sys/net80211/ieee80211_superg.c

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