RAIL_BLE_TxChannelHoppingConfig_t Struct Reference
RAIL API > Protocol-specific > BLE > BLE TX Channel Hopping

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

#include < rail_ble.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 that is in the channel hopping sequence.
uint8_t reserved
Pad bytes reserved for future use and currently ignored.
RAIL_BLE_TxChannelHoppingConfigEntry_t * entries
A pointer to the first element of an array of RAIL_BLE_TxChannelHoppingConfigEntry_t that represents the channels used during channel hopping.

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

Definition at line 888 of file rail_ble.h .

Field Documentation

◆ buffer

uint32_t* RAIL_BLE_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.

Definition at line 895 of file rail_ble.h .

◆ bufferLength

uint16_t RAIL_BLE_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 902 of file rail_ble.h .

◆ entries

RAIL_BLE_TxChannelHoppingConfigEntry_t * RAIL_BLE_TxChannelHoppingConfig_t::entries

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

The length of this array must be numberOfChannels.

Definition at line 915 of file rail_ble.h .

◆ numberOfChannels

uint8_t RAIL_BLE_TxChannelHoppingConfig_t::numberOfChannels

The number of channels that is in the channel hopping sequence.

Definition at line 904 of file rail_ble.h .

The documentation for this struct was generated from the following file:
  • protocol/ble/ rail_ble.h