Antenna Control
Basic APIs to control the antenna functionality.
Modules |
|
EFR32 | |
EFR32 Antenna Control FunctionalityThese enumerations and structures are used with RAIL Antenna Control API.
|
Functions |
|
RAIL_Status_t | RAIL_ConfigAntenna ( RAIL_Handle_t railHandle, const RAIL_AntennaConfig_t *config) |
Configure antenna path and pin locations.
|
|
RAIL_Status_t | RAIL_GetRfPath ( RAIL_Handle_t railHandle, RAIL_AntennaSel_t *rfPath) |
Get the default RF path.
|
Detailed Description
Basic APIs to control the antenna functionality.
Function Documentation
◆ RAIL_ConfigAntenna()
RAIL_Status_t RAIL_ConfigAntenna | ( | RAIL_Handle_t |
railHandle,
|
const RAIL_AntennaConfig_t * |
config
|
||
) |
Configure antenna path and pin locations.
- Warning
- This API must be called before any TX or RX occurs. Otherwise, the antenna configurations for those functions will not take effect.
- Parameters
-
[in] railHandle
A RAIL instance handle. [in] config
A configuration structure applied to the relevant Antenna Configuration registers. A NULL configuration will produce undefined behavior.
- Returns
- Status code indicating success of the function call.
This function informs RAIL how to select each antenna, but not when. Antenna selection for receive is controlled by the RAIL_RxOptions_t::RAIL_RX_OPTION_ANTENNA0 and RAIL_RxOptions_t::RAIL_RX_OPTION_ANTENNA1 options (and the RAIL_RxOptions_t::RAIL_RX_OPTION_ANTENNA_AUTO combination). Antenna selection for transmit is controlled by the RAIL_TxOptions_t::RAIL_TX_OPTION_ANTENNA0 and RAIL_TxOptions_t::RAIL_TX_OPTION_ANTENNA1 options.
Although a RAIL handle is included for potential future expansion of this function, it is currently not used. That is, only one antenna configuration can be active on a chip, regardless of the number of protocols (unless the application updates the configuration upon a protocol switch), and the configuration is not saved in the RAIL instance. For optimal future compatibility, pass in a chip-specific handle, such as RAIL_EFR32_HANDLE .
◆ RAIL_GetRfPath()
RAIL_Status_t RAIL_GetRfPath | ( | RAIL_Handle_t |
railHandle,
|
RAIL_AntennaSel_t * |
rfPath
|
||
) |
Get the default RF path.
- Parameters
-
[in] railHandle
A RAIL instance handle. [out] rfPath
Pointer to RF path.
- Returns
- A status code indicating success of the function call.
If multiple protocols are used, this function returns RAIL_STATUS_INVALID_STATE if it is called and the given railHandle is not active. In that case, the caller must attempt to re-call this function later, for example when RAIL_EVENT_CONFIG_SCHEDULED trigger.