Module to declare MAC MCPS Data API. More...
Data Structures | |
| struct | mac_tx_options_t |
| TX options for MAC data transmission. More... | |
| struct | mcps_data_conf_t |
| MCPS-DATA.confirm. More... | |
| struct | mcps_data_req_t |
| MCPS-DATA.request. More... | |
| struct | mcps_data_ind_private_t |
| Private information passed with MCPS-DATA.indication. Not covered by the standard. More... | |
| struct | mcps_data_ind_t |
| MCPS-DATA.indication. More... | |
Macros | |
| #define | TX_ACKNOWLEDGED_BIT (0) |
| TX options bit fields. More... | |
| #define | TX_GTS_BIT (1) |
| #define | TX_INDIRECT_BIT (2) |
Typedefs | |
| typedef void(* | mcps_data_conf_cb_t )(mcps_data_conf_t *) |
| Confirmation function. More... | |
Functions | |
| void | mcps_data_req (mcps_data_req_t *req, mcps_data_conf_cb_t conf_cb) |
| MCPS-DATA.request service. More... | |
| void | mcps_data_ind (mcps_data_ind_t *ind) |
| MCPS-DATA.indication handler. More... | |
| void | mac_mem_msdu_free (mac_payload_descriptor_t *p_payload_descriptor) |
| Free memory allocated for incoming message. More... | |
Module to declare MAC MCPS Data API.
The MAC MCPS Data module declares the MAC Data transmission routines and necessary types according to the MAC specification. More specifically, MAC data request mcps_data_req(), and MAC Data indication mcps_data_ind() primitives are declared. The confirmation callback typedef is declared as mcps_data_conf_cb_t.
| #define TX_ACKNOWLEDGED_BIT (0) |
TX options bit fields.
In accordance with IEEE Std 802.15.4-2006, section 7.1.1.1.
| typedef void(* mcps_data_conf_cb_t)(mcps_data_conf_t *) |
Confirmation function.
The MCPS-DATA.confirm primitive is generated by the MAC sublayer entity in response to an MCPS-DATA. request primitive. The MCPS-DATA.confirm primitive returns a status of either SUCCESS, indicating that the request to transmit was successful, or the appropriate error code. The status values are fully described in 7.1.1.1.3 and subclauses referenced by 7.1.1.1.3.
| Pointer | to confirmation primitive. |
| void mac_mem_msdu_free | ( | mac_payload_descriptor_t * | p_payload_descriptor | ) |
Free memory allocated for incoming message.
The function will be invoked after all manipulations with MSDU are completed. That is necessary to return the memory allocated by MAC into the heap.
| p_payload_descriptor | - Pointer to MSDU descriptor. |
| void mcps_data_ind | ( | mcps_data_ind_t * | ind | ) |
MCPS-DATA.indication handler.
The MCPS-DATA.indication primitive is generated by the MAC sublayer and issued to the SSCS on receipt of a data frame at the local MAC sublayer entity that passes the appropriate message filtering operations as described in 7.5.6.2.
| ind | MCPS-DATA.indication structure. |
In accordance with IEEE Std 802.15.4-2006, section 7.1.1.3.
| void mcps_data_req | ( | mcps_data_req_t * | req, |
| mcps_data_conf_cb_t | conf_cb | ||
| ) |
MCPS-DATA.request service.
The MCPS-DATA.request primitive is generated by a local SSCS entity when a data SPDU (i.e., MSDU) is to be transferred to a peer SSCS entity. After request completion, user callback will be issued with valid data stored in structure mcps_data_conf_t.
| req | Pointer to MCPS-DATA request structure. |
| conf_cb | Pointer to confirmation function (user callback). |
In accordance with IEEE Std 802.15.4-2006, section 7.1.1.2.