Microchip® Advanced Software Framework

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
MAC Confirmation Callback's

This module describes all MAC Confirmation Callback's.

Functions

void usr_mcps_data_conf (uint8_t msduHandle, uint8_t status, uint32_t Timestamp)
 Callback function that must be implemented by application (NHLE) for MAC service MCPS-DATA.confirm. More...
 
void usr_mcps_purge_conf (uint8_t msduHandle, uint8_t status)
 Callback function that must be implemented by application (NHLE) for MAC service MCPS-PURGE.confirm. More...
 
void usr_mlme_associate_conf (uint16_t AssocShortAddress, uint8_t status)
 Callback function that must be implemented by application (NHLE) for MAC service MLME-ASSOCIATE.confirm. More...
 
void usr_mlme_disassociate_conf (uint8_t status, wpan_addr_spec_t *DeviceAddrSpec)
 Callback function that must be implemented by application (NHLE) for MAC service MLME-DISASSOCIATE.confirm. More...
 
void usr_mlme_get_conf (uint8_t status, uint8_t PIBAttribute, void *PIBAttributeValue)
 Callback function that must be implemented by application (NHLE) for MAC service MLME-GET.confirm. More...
 
void usr_mlme_poll_conf (uint8_t status)
 Callback function that must be implemented by application (NHLE) for MAC service MLME-POLL.confirm. More...
 
void usr_mlme_reset_conf (uint8_t status)
 Callback function that must be implemented by application (NHLE) for MAC service MLME-RESET.confirm. More...
 
void usr_mlme_rx_enable_conf (uint8_t status)
 Callback function that must be implemented by application (NHLE) for MAC service MLME-RX-ENABLE.confirm. More...
 
void usr_mlme_scan_conf (uint8_t status, uint8_t ScanType, uint8_t ChannelPage, uint32_t UnscannedChannels, uint8_t ResultListSize, void *ResultList)
 Callback function that must be implemented by application (NHLE) for MAC service MLME-SCAN.confirm. More...
 
void usr_mlme_set_conf (uint8_t status, uint8_t PIBAttribute)
 Callback function that must be implemented by application (NHLE) for MAC service MLME-SET.confirm. More...
 
void usr_mlme_start_conf (uint8_t status)
 Callback function that must be implemented by application (NHLE) for MAC service MLME-START.confirm. More...
 

void usr_mcps_data_conf ( uint8_t  msduHandle,
uint8_t  status,
uint32_t  Timestamp 
)

Callback function that must be implemented by application (NHLE) for MAC service MCPS-DATA.confirm.

Parameters
msduHandleHandle of MSDU handed over to MAC earlier.
statusResult for requested data transmission request.
TimestampThe time, in symbols, at which the data were transmitted; this parameter is only available if timestamping is enabled via compile switch ENABLE_TSTAMP.
Returns
void

References delay_ms, IDLE, LED_DATA, LED_Off, MAC_SUCCESS, and node_status.

Referenced by mcps_data_conf().

void usr_mcps_purge_conf ( uint8_t  msduHandle,
uint8_t  status 
)

Callback function that must be implemented by application (NHLE) for MAC service MCPS-PURGE.confirm.

Parameters
msduHandleHandle (id) of MSDU to be purged.
statusResult of requested purge operation.
Returns
void

Referenced by mcps_purge_conf().

void usr_mlme_associate_conf ( uint16_t  AssocShortAddress,
uint8_t  status 
)

Callback function that must be implemented by application (NHLE) for MAC service MLME-ASSOCIATE.confirm.

Parameters
AssocShortAddressShort address allocated by the coordinator.
statusResult of requested association operation.
Returns
void

References awake_timer_cb(), DATA_TX_PERIOD, FUNC_PTR, IDLE, LED_NWK_SETUP, LED_On, MAC_SUCCESS, node_status, SW_TIMEOUT_RELATIVE, sw_timer_start(), sw_timer_stop(), TIMER_LED_OFF, and wpan_mlme_reset_req().

Referenced by mlme_associate_conf().

void usr_mlme_disassociate_conf ( uint8_t  status,
wpan_addr_spec_t DeviceAddrSpec 
)

Callback function that must be implemented by application (NHLE) for MAC service MLME-DISASSOCIATE.confirm.

Parameters
statusResult of requested disassociate operation.
DeviceAddrSpecPointer to wpan_addr_spec_t structure for device that has either requested disassociation or been instructed to disassociate by its coordinator.
Returns
void

Referenced by mlme_disassociate_conf().

void usr_mlme_get_conf ( uint8_t  status,
uint8_t  PIBAttribute,
void *  PIBAttributeValue 
)

Callback function that must be implemented by application (NHLE) for MAC service MLME-GET.confirm.

Parameters
statusResult of requested PIB attribute get operation.
PIBAttributeRetrieved PIB attribute.
PIBAttributeIndexIndex of the PIB attribute to be read.
PIBAttributeValuePointer to data containing retrieved PIB attribute,
Returns
void

References CHANNEL_OFFSET, channels_supported, current_channel, current_channel_page, FUNC_PTR, MAC_SUCCESS, MLME_SCAN_TYPE_ACTIVE, network_scan_indication_cb(), phyChannelsSupported, phyCurrentPage, SCAN_CHANNEL, SCAN_DURATION, SW_TIMEOUT_RELATIVE, sw_timer_start(), TIMER_LED_OFF, wpan_mlme_get_req(), and wpan_mlme_scan_req().

Referenced by mlme_get_conf().

void usr_mlme_poll_conf ( uint8_t  status)

Callback function that must be implemented by application (NHLE) for MAC service MLME-POLL.confirm.

Parameters
statusResult of requested poll operation.
Returns
void

Referenced by mlme_poll_conf().

void usr_mlme_reset_conf ( uint8_t  status)

Callback function that must be implemented by application (NHLE) for MAC service MLME-RESET.confirm.

Parameters
statusResult of requested reset operation.
Returns
void

References MAC_SUCCESS, phyCurrentPage, wpan_mlme_get_req(), and wpan_mlme_reset_req().

Referenced by mlme_reset_conf().

void usr_mlme_rx_enable_conf ( uint8_t  status)

Callback function that must be implemented by application (NHLE) for MAC service MLME-RX-ENABLE.confirm.

Parameters
statusResult of requested receiver enable operation.
Returns
void

Referenced by mlme_rx_enable_conf().

void usr_mlme_scan_conf ( uint8_t  status,
uint8_t  ScanType,
uint8_t  ChannelPage,
uint32_t  UnscannedChannels,
uint8_t  ResultListSize,
void *  ResultList 
)
void usr_mlme_set_conf ( uint8_t  status,
uint8_t  PIBAttribute 
)

Callback function that must be implemented by application (NHLE) for MAC service MLME-SET.confirm.

Parameters
statusResult of requested PIB attribute set operation.
PIBAttributeUpdated PIB attribute.
PIBAttributeIndexIndex of updated PIB attribute.
Returns
void

References current_channel, current_channel_page, DEFAULT_PAN_ID, MAC_SUCCESS, macAssociationPermit, macRxOnWhenIdle, macShortAddress, wpan_mlme_reset_req(), wpan_mlme_set_req(), and wpan_mlme_start_req().

Referenced by mlme_set_conf().

void usr_mlme_start_conf ( uint8_t  status)

Callback function that must be implemented by application (NHLE) for MAC service MLME-START.confirm.

Parameters
statusResult of requested start operation.
Returns
void

References LED_NWK_SETUP, LED_On, MAC_SUCCESS, node_status, PC_RUNNING, sw_timer_stop(), TIMER_LED_OFF, and wpan_mlme_reset_req().

Referenced by mlme_start_conf().