Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

boards: add support for EFM32GG12 Thunderboard Kit (SLTB009A) #18755

Merged
merged 3 commits into from
Oct 18, 2022
Merged

boards: add support for EFM32GG12 Thunderboard Kit (SLTB009A) #18755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae98c3e
cpu/efm32: add EFM32GG12 family (generated with EFM2RIOT)
gschorcht Oct 16, 2022
550a599
cpu/efm32: fix RTT_MAX_VALUE selection
gschorcht Oct 16, 2022
7a6847e
boards: add SLTB009A EFM32GG12 Thunderboard Kit
gschorcht Oct 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions boards/sltb009a/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 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 "sltb009a" if BOARD_SLTB009A

config BOARD_SLTB009A
bool
default y
select BOARD_COMMON_SILABS
select CPU_MODEL_EFM32GG12B810F1024GM64
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
select HAVE_SAUL_GPIO

source "$(RIOTBOARD)/common/silabs/Kconfig"
5 changes: 5 additions & 0 deletions boards/sltb009a/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
MODULE = board

DIRS = $(RIOTBOARD)/common/silabs

include $(RIOTBASE)/Makefile.base
10 changes: 10 additions & 0 deletions boards/sltb009a/Makefile.dep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
ifneq (,$(filter saul_default,$(USEMODULE)))
USEMODULE += efm32_coretemp
USEMODULE += saul_gpio
endif

# add board common drivers
USEMODULE += boards_common_silabs

# include board common dependencies
include $(RIOTBOARD)/common/silabs/Makefile.dep
14 changes: 14 additions & 0 deletions boards/sltb009a/Makefile.features
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
CPU = efm32
CPU_FAM = efm32gg12b
CPU_MODEL = efm32gg12b810f1024gm64

# 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
12 changes: 12 additions & 0 deletions boards/sltb009a/Makefile.include
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# set default port depending on operating system
PORT_LINUX ?= /dev/ttyACM0
PORT_DARWIN ?= $(firstword $(sort $(wildcard /dev/tty.usbmodem*)))

# setup serial terminal
include $(RIOTMAKE)/tools/serial.inc.mk

# setup JLink for flashing
JLINK_PRE_FLASH = r

# include board common
include $(RIOTBOARD)/common/silabs/Makefile.include
36 changes: 36 additions & 0 deletions boards/sltb009a/board.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
* Copyright (C) 2015-2020 Freie Universität Berlin
* 2022 Gunar Schorcht
*
* 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_sltb009a
* @{
*
* @file
* @brief Board specific implementations SLTB009A board
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* @author Bas Stottelaar <basstottelaar@gmail.com>
* @author Gunar Schorcht <gunar@schorcht.net>
*
* @}
*/

#include "board.h"
#include "board_common.h"

void board_init(void)
{
#ifndef RIOTBOOT
/* perform common board initialization */
board_common_init();
#endif
/* enable the virtual COM port */
gpio_init(VCOM_EN_PIN, GPIO_OUT);
gpio_set(VCOM_EN_PIN);
}
232 changes: 232 additions & 0 deletions boards/sltb009a/doc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,232 @@
/**
* @defgroup boards_sltb009a Silicon Labs SLTB009A starter kit
* @ingroup boards
* @brief Support for Silicon Labs SLTB009A starter kit

## Overview
Silicon Labs Thunderboard GG12 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 | EFM32GG12B810F1024GM64 |
|-----------------|------------------------------------------------------|
| Family | ARM Cortex-M4F |
| Vendor | Silicon Labs |
| Vendor Family | EFM32 Giant Gecko 12B |
| RAM | 192.0 KiB |
| Flash | 1024.0 KiB |
| EEPROM | no |
| Frequency | up to 50 MHz |
| FPU | yes |
| MPU | yes |
| DMA | 12 channels |
| Timers | 4x 32-bit, 7x 16-bit + 1x 16-bit (low power) |
| ADCs | 12-bit ADC |
| UARTs | 2x UART, 5x USART, 1x LEUART |
| SPIs | 5x USART |
| I2Cs | 2x |
| Vcc | 1.8 V - 3.8 V |
| Datasheet | [Datasheet](https://www.silabs.com/documents/public/data-sheets/efm32gg12-datasheet.pdf) |
| Manual | [Manual](https://www.silabs.com/documents/public/reference-manuals/efm32gg12-rm.pdf) |
| Board Manual | [Board Manual](https://www.silabs.com/documents/public/user-guides/ug371-sltb009a-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 | |
|------|-----|-----|------|
| GND | 1 | 2 | VMCU |
| PD0 | 3 | 4 | PA0 |
| PD1 | 5 | 6 | PA1 |
| PA4 | 7 | 8 | PA2 |
| PA5 | 9 | 10 | PA3 |
| PA6 | 11 | 12 | PC4 |
| PE15 | 13 | 14 | PC5 |
| PE5 | 15 | 16 | PE4 |
| | 17 | 18 | 5V |
| | 19 | 20 | 3V3 |
| PB12 | 21 | 22 | PE8 |
| PB11 | 23 | 24 | PE9 |
| PB3 | 25 | 26 | PE10 |
| PB4 | 27 | 28 | PE11 |
| PD2 | 29 | 30 | PE13 |
| PD3 | 31 | 32 | PE14 |
| PD4 | 33 | 34 | PF5 |

**Note**: not all starter kits by Silicon Labs share the same pinout!

### Peripheral mapping
| Peripheral | Number | Hardware | Pins | Comments |
|------------|---------|-------------------|-----------------------------------|-----------------------------------------------------------|

### User interface
| Peripheral | Mapped to | Pin | Comments |
|------------|-----------|------|------------|
| Button | PB0_PIN | PD5 | |
| | PB1_PIN | PD8 | |
| LED | LED0R_PIN | PA12 | |
| | LED0G_PIN | PA13 | |
| | LED0B_PIN | PA14 | |
| | LED1R_PIN | PD6 | |
| | LED1G_PIN | PF12 | |
| | LED1B_PIN | PE12 | |
| | LED0_PIN | LED0R_PIN | |
| | LED1_PIN | LED1R_PIN | |

## Implementation Status
| Device | ID | Supported | Comments |
|-------------------------------|-------------------------------------|-----------|----------------------------------------------------------------|
| MCU | EFM32GG12B | 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 | |
| | RTCC | 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 | |

## Board configuration

### Board controller
The starter kit is equipped with a Board Controller. This controller provides
a virtual serial port.

**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 | 19 MHz | Enabled during startup, changeable |
| HFXO | No | 50 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 |
| LFE | LFRCO, LFXO | Real-time Clock and Calendar |

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 32-bit *Real-Time Clock and
Calendar*, which can be configured in ticker mode **or** calendar mode.
Therefore, only one of both peripherals can be enabled at the same time.

Configured at 1 Hz interval, the RTCC will overflow each 136 years.

### Hardware crypto
This MCU is equipped with a hardware-accelerated crypto peripheral that can
speed up AES128, AES256, SHA1, SHA256 and several other cryptographic
computations.

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.

This MCU has extended pin mapping support. Each pin of a peripheral can be
connected separately to one of the predefined pins for that peripheral.

## 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 SLTB009A 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).
*/
Loading