All Definitions used by the MAC Layer is described here.

Modules
	MAC Data Structures
	This module defines all the MAC Data Structures.

Macros
#define	BO_USED_FOR_MAC_PERS_TIME (0)

#define	FINAL_CAP_SLOT_DEFAULT (0x0F)

#define	LAST_MESSAGE MLME_POLL_CONFIRM
	Bump this when extending the list! More...

#define	MAC (4)

#define	MAC_NHLE_QUEUE_CAPACITY 255
	Capacity of queue between MAC and Next Higher Layer. More...

#define	macAckWaitDuration_def (tal_pib.CurrentPage == 0 ? 120 : 54)
	Default value for MIB macAckWaitDuration. More...

#define	macMaxFrameTotalWaitTime_def (2784)

#define	MCPS_DATA_CON_LEN (7 - 4)
	The following defines describe the minimum length of a primitive message. More...

#define	MCPS_DATA_IND_LEN (31 - 4)

#define	MCPS_PURGE_CONF_LEN (3)

#define	MLME_ASSOCIATE_CONF_LEN (4)

#define	MLME_ASSOCIATE_IND_LEN (10)

#define	MLME_BEACON_NOTIFY_IND_LEN (2)

#define	MLME_COMM_STATUS_IND_LEN (22)

#define	MLME_DISASSOCIATE_CONF_LEN (13)

#define	MLME_DISASSOCIATE_IND_LEN (10)

#define	MLME_GET_CONF_LEN (4)

#define	MLME_GTS_CONF_LEN (3)

#define	MLME_GTS_IND_LEN (4)

#define	MLME_ORPHAN_IND_LEN (9)

#define	MLME_POLL_CONF_LEN (2)

#define	MLME_RESET_CONF_LEN (2)

#define	MLME_RX_ENABLE_CONF_LEN (2)

#define	MLME_SCAN_CONF_LEN (10)

#define	MLME_SET_CONF_LEN (3)

#define	MLME_START_CONF_LEN (2)

#define	MLME_SYNC_LOSS_IND_LEN (6)

#define	NUMBER_OF_MAC_BEACON_SUPPORT_TIMERS (0)

#define	NUMBER_OF_MAC_INDIRECT_DATA_SUPPORT_TIMERS (0)

#define	NUMBER_OF_MAC_RX_ENABLE_SUPPORT_TIMERS (1)

#define	NUMBER_OF_MAC_SCAN_SUPPORT_TIMERS (1)

#define	NUMBER_OF_MAC_TIMERS

#define	WPAN_ADDRMODE_LONG (0x03)
	Value for the address mode, where a 64 bit long address is given. More...

#define	WPAN_ADDRMODE_NONE (0x00)
	Value for the address mode, where no address is given. More...

#define	WPAN_ADDRMODE_SHORT (0x02)
	Value for the address mode, where a 16 bit short address is given. More...

#define	WPAN_CAP_ALLOCADDRESS (0x80)
	Flag value for capability information field (see wpan_mlme_associate_req()). More...

#define	WPAN_CAP_ALTPANCOORD (0x01)
	Flag value for capability information field (see wpan_mlme_associate_req()). More...

#define	WPAN_CAP_FFD (0x02)
	Flag value for capability information field (see wpan_mlme_associate_req()). More...

#define	WPAN_CAP_PWRSOURCE (0x04)
	Flag value for capability information field (see wpan_mlme_associate_req()). More...

#define	WPAN_CAP_RXONWHENIDLE (0x08)
	Flag value for capability information field (see wpan_mlme_associate_req()). More...

#define	WPAN_DESCRIPTOR_LEN (21 - 4)

#define	WPAN_DISASSOC_BYCHILD (0x02)
	Symbolic constant for disassociate reason - initiated by child (see wpan_mlme_disassociate_req()) More...

#define	WPAN_DISASSOC_BYPARENT (0x01)
	Symbolic constant for disassociate reason - initiated by parent (see wpan_mlme_disassociate_req()) More...

#define	WPAN_NUM_EXTENDED_ADDR_PENDING(x) (((x) >> 4) & 0x7)
	Macro to extract size of extended address list in PAN descriptor. More...

#define	WPAN_NUM_SHORT_ADDR_PENDING(x) ((x) & 0x7)
	Marco to extract size of short address list in PAN descriptor. More...

Typedefs
typedef void(*	handler_t )(uint8_t *)

typedef enum mac_poll_state_tag	mac_poll_state_t
	MAC poll states. More...

typedef enum mac_radio_sleep_state_tag	mac_radio_sleep_state_t
	MAC sleep state type. More...

typedef enum mac_scan_state_tag	mac_scan_state_t
	Device or coordinator scan states. More...

typedef __PACK__DATA__ enum mac_state_tag	mac_state_t
	MAC state type. More...

typedef enum mac_superframe_state_tag	mac_superframe_state_t
	MAC state type. More...

typedef enum mac_sync_state_tag	mac_sync_state_t
	Device or coordinator sync states. More...

Enumerations
enum	mac_poll_state_tag { MAC_POLL_IDLE = 0, MAC_AWAIT_ASSOC_RESPONSE, MAC_POLL_EXPLICIT, MAC_POLL_IMPLICIT }
	MAC poll states. More...

enum	mac_radio_sleep_state_tag { RADIO_AWAKE = 0, RADIO_SLEEPING }
	MAC sleep state type. More...

enum	mac_scan_state_tag { MAC_SCAN_IDLE = 0, MAC_SCAN_ED, MAC_SCAN_ACTIVE, MAC_SCAN_ORPHAN, MAC_SCAN_PASSIVE }
	Device or coordinator scan states. More...

enum	mac_state_tag { MAC_IDLE = 0, MAC_ASSOCIATED = 1, MAC_COORDINATOR = 2, MAC_PAN_COORD_STARTED = 3 }
	MAC state type. More...

enum	mac_superframe_state_tag { MAC_ACTIVE_CAP = 0, MAC_INACTIVE, MAC_NOBEACON }
	MAC state type. More...

enum	mac_sync_state_tag { MAC_SYNC_NEVER = 0, MAC_SYNC_ONCE, MAC_SYNC_TRACKING_BEACON, MAC_SYNC_BEFORE_ASSOC }
	Device or coordinator sync states. More...

enum	msg_code { TAL_DATA_INDICATION = (0x00), MLME_ASSOCIATE_REQUEST = (0x01), MLME_ASSOCIATE_RESPONSE = (0x02), MCPS_DATA_REQUEST = (0x03), MCPS_PURGE_REQUEST = (0x04), MLME_DISASSOCIATE_REQUEST = (0x05), MLME_ORPHAN_RESPONSE = (0x07), MLME_GET_REQUEST = (0x08), MLME_RESET_REQUEST = (0x09), MLME_RX_ENABLE_REQUEST = (0x0A), MLME_SCAN_REQUEST = (0x0B), MLME_GTS_REQUEST = (0x0C), MLME_START_REQUEST = (0x0D), MLME_POLL_REQUEST = (0x0E), MLME_SYNC_REQUEST = (0x0F), MCPS_DATA_CONFIRM = (0x10), MCPS_DATA_INDICATION = (0x11), MCPS_PURGE_CONFIRM = (0x12), MLME_ASSOCIATE_INDICATION = (0x13), MLME_ASSOCIATE_CONFIRM = (0x14), MLME_DISASSOCIATE_INDICATION = (0x15), MLME_DISASSOCIATE_CONFIRM = (0x16), MLME_BEACON_NOTIFY_INDICATION = (0x17), MLME_GTS_CONFIRM = (0x18), MLME_GTS_INDICATION = (0x19), MLME_ORPHAN_INDICATION = (0x1A), MLME_SCAN_CONFIRM = (0x1B), MLME_COMM_STATUS_INDICATION = (0x1C), MLME_SYNC_LOSS_INDICATION = (0x1D), MLME_GET_CONFIRM = (0x1E), MLME_RESET_CONFIRM = (0x20), MLME_RX_ENABLE_CONFIRM = (0x21), MLME_START_CONFIRM = (0x22), MLME_POLL_CONFIRM = (0x23), MAC_INC_FRAME = (0x24) }
	This type contains the service primitives of the PHY-, MAC- and Network-layer as well the command-interface primitives. More...

Functions
retval_t	mac_timers_init (void)

retval_t	mac_timers_stop (void)

retval_t	wpan_init (void)
	The stack initialization function. More...

bool	wpan_mcps_data_req (uint8_t SrcAddrMode, wpan_addr_spec_t DstAddrSpec, uint8_t msduLength, uint8_t msdu, uint8_t msduHandle, uint8_t TxOptions)
	Initiate MCPS-DATA.request service and have it placed in the MCPS-SAP queue. More...

bool	wpan_mcps_purge_req (const uint8_t msduHandle)
	Initiate MCPS-PURGE.request service and have it placed in the MCPS-SAP queue. More...

bool	wpan_mlme_associate_req (uint8_t LogicalChannel, uint8_t ChannelPage, wpan_addr_spec_t *CoordAddrSpec, uint8_t CapabilityInformation)
	Initiate MLME-ASSOCIATE.request service and have it placed in the MLME-SAP queue. More...

bool	wpan_mlme_associate_resp (uint64_t DeviceAddress, uint16_t AssocShortAddress, uint8_t status)
	Initiate MLME-ASSOCIATE.response service and place it in the MLME-SAP queue. More...

bool	wpan_mlme_disassociate_req (wpan_addr_spec_t *DeviceAddrSpec, uint8_t DisassociateReason, bool TxIndirect)
	Inititate MLME-DISASSOCIATE.request service and have it placed in the MLME-SAP queue. More...

bool	wpan_mlme_get_req (uint8_t PIBAttribute)
	Initiate MLME-GET.request service and have it placed in the MLME-SAP queue. More...

bool	wpan_mlme_gts_req (uint16_t DevShortAddr, gts_char_t GtsChar)

bool	wpan_mlme_orphan_resp (uint64_t OrphanAddress, uint16_t ShortAddress, bool AssociatedMember)
	Initiate MLME-ORPHAN.response service and have it placed in MLME_SAP queue. More...

bool	wpan_mlme_poll_req (wpan_addr_spec_t *CoordAddrSpec)
	Initiate MLME-POLL.request service and have it placed in the MLME-SAP queue. More...

bool	wpan_mlme_reset_req (bool SetDefaultPib)
	Initiate MLME-RESET.request service and have it placed in the MLME-SAP queue. More...

bool	wpan_mlme_rx_enable_req (bool DeferPermit, uint32_t RxOnTime, uint32_t RxOnDuration)
	Initiate MLME-RX-ENABLE.request service and have it placed in the MLME-SAP queue. More...

bool	wpan_mlme_scan_req (uint8_t ScanType, uint32_t ScanChannels, uint8_t ScanDuration, uint8_t ChannelPage)
	Initiate MLME-SCAN.request service and have it placed in the MLME-SAP queue. More...

bool	wpan_mlme_set_req (uint8_t PIBAttribute, void *PIBAttributeValue)
	Initiate MLME-SET.request service and have it placed in MLME_SAP queue. More...

bool	wpan_mlme_start_req (uint16_t PANId, uint8_t LogicalChannel, uint8_t ChannelPage, uint8_t BeaconOrder, uint8_t SuperframeOrder, bool PANCoordinator, bool BatteryLifeExtension, bool CoordRealignment)
	Initiate MLME-START service and have it placed in the MLME-SAP queue. More...

bool	wpan_mlme_sync_req (uint8_t LogicalChannel, uint8_t ChannelPage, bool TrackBeacon)
	Initiate MLME-SYNC.request service and have it placed in the MLME-SAP queue. More...

bool	wpan_task (void)
	The stack task function called by the application. More...

Variables
enum msg_code	SHORTENUM

uint8_t	T_Rx_Enable

uint8_t	T_Scan_Duration

#define BO_USED_FOR_MAC_PERS_TIME (0)

Referenced by process_data_ind_not_transient().

#define FINAL_CAP_SLOT_DEFAULT (0x0F)

Referenced by mac_build_and_tx_beacon(), process_data_ind_not_transient(), and reset_globals().

#define LAST_MESSAGE MLME_POLL_CONFIRM

Bump this when extending the list!

Referenced by dispatch_event().

#define MAC (4)

#define MAC_NHLE_QUEUE_CAPACITY 255

Capacity of queue between MAC and Next Higher Layer.

#define macAckWaitDuration_def (tal_pib.CurrentPage == 0 ? 120 : 54)

Default value for MIB macAckWaitDuration.

The default value for this PIB attribute depends on the current channel page (i.e. the modulation scheme: BPSK or O-QPSK).

#define macMaxFrameTotalWaitTime_def (2784)

Referenced by do_init_pib().

#define MCPS_DATA_CON_LEN (7 - 4)

The following defines describe the minimum length of a primitive message.

#define MCPS_DATA_IND_LEN (31 - 4)

#define MCPS_PURGE_CONF_LEN (3)

#define MLME_ASSOCIATE_CONF_LEN (4)

#define MLME_ASSOCIATE_IND_LEN (10)

#define MLME_BEACON_NOTIFY_IND_LEN (2)

#define MLME_COMM_STATUS_IND_LEN (22)

#define MLME_DISASSOCIATE_CONF_LEN (13)

#define MLME_DISASSOCIATE_IND_LEN (10)

#define MLME_GET_CONF_LEN (4)

#define MLME_GTS_CONF_LEN (3)

#define MLME_GTS_IND_LEN (4)

#define MLME_ORPHAN_IND_LEN (9)

#define MLME_POLL_CONF_LEN (2)

#define MLME_RESET_CONF_LEN (2)

#define MLME_RX_ENABLE_CONF_LEN (2)

#define MLME_SCAN_CONF_LEN (10)

#define MLME_SET_CONF_LEN (3)

#define MLME_START_CONF_LEN (2)

#define MLME_SYNC_LOSS_IND_LEN (6)

#define NUMBER_OF_MAC_BEACON_SUPPORT_TIMERS (0)

#define NUMBER_OF_MAC_INDIRECT_DATA_SUPPORT_TIMERS (0)

#define NUMBER_OF_MAC_RX_ENABLE_SUPPORT_TIMERS (1)

#define NUMBER_OF_MAC_SCAN_SUPPORT_TIMERS (1)

#define NUMBER_OF_MAC_TIMERS

Value:

(NUMBER_OF_MAC_BEACON_SUPPORT_TIMERS + \
	NUMBER_OF_MAC_INDIRECT_DATA_SUPPORT_TIMERS + \
	NUMBER_OF_MAC_SCAN_SUPPORT_TIMERS + \
	NUMBER_OF_MAC_RX_ENABLE_SUPPORT_TIMERS)

#define WPAN_ADDRMODE_LONG (0x03)

Value for the address mode, where a 64 bit long address is given.

(see wpan_addr_spec_t::AddrMode)

#define WPAN_ADDRMODE_NONE (0x00)

Value for the address mode, where no address is given.

(see wpan_addr_spec_t::AddrMode)

#define WPAN_ADDRMODE_SHORT (0x02)

Value for the address mode, where a 16 bit short address is given.

(see wpan_addr_spec_t::AddrMode)

Referenced by mac_process_beacon_frame().

#define WPAN_CAP_ALLOCADDRESS (0x80)

Flag value for capability information field (see wpan_mlme_associate_req()).

The allocate address subfield shall be set if the device wishes the coordinator to allocate a short address as a result of the association procedure. If this subfield is set to 0, the special short address of 0xfffe shall be allocated to the device and returned through the association response command. In this case, the device shall communicate on the PAN using only its 64 bit extended address.

#define WPAN_CAP_ALTPANCOORD (0x01)

Flag value for capability information field (see wpan_mlme_associate_req()).

The alternate PAN coordinator subfield shall be set if the device is capable of becoming a PAN coordinator. Otherwise, the alternate PAN coordinator subfield shall be set to 0.

#define WPAN_CAP_FFD (0x02)

Flag value for capability information field (see wpan_mlme_associate_req()).

The device type subfield shall be set if the device is an FFD. Otherwise, the device type subfield shall be set to 0 to indicate an RFD.

#define WPAN_CAP_PWRSOURCE (0x04)

Flag value for capability information field (see wpan_mlme_associate_req()).

The power source subfield shall be set if the device is receiving power from the alternating current mains. Otherwise, the power source subfield shall be set to 0.

#define WPAN_CAP_RXONWHENIDLE (0x08)

Flag value for capability information field (see wpan_mlme_associate_req()).

The receiver on when idle subfield shall be set if the device does not disable its receiver to conserve power during idle periods. Otherwise, the receiver on when idle subfield shall be set to 0.

#define WPAN_DESCRIPTOR_LEN (21 - 4)

#define WPAN_DISASSOC_BYCHILD (0x02)

Symbolic constant for disassociate reason - initiated by child (see wpan_mlme_disassociate_req())

#define WPAN_DISASSOC_BYPARENT (0x01)

Symbolic constant for disassociate reason - initiated by parent (see wpan_mlme_disassociate_req())

#define WPAN_NUM_EXTENDED_ADDR_PENDING ( x ) (((x) >> 4) & 0x7)

Macro to extract size of extended address list in PAN descriptor.

#define WPAN_NUM_SHORT_ADDR_PENDING ( x ) ((x) & 0x7)

Marco to extract size of short address list in PAN descriptor.

typedef void(* handler_t)(uint8_t *)

typedef enum mac_poll_state_tag mac_poll_state_t

MAC poll states.

These states describe the current status of the MAC for polling for devices or coordinators, not for PAN coordinator.

typedef enum mac_radio_sleep_state_tag mac_radio_sleep_state_t

MAC sleep state type.

typedef enum mac_scan_state_tag mac_scan_state_t

Device or coordinator scan states.

typedef __PACK__DATA__ enum mac_state_tag mac_state_t

MAC state type.

typedef enum mac_superframe_state_tag mac_superframe_state_t

MAC state type.

typedef enum mac_sync_state_tag mac_sync_state_t

Device or coordinator sync states.

enum mac_poll_state_tag

MAC poll states.

These states describe the current status of the MAC for polling for devices or coordinators, not for PAN coordinator.

Enumerator
MAC_POLL_IDLE	No polling ongoing.
MAC_AWAIT_ASSOC_RESPONSE	Successful transmission of association request frame, wait for Association response.
MAC_POLL_EXPLICIT	Explicit poll ongoing (MLME_POLL.request), Ack after Data request frame transmission received, awaiting data response.
MAC_POLL_IMPLICIT	Implicit poll ongoing (more pending data detected, either in beacon or data frame), awaiting data response,.

enum mac_radio_sleep_state_tag

MAC sleep state type.

Enumerator

RADIO_AWAKE

Radio is awake.

Radio is in sleep mode

RADIO_SLEEPING

enum mac_scan_state_tag

Device or coordinator scan states.

Enumerator
MAC_SCAN_IDLE	No scanning ongoing.
MAC_SCAN_ED	ED scan ongoing.
MAC_SCAN_ACTIVE	Active scan proceeding.
MAC_SCAN_ORPHAN	Orphan scan proceeding.
MAC_SCAN_PASSIVE	Passive scan proceeding.

enum mac_state_tag

MAC state type.

Enumerator
MAC_IDLE	Node is idle, i.e. it is neither associated nor has started its own network
MAC_ASSOCIATED
MAC_COORDINATOR	Coordinator successfully associated with PAN Coordinator and successfully started network with same PAN-Id (not as PAN Coordinator)
MAC_PAN_COORD_STARTED	PAN coordinator successfully started.

enum mac_superframe_state_tag

MAC state type.

Enumerator
MAC_ACTIVE_CAP
MAC_INACTIVE
MAC_NOBEACON

enum mac_sync_state_tag

Device or coordinator sync states.

Enumerator
MAC_SYNC_NEVER	Do not track beacons.
MAC_SYNC_ONCE	Track the next beacon.
MAC_SYNC_TRACKING_BEACON	Track beacons continuously.
MAC_SYNC_BEFORE_ASSOC	Track beacons continuously before beeing associated in order to obtain synchronization with desired network.

enum msg_code

This type contains the service primitives of the PHY-, MAC- and Network-layer as well the command-interface primitives.

Enumerator
TAL_DATA_INDICATION
MLME_ASSOCIATE_REQUEST
MLME_ASSOCIATE_RESPONSE
MCPS_DATA_REQUEST
MCPS_PURGE_REQUEST
MLME_DISASSOCIATE_REQUEST
MLME_ORPHAN_RESPONSE
MLME_GET_REQUEST
MLME_RESET_REQUEST
MLME_RX_ENABLE_REQUEST
MLME_SCAN_REQUEST
MLME_GTS_REQUEST
MLME_START_REQUEST
MLME_POLL_REQUEST
MLME_SYNC_REQUEST
MCPS_DATA_CONFIRM
MCPS_DATA_INDICATION
MCPS_PURGE_CONFIRM
MLME_ASSOCIATE_INDICATION
MLME_ASSOCIATE_CONFIRM
MLME_DISASSOCIATE_INDICATION
MLME_DISASSOCIATE_CONFIRM
MLME_BEACON_NOTIFY_INDICATION
MLME_GTS_CONFIRM
MLME_GTS_INDICATION
MLME_ORPHAN_INDICATION
MLME_SCAN_CONFIRM
MLME_COMM_STATUS_INDICATION
MLME_SYNC_LOSS_INDICATION
MLME_GET_CONFIRM
MLME_RESET_CONFIRM
MLME_RX_ENABLE_CONFIRM
MLME_START_CONFIRM
MLME_POLL_CONFIRM
MAC_INC_FRAME

retval_t mac_timers_init ( void )

References FAILURE, MAC_SUCCESS, pal_timer_get_id(), T_Rx_Enable, and T_Scan_Duration.

Referenced by mac_init().

retval_t mac_timers_stop ( void )

References MAC_SUCCESS, pal_timer_stop(), T_Rx_Enable, and T_Scan_Duration.

Referenced by mac_soft_reset().

retval_t wpan_init ( void )

The stack initialization function.

This function initializes all resources, which are used from the stack. It has to be called before any other function of the stack is called.

bool wpan_mcps_data_req	(	uint8_t	SrcAddrMode,
		wpan_addr_spec_t *	DstAddrSpec,
		uint8_t	msduLength,
		uint8_t *	msdu,
		uint8_t	msduHandle,
		uint8_t	TxOptions
	)

Initiate MCPS-DATA.request service and have it placed in the MCPS-SAP queue.

Parameters

SrcAddrMode	Address Mode of the source address.
DstAddrSpec	Pointer to wpan_addr_spec_t structure for destination.
msduHandle	Handle (identification) of the MSDU.
TxOptions	Bitmap for transmission options. Valid values: WPAN_TXOPT_OFF, WPAN_TXOPT_ACK, WPAN_TXOPT_INDIRECT, WPAN_TXOPT_INDIRECT_ACK. WPAN_TXOPT_GTS. WPAN_TXOPT_GTS_ACK.
msdu	Pointer to the data to be transmitted.
msduLength	Length of the data to be transmitted.
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: true - success; false - buffer not available or queue full.

bool wpan_mcps_purge_req ( const uint8_t msduHandle )

Initiate MCPS-PURGE.request service and have it placed in the MCPS-SAP queue.

Parameters

msduHandle Handle of MSDU to be purged.

Returns: true - success; false - buffer not available or queue full.

bool wpan_mlme_associate_req	(	uint8_t	LogicalChannel,
		uint8_t	ChannelPage,
		wpan_addr_spec_t *	CoordAddrSpec,
		uint8_t	CapabilityInformation
	)

Initiate MLME-ASSOCIATE.request service and have it placed in the MLME-SAP queue.

Parameters

LogicalChannel	The logical channel on which to attempt association.
ChannelPage	The channel page on which to attempt association.
CoordAddrSpec	Pointer to wpan_addr_spec_t structure for coordinator.
CapabilityInformation	Bitmap that describes the nodes capabilities. (WPAN_CAP_ALTPANCOORD \| WPAN_CAP_FFD \| WPAN_CAP_PWRSOURCE \| WPAN_CAP_RXONWHENIDLE \| WPAN_CAP_ALLOCADDRESS)

Returns: true - success; false - buffer not available or queue full.

bool wpan_mlme_associate_resp	(	uint64_t	DeviceAddress,
		uint16_t	AssocShortAddress,
		uint8_t	status
	)

Initiate MLME-ASSOCIATE.response service and place it in the MLME-SAP queue.

Parameters

DeviceAddress	Extended address for device requesting association.
AssocShortAddress	Short address allocated on successful association.
status	Status of the association attempt. Valid values: ASSOCIATION_SUCCESSFUL, PAN_AT_CAPACITY, PAN_ACCESS_DENIED, ASSOCIATION_RESERVED.

Returns: true - success; false - buffer not available or queue full.

bool wpan_mlme_disassociate_req	(	wpan_addr_spec_t *	DeviceAddrSpec,
		uint8_t	DisassociateReason,
		bool	TxIndirect
	)

Inititate MLME-DISASSOCIATE.request service and have it placed in the MLME-SAP queue.

Parameters

DeviceAddrSpec	Pointer to wpan_addr_spec_t structure for device to which to send the disassociation notification command.
DisassociateReason	Reason for disassociation. Valid values: WPAN_DISASSOC_BYPARENT, WPAN_DISASSOC_BYCHILD.
TxIndirect	TRUE if the disassociation notification command is to be sent indirectly

Returns: true - success; false - buffer not available or queue full.

bool wpan_mlme_get_req ( uint8_t PIBAttribute )

Initiate MLME-GET.request service and have it placed in the MLME-SAP queue.

Parameters

PIBAttribute	PIB attribute to be retrieved.
PIBAttributeIndex	Index of the PIB attribute to be read.

Returns: true - success; false - buffer not availability or queue full.

bool wpan_mlme_gts_req	(	uint16_t	DevShortAddr,
		gts_char_t	GtsChar
	)

bool wpan_mlme_orphan_resp	(	uint64_t	OrphanAddress,
		uint16_t	ShortAddress,
		bool	AssociatedMember
	)

Initiate MLME-ORPHAN.response service and have it placed in MLME_SAP queue.

Parameters

OrphanAddress	Address of orphaned device.
ShortAddress	Short address allocated to orphaned device.
AssociatedMember	Boolean true if the orphaned device is associated.

Returns: true - success; false - buffer not availability or queue full.

bool wpan_mlme_poll_req ( wpan_addr_spec_t * CoordAddrSpec )

Initiate MLME-POLL.request service and have it placed in the MLME-SAP queue.

Parameters

CoordAddrSpec Pointer to wpan_addr_spec_t structure for the coordinator.

Returns: true - success; false - buffer not availability or queue full.

bool wpan_mlme_reset_req ( bool SetDefaultPib )

Initiate MLME-RESET.request service and have it placed in the MLME-SAP queue.

Parameters

SetDefaultPib Boolean to set all PIB values to their respective defaults.

Returns: true - success; false - buffer not available or queue full.

bool wpan_mlme_rx_enable_req	(	bool	DeferPermit,
		uint32_t	RxOnTime,
		uint32_t	RxOnDuration
	)

Initiate MLME-RX-ENABLE.request service and have it placed in the MLME-SAP queue.

Parameters

DeferPermit	Set to true if receiver enable can be deferred until next superframe if requested time has already passed.
RxOnTime	Number of symbols from start of superframe before receiver is enabled.
RxOnDuration	Number of symbols for which the receiver is enabled,

Returns: true - success; false - buffer not available or queue full.

bool wpan_mlme_scan_req	(	uint8_t	ScanType,
		uint32_t	ScanChannels,
		uint8_t	ScanDuration,
		uint8_t	ChannelPage
	)

Initiate MLME-SCAN.request service and have it placed in the MLME-SAP queue.

Parameters

ScanType	Type of scan to perform. Valid values: MLME_SCAN_TYPE_ED, MLME_SCAN_TYPE_ACTIVE, MLME_SCAN_TYPE_PASSIVE, MLME_SCAN_TYPE_ORPHAN.
ScanChannels	Channels to be scanned.
ScanDuration	Duration of each scan.
ChannelPage	The channel page on which to perform the scan.

Returns: true - success; false - buffer not available or queue full.

bool wpan_mlme_set_req	(	uint8_t	PIBAttribute,
		void *	PIBAttributeValue
	)

Initiate MLME-SET.request service and have it placed in MLME_SAP queue.

Parameters

PIBAttribute	PIB attribute to be set.
PIBAttributeIndex	Index of the PIB attribute to be set.
PIBAttributeValue	Pointer to new PIB attribute value.

Returns: true - success; false - buffer not available or queue full.

bool wpan_mlme_start_req	(	uint16_t	PANId,
		uint8_t	LogicalChannel,
		uint8_t	ChannelPage,
		uint8_t	BeaconOrder,
		uint8_t	SuperframeOrder,
		bool	PANCoordinator,
		bool	BatteryLifeExtension,
		bool	CoordRealignment
	)

Initiate MLME-START service and have it placed in the MLME-SAP queue.

Parameters

PANId	PAN identifier to be used by device.
LogicalChannel	The logical channel on which to start using the new superframe configuration.
ChannelPage	The channel page on which to begin using the new superframe configuration.
BeaconOrder	Beacon transmission interval.
SuperframeOrder	Duration of active portion of superframe.
PANCoordinator	Indicates whether node is PAN coordinator of PAN.
BatteryLifeExtension	Boolean true disables receiver of beaconing device for a period after interframe spacing of beacon frame.
CoordRealignment	Boolean to transmit Coordinator Realignment command prior to changing to new superframe configuration.

Returns: true - success; false - buffer not available or queue full.

bool wpan_mlme_sync_req	(	uint8_t	LogicalChannel,
		uint8_t	ChannelPage,
		bool	TrackBeacon
	)

Initiate MLME-SYNC.request service and have it placed in the MLME-SAP queue.

Parameters

LogicalChannel	The logical channel on which to attempt coordinator synchronization.
ChannelPage	The channel page on which to attempt coordinator synchronization.
TrackBeacon	Boolean to synchronize with next beacon and to track all future beacons.

Returns: true - success; false - buffer not available or queue full.

bool wpan_task ( void )

The stack task function called by the application.

This function should be called as frequently as possible by the application in order to provide a permanent execution of the protocol stack.

Returns: Boolean true if an event was processed otherwise false.

enum msg_code SHORTENUM

uint8_t T_Rx_Enable

Referenced by handle_rx_on(), mac_t_rx_off_cb(), mac_timers_init(), mac_timers_stop(), and mlme_rx_enable_request().

uint8_t T_Scan_Duration

Referenced by mac_scan_send_complete(), mac_timers_init(), mac_timers_stop(), process_data_ind_scanning(), and scan_set_complete().

Microchip® Advanced Software Framework

Modules

Macros

Typedefs

Enumerations

Functions

Variables