]> err.no Git - linux-2.6/blob - drivers/net/wireless/b43/b43.h
Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/davem/net-2.6
[linux-2.6] / drivers / net / wireless / b43 / b43.h
1 #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>
8 #include <linux/ssb/ssb.h>
9 #include <net/mac80211.h>
10
11 #include "debugfs.h"
12 #include "leds.h"
13 #include "rfkill.h"
14 #include "lo.h"
15 #include "phy.h"
16
17
18 /* The unique identifier of the firmware that's officially supported by
19  * this driver version. */
20 #define B43_SUPPORTED_FIRMWARE_ID       "FW13"
21
22
23 #ifdef CONFIG_B43_DEBUG
24 # define B43_DEBUG      1
25 #else
26 # define B43_DEBUG      0
27 #endif
28
29 #define B43_RX_MAX_SSI                  60
30
31 /* 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
44 #define B43_MMIO_MACCTL                 0x120   /* MAC control */
45 #define B43_MMIO_MACCMD                 0x124   /* MAC command */
46 #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 */
59 #define B43_MMIO_TSF_CFP_REP            0x188
60 #define B43_MMIO_TSF_CFP_START          0x18C
61 #define B43_MMIO_TSF_CFP_MAXDUR         0x190
62
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
77
78 #define B43_MMIO_PHY_VER                0x3E0
79 #define B43_MMIO_PHY_RADIO              0x3E2
80 #define B43_MMIO_PHY0                   0x3E6
81 #define B43_MMIO_ANTENNA                0x3E8
82 #define B43_MMIO_CHANNEL                0x3F0
83 #define B43_MMIO_CHANNEL_EXT            0x3F4
84 #define B43_MMIO_RADIO_CONTROL          0x3F6
85 #define B43_MMIO_RADIO_DATA_HIGH        0x3F8
86 #define B43_MMIO_RADIO_DATA_LOW         0x3FA
87 #define B43_MMIO_PHY_CONTROL            0x3FC
88 #define B43_MMIO_PHY_DATA               0x3FE
89 #define B43_MMIO_MACFILTER_CONTROL      0x420
90 #define B43_MMIO_MACFILTER_DATA         0x422
91 #define B43_MMIO_RCMTA_COUNT            0x43C
92 #define B43_MMIO_RADIO_HWENABLED_LO     0x49A
93 #define B43_MMIO_GPIO_CONTROL           0x49C
94 #define B43_MMIO_GPIO_MASK              0x49E
95 #define B43_MMIO_TSF_CFP_START_LOW      0x604
96 #define B43_MMIO_TSF_CFP_START_HIGH     0x606
97 #define B43_MMIO_TSF_0                  0x632   /* core rev < 3 only */
98 #define B43_MMIO_TSF_1                  0x634   /* core rev < 3 only */
99 #define B43_MMIO_TSF_2                  0x636   /* core rev < 3 only */
100 #define B43_MMIO_TSF_3                  0x638   /* core rev < 3 only */
101 #define B43_MMIO_RNG                    0x65A
102 #define B43_MMIO_IFSCTL                 0x688 /* Interframe space control */
103 #define  B43_MMIO_IFSCTL_USE_EDCF       0x0004
104 #define B43_MMIO_POWERUP_DELAY          0x6A8
105
106 /* SPROM boardflags_lo values */
107 #define B43_BFL_BTCOEXIST               0x0001  /* implements Bluetooth coexistance */
108 #define B43_BFL_PACTRL                  0x0002  /* GPIO 9 controlling the PA */
109 #define B43_BFL_AIRLINEMODE             0x0004  /* implements GPIO 13 radio disable indication */
110 #define B43_BFL_RSSI                    0x0008  /* software calculates nrssi slope. */
111 #define B43_BFL_ENETSPI                 0x0010  /* has ephy roboswitch spi */
112 #define B43_BFL_XTAL_NOSLOW             0x0020  /* no slow clock available */
113 #define B43_BFL_CCKHIPWR                0x0040  /* can do high power CCK transmission */
114 #define B43_BFL_ENETADM                 0x0080  /* has ADMtek switch */
115 #define B43_BFL_ENETVLAN                0x0100  /* can do vlan */
116 #define B43_BFL_AFTERBURNER             0x0200  /* supports Afterburner mode */
117 #define B43_BFL_NOPCI                   0x0400  /* leaves PCI floating */
118 #define B43_BFL_FEM                     0x0800  /* supports the Front End Module */
119 #define B43_BFL_EXTLNA                  0x1000  /* has an external LNA */
120 #define B43_BFL_HGPA                    0x2000  /* had high gain PA */
121 #define B43_BFL_BTCMOD                  0x4000  /* BFL_BTCOEXIST is given in alternate GPIOs */
122 #define B43_BFL_ALTIQ                   0x8000  /* alternate I/Q settings */
123
124 /* GPIO register offset, in both ChipCommon and PCI core. */
125 #define B43_GPIO_CONTROL                0x6c
126
127 /* SHM Routing */
128 enum {
129         B43_SHM_UCODE,          /* Microcode memory */
130         B43_SHM_SHARED,         /* Shared memory */
131         B43_SHM_SCRATCH,        /* Scratch memory */
132         B43_SHM_HW,             /* Internal hardware register */
133         B43_SHM_RCMTA,          /* Receive match transmitter address (rev >= 5 only) */
134 };
135 /* SHM Routing modifiers */
136 #define B43_SHM_AUTOINC_R               0x0200  /* Auto-increment address on read */
137 #define B43_SHM_AUTOINC_W               0x0100  /* Auto-increment address on write */
138 #define B43_SHM_AUTOINC_RW              (B43_SHM_AUTOINC_R | \
139                                          B43_SHM_AUTOINC_W)
140
141 /* Misc SHM_SHARED offsets */
142 #define B43_SHM_SH_WLCOREREV            0x0016  /* 802.11 core revision */
143 #define B43_SHM_SH_PCTLWDPOS            0x0008
144 #define B43_SHM_SH_RXPADOFF             0x0034  /* RX Padding data offset (PIO only) */
145 #define B43_SHM_SH_PHYVER               0x0050  /* PHY version */
146 #define B43_SHM_SH_PHYTYPE              0x0052  /* PHY type */
147 #define B43_SHM_SH_ANTSWAP              0x005C  /* Antenna swap threshold */
148 #define B43_SHM_SH_HOSTFLO              0x005E  /* Hostflags for ucode options (low) */
149 #define B43_SHM_SH_HOSTFMI              0x0060  /* Hostflags for ucode options (middle) */
150 #define B43_SHM_SH_HOSTFHI              0x0062  /* Hostflags for ucode options (high) */
151 #define B43_SHM_SH_RFATT                0x0064  /* Current radio attenuation value */
152 #define B43_SHM_SH_RADAR                0x0066  /* Radar register */
153 #define B43_SHM_SH_PHYTXNOI             0x006E  /* PHY noise directly after TX (lower 8bit only) */
154 #define B43_SHM_SH_RFRXSP1              0x0072  /* RF RX SP Register 1 */
155 #define B43_SHM_SH_CHAN                 0x00A0  /* Current channel (low 8bit only) */
156 #define  B43_SHM_SH_CHAN_5GHZ           0x0100  /* Bit set, if 5Ghz channel */
157 #define B43_SHM_SH_BCMCFIFOID           0x0108  /* Last posted cookie to the bcast/mcast FIFO */
158 /* SHM_SHARED TX FIFO variables */
159 #define B43_SHM_SH_SIZE01               0x0098  /* TX FIFO size for FIFO 0 (low) and 1 (high) */
160 #define B43_SHM_SH_SIZE23               0x009A  /* TX FIFO size for FIFO 2 and 3 */
161 #define B43_SHM_SH_SIZE45               0x009C  /* TX FIFO size for FIFO 4 and 5 */
162 #define B43_SHM_SH_SIZE67               0x009E  /* TX FIFO size for FIFO 6 and 7 */
163 /* SHM_SHARED background noise */
164 #define B43_SHM_SH_JSSI0                0x0088  /* Measure JSSI 0 */
165 #define B43_SHM_SH_JSSI1                0x008A  /* Measure JSSI 1 */
166 #define B43_SHM_SH_JSSIAUX              0x008C  /* Measure JSSI AUX */
167 /* SHM_SHARED crypto engine */
168 #define B43_SHM_SH_DEFAULTIV            0x003C  /* Default IV location */
169 #define B43_SHM_SH_NRRXTRANS            0x003E  /* # of soft RX transmitter addresses (max 8) */
170 #define B43_SHM_SH_KTP                  0x0056  /* Key table pointer */
171 #define B43_SHM_SH_TKIPTSCTTAK          0x0318
172 #define B43_SHM_SH_KEYIDXBLOCK          0x05D4  /* Key index/algorithm block (v4 firmware) */
173 #define B43_SHM_SH_PSM                  0x05F4  /* PSM transmitter address match block (rev < 5) */
174 /* SHM_SHARED WME variables */
175 #define B43_SHM_SH_EDCFSTAT             0x000E  /* EDCF status */
176 #define B43_SHM_SH_TXFCUR               0x0030  /* TXF current index */
177 #define B43_SHM_SH_EDCFQ                0x0240  /* EDCF Q info */
178 /* SHM_SHARED powersave mode related */
179 #define B43_SHM_SH_SLOTT                0x0010  /* Slot time */
180 #define B43_SHM_SH_DTIMPER              0x0012  /* DTIM period */
181 #define B43_SHM_SH_NOSLPZNATDTIM        0x004C  /* NOSLPZNAT DTIM */
182 /* SHM_SHARED beacon/AP variables */
183 #define B43_SHM_SH_BTL0                 0x0018  /* Beacon template length 0 */
184 #define B43_SHM_SH_BTL1                 0x001A  /* Beacon template length 1 */
185 #define B43_SHM_SH_BTSFOFF              0x001C  /* Beacon TSF offset */
186 #define B43_SHM_SH_TIMBPOS              0x001E  /* TIM B position in beacon */
187 #define B43_SHM_SH_DTIMP                0x0012  /* DTIP period */
188 #define B43_SHM_SH_MCASTCOOKIE          0x00A8  /* Last bcast/mcast frame ID */
189 #define B43_SHM_SH_SFFBLIM              0x0044  /* Short frame fallback retry limit */
190 #define B43_SHM_SH_LFFBLIM              0x0046  /* Long frame fallback retry limit */
191 #define B43_SHM_SH_BEACPHYCTL           0x0054  /* Beacon PHY TX control word (see PHY TX control) */
192 #define B43_SHM_SH_EXTNPHYCTL           0x00B0  /* Extended bytes for beacon PHY control (N) */
193 /* SHM_SHARED ACK/CTS control */
194 #define B43_SHM_SH_ACKCTSPHYCTL         0x0022  /* ACK/CTS PHY control word (see PHY TX control) */
195 /* SHM_SHARED probe response variables */
196 #define B43_SHM_SH_PRSSID               0x0160  /* Probe Response SSID */
197 #define B43_SHM_SH_PRSSIDLEN            0x0048  /* Probe Response SSID length */
198 #define B43_SHM_SH_PRTLEN               0x004A  /* Probe Response template length */
199 #define B43_SHM_SH_PRMAXTIME            0x0074  /* Probe Response max time */
200 #define B43_SHM_SH_PRPHYCTL             0x0188  /* Probe Response PHY TX control word */
201 /* SHM_SHARED rate tables */
202 #define B43_SHM_SH_OFDMDIRECT           0x01C0  /* Pointer to OFDM direct map */
203 #define B43_SHM_SH_OFDMBASIC            0x01E0  /* Pointer to OFDM basic rate map */
204 #define B43_SHM_SH_CCKDIRECT            0x0200  /* Pointer to CCK direct map */
205 #define B43_SHM_SH_CCKBASIC             0x0220  /* Pointer to CCK basic rate map */
206 /* SHM_SHARED microcode soft registers */
207 #define B43_SHM_SH_UCODEREV             0x0000  /* Microcode revision */
208 #define B43_SHM_SH_UCODEPATCH           0x0002  /* Microcode patchlevel */
209 #define B43_SHM_SH_UCODEDATE            0x0004  /* Microcode date */
210 #define B43_SHM_SH_UCODETIME            0x0006  /* Microcode time */
211 #define B43_SHM_SH_UCODESTAT            0x0040  /* Microcode debug status code */
212 #define  B43_SHM_SH_UCODESTAT_INVALID   0
213 #define  B43_SHM_SH_UCODESTAT_INIT      1
214 #define  B43_SHM_SH_UCODESTAT_ACTIVE    2
215 #define  B43_SHM_SH_UCODESTAT_SUSP      3       /* suspended */
216 #define  B43_SHM_SH_UCODESTAT_SLEEP     4       /* asleep (PS) */
217 #define B43_SHM_SH_MAXBFRAMES           0x0080  /* Maximum number of frames in a burst */
218 #define B43_SHM_SH_SPUWKUP              0x0094  /* pre-wakeup for synth PU in us */
219 #define B43_SHM_SH_PRETBTT              0x0096  /* pre-TBTT in us */
220
221 /* SHM_SCRATCH offsets */
222 #define B43_SHM_SC_MINCONT              0x0003  /* Minimum contention window */
223 #define B43_SHM_SC_MAXCONT              0x0004  /* Maximum contention window */
224 #define B43_SHM_SC_CURCONT              0x0005  /* Current contention window */
225 #define B43_SHM_SC_SRLIMIT              0x0006  /* Short retry count limit */
226 #define B43_SHM_SC_LRLIMIT              0x0007  /* Long retry count limit */
227 #define B43_SHM_SC_DTIMC                0x0008  /* Current DTIM count */
228 #define B43_SHM_SC_BTL0LEN              0x0015  /* Beacon 0 template length */
229 #define B43_SHM_SC_BTL1LEN              0x0016  /* Beacon 1 template length */
230 #define B43_SHM_SC_SCFB                 0x0017  /* Short frame transmit count threshold for rate fallback */
231 #define B43_SHM_SC_LCFB                 0x0018  /* Long frame transmit count threshold for rate fallback */
232
233 /* Hardware Radio Enable masks */
234 #define B43_MMIO_RADIO_HWENABLED_HI_MASK (1 << 16)
235 #define B43_MMIO_RADIO_HWENABLED_LO_MASK (1 << 4)
236
237 /* HostFlags. See b43_hf_read/write() */
238 #define B43_HF_ANTDIVHELP       0x000000000001ULL /* ucode antenna div helper */
239 #define B43_HF_SYMW             0x000000000002ULL /* G-PHY SYM workaround */
240 #define B43_HF_RXPULLW          0x000000000004ULL /* RX pullup workaround */
241 #define B43_HF_CCKBOOST         0x000000000008ULL /* 4dB CCK power boost (exclusive with OFDM boost) */
242 #define B43_HF_BTCOEX           0x000000000010ULL /* Bluetooth coexistance */
243 #define B43_HF_GDCW             0x000000000020ULL /* G-PHY DC canceller filter bw workaround */
244 #define B43_HF_OFDMPABOOST      0x000000000040ULL /* Enable PA gain boost for OFDM */
245 #define B43_HF_ACPR             0x000000000080ULL /* Disable for Japan, channel 14 */
246 #define B43_HF_EDCF             0x000000000100ULL /* on if WME and MAC suspended */
247 #define B43_HF_TSSIRPSMW        0x000000000200ULL /* TSSI reset PSM ucode workaround */
248 #define B43_HF_20IN40IQW        0x000000000200ULL /* 20 in 40 MHz I/Q workaround (rev >= 13 only) */
249 #define B43_HF_DSCRQ            0x000000000400ULL /* Disable slow clock request in ucode */
250 #define B43_HF_ACIW             0x000000000800ULL /* ACI workaround: shift bits by 2 on PHY CRS */
251 #define B43_HF_2060W            0x000000001000ULL /* 2060 radio workaround */
252 #define B43_HF_RADARW           0x000000002000ULL /* Radar workaround */
253 #define B43_HF_USEDEFKEYS       0x000000004000ULL /* Enable use of default keys */
254 #define B43_HF_AFTERBURNER      0x000000008000ULL /* Afterburner enabled */
255 #define B43_HF_BT4PRIOCOEX      0x000000010000ULL /* Bluetooth 4-priority coexistance */
256 #define B43_HF_FWKUP            0x000000020000ULL /* Fast wake-up ucode */
257 #define B43_HF_VCORECALC        0x000000040000ULL /* Force VCO recalculation when powering up synthpu */
258 #define B43_HF_PCISCW           0x000000080000ULL /* PCI slow clock workaround */
259 #define B43_HF_4318TSSI         0x000000200000ULL /* 4318 TSSI */
260 #define B43_HF_FBCMCFIFO        0x000000400000ULL /* Flush bcast/mcast FIFO immediately */
261 #define B43_HF_HWPCTL           0x000000800000ULL /* Enable hardwarre power control */
262 #define B43_HF_BTCOEXALT        0x000001000000ULL /* Bluetooth coexistance in alternate pins */
263 #define B43_HF_TXBTCHECK        0x000002000000ULL /* Bluetooth check during transmission */
264 #define B43_HF_SKCFPUP          0x000004000000ULL /* Skip CFP update */
265 #define B43_HF_N40W             0x000008000000ULL /* N PHY 40 MHz workaround (rev >= 13 only) */
266 #define B43_HF_ANTSEL           0x000020000000ULL /* Antenna selection (for testing antenna div.) */
267 #define B43_HF_BT3COEXT         0x000020000000ULL /* Bluetooth 3-wire coexistence (rev >= 13 only) */
268 #define B43_HF_BTCANT           0x000040000000ULL /* Bluetooth coexistence (antenna mode) (rev >= 13 only) */
269 #define B43_HF_ANTSELEN         0x000100000000ULL /* Antenna selection enabled (rev >= 13 only) */
270 #define B43_HF_ANTSELMODE       0x000200000000ULL /* Antenna selection mode (rev >= 13 only) */
271 #define B43_HF_MLADVW           0x001000000000ULL /* N PHY ML ADV workaround (rev >= 13 only) */
272 #define B43_HF_PR45960W         0x080000000000ULL /* PR 45960 workaround (rev >= 13 only) */
273
274 /* MacFilter offsets. */
275 #define B43_MACFILTER_SELF              0x0000
276 #define B43_MACFILTER_BSSID             0x0003
277
278 /* PowerControl */
279 #define B43_PCTL_IN                     0xB0
280 #define B43_PCTL_OUT                    0xB4
281 #define B43_PCTL_OUTENABLE              0xB8
282 #define B43_PCTL_XTAL_POWERUP           0x40
283 #define B43_PCTL_PLL_POWERDOWN          0x80
284
285 /* PowerControl Clock Modes */
286 #define B43_PCTL_CLK_FAST               0x00
287 #define B43_PCTL_CLK_SLOW               0x01
288 #define B43_PCTL_CLK_DYNAMIC            0x02
289
290 #define B43_PCTL_FORCE_SLOW             0x0800
291 #define B43_PCTL_FORCE_PLL              0x1000
292 #define B43_PCTL_DYN_XTAL               0x2000
293
294 /* PHYVersioning */
295 #define B43_PHYTYPE_A                   0x00
296 #define B43_PHYTYPE_B                   0x01
297 #define B43_PHYTYPE_G                   0x02
298 #define B43_PHYTYPE_N                   0x04
299 #define B43_PHYTYPE_LP                  0x05
300
301 /* PHYRegisters */
302 #define B43_PHY_ILT_A_CTRL              0x0072
303 #define B43_PHY_ILT_A_DATA1             0x0073
304 #define B43_PHY_ILT_A_DATA2             0x0074
305 #define B43_PHY_G_LO_CONTROL            0x0810
306 #define B43_PHY_ILT_G_CTRL              0x0472
307 #define B43_PHY_ILT_G_DATA1             0x0473
308 #define B43_PHY_ILT_G_DATA2             0x0474
309 #define B43_PHY_A_PCTL                  0x007B
310 #define B43_PHY_G_PCTL                  0x0029
311 #define B43_PHY_A_CRS                   0x0029
312 #define B43_PHY_RADIO_BITFIELD          0x0401
313 #define B43_PHY_G_CRS                   0x0429
314 #define B43_PHY_NRSSILT_CTRL            0x0803
315 #define B43_PHY_NRSSILT_DATA            0x0804
316
317 /* RadioRegisters */
318 #define B43_RADIOCTL_ID                 0x01
319
320 /* MAC Control bitfield */
321 #define B43_MACCTL_ENABLED              0x00000001      /* MAC Enabled */
322 #define B43_MACCTL_PSM_RUN              0x00000002      /* Run Microcode */
323 #define B43_MACCTL_PSM_JMP0             0x00000004      /* Microcode jump to 0 */
324 #define B43_MACCTL_SHM_ENABLED          0x00000100      /* SHM Enabled */
325 #define B43_MACCTL_SHM_UPPER            0x00000200      /* SHM Upper */
326 #define B43_MACCTL_IHR_ENABLED          0x00000400      /* IHR Region Enabled */
327 #define B43_MACCTL_PSM_DBG              0x00002000      /* Microcode debugging enabled */
328 #define B43_MACCTL_GPOUTSMSK            0x0000C000      /* GPOUT Select Mask */
329 #define B43_MACCTL_BE                   0x00010000      /* Big Endian mode */
330 #define B43_MACCTL_INFRA                0x00020000      /* Infrastructure mode */
331 #define B43_MACCTL_AP                   0x00040000      /* AccessPoint mode */
332 #define B43_MACCTL_RADIOLOCK            0x00080000      /* Radio lock */
333 #define B43_MACCTL_BEACPROMISC          0x00100000      /* Beacon Promiscuous */
334 #define B43_MACCTL_KEEP_BADPLCP         0x00200000      /* Keep frames with bad PLCP */
335 #define B43_MACCTL_KEEP_CTL             0x00400000      /* Keep control frames */
336 #define B43_MACCTL_KEEP_BAD             0x00800000      /* Keep bad frames (FCS) */
337 #define B43_MACCTL_PROMISC              0x01000000      /* Promiscuous mode */
338 #define B43_MACCTL_HWPS                 0x02000000      /* Hardware Power Saving */
339 #define B43_MACCTL_AWAKE                0x04000000      /* Device is awake */
340 #define B43_MACCTL_CLOSEDNET            0x08000000      /* Closed net (no SSID bcast) */
341 #define B43_MACCTL_TBTTHOLD             0x10000000      /* TBTT Hold */
342 #define B43_MACCTL_DISCTXSTAT           0x20000000      /* Discard TX status */
343 #define B43_MACCTL_DISCPMQ              0x40000000      /* Discard Power Management Queue */
344 #define B43_MACCTL_GMODE                0x80000000      /* G Mode */
345
346 /* MAC Command bitfield */
347 #define B43_MACCMD_BEACON0_VALID        0x00000001      /* Beacon 0 in template RAM is busy/valid */
348 #define B43_MACCMD_BEACON1_VALID        0x00000002      /* Beacon 1 in template RAM is busy/valid */
349 #define B43_MACCMD_DFQ_VALID            0x00000004      /* Directed frame queue valid (IBSS PS mode, ATIM) */
350 #define B43_MACCMD_CCA                  0x00000008      /* Clear channel assessment */
351 #define B43_MACCMD_BGNOISE              0x00000010      /* Background noise */
352
353 /* 802.11 core specific TM State Low (SSB_TMSLOW) flags */
354 #define B43_TMSLOW_GMODE                0x20000000      /* G Mode Enable */
355 #define B43_TMSLOW_PHYCLKSPEED          0x00C00000      /* PHY clock speed mask (N-PHY only) */
356 #define  B43_TMSLOW_PHYCLKSPEED_40MHZ   0x00000000      /* 40 MHz PHY */
357 #define  B43_TMSLOW_PHYCLKSPEED_80MHZ   0x00400000      /* 80 MHz PHY */
358 #define  B43_TMSLOW_PHYCLKSPEED_160MHZ  0x00800000      /* 160 MHz PHY */
359 #define B43_TMSLOW_PLLREFSEL            0x00200000      /* PLL Frequency Reference Select (rev >= 5) */
360 #define B43_TMSLOW_MACPHYCLKEN          0x00100000      /* MAC PHY Clock Control Enable (rev >= 5) */
361 #define B43_TMSLOW_PHYRESET             0x00080000      /* PHY Reset */
362 #define B43_TMSLOW_PHYCLKEN             0x00040000      /* PHY Clock Enable */
363
364 /* 802.11 core specific TM State High (SSB_TMSHIGH) flags */
365 #define B43_TMSHIGH_DUALBAND_PHY        0x00080000      /* Dualband PHY available */
366 #define B43_TMSHIGH_FCLOCK              0x00040000      /* Fast Clock Available (rev >= 5) */
367 #define B43_TMSHIGH_HAVE_5GHZ_PHY       0x00020000      /* 5 GHz PHY available (rev >= 5) */
368 #define B43_TMSHIGH_HAVE_2GHZ_PHY       0x00010000      /* 2.4 GHz PHY available (rev >= 5) */
369
370 /* Generic-Interrupt reasons. */
371 #define B43_IRQ_MAC_SUSPENDED           0x00000001
372 #define B43_IRQ_BEACON                  0x00000002
373 #define B43_IRQ_TBTT_INDI               0x00000004
374 #define B43_IRQ_BEACON_TX_OK            0x00000008
375 #define B43_IRQ_BEACON_CANCEL           0x00000010
376 #define B43_IRQ_ATIM_END                0x00000020
377 #define B43_IRQ_PMQ                     0x00000040
378 #define B43_IRQ_PIO_WORKAROUND          0x00000100
379 #define B43_IRQ_MAC_TXERR               0x00000200
380 #define B43_IRQ_PHY_TXERR               0x00000800
381 #define B43_IRQ_PMEVENT                 0x00001000
382 #define B43_IRQ_TIMER0                  0x00002000
383 #define B43_IRQ_TIMER1                  0x00004000
384 #define B43_IRQ_DMA                     0x00008000
385 #define B43_IRQ_TXFIFO_FLUSH_OK         0x00010000
386 #define B43_IRQ_CCA_MEASURE_OK          0x00020000
387 #define B43_IRQ_NOISESAMPLE_OK          0x00040000
388 #define B43_IRQ_UCODE_DEBUG             0x08000000
389 #define B43_IRQ_RFKILL                  0x10000000
390 #define B43_IRQ_TX_OK                   0x20000000
391 #define B43_IRQ_PHY_G_CHANGED           0x40000000
392 #define B43_IRQ_TIMEOUT                 0x80000000
393
394 #define B43_IRQ_ALL                     0xFFFFFFFF
395 #define B43_IRQ_MASKTEMPLATE            (B43_IRQ_MAC_SUSPENDED | \
396                                          B43_IRQ_BEACON | \
397                                          B43_IRQ_TBTT_INDI | \
398                                          B43_IRQ_ATIM_END | \
399                                          B43_IRQ_PMQ | \
400                                          B43_IRQ_MAC_TXERR | \
401                                          B43_IRQ_PHY_TXERR | \
402                                          B43_IRQ_DMA | \
403                                          B43_IRQ_TXFIFO_FLUSH_OK | \
404                                          B43_IRQ_NOISESAMPLE_OK | \
405                                          B43_IRQ_UCODE_DEBUG | \
406                                          B43_IRQ_RFKILL | \
407                                          B43_IRQ_TX_OK)
408
409 /* Device specific rate values.
410  * The actual values defined here are (rate_in_mbps * 2).
411  * Some code depends on this. Don't change it. */
412 #define B43_CCK_RATE_1MB                0x02
413 #define B43_CCK_RATE_2MB                0x04
414 #define B43_CCK_RATE_5MB                0x0B
415 #define B43_CCK_RATE_11MB               0x16
416 #define B43_OFDM_RATE_6MB               0x0C
417 #define B43_OFDM_RATE_9MB               0x12
418 #define B43_OFDM_RATE_12MB              0x18
419 #define B43_OFDM_RATE_18MB              0x24
420 #define B43_OFDM_RATE_24MB              0x30
421 #define B43_OFDM_RATE_36MB              0x48
422 #define B43_OFDM_RATE_48MB              0x60
423 #define B43_OFDM_RATE_54MB              0x6C
424 /* Convert a b43 rate value to a rate in 100kbps */
425 #define B43_RATE_TO_BASE100KBPS(rate)   (((rate) * 10) / 2)
426
427 #define B43_DEFAULT_SHORT_RETRY_LIMIT   7
428 #define B43_DEFAULT_LONG_RETRY_LIMIT    4
429
430 #define B43_PHY_TX_BADNESS_LIMIT        1000
431
432 /* Max size of a security key */
433 #define B43_SEC_KEYSIZE                 16
434 /* Security algorithms. */
435 enum {
436         B43_SEC_ALGO_NONE = 0,  /* unencrypted, as of TX header. */
437         B43_SEC_ALGO_WEP40,
438         B43_SEC_ALGO_TKIP,
439         B43_SEC_ALGO_AES,
440         B43_SEC_ALGO_WEP104,
441         B43_SEC_ALGO_AES_LEGACY,
442 };
443
444 struct b43_dmaring;
445 struct b43_pioqueue;
446
447 /* The firmware file header */
448 #define B43_FW_TYPE_UCODE       'u'
449 #define B43_FW_TYPE_PCM         'p'
450 #define B43_FW_TYPE_IV          'i'
451 struct b43_fw_header {
452         /* File type */
453         u8 type;
454         /* File format version */
455         u8 ver;
456         u8 __padding[2];
457         /* Size of the data. For ucode and PCM this is in bytes.
458          * For IV this is number-of-ivs. */
459         __be32 size;
460 } __attribute__((__packed__));
461
462 /* Initial Value file format */
463 #define B43_IV_OFFSET_MASK      0x7FFF
464 #define B43_IV_32BIT            0x8000
465 struct b43_iv {
466         __be16 offset_size;
467         union {
468                 __be16 d16;
469                 __be32 d32;
470         } data __attribute__((__packed__));
471 } __attribute__((__packed__));
472
473
474 struct b43_phy {
475         /* Band support flags. */
476         bool supports_2ghz;
477         bool supports_5ghz;
478
479         /* GMODE bit enabled? */
480         bool gmode;
481
482         /* Analog Type */
483         u8 analog;
484         /* B43_PHYTYPE_ */
485         u8 type;
486         /* PHY revision number. */
487         u8 rev;
488
489         /* Radio versioning */
490         u16 radio_manuf;        /* Radio manufacturer */
491         u16 radio_ver;          /* Radio version */
492         u8 radio_rev;           /* Radio revision */
493
494         bool dyn_tssi_tbl;      /* tssi2dbm is kmalloc()ed. */
495
496         /* ACI (adjacent channel interference) flags. */
497         bool aci_enable;
498         bool aci_wlan_automatic;
499         bool aci_hw_rssi;
500
501         /* Radio switched on/off */
502         bool radio_on;
503         struct {
504                 /* Values saved when turning the radio off.
505                  * They are needed when turning it on again. */
506                 bool valid;
507                 u16 rfover;
508                 u16 rfoverval;
509         } radio_off_context;
510
511         u16 minlowsig[2];
512         u16 minlowsigpos[2];
513
514         /* TSSI to dBm table in use */
515         const s8 *tssi2dbm;
516         /* Target idle TSSI */
517         int tgt_idle_tssi;
518         /* Current idle TSSI */
519         int cur_idle_tssi;
520
521         /* LocalOscillator control values. */
522         struct b43_txpower_lo_control *lo_control;
523         /* Values from b43_calc_loopback_gain() */
524         s16 max_lb_gain;        /* Maximum Loopback gain in hdB */
525         s16 trsw_rx_gain;       /* TRSW RX gain in hdB */
526         s16 lna_lod_gain;       /* LNA lod */
527         s16 lna_gain;           /* LNA */
528         s16 pga_gain;           /* PGA */
529
530         /* Desired TX power level (in dBm).
531          * This is set by the user and adjusted in b43_phy_xmitpower(). */
532         u8 power_level;
533         /* A-PHY TX Power control value. */
534         u16 txpwr_offset;
535
536         /* Current TX power level attenuation control values */
537         struct b43_bbatt bbatt;
538         struct b43_rfatt rfatt;
539         u8 tx_control;          /* B43_TXCTL_XXX */
540
541         /* Hardware Power Control enabled? */
542         bool hardware_power_control;
543
544         /* Current Interference Mitigation mode */
545         int interfmode;
546         /* Stack of saved values from the Interference Mitigation code.
547          * Each value in the stack is layed out as follows:
548          * bit 0-11:  offset
549          * bit 12-15: register ID
550          * bit 16-32: value
551          * register ID is: 0x1 PHY, 0x2 Radio, 0x3 ILT
552          */
553 #define B43_INTERFSTACK_SIZE    26
554         u32 interfstack[B43_INTERFSTACK_SIZE];  //FIXME: use a data structure
555
556         /* Saved values from the NRSSI Slope calculation */
557         s16 nrssi[2];
558         s32 nrssislope;
559         /* In memory nrssi lookup table. */
560         s8 nrssi_lt[64];
561
562         /* current channel */
563         u8 channel;
564
565         u16 lofcal;
566
567         u16 initval;            //FIXME rename?
568
569         /* PHY TX errors counter. */
570         atomic_t txerr_cnt;
571
572         /* The device does address auto increment for the OFDM tables.
573          * We cache the previously used address here and omit the address
574          * write on the next table access, if possible. */
575         u16 ofdmtab_addr; /* The address currently set in hardware. */
576         enum { /* The last data flow direction. */
577                 B43_OFDMTAB_DIRECTION_UNKNOWN = 0,
578                 B43_OFDMTAB_DIRECTION_READ,
579                 B43_OFDMTAB_DIRECTION_WRITE,
580         } ofdmtab_addr_direction;
581
582 #if B43_DEBUG
583         /* Manual TX-power control enabled? */
584         bool manual_txpower_control;
585         /* PHY registers locked by b43_phy_lock()? */
586         bool phy_locked;
587 #endif /* B43_DEBUG */
588 };
589
590 /* Data structures for DMA transmission, per 80211 core. */
591 struct b43_dma {
592         struct b43_dmaring *tx_ring_AC_BK; /* Background */
593         struct b43_dmaring *tx_ring_AC_BE; /* Best Effort */
594         struct b43_dmaring *tx_ring_AC_VI; /* Video */
595         struct b43_dmaring *tx_ring_AC_VO; /* Voice */
596         struct b43_dmaring *tx_ring_mcast; /* Multicast */
597
598         struct b43_dmaring *rx_ring;
599 };
600
601 /* Context information for a noise calculation (Link Quality). */
602 struct b43_noise_calculation {
603         u8 channel_at_start;
604         bool calculation_running;
605         u8 nr_samples;
606         s8 samples[8][4];
607 };
608
609 struct b43_stats {
610         u8 link_noise;
611         /* Store the last TX/RX times here for updating the leds. */
612         unsigned long last_tx;
613         unsigned long last_rx;
614 };
615
616 struct b43_key {
617         /* If keyconf is NULL, this key is disabled.
618          * keyconf is a cookie. Don't derefenrence it outside of the set_key
619          * path, because b43 doesn't own it. */
620         struct ieee80211_key_conf *keyconf;
621         u8 algorithm;
622 };
623
624 /* SHM offsets to the QOS data structures for the 4 different queues. */
625 #define B43_QOS_PARAMS(queue)   (B43_SHM_SH_EDCFQ + \
626                                  (B43_NR_QOSPARAMS * sizeof(u16) * (queue)))
627 #define B43_QOS_BACKGROUND      B43_QOS_PARAMS(0)
628 #define B43_QOS_BESTEFFORT      B43_QOS_PARAMS(1)
629 #define B43_QOS_VIDEO           B43_QOS_PARAMS(2)
630 #define B43_QOS_VOICE           B43_QOS_PARAMS(3)
631
632 /* QOS parameter hardware data structure offsets. */
633 #define B43_NR_QOSPARAMS        22
634 enum {
635         B43_QOSPARAM_TXOP = 0,
636         B43_QOSPARAM_CWMIN,
637         B43_QOSPARAM_CWMAX,
638         B43_QOSPARAM_CWCUR,
639         B43_QOSPARAM_AIFS,
640         B43_QOSPARAM_BSLOTS,
641         B43_QOSPARAM_REGGAP,
642         B43_QOSPARAM_STATUS,
643 };
644
645 /* QOS parameters for a queue. */
646 struct b43_qos_params {
647         /* The QOS parameters */
648         struct ieee80211_tx_queue_params p;
649         /* Does this need to get uploaded to hardware? */
650         bool need_hw_update;
651 };
652
653 struct b43_wldev;
654
655 /* Data structure for the WLAN parts (802.11 cores) of the b43 chip. */
656 struct b43_wl {
657         /* Pointer to the active wireless device on this chip */
658         struct b43_wldev *current_dev;
659         /* Pointer to the ieee80211 hardware data structure */
660         struct ieee80211_hw *hw;
661
662         struct mutex mutex;
663         spinlock_t irq_lock;
664         /* Lock for LEDs access. */
665         spinlock_t leds_lock;
666         /* Lock for SHM access. */
667         spinlock_t shm_lock;
668
669         /* We can only have one operating interface (802.11 core)
670          * at a time. General information about this interface follows.
671          */
672
673         struct ieee80211_vif *vif;
674         /* The MAC address of the operating interface. */
675         u8 mac_addr[ETH_ALEN];
676         /* Current BSSID */
677         u8 bssid[ETH_ALEN];
678         /* Interface type. (IEEE80211_IF_TYPE_XXX) */
679         int if_type;
680         /* Is the card operating in AP, STA or IBSS mode? */
681         bool operating;
682         /* filter flags */
683         unsigned int filter_flags;
684         /* Stats about the wireless interface */
685         struct ieee80211_low_level_stats ieee_stats;
686
687         struct hwrng rng;
688         u8 rng_initialized;
689         char rng_name[30 + 1];
690
691         /* The RF-kill button */
692         struct b43_rfkill rfkill;
693
694         /* List of all wireless devices on this chip */
695         struct list_head devlist;
696         u8 nr_devs;
697
698         bool radiotap_enabled;
699
700         /* The beacon we are currently using (AP or IBSS mode).
701          * This beacon stuff is protected by the irq_lock. */
702         struct sk_buff *current_beacon;
703         bool beacon0_uploaded;
704         bool beacon1_uploaded;
705
706         /* The current QOS parameters for the 4 queues.
707          * This is protected by the irq_lock. */
708         struct b43_qos_params qos_params[4];
709         /* Workqueue for updating QOS parameters in hardware. */
710         struct work_struct qos_update_work;
711 };
712
713 /* In-memory representation of a cached microcode file. */
714 struct b43_firmware_file {
715         const char *filename;
716         const struct firmware *data;
717 };
718
719 /* Pointers to the firmware data and meta information about it. */
720 struct b43_firmware {
721         /* Microcode */
722         struct b43_firmware_file ucode;
723         /* PCM code */
724         struct b43_firmware_file pcm;
725         /* Initial MMIO values for the firmware */
726         struct b43_firmware_file initvals;
727         /* Initial MMIO values for the firmware, band-specific */
728         struct b43_firmware_file initvals_band;
729
730         /* Firmware revision */
731         u16 rev;
732         /* Firmware patchlevel */
733         u16 patch;
734 };
735
736 /* Device (802.11 core) initialization status. */
737 enum {
738         B43_STAT_UNINIT = 0,    /* Uninitialized. */
739         B43_STAT_INITIALIZED = 1,       /* Initialized, but not started, yet. */
740         B43_STAT_STARTED = 2,   /* Up and running. */
741 };
742 #define b43_status(wldev)               atomic_read(&(wldev)->__init_status)
743 #define b43_set_status(wldev, stat)     do {                    \
744                 atomic_set(&(wldev)->__init_status, (stat));    \
745                 smp_wmb();                                      \
746                                         } while (0)
747
748 /* XXX---   HOW LOCKING WORKS IN B43   ---XXX
749  *
750  * You should always acquire both, wl->mutex and wl->irq_lock unless:
751  * - You don't need to acquire wl->irq_lock, if the interface is stopped.
752  * - You don't need to acquire wl->mutex in the IRQ handler, IRQ tasklet
753  *   and packet TX path (and _ONLY_ there.)
754  */
755
756 /* Data structure for one wireless device (802.11 core) */
757 struct b43_wldev {
758         struct ssb_device *dev;
759         struct b43_wl *wl;
760
761         /* The device initialization status.
762          * Use b43_status() to query. */
763         atomic_t __init_status;
764         /* Saved init status for handling suspend. */
765         int suspend_init_status;
766
767         bool bad_frames_preempt;        /* Use "Bad Frames Preemption" (default off) */
768         bool dfq_valid;         /* Directed frame queue valid (IBSS PS mode, ATIM) */
769         bool short_slot;        /* TRUE, if short slot timing is enabled. */
770         bool radio_hw_enable;   /* saved state of radio hardware enabled state */
771         bool suspend_in_progress;       /* TRUE, if we are in a suspend/resume cycle */
772
773         /* PHY/Radio device. */
774         struct b43_phy phy;
775
776         /* DMA engines. */
777         struct b43_dma dma;
778
779         /* Various statistics about the physical device. */
780         struct b43_stats stats;
781
782         /* The device LEDs. */
783         struct b43_led led_tx;
784         struct b43_led led_rx;
785         struct b43_led led_assoc;
786         struct b43_led led_radio;
787
788         /* Reason code of the last interrupt. */
789         u32 irq_reason;
790         u32 dma_reason[6];
791         /* saved irq enable/disable state bitfield. */
792         u32 irq_savedstate;
793         /* Link Quality calculation context. */
794         struct b43_noise_calculation noisecalc;
795         /* if > 0 MAC is suspended. if == 0 MAC is enabled. */
796         int mac_suspended;
797
798         /* Interrupt Service Routine tasklet (bottom-half) */
799         struct tasklet_struct isr_tasklet;
800
801         /* Periodic tasks */
802         struct delayed_work periodic_work;
803         unsigned int periodic_state;
804
805         struct work_struct restart_work;
806
807         /* encryption/decryption */
808         u16 ktp;                /* Key table pointer */
809         u8 max_nr_keys;
810         struct b43_key key[58];
811
812         /* Firmware data */
813         struct b43_firmware fw;
814
815         /* Devicelist in struct b43_wl (all 802.11 cores) */
816         struct list_head list;
817
818         /* Debugging stuff follows. */
819 #ifdef CONFIG_B43_DEBUG
820         struct b43_dfsentry *dfsentry;
821 #endif
822 };
823
824 static inline struct b43_wl *hw_to_b43_wl(struct ieee80211_hw *hw)
825 {
826         return hw->priv;
827 }
828
829 static inline struct b43_wldev *dev_to_b43_wldev(struct device *dev)
830 {
831         struct ssb_device *ssb_dev = dev_to_ssb_dev(dev);
832         return ssb_get_drvdata(ssb_dev);
833 }
834
835 /* Is the device operating in a specified mode (IEEE80211_IF_TYPE_XXX). */
836 static inline int b43_is_mode(struct b43_wl *wl, int type)
837 {
838         return (wl->operating && wl->if_type == type);
839 }
840
841 static inline u16 b43_read16(struct b43_wldev *dev, u16 offset)
842 {
843         return ssb_read16(dev->dev, offset);
844 }
845
846 static inline void b43_write16(struct b43_wldev *dev, u16 offset, u16 value)
847 {
848         ssb_write16(dev->dev, offset, value);
849 }
850
851 static inline u32 b43_read32(struct b43_wldev *dev, u16 offset)
852 {
853         return ssb_read32(dev->dev, offset);
854 }
855
856 static inline void b43_write32(struct b43_wldev *dev, u16 offset, u32 value)
857 {
858         ssb_write32(dev->dev, offset, value);
859 }
860
861 /* Message printing */
862 void b43info(struct b43_wl *wl, const char *fmt, ...)
863     __attribute__ ((format(printf, 2, 3)));
864 void b43err(struct b43_wl *wl, const char *fmt, ...)
865     __attribute__ ((format(printf, 2, 3)));
866 void b43warn(struct b43_wl *wl, const char *fmt, ...)
867     __attribute__ ((format(printf, 2, 3)));
868 #if B43_DEBUG
869 void b43dbg(struct b43_wl *wl, const char *fmt, ...)
870     __attribute__ ((format(printf, 2, 3)));
871 #else /* DEBUG */
872 # define b43dbg(wl, fmt...) do { /* nothing */ } while (0)
873 #endif /* DEBUG */
874
875 /* A WARN_ON variant that vanishes when b43 debugging is disabled.
876  * This _also_ evaluates the arg with debugging disabled. */
877 #if B43_DEBUG
878 # define B43_WARN_ON(x) WARN_ON(x)
879 #else
880 static inline bool __b43_warn_on_dummy(bool x) { return x; }
881 # define B43_WARN_ON(x) __b43_warn_on_dummy(unlikely(!!(x)))
882 #endif
883
884 /** Limit a value between two limits */
885 #ifdef limit_value
886 # undef limit_value
887 #endif
888 #define limit_value(value, min, max)  \
889         ({                                              \
890                 typeof(value) __value = (value);        \
891                 typeof(value) __min = (min);            \
892                 typeof(value) __max = (max);            \
893                 if (__value < __min)                    \
894                         __value = __min;                \
895                 else if (__value > __max)               \
896                         __value = __max;                \
897                 __value;                                \
898         })
899
900 /* Convert an integer to a Q5.2 value */
901 #define INT_TO_Q52(i)   ((i) << 2)
902 /* Convert a Q5.2 value to an integer (precision loss!) */
903 #define Q52_TO_INT(q52) ((q52) >> 2)
904 /* Macros for printing a value in Q5.2 format */
905 #define Q52_FMT         "%u.%u"
906 #define Q52_ARG(q52)    Q52_TO_INT(q52), ((((q52) & 0x3) * 100) / 4)
907
908 #endif /* B43_H_ */