nRF5 SDK v17.1.0
Data Structures | Macros | Enumerations | Functions
PHY PIB API

Module to declare PHY Information Base API. More...

Data Structures

union  phy_pib_item_t
 PHY PIB attribute type sizes. More...
 
struct  plme_get_req_t
 PLME-GET.request parameters. More...
 
struct  plme_get_conf_t
 PLME-GET.confirm parameters. More...
 
struct  plme_set_req_t
 PLME-SET.request parameters. More...
 
struct  plme_set_conf_t
 PLME-SET.confirm parameters. More...
 

Macros

#define PHY_TX_POWER_TOLERANCE_1DB   0x00
 
#define PHY_TX_POWER_TOLERANCE_3DB   0x40
 
#define PHY_TX_POWER_TOLERANCE_6DB   0x80
 
#define PHY_TX_POWER_TOLERANCE_MASK   0xC0
 

Enumerations

enum  plme_pib_attr_id_t {
  PHY_CURRENT_CHANNEL_ID = 0x00,
  PHY_CHANNELS_SUPPORTED_ID = 0x01,
  PHY_TRANSMIT_POWER_ID = 0x02,
  PHY_CCA_MODE_ID = 0x03,
  PHY_CURRENT_PAGE_ID = 0x04,
  PHY_MAX_FRAME_DURATION_ID = 0X05,
  PHY_SHR_DURATION_ID = 0x06,
  PHY_SYMBOLS_PER_OCTET_ID = 0x07
}
 PHY PIB attribute identificators. More...
 

Functions

void plme_get_req (plme_get_req_t *req)
 PLME-GET.request. More...
 
void plme_get_conf (plme_get_conf_t *conf)
 PLME-GET.confirm callback function, implemented by the next higher layer. More...
 
void plme_set_req (plme_set_req_t *req)
 PLME-SET.request. More...
 
void plme_set_conf (plme_set_conf_t *conf)
 PLME-SET.confirm callback function, implemented by the next higher layer. More...
 
phy_status_t plme_get (plme_pib_attr_id_t id, void *mem)
 Getting parameters from PIB directly (without request - confirm approach) More...
 
phy_status_t plme_set (plme_pib_attr_id_t id, void *mem)
 Setting parameters to PIB directly (without request - confirm approach) More...
 

Detailed Description

Module to declare PHY Information Base API.

The PHY PIB module declares PHY Information Base routines and necessary types according to the PHY specification. More specifically, PHY PIB Get request plme_get_req(), PHY PIB Set request plme_set_req(), PHY PIB Get confirm plme_get_conf(), and PHY PIB Set confirm plme_set_conf() primitives are declared. Two additional primitives not covered by the standard are declared. These are plme_get() and plme_set() which are synchronous versions of plme_get_req() and plme_set_req() accordingly.

Enumeration Type Documentation

PHY PIB attribute identificators.

In accordance with IEEE Std 802.15.4-2006, section 6.4.2.

Enumerator
PHY_CURRENT_CHANNEL_ID 

Current channel.

PHY_CHANNELS_SUPPORTED_ID 

Supported channels.

Note
read only.
PHY_TRANSMIT_POWER_ID 

Transmit power.

PHY_CCA_MODE_ID 

CCA mode.

PHY_CURRENT_PAGE_ID 

Current page.

PHY_MAX_FRAME_DURATION_ID 

MAX Frame duration.

Note
read only.
PHY_SHR_DURATION_ID 

SHR Duration.

Note
read only.
PHY_SYMBOLS_PER_OCTET_ID 

Symbols per octet.

Note
read only.

Function Documentation

phy_status_t plme_get ( plme_pib_attr_id_t  id,
void *  mem 
)

Getting parameters from PIB directly (without request - confirm approach)

Optional. Not covered by a standard.

Parameters
[in]idattribute id.
[out]mempointer to memory for parameter storing.
Returns
status of operation.
void plme_get_conf ( plme_get_conf_t conf)

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

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

Parameters
[out]confPointer to PLME-GET.confirm parameters. See plme_get_conf_t.
void plme_get_req ( plme_get_req_t req)

PLME-GET.request.

In accordance with IEEE Std 802.15.4-2006, section 6.2.2.5.

Parameters
[in]reqPointer to PLME-GET.request parameters. See plme_get_req_t.
phy_status_t plme_set ( plme_pib_attr_id_t  id,
void *  mem 
)

Setting parameters to PIB directly (without request - confirm approach)

Optional. Not covered by a standard.

Parameters
[in]idattribute id.
[out]mempointer to memory for parameter storing.
Returns
status of operation.
void plme_set_conf ( plme_set_conf_t conf)

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

In accordance with IEEE Std 802.15.4-2006, section 6.2.2.10.

Parameters
[out]confPointer to PLME-SET.confirm parameters. See plme_set_conf_t.
void plme_set_req ( plme_set_req_t req)

PLME-SET.request.

In accordance with IEEE Std 802.15.4-2006, section 6.2.2.9.

Parameters
[in]reqPointer to PLME-SET.request parameters. See plme_set_req_t.

Documentation feedback | Developer Zone | Subscribe | Updated