Merge pull request #10563 from aabadie/pr/boards/particle_mesh

boards/particle-{xenon,argon,boron}: add initial support

boards/common/particle-mesh/Makefile

@@ -0,0 +1,3 @@
+MODULE = boards_common_particle_mesh
+
+include $(RIOTBASE)/Makefile.base

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

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

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

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 <[email protected]>
+ *
+ * @}
+ */
+
+#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();
+}

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=<board name>` (with board name in {particle-argon,
+particle-boron, particle-xenon}) with the `make` command.<br/>
+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=<board name> -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=<board name> -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.
+
+ */

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 <[email protected]>
+ */
+
+#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 */
+/** @} */

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 <[email protected]>
+ */
+
+#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 */
+/** @} */

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 <[email protected]>
+ *
+ */
+
+#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 */

boards/particle-argon/Makefile

@@ -0,0 +1,5 @@
+MODULE = board
+
+DIRS = $(RIOTBOARD)/common/particle-mesh
+
+include $(RIOTBASE)/Makefile.base

boards/particle-argon/Makefile.dep

@@ -0,0 +1 @@
+include $(RIOTBOARD)/common/particle-mesh/Makefile.dep

boards/particle-argon/Makefile.features

@@ -0,0 +1 @@
+include $(RIOTBOARD)/common/particle-mesh/Makefile.features

boards/particle-argon/Makefile.include

@@ -0,0 +1,3 @@
+USEMODULE += boards_common_particle_mesh
+
+include $(RIOTBOARD)/common/particle-mesh/Makefile.include

boards/particle-argon/doc.txt

@@ -0,0 +1,25 @@
+/**
+@defgroup    boards_particle-argon Particle Argon
+@ingroup     boards
+@brief       Support for the Particle Argon
+
+### General information
+
+[Particle Argon](https://docs.particle.io/argon/) is a mesh-ready development kit
+that provides access to multiple communication protocols: BLE, 802.15.4 and WiFi.
+
+<img src="https://docs.particle.io/assets/images/argon/argon-top.png"
+     alt="pinout" style="height:300px;"/>
+
+### Block diagrams and datasheets
+
+<img src="https://docs.particle.io/assets/images/argon/argon-block-diagram.png"
+     alt="pinout" style="height:800px;"/>
+
+The board datasheet is available [here](https://docs.particle.io/assets/pdfs/datasheets/argon-datasheet.pdf)
+
+### Flash the board
+
+See the `Flashing` section in @ref boards_common_particle-mesh.
+
+ */