Pileus Git - ~andy/linux/blob - 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 BRCMS_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 BRCMS_10_MHZ    10      /* 10Mhz nphy channel bandwidth */
  40 #define BRCMS_20_MHZ    20      /* 20Mhz nphy channel bandwidth */
  41 #define BRCMS_40_MHZ    40      /* 40Mhz nphy channel bandwidth */
  42
  43 #define CHSPEC_WLC_BW(chanspec) (CHSPEC_IS40(chanspec) ? BRCMS_40_MHZ : \
  44                                  CHSPEC_IS20(chanspec) ? BRCMS_20_MHZ : \
  45                                                          BRCMS_10_MHZ)
  46
  47 #define BRCMS_RSSI_MINVAL       -200    /* Low value, e.g. for forcing roam */
  48 #define BRCMS_RSSI_NO_SIGNAL    -91     /* NDIS RSSI link quality cutoffs */
  49 #define BRCMS_RSSI_VERY_LOW     -80     /* Very low quality cutoffs */
  50 #define BRCMS_RSSI_LOW          -70     /* Low quality cutoffs */
  51 #define BRCMS_RSSI_GOOD         -68     /* Good quality cutoffs */
  52 #define BRCMS_RSSI_VERY_GOOD    -58     /* Very good quality cutoffs */
  53 #define BRCMS_RSSI_EXCELLENT    -57     /* Excellent quality cutoffs */
  54
  55 /* macro to perform PHY -> D11 PHY TYPE, currently 1:1 */
  56 #define BRCMS_PHYTYPE(_x) (_x)
  57
  58 #define MA_WINDOW_SZ            8       /* moving average window size */
  59
  60 #define BRCMS_SNR_INVALID               0       /* invalid SNR value */
  61
  62 /* a large TX Power as an init value to factor out of min() calculations,
  63  * keep low enough to fit in an s8, units are .25 dBm
  64  */
  65 #define BRCMS_TXPWR_MAX         (127)   /* ~32 dBm = 1,500 mW */
  66
  67 /* rate related definitions */
  68 #define BRCMS_RATE_FLAG 0x80    /* Flag to indicate it is a basic rate */
  69 #define BRCMS_RATE_MASK 0x7f    /* Rate value mask w/o basic rate flag */
  70
  71 /* legacy rx Antenna diversity for SISO rates */
  72 #define ANT_RX_DIV_FORCE_0      0       /* Use antenna 0 */
  73 #define ANT_RX_DIV_FORCE_1      1       /* Use antenna 1 */
  74 #define ANT_RX_DIV_START_1      2       /* Choose starting with 1 */
  75 #define ANT_RX_DIV_START_0      3       /* Choose starting with 0 */
  76 #define ANT_RX_DIV_ENABLE       3       /* APHY bbConfig Enable RX Diversity */
  77 /* default antdiv setting */
  78 #define ANT_RX_DIV_DEF          ANT_RX_DIV_START_0
  79
  80 /* legacy rx Antenna diversity for SISO rates */
  81 /* Tx on antenna 0, "legacy term Main" */
  82 #define ANT_TX_FORCE_0          0
  83 /* Tx on antenna 1, "legacy term Aux" */
  84 #define ANT_TX_FORCE_1          1
  85 /* Tx on phy's last good Rx antenna */
  86 #define ANT_TX_LAST_RX          3
  87 /* driver's default tx antenna setting */
  88 #define ANT_TX_DEF              3
  89
  90 /* use all available core for transmit */
  91 #define TXCORE_POLICY_ALL       0x1
  92
  93 /* Tx Chain values */
  94 /* def bitmap of txchain */
  95 #define TXCHAIN_DEF             0x1
  96 /* default bitmap of tx chains for nphy */
  97 #define TXCHAIN_DEF_NPHY        0x3
  98 /* default bitmap of tx chains for nphy */
  99 #define TXCHAIN_DEF_HTPHY       0x7
 100 /* def bitmap of rxchain */
 101 #define RXCHAIN_DEF             0x1
 102 /* default bitmap of rx chains for nphy */
 103 #define RXCHAIN_DEF_NPHY        0x3
 104 /* default bitmap of rx chains for nphy */
 105 #define RXCHAIN_DEF_HTPHY       0x7
 106 /* no antenna switch */
 107 #define ANTSWITCH_NONE          0
 108 /* antenna switch on 4321CB2, 2of3 */
 109 #define ANTSWITCH_TYPE_1        1
 110 /* antenna switch on 4321MPCI, 2of3 */
 111 #define ANTSWITCH_TYPE_2        2
 112 /* antenna switch on 4322, 2of3 */
 113 #define ANTSWITCH_TYPE_3        3
 114
 115 #define RXBUFSZ         PKTBUFSZ
 116 /* aid bitmap size in bytes */
 117 #define AIDMAPSZ        (roundup(MAXSCB, NBBY)/NBBY)
 118
 119 #define MAX_STREAMS_SUPPORTED   4       /* max number of streams supported */
 120
 121 #define WL_SPURAVOID_OFF        0
 122 #define WL_SPURAVOID_ON1        1
 123 #define WL_SPURAVOID_ON2        2
 124
 125 struct brcms_tunables {
 126         int ntxd;       /* size of tx descriptor table */
 127         int nrxd;       /* size of rx descriptor table */
 128         int rxbufsz;    /* size of rx buffers to post */
 129         int nrxbufpost; /* # of rx buffers to post */
 130         int maxscb;     /* # of SCBs supported */
 131         int ampdunummpdu;       /* max number of mpdu in an ampdu */
 132         int maxpktcb;   /* max # of packet callbacks */
 133         int maxucodebss;/* max # of BSS handled in ucode bcn/prb */
 134         int maxucodebss4;       /* max # of BSS handled in sw bcn/prb */
 135         int maxbss;     /* max # of bss info elements in scan list */
 136         int datahiwat;  /* data msg txq hiwat mark */
 137         int ampdudatahiwat;     /* AMPDU msg txq hiwat mark */
 138         int rxbnd;      /* max # rx bufs to process before deferring to dpc */
 139         int txsbnd;     /* max # tx status to process in wlc_txstatus() */
 140         int memreserved;/* memory reserved for BMAC's USB dma rx */
 141 };
 142
 143 struct brcms_c_rateset {
 144         uint count;             /* number of rates in rates[] */
 145          /* rates in 500kbps units w/hi bit set if basic */
 146         u8 rates[BRCMS_NUMRATES];
 147         u8 htphy_membership;    /* HT PHY Membership */
 148         u8 mcs[MCSSET_LEN];     /* supported mcs index bit map */
 149 };
 150
 151 struct rsn_parms {
 152         u8 flags;               /* misc booleans (e.g., supported) */
 153         u8 multicast;   /* multicast cipher */
 154         u8 ucount;              /* count of unicast ciphers */
 155         u8 unicast[4];  /* unicast ciphers */
 156         u8 acount;              /* count of auth modes */
 157         u8 auth[4];             /* Authentication modes */
 158         u8 PAD[4];              /* padding for future growth */
 159 };
 160
 161 /*
 162  * 32 SSID chars, max of 4 chars for each SSID char "\xFF", plus NULL.
 163  */
 164 #define SSID_FMT_BUF_LEN        ((4 * IEEE80211_MAX_SSID_LEN) + 1)
 165
 166 #define RSN_FLAGS_SUPPORTED             0x1     /* Flag for rsn_params */
 167 #define RSN_FLAGS_PREAUTH               0x2     /* Flag for WPA2 rsn_params */
 168
 169 /* All the HT-specific default advertised capabilities (including AMPDU)
 170  * should be grouped here at one place
 171  */
 172 #define AMPDU_DEF_MPDU_DENSITY  6       /* default mpdu density (110 ==> 4us) */
 173
 174 /* defaults for the HT (MIMO) bss */
 175 #define HT_CAP  (IEEE80211_HT_CAP_SM_PS |\
 176         IEEE80211_HT_CAP_SUP_WIDTH_20_40 | IEEE80211_HT_CAP_GRN_FLD |\
 177         IEEE80211_HT_CAP_MAX_AMSDU | IEEE80211_HT_CAP_DSSSCCK40)
 178
 179 /* wlc internal bss_info */
 180 struct brcms_bss_info {
 181         u8 BSSID[ETH_ALEN];     /* network BSSID */
 182         u16 flags;              /* flags for internal attributes */
 183         u8 SSID_len;            /* the length of SSID */
 184         u8 SSID[32];            /* SSID string */
 185         s16 RSSI;               /* receive signal strength (in dBm) */
 186         s16 SNR;                /* receive signal SNR in dB */
 187         u16 beacon_period;      /* units are Kusec */
 188         u16 atim_window;        /* units are Kusec */
 189         u16 chanspec;   /* Channel num, bw, ctrl_sb and band */
 190         s8 infra;               /* 0=IBSS, 1=infrastructure, 2=unknown */
 191         struct brcms_c_rateset rateset; /* supported rates */
 192         u8 dtim_period; /* DTIM period */
 193         s8 phy_noise;           /* noise right after tx (in dBm) */
 194         u16 capability; /* Capability information */
 195         u8 wme_qosinfo; /* QoS Info from WME IE; valid if BSS_WME flag set */
 196         struct rsn_parms wpa;
 197         struct rsn_parms wpa2;
 198         u16 qbss_load_aac;      /* qbss load available admission capacity */
 199         /* qbss_load_chan_free <- (0xff - chan utilization of qbss_load_ie_t) */
 200         u8 qbss_load_chan_free; /* indicates how free the channel is */
 201         u8 mcipher;             /* multicast cipher */
 202         u8 wpacfg;              /* wpa config index */
 203 };
 204
 205 /* IOVar flags for common error checks */
 206 #define IOVF_MFG        (1<<3)  /* flag for mfgtest iovars */
 207 #define IOVF_WHL        (1<<4)  /* value must be whole (0-max) */
 208 #define IOVF_NTRL       (1<<5)  /* value must be natural (1-max) */
 209
 210 #define IOVF_SET_UP     (1<<6)  /* set requires driver be up */
 211 #define IOVF_SET_DOWN   (1<<7)  /* set requires driver be down */
 212 #define IOVF_SET_CLK    (1<<8)  /* set requires core clock */
 213 #define IOVF_SET_BAND   (1<<9)  /* set requires fixed band */
 214
 215 #define IOVF_GET_UP     (1<<10) /* get requires driver be up */
 216 #define IOVF_GET_DOWN   (1<<11) /* get requires driver be down */
 217 #define IOVF_GET_CLK    (1<<12) /* get requires core clock */
 218 #define IOVF_GET_BAND   (1<<13) /* get requires fixed band */
 219 #define IOVF_OPEN_ALLOW (1<<14) /* set allowed iovar for opensrc */
 220
 221 #define MAC80211_PROMISC_BCNS   (1 << 0)
 222 #define MAC80211_SCAN           (1 << 1)
 223
 224 /*
 225  * Public portion of common driver state structure.
 226  * The wlc handle points at this.
 227  */
 228 struct brcms_pub {
 229         struct brcms_c_info *wlc;
 230         struct ieee80211_hw *ieee_hw;
 231         struct scb *global_scb;
 232         struct scb_ampdu *global_ampdu;
 233         uint mac80211_state;
 234         uint unit;              /* device instance number */
 235         uint corerev;           /* core revision */
 236         struct si_pub *sih;     /* SI handle (cookie for siutils calls) */
 237         char *vars;             /* "environment" name=value */
 238         bool up;                /* interface up and running */
 239         bool hw_off;            /* HW is off */
 240         /* tunables: ntxd, nrxd, maxscb, etc. */
 241         struct brcms_tunables *tunables;
 242         bool hw_up;             /* one time hw up/down */
 243         bool _piomode;          /* true if pio mode */
 244         uint _nbands;           /* # bands supported */
 245         uint now;               /* # elapsed seconds */
 246
 247         bool promisc;           /* promiscuous destination address */
 248         bool delayed_down;      /* down delayed */
 249         bool _ap;               /* AP mode enabled */
 250         bool _apsta;            /* simultaneous AP/STA mode enabled */
 251         bool _assoc_recreate;   /* association recreation on up transitions */
 252         int _wme;               /* WME QoS mode */
 253         u8 _mbss;               /* MBSS mode on */
 254         bool allmulti;          /* enable all multicasts */
 255         bool associated;        /* true:part of [I]BSS, false: not */
 256         /* (union of stas_associated, aps_associated) */
 257         bool phytest_on;        /* whether a PHY test is running */
 258         bool bf_preempt_4306;   /* True to enable 'darwin' mode */
 259         bool _ampdu;            /* ampdu enabled or not */
 260         bool _cac;              /* 802.11e CAC enabled */
 261         u8 _n_enab;             /* bitmap of 11N + HT support */
 262         bool _n_reqd;           /* N support required for clients */
 263
 264         s8 _coex;       /* 20/40 MHz BSS Management AUTO, ENAB, DISABLE */
 265         bool _priofc;           /* Priority-based flowcontrol */
 266
 267         u8 cur_etheraddr[ETH_ALEN];     /* our local ethernet address */
 268
 269         u8 *multicast;  /* ptr to list of multicast addresses */
 270         uint nmulticast;        /* # enabled multicast addresses */
 271
 272         u32 wlfeatureflag;      /* Flags to control sw features from registry */
 273         int psq_pkts_total;     /* total num of ps pkts */
 274
 275         u16 txmaxpkts;  /* max number of large pkts allowed to be pending */
 276
 277         /* s/w decryption counters */
 278         u32 swdecrypt;  /* s/w decrypt attempts */
 279
 280         int bcmerror;           /* last bcm error */
 281
 282         u32 radio_disabled;     /* bit vector for radio disabled reasons */
 283         bool radio_active;      /* radio on/off state */
 284         u16 roam_time_thresh;   /* Max. # secs. of not hearing beacons
 285                                          * before roaming.
 286                                          */
 287         bool align_wd_tbtt;     /* Align watchdog with tbtt indication
 288                                  * handling. This flag is cleared by default
 289                                  * and is set by per port code explicitly and
 290                                  * you need to make sure the OSL_SYSUPTIME()
 291                                  * is implemented properly in osl of that port
 292                                  * when it enables this Power Save feature.
 293                                  */
 294
 295         u16 boardrev;   /* version # of particular board */
 296         u8 sromrev;             /* version # of the srom */
 297         char srom_ccode[BRCM_CNTRY_BUF_SZ];     /* Country Code in SROM */
 298         u32 boardflags; /* Board specific flags from srom */
 299         u32 boardflags2;        /* More board flags if sromrev >= 4 */
 300         bool tempsense_disable; /* disable periodic tempsense check */
 301         bool phy_11ncapable;    /* the PHY/HW is capable of 802.11N */
 302         bool _ampdumac;         /* mac assist ampdu enabled or not */
 303
 304         struct wl_cnt *_cnt;    /* low-level counters in driver */
 305 };
 306
 307 /* wl_monitor rx status per packet */
 308 struct wl_rxsts {
 309         uint pkterror;          /* error flags per pkt */
 310         uint phytype;           /* 802.11 A/B/G ... */
 311         uint channel;           /* channel */
 312         uint datarate;          /* rate in 500kbps */
 313         uint antenna;           /* antenna pkts received on */
 314         uint pktlength;         /* pkt length minus bcm phy hdr */
 315         u32 mactime;            /* time stamp from mac, count per 1us */
 316         uint sq;                /* signal quality */
 317         s32 signal;             /* in dbm */
 318         s32 noise;              /* in dbm */
 319         uint preamble;          /* Unknown, short, long */
 320         uint encoding;          /* Unknown, CCK, PBCC, OFDM */
 321         uint nfrmtype;          /* special 802.11n frames(AMPDU, AMSDU) */
 322         struct brcms_if *wlif;  /* wl interface */
 323 };
 324
 325 enum wlc_par_id {
 326         IOV_MPC = 1,
 327         IOV_RTSTHRESH,
 328         IOV_QTXPOWER,
 329         IOV_BCN_LI_BCN          /* Beacon listen interval in # of beacons */
 330 };
 331
 332 /***********************************************
 333  * Feature-related macros to optimize out code *
 334  * *********************************************
 335  */
 336
 337 /* AP Support (versus STA) */
 338 #define AP_ENAB(pub)    (0)
 339
 340 /* Macro to check if APSTA mode enabled */
 341 #define APSTA_ENAB(pub) (0)
 342
 343 /* Some useful combinations */
 344 #define STA_ONLY(pub)   (!AP_ENAB(pub))
 345 #define AP_ONLY(pub)    (AP_ENAB(pub) && !APSTA_ENAB(pub))
 346
 347 #define ENAB_1x1        0x01
 348 #define ENAB_2x2        0x02
 349 #define ENAB_3x3        0x04
 350 #define ENAB_4x4        0x08
 351 #define SUPPORT_11N     (ENAB_1x1|ENAB_2x2)
 352 #define SUPPORT_HT      (ENAB_1x1|ENAB_2x2|ENAB_3x3)
 353 /* WL11N Support */
 354 #define N_ENAB(pub) ((pub)->_n_enab & SUPPORT_11N)
 355 #define N_REQD(pub) ((pub)->_n_reqd)
 356
 357 #define HT_ENAB(pub) 0
 358
 359 #define AMPDU_AGG_HOST  1
 360 #define AMPDU_ENAB(pub) ((pub)->_ampdu)
 361
 362 #define EDCF_ENAB(pub) (WME_ENAB(pub))
 363 #define QOS_ENAB(pub) (WME_ENAB(pub) || N_ENAB(pub))
 364
 365 #define MONITOR_ENAB(wlc)       ((wlc)->monitor)
 366
 367 #define PROMISC_ENAB(wlc)       ((wlc)->promisc)
 368
 369 #define BRCMS_PREC_COUNT        16      /* Max precedence level implemented */
 370
 371 /* pri is priority encoded in the packet. This maps the Packet priority to
 372  * enqueue precedence as defined in wlc_prec_map
 373  */
 374 extern const u8 wlc_prio2prec_map[];
 375 #define BRCMS_PRIO_TO_PREC(pri) wlc_prio2prec_map[(pri) & 7]
 376
 377 /*
 378  * This maps priority to one precedence higher - Used by PS-Poll response
 379  * packets to simulate enqueue-at-head operation, but still maintain the
 380  * order on the queue
 381  */
 382 #define BRCMS_PRIO_TO_HI_PREC(pri)      min(BRCMS_PRIO_TO_PREC(pri) + 1,\
 383                                             BRCMS_PREC_COUNT - 1)
 384
 385 extern const u8 wme_fifo2ac[];
 386 #define WME_PRIO2AC(prio)       wme_fifo2ac[prio2fifo[(prio)]]
 387
 388 /* Mask to describe all precedence levels */
 389 #define BRCMS_PREC_BMP_ALL              MAXBITVAL(BRCMS_PREC_COUNT)
 390
 391 /* Define a bitmap of precedences comprised by each AC */
 392 #define BRCMS_PREC_BMP_AC_BE    (NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_BE)) | \
 393                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_BE)) | \
 394                         NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_EE)) |    \
 395                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_EE)))
 396 #define BRCMS_PREC_BMP_AC_BK    (NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_BK)) | \
 397                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_BK)) | \
 398                         NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_NONE)) |  \
 399                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_NONE)))
 400 #define BRCMS_PREC_BMP_AC_VI    (NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_CL)) | \
 401                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_CL)) | \
 402                         NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_VI)) |    \
 403                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_VI)))
 404 #define BRCMS_PREC_BMP_AC_VO    (NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_VO)) | \
 405                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_VO)) | \
 406                         NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_NC)) |    \
 407                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_NC)))
 408
 409 /* WME Support */
 410 #define WME_ENAB(pub) ((pub)->_wme != OFF)
 411 #define WME_AUTO(wlc) ((wlc)->pub->_wme == AUTO)
 412
 413 /* invalid core flags, use the saved coreflags */
 414 #define BRCMS_USE_COREFLAGS     0xffffffff
 415
 416
 417 /* network protection config */
 418 #define BRCMS_PROT_G_SPEC               1       /* SPEC g protection */
 419 #define BRCMS_PROT_G_OVR                2       /* SPEC g prot override */
 420 #define BRCMS_PROT_G_USER               3       /* gmode specified by user */
 421 #define BRCMS_PROT_OVERLAP      4       /* overlap */
 422 #define BRCMS_PROT_N_USER               10      /* nmode specified by user */
 423 #define BRCMS_PROT_N_CFG                11      /* n protection */
 424 #define BRCMS_PROT_N_CFG_OVR    12      /* n protection override */
 425 #define BRCMS_PROT_N_NONGF      13      /* non-GF protection */
 426 #define BRCMS_PROT_N_NONGF_OVR  14      /* non-GF protection override */
 427 #define BRCMS_PROT_N_PAM_OVR    15      /* n preamble override */
 428 #define BRCMS_PROT_N_OBSS               16      /* non-HT OBSS present */
 429
 430 /*
 431  * 54g modes (basic bits may still be overridden)
 432  *
 433  * GMODE_LEGACY_B
 434  *      Rateset: 1b, 2b, 5.5, 11
 435  *      Preamble: Long
 436  *      Shortslot: Off
 437  * GMODE_AUTO
 438  *      Rateset: 1b, 2b, 5.5b, 11b, 18, 24, 36, 54
 439  *      Extended Rateset: 6, 9, 12, 48
 440  *      Preamble: Long
 441  *      Shortslot: Auto
 442  * GMODE_ONLY
 443  *      Rateset: 1b, 2b, 5.5b, 11b, 18, 24b, 36, 54
 444  *      Extended Rateset: 6b, 9, 12b, 48
 445  *      Preamble: Short required
 446  *      Shortslot: Auto
 447  * GMODE_B_DEFERRED
 448  *      Rateset: 1b, 2b, 5.5b, 11b, 18, 24, 36, 54
 449  *      Extended Rateset: 6, 9, 12, 48
 450  *      Preamble: Long
 451  *      Shortslot: On
 452  * GMODE_PERFORMANCE
 453  *      Rateset: 1b, 2b, 5.5b, 6b, 9, 11b, 12b, 18, 24b, 36, 48, 54
 454  *      Preamble: Short required
 455  *      Shortslot: On and required
 456  * GMODE_LRS
 457  *      Rateset: 1b, 2b, 5.5b, 11b
 458  *      Extended Rateset: 6, 9, 12, 18, 24, 36, 48, 54
 459  *      Preamble: Long
 460  *      Shortslot: Auto
 461  */
 462 #define GMODE_LEGACY_B          0
 463 #define GMODE_AUTO              1
 464 #define GMODE_ONLY              2
 465 #define GMODE_B_DEFERRED        3
 466 #define GMODE_PERFORMANCE       4
 467 #define GMODE_LRS               5
 468 #define GMODE_MAX               6
 469
 470 /* values for PLCPHdr_override */
 471 #define BRCMS_PLCP_AUTO -1
 472 #define BRCMS_PLCP_SHORT        0
 473 #define BRCMS_PLCP_LONG 1
 474
 475 /* values for g_protection_override and n_protection_override */
 476 #define BRCMS_PROTECTION_AUTO           -1
 477 #define BRCMS_PROTECTION_OFF            0
 478 #define BRCMS_PROTECTION_ON             1
 479 #define BRCMS_PROTECTION_MMHDR_ONLY     2
 480 #define BRCMS_PROTECTION_CTS_ONLY               3
 481
 482 /* values for g_protection_control and n_protection_control */
 483 #define BRCMS_PROTECTION_CTL_OFF                0
 484 #define BRCMS_PROTECTION_CTL_LOCAL      1
 485 #define BRCMS_PROTECTION_CTL_OVERLAP    2
 486
 487 /* values for n_protection */
 488 #define BRCMS_N_PROTECTION_OFF          0
 489 #define BRCMS_N_PROTECTION_OPTIONAL     1
 490 #define BRCMS_N_PROTECTION_20IN40               2
 491 #define BRCMS_N_PROTECTION_MIXEDMODE    3
 492
 493 /* values for band specific 40MHz capabilities */
 494 #define BRCMS_N_BW_20ALL                        0
 495 #define BRCMS_N_BW_40ALL                        1
 496 #define BRCMS_N_BW_20IN2G_40IN5G                2
 497
 498 /* bitflags for SGI support (sgi_rx iovar) */
 499 #define BRCMS_N_SGI_20                  0x01
 500 #define BRCMS_N_SGI_40                  0x02
 501
 502 /* defines used by the nrate iovar */
 503 /* MSC in use,indicates b0-6 holds an mcs */
 504 #define NRATE_MCS_INUSE 0x00000080
 505 /* rate/mcs value */
 506 #define NRATE_RATE_MASK 0x0000007f
 507 /* stf mode mask: siso, cdd, stbc, sdm */
 508 #define NRATE_STF_MASK  0x0000ff00
 509 /* stf mode shift */
 510 #define NRATE_STF_SHIFT 8
 511 /* bit indicates override both rate & mode */
 512 #define NRATE_OVERRIDE  0x80000000
 513 /* bit indicate to override mcs only */
 514 #define NRATE_OVERRIDE_MCS_ONLY 0x40000000
 515 #define NRATE_SGI_MASK  0x00800000      /* sgi mode */
 516 #define NRATE_SGI_SHIFT 23      /* sgi mode */
 517 #define NRATE_LDPC_CODING 0x00400000    /* bit indicates adv coding in use */
 518 #define NRATE_LDPC_SHIFT 22     /* ldpc shift */
 519
 520 #define NRATE_STF_SISO  0       /* stf mode SISO */
 521 #define NRATE_STF_CDD   1       /* stf mode CDD */
 522 #define NRATE_STF_STBC  2       /* stf mode STBC */
 523 #define NRATE_STF_SDM   3       /* stf mode SDM */
 524
 525 /* max number of antenna configurations */
 526 #define ANT_SELCFG_MAX          4
 527
 528 /* MCS values greater than this enable multiple streams */
 529 #define HIGHEST_SINGLE_STREAM_MCS       7
 530
 531 struct brcms_antselcfg {
 532         u8 ant_config[ANT_SELCFG_MAX];  /* antenna configuration */
 533         u8 num_antcfg;  /* number of available antenna configurations */
 534 };
 535
 536 /* common functions for every port */
 537 struct brcms_c_info *
 538 brcms_c_attach(struct brcms_info *wl, u16 vendor, u16 device, uint unit,
 539                bool piomode, void *regsva, struct pci_dev *btparam, uint *perr);
 540 extern uint brcms_c_detach(struct brcms_c_info *wlc);
 541 extern int brcms_c_up(struct brcms_c_info *wlc);
 542 extern uint brcms_c_down(struct brcms_c_info *wlc);
 543
 544 extern int brcms_c_set(struct brcms_c_info *wlc, int cmd, int arg);
 545 extern int brcms_c_get(struct brcms_c_info *wlc, int cmd, int *arg);
 546 extern bool brcms_c_chipmatch(u16 vendor, u16 device);
 547 extern void brcms_c_init(struct brcms_c_info *wlc);
 548 extern void brcms_c_reset(struct brcms_c_info *wlc);
 549
 550 extern void brcms_c_intrson(struct brcms_c_info *wlc);
 551 extern u32 brcms_c_intrsoff(struct brcms_c_info *wlc);
 552 extern void brcms_c_intrsrestore(struct brcms_c_info *wlc, u32 macintmask);
 553 extern bool brcms_c_intrsupd(struct brcms_c_info *wlc);
 554 extern bool brcms_c_isr(struct brcms_c_info *wlc, bool *wantdpc);
 555 extern bool brcms_c_dpc(struct brcms_c_info *wlc, bool bounded);
 556 extern bool brcms_c_sendpkt_mac80211(struct brcms_c_info *wlc,
 557                                      struct sk_buff *sdu,
 558                                      struct ieee80211_hw *hw);
 559 extern int brcms_c_ioctl(struct brcms_c_info *wlc, int cmd, void *arg, int len,
 560                          struct brcms_c_if *wlcif);
 561 extern bool brcms_c_aggregatable(struct brcms_c_info *wlc, u8 tid);
 562
 563 /* helper functions */
 564 extern void brcms_c_statsupd(struct brcms_c_info *wlc);
 565 extern void brcms_c_protection_upd(struct brcms_c_info *wlc, uint idx,
 566                                    int val);
 567 extern int brcms_c_get_header_len(void);
 568 extern void brcms_c_mac_bcn_promisc_change(struct brcms_c_info *wlc,
 569                                            bool promisc);
 570 extern void brcms_c_set_addrmatch(struct brcms_c_info *wlc,
 571                                   int match_reg_offset,
 572                                   const u8 *addr);
 573 extern void brcms_c_wme_setparams(struct brcms_c_info *wlc, u16 aci,
 574                               const struct ieee80211_tx_queue_params *arg,
 575                               bool suspend);
 576 extern struct brcms_pub *brcms_c_pub(struct brcms_c_info *wlc);
 577
 578 /* common functions for every port */
 579 extern void brcms_c_mhf(struct brcms_c_info *wlc, u8 idx, u16 mask, u16 val,
 580                     int bands);
 581 extern void brcms_c_rate_lookup_init(struct brcms_c_info *wlc,
 582                                      struct brcms_c_rateset *rateset);
 583 extern void brcms_default_rateset(struct brcms_c_info *wlc,
 584                                   struct brcms_c_rateset *rs);
 585
 586 extern void brcms_c_ampdu_flush(struct brcms_c_info *wlc,
 587                             struct ieee80211_sta *sta, u16 tid);
 588 extern void brcms_c_ampdu_tx_operational(struct brcms_c_info *wlc, u8 tid,
 589                                          u8 ba_wsize, uint max_rx_ampdu_bytes);
 590 extern int brcms_c_set_par(struct brcms_c_info *wlc, enum wlc_par_id par_id,
 591                            int val);
 592 extern int brcms_c_get_par(struct brcms_c_info *wlc, enum wlc_par_id par_id,
 593                            int *ret_int_ptr);
 594 extern char *getvar(char *vars, const char *name);
 595 extern int getintvar(char *vars, const char *name);
 596
 597 /* wlc_phy.c helper functions */
 598 extern void brcms_c_set_ps_ctrl(struct brcms_c_info *wlc);
 599 extern void brcms_c_mctrl(struct brcms_c_info *wlc, u32 mask, u32 val);
 600
 601 extern int brcms_c_module_register(struct brcms_pub *pub,
 602                                    const char *name, struct brcms_info *hdl,
 603                                    int (*down_fn)(void *handle));
 604 extern int brcms_c_module_unregister(struct brcms_pub *pub, const char *name,
 605                                      struct brcms_info *hdl);
 606 extern void brcms_c_suspend_mac_and_wait(struct brcms_c_info *wlc);
 607 extern void brcms_c_enable_mac(struct brcms_c_info *wlc);
 608 extern void brcms_c_associate_upd(struct brcms_c_info *wlc, bool state);
 609 extern void brcms_c_scan_start(struct brcms_c_info *wlc);
 610 extern void brcms_c_scan_stop(struct brcms_c_info *wlc);
 611 extern int brcms_c_get_curband(struct brcms_c_info *wlc);
 612 extern void brcms_c_wait_for_tx_completion(struct brcms_c_info *wlc,
 613                                            bool drop);
 614
 615 /* helper functions */
 616 extern bool brcms_c_check_radio_disabled(struct brcms_c_info *wlc);
 617 extern bool brcms_c_radio_monitor_stop(struct brcms_c_info *wlc);
 618
 619 #define MAXBANDS                2       /* Maximum #of bands */
 620 /* bandstate array indices */
 621 #define BAND_2G_INDEX           0       /* wlc->bandstate[x] index */
 622 #define BAND_5G_INDEX           1       /* wlc->bandstate[x] index */
 623
 624 #define BAND_2G_NAME            "2.4G"
 625 #define BAND_5G_NAME            "5G"
 626
 627 #endif                          /* _BRCM_PUB_H_ */