diff --git a/boards/slstk3400a/Kconfig b/boards/slstk3400a/Kconfig new file mode 100644 index 0000000000..9dcd10b97a --- /dev/null +++ b/boards/slstk3400a/Kconfig @@ -0,0 +1,24 @@ +# Copyright (c) 2020 HAW Hamburg +# +# 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. + +config BOARD + default "slstk3400a" if BOARD_SLSTK3400A + +config BOARD_SLSTK3400A + bool + default y + select BOARD_COMMON_SILABS + select CPU_MODEL_EFM32HG322F64 + select HAS_PERIPH_ADC + select HAS_PERIPH_I2C + select HAS_PERIPH_RTC + select HAS_PERIPH_RTT + select HAS_PERIPH_SPI + select HAS_PERIPH_TIMER + select HAS_PERIPH_UART + select HAS_PERIPH_UART_MODECFG + +source "$(RIOTBOARD)/common/silabs/Kconfig" diff --git a/boards/slstk3400a/Makefile b/boards/slstk3400a/Makefile new file mode 100644 index 0000000000..39108f4589 --- /dev/null +++ b/boards/slstk3400a/Makefile @@ -0,0 +1,5 @@ +MODULE = board + +DIRS = $(RIOTBOARD)/common/silabs + +include $(RIOTBASE)/Makefile.base diff --git a/boards/slstk3400a/Makefile.dep b/boards/slstk3400a/Makefile.dep new file mode 100644 index 0000000000..36153f85fa --- /dev/null +++ b/boards/slstk3400a/Makefile.dep @@ -0,0 +1,11 @@ +ifneq (,$(filter saul_default,$(USEMODULE))) + USEMODULE += saul_gpio + USEMODULE += si7021 +endif + +# add board common drivers +USEMODULE += boards_common_silabs +USEMODULE += silabs_bc + +# include board common dependencies +include $(RIOTBOARD)/common/silabs/Makefile.dep diff --git a/boards/slstk3400a/Makefile.features b/boards/slstk3400a/Makefile.features new file mode 100644 index 0000000000..c71ce5516e --- /dev/null +++ b/boards/slstk3400a/Makefile.features @@ -0,0 +1,14 @@ +CPU = efm32 +CPU_FAM = efm32hg +CPU_MODEL = efm32hg322f64 + +# Put defined MCU peripherals here (in alphabetical order) +FEATURES_PROVIDED += periph_adc +FEATURES_PROVIDED += periph_i2c +FEATURES_PROVIDED += periph_rtc +FEATURES_PROVIDED += periph_rtt +FEATURES_PROVIDED += periph_spi +FEATURES_PROVIDED += periph_timer +FEATURES_PROVIDED += periph_uart periph_uart_modecfg + +include $(RIOTBOARD)/common/silabs/Makefile.features diff --git a/boards/slstk3400a/Makefile.include b/boards/slstk3400a/Makefile.include new file mode 100644 index 0000000000..149d8aeebb --- /dev/null +++ b/boards/slstk3400a/Makefile.include @@ -0,0 +1,5 @@ +# setup JLink for flashing +JLINK_PRE_FLASH = r + +# include board common +include $(RIOTBOARD)/common/silabs/Makefile.include diff --git a/boards/slstk3400a/board.c b/boards/slstk3400a/board.c new file mode 100644 index 0000000000..ae9d7f97d3 --- /dev/null +++ b/boards/slstk3400a/board.c @@ -0,0 +1,34 @@ +/* + * Copyright (C) 2015-2020 Freie Universität Berlin + * + * 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_slstk3400a + * @{ + * + * @file + * @brief Board specific implementations SLSTK3400A board + * + * @author Hauke Petersen + * @author Bas Stottelaar + * + * @} + */ + +#include "board.h" +#include "board_common.h" + +void board_init(void) +{ + /* initialize the CPU */ + cpu_init(); + +#ifndef RIOTBOOT + /* perform common board initialization */ + board_common_init(); +#endif +} diff --git a/boards/slstk3400a/doc.txt b/boards/slstk3400a/doc.txt new file mode 100644 index 0000000000..1e7703cca2 --- /dev/null +++ b/boards/slstk3400a/doc.txt @@ -0,0 +1,234 @@ +/** + * @defgroup boards_slstk3400a Silicon Labs SLSTK3400A starter kit + * @ingroup boards + * @brief Support for Silicon Labs SLSTK3400A starter kit + +## Overview +Silicon Labs EFM32 Happy Gecko Starter Kit is equipped with the EFM32 +microcontroller. It is specifically designed for low-power applications, having +energy-saving peripherals, different energy modes and short wake-up times. + +The starter kit is equipped with an Advanced Energy Monitor. This allows you to +actively measure the power consumption of your hardware and code, in real-time. + +## Hardware + +### MCU +| MCU | EFM32HG322F64 | +|-----------------|--------------------------------------------------------------------------------------------------| +| Family | ARM Cortex-M0PLUS | +| Vendor | Silicon Labs | +| Vendor Family | EFM32 Happy Gecko | +| RAM | 8.0 KiB | +| Flash | 64.0 KiB | +| EEPROM | no | +| Frequency | up to 24 MHz | +| FPU | no | +| MPU | no | +| DMA | 6 channels | +| Timers | 3x 16-bits | +| ADCs | 12-bit ADC | +| UARTs | 2x USART, 1x LEUART | +| SPIs | 2x USART | +| I2Cs | 1x | +| Vcc | 1.98 V - 3.8 V | +| Datasheet | [Datasheet](https://www.silabs.com/documents/public/data-sheets/efm32hg-datasheet.pdf) | +| Manual | [Manual](https://www.silabs.com/documents/public/reference-manuals/efm32hg-rm.pdf) | +| Board Manual | [Board Manual](https://www.silabs.com/documents/public/user-guides/ug255-stk3400-user-guide.pdf) | +| Board Schematic | Can be downloaded using Silicon Labs' Simplicity Studio | + +### Pinout +This is the pinout of the expansion header on the right side of the board. +PIN 1 is the bottom-left contact when the header faces you horizontally. + +| | PIN | PIN | | +|------|-----|-----|------| +| 3V3 | 20 | 19 | RES | +| 5V | 18 | 17 | RES | +| PD6 | 16 | 15 | PD7 | +| PD5 | 14 | 13 | PA1 | +| PD4 | 12 | 11 | PB11 | +| PE13 | 10 | 9 | PA2 | +| PE12 | 8 | 7 | PC2 | +| PE11 | 6 | 5 | PC1 | +| PE10 | 4 | 3 | PC0 | +| VMCU | 2 | 1 | GND | + +**Note**: not all starter kits by Silicon Labs share the same pinout! + +**Note:** some pins are connected to the board controller, when enabled! + +### Peripheral mapping +| Peripheral | Number | Hardware | Pins | Comments | +|------------|---------|-----------------|-----------------------------------|----------------------------------------------------------| +| ADC | 0 | ADC0 | CHAN0: internal temperature | Ports are fixed, 14/16-bit resolution not supported | +| I2C | 0 | I2C0 | SDA: PD6, CLK: PD7 | `I2C_SPEED_LOW` and `I2C_SPEED_HIGH` clock speed deviate | +| HWCRYPTO | — | — | | AES128 | +| RTT | — | RTCC | | 1 Hz interval. Either RTT or RTC (see below) | +| RTC | — | RTCC | | 1 Hz interval. Either RTC or RTT (see below) | +| SPI | 0 | USART0 | MOSI: PE10, MISO: PE11, CLK: PE12 | | +| Timer | 0 | TIMER0 + TIMER1 | | TIMER0 is used as prescaler (must be adjecent) | +| UART | 0 | USART1 | RX: PA0, TX: PF2 | Default STDIO output | +| | 1 | LEUART0 | RX: PD5, TX: PD4 | Baud rate limited (see below) | + +### User interface +| Peripheral | Mapped to | Pin | Comments | +|------------|-----------|------|------------| +| Button | PB0 | PC9 | | +| | PB1 | PC10 | | +| LED | LED0 | PF4 | Yellow LED | +| | LED1 | PF5 | Yellow LED | + +## Implementation Status +| Device | ID | Supported | Comments | +|-------------------------------|-------------|-----------|----------------------------------------------------------------| +| MCU | EFM32HG | yes | Power modes supported | +| Low-level driver | ADC | yes | | +| | Flash | yes | | +| | GPIO | yes | Interrupts are shared across pins (see reference manual) | +| | HW Crypto | yes | | +| | I2C | yes | | +| | PWM | yes | | +| | RTC | yes | As RTT or RTC | +| | SPI | partially | Only master mode | +| | Timer | yes | | +| | UART | yes | USART is shared with SPI. LEUART baud rate limited (see below) | +| | USB | no | | +| LCD driver | LS013B7DH03 | yes | Sharp Low Power Memory LCD via the U8g2 package | +| Temperature + humidity sensor | Si7021 | yes | Silicon Labs Temperature + Humidity sensor | + +## Board configuration + +### Board controller +The starter kit is equipped with a Board Controller. This controller provides a +virtual serial port. The board controller is enabled via a GPIO pin. + +By default, this pin is enabled. You can disable the board controller module by +passing `DISABLE_MODULE=silabs_bc` to the `make` command. + +**Note:** to use the virtual serial port, ensure you have the latest board +controller firmware installed. + +**Note:** the board controller *always* configures the virtual serial port at +115200 baud with 8 bits, no parity and one stop bit. This also means that it +expects data from the MCU with the same settings. + +### Clock selection +There are several clock sources that are available for the different +peripherals. You are advised to read [AN0004.0](https://www.silabs.com/documents/public/application-notes/an0004.0-efm32-cmu.pdf) +to get familiar with the different clocks. + +| Source | Internal | Speed | Comments | +|--------|----------|------------|------------------------------------| +| HFRCO | Yes | 14 MHz | Enabled during startup, changeable | +| HFXO | No | 24 MHz | | +| LFRCO | Yes | 32.768 kHz | | +| LFXO | No | 32.768 kHz | | +| ULFRCO | No | 1 kHz | Not very reliable as a time source | + +The sources can be used to clock following branches: + +| Branch | Sources | Comments | +|--------|-------------------------|-------------------| +| HF | HFRCO, HFXO | Core, peripherals | +| LFA | LFRCO, LFXO | Low-power timers | +| LFB | LFRCO, LFXO, CORELEDIV2 | Low-power UART | + +CORELEDIV2 is a source that depends on the clock source that powers the core. +It is divided by 2 or 4 to not exceed maximum clock frequencies (EMLIB takes +care of this). + +The frequencies mentioned in the tables above are specific for this starter +kit. + +It is important that the clock speeds are known to the code, for proper +calculations of speeds and baud rates. If the HFXO or LFXO are different from +the speeds above, ensure to pass `EFM32_HFXO_FREQ=freq_in_hz` and +`EFM32_LFXO_FREQ=freq_in_hz` to your compiler. + +You can override the branch's clock source by adding `CLOCK_LFA=source` to your +compiler defines, e.g. `CLOCK_LFA=cmuSelect_LFRCO`. + +### Low-power peripherals +The low-power UART is capable of providing an UART peripheral using a low-speed +clock. When the LFB clock source is the LFRCO or LFXO, it can still be used in +EM2. However, this limits the baud rate to 9600 baud. If a higher baud rate is +desired, set the clock source to CORELEDIV2. + +**Note:** peripheral mappings in your board definitions will not be affected by +this setting. Ensure you do not refer to any low-power peripherals. + +### RTC or RTT +RIOT-OS has support for *Real-Time Tickers* and *Real-Time Clocks*. + +However, this board MCU family has support for a 24-bit *Real-Time Counter* +only, which is a ticker only. A compatibility layer for ticker-to-calendar is +available, but this includes extra code size to convert from timestamps to time +structures and visa versa. + +Configured at 1 Hz interval, the RTC will overflow each 194 days. When using +the ticker-to-calendar mode, this interval is extended artificially. + +### Hardware crypto +This MCUs has support for hardware-accelerated AES128. + +A peripheral driver interface is proposed, but not yet implemented. + +### Usage of EMLIB +This port makes uses of EMLIB by Silicon Labs to abstract peripheral registers. +While some overhead is to be expected, it ensures proper setup of devices, +provides chip errata and simplifies development. The exact overhead depends on +the application and peripheral usage, but the largest overhead is expected +during peripheral setup. A lot of read/write/get/set methods are implemented as +inline methods or macros (which have no overhead). + +Another advantage of EMLIB are the included assertions. These assertions ensure +that peripherals are used properly. To enable this, pass `DEBUG_EFM` to your +compiler. + +### Pin locations +The EFM32 platform supports peripherals to be mapped to different pins +(predefined locations). The definitions in `periph_conf.h` mostly consist of a +location number and the actual pins. The actual pins are required to configure +the pins via GPIO driver, while the location is used to map the peripheral to +these pins. + +In other words, these definitions must match. Refer to the data sheet for more +information. + +## Flashing the device +To flash, [SEGGER JLink](https://www.segger.com/jlink-software.html) is +required. + +Flashing is supported by RIOT-OS using the command below: + +``` +make flash +``` + +To run the GDB debugger, use the command: + +``` +make debug +``` + +Or, to connect with your own debugger: + +``` +make debug-server +``` + +Some boards have (limited) support for emulation, which can be started with: + +``` +make emulate +``` + +## Supported Toolchains +For using the Silicon Labs SLSTK3400A starter kit we strongly recommend +the usage of the [GNU Tools for ARM Embedded Processors](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm) +toolchain. + +## License information +* Silicon Labs' EMLIB: zlib-style license (permits distribution of source). + */ diff --git a/boards/slstk3400a/include/board.h b/boards/slstk3400a/include/board.h new file mode 100644 index 0000000000..af80430ba4 --- /dev/null +++ b/boards/slstk3400a/include/board.h @@ -0,0 +1,126 @@ +/* + * Copyright (C) 2015-2020 Freie Universität Berlin + * + * 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_slstk3400a + * @{ + * + * @file + * @brief Board specific definitions for the SLSTK3400A starter kit + * + * @author Hauke Petersen + * @author Bas Stottelaar + * @author Akshai M + */ + +#ifndef BOARD_H +#define BOARD_H + +#include "cpu.h" +#include "periph_conf.h" +#include "periph/gpio.h" +#include "periph/spi.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @name Xtimer configuration + * + * The timer runs at 250 kHz. + * @{ + */ +#define XTIMER_DEV (TIMER_DEV(0)) +#define XTIMER_HZ (250000UL) +#define XTIMER_WIDTH (16) +#define XTIMER_CHAN (0) +/** @} */ + +/** + * @name Board controller configuration + * + * Define the GPIO pin to enable the BC, to allow serial communication + * via the USB port. + * @{ + */ +#define BC_PIN GPIO_PIN(PA, 9) +/** @} */ + +/** + * @name Push button pin definitions + * @{ + */ +#define PB0_PIN GPIO_PIN(PC, 9) +#define PB1_PIN GPIO_PIN(PC, 10) +/** @} */ + +/** + * @name LED pin definitions + * @{ + */ +#define LED0_PIN GPIO_PIN(PF, 4) +#define LED1_PIN GPIO_PIN(PF, 5) +/** @} */ + +/** + * @name Macros for controlling the on-board LEDs + * @{ + */ +#define LED0_ON gpio_set(LED0_PIN) +#define LED0_OFF gpio_clear(LED0_PIN) +#define LED0_TOGGLE gpio_toggle(LED0_PIN) +#define LED1_ON gpio_set(LED1_PIN) +#define LED1_OFF gpio_clear(LED1_PIN) +#define LED1_TOGGLE gpio_toggle(LED1_PIN) +/** @} */ + +/** + * @name Core temperature sensor configuration + * + * Connection to the on-chip temperature sensor. + * @{ + */ +#define CORETEMP_ADC ADC_LINE(0) +/** @} */ + +/** + * @name Display configuration + * + * Connection to the on-board Sharp Memory LCD (LS013B7DH03). + * @{ + */ +#define DISP_SPI SPI_DEV(0) +#define DISP_COM_PIN GPIO_PIN(PF, 3) +#define DISP_CS_PIN GPIO_PIN(PA, 10) +#define DISP_EN_PIN GPIO_PIN(PA, 8) +/** @} */ + +/** + * @name Temperature sensor configuration + * + * Connection to the on-board temperature/humidity sensor (Si7021). + * @{ + */ +#define SI7021_I2C I2C_DEV(0) +#define SI7021_EN_PIN GPIO_PIN(PC, 8) + +#define SI70XX_PARAM_I2C_DEV SI7021_I2C +/** @} */ + +/** + * @brief Initialize the board (GPIO, sensors, clocks). + */ +void board_init(void); + +#ifdef __cplusplus +} +#endif + +#endif /* BOARD_H */ +/** @} */ diff --git a/boards/slstk3400a/include/gpio_params.h b/boards/slstk3400a/include/gpio_params.h new file mode 100644 index 0000000000..9299c4b100 --- /dev/null +++ b/boards/slstk3400a/include/gpio_params.h @@ -0,0 +1,63 @@ +/* + * Copyright (C) 2016-2020 Bas Stottelaar + * + * 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_slstk3400a + * @{ + * + * @file + * @brief Board specific configuration of direct mapped GPIOs + * + * @author Bas Stottelaar + */ + +#ifndef GPIO_PARAMS_H +#define GPIO_PARAMS_H + +#include "board.h" +#include "saul/periph.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @brief GPIO pin configuration + */ +static const saul_gpio_params_t saul_gpio_params[] = +{ + { + .name = "LED 0", + .pin = LED0_PIN, + .mode = GPIO_OUT + }, + { + .name = "LED 1", + .pin = LED1_PIN, + .mode = GPIO_OUT + }, + { + .name = "Button 1", + .pin = PB0_PIN, + .mode = GPIO_IN_PU, + .flags = SAUL_GPIO_INVERTED + }, + { + .name = "Button 2", + .pin = PB1_PIN, + .mode = GPIO_IN_PU, + .flags = SAUL_GPIO_INVERTED + } +}; + +#ifdef __cplusplus +} +#endif + +#endif /* GPIO_PARAMS_H */ +/** @} */ diff --git a/boards/slstk3400a/include/periph_conf.h b/boards/slstk3400a/include/periph_conf.h new file mode 100644 index 0000000000..57ecf93429 --- /dev/null +++ b/boards/slstk3400a/include/periph_conf.h @@ -0,0 +1,185 @@ +/* + * Copyright (C) 2015-2020 Freie Universität Berlin + * + * 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_slstk3400a + * @{ + * + * @file + * @brief Configuration of CPU peripherals for the SLSTK3400A starter kit + * + * @author Hauke Petersen + * @author Bas Stottelaar + * @author Akshai M + */ + +#ifndef PERIPH_CONF_H +#define PERIPH_CONF_H + +#include "cpu.h" +#include "periph_cpu.h" +#include "em_cmu.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @name Clock configuration + * @{ + */ +#ifndef CLOCK_HF +#define CLOCK_HF cmuSelect_HFXO +#endif +#ifndef CLOCK_CORE_DIV +#define CLOCK_CORE_DIV cmuClkDiv_1 +#endif +#ifndef CLOCK_LFA +#define CLOCK_LFA cmuSelect_LFXO +#endif +#ifndef CLOCK_LFB +#define CLOCK_LFB cmuSelect_LFXO +#endif +/** @} */ + +/** + * @name ADC configuration + * @{ + */ +static const adc_conf_t adc_config[] = { + { + .dev = ADC0, + .cmu = cmuClock_ADC0, + } +}; + +static const adc_chan_conf_t adc_channel_config[] = { + { + .dev = 0, + .input = adcSingleInputTemp, + .reference = adcRef1V25, + .acq_time = adcAcqTime8 + }, + { + .dev = 0, + .input = adcSingleInputVDDDiv3, + .reference = adcRef1V25, + .acq_time = adcAcqTime8 + } +}; + +#define ADC_DEV_NUMOF ARRAY_SIZE(adc_config) +#define ADC_NUMOF ARRAY_SIZE(adc_channel_config) +/** @} */ + +/** + * @name I2C configuration + * @{ + */ +static const i2c_conf_t i2c_config[] = { + { + .dev = I2C0, + .sda_pin = GPIO_PIN(PD, 6), + .scl_pin = GPIO_PIN(PD, 7), + .loc = I2C_ROUTE_LOCATION_LOC1, + .cmu = cmuClock_I2C0, + .irq = I2C0_IRQn, + .speed = I2C_SPEED_NORMAL + } +}; + +#define I2C_NUMOF ARRAY_SIZE(i2c_config) +#define I2C_0_ISR isr_i2c0 +/** @} */ + +/** + * @name RTT configuration + * @{ + */ +#define RTT_MAX_VALUE (0xFFFFFF) +#define RTT_FREQUENCY (1U) +/** @} */ + +/** + * @name SPI configuration + * @{ + */ +static const spi_dev_t spi_config[] = { + { + .dev = USART0, + .mosi_pin = GPIO_PIN(PE, 10), + .miso_pin = GPIO_PIN(PE, 11), + .clk_pin = GPIO_PIN(PE, 12), + .loc = USART_ROUTE_LOCATION_LOC0, + .cmu = cmuClock_USART0, + .irq = USART0_RX_IRQn + } +}; + +#define SPI_NUMOF ARRAY_SIZE(spi_config) +/** @} */ + +/** + * @name Timer configuration + * + * The implementation uses two timers in cascade mode. + * @{ + */ +static const timer_conf_t timer_config[] = { + { + .prescaler = { + .dev = TIMER0, + .cmu = cmuClock_TIMER0 + }, + .timer = { + .dev = TIMER1, + .cmu = cmuClock_TIMER1 + }, + .irq = TIMER1_IRQn, + .channel_numof = 3 + } +}; + +#define TIMER_NUMOF ARRAY_SIZE(timer_config) +#define TIMER_0_ISR isr_timer1 +/** @} */ + +/** + * @name UART configuration + * @{ + */ +static const uart_conf_t uart_config[] = { + { + .dev = USART1, + .rx_pin = GPIO_PIN(PA, 0), + .tx_pin = GPIO_PIN(PF, 2), + .loc = USART_ROUTE_LOCATION_LOC4, + .cmu = cmuClock_USART1, + .irq = USART1_RX_IRQn + }, + { + .dev = LEUART0, + .rx_pin = GPIO_PIN(PD, 5), + .tx_pin = GPIO_PIN(PD, 4), + .loc = LEUART_ROUTE_LOCATION_LOC0, + .cmu = cmuClock_LEUART0, + .irq = LEUART0_IRQn + } +}; + +#define UART_NUMOF ARRAY_SIZE(uart_config) +#define UART_0_ISR_RX isr_usart1_rx +#define UART_1_ISR_RX isr_leuart0 +/** @} */ + +#ifdef __cplusplus +} +#endif + +#endif /* PERIPH_CONF_H */ +/** @} */