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     100
  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_CTL                  0x28
 163 #define BCM43xx_CHIPCOMMON_PLLONDELAY           0xB0
 164 #define BCM43xx_CHIPCOMMON_FREFSELDELAY         0xB4
 165 #define BCM43xx_CHIPCOMMON_SLOWCLKCTL           0xB8
 166 #define BCM43xx_CHIPCOMMON_SYSCLKCTL            0xC0
 167
 168 /* PCI core specific registers. */
 169 #define BCM43xx_PCICORE_BCAST_ADDR      0x50
 170 #define BCM43xx_PCICORE_BCAST_DATA      0x54
 171 #define BCM43xx_PCICORE_SBTOPCI2        0x108
 172
 173 /* SBTOPCI2 values. */
 174 #define BCM43xx_SBTOPCI2_PREFETCH       0x4
 175 #define BCM43xx_SBTOPCI2_BURST          0x8
 176 #define BCM43xx_SBTOPCI2_MEMREAD_MULTI  0x20
 177
 178 /* PCI-E core registers. */
 179 #define BCM43xx_PCIECORE_REG_ADDR      0x0130
 180 #define BCM43xx_PCIECORE_REG_DATA      0x0134
 181 #define BCM43xx_PCIECORE_MDIO_CTL      0x0128
 182 #define BCM43xx_PCIECORE_MDIO_DATA     0x012C
 183
 184 /* PCI-E registers. */
 185 #define BCM43xx_PCIE_TLP_WORKAROUND    0x0004
 186 #define BCM43xx_PCIE_DLLP_LINKCTL      0x0100
 187
 188 /* PCI-E MDIO bits. */
 189 #define BCM43xx_PCIE_MDIO_ST   0x40000000
 190 #define BCM43xx_PCIE_MDIO_WT   0x10000000
 191 #define BCM43xx_PCIE_MDIO_DEV  22
 192 #define BCM43xx_PCIE_MDIO_REG  18
 193 #define BCM43xx_PCIE_MDIO_TA   0x00020000
 194 #define BCM43xx_PCIE_MDIO_TC   0x0100
 195
 196 /* MDIO devices. */
 197 #define BCM43xx_MDIO_SERDES_RX  0x1F
 198
 199 /* SERDES RX registers. */
 200 #define BCM43xx_SERDES_RXTIMER  0x2
 201 #define BCM43xx_SERDES_CDR      0x6
 202 #define BCM43xx_SERDES_CDR_BW   0x7
 203
 204 /* Chipcommon capabilities. */
 205 #define BCM43xx_CAPABILITIES_PCTL               0x00040000
 206 #define BCM43xx_CAPABILITIES_PLLMASK            0x00030000
 207 #define BCM43xx_CAPABILITIES_PLLSHIFT           16
 208 #define BCM43xx_CAPABILITIES_FLASHMASK          0x00000700
 209 #define BCM43xx_CAPABILITIES_FLASHSHIFT         8
 210 #define BCM43xx_CAPABILITIES_EXTBUSPRESENT      0x00000040
 211 #define BCM43xx_CAPABILITIES_UARTGPIO           0x00000020
 212 #define BCM43xx_CAPABILITIES_UARTCLOCKMASK      0x00000018
 213 #define BCM43xx_CAPABILITIES_UARTCLOCKSHIFT     3
 214 #define BCM43xx_CAPABILITIES_MIPSBIGENDIAN      0x00000004
 215 #define BCM43xx_CAPABILITIES_NRUARTSMASK        0x00000003
 216
 217 /* PowerControl */
 218 #define BCM43xx_PCTL_IN                 0xB0
 219 #define BCM43xx_PCTL_OUT                0xB4
 220 #define BCM43xx_PCTL_OUTENABLE          0xB8
 221 #define BCM43xx_PCTL_XTAL_POWERUP       0x40
 222 #define BCM43xx_PCTL_PLL_POWERDOWN      0x80
 223
 224 /* PowerControl Clock Modes */
 225 #define BCM43xx_PCTL_CLK_FAST           0x00
 226 #define BCM43xx_PCTL_CLK_SLOW           0x01
 227 #define BCM43xx_PCTL_CLK_DYNAMIC        0x02
 228
 229 #define BCM43xx_PCTL_FORCE_SLOW         0x0800
 230 #define BCM43xx_PCTL_FORCE_PLL          0x1000
 231 #define BCM43xx_PCTL_DYN_XTAL           0x2000
 232
 233 /* COREIDs */
 234 #define BCM43xx_COREID_CHIPCOMMON       0x800
 235 #define BCM43xx_COREID_ILINE20          0x801
 236 #define BCM43xx_COREID_SDRAM            0x803
 237 #define BCM43xx_COREID_PCI              0x804
 238 #define BCM43xx_COREID_MIPS             0x805
 239 #define BCM43xx_COREID_ETHERNET         0x806
 240 #define BCM43xx_COREID_V90              0x807
 241 #define BCM43xx_COREID_USB11_HOSTDEV    0x80a
 242 #define BCM43xx_COREID_IPSEC            0x80b
 243 #define BCM43xx_COREID_PCMCIA           0x80d
 244 #define BCM43xx_COREID_EXT_IF           0x80f
 245 #define BCM43xx_COREID_80211            0x812
 246 #define BCM43xx_COREID_MIPS_3302        0x816
 247 #define BCM43xx_COREID_USB11_HOST       0x817
 248 #define BCM43xx_COREID_USB11_DEV        0x818
 249 #define BCM43xx_COREID_USB20_HOST       0x819
 250 #define BCM43xx_COREID_USB20_DEV        0x81a
 251 #define BCM43xx_COREID_SDIO_HOST        0x81b
 252 #define BCM43xx_COREID_PCIE             0x820
 253
 254 /* Core Information Registers */
 255 #define BCM43xx_CIR_BASE                0xf00
 256 #define BCM43xx_CIR_SBTPSFLAG           (BCM43xx_CIR_BASE + 0x18)
 257 #define BCM43xx_CIR_SBIMSTATE           (BCM43xx_CIR_BASE + 0x90)
 258 #define BCM43xx_CIR_SBINTVEC            (BCM43xx_CIR_BASE + 0x94)
 259 #define BCM43xx_CIR_SBTMSTATELOW        (BCM43xx_CIR_BASE + 0x98)
 260 #define BCM43xx_CIR_SBTMSTATEHIGH       (BCM43xx_CIR_BASE + 0x9c)
 261 #define BCM43xx_CIR_SBIMCONFIGLOW       (BCM43xx_CIR_BASE + 0xa8)
 262 #define BCM43xx_CIR_SB_ID_HI            (BCM43xx_CIR_BASE + 0xfc)
 263
 264 /* Mask to get the Backplane Flag Number from SBTPSFLAG. */
 265 #define BCM43xx_BACKPLANE_FLAG_NR_MASK  0x3f
 266
 267 /* SBIMCONFIGLOW values/masks. */
 268 #define BCM43xx_SBIMCONFIGLOW_SERVICE_TOUT_MASK         0x00000007
 269 #define BCM43xx_SBIMCONFIGLOW_SERVICE_TOUT_SHIFT        0
 270 #define BCM43xx_SBIMCONFIGLOW_REQUEST_TOUT_MASK         0x00000070
 271 #define BCM43xx_SBIMCONFIGLOW_REQUEST_TOUT_SHIFT        4
 272 #define BCM43xx_SBIMCONFIGLOW_CONNID_MASK               0x00ff0000
 273 #define BCM43xx_SBIMCONFIGLOW_CONNID_SHIFT              16
 274
 275 /* sbtmstatelow state flags */
 276 #define BCM43xx_SBTMSTATELOW_RESET              0x01
 277 #define BCM43xx_SBTMSTATELOW_REJECT             0x02
 278 #define BCM43xx_SBTMSTATELOW_CLOCK              0x10000
 279 #define BCM43xx_SBTMSTATELOW_FORCE_GATE_CLOCK   0x20000
 280
 281 /* sbtmstatehigh state flags */
 282 #define BCM43xx_SBTMSTATEHIGH_SERROR            0x00000001
 283 #define BCM43xx_SBTMSTATEHIGH_BUSY              0x00000004
 284 #define BCM43xx_SBTMSTATEHIGH_TIMEOUT           0x00000020
 285 #define BCM43xx_SBTMSTATEHIGH_COREFLAGS         0x1FFF0000
 286 #define BCM43xx_SBTMSTATEHIGH_DMA64BIT          0x10000000
 287 #define BCM43xx_SBTMSTATEHIGH_GATEDCLK          0x20000000
 288 #define BCM43xx_SBTMSTATEHIGH_BISTFAILED        0x40000000
 289 #define BCM43xx_SBTMSTATEHIGH_BISTCOMPLETE      0x80000000
 290
 291 /* sbimstate flags */
 292 #define BCM43xx_SBIMSTATE_IB_ERROR              0x20000
 293 #define BCM43xx_SBIMSTATE_TIMEOUT               0x40000
 294
 295 /* PHYVersioning */
 296 #define BCM43xx_PHYTYPE_A               0x00
 297 #define BCM43xx_PHYTYPE_B               0x01
 298 #define BCM43xx_PHYTYPE_G               0x02
 299
 300 /* PHYRegisters */
 301 #define BCM43xx_PHY_ILT_A_CTRL          0x0072
 302 #define BCM43xx_PHY_ILT_A_DATA1         0x0073
 303 #define BCM43xx_PHY_ILT_A_DATA2         0x0074
 304 #define BCM43xx_PHY_G_LO_CONTROL        0x0810
 305 #define BCM43xx_PHY_ILT_G_CTRL          0x0472
 306 #define BCM43xx_PHY_ILT_G_DATA1         0x0473
 307 #define BCM43xx_PHY_ILT_G_DATA2         0x0474
 308 #define BCM43xx_PHY_A_PCTL              0x007B
 309 #define BCM43xx_PHY_G_PCTL              0x0029
 310 #define BCM43xx_PHY_A_CRS               0x0029
 311 #define BCM43xx_PHY_RADIO_BITFIELD      0x0401
 312 #define BCM43xx_PHY_G_CRS               0x0429
 313 #define BCM43xx_PHY_NRSSILT_CTRL        0x0803
 314 #define BCM43xx_PHY_NRSSILT_DATA        0x0804
 315
 316 /* RadioRegisters */
 317 #define BCM43xx_RADIOCTL_ID             0x01
 318
 319 /* StatusBitField */
 320 #define BCM43xx_SBF_MAC_ENABLED         0x00000001
 321 #define BCM43xx_SBF_2                   0x00000002 /*FIXME: fix name*/
 322 #define BCM43xx_SBF_CORE_READY          0x00000004
 323 #define BCM43xx_SBF_400                 0x00000400 /*FIXME: fix name*/
 324 #define BCM43xx_SBF_4000                0x00004000 /*FIXME: fix name*/
 325 #define BCM43xx_SBF_8000                0x00008000 /*FIXME: fix name*/
 326 #define BCM43xx_SBF_XFER_REG_BYTESWAP   0x00010000
 327 #define BCM43xx_SBF_MODE_NOTADHOC       0x00020000
 328 #define BCM43xx_SBF_MODE_AP             0x00040000
 329 #define BCM43xx_SBF_RADIOREG_LOCK       0x00080000
 330 #define BCM43xx_SBF_MODE_MONITOR        0x00400000
 331 #define BCM43xx_SBF_MODE_PROMISC        0x01000000
 332 #define BCM43xx_SBF_PS1                 0x02000000
 333 #define BCM43xx_SBF_PS2                 0x04000000
 334 #define BCM43xx_SBF_NO_SSID_BCAST       0x08000000
 335 #define BCM43xx_SBF_TIME_UPDATE         0x10000000
 336 #define BCM43xx_SBF_MODE_G              0x80000000
 337
 338 /* Microcode */
 339 #define BCM43xx_UCODE_REVISION          0x0000
 340 #define BCM43xx_UCODE_PATCHLEVEL        0x0002
 341 #define BCM43xx_UCODE_DATE              0x0004
 342 #define BCM43xx_UCODE_TIME              0x0006
 343 #define BCM43xx_UCODE_STATUS            0x0040
 344
 345 /* MicrocodeFlagsBitfield (addr + lo-word values?)*/
 346 #define BCM43xx_UCODEFLAGS_OFFSET       0x005E
 347
 348 #define BCM43xx_UCODEFLAG_AUTODIV       0x0001
 349 #define BCM43xx_UCODEFLAG_UNKBGPHY      0x0002
 350 #define BCM43xx_UCODEFLAG_UNKBPHY       0x0004
 351 #define BCM43xx_UCODEFLAG_UNKGPHY       0x0020
 352 #define BCM43xx_UCODEFLAG_UNKPACTRL     0x0040
 353 #define BCM43xx_UCODEFLAG_JAPAN         0x0080
 354
 355 /* Hardware Radio Enable masks */
 356 #define BCM43xx_MMIO_RADIO_HWENABLED_HI_MASK (1 << 16)
 357 #define BCM43xx_MMIO_RADIO_HWENABLED_LO_MASK (1 << 4)
 358
 359 /* Generic-Interrupt reasons. */
 360 #define BCM43xx_IRQ_READY               (1 << 0)
 361 #define BCM43xx_IRQ_BEACON              (1 << 1)
 362 #define BCM43xx_IRQ_PS                  (1 << 2)
 363 #define BCM43xx_IRQ_REG124              (1 << 5)
 364 #define BCM43xx_IRQ_PMQ                 (1 << 6)
 365 #define BCM43xx_IRQ_PIO_WORKAROUND      (1 << 8)
 366 #define BCM43xx_IRQ_XMIT_ERROR          (1 << 11)
 367 #define BCM43xx_IRQ_RX                  (1 << 15)
 368 #define BCM43xx_IRQ_SCAN                (1 << 16)
 369 #define BCM43xx_IRQ_NOISE               (1 << 18)
 370 #define BCM43xx_IRQ_XMIT_STATUS         (1 << 29)
 371
 372 #define BCM43xx_IRQ_ALL                 0xffffffff
 373 #define BCM43xx_IRQ_INITIAL             (BCM43xx_IRQ_PS |               \
 374                                          BCM43xx_IRQ_REG124 |           \
 375                                          BCM43xx_IRQ_PMQ |              \
 376                                          BCM43xx_IRQ_XMIT_ERROR |       \
 377                                          BCM43xx_IRQ_RX |               \
 378                                          BCM43xx_IRQ_SCAN |             \
 379                                          BCM43xx_IRQ_NOISE |            \
 380                                          BCM43xx_IRQ_XMIT_STATUS)
 381
 382
 383 /* Initial default iw_mode */
 384 #define BCM43xx_INITIAL_IWMODE                  IW_MODE_INFRA
 385
 386 /* Bus type PCI. */
 387 #define BCM43xx_BUSTYPE_PCI     0
 388 /* Bus type Silicone Backplane Bus. */
 389 #define BCM43xx_BUSTYPE_SB      1
 390 /* Bus type PCMCIA. */
 391 #define BCM43xx_BUSTYPE_PCMCIA  2
 392
 393 /* Threshold values. */
 394 #define BCM43xx_MIN_RTS_THRESHOLD               1U
 395 #define BCM43xx_MAX_RTS_THRESHOLD               2304U
 396 #define BCM43xx_DEFAULT_RTS_THRESHOLD           BCM43xx_MAX_RTS_THRESHOLD
 397
 398 #define BCM43xx_DEFAULT_SHORT_RETRY_LIMIT       7
 399 #define BCM43xx_DEFAULT_LONG_RETRY_LIMIT        4
 400
 401 /* FIXME: the next line is a guess as to what the maximum RSSI value might be */
 402 #define RX_RSSI_MAX                             60
 403
 404 /* Max size of a security key */
 405 #define BCM43xx_SEC_KEYSIZE                     16
 406 /* Security algorithms. */
 407 enum {
 408         BCM43xx_SEC_ALGO_NONE = 0, /* unencrypted, as of TX header. */
 409         BCM43xx_SEC_ALGO_WEP,
 410         BCM43xx_SEC_ALGO_UNKNOWN,
 411         BCM43xx_SEC_ALGO_AES,
 412         BCM43xx_SEC_ALGO_WEP104,
 413         BCM43xx_SEC_ALGO_TKIP,
 414 };
 415
 416 #ifdef assert
 417 # undef assert
 418 #endif
 419 #ifdef CONFIG_BCM43XX_DEBUG
 420 #define assert(expr) \
 421         do {                                                                    \
 422                 if (unlikely(!(expr))) {                                        \
 423                 printk(KERN_ERR PFX "ASSERTION FAILED (%s) at: %s:%d:%s()\n",   \
 424                         #expr, __FILE__, __LINE__, __FUNCTION__);               \
 425                 }                                                               \
 426         } while (0)
 427 #else
 428 #define assert(expr)    do { /* nothing */ } while (0)
 429 #endif
 430
 431 /* rate limited printk(). */
 432 #ifdef printkl
 433 # undef printkl
 434 #endif
 435 #define printkl(f, x...)  do { if (printk_ratelimit()) printk(f ,##x); } while (0)
 436 /* rate limited printk() for debugging */
 437 #ifdef dprintkl
 438 # undef dprintkl
 439 #endif
 440 #ifdef CONFIG_BCM43XX_DEBUG
 441 # define dprintkl               printkl
 442 #else
 443 # define dprintkl(f, x...)      do { /* nothing */ } while (0)
 444 #endif
 445
 446 /* Helper macro for if branches.
 447  * An if branch marked with this macro is only taken in DEBUG mode.
 448  * Example:
 449  *      if (DEBUG_ONLY(foo == bar)) {
 450  *              do something
 451  *      }
 452  *      In DEBUG mode, the branch will be taken if (foo == bar).
 453  *      In non-DEBUG mode, the branch will never be taken.
 454  */
 455 #ifdef DEBUG_ONLY
 456 # undef DEBUG_ONLY
 457 #endif
 458 #ifdef CONFIG_BCM43XX_DEBUG
 459 # define DEBUG_ONLY(x)  (x)
 460 #else
 461 # define DEBUG_ONLY(x)  0
 462 #endif
 463
 464 /* debugging printk() */
 465 #ifdef dprintk
 466 # undef dprintk
 467 #endif
 468 #ifdef CONFIG_BCM43XX_DEBUG
 469 # define dprintk(f, x...)  do { printk(f ,##x); } while (0)
 470 #else
 471 # define dprintk(f, x...)  do { /* nothing */ } while (0)
 472 #endif
 473
 474
 475 struct net_device;
 476 struct pci_dev;
 477 struct bcm43xx_dmaring;
 478 struct bcm43xx_pioqueue;
 479
 480 struct bcm43xx_initval {
 481         u16 offset;
 482         u16 size;
 483         u32 value;
 484 } __attribute__((__packed__));
 485
 486 /* Values for bcm430x_sprominfo.locale */
 487 enum {
 488         BCM43xx_LOCALE_WORLD = 0,
 489         BCM43xx_LOCALE_THAILAND,
 490         BCM43xx_LOCALE_ISRAEL,
 491         BCM43xx_LOCALE_JORDAN,
 492         BCM43xx_LOCALE_CHINA,
 493         BCM43xx_LOCALE_JAPAN,
 494         BCM43xx_LOCALE_USA_CANADA_ANZ,
 495         BCM43xx_LOCALE_EUROPE,
 496         BCM43xx_LOCALE_USA_LOW,
 497         BCM43xx_LOCALE_JAPAN_HIGH,
 498         BCM43xx_LOCALE_ALL,
 499         BCM43xx_LOCALE_NONE,
 500 };
 501
 502 #define BCM43xx_SPROM_SIZE      64 /* in 16-bit words. */
 503 struct bcm43xx_sprominfo {
 504         u16 boardflags2;
 505         u8 il0macaddr[6];
 506         u8 et0macaddr[6];
 507         u8 et1macaddr[6];
 508         u8 et0phyaddr:5;
 509         u8 et1phyaddr:5;
 510         u8 boardrev;
 511         u8 locale:4;
 512         u8 antennas_aphy:2;
 513         u8 antennas_bgphy:2;
 514         u16 pa0b0;
 515         u16 pa0b1;
 516         u16 pa0b2;
 517         u8 wl0gpio0;
 518         u8 wl0gpio1;
 519         u8 wl0gpio2;
 520         u8 wl0gpio3;
 521         u8 maxpower_aphy;
 522         u8 maxpower_bgphy;
 523         u16 pa1b0;
 524         u16 pa1b1;
 525         u16 pa1b2;
 526         u8 idle_tssi_tgt_aphy;
 527         u8 idle_tssi_tgt_bgphy;
 528         u16 boardflags;
 529         u16 antennagain_aphy;
 530         u16 antennagain_bgphy;
 531 };
 532
 533 /* Value pair to measure the LocalOscillator. */
 534 struct bcm43xx_lopair {
 535         s8 low;
 536         s8 high;
 537         u8 used:1;
 538 };
 539 #define BCM43xx_LO_COUNT        (14*4)
 540
 541 struct bcm43xx_phyinfo {
 542         /* Hardware Data */
 543         u8 analog;
 544         u8 type;
 545         u8 rev;
 546         u16 antenna_diversity;
 547         u16 savedpctlreg;
 548         u16 minlowsig[2];
 549         u16 minlowsigpos[2];
 550         u8 connected:1,
 551            calibrated:1,
 552            is_locked:1, /* used in bcm43xx_phy_{un}lock() */
 553            dyn_tssi_tbl:1; /* used in bcm43xx_phy_init_tssi2dbm_table() */
 554         /* LO Measurement Data.
 555          * Use bcm43xx_get_lopair() to get a value.
 556          */
 557         struct bcm43xx_lopair *_lo_pairs;
 558
 559         /* TSSI to dBm table in use */
 560         const s8 *tssi2dbm;
 561         /* idle TSSI value */
 562         s8 idle_tssi;
 563
 564         /* Values from bcm43xx_calc_loopback_gain() */
 565         u16 loopback_gain[2];
 566
 567         /* PHY lock for core.rev < 3
 568          * This lock is only used by bcm43xx_phy_{un}lock()
 569          */
 570         spinlock_t lock;
 571
 572         /* Firmware. */
 573         const struct firmware *ucode;
 574         const struct firmware *pcm;
 575         const struct firmware *initvals0;
 576         const struct firmware *initvals1;
 577 };
 578
 579
 580 struct bcm43xx_radioinfo {
 581         u16 manufact;
 582         u16 version;
 583         u8 revision;
 584
 585         /* Desired TX power in dBm Q5.2 */
 586         u16 txpower_desired;
 587         /* TX Power control values. */
 588         union {
 589                 /* B/G PHY */
 590                 struct {
 591                         u16 baseband_atten;
 592                         u16 radio_atten;
 593                         u16 txctl1;
 594                         u16 txctl2;
 595                 };
 596                 /* A PHY */
 597                 struct {
 598                         u16 txpwr_offset;
 599                 };
 600         };
 601
 602         /* Current Interference Mitigation mode */
 603         int interfmode;
 604         /* Stack of saved values from the Interference Mitigation code.
 605          * Each value in the stack is layed out as follows:
 606          * bit 0-11:  offset
 607          * bit 12-15: register ID
 608          * bit 16-32: value
 609          * register ID is: 0x1 PHY, 0x2 Radio, 0x3 ILT
 610          */
 611 #define BCM43xx_INTERFSTACK_SIZE        26
 612         u32 interfstack[BCM43xx_INTERFSTACK_SIZE];
 613
 614         /* Saved values from the NRSSI Slope calculation */
 615         s16 nrssi[2];
 616         s32 nrssislope;
 617         /* In memory nrssi lookup table. */
 618         s8 nrssi_lt[64];
 619
 620         /* current channel */
 621         u8 channel;
 622         u8 initial_channel;
 623
 624         u16 lofcal;
 625
 626         u16 initval;
 627
 628         u8 enabled:1;
 629         /* ACI (adjacent channel interference) flags. */
 630         u8 aci_enable:1,
 631            aci_wlan_automatic:1,
 632            aci_hw_rssi:1;
 633 };
 634
 635 /* Data structures for DMA transmission, per 80211 core. */
 636 struct bcm43xx_dma {
 637         struct bcm43xx_dmaring *tx_ring0;
 638         struct bcm43xx_dmaring *tx_ring1;
 639         struct bcm43xx_dmaring *tx_ring2;
 640         struct bcm43xx_dmaring *tx_ring3;
 641         struct bcm43xx_dmaring *tx_ring4;
 642         struct bcm43xx_dmaring *tx_ring5;
 643
 644         struct bcm43xx_dmaring *rx_ring0;
 645         struct bcm43xx_dmaring *rx_ring3; /* only available on core.rev < 5 */
 646 };
 647
 648 /* Data structures for PIO transmission, per 80211 core. */
 649 struct bcm43xx_pio {
 650         struct bcm43xx_pioqueue *queue0;
 651         struct bcm43xx_pioqueue *queue1;
 652         struct bcm43xx_pioqueue *queue2;
 653         struct bcm43xx_pioqueue *queue3;
 654 };
 655
 656 #define BCM43xx_MAX_80211_CORES         2
 657
 658 #ifdef CONFIG_BCM947XX
 659 #define core_offset(bcm) (bcm)->current_core_offset
 660 #else
 661 #define core_offset(bcm) 0
 662 #endif
 663
 664 /* Generic information about a core. */
 665 struct bcm43xx_coreinfo {
 666         u8 available:1,
 667            enabled:1,
 668            initialized:1;
 669         /** core_rev revision number */
 670         u8 rev;
 671         /** Index number for _switch_core() */
 672         u8 index;
 673         /** core_id ID number */
 674         u16 id;
 675         /** Core-specific data. */
 676         void *priv;
 677 };
 678
 679 /* Additional information for each 80211 core. */
 680 struct bcm43xx_coreinfo_80211 {
 681         /* PHY device. */
 682         struct bcm43xx_phyinfo phy;
 683         /* Radio device. */
 684         struct bcm43xx_radioinfo radio;
 685         union {
 686                 /* DMA context. */
 687                 struct bcm43xx_dma dma;
 688                 /* PIO context. */
 689                 struct bcm43xx_pio pio;
 690         };
 691 };
 692
 693 /* Context information for a noise calculation (Link Quality). */
 694 struct bcm43xx_noise_calculation {
 695         struct bcm43xx_coreinfo *core_at_start;
 696         u8 channel_at_start;
 697         u8 calculation_running:1;
 698         u8 nr_samples;
 699         s8 samples[8][4];
 700 };
 701
 702 struct bcm43xx_stats {
 703         u8 noise;
 704         struct iw_statistics wstats;
 705         /* Store the last TX/RX times here for updating the leds. */
 706         unsigned long last_tx;
 707         unsigned long last_rx;
 708 };
 709
 710 struct bcm43xx_key {
 711         u8 enabled:1;
 712         u8 algorithm;
 713 };
 714
 715 /* Driver initialization status. */
 716 enum {
 717         BCM43xx_STAT_UNINIT,            /* Uninitialized. */
 718         BCM43xx_STAT_INITIALIZING,      /* init_board() in progress. */
 719         BCM43xx_STAT_INITIALIZED,       /* Fully operational. */
 720         BCM43xx_STAT_SHUTTINGDOWN,      /* free_board() in progress. */
 721         BCM43xx_STAT_RESTARTING,        /* controller_restart() called. */
 722 };
 723 #define bcm43xx_status(bcm)             atomic_read(&(bcm)->init_status)
 724 #define bcm43xx_set_status(bcm, stat)   do {                    \
 725                 atomic_set(&(bcm)->init_status, (stat));        \
 726                 smp_wmb();                                      \
 727                                         } while (0)
 728
 729 /*    *** THEORY OF LOCKING ***
 730  *
 731  * We have two different locks in the bcm43xx driver.
 732  * => bcm->mutex:    General sleeping mutex. Protects struct bcm43xx_private
 733  *                   and the device registers. This mutex does _not_ protect
 734  *                   against concurrency from the IRQ handler.
 735  * => bcm->irq_lock: IRQ spinlock. Protects against IRQ handler concurrency.
 736  *
 737  * Please note that, if you only take the irq_lock, you are not protected
 738  * against concurrency from the periodic work handlers.
 739  * Most times you want to take _both_ locks.
 740  */
 741
 742 struct bcm43xx_private {
 743         struct ieee80211_device *ieee;
 744         struct ieee80211softmac_device *softmac;
 745
 746         struct net_device *net_dev;
 747         struct pci_dev *pci_dev;
 748         unsigned int irq;
 749
 750         void __iomem *mmio_addr;
 751
 752         spinlock_t irq_lock;
 753         struct mutex mutex;
 754
 755         /* Driver initialization status BCM43xx_STAT_*** */
 756         atomic_t init_status;
 757
 758         u16 was_initialized:1,          /* for PCI suspend/resume. */
 759             __using_pio:1,              /* Internal, use bcm43xx_using_pio(). */
 760             bad_frames_preempt:1,       /* Use "Bad Frames Preemption" (default off) */
 761             reg124_set_0x4:1,           /* Some variable to keep track of IRQ stuff. */
 762             short_preamble:1,           /* TRUE, if short preamble is enabled. */
 763             firmware_norelease:1,       /* Do not release the firmware. Used on suspend. */
 764             radio_hw_enable:1;          /* TRUE if radio is hardware enabled */
 765
 766         struct bcm43xx_stats stats;
 767
 768         /* Bus type we are connected to.
 769          * This is currently always BCM43xx_BUSTYPE_PCI
 770          */
 771         u8 bustype;
 772         u64 dma_mask;
 773
 774         u16 board_vendor;
 775         u16 board_type;
 776         u16 board_revision;
 777
 778         u16 chip_id;
 779         u8 chip_rev;
 780         u8 chip_package;
 781
 782         struct bcm43xx_sprominfo sprom;
 783 #define BCM43xx_NR_LEDS         4
 784         struct bcm43xx_led leds[BCM43xx_NR_LEDS];
 785         spinlock_t leds_lock;
 786
 787         /* The currently active core. */
 788         struct bcm43xx_coreinfo *current_core;
 789 #ifdef CONFIG_BCM947XX
 790         /** current core memory offset */
 791         u32 current_core_offset;
 792 #endif
 793         struct bcm43xx_coreinfo *active_80211_core;
 794         /* coreinfo structs for all possible cores follow.
 795          * Note that a core might not exist.
 796          * So check the coreinfo flags before using it.
 797          */
 798         struct bcm43xx_coreinfo core_chipcommon;
 799         struct bcm43xx_coreinfo core_pci;
 800         struct bcm43xx_coreinfo core_80211[ BCM43xx_MAX_80211_CORES ];
 801         /* Additional information, specific to the 80211 cores. */
 802         struct bcm43xx_coreinfo_80211 core_80211_ext[ BCM43xx_MAX_80211_CORES ];
 803         /* Number of available 80211 cores. */
 804         int nr_80211_available;
 805
 806         u32 chipcommon_capabilities;
 807
 808         /* Reason code of the last interrupt. */
 809         u32 irq_reason;
 810         u32 dma_reason[6];
 811         /* saved irq enable/disable state bitfield. */
 812         u32 irq_savedstate;
 813         /* Link Quality calculation context. */
 814         struct bcm43xx_noise_calculation noisecalc;
 815         /* if > 0 MAC is suspended. if == 0 MAC is enabled. */
 816         int mac_suspended;
 817
 818         /* Threshold values. */
 819         //TODO: The RTS thr has to be _used_. Currently, it is only set via WX.
 820         u32 rts_threshold;
 821
 822         /* Interrupt Service Routine tasklet (bottom-half) */
 823         struct tasklet_struct isr_tasklet;
 824
 825         /* Periodic tasks */
 826         struct delayed_work periodic_work;
 827         unsigned int periodic_state;
 828
 829         struct work_struct restart_work;
 830
 831         /* Informational stuff. */
 832         char nick[IW_ESSID_MAX_SIZE + 1];
 833
 834         /* encryption/decryption */
 835         u16 security_offset;
 836         struct bcm43xx_key key[54];
 837         u8 default_key_idx;
 838
 839         /* Random Number Generator. */
 840         struct hwrng rng;
 841         char rng_name[20 + 1];
 842
 843         /* Debugging stuff follows. */
 844 #ifdef CONFIG_BCM43XX_DEBUG
 845         struct bcm43xx_dfsentry *dfsentry;
 846 #endif
 847 };
 848
 849
 850 static inline
 851 struct bcm43xx_private * bcm43xx_priv(struct net_device *dev)
 852 {
 853         return ieee80211softmac_priv(dev);
 854 }
 855
 856 struct device;
 857
 858 static inline
 859 struct bcm43xx_private * dev_to_bcm(struct device *dev)
 860 {
 861         struct net_device *net_dev;
 862         struct bcm43xx_private *bcm;
 863
 864         net_dev = dev_get_drvdata(dev);
 865         bcm = bcm43xx_priv(net_dev);
 866
 867         return bcm;
 868 }
 869
 870
 871 /* Helper function, which returns a boolean.
 872  * TRUE, if PIO is used; FALSE, if DMA is used.
 873  */
 874 #if defined(CONFIG_BCM43XX_DMA) && defined(CONFIG_BCM43XX_PIO)
 875 static inline
 876 int bcm43xx_using_pio(struct bcm43xx_private *bcm)
 877 {
 878         return bcm->__using_pio;
 879 }
 880 #elif defined(CONFIG_BCM43XX_DMA)
 881 static inline
 882 int bcm43xx_using_pio(struct bcm43xx_private *bcm)
 883 {
 884         return 0;
 885 }
 886 #elif defined(CONFIG_BCM43XX_PIO)
 887 static inline
 888 int bcm43xx_using_pio(struct bcm43xx_private *bcm)
 889 {
 890         return 1;
 891 }
 892 #else
 893 # error "Using neither DMA nor PIO? Confused..."
 894 #endif
 895
 896 /* Helper functions to access data structures private to the 80211 cores.
 897  * Note that we _must_ have an 80211 core mapped when calling
 898  * any of these functions.
 899  */
 900 static inline
 901 struct bcm43xx_coreinfo_80211 *
 902 bcm43xx_current_80211_priv(struct bcm43xx_private *bcm)
 903 {
 904         assert(bcm->current_core->id == BCM43xx_COREID_80211);
 905         return bcm->current_core->priv;
 906 }
 907 static inline
 908 struct bcm43xx_pio * bcm43xx_current_pio(struct bcm43xx_private *bcm)
 909 {
 910         assert(bcm43xx_using_pio(bcm));
 911         return &(bcm43xx_current_80211_priv(bcm)->pio);
 912 }
 913 static inline
 914 struct bcm43xx_dma * bcm43xx_current_dma(struct bcm43xx_private *bcm)
 915 {
 916         assert(!bcm43xx_using_pio(bcm));
 917         return &(bcm43xx_current_80211_priv(bcm)->dma);
 918 }
 919 static inline
 920 struct bcm43xx_phyinfo * bcm43xx_current_phy(struct bcm43xx_private *bcm)
 921 {
 922         return &(bcm43xx_current_80211_priv(bcm)->phy);
 923 }
 924 static inline
 925 struct bcm43xx_radioinfo * bcm43xx_current_radio(struct bcm43xx_private *bcm)
 926 {
 927         return &(bcm43xx_current_80211_priv(bcm)->radio);
 928 }
 929
 930
 931 static inline
 932 struct bcm43xx_lopair * bcm43xx_get_lopair(struct bcm43xx_phyinfo *phy,
 933                                            u16 radio_attenuation,
 934                                            u16 baseband_attenuation)
 935 {
 936         return phy->_lo_pairs + (radio_attenuation + 14 * (baseband_attenuation / 2));
 937 }
 938
 939
 940 static inline
 941 u16 bcm43xx_read16(struct bcm43xx_private *bcm, u16 offset)
 942 {
 943         return ioread16(bcm->mmio_addr + core_offset(bcm) + offset);
 944 }
 945
 946 static inline
 947 void bcm43xx_write16(struct bcm43xx_private *bcm, u16 offset, u16 value)
 948 {
 949         iowrite16(value, bcm->mmio_addr + core_offset(bcm) + offset);
 950 }
 951
 952 static inline
 953 u32 bcm43xx_read32(struct bcm43xx_private *bcm, u16 offset)
 954 {
 955         return ioread32(bcm->mmio_addr + core_offset(bcm) + offset);
 956 }
 957
 958 static inline
 959 void bcm43xx_write32(struct bcm43xx_private *bcm, u16 offset, u32 value)
 960 {
 961         iowrite32(value, bcm->mmio_addr + core_offset(bcm) + offset);
 962 }
 963
 964 static inline
 965 int bcm43xx_pci_read_config16(struct bcm43xx_private *bcm, int offset, u16 *value)
 966 {
 967         return pci_read_config_word(bcm->pci_dev, offset, value);
 968 }
 969
 970 static inline
 971 int bcm43xx_pci_read_config32(struct bcm43xx_private *bcm, int offset, u32 *value)
 972 {
 973         return pci_read_config_dword(bcm->pci_dev, offset, value);
 974 }
 975
 976 static inline
 977 int bcm43xx_pci_write_config16(struct bcm43xx_private *bcm, int offset, u16 value)
 978 {
 979         return pci_write_config_word(bcm->pci_dev, offset, value);
 980 }
 981
 982 static inline
 983 int bcm43xx_pci_write_config32(struct bcm43xx_private *bcm, int offset, u32 value)
 984 {
 985         return pci_write_config_dword(bcm->pci_dev, offset, value);
 986 }
 987
 988 /** Limit a value between two limits */
 989 #ifdef limit_value
 990 # undef limit_value
 991 #endif
 992 #define limit_value(value, min, max)  \
 993         ({                                              \
 994                 typeof(value) __value = (value);        \
 995                 typeof(value) __min = (min);            \
 996                 typeof(value) __max = (max);            \
 997                 if (__value < __min)                    \
 998                         __value = __min;                \
 999                 else if (__value > __max)               \
1000                         __value = __max;                \
1001                 __value;                                \
1002         })
1003
1004 /** Helpers to print MAC addresses. */
1005 #define BCM43xx_MACFMT          "%02x:%02x:%02x:%02x:%02x:%02x"
1006 #define BCM43xx_MACARG(x)       ((u8*)(x))[0], ((u8*)(x))[1], \
1007                                 ((u8*)(x))[2], ((u8*)(x))[3], \
1008                                 ((u8*)(x))[4], ((u8*)(x))[5]
1009
1010 #endif /* BCM43xx_H_ */