drivers/net/wireless/ath/ath9k/hw.h

   1 /*
   2  * Copyright (c) 2008-2010 Atheros Communications Inc.
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #ifndef HW_H
  18 #define HW_H
  19
  20 #include <linux/if_ether.h>
  21 #include <linux/delay.h>
  22 #include <linux/io.h>
  23
  24 #include "mac.h"
  25 #include "ani.h"
  26 #include "eeprom.h"
  27 #include "calib.h"
  28 #include "reg.h"
  29 #include "phy.h"
  30 #include "btcoex.h"
  31
  32 #include "../regd.h"
  33 #include "../debug.h"
  34
  35 #define ATHEROS_VENDOR_ID       0x168c
  36
  37 #define AR5416_DEVID_PCI        0x0023
  38 #define AR5416_DEVID_PCIE       0x0024
  39 #define AR9160_DEVID_PCI        0x0027
  40 #define AR9280_DEVID_PCI        0x0029
  41 #define AR9280_DEVID_PCIE       0x002a
  42 #define AR9285_DEVID_PCIE       0x002b
  43 #define AR2427_DEVID_PCIE       0x002c
  44 #define AR9287_DEVID_PCI        0x002d
  45 #define AR9287_DEVID_PCIE       0x002e
  46 #define AR9300_DEVID_PCIE       0x0030
  47
  48 #define AR5416_AR9100_DEVID     0x000b
  49
  50 #define AR_SUBVENDOR_ID_NOG     0x0e11
  51 #define AR_SUBVENDOR_ID_NEW_A   0x7065
  52 #define AR5416_MAGIC            0x19641014
  53
  54 #define AR9280_COEX2WIRE_SUBSYSID       0x309b
  55 #define AT9285_COEX3WIRE_SA_SUBSYSID    0x30aa
  56 #define AT9285_COEX3WIRE_DA_SUBSYSID    0x30ab
  57
  58 #define ATH_AMPDU_LIMIT_MAX        (64 * 1024 - 1)
  59
  60 #define ATH_DEFAULT_NOISE_FLOOR -95
  61
  62 #define ATH9K_RSSI_BAD                  -128
  63
  64 /* Register read/write primitives */
  65 #define REG_WRITE(_ah, _reg, _val) \
  66         ath9k_hw_common(_ah)->ops->write((_ah), (_val), (_reg))
  67
  68 #define REG_READ(_ah, _reg) \
  69         ath9k_hw_common(_ah)->ops->read((_ah), (_reg))
  70
  71 #define SM(_v, _f)  (((_v) << _f##_S) & _f)
  72 #define MS(_v, _f)  (((_v) & _f) >> _f##_S)
  73 #define REG_RMW(_a, _r, _set, _clr)    \
  74         REG_WRITE(_a, _r, (REG_READ(_a, _r) & ~(_clr)) | (_set))
  75 #define REG_RMW_FIELD(_a, _r, _f, _v) \
  76         REG_WRITE(_a, _r, \
  77         (REG_READ(_a, _r) & ~_f) | (((_v) << _f##_S) & _f))
  78 #define REG_READ_FIELD(_a, _r, _f) \
  79         (((REG_READ(_a, _r) & _f) >> _f##_S))
  80 #define REG_SET_BIT(_a, _r, _f) \
  81         REG_WRITE(_a, _r, REG_READ(_a, _r) | _f)
  82 #define REG_CLR_BIT(_a, _r, _f) \
  83         REG_WRITE(_a, _r, REG_READ(_a, _r) & ~_f)
  84
  85 #define DO_DELAY(x) do {                        \
  86                 if ((++(x) % 64) == 0)          \
  87                         udelay(1);              \
  88         } while (0)
  89
  90 #define REG_WRITE_ARRAY(iniarray, column, regWr) do {                   \
  91                 int r;                                                  \
  92                 for (r = 0; r < ((iniarray)->ia_rows); r++) {           \
  93                         REG_WRITE(ah, INI_RA((iniarray), (r), 0),       \
  94                                   INI_RA((iniarray), r, (column)));     \
  95                         DO_DELAY(regWr);                                \
  96                 }                                                       \
  97         } while (0)
  98
  99 #define AR_GPIO_OUTPUT_MUX_AS_OUTPUT             0
 100 #define AR_GPIO_OUTPUT_MUX_AS_PCIE_ATTENTION_LED 1
 101 #define AR_GPIO_OUTPUT_MUX_AS_PCIE_POWER_LED     2
 102 #define AR_GPIO_OUTPUT_MUX_AS_TX_FRAME           3
 103 #define AR_GPIO_OUTPUT_MUX_AS_RX_CLEAR_EXTERNAL  4
 104 #define AR_GPIO_OUTPUT_MUX_AS_MAC_NETWORK_LED    5
 105 #define AR_GPIO_OUTPUT_MUX_AS_MAC_POWER_LED      6
 106
 107 #define AR_GPIOD_MASK               0x00001FFF
 108 #define AR_GPIO_BIT(_gpio)          (1 << (_gpio))
 109
 110 #define BASE_ACTIVATE_DELAY         100
 111 #define RTC_PLL_SETTLE_DELAY        100
 112 #define COEF_SCALE_S                24
 113 #define HT40_CHANNEL_CENTER_SHIFT   10
 114
 115 #define ATH9K_ANTENNA0_CHAINMASK    0x1
 116 #define ATH9K_ANTENNA1_CHAINMASK    0x2
 117
 118 #define ATH9K_NUM_DMA_DEBUG_REGS    8
 119 #define ATH9K_NUM_QUEUES            10
 120
 121 #define MAX_RATE_POWER              63
 122 #define AH_WAIT_TIMEOUT             100000 /* (us) */
 123 #define AH_TSF_WRITE_TIMEOUT        100    /* (us) */
 124 #define AH_TIME_QUANTUM             10
 125 #define AR_KEYTABLE_SIZE            128
 126 #define POWER_UP_TIME               10000
 127 #define SPUR_RSSI_THRESH            40
 128
 129 #define CAB_TIMEOUT_VAL             10
 130 #define BEACON_TIMEOUT_VAL          10
 131 #define MIN_BEACON_TIMEOUT_VAL      1
 132 #define SLEEP_SLOP                  3
 133
 134 #define INIT_CONFIG_STATUS          0x00000000
 135 #define INIT_RSSI_THR               0x00000700
 136 #define INIT_BCON_CNTRL_REG         0x00000000
 137
 138 #define TU_TO_USEC(_tu)             ((_tu) << 10)
 139
 140 #define ATH9K_HW_RX_HP_QDEPTH   16
 141 #define ATH9K_HW_RX_LP_QDEPTH   128
 142
 143 enum ath_ini_subsys {
 144         ATH_INI_PRE = 0,
 145         ATH_INI_CORE,
 146         ATH_INI_POST,
 147         ATH_INI_NUM_SPLIT,
 148 };
 149
 150 enum wireless_mode {
 151         ATH9K_MODE_11A = 0,
 152         ATH9K_MODE_11G,
 153         ATH9K_MODE_11NA_HT20,
 154         ATH9K_MODE_11NG_HT20,
 155         ATH9K_MODE_11NA_HT40PLUS,
 156         ATH9K_MODE_11NA_HT40MINUS,
 157         ATH9K_MODE_11NG_HT40PLUS,
 158         ATH9K_MODE_11NG_HT40MINUS,
 159         ATH9K_MODE_MAX,
 160 };
 161
 162 enum ath9k_hw_caps {
 163         ATH9K_HW_CAP_MIC_AESCCM                 = BIT(0),
 164         ATH9K_HW_CAP_MIC_CKIP                   = BIT(1),
 165         ATH9K_HW_CAP_MIC_TKIP                   = BIT(2),
 166         ATH9K_HW_CAP_CIPHER_AESCCM              = BIT(3),
 167         ATH9K_HW_CAP_CIPHER_CKIP                = BIT(4),
 168         ATH9K_HW_CAP_CIPHER_TKIP                = BIT(5),
 169         ATH9K_HW_CAP_VEOL                       = BIT(6),
 170         ATH9K_HW_CAP_BSSIDMASK                  = BIT(7),
 171         ATH9K_HW_CAP_MCAST_KEYSEARCH            = BIT(8),
 172         ATH9K_HW_CAP_HT                         = BIT(9),
 173         ATH9K_HW_CAP_GTT                        = BIT(10),
 174         ATH9K_HW_CAP_FASTCC                     = BIT(11),
 175         ATH9K_HW_CAP_RFSILENT                   = BIT(12),
 176         ATH9K_HW_CAP_CST                        = BIT(13),
 177         ATH9K_HW_CAP_ENHANCEDPM                 = BIT(14),
 178         ATH9K_HW_CAP_AUTOSLEEP                  = BIT(15),
 179         ATH9K_HW_CAP_4KB_SPLITTRANS             = BIT(16),
 180         ATH9K_HW_CAP_EDMA                       = BIT(17),
 181         ATH9K_HW_CAP_RAC_SUPPORTED              = BIT(18),
 182         ATH9K_HW_CAP_LDPC                       = BIT(19),
 183 };
 184
 185 enum ath9k_capability_type {
 186         ATH9K_CAP_CIPHER = 0,
 187         ATH9K_CAP_TKIP_MIC,
 188         ATH9K_CAP_TKIP_SPLIT,
 189         ATH9K_CAP_TXPOW,
 190         ATH9K_CAP_MCAST_KEYSRCH,
 191         ATH9K_CAP_DS
 192 };
 193
 194 struct ath9k_hw_capabilities {
 195         u32 hw_caps; /* ATH9K_HW_CAP_* from ath9k_hw_caps */
 196         DECLARE_BITMAP(wireless_modes, ATH9K_MODE_MAX); /* ATH9K_MODE_* */
 197         u16 total_queues;
 198         u16 keycache_size;
 199         u16 low_5ghz_chan, high_5ghz_chan;
 200         u16 low_2ghz_chan, high_2ghz_chan;
 201         u16 rts_aggr_limit;
 202         u8 tx_chainmask;
 203         u8 rx_chainmask;
 204         u16 tx_triglevel_max;
 205         u16 reg_cap;
 206         u8 num_gpio_pins;
 207         u8 num_antcfg_2ghz;
 208         u8 num_antcfg_5ghz;
 209         u8 rx_hp_qdepth;
 210         u8 rx_lp_qdepth;
 211         u8 rx_status_len;
 212         u8 tx_desc_len;
 213         u8 txs_len;
 214 };
 215
 216 struct ath9k_ops_config {
 217         int dma_beacon_response_time;
 218         int sw_beacon_response_time;
 219         int additional_swba_backoff;
 220         int ack_6mb;
 221         int cwm_ignore_extcca;
 222         u8 pcie_powersave_enable;
 223         u8 pcie_clock_req;
 224         u32 pcie_waen;
 225         u8 analog_shiftreg;
 226         u8 ht_enable;
 227         u32 ofdm_trig_low;
 228         u32 ofdm_trig_high;
 229         u32 cck_trig_high;
 230         u32 cck_trig_low;
 231         u32 enable_ani;
 232         int serialize_regmode;
 233         bool rx_intr_mitigation;
 234         bool tx_intr_mitigation;
 235 #define SPUR_DISABLE            0
 236 #define SPUR_ENABLE_IOCTL       1
 237 #define SPUR_ENABLE_EEPROM      2
 238 #define AR_EEPROM_MODAL_SPURS   5
 239 #define AR_SPUR_5413_1          1640
 240 #define AR_SPUR_5413_2          1200
 241 #define AR_NO_SPUR              0x8000
 242 #define AR_BASE_FREQ_2GHZ       2300
 243 #define AR_BASE_FREQ_5GHZ       4900
 244 #define AR_SPUR_FEEQ_BOUND_HT40 19
 245 #define AR_SPUR_FEEQ_BOUND_HT20 10
 246         int spurmode;
 247         u16 spurchans[AR_EEPROM_MODAL_SPURS][2];
 248         u8 max_txtrig_level;
 249 };
 250
 251 enum ath9k_int {
 252         ATH9K_INT_RX = 0x00000001,
 253         ATH9K_INT_RXDESC = 0x00000002,
 254         ATH9K_INT_RXHP = 0x00000001,
 255         ATH9K_INT_RXLP = 0x00000002,
 256         ATH9K_INT_RXNOFRM = 0x00000008,
 257         ATH9K_INT_RXEOL = 0x00000010,
 258         ATH9K_INT_RXORN = 0x00000020,
 259         ATH9K_INT_TX = 0x00000040,
 260         ATH9K_INT_TXDESC = 0x00000080,
 261         ATH9K_INT_TIM_TIMER = 0x00000100,
 262         ATH9K_INT_TXURN = 0x00000800,
 263         ATH9K_INT_MIB = 0x00001000,
 264         ATH9K_INT_RXPHY = 0x00004000,
 265         ATH9K_INT_RXKCM = 0x00008000,
 266         ATH9K_INT_SWBA = 0x00010000,
 267         ATH9K_INT_BMISS = 0x00040000,
 268         ATH9K_INT_BNR = 0x00100000,
 269         ATH9K_INT_TIM = 0x00200000,
 270         ATH9K_INT_DTIM = 0x00400000,
 271         ATH9K_INT_DTIMSYNC = 0x00800000,
 272         ATH9K_INT_GPIO = 0x01000000,
 273         ATH9K_INT_CABEND = 0x02000000,
 274         ATH9K_INT_TSFOOR = 0x04000000,
 275         ATH9K_INT_GENTIMER = 0x08000000,
 276         ATH9K_INT_CST = 0x10000000,
 277         ATH9K_INT_GTT = 0x20000000,
 278         ATH9K_INT_FATAL = 0x40000000,
 279         ATH9K_INT_GLOBAL = 0x80000000,
 280         ATH9K_INT_BMISC = ATH9K_INT_TIM |
 281                 ATH9K_INT_DTIM |
 282                 ATH9K_INT_DTIMSYNC |
 283                 ATH9K_INT_TSFOOR |
 284                 ATH9K_INT_CABEND,
 285         ATH9K_INT_COMMON = ATH9K_INT_RXNOFRM |
 286                 ATH9K_INT_RXDESC |
 287                 ATH9K_INT_RXEOL |
 288                 ATH9K_INT_RXORN |
 289                 ATH9K_INT_TXURN |
 290                 ATH9K_INT_TXDESC |
 291                 ATH9K_INT_MIB |
 292                 ATH9K_INT_RXPHY |
 293                 ATH9K_INT_RXKCM |
 294                 ATH9K_INT_SWBA |
 295                 ATH9K_INT_BMISS |
 296                 ATH9K_INT_GPIO,
 297         ATH9K_INT_NOCARD = 0xffffffff
 298 };
 299
 300 #define CHANNEL_CW_INT    0x00002
 301 #define CHANNEL_CCK       0x00020
 302 #define CHANNEL_OFDM      0x00040
 303 #define CHANNEL_2GHZ      0x00080
 304 #define CHANNEL_5GHZ      0x00100
 305 #define CHANNEL_PASSIVE   0x00200
 306 #define CHANNEL_DYN       0x00400
 307 #define CHANNEL_HALF      0x04000
 308 #define CHANNEL_QUARTER   0x08000
 309 #define CHANNEL_HT20      0x10000
 310 #define CHANNEL_HT40PLUS  0x20000
 311 #define CHANNEL_HT40MINUS 0x40000
 312
 313 #define CHANNEL_A           (CHANNEL_5GHZ|CHANNEL_OFDM)
 314 #define CHANNEL_B           (CHANNEL_2GHZ|CHANNEL_CCK)
 315 #define CHANNEL_G           (CHANNEL_2GHZ|CHANNEL_OFDM)
 316 #define CHANNEL_G_HT20      (CHANNEL_2GHZ|CHANNEL_HT20)
 317 #define CHANNEL_A_HT20      (CHANNEL_5GHZ|CHANNEL_HT20)
 318 #define CHANNEL_G_HT40PLUS  (CHANNEL_2GHZ|CHANNEL_HT40PLUS)
 319 #define CHANNEL_G_HT40MINUS (CHANNEL_2GHZ|CHANNEL_HT40MINUS)
 320 #define CHANNEL_A_HT40PLUS  (CHANNEL_5GHZ|CHANNEL_HT40PLUS)
 321 #define CHANNEL_A_HT40MINUS (CHANNEL_5GHZ|CHANNEL_HT40MINUS)
 322 #define CHANNEL_ALL                             \
 323         (CHANNEL_OFDM|                          \
 324          CHANNEL_CCK|                           \
 325          CHANNEL_2GHZ |                         \
 326          CHANNEL_5GHZ |                         \
 327          CHANNEL_HT20 |                         \
 328          CHANNEL_HT40PLUS |                     \
 329          CHANNEL_HT40MINUS)
 330
 331 struct ath9k_channel {
 332         struct ieee80211_channel *chan;
 333         u16 channel;
 334         u32 channelFlags;
 335         u32 chanmode;
 336         int32_t CalValid;
 337         bool oneTimeCalsDone;
 338         int8_t iCoff;
 339         int8_t qCoff;
 340         int16_t rawNoiseFloor;
 341 };
 342
 343 #define IS_CHAN_G(_c) ((((_c)->channelFlags & (CHANNEL_G)) == CHANNEL_G) || \
 344        (((_c)->channelFlags & CHANNEL_G_HT20) == CHANNEL_G_HT20) || \
 345        (((_c)->channelFlags & CHANNEL_G_HT40PLUS) == CHANNEL_G_HT40PLUS) || \
 346        (((_c)->channelFlags & CHANNEL_G_HT40MINUS) == CHANNEL_G_HT40MINUS))
 347 #define IS_CHAN_OFDM(_c) (((_c)->channelFlags & CHANNEL_OFDM) != 0)
 348 #define IS_CHAN_5GHZ(_c) (((_c)->channelFlags & CHANNEL_5GHZ) != 0)
 349 #define IS_CHAN_2GHZ(_c) (((_c)->channelFlags & CHANNEL_2GHZ) != 0)
 350 #define IS_CHAN_HALF_RATE(_c) (((_c)->channelFlags & CHANNEL_HALF) != 0)
 351 #define IS_CHAN_QUARTER_RATE(_c) (((_c)->channelFlags & CHANNEL_QUARTER) != 0)
 352 #define IS_CHAN_A_5MHZ_SPACED(_c)                       \
 353         ((((_c)->channelFlags & CHANNEL_5GHZ) != 0) &&  \
 354          (((_c)->channel % 20) != 0) &&                 \
 355          (((_c)->channel % 10) != 0))
 356
 357 /* These macros check chanmode and not channelFlags */
 358 #define IS_CHAN_B(_c) ((_c)->chanmode == CHANNEL_B)
 359 #define IS_CHAN_HT20(_c) (((_c)->chanmode == CHANNEL_A_HT20) || \
 360                           ((_c)->chanmode == CHANNEL_G_HT20))
 361 #define IS_CHAN_HT40(_c) (((_c)->chanmode == CHANNEL_A_HT40PLUS) ||     \
 362                           ((_c)->chanmode == CHANNEL_A_HT40MINUS) ||    \
 363                           ((_c)->chanmode == CHANNEL_G_HT40PLUS) ||     \
 364                           ((_c)->chanmode == CHANNEL_G_HT40MINUS))
 365 #define IS_CHAN_HT(_c) (IS_CHAN_HT20((_c)) || IS_CHAN_HT40((_c)))
 366
 367 enum ath9k_power_mode {
 368         ATH9K_PM_AWAKE = 0,
 369         ATH9K_PM_FULL_SLEEP,
 370         ATH9K_PM_NETWORK_SLEEP,
 371         ATH9K_PM_UNDEFINED
 372 };
 373
 374 enum ath9k_tp_scale {
 375         ATH9K_TP_SCALE_MAX = 0,
 376         ATH9K_TP_SCALE_50,
 377         ATH9K_TP_SCALE_25,
 378         ATH9K_TP_SCALE_12,
 379         ATH9K_TP_SCALE_MIN
 380 };
 381
 382 enum ser_reg_mode {
 383         SER_REG_MODE_OFF = 0,
 384         SER_REG_MODE_ON = 1,
 385         SER_REG_MODE_AUTO = 2,
 386 };
 387
 388 enum ath9k_rx_qtype {
 389         ATH9K_RX_QUEUE_HP,
 390         ATH9K_RX_QUEUE_LP,
 391         ATH9K_RX_QUEUE_MAX,
 392 };
 393
 394 struct ath9k_beacon_state {
 395         u32 bs_nexttbtt;
 396         u32 bs_nextdtim;
 397         u32 bs_intval;
 398 #define ATH9K_BEACON_PERIOD       0x0000ffff
 399 #define ATH9K_BEACON_ENA          0x00800000
 400 #define ATH9K_BEACON_RESET_TSF    0x01000000
 401 #define ATH9K_TSFOOR_THRESHOLD    0x00004240 /* 16k us */
 402         u32 bs_dtimperiod;
 403         u16 bs_cfpperiod;
 404         u16 bs_cfpmaxduration;
 405         u32 bs_cfpnext;
 406         u16 bs_timoffset;
 407         u16 bs_bmissthreshold;
 408         u32 bs_sleepduration;
 409         u32 bs_tsfoor_threshold;
 410 };
 411
 412 struct chan_centers {
 413         u16 synth_center;
 414         u16 ctl_center;
 415         u16 ext_center;
 416 };
 417
 418 enum {
 419         ATH9K_RESET_POWER_ON,
 420         ATH9K_RESET_WARM,
 421         ATH9K_RESET_COLD,
 422 };
 423
 424 struct ath9k_hw_version {
 425         u32 magic;
 426         u16 devid;
 427         u16 subvendorid;
 428         u32 macVersion;
 429         u16 macRev;
 430         u16 phyRev;
 431         u16 analog5GhzRev;
 432         u16 analog2GhzRev;
 433         u16 subsysid;
 434 };
 435
 436 /* Generic TSF timer definitions */
 437
 438 #define ATH_MAX_GEN_TIMER       16
 439
 440 #define AR_GENTMR_BIT(_index)   (1 << (_index))
 441
 442 /*
 443  * Using de Bruijin sequence to to look up 1's index in a 32 bit number
 444  * debruijn32 = 0000 0111 0111 1100 1011 0101 0011 0001
 445  */
 446 #define debruijn32 0x077CB531U
 447
 448 struct ath_gen_timer_configuration {
 449         u32 next_addr;
 450         u32 period_addr;
 451         u32 mode_addr;
 452         u32 mode_mask;
 453 };
 454
 455 struct ath_gen_timer {
 456         void (*trigger)(void *arg);
 457         void (*overflow)(void *arg);
 458         void *arg;
 459         u8 index;
 460 };
 461
 462 struct ath_gen_timer_table {
 463         u32 gen_timer_index[32];
 464         struct ath_gen_timer *timers[ATH_MAX_GEN_TIMER];
 465         union {
 466                 unsigned long timer_bits;
 467                 u16 val;
 468         } timer_mask;
 469 };
 470
 471 /**
 472  * struct ath_hw_private_ops - callbacks used internally by hardware code
 473  *
 474  * This structure contains private callbacks designed to only be used internally
 475  * by the hardware core.
 476  *
 477  * @init_cal_settings: setup types of calibrations supported
 478  * @init_cal: starts actual calibration
 479  *
 480  * @init_mode_regs: Initializes mode registers
 481  * @init_mode_gain_regs: Initialize TX/RX gain registers
 482  * @macversion_supported: If this specific mac revision is supported
 483  *
 484  * @rf_set_freq: change frequency
 485  * @spur_mitigate_freq: spur mitigation
 486  * @rf_alloc_ext_banks:
 487  * @rf_free_ext_banks:
 488  * @set_rf_regs:
 489  * @compute_pll_control: compute the PLL control value to use for
 490  *      AR_RTC_PLL_CONTROL for a given channel
 491  * @setup_calibration: set up calibration
 492  * @iscal_supported: used to query if a type of calibration is supported
 493  * @loadnf: load noise floor read from each chain on the CCA registers
 494  */
 495 struct ath_hw_private_ops {
 496         /* Calibration ops */
 497         void (*init_cal_settings)(struct ath_hw *ah);
 498         bool (*init_cal)(struct ath_hw *ah, struct ath9k_channel *chan);
 499
 500         void (*init_mode_regs)(struct ath_hw *ah);
 501         void (*init_mode_gain_regs)(struct ath_hw *ah);
 502         bool (*macversion_supported)(u32 macversion);
 503         void (*setup_calibration)(struct ath_hw *ah,
 504                                   struct ath9k_cal_list *currCal);
 505         bool (*iscal_supported)(struct ath_hw *ah,
 506                                 enum ath9k_cal_types calType);
 507
 508         /* PHY ops */
 509         int (*rf_set_freq)(struct ath_hw *ah,
 510                            struct ath9k_channel *chan);
 511         void (*spur_mitigate_freq)(struct ath_hw *ah,
 512                                    struct ath9k_channel *chan);
 513         int (*rf_alloc_ext_banks)(struct ath_hw *ah);
 514         void (*rf_free_ext_banks)(struct ath_hw *ah);
 515         bool (*set_rf_regs)(struct ath_hw *ah,
 516                             struct ath9k_channel *chan,
 517                             u16 modesIndex);
 518         void (*set_channel_regs)(struct ath_hw *ah, struct ath9k_channel *chan);
 519         void (*init_bb)(struct ath_hw *ah,
 520                         struct ath9k_channel *chan);
 521         int (*process_ini)(struct ath_hw *ah, struct ath9k_channel *chan);
 522         void (*olc_init)(struct ath_hw *ah);
 523         void (*set_rfmode)(struct ath_hw *ah, struct ath9k_channel *chan);
 524         void (*mark_phy_inactive)(struct ath_hw *ah);
 525         void (*set_delta_slope)(struct ath_hw *ah, struct ath9k_channel *chan);
 526         bool (*rfbus_req)(struct ath_hw *ah);
 527         void (*rfbus_done)(struct ath_hw *ah);
 528         void (*enable_rfkill)(struct ath_hw *ah);
 529         void (*restore_chainmask)(struct ath_hw *ah);
 530         void (*set_diversity)(struct ath_hw *ah, bool value);
 531         u32 (*compute_pll_control)(struct ath_hw *ah,
 532                                    struct ath9k_channel *chan);
 533         bool (*ani_control)(struct ath_hw *ah, enum ath9k_ani_cmd cmd,
 534                             int param);
 535         void (*do_getnf)(struct ath_hw *ah, int16_t nfarray[NUM_NF_READINGS]);
 536         void (*loadnf)(struct ath_hw *ah, struct ath9k_channel *chan);
 537 };
 538
 539 /**
 540  * struct ath_hw_ops - callbacks used by hardware code and driver code
 541  *
 542  * This structure contains callbacks designed to to be used internally by
 543  * hardware code and also by the lower level driver.
 544  *
 545  * @config_pci_powersave:
 546  * @calibrate: periodic calibration for NF, ANI, IQ, ADC gain, ADC-DC
 547  */
 548 struct ath_hw_ops {
 549         void (*config_pci_powersave)(struct ath_hw *ah,
 550                                      int restore,
 551                                      int power_off);
 552         void (*rx_enable)(struct ath_hw *ah);
 553         void (*set_desc_link)(void *ds, u32 link);
 554         void (*get_desc_link)(void *ds, u32 **link);
 555         bool (*calibrate)(struct ath_hw *ah,
 556                           struct ath9k_channel *chan,
 557                           u8 rxchainmask,
 558                           bool longcal);
 559         bool (*get_isr)(struct ath_hw *ah, enum ath9k_int *masked);
 560         void (*fill_txdesc)(struct ath_hw *ah, void *ds, u32 seglen,
 561                             bool is_firstseg, bool is_is_lastseg,
 562                             const void *ds0, dma_addr_t buf_addr,
 563                             unsigned int qcu);
 564         int (*proc_txdesc)(struct ath_hw *ah, void *ds,
 565                            struct ath_tx_status *ts);
 566         void (*set11n_txdesc)(struct ath_hw *ah, void *ds,
 567                               u32 pktLen, enum ath9k_pkt_type type,
 568                               u32 txPower, u32 keyIx,
 569                               enum ath9k_key_type keyType,
 570                               u32 flags);
 571         void (*set11n_ratescenario)(struct ath_hw *ah, void *ds,
 572                                 void *lastds,
 573                                 u32 durUpdateEn, u32 rtsctsRate,
 574                                 u32 rtsctsDuration,
 575                                 struct ath9k_11n_rate_series series[],
 576                                 u32 nseries, u32 flags);
 577         void (*set11n_aggr_first)(struct ath_hw *ah, void *ds,
 578                                   u32 aggrLen);
 579         void (*set11n_aggr_middle)(struct ath_hw *ah, void *ds,
 580                                    u32 numDelims);
 581         void (*set11n_aggr_last)(struct ath_hw *ah, void *ds);
 582         void (*clr11n_aggr)(struct ath_hw *ah, void *ds);
 583         void (*set11n_burstduration)(struct ath_hw *ah, void *ds,
 584                                      u32 burstDuration);
 585         void (*set11n_virtualmorefrag)(struct ath_hw *ah, void *ds,
 586                                        u32 vmf);
 587 };
 588
 589 struct ath_hw {
 590         struct ieee80211_hw *hw;
 591         struct ath_common common;
 592         struct ath9k_hw_version hw_version;
 593         struct ath9k_ops_config config;
 594         struct ath9k_hw_capabilities caps;
 595         struct ath9k_channel channels[38];
 596         struct ath9k_channel *curchan;
 597
 598         union {
 599                 struct ar5416_eeprom_def def;
 600                 struct ar5416_eeprom_4k map4k;
 601                 struct ar9287_eeprom map9287;
 602                 struct ar9300_eeprom ar9300_eep;
 603         } eeprom;
 604         const struct eeprom_ops *eep_ops;
 605
 606         bool sw_mgmt_crypto;
 607         bool is_pciexpress;
 608         bool need_an_top2_fixup;
 609         u16 tx_trig_level;
 610         s16 nf_2g_max;
 611         s16 nf_2g_min;
 612         s16 nf_5g_max;
 613         s16 nf_5g_min;
 614         u16 rfsilent;
 615         u32 rfkill_gpio;
 616         u32 rfkill_polarity;
 617         u32 ah_flags;
 618
 619         bool htc_reset_init;
 620
 621         enum nl80211_iftype opmode;
 622         enum ath9k_power_mode power_mode;
 623
 624         struct ath9k_nfcal_hist nfCalHist[NUM_NF_READINGS];
 625         struct ath9k_pacal_info pacal_info;
 626         struct ar5416Stats stats;
 627         struct ath9k_tx_queue_info txq[ATH9K_NUM_TX_QUEUES];
 628
 629         int16_t curchan_rad_index;
 630         enum ath9k_int imask;
 631         u32 imrs2_reg;
 632         u32 txok_interrupt_mask;
 633         u32 txerr_interrupt_mask;
 634         u32 txdesc_interrupt_mask;
 635         u32 txeol_interrupt_mask;
 636         u32 txurn_interrupt_mask;
 637         bool chip_fullsleep;
 638         u32 atim_window;
 639
 640         /* Calibration */
 641         enum ath9k_cal_types supp_cals;
 642         struct ath9k_cal_list iq_caldata;
 643         struct ath9k_cal_list adcgain_caldata;
 644         struct ath9k_cal_list adcdc_calinitdata;
 645         struct ath9k_cal_list adcdc_caldata;
 646         struct ath9k_cal_list tempCompCalData;
 647         struct ath9k_cal_list *cal_list;
 648         struct ath9k_cal_list *cal_list_last;
 649         struct ath9k_cal_list *cal_list_curr;
 650 #define totalPowerMeasI meas0.unsign
 651 #define totalPowerMeasQ meas1.unsign
 652 #define totalIqCorrMeas meas2.sign
 653 #define totalAdcIOddPhase  meas0.unsign
 654 #define totalAdcIEvenPhase meas1.unsign
 655 #define totalAdcQOddPhase  meas2.unsign
 656 #define totalAdcQEvenPhase meas3.unsign
 657 #define totalAdcDcOffsetIOddPhase  meas0.sign
 658 #define totalAdcDcOffsetIEvenPhase meas1.sign
 659 #define totalAdcDcOffsetQOddPhase  meas2.sign
 660 #define totalAdcDcOffsetQEvenPhase meas3.sign
 661         union {
 662                 u32 unsign[AR5416_MAX_CHAINS];
 663                 int32_t sign[AR5416_MAX_CHAINS];
 664         } meas0;
 665         union {
 666                 u32 unsign[AR5416_MAX_CHAINS];
 667                 int32_t sign[AR5416_MAX_CHAINS];
 668         } meas1;
 669         union {
 670                 u32 unsign[AR5416_MAX_CHAINS];
 671                 int32_t sign[AR5416_MAX_CHAINS];
 672         } meas2;
 673         union {
 674                 u32 unsign[AR5416_MAX_CHAINS];
 675                 int32_t sign[AR5416_MAX_CHAINS];
 676         } meas3;
 677         u16 cal_samples;
 678
 679         u32 sta_id1_defaults;
 680         u32 misc_mode;
 681         enum {
 682                 AUTO_32KHZ,
 683                 USE_32KHZ,
 684                 DONT_USE_32KHZ,
 685         } enable_32kHz_clock;
 686
 687         /* Private to hardware code */
 688         struct ath_hw_private_ops private_ops;
 689         /* Accessed by the lower level driver */
 690         struct ath_hw_ops ops;
 691
 692         /* Used to program the radio on non single-chip devices */
 693         u32 *analogBank0Data;
 694         u32 *analogBank1Data;
 695         u32 *analogBank2Data;
 696         u32 *analogBank3Data;
 697         u32 *analogBank6Data;
 698         u32 *analogBank6TPCData;
 699         u32 *analogBank7Data;
 700         u32 *addac5416_21;
 701         u32 *bank6Temp;
 702
 703         int16_t txpower_indexoffset;
 704         int coverage_class;
 705         u32 beacon_interval;
 706         u32 slottime;
 707         u32 globaltxtimeout;
 708
 709         /* ANI */
 710         u32 proc_phyerr;
 711         u32 aniperiod;
 712         struct ar5416AniState *curani;
 713         struct ar5416AniState ani[255];
 714         int totalSizeDesired[5];
 715         int coarse_high[5];
 716         int coarse_low[5];
 717         int firpwr[5];
 718         enum ath9k_ani_cmd ani_function;
 719
 720         /* Bluetooth coexistance */
 721         struct ath_btcoex_hw btcoex_hw;
 722
 723         u32 intr_txqs;
 724         u8 txchainmask;
 725         u8 rxchainmask;
 726
 727         u32 originalGain[22];
 728         int initPDADC;
 729         int PDADCdelta;
 730         u8 led_pin;
 731
 732         struct ar5416IniArray iniModes;
 733         struct ar5416IniArray iniCommon;
 734         struct ar5416IniArray iniBank0;
 735         struct ar5416IniArray iniBB_RfGain;
 736         struct ar5416IniArray iniBank1;
 737         struct ar5416IniArray iniBank2;
 738         struct ar5416IniArray iniBank3;
 739         struct ar5416IniArray iniBank6;
 740         struct ar5416IniArray iniBank6TPC;
 741         struct ar5416IniArray iniBank7;
 742         struct ar5416IniArray iniAddac;
 743         struct ar5416IniArray iniPcieSerdes;
 744         struct ar5416IniArray iniPcieSerdesLowPower;
 745         struct ar5416IniArray iniModesAdditional;
 746         struct ar5416IniArray iniModesRxGain;
 747         struct ar5416IniArray iniModesTxGain;
 748         struct ar5416IniArray iniModes_9271_1_0_only;
 749         struct ar5416IniArray iniCckfirNormal;
 750         struct ar5416IniArray iniCckfirJapan2484;
 751         struct ar5416IniArray iniCommon_normal_cck_fir_coeff_9271;
 752         struct ar5416IniArray iniCommon_japan_2484_cck_fir_coeff_9271;
 753         struct ar5416IniArray iniModes_9271_ANI_reg;
 754         struct ar5416IniArray iniModes_high_power_tx_gain_9271;
 755         struct ar5416IniArray iniModes_normal_power_tx_gain_9271;
 756
 757         struct ar5416IniArray iniMac[ATH_INI_NUM_SPLIT];
 758         struct ar5416IniArray iniBB[ATH_INI_NUM_SPLIT];
 759         struct ar5416IniArray iniRadio[ATH_INI_NUM_SPLIT];
 760         struct ar5416IniArray iniSOC[ATH_INI_NUM_SPLIT];
 761
 762         u32 intr_gen_timer_trigger;
 763         u32 intr_gen_timer_thresh;
 764         struct ath_gen_timer_table hw_gen_timers;
 765
 766         struct ar9003_txs *ts_ring;
 767         void *ts_start;
 768         u32 ts_paddr_start;
 769         u32 ts_paddr_end;
 770         u16 ts_tail;
 771         u8 ts_size;
 772 };
 773
 774 static inline struct ath_common *ath9k_hw_common(struct ath_hw *ah)
 775 {
 776         return &ah->common;
 777 }
 778
 779 static inline struct ath_regulatory *ath9k_hw_regulatory(struct ath_hw *ah)
 780 {
 781         return &(ath9k_hw_common(ah)->regulatory);
 782 }
 783
 784 static inline struct ath_hw_private_ops *ath9k_hw_private_ops(struct ath_hw *ah)
 785 {
 786         return &ah->private_ops;
 787 }
 788
 789 static inline struct ath_hw_ops *ath9k_hw_ops(struct ath_hw *ah)
 790 {
 791         return &ah->ops;
 792 }
 793
 794 /* Initialization, Detach, Reset */
 795 const char *ath9k_hw_probe(u16 vendorid, u16 devid);
 796 void ath9k_hw_deinit(struct ath_hw *ah);
 797 int ath9k_hw_init(struct ath_hw *ah);
 798 int ath9k_hw_reset(struct ath_hw *ah, struct ath9k_channel *chan,
 799                    bool bChannelChange);
 800 int ath9k_hw_fill_cap_info(struct ath_hw *ah);
 801 bool ath9k_hw_getcapability(struct ath_hw *ah, enum ath9k_capability_type type,
 802                             u32 capability, u32 *result);
 803 bool ath9k_hw_setcapability(struct ath_hw *ah, enum ath9k_capability_type type,
 804                             u32 capability, u32 setting, int *status);
 805 u32 ath9k_regd_get_ctl(struct ath_regulatory *reg, struct ath9k_channel *chan);
 806
 807 /* Key Cache Management */
 808 bool ath9k_hw_keyreset(struct ath_hw *ah, u16 entry);
 809 bool ath9k_hw_keysetmac(struct ath_hw *ah, u16 entry, const u8 *mac);
 810 bool ath9k_hw_set_keycache_entry(struct ath_hw *ah, u16 entry,
 811                                  const struct ath9k_keyval *k,
 812                                  const u8 *mac);
 813 bool ath9k_hw_keyisvalid(struct ath_hw *ah, u16 entry);
 814
 815 /* GPIO / RFKILL / Antennae */
 816 void ath9k_hw_cfg_gpio_input(struct ath_hw *ah, u32 gpio);
 817 u32 ath9k_hw_gpio_get(struct ath_hw *ah, u32 gpio);
 818 void ath9k_hw_cfg_output(struct ath_hw *ah, u32 gpio,
 819                          u32 ah_signal_type);
 820 void ath9k_hw_set_gpio(struct ath_hw *ah, u32 gpio, u32 val);
 821 u32 ath9k_hw_getdefantenna(struct ath_hw *ah);
 822 void ath9k_hw_setantenna(struct ath_hw *ah, u32 antenna);
 823
 824 /* General Operation */
 825 bool ath9k_hw_wait(struct ath_hw *ah, u32 reg, u32 mask, u32 val, u32 timeout);
 826 u32 ath9k_hw_reverse_bits(u32 val, u32 n);
 827 bool ath9k_get_channel_edges(struct ath_hw *ah, u16 flags, u16 *low, u16 *high);
 828 u16 ath9k_hw_computetxtime(struct ath_hw *ah,
 829                            u8 phy, int kbps,
 830                            u32 frameLen, u16 rateix, bool shortPreamble);
 831 void ath9k_hw_get_channel_centers(struct ath_hw *ah,
 832                                   struct ath9k_channel *chan,
 833                                   struct chan_centers *centers);
 834 u32 ath9k_hw_getrxfilter(struct ath_hw *ah);
 835 void ath9k_hw_setrxfilter(struct ath_hw *ah, u32 bits);
 836 bool ath9k_hw_phy_disable(struct ath_hw *ah);
 837 bool ath9k_hw_disable(struct ath_hw *ah);
 838 void ath9k_hw_set_txpowerlimit(struct ath_hw *ah, u32 limit);
 839 void ath9k_hw_setmac(struct ath_hw *ah, const u8 *mac);
 840 void ath9k_hw_setopmode(struct ath_hw *ah);
 841 void ath9k_hw_setmcastfilter(struct ath_hw *ah, u32 filter0, u32 filter1);
 842 void ath9k_hw_setbssidmask(struct ath_hw *ah);
 843 void ath9k_hw_write_associd(struct ath_hw *ah);
 844 u64 ath9k_hw_gettsf64(struct ath_hw *ah);
 845 void ath9k_hw_settsf64(struct ath_hw *ah, u64 tsf64);
 846 void ath9k_hw_reset_tsf(struct ath_hw *ah);
 847 void ath9k_hw_set_tsfadjust(struct ath_hw *ah, u32 setting);
 848 u64 ath9k_hw_extend_tsf(struct ath_hw *ah, u32 rstamp);
 849 void ath9k_hw_init_global_settings(struct ath_hw *ah);
 850 void ath9k_hw_set11nmac2040(struct ath_hw *ah);
 851 void ath9k_hw_beaconinit(struct ath_hw *ah, u32 next_beacon, u32 beacon_period);
 852 void ath9k_hw_set_sta_beacon_timers(struct ath_hw *ah,
 853                                     const struct ath9k_beacon_state *bs);
 854
 855 bool ath9k_hw_setpower(struct ath_hw *ah, enum ath9k_power_mode mode);
 856
 857 /* Generic hw timer primitives */
 858 struct ath_gen_timer *ath_gen_timer_alloc(struct ath_hw *ah,
 859                                           void (*trigger)(void *),
 860                                           void (*overflow)(void *),
 861                                           void *arg,
 862                                           u8 timer_index);
 863 void ath9k_hw_gen_timer_start(struct ath_hw *ah,
 864                               struct ath_gen_timer *timer,
 865                               u32 timer_next,
 866                               u32 timer_period);
 867 void ath9k_hw_gen_timer_stop(struct ath_hw *ah, struct ath_gen_timer *timer);
 868
 869 void ath_gen_timer_free(struct ath_hw *ah, struct ath_gen_timer *timer);
 870 void ath_gen_timer_isr(struct ath_hw *hw);
 871 u32 ath9k_hw_gettsf32(struct ath_hw *ah);
 872
 873 void ath9k_hw_name(struct ath_hw *ah, char *hw_name, size_t len);
 874
 875 /* HTC */
 876 void ath9k_hw_htc_resetinit(struct ath_hw *ah);
 877
 878 /* PHY */
 879 void ath9k_hw_get_delta_slope_vals(struct ath_hw *ah, u32 coef_scaled,
 880                                    u32 *coef_mantissa, u32 *coef_exponent);
 881
 882 /*
 883  * Code Specific to AR5008, AR9001 or AR9002,
 884  * we stuff these here to avoid callbacks for AR9003.
 885  */
 886 void ar9002_hw_cck_chan14_spread(struct ath_hw *ah);
 887 int ar9002_hw_rf_claim(struct ath_hw *ah);
 888 void ar9002_hw_enable_async_fifo(struct ath_hw *ah);
 889 void ar9002_hw_enable_wep_aggregation(struct ath_hw *ah);
 890
 891 /*
 892  * Code specifric to AR9003, we stuff these here to avoid callbacks
 893  * for older families
 894  */
 895 void ar9003_hw_set_nf_limits(struct ath_hw *ah);
 896
 897 /* Hardware family op attach helpers */
 898 void ar5008_hw_attach_phy_ops(struct ath_hw *ah);
 899 void ar9002_hw_attach_phy_ops(struct ath_hw *ah);
 900 void ar9003_hw_attach_phy_ops(struct ath_hw *ah);
 901
 902 void ar9002_hw_attach_calib_ops(struct ath_hw *ah);
 903 void ar9003_hw_attach_calib_ops(struct ath_hw *ah);
 904
 905 void ar9002_hw_attach_ops(struct ath_hw *ah);
 906 void ar9003_hw_attach_ops(struct ath_hw *ah);
 907
 908 #define ATH_PCIE_CAP_LINK_CTRL  0x70
 909 #define ATH_PCIE_CAP_LINK_L0S   1
 910 #define ATH_PCIE_CAP_LINK_L1    2
 911
 912 #endif