nRF5 SDK v17.1.0
Data Structures | Typedefs | Enumerations | Functions
MAC MLME GTS API

Module to declare MAC MLME GTS API. More...

Data Structures

union  mac_gts_characteristics_t
 MAC GTS characteristics (not packed) More...
 
struct  mlme_gts_conf_t
 MLME-GTS.confirm. More...
 
struct  mlme_gts_req_t
 MLME-GTS.request. More...
 
struct  mlme_gts_ind_t
 MLME-GTS.indication. More...
 

Typedefs

typedef void(* mlme_gts_conf_cb_t )(mlme_gts_conf_t *)
 MLME-GTS confirm callback. More...
 

Enumerations

enum  mac_gts_direction_t {
  MAC_GTS_DIR_TXONLY = 0,
  MAC_GTS_DIR_RXONLY = 1
}
 GTS directions, from device side. More...
 
enum  mac_gts_characteristics_type_t {
  MAC_GTS_DEALLOC = 0,
  MAC_GTS_ALLOC = 1
}
 GTS characteristics type. More...
 

Functions

void mlme_gts_req (mlme_gts_req_t *req, mlme_gts_conf_cb_t conf_cb)
 MLME-GTS request. More...
 
void mlme_gts_ind (mlme_gts_ind_t *ind)
 MLME-GTS indication handler. More...
 

Detailed Description

Module to declare MAC MLME GTS API.

The MAC GTS module declares MAC Guaranteed Time Slots routines and necessary types according to the MAC specification. More specifically, MLME GTS request aka mlme_gts_req(), MLME GTS indicaton aka mlme_gts_ind(), and MLME GTS confirm callback typedef aka mlme_gts_conf_cb_t primitives are declared.

Typedef Documentation

typedef void(* mlme_gts_conf_cb_t)(mlme_gts_conf_t *)

MLME-GTS confirm callback.

The MLME-GTS.confirm primitive is generated by the MLME and issued to its next higher layer in response to a previously issued MLME-GTS.request primitive.

Parameters
MLME_GTScallback structure.

In accordance with IEEE Std 802.15.4-2006, section 7.1.7.4

Enumeration Type Documentation

GTS characteristics type.

Enumerator
MAC_GTS_DEALLOC 

GTS Dealloc.

MAC_GTS_ALLOC 

GTS Alloc.

GTS directions, from device side.

Enumerator
MAC_GTS_DIR_TXONLY 

TX only direction.

MAC_GTS_DIR_RXONLY 

RX only direction.

Function Documentation

void mlme_gts_ind ( mlme_gts_ind_t ind)

MLME-GTS indication handler.

The MLME-GTS.indication primitive is generated by the MLME of the PAN coordinator to its next higher layer whenever a GTS is allocated or deallocated following the reception of a GTS request command (see 7.3.9) by the MLME. The MLME of the PAN coordinator also generates this primitive when a GTS deallocation is initiated by the PAN coordinator itself.

Parameters
indMLME_GTS indication structure.

In accordance with IEEE Std 802.15.4-2006, section 7.1.7.4

void mlme_gts_req ( mlme_gts_req_t req,
mlme_gts_conf_cb_t  conf_cb 
)

MLME-GTS request.

The MLME-GTS.request primitive is generated by the next higher layer of a device and issued to its MLME to request the allocation of a new GTS or to request the deallocation of an existing GTS. It is also generated by the next higher layer of the PAN coordinator and issued to its MLME to request the deallocation of an existing GTS.

Parameters
reqMLME_GTS request structure.
conf_cbpointer to user callback.

In accordance with IEEE Std 802.15.4-2006, section 7.1.7.4


Documentation feedback | Developer Zone | Subscribe | Updated