/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * An interface between IEEE802.15.4 device and rest of the kernel.
 *
 * Copyright (C) 2007-2012 Siemens AG
 *
 * Written by:
 * Pavel Smolenskiy <pavel.smolenskiy@gmail.com>
 * Maxim Gorbachyov <maxim.gorbachev@siemens.com>
 * Maxim Osipov <maxim.osipov@siemens.com>
 * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
 * Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
 */

#ifndef IEEE802154_NETDEVICE_H
#define IEEE802154_NETDEVICE_H

#define IEEE802154_REQUIRED_SIZE(struct_type, member) \
        (offsetof(typeof(struct_type), member) + \
        sizeof(((typeof(struct_type) *)(NULL))->member))

#define IEEE802154_ADDR_OFFSET \
        offsetof(typeof(struct sockaddr_ieee802154), addr)

#define IEEE802154_MIN_NAMELEN (IEEE802154_ADDR_OFFSET + \
        IEEE802154_REQUIRED_SIZE(struct ieee802154_addr_sa, addr_type))

#define IEEE802154_NAMELEN_SHORT (IEEE802154_ADDR_OFFSET + \
        IEEE802154_REQUIRED_SIZE(struct ieee802154_addr_sa, short_addr))

#define IEEE802154_NAMELEN_LONG (IEEE802154_ADDR_OFFSET + \
        IEEE802154_REQUIRED_SIZE(struct ieee802154_addr_sa, hwaddr))

#include <net/af_ieee802154.h>
#include <linux/netdevice.h>
#include <linux/skbuff.h>
#include <linux/ieee802154.h>

#include <net/cfg802154.h>

struct ieee802154_beacon_hdr {
#if defined(__LITTLE_ENDIAN_BITFIELD)
        u16 beacon_order:4,
            superframe_order:4,
            final_cap_slot:4,
            battery_life_ext:1,
            reserved0:1,
            pan_coordinator:1,
            assoc_permit:1;
        u8  gts_count:3,
            gts_reserved:4,
            gts_permit:1;
        u8  pend_short_addr_count:3,
            reserved1:1,
            pend_ext_addr_count:3,
            reserved2:1;
#elif defined(__BIG_ENDIAN_BITFIELD)
        u16 assoc_permit:1,
            pan_coordinator:1,
            reserved0:1,
            battery_life_ext:1,
            final_cap_slot:4,
            superframe_order:4,
            beacon_order:4;
        u8  gts_permit:1,
            gts_reserved:4,
            gts_count:3;
        u8  reserved2:1,
            pend_ext_addr_count:3,
            reserved1:1,
            pend_short_addr_count:3;
#else
#error  "Please fix <asm/byteorder.h>"
#endif
} __packed;

struct ieee802154_mac_cmd_pl {
        u8  cmd_id;
} __packed;

struct ieee802154_sechdr {
#if defined(__LITTLE_ENDIAN_BITFIELD)
        u8 level:3,
           key_id_mode:2,
           reserved:3;
#elif defined(__BIG_ENDIAN_BITFIELD)
        u8 reserved:3,
           key_id_mode:2,
           level:3;
#else
#error  "Please fix <asm/byteorder.h>"
#endif
        u8 key_id;
        __le32 frame_counter;
        union {
                __le32 short_src;
                __le64 extended_src;
        };
};

struct ieee802154_hdr_fc {
#if defined(__LITTLE_ENDIAN_BITFIELD)
        u16 type:3,
            security_enabled:1,
            frame_pending:1,
            ack_request:1,
            intra_pan:1,
            reserved:3,
            dest_addr_mode:2,
            version:2,
            source_addr_mode:2;
#elif defined(__BIG_ENDIAN_BITFIELD)
        u16 reserved:1,
            intra_pan:1,
            ack_request:1,
            frame_pending:1,
            security_enabled:1,
            type:3,
            source_addr_mode:2,
            version:2,
            dest_addr_mode:2,
            reserved2:2;
#else
#error  "Please fix <asm/byteorder.h>"
#endif
};

struct ieee802154_assoc_req_pl {
#if defined(__LITTLE_ENDIAN_BITFIELD)
        u8 reserved1:1,
           device_type:1,
           power_source:1,
           rx_on_when_idle:1,
           assoc_type:1,
           reserved2:1,
           security_cap:1,
           alloc_addr:1;
#elif defined(__BIG_ENDIAN_BITFIELD)
        u8 alloc_addr:1,
           security_cap:1,
           reserved2:1,
           assoc_type:1,
           rx_on_when_idle:1,
           power_source:1,
           device_type:1,
           reserved1:1;
#else
#error  "Please fix <asm/byteorder.h>"
#endif
} __packed;

struct ieee802154_assoc_resp_pl {
        __le16 short_addr;
        u8 status;
} __packed;

enum ieee802154_frame_version {
        IEEE802154_2003_STD,
        IEEE802154_2006_STD,
        IEEE802154_STD,
        IEEE802154_RESERVED_STD,
        IEEE802154_MULTIPURPOSE_STD = IEEE802154_2003_STD,
};

enum ieee802154_addressing_mode {
        IEEE802154_NO_ADDRESSING,
        IEEE802154_RESERVED,
        IEEE802154_SHORT_ADDRESSING,
        IEEE802154_EXTENDED_ADDRESSING,
};

enum ieee802154_association_status {
        IEEE802154_ASSOCIATION_SUCCESSFUL = 0x00,
        IEEE802154_PAN_AT_CAPACITY = 0x01,
        IEEE802154_PAN_ACCESS_DENIED = 0x02,
        IEEE802154_HOPPING_SEQUENCE_OFFSET_DUP = 0x03,
        IEEE802154_FAST_ASSOCIATION_SUCCESSFUL = 0x80,
};

enum ieee802154_disassociation_reason {
        IEEE802154_COORD_WISHES_DEVICE_TO_LEAVE = 0x1,
        IEEE802154_DEVICE_WISHES_TO_LEAVE = 0x2,
};

struct ieee802154_hdr {
        struct ieee802154_hdr_fc fc;
        u8 seq;
        struct ieee802154_addr source;
        struct ieee802154_addr dest;
        struct ieee802154_sechdr sec;
};

struct ieee802154_beacon_frame {
        struct ieee802154_hdr mhr;
        struct ieee802154_beacon_hdr mac_pl;
};

struct ieee802154_mac_cmd_frame {
        struct ieee802154_hdr mhr;
        struct ieee802154_mac_cmd_pl mac_pl;
};

struct ieee802154_beacon_req_frame {
        struct ieee802154_hdr mhr;
        struct ieee802154_mac_cmd_pl mac_pl;
};

struct ieee802154_association_req_frame {
        struct ieee802154_hdr mhr;
        struct ieee802154_mac_cmd_pl mac_pl;
        struct ieee802154_assoc_req_pl assoc_req_pl;
};

struct ieee802154_association_resp_frame {
        struct ieee802154_hdr mhr;
        struct ieee802154_mac_cmd_pl mac_pl;
        struct ieee802154_assoc_resp_pl assoc_resp_pl;
};

struct ieee802154_disassociation_notif_frame {
        struct ieee802154_hdr mhr;
        struct ieee802154_mac_cmd_pl mac_pl;
        u8 disassoc_pl;
};

/* pushes hdr onto the skb. fields of hdr->fc that can be calculated from
 * the contents of hdr will be, and the actual value of those bits in
 * hdr->fc will be ignored. this includes the INTRA_PAN bit and the frame
 * version, if SECEN is set.
 */
int ieee802154_hdr_push(struct sk_buff *skb, struct ieee802154_hdr *hdr);

/* pulls the entire 802.15.4 header off of the skb, including the security
 * header, and performs pan id decompression
 */
int ieee802154_hdr_pull(struct sk_buff *skb, struct ieee802154_hdr *hdr);

/* parses the frame control, sequence number of address fields in a given skb
 * and stores them into hdr, performing pan id decompression and length checks
 * to be suitable for use in header_ops.parse
 */
int ieee802154_hdr_peek_addrs(const struct sk_buff *skb,
                              struct ieee802154_hdr *hdr);

/* parses the full 802.15.4 header a given skb and stores them into hdr,
 * performing pan id decompression and length checks to be suitable for use in
 * header_ops.parse
 */
int ieee802154_hdr_peek(const struct sk_buff *skb, struct ieee802154_hdr *hdr);

/* pushes/pulls various frame types into/from an skb */
int ieee802154_beacon_push(struct sk_buff *skb,
                           struct ieee802154_beacon_frame *beacon);
int ieee802154_mac_cmd_push(struct sk_buff *skb, void *frame,
                            const void *pl, unsigned int pl_len);
int ieee802154_mac_cmd_pl_pull(struct sk_buff *skb,
                               struct ieee802154_mac_cmd_pl *mac_pl);

int ieee802154_max_payload(const struct ieee802154_hdr *hdr);

static inline int
ieee802154_sechdr_authtag_len(const struct ieee802154_sechdr *sec)
{
        switch (sec->level) {
        case IEEE802154_SCF_SECLEVEL_MIC32:
        case IEEE802154_SCF_SECLEVEL_ENC_MIC32:
                return 4;
        case IEEE802154_SCF_SECLEVEL_MIC64:
        case IEEE802154_SCF_SECLEVEL_ENC_MIC64:
                return 8;
        case IEEE802154_SCF_SECLEVEL_MIC128:
        case IEEE802154_SCF_SECLEVEL_ENC_MIC128:
                return 16;
        case IEEE802154_SCF_SECLEVEL_NONE:
        case IEEE802154_SCF_SECLEVEL_ENC:
        default:
                return 0;
        }
}

static inline int ieee802154_hdr_length(struct sk_buff *skb)
{
        struct ieee802154_hdr hdr;
        int len = ieee802154_hdr_pull(skb, &hdr);

        if (len > 0)
                skb_push(skb, len);

        return len;
}

static inline bool ieee802154_addr_equal(const struct ieee802154_addr *a1,
                                         const struct ieee802154_addr *a2)
{
        if (a1->pan_id != a2->pan_id || a1->mode != a2->mode)
                return false;

        if ((a1->mode == IEEE802154_ADDR_LONG &&
             a1->extended_addr != a2->extended_addr) ||
            (a1->mode == IEEE802154_ADDR_SHORT &&
             a1->short_addr != a2->short_addr))
                return false;

        return true;
}

static inline __le64 ieee802154_devaddr_from_raw(const void *raw)
{
        u64 temp;

        memcpy(&temp, raw, IEEE802154_ADDR_LEN);
        return (__force __le64)swab64(temp);
}

static inline void ieee802154_devaddr_to_raw(void *raw, __le64 addr)
{
        u64 temp = swab64((__force u64)addr);

        memcpy(raw, &temp, IEEE802154_ADDR_LEN);
}

static inline int
ieee802154_sockaddr_check_size(struct sockaddr_ieee802154 *daddr, int len)
{
        struct ieee802154_addr_sa *sa;
        int ret = 0;

        sa = &daddr->addr;
        if (len < IEEE802154_MIN_NAMELEN)
                return -EINVAL;
        switch (sa->addr_type) {
        case IEEE802154_ADDR_NONE:
                break;
        case IEEE802154_ADDR_SHORT:
                if (len < IEEE802154_NAMELEN_SHORT)
                        ret = -EINVAL;
                break;
        case IEEE802154_ADDR_LONG:
                if (len < IEEE802154_NAMELEN_LONG)
                        ret = -EINVAL;
                break;
        default:
                ret = -EINVAL;
                break;
        }
        return ret;
}

static inline void ieee802154_addr_from_sa(struct ieee802154_addr *a,
                                           const struct ieee802154_addr_sa *sa)
{
        a->mode = sa->addr_type;
        a->pan_id = cpu_to_le16(sa->pan_id);

        switch (a->mode) {
        case IEEE802154_ADDR_SHORT:
                a->short_addr = cpu_to_le16(sa->short_addr);
                break;
        case IEEE802154_ADDR_LONG:
                a->extended_addr = ieee802154_devaddr_from_raw(sa->hwaddr);
                break;
        }
}

static inline void ieee802154_addr_to_sa(struct ieee802154_addr_sa *sa,
                                         const struct ieee802154_addr *a)
{
        sa->addr_type = a->mode;
        sa->pan_id = le16_to_cpu(a->pan_id);

        switch (a->mode) {
        case IEEE802154_ADDR_SHORT:
                sa->short_addr = le16_to_cpu(a->short_addr);
                break;
        case IEEE802154_ADDR_LONG:
                ieee802154_devaddr_to_raw(sa->hwaddr, a->extended_addr);
                break;
        }
}

/*
 * A control block of skb passed between the ARPHRD_IEEE802154 device
 * and other stack parts.
 */
struct ieee802154_mac_cb {
        u8 lqi;
        u8 type;
        bool ackreq;
        bool secen;
        bool secen_override;
        u8 seclevel;
        bool seclevel_override;
        struct ieee802154_addr source;
        struct ieee802154_addr dest;
};

static inline struct ieee802154_mac_cb *mac_cb(struct sk_buff *skb)
{
        return (struct ieee802154_mac_cb *)skb->cb;
}

static inline struct ieee802154_mac_cb *mac_cb_init(struct sk_buff *skb)
{
        BUILD_BUG_ON(sizeof(struct ieee802154_mac_cb) > sizeof(skb->cb));

        memset(skb->cb, 0, sizeof(struct ieee802154_mac_cb));
        return mac_cb(skb);
}

enum {
        IEEE802154_LLSEC_DEVKEY_IGNORE,
        IEEE802154_LLSEC_DEVKEY_RESTRICT,
        IEEE802154_LLSEC_DEVKEY_RECORD,

        __IEEE802154_LLSEC_DEVKEY_MAX,
};

#define IEEE802154_MAC_SCAN_ED          0
#define IEEE802154_MAC_SCAN_ACTIVE      1
#define IEEE802154_MAC_SCAN_PASSIVE     2
#define IEEE802154_MAC_SCAN_ORPHAN      3

struct ieee802154_mac_params {
        s8 transmit_power;
        u8 min_be;
        u8 max_be;
        u8 csma_retries;
        s8 frame_retries;

        bool lbt;
        struct wpan_phy_cca cca;
        s32 cca_ed_level;
};

struct wpan_phy;

enum {
        IEEE802154_LLSEC_PARAM_ENABLED          = BIT(0),
        IEEE802154_LLSEC_PARAM_FRAME_COUNTER    = BIT(1),
        IEEE802154_LLSEC_PARAM_OUT_LEVEL        = BIT(2),
        IEEE802154_LLSEC_PARAM_OUT_KEY          = BIT(3),
        IEEE802154_LLSEC_PARAM_KEY_SOURCE       = BIT(4),
        IEEE802154_LLSEC_PARAM_PAN_ID           = BIT(5),
        IEEE802154_LLSEC_PARAM_HWADDR           = BIT(6),
        IEEE802154_LLSEC_PARAM_COORD_HWADDR     = BIT(7),
        IEEE802154_LLSEC_PARAM_COORD_SHORTADDR  = BIT(8),
};

struct ieee802154_llsec_ops {
        int (*get_params)(struct net_device *dev,
                          struct ieee802154_llsec_params *params);
        int (*set_params)(struct net_device *dev,
                          const struct ieee802154_llsec_params *params,
                          int changed);

        int (*add_key)(struct net_device *dev,
                       const struct ieee802154_llsec_key_id *id,
                       const struct ieee802154_llsec_key *key);
        int (*del_key)(struct net_device *dev,
                       const struct ieee802154_llsec_key_id *id);

        int (*add_dev)(struct net_device *dev,
                       const struct ieee802154_llsec_device *llsec_dev);
        int (*del_dev)(struct net_device *dev, __le64 dev_addr);

        int (*add_devkey)(struct net_device *dev,
                          __le64 device_addr,
                          const struct ieee802154_llsec_device_key *key);
        int (*del_devkey)(struct net_device *dev,
                          __le64 device_addr,
                          const struct ieee802154_llsec_device_key *key);

        int (*add_seclevel)(struct net_device *dev,
                            const struct ieee802154_llsec_seclevel *sl);
        int (*del_seclevel)(struct net_device *dev,
                            const struct ieee802154_llsec_seclevel *sl);

        void (*lock_table)(struct net_device *dev);
        void (*get_table)(struct net_device *dev,
                          struct ieee802154_llsec_table **t);
        void (*unlock_table)(struct net_device *dev);
};
/*
 * This should be located at net_device->ml_priv
 *
 * get_phy should increment the reference counting on returned phy.
 * Use wpan_wpy_put to put that reference.
 */
struct ieee802154_mlme_ops {
        /* The following fields are optional (can be NULL). */

        int (*assoc_req)(struct net_device *dev,
                        struct ieee802154_addr *addr,
                        u8 channel, u8 page, u8 cap);
        int (*assoc_resp)(struct net_device *dev,
                        struct ieee802154_addr *addr,
                        __le16 short_addr, u8 status);
        int (*disassoc_req)(struct net_device *dev,
                        struct ieee802154_addr *addr,
                        u8 reason);
        int (*start_req)(struct net_device *dev,
                        struct ieee802154_addr *addr,
                        u8 channel, u8 page, u8 bcn_ord, u8 sf_ord,
                        u8 pan_coord, u8 blx, u8 coord_realign);
        int (*scan_req)(struct net_device *dev,
                        u8 type, u32 channels, u8 page, u8 duration);

        int (*set_mac_params)(struct net_device *dev,
                              const struct ieee802154_mac_params *params);
        void (*get_mac_params)(struct net_device *dev,
                               struct ieee802154_mac_params *params);

        const struct ieee802154_llsec_ops *llsec;
};

static inline struct ieee802154_mlme_ops *
ieee802154_mlme_ops(const struct net_device *dev)
{
        return dev->ml_priv;
}

#endif