sys/netproto/802_11/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: src/sys/net80211/ieee80211_proto.h,v 1.11.2.5 2006/02/12 19:00:39 sam Exp $
  33  * $DragonFly: src/sys/netproto/802_11/ieee80211_proto.h,v 1.13 2007/05/07 14:12:16 sephe Exp $
  34  */
  35 #ifndef _NET80211_IEEE80211_PROTO_H_
  36 #define _NET80211_IEEE80211_PROTO_H_
  37
  38 /*
  39  * 802.11 protocol implementation definitions.
  40  */
  41
  42 enum ieee80211_state {
  43         IEEE80211_S_INIT        = 0,    /* default state */
  44         IEEE80211_S_SCAN        = 1,    /* scanning */
  45         IEEE80211_S_AUTH        = 2,    /* try to authenticate */
  46         IEEE80211_S_ASSOC       = 3,    /* try to assoc */
  47         IEEE80211_S_RUN         = 4,    /* associated */
  48 };
  49 #define IEEE80211_S_MAX         (IEEE80211_S_RUN+1)
  50
  51 #define IEEE80211_SEND_MGMT(_ic,_ni,_type,_arg) \
  52         ((*(_ic)->ic_send_mgmt)(_ic, _ni, _type, _arg))
  53
  54 extern  const char *ieee80211_mgt_subtype_name[];
  55 extern  const char *ieee80211_phymode_name[];
  56
  57 void    ieee80211_proto_attach(struct ieee80211com *);
  58 void    ieee80211_proto_detach(struct ieee80211com *);
  59
  60 struct ieee80211_node;
  61 struct ieee80211_crypto_iv;
  62 int     ieee80211_input(struct ieee80211com *, struct mbuf *,
  63                 struct ieee80211_node *, int, uint32_t);
  64 int     ieee80211_input_withiv(struct ieee80211com *, struct mbuf *,
  65                 struct ieee80211_node *, int, uint32_t,
  66                 const struct ieee80211_crypto_iv *);
  67 int     ieee80211_setup_rates(struct ieee80211_node *ni,
  68                 const uint8_t *rates, const uint8_t *xrates,
  69                 int flags, int join);
  70 void    ieee80211_saveie(uint8_t **, const uint8_t *);
  71 void    ieee80211_recv_mgmt(struct ieee80211com *, struct mbuf *,
  72                 struct ieee80211_node *, int, int, uint32_t);
  73 int     ieee80211_send_nulldata(struct ieee80211_node *);
  74 int     ieee80211_send_probereq(struct ieee80211_node *ni,
  75                 const uint8_t sa[IEEE80211_ADDR_LEN],
  76                 const uint8_t da[IEEE80211_ADDR_LEN],
  77                 const uint8_t bssid[IEEE80211_ADDR_LEN],
  78                 const uint8_t *ssid, size_t ssidlen,
  79                 const void *optie, size_t optielen);
  80 int     ieee80211_send_mgmt(struct ieee80211com *, struct ieee80211_node *,
  81                 int, int);
  82 int     ieee80211_classify(struct ieee80211com *, struct mbuf *,
  83                 struct ieee80211_node *);
  84 struct mbuf *ieee80211_encap(struct ieee80211com *, struct mbuf *,
  85                 struct ieee80211_node *);
  86 void    ieee80211_pwrsave(struct ieee80211com *, struct ieee80211_node *,
  87                 struct mbuf *);
  88
  89 void    ieee80211_reset_erp(struct ieee80211com *);
  90 void    ieee80211_set_shortslottime(struct ieee80211com *, int);
  91 void    ieee80211_set_shortpreamble(struct ieee80211com *, int);
  92 int     ieee80211_iserp_rateset(struct ieee80211com *,
  93                 const struct ieee80211_rateset *);
  94 void    ieee80211_set_basicrates(struct ieee80211_rateset *,
  95                 enum ieee80211_phymode, int);
  96 int     ieee80211_copy_basicrates(struct ieee80211_rateset *,
  97                 const struct ieee80211_rateset *);
  98
  99 /*
 100  * Return the size of the 802.11 header for a management or data frame.
 101  */
 102 static __inline int
 103 ieee80211_hdrsize(const void *data)
 104 {
 105         const struct ieee80211_frame *wh = data;
 106         int size = sizeof(struct ieee80211_frame);
 107
 108         /* NB: we don't handle control frames */
 109         KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
 110                 ("%s: control frame", __func__));
 111         if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS)
 112                 size += IEEE80211_ADDR_LEN;
 113         if (IEEE80211_QOS_HAS_SEQ(wh))
 114                 size += sizeof(uint16_t);
 115         return size;
 116 }
 117
 118 /*
 119  * Return the size of the 802.11 header; handles any type of frame.
 120  */
 121 static __inline int
 122 ieee80211_anyhdrsize(const void *data)
 123 {
 124         const struct ieee80211_frame *wh = data;
 125
 126         if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
 127                 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
 128                 case IEEE80211_FC0_SUBTYPE_CTS:
 129                 case IEEE80211_FC0_SUBTYPE_ACK:
 130                         return sizeof(struct ieee80211_frame_ack);
 131                 }
 132                 return sizeof(struct ieee80211_frame_min);
 133         } else
 134                 return ieee80211_hdrsize(data);
 135 }
 136
 137 /*
 138  * Template for an in-kernel authenticator.  Authenticators
 139  * register with the protocol code and are typically loaded
 140  * as separate modules as needed.
 141  */
 142 struct ieee80211_authenticator {
 143         const char *ia_name;            /* printable name */
 144         int     (*ia_attach)(struct ieee80211com *);
 145         void    (*ia_detach)(struct ieee80211com *);
 146         void    (*ia_node_join)(struct ieee80211com *,
 147                                 struct ieee80211_node *);
 148         void    (*ia_node_leave)(struct ieee80211com *,
 149                                 struct ieee80211_node *);
 150 };
 151 void    ieee80211_authenticator_register(int type,
 152                 const struct ieee80211_authenticator *);
 153 void    ieee80211_authenticator_unregister(int type);
 154 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
 155
 156 struct ieee80211req;
 157 /*
 158  * Template for an MAC ACL policy module.  Such modules
 159  * register with the protocol code and are passed the sender's
 160  * address of each received frame for validation.
 161  */
 162 struct ieee80211_aclator {
 163         const char *iac_name;           /* printable name */
 164         int     (*iac_attach)(struct ieee80211com *);
 165         void    (*iac_detach)(struct ieee80211com *);
 166         int     (*iac_check)(struct ieee80211com *,
 167                         const uint8_t mac[IEEE80211_ADDR_LEN]);
 168         int     (*iac_add)(struct ieee80211com *,
 169                         const uint8_t mac[IEEE80211_ADDR_LEN]);
 170         int     (*iac_remove)(struct ieee80211com *,
 171                         const uint8_t mac[IEEE80211_ADDR_LEN]);
 172         int     (*iac_flush)(struct ieee80211com *);
 173         int     (*iac_setpolicy)(struct ieee80211com *, int);
 174         int     (*iac_getpolicy)(struct ieee80211com *);
 175         int     (*iac_setioctl)(struct ieee80211com *, struct ieee80211req *);
 176         int     (*iac_getioctl)(struct ieee80211com *, struct ieee80211req *);
 177 };
 178 void    ieee80211_aclator_register(const struct ieee80211_aclator *);
 179 void    ieee80211_aclator_unregister(const struct ieee80211_aclator *);
 180 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
 181
 182 /* flags for ieee80211_fix_rate() */
 183 #define IEEE80211_F_DOSORT      0x00000001      /* sort rate list */
 184 #define IEEE80211_F_DOFRATE     0x00000002      /* use fixed rate */
 185 #define IEEE80211_F_DONEGO      0x00000004      /* calc negotiated rate */
 186 #define IEEE80211_F_DODEL       0x00000008      /* delete ignore rate */
 187 int     ieee80211_fix_rate(struct ieee80211_node *ni, int flags, int join);
 188
 189 /*
 190  * WME/WMM support.
 191  */
 192 struct wmeParams {
 193         uint8_t         wmep_acm;
 194         uint8_t         wmep_aifsn;
 195         uint8_t         wmep_logcwmin;          /* log2(cwmin) */
 196         uint8_t         wmep_logcwmax;          /* log2(cwmax) */
 197         uint8_t         wmep_txopLimit;
 198         uint8_t         wmep_noackPolicy;       /* 0 (ack), 1 (no ack) */
 199 };
 200 #define IEEE80211_TXOP_TO_US(_txop)     ((_txop)<<5)
 201 #define IEEE80211_US_TO_TXOP(_us)       ((_us)>>5)
 202
 203 struct chanAccParams {
 204         uint8_t         cap_info;               /* version of the current set */
 205         struct wmeParams cap_wmeParams[WME_NUM_AC];
 206 };
 207
 208 struct ieee80211_wme_state {
 209         u_int   wme_flags;
 210 #define WME_F_AGGRMODE  0x00000001      /* STATUS: WME agressive mode */
 211         u_int   wme_hipri_traffic;      /* VI/VO frames in beacon interval */
 212         u_int   wme_hipri_switch_thresh;/* agressive mode switch thresh */
 213         u_int   wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
 214
 215         struct wmeParams wme_params[4];         /* from assoc resp for each AC*/
 216         struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
 217         struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
 218         struct chanAccParams wme_chanParams;    /* params applied to self */
 219         struct chanAccParams wme_bssChanParams; /* params bcast to stations */
 220
 221         int     (*wme_update)(struct ieee80211com *);
 222 };
 223
 224 void    ieee80211_wme_initparams(struct ieee80211com *);
 225 void    ieee80211_wme_updateparams(struct ieee80211com *);
 226
 227 #define ieee80211_new_state(_ic, _nstate, _arg) \
 228         (((_ic)->ic_newstate)((_ic), (_nstate), (_arg)))
 229 void    ieee80211_reset_state(struct ieee80211com *, enum ieee80211_state);
 230 void    ieee80211_beacon_miss(struct ieee80211com *);
 231 void    ieee80211_print_essid(const uint8_t *, int);
 232 void    ieee80211_print_rateset(const struct ieee80211_rateset *);
 233 void    ieee80211_dump_pkt(const uint8_t *, int, int, int);
 234
 235 extern  const char *ieee80211_state_name[IEEE80211_S_MAX];
 236 extern  const char *ieee80211_wme_acnames[];
 237
 238 /*
 239  * Beacon frames constructed by ieee80211_beacon_alloc
 240  * have the following structure filled in so drivers
 241  * can update the frame later w/ minimal overhead.
 242  */
 243 struct ieee80211_beacon_offsets {
 244         uint16_t        *bo_caps;       /* capabilities */
 245         uint8_t         *bo_tim;        /* start of atim/dtim */
 246         uint8_t         *bo_wme;        /* start of WME parameters */
 247         uint8_t         *bo_trailer;    /* start of fixed-size trailer */
 248         uint16_t        bo_tim_len;     /* atim/dtim length in bytes */
 249         uint16_t        bo_trailer_len; /* trailer length in bytes */
 250         uint8_t         *bo_erp;        /* start of ERP element */
 251         void            *bo_pad[8];     /* future expansion */
 252 };
 253 struct mbuf *ieee80211_beacon_alloc(struct ieee80211com *,
 254                 struct ieee80211_node *, struct ieee80211_beacon_offsets *);
 255 int     ieee80211_beacon_update(struct ieee80211com *,
 256                 struct ieee80211_node *, struct ieee80211_beacon_offsets *,
 257                 struct mbuf *, int broadcast);
 258
 259 struct mbuf *ieee80211_probe_resp_alloc(struct ieee80211com *,
 260                 struct ieee80211_node *);
 261
 262 uint8_t         ieee80211_ack_rate(struct ieee80211_node *, uint8_t);
 263 uint16_t        ieee80211_txtime(struct ieee80211_node *, u_int, uint8_t,
 264                                  uint32_t);
 265
 266 /*
 267  * Notification methods called from the 802.11 state machine.
 268  * Note that while these are defined here, their implementation
 269  * is OS-specific.
 270  */
 271 void    ieee80211_notify_node_join(struct ieee80211com *,
 272                 struct ieee80211_node *, int newassoc);
 273 void    ieee80211_notify_node_leave(struct ieee80211com *,
 274                 struct ieee80211_node *);
 275 void    ieee80211_notify_scan_done(struct ieee80211com *);
 276 #endif /* _NET80211_IEEE80211_PROTO_H_ */