ieee802154_pkt.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Intel Corporation.
 * Copyright (c) 2022 Florian Grandel.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_IEEE802154_PKT_H_
#define ZEPHYR_INCLUDE_NET_IEEE802154_PKT_H_
 
#include <string.h>
 
#include <zephyr/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef NET_PKT_HAS_CONTROL_BLOCK
#define NET_PKT_HAS_CONTROL_BLOCK
#endif
 
/* See section 6.16.2.8 - Received Signal Strength Indicator (RSSI) */
#define IEEE802154_MAC_RSSI_MIN       0U   /* corresponds to -174 dBm */
#define IEEE802154_MAC_RSSI_MAX       254U /* corresponds to 80 dBm */
#define IEEE802154_MAC_RSSI_UNDEFINED 255U /* used by us to indicate an undefined RSSI value */
 
#define IEEE802154_MAC_RSSI_DBM_MIN       -174      /* in dBm */
#define IEEE802154_MAC_RSSI_DBM_MAX       80        /* in dBm */
#define IEEE802154_MAC_RSSI_DBM_UNDEFINED INT16_MIN /* represents an undefined RSSI value */
 
struct net_pkt_cb_ieee802154 {
#if defined(CONFIG_NET_L2_OPENTHREAD)
        uint32_t ack_fc;   /* Frame counter set in the ACK */
        uint8_t ack_keyid; /* Key index set in the ACK */
#endif
        union {
                /* RX packets */
                struct {
                        uint8_t lqi;  /* Link Quality Indicator */
                        /* See section 6.16.2.8 - Received Signal Strength Indicator (RSSI)
                         * "RSSI is represented as one octet of integer [...]; therefore,
                         * the minimum and maximum values are 0 (–174 dBm) and 254 (80 dBm),
                         * respectively. 255 is reserved." (MAC PIB attribute macRssi, see
                         * section 8.4.3.10, table 8-108)
                         *
                         * TX packets will show zero for this value. Drivers may set the
                         * field to the reserved value 255 (0xff) to indicate that an RSSI
                         * value is not available for this packet.
                         */
                        uint8_t rssi;
                };
                struct {
#if defined(CONFIG_IEEE802154_SELECTIVE_TXCHANNEL)
                        /* The channel used for timed transmissions.
                         *
                         * Please refer to `ieee802154_radio_api::tx` documentation for
                         * details.
                         */
                        uint8_t txchannel;
#endif /* CONFIG_IEEE802154_SELECTIVE_TXCHANNEL */
                };
        };
 
        /* Flags */
        uint8_t ack_fpb : 1;       /* Frame Pending Bit was set in the ACK */
        uint8_t frame_secured : 1; /* Frame is authenticated and
                                    * encrypted according to its
                                    * Auxiliary Security Header
                                    */
        uint8_t mac_hdr_rdy : 1;   /* Indicates if frame's MAC header
                                    * is ready to be transmitted or if
                                    * it requires further modifications,
                                    * e.g. Frame Counter injection.
                                    */
#if defined(CONFIG_NET_L2_OPENTHREAD)
        uint8_t ack_seb : 1; /* Security Enabled Bit was set in the ACK */
#endif
};
 
struct net_pkt;
static inline void *net_pkt_cb(struct net_pkt *pkt);
 
static inline struct net_pkt_cb_ieee802154 *net_pkt_cb_ieee802154(struct net_pkt *pkt)
{
        return (struct net_pkt_cb_ieee802154 *)net_pkt_cb(pkt);
};
 
static inline uint8_t net_pkt_ieee802154_lqi(struct net_pkt *pkt)
{
        return net_pkt_cb_ieee802154(pkt)->lqi;
}
 
static inline void net_pkt_set_ieee802154_lqi(struct net_pkt *pkt, uint8_t lqi)
{
        net_pkt_cb_ieee802154(pkt)->lqi = lqi;
}
 
static inline uint8_t net_pkt_ieee802154_rssi(struct net_pkt *pkt)
{
        return net_pkt_cb_ieee802154(pkt)->rssi;
}
 
static inline void net_pkt_set_ieee802154_rssi(struct net_pkt *pkt, uint8_t rssi)
{
        net_pkt_cb_ieee802154(pkt)->rssi = rssi;
}
 
static inline int16_t net_pkt_ieee802154_rssi_dbm(struct net_pkt *pkt)
{
        int16_t rssi = net_pkt_cb_ieee802154(pkt)->rssi;
        return rssi == IEEE802154_MAC_RSSI_UNDEFINED ? IEEE802154_MAC_RSSI_DBM_UNDEFINED
                                                     : rssi + IEEE802154_MAC_RSSI_DBM_MIN;
}
 
static inline void net_pkt_set_ieee802154_rssi_dbm(struct net_pkt *pkt, int16_t rssi)
{
        if (likely(rssi >= IEEE802154_MAC_RSSI_DBM_MIN && rssi <= IEEE802154_MAC_RSSI_DBM_MAX)) {
                int16_t unsigned_rssi = rssi - IEEE802154_MAC_RSSI_DBM_MIN;
 
                net_pkt_cb_ieee802154(pkt)->rssi = unsigned_rssi;
                return;
        } else if (rssi == IEEE802154_MAC_RSSI_DBM_UNDEFINED) {
                net_pkt_cb_ieee802154(pkt)->rssi = IEEE802154_MAC_RSSI_UNDEFINED;
                return;
        } else if (rssi < IEEE802154_MAC_RSSI_DBM_MIN) {
                net_pkt_cb_ieee802154(pkt)->rssi = IEEE802154_MAC_RSSI_MIN;
                return;
        } else if (rssi > IEEE802154_MAC_RSSI_DBM_MAX) {
                net_pkt_cb_ieee802154(pkt)->rssi = IEEE802154_MAC_RSSI_MAX;
                return;
        }
 
        CODE_UNREACHABLE;
}
 
#if defined(CONFIG_IEEE802154_SELECTIVE_TXCHANNEL)
static inline uint8_t net_pkt_ieee802154_txchannel(struct net_pkt *pkt)
{
        return net_pkt_cb_ieee802154(pkt)->txchannel;
}
 
static inline void net_pkt_set_ieee802154_txchannel(struct net_pkt *pkt, uint8_t channel)
{
        net_pkt_cb_ieee802154(pkt)->txchannel = channel;
}
#endif /* CONFIG_IEEE802154_SELECTIVE_TXCHANNEL */
 
static inline bool net_pkt_ieee802154_ack_fpb(struct net_pkt *pkt)
{
        return net_pkt_cb_ieee802154(pkt)->ack_fpb;
}
 
static inline void net_pkt_set_ieee802154_ack_fpb(struct net_pkt *pkt, bool fpb)
{
        net_pkt_cb_ieee802154(pkt)->ack_fpb = fpb;
}
 
static inline bool net_pkt_ieee802154_frame_secured(struct net_pkt *pkt)
{
        return net_pkt_cb_ieee802154(pkt)->frame_secured;
}
 
static inline void net_pkt_set_ieee802154_frame_secured(struct net_pkt *pkt, bool secured)
{
        net_pkt_cb_ieee802154(pkt)->frame_secured = secured;
}
 
static inline bool net_pkt_ieee802154_mac_hdr_rdy(struct net_pkt *pkt)
{
        return net_pkt_cb_ieee802154(pkt)->mac_hdr_rdy;
}
 
static inline void net_pkt_set_ieee802154_mac_hdr_rdy(struct net_pkt *pkt, bool rdy)
{
        net_pkt_cb_ieee802154(pkt)->mac_hdr_rdy = rdy;
}
 
#if defined(CONFIG_NET_L2_OPENTHREAD)
static inline uint32_t net_pkt_ieee802154_ack_fc(struct net_pkt *pkt)
{
        return net_pkt_cb_ieee802154(pkt)->ack_fc;
}
 
static inline void net_pkt_set_ieee802154_ack_fc(struct net_pkt *pkt, uint32_t fc)
{
        net_pkt_cb_ieee802154(pkt)->ack_fc = fc;
}
 
static inline uint8_t net_pkt_ieee802154_ack_keyid(struct net_pkt *pkt)
{
        return net_pkt_cb_ieee802154(pkt)->ack_keyid;
}
 
static inline void net_pkt_set_ieee802154_ack_keyid(struct net_pkt *pkt, uint8_t keyid)
{
        net_pkt_cb_ieee802154(pkt)->ack_keyid = keyid;
}
 
static inline bool net_pkt_ieee802154_ack_seb(struct net_pkt *pkt)
{
        return net_pkt_cb_ieee802154(pkt)->ack_seb;
}
 
static inline void net_pkt_set_ieee802154_ack_seb(struct net_pkt *pkt, bool seb)
{
        net_pkt_cb_ieee802154(pkt)->ack_seb = seb;
}
#endif /* CONFIG_NET_L2_OPENTHREAD */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_IEEE802154_PKT_H_ */