drivers/staging/brcm80211/brcmsmac/pub.h

   1 /*
   2  * Copyright (c) 2010 Broadcom Corporation
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  11  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
  13  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #ifndef _BRCM_PUB_H_
  18 #define _BRCM_PUB_H_
  19
  20 #include <brcmu_wifi.h>
  21 #include "types.h"
  22 #include "defs.h"
  23
  24 #define WLC_NUMRATES    16      /* max # of rates in a rateset */
  25 #define MAXMULTILIST    32      /* max # multicast addresses */
  26 #define D11_PHY_HDR_LEN 6       /* Phy header length - 6 bytes */
  27
  28 /* phy types */
  29 #define PHY_TYPE_A      0       /* Phy type A */
  30 #define PHY_TYPE_G      2       /* Phy type G */
  31 #define PHY_TYPE_N      4       /* Phy type N */
  32 #define PHY_TYPE_LP     5       /* Phy type Low Power A/B/G */
  33 #define PHY_TYPE_SSN    6       /* Phy type Single Stream N */
  34 #define PHY_TYPE_LCN    8       /* Phy type Single Stream N */
  35 #define PHY_TYPE_LCNXN  9       /* Phy type 2-stream N */
  36 #define PHY_TYPE_HT     7       /* Phy type 3-Stream N */
  37
  38 /* bw */
  39 #define WLC_10_MHZ      10      /* 10Mhz nphy channel bandwidth */
  40 #define WLC_20_MHZ      20      /* 20Mhz nphy channel bandwidth */
  41 #define WLC_40_MHZ      40      /* 40Mhz nphy channel bandwidth */
  42
  43 #define CHSPEC_WLC_BW(chanspec) (CHSPEC_IS40(chanspec) ? WLC_40_MHZ : \
  44                                  CHSPEC_IS20(chanspec) ? WLC_20_MHZ : \
  45                                                          WLC_10_MHZ)
  46
  47 #define WLC_RSSI_MINVAL         -200    /* Low value, e.g. for forcing roam */
  48 #define WLC_RSSI_NO_SIGNAL      -91     /* NDIS RSSI link quality cutoffs */
  49 #define WLC_RSSI_VERY_LOW       -80     /* Very low quality cutoffs */
  50 #define WLC_RSSI_LOW            -70     /* Low quality cutoffs */
  51 #define WLC_RSSI_GOOD           -68     /* Good quality cutoffs */
  52 #define WLC_RSSI_VERY_GOOD      -58     /* Very good quality cutoffs */
  53 #define WLC_RSSI_EXCELLENT      -57     /* Excellent quality cutoffs */
  54
  55 #define WLC_PHYTYPE(_x) (_x)    /* macro to perform WLC PHY -> D11 PHY TYPE, currently 1:1 */
  56
  57 #define MA_WINDOW_SZ            8       /* moving average window size */
  58
  59 #define WLC_SNR_INVALID         0       /* invalid SNR value */
  60
  61 /* a large TX Power as an init value to factor out of min() calculations,
  62  * keep low enough to fit in an s8, units are .25 dBm
  63  */
  64 #define WLC_TXPWR_MAX           (127)   /* ~32 dBm = 1,500 mW */
  65
  66 /* rate related definitions */
  67 #define WLC_RATE_FLAG   0x80    /* Flag to indicate it is a basic rate */
  68 #define WLC_RATE_MASK   0x7f    /* Rate value mask w/o basic rate flag */
  69
  70 /* legacy rx Antenna diversity for SISO rates */
  71 #define ANT_RX_DIV_FORCE_0              0       /* Use antenna 0 */
  72 #define ANT_RX_DIV_FORCE_1              1       /* Use antenna 1 */
  73 #define ANT_RX_DIV_START_1              2       /* Choose starting with 1 */
  74 #define ANT_RX_DIV_START_0              3       /* Choose starting with 0 */
  75 #define ANT_RX_DIV_ENABLE               3       /* APHY bbConfig Enable RX Diversity */
  76 #define ANT_RX_DIV_DEF          ANT_RX_DIV_START_0      /* default antdiv setting */
  77
  78 /* legacy rx Antenna diversity for SISO rates */
  79 #define ANT_TX_FORCE_0          0       /* Tx on antenna 0, "legacy term Main" */
  80 #define ANT_TX_FORCE_1          1       /* Tx on antenna 1, "legacy term Aux" */
  81 #define ANT_TX_LAST_RX          3       /* Tx on phy's last good Rx antenna */
  82 #define ANT_TX_DEF                      3       /* driver's default tx antenna setting */
  83
  84 #define TXCORE_POLICY_ALL       0x1     /* use all available core for transmit */
  85
  86 /* Tx Chain values */
  87 #define TXCHAIN_DEF             0x1     /* def bitmap of txchain */
  88 #define TXCHAIN_DEF_NPHY        0x3     /* default bitmap of tx chains for nphy */
  89 #define TXCHAIN_DEF_HTPHY       0x7     /* default bitmap of tx chains for nphy */
  90 #define RXCHAIN_DEF             0x1     /* def bitmap of rxchain */
  91 #define RXCHAIN_DEF_NPHY        0x3     /* default bitmap of rx chains for nphy */
  92 #define RXCHAIN_DEF_HTPHY       0x7     /* default bitmap of rx chains for nphy */
  93 #define ANTSWITCH_NONE          0       /* no antenna switch */
  94 #define ANTSWITCH_TYPE_1        1       /* antenna switch on 4321CB2, 2of3 */
  95 #define ANTSWITCH_TYPE_2        2       /* antenna switch on 4321MPCI, 2of3 */
  96 #define ANTSWITCH_TYPE_3        3       /* antenna switch on 4322, 2of3 */
  97
  98 #define RXBUFSZ         PKTBUFSZ
  99 #ifndef AIDMAPSZ
 100 #define AIDMAPSZ        (roundup(MAXSCB, NBBY)/NBBY)    /* aid bitmap size in bytes */
 101 #endif                          /* AIDMAPSZ */
 102
 103 #define MAX_STREAMS_SUPPORTED   4       /* max number of streams supported */
 104
 105 #define WL_SPURAVOID_OFF        0
 106 #define WL_SPURAVOID_ON1        1
 107 #define WL_SPURAVOID_ON2        2
 108
 109 struct brcms_tunables {
 110         int ntxd;               /* size of tx descriptor table */
 111         int nrxd;               /* size of rx descriptor table */
 112         int rxbufsz;            /* size of rx buffers to post */
 113         int nrxbufpost;         /* # of rx buffers to post */
 114         int maxscb;             /* # of SCBs supported */
 115         int ampdunummpdu;       /* max number of mpdu in an ampdu */
 116         int maxpktcb;           /* max # of packet callbacks */
 117         int maxucodebss;        /* max # of BSS handled in ucode bcn/prb */
 118         int maxucodebss4;       /* max # of BSS handled in sw bcn/prb */
 119         int maxbss;             /* max # of bss info elements in scan list */
 120         int datahiwat;          /* data msg txq hiwat mark */
 121         int ampdudatahiwat;     /* AMPDU msg txq hiwat mark */
 122         int rxbnd;              /* max # of rx bufs to process before deferring to dpc */
 123         int txsbnd;             /* max # tx status to process in wlc_txstatus() */
 124         int memreserved;        /* memory reserved for BMAC's USB dma rx */
 125 };
 126
 127 struct brcms_rateset {
 128         uint count;             /* number of rates in rates[] */
 129         u8 rates[WLC_NUMRATES]; /* rates in 500kbps units w/hi bit set if basic */
 130         u8 htphy_membership;    /* HT PHY Membership */
 131         u8 mcs[MCSSET_LEN];     /* supported mcs index bit map */
 132 };
 133
 134 struct rsn_parms {
 135         u8 flags;               /* misc booleans (e.g., supported) */
 136         u8 multicast;   /* multicast cipher */
 137         u8 ucount;              /* count of unicast ciphers */
 138         u8 unicast[4];  /* unicast ciphers */
 139         u8 acount;              /* count of auth modes */
 140         u8 auth[4];             /* Authentication modes */
 141         u8 PAD[4];              /* padding for future growth */
 142 };
 143
 144 /*
 145  * 32 SSID chars, max of 4 chars for each SSID char "\xFF", plus NULL.
 146  */
 147 #define SSID_FMT_BUF_LEN        ((4 * IEEE80211_MAX_SSID_LEN) + 1)
 148
 149 #define RSN_FLAGS_SUPPORTED             0x1     /* Flag for rsn_params */
 150 #define RSN_FLAGS_PREAUTH               0x2     /* Flag for WPA2 rsn_params */
 151
 152 /* All the HT-specific default advertised capabilities (including AMPDU)
 153  * should be grouped here at one place
 154  */
 155 #define AMPDU_DEF_MPDU_DENSITY  6       /* default mpdu density (110 ==> 4us) */
 156
 157 /* defaults for the HT (MIMO) bss */
 158 #define HT_CAP  (IEEE80211_HT_CAP_SM_PS |\
 159         IEEE80211_HT_CAP_SUP_WIDTH_20_40 | IEEE80211_HT_CAP_GRN_FLD |\
 160         IEEE80211_HT_CAP_MAX_AMSDU | IEEE80211_HT_CAP_DSSSCCK40)
 161
 162 /* wlc internal bss_info */
 163 struct brcms_bss_info {
 164         u8 BSSID[ETH_ALEN];     /* network BSSID */
 165         u16 flags;              /* flags for internal attributes */
 166         u8 SSID_len;            /* the length of SSID */
 167         u8 SSID[32];            /* SSID string */
 168         s16 RSSI;               /* receive signal strength (in dBm) */
 169         s16 SNR;                /* receive signal SNR in dB */
 170         u16 beacon_period;      /* units are Kusec */
 171         u16 atim_window;        /* units are Kusec */
 172         chanspec_t chanspec;    /* Channel num, bw, ctrl_sb and band */
 173         s8 infra;               /* 0=IBSS, 1=infrastructure, 2=unknown */
 174         wlc_rateset_t rateset;  /* supported rates */
 175         u8 dtim_period; /* DTIM period */
 176         s8 phy_noise;           /* noise right after tx (in dBm) */
 177         u16 capability; /* Capability information */
 178         u8 wme_qosinfo; /* QoS Info from WME IE; valid if WLC_BSS_WME flag set */
 179         struct rsn_parms wpa;
 180         struct rsn_parms wpa2;
 181         u16 qbss_load_aac;      /* qbss load available admission capacity */
 182         /* qbss_load_chan_free <- (0xff - channel_utilization of qbss_load_ie_t) */
 183         u8 qbss_load_chan_free; /* indicates how free the channel is */
 184         u8 mcipher;             /* multicast cipher */
 185         u8 wpacfg;              /* wpa config index */
 186 };
 187
 188 /* brcms_c_ioctl error codes */
 189 #define WLC_ENOIOCTL    1       /* No such Ioctl */
 190 #define WLC_EINVAL      2       /* Invalid value */
 191 #define WLC_ETOOSMALL   3       /* Value too small */
 192 #define WLC_ETOOBIG     4       /* Value too big */
 193 #define WLC_ERANGE      5       /* Out of range */
 194 #define WLC_EDOWN       6       /* Down */
 195 #define WLC_EUP         7       /* Up */
 196 #define WLC_ENOMEM      8       /* No Memory */
 197 #define WLC_EBUSY       9       /* Busy */
 198
 199 /* IOVar flags for common error checks */
 200 #define IOVF_MFG        (1<<3)  /* flag for mfgtest iovars */
 201 #define IOVF_WHL        (1<<4)  /* value must be whole (0-max) */
 202 #define IOVF_NTRL       (1<<5)  /* value must be natural (1-max) */
 203
 204 #define IOVF_SET_UP     (1<<6)  /* set requires driver be up */
 205 #define IOVF_SET_DOWN   (1<<7)  /* set requires driver be down */
 206 #define IOVF_SET_CLK    (1<<8)  /* set requires core clock */
 207 #define IOVF_SET_BAND   (1<<9)  /* set requires fixed band */
 208
 209 #define IOVF_GET_UP     (1<<10) /* get requires driver be up */
 210 #define IOVF_GET_DOWN   (1<<11) /* get requires driver be down */
 211 #define IOVF_GET_CLK    (1<<12) /* get requires core clock */
 212 #define IOVF_GET_BAND   (1<<13) /* get requires fixed band */
 213 #define IOVF_OPEN_ALLOW (1<<14) /* set allowed iovar for opensrc */
 214
 215 /* watchdog down and dump callback function proto's */
 216 typedef int (*watchdog_fn_t) (void *handle);
 217 typedef int (*down_fn_t) (void *handle);
 218 typedef int (*dump_fn_t) (void *handle, struct brcmu_strbuf *b);
 219
 220 /* IOVar handler
 221  *
 222  * handle - a pointer value registered with the function
 223  * vi - iovar_info that was looked up
 224  * actionid - action ID, calculated by IOV_GVAL() and IOV_SVAL() based on varid.
 225  * name - the actual iovar name
 226  * params/plen - parameters and length for a get, input only.
 227  * arg/len - buffer and length for value to be set or retrieved, input or output.
 228  * vsize - value size, valid for integer type only.
 229  * wlcif - interface context (brcms_c_if pointer)
 230  *
 231  * All pointers may point into the same buffer.
 232  */
 233 typedef int (*iovar_fn_t) (void *handle, const struct brcmu_iovar *vi,
 234                            u32 actionid, const char *name, void *params,
 235                            uint plen, void *arg, int alen, int vsize,
 236                            struct brcms_c_if *wlcif);
 237
 238 #define MAC80211_PROMISC_BCNS   (1 << 0)
 239 #define MAC80211_SCAN           (1 << 1)
 240
 241 /*
 242  * Public portion of "common" os-independent state structure.
 243  * The wlc handle points at this.
 244  */
 245 struct brcms_pub {
 246         void *wlc;
 247
 248         struct ieee80211_hw *ieee_hw;
 249         struct scb *global_scb;
 250         struct scb_ampdu *global_ampdu;
 251         uint mac80211_state;
 252         uint unit;              /* device instance number */
 253         uint corerev;           /* core revision */
 254         struct si_pub *sih;     /* SI handle (cookie for siutils calls) */
 255         char *vars;             /* "environment" name=value */
 256         bool up;                /* interface up and running */
 257         bool hw_off;            /* HW is off */
 258         /* tunables: ntxd, nrxd, maxscb, etc. */
 259         struct brcms_tunables *tunables;
 260         bool hw_up;             /* one time hw up/down(from boot or hibernation) */
 261         bool _piomode;          /* true if pio mode *//* BMAC_NOTE: NEED In both */
 262         uint _nbands;           /* # bands supported */
 263         uint now;               /* # elapsed seconds */
 264
 265         bool promisc;           /* promiscuous destination address */
 266         bool delayed_down;      /* down delayed */
 267         bool _ap;               /* AP mode enabled */
 268         bool _apsta;            /* simultaneous AP/STA mode enabled */
 269         bool _assoc_recreate;   /* association recreation on up transitions */
 270         int _wme;               /* WME QoS mode */
 271         u8 _mbss;               /* MBSS mode on */
 272         bool allmulti;          /* enable all multicasts */
 273         bool associated;        /* true:part of [I]BSS, false: not */
 274         /* (union of stas_associated, aps_associated) */
 275         bool phytest_on;        /* whether a PHY test is running */
 276         bool bf_preempt_4306;   /* True to enable 'darwin' mode */
 277         bool _ampdu;            /* ampdu enabled or not */
 278         bool _cac;              /* 802.11e CAC enabled */
 279         u8 _n_enab;             /* bitmap of 11N + HT support */
 280         bool _n_reqd;           /* N support required for clients */
 281
 282         s8 _coex;               /* 20/40 MHz BSS Management AUTO, ENAB, DISABLE */
 283         bool _priofc;           /* Priority-based flowcontrol */
 284
 285         u8 cur_etheraddr[ETH_ALEN];     /* our local ethernet address */
 286
 287         u8 *multicast;  /* ptr to list of multicast addresses */
 288         uint nmulticast;        /* # enabled multicast addresses */
 289
 290         u32 wlfeatureflag;      /* Flags to control sw features from registry */
 291         int psq_pkts_total;     /* total num of ps pkts */
 292
 293         u16 txmaxpkts;  /* max number of large pkts allowed to be pending */
 294
 295         /* s/w decryption counters */
 296         u32 swdecrypt;  /* s/w decrypt attempts */
 297
 298         int bcmerror;           /* last bcm error */
 299
 300         mbool radio_disabled;   /* bit vector for radio disabled reasons */
 301         bool radio_active;      /* radio on/off state */
 302         u16 roam_time_thresh;   /* Max. # secs. of not hearing beacons
 303                                          * before roaming.
 304                                          */
 305         bool align_wd_tbtt;     /* Align watchdog with tbtt indication
 306                                  * handling. This flag is cleared by default
 307                                  * and is set by per port code explicitly and
 308                                  * you need to make sure the OSL_SYSUPTIME()
 309                                  * is implemented properly in osl of that port
 310                                  * when it enables this Power Save feature.
 311                                  */
 312
 313         u16 boardrev;   /* version # of particular board */
 314         u8 sromrev;             /* version # of the srom */
 315         char srom_ccode[WLC_CNTRY_BUF_SZ];      /* Country Code in SROM */
 316         u32 boardflags; /* Board specific flags from srom */
 317         u32 boardflags2;        /* More board flags if sromrev >= 4 */
 318         bool tempsense_disable; /* disable periodic tempsense check */
 319         bool phy_11ncapable;    /* the PHY/HW is capable of 802.11N */
 320         bool _ampdumac;         /* mac assist ampdu enabled or not */
 321
 322         struct wl_cnt *_cnt;    /* low-level counters in driver */
 323 };
 324
 325 /* wl_monitor rx status per packet */
 326 struct wl_rxsts {
 327         uint pkterror;          /* error flags per pkt */
 328         uint phytype;           /* 802.11 A/B/G ... */
 329         uint channel;           /* channel */
 330         uint datarate;          /* rate in 500kbps */
 331         uint antenna;           /* antenna pkts received on */
 332         uint pktlength;         /* pkt length minus bcm phy hdr */
 333         u32 mactime;            /* time stamp from mac, count per 1us */
 334         uint sq;                /* signal quality */
 335         s32 signal;             /* in dbm */
 336         s32 noise;              /* in dbm */
 337         uint preamble;          /* Unknown, short, long */
 338         uint encoding;          /* Unknown, CCK, PBCC, OFDM */
 339         uint nfrmtype;          /* special 802.11n frames(AMPDU, AMSDU) */
 340         struct brcms_if *wlif;  /* wl interface */
 341 };
 342
 343 /* status per error RX pkt */
 344 #define WL_RXS_CRC_ERROR                0x00000001      /* CRC Error in packet */
 345 #define WL_RXS_RUNT_ERROR               0x00000002      /* Runt packet */
 346 #define WL_RXS_ALIGN_ERROR              0x00000004      /* Misaligned packet */
 347 #define WL_RXS_OVERSIZE_ERROR           0x00000008      /* packet bigger than RX_LENGTH (usually 1518) */
 348 #define WL_RXS_WEP_ICV_ERROR            0x00000010      /* Integrity Check Value error */
 349 #define WL_RXS_WEP_ENCRYPTED            0x00000020      /* Encrypted with WEP */
 350 #define WL_RXS_PLCP_SHORT               0x00000040      /* Short PLCP error */
 351 #define WL_RXS_DECRYPT_ERR              0x00000080      /* Decryption error */
 352 #define WL_RXS_OTHER_ERR                0x80000000      /* Other errors */
 353
 354 /* phy type */
 355 #define WL_RXS_PHY_A                    0x00000000      /* A phy type */
 356 #define WL_RXS_PHY_B                    0x00000001      /* B phy type */
 357 #define WL_RXS_PHY_G                    0x00000002      /* G phy type */
 358 #define WL_RXS_PHY_N                    0x00000004      /* N phy type */
 359
 360 /* encoding */
 361 #define WL_RXS_ENCODING_CCK             0x00000000      /* CCK encoding */
 362 #define WL_RXS_ENCODING_OFDM            0x00000001      /* OFDM encoding */
 363
 364 /* preamble */
 365 #define WL_RXS_UNUSED_STUB              0x0     /* stub to match with wlc_ethereal.h */
 366 #define WL_RXS_PREAMBLE_SHORT           0x00000001      /* Short preamble */
 367 #define WL_RXS_PREAMBLE_LONG            0x00000002      /* Long preamble */
 368 #define WL_RXS_PREAMBLE_MIMO_MM         0x00000003      /* MIMO mixed mode preamble */
 369 #define WL_RXS_PREAMBLE_MIMO_GF         0x00000004      /* MIMO green field preamble */
 370
 371 #define WL_RXS_NFRM_AMPDU_FIRST         0x00000001      /* first MPDU in A-MPDU */
 372 #define WL_RXS_NFRM_AMPDU_SUB           0x00000002      /* subsequent MPDU(s) in A-MPDU */
 373 #define WL_RXS_NFRM_AMSDU_FIRST         0x00000004      /* first MSDU in A-MSDU */
 374 #define WL_RXS_NFRM_AMSDU_SUB           0x00000008      /* subsequent MSDU(s) in A-MSDU */
 375
 376 enum wlc_par_id {
 377         IOV_MPC = 1,
 378         IOV_RTSTHRESH,
 379         IOV_QTXPOWER,
 380         IOV_BCN_LI_BCN          /* Beacon listen interval in # of beacons */
 381 };
 382
 383 /***********************************************
 384  * Feature-related macros to optimize out code *
 385  * *********************************************
 386  */
 387
 388 /* AP Support (versus STA) */
 389 #define AP_ENAB(pub)    (0)
 390
 391 /* Macro to check if APSTA mode enabled */
 392 #define APSTA_ENAB(pub) (0)
 393
 394 /* Some useful combinations */
 395 #define STA_ONLY(pub)   (!AP_ENAB(pub))
 396 #define AP_ONLY(pub)    (AP_ENAB(pub) && !APSTA_ENAB(pub))
 397
 398 #define ENAB_1x1        0x01
 399 #define ENAB_2x2        0x02
 400 #define ENAB_3x3        0x04
 401 #define ENAB_4x4        0x08
 402 #define SUPPORT_11N     (ENAB_1x1|ENAB_2x2)
 403 #define SUPPORT_HT      (ENAB_1x1|ENAB_2x2|ENAB_3x3)
 404 /* WL11N Support */
 405 #if ((defined(NCONF) && (NCONF != 0)) || (defined(LCNCONF) && (LCNCONF != 0)) || \
 406         (defined(HTCONF) && (HTCONF != 0)) || (defined(SSLPNCONF) && (SSLPNCONF != 0)))
 407 #define N_ENAB(pub) ((pub)->_n_enab & SUPPORT_11N)
 408 #define N_REQD(pub) ((pub)->_n_reqd)
 409 #else
 410 #define N_ENAB(pub)     0
 411 #define N_REQD(pub)     0
 412 #endif
 413
 414 #if (defined(HTCONF) && (HTCONF != 0))
 415 #define HT_ENAB(pub) (((pub)->_n_enab & SUPPORT_HT) == SUPPORT_HT)
 416 #else
 417 #define HT_ENAB(pub) 0
 418 #endif
 419
 420 #define AMPDU_AGG_HOST  1
 421 #define AMPDU_ENAB(pub) ((pub)->_ampdu)
 422
 423 #define EDCF_ENAB(pub) (WME_ENAB(pub))
 424 #define QOS_ENAB(pub) (WME_ENAB(pub) || N_ENAB(pub))
 425
 426 #define MONITOR_ENAB(wlc)       ((wlc)->monitor)
 427
 428 #define PROMISC_ENAB(wlc)       ((wlc)->promisc)
 429
 430 #define WLC_PREC_COUNT          16      /* Max precedence level implemented */
 431
 432 /* pri is priority encoded in the packet. This maps the Packet priority to
 433  * enqueue precedence as defined in wlc_prec_map
 434  */
 435 extern const u8 wlc_prio2prec_map[];
 436 #define WLC_PRIO_TO_PREC(pri)   wlc_prio2prec_map[(pri) & 7]
 437
 438 /* This maps priority to one precedence higher - Used by PS-Poll response packets to
 439  * simulate enqueue-at-head operation, but still maintain the order on the queue
 440  */
 441 #define WLC_PRIO_TO_HI_PREC(pri)        min(WLC_PRIO_TO_PREC(pri) + 1, WLC_PREC_COUNT - 1)
 442
 443 extern const u8 wme_fifo2ac[];
 444 #define WME_PRIO2AC(prio)       wme_fifo2ac[prio2fifo[(prio)]]
 445
 446 /* Mask to describe all precedence levels */
 447 #define WLC_PREC_BMP_ALL                MAXBITVAL(WLC_PREC_COUNT)
 448
 449 /* Define a bitmap of precedences comprised by each AC */
 450 #define WLC_PREC_BMP_AC_BE      (NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_BE)) |     \
 451                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_BE)) |   \
 452                                 NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_EE)) |      \
 453                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_EE)))
 454 #define WLC_PREC_BMP_AC_BK      (NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_BK)) |     \
 455                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_BK)) |   \
 456                                 NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_NONE)) |    \
 457                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_NONE)))
 458 #define WLC_PREC_BMP_AC_VI      (NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_CL)) |     \
 459                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_CL)) |   \
 460                                 NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_VI)) |      \
 461                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_VI)))
 462 #define WLC_PREC_BMP_AC_VO      (NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_VO)) |     \
 463                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_VO)) |   \
 464                                 NBITVAL(WLC_PRIO_TO_PREC(PRIO_8021D_NC)) |      \
 465                                 NBITVAL(WLC_PRIO_TO_HI_PREC(PRIO_8021D_NC)))
 466
 467 /* WME Support */
 468 #define WME_ENAB(pub) ((pub)->_wme != OFF)
 469 #define WME_AUTO(wlc) ((wlc)->pub->_wme == AUTO)
 470
 471 #define WLC_USE_COREFLAGS       0xffffffff      /* invalid core flags, use the saved coreflags */
 472
 473
 474 /* network protection config */
 475 #define WLC_PROT_G_SPEC         1       /* SPEC g protection */
 476 #define WLC_PROT_G_OVR          2       /* SPEC g prot override */
 477 #define WLC_PROT_G_USER         3       /* gmode specified by user */
 478 #define WLC_PROT_OVERLAP        4       /* overlap */
 479 #define WLC_PROT_N_USER         10      /* nmode specified by user */
 480 #define WLC_PROT_N_CFG          11      /* n protection */
 481 #define WLC_PROT_N_CFG_OVR      12      /* n protection override */
 482 #define WLC_PROT_N_NONGF        13      /* non-GF protection */
 483 #define WLC_PROT_N_NONGF_OVR    14      /* non-GF protection override */
 484 #define WLC_PROT_N_PAM_OVR      15      /* n preamble override */
 485 #define WLC_PROT_N_OBSS         16      /* non-HT OBSS present */
 486
 487 /*
 488  * 54g modes (basic bits may still be overridden)
 489  *
 490  * GMODE_LEGACY_B                       Rateset: 1b, 2b, 5.5, 11
 491  *                                      Preamble: Long
 492  *                                      Shortslot: Off
 493  * GMODE_AUTO                           Rateset: 1b, 2b, 5.5b, 11b, 18, 24, 36, 54
 494  *                                      Extended Rateset: 6, 9, 12, 48
 495  *                                      Preamble: Long
 496  *                                      Shortslot: Auto
 497  * GMODE_ONLY                           Rateset: 1b, 2b, 5.5b, 11b, 18, 24b, 36, 54
 498  *                                      Extended Rateset: 6b, 9, 12b, 48
 499  *                                      Preamble: Short required
 500  *                                      Shortslot: Auto
 501  * GMODE_B_DEFERRED                     Rateset: 1b, 2b, 5.5b, 11b, 18, 24, 36, 54
 502  *                                      Extended Rateset: 6, 9, 12, 48
 503  *                                      Preamble: Long
 504  *                                      Shortslot: On
 505  * GMODE_PERFORMANCE                    Rateset: 1b, 2b, 5.5b, 6b, 9, 11b, 12b, 18, 24b, 36, 48, 54
 506  *                                      Preamble: Short required
 507  *                                      Shortslot: On and required
 508  * GMODE_LRS                            Rateset: 1b, 2b, 5.5b, 11b
 509  *                                      Extended Rateset: 6, 9, 12, 18, 24, 36, 48, 54
 510  *                                      Preamble: Long
 511  *                                      Shortslot: Auto
 512  */
 513 #define GMODE_LEGACY_B          0
 514 #define GMODE_AUTO              1
 515 #define GMODE_ONLY              2
 516 #define GMODE_B_DEFERRED        3
 517 #define GMODE_PERFORMANCE       4
 518 #define GMODE_LRS               5
 519 #define GMODE_MAX               6
 520
 521 /* values for PLCPHdr_override */
 522 #define WLC_PLCP_AUTO   -1
 523 #define WLC_PLCP_SHORT  0
 524 #define WLC_PLCP_LONG   1
 525
 526 /* values for g_protection_override and n_protection_override */
 527 #define WLC_PROTECTION_AUTO             -1
 528 #define WLC_PROTECTION_OFF              0
 529 #define WLC_PROTECTION_ON               1
 530 #define WLC_PROTECTION_MMHDR_ONLY       2
 531 #define WLC_PROTECTION_CTS_ONLY         3
 532
 533 /* values for g_protection_control and n_protection_control */
 534 #define WLC_PROTECTION_CTL_OFF          0
 535 #define WLC_PROTECTION_CTL_LOCAL        1
 536 #define WLC_PROTECTION_CTL_OVERLAP      2
 537
 538 /* values for n_protection */
 539 #define WLC_N_PROTECTION_OFF            0
 540 #define WLC_N_PROTECTION_OPTIONAL       1
 541 #define WLC_N_PROTECTION_20IN40         2
 542 #define WLC_N_PROTECTION_MIXEDMODE      3
 543
 544 /* values for band specific 40MHz capabilities */
 545 #define WLC_N_BW_20ALL                  0
 546 #define WLC_N_BW_40ALL                  1
 547 #define WLC_N_BW_20IN2G_40IN5G          2
 548
 549 /* bitflags for SGI support (sgi_rx iovar) */
 550 #define WLC_N_SGI_20                    0x01
 551 #define WLC_N_SGI_40                    0x02
 552
 553 /* defines used by the nrate iovar */
 554 #define NRATE_MCS_INUSE 0x00000080      /* MSC in use,indicates b0-6 holds an mcs */
 555 #define NRATE_RATE_MASK 0x0000007f      /* rate/mcs value */
 556 #define NRATE_STF_MASK  0x0000ff00      /* stf mode mask: siso, cdd, stbc, sdm */
 557 #define NRATE_STF_SHIFT 8       /* stf mode shift */
 558 #define NRATE_OVERRIDE  0x80000000      /* bit indicates override both rate & mode */
 559 #define NRATE_OVERRIDE_MCS_ONLY 0x40000000      /* bit indicate to override mcs only */
 560 #define NRATE_SGI_MASK  0x00800000      /* sgi mode */
 561 #define NRATE_SGI_SHIFT 23      /* sgi mode */
 562 #define NRATE_LDPC_CODING 0x00400000    /* bit indicates adv coding in use */
 563 #define NRATE_LDPC_SHIFT 22     /* ldpc shift */
 564
 565 #define NRATE_STF_SISO  0       /* stf mode SISO */
 566 #define NRATE_STF_CDD   1       /* stf mode CDD */
 567 #define NRATE_STF_STBC  2       /* stf mode STBC */
 568 #define NRATE_STF_SDM   3       /* stf mode SDM */
 569
 570 #define ANT_SELCFG_MAX          4       /* max number of antenna configurations */
 571
 572 #define HIGHEST_SINGLE_STREAM_MCS       7       /* MCS values greater than this enable multiple streams */
 573
 574 struct brcms_antselcfg {
 575         u8 ant_config[ANT_SELCFG_MAX];  /* antenna configuration */
 576         u8 num_antcfg;  /* number of available antenna configurations */
 577 };
 578
 579 /* common functions for every port */
 580 extern void *brcms_c_attach(struct brcms_info *wl, u16 vendor, u16 device,
 581                         uint unit, bool piomode, void *regsva, uint bustype,
 582                         void *btparam, uint *perr);
 583 extern uint brcms_c_detach(struct brcms_c_info *wlc);
 584 extern int brcms_c_up(struct brcms_c_info *wlc);
 585 extern uint brcms_c_down(struct brcms_c_info *wlc);
 586
 587 extern int brcms_c_set(struct brcms_c_info *wlc, int cmd, int arg);
 588 extern int brcms_c_get(struct brcms_c_info *wlc, int cmd, int *arg);
 589 extern bool brcms_c_chipmatch(u16 vendor, u16 device);
 590 extern void brcms_c_init(struct brcms_c_info *wlc);
 591 extern void brcms_c_reset(struct brcms_c_info *wlc);
 592
 593 extern void brcms_c_intrson(struct brcms_c_info *wlc);
 594 extern u32 brcms_c_intrsoff(struct brcms_c_info *wlc);
 595 extern void brcms_c_intrsrestore(struct brcms_c_info *wlc, u32 macintmask);
 596 extern bool brcms_c_intrsupd(struct brcms_c_info *wlc);
 597 extern bool brcms_c_isr(struct brcms_c_info *wlc, bool *wantdpc);
 598 extern bool brcms_c_dpc(struct brcms_c_info *wlc, bool bounded);
 599 extern bool brcms_c_sendpkt_mac80211(struct brcms_c_info *wlc,
 600                                      struct sk_buff *sdu,
 601                                      struct ieee80211_hw *hw);
 602 extern int brcms_c_ioctl(struct brcms_c_info *wlc, int cmd, void *arg, int len,
 603                          struct brcms_c_if *wlcif);
 604 extern bool brcms_c_aggregatable(struct brcms_c_info *wlc, u8 tid);
 605
 606 /* helper functions */
 607 extern void brcms_c_statsupd(struct brcms_c_info *wlc);
 608 extern void brcms_c_protection_upd(struct brcms_c_info *wlc, uint idx,
 609                                    int val);
 610 extern int brcms_c_get_header_len(void);
 611 extern void brcms_c_mac_bcn_promisc_change(struct brcms_c_info *wlc,
 612                                            bool promisc);
 613 extern void brcms_c_set_addrmatch(struct brcms_c_info *wlc,
 614                                   int match_reg_offset,
 615                                   const u8 *addr);
 616 extern void brcms_c_wme_setparams(struct brcms_c_info *wlc, u16 aci,
 617                               const struct ieee80211_tx_queue_params *arg,
 618                               bool suspend);
 619 extern struct brcms_pub *brcms_c_pub(void *wlc);
 620
 621 /* common functions for every port */
 622 extern void brcms_c_mhf(struct brcms_c_info *wlc, u8 idx, u16 mask, u16 val,
 623                     int bands);
 624 extern void brcms_c_rate_lookup_init(struct brcms_c_info *wlc,
 625                                      wlc_rateset_t *rateset);
 626 extern void brcms_default_rateset(struct brcms_c_info *wlc, wlc_rateset_t *rs);
 627
 628 extern void brcms_c_ampdu_flush(struct brcms_c_info *wlc,
 629                             struct ieee80211_sta *sta, u16 tid);
 630 extern void brcms_c_ampdu_tx_operational(struct brcms_c_info *wlc, u8 tid,
 631                                          u8 ba_wsize, uint max_rx_ampdu_bytes);
 632 extern int brcms_c_set_par(struct brcms_c_info *wlc, enum wlc_par_id par_id,
 633                            int val);
 634 extern int brcms_c_get_par(struct brcms_c_info *wlc, enum wlc_par_id par_id,
 635                            int *ret_int_ptr);
 636 extern char *getvar(char *vars, const char *name);
 637 extern int getintvar(char *vars, const char *name);
 638
 639 /* wlc_phy.c helper functions */
 640 extern void brcms_c_set_ps_ctrl(struct brcms_c_info *wlc);
 641 extern void brcms_c_mctrl(struct brcms_c_info *wlc, u32 mask, u32 val);
 642
 643 extern int brcms_c_module_register(struct brcms_pub *pub,
 644                                const char *name, void *hdl,
 645                                watchdog_fn_t watchdog_fn, down_fn_t down_fn);
 646 extern int brcms_c_module_unregister(struct brcms_pub *pub, const char *name,
 647                                  void *hdl);
 648 extern void brcms_c_suspend_mac_and_wait(struct brcms_c_info *wlc);
 649 extern void brcms_c_enable_mac(struct brcms_c_info *wlc);
 650 extern void brcms_c_associate_upd(struct brcms_c_info *wlc, bool state);
 651 extern void brcms_c_scan_start(struct brcms_c_info *wlc);
 652 extern void brcms_c_scan_stop(struct brcms_c_info *wlc);
 653 extern int brcms_c_get_curband(struct brcms_c_info *wlc);
 654 extern void brcms_c_wait_for_tx_completion(struct brcms_c_info *wlc,
 655                                            bool drop);
 656
 657 /* helper functions */
 658 extern bool brcms_c_check_radio_disabled(struct brcms_c_info *wlc);
 659 extern bool brcms_c_radio_monitor_stop(struct brcms_c_info *wlc);
 660
 661 #define MAXBANDS                2       /* Maximum #of bands */
 662 /* bandstate array indices */
 663 #define BAND_2G_INDEX           0       /* wlc->bandstate[x] index */
 664 #define BAND_5G_INDEX           1       /* wlc->bandstate[x] index */
 665
 666 #define BAND_2G_NAME            "2.4G"
 667 #define BAND_5G_NAME            "5G"
 668
 669 /* BMAC RPC: 7 u32 params: pkttotlen, fifo, commit, fid, txpktpend, pktflag, rpc_id */
 670 #define WLC_RPCTX_PARAMS                32
 671
 672 #endif                          /* _BRCM_PUB_H_ */