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

Module to declare PHY Clear Channel Assessment API. More...

Data Structures

struct  plme_cca_conf_t
 PLME-CCA.confirm parameters. More...
 

Functions

void plme_cca_req (void)
 PLME-CCA.request. More...
 
void plme_cca_conf (plme_cca_conf_t *conf)
 PLME-CCA.confirm callback function, implemented by the next higher layer. More...
 
phy_enum_t plme_cca (void)
 Direct (synchronous) PLME-CCA.request. More...
 

Detailed Description

Module to declare PHY Clear Channel Assessment API.

The PHY CCA module declares Clear Channel Assessment PHY routines and necessary types according to the PHY specification. More specifically, PHY CCA request plme_cca_req(), PHY CCA confirm plme_cca_conf() primitives are declared. An additional primitive not covered by the standard is declared. This is plme_cca() which is a synchronous version of plme_cca_req().

Function Documentation

phy_enum_t plme_cca ( void  )

Direct (synchronous) PLME-CCA.request.

Optional. Not covered by a standard.

Returns
One of PHY_TRX_OFF, PHY_BUSY or PHY_IDLE, or implementation defined error code in case of unavailability of access to system resources.
void plme_cca_conf ( plme_cca_conf_t conf)

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

The PLME-CCA.confirm primitive is generated by the PLME and issued to its next higher layer in response to an PLME-CCA.request primitive. In accordance with IEEE Std 802.15.4-2006, section 6.2.2.2

Parameters
[out]confPointer to PLME-CCA.confirm parameters
void plme_cca_req ( void  )

PLME-CCA.request.

Request for clear channel assessment. In accordance with IEEE Std 802.15.4-2006, section 6.2.2.1


Documentation feedback | Developer Zone | Subscribe | Updated