nRF5 SDK v17.1.0
Data Structures | Functions
PHY TRX API

Module to declare PHY Transceiver State API. More...

Data Structures

struct  plme_trx_req_t
 PLME-SET_TRX_STATE.request parameters. More...
 
struct  plme_trx_conf_t
 PLME-TRX.confirm parameters. More...
 

Functions

void plme_set_trx_state_req (plme_trx_req_t *req)
 PLME-SET_TRX_STATE request. More...
 
void plme_set_trx_state_conf (plme_trx_conf_t *conf)
 PLME-SET_TRX_STATE.confirm callback function, implemented by the next higher layer. More...
 
phy_enum_t plme_set_trx_state (phy_enum_t state)
 Direct (synchronous) PLME-SET_TRX_STATE access. More...
 

Detailed Description

Module to declare PHY Transceiver State API.

The PHY TRX module declares Transceiver state change PHY routines and necessary types according to the PHY specification. More specifically, PHY set TRX state request plme_set_trx_state_req(), PHY TRX state change confirm plme_set_trx_state_conf() primitives are declared. An additional primitive not covered by the standard is declared. This is plme_set_trx_state() which is a synchronous version of plme_set_trx_state_req().

Function Documentation

phy_enum_t plme_set_trx_state ( phy_enum_t  state)

Direct (synchronous) PLME-SET_TRX_STATE access.

Optional. Not covered by the standard.

Parameters
[in]stateOne of PHY_RX_ON, PHY_TRX_OFF, PHY_FORCE_TRX_OFF or PHY_TX_ON.
Returns
PHY_SUCCESS if state changed successfully or current PHY state in either case.
void plme_set_trx_state_conf ( plme_trx_conf_t conf)

PLME-SET_TRX_STATE.confirm callback function, implemented by the next higher layer.

The PLME-SET_TRX_STATE.confirm primitive is generated by the PLME and issued to its next higher layer in response to an PLME-SET_TRX_STATE.request primitive.

In accordance with IEEE Std 802.15.4-2006, section 6.2.2.8

Parameters
[out]confPointer to PLME-TRX.confirm parameters. See plme_trx_conf_t.
void plme_set_trx_state_req ( plme_trx_req_t req)

PLME-SET_TRX_STATE request.

Request PHY to change internal operating state. In accordance with IEEE Std 802.15.4-2006, section 6.2.2.7

Parameters
[in]reqPointer to PLME-SET_TRX_STATE.request parameters. See plme_trx_req_t.

Documentation feedback | Developer Zone | Subscribe | Updated