RAIL_Config_t Struct Reference

RAIL configuration and internal state structure.

#include <rail_chip_specific.h>

Data Fields

void(* eventsCallback )(RAIL_Handle_t railHandle, RAIL_Events_t events)
 A pointer to a function, which is called whenever a RAIL event occurs.
 
void * protocol
 Pointer to a structure to hold state information required by the Protocol-specific APIs.
 
RAILSched_Config_tscheduler
 A pointer to a RAIL scheduler state object allocated in global read-write memory and initialized to all zeros.
 
RAIL_StateBuffer_t buffer
 A structure for RAIL to maintain its internal state, which must be initialized to all zeros.

RAIL configuration and internal state structure.

This structure must be allocated in application global read-write memory that persists for the duration of RAIL usage. It cannot be allocated in read-only memory or on the call stack.

Definition at line 176 of file rail_chip_specific.h.

Field Documentation

◆ eventsCallback

void(* RAIL_Config_t::eventsCallback) (RAIL_Handle_t railHandle, RAIL_Events_t events)

A pointer to a function, which is called whenever a RAIL event occurs.

Parameters
[in]railHandleA handle for a RAIL instance.
[in]eventsA bit mask of RAIL events.
Returns
void.

See the RAIL_Events_t documentation for the list of RAIL events.

Definition at line 186 of file rail_chip_specific.h.

◆ protocol

void* RAIL_Config_t::protocol

Pointer to a structure to hold state information required by the Protocol-specific APIs.

If needed, this structure must be allocated in global read-write memory and initialized to all zeros.

Currently, this is only required when using the BLE APIs and should be set to point to a RAIL_BLE_State_t structure. When using IEEE 802.15.4 or Z-Wave this should be set to NULL.

Definition at line 196 of file rail_chip_specific.h.

◆ scheduler

RAILSched_Config_t* RAIL_Config_t::scheduler

A pointer to a RAIL scheduler state object allocated in global read-write memory and initialized to all zeros.

When not using a multiprotocol scheduler, it should be NULL.

Definition at line 202 of file rail_chip_specific.h.


The documentation for this struct was generated from the following file:
  • chip/efr32/efr32xg1x/rail_chip_specific.h