xref: /openbmc/linux/drivers/net/wireless/ath/ath9k/hw.h (revision cd5d5810)
1 /*
2  * Copyright (c) 2008-2011 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 #include <linux/firmware.h>
24 
25 #include "mac.h"
26 #include "ani.h"
27 #include "eeprom.h"
28 #include "calib.h"
29 #include "reg.h"
30 #include "phy.h"
31 #include "btcoex.h"
32 
33 #include "../regd.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 #define AR9300_DEVID_AR9340	0x0031
48 #define AR9300_DEVID_AR9485_PCIE 0x0032
49 #define AR9300_DEVID_AR9580	0x0033
50 #define AR9300_DEVID_AR9462	0x0034
51 #define AR9300_DEVID_AR9330	0x0035
52 #define AR9300_DEVID_QCA955X	0x0038
53 #define AR9485_DEVID_AR1111	0x0037
54 #define AR9300_DEVID_AR9565     0x0036
55 
56 #define AR5416_AR9100_DEVID	0x000b
57 
58 #define	AR_SUBVENDOR_ID_NOG	0x0e11
59 #define AR_SUBVENDOR_ID_NEW_A	0x7065
60 #define AR5416_MAGIC		0x19641014
61 
62 #define AR9280_COEX2WIRE_SUBSYSID	0x309b
63 #define AT9285_COEX3WIRE_SA_SUBSYSID	0x30aa
64 #define AT9285_COEX3WIRE_DA_SUBSYSID	0x30ab
65 
66 #define ATH_AMPDU_LIMIT_MAX        (64 * 1024 - 1)
67 
68 #define	ATH_DEFAULT_NOISE_FLOOR -95
69 
70 #define ATH9K_RSSI_BAD			-128
71 
72 #define ATH9K_NUM_CHANNELS	38
73 
74 /* Register read/write primitives */
75 #define REG_WRITE(_ah, _reg, _val) \
76 	(_ah)->reg_ops.write((_ah), (_val), (_reg))
77 
78 #define REG_READ(_ah, _reg) \
79 	(_ah)->reg_ops.read((_ah), (_reg))
80 
81 #define REG_READ_MULTI(_ah, _addr, _val, _cnt)		\
82 	(_ah)->reg_ops.multi_read((_ah), (_addr), (_val), (_cnt))
83 
84 #define REG_RMW(_ah, _reg, _set, _clr) \
85 	(_ah)->reg_ops.rmw((_ah), (_reg), (_set), (_clr))
86 
87 #define ENABLE_REGWRITE_BUFFER(_ah)					\
88 	do {								\
89 		if ((_ah)->reg_ops.enable_write_buffer)	\
90 			(_ah)->reg_ops.enable_write_buffer((_ah)); \
91 	} while (0)
92 
93 #define REGWRITE_BUFFER_FLUSH(_ah)					\
94 	do {								\
95 		if ((_ah)->reg_ops.write_flush)		\
96 			(_ah)->reg_ops.write_flush((_ah));	\
97 	} while (0)
98 
99 #define PR_EEP(_s, _val)						\
100 	do {								\
101 		len += snprintf(buf + len, size - len, "%20s : %10d\n",	\
102 				_s, (_val));				\
103 	} while (0)
104 
105 #define SM(_v, _f)  (((_v) << _f##_S) & _f)
106 #define MS(_v, _f)  (((_v) & _f) >> _f##_S)
107 #define REG_RMW_FIELD(_a, _r, _f, _v) \
108 	REG_RMW(_a, _r, (((_v) << _f##_S) & _f), (_f))
109 #define REG_READ_FIELD(_a, _r, _f) \
110 	(((REG_READ(_a, _r) & _f) >> _f##_S))
111 #define REG_SET_BIT(_a, _r, _f) \
112 	REG_RMW(_a, _r, (_f), 0)
113 #define REG_CLR_BIT(_a, _r, _f) \
114 	REG_RMW(_a, _r, 0, (_f))
115 
116 #define DO_DELAY(x) do {					\
117 		if (((++(x) % 64) == 0) &&			\
118 		    (ath9k_hw_common(ah)->bus_ops->ath_bus_type	\
119 			!= ATH_USB))				\
120 			udelay(1);				\
121 	} while (0)
122 
123 #define REG_WRITE_ARRAY(iniarray, column, regWr) \
124 	ath9k_hw_write_array(ah, iniarray, column, &(regWr))
125 
126 #define AR_GPIO_OUTPUT_MUX_AS_OUTPUT             0
127 #define AR_GPIO_OUTPUT_MUX_AS_PCIE_ATTENTION_LED 1
128 #define AR_GPIO_OUTPUT_MUX_AS_PCIE_POWER_LED     2
129 #define AR_GPIO_OUTPUT_MUX_AS_TX_FRAME           3
130 #define AR_GPIO_OUTPUT_MUX_AS_RX_CLEAR_EXTERNAL  4
131 #define AR_GPIO_OUTPUT_MUX_AS_MAC_NETWORK_LED    5
132 #define AR_GPIO_OUTPUT_MUX_AS_MAC_POWER_LED      6
133 #define AR_GPIO_OUTPUT_MUX_AS_MCI_WLAN_DATA      0x16
134 #define AR_GPIO_OUTPUT_MUX_AS_MCI_WLAN_CLK       0x17
135 #define AR_GPIO_OUTPUT_MUX_AS_MCI_BT_DATA        0x18
136 #define AR_GPIO_OUTPUT_MUX_AS_MCI_BT_CLK         0x19
137 #define AR_GPIO_OUTPUT_MUX_AS_WL_IN_TX           0x14
138 #define AR_GPIO_OUTPUT_MUX_AS_WL_IN_RX           0x13
139 #define AR_GPIO_OUTPUT_MUX_AS_BT_IN_TX           9
140 #define AR_GPIO_OUTPUT_MUX_AS_BT_IN_RX           8
141 #define AR_GPIO_OUTPUT_MUX_AS_RUCKUS_STROBE      0x1d
142 #define AR_GPIO_OUTPUT_MUX_AS_RUCKUS_DATA        0x1e
143 
144 #define AR_GPIOD_MASK               0x00001FFF
145 #define AR_GPIO_BIT(_gpio)          (1 << (_gpio))
146 
147 #define BASE_ACTIVATE_DELAY         100
148 #define RTC_PLL_SETTLE_DELAY        (AR_SREV_9340(ah) ? 1000 : 100)
149 #define COEF_SCALE_S                24
150 #define HT40_CHANNEL_CENTER_SHIFT   10
151 
152 #define ATH9K_ANTENNA0_CHAINMASK    0x1
153 #define ATH9K_ANTENNA1_CHAINMASK    0x2
154 
155 #define ATH9K_NUM_DMA_DEBUG_REGS    8
156 #define ATH9K_NUM_QUEUES            10
157 
158 #define MAX_RATE_POWER              63
159 #define AH_WAIT_TIMEOUT             100000 /* (us) */
160 #define AH_TSF_WRITE_TIMEOUT        100    /* (us) */
161 #define AH_TIME_QUANTUM             10
162 #define AR_KEYTABLE_SIZE            128
163 #define POWER_UP_TIME               10000
164 #define SPUR_RSSI_THRESH            40
165 #define UPPER_5G_SUB_BAND_START		5700
166 #define MID_5G_SUB_BAND_START		5400
167 
168 #define CAB_TIMEOUT_VAL             10
169 #define BEACON_TIMEOUT_VAL          10
170 #define MIN_BEACON_TIMEOUT_VAL      1
171 #define SLEEP_SLOP                  3
172 
173 #define INIT_CONFIG_STATUS          0x00000000
174 #define INIT_RSSI_THR               0x00000700
175 #define INIT_BCON_CNTRL_REG         0x00000000
176 
177 #define TU_TO_USEC(_tu)             ((_tu) << 10)
178 
179 #define ATH9K_HW_RX_HP_QDEPTH	16
180 #define ATH9K_HW_RX_LP_QDEPTH	128
181 
182 #define PAPRD_GAIN_TABLE_ENTRIES	32
183 #define PAPRD_TABLE_SZ			24
184 #define PAPRD_IDEAL_AGC2_PWR_RANGE	0xe0
185 
186 /*
187  * Wake on Wireless
188  */
189 
190 /* Keep Alive Frame */
191 #define KAL_FRAME_LEN		28
192 #define KAL_FRAME_TYPE		0x2	/* data frame */
193 #define KAL_FRAME_SUB_TYPE	0x4	/* null data frame */
194 #define KAL_DURATION_ID		0x3d
195 #define KAL_NUM_DATA_WORDS	6
196 #define KAL_NUM_DESC_WORDS	12
197 #define KAL_ANTENNA_MODE	1
198 #define KAL_TO_DS		1
199 #define KAL_DELAY		4	/*delay of 4ms between 2 KAL frames */
200 #define KAL_TIMEOUT		900
201 
202 #define MAX_PATTERN_SIZE		256
203 #define MAX_PATTERN_MASK_SIZE		32
204 #define MAX_NUM_PATTERN			8
205 #define MAX_NUM_USER_PATTERN		6 /*  deducting the disassociate and
206 					      deauthenticate packets */
207 
208 /*
209  * WoW trigger mapping to hardware code
210  */
211 
212 #define AH_WOW_USER_PATTERN_EN		BIT(0)
213 #define AH_WOW_MAGIC_PATTERN_EN		BIT(1)
214 #define AH_WOW_LINK_CHANGE		BIT(2)
215 #define AH_WOW_BEACON_MISS		BIT(3)
216 
217 enum ath_hw_txq_subtype {
218 	ATH_TXQ_AC_BE = 0,
219 	ATH_TXQ_AC_BK = 1,
220 	ATH_TXQ_AC_VI = 2,
221 	ATH_TXQ_AC_VO = 3,
222 };
223 
224 enum ath_ini_subsys {
225 	ATH_INI_PRE = 0,
226 	ATH_INI_CORE,
227 	ATH_INI_POST,
228 	ATH_INI_NUM_SPLIT,
229 };
230 
231 enum ath9k_hw_caps {
232 	ATH9K_HW_CAP_HT                         = BIT(0),
233 	ATH9K_HW_CAP_RFSILENT                   = BIT(1),
234 	ATH9K_HW_CAP_AUTOSLEEP                  = BIT(2),
235 	ATH9K_HW_CAP_4KB_SPLITTRANS             = BIT(3),
236 	ATH9K_HW_CAP_EDMA			= BIT(4),
237 	ATH9K_HW_CAP_RAC_SUPPORTED		= BIT(5),
238 	ATH9K_HW_CAP_LDPC			= BIT(6),
239 	ATH9K_HW_CAP_FASTCLOCK			= BIT(7),
240 	ATH9K_HW_CAP_SGI_20			= BIT(8),
241 	ATH9K_HW_CAP_ANT_DIV_COMB		= BIT(10),
242 	ATH9K_HW_CAP_2GHZ			= BIT(11),
243 	ATH9K_HW_CAP_5GHZ			= BIT(12),
244 	ATH9K_HW_CAP_APM			= BIT(13),
245 	ATH9K_HW_CAP_RTT			= BIT(14),
246 	ATH9K_HW_CAP_MCI			= BIT(15),
247 	ATH9K_HW_CAP_DFS			= BIT(16),
248 	ATH9K_HW_WOW_DEVICE_CAPABLE		= BIT(17),
249 	ATH9K_HW_CAP_PAPRD			= BIT(18),
250 	ATH9K_HW_CAP_FCC_BAND_SWITCH		= BIT(19),
251 	ATH9K_HW_CAP_BT_ANT_DIV			= BIT(20),
252 };
253 
254 /*
255  * WoW device capabilities
256  * @ATH9K_HW_WOW_DEVICE_CAPABLE: device revision is capable of WoW.
257  * @ATH9K_HW_WOW_PATTERN_MATCH_EXACT: device is capable of matching
258  * an exact user defined pattern or de-authentication/disassoc pattern.
259  * @ATH9K_HW_WOW_PATTERN_MATCH_DWORD: device requires the first four
260  * bytes of the pattern for user defined pattern, de-authentication and
261  * disassociation patterns for all types of possible frames recieved
262  * of those types.
263  */
264 
265 struct ath9k_hw_capabilities {
266 	u32 hw_caps; /* ATH9K_HW_CAP_* from ath9k_hw_caps */
267 	u16 rts_aggr_limit;
268 	u8 tx_chainmask;
269 	u8 rx_chainmask;
270 	u8 max_txchains;
271 	u8 max_rxchains;
272 	u8 num_gpio_pins;
273 	u8 rx_hp_qdepth;
274 	u8 rx_lp_qdepth;
275 	u8 rx_status_len;
276 	u8 tx_desc_len;
277 	u8 txs_len;
278 };
279 
280 struct ath9k_ops_config {
281 	int dma_beacon_response_time;
282 	int sw_beacon_response_time;
283 	int additional_swba_backoff;
284 	int ack_6mb;
285 	u32 cwm_ignore_extcca;
286 	bool pcieSerDesWrite;
287 	u8 pcie_clock_req;
288 	u32 pcie_waen;
289 	u8 analog_shiftreg;
290 	u32 ofdm_trig_low;
291 	u32 ofdm_trig_high;
292 	u32 cck_trig_high;
293 	u32 cck_trig_low;
294 	u32 enable_paprd;
295 	int serialize_regmode;
296 	bool rx_intr_mitigation;
297 	bool tx_intr_mitigation;
298 #define SPUR_DISABLE        	0
299 #define SPUR_ENABLE_IOCTL   	1
300 #define SPUR_ENABLE_EEPROM  	2
301 #define AR_SPUR_5413_1      	1640
302 #define AR_SPUR_5413_2      	1200
303 #define AR_NO_SPUR      	0x8000
304 #define AR_BASE_FREQ_2GHZ   	2300
305 #define AR_BASE_FREQ_5GHZ   	4900
306 #define AR_SPUR_FEEQ_BOUND_HT40 19
307 #define AR_SPUR_FEEQ_BOUND_HT20 10
308 	int spurmode;
309 	u16 spurchans[AR_EEPROM_MODAL_SPURS][2];
310 	u8 max_txtrig_level;
311 	u16 ani_poll_interval; /* ANI poll interval in ms */
312 
313 	/* Platform specific config */
314 	u32 aspm_l1_fix;
315 	u32 xlna_gpio;
316 	u32 ant_ctrl_comm2g_switch_enable;
317 	bool xatten_margin_cfg;
318 	bool alt_mingainidx;
319 };
320 
321 enum ath9k_int {
322 	ATH9K_INT_RX = 0x00000001,
323 	ATH9K_INT_RXDESC = 0x00000002,
324 	ATH9K_INT_RXHP = 0x00000001,
325 	ATH9K_INT_RXLP = 0x00000002,
326 	ATH9K_INT_RXNOFRM = 0x00000008,
327 	ATH9K_INT_RXEOL = 0x00000010,
328 	ATH9K_INT_RXORN = 0x00000020,
329 	ATH9K_INT_TX = 0x00000040,
330 	ATH9K_INT_TXDESC = 0x00000080,
331 	ATH9K_INT_TIM_TIMER = 0x00000100,
332 	ATH9K_INT_MCI = 0x00000200,
333 	ATH9K_INT_BB_WATCHDOG = 0x00000400,
334 	ATH9K_INT_TXURN = 0x00000800,
335 	ATH9K_INT_MIB = 0x00001000,
336 	ATH9K_INT_RXPHY = 0x00004000,
337 	ATH9K_INT_RXKCM = 0x00008000,
338 	ATH9K_INT_SWBA = 0x00010000,
339 	ATH9K_INT_BMISS = 0x00040000,
340 	ATH9K_INT_BNR = 0x00100000,
341 	ATH9K_INT_TIM = 0x00200000,
342 	ATH9K_INT_DTIM = 0x00400000,
343 	ATH9K_INT_DTIMSYNC = 0x00800000,
344 	ATH9K_INT_GPIO = 0x01000000,
345 	ATH9K_INT_CABEND = 0x02000000,
346 	ATH9K_INT_TSFOOR = 0x04000000,
347 	ATH9K_INT_GENTIMER = 0x08000000,
348 	ATH9K_INT_CST = 0x10000000,
349 	ATH9K_INT_GTT = 0x20000000,
350 	ATH9K_INT_FATAL = 0x40000000,
351 	ATH9K_INT_GLOBAL = 0x80000000,
352 	ATH9K_INT_BMISC = ATH9K_INT_TIM |
353 		ATH9K_INT_DTIM |
354 		ATH9K_INT_DTIMSYNC |
355 		ATH9K_INT_TSFOOR |
356 		ATH9K_INT_CABEND,
357 	ATH9K_INT_COMMON = ATH9K_INT_RXNOFRM |
358 		ATH9K_INT_RXDESC |
359 		ATH9K_INT_RXEOL |
360 		ATH9K_INT_RXORN |
361 		ATH9K_INT_TXURN |
362 		ATH9K_INT_TXDESC |
363 		ATH9K_INT_MIB |
364 		ATH9K_INT_RXPHY |
365 		ATH9K_INT_RXKCM |
366 		ATH9K_INT_SWBA |
367 		ATH9K_INT_BMISS |
368 		ATH9K_INT_GPIO,
369 	ATH9K_INT_NOCARD = 0xffffffff
370 };
371 
372 #define CHANNEL_CCK       0x00020
373 #define CHANNEL_OFDM      0x00040
374 #define CHANNEL_2GHZ      0x00080
375 #define CHANNEL_5GHZ      0x00100
376 #define CHANNEL_PASSIVE   0x00200
377 #define CHANNEL_DYN       0x00400
378 #define CHANNEL_HALF      0x04000
379 #define CHANNEL_QUARTER   0x08000
380 #define CHANNEL_HT20      0x10000
381 #define CHANNEL_HT40PLUS  0x20000
382 #define CHANNEL_HT40MINUS 0x40000
383 
384 #define CHANNEL_A           (CHANNEL_5GHZ|CHANNEL_OFDM)
385 #define CHANNEL_B           (CHANNEL_2GHZ|CHANNEL_CCK)
386 #define CHANNEL_G           (CHANNEL_2GHZ|CHANNEL_OFDM)
387 #define CHANNEL_G_HT20      (CHANNEL_2GHZ|CHANNEL_HT20)
388 #define CHANNEL_A_HT20      (CHANNEL_5GHZ|CHANNEL_HT20)
389 #define CHANNEL_G_HT40PLUS  (CHANNEL_2GHZ|CHANNEL_HT40PLUS)
390 #define CHANNEL_G_HT40MINUS (CHANNEL_2GHZ|CHANNEL_HT40MINUS)
391 #define CHANNEL_A_HT40PLUS  (CHANNEL_5GHZ|CHANNEL_HT40PLUS)
392 #define CHANNEL_A_HT40MINUS (CHANNEL_5GHZ|CHANNEL_HT40MINUS)
393 #define CHANNEL_ALL				\
394 	(CHANNEL_OFDM|				\
395 	 CHANNEL_CCK|				\
396 	 CHANNEL_2GHZ |				\
397 	 CHANNEL_5GHZ |				\
398 	 CHANNEL_HT20 |				\
399 	 CHANNEL_HT40PLUS |			\
400 	 CHANNEL_HT40MINUS)
401 
402 #define MAX_RTT_TABLE_ENTRY     6
403 #define MAX_IQCAL_MEASUREMENT	8
404 #define MAX_CL_TAB_ENTRY	16
405 #define CL_TAB_ENTRY(reg_base)	(reg_base + (4 * j))
406 
407 struct ath9k_hw_cal_data {
408 	u16 channel;
409 	u32 channelFlags;
410 	u32 chanmode;
411 	int32_t CalValid;
412 	int8_t iCoff;
413 	int8_t qCoff;
414 	bool rtt_done;
415 	bool paprd_packet_sent;
416 	bool paprd_done;
417 	bool nfcal_pending;
418 	bool nfcal_interference;
419 	bool done_txiqcal_once;
420 	bool done_txclcal_once;
421 	u16 small_signal_gain[AR9300_MAX_CHAINS];
422 	u32 pa_table[AR9300_MAX_CHAINS][PAPRD_TABLE_SZ];
423 	u32 num_measures[AR9300_MAX_CHAINS];
424 	int tx_corr_coeff[MAX_IQCAL_MEASUREMENT][AR9300_MAX_CHAINS];
425 	u32 tx_clcal[AR9300_MAX_CHAINS][MAX_CL_TAB_ENTRY];
426 	u32 rtt_table[AR9300_MAX_CHAINS][MAX_RTT_TABLE_ENTRY];
427 	struct ath9k_nfcal_hist nfCalHist[NUM_NF_READINGS];
428 };
429 
430 struct ath9k_channel {
431 	struct ieee80211_channel *chan;
432 	u16 channel;
433 	u32 channelFlags;
434 	u32 chanmode;
435 	s16 noisefloor;
436 };
437 
438 #define IS_CHAN_G(_c) ((((_c)->channelFlags & (CHANNEL_G)) == CHANNEL_G) || \
439        (((_c)->channelFlags & CHANNEL_G_HT20) == CHANNEL_G_HT20) || \
440        (((_c)->channelFlags & CHANNEL_G_HT40PLUS) == CHANNEL_G_HT40PLUS) || \
441        (((_c)->channelFlags & CHANNEL_G_HT40MINUS) == CHANNEL_G_HT40MINUS))
442 #define IS_CHAN_OFDM(_c) (((_c)->channelFlags & CHANNEL_OFDM) != 0)
443 #define IS_CHAN_5GHZ(_c) (((_c)->channelFlags & CHANNEL_5GHZ) != 0)
444 #define IS_CHAN_2GHZ(_c) (((_c)->channelFlags & CHANNEL_2GHZ) != 0)
445 #define IS_CHAN_HALF_RATE(_c) (((_c)->channelFlags & CHANNEL_HALF) != 0)
446 #define IS_CHAN_QUARTER_RATE(_c) (((_c)->channelFlags & CHANNEL_QUARTER) != 0)
447 #define IS_CHAN_A_FAST_CLOCK(_ah, _c)			\
448 	((((_c)->channelFlags & CHANNEL_5GHZ) != 0) &&	\
449 	 ((_ah)->caps.hw_caps & ATH9K_HW_CAP_FASTCLOCK))
450 
451 /* These macros check chanmode and not channelFlags */
452 #define IS_CHAN_B(_c) ((_c)->chanmode == CHANNEL_B)
453 #define IS_CHAN_HT20(_c) (((_c)->chanmode == CHANNEL_A_HT20) ||	\
454 			  ((_c)->chanmode == CHANNEL_G_HT20))
455 #define IS_CHAN_HT40(_c) (((_c)->chanmode == CHANNEL_A_HT40PLUS) ||	\
456 			  ((_c)->chanmode == CHANNEL_A_HT40MINUS) ||	\
457 			  ((_c)->chanmode == CHANNEL_G_HT40PLUS) ||	\
458 			  ((_c)->chanmode == CHANNEL_G_HT40MINUS))
459 #define IS_CHAN_HT(_c) (IS_CHAN_HT20((_c)) || IS_CHAN_HT40((_c)))
460 
461 enum ath9k_power_mode {
462 	ATH9K_PM_AWAKE = 0,
463 	ATH9K_PM_FULL_SLEEP,
464 	ATH9K_PM_NETWORK_SLEEP,
465 	ATH9K_PM_UNDEFINED
466 };
467 
468 enum ser_reg_mode {
469 	SER_REG_MODE_OFF = 0,
470 	SER_REG_MODE_ON = 1,
471 	SER_REG_MODE_AUTO = 2,
472 };
473 
474 enum ath9k_rx_qtype {
475 	ATH9K_RX_QUEUE_HP,
476 	ATH9K_RX_QUEUE_LP,
477 	ATH9K_RX_QUEUE_MAX,
478 };
479 
480 struct ath9k_beacon_state {
481 	u32 bs_nexttbtt;
482 	u32 bs_nextdtim;
483 	u32 bs_intval;
484 #define ATH9K_TSFOOR_THRESHOLD    0x00004240 /* 16k us */
485 	u32 bs_dtimperiod;
486 	u16 bs_cfpperiod;
487 	u16 bs_cfpmaxduration;
488 	u32 bs_cfpnext;
489 	u16 bs_timoffset;
490 	u16 bs_bmissthreshold;
491 	u32 bs_sleepduration;
492 	u32 bs_tsfoor_threshold;
493 };
494 
495 struct chan_centers {
496 	u16 synth_center;
497 	u16 ctl_center;
498 	u16 ext_center;
499 };
500 
501 enum {
502 	ATH9K_RESET_POWER_ON,
503 	ATH9K_RESET_WARM,
504 	ATH9K_RESET_COLD,
505 };
506 
507 struct ath9k_hw_version {
508 	u32 magic;
509 	u16 devid;
510 	u16 subvendorid;
511 	u32 macVersion;
512 	u16 macRev;
513 	u16 phyRev;
514 	u16 analog5GhzRev;
515 	u16 analog2GhzRev;
516 	enum ath_usb_dev usbdev;
517 };
518 
519 /* Generic TSF timer definitions */
520 
521 #define ATH_MAX_GEN_TIMER	16
522 
523 #define AR_GENTMR_BIT(_index)	(1 << (_index))
524 
525 /*
526  * Using de Bruijin sequence to look up 1's index in a 32 bit number
527  * debruijn32 = 0000 0111 0111 1100 1011 0101 0011 0001
528  */
529 #define debruijn32 0x077CB531U
530 
531 struct ath_gen_timer_configuration {
532 	u32 next_addr;
533 	u32 period_addr;
534 	u32 mode_addr;
535 	u32 mode_mask;
536 };
537 
538 struct ath_gen_timer {
539 	void (*trigger)(void *arg);
540 	void (*overflow)(void *arg);
541 	void *arg;
542 	u8 index;
543 };
544 
545 struct ath_gen_timer_table {
546 	u32 gen_timer_index[32];
547 	struct ath_gen_timer *timers[ATH_MAX_GEN_TIMER];
548 	union {
549 		unsigned long timer_bits;
550 		u16 val;
551 	} timer_mask;
552 };
553 
554 struct ath_hw_antcomb_conf {
555 	u8 main_lna_conf;
556 	u8 alt_lna_conf;
557 	u8 fast_div_bias;
558 	u8 main_gaintb;
559 	u8 alt_gaintb;
560 	int lna1_lna2_delta;
561 	u8 div_group;
562 };
563 
564 /**
565  * struct ath_hw_radar_conf - radar detection initialization parameters
566  *
567  * @pulse_inband: threshold for checking the ratio of in-band power
568  *	to total power for short radar pulses (half dB steps)
569  * @pulse_inband_step: threshold for checking an in-band power to total
570  *	power ratio increase for short radar pulses (half dB steps)
571  * @pulse_height: threshold for detecting the beginning of a short
572  *	radar pulse (dB step)
573  * @pulse_rssi: threshold for detecting if a short radar pulse is
574  *	gone (dB step)
575  * @pulse_maxlen: maximum pulse length (0.8 us steps)
576  *
577  * @radar_rssi: RSSI threshold for starting long radar detection (dB steps)
578  * @radar_inband: threshold for checking the ratio of in-band power
579  *	to total power for long radar pulses (half dB steps)
580  * @fir_power: threshold for detecting the end of a long radar pulse (dB)
581  *
582  * @ext_channel: enable extension channel radar detection
583  */
584 struct ath_hw_radar_conf {
585 	unsigned int pulse_inband;
586 	unsigned int pulse_inband_step;
587 	unsigned int pulse_height;
588 	unsigned int pulse_rssi;
589 	unsigned int pulse_maxlen;
590 
591 	unsigned int radar_rssi;
592 	unsigned int radar_inband;
593 	int fir_power;
594 
595 	bool ext_channel;
596 };
597 
598 /**
599  * struct ath_hw_private_ops - callbacks used internally by hardware code
600  *
601  * This structure contains private callbacks designed to only be used internally
602  * by the hardware core.
603  *
604  * @init_cal_settings: setup types of calibrations supported
605  * @init_cal: starts actual calibration
606  *
607  * @init_mode_gain_regs: Initialize TX/RX gain registers
608  *
609  * @rf_set_freq: change frequency
610  * @spur_mitigate_freq: spur mitigation
611  * @set_rf_regs:
612  * @compute_pll_control: compute the PLL control value to use for
613  *	AR_RTC_PLL_CONTROL for a given channel
614  * @setup_calibration: set up calibration
615  * @iscal_supported: used to query if a type of calibration is supported
616  *
617  * @ani_cache_ini_regs: cache the values for ANI from the initial
618  *	register settings through the register initialization.
619  */
620 struct ath_hw_private_ops {
621 	/* Calibration ops */
622 	void (*init_cal_settings)(struct ath_hw *ah);
623 	bool (*init_cal)(struct ath_hw *ah, struct ath9k_channel *chan);
624 
625 	void (*init_mode_gain_regs)(struct ath_hw *ah);
626 	void (*setup_calibration)(struct ath_hw *ah,
627 				  struct ath9k_cal_list *currCal);
628 
629 	/* PHY ops */
630 	int (*rf_set_freq)(struct ath_hw *ah,
631 			   struct ath9k_channel *chan);
632 	void (*spur_mitigate_freq)(struct ath_hw *ah,
633 				   struct ath9k_channel *chan);
634 	bool (*set_rf_regs)(struct ath_hw *ah,
635 			    struct ath9k_channel *chan,
636 			    u16 modesIndex);
637 	void (*set_channel_regs)(struct ath_hw *ah, struct ath9k_channel *chan);
638 	void (*init_bb)(struct ath_hw *ah,
639 			struct ath9k_channel *chan);
640 	int (*process_ini)(struct ath_hw *ah, struct ath9k_channel *chan);
641 	void (*olc_init)(struct ath_hw *ah);
642 	void (*set_rfmode)(struct ath_hw *ah, struct ath9k_channel *chan);
643 	void (*mark_phy_inactive)(struct ath_hw *ah);
644 	void (*set_delta_slope)(struct ath_hw *ah, struct ath9k_channel *chan);
645 	bool (*rfbus_req)(struct ath_hw *ah);
646 	void (*rfbus_done)(struct ath_hw *ah);
647 	void (*restore_chainmask)(struct ath_hw *ah);
648 	u32 (*compute_pll_control)(struct ath_hw *ah,
649 				   struct ath9k_channel *chan);
650 	bool (*ani_control)(struct ath_hw *ah, enum ath9k_ani_cmd cmd,
651 			    int param);
652 	void (*do_getnf)(struct ath_hw *ah, int16_t nfarray[NUM_NF_READINGS]);
653 	void (*set_radar_params)(struct ath_hw *ah,
654 				 struct ath_hw_radar_conf *conf);
655 	int (*fast_chan_change)(struct ath_hw *ah, struct ath9k_channel *chan,
656 				u8 *ini_reloaded);
657 
658 	/* ANI */
659 	void (*ani_cache_ini_regs)(struct ath_hw *ah);
660 };
661 
662 /**
663  * struct ath_spec_scan - parameters for Atheros spectral scan
664  *
665  * @enabled: enable/disable spectral scan
666  * @short_repeat: controls whether the chip is in spectral scan mode
667  *		  for 4 usec (enabled) or 204 usec (disabled)
668  * @count: number of scan results requested. There are special meanings
669  *	   in some chip revisions:
670  *	   AR92xx: highest bit set (>=128) for endless mode
671  *		   (spectral scan won't stopped until explicitly disabled)
672  *	   AR9300 and newer: 0 for endless mode
673  * @endless: true if endless mode is intended. Otherwise, count value is
674  *           corrected to the next possible value.
675  * @period: time duration between successive spectral scan entry points
676  *	    (period*256*Tclk). Tclk = ath_common->clockrate
677  * @fft_period: PHY passes FFT frames to MAC every (fft_period+1)*4uS
678  *
679  * Note: Tclk = 40MHz or 44MHz depending upon operating mode.
680  *	 Typically it's 44MHz in 2/5GHz on later chips, but there's
681  *	 a "fast clock" check for this in 5GHz.
682  *
683  */
684 struct ath_spec_scan {
685 	bool enabled;
686 	bool short_repeat;
687 	bool endless;
688 	u8 count;
689 	u8 period;
690 	u8 fft_period;
691 };
692 
693 /**
694  * struct ath_hw_ops - callbacks used by hardware code and driver code
695  *
696  * This structure contains callbacks designed to to be used internally by
697  * hardware code and also by the lower level driver.
698  *
699  * @config_pci_powersave:
700  * @calibrate: periodic calibration for NF, ANI, IQ, ADC gain, ADC-DC
701  *
702  * @spectral_scan_config: set parameters for spectral scan and enable/disable it
703  * @spectral_scan_trigger: trigger a spectral scan run
704  * @spectral_scan_wait: wait for a spectral scan run to finish
705  */
706 struct ath_hw_ops {
707 	void (*config_pci_powersave)(struct ath_hw *ah,
708 				     bool power_off);
709 	void (*rx_enable)(struct ath_hw *ah);
710 	void (*set_desc_link)(void *ds, u32 link);
711 	bool (*calibrate)(struct ath_hw *ah,
712 			  struct ath9k_channel *chan,
713 			  u8 rxchainmask,
714 			  bool longcal);
715 	bool (*get_isr)(struct ath_hw *ah, enum ath9k_int *masked);
716 	void (*set_txdesc)(struct ath_hw *ah, void *ds,
717 			   struct ath_tx_info *i);
718 	int (*proc_txdesc)(struct ath_hw *ah, void *ds,
719 			   struct ath_tx_status *ts);
720 	void (*antdiv_comb_conf_get)(struct ath_hw *ah,
721 			struct ath_hw_antcomb_conf *antconf);
722 	void (*antdiv_comb_conf_set)(struct ath_hw *ah,
723 			struct ath_hw_antcomb_conf *antconf);
724 	void (*spectral_scan_config)(struct ath_hw *ah,
725 				     struct ath_spec_scan *param);
726 	void (*spectral_scan_trigger)(struct ath_hw *ah);
727 	void (*spectral_scan_wait)(struct ath_hw *ah);
728 
729 #ifdef CONFIG_ATH9K_BTCOEX_SUPPORT
730 	void (*set_bt_ant_diversity)(struct ath_hw *hw, bool enable);
731 #endif
732 };
733 
734 struct ath_nf_limits {
735 	s16 max;
736 	s16 min;
737 	s16 nominal;
738 };
739 
740 enum ath_cal_list {
741 	TX_IQ_CAL         =	BIT(0),
742 	TX_IQ_ON_AGC_CAL  =	BIT(1),
743 	TX_CL_CAL         =	BIT(2),
744 };
745 
746 /* ah_flags */
747 #define AH_USE_EEPROM   0x1
748 #define AH_UNPLUGGED    0x2 /* The card has been physically removed. */
749 #define AH_FASTCC       0x4
750 
751 struct ath_hw {
752 	struct ath_ops reg_ops;
753 
754 	struct device *dev;
755 	struct ieee80211_hw *hw;
756 	struct ath_common common;
757 	struct ath9k_hw_version hw_version;
758 	struct ath9k_ops_config config;
759 	struct ath9k_hw_capabilities caps;
760 	struct ath9k_channel channels[ATH9K_NUM_CHANNELS];
761 	struct ath9k_channel *curchan;
762 
763 	union {
764 		struct ar5416_eeprom_def def;
765 		struct ar5416_eeprom_4k map4k;
766 		struct ar9287_eeprom map9287;
767 		struct ar9300_eeprom ar9300_eep;
768 	} eeprom;
769 	const struct eeprom_ops *eep_ops;
770 
771 	bool sw_mgmt_crypto;
772 	bool is_pciexpress;
773 	bool aspm_enabled;
774 	bool is_monitoring;
775 	bool need_an_top2_fixup;
776 	u16 tx_trig_level;
777 
778 	u32 nf_regs[6];
779 	struct ath_nf_limits nf_2g;
780 	struct ath_nf_limits nf_5g;
781 	u16 rfsilent;
782 	u32 rfkill_gpio;
783 	u32 rfkill_polarity;
784 	u32 ah_flags;
785 
786 	bool reset_power_on;
787 	bool htc_reset_init;
788 
789 	enum nl80211_iftype opmode;
790 	enum ath9k_power_mode power_mode;
791 
792 	s8 noise;
793 	struct ath9k_hw_cal_data *caldata;
794 	struct ath9k_pacal_info pacal_info;
795 	struct ar5416Stats stats;
796 	struct ath9k_tx_queue_info txq[ATH9K_NUM_TX_QUEUES];
797 
798 	enum ath9k_int imask;
799 	u32 imrs2_reg;
800 	u32 txok_interrupt_mask;
801 	u32 txerr_interrupt_mask;
802 	u32 txdesc_interrupt_mask;
803 	u32 txeol_interrupt_mask;
804 	u32 txurn_interrupt_mask;
805 	atomic_t intr_ref_cnt;
806 	bool chip_fullsleep;
807 	u32 atim_window;
808 	u32 modes_index;
809 
810 	/* Calibration */
811 	u32 supp_cals;
812 	struct ath9k_cal_list iq_caldata;
813 	struct ath9k_cal_list adcgain_caldata;
814 	struct ath9k_cal_list adcdc_caldata;
815 	struct ath9k_cal_list *cal_list;
816 	struct ath9k_cal_list *cal_list_last;
817 	struct ath9k_cal_list *cal_list_curr;
818 #define totalPowerMeasI meas0.unsign
819 #define totalPowerMeasQ meas1.unsign
820 #define totalIqCorrMeas meas2.sign
821 #define totalAdcIOddPhase  meas0.unsign
822 #define totalAdcIEvenPhase meas1.unsign
823 #define totalAdcQOddPhase  meas2.unsign
824 #define totalAdcQEvenPhase meas3.unsign
825 #define totalAdcDcOffsetIOddPhase  meas0.sign
826 #define totalAdcDcOffsetIEvenPhase meas1.sign
827 #define totalAdcDcOffsetQOddPhase  meas2.sign
828 #define totalAdcDcOffsetQEvenPhase meas3.sign
829 	union {
830 		u32 unsign[AR5416_MAX_CHAINS];
831 		int32_t sign[AR5416_MAX_CHAINS];
832 	} meas0;
833 	union {
834 		u32 unsign[AR5416_MAX_CHAINS];
835 		int32_t sign[AR5416_MAX_CHAINS];
836 	} meas1;
837 	union {
838 		u32 unsign[AR5416_MAX_CHAINS];
839 		int32_t sign[AR5416_MAX_CHAINS];
840 	} meas2;
841 	union {
842 		u32 unsign[AR5416_MAX_CHAINS];
843 		int32_t sign[AR5416_MAX_CHAINS];
844 	} meas3;
845 	u16 cal_samples;
846 	u8 enabled_cals;
847 
848 	u32 sta_id1_defaults;
849 	u32 misc_mode;
850 
851 	/* Private to hardware code */
852 	struct ath_hw_private_ops private_ops;
853 	/* Accessed by the lower level driver */
854 	struct ath_hw_ops ops;
855 
856 	/* Used to program the radio on non single-chip devices */
857 	u32 *analogBank6Data;
858 
859 	int coverage_class;
860 	u32 slottime;
861 	u32 globaltxtimeout;
862 
863 	/* ANI */
864 	u32 aniperiod;
865 	enum ath9k_ani_cmd ani_function;
866 	u32 ani_skip_count;
867 	struct ar5416AniState ani;
868 
869 #ifdef CONFIG_ATH9K_BTCOEX_SUPPORT
870 	struct ath_btcoex_hw btcoex_hw;
871 #endif
872 
873 	u32 intr_txqs;
874 	u8 txchainmask;
875 	u8 rxchainmask;
876 
877 	struct ath_hw_radar_conf radar_conf;
878 
879 	u32 originalGain[22];
880 	int initPDADC;
881 	int PDADCdelta;
882 	int led_pin;
883 	u32 gpio_mask;
884 	u32 gpio_val;
885 
886 	struct ar5416IniArray iniModes;
887 	struct ar5416IniArray iniCommon;
888 	struct ar5416IniArray iniBB_RfGain;
889 	struct ar5416IniArray iniBank6;
890 	struct ar5416IniArray iniAddac;
891 	struct ar5416IniArray iniPcieSerdes;
892 	struct ar5416IniArray iniPcieSerdesLowPower;
893 	struct ar5416IniArray iniModesFastClock;
894 	struct ar5416IniArray iniAdditional;
895 	struct ar5416IniArray iniModesRxGain;
896 	struct ar5416IniArray ini_modes_rx_gain_bounds;
897 	struct ar5416IniArray iniModesTxGain;
898 	struct ar5416IniArray iniCckfirNormal;
899 	struct ar5416IniArray iniCckfirJapan2484;
900 	struct ar5416IniArray iniModes_9271_ANI_reg;
901 	struct ar5416IniArray ini_radio_post_sys2ant;
902 	struct ar5416IniArray ini_modes_rxgain_5g_xlna;
903 	struct ar5416IniArray ini_modes_rxgain_bb_core;
904 	struct ar5416IniArray ini_modes_rxgain_bb_postamble;
905 
906 	struct ar5416IniArray iniMac[ATH_INI_NUM_SPLIT];
907 	struct ar5416IniArray iniBB[ATH_INI_NUM_SPLIT];
908 	struct ar5416IniArray iniRadio[ATH_INI_NUM_SPLIT];
909 	struct ar5416IniArray iniSOC[ATH_INI_NUM_SPLIT];
910 
911 	u32 intr_gen_timer_trigger;
912 	u32 intr_gen_timer_thresh;
913 	struct ath_gen_timer_table hw_gen_timers;
914 
915 	struct ar9003_txs *ts_ring;
916 	u32 ts_paddr_start;
917 	u32 ts_paddr_end;
918 	u16 ts_tail;
919 	u16 ts_size;
920 
921 	u32 bb_watchdog_last_status;
922 	u32 bb_watchdog_timeout_ms; /* in ms, 0 to disable */
923 	u8 bb_hang_rx_ofdm; /* true if bb hang due to rx_ofdm */
924 
925 	unsigned int paprd_target_power;
926 	unsigned int paprd_training_power;
927 	unsigned int paprd_ratemask;
928 	unsigned int paprd_ratemask_ht40;
929 	bool paprd_table_write_done;
930 	u32 paprd_gain_table_entries[PAPRD_GAIN_TABLE_ENTRIES];
931 	u8 paprd_gain_table_index[PAPRD_GAIN_TABLE_ENTRIES];
932 	/*
933 	 * Store the permanent value of Reg 0x4004in WARegVal
934 	 * so we dont have to R/M/W. We should not be reading
935 	 * this register when in sleep states.
936 	 */
937 	u32 WARegVal;
938 
939 	/* Enterprise mode cap */
940 	u32 ent_mode;
941 
942 #ifdef CONFIG_PM_SLEEP
943 	u32 wow_event_mask;
944 #endif
945 	bool is_clk_25mhz;
946 	int (*get_mac_revision)(void);
947 	int (*external_reset)(void);
948 
949 	const struct firmware *eeprom_blob;
950 };
951 
952 struct ath_bus_ops {
953 	enum ath_bus_type ath_bus_type;
954 	void (*read_cachesize)(struct ath_common *common, int *csz);
955 	bool (*eeprom_read)(struct ath_common *common, u32 off, u16 *data);
956 	void (*bt_coex_prep)(struct ath_common *common);
957 	void (*aspm_init)(struct ath_common *common);
958 };
959 
960 static inline struct ath_common *ath9k_hw_common(struct ath_hw *ah)
961 {
962 	return &ah->common;
963 }
964 
965 static inline struct ath_regulatory *ath9k_hw_regulatory(struct ath_hw *ah)
966 {
967 	return &(ath9k_hw_common(ah)->regulatory);
968 }
969 
970 static inline struct ath_hw_private_ops *ath9k_hw_private_ops(struct ath_hw *ah)
971 {
972 	return &ah->private_ops;
973 }
974 
975 static inline struct ath_hw_ops *ath9k_hw_ops(struct ath_hw *ah)
976 {
977 	return &ah->ops;
978 }
979 
980 static inline u8 get_streams(int mask)
981 {
982 	return !!(mask & BIT(0)) + !!(mask & BIT(1)) + !!(mask & BIT(2));
983 }
984 
985 /* Initialization, Detach, Reset */
986 void ath9k_hw_deinit(struct ath_hw *ah);
987 int ath9k_hw_init(struct ath_hw *ah);
988 int ath9k_hw_reset(struct ath_hw *ah, struct ath9k_channel *chan,
989 		   struct ath9k_hw_cal_data *caldata, bool fastcc);
990 int ath9k_hw_fill_cap_info(struct ath_hw *ah);
991 u32 ath9k_regd_get_ctl(struct ath_regulatory *reg, struct ath9k_channel *chan);
992 
993 /* GPIO / RFKILL / Antennae */
994 void ath9k_hw_cfg_gpio_input(struct ath_hw *ah, u32 gpio);
995 u32 ath9k_hw_gpio_get(struct ath_hw *ah, u32 gpio);
996 void ath9k_hw_cfg_output(struct ath_hw *ah, u32 gpio,
997 			 u32 ah_signal_type);
998 void ath9k_hw_set_gpio(struct ath_hw *ah, u32 gpio, u32 val);
999 void ath9k_hw_setantenna(struct ath_hw *ah, u32 antenna);
1000 
1001 /* General Operation */
1002 void ath9k_hw_synth_delay(struct ath_hw *ah, struct ath9k_channel *chan,
1003 			  int hw_delay);
1004 bool ath9k_hw_wait(struct ath_hw *ah, u32 reg, u32 mask, u32 val, u32 timeout);
1005 void ath9k_hw_write_array(struct ath_hw *ah, const struct ar5416IniArray *array,
1006 			  int column, unsigned int *writecnt);
1007 u32 ath9k_hw_reverse_bits(u32 val, u32 n);
1008 u16 ath9k_hw_computetxtime(struct ath_hw *ah,
1009 			   u8 phy, int kbps,
1010 			   u32 frameLen, u16 rateix, bool shortPreamble);
1011 void ath9k_hw_get_channel_centers(struct ath_hw *ah,
1012 				  struct ath9k_channel *chan,
1013 				  struct chan_centers *centers);
1014 u32 ath9k_hw_getrxfilter(struct ath_hw *ah);
1015 void ath9k_hw_setrxfilter(struct ath_hw *ah, u32 bits);
1016 bool ath9k_hw_phy_disable(struct ath_hw *ah);
1017 bool ath9k_hw_disable(struct ath_hw *ah);
1018 void ath9k_hw_set_txpowerlimit(struct ath_hw *ah, u32 limit, bool test);
1019 void ath9k_hw_setopmode(struct ath_hw *ah);
1020 void ath9k_hw_setmcastfilter(struct ath_hw *ah, u32 filter0, u32 filter1);
1021 void ath9k_hw_write_associd(struct ath_hw *ah);
1022 u32 ath9k_hw_gettsf32(struct ath_hw *ah);
1023 u64 ath9k_hw_gettsf64(struct ath_hw *ah);
1024 void ath9k_hw_settsf64(struct ath_hw *ah, u64 tsf64);
1025 void ath9k_hw_reset_tsf(struct ath_hw *ah);
1026 void ath9k_hw_set_tsfadjust(struct ath_hw *ah, bool set);
1027 void ath9k_hw_init_global_settings(struct ath_hw *ah);
1028 u32 ar9003_get_pll_sqsum_dvc(struct ath_hw *ah);
1029 void ath9k_hw_set11nmac2040(struct ath_hw *ah);
1030 void ath9k_hw_beaconinit(struct ath_hw *ah, u32 next_beacon, u32 beacon_period);
1031 void ath9k_hw_set_sta_beacon_timers(struct ath_hw *ah,
1032 				    const struct ath9k_beacon_state *bs);
1033 bool ath9k_hw_check_alive(struct ath_hw *ah);
1034 
1035 bool ath9k_hw_setpower(struct ath_hw *ah, enum ath9k_power_mode mode);
1036 
1037 #ifdef CONFIG_ATH9K_DEBUGFS
1038 void ath9k_debug_sync_cause(struct ath_common *common, u32 sync_cause);
1039 #else
1040 static inline void ath9k_debug_sync_cause(struct ath_common *common,
1041 					  u32 sync_cause) {}
1042 #endif
1043 
1044 /* Generic hw timer primitives */
1045 struct ath_gen_timer *ath_gen_timer_alloc(struct ath_hw *ah,
1046 					  void (*trigger)(void *),
1047 					  void (*overflow)(void *),
1048 					  void *arg,
1049 					  u8 timer_index);
1050 void ath9k_hw_gen_timer_start(struct ath_hw *ah,
1051 			      struct ath_gen_timer *timer,
1052 			      u32 timer_next,
1053 			      u32 timer_period);
1054 void ath9k_hw_gen_timer_stop(struct ath_hw *ah, struct ath_gen_timer *timer);
1055 
1056 void ath_gen_timer_free(struct ath_hw *ah, struct ath_gen_timer *timer);
1057 void ath_gen_timer_isr(struct ath_hw *hw);
1058 
1059 void ath9k_hw_name(struct ath_hw *ah, char *hw_name, size_t len);
1060 
1061 /* PHY */
1062 void ath9k_hw_get_delta_slope_vals(struct ath_hw *ah, u32 coef_scaled,
1063 				   u32 *coef_mantissa, u32 *coef_exponent);
1064 void ath9k_hw_apply_txpower(struct ath_hw *ah, struct ath9k_channel *chan,
1065 			    bool test);
1066 
1067 /*
1068  * Code Specific to AR5008, AR9001 or AR9002,
1069  * we stuff these here to avoid callbacks for AR9003.
1070  */
1071 int ar9002_hw_rf_claim(struct ath_hw *ah);
1072 void ar9002_hw_enable_async_fifo(struct ath_hw *ah);
1073 
1074 /*
1075  * Code specific to AR9003, we stuff these here to avoid callbacks
1076  * for older families
1077  */
1078 void ar9003_hw_bb_watchdog_config(struct ath_hw *ah);
1079 void ar9003_hw_bb_watchdog_read(struct ath_hw *ah);
1080 void ar9003_hw_bb_watchdog_dbg_info(struct ath_hw *ah);
1081 void ar9003_hw_disable_phy_restart(struct ath_hw *ah);
1082 void ar9003_paprd_enable(struct ath_hw *ah, bool val);
1083 void ar9003_paprd_populate_single_table(struct ath_hw *ah,
1084 					struct ath9k_hw_cal_data *caldata,
1085 					int chain);
1086 int ar9003_paprd_create_curve(struct ath_hw *ah,
1087 			      struct ath9k_hw_cal_data *caldata, int chain);
1088 void ar9003_paprd_setup_gain_table(struct ath_hw *ah, int chain);
1089 int ar9003_paprd_init_table(struct ath_hw *ah);
1090 bool ar9003_paprd_is_done(struct ath_hw *ah);
1091 bool ar9003_is_paprd_enabled(struct ath_hw *ah);
1092 void ar9003_hw_set_chain_masks(struct ath_hw *ah, u8 rx, u8 tx);
1093 
1094 /* Hardware family op attach helpers */
1095 int ar5008_hw_attach_phy_ops(struct ath_hw *ah);
1096 void ar9002_hw_attach_phy_ops(struct ath_hw *ah);
1097 void ar9003_hw_attach_phy_ops(struct ath_hw *ah);
1098 
1099 void ar9002_hw_attach_calib_ops(struct ath_hw *ah);
1100 void ar9003_hw_attach_calib_ops(struct ath_hw *ah);
1101 
1102 int ar9002_hw_attach_ops(struct ath_hw *ah);
1103 void ar9003_hw_attach_ops(struct ath_hw *ah);
1104 
1105 void ar9002_hw_load_ani_reg(struct ath_hw *ah, struct ath9k_channel *chan);
1106 
1107 void ath9k_ani_reset(struct ath_hw *ah, bool is_scanning);
1108 void ath9k_hw_ani_monitor(struct ath_hw *ah, struct ath9k_channel *chan);
1109 
1110 #ifdef CONFIG_ATH9K_BTCOEX_SUPPORT
1111 static inline bool ath9k_hw_btcoex_is_enabled(struct ath_hw *ah)
1112 {
1113 	return ah->btcoex_hw.enabled;
1114 }
1115 static inline bool ath9k_hw_mci_is_enabled(struct ath_hw *ah)
1116 {
1117 	return ah->common.btcoex_enabled &&
1118 	       (ah->caps.hw_caps & ATH9K_HW_CAP_MCI);
1119 
1120 }
1121 void ath9k_hw_btcoex_enable(struct ath_hw *ah);
1122 static inline enum ath_btcoex_scheme
1123 ath9k_hw_get_btcoex_scheme(struct ath_hw *ah)
1124 {
1125 	return ah->btcoex_hw.scheme;
1126 }
1127 #else
1128 static inline bool ath9k_hw_btcoex_is_enabled(struct ath_hw *ah)
1129 {
1130 	return false;
1131 }
1132 static inline bool ath9k_hw_mci_is_enabled(struct ath_hw *ah)
1133 {
1134 	return false;
1135 }
1136 static inline void ath9k_hw_btcoex_enable(struct ath_hw *ah)
1137 {
1138 }
1139 static inline enum ath_btcoex_scheme
1140 ath9k_hw_get_btcoex_scheme(struct ath_hw *ah)
1141 {
1142 	return ATH_BTCOEX_CFG_NONE;
1143 }
1144 #endif /* CONFIG_ATH9K_BTCOEX_SUPPORT */
1145 
1146 
1147 #ifdef CONFIG_PM_SLEEP
1148 const char *ath9k_hw_wow_event_to_string(u32 wow_event);
1149 void ath9k_hw_wow_apply_pattern(struct ath_hw *ah, u8 *user_pattern,
1150 				u8 *user_mask, int pattern_count,
1151 				int pattern_len);
1152 u32 ath9k_hw_wow_wakeup(struct ath_hw *ah);
1153 void ath9k_hw_wow_enable(struct ath_hw *ah, u32 pattern_enable);
1154 #else
1155 static inline const char *ath9k_hw_wow_event_to_string(u32 wow_event)
1156 {
1157 	return NULL;
1158 }
1159 static inline void ath9k_hw_wow_apply_pattern(struct ath_hw *ah,
1160 					      u8 *user_pattern,
1161 					      u8 *user_mask,
1162 					      int pattern_count,
1163 					      int pattern_len)
1164 {
1165 }
1166 static inline u32 ath9k_hw_wow_wakeup(struct ath_hw *ah)
1167 {
1168 	return 0;
1169 }
1170 static inline void ath9k_hw_wow_enable(struct ath_hw *ah, u32 pattern_enable)
1171 {
1172 }
1173 #endif
1174 
1175 #define ATH9K_CLOCK_RATE_CCK		22
1176 #define ATH9K_CLOCK_RATE_5GHZ_OFDM	40
1177 #define ATH9K_CLOCK_RATE_2GHZ_OFDM	44
1178 #define ATH9K_CLOCK_FAST_RATE_5GHZ_OFDM 44
1179 
1180 #endif
1181