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