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

msduHandle	Handle of MSDU handed over to MAC earlier.
status	Result for requested data transmission request.
Timestamp	The 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 Dispaly_Result_Frame, EOT, get_next_tx_buffer(), LED_DATA, MAC_CHANNEL_ACCESS_FAILURE, MAC_NO_ACK, MAC_PID, MAC_PID_LEN, MAC_SUCCESS, MAC_TRANSACTION_EXPIRED, MAC_TRANSACTION_OVERFLOW, MCPS_DATA_CON_LEN, MCPS_DATA_CONFIRM, and 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

msduHandle	Handle (id) of MSDU to be purged.
status	Result 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

AssocShortAddress	Short address allocated by the coordinator.
status	Result of requested association operation.

Returns

void

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

status	Result of requested disassociate operation.
DeviceAddrSpec	Pointer to wpan_addr_spec_t structure for device that has either requested disassociation or been instructed to disassociate by its coordinator.

Returns

void

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

status	Result of requested PIB attribute get operation.
PIBAttribute	Retrieved PIB attribute.
PIBAttributeIndex	Index of the PIB attribute to be read.
PIBAttributeValue	Pointer to data containing retrieved PIB attribute,

Returns

void

void usr_mlme_poll_conf

(

uint8_t

status

)

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

Parameters

status

Result of requested poll operation.

Returns

void

void usr_mlme_reset_conf

(

uint8_t

status

)

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

Parameters

status

Result of requested reset operation.

Returns

void

References APP_IDLE, app_state, default_key_source, EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MAC_SUCCESS, MLME_RESET_CONF_LEN, MLME_RESET_CONFIRM, NO_PIB_INDEX, phyCurrentPage, status, wpan_mlme_get_req(), wpan_mlme_reset_req(), and wpan_mlme_set_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

status

Result of requested receiver enable operation.

Returns

void

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

status	Result of requested scan operation.
ScanType	Type of scan performed.
ChannelPage	The channel page on which the scan was performed.
UnscannedChannels	Bitmap of unscanned channels
ResultListSize	Number of elements in ResultList.
ResultList	Pointer to array of scan results .

Returns

void

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

status	Result of requested PIB attribute set operation.
PIBAttribute	Updated PIB attribute.
PIBAttributeIndex	Index of updated PIB attribute.

Returns

void

References wpan_addr_spec_tag::Addr, APP_IDLE, app_state, beacon_payload, BEACON_PAYLOAD_LEN, COORD_STARTING, coord_state, current_channel, current_channel_page, EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MAC_SUCCESS, macAssociationPermit, macBeaconPayload, macBeaconPayloadLength, macCoordShortAddress, macPANId, macRxOnWhenIdle, macShortAddress, MLME_SCAN_TYPE_ACTIVE, MLME_SET_CONF_LEN, MLME_SET_CONFIRM, SCAN_CHANNEL, SCAN_DURATION_COORDINATOR, status, wpan_mlme_reset_req(), wpan_mlme_scan_req(), wpan_mlme_set_req(), and wpan_mlme_sync_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

status

Result of requested start operation.

Returns

void