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

Public Attributes#

uint32_t *

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

uint16_t

This parameter must be set to the length of the buffer array, in 32 bit words.

uint8_t

The number of channels in the channel hopping sequence, which is the number of elements in the array that entries points to.

uint8_t

Pad byte reserved for future use and currently ignored.

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

Public Attribute 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 + RAIL_CHANNEL_HOPPING_BUFFER_SIZE_PER_CHANNEL * 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 buffer is for internal use to the library.


Definition at line 2907 of file common/rail_types.h

bufferLength#

uint16_t RAIL_TxChannelHoppingConfig_t::bufferLength

This parameter must be set to the length of the buffer array, in 32 bit words.

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


Definition at line 2915 of file common/rail_types.h

numberOfChannels#

uint8_t RAIL_TxChannelHoppingConfig_t::numberOfChannels

The number of channels in the channel hopping sequence, which is the number of elements in the array that entries points to.


Definition at line 2920 of file common/rail_types.h

reserved#

uint8_t RAIL_TxChannelHoppingConfig_t::reserved

Pad byte reserved for future use and currently ignored.


Definition at line 2924 of file common/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 2931 of file common/rail_types.h