blob: b298e5d68be2f0a58cf02d45d2ccd9a1e1e464bd [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
Michael Buesche4d6b792007-09-18 15:39:42 -040020#ifdef CONFIG_B43_DEBUG
21# define B43_DEBUG 1
22#else
23# define B43_DEBUG 0
24#endif
25
Michael Buesche4d6b792007-09-18 15:39:42 -040026/* MMIO offsets */
27#define B43_MMIO_DMA0_REASON 0x20
28#define B43_MMIO_DMA0_IRQ_MASK 0x24
29#define B43_MMIO_DMA1_REASON 0x28
30#define B43_MMIO_DMA1_IRQ_MASK 0x2C
31#define B43_MMIO_DMA2_REASON 0x30
32#define B43_MMIO_DMA2_IRQ_MASK 0x34
33#define B43_MMIO_DMA3_REASON 0x38
34#define B43_MMIO_DMA3_IRQ_MASK 0x3C
35#define B43_MMIO_DMA4_REASON 0x40
36#define B43_MMIO_DMA4_IRQ_MASK 0x44
37#define B43_MMIO_DMA5_REASON 0x48
38#define B43_MMIO_DMA5_IRQ_MASK 0x4C
Michael Bueschaa6c7ae2007-12-26 16:26:36 +010039#define B43_MMIO_MACCTL 0x120 /* MAC control */
40#define B43_MMIO_MACCMD 0x124 /* MAC command */
Michael Buesche4d6b792007-09-18 15:39:42 -040041#define B43_MMIO_GEN_IRQ_REASON 0x128
42#define B43_MMIO_GEN_IRQ_MASK 0x12C
43#define B43_MMIO_RAM_CONTROL 0x130
44#define B43_MMIO_RAM_DATA 0x134
45#define B43_MMIO_PS_STATUS 0x140
46#define B43_MMIO_RADIO_HWENABLED_HI 0x158
47#define B43_MMIO_SHM_CONTROL 0x160
48#define B43_MMIO_SHM_DATA 0x164
49#define B43_MMIO_SHM_DATA_UNALIGNED 0x166
50#define B43_MMIO_XMITSTAT_0 0x170
51#define B43_MMIO_XMITSTAT_1 0x174
52#define B43_MMIO_REV3PLUS_TSF_LOW 0x180 /* core rev >= 3 only */
53#define B43_MMIO_REV3PLUS_TSF_HIGH 0x184 /* core rev >= 3 only */
Michael Bueschf3dd3fc2007-12-22 21:56:30 +010054#define B43_MMIO_TSF_CFP_REP 0x188
55#define B43_MMIO_TSF_CFP_START 0x18C
56#define B43_MMIO_TSF_CFP_MAXDUR 0x190
Michael Buesche4d6b792007-09-18 15:39:42 -040057
58/* 32-bit DMA */
59#define B43_MMIO_DMA32_BASE0 0x200
60#define B43_MMIO_DMA32_BASE1 0x220
61#define B43_MMIO_DMA32_BASE2 0x240
62#define B43_MMIO_DMA32_BASE3 0x260
63#define B43_MMIO_DMA32_BASE4 0x280
64#define B43_MMIO_DMA32_BASE5 0x2A0
65/* 64-bit DMA */
66#define B43_MMIO_DMA64_BASE0 0x200
67#define B43_MMIO_DMA64_BASE1 0x240
68#define B43_MMIO_DMA64_BASE2 0x280
69#define B43_MMIO_DMA64_BASE3 0x2C0
70#define B43_MMIO_DMA64_BASE4 0x300
71#define B43_MMIO_DMA64_BASE5 0x340
Michael Buesche4d6b792007-09-18 15:39:42 -040072
Michael Buesch5100d5a2008-03-29 21:01:16 +010073/* PIO on core rev < 11 */
74#define B43_MMIO_PIO_BASE0 0x300
75#define B43_MMIO_PIO_BASE1 0x310
76#define B43_MMIO_PIO_BASE2 0x320
77#define B43_MMIO_PIO_BASE3 0x330
78#define B43_MMIO_PIO_BASE4 0x340
79#define B43_MMIO_PIO_BASE5 0x350
80#define B43_MMIO_PIO_BASE6 0x360
81#define B43_MMIO_PIO_BASE7 0x370
82/* PIO on core rev >= 11 */
83#define B43_MMIO_PIO11_BASE0 0x200
84#define B43_MMIO_PIO11_BASE1 0x240
85#define B43_MMIO_PIO11_BASE2 0x280
86#define B43_MMIO_PIO11_BASE3 0x2C0
87#define B43_MMIO_PIO11_BASE4 0x300
88#define B43_MMIO_PIO11_BASE5 0x340
89
Rafał Miłecki443c1a22011-06-13 16:20:05 +020090#define B43_MMIO_RADIO24_CONTROL 0x3D8 /* core rev >= 24 only */
91#define B43_MMIO_RADIO24_DATA 0x3DA /* core rev >= 24 only */
Michael Buesche4d6b792007-09-18 15:39:42 -040092#define B43_MMIO_PHY_VER 0x3E0
93#define B43_MMIO_PHY_RADIO 0x3E2
94#define B43_MMIO_PHY0 0x3E6
95#define B43_MMIO_ANTENNA 0x3E8
96#define B43_MMIO_CHANNEL 0x3F0
97#define B43_MMIO_CHANNEL_EXT 0x3F4
98#define B43_MMIO_RADIO_CONTROL 0x3F6
99#define B43_MMIO_RADIO_DATA_HIGH 0x3F8
100#define B43_MMIO_RADIO_DATA_LOW 0x3FA
101#define B43_MMIO_PHY_CONTROL 0x3FC
102#define B43_MMIO_PHY_DATA 0x3FE
103#define B43_MMIO_MACFILTER_CONTROL 0x420
104#define B43_MMIO_MACFILTER_DATA 0x422
105#define B43_MMIO_RCMTA_COUNT 0x43C
Rafał Miłecki97344852010-02-27 13:03:32 +0100106#define B43_MMIO_PSM_PHY_HDR 0x492
Michael Buesche4d6b792007-09-18 15:39:42 -0400107#define B43_MMIO_RADIO_HWENABLED_LO 0x49A
108#define B43_MMIO_GPIO_CONTROL 0x49C
109#define B43_MMIO_GPIO_MASK 0x49E
Rafał Miłecki7955d872011-09-21 21:44:13 +0200110#define B43_MMIO_TXE0_CTL 0x500
111#define B43_MMIO_TXE0_AUX 0x502
112#define B43_MMIO_TXE0_TS_LOC 0x504
113#define B43_MMIO_TXE0_TIME_OUT 0x506
114#define B43_MMIO_TXE0_WM_0 0x508
115#define B43_MMIO_TXE0_WM_1 0x50A
116#define B43_MMIO_TXE0_PHYCTL 0x50C
117#define B43_MMIO_TXE0_STATUS 0x50E
118#define B43_MMIO_TXE0_MMPLCP0 0x510
119#define B43_MMIO_TXE0_MMPLCP1 0x512
120#define B43_MMIO_TXE0_PHYCTL1 0x514
121#define B43_MMIO_XMTFIFODEF 0x520
122#define B43_MMIO_XMTFIFO_FRAME_CNT 0x522 /* core rev>= 16 only */
123#define B43_MMIO_XMTFIFO_BYTE_CNT 0x524 /* core rev>= 16 only */
124#define B43_MMIO_XMTFIFO_HEAD 0x526 /* core rev>= 16 only */
125#define B43_MMIO_XMTFIFO_RD_PTR 0x528 /* core rev>= 16 only */
126#define B43_MMIO_XMTFIFO_WR_PTR 0x52A /* core rev>= 16 only */
127#define B43_MMIO_XMTFIFODEF1 0x52C /* core rev>= 16 only */
128#define B43_MMIO_XMTFIFOCMD 0x540
129#define B43_MMIO_XMTFIFOFLUSH 0x542
130#define B43_MMIO_XMTFIFOTHRESH 0x544
131#define B43_MMIO_XMTFIFORDY 0x546
132#define B43_MMIO_XMTFIFOPRIRDY 0x548
133#define B43_MMIO_XMTFIFORQPRI 0x54A
134#define B43_MMIO_XMTTPLATETXPTR 0x54C
135#define B43_MMIO_XMTTPLATEPTR 0x550
136#define B43_MMIO_SMPL_CLCT_STRPTR 0x552 /* core rev>= 22 only */
137#define B43_MMIO_SMPL_CLCT_STPPTR 0x554 /* core rev>= 22 only */
138#define B43_MMIO_SMPL_CLCT_CURPTR 0x556 /* core rev>= 22 only */
139#define B43_MMIO_XMTTPLATEDATALO 0x560
140#define B43_MMIO_XMTTPLATEDATAHI 0x562
141#define B43_MMIO_XMTSEL 0x568
142#define B43_MMIO_XMTTXCNT 0x56A
143#define B43_MMIO_XMTTXSHMADDR 0x56C
Michael Bueschf3dd3fc2007-12-22 21:56:30 +0100144#define B43_MMIO_TSF_CFP_START_LOW 0x604
145#define B43_MMIO_TSF_CFP_START_HIGH 0x606
Michael Bueschd59f7202008-04-03 18:56:19 +0200146#define B43_MMIO_TSF_CFP_PRETBTT 0x612
Rafał Miłecki0b4ff452011-08-31 23:36:16 +0200147#define B43_MMIO_TSF_CLK_FRAC_LOW 0x62E
148#define B43_MMIO_TSF_CLK_FRAC_HIGH 0x630
Michael Buesche4d6b792007-09-18 15:39:42 -0400149#define B43_MMIO_TSF_0 0x632 /* core rev < 3 only */
150#define B43_MMIO_TSF_1 0x634 /* core rev < 3 only */
151#define B43_MMIO_TSF_2 0x636 /* core rev < 3 only */
152#define B43_MMIO_TSF_3 0x638 /* core rev < 3 only */
153#define B43_MMIO_RNG 0x65A
Larry Fingerb6c3f5b2010-02-02 10:08:19 -0600154#define B43_MMIO_IFSSLOT 0x684 /* Interframe slot time */
Rafał Miłecki7955d872011-09-21 21:44:13 +0200155#define B43_MMIO_IFSCTL 0x688 /* Interframe space control */
156#define B43_MMIO_IFSSTAT 0x690
157#define B43_MMIO_IFSMEDBUSYCTL 0x692
158#define B43_MMIO_IFTXDUR 0x694
Michael Buesche6f5b932008-03-05 21:18:49 +0100159#define B43_MMIO_IFSCTL_USE_EDCF 0x0004
Michael Buesche4d6b792007-09-18 15:39:42 -0400160#define B43_MMIO_POWERUP_DELAY 0x6A8
Michael Bueschce1a9ee32009-02-04 19:55:22 +0100161#define B43_MMIO_BTCOEX_CTL 0x6B4 /* Bluetooth Coexistence Control */
162#define B43_MMIO_BTCOEX_STAT 0x6B6 /* Bluetooth Coexistence Status */
163#define B43_MMIO_BTCOEX_TXCTL 0x6B8 /* Bluetooth Coexistence Transmit Control */
Rafał Miłecki7955d872011-09-21 21:44:13 +0200164#define B43_MMIO_WEPCTL 0x7C0
Michael Buesche4d6b792007-09-18 15:39:42 -0400165
166/* SPROM boardflags_lo values */
167#define B43_BFL_BTCOEXIST 0x0001 /* implements Bluetooth coexistance */
168#define B43_BFL_PACTRL 0x0002 /* GPIO 9 controlling the PA */
169#define B43_BFL_AIRLINEMODE 0x0004 /* implements GPIO 13 radio disable indication */
170#define B43_BFL_RSSI 0x0008 /* software calculates nrssi slope. */
171#define B43_BFL_ENETSPI 0x0010 /* has ephy roboswitch spi */
172#define B43_BFL_XTAL_NOSLOW 0x0020 /* no slow clock available */
173#define B43_BFL_CCKHIPWR 0x0040 /* can do high power CCK transmission */
174#define B43_BFL_ENETADM 0x0080 /* has ADMtek switch */
175#define B43_BFL_ENETVLAN 0x0100 /* can do vlan */
176#define B43_BFL_AFTERBURNER 0x0200 /* supports Afterburner mode */
177#define B43_BFL_NOPCI 0x0400 /* leaves PCI floating */
178#define B43_BFL_FEM 0x0800 /* supports the Front End Module */
179#define B43_BFL_EXTLNA 0x1000 /* has an external LNA */
180#define B43_BFL_HGPA 0x2000 /* had high gain PA */
181#define B43_BFL_BTCMOD 0x4000 /* BFL_BTCOEXIST is given in alternate GPIOs */
182#define B43_BFL_ALTIQ 0x8000 /* alternate I/Q settings */
183
Gábor Stefanik738f0f42009-08-03 01:28:12 +0200184/* SPROM boardflags_hi values */
185#define B43_BFH_NOPA 0x0001 /* has no PA */
186#define B43_BFH_RSSIINV 0x0002 /* RSSI uses positive slope (not TSSI) */
187#define B43_BFH_PAREF 0x0004 /* uses the PARef LDO */
188#define B43_BFH_3TSWITCH 0x0008 /* uses a triple throw switch shared
189 * with bluetooth */
190#define B43_BFH_PHASESHIFT 0x0010 /* can support phase shifter */
191#define B43_BFH_BUCKBOOST 0x0020 /* has buck/booster */
192#define B43_BFH_FEM_BT 0x0040 /* has FEM and switch to share antenna
193 * with bluetooth */
Rafał Miłeckicc96add2011-12-22 00:47:16 +0100194#define B43_BFH_NOCBUCK 0x0080
195#define B43_BFH_PALDO 0x0200
196#define B43_BFH_EXTLNA_5GHZ 0x1000 /* has an external LNA (5GHz mode) */
Gábor Stefanik738f0f42009-08-03 01:28:12 +0200197
Rafał Miłecki7e6da2b2010-10-22 17:43:47 +0200198/* SPROM boardflags2_lo values */
199#define B43_BFL2_RXBB_INT_REG_DIS 0x0001 /* external RX BB regulator present */
200#define B43_BFL2_APLL_WAR 0x0002 /* alternative A-band PLL settings implemented */
201#define B43_BFL2_TXPWRCTRL_EN 0x0004 /* permits enabling TX Power Control */
202#define B43_BFL2_2X4_DIV 0x0008 /* 2x4 diversity switch */
203#define B43_BFL2_5G_PWRGAIN 0x0010 /* supports 5G band power gain */
204#define B43_BFL2_PCIEWAR_OVR 0x0020 /* overrides ASPM and Clkreq settings */
205#define B43_BFL2_CAESERS_BRD 0x0040 /* is Caesers board (unused) */
206#define B43_BFL2_BTC3WIRE 0x0080 /* used 3-wire bluetooth coexist */
207#define B43_BFL2_SKWRKFEM_BRD 0x0100 /* 4321mcm93 uses Skyworks FEM */
208#define B43_BFL2_SPUR_WAR 0x0200 /* has a workaround for clock-harmonic spurs */
209#define B43_BFL2_GPLL_WAR 0x0400 /* altenative G-band PLL settings implemented */
Rafał Miłeckicc96add2011-12-22 00:47:16 +0100210#define B43_BFL2_SINGLEANT_CCK 0x1000
211#define B43_BFL2_2G_SPUR_WAR 0x2000
212
213/* SPROM boardflags2_hi values */
214#define B43_BFH2_GPLL_WAR2 0x0001
215#define B43_BFH2_IPALVLSHIFT_3P3 0x0002
216#define B43_BFH2_INTERNDET_TXIQCAL 0x0004
217#define B43_BFH2_XTALBUFOUTEN 0x0008
Rafał Miłecki7e6da2b2010-10-22 17:43:47 +0200218
Michael Buesche4d6b792007-09-18 15:39:42 -0400219/* GPIO register offset, in both ChipCommon and PCI core. */
220#define B43_GPIO_CONTROL 0x6c
221
222/* SHM Routing */
223enum {
224 B43_SHM_UCODE, /* Microcode memory */
225 B43_SHM_SHARED, /* Shared memory */
226 B43_SHM_SCRATCH, /* Scratch memory */
227 B43_SHM_HW, /* Internal hardware register */
228 B43_SHM_RCMTA, /* Receive match transmitter address (rev >= 5 only) */
229};
230/* SHM Routing modifiers */
231#define B43_SHM_AUTOINC_R 0x0200 /* Auto-increment address on read */
232#define B43_SHM_AUTOINC_W 0x0100 /* Auto-increment address on write */
233#define B43_SHM_AUTOINC_RW (B43_SHM_AUTOINC_R | \
234 B43_SHM_AUTOINC_W)
235
236/* Misc SHM_SHARED offsets */
237#define B43_SHM_SH_WLCOREREV 0x0016 /* 802.11 core revision */
238#define B43_SHM_SH_PCTLWDPOS 0x0008
239#define B43_SHM_SH_RXPADOFF 0x0034 /* RX Padding data offset (PIO only) */
Michael Buesch403a3a12009-06-08 21:04:57 +0200240#define B43_SHM_SH_FWCAPA 0x0042 /* Firmware capabilities (Opensource firmware only) */
Michael Buesche4d6b792007-09-18 15:39:42 -0400241#define B43_SHM_SH_PHYVER 0x0050 /* PHY version */
242#define B43_SHM_SH_PHYTYPE 0x0052 /* PHY type */
243#define B43_SHM_SH_ANTSWAP 0x005C /* Antenna swap threshold */
Rafał Miłecki6e6a2cd2012-07-25 16:58:38 +0200244#define B43_SHM_SH_HOSTF1 0x005E /* Hostflags 1 for ucode options */
245#define B43_SHM_SH_HOSTF2 0x0060 /* Hostflags 2 for ucode options */
246#define B43_SHM_SH_HOSTF3 0x0062 /* Hostflags 3 for ucode options */
Michael Buesche4d6b792007-09-18 15:39:42 -0400247#define B43_SHM_SH_RFATT 0x0064 /* Current radio attenuation value */
248#define B43_SHM_SH_RADAR 0x0066 /* Radar register */
249#define B43_SHM_SH_PHYTXNOI 0x006E /* PHY noise directly after TX (lower 8bit only) */
250#define B43_SHM_SH_RFRXSP1 0x0072 /* RF RX SP Register 1 */
Rafał Miłecki6e6a2cd2012-07-25 16:58:38 +0200251#define B43_SHM_SH_HOSTF4 0x0078 /* Hostflags 4 for ucode options */
Michael Buesche4d6b792007-09-18 15:39:42 -0400252#define B43_SHM_SH_CHAN 0x00A0 /* Current channel (low 8bit only) */
Rafał Miłecki106cb092010-10-06 07:50:07 +0200253#define B43_SHM_SH_CHAN_5GHZ 0x0100 /* Bit set, if 5 Ghz channel */
254#define B43_SHM_SH_CHAN_40MHZ 0x0200 /* Bit set, if 40 Mhz channel width */
Rafał Miłecki6e6a2cd2012-07-25 16:58:38 +0200255#define B43_SHM_SH_HOSTF5 0x00D4 /* Hostflags 5 for ucode options */
Michael Buesche4d6b792007-09-18 15:39:42 -0400256#define B43_SHM_SH_BCMCFIFOID 0x0108 /* Last posted cookie to the bcast/mcast FIFO */
Michael Buesch18c8ade2008-08-28 19:33:40 +0200257/* TSSI information */
258#define B43_SHM_SH_TSSI_CCK 0x0058 /* TSSI for last 4 CCK frames (32bit) */
259#define B43_SHM_SH_TSSI_OFDM_A 0x0068 /* TSSI for last 4 OFDM frames (32bit) */
260#define B43_SHM_SH_TSSI_OFDM_G 0x0070 /* TSSI for last 4 OFDM frames (32bit) */
261#define B43_TSSI_MAX 0x7F /* Max value for one TSSI value */
Michael Buesche4d6b792007-09-18 15:39:42 -0400262/* SHM_SHARED TX FIFO variables */
263#define B43_SHM_SH_SIZE01 0x0098 /* TX FIFO size for FIFO 0 (low) and 1 (high) */
264#define B43_SHM_SH_SIZE23 0x009A /* TX FIFO size for FIFO 2 and 3 */
265#define B43_SHM_SH_SIZE45 0x009C /* TX FIFO size for FIFO 4 and 5 */
266#define B43_SHM_SH_SIZE67 0x009E /* TX FIFO size for FIFO 6 and 7 */
267/* SHM_SHARED background noise */
268#define B43_SHM_SH_JSSI0 0x0088 /* Measure JSSI 0 */
269#define B43_SHM_SH_JSSI1 0x008A /* Measure JSSI 1 */
270#define B43_SHM_SH_JSSIAUX 0x008C /* Measure JSSI AUX */
271/* SHM_SHARED crypto engine */
272#define B43_SHM_SH_DEFAULTIV 0x003C /* Default IV location */
273#define B43_SHM_SH_NRRXTRANS 0x003E /* # of soft RX transmitter addresses (max 8) */
274#define B43_SHM_SH_KTP 0x0056 /* Key table pointer */
275#define B43_SHM_SH_TKIPTSCTTAK 0x0318
276#define B43_SHM_SH_KEYIDXBLOCK 0x05D4 /* Key index/algorithm block (v4 firmware) */
277#define B43_SHM_SH_PSM 0x05F4 /* PSM transmitter address match block (rev < 5) */
278/* SHM_SHARED WME variables */
279#define B43_SHM_SH_EDCFSTAT 0x000E /* EDCF status */
280#define B43_SHM_SH_TXFCUR 0x0030 /* TXF current index */
281#define B43_SHM_SH_EDCFQ 0x0240 /* EDCF Q info */
282/* SHM_SHARED powersave mode related */
283#define B43_SHM_SH_SLOTT 0x0010 /* Slot time */
284#define B43_SHM_SH_DTIMPER 0x0012 /* DTIM period */
285#define B43_SHM_SH_NOSLPZNATDTIM 0x004C /* NOSLPZNAT DTIM */
Michael Buesch280d0e12007-12-26 18:26:17 +0100286/* SHM_SHARED beacon/AP variables */
Michael Buesche4d6b792007-09-18 15:39:42 -0400287#define B43_SHM_SH_BTL0 0x0018 /* Beacon template length 0 */
288#define B43_SHM_SH_BTL1 0x001A /* Beacon template length 1 */
289#define B43_SHM_SH_BTSFOFF 0x001C /* Beacon TSF offset */
290#define B43_SHM_SH_TIMBPOS 0x001E /* TIM B position in beacon */
Michael Buesch280d0e12007-12-26 18:26:17 +0100291#define B43_SHM_SH_DTIMP 0x0012 /* DTIP period */
292#define B43_SHM_SH_MCASTCOOKIE 0x00A8 /* Last bcast/mcast frame ID */
Michael Buesche4d6b792007-09-18 15:39:42 -0400293#define B43_SHM_SH_SFFBLIM 0x0044 /* Short frame fallback retry limit */
294#define B43_SHM_SH_LFFBLIM 0x0046 /* Long frame fallback retry limit */
295#define B43_SHM_SH_BEACPHYCTL 0x0054 /* Beacon PHY TX control word (see PHY TX control) */
Michael Buesch280d0e12007-12-26 18:26:17 +0100296#define B43_SHM_SH_EXTNPHYCTL 0x00B0 /* Extended bytes for beacon PHY control (N) */
Michael Buesche4d6b792007-09-18 15:39:42 -0400297/* SHM_SHARED ACK/CTS control */
298#define B43_SHM_SH_ACKCTSPHYCTL 0x0022 /* ACK/CTS PHY control word (see PHY TX control) */
299/* SHM_SHARED probe response variables */
300#define B43_SHM_SH_PRSSID 0x0160 /* Probe Response SSID */
301#define B43_SHM_SH_PRSSIDLEN 0x0048 /* Probe Response SSID length */
302#define B43_SHM_SH_PRTLEN 0x004A /* Probe Response template length */
303#define B43_SHM_SH_PRMAXTIME 0x0074 /* Probe Response max time */
304#define B43_SHM_SH_PRPHYCTL 0x0188 /* Probe Response PHY TX control word */
305/* SHM_SHARED rate tables */
306#define B43_SHM_SH_OFDMDIRECT 0x01C0 /* Pointer to OFDM direct map */
307#define B43_SHM_SH_OFDMBASIC 0x01E0 /* Pointer to OFDM basic rate map */
308#define B43_SHM_SH_CCKDIRECT 0x0200 /* Pointer to CCK direct map */
309#define B43_SHM_SH_CCKBASIC 0x0220 /* Pointer to CCK basic rate map */
310/* SHM_SHARED microcode soft registers */
311#define B43_SHM_SH_UCODEREV 0x0000 /* Microcode revision */
312#define B43_SHM_SH_UCODEPATCH 0x0002 /* Microcode patchlevel */
313#define B43_SHM_SH_UCODEDATE 0x0004 /* Microcode date */
314#define B43_SHM_SH_UCODETIME 0x0006 /* Microcode time */
315#define B43_SHM_SH_UCODESTAT 0x0040 /* Microcode debug status code */
316#define B43_SHM_SH_UCODESTAT_INVALID 0
317#define B43_SHM_SH_UCODESTAT_INIT 1
318#define B43_SHM_SH_UCODESTAT_ACTIVE 2
319#define B43_SHM_SH_UCODESTAT_SUSP 3 /* suspended */
320#define B43_SHM_SH_UCODESTAT_SLEEP 4 /* asleep (PS) */
321#define B43_SHM_SH_MAXBFRAMES 0x0080 /* Maximum number of frames in a burst */
322#define B43_SHM_SH_SPUWKUP 0x0094 /* pre-wakeup for synth PU in us */
323#define B43_SHM_SH_PRETBTT 0x0096 /* pre-TBTT in us */
Rafał Miłecki76a4db32010-01-15 12:27:46 +0100324/* SHM_SHARED tx iq workarounds */
325#define B43_SHM_SH_NPHY_TXIQW0 0x0700
326#define B43_SHM_SH_NPHY_TXIQW1 0x0702
327#define B43_SHM_SH_NPHY_TXIQW2 0x0704
328#define B43_SHM_SH_NPHY_TXIQW3 0x0706
329/* SHM_SHARED tx pwr ctrl */
330#define B43_SHM_SH_NPHY_TXPWR_INDX0 0x0708
331#define B43_SHM_SH_NPHY_TXPWR_INDX1 0x070E
Michael Buesche4d6b792007-09-18 15:39:42 -0400332
333/* SHM_SCRATCH offsets */
334#define B43_SHM_SC_MINCONT 0x0003 /* Minimum contention window */
335#define B43_SHM_SC_MAXCONT 0x0004 /* Maximum contention window */
336#define B43_SHM_SC_CURCONT 0x0005 /* Current contention window */
337#define B43_SHM_SC_SRLIMIT 0x0006 /* Short retry count limit */
338#define B43_SHM_SC_LRLIMIT 0x0007 /* Long retry count limit */
339#define B43_SHM_SC_DTIMC 0x0008 /* Current DTIM count */
340#define B43_SHM_SC_BTL0LEN 0x0015 /* Beacon 0 template length */
341#define B43_SHM_SC_BTL1LEN 0x0016 /* Beacon 1 template length */
342#define B43_SHM_SC_SCFB 0x0017 /* Short frame transmit count threshold for rate fallback */
343#define B43_SHM_SC_LCFB 0x0018 /* Long frame transmit count threshold for rate fallback */
344
345/* Hardware Radio Enable masks */
346#define B43_MMIO_RADIO_HWENABLED_HI_MASK (1 << 16)
347#define B43_MMIO_RADIO_HWENABLED_LO_MASK (1 << 4)
348
349/* HostFlags. See b43_hf_read/write() */
Michael Buesch35f0d352008-02-13 14:31:08 +0100350#define B43_HF_ANTDIVHELP 0x000000000001ULL /* ucode antenna div helper */
351#define B43_HF_SYMW 0x000000000002ULL /* G-PHY SYM workaround */
352#define B43_HF_RXPULLW 0x000000000004ULL /* RX pullup workaround */
353#define B43_HF_CCKBOOST 0x000000000008ULL /* 4dB CCK power boost (exclusive with OFDM boost) */
354#define B43_HF_BTCOEX 0x000000000010ULL /* Bluetooth coexistance */
355#define B43_HF_GDCW 0x000000000020ULL /* G-PHY DC canceller filter bw workaround */
356#define B43_HF_OFDMPABOOST 0x000000000040ULL /* Enable PA gain boost for OFDM */
357#define B43_HF_ACPR 0x000000000080ULL /* Disable for Japan, channel 14 */
358#define B43_HF_EDCF 0x000000000100ULL /* on if WME and MAC suspended */
359#define B43_HF_TSSIRPSMW 0x000000000200ULL /* TSSI reset PSM ucode workaround */
360#define B43_HF_20IN40IQW 0x000000000200ULL /* 20 in 40 MHz I/Q workaround (rev >= 13 only) */
361#define B43_HF_DSCRQ 0x000000000400ULL /* Disable slow clock request in ucode */
362#define B43_HF_ACIW 0x000000000800ULL /* ACI workaround: shift bits by 2 on PHY CRS */
363#define B43_HF_2060W 0x000000001000ULL /* 2060 radio workaround */
364#define B43_HF_RADARW 0x000000002000ULL /* Radar workaround */
365#define B43_HF_USEDEFKEYS 0x000000004000ULL /* Enable use of default keys */
366#define B43_HF_AFTERBURNER 0x000000008000ULL /* Afterburner enabled */
367#define B43_HF_BT4PRIOCOEX 0x000000010000ULL /* Bluetooth 4-priority coexistance */
368#define B43_HF_FWKUP 0x000000020000ULL /* Fast wake-up ucode */
369#define B43_HF_VCORECALC 0x000000040000ULL /* Force VCO recalculation when powering up synthpu */
370#define B43_HF_PCISCW 0x000000080000ULL /* PCI slow clock workaround */
371#define B43_HF_4318TSSI 0x000000200000ULL /* 4318 TSSI */
372#define B43_HF_FBCMCFIFO 0x000000400000ULL /* Flush bcast/mcast FIFO immediately */
373#define B43_HF_HWPCTL 0x000000800000ULL /* Enable hardwarre power control */
374#define B43_HF_BTCOEXALT 0x000001000000ULL /* Bluetooth coexistance in alternate pins */
375#define B43_HF_TXBTCHECK 0x000002000000ULL /* Bluetooth check during transmission */
376#define B43_HF_SKCFPUP 0x000004000000ULL /* Skip CFP update */
377#define B43_HF_N40W 0x000008000000ULL /* N PHY 40 MHz workaround (rev >= 13 only) */
378#define B43_HF_ANTSEL 0x000020000000ULL /* Antenna selection (for testing antenna div.) */
379#define B43_HF_BT3COEXT 0x000020000000ULL /* Bluetooth 3-wire coexistence (rev >= 13 only) */
380#define B43_HF_BTCANT 0x000040000000ULL /* Bluetooth coexistence (antenna mode) (rev >= 13 only) */
381#define B43_HF_ANTSELEN 0x000100000000ULL /* Antenna selection enabled (rev >= 13 only) */
382#define B43_HF_ANTSELMODE 0x000200000000ULL /* Antenna selection mode (rev >= 13 only) */
383#define B43_HF_MLADVW 0x001000000000ULL /* N PHY ML ADV workaround (rev >= 13 only) */
384#define B43_HF_PR45960W 0x080000000000ULL /* PR 45960 workaround (rev >= 13 only) */
Michael Buesche4d6b792007-09-18 15:39:42 -0400385
Michael Buesch403a3a12009-06-08 21:04:57 +0200386/* Firmware capabilities field in SHM (Opensource firmware only) */
387#define B43_FWCAPA_HWCRYPTO 0x0001
388#define B43_FWCAPA_QOS 0x0002
389
Michael Buesche4d6b792007-09-18 15:39:42 -0400390/* MacFilter offsets. */
391#define B43_MACFILTER_SELF 0x0000
392#define B43_MACFILTER_BSSID 0x0003
393
394/* PowerControl */
395#define B43_PCTL_IN 0xB0
396#define B43_PCTL_OUT 0xB4
397#define B43_PCTL_OUTENABLE 0xB8
398#define B43_PCTL_XTAL_POWERUP 0x40
399#define B43_PCTL_PLL_POWERDOWN 0x80
400
401/* PowerControl Clock Modes */
402#define B43_PCTL_CLK_FAST 0x00
403#define B43_PCTL_CLK_SLOW 0x01
404#define B43_PCTL_CLK_DYNAMIC 0x02
405
406#define B43_PCTL_FORCE_SLOW 0x0800
407#define B43_PCTL_FORCE_PLL 0x1000
408#define B43_PCTL_DYN_XTAL 0x2000
409
410/* PHYVersioning */
411#define B43_PHYTYPE_A 0x00
412#define B43_PHYTYPE_B 0x01
413#define B43_PHYTYPE_G 0x02
Michael Bueschd9871602008-01-02 18:55:53 +0100414#define B43_PHYTYPE_N 0x04
415#define B43_PHYTYPE_LP 0x05
Rafał Miłecki443c1a22011-06-13 16:20:05 +0200416#define B43_PHYTYPE_SSLPN 0x06
417#define B43_PHYTYPE_HT 0x07
418#define B43_PHYTYPE_LCN 0x08
419#define B43_PHYTYPE_LCNXN 0x09
Rafał Miłecki2fdf8c52012-07-26 08:16:01 +0200420#define B43_PHYTYPE_LCN40 0x0a
421#define B43_PHYTYPE_AC 0x0b
Michael Buesche4d6b792007-09-18 15:39:42 -0400422
423/* PHYRegisters */
424#define B43_PHY_ILT_A_CTRL 0x0072
425#define B43_PHY_ILT_A_DATA1 0x0073
426#define B43_PHY_ILT_A_DATA2 0x0074
427#define B43_PHY_G_LO_CONTROL 0x0810
428#define B43_PHY_ILT_G_CTRL 0x0472
429#define B43_PHY_ILT_G_DATA1 0x0473
430#define B43_PHY_ILT_G_DATA2 0x0474
431#define B43_PHY_A_PCTL 0x007B
432#define B43_PHY_G_PCTL 0x0029
433#define B43_PHY_A_CRS 0x0029
434#define B43_PHY_RADIO_BITFIELD 0x0401
435#define B43_PHY_G_CRS 0x0429
436#define B43_PHY_NRSSILT_CTRL 0x0803
437#define B43_PHY_NRSSILT_DATA 0x0804
438
439/* RadioRegisters */
440#define B43_RADIOCTL_ID 0x01
441
442/* MAC Control bitfield */
443#define B43_MACCTL_ENABLED 0x00000001 /* MAC Enabled */
444#define B43_MACCTL_PSM_RUN 0x00000002 /* Run Microcode */
445#define B43_MACCTL_PSM_JMP0 0x00000004 /* Microcode jump to 0 */
446#define B43_MACCTL_SHM_ENABLED 0x00000100 /* SHM Enabled */
447#define B43_MACCTL_SHM_UPPER 0x00000200 /* SHM Upper */
448#define B43_MACCTL_IHR_ENABLED 0x00000400 /* IHR Region Enabled */
449#define B43_MACCTL_PSM_DBG 0x00002000 /* Microcode debugging enabled */
450#define B43_MACCTL_GPOUTSMSK 0x0000C000 /* GPOUT Select Mask */
451#define B43_MACCTL_BE 0x00010000 /* Big Endian mode */
452#define B43_MACCTL_INFRA 0x00020000 /* Infrastructure mode */
453#define B43_MACCTL_AP 0x00040000 /* AccessPoint mode */
454#define B43_MACCTL_RADIOLOCK 0x00080000 /* Radio lock */
455#define B43_MACCTL_BEACPROMISC 0x00100000 /* Beacon Promiscuous */
456#define B43_MACCTL_KEEP_BADPLCP 0x00200000 /* Keep frames with bad PLCP */
457#define B43_MACCTL_KEEP_CTL 0x00400000 /* Keep control frames */
458#define B43_MACCTL_KEEP_BAD 0x00800000 /* Keep bad frames (FCS) */
459#define B43_MACCTL_PROMISC 0x01000000 /* Promiscuous mode */
460#define B43_MACCTL_HWPS 0x02000000 /* Hardware Power Saving */
461#define B43_MACCTL_AWAKE 0x04000000 /* Device is awake */
462#define B43_MACCTL_CLOSEDNET 0x08000000 /* Closed net (no SSID bcast) */
463#define B43_MACCTL_TBTTHOLD 0x10000000 /* TBTT Hold */
464#define B43_MACCTL_DISCTXSTAT 0x20000000 /* Discard TX status */
465#define B43_MACCTL_DISCPMQ 0x40000000 /* Discard Power Management Queue */
466#define B43_MACCTL_GMODE 0x80000000 /* G Mode */
467
Michael Bueschaa6c7ae2007-12-26 16:26:36 +0100468/* MAC Command bitfield */
469#define B43_MACCMD_BEACON0_VALID 0x00000001 /* Beacon 0 in template RAM is busy/valid */
470#define B43_MACCMD_BEACON1_VALID 0x00000002 /* Beacon 1 in template RAM is busy/valid */
471#define B43_MACCMD_DFQ_VALID 0x00000004 /* Directed frame queue valid (IBSS PS mode, ATIM) */
472#define B43_MACCMD_CCA 0x00000008 /* Clear channel assessment */
473#define B43_MACCMD_BGNOISE 0x00000010 /* Background noise */
474
Rafał Miłeckiaa4e0142011-06-02 13:43:24 +0200475/* BCMA 802.11 core specific IO Control (BCMA_IOCTL) flags */
476#define B43_BCMA_IOCTL_PHY_CLKEN 0x00000004 /* PHY Clock Enable */
477#define B43_BCMA_IOCTL_PHY_RESET 0x00000008 /* PHY Reset */
478#define B43_BCMA_IOCTL_MACPHYCLKEN 0x00000010 /* MAC PHY Clock Control Enable */
479#define B43_BCMA_IOCTL_PLLREFSEL 0x00000020 /* PLL Frequency Reference Select */
480#define B43_BCMA_IOCTL_PHY_BW 0x000000C0 /* PHY band width and clock speed mask (N-PHY+ only?) */
481#define B43_BCMA_IOCTL_PHY_BW_10MHZ 0x00000000 /* 10 MHz bandwidth, 40 MHz PHY */
482#define B43_BCMA_IOCTL_PHY_BW_20MHZ 0x00000040 /* 20 MHz bandwidth, 80 MHz PHY */
483#define B43_BCMA_IOCTL_PHY_BW_40MHZ 0x00000080 /* 40 MHz bandwidth, 160 MHz PHY */
484#define B43_BCMA_IOCTL_GMODE 0x00002000 /* G Mode Enable */
485
Rafał Miłecki124cc112011-07-18 02:01:29 +0200486/* BCMA 802.11 core specific IO status (BCMA_IOST) flags */
487#define B43_BCMA_IOST_2G_PHY 0x00000001 /* 2.4G capable phy */
488#define B43_BCMA_IOST_5G_PHY 0x00000002 /* 5G capable phy */
489#define B43_BCMA_IOST_FASTCLKA 0x00000004 /* Fast Clock Available */
490#define B43_BCMA_IOST_DUALB_PHY 0x00000008 /* Dualband phy */
491
Michael Buesch96c755a2008-01-06 00:09:46 +0100492/* 802.11 core specific TM State Low (SSB_TMSLOW) flags */
Michael Buesche4d6b792007-09-18 15:39:42 -0400493#define B43_TMSLOW_GMODE 0x20000000 /* G Mode Enable */
Rafał Miłecki42ab1352010-12-09 20:56:01 +0100494#define B43_TMSLOW_PHY_BANDWIDTH 0x00C00000 /* PHY band width and clock speed mask (N-PHY only) */
495#define B43_TMSLOW_PHY_BANDWIDTH_10MHZ 0x00000000 /* 10 MHz bandwidth, 40 MHz PHY */
496#define B43_TMSLOW_PHY_BANDWIDTH_20MHZ 0x00400000 /* 20 MHz bandwidth, 80 MHz PHY */
497#define B43_TMSLOW_PHY_BANDWIDTH_40MHZ 0x00800000 /* 40 MHz bandwidth, 160 MHz PHY */
Michael Buesch96c755a2008-01-06 00:09:46 +0100498#define B43_TMSLOW_PLLREFSEL 0x00200000 /* PLL Frequency Reference Select (rev >= 5) */
Michael Buesche4d6b792007-09-18 15:39:42 -0400499#define B43_TMSLOW_MACPHYCLKEN 0x00100000 /* MAC PHY Clock Control Enable (rev >= 5) */
500#define B43_TMSLOW_PHYRESET 0x00080000 /* PHY Reset */
501#define B43_TMSLOW_PHYCLKEN 0x00040000 /* PHY Clock Enable */
502
Michael Buesch96c755a2008-01-06 00:09:46 +0100503/* 802.11 core specific TM State High (SSB_TMSHIGH) flags */
504#define B43_TMSHIGH_DUALBAND_PHY 0x00080000 /* Dualband PHY available */
Michael Buesche4d6b792007-09-18 15:39:42 -0400505#define B43_TMSHIGH_FCLOCK 0x00040000 /* Fast Clock Available (rev >= 5) */
Michael Buesch96c755a2008-01-06 00:09:46 +0100506#define B43_TMSHIGH_HAVE_5GHZ_PHY 0x00020000 /* 5 GHz PHY available (rev >= 5) */
507#define B43_TMSHIGH_HAVE_2GHZ_PHY 0x00010000 /* 2.4 GHz PHY available (rev >= 5) */
Michael Buesche4d6b792007-09-18 15:39:42 -0400508
509/* Generic-Interrupt reasons. */
510#define B43_IRQ_MAC_SUSPENDED 0x00000001
511#define B43_IRQ_BEACON 0x00000002
512#define B43_IRQ_TBTT_INDI 0x00000004
513#define B43_IRQ_BEACON_TX_OK 0x00000008
514#define B43_IRQ_BEACON_CANCEL 0x00000010
515#define B43_IRQ_ATIM_END 0x00000020
516#define B43_IRQ_PMQ 0x00000040
517#define B43_IRQ_PIO_WORKAROUND 0x00000100
518#define B43_IRQ_MAC_TXERR 0x00000200
519#define B43_IRQ_PHY_TXERR 0x00000800
520#define B43_IRQ_PMEVENT 0x00001000
521#define B43_IRQ_TIMER0 0x00002000
522#define B43_IRQ_TIMER1 0x00004000
523#define B43_IRQ_DMA 0x00008000
524#define B43_IRQ_TXFIFO_FLUSH_OK 0x00010000
525#define B43_IRQ_CCA_MEASURE_OK 0x00020000
526#define B43_IRQ_NOISESAMPLE_OK 0x00040000
527#define B43_IRQ_UCODE_DEBUG 0x08000000
528#define B43_IRQ_RFKILL 0x10000000
529#define B43_IRQ_TX_OK 0x20000000
530#define B43_IRQ_PHY_G_CHANGED 0x40000000
531#define B43_IRQ_TIMEOUT 0x80000000
532
533#define B43_IRQ_ALL 0xFFFFFFFF
Michael Buesche40ac412008-04-25 21:10:54 +0200534#define B43_IRQ_MASKTEMPLATE (B43_IRQ_TBTT_INDI | \
Michael Buesche4d6b792007-09-18 15:39:42 -0400535 B43_IRQ_ATIM_END | \
536 B43_IRQ_PMQ | \
537 B43_IRQ_MAC_TXERR | \
538 B43_IRQ_PHY_TXERR | \
539 B43_IRQ_DMA | \
540 B43_IRQ_TXFIFO_FLUSH_OK | \
541 B43_IRQ_NOISESAMPLE_OK | \
542 B43_IRQ_UCODE_DEBUG | \
543 B43_IRQ_RFKILL | \
544 B43_IRQ_TX_OK)
545
Michael Bueschafa83e22008-05-19 23:51:37 +0200546/* The firmware register to fetch the debug-IRQ reason from. */
547#define B43_DEBUGIRQ_REASON_REG 63
Michael Buesche48b0ee2008-05-17 22:44:35 +0200548/* Debug-IRQ reasons. */
549#define B43_DEBUGIRQ_PANIC 0 /* The firmware panic'ed */
550#define B43_DEBUGIRQ_DUMP_SHM 1 /* Dump shared SHM */
551#define B43_DEBUGIRQ_DUMP_REGS 2 /* Dump the microcode registers */
Michael Buesch53c06852008-05-20 00:24:36 +0200552#define B43_DEBUGIRQ_MARKER 3 /* A "marker" was thrown by the firmware. */
Michael Buesche48b0ee2008-05-17 22:44:35 +0200553#define B43_DEBUGIRQ_ACK 0xFFFF /* The host writes that to ACK the IRQ */
554
Michael Buesch53c06852008-05-20 00:24:36 +0200555/* The firmware register that contains the "marker" line. */
556#define B43_MARKER_ID_REG 2
557#define B43_MARKER_LINE_REG 3
558
Michael Bueschafa83e22008-05-19 23:51:37 +0200559/* The firmware register to fetch the panic reason from. */
560#define B43_FWPANIC_REASON_REG 3
561/* Firmware panic reason codes */
562#define B43_FWPANIC_DIE 0 /* Firmware died. Don't auto-restart it. */
563#define B43_FWPANIC_RESTART 1 /* Firmware died. Schedule a controller reset. */
564
Michael Buesch9b839a72008-06-20 17:44:02 +0200565/* The firmware register that contains the watchdog counter. */
566#define B43_WATCHDOG_REG 1
Michael Bueschafa83e22008-05-19 23:51:37 +0200567
Michael Buesche4d6b792007-09-18 15:39:42 -0400568/* Device specific rate values.
569 * The actual values defined here are (rate_in_mbps * 2).
570 * Some code depends on this. Don't change it. */
571#define B43_CCK_RATE_1MB 0x02
572#define B43_CCK_RATE_2MB 0x04
573#define B43_CCK_RATE_5MB 0x0B
574#define B43_CCK_RATE_11MB 0x16
575#define B43_OFDM_RATE_6MB 0x0C
576#define B43_OFDM_RATE_9MB 0x12
577#define B43_OFDM_RATE_12MB 0x18
578#define B43_OFDM_RATE_18MB 0x24
579#define B43_OFDM_RATE_24MB 0x30
580#define B43_OFDM_RATE_36MB 0x48
581#define B43_OFDM_RATE_48MB 0x60
582#define B43_OFDM_RATE_54MB 0x6C
583/* Convert a b43 rate value to a rate in 100kbps */
584#define B43_RATE_TO_BASE100KBPS(rate) (((rate) * 10) / 2)
585
586#define B43_DEFAULT_SHORT_RETRY_LIMIT 7
587#define B43_DEFAULT_LONG_RETRY_LIMIT 4
588
Stefano Brivio00e0b8c2007-11-25 11:10:33 +0100589#define B43_PHY_TX_BADNESS_LIMIT 1000
590
Michael Buesche4d6b792007-09-18 15:39:42 -0400591/* Max size of a security key */
592#define B43_SEC_KEYSIZE 16
Michael Buesch66d2d082009-08-06 10:36:50 +0200593/* Max number of group keys */
594#define B43_NR_GROUP_KEYS 4
595/* Max number of pairwise keys */
596#define B43_NR_PAIRWISE_KEYS 50
Michael Buesche4d6b792007-09-18 15:39:42 -0400597/* Security algorithms. */
598enum {
599 B43_SEC_ALGO_NONE = 0, /* unencrypted, as of TX header. */
600 B43_SEC_ALGO_WEP40,
601 B43_SEC_ALGO_TKIP,
602 B43_SEC_ALGO_AES,
603 B43_SEC_ALGO_WEP104,
604 B43_SEC_ALGO_AES_LEGACY,
605};
606
607struct b43_dmaring;
Michael Buesche4d6b792007-09-18 15:39:42 -0400608
609/* The firmware file header */
610#define B43_FW_TYPE_UCODE 'u'
611#define B43_FW_TYPE_PCM 'p'
612#define B43_FW_TYPE_IV 'i'
613struct b43_fw_header {
614 /* File type */
615 u8 type;
616 /* File format version */
617 u8 ver;
618 u8 __padding[2];
619 /* Size of the data. For ucode and PCM this is in bytes.
620 * For IV this is number-of-ivs. */
621 __be32 size;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000622} __packed;
Michael Buesche4d6b792007-09-18 15:39:42 -0400623
624/* Initial Value file format */
625#define B43_IV_OFFSET_MASK 0x7FFF
626#define B43_IV_32BIT 0x8000
627struct b43_iv {
628 __be16 offset_size;
629 union {
630 __be16 d16;
631 __be32 d32;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000632 } data __packed;
633} __packed;
Michael Buesche4d6b792007-09-18 15:39:42 -0400634
635
Michael Buesche4d6b792007-09-18 15:39:42 -0400636/* Data structures for DMA transmission, per 80211 core. */
637struct b43_dma {
Michael Bueschb27faf82008-03-06 16:32:46 +0100638 struct b43_dmaring *tx_ring_AC_BK; /* Background */
639 struct b43_dmaring *tx_ring_AC_BE; /* Best Effort */
640 struct b43_dmaring *tx_ring_AC_VI; /* Video */
641 struct b43_dmaring *tx_ring_AC_VO; /* Voice */
642 struct b43_dmaring *tx_ring_mcast; /* Multicast */
Michael Buesche4d6b792007-09-18 15:39:42 -0400643
Michael Bueschb27faf82008-03-06 16:32:46 +0100644 struct b43_dmaring *rx_ring;
Rafał Miłecki05100a22011-05-17 14:00:02 +0200645
646 u32 translation; /* Routing bits */
Rafał Miłecki0cc97722011-08-14 20:16:37 +0200647 bool translation_in_low; /* Should translation bit go into low addr? */
Rafał Miłecki78c1ee72011-07-20 19:47:07 +0200648 bool parity; /* Check for parity */
Michael Buesche4d6b792007-09-18 15:39:42 -0400649};
650
Michael Buesch5100d5a2008-03-29 21:01:16 +0100651struct b43_pio_txqueue;
652struct b43_pio_rxqueue;
653
654/* Data structures for PIO transmission, per 80211 core. */
655struct b43_pio {
656 struct b43_pio_txqueue *tx_queue_AC_BK; /* Background */
657 struct b43_pio_txqueue *tx_queue_AC_BE; /* Best Effort */
658 struct b43_pio_txqueue *tx_queue_AC_VI; /* Video */
659 struct b43_pio_txqueue *tx_queue_AC_VO; /* Voice */
660 struct b43_pio_txqueue *tx_queue_mcast; /* Multicast */
661
662 struct b43_pio_rxqueue *rx_queue;
663};
664
Michael Buesche4d6b792007-09-18 15:39:42 -0400665/* Context information for a noise calculation (Link Quality). */
666struct b43_noise_calculation {
Michael Buesche4d6b792007-09-18 15:39:42 -0400667 bool calculation_running;
668 u8 nr_samples;
669 s8 samples[8][4];
670};
671
672struct b43_stats {
673 u8 link_noise;
Michael Buesche4d6b792007-09-18 15:39:42 -0400674};
675
676struct b43_key {
677 /* If keyconf is NULL, this key is disabled.
678 * keyconf is a cookie. Don't derefenrence it outside of the set_key
679 * path, because b43 doesn't own it. */
680 struct ieee80211_key_conf *keyconf;
681 u8 algorithm;
682};
683
Michael Buesche6f5b932008-03-05 21:18:49 +0100684/* SHM offsets to the QOS data structures for the 4 different queues. */
francesco.gringoli@ing.unibs.itbad69192011-12-16 18:34:56 +0100685#define B43_QOS_QUEUE_NUM 4
Michael Buesche6f5b932008-03-05 21:18:49 +0100686#define B43_QOS_PARAMS(queue) (B43_SHM_SH_EDCFQ + \
687 (B43_NR_QOSPARAMS * sizeof(u16) * (queue)))
688#define B43_QOS_BACKGROUND B43_QOS_PARAMS(0)
689#define B43_QOS_BESTEFFORT B43_QOS_PARAMS(1)
690#define B43_QOS_VIDEO B43_QOS_PARAMS(2)
691#define B43_QOS_VOICE B43_QOS_PARAMS(3)
692
693/* QOS parameter hardware data structure offsets. */
Lorenzo Navae35cc4d2008-09-11 15:06:24 +0200694#define B43_NR_QOSPARAMS 16
Michael Buesche6f5b932008-03-05 21:18:49 +0100695enum {
696 B43_QOSPARAM_TXOP = 0,
697 B43_QOSPARAM_CWMIN,
698 B43_QOSPARAM_CWMAX,
699 B43_QOSPARAM_CWCUR,
700 B43_QOSPARAM_AIFS,
701 B43_QOSPARAM_BSLOTS,
702 B43_QOSPARAM_REGGAP,
703 B43_QOSPARAM_STATUS,
704};
705
706/* QOS parameters for a queue. */
707struct b43_qos_params {
708 /* The QOS parameters */
709 struct ieee80211_tx_queue_params p;
Michael Buesche6f5b932008-03-05 21:18:49 +0100710};
711
Albert Herranz7e937c62009-10-07 00:07:44 +0200712struct b43_wl;
Michael Buesche4d6b792007-09-18 15:39:42 -0400713
Michael Buesch1a9f5092009-01-23 21:21:51 +0100714/* The type of the firmware file. */
715enum b43_firmware_file_type {
716 B43_FWTYPE_PROPRIETARY,
717 B43_FWTYPE_OPENSOURCE,
718 B43_NR_FWTYPES,
719};
720
721/* Context data for fetching firmware. */
722struct b43_request_fw_context {
723 /* The device we are requesting the fw for. */
724 struct b43_wldev *dev;
725 /* The type of firmware to request. */
726 enum b43_firmware_file_type req_type;
727 /* Error messages for each firmware type. */
728 char errors[B43_NR_FWTYPES][128];
729 /* Temporary buffer for storing the firmware name. */
730 char fwname[64];
Jim Cromiee64851f2011-05-21 11:51:50 -0600731 /* A fatal error occurred while requesting. Firmware request
732 * can not continue, as any other request will also fail. */
Michael Buesch1a9f5092009-01-23 21:21:51 +0100733 int fatal_failure;
734};
735
Michael Buesch61cb5dd2008-01-21 19:55:09 +0100736/* In-memory representation of a cached microcode file. */
737struct b43_firmware_file {
738 const char *filename;
739 const struct firmware *data;
Michael Buesch1a9f5092009-01-23 21:21:51 +0100740 /* Type of the firmware file name. Note that this does only indicate
741 * the type by the firmware name. NOT the file contents.
742 * If you want to check for proprietary vs opensource, use (struct b43_firmware)->opensource
743 * instead! The (struct b43_firmware)->opensource flag is derived from the actual firmware
744 * binary code, not just the filename.
745 */
746 enum b43_firmware_file_type type;
Michael Buesch61cb5dd2008-01-21 19:55:09 +0100747};
748
Rafał Miłeckiefe02492011-08-11 15:07:15 +0200749enum b43_firmware_hdr_format {
Rafał Miłecki5d852902011-08-11 15:07:16 +0200750 B43_FW_HDR_598,
Rafał Miłeckiefe02492011-08-11 15:07:15 +0200751 B43_FW_HDR_410,
752 B43_FW_HDR_351,
753};
754
Michael Buesche4d6b792007-09-18 15:39:42 -0400755/* Pointers to the firmware data and meta information about it. */
756struct b43_firmware {
757 /* Microcode */
Michael Buesch61cb5dd2008-01-21 19:55:09 +0100758 struct b43_firmware_file ucode;
Michael Buesche4d6b792007-09-18 15:39:42 -0400759 /* PCM code */
Michael Buesch61cb5dd2008-01-21 19:55:09 +0100760 struct b43_firmware_file pcm;
Michael Buesche4d6b792007-09-18 15:39:42 -0400761 /* Initial MMIO values for the firmware */
Michael Buesch61cb5dd2008-01-21 19:55:09 +0100762 struct b43_firmware_file initvals;
Michael Buesche4d6b792007-09-18 15:39:42 -0400763 /* Initial MMIO values for the firmware, band-specific */
Michael Buesch61cb5dd2008-01-21 19:55:09 +0100764 struct b43_firmware_file initvals_band;
765
Michael Buesche4d6b792007-09-18 15:39:42 -0400766 /* Firmware revision */
767 u16 rev;
768 /* Firmware patchlevel */
769 u16 patch;
Michael Buesche48b0ee2008-05-17 22:44:35 +0200770
Rafał Miłeckiefe02492011-08-11 15:07:15 +0200771 /* Format of header used by firmware */
772 enum b43_firmware_hdr_format hdr_format;
773
Michael Buesch1a9f5092009-01-23 21:21:51 +0100774 /* Set to true, if we are using an opensource firmware.
775 * Use this to check for proprietary vs opensource. */
Michael Buesche48b0ee2008-05-17 22:44:35 +0200776 bool opensource;
Michael Buesch68217832008-05-17 23:43:57 +0200777 /* Set to true, if the core needs a PCM firmware, but
778 * we failed to load one. This is always false for
779 * core rev > 10, as these don't need PCM firmware. */
780 bool pcm_request_failed;
Michael Buesche4d6b792007-09-18 15:39:42 -0400781};
782
783/* Device (802.11 core) initialization status. */
784enum {
785 B43_STAT_UNINIT = 0, /* Uninitialized. */
786 B43_STAT_INITIALIZED = 1, /* Initialized, but not started, yet. */
787 B43_STAT_STARTED = 2, /* Up and running. */
788};
789#define b43_status(wldev) atomic_read(&(wldev)->__init_status)
790#define b43_set_status(wldev, stat) do { \
791 atomic_set(&(wldev)->__init_status, (stat)); \
792 smp_wmb(); \
793 } while (0)
794
Michael Buesche4d6b792007-09-18 15:39:42 -0400795/* Data structure for one wireless device (802.11 core) */
796struct b43_wldev {
Rafał Miłecki482f0532011-05-18 02:06:36 +0200797 struct b43_bus_dev *dev;
Michael Buesche4d6b792007-09-18 15:39:42 -0400798 struct b43_wl *wl;
799
800 /* The device initialization status.
801 * Use b43_status() to query. */
802 atomic_t __init_status;
Michael Buesche4d6b792007-09-18 15:39:42 -0400803
Michael Buesche4d6b792007-09-18 15:39:42 -0400804 bool bad_frames_preempt; /* Use "Bad Frames Preemption" (default off) */
Michael Bueschaa6c7ae2007-12-26 16:26:36 +0100805 bool dfq_valid; /* Directed frame queue valid (IBSS PS mode, ATIM) */
Michael Buesche4d6b792007-09-18 15:39:42 -0400806 bool radio_hw_enable; /* saved state of radio hardware enabled state */
Michael Buesch403a3a12009-06-08 21:04:57 +0200807 bool qos_enabled; /* TRUE, if QoS is used. */
808 bool hwcrypto_enabled; /* TRUE, if HW crypto acceleration is enabled. */
Linus Torvalds9e3bd912010-02-26 10:34:27 -0800809 bool use_pio; /* TRUE if next init should use PIO */
Michael Buesche4d6b792007-09-18 15:39:42 -0400810
811 /* PHY/Radio device. */
812 struct b43_phy phy;
Michael Buesch03b29772007-12-26 14:41:30 +0100813
Michael Buesch5100d5a2008-03-29 21:01:16 +0100814 union {
815 /* DMA engines. */
816 struct b43_dma dma;
817 /* PIO engines. */
818 struct b43_pio pio;
819 };
820 /* Use b43_using_pio_transfers() to check whether we are using
821 * DMA or PIO data transfers. */
822 bool __using_pio_transfers;
Michael Buesche4d6b792007-09-18 15:39:42 -0400823
824 /* Various statistics about the physical device. */
825 struct b43_stats stats;
826
Michael Buesche4d6b792007-09-18 15:39:42 -0400827 /* Reason code of the last interrupt. */
828 u32 irq_reason;
829 u32 dma_reason[6];
Michael Buesch13790722009-04-08 21:26:27 +0200830 /* The currently active generic-interrupt mask. */
831 u32 irq_mask;
Michael Buesch36dbd952009-09-04 22:51:29 +0200832
Michael Buesche4d6b792007-09-18 15:39:42 -0400833 /* Link Quality calculation context. */
834 struct b43_noise_calculation noisecalc;
835 /* if > 0 MAC is suspended. if == 0 MAC is enabled. */
836 int mac_suspended;
837
Michael Buesche4d6b792007-09-18 15:39:42 -0400838 /* Periodic tasks */
839 struct delayed_work periodic_work;
840 unsigned int periodic_state;
841
842 struct work_struct restart_work;
843
844 /* encryption/decryption */
845 u16 ktp; /* Key table pointer */
Michael Buesch66d2d082009-08-06 10:36:50 +0200846 struct b43_key key[B43_NR_GROUP_KEYS * 2 + B43_NR_PAIRWISE_KEYS];
Michael Buesche4d6b792007-09-18 15:39:42 -0400847
Michael Buesche4d6b792007-09-18 15:39:42 -0400848 /* Firmware data */
849 struct b43_firmware fw;
850
851 /* Devicelist in struct b43_wl (all 802.11 cores) */
852 struct list_head list;
853
854 /* Debugging stuff follows. */
855#ifdef CONFIG_B43_DEBUG
856 struct b43_dfsentry *dfsentry;
Michael Buesch990b86f2009-09-12 00:48:03 +0200857 unsigned int irq_count;
858 unsigned int irq_bit_count[32];
859 unsigned int tx_count;
860 unsigned int rx_count;
Michael Buesche4d6b792007-09-18 15:39:42 -0400861#endif
862};
863
Albert Herranz7e937c62009-10-07 00:07:44 +0200864/* Data structure for the WLAN parts (802.11 cores) of the b43 chip. */
865struct b43_wl {
866 /* Pointer to the active wireless device on this chip */
867 struct b43_wldev *current_dev;
868 /* Pointer to the ieee80211 hardware data structure */
869 struct ieee80211_hw *hw;
870
871 /* Global driver mutex. Every operation must run with this mutex locked. */
872 struct mutex mutex;
873 /* Hard-IRQ spinlock. This lock protects things used in the hard-IRQ
874 * handler, only. This basically is just the IRQ mask register. */
875 spinlock_t hardirq_lock;
876
Oleksij Rempele64add22012-06-05 20:39:32 +0200877 /* Set this if we call ieee80211_register_hw() and check if we call
878 * ieee80211_unregister_hw(). */
879 bool hw_registred;
880
Albert Herranz7e937c62009-10-07 00:07:44 +0200881 /* We can only have one operating interface (802.11 core)
882 * at a time. General information about this interface follows.
883 */
884
885 struct ieee80211_vif *vif;
886 /* The MAC address of the operating interface. */
887 u8 mac_addr[ETH_ALEN];
888 /* Current BSSID */
889 u8 bssid[ETH_ALEN];
890 /* Interface type. (NL80211_IFTYPE_XXX) */
891 int if_type;
892 /* Is the card operating in AP, STA or IBSS mode? */
893 bool operating;
894 /* filter flags */
895 unsigned int filter_flags;
896 /* Stats about the wireless interface */
897 struct ieee80211_low_level_stats ieee_stats;
898
899#ifdef CONFIG_B43_HWRNG
900 struct hwrng rng;
901 bool rng_initialized;
902 char rng_name[30 + 1];
903#endif /* CONFIG_B43_HWRNG */
904
905 /* List of all wireless devices on this chip */
906 struct list_head devlist;
907 u8 nr_devs;
908
909 bool radiotap_enabled;
910 bool radio_enabled;
911
912 /* The beacon we are currently using (AP or IBSS mode). */
913 struct sk_buff *current_beacon;
914 bool beacon0_uploaded;
915 bool beacon1_uploaded;
916 bool beacon_templates_virgin; /* Never wrote the templates? */
917 struct work_struct beacon_update_trigger;
918
919 /* The current QOS parameters for the 4 queues. */
francesco.gringoli@ing.unibs.itbad69192011-12-16 18:34:56 +0100920 struct b43_qos_params qos_params[B43_QOS_QUEUE_NUM];
Albert Herranz7e937c62009-10-07 00:07:44 +0200921
922 /* Work for adjustment of the transmission power.
923 * This is scheduled when we determine that the actual TX output
924 * power doesn't match what we want. */
925 struct work_struct txpower_adjust_work;
926
927 /* Packet transmit work */
928 struct work_struct tx_work;
francesco.gringoli@ing.unibs.itbad69192011-12-16 18:34:56 +0100929
Albert Herranz7e937c62009-10-07 00:07:44 +0200930 /* Queue of packets to be transmitted. */
francesco.gringoli@ing.unibs.itbad69192011-12-16 18:34:56 +0100931 struct sk_buff_head tx_queue[B43_QOS_QUEUE_NUM];
932
933 /* Flag that implement the queues stopping. */
934 bool tx_queue_stopped[B43_QOS_QUEUE_NUM];
Albert Herranz7e937c62009-10-07 00:07:44 +0200935
Larry Finger6b6fa582012-03-08 22:27:46 -0600936 /* firmware loading work */
937 struct work_struct firmware_load;
938
Albert Herranz7e937c62009-10-07 00:07:44 +0200939 /* The device LEDs. */
940 struct b43_leds leds;
941
Michael Buesch88499ab2009-10-09 20:33:32 +0200942 /* Kmalloc'ed scratch space for PIO TX/RX. Protected by wl->mutex. */
Rafał Miłecki5d852902011-08-11 15:07:16 +0200943 u8 pio_scratchspace[118] __attribute__((__aligned__(8)));
Michael Buesch88499ab2009-10-09 20:33:32 +0200944 u8 pio_tailspace[4] __attribute__((__aligned__(8)));
Albert Herranz7e937c62009-10-07 00:07:44 +0200945};
946
Michael Buesche4d6b792007-09-18 15:39:42 -0400947static inline struct b43_wl *hw_to_b43_wl(struct ieee80211_hw *hw)
948{
949 return hw->priv;
950}
951
Michael Buesche4d6b792007-09-18 15:39:42 -0400952static inline struct b43_wldev *dev_to_b43_wldev(struct device *dev)
953{
954 struct ssb_device *ssb_dev = dev_to_ssb_dev(dev);
955 return ssb_get_drvdata(ssb_dev);
956}
957
Gábor Stefanikbedaf802009-08-05 01:28:20 +0200958/* Is the device operating in a specified mode (NL80211_IFTYPE_XXX). */
Michael Buesche4d6b792007-09-18 15:39:42 -0400959static inline int b43_is_mode(struct b43_wl *wl, int type)
960{
Michael Buesche4d6b792007-09-18 15:39:42 -0400961 return (wl->operating && wl->if_type == type);
962}
963
Michael Bueschef1a6282008-08-27 18:53:02 +0200964/**
965 * b43_current_band - Returns the currently used band.
966 * Returns one of IEEE80211_BAND_2GHZ and IEEE80211_BAND_5GHZ.
967 */
968static inline enum ieee80211_band b43_current_band(struct b43_wl *wl)
969{
970 return wl->hw->conf.channel->band;
971}
972
Rafał Miłecki24ca39d2011-05-18 02:06:43 +0200973static inline int b43_bus_may_powerdown(struct b43_wldev *wldev)
974{
975 return wldev->dev->bus_may_powerdown(wldev->dev);
976}
977static inline int b43_bus_powerup(struct b43_wldev *wldev, bool dynamic_pctl)
978{
979 return wldev->dev->bus_powerup(wldev->dev, dynamic_pctl);
980}
981static inline int b43_device_is_enabled(struct b43_wldev *wldev)
982{
983 return wldev->dev->device_is_enabled(wldev->dev);
984}
985static inline void b43_device_enable(struct b43_wldev *wldev,
986 u32 core_specific_flags)
987{
988 wldev->dev->device_enable(wldev->dev, core_specific_flags);
989}
990static inline void b43_device_disable(struct b43_wldev *wldev,
991 u32 core_specific_flags)
992{
993 wldev->dev->device_disable(wldev->dev, core_specific_flags);
994}
995
Michael Buesche4d6b792007-09-18 15:39:42 -0400996static inline u16 b43_read16(struct b43_wldev *dev, u16 offset)
997{
Rafał Miłeckic0b4c002011-05-18 02:06:37 +0200998 return dev->dev->read16(dev->dev, offset);
Michael Buesche4d6b792007-09-18 15:39:42 -0400999}
1000
1001static inline void b43_write16(struct b43_wldev *dev, u16 offset, u16 value)
1002{
Rafał Miłeckic0b4c002011-05-18 02:06:37 +02001003 dev->dev->write16(dev->dev, offset, value);
Michael Buesche4d6b792007-09-18 15:39:42 -04001004}
1005
Rafał Miłecki50566352012-01-02 19:31:21 +01001006static inline void b43_maskset16(struct b43_wldev *dev, u16 offset, u16 mask,
1007 u16 set)
1008{
1009 b43_write16(dev, offset, (b43_read16(dev, offset) & mask) | set);
1010}
1011
Michael Buesche4d6b792007-09-18 15:39:42 -04001012static inline u32 b43_read32(struct b43_wldev *dev, u16 offset)
1013{
Rafał Miłeckic0b4c002011-05-18 02:06:37 +02001014 return dev->dev->read32(dev->dev, offset);
Michael Buesche4d6b792007-09-18 15:39:42 -04001015}
1016
1017static inline void b43_write32(struct b43_wldev *dev, u16 offset, u32 value)
1018{
Rafał Miłeckic0b4c002011-05-18 02:06:37 +02001019 dev->dev->write32(dev->dev, offset, value);
Michael Buesche4d6b792007-09-18 15:39:42 -04001020}
1021
Rafał Miłecki50566352012-01-02 19:31:21 +01001022static inline void b43_maskset32(struct b43_wldev *dev, u16 offset, u32 mask,
1023 u32 set)
1024{
1025 b43_write32(dev, offset, (b43_read32(dev, offset) & mask) | set);
1026}
1027
Rafał Miłecki620d7852011-05-17 14:00:00 +02001028static inline void b43_block_read(struct b43_wldev *dev, void *buffer,
1029 size_t count, u16 offset, u8 reg_width)
1030{
Rafał Miłeckic0b4c002011-05-18 02:06:37 +02001031 dev->dev->block_read(dev->dev, buffer, count, offset, reg_width);
Rafał Miłecki620d7852011-05-17 14:00:00 +02001032}
1033
1034static inline void b43_block_write(struct b43_wldev *dev, const void *buffer,
1035 size_t count, u16 offset, u8 reg_width)
1036{
Rafał Miłeckic0b4c002011-05-18 02:06:37 +02001037 dev->dev->block_write(dev->dev, buffer, count, offset, reg_width);
Michael Buesche4d6b792007-09-18 15:39:42 -04001038}
1039
Michael Buesch5100d5a2008-03-29 21:01:16 +01001040static inline bool b43_using_pio_transfers(struct b43_wldev *dev)
1041{
Michael Buesch5100d5a2008-03-29 21:01:16 +01001042 return dev->__using_pio_transfers;
Michael Buesch5100d5a2008-03-29 21:01:16 +01001043}
1044
Michael Buesche4d6b792007-09-18 15:39:42 -04001045/* Message printing */
Joe Perchesb9075fa2011-10-31 17:11:33 -07001046__printf(2, 3) void b43info(struct b43_wl *wl, const char *fmt, ...);
1047__printf(2, 3) void b43err(struct b43_wl *wl, const char *fmt, ...);
1048__printf(2, 3) void b43warn(struct b43_wl *wl, const char *fmt, ...);
1049__printf(2, 3) void b43dbg(struct b43_wl *wl, const char *fmt, ...);
Michael Buesch060210f2009-01-25 15:49:59 +01001050
Michael Buesche4d6b792007-09-18 15:39:42 -04001051
1052/* A WARN_ON variant that vanishes when b43 debugging is disabled.
1053 * This _also_ evaluates the arg with debugging disabled. */
1054#if B43_DEBUG
1055# define B43_WARN_ON(x) WARN_ON(x)
1056#else
1057static inline bool __b43_warn_on_dummy(bool x) { return x; }
1058# define B43_WARN_ON(x) __b43_warn_on_dummy(unlikely(!!(x)))
1059#endif
1060
Michael Buesche4d6b792007-09-18 15:39:42 -04001061/* Convert an integer to a Q5.2 value */
1062#define INT_TO_Q52(i) ((i) << 2)
1063/* Convert a Q5.2 value to an integer (precision loss!) */
1064#define Q52_TO_INT(q52) ((q52) >> 2)
1065/* Macros for printing a value in Q5.2 format */
1066#define Q52_FMT "%u.%u"
1067#define Q52_ARG(q52) Q52_TO_INT(q52), ((((q52) & 0x3) * 100) / 4)
1068
1069#endif /* B43_H_ */