HAL Configuration Reference
The HAL Config framework is a set of standardized configuration options
which can be used to initialize and customize hardware peripherals and
drivers. These options, spanning from antenna diversity GPIO to enabling
the watchdog, are constructed with three components:
Prefix_Module_Option
Prefix - There are two prefixes for HAL config defines: BSP and HAL. As the name suggests, BSP (board support package) type options relate to the board design, for example GPIO route locations, clock/crystal options, and DCDC usage.
Module - There are 38 HAL config modules.
Each module pertains to a set of hardware features based on an underlying
peripheral and/or software enhancements. Core (Hardware Configurator) modules
map directly onto peripherals present on the chip and will always be present
on a chip which has that peripheral, while other modules might be stack-specific.
Core Modules
HAL Modules
NCP Modules
Radio Modules
Serial Modules
PWM Modules
Third Party Modules
Option - Each module can be customized by defining configuration options. These might include enabling/disabling the module, specifying a peripheral signal route location, or mode to initialize the module. A full list of HAL Config options can be found below.
Core modules
With core modules, pay close attention to the define names. When a peripheral has
an instance number in the datasheet, the peripheral name in the define will get replaced
by the peripheral name plus the instance number. For example, if the definition for an option
on UART is BSP_UART_TX_PIN, each UART peripheral will generate its own define (e.g.
BSP_UART0_TX_PIN for UART0). This is valid for all of the defines in the core peripheral.
ACMP
Define |
Value |
Dependency |
Description |
BSP_ACMP_NEG |
|
SERIES1 |
Negative input selection |
BSP_ACMP_POS |
|
SERIES1 |
Positive input selection |
ADC
Define |
Value |
Dependency |
Description |
BSP_ADC_NEG |
|
SERIES1 |
Negative input selection |
BSP_ADC_POS |
|
SERIES1 |
Positive input selection |
BSP_ADC_SCAN_MASK |
|
SERIES1 |
Scan input mask |
HAL_ADC_ENABLE |
[0, 1] |
SERIES1 |
Enable ADC |
CMU
Define |
Value |
Dependency |
Description |
BSP_CLK_HFXO_BOOST |
_CMU_CTRL_HFXOBOOST_50PCENT, _CMU_CTRL_HFXOBOOST_70PCENT, _CMU_CTRL_HFXOBOOST_80PCENT, _CMU_CTRL_HFXOBOOST_100PCENT |
SERIES0 |
HFXO Boost |
BSP_CLK_HFXO_CTUNE |
uint16_t |
SERIES1 |
HFXO CTUNE value |
BSP_CLK_HFXO_CTUNE_TOKEN |
[0, 1] |
SERIES1, RADIO |
Calibrate HFXO CTUNE from mfg token |
BSP_CLK_HFXO_FREQ |
uint32_t |
None |
HFXO frequency (See datasheet for maximum) |
BSP_CLK_HFXO_INIT |
string |
None |
HFXO initialization settings struct |
BSP_CLK_HFXO_PRESENT |
[0, 1] |
None |
HFXO present on board |
BSP_CLK_LFXO_BOOST |
0, 2, 1, 3 |
SERIES0 |
LFXO Boost |
BSP_CLK_LFXO_CTUNE |
uint16_t |
SERIES1 |
LFXO CTUNE value |
BSP_CLK_LFXO_FREQ |
uint32_t |
None |
LFXO frequency |
BSP_CLK_LFXO_INIT |
string |
None |
LFXO initialization settings struct |
BSP_CLK_LFXO_PRESENT |
[0, 1] |
None |
LFXO present on board |
HAL_CLK_HFCLK_SOURCE |
HAL_CLK_HFCLK_SOURCE_HFRCO, HAL_CLK_HFCLK_SOURCE_HFXO |
None |
HF clock source |
HAL_CLK_HFXO_AUTOSTART |
HAL_CLK_HFXO_AUTOSTART_NONE, HAL_CLK_HFXO_AUTOSTART_START, HAL_CLK_HFXO_AUTOSTART_SELECT |
SERIES1 |
Start HFXO automatically on EM0/1 entry |
HAL_CLK_LFACLK_SOURCE |
HAL_CLK_LFCLK_SOURCE_DISABLED, HAL_CLK_LFCLK_SOURCE_LFRCO, HAL_CLK_LFCLK_SOURCE_LFXO, HAL_CLK_LFCLK_SOURCE_ULFRCO, HAL_CLK_LFCLK_SOURCE_HFLE, HAL_CLK_LFCLK_SOURCE_PLFRCO |
None |
LFA clock source |
HAL_CLK_LFBCLK_SOURCE |
HAL_CLK_LFCLK_SOURCE_DISABLED, HAL_CLK_LFCLK_SOURCE_LFRCO, HAL_CLK_LFCLK_SOURCE_LFXO, HAL_CLK_LFCLK_SOURCE_ULFRCO, HAL_CLK_LFCLK_SOURCE_HFLE, HAL_CLK_LFCLK_SOURCE_PLFRCO |
None |
LFB clock source |
HAL_CLK_LFCCLK_SOURCE |
HAL_CLK_LFCLK_SOURCE_DISABLED, HAL_CLK_LFCLK_SOURCE_LFRCO, HAL_CLK_LFCLK_SOURCE_LFXO, HAL_CLK_LFCLK_SOURCE_PLFRCO |
['efm32gg11b', 'efm32hg', 'ezr32hg'] |
LFC clock source |
HAL_CLK_LFECLK_SOURCE |
HAL_CLK_LFCLK_SOURCE_DISABLED, HAL_CLK_LFCLK_SOURCE_LFRCO, HAL_CLK_LFCLK_SOURCE_LFXO, HAL_CLK_LFCLK_SOURCE_ULFRCO, HAL_CLK_LFCLK_SOURCE_PLFRCO |
SERIES1 |
LFE clock source |
CSEN
Define |
Value |
Dependency |
Description |
BSP_CSEN_BONDED_MASK0 |
|
SERIES1 |
Bonded input mask (0-31) |
BSP_CSEN_BONDED_MASK1 |
|
SERIES1 |
Bonded input mask (32-63) |
BSP_CSEN_SCAN_MASK0 |
|
SERIES1 |
Scan input mask (0-31) |
BSP_CSEN_SCAN_MASK1 |
|
SERIES1 |
Scan input mask (32-63) |
BSP_CSEN_SINGLE_INPUT |
|
SERIES1 |
Single input selection |
DCDC
Define |
Value |
Dependency |
Description |
BSP_DCDC_INIT |
string |
SERIES1 |
DCDC initialization options struct |
BSP_DCDC_PRESENT |
[0, 1] |
SERIES1 |
Power circuit configured for DCDC |
HAL_DCDC_BYPASS |
[0, 1] |
SERIES1 |
Bypass DCDC |
EMU
Define |
Value |
Dependency |
Description |
HAL_EMU_EM01_VSCALE |
[0, 1] |
SERIES1, not ['efm32pg1b', 'efm32jg1b', 'efr32mg1', 'efr32bg1', 'efr32fg1'] |
Enable voltage scaling in EM0/1 |
HAL_EMU_EM23_VREG |
[0, 1] |
SERIES0 |
Enable full VREG drive strength in EM2/3 |
HAL_EMU_EM23_VSCALE |
HAL_EMU_EM23_VSCALE_FASTWAKEUP, HAL_EMU_EM23_VSCALE_LOWPOWER |
SERIES1, not ['efm32pg1b', 'efm32jg1b', 'efr32mg1', 'efr32bg1', 'efr32fg1'] |
EM2/3 voltage scaling level |
HAL_EMU_ENABLE |
[0, 1] |
None |
Initialize EMU settings |
GPIO
Define |
Value |
Dependency |
Description |
BSP_TRACE_DBGROUTE_LOC |
_GPIO_ROUTE_SWLOCATION_LOC0 |
SERIES0, not ['efm32zg', 'efm32hg', 'ezr32hg'] |
Serial Wire Output location (Series 0) |
BSP_TRACE_SWO_LOC |
_GPIO_ROUTELOC0_SWVLOC_LOC0 |
SERIES1 |
Serial Wire Output location (Series 1) |
BSP_TRACE_SWO_PIN |
0-15 |
None |
Serial Wire Output pin |
BSP_TRACE_SWO_PORT |
GPIO_Port_TypeDef |
None |
Serial Wire Output port |
I2C
Define |
Value |
Dependency |
Description |
BSP_I2C_SCL_PIN |
0-15 |
None |
I2C SCL pin |
BSP_I2C_SCL_PORT |
GPIO_Port_TypeDef |
None |
I2C SCL port |
BSP_I2C_SCL_LOC |
_I2C_ROUTELOC0_SCLLOC_LOCn |
SERIES1 |
I2C SCL location |
BSP_I2C_SDA_PIN |
0-15 |
None |
I2C SDA pin |
BSP_I2C_SDA_PORT |
GPIO_Port_TypeDef |
None |
I2C SDA port |
BSP_I2C_SDA_LOC |
_I2C_ROUTELOC0_SDALOC_LOCn |
SERIES1 |
I2C SDA location |
HAL_I2C_ENABLE |
[0, 1] |
None |
Enable I2C peripheral |
HAL_I2C_INIT_ENABLE |
[0, 1] |
None |
Enable I2C after init |
HAL_I2C_LOW_HIGH_RATIO |
_I2C_CTRL_CLHR_STANDARD, _I2C_CTRL_CLHR_ASYMMETRIC, _I2C_CTRL_CLHR_FAST |
None |
Clock Low/High ratio |
HAL_I2C_MASTER |
[0, 1] |
None |
I2C Master |
HAL_I2C_MAX_BUS_FREQ |
uint32_t |
None |
Bus frequency |
HAL_I2C_SLAVE_ADDRESS |
uint8_t |
None |
Slave address |
IDAC
Define |
Value |
Dependency |
Description |
BSP_IDAC_OUTPUT |
|
SERIES1 |
Output selection |
LEUART
Define |
Value |
Dependency |
Description |
BSP_LEUART_RX_PIN |
0-15 |
None |
RX pin |
BSP_LEUART_RX_PORT |
GPIO_Port_TypeDef |
None |
RX port |
BSP_LEUART_RX_LOC |
_LEUART_ROUTELOC0_RXLOC_LOCn |
SERIES1 |
RX location |
BSP_LEUART_TX_PIN |
0-15 |
None |
TX pin |
BSP_LEUART_TX_PORT |
GPIO_Port_TypeDef |
None |
TX port |
BSP_LEUART_TX_LOC |
_LEUART_ROUTELOC0_TXLOC_LOCn |
SERIES1 |
TX location |
HAL_LEUART_BAUD_RATE |
uint32_t |
None |
Baud rate |
HAL_LEUART_ENABLE |
[0, 1] |
None |
Enable LEUART |
HAL_LEUART_FLOW_CONTROL |
HAL_LEUART_FLOW_CONTROL_NONE, HAL_LEUART_FLOW_CONTROL_SW, HAL_LEUART_FLOW_CONTROL_HW |
None |
Flow control mode |
HAL_LEUART_RXSTART |
uint16_t |
None |
Release flow control threshold |
HAL_LEUART_RXSTOP |
uint16_t |
None |
Flow control threshold |
HAL_LEUART_RX_QUEUE_SIZE |
uint16_t |
None |
RX buffer size |
HAL_LEUART_TX_QUEUE_SIZE |
uint16_t |
None |
TX buffer size |
PA
Define |
Value |
Dependency |
Description |
BSP_PA_VOLTAGE |
uint16_t |
SERIES1, RADIO |
PA voltage (mV) |
HAL_PA_2P4_LOWPOWER |
[0, 1] |
SERIES1, RADIO |
Use low power PA on 2.4 GHz |
HAL_PA_CURVE_HEADER |
string |
SERIES1, RADIO |
Custom PA curve header file |
HAL_PA_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable PA |
HAL_PA_POWER |
uint8_t |
SERIES1, RADIO |
Output power (raw units) |
HAL_PA_RAMP |
uint16_t |
SERIES1, RADIO |
Ramp time (us) |
PTI
Define |
Value |
Dependency |
Description |
BSP_PTI_DCLK_PIN |
0-15 |
SERIES1, RADIO |
DCLK pin |
BSP_PTI_DCLK_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
DCLK port |
BSP_PTI_DCLK_LOC |
_FRC_ROUTELOC0_DCLKLOC_LOCn |
SERIES1, RADIO |
DCLK location |
BSP_PTI_DFRAME_PIN |
0-15 |
SERIES1, RADIO |
DFRAME pin |
BSP_PTI_DFRAME_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
DFRAME port |
BSP_PTI_DFRAME_LOC |
_FRC_ROUTELOC0_DFRAMELOC_LOCn |
SERIES1, RADIO |
DFRAME location |
BSP_PTI_DOUT_PIN |
0-15 |
SERIES1, RADIO |
DOUT pin |
BSP_PTI_DOUT_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
DOUT port |
BSP_PTI_DOUT_LOC |
_FRC_ROUTELOC0_DOUTLOC_LOCn |
SERIES1, RADIO |
DOUT location |
HAL_PTI_BAUD_RATE |
uint32_t |
SERIES1, RADIO |
PTI baud rate |
HAL_PTI_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable PTI peripheral |
TIMER
Define |
Value |
Dependency |
Description |
BSP_TIMER_CC0_PIN |
0-15 |
None |
TIMER Compare/Capture Channel 0 pin |
BSP_TIMER_CC0_PORT |
GPIO_Port_TypeDef |
None |
TIMER Compare/Capture Channel 0 port |
BSP_TIMER_CC0_LOC |
_TIMER_ROUTELOC0_CC0LOC_LOCn |
SERIES1 |
TIMER Compare/Capture Channel 0 location |
BSP_TIMER_CC1_PIN |
0-15 |
None |
TIMER Compare/Capture Channel 1 pin |
BSP_TIMER_CC1_PORT |
GPIO_Port_TypeDef |
None |
TIMER Compare/Capture Channel 1 port |
BSP_TIMER_CC1_LOC |
_TIMER_ROUTELOC0_CC1LOC_LOCn |
SERIES1 |
TIMER Compare/Capture Channel 1 location |
BSP_TIMER_CC2_PIN |
0-15 |
None |
TIMER Compare/Capture Channel 2 pin |
BSP_TIMER_CC2_PORT |
GPIO_Port_TypeDef |
None |
TIMER Compare/Capture Channel 2 port |
BSP_TIMER_CC2_LOC |
_TIMER_ROUTELOC0_CC2LOC_LOCn |
SERIES1 |
TIMER Compare/Capture Channel 2 location |
BSP_TIMER_CC3_PIN |
0-15 |
SERIES1, TIMER1 |
TIMER Compare/Capture Channel 3 pin |
BSP_TIMER_CC3_PORT |
GPIO_Port_TypeDef |
SERIES1, TIMER1 |
TIMER Compare/Capture Channel 3 port |
BSP_TIMER_CC3_LOC |
_TIMER_ROUTELOC0_CC3LOC_LOCn |
SERIES1, TIMER1 |
TIMER Compare/Capture Channel 3 location |
UART
Define |
Value |
Dependency |
Description |
BSP_UART_RX_PIN |
0-15 |
None |
RX pin |
BSP_UART_RX_PORT |
GPIO_Port_TypeDef |
None |
RX port |
BSP_UART_RX_LOC |
_UART_ROUTELOC0_RXLOC_LOCn |
SERIES1 |
RX location |
BSP_UART_TX_PIN |
0-15 |
None |
TX pin |
BSP_UART_TX_PORT |
GPIO_Port_TypeDef |
None |
TX port |
BSP_UART_TX_LOC |
_UART_ROUTELOC0_TXLOC_LOCn |
SERIES1 |
TX location |
HAL_UART_BAUD_RATE |
uint32_t |
None |
Baud rate |
HAL_UART_ENABLE |
[0, 1] |
None |
Enable UART |
HAL_UART_FLOW_CONTROL |
HAL_UART_FLOW_CONTROL_NONE, HAL_UART_FLOW_CONTROL_SW, HAL_UART_FLOW_CONTROL_HW, HAL_UART_FLOW_CONTROL_HWUART |
None |
Flow control mode |
HAL_UART_RXSTART |
uint16_t |
None |
Release flow control threshold |
HAL_UART_RXSTOP |
uint16_t |
None |
Flow control threshold |
HAL_UART_RX_QUEUE_SIZE |
uint16_t |
None |
RX buffer size |
HAL_UART_TX_QUEUE_SIZE |
uint16_t |
None |
TX buffer size |
USART
Define |
Value |
Dependency |
Description |
BSP_USART_CLK_PIN |
0-15 |
None |
USART CLK pin |
BSP_USART_CLK_PORT |
GPIO_Port_TypeDef |
None |
USART CLK port |
BSP_USART_CLK_LOC |
_USART_ROUTELOC0_CLKLOC_LOCn |
SERIES1 |
USART CLK location |
BSP_USART_CS_PIN |
0-15 |
None |
USART CS pin |
BSP_USART_CS_PORT |
GPIO_Port_TypeDef |
None |
USART CS port |
BSP_USART_CS_LOC |
_USART_ROUTELOC0_CSLOC_LOCn |
SERIES1 |
USART CS location |
BSP_USART_CTS_PIN |
0-15 |
SERIES1 |
USART CTS pin |
BSP_USART_CTS_PORT |
GPIO_Port_TypeDef |
SERIES1 |
USART CTS port |
BSP_USART_CTS_LOC |
_USART_ROUTELOC1_CTSLOC_LOCn |
SERIES1 |
USART CTS location |
BSP_USART_MISO_PIN |
0-15 |
None |
USART MISO pin |
BSP_USART_MISO_PORT |
GPIO_Port_TypeDef |
None |
USART MISO port |
BSP_USART_MISO_LOC |
_USART_ROUTELOC0_RXLOC_LOCn |
SERIES1 |
USART MISO location |
BSP_USART_MOSI_PIN |
0-15 |
None |
USART MOSI pin |
BSP_USART_MOSI_PORT |
GPIO_Port_TypeDef |
None |
USART MOSI port |
BSP_USART_MOSI_LOC |
_USART_ROUTELOC0_TXLOC_LOCn |
SERIES1 |
USART MOSI location |
BSP_USART_RTS_PIN |
0-15 |
SERIES1 |
USART RTS pin |
BSP_USART_RTS_PORT |
GPIO_Port_TypeDef |
SERIES1 |
USART RTS port |
BSP_USART_RTS_LOC |
_USART_ROUTELOC1_RTSLOC_LOCn |
SERIES1 |
USART RTS location |
BSP_USART_RX_PIN |
0-15 |
None |
USART RX pin |
BSP_USART_RX_PORT |
GPIO_Port_TypeDef |
None |
USART RX port |
BSP_USART_RX_LOC |
_USART_ROUTELOC0_RXLOC_LOCn |
SERIES1 |
USART RX location |
BSP_USART_TX_PIN |
0-15 |
None |
USART TX pin |
BSP_USART_TX_PORT |
GPIO_Port_TypeDef |
None |
USART TX port |
BSP_USART_TX_LOC |
_USART_ROUTELOC0_TXLOC_LOCn |
SERIES1 |
USART TX location |
HAL_USART_BAUD_RATE |
uint32_t |
None |
Baud rate |
HAL_USART_ENABLE |
[0, 1] |
None |
Enable USART |
HAL_USART_FLOW_CONTROL |
HAL_USART_FLOW_CONTROL_NONE, HAL_USART_FLOW_CONTROL_SW, HAL_USART_FLOW_CONTROL_HW, HAL_USART_FLOW_CONTROL_HWUART |
None |
Flow control mode |
HAL_USART_FREQUENCY |
uint32_t |
None |
Frequency |
HAL_USART_RXSTART |
uint16_t |
None |
Release flow control threshold |
HAL_USART_RXSTOP |
uint16_t |
None |
Flow control threshold |
HAL_USART_RX_QUEUE_SIZE |
uint16_t |
None |
RX buffer size |
HAL_USART_TX_QUEUE_SIZE |
uint16_t |
None |
TX buffer size |
VDAC
Define |
Value |
Dependency |
Description |
BSP_VDAC_OPA0_NEG |
|
SERIES1 |
Negative input selection |
BSP_VDAC_OPA0_OUT |
|
SERIES1 |
Output selection |
BSP_VDAC_OPA0_POS |
|
SERIES1 |
Positive input selection |
BSP_VDAC_OPA1_NEG |
|
SERIES1 |
Negative input selection |
BSP_VDAC_OPA1_OUT |
|
SERIES1 |
Output selection |
BSP_VDAC_OPA1_POS |
|
SERIES1 |
Positive input selection |
BSP_VDAC_OPA2_NEG |
|
not ['efm32pg14b', 'efm32jg14b', 'efr32mg14', 'efr32bg14', 'efr32fg14'] |
Negative input selection |
BSP_VDAC_OPA2_OUT |
|
not ['efm32pg14b', 'efm32jg14b', 'efr32mg14', 'efr32bg14', 'efr32fg14'] |
Output selection |
BSP_VDAC_OPA2_POS |
|
not ['efm32pg14b', 'efm32jg14b', 'efr32mg14', 'efr32bg14', 'efr32fg14'] |
Positive input selection |
BSP_VDAC_OPA3_NEG |
|
['efm32gg11b', 'efm32tg11b'] |
Negative input selection |
BSP_VDAC_OPA3_OUT |
|
['efm32gg11b', 'efm32tg11b'] |
Output selection |
BSP_VDAC_OPA3_POS |
|
['efm32gg11b', 'efm32tg11b'] |
Positive input selection |
WDOG
Define |
Value |
Dependency |
Description |
HAL_WDOG_ENABLE |
[0, 1] |
None |
Enable watchdog |
HAL modules
Bootloader Entry
Define |
Value |
Dependency |
Description |
BSP_BTL_BUTTON_PIN |
0-15 |
None |
Bootloader entry pin |
BSP_BTL_BUTTON_PORT |
GPIO_Port_TypeDef |
None |
Bootloader entry port |
HAL_BTL_BUTTON_ENABLE |
[0, 1] |
None |
Enable bootloader entry via button press |
Define |
Value |
Dependency |
Description |
BSP_BUTTON_COUNT |
uint8_t |
None |
Number of buttons available on board |
BSP_BUTTONn_PIN |
0-15 |
None |
BUTTONn pin |
BSP_BUTTONn_PORT |
GPIO_Port_TypeDef |
None |
BUTTONn port |
BSP_BUTTON_GPIO_DOUT |
HAL_GPIO_DOUT_LOW, HAL_GPIO_DOUT_HIGH |
None |
DOUT register value of button pins |
BSP_BUTTON_GPIO_MODE |
HAL_GPIO_MODE_INPUT, HAL_GPIO_MODE_INPUT_PULL, HAL_GPIO_MODE_INPUT_PULL_FILTER |
None |
MODE register value of button pins |
BSP_BUTTON_PRESENT |
[0, 1] |
None |
Buttons present on board |
HAL_BUTTON_COUNT |
uint8_t |
None |
Number of buttons to enable |
HAL_BUTTON_ENABLE |
array |
None |
List of button indices to enable |
SPI Flash
Define |
Value |
Dependency |
Description |
BSP_EXTFLASH_CLK_PIN |
0-15 |
None |
SPI Flash CLK pin |
BSP_EXTFLASH_CLK_PORT |
GPIO_Port_TypeDef |
None |
SPI Flash CLK port |
BSP_EXTFLASH_CLK_LOC |
_USART_ROUTELOC0_CLKLOC_LOCn |
SERIES1 |
SPI Flash CLK location |
BSP_EXTFLASH_CS_PIN |
0-15 |
None |
SPI Flash CS pin |
BSP_EXTFLASH_CS_PORT |
GPIO_Port_TypeDef |
None |
SPI Flash CS port |
BSP_EXTFLASH_CS_LOC |
_USART_ROUTELOC0_CSLOC_LOCn |
SERIES1 |
SPI Flash CS location |
BSP_EXTFLASH_HOLD_PIN |
0-15 |
None |
Hold pin |
BSP_EXTFLASH_HOLD_PORT |
GPIO_Port_TypeDef |
None |
Hold port |
BSP_EXTFLASH_INTERNAL |
0, 1 |
None |
SPI Flash type |
BSP_EXTFLASH_MISO_PIN |
0-15 |
None |
SPI Flash MISO pin |
BSP_EXTFLASH_MISO_PORT |
GPIO_Port_TypeDef |
None |
SPI Flash MISO port |
BSP_EXTFLASH_MISO_LOC |
_USART_ROUTELOC0_RXLOC_LOCn |
SERIES1 |
SPI Flash MISO location |
BSP_EXTFLASH_MOSI_PIN |
0-15 |
None |
SPI Flash MOSI pin |
BSP_EXTFLASH_MOSI_PORT |
GPIO_Port_TypeDef |
None |
SPI Flash MOSI port |
BSP_EXTFLASH_MOSI_LOC |
_USART_ROUTELOC0_TXLOC_LOCn |
SERIES1 |
SPI Flash MOSI location |
BSP_EXTFLASH_USART |
HAL_SPI_PORT_USARTn |
None |
USART connected to SPI Flash |
BSP_EXTFLASH_WP_PIN |
0-15 |
None |
Write Protect pin |
BSP_EXTFLASH_WP_PORT |
GPIO_Port_TypeDef |
None |
Write Protect port |
I2C Sensor
Define |
Value |
Dependency |
Description |
BSP_I2CSENSOR_ENABLE_PIN |
0-15 |
None |
Sensor enable pin |
BSP_I2CSENSOR_ENABLE_PORT |
GPIO_Port_TypeDef |
None |
Sensor enable port |
BSP_I2CSENSOR_PERIPHERAL |
HAL_I2C_PORT_I2Cn |
None |
I2C peripheral |
BSP_I2CSENSOR_SCL_PIN |
0-15 |
None |
I2C Sensor SCL pin |
BSP_I2CSENSOR_SCL_PORT |
GPIO_Port_TypeDef |
None |
I2C Sensor SCL port |
BSP_I2CSENSOR_SCL_LOC |
_I2C_ROUTELOC0_SCLLOC_LOCn |
SERIES1 |
I2C Sensor SCL location |
BSP_I2CSENSOR_SDA_PIN |
0-15 |
None |
I2C Sensor SDA pin |
BSP_I2CSENSOR_SDA_PORT |
GPIO_Port_TypeDef |
None |
I2C Sensor SDA port |
BSP_I2CSENSOR_SDA_LOC |
_I2C_ROUTELOC0_SDALOC_LOCn |
SERIES1 |
I2C Sensor SDA location |
HAL_I2CSENSOR_ENABLE |
[0, 1] |
None |
Enable I2C sensor |
I2C I/O Expander
Define |
Value |
Dependency |
Description |
BSP_IOEXP_PERIPHERAL |
HAL_I2C_PORT_I2Cn |
None |
IO expander I2C |
BSP_IOEXP_SCL_PIN |
0-15 |
None |
I2C I/O Expander SCL pin |
BSP_IOEXP_SCL_PORT |
GPIO_Port_TypeDef |
None |
I2C I/O Expander SCL port |
BSP_IOEXP_SCL_LOC |
_I2C_ROUTELOC0_SCLLOC_LOCn |
SERIES1 |
I2C I/O Expander SCL location |
BSP_IOEXP_SDA_PIN |
0-15 |
None |
I2C I/O Expander SDA pin |
BSP_IOEXP_SDA_PORT |
GPIO_Port_TypeDef |
None |
I2C I/O Expander SDA port |
BSP_IOEXP_SDA_LOC |
_I2C_ROUTELOC0_SDALOC_LOCn |
SERIES1 |
I2C I/O Expander SDA location |
BSP_IOEXP_WAKE_PIN |
0-15 |
None |
IOEXP wake pin |
BSP_IOEXP_WAKE_PORT |
GPIO_Port_TypeDef |
None |
IOEXP wake port |
HAL_IOEXP_ENABLE |
[0, 1] |
None |
Enable IO expander |
HAL_IOEXP_VCOM_ENABLE |
[0, 1] |
None |
Enable VCOM via IO expander |
LED
Define |
Value |
Dependency |
Description |
BSP_LED_COUNT |
uint8_t |
None |
Number of LEDs available on board |
BSP_LEDn_PIN |
0-15 |
None |
LEDn pin |
BSP_LEDn_PORT |
GPIO_Port_TypeDef |
None |
LEDn port |
BSP_LED_PRESENT |
[0, 1] |
None |
LEDs present on board |
HAL_LED_COUNT |
uint8_t |
None |
Number of LEDs to initialize |
HAL_LED_ENABLE |
array |
None |
List of LED indices to initialize |
SPI Display
Define |
Value |
Dependency |
Description |
BSP_SPIDISPLAY_CLK_PIN |
0-15 |
not efm32g |
SPI Display CLK pin |
BSP_SPIDISPLAY_CLK_PORT |
GPIO_Port_TypeDef |
not efm32g |
SPI Display CLK port |
BSP_SPIDISPLAY_CLK_LOC |
_USART_ROUTELOC0_CLKLOC_LOCn |
SERIES1, not efm32g |
SPI Display CLK location |
BSP_SPIDISPLAY_CS_PIN |
0-15 |
not efm32g |
SPI Display CS pin |
BSP_SPIDISPLAY_CS_PORT |
GPIO_Port_TypeDef |
not efm32g |
SPI Display CS port |
BSP_SPIDISPLAY_CS_LOC |
_USART_ROUTELOC0_CSLOC_LOCn |
SERIES1, not efm32g |
SPI Display CS location |
BSP_SPIDISPLAY_DISPLAY |
HAL_DISPLAY_SHARP_LS013B7DH03, HAL_DISPLAY_SHARP_LS013B7DH06 |
not efm32g |
Display type |
BSP_SPIDISPLAY_ENABLE_PIN |
0-15 |
not efm32g |
Display enable pin |
BSP_SPIDISPLAY_ENABLE_PORT |
GPIO_Port_TypeDef |
not efm32g |
Display enable port |
BSP_SPIDISPLAY_EXTCOMIN_PIN |
0-15 |
not efm32g |
EXTCOMIN pin |
BSP_SPIDISPLAY_EXTCOMIN_PORT |
GPIO_Port_TypeDef |
not efm32g |
EXTCOMIN port |
BSP_SPIDISPLAY_EXTCOMIN_PRS_CHANNEL |
PRS Channel |
not efm32g |
EXTCOMIN PRS channel PRS channel |
BSP_SPIDISPLAY_EXTCOMIN_PRS_PIN |
0-15 |
not efm32g |
EXTCOMIN PRS channel pin |
BSP_SPIDISPLAY_EXTCOMIN_PRS_PORT |
GPIO_Port_TypeDef |
not efm32g |
EXTCOMIN PRS channel port |
BSP_SPIDISPLAY_EXTCOMIN_PRS_LOC |
_PRS_ROUTELOC0_CHnLOC_LOCm |
SERIES1, not efm32g |
EXTCOMIN PRS channel location |
BSP_SPIDISPLAY_EXTMODE_PIN |
0-15 |
not efm32g |
EXTMODE pin |
BSP_SPIDISPLAY_EXTMODE_PORT |
GPIO_Port_TypeDef |
not efm32g |
EXTMODE port |
BSP_SPIDISPLAY_MISO_PIN |
0-15 |
not efm32g |
SPI Display MISO pin |
BSP_SPIDISPLAY_MISO_PORT |
GPIO_Port_TypeDef |
not efm32g |
SPI Display MISO port |
BSP_SPIDISPLAY_MISO_LOC |
_USART_ROUTELOC0_RXLOC_LOCn |
SERIES1, not efm32g |
SPI Display MISO location |
BSP_SPIDISPLAY_MOSI_PIN |
0-15 |
not efm32g |
SPI Display MOSI pin |
BSP_SPIDISPLAY_MOSI_PORT |
GPIO_Port_TypeDef |
not efm32g |
SPI Display MOSI port |
BSP_SPIDISPLAY_MOSI_LOC |
_USART_ROUTELOC0_TXLOC_LOCn |
SERIES1, not efm32g |
SPI Display MOSI location |
BSP_SPIDISPLAY_USART |
HAL_SPI_PORT_USARTn |
not efm32g |
USART port |
HAL_SPIDISPLAY_ENABLE |
[0, 1] |
not efm32g |
Enable SPI display |
HAL_SPIDISPLAY_EXTCOMIN_CALLBACK |
string |
not efm32g |
EXTCOMIN callback registration function |
HAL_SPIDISPLAY_EXTCOMIN_USE_CALLBACK |
[0, 1] |
not efm32g |
Toggle EXTCOMIN from software callback |
HAL_SPIDISPLAY_EXTCOMIN_USE_PRS |
[0, 1] |
not efm32g |
Autonomously toggle EXTCOMIN using PRS |
HAL_SPIDISPLAY_EXTMODE_EXTCOMIN |
[0, 1] |
not efm32g |
Use EXTCOMIN pin for polarity inversion |
HAL_SPIDISPLAY_EXTMODE_SPI |
[0, 1] |
not efm32g |
Use SPI command for polarity inversion |
NCP modules
Back to top
SPI NCP
Define |
Value |
Dependency |
Description |
BSP_SPINCP_CLK_PIN |
0-15 |
None |
SPI NCP CLK pin |
BSP_SPINCP_CLK_PORT |
GPIO_Port_TypeDef |
None |
SPI NCP CLK port |
BSP_SPINCP_CLK_LOC |
_USART_ROUTELOC0_CLKLOC_LOCn |
SERIES1 |
SPI NCP CLK location |
BSP_SPINCP_CS_PIN |
0-15 |
None |
SPI NCP CS pin |
BSP_SPINCP_CS_PORT |
GPIO_Port_TypeDef |
None |
SPI NCP CS port |
BSP_SPINCP_CS_LOC |
_USART_ROUTELOC0_CSLOC_LOCn |
SERIES1 |
SPI NCP CS location |
BSP_SPINCP_MISO_PIN |
0-15 |
None |
SPI NCP MISO pin |
BSP_SPINCP_MISO_PORT |
GPIO_Port_TypeDef |
None |
SPI NCP MISO port |
BSP_SPINCP_MISO_LOC |
_USART_ROUTELOC0_RXLOC_LOCn |
SERIES1 |
SPI NCP MISO location |
BSP_SPINCP_MOSI_PIN |
0-15 |
None |
SPI NCP MOSI pin |
BSP_SPINCP_MOSI_PORT |
GPIO_Port_TypeDef |
None |
SPI NCP MOSI port |
BSP_SPINCP_MOSI_LOC |
_USART_ROUTELOC0_TXLOC_LOCn |
SERIES1 |
SPI NCP MOSI location |
BSP_SPINCP_NHOSTINT_PIN |
0-15 |
None |
nHOST_INT pin |
BSP_SPINCP_NHOSTINT_PORT |
GPIO_Port_TypeDef |
None |
nHOST_INT port |
BSP_SPINCP_NWAKE_PIN |
0-15 |
None |
nWAKE pin |
BSP_SPINCP_NWAKE_PORT |
GPIO_Port_TypeDef |
None |
nWAKE port |
BSP_SPINCP_USART_PORT |
HAL_SPI_PORT_USARTn |
None |
USART port |
UART NCP
Define |
Value |
Dependency |
Description |
BSP_UARTNCP_CTS_PIN |
0-15 |
SERIES1 |
UART NCP CTS pin |
BSP_UARTNCP_CTS_PORT |
GPIO_Port_TypeDef |
SERIES1 |
UART NCP CTS port |
BSP_UARTNCP_CTS_LOC |
_USART_ROUTELOC1_CTSLOC_LOCn |
SERIES1 |
UART NCP CTS location |
BSP_UARTNCP_RTS_PIN |
0-15 |
SERIES1 |
UART NCP RTS pin |
BSP_UARTNCP_RTS_PORT |
GPIO_Port_TypeDef |
SERIES1 |
UART NCP RTS port |
BSP_UARTNCP_RTS_LOC |
_USART_ROUTELOC1_RTSLOC_LOCn |
SERIES1 |
UART NCP RTS location |
BSP_UARTNCP_RX_PIN |
0-15 |
None |
UART NCP RX pin |
BSP_UARTNCP_RX_PORT |
GPIO_Port_TypeDef |
None |
UART NCP RX port |
BSP_UARTNCP_RX_LOC |
_USART_ROUTELOC0_RXLOC_LOCn |
SERIES1 |
UART NCP RX location |
BSP_UARTNCP_TX_PIN |
0-15 |
None |
UART NCP TX pin |
BSP_UARTNCP_TX_PORT |
GPIO_Port_TypeDef |
None |
UART NCP TX port |
BSP_UARTNCP_TX_LOC |
_USART_ROUTELOC0_TXLOC_LOCn |
SERIES1 |
UART NCP TX location |
BSP_UARTNCP_USART_PORT |
['HAL_SERIAL_PORT_USARTn', 'HAL_SERIAL_PORT_UARTn', 'HAL_SERIAL_PORT_LEUARTn'] |
None |
UART port |
Radio modules
Back to top
Antenna Diversity
Define |
Value |
Dependency |
Description |
BSP_ANTDIV_NSEL_PIN |
0-15 |
RADIO |
Complementary antenna select pin |
BSP_ANTDIV_NSEL_PORT |
GPIO_Port_TypeDef |
RADIO |
Complementary antenna select port |
BSP_ANTDIV_SEL_PIN |
0-15 |
RADIO |
Antenna select pin |
BSP_ANTDIV_SEL_PORT |
GPIO_Port_TypeDef |
RADIO |
Antenna select port |
HAL_ANTDIV_ENABLE |
[0, 1] |
RADIO |
Enable antenna diversity. SEL signal must be defined, NSEL is optional. |
Coexistence
Define |
Value |
Dependency |
Description |
BSP_COEX_GNT_ASSERT_LEVEL |
1, 0 |
RADIO |
GRANT assert signal level |
BSP_COEX_GNT_PIN |
0-15 |
RADIO |
GRANT signal pin |
BSP_COEX_GNT_PORT |
GPIO_Port_TypeDef |
RADIO |
GRANT signal port |
BSP_COEX_PRI_ASSERT_LEVEL |
1, 0 |
RADIO |
PRIORITY assert signal level |
BSP_COEX_PRI_PIN |
0-15 |
RADIO |
PRIORITY signal pin |
BSP_COEX_PRI_PORT |
GPIO_Port_TypeDef |
RADIO |
PRIORITY signal port |
BSP_COEX_REQ_ASSERT_LEVEL |
1, 0 |
RADIO |
REQUEST assert signal level |
BSP_COEX_REQ_PIN |
0-15 |
RADIO |
REQUEST signal pin |
BSP_COEX_REQ_PORT |
GPIO_Port_TypeDef |
RADIO |
REQUEST signal port |
BSP_COEX_RHO_ASSERT_LEVEL |
1, 0 |
RADIO |
RHO assert signal level |
BSP_COEX_RHO_PIN |
0-15 |
RADIO |
RHO signal pin |
BSP_COEX_RHO_PORT |
GPIO_Port_TypeDef |
RADIO |
RHO signal port |
HAL_COEX_ACKHOLDOFF |
[0, 1] |
RADIO |
Disable ACKing when GRANT deasserted, RHO asserted, or REQUEST not secured (shared REQUEST only) |
HAL_COEX_ENABLE |
[0, 1] |
RADIO |
Enable radio coexistence |
HAL_COEX_PRI_SHARED |
[0, 1] |
RADIO |
Enable PRIORITY shared mode |
HAL_COEX_REQ_BACKOFF |
uint8_t |
RADIO |
Max REQUEST backoff mask [0-255] |
HAL_COEX_REQ_SHARED |
[0, 1] |
RADIO |
Enable REQUEST shared mode |
HAL_COEX_REQ_WINDOW |
uint16_t |
RADIO |
Assert time between REQUEST and RX/TX start (us) [BLE only] |
HAL_COEX_RETRYRX_ENABLE |
[0, 1] |
RADIO |
Enable REQUEST receive retry |
HAL_COEX_RETRYRX_HIPRI |
[0, 1] |
RADIO |
REQUEST receive retry assert PRIORITY |
HAL_COEX_RETRYRX_TIMEOUT |
uint8_t |
RADIO |
REQUEST receive retry timeout(ms) |
HAL_COEX_RX_HIPRI |
[0, 1] |
RADIO |
Assert PRIORITY when receiving packet |
HAL_COEX_TX_ABORT |
[0, 1] |
RADIO |
Abort transmission mid-packet if GRANT is lost |
HAL_COEX_TX_HIPRI |
[0, 1] |
RADIO |
Assert PRIORITY when transmitting packet |
EZRadioPro
Define |
Value |
Dependency |
Description |
BSP_EZRADIOPRO_CLK_PIN |
0-15 |
RADIO |
EZRadioPro CLK pin |
BSP_EZRADIOPRO_CLK_PORT |
GPIO_Port_TypeDef |
RADIO |
EZRadioPro CLK port |
BSP_EZRADIOPRO_CLK_LOC |
_USART_ROUTELOC0_CLKLOC_LOCn |
SERIES1, RADIO |
EZRadioPro CLK location |
BSP_EZRADIOPRO_CS_PIN |
0-15 |
RADIO |
EZRadioPro CS pin |
BSP_EZRADIOPRO_CS_PORT |
GPIO_Port_TypeDef |
RADIO |
EZRadioPro CS port |
BSP_EZRADIOPRO_CS_LOC |
_USART_ROUTELOC0_CSLOC_LOCn |
SERIES1, RADIO |
EZRadioPro CS location |
BSP_EZRADIOPRO_INT_PIN |
0-15 |
RADIO |
EZRadio Pro Interrupt pin |
BSP_EZRADIOPRO_INT_PORT |
GPIO_Port_TypeDef |
RADIO |
EZRadio Pro Interrupt port |
BSP_EZRADIOPRO_MISO_PIN |
0-15 |
RADIO |
EZRadioPro MISO pin |
BSP_EZRADIOPRO_MISO_PORT |
GPIO_Port_TypeDef |
RADIO |
EZRadioPro MISO port |
BSP_EZRADIOPRO_MISO_LOC |
_USART_ROUTELOC0_RXLOC_LOCn |
SERIES1, RADIO |
EZRadioPro MISO location |
BSP_EZRADIOPRO_MOSI_PIN |
0-15 |
RADIO |
EZRadioPro MOSI pin |
BSP_EZRADIOPRO_MOSI_PORT |
GPIO_Port_TypeDef |
RADIO |
EZRadioPro MOSI port |
BSP_EZRADIOPRO_MOSI_LOC |
_USART_ROUTELOC0_TXLOC_LOCn |
SERIES1, RADIO |
EZRadioPro MOSI location |
BSP_EZRADIOPRO_SDN_PIN |
0-15 |
RADIO |
EZRadio Pro Shutdown pin |
BSP_EZRADIOPRO_SDN_PORT |
GPIO_Port_TypeDef |
RADIO |
EZRadio Pro Shutdown port |
BSP_EZRADIOPRO_USART |
HAL_SPI_PORT_USARTn |
RADIO |
USART port |
HAL_EZRADIOPRO_ENABLE |
[0, 1] |
RADIO |
Enable EZRadio Pro |
HAL_EZRADIOPRO_SHUTDOWN_SLEEP |
[0, 1] |
RADIO |
Shutdown radio when MCU is sleeping |
External FEM
Define |
Value |
Dependency |
Description |
BSP_FEM_BYPASS_PIN |
0-15 |
SERIES1, RADIO |
Bypass pin |
BSP_FEM_BYPASS_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
Bypass port |
BSP_FEM_RX_CHANNEL |
PRS Channel |
SERIES1, RADIO |
RX PRS channel PRS channel |
BSP_FEM_RX_PIN |
0-15 |
SERIES1, RADIO |
RX PRS channel pin |
BSP_FEM_RX_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
RX PRS channel port |
BSP_FEM_RX_LOC |
_PRS_ROUTELOC0_CHnLOC_LOCm |
SERIES1, RADIO |
RX PRS channel location |
BSP_FEM_SLEEP_CHANNEL |
PRS Channel |
SERIES1, RADIO |
Sleep PRS channel PRS channel |
BSP_FEM_SLEEP_PIN |
0-15 |
SERIES1, RADIO |
Sleep PRS channel pin |
BSP_FEM_SLEEP_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
Sleep PRS channel port |
BSP_FEM_SLEEP_LOC |
_PRS_ROUTELOC0_CHnLOC_LOCm |
SERIES1, RADIO |
Sleep PRS channel location |
BSP_FEM_TXPOWER_PIN |
0-15 |
SERIES1, RADIO |
TX power pin |
BSP_FEM_TXPOWER_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
TX power port |
BSP_FEM_TX_CHANNEL |
PRS Channel |
SERIES1, RADIO |
TX PRS channel PRS channel |
BSP_FEM_TX_PIN |
0-15 |
SERIES1, RADIO |
TX PRS channel pin |
BSP_FEM_TX_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
TX PRS channel port |
BSP_FEM_TX_LOC |
_PRS_ROUTELOC0_CHnLOC_LOCm |
SERIES1, RADIO |
TX PRS channel location |
HAL_FEM_BYPASS_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable bypass mode |
HAL_FEM_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable FEM |
HAL_FEM_RX_ACTIVE |
[0, 1] |
SERIES1, RADIO |
Enable RX mode |
HAL_FEM_TX_ACTIVE |
[0, 1] |
SERIES1, RADIO |
Enable TX mode |
HAL_FEM_TX_HIGH_POWER |
[0, 1] |
SERIES1, RADIO |
Enable high power tx |
Serial modules
Back to top
Serial
Define |
Value |
Dependency |
Description |
BSP_SERIAL_APP_CTS_PIN |
0-15 |
SERIES1 |
Serial CTS pin |
BSP_SERIAL_APP_CTS_PORT |
GPIO_Port_TypeDef |
SERIES1 |
Serial CTS port |
BSP_SERIAL_APP_CTS_LOC |
_USART_ROUTELOC1_CTSLOC_LOCn |
SERIES1 |
Serial CTS location |
BSP_SERIAL_APP_PORT |
['HAL_SERIAL_PORT_USARTn', 'HAL_SERIAL_PORT_UARTn', 'HAL_SERIAL_PORT_LEUARTn', 'HAL_SERIAL_PORT_VUART'] |
None |
Port for application serial communication |
BSP_SERIAL_APP_RTS_PIN |
0-15 |
SERIES1 |
Serial RTS pin |
BSP_SERIAL_APP_RTS_PORT |
GPIO_Port_TypeDef |
SERIES1 |
Serial RTS port |
BSP_SERIAL_APP_RTS_LOC |
_USART_ROUTELOC1_RTSLOC_LOCn |
SERIES1 |
Serial RTS location |
BSP_SERIAL_APP_RX_PIN |
0-15 |
None |
Serial RX pin |
BSP_SERIAL_APP_RX_PORT |
GPIO_Port_TypeDef |
None |
Serial RX port |
BSP_SERIAL_APP_RX_LOC |
_USART_ROUTELOC0_RXLOC_LOCn |
SERIES1 |
Serial RX location |
BSP_SERIAL_APP_TX_PIN |
0-15 |
None |
Serial TX pin |
BSP_SERIAL_APP_TX_PORT |
GPIO_Port_TypeDef |
None |
Serial TX port |
BSP_SERIAL_APP_TX_LOC |
_USART_ROUTELOC0_TXLOC_LOCn |
SERIES1 |
Serial TX location |
BSP_SERIAL_ASSERT_CTS_PIN |
0-15 |
SERIES1 |
Serial CTS pin |
BSP_SERIAL_ASSERT_CTS_PORT |
GPIO_Port_TypeDef |
SERIES1 |
Serial CTS port |
BSP_SERIAL_ASSERT_CTS_LOC |
_USART_ROUTELOC1_CTSLOC_LOCn |
SERIES1 |
Serial CTS location |
BSP_SERIAL_ASSERT_PORT |
['HAL_SERIAL_PORT_USARTn', 'HAL_SERIAL_PORT_UARTn', 'HAL_SERIAL_PORT_LEUARTn', 'HAL_SERIAL_PORT_VUART'] |
SERIES1, RADIO |
Port for assert serial communication |
BSP_SERIAL_ASSERT_RTS_PIN |
0-15 |
SERIES1 |
Serial RTS pin |
BSP_SERIAL_ASSERT_RTS_PORT |
GPIO_Port_TypeDef |
SERIES1 |
Serial RTS port |
BSP_SERIAL_ASSERT_RTS_LOC |
_USART_ROUTELOC1_RTSLOC_LOCn |
SERIES1 |
Serial RTS location |
BSP_SERIAL_ASSERT_RX_PIN |
0-15 |
None |
Serial RX pin |
BSP_SERIAL_ASSERT_RX_PORT |
GPIO_Port_TypeDef |
None |
Serial RX port |
BSP_SERIAL_ASSERT_RX_LOC |
_USART_ROUTELOC0_RXLOC_LOCn |
SERIES1 |
Serial RX location |
BSP_SERIAL_ASSERT_TX_PIN |
0-15 |
None |
Serial TX pin |
BSP_SERIAL_ASSERT_TX_PORT |
GPIO_Port_TypeDef |
None |
Serial TX port |
BSP_SERIAL_ASSERT_TX_LOC |
_USART_ROUTELOC0_TXLOC_LOCn |
SERIES1 |
Serial TX location |
HAL_SERIAL_LEUART0_ENABLE |
[0, 1] |
SERIES1, RADIO, ['LEUART0'] |
Use LEUART0 for serial |
HAL_SERIAL_LEUART1_ENABLE |
[0, 1] |
SERIES1, RADIO, ['LEUART1'] |
Use LEUART1 for serial |
HAL_SERIAL_RXWAKE_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable wake from activity on RX GPIO of application port |
HAL_SERIAL_UART0_ENABLE |
[0, 1] |
SERIES1, RADIO, ['UART0'] |
Use UART0 for serial |
HAL_SERIAL_UART1_ENABLE |
[0, 1] |
SERIES1, RADIO, ['UART1'] |
Use UART1 for serial |
HAL_SERIAL_USART0_ENABLE |
[0, 1] |
SERIES1, RADIO, ['USART0'] |
Use USART0 for serial |
HAL_SERIAL_USART1_ENABLE |
[0, 1] |
SERIES1, RADIO, ['USART1'] |
Use USART1 for serial |
HAL_SERIAL_USART2_ENABLE |
[0, 1] |
SERIES1, RADIO, ['USART2'] |
Use USART2 for serial |
HAL_SERIAL_USART3_ENABLE |
[0, 1] |
SERIES1, RADIO, ['USART3'] |
Use USART3 for serial |
Define |
Value |
Dependency |
Description |
BSP_VCOM_ENABLE_PIN |
0-15 |
None |
VCOM enable pin |
BSP_VCOM_ENABLE_PORT |
GPIO_Port_TypeDef |
None |
VCOM enable port |
HAL_VCOM_ENABLE |
[0, 1] |
None |
Enable VCOM |
Virtual UART
Define |
Value |
Dependency |
Description |
HAL_SERIAL_VUART_ENABLE |
[0, 1] |
RADIO |
Enable VUART/Semihosting |
HAL_VUART_TYPE |
HAL_VUART_TYPE_NONE, HAL_VUART_TYPE_SWO, HAL_VUART_TYPE_RTT |
RADIO |
VUART type |
PWM modules
Back to top
PWM Lightbulb
Define |
Value |
Dependency |
Description |
BSP_BULBPWM_CC0_PIN |
0-15 |
SERIES1, RADIO |
PWM Lightbulb Compare/Capture Channel 0 pin |
BSP_BULBPWM_CC0_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
PWM Lightbulb Compare/Capture Channel 0 port |
BSP_BULBPWM_CC0_LOC |
_TIMER_ROUTELOC0_CC0LOC_LOCn |
SERIES1, RADIO |
PWM Lightbulb Compare/Capture Channel 0 location |
BSP_BULBPWM_CC1_PIN |
0-15 |
SERIES1, RADIO |
PWM Lightbulb Compare/Capture Channel 1 pin |
BSP_BULBPWM_CC1_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
PWM Lightbulb Compare/Capture Channel 1 port |
BSP_BULBPWM_CC1_LOC |
_TIMER_ROUTELOC0_CC1LOC_LOCn |
SERIES1, RADIO |
PWM Lightbulb Compare/Capture Channel 1 location |
BSP_BULBPWM_CC2_PIN |
0-15 |
SERIES1, RADIO |
PWM Lightbulb Compare/Capture Channel 2 pin |
BSP_BULBPWM_CC2_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
PWM Lightbulb Compare/Capture Channel 2 port |
BSP_BULBPWM_CC2_LOC |
_TIMER_ROUTELOC0_CC2LOC_LOCn |
SERIES1, RADIO |
PWM Lightbulb Compare/Capture Channel 2 location |
BSP_BULBPWM_CC3_PIN |
0-15 |
SERIES1, RADIO, TIMER1 |
PWM Lightbulb Compare/Capture Channel 3 pin |
BSP_BULBPWM_CC3_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO, TIMER1 |
PWM Lightbulb Compare/Capture Channel 3 port |
BSP_BULBPWM_CC3_LOC |
_TIMER_ROUTELOC0_CC3LOC_LOCn |
SERIES1, RADIO, TIMER1 |
PWM Lightbulb Compare/Capture Channel 3 location |
BSP_BULBPWM_TIMER |
TIMERn |
SERIES1, RADIO |
BULBPWM Timer module |
HAL_BULBPWM_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable BULBPWM |
HAL_BULBPWM_FREQUENCY |
uint16_t |
SERIES1, RADIO |
PWM frequency select |
HAL_BULBPWM_LOWTEMP_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable lowtemp PWM channel (CC1) |
HAL_BULBPWM_STATUS_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable status PWM channel (CC2) |
HAL_BULBPWM_WHITE_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable white PWM channel (CC0) |
Color PWM Lightbulb
Define |
Value |
Dependency |
Description |
BSP_BULBPWM_COLOR_CC0_PIN |
0-15 |
SERIES1, RADIO |
Color PWM Lightbulb Compare/Capture Channel 0 pin |
BSP_BULBPWM_COLOR_CC0_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
Color PWM Lightbulb Compare/Capture Channel 0 port |
BSP_BULBPWM_COLOR_CC0_LOC |
_TIMER_ROUTELOC0_CC0LOC_LOCn |
SERIES1, RADIO |
Color PWM Lightbulb Compare/Capture Channel 0 location |
BSP_BULBPWM_COLOR_CC1_PIN |
0-15 |
SERIES1, RADIO |
Color PWM Lightbulb Compare/Capture Channel 1 pin |
BSP_BULBPWM_COLOR_CC1_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
Color PWM Lightbulb Compare/Capture Channel 1 port |
BSP_BULBPWM_COLOR_CC1_LOC |
_TIMER_ROUTELOC0_CC1LOC_LOCn |
SERIES1, RADIO |
Color PWM Lightbulb Compare/Capture Channel 1 location |
BSP_BULBPWM_COLOR_CC2_PIN |
0-15 |
SERIES1, RADIO |
Color PWM Lightbulb Compare/Capture Channel 2 pin |
BSP_BULBPWM_COLOR_CC2_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
Color PWM Lightbulb Compare/Capture Channel 2 port |
BSP_BULBPWM_COLOR_CC2_LOC |
_TIMER_ROUTELOC0_CC2LOC_LOCn |
SERIES1, RADIO |
Color PWM Lightbulb Compare/Capture Channel 2 location |
BSP_BULBPWM_COLOR_CC3_PIN |
0-15 |
SERIES1, RADIO, TIMER1 |
Color PWM Lightbulb Compare/Capture Channel 3 pin |
BSP_BULBPWM_COLOR_CC3_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO, TIMER1 |
Color PWM Lightbulb Compare/Capture Channel 3 port |
BSP_BULBPWM_COLOR_CC3_LOC |
_TIMER_ROUTELOC0_CC3LOC_LOCn |
SERIES1, RADIO, TIMER1 |
Color PWM Lightbulb Compare/Capture Channel 3 location |
BSP_BULBPWM_COLOR_TIMER |
TIMERn |
SERIES1, RADIO |
BULBPWM_COLOR Timer module |
HAL_BULBPWM_AMBER_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable amber PWM channel (CC3) |
HAL_BULBPWM_BLUE_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable blue PWM channel (CC2) |
HAL_BULBPWM_COLOR_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable BULBPWM_COLOR |
HAL_BULBPWM_COLOR_FREQUENCY |
uint16_t |
SERIES1, RADIO |
PWM frequency select |
HAL_BULBPWM_GREEN_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable green PWM channel (CC1) |
HAL_BULBPWM_RED_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable red PWM channel (CC0) |
Third Party modules
Back to top
Battery Monitor
Define |
Value |
Dependency |
Description |
BSP_BATTERYMON_TX_ACTIVE_CHANNEL |
PRS Channel |
SERIES1, RADIO |
Battery monitor TX active PRS channel PRS channel |
BSP_BATTERYMON_TX_ACTIVE_PIN |
0-15 |
SERIES1, RADIO |
Battery monitor TX active PRS channel pin |
BSP_BATTERYMON_TX_ACTIVE_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
Battery monitor TX active PRS channel port |
BSP_BATTERYMON_TX_ACTIVE_LOC |
_PRS_ROUTELOC0_CHnLOC_LOCm |
SERIES1, RADIO |
Battery monitor TX active PRS channel location |
HAL_BATTERYMON_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable battery monitor |
CS5463 Power Meter
Define |
Value |
Dependency |
Description |
BSP_CS5463_CLK_PIN |
0-15 |
SERIES1, RADIO |
CS5463 Power Meter CLK pin |
BSP_CS5463_CLK_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
CS5463 Power Meter CLK port |
BSP_CS5463_CLK_LOC |
_USART_ROUTELOC0_CLKLOC_LOCn |
SERIES1, RADIO |
CS5463 Power Meter CLK location |
BSP_CS5463_CS_PIN |
0-15 |
SERIES1, RADIO |
CS5463 Power Meter CS pin |
BSP_CS5463_CS_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
CS5463 Power Meter CS port |
BSP_CS5463_CS_LOC |
_USART_ROUTELOC0_CSLOC_LOCn |
SERIES1, RADIO |
CS5463 Power Meter CS location |
BSP_CS5463_MISO_PIN |
0-15 |
SERIES1, RADIO |
CS5463 Power Meter MISO pin |
BSP_CS5463_MISO_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
CS5463 Power Meter MISO port |
BSP_CS5463_MISO_LOC |
_USART_ROUTELOC0_RXLOC_LOCn |
SERIES1, RADIO |
CS5463 Power Meter MISO location |
BSP_CS5463_MOSI_PIN |
0-15 |
SERIES1, RADIO |
CS5463 Power Meter MOSI pin |
BSP_CS5463_MOSI_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
CS5463 Power Meter MOSI port |
BSP_CS5463_MOSI_LOC |
_USART_ROUTELOC0_TXLOC_LOCn |
SERIES1, RADIO |
CS5463 Power Meter MOSI location |
BSP_CS5463_USART_PORT |
HAL_SPI_PORT_USARTn |
SERIES1, RADIO |
CS5463 USART port |
PYD1698 IR Sensor
Define |
Value |
Dependency |
Description |
BSP_PYD1698_DLINK_PIN |
0-15 |
SERIES1, RADIO |
PYD1698 DLINK port pin |
BSP_PYD1698_DLINK_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
PYD1698 DLINK port port |
BSP_PYD1698_INSTALLATION_JP_PIN |
0-15 |
SERIES1, RADIO |
PYD1698 calibration mode pin |
BSP_PYD1698_INSTALLATION_JP_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
PYD1698 calibration mode port |
BSP_PYD1698_SERIN_PIN |
0-15 |
SERIES1, RADIO |
PYD1698 serial in pin |
BSP_PYD1698_SERIN_PORT |
GPIO_Port_TypeDef |
SERIES1, RADIO |
PYD1698 serial in port |
HAL_PYD1698_ENABLE |
[0, 1] |
SERIES1, RADIO |
Enable PYD1698 IR Sensor |