drivers/staging/brcm80211/brcmsmac/wlc_main.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 _wlc_h_
  18 #define _wlc_h_
  19
  20 #define MA_WINDOW_SZ            8       /* moving average window size */
  21 #define WL_HWRXOFF              38      /* chip rx buffer offset */
  22 #define INVCHANNEL              255     /* invalid channel */
  23 #define MAXCOREREV              28      /* max # supported core revisions (0 .. MAXCOREREV - 1) */
  24 #define WLC_MAXMODULES          22      /* max #  wlc_module_register() calls */
  25
  26 #define WLC_BITSCNT(x)  bcm_bitcount((u8 *)&(x), sizeof(u8))
  27
  28 /* Maximum wait time for a MAC suspend */
  29 #define WLC_MAX_MAC_SUSPEND     83000   /* uS: 83mS is max packet time (64KB ampdu @ 6Mbps) */
  30
  31 /* Probe Response timeout - responses for probe requests older that this are tossed, zero to disable
  32  */
  33 #define WLC_PRB_RESP_TIMEOUT    0       /* Disable probe response timeout */
  34
  35 /* transmit buffer max headroom for protocol headers */
  36 #define TXOFF (D11_TXH_LEN + D11_PHY_HDR_LEN)
  37
  38 /* For managing scan result lists */
  39 struct wlc_bss_list {
  40         uint count;
  41         bool beacon;            /* set for beacon, cleared for probe response */
  42         wlc_bss_info_t *ptrs[MAXBSS];
  43 };
  44
  45 #define SW_TIMER_MAC_STAT_UPD           30      /* periodic MAC stats update */
  46
  47 /* Double check that unsupported cores are not enabled */
  48 #if CONF_MSK(D11CONF, 0x4f) || CONF_GE(D11CONF, MAXCOREREV)
  49 #error "Configuration for D11CONF includes unsupported versions."
  50 #endif                          /* Bad versions */
  51
  52 #define VALID_COREREV(corerev)  CONF_HAS(D11CONF, corerev)
  53
  54 /* values for shortslot_override */
  55 #define WLC_SHORTSLOT_AUTO      -1      /* Driver will manage Shortslot setting */
  56 #define WLC_SHORTSLOT_OFF       0       /* Turn off short slot */
  57 #define WLC_SHORTSLOT_ON        1       /* Turn on short slot */
  58
  59 /* value for short/long and mixmode/greenfield preamble */
  60
  61 #define WLC_LONG_PREAMBLE       (0)
  62 #define WLC_SHORT_PREAMBLE      (1 << 0)
  63 #define WLC_GF_PREAMBLE         (1 << 1)
  64 #define WLC_MM_PREAMBLE         (1 << 2)
  65 #define WLC_IS_MIMO_PREAMBLE(_pre) (((_pre) == WLC_GF_PREAMBLE) || ((_pre) == WLC_MM_PREAMBLE))
  66
  67 /* values for barker_preamble */
  68 #define WLC_BARKER_SHORT_ALLOWED        0       /* Short pre-amble allowed */
  69
  70 /* A fifo is full. Clear precedences related to that FIFO */
  71 #define WLC_TX_FIFO_CLEAR(wlc, fifo) ((wlc)->tx_prec_map &= ~(wlc)->fifo2prec_map[fifo])
  72
  73 /* Fifo is NOT full. Enable precedences for that FIFO */
  74 #define WLC_TX_FIFO_ENAB(wlc, fifo)  ((wlc)->tx_prec_map |= (wlc)->fifo2prec_map[fifo])
  75
  76 /* TxFrameID */
  77 /* seq and frag bits: SEQNUM_SHIFT, FRAGNUM_MASK (802.11.h) */
  78 /* rate epoch bits: TXFID_RATE_SHIFT, TXFID_RATE_MASK ((wlc_rate.c) */
  79 #define TXFID_QUEUE_MASK        0x0007  /* Bits 0-2 */
  80 #define TXFID_SEQ_MASK          0x7FE0  /* Bits 5-15 */
  81 #define TXFID_SEQ_SHIFT         5       /* Number of bit shifts */
  82 #define TXFID_RATE_PROBE_MASK   0x8000  /* Bit 15 for rate probe */
  83 #define TXFID_RATE_MASK         0x0018  /* Mask for bits 3 and 4 */
  84 #define TXFID_RATE_SHIFT        3       /* Shift 3 bits for rate mask */
  85
  86 /* promote boardrev */
  87 #define BOARDREV_PROMOTABLE     0xFF    /* from */
  88 #define BOARDREV_PROMOTED       1       /* to */
  89
  90 /* if wpa is in use then portopen is true when the group key is plumbed otherwise it is always true
  91  */
  92 #define WSEC_ENABLED(wsec) ((wsec) & (WEP_ENABLED | TKIP_ENABLED | AES_ENABLED))
  93 #define WLC_SW_KEYS(wlc, bsscfg) ((((wlc)->wsec_swkeys) || \
  94         ((bsscfg)->wsec & WSEC_SWFLAG)))
  95
  96 #define WLC_PORTOPEN(cfg) \
  97         (((cfg)->WPA_auth != WPA_AUTH_DISABLED && WSEC_ENABLED((cfg)->wsec)) ? \
  98         (cfg)->wsec_portopen : true)
  99
 100 #define PS_ALLOWED(wlc) wlc_ps_allowed(wlc)
 101
 102 #define DATA_BLOCK_TX_SUPR      (1 << 4)
 103
 104 /* 802.1D Priority to TX FIFO number for wme */
 105 extern const u8 prio2fifo[];
 106
 107 /* Ucode MCTL_WAKE override bits */
 108 #define WLC_WAKE_OVERRIDE_CLKCTL        0x01
 109 #define WLC_WAKE_OVERRIDE_PHYREG        0x02
 110 #define WLC_WAKE_OVERRIDE_MACSUSPEND    0x04
 111 #define WLC_WAKE_OVERRIDE_TXFIFO        0x08
 112 #define WLC_WAKE_OVERRIDE_FORCEFAST     0x10
 113
 114 /* stuff pulled in from wlc.c */
 115
 116 /* Interrupt bit error summary.  Don't include I_RU: we refill DMA at other
 117  * times; and if we run out, constant I_RU interrupts may cause lockup.  We
 118  * will still get error counts from rx0ovfl.
 119  */
 120 #define I_ERRORS        (I_PC | I_PD | I_DE | I_RO | I_XU)
 121 /* default software intmasks */
 122 #define DEF_RXINTMASK   (I_RI)  /* enable rx int on rxfifo only */
 123 #define DEF_MACINTMASK  (MI_TXSTOP | MI_TBTT | MI_ATIMWINEND | MI_PMQ | \
 124                          MI_PHYTXERR | MI_DMAINT | MI_TFS | MI_BG_NOISE | \
 125                          MI_CCA | MI_TO | MI_GP0 | MI_RFDISABLE | MI_PWRUP)
 126
 127 #define RETRY_SHORT_DEF                 7       /* Default Short retry Limit */
 128 #define RETRY_SHORT_MAX                 255     /* Maximum Short retry Limit */
 129 #define RETRY_LONG_DEF                  4       /* Default Long retry count */
 130 #define RETRY_SHORT_FB                  3       /* Short retry count for fallback rate */
 131 #define RETRY_LONG_FB                   2       /* Long retry count for fallback rate */
 132
 133 #define MAXTXPKTS               6       /* max # pkts pending */
 134
 135 /* frameburst */
 136 #define MAXTXFRAMEBURST         8       /* vanilla xpress mode: max frames/burst */
 137 #define MAXFRAMEBURST_TXOP      10000   /* Frameburst TXOP in usec */
 138
 139 /* Per-AC retry limit register definitions; uses bcmdefs.h bitfield macros */
 140 #define EDCF_SHORT_S            0
 141 #define EDCF_SFB_S              4
 142 #define EDCF_LONG_S             8
 143 #define EDCF_LFB_S              12
 144 #define EDCF_SHORT_M            BITFIELD_MASK(4)
 145 #define EDCF_SFB_M              BITFIELD_MASK(4)
 146 #define EDCF_LONG_M             BITFIELD_MASK(4)
 147 #define EDCF_LFB_M              BITFIELD_MASK(4)
 148
 149 #define WLC_WME_RETRY_SHORT_GET(wlc, ac)    GFIELD(wlc->wme_retries[ac], EDCF_SHORT)
 150 #define WLC_WME_RETRY_SFB_GET(wlc, ac)      GFIELD(wlc->wme_retries[ac], EDCF_SFB)
 151 #define WLC_WME_RETRY_LONG_GET(wlc, ac)     GFIELD(wlc->wme_retries[ac], EDCF_LONG)
 152 #define WLC_WME_RETRY_LFB_GET(wlc, ac)      GFIELD(wlc->wme_retries[ac], EDCF_LFB)
 153
 154 #define WLC_WME_RETRY_SHORT_SET(wlc, ac, val) \
 155         (wlc->wme_retries[ac] = SFIELD(wlc->wme_retries[ac], EDCF_SHORT, val))
 156 #define WLC_WME_RETRY_SFB_SET(wlc, ac, val) \
 157         (wlc->wme_retries[ac] = SFIELD(wlc->wme_retries[ac], EDCF_SFB, val))
 158 #define WLC_WME_RETRY_LONG_SET(wlc, ac, val) \
 159         (wlc->wme_retries[ac] = SFIELD(wlc->wme_retries[ac], EDCF_LONG, val))
 160 #define WLC_WME_RETRY_LFB_SET(wlc, ac, val) \
 161         (wlc->wme_retries[ac] = SFIELD(wlc->wme_retries[ac], EDCF_LFB, val))
 162
 163 /* PLL requests */
 164 #define WLC_PLLREQ_SHARED       0x1     /* pll is shared on old chips */
 165 #define WLC_PLLREQ_RADIO_MON    0x2     /* hold pll for radio monitor register checking */
 166 #define WLC_PLLREQ_FLIP         0x4     /* hold/release pll for some short operation */
 167
 168 /*
 169  * Macros to check if AP or STA is active.
 170  * AP Active means more than just configured: driver and BSS are "up";
 171  * that is, we are beaconing/responding as an AP (aps_associated).
 172  * STA Active similarly means the driver is up and a configured STA BSS
 173  * is up: either associated (stas_associated) or trying.
 174  *
 175  * Macro definitions vary as per AP/STA ifdefs, allowing references to
 176  * ifdef'd structure fields and constant values (0) for optimization.
 177  * Make sure to enclose blocks of code such that any routines they
 178  * reference can also be unused and optimized out by the linker.
 179  */
 180 /* NOTE: References structure fields defined in wlc.h */
 181 #define AP_ACTIVE(wlc)  (0)
 182
 183 /*
 184  * Detect Card removed.
 185  * Even checking an sbconfig register read will not false trigger when the core is in reset.
 186  * it breaks CF address mechanism. Accessing gphy phyversion will cause SB error if aphy
 187  * is in reset on 4306B0-DB. Need a simple accessible reg with fixed 0/1 pattern
 188  * (some platforms return all 0).
 189  * If clocks are present, call the sb routine which will figure out if the device is removed.
 190  */
 191 #define DEVICEREMOVED(wlc)      \
 192         ((wlc->hw->clk) ?   \
 193         ((R_REG(&wlc->hw->regs->maccontrol) & \
 194         (MCTL_PSM_JMP_0 | MCTL_IHR_EN)) != MCTL_IHR_EN) : \
 195         (ai_deviceremoved(wlc->hw->sih)))
 196
 197 #define WLCWLUNIT(wlc)          ((wlc)->pub->unit)
 198
 199 struct wlc_protection {
 200         bool _g;                /* use g spec protection, driver internal */
 201         s8 g_override;  /* override for use of g spec protection */
 202         u8 gmode_user;  /* user config gmode, operating band->gmode is different */
 203         s8 overlap;             /* Overlap BSS/IBSS protection for both 11g and 11n */
 204         s8 nmode_user;  /* user config nmode, operating pub->nmode is different */
 205         s8 n_cfg;               /* use OFDM protection on MIMO frames */
 206         s8 n_cfg_override;      /* override for use of N protection */
 207         bool nongf;             /* non-GF present protection */
 208         s8 nongf_override;      /* override for use of GF protection */
 209         s8 n_pam_override;      /* override for preamble: MM or GF */
 210         bool n_obss;            /* indicated OBSS Non-HT STA present */
 211 };
 212
 213 /* anything affects the single/dual streams/antenna operation */
 214 struct wlc_stf {
 215         u8 hw_txchain;  /* HW txchain bitmap cfg */
 216         u8 txchain;             /* txchain bitmap being used */
 217         u8 txstreams;   /* number of txchains being used */
 218
 219         u8 hw_rxchain;  /* HW rxchain bitmap cfg */
 220         u8 rxchain;             /* rxchain bitmap being used */
 221         u8 rxstreams;   /* number of rxchains being used */
 222
 223         u8 ant_rx_ovr;  /* rx antenna override */
 224         s8 txant;               /* userTx antenna setting */
 225         u16 phytxant;   /* phyTx antenna setting in txheader */
 226
 227         u8 ss_opmode;   /* singlestream Operational mode, 0:siso; 1:cdd */
 228         bool ss_algosel_auto;   /* if true, use wlc->stf->ss_algo_channel; */
 229         /* else use wlc->band->stf->ss_mode_band; */
 230         u16 ss_algo_channel;    /* ss based on per-channel algo: 0: SISO, 1: CDD 2: STBC */
 231         u8 no_cddstbc;  /* stf override, 1: no CDD (or STBC) allowed */
 232
 233         u8 rxchain_restore_delay;       /* delay time to restore default rxchain */
 234
 235         s8 ldpc;                /* AUTO/ON/OFF ldpc cap supported */
 236         u8 txcore[MAX_STREAMS_SUPPORTED + 1];   /* bitmap of selected core for each Nsts */
 237         s8 spatial_policy;
 238 };
 239
 240 #define WLC_STF_SS_STBC_TX(wlc, scb) \
 241         (((wlc)->stf->txstreams > 1) && (((wlc)->band->band_stf_stbc_tx == ON) || \
 242          (SCB_STBC_CAP((scb)) &&                                        \
 243           (wlc)->band->band_stf_stbc_tx == AUTO &&                      \
 244           isset(&((wlc)->stf->ss_algo_channel), PHY_TXC1_MODE_STBC))))
 245
 246 #define WLC_STBC_CAP_PHY(wlc) (WLCISNPHY(wlc->band) && NREV_GE(wlc->band->phyrev, 3))
 247
 248 #define WLC_SGI_CAP_PHY(wlc) ((WLCISNPHY(wlc->band) && NREV_GE(wlc->band->phyrev, 3)) || \
 249         WLCISLCNPHY(wlc->band))
 250
 251 #define WLC_CHAN_PHYTYPE(x)     (((x) & RXS_CHAN_PHYTYPE_MASK) >> RXS_CHAN_PHYTYPE_SHIFT)
 252 #define WLC_CHAN_CHANNEL(x)     (((x) & RXS_CHAN_ID_MASK) >> RXS_CHAN_ID_SHIFT)
 253 #define WLC_RX_CHANNEL(rxh)     (WLC_CHAN_CHANNEL((rxh)->RxChan))
 254
 255 /* wlc_bss_info flag bit values */
 256 #define WLC_BSS_HT              0x0020  /* BSS is HT (MIMO) capable */
 257
 258 /* Flags used in wlc_txq_info.stopped */
 259 #define TXQ_STOP_FOR_PRIOFC_MASK        0x000000FF      /* per prio flow control bits */
 260 #define TXQ_STOP_FOR_PKT_DRAIN          0x00000100      /* stop txq enqueue for packet drain */
 261 #define TXQ_STOP_FOR_AMPDU_FLOW_CNTRL   0x00000200      /* stop txq enqueue for ampdu flow control */
 262
 263 #define WLC_HT_WEP_RESTRICT     0x01    /* restrict HT with WEP */
 264 #define WLC_HT_TKIP_RESTRICT    0x02    /* restrict HT with TKIP */
 265
 266 /*
 267  * core state (mac)
 268  */
 269 struct wlccore {
 270         uint coreidx;           /* # sb enumerated core */
 271
 272         /* fifo */
 273         uint *txavail[NFIFO];   /* # tx descriptors available */
 274         s16 txpktpend[NFIFO];   /* tx admission control */
 275
 276         macstat_t *macstat_snapshot;    /* mac hw prev read values */
 277 };
 278
 279 /*
 280  * band state (phy+ana+radio)
 281  */
 282 struct wlcband {
 283         int bandtype;           /* WLC_BAND_2G, WLC_BAND_5G */
 284         uint bandunit;          /* bandstate[] index */
 285
 286         u16 phytype;            /* phytype */
 287         u16 phyrev;
 288         u16 radioid;
 289         u16 radiorev;
 290         wlc_phy_t *pi;          /* pointer to phy specific information */
 291         bool abgphy_encore;
 292
 293         u8 gmode;               /* currently active gmode */
 294
 295         struct scb *hwrs_scb;   /* permanent scb for hw rateset */
 296
 297         wlc_rateset_t defrateset;       /* band-specific copy of default_bss.rateset */
 298
 299         ratespec_t rspec_override;      /* 802.11 rate override */
 300         ratespec_t mrspec_override;     /* multicast rate override */
 301         u8 band_stf_ss_mode;    /* Configured STF type, 0:siso; 1:cdd */
 302         s8 band_stf_stbc_tx;    /* STBC TX 0:off; 1:force on; -1:auto */
 303         wlc_rateset_t hw_rateset;       /* rates supported by chip (phy-specific) */
 304         u8 basic_rate[WLC_MAXRATE + 1]; /* basic rates indexed by rate */
 305         bool mimo_cap_40;       /* 40 MHz cap enabled on this band */
 306         s8 antgain;             /* antenna gain from srom */
 307
 308         u16 CWmin;              /* The minimum size of contention window, in unit of aSlotTime */
 309         u16 CWmax;              /* The maximum size of contention window, in unit of aSlotTime */
 310         u16 bcntsfoff;  /* beacon tsf offset */
 311 };
 312
 313 /* tx completion callback takes 3 args */
 314 typedef void (*pkcb_fn_t) (struct wlc_info *wlc, uint txstatus, void *arg);
 315
 316 struct pkt_cb {
 317         pkcb_fn_t fn;           /* function to call when tx frame completes */
 318         void *arg;              /* void arg for fn */
 319         u8 nextidx;             /* index of next call back if threading */
 320         bool entered;           /* recursion check */
 321 };
 322
 323 /* module control blocks */
 324 struct modulecb {
 325         char name[32];          /* module name : NULL indicates empty array member */
 326         const bcm_iovar_t *iovars;      /* iovar table */
 327         void *hdl;              /* handle passed when handler 'doiovar' is called */
 328         watchdog_fn_t watchdog_fn;      /* watchdog handler */
 329         iovar_fn_t iovar_fn;    /* iovar handler */
 330         down_fn_t down_fn;      /* down handler. Note: the int returned
 331                                  * by the down function is a count of the
 332                                  * number of timers that could not be
 333                                  * freed.
 334                                  */
 335 };
 336
 337 /* dump control blocks */
 338 struct dumpcb_s {
 339         const char *name;       /* dump name */
 340         dump_fn_t dump_fn;      /* 'wl dump' handler */
 341         void *dump_fn_arg;
 342         struct dumpcb_s *next;
 343 };
 344
 345 /* virtual interface */
 346 struct wlc_if {
 347         struct wlc_if *next;
 348         u8 type;                /* WLC_IFTYPE_BSS or WLC_IFTYPE_WDS */
 349         u8 index;               /* assigned in wl_add_if(), index of the wlif if any,
 350                                  * not necessarily corresponding to bsscfg._idx or
 351                                  * AID2PVBMAP(scb).
 352                                  */
 353         u8 flags;               /* flags for the interface */
 354         struct wl_if *wlif;             /* pointer to wlif */
 355         struct wlc_txq_info *qi;        /* pointer to associated tx queue */
 356         union {
 357                 struct scb *scb;        /* pointer to scb if WLC_IFTYPE_WDS */
 358                 struct wlc_bsscfg *bsscfg;      /* pointer to bsscfg if WLC_IFTYPE_BSS */
 359         } u;
 360 };
 361
 362 /* flags for the interface */
 363 #define WLC_IF_LINKED           0x02    /* this interface is linked to a wl_if */
 364
 365 struct wlc_hwband {
 366         int bandtype;           /* WLC_BAND_2G, WLC_BAND_5G */
 367         uint bandunit;          /* bandstate[] index */
 368         u16 mhfs[MHFMAX];       /* MHF array shadow */
 369         u8 bandhw_stf_ss_mode;  /* HW configured STF type, 0:siso; 1:cdd */
 370         u16 CWmin;
 371         u16 CWmax;
 372         u32 core_flags;
 373
 374         u16 phytype;            /* phytype */
 375         u16 phyrev;
 376         u16 radioid;
 377         u16 radiorev;
 378         wlc_phy_t *pi;          /* pointer to phy specific information */
 379         bool abgphy_encore;
 380 };
 381
 382 struct wlc_hw_info {
 383         bool _piomode;          /* true if pio mode */
 384         struct wlc_info *wlc;
 385
 386         /* fifo */
 387         struct hnddma_pub *di[NFIFO];   /* hnddma handles, per fifo */
 388
 389         uint unit;              /* device instance number */
 390
 391         /* version info */
 392         u16 vendorid;   /* PCI vendor id */
 393         u16 deviceid;   /* PCI device id */
 394         uint corerev;           /* core revision */
 395         u8 sromrev;             /* version # of the srom */
 396         u16 boardrev;   /* version # of particular board */
 397         u32 boardflags; /* Board specific flags from srom */
 398         u32 boardflags2;        /* More board flags if sromrev >= 4 */
 399         u32 machwcap;   /* MAC capabilities */
 400         u32 machwcap_backup;    /* backup of machwcap */
 401         u16 ucode_dbgsel;       /* dbgsel for ucode debug(config gpio) */
 402
 403         si_t *sih;              /* SB handle (cookie for siutils calls) */
 404         char *vars;             /* "environment" name=value */
 405         uint vars_size;         /* size of vars, free vars on detach */
 406         d11regs_t *regs;        /* pointer to device registers */
 407         void *physhim;          /* phy shim layer handler */
 408         void *phy_sh;           /* pointer to shared phy state */
 409         struct wlc_hwband *band;/* pointer to active per-band state */
 410         struct wlc_hwband *bandstate[MAXBANDS];/* band state per phy/radio */
 411         u16 bmac_phytxant;      /* cache of high phytxant state */
 412         bool shortslot;         /* currently using 11g ShortSlot timing */
 413         u16 SRL;                /* 802.11 dot11ShortRetryLimit */
 414         u16 LRL;                /* 802.11 dot11LongRetryLimit */
 415         u16 SFBL;               /* Short Frame Rate Fallback Limit */
 416         u16 LFBL;               /* Long Frame Rate Fallback Limit */
 417
 418         bool up;                /* d11 hardware up and running */
 419         uint now;               /* # elapsed seconds */
 420         uint _nbands;           /* # bands supported */
 421         chanspec_t chanspec;    /* bmac chanspec shadow */
 422
 423         uint *txavail[NFIFO];   /* # tx descriptors available */
 424         u16 *xmtfifo_sz;        /* fifo size in 256B for each xmt fifo */
 425
 426         mbool pllreq;           /* pll requests to keep PLL on */
 427
 428         u8 suspended_fifos;     /* Which TX fifo to remain awake for */
 429         u32 maccontrol; /* Cached value of maccontrol */
 430         uint mac_suspend_depth; /* current depth of mac_suspend levels */
 431         u32 wake_override;      /* Various conditions to force MAC to WAKE mode */
 432         u32 mute_override;      /* Prevent ucode from sending beacons */
 433         u8 etheraddr[ETH_ALEN]; /* currently configured ethernet address */
 434         u32 led_gpio_mask;      /* LED GPIO Mask */
 435         bool noreset;           /* true= do not reset hw, used by WLC_OUT */
 436         bool forcefastclk;      /* true if the h/w is forcing the use of fast clk */
 437         bool clk;               /* core is out of reset and has clock */
 438         bool sbclk;             /* sb has clock */
 439         struct bmac_pmq *bmac_pmq; /*  bmac PM states derived from ucode PMQ */
 440         bool phyclk;            /* phy is out of reset and has clock */
 441         bool dma_lpbk;          /* core is in DMA loopback */
 442
 443         bool ucode_loaded;      /* true after ucode downloaded */
 444
 445
 446         u8 hw_stf_ss_opmode;    /* STF single stream operation mode */
 447         u8 antsel_type; /* Type of boardlevel mimo antenna switch-logic
 448                                  * 0 = N/A, 1 = 2x4 board, 2 = 2x3 CB2 board
 449                                  */
 450         u32 antsel_avail;       /*
 451                                  * put struct antsel_info here if more info is
 452                                  * needed
 453                                  */
 454 };
 455
 456 /* TX Queue information
 457  *
 458  * Each flow of traffic out of the device has a TX Queue with independent
 459  * flow control. Several interfaces may be associated with a single TX Queue
 460  * if they belong to the same flow of traffic from the device. For multi-channel
 461  * operation there are independent TX Queues for each channel.
 462  */
 463 struct wlc_txq_info {
 464         struct wlc_txq_info *next;
 465         struct pktq q;
 466         uint stopped;           /* tx flow control bits */
 467 };
 468
 469 /*
 470  * Principal common (os-independent) software data structure.
 471  */
 472 struct wlc_info {
 473         struct wlc_pub *pub;            /* pointer to wlc public state */
 474         struct wl_info *wl;     /* pointer to os-specific private state */
 475         d11regs_t *regs;        /* pointer to device registers */
 476
 477         struct wlc_hw_info *hw; /* HW related state used primarily by BMAC */
 478
 479         /* clock */
 480         int clkreq_override;    /* setting for clkreq for PCIE : Auto, 0, 1 */
 481         u16 fastpwrup_dly;      /* time in us needed to bring up d11 fast clock */
 482
 483         /* interrupt */
 484         u32 macintstatus;       /* bit channel between isr and dpc */
 485         u32 macintmask; /* sw runtime master macintmask value */
 486         u32 defmacintmask;      /* default "on" macintmask value */
 487
 488         /* up and down */
 489         bool device_present;    /* (removable) device is present */
 490
 491         bool clk;               /* core is out of reset and has clock */
 492
 493         /* multiband */
 494         struct wlccore *core;   /* pointer to active io core */
 495         struct wlcband *band;   /* pointer to active per-band state */
 496         struct wlccore *corestate;      /* per-core state (one per hw core) */
 497         /* per-band state (one per phy/radio): */
 498         struct wlcband *bandstate[MAXBANDS];
 499
 500         bool war16165;          /* PCI slow clock 16165 war flag */
 501
 502         bool tx_suspended;      /* data fifos need to remain suspended */
 503
 504         uint txpend16165war;
 505
 506         /* packet queue */
 507         uint qvalid;            /* DirFrmQValid and BcMcFrmQValid */
 508
 509         /* Regulatory power limits */
 510         s8 txpwr_local_max;     /* regulatory local txpwr max */
 511         u8 txpwr_local_constraint;      /* local power contraint in dB */
 512
 513
 514         struct ampdu_info *ampdu;       /* ampdu module handler */
 515         struct antsel_info *asi;        /* antsel module handler */
 516         wlc_cm_info_t *cmi;     /* channel manager module handler */
 517
 518         uint vars_size;         /* size of vars, free vars on detach */
 519
 520         u16 vendorid;   /* PCI vendor id */
 521         u16 deviceid;   /* PCI device id */
 522         uint ucode_rev;         /* microcode revision */
 523
 524         u32 machwcap;   /* MAC capabilities, BMAC shadow */
 525
 526         u8 perm_etheraddr[ETH_ALEN];    /* original sprom local ethernet address */
 527
 528         bool bandlocked;        /* disable auto multi-band switching */
 529         bool bandinit_pending;  /* track band init in auto band */
 530
 531         bool radio_monitor;     /* radio timer is running */
 532         bool going_down;        /* down path intermediate variable */
 533
 534         bool mpc;               /* enable minimum power consumption */
 535         u8 mpc_dlycnt;  /* # of watchdog cnt before turn disable radio */
 536         u8 mpc_offcnt;  /* # of watchdog cnt that radio is disabled */
 537         u8 mpc_delay_off;       /* delay radio disable by # of watchdog cnt */
 538         u8 prev_non_delay_mpc;  /* prev state wlc_is_non_delay_mpc */
 539
 540         /* timer */
 541         struct wl_timer *wdtimer;       /* timer for watchdog routine */
 542         struct wl_timer *radio_timer;   /* timer for hw radio button monitor routine */
 543
 544         /* promiscuous */
 545         bool monitor;           /* monitor (MPDU sniffing) mode */
 546         bool bcnmisc_ibss;      /* bcns promisc mode override for IBSS */
 547         bool bcnmisc_scan;      /* bcns promisc mode override for scan */
 548         bool bcnmisc_monitor;   /* bcns promisc mode override for monitor */
 549
 550         /* driver feature */
 551         bool _rifs;             /* enable per-packet rifs */
 552         s8 sgi_tx;              /* sgi tx */
 553
 554         /* AP-STA synchronization, power save */
 555         u8 bcn_li_bcn;  /* beacon listen interval in # beacons */
 556         u8 bcn_li_dtim; /* beacon listen interval in # dtims */
 557
 558         bool WDarmed;           /* watchdog timer is armed */
 559         u32 WDlast;             /* last time wlc_watchdog() was called */
 560
 561         /* WME */
 562         ac_bitmap_t wme_dp;     /* Discard (oldest first) policy per AC */
 563         u16 edcf_txop[AC_COUNT];        /* current txop for each ac */
 564         wme_param_ie_t wme_param_ie;    /* WME parameter info element, which on STA
 565                                          * contains parameters in use locally, and on
 566                                          * AP contains parameters advertised to STA
 567                                          * in beacons and assoc responses.
 568                                          */
 569         u16 wme_retries[AC_COUNT];      /* per-AC retry limits */
 570
 571         u16 tx_prec_map;        /* Precedence map based on HW FIFO space */
 572         u16 fifo2prec_map[NFIFO];       /* pointer to fifo2_prec map based on WME */
 573
 574         /*
 575          * BSS Configurations set of BSS configurations, idx 0 is default and
 576          * always valid
 577          */
 578         struct wlc_bsscfg *bsscfg[WLC_MAXBSSCFG];
 579         struct wlc_bsscfg *cfg; /* the primary bsscfg (can be AP or STA) */
 580
 581         /* tx queue */
 582         struct wlc_txq_info *tx_queues; /* common TX Queue list */
 583
 584         /* security */
 585         wsec_key_t *wsec_keys[WSEC_MAX_KEYS];   /* dynamic key storage */
 586         wsec_key_t *wsec_def_keys[WLC_DEFAULT_KEYS];    /* default key storage */
 587         bool wsec_swkeys;       /* indicates that all keys should be
 588                                  * treated as sw keys (used for debugging)
 589                                  */
 590         struct modulecb *modulecb;
 591
 592         u8 mimoft;              /* SIGN or 11N */
 593         s8 cck_40txbw;  /* 11N, cck tx b/w override when in 40MHZ mode */
 594         s8 ofdm_40txbw; /* 11N, ofdm tx b/w override when in 40MHZ mode */
 595         s8 mimo_40txbw; /* 11N, mimo tx b/w override when in 40MHZ mode */
 596         /* HT CAP IE being advertised by this node: */
 597         struct ieee80211_ht_cap ht_cap;
 598
 599         wlc_bss_info_t *default_bss;    /* configured BSS parameters */
 600
 601         u16 mc_fid_counter;     /* BC/MC FIFO frame ID counter */
 602
 603         char country_default[WLC_CNTRY_BUF_SZ]; /* saved country for leaving 802.11d
 604                                                  * auto-country mode
 605                                                  */
 606         char autocountry_default[WLC_CNTRY_BUF_SZ];     /* initial country for 802.11d
 607                                                          * auto-country mode
 608                                                          */
 609         u16 prb_resp_timeout;   /* do not send prb resp if request older than this,
 610                                          * 0 = disable
 611                                          */
 612
 613         wlc_rateset_t sup_rates_override;       /* use only these rates in 11g supported rates if
 614                                                  * specifed
 615                                                  */
 616
 617         chanspec_t home_chanspec;       /* shared home chanspec */
 618
 619         /* PHY parameters */
 620         chanspec_t chanspec;    /* target operational channel */
 621         u16 usr_fragthresh;     /* user configured fragmentation threshold */
 622         u16 fragthresh[NFIFO];  /* per-fifo fragmentation thresholds */
 623         u16 RTSThresh;  /* 802.11 dot11RTSThreshold */
 624         u16 SRL;                /* 802.11 dot11ShortRetryLimit */
 625         u16 LRL;                /* 802.11 dot11LongRetryLimit */
 626         u16 SFBL;               /* Short Frame Rate Fallback Limit */
 627         u16 LFBL;               /* Long Frame Rate Fallback Limit */
 628
 629         /* network config */
 630         bool shortslot;         /* currently using 11g ShortSlot timing */
 631         s8 shortslot_override;  /* 11g ShortSlot override */
 632         bool include_legacy_erp;        /* include Legacy ERP info elt ID 47 as well as g ID 42 */
 633
 634         struct wlc_protection *protection;
 635         s8 PLCPHdr_override;    /* 802.11b Preamble Type override */
 636
 637         struct wlc_stf *stf;
 638
 639         ratespec_t bcn_rspec;   /* save bcn ratespec purpose */
 640
 641         uint tempsense_lasttime;
 642
 643         u16 tx_duty_cycle_ofdm; /* maximum allowed duty cycle for OFDM */
 644         u16 tx_duty_cycle_cck;  /* maximum allowed duty cycle for CCK */
 645
 646         u16 next_bsscfg_ID;
 647
 648         struct wlc_txq_info *pkt_queue; /* txq for transmit packets */
 649         u32 mpc_dur;            /* total time (ms) in mpc mode except for the
 650                                  * portion since radio is turned off last time
 651                                  */
 652         u32 mpc_laston_ts;      /* timestamp (ms) when radio is turned off last
 653                                  * time
 654                                  */
 655         struct wiphy *wiphy;
 656 };
 657
 658 /* antsel module specific state */
 659 struct antsel_info {
 660         struct wlc_info *wlc;   /* pointer to main wlc structure */
 661         struct wlc_pub *pub;            /* pointer to public fn */
 662         u8 antsel_type; /* Type of boardlevel mimo antenna switch-logic
 663                                  * 0 = N/A, 1 = 2x4 board, 2 = 2x3 CB2 board
 664                                  */
 665         u8 antsel_antswitch;    /* board level antenna switch type */
 666         bool antsel_avail;      /* Ant selection availability (SROM based) */
 667         wlc_antselcfg_t antcfg_11n;     /* antenna configuration */
 668         wlc_antselcfg_t antcfg_cur;     /* current antenna config (auto) */
 669 };
 670
 671 #define CHANNEL_BANDUNIT(wlc, ch) (((ch) <= CH_MAX_2G_CHANNEL) ? BAND_2G_INDEX : BAND_5G_INDEX)
 672 #define OTHERBANDUNIT(wlc)      ((uint)((wlc)->band->bandunit ? BAND_2G_INDEX : BAND_5G_INDEX))
 673
 674 #define IS_MBAND_UNLOCKED(wlc) \
 675         ((NBANDS(wlc) > 1) && !(wlc)->bandlocked)
 676
 677 #define WLC_BAND_PI_RADIO_CHANSPEC wlc_phy_chanspec_get(wlc->band->pi)
 678
 679 /* sum the individual fifo tx pending packet counts */
 680 #define TXPKTPENDTOT(wlc) ((wlc)->core->txpktpend[0] + (wlc)->core->txpktpend[1] + \
 681         (wlc)->core->txpktpend[2] + (wlc)->core->txpktpend[3])
 682 #define TXPKTPENDGET(wlc, fifo)         ((wlc)->core->txpktpend[(fifo)])
 683 #define TXPKTPENDINC(wlc, fifo, val)    ((wlc)->core->txpktpend[(fifo)] += (val))
 684 #define TXPKTPENDDEC(wlc, fifo, val)    ((wlc)->core->txpktpend[(fifo)] -= (val))
 685 #define TXPKTPENDCLR(wlc, fifo)         ((wlc)->core->txpktpend[(fifo)] = 0)
 686 #define TXAVAIL(wlc, fifo)              (*(wlc)->core->txavail[(fifo)])
 687 #define GETNEXTTXP(wlc, _queue)                                                         \
 688                 dma_getnexttxp((wlc)->hw->di[(_queue)], HNDDMA_RANGE_TRANSMITTED)
 689
 690 #define WLC_IS_MATCH_SSID(wlc, ssid1, ssid2, len1, len2) \
 691         ((len1 == len2) && !memcmp(ssid1, ssid2, len1))
 692
 693 extern void wlc_fatal_error(struct wlc_info *wlc);
 694 extern void wlc_bmac_rpc_watchdog(struct wlc_info *wlc);
 695 extern void wlc_recv(struct wlc_info *wlc, struct sk_buff *p);
 696 extern bool wlc_dotxstatus(struct wlc_info *wlc, tx_status_t *txs, u32 frm_tx2);
 697 extern void wlc_txfifo(struct wlc_info *wlc, uint fifo, struct sk_buff *p,
 698                        bool commit, s8 txpktpend);
 699 extern void wlc_txfifo_complete(struct wlc_info *wlc, uint fifo, s8 txpktpend);
 700 extern void wlc_txq_enq(void *ctx, struct scb *scb, struct sk_buff *sdu,
 701                         uint prec);
 702 extern void wlc_info_init(struct wlc_info *wlc, int unit);
 703 extern void wlc_print_txstatus(tx_status_t *txs);
 704 extern int wlc_xmtfifo_sz_get(struct wlc_info *wlc, uint fifo, uint *blocks);
 705 extern void wlc_write_template_ram(struct wlc_info *wlc, int offset, int len,
 706                                    void *buf);
 707 extern void wlc_write_hw_bcntemplates(struct wlc_info *wlc, void *bcn, int len,
 708                                       bool both);
 709 extern void wlc_pllreq(struct wlc_info *wlc, bool set, mbool req_bit);
 710 extern void wlc_reset_bmac_done(struct wlc_info *wlc);
 711
 712 #if defined(BCMDBG)
 713 extern void wlc_print_rxh(d11rxhdr_t *rxh);
 714 extern void wlc_print_hdrs(struct wlc_info *wlc, const char *prefix, u8 *frame,
 715                            d11txh_t *txh, d11rxhdr_t *rxh, uint len);
 716 extern void wlc_print_txdesc(d11txh_t *txh);
 717 #else
 718 #define wlc_print_txdesc(a)
 719 #endif
 720 #if defined(BCMDBG)
 721 extern void wlc_print_dot11_mac_hdr(u8 *buf, int len);
 722 #endif
 723
 724 extern void wlc_setxband(struct wlc_hw_info *wlc_hw, uint bandunit);
 725 extern void wlc_coredisable(struct wlc_hw_info *wlc_hw);
 726
 727 extern bool wlc_valid_rate(struct wlc_info *wlc, ratespec_t rate, int band,
 728                            bool verbose);
 729 extern void wlc_ap_upd(struct wlc_info *wlc);
 730
 731 /* helper functions */
 732 extern void wlc_shm_ssid_upd(struct wlc_info *wlc, struct wlc_bsscfg *cfg);
 733 extern int wlc_set_gmode(struct wlc_info *wlc, u8 gmode, bool config);
 734
 735 extern void wlc_mac_bcn_promisc_change(struct wlc_info *wlc, bool promisc);
 736 extern void wlc_mac_bcn_promisc(struct wlc_info *wlc);
 737 extern void wlc_mac_promisc(struct wlc_info *wlc);
 738 extern void wlc_txflowcontrol(struct wlc_info *wlc, struct wlc_txq_info *qi,
 739                               bool on, int prio);
 740 extern void wlc_txflowcontrol_override(struct wlc_info *wlc,
 741                                        struct wlc_txq_info *qi,
 742                                        bool on, uint override);
 743 extern bool wlc_txflowcontrol_prio_isset(struct wlc_info *wlc,
 744                                          struct wlc_txq_info *qi, int prio);
 745 extern void wlc_send_q(struct wlc_info *wlc);
 746 extern int wlc_prep_pdu(struct wlc_info *wlc, struct sk_buff *pdu, uint *fifo);
 747
 748 extern u16 wlc_calc_lsig_len(struct wlc_info *wlc, ratespec_t ratespec,
 749                                 uint mac_len);
 750 extern ratespec_t wlc_rspec_to_rts_rspec(struct wlc_info *wlc, ratespec_t rspec,
 751                                          bool use_rspec, u16 mimo_ctlchbw);
 752 extern u16 wlc_compute_rtscts_dur(struct wlc_info *wlc, bool cts_only,
 753                                      ratespec_t rts_rate, ratespec_t frame_rate,
 754                                      u8 rts_preamble_type,
 755                                      u8 frame_preamble_type, uint frame_len,
 756                                      bool ba);
 757
 758 extern void wlc_tbtt(struct wlc_info *wlc, d11regs_t *regs);
 759 extern void wlc_inval_dma_pkts(struct wlc_hw_info *hw,
 760                                struct ieee80211_sta *sta,
 761                                void (*dma_callback_fn));
 762
 763 #if defined(BCMDBG)
 764 extern void wlc_dump_ie(struct wlc_info *wlc, bcm_tlv_t *ie,
 765                         struct bcmstrbuf *b);
 766 #endif
 767
 768 extern void wlc_reprate_init(struct wlc_info *wlc);
 769 extern void wlc_bsscfg_reprate_init(struct wlc_bsscfg *bsscfg);
 770
 771 /* Shared memory access */
 772 extern void wlc_write_shm(struct wlc_info *wlc, uint offset, u16 v);
 773 extern u16 wlc_read_shm(struct wlc_info *wlc, uint offset);
 774 extern void wlc_copyto_shm(struct wlc_info *wlc, uint offset, const void *buf,
 775                            int len);
 776
 777 extern void wlc_update_beacon(struct wlc_info *wlc);
 778 extern void wlc_bss_update_beacon(struct wlc_info *wlc,
 779                                   struct wlc_bsscfg *bsscfg);
 780
 781 extern void wlc_update_probe_resp(struct wlc_info *wlc, bool suspend);
 782 extern void wlc_bss_update_probe_resp(struct wlc_info *wlc,
 783                                       struct wlc_bsscfg *cfg, bool suspend);
 784
 785 extern bool wlc_ismpc(struct wlc_info *wlc);
 786 extern bool wlc_is_non_delay_mpc(struct wlc_info *wlc);
 787 extern void wlc_radio_mpc_upd(struct wlc_info *wlc);
 788 extern bool wlc_prec_enq(struct wlc_info *wlc, struct pktq *q, void *pkt,
 789                          int prec);
 790 extern bool wlc_prec_enq_head(struct wlc_info *wlc, struct pktq *q,
 791                               struct sk_buff *pkt, int prec, bool head);
 792 extern u16 wlc_phytxctl1_calc(struct wlc_info *wlc, ratespec_t rspec);
 793 extern void wlc_compute_plcp(struct wlc_info *wlc, ratespec_t rate, uint length,
 794                              u8 *plcp);
 795 extern uint wlc_calc_frame_time(struct wlc_info *wlc, ratespec_t ratespec,
 796                                 u8 preamble_type, uint mac_len);
 797
 798 extern void wlc_set_chanspec(struct wlc_info *wlc, chanspec_t chanspec);
 799
 800 extern bool wlc_timers_init(struct wlc_info *wlc, int unit);
 801
 802 #if defined(BCMDBG)
 803 extern void wlc_print_ies(struct wlc_info *wlc, u8 *ies, uint ies_len);
 804 #endif
 805
 806 extern int wlc_set_nmode(struct wlc_info *wlc, s32 nmode);
 807 extern void wlc_mimops_action_ht_send(struct wlc_info *wlc,
 808                                       struct wlc_bsscfg *bsscfg,
 809                                       u8 mimops_mode);
 810
 811 extern void wlc_switch_shortslot(struct wlc_info *wlc, bool shortslot);
 812 extern void wlc_set_bssid(struct wlc_bsscfg *cfg);
 813 extern void wlc_edcf_setparams(struct wlc_info *wlc, bool suspend);
 814
 815 extern void wlc_set_ratetable(struct wlc_info *wlc);
 816 extern int wlc_set_mac(struct wlc_bsscfg *cfg);
 817 extern void wlc_beacon_phytxctl_txant_upd(struct wlc_info *wlc,
 818                                           ratespec_t bcn_rate);
 819 extern void wlc_mod_prb_rsp_rate_table(struct wlc_info *wlc, uint frame_len);
 820 extern ratespec_t wlc_lowest_basic_rspec(struct wlc_info *wlc,
 821                                          wlc_rateset_t *rs);
 822 extern void wlc_radio_disable(struct wlc_info *wlc);
 823 extern void wlc_bcn_li_upd(struct wlc_info *wlc);
 824 extern void wlc_set_home_chanspec(struct wlc_info *wlc, chanspec_t chanspec);
 825 extern bool wlc_ps_allowed(struct wlc_info *wlc);
 826 extern bool wlc_stay_awake(struct wlc_info *wlc);
 827 extern void wlc_wme_initparams_sta(struct wlc_info *wlc, wme_param_ie_t *pe);
 828
 829 #endif                          /* _wlc_h_ */