Module to declare MAC MLME RX-Enable API. More...
Data Structures | |
struct | mlme_rx_enable_conf_t |
MLME-RX-ENABLE.confirm. More... | |
struct | mlme_rx_enable_req_t |
MLME-RX-ENABLE.request. More... | |
Typedefs | |
typedef void(* | mlme_rx_enable_conf_cb_t )(mlme_rx_enable_conf_t *) |
Customer's function of confirmation. More... | |
Functions | |
void | mlme_rx_enable_req (mlme_rx_enable_req_t *req, mlme_rx_enable_conf_cb_t conf_cb) |
MLME-RX-ENABLE.request service. More... | |
mac_status_t | mlme_rx_enable (mlme_rx_enable_req_t *req) |
Enables permission for receiving. More... | |
Module to declare MAC MLME RX-Enable API.
The MAC RX-Enable module declares MLME RX-Enable primitives and necessary types according to the MAC specification. More specifically, MLME RX-Enable request aka mlme_rx_enable_req(), and MLME RX-Enable confirm callback typedef aka mlme_rx_enable_conf_cb_t primitives are declared. One additional primitive not covered by the standard is declared. This is mlme_rx_enable() which is synchronous (i.e. does not require confirmation) version of mlme_rx_enable_req().
typedef void(* mlme_rx_enable_conf_cb_t)(mlme_rx_enable_conf_t *) |
Customer's function of confirmation.
The MLME-RX-ENABLE.confirm primitive is generated by the MLME and issued to its next higher layer in response to an MLME-RX-ENABLE.request primitive.
pointer | to a confirmation primitive. |
mac_status_t mlme_rx_enable | ( | mlme_rx_enable_req_t * | req | ) |
Enables permission for receiving.
Optional. Not covered by a standard.
[in] | req | pointer to MLME-RX-ENABLE request structure. |
void mlme_rx_enable_req | ( | mlme_rx_enable_req_t * | req, |
mlme_rx_enable_conf_cb_t | conf_cb | ||
) |
MLME-RX-ENABLE.request service.
The MLME-RX-ENABLE.request primitive is generated by the next higher layer and issued to the MLME to enable the receiver for a fixed duration, at a time relative to the start of the current or next superframe on a beacon-enabled PAN or immediately on a nonbeacon-enabled PAN. This primitive may also be generated to cancel a previously generated request to enable the receiver. After request completion, user callback will be issued with valid data stored in structure mlme_rx_enable_conf_t.
[in] | req | pointer to MLME-RX-ENABLE request structure. |
[in] | conf_cb | - pointer to confirm function (user callback). |
In accordance with IEEE Std 802.15.4-2006, section 7.1.10.1