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