/*      $NetBSD: ieee80211_proto.h,v 1.24 2021/07/24 21:31:38 andvar Exp $      */
/*-
 * Copyright (c) 2001 Atsushi Onoe
 * Copyright (c) 2002-2005 Sam Leffler, Errno Consulting
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * $FreeBSD: src/sys/net80211/ieee80211_proto.h,v 1.16 2005/08/13 17:31:48 sam Exp $
 */
#ifndef _NET80211_IEEE80211_PROTO_H_
#define _NET80211_IEEE80211_PROTO_H_

/*
 * 802.11 protocol implementation definitions.
 */

enum ieee80211_state {
        IEEE80211_S_INIT        = 0,    /* default state */
        IEEE80211_S_SCAN        = 1,    /* scanning */
        IEEE80211_S_AUTH        = 2,    /* try to authenticate */
        IEEE80211_S_ASSOC       = 3,    /* try to assoc */
        IEEE80211_S_RUN         = 4     /* associated */
};
#define IEEE80211_S_MAX         ((int)IEEE80211_S_RUN + 1)

#define IEEE80211_SEND_MGMT(_ic,_ni,_type,_arg) \
        ((*(_ic)->ic_send_mgmt)(_ic, _ni, _type, _arg))

extern  const char *ieee80211_mgt_subtype_name[];
extern  const char *ieee80211_phymode_name[];

void    ieee80211_proto_attach(struct ieee80211com *);
void    ieee80211_proto_detach(struct ieee80211com *);

struct ieee80211_node;
int     ieee80211_input(struct ieee80211com *, struct mbuf *,
                struct ieee80211_node *, int, u_int32_t);
int     ieee80211_setup_rates(struct ieee80211_node *ni,
                const u_int8_t *rates, const u_int8_t *xrates, int flags);
void    ieee80211_saveie(u_int8_t **, const u_int8_t *);
void    ieee80211_recv_mgmt(struct ieee80211com *, struct mbuf *,
                struct ieee80211_node *, int, int, u_int32_t);
int     ieee80211_send_nulldata(struct ieee80211_node *);
int     ieee80211_send_probereq(struct ieee80211_node *ni,
                const u_int8_t sa[IEEE80211_ADDR_LEN],
                const u_int8_t da[IEEE80211_ADDR_LEN],
                const u_int8_t bssid[IEEE80211_ADDR_LEN],
                const u_int8_t *ssid, size_t ssidlen,
                const void *optie, size_t optielen);
int     ieee80211_send_mgmt(struct ieee80211com *, struct ieee80211_node *,
                int, int);
int     ieee80211_classify(struct ieee80211com *, struct mbuf *,
                struct ieee80211_node *);
struct mbuf *ieee80211_encap(struct ieee80211com *, struct mbuf *,
                struct ieee80211_node *);
struct mbuf *ieee80211_get_rts(struct ieee80211com *,
                const struct ieee80211_frame *, uint16_t);
struct mbuf *ieee80211_get_cts_to_self(struct ieee80211com *,
                uint16_t);
void    ieee80211_pwrsave(struct ieee80211com *, struct ieee80211_node *,
                struct mbuf *);

u_int8_t *ieee80211_add_rates(u_int8_t *, const struct ieee80211_rateset *);
u_int8_t *ieee80211_add_xrates(u_int8_t *, const struct ieee80211_rateset *);
u_int8_t *ieee80211_add_ssid(u_int8_t *, const u_int8_t *, u_int);
u_int8_t *ieee80211_add_wpa(u_int8_t *, struct ieee80211com *);
struct ieee80211_wme_state;
u_int8_t *ieee80211_add_wme_info(u_int8_t *, struct ieee80211_wme_state *);

void    ieee80211_reset_erp(struct ieee80211com *);
void    ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
int     ieee80211_iserp_rateset(struct ieee80211com *,
                struct ieee80211_rateset *);
void    ieee80211_set11gbasicrates(struct ieee80211_rateset *,
                enum ieee80211_phymode);

/*
 * Return the size of the 802.11 header for a management or data frame.
 */
static __inline int
ieee80211_hdrsize(const void *data)
{
        const struct ieee80211_frame *wh = data;
        int size = sizeof(struct ieee80211_frame);

        /* NB: we don't handle control frames */
        IASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
                ("%s: control frame", __func__));
        if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS)
                size += IEEE80211_ADDR_LEN;
        if (ieee80211_has_qos(wh))
                size += sizeof(u_int16_t);
        return size;
}

/*
 * Return the size of the 802.11 header; handles any type of frame.
 */
static __inline int
ieee80211_anyhdrsize(const void *data)
{
        const struct ieee80211_frame *wh = data;

        if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
                switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
                case IEEE80211_FC0_SUBTYPE_CTS:
                case IEEE80211_FC0_SUBTYPE_ACK:
                        return sizeof(struct ieee80211_frame_ack);
                }
                return sizeof(struct ieee80211_frame_min);
        } else
                return ieee80211_hdrsize(data);
}

/*
 * Template for an in-kernel authenticator.  Authenticators
 * register with the protocol code and are typically loaded
 * as separate modules as needed.
 */
struct ieee80211_authenticator {
        const char *ia_name;            /* printable name */
        int     (*ia_attach)(struct ieee80211com *);
        void    (*ia_detach)(struct ieee80211com *);
        void    (*ia_node_join)(struct ieee80211com *,
                                struct ieee80211_node *);
        void    (*ia_node_leave)(struct ieee80211com *,
                                struct ieee80211_node *);
};
void    ieee80211_authenticator_register(int type,
                const struct ieee80211_authenticator *);
void    ieee80211_authenticator_unregister(int type);
const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);

struct ieee80211req;
/*
 * Template for an MAC ACL policy module.  Such modules
 * register with the protocol code and are passed the sender's
 * address of each received frame for validation.
 */
struct ieee80211_aclator {
        const char *iac_name;           /* printable name */
        int     (*iac_attach)(struct ieee80211com *);
        void    (*iac_detach)(struct ieee80211com *);
        int     (*iac_check)(struct ieee80211com *,
                        const u_int8_t mac[IEEE80211_ADDR_LEN]);
        int     (*iac_add)(struct ieee80211com *,
                        const u_int8_t mac[IEEE80211_ADDR_LEN]);
        int     (*iac_remove)(struct ieee80211com *,
                        const u_int8_t mac[IEEE80211_ADDR_LEN]);
        int     (*iac_flush)(struct ieee80211com *);
        int     (*iac_setpolicy)(struct ieee80211com *, int);
        int     (*iac_getpolicy)(struct ieee80211com *);
        int     (*iac_setioctl)(struct ieee80211com *, struct ieee80211req *);
        int     (*iac_getioctl)(struct ieee80211com *, struct ieee80211req *);
};
void    ieee80211_aclator_register(const struct ieee80211_aclator *);
void    ieee80211_aclator_unregister(const struct ieee80211_aclator *);
const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);

/* flags for ieee80211_fix_rate() */
#define IEEE80211_R_DOSORT      0x00000001      /* sort rate list */
#define IEEE80211_R_DOFRATE     0x00000002      /* use fixed rate */
#define IEEE80211_R_DONEGO      0x00000004      /* calc negotiated rate */
#define IEEE80211_R_DODEL       0x00000008      /* delete ignore rate */
int     ieee80211_fix_rate(struct ieee80211_node *, int);

/*
 * WME/WMM support.
 */
struct wmeParams {
        u_int8_t        wmep_acm;
        u_int8_t        wmep_aifsn;
        u_int8_t        wmep_logcwmin;          /* log2(cwmin) */
        u_int8_t        wmep_logcwmax;          /* log2(cwmax) */
        u_int8_t        wmep_txopLimit;
        u_int8_t        wmep_noackPolicy;       /* 0 (ack), 1 (no ack) */
};
#define IEEE80211_TXOP_TO_US(_txop)     ((_txop)<<5)
#define IEEE80211_US_TO_TXOP(_us)       ((_us)>>5)

struct chanAccParams {
        u_int8_t        cap_info;               /* version of the current set */
        struct wmeParams cap_wmeParams[WME_NUM_AC];
};

struct ieee80211_wme_state {
        u_int   wme_flags;
#define WME_F_AGGRMODE  0x00000001      /* STATUS: WME aggressive mode */
        u_int   wme_hipri_traffic;      /* VI/VO frames in beacon interval */
        u_int   wme_hipri_switch_thresh;/* aggressive mode switch thresh */
        u_int   wme_hipri_switch_hysteresis;/* aggressive mode switch hysteresis */

        struct wmeParams wme_params[4];         /* from assoc resp for each AC*/
        struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
        struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
        struct chanAccParams wme_chanParams;    /* params applied to self */
        struct chanAccParams wme_bssChanParams; /* params bcast to stations */

        int     (*wme_update)(struct ieee80211com *);
};

void    ieee80211_wme_initparams(struct ieee80211com *);
void    ieee80211_wme_updateparams(struct ieee80211com *);
void    ieee80211_wme_updateparams_locked(struct ieee80211com *);

#define ieee80211_new_state(_ic, _nstate, _arg) \
        (((_ic)->ic_newstate)((_ic), (_nstate), (_arg)))
int     ieee80211_compute_duration(const struct ieee80211_frame_min *,
                const struct ieee80211_key *, int,
                uint32_t, int, int, struct ieee80211_duration *,
                struct ieee80211_duration *, int *, int);
void    ieee80211_beacon_miss(struct ieee80211com *);
void    ieee80211_print_essid(const u_int8_t *, int);
void    ieee80211_dump_pkt(const u_int8_t *, int, int, int);

extern  const char *ieee80211_state_name[IEEE80211_S_MAX];
extern  const char *ieee80211_wme_acnames[];

/*
 * Beacon frames constructed by ieee80211_beacon_alloc
 * have the following structure filled in so drivers
 * can update the frame later w/ minimal overhead.
 */
struct ieee80211_beacon_offsets {
        u_int16_t       *bo_caps;       /* capabilities */
        u_int8_t        *bo_tim;        /* start of atim/dtim */
        u_int8_t        *bo_wme;        /* start of WME parameters */
        u_int8_t        *bo_trailer;    /* start of fixed-size trailer */
        u_int16_t       bo_tim_len;     /* atim/dtim length in bytes */
        u_int16_t       bo_trailer_len; /* trailer length in bytes */
};
struct mbuf *ieee80211_beacon_alloc(struct ieee80211com *,
                struct ieee80211_node *, struct ieee80211_beacon_offsets *);
int     ieee80211_beacon_update(struct ieee80211com *,
                struct ieee80211_node *, struct ieee80211_beacon_offsets *,
                struct mbuf *, int broadcast);

/*
 * Notification methods called from the 802.11 state machine.
 * Note that while these are defined here, their implementation
 * is OS-specific.
 */
void    ieee80211_notify_node_join(struct ieee80211com *,
                struct ieee80211_node *, int newassoc);
void    ieee80211_notify_node_leave(struct ieee80211com *,
                struct ieee80211_node *);
void    ieee80211_notify_scan_done(struct ieee80211com *);

#endif /* !_NET80211_IEEE80211_PROTO_H_ */