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