RF_Object Struct Reference

Struct used to store RF client state and configuration Pointer to an RF_Object is used as handles (RF_Handle) in interactions with the RF driver. More...

#include <RF.h>

Collaboration diagram for RF_Object:

Data Fields
struct {
uint32_t   nInactivityTimeout
	Inactivity timeout in us. More...
RF_Mode *   pRfMode
	Mode of operation. More...
RF_RadioSetup *   pOpSetup
	Radio setup radio operation, only ram right now. More...
uint32_t   nPowerUpDuration
	Measured poweruptime in us or specified startup time (if left default it will measure) More...
bool   bPowerUpXOSC
	Allways enable XOSC_HF at chip wakeup. More...
void *   pPowerCb
	Power up callback. More...
void *   pErrCb
	Error callback. More...
}	clientConfig
	Configuration. More...
struct {
struct {
rfc_CMD_FS_t   cmdFs
	FS command encapsulating FS state. More...
}   mode_state
	(Mode-specific) state structure More...
Semaphore_Struct   semSync
	Semaphore used by runCmd(), pendCmd() and powerdown sequence. More...
RF_EventMask volatile   eventSync
	Event mask/value used by runCmd() and waitCmd() More...
void *   pCbSync
	Internal storage for user callback. More...
RF_EventMask   unpendCause
	Return value for RF_pendCmd() More...
Clock_Struct   clkInactivity
	Clock used for inactivity timeouts. More...
RF_CmdHandle volatile   chLastPosted
	Command handle of most recently posted command. More...
bool   bYielded
	Client has indicated that there are no more commands. More...
}	state
	State & variables. More...

Detailed Description

Struct used to store RF client state and configuration Pointer to an RF_Object is used as handles (RF_Handle) in interactions with the RF driver.

Note

Must reside in persistent memory

Except configuration fields before call to RF_open(), fields must never be modified directly

Field Documentation

uint32_t RF_Object::nInactivityTimeout

Inactivity timeout in us.

RF_Mode* RF_Object::pRfMode

Mode of operation.

RF_RadioSetup* RF_Object::pOpSetup

Radio setup radio operation, only ram right now.

uint32_t RF_Object::nPowerUpDuration

Measured poweruptime in us or specified startup time (if left default it will measure)

bool RF_Object::bPowerUpXOSC

Allways enable XOSC_HF at chip wakeup.

void* RF_Object::pPowerCb

Power up callback.

void* RF_Object::pErrCb

Error callback.

struct { ... } RF_Object::clientConfig

Configuration.

rfc_CMD_FS_t RF_Object::cmdFs

FS command encapsulating FS state.

struct { ... } RF_Object::mode_state

(Mode-specific) state structure

Semaphore_Struct RF_Object::semSync

Semaphore used by runCmd(), pendCmd() and powerdown sequence.

RF_EventMask volatile RF_Object::eventSync

Event mask/value used by runCmd() and waitCmd()

void* RF_Object::pCbSync

Internal storage for user callback.

RF_EventMask RF_Object::unpendCause

Return value for RF_pendCmd()

Clock_Struct RF_Object::clkInactivity

Clock used for inactivity timeouts.

RF_CmdHandle volatile RF_Object::chLastPosted

Command handle of most recently posted command.

bool RF_Object::bYielded

Client has indicated that there are no more commands.

struct { ... } RF_Object::state

State & variables.

---

The documentation for this struct was generated from the following file:

• RF.h