MAC Indication Callback'

This module describes all MAC Indication Callback's.

Functions
void	usr_mcps_data_ind (wpan_addr_spec_t *SrcAddrSpec, wpan_addr_spec_t *DstAddrSpec, uint8_t msduLength, uint8_t *msdu, uint8_t mpduLinkQuality, uint8_t DSN, uint32_t Timestamp, uint8_t SecurityLevel, uint8_t KeyIdMode, uint8_t KeyIndex)
	Callback function that must be implemented by application (NHLE) for MAC service MCPS-DATA.indication. More...
void	usr_mlme_associate_ind (uint64_t DeviceAddress, uint8_t CapabilityInformation)
	Callback function that must be implemented by application (NHLE) for MAC service MLME-ASSOCIATE.indication. More...
void	usr_mlme_beacon_notify_ind (uint8_t BSN, wpan_pandescriptor_t *PANDescriptor, uint8_t PendAddrSpec, uint8_t *AddrList, uint8_t sduLength, uint8_t *sdu)
	Callback function that must be implemented by application (NHLE) for MAC service MLME-BEACON-NOTIFY.indication. More...
void	usr_mlme_comm_status_ind (wpan_addr_spec_t *SrcAddrSpec, wpan_addr_spec_t *DstAddrSpec, uint8_t status)
	Callback function that must be implemented by application (NHLE) for MAC service MLME-COMM-STATUS.indication. More...
void	usr_mlme_disassociate_ind (uint64_t DeviceAddress, uint8_t DisassociateReason)
	Callback function that must be implemented by application (NHLE) for MAC service MLME-DISASSOCIATE.indication. More...
void	usr_mlme_orphan_ind (uint64_t OrphanAddress)
	Callback function that must be implemented by application (NHLE) for MAC service MLME-ORPHAN.indication. More...
void	usr_mlme_sync_loss_ind (uint8_t LossReason, uint16_t PANId, uint8_t LogicalChannel, uint8_t ChannelPage)
	Callback function that must be implemented by application (NHLE) for MAC service MLME-SYNC-LOSS.indication. More...

void usr_mcps_data_ind	(	wpan_addr_spec_t *	SrcAddrSpec,
		wpan_addr_spec_t *	DstAddrSpec,
		uint8_t	msduLength,
		uint8_t *	msdu,
		uint8_t	mpduLinkQuality,
		uint8_t	DSN,
		uint32_t	Timestamp,
		uint8_t	SecurityLevel,
		uint8_t	KeyIdMode,
		uint8_t	KeyIndex
	)

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

Parameters

SrcAddrSpec	Pointer to source address specification.
DstAddrSpec	Pointer to destination address specification.
msduLength	Number of octets contained in MSDU.
msdu	Pointer to MSDU.
mpduLinkQuality	LQI measured during reception of the MPDU.
DSN	The DSN of the received data frame.
Timestamp	The time, in symbols, at which the data were received; this parameter is only available if timestamping is enabled via compile switch ENABLE_TSTAMP.
SecurityLevel	Used security level; this parameter is only available if MAC security is enabled via MAC_SECURITY_ZIP
KeyIdMode	Used mode to identify the key; this parameter is only available if MAC security is enabled via MAC_SECURITY_ZIP
KeyIndex	Used index of the key; this parameter is only available if MAC security is enabled via MAC_SECURITY_ZIP

Returns

void

References wpan_addr_spec_tag::Addr, wpan_addr_spec_tag::AddrMode, EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MCPS_DATA_IND_LEN, MCPS_DATA_INDICATION, and wpan_addr_spec_tag::PANId.

Referenced by mcps_data_ind().

void usr_mlme_associate_ind	(	uint64_t	DeviceAddress,
		uint8_t	CapabilityInformation
	)

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

Parameters

DeviceAddress	Extended address of device requesting association.
CapabilityInformation	Capabilities of device requesting association. (WPAN_CAP_ALTPANCOORD | WPAN_CAP_FFD | WPAN_CAP_PWRSOURCE | WPAN_CAP_RXONWHENIDLE | WPAN_CAP_ALLOCADDRESS)

Returns

void

References EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MLME_ASSOCIATE_IND_LEN, and MLME_ASSOCIATE_INDICATION.

Referenced by mlme_associate_ind().

void usr_mlme_beacon_notify_ind	(	uint8_t	BSN,
		wpan_pandescriptor_t *	PANDescriptor,
		uint8_t	PendAddrSpec,
		uint8_t *	AddrList,
		uint8_t	sduLength,
		uint8_t *	sdu
	)

Callback function that must be implemented by application (NHLE) for MAC service MLME-BEACON-NOTIFY.indication.

Parameters

BSN	Beacon sequence number.
PANDescriptor	Pointer to PAN descriptor for received beacon.
PendAddrSpec	Pending address specification in received beacon.
AddrList	List of addresses of devices the coordinator has pending data.
sduLength	Length of beacon payload.
sdu	Pointer to beacon payload.

Returns

void

References wpan_addr_spec_tag::Addr, 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_BEACON_NOTIFY_IND_LEN, MLME_BEACON_NOTIFY_INDICATION, wpan_addr_spec_tag::PANId, wpan_pandescriptor_tag::SuperframeSpec, wpan_pandescriptor_tag::TimeStamp, WPAN_DESCRIPTOR_LEN, WPAN_NUM_EXTENDED_ADDR_PENDING, and WPAN_NUM_SHORT_ADDR_PENDING.

Referenced by mlme_beacon_notify_ind().

void usr_mlme_comm_status_ind	(	wpan_addr_spec_t *	SrcAddrSpec,
		wpan_addr_spec_t *	DstAddrSpec,
		uint8_t	status
	)

Callback function that must be implemented by application (NHLE) for MAC service MLME-COMM-STATUS.indication.

Parameters

SrcAddrSpec	Pointer to source address specification.
DstAddrSpec	Pointer to destination address specification.
status	Result for related response operation.

Returns

void

References wpan_addr_spec_tag::Addr, wpan_addr_spec_tag::AddrMode, EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MLME_COMM_STATUS_IND_LEN, MLME_COMM_STATUS_INDICATION, and wpan_addr_spec_tag::PANId.

Referenced by mlme_comm_status_ind().

void usr_mlme_disassociate_ind	(	uint64_t	DeviceAddress,
		uint8_t	DisassociateReason
	)

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

Parameters

DeviceAddress	Extended address of device which initiated the disassociation request.
DisassociateReason	Reason for the disassociation. Valid values: WPAN_DISASSOC_BYPARENT, WPAN_DISASSOC_BYCHILD.

Returns

void

References EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MLME_DISASSOCIATE_IND_LEN, and MLME_DISASSOCIATE_INDICATION.

Referenced by mlme_disassociate_ind().

void usr_mlme_orphan_ind

(

uint64_t

OrphanAddress

)

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

Parameters

OrphanAddress

Address of orphaned device.

Returns

void

References EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MLME_ORPHAN_IND_LEN, and MLME_ORPHAN_INDICATION.

Referenced by mlme_orphan_ind().

void usr_mlme_sync_loss_ind	(	uint8_t	LossReason,
		uint16_t	PANId,
		uint8_t	LogicalChannel,
		uint8_t	ChannelPage
	)

Callback function that must be implemented by application (NHLE) for MAC service MLME-SYNC-LOSS.indication.

Parameters

LossReason	Reason for synchronization loss.
PANId	The PAN identifier with which the device lost synchronization or to which it was realigned.
LogicalChannel	The logical channel on which the device lost synchronization or to which it was realigned.
ChannelPage	The channel page on which the device lost synchronization or to which it was realigned.

Returns

void

References EOT, get_next_tx_buffer(), MAC_PID, MAC_PID_LEN, MLME_SYNC_LOSS_IND_LEN, and MLME_SYNC_LOSS_INDICATION.

Referenced by mlme_sync_loss_ind().