Receive

APIs related to packet receive.

Modules

Address Filtering
Configuration APIs for receive packet address filtering.
 
Packet Information
APIs to get information about received packets.

Data Structures

struct  RAIL_ScheduleRxConfig_t
 Configures the scheduled RX algorithm.
 
struct  RAIL_RxPacketInfo_t
 Basic information about a packet being received or already completed and awaiting processing, including memory pointers to its data in the circular receive FIFO buffer.
 
struct  RAIL_RxPacketDetails_t
 Received packet details obtained via RAIL_GetRxPacketDetails() or RAIL_GetRxPacketDetailsAlt().

Macros

#define RAIL_RX_OPTIONS_NONE   0
 A value representing no options enabled.
 
#define RAIL_RX_OPTIONS_DEFAULT   RAIL_RX_OPTIONS_NONE
 All options are disabled by default.
 
#define RAIL_RX_OPTION_STORE_CRC   (1UL << RAIL_RX_OPTION_STORE_CRC_SHIFT)
 An option to configure whether the CRC portion of the packet is included in the packet payload exposed to the app on packet reception.
 
#define RAIL_RX_OPTION_IGNORE_CRC_ERRORS   (1UL << RAIL_RX_OPTION_IGNORE_CRC_ERRORS_SHIFT)
 An option to configure whether CRC errors will be ignored.
 
#define RAIL_RX_OPTION_ENABLE_DUALSYNC   (1UL << RAIL_RX_OPTION_ENABLE_DUALSYNC_SHIFT)
 An option to control which sync words will be accepted.
 
#define RAIL_RX_OPTION_TRACK_ABORTED_FRAMES   (1UL << RAIL_RX_OPTION_TRACK_ABORTED_FRAMES_SHIFT)
 An option to configure whether frames which are aborted during reception should continue to be tracked.
 
#define RAIL_RX_OPTION_REMOVE_APPENDED_INFO   (1UL << RAIL_RX_OPTION_REMOVE_APPENDED_INFO_SHIFT)
 An option to suppress capturing the appended information after received frames.
 
#define RAIL_RX_OPTION_ANTENNA0   (1UL << RAIL_RX_OPTION_ANTENNA0_SHIFT)
 An option to select the use of antenna 0 during receive (including Auto-ACK receive).
 
#define RAIL_RX_OPTION_ANTENNA1   (1UL << RAIL_RX_OPTION_ANTENNA1_SHIFT)
 An option to select the use of antenna 1 during receive (including Auto-ACK receive).
 
#define RAIL_RX_OPTION_ANTENNA_AUTO   (RAIL_RX_OPTION_ANTENNA0 | RAIL_RX_OPTION_ANTENNA1)
 An option combination to automatically choose an antenna during receive (including Auto-ACK receive).
 
#define RAIL_RX_OPTION_DISABLE_FRAME_DETECTION   (1UL << RAIL_RX_OPTION_DISABLE_FRAME_DETECTION_SHIFT)
 An option to disable frame detection.
 
#define RAIL_RX_OPTIONS_ALL   0xFFFFFFFFUL
 A value representing all possible options.
 
#define RAIL_RSSI_INVALID_DBM   (-128)
 The value returned by RAIL for an invalid RSSI, in dBm.
 
#define RAIL_RSSI_INVALID   ((int16_t)(RAIL_RSSI_INVALID_DBM * 4))
 The value returned by RAIL for an invalid RSSI: in quarter dBm.
 
#define RAIL_RX_PACKET_HANDLE_INVALID   (NULL)
 An invalid RX packet handle value.
 
#define RAIL_RX_PACKET_HANDLE_OLDEST   ((RAIL_RxPacketHandle_t) 1)
 A special RX packet handle to refer to the oldest unreleased packet.
 
#define RAIL_RX_PACKET_HANDLE_NEWEST   ((RAIL_RxPacketHandle_t) 2)
 A special RX packet handle to refer to the newest unreleased packet when in callback context.

Typedefs

typedef const void * RAIL_RxPacketHandle_t
 A handle used to reference a packet during reception processing.
 
typedef uint8_t(* RAIL_ConvertLqiCallback_t) (uint8_t lqi, int8_t rssi)
 A pointer to a funcation called before LQI is copied into the RAIL_RxPacketDetails_t structure.

Enumerations

enum  RAIL_RxOptions_t {
  RAIL_RX_OPTION_STORE_CRC_SHIFT = 0,
  RAIL_RX_OPTION_IGNORE_CRC_ERRORS_SHIFT,
  RAIL_RX_OPTION_ENABLE_DUALSYNC_SHIFT,
  RAIL_RX_OPTION_TRACK_ABORTED_FRAMES_SHIFT,
  RAIL_RX_OPTION_REMOVE_APPENDED_INFO_SHIFT,
  RAIL_RX_OPTION_ANTENNA0_SHIFT,
  RAIL_RX_OPTION_ANTENNA1_SHIFT,
  RAIL_RX_OPTION_DISABLE_FRAME_DETECTION_SHIFT
}
 Receive options, in reality a bitmask.
 
enum  RAIL_RxPacketStatus_t {
  RAIL_RX_PACKET_NONE = 0,
  RAIL_RX_PACKET_ABORT_FORMAT,
  RAIL_RX_PACKET_ABORT_FILTERED,
  RAIL_RX_PACKET_ABORT_ABORTED,
  RAIL_RX_PACKET_ABORT_OVERFLOW,
  RAIL_RX_PACKET_ABORT_CRC_ERROR,
  RAIL_RX_PACKET_READY_CRC_ERROR,
  RAIL_RX_PACKET_READY_SUCCESS,
  RAIL_RX_PACKET_RECEIVING
}
 The packet status code associated with a packet received or currently being received.

Functions

RAIL_Status_t RAIL_ConfigRxOptions (RAIL_Handle_t railHandle, RAIL_RxOptions_t mask, RAIL_RxOptions_t options)
 Configures receive options.
 
void RAIL_IncludeFrameTypeLength (RAIL_Handle_t railHandle)
 Function to include the code necessary for frame type based length decoding.
 
void RAILCb_ConfigFrameTypeLength (RAIL_Handle_t railHandle, const RAIL_FrameType_t *frameType)
 Function implemented in the radio config for frame type length handling.
 
RAIL_Status_t RAIL_StartRx (RAIL_Handle_t railHandle, uint16_t channel, const RAIL_SchedulerInfo_t *schedulerInfo)
 Starts the receiver on a specific channel.
 
RAIL_Status_t RAIL_ScheduleRx (RAIL_Handle_t railHandle, uint16_t channel, const RAIL_ScheduleRxConfig_t *cfg, const RAIL_SchedulerInfo_t *schedulerInfo)
 Schedules a receive window for some future time.
 
RAIL_RxPacketHandle_t RAIL_HoldRxPacket (RAIL_Handle_t railHandle)
 Place a temporary hold on this packet's data and information resources within RAIL.
 
uint16_t RAIL_PeekRxPacket (RAIL_Handle_t railHandle, RAIL_RxPacketHandle_t packetHandle, uint8_t *pDst, uint16_t len, uint16_t offset)
 Copies 'len' bytes of packet data starting from 'offset' from the receive FIFO.
 
RAIL_Status_t RAIL_ReleaseRxPacket (RAIL_Handle_t railHandle, RAIL_RxPacketHandle_t packetHandle)
 Releases RAIL's internal resources for the packet.
 
int16_t RAIL_GetRssi (RAIL_Handle_t railHandle, bool wait)
 Returns the current raw RSSI.
 
RAIL_Status_t RAIL_StartAverageRssi (RAIL_Handle_t railHandle, uint16_t channel, RAIL_Time_t averagingTimeUs, const RAIL_SchedulerInfo_t *schedulerInfo)
 Starts the RSSI averaging over a specified time in us.
 
bool RAIL_IsAverageRssiReady (RAIL_Handle_t railHandle)
 Queries whether the RSSI averaging is done.
 
int16_t RAIL_GetAverageRssi (RAIL_Handle_t railHandle)
 Gets the RSSI averaged over a specified time in us.
 
RAIL_Status_t RAIL_SetRssiOffset (RAIL_Handle_t railHandle, int8_t rssiOffset)
 Sets the RSSI offset.
 
int8_t RAIL_GetRssiOffset (RAIL_Handle_t railHandle)
 Gets the RSSI offset.
 
RAIL_Status_t RAIL_ConvertLqi (RAIL_Handle_t railHandle, RAIL_ConvertLqiCallback_t cb)
 Setup a callback function capable of converting a RX packet's LQI value before being consumed by application code.

Detailed Description

APIs related to packet receive.

Macro Definition Documentation

#define RAIL_RSSI_INVALID   ((int16_t)(RAIL_RSSI_INVALID_DBM * 4))

The value returned by RAIL for an invalid RSSI: in quarter dBm.

Definition at line 2119 of file rail_types.h.

#define RAIL_RSSI_INVALID_DBM   (-128)

The value returned by RAIL for an invalid RSSI, in dBm.

Definition at line 2117 of file rail_types.h.

#define RAIL_RX_OPTION_ANTENNA0   (1UL << RAIL_RX_OPTION_ANTENNA0_SHIFT)

An option to select the use of antenna 0 during receive (including Auto-ACK receive).

If no antenna option is selected, the receive may take place on either antenna depending on the last receive or transmit selection. Defaults to false. This option is only valid on platforms that support Antenna Control and have been configured via RAIL_ConfigAntenna().

Definition at line 2082 of file rail_types.h.

#define RAIL_RX_OPTION_ANTENNA1   (1UL << RAIL_RX_OPTION_ANTENNA1_SHIFT)

An option to select the use of antenna 1 during receive (including Auto-ACK receive).

If no antenna option is selected, the receive may take place on either antenna depending on the last receive or transmit selection. Defaults to false. This option is only valid on platforms that support Antenna Control and have been configured via RAIL_ConfigAntenna().

Definition at line 2092 of file rail_types.h.

#define RAIL_RX_OPTION_ANTENNA_AUTO   (RAIL_RX_OPTION_ANTENNA0 | RAIL_RX_OPTION_ANTENNA1)

An option combination to automatically choose an antenna during receive (including Auto-ACK receive).

If both antenna 0 and antenna 1 options are set, the radio will dynamically switch between antennas during packet detection and choose the best one for completing the reception. This option is only valid on platforms that support Antenna Control and have been configured via RAIL_ConfigAntenna().

Definition at line 2103 of file rail_types.h.

#define RAIL_RX_OPTION_DISABLE_FRAME_DETECTION   (1UL << RAIL_RX_OPTION_DISABLE_FRAME_DETECTION_SHIFT)

An option to disable frame detection.

This can be useful for doing energy detection without risking packet reception. Enabling this will abort any frame currently being received in addition to preventing further frames from being received. Defaults to false.

Definition at line 2111 of file rail_types.h.

#define RAIL_RX_OPTION_ENABLE_DUALSYNC   (1UL << RAIL_RX_OPTION_ENABLE_DUALSYNC_SHIFT)

An option to control which sync words will be accepted.

Setting it to 0 (default) will cause the receiver to listen for SYNC1 only. Setting it to 1 causes the receiver to listen for either SYNC1 or SYNC2. RX appended info will contain which sync word was detected. Note, this only affects which sync word(s) are received, but not what each of the sync words actually are. This feature may not be available on some combinations of chips, PHYs, and protocols. See the data sheet or support team for more details.

Definition at line 2056 of file rail_types.h.

#define RAIL_RX_OPTION_IGNORE_CRC_ERRORS   (1UL << RAIL_RX_OPTION_IGNORE_CRC_ERRORS_SHIFT)

An option to configure whether CRC errors will be ignored.

If this is set, RX will still be successful, even if the CRC does not pass the check. Defaults to false.

Definition at line 2045 of file rail_types.h.

#define RAIL_RX_OPTION_REMOVE_APPENDED_INFO   (1UL << RAIL_RX_OPTION_REMOVE_APPENDED_INFO_SHIFT)

An option to suppress capturing the appended information after received frames.

Defaults to false. When suppressed, certain RAIL_RxPacketDetails_t details will not be available for received packets whose RAIL_RxPacketStatus_t is among the RAIL_RX_PACKET_READY_ set.

Definition at line 2072 of file rail_types.h.

#define RAIL_RX_OPTION_STORE_CRC   (1UL << RAIL_RX_OPTION_STORE_CRC_SHIFT)

An option to configure whether the CRC portion of the packet is included in the packet payload exposed to the app on packet reception.

Defaults to false.

Definition at line 2039 of file rail_types.h.

#define RAIL_RX_OPTION_TRACK_ABORTED_FRAMES   (1UL << RAIL_RX_OPTION_TRACK_ABORTED_FRAMES_SHIFT)

An option to configure whether frames which are aborted during reception should continue to be tracked.

Setting this option allows viewing Packet Trace information for frames which get discarded. Defaults to false.

Definition at line 2063 of file rail_types.h.

#define RAIL_RX_OPTIONS_ALL   0xFFFFFFFFUL

A value representing all possible options.

Definition at line 2114 of file rail_types.h.

#define RAIL_RX_OPTIONS_DEFAULT   RAIL_RX_OPTIONS_NONE

All options are disabled by default.

Definition at line 2032 of file rail_types.h.

#define RAIL_RX_OPTIONS_NONE   0

A value representing no options enabled.

Definition at line 2030 of file rail_types.h.

#define RAIL_RX_PACKET_HANDLE_INVALID   (NULL)

An invalid RX packet handle value.

Definition at line 2221 of file rail_types.h.

#define RAIL_RX_PACKET_HANDLE_NEWEST   ((RAIL_RxPacketHandle_t) 2)

A special RX packet handle to refer to the newest unreleased packet when in callback context.

For a callback involving a completed receive event, this refers to the packet just completed. For other callback events, this refers to the next packet to be completed, which might be in-progress or might not have even started yet.

Definition at line 2231 of file rail_types.h.

#define RAIL_RX_PACKET_HANDLE_OLDEST   ((RAIL_RxPacketHandle_t) 1)

A special RX packet handle to refer to the oldest unreleased packet.

Definition at line 2223 of file rail_types.h.

Typedef Documentation

RAIL_ConvertLqiCallback_t

A pointer to a funcation called before LQI is copied into the RAIL_RxPacketDetails_t structure.

Parameters
[in]lqiThe LQI value obtained by hardware and being readied for application consumption. This LQI value is in integral units ranging from 0 to 255.
[in]rssiThe RSSI value corresponding to the packet from which the hardware LQI value was obtained. This RSSI value is in integral dBm units.
Returns
uint8_t The converted LQI value that will be loaded into the RAIL_RxPacketDetails_t structure in preparation for application consumption. This value should likewise be in integral units ranging from 0 to 255.

Definition at line 2508 of file rail_types.h.

A handle used to reference a packet during reception processing.

There are several sentinel handle values that pertain to certain circumstances: RAIL_RX_PACKET_HANDLE_INVALID, RAIL_RX_PACKET_HANDLE_OLDEST and RAIL_RX_PACKET_HANDLE_NEWEST.

Definition at line 2218 of file rail_types.h.

Enumeration Type Documentation

Receive options, in reality a bitmask.

Enumerator
RAIL_RX_OPTION_STORE_CRC_SHIFT 

Shift position of RAIL_RX_OPTION_STORE_CRC bit.

RAIL_RX_OPTION_IGNORE_CRC_ERRORS_SHIFT 

Shift position of RAIL_RX_OPTION_IGNORE_CRC_ERRORS bit.

RAIL_RX_OPTION_ENABLE_DUALSYNC_SHIFT 

Shift position of RAIL_RX_OPTION_ENABLE_DUALSYNC bit.

RAIL_RX_OPTION_TRACK_ABORTED_FRAMES_SHIFT 

Shift position of RAIL_RX_OPTION_TRACK_ABORTED_FRAMES bit.

RAIL_RX_OPTION_REMOVE_APPENDED_INFO_SHIFT 

Shift position of RAIL_RX_OPTION_REMOVE_APPENDED_INFO bit.

RAIL_RX_OPTION_ANTENNA0_SHIFT 

Shift position of RAIL_RX_OPTION_ANTENNA0 bit.

RAIL_RX_OPTION_ANTENNA1_SHIFT 

Shift position of RAIL_RX_OPTION_ANTENNA1 bit.

RAIL_RX_OPTION_DISABLE_FRAME_DETECTION_SHIFT 

Shift position of RAIL_RX_OPTION_DISABLE_FRAME_DETECTION bit.

Definition at line 2010 of file rail_types.h.

The packet status code associated with a packet received or currently being received.

Note
RECEIVING implies some packet data may be available, but is untrustworthy (not CRC-verified) and might disappear if the packet is rolled back on error. No packet details are yet available.
In RX RAIL_DataMethod_t::FIFO_MODE, ABORT statuses imply some packet data may be available, but it's incomplete and not trustworthy.
Enumerator
RAIL_RX_PACKET_NONE 

The radio is idle or searching for a packet.

RAIL_RX_PACKET_ABORT_FORMAT 

A format/length error.

RAIL_RX_PACKET_ABORT_FILTERED 

A filtering error (address).

RAIL_RX_PACKET_ABORT_ABORTED 

An aborted error.

RAIL_RX_PACKET_ABORT_OVERFLOW 

The receive buffer overflowed.

RAIL_RX_PACKET_ABORT_CRC_ERROR 

A CRC error aborted.

RAIL_RX_PACKET_READY_CRC_ERROR 

A CRC error accepted.

RAIL_RX_PACKET_READY_SUCCESS 

Success.

RAIL_RX_PACKET_RECEIVING 

Receiving in progress.

Definition at line 2186 of file rail_types.h.

Function Documentation

RAIL_Status_t RAIL_ConfigRxOptions ( RAIL_Handle_t  railHandle,
RAIL_RxOptions_t  mask,
RAIL_RxOptions_t  options 
)

Configures receive options.

Parameters
[in]railHandleA RAIL instance handle.
[in]maskA bitmask containing which options should be modified.
[in]optionsA bitmask containing desired configuration settings. Bit positions for each option are found in the RAIL_RxOptions_t.
Returns
Status code indicating success of the function call.

Configures the radio receive flow based on the list of available options. Only the options indicated by the mask parameter will be affected. Pass RAIL_RX_OPTIONS_ALL to set all parameters. The previous settings may affect the current frame if a packet is received during this configuration.

RAIL_Status_t RAIL_ConvertLqi ( RAIL_Handle_t  railHandle,
RAIL_ConvertLqiCallback_t  cb 
)

Setup a callback function capable of converting a RX packet's LQI value before being consumed by application code.

Parameters
[in]railHandleA RAIL instance handle.
[in]cbA callback of type RAIL_ConvertLqiCallback_t that is called before the RX packet LQI value is loaded into the RAIL_RxPacketDetails_t structure for application consumption.
Returns
Status code indicating success of the function call.
int16_t RAIL_GetAverageRssi ( RAIL_Handle_t  railHandle)

Gets the RSSI averaged over a specified time in us.

Parameters
[in]railHandleA RAIL instance handle.
Returns
Return RAIL_RSSI_INVALID if the receiver is disabled an RSSI value can't be obtained. Otherwise, return the RSSI in quarter dBm,dbm*4.

Gets the hardware RSSI average after issuing RAIL_StartAverageRssi. It should be used after RAIL_StartAverageRssi.

int16_t RAIL_GetRssi ( RAIL_Handle_t  railHandle,
bool  wait 
)

Returns the current raw RSSI.

Parameters
[in]railHandleA RAIL instance handle.
[in]waitif false returns instant RSSI with no checks.
Returns
RAIL_RSSI_INVALID if the receiver is disabled and an RSSI value can't be obtained. Otherwise, return the RSSI in quarter dBm, dbm*4.

Gets the current RSSI value. This value represents the current energy of the channel. It can change rapidly and will be low if no RF energy is in the current channel. The function from the value reported to dBm is an offset dependent on the PHY and the PCB layout. Users should characterize the RSSI received on their hardware and apply an offset in the application to account for board and PHY parameters. 'Wait' argument doesn't guarantee a valid RSSI reading.'Wait' being true gives assurance that that the RSSI is current and not a stale value from a previous radio state. If GetRssi is called during RX-to-RX, RX-to-IDLE, or RX-to-TX transition, the RSSI is considered stale and RAIL_RSSI_INVALID is returned if wait=true. 'Wait' being false will return either the current RSSI or a stale RSSI measurement (if called during RX-to-RX, RX-to-IDLE, or RX-to-TX transition). RAIL_RSSI_INVALID is returned if radio hasn't been in RX longer than 'idleToRx' time (see RAIL_StateTiming_t), regardless of wait argument.

In multiprotocol, this function returns RAIL_RSSI_INVALID immediately if railHandle is not the current active RAIL_Handle_t. Additionally, 'wait' should never be set 'true' in multiprotocol as the wait time is not consistent, so scheduling a scheduler slot cannot be done accurately.

int8_t RAIL_GetRssiOffset ( RAIL_Handle_t  railHandle)

Gets the RSSI offset.

Parameters
[in]railHandlea RAIL instance handle.
Returns
rssiOffset in dBm corresponding to the current handle.
RAIL_RxPacketHandle_t RAIL_HoldRxPacket ( RAIL_Handle_t  railHandle)

Place a temporary hold on this packet's data and information resources within RAIL.

This function can only be called from within RAIL callback context. It can be used in any RX mode.

Normally, when RAIL issues its callback indicating a packet is ready or aborted, it expects the application's callback to retrieve and copy (or discard) the packet's information and data, and will free up its internal packet data after the callback returns. This function tells RAIL to hold onto those resources after the callback returns in case the application wants to defer processing the packet to a later time, e.g., outside of callback context.

Parameters
[in]railHandleA RAIL instance handle.
Returns
The packet handle for the packet associated with the callback, RAIL_RX_PACKET_HANDLE_INVALID if no such packet yet exists or railHandle is not active.
void RAIL_IncludeFrameTypeLength ( RAIL_Handle_t  railHandle)

Function to include the code necessary for frame type based length decoding.

Parameters
[in]railHandleA RAIL instance handle.
Returns
void.

This must be called before RAIL_ConfigChannels to allow configurations using a frame type based length setup. In RAIL 2.x this is called by default in the RAILCb_ConfigFrameTypeLength API which can be overridden to save code space. In future versions the user may be required to call this API explicitly.

bool RAIL_IsAverageRssiReady ( RAIL_Handle_t  railHandle)

Queries whether the RSSI averaging is done.

Parameters
[in]railHandleA RAIL instance handle.
Returns
Returns true if done and false otherwise.

This function can be used to poll for completion of the RSSI averaging to avoid relying on an interrupt-based callback.

uint16_t RAIL_PeekRxPacket ( RAIL_Handle_t  railHandle,
RAIL_RxPacketHandle_t  packetHandle,
uint8_t *  pDst,
uint16_t  len,
uint16_t  offset 
)

Copies 'len' bytes of packet data starting from 'offset' from the receive FIFO.

Those bytes remain valid for re-peeking.

Parameters
[in]railHandleA RAIL instance handle.
[in]packetHandleA packet handle as returned from a previous RAIL_GetRxPacketInfo() or RAIL_HoldRxPacket() call, or sentinel values RAIL_RX_PACKET_HANDLE_OLDEST or RAIL_RX_PACKET_HANDLE_NEWEST.
[out]pDstA pointer to the location where the received bytes will be copied. If NULL, no copying occurs.
[in]lenA number of packet data bytes to copy.
[in]offsetA byte offset within remaining packet data from which to copy.
Returns
Number of packet bytes copied.
Note
Peek does not permit peeking beyond the requested packet's available packet data (though there is a small chance it might for a RAIL_RX_PACKET_HANDLE_NEWEST packet at the very end of still being received). Nor can one peek into already-consumed data read by RAIL_ReadRxFifo(). len and offset are relative to the remaining data available in the packet, if any was already consumed by RAIL_ReadRxFifo().
RAIL_Status_t RAIL_ReleaseRxPacket ( RAIL_Handle_t  railHandle,
RAIL_RxPacketHandle_t  packetHandle 
)

Releases RAIL's internal resources for the packet.

This function must be called for any packet previously held via RAIL_HoldRxPacket(). It may optionally be called within a callback context to release RAIL resources sooner than at callback completion time when not holding the packet. This function can be used in any RX mode.

Parameters
[in]railHandleA RAIL instance handle.
[in]packetHandleA packet handle as returned from a previous RAIL_HoldRxPacket() call, or sentinel values RAIL_RX_PACKET_HANDLE_OLDEST or RAIL_RX_PACKET_HANDLE_NEWEST. The latter might be used within RAIL callback context to explicitly release the packet associated with the callback early, before it's released automatically by RAIL on callback return (unless explicitly held).
Returns
RAIL_STATUS_NO_ERROR if the held packet was released or an appropriate error code otherwise.
RAIL_Status_t RAIL_ScheduleRx ( RAIL_Handle_t  railHandle,
uint16_t  channel,
const RAIL_ScheduleRxConfig_t cfg,
const RAIL_SchedulerInfo_t schedulerInfo 
)

Schedules a receive window for some future time.

Parameters
[in]railHandleA RAIL instance handle.
[in]channelA channel to listen on.
[in]cfgThe configuration structure to define the receive window.
[in]schedulerInfoInformation to allow the radio scheduler to place this receive appropriately. This is only used in multiprotocol version of RAIL and may be set to NULL in all other versions.
Returns
Status code indicating success of the function call.

This API immediately changes the channel and schedules receive to start at the specified time and end at the given end time. If you do not specify an end time, you may call this API later with an end time as long as you set the start time to disabled. You can also terminate the receive operation immediately using the RAIL_Idle() function. Note that relative end times are always relative to the start unless no start time is specified. If changing channels, aborts any ongoing packet transmission or reception.

In multiprotocol, ensure that you properly yield the radio after this call. See Yielding the radio for more details.

RAIL_Status_t RAIL_SetRssiOffset ( RAIL_Handle_t  railHandle,
int8_t  rssiOffset 
)

Sets the RSSI offset.

Parameters
[in]railHandlea RAIL instance handle.
[in]rssiOffsetdesired offset to be added to the RSSI measurements.
Returns
Status code indicating success of the function call.

Adds an offset to the RSSI in dBm. This offset affects all functionality that depends on RSSI values, such as CCA fuctions. The offset should not be modified dynamically during the RX of a packet.

RAIL_Status_t RAIL_StartAverageRssi ( RAIL_Handle_t  railHandle,
uint16_t  channel,
RAIL_Time_t  averagingTimeUs,
const RAIL_SchedulerInfo_t schedulerInfo 
)

Starts the RSSI averaging over a specified time in us.

Parameters
[in]railHandleA RAIL instance handle.
[in]channelThe physical channel to set.
[in]averagingTimeUsAveraging time in microseconds.
[in]schedulerInfoInformation to allow the radio scheduler to place this operation appropriately. This is only used in multiprotocol version of RAIL and may be set to NULL in all other versions.
Returns
Status code indicating success of the function call.

Starts a non-blocking hardware-based RSSI averaging mechanism. Only a single instance of RSSI averaging can be run at any time and the radio must be idle to start.

In multiprotocol, this is a scheduled event. It will start when railHandle becomes active. railHandle needs to stay active until the averaging completes. If the averaging is interrupted, calls to RAIL_GetAverageRssi will return RAIL_RSSI_INVALID.

Also in multiprotocol, the user is required to call RAIL_YieldRadio after this event completes (i.e., when RAIL_EVENT_RSSI_AVERAGE_DONE occurs).

RAIL_Status_t RAIL_StartRx ( RAIL_Handle_t  railHandle,
uint16_t  channel,
const RAIL_SchedulerInfo_t schedulerInfo 
)

Starts the receiver on a specific channel.

Parameters
[in]railHandleA RAIL instance handle.
[in]channelThe channel to listen on.
[in]schedulerInfoInformation to allow the radio scheduler to place this receive appropriately. This is only used in multiprotocol version of RAIL and may be set to NULL in all other versions.
Returns
Status code indicating success of the function call.

This is a non-blocking function. Whenever a packet is received, RAIL_Config_t::eventsCallback will fire with RAIL_EVENT_RX_PACKET_RECEIVED set. If you call this while not idle but with a different channel, any ongoing receive or transmit operation will be aborted.

void RAILCb_ConfigFrameTypeLength ( RAIL_Handle_t  railHandle,
const RAIL_FrameType_t frameType 
)

Function implemented in the radio config for frame type length handling.

Parameters
[in]railHandleA RAIL instance handle.
[in]frameTypeA frame type configuration structure.
Returns
void.

Currently, the frame type passed in only handles packet length decoding. If NULL is passed into this function, it clears any currently configured frame type settings. This will either be implemented as an empty function in the radio configuration if it is not needed, to assist in dead code elimination.