From 22fe1925e03c8e3d01725e45d513d52b78e7104a Mon Sep 17 00:00:00 2001 From: Alexandre Abadie Date: Tue, 5 Mar 2019 15:49:29 +0100 Subject: [PATCH] boards/particle-mesh: common support for particle mesh boards --- boards/common/particle-mesh/Makefile | 3 + boards/common/particle-mesh/Makefile.dep | 11 +++ boards/common/particle-mesh/Makefile.features | 9 +++ boards/common/particle-mesh/Makefile.include | 24 +++++++ boards/common/particle-mesh/board.c | 38 ++++++++++ boards/common/particle-mesh/doc.txt | 53 ++++++++++++++ boards/common/particle-mesh/include/board.h | 69 +++++++++++++++++++ .../particle-mesh/include/gpio_params.h | 66 ++++++++++++++++++ .../include/periph_conf_common.h | 67 ++++++++++++++++++ 9 files changed, 340 insertions(+) create mode 100644 boards/common/particle-mesh/Makefile create mode 100644 boards/common/particle-mesh/Makefile.dep create mode 100644 boards/common/particle-mesh/Makefile.features create mode 100644 boards/common/particle-mesh/Makefile.include create mode 100644 boards/common/particle-mesh/board.c create mode 100644 boards/common/particle-mesh/doc.txt create mode 100644 boards/common/particle-mesh/include/board.h create mode 100644 boards/common/particle-mesh/include/gpio_params.h create mode 100644 boards/common/particle-mesh/include/periph_conf_common.h diff --git a/boards/common/particle-mesh/Makefile b/boards/common/particle-mesh/Makefile new file mode 100644 index 0000000000..1977a5b0d6 --- /dev/null +++ b/boards/common/particle-mesh/Makefile @@ -0,0 +1,3 @@ +MODULE = boards_common_particle_mesh + +include $(RIOTBASE)/Makefile.base diff --git a/boards/common/particle-mesh/Makefile.dep b/boards/common/particle-mesh/Makefile.dep new file mode 100644 index 0000000000..e64683ea96 --- /dev/null +++ b/boards/common/particle-mesh/Makefile.dep @@ -0,0 +1,11 @@ +ifneq (,$(filter saul_default,$(USEMODULE))) + USEMODULE += saul_gpio +endif + +ifneq (,$(filter gnrc_netdev_default netdev_default,$(USEMODULE))) + ifeq (,$(filter nrfmin,$(USEMODULE))) + USEMODULE += nrf802154 + endif +endif + +include $(RIOTBOARD)/common/nrf52/Makefile.dep diff --git a/boards/common/particle-mesh/Makefile.features b/boards/common/particle-mesh/Makefile.features new file mode 100644 index 0000000000..26f1bcc71f --- /dev/null +++ b/boards/common/particle-mesh/Makefile.features @@ -0,0 +1,9 @@ +# Put defined MCU peripherals here (in alphabetical order) +FEATURES_PROVIDED += periph_i2c +FEATURES_PROVIDED += periph_spi +FEATURES_PROVIDED += periph_uart + +# Various other features (if any) +FEATURES_PROVIDED += radio_nrf802154 + +include $(RIOTBOARD)/common/nrf52/Makefile.features diff --git a/boards/common/particle-mesh/Makefile.include b/boards/common/particle-mesh/Makefile.include new file mode 100644 index 0000000000..6d393ec199 --- /dev/null +++ b/boards/common/particle-mesh/Makefile.include @@ -0,0 +1,24 @@ +export CPU_MODEL = nrf52840xxaa + +# set default port depending on operating system +PORT_LINUX ?= /dev/ttyUSB0 +PORT_DARWIN ?= $(firstword $(sort $(wildcard /dev/tty.SLAB_USBtoUART*))) + +# add the common header files to the include path +INCLUDES += -I$(RIOTBOARD)/common/particle-mesh/include + +# This board uses a DAP-Link programmer +# Flashing support is provided through pyocd (default) and openocd. +# For openocd, a version built against the development branch and containing +# the support for nrf52 cpu is required. +PROGRAMMER ?= pyocd +ifeq (pyocd,$(PROGRAMMER)) + # The board is not recognized automatically by pyocd, so the CPU target + # option is passed explicitly + export FLASH_TARGET_TYPE ?= -t nrf52840 + include $(RIOTMAKE)/tools/pyocd.inc.mk +else ifeq (openocd,$(PROGRAMMER)) + DEBUG_ADAPTER ?= dap +endif + +include $(RIOTBOARD)/common/nrf52/Makefile.include diff --git a/boards/common/particle-mesh/board.c b/boards/common/particle-mesh/board.c new file mode 100644 index 0000000000..05f0d0d3ba --- /dev/null +++ b/boards/common/particle-mesh/board.c @@ -0,0 +1,38 @@ +/* + * Copyright (C) 2018 Inria + * + * This file is subject to the terms and conditions of the GNU Lesser + * General Public License v2.1. See the file LICENSE in the top level + * directory for more details. + */ + +/** + * @ingroup boards_common_particle-mesh + * @{ + * + * @file + * @brief Common board initialization for the Particle Mesh + * + * @author Alexandre Abadie + * + * @} + */ + +#include "cpu.h" +#include "board.h" + +#include "periph/gpio.h" + +void board_init(void) +{ + /* initialize the boards LEDs */ + gpio_init(LED0_PIN, GPIO_OUT); + gpio_set(LED0_PIN); + gpio_init(LED1_PIN, GPIO_OUT); + gpio_set(LED1_PIN); + gpio_init(LED2_PIN, GPIO_OUT); + gpio_set(LED2_PIN); + + /* initialize the CPU */ + cpu_init(); +} diff --git a/boards/common/particle-mesh/doc.txt b/boards/common/particle-mesh/doc.txt new file mode 100644 index 0000000000..e750e277dd --- /dev/null +++ b/boards/common/particle-mesh/doc.txt @@ -0,0 +1,53 @@ +/** +@defgroup boards_common_particle-mesh Particle Mesh common +@ingroup boards +@brief Common support for the Particle Mesh boards family (Xenon, Argon, Boron) + +### General information + +[Particle Mesh](https://www.particle.io/mesh/) are mesh-ready development kits. +Depending on the board type (Xenon, Argon, Boron), it provides access to +multiple communication protocols: BLE, 802.15.4, WiFi, LTE. + +### Flash the board + +Using the [Particle Mesh debugger](https://docs.particle.io/datasheets/accessories/mesh-accessories/#debugger), +the board can be flashed with PyOCD programmer via a DAPLink. + +PyOCD can be installed using Python package manager: +``` + pip install pyocd --user -U +``` + +To flash the board, use `BOARD=` (with board name in {particle-argon, +particle-boron, particle-xenon}) with the `make` command.
+Example with `hello-world` application: +``` + make BOARD=particle-xenon -C examples/hello-world flash +``` + +In this case, OpenOCD can also be used. For the moment, the latest stable +version of OpenOCD (0.10) doesn't contain any support for nrf52 but versions +built against the actual development version can be used. + +To flash the board with OpenOCD, use the `PROGRAMMER` variable: +``` + PROGRAMMER=openocd make BOARD= -C examples/hello-world flash +``` + +### Reset the board + +The on-board reset button doesn't work, so to trigger a reset of the board, use +the `reset` target with `make`: +``` + make BOARD= -C examples/hello-world reset +``` + +### Accessing STDIO via UART + +The STDIO is not accessible via the USB port. + +To access the STDIO of RIOT, a FTDI to USB converter needs to be plugged to +the RX/TX pins on the board. + + */ diff --git a/boards/common/particle-mesh/include/board.h b/boards/common/particle-mesh/include/board.h new file mode 100644 index 0000000000..0655d255ab --- /dev/null +++ b/boards/common/particle-mesh/include/board.h @@ -0,0 +1,69 @@ +/* + * Copyright (C) 2018 Inria + * + * This file is subject to the terms and conditions of the GNU Lesser + * General Public License v2.1. See the file LICENSE in the top level + * directory for more details. + */ + +/** + * @ingroup boards_common_particle-mesh + * @{ + * + * @file + * @brief Common board specific configuration for the Particle Mesh + * + * @author Alexandre Abadie + */ + +#ifndef BOARD_H +#define BOARD_H + +#include "cpu.h" +#include "board_common.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @name LED pin configuration + * @{ + */ +#define LED0_PIN GPIO_PIN(0, 13) +#define LED1_PIN GPIO_PIN(0, 14) +#define LED2_PIN GPIO_PIN(0, 15) + +#define LED_PORT (NRF_P0) +#define LED0_MASK (1 << 13) +#define LED1_MASK (1 << 14) +#define LED2_MASK (1 << 15) +#define LED_MASK (LED0_MASK | LED1_MASK | LED2_MASK) + +#define LED0_ON (LED_PORT->OUTCLR = LED0_MASK) +#define LED0_OFF (LED_PORT->OUTSET = LED0_MASK) +#define LED0_TOGGLE (LED_PORT->OUT ^= LED0_MASK) + +#define LED1_ON (LED_PORT->OUTCLR = LED1_MASK) +#define LED1_OFF (LED_PORT->OUTSET = LED1_MASK) +#define LED1_TOGGLE (LED_PORT->OUT ^= LED1_MASK) + +#define LED2_ON (LED_PORT->OUTCLR = LED2_MASK) +#define LED2_OFF (LED_PORT->OUTSET = LED2_MASK) +#define LED2_TOGGLE (LED_PORT->OUT ^= LED2_MASK) +/** @} */ + +/** + * @name Button pin configuration + * @{ + */ +#define BTN0_PIN GPIO_PIN(0, 11) +#define BTN0_MODE GPIO_IN_PU +/** @} */ + +#ifdef __cplusplus +} +#endif + +#endif /* BOARD_H */ +/** @} */ diff --git a/boards/common/particle-mesh/include/gpio_params.h b/boards/common/particle-mesh/include/gpio_params.h new file mode 100644 index 0000000000..a9858f0acd --- /dev/null +++ b/boards/common/particle-mesh/include/gpio_params.h @@ -0,0 +1,66 @@ +/* + * Copyright (C) 2018 Inria + * + * This file is subject to the terms and conditions of the GNU Lesser + * General Public License v2.1. See the file LICENSE in the top level + * directory for more details. + */ + +/** + * @ingroup boards_common_particle-mesh + * @{ + * + * @file + * @brief Configuration of SAUL mapped GPIO pins + * + * @author Alexandre Abadie + */ + +#ifndef GPIO_PARAMS_H +#define GPIO_PARAMS_H + +#include "board.h" +#include "saul/periph.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @brief LED configuration + */ +static const saul_gpio_params_t saul_gpio_params[] = +{ + { + .name = "Led Red", + .pin = LED0_PIN, + .mode = GPIO_OUT, + .flags = (SAUL_GPIO_INVERTED | SAUL_GPIO_INIT_CLEAR), + }, + { + .name = "Led Green", + .pin = LED1_PIN, + .mode = GPIO_OUT, + .flags = (SAUL_GPIO_INVERTED | SAUL_GPIO_INIT_CLEAR), + }, + { + .name = "Led Blue", + .pin = LED2_PIN, + .mode = GPIO_OUT, + .flags = (SAUL_GPIO_INVERTED | SAUL_GPIO_INIT_CLEAR), + }, + { + .name = "MODE Button", + .pin = BTN0_PIN, + .mode = BTN0_MODE, + .flags = SAUL_GPIO_INVERTED, + }, +}; + + +#ifdef __cplusplus +} +#endif + +#endif /* GPIO_PARAMS_H */ +/** @} */ diff --git a/boards/common/particle-mesh/include/periph_conf_common.h b/boards/common/particle-mesh/include/periph_conf_common.h new file mode 100644 index 0000000000..e4737b4168 --- /dev/null +++ b/boards/common/particle-mesh/include/periph_conf_common.h @@ -0,0 +1,67 @@ +/* + * Copyright (C) 2018 Inria + * + * This file is subject to the terms and conditions of the GNU Lesser + * General Public License v2.1. See the file LICENSE in the top level + * directory for more details. + */ + +/** + * @ingroup boards_common_particle-mesh + * @{ + * + * @file + * @brief Common peripheral configuration for the Particle Mesh + * + * @author Alexandre Abadie + * + */ + +#ifndef PERIPH_CONF_COMMON_H +#define PERIPH_CONF_COMMON_H + +#include "periph_cpu.h" +#include "cfg_clock_32_1.h" +#include "cfg_rtt_default.h" +#include "cfg_timer_default.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @name SPI configuration + * @{ + */ +static const spi_conf_t spi_config[] = { + { + .dev = NRF_SPI0, + .sclk = 15, + .mosi = 13, + .miso = 14 + } +}; + +#define SPI_NUMOF (sizeof(spi_config) / sizeof(spi_config[0])) +/** @} */ + +/** + * @name I2C configuration + * @{ + */ +static const i2c_conf_t i2c_config[] = { + { + .dev = NRF_TWIM1, + .scl = 27, + .sda = 26, + .speed = I2C_SPEED_NORMAL + } +}; +#define I2C_NUMOF (sizeof(i2c_config) / sizeof(i2c_config[0])) +/** @} */ + +#ifdef __cplusplus +} +#endif + +#endif /* PERIPH_CONF_COMMON_H */