ieee802154_mgmt.h File Reference

IEEE 802.15.4 Management interface public header. More...

#include <zephyr/net/ieee802154.h>
#include <zephyr/net/net_mgmt.h>

Go to the source code of this file.

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

Macros
Command Macros
IEEE 802.15.4 net management commands. These IEEE 802.15.4 subsystem net management commands can be called by applications via Network Management macro. All attributes and parameters are given in CPU byte order (scalars) or big endian (byte arrays) unless otherwise specified. The following IEEE 802.15.4 MAC management service primitives are referenced in this enumeration: MLME-ASSOCIATE.request, see section 8.2.3 MLME-DISASSOCIATE.request, see section 8.2.4 MLME-SET/GET.request, see section 8.2.6 MLME-SCAN.request, see section 8.2.11 The following IEEE 802.15.4 MAC data service primitives are referenced in this enumeration: MLME-DATA.request, see section 8.3.2 MAC PIB attributes (mac.../sec...): see sections 8.4.3 and 9.5. PHY PIB attributes (phy...): see section 11.3. Both are accessed through MLME-SET/GET primitives.
#define	NET_REQUEST_IEEE802154_SET_ACK   (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_ACK)
	Sets AckTx for all subsequent MLME-DATA (aka TX) requests.
#define	NET_REQUEST_IEEE802154_UNSET_ACK    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_UNSET_ACK)
	Unsets AckTx for all subsequent MLME-DATA requests.
#define	NET_REQUEST_IEEE802154_PASSIVE_SCAN    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_PASSIVE_SCAN)
	MLME-SCAN(PASSIVE, ...) request.
#define	NET_REQUEST_IEEE802154_ACTIVE_SCAN    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_ACTIVE_SCAN)
	MLME-SCAN(ACTIVE, ...) request.
#define	NET_REQUEST_IEEE802154_CANCEL_SCAN    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_CANCEL_SCAN)
	Cancels an ongoing MLME-SCAN(...) command (non-standard).
#define	NET_REQUEST_IEEE802154_ASSOCIATE    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_ASSOCIATE)
	MLME-ASSOCIATE(...) request.
#define	NET_REQUEST_IEEE802154_DISASSOCIATE    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_DISASSOCIATE)
	MLME-DISASSOCIATE(...) request.
#define	NET_REQUEST_IEEE802154_SET_CHANNEL    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_CHANNEL)
	MLME-SET(phyCurrentChannel) request.
#define	NET_REQUEST_IEEE802154_GET_CHANNEL    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_CHANNEL)
	MLME-GET(phyCurrentChannel) request.
#define	NET_REQUEST_IEEE802154_SET_PAN_ID    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_PAN_ID)
	MLME-SET(macPanId) request.
#define	NET_REQUEST_IEEE802154_GET_PAN_ID    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_PAN_ID)
	MLME-GET(macPanId) request.
#define	NET_REQUEST_IEEE802154_SET_EXT_ADDR    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_EXT_ADDR)
	Sets the extended interface address (non-standard), see sections 7.1 and 8.4.3.1, in big endian byte order.
#define	NET_REQUEST_IEEE802154_GET_EXT_ADDR    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_EXT_ADDR)
	like MLME-GET(macExtendedAddress) but in big endian byte order
#define	NET_REQUEST_IEEE802154_SET_SHORT_ADDR    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_SHORT_ADDR)
	MLME-SET(macShortAddress) request, only allowed for co-ordinators.
#define	NET_REQUEST_IEEE802154_GET_SHORT_ADDR    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_SHORT_ADDR)
	MLME-GET(macShortAddress) request.
#define	NET_REQUEST_IEEE802154_GET_TX_POWER    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_TX_POWER)
	MLME-SET(phyUnicastTxPower/phyBroadcastTxPower) request (currently not distinguished)
#define	NET_REQUEST_IEEE802154_SET_TX_POWER    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_TX_POWER)
	MLME-GET(phyUnicastTxPower/phyBroadcastTxPower) request.
#define	NET_REQUEST_IEEE802154_SET_SECURITY_SETTINGS    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_SECURITY_SETTINGS)
	Configures basic sec* MAC PIB attributes, implies macSecurityEnabled=true.
#define	NET_REQUEST_IEEE802154_GET_SECURITY_SETTINGS    (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_SECURITY_SETTINGS)
	Gets the configured sec* attributes.
Event Macros
IEEE 802.15.4 net management events. These IEEE 802.15.4 subsystem net management events can be subscribed to by applications via net_mgmt_init_event_callback, net_mgmt_add_event_callback and net_mgmt_del_event_callback.
#define	NET_EVENT_IEEE802154_SCAN_RESULT    (_NET_IEEE802154_EVENT | NET_EVENT_IEEE802154_CMD_SCAN_RESULT)
	Signals the result of the NET_REQUEST_IEEE802154_ACTIVE_SCAN or NET_REQUEST_IEEE802154_PASSIVE_SCAN net management commands.

Detailed Description

IEEE 802.15.4 Management interface public header.

Note

All references to the standard in this file cite IEEE 802.15.4-2020.