nRF5 SDK v17.1.0
Data Structures | Macros | Enumerations
MAC MLME Association API

Module to declare MAC MLME Association API. More...

Data Structures

struct  mac_capability_t
 Capability information field. More...
 

Macros

#define ALTERNATE_PAN_COORDINATOR_BIT   (0)
 Capability information field. More...
 
#define DEVICE_TYPE_BIT   (1)
 
#define POWER_SOURCE_BIT   (2)
 
#define RECEIVER_ON_WHEN_IDLE_BIT   (3)
 
#define SECURITY_CAPABILITY_BIT   (6)
 
#define ALLOCATE_ADDRESS_BIT   (7)
 

Enumerations

enum  mac_association_status_t {
  MAC_ASSOCIATION_SUCCESSFUL = 0,
  MAC_PAN_AT_CAPACITY,
  MAC_PAN_ACCESS_DENIED
}
 Valid values of the Association Status field. More...
 
enum  mac_cap_alt_pan_coord_t {
  MAC_CAP_CANNOT_BE_PAN_COORD = 0,
  MAC_CAP_CAN_BE_PAN_COORD
}
 The Alternate PAN Coordinator subfield of the Capability Information field. More...
 
enum  mac_cap_device_type_t {
  MAC_CAP_RFD_DEVICE = 0,
  MAC_CAP_FFD_DEVICE
}
 The Device Type subfield of the Capability Information field. More...
 
enum  mac_cap_power_source_t {
  MAC_CAP_BATTERY_POWERED = 0,
  MAC_CAP_MAINS_POWERED
}
 The Power Source subfield of the Capability Information field. More...
 
enum  mac_cap_rx_when_idle_t {
  MAC_CAP_RX_OFF_WHEN_IDLE = 0,
  MAC_CAP_RX_ON_WHEN_IDLE
}
 The Receiver On When Idle subfield of the Capability Information field. More...
 
enum  mac_cap_secure_t {
  MAC_CAP_CANNOT_SECURE = 0,
  MAC_CAP_CAN_SECURE
}
 The Security Capability subfield of the Capability Information field. More...
 
enum  mac_cap_allocate_addr_t {
  MAC_CAP_SHORT_ADDR_NOT_REQ = 0,
  MAC_CAP_SHORT_ADDR_REQ
}
 The Allocate Address subfield of the Capability Information field. More...
 

Detailed Description

Module to declare MAC MLME Association API.

The MLME Association module declares Association MAC routines and necessary macros/types according to the MAC specification. More specifically, MLME Association request aka mlme_associate_req(), MLME Association confirm callback typedef aka mlme_associate_conf_cb_t, MLME Association indication as mlme_associate_ind(), and MLME Response aka mlme_associate_resp() primitives are declared.

Macro Definition Documentation

#define ALTERNATE_PAN_COORDINATOR_BIT   (0)

Capability information field.

In accordance with IEEE Std 802.15.4-2006, section 7.3.1.2.

Enumeration Type Documentation

Valid values of the Association Status field.

In accordance with IEEE Std 802.15.4-2006, section 7.3.2.3

The Allocate Address subfield of the Capability Information field.

Enumerator
MAC_CAP_SHORT_ADDR_NOT_REQ 

The coordinator will not allocate a 16-bit short address as a result of the association procedure.

MAC_CAP_SHORT_ADDR_REQ 

The coordinator will allocate a 16-bit short address as a result of the association procedure.

The Alternate PAN Coordinator subfield of the Capability Information field.

Enumerator
MAC_CAP_CANNOT_BE_PAN_COORD 

Device is not capable of becoming the PAN coordinator.

MAC_CAP_CAN_BE_PAN_COORD 

Device is capable of becoming the PAN coordinator.

The Device Type subfield of the Capability Information field.

Enumerator
MAC_CAP_RFD_DEVICE 

Device is an RFD.

MAC_CAP_FFD_DEVICE 

Device is an FFD.

The Power Source subfield of the Capability Information field.

Enumerator
MAC_CAP_BATTERY_POWERED 

Device is not AC-powered.

MAC_CAP_MAINS_POWERED 

Device is receiving power from the alternating current mains.

The Receiver On When Idle subfield of the Capability Information field.

Enumerator
MAC_CAP_RX_OFF_WHEN_IDLE 

Device conserves power during idle.

MAC_CAP_RX_ON_WHEN_IDLE 

Device does not disable its receiver to conserve power during idle periods.

The Security Capability subfield of the Capability Information field.

Enumerator
MAC_CAP_CANNOT_SECURE 

Device does not support securing.

MAC_CAP_CAN_SECURE 

Device is capable of sending and receiving cryptographically protected MAC frames.


Documentation feedback | Developer Zone | Subscribe | Updated