sys/net80211/ieee80211_proto.h

   1 /*-
   2  * Copyright (c) 2001 Atsushi Onoe
   3  * Copyright (c) 2002-2009 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  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28 #ifndef _NET80211_IEEE80211_PROTO_H_
  29 #define _NET80211_IEEE80211_PROTO_H_
  30
  31 /*
  32  * 802.11 protocol implementation definitions.
  33  */
  34
  35 enum ieee80211_state {
  36         IEEE80211_S_INIT        = 0,    /* default state */
  37         IEEE80211_S_SCAN        = 1,    /* scanning */
  38         IEEE80211_S_AUTH        = 2,    /* try to authenticate */
  39         IEEE80211_S_ASSOC       = 3,    /* try to assoc */
  40         IEEE80211_S_CAC         = 4,    /* doing channel availability check */
  41         IEEE80211_S_RUN         = 5,    /* operational (e.g. associated) */
  42         IEEE80211_S_CSA         = 6,    /* channel switch announce pending */
  43         IEEE80211_S_SLEEP       = 7,    /* power save */
  44 };
  45 #define IEEE80211_S_MAX         (IEEE80211_S_SLEEP+1)
  46
  47 #define IEEE80211_SEND_MGMT(_ni,_type,_arg) \
  48         ((*(_ni)->ni_ic->ic_send_mgmt)(_ni, _type, _arg))
  49
  50 extern  const char *ieee80211_mgt_subtype_name[];
  51 extern  const char *ieee80211_phymode_name[IEEE80211_MODE_MAX];
  52 extern  const int ieee80211_opcap[IEEE80211_OPMODE_MAX];
  53
  54 void    ieee80211_proto_attach(struct ieee80211com *);
  55 void    ieee80211_proto_detach(struct ieee80211com *);
  56 void    ieee80211_proto_vattach(struct ieee80211vap *);
  57 void    ieee80211_proto_vdetach(struct ieee80211vap *);
  58
  59 void    ieee80211_syncifflag_locked(struct ieee80211com *, int flag);
  60 void    ieee80211_syncflag(struct ieee80211vap *, int flag);
  61 void    ieee80211_syncflag_ht(struct ieee80211vap *, int flag);
  62 void    ieee80211_syncflag_ext(struct ieee80211vap *, int flag);
  63
  64 #define IEEE80211_R_NF          0x0000001       /* global NF value valid */
  65 #define IEEE80211_R_RSSI        0x0000002       /* global RSSI value valid */
  66 #define IEEE80211_R_C_CHAIN     0x0000004       /* RX chain count valid */
  67 #define IEEE80211_R_C_NF        0x0000008       /* per-chain NF value valid */
  68 #define IEEE80211_R_C_RSSI      0x0000010       /* per-chain RSSI value valid */
  69 #define IEEE80211_R_C_EVM       0x0000020       /* per-chain EVM valid */
  70 #define IEEE80211_R_C_HT40      0x0000040       /* RX'ed packet is 40mhz, pilots 4,5 valid */
  71
  72 struct ieee80211_rx_stats {
  73         uint32_t r_flags;               /* IEEE80211_R_* flags */
  74         uint8_t c_chain;                /* number of RX chains involved */
  75         int16_t c_nf_ctl[IEEE80211_MAX_CHAINS]; /* per-chain NF */
  76         int16_t c_nf_ext[IEEE80211_MAX_CHAINS]; /* per-chain NF */
  77         int16_t c_rssi_ctl[IEEE80211_MAX_CHAINS];       /* per-chain RSSI */
  78         int16_t c_rssi_ext[IEEE80211_MAX_CHAINS];       /* per-chain RSSI */
  79         uint8_t nf;                     /* global NF */
  80         uint8_t rssi;                   /* global RSSI */
  81         uint8_t evm[IEEE80211_MAX_CHAINS][IEEE80211_MAX_EVM_PILOTS];
  82                                         /* per-chain, per-pilot EVM values */
  83 };
  84
  85 #define ieee80211_input(ni, m, rssi, nf) \
  86         ((ni)->ni_vap->iv_input(ni, m, rssi, nf))
  87 int     ieee80211_input_all(struct ieee80211com *, struct mbuf *, int, int);
  88
  89 int     ieee80211_input_mimo(struct ieee80211_node *, struct mbuf *,
  90             struct ieee80211_rx_stats *);
  91 int     ieee80211_input_mimo_all(struct ieee80211com *, struct mbuf *,
  92             struct ieee80211_rx_stats *);
  93
  94 struct ieee80211_bpf_params;
  95 int     ieee80211_mgmt_output(struct ieee80211_node *, struct mbuf *, int,
  96                 struct ieee80211_bpf_params *);
  97 int     ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *,
  98                 const struct ieee80211_bpf_params *);
  99 int     ieee80211_output(struct ifnet *, struct mbuf *,
 100                struct sockaddr *, struct route *ro);
 101 void    ieee80211_send_setup(struct ieee80211_node *, struct mbuf *, int, int,
 102         const uint8_t [IEEE80211_ADDR_LEN], const uint8_t [IEEE80211_ADDR_LEN],
 103         const uint8_t [IEEE80211_ADDR_LEN]);
 104 void    ieee80211_start(struct ifnet *);
 105 int     ieee80211_send_nulldata(struct ieee80211_node *);
 106 int     ieee80211_classify(struct ieee80211_node *, struct mbuf *m);
 107 struct mbuf *ieee80211_mbuf_adjust(struct ieee80211vap *, int,
 108                 struct ieee80211_key *, struct mbuf *);
 109 struct mbuf *ieee80211_encap(struct ieee80211vap *, struct ieee80211_node *,
 110                 struct mbuf *);
 111 int     ieee80211_send_mgmt(struct ieee80211_node *, int, int);
 112 struct ieee80211_appie;
 113 int     ieee80211_send_probereq(struct ieee80211_node *ni,
 114                 const uint8_t sa[IEEE80211_ADDR_LEN],
 115                 const uint8_t da[IEEE80211_ADDR_LEN],
 116                 const uint8_t bssid[IEEE80211_ADDR_LEN],
 117                 const uint8_t *ssid, size_t ssidlen);
 118 /*
 119  * The formation of ProbeResponse frames requires guidance to
 120  * deal with legacy clients.  When the client is identified as
 121  * "legacy 11b" ieee80211_send_proberesp is passed this token.
 122  */
 123 #define IEEE80211_SEND_LEGACY_11B       0x1     /* legacy 11b client */
 124 #define IEEE80211_SEND_LEGACY_11        0x2     /* other legacy client */
 125 #define IEEE80211_SEND_LEGACY           0x3     /* any legacy client */
 126 struct mbuf *ieee80211_alloc_proberesp(struct ieee80211_node *, int);
 127 int     ieee80211_send_proberesp(struct ieee80211vap *,
 128                 const uint8_t da[IEEE80211_ADDR_LEN], int);
 129 struct mbuf *ieee80211_alloc_rts(struct ieee80211com *ic,
 130                 const uint8_t [IEEE80211_ADDR_LEN],
 131                 const uint8_t [IEEE80211_ADDR_LEN], uint16_t);
 132 struct mbuf *ieee80211_alloc_cts(struct ieee80211com *,
 133                 const uint8_t [IEEE80211_ADDR_LEN], uint16_t);
 134
 135 uint8_t *ieee80211_add_rates(uint8_t *, const struct ieee80211_rateset *);
 136 uint8_t *ieee80211_add_xrates(uint8_t *, const struct ieee80211_rateset *);
 137 uint8_t *ieee80211_add_wpa(uint8_t *, const struct ieee80211vap *);
 138 uint8_t *ieee80211_add_rsn(uint8_t *, const struct ieee80211vap *);
 139 uint8_t *ieee80211_add_qos(uint8_t *, const struct ieee80211_node *);
 140 uint16_t ieee80211_getcapinfo(struct ieee80211vap *,
 141                 struct ieee80211_channel *);
 142
 143 void    ieee80211_reset_erp(struct ieee80211com *);
 144 void    ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
 145 int     ieee80211_iserp_rateset(const struct ieee80211_rateset *);
 146 void    ieee80211_setbasicrates(struct ieee80211_rateset *,
 147                 enum ieee80211_phymode);
 148 void    ieee80211_addbasicrates(struct ieee80211_rateset *,
 149                 enum ieee80211_phymode);
 150
 151 /*
 152  * Return the size of the 802.11 header for a management or data frame.
 153  */
 154 static __inline int
 155 ieee80211_hdrsize(const void *data)
 156 {
 157         const struct ieee80211_frame *wh = data;
 158         int size = sizeof(struct ieee80211_frame);
 159
 160         /* NB: we don't handle control frames */
 161         KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
 162                 ("%s: control frame", __func__));
 163         if (IEEE80211_IS_DSTODS(wh))
 164                 size += IEEE80211_ADDR_LEN;
 165         if (IEEE80211_QOS_HAS_SEQ(wh))
 166                 size += sizeof(uint16_t);
 167         return size;
 168 }
 169
 170 /*
 171  * Like ieee80211_hdrsize, but handles any type of frame.
 172  */
 173 static __inline int
 174 ieee80211_anyhdrsize(const void *data)
 175 {
 176         const struct ieee80211_frame *wh = data;
 177
 178         if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
 179                 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
 180                 case IEEE80211_FC0_SUBTYPE_CTS:
 181                 case IEEE80211_FC0_SUBTYPE_ACK:
 182                         return sizeof(struct ieee80211_frame_ack);
 183                 case IEEE80211_FC0_SUBTYPE_BAR:
 184                         return sizeof(struct ieee80211_frame_bar);
 185                 }
 186                 return sizeof(struct ieee80211_frame_min);
 187         } else
 188                 return ieee80211_hdrsize(data);
 189 }
 190
 191 /*
 192  * Template for an in-kernel authenticator.  Authenticators
 193  * register with the protocol code and are typically loaded
 194  * as separate modules as needed.  One special authenticator
 195  * is xauth; it intercepts requests so that protocols like
 196  * WPA can be handled in user space.
 197  */
 198 struct ieee80211_authenticator {
 199         const char *ia_name;            /* printable name */
 200         int     (*ia_attach)(struct ieee80211vap *);
 201         void    (*ia_detach)(struct ieee80211vap *);
 202         void    (*ia_node_join)(struct ieee80211_node *);
 203         void    (*ia_node_leave)(struct ieee80211_node *);
 204 };
 205 void    ieee80211_authenticator_register(int type,
 206                 const struct ieee80211_authenticator *);
 207 void    ieee80211_authenticator_unregister(int type);
 208 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
 209
 210 struct ieee80211req;
 211 /*
 212  * Template for an MAC ACL policy module.  Such modules
 213  * register with the protocol code and are passed the sender's
 214  * address of each received auth frame for validation.
 215  */
 216 struct ieee80211_aclator {
 217         const char *iac_name;           /* printable name */
 218         int     (*iac_attach)(struct ieee80211vap *);
 219         void    (*iac_detach)(struct ieee80211vap *);
 220         int     (*iac_check)(struct ieee80211vap *,
 221                         const uint8_t mac[IEEE80211_ADDR_LEN]);
 222         int     (*iac_add)(struct ieee80211vap *,
 223                         const uint8_t mac[IEEE80211_ADDR_LEN]);
 224         int     (*iac_remove)(struct ieee80211vap *,
 225                         const uint8_t mac[IEEE80211_ADDR_LEN]);
 226         int     (*iac_flush)(struct ieee80211vap *);
 227         int     (*iac_setpolicy)(struct ieee80211vap *, int);
 228         int     (*iac_getpolicy)(struct ieee80211vap *);
 229         int     (*iac_setioctl)(struct ieee80211vap *, struct ieee80211req *);
 230         int     (*iac_getioctl)(struct ieee80211vap *, struct ieee80211req *);
 231 };
 232 void    ieee80211_aclator_register(const struct ieee80211_aclator *);
 233 void    ieee80211_aclator_unregister(const struct ieee80211_aclator *);
 234 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
 235
 236 /* flags for ieee80211_fix_rate() */
 237 #define IEEE80211_F_DOSORT      0x00000001      /* sort rate list */
 238 #define IEEE80211_F_DOFRATE     0x00000002      /* use fixed legacy rate */
 239 #define IEEE80211_F_DONEGO      0x00000004      /* calc negotiated rate */
 240 #define IEEE80211_F_DODEL       0x00000008      /* delete ignore rate */
 241 #define IEEE80211_F_DOBRS       0x00000010      /* check basic rate set */
 242 #define IEEE80211_F_JOIN        0x00000020      /* sta joining our bss */
 243 #define IEEE80211_F_DOFMCS      0x00000040      /* use fixed HT rate */
 244 int     ieee80211_fix_rate(struct ieee80211_node *,
 245                 struct ieee80211_rateset *, int);
 246
 247 /*
 248  * WME/WMM support.
 249  */
 250 struct wmeParams {
 251         uint8_t         wmep_acm;
 252         uint8_t         wmep_aifsn;
 253         uint8_t         wmep_logcwmin;          /* log2(cwmin) */
 254         uint8_t         wmep_logcwmax;          /* log2(cwmax) */
 255         uint8_t         wmep_txopLimit;
 256         uint8_t         wmep_noackPolicy;       /* 0 (ack), 1 (no ack) */
 257 };
 258 #define IEEE80211_TXOP_TO_US(_txop)     ((_txop)<<5)
 259 #define IEEE80211_US_TO_TXOP(_us)       ((_us)>>5)
 260
 261 struct chanAccParams {
 262         uint8_t         cap_info;               /* version of the current set */
 263         struct wmeParams cap_wmeParams[WME_NUM_AC];
 264 };
 265
 266 struct ieee80211_wme_state {
 267         u_int   wme_flags;
 268 #define WME_F_AGGRMODE  0x00000001      /* STATUS: WME agressive mode */
 269         u_int   wme_hipri_traffic;      /* VI/VO frames in beacon interval */
 270         u_int   wme_hipri_switch_thresh;/* agressive mode switch thresh */
 271         u_int   wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
 272
 273         struct wmeParams wme_params[4];         /* from assoc resp for each AC*/
 274         struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
 275         struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
 276         struct chanAccParams wme_chanParams;    /* params applied to self */
 277         struct chanAccParams wme_bssChanParams; /* params bcast to stations */
 278
 279         int     (*wme_update)(struct ieee80211com *);
 280 };
 281
 282 void    ieee80211_wme_initparams(struct ieee80211vap *);
 283 void    ieee80211_wme_updateparams(struct ieee80211vap *);
 284 void    ieee80211_wme_updateparams_locked(struct ieee80211vap *);
 285
 286 /*
 287  * Return the WME TID from a QoS frame.  If no TID
 288  * is present return the index for the "non-QoS" entry.
 289  */
 290 static __inline uint8_t
 291 ieee80211_gettid(const struct ieee80211_frame *wh)
 292 {
 293         uint8_t tid;
 294
 295         if (IEEE80211_QOS_HAS_SEQ(wh)) {
 296                 if (IEEE80211_IS_DSTODS(wh))
 297                         tid = ((const struct ieee80211_qosframe_addr4 *)wh)->
 298                                 i_qos[0];
 299                 else
 300                         tid = ((const struct ieee80211_qosframe *)wh)->i_qos[0];
 301                 tid &= IEEE80211_QOS_TID;
 302         } else
 303                 tid = IEEE80211_NONQOS_TID;
 304         return tid;
 305 }
 306
 307 void    ieee80211_waitfor_parent(struct ieee80211com *);
 308 void    ieee80211_start_locked(struct ieee80211vap *);
 309 void    ieee80211_init(void *);
 310 void    ieee80211_start_all(struct ieee80211com *);
 311 void    ieee80211_stop_locked(struct ieee80211vap *);
 312 void    ieee80211_stop(struct ieee80211vap *);
 313 void    ieee80211_stop_all(struct ieee80211com *);
 314 void    ieee80211_suspend_all(struct ieee80211com *);
 315 void    ieee80211_resume_all(struct ieee80211com *);
 316 void    ieee80211_dturbo_switch(struct ieee80211vap *, int newflags);
 317 void    ieee80211_swbmiss(void *arg);
 318 void    ieee80211_beacon_miss(struct ieee80211com *);
 319 int     ieee80211_new_state(struct ieee80211vap *, enum ieee80211_state, int);
 320 void    ieee80211_print_essid(const uint8_t *, int);
 321 void    ieee80211_dump_pkt(struct ieee80211com *,
 322                 const uint8_t *, int, int, int);
 323
 324 extern  const char *ieee80211_opmode_name[];
 325 extern  const char *ieee80211_state_name[IEEE80211_S_MAX];
 326 extern  const char *ieee80211_wme_acnames[];
 327
 328 /*
 329  * Beacon frames constructed by ieee80211_beacon_alloc
 330  * have the following structure filled in so drivers
 331  * can update the frame later w/ minimal overhead.
 332  */
 333 struct ieee80211_beacon_offsets {
 334         uint8_t         bo_flags[4];    /* update/state flags */
 335         uint16_t        *bo_caps;       /* capabilities */
 336         uint8_t         *bo_cfp;        /* start of CFParms element */
 337         uint8_t         *bo_tim;        /* start of atim/dtim */
 338         uint8_t         *bo_wme;        /* start of WME parameters */
 339         uint8_t         *bo_tdma;       /* start of TDMA parameters */
 340         uint8_t         *bo_tim_trailer;/* start of fixed-size trailer */
 341         uint16_t        bo_tim_len;     /* atim/dtim length in bytes */
 342         uint16_t        bo_tim_trailer_len;/* tim trailer length in bytes */
 343         uint8_t         *bo_erp;        /* start of ERP element */
 344         uint8_t         *bo_htinfo;     /* start of HT info element */
 345         uint8_t         *bo_ath;        /* start of ATH parameters */
 346         uint8_t         *bo_appie;      /* start of AppIE element */
 347         uint16_t        bo_appie_len;   /* AppIE length in bytes */
 348         uint16_t        bo_csa_trailer_len;
 349         uint8_t         *bo_csa;        /* start of CSA element */
 350         uint8_t         *bo_meshconf;   /* start of MESHCONF element */
 351         uint8_t         *bo_spare[3];
 352 };
 353 struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *,
 354                 struct ieee80211_beacon_offsets *);
 355
 356 /*
 357  * Beacon frame updates are signaled through calls to iv_update_beacon
 358  * with one of the IEEE80211_BEACON_* tokens defined below.  For devices
 359  * that construct beacon frames on the host this can trigger a rebuild
 360  * or defer the processing.  For devices that offload beacon frame
 361  * handling this callback can be used to signal a rebuild.  The bo_flags
 362  * array in the ieee80211_beacon_offsets structure is intended to record
 363  * deferred processing requirements; ieee80211_beacon_update uses the
 364  * state to optimize work.  Since this structure is owned by the driver
 365  * and not visible to the 802.11 layer drivers must supply an iv_update_beacon
 366  * callback that marks the flag bits and schedules (as necessary) an update.
 367  */
 368 enum {
 369         IEEE80211_BEACON_CAPS   = 0,    /* capabilities */
 370         IEEE80211_BEACON_TIM    = 1,    /* DTIM/ATIM */
 371         IEEE80211_BEACON_WME    = 2,
 372         IEEE80211_BEACON_ERP    = 3,    /* Extended Rate Phy */
 373         IEEE80211_BEACON_HTINFO = 4,    /* HT Information */
 374         IEEE80211_BEACON_APPIE  = 5,    /* Application IE's */
 375         IEEE80211_BEACON_CFP    = 6,    /* CFParms */
 376         IEEE80211_BEACON_CSA    = 7,    /* Channel Switch Announcement */
 377         IEEE80211_BEACON_TDMA   = 9,    /* TDMA Info */
 378         IEEE80211_BEACON_ATH    = 10,   /* ATH parameters */
 379         IEEE80211_BEACON_MESHCONF = 11, /* Mesh Configuration */
 380 };
 381 int     ieee80211_beacon_update(struct ieee80211_node *,
 382                 struct ieee80211_beacon_offsets *, struct mbuf *, int mcast);
 383
 384 void    ieee80211_csa_startswitch(struct ieee80211com *,
 385                 struct ieee80211_channel *, int mode, int count);
 386 void    ieee80211_csa_completeswitch(struct ieee80211com *);
 387 void    ieee80211_csa_cancelswitch(struct ieee80211com *);
 388 void    ieee80211_cac_completeswitch(struct ieee80211vap *);
 389
 390 /*
 391  * Notification methods called from the 802.11 state machine.
 392  * Note that while these are defined here, their implementation
 393  * is OS-specific.
 394  */
 395 void    ieee80211_notify_node_join(struct ieee80211_node *, int newassoc);
 396 void    ieee80211_notify_node_leave(struct ieee80211_node *);
 397 void    ieee80211_notify_scan_done(struct ieee80211vap *);
 398 void    ieee80211_notify_wds_discover(struct ieee80211_node *);
 399 void    ieee80211_notify_csa(struct ieee80211com *,
 400                 const struct ieee80211_channel *, int mode, int count);
 401 void    ieee80211_notify_radar(struct ieee80211com *,
 402                 const struct ieee80211_channel *);
 403 enum ieee80211_notify_cac_event {
 404         IEEE80211_NOTIFY_CAC_START  = 0, /* CAC timer started */
 405         IEEE80211_NOTIFY_CAC_STOP   = 1, /* CAC intentionally stopped */
 406         IEEE80211_NOTIFY_CAC_RADAR  = 2, /* CAC stopped due to radar detectio */
 407         IEEE80211_NOTIFY_CAC_EXPIRE = 3, /* CAC expired w/o radar */
 408 };
 409 void    ieee80211_notify_cac(struct ieee80211com *,
 410                 const struct ieee80211_channel *,
 411                 enum ieee80211_notify_cac_event);
 412 void    ieee80211_notify_node_deauth(struct ieee80211_node *);
 413 void    ieee80211_notify_node_auth(struct ieee80211_node *);
 414 void    ieee80211_notify_country(struct ieee80211vap *, const uint8_t [],
 415                 const uint8_t cc[2]);
 416 void    ieee80211_notify_radio(struct ieee80211com *, int);
 417 #endif /* _NET80211_IEEE80211_PROTO_H_ */