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