2 * Copyright (c) 2010 Broadcom Corporation
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.
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.
21 #include <wlc_phy_hal.h>
22 #include <wlc_channel.h>
23 #include <wlc_bsscfg.h>
26 #define MA_WINDOW_SZ 8 /* moving average window size */
27 #define WL_HWRXOFF 38 /* chip rx buffer offset */
28 #define INVCHANNEL 255 /* invalid channel */
29 #define MAXCOREREV 28 /* max # supported core revisions (0 .. MAXCOREREV - 1) */
30 #define WLC_MAXMODULES 22 /* max # wlc_module_register() calls */
32 /* network protection config */
33 #define WLC_PROT_G_SPEC 1 /* SPEC g protection */
34 #define WLC_PROT_G_OVR 2 /* SPEC g prot override */
35 #define WLC_PROT_G_USER 3 /* gmode specified by user */
36 #define WLC_PROT_OVERLAP 4 /* overlap */
37 #define WLC_PROT_N_USER 10 /* nmode specified by user */
38 #define WLC_PROT_N_CFG 11 /* n protection */
39 #define WLC_PROT_N_CFG_OVR 12 /* n protection override */
40 #define WLC_PROT_N_NONGF 13 /* non-GF protection */
41 #define WLC_PROT_N_NONGF_OVR 14 /* non-GF protection override */
42 #define WLC_PROT_N_PAM_OVR 15 /* n preamble override */
43 #define WLC_PROT_N_OBSS 16 /* non-HT OBSS present */
45 #define WLC_BITSCNT(x) bcm_bitcount((u8 *)&(x), sizeof(u8))
47 /* Maximum wait time for a MAC suspend */
48 #define WLC_MAX_MAC_SUSPEND 83000 /* uS: 83mS is max packet time (64KB ampdu @ 6Mbps) */
50 /* Probe Response timeout - responses for probe requests older that this are tossed, zero to disable
52 #define WLC_PRB_RESP_TIMEOUT 0 /* Disable probe response timeout */
54 /* transmit buffer max headroom for protocol headers */
55 #define TXOFF (D11_TXH_LEN + D11_PHY_HDR_LEN)
57 /* For managing scan result lists */
58 typedef struct wlc_bss_list {
60 bool beacon; /* set for beacon, cleared for probe response */
61 wlc_bss_info_t *ptrs[MAXBSS];
64 #define SW_TIMER_MAC_STAT_UPD 30 /* periodic MAC stats update */
66 /* Double check that unsupported cores are not enabled */
67 #if CONF_MSK(D11CONF, 0x4f) || CONF_GE(D11CONF, MAXCOREREV)
68 #error "Configuration for D11CONF includes unsupported versions."
69 #endif /* Bad versions */
71 #define VALID_COREREV(corerev) CONF_HAS(D11CONF, corerev)
73 /* values for shortslot_override */
74 #define WLC_SHORTSLOT_AUTO -1 /* Driver will manage Shortslot setting */
75 #define WLC_SHORTSLOT_OFF 0 /* Turn off short slot */
76 #define WLC_SHORTSLOT_ON 1 /* Turn on short slot */
78 /* value for short/long and mixmode/greenfield preamble */
80 #define WLC_LONG_PREAMBLE (0)
81 #define WLC_SHORT_PREAMBLE (1 << 0)
82 #define WLC_GF_PREAMBLE (1 << 1)
83 #define WLC_MM_PREAMBLE (1 << 2)
84 #define WLC_IS_MIMO_PREAMBLE(_pre) (((_pre) == WLC_GF_PREAMBLE) || ((_pre) == WLC_MM_PREAMBLE))
86 /* values for barker_preamble */
87 #define WLC_BARKER_SHORT_ALLOWED 0 /* Short pre-amble allowed */
89 /* A fifo is full. Clear precedences related to that FIFO */
90 #define WLC_TX_FIFO_CLEAR(wlc, fifo) ((wlc)->tx_prec_map &= ~(wlc)->fifo2prec_map[fifo])
92 /* Fifo is NOT full. Enable precedences for that FIFO */
93 #define WLC_TX_FIFO_ENAB(wlc, fifo) ((wlc)->tx_prec_map |= (wlc)->fifo2prec_map[fifo])
96 /* seq and frag bits: SEQNUM_SHIFT, FRAGNUM_MASK (802.11.h) */
97 /* rate epoch bits: TXFID_RATE_SHIFT, TXFID_RATE_MASK ((wlc_rate.c) */
98 #define TXFID_QUEUE_MASK 0x0007 /* Bits 0-2 */
99 #define TXFID_SEQ_MASK 0x7FE0 /* Bits 5-15 */
100 #define TXFID_SEQ_SHIFT 5 /* Number of bit shifts */
101 #define TXFID_RATE_PROBE_MASK 0x8000 /* Bit 15 for rate probe */
102 #define TXFID_RATE_MASK 0x0018 /* Mask for bits 3 and 4 */
103 #define TXFID_RATE_SHIFT 3 /* Shift 3 bits for rate mask */
105 /* promote boardrev */
106 #define BOARDREV_PROMOTABLE 0xFF /* from */
107 #define BOARDREV_PROMOTED 1 /* to */
109 /* if wpa is in use then portopen is true when the group key is plumbed otherwise it is always true
111 #define WSEC_ENABLED(wsec) ((wsec) & (WEP_ENABLED | TKIP_ENABLED | AES_ENABLED))
112 #define WLC_SW_KEYS(wlc, bsscfg) ((((wlc)->wsec_swkeys) || \
113 ((bsscfg)->wsec & WSEC_SWFLAG)))
115 #define WLC_PORTOPEN(cfg) \
116 (((cfg)->WPA_auth != WPA_AUTH_DISABLED && WSEC_ENABLED((cfg)->wsec)) ? \
117 (cfg)->wsec_portopen : true)
119 #define PS_ALLOWED(wlc) wlc_ps_allowed(wlc)
120 #define STAY_AWAKE(wlc) wlc_stay_awake(wlc)
122 #define DATA_BLOCK_TX_SUPR (1 << 4)
124 /* 802.1D Priority to TX FIFO number for wme */
125 extern const u8 prio2fifo[];
127 /* Ucode MCTL_WAKE override bits */
128 #define WLC_WAKE_OVERRIDE_CLKCTL 0x01
129 #define WLC_WAKE_OVERRIDE_PHYREG 0x02
130 #define WLC_WAKE_OVERRIDE_MACSUSPEND 0x04
131 #define WLC_WAKE_OVERRIDE_TXFIFO 0x08
132 #define WLC_WAKE_OVERRIDE_FORCEFAST 0x10
134 /* stuff pulled in from wlc.c */
136 /* Interrupt bit error summary. Don't include I_RU: we refill DMA at other
137 * times; and if we run out, constant I_RU interrupts may cause lockup. We
138 * will still get error counts from rx0ovfl.
140 #define I_ERRORS (I_PC | I_PD | I_DE | I_RO | I_XU)
141 /* default software intmasks */
142 #define DEF_RXINTMASK (I_RI) /* enable rx int on rxfifo only */
143 #define DEF_MACINTMASK (MI_TXSTOP | MI_TBTT | MI_ATIMWINEND | MI_PMQ | \
144 MI_PHYTXERR | MI_DMAINT | MI_TFS | MI_BG_NOISE | \
145 MI_CCA | MI_TO | MI_GP0 | MI_RFDISABLE | MI_PWRUP)
147 #define RETRY_SHORT_DEF 7 /* Default Short retry Limit */
148 #define RETRY_SHORT_MAX 255 /* Maximum Short retry Limit */
149 #define RETRY_LONG_DEF 4 /* Default Long retry count */
150 #define RETRY_SHORT_FB 3 /* Short retry count for fallback rate */
151 #define RETRY_LONG_FB 2 /* Long retry count for fallback rate */
153 #define MAXTXPKTS 6 /* max # pkts pending */
156 #define MAXTXFRAMEBURST 8 /* vanilla xpress mode: max frames/burst */
157 #define MAXFRAMEBURST_TXOP 10000 /* Frameburst TXOP in usec */
159 /* Per-AC retry limit register definitions; uses bcmdefs.h bitfield macros */
160 #define EDCF_SHORT_S 0
162 #define EDCF_LONG_S 8
163 #define EDCF_LFB_S 12
164 #define EDCF_SHORT_M BITFIELD_MASK(4)
165 #define EDCF_SFB_M BITFIELD_MASK(4)
166 #define EDCF_LONG_M BITFIELD_MASK(4)
167 #define EDCF_LFB_M BITFIELD_MASK(4)
169 #define WLC_WME_RETRY_SHORT_GET(wlc, ac) GFIELD(wlc->wme_retries[ac], EDCF_SHORT)
170 #define WLC_WME_RETRY_SFB_GET(wlc, ac) GFIELD(wlc->wme_retries[ac], EDCF_SFB)
171 #define WLC_WME_RETRY_LONG_GET(wlc, ac) GFIELD(wlc->wme_retries[ac], EDCF_LONG)
172 #define WLC_WME_RETRY_LFB_GET(wlc, ac) GFIELD(wlc->wme_retries[ac], EDCF_LFB)
174 #define WLC_WME_RETRY_SHORT_SET(wlc, ac, val) \
175 (wlc->wme_retries[ac] = SFIELD(wlc->wme_retries[ac], EDCF_SHORT, val))
176 #define WLC_WME_RETRY_SFB_SET(wlc, ac, val) \
177 (wlc->wme_retries[ac] = SFIELD(wlc->wme_retries[ac], EDCF_SFB, val))
178 #define WLC_WME_RETRY_LONG_SET(wlc, ac, val) \
179 (wlc->wme_retries[ac] = SFIELD(wlc->wme_retries[ac], EDCF_LONG, val))
180 #define WLC_WME_RETRY_LFB_SET(wlc, ac, val) \
181 (wlc->wme_retries[ac] = SFIELD(wlc->wme_retries[ac], EDCF_LFB, val))
184 #define WLC_PLLREQ_SHARED 0x1 /* pll is shared on old chips */
185 #define WLC_PLLREQ_RADIO_MON 0x2 /* hold pll for radio monitor register checking */
186 #define WLC_PLLREQ_FLIP 0x4 /* hold/release pll for some short operation */
188 /* Do we support this rate? */
189 #define VALID_RATE_DBG(wlc, rspec) wlc_valid_rate(wlc, rspec, WLC_BAND_AUTO, true)
192 * Macros to check if AP or STA is active.
193 * AP Active means more than just configured: driver and BSS are "up";
194 * that is, we are beaconing/responding as an AP (aps_associated).
195 * STA Active similarly means the driver is up and a configured STA BSS
196 * is up: either associated (stas_associated) or trying.
198 * Macro definitions vary as per AP/STA ifdefs, allowing references to
199 * ifdef'd structure fields and constant values (0) for optimization.
200 * Make sure to enclose blocks of code such that any routines they
201 * reference can also be unused and optimized out by the linker.
203 /* NOTE: References structure fields defined in wlc.h */
204 #define AP_ACTIVE(wlc) (0)
207 * Detect Card removed.
208 * Even checking an sbconfig register read will not false trigger when the core is in reset.
209 * it breaks CF address mechanism. Accessing gphy phyversion will cause SB error if aphy
210 * is in reset on 4306B0-DB. Need a simple accessible reg with fixed 0/1 pattern
211 * (some platforms return all 0).
212 * If clocks are present, call the sb routine which will figure out if the device is removed.
214 #define DEVICEREMOVED(wlc) \
216 ((R_REG(wlc->hw->osh, &wlc->hw->regs->maccontrol) & \
217 (MCTL_PSM_JMP_0 | MCTL_IHR_EN)) != MCTL_IHR_EN) : \
218 (si_deviceremoved(wlc->hw->sih)))
220 #define WLCWLUNIT(wlc) ((wlc)->pub->unit)
222 typedef struct wlc_protection {
223 bool _g; /* use g spec protection, driver internal */
224 s8 g_override; /* override for use of g spec protection */
225 u8 gmode_user; /* user config gmode, operating band->gmode is different */
226 s8 overlap; /* Overlap BSS/IBSS protection for both 11g and 11n */
227 s8 nmode_user; /* user config nmode, operating pub->nmode is different */
228 s8 n_cfg; /* use OFDM protection on MIMO frames */
229 s8 n_cfg_override; /* override for use of N protection */
230 bool nongf; /* non-GF present protection */
231 s8 nongf_override; /* override for use of GF protection */
232 s8 n_pam_override; /* override for preamble: MM or GF */
233 bool n_obss; /* indicated OBSS Non-HT STA present */
235 uint longpre_detect_timeout; /* #sec until long preamble bcns gone */
236 uint barker_detect_timeout; /* #sec until bcns signaling Barker long preamble */
238 uint ofdm_ibss_timeout; /* #sec until ofdm IBSS beacons gone */
239 uint ofdm_ovlp_timeout; /* #sec until ofdm overlapping BSS bcns gone */
240 uint nonerp_ibss_timeout; /* #sec until nonerp IBSS beacons gone */
241 uint nonerp_ovlp_timeout; /* #sec until nonerp overlapping BSS bcns gone */
242 uint g_ibss_timeout; /* #sec until bcns signaling Use_Protection gone */
243 uint n_ibss_timeout; /* #sec until bcns signaling Use_OFDM_Protection gone */
244 uint ht20in40_ovlp_timeout; /* #sec until 20MHz overlapping OPMODE gone */
245 uint ht20in40_ibss_timeout; /* #sec until 20MHz-only HT station bcns gone */
246 uint non_gf_ibss_timeout; /* #sec until non-GF bcns gone */
249 /* anything affects the single/dual streams/antenna operation */
250 typedef struct wlc_stf {
251 u8 hw_txchain; /* HW txchain bitmap cfg */
252 u8 txchain; /* txchain bitmap being used */
253 u8 txstreams; /* number of txchains being used */
255 u8 hw_rxchain; /* HW rxchain bitmap cfg */
256 u8 rxchain; /* rxchain bitmap being used */
257 u8 rxstreams; /* number of rxchains being used */
259 u8 ant_rx_ovr; /* rx antenna override */
260 s8 txant; /* userTx antenna setting */
261 u16 phytxant; /* phyTx antenna setting in txheader */
263 u8 ss_opmode; /* singlestream Operational mode, 0:siso; 1:cdd */
264 bool ss_algosel_auto; /* if true, use wlc->stf->ss_algo_channel; */
265 /* else use wlc->band->stf->ss_mode_band; */
266 u16 ss_algo_channel; /* ss based on per-channel algo: 0: SISO, 1: CDD 2: STBC */
267 u8 no_cddstbc; /* stf override, 1: no CDD (or STBC) allowed */
269 u8 rxchain_restore_delay; /* delay time to restore default rxchain */
271 s8 ldpc; /* AUTO/ON/OFF ldpc cap supported */
272 u8 txcore[MAX_STREAMS_SUPPORTED + 1]; /* bitmap of selected core for each Nsts */
276 #define WLC_STF_SS_STBC_TX(wlc, scb) \
277 (((wlc)->stf->txstreams > 1) && (((wlc)->band->band_stf_stbc_tx == ON) || \
278 (SCB_STBC_CAP((scb)) && \
279 (wlc)->band->band_stf_stbc_tx == AUTO && \
280 isset(&((wlc)->stf->ss_algo_channel), PHY_TXC1_MODE_STBC))))
282 #define WLC_STBC_CAP_PHY(wlc) (WLCISNPHY(wlc->band) && NREV_GE(wlc->band->phyrev, 3))
284 #define WLC_SGI_CAP_PHY(wlc) ((WLCISNPHY(wlc->band) && NREV_GE(wlc->band->phyrev, 3)) || \
285 WLCISLCNPHY(wlc->band))
287 #define WLC_CHAN_PHYTYPE(x) (((x) & RXS_CHAN_PHYTYPE_MASK) >> RXS_CHAN_PHYTYPE_SHIFT)
288 #define WLC_CHAN_CHANNEL(x) (((x) & RXS_CHAN_ID_MASK) >> RXS_CHAN_ID_SHIFT)
289 #define WLC_RX_CHANNEL(rxh) (WLC_CHAN_CHANNEL((rxh)->RxChan))
291 /* wlc_bss_info flag bit values */
292 #define WLC_BSS_HT 0x0020 /* BSS is HT (MIMO) capable */
294 /* Flags used in wlc_txq_info.stopped */
295 #define TXQ_STOP_FOR_PRIOFC_MASK 0x000000FF /* per prio flow control bits */
296 #define TXQ_STOP_FOR_PKT_DRAIN 0x00000100 /* stop txq enqueue for packet drain */
297 #define TXQ_STOP_FOR_AMPDU_FLOW_CNTRL 0x00000200 /* stop txq enqueue for ampdu flow control */
299 #define WLC_HT_WEP_RESTRICT 0x01 /* restrict HT with WEP */
300 #define WLC_HT_TKIP_RESTRICT 0x02 /* restrict HT with TKIP */
306 uint coreidx; /* # sb enumerated core */
309 uint *txavail[NFIFO]; /* # tx descriptors available */
310 s16 txpktpend[NFIFO]; /* tx admission control */
312 macstat_t *macstat_snapshot; /* mac hw prev read values */
316 * band state (phy+ana+radio)
319 int bandtype; /* WLC_BAND_2G, WLC_BAND_5G */
320 uint bandunit; /* bandstate[] index */
322 u16 phytype; /* phytype */
326 wlc_phy_t *pi; /* pointer to phy specific information */
329 u8 gmode; /* currently active gmode (see wlioctl.h) */
331 struct scb *hwrs_scb; /* permanent scb for hw rateset */
333 wlc_rateset_t defrateset; /* band-specific copy of default_bss.rateset */
335 ratespec_t rspec_override; /* 802.11 rate override */
336 ratespec_t mrspec_override; /* multicast rate override */
337 u8 band_stf_ss_mode; /* Configured STF type, 0:siso; 1:cdd */
338 s8 band_stf_stbc_tx; /* STBC TX 0:off; 1:force on; -1:auto */
339 wlc_rateset_t hw_rateset; /* rates supported by chip (phy-specific) */
340 u8 basic_rate[WLC_MAXRATE + 1]; /* basic rates indexed by rate */
341 bool mimo_cap_40; /* 40 MHz cap enabled on this band */
342 s8 antgain; /* antenna gain from srom */
344 u16 CWmin; /* The minimum size of contention window, in unit of aSlotTime */
345 u16 CWmax; /* The maximum size of contention window, in unit of aSlotTime */
346 u16 bcntsfoff; /* beacon tsf offset */
349 /* generic function callback takes just one arg */
350 typedef void (*cb_fn_t) (void *);
352 /* tx completion callback takes 3 args */
353 typedef void (*pkcb_fn_t) (struct wlc_info *wlc, uint txstatus, void *arg);
355 typedef struct pkt_cb {
356 pkcb_fn_t fn; /* function to call when tx frame completes */
357 void *arg; /* void arg for fn */
358 u8 nextidx; /* index of next call back if threading */
359 bool entered; /* recursion check */
362 /* module control blocks */
363 typedef struct modulecb {
364 char name[32]; /* module name : NULL indicates empty array member */
365 const bcm_iovar_t *iovars; /* iovar table */
366 void *hdl; /* handle passed when handler 'doiovar' is called */
367 watchdog_fn_t watchdog_fn; /* watchdog handler */
368 iovar_fn_t iovar_fn; /* iovar handler */
369 down_fn_t down_fn; /* down handler. Note: the int returned
370 * by the down function is a count of the
371 * number of timers that could not be
376 /* dump control blocks */
377 typedef struct dumpcb_s {
378 const char *name; /* dump name */
379 dump_fn_t dump_fn; /* 'wl dump' handler */
381 struct dumpcb_s *next;
384 /* virtual interface */
387 u8 type; /* WLC_IFTYPE_BSS or WLC_IFTYPE_WDS */
388 u8 index; /* assigned in wl_add_if(), index of the wlif if any,
389 * not necessarily corresponding to bsscfg._idx or
392 u8 flags; /* flags for the interface */
393 struct wl_if *wlif; /* pointer to wlif */
394 struct wlc_txq_info *qi; /* pointer to associated tx queue */
396 struct scb *scb; /* pointer to scb if WLC_IFTYPE_WDS */
397 struct wlc_bsscfg *bsscfg; /* pointer to bsscfg if WLC_IFTYPE_BSS */
401 /* flags for the interface */
402 #define WLC_IF_LINKED 0x02 /* this interface is linked to a wl_if */
404 typedef struct wlc_hwband {
405 int bandtype; /* WLC_BAND_2G, WLC_BAND_5G */
406 uint bandunit; /* bandstate[] index */
407 u16 mhfs[MHFMAX]; /* MHF array shadow */
408 u8 bandhw_stf_ss_mode; /* HW configured STF type, 0:siso; 1:cdd */
413 u16 phytype; /* phytype */
417 wlc_phy_t *pi; /* pointer to phy specific information */
422 struct osl_info *osh; /* pointer to os handle */
423 bool _piomode; /* true if pio mode */
424 struct wlc_info *wlc;
427 struct hnddma_pub *di[NFIFO]; /* hnddma handles, per fifo */
429 uint unit; /* device instance number */
432 u16 vendorid; /* PCI vendor id */
433 u16 deviceid; /* PCI device id */
434 uint corerev; /* core revision */
435 u8 sromrev; /* version # of the srom */
436 u16 boardrev; /* version # of particular board */
437 u32 boardflags; /* Board specific flags from srom */
438 u32 boardflags2; /* More board flags if sromrev >= 4 */
439 u32 machwcap; /* MAC capabilities (corerev >= 13) */
440 u32 machwcap_backup; /* backup of machwcap (corerev >= 13) */
441 u16 ucode_dbgsel; /* dbgsel for ucode debug(config gpio) */
443 si_t *sih; /* SB handle (cookie for siutils calls) */
444 char *vars; /* "environment" name=value */
445 uint vars_size; /* size of vars, free vars on detach */
446 d11regs_t *regs; /* pointer to device registers */
447 void *physhim; /* phy shim layer handler */
448 void *phy_sh; /* pointer to shared phy state */
449 wlc_hwband_t *band; /* pointer to active per-band state */
450 wlc_hwband_t *bandstate[MAXBANDS]; /* per-band state (one per phy/radio) */
451 u16 bmac_phytxant; /* cache of high phytxant state */
452 bool shortslot; /* currently using 11g ShortSlot timing */
453 u16 SRL; /* 802.11 dot11ShortRetryLimit */
454 u16 LRL; /* 802.11 dot11LongRetryLimit */
455 u16 SFBL; /* Short Frame Rate Fallback Limit */
456 u16 LFBL; /* Long Frame Rate Fallback Limit */
458 bool up; /* d11 hardware up and running */
459 uint now; /* # elapsed seconds */
460 uint _nbands; /* # bands supported */
461 chanspec_t chanspec; /* bmac chanspec shadow */
463 uint *txavail[NFIFO]; /* # tx descriptors available */
464 u16 *xmtfifo_sz; /* fifo size in 256B for each xmt fifo */
466 mbool pllreq; /* pll requests to keep PLL on */
468 u8 suspended_fifos; /* Which TX fifo to remain awake for */
469 u32 maccontrol; /* Cached value of maccontrol */
470 uint mac_suspend_depth; /* current depth of mac_suspend levels */
471 u32 wake_override; /* Various conditions to force MAC to WAKE mode */
472 u32 mute_override; /* Prevent ucode from sending beacons */
473 u8 etheraddr[ETH_ALEN]; /* currently configured ethernet address */
474 u32 led_gpio_mask; /* LED GPIO Mask */
475 bool noreset; /* true= do not reset hw, used by WLC_OUT */
476 bool forcefastclk; /* true if the h/w is forcing the use of fast clk */
477 bool clk; /* core is out of reset and has clock */
478 bool sbclk; /* sb has clock */
479 struct bmac_pmq *bmac_pmq; /* bmac PM states derived from ucode PMQ */
480 bool phyclk; /* phy is out of reset and has clock */
481 bool dma_lpbk; /* core is in DMA loopback */
483 bool ucode_loaded; /* true after ucode downloaded */
486 u8 hw_stf_ss_opmode; /* STF single stream operation mode */
487 u8 antsel_type; /* Type of boardlevel mimo antenna switch-logic
488 * 0 = N/A, 1 = 2x4 board, 2 = 2x3 CB2 board
491 * put struct antsel_info here if more info is
496 /* TX Queue information
498 * Each flow of traffic out of the device has a TX Queue with independent
499 * flow control. Several interfaces may be associated with a single TX Queue
500 * if they belong to the same flow of traffic from the device. For multi-channel
501 * operation there are independent TX Queues for each channel.
503 typedef struct wlc_txq_info {
504 struct wlc_txq_info *next;
506 uint stopped; /* tx flow control bits */
510 * Principal common (os-independent) software data structure.
513 struct wlc_pub *pub; /* pointer to wlc public state */
514 struct osl_info *osh; /* pointer to os handle */
515 struct wl_info *wl; /* pointer to os-specific private state */
516 d11regs_t *regs; /* pointer to device registers */
518 struct wlc_hw_info *hw; /* HW related state used primarily by BMAC */
521 int clkreq_override; /* setting for clkreq for PCIE : Auto, 0, 1 */
522 u16 fastpwrup_dly; /* time in us needed to bring up d11 fast clock */
525 u32 macintstatus; /* bit channel between isr and dpc */
526 u32 macintmask; /* sw runtime master macintmask value */
527 u32 defmacintmask; /* default "on" macintmask value */
530 bool device_present; /* (removable) device is present */
532 bool clk; /* core is out of reset and has clock */
535 struct wlccore *core; /* pointer to active io core */
536 struct wlcband *band; /* pointer to active per-band state */
537 struct wlccore *corestate; /* per-core state (one per hw core) */
538 /* per-band state (one per phy/radio): */
539 struct wlcband *bandstate[MAXBANDS];
541 bool war16165; /* PCI slow clock 16165 war flag */
543 bool tx_suspended; /* data fifos need to remain suspended */
548 uint qvalid; /* DirFrmQValid and BcMcFrmQValid */
550 /* Regulatory power limits */
551 s8 txpwr_local_max; /* regulatory local txpwr max */
552 u8 txpwr_local_constraint; /* local power contraint in dB */
555 struct ampdu_info *ampdu; /* ampdu module handler */
556 struct antsel_info *asi; /* antsel module handler */
557 wlc_cm_info_t *cmi; /* channel manager module handler */
559 void *btparam; /* bus type specific cookie */
561 uint vars_size; /* size of vars, free vars on detach */
563 u16 vendorid; /* PCI vendor id */
564 u16 deviceid; /* PCI device id */
565 uint ucode_rev; /* microcode revision */
567 u32 machwcap; /* MAC capabilities, BMAC shadow */
569 u8 perm_etheraddr[ETH_ALEN]; /* original sprom local ethernet address */
571 bool bandlocked; /* disable auto multi-band switching */
572 bool bandinit_pending; /* track band init in auto band */
574 bool radio_monitor; /* radio timer is running */
575 bool down_override; /* true=down */
576 bool going_down; /* down path intermediate variable */
578 bool mpc; /* enable minimum power consumption */
579 u8 mpc_dlycnt; /* # of watchdog cnt before turn disable radio */
580 u8 mpc_offcnt; /* # of watchdog cnt that radio is disabled */
581 u8 mpc_delay_off; /* delay radio disable by # of watchdog cnt */
582 u8 prev_non_delay_mpc; /* prev state wlc_is_non_delay_mpc */
585 struct wl_timer *wdtimer; /* timer for watchdog routine */
586 uint fast_timer; /* Periodic timeout for 'fast' timer */
587 uint slow_timer; /* Periodic timeout for 'slow' timer */
588 uint glacial_timer; /* Periodic timeout for 'glacial' timer */
589 uint phycal_mlo; /* last time measurelow calibration was done */
590 uint phycal_txpower; /* last time txpower calibration was done */
592 struct wl_timer *radio_timer; /* timer for hw radio button monitor routine */
593 struct wl_timer *pspoll_timer; /* periodic pspoll timer */
596 bool monitor; /* monitor (MPDU sniffing) mode */
597 bool bcnmisc_ibss; /* bcns promisc mode override for IBSS */
598 bool bcnmisc_scan; /* bcns promisc mode override for scan */
599 bool bcnmisc_monitor; /* bcns promisc mode override for monitor */
601 u8 bcn_wait_prd; /* max waiting period (for beacon) in 1024TU */
604 bool _rifs; /* enable per-packet rifs */
605 s32 rifs_advert; /* RIFS mode advertisement */
606 s8 sgi_tx; /* sgi tx */
607 bool wet; /* true if wireless ethernet bridging mode */
609 /* AP-STA synchronization, power save */
610 bool check_for_unaligned_tbtt; /* check unaligned tbtt flag */
611 bool PM_override; /* no power-save flag, override PM(user input) */
612 bool PMenabled; /* current power-management state (CAM or PS) */
613 bool PMpending; /* waiting for tx status with PM indicated set */
614 bool PMblocked; /* block any PSPolling in PS mode, used to buffer
615 * AP traffic, also used to indicate in progress
616 * of scan, rm, etc. off home channel activity.
618 bool PSpoll; /* whether there is an outstanding PS-Poll frame */
619 u8 PM; /* power-management mode (CAM, PS or FASTPS) */
620 bool PMawakebcn; /* bcn recvd during current waking state */
622 bool WME_PM_blocked; /* Can STA go to PM when in WME Auto mode */
623 bool wake; /* host-specified PS-mode sleep state */
624 u8 pspoll_prd; /* pspoll interval in milliseconds */
625 u8 bcn_li_bcn; /* beacon listen interval in # beacons */
626 u8 bcn_li_dtim; /* beacon listen interval in # dtims */
628 bool WDarmed; /* watchdog timer is armed */
629 u32 WDlast; /* last time wlc_watchdog() was called */
632 ac_bitmap_t wme_dp; /* Discard (oldest first) policy per AC */
633 bool wme_apsd; /* enable Advanced Power Save Delivery */
634 ac_bitmap_t wme_admctl; /* bit i set if AC i under admission control */
635 u16 edcf_txop[AC_COUNT]; /* current txop for each ac */
636 wme_param_ie_t wme_param_ie; /* WME parameter info element, which on STA
637 * contains parameters in use locally, and on
638 * AP contains parameters advertised to STA
639 * in beacons and assoc responses.
641 bool wme_prec_queuing; /* enable/disable non-wme STA prec queuing */
642 u16 wme_retries[AC_COUNT]; /* per-AC retry limits */
644 int vlan_mode; /* OK to use 802.1Q Tags (ON, OFF, AUTO) */
645 u16 tx_prec_map; /* Precedence map based on HW FIFO space */
646 u16 fifo2prec_map[NFIFO]; /* pointer to fifo2_prec map based on WME */
648 /* BSS Configurations */
649 wlc_bsscfg_t *bsscfg[WLC_MAXBSSCFG]; /* set of BSS configurations, idx 0 is default and
652 wlc_bsscfg_t *cfg; /* the primary bsscfg (can be AP or STA) */
653 u8 stas_associated; /* count of ASSOCIATED STA bsscfgs */
654 u8 aps_associated; /* count of UP AP bsscfgs */
655 u8 block_datafifo; /* prohibit posting frames to data fifos */
656 bool bcmcfifo_drain; /* TX_BCMC_FIFO is set to drain */
659 wlc_txq_info_t *tx_queues; /* common TX Queue list */
662 wlc_eventq_t *eventq; /* event queue for deferred processing */
665 wsec_key_t *wsec_keys[WSEC_MAX_KEYS]; /* dynamic key storage */
666 wsec_key_t *wsec_def_keys[WLC_DEFAULT_KEYS]; /* default key storage */
667 bool wsec_swkeys; /* indicates that all keys should be
668 * treated as sw keys (used for debugging)
670 modulecb_t *modulecb;
671 dumpcb_t *dumpcb_head;
673 u8 mimoft; /* SIGN or 11N */
674 u8 mimo_band_bwcap; /* bw cap per band type */
675 s8 txburst_limit_override; /* tx burst limit override */
676 u16 txburst_limit; /* tx burst limit value */
677 s8 cck_40txbw; /* 11N, cck tx b/w override when in 40MHZ mode */
678 s8 ofdm_40txbw; /* 11N, ofdm tx b/w override when in 40MHZ mode */
679 s8 mimo_40txbw; /* 11N, mimo tx b/w override when in 40MHZ mode */
680 /* HT CAP IE being advertised by this node: */
681 struct ieee80211_ht_cap ht_cap;
683 uint seckeys; /* 54 key table shm address */
684 uint tkmickeys; /* 12 TKIP MIC key table shm address */
686 wlc_bss_info_t *default_bss; /* configured BSS parameters */
688 u16 AID; /* association ID */
689 u16 counter; /* per-sdu monotonically increasing counter */
690 u16 mc_fid_counter; /* BC/MC FIFO frame ID counter */
692 bool ibss_allowed; /* false, all IBSS will be ignored during a scan
693 * and the driver will not allow the creation of
696 bool ibss_coalesce_allowed;
698 char country_default[WLC_CNTRY_BUF_SZ]; /* saved country for leaving 802.11d
701 char autocountry_default[WLC_CNTRY_BUF_SZ]; /* initial country for 802.11d
705 bcm_tlv_t *country_ie_override; /* debug override of announced Country IE */
708 u16 prb_resp_timeout; /* do not send prb resp if request older than this,
712 wlc_rateset_t sup_rates_override; /* use only these rates in 11g supported rates if
716 chanspec_t home_chanspec; /* shared home chanspec */
719 chanspec_t chanspec; /* target operational channel */
720 u16 usr_fragthresh; /* user configured fragmentation threshold */
721 u16 fragthresh[NFIFO]; /* per-fifo fragmentation thresholds */
722 u16 RTSThresh; /* 802.11 dot11RTSThreshold */
723 u16 SRL; /* 802.11 dot11ShortRetryLimit */
724 u16 LRL; /* 802.11 dot11LongRetryLimit */
725 u16 SFBL; /* Short Frame Rate Fallback Limit */
726 u16 LFBL; /* Long Frame Rate Fallback Limit */
729 bool shortpreamble; /* currently operating with CCK ShortPreambles */
730 bool shortslot; /* currently using 11g ShortSlot timing */
731 s8 barker_preamble; /* current Barker Preamble Mode */
732 s8 shortslot_override; /* 11g ShortSlot override */
733 bool include_legacy_erp; /* include Legacy ERP info elt ID 47 as well as g ID 42 */
734 bool barker_overlap_control; /* true: be aware of overlapping BSSs for barker */
735 bool ignore_bcns; /* override: ignore non shortslot bcns in a 11g network */
736 bool legacy_probe; /* restricts probe requests to CCK rates */
738 wlc_protection_t *protection;
739 s8 PLCPHdr_override; /* 802.11b Preamble Type override */
743 pkt_cb_t *pkt_callback; /* tx completion callback handlers */
745 u32 txretried; /* tx retried number in one msdu */
747 ratespec_t bcn_rspec; /* save bcn ratespec purpose */
749 bool apsd_sta_usp; /* Unscheduled Service Period in progress on STA */
750 struct wl_timer *apsd_trigger_timer; /* timer for wme apsd trigger frames */
751 u32 apsd_trigger_timeout; /* timeout value for apsd_trigger_timer (in ms)
754 ac_bitmap_t apsd_trigger_ac; /* Permissible Acess Category in which APSD Null
755 * Trigger frames can be send
757 u8 htphy_membership; /* HT PHY membership */
759 bool _regulatory_domain; /* 802.11d enabled? */
763 u8 txpwr_percent; /* power output percentage */
765 u8 ht_wsec_restriction; /* the restriction of HT with TKIP or WEP */
767 uint tempsense_lasttime;
769 u16 tx_duty_cycle_ofdm; /* maximum allowed duty cycle for OFDM */
770 u16 tx_duty_cycle_cck; /* maximum allowed duty cycle for CCK */
774 struct wlc_if *wlcif_list; /* linked list of wlc_if structs */
775 wlc_txq_info_t *active_queue; /* txq for the currently active transmit context */
776 u32 mpc_dur; /* total time (ms) in mpc mode except for the
777 * portion since radio is turned off last time
779 u32 mpc_laston_ts; /* timestamp (ms) when radio is turned off last
786 /* antsel module specific state */
788 struct wlc_info *wlc; /* pointer to main wlc structure */
789 struct wlc_pub *pub; /* pointer to public fn */
790 u8 antsel_type; /* Type of boardlevel mimo antenna switch-logic
791 * 0 = N/A, 1 = 2x4 board, 2 = 2x3 CB2 board
793 u8 antsel_antswitch; /* board level antenna switch type */
794 bool antsel_avail; /* Ant selection availability (SROM based) */
795 wlc_antselcfg_t antcfg_11n; /* antenna configuration */
796 wlc_antselcfg_t antcfg_cur; /* current antenna config (auto) */
799 #define CHANNEL_BANDUNIT(wlc, ch) (((ch) <= CH_MAX_2G_CHANNEL) ? BAND_2G_INDEX : BAND_5G_INDEX)
800 #define OTHERBANDUNIT(wlc) ((uint)((wlc)->band->bandunit ? BAND_2G_INDEX : BAND_5G_INDEX))
802 #define IS_MBAND_UNLOCKED(wlc) \
803 ((NBANDS(wlc) > 1) && !(wlc)->bandlocked)
805 #define WLC_BAND_PI_RADIO_CHANSPEC wlc_phy_chanspec_get(wlc->band->pi)
807 /* sum the individual fifo tx pending packet counts */
808 #define TXPKTPENDTOT(wlc) ((wlc)->core->txpktpend[0] + (wlc)->core->txpktpend[1] + \
809 (wlc)->core->txpktpend[2] + (wlc)->core->txpktpend[3])
810 #define TXPKTPENDGET(wlc, fifo) ((wlc)->core->txpktpend[(fifo)])
811 #define TXPKTPENDINC(wlc, fifo, val) ((wlc)->core->txpktpend[(fifo)] += (val))
812 #define TXPKTPENDDEC(wlc, fifo, val) ((wlc)->core->txpktpend[(fifo)] -= (val))
813 #define TXPKTPENDCLR(wlc, fifo) ((wlc)->core->txpktpend[(fifo)] = 0)
814 #define TXAVAIL(wlc, fifo) (*(wlc)->core->txavail[(fifo)])
815 #define GETNEXTTXP(wlc, _queue) \
816 dma_getnexttxp((wlc)->hw->di[(_queue)], HNDDMA_RANGE_TRANSMITTED)
818 #define WLC_IS_MATCH_SSID(wlc, ssid1, ssid2, len1, len2) \
819 ((len1 == len2) && !memcmp(ssid1, ssid2, len1))
821 extern void wlc_high_dpc(struct wlc_info *wlc, u32 macintstatus);
822 extern void wlc_fatal_error(struct wlc_info *wlc);
823 extern void wlc_bmac_rpc_watchdog(struct wlc_info *wlc);
824 extern void wlc_recv(struct wlc_info *wlc, struct sk_buff *p);
825 extern bool wlc_dotxstatus(struct wlc_info *wlc, tx_status_t *txs, u32 frm_tx2);
826 extern void wlc_txfifo(struct wlc_info *wlc, uint fifo, struct sk_buff *p,
827 bool commit, s8 txpktpend);
828 extern void wlc_txfifo_complete(struct wlc_info *wlc, uint fifo, s8 txpktpend);
829 extern void wlc_txq_enq(void *ctx, struct scb *scb, struct sk_buff *sdu,
831 extern void wlc_info_init(struct wlc_info *wlc, int unit);
832 extern void wlc_print_txstatus(tx_status_t *txs);
833 extern int wlc_xmtfifo_sz_get(struct wlc_info *wlc, uint fifo, uint *blocks);
834 extern void wlc_write_template_ram(struct wlc_info *wlc, int offset, int len,
836 extern void wlc_write_hw_bcntemplates(struct wlc_info *wlc, void *bcn, int len,
839 extern void wlc_get_rcmta(struct wlc_info *wlc, int idx,
842 extern void wlc_set_rcmta(struct wlc_info *wlc, int idx,
844 extern void wlc_set_addrmatch(struct wlc_info *wlc, int match_reg_offset,
846 extern void wlc_read_tsf(struct wlc_info *wlc, u32 *tsf_l_ptr,
848 extern void wlc_set_cwmin(struct wlc_info *wlc, u16 newmin);
849 extern void wlc_set_cwmax(struct wlc_info *wlc, u16 newmax);
850 extern void wlc_fifoerrors(struct wlc_info *wlc);
851 extern void wlc_pllreq(struct wlc_info *wlc, bool set, mbool req_bit);
852 extern void wlc_reset_bmac_done(struct wlc_info *wlc);
853 extern void wlc_protection_upd(struct wlc_info *wlc, uint idx, int val);
854 extern void wlc_hwtimer_gptimer_set(struct wlc_info *wlc, uint us);
855 extern void wlc_hwtimer_gptimer_abort(struct wlc_info *wlc);
858 extern void wlc_print_rxh(d11rxhdr_t *rxh);
859 extern void wlc_print_hdrs(struct wlc_info *wlc, const char *prefix, u8 *frame,
860 d11txh_t *txh, d11rxhdr_t *rxh, uint len);
861 extern void wlc_print_txdesc(d11txh_t *txh);
864 extern void wlc_print_dot11_mac_hdr(u8 *buf, int len);
867 extern void wlc_setxband(struct wlc_hw_info *wlc_hw, uint bandunit);
868 extern void wlc_coredisable(struct wlc_hw_info *wlc_hw);
870 extern bool wlc_valid_rate(struct wlc_info *wlc, ratespec_t rate, int band,
872 extern void wlc_ap_upd(struct wlc_info *wlc);
874 /* helper functions */
875 extern void wlc_shm_ssid_upd(struct wlc_info *wlc, wlc_bsscfg_t *cfg);
876 extern int wlc_set_gmode(struct wlc_info *wlc, u8 gmode, bool config);
878 extern void wlc_mac_bcn_promisc_change(struct wlc_info *wlc, bool promisc);
879 extern void wlc_mac_bcn_promisc(struct wlc_info *wlc);
880 extern void wlc_mac_promisc(struct wlc_info *wlc);
881 extern void wlc_txflowcontrol(struct wlc_info *wlc, wlc_txq_info_t *qi, bool on,
883 extern void wlc_txflowcontrol_override(struct wlc_info *wlc, wlc_txq_info_t *qi,
884 bool on, uint override);
885 extern bool wlc_txflowcontrol_prio_isset(struct wlc_info *wlc,
886 wlc_txq_info_t *qi, int prio);
887 extern void wlc_send_q(struct wlc_info *wlc, wlc_txq_info_t *qi);
888 extern int wlc_prep_pdu(struct wlc_info *wlc, struct sk_buff *pdu, uint *fifo);
890 extern u16 wlc_calc_lsig_len(struct wlc_info *wlc, ratespec_t ratespec,
892 extern ratespec_t wlc_rspec_to_rts_rspec(struct wlc_info *wlc, ratespec_t rspec,
893 bool use_rspec, u16 mimo_ctlchbw);
894 extern u16 wlc_compute_rtscts_dur(struct wlc_info *wlc, bool cts_only,
895 ratespec_t rts_rate, ratespec_t frame_rate,
896 u8 rts_preamble_type,
897 u8 frame_preamble_type, uint frame_len,
900 extern void wlc_tbtt(struct wlc_info *wlc, d11regs_t *regs);
903 extern void wlc_dump_ie(struct wlc_info *wlc, bcm_tlv_t *ie,
904 struct bcmstrbuf *b);
907 extern bool wlc_ps_check(struct wlc_info *wlc);
908 extern void wlc_reprate_init(struct wlc_info *wlc);
909 extern void wlc_bsscfg_reprate_init(wlc_bsscfg_t *bsscfg);
910 extern void wlc_uint64_sub(u32 *a_high, u32 *a_low, u32 b_high,
912 extern u32 wlc_calc_tbtt_offset(u32 bi, u32 tsf_h, u32 tsf_l);
914 /* Shared memory access */
915 extern void wlc_write_shm(struct wlc_info *wlc, uint offset, u16 v);
916 extern u16 wlc_read_shm(struct wlc_info *wlc, uint offset);
917 extern void wlc_set_shm(struct wlc_info *wlc, uint offset, u16 v, int len);
918 extern void wlc_copyto_shm(struct wlc_info *wlc, uint offset, const void *buf,
920 extern void wlc_copyfrom_shm(struct wlc_info *wlc, uint offset, void *buf,
923 extern void wlc_update_beacon(struct wlc_info *wlc);
924 extern void wlc_bss_update_beacon(struct wlc_info *wlc,
925 struct wlc_bsscfg *bsscfg);
927 extern void wlc_update_probe_resp(struct wlc_info *wlc, bool suspend);
928 extern void wlc_bss_update_probe_resp(struct wlc_info *wlc, wlc_bsscfg_t *cfg,
931 extern bool wlc_ismpc(struct wlc_info *wlc);
932 extern bool wlc_is_non_delay_mpc(struct wlc_info *wlc);
933 extern void wlc_radio_mpc_upd(struct wlc_info *wlc);
934 extern bool wlc_prec_enq(struct wlc_info *wlc, struct pktq *q, void *pkt,
936 extern bool wlc_prec_enq_head(struct wlc_info *wlc, struct pktq *q,
937 struct sk_buff *pkt, int prec, bool head);
938 extern u16 wlc_phytxctl1_calc(struct wlc_info *wlc, ratespec_t rspec);
939 extern void wlc_compute_plcp(struct wlc_info *wlc, ratespec_t rate, uint length,
941 extern uint wlc_calc_frame_time(struct wlc_info *wlc, ratespec_t ratespec,
942 u8 preamble_type, uint mac_len);
944 extern void wlc_set_chanspec(struct wlc_info *wlc, chanspec_t chanspec);
946 extern bool wlc_timers_init(struct wlc_info *wlc, int unit);
948 extern const bcm_iovar_t wlc_iovars[];
950 extern int wlc_doiovar(void *hdl, const bcm_iovar_t *vi, u32 actionid,
951 const char *name, void *params, uint p_len, void *arg,
952 int len, int val_size, struct wlc_if *wlcif);
955 extern void wlc_print_ies(struct wlc_info *wlc, u8 *ies, uint ies_len);
958 extern int wlc_set_nmode(struct wlc_info *wlc, s32 nmode);
959 extern void wlc_ht_mimops_cap_update(struct wlc_info *wlc, u8 mimops_mode);
960 extern void wlc_mimops_action_ht_send(struct wlc_info *wlc,
961 wlc_bsscfg_t *bsscfg, u8 mimops_mode);
963 extern void wlc_switch_shortslot(struct wlc_info *wlc, bool shortslot);
964 extern void wlc_set_bssid(wlc_bsscfg_t *cfg);
965 extern void wlc_edcf_setparams(wlc_bsscfg_t *cfg, bool suspend);
967 extern void wlc_set_ratetable(struct wlc_info *wlc);
968 extern int wlc_set_mac(wlc_bsscfg_t *cfg);
969 extern void wlc_beacon_phytxctl_txant_upd(struct wlc_info *wlc,
970 ratespec_t bcn_rate);
971 extern void wlc_mod_prb_rsp_rate_table(struct wlc_info *wlc, uint frame_len);
972 extern ratespec_t wlc_lowest_basic_rspec(struct wlc_info *wlc,
974 extern u16 wlc_compute_bcntsfoff(struct wlc_info *wlc, ratespec_t rspec,
975 bool short_preamble, bool phydelay);
976 extern void wlc_radio_disable(struct wlc_info *wlc);
977 extern void wlc_bcn_li_upd(struct wlc_info *wlc);
979 extern int wlc_get_revision_info(struct wlc_info *wlc, void *buf, uint len);
980 extern void wlc_out(struct wlc_info *wlc);
981 extern void wlc_set_home_chanspec(struct wlc_info *wlc, chanspec_t chanspec);
982 extern void wlc_watchdog_upd(struct wlc_info *wlc, bool tbtt);
983 extern bool wlc_ps_allowed(struct wlc_info *wlc);
984 extern bool wlc_stay_awake(struct wlc_info *wlc);
985 extern void wlc_wme_initparams_sta(struct wlc_info *wlc, wme_param_ie_t *pe);
987 extern void wlc_bss_list_free(struct wlc_info *wlc, wlc_bss_list_t *bss_list);
988 extern void wlc_ht_mimops_cap_update(struct wlc_info *wlc, u8 mimops_mode);