RAIL_TxChannelHoppingConfig_t Struct Reference
RAIL API > TX Channel Hopping

Wrapper struct that will contain the sequence of RAIL_TxChannelHoppingConfigEntry_t that represents the channel sequence to use during TX Channel Hopping.

#include < rail_types.h >

Data Fields

uint32_t * buffer
Pointer to contiguous global read-write memory that will be used by RAIL to store channel hopping information throughout its operation.
uint16_t bufferLength
This parameter must be set to the length of the buffer array.
uint8_t numberOfChannels
The number of channels in the channel hopping sequence, which is the number of elements in the array that entries points to.
uint8_t reserved
Pad byte reserved for future use and currently ignored.
RAIL_TxChannelHoppingConfigEntry_t * entries
A pointer to the first element of an array of RAIL_TxChannelHoppingConfigEntry_t that represents the channels used during channel hopping.

Wrapper struct that will contain the sequence of RAIL_TxChannelHoppingConfigEntry_t that represents the channel sequence to use during TX Channel Hopping.

Definition at line 2011 of file rail_types.h .

Field Documentation

◆ buffer

uint32_t* RAIL_TxChannelHoppingConfig_t::buffer

Pointer to contiguous global read-write memory that will be used by RAIL to store channel hopping information throughout its operation.

It need not be initialized and applications should never write data anywhere in this buffer.

Note
the size of this buffer must be at least as large as 3 + 30 * numberOfChannels, plus the sum of the sizes of the radioConfigDeltaAdd's of the required channels, plus the size of the radioConfigDeltaSubtract. In the case that one channel appears two or more times in your channel sequence (e.g., 1, 2, 3, 2), you must account for the radio configuration size that number of times (i.e., need to count channel 2's radio configuration size twice for the given example). The overall 3 words and 30 words per channel needed in this buffer are for internal use to the library.

Definition at line 2029 of file rail_types.h .

◆ bufferLength

uint16_t RAIL_TxChannelHoppingConfig_t::bufferLength

This parameter must be set to the length of the buffer array.

This way, during configuration, the software can confirm it's writing within the range of the buffer. The configuration API will return an error if bufferLength is insufficient.

Definition at line 2036 of file rail_types.h .

◆ entries

RAIL_TxChannelHoppingConfigEntry_t * RAIL_TxChannelHoppingConfig_t::entries

A pointer to the first element of an array of RAIL_TxChannelHoppingConfigEntry_t that represents the channels used during channel hopping.

The length of this array must be numberOfChannels.

Definition at line 2052 of file rail_types.h .

The documentation for this struct was generated from the following file:
  • common/ rail_types.h