sys/net80211/ieee80211_proto.h

   1 /*-
   2  * Copyright (c) 2001 Atsushi Onoe
   3  * Copyright (c) 2002-2005 Sam Leffler, Errno Consulting
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission.
  16  *
  17  * Alternatively, this software may be distributed under the terms of the
  18  * GNU General Public License ("GPL") version 2 as published by the Free
  19  * Software Foundation.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  * $FreeBSD$
  33  */
  34 #ifndef _NET80211_IEEE80211_PROTO_H_
  35 #define _NET80211_IEEE80211_PROTO_H_
  36
  37 /*
  38  * 802.11 protocol implementation definitions.
  39  */
  40
  41 enum ieee80211_state {
  42         IEEE80211_S_INIT        = 0,    /* default state */
  43         IEEE80211_S_SCAN        = 1,    /* scanning */
  44         IEEE80211_S_AUTH        = 2,    /* try to authenticate */
  45         IEEE80211_S_ASSOC       = 3,    /* try to assoc */
  46         IEEE80211_S_RUN         = 4,    /* associated */
  47 };
  48 #define IEEE80211_S_MAX         (IEEE80211_S_RUN+1)
  49
  50 #define IEEE80211_SEND_MGMT(_ic,_ni,_type,_arg) \
  51         ((*(_ic)->ic_send_mgmt)(_ic, _ni, _type, _arg))
  52
  53 extern  const char *ieee80211_mgt_subtype_name[];
  54 extern  const char *ieee80211_phymode_name[];
  55
  56 void    ieee80211_proto_attach(struct ieee80211com *);
  57 void    ieee80211_proto_detach(struct ieee80211com *);
  58
  59 struct ieee80211_node;
  60 int     ieee80211_input(struct ieee80211com *, struct mbuf *,
  61                 struct ieee80211_node *, int, u_int32_t);
  62 int     ieee80211_setup_rates(struct ieee80211_node *ni,
  63                 const u_int8_t *rates, const u_int8_t *xrates, int flags);
  64 void    ieee80211_saveie(u_int8_t **, const u_int8_t *);
  65 void    ieee80211_recv_mgmt(struct ieee80211com *, struct mbuf *,
  66                 struct ieee80211_node *, int, int, u_int32_t);
  67 int     ieee80211_send_nulldata(struct ieee80211_node *);
  68 int     ieee80211_send_probereq(struct ieee80211_node *ni,
  69                 const u_int8_t sa[IEEE80211_ADDR_LEN],
  70                 const u_int8_t da[IEEE80211_ADDR_LEN],
  71                 const u_int8_t bssid[IEEE80211_ADDR_LEN],
  72                 const u_int8_t *ssid, size_t ssidlen,
  73                 const void *optie, size_t optielen);
  74 int     ieee80211_send_mgmt(struct ieee80211com *, struct ieee80211_node *,
  75                 int, int);
  76 int     ieee80211_classify(struct ieee80211com *, struct mbuf *,
  77                 struct ieee80211_node *);
  78 struct mbuf *ieee80211_encap(struct ieee80211com *, struct mbuf *,
  79                 struct ieee80211_node *);
  80 void    ieee80211_pwrsave(struct ieee80211com *, struct ieee80211_node *,
  81                 struct mbuf *);
  82
  83 void    ieee80211_reset_erp(struct ieee80211com *);
  84 void    ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
  85 int     ieee80211_iserp_rateset(struct ieee80211com *,
  86                 struct ieee80211_rateset *);
  87 void    ieee80211_set11gbasicrates(struct ieee80211_rateset *,
  88                 enum ieee80211_phymode);
  89
  90 /*
  91  * Return the size of the 802.11 header for a management or data frame.
  92  */
  93 static __inline int
  94 ieee80211_hdrsize(const void *data)
  95 {
  96         const struct ieee80211_frame *wh = data;
  97         int size = sizeof(struct ieee80211_frame);
  98
  99         /* NB: we don't handle control frames */
 100         KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
 101                 ("%s: control frame", __func__));
 102         if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS)
 103                 size += IEEE80211_ADDR_LEN;
 104         if (IEEE80211_QOS_HAS_SEQ(wh))
 105                 size += sizeof(u_int16_t);
 106         return size;
 107 }
 108
 109 /*
 110  * Return the size of the 802.11 header; handles any type of frame.
 111  */
 112 static __inline int
 113 ieee80211_anyhdrsize(const void *data)
 114 {
 115         const struct ieee80211_frame *wh = data;
 116
 117         if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
 118                 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
 119                 case IEEE80211_FC0_SUBTYPE_CTS:
 120                 case IEEE80211_FC0_SUBTYPE_ACK:
 121                         return sizeof(struct ieee80211_frame_ack);
 122                 }
 123                 return sizeof(struct ieee80211_frame_min);
 124         } else
 125                 return ieee80211_hdrsize(data);
 126 }
 127
 128 /*
 129  * Template for an in-kernel authenticator.  Authenticators
 130  * register with the protocol code and are typically loaded
 131  * as separate modules as needed.
 132  */
 133 struct ieee80211_authenticator {
 134         const char *ia_name;            /* printable name */
 135         int     (*ia_attach)(struct ieee80211com *);
 136         void    (*ia_detach)(struct ieee80211com *);
 137         void    (*ia_node_join)(struct ieee80211com *,
 138                                 struct ieee80211_node *);
 139         void    (*ia_node_leave)(struct ieee80211com *,
 140                                 struct ieee80211_node *);
 141 };
 142 void    ieee80211_authenticator_register(int type,
 143                 const struct ieee80211_authenticator *);
 144 void    ieee80211_authenticator_unregister(int type);
 145 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
 146
 147 struct ieee80211req;
 148 /*
 149  * Template for an MAC ACL policy module.  Such modules
 150  * register with the protocol code and are passed the sender's
 151  * address of each received frame for validation.
 152  */
 153 struct ieee80211_aclator {
 154         const char *iac_name;           /* printable name */
 155         int     (*iac_attach)(struct ieee80211com *);
 156         void    (*iac_detach)(struct ieee80211com *);
 157         int     (*iac_check)(struct ieee80211com *,
 158                         const u_int8_t mac[IEEE80211_ADDR_LEN]);
 159         int     (*iac_add)(struct ieee80211com *,
 160                         const u_int8_t mac[IEEE80211_ADDR_LEN]);
 161         int     (*iac_remove)(struct ieee80211com *,
 162                         const u_int8_t mac[IEEE80211_ADDR_LEN]);
 163         int     (*iac_flush)(struct ieee80211com *);
 164         int     (*iac_setpolicy)(struct ieee80211com *, int);
 165         int     (*iac_getpolicy)(struct ieee80211com *);
 166         int     (*iac_setioctl)(struct ieee80211com *, struct ieee80211req *);
 167         int     (*iac_getioctl)(struct ieee80211com *, struct ieee80211req *);
 168 };
 169 void    ieee80211_aclator_register(const struct ieee80211_aclator *);
 170 void    ieee80211_aclator_unregister(const struct ieee80211_aclator *);
 171 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
 172
 173 /* flags for ieee80211_fix_rate() */
 174 #define IEEE80211_F_DOSORT      0x00000001      /* sort rate list */
 175 #define IEEE80211_F_DOFRATE     0x00000002      /* use fixed rate */
 176 #define IEEE80211_F_DONEGO      0x00000004      /* calc negotiated rate */
 177 #define IEEE80211_F_DODEL       0x00000008      /* delete ignore rate */
 178 int     ieee80211_fix_rate(struct ieee80211_node *, int);
 179
 180 /*
 181  * WME/WMM support.
 182  */
 183 struct wmeParams {
 184         u_int8_t        wmep_acm;
 185         u_int8_t        wmep_aifsn;
 186         u_int8_t        wmep_logcwmin;          /* log2(cwmin) */
 187         u_int8_t        wmep_logcwmax;          /* log2(cwmax) */
 188         u_int8_t        wmep_txopLimit;
 189         u_int8_t        wmep_noackPolicy;       /* 0 (ack), 1 (no ack) */
 190 };
 191 #define IEEE80211_TXOP_TO_US(_txop)     ((_txop)<<5)
 192 #define IEEE80211_US_TO_TXOP(_us)       ((_us)>>5)
 193
 194 struct chanAccParams {
 195         u_int8_t        cap_info;               /* version of the current set */
 196         struct wmeParams cap_wmeParams[WME_NUM_AC];
 197 };
 198
 199 struct ieee80211_wme_state {
 200         u_int   wme_flags;
 201 #define WME_F_AGGRMODE  0x00000001      /* STATUS: WME agressive mode */
 202         u_int   wme_hipri_traffic;      /* VI/VO frames in beacon interval */
 203         u_int   wme_hipri_switch_thresh;/* agressive mode switch thresh */
 204         u_int   wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
 205
 206         struct wmeParams wme_params[4];         /* from assoc resp for each AC*/
 207         struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
 208         struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
 209         struct chanAccParams wme_chanParams;    /* params applied to self */
 210         struct chanAccParams wme_bssChanParams; /* params bcast to stations */
 211
 212         int     (*wme_update)(struct ieee80211com *);
 213 };
 214
 215 void    ieee80211_wme_initparams(struct ieee80211com *);
 216 void    ieee80211_wme_updateparams(struct ieee80211com *);
 217 void    ieee80211_wme_updateparams_locked(struct ieee80211com *);
 218
 219 #define ieee80211_new_state(_ic, _nstate, _arg) \
 220         (((_ic)->ic_newstate)((_ic), (_nstate), (_arg)))
 221 void    ieee80211_beacon_miss(struct ieee80211com *);
 222 void    ieee80211_print_essid(const u_int8_t *, int);
 223 void    ieee80211_dump_pkt(const u_int8_t *, int, int, int);
 224
 225 extern  const char *ieee80211_state_name[IEEE80211_S_MAX];
 226 extern  const char *ieee80211_wme_acnames[];
 227
 228 /*
 229  * Beacon frames constructed by ieee80211_beacon_alloc
 230  * have the following structure filled in so drivers
 231  * can update the frame later w/ minimal overhead.
 232  */
 233 struct ieee80211_beacon_offsets {
 234         u_int16_t       *bo_caps;       /* capabilities */
 235         u_int8_t        *bo_tim;        /* start of atim/dtim */
 236         u_int8_t        *bo_wme;        /* start of WME parameters */
 237         u_int8_t        *bo_trailer;    /* start of fixed-size trailer */
 238         u_int16_t       bo_tim_len;     /* atim/dtim length in bytes */
 239         u_int16_t       bo_trailer_len; /* trailer length in bytes */
 240         u_int8_t        *bo_erp;        /* start of ERP element */
 241 };
 242 struct mbuf *ieee80211_beacon_alloc(struct ieee80211com *,
 243                 struct ieee80211_node *, struct ieee80211_beacon_offsets *);
 244 int     ieee80211_beacon_update(struct ieee80211com *,
 245                 struct ieee80211_node *, struct ieee80211_beacon_offsets *,
 246                 struct mbuf *, int broadcast);
 247
 248 /*
 249  * Notification methods called from the 802.11 state machine.
 250  * Note that while these are defined here, their implementation
 251  * is OS-specific.
 252  */
 253 void    ieee80211_notify_node_join(struct ieee80211com *,
 254                 struct ieee80211_node *, int newassoc);
 255 void    ieee80211_notify_node_leave(struct ieee80211com *,
 256                 struct ieee80211_node *);
 257 void    ieee80211_notify_scan_done(struct ieee80211com *);
 258 #endif /* _NET80211_IEEE80211_PROTO_H_ */