blob: 1cb2ddee9dcfbc501eaf9f873db390efe5b4d890 [file] [log] [blame]
Michael Buesche4d6b792007-09-18 15:39:42 -04001#ifndef B43_H_
2#define B43_H_
3
4#include <linux/kernel.h>
5#include <linux/spinlock.h>
6#include <linux/interrupt.h>
7#include <linux/hw_random.h>
Rafał Miłecki3c65ab62011-06-02 09:56:04 +02008#include <linux/bcma/bcma.h>
Michael Buesche4d6b792007-09-18 15:39:42 -04009#include <linux/ssb/ssb.h>
10#include <net/mac80211.h>
11
12#include "debugfs.h"
13#include "leds.h"
Michael Buesch8e9f7522007-09-27 21:35:34 +020014#include "rfkill.h"
Rafał Miłecki482f0532011-05-18 02:06:36 +020015#include "bus.h"
Michael Buesche4d6b792007-09-18 15:39:42 -040016#include "lo.h"
Michael Bueschef1a6282008-08-27 18:53:02 +020017#include "phy_common.h"
Michael Buesche4d6b792007-09-18 15:39:42 -040018
Michael Buesch26bc7832008-02-09 00:18:35 +010019
20/* The unique identifier of the firmware that's officially supported by
21 * this driver version. */
22#define B43_SUPPORTED_FIRMWARE_ID "FW13"
23
24
Michael Buesche4d6b792007-09-18 15:39:42 -040025#ifdef CONFIG_B43_DEBUG
26# define B43_DEBUG 1
27#else
28# define B43_DEBUG 0
29#endif
30
Michael Buesche4d6b792007-09-18 15:39:42 -040031/* MMIO offsets */
32#define B43_MMIO_DMA0_REASON 0x20
33#define B43_MMIO_DMA0_IRQ_MASK 0x24
34#define B43_MMIO_DMA1_REASON 0x28
35#define B43_MMIO_DMA1_IRQ_MASK 0x2C
36#define B43_MMIO_DMA2_REASON 0x30
37#define B43_MMIO_DMA2_IRQ_MASK 0x34
38#define B43_MMIO_DMA3_REASON 0x38
39#define B43_MMIO_DMA3_IRQ_MASK 0x3C
40#define B43_MMIO_DMA4_REASON 0x40
41#define B43_MMIO_DMA4_IRQ_MASK 0x44
42#define B43_MMIO_DMA5_REASON 0x48
43#define B43_MMIO_DMA5_IRQ_MASK 0x4C
Michael Bueschaa6c7ae2007-12-26 16:26:36 +010044#define B43_MMIO_MACCTL 0x120 /* MAC control */
45#define B43_MMIO_MACCMD 0x124 /* MAC command */
Michael Buesche4d6b792007-09-18 15:39:42 -040046#define B43_MMIO_GEN_IRQ_REASON 0x128
47#define B43_MMIO_GEN_IRQ_MASK 0x12C
48#define B43_MMIO_RAM_CONTROL 0x130
49#define B43_MMIO_RAM_DATA 0x134
50#define B43_MMIO_PS_STATUS 0x140
51#define B43_MMIO_RADIO_HWENABLED_HI 0x158
52#define B43_MMIO_SHM_CONTROL 0x160
53#define B43_MMIO_SHM_DATA 0x164
54#define B43_MMIO_SHM_DATA_UNALIGNED 0x166
55#define B43_MMIO_XMITSTAT_0 0x170
56#define B43_MMIO_XMITSTAT_1 0x174
57#define B43_MMIO_REV3PLUS_TSF_LOW 0x180 /* core rev >= 3 only */
58#define B43_MMIO_REV3PLUS_TSF_HIGH 0x184 /* core rev >= 3 only */
Michael Bueschf3dd3fc2007-12-22 21:56:30 +010059#define B43_MMIO_TSF_CFP_REP 0x188
60#define B43_MMIO_TSF_CFP_START 0x18C
61#define B43_MMIO_TSF_CFP_MAXDUR 0x190
Michael Buesche4d6b792007-09-18 15:39:42 -040062
63/* 32-bit DMA */
64#define B43_MMIO_DMA32_BASE0 0x200
65#define B43_MMIO_DMA32_BASE1 0x220
66#define B43_MMIO_DMA32_BASE2 0x240
67#define B43_MMIO_DMA32_BASE3 0x260
68#define B43_MMIO_DMA32_BASE4 0x280
69#define B43_MMIO_DMA32_BASE5 0x2A0
70/* 64-bit DMA */
71#define B43_MMIO_DMA64_BASE0 0x200
72#define B43_MMIO_DMA64_BASE1 0x240
73#define B43_MMIO_DMA64_BASE2 0x280
74#define B43_MMIO_DMA64_BASE3 0x2C0
75#define B43_MMIO_DMA64_BASE4 0x300
76#define B43_MMIO_DMA64_BASE5 0x340
Michael Buesche4d6b792007-09-18 15:39:42 -040077
Michael Buesch5100d5a2008-03-29 21:01:16 +010078/* PIO on core rev < 11 */
79#define B43_MMIO_PIO_BASE0 0x300
80#define B43_MMIO_PIO_BASE1 0x310
81#define B43_MMIO_PIO_BASE2 0x320
82#define B43_MMIO_PIO_BASE3 0x330
83#define B43_MMIO_PIO_BASE4 0x340
84#define B43_MMIO_PIO_BASE5 0x350
85#define B43_MMIO_PIO_BASE6 0x360
86#define B43_MMIO_PIO_BASE7 0x370
87/* PIO on core rev >= 11 */
88#define B43_MMIO_PIO11_BASE0 0x200
89#define B43_MMIO_PIO11_BASE1 0x240
90#define B43_MMIO_PIO11_BASE2 0x280
91#define B43_MMIO_PIO11_BASE3 0x2C0
92#define B43_MMIO_PIO11_BASE4 0x300
93#define B43_MMIO_PIO11_BASE5 0x340
94
Michael Buesche4d6b792007-09-18 15:39:42 -040095#define B43_MMIO_PHY_VER 0x3E0
96#define B43_MMIO_PHY_RADIO 0x3E2
97#define B43_MMIO_PHY0 0x3E6
98#define B43_MMIO_ANTENNA 0x3E8
99#define B43_MMIO_CHANNEL 0x3F0
100#define B43_MMIO_CHANNEL_EXT 0x3F4
101#define B43_MMIO_RADIO_CONTROL 0x3F6
102#define B43_MMIO_RADIO_DATA_HIGH 0x3F8
103#define B43_MMIO_RADIO_DATA_LOW 0x3FA
104#define B43_MMIO_PHY_CONTROL 0x3FC
105#define B43_MMIO_PHY_DATA 0x3FE
106#define B43_MMIO_MACFILTER_CONTROL 0x420
107#define B43_MMIO_MACFILTER_DATA 0x422
108#define B43_MMIO_RCMTA_COUNT 0x43C
Rafał Miłecki97344852010-02-27 13:03:32 +0100109#define B43_MMIO_PSM_PHY_HDR 0x492
Michael Buesche4d6b792007-09-18 15:39:42 -0400110#define B43_MMIO_RADIO_HWENABLED_LO 0x49A
111#define B43_MMIO_GPIO_CONTROL 0x49C
112#define B43_MMIO_GPIO_MASK 0x49E
Michael Bueschf3dd3fc2007-12-22 21:56:30 +0100113#define B43_MMIO_TSF_CFP_START_LOW 0x604
114#define B43_MMIO_TSF_CFP_START_HIGH 0x606
Michael Bueschd59f7202008-04-03 18:56:19 +0200115#define B43_MMIO_TSF_CFP_PRETBTT 0x612
Michael Buesche4d6b792007-09-18 15:39:42 -0400116#define B43_MMIO_TSF_0 0x632 /* core rev < 3 only */
117#define B43_MMIO_TSF_1 0x634 /* core rev < 3 only */
118#define B43_MMIO_TSF_2 0x636 /* core rev < 3 only */
119#define B43_MMIO_TSF_3 0x638 /* core rev < 3 only */
120#define B43_MMIO_RNG 0x65A
Larry Fingerb6c3f5b2010-02-02 10:08:19 -0600121#define B43_MMIO_IFSSLOT 0x684 /* Interframe slot time */
Michael Buesche6f5b932008-03-05 21:18:49 +0100122#define B43_MMIO_IFSCTL 0x688 /* Interframe space control */
123#define B43_MMIO_IFSCTL_USE_EDCF 0x0004
Michael Buesche4d6b792007-09-18 15:39:42 -0400124#define B43_MMIO_POWERUP_DELAY 0x6A8
Michael Bueschce1a9ee2009-02-04 19:55:22 +0100125#define B43_MMIO_BTCOEX_CTL 0x6B4 /* Bluetooth Coexistence Control */
126#define B43_MMIO_BTCOEX_STAT 0x6B6 /* Bluetooth Coexistence Status */
127#define B43_MMIO_BTCOEX_TXCTL 0x6B8 /* Bluetooth Coexistence Transmit Control */
Michael Buesche4d6b792007-09-18 15:39:42 -0400128
129/* SPROM boardflags_lo values */
130#define B43_BFL_BTCOEXIST 0x0001 /* implements Bluetooth coexistance */
131#define B43_BFL_PACTRL 0x0002 /* GPIO 9 controlling the PA */
132#define B43_BFL_AIRLINEMODE 0x0004 /* implements GPIO 13 radio disable indication */
133#define B43_BFL_RSSI 0x0008 /* software calculates nrssi slope. */
134#define B43_BFL_ENETSPI 0x0010 /* has ephy roboswitch spi */
135#define B43_BFL_XTAL_NOSLOW 0x0020 /* no slow clock available */
136#define B43_BFL_CCKHIPWR 0x0040 /* can do high power CCK transmission */
137#define B43_BFL_ENETADM 0x0080 /* has ADMtek switch */
138#define B43_BFL_ENETVLAN 0x0100 /* can do vlan */
139#define B43_BFL_AFTERBURNER 0x0200 /* supports Afterburner mode */
140#define B43_BFL_NOPCI 0x0400 /* leaves PCI floating */
141#define B43_BFL_FEM 0x0800 /* supports the Front End Module */
142#define B43_BFL_EXTLNA 0x1000 /* has an external LNA */
143#define B43_BFL_HGPA 0x2000 /* had high gain PA */
144#define B43_BFL_BTCMOD 0x4000 /* BFL_BTCOEXIST is given in alternate GPIOs */
145#define B43_BFL_ALTIQ 0x8000 /* alternate I/Q settings */
146
Gábor Stefanik738f0f42009-08-03 01:28:12 +0200147/* SPROM boardflags_hi values */
148#define B43_BFH_NOPA 0x0001 /* has no PA */
149#define B43_BFH_RSSIINV 0x0002 /* RSSI uses positive slope (not TSSI) */
150#define B43_BFH_PAREF 0x0004 /* uses the PARef LDO */
151#define B43_BFH_3TSWITCH 0x0008 /* uses a triple throw switch shared
152 * with bluetooth */
153#define B43_BFH_PHASESHIFT 0x0010 /* can support phase shifter */
154#define B43_BFH_BUCKBOOST 0x0020 /* has buck/booster */
155#define B43_BFH_FEM_BT 0x0040 /* has FEM and switch to share antenna
156 * with bluetooth */
157
Rafał Miłecki7e6da2b2010-10-22 17:43:47 +0200158/* SPROM boardflags2_lo values */
159#define B43_BFL2_RXBB_INT_REG_DIS 0x0001 /* external RX BB regulator present */
160#define B43_BFL2_APLL_WAR 0x0002 /* alternative A-band PLL settings implemented */
161#define B43_BFL2_TXPWRCTRL_EN 0x0004 /* permits enabling TX Power Control */
162#define B43_BFL2_2X4_DIV 0x0008 /* 2x4 diversity switch */
163#define B43_BFL2_5G_PWRGAIN 0x0010 /* supports 5G band power gain */
164#define B43_BFL2_PCIEWAR_OVR 0x0020 /* overrides ASPM and Clkreq settings */
165#define B43_BFL2_CAESERS_BRD 0x0040 /* is Caesers board (unused) */
166#define B43_BFL2_BTC3WIRE 0x0080 /* used 3-wire bluetooth coexist */
167#define B43_BFL2_SKWRKFEM_BRD 0x0100 /* 4321mcm93 uses Skyworks FEM */
168#define B43_BFL2_SPUR_WAR 0x0200 /* has a workaround for clock-harmonic spurs */
169#define B43_BFL2_GPLL_WAR 0x0400 /* altenative G-band PLL settings implemented */
170
Michael Buesche4d6b792007-09-18 15:39:42 -0400171/* GPIO register offset, in both ChipCommon and PCI core. */
172#define B43_GPIO_CONTROL 0x6c
173
174/* SHM Routing */
175enum {
176 B43_SHM_UCODE, /* Microcode memory */
177 B43_SHM_SHARED, /* Shared memory */
178 B43_SHM_SCRATCH, /* Scratch memory */
179 B43_SHM_HW, /* Internal hardware register */
180 B43_SHM_RCMTA, /* Receive match transmitter address (rev >= 5 only) */
181};
182/* SHM Routing modifiers */
183#define B43_SHM_AUTOINC_R 0x0200 /* Auto-increment address on read */
184#define B43_SHM_AUTOINC_W 0x0100 /* Auto-increment address on write */
185#define B43_SHM_AUTOINC_RW (B43_SHM_AUTOINC_R | \
186 B43_SHM_AUTOINC_W)
187
188/* Misc SHM_SHARED offsets */
189#define B43_SHM_SH_WLCOREREV 0x0016 /* 802.11 core revision */
190#define B43_SHM_SH_PCTLWDPOS 0x0008
191#define B43_SHM_SH_RXPADOFF 0x0034 /* RX Padding data offset (PIO only) */
Michael Buesch403a3a12009-06-08 21:04:57 +0200192#define B43_SHM_SH_FWCAPA 0x0042 /* Firmware capabilities (Opensource firmware only) */
Michael Buesche4d6b792007-09-18 15:39:42 -0400193#define B43_SHM_SH_PHYVER 0x0050 /* PHY version */
194#define B43_SHM_SH_PHYTYPE 0x0052 /* PHY type */
195#define B43_SHM_SH_ANTSWAP 0x005C /* Antenna swap threshold */
196#define B43_SHM_SH_HOSTFLO 0x005E /* Hostflags for ucode options (low) */
Michael Buesch35f0d352008-02-13 14:31:08 +0100197#define B43_SHM_SH_HOSTFMI 0x0060 /* Hostflags for ucode options (middle) */
198#define B43_SHM_SH_HOSTFHI 0x0062 /* Hostflags for ucode options (high) */
Michael Buesche4d6b792007-09-18 15:39:42 -0400199#define B43_SHM_SH_RFATT 0x0064 /* Current radio attenuation value */
200#define B43_SHM_SH_RADAR 0x0066 /* Radar register */
201#define B43_SHM_SH_PHYTXNOI 0x006E /* PHY noise directly after TX (lower 8bit only) */
202#define B43_SHM_SH_RFRXSP1 0x0072 /* RF RX SP Register 1 */
203#define B43_SHM_SH_CHAN 0x00A0 /* Current channel (low 8bit only) */
Rafał Miłecki106cb092010-10-06 07:50:07 +0200204#define B43_SHM_SH_CHAN_5GHZ 0x0100 /* Bit set, if 5 Ghz channel */
205#define B43_SHM_SH_CHAN_40MHZ 0x0200 /* Bit set, if 40 Mhz channel width */
Michael Buesche4d6b792007-09-18 15:39:42 -0400206#define B43_SHM_SH_BCMCFIFOID 0x0108 /* Last posted cookie to the bcast/mcast FIFO */
Michael Buesch18c8ade2008-08-28 19:33:40 +0200207/* TSSI information */
208#define B43_SHM_SH_TSSI_CCK 0x0058 /* TSSI for last 4 CCK frames (32bit) */
209#define B43_SHM_SH_TSSI_OFDM_A 0x0068 /* TSSI for last 4 OFDM frames (32bit) */
210#define B43_SHM_SH_TSSI_OFDM_G 0x0070 /* TSSI for last 4 OFDM frames (32bit) */
211#define B43_TSSI_MAX 0x7F /* Max value for one TSSI value */
Michael Buesche4d6b792007-09-18 15:39:42 -0400212/* SHM_SHARED TX FIFO variables */
213#define B43_SHM_SH_SIZE01 0x0098 /* TX FIFO size for FIFO 0 (low) and 1 (high) */
214#define B43_SHM_SH_SIZE23 0x009A /* TX FIFO size for FIFO 2 and 3 */
215#define B43_SHM_SH_SIZE45 0x009C /* TX FIFO size for FIFO 4 and 5 */
216#define B43_SHM_SH_SIZE67 0x009E /* TX FIFO size for FIFO 6 and 7 */
217/* SHM_SHARED background noise */
218#define B43_SHM_SH_JSSI0 0x0088 /* Measure JSSI 0 */
219#define B43_SHM_SH_JSSI1 0x008A /* Measure JSSI 1 */
220#define B43_SHM_SH_JSSIAUX 0x008C /* Measure JSSI AUX */
221/* SHM_SHARED crypto engine */
222#define B43_SHM_SH_DEFAULTIV 0x003C /* Default IV location */
223#define B43_SHM_SH_NRRXTRANS 0x003E /* # of soft RX transmitter addresses (max 8) */
224#define B43_SHM_SH_KTP 0x0056 /* Key table pointer */
225#define B43_SHM_SH_TKIPTSCTTAK 0x0318
226#define B43_SHM_SH_KEYIDXBLOCK 0x05D4 /* Key index/algorithm block (v4 firmware) */
227#define B43_SHM_SH_PSM 0x05F4 /* PSM transmitter address match block (rev < 5) */
228/* SHM_SHARED WME variables */
229#define B43_SHM_SH_EDCFSTAT 0x000E /* EDCF status */
230#define B43_SHM_SH_TXFCUR 0x0030 /* TXF current index */
231#define B43_SHM_SH_EDCFQ 0x0240 /* EDCF Q info */
232/* SHM_SHARED powersave mode related */
233#define B43_SHM_SH_SLOTT 0x0010 /* Slot time */
234#define B43_SHM_SH_DTIMPER 0x0012 /* DTIM period */
235#define B43_SHM_SH_NOSLPZNATDTIM 0x004C /* NOSLPZNAT DTIM */
Michael Buesch280d0e12007-12-26 18:26:17 +0100236/* SHM_SHARED beacon/AP variables */
Michael Buesche4d6b792007-09-18 15:39:42 -0400237#define B43_SHM_SH_BTL0 0x0018 /* Beacon template length 0 */
238#define B43_SHM_SH_BTL1 0x001A /* Beacon template length 1 */
239#define B43_SHM_SH_BTSFOFF 0x001C /* Beacon TSF offset */
240#define B43_SHM_SH_TIMBPOS 0x001E /* TIM B position in beacon */
Michael Buesch280d0e12007-12-26 18:26:17 +0100241#define B43_SHM_SH_DTIMP 0x0012 /* DTIP period */
242#define B43_SHM_SH_MCASTCOOKIE 0x00A8 /* Last bcast/mcast frame ID */
Michael Buesche4d6b792007-09-18 15:39:42 -0400243#define B43_SHM_SH_SFFBLIM 0x0044 /* Short frame fallback retry limit */
244#define B43_SHM_SH_LFFBLIM 0x0046 /* Long frame fallback retry limit */
245#define B43_SHM_SH_BEACPHYCTL 0x0054 /* Beacon PHY TX control word (see PHY TX control) */
Michael Buesch280d0e12007-12-26 18:26:17 +0100246#define B43_SHM_SH_EXTNPHYCTL 0x00B0 /* Extended bytes for beacon PHY control (N) */
Michael Buesche4d6b792007-09-18 15:39:42 -0400247/* SHM_SHARED ACK/CTS control */
248#define B43_SHM_SH_ACKCTSPHYCTL 0x0022 /* ACK/CTS PHY control word (see PHY TX control) */
249/* SHM_SHARED probe response variables */
250#define B43_SHM_SH_PRSSID 0x0160 /* Probe Response SSID */
251#define B43_SHM_SH_PRSSIDLEN 0x0048 /* Probe Response SSID length */
252#define B43_SHM_SH_PRTLEN 0x004A /* Probe Response template length */
253#define B43_SHM_SH_PRMAXTIME 0x0074 /* Probe Response max time */
254#define B43_SHM_SH_PRPHYCTL 0x0188 /* Probe Response PHY TX control word */
255/* SHM_SHARED rate tables */
256#define B43_SHM_SH_OFDMDIRECT 0x01C0 /* Pointer to OFDM direct map */
257#define B43_SHM_SH_OFDMBASIC 0x01E0 /* Pointer to OFDM basic rate map */
258#define B43_SHM_SH_CCKDIRECT 0x0200 /* Pointer to CCK direct map */
259#define B43_SHM_SH_CCKBASIC 0x0220 /* Pointer to CCK basic rate map */
260/* SHM_SHARED microcode soft registers */
261#define B43_SHM_SH_UCODEREV 0x0000 /* Microcode revision */
262#define B43_SHM_SH_UCODEPATCH 0x0002 /* Microcode patchlevel */
263#define B43_SHM_SH_UCODEDATE 0x0004 /* Microcode date */
264#define B43_SHM_SH_UCODETIME 0x0006 /* Microcode time */
265#define B43_SHM_SH_UCODESTAT 0x0040 /* Microcode debug status code */
266#define B43_SHM_SH_UCODESTAT_INVALID 0
267#define B43_SHM_SH_UCODESTAT_INIT 1
268#define B43_SHM_SH_UCODESTAT_ACTIVE 2
269#define B43_SHM_SH_UCODESTAT_SUSP 3 /* suspended */
270#define B43_SHM_SH_UCODESTAT_SLEEP 4 /* asleep (PS) */
271#define B43_SHM_SH_MAXBFRAMES 0x0080 /* Maximum number of frames in a burst */
272#define B43_SHM_SH_SPUWKUP 0x0094 /* pre-wakeup for synth PU in us */
273#define B43_SHM_SH_PRETBTT 0x0096 /* pre-TBTT in us */
Rafał Miłecki76a4db32010-01-15 12:27:46 +0100274/* SHM_SHARED tx iq workarounds */
275#define B43_SHM_SH_NPHY_TXIQW0 0x0700
276#define B43_SHM_SH_NPHY_TXIQW1 0x0702
277#define B43_SHM_SH_NPHY_TXIQW2 0x0704
278#define B43_SHM_SH_NPHY_TXIQW3 0x0706
279/* SHM_SHARED tx pwr ctrl */
280#define B43_SHM_SH_NPHY_TXPWR_INDX0 0x0708
281#define B43_SHM_SH_NPHY_TXPWR_INDX1 0x070E
Michael Buesche4d6b792007-09-18 15:39:42 -0400282
283/* SHM_SCRATCH offsets */
284#define B43_SHM_SC_MINCONT 0x0003 /* Minimum contention window */
285#define B43_SHM_SC_MAXCONT 0x0004 /* Maximum contention window */
286#define B43_SHM_SC_CURCONT 0x0005 /* Current contention window */
287#define B43_SHM_SC_SRLIMIT 0x0006 /* Short retry count limit */
288#define B43_SHM_SC_LRLIMIT 0x0007 /* Long retry count limit */
289#define B43_SHM_SC_DTIMC 0x0008 /* Current DTIM count */
290#define B43_SHM_SC_BTL0LEN 0x0015 /* Beacon 0 template length */
291#define B43_SHM_SC_BTL1LEN 0x0016 /* Beacon 1 template length */
292#define B43_SHM_SC_SCFB 0x0017 /* Short frame transmit count threshold for rate fallback */
293#define B43_SHM_SC_LCFB 0x0018 /* Long frame transmit count threshold for rate fallback */
294
295/* Hardware Radio Enable masks */
296#define B43_MMIO_RADIO_HWENABLED_HI_MASK (1 << 16)
297#define B43_MMIO_RADIO_HWENABLED_LO_MASK (1 << 4)
298
299/* HostFlags. See b43_hf_read/write() */
Michael Buesch35f0d352008-02-13 14:31:08 +0100300#define B43_HF_ANTDIVHELP 0x000000000001ULL /* ucode antenna div helper */
301#define B43_HF_SYMW 0x000000000002ULL /* G-PHY SYM workaround */
302#define B43_HF_RXPULLW 0x000000000004ULL /* RX pullup workaround */
303#define B43_HF_CCKBOOST 0x000000000008ULL /* 4dB CCK power boost (exclusive with OFDM boost) */
304#define B43_HF_BTCOEX 0x000000000010ULL /* Bluetooth coexistance */
305#define B43_HF_GDCW 0x000000000020ULL /* G-PHY DC canceller filter bw workaround */
306#define B43_HF_OFDMPABOOST 0x000000000040ULL /* Enable PA gain boost for OFDM */
307#define B43_HF_ACPR 0x000000000080ULL /* Disable for Japan, channel 14 */
308#define B43_HF_EDCF 0x000000000100ULL /* on if WME and MAC suspended */
309#define B43_HF_TSSIRPSMW 0x000000000200ULL /* TSSI reset PSM ucode workaround */
310#define B43_HF_20IN40IQW 0x000000000200ULL /* 20 in 40 MHz I/Q workaround (rev >= 13 only) */
311#define B43_HF_DSCRQ 0x000000000400ULL /* Disable slow clock request in ucode */
312#define B43_HF_ACIW 0x000000000800ULL /* ACI workaround: shift bits by 2 on PHY CRS */
313#define B43_HF_2060W 0x000000001000ULL /* 2060 radio workaround */
314#define B43_HF_RADARW 0x000000002000ULL /* Radar workaround */
315#define B43_HF_USEDEFKEYS 0x000000004000ULL /* Enable use of default keys */
316#define B43_HF_AFTERBURNER 0x000000008000ULL /* Afterburner enabled */
317#define B43_HF_BT4PRIOCOEX 0x000000010000ULL /* Bluetooth 4-priority coexistance */
318#define B43_HF_FWKUP 0x000000020000ULL /* Fast wake-up ucode */
319#define B43_HF_VCORECALC 0x000000040000ULL /* Force VCO recalculation when powering up synthpu */
320#define B43_HF_PCISCW 0x000000080000ULL /* PCI slow clock workaround */
321#define B43_HF_4318TSSI 0x000000200000ULL /* 4318 TSSI */
322#define B43_HF_FBCMCFIFO 0x000000400000ULL /* Flush bcast/mcast FIFO immediately */
323#define B43_HF_HWPCTL 0x000000800000ULL /* Enable hardwarre power control */
324#define B43_HF_BTCOEXALT 0x000001000000ULL /* Bluetooth coexistance in alternate pins */
325#define B43_HF_TXBTCHECK 0x000002000000ULL /* Bluetooth check during transmission */
326#define B43_HF_SKCFPUP 0x000004000000ULL /* Skip CFP update */
327#define B43_HF_N40W 0x000008000000ULL /* N PHY 40 MHz workaround (rev >= 13 only) */
328#define B43_HF_ANTSEL 0x000020000000ULL /* Antenna selection (for testing antenna div.) */
329#define B43_HF_BT3COEXT 0x000020000000ULL /* Bluetooth 3-wire coexistence (rev >= 13 only) */
330#define B43_HF_BTCANT 0x000040000000ULL /* Bluetooth coexistence (antenna mode) (rev >= 13 only) */
331#define B43_HF_ANTSELEN 0x000100000000ULL /* Antenna selection enabled (rev >= 13 only) */
332#define B43_HF_ANTSELMODE 0x000200000000ULL /* Antenna selection mode (rev >= 13 only) */
333#define B43_HF_MLADVW 0x001000000000ULL /* N PHY ML ADV workaround (rev >= 13 only) */
334#define B43_HF_PR45960W 0x080000000000ULL /* PR 45960 workaround (rev >= 13 only) */
Michael Buesche4d6b792007-09-18 15:39:42 -0400335
Michael Buesch403a3a12009-06-08 21:04:57 +0200336/* Firmware capabilities field in SHM (Opensource firmware only) */
337#define B43_FWCAPA_HWCRYPTO 0x0001
338#define B43_FWCAPA_QOS 0x0002
339
Michael Buesche4d6b792007-09-18 15:39:42 -0400340/* MacFilter offsets. */
341#define B43_MACFILTER_SELF 0x0000
342#define B43_MACFILTER_BSSID 0x0003
343
344/* PowerControl */
345#define B43_PCTL_IN 0xB0
346#define B43_PCTL_OUT 0xB4
347#define B43_PCTL_OUTENABLE 0xB8
348#define B43_PCTL_XTAL_POWERUP 0x40
349#define B43_PCTL_PLL_POWERDOWN 0x80
350
351/* PowerControl Clock Modes */
352#define B43_PCTL_CLK_FAST 0x00
353#define B43_PCTL_CLK_SLOW 0x01
354#define B43_PCTL_CLK_DYNAMIC 0x02
355
356#define B43_PCTL_FORCE_SLOW 0x0800
357#define B43_PCTL_FORCE_PLL 0x1000
358#define B43_PCTL_DYN_XTAL 0x2000
359
360/* PHYVersioning */
361#define B43_PHYTYPE_A 0x00
362#define B43_PHYTYPE_B 0x01
363#define B43_PHYTYPE_G 0x02
Michael Bueschd9871602008-01-02 18:55:53 +0100364#define B43_PHYTYPE_N 0x04
365#define B43_PHYTYPE_LP 0x05
Michael Buesche4d6b792007-09-18 15:39:42 -0400366
367/* PHYRegisters */
368#define B43_PHY_ILT_A_CTRL 0x0072
369#define B43_PHY_ILT_A_DATA1 0x0073
370#define B43_PHY_ILT_A_DATA2 0x0074
371#define B43_PHY_G_LO_CONTROL 0x0810
372#define B43_PHY_ILT_G_CTRL 0x0472
373#define B43_PHY_ILT_G_DATA1 0x0473
374#define B43_PHY_ILT_G_DATA2 0x0474
375#define B43_PHY_A_PCTL 0x007B
376#define B43_PHY_G_PCTL 0x0029
377#define B43_PHY_A_CRS 0x0029
378#define B43_PHY_RADIO_BITFIELD 0x0401
379#define B43_PHY_G_CRS 0x0429
380#define B43_PHY_NRSSILT_CTRL 0x0803
381#define B43_PHY_NRSSILT_DATA 0x0804
382
383/* RadioRegisters */
384#define B43_RADIOCTL_ID 0x01
385
386/* MAC Control bitfield */
387#define B43_MACCTL_ENABLED 0x00000001 /* MAC Enabled */
388#define B43_MACCTL_PSM_RUN 0x00000002 /* Run Microcode */
389#define B43_MACCTL_PSM_JMP0 0x00000004 /* Microcode jump to 0 */
390#define B43_MACCTL_SHM_ENABLED 0x00000100 /* SHM Enabled */
391#define B43_MACCTL_SHM_UPPER 0x00000200 /* SHM Upper */
392#define B43_MACCTL_IHR_ENABLED 0x00000400 /* IHR Region Enabled */
393#define B43_MACCTL_PSM_DBG 0x00002000 /* Microcode debugging enabled */
394#define B43_MACCTL_GPOUTSMSK 0x0000C000 /* GPOUT Select Mask */
395#define B43_MACCTL_BE 0x00010000 /* Big Endian mode */
396#define B43_MACCTL_INFRA 0x00020000 /* Infrastructure mode */
397#define B43_MACCTL_AP 0x00040000 /* AccessPoint mode */
398#define B43_MACCTL_RADIOLOCK 0x00080000 /* Radio lock */
399#define B43_MACCTL_BEACPROMISC 0x00100000 /* Beacon Promiscuous */
400#define B43_MACCTL_KEEP_BADPLCP 0x00200000 /* Keep frames with bad PLCP */
401#define B43_MACCTL_KEEP_CTL 0x00400000 /* Keep control frames */
402#define B43_MACCTL_KEEP_BAD 0x00800000 /* Keep bad frames (FCS) */
403#define B43_MACCTL_PROMISC 0x01000000 /* Promiscuous mode */
404#define B43_MACCTL_HWPS 0x02000000 /* Hardware Power Saving */
405#define B43_MACCTL_AWAKE 0x04000000 /* Device is awake */
406#define B43_MACCTL_CLOSEDNET 0x08000000 /* Closed net (no SSID bcast) */
407#define B43_MACCTL_TBTTHOLD 0x10000000 /* TBTT Hold */
408#define B43_MACCTL_DISCTXSTAT 0x20000000 /* Discard TX status */
409#define B43_MACCTL_DISCPMQ 0x40000000 /* Discard Power Management Queue */
410#define B43_MACCTL_GMODE 0x80000000 /* G Mode */
411
Michael Bueschaa6c7ae2007-12-26 16:26:36 +0100412/* MAC Command bitfield */
413#define B43_MACCMD_BEACON0_VALID 0x00000001 /* Beacon 0 in template RAM is busy/valid */
414#define B43_MACCMD_BEACON1_VALID 0x00000002 /* Beacon 1 in template RAM is busy/valid */
415#define B43_MACCMD_DFQ_VALID 0x00000004 /* Directed frame queue valid (IBSS PS mode, ATIM) */
416#define B43_MACCMD_CCA 0x00000008 /* Clear channel assessment */
417#define B43_MACCMD_BGNOISE 0x00000010 /* Background noise */
418
Rafał Miłeckiaa4e0142011-06-02 13:43:24 +0200419/* BCMA 802.11 core specific IO Control (BCMA_IOCTL) flags */
420#define B43_BCMA_IOCTL_PHY_CLKEN 0x00000004 /* PHY Clock Enable */
421#define B43_BCMA_IOCTL_PHY_RESET 0x00000008 /* PHY Reset */
422#define B43_BCMA_IOCTL_MACPHYCLKEN 0x00000010 /* MAC PHY Clock Control Enable */
423#define B43_BCMA_IOCTL_PLLREFSEL 0x00000020 /* PLL Frequency Reference Select */
424#define B43_BCMA_IOCTL_PHY_BW 0x000000C0 /* PHY band width and clock speed mask (N-PHY+ only?) */
425#define B43_BCMA_IOCTL_PHY_BW_10MHZ 0x00000000 /* 10 MHz bandwidth, 40 MHz PHY */
426#define B43_BCMA_IOCTL_PHY_BW_20MHZ 0x00000040 /* 20 MHz bandwidth, 80 MHz PHY */
427#define B43_BCMA_IOCTL_PHY_BW_40MHZ 0x00000080 /* 40 MHz bandwidth, 160 MHz PHY */
428#define B43_BCMA_IOCTL_GMODE 0x00002000 /* G Mode Enable */
429
Michael Buesch96c755a2008-01-06 00:09:46 +0100430/* 802.11 core specific TM State Low (SSB_TMSLOW) flags */
Michael Buesche4d6b792007-09-18 15:39:42 -0400431#define B43_TMSLOW_GMODE 0x20000000 /* G Mode Enable */
Rafał Miłecki42ab1352010-12-09 20:56:01 +0100432#define B43_TMSLOW_PHY_BANDWIDTH 0x00C00000 /* PHY band width and clock speed mask (N-PHY only) */
433#define B43_TMSLOW_PHY_BANDWIDTH_10MHZ 0x00000000 /* 10 MHz bandwidth, 40 MHz PHY */
434#define B43_TMSLOW_PHY_BANDWIDTH_20MHZ 0x00400000 /* 20 MHz bandwidth, 80 MHz PHY */
435#define B43_TMSLOW_PHY_BANDWIDTH_40MHZ 0x00800000 /* 40 MHz bandwidth, 160 MHz PHY */
Michael Buesch96c755a2008-01-06 00:09:46 +0100436#define B43_TMSLOW_PLLREFSEL 0x00200000 /* PLL Frequency Reference Select (rev >= 5) */
Michael Buesche4d6b792007-09-18 15:39:42 -0400437#define B43_TMSLOW_MACPHYCLKEN 0x00100000 /* MAC PHY Clock Control Enable (rev >= 5) */
438#define B43_TMSLOW_PHYRESET 0x00080000 /* PHY Reset */
439#define B43_TMSLOW_PHYCLKEN 0x00040000 /* PHY Clock Enable */
440
Michael Buesch96c755a2008-01-06 00:09:46 +0100441/* 802.11 core specific TM State High (SSB_TMSHIGH) flags */
442#define B43_TMSHIGH_DUALBAND_PHY 0x00080000 /* Dualband PHY available */
Michael Buesche4d6b792007-09-18 15:39:42 -0400443#define B43_TMSHIGH_FCLOCK 0x00040000 /* Fast Clock Available (rev >= 5) */
Michael Buesch96c755a2008-01-06 00:09:46 +0100444#define B43_TMSHIGH_HAVE_5GHZ_PHY 0x00020000 /* 5 GHz PHY available (rev >= 5) */
445#define B43_TMSHIGH_HAVE_2GHZ_PHY 0x00010000 /* 2.4 GHz PHY available (rev >= 5) */
Michael Buesche4d6b792007-09-18 15:39:42 -0400446
447/* Generic-Interrupt reasons. */
448#define B43_IRQ_MAC_SUSPENDED 0x00000001
449#define B43_IRQ_BEACON 0x00000002
450#define B43_IRQ_TBTT_INDI 0x00000004
451#define B43_IRQ_BEACON_TX_OK 0x00000008
452#define B43_IRQ_BEACON_CANCEL 0x00000010
453#define B43_IRQ_ATIM_END 0x00000020
454#define B43_IRQ_PMQ 0x00000040
455#define B43_IRQ_PIO_WORKAROUND 0x00000100
456#define B43_IRQ_MAC_TXERR 0x00000200
457#define B43_IRQ_PHY_TXERR 0x00000800
458#define B43_IRQ_PMEVENT 0x00001000
459#define B43_IRQ_TIMER0 0x00002000
460#define B43_IRQ_TIMER1 0x00004000
461#define B43_IRQ_DMA 0x00008000
462#define B43_IRQ_TXFIFO_FLUSH_OK 0x00010000
463#define B43_IRQ_CCA_MEASURE_OK 0x00020000
464#define B43_IRQ_NOISESAMPLE_OK 0x00040000
465#define B43_IRQ_UCODE_DEBUG 0x08000000
466#define B43_IRQ_RFKILL 0x10000000
467#define B43_IRQ_TX_OK 0x20000000
468#define B43_IRQ_PHY_G_CHANGED 0x40000000
469#define B43_IRQ_TIMEOUT 0x80000000
470
471#define B43_IRQ_ALL 0xFFFFFFFF
Michael Buesche40ac412008-04-25 21:10:54 +0200472#define B43_IRQ_MASKTEMPLATE (B43_IRQ_TBTT_INDI | \
Michael Buesche4d6b792007-09-18 15:39:42 -0400473 B43_IRQ_ATIM_END | \
474 B43_IRQ_PMQ | \
475 B43_IRQ_MAC_TXERR | \
476 B43_IRQ_PHY_TXERR | \
477 B43_IRQ_DMA | \
478 B43_IRQ_TXFIFO_FLUSH_OK | \
479 B43_IRQ_NOISESAMPLE_OK | \
480 B43_IRQ_UCODE_DEBUG | \
481 B43_IRQ_RFKILL | \
482 B43_IRQ_TX_OK)
483
Michael Bueschafa83e22008-05-19 23:51:37 +0200484/* The firmware register to fetch the debug-IRQ reason from. */
485#define B43_DEBUGIRQ_REASON_REG 63
Michael Buesche48b0ee2008-05-17 22:44:35 +0200486/* Debug-IRQ reasons. */
487#define B43_DEBUGIRQ_PANIC 0 /* The firmware panic'ed */
488#define B43_DEBUGIRQ_DUMP_SHM 1 /* Dump shared SHM */
489#define B43_DEBUGIRQ_DUMP_REGS 2 /* Dump the microcode registers */
Michael Buesch53c06852008-05-20 00:24:36 +0200490#define B43_DEBUGIRQ_MARKER 3 /* A "marker" was thrown by the firmware. */
Michael Buesche48b0ee2008-05-17 22:44:35 +0200491#define B43_DEBUGIRQ_ACK 0xFFFF /* The host writes that to ACK the IRQ */
492
Michael Buesch53c06852008-05-20 00:24:36 +0200493/* The firmware register that contains the "marker" line. */
494#define B43_MARKER_ID_REG 2
495#define B43_MARKER_LINE_REG 3
496
Michael Bueschafa83e22008-05-19 23:51:37 +0200497/* The firmware register to fetch the panic reason from. */
498#define B43_FWPANIC_REASON_REG 3
499/* Firmware panic reason codes */
500#define B43_FWPANIC_DIE 0 /* Firmware died. Don't auto-restart it. */
501#define B43_FWPANIC_RESTART 1 /* Firmware died. Schedule a controller reset. */
502
Michael Buesch9b839a72008-06-20 17:44:02 +0200503/* The firmware register that contains the watchdog counter. */
504#define B43_WATCHDOG_REG 1
Michael Bueschafa83e22008-05-19 23:51:37 +0200505
Michael Buesche4d6b792007-09-18 15:39:42 -0400506/* Device specific rate values.
507 * The actual values defined here are (rate_in_mbps * 2).
508 * Some code depends on this. Don't change it. */
509#define B43_CCK_RATE_1MB 0x02
510#define B43_CCK_RATE_2MB 0x04
511#define B43_CCK_RATE_5MB 0x0B
512#define B43_CCK_RATE_11MB 0x16
513#define B43_OFDM_RATE_6MB 0x0C
514#define B43_OFDM_RATE_9MB 0x12
515#define B43_OFDM_RATE_12MB 0x18
516#define B43_OFDM_RATE_18MB 0x24
517#define B43_OFDM_RATE_24MB 0x30
518#define B43_OFDM_RATE_36MB 0x48
519#define B43_OFDM_RATE_48MB 0x60
520#define B43_OFDM_RATE_54MB 0x6C
521/* Convert a b43 rate value to a rate in 100kbps */
522#define B43_RATE_TO_BASE100KBPS(rate) (((rate) * 10) / 2)
523
524#define B43_DEFAULT_SHORT_RETRY_LIMIT 7
525#define B43_DEFAULT_LONG_RETRY_LIMIT 4
526
Stefano Brivio00e0b8c2007-11-25 11:10:33 +0100527#define B43_PHY_TX_BADNESS_LIMIT 1000
528
Michael Buesche4d6b792007-09-18 15:39:42 -0400529/* Max size of a security key */
530#define B43_SEC_KEYSIZE 16
Michael Buesch66d2d082009-08-06 10:36:50 +0200531/* Max number of group keys */
532#define B43_NR_GROUP_KEYS 4
533/* Max number of pairwise keys */
534#define B43_NR_PAIRWISE_KEYS 50
Michael Buesche4d6b792007-09-18 15:39:42 -0400535/* Security algorithms. */
536enum {
537 B43_SEC_ALGO_NONE = 0, /* unencrypted, as of TX header. */
538 B43_SEC_ALGO_WEP40,
539 B43_SEC_ALGO_TKIP,
540 B43_SEC_ALGO_AES,
541 B43_SEC_ALGO_WEP104,
542 B43_SEC_ALGO_AES_LEGACY,
543};
544
545struct b43_dmaring;
Michael Buesche4d6b792007-09-18 15:39:42 -0400546
547/* The firmware file header */
548#define B43_FW_TYPE_UCODE 'u'
549#define B43_FW_TYPE_PCM 'p'
550#define B43_FW_TYPE_IV 'i'
551struct b43_fw_header {
552 /* File type */
553 u8 type;
554 /* File format version */
555 u8 ver;
556 u8 __padding[2];
557 /* Size of the data. For ucode and PCM this is in bytes.
558 * For IV this is number-of-ivs. */
559 __be32 size;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000560} __packed;
Michael Buesche4d6b792007-09-18 15:39:42 -0400561
562/* Initial Value file format */
563#define B43_IV_OFFSET_MASK 0x7FFF
564#define B43_IV_32BIT 0x8000
565struct b43_iv {
566 __be16 offset_size;
567 union {
568 __be16 d16;
569 __be32 d32;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000570 } data __packed;
571} __packed;
Michael Buesche4d6b792007-09-18 15:39:42 -0400572
573
Michael Buesche4d6b792007-09-18 15:39:42 -0400574/* Data structures for DMA transmission, per 80211 core. */
575struct b43_dma {
Michael Bueschb27faf82008-03-06 16:32:46 +0100576 struct b43_dmaring *tx_ring_AC_BK; /* Background */
577 struct b43_dmaring *tx_ring_AC_BE; /* Best Effort */
578 struct b43_dmaring *tx_ring_AC_VI; /* Video */
579 struct b43_dmaring *tx_ring_AC_VO; /* Voice */
580 struct b43_dmaring *tx_ring_mcast; /* Multicast */
Michael Buesche4d6b792007-09-18 15:39:42 -0400581
Michael Bueschb27faf82008-03-06 16:32:46 +0100582 struct b43_dmaring *rx_ring;
Rafał Miłecki05100a22011-05-17 14:00:02 +0200583
584 u32 translation; /* Routing bits */
Michael Buesche4d6b792007-09-18 15:39:42 -0400585};
586
Michael Buesch5100d5a2008-03-29 21:01:16 +0100587struct b43_pio_txqueue;
588struct b43_pio_rxqueue;
589
590/* Data structures for PIO transmission, per 80211 core. */
591struct b43_pio {
592 struct b43_pio_txqueue *tx_queue_AC_BK; /* Background */
593 struct b43_pio_txqueue *tx_queue_AC_BE; /* Best Effort */
594 struct b43_pio_txqueue *tx_queue_AC_VI; /* Video */
595 struct b43_pio_txqueue *tx_queue_AC_VO; /* Voice */
596 struct b43_pio_txqueue *tx_queue_mcast; /* Multicast */
597
598 struct b43_pio_rxqueue *rx_queue;
599};
600
Michael Buesche4d6b792007-09-18 15:39:42 -0400601/* Context information for a noise calculation (Link Quality). */
602struct b43_noise_calculation {
Michael Buesche4d6b792007-09-18 15:39:42 -0400603 bool calculation_running;
604 u8 nr_samples;
605 s8 samples[8][4];
606};
607
608struct b43_stats {
609 u8 link_noise;
Michael Buesche4d6b792007-09-18 15:39:42 -0400610};
611
612struct b43_key {
613 /* If keyconf is NULL, this key is disabled.
614 * keyconf is a cookie. Don't derefenrence it outside of the set_key
615 * path, because b43 doesn't own it. */
616 struct ieee80211_key_conf *keyconf;
617 u8 algorithm;
618};
619
Michael Buesche6f5b932008-03-05 21:18:49 +0100620/* SHM offsets to the QOS data structures for the 4 different queues. */
621#define B43_QOS_PARAMS(queue) (B43_SHM_SH_EDCFQ + \
622 (B43_NR_QOSPARAMS * sizeof(u16) * (queue)))
623#define B43_QOS_BACKGROUND B43_QOS_PARAMS(0)
624#define B43_QOS_BESTEFFORT B43_QOS_PARAMS(1)
625#define B43_QOS_VIDEO B43_QOS_PARAMS(2)
626#define B43_QOS_VOICE B43_QOS_PARAMS(3)
627
628/* QOS parameter hardware data structure offsets. */
Lorenzo Navae35cc4d2008-09-11 15:06:24 +0200629#define B43_NR_QOSPARAMS 16
Michael Buesche6f5b932008-03-05 21:18:49 +0100630enum {
631 B43_QOSPARAM_TXOP = 0,
632 B43_QOSPARAM_CWMIN,
633 B43_QOSPARAM_CWMAX,
634 B43_QOSPARAM_CWCUR,
635 B43_QOSPARAM_AIFS,
636 B43_QOSPARAM_BSLOTS,
637 B43_QOSPARAM_REGGAP,
638 B43_QOSPARAM_STATUS,
639};
640
641/* QOS parameters for a queue. */
642struct b43_qos_params {
643 /* The QOS parameters */
644 struct ieee80211_tx_queue_params p;
Michael Buesche6f5b932008-03-05 21:18:49 +0100645};
646
Albert Herranz7e937c62009-10-07 00:07:44 +0200647struct b43_wl;
Michael Buesche4d6b792007-09-18 15:39:42 -0400648
Michael Buesch1a9f5092009-01-23 21:21:51 +0100649/* The type of the firmware file. */
650enum b43_firmware_file_type {
651 B43_FWTYPE_PROPRIETARY,
652 B43_FWTYPE_OPENSOURCE,
653 B43_NR_FWTYPES,
654};
655
656/* Context data for fetching firmware. */
657struct b43_request_fw_context {
658 /* The device we are requesting the fw for. */
659 struct b43_wldev *dev;
660 /* The type of firmware to request. */
661 enum b43_firmware_file_type req_type;
662 /* Error messages for each firmware type. */
663 char errors[B43_NR_FWTYPES][128];
664 /* Temporary buffer for storing the firmware name. */
665 char fwname[64];
Jim Cromiee64851f2011-05-21 11:51:50 -0600666 /* A fatal error occurred while requesting. Firmware request
667 * can not continue, as any other request will also fail. */
Michael Buesch1a9f5092009-01-23 21:21:51 +0100668 int fatal_failure;
669};
670
Michael Buesch61cb5dd2008-01-21 19:55:09 +0100671/* In-memory representation of a cached microcode file. */
672struct b43_firmware_file {
673 const char *filename;
674 const struct firmware *data;
Michael Buesch1a9f5092009-01-23 21:21:51 +0100675 /* Type of the firmware file name. Note that this does only indicate
676 * the type by the firmware name. NOT the file contents.
677 * If you want to check for proprietary vs opensource, use (struct b43_firmware)->opensource
678 * instead! The (struct b43_firmware)->opensource flag is derived from the actual firmware
679 * binary code, not just the filename.
680 */
681 enum b43_firmware_file_type type;
Michael Buesch61cb5dd2008-01-21 19:55:09 +0100682};
683
Michael Buesche4d6b792007-09-18 15:39:42 -0400684/* Pointers to the firmware data and meta information about it. */
685struct b43_firmware {
686 /* Microcode */
Michael Buesch61cb5dd2008-01-21 19:55:09 +0100687 struct b43_firmware_file ucode;
Michael Buesche4d6b792007-09-18 15:39:42 -0400688 /* PCM code */
Michael Buesch61cb5dd2008-01-21 19:55:09 +0100689 struct b43_firmware_file pcm;
Michael Buesche4d6b792007-09-18 15:39:42 -0400690 /* Initial MMIO values for the firmware */
Michael Buesch61cb5dd2008-01-21 19:55:09 +0100691 struct b43_firmware_file initvals;
Michael Buesche4d6b792007-09-18 15:39:42 -0400692 /* Initial MMIO values for the firmware, band-specific */
Michael Buesch61cb5dd2008-01-21 19:55:09 +0100693 struct b43_firmware_file initvals_band;
694
Michael Buesche4d6b792007-09-18 15:39:42 -0400695 /* Firmware revision */
696 u16 rev;
697 /* Firmware patchlevel */
698 u16 patch;
Michael Buesche48b0ee2008-05-17 22:44:35 +0200699
Michael Buesch1a9f5092009-01-23 21:21:51 +0100700 /* Set to true, if we are using an opensource firmware.
701 * Use this to check for proprietary vs opensource. */
Michael Buesche48b0ee2008-05-17 22:44:35 +0200702 bool opensource;
Michael Buesch68217832008-05-17 23:43:57 +0200703 /* Set to true, if the core needs a PCM firmware, but
704 * we failed to load one. This is always false for
705 * core rev > 10, as these don't need PCM firmware. */
706 bool pcm_request_failed;
Michael Buesche4d6b792007-09-18 15:39:42 -0400707};
708
709/* Device (802.11 core) initialization status. */
710enum {
711 B43_STAT_UNINIT = 0, /* Uninitialized. */
712 B43_STAT_INITIALIZED = 1, /* Initialized, but not started, yet. */
713 B43_STAT_STARTED = 2, /* Up and running. */
714};
715#define b43_status(wldev) atomic_read(&(wldev)->__init_status)
716#define b43_set_status(wldev, stat) do { \
717 atomic_set(&(wldev)->__init_status, (stat)); \
718 smp_wmb(); \
719 } while (0)
720
Michael Buesche4d6b792007-09-18 15:39:42 -0400721/* Data structure for one wireless device (802.11 core) */
722struct b43_wldev {
Rafał Miłecki482f0532011-05-18 02:06:36 +0200723 struct ssb_device *sdev; /* TODO: remove when b43_bus_dev is ready */
724 struct b43_bus_dev *dev;
Michael Buesche4d6b792007-09-18 15:39:42 -0400725 struct b43_wl *wl;
726
727 /* The device initialization status.
728 * Use b43_status() to query. */
729 atomic_t __init_status;
Michael Buesche4d6b792007-09-18 15:39:42 -0400730
Michael Buesche4d6b792007-09-18 15:39:42 -0400731 bool bad_frames_preempt; /* Use "Bad Frames Preemption" (default off) */
Michael Bueschaa6c7ae2007-12-26 16:26:36 +0100732 bool dfq_valid; /* Directed frame queue valid (IBSS PS mode, ATIM) */
Michael Buesche4d6b792007-09-18 15:39:42 -0400733 bool radio_hw_enable; /* saved state of radio hardware enabled state */
Michael Buesch403a3a12009-06-08 21:04:57 +0200734 bool qos_enabled; /* TRUE, if QoS is used. */
735 bool hwcrypto_enabled; /* TRUE, if HW crypto acceleration is enabled. */
Linus Torvalds9e3bd912010-02-26 10:34:27 -0800736 bool use_pio; /* TRUE if next init should use PIO */
Michael Buesche4d6b792007-09-18 15:39:42 -0400737
738 /* PHY/Radio device. */
739 struct b43_phy phy;
Michael Buesch03b29772007-12-26 14:41:30 +0100740
Michael Buesch5100d5a2008-03-29 21:01:16 +0100741 union {
742 /* DMA engines. */
743 struct b43_dma dma;
744 /* PIO engines. */
745 struct b43_pio pio;
746 };
747 /* Use b43_using_pio_transfers() to check whether we are using
748 * DMA or PIO data transfers. */
749 bool __using_pio_transfers;
Michael Buesche4d6b792007-09-18 15:39:42 -0400750
751 /* Various statistics about the physical device. */
752 struct b43_stats stats;
753
Michael Buesche4d6b792007-09-18 15:39:42 -0400754 /* Reason code of the last interrupt. */
755 u32 irq_reason;
756 u32 dma_reason[6];
Michael Buesch13790722009-04-08 21:26:27 +0200757 /* The currently active generic-interrupt mask. */
758 u32 irq_mask;
Michael Buesch36dbd952009-09-04 22:51:29 +0200759
Michael Buesche4d6b792007-09-18 15:39:42 -0400760 /* Link Quality calculation context. */
761 struct b43_noise_calculation noisecalc;
762 /* if > 0 MAC is suspended. if == 0 MAC is enabled. */
763 int mac_suspended;
764
Michael Buesche4d6b792007-09-18 15:39:42 -0400765 /* Periodic tasks */
766 struct delayed_work periodic_work;
767 unsigned int periodic_state;
768
769 struct work_struct restart_work;
770
771 /* encryption/decryption */
772 u16 ktp; /* Key table pointer */
Michael Buesch66d2d082009-08-06 10:36:50 +0200773 struct b43_key key[B43_NR_GROUP_KEYS * 2 + B43_NR_PAIRWISE_KEYS];
Michael Buesche4d6b792007-09-18 15:39:42 -0400774
Michael Buesche4d6b792007-09-18 15:39:42 -0400775 /* Firmware data */
776 struct b43_firmware fw;
777
778 /* Devicelist in struct b43_wl (all 802.11 cores) */
779 struct list_head list;
780
781 /* Debugging stuff follows. */
782#ifdef CONFIG_B43_DEBUG
783 struct b43_dfsentry *dfsentry;
Michael Buesch990b86f2009-09-12 00:48:03 +0200784 unsigned int irq_count;
785 unsigned int irq_bit_count[32];
786 unsigned int tx_count;
787 unsigned int rx_count;
Michael Buesche4d6b792007-09-18 15:39:42 -0400788#endif
789};
790
Albert Herranz7e937c62009-10-07 00:07:44 +0200791/* Data structure for the WLAN parts (802.11 cores) of the b43 chip. */
792struct b43_wl {
793 /* Pointer to the active wireless device on this chip */
794 struct b43_wldev *current_dev;
795 /* Pointer to the ieee80211 hardware data structure */
796 struct ieee80211_hw *hw;
797
798 /* Global driver mutex. Every operation must run with this mutex locked. */
799 struct mutex mutex;
800 /* Hard-IRQ spinlock. This lock protects things used in the hard-IRQ
801 * handler, only. This basically is just the IRQ mask register. */
802 spinlock_t hardirq_lock;
803
804 /* The number of queues that were registered with the mac80211 subsystem
805 * initially. This is a backup copy of hw->queues in case hw->queues has
806 * to be dynamically lowered at runtime (Firmware does not support QoS).
807 * hw->queues has to be restored to the original value before unregistering
808 * from the mac80211 subsystem. */
809 u16 mac80211_initially_registered_queues;
810
811 /* We can only have one operating interface (802.11 core)
812 * at a time. General information about this interface follows.
813 */
814
815 struct ieee80211_vif *vif;
816 /* The MAC address of the operating interface. */
817 u8 mac_addr[ETH_ALEN];
818 /* Current BSSID */
819 u8 bssid[ETH_ALEN];
820 /* Interface type. (NL80211_IFTYPE_XXX) */
821 int if_type;
822 /* Is the card operating in AP, STA or IBSS mode? */
823 bool operating;
824 /* filter flags */
825 unsigned int filter_flags;
826 /* Stats about the wireless interface */
827 struct ieee80211_low_level_stats ieee_stats;
828
829#ifdef CONFIG_B43_HWRNG
830 struct hwrng rng;
831 bool rng_initialized;
832 char rng_name[30 + 1];
833#endif /* CONFIG_B43_HWRNG */
834
835 /* List of all wireless devices on this chip */
836 struct list_head devlist;
837 u8 nr_devs;
838
839 bool radiotap_enabled;
840 bool radio_enabled;
841
842 /* The beacon we are currently using (AP or IBSS mode). */
843 struct sk_buff *current_beacon;
844 bool beacon0_uploaded;
845 bool beacon1_uploaded;
846 bool beacon_templates_virgin; /* Never wrote the templates? */
847 struct work_struct beacon_update_trigger;
848
849 /* The current QOS parameters for the 4 queues. */
850 struct b43_qos_params qos_params[4];
851
852 /* Work for adjustment of the transmission power.
853 * This is scheduled when we determine that the actual TX output
854 * power doesn't match what we want. */
855 struct work_struct txpower_adjust_work;
856
857 /* Packet transmit work */
858 struct work_struct tx_work;
859 /* Queue of packets to be transmitted. */
860 struct sk_buff_head tx_queue;
861
862 /* The device LEDs. */
863 struct b43_leds leds;
864
Michael Buesch88499ab2009-10-09 20:33:32 +0200865 /* Kmalloc'ed scratch space for PIO TX/RX. Protected by wl->mutex. */
866 u8 pio_scratchspace[110] __attribute__((__aligned__(8)));
867 u8 pio_tailspace[4] __attribute__((__aligned__(8)));
Albert Herranz7e937c62009-10-07 00:07:44 +0200868};
869
Michael Buesche4d6b792007-09-18 15:39:42 -0400870static inline struct b43_wl *hw_to_b43_wl(struct ieee80211_hw *hw)
871{
872 return hw->priv;
873}
874
Michael Buesche4d6b792007-09-18 15:39:42 -0400875static inline struct b43_wldev *dev_to_b43_wldev(struct device *dev)
876{
877 struct ssb_device *ssb_dev = dev_to_ssb_dev(dev);
878 return ssb_get_drvdata(ssb_dev);
879}
880
Gábor Stefanikbedaf802009-08-05 01:28:20 +0200881/* Is the device operating in a specified mode (NL80211_IFTYPE_XXX). */
Michael Buesche4d6b792007-09-18 15:39:42 -0400882static inline int b43_is_mode(struct b43_wl *wl, int type)
883{
Michael Buesche4d6b792007-09-18 15:39:42 -0400884 return (wl->operating && wl->if_type == type);
885}
886
Michael Bueschef1a6282008-08-27 18:53:02 +0200887/**
888 * b43_current_band - Returns the currently used band.
889 * Returns one of IEEE80211_BAND_2GHZ and IEEE80211_BAND_5GHZ.
890 */
891static inline enum ieee80211_band b43_current_band(struct b43_wl *wl)
892{
893 return wl->hw->conf.channel->band;
894}
895
Rafał Miłecki24ca39d2011-05-18 02:06:43 +0200896static inline int b43_bus_may_powerdown(struct b43_wldev *wldev)
897{
898 return wldev->dev->bus_may_powerdown(wldev->dev);
899}
900static inline int b43_bus_powerup(struct b43_wldev *wldev, bool dynamic_pctl)
901{
902 return wldev->dev->bus_powerup(wldev->dev, dynamic_pctl);
903}
904static inline int b43_device_is_enabled(struct b43_wldev *wldev)
905{
906 return wldev->dev->device_is_enabled(wldev->dev);
907}
908static inline void b43_device_enable(struct b43_wldev *wldev,
909 u32 core_specific_flags)
910{
911 wldev->dev->device_enable(wldev->dev, core_specific_flags);
912}
913static inline void b43_device_disable(struct b43_wldev *wldev,
914 u32 core_specific_flags)
915{
916 wldev->dev->device_disable(wldev->dev, core_specific_flags);
917}
918
Michael Buesche4d6b792007-09-18 15:39:42 -0400919static inline u16 b43_read16(struct b43_wldev *dev, u16 offset)
920{
Rafał Miłeckic0b4c002011-05-18 02:06:37 +0200921 return dev->dev->read16(dev->dev, offset);
Michael Buesche4d6b792007-09-18 15:39:42 -0400922}
923
924static inline void b43_write16(struct b43_wldev *dev, u16 offset, u16 value)
925{
Rafał Miłeckic0b4c002011-05-18 02:06:37 +0200926 dev->dev->write16(dev->dev, offset, value);
Michael Buesche4d6b792007-09-18 15:39:42 -0400927}
928
929static inline u32 b43_read32(struct b43_wldev *dev, u16 offset)
930{
Rafał Miłeckic0b4c002011-05-18 02:06:37 +0200931 return dev->dev->read32(dev->dev, offset);
Michael Buesche4d6b792007-09-18 15:39:42 -0400932}
933
934static inline void b43_write32(struct b43_wldev *dev, u16 offset, u32 value)
935{
Rafał Miłeckic0b4c002011-05-18 02:06:37 +0200936 dev->dev->write32(dev->dev, offset, value);
Michael Buesche4d6b792007-09-18 15:39:42 -0400937}
938
Rafał Miłecki620d7852011-05-17 14:00:00 +0200939static inline void b43_block_read(struct b43_wldev *dev, void *buffer,
940 size_t count, u16 offset, u8 reg_width)
941{
Rafał Miłeckic0b4c002011-05-18 02:06:37 +0200942 dev->dev->block_read(dev->dev, buffer, count, offset, reg_width);
Rafał Miłecki620d7852011-05-17 14:00:00 +0200943}
944
945static inline void b43_block_write(struct b43_wldev *dev, const void *buffer,
946 size_t count, u16 offset, u8 reg_width)
947{
Rafał Miłeckic0b4c002011-05-18 02:06:37 +0200948 dev->dev->block_write(dev->dev, buffer, count, offset, reg_width);
Michael Buesche4d6b792007-09-18 15:39:42 -0400949}
950
Michael Buesch5100d5a2008-03-29 21:01:16 +0100951static inline bool b43_using_pio_transfers(struct b43_wldev *dev)
952{
Michael Buesch5100d5a2008-03-29 21:01:16 +0100953 return dev->__using_pio_transfers;
Michael Buesch5100d5a2008-03-29 21:01:16 +0100954}
955
Linus Torvalds9e3bd912010-02-26 10:34:27 -0800956#ifdef CONFIG_B43_FORCE_PIO
957# define B43_PIO_DEFAULT 1
958#else
959# define B43_PIO_DEFAULT 0
960#endif
961
Michael Buesche4d6b792007-09-18 15:39:42 -0400962/* Message printing */
963void b43info(struct b43_wl *wl, const char *fmt, ...)
964 __attribute__ ((format(printf, 2, 3)));
965void b43err(struct b43_wl *wl, const char *fmt, ...)
966 __attribute__ ((format(printf, 2, 3)));
967void b43warn(struct b43_wl *wl, const char *fmt, ...)
968 __attribute__ ((format(printf, 2, 3)));
Michael Buesche4d6b792007-09-18 15:39:42 -0400969void b43dbg(struct b43_wl *wl, const char *fmt, ...)
970 __attribute__ ((format(printf, 2, 3)));
Michael Buesch060210f2009-01-25 15:49:59 +0100971
Michael Buesche4d6b792007-09-18 15:39:42 -0400972
973/* A WARN_ON variant that vanishes when b43 debugging is disabled.
974 * This _also_ evaluates the arg with debugging disabled. */
975#if B43_DEBUG
976# define B43_WARN_ON(x) WARN_ON(x)
977#else
978static inline bool __b43_warn_on_dummy(bool x) { return x; }
979# define B43_WARN_ON(x) __b43_warn_on_dummy(unlikely(!!(x)))
980#endif
981
Michael Buesche4d6b792007-09-18 15:39:42 -0400982/* Convert an integer to a Q5.2 value */
983#define INT_TO_Q52(i) ((i) << 2)
984/* Convert a Q5.2 value to an integer (precision loss!) */
985#define Q52_TO_INT(q52) ((q52) >> 2)
986/* Macros for printing a value in Q5.2 format */
987#define Q52_FMT "%u.%u"
988#define Q52_ARG(q52) Q52_TO_INT(q52), ((((q52) & 0x3) * 100) / 4)
989
990#endif /* B43_H_ */