sys/netproto/802_11/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: head/sys/net80211/ieee80211_proto.h 199187 2009-11-11 15:00:56Z antoine $
  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_input(ni, m, rssi, nf) \
  65         ((ni)->ni_vap->iv_input(ni, m, rssi, nf))
  66 int     ieee80211_input_all(struct ieee80211com *, struct mbuf *, int, int);
  67 struct ieee80211_bpf_params;
  68 int     ieee80211_mgmt_output(struct ieee80211_node *, struct mbuf *, int,
  69                 struct ieee80211_bpf_params *);
  70 int     ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *,
  71                 const struct ieee80211_bpf_params *);
  72 int     ieee80211_output(struct ifnet *, struct mbuf *,
  73                struct sockaddr *, struct rtentry *rt);
  74 void    ieee80211_send_setup(struct ieee80211_node *, struct mbuf *, int, int,
  75         const uint8_t [IEEE80211_ADDR_LEN], const uint8_t [IEEE80211_ADDR_LEN],
  76         const uint8_t [IEEE80211_ADDR_LEN]);
  77 void    ieee80211_start(struct ifnet *, struct ifaltq_subque *);
  78 int     ieee80211_send_nulldata(struct ieee80211_node *);
  79 int     ieee80211_classify(struct ieee80211_node *, struct mbuf *m);
  80 struct mbuf *ieee80211_mbuf_adjust(struct ieee80211vap *, int,
  81                 struct ieee80211_key *, struct mbuf *);
  82 struct mbuf *ieee80211_encap(struct ieee80211vap *, struct ieee80211_node *,
  83                 struct mbuf *);
  84 int     ieee80211_send_mgmt(struct ieee80211_node *, int, int);
  85 struct ieee80211_appie;
  86 int     ieee80211_send_probereq(struct ieee80211_node *ni,
  87                 const uint8_t sa[IEEE80211_ADDR_LEN],
  88                 const uint8_t da[IEEE80211_ADDR_LEN],
  89                 const uint8_t bssid[IEEE80211_ADDR_LEN],
  90                 const uint8_t *ssid, size_t ssidlen);
  91 /*
  92  * The formation of ProbeResponse frames requires guidance to
  93  * deal with legacy clients.  When the client is identified as
  94  * "legacy 11b" ieee80211_send_proberesp is passed this token.
  95  */
  96 #define IEEE80211_SEND_LEGACY_11B       0x1     /* legacy 11b client */
  97 #define IEEE80211_SEND_LEGACY_11        0x2     /* other legacy client */
  98 #define IEEE80211_SEND_LEGACY           0x3     /* any legacy client */
  99 struct mbuf *ieee80211_alloc_proberesp(struct ieee80211_node *, int);
 100 int     ieee80211_send_proberesp(struct ieee80211vap *,
 101                 const uint8_t da[IEEE80211_ADDR_LEN], int);
 102 struct mbuf *ieee80211_alloc_rts(struct ieee80211com *ic,
 103                 const uint8_t [IEEE80211_ADDR_LEN],
 104                 const uint8_t [IEEE80211_ADDR_LEN], uint16_t);
 105 struct mbuf *ieee80211_alloc_cts(struct ieee80211com *,
 106                 const uint8_t [IEEE80211_ADDR_LEN], uint16_t);
 107
 108 uint8_t *ieee80211_add_rates(uint8_t *, const struct ieee80211_rateset *);
 109 uint8_t *ieee80211_add_xrates(uint8_t *, const struct ieee80211_rateset *);
 110 uint16_t ieee80211_getcapinfo(struct ieee80211vap *,
 111                 struct ieee80211_channel *);
 112
 113 void    ieee80211_reset_erp(struct ieee80211com *);
 114 void    ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
 115 int     ieee80211_iserp_rateset(const struct ieee80211_rateset *);
 116 void    ieee80211_setbasicrates(struct ieee80211_rateset *,
 117                 enum ieee80211_phymode);
 118 void    ieee80211_addbasicrates(struct ieee80211_rateset *,
 119                 enum ieee80211_phymode);
 120
 121 /*
 122  * Return the size of the 802.11 header for a management or data frame.
 123  */
 124 static __inline int
 125 ieee80211_hdrsize(const void *data)
 126 {
 127         const struct ieee80211_frame *wh = data;
 128         int size = sizeof(struct ieee80211_frame);
 129
 130         /* NB: we don't handle control frames */
 131         KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
 132                 ("%s: control frame", __func__));
 133         if (IEEE80211_IS_DSTODS(wh))
 134                 size += IEEE80211_ADDR_LEN;
 135         if (IEEE80211_QOS_HAS_SEQ(wh))
 136                 size += sizeof(uint16_t);
 137         return size;
 138 }
 139
 140 /*
 141  * Like ieee80211_hdrsize, but handles any type of frame.
 142  */
 143 static __inline int
 144 ieee80211_anyhdrsize(const void *data)
 145 {
 146         const struct ieee80211_frame *wh = data;
 147
 148         if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
 149                 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
 150                 case IEEE80211_FC0_SUBTYPE_CTS:
 151                 case IEEE80211_FC0_SUBTYPE_ACK:
 152                         return sizeof(struct ieee80211_frame_ack);
 153                 case IEEE80211_FC0_SUBTYPE_BAR:
 154                         return sizeof(struct ieee80211_frame_bar);
 155                 }
 156                 return sizeof(struct ieee80211_frame_min);
 157         } else
 158                 return ieee80211_hdrsize(data);
 159 }
 160
 161 /*
 162  * Template for an in-kernel authenticator.  Authenticators
 163  * register with the protocol code and are typically loaded
 164  * as separate modules as needed.  One special authenticator
 165  * is xauth; it intercepts requests so that protocols like
 166  * WPA can be handled in user space.
 167  */
 168 struct ieee80211_authenticator {
 169         const char *ia_name;            /* printable name */
 170         int     (*ia_attach)(struct ieee80211vap *);
 171         void    (*ia_detach)(struct ieee80211vap *);
 172         void    (*ia_node_join)(struct ieee80211_node *);
 173         void    (*ia_node_leave)(struct ieee80211_node *);
 174 };
 175 void    ieee80211_authenticator_register(int type,
 176                 const struct ieee80211_authenticator *);
 177 void    ieee80211_authenticator_unregister(int type);
 178 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
 179
 180 struct ieee80211req;
 181 /*
 182  * Template for an MAC ACL policy module.  Such modules
 183  * register with the protocol code and are passed the sender's
 184  * address of each received auth frame for validation.
 185  */
 186 struct ieee80211_aclator {
 187         const char *iac_name;           /* printable name */
 188         int     (*iac_attach)(struct ieee80211vap *);
 189         void    (*iac_detach)(struct ieee80211vap *);
 190         int     (*iac_check)(struct ieee80211vap *,
 191                         const uint8_t mac[IEEE80211_ADDR_LEN]);
 192         int     (*iac_add)(struct ieee80211vap *,
 193                         const uint8_t mac[IEEE80211_ADDR_LEN]);
 194         int     (*iac_remove)(struct ieee80211vap *,
 195                         const uint8_t mac[IEEE80211_ADDR_LEN]);
 196         int     (*iac_flush)(struct ieee80211vap *);
 197         int     (*iac_setpolicy)(struct ieee80211vap *, int);
 198         int     (*iac_getpolicy)(struct ieee80211vap *);
 199         int     (*iac_setioctl)(struct ieee80211vap *, struct ieee80211req *);
 200         int     (*iac_getioctl)(struct ieee80211vap *, struct ieee80211req *);
 201 };
 202 void    ieee80211_aclator_register(const struct ieee80211_aclator *);
 203 void    ieee80211_aclator_unregister(const struct ieee80211_aclator *);
 204 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
 205
 206 /* flags for ieee80211_fix_rate() */
 207 #define IEEE80211_F_DOSORT      0x00000001      /* sort rate list */
 208 #define IEEE80211_F_DOFRATE     0x00000002      /* use fixed legacy rate */
 209 #define IEEE80211_F_DONEGO      0x00000004      /* calc negotiated rate */
 210 #define IEEE80211_F_DODEL       0x00000008      /* delete ignore rate */
 211 #define IEEE80211_F_DOBRS       0x00000010      /* check basic rate set */
 212 #define IEEE80211_F_JOIN        0x00000020      /* sta joining our bss */
 213 #define IEEE80211_F_DOFMCS      0x00000040      /* use fixed HT rate */
 214 int     ieee80211_fix_rate(struct ieee80211_node *,
 215                 struct ieee80211_rateset *, int);
 216
 217 /*
 218  * WME/WMM support.
 219  */
 220 struct wmeParams {
 221         uint8_t         wmep_acm;
 222         uint8_t         wmep_aifsn;
 223         uint8_t         wmep_logcwmin;          /* log2(cwmin) */
 224         uint8_t         wmep_logcwmax;          /* log2(cwmax) */
 225         uint8_t         wmep_txopLimit;
 226         uint8_t         wmep_noackPolicy;       /* 0 (ack), 1 (no ack) */
 227 };
 228 #define IEEE80211_TXOP_TO_US(_txop)     ((_txop)<<5)
 229 #define IEEE80211_US_TO_TXOP(_us)       ((_us)>>5)
 230
 231 struct chanAccParams {
 232         uint8_t         cap_info;               /* version of the current set */
 233         struct wmeParams cap_wmeParams[WME_NUM_AC];
 234 };
 235
 236 struct ieee80211_wme_state {
 237         u_int   wme_flags;
 238 #define WME_F_AGGRMODE  0x00000001      /* STATUS: WME agressive mode */
 239         u_int   wme_hipri_traffic;      /* VI/VO frames in beacon interval */
 240         u_int   wme_hipri_switch_thresh;/* agressive mode switch thresh */
 241         u_int   wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
 242
 243         struct wmeParams wme_params[4];         /* from assoc resp for each AC*/
 244         struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
 245         struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
 246         struct chanAccParams wme_chanParams;    /* params applied to self */
 247         struct chanAccParams wme_bssChanParams; /* params bcast to stations */
 248
 249         int     (*wme_update)(struct ieee80211com *);
 250 };
 251
 252 void    ieee80211_wme_initparams(struct ieee80211vap *);
 253 void    ieee80211_wme_updateparams(struct ieee80211vap *);
 254 void    ieee80211_wme_updateparams_locked(struct ieee80211vap *);
 255
 256 /*
 257  * Return the WME TID from a QoS frame.  If no TID
 258  * is present return the index for the "non-QoS" entry.
 259  */
 260 static __inline uint8_t
 261 ieee80211_gettid(const struct ieee80211_frame *wh)
 262 {
 263         uint8_t tid;
 264
 265         if (IEEE80211_QOS_HAS_SEQ(wh)) {
 266                 if (IEEE80211_IS_DSTODS(wh))
 267                         tid = ((const struct ieee80211_qosframe_addr4 *)wh)->
 268                                 i_qos[0];
 269                 else
 270                         tid = ((const struct ieee80211_qosframe *)wh)->i_qos[0];
 271                 tid &= IEEE80211_QOS_TID;
 272         } else
 273                 tid = IEEE80211_NONQOS_TID;
 274         return tid;
 275 }
 276
 277 void    ieee80211_waitfor_parent(struct ieee80211com *);
 278 void    ieee80211_start_locked(struct ieee80211vap *);
 279 void    ieee80211_init(void *);
 280 void    ieee80211_start_all(struct ieee80211com *);
 281 void    ieee80211_stop_locked(struct ieee80211vap *);
 282 void    ieee80211_stop(struct ieee80211vap *);
 283 void    ieee80211_stop_all(struct ieee80211com *);
 284 void    ieee80211_suspend_all(struct ieee80211com *);
 285 void    ieee80211_resume_all(struct ieee80211com *);
 286 void    ieee80211_dturbo_switch(struct ieee80211vap *, int newflags);
 287 void    ieee80211_swbmiss_callout(void *arg);
 288 void    ieee80211_beacon_miss(struct ieee80211com *);
 289 int     ieee80211_new_state(struct ieee80211vap *, enum ieee80211_state, int);
 290 void    ieee80211_print_essid(const uint8_t *, int);
 291 void    ieee80211_dump_pkt(struct ieee80211com *,
 292                 const uint8_t *, int, int, int);
 293
 294 extern  const char *ieee80211_opmode_name[];
 295 extern  const char *ieee80211_state_name[IEEE80211_S_MAX];
 296 extern  const char *ieee80211_wme_acnames[];
 297
 298 /*
 299  * Beacon frames constructed by ieee80211_beacon_alloc
 300  * have the following structure filled in so drivers
 301  * can update the frame later w/ minimal overhead.
 302  */
 303 struct ieee80211_beacon_offsets {
 304         uint8_t         bo_flags[4];    /* update/state flags */
 305         uint16_t        *bo_caps;       /* capabilities */
 306         uint8_t         *bo_cfp;        /* start of CFParms element */
 307         uint8_t         *bo_tim;        /* start of atim/dtim */
 308         uint8_t         *bo_wme;        /* start of WME parameters */
 309         uint8_t         *bo_tdma;       /* start of TDMA parameters */
 310         uint8_t         *bo_tim_trailer;/* start of fixed-size trailer */
 311         uint16_t        bo_tim_len;     /* atim/dtim length in bytes */
 312         uint16_t        bo_tim_trailer_len;/* tim trailer length in bytes */
 313         uint8_t         *bo_erp;        /* start of ERP element */
 314         uint8_t         *bo_htinfo;     /* start of HT info element */
 315         uint8_t         *bo_ath;        /* start of ATH parameters */
 316         uint8_t         *bo_appie;      /* start of AppIE element */
 317         uint16_t        bo_appie_len;   /* AppIE length in bytes */
 318         uint16_t        bo_csa_trailer_len;
 319         uint8_t         *bo_csa;        /* start of CSA element */
 320         uint8_t         *bo_meshconf;   /* start of MESHCONF element */
 321         uint8_t         *bo_spare[3];
 322 };
 323 struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *,
 324                 struct ieee80211_beacon_offsets *);
 325
 326 /*
 327  * Beacon frame updates are signaled through calls to iv_update_beacon
 328  * with one of the IEEE80211_BEACON_* tokens defined below.  For devices
 329  * that construct beacon frames on the host this can trigger a rebuild
 330  * or defer the processing.  For devices that offload beacon frame
 331  * handling this callback can be used to signal a rebuild.  The bo_flags
 332  * array in the ieee80211_beacon_offsets structure is intended to record
 333  * deferred processing requirements; ieee80211_beacon_update uses the
 334  * state to optimize work.  Since this structure is owned by the driver
 335  * and not visible to the 802.11 layer drivers must supply an iv_update_beacon
 336  * callback that marks the flag bits and schedules (as necessary) an update.
 337  */
 338 enum {
 339         IEEE80211_BEACON_CAPS   = 0,    /* capabilities */
 340         IEEE80211_BEACON_TIM    = 1,    /* DTIM/ATIM */
 341         IEEE80211_BEACON_WME    = 2,
 342         IEEE80211_BEACON_ERP    = 3,    /* Extended Rate Phy */
 343         IEEE80211_BEACON_HTINFO = 4,    /* HT Information */
 344         IEEE80211_BEACON_APPIE  = 5,    /* Application IE's */
 345         IEEE80211_BEACON_CFP    = 6,    /* CFParms */
 346         IEEE80211_BEACON_CSA    = 7,    /* Channel Switch Announcement */
 347         IEEE80211_BEACON_TDMA   = 9,    /* TDMA Info */
 348         IEEE80211_BEACON_ATH    = 10,   /* ATH parameters */
 349         IEEE80211_BEACON_MESHCONF = 11, /* Mesh Configuration */
 350 };
 351 int     ieee80211_beacon_update(struct ieee80211_node *,
 352                 struct ieee80211_beacon_offsets *, struct mbuf *, int mcast);
 353
 354 void    ieee80211_csa_startswitch(struct ieee80211com *,
 355                 struct ieee80211_channel *, int mode, int count);
 356 void    ieee80211_csa_completeswitch(struct ieee80211com *);
 357 void    ieee80211_csa_cancelswitch(struct ieee80211com *);
 358 void    ieee80211_cac_completeswitch(struct ieee80211vap *);
 359
 360 /*
 361  * Notification methods called from the 802.11 state machine.
 362  * Note that while these are defined here, their implementation
 363  * is OS-specific.
 364  */
 365 void    ieee80211_notify_node_join(struct ieee80211_node *, int newassoc);
 366 void    ieee80211_notify_node_leave(struct ieee80211_node *);
 367 void    ieee80211_notify_scan_done(struct ieee80211vap *);
 368 void    ieee80211_notify_wds_discover(struct ieee80211_node *);
 369 void    ieee80211_notify_csa(struct ieee80211com *,
 370                 const struct ieee80211_channel *, int mode, int count);
 371 void    ieee80211_notify_radar(struct ieee80211com *,
 372                 const struct ieee80211_channel *);
 373 enum ieee80211_notify_cac_event {
 374         IEEE80211_NOTIFY_CAC_START  = 0, /* CAC timer started */
 375         IEEE80211_NOTIFY_CAC_STOP   = 1, /* CAC intentionally stopped */
 376         IEEE80211_NOTIFY_CAC_RADAR  = 2, /* CAC stopped due to radar detectio */
 377         IEEE80211_NOTIFY_CAC_EXPIRE = 3, /* CAC expired w/o radar */
 378 };
 379 void    ieee80211_notify_cac(struct ieee80211com *,
 380                 const struct ieee80211_channel *,
 381                 enum ieee80211_notify_cac_event);
 382 void    ieee80211_notify_node_deauth(struct ieee80211_node *);
 383 void    ieee80211_notify_node_auth(struct ieee80211_node *);
 384 void    ieee80211_notify_country(struct ieee80211vap *, const uint8_t [],
 385                 const uint8_t cc[2]);
 386 void    ieee80211_notify_radio(struct ieee80211com *, int);
 387 #endif /* _NET80211_IEEE80211_PROTO_H_ */