]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/net80211/ieee80211_superg.c
Update base system libexpat to 2.1.0.
[FreeBSD/FreeBSD.git] / sys / net80211 / ieee80211_superg.c
1 /*-
2  * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
28
29 #include "opt_wlan.h"
30
31 #ifdef  IEEE80211_SUPPORT_SUPERG
32
33 #include <sys/param.h>
34 #include <sys/systm.h> 
35 #include <sys/mbuf.h>   
36 #include <sys/kernel.h>
37 #include <sys/endian.h>
38
39 #include <sys/socket.h>
40  
41 #include <net/bpf.h>
42 #include <net/ethernet.h>
43 #include <net/if.h>
44 #include <net/if_llc.h>
45 #include <net/if_media.h>
46
47 #include <net80211/ieee80211_var.h>
48 #include <net80211/ieee80211_input.h>
49 #include <net80211/ieee80211_phy.h>
50 #include <net80211/ieee80211_superg.h>
51
52 /*
53  * Atheros fast-frame encapsulation format.
54  * FF max payload:
55  * 802.2 + FFHDR + HPAD + 802.3 + 802.2 + 1500 + SPAD + 802.3 + 802.2 + 1500:
56  *   8   +   4   +  4   +   14  +   8   + 1500 +  6   +   14  +   8   + 1500
57  * = 3066
58  */
59 /* fast frame header is 32-bits */
60 #define ATH_FF_PROTO    0x0000003f      /* protocol */
61 #define ATH_FF_PROTO_S  0
62 #define ATH_FF_FTYPE    0x000000c0      /* frame type */
63 #define ATH_FF_FTYPE_S  6
64 #define ATH_FF_HLEN32   0x00000300      /* optional hdr length */
65 #define ATH_FF_HLEN32_S 8
66 #define ATH_FF_SEQNUM   0x001ffc00      /* sequence number */
67 #define ATH_FF_SEQNUM_S 10
68 #define ATH_FF_OFFSET   0xffe00000      /* offset to 2nd payload */
69 #define ATH_FF_OFFSET_S 21
70
71 #define ATH_FF_MAX_HDR_PAD      4
72 #define ATH_FF_MAX_SEP_PAD      6
73 #define ATH_FF_MAX_HDR          30
74
75 #define ATH_FF_PROTO_L2TUNNEL   0       /* L2 tunnel protocol */
76 #define ATH_FF_ETH_TYPE         0x88bd  /* Ether type for encapsulated frames */
77 #define ATH_FF_SNAP_ORGCODE_0   0x00
78 #define ATH_FF_SNAP_ORGCODE_1   0x03
79 #define ATH_FF_SNAP_ORGCODE_2   0x7f
80
81 #define ATH_FF_TXQMIN   2               /* min txq depth for staging */
82 #define ATH_FF_TXQMAX   50              /* maximum # of queued frames allowed */
83 #define ATH_FF_STAGEMAX 5               /* max waiting period for staged frame*/
84
85 #define ETHER_HEADER_COPY(dst, src) \
86         memcpy(dst, src, sizeof(struct ether_header))
87
88 static  int ieee80211_ffppsmin = 2;     /* pps threshold for ff aggregation */
89 SYSCTL_INT(_net_wlan, OID_AUTO, ffppsmin, CTLTYPE_INT | CTLFLAG_RW,
90         &ieee80211_ffppsmin, 0, "min packet rate before fast-frame staging");
91 static  int ieee80211_ffagemax = -1;    /* max time frames held on stage q */
92 SYSCTL_PROC(_net_wlan, OID_AUTO, ffagemax, CTLTYPE_INT | CTLFLAG_RW,
93         &ieee80211_ffagemax, 0, ieee80211_sysctl_msecs_ticks, "I",
94         "max hold time for fast-frame staging (ms)");
95
96 void
97 ieee80211_superg_attach(struct ieee80211com *ic)
98 {
99         struct ieee80211_superg *sg;
100
101         if (ic->ic_caps & IEEE80211_C_FF) {
102                 sg = (struct ieee80211_superg *) malloc(
103                      sizeof(struct ieee80211_superg), M_80211_VAP,
104                      M_NOWAIT | M_ZERO);
105                 if (sg == NULL) {
106                         printf("%s: cannot allocate SuperG state block\n",
107                             __func__);
108                         return;
109                 }
110                 ic->ic_superg = sg;
111         }
112         ieee80211_ffagemax = msecs_to_ticks(150);
113 }
114
115 void
116 ieee80211_superg_detach(struct ieee80211com *ic)
117 {
118         if (ic->ic_superg != NULL) {
119                 free(ic->ic_superg, M_80211_VAP);
120                 ic->ic_superg = NULL;
121         }
122 }
123
124 void
125 ieee80211_superg_vattach(struct ieee80211vap *vap)
126 {
127         struct ieee80211com *ic = vap->iv_ic;
128
129         if (ic->ic_superg == NULL)      /* NB: can't do fast-frames w/o state */
130                 vap->iv_caps &= ~IEEE80211_C_FF;
131         if (vap->iv_caps & IEEE80211_C_FF)
132                 vap->iv_flags |= IEEE80211_F_FF;
133         /* NB: we only implement sta mode */
134         if (vap->iv_opmode == IEEE80211_M_STA &&
135             (vap->iv_caps & IEEE80211_C_TURBOP))
136                 vap->iv_flags |= IEEE80211_F_TURBOP;
137 }
138
139 void
140 ieee80211_superg_vdetach(struct ieee80211vap *vap)
141 {
142 }
143
144 #define ATH_OUI_BYTES           0x00, 0x03, 0x7f
145 /*
146  * Add a WME information element to a frame.
147  */
148 uint8_t *
149 ieee80211_add_ath(uint8_t *frm, uint8_t caps, ieee80211_keyix defkeyix)
150 {
151         static const struct ieee80211_ath_ie info = {
152                 .ath_id         = IEEE80211_ELEMID_VENDOR,
153                 .ath_len        = sizeof(struct ieee80211_ath_ie) - 2,
154                 .ath_oui        = { ATH_OUI_BYTES },
155                 .ath_oui_type   = ATH_OUI_TYPE,
156                 .ath_oui_subtype= ATH_OUI_SUBTYPE,
157                 .ath_version    = ATH_OUI_VERSION,
158         };
159         struct ieee80211_ath_ie *ath = (struct ieee80211_ath_ie *) frm;
160
161         memcpy(frm, &info, sizeof(info));
162         ath->ath_capability = caps;
163         if (defkeyix != IEEE80211_KEYIX_NONE) {
164                 ath->ath_defkeyix[0] = (defkeyix & 0xff);
165                 ath->ath_defkeyix[1] = ((defkeyix >> 8) & 0xff);
166         } else {
167                 ath->ath_defkeyix[0] = 0xff;
168                 ath->ath_defkeyix[1] = 0x7f;
169         }
170         return frm + sizeof(info); 
171 }
172 #undef ATH_OUI_BYTES
173
174 uint8_t *
175 ieee80211_add_athcaps(uint8_t *frm, const struct ieee80211_node *bss)
176 {
177         const struct ieee80211vap *vap = bss->ni_vap;
178
179         return ieee80211_add_ath(frm,
180             vap->iv_flags & IEEE80211_F_ATHEROS,
181             ((vap->iv_flags & IEEE80211_F_WPA) == 0 &&
182             bss->ni_authmode != IEEE80211_AUTH_8021X) ?
183             vap->iv_def_txkey : IEEE80211_KEYIX_NONE);
184 }
185
186 void
187 ieee80211_parse_ath(struct ieee80211_node *ni, uint8_t *ie)
188 {
189         const struct ieee80211_ath_ie *ath =
190                 (const struct ieee80211_ath_ie *) ie;
191
192         ni->ni_ath_flags = ath->ath_capability;
193         ni->ni_ath_defkeyix = LE_READ_2(&ath->ath_defkeyix);
194 }
195
196 int
197 ieee80211_parse_athparams(struct ieee80211_node *ni, uint8_t *frm,
198         const struct ieee80211_frame *wh)
199 {
200         struct ieee80211vap *vap = ni->ni_vap;
201         const struct ieee80211_ath_ie *ath;
202         u_int len = frm[1];
203         int capschanged;
204         uint16_t defkeyix;
205
206         if (len < sizeof(struct ieee80211_ath_ie)-2) {
207                 IEEE80211_DISCARD_IE(vap,
208                     IEEE80211_MSG_ELEMID | IEEE80211_MSG_SUPERG,
209                     wh, "Atheros", "too short, len %u", len);
210                 return -1;
211         }
212         ath = (const struct ieee80211_ath_ie *)frm;
213         capschanged = (ni->ni_ath_flags != ath->ath_capability);
214         defkeyix = LE_READ_2(ath->ath_defkeyix);
215         if (capschanged || defkeyix != ni->ni_ath_defkeyix) {
216                 ni->ni_ath_flags = ath->ath_capability;
217                 ni->ni_ath_defkeyix = defkeyix;
218                 IEEE80211_NOTE(vap, IEEE80211_MSG_SUPERG, ni,
219                     "ath ie change: new caps 0x%x defkeyix 0x%x",
220                     ni->ni_ath_flags, ni->ni_ath_defkeyix);
221         }
222         if (IEEE80211_ATH_CAP(vap, ni, ATHEROS_CAP_TURBO_PRIME)) {
223                 uint16_t curflags, newflags;
224
225                 /*
226                  * Check for turbo mode switch.  Calculate flags
227                  * for the new mode and effect the switch.
228                  */
229                 newflags = curflags = vap->iv_ic->ic_bsschan->ic_flags;
230                 /* NB: BOOST is not in ic_flags, so get it from the ie */
231                 if (ath->ath_capability & ATHEROS_CAP_BOOST) 
232                         newflags |= IEEE80211_CHAN_TURBO;
233                 else
234                         newflags &= ~IEEE80211_CHAN_TURBO;
235                 if (newflags != curflags)
236                         ieee80211_dturbo_switch(vap, newflags);
237         }
238         return capschanged;
239 }
240
241 /*
242  * Decap the encapsulated frame pair and dispatch the first
243  * for delivery.  The second frame is returned for delivery
244  * via the normal path.
245  */
246 struct mbuf *
247 ieee80211_ff_decap(struct ieee80211_node *ni, struct mbuf *m)
248 {
249 #define FF_LLC_SIZE     (sizeof(struct ether_header) + sizeof(struct llc))
250 #define MS(x,f) (((x) & f) >> f##_S)
251         struct ieee80211vap *vap = ni->ni_vap;
252         struct llc *llc;
253         uint32_t ath;
254         struct mbuf *n;
255         int framelen;
256
257         /* NB: we assume caller does this check for us */
258         KASSERT(IEEE80211_ATH_CAP(vap, ni, IEEE80211_NODE_FF),
259             ("ff not negotiated"));
260         /*
261          * Check for fast-frame tunnel encapsulation.
262          */
263         if (m->m_pkthdr.len < 3*FF_LLC_SIZE)
264                 return m;
265         if (m->m_len < FF_LLC_SIZE &&
266             (m = m_pullup(m, FF_LLC_SIZE)) == NULL) {
267                 IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_ANY,
268                     ni->ni_macaddr, "fast-frame",
269                     "%s", "m_pullup(llc) failed");
270                 vap->iv_stats.is_rx_tooshort++;
271                 return NULL;
272         }
273         llc = (struct llc *)(mtod(m, uint8_t *) +
274             sizeof(struct ether_header));
275         if (llc->llc_snap.ether_type != htons(ATH_FF_ETH_TYPE))
276                 return m;
277         m_adj(m, FF_LLC_SIZE);
278         m_copydata(m, 0, sizeof(uint32_t), (caddr_t) &ath);
279         if (MS(ath, ATH_FF_PROTO) != ATH_FF_PROTO_L2TUNNEL) {
280                 IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_ANY,
281                     ni->ni_macaddr, "fast-frame",
282                     "unsupport tunnel protocol, header 0x%x", ath);
283                 vap->iv_stats.is_ff_badhdr++;
284                 m_freem(m);
285                 return NULL;
286         }
287         /* NB: skip header and alignment padding */
288         m_adj(m, roundup(sizeof(uint32_t) - 2, 4) + 2);
289
290         vap->iv_stats.is_ff_decap++;
291
292         /*
293          * Decap the first frame, bust it apart from the
294          * second and deliver; then decap the second frame
295          * and return it to the caller for normal delivery.
296          */
297         m = ieee80211_decap1(m, &framelen);
298         if (m == NULL) {
299                 IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_ANY,
300                     ni->ni_macaddr, "fast-frame", "%s", "first decap failed");
301                 vap->iv_stats.is_ff_tooshort++;
302                 return NULL;
303         }
304         n = m_split(m, framelen, M_NOWAIT);
305         if (n == NULL) {
306                 IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_ANY,
307                     ni->ni_macaddr, "fast-frame",
308                     "%s", "unable to split encapsulated frames");
309                 vap->iv_stats.is_ff_split++;
310                 m_freem(m);                     /* NB: must reclaim */
311                 return NULL;
312         }
313         /* XXX not right for WDS */
314         vap->iv_deliver_data(vap, ni, m);       /* 1st of pair */
315
316         /*
317          * Decap second frame.
318          */
319         m_adj(n, roundup2(framelen, 4) - framelen);     /* padding */
320         n = ieee80211_decap1(n, &framelen);
321         if (n == NULL) {
322                 IEEE80211_DISCARD_MAC(vap, IEEE80211_MSG_ANY,
323                     ni->ni_macaddr, "fast-frame", "%s", "second decap failed");
324                 vap->iv_stats.is_ff_tooshort++;
325         }
326         /* XXX verify framelen against mbuf contents */
327         return n;                               /* 2nd delivered by caller */
328 #undef MS
329 #undef FF_LLC_SIZE
330 }
331
332 /*
333  * Do Ethernet-LLC encapsulation for each payload in a fast frame
334  * tunnel encapsulation.  The frame is assumed to have an Ethernet
335  * header at the front that must be stripped before prepending the
336  * LLC followed by the Ethernet header passed in (with an Ethernet
337  * type that specifies the payload size).
338  */
339 static struct mbuf *
340 ff_encap1(struct ieee80211vap *vap, struct mbuf *m,
341         const struct ether_header *eh)
342 {
343         struct llc *llc;
344         uint16_t payload;
345
346         /* XXX optimize by combining m_adj+M_PREPEND */
347         m_adj(m, sizeof(struct ether_header) - sizeof(struct llc));
348         llc = mtod(m, struct llc *);
349         llc->llc_dsap = llc->llc_ssap = LLC_SNAP_LSAP;
350         llc->llc_control = LLC_UI;
351         llc->llc_snap.org_code[0] = 0;
352         llc->llc_snap.org_code[1] = 0;
353         llc->llc_snap.org_code[2] = 0;
354         llc->llc_snap.ether_type = eh->ether_type;
355         payload = m->m_pkthdr.len;              /* NB: w/o Ethernet header */
356
357         M_PREPEND(m, sizeof(struct ether_header), M_NOWAIT);
358         if (m == NULL) {                /* XXX cannot happen */
359                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_SUPERG,
360                         "%s: no space for ether_header\n", __func__);
361                 vap->iv_stats.is_tx_nobuf++;
362                 return NULL;
363         }
364         ETHER_HEADER_COPY(mtod(m, void *), eh);
365         mtod(m, struct ether_header *)->ether_type = htons(payload);
366         return m;
367 }
368
369 /*
370  * Fast frame encapsulation.  There must be two packets
371  * chained with m_nextpkt.  We do header adjustment for
372  * each, add the tunnel encapsulation, and then concatenate
373  * the mbuf chains to form a single frame for transmission.
374  */
375 struct mbuf *
376 ieee80211_ff_encap(struct ieee80211vap *vap, struct mbuf *m1, int hdrspace,
377         struct ieee80211_key *key)
378 {
379         struct mbuf *m2;
380         struct ether_header eh1, eh2;
381         struct llc *llc;
382         struct mbuf *m;
383         int pad;
384
385         m2 = m1->m_nextpkt;
386         if (m2 == NULL) {
387                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_SUPERG,
388                     "%s: only one frame\n", __func__);
389                 goto bad;
390         }
391         m1->m_nextpkt = NULL;
392         /*
393          * Include fast frame headers in adjusting header layout.
394          */
395         KASSERT(m1->m_len >= sizeof(eh1), ("no ethernet header!"));
396         ETHER_HEADER_COPY(&eh1, mtod(m1, caddr_t));
397         m1 = ieee80211_mbuf_adjust(vap,
398                 hdrspace + sizeof(struct llc) + sizeof(uint32_t) + 2 +
399                     sizeof(struct ether_header),
400                 key, m1);
401         if (m1 == NULL) {
402                 /* NB: ieee80211_mbuf_adjust handles msgs+statistics */
403                 m_freem(m2);
404                 goto bad;
405         }
406
407         /*
408          * Copy second frame's Ethernet header out of line
409          * and adjust for encapsulation headers.  Note that
410          * we make room for padding in case there isn't room
411          * at the end of first frame.
412          */
413         KASSERT(m2->m_len >= sizeof(eh2), ("no ethernet header!"));
414         ETHER_HEADER_COPY(&eh2, mtod(m2, caddr_t));
415         m2 = ieee80211_mbuf_adjust(vap,
416                 ATH_FF_MAX_HDR_PAD + sizeof(struct ether_header),
417                 NULL, m2);
418         if (m2 == NULL) {
419                 /* NB: ieee80211_mbuf_adjust handles msgs+statistics */
420                 goto bad;
421         }
422
423         /*
424          * Now do tunnel encapsulation.  First, each
425          * frame gets a standard encapsulation.
426          */
427         m1 = ff_encap1(vap, m1, &eh1);
428         if (m1 == NULL)
429                 goto bad;
430         m2 = ff_encap1(vap, m2, &eh2);
431         if (m2 == NULL)
432                 goto bad;
433
434         /*
435          * Pad leading frame to a 4-byte boundary.  If there
436          * is space at the end of the first frame, put it
437          * there; otherwise prepend to the front of the second
438          * frame.  We know doing the second will always work
439          * because we reserve space above.  We prefer appending
440          * as this typically has better DMA alignment properties.
441          */
442         for (m = m1; m->m_next != NULL; m = m->m_next)
443                 ;
444         pad = roundup2(m1->m_pkthdr.len, 4) - m1->m_pkthdr.len;
445         if (pad) {
446                 if (M_TRAILINGSPACE(m) < pad) {         /* prepend to second */
447                         m2->m_data -= pad;
448                         m2->m_len += pad;
449                         m2->m_pkthdr.len += pad;
450                 } else {                                /* append to first */
451                         m->m_len += pad;
452                         m1->m_pkthdr.len += pad;
453                 }
454         }
455
456         /*
457          * Now, stick 'em together and prepend the tunnel headers;
458          * first the Atheros tunnel header (all zero for now) and
459          * then a special fast frame LLC.
460          *
461          * XXX optimize by prepending together
462          */
463         m->m_next = m2;                 /* NB: last mbuf from above */
464         m1->m_pkthdr.len += m2->m_pkthdr.len;
465         M_PREPEND(m1, sizeof(uint32_t)+2, M_NOWAIT);
466         if (m1 == NULL) {               /* XXX cannot happen */
467                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_SUPERG,
468                     "%s: no space for tunnel header\n", __func__);
469                 vap->iv_stats.is_tx_nobuf++;
470                 return NULL;
471         }
472         memset(mtod(m1, void *), 0, sizeof(uint32_t)+2);
473
474         M_PREPEND(m1, sizeof(struct llc), M_NOWAIT);
475         if (m1 == NULL) {               /* XXX cannot happen */
476                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_SUPERG,
477                     "%s: no space for llc header\n", __func__);
478                 vap->iv_stats.is_tx_nobuf++;
479                 return NULL;
480         }
481         llc = mtod(m1, struct llc *);
482         llc->llc_dsap = llc->llc_ssap = LLC_SNAP_LSAP;
483         llc->llc_control = LLC_UI;
484         llc->llc_snap.org_code[0] = ATH_FF_SNAP_ORGCODE_0;
485         llc->llc_snap.org_code[1] = ATH_FF_SNAP_ORGCODE_1;
486         llc->llc_snap.org_code[2] = ATH_FF_SNAP_ORGCODE_2;
487         llc->llc_snap.ether_type = htons(ATH_FF_ETH_TYPE);
488
489         vap->iv_stats.is_ff_encap++;
490
491         return m1;
492 bad:
493         if (m1 != NULL)
494                 m_freem(m1);
495         if (m2 != NULL)
496                 m_freem(m2);
497         return NULL;
498 }
499
500 static void
501 ff_transmit(struct ieee80211_node *ni, struct mbuf *m)
502 {
503         struct ieee80211vap *vap = ni->ni_vap;
504         int error;
505
506         /* encap and xmit */
507         m = ieee80211_encap(vap, ni, m);
508         if (m != NULL) {
509                 struct ifnet *ifp = vap->iv_ifp;
510                 struct ifnet *parent = ni->ni_ic->ic_ifp;
511
512                 error = parent->if_transmit(parent, m);
513                 if (error != 0) {
514                         /* NB: IFQ_HANDOFF reclaims mbuf */
515                         ieee80211_free_node(ni);
516                 } else {
517                         ifp->if_opackets++;
518                 }
519         } else
520                 ieee80211_free_node(ni);
521 }
522
523 /*
524  * Flush frames to device; note we re-use the linked list
525  * the frames were stored on and use the sentinel (unchanged)
526  * which may be non-NULL.
527  */
528 static void
529 ff_flush(struct mbuf *head, struct mbuf *last)
530 {
531         struct mbuf *m, *next;
532         struct ieee80211_node *ni;
533         struct ieee80211vap *vap;
534
535         for (m = head; m != last; m = next) {
536                 next = m->m_nextpkt;
537                 m->m_nextpkt = NULL;
538
539                 ni = (struct ieee80211_node *) m->m_pkthdr.rcvif;
540                 vap = ni->ni_vap;
541
542                 IEEE80211_NOTE(vap, IEEE80211_MSG_SUPERG, ni,
543                     "%s: flush frame, age %u", __func__, M_AGE_GET(m));
544                 vap->iv_stats.is_ff_flush++;
545
546                 ff_transmit(ni, m);
547         }
548 }
549
550 /*
551  * Age frames on the staging queue.
552  *
553  * This is called without the comlock held, but it does all its work
554  * behind the comlock.  Because of this, it's possible that the
555  * staging queue will be serviced between the function which called
556  * it and now; thus simply checking that the queue has work in it
557  * may fail.
558  *
559  * See PR kern/174283 for more details.
560  */
561 void
562 ieee80211_ff_age(struct ieee80211com *ic, struct ieee80211_stageq *sq,
563     int quanta)
564 {
565         struct mbuf *m, *head;
566         struct ieee80211_node *ni;
567         struct ieee80211_tx_ampdu *tap;
568
569 #if 0
570         KASSERT(sq->head != NULL, ("stageq empty"));
571 #endif
572
573         IEEE80211_LOCK(ic);
574         head = sq->head;
575         while ((m = sq->head) != NULL && M_AGE_GET(m) < quanta) {
576                 int tid = WME_AC_TO_TID(M_WME_GETAC(m));
577
578                 /* clear tap ref to frame */
579                 ni = (struct ieee80211_node *) m->m_pkthdr.rcvif;
580                 tap = &ni->ni_tx_ampdu[tid];
581                 KASSERT(tap->txa_private == m, ("staging queue empty"));
582                 tap->txa_private = NULL;
583
584                 sq->head = m->m_nextpkt;
585                 sq->depth--;
586         }
587         if (m == NULL)
588                 sq->tail = NULL;
589         else
590                 M_AGE_SUB(m, quanta);
591         IEEE80211_UNLOCK(ic);
592
593         ff_flush(head, m);
594 }
595
596 static void
597 stageq_add(struct ieee80211com *ic, struct ieee80211_stageq *sq, struct mbuf *m)
598 {
599         int age = ieee80211_ffagemax;
600
601         IEEE80211_LOCK_ASSERT(ic);
602
603         if (sq->tail != NULL) {
604                 sq->tail->m_nextpkt = m;
605                 age -= M_AGE_GET(sq->head);
606         } else
607                 sq->head = m;
608         KASSERT(age >= 0, ("age %d", age));
609         M_AGE_SET(m, age);
610         m->m_nextpkt = NULL;
611         sq->tail = m;
612         sq->depth++;
613 }
614
615 static void
616 stageq_remove(struct ieee80211com *ic, struct ieee80211_stageq *sq, struct mbuf *mstaged)
617 {
618         struct mbuf *m, *mprev;
619
620         IEEE80211_LOCK_ASSERT(ic);
621
622         mprev = NULL;
623         for (m = sq->head; m != NULL; m = m->m_nextpkt) {
624                 if (m == mstaged) {
625                         if (mprev == NULL)
626                                 sq->head = m->m_nextpkt;
627                         else
628                                 mprev->m_nextpkt = m->m_nextpkt;
629                         if (sq->tail == m)
630                                 sq->tail = mprev;
631                         sq->depth--;
632                         return;
633                 }
634                 mprev = m;
635         }
636         printf("%s: packet not found\n", __func__);
637 }
638
639 static uint32_t
640 ff_approx_txtime(struct ieee80211_node *ni,
641         const struct mbuf *m1, const struct mbuf *m2)
642 {
643         struct ieee80211com *ic = ni->ni_ic;
644         struct ieee80211vap *vap = ni->ni_vap;
645         uint32_t framelen;
646
647         /*
648          * Approximate the frame length to be transmitted. A swag to add
649          * the following maximal values to the skb payload:
650          *   - 32: 802.11 encap + CRC
651          *   - 24: encryption overhead (if wep bit)
652          *   - 4 + 6: fast-frame header and padding
653          *   - 16: 2 LLC FF tunnel headers
654          *   - 14: 1 802.3 FF tunnel header (mbuf already accounts for 2nd)
655          */
656         framelen = m1->m_pkthdr.len + 32 +
657             ATH_FF_MAX_HDR_PAD + ATH_FF_MAX_SEP_PAD + ATH_FF_MAX_HDR;
658         if (vap->iv_flags & IEEE80211_F_PRIVACY)
659                 framelen += 24;
660         if (m2 != NULL)
661                 framelen += m2->m_pkthdr.len;
662         return ieee80211_compute_duration(ic->ic_rt, framelen, ni->ni_txrate, 0);
663 }
664
665 /*
666  * Check if the supplied frame can be partnered with an existing
667  * or pending frame.  Return a reference to any frame that should be
668  * sent on return; otherwise return NULL.
669  */
670 struct mbuf *
671 ieee80211_ff_check(struct ieee80211_node *ni, struct mbuf *m)
672 {
673         struct ieee80211vap *vap = ni->ni_vap;
674         struct ieee80211com *ic = ni->ni_ic;
675         struct ieee80211_superg *sg = ic->ic_superg;
676         const int pri = M_WME_GETAC(m);
677         struct ieee80211_stageq *sq;
678         struct ieee80211_tx_ampdu *tap;
679         struct mbuf *mstaged;
680         uint32_t txtime, limit;
681
682         /*
683          * Check if the supplied frame can be aggregated.
684          *
685          * NB: we allow EAPOL frames to be aggregated with other ucast traffic.
686          *     Do 802.1x EAPOL frames proceed in the clear? Then they couldn't
687          *     be aggregated with other types of frames when encryption is on?
688          */
689         IEEE80211_LOCK(ic);
690         tap = &ni->ni_tx_ampdu[WME_AC_TO_TID(pri)];
691         mstaged = tap->txa_private;             /* NB: we reuse AMPDU state */
692         ieee80211_txampdu_count_packet(tap);
693
694         /*
695          * When not in station mode never aggregate a multicast
696          * frame; this insures, for example, that a combined frame
697          * does not require multiple encryption keys.
698          */
699         if (vap->iv_opmode != IEEE80211_M_STA &&
700             ETHER_IS_MULTICAST(mtod(m, struct ether_header *)->ether_dhost)) {
701                 /* XXX flush staged frame? */
702                 IEEE80211_UNLOCK(ic);
703                 return m;
704         }
705         /*
706          * If there is no frame to combine with and the pps is
707          * too low; then do not attempt to aggregate this frame.
708          */
709         if (mstaged == NULL &&
710             ieee80211_txampdu_getpps(tap) < ieee80211_ffppsmin) {
711                 IEEE80211_UNLOCK(ic);
712                 return m;
713         }
714         sq = &sg->ff_stageq[pri];
715         /*
716          * Check the txop limit to insure the aggregate fits.
717          */
718         limit = IEEE80211_TXOP_TO_US(
719                 ic->ic_wme.wme_chanParams.cap_wmeParams[pri].wmep_txopLimit);
720         if (limit != 0 &&
721             (txtime = ff_approx_txtime(ni, m, mstaged)) > limit) {
722                 /*
723                  * Aggregate too long, return to the caller for direct
724                  * transmission.  In addition, flush any pending frame
725                  * before sending this one.
726                  */
727                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_SUPERG,
728                     "%s: txtime %u exceeds txop limit %u\n",
729                     __func__, txtime, limit);
730
731                 tap->txa_private = NULL;
732                 if (mstaged != NULL)
733                         stageq_remove(ic, sq, mstaged);
734                 IEEE80211_UNLOCK(ic);
735
736                 if (mstaged != NULL) {
737                         IEEE80211_NOTE(vap, IEEE80211_MSG_SUPERG, ni,
738                             "%s: flush staged frame", __func__);
739                         /* encap and xmit */
740                         ff_transmit(ni, mstaged);
741                 }
742                 return m;               /* NB: original frame */
743         }
744         /*
745          * An aggregation candidate.  If there's a frame to partner
746          * with then combine and return for processing.  Otherwise
747          * save this frame and wait for a partner to show up (or
748          * the frame to be flushed).  Note that staged frames also
749          * hold their node reference.
750          */
751         if (mstaged != NULL) {
752                 tap->txa_private = NULL;
753                 stageq_remove(ic, sq, mstaged);
754                 IEEE80211_UNLOCK(ic);
755
756                 IEEE80211_NOTE(vap, IEEE80211_MSG_SUPERG, ni,
757                     "%s: aggregate fast-frame", __func__);
758                 /*
759                  * Release the node reference; we only need
760                  * the one already in mstaged.
761                  */
762                 KASSERT(mstaged->m_pkthdr.rcvif == (void *)ni,
763                     ("rcvif %p ni %p", mstaged->m_pkthdr.rcvif, ni));
764                 ieee80211_free_node(ni);
765
766                 m->m_nextpkt = NULL;
767                 mstaged->m_nextpkt = m;
768                 mstaged->m_flags |= M_FF; /* NB: mark for encap work */
769         } else {
770                 KASSERT(tap->txa_private == NULL,
771                     ("txa_private %p", tap->txa_private));
772                 tap->txa_private = m;
773
774                 stageq_add(ic, sq, m);
775                 IEEE80211_UNLOCK(ic);
776
777                 IEEE80211_NOTE(vap, IEEE80211_MSG_SUPERG, ni,
778                     "%s: stage frame, %u queued", __func__, sq->depth);
779                 /* NB: mstaged is NULL */
780         }
781         return mstaged;
782 }
783
784 void
785 ieee80211_ff_node_init(struct ieee80211_node *ni)
786 {
787         /*
788          * Clean FF state on re-associate.  This handles the case
789          * where a station leaves w/o notifying us and then returns
790          * before node is reaped for inactivity.
791          */
792         ieee80211_ff_node_cleanup(ni);
793 }
794
795 void
796 ieee80211_ff_node_cleanup(struct ieee80211_node *ni)
797 {
798         struct ieee80211com *ic = ni->ni_ic;
799         struct ieee80211_superg *sg = ic->ic_superg;
800         struct ieee80211_tx_ampdu *tap;
801         struct mbuf *m, *next_m, *head;
802         int tid;
803
804         IEEE80211_LOCK(ic);
805         head = NULL;
806         for (tid = 0; tid < WME_NUM_TID; tid++) {
807                 int ac = TID_TO_WME_AC(tid);
808
809                 tap = &ni->ni_tx_ampdu[tid];
810                 m = tap->txa_private;
811                 if (m != NULL) {
812                         tap->txa_private = NULL;
813                         stageq_remove(ic, &sg->ff_stageq[ac], m);
814                         m->m_nextpkt = head;
815                         head = m;
816                 }
817         }
818         IEEE80211_UNLOCK(ic);
819
820         /*
821          * Free mbufs, taking care to not dereference the mbuf after
822          * we free it (hence grabbing m_nextpkt before we free it.)
823          */
824         m = head;
825         while (m != NULL) {
826                 next_m = m->m_nextpkt;
827                 m_freem(m);
828                 ieee80211_free_node(ni);
829                 m = next_m;
830         }
831 }
832
833 /*
834  * Switch between turbo and non-turbo operating modes.
835  * Use the specified channel flags to locate the new
836  * channel, update 802.11 state, and then call back into
837  * the driver to effect the change.
838  */
839 void
840 ieee80211_dturbo_switch(struct ieee80211vap *vap, int newflags)
841 {
842         struct ieee80211com *ic = vap->iv_ic;
843         struct ieee80211_channel *chan;
844
845         chan = ieee80211_find_channel(ic, ic->ic_bsschan->ic_freq, newflags);
846         if (chan == NULL) {             /* XXX should not happen */
847                 IEEE80211_DPRINTF(vap, IEEE80211_MSG_SUPERG,
848                     "%s: no channel with freq %u flags 0x%x\n",
849                     __func__, ic->ic_bsschan->ic_freq, newflags);
850                 return;
851         }
852
853         IEEE80211_DPRINTF(vap, IEEE80211_MSG_SUPERG,
854             "%s: %s -> %s (freq %u flags 0x%x)\n", __func__,
855             ieee80211_phymode_name[ieee80211_chan2mode(ic->ic_bsschan)],
856             ieee80211_phymode_name[ieee80211_chan2mode(chan)],
857             chan->ic_freq, chan->ic_flags);
858
859         ic->ic_bsschan = chan;
860         ic->ic_prevchan = ic->ic_curchan;
861         ic->ic_curchan = chan;
862         ic->ic_rt = ieee80211_get_ratetable(chan);
863         ic->ic_set_channel(ic);
864         ieee80211_radiotap_chan_change(ic);
865         /* NB: do not need to reset ERP state 'cuz we're in sta mode */
866 }
867
868 /*
869  * Return the current ``state'' of an Atheros capbility.
870  * If associated in station mode report the negotiated
871  * setting. Otherwise report the current setting.
872  */
873 static int
874 getathcap(struct ieee80211vap *vap, int cap)
875 {
876         if (vap->iv_opmode == IEEE80211_M_STA &&
877             vap->iv_state == IEEE80211_S_RUN)
878                 return IEEE80211_ATH_CAP(vap, vap->iv_bss, cap) != 0;
879         else
880                 return (vap->iv_flags & cap) != 0;
881 }
882
883 static int
884 superg_ioctl_get80211(struct ieee80211vap *vap, struct ieee80211req *ireq)
885 {
886         switch (ireq->i_type) {
887         case IEEE80211_IOC_FF:
888                 ireq->i_val = getathcap(vap, IEEE80211_F_FF);
889                 break;
890         case IEEE80211_IOC_TURBOP:
891                 ireq->i_val = getathcap(vap, IEEE80211_F_TURBOP);
892                 break;
893         default:
894                 return ENOSYS;
895         }
896         return 0;
897 }
898 IEEE80211_IOCTL_GET(superg, superg_ioctl_get80211);
899
900 static int
901 superg_ioctl_set80211(struct ieee80211vap *vap, struct ieee80211req *ireq)
902 {
903         switch (ireq->i_type) {
904         case IEEE80211_IOC_FF:
905                 if (ireq->i_val) {
906                         if ((vap->iv_caps & IEEE80211_C_FF) == 0)
907                                 return EOPNOTSUPP;
908                         vap->iv_flags |= IEEE80211_F_FF;
909                 } else
910                         vap->iv_flags &= ~IEEE80211_F_FF;
911                 return ENETRESET;
912         case IEEE80211_IOC_TURBOP:
913                 if (ireq->i_val) {
914                         if ((vap->iv_caps & IEEE80211_C_TURBOP) == 0)
915                                 return EOPNOTSUPP;
916                         vap->iv_flags |= IEEE80211_F_TURBOP;
917                 } else
918                         vap->iv_flags &= ~IEEE80211_F_TURBOP;
919                 return ENETRESET;
920         default:
921                 return ENOSYS;
922         }
923         return 0;
924 }
925 IEEE80211_IOCTL_SET(superg, superg_ioctl_set80211);
926
927 #endif  /* IEEE80211_SUPPORT_SUPERG */