Zephyr API Documentation  2.7.0-rc2
A Scalable Open Source RTOS
IEEE 802.15.4 Library

IEEE 802.15.4 library. More...

Data Structures

struct  ieee802154_req_params
 Scanning parameters. More...
 
struct  ieee802154_security_params
 Security parameters. More...
 

Macros

#define NET_REQUEST_IEEE802154_SET_ACK    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_ACK)
 
#define NET_REQUEST_IEEE802154_UNSET_ACK    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_UNSET_ACK)
 
#define NET_REQUEST_IEEE802154_PASSIVE_SCAN    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_PASSIVE_SCAN)
 
#define NET_REQUEST_IEEE802154_ACTIVE_SCAN    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_ACTIVE_SCAN)
 
#define NET_REQUEST_IEEE802154_CANCEL_SCAN    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_CANCEL_SCAN)
 
#define NET_REQUEST_IEEE802154_ASSOCIATE    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_ASSOCIATE)
 
#define NET_REQUEST_IEEE802154_DISASSOCIATE    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_DISASSOCIATE)
 
#define NET_REQUEST_IEEE802154_SET_CHANNEL    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_CHANNEL)
 
#define NET_REQUEST_IEEE802154_GET_CHANNEL    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_CHANNEL)
 
#define NET_REQUEST_IEEE802154_SET_PAN_ID    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_PAN_ID)
 
#define NET_REQUEST_IEEE802154_GET_PAN_ID    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_PAN_ID)
 
#define NET_REQUEST_IEEE802154_SET_EXT_ADDR    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_EXT_ADDR)
 
#define NET_REQUEST_IEEE802154_GET_EXT_ADDR    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_EXT_ADDR)
 
#define NET_REQUEST_IEEE802154_SET_SHORT_ADDR    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_SHORT_ADDR)
 
#define NET_REQUEST_IEEE802154_GET_SHORT_ADDR    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_SHORT_ADDR)
 
#define NET_REQUEST_IEEE802154_GET_TX_POWER
 
#define NET_REQUEST_IEEE802154_SET_TX_POWER
 
#define NET_EVENT_IEEE802154_SCAN_RESULT    (_NET_IEEE802154_EVENT | NET_EVENT_IEEE802154_CMD_SCAN_RESULT)
 
#define IEEE802154_IS_CHAN_SCANNED(_channel_set, _chan)    (_channel_set & BIT(_chan - 1))
 
#define IEEE802154_IS_CHAN_UNSCANNED(_channel_set, _chan)    (!IEEE802154_IS_CHAN_SCANNED(_channel_set, _chan))
 
#define IEEE802154_ALL_CHANNELS   (0x03FFFC00)
 

Enumerations

enum  net_request_ieee802154_cmd {
  NET_REQUEST_IEEE802154_CMD_SET_ACK = 1 , NET_REQUEST_IEEE802154_CMD_UNSET_ACK , NET_REQUEST_IEEE802154_CMD_PASSIVE_SCAN , NET_REQUEST_IEEE802154_CMD_ACTIVE_SCAN ,
  NET_REQUEST_IEEE802154_CMD_CANCEL_SCAN , NET_REQUEST_IEEE802154_CMD_ASSOCIATE , NET_REQUEST_IEEE802154_CMD_DISASSOCIATE , NET_REQUEST_IEEE802154_CMD_SET_CHANNEL ,
  NET_REQUEST_IEEE802154_CMD_GET_CHANNEL , NET_REQUEST_IEEE802154_CMD_SET_PAN_ID , NET_REQUEST_IEEE802154_CMD_GET_PAN_ID , NET_REQUEST_IEEE802154_CMD_SET_EXT_ADDR ,
  NET_REQUEST_IEEE802154_CMD_GET_EXT_ADDR , NET_REQUEST_IEEE802154_CMD_SET_SHORT_ADDR , NET_REQUEST_IEEE802154_CMD_GET_SHORT_ADDR , NET_REQUEST_IEEE802154_CMD_GET_TX_POWER ,
  NET_REQUEST_IEEE802154_CMD_SET_TX_POWER , NET_REQUEST_IEEE802154_CMD_SET_SECURITY_SETTINGS , NET_REQUEST_IEEE802154_CMD_GET_SECURITY_SETTINGS
}
 
enum  net_event_ieee802154_cmd { NET_EVENT_IEEE802154_CMD_SCAN_RESULT = 1 }
 

Detailed Description

IEEE 802.15.4 library.

Macro Definition Documentation

◆ IEEE802154_ALL_CHANNELS

#define IEEE802154_ALL_CHANNELS   (0x03FFFC00)

◆ IEEE802154_IS_CHAN_SCANNED

#define IEEE802154_IS_CHAN_SCANNED (   _channel_set,
  _chan 
)     (_channel_set & BIT(_chan - 1))

◆ IEEE802154_IS_CHAN_UNSCANNED

#define IEEE802154_IS_CHAN_UNSCANNED (   _channel_set,
  _chan 
)     (!IEEE802154_IS_CHAN_SCANNED(_channel_set, _chan))

◆ NET_EVENT_IEEE802154_SCAN_RESULT

#define NET_EVENT_IEEE802154_SCAN_RESULT    (_NET_IEEE802154_EVENT | NET_EVENT_IEEE802154_CMD_SCAN_RESULT)

◆ NET_REQUEST_IEEE802154_ACTIVE_SCAN

#define NET_REQUEST_IEEE802154_ACTIVE_SCAN    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_ACTIVE_SCAN)

◆ NET_REQUEST_IEEE802154_ASSOCIATE

#define NET_REQUEST_IEEE802154_ASSOCIATE    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_ASSOCIATE)

◆ NET_REQUEST_IEEE802154_CANCEL_SCAN

#define NET_REQUEST_IEEE802154_CANCEL_SCAN    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_CANCEL_SCAN)

◆ NET_REQUEST_IEEE802154_DISASSOCIATE

#define NET_REQUEST_IEEE802154_DISASSOCIATE    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_DISASSOCIATE)

◆ NET_REQUEST_IEEE802154_GET_CHANNEL

#define NET_REQUEST_IEEE802154_GET_CHANNEL    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_CHANNEL)

◆ NET_REQUEST_IEEE802154_GET_EXT_ADDR

#define NET_REQUEST_IEEE802154_GET_EXT_ADDR    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_EXT_ADDR)

◆ NET_REQUEST_IEEE802154_GET_PAN_ID

#define NET_REQUEST_IEEE802154_GET_PAN_ID    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_PAN_ID)

◆ NET_REQUEST_IEEE802154_GET_SHORT_ADDR

#define NET_REQUEST_IEEE802154_GET_SHORT_ADDR    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_SHORT_ADDR)

◆ NET_REQUEST_IEEE802154_GET_TX_POWER

#define NET_REQUEST_IEEE802154_GET_TX_POWER

#include <include/net/ieee802154_mgmt.h>

Value:
(_NET_IEEE802154_BASE | \
NET_REQUEST_IEEE802154_CMD_GET_TX_POWER)

◆ NET_REQUEST_IEEE802154_PASSIVE_SCAN

#define NET_REQUEST_IEEE802154_PASSIVE_SCAN    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_PASSIVE_SCAN)

◆ NET_REQUEST_IEEE802154_SET_ACK

#define NET_REQUEST_IEEE802154_SET_ACK    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_ACK)

◆ NET_REQUEST_IEEE802154_SET_CHANNEL

#define NET_REQUEST_IEEE802154_SET_CHANNEL    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_CHANNEL)

◆ NET_REQUEST_IEEE802154_SET_EXT_ADDR

#define NET_REQUEST_IEEE802154_SET_EXT_ADDR    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_EXT_ADDR)

◆ NET_REQUEST_IEEE802154_SET_PAN_ID

#define NET_REQUEST_IEEE802154_SET_PAN_ID    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_PAN_ID)

◆ NET_REQUEST_IEEE802154_SET_SHORT_ADDR

#define NET_REQUEST_IEEE802154_SET_SHORT_ADDR    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_SHORT_ADDR)

◆ NET_REQUEST_IEEE802154_SET_TX_POWER

#define NET_REQUEST_IEEE802154_SET_TX_POWER

#include <include/net/ieee802154_mgmt.h>

Value:
(_NET_IEEE802154_BASE | \
NET_REQUEST_IEEE802154_CMD_SET_TX_POWER)

◆ NET_REQUEST_IEEE802154_UNSET_ACK

#define NET_REQUEST_IEEE802154_UNSET_ACK    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_UNSET_ACK)

Enumeration Type Documentation

◆ net_event_ieee802154_cmd

#include <include/net/ieee802154_mgmt.h>

Enumerator
NET_EVENT_IEEE802154_CMD_SCAN_RESULT 

◆ net_request_ieee802154_cmd

#include <include/net/ieee802154_mgmt.h>

Enumerator
NET_REQUEST_IEEE802154_CMD_SET_ACK 
NET_REQUEST_IEEE802154_CMD_UNSET_ACK 
NET_REQUEST_IEEE802154_CMD_PASSIVE_SCAN 
NET_REQUEST_IEEE802154_CMD_ACTIVE_SCAN 
NET_REQUEST_IEEE802154_CMD_CANCEL_SCAN 
NET_REQUEST_IEEE802154_CMD_ASSOCIATE 
NET_REQUEST_IEEE802154_CMD_DISASSOCIATE 
NET_REQUEST_IEEE802154_CMD_SET_CHANNEL 
NET_REQUEST_IEEE802154_CMD_GET_CHANNEL 
NET_REQUEST_IEEE802154_CMD_SET_PAN_ID 
NET_REQUEST_IEEE802154_CMD_GET_PAN_ID 
NET_REQUEST_IEEE802154_CMD_SET_EXT_ADDR 
NET_REQUEST_IEEE802154_CMD_GET_EXT_ADDR 
NET_REQUEST_IEEE802154_CMD_SET_SHORT_ADDR 
NET_REQUEST_IEEE802154_CMD_GET_SHORT_ADDR 
NET_REQUEST_IEEE802154_CMD_GET_TX_POWER 
NET_REQUEST_IEEE802154_CMD_SET_TX_POWER 
NET_REQUEST_IEEE802154_CMD_SET_SECURITY_SETTINGS 
NET_REQUEST_IEEE802154_CMD_GET_SECURITY_SETTINGS