Antenna Control#

Basic APIs to control the antenna functionality.

These enumerations and structures are used with RAIL Antenna Control API.

EFR32 supports up to two antennas with configurable pin locations.

Modules#

RAIL_AntennaConfig_t

Enumerations#

enum

RAIL_AntennaSel_t {

RAIL_ANTENNA_0 = 0

RAIL_ANTENNA_1 = 1

RAIL_ANTENNA_AUTO = 255

}

Antenna path Selection enumeration.

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.

Macros#

#define

ant0Loc defaultPath

Enumeration Documentation#

RAIL_AntennaSel_t#

RAIL_AntennaSel_t

Antenna path Selection enumeration.

Enumerator
RAIL_ANTENNA_0	Enum for antenna path 0.
RAIL_ANTENNA_1	Enum for antenna path 1.
RAIL_ANTENNA_AUTO	Enum for antenna path auto.

Definition at line 4504 of file common/rail_types.h

Function Documentation#

RAIL_ConfigAntenna#

RAIL_Status_t RAIL_ConfigAntenna (RAIL_Handle_t railHandle, const RAIL_AntennaConfig_t * config)

Configure antenna path and pin locations.

Parameters

[in]	railHandle	A RAIL instance handle, e.g., RAIL_EFR32_HANDLE.
[in]	config	A pointer to a configuration structure applied to the relevant Antenna Configuration registers. A NULL configuration will produce undefined behavior.

Warnings

This API must be called before any TX or RX occurs. Otherwise, the antenna configurations for those functions will not take effect.

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_RX_OPTION_ANTENNA0 and RAIL_RX_OPTION_ANTENNA1 options (and the RAIL_RX_OPTION_ANTENNA_AUTO combination). Antenna selection for transmit is controlled by the RAIL_TX_OPTION_ANTENNA0 and RAIL_TX_OPTION_ANTENNA1 options.

There is only one antenna configuration can be active on a radio, regardless of the number of protocols (unless the application updates the configuration upon a protocol switch – RAIL does not save this configuration in a protocol RAIL instance).

Definition at line 494 of file common/rail.h

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	A pointer to RF path updated by the function.

Returns

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.

Definition at line 509 of file common/rail.h

Macro Definition Documentation#

ant0Loc#

#define ant0Loc

Value:

defaultPath

DeprecatedBackwards compatible name for RAIL_AntennaConfig_t::defaultPath field.

Definition at line 4559 of file common/rail_types.h