ieee802154_ie.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Florian Grandel, Zephyr Project.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_IEEE802154_IE_H_
#define ZEPHYR_INCLUDE_NET_IEEE802154_IE_H_
 
#include <zephyr/net/buf.h>
#include <zephyr/sys/byteorder.h>
 
enum ieee802154_ie_type {
        IEEE802154_IE_TYPE_HEADER = 0x0,
        IEEE802154_IE_TYPE_PAYLOAD,
};
 
enum ieee802154_header_ie_element_id {
        IEEE802154_HEADER_IE_ELEMENT_ID_VENDOR_SPECIFIC_IE = 0x00,
        IEEE802154_HEADER_IE_ELEMENT_ID_CSL_IE = 0x1a,
        IEEE802154_HEADER_IE_ELEMENT_ID_RIT_IE = 0x1b,
        IEEE802154_HEADER_IE_ELEMENT_ID_RENDEZVOUS_TIME_IE = 0x1d,
        IEEE802154_HEADER_IE_ELEMENT_ID_TIME_CORRECTION_IE = 0x1e,
        IEEE802154_HEADER_IE_ELEMENT_ID_HEADER_TERMINATION_1 = 0x7e,
        IEEE802154_HEADER_IE_ELEMENT_ID_HEADER_TERMINATION_2 = 0x7f,
        /* partial list, add additional ids as needed */
};
 
#define IEEE802154_VENDOR_SPECIFIC_IE_OUI_LEN 3
struct ieee802154_header_ie_vendor_specific {
        uint8_t vendor_oui[IEEE802154_VENDOR_SPECIFIC_IE_OUI_LEN];
        uint8_t *vendor_specific_info;
} __packed;
 
struct ieee802154_header_ie_csl_full {
        uint16_t csl_phase;
        uint16_t csl_period;
        uint16_t csl_rendezvous_time;
} __packed;
 
struct ieee802154_header_ie_csl_reduced {
        uint16_t csl_phase;
        uint16_t csl_period;
} __packed;
 
struct ieee802154_header_ie_csl {
        union {
                struct ieee802154_header_ie_csl_full full;
                struct ieee802154_header_ie_csl_reduced reduced;
        };
} __packed;
 
struct ieee802154_header_ie_rit {
        uint8_t time_to_first_listen;
        uint8_t number_of_repeat_listen;
        uint16_t repeat_listen_interval;
} __packed;
 
struct ieee802154_header_ie_rendezvous_time_full {
        uint16_t rendezvous_time;
        uint16_t wakeup_interval;
} __packed;
 
struct ieee802154_header_ie_rendezvous_time_reduced {
        uint16_t rendezvous_time;
} __packed;
 
struct ieee802154_header_ie_rendezvous_time {
        union {
                struct ieee802154_header_ie_rendezvous_time_full full;
                struct ieee802154_header_ie_rendezvous_time_reduced reduced;
        };
} __packed;
 
struct ieee802154_header_ie_time_correction {
        uint16_t time_sync_info;
} __packed;
 
/* @brief Generic Header IE, see section 7.4.2.1. */
struct ieee802154_header_ie {
#if CONFIG_LITTLE_ENDIAN
        uint16_t length : 7;
        uint16_t element_id_low : 1; /* see enum ieee802154_header_ie_element_id */
        uint16_t element_id_high : 7;
        uint16_t type : 1; /* always 0 */
#else
        uint16_t element_id_low : 1; /* see enum ieee802154_header_ie_element_id */
        uint16_t length : 7;
        uint16_t type : 1; /* always 0 */
        uint16_t element_id_high : 7;
#endif
        union {
                struct ieee802154_header_ie_vendor_specific vendor_specific;
                struct ieee802154_header_ie_csl csl;
                struct ieee802154_header_ie_rit rit;
                struct ieee802154_header_ie_rendezvous_time rendezvous_time;
                struct ieee802154_header_ie_time_correction time_correction;
                /* add additional supported header IEs here */
        } content;
} __packed;
 
#define IEEE802154_HEADER_IE_HEADER_LENGTH sizeof(uint16_t)
 
 
#define IEEE802154_DEFINE_HEADER_IE(_element_id, _length, _content, _content_type)                 \
        (struct ieee802154_header_ie) {                                                            \
                .length = (_length),                                                               \
                .element_id_high = (_element_id) >> 1U, .element_id_low = (_element_id) & 0x01,    \
                .type = IEEE802154_IE_TYPE_HEADER,                                                 \
                .content._content_type = _content,                                                 \
        }
 
#define IEEE802154_DEFINE_HEADER_IE_VENDOR_SPECIFIC_CONTENT_LEN(_vendor_specific_info_len)         \
        (IEEE802154_VENDOR_SPECIFIC_IE_OUI_LEN + (_vendor_specific_info_len))
 
#define IEEE802154_DEFINE_HEADER_IE_VENDOR_SPECIFIC_CONTENT(_vendor_oui, _vendor_specific_info)    \
        (struct ieee802154_header_ie_vendor_specific) {                                            \
                .vendor_oui = _vendor_oui, .vendor_specific_info = (_vendor_specific_info),        \
        }
 
#define IEEE802154_DEFINE_HEADER_IE_CSL_REDUCED_CONTENT(_csl_phase, _csl_period)                   \
        (struct ieee802154_header_ie_csl_reduced) {                                                \
                .csl_phase = sys_cpu_to_le16(_csl_phase),                                          \
                .csl_period = sys_cpu_to_le16(_csl_period),                                        \
        }
 
#define IEEE802154_DEFINE_HEADER_IE_CSL_FULL_CONTENT(_csl_phase, _csl_period,                      \
                                                     _csl_rendezvous_time)                         \
        (struct ieee802154_header_ie_csl_full) {                                                   \
                .csl_phase = sys_cpu_to_le16(_csl_phase),                                          \
                .csl_period = sys_cpu_to_le16(_csl_period),                                        \
                .csl_rendezvous_time = sys_cpu_to_le16(_csl_rendezvous_time),                      \
        }
 
#define IEEE802154_HEADER_IE_TIME_CORRECTION_NACK          0x8000
#define IEEE802154_HEADER_IE_TIME_CORRECTION_MASK          0x0fff
#define IEEE802154_HEADER_IE_TIME_CORRECTION_SIGN_BIT_MASK 0x0800
 
#define IEEE802154_DEFINE_HEADER_IE_TIME_CORRECTION_CONTENT(_ack, _time_correction_us)             \
        (struct ieee802154_header_ie_time_correction) {                                            \
                .time_sync_info = sys_cpu_to_le16(                                                 \
                        (!(_ack) * IEEE802154_HEADER_IE_TIME_CORRECTION_NACK) |                    \
                        ((_time_correction_us) & IEEE802154_HEADER_IE_TIME_CORRECTION_MASK)),      \
        }
#define IEEE802154_DEFINE_HEADER_IE_VENDOR_SPECIFIC(_vendor_oui, _vendor_specific_info,            \
                                                    _vendor_specific_info_len)                     \
        IEEE802154_DEFINE_HEADER_IE(IEEE802154_HEADER_IE_ELEMENT_ID_VENDOR_SPECIFIC_IE,            \
                                    IEEE802154_DEFINE_HEADER_IE_VENDOR_SPECIFIC_CONTENT_LEN(       \
                                            _vendor_specific_info_len),                            \
                                    IEEE802154_DEFINE_HEADER_IE_VENDOR_SPECIFIC_CONTENT(           \
                                            _vendor_oui, _vendor_specific_info),                   \
                                    vendor_specific)
 
#define IEEE802154_DEFINE_HEADER_IE_CSL_REDUCED(_csl_phase, _csl_period)                           \
        IEEE802154_DEFINE_HEADER_IE(                                                               \
                IEEE802154_HEADER_IE_ELEMENT_ID_CSL_IE,                                            \
                sizeof(struct ieee802154_header_ie_csl_reduced),                                   \
                IEEE802154_DEFINE_HEADER_IE_CSL_REDUCED_CONTENT(_csl_phase, _csl_period),          \
                csl.reduced)
 
#define IEEE802154_DEFINE_HEADER_IE_CSL_FULL(_csl_phase, _csl_period, _csl_rendezvous_time)        \
        IEEE802154_DEFINE_HEADER_IE(IEEE802154_HEADER_IE_ELEMENT_ID_CSL_IE,                        \
                                    sizeof(struct ieee802154_header_ie_csl_full),                  \
                                    IEEE802154_DEFINE_HEADER_IE_CSL_FULL_CONTENT(                  \
                                            _csl_phase, _csl_period, _csl_rendezvous_time),        \
                                    csl.full)
 
#define IEEE802154_DEFINE_HEADER_IE_TIME_CORRECTION(_ack, _time_correction_us)                     \
        IEEE802154_DEFINE_HEADER_IE(                                                               \
                IEEE802154_HEADER_IE_ELEMENT_ID_TIME_CORRECTION_IE,                                \
                sizeof(struct ieee802154_header_ie_time_correction),                               \
                IEEE802154_DEFINE_HEADER_IE_TIME_CORRECTION_CONTENT(_ack, _time_correction_us),    \
                time_correction)
 
static inline int16_t
ieee802154_header_ie_get_time_correction_us(struct ieee802154_header_ie_time_correction *ie)
{
        if (ie->time_sync_info & IEEE802154_HEADER_IE_TIME_CORRECTION_SIGN_BIT_MASK) {
                /* Negative integer */
                return (int16_t)ie->time_sync_info | ~IEEE802154_HEADER_IE_TIME_CORRECTION_MASK;
        }
 
        /* Positive integer */
        return (int16_t)ie->time_sync_info & IEEE802154_HEADER_IE_TIME_CORRECTION_MASK;
}
 
static inline void ieee802154_header_ie_set_element_id(struct ieee802154_header_ie *ie,
                                                       uint8_t element_id)
{
        ie->element_id_high = element_id >> 1U;
        ie->element_id_low = element_id & 0x01;
}
 
static inline uint8_t ieee802154_header_ie_get_element_id(struct ieee802154_header_ie *ie)
{
        return (ie->element_id_high << 1U) | ie->element_id_low;
}
 
#define IEEE802154_TIME_CORRECTION_HEADER_IE_LEN                                                   \
        (IEEE802154_HEADER_IE_HEADER_LENGTH + sizeof(struct ieee802154_header_ie_time_correction))
 
#define IEEE802154_HEADER_TERMINATION_1_HEADER_IE_LEN IEEE802154_HEADER_IE_HEADER_LENGTH
 
#endif /* ZEPHYR_INCLUDE_NET_IEEE802154_IE_H_ */