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 D11_PHY_HDR_LEN 6       /* Phy header length - 6 bytes */
  26
  27 /* phy types */
  28 #define PHY_TYPE_A      0       /* Phy type A */
  29 #define PHY_TYPE_G      2       /* Phy type G */
  30 #define PHY_TYPE_N      4       /* Phy type N */
  31 #define PHY_TYPE_LP     5       /* Phy type Low Power A/B/G */
  32 #define PHY_TYPE_SSN    6       /* Phy type Single Stream N */
  33 #define PHY_TYPE_LCN    8       /* Phy type Single Stream N */
  34 #define PHY_TYPE_LCNXN  9       /* Phy type 2-stream N */
  35 #define PHY_TYPE_HT     7       /* Phy type 3-Stream N */
  36
  37 /* bw */
  38 #define BRCMS_10_MHZ    10      /* 10Mhz nphy channel bandwidth */
  39 #define BRCMS_20_MHZ    20      /* 20Mhz nphy channel bandwidth */
  40 #define BRCMS_40_MHZ    40      /* 40Mhz nphy channel bandwidth */
  41
  42 #define BRCMS_RSSI_MINVAL       -200    /* Low value, e.g. for forcing roam */
  43 #define BRCMS_RSSI_NO_SIGNAL    -91     /* NDIS RSSI link quality cutoffs */
  44 #define BRCMS_RSSI_VERY_LOW     -80     /* Very low quality cutoffs */
  45 #define BRCMS_RSSI_LOW          -70     /* Low quality cutoffs */
  46 #define BRCMS_RSSI_GOOD         -68     /* Good quality cutoffs */
  47 #define BRCMS_RSSI_VERY_GOOD    -58     /* Very good quality cutoffs */
  48 #define BRCMS_RSSI_EXCELLENT    -57     /* Excellent quality cutoffs */
  49
  50 /* a large TX Power as an init value to factor out of min() calculations,
  51  * keep low enough to fit in an s8, units are .25 dBm
  52  */
  53 #define BRCMS_TXPWR_MAX         (127)   /* ~32 dBm = 1,500 mW */
  54
  55 /* rate related definitions */
  56 #define BRCMS_RATE_FLAG 0x80    /* Flag to indicate it is a basic rate */
  57 #define BRCMS_RATE_MASK 0x7f    /* Rate value mask w/o basic rate flag */
  58
  59 /* legacy rx Antenna diversity for SISO rates */
  60 #define ANT_RX_DIV_FORCE_0      0       /* Use antenna 0 */
  61 #define ANT_RX_DIV_FORCE_1      1       /* Use antenna 1 */
  62 #define ANT_RX_DIV_START_1      2       /* Choose starting with 1 */
  63 #define ANT_RX_DIV_START_0      3       /* Choose starting with 0 */
  64 #define ANT_RX_DIV_ENABLE       3       /* APHY bbConfig Enable RX Diversity */
  65 /* default antdiv setting */
  66 #define ANT_RX_DIV_DEF          ANT_RX_DIV_START_0
  67
  68 /* legacy rx Antenna diversity for SISO rates */
  69 /* Tx on antenna 0, "legacy term Main" */
  70 #define ANT_TX_FORCE_0          0
  71 /* Tx on antenna 1, "legacy term Aux" */
  72 #define ANT_TX_FORCE_1          1
  73 /* Tx on phy's last good Rx antenna */
  74 #define ANT_TX_LAST_RX          3
  75 /* driver's default tx antenna setting */
  76 #define ANT_TX_DEF              3
  77
  78 /* Tx Chain values */
  79 /* def bitmap of txchain */
  80 #define TXCHAIN_DEF             0x1
  81 /* default bitmap of tx chains for nphy */
  82 #define TXCHAIN_DEF_NPHY        0x3
  83 /* default bitmap of tx chains for nphy */
  84 #define TXCHAIN_DEF_HTPHY       0x7
  85 /* def bitmap of rxchain */
  86 #define RXCHAIN_DEF             0x1
  87 /* default bitmap of rx chains for nphy */
  88 #define RXCHAIN_DEF_NPHY        0x3
  89 /* default bitmap of rx chains for nphy */
  90 #define RXCHAIN_DEF_HTPHY       0x7
  91 /* no antenna switch */
  92 #define ANTSWITCH_NONE          0
  93 /* antenna switch on 4321CB2, 2of3 */
  94 #define ANTSWITCH_TYPE_1        1
  95 /* antenna switch on 4321MPCI, 2of3 */
  96 #define ANTSWITCH_TYPE_2        2
  97 /* antenna switch on 4322, 2of3 */
  98 #define ANTSWITCH_TYPE_3        3
  99
 100 #define RXBUFSZ         PKTBUFSZ
 101
 102 #define MAX_STREAMS_SUPPORTED   4       /* max number of streams supported */
 103
 104 struct brcm_rateset {
 105         /* # rates in this set */
 106         u32 count;
 107         /* rates in 500kbps units w/hi bit set if basic */
 108         u8 rates[WL_NUMRATES];
 109 };
 110
 111 struct brcms_c_rateset {
 112         uint count;             /* number of rates in rates[] */
 113          /* rates in 500kbps units w/hi bit set if basic */
 114         u8 rates[BRCMS_NUMRATES];
 115         u8 htphy_membership;    /* HT PHY Membership */
 116         u8 mcs[MCSSET_LEN];     /* supported mcs index bit map */
 117 };
 118
 119 /* All the HT-specific default advertised capabilities (including AMPDU)
 120  * should be grouped here at one place
 121  */
 122 #define AMPDU_DEF_MPDU_DENSITY  6       /* default mpdu density (110 ==> 4us) */
 123
 124 /* wlc internal bss_info */
 125 struct brcms_bss_info {
 126         u8 BSSID[ETH_ALEN];     /* network BSSID */
 127         u16 flags;              /* flags for internal attributes */
 128         u8 SSID_len;            /* the length of SSID */
 129         u8 SSID[32];            /* SSID string */
 130         s16 RSSI;               /* receive signal strength (in dBm) */
 131         s16 SNR;                /* receive signal SNR in dB */
 132         u16 beacon_period;      /* units are Kusec */
 133         u16 chanspec;   /* Channel num, bw, ctrl_sb and band */
 134         struct brcms_c_rateset rateset; /* supported rates */
 135 };
 136
 137 #define MAC80211_PROMISC_BCNS   (1 << 0)
 138 #define MAC80211_SCAN           (1 << 1)
 139
 140 /*
 141  * Public portion of common driver state structure.
 142  * The wlc handle points at this.
 143  */
 144 struct brcms_pub {
 145         struct brcms_c_info *wlc;
 146         struct ieee80211_hw *ieee_hw;
 147         struct scb_ampdu *global_ampdu;
 148         uint mac80211_state;
 149         uint unit;              /* device instance number */
 150         uint corerev;           /* core revision */
 151         struct si_pub *sih;     /* SI handle (cookie for siutils calls) */
 152         char *vars;             /* "environment" name=value */
 153         bool up;                /* interface up and running */
 154         bool hw_off;            /* HW is off */
 155         bool hw_up;             /* one time hw up/down */
 156         bool _piomode;          /* true if pio mode */
 157         uint _nbands;           /* # bands supported */
 158         uint now;               /* # elapsed seconds */
 159
 160         bool promisc;           /* promiscuous destination address */
 161         bool delayed_down;      /* down delayed */
 162         bool associated;        /* true:part of [I]BSS, false: not */
 163         /* (union of stas_associated, aps_associated) */
 164         bool _ampdu;            /* ampdu enabled or not */
 165         u8 _n_enab;             /* bitmap of 11N + HT support */
 166
 167         u8 cur_etheraddr[ETH_ALEN];     /* our local ethernet address */
 168
 169         int bcmerror;           /* last bcm error */
 170
 171         u32 radio_disabled;     /* bit vector for radio disabled reasons */
 172
 173         u16 boardrev;   /* version # of particular board */
 174         u8 sromrev;             /* version # of the srom */
 175         char srom_ccode[BRCM_CNTRY_BUF_SZ];     /* Country Code in SROM */
 176         u32 boardflags; /* Board specific flags from srom */
 177         u32 boardflags2;        /* More board flags if sromrev >= 4 */
 178         bool phy_11ncapable;    /* the PHY/HW is capable of 802.11N */
 179
 180         struct wl_cnt *_cnt;    /* low-level counters in driver */
 181 };
 182
 183 enum wlc_par_id {
 184         IOV_MPC = 1,
 185         IOV_RTSTHRESH,
 186         IOV_QTXPOWER,
 187         IOV_BCN_LI_BCN          /* Beacon listen interval in # of beacons */
 188 };
 189
 190 /***********************************************
 191  * Feature-related macros to optimize out code *
 192  * *********************************************
 193  */
 194
 195 #define ENAB_1x1        0x01
 196 #define ENAB_2x2        0x02
 197 #define ENAB_3x3        0x04
 198 #define ENAB_4x4        0x08
 199 #define SUPPORT_11N     (ENAB_1x1|ENAB_2x2)
 200 #define SUPPORT_HT      (ENAB_1x1|ENAB_2x2|ENAB_3x3)
 201
 202 /* WL11N Support */
 203 #define AMPDU_AGG_HOST  1
 204
 205 /* pri is priority encoded in the packet. This maps the Packet priority to
 206  * enqueue precedence as defined in wlc_prec_map
 207  */
 208 extern const u8 wlc_prio2prec_map[];
 209 #define BRCMS_PRIO_TO_PREC(pri) wlc_prio2prec_map[(pri) & 7]
 210
 211 #define BRCMS_PREC_COUNT        16      /* Max precedence level implemented */
 212
 213 /* Mask to describe all precedence levels */
 214 #define BRCMS_PREC_BMP_ALL              MAXBITVAL(BRCMS_PREC_COUNT)
 215
 216 /*
 217  * This maps priority to one precedence higher - Used by PS-Poll response
 218  * packets to simulate enqueue-at-head operation, but still maintain the
 219  * order on the queue
 220  */
 221 #define BRCMS_PRIO_TO_HI_PREC(pri)      min(BRCMS_PRIO_TO_PREC(pri) + 1,\
 222                                             BRCMS_PREC_COUNT - 1)
 223
 224 /* Define a bitmap of precedences comprised by each AC */
 225 #define BRCMS_PREC_BMP_AC_BE    (NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_BE)) | \
 226                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_BE)) | \
 227                         NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_EE)) |    \
 228                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_EE)))
 229 #define BRCMS_PREC_BMP_AC_BK    (NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_BK)) | \
 230                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_BK)) | \
 231                         NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_NONE)) |  \
 232                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_NONE)))
 233 #define BRCMS_PREC_BMP_AC_VI    (NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_CL)) | \
 234                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_CL)) | \
 235                         NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_VI)) |    \
 236                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_VI)))
 237 #define BRCMS_PREC_BMP_AC_VO    (NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_VO)) | \
 238                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_VO)) | \
 239                         NBITVAL(BRCMS_PRIO_TO_PREC(PRIO_8021D_NC)) |    \
 240                         NBITVAL(BRCMS_PRIO_TO_HI_PREC(PRIO_8021D_NC)))
 241
 242 /* network protection config */
 243 #define BRCMS_PROT_G_SPEC               1       /* SPEC g protection */
 244 #define BRCMS_PROT_G_OVR                2       /* SPEC g prot override */
 245 #define BRCMS_PROT_G_USER               3       /* gmode specified by user */
 246 #define BRCMS_PROT_OVERLAP      4       /* overlap */
 247 #define BRCMS_PROT_N_USER               10      /* nmode specified by user */
 248 #define BRCMS_PROT_N_CFG                11      /* n protection */
 249 #define BRCMS_PROT_N_CFG_OVR    12      /* n protection override */
 250 #define BRCMS_PROT_N_NONGF      13      /* non-GF protection */
 251 #define BRCMS_PROT_N_NONGF_OVR  14      /* non-GF protection override */
 252 #define BRCMS_PROT_N_PAM_OVR    15      /* n preamble override */
 253 #define BRCMS_PROT_N_OBSS               16      /* non-HT OBSS present */
 254
 255 /*
 256  * 54g modes (basic bits may still be overridden)
 257  *
 258  * GMODE_LEGACY_B
 259  *      Rateset: 1b, 2b, 5.5, 11
 260  *      Preamble: Long
 261  *      Shortslot: Off
 262  * GMODE_AUTO
 263  *      Rateset: 1b, 2b, 5.5b, 11b, 18, 24, 36, 54
 264  *      Extended Rateset: 6, 9, 12, 48
 265  *      Preamble: Long
 266  *      Shortslot: Auto
 267  * GMODE_ONLY
 268  *      Rateset: 1b, 2b, 5.5b, 11b, 18, 24b, 36, 54
 269  *      Extended Rateset: 6b, 9, 12b, 48
 270  *      Preamble: Short required
 271  *      Shortslot: Auto
 272  * GMODE_B_DEFERRED
 273  *      Rateset: 1b, 2b, 5.5b, 11b, 18, 24, 36, 54
 274  *      Extended Rateset: 6, 9, 12, 48
 275  *      Preamble: Long
 276  *      Shortslot: On
 277  * GMODE_PERFORMANCE
 278  *      Rateset: 1b, 2b, 5.5b, 6b, 9, 11b, 12b, 18, 24b, 36, 48, 54
 279  *      Preamble: Short required
 280  *      Shortslot: On and required
 281  * GMODE_LRS
 282  *      Rateset: 1b, 2b, 5.5b, 11b
 283  *      Extended Rateset: 6, 9, 12, 18, 24, 36, 48, 54
 284  *      Preamble: Long
 285  *      Shortslot: Auto
 286  */
 287 #define GMODE_LEGACY_B          0
 288 #define GMODE_AUTO              1
 289 #define GMODE_ONLY              2
 290 #define GMODE_B_DEFERRED        3
 291 #define GMODE_PERFORMANCE       4
 292 #define GMODE_LRS               5
 293 #define GMODE_MAX               6
 294
 295 /* MCS values greater than this enable multiple streams */
 296 #define HIGHEST_SINGLE_STREAM_MCS       7
 297
 298 #define MAXBANDS                2       /* Maximum #of bands */
 299
 300 /* max number of antenna configurations */
 301 #define ANT_SELCFG_MAX          4
 302
 303 struct brcms_antselcfg {
 304         u8 ant_config[ANT_SELCFG_MAX];  /* antenna configuration */
 305         u8 num_antcfg;  /* number of available antenna configurations */
 306 };
 307
 308 /* common functions for every port */
 309 struct brcms_c_info *
 310 brcms_c_attach(struct brcms_info *wl, u16 vendor, u16 device, uint unit,
 311                bool piomode, void __iomem *regsva, struct pci_dev *btparam,
 312                uint *perr);
 313 extern uint brcms_c_detach(struct brcms_c_info *wlc);
 314 extern int brcms_c_up(struct brcms_c_info *wlc);
 315 extern uint brcms_c_down(struct brcms_c_info *wlc);
 316
 317 extern bool brcms_c_chipmatch(u16 vendor, u16 device);
 318 extern void brcms_c_init(struct brcms_c_info *wlc);
 319 extern void brcms_c_reset(struct brcms_c_info *wlc);
 320
 321 extern void brcms_c_intrson(struct brcms_c_info *wlc);
 322 extern u32 brcms_c_intrsoff(struct brcms_c_info *wlc);
 323 extern void brcms_c_intrsrestore(struct brcms_c_info *wlc, u32 macintmask);
 324 extern bool brcms_c_intrsupd(struct brcms_c_info *wlc);
 325 extern bool brcms_c_isr(struct brcms_c_info *wlc, bool *wantdpc);
 326 extern bool brcms_c_dpc(struct brcms_c_info *wlc, bool bounded);
 327 extern void brcms_c_sendpkt_mac80211(struct brcms_c_info *wlc,
 328                                      struct sk_buff *sdu,
 329                                      struct ieee80211_hw *hw);
 330 extern bool brcms_c_aggregatable(struct brcms_c_info *wlc, u8 tid);
 331
 332 /* helper functions */
 333 extern void brcms_c_statsupd(struct brcms_c_info *wlc);
 334 extern void brcms_c_protection_upd(struct brcms_c_info *wlc, uint idx,
 335                                    int val);
 336 extern int brcms_c_get_header_len(void);
 337 extern void brcms_c_mac_bcn_promisc_change(struct brcms_c_info *wlc,
 338                                            bool promisc);
 339 extern void brcms_c_set_addrmatch(struct brcms_c_info *wlc,
 340                                   int match_reg_offset,
 341                                   const u8 *addr);
 342 extern void brcms_c_wme_setparams(struct brcms_c_info *wlc, u16 aci,
 343                               const struct ieee80211_tx_queue_params *arg,
 344                               bool suspend);
 345 extern struct brcms_pub *brcms_c_pub(struct brcms_c_info *wlc);
 346
 347 /* common functions for every port */
 348 extern void brcms_c_mhf(struct brcms_c_info *wlc, u8 idx, u16 mask, u16 val,
 349                     int bands);
 350 extern void brcms_c_rate_lookup_init(struct brcms_c_info *wlc,
 351                                      struct brcms_c_rateset *rateset);
 352 extern void brcms_default_rateset(struct brcms_c_info *wlc,
 353                                   struct brcms_c_rateset *rs);
 354
 355 extern void brcms_c_ampdu_flush(struct brcms_c_info *wlc,
 356                             struct ieee80211_sta *sta, u16 tid);
 357 extern void brcms_c_ampdu_tx_operational(struct brcms_c_info *wlc, u8 tid,
 358                                          u8 ba_wsize, uint max_rx_ampdu_bytes);
 359 extern char *getvar(char *vars, const char *name);
 360 extern int getintvar(char *vars, const char *name);
 361
 362 /* wlc_phy.c helper functions */
 363 extern void brcms_c_set_ps_ctrl(struct brcms_c_info *wlc);
 364 extern void brcms_c_mctrl(struct brcms_c_info *wlc, u32 mask, u32 val);
 365
 366 extern int brcms_c_module_register(struct brcms_pub *pub,
 367                                    const char *name, struct brcms_info *hdl,
 368                                    int (*down_fn)(void *handle));
 369 extern int brcms_c_module_unregister(struct brcms_pub *pub, const char *name,
 370                                      struct brcms_info *hdl);
 371 extern void brcms_c_suspend_mac_and_wait(struct brcms_c_info *wlc);
 372 extern void brcms_c_enable_mac(struct brcms_c_info *wlc);
 373 extern void brcms_c_associate_upd(struct brcms_c_info *wlc, bool state);
 374 extern void brcms_c_scan_start(struct brcms_c_info *wlc);
 375 extern void brcms_c_scan_stop(struct brcms_c_info *wlc);
 376 extern int brcms_c_get_curband(struct brcms_c_info *wlc);
 377 extern void brcms_c_wait_for_tx_completion(struct brcms_c_info *wlc,
 378                                            bool drop);
 379
 380 int brcms_c_set_channel(struct brcms_c_info *wlc, u16 channel);
 381 int brcms_c_set_rate_limit(struct brcms_c_info *wlc, u16 srl, u16 lrl);
 382 void brcms_c_get_current_rateset(struct brcms_c_info *wlc,
 383                                  struct brcm_rateset *currs);
 384 int brcms_c_set_rateset(struct brcms_c_info *wlc, struct brcm_rateset *rs);
 385 int brcms_c_set_beacon_period(struct brcms_c_info *wlc, u16 period);
 386 u16 brcms_c_get_phy_type(struct brcms_c_info *wlc, int phyidx);
 387 void brcms_c_set_shortslot_override(struct brcms_c_info *wlc,
 388                                     s8 sslot_override);
 389 void brcms_c_set_beacon_listen_interval(struct brcms_c_info *wlc, u8 interval);
 390 int brcms_c_set_tx_power(struct brcms_c_info *wlc, int txpwr);
 391 int brcms_c_get_tx_power(struct brcms_c_info *wlc);
 392 void brcms_c_set_radio_mpc(struct brcms_c_info *wlc, bool mpc);
 393
 394 /* helper functions */
 395 extern bool brcms_c_check_radio_disabled(struct brcms_c_info *wlc);
 396 extern bool brcms_c_radio_monitor_stop(struct brcms_c_info *wlc);
 397
 398 #endif                          /* _BRCM_PUB_H_ */