drivers/net/wireless/bcm43xx/bcm43xx.h

   1 #ifndef BCM43xx_H_
   2 #define BCM43xx_H_
   3
   4 #include <linux/hw_random.h>
   5 #include <linux/version.h>
   6 #include <linux/kernel.h>
   7 #include <linux/spinlock.h>
   8 #include <linux/interrupt.h>
   9 #include <linux/stringify.h>
  10 #include <linux/pci.h>
  11 #include <net/ieee80211.h>
  12 #include <net/ieee80211softmac.h>
  13 #include <asm/atomic.h>
  14 #include <asm/io.h>
  15
  16
  17 #include "bcm43xx_debugfs.h"
  18 #include "bcm43xx_leds.h"
  19
  20
  21 #define PFX                             KBUILD_MODNAME ": "
  22
  23 #define BCM43xx_SWITCH_CORE_MAX_RETRIES 50
  24 #define BCM43xx_IRQWAIT_MAX_RETRIES     50
  25
  26 #define BCM43xx_IO_SIZE                 8192
  27
  28 /* Active Core PCI Configuration Register. */
  29 #define BCM43xx_PCICFG_ACTIVE_CORE      0x80
  30 /* SPROM control register. */
  31 #define BCM43xx_PCICFG_SPROMCTL         0x88
  32 /* Interrupt Control PCI Configuration Register. (Only on PCI cores with rev >= 6) */
  33 #define BCM43xx_PCICFG_ICR              0x94
  34
  35 /* MMIO offsets */
  36 #define BCM43xx_MMIO_DMA0_REASON        0x20
  37 #define BCM43xx_MMIO_DMA0_IRQ_MASK      0x24
  38 #define BCM43xx_MMIO_DMA1_REASON        0x28
  39 #define BCM43xx_MMIO_DMA1_IRQ_MASK      0x2C
  40 #define BCM43xx_MMIO_DMA2_REASON        0x30
  41 #define BCM43xx_MMIO_DMA2_IRQ_MASK      0x34
  42 #define BCM43xx_MMIO_DMA3_REASON        0x38
  43 #define BCM43xx_MMIO_DMA3_IRQ_MASK      0x3C
  44 #define BCM43xx_MMIO_DMA4_REASON        0x40
  45 #define BCM43xx_MMIO_DMA4_IRQ_MASK      0x44
  46 #define BCM43xx_MMIO_DMA5_REASON        0x48
  47 #define BCM43xx_MMIO_DMA5_IRQ_MASK      0x4C
  48 #define BCM43xx_MMIO_STATUS_BITFIELD    0x120
  49 #define BCM43xx_MMIO_STATUS2_BITFIELD   0x124
  50 #define BCM43xx_MMIO_GEN_IRQ_REASON     0x128
  51 #define BCM43xx_MMIO_GEN_IRQ_MASK       0x12C
  52 #define BCM43xx_MMIO_RAM_CONTROL        0x130
  53 #define BCM43xx_MMIO_RAM_DATA           0x134
  54 #define BCM43xx_MMIO_PS_STATUS          0x140
  55 #define BCM43xx_MMIO_RADIO_HWENABLED_HI 0x158
  56 #define BCM43xx_MMIO_SHM_CONTROL        0x160
  57 #define BCM43xx_MMIO_SHM_DATA           0x164
  58 #define BCM43xx_MMIO_SHM_DATA_UNALIGNED 0x166
  59 #define BCM43xx_MMIO_XMITSTAT_0         0x170
  60 #define BCM43xx_MMIO_XMITSTAT_1         0x174
  61 #define BCM43xx_MMIO_REV3PLUS_TSF_LOW   0x180 /* core rev >= 3 only */
  62 #define BCM43xx_MMIO_REV3PLUS_TSF_HIGH  0x184 /* core rev >= 3 only */
  63
  64 /* 32-bit DMA */
  65 #define BCM43xx_MMIO_DMA32_BASE0        0x200
  66 #define BCM43xx_MMIO_DMA32_BASE1        0x220
  67 #define BCM43xx_MMIO_DMA32_BASE2        0x240
  68 #define BCM43xx_MMIO_DMA32_BASE3        0x260
  69 #define BCM43xx_MMIO_DMA32_BASE4        0x280
  70 #define BCM43xx_MMIO_DMA32_BASE5        0x2A0
  71 /* 64-bit DMA */
  72 #define BCM43xx_MMIO_DMA64_BASE0        0x200
  73 #define BCM43xx_MMIO_DMA64_BASE1        0x240
  74 #define BCM43xx_MMIO_DMA64_BASE2        0x280
  75 #define BCM43xx_MMIO_DMA64_BASE3        0x2C0
  76 #define BCM43xx_MMIO_DMA64_BASE4        0x300
  77 #define BCM43xx_MMIO_DMA64_BASE5        0x340
  78 /* PIO */
  79 #define BCM43xx_MMIO_PIO1_BASE          0x300
  80 #define BCM43xx_MMIO_PIO2_BASE          0x310
  81 #define BCM43xx_MMIO_PIO3_BASE          0x320
  82 #define BCM43xx_MMIO_PIO4_BASE          0x330
  83
  84 #define BCM43xx_MMIO_PHY_VER            0x3E0
  85 #define BCM43xx_MMIO_PHY_RADIO          0x3E2
  86 #define BCM43xx_MMIO_ANTENNA            0x3E8
  87 #define BCM43xx_MMIO_CHANNEL            0x3F0
  88 #define BCM43xx_MMIO_CHANNEL_EXT        0x3F4
  89 #define BCM43xx_MMIO_RADIO_CONTROL      0x3F6
  90 #define BCM43xx_MMIO_RADIO_DATA_HIGH    0x3F8
  91 #define BCM43xx_MMIO_RADIO_DATA_LOW     0x3FA
  92 #define BCM43xx_MMIO_PHY_CONTROL        0x3FC
  93 #define BCM43xx_MMIO_PHY_DATA           0x3FE
  94 #define BCM43xx_MMIO_MACFILTER_CONTROL  0x420
  95 #define BCM43xx_MMIO_MACFILTER_DATA     0x422
  96 #define BCM43xx_MMIO_RADIO_HWENABLED_LO 0x49A
  97 #define BCM43xx_MMIO_GPIO_CONTROL       0x49C
  98 #define BCM43xx_MMIO_GPIO_MASK          0x49E
  99 #define BCM43xx_MMIO_TSF_0              0x632 /* core rev < 3 only */
 100 #define BCM43xx_MMIO_TSF_1              0x634 /* core rev < 3 only */
 101 #define BCM43xx_MMIO_TSF_2              0x636 /* core rev < 3 only */
 102 #define BCM43xx_MMIO_TSF_3              0x638 /* core rev < 3 only */
 103 #define BCM43xx_MMIO_RNG                0x65A
 104 #define BCM43xx_MMIO_POWERUP_DELAY      0x6A8
 105
 106 /* SPROM offsets. */
 107 #define BCM43xx_SPROM_BASE              0x1000
 108 #define BCM43xx_SPROM_BOARDFLAGS2       0x1c
 109 #define BCM43xx_SPROM_IL0MACADDR        0x24
 110 #define BCM43xx_SPROM_ET0MACADDR        0x27
 111 #define BCM43xx_SPROM_ET1MACADDR        0x2a
 112 #define BCM43xx_SPROM_ETHPHY            0x2d
 113 #define BCM43xx_SPROM_BOARDREV          0x2e
 114 #define BCM43xx_SPROM_PA0B0             0x2f
 115 #define BCM43xx_SPROM_PA0B1             0x30
 116 #define BCM43xx_SPROM_PA0B2             0x31
 117 #define BCM43xx_SPROM_WL0GPIO0          0x32
 118 #define BCM43xx_SPROM_WL0GPIO2          0x33
 119 #define BCM43xx_SPROM_MAXPWR            0x34
 120 #define BCM43xx_SPROM_PA1B0             0x35
 121 #define BCM43xx_SPROM_PA1B1             0x36
 122 #define BCM43xx_SPROM_PA1B2             0x37
 123 #define BCM43xx_SPROM_IDL_TSSI_TGT      0x38
 124 #define BCM43xx_SPROM_BOARDFLAGS        0x39
 125 #define BCM43xx_SPROM_ANTENNA_GAIN      0x3a
 126 #define BCM43xx_SPROM_VERSION           0x3f
 127
 128 /* BCM43xx_SPROM_BOARDFLAGS values */
 129 #define BCM43xx_BFL_BTCOEXIST           0x0001 /* implements Bluetooth coexistance */
 130 #define BCM43xx_BFL_PACTRL              0x0002 /* GPIO 9 controlling the PA */
 131 #define BCM43xx_BFL_AIRLINEMODE         0x0004 /* implements GPIO 13 radio disable indication */
 132 #define BCM43xx_BFL_RSSI                0x0008 /* software calculates nrssi slope. */
 133 #define BCM43xx_BFL_ENETSPI             0x0010 /* has ephy roboswitch spi */
 134 #define BCM43xx_BFL_XTAL_NOSLOW         0x0020 /* no slow clock available */
 135 #define BCM43xx_BFL_CCKHIPWR            0x0040 /* can do high power CCK transmission */
 136 #define BCM43xx_BFL_ENETADM             0x0080 /* has ADMtek switch */
 137 #define BCM43xx_BFL_ENETVLAN            0x0100 /* can do vlan */
 138 #define BCM43xx_BFL_AFTERBURNER         0x0200 /* supports Afterburner mode */
 139 #define BCM43xx_BFL_NOPCI               0x0400 /* leaves PCI floating */
 140 #define BCM43xx_BFL_FEM                 0x0800 /* supports the Front End Module */
 141 #define BCM43xx_BFL_EXTLNA              0x1000 /* has an external LNA */
 142 #define BCM43xx_BFL_HGPA                0x2000 /* had high gain PA */
 143 #define BCM43xx_BFL_BTCMOD              0x4000 /* BFL_BTCOEXIST is given in alternate GPIOs */
 144 #define BCM43xx_BFL_ALTIQ               0x8000 /* alternate I/Q settings */
 145
 146 /* GPIO register offset, in both ChipCommon and PCI core. */
 147 #define BCM43xx_GPIO_CONTROL            0x6c
 148
 149 /* SHM Routing */
 150 #define BCM43xx_SHM_SHARED              0x0001
 151 #define BCM43xx_SHM_WIRELESS            0x0002
 152 #define BCM43xx_SHM_PCM                 0x0003
 153 #define BCM43xx_SHM_HWMAC               0x0004
 154 #define BCM43xx_SHM_UCODE               0x0300
 155
 156 /* MacFilter offsets. */
 157 #define BCM43xx_MACFILTER_SELF          0x0000
 158 #define BCM43xx_MACFILTER_ASSOC         0x0003
 159
 160 /* Chipcommon registers. */
 161 #define BCM43xx_CHIPCOMMON_CAPABILITIES         0x04
 162 #define BCM43xx_CHIPCOMMON_PLLONDELAY           0xB0
 163 #define BCM43xx_CHIPCOMMON_FREFSELDELAY         0xB4
 164 #define BCM43xx_CHIPCOMMON_SLOWCLKCTL           0xB8
 165 #define BCM43xx_CHIPCOMMON_SYSCLKCTL            0xC0
 166
 167 /* PCI core specific registers. */
 168 #define BCM43xx_PCICORE_BCAST_ADDR      0x50
 169 #define BCM43xx_PCICORE_BCAST_DATA      0x54
 170 #define BCM43xx_PCICORE_SBTOPCI2        0x108
 171
 172 /* SBTOPCI2 values. */
 173 #define BCM43xx_SBTOPCI2_PREFETCH       0x4
 174 #define BCM43xx_SBTOPCI2_BURST          0x8
 175
 176 /* Chipcommon capabilities. */
 177 #define BCM43xx_CAPABILITIES_PCTL               0x00040000
 178 #define BCM43xx_CAPABILITIES_PLLMASK            0x00030000
 179 #define BCM43xx_CAPABILITIES_PLLSHIFT           16
 180 #define BCM43xx_CAPABILITIES_FLASHMASK          0x00000700
 181 #define BCM43xx_CAPABILITIES_FLASHSHIFT         8
 182 #define BCM43xx_CAPABILITIES_EXTBUSPRESENT      0x00000040
 183 #define BCM43xx_CAPABILITIES_UARTGPIO           0x00000020
 184 #define BCM43xx_CAPABILITIES_UARTCLOCKMASK      0x00000018
 185 #define BCM43xx_CAPABILITIES_UARTCLOCKSHIFT     3
 186 #define BCM43xx_CAPABILITIES_MIPSBIGENDIAN      0x00000004
 187 #define BCM43xx_CAPABILITIES_NRUARTSMASK        0x00000003
 188
 189 /* PowerControl */
 190 #define BCM43xx_PCTL_IN                 0xB0
 191 #define BCM43xx_PCTL_OUT                0xB4
 192 #define BCM43xx_PCTL_OUTENABLE          0xB8
 193 #define BCM43xx_PCTL_XTAL_POWERUP       0x40
 194 #define BCM43xx_PCTL_PLL_POWERDOWN      0x80
 195
 196 /* PowerControl Clock Modes */
 197 #define BCM43xx_PCTL_CLK_FAST           0x00
 198 #define BCM43xx_PCTL_CLK_SLOW           0x01
 199 #define BCM43xx_PCTL_CLK_DYNAMIC        0x02
 200
 201 #define BCM43xx_PCTL_FORCE_SLOW         0x0800
 202 #define BCM43xx_PCTL_FORCE_PLL          0x1000
 203 #define BCM43xx_PCTL_DYN_XTAL           0x2000
 204
 205 /* COREIDs */
 206 #define BCM43xx_COREID_CHIPCOMMON       0x800
 207 #define BCM43xx_COREID_ILINE20          0x801
 208 #define BCM43xx_COREID_SDRAM            0x803
 209 #define BCM43xx_COREID_PCI              0x804
 210 #define BCM43xx_COREID_MIPS             0x805
 211 #define BCM43xx_COREID_ETHERNET         0x806
 212 #define BCM43xx_COREID_V90              0x807
 213 #define BCM43xx_COREID_USB11_HOSTDEV    0x80a
 214 #define BCM43xx_COREID_IPSEC            0x80b
 215 #define BCM43xx_COREID_PCMCIA           0x80d
 216 #define BCM43xx_COREID_EXT_IF           0x80f
 217 #define BCM43xx_COREID_80211            0x812
 218 #define BCM43xx_COREID_MIPS_3302        0x816
 219 #define BCM43xx_COREID_USB11_HOST       0x817
 220 #define BCM43xx_COREID_USB11_DEV        0x818
 221 #define BCM43xx_COREID_USB20_HOST       0x819
 222 #define BCM43xx_COREID_USB20_DEV        0x81a
 223 #define BCM43xx_COREID_SDIO_HOST        0x81b
 224
 225 /* Core Information Registers */
 226 #define BCM43xx_CIR_BASE                0xf00
 227 #define BCM43xx_CIR_SBTPSFLAG           (BCM43xx_CIR_BASE + 0x18)
 228 #define BCM43xx_CIR_SBIMSTATE           (BCM43xx_CIR_BASE + 0x90)
 229 #define BCM43xx_CIR_SBINTVEC            (BCM43xx_CIR_BASE + 0x94)
 230 #define BCM43xx_CIR_SBTMSTATELOW        (BCM43xx_CIR_BASE + 0x98)
 231 #define BCM43xx_CIR_SBTMSTATEHIGH       (BCM43xx_CIR_BASE + 0x9c)
 232 #define BCM43xx_CIR_SBIMCONFIGLOW       (BCM43xx_CIR_BASE + 0xa8)
 233 #define BCM43xx_CIR_SB_ID_HI            (BCM43xx_CIR_BASE + 0xfc)
 234
 235 /* Mask to get the Backplane Flag Number from SBTPSFLAG. */
 236 #define BCM43xx_BACKPLANE_FLAG_NR_MASK  0x3f
 237
 238 /* SBIMCONFIGLOW values/masks. */
 239 #define BCM43xx_SBIMCONFIGLOW_SERVICE_TOUT_MASK         0x00000007
 240 #define BCM43xx_SBIMCONFIGLOW_SERVICE_TOUT_SHIFT        0
 241 #define BCM43xx_SBIMCONFIGLOW_REQUEST_TOUT_MASK         0x00000070
 242 #define BCM43xx_SBIMCONFIGLOW_REQUEST_TOUT_SHIFT        4
 243 #define BCM43xx_SBIMCONFIGLOW_CONNID_MASK               0x00ff0000
 244 #define BCM43xx_SBIMCONFIGLOW_CONNID_SHIFT              16
 245
 246 /* sbtmstatelow state flags */
 247 #define BCM43xx_SBTMSTATELOW_RESET              0x01
 248 #define BCM43xx_SBTMSTATELOW_REJECT             0x02
 249 #define BCM43xx_SBTMSTATELOW_CLOCK              0x10000
 250 #define BCM43xx_SBTMSTATELOW_FORCE_GATE_CLOCK   0x20000
 251
 252 /* sbtmstatehigh state flags */
 253 #define BCM43xx_SBTMSTATEHIGH_SERROR            0x00000001
 254 #define BCM43xx_SBTMSTATEHIGH_BUSY              0x00000004
 255 #define BCM43xx_SBTMSTATEHIGH_TIMEOUT           0x00000020
 256 #define BCM43xx_SBTMSTATEHIGH_COREFLAGS         0x1FFF0000
 257 #define BCM43xx_SBTMSTATEHIGH_DMA64BIT          0x10000000
 258 #define BCM43xx_SBTMSTATEHIGH_GATEDCLK          0x20000000
 259 #define BCM43xx_SBTMSTATEHIGH_BISTFAILED        0x40000000
 260 #define BCM43xx_SBTMSTATEHIGH_BISTCOMPLETE      0x80000000
 261
 262 /* sbimstate flags */
 263 #define BCM43xx_SBIMSTATE_IB_ERROR              0x20000
 264 #define BCM43xx_SBIMSTATE_TIMEOUT               0x40000
 265
 266 /* PHYVersioning */
 267 #define BCM43xx_PHYTYPE_A               0x00
 268 #define BCM43xx_PHYTYPE_B               0x01
 269 #define BCM43xx_PHYTYPE_G               0x02
 270
 271 /* PHYRegisters */
 272 #define BCM43xx_PHY_ILT_A_CTRL          0x0072
 273 #define BCM43xx_PHY_ILT_A_DATA1         0x0073
 274 #define BCM43xx_PHY_ILT_A_DATA2         0x0074
 275 #define BCM43xx_PHY_G_LO_CONTROL        0x0810
 276 #define BCM43xx_PHY_ILT_G_CTRL          0x0472
 277 #define BCM43xx_PHY_ILT_G_DATA1         0x0473
 278 #define BCM43xx_PHY_ILT_G_DATA2         0x0474
 279 #define BCM43xx_PHY_A_PCTL              0x007B
 280 #define BCM43xx_PHY_G_PCTL              0x0029
 281 #define BCM43xx_PHY_A_CRS               0x0029
 282 #define BCM43xx_PHY_RADIO_BITFIELD      0x0401
 283 #define BCM43xx_PHY_G_CRS               0x0429
 284 #define BCM43xx_PHY_NRSSILT_CTRL        0x0803
 285 #define BCM43xx_PHY_NRSSILT_DATA        0x0804
 286
 287 /* RadioRegisters */
 288 #define BCM43xx_RADIOCTL_ID             0x01
 289
 290 /* StatusBitField */
 291 #define BCM43xx_SBF_MAC_ENABLED         0x00000001
 292 #define BCM43xx_SBF_2                   0x00000002 /*FIXME: fix name*/
 293 #define BCM43xx_SBF_CORE_READY          0x00000004
 294 #define BCM43xx_SBF_400                 0x00000400 /*FIXME: fix name*/
 295 #define BCM43xx_SBF_4000                0x00004000 /*FIXME: fix name*/
 296 #define BCM43xx_SBF_8000                0x00008000 /*FIXME: fix name*/
 297 #define BCM43xx_SBF_XFER_REG_BYTESWAP   0x00010000
 298 #define BCM43xx_SBF_MODE_NOTADHOC       0x00020000
 299 #define BCM43xx_SBF_MODE_AP             0x00040000
 300 #define BCM43xx_SBF_RADIOREG_LOCK       0x00080000
 301 #define BCM43xx_SBF_MODE_MONITOR        0x00400000
 302 #define BCM43xx_SBF_MODE_PROMISC        0x01000000
 303 #define BCM43xx_SBF_PS1                 0x02000000
 304 #define BCM43xx_SBF_PS2                 0x04000000
 305 #define BCM43xx_SBF_NO_SSID_BCAST       0x08000000
 306 #define BCM43xx_SBF_TIME_UPDATE         0x10000000
 307 #define BCM43xx_SBF_80000000            0x80000000 /*FIXME: fix name*/
 308
 309 /* Microcode */
 310 #define BCM43xx_UCODE_REVISION          0x0000
 311 #define BCM43xx_UCODE_PATCHLEVEL        0x0002
 312 #define BCM43xx_UCODE_DATE              0x0004
 313 #define BCM43xx_UCODE_TIME              0x0006
 314 #define BCM43xx_UCODE_STATUS            0x0040
 315
 316 /* MicrocodeFlagsBitfield (addr + lo-word values?)*/
 317 #define BCM43xx_UCODEFLAGS_OFFSET       0x005E
 318
 319 #define BCM43xx_UCODEFLAG_AUTODIV       0x0001
 320 #define BCM43xx_UCODEFLAG_UNKBGPHY      0x0002
 321 #define BCM43xx_UCODEFLAG_UNKBPHY       0x0004
 322 #define BCM43xx_UCODEFLAG_UNKGPHY       0x0020
 323 #define BCM43xx_UCODEFLAG_UNKPACTRL     0x0040
 324 #define BCM43xx_UCODEFLAG_JAPAN         0x0080
 325
 326 /* Generic-Interrupt reasons. */
 327 #define BCM43xx_IRQ_READY               (1 << 0)
 328 #define BCM43xx_IRQ_BEACON              (1 << 1)
 329 #define BCM43xx_IRQ_PS                  (1 << 2)
 330 #define BCM43xx_IRQ_REG124              (1 << 5)
 331 #define BCM43xx_IRQ_PMQ                 (1 << 6)
 332 #define BCM43xx_IRQ_PIO_WORKAROUND      (1 << 8)
 333 #define BCM43xx_IRQ_XMIT_ERROR          (1 << 11)
 334 #define BCM43xx_IRQ_RX                  (1 << 15)
 335 #define BCM43xx_IRQ_SCAN                (1 << 16)
 336 #define BCM43xx_IRQ_NOISE               (1 << 18)
 337 #define BCM43xx_IRQ_XMIT_STATUS         (1 << 29)
 338
 339 #define BCM43xx_IRQ_ALL                 0xffffffff
 340 #define BCM43xx_IRQ_INITIAL             (BCM43xx_IRQ_PS |               \
 341                                          BCM43xx_IRQ_REG124 |           \
 342                                          BCM43xx_IRQ_PMQ |              \
 343                                          BCM43xx_IRQ_XMIT_ERROR |       \
 344                                          BCM43xx_IRQ_RX |               \
 345                                          BCM43xx_IRQ_SCAN |             \
 346                                          BCM43xx_IRQ_NOISE |            \
 347                                          BCM43xx_IRQ_XMIT_STATUS)
 348
 349
 350 /* Initial default iw_mode */
 351 #define BCM43xx_INITIAL_IWMODE                  IW_MODE_INFRA
 352
 353 /* Bus type PCI. */
 354 #define BCM43xx_BUSTYPE_PCI     0
 355 /* Bus type Silicone Backplane Bus. */
 356 #define BCM43xx_BUSTYPE_SB      1
 357 /* Bus type PCMCIA. */
 358 #define BCM43xx_BUSTYPE_PCMCIA  2
 359
 360 /* Threshold values. */
 361 #define BCM43xx_MIN_RTS_THRESHOLD               1U
 362 #define BCM43xx_MAX_RTS_THRESHOLD               2304U
 363 #define BCM43xx_DEFAULT_RTS_THRESHOLD           BCM43xx_MAX_RTS_THRESHOLD
 364
 365 #define BCM43xx_DEFAULT_SHORT_RETRY_LIMIT       7
 366 #define BCM43xx_DEFAULT_LONG_RETRY_LIMIT        4
 367
 368 /* FIXME: the next line is a guess as to what the maximum RSSI value might be */
 369 #define RX_RSSI_MAX                             60
 370
 371 /* Max size of a security key */
 372 #define BCM43xx_SEC_KEYSIZE                     16
 373 /* Security algorithms. */
 374 enum {
 375         BCM43xx_SEC_ALGO_NONE = 0, /* unencrypted, as of TX header. */
 376         BCM43xx_SEC_ALGO_WEP,
 377         BCM43xx_SEC_ALGO_UNKNOWN,
 378         BCM43xx_SEC_ALGO_AES,
 379         BCM43xx_SEC_ALGO_WEP104,
 380         BCM43xx_SEC_ALGO_TKIP,
 381 };
 382
 383 #ifdef assert
 384 # undef assert
 385 #endif
 386 #ifdef CONFIG_BCM43XX_DEBUG
 387 #define assert(expr) \
 388         do {                                                                    \
 389                 if (unlikely(!(expr))) {                                        \
 390                 printk(KERN_ERR PFX "ASSERTION FAILED (%s) at: %s:%d:%s()\n",   \
 391                         #expr, __FILE__, __LINE__, __FUNCTION__);               \
 392                 }                                                               \
 393         } while (0)
 394 #else
 395 #define assert(expr)    do { /* nothing */ } while (0)
 396 #endif
 397
 398 /* rate limited printk(). */
 399 #ifdef printkl
 400 # undef printkl
 401 #endif
 402 #define printkl(f, x...)  do { if (printk_ratelimit()) printk(f ,##x); } while (0)
 403 /* rate limited printk() for debugging */
 404 #ifdef dprintkl
 405 # undef dprintkl
 406 #endif
 407 #ifdef CONFIG_BCM43XX_DEBUG
 408 # define dprintkl               printkl
 409 #else
 410 # define dprintkl(f, x...)      do { /* nothing */ } while (0)
 411 #endif
 412
 413 /* Helper macro for if branches.
 414  * An if branch marked with this macro is only taken in DEBUG mode.
 415  * Example:
 416  *      if (DEBUG_ONLY(foo == bar)) {
 417  *              do something
 418  *      }
 419  *      In DEBUG mode, the branch will be taken if (foo == bar).
 420  *      In non-DEBUG mode, the branch will never be taken.
 421  */
 422 #ifdef DEBUG_ONLY
 423 # undef DEBUG_ONLY
 424 #endif
 425 #ifdef CONFIG_BCM43XX_DEBUG
 426 # define DEBUG_ONLY(x)  (x)
 427 #else
 428 # define DEBUG_ONLY(x)  0
 429 #endif
 430
 431 /* debugging printk() */
 432 #ifdef dprintk
 433 # undef dprintk
 434 #endif
 435 #ifdef CONFIG_BCM43XX_DEBUG
 436 # define dprintk(f, x...)  do { printk(f ,##x); } while (0)
 437 #else
 438 # define dprintk(f, x...)  do { /* nothing */ } while (0)
 439 #endif
 440
 441
 442 struct net_device;
 443 struct pci_dev;
 444 struct bcm43xx_dmaring;
 445 struct bcm43xx_pioqueue;
 446
 447 struct bcm43xx_initval {
 448         u16 offset;
 449         u16 size;
 450         u32 value;
 451 } __attribute__((__packed__));
 452
 453 /* Values for bcm430x_sprominfo.locale */
 454 enum {
 455         BCM43xx_LOCALE_WORLD = 0,
 456         BCM43xx_LOCALE_THAILAND,
 457         BCM43xx_LOCALE_ISRAEL,
 458         BCM43xx_LOCALE_JORDAN,
 459         BCM43xx_LOCALE_CHINA,
 460         BCM43xx_LOCALE_JAPAN,
 461         BCM43xx_LOCALE_USA_CANADA_ANZ,
 462         BCM43xx_LOCALE_EUROPE,
 463         BCM43xx_LOCALE_USA_LOW,
 464         BCM43xx_LOCALE_JAPAN_HIGH,
 465         BCM43xx_LOCALE_ALL,
 466         BCM43xx_LOCALE_NONE,
 467 };
 468
 469 #define BCM43xx_SPROM_SIZE      64 /* in 16-bit words. */
 470 struct bcm43xx_sprominfo {
 471         u16 boardflags2;
 472         u8 il0macaddr[6];
 473         u8 et0macaddr[6];
 474         u8 et1macaddr[6];
 475         u8 et0phyaddr:5;
 476         u8 et1phyaddr:5;
 477         u8 et0mdcport:1;
 478         u8 et1mdcport:1;
 479         u8 boardrev;
 480         u8 locale:4;
 481         u8 antennas_aphy:2;
 482         u8 antennas_bgphy:2;
 483         u16 pa0b0;
 484         u16 pa0b1;
 485         u16 pa0b2;
 486         u8 wl0gpio0;
 487         u8 wl0gpio1;
 488         u8 wl0gpio2;
 489         u8 wl0gpio3;
 490         u8 maxpower_aphy;
 491         u8 maxpower_bgphy;
 492         u16 pa1b0;
 493         u16 pa1b1;
 494         u16 pa1b2;
 495         u8 idle_tssi_tgt_aphy;
 496         u8 idle_tssi_tgt_bgphy;
 497         u16 boardflags;
 498         u16 antennagain_aphy;
 499         u16 antennagain_bgphy;
 500 };
 501
 502 /* Value pair to measure the LocalOscillator. */
 503 struct bcm43xx_lopair {
 504         s8 low;
 505         s8 high;
 506         u8 used:1;
 507 };
 508 #define BCM43xx_LO_COUNT        (14*4)
 509
 510 struct bcm43xx_phyinfo {
 511         /* Hardware Data */
 512         u8 version;
 513         u8 type;
 514         u8 rev;
 515         u16 antenna_diversity;
 516         u16 savedpctlreg;
 517         u16 minlowsig[2];
 518         u16 minlowsigpos[2];
 519         u8 connected:1,
 520            calibrated:1,
 521            is_locked:1, /* used in bcm43xx_phy_{un}lock() */
 522            dyn_tssi_tbl:1; /* used in bcm43xx_phy_init_tssi2dbm_table() */
 523         /* LO Measurement Data.
 524          * Use bcm43xx_get_lopair() to get a value.
 525          */
 526         struct bcm43xx_lopair *_lo_pairs;
 527
 528         /* TSSI to dBm table in use */
 529         const s8 *tssi2dbm;
 530         /* idle TSSI value */
 531         s8 idle_tssi;
 532
 533         /* Values from bcm43xx_calc_loopback_gain() */
 534         u16 loopback_gain[2];
 535
 536         /* PHY lock for core.rev < 3
 537          * This lock is only used by bcm43xx_phy_{un}lock()
 538          */
 539         spinlock_t lock;
 540
 541         /* Firmware. */
 542         const struct firmware *ucode;
 543         const struct firmware *pcm;
 544         const struct firmware *initvals0;
 545         const struct firmware *initvals1;
 546 };
 547
 548
 549 struct bcm43xx_radioinfo {
 550         u16 manufact;
 551         u16 version;
 552         u8 revision;
 553
 554         /* Desired TX power in dBm Q5.2 */
 555         u16 txpower_desired;
 556         /* TX Power control values. */
 557         union {
 558                 /* B/G PHY */
 559                 struct {
 560                         u16 baseband_atten;
 561                         u16 radio_atten;
 562                         u16 txctl1;
 563                         u16 txctl2;
 564                 };
 565                 /* A PHY */
 566                 struct {
 567                         u16 txpwr_offset;
 568                 };
 569         };
 570
 571         /* Current Interference Mitigation mode */
 572         int interfmode;
 573         /* Stack of saved values from the Interference Mitigation code.
 574          * Each value in the stack is layed out as follows:
 575          * bit 0-11:  offset
 576          * bit 12-15: register ID
 577          * bit 16-32: value
 578          * register ID is: 0x1 PHY, 0x2 Radio, 0x3 ILT
 579          */
 580 #define BCM43xx_INTERFSTACK_SIZE        26
 581         u32 interfstack[BCM43xx_INTERFSTACK_SIZE];
 582
 583         /* Saved values from the NRSSI Slope calculation */
 584         s16 nrssi[2];
 585         s32 nrssislope;
 586         /* In memory nrssi lookup table. */
 587         s8 nrssi_lt[64];
 588
 589         /* current channel */
 590         u8 channel;
 591         u8 initial_channel;
 592
 593         u16 lofcal;
 594
 595         u16 initval;
 596
 597         u8 enabled:1;
 598         /* ACI (adjacent channel interference) flags. */
 599         u8 aci_enable:1,
 600            aci_wlan_automatic:1,
 601            aci_hw_rssi:1;
 602 };
 603
 604 /* Data structures for DMA transmission, per 80211 core. */
 605 struct bcm43xx_dma {
 606         struct bcm43xx_dmaring *tx_ring0;
 607         struct bcm43xx_dmaring *tx_ring1;
 608         struct bcm43xx_dmaring *tx_ring2;
 609         struct bcm43xx_dmaring *tx_ring3;
 610         struct bcm43xx_dmaring *tx_ring4;
 611         struct bcm43xx_dmaring *tx_ring5;
 612
 613         struct bcm43xx_dmaring *rx_ring0;
 614         struct bcm43xx_dmaring *rx_ring3; /* only available on core.rev < 5 */
 615 };
 616
 617 /* Data structures for PIO transmission, per 80211 core. */
 618 struct bcm43xx_pio {
 619         struct bcm43xx_pioqueue *queue0;
 620         struct bcm43xx_pioqueue *queue1;
 621         struct bcm43xx_pioqueue *queue2;
 622         struct bcm43xx_pioqueue *queue3;
 623 };
 624
 625 #define BCM43xx_MAX_80211_CORES         2
 626
 627 #ifdef CONFIG_BCM947XX
 628 #define core_offset(bcm) (bcm)->current_core_offset
 629 #else
 630 #define core_offset(bcm) 0
 631 #endif
 632
 633 /* Generic information about a core. */
 634 struct bcm43xx_coreinfo {
 635         u8 available:1,
 636            enabled:1,
 637            initialized:1;
 638         /** core_rev revision number */
 639         u8 rev;
 640         /** Index number for _switch_core() */
 641         u8 index;
 642         /** core_id ID number */
 643         u16 id;
 644         /** Core-specific data. */
 645         void *priv;
 646 };
 647
 648 /* Additional information for each 80211 core. */
 649 struct bcm43xx_coreinfo_80211 {
 650         /* PHY device. */
 651         struct bcm43xx_phyinfo phy;
 652         /* Radio device. */
 653         struct bcm43xx_radioinfo radio;
 654         union {
 655                 /* DMA context. */
 656                 struct bcm43xx_dma dma;
 657                 /* PIO context. */
 658                 struct bcm43xx_pio pio;
 659         };
 660 };
 661
 662 /* Context information for a noise calculation (Link Quality). */
 663 struct bcm43xx_noise_calculation {
 664         struct bcm43xx_coreinfo *core_at_start;
 665         u8 channel_at_start;
 666         u8 calculation_running:1;
 667         u8 nr_samples;
 668         s8 samples[8][4];
 669 };
 670
 671 struct bcm43xx_stats {
 672         u8 noise;
 673         struct iw_statistics wstats;
 674         /* Store the last TX/RX times here for updating the leds. */
 675         unsigned long last_tx;
 676         unsigned long last_rx;
 677 };
 678
 679 struct bcm43xx_key {
 680         u8 enabled:1;
 681         u8 algorithm;
 682 };
 683
 684 /* Driver initialization status. */
 685 enum {
 686         BCM43xx_STAT_UNINIT,            /* Uninitialized. */
 687         BCM43xx_STAT_INITIALIZING,      /* init_board() in progress. */
 688         BCM43xx_STAT_INITIALIZED,       /* Fully operational. */
 689         BCM43xx_STAT_SHUTTINGDOWN,      /* free_board() in progress. */
 690         BCM43xx_STAT_RESTARTING,        /* controller_restart() called. */
 691 };
 692 #define bcm43xx_status(bcm)             atomic_read(&(bcm)->init_status)
 693 #define bcm43xx_set_status(bcm, stat)   do {                    \
 694                 atomic_set(&(bcm)->init_status, (stat));        \
 695                 smp_wmb();                                      \
 696                                         } while (0)
 697
 698 /*    *** THEORY OF LOCKING ***
 699  *
 700  * We have two different locks in the bcm43xx driver.
 701  * => bcm->mutex:    General sleeping mutex. Protects struct bcm43xx_private
 702  *                   and the device registers. This mutex does _not_ protect
 703  *                   against concurrency from the IRQ handler.
 704  * => bcm->irq_lock: IRQ spinlock. Protects against IRQ handler concurrency.
 705  *
 706  * Please note that, if you only take the irq_lock, you are not protected
 707  * against concurrency from the periodic work handlers.
 708  * Most times you want to take _both_ locks.
 709  */
 710
 711 struct bcm43xx_private {
 712         struct ieee80211_device *ieee;
 713         struct ieee80211softmac_device *softmac;
 714
 715         struct net_device *net_dev;
 716         struct pci_dev *pci_dev;
 717         unsigned int irq;
 718
 719         void __iomem *mmio_addr;
 720
 721         spinlock_t irq_lock;
 722         struct mutex mutex;
 723
 724         /* Driver initialization status BCM43xx_STAT_*** */
 725         atomic_t init_status;
 726
 727         u16 was_initialized:1,          /* for PCI suspend/resume. */
 728             __using_pio:1,              /* Internal, use bcm43xx_using_pio(). */
 729             bad_frames_preempt:1,       /* Use "Bad Frames Preemption" (default off) */
 730             reg124_set_0x4:1,           /* Some variable to keep track of IRQ stuff. */
 731             short_preamble:1,           /* TRUE, if short preamble is enabled. */
 732             firmware_norelease:1;       /* Do not release the firmware. Used on suspend. */
 733
 734         struct bcm43xx_stats stats;
 735
 736         /* Bus type we are connected to.
 737          * This is currently always BCM43xx_BUSTYPE_PCI
 738          */
 739         u8 bustype;
 740
 741         u16 board_vendor;
 742         u16 board_type;
 743         u16 board_revision;
 744
 745         u16 chip_id;
 746         u8 chip_rev;
 747         u8 chip_package;
 748
 749         struct bcm43xx_sprominfo sprom;
 750 #define BCM43xx_NR_LEDS         4
 751         struct bcm43xx_led leds[BCM43xx_NR_LEDS];
 752         spinlock_t leds_lock;
 753
 754         /* The currently active core. */
 755         struct bcm43xx_coreinfo *current_core;
 756 #ifdef CONFIG_BCM947XX
 757         /** current core memory offset */
 758         u32 current_core_offset;
 759 #endif
 760         struct bcm43xx_coreinfo *active_80211_core;
 761         /* coreinfo structs for all possible cores follow.
 762          * Note that a core might not exist.
 763          * So check the coreinfo flags before using it.
 764          */
 765         struct bcm43xx_coreinfo core_chipcommon;
 766         struct bcm43xx_coreinfo core_pci;
 767         struct bcm43xx_coreinfo core_80211[ BCM43xx_MAX_80211_CORES ];
 768         /* Additional information, specific to the 80211 cores. */
 769         struct bcm43xx_coreinfo_80211 core_80211_ext[ BCM43xx_MAX_80211_CORES ];
 770         /* Number of available 80211 cores. */
 771         int nr_80211_available;
 772
 773         u32 chipcommon_capabilities;
 774
 775         /* Reason code of the last interrupt. */
 776         u32 irq_reason;
 777         u32 dma_reason[6];
 778         /* saved irq enable/disable state bitfield. */
 779         u32 irq_savedstate;
 780         /* Link Quality calculation context. */
 781         struct bcm43xx_noise_calculation noisecalc;
 782         /* if > 0 MAC is suspended. if == 0 MAC is enabled. */
 783         int mac_suspended;
 784
 785         /* Threshold values. */
 786         //TODO: The RTS thr has to be _used_. Currently, it is only set via WX.
 787         u32 rts_threshold;
 788
 789         /* Interrupt Service Routine tasklet (bottom-half) */
 790         struct tasklet_struct isr_tasklet;
 791
 792         /* Periodic tasks */
 793         struct work_struct periodic_work;
 794         unsigned int periodic_state;
 795
 796         struct work_struct restart_work;
 797
 798         /* Informational stuff. */
 799         char nick[IW_ESSID_MAX_SIZE + 1];
 800
 801         /* encryption/decryption */
 802         u16 security_offset;
 803         struct bcm43xx_key key[54];
 804         u8 default_key_idx;
 805
 806         /* Random Number Generator. */
 807         struct hwrng rng;
 808         char rng_name[20 + 1];
 809
 810         /* Debugging stuff follows. */
 811 #ifdef CONFIG_BCM43XX_DEBUG
 812         struct bcm43xx_dfsentry *dfsentry;
 813 #endif
 814 };
 815
 816
 817 static inline
 818 struct bcm43xx_private * bcm43xx_priv(struct net_device *dev)
 819 {
 820         return ieee80211softmac_priv(dev);
 821 }
 822
 823 struct device;
 824
 825 static inline
 826 struct bcm43xx_private * dev_to_bcm(struct device *dev)
 827 {
 828         struct net_device *net_dev;
 829         struct bcm43xx_private *bcm;
 830
 831         net_dev = dev_get_drvdata(dev);
 832         bcm = bcm43xx_priv(net_dev);
 833
 834         return bcm;
 835 }
 836
 837
 838 /* Helper function, which returns a boolean.
 839  * TRUE, if PIO is used; FALSE, if DMA is used.
 840  */
 841 #if defined(CONFIG_BCM43XX_DMA) && defined(CONFIG_BCM43XX_PIO)
 842 static inline
 843 int bcm43xx_using_pio(struct bcm43xx_private *bcm)
 844 {
 845         return bcm->__using_pio;
 846 }
 847 #elif defined(CONFIG_BCM43XX_DMA)
 848 static inline
 849 int bcm43xx_using_pio(struct bcm43xx_private *bcm)
 850 {
 851         return 0;
 852 }
 853 #elif defined(CONFIG_BCM43XX_PIO)
 854 static inline
 855 int bcm43xx_using_pio(struct bcm43xx_private *bcm)
 856 {
 857         return 1;
 858 }
 859 #else
 860 # error "Using neither DMA nor PIO? Confused..."
 861 #endif
 862
 863 /* Helper functions to access data structures private to the 80211 cores.
 864  * Note that we _must_ have an 80211 core mapped when calling
 865  * any of these functions.
 866  */
 867 static inline
 868 struct bcm43xx_coreinfo_80211 *
 869 bcm43xx_current_80211_priv(struct bcm43xx_private *bcm)
 870 {
 871         assert(bcm->current_core->id == BCM43xx_COREID_80211);
 872         return bcm->current_core->priv;
 873 }
 874 static inline
 875 struct bcm43xx_pio * bcm43xx_current_pio(struct bcm43xx_private *bcm)
 876 {
 877         assert(bcm43xx_using_pio(bcm));
 878         return &(bcm43xx_current_80211_priv(bcm)->pio);
 879 }
 880 static inline
 881 struct bcm43xx_dma * bcm43xx_current_dma(struct bcm43xx_private *bcm)
 882 {
 883         assert(!bcm43xx_using_pio(bcm));
 884         return &(bcm43xx_current_80211_priv(bcm)->dma);
 885 }
 886 static inline
 887 struct bcm43xx_phyinfo * bcm43xx_current_phy(struct bcm43xx_private *bcm)
 888 {
 889         return &(bcm43xx_current_80211_priv(bcm)->phy);
 890 }
 891 static inline
 892 struct bcm43xx_radioinfo * bcm43xx_current_radio(struct bcm43xx_private *bcm)
 893 {
 894         return &(bcm43xx_current_80211_priv(bcm)->radio);
 895 }
 896
 897
 898 static inline
 899 struct bcm43xx_lopair * bcm43xx_get_lopair(struct bcm43xx_phyinfo *phy,
 900                                            u16 radio_attenuation,
 901                                            u16 baseband_attenuation)
 902 {
 903         return phy->_lo_pairs + (radio_attenuation + 14 * (baseband_attenuation / 2));
 904 }
 905
 906
 907 static inline
 908 u16 bcm43xx_read16(struct bcm43xx_private *bcm, u16 offset)
 909 {
 910         return ioread16(bcm->mmio_addr + core_offset(bcm) + offset);
 911 }
 912
 913 static inline
 914 void bcm43xx_write16(struct bcm43xx_private *bcm, u16 offset, u16 value)
 915 {
 916         iowrite16(value, bcm->mmio_addr + core_offset(bcm) + offset);
 917 }
 918
 919 static inline
 920 u32 bcm43xx_read32(struct bcm43xx_private *bcm, u16 offset)
 921 {
 922         return ioread32(bcm->mmio_addr + core_offset(bcm) + offset);
 923 }
 924
 925 static inline
 926 void bcm43xx_write32(struct bcm43xx_private *bcm, u16 offset, u32 value)
 927 {
 928         iowrite32(value, bcm->mmio_addr + core_offset(bcm) + offset);
 929 }
 930
 931 static inline
 932 int bcm43xx_pci_read_config16(struct bcm43xx_private *bcm, int offset, u16 *value)
 933 {
 934         return pci_read_config_word(bcm->pci_dev, offset, value);
 935 }
 936
 937 static inline
 938 int bcm43xx_pci_read_config32(struct bcm43xx_private *bcm, int offset, u32 *value)
 939 {
 940         return pci_read_config_dword(bcm->pci_dev, offset, value);
 941 }
 942
 943 static inline
 944 int bcm43xx_pci_write_config16(struct bcm43xx_private *bcm, int offset, u16 value)
 945 {
 946         return pci_write_config_word(bcm->pci_dev, offset, value);
 947 }
 948
 949 static inline
 950 int bcm43xx_pci_write_config32(struct bcm43xx_private *bcm, int offset, u32 value)
 951 {
 952         return pci_write_config_dword(bcm->pci_dev, offset, value);
 953 }
 954
 955 /** Limit a value between two limits */
 956 #ifdef limit_value
 957 # undef limit_value
 958 #endif
 959 #define limit_value(value, min, max)  \
 960         ({                                              \
 961                 typeof(value) __value = (value);        \
 962                 typeof(value) __min = (min);            \
 963                 typeof(value) __max = (max);            \
 964                 if (__value < __min)                    \
 965                         __value = __min;                \
 966                 else if (__value > __max)               \
 967                         __value = __max;                \
 968                 __value;                                \
 969         })
 970
 971 /** Helpers to print MAC addresses. */
 972 #define BCM43xx_MACFMT          "%02x:%02x:%02x:%02x:%02x:%02x"
 973 #define BCM43xx_MACARG(x)       ((u8*)(x))[0], ((u8*)(x))[1], \
 974                                 ((u8*)(x))[2], ((u8*)(x))[3], \
 975                                 ((u8*)(x))[4], ((u8*)(x))[5]
 976
 977 #endif /* BCM43xx_H_ */