ieee802154_mgmt.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_IEEE802154_MGMT_H_
#define ZEPHYR_INCLUDE_NET_IEEE802154_MGMT_H_
 
#include <zephyr/net/ieee802154.h>
#include <zephyr/net/net_mgmt.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define _NET_IEEE802154_LAYER   NET_MGMT_LAYER_L2
#define _NET_IEEE802154_CODE    0x154
#define _NET_IEEE802154_BASE    (NET_MGMT_IFACE_BIT |                   \
                                 NET_MGMT_LAYER(_NET_IEEE802154_LAYER) |\
                                 NET_MGMT_LAYER_CODE(_NET_IEEE802154_CODE))
#define _NET_IEEE802154_EVENT   (_NET_IEEE802154_BASE | NET_MGMT_EVENT_BIT)
 
/* 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 below:
 *  - 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 below:
 *  - 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.
 */
enum net_request_ieee802154_cmd {
        NET_REQUEST_IEEE802154_CMD_SET_ACK = 1,    /* sets AckTx for all subsequent
                                                    * MLME-DATA (aka TX) requests
                                                    */
        NET_REQUEST_IEEE802154_CMD_UNSET_ACK,      /* unsets AckTx for all subsequent
                                                    * MLME-DATA requests
                                                    */
        NET_REQUEST_IEEE802154_CMD_PASSIVE_SCAN,   /* MLME-SCAN(PASSIVE, ...) request */
        NET_REQUEST_IEEE802154_CMD_ACTIVE_SCAN,    /* MLME-SCAN(ACTIVE, ...) request */
        NET_REQUEST_IEEE802154_CMD_CANCEL_SCAN,    /* not-standard */
        NET_REQUEST_IEEE802154_CMD_ASSOCIATE,      /* MLME-ASSOCIATE(...) request */
        NET_REQUEST_IEEE802154_CMD_DISASSOCIATE,   /* MLME-DISASSOCIATE(...) request */
        NET_REQUEST_IEEE802154_CMD_SET_CHANNEL,    /* MLME-SET(phyCurrentChannel) request */
        NET_REQUEST_IEEE802154_CMD_GET_CHANNEL,    /* MLME-GET(phyCurrentChannel) request */
        NET_REQUEST_IEEE802154_CMD_SET_PAN_ID,     /* MLME-SET(macPanId) request */
        NET_REQUEST_IEEE802154_CMD_GET_PAN_ID,     /* MLME-GET(macPanId) request */
        NET_REQUEST_IEEE802154_CMD_SET_EXT_ADDR,   /* non-standard, see chapters 7.1 and 8.4.3.1, in
                                                    * big endian byte order
                                                    */
        NET_REQUEST_IEEE802154_CMD_GET_EXT_ADDR,   /* like MLME-GET(macExtendedAddress) but in big
                                                    * endian byte order
                                                    */
        NET_REQUEST_IEEE802154_CMD_SET_SHORT_ADDR, /* MLME-SET(macShortAddress) request, only
                                                    * allowed for co-ordinators
                                                    */
        NET_REQUEST_IEEE802154_CMD_GET_SHORT_ADDR, /* MLME-GET(macShortAddress) request */
        NET_REQUEST_IEEE802154_CMD_GET_TX_POWER, /* MLME-SET(phyUnicastTxPower/phyBroadcastTxPower)
                                                  * request (currently not distinguished)
                                                  */
        NET_REQUEST_IEEE802154_CMD_SET_TX_POWER, /* MLME-GET(phyUnicastTxPower/phyBroadcastTxPower)
                                                  * request
                                                  */
 
        NET_REQUEST_IEEE802154_CMD_SET_SECURITY_SETTINGS, /* implies macSecurityEnabled=true,
                                                           * configures basic sec* MAC PIB
                                                           * attributes
                                                           */
        NET_REQUEST_IEEE802154_CMD_GET_SECURITY_SETTINGS, /* gets the configured sec* attributes */
};
 
 
#define NET_REQUEST_IEEE802154_SET_ACK                                  \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_ACK)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_SET_ACK);
 
#define NET_REQUEST_IEEE802154_UNSET_ACK                                \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_UNSET_ACK)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_UNSET_ACK);
 
#define NET_REQUEST_IEEE802154_PASSIVE_SCAN                             \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_PASSIVE_SCAN)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_PASSIVE_SCAN);
 
#define NET_REQUEST_IEEE802154_ACTIVE_SCAN                              \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_ACTIVE_SCAN)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_ACTIVE_SCAN);
 
#define NET_REQUEST_IEEE802154_CANCEL_SCAN                              \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_CANCEL_SCAN)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_CANCEL_SCAN);
 
#define NET_REQUEST_IEEE802154_ASSOCIATE                                \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_ASSOCIATE)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_ASSOCIATE);
 
#define NET_REQUEST_IEEE802154_DISASSOCIATE                             \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_DISASSOCIATE)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_DISASSOCIATE);
 
#define NET_REQUEST_IEEE802154_SET_CHANNEL                              \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_CHANNEL)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_SET_CHANNEL);
 
#define NET_REQUEST_IEEE802154_GET_CHANNEL                              \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_CHANNEL)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_GET_CHANNEL);
 
#define NET_REQUEST_IEEE802154_SET_PAN_ID                               \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_PAN_ID)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_SET_PAN_ID);
 
#define NET_REQUEST_IEEE802154_GET_PAN_ID                               \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_PAN_ID)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_GET_PAN_ID);
 
#define NET_REQUEST_IEEE802154_SET_EXT_ADDR                             \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_EXT_ADDR)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_SET_EXT_ADDR);
 
#define NET_REQUEST_IEEE802154_GET_EXT_ADDR                             \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_EXT_ADDR)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_GET_EXT_ADDR);
 
#define NET_REQUEST_IEEE802154_SET_SHORT_ADDR                           \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_SET_SHORT_ADDR)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_SET_SHORT_ADDR);
 
#define NET_REQUEST_IEEE802154_GET_SHORT_ADDR                           \
        (_NET_IEEE802154_BASE | NET_REQUEST_IEEE802154_CMD_GET_SHORT_ADDR)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_GET_SHORT_ADDR);
 
#define NET_REQUEST_IEEE802154_GET_TX_POWER                             \
        (_NET_IEEE802154_BASE |                                         \
         NET_REQUEST_IEEE802154_CMD_GET_TX_POWER)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_GET_TX_POWER);
 
#define NET_REQUEST_IEEE802154_SET_TX_POWER                             \
        (_NET_IEEE802154_BASE |                                         \
         NET_REQUEST_IEEE802154_CMD_SET_TX_POWER)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_SET_TX_POWER);
 
#ifdef CONFIG_NET_L2_IEEE802154_SECURITY
 
#define NET_REQUEST_IEEE802154_SET_SECURITY_SETTINGS                    \
        (_NET_IEEE802154_BASE |                                         \
         NET_REQUEST_IEEE802154_CMD_SET_SECURITY_SETTINGS)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_SET_SECURITY_SETTINGS);
 
#define NET_REQUEST_IEEE802154_GET_SECURITY_SETTINGS                    \
        (_NET_IEEE802154_BASE |                                         \
         NET_REQUEST_IEEE802154_CMD_GET_SECURITY_SETTINGS)
 
NET_MGMT_DEFINE_REQUEST_HANDLER(NET_REQUEST_IEEE802154_GET_SECURITY_SETTINGS);
 
#endif /* CONFIG_NET_L2_IEEE802154_SECURITY */
 
enum net_event_ieee802154_cmd {
        NET_EVENT_IEEE802154_CMD_SCAN_RESULT = 1,
};
 
#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))
 
/* Useful define to request all 16 channels of channel page zero
 * in the 2450 MHz band to be scanned, from 11 to 26 included.
 */
#define IEEE802154_ALL_CHANNELS (0x03FFFC00)
 
struct ieee802154_req_params {
        uint32_t channel_set;
 
        uint32_t duration;
 
        uint16_t channel; /* in CPU byte order */
        uint16_t pan_id; /* in CPU byte order */
 
        union {
                uint16_t short_addr;                      /* in CPU byte order */
                uint8_t addr[IEEE802154_MAX_ADDR_LENGTH]; /* in big endian */
        };
 
        uint8_t len;
        uint8_t lqi;
};
 
struct ieee802154_security_params {
        uint8_t key[16];      /* secKeyDescriptor.secKey */
        uint8_t key_len;      /* a key length of 16 bytes is mandatory for standards conformance */
        uint8_t key_mode : 2; /* secKeyIdMode */
        uint8_t level : 3;    /* Used instead of a frame-specific SecurityLevel parameter when
                               * constructing the auxiliary security header
                               */
        uint8_t _unused : 3;
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_IEEE802154_MGMT_H_ */