ieee802154.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_IEEE802154_H_
#define ZEPHYR_INCLUDE_NET_IEEE802154_H_
 
#include <limits.h>
#include <zephyr/net/net_l2.h>
#include <zephyr/net/net_mgmt.h>
#include <zephyr/crypto/cipher.h>
#include <zephyr/net/ieee802154_radio.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define IEEE802154_MAX_PHY_PACKET_SIZE  127
 
#define IEEE802154_FCS_LENGTH           2
 
#define IEEE802154_MTU                  (IEEE802154_MAX_PHY_PACKET_SIZE - IEEE802154_FCS_LENGTH)
 
/* TODO: Support flexible MTU and FCS lengths for IEEE 802.15.4-2015ff */
 
#define IEEE802154_SHORT_ADDR_LENGTH    2
 
#define IEEE802154_EXT_ADDR_LENGTH      8
 
#define IEEE802154_MAX_ADDR_LENGTH      IEEE802154_EXT_ADDR_LENGTH
 
#define IEEE802154_NO_CHANNEL           USHRT_MAX
 
#define IEEE802154_BROADCAST_ADDRESS         0xffff
 
#define IEEE802154_NO_SHORT_ADDRESS_ASSIGNED 0xfffe
 
#define IEEE802154_BROADCAST_PAN_ID 0xffff
 
#define IEEE802154_SHORT_ADDRESS_NOT_ASSOCIATED IEEE802154_BROADCAST_ADDRESS
 
#define IEEE802154_PAN_ID_NOT_ASSOCIATED        IEEE802154_BROADCAST_PAN_ID
 
struct ieee802154_security_ctx {
        uint32_t frame_counter;
 
        struct cipher_ctx enc;
        struct cipher_ctx dec;
        uint8_t key[16];
 
        uint8_t key_len;
 
        uint8_t level   : 3;
 
        uint8_t key_mode        : 2;
 
        uint8_t _unused : 3;
};
 
enum ieee802154_device_role {
        IEEE802154_DEVICE_ROLE_ENDDEVICE,       
        IEEE802154_DEVICE_ROLE_COORDINATOR,     
        IEEE802154_DEVICE_ROLE_PAN_COORDINATOR, 
};
 
struct ieee802154_context {
        uint16_t pan_id;
 
        uint16_t channel;
 
        uint16_t short_addr;
 
        uint8_t ext_addr[IEEE802154_MAX_ADDR_LENGTH];
 
        struct net_linkaddr_storage linkaddr;
 
#ifdef CONFIG_NET_L2_IEEE802154_SECURITY
        struct ieee802154_security_ctx sec_ctx;
#endif
 
#ifdef CONFIG_NET_L2_IEEE802154_MGMT
        struct ieee802154_req_params *scan_ctx;
 
        struct k_sem scan_ctx_lock;
 
        uint8_t coord_ext_addr[IEEE802154_MAX_ADDR_LENGTH];
 
        uint16_t coord_short_addr;
#endif
 
        int16_t tx_power;
 
        enum net_l2_flags flags;
 
        uint8_t sequence;
 
        uint8_t device_role : 2;
 
        uint8_t _unused : 5;
        uint8_t ack_requested: 1;
 
        uint8_t ack_seq;
 
        struct k_sem ack_lock;
 
        struct k_sem ctx_lock;
};
 
/* L2 context type to be used with NET_L2_GET_CTX_TYPE */
#define IEEE802154_L2_CTX_TYPE  struct ieee802154_context
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_IEEE802154_H_ */