]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/net80211/ieee80211_proto.c
[net80211] Migrate short slot time configuration into per-vap and deferred taskqueue...
[FreeBSD/FreeBSD.git] / sys / net80211 / ieee80211_proto.c
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2001 Atsushi Onoe
5  * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
6  * Copyright (c) 2012 IEEE
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32
33 /*
34  * IEEE 802.11 protocol support.
35  */
36
37 #include "opt_inet.h"
38 #include "opt_wlan.h"
39
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/kernel.h>
43 #include <sys/malloc.h>
44
45 #include <sys/socket.h>
46 #include <sys/sockio.h>
47
48 #include <net/if.h>
49 #include <net/if_var.h>
50 #include <net/if_media.h>
51 #include <net/ethernet.h>               /* XXX for ether_sprintf */
52
53 #include <net80211/ieee80211_var.h>
54 #include <net80211/ieee80211_adhoc.h>
55 #include <net80211/ieee80211_sta.h>
56 #include <net80211/ieee80211_hostap.h>
57 #include <net80211/ieee80211_wds.h>
58 #ifdef IEEE80211_SUPPORT_MESH
59 #include <net80211/ieee80211_mesh.h>
60 #endif
61 #include <net80211/ieee80211_monitor.h>
62 #include <net80211/ieee80211_input.h>
63
64 /* XXX tunables */
65 #define AGGRESSIVE_MODE_SWITCH_HYSTERESIS       3       /* pkts / 100ms */
66 #define HIGH_PRI_SWITCH_THRESH                  10      /* pkts / 100ms */
67
68 const char *mgt_subtype_name[] = {
69         "assoc_req",    "assoc_resp",   "reassoc_req",  "reassoc_resp",
70         "probe_req",    "probe_resp",   "timing_adv",   "reserved#7",
71         "beacon",       "atim",         "disassoc",     "auth",
72         "deauth",       "action",       "action_noack", "reserved#15"
73 };
74 const char *ctl_subtype_name[] = {
75         "reserved#0",   "reserved#1",   "reserved#2",   "reserved#3",
76         "reserved#4",   "reserved#5",   "reserved#6",   "control_wrap",
77         "bar",          "ba",           "ps_poll",      "rts",
78         "cts",          "ack",          "cf_end",       "cf_end_ack"
79 };
80 const char *ieee80211_opmode_name[IEEE80211_OPMODE_MAX] = {
81         "IBSS",         /* IEEE80211_M_IBSS */
82         "STA",          /* IEEE80211_M_STA */
83         "WDS",          /* IEEE80211_M_WDS */
84         "AHDEMO",       /* IEEE80211_M_AHDEMO */
85         "HOSTAP",       /* IEEE80211_M_HOSTAP */
86         "MONITOR",      /* IEEE80211_M_MONITOR */
87         "MBSS"          /* IEEE80211_M_MBSS */
88 };
89 const char *ieee80211_state_name[IEEE80211_S_MAX] = {
90         "INIT",         /* IEEE80211_S_INIT */
91         "SCAN",         /* IEEE80211_S_SCAN */
92         "AUTH",         /* IEEE80211_S_AUTH */
93         "ASSOC",        /* IEEE80211_S_ASSOC */
94         "CAC",          /* IEEE80211_S_CAC */
95         "RUN",          /* IEEE80211_S_RUN */
96         "CSA",          /* IEEE80211_S_CSA */
97         "SLEEP",        /* IEEE80211_S_SLEEP */
98 };
99 const char *ieee80211_wme_acnames[] = {
100         "WME_AC_BE",
101         "WME_AC_BK",
102         "WME_AC_VI",
103         "WME_AC_VO",
104         "WME_UPSD",
105 };
106
107
108 /*
109  * Reason code descriptions were (mostly) obtained from
110  * IEEE Std 802.11-2012, pp. 442-445 Table 8-36.
111  */
112 const char *
113 ieee80211_reason_to_string(uint16_t reason)
114 {
115         switch (reason) {
116         case IEEE80211_REASON_UNSPECIFIED:
117                 return ("unspecified");
118         case IEEE80211_REASON_AUTH_EXPIRE:
119                 return ("previous authentication is expired");
120         case IEEE80211_REASON_AUTH_LEAVE:
121                 return ("sending STA is leaving/has left IBSS or ESS");
122         case IEEE80211_REASON_ASSOC_EXPIRE:
123                 return ("disassociated due to inactivity");
124         case IEEE80211_REASON_ASSOC_TOOMANY:
125                 return ("too many associated STAs");
126         case IEEE80211_REASON_NOT_AUTHED:
127                 return ("class 2 frame received from nonauthenticated STA");
128         case IEEE80211_REASON_NOT_ASSOCED:
129                 return ("class 3 frame received from nonassociated STA");
130         case IEEE80211_REASON_ASSOC_LEAVE:
131                 return ("sending STA is leaving/has left BSS");
132         case IEEE80211_REASON_ASSOC_NOT_AUTHED:
133                 return ("STA requesting (re)association is not authenticated");
134         case IEEE80211_REASON_DISASSOC_PWRCAP_BAD:
135                 return ("information in the Power Capability element is "
136                         "unacceptable");
137         case IEEE80211_REASON_DISASSOC_SUPCHAN_BAD:
138                 return ("information in the Supported Channels element is "
139                         "unacceptable");
140         case IEEE80211_REASON_IE_INVALID:
141                 return ("invalid element");
142         case IEEE80211_REASON_MIC_FAILURE:
143                 return ("MIC failure");
144         case IEEE80211_REASON_4WAY_HANDSHAKE_TIMEOUT:
145                 return ("4-Way handshake timeout");
146         case IEEE80211_REASON_GROUP_KEY_UPDATE_TIMEOUT:
147                 return ("group key update timeout");
148         case IEEE80211_REASON_IE_IN_4WAY_DIFFERS:
149                 return ("element in 4-Way handshake different from "
150                         "(re)association request/probe response/beacon frame");
151         case IEEE80211_REASON_GROUP_CIPHER_INVALID:
152                 return ("invalid group cipher");
153         case IEEE80211_REASON_PAIRWISE_CIPHER_INVALID:
154                 return ("invalid pairwise cipher");
155         case IEEE80211_REASON_AKMP_INVALID:
156                 return ("invalid AKMP");
157         case IEEE80211_REASON_UNSUPP_RSN_IE_VERSION:
158                 return ("unsupported version in RSN IE");
159         case IEEE80211_REASON_INVALID_RSN_IE_CAP:
160                 return ("invalid capabilities in RSN IE");
161         case IEEE80211_REASON_802_1X_AUTH_FAILED:
162                 return ("IEEE 802.1X authentication failed");
163         case IEEE80211_REASON_CIPHER_SUITE_REJECTED:
164                 return ("cipher suite rejected because of the security "
165                         "policy");
166         case IEEE80211_REASON_UNSPECIFIED_QOS:
167                 return ("unspecified (QoS-related)");
168         case IEEE80211_REASON_INSUFFICIENT_BW:
169                 return ("QoS AP lacks sufficient bandwidth for this QoS STA");
170         case IEEE80211_REASON_TOOMANY_FRAMES:
171                 return ("too many frames need to be acknowledged");
172         case IEEE80211_REASON_OUTSIDE_TXOP:
173                 return ("STA is transmitting outside the limits of its TXOPs");
174         case IEEE80211_REASON_LEAVING_QBSS:
175                 return ("requested from peer STA (the STA is "
176                         "resetting/leaving the BSS)");
177         case IEEE80211_REASON_BAD_MECHANISM:
178                 return ("requested from peer STA (it does not want to use "
179                         "the mechanism)");
180         case IEEE80211_REASON_SETUP_NEEDED:
181                 return ("requested from peer STA (setup is required for the "
182                         "used mechanism)");
183         case IEEE80211_REASON_TIMEOUT:
184                 return ("requested from peer STA (timeout)");
185         case IEEE80211_REASON_PEER_LINK_CANCELED:
186                 return ("SME cancels the mesh peering instance (not related "
187                         "to the maximum number of peer mesh STAs)");
188         case IEEE80211_REASON_MESH_MAX_PEERS:
189                 return ("maximum number of peer mesh STAs was reached");
190         case IEEE80211_REASON_MESH_CPVIOLATION:
191                 return ("the received information violates the Mesh "
192                         "Configuration policy configured in the mesh STA "
193                         "profile");
194         case IEEE80211_REASON_MESH_CLOSE_RCVD:
195                 return ("the mesh STA has received a Mesh Peering Close "
196                         "message requesting to close the mesh peering");
197         case IEEE80211_REASON_MESH_MAX_RETRIES:
198                 return ("the mesh STA has resent dot11MeshMaxRetries Mesh "
199                         "Peering Open messages, without receiving a Mesh "
200                         "Peering Confirm message");
201         case IEEE80211_REASON_MESH_CONFIRM_TIMEOUT:
202                 return ("the confirmTimer for the mesh peering instance times "
203                         "out");
204         case IEEE80211_REASON_MESH_INVALID_GTK:
205                 return ("the mesh STA fails to unwrap the GTK or the values "
206                         "in the wrapped contents do not match");
207         case IEEE80211_REASON_MESH_INCONS_PARAMS:
208                 return ("the mesh STA receives inconsistent information about "
209                         "the mesh parameters between Mesh Peering Management "
210                         "frames");
211         case IEEE80211_REASON_MESH_INVALID_SECURITY:
212                 return ("the mesh STA fails the authenticated mesh peering "
213                         "exchange because due to failure in selecting "
214                         "pairwise/group ciphersuite");
215         case IEEE80211_REASON_MESH_PERR_NO_PROXY:
216                 return ("the mesh STA does not have proxy information for "
217                         "this external destination");
218         case IEEE80211_REASON_MESH_PERR_NO_FI:
219                 return ("the mesh STA does not have forwarding information "
220                         "for this destination");
221         case IEEE80211_REASON_MESH_PERR_DEST_UNREACH:
222                 return ("the mesh STA determines that the link to the next "
223                         "hop of an active path in its forwarding information "
224                         "is no longer usable");
225         case IEEE80211_REASON_MESH_MAC_ALRDY_EXISTS_MBSS:
226                 return ("the MAC address of the STA already exists in the "
227                         "mesh BSS");
228         case IEEE80211_REASON_MESH_CHAN_SWITCH_REG:
229                 return ("the mesh STA performs channel switch to meet "
230                         "regulatory requirements");
231         case IEEE80211_REASON_MESH_CHAN_SWITCH_UNSPEC:
232                 return ("the mesh STA performs channel switch with "
233                         "unspecified reason");
234         default:
235                 return ("reserved/unknown");
236         }
237 }
238
239 static void beacon_miss(void *, int);
240 static void beacon_swmiss(void *, int);
241 static void parent_updown(void *, int);
242 static void update_mcast(void *, int);
243 static void update_promisc(void *, int);
244 static void update_channel(void *, int);
245 static void update_chw(void *, int);
246 static void vap_update_wme(void *, int);
247 static void vap_update_slot(void *, int);
248 static void restart_vaps(void *, int);
249 static void ieee80211_newstate_cb(void *, int);
250
251 static int
252 null_raw_xmit(struct ieee80211_node *ni, struct mbuf *m,
253         const struct ieee80211_bpf_params *params)
254 {
255
256         ic_printf(ni->ni_ic, "missing ic_raw_xmit callback, drop frame\n");
257         m_freem(m);
258         return ENETDOWN;
259 }
260
261 void
262 ieee80211_proto_attach(struct ieee80211com *ic)
263 {
264         uint8_t hdrlen;
265
266         /* override the 802.3 setting */
267         hdrlen = ic->ic_headroom
268                 + sizeof(struct ieee80211_qosframe_addr4)
269                 + IEEE80211_WEP_IVLEN + IEEE80211_WEP_KIDLEN
270                 + IEEE80211_WEP_EXTIVLEN;
271         /* XXX no way to recalculate on ifdetach */
272         if (ALIGN(hdrlen) > max_linkhdr) {
273                 /* XXX sanity check... */
274                 max_linkhdr = ALIGN(hdrlen);
275                 max_hdr = max_linkhdr + max_protohdr;
276                 max_datalen = MHLEN - max_hdr;
277         }
278         ic->ic_protmode = IEEE80211_PROT_CTSONLY;
279
280         TASK_INIT(&ic->ic_parent_task, 0, parent_updown, ic);
281         TASK_INIT(&ic->ic_mcast_task, 0, update_mcast, ic);
282         TASK_INIT(&ic->ic_promisc_task, 0, update_promisc, ic);
283         TASK_INIT(&ic->ic_chan_task, 0, update_channel, ic);
284         TASK_INIT(&ic->ic_bmiss_task, 0, beacon_miss, ic);
285         TASK_INIT(&ic->ic_chw_task, 0, update_chw, ic);
286         TASK_INIT(&ic->ic_restart_task, 0, restart_vaps, ic);
287
288         ic->ic_wme.wme_hipri_switch_hysteresis =
289                 AGGRESSIVE_MODE_SWITCH_HYSTERESIS;
290
291         /* initialize management frame handlers */
292         ic->ic_send_mgmt = ieee80211_send_mgmt;
293         ic->ic_raw_xmit = null_raw_xmit;
294
295         ieee80211_adhoc_attach(ic);
296         ieee80211_sta_attach(ic);
297         ieee80211_wds_attach(ic);
298         ieee80211_hostap_attach(ic);
299 #ifdef IEEE80211_SUPPORT_MESH
300         ieee80211_mesh_attach(ic);
301 #endif
302         ieee80211_monitor_attach(ic);
303 }
304
305 void
306 ieee80211_proto_detach(struct ieee80211com *ic)
307 {
308         ieee80211_monitor_detach(ic);
309 #ifdef IEEE80211_SUPPORT_MESH
310         ieee80211_mesh_detach(ic);
311 #endif
312         ieee80211_hostap_detach(ic);
313         ieee80211_wds_detach(ic);
314         ieee80211_adhoc_detach(ic);
315         ieee80211_sta_detach(ic);
316 }
317
318 static void
319 null_update_beacon(struct ieee80211vap *vap, int item)
320 {
321 }
322
323 void
324 ieee80211_proto_vattach(struct ieee80211vap *vap)
325 {
326         struct ieee80211com *ic = vap->iv_ic;
327         struct ifnet *ifp = vap->iv_ifp;
328         int i;
329
330         /* override the 802.3 setting */
331         ifp->if_hdrlen = ic->ic_headroom
332                 + sizeof(struct ieee80211_qosframe_addr4)
333                 + IEEE80211_WEP_IVLEN + IEEE80211_WEP_KIDLEN
334                 + IEEE80211_WEP_EXTIVLEN;
335
336         vap->iv_rtsthreshold = IEEE80211_RTS_DEFAULT;
337         vap->iv_fragthreshold = IEEE80211_FRAG_DEFAULT;
338         vap->iv_bmiss_max = IEEE80211_BMISS_MAX;
339         callout_init_mtx(&vap->iv_swbmiss, IEEE80211_LOCK_OBJ(ic), 0);
340         callout_init(&vap->iv_mgtsend, 1);
341         TASK_INIT(&vap->iv_nstate_task, 0, ieee80211_newstate_cb, vap);
342         TASK_INIT(&vap->iv_swbmiss_task, 0, beacon_swmiss, vap);
343         TASK_INIT(&vap->iv_wme_task, 0, vap_update_wme, vap);
344         TASK_INIT(&vap->iv_slot_task, 0, vap_update_slot, vap);
345         /*
346          * Install default tx rate handling: no fixed rate, lowest
347          * supported rate for mgmt and multicast frames.  Default
348          * max retry count.  These settings can be changed by the
349          * driver and/or user applications.
350          */
351         for (i = IEEE80211_MODE_11A; i < IEEE80211_MODE_MAX; i++) {
352                 if (isclr(ic->ic_modecaps, i))
353                         continue;
354
355                 const struct ieee80211_rateset *rs = &ic->ic_sup_rates[i];
356
357                 vap->iv_txparms[i].ucastrate = IEEE80211_FIXED_RATE_NONE;
358
359                 /*
360                  * Setting the management rate to MCS 0 assumes that the
361                  * BSS Basic rate set is empty and the BSS Basic MCS set
362                  * is not.
363                  *
364                  * Since we're not checking this, default to the lowest
365                  * defined rate for this mode.
366                  *
367                  * At least one 11n AP (DLINK DIR-825) is reported to drop
368                  * some MCS management traffic (eg BA response frames.)
369                  *
370                  * See also: 9.6.0 of the 802.11n-2009 specification.
371                  */
372 #ifdef  NOTYET
373                 if (i == IEEE80211_MODE_11NA || i == IEEE80211_MODE_11NG) {
374                         vap->iv_txparms[i].mgmtrate = 0 | IEEE80211_RATE_MCS;
375                         vap->iv_txparms[i].mcastrate = 0 | IEEE80211_RATE_MCS;
376                 } else {
377                         vap->iv_txparms[i].mgmtrate =
378                             rs->rs_rates[0] & IEEE80211_RATE_VAL;
379                         vap->iv_txparms[i].mcastrate = 
380                             rs->rs_rates[0] & IEEE80211_RATE_VAL;
381                 }
382 #endif
383                 vap->iv_txparms[i].mgmtrate = rs->rs_rates[0] & IEEE80211_RATE_VAL;
384                 vap->iv_txparms[i].mcastrate = rs->rs_rates[0] & IEEE80211_RATE_VAL;
385                 vap->iv_txparms[i].maxretry = IEEE80211_TXMAX_DEFAULT;
386         }
387         vap->iv_roaming = IEEE80211_ROAMING_AUTO;
388
389         vap->iv_update_beacon = null_update_beacon;
390         vap->iv_deliver_data = ieee80211_deliver_data;
391
392         /* attach support for operating mode */
393         ic->ic_vattach[vap->iv_opmode](vap);
394 }
395
396 void
397 ieee80211_proto_vdetach(struct ieee80211vap *vap)
398 {
399 #define FREEAPPIE(ie) do { \
400         if (ie != NULL) \
401                 IEEE80211_FREE(ie, M_80211_NODE_IE); \
402 } while (0)
403         /*
404          * Detach operating mode module.
405          */
406         if (vap->iv_opdetach != NULL)
407                 vap->iv_opdetach(vap);
408         /*
409          * This should not be needed as we detach when reseting
410          * the state but be conservative here since the
411          * authenticator may do things like spawn kernel threads.
412          */
413         if (vap->iv_auth->ia_detach != NULL)
414                 vap->iv_auth->ia_detach(vap);
415         /*
416          * Detach any ACL'ator.
417          */
418         if (vap->iv_acl != NULL)
419                 vap->iv_acl->iac_detach(vap);
420
421         FREEAPPIE(vap->iv_appie_beacon);
422         FREEAPPIE(vap->iv_appie_probereq);
423         FREEAPPIE(vap->iv_appie_proberesp);
424         FREEAPPIE(vap->iv_appie_assocreq);
425         FREEAPPIE(vap->iv_appie_assocresp);
426         FREEAPPIE(vap->iv_appie_wpa);
427 #undef FREEAPPIE
428 }
429
430 /*
431  * Simple-minded authenticator module support.
432  */
433
434 #define IEEE80211_AUTH_MAX      (IEEE80211_AUTH_WPA+1)
435 /* XXX well-known names */
436 static const char *auth_modnames[IEEE80211_AUTH_MAX] = {
437         "wlan_internal",        /* IEEE80211_AUTH_NONE */
438         "wlan_internal",        /* IEEE80211_AUTH_OPEN */
439         "wlan_internal",        /* IEEE80211_AUTH_SHARED */
440         "wlan_xauth",           /* IEEE80211_AUTH_8021X  */
441         "wlan_internal",        /* IEEE80211_AUTH_AUTO */
442         "wlan_xauth",           /* IEEE80211_AUTH_WPA */
443 };
444 static const struct ieee80211_authenticator *authenticators[IEEE80211_AUTH_MAX];
445
446 static const struct ieee80211_authenticator auth_internal = {
447         .ia_name                = "wlan_internal",
448         .ia_attach              = NULL,
449         .ia_detach              = NULL,
450         .ia_node_join           = NULL,
451         .ia_node_leave          = NULL,
452 };
453
454 /*
455  * Setup internal authenticators once; they are never unregistered.
456  */
457 static void
458 ieee80211_auth_setup(void)
459 {
460         ieee80211_authenticator_register(IEEE80211_AUTH_OPEN, &auth_internal);
461         ieee80211_authenticator_register(IEEE80211_AUTH_SHARED, &auth_internal);
462         ieee80211_authenticator_register(IEEE80211_AUTH_AUTO, &auth_internal);
463 }
464 SYSINIT(wlan_auth, SI_SUB_DRIVERS, SI_ORDER_FIRST, ieee80211_auth_setup, NULL);
465
466 const struct ieee80211_authenticator *
467 ieee80211_authenticator_get(int auth)
468 {
469         if (auth >= IEEE80211_AUTH_MAX)
470                 return NULL;
471         if (authenticators[auth] == NULL)
472                 ieee80211_load_module(auth_modnames[auth]);
473         return authenticators[auth];
474 }
475
476 void
477 ieee80211_authenticator_register(int type,
478         const struct ieee80211_authenticator *auth)
479 {
480         if (type >= IEEE80211_AUTH_MAX)
481                 return;
482         authenticators[type] = auth;
483 }
484
485 void
486 ieee80211_authenticator_unregister(int type)
487 {
488
489         if (type >= IEEE80211_AUTH_MAX)
490                 return;
491         authenticators[type] = NULL;
492 }
493
494 /*
495  * Very simple-minded ACL module support.
496  */
497 /* XXX just one for now */
498 static  const struct ieee80211_aclator *acl = NULL;
499
500 void
501 ieee80211_aclator_register(const struct ieee80211_aclator *iac)
502 {
503         printf("wlan: %s acl policy registered\n", iac->iac_name);
504         acl = iac;
505 }
506
507 void
508 ieee80211_aclator_unregister(const struct ieee80211_aclator *iac)
509 {
510         if (acl == iac)
511                 acl = NULL;
512         printf("wlan: %s acl policy unregistered\n", iac->iac_name);
513 }
514
515 const struct ieee80211_aclator *
516 ieee80211_aclator_get(const char *name)
517 {
518         if (acl == NULL)
519                 ieee80211_load_module("wlan_acl");
520         return acl != NULL && strcmp(acl->iac_name, name) == 0 ? acl : NULL;
521 }
522
523 void
524 ieee80211_print_essid(const uint8_t *essid, int len)
525 {
526         const uint8_t *p;
527         int i;
528
529         if (len > IEEE80211_NWID_LEN)
530                 len = IEEE80211_NWID_LEN;
531         /* determine printable or not */
532         for (i = 0, p = essid; i < len; i++, p++) {
533                 if (*p < ' ' || *p > 0x7e)
534                         break;
535         }
536         if (i == len) {
537                 printf("\"");
538                 for (i = 0, p = essid; i < len; i++, p++)
539                         printf("%c", *p);
540                 printf("\"");
541         } else {
542                 printf("0x");
543                 for (i = 0, p = essid; i < len; i++, p++)
544                         printf("%02x", *p);
545         }
546 }
547
548 void
549 ieee80211_dump_pkt(struct ieee80211com *ic,
550         const uint8_t *buf, int len, int rate, int rssi)
551 {
552         const struct ieee80211_frame *wh;
553         int i;
554
555         wh = (const struct ieee80211_frame *)buf;
556         switch (wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) {
557         case IEEE80211_FC1_DIR_NODS:
558                 printf("NODS %s", ether_sprintf(wh->i_addr2));
559                 printf("->%s", ether_sprintf(wh->i_addr1));
560                 printf("(%s)", ether_sprintf(wh->i_addr3));
561                 break;
562         case IEEE80211_FC1_DIR_TODS:
563                 printf("TODS %s", ether_sprintf(wh->i_addr2));
564                 printf("->%s", ether_sprintf(wh->i_addr3));
565                 printf("(%s)", ether_sprintf(wh->i_addr1));
566                 break;
567         case IEEE80211_FC1_DIR_FROMDS:
568                 printf("FRDS %s", ether_sprintf(wh->i_addr3));
569                 printf("->%s", ether_sprintf(wh->i_addr1));
570                 printf("(%s)", ether_sprintf(wh->i_addr2));
571                 break;
572         case IEEE80211_FC1_DIR_DSTODS:
573                 printf("DSDS %s", ether_sprintf((const uint8_t *)&wh[1]));
574                 printf("->%s", ether_sprintf(wh->i_addr3));
575                 printf("(%s", ether_sprintf(wh->i_addr2));
576                 printf("->%s)", ether_sprintf(wh->i_addr1));
577                 break;
578         }
579         switch (wh->i_fc[0] & IEEE80211_FC0_TYPE_MASK) {
580         case IEEE80211_FC0_TYPE_DATA:
581                 printf(" data");
582                 break;
583         case IEEE80211_FC0_TYPE_MGT:
584                 printf(" %s", ieee80211_mgt_subtype_name(wh->i_fc[0]));
585                 break;
586         default:
587                 printf(" type#%d", wh->i_fc[0] & IEEE80211_FC0_TYPE_MASK);
588                 break;
589         }
590         if (IEEE80211_QOS_HAS_SEQ(wh)) {
591                 const struct ieee80211_qosframe *qwh = 
592                         (const struct ieee80211_qosframe *)buf;
593                 printf(" QoS [TID %u%s]", qwh->i_qos[0] & IEEE80211_QOS_TID,
594                         qwh->i_qos[0] & IEEE80211_QOS_ACKPOLICY ? " ACM" : "");
595         }
596         if (wh->i_fc[1] & IEEE80211_FC1_PROTECTED) {
597                 int off;
598
599                 off = ieee80211_anyhdrspace(ic, wh);
600                 printf(" WEP [IV %.02x %.02x %.02x",
601                         buf[off+0], buf[off+1], buf[off+2]);
602                 if (buf[off+IEEE80211_WEP_IVLEN] & IEEE80211_WEP_EXTIV)
603                         printf(" %.02x %.02x %.02x",
604                                 buf[off+4], buf[off+5], buf[off+6]);
605                 printf(" KID %u]", buf[off+IEEE80211_WEP_IVLEN] >> 6);
606         }
607         if (rate >= 0)
608                 printf(" %dM", rate / 2);
609         if (rssi >= 0)
610                 printf(" +%d", rssi);
611         printf("\n");
612         if (len > 0) {
613                 for (i = 0; i < len; i++) {
614                         if ((i & 1) == 0)
615                                 printf(" ");
616                         printf("%02x", buf[i]);
617                 }
618                 printf("\n");
619         }
620 }
621
622 static __inline int
623 findrix(const struct ieee80211_rateset *rs, int r)
624 {
625         int i;
626
627         for (i = 0; i < rs->rs_nrates; i++)
628                 if ((rs->rs_rates[i] & IEEE80211_RATE_VAL) == r)
629                         return i;
630         return -1;
631 }
632
633 int
634 ieee80211_fix_rate(struct ieee80211_node *ni,
635         struct ieee80211_rateset *nrs, int flags)
636 {
637         struct ieee80211vap *vap = ni->ni_vap;
638         struct ieee80211com *ic = ni->ni_ic;
639         int i, j, rix, error;
640         int okrate, badrate, fixedrate, ucastrate;
641         const struct ieee80211_rateset *srs;
642         uint8_t r;
643
644         error = 0;
645         okrate = badrate = 0;
646         ucastrate = vap->iv_txparms[ieee80211_chan2mode(ni->ni_chan)].ucastrate;
647         if (ucastrate != IEEE80211_FIXED_RATE_NONE) {
648                 /*
649                  * Workaround awkwardness with fixed rate.  We are called
650                  * to check both the legacy rate set and the HT rate set
651                  * but we must apply any legacy fixed rate check only to the
652                  * legacy rate set and vice versa.  We cannot tell what type
653                  * of rate set we've been given (legacy or HT) but we can
654                  * distinguish the fixed rate type (MCS have 0x80 set).
655                  * So to deal with this the caller communicates whether to
656                  * check MCS or legacy rate using the flags and we use the
657                  * type of any fixed rate to avoid applying an MCS to a
658                  * legacy rate and vice versa.
659                  */
660                 if (ucastrate & 0x80) {
661                         if (flags & IEEE80211_F_DOFRATE)
662                                 flags &= ~IEEE80211_F_DOFRATE;
663                 } else if ((ucastrate & 0x80) == 0) {
664                         if (flags & IEEE80211_F_DOFMCS)
665                                 flags &= ~IEEE80211_F_DOFMCS;
666                 }
667                 /* NB: required to make MCS match below work */
668                 ucastrate &= IEEE80211_RATE_VAL;
669         }
670         fixedrate = IEEE80211_FIXED_RATE_NONE;
671         /*
672          * XXX we are called to process both MCS and legacy rates;
673          * we must use the appropriate basic rate set or chaos will
674          * ensue; for now callers that want MCS must supply
675          * IEEE80211_F_DOBRS; at some point we'll need to split this
676          * function so there are two variants, one for MCS and one
677          * for legacy rates.
678          */
679         if (flags & IEEE80211_F_DOBRS)
680                 srs = (const struct ieee80211_rateset *)
681                     ieee80211_get_suphtrates(ic, ni->ni_chan);
682         else
683                 srs = ieee80211_get_suprates(ic, ni->ni_chan);
684         for (i = 0; i < nrs->rs_nrates; ) {
685                 if (flags & IEEE80211_F_DOSORT) {
686                         /*
687                          * Sort rates.
688                          */
689                         for (j = i + 1; j < nrs->rs_nrates; j++) {
690                                 if (IEEE80211_RV(nrs->rs_rates[i]) >
691                                     IEEE80211_RV(nrs->rs_rates[j])) {
692                                         r = nrs->rs_rates[i];
693                                         nrs->rs_rates[i] = nrs->rs_rates[j];
694                                         nrs->rs_rates[j] = r;
695                                 }
696                         }
697                 }
698                 r = nrs->rs_rates[i] & IEEE80211_RATE_VAL;
699                 badrate = r;
700                 /*
701                  * Check for fixed rate.
702                  */
703                 if (r == ucastrate)
704                         fixedrate = r;
705                 /*
706                  * Check against supported rates.
707                  */
708                 rix = findrix(srs, r);
709                 if (flags & IEEE80211_F_DONEGO) {
710                         if (rix < 0) {
711                                 /*
712                                  * A rate in the node's rate set is not
713                                  * supported.  If this is a basic rate and we
714                                  * are operating as a STA then this is an error.
715                                  * Otherwise we just discard/ignore the rate.
716                                  */
717                                 if ((flags & IEEE80211_F_JOIN) &&
718                                     (nrs->rs_rates[i] & IEEE80211_RATE_BASIC))
719                                         error++;
720                         } else if ((flags & IEEE80211_F_JOIN) == 0) {
721                                 /*
722                                  * Overwrite with the supported rate
723                                  * value so any basic rate bit is set.
724                                  */
725                                 nrs->rs_rates[i] = srs->rs_rates[rix];
726                         }
727                 }
728                 if ((flags & IEEE80211_F_DODEL) && rix < 0) {
729                         /*
730                          * Delete unacceptable rates.
731                          */
732                         nrs->rs_nrates--;
733                         for (j = i; j < nrs->rs_nrates; j++)
734                                 nrs->rs_rates[j] = nrs->rs_rates[j + 1];
735                         nrs->rs_rates[j] = 0;
736                         continue;
737                 }
738                 if (rix >= 0)
739                         okrate = nrs->rs_rates[i];
740                 i++;
741         }
742         if (okrate == 0 || error != 0 ||
743             ((flags & (IEEE80211_F_DOFRATE|IEEE80211_F_DOFMCS)) &&
744              fixedrate != ucastrate)) {
745                 IEEE80211_NOTE(vap, IEEE80211_MSG_XRATE | IEEE80211_MSG_11N, ni,
746                     "%s: flags 0x%x okrate %d error %d fixedrate 0x%x "
747                     "ucastrate %x\n", __func__, fixedrate, ucastrate, flags);
748                 return badrate | IEEE80211_RATE_BASIC;
749         } else
750                 return IEEE80211_RV(okrate);
751 }
752
753 /*
754  * Reset 11g-related state.
755  *
756  * This is for per-VAP ERP/11g state.
757  *
758  * Eventually everything in ieee80211_reset_erp() will be
759  * per-VAP and in here.
760  */
761 void
762 ieee80211_vap_reset_erp(struct ieee80211vap *vap)
763 {
764         struct ieee80211com *ic = vap->iv_ic;
765
766         /*
767          * Short slot time is enabled only when operating in 11g
768          * and not in an IBSS.  We must also honor whether or not
769          * the driver is capable of doing it.
770          */
771         ieee80211_vap_set_shortslottime(vap,
772                 IEEE80211_IS_CHAN_A(ic->ic_curchan) ||
773                 IEEE80211_IS_CHAN_HT(ic->ic_curchan) ||
774                 (IEEE80211_IS_CHAN_ANYG(ic->ic_curchan) &&
775                 vap->iv_opmode == IEEE80211_M_HOSTAP &&
776                 (ic->ic_caps & IEEE80211_C_SHSLOT)));
777 }
778
779 /*
780  * Reset 11g-related state.
781  */
782 void
783 ieee80211_reset_erp(struct ieee80211com *ic)
784 {
785         ic->ic_flags &= ~IEEE80211_F_USEPROT;
786         ic->ic_nonerpsta = 0;
787         ic->ic_longslotsta = 0;
788         /*
789          * Set short preamble and ERP barker-preamble flags.
790          */
791         if (IEEE80211_IS_CHAN_A(ic->ic_curchan) ||
792             (ic->ic_caps & IEEE80211_C_SHPREAMBLE)) {
793                 ic->ic_flags |= IEEE80211_F_SHPREAMBLE;
794                 ic->ic_flags &= ~IEEE80211_F_USEBARKER;
795         } else {
796                 ic->ic_flags &= ~IEEE80211_F_SHPREAMBLE;
797                 ic->ic_flags |= IEEE80211_F_USEBARKER;
798         }
799 }
800
801 /*
802  * Deferred slot time update.
803  *
804  * For per-VAP slot time configuration, call the VAP
805  * method if the VAP requires it.  Otherwise, just call the
806  * older global method.
807  *
808  * If the per-VAP method is called then it's expected that
809  * the driver/firmware will take care of turning the per-VAP
810  * flags into slot time configuration.
811  *
812  * If the per-VAP method is not called then the global flags will be
813  * flipped into sync with the VAPs; ic_flags IEEE80211_F_SHSLOT will
814  * be set only if all of the vaps will have it set.
815  */
816 static void
817 vap_update_slot(void *arg, int npending)
818 {
819         struct ieee80211vap *vap = arg;
820         struct ieee80211com *ic = vap->iv_ic;
821         struct ieee80211vap *iv;
822         int num_shslot = 0, num_lgslot = 0;
823
824         /*
825          * Per-VAP path - we've already had the flags updated;
826          * so just notify the driver and move on.
827          */
828         if (vap->iv_updateslot != NULL) {
829                 vap->iv_updateslot(vap);
830                 return;
831         }
832
833         /*
834          * Iterate over all of the VAP flags to update the
835          * global flag.
836          *
837          * If all vaps have short slot enabled then flip on
838          * short slot.  If any vap has it disabled then
839          * we leave it globally disabled.  This should provide
840          * correct behaviour in a multi-BSS scenario where
841          * at least one VAP has short slot disabled for some
842          * reason.
843          */
844         IEEE80211_LOCK(ic);
845         TAILQ_FOREACH(iv, &ic->ic_vaps, iv_next) {
846                 if (iv->iv_flags & IEEE80211_F_SHSLOT)
847                         num_shslot++;
848                 else
849                         num_lgslot++;
850         }
851         IEEE80211_UNLOCK(ic);
852
853         /*
854          * It looks backwards but - if the number of short slot VAPs
855          * is zero then we're not short slot.  Else, we have one
856          * or more short slot VAPs and we're checking to see if ANY
857          * of them have short slot disabled.
858          */
859         if (num_shslot == 0)
860                 ic->ic_flags &= ~IEEE80211_F_SHSLOT;
861         else if (num_lgslot == 0)
862                 ic->ic_flags |= IEEE80211_F_SHSLOT;
863
864         /*
865          * Call the driver with our new global slot time flags.
866          */
867         ic->ic_updateslot(ic);
868 }
869
870 /*
871  * Set the short slot time state and notify the driver.
872  *
873  * This is the per-VAP slot time state.
874  */
875 void
876 ieee80211_vap_set_shortslottime(struct ieee80211vap *vap, int onoff)
877 {
878         struct ieee80211com *ic = vap->iv_ic;
879
880         /*
881          * Only modify the per-VAP slot time.
882          */
883         if (onoff)
884                 vap->iv_flags |= IEEE80211_F_SHSLOT;
885         else
886                 vap->iv_flags &= ~IEEE80211_F_SHSLOT;
887
888         /* schedule the deferred slot flag update and update */
889         ieee80211_runtask(ic, &vap->iv_slot_task);
890 }
891
892 /*
893  * Check if the specified rate set supports ERP.
894  * NB: the rate set is assumed to be sorted.
895  */
896 int
897 ieee80211_iserp_rateset(const struct ieee80211_rateset *rs)
898 {
899         static const int rates[] = { 2, 4, 11, 22, 12, 24, 48 };
900         int i, j;
901
902         if (rs->rs_nrates < nitems(rates))
903                 return 0;
904         for (i = 0; i < nitems(rates); i++) {
905                 for (j = 0; j < rs->rs_nrates; j++) {
906                         int r = rs->rs_rates[j] & IEEE80211_RATE_VAL;
907                         if (rates[i] == r)
908                                 goto next;
909                         if (r > rates[i])
910                                 return 0;
911                 }
912                 return 0;
913         next:
914                 ;
915         }
916         return 1;
917 }
918
919 /*
920  * Mark the basic rates for the rate table based on the
921  * operating mode.  For real 11g we mark all the 11b rates
922  * and 6, 12, and 24 OFDM.  For 11b compatibility we mark only
923  * 11b rates.  There's also a pseudo 11a-mode used to mark only
924  * the basic OFDM rates.
925  */
926 static void
927 setbasicrates(struct ieee80211_rateset *rs,
928     enum ieee80211_phymode mode, int add)
929 {
930         static const struct ieee80211_rateset basic[IEEE80211_MODE_MAX] = {
931             [IEEE80211_MODE_11A]        = { 3, { 12, 24, 48 } },
932             [IEEE80211_MODE_11B]        = { 2, { 2, 4 } },
933                                             /* NB: mixed b/g */
934             [IEEE80211_MODE_11G]        = { 4, { 2, 4, 11, 22 } },
935             [IEEE80211_MODE_TURBO_A]    = { 3, { 12, 24, 48 } },
936             [IEEE80211_MODE_TURBO_G]    = { 4, { 2, 4, 11, 22 } },
937             [IEEE80211_MODE_STURBO_A]   = { 3, { 12, 24, 48 } },
938             [IEEE80211_MODE_HALF]       = { 3, { 6, 12, 24 } },
939             [IEEE80211_MODE_QUARTER]    = { 3, { 3, 6, 12 } },
940             [IEEE80211_MODE_11NA]       = { 3, { 12, 24, 48 } },
941                                             /* NB: mixed b/g */
942             [IEEE80211_MODE_11NG]       = { 4, { 2, 4, 11, 22 } },
943                                             /* NB: mixed b/g */
944             [IEEE80211_MODE_VHT_2GHZ]   = { 4, { 2, 4, 11, 22 } },
945             [IEEE80211_MODE_VHT_5GHZ]   = { 3, { 12, 24, 48 } },
946         };
947         int i, j;
948
949         for (i = 0; i < rs->rs_nrates; i++) {
950                 if (!add)
951                         rs->rs_rates[i] &= IEEE80211_RATE_VAL;
952                 for (j = 0; j < basic[mode].rs_nrates; j++)
953                         if (basic[mode].rs_rates[j] == rs->rs_rates[i]) {
954                                 rs->rs_rates[i] |= IEEE80211_RATE_BASIC;
955                                 break;
956                         }
957         }
958 }
959
960 /*
961  * Set the basic rates in a rate set.
962  */
963 void
964 ieee80211_setbasicrates(struct ieee80211_rateset *rs,
965     enum ieee80211_phymode mode)
966 {
967         setbasicrates(rs, mode, 0);
968 }
969
970 /*
971  * Add basic rates to a rate set.
972  */
973 void
974 ieee80211_addbasicrates(struct ieee80211_rateset *rs,
975     enum ieee80211_phymode mode)
976 {
977         setbasicrates(rs, mode, 1);
978 }
979
980 /*
981  * WME protocol support.
982  *
983  * The default 11a/b/g/n parameters come from the WiFi Alliance WMM
984  * System Interopability Test Plan (v1.4, Appendix F) and the 802.11n
985  * Draft 2.0 Test Plan (Appendix D).
986  *
987  * Static/Dynamic Turbo mode settings come from Atheros.
988  */
989 typedef struct phyParamType {
990         uint8_t         aifsn;
991         uint8_t         logcwmin;
992         uint8_t         logcwmax;
993         uint16_t        txopLimit;
994         uint8_t         acm;
995 } paramType;
996
997 static const struct phyParamType phyParamForAC_BE[IEEE80211_MODE_MAX] = {
998         [IEEE80211_MODE_AUTO]   = { 3, 4,  6,  0, 0 },
999         [IEEE80211_MODE_11A]    = { 3, 4,  6,  0, 0 },
1000         [IEEE80211_MODE_11B]    = { 3, 4,  6,  0, 0 },
1001         [IEEE80211_MODE_11G]    = { 3, 4,  6,  0, 0 },
1002         [IEEE80211_MODE_FH]     = { 3, 4,  6,  0, 0 },
1003         [IEEE80211_MODE_TURBO_A]= { 2, 3,  5,  0, 0 },
1004         [IEEE80211_MODE_TURBO_G]= { 2, 3,  5,  0, 0 },
1005         [IEEE80211_MODE_STURBO_A]={ 2, 3,  5,  0, 0 },
1006         [IEEE80211_MODE_HALF]   = { 3, 4,  6,  0, 0 },
1007         [IEEE80211_MODE_QUARTER]= { 3, 4,  6,  0, 0 },
1008         [IEEE80211_MODE_11NA]   = { 3, 4,  6,  0, 0 },
1009         [IEEE80211_MODE_11NG]   = { 3, 4,  6,  0, 0 },
1010         [IEEE80211_MODE_VHT_2GHZ]       = { 3, 4,  6,  0, 0 },
1011         [IEEE80211_MODE_VHT_5GHZ]       = { 3, 4,  6,  0, 0 },
1012 };
1013 static const struct phyParamType phyParamForAC_BK[IEEE80211_MODE_MAX] = {
1014         [IEEE80211_MODE_AUTO]   = { 7, 4, 10,  0, 0 },
1015         [IEEE80211_MODE_11A]    = { 7, 4, 10,  0, 0 },
1016         [IEEE80211_MODE_11B]    = { 7, 4, 10,  0, 0 },
1017         [IEEE80211_MODE_11G]    = { 7, 4, 10,  0, 0 },
1018         [IEEE80211_MODE_FH]     = { 7, 4, 10,  0, 0 },
1019         [IEEE80211_MODE_TURBO_A]= { 7, 3, 10,  0, 0 },
1020         [IEEE80211_MODE_TURBO_G]= { 7, 3, 10,  0, 0 },
1021         [IEEE80211_MODE_STURBO_A]={ 7, 3, 10,  0, 0 },
1022         [IEEE80211_MODE_HALF]   = { 7, 4, 10,  0, 0 },
1023         [IEEE80211_MODE_QUARTER]= { 7, 4, 10,  0, 0 },
1024         [IEEE80211_MODE_11NA]   = { 7, 4, 10,  0, 0 },
1025         [IEEE80211_MODE_11NG]   = { 7, 4, 10,  0, 0 },
1026         [IEEE80211_MODE_VHT_2GHZ]       = { 7, 4, 10,  0, 0 },
1027         [IEEE80211_MODE_VHT_5GHZ]       = { 7, 4, 10,  0, 0 },
1028 };
1029 static const struct phyParamType phyParamForAC_VI[IEEE80211_MODE_MAX] = {
1030         [IEEE80211_MODE_AUTO]   = { 1, 3, 4,  94, 0 },
1031         [IEEE80211_MODE_11A]    = { 1, 3, 4,  94, 0 },
1032         [IEEE80211_MODE_11B]    = { 1, 3, 4, 188, 0 },
1033         [IEEE80211_MODE_11G]    = { 1, 3, 4,  94, 0 },
1034         [IEEE80211_MODE_FH]     = { 1, 3, 4, 188, 0 },
1035         [IEEE80211_MODE_TURBO_A]= { 1, 2, 3,  94, 0 },
1036         [IEEE80211_MODE_TURBO_G]= { 1, 2, 3,  94, 0 },
1037         [IEEE80211_MODE_STURBO_A]={ 1, 2, 3,  94, 0 },
1038         [IEEE80211_MODE_HALF]   = { 1, 3, 4,  94, 0 },
1039         [IEEE80211_MODE_QUARTER]= { 1, 3, 4,  94, 0 },
1040         [IEEE80211_MODE_11NA]   = { 1, 3, 4,  94, 0 },
1041         [IEEE80211_MODE_11NG]   = { 1, 3, 4,  94, 0 },
1042         [IEEE80211_MODE_VHT_2GHZ]       = { 1, 3, 4,  94, 0 },
1043         [IEEE80211_MODE_VHT_5GHZ]       = { 1, 3, 4,  94, 0 },
1044 };
1045 static const struct phyParamType phyParamForAC_VO[IEEE80211_MODE_MAX] = {
1046         [IEEE80211_MODE_AUTO]   = { 1, 2, 3,  47, 0 },
1047         [IEEE80211_MODE_11A]    = { 1, 2, 3,  47, 0 },
1048         [IEEE80211_MODE_11B]    = { 1, 2, 3, 102, 0 },
1049         [IEEE80211_MODE_11G]    = { 1, 2, 3,  47, 0 },
1050         [IEEE80211_MODE_FH]     = { 1, 2, 3, 102, 0 },
1051         [IEEE80211_MODE_TURBO_A]= { 1, 2, 2,  47, 0 },
1052         [IEEE80211_MODE_TURBO_G]= { 1, 2, 2,  47, 0 },
1053         [IEEE80211_MODE_STURBO_A]={ 1, 2, 2,  47, 0 },
1054         [IEEE80211_MODE_HALF]   = { 1, 2, 3,  47, 0 },
1055         [IEEE80211_MODE_QUARTER]= { 1, 2, 3,  47, 0 },
1056         [IEEE80211_MODE_11NA]   = { 1, 2, 3,  47, 0 },
1057         [IEEE80211_MODE_11NG]   = { 1, 2, 3,  47, 0 },
1058         [IEEE80211_MODE_VHT_2GHZ]       = { 1, 2, 3,  47, 0 },
1059         [IEEE80211_MODE_VHT_5GHZ]       = { 1, 2, 3,  47, 0 },
1060 };
1061
1062 static const struct phyParamType bssPhyParamForAC_BE[IEEE80211_MODE_MAX] = {
1063         [IEEE80211_MODE_AUTO]   = { 3, 4, 10,  0, 0 },
1064         [IEEE80211_MODE_11A]    = { 3, 4, 10,  0, 0 },
1065         [IEEE80211_MODE_11B]    = { 3, 4, 10,  0, 0 },
1066         [IEEE80211_MODE_11G]    = { 3, 4, 10,  0, 0 },
1067         [IEEE80211_MODE_FH]     = { 3, 4, 10,  0, 0 },
1068         [IEEE80211_MODE_TURBO_A]= { 2, 3, 10,  0, 0 },
1069         [IEEE80211_MODE_TURBO_G]= { 2, 3, 10,  0, 0 },
1070         [IEEE80211_MODE_STURBO_A]={ 2, 3, 10,  0, 0 },
1071         [IEEE80211_MODE_HALF]   = { 3, 4, 10,  0, 0 },
1072         [IEEE80211_MODE_QUARTER]= { 3, 4, 10,  0, 0 },
1073         [IEEE80211_MODE_11NA]   = { 3, 4, 10,  0, 0 },
1074         [IEEE80211_MODE_11NG]   = { 3, 4, 10,  0, 0 },
1075 };
1076 static const struct phyParamType bssPhyParamForAC_VI[IEEE80211_MODE_MAX] = {
1077         [IEEE80211_MODE_AUTO]   = { 2, 3, 4,  94, 0 },
1078         [IEEE80211_MODE_11A]    = { 2, 3, 4,  94, 0 },
1079         [IEEE80211_MODE_11B]    = { 2, 3, 4, 188, 0 },
1080         [IEEE80211_MODE_11G]    = { 2, 3, 4,  94, 0 },
1081         [IEEE80211_MODE_FH]     = { 2, 3, 4, 188, 0 },
1082         [IEEE80211_MODE_TURBO_A]= { 2, 2, 3,  94, 0 },
1083         [IEEE80211_MODE_TURBO_G]= { 2, 2, 3,  94, 0 },
1084         [IEEE80211_MODE_STURBO_A]={ 2, 2, 3,  94, 0 },
1085         [IEEE80211_MODE_HALF]   = { 2, 3, 4,  94, 0 },
1086         [IEEE80211_MODE_QUARTER]= { 2, 3, 4,  94, 0 },
1087         [IEEE80211_MODE_11NA]   = { 2, 3, 4,  94, 0 },
1088         [IEEE80211_MODE_11NG]   = { 2, 3, 4,  94, 0 },
1089 };
1090 static const struct phyParamType bssPhyParamForAC_VO[IEEE80211_MODE_MAX] = {
1091         [IEEE80211_MODE_AUTO]   = { 2, 2, 3,  47, 0 },
1092         [IEEE80211_MODE_11A]    = { 2, 2, 3,  47, 0 },
1093         [IEEE80211_MODE_11B]    = { 2, 2, 3, 102, 0 },
1094         [IEEE80211_MODE_11G]    = { 2, 2, 3,  47, 0 },
1095         [IEEE80211_MODE_FH]     = { 2, 2, 3, 102, 0 },
1096         [IEEE80211_MODE_TURBO_A]= { 1, 2, 2,  47, 0 },
1097         [IEEE80211_MODE_TURBO_G]= { 1, 2, 2,  47, 0 },
1098         [IEEE80211_MODE_STURBO_A]={ 1, 2, 2,  47, 0 },
1099         [IEEE80211_MODE_HALF]   = { 2, 2, 3,  47, 0 },
1100         [IEEE80211_MODE_QUARTER]= { 2, 2, 3,  47, 0 },
1101         [IEEE80211_MODE_11NA]   = { 2, 2, 3,  47, 0 },
1102         [IEEE80211_MODE_11NG]   = { 2, 2, 3,  47, 0 },
1103 };
1104
1105 static void
1106 _setifsparams(struct wmeParams *wmep, const paramType *phy)
1107 {
1108         wmep->wmep_aifsn = phy->aifsn;
1109         wmep->wmep_logcwmin = phy->logcwmin;    
1110         wmep->wmep_logcwmax = phy->logcwmax;            
1111         wmep->wmep_txopLimit = phy->txopLimit;
1112 }
1113
1114 static void
1115 setwmeparams(struct ieee80211vap *vap, const char *type, int ac,
1116         struct wmeParams *wmep, const paramType *phy)
1117 {
1118         wmep->wmep_acm = phy->acm;
1119         _setifsparams(wmep, phy);
1120
1121         IEEE80211_DPRINTF(vap, IEEE80211_MSG_WME,
1122             "set %s (%s) [acm %u aifsn %u logcwmin %u logcwmax %u txop %u]\n",
1123             ieee80211_wme_acnames[ac], type,
1124             wmep->wmep_acm, wmep->wmep_aifsn, wmep->wmep_logcwmin,
1125             wmep->wmep_logcwmax, wmep->wmep_txopLimit);
1126 }
1127
1128 static void
1129 ieee80211_wme_initparams_locked(struct ieee80211vap *vap)
1130 {
1131         struct ieee80211com *ic = vap->iv_ic;
1132         struct ieee80211_wme_state *wme = &ic->ic_wme;
1133         const paramType *pPhyParam, *pBssPhyParam;
1134         struct wmeParams *wmep;
1135         enum ieee80211_phymode mode;
1136         int i;
1137
1138         IEEE80211_LOCK_ASSERT(ic);
1139
1140         if ((ic->ic_caps & IEEE80211_C_WME) == 0 || ic->ic_nrunning > 1)
1141                 return;
1142
1143         /*
1144          * Clear the wme cap_info field so a qoscount from a previous
1145          * vap doesn't confuse later code which only parses the beacon
1146          * field and updates hardware when said field changes.
1147          * Otherwise the hardware is programmed with defaults, not what
1148          * the beacon actually announces.
1149          */
1150         wme->wme_wmeChanParams.cap_info = 0;
1151
1152         /*
1153          * Select mode; we can be called early in which case we
1154          * always use auto mode.  We know we'll be called when
1155          * entering the RUN state with bsschan setup properly
1156          * so state will eventually get set correctly
1157          */
1158         if (ic->ic_bsschan != IEEE80211_CHAN_ANYC)
1159                 mode = ieee80211_chan2mode(ic->ic_bsschan);
1160         else
1161                 mode = IEEE80211_MODE_AUTO;
1162         for (i = 0; i < WME_NUM_AC; i++) {
1163                 switch (i) {
1164                 case WME_AC_BK:
1165                         pPhyParam = &phyParamForAC_BK[mode];
1166                         pBssPhyParam = &phyParamForAC_BK[mode];
1167                         break;
1168                 case WME_AC_VI:
1169                         pPhyParam = &phyParamForAC_VI[mode];
1170                         pBssPhyParam = &bssPhyParamForAC_VI[mode];
1171                         break;
1172                 case WME_AC_VO:
1173                         pPhyParam = &phyParamForAC_VO[mode];
1174                         pBssPhyParam = &bssPhyParamForAC_VO[mode];
1175                         break;
1176                 case WME_AC_BE:
1177                 default:
1178                         pPhyParam = &phyParamForAC_BE[mode];
1179                         pBssPhyParam = &bssPhyParamForAC_BE[mode];
1180                         break;
1181                 }
1182                 wmep = &wme->wme_wmeChanParams.cap_wmeParams[i];
1183                 if (ic->ic_opmode == IEEE80211_M_HOSTAP) {
1184                         setwmeparams(vap, "chan", i, wmep, pPhyParam);
1185                 } else {
1186                         setwmeparams(vap, "chan", i, wmep, pBssPhyParam);
1187                 }       
1188                 wmep = &wme->wme_wmeBssChanParams.cap_wmeParams[i];
1189                 setwmeparams(vap, "bss ", i, wmep, pBssPhyParam);
1190         }
1191         /* NB: check ic_bss to avoid NULL deref on initial attach */
1192         if (vap->iv_bss != NULL) {
1193                 /*
1194                  * Calculate aggressive mode switching threshold based
1195                  * on beacon interval.  This doesn't need locking since
1196                  * we're only called before entering the RUN state at
1197                  * which point we start sending beacon frames.
1198                  */
1199                 wme->wme_hipri_switch_thresh =
1200                         (HIGH_PRI_SWITCH_THRESH * vap->iv_bss->ni_intval) / 100;
1201                 wme->wme_flags &= ~WME_F_AGGRMODE;
1202                 ieee80211_wme_updateparams(vap);
1203         }
1204 }
1205
1206 void
1207 ieee80211_wme_initparams(struct ieee80211vap *vap)
1208 {
1209         struct ieee80211com *ic = vap->iv_ic;
1210
1211         IEEE80211_LOCK(ic);
1212         ieee80211_wme_initparams_locked(vap);
1213         IEEE80211_UNLOCK(ic);
1214 }
1215
1216 /*
1217  * Update WME parameters for ourself and the BSS.
1218  */
1219 void
1220 ieee80211_wme_updateparams_locked(struct ieee80211vap *vap)
1221 {
1222         static const paramType aggrParam[IEEE80211_MODE_MAX] = {
1223             [IEEE80211_MODE_AUTO]       = { 2, 4, 10, 64, 0 },
1224             [IEEE80211_MODE_11A]        = { 2, 4, 10, 64, 0 },
1225             [IEEE80211_MODE_11B]        = { 2, 5, 10, 64, 0 },
1226             [IEEE80211_MODE_11G]        = { 2, 4, 10, 64, 0 },
1227             [IEEE80211_MODE_FH]         = { 2, 5, 10, 64, 0 },
1228             [IEEE80211_MODE_TURBO_A]    = { 1, 3, 10, 64, 0 },
1229             [IEEE80211_MODE_TURBO_G]    = { 1, 3, 10, 64, 0 },
1230             [IEEE80211_MODE_STURBO_A]   = { 1, 3, 10, 64, 0 },
1231             [IEEE80211_MODE_HALF]       = { 2, 4, 10, 64, 0 },
1232             [IEEE80211_MODE_QUARTER]    = { 2, 4, 10, 64, 0 },
1233             [IEEE80211_MODE_11NA]       = { 2, 4, 10, 64, 0 },  /* XXXcheck*/
1234             [IEEE80211_MODE_11NG]       = { 2, 4, 10, 64, 0 },  /* XXXcheck*/
1235             [IEEE80211_MODE_VHT_2GHZ]   = { 2, 4, 10, 64, 0 },  /* XXXcheck*/
1236             [IEEE80211_MODE_VHT_5GHZ]   = { 2, 4, 10, 64, 0 },  /* XXXcheck*/
1237         };
1238         struct ieee80211com *ic = vap->iv_ic;
1239         struct ieee80211_wme_state *wme = &ic->ic_wme;
1240         const struct wmeParams *wmep;
1241         struct wmeParams *chanp, *bssp;
1242         enum ieee80211_phymode mode;
1243         int i;
1244         int do_aggrmode = 0;
1245
1246         /*
1247          * Set up the channel access parameters for the physical
1248          * device.  First populate the configured settings.
1249          */
1250         for (i = 0; i < WME_NUM_AC; i++) {
1251                 chanp = &wme->wme_chanParams.cap_wmeParams[i];
1252                 wmep = &wme->wme_wmeChanParams.cap_wmeParams[i];
1253                 chanp->wmep_aifsn = wmep->wmep_aifsn;
1254                 chanp->wmep_logcwmin = wmep->wmep_logcwmin;
1255                 chanp->wmep_logcwmax = wmep->wmep_logcwmax;
1256                 chanp->wmep_txopLimit = wmep->wmep_txopLimit;
1257
1258                 chanp = &wme->wme_bssChanParams.cap_wmeParams[i];
1259                 wmep = &wme->wme_wmeBssChanParams.cap_wmeParams[i];
1260                 chanp->wmep_aifsn = wmep->wmep_aifsn;
1261                 chanp->wmep_logcwmin = wmep->wmep_logcwmin;
1262                 chanp->wmep_logcwmax = wmep->wmep_logcwmax;
1263                 chanp->wmep_txopLimit = wmep->wmep_txopLimit;
1264         }
1265
1266         /*
1267          * Select mode; we can be called early in which case we
1268          * always use auto mode.  We know we'll be called when
1269          * entering the RUN state with bsschan setup properly
1270          * so state will eventually get set correctly
1271          */
1272         if (ic->ic_bsschan != IEEE80211_CHAN_ANYC)
1273                 mode = ieee80211_chan2mode(ic->ic_bsschan);
1274         else
1275                 mode = IEEE80211_MODE_AUTO;
1276
1277         /*
1278          * This implements aggressive mode as found in certain
1279          * vendors' AP's.  When there is significant high
1280          * priority (VI/VO) traffic in the BSS throttle back BE
1281          * traffic by using conservative parameters.  Otherwise
1282          * BE uses aggressive params to optimize performance of
1283          * legacy/non-QoS traffic.
1284          */
1285
1286         /* Hostap? Only if aggressive mode is enabled */
1287         if (vap->iv_opmode == IEEE80211_M_HOSTAP &&
1288              (wme->wme_flags & WME_F_AGGRMODE) != 0)
1289                 do_aggrmode = 1;
1290
1291         /*
1292          * Station? Only if we're in a non-QoS BSS.
1293          */
1294         else if ((vap->iv_opmode == IEEE80211_M_STA &&
1295              (vap->iv_bss->ni_flags & IEEE80211_NODE_QOS) == 0))
1296                 do_aggrmode = 1;
1297
1298         /*
1299          * IBSS? Only if we we have WME enabled.
1300          */
1301         else if ((vap->iv_opmode == IEEE80211_M_IBSS) &&
1302             (vap->iv_flags & IEEE80211_F_WME))
1303                 do_aggrmode = 1;
1304
1305         /*
1306          * If WME is disabled on this VAP, default to aggressive mode
1307          * regardless of the configuration.
1308          */
1309         if ((vap->iv_flags & IEEE80211_F_WME) == 0)
1310                 do_aggrmode = 1;
1311
1312         /* XXX WDS? */
1313
1314         /* XXX MBSS? */
1315         
1316         if (do_aggrmode) {
1317                 chanp = &wme->wme_chanParams.cap_wmeParams[WME_AC_BE];
1318                 bssp = &wme->wme_bssChanParams.cap_wmeParams[WME_AC_BE];
1319
1320                 chanp->wmep_aifsn = bssp->wmep_aifsn = aggrParam[mode].aifsn;
1321                 chanp->wmep_logcwmin = bssp->wmep_logcwmin =
1322                     aggrParam[mode].logcwmin;
1323                 chanp->wmep_logcwmax = bssp->wmep_logcwmax =
1324                     aggrParam[mode].logcwmax;
1325                 chanp->wmep_txopLimit = bssp->wmep_txopLimit =
1326                     (vap->iv_flags & IEEE80211_F_BURST) ?
1327                         aggrParam[mode].txopLimit : 0;          
1328                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_WME,
1329                     "update %s (chan+bss) [acm %u aifsn %u logcwmin %u "
1330                     "logcwmax %u txop %u]\n", ieee80211_wme_acnames[WME_AC_BE],
1331                     chanp->wmep_acm, chanp->wmep_aifsn, chanp->wmep_logcwmin,
1332                     chanp->wmep_logcwmax, chanp->wmep_txopLimit);
1333         }
1334
1335
1336         /*
1337          * Change the contention window based on the number of associated
1338          * stations.  If the number of associated stations is 1 and
1339          * aggressive mode is enabled, lower the contention window even
1340          * further.
1341          */
1342         if (vap->iv_opmode == IEEE80211_M_HOSTAP &&
1343             ic->ic_sta_assoc < 2 && (wme->wme_flags & WME_F_AGGRMODE) != 0) {
1344                 static const uint8_t logCwMin[IEEE80211_MODE_MAX] = {
1345                     [IEEE80211_MODE_AUTO]       = 3,
1346                     [IEEE80211_MODE_11A]        = 3,
1347                     [IEEE80211_MODE_11B]        = 4,
1348                     [IEEE80211_MODE_11G]        = 3,
1349                     [IEEE80211_MODE_FH]         = 4,
1350                     [IEEE80211_MODE_TURBO_A]    = 3,
1351                     [IEEE80211_MODE_TURBO_G]    = 3,
1352                     [IEEE80211_MODE_STURBO_A]   = 3,
1353                     [IEEE80211_MODE_HALF]       = 3,
1354                     [IEEE80211_MODE_QUARTER]    = 3,
1355                     [IEEE80211_MODE_11NA]       = 3,
1356                     [IEEE80211_MODE_11NG]       = 3,
1357                     [IEEE80211_MODE_VHT_2GHZ]   = 3,
1358                     [IEEE80211_MODE_VHT_5GHZ]   = 3,
1359                 };
1360                 chanp = &wme->wme_chanParams.cap_wmeParams[WME_AC_BE];
1361                 bssp = &wme->wme_bssChanParams.cap_wmeParams[WME_AC_BE];
1362
1363                 chanp->wmep_logcwmin = bssp->wmep_logcwmin = logCwMin[mode];
1364                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_WME,
1365                     "update %s (chan+bss) logcwmin %u\n",
1366                     ieee80211_wme_acnames[WME_AC_BE], chanp->wmep_logcwmin);
1367         }
1368
1369         /*
1370          * Arrange for the beacon update.
1371          *
1372          * XXX what about MBSS, WDS?
1373          */
1374         if (vap->iv_opmode == IEEE80211_M_HOSTAP
1375             || vap->iv_opmode == IEEE80211_M_IBSS) {
1376                 /*
1377                  * Arrange for a beacon update and bump the parameter
1378                  * set number so associated stations load the new values.
1379                  */
1380                 wme->wme_bssChanParams.cap_info =
1381                         (wme->wme_bssChanParams.cap_info+1) & WME_QOSINFO_COUNT;
1382                 ieee80211_beacon_notify(vap, IEEE80211_BEACON_WME);
1383         }
1384
1385         /* schedule the deferred WME update */
1386         ieee80211_runtask(ic, &vap->iv_wme_task);
1387
1388         IEEE80211_DPRINTF(vap, IEEE80211_MSG_WME,
1389             "%s: WME params updated, cap_info 0x%x\n", __func__,
1390             vap->iv_opmode == IEEE80211_M_STA ?
1391                 wme->wme_wmeChanParams.cap_info :
1392                 wme->wme_bssChanParams.cap_info);
1393 }
1394
1395 void
1396 ieee80211_wme_updateparams(struct ieee80211vap *vap)
1397 {
1398         struct ieee80211com *ic = vap->iv_ic;
1399
1400         if (ic->ic_caps & IEEE80211_C_WME) {
1401                 IEEE80211_LOCK(ic);
1402                 ieee80211_wme_updateparams_locked(vap);
1403                 IEEE80211_UNLOCK(ic);
1404         }
1405 }
1406
1407 /*
1408  * Fetch the WME parameters for the given VAP.
1409  *
1410  * When net80211 grows p2p, etc support, this may return different
1411  * parameters for each VAP.
1412  */
1413 void
1414 ieee80211_wme_vap_getparams(struct ieee80211vap *vap, struct chanAccParams *wp)
1415 {
1416
1417         memcpy(wp, &vap->iv_ic->ic_wme.wme_chanParams, sizeof(*wp));
1418 }
1419
1420 /*
1421  * For NICs which only support one set of WME paramaters (ie, softmac NICs)
1422  * there may be different VAP WME parameters but only one is "active".
1423  * This returns the "NIC" WME parameters for the currently active
1424  * context.
1425  */
1426 void
1427 ieee80211_wme_ic_getparams(struct ieee80211com *ic, struct chanAccParams *wp)
1428 {
1429
1430         memcpy(wp, &ic->ic_wme.wme_chanParams, sizeof(*wp));
1431 }
1432
1433 /*
1434  * Return whether to use QoS on a given WME queue.
1435  *
1436  * This is intended to be called from the transmit path of softmac drivers
1437  * which are setting NoAck bits in transmit descriptors.
1438  *
1439  * Ideally this would be set in some transmit field before the packet is
1440  * queued to the driver but net80211 isn't quite there yet.
1441  */
1442 int
1443 ieee80211_wme_vap_ac_is_noack(struct ieee80211vap *vap, int ac)
1444 {
1445         /* Bounds/sanity check */
1446         if (ac < 0 || ac >= WME_NUM_AC)
1447                 return (0);
1448
1449         /* Again, there's only one global context for now */
1450         return (!! vap->iv_ic->ic_wme.wme_chanParams.cap_wmeParams[ac].wmep_noackPolicy);
1451 }
1452
1453 static void
1454 parent_updown(void *arg, int npending)
1455 {
1456         struct ieee80211com *ic = arg;
1457
1458         ic->ic_parent(ic);
1459 }
1460
1461 static void
1462 update_mcast(void *arg, int npending)
1463 {
1464         struct ieee80211com *ic = arg;
1465
1466         ic->ic_update_mcast(ic);
1467 }
1468
1469 static void
1470 update_promisc(void *arg, int npending)
1471 {
1472         struct ieee80211com *ic = arg;
1473
1474         ic->ic_update_promisc(ic);
1475 }
1476
1477 static void
1478 update_channel(void *arg, int npending)
1479 {
1480         struct ieee80211com *ic = arg;
1481
1482         ic->ic_set_channel(ic);
1483         ieee80211_radiotap_chan_change(ic);
1484 }
1485
1486 static void
1487 update_chw(void *arg, int npending)
1488 {
1489         struct ieee80211com *ic = arg;
1490
1491         /*
1492          * XXX should we defer the channel width _config_ update until now?
1493          */
1494         ic->ic_update_chw(ic);
1495 }
1496
1497 /*
1498  * Deferred WME update.
1499  *
1500  * In preparation for per-VAP WME configuration, call the VAP
1501  * method if the VAP requires it.  Otherwise, just call the
1502  * older global method.  There isn't a per-VAP WME configuration
1503  * just yet so for now just use the global configuration.
1504  */
1505 static void
1506 vap_update_wme(void *arg, int npending)
1507 {
1508         struct ieee80211vap *vap = arg;
1509         struct ieee80211com *ic = vap->iv_ic;
1510
1511         if (vap->iv_wme_update != NULL)
1512                 vap->iv_wme_update(vap,
1513                     ic->ic_wme.wme_chanParams.cap_wmeParams);
1514         else
1515                 ic->ic_wme.wme_update(ic);
1516 }
1517
1518 static void
1519 restart_vaps(void *arg, int npending)
1520 {
1521         struct ieee80211com *ic = arg;
1522
1523         ieee80211_suspend_all(ic);
1524         ieee80211_resume_all(ic);
1525 }
1526
1527 /*
1528  * Block until the parent is in a known state.  This is
1529  * used after any operations that dispatch a task (e.g.
1530  * to auto-configure the parent device up/down).
1531  */
1532 void
1533 ieee80211_waitfor_parent(struct ieee80211com *ic)
1534 {
1535         taskqueue_block(ic->ic_tq);
1536         ieee80211_draintask(ic, &ic->ic_parent_task);
1537         ieee80211_draintask(ic, &ic->ic_mcast_task);
1538         ieee80211_draintask(ic, &ic->ic_promisc_task);
1539         ieee80211_draintask(ic, &ic->ic_chan_task);
1540         ieee80211_draintask(ic, &ic->ic_bmiss_task);
1541         ieee80211_draintask(ic, &ic->ic_chw_task);
1542         taskqueue_unblock(ic->ic_tq);
1543 }
1544
1545 /*
1546  * Check to see whether the current channel needs reset.
1547  *
1548  * Some devices don't handle being given an invalid channel
1549  * in their operating mode very well (eg wpi(4) will throw a
1550  * firmware exception.)
1551  *
1552  * Return 0 if we're ok, 1 if the channel needs to be reset.
1553  *
1554  * See PR kern/202502.
1555  */
1556 static int
1557 ieee80211_start_check_reset_chan(struct ieee80211vap *vap)
1558 {
1559         struct ieee80211com *ic = vap->iv_ic;
1560
1561         if ((vap->iv_opmode == IEEE80211_M_IBSS &&
1562              IEEE80211_IS_CHAN_NOADHOC(ic->ic_curchan)) ||
1563             (vap->iv_opmode == IEEE80211_M_HOSTAP &&
1564              IEEE80211_IS_CHAN_NOHOSTAP(ic->ic_curchan)))
1565                 return (1);
1566         return (0);
1567 }
1568
1569 /*
1570  * Reset the curchan to a known good state.
1571  */
1572 static void
1573 ieee80211_start_reset_chan(struct ieee80211vap *vap)
1574 {
1575         struct ieee80211com *ic = vap->iv_ic;
1576
1577         ic->ic_curchan = &ic->ic_channels[0];
1578 }
1579
1580 /*
1581  * Start a vap running.  If this is the first vap to be
1582  * set running on the underlying device then we
1583  * automatically bring the device up.
1584  */
1585 void
1586 ieee80211_start_locked(struct ieee80211vap *vap)
1587 {
1588         struct ifnet *ifp = vap->iv_ifp;
1589         struct ieee80211com *ic = vap->iv_ic;
1590
1591         IEEE80211_LOCK_ASSERT(ic);
1592
1593         IEEE80211_DPRINTF(vap,
1594                 IEEE80211_MSG_STATE | IEEE80211_MSG_DEBUG,
1595                 "start running, %d vaps running\n", ic->ic_nrunning);
1596
1597         if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0) {
1598                 /*
1599                  * Mark us running.  Note that it's ok to do this first;
1600                  * if we need to bring the parent device up we defer that
1601                  * to avoid dropping the com lock.  We expect the device
1602                  * to respond to being marked up by calling back into us
1603                  * through ieee80211_start_all at which point we'll come
1604                  * back in here and complete the work.
1605                  */
1606                 ifp->if_drv_flags |= IFF_DRV_RUNNING;
1607                 ieee80211_notify_ifnet_change(vap);
1608
1609                 /*
1610                  * We are not running; if this we are the first vap
1611                  * to be brought up auto-up the parent if necessary.
1612                  */
1613                 if (ic->ic_nrunning++ == 0) {
1614
1615                         /* reset the channel to a known good channel */
1616                         if (ieee80211_start_check_reset_chan(vap))
1617                                 ieee80211_start_reset_chan(vap);
1618
1619                         IEEE80211_DPRINTF(vap,
1620                             IEEE80211_MSG_STATE | IEEE80211_MSG_DEBUG,
1621                             "%s: up parent %s\n", __func__, ic->ic_name);
1622                         ieee80211_runtask(ic, &ic->ic_parent_task);
1623                         return;
1624                 }
1625         }
1626         /*
1627          * If the parent is up and running, then kick the
1628          * 802.11 state machine as appropriate.
1629          */
1630         if (vap->iv_roaming != IEEE80211_ROAMING_MANUAL) {
1631                 if (vap->iv_opmode == IEEE80211_M_STA) {
1632 #if 0
1633                         /* XXX bypasses scan too easily; disable for now */
1634                         /*
1635                          * Try to be intelligent about clocking the state
1636                          * machine.  If we're currently in RUN state then
1637                          * we should be able to apply any new state/parameters
1638                          * simply by re-associating.  Otherwise we need to
1639                          * re-scan to select an appropriate ap.
1640                          */ 
1641                         if (vap->iv_state >= IEEE80211_S_RUN)
1642                                 ieee80211_new_state_locked(vap,
1643                                     IEEE80211_S_ASSOC, 1);
1644                         else
1645 #endif
1646                                 ieee80211_new_state_locked(vap,
1647                                     IEEE80211_S_SCAN, 0);
1648                 } else {
1649                         /*
1650                          * For monitor+wds mode there's nothing to do but
1651                          * start running.  Otherwise if this is the first
1652                          * vap to be brought up, start a scan which may be
1653                          * preempted if the station is locked to a particular
1654                          * channel.
1655                          */
1656                         vap->iv_flags_ext |= IEEE80211_FEXT_REINIT;
1657                         if (vap->iv_opmode == IEEE80211_M_MONITOR ||
1658                             vap->iv_opmode == IEEE80211_M_WDS)
1659                                 ieee80211_new_state_locked(vap,
1660                                     IEEE80211_S_RUN, -1);
1661                         else
1662                                 ieee80211_new_state_locked(vap,
1663                                     IEEE80211_S_SCAN, 0);
1664                 }
1665         }
1666 }
1667
1668 /*
1669  * Start a single vap.
1670  */
1671 void
1672 ieee80211_init(void *arg)
1673 {
1674         struct ieee80211vap *vap = arg;
1675
1676         IEEE80211_DPRINTF(vap, IEEE80211_MSG_STATE | IEEE80211_MSG_DEBUG,
1677             "%s\n", __func__);
1678
1679         IEEE80211_LOCK(vap->iv_ic);
1680         ieee80211_start_locked(vap);
1681         IEEE80211_UNLOCK(vap->iv_ic);
1682 }
1683
1684 /*
1685  * Start all runnable vap's on a device.
1686  */
1687 void
1688 ieee80211_start_all(struct ieee80211com *ic)
1689 {
1690         struct ieee80211vap *vap;
1691
1692         IEEE80211_LOCK(ic);
1693         TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next) {
1694                 struct ifnet *ifp = vap->iv_ifp;
1695                 if (IFNET_IS_UP_RUNNING(ifp))   /* NB: avoid recursion */
1696                         ieee80211_start_locked(vap);
1697         }
1698         IEEE80211_UNLOCK(ic);
1699 }
1700
1701 /*
1702  * Stop a vap.  We force it down using the state machine
1703  * then mark it's ifnet not running.  If this is the last
1704  * vap running on the underlying device then we close it
1705  * too to insure it will be properly initialized when the
1706  * next vap is brought up.
1707  */
1708 void
1709 ieee80211_stop_locked(struct ieee80211vap *vap)
1710 {
1711         struct ieee80211com *ic = vap->iv_ic;
1712         struct ifnet *ifp = vap->iv_ifp;
1713
1714         IEEE80211_LOCK_ASSERT(ic);
1715
1716         IEEE80211_DPRINTF(vap, IEEE80211_MSG_STATE | IEEE80211_MSG_DEBUG,
1717             "stop running, %d vaps running\n", ic->ic_nrunning);
1718
1719         ieee80211_new_state_locked(vap, IEEE80211_S_INIT, -1);
1720         if (ifp->if_drv_flags & IFF_DRV_RUNNING) {
1721                 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;  /* mark us stopped */
1722                 ieee80211_notify_ifnet_change(vap);
1723                 if (--ic->ic_nrunning == 0) {
1724                         IEEE80211_DPRINTF(vap,
1725                             IEEE80211_MSG_STATE | IEEE80211_MSG_DEBUG,
1726                             "down parent %s\n", ic->ic_name);
1727                         ieee80211_runtask(ic, &ic->ic_parent_task);
1728                 }
1729         }
1730 }
1731
1732 void
1733 ieee80211_stop(struct ieee80211vap *vap)
1734 {
1735         struct ieee80211com *ic = vap->iv_ic;
1736
1737         IEEE80211_LOCK(ic);
1738         ieee80211_stop_locked(vap);
1739         IEEE80211_UNLOCK(ic);
1740 }
1741
1742 /*
1743  * Stop all vap's running on a device.
1744  */
1745 void
1746 ieee80211_stop_all(struct ieee80211com *ic)
1747 {
1748         struct ieee80211vap *vap;
1749
1750         IEEE80211_LOCK(ic);
1751         TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next) {
1752                 struct ifnet *ifp = vap->iv_ifp;
1753                 if (IFNET_IS_UP_RUNNING(ifp))   /* NB: avoid recursion */
1754                         ieee80211_stop_locked(vap);
1755         }
1756         IEEE80211_UNLOCK(ic);
1757
1758         ieee80211_waitfor_parent(ic);
1759 }
1760
1761 /*
1762  * Stop all vap's running on a device and arrange
1763  * for those that were running to be resumed.
1764  */
1765 void
1766 ieee80211_suspend_all(struct ieee80211com *ic)
1767 {
1768         struct ieee80211vap *vap;
1769
1770         IEEE80211_LOCK(ic);
1771         TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next) {
1772                 struct ifnet *ifp = vap->iv_ifp;
1773                 if (IFNET_IS_UP_RUNNING(ifp)) { /* NB: avoid recursion */
1774                         vap->iv_flags_ext |= IEEE80211_FEXT_RESUME;
1775                         ieee80211_stop_locked(vap);
1776                 }
1777         }
1778         IEEE80211_UNLOCK(ic);
1779
1780         ieee80211_waitfor_parent(ic);
1781 }
1782
1783 /*
1784  * Start all vap's marked for resume.
1785  */
1786 void
1787 ieee80211_resume_all(struct ieee80211com *ic)
1788 {
1789         struct ieee80211vap *vap;
1790
1791         IEEE80211_LOCK(ic);
1792         TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next) {
1793                 struct ifnet *ifp = vap->iv_ifp;
1794                 if (!IFNET_IS_UP_RUNNING(ifp) &&
1795                     (vap->iv_flags_ext & IEEE80211_FEXT_RESUME)) {
1796                         vap->iv_flags_ext &= ~IEEE80211_FEXT_RESUME;
1797                         ieee80211_start_locked(vap);
1798                 }
1799         }
1800         IEEE80211_UNLOCK(ic);
1801 }
1802
1803 /*
1804  * Restart all vap's running on a device.
1805  */
1806 void
1807 ieee80211_restart_all(struct ieee80211com *ic)
1808 {
1809         /*
1810          * NB: do not use ieee80211_runtask here, we will
1811          * block & drain net80211 taskqueue.
1812          */
1813         taskqueue_enqueue(taskqueue_thread, &ic->ic_restart_task);
1814 }
1815
1816 void
1817 ieee80211_beacon_miss(struct ieee80211com *ic)
1818 {
1819         IEEE80211_LOCK(ic);
1820         if ((ic->ic_flags & IEEE80211_F_SCAN) == 0) {
1821                 /* Process in a taskq, the handler may reenter the driver */
1822                 ieee80211_runtask(ic, &ic->ic_bmiss_task);
1823         }
1824         IEEE80211_UNLOCK(ic);
1825 }
1826
1827 static void
1828 beacon_miss(void *arg, int npending)
1829 {
1830         struct ieee80211com *ic = arg;
1831         struct ieee80211vap *vap;
1832
1833         IEEE80211_LOCK(ic);
1834         TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next) {
1835                 /*
1836                  * We only pass events through for sta vap's in RUN+ state;
1837                  * may be too restrictive but for now this saves all the
1838                  * handlers duplicating these checks.
1839                  */
1840                 if (vap->iv_opmode == IEEE80211_M_STA &&
1841                     vap->iv_state >= IEEE80211_S_RUN &&
1842                     vap->iv_bmiss != NULL)
1843                         vap->iv_bmiss(vap);
1844         }
1845         IEEE80211_UNLOCK(ic);
1846 }
1847
1848 static void
1849 beacon_swmiss(void *arg, int npending)
1850 {
1851         struct ieee80211vap *vap = arg;
1852         struct ieee80211com *ic = vap->iv_ic;
1853
1854         IEEE80211_LOCK(ic);
1855         if (vap->iv_state >= IEEE80211_S_RUN) {
1856                 /* XXX Call multiple times if npending > zero? */
1857                 vap->iv_bmiss(vap);
1858         }
1859         IEEE80211_UNLOCK(ic);
1860 }
1861
1862 /*
1863  * Software beacon miss handling.  Check if any beacons
1864  * were received in the last period.  If not post a
1865  * beacon miss; otherwise reset the counter.
1866  */
1867 void
1868 ieee80211_swbmiss(void *arg)
1869 {
1870         struct ieee80211vap *vap = arg;
1871         struct ieee80211com *ic = vap->iv_ic;
1872
1873         IEEE80211_LOCK_ASSERT(ic);
1874
1875         KASSERT(vap->iv_state >= IEEE80211_S_RUN,
1876             ("wrong state %d", vap->iv_state));
1877
1878         if (ic->ic_flags & IEEE80211_F_SCAN) {
1879                 /*
1880                  * If scanning just ignore and reset state.  If we get a
1881                  * bmiss after coming out of scan because we haven't had
1882                  * time to receive a beacon then we should probe the AP
1883                  * before posting a real bmiss (unless iv_bmiss_max has
1884                  * been artifiically lowered).  A cleaner solution might
1885                  * be to disable the timer on scan start/end but to handle
1886                  * case of multiple sta vap's we'd need to disable the
1887                  * timers of all affected vap's.
1888                  */
1889                 vap->iv_swbmiss_count = 0;
1890         } else if (vap->iv_swbmiss_count == 0) {
1891                 if (vap->iv_bmiss != NULL)
1892                         ieee80211_runtask(ic, &vap->iv_swbmiss_task);
1893         } else
1894                 vap->iv_swbmiss_count = 0;
1895         callout_reset(&vap->iv_swbmiss, vap->iv_swbmiss_period,
1896                 ieee80211_swbmiss, vap);
1897 }
1898
1899 /*
1900  * Start an 802.11h channel switch.  We record the parameters,
1901  * mark the operation pending, notify each vap through the
1902  * beacon update mechanism so it can update the beacon frame
1903  * contents, and then switch vap's to CSA state to block outbound
1904  * traffic.  Devices that handle CSA directly can use the state
1905  * switch to do the right thing so long as they call
1906  * ieee80211_csa_completeswitch when it's time to complete the
1907  * channel change.  Devices that depend on the net80211 layer can
1908  * use ieee80211_beacon_update to handle the countdown and the
1909  * channel switch.
1910  */
1911 void
1912 ieee80211_csa_startswitch(struct ieee80211com *ic,
1913         struct ieee80211_channel *c, int mode, int count)
1914 {
1915         struct ieee80211vap *vap;
1916
1917         IEEE80211_LOCK_ASSERT(ic);
1918
1919         ic->ic_csa_newchan = c;
1920         ic->ic_csa_mode = mode;
1921         ic->ic_csa_count = count;
1922         ic->ic_flags |= IEEE80211_F_CSAPENDING;
1923         TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next) {
1924                 if (vap->iv_opmode == IEEE80211_M_HOSTAP ||
1925                     vap->iv_opmode == IEEE80211_M_IBSS ||
1926                     vap->iv_opmode == IEEE80211_M_MBSS)
1927                         ieee80211_beacon_notify(vap, IEEE80211_BEACON_CSA);
1928                 /* switch to CSA state to block outbound traffic */
1929                 if (vap->iv_state == IEEE80211_S_RUN)
1930                         ieee80211_new_state_locked(vap, IEEE80211_S_CSA, 0);
1931         }
1932         ieee80211_notify_csa(ic, c, mode, count);
1933 }
1934
1935 /*
1936  * Complete the channel switch by transitioning all CSA VAPs to RUN.
1937  * This is called by both the completion and cancellation functions
1938  * so each VAP is placed back in the RUN state and can thus transmit.
1939  */
1940 static void
1941 csa_completeswitch(struct ieee80211com *ic)
1942 {
1943         struct ieee80211vap *vap;
1944
1945         ic->ic_csa_newchan = NULL;
1946         ic->ic_flags &= ~IEEE80211_F_CSAPENDING;
1947
1948         TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next)
1949                 if (vap->iv_state == IEEE80211_S_CSA)
1950                         ieee80211_new_state_locked(vap, IEEE80211_S_RUN, 0);
1951 }
1952
1953 /*
1954  * Complete an 802.11h channel switch started by ieee80211_csa_startswitch.
1955  * We clear state and move all vap's in CSA state to RUN state
1956  * so they can again transmit.
1957  *
1958  * Although this may not be completely correct, update the BSS channel
1959  * for each VAP to the newly configured channel. The setcurchan sets
1960  * the current operating channel for the interface (so the radio does
1961  * switch over) but the VAP BSS isn't updated, leading to incorrectly
1962  * reported information via ioctl.
1963  */
1964 void
1965 ieee80211_csa_completeswitch(struct ieee80211com *ic)
1966 {
1967         struct ieee80211vap *vap;
1968
1969         IEEE80211_LOCK_ASSERT(ic);
1970
1971         KASSERT(ic->ic_flags & IEEE80211_F_CSAPENDING, ("csa not pending"));
1972
1973         ieee80211_setcurchan(ic, ic->ic_csa_newchan);
1974         TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next)
1975                 if (vap->iv_state == IEEE80211_S_CSA)
1976                         vap->iv_bss->ni_chan = ic->ic_curchan;
1977
1978         csa_completeswitch(ic);
1979 }
1980
1981 /*
1982  * Cancel an 802.11h channel switch started by ieee80211_csa_startswitch.
1983  * We clear state and move all vap's in CSA state to RUN state
1984  * so they can again transmit.
1985  */
1986 void
1987 ieee80211_csa_cancelswitch(struct ieee80211com *ic)
1988 {
1989         IEEE80211_LOCK_ASSERT(ic);
1990
1991         csa_completeswitch(ic);
1992 }
1993
1994 /*
1995  * Complete a DFS CAC started by ieee80211_dfs_cac_start.
1996  * We clear state and move all vap's in CAC state to RUN state.
1997  */
1998 void
1999 ieee80211_cac_completeswitch(struct ieee80211vap *vap0)
2000 {
2001         struct ieee80211com *ic = vap0->iv_ic;
2002         struct ieee80211vap *vap;
2003
2004         IEEE80211_LOCK(ic);
2005         /*
2006          * Complete CAC state change for lead vap first; then
2007          * clock all the other vap's waiting.
2008          */
2009         KASSERT(vap0->iv_state == IEEE80211_S_CAC,
2010             ("wrong state %d", vap0->iv_state));
2011         ieee80211_new_state_locked(vap0, IEEE80211_S_RUN, 0);
2012
2013         TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next)
2014                 if (vap->iv_state == IEEE80211_S_CAC && vap != vap0)
2015                         ieee80211_new_state_locked(vap, IEEE80211_S_RUN, 0);
2016         IEEE80211_UNLOCK(ic);
2017 }
2018
2019 /*
2020  * Force all vap's other than the specified vap to the INIT state
2021  * and mark them as waiting for a scan to complete.  These vaps
2022  * will be brought up when the scan completes and the scanning vap
2023  * reaches RUN state by wakeupwaiting.
2024  */
2025 static void
2026 markwaiting(struct ieee80211vap *vap0)
2027 {
2028         struct ieee80211com *ic = vap0->iv_ic;
2029         struct ieee80211vap *vap;
2030
2031         IEEE80211_LOCK_ASSERT(ic);
2032
2033         /*
2034          * A vap list entry can not disappear since we are running on the
2035          * taskqueue and a vap destroy will queue and drain another state
2036          * change task.
2037          */
2038         TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next) {
2039                 if (vap == vap0)
2040                         continue;
2041                 if (vap->iv_state != IEEE80211_S_INIT) {
2042                         /* NB: iv_newstate may drop the lock */
2043                         vap->iv_newstate(vap, IEEE80211_S_INIT, 0);
2044                         IEEE80211_LOCK_ASSERT(ic);
2045                         vap->iv_flags_ext |= IEEE80211_FEXT_SCANWAIT;
2046                 }
2047         }
2048 }
2049
2050 /*
2051  * Wakeup all vap's waiting for a scan to complete.  This is the
2052  * companion to markwaiting (above) and is used to coordinate
2053  * multiple vaps scanning.
2054  * This is called from the state taskqueue.
2055  */
2056 static void
2057 wakeupwaiting(struct ieee80211vap *vap0)
2058 {
2059         struct ieee80211com *ic = vap0->iv_ic;
2060         struct ieee80211vap *vap;
2061
2062         IEEE80211_LOCK_ASSERT(ic);
2063
2064         /*
2065          * A vap list entry can not disappear since we are running on the
2066          * taskqueue and a vap destroy will queue and drain another state
2067          * change task.
2068          */
2069         TAILQ_FOREACH(vap, &ic->ic_vaps, iv_next) {
2070                 if (vap == vap0)
2071                         continue;
2072                 if (vap->iv_flags_ext & IEEE80211_FEXT_SCANWAIT) {
2073                         vap->iv_flags_ext &= ~IEEE80211_FEXT_SCANWAIT;
2074                         /* NB: sta's cannot go INIT->RUN */
2075                         /* NB: iv_newstate may drop the lock */
2076                         vap->iv_newstate(vap,
2077                             vap->iv_opmode == IEEE80211_M_STA ?
2078                                 IEEE80211_S_SCAN : IEEE80211_S_RUN, 0);
2079                         IEEE80211_LOCK_ASSERT(ic);
2080                 }
2081         }
2082 }
2083
2084 /*
2085  * Handle post state change work common to all operating modes.
2086  */
2087 static void
2088 ieee80211_newstate_cb(void *xvap, int npending)
2089 {
2090         struct ieee80211vap *vap = xvap;
2091         struct ieee80211com *ic = vap->iv_ic;
2092         enum ieee80211_state nstate, ostate;
2093         int arg, rc;
2094
2095         IEEE80211_LOCK(ic);
2096         nstate = vap->iv_nstate;
2097         arg = vap->iv_nstate_arg;
2098
2099         if (vap->iv_flags_ext & IEEE80211_FEXT_REINIT) {
2100                 /*
2101                  * We have been requested to drop back to the INIT before
2102                  * proceeding to the new state.
2103                  */
2104                 /* Deny any state changes while we are here. */
2105                 vap->iv_nstate = IEEE80211_S_INIT;
2106                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_STATE,
2107                     "%s: %s -> %s arg %d\n", __func__,
2108                     ieee80211_state_name[vap->iv_state],
2109                     ieee80211_state_name[vap->iv_nstate], arg);
2110                 vap->iv_newstate(vap, vap->iv_nstate, 0);
2111                 IEEE80211_LOCK_ASSERT(ic);
2112                 vap->iv_flags_ext &= ~(IEEE80211_FEXT_REINIT |
2113                     IEEE80211_FEXT_STATEWAIT);
2114                 /* enqueue new state transition after cancel_scan() task */
2115                 ieee80211_new_state_locked(vap, nstate, arg);
2116                 goto done;
2117         }
2118
2119         ostate = vap->iv_state;
2120         if (nstate == IEEE80211_S_SCAN && ostate != IEEE80211_S_INIT) {
2121                 /*
2122                  * SCAN was forced; e.g. on beacon miss.  Force other running
2123                  * vap's to INIT state and mark them as waiting for the scan to
2124                  * complete.  This insures they don't interfere with our
2125                  * scanning.  Since we are single threaded the vaps can not
2126                  * transition again while we are executing.
2127                  *
2128                  * XXX not always right, assumes ap follows sta
2129                  */
2130                 markwaiting(vap);
2131         }
2132         IEEE80211_DPRINTF(vap, IEEE80211_MSG_STATE,
2133             "%s: %s -> %s arg %d\n", __func__,
2134             ieee80211_state_name[ostate], ieee80211_state_name[nstate], arg);
2135
2136         rc = vap->iv_newstate(vap, nstate, arg);
2137         IEEE80211_LOCK_ASSERT(ic);
2138         vap->iv_flags_ext &= ~IEEE80211_FEXT_STATEWAIT;
2139         if (rc != 0) {
2140                 /* State transition failed */
2141                 KASSERT(rc != EINPROGRESS, ("iv_newstate was deferred"));
2142                 KASSERT(nstate != IEEE80211_S_INIT,
2143                     ("INIT state change failed"));
2144                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_STATE,
2145                     "%s: %s returned error %d\n", __func__,
2146                     ieee80211_state_name[nstate], rc);
2147                 goto done;
2148         }
2149
2150         /* No actual transition, skip post processing */
2151         if (ostate == nstate)
2152                 goto done;
2153
2154         if (nstate == IEEE80211_S_RUN) {
2155                 /*
2156                  * OACTIVE may be set on the vap if the upper layer
2157                  * tried to transmit (e.g. IPv6 NDP) before we reach
2158                  * RUN state.  Clear it and restart xmit.
2159                  *
2160                  * Note this can also happen as a result of SLEEP->RUN
2161                  * (i.e. coming out of power save mode).
2162                  */
2163                 vap->iv_ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
2164
2165                 /*
2166                  * XXX TODO Kick-start a VAP queue - this should be a method!
2167                  */
2168
2169                 /* bring up any vaps waiting on us */
2170                 wakeupwaiting(vap);
2171         } else if (nstate == IEEE80211_S_INIT) {
2172                 /*
2173                  * Flush the scan cache if we did the last scan (XXX?)
2174                  * and flush any frames on send queues from this vap.
2175                  * Note the mgt q is used only for legacy drivers and
2176                  * will go away shortly.
2177                  */
2178                 ieee80211_scan_flush(vap);
2179
2180                 /*
2181                  * XXX TODO: ic/vap queue flush
2182                  */
2183         }
2184 done:
2185         IEEE80211_UNLOCK(ic);
2186 }
2187
2188 /*
2189  * Public interface for initiating a state machine change.
2190  * This routine single-threads the request and coordinates
2191  * the scheduling of multiple vaps for the purpose of selecting
2192  * an operating channel.  Specifically the following scenarios
2193  * are handled:
2194  * o only one vap can be selecting a channel so on transition to
2195  *   SCAN state if another vap is already scanning then
2196  *   mark the caller for later processing and return without
2197  *   doing anything (XXX? expectations by caller of synchronous operation)
2198  * o only one vap can be doing CAC of a channel so on transition to
2199  *   CAC state if another vap is already scanning for radar then
2200  *   mark the caller for later processing and return without
2201  *   doing anything (XXX? expectations by caller of synchronous operation)
2202  * o if another vap is already running when a request is made
2203  *   to SCAN then an operating channel has been chosen; bypass
2204  *   the scan and just join the channel
2205  *
2206  * Note that the state change call is done through the iv_newstate
2207  * method pointer so any driver routine gets invoked.  The driver
2208  * will normally call back into operating mode-specific
2209  * ieee80211_newstate routines (below) unless it needs to completely
2210  * bypass the state machine (e.g. because the firmware has it's
2211  * own idea how things should work).  Bypassing the net80211 layer
2212  * is usually a mistake and indicates lack of proper integration
2213  * with the net80211 layer.
2214  */
2215 int
2216 ieee80211_new_state_locked(struct ieee80211vap *vap,
2217         enum ieee80211_state nstate, int arg)
2218 {
2219         struct ieee80211com *ic = vap->iv_ic;
2220         struct ieee80211vap *vp;
2221         enum ieee80211_state ostate;
2222         int nrunning, nscanning;
2223
2224         IEEE80211_LOCK_ASSERT(ic);
2225
2226         if (vap->iv_flags_ext & IEEE80211_FEXT_STATEWAIT) {
2227                 if (vap->iv_nstate == IEEE80211_S_INIT ||
2228                     ((vap->iv_state == IEEE80211_S_INIT ||
2229                     (vap->iv_flags_ext & IEEE80211_FEXT_REINIT)) &&
2230                     vap->iv_nstate == IEEE80211_S_SCAN &&
2231                     nstate > IEEE80211_S_SCAN)) {
2232                         /*
2233                          * XXX The vap is being stopped/started,
2234                          * do not allow any other state changes
2235                          * until this is completed.
2236                          */
2237                         IEEE80211_DPRINTF(vap, IEEE80211_MSG_STATE,
2238                             "%s: %s -> %s (%s) transition discarded\n",
2239                             __func__,
2240                             ieee80211_state_name[vap->iv_state],
2241                             ieee80211_state_name[nstate],
2242                             ieee80211_state_name[vap->iv_nstate]);
2243                         return -1;
2244                 } else if (vap->iv_state != vap->iv_nstate) {
2245 #if 0
2246                         /* Warn if the previous state hasn't completed. */
2247                         IEEE80211_DPRINTF(vap, IEEE80211_MSG_STATE,
2248                             "%s: pending %s -> %s transition lost\n", __func__,
2249                             ieee80211_state_name[vap->iv_state],
2250                             ieee80211_state_name[vap->iv_nstate]);
2251 #else
2252                         /* XXX temporarily enable to identify issues */
2253                         if_printf(vap->iv_ifp,
2254                             "%s: pending %s -> %s transition lost\n",
2255                             __func__, ieee80211_state_name[vap->iv_state],
2256                             ieee80211_state_name[vap->iv_nstate]);
2257 #endif
2258                 }
2259         }
2260
2261         nrunning = nscanning = 0;
2262         /* XXX can track this state instead of calculating */
2263         TAILQ_FOREACH(vp, &ic->ic_vaps, iv_next) {
2264                 if (vp != vap) {
2265                         if (vp->iv_state >= IEEE80211_S_RUN)
2266                                 nrunning++;
2267                         /* XXX doesn't handle bg scan */
2268                         /* NB: CAC+AUTH+ASSOC treated like SCAN */
2269                         else if (vp->iv_state > IEEE80211_S_INIT)
2270                                 nscanning++;
2271                 }
2272         }
2273         ostate = vap->iv_state;
2274         IEEE80211_DPRINTF(vap, IEEE80211_MSG_STATE,
2275             "%s: %s -> %s (nrunning %d nscanning %d)\n", __func__,
2276             ieee80211_state_name[ostate], ieee80211_state_name[nstate],
2277             nrunning, nscanning);
2278         switch (nstate) {
2279         case IEEE80211_S_SCAN:
2280                 if (ostate == IEEE80211_S_INIT) {
2281                         /*
2282                          * INIT -> SCAN happens on initial bringup.
2283                          */
2284                         KASSERT(!(nscanning && nrunning),
2285                             ("%d scanning and %d running", nscanning, nrunning));
2286                         if (nscanning) {
2287                                 /*
2288                                  * Someone is scanning, defer our state
2289                                  * change until the work has completed.
2290                                  */
2291                                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_STATE,
2292                                     "%s: defer %s -> %s\n",
2293                                     __func__, ieee80211_state_name[ostate],
2294                                     ieee80211_state_name[nstate]);
2295                                 vap->iv_flags_ext |= IEEE80211_FEXT_SCANWAIT;
2296                                 return 0;
2297                         }
2298                         if (nrunning) {
2299                                 /*
2300                                  * Someone is operating; just join the channel
2301                                  * they have chosen.
2302                                  */
2303                                 /* XXX kill arg? */
2304                                 /* XXX check each opmode, adhoc? */
2305                                 if (vap->iv_opmode == IEEE80211_M_STA)
2306                                         nstate = IEEE80211_S_SCAN;
2307                                 else
2308                                         nstate = IEEE80211_S_RUN;
2309 #ifdef IEEE80211_DEBUG
2310                                 if (nstate != IEEE80211_S_SCAN) {
2311                                         IEEE80211_DPRINTF(vap,
2312                                             IEEE80211_MSG_STATE,
2313                                             "%s: override, now %s -> %s\n",
2314                                             __func__,
2315                                             ieee80211_state_name[ostate],
2316                                             ieee80211_state_name[nstate]);
2317                                 }
2318 #endif
2319                         }
2320                 }
2321                 break;
2322         case IEEE80211_S_RUN:
2323                 if (vap->iv_opmode == IEEE80211_M_WDS &&
2324                     (vap->iv_flags_ext & IEEE80211_FEXT_WDSLEGACY) &&
2325                     nscanning) {
2326                         /*
2327                          * Legacy WDS with someone else scanning; don't
2328                          * go online until that completes as we should
2329                          * follow the other vap to the channel they choose.
2330                          */
2331                         IEEE80211_DPRINTF(vap, IEEE80211_MSG_STATE,
2332                              "%s: defer %s -> %s (legacy WDS)\n", __func__,
2333                              ieee80211_state_name[ostate],
2334                              ieee80211_state_name[nstate]);
2335                         vap->iv_flags_ext |= IEEE80211_FEXT_SCANWAIT;
2336                         return 0;
2337                 }
2338                 if (vap->iv_opmode == IEEE80211_M_HOSTAP &&
2339                     IEEE80211_IS_CHAN_DFS(ic->ic_bsschan) &&
2340                     (vap->iv_flags_ext & IEEE80211_FEXT_DFS) &&
2341                     !IEEE80211_IS_CHAN_CACDONE(ic->ic_bsschan)) {
2342                         /*
2343                          * This is a DFS channel, transition to CAC state
2344                          * instead of RUN.  This allows us to initiate
2345                          * Channel Availability Check (CAC) as specified
2346                          * by 11h/DFS.
2347                          */
2348                         nstate = IEEE80211_S_CAC;
2349                         IEEE80211_DPRINTF(vap, IEEE80211_MSG_STATE,
2350                              "%s: override %s -> %s (DFS)\n", __func__,
2351                              ieee80211_state_name[ostate],
2352                              ieee80211_state_name[nstate]);
2353                 }
2354                 break;
2355         case IEEE80211_S_INIT:
2356                 /* cancel any scan in progress */
2357                 ieee80211_cancel_scan(vap);
2358                 if (ostate == IEEE80211_S_INIT ) {
2359                         /* XXX don't believe this */
2360                         /* INIT -> INIT. nothing to do */
2361                         vap->iv_flags_ext &= ~IEEE80211_FEXT_SCANWAIT;
2362                 }
2363                 /* fall thru... */
2364         default:
2365                 break;
2366         }
2367         /* defer the state change to a thread */
2368         vap->iv_nstate = nstate;
2369         vap->iv_nstate_arg = arg;
2370         vap->iv_flags_ext |= IEEE80211_FEXT_STATEWAIT;
2371         ieee80211_runtask(ic, &vap->iv_nstate_task);
2372         return EINPROGRESS;
2373 }
2374
2375 int
2376 ieee80211_new_state(struct ieee80211vap *vap,
2377         enum ieee80211_state nstate, int arg)
2378 {
2379         struct ieee80211com *ic = vap->iv_ic;
2380         int rc;
2381
2382         IEEE80211_LOCK(ic);
2383         rc = ieee80211_new_state_locked(vap, nstate, arg);
2384         IEEE80211_UNLOCK(ic);
2385         return rc;
2386 }