Microchip® Advanced Software Framework

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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
SrcAddrSpecPointer to source address specification.
DstAddrSpecPointer to destination address specification.
msduLengthNumber of octets contained in MSDU.
msduPointer to MSDU.
mpduLinkQualityLQI measured during reception of the MPDU.
DSNThe DSN of the received data frame.
TimestampThe time, in symbols, at which the data were received; this parameter is only available if timestamping is enabled via compile switch ENABLE_TSTAMP.
SecurityLevelUsed security level; this parameter is only available if MAC security is enabled via MAC_SECURITY_ZIP
KeyIdModeUsed mode to identify the key; this parameter is only available if MAC security is enabled via MAC_SECURITY_ZIP
KeyIndexUsed index of the key; this parameter is only available if MAC security is enabled via MAC_SECURITY_ZIP
Returns
void
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
DeviceAddressExtended address of device requesting association.
CapabilityInformationCapabilities of device requesting association. (WPAN_CAP_ALTPANCOORD | WPAN_CAP_FFD | WPAN_CAP_PWRSOURCE | WPAN_CAP_RXONWHENIDLE | WPAN_CAP_ALLOCADDRESS)
Returns
void
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
BSNBeacon sequence number.
PANDescriptorPointer to PAN descriptor for received beacon.
PendAddrSpecPending address specification in received beacon.
AddrListList of addresses of devices the coordinator has pending data.
sduLengthLength of beacon payload.
sduPointer to beacon payload.
Returns
void

References APP_ASSOC_IN_PROGRESS, APP_DEVICE_RUNNING, APP_SCAN_DONE, app_state, current_channel, current_channel_page, MAC_SUCCESS, msdu_payload, PAYLOAD_LEN, usr_mlme_comm_status_ind(), WPAN_ADDRMODE_SHORT, WPAN_CAP_ALLOCADDRESS, wpan_mcps_data_req(), wpan_mlme_associate_req(), and WPAN_TXOPT_ACK.

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
SrcAddrSpecPointer to source address specification.
DstAddrSpecPointer to destination address specification.
statusResult for related response operation.
Returns
void

Referenced by usr_mlme_beacon_notify_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
DeviceAddressExtended address of device which initiated the disassociation request.
DisassociateReasonReason for the disassociation. Valid values:
Returns
void

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
OrphanAddressAddress of orphaned device.
Returns
void
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
LossReasonReason for synchronization loss.
PANIdThe PAN identifier with which the device lost synchronization or to which it was realigned.
LogicalChannelThe logical channel on which the device lost synchronization or to which it was realigned.
ChannelPageThe channel page on which the device lost synchronization or to which it was realigned.
Returns
void

References wpan_mlme_sync_req().

Referenced by mlme_sync_loss_ind().