drivers/net/wireless/ath5k/ath5k.h

   1 /*
   2  * Copyright (c) 2004-2007 Reyk Floeter <reyk@openbsd.org>
   3  * Copyright (c) 2006-2007 Nick Kossifidis <mickflemm@gmail.com>
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 #ifndef _ATH5K_H
  19 #define _ATH5K_H
  20
  21 /* Set this to 1 to disable regulatory domain restrictions for channel tests.
  22  * WARNING: This is for debuging only and has side effects (eg. scan takes too
  23  * long and results timeouts). It's also illegal to tune to some of the
  24  * supported frequencies in some countries, so use this at your own risk,
  25  * you've been warned. */
  26 #define CHAN_DEBUG      0
  27
  28 #include <linux/io.h>
  29 #include <linux/types.h>
  30 #include <net/mac80211.h>
  31
  32 #include "hw.h"
  33
  34 /* PCI IDs */
  35 #define PCI_DEVICE_ID_ATHEROS_AR5210            0x0007 /* AR5210 */
  36 #define PCI_DEVICE_ID_ATHEROS_AR5311            0x0011 /* AR5311 */
  37 #define PCI_DEVICE_ID_ATHEROS_AR5211            0x0012 /* AR5211 */
  38 #define PCI_DEVICE_ID_ATHEROS_AR5212            0x0013 /* AR5212 */
  39 #define PCI_DEVICE_ID_3COM_3CRDAG675            0x0013 /* 3CRDAG675 (Atheros AR5212) */
  40 #define PCI_DEVICE_ID_3COM_2_3CRPAG175          0x0013 /* 3CRPAG175 (Atheros AR5212) */
  41 #define PCI_DEVICE_ID_ATHEROS_AR5210_AP         0x0207 /* AR5210 (Early) */
  42 #define PCI_DEVICE_ID_ATHEROS_AR5212_IBM        0x1014 /* AR5212 (IBM MiniPCI) */
  43 #define PCI_DEVICE_ID_ATHEROS_AR5210_DEFAULT    0x1107 /* AR5210 (no eeprom) */
  44 #define PCI_DEVICE_ID_ATHEROS_AR5212_DEFAULT    0x1113 /* AR5212 (no eeprom) */
  45 #define PCI_DEVICE_ID_ATHEROS_AR5211_DEFAULT    0x1112 /* AR5211 (no eeprom) */
  46 #define PCI_DEVICE_ID_ATHEROS_AR5212_FPGA       0xf013 /* AR5212 (emulation board) */
  47 #define PCI_DEVICE_ID_ATHEROS_AR5211_LEGACY     0xff12 /* AR5211 (emulation board) */
  48 #define PCI_DEVICE_ID_ATHEROS_AR5211_FPGA11B    0xf11b /* AR5211 (emulation board) */
  49 #define PCI_DEVICE_ID_ATHEROS_AR5312_REV2       0x0052 /* AR5312 WMAC (AP31) */
  50 #define PCI_DEVICE_ID_ATHEROS_AR5312_REV7       0x0057 /* AR5312 WMAC (AP30-040) */
  51 #define PCI_DEVICE_ID_ATHEROS_AR5312_REV8       0x0058 /* AR5312 WMAC (AP43-030) */
  52 #define PCI_DEVICE_ID_ATHEROS_AR5212_0014       0x0014 /* AR5212 compatible */
  53 #define PCI_DEVICE_ID_ATHEROS_AR5212_0015       0x0015 /* AR5212 compatible */
  54 #define PCI_DEVICE_ID_ATHEROS_AR5212_0016       0x0016 /* AR5212 compatible */
  55 #define PCI_DEVICE_ID_ATHEROS_AR5212_0017       0x0017 /* AR5212 compatible */
  56 #define PCI_DEVICE_ID_ATHEROS_AR5212_0018       0x0018 /* AR5212 compatible */
  57 #define PCI_DEVICE_ID_ATHEROS_AR5212_0019       0x0019 /* AR5212 compatible */
  58 #define PCI_DEVICE_ID_ATHEROS_AR2413            0x001a /* AR2413 (Griffin-lite) */
  59 #define PCI_DEVICE_ID_ATHEROS_AR5413            0x001b /* AR5413 (Eagle) */
  60 #define PCI_DEVICE_ID_ATHEROS_AR5424            0x001c /* AR5424 (Condor PCI-E) */
  61 #define PCI_DEVICE_ID_ATHEROS_AR5416            0x0023 /* AR5416 */
  62 #define PCI_DEVICE_ID_ATHEROS_AR5418            0x0024 /* AR5418 */
  63
  64 /****************************\
  65   GENERIC DRIVER DEFINITIONS
  66 \****************************/
  67
  68 #define ATH5K_PRINTF(fmt, ...)   printk("%s: " fmt, __func__, ##__VA_ARGS__)
  69
  70 #define ATH5K_PRINTK(_sc, _level, _fmt, ...) \
  71         printk(_level "ath5k %s: " _fmt, \
  72                 ((_sc) && (_sc)->hw) ? wiphy_name((_sc)->hw->wiphy) : "", \
  73                 ##__VA_ARGS__)
  74
  75 #define ATH5K_PRINTK_LIMIT(_sc, _level, _fmt, ...) do { \
  76         if (net_ratelimit()) \
  77                 ATH5K_PRINTK(_sc, _level, _fmt, ##__VA_ARGS__); \
  78         } while (0)
  79
  80 #define ATH5K_INFO(_sc, _fmt, ...) \
  81         ATH5K_PRINTK(_sc, KERN_INFO, _fmt, ##__VA_ARGS__)
  82
  83 #define ATH5K_WARN(_sc, _fmt, ...) \
  84         ATH5K_PRINTK_LIMIT(_sc, KERN_WARNING, _fmt, ##__VA_ARGS__)
  85
  86 #define ATH5K_ERR(_sc, _fmt, ...) \
  87         ATH5K_PRINTK_LIMIT(_sc, KERN_ERR, _fmt, ##__VA_ARGS__)
  88
  89 /*
  90  * Some tuneable values (these should be changeable by the user)
  91  */
  92 #define AR5K_TUNE_DMA_BEACON_RESP               2
  93 #define AR5K_TUNE_SW_BEACON_RESP                10
  94 #define AR5K_TUNE_ADDITIONAL_SWBA_BACKOFF       0
  95 #define AR5K_TUNE_RADAR_ALERT                   false
  96 #define AR5K_TUNE_MIN_TX_FIFO_THRES             1
  97 #define AR5K_TUNE_MAX_TX_FIFO_THRES             ((IEEE80211_MAX_LEN / 64) + 1)
  98 #define AR5K_TUNE_REGISTER_TIMEOUT              20000
  99 /* Register for RSSI threshold has a mask of 0xff, so 255 seems to
 100  * be the max value. */
 101 #define AR5K_TUNE_RSSI_THRES                   129
 102 /* This must be set when setting the RSSI threshold otherwise it can
 103  * prevent a reset. If AR5K_RSSI_THR is read after writing to it
 104  * the BMISS_THRES will be seen as 0, seems harware doesn't keep
 105  * track of it. Max value depends on harware. For AR5210 this is just 7.
 106  * For AR5211+ this seems to be up to 255. */
 107 #define AR5K_TUNE_BMISS_THRES                  7
 108 #define AR5K_TUNE_REGISTER_DWELL_TIME           20000
 109 #define AR5K_TUNE_BEACON_INTERVAL               100
 110 #define AR5K_TUNE_AIFS                          2
 111 #define AR5K_TUNE_AIFS_11B                      2
 112 #define AR5K_TUNE_AIFS_XR                       0
 113 #define AR5K_TUNE_CWMIN                         15
 114 #define AR5K_TUNE_CWMIN_11B                     31
 115 #define AR5K_TUNE_CWMIN_XR                      3
 116 #define AR5K_TUNE_CWMAX                         1023
 117 #define AR5K_TUNE_CWMAX_11B                     1023
 118 #define AR5K_TUNE_CWMAX_XR                      7
 119 #define AR5K_TUNE_NOISE_FLOOR                   -72
 120 #define AR5K_TUNE_MAX_TXPOWER                   60
 121 #define AR5K_TUNE_DEFAULT_TXPOWER               30
 122 #define AR5K_TUNE_TPC_TXPOWER                   true
 123 #define AR5K_TUNE_ANT_DIVERSITY                 true
 124 #define AR5K_TUNE_HWTXTRIES                     4
 125
 126 /* token to use for aifs, cwmin, cwmax in MadWiFi */
 127 #define AR5K_TXQ_USEDEFAULT     ((u32) -1)
 128
 129 /* GENERIC CHIPSET DEFINITIONS */
 130
 131 /* MAC Chips */
 132 enum ath5k_version {
 133         AR5K_AR5210     = 0,
 134         AR5K_AR5211     = 1,
 135         AR5K_AR5212     = 2,
 136 };
 137
 138 /* PHY Chips */
 139 enum ath5k_radio {
 140         AR5K_RF5110     = 0,
 141         AR5K_RF5111     = 1,
 142         AR5K_RF5112     = 2,
 143         AR5K_RF2413     = 3,
 144         AR5K_RF5413     = 4,
 145         AR5K_RF2425     = 5,
 146 };
 147
 148 /*
 149  * Common silicon revision/version values
 150  */
 151
 152 enum ath5k_srev_type {
 153         AR5K_VERSION_VER,
 154         AR5K_VERSION_RAD,
 155 };
 156
 157 struct ath5k_srev_name {
 158         const char              *sr_name;
 159         enum ath5k_srev_type    sr_type;
 160         u_int                   sr_val;
 161 };
 162
 163 #define AR5K_SREV_UNKNOWN       0xffff
 164
 165 #define AR5K_SREV_VER_AR5210    0x00
 166 #define AR5K_SREV_VER_AR5311    0x10
 167 #define AR5K_SREV_VER_AR5311A   0x20
 168 #define AR5K_SREV_VER_AR5311B   0x30
 169 #define AR5K_SREV_VER_AR5211    0x40
 170 #define AR5K_SREV_VER_AR5212    0x50
 171 #define AR5K_SREV_VER_AR5213    0x55
 172 #define AR5K_SREV_VER_AR5213A   0x59
 173 #define AR5K_SREV_VER_AR2413    0x78
 174 #define AR5K_SREV_VER_AR2414    0x79
 175 #define AR5K_SREV_VER_AR2424    0xa0 /* PCI-E */
 176 #define AR5K_SREV_VER_AR5424    0xa3 /* PCI-E */
 177 #define AR5K_SREV_VER_AR5413    0xa4
 178 #define AR5K_SREV_VER_AR5414    0xa5
 179 #define AR5K_SREV_VER_AR5416    0xc0 /* PCI-E */
 180 #define AR5K_SREV_VER_AR5418    0xca /* PCI-E */
 181 #define AR5K_SREV_VER_AR2425    0xe2 /* PCI-E */
 182
 183 #define AR5K_SREV_RAD_5110      0x00
 184 #define AR5K_SREV_RAD_5111      0x10
 185 #define AR5K_SREV_RAD_5111A     0x15
 186 #define AR5K_SREV_RAD_2111      0x20
 187 #define AR5K_SREV_RAD_5112      0x30
 188 #define AR5K_SREV_RAD_5112A     0x35
 189 #define AR5K_SREV_RAD_2112      0x40
 190 #define AR5K_SREV_RAD_2112A     0x45
 191 #define AR5K_SREV_RAD_SC0       0x56    /* Found on 2413/2414 */
 192 #define AR5K_SREV_RAD_SC1       0x63    /* Found on 5413/5414 */
 193 #define AR5K_SREV_RAD_SC2       0xa2    /* Found on 2424-5/5424 */
 194 #define AR5K_SREV_RAD_5133      0xc0    /* MIMO found on 5418 */
 195
 196 /* IEEE defs */
 197
 198 #define IEEE80211_MAX_LEN       2500
 199
 200 /* TODO add support to mac80211 for vendor-specific rates and modes */
 201
 202 /*
 203  * Some of this information is based on Documentation from:
 204  *
 205  * http://madwifi.org/wiki/ChipsetFeatures/SuperAG
 206  *
 207  * Modulation for Atheros' eXtended Range - range enhancing extension that is
 208  * supposed to double the distance an Atheros client device can keep a
 209  * connection with an Atheros access point. This is achieved by increasing
 210  * the receiver sensitivity up to, -105dBm, which is about 20dB above what
 211  * the 802.11 specifications demand. In addition, new (proprietary) data rates
 212  * are introduced: 3, 2, 1, 0.5 and 0.25 MBit/s.
 213  *
 214  * Please note that can you either use XR or TURBO but you cannot use both,
 215  * they are exclusive.
 216  *
 217  */
 218 #define MODULATION_XR           0x00000200
 219 /*
 220  * Modulation for Atheros' Turbo G and Turbo A, its supposed to provide a
 221  * throughput transmission speed up to 40Mbit/s-60Mbit/s at a 108Mbit/s
 222  * signaling rate achieved through the bonding of two 54Mbit/s 802.11g
 223  * channels. To use this feature your Access Point must also suport it.
 224  * There is also a distinction between "static" and "dynamic" turbo modes:
 225  *
 226  * - Static: is the dumb version: devices set to this mode stick to it until
 227  *     the mode is turned off.
 228  * - Dynamic: is the intelligent version, the network decides itself if it
 229  *     is ok to use turbo. As soon as traffic is detected on adjacent channels
 230  *     (which would get used in turbo mode), or when a non-turbo station joins
 231  *     the network, turbo mode won't be used until the situation changes again.
 232  *     Dynamic mode is achieved by Atheros' Adaptive Radio (AR) feature which
 233  *     monitors the used radio band in order to decide whether turbo mode may
 234  *     be used or not.
 235  *
 236  * This article claims Super G sticks to bonding of channels 5 and 6 for
 237  * USA:
 238  *
 239  * http://www.pcworld.com/article/id,113428-page,1/article.html
 240  *
 241  * The channel bonding seems to be driver specific though. In addition to
 242  * deciding what channels will be used, these "Turbo" modes are accomplished
 243  * by also enabling the following features:
 244  *
 245  * - Bursting: allows multiple frames to be sent at once, rather than pausing
 246  *     after each frame. Bursting is a standards-compliant feature that can be
 247  *     used with any Access Point.
 248  * - Fast frames: increases the amount of information that can be sent per
 249  *     frame, also resulting in a reduction of transmission overhead. It is a
 250  *     proprietary feature that needs to be supported by the Access Point.
 251  * - Compression: data frames are compressed in real time using a Lempel Ziv
 252  *     algorithm. This is done transparently. Once this feature is enabled,
 253  *     compression and decompression takes place inside the chipset, without
 254  *     putting additional load on the host CPU.
 255  *
 256  */
 257 #define MODULATION_TURBO        0x00000080
 258
 259 enum ath5k_driver_mode {
 260         AR5K_MODE_11A           =       0,
 261         AR5K_MODE_11A_TURBO     =       1,
 262         AR5K_MODE_11B           =       2,
 263         AR5K_MODE_11G           =       3,
 264         AR5K_MODE_11G_TURBO     =       4,
 265         AR5K_MODE_XR            =       0,
 266         AR5K_MODE_MAX           =       5
 267 };
 268
 269 /* adding this flag to rate_code enables short preamble, see ar5212_reg.h */
 270 #define AR5K_SET_SHORT_PREAMBLE 0x04
 271
 272 #define HAS_SHPREAMBLE(_ix) \
 273         (rt->rates[_ix].modulation == IEEE80211_RATE_SHORT_PREAMBLE)
 274 #define SHPREAMBLE_FLAG(_ix) \
 275         (HAS_SHPREAMBLE(_ix) ? AR5K_SET_SHORT_PREAMBLE : 0)
 276
 277
 278 /****************\
 279   TX DEFINITIONS
 280 \****************/
 281
 282 /*
 283  * TX Status
 284  */
 285 struct ath5k_tx_status {
 286         u16     ts_seqnum;
 287         u16     ts_tstamp;
 288         u8      ts_status;
 289         u8      ts_rate;
 290         s8      ts_rssi;
 291         u8      ts_shortretry;
 292         u8      ts_longretry;
 293         u8      ts_virtcol;
 294         u8      ts_antenna;
 295 };
 296
 297 #define AR5K_TXSTAT_ALTRATE     0x80
 298 #define AR5K_TXERR_XRETRY       0x01
 299 #define AR5K_TXERR_FILT         0x02
 300 #define AR5K_TXERR_FIFO         0x04
 301
 302 /**
 303  * enum ath5k_tx_queue - Queue types used to classify tx queues.
 304  * @AR5K_TX_QUEUE_INACTIVE: q is unused -- see ath5k_hw_release_tx_queue
 305  * @AR5K_TX_QUEUE_DATA: A normal data queue
 306  * @AR5K_TX_QUEUE_XR_DATA: An XR-data queue
 307  * @AR5K_TX_QUEUE_BEACON: The beacon queue
 308  * @AR5K_TX_QUEUE_CAB: The after-beacon queue
 309  * @AR5K_TX_QUEUE_UAPSD: Unscheduled Automatic Power Save Delivery queue
 310  */
 311 enum ath5k_tx_queue {
 312         AR5K_TX_QUEUE_INACTIVE = 0,
 313         AR5K_TX_QUEUE_DATA,
 314         AR5K_TX_QUEUE_XR_DATA,
 315         AR5K_TX_QUEUE_BEACON,
 316         AR5K_TX_QUEUE_CAB,
 317         AR5K_TX_QUEUE_UAPSD,
 318 };
 319
 320 #define AR5K_NUM_TX_QUEUES              10
 321 #define AR5K_NUM_TX_QUEUES_NOQCU        2
 322
 323 /*
 324  * Queue syb-types to classify normal data queues.
 325  * These are the 4 Access Categories as defined in
 326  * WME spec. 0 is the lowest priority and 4 is the
 327  * highest. Normal data that hasn't been classified
 328  * goes to the Best Effort AC.
 329  */
 330 enum ath5k_tx_queue_subtype {
 331         AR5K_WME_AC_BK = 0,     /*Background traffic*/
 332         AR5K_WME_AC_BE,         /*Best-effort (normal) traffic)*/
 333         AR5K_WME_AC_VI,         /*Video traffic*/
 334         AR5K_WME_AC_VO,         /*Voice traffic*/
 335 };
 336
 337 /*
 338  * Queue ID numbers as returned by the hw functions, each number
 339  * represents a hw queue. If hw does not support hw queues
 340  * (eg 5210) all data goes in one queue. These match
 341  * d80211 definitions (net80211/MadWiFi don't use them).
 342  */
 343 enum ath5k_tx_queue_id {
 344         AR5K_TX_QUEUE_ID_NOQCU_DATA     = 0,
 345         AR5K_TX_QUEUE_ID_NOQCU_BEACON   = 1,
 346         AR5K_TX_QUEUE_ID_DATA_MIN       = 0, /*IEEE80211_TX_QUEUE_DATA0*/
 347         AR5K_TX_QUEUE_ID_DATA_MAX       = 4, /*IEEE80211_TX_QUEUE_DATA4*/
 348         AR5K_TX_QUEUE_ID_DATA_SVP       = 5, /*IEEE80211_TX_QUEUE_SVP - Spectralink Voice Protocol*/
 349         AR5K_TX_QUEUE_ID_CAB            = 6, /*IEEE80211_TX_QUEUE_AFTER_BEACON*/
 350         AR5K_TX_QUEUE_ID_BEACON         = 7, /*IEEE80211_TX_QUEUE_BEACON*/
 351         AR5K_TX_QUEUE_ID_UAPSD          = 8,
 352         AR5K_TX_QUEUE_ID_XR_DATA        = 9,
 353 };
 354
 355
 356 /*
 357  * Flags to set hw queue's parameters...
 358  */
 359 #define AR5K_TXQ_FLAG_TXOKINT_ENABLE            0x0001  /* Enable TXOK interrupt */
 360 #define AR5K_TXQ_FLAG_TXERRINT_ENABLE           0x0002  /* Enable TXERR interrupt */
 361 #define AR5K_TXQ_FLAG_TXEOLINT_ENABLE           0x0004  /* Enable TXEOL interrupt -not used- */
 362 #define AR5K_TXQ_FLAG_TXDESCINT_ENABLE          0x0008  /* Enable TXDESC interrupt -not used- */
 363 #define AR5K_TXQ_FLAG_TXURNINT_ENABLE           0x0010  /* Enable TXURN interrupt */
 364 #define AR5K_TXQ_FLAG_BACKOFF_DISABLE           0x0020  /* Disable random post-backoff */
 365 #define AR5K_TXQ_FLAG_RDYTIME_EXP_POLICY_ENABLE 0x0040  /* Enable ready time expiry policy (?)*/
 366 #define AR5K_TXQ_FLAG_FRAG_BURST_BACKOFF_ENABLE 0x0080  /* Enable backoff while bursting */
 367 #define AR5K_TXQ_FLAG_POST_FR_BKOFF_DIS         0x0100  /* Disable backoff while bursting */
 368 #define AR5K_TXQ_FLAG_COMPRESSION_ENABLE        0x0200  /* Enable hw compression -not implemented-*/
 369
 370 /*
 371  * A struct to hold tx queue's parameters
 372  */
 373 struct ath5k_txq_info {
 374         enum ath5k_tx_queue tqi_type;
 375         enum ath5k_tx_queue_subtype tqi_subtype;
 376         u16     tqi_flags;      /* Tx queue flags (see above) */
 377         u32     tqi_aifs;       /* Arbitrated Interframe Space */
 378         s32     tqi_cw_min;     /* Minimum Contention Window */
 379         s32     tqi_cw_max;     /* Maximum Contention Window */
 380         u32     tqi_cbr_period; /* Constant bit rate period */
 381         u32     tqi_cbr_overflow_limit;
 382         u32     tqi_burst_time;
 383         u32     tqi_ready_time; /* Not used */
 384 };
 385
 386 /*
 387  * Transmit packet types.
 388  * These are not fully used inside OpenHAL yet
 389  */
 390 enum ath5k_pkt_type {
 391         AR5K_PKT_TYPE_NORMAL            = 0,
 392         AR5K_PKT_TYPE_ATIM              = 1,
 393         AR5K_PKT_TYPE_PSPOLL            = 2,
 394         AR5K_PKT_TYPE_BEACON            = 3,
 395         AR5K_PKT_TYPE_PROBE_RESP        = 4,
 396         AR5K_PKT_TYPE_PIFS              = 5,
 397 };
 398
 399 /*
 400  * TX power and TPC settings
 401  */
 402 #define AR5K_TXPOWER_OFDM(_r, _v)       (                       \
 403         ((0 & 1) << ((_v) + 6)) |                               \
 404         (((ah->ah_txpower.txp_rates[(_r)]) & 0x3f) << (_v))     \
 405 )
 406
 407 #define AR5K_TXPOWER_CCK(_r, _v)        (                       \
 408         (ah->ah_txpower.txp_rates[(_r)] & 0x3f) << (_v) \
 409 )
 410
 411 /*
 412  * DMA size definitions (2^n+2)
 413  */
 414 enum ath5k_dmasize {
 415         AR5K_DMASIZE_4B = 0,
 416         AR5K_DMASIZE_8B,
 417         AR5K_DMASIZE_16B,
 418         AR5K_DMASIZE_32B,
 419         AR5K_DMASIZE_64B,
 420         AR5K_DMASIZE_128B,
 421         AR5K_DMASIZE_256B,
 422         AR5K_DMASIZE_512B
 423 };
 424
 425
 426 /****************\
 427   RX DEFINITIONS
 428 \****************/
 429
 430 /*
 431  * RX Status
 432  */
 433 struct ath5k_rx_status {
 434         u16     rs_datalen;
 435         u16     rs_tstamp;
 436         u8      rs_status;
 437         u8      rs_phyerr;
 438         s8      rs_rssi;
 439         u8      rs_keyix;
 440         u8      rs_rate;
 441         u8      rs_antenna;
 442         u8      rs_more;
 443 };
 444
 445 #define AR5K_RXERR_CRC          0x01
 446 #define AR5K_RXERR_PHY          0x02
 447 #define AR5K_RXERR_FIFO         0x04
 448 #define AR5K_RXERR_DECRYPT      0x08
 449 #define AR5K_RXERR_MIC          0x10
 450 #define AR5K_RXKEYIX_INVALID    ((u8) - 1)
 451 #define AR5K_TXKEYIX_INVALID    ((u32) - 1)
 452
 453
 454 /**************************\
 455  BEACON TIMERS DEFINITIONS
 456 \**************************/
 457
 458 #define AR5K_BEACON_PERIOD      0x0000ffff
 459 #define AR5K_BEACON_ENA         0x00800000 /*enable beacon xmit*/
 460 #define AR5K_BEACON_RESET_TSF   0x01000000 /*force a TSF reset*/
 461
 462 #if 0
 463 /**
 464  * struct ath5k_beacon_state - Per-station beacon timer state.
 465  * @bs_interval: in TU's, can also include the above flags
 466  * @bs_cfp_max_duration: if non-zero hw is setup to coexist with a
 467  *      Point Coordination Function capable AP
 468  */
 469 struct ath5k_beacon_state {
 470         u32     bs_next_beacon;
 471         u32     bs_next_dtim;
 472         u32     bs_interval;
 473         u8      bs_dtim_period;
 474         u8      bs_cfp_period;
 475         u16     bs_cfp_max_duration;
 476         u16     bs_cfp_du_remain;
 477         u16     bs_tim_offset;
 478         u16     bs_sleep_duration;
 479         u16     bs_bmiss_threshold;
 480         u32     bs_cfp_next;
 481 };
 482 #endif
 483
 484
 485 /*
 486  * TSF to TU conversion:
 487  *
 488  * TSF is a 64bit value in usec (microseconds).
 489  * TU is a 32bit value and defined by IEEE802.11 (page 6) as "A measurement of
 490  * time equal to 1024 usec", so it's roughly milliseconds (usec / 1024).
 491  */
 492 #define TSF_TO_TU(_tsf) (u32)((_tsf) >> 10)
 493
 494
 495 /********************\
 496   COMMON DEFINITIONS
 497 \********************/
 498
 499 /*
 500  * Atheros hardware descriptor
 501  * This is read and written to by the hardware
 502  */
 503 struct ath5k_desc {
 504         u32     ds_link;        /* physical address of the next descriptor */
 505         u32     ds_data;        /* physical address of data buffer (skb) */
 506
 507         union {
 508                 struct ath5k_hw_5210_tx_desc    ds_tx5210;
 509                 struct ath5k_hw_5212_tx_desc    ds_tx5212;
 510                 struct ath5k_hw_all_rx_desc     ds_rx;
 511         } ud;
 512 } __packed;
 513
 514 #define AR5K_RXDESC_INTREQ      0x0020
 515
 516 #define AR5K_TXDESC_CLRDMASK    0x0001
 517 #define AR5K_TXDESC_NOACK       0x0002  /*[5211+]*/
 518 #define AR5K_TXDESC_RTSENA      0x0004
 519 #define AR5K_TXDESC_CTSENA      0x0008
 520 #define AR5K_TXDESC_INTREQ      0x0010
 521 #define AR5K_TXDESC_VEOL        0x0020  /*[5211+]*/
 522
 523 #define AR5K_SLOT_TIME_9        396
 524 #define AR5K_SLOT_TIME_20       880
 525 #define AR5K_SLOT_TIME_MAX      0xffff
 526
 527 /* channel_flags */
 528 #define CHANNEL_CW_INT  0x0008  /* Contention Window interference detected */
 529 #define CHANNEL_TURBO   0x0010  /* Turbo Channel */
 530 #define CHANNEL_CCK     0x0020  /* CCK channel */
 531 #define CHANNEL_OFDM    0x0040  /* OFDM channel */
 532 #define CHANNEL_2GHZ    0x0080  /* 2GHz channel. */
 533 #define CHANNEL_5GHZ    0x0100  /* 5GHz channel */
 534 #define CHANNEL_PASSIVE 0x0200  /* Only passive scan allowed */
 535 #define CHANNEL_DYN     0x0400  /* Dynamic CCK-OFDM channel (for g operation) */
 536 #define CHANNEL_XR      0x0800  /* XR channel */
 537
 538 #define CHANNEL_A       (CHANNEL_5GHZ|CHANNEL_OFDM)
 539 #define CHANNEL_B       (CHANNEL_2GHZ|CHANNEL_CCK)
 540 #define CHANNEL_G       (CHANNEL_2GHZ|CHANNEL_OFDM)
 541 #define CHANNEL_T       (CHANNEL_5GHZ|CHANNEL_OFDM|CHANNEL_TURBO)
 542 #define CHANNEL_TG      (CHANNEL_2GHZ|CHANNEL_OFDM|CHANNEL_TURBO)
 543 #define CHANNEL_108A    CHANNEL_T
 544 #define CHANNEL_108G    CHANNEL_TG
 545 #define CHANNEL_X       (CHANNEL_5GHZ|CHANNEL_OFDM|CHANNEL_XR)
 546
 547 #define CHANNEL_ALL     (CHANNEL_OFDM|CHANNEL_CCK|CHANNEL_2GHZ|CHANNEL_5GHZ| \
 548                 CHANNEL_TURBO)
 549
 550 #define CHANNEL_ALL_NOTURBO     (CHANNEL_ALL & ~CHANNEL_TURBO)
 551 #define CHANNEL_MODES           CHANNEL_ALL
 552
 553 /*
 554  * Used internaly in OpenHAL (ar5211.c/ar5212.c
 555  * for reset_tx_queue). Also see struct struct ieee80211_channel.
 556  */
 557 #define IS_CHAN_XR(_c)  ((_c.hw_value & CHANNEL_XR) != 0)
 558 #define IS_CHAN_B(_c)   ((_c.hw_value & CHANNEL_B) != 0)
 559
 560 /*
 561  * The following structure will be used to map 2GHz channels to
 562  * 5GHz Atheros channels.
 563  */
 564 struct ath5k_athchan_2ghz {
 565         u32     a2_flags;
 566         u16     a2_athchan;
 567 };
 568
 569 /*
 570  * Rate definitions
 571  * TODO: Clean them up or move them on mac80211 -most of these infos are
 572  *       used by the rate control algorytm on MadWiFi.
 573  */
 574
 575 /* Max number of rates on the rate table and what it seems
 576  * Atheros hardware supports */
 577 #define AR5K_MAX_RATES 32
 578
 579 /**
 580  * struct ath5k_rate - rate structure
 581  * @valid: is this a valid rate for rate control (remove)
 582  * @modulation: respective mac80211 modulation
 583  * @rate_kbps: rate in kbit/s
 584  * @rate_code: hardware rate value, used in &struct ath5k_desc, on RX on
 585  *     &struct ath5k_rx_status.rs_rate and on TX on
 586  *     &struct ath5k_tx_status.ts_rate. Seems the ar5xxx harware supports
 587  *     up to 32 rates, indexed by 1-32. This means we really only need
 588  *     6 bits for the rate_code.
 589  * @dot11_rate: respective IEEE-802.11 rate value
 590  * @control_rate: index of rate assumed to be used to send control frames.
 591  *     This can be used to set override the value on the rate duration
 592  *     registers. This is only useful if we can override in the harware at
 593  *     what rate we want to send control frames at. Note that IEEE-802.11
 594  *     Ch. 9.6 (after IEEE 802.11g changes) defines the rate at which we
 595  *     should send ACK/CTS, if we change this value we can be breaking
 596  *     the spec.
 597  *
 598  * This structure is used to get the RX rate or set the TX rate on the
 599  * hardware descriptors. It is also used for internal modulation control
 600  * and settings.
 601  *
 602  * On RX after the &struct ath5k_desc is parsed by the appropriate
 603  * ah_proc_rx_desc() the respective hardware rate value is set in
 604  * &struct ath5k_rx_status.rs_rate. On TX the desired rate is set in
 605  * &struct ath5k_tx_status.ts_rate which is later used to setup the
 606  * &struct ath5k_desc correctly. This is the hardware rate map we are
 607  * aware of:
 608  *
 609  * rate_code   1       2       3       4       5       6       7       8
 610  * rate_kbps   3000    1000    ?       ?       ?       2000    500     48000
 611  *
 612  * rate_code   9       10      11      12      13      14      15      16
 613  * rate_kbps   24000   12000   6000    54000   36000   18000   9000    ?
 614  *
 615  * rate_code   17      18      19      20      21      22      23      24
 616  * rate_kbps   ?       ?       ?       ?       ?       ?       ?       11000
 617  *
 618  * rate_code   25      26      27      28      29      30      31      32
 619  * rate_kbps   5500    2000    1000    ?       ?       ?       ?       ?
 620  *
 621  */
 622 struct ath5k_rate {
 623         u8      valid;
 624         u32     modulation;
 625         u16     rate_kbps;
 626         u8      rate_code;
 627         u8      dot11_rate;
 628         u8      control_rate;
 629 };
 630
 631 /* XXX: GRR all this stuff to get leds blinking ??? (check out setcurmode) */
 632 struct ath5k_rate_table {
 633         u16     rate_count;
 634         u8      rate_code_to_index[AR5K_MAX_RATES];     /* Back-mapping */
 635         struct ath5k_rate rates[AR5K_MAX_RATES];
 636 };
 637
 638 /*
 639  * Rate tables...
 640  * TODO: CLEAN THIS !!!
 641  */
 642 #define AR5K_RATES_11A { 8, {                                   \
 643         255, 255, 255, 255, 255, 255, 255, 255, 6, 4, 2, 0,     \
 644         7, 5, 3, 1, 255, 255, 255, 255, 255, 255, 255, 255,     \
 645         255, 255, 255, 255, 255, 255, 255, 255 }, {             \
 646         { 1, 0, 6000, 11, 140, 0 },             \
 647         { 1, 0, 9000, 15, 18, 0 },              \
 648         { 1, 0, 12000, 10, 152, 2 },            \
 649         { 1, 0, 18000, 14, 36, 2 },             \
 650         { 1, 0, 24000, 9, 176, 4 },             \
 651         { 1, 0, 36000, 13, 72, 4 },             \
 652         { 1, 0, 48000, 8, 96, 4 },              \
 653         { 1, 0, 54000, 12, 108, 4 } }           \
 654 }
 655
 656 #define AR5K_RATES_11B { 4, {                                           \
 657         255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,     \
 658         255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,     \
 659         3, 2, 1, 0, 255, 255, 255, 255 }, {                             \
 660         { 1, 0, 1000, 27, 130, 0 },     \
 661         { 1, IEEE80211_RATE_SHORT_PREAMBLE, 2000, 26, 132, 1 }, \
 662         { 1, IEEE80211_RATE_SHORT_PREAMBLE, 5500, 25, 139, 1 }, \
 663         { 1, IEEE80211_RATE_SHORT_PREAMBLE, 11000, 24, 150, 1 } }       \
 664 }
 665
 666 #define AR5K_RATES_11G { 12, {                                  \
 667         255, 255, 255, 255, 255, 255, 255, 255, 10, 8, 6, 4,    \
 668         11, 9, 7, 5, 255, 255, 255, 255, 255, 255, 255, 255,    \
 669         3, 2, 1, 0, 255, 255, 255, 255 }, {                     \
 670         { 1, 0, 1000, 27, 2, 0 },               \
 671         { 1, IEEE80211_RATE_SHORT_PREAMBLE, 2000, 26, 4, 1 },           \
 672         { 1, IEEE80211_RATE_SHORT_PREAMBLE, 5500, 25, 11, 1 },          \
 673         { 1, IEEE80211_RATE_SHORT_PREAMBLE, 11000, 24, 22, 1 }, \
 674         { 0, 0, 6000, 11, 12, 4 },      \
 675         { 0, 0, 9000, 15, 18, 4 },      \
 676         { 1, 0, 12000, 10, 24, 6 },     \
 677         { 1, 0, 18000, 14, 36, 6 },     \
 678         { 1, 0, 24000, 9, 48, 8 },      \
 679         { 1, 0, 36000, 13, 72, 8 },     \
 680         { 1, 0, 48000, 8, 96, 8 },      \
 681         { 1, 0, 54000, 12, 108, 8 } }   \
 682 }
 683
 684 #define AR5K_RATES_TURBO { 8, {                                 \
 685         255, 255, 255, 255, 255, 255, 255, 255, 6, 4, 2, 0,     \
 686         7, 5, 3, 1, 255, 255, 255, 255, 255, 255, 255, 255,     \
 687         255, 255, 255, 255, 255, 255, 255, 255 }, {             \
 688         { 1, MODULATION_TURBO, 6000, 11, 140, 0 },      \
 689         { 1, MODULATION_TURBO, 9000, 15, 18, 0 },       \
 690         { 1, MODULATION_TURBO, 12000, 10, 152, 2 },     \
 691         { 1, MODULATION_TURBO, 18000, 14, 36, 2 },      \
 692         { 1, MODULATION_TURBO, 24000, 9, 176, 4 },      \
 693         { 1, MODULATION_TURBO, 36000, 13, 72, 4 },      \
 694         { 1, MODULATION_TURBO, 48000, 8, 96, 4 },       \
 695         { 1, MODULATION_TURBO, 54000, 12, 108, 4 } }    \
 696 }
 697
 698 #define AR5K_RATES_XR { 12, {                                   \
 699         255, 3, 1, 255, 255, 255, 2, 0, 10, 8, 6, 4,            \
 700         11, 9, 7, 5, 255, 255, 255, 255, 255, 255, 255, 255,    \
 701         255, 255, 255, 255, 255, 255, 255, 255 }, {             \
 702         { 1, MODULATION_XR, 500, 7, 129, 0 },           \
 703         { 1, MODULATION_XR, 1000, 2, 139, 1 },          \
 704         { 1, MODULATION_XR, 2000, 6, 150, 2 },          \
 705         { 1, MODULATION_XR, 3000, 1, 150, 3 },          \
 706         { 1, 0, 6000, 11, 140, 4 },     \
 707         { 1, 0, 9000, 15, 18, 4 },      \
 708         { 1, 0, 12000, 10, 152, 6 },    \
 709         { 1, 0, 18000, 14, 36, 6 },     \
 710         { 1, 0, 24000, 9, 176, 8 },     \
 711         { 1, 0, 36000, 13, 72, 8 },     \
 712         { 1, 0, 48000, 8, 96, 8 },      \
 713         { 1, 0, 54000, 12, 108, 8 } }   \
 714 }
 715
 716 /*
 717  * Crypto definitions
 718  */
 719
 720 #define AR5K_KEYCACHE_SIZE      8
 721
 722 /***********************\
 723  HW RELATED DEFINITIONS
 724 \***********************/
 725
 726 /*
 727  * Misc definitions
 728  */
 729 #define AR5K_RSSI_EP_MULTIPLIER (1<<7)
 730
 731 #define AR5K_ASSERT_ENTRY(_e, _s) do {          \
 732         if (_e >= _s)                           \
 733                 return (false);                 \
 734 } while (0)
 735
 736
 737 enum ath5k_ant_setting {
 738         AR5K_ANT_VARIABLE       = 0,    /* variable by programming */
 739         AR5K_ANT_FIXED_A        = 1,    /* fixed to 11a frequencies */
 740         AR5K_ANT_FIXED_B        = 2,    /* fixed to 11b frequencies */
 741         AR5K_ANT_MAX            = 3,
 742 };
 743
 744 /*
 745  * Hardware interrupt abstraction
 746  */
 747
 748 /**
 749  * enum ath5k_int - Hardware interrupt masks helpers
 750  *
 751  * @AR5K_INT_RX: mask to identify received frame interrupts, of type
 752  *      AR5K_ISR_RXOK or AR5K_ISR_RXERR
 753  * @AR5K_INT_RXDESC: Request RX descriptor/Read RX descriptor (?)
 754  * @AR5K_INT_RXNOFRM: No frame received (?)
 755  * @AR5K_INT_RXEOL: received End Of List for VEOL (Virtual End Of List). The
 756  *      Queue Control Unit (QCU) signals an EOL interrupt only if a descriptor's
 757  *      LinkPtr is NULL. For more details, refer to:
 758  *      http://www.freepatentsonline.com/20030225739.html
 759  * @AR5K_INT_RXORN: Indicates we got RX overrun (eg. no more descriptors).
 760  *      Note that Rx overrun is not always fatal, on some chips we can continue
 761  *      operation without reseting the card, that's why int_fatal is not
 762  *      common for all chips.
 763  * @AR5K_INT_TX: mask to identify received frame interrupts, of type
 764  *      AR5K_ISR_TXOK or AR5K_ISR_TXERR
 765  * @AR5K_INT_TXDESC: Request TX descriptor/Read TX status descriptor (?)
 766  * @AR5K_INT_TXURN: received when we should increase the TX trigger threshold
 767  *      We currently do increments on interrupt by
 768  *      (AR5K_TUNE_MAX_TX_FIFO_THRES - current_trigger_level) / 2
 769  * @AR5K_INT_MIB: Indicates the Management Information Base counters should be
 770  *      checked. We should do this with ath5k_hw_update_mib_counters() but
 771  *      it seems we should also then do some noise immunity work.
 772  * @AR5K_INT_RXPHY: RX PHY Error
 773  * @AR5K_INT_RXKCM: ??
 774  * @AR5K_INT_SWBA: SoftWare Beacon Alert - indicates its time to send a
 775  *      beacon that must be handled in software. The alternative is if you
 776  *      have VEOL support, in that case you let the hardware deal with things.
 777  * @AR5K_INT_BMISS: If in STA mode this indicates we have stopped seeing
 778  *      beacons from the AP have associated with, we should probably try to
 779  *      reassociate. When in IBSS mode this might mean we have not received
 780  *      any beacons from any local stations. Note that every station in an
 781  *      IBSS schedules to send beacons at the Target Beacon Transmission Time
 782  *      (TBTT) with a random backoff.
 783  * @AR5K_INT_BNR: Beacon Not Ready interrupt - ??
 784  * @AR5K_INT_GPIO: GPIO interrupt is used for RF Kill, disabled for now
 785  *      until properly handled
 786  * @AR5K_INT_FATAL: Fatal errors were encountered, typically caused by DMA
 787  *      errors. These types of errors we can enable seem to be of type
 788  *      AR5K_SIMR2_MCABT, AR5K_SIMR2_SSERR and AR5K_SIMR2_DPERR.
 789  * @AR5K_INT_GLOBAL: Seems to be used to clear and set the IER
 790  * @AR5K_INT_NOCARD: signals the card has been removed
 791  * @AR5K_INT_COMMON: common interrupts shared amogst MACs with the same
 792  *      bit value
 793  *
 794  * These are mapped to take advantage of some common bits
 795  * between the MACs, to be able to set intr properties
 796  * easier. Some of them are not used yet inside hw.c. Most map
 797  * to the respective hw interrupt value as they are common amogst different
 798  * MACs.
 799  */
 800 enum ath5k_int {
 801         AR5K_INT_RX     = 0x00000001, /* Not common */
 802         AR5K_INT_RXDESC = 0x00000002,
 803         AR5K_INT_RXNOFRM = 0x00000008,
 804         AR5K_INT_RXEOL  = 0x00000010,
 805         AR5K_INT_RXORN  = 0x00000020,
 806         AR5K_INT_TX     = 0x00000040, /* Not common */
 807         AR5K_INT_TXDESC = 0x00000080,
 808         AR5K_INT_TXURN  = 0x00000800,
 809         AR5K_INT_MIB    = 0x00001000,
 810         AR5K_INT_RXPHY  = 0x00004000,
 811         AR5K_INT_RXKCM  = 0x00008000,
 812         AR5K_INT_SWBA   = 0x00010000,
 813         AR5K_INT_BMISS  = 0x00040000,
 814         AR5K_INT_BNR    = 0x00100000, /* Not common */
 815         AR5K_INT_GPIO   = 0x01000000,
 816         AR5K_INT_FATAL  = 0x40000000, /* Not common */
 817         AR5K_INT_GLOBAL = 0x80000000,
 818
 819         AR5K_INT_COMMON  = AR5K_INT_RXNOFRM
 820                         | AR5K_INT_RXDESC
 821                         | AR5K_INT_RXEOL
 822                         | AR5K_INT_RXORN
 823                         | AR5K_INT_TXURN
 824                         | AR5K_INT_TXDESC
 825                         | AR5K_INT_MIB
 826                         | AR5K_INT_RXPHY
 827                         | AR5K_INT_RXKCM
 828                         | AR5K_INT_SWBA
 829                         | AR5K_INT_BMISS
 830                         | AR5K_INT_GPIO,
 831         AR5K_INT_NOCARD = 0xffffffff
 832 };
 833
 834 /*
 835  * Power management
 836  */
 837 enum ath5k_power_mode {
 838         AR5K_PM_UNDEFINED = 0,
 839         AR5K_PM_AUTO,
 840         AR5K_PM_AWAKE,
 841         AR5K_PM_FULL_SLEEP,
 842         AR5K_PM_NETWORK_SLEEP,
 843 };
 844
 845 /*
 846  * These match net80211 definitions (not used in
 847  * d80211).
 848  */
 849 #define AR5K_LED_INIT   0 /*IEEE80211_S_INIT*/
 850 #define AR5K_LED_SCAN   1 /*IEEE80211_S_SCAN*/
 851 #define AR5K_LED_AUTH   2 /*IEEE80211_S_AUTH*/
 852 #define AR5K_LED_ASSOC  3 /*IEEE80211_S_ASSOC*/
 853 #define AR5K_LED_RUN    4 /*IEEE80211_S_RUN*/
 854
 855 /* GPIO-controlled software LED */
 856 #define AR5K_SOFTLED_PIN        0
 857 #define AR5K_SOFTLED_ON         0
 858 #define AR5K_SOFTLED_OFF        1
 859
 860 /*
 861  * Chipset capabilities -see ath5k_hw_get_capability-
 862  * get_capability function is not yet fully implemented
 863  * in OpenHAL so most of these don't work yet...
 864  */
 865 enum ath5k_capability_type {
 866         AR5K_CAP_REG_DMN                = 0,    /* Used to get current reg. domain id */
 867         AR5K_CAP_TKIP_MIC               = 2,    /* Can handle TKIP MIC in hardware */
 868         AR5K_CAP_TKIP_SPLIT             = 3,    /* TKIP uses split keys */
 869         AR5K_CAP_PHYCOUNTERS            = 4,    /* PHY error counters */
 870         AR5K_CAP_DIVERSITY              = 5,    /* Supports fast diversity */
 871         AR5K_CAP_NUM_TXQUEUES           = 6,    /* Used to get max number of hw txqueues */
 872         AR5K_CAP_VEOL                   = 7,    /* Supports virtual EOL */
 873         AR5K_CAP_COMPRESSION            = 8,    /* Supports compression */
 874         AR5K_CAP_BURST                  = 9,    /* Supports packet bursting */
 875         AR5K_CAP_FASTFRAME              = 10,   /* Supports fast frames */
 876         AR5K_CAP_TXPOW                  = 11,   /* Used to get global tx power limit */
 877         AR5K_CAP_TPC                    = 12,   /* Can do per-packet tx power control (needed for 802.11a) */
 878         AR5K_CAP_BSSIDMASK              = 13,   /* Supports bssid mask */
 879         AR5K_CAP_MCAST_KEYSRCH          = 14,   /* Supports multicast key search */
 880         AR5K_CAP_TSF_ADJUST             = 15,   /* Supports beacon tsf adjust */
 881         AR5K_CAP_XR                     = 16,   /* Supports XR mode */
 882         AR5K_CAP_WME_TKIPMIC            = 17,   /* Supports TKIP MIC when using WMM */
 883         AR5K_CAP_CHAN_HALFRATE          = 18,   /* Supports half rate channels */
 884         AR5K_CAP_CHAN_QUARTERRATE       = 19,   /* Supports quarter rate channels */
 885         AR5K_CAP_RFSILENT               = 20,   /* Supports RFsilent */
 886 };
 887
 888
 889 /* XXX: we *may* move cap_range stuff to struct wiphy */
 890 struct ath5k_capabilities {
 891         /*
 892          * Supported PHY modes
 893          * (ie. CHANNEL_A, CHANNEL_B, ...)
 894          */
 895         DECLARE_BITMAP(cap_mode, AR5K_MODE_MAX);
 896
 897         /*
 898          * Frequency range (without regulation restrictions)
 899          */
 900         struct {
 901                 u16     range_2ghz_min;
 902                 u16     range_2ghz_max;
 903                 u16     range_5ghz_min;
 904                 u16     range_5ghz_max;
 905         } cap_range;
 906
 907         /*
 908          * Values stored in the EEPROM (some of them...)
 909          */
 910         struct ath5k_eeprom_info        cap_eeprom;
 911
 912         /*
 913          * Queue information
 914          */
 915         struct {
 916                 u8      q_tx_num;
 917         } cap_queues;
 918 };
 919
 920
 921 /***************************************\
 922   HARDWARE ABSTRACTION LAYER STRUCTURE
 923 \***************************************/
 924
 925 /*
 926  * Misc defines
 927  */
 928
 929 #define AR5K_MAX_GPIO           10
 930 #define AR5K_MAX_RF_BANKS       8
 931
 932 struct ath5k_hw {
 933         u32                     ah_magic;
 934
 935         struct ath5k_softc      *ah_sc;
 936         void __iomem            *ah_iobase;
 937
 938         enum ath5k_int          ah_imr;
 939
 940         enum ieee80211_if_types ah_op_mode;
 941         enum ath5k_power_mode   ah_power_mode;
 942         struct ieee80211_channel ah_current_channel;
 943         bool                    ah_turbo;
 944         bool                    ah_calibration;
 945         bool                    ah_running;
 946         bool                    ah_single_chip;
 947         enum ath5k_rfgain       ah_rf_gain;
 948
 949         u32                     ah_mac_srev;
 950         u16                     ah_mac_version;
 951         u16                     ah_mac_revision;
 952         u16                     ah_phy_revision;
 953         u16                     ah_radio_5ghz_revision;
 954         u16                     ah_radio_2ghz_revision;
 955         u32                     ah_phy_spending;
 956
 957         enum ath5k_version      ah_version;
 958         enum ath5k_radio        ah_radio;
 959         u32                     ah_phy;
 960
 961         bool                    ah_5ghz;
 962         bool                    ah_2ghz;
 963
 964 #define ah_regdomain            ah_capabilities.cap_regdomain.reg_current
 965 #define ah_regdomain_hw         ah_capabilities.cap_regdomain.reg_hw
 966 #define ah_modes                ah_capabilities.cap_mode
 967 #define ah_ee_version           ah_capabilities.cap_eeprom.ee_version
 968
 969         u32                     ah_atim_window;
 970         u32                     ah_aifs;
 971         u32                     ah_cw_min;
 972         u32                     ah_cw_max;
 973         bool                    ah_software_retry;
 974         u32                     ah_limit_tx_retries;
 975
 976         u32                     ah_antenna[AR5K_EEPROM_N_MODES][AR5K_ANT_MAX];
 977         bool                    ah_ant_diversity;
 978
 979         u8                      ah_sta_id[ETH_ALEN];
 980
 981         /* Current BSSID we are trying to assoc to / creating.
 982          * This is passed by mac80211 on config_interface() and cached here for
 983          * use in resets */
 984         u8                      ah_bssid[ETH_ALEN];
 985
 986         u32                     ah_gpio[AR5K_MAX_GPIO];
 987         int                     ah_gpio_npins;
 988
 989         struct ath5k_capabilities ah_capabilities;
 990
 991         struct ath5k_txq_info   ah_txq[AR5K_NUM_TX_QUEUES];
 992         u32                     ah_txq_status;
 993         u32                     ah_txq_imr_txok;
 994         u32                     ah_txq_imr_txerr;
 995         u32                     ah_txq_imr_txurn;
 996         u32                     ah_txq_imr_txdesc;
 997         u32                     ah_txq_imr_txeol;
 998         u32                     *ah_rf_banks;
 999         size_t                  ah_rf_banks_size;
1000         struct ath5k_gain       ah_gain;
1001         u32                     ah_offset[AR5K_MAX_RF_BANKS];
1002
1003         struct {
1004                 u16             txp_pcdac[AR5K_EEPROM_POWER_TABLE_SIZE];
1005                 u16             txp_rates[AR5K_MAX_RATES];
1006                 s16             txp_min;
1007                 s16             txp_max;
1008                 bool            txp_tpc;
1009                 s16             txp_ofdm;
1010         } ah_txpower;
1011
1012         struct {
1013                 bool            r_enabled;
1014                 int             r_last_alert;
1015                 struct ieee80211_channel r_last_channel;
1016         } ah_radar;
1017
1018         /* noise floor from last periodic calibration */
1019         s32                     ah_noise_floor;
1020
1021         /*
1022          * Function pointers
1023          */
1024         int (*ah_setup_tx_desc)(struct ath5k_hw *, struct ath5k_desc *,
1025                 unsigned int, unsigned int, enum ath5k_pkt_type, unsigned int,
1026                 unsigned int, unsigned int, unsigned int, unsigned int,
1027                 unsigned int, unsigned int, unsigned int);
1028         int (*ah_setup_xtx_desc)(struct ath5k_hw *, struct ath5k_desc *,
1029                 unsigned int, unsigned int, unsigned int, unsigned int,
1030                 unsigned int, unsigned int);
1031         int (*ah_proc_tx_desc)(struct ath5k_hw *, struct ath5k_desc *,
1032                 struct ath5k_tx_status *);
1033         int (*ah_proc_rx_desc)(struct ath5k_hw *, struct ath5k_desc *,
1034                 struct ath5k_rx_status *);
1035 };
1036
1037 /*
1038  * Prototypes
1039  */
1040
1041 /* General Functions */
1042 extern int ath5k_hw_register_timeout(struct ath5k_hw *ah, u32 reg, u32 flag, u32 val, bool is_set);
1043 /* Attach/Detach Functions */
1044 extern struct ath5k_hw *ath5k_hw_attach(struct ath5k_softc *sc, u8 mac_version);
1045 extern const struct ath5k_rate_table *ath5k_hw_get_rate_table(struct ath5k_hw *ah, unsigned int mode);
1046 extern void ath5k_hw_detach(struct ath5k_hw *ah);
1047 /* Reset Functions */
1048 extern int ath5k_hw_reset(struct ath5k_hw *ah, enum ieee80211_if_types op_mode, struct ieee80211_channel *channel, bool change_channel);
1049 /* Power management functions */
1050 extern int ath5k_hw_set_power(struct ath5k_hw *ah, enum ath5k_power_mode mode, bool set_chip, u16 sleep_duration);
1051 /* DMA Related Functions */
1052 extern void ath5k_hw_start_rx(struct ath5k_hw *ah);
1053 extern int ath5k_hw_stop_rx_dma(struct ath5k_hw *ah);
1054 extern u32 ath5k_hw_get_rx_buf(struct ath5k_hw *ah);
1055 extern void ath5k_hw_put_rx_buf(struct ath5k_hw *ah, u32 phys_addr);
1056 extern int ath5k_hw_tx_start(struct ath5k_hw *ah, unsigned int queue);
1057 extern int ath5k_hw_stop_tx_dma(struct ath5k_hw *ah, unsigned int queue);
1058 extern u32 ath5k_hw_get_tx_buf(struct ath5k_hw *ah, unsigned int queue);
1059 extern int ath5k_hw_put_tx_buf(struct ath5k_hw *ah, unsigned int queue, u32 phys_addr);
1060 extern int ath5k_hw_update_tx_triglevel(struct ath5k_hw *ah, bool increase);
1061 /* Interrupt handling */
1062 extern bool ath5k_hw_is_intr_pending(struct ath5k_hw *ah);
1063 extern int ath5k_hw_get_isr(struct ath5k_hw *ah, enum ath5k_int *interrupt_mask);
1064 extern enum ath5k_int ath5k_hw_set_intr(struct ath5k_hw *ah, enum ath5k_int new_mask);
1065 extern void ath5k_hw_update_mib_counters(struct ath5k_hw *ah, struct ieee80211_low_level_stats *stats);
1066 /* EEPROM access functions */
1067 extern int ath5k_hw_set_regdomain(struct ath5k_hw *ah, u16 regdomain);
1068 /* Protocol Control Unit Functions */
1069 extern int ath5k_hw_set_opmode(struct ath5k_hw *ah);
1070 /* BSSID Functions */
1071 extern void ath5k_hw_get_lladdr(struct ath5k_hw *ah, u8 *mac);
1072 extern int ath5k_hw_set_lladdr(struct ath5k_hw *ah, const u8 *mac);
1073 extern void ath5k_hw_set_associd(struct ath5k_hw *ah, const u8 *bssid, u16 assoc_id);
1074 extern int ath5k_hw_set_bssid_mask(struct ath5k_hw *ah, const u8 *mask);
1075 /* Receive start/stop functions */
1076 extern void ath5k_hw_start_rx_pcu(struct ath5k_hw *ah);
1077 extern void ath5k_hw_stop_pcu_recv(struct ath5k_hw *ah);
1078 /* RX Filter functions */
1079 extern void ath5k_hw_set_mcast_filter(struct ath5k_hw *ah, u32 filter0, u32 filter1);
1080 extern int ath5k_hw_set_mcast_filterindex(struct ath5k_hw *ah, u32 index);
1081 extern int ath5k_hw_clear_mcast_filter_idx(struct ath5k_hw *ah, u32 index);
1082 extern u32 ath5k_hw_get_rx_filter(struct ath5k_hw *ah);
1083 extern void ath5k_hw_set_rx_filter(struct ath5k_hw *ah, u32 filter);
1084 /* Beacon related functions */
1085 extern u32 ath5k_hw_get_tsf32(struct ath5k_hw *ah);
1086 extern u64 ath5k_hw_get_tsf64(struct ath5k_hw *ah);
1087 extern void ath5k_hw_reset_tsf(struct ath5k_hw *ah);
1088 extern void ath5k_hw_init_beacon(struct ath5k_hw *ah, u32 next_beacon, u32 interval);
1089 #if 0
1090 extern int ath5k_hw_set_beacon_timers(struct ath5k_hw *ah, const struct ath5k_beacon_state *state);
1091 extern void ath5k_hw_reset_beacon(struct ath5k_hw *ah);
1092 extern int ath5k_hw_beaconq_finish(struct ath5k_hw *ah, unsigned long phys_addr);
1093 #endif
1094 /* ACK bit rate */
1095 void ath5k_hw_set_ack_bitrate_high(struct ath5k_hw *ah, bool high);
1096 /* ACK/CTS Timeouts */
1097 extern int ath5k_hw_set_ack_timeout(struct ath5k_hw *ah, unsigned int timeout);
1098 extern unsigned int ath5k_hw_get_ack_timeout(struct ath5k_hw *ah);
1099 extern int ath5k_hw_set_cts_timeout(struct ath5k_hw *ah, unsigned int timeout);
1100 extern unsigned int ath5k_hw_get_cts_timeout(struct ath5k_hw *ah);
1101 /* Key table (WEP) functions */
1102 extern int ath5k_hw_reset_key(struct ath5k_hw *ah, u16 entry);
1103 extern int ath5k_hw_is_key_valid(struct ath5k_hw *ah, u16 entry);
1104 extern int ath5k_hw_set_key(struct ath5k_hw *ah, u16 entry, const struct ieee80211_key_conf *key, const u8 *mac);
1105 extern int ath5k_hw_set_key_lladdr(struct ath5k_hw *ah, u16 entry, const u8 *mac);
1106 /* Queue Control Unit, DFS Control Unit Functions */
1107 extern int ath5k_hw_setup_tx_queue(struct ath5k_hw *ah, enum ath5k_tx_queue queue_type, struct ath5k_txq_info *queue_info);
1108 extern int ath5k_hw_setup_tx_queueprops(struct ath5k_hw *ah, int queue, const struct ath5k_txq_info *queue_info);
1109 extern int ath5k_hw_get_tx_queueprops(struct ath5k_hw *ah, int queue, struct ath5k_txq_info *queue_info);
1110 extern void ath5k_hw_release_tx_queue(struct ath5k_hw *ah, unsigned int queue);
1111 extern int ath5k_hw_reset_tx_queue(struct ath5k_hw *ah, unsigned int queue);
1112 extern u32 ath5k_hw_num_tx_pending(struct ath5k_hw *ah, unsigned int queue);
1113 extern int ath5k_hw_set_slot_time(struct ath5k_hw *ah, unsigned int slot_time);
1114 extern unsigned int ath5k_hw_get_slot_time(struct ath5k_hw *ah);
1115 /* Hardware Descriptor Functions */
1116 extern int ath5k_hw_setup_rx_desc(struct ath5k_hw *ah, struct ath5k_desc *desc, u32 size, unsigned int flags);
1117 /* GPIO Functions */
1118 extern void ath5k_hw_set_ledstate(struct ath5k_hw *ah, unsigned int state);
1119 extern int ath5k_hw_set_gpio_output(struct ath5k_hw *ah, u32 gpio);
1120 extern int ath5k_hw_set_gpio_input(struct ath5k_hw *ah, u32 gpio);
1121 extern u32 ath5k_hw_get_gpio(struct ath5k_hw *ah, u32 gpio);
1122 extern int ath5k_hw_set_gpio(struct ath5k_hw *ah, u32 gpio, u32 val);
1123 extern void ath5k_hw_set_gpio_intr(struct ath5k_hw *ah, unsigned int gpio, u32 interrupt_level);
1124 /* Misc functions */
1125 extern int ath5k_hw_get_capability(struct ath5k_hw *ah, enum ath5k_capability_type cap_type, u32 capability, u32 *result);
1126
1127
1128 /* Initial register settings functions */
1129 extern int ath5k_hw_write_initvals(struct ath5k_hw *ah, u8 mode, bool change_channel);
1130 /* Initialize RF */
1131 extern int ath5k_hw_rfregs(struct ath5k_hw *ah, struct ieee80211_channel *channel, unsigned int mode);
1132 extern int ath5k_hw_rfgain(struct ath5k_hw *ah, unsigned int freq);
1133 extern enum ath5k_rfgain ath5k_hw_get_rf_gain(struct ath5k_hw *ah);
1134 extern int ath5k_hw_set_rfgain_opt(struct ath5k_hw *ah);
1135
1136
1137 /* PHY/RF channel functions */
1138 extern bool ath5k_channel_ok(struct ath5k_hw *ah, u16 freq, unsigned int flags);
1139 extern int ath5k_hw_channel(struct ath5k_hw *ah, struct ieee80211_channel *channel);
1140 /* PHY calibration */
1141 extern int ath5k_hw_phy_calibrate(struct ath5k_hw *ah, struct ieee80211_channel *channel);
1142 extern int ath5k_hw_phy_disable(struct ath5k_hw *ah);
1143 /* Misc PHY functions */
1144 extern u16 ath5k_hw_radio_revision(struct ath5k_hw *ah, unsigned int chan);
1145 extern void ath5k_hw_set_def_antenna(struct ath5k_hw *ah, unsigned int ant);
1146 extern unsigned int ath5k_hw_get_def_antenna(struct ath5k_hw *ah);
1147 extern int ath5k_hw_noise_floor_calibration(struct ath5k_hw *ah, short freq);
1148 /* TX power setup */
1149 extern int ath5k_hw_txpower(struct ath5k_hw *ah, struct ieee80211_channel *channel, unsigned int txpower);
1150 extern int ath5k_hw_set_txpower_limit(struct ath5k_hw *ah, unsigned int power);
1151
1152
1153 static inline u32 ath5k_hw_reg_read(struct ath5k_hw *ah, u16 reg)
1154 {
1155         return ioread32(ah->ah_iobase + reg);
1156 }
1157
1158 static inline void ath5k_hw_reg_write(struct ath5k_hw *ah, u32 val, u16 reg)
1159 {
1160         iowrite32(val, ah->ah_iobase + reg);
1161 }
1162
1163 #endif