RAIL configuration and internal state structure.
#include <
rail_types.h
>
Data Fields | |
void(* | eventsCallback )(RAIL_Handle_t railHandle, RAIL_Events_t events) |
Pointer to function called whenever a RAIL event occurs. | |
void * | protocol |
Pointer to a protocol-specific state structure allocated in global read-write memory and initialized to all zeros. | |
RAILSched_Config_t * | scheduler |
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 734
of file rail_types.h
.
Field Documentation
◆ eventsCallback
void(* RAIL_Config_t::eventsCallback) (RAIL_Handle_t railHandle, RAIL_Events_t events) |
Pointer to function called whenever a RAIL event occurs.
- Parameters
-
[in] railHandle
A handle for RAIL instance. [in] events
A bit mask of RAIL events.
- Returns
- void.
See the RAIL_Events_t documentation for the list of RAIL events.
Definition at line 744
of file rail_types.h
.
◆ protocol
void* RAIL_Config_t::protocol |
Pointer to a protocol-specific state structure allocated in global read-write memory and initialized to all zeros.
For the BLE protocol this should point to a RAIL_BLE_State_t structure. For IEEE802154 this should be NULL.
Definition at line 751
of file rail_types.h
.
◆ scheduler
RAILSched_Config_t* RAIL_Config_t::scheduler |
Pointer to a RAIL scheduler state object allocated in global read-write memory and initialized to all zeros.
When not using a multiprotocol scheduler, this should be NULL.
Definition at line 757
of file rail_types.h
.
The documentation for this struct was generated from the following file:
- common/
rail_types.h