Microchip® Advanced Software Framework

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
MAC Data Structures

This module defines all the MAC Data Structures.

Modules

 MAC Definitions
 All Definitions used by the MAC Layer is described here.
 

Data Structures

struct  mcps_data_conf_tag
 This is the MCPS-DATA.confirm message structure. More...
 
struct  mcps_data_ind_tag
 This is the MCPS-DATA.indication message structure. More...
 
struct  mcps_data_req_tag
 This is the MCPS-DATA.request message structure. More...
 
struct  mcps_purge_conf_tag
 This is the MCPS-PURGE.confirm message structure. More...
 
struct  mcps_purge_req_tag
 This is the MCPS-PURGE.request message structure. More...
 
struct  mlme_associate_conf_tag
 This is the MLME-ASSOCIATE.confirm message structure. More...
 
struct  mlme_associate_ind_tag
 This is the MLME-ASSOCIATE.indication message structure. More...
 
struct  mlme_associate_req_tag
 This is the MLME-ASSOCIATE.request message structure. More...
 
struct  mlme_associate_resp_tag
 This is the MLME-ASSOCIATE.response message structure. More...
 
struct  mlme_beacon_notify_ind_tag
 This is the MLME-BEACON-NOTIFY.indication message structure. More...
 
struct  mlme_comm_status_ind_tag
 This is the MLME-COMM-STATUS.indication message structure. More...
 
struct  mlme_disassociate_conf_tag
 This is the MLME-DISASSOCIATE.confirm message structure. More...
 
struct  mlme_disassociate_ind_tag
 This is the MLME-DISASSOCIATE.indication message structure. More...
 
struct  mlme_disassociate_req_tag
 This is the MLME-DISASSOCIATE.request message structure. More...
 
struct  mlme_get_conf_tag
 This is the MLME-GET.confirm message structure. More...
 
struct  mlme_get_req_tag
 This is the MLME-GET.request message structure. More...
 
struct  mlme_orphan_ind_tag
 This is the MLME-ORPHAN.indication message structure. More...
 
struct  mlme_orphan_resp_tag
 This is the MLME-ORPHAN.response message structure. More...
 
struct  mlme_poll_conf_tag
 This is the MLME-POLL.confirm message structure. More...
 
struct  mlme_poll_req_tag
 This is the MLME-POLL.request message structure. More...
 
struct  mlme_reset_conf_tag
 This is the MLME-RESET.confirm message structure. More...
 
struct  mlme_reset_req_tag
 This is the MLME-RESET.request message structure. More...
 
struct  mlme_rx_enable_conf_tag
 This is the MLME-RX-ENABLE.confirm message structure. More...
 
struct  mlme_rx_enable_req_tag
 This is the MLME-RX-ENABLE.request message structure. More...
 
struct  mlme_scan_conf_tag
 This is the MLME-SCAN.confirm message structure. More...
 
struct  mlme_scan_req_tag
 This is the MLME-SCAN.request message structure. More...
 
struct  mlme_start_conf_tag
 This is the MLME-START.confirm message structure. More...
 
struct  mlme_start_req_tag
 This is the MLME-START.request message structure. More...
 
struct  mlme_sync_loss_ind_tag
 This is the MLME-SYNC-LOSS.indication message structure. More...
 
struct  mlme_sync_req_tag
 This is the MLME-SYNC.request message structure. More...
 
union  scan_result_list_t
 Union to force alignment of variable portion of scan confirm with wpan_pandescriptor_t. More...
 
struct  wpan_addr_spec_tag
 Device address specification structure. More...
 
struct  wpan_pandescriptor_tag
 PAN descriptor information structure. More...
 

Typedefs

typedef struct mcps_data_conf_tag mcps_data_conf_t
 This is the MCPS-DATA.confirm message structure. More...
 
typedef __PACK__DATA__ struct
mcps_data_ind_tag 
mcps_data_ind_t
 This is the MCPS-DATA.indication message structure. More...
 
typedef struct mcps_data_req_tag mcps_data_req_t
 This is the MCPS-DATA.request message structure. More...
 
typedef struct mcps_purge_conf_tag mcps_purge_conf_t
 This is the MCPS-PURGE.confirm message structure. More...
 
typedef struct mcps_purge_req_tag mcps_purge_req_t
 This is the MCPS-PURGE.request message structure. More...
 
typedef struct
mlme_associate_conf_tag 
mlme_associate_conf_t
 This is the MLME-ASSOCIATE.confirm message structure. More...
 
typedef struct
mlme_associate_ind_tag 
mlme_associate_ind_t
 This is the MLME-ASSOCIATE.indication message structure. More...
 
typedef struct
mlme_associate_req_tag 
mlme_associate_req_t
 This is the MLME-ASSOCIATE.request message structure. More...
 
typedef struct
mlme_associate_resp_tag 
mlme_associate_resp_t
 This is the MLME-ASSOCIATE.response message structure. More...
 
typedef struct
mlme_beacon_notify_ind_tag 
mlme_beacon_notify_ind_t
 This is the MLME-BEACON-NOTIFY.indication message structure. More...
 
typedef struct
mlme_comm_status_ind_tag 
mlme_comm_status_ind_t
 This is the MLME-COMM-STATUS.indication message structure. More...
 
typedef struct
mlme_disassociate_conf_tag 
mlme_disassociate_conf_t
 This is the MLME-DISASSOCIATE.confirm message structure. More...
 
typedef struct
mlme_disassociate_ind_tag 
mlme_disassociate_ind_t
 This is the MLME-DISASSOCIATE.indication message structure. More...
 
typedef struct
mlme_disassociate_req_tag 
mlme_disassociate_req_t
 This is the MLME-DISASSOCIATE.request message structure. More...
 
typedef struct mlme_get_conf_tag mlme_get_conf_t
 This is the MLME-GET.confirm message structure. More...
 
typedef struct mlme_get_req_tag mlme_get_req_t
 This is the MLME-GET.request message structure. More...
 
typedef struct mlme_orphan_ind_tag mlme_orphan_ind_t
 This is the MLME-ORPHAN.indication message structure. More...
 
typedef struct mlme_orphan_resp_tag mlme_orphan_resp_t
 This is the MLME-ORPHAN.response message structure. More...
 
typedef struct mlme_poll_conf_tag mlme_poll_conf_t
 This is the MLME-POLL.confirm message structure. More...
 
typedef struct mlme_poll_req_tag mlme_poll_req_t
 This is the MLME-POLL.request message structure. More...
 
typedef struct mlme_reset_conf_tag mlme_reset_conf_t
 This is the MLME-RESET.confirm message structure. More...
 
typedef struct mlme_reset_req_tag mlme_reset_req_t
 This is the MLME-RESET.request message structure. More...
 
typedef struct
mlme_rx_enable_conf_tag 
mlme_rx_enable_conf_t
 This is the MLME-RX-ENABLE.confirm message structure. More...
 
typedef struct
mlme_rx_enable_req_tag 
mlme_rx_enable_req_t
 This is the MLME-RX-ENABLE.request message structure. More...
 
typedef struct mlme_scan_conf_tag mlme_scan_conf_t
 This is the MLME-SCAN.confirm message structure. More...
 
typedef struct mlme_scan_req_tag mlme_scan_req_t
 This is the MLME-SCAN.request message structure. More...
 
typedef struct mlme_start_conf_tag mlme_start_conf_t
 This is the MLME-START.confirm message structure. More...
 
typedef struct mlme_start_req_tag mlme_start_req_t
 This is the MLME-START.request message structure. More...
 
typedef struct
mlme_sync_loss_ind_tag 
mlme_sync_loss_ind_t
 This is the MLME-SYNC-LOSS.indication message structure. More...
 
typedef struct mlme_sync_req_tag mlme_sync_req_t
 This is the MLME-SYNC.request message structure. More...
 
typedef struct wpan_addr_spec_tag wpan_addr_spec_t
 Device address specification structure. More...
 
typedef struct
wpan_pandescriptor_tag 
wpan_pandescriptor_t
 PAN descriptor information structure. More...
 

Functions

uint8_t mac_get_pib_attribute_size (uint8_t pib_attribute_id)
 

Variables

uint8_t * mlme_beacon_notify_ind_tag::AddrList
 The list of addresses of the devices for which the beacon source has data. More...
 
uint8_t mlme_orphan_resp_tag::AssociatedMember
 TRUE if the orphaned device is associated with this coordinator or FALSE otherwise. More...
 
uint16_t mlme_associate_resp_tag::AssocShortAddress
 The short device address allocated by the coordinator on successful association. More...
 
uint16_t mlme_associate_conf_tag::AssocShortAddress
 The short device address allocated by the coordinator on successful association. More...
 
uint8_t mlme_start_req_tag::BatteryLifeExtension
 If this value is TRUE, the receiver of the beaconing device is disabled macBattLifeExtPeriods full backoff periods after the interframe spacing (IFS) period of the beacon frame. More...
 
uint8_t mlme_start_req_tag::BeaconOrder
 How often the beacon is to be transmitted. More...
 
uint8_t mlme_beacon_notify_ind_tag::BSN
 The beacon sequence number. More...
 
uint8_t mlme_associate_req_tag::CapabilityInformation
 Specifies the operational capabilities of the associating device. More...
 
uint8_t mlme_associate_ind_tag::CapabilityInformation
 The operational capabilities of the device requesting association. More...
 
uint8_t mlme_associate_req_tag::ChannelPage
 The channel page on which to attempt association. More...
 
uint8_t mlme_scan_req_tag::ChannelPage
 The channel page on which to perform the scan. More...
 
uint8_t mlme_scan_conf_tag::ChannelPage
 The channel page on which the scan was performed. More...
 
uint8_t mlme_start_req_tag::ChannelPage
 The channel page on which to begin using the new superframe configuration. More...
 
uint8_t mlme_sync_req_tag::ChannelPage
 The channel page on which to attempt coordinator synchronization. More...
 
uint8_t mlme_sync_loss_ind_tag::ChannelPage
 The channel page on which the device lost synchronization or to which it was realigned. More...
 
enum msg_code mcps_data_req_tag::cmdcode
 < This identifies the message as MCPS_DATA_REQUEST More...
 
enum msg_code mcps_data_conf_tag::cmdcode
 < This identifies the message as MCPS_DATA_CONFIRM More...
 
enum msg_code mcps_data_ind_tag::cmdcode
 < This identifies the message as MCPS_DATA_INDICATION More...
 
enum msg_code mcps_purge_req_tag::cmdcode
 < This identifies the message as MCPS_PURGE_REQUEST More...
 
enum msg_code mcps_purge_conf_tag::cmdcode
 < This identifies the message as MCPS_PURGE_CONFIRM More...
 
enum msg_code mlme_associate_req_tag::cmdcode
 < This identifies the message as MLME_ASSOCIATE_REQUEST More...
 
enum msg_code mlme_associate_ind_tag::cmdcode
 This identifies the message as MLME_ASSOCIATE_INDICATION. More...
 
enum msg_code mlme_associate_resp_tag::cmdcode
 This identifies the message as MLME_ASSOCIATE_RESPONSE. More...
 
enum msg_code mlme_associate_conf_tag::cmdcode
 This identifies the message as MLME_ASSOCIATE_CONFIRM. More...
 
enum msg_code mlme_disassociate_req_tag::cmdcode
 This identifies the message as MLME_DISASSOCIATE_REQUEST. More...
 
enum msg_code mlme_disassociate_ind_tag::cmdcode
 This identifies the message as MLME_DISASSOCIATE_INDICATION. More...
 
enum msg_code mlme_disassociate_conf_tag::cmdcode
 This identifies the message as MLME_DISASSOCIATE_CONFIRM. More...
 
enum msg_code mlme_beacon_notify_ind_tag::cmdcode
 This identifies the message as MLME_BEACON_NOTIFY_INDICATION. More...
 
enum msg_code mlme_orphan_ind_tag::cmdcode
 This identifies the message as MLME_ORPHAN_INDICATION. More...
 
enum msg_code mlme_orphan_resp_tag::cmdcode
 This identifies the message as MLME_ORPHAN_RESPONSE. More...
 
enum msg_code mlme_reset_req_tag::cmdcode
 < This identifies the message as MLME_RESET_REQUEST More...
 
enum msg_code mlme_reset_conf_tag::cmdcode
 < This identifies the message as MLME_RESET_CONFIRM More...
 
enum msg_code mlme_get_req_tag::cmdcode
 < This identifies the message as MLME_GET_REQUEST More...
 
enum msg_code mlme_get_conf_tag::cmdcode
 < This identifies the message as MLME_GET_CONFIRM More...
 
enum msg_code mlme_rx_enable_req_tag::cmdcode
 This identifies the message as MLME_RX_ENABLE_REQUEST. More...
 
enum msg_code mlme_rx_enable_conf_tag::cmdcode
 This identifies the message as MLME_RX_ENABLE_CONFIRM. More...
 
enum msg_code mlme_scan_req_tag::cmdcode
 This identifies the message as MLME_SCAN_REQUEST. More...
 
enum msg_code mlme_scan_conf_tag::cmdcode
 This identifies the message as MLME_SCAN_CONFIRM. More...
 
enum msg_code mlme_comm_status_ind_tag::cmdcode
 This identifies the message as MLME_COMM_STATUS_INDICATION. More...
 
enum msg_code mlme_start_req_tag::cmdcode
 This identifies the message as MLME_START_REQUEST. More...
 
enum msg_code mlme_start_conf_tag::cmdcode
 This identifies the message as MLME_START_CONFIRM. More...
 
enum msg_code mlme_sync_req_tag::cmdcode
 This identifies the message as MLME_SYNC_REQUEST. More...
 
enum msg_code mlme_sync_loss_ind_tag::cmdcode
 This identifies the message as MLME_SYNC_LOSS_INDICATION. More...
 
enum msg_code mlme_poll_req_tag::cmdcode
 This identifies the message as MLME_POLL_REQUEST. More...
 
enum msg_code mlme_poll_conf_tag::cmdcode
 This identifies the message as MLME_POLL_CONFIRM. More...
 
address_field_t mlme_associate_req_tag::CoordAddress
 The address of the coordinator with which to associate. More...
 
uint64_t mlme_poll_req_tag::CoordAddress
 The address of the coordinator to which the poll is intended. More...
 
uint8_t mlme_associate_req_tag::CoordAddrMode
 The coordinator addressing mode for this primitive and subsequent MPDU. More...
 
uint8_t mlme_poll_req_tag::CoordAddrMode
 The addressing mode of the coordinator to which the poll is intended. More...
 
uint16_t mlme_associate_req_tag::CoordPANId
 The identifier of the PAN with which to associate. More...
 
uint16_t mlme_poll_req_tag::CoordPANId
 The PAN identifier of the coordinator to which the poll is intended. More...
 
uint8_t mlme_start_req_tag::CoordRealignment
 TRUE if a coordinator realignment command is to be transmitted prior to changing the superframe configuration or FALSE otherwise. More...
 
uint8_t mlme_rx_enable_req_tag::DeferPermit
 TRUE if the receiver enable can be deferred until during the next superframe if the requested time has already passed. More...
 
uint64_t mlme_associate_ind_tag::DeviceAddress
 The address of the device requesting association. More...
 
uint64_t mlme_associate_resp_tag::DeviceAddress
 The address of the device requesting association. More...
 
uint64_t mlme_disassociate_req_tag::DeviceAddress
 The address of the device to which to send the disassociation notification command. More...
 
uint64_t mlme_disassociate_ind_tag::DeviceAddress
 The address of the device requesting disassociation. More...
 
uint64_t mlme_disassociate_conf_tag::DeviceAddress
 The address of the device that has either requested disassociation or been instructed to disassociate by its coordinator. More...
 
uint8_t mlme_disassociate_req_tag::DeviceAddrMode
 The addressing mode of the device to which to send the disassociation notification command. More...
 
uint8_t mlme_disassociate_conf_tag::DeviceAddrMode
 The addressing mode of the device that has either requested disassociation or been instructed to disassociate by its coordinator. More...
 
uint16_t mlme_disassociate_req_tag::DevicePANId
 The PAN identifier of the device to which to send the disassociation notification command. More...
 
uint16_t mlme_disassociate_conf_tag::DevicePANId
 The PAN identifier of the device that has either requested disassociation or been instructed to disassociate by its coordinator. More...
 
uint8_t mlme_disassociate_req_tag::DisassociateReason
 The reason for the disassociation (see 7.3.1.3.2). More...
 
uint8_t mlme_disassociate_ind_tag::DisassociateReason
 The reason for the disassociation (see 7.3.1.3.2). More...
 
uint8_t mcps_data_ind_tag::DSN
 The DSN of the received data frame. More...
 
uint64_t mcps_data_req_tag::DstAddr
 The individual device address of the entity to which the MSDU is being transferred. More...
 
uint64_t mcps_data_ind_tag::DstAddr
 The individual device address of the entity to which the MSDU is being transferred. More...
 
uint64_t mlme_comm_status_ind_tag::DstAddr
 The individual device address of the device for which the frame was intended. More...
 
uint8_t mcps_data_req_tag::DstAddrMode
 The destination addressing mode for this primitive and subsequent MPDU. More...
 
uint8_t mcps_data_ind_tag::DstAddrMode
 The destination addressing mode for this primitive corresponding to the received MPDU. More...
 
uint8_t mlme_comm_status_ind_tag::DstAddrMode
 The destination addressing mode for this primitive. More...
 
uint16_t mcps_data_req_tag::DstPANId
 The 16 bit PAN identifier of the entity to which the MSDU is being transferred. More...
 
uint16_t mcps_data_ind_tag::DstPANId
 The 16 bit PAN identifier of the entity to which the MSDU is being transferred. More...
 
uint8_t scan_result_list_t::ed_value [1]
 
uint8_t mlme_associate_req_tag::LogicalChannel
 The logical channel on which to attempt association. More...
 
uint8_t mlme_start_req_tag::LogicalChannel
 The logical channel on which to start using the new superframe configuration. More...
 
uint8_t mlme_sync_req_tag::LogicalChannel
 The logical channel on which to attempt coordinator synchronization. More...
 
uint8_t mlme_sync_loss_ind_tag::LogicalChannel
 The logical channel on which the device lost synchronization or to which it was realigned. More...
 
uint8_t mlme_sync_loss_ind_tag::LossReason
 The reason that synchronization was lost. More...
 
uint8_t mcps_data_ind_tag::mpduLinkQuality
 LQI value measured during reception of the MPDU. More...
 
uint8_t * mcps_data_req_tag::msdu
 The set of octets forming the MSDU to be transmitted by the MAC sublayer entity. More...
 
uint8_t * mcps_data_ind_tag::msdu
 The set of octets forming the MSDU being indicated by the MAC sublayer entity. More...
 
uint8_t mcps_data_req_tag::msduHandle
 The handle associated with the MSDU to be transmitted by the MAC sublayer entity. More...
 
uint8_t mcps_data_conf_tag::msduHandle
 The handle associated with the MSDU being confirmed. More...
 
uint8_t mcps_purge_req_tag::msduHandle
 The handle of the MSDU to be purged from the transaction queue. More...
 
uint8_t mcps_purge_conf_tag::msduHandle
 The handle of the MSDU requested to be purge from the transaction queue. More...
 
uint8_t mcps_data_req_tag::msduLength
 The number of octets contained in the MSDU to be transmitted by the MAC sublayer entity. More...
 
uint8_t mcps_data_ind_tag::msduLength
 The number of octets contained in the MSDU being indicated by the MAC sublayer entity. More...
 
uint64_t mlme_orphan_ind_tag::OrphanAddress
 The address of the orphaned device. More...
 
uint64_t mlme_orphan_resp_tag::OrphanAddress
 The address of the orphaned device. More...
 
uint8_t mlme_start_req_tag::PANCoordinator
 If this value is TRUE, the device will become the PAN coordinator of a new PAN. More...
 
wpan_pandescriptor_t mlme_beacon_notify_ind_tag::PANDescriptor
 The PANDescriptor for the received beacon. More...
 
uint16_t mlme_comm_status_ind_tag::PANId
 The 16 bit PAN identifier of the device from which the frame was received or to which the frame was being sent. More...
 
uint16_t mlme_start_req_tag::PANId
 The PAN identifier to be used by the device. More...
 
uint16_t mlme_sync_loss_ind_tag::PANId
 The PAN identifier with which the device lost synchronization or to which it was realigned. More...
 
uint8_t mlme_beacon_notify_ind_tag::PendAddrSpec
 The beacon pending address specification. More...
 
uint8_t mlme_get_req_tag::PIBAttribute
 
uint8_t mlme_get_conf_tag::PIBAttribute
 
pib_value_t mlme_get_conf_tag::PIBAttributeValue
 < The value of the indicated MAC PIB attribute that was read. More...
 
uint8_t mlme_scan_conf_tag::ResultListSize
 The number of elements returned in the appropriate result lists. More...
 
uint32_t mlme_rx_enable_req_tag::RxOnDuration
 The number of symbols for which the receiver is to be enabled. More...
 
uint32_t mlme_rx_enable_req_tag::RxOnTime
 The number of symbols from the start of the superframe before the receiver is to be enabled. More...
 
scan_result_list_t mlme_scan_conf_tag::scan_result_list [1]
 ResultListSize - The number of elements returned in the appropriate result lists. More...
 
uint32_t mlme_scan_req_tag::ScanChannels
 The 5 MSBs (b27, ... More...
 
uint8_t mlme_scan_req_tag::ScanDuration
 A value used to calculate the length of time to spend scanning each channel for ED, active, and passive scans. More...
 
uint8_t mlme_scan_req_tag::ScanType
 Indicates the type of scan performed: 0 x 00 = ED scan (FFD only). More...
 
uint8_t mlme_scan_conf_tag::ScanType
 ScanType Integer 0 x 00 0 x 03 Indicates if the type of scan performed: 0 x 00 = ED scan (FFD only). More...
 
uint8_t * mlme_beacon_notify_ind_tag::sdu
 The set of octets comprising the beacon payload to be transferred from the MAC sublayerentity to the next higher layer. More...
 
uint8_t mlme_beacon_notify_ind_tag::sduLength
 The number of octets contained in the beacon payload of the beacon frame received by the MAC sublayer. More...
 
uint8_t mlme_reset_req_tag::SetDefaultPIB
 If TRUE, the MAC sublayer is reset and all MAC PIB attributes are set to their default values. More...
 
uint16_t mlme_orphan_resp_tag::ShortAddress
 The short address allocated to the orphaned device if it is associated with this coordinator. More...
 
uint64_t mcps_data_ind_tag::SrcAddr
 The individual device address of the entity from which the MSDU was received. More...
 
uint64_t mlme_comm_status_ind_tag::SrcAddr
 The source addressing mode for this primitive. More...
 
uint8_t mcps_data_ind_tag::SrcAddrMode
 The source addressing mode for this primitive corresponding to the received MPDU. More...
 
uint8_t mcps_data_req_tag::SrcAddrMode
 The source addressing mode for this primitive and subsequent MPDU. More...
 
uint8_t mlme_comm_status_ind_tag::SrcAddrMode
 The source addressing mode for this primitive. More...
 
uint16_t mcps_data_ind_tag::SrcPANId
 The 16 bit PAN identifier of the entity from which the MSDU was received. More...
 
uint8_t mcps_data_conf_tag::status
 The status of the last MSDU transmission. More...
 
uint8_t mcps_purge_conf_tag::status
 The status of the request to be purged an MSDU from the transaction queue. More...
 
uint8_t mlme_associate_resp_tag::status
 The status of the association attempt. More...
 
uint8_t mlme_associate_conf_tag::status
 The status of the association attempt. More...
 
uint8_t mlme_disassociate_conf_tag::status
 The status of the disassociation attempt. More...
 
uint8_t mlme_reset_conf_tag::status
 The result of the reset operation. More...
 
uint8_t mlme_get_conf_tag::status
 The identifier of the MAC PIB attribute to get. More...
 
uint8_t mlme_rx_enable_conf_tag::status
 The result of the receiver enable request. More...
 
uint8_t mlme_scan_conf_tag::status
 The status of the scan request. More...
 
uint8_t mlme_comm_status_ind_tag::status
 The communications status. More...
 
uint8_t mlme_start_conf_tag::status
 The result of the attempt to start using an updated superframe configuration. More...
 
uint8_t mlme_poll_conf_tag::status
 The status of the data request. More...
 
uint8_t mlme_start_req_tag::SuperframeOrder
 The length of the active portion of the superframe, including the beacon frame. More...
 
bool mlme_sync_req_tag::TrackBeacon
 TRUE if the MLME is to synchronize with the next beacon and attempt to track all future beacons. More...
 
uint8_t mlme_disassociate_req_tag::TxIndirect
 TRUE if the disassociation notification command is to be sent indirectly. More...
 
uint8_t mcps_data_req_tag::TxOptions
 The transmission options for this MSDU. More...
 
uint32_t mlme_scan_conf_tag::UnscannedChannels
 Indicates which channels given in the request were not scanned (1 = not scanned, 0 = scanned or not requested). More...
 
wpan_pandescriptor_t scan_result_list_t::wpan_pan_desc
 

This is the MCPS-DATA.confirm message structure.

This is the MCPS-DATA.indication message structure.

This is the MCPS-DATA.request message structure.

This is the MCPS-PURGE.confirm message structure.

This is the MCPS-PURGE.request message structure.

This is the MLME-ASSOCIATE.confirm message structure.

This is the MLME-ASSOCIATE.indication message structure.

This is the MLME-ASSOCIATE.request message structure.

This is the MLME-ASSOCIATE.response message structure.

This is the MLME-BEACON-NOTIFY.indication message structure.

This is the MLME-COMM-STATUS.indication message structure.

This is the MLME-DISASSOCIATE.confirm message structure.

This is the MLME-DISASSOCIATE.indication message structure.

This is the MLME-DISASSOCIATE.request message structure.

This is the MLME-GET.confirm message structure.

This is the MLME-GET.request message structure.

This is the MLME-ORPHAN.indication message structure.

This is the MLME-ORPHAN.response message structure.

This is the MLME-POLL.confirm message structure.

This is the MLME-POLL.request message structure.

This is the MLME-RESET.confirm message structure.

This is the MLME-RESET.request message structure.

This is the MLME-RX-ENABLE.confirm message structure.

This is the MLME-RX-ENABLE.request message structure.

This is the MLME-SCAN.confirm message structure.

This is the MLME-SCAN.request message structure.

This is the MLME-START.confirm message structure.

This is the MLME-START.request message structure.

This is the MLME-SYNC-LOSS.indication message structure.

This is the MLME-SYNC.request message structure.

Device address specification structure.

PAN descriptor information structure.

uint8_t mac_get_pib_attribute_size ( uint8_t  pib_attribute_id)

uint8_t* mlme_beacon_notify_ind_tag::AddrList

The list of addresses of the devices for which the beacon source has data.

uint8_t mlme_orphan_resp_tag::AssociatedMember

TRUE if the orphaned device is associated with this coordinator or FALSE otherwise.

uint16_t mlme_associate_resp_tag::AssocShortAddress

The short device address allocated by the coordinator on successful association.

This parameter is set to 0xffff if the association was unsuccessful.

uint16_t mlme_associate_conf_tag::AssocShortAddress

The short device address allocated by the coordinator on successful association.

This parameter will be equal to 0 x ffff if the association attempt was unsuccessful.

uint8_t mlme_start_req_tag::BatteryLifeExtension

If this value is TRUE, the receiver of the beaconing device is disabled macBattLifeExtPeriods full backoff periods after the interframe spacing (IFS) period of the beacon frame.

If this value is FALSE, the receiver of the beaconing device remains enabled for the entire CAP.

uint8_t mlme_start_req_tag::BeaconOrder

How often the beacon is to be transmitted.

The beacon order, BO, and the beacon interval, BI, are related as follows: for 0 d BO d 14, BI = BaseSuperframeDuration * 2^BO symbols. If BO = 15, the coordinator will not transmit a beacon, and the SuperframeOrder parameter value is ignored.

uint8_t mlme_beacon_notify_ind_tag::BSN

The beacon sequence number.

uint8_t mlme_associate_req_tag::CapabilityInformation

Specifies the operational capabilities of the associating device.

uint8_t mlme_associate_ind_tag::CapabilityInformation

The operational capabilities of the device requesting association.

uint8_t mlme_associate_req_tag::ChannelPage

The channel page on which to attempt association.

uint8_t mlme_scan_req_tag::ChannelPage

The channel page on which to perform the scan.

uint8_t mlme_scan_conf_tag::ChannelPage

The channel page on which the scan was performed.

uint8_t mlme_start_req_tag::ChannelPage

The channel page on which to begin using the new superframe configuration.

uint8_t mlme_sync_req_tag::ChannelPage

The channel page on which to attempt coordinator synchronization.

uint8_t mlme_sync_loss_ind_tag::ChannelPage

The channel page on which the device lost synchronization or to which it was realigned.

enum msg_code mcps_data_req_tag::cmdcode

< This identifies the message as MCPS_DATA_REQUEST

enum msg_code mcps_data_conf_tag::cmdcode

< This identifies the message as MCPS_DATA_CONFIRM

enum msg_code mcps_data_ind_tag::cmdcode

< This identifies the message as MCPS_DATA_INDICATION

enum msg_code mcps_purge_req_tag::cmdcode

< This identifies the message as MCPS_PURGE_REQUEST

enum msg_code mcps_purge_conf_tag::cmdcode

< This identifies the message as MCPS_PURGE_CONFIRM

enum msg_code mlme_associate_req_tag::cmdcode

< This identifies the message as MLME_ASSOCIATE_REQUEST

enum msg_code mlme_associate_ind_tag::cmdcode

This identifies the message as MLME_ASSOCIATE_INDICATION.

enum msg_code mlme_associate_resp_tag::cmdcode

This identifies the message as MLME_ASSOCIATE_RESPONSE.

enum msg_code mlme_associate_conf_tag::cmdcode

This identifies the message as MLME_ASSOCIATE_CONFIRM.

enum msg_code mlme_disassociate_req_tag::cmdcode

This identifies the message as MLME_DISASSOCIATE_REQUEST.

enum msg_code mlme_disassociate_ind_tag::cmdcode

This identifies the message as MLME_DISASSOCIATE_INDICATION.

enum msg_code mlme_disassociate_conf_tag::cmdcode

This identifies the message as MLME_DISASSOCIATE_CONFIRM.

enum msg_code mlme_beacon_notify_ind_tag::cmdcode

This identifies the message as MLME_BEACON_NOTIFY_INDICATION.

enum msg_code mlme_orphan_ind_tag::cmdcode

This identifies the message as MLME_ORPHAN_INDICATION.

enum msg_code mlme_orphan_resp_tag::cmdcode

This identifies the message as MLME_ORPHAN_RESPONSE.

enum msg_code mlme_reset_req_tag::cmdcode

< This identifies the message as MLME_RESET_REQUEST

enum msg_code mlme_reset_conf_tag::cmdcode

< This identifies the message as MLME_RESET_CONFIRM

enum msg_code mlme_get_req_tag::cmdcode

< This identifies the message as MLME_GET_REQUEST

The identifier of the MAC PIB attribute to get.

enum msg_code mlme_get_conf_tag::cmdcode

< This identifies the message as MLME_GET_CONFIRM

The result of the request for PHY PIB attribute information.

enum msg_code mlme_rx_enable_req_tag::cmdcode

This identifies the message as MLME_RX_ENABLE_REQUEST.

enum msg_code mlme_rx_enable_conf_tag::cmdcode

This identifies the message as MLME_RX_ENABLE_CONFIRM.

enum msg_code mlme_scan_req_tag::cmdcode

This identifies the message as MLME_SCAN_REQUEST.

enum msg_code mlme_scan_conf_tag::cmdcode

This identifies the message as MLME_SCAN_CONFIRM.

enum msg_code mlme_comm_status_ind_tag::cmdcode

This identifies the message as MLME_COMM_STATUS_INDICATION.

enum msg_code mlme_start_req_tag::cmdcode

This identifies the message as MLME_START_REQUEST.

enum msg_code mlme_start_conf_tag::cmdcode

This identifies the message as MLME_START_CONFIRM.

enum msg_code mlme_sync_req_tag::cmdcode

This identifies the message as MLME_SYNC_REQUEST.

enum msg_code mlme_sync_loss_ind_tag::cmdcode

This identifies the message as MLME_SYNC_LOSS_INDICATION.

enum msg_code mlme_poll_req_tag::cmdcode

This identifies the message as MLME_POLL_REQUEST.

enum msg_code mlme_poll_conf_tag::cmdcode

This identifies the message as MLME_POLL_CONFIRM.

address_field_t mlme_associate_req_tag::CoordAddress

The address of the coordinator with which to associate.

uint64_t mlme_poll_req_tag::CoordAddress

The address of the coordinator to which the poll is intended.

The address of the coordinator to which the poll is intended.

uint8_t mlme_associate_req_tag::CoordAddrMode

The coordinator addressing mode for this primitive and subsequent MPDU.

This value can take one of the following values: 2 = 16 bit short address. 3 = 64 bit extended address.

uint8_t mlme_poll_req_tag::CoordAddrMode

The addressing mode of the coordinator to which the poll is intended.

This parameter can take one of the following values: 2 = 16 bit short address, 3 = 64 bit extended address.

uint16_t mlme_associate_req_tag::CoordPANId

The identifier of the PAN with which to associate.

uint16_t mlme_poll_req_tag::CoordPANId

The PAN identifier of the coordinator to which the poll is intended.

uint8_t mlme_start_req_tag::CoordRealignment

TRUE if a coordinator realignment command is to be transmitted prior to changing the superframe configuration or FALSE otherwise.

uint8_t mlme_rx_enable_req_tag::DeferPermit

TRUE if the receiver enable can be deferred until during the next superframe if the requested time has already passed.

FALSE if the receiver enable is only to be attempted in the current superframe. This parameter is ignored for nonbeacon-enabled PANs.

uint64_t mlme_associate_ind_tag::DeviceAddress

The address of the device requesting association.

uint64_t mlme_associate_resp_tag::DeviceAddress

The address of the device requesting association.

uint64_t mlme_disassociate_req_tag::DeviceAddress

The address of the device to which to send the disassociation notification command.

uint64_t mlme_disassociate_ind_tag::DeviceAddress

The address of the device requesting disassociation.

uint64_t mlme_disassociate_conf_tag::DeviceAddress

The address of the device that has either requested disassociation or been instructed to disassociate by its coordinator.

uint8_t mlme_disassociate_req_tag::DeviceAddrMode

The addressing mode of the device to which to send the disassociation notification command.

uint8_t mlme_disassociate_conf_tag::DeviceAddrMode

The addressing mode of the device that has either requested disassociation or been instructed to disassociate by its coordinator.

uint16_t mlme_disassociate_req_tag::DevicePANId

The PAN identifier of the device to which to send the disassociation notification command.

uint16_t mlme_disassociate_conf_tag::DevicePANId

The PAN identifier of the device that has either requested disassociation or been instructed to disassociate by its coordinator.

uint8_t mlme_disassociate_req_tag::DisassociateReason

The reason for the disassociation (see 7.3.1.3.2).

uint8_t mlme_disassociate_ind_tag::DisassociateReason

The reason for the disassociation (see 7.3.1.3.2).

uint8_t mcps_data_ind_tag::DSN

The DSN of the received data frame.

uint64_t mcps_data_req_tag::DstAddr

The individual device address of the entity to which the MSDU is being transferred.

uint64_t mcps_data_ind_tag::DstAddr

The individual device address of the entity to which the MSDU is being transferred.

uint64_t mlme_comm_status_ind_tag::DstAddr

The individual device address of the device for which the frame was intended.

uint8_t mcps_data_req_tag::DstAddrMode

The destination addressing mode for this primitive and subsequent MPDU.

This value can take one of the following values: 0 x 00 = no address (addressing fields omitted). 0 x 01 = reserved. 0 x 02 = 16 bit short address. 0 x 03 = 64 bit extended address.

uint8_t mcps_data_ind_tag::DstAddrMode

The destination addressing mode for this primitive corresponding to the received MPDU.

This value can take one of the following values: 0 x 00 = no address (addressing fields omitted). 0 x 01 = reserved. 0 x 02 = 16 bit short device address. 0 x 03 = 64 bit extended device address.

uint8_t mlme_comm_status_ind_tag::DstAddrMode

The destination addressing mode for this primitive.

This value can take one of the following values: 0 x 00 = no address (addressing fields omitted). 0 x 01 = reserved. 0 x 02 = 16 bit short address. 0 x 03 = 64 bit extended address.

uint16_t mcps_data_req_tag::DstPANId

The 16 bit PAN identifier of the entity to which the MSDU is being transferred.

uint16_t mcps_data_ind_tag::DstPANId

The 16 bit PAN identifier of the entity to which the MSDU is being transferred.

uint8_t scan_result_list_t::ed_value[1]
uint8_t mlme_associate_req_tag::LogicalChannel

The logical channel on which to attempt association.

uint8_t mlme_start_req_tag::LogicalChannel

The logical channel on which to start using the new superframe configuration.

uint8_t mlme_sync_req_tag::LogicalChannel

The logical channel on which to attempt coordinator synchronization.

uint8_t mlme_sync_loss_ind_tag::LogicalChannel

The logical channel on which the device lost synchronization or to which it was realigned.

uint8_t mlme_sync_loss_ind_tag::LossReason

The reason that synchronization was lost.

uint8_t mcps_data_ind_tag::mpduLinkQuality

LQI value measured during reception of the MPDU.

Lower values represent lower LQI (see 6.7.8).

uint8_t* mcps_data_req_tag::msdu

The set of octets forming the MSDU to be transmitted by the MAC sublayer entity.

uint8_t* mcps_data_ind_tag::msdu

The set of octets forming the MSDU being indicated by the MAC sublayer entity.

uint8_t mcps_data_req_tag::msduHandle

The handle associated with the MSDU to be transmitted by the MAC sublayer entity.

uint8_t mcps_data_conf_tag::msduHandle

The handle associated with the MSDU being confirmed.

uint8_t mcps_purge_req_tag::msduHandle

The handle of the MSDU to be purged from the transaction queue.

uint8_t mcps_purge_conf_tag::msduHandle

The handle of the MSDU requested to be purge from the transaction queue.

uint8_t mcps_data_req_tag::msduLength

The number of octets contained in the MSDU to be transmitted by the MAC sublayer entity.

uint8_t mcps_data_ind_tag::msduLength

The number of octets contained in the MSDU being indicated by the MAC sublayer entity.

uint64_t mlme_orphan_ind_tag::OrphanAddress

The address of the orphaned device.

uint64_t mlme_orphan_resp_tag::OrphanAddress

The address of the orphaned device.

uint8_t mlme_start_req_tag::PANCoordinator

If this value is TRUE, the device will become the PAN coordinator of a new PAN.

If this value is FALSE, the device will begin transmitting beacons on the PAN with which it is associated.

wpan_pandescriptor_t mlme_beacon_notify_ind_tag::PANDescriptor

The PANDescriptor for the received beacon.

uint16_t mlme_comm_status_ind_tag::PANId

The 16 bit PAN identifier of the device from which the frame was received or to which the frame was being sent.

uint16_t mlme_start_req_tag::PANId

The PAN identifier to be used by the device.

uint16_t mlme_sync_loss_ind_tag::PANId

The PAN identifier with which the device lost synchronization or to which it was realigned.

uint8_t mlme_beacon_notify_ind_tag::PendAddrSpec

The beacon pending address specification.

uint8_t mlme_get_req_tag::PIBAttribute
uint8_t mlme_get_conf_tag::PIBAttribute
pib_value_t mlme_get_conf_tag::PIBAttributeValue

< The value of the indicated MAC PIB attribute that was read.

uint8_t mlme_scan_conf_tag::ResultListSize

The number of elements returned in the appropriate result lists.

This value is 0 for the result of an orphan scan.

uint32_t mlme_rx_enable_req_tag::RxOnDuration

The number of symbols for which the receiver is to be enabled.

uint32_t mlme_rx_enable_req_tag::RxOnTime

The number of symbols from the start of the superframe before the receiver is to be enabled.

The precision of this value is a minimum of 20 bits, with the lowest 4 bits being the least significant. This parameter is ignored for nonbeacon-enabled PANs.

scan_result_list_t mlme_scan_conf_tag::scan_result_list[1]

ResultListSize - The number of elements returned in the appropriate result lists.

This value is 0 for the result of an orphan scan. EnergyDetectList - The number of elements returned in the appropriate result lists. This value is 0 for the result of an orphan scan. PANDescriptorList - The list of PAN descriptors, one for each beacon found during an active or passive scan. This parameter is null for ED and orphan scans.

uint32_t mlme_scan_req_tag::ScanChannels

The 5 MSBs (b27, ...

, b31) are reserved. The 27 LSBs (b0, b1, ... b26) indicate which channels are to be scanned (1 = scan, 0 = do not scan) for each of the 27 valid channels (see 6.1.2).

uint8_t mlme_scan_req_tag::ScanDuration

A value used to calculate the length of time to spend scanning each channel for ED, active, and passive scans.

This parameter is ignored for orphan scans. The time spent scanning each channel is [aBaseSuperframeDuration * (2n + 1)] symbols, where n is the value of the ScanDuration parameter.

uint8_t mlme_scan_req_tag::ScanType

Indicates the type of scan performed: 0 x 00 = ED scan (FFD only).

0 x 01 = active scan (FFD only). 0 x 02 = passive scan. 0 x 03 = orphan scan.

uint8_t mlme_scan_conf_tag::ScanType

ScanType Integer 0 x 00 0 x 03 Indicates if the type of scan performed: 0 x 00 = ED scan (FFD only).

0 x 01 = active scan (FFD only). 0 x 02 = passive scan. 0 x 03 = orphan scan.

uint8_t* mlme_beacon_notify_ind_tag::sdu

The set of octets comprising the beacon payload to be transferred from the MAC sublayerentity to the next higher layer.

uint8_t mlme_beacon_notify_ind_tag::sduLength

The number of octets contained in the beacon payload of the beacon frame received by the MAC sublayer.

uint8_t mlme_reset_req_tag::SetDefaultPIB

If TRUE, the MAC sublayer is reset and all MAC PIB attributes are set to their default values.

If FALSE, the MAC sublayer is reset but all MAC PIB attributes retain their values prior to the generation of the MLME-RESET.request primitive.

uint16_t mlme_orphan_resp_tag::ShortAddress

The short address allocated to the orphaned device if it is associated with this coordinator.

The special short address 0 x fffe indicates that no short address was allocated, and the device will use its 64 bit extended address in all communications. If the device was not associated with thiscoordinator, this field will contain the value 0 x ffff and be ignored on receipt.

uint64_t mcps_data_ind_tag::SrcAddr

The individual device address of the entity from which the MSDU was received.

uint64_t mlme_comm_status_ind_tag::SrcAddr

The source addressing mode for this primitive.

This value can take one of the following values: 0 = no address (addressing fields omitted). 0 x 01 = reserved. 0 x 02 = 16 bit short address. 0 x 03 = 64 bit extended address.

uint8_t mcps_data_ind_tag::SrcAddrMode

The source addressing mode for this primitive corresponding to the received MPDU.

This value can take one of the following values: 0 x 00 = no address (addressing fields omitted). 0 x 01 = reserved. 0 x 02 = 16 bit short address. 0 x 03 = 64 bit extended address.

uint8_t mcps_data_req_tag::SrcAddrMode

The source addressing mode for this primitive and subsequent MPDU.

This value can take one of the following values: 0 x 00 = no address (addressingfields omitted). 0 x 01 = reserved. 0 x 02 = 16 bit short address. 0 x 03 = 64 bit extended address.

uint8_t mlme_comm_status_ind_tag::SrcAddrMode

The source addressing mode for this primitive.

This value can take one of the following values: 0 = no address (addressing fields omitted). 0 x 01 = reserved. 0 x 02 = 16 bit short address. 0 x 03 = 64 bit extended address.

uint16_t mcps_data_ind_tag::SrcPANId

The 16 bit PAN identifier of the entity from which the MSDU was received.

uint8_t mcps_data_conf_tag::status

The status of the last MSDU transmission.

uint8_t mcps_purge_conf_tag::status

The status of the request to be purged an MSDU from the transaction queue.

uint8_t mlme_associate_resp_tag::status

The status of the association attempt.

uint8_t mlme_associate_conf_tag::status

The status of the association attempt.

uint8_t mlme_disassociate_conf_tag::status

The status of the disassociation attempt.

uint8_t mlme_reset_conf_tag::status

The result of the reset operation.

uint8_t mlme_get_conf_tag::status

The identifier of the MAC PIB attribute to get.

uint8_t mlme_rx_enable_conf_tag::status

The result of the receiver enable request.

uint8_t mlme_scan_conf_tag::status

The status of the scan request.

uint8_t mlme_comm_status_ind_tag::status

The communications status.

uint8_t mlme_start_conf_tag::status

The result of the attempt to start using an updated superframe configuration.

uint8_t mlme_poll_conf_tag::status

The status of the data request.

uint8_t mlme_start_req_tag::SuperframeOrder

The length of the active portion of the superframe, including the beacon frame.

The superframe order, SO, and the superframe duration, SD, are related as follows: for 0 d SO d BO d 14, SD = aBaseSuperframeDuration * 2^SO symbols. If SO = 15, the superframe will not be active after the beacon.

bool mlme_sync_req_tag::TrackBeacon

TRUE if the MLME is to synchronize with the next beacon and attempt to track all future beacons.

FALSE if the MLME is to synchronize with only the next beacon.

uint8_t mlme_disassociate_req_tag::TxIndirect

TRUE if the disassociation notification command is to be sent indirectly.

uint8_t mcps_data_req_tag::TxOptions

The transmission options for this MSDU.

These are a bitwise OR of one or more of the following: 0 x 01 = acknowledged transmission. 0 x 04 = indirect transmission.

uint32_t mlme_scan_conf_tag::UnscannedChannels

Indicates which channels given in the request were not scanned (1 = not scanned, 0 = scanned or not requested).

This parameter is only valid for passive or active scans.

wpan_pandescriptor_t scan_result_list_t::wpan_pan_desc