Rtos API example

Embed: (wiki syntax)

« Back to documentation index

mlme.h File Reference

mlme.h File Reference

MLME API. More...

Go to the source code of this file.

Data Structures

struct  mlme_pan_descriptor_s
 struct mlme_pan_descriptor_t PAN descriptor More...
struct  mlme_key_usage_descriptor_s
 struct mlme_key_usage_descriptor_t Key usage descriptor More...
struct  mlme_key_device_descriptor_s
 struct mlme_key_device_descriptor_t Key usage descriptor More...
struct  mlme_security_level_descriptor_s
 struct mlme_security_level_descriptor_t Security level descriptor More...
struct  mlme_device_descriptor_s
 struct mlme_device_descriptor_t Device descriptor More...
struct  mlme_key_id_lookup_descriptor_s
 struct mlme_key_id_lookup_descriptor_t Key id lookup descriptor More...
struct  mlme_key_descriptor_entry_s
 struct mlme_key_descriptor_entry_t Key descriptor entry More...
struct  mlme_beacon_pending_address_spec_s
 struct mlme_beacon_pending_address_spec_t Pending address specification field More...
struct  mlme_beacon_gts_spec_s
 struct mlme_beacon_gts_spec_t Format of GTS specification field More...
struct  mlme_beacon_ind_s
 struct mlme_beacon_ind_t Beacon notify structure More...
struct  mlme_scan_s
 struct mlme_scan_t Scan request structure More...
struct  mlme_set_s
 struct mlme_set_t Set request structure More...
struct  mlme_get_s
 struct mlme_get_t Get request structure More...
struct  mlme_get_conf_s
 struct mlme_get_conf_t Get confirm structure More...
struct  mlme_set_conf_s
 struct mlme_set_conf_t Set confirm structure More...
struct  mlme_scan_conf_s
 struct mlme_scan_conf_t Scan confirm structure More...
struct  mlme_reset_s
 struct mlme_reset_t Reset request structure More...
struct  mlme_reset_conf_s
 struct mlme_reset_conf_t Reset confirm structure More...
struct  mlme_rx_enable_s
 struct mlme_rx_enable_t Rx enable request structure (Not supported) More...
struct  mlme_rx_enable_conf_s
 struct mlme_rx_enable_conf_t Rx enable confirm structure (Not supported) More...
struct  mlme_comm_status_s
 struct mlme_comm_status_t Comm status indication structure More...
struct  mlme_start_s
 struct mlme_start_t Start request structure More...
struct  mlme_start_conf_s
 struct mlme_start_conf_t Start confirm structure (Currently not triggered yet) More...
struct  mlme_sync_loss_s
 struct mlme_sync_loss_s Synch loss indication More...
struct  mlme_poll_s
 struct mlme_poll_t Poll request structure More...
struct  mlme_poll_conf_s
 struct mlme_poll_conf_t Poll confirm structure More...

Typedefs

typedef struct
mlme_pan_descriptor_s 
mlme_pan_descriptor_t
 struct mlme_pan_descriptor_t PAN descriptor
typedef struct
mlme_key_usage_descriptor_s 
mlme_key_usage_descriptor_t
 struct mlme_key_usage_descriptor_t Key usage descriptor
typedef struct
mlme_key_device_descriptor_s 
mlme_key_device_descriptor_t
 struct mlme_key_device_descriptor_t Key usage descriptor
typedef struct
mlme_security_level_descriptor_s 
mlme_security_level_descriptor_t
 struct mlme_security_level_descriptor_t Security level descriptor
typedef struct
mlme_device_descriptor_s 
mlme_device_descriptor_t
 struct mlme_device_descriptor_t Device descriptor
typedef struct
mlme_key_id_lookup_descriptor_s 
mlme_key_id_lookup_descriptor_t
 struct mlme_key_id_lookup_descriptor_t Key id lookup descriptor
typedef struct
mlme_key_descriptor_entry_s 
mlme_key_descriptor_entry_t
 struct mlme_key_descriptor_entry_t Key descriptor entry
typedef struct
mlme_beacon_pending_address_spec_s 
mlme_beacon_pending_address_spec_t
 struct mlme_beacon_pending_address_spec_t Pending address specification field
typedef struct
mlme_beacon_gts_spec_s 
mlme_beacon_gts_spec_t
 struct mlme_beacon_gts_spec_t Format of GTS specification field
typedef struct mlme_beacon_ind_s mlme_beacon_ind_t
 struct mlme_beacon_ind_t Beacon notify structure
typedef struct mlme_scan_s mlme_scan_t
 struct mlme_scan_t Scan request structure
typedef struct mlme_set_s mlme_set_t
 struct mlme_set_t Set request structure
typedef struct mlme_get_s mlme_get_t
 struct mlme_get_t Get request structure
typedef struct mlme_get_conf_s mlme_get_conf_t
 struct mlme_get_conf_t Get confirm structure
typedef struct mlme_set_conf_s mlme_set_conf_t
 struct mlme_set_conf_t Set confirm structure
typedef struct mlme_scan_conf_s mlme_scan_conf_t
 struct mlme_scan_conf_t Scan confirm structure
typedef struct mlme_reset_s mlme_reset_t
 struct mlme_reset_t Reset request structure
typedef struct mlme_reset_conf_s mlme_reset_conf_t
 struct mlme_reset_conf_t Reset confirm structure
typedef struct mlme_rx_enable_s mlme_rx_enable_t
 struct mlme_rx_enable_t Rx enable request structure (Not supported)
typedef struct
mlme_rx_enable_conf_s 
mlme_rx_enable_conf_t
 struct mlme_rx_enable_conf_t Rx enable confirm structure (Not supported)
typedef struct mlme_comm_status_s mlme_comm_status_t
 struct mlme_comm_status_t Comm status indication structure
typedef struct mlme_start_s mlme_start_t
 struct mlme_start_t Start request structure
typedef struct mlme_start_conf_s mlme_start_conf_t
 struct mlme_start_conf_t Start confirm structure (Currently not triggered yet)
typedef struct mlme_sync_loss_s mlme_sync_loss_t
 struct mlme_sync_loss_s Synch loss indication
typedef struct mlme_poll_s mlme_poll_t
 struct mlme_poll_t Poll request structure
typedef struct mlme_poll_conf_s mlme_poll_conf_t
 struct mlme_poll_conf_t Poll confirm structure

Enumerations

enum  mlme_command_type_t {
  ASSOCIATION_REQUEST = 1, ASSOCIATION_RESPONSE = 2, DISASSOCIATION_NOTIFICATION = 3, DATA_REQUEST = 4,
  PAN_ID_CONFLICT_NOTIFICATION = 5, ORPHAN_NOTIFICATION = 6, BEACON_REQUEST = 7, COORDINATOR_REALIGNMENT = 8,
  GTS_REQUEST = 9
}
 

struct mlme_command_type_t Command type enumeration

More...
enum  mlme_loss_reason_t { PAN_ID_CONFLICT, REALIGNMENT, BEACON_LOST }
 

enum mlme_loss_reason_t loss reason enumeration

More...
enum  mlme_security_type_t {
  SEC_NONE = 0, SEC_MIC32 = 1, SEC_MIC64 = 2, SEC_MIC128 = 3,
  SEC_ENC = 4, SEC_ENC_MIC32 = 5, SEC_ENC_MIC64 = 6, SEC_ENC_MIC128 = 7
}
 

enum mlme_security_type_t Security type enumeration

More...
enum  mac_scan_type_t { MAC_ED_SCAN_TYPE = 0, MAC_ACTIVE_SCAN = 1, MAC_PASSIVE_SCAN = 2, MAC_ORPHAN_SCAN = 3 }
 

enum mac_scan_type_t MAC scan type

More...
enum  mlme_attr_t
 

enum mlme_attr_t MLME attributes used with GET and SET primitives

More...

Detailed Description

MLME API.

Definition in file mlme.h.


Typedef Documentation

struct mlme_beacon_gts_spec_t Format of GTS specification field

See IEEE standard 802.15.4-2006 (figure 48) for more details

struct mlme_beacon_ind_t Beacon notify structure

See IEEE standard 802.15.4-2006 (table 54) for more details

struct mlme_beacon_pending_address_spec_t Pending address specification field

See IEEE standard 802.15.4-2006 (figure 51) for more details

struct mlme_comm_status_t Comm status indication structure

See IEEE standard 802.15.4-2006 (table 69) for more details

struct mlme_device_descriptor_t Device descriptor

See IEEE standard 802.15.4-2006 (table 93) for more details

struct mlme_get_conf_t Get confirm structure

See IEEE standard 802.15.4-2006 (table 57) for more details

typedef struct mlme_get_s mlme_get_t

struct mlme_get_t Get request structure

See IEEE standard 802.15.4-2006 (table 56) for more details

struct mlme_key_descriptor_entry_t Key descriptor entry

See IEEE standard 802.15.4-2006 (table 89) for more details

struct mlme_key_device_descriptor_t Key usage descriptor

See IEEE standard 802.15.4-2006 (table 91) for more details

struct mlme_key_id_lookup_descriptor_t Key id lookup descriptor

See IEEE standard 802.15.4-2006 (table 94) for more details

struct mlme_key_usage_descriptor_t Key usage descriptor

See IEEE standard 802.15.4-2006 (table 90) for more details

struct mlme_pan_descriptor_t PAN descriptor

See IEEE standard 802.15.4-2006 (table 55) for more details

struct mlme_poll_conf_t Poll confirm structure

See IEEE standard 802.15.4-2006 (table 77) for more details

typedef struct mlme_poll_s mlme_poll_t

struct mlme_poll_t Poll request structure

See IEEE standard 802.15.4-2006 (table 76) for more details

struct mlme_reset_conf_t Reset confirm structure

See IEEE standard 802.15.4-2006 (table 64) for more details

typedef struct mlme_reset_s mlme_reset_t

struct mlme_reset_t Reset request structure

See IEEE standard 802.15.4-2006 (table 63) for more details

struct mlme_rx_enable_conf_t Rx enable confirm structure (Not supported)

See IEEE standard 802.15.4-2006 (table 66) for more details

struct mlme_rx_enable_t Rx enable request structure (Not supported)

See IEEE standard 802.15.4-2006 (table 65) for more details

struct mlme_scan_conf_t Scan confirm structure

See IEEE standard 802.15.4-2006 (table 68) for more details

typedef struct mlme_scan_s mlme_scan_t

struct mlme_scan_t Scan request structure

See IEEE standard 802.15.4-2006 (table 67) for more details

struct mlme_security_level_descriptor_t Security level descriptor

See IEEE standard 802.15.4-2006 (table 92) for more details

struct mlme_set_conf_t Set confirm structure

See IEEE standard 802.15.4-2006 (table 71) for more details

typedef struct mlme_set_s mlme_set_t

struct mlme_set_t Set request structure

See IEEE standard 802.15.4-2006 (table 70) for more details

struct mlme_start_conf_t Start confirm structure (Currently not triggered yet)

See IEEE standard 802.15.4-2006 (table 73) for more details

typedef struct mlme_start_s mlme_start_t

struct mlme_start_t Start request structure

See IEEE standard 802.15.4-2006 (table 72) for more details

struct mlme_sync_loss_s Synch loss indication

Stack will trig this with FHSS enabled mac when synch to parent is lost See IEEE standard 802.15.4-2006 (table 73) for more details


Enumeration Type Documentation

enum mac_scan_type_t MAC scan type

See IEEE standard 802.15.4-2006 (table 67) for more details

Enumerator:
MAC_ED_SCAN_TYPE 

Energy detection scan operation.

MAC_ACTIVE_SCAN 

Active scan operation.

MAC_PASSIVE_SCAN 

Passive scan operation.

MAC_ORPHAN_SCAN 

Orphan scan operation (Not supported)

Definition at line 207 of file mlme.h.

enum mlme_attr_t MLME attributes used with GET and SET primitives

See IEEE standard 802.15.4-2006 (table 86) for more details

Definition at line 219 of file mlme.h.

struct mlme_command_type_t Command type enumeration

See IEEE standard 802.15.4-2006 (table 82) for more details

Enumerator:
ASSOCIATION_REQUEST 

Assocation request (Not supported)

ASSOCIATION_RESPONSE 

Assocation response (Not supported)

DISASSOCIATION_NOTIFICATION 

Disasocation Notification (Not supported)

DATA_REQUEST 

Data Request.

PAN_ID_CONFLICT_NOTIFICATION 

Pan ID conflict notification (Not supported)

ORPHAN_NOTIFICATION 

Orphan Notification (Not supported)

BEACON_REQUEST 

Beacon request.

COORDINATOR_REALIGNMENT 

Coordinator Realignment (Not supported)

GTS_REQUEST 

GTS request (Not supported)

Definition at line 50 of file mlme.h.

enum mlme_loss_reason_t loss reason enumeration

See IEEE standard 802.15.4-2006 (table 75) for more details

Enumerator:
PAN_ID_CONFLICT 

Pan id conflict (Not supported)

REALIGNMENT 

Cordinator Realignment(Not supported)

BEACON_LOST 

FHSS indicate by this when it loose synch to coordinator.

Definition at line 68 of file mlme.h.

enum mlme_security_type_t Security type enumeration

See IEEE standard 802.15.4-2006 (table 95) for more details

Enumerator:
SEC_NONE 

No payload encode and authentication.

SEC_MIC32 

No payload encode with 32-bit MIC authentication.

SEC_MIC64 

No payload encode with 64-bit MIC authentication.

SEC_MIC128 

No payload encode with 128-bit MIC authentication.

SEC_ENC 

Payload encode enabled and without authentication.

SEC_ENC_MIC32 

Payload encode enabled with 32-bit MIC authentication.

SEC_ENC_MIC64 

Payload encode enabled with 64-bit MIC authentication.

SEC_ENC_MIC128 

Payload encode enabled with 128-bit MIC authentication.

Definition at line 100 of file mlme.h.