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 /* MicrocodeFlagsBitfield (addr + lo-word values?)*/
 310 #define BCM43xx_UCODEFLAGS_OFFSET       0x005E
 311
 312 #define BCM43xx_UCODEFLAG_AUTODIV       0x0001
 313 #define BCM43xx_UCODEFLAG_UNKBGPHY      0x0002
 314 #define BCM43xx_UCODEFLAG_UNKBPHY       0x0004
 315 #define BCM43xx_UCODEFLAG_UNKGPHY       0x0020
 316 #define BCM43xx_UCODEFLAG_UNKPACTRL     0x0040
 317 #define BCM43xx_UCODEFLAG_JAPAN         0x0080
 318
 319 /* Generic-Interrupt reasons. */
 320 #define BCM43xx_IRQ_READY               (1 << 0)
 321 #define BCM43xx_IRQ_BEACON              (1 << 1)
 322 #define BCM43xx_IRQ_PS                  (1 << 2)
 323 #define BCM43xx_IRQ_REG124              (1 << 5)
 324 #define BCM43xx_IRQ_PMQ                 (1 << 6)
 325 #define BCM43xx_IRQ_PIO_WORKAROUND      (1 << 8)
 326 #define BCM43xx_IRQ_XMIT_ERROR          (1 << 11)
 327 #define BCM43xx_IRQ_RX                  (1 << 15)
 328 #define BCM43xx_IRQ_SCAN                (1 << 16)
 329 #define BCM43xx_IRQ_NOISE               (1 << 18)
 330 #define BCM43xx_IRQ_XMIT_STATUS         (1 << 29)
 331
 332 #define BCM43xx_IRQ_ALL                 0xffffffff
 333 #define BCM43xx_IRQ_INITIAL             (BCM43xx_IRQ_PS |               \
 334                                          BCM43xx_IRQ_REG124 |           \
 335                                          BCM43xx_IRQ_PMQ |              \
 336                                          BCM43xx_IRQ_XMIT_ERROR |       \
 337                                          BCM43xx_IRQ_RX |               \
 338                                          BCM43xx_IRQ_SCAN |             \
 339                                          BCM43xx_IRQ_NOISE |            \
 340                                          BCM43xx_IRQ_XMIT_STATUS)
 341
 342
 343 /* Initial default iw_mode */
 344 #define BCM43xx_INITIAL_IWMODE                  IW_MODE_INFRA
 345
 346 /* Bus type PCI. */
 347 #define BCM43xx_BUSTYPE_PCI     0
 348 /* Bus type Silicone Backplane Bus. */
 349 #define BCM43xx_BUSTYPE_SB      1
 350 /* Bus type PCMCIA. */
 351 #define BCM43xx_BUSTYPE_PCMCIA  2
 352
 353 /* Threshold values. */
 354 #define BCM43xx_MIN_RTS_THRESHOLD               1U
 355 #define BCM43xx_MAX_RTS_THRESHOLD               2304U
 356 #define BCM43xx_DEFAULT_RTS_THRESHOLD           BCM43xx_MAX_RTS_THRESHOLD
 357
 358 #define BCM43xx_DEFAULT_SHORT_RETRY_LIMIT       7
 359 #define BCM43xx_DEFAULT_LONG_RETRY_LIMIT        4
 360
 361 /* Max size of a security key */
 362 #define BCM43xx_SEC_KEYSIZE                     16
 363 /* Security algorithms. */
 364 enum {
 365         BCM43xx_SEC_ALGO_NONE = 0, /* unencrypted, as of TX header. */
 366         BCM43xx_SEC_ALGO_WEP,
 367         BCM43xx_SEC_ALGO_UNKNOWN,
 368         BCM43xx_SEC_ALGO_AES,
 369         BCM43xx_SEC_ALGO_WEP104,
 370         BCM43xx_SEC_ALGO_TKIP,
 371 };
 372
 373 #ifdef assert
 374 # undef assert
 375 #endif
 376 #ifdef CONFIG_BCM43XX_DEBUG
 377 #define assert(expr) \
 378         do {                                                                    \
 379                 if (unlikely(!(expr))) {                                        \
 380                 printk(KERN_ERR PFX "ASSERTION FAILED (%s) at: %s:%d:%s()\n",   \
 381                         #expr, __FILE__, __LINE__, __FUNCTION__);               \
 382                 }                                                               \
 383         } while (0)
 384 #else
 385 #define assert(expr)    do { /* nothing */ } while (0)
 386 #endif
 387
 388 /* rate limited printk(). */
 389 #ifdef printkl
 390 # undef printkl
 391 #endif
 392 #define printkl(f, x...)  do { if (printk_ratelimit()) printk(f ,##x); } while (0)
 393 /* rate limited printk() for debugging */
 394 #ifdef dprintkl
 395 # undef dprintkl
 396 #endif
 397 #ifdef CONFIG_BCM43XX_DEBUG
 398 # define dprintkl               printkl
 399 #else
 400 # define dprintkl(f, x...)      do { /* nothing */ } while (0)
 401 #endif
 402
 403 /* Helper macro for if branches.
 404  * An if branch marked with this macro is only taken in DEBUG mode.
 405  * Example:
 406  *      if (DEBUG_ONLY(foo == bar)) {
 407  *              do something
 408  *      }
 409  *      In DEBUG mode, the branch will be taken if (foo == bar).
 410  *      In non-DEBUG mode, the branch will never be taken.
 411  */
 412 #ifdef DEBUG_ONLY
 413 # undef DEBUG_ONLY
 414 #endif
 415 #ifdef CONFIG_BCM43XX_DEBUG
 416 # define DEBUG_ONLY(x)  (x)
 417 #else
 418 # define DEBUG_ONLY(x)  0
 419 #endif
 420
 421 /* debugging printk() */
 422 #ifdef dprintk
 423 # undef dprintk
 424 #endif
 425 #ifdef CONFIG_BCM43XX_DEBUG
 426 # define dprintk(f, x...)  do { printk(f ,##x); } while (0)
 427 #else
 428 # define dprintk(f, x...)  do { /* nothing */ } while (0)
 429 #endif
 430
 431
 432 struct net_device;
 433 struct pci_dev;
 434 struct bcm43xx_dmaring;
 435 struct bcm43xx_pioqueue;
 436
 437 struct bcm43xx_initval {
 438         u16 offset;
 439         u16 size;
 440         u32 value;
 441 } __attribute__((__packed__));
 442
 443 /* Values for bcm430x_sprominfo.locale */
 444 enum {
 445         BCM43xx_LOCALE_WORLD = 0,
 446         BCM43xx_LOCALE_THAILAND,
 447         BCM43xx_LOCALE_ISRAEL,
 448         BCM43xx_LOCALE_JORDAN,
 449         BCM43xx_LOCALE_CHINA,
 450         BCM43xx_LOCALE_JAPAN,
 451         BCM43xx_LOCALE_USA_CANADA_ANZ,
 452         BCM43xx_LOCALE_EUROPE,
 453         BCM43xx_LOCALE_USA_LOW,
 454         BCM43xx_LOCALE_JAPAN_HIGH,
 455         BCM43xx_LOCALE_ALL,
 456         BCM43xx_LOCALE_NONE,
 457 };
 458
 459 #define BCM43xx_SPROM_SIZE      64 /* in 16-bit words. */
 460 struct bcm43xx_sprominfo {
 461         u16 boardflags2;
 462         u8 il0macaddr[6];
 463         u8 et0macaddr[6];
 464         u8 et1macaddr[6];
 465         u8 et0phyaddr:5;
 466         u8 et1phyaddr:5;
 467         u8 et0mdcport:1;
 468         u8 et1mdcport:1;
 469         u8 boardrev;
 470         u8 locale:4;
 471         u8 antennas_aphy:2;
 472         u8 antennas_bgphy:2;
 473         u16 pa0b0;
 474         u16 pa0b1;
 475         u16 pa0b2;
 476         u8 wl0gpio0;
 477         u8 wl0gpio1;
 478         u8 wl0gpio2;
 479         u8 wl0gpio3;
 480         u8 maxpower_aphy;
 481         u8 maxpower_bgphy;
 482         u16 pa1b0;
 483         u16 pa1b1;
 484         u16 pa1b2;
 485         u8 idle_tssi_tgt_aphy;
 486         u8 idle_tssi_tgt_bgphy;
 487         u16 boardflags;
 488         u16 antennagain_aphy;
 489         u16 antennagain_bgphy;
 490 };
 491
 492 /* Value pair to measure the LocalOscillator. */
 493 struct bcm43xx_lopair {
 494         s8 low;
 495         s8 high;
 496         u8 used:1;
 497 };
 498 #define BCM43xx_LO_COUNT        (14*4)
 499
 500 struct bcm43xx_phyinfo {
 501         /* Hardware Data */
 502         u8 version;
 503         u8 type;
 504         u8 rev;
 505         u16 antenna_diversity;
 506         u16 savedpctlreg;
 507         u16 minlowsig[2];
 508         u16 minlowsigpos[2];
 509         u8 connected:1,
 510            calibrated:1,
 511            is_locked:1, /* used in bcm43xx_phy_{un}lock() */
 512            dyn_tssi_tbl:1; /* used in bcm43xx_phy_init_tssi2dbm_table() */
 513         /* LO Measurement Data.
 514          * Use bcm43xx_get_lopair() to get a value.
 515          */
 516         struct bcm43xx_lopair *_lo_pairs;
 517
 518         /* TSSI to dBm table in use */
 519         const s8 *tssi2dbm;
 520         /* idle TSSI value */
 521         s8 idle_tssi;
 522
 523         /* Values from bcm43xx_calc_loopback_gain() */
 524         u16 loopback_gain[2];
 525
 526         /* PHY lock for core.rev < 3
 527          * This lock is only used by bcm43xx_phy_{un}lock()
 528          */
 529         spinlock_t lock;
 530
 531         /* Firmware. */
 532         const struct firmware *ucode;
 533         const struct firmware *pcm;
 534         const struct firmware *initvals0;
 535         const struct firmware *initvals1;
 536 };
 537
 538
 539 struct bcm43xx_radioinfo {
 540         u16 manufact;
 541         u16 version;
 542         u8 revision;
 543
 544         /* Desired TX power in dBm Q5.2 */
 545         u16 txpower_desired;
 546         /* TX Power control values. */
 547         union {
 548                 /* B/G PHY */
 549                 struct {
 550                         u16 baseband_atten;
 551                         u16 radio_atten;
 552                         u16 txctl1;
 553                         u16 txctl2;
 554                 };
 555                 /* A PHY */
 556                 struct {
 557                         u16 txpwr_offset;
 558                 };
 559         };
 560
 561         /* Current Interference Mitigation mode */
 562         int interfmode;
 563         /* Stack of saved values from the Interference Mitigation code.
 564          * Each value in the stack is layed out as follows:
 565          * bit 0-11:  offset
 566          * bit 12-15: register ID
 567          * bit 16-32: value
 568          * register ID is: 0x1 PHY, 0x2 Radio, 0x3 ILT
 569          */
 570 #define BCM43xx_INTERFSTACK_SIZE        26
 571         u32 interfstack[BCM43xx_INTERFSTACK_SIZE];
 572
 573         /* Saved values from the NRSSI Slope calculation */
 574         s16 nrssi[2];
 575         s32 nrssislope;
 576         /* In memory nrssi lookup table. */
 577         s8 nrssi_lt[64];
 578
 579         /* current channel */
 580         u8 channel;
 581         u8 initial_channel;
 582
 583         u16 lofcal;
 584
 585         u16 initval;
 586
 587         u8 enabled:1;
 588         /* ACI (adjacent channel interference) flags. */
 589         u8 aci_enable:1,
 590            aci_wlan_automatic:1,
 591            aci_hw_rssi:1;
 592 };
 593
 594 /* Data structures for DMA transmission, per 80211 core. */
 595 struct bcm43xx_dma {
 596         struct bcm43xx_dmaring *tx_ring0;
 597         struct bcm43xx_dmaring *tx_ring1;
 598         struct bcm43xx_dmaring *tx_ring2;
 599         struct bcm43xx_dmaring *tx_ring3;
 600         struct bcm43xx_dmaring *tx_ring4;
 601         struct bcm43xx_dmaring *tx_ring5;
 602
 603         struct bcm43xx_dmaring *rx_ring0;
 604         struct bcm43xx_dmaring *rx_ring3; /* only available on core.rev < 5 */
 605 };
 606
 607 /* Data structures for PIO transmission, per 80211 core. */
 608 struct bcm43xx_pio {
 609         struct bcm43xx_pioqueue *queue0;
 610         struct bcm43xx_pioqueue *queue1;
 611         struct bcm43xx_pioqueue *queue2;
 612         struct bcm43xx_pioqueue *queue3;
 613 };
 614
 615 #define BCM43xx_MAX_80211_CORES         2
 616
 617 #ifdef CONFIG_BCM947XX
 618 #define core_offset(bcm) (bcm)->current_core_offset
 619 #else
 620 #define core_offset(bcm) 0
 621 #endif
 622
 623 /* Generic information about a core. */
 624 struct bcm43xx_coreinfo {
 625         u8 available:1,
 626            enabled:1,
 627            initialized:1;
 628         /** core_rev revision number */
 629         u8 rev;
 630         /** Index number for _switch_core() */
 631         u8 index;
 632         /** core_id ID number */
 633         u16 id;
 634         /** Core-specific data. */
 635         void *priv;
 636 };
 637
 638 /* Additional information for each 80211 core. */
 639 struct bcm43xx_coreinfo_80211 {
 640         /* PHY device. */
 641         struct bcm43xx_phyinfo phy;
 642         /* Radio device. */
 643         struct bcm43xx_radioinfo radio;
 644         union {
 645                 /* DMA context. */
 646                 struct bcm43xx_dma dma;
 647                 /* PIO context. */
 648                 struct bcm43xx_pio pio;
 649         };
 650 };
 651
 652 /* Context information for a noise calculation (Link Quality). */
 653 struct bcm43xx_noise_calculation {
 654         struct bcm43xx_coreinfo *core_at_start;
 655         u8 channel_at_start;
 656         u8 calculation_running:1;
 657         u8 nr_samples;
 658         s8 samples[8][4];
 659 };
 660
 661 struct bcm43xx_stats {
 662         u8 link_quality;
 663         u8 noise;
 664         struct iw_statistics wstats;
 665         /* Store the last TX/RX times here for updating the leds. */
 666         unsigned long last_tx;
 667         unsigned long last_rx;
 668 };
 669
 670 struct bcm43xx_key {
 671         u8 enabled:1;
 672         u8 algorithm;
 673 };
 674
 675 /* Driver initialization status. */
 676 enum {
 677         BCM43xx_STAT_UNINIT,            /* Uninitialized. */
 678         BCM43xx_STAT_INITIALIZING,      /* init_board() in progress. */
 679         BCM43xx_STAT_INITIALIZED,       /* Fully operational. */
 680         BCM43xx_STAT_SHUTTINGDOWN,      /* free_board() in progress. */
 681         BCM43xx_STAT_RESTARTING,        /* controller_restart() called. */
 682 };
 683 #define bcm43xx_status(bcm)             atomic_read(&(bcm)->init_status)
 684 #define bcm43xx_set_status(bcm, stat)   do {                    \
 685                 atomic_set(&(bcm)->init_status, (stat));        \
 686                 smp_wmb();                                      \
 687                                         } while (0)
 688
 689 /*    *** THEORY OF LOCKING ***
 690  *
 691  * We have two different locks in the bcm43xx driver.
 692  * => bcm->mutex:    General sleeping mutex. Protects struct bcm43xx_private
 693  *                   and the device registers. This mutex does _not_ protect
 694  *                   against concurrency from the IRQ handler.
 695  * => bcm->irq_lock: IRQ spinlock. Protects against IRQ handler concurrency.
 696  *
 697  * Please note that, if you only take the irq_lock, you are not protected
 698  * against concurrency from the periodic work handlers.
 699  * Most times you want to take _both_ locks.
 700  */
 701
 702 struct bcm43xx_private {
 703         struct ieee80211_device *ieee;
 704         struct ieee80211softmac_device *softmac;
 705
 706         struct net_device *net_dev;
 707         struct pci_dev *pci_dev;
 708         unsigned int irq;
 709
 710         void __iomem *mmio_addr;
 711
 712         spinlock_t irq_lock;
 713         struct mutex mutex;
 714
 715         /* Driver initialization status BCM43xx_STAT_*** */
 716         atomic_t init_status;
 717
 718         u16 was_initialized:1,          /* for PCI suspend/resume. */
 719             __using_pio:1,              /* Internal, use bcm43xx_using_pio(). */
 720             bad_frames_preempt:1,       /* Use "Bad Frames Preemption" (default off) */
 721             reg124_set_0x4:1,           /* Some variable to keep track of IRQ stuff. */
 722             short_preamble:1,           /* TRUE, if short preamble is enabled. */
 723             firmware_norelease:1;       /* Do not release the firmware. Used on suspend. */
 724
 725         struct bcm43xx_stats stats;
 726
 727         /* Bus type we are connected to.
 728          * This is currently always BCM43xx_BUSTYPE_PCI
 729          */
 730         u8 bustype;
 731
 732         u16 board_vendor;
 733         u16 board_type;
 734         u16 board_revision;
 735
 736         u16 chip_id;
 737         u8 chip_rev;
 738         u8 chip_package;
 739
 740         struct bcm43xx_sprominfo sprom;
 741 #define BCM43xx_NR_LEDS         4
 742         struct bcm43xx_led leds[BCM43xx_NR_LEDS];
 743         spinlock_t leds_lock;
 744
 745         /* The currently active core. */
 746         struct bcm43xx_coreinfo *current_core;
 747 #ifdef CONFIG_BCM947XX
 748         /** current core memory offset */
 749         u32 current_core_offset;
 750 #endif
 751         struct bcm43xx_coreinfo *active_80211_core;
 752         /* coreinfo structs for all possible cores follow.
 753          * Note that a core might not exist.
 754          * So check the coreinfo flags before using it.
 755          */
 756         struct bcm43xx_coreinfo core_chipcommon;
 757         struct bcm43xx_coreinfo core_pci;
 758         struct bcm43xx_coreinfo core_80211[ BCM43xx_MAX_80211_CORES ];
 759         /* Additional information, specific to the 80211 cores. */
 760         struct bcm43xx_coreinfo_80211 core_80211_ext[ BCM43xx_MAX_80211_CORES ];
 761         /* Number of available 80211 cores. */
 762         int nr_80211_available;
 763
 764         u32 chipcommon_capabilities;
 765
 766         /* Reason code of the last interrupt. */
 767         u32 irq_reason;
 768         u32 dma_reason[6];
 769         /* saved irq enable/disable state bitfield. */
 770         u32 irq_savedstate;
 771         /* Link Quality calculation context. */
 772         struct bcm43xx_noise_calculation noisecalc;
 773         /* if > 0 MAC is suspended. if == 0 MAC is enabled. */
 774         int mac_suspended;
 775
 776         /* Threshold values. */
 777         //TODO: The RTS thr has to be _used_. Currently, it is only set via WX.
 778         u32 rts_threshold;
 779
 780         /* Interrupt Service Routine tasklet (bottom-half) */
 781         struct tasklet_struct isr_tasklet;
 782
 783         /* Periodic tasks */
 784         struct work_struct periodic_work;
 785         unsigned int periodic_state;
 786
 787         struct work_struct restart_work;
 788
 789         /* Informational stuff. */
 790         char nick[IW_ESSID_MAX_SIZE + 1];
 791
 792         /* encryption/decryption */
 793         u16 security_offset;
 794         struct bcm43xx_key key[54];
 795         u8 default_key_idx;
 796
 797         /* Random Number Generator. */
 798         struct hwrng rng;
 799         char rng_name[20 + 1];
 800
 801         /* Debugging stuff follows. */
 802 #ifdef CONFIG_BCM43XX_DEBUG
 803         struct bcm43xx_dfsentry *dfsentry;
 804 #endif
 805 };
 806
 807
 808 static inline
 809 struct bcm43xx_private * bcm43xx_priv(struct net_device *dev)
 810 {
 811         return ieee80211softmac_priv(dev);
 812 }
 813
 814 struct device;
 815
 816 static inline
 817 struct bcm43xx_private * dev_to_bcm(struct device *dev)
 818 {
 819         struct net_device *net_dev;
 820         struct bcm43xx_private *bcm;
 821
 822         net_dev = dev_get_drvdata(dev);
 823         bcm = bcm43xx_priv(net_dev);
 824
 825         return bcm;
 826 }
 827
 828
 829 /* Helper function, which returns a boolean.
 830  * TRUE, if PIO is used; FALSE, if DMA is used.
 831  */
 832 #if defined(CONFIG_BCM43XX_DMA) && defined(CONFIG_BCM43XX_PIO)
 833 static inline
 834 int bcm43xx_using_pio(struct bcm43xx_private *bcm)
 835 {
 836         return bcm->__using_pio;
 837 }
 838 #elif defined(CONFIG_BCM43XX_DMA)
 839 static inline
 840 int bcm43xx_using_pio(struct bcm43xx_private *bcm)
 841 {
 842         return 0;
 843 }
 844 #elif defined(CONFIG_BCM43XX_PIO)
 845 static inline
 846 int bcm43xx_using_pio(struct bcm43xx_private *bcm)
 847 {
 848         return 1;
 849 }
 850 #else
 851 # error "Using neither DMA nor PIO? Confused..."
 852 #endif
 853
 854 /* Helper functions to access data structures private to the 80211 cores.
 855  * Note that we _must_ have an 80211 core mapped when calling
 856  * any of these functions.
 857  */
 858 static inline
 859 struct bcm43xx_coreinfo_80211 *
 860 bcm43xx_current_80211_priv(struct bcm43xx_private *bcm)
 861 {
 862         assert(bcm->current_core->id == BCM43xx_COREID_80211);
 863         return bcm->current_core->priv;
 864 }
 865 static inline
 866 struct bcm43xx_pio * bcm43xx_current_pio(struct bcm43xx_private *bcm)
 867 {
 868         assert(bcm43xx_using_pio(bcm));
 869         return &(bcm43xx_current_80211_priv(bcm)->pio);
 870 }
 871 static inline
 872 struct bcm43xx_dma * bcm43xx_current_dma(struct bcm43xx_private *bcm)
 873 {
 874         assert(!bcm43xx_using_pio(bcm));
 875         return &(bcm43xx_current_80211_priv(bcm)->dma);
 876 }
 877 static inline
 878 struct bcm43xx_phyinfo * bcm43xx_current_phy(struct bcm43xx_private *bcm)
 879 {
 880         return &(bcm43xx_current_80211_priv(bcm)->phy);
 881 }
 882 static inline
 883 struct bcm43xx_radioinfo * bcm43xx_current_radio(struct bcm43xx_private *bcm)
 884 {
 885         return &(bcm43xx_current_80211_priv(bcm)->radio);
 886 }
 887
 888
 889 static inline
 890 struct bcm43xx_lopair * bcm43xx_get_lopair(struct bcm43xx_phyinfo *phy,
 891                                            u16 radio_attenuation,
 892                                            u16 baseband_attenuation)
 893 {
 894         return phy->_lo_pairs + (radio_attenuation + 14 * (baseband_attenuation / 2));
 895 }
 896
 897
 898 static inline
 899 u16 bcm43xx_read16(struct bcm43xx_private *bcm, u16 offset)
 900 {
 901         return ioread16(bcm->mmio_addr + core_offset(bcm) + offset);
 902 }
 903
 904 static inline
 905 void bcm43xx_write16(struct bcm43xx_private *bcm, u16 offset, u16 value)
 906 {
 907         iowrite16(value, bcm->mmio_addr + core_offset(bcm) + offset);
 908 }
 909
 910 static inline
 911 u32 bcm43xx_read32(struct bcm43xx_private *bcm, u16 offset)
 912 {
 913         return ioread32(bcm->mmio_addr + core_offset(bcm) + offset);
 914 }
 915
 916 static inline
 917 void bcm43xx_write32(struct bcm43xx_private *bcm, u16 offset, u32 value)
 918 {
 919         iowrite32(value, bcm->mmio_addr + core_offset(bcm) + offset);
 920 }
 921
 922 static inline
 923 int bcm43xx_pci_read_config16(struct bcm43xx_private *bcm, int offset, u16 *value)
 924 {
 925         return pci_read_config_word(bcm->pci_dev, offset, value);
 926 }
 927
 928 static inline
 929 int bcm43xx_pci_read_config32(struct bcm43xx_private *bcm, int offset, u32 *value)
 930 {
 931         return pci_read_config_dword(bcm->pci_dev, offset, value);
 932 }
 933
 934 static inline
 935 int bcm43xx_pci_write_config16(struct bcm43xx_private *bcm, int offset, u16 value)
 936 {
 937         return pci_write_config_word(bcm->pci_dev, offset, value);
 938 }
 939
 940 static inline
 941 int bcm43xx_pci_write_config32(struct bcm43xx_private *bcm, int offset, u32 value)
 942 {
 943         return pci_write_config_dword(bcm->pci_dev, offset, value);
 944 }
 945
 946 /** Limit a value between two limits */
 947 #ifdef limit_value
 948 # undef limit_value
 949 #endif
 950 #define limit_value(value, min, max)  \
 951         ({                                              \
 952                 typeof(value) __value = (value);        \
 953                 typeof(value) __min = (min);            \
 954                 typeof(value) __max = (max);            \
 955                 if (__value < __min)                    \
 956                         __value = __min;                \
 957                 else if (__value > __max)               \
 958                         __value = __max;                \
 959                 __value;                                \
 960         })
 961
 962 /** Helpers to print MAC addresses. */
 963 #define BCM43xx_MACFMT          "%02x:%02x:%02x:%02x:%02x:%02x"
 964 #define BCM43xx_MACARG(x)       ((u8*)(x))[0], ((u8*)(x))[1], \
 965                                 ((u8*)(x))[2], ((u8*)(x))[3], \
 966                                 ((u8*)(x))[4], ((u8*)(x))[5]
 967
 968 #endif /* BCM43xx_H_ */