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 EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MCPS_DATA_CON_LEN, and MCPS_DATA_CONFIRM.

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
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 EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MLME_ASSOCIATE_CONF_LEN, and MLME_ASSOCIATE_CONFIRM.

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

References wpan_addr_spec_tag::Addr, wpan_addr_spec_tag::AddrMode, EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MLME_DISASSOCIATE_CONF_LEN, MLME_DISASSOCIATE_CONFIRM, and wpan_addr_spec_tag::PANId.

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 EOT, get_next_tx_buffer(), mac_get_pib_attribute_size(), MAC_PID, MAC_PID_LEN, macBeaconTxTime, macMaxFrameTotalWaitTime, macResponseWaitTime, macTransactionPersistenceTime, MLME_GET_CONF_LEN, and MLME_GET_CONFIRM.

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

References EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MLME_POLL_CONF_LEN, and MLME_POLL_CONFIRM.

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 EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MLME_RESET_CONF_LEN, and MLME_RESET_CONFIRM.

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

References EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MLME_RX_ENABLE_CONF_LEN, and MLME_RX_ENABLE_CONFIRM.

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 
)

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

Parameters
statusResult of requested scan operation.
ScanTypeType of scan performed.
ChannelPageThe channel page on which the scan was performed.
UnscannedChannelsBitmap of unscanned channels
ResultListSizeNumber of elements in ResultList.
ResultListPointer to array of scan results .
Returns
void

References wpan_addr_spec_tag::AddrMode, wpan_pandescriptor_tag::ChannelPage, wpan_pandescriptor_tag::CoordAddrSpec, EOT, get_next_tx_buffer(), wpan_pandescriptor_tag::GTSPermit, wpan_pandescriptor_tag::LinkQuality, wpan_pandescriptor_tag::LogicalChannel, MAC_PID, MAC_PID_LEN, MLME_SCAN_CONF_LEN, MLME_SCAN_CONFIRM, MLME_SCAN_TYPE_ACTIVE, MLME_SCAN_TYPE_ED, MLME_SCAN_TYPE_PASSIVE, wpan_addr_spec_tag::PANId, wpan_pandescriptor_tag::SuperframeSpec, wpan_pandescriptor_tag::TimeStamp, and WPAN_DESCRIPTOR_LEN.

Referenced by mlme_scan_conf().

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 EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MLME_SET_CONF_LEN, and MLME_SET_CONFIRM.

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