235cb5357a2285b1525ae1ee0b887372f9cc2d85
[pandora-kernel.git] / 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 ENABLE_REGWRITE_BUFFER(_ah)                                     \
72         do {                                                            \
73                 if (AR_SREV_9271(_ah))                                  \
74                         ath9k_hw_common(_ah)->ops->enable_write_buffer((_ah)); \
75         } while (0)
76
77 #define DISABLE_REGWRITE_BUFFER(_ah)                                    \
78         do {                                                            \
79                 if (AR_SREV_9271(_ah))                                  \
80                         ath9k_hw_common(_ah)->ops->disable_write_buffer((_ah)); \
81         } while (0)
82
83 #define REGWRITE_BUFFER_FLUSH(_ah)                                      \
84         do {                                                            \
85                 if (AR_SREV_9271(_ah))                                  \
86                         ath9k_hw_common(_ah)->ops->write_flush((_ah));  \
87         } while (0)
88
89 #define SM(_v, _f)  (((_v) << _f##_S) & _f)
90 #define MS(_v, _f)  (((_v) & _f) >> _f##_S)
91 #define REG_RMW(_a, _r, _set, _clr)    \
92         REG_WRITE(_a, _r, (REG_READ(_a, _r) & ~(_clr)) | (_set))
93 #define REG_RMW_FIELD(_a, _r, _f, _v) \
94         REG_WRITE(_a, _r, \
95         (REG_READ(_a, _r) & ~_f) | (((_v) << _f##_S) & _f))
96 #define REG_READ_FIELD(_a, _r, _f) \
97         (((REG_READ(_a, _r) & _f) >> _f##_S))
98 #define REG_SET_BIT(_a, _r, _f) \
99         REG_WRITE(_a, _r, REG_READ(_a, _r) | _f)
100 #define REG_CLR_BIT(_a, _r, _f) \
101         REG_WRITE(_a, _r, REG_READ(_a, _r) & ~_f)
102
103 #define DO_DELAY(x) do {                        \
104                 if ((++(x) % 64) == 0)          \
105                         udelay(1);              \
106         } while (0)
107
108 #define REG_WRITE_ARRAY(iniarray, column, regWr) do {                   \
109                 int r;                                                  \
110                 for (r = 0; r < ((iniarray)->ia_rows); r++) {           \
111                         REG_WRITE(ah, INI_RA((iniarray), (r), 0),       \
112                                   INI_RA((iniarray), r, (column)));     \
113                         DO_DELAY(regWr);                                \
114                 }                                                       \
115         } while (0)
116
117 #define AR_GPIO_OUTPUT_MUX_AS_OUTPUT             0
118 #define AR_GPIO_OUTPUT_MUX_AS_PCIE_ATTENTION_LED 1
119 #define AR_GPIO_OUTPUT_MUX_AS_PCIE_POWER_LED     2
120 #define AR_GPIO_OUTPUT_MUX_AS_TX_FRAME           3
121 #define AR_GPIO_OUTPUT_MUX_AS_RX_CLEAR_EXTERNAL  4
122 #define AR_GPIO_OUTPUT_MUX_AS_MAC_NETWORK_LED    5
123 #define AR_GPIO_OUTPUT_MUX_AS_MAC_POWER_LED      6
124
125 #define AR_GPIOD_MASK               0x00001FFF
126 #define AR_GPIO_BIT(_gpio)          (1 << (_gpio))
127
128 #define BASE_ACTIVATE_DELAY         100
129 #define RTC_PLL_SETTLE_DELAY        100
130 #define COEF_SCALE_S                24
131 #define HT40_CHANNEL_CENTER_SHIFT   10
132
133 #define ATH9K_ANTENNA0_CHAINMASK    0x1
134 #define ATH9K_ANTENNA1_CHAINMASK    0x2
135
136 #define ATH9K_NUM_DMA_DEBUG_REGS    8
137 #define ATH9K_NUM_QUEUES            10
138
139 #define MAX_RATE_POWER              63
140 #define AH_WAIT_TIMEOUT             100000 /* (us) */
141 #define AH_TSF_WRITE_TIMEOUT        100    /* (us) */
142 #define AH_TIME_QUANTUM             10
143 #define AR_KEYTABLE_SIZE            128
144 #define POWER_UP_TIME               10000
145 #define SPUR_RSSI_THRESH            40
146
147 #define CAB_TIMEOUT_VAL             10
148 #define BEACON_TIMEOUT_VAL          10
149 #define MIN_BEACON_TIMEOUT_VAL      1
150 #define SLEEP_SLOP                  3
151
152 #define INIT_CONFIG_STATUS          0x00000000
153 #define INIT_RSSI_THR               0x00000700
154 #define INIT_BCON_CNTRL_REG         0x00000000
155
156 #define TU_TO_USEC(_tu)             ((_tu) << 10)
157
158 #define ATH9K_HW_RX_HP_QDEPTH   16
159 #define ATH9K_HW_RX_LP_QDEPTH   128
160
161 #define PAPRD_GAIN_TABLE_ENTRIES    32
162 #define PAPRD_TABLE_SZ              24
163
164 enum ath_ini_subsys {
165         ATH_INI_PRE = 0,
166         ATH_INI_CORE,
167         ATH_INI_POST,
168         ATH_INI_NUM_SPLIT,
169 };
170
171 enum wireless_mode {
172         ATH9K_MODE_11A = 0,
173         ATH9K_MODE_11G,
174         ATH9K_MODE_11NA_HT20,
175         ATH9K_MODE_11NG_HT20,
176         ATH9K_MODE_11NA_HT40PLUS,
177         ATH9K_MODE_11NA_HT40MINUS,
178         ATH9K_MODE_11NG_HT40PLUS,
179         ATH9K_MODE_11NG_HT40MINUS,
180         ATH9K_MODE_MAX,
181 };
182
183 enum ath9k_hw_caps {
184         ATH9K_HW_CAP_HT                         = BIT(0),
185         ATH9K_HW_CAP_RFSILENT                   = BIT(1),
186         ATH9K_HW_CAP_CST                        = BIT(2),
187         ATH9K_HW_CAP_ENHANCEDPM                 = BIT(3),
188         ATH9K_HW_CAP_AUTOSLEEP                  = BIT(4),
189         ATH9K_HW_CAP_4KB_SPLITTRANS             = BIT(5),
190         ATH9K_HW_CAP_EDMA                       = BIT(6),
191         ATH9K_HW_CAP_RAC_SUPPORTED              = BIT(7),
192         ATH9K_HW_CAP_LDPC                       = BIT(8),
193         ATH9K_HW_CAP_FASTCLOCK                  = BIT(9),
194         ATH9K_HW_CAP_SGI_20                     = BIT(10),
195         ATH9K_HW_CAP_PAPRD                      = BIT(11),
196         ATH9K_HW_CAP_ANT_DIV_COMB               = BIT(12),
197 };
198
199 struct ath9k_hw_capabilities {
200         u32 hw_caps; /* ATH9K_HW_CAP_* from ath9k_hw_caps */
201         DECLARE_BITMAP(wireless_modes, ATH9K_MODE_MAX); /* ATH9K_MODE_* */
202         u16 total_queues;
203         u16 keycache_size;
204         u16 low_5ghz_chan, high_5ghz_chan;
205         u16 low_2ghz_chan, high_2ghz_chan;
206         u16 rts_aggr_limit;
207         u8 tx_chainmask;
208         u8 rx_chainmask;
209         u16 tx_triglevel_max;
210         u16 reg_cap;
211         u8 num_gpio_pins;
212         u8 num_antcfg_2ghz;
213         u8 num_antcfg_5ghz;
214         u8 rx_hp_qdepth;
215         u8 rx_lp_qdepth;
216         u8 rx_status_len;
217         u8 tx_desc_len;
218         u8 txs_len;
219 };
220
221 struct ath9k_ops_config {
222         int dma_beacon_response_time;
223         int sw_beacon_response_time;
224         int additional_swba_backoff;
225         int ack_6mb;
226         u32 cwm_ignore_extcca;
227         u8 pcie_powersave_enable;
228         bool pcieSerDesWrite;
229         u8 pcie_clock_req;
230         u32 pcie_waen;
231         u8 analog_shiftreg;
232         u8 ht_enable;
233         u32 ofdm_trig_low;
234         u32 ofdm_trig_high;
235         u32 cck_trig_high;
236         u32 cck_trig_low;
237         u32 enable_ani;
238         int serialize_regmode;
239         bool rx_intr_mitigation;
240         bool tx_intr_mitigation;
241 #define SPUR_DISABLE            0
242 #define SPUR_ENABLE_IOCTL       1
243 #define SPUR_ENABLE_EEPROM      2
244 #define AR_EEPROM_MODAL_SPURS   5
245 #define AR_SPUR_5413_1          1640
246 #define AR_SPUR_5413_2          1200
247 #define AR_NO_SPUR              0x8000
248 #define AR_BASE_FREQ_2GHZ       2300
249 #define AR_BASE_FREQ_5GHZ       4900
250 #define AR_SPUR_FEEQ_BOUND_HT40 19
251 #define AR_SPUR_FEEQ_BOUND_HT20 10
252         int spurmode;
253         u16 spurchans[AR_EEPROM_MODAL_SPURS][2];
254         u8 max_txtrig_level;
255         u16 ani_poll_interval; /* ANI poll interval in ms */
256 };
257
258 enum ath9k_int {
259         ATH9K_INT_RX = 0x00000001,
260         ATH9K_INT_RXDESC = 0x00000002,
261         ATH9K_INT_RXHP = 0x00000001,
262         ATH9K_INT_RXLP = 0x00000002,
263         ATH9K_INT_RXNOFRM = 0x00000008,
264         ATH9K_INT_RXEOL = 0x00000010,
265         ATH9K_INT_RXORN = 0x00000020,
266         ATH9K_INT_TX = 0x00000040,
267         ATH9K_INT_TXDESC = 0x00000080,
268         ATH9K_INT_TIM_TIMER = 0x00000100,
269         ATH9K_INT_BB_WATCHDOG = 0x00000400,
270         ATH9K_INT_TXURN = 0x00000800,
271         ATH9K_INT_MIB = 0x00001000,
272         ATH9K_INT_RXPHY = 0x00004000,
273         ATH9K_INT_RXKCM = 0x00008000,
274         ATH9K_INT_SWBA = 0x00010000,
275         ATH9K_INT_BMISS = 0x00040000,
276         ATH9K_INT_BNR = 0x00100000,
277         ATH9K_INT_TIM = 0x00200000,
278         ATH9K_INT_DTIM = 0x00400000,
279         ATH9K_INT_DTIMSYNC = 0x00800000,
280         ATH9K_INT_GPIO = 0x01000000,
281         ATH9K_INT_CABEND = 0x02000000,
282         ATH9K_INT_TSFOOR = 0x04000000,
283         ATH9K_INT_GENTIMER = 0x08000000,
284         ATH9K_INT_CST = 0x10000000,
285         ATH9K_INT_GTT = 0x20000000,
286         ATH9K_INT_FATAL = 0x40000000,
287         ATH9K_INT_GLOBAL = 0x80000000,
288         ATH9K_INT_BMISC = ATH9K_INT_TIM |
289                 ATH9K_INT_DTIM |
290                 ATH9K_INT_DTIMSYNC |
291                 ATH9K_INT_TSFOOR |
292                 ATH9K_INT_CABEND,
293         ATH9K_INT_COMMON = ATH9K_INT_RXNOFRM |
294                 ATH9K_INT_RXDESC |
295                 ATH9K_INT_RXEOL |
296                 ATH9K_INT_RXORN |
297                 ATH9K_INT_TXURN |
298                 ATH9K_INT_TXDESC |
299                 ATH9K_INT_MIB |
300                 ATH9K_INT_RXPHY |
301                 ATH9K_INT_RXKCM |
302                 ATH9K_INT_SWBA |
303                 ATH9K_INT_BMISS |
304                 ATH9K_INT_GPIO,
305         ATH9K_INT_NOCARD = 0xffffffff
306 };
307
308 #define CHANNEL_CW_INT    0x00002
309 #define CHANNEL_CCK       0x00020
310 #define CHANNEL_OFDM      0x00040
311 #define CHANNEL_2GHZ      0x00080
312 #define CHANNEL_5GHZ      0x00100
313 #define CHANNEL_PASSIVE   0x00200
314 #define CHANNEL_DYN       0x00400
315 #define CHANNEL_HALF      0x04000
316 #define CHANNEL_QUARTER   0x08000
317 #define CHANNEL_HT20      0x10000
318 #define CHANNEL_HT40PLUS  0x20000
319 #define CHANNEL_HT40MINUS 0x40000
320
321 #define CHANNEL_A           (CHANNEL_5GHZ|CHANNEL_OFDM)
322 #define CHANNEL_B           (CHANNEL_2GHZ|CHANNEL_CCK)
323 #define CHANNEL_G           (CHANNEL_2GHZ|CHANNEL_OFDM)
324 #define CHANNEL_G_HT20      (CHANNEL_2GHZ|CHANNEL_HT20)
325 #define CHANNEL_A_HT20      (CHANNEL_5GHZ|CHANNEL_HT20)
326 #define CHANNEL_G_HT40PLUS  (CHANNEL_2GHZ|CHANNEL_HT40PLUS)
327 #define CHANNEL_G_HT40MINUS (CHANNEL_2GHZ|CHANNEL_HT40MINUS)
328 #define CHANNEL_A_HT40PLUS  (CHANNEL_5GHZ|CHANNEL_HT40PLUS)
329 #define CHANNEL_A_HT40MINUS (CHANNEL_5GHZ|CHANNEL_HT40MINUS)
330 #define CHANNEL_ALL                             \
331         (CHANNEL_OFDM|                          \
332          CHANNEL_CCK|                           \
333          CHANNEL_2GHZ |                         \
334          CHANNEL_5GHZ |                         \
335          CHANNEL_HT20 |                         \
336          CHANNEL_HT40PLUS |                     \
337          CHANNEL_HT40MINUS)
338
339 struct ath9k_hw_cal_data {
340         u16 channel;
341         u32 channelFlags;
342         int32_t CalValid;
343         int8_t iCoff;
344         int8_t qCoff;
345         bool paprd_done;
346         bool nfcal_pending;
347         bool nfcal_interference;
348         u16 small_signal_gain[AR9300_MAX_CHAINS];
349         u32 pa_table[AR9300_MAX_CHAINS][PAPRD_TABLE_SZ];
350         struct ath9k_nfcal_hist nfCalHist[NUM_NF_READINGS];
351 };
352
353 struct ath9k_channel {
354         struct ieee80211_channel *chan;
355         u16 channel;
356         u32 channelFlags;
357         u32 chanmode;
358         s16 noisefloor;
359 };
360
361 #define IS_CHAN_G(_c) ((((_c)->channelFlags & (CHANNEL_G)) == CHANNEL_G) || \
362        (((_c)->channelFlags & CHANNEL_G_HT20) == CHANNEL_G_HT20) || \
363        (((_c)->channelFlags & CHANNEL_G_HT40PLUS) == CHANNEL_G_HT40PLUS) || \
364        (((_c)->channelFlags & CHANNEL_G_HT40MINUS) == CHANNEL_G_HT40MINUS))
365 #define IS_CHAN_OFDM(_c) (((_c)->channelFlags & CHANNEL_OFDM) != 0)
366 #define IS_CHAN_5GHZ(_c) (((_c)->channelFlags & CHANNEL_5GHZ) != 0)
367 #define IS_CHAN_2GHZ(_c) (((_c)->channelFlags & CHANNEL_2GHZ) != 0)
368 #define IS_CHAN_HALF_RATE(_c) (((_c)->channelFlags & CHANNEL_HALF) != 0)
369 #define IS_CHAN_QUARTER_RATE(_c) (((_c)->channelFlags & CHANNEL_QUARTER) != 0)
370 #define IS_CHAN_A_FAST_CLOCK(_ah, _c)                   \
371         ((((_c)->channelFlags & CHANNEL_5GHZ) != 0) &&  \
372          ((_ah)->caps.hw_caps & ATH9K_HW_CAP_FASTCLOCK))
373
374 /* These macros check chanmode and not channelFlags */
375 #define IS_CHAN_B(_c) ((_c)->chanmode == CHANNEL_B)
376 #define IS_CHAN_HT20(_c) (((_c)->chanmode == CHANNEL_A_HT20) || \
377                           ((_c)->chanmode == CHANNEL_G_HT20))
378 #define IS_CHAN_HT40(_c) (((_c)->chanmode == CHANNEL_A_HT40PLUS) ||     \
379                           ((_c)->chanmode == CHANNEL_A_HT40MINUS) ||    \
380                           ((_c)->chanmode == CHANNEL_G_HT40PLUS) ||     \
381                           ((_c)->chanmode == CHANNEL_G_HT40MINUS))
382 #define IS_CHAN_HT(_c) (IS_CHAN_HT20((_c)) || IS_CHAN_HT40((_c)))
383
384 enum ath9k_power_mode {
385         ATH9K_PM_AWAKE = 0,
386         ATH9K_PM_FULL_SLEEP,
387         ATH9K_PM_NETWORK_SLEEP,
388         ATH9K_PM_UNDEFINED
389 };
390
391 enum ath9k_tp_scale {
392         ATH9K_TP_SCALE_MAX = 0,
393         ATH9K_TP_SCALE_50,
394         ATH9K_TP_SCALE_25,
395         ATH9K_TP_SCALE_12,
396         ATH9K_TP_SCALE_MIN
397 };
398
399 enum ser_reg_mode {
400         SER_REG_MODE_OFF = 0,
401         SER_REG_MODE_ON = 1,
402         SER_REG_MODE_AUTO = 2,
403 };
404
405 enum ath9k_rx_qtype {
406         ATH9K_RX_QUEUE_HP,
407         ATH9K_RX_QUEUE_LP,
408         ATH9K_RX_QUEUE_MAX,
409 };
410
411 struct ath9k_beacon_state {
412         u32 bs_nexttbtt;
413         u32 bs_nextdtim;
414         u32 bs_intval;
415 #define ATH9K_BEACON_PERIOD       0x0000ffff
416 #define ATH9K_BEACON_ENA          0x00800000
417 #define ATH9K_BEACON_RESET_TSF    0x01000000
418 #define ATH9K_TSFOOR_THRESHOLD    0x00004240 /* 16k us */
419         u32 bs_dtimperiod;
420         u16 bs_cfpperiod;
421         u16 bs_cfpmaxduration;
422         u32 bs_cfpnext;
423         u16 bs_timoffset;
424         u16 bs_bmissthreshold;
425         u32 bs_sleepduration;
426         u32 bs_tsfoor_threshold;
427 };
428
429 struct chan_centers {
430         u16 synth_center;
431         u16 ctl_center;
432         u16 ext_center;
433 };
434
435 enum {
436         ATH9K_RESET_POWER_ON,
437         ATH9K_RESET_WARM,
438         ATH9K_RESET_COLD,
439 };
440
441 struct ath9k_hw_version {
442         u32 magic;
443         u16 devid;
444         u16 subvendorid;
445         u32 macVersion;
446         u16 macRev;
447         u16 phyRev;
448         u16 analog5GhzRev;
449         u16 analog2GhzRev;
450         u16 subsysid;
451 };
452
453 /* Generic TSF timer definitions */
454
455 #define ATH_MAX_GEN_TIMER       16
456
457 #define AR_GENTMR_BIT(_index)   (1 << (_index))
458
459 /*
460  * Using de Bruijin sequence to look up 1's index in a 32 bit number
461  * debruijn32 = 0000 0111 0111 1100 1011 0101 0011 0001
462  */
463 #define debruijn32 0x077CB531U
464
465 struct ath_gen_timer_configuration {
466         u32 next_addr;
467         u32 period_addr;
468         u32 mode_addr;
469         u32 mode_mask;
470 };
471
472 struct ath_gen_timer {
473         void (*trigger)(void *arg);
474         void (*overflow)(void *arg);
475         void *arg;
476         u8 index;
477 };
478
479 struct ath_gen_timer_table {
480         u32 gen_timer_index[32];
481         struct ath_gen_timer *timers[ATH_MAX_GEN_TIMER];
482         union {
483                 unsigned long timer_bits;
484                 u16 val;
485         } timer_mask;
486 };
487
488 struct ath_hw_antcomb_conf {
489         u8 main_lna_conf;
490         u8 alt_lna_conf;
491         u8 fast_div_bias;
492 };
493
494 /**
495  * struct ath_hw_private_ops - callbacks used internally by hardware code
496  *
497  * This structure contains private callbacks designed to only be used internally
498  * by the hardware core.
499  *
500  * @init_cal_settings: setup types of calibrations supported
501  * @init_cal: starts actual calibration
502  *
503  * @init_mode_regs: Initializes mode registers
504  * @init_mode_gain_regs: Initialize TX/RX gain registers
505  * @macversion_supported: If this specific mac revision is supported
506  *
507  * @rf_set_freq: change frequency
508  * @spur_mitigate_freq: spur mitigation
509  * @rf_alloc_ext_banks:
510  * @rf_free_ext_banks:
511  * @set_rf_regs:
512  * @compute_pll_control: compute the PLL control value to use for
513  *      AR_RTC_PLL_CONTROL for a given channel
514  * @setup_calibration: set up calibration
515  * @iscal_supported: used to query if a type of calibration is supported
516  *
517  * @ani_reset: reset ANI parameters to default values
518  * @ani_lower_immunity: lower the noise immunity level. The level controls
519  *      the power-based packet detection on hardware. If a power jump is
520  *      detected the adapter takes it as an indication that a packet has
521  *      arrived. The level ranges from 0-5. Each level corresponds to a
522  *      few dB more of noise immunity. If you have a strong time-varying
523  *      interference that is causing false detections (OFDM timing errors or
524  *      CCK timing errors) the level can be increased.
525  * @ani_cache_ini_regs: cache the values for ANI from the initial
526  *      register settings through the register initialization.
527  */
528 struct ath_hw_private_ops {
529         /* Calibration ops */
530         void (*init_cal_settings)(struct ath_hw *ah);
531         bool (*init_cal)(struct ath_hw *ah, struct ath9k_channel *chan);
532
533         void (*init_mode_regs)(struct ath_hw *ah);
534         void (*init_mode_gain_regs)(struct ath_hw *ah);
535         bool (*macversion_supported)(u32 macversion);
536         void (*setup_calibration)(struct ath_hw *ah,
537                                   struct ath9k_cal_list *currCal);
538         bool (*iscal_supported)(struct ath_hw *ah,
539                                 enum ath9k_cal_types calType);
540
541         /* PHY ops */
542         int (*rf_set_freq)(struct ath_hw *ah,
543                            struct ath9k_channel *chan);
544         void (*spur_mitigate_freq)(struct ath_hw *ah,
545                                    struct ath9k_channel *chan);
546         int (*rf_alloc_ext_banks)(struct ath_hw *ah);
547         void (*rf_free_ext_banks)(struct ath_hw *ah);
548         bool (*set_rf_regs)(struct ath_hw *ah,
549                             struct ath9k_channel *chan,
550                             u16 modesIndex);
551         void (*set_channel_regs)(struct ath_hw *ah, struct ath9k_channel *chan);
552         void (*init_bb)(struct ath_hw *ah,
553                         struct ath9k_channel *chan);
554         int (*process_ini)(struct ath_hw *ah, struct ath9k_channel *chan);
555         void (*olc_init)(struct ath_hw *ah);
556         void (*set_rfmode)(struct ath_hw *ah, struct ath9k_channel *chan);
557         void (*mark_phy_inactive)(struct ath_hw *ah);
558         void (*set_delta_slope)(struct ath_hw *ah, struct ath9k_channel *chan);
559         bool (*rfbus_req)(struct ath_hw *ah);
560         void (*rfbus_done)(struct ath_hw *ah);
561         void (*enable_rfkill)(struct ath_hw *ah);
562         void (*restore_chainmask)(struct ath_hw *ah);
563         void (*set_diversity)(struct ath_hw *ah, bool value);
564         u32 (*compute_pll_control)(struct ath_hw *ah,
565                                    struct ath9k_channel *chan);
566         bool (*ani_control)(struct ath_hw *ah, enum ath9k_ani_cmd cmd,
567                             int param);
568         void (*do_getnf)(struct ath_hw *ah, int16_t nfarray[NUM_NF_READINGS]);
569
570         /* ANI */
571         void (*ani_reset)(struct ath_hw *ah, bool is_scanning);
572         void (*ani_lower_immunity)(struct ath_hw *ah);
573         void (*ani_cache_ini_regs)(struct ath_hw *ah);
574 };
575
576 /**
577  * struct ath_hw_ops - callbacks used by hardware code and driver code
578  *
579  * This structure contains callbacks designed to to be used internally by
580  * hardware code and also by the lower level driver.
581  *
582  * @config_pci_powersave:
583  * @calibrate: periodic calibration for NF, ANI, IQ, ADC gain, ADC-DC
584  *
585  * @ani_proc_mib_event: process MIB events, this would happen upon specific ANI
586  *      thresholds being reached or having overflowed.
587  * @ani_monitor: called periodically by the core driver to collect
588  *      MIB stats and adjust ANI if specific thresholds have been reached.
589  */
590 struct ath_hw_ops {
591         void (*config_pci_powersave)(struct ath_hw *ah,
592                                      int restore,
593                                      int power_off);
594         void (*rx_enable)(struct ath_hw *ah);
595         void (*set_desc_link)(void *ds, u32 link);
596         void (*get_desc_link)(void *ds, u32 **link);
597         bool (*calibrate)(struct ath_hw *ah,
598                           struct ath9k_channel *chan,
599                           u8 rxchainmask,
600                           bool longcal);
601         bool (*get_isr)(struct ath_hw *ah, enum ath9k_int *masked);
602         void (*fill_txdesc)(struct ath_hw *ah, void *ds, u32 seglen,
603                             bool is_firstseg, bool is_is_lastseg,
604                             const void *ds0, dma_addr_t buf_addr,
605                             unsigned int qcu);
606         int (*proc_txdesc)(struct ath_hw *ah, void *ds,
607                            struct ath_tx_status *ts);
608         void (*set11n_txdesc)(struct ath_hw *ah, void *ds,
609                               u32 pktLen, enum ath9k_pkt_type type,
610                               u32 txPower, u32 keyIx,
611                               enum ath9k_key_type keyType,
612                               u32 flags);
613         void (*set11n_ratescenario)(struct ath_hw *ah, void *ds,
614                                 void *lastds,
615                                 u32 durUpdateEn, u32 rtsctsRate,
616                                 u32 rtsctsDuration,
617                                 struct ath9k_11n_rate_series series[],
618                                 u32 nseries, u32 flags);
619         void (*set11n_aggr_first)(struct ath_hw *ah, void *ds,
620                                   u32 aggrLen);
621         void (*set11n_aggr_middle)(struct ath_hw *ah, void *ds,
622                                    u32 numDelims);
623         void (*set11n_aggr_last)(struct ath_hw *ah, void *ds);
624         void (*clr11n_aggr)(struct ath_hw *ah, void *ds);
625         void (*set11n_burstduration)(struct ath_hw *ah, void *ds,
626                                      u32 burstDuration);
627         void (*set11n_virtualmorefrag)(struct ath_hw *ah, void *ds,
628                                        u32 vmf);
629
630         void (*ani_proc_mib_event)(struct ath_hw *ah);
631         void (*ani_monitor)(struct ath_hw *ah, struct ath9k_channel *chan);
632 };
633
634 struct ath_nf_limits {
635         s16 max;
636         s16 min;
637         s16 nominal;
638 };
639
640 struct ath_hw {
641         struct ieee80211_hw *hw;
642         struct ath_common common;
643         struct ath9k_hw_version hw_version;
644         struct ath9k_ops_config config;
645         struct ath9k_hw_capabilities caps;
646         struct ath9k_channel channels[38];
647         struct ath9k_channel *curchan;
648
649         union {
650                 struct ar5416_eeprom_def def;
651                 struct ar5416_eeprom_4k map4k;
652                 struct ar9287_eeprom map9287;
653                 struct ar9300_eeprom ar9300_eep;
654         } eeprom;
655         const struct eeprom_ops *eep_ops;
656
657         bool sw_mgmt_crypto;
658         bool is_pciexpress;
659         bool need_an_top2_fixup;
660         u16 tx_trig_level;
661
662         u32 nf_regs[6];
663         struct ath_nf_limits nf_2g;
664         struct ath_nf_limits nf_5g;
665         u16 rfsilent;
666         u32 rfkill_gpio;
667         u32 rfkill_polarity;
668         u32 ah_flags;
669
670         bool htc_reset_init;
671
672         enum nl80211_iftype opmode;
673         enum ath9k_power_mode power_mode;
674
675         struct ath9k_hw_cal_data *caldata;
676         struct ath9k_pacal_info pacal_info;
677         struct ar5416Stats stats;
678         struct ath9k_tx_queue_info txq[ATH9K_NUM_TX_QUEUES];
679
680         int16_t curchan_rad_index;
681         enum ath9k_int imask;
682         u32 imrs2_reg;
683         u32 txok_interrupt_mask;
684         u32 txerr_interrupt_mask;
685         u32 txdesc_interrupt_mask;
686         u32 txeol_interrupt_mask;
687         u32 txurn_interrupt_mask;
688         bool chip_fullsleep;
689         u32 atim_window;
690
691         /* Calibration */
692         enum ath9k_cal_types supp_cals;
693         struct ath9k_cal_list iq_caldata;
694         struct ath9k_cal_list adcgain_caldata;
695         struct ath9k_cal_list adcdc_caldata;
696         struct ath9k_cal_list tempCompCalData;
697         struct ath9k_cal_list *cal_list;
698         struct ath9k_cal_list *cal_list_last;
699         struct ath9k_cal_list *cal_list_curr;
700 #define totalPowerMeasI meas0.unsign
701 #define totalPowerMeasQ meas1.unsign
702 #define totalIqCorrMeas meas2.sign
703 #define totalAdcIOddPhase  meas0.unsign
704 #define totalAdcIEvenPhase meas1.unsign
705 #define totalAdcQOddPhase  meas2.unsign
706 #define totalAdcQEvenPhase meas3.unsign
707 #define totalAdcDcOffsetIOddPhase  meas0.sign
708 #define totalAdcDcOffsetIEvenPhase meas1.sign
709 #define totalAdcDcOffsetQOddPhase  meas2.sign
710 #define totalAdcDcOffsetQEvenPhase meas3.sign
711         union {
712                 u32 unsign[AR5416_MAX_CHAINS];
713                 int32_t sign[AR5416_MAX_CHAINS];
714         } meas0;
715         union {
716                 u32 unsign[AR5416_MAX_CHAINS];
717                 int32_t sign[AR5416_MAX_CHAINS];
718         } meas1;
719         union {
720                 u32 unsign[AR5416_MAX_CHAINS];
721                 int32_t sign[AR5416_MAX_CHAINS];
722         } meas2;
723         union {
724                 u32 unsign[AR5416_MAX_CHAINS];
725                 int32_t sign[AR5416_MAX_CHAINS];
726         } meas3;
727         u16 cal_samples;
728
729         u32 sta_id1_defaults;
730         u32 misc_mode;
731         enum {
732                 AUTO_32KHZ,
733                 USE_32KHZ,
734                 DONT_USE_32KHZ,
735         } enable_32kHz_clock;
736
737         /* Private to hardware code */
738         struct ath_hw_private_ops private_ops;
739         /* Accessed by the lower level driver */
740         struct ath_hw_ops ops;
741
742         /* Used to program the radio on non single-chip devices */
743         u32 *analogBank0Data;
744         u32 *analogBank1Data;
745         u32 *analogBank2Data;
746         u32 *analogBank3Data;
747         u32 *analogBank6Data;
748         u32 *analogBank6TPCData;
749         u32 *analogBank7Data;
750         u32 *addac5416_21;
751         u32 *bank6Temp;
752
753         u8 txpower_limit;
754         int16_t txpower_indexoffset;
755         int coverage_class;
756         u32 beacon_interval;
757         u32 slottime;
758         u32 globaltxtimeout;
759
760         /* ANI */
761         u32 proc_phyerr;
762         u32 aniperiod;
763         struct ar5416AniState *curani;
764         struct ar5416AniState ani[255];
765         int totalSizeDesired[5];
766         int coarse_high[5];
767         int coarse_low[5];
768         int firpwr[5];
769         enum ath9k_ani_cmd ani_function;
770
771         /* Bluetooth coexistance */
772         struct ath_btcoex_hw btcoex_hw;
773
774         u32 intr_txqs;
775         u8 txchainmask;
776         u8 rxchainmask;
777
778         u32 originalGain[22];
779         int initPDADC;
780         int PDADCdelta;
781         u8 led_pin;
782
783         struct ar5416IniArray iniModes;
784         struct ar5416IniArray iniCommon;
785         struct ar5416IniArray iniBank0;
786         struct ar5416IniArray iniBB_RfGain;
787         struct ar5416IniArray iniBank1;
788         struct ar5416IniArray iniBank2;
789         struct ar5416IniArray iniBank3;
790         struct ar5416IniArray iniBank6;
791         struct ar5416IniArray iniBank6TPC;
792         struct ar5416IniArray iniBank7;
793         struct ar5416IniArray iniAddac;
794         struct ar5416IniArray iniPcieSerdes;
795         struct ar5416IniArray iniPcieSerdesLowPower;
796         struct ar5416IniArray iniModesAdditional;
797         struct ar5416IniArray iniModesRxGain;
798         struct ar5416IniArray iniModesTxGain;
799         struct ar5416IniArray iniModes_9271_1_0_only;
800         struct ar5416IniArray iniCckfirNormal;
801         struct ar5416IniArray iniCckfirJapan2484;
802         struct ar5416IniArray iniCommon_normal_cck_fir_coeff_9271;
803         struct ar5416IniArray iniCommon_japan_2484_cck_fir_coeff_9271;
804         struct ar5416IniArray iniModes_9271_ANI_reg;
805         struct ar5416IniArray iniModes_high_power_tx_gain_9271;
806         struct ar5416IniArray iniModes_normal_power_tx_gain_9271;
807
808         struct ar5416IniArray iniMac[ATH_INI_NUM_SPLIT];
809         struct ar5416IniArray iniBB[ATH_INI_NUM_SPLIT];
810         struct ar5416IniArray iniRadio[ATH_INI_NUM_SPLIT];
811         struct ar5416IniArray iniSOC[ATH_INI_NUM_SPLIT];
812
813         u32 intr_gen_timer_trigger;
814         u32 intr_gen_timer_thresh;
815         struct ath_gen_timer_table hw_gen_timers;
816
817         struct ar9003_txs *ts_ring;
818         void *ts_start;
819         u32 ts_paddr_start;
820         u32 ts_paddr_end;
821         u16 ts_tail;
822         u8 ts_size;
823
824         u32 bb_watchdog_last_status;
825         u32 bb_watchdog_timeout_ms; /* in ms, 0 to disable */
826
827         u32 paprd_gain_table_entries[PAPRD_GAIN_TABLE_ENTRIES];
828         u8 paprd_gain_table_index[PAPRD_GAIN_TABLE_ENTRIES];
829         /*
830          * Store the permanent value of Reg 0x4004in WARegVal
831          * so we dont have to R/M/W. We should not be reading
832          * this register when in sleep states.
833          */
834         u32 WARegVal;
835 };
836
837 static inline struct ath_common *ath9k_hw_common(struct ath_hw *ah)
838 {
839         return &ah->common;
840 }
841
842 static inline struct ath_regulatory *ath9k_hw_regulatory(struct ath_hw *ah)
843 {
844         return &(ath9k_hw_common(ah)->regulatory);
845 }
846
847 static inline struct ath_hw_private_ops *ath9k_hw_private_ops(struct ath_hw *ah)
848 {
849         return &ah->private_ops;
850 }
851
852 static inline struct ath_hw_ops *ath9k_hw_ops(struct ath_hw *ah)
853 {
854         return &ah->ops;
855 }
856
857 static inline int sign_extend(int val, const int nbits)
858 {
859         int order = BIT(nbits-1);
860         return (val ^ order) - order;
861 }
862
863 /* Initialization, Detach, Reset */
864 const char *ath9k_hw_probe(u16 vendorid, u16 devid);
865 void ath9k_hw_deinit(struct ath_hw *ah);
866 int ath9k_hw_init(struct ath_hw *ah);
867 int ath9k_hw_reset(struct ath_hw *ah, struct ath9k_channel *chan,
868                    struct ath9k_hw_cal_data *caldata, bool bChannelChange);
869 int ath9k_hw_fill_cap_info(struct ath_hw *ah);
870 u32 ath9k_regd_get_ctl(struct ath_regulatory *reg, struct ath9k_channel *chan);
871
872 /* GPIO / RFKILL / Antennae */
873 void ath9k_hw_cfg_gpio_input(struct ath_hw *ah, u32 gpio);
874 u32 ath9k_hw_gpio_get(struct ath_hw *ah, u32 gpio);
875 void ath9k_hw_cfg_output(struct ath_hw *ah, u32 gpio,
876                          u32 ah_signal_type);
877 void ath9k_hw_set_gpio(struct ath_hw *ah, u32 gpio, u32 val);
878 u32 ath9k_hw_getdefantenna(struct ath_hw *ah);
879 void ath9k_hw_setantenna(struct ath_hw *ah, u32 antenna);
880 void ath9k_hw_antdiv_comb_conf_get(struct ath_hw *ah,
881                                    struct ath_hw_antcomb_conf *antconf);
882 void ath9k_hw_antdiv_comb_conf_set(struct ath_hw *ah,
883                                    struct ath_hw_antcomb_conf *antconf);
884
885 /* General Operation */
886 bool ath9k_hw_wait(struct ath_hw *ah, u32 reg, u32 mask, u32 val, u32 timeout);
887 u32 ath9k_hw_reverse_bits(u32 val, u32 n);
888 bool ath9k_get_channel_edges(struct ath_hw *ah, u16 flags, u16 *low, u16 *high);
889 u16 ath9k_hw_computetxtime(struct ath_hw *ah,
890                            u8 phy, int kbps,
891                            u32 frameLen, u16 rateix, bool shortPreamble);
892 void ath9k_hw_get_channel_centers(struct ath_hw *ah,
893                                   struct ath9k_channel *chan,
894                                   struct chan_centers *centers);
895 u32 ath9k_hw_getrxfilter(struct ath_hw *ah);
896 void ath9k_hw_setrxfilter(struct ath_hw *ah, u32 bits);
897 bool ath9k_hw_phy_disable(struct ath_hw *ah);
898 bool ath9k_hw_disable(struct ath_hw *ah);
899 void ath9k_hw_set_txpowerlimit(struct ath_hw *ah, u32 limit);
900 void ath9k_hw_setopmode(struct ath_hw *ah);
901 void ath9k_hw_setmcastfilter(struct ath_hw *ah, u32 filter0, u32 filter1);
902 void ath9k_hw_setbssidmask(struct ath_hw *ah);
903 void ath9k_hw_write_associd(struct ath_hw *ah);
904 u64 ath9k_hw_gettsf64(struct ath_hw *ah);
905 void ath9k_hw_settsf64(struct ath_hw *ah, u64 tsf64);
906 void ath9k_hw_reset_tsf(struct ath_hw *ah);
907 void ath9k_hw_set_tsfadjust(struct ath_hw *ah, u32 setting);
908 void ath9k_hw_init_global_settings(struct ath_hw *ah);
909 void ath9k_hw_set11nmac2040(struct ath_hw *ah);
910 void ath9k_hw_beaconinit(struct ath_hw *ah, u32 next_beacon, u32 beacon_period);
911 void ath9k_hw_set_sta_beacon_timers(struct ath_hw *ah,
912                                     const struct ath9k_beacon_state *bs);
913 bool ath9k_hw_check_alive(struct ath_hw *ah);
914
915 bool ath9k_hw_setpower(struct ath_hw *ah, enum ath9k_power_mode mode);
916
917 /* Generic hw timer primitives */
918 struct ath_gen_timer *ath_gen_timer_alloc(struct ath_hw *ah,
919                                           void (*trigger)(void *),
920                                           void (*overflow)(void *),
921                                           void *arg,
922                                           u8 timer_index);
923 void ath9k_hw_gen_timer_start(struct ath_hw *ah,
924                               struct ath_gen_timer *timer,
925                               u32 timer_next,
926                               u32 timer_period);
927 void ath9k_hw_gen_timer_stop(struct ath_hw *ah, struct ath_gen_timer *timer);
928
929 void ath_gen_timer_free(struct ath_hw *ah, struct ath_gen_timer *timer);
930 void ath_gen_timer_isr(struct ath_hw *hw);
931 u32 ath9k_hw_gettsf32(struct ath_hw *ah);
932
933 void ath9k_hw_name(struct ath_hw *ah, char *hw_name, size_t len);
934
935 /* HTC */
936 void ath9k_hw_htc_resetinit(struct ath_hw *ah);
937
938 /* PHY */
939 void ath9k_hw_get_delta_slope_vals(struct ath_hw *ah, u32 coef_scaled,
940                                    u32 *coef_mantissa, u32 *coef_exponent);
941
942 /*
943  * Code Specific to AR5008, AR9001 or AR9002,
944  * we stuff these here to avoid callbacks for AR9003.
945  */
946 void ar9002_hw_cck_chan14_spread(struct ath_hw *ah);
947 int ar9002_hw_rf_claim(struct ath_hw *ah);
948 void ar9002_hw_enable_async_fifo(struct ath_hw *ah);
949 void ar9002_hw_update_async_fifo(struct ath_hw *ah);
950 void ar9002_hw_enable_wep_aggregation(struct ath_hw *ah);
951
952 /*
953  * Code specific to AR9003, we stuff these here to avoid callbacks
954  * for older families
955  */
956 void ar9003_hw_bb_watchdog_config(struct ath_hw *ah);
957 void ar9003_hw_bb_watchdog_read(struct ath_hw *ah);
958 void ar9003_hw_bb_watchdog_dbg_info(struct ath_hw *ah);
959 void ar9003_paprd_enable(struct ath_hw *ah, bool val);
960 void ar9003_paprd_populate_single_table(struct ath_hw *ah,
961                                         struct ath9k_hw_cal_data *caldata,
962                                         int chain);
963 int ar9003_paprd_create_curve(struct ath_hw *ah,
964                               struct ath9k_hw_cal_data *caldata, int chain);
965 int ar9003_paprd_setup_gain_table(struct ath_hw *ah, int chain);
966 int ar9003_paprd_init_table(struct ath_hw *ah);
967 bool ar9003_paprd_is_done(struct ath_hw *ah);
968 void ar9003_hw_set_paprd_txdesc(struct ath_hw *ah, void *ds, u8 chains);
969
970 /* Hardware family op attach helpers */
971 void ar5008_hw_attach_phy_ops(struct ath_hw *ah);
972 void ar9002_hw_attach_phy_ops(struct ath_hw *ah);
973 void ar9003_hw_attach_phy_ops(struct ath_hw *ah);
974
975 void ar9002_hw_attach_calib_ops(struct ath_hw *ah);
976 void ar9003_hw_attach_calib_ops(struct ath_hw *ah);
977
978 void ar9002_hw_attach_ops(struct ath_hw *ah);
979 void ar9003_hw_attach_ops(struct ath_hw *ah);
980
981 void ar9002_hw_load_ani_reg(struct ath_hw *ah, struct ath9k_channel *chan);
982 /*
983  * ANI work can be shared between all families but a next
984  * generation implementation of ANI will be used only for AR9003 only
985  * for now as the other families still need to be tested with the same
986  * next generation ANI. Feel free to start testing it though for the
987  * older families (AR5008, AR9001, AR9002) by using modparam_force_new_ani.
988  */
989 extern int modparam_force_new_ani;
990 void ath9k_hw_attach_ani_ops_old(struct ath_hw *ah);
991 void ath9k_hw_attach_ani_ops_new(struct ath_hw *ah);
992
993 #define ATH_PCIE_CAP_LINK_CTRL  0x70
994 #define ATH_PCIE_CAP_LINK_L0S   1
995 #define ATH_PCIE_CAP_LINK_L1    2
996
997 #define ATH9K_CLOCK_RATE_CCK            22
998 #define ATH9K_CLOCK_RATE_5GHZ_OFDM      40
999 #define ATH9K_CLOCK_RATE_2GHZ_OFDM      44
1000 #define ATH9K_CLOCK_FAST_RATE_5GHZ_OFDM 44
1001
1002 #endif