2 * Copyright (c) 2008-2011 Atheros Communications Inc.
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.
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.
20 #include <linux/if_ether.h>
21 #include <linux/delay.h>
23 #include <linux/firmware.h>
35 #define ATHEROS_VENDOR_ID 0x168c
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 #define AR9300_DEVID_AR953X 0x003d
57 #define AR5416_AR9100_DEVID 0x000b
59 #define AR_SUBVENDOR_ID_NOG 0x0e11
60 #define AR_SUBVENDOR_ID_NEW_A 0x7065
61 #define AR5416_MAGIC 0x19641014
63 #define AR9280_COEX2WIRE_SUBSYSID 0x309b
64 #define AT9285_COEX3WIRE_SA_SUBSYSID 0x30aa
65 #define AT9285_COEX3WIRE_DA_SUBSYSID 0x30ab
67 #define ATH_AMPDU_LIMIT_MAX (64 * 1024 - 1)
69 #define ATH_DEFAULT_NOISE_FLOOR -95
71 #define ATH9K_RSSI_BAD -128
73 #define ATH9K_NUM_CHANNELS 38
75 /* Register read/write primitives */
76 #define REG_WRITE(_ah, _reg, _val) \
77 (_ah)->reg_ops.write((_ah), (_val), (_reg))
79 #define REG_READ(_ah, _reg) \
80 (_ah)->reg_ops.read((_ah), (_reg))
82 #define REG_READ_MULTI(_ah, _addr, _val, _cnt) \
83 (_ah)->reg_ops.multi_read((_ah), (_addr), (_val), (_cnt))
85 #define REG_RMW(_ah, _reg, _set, _clr) \
86 (_ah)->reg_ops.rmw((_ah), (_reg), (_set), (_clr))
88 #define ENABLE_REGWRITE_BUFFER(_ah) \
90 if ((_ah)->reg_ops.enable_write_buffer) \
91 (_ah)->reg_ops.enable_write_buffer((_ah)); \
94 #define REGWRITE_BUFFER_FLUSH(_ah) \
96 if ((_ah)->reg_ops.write_flush) \
97 (_ah)->reg_ops.write_flush((_ah)); \
100 #define PR_EEP(_s, _val) \
102 len += scnprintf(buf + len, size - len, "%20s : %10d\n",\
106 #define SM(_v, _f) (((_v) << _f##_S) & _f)
107 #define MS(_v, _f) (((_v) & _f) >> _f##_S)
108 #define REG_RMW_FIELD(_a, _r, _f, _v) \
109 REG_RMW(_a, _r, (((_v) << _f##_S) & _f), (_f))
110 #define REG_READ_FIELD(_a, _r, _f) \
111 (((REG_READ(_a, _r) & _f) >> _f##_S))
112 #define REG_SET_BIT(_a, _r, _f) \
113 REG_RMW(_a, _r, (_f), 0)
114 #define REG_CLR_BIT(_a, _r, _f) \
115 REG_RMW(_a, _r, 0, (_f))
117 #define DO_DELAY(x) do { \
118 if (((++(x) % 64) == 0) && \
119 (ath9k_hw_common(ah)->bus_ops->ath_bus_type \
124 #define REG_WRITE_ARRAY(iniarray, column, regWr) \
125 ath9k_hw_write_array(ah, iniarray, column, &(regWr))
127 #define AR_GPIO_OUTPUT_MUX_AS_OUTPUT 0
128 #define AR_GPIO_OUTPUT_MUX_AS_PCIE_ATTENTION_LED 1
129 #define AR_GPIO_OUTPUT_MUX_AS_PCIE_POWER_LED 2
130 #define AR_GPIO_OUTPUT_MUX_AS_TX_FRAME 3
131 #define AR_GPIO_OUTPUT_MUX_AS_RX_CLEAR_EXTERNAL 4
132 #define AR_GPIO_OUTPUT_MUX_AS_MAC_NETWORK_LED 5
133 #define AR_GPIO_OUTPUT_MUX_AS_MAC_POWER_LED 6
134 #define AR_GPIO_OUTPUT_MUX_AS_MCI_WLAN_DATA 0x16
135 #define AR_GPIO_OUTPUT_MUX_AS_MCI_WLAN_CLK 0x17
136 #define AR_GPIO_OUTPUT_MUX_AS_MCI_BT_DATA 0x18
137 #define AR_GPIO_OUTPUT_MUX_AS_MCI_BT_CLK 0x19
138 #define AR_GPIO_OUTPUT_MUX_AS_WL_IN_TX 0x14
139 #define AR_GPIO_OUTPUT_MUX_AS_WL_IN_RX 0x13
140 #define AR_GPIO_OUTPUT_MUX_AS_BT_IN_TX 9
141 #define AR_GPIO_OUTPUT_MUX_AS_BT_IN_RX 8
142 #define AR_GPIO_OUTPUT_MUX_AS_RUCKUS_STROBE 0x1d
143 #define AR_GPIO_OUTPUT_MUX_AS_RUCKUS_DATA 0x1e
145 #define AR_GPIOD_MASK 0x00001FFF
146 #define AR_GPIO_BIT(_gpio) (1 << (_gpio))
148 #define BASE_ACTIVATE_DELAY 100
149 #define RTC_PLL_SETTLE_DELAY (AR_SREV_9340(ah) ? 1000 : 100)
150 #define COEF_SCALE_S 24
151 #define HT40_CHANNEL_CENTER_SHIFT 10
153 #define ATH9K_ANTENNA0_CHAINMASK 0x1
154 #define ATH9K_ANTENNA1_CHAINMASK 0x2
156 #define ATH9K_NUM_DMA_DEBUG_REGS 8
157 #define ATH9K_NUM_QUEUES 10
159 #define MAX_RATE_POWER 63
160 #define AH_WAIT_TIMEOUT 100000 /* (us) */
161 #define AH_TSF_WRITE_TIMEOUT 100 /* (us) */
162 #define AH_TIME_QUANTUM 10
163 #define AR_KEYTABLE_SIZE 128
164 #define POWER_UP_TIME 10000
165 #define SPUR_RSSI_THRESH 40
166 #define UPPER_5G_SUB_BAND_START 5700
167 #define MID_5G_SUB_BAND_START 5400
169 #define CAB_TIMEOUT_VAL 10
170 #define BEACON_TIMEOUT_VAL 10
171 #define MIN_BEACON_TIMEOUT_VAL 1
172 #define SLEEP_SLOP TU_TO_USEC(3)
174 #define INIT_CONFIG_STATUS 0x00000000
175 #define INIT_RSSI_THR 0x00000700
176 #define INIT_BCON_CNTRL_REG 0x00000000
178 #define TU_TO_USEC(_tu) ((_tu) << 10)
180 #define ATH9K_HW_RX_HP_QDEPTH 16
181 #define ATH9K_HW_RX_LP_QDEPTH 128
183 #define PAPRD_GAIN_TABLE_ENTRIES 32
184 #define PAPRD_TABLE_SZ 24
185 #define PAPRD_IDEAL_AGC2_PWR_RANGE 0xe0
191 /* Keep Alive Frame */
192 #define KAL_FRAME_LEN 28
193 #define KAL_FRAME_TYPE 0x2 /* data frame */
194 #define KAL_FRAME_SUB_TYPE 0x4 /* null data frame */
195 #define KAL_DURATION_ID 0x3d
196 #define KAL_NUM_DATA_WORDS 6
197 #define KAL_NUM_DESC_WORDS 12
198 #define KAL_ANTENNA_MODE 1
200 #define KAL_DELAY 4 /*delay of 4ms between 2 KAL frames */
201 #define KAL_TIMEOUT 900
203 #define MAX_PATTERN_SIZE 256
204 #define MAX_PATTERN_MASK_SIZE 32
205 #define MAX_NUM_PATTERN 8
206 #define MAX_NUM_USER_PATTERN 6 /* deducting the disassociate and
207 deauthenticate packets */
210 * WoW trigger mapping to hardware code
213 #define AH_WOW_USER_PATTERN_EN BIT(0)
214 #define AH_WOW_MAGIC_PATTERN_EN BIT(1)
215 #define AH_WOW_LINK_CHANGE BIT(2)
216 #define AH_WOW_BEACON_MISS BIT(3)
218 enum ath_hw_txq_subtype {
225 enum ath_ini_subsys {
233 ATH9K_HW_CAP_HT = BIT(0),
234 ATH9K_HW_CAP_RFSILENT = BIT(1),
235 ATH9K_HW_CAP_AUTOSLEEP = BIT(2),
236 ATH9K_HW_CAP_4KB_SPLITTRANS = BIT(3),
237 ATH9K_HW_CAP_EDMA = BIT(4),
238 ATH9K_HW_CAP_RAC_SUPPORTED = BIT(5),
239 ATH9K_HW_CAP_LDPC = BIT(6),
240 ATH9K_HW_CAP_FASTCLOCK = BIT(7),
241 ATH9K_HW_CAP_SGI_20 = BIT(8),
242 ATH9K_HW_CAP_ANT_DIV_COMB = BIT(10),
243 ATH9K_HW_CAP_2GHZ = BIT(11),
244 ATH9K_HW_CAP_5GHZ = BIT(12),
245 ATH9K_HW_CAP_APM = BIT(13),
246 ATH9K_HW_CAP_RTT = BIT(14),
247 ATH9K_HW_CAP_MCI = BIT(15),
248 ATH9K_HW_CAP_DFS = BIT(16),
249 ATH9K_HW_WOW_DEVICE_CAPABLE = BIT(17),
250 ATH9K_HW_CAP_PAPRD = BIT(18),
251 ATH9K_HW_CAP_FCC_BAND_SWITCH = BIT(19),
252 ATH9K_HW_CAP_BT_ANT_DIV = BIT(20),
256 * WoW device capabilities
257 * @ATH9K_HW_WOW_DEVICE_CAPABLE: device revision is capable of WoW.
258 * @ATH9K_HW_WOW_PATTERN_MATCH_EXACT: device is capable of matching
259 * an exact user defined pattern or de-authentication/disassoc pattern.
260 * @ATH9K_HW_WOW_PATTERN_MATCH_DWORD: device requires the first four
261 * bytes of the pattern for user defined pattern, de-authentication and
262 * disassociation patterns for all types of possible frames recieved
266 struct ath9k_hw_capabilities {
267 u32 hw_caps; /* ATH9K_HW_CAP_* from ath9k_hw_caps */
281 #define AR_NO_SPUR 0x8000
282 #define AR_BASE_FREQ_2GHZ 2300
283 #define AR_BASE_FREQ_5GHZ 4900
284 #define AR_SPUR_FEEQ_BOUND_HT40 19
285 #define AR_SPUR_FEEQ_BOUND_HT20 10
287 enum ath9k_hw_hang_checks {
288 HW_BB_WATCHDOG = BIT(0),
289 HW_PHYRESTART_CLC_WAR = BIT(1),
290 HW_BB_RIFS_HANG = BIT(2),
291 HW_BB_DFS_HANG = BIT(3),
292 HW_BB_RX_CLEAR_STUCK_HANG = BIT(4),
293 HW_MAC_HANG = BIT(5),
296 struct ath9k_ops_config {
297 int dma_beacon_response_time;
298 int sw_beacon_response_time;
299 u32 cwm_ignore_extcca;
307 int serialize_regmode;
308 bool rx_intr_mitigation;
309 bool tx_intr_mitigation;
311 u16 ani_poll_interval; /* ANI poll interval in ms */
314 /* Platform specific config */
317 u32 ant_ctrl_comm2g_switch_enable;
318 bool xatten_margin_cfg;
321 bool tx_gain_buffalo;
325 ATH9K_INT_RX = 0x00000001,
326 ATH9K_INT_RXDESC = 0x00000002,
327 ATH9K_INT_RXHP = 0x00000001,
328 ATH9K_INT_RXLP = 0x00000002,
329 ATH9K_INT_RXNOFRM = 0x00000008,
330 ATH9K_INT_RXEOL = 0x00000010,
331 ATH9K_INT_RXORN = 0x00000020,
332 ATH9K_INT_TX = 0x00000040,
333 ATH9K_INT_TXDESC = 0x00000080,
334 ATH9K_INT_TIM_TIMER = 0x00000100,
335 ATH9K_INT_MCI = 0x00000200,
336 ATH9K_INT_BB_WATCHDOG = 0x00000400,
337 ATH9K_INT_TXURN = 0x00000800,
338 ATH9K_INT_MIB = 0x00001000,
339 ATH9K_INT_RXPHY = 0x00004000,
340 ATH9K_INT_RXKCM = 0x00008000,
341 ATH9K_INT_SWBA = 0x00010000,
342 ATH9K_INT_BMISS = 0x00040000,
343 ATH9K_INT_BNR = 0x00100000,
344 ATH9K_INT_TIM = 0x00200000,
345 ATH9K_INT_DTIM = 0x00400000,
346 ATH9K_INT_DTIMSYNC = 0x00800000,
347 ATH9K_INT_GPIO = 0x01000000,
348 ATH9K_INT_CABEND = 0x02000000,
349 ATH9K_INT_TSFOOR = 0x04000000,
350 ATH9K_INT_GENTIMER = 0x08000000,
351 ATH9K_INT_CST = 0x10000000,
352 ATH9K_INT_GTT = 0x20000000,
353 ATH9K_INT_FATAL = 0x40000000,
354 ATH9K_INT_GLOBAL = 0x80000000,
355 ATH9K_INT_BMISC = ATH9K_INT_TIM |
360 ATH9K_INT_COMMON = ATH9K_INT_RXNOFRM |
372 ATH9K_INT_NOCARD = 0xffffffff
375 #define MAX_RTT_TABLE_ENTRY 6
376 #define MAX_IQCAL_MEASUREMENT 8
377 #define MAX_CL_TAB_ENTRY 16
378 #define CL_TAB_ENTRY(reg_base) (reg_base + (4 * j))
380 enum ath9k_cal_flags {
391 struct ath9k_hw_cal_data {
394 unsigned long cal_flags;
399 u16 small_signal_gain[AR9300_MAX_CHAINS];
400 u32 pa_table[AR9300_MAX_CHAINS][PAPRD_TABLE_SZ];
401 u32 num_measures[AR9300_MAX_CHAINS];
402 int tx_corr_coeff[MAX_IQCAL_MEASUREMENT][AR9300_MAX_CHAINS];
403 u32 tx_clcal[AR9300_MAX_CHAINS][MAX_CL_TAB_ENTRY];
404 u32 rtt_table[AR9300_MAX_CHAINS][MAX_RTT_TABLE_ENTRY];
405 struct ath9k_nfcal_hist nfCalHist[NUM_NF_READINGS];
408 struct ath9k_channel {
409 struct ieee80211_channel *chan;
415 #define CHANNEL_5GHZ BIT(0)
416 #define CHANNEL_HALF BIT(1)
417 #define CHANNEL_QUARTER BIT(2)
418 #define CHANNEL_HT BIT(3)
419 #define CHANNEL_HT40PLUS BIT(4)
420 #define CHANNEL_HT40MINUS BIT(5)
422 #define IS_CHAN_5GHZ(_c) (!!((_c)->channelFlags & CHANNEL_5GHZ))
423 #define IS_CHAN_2GHZ(_c) (!IS_CHAN_5GHZ(_c))
425 #define IS_CHAN_HALF_RATE(_c) (!!((_c)->channelFlags & CHANNEL_HALF))
426 #define IS_CHAN_QUARTER_RATE(_c) (!!((_c)->channelFlags & CHANNEL_QUARTER))
427 #define IS_CHAN_A_FAST_CLOCK(_ah, _c) \
428 (IS_CHAN_5GHZ(_c) && ((_ah)->caps.hw_caps & ATH9K_HW_CAP_FASTCLOCK))
430 #define IS_CHAN_HT(_c) ((_c)->channelFlags & CHANNEL_HT)
432 #define IS_CHAN_HT20(_c) (IS_CHAN_HT(_c) && !IS_CHAN_HT40(_c))
434 #define IS_CHAN_HT40(_c) \
435 (!!((_c)->channelFlags & (CHANNEL_HT40PLUS | CHANNEL_HT40MINUS)))
437 #define IS_CHAN_HT40PLUS(_c) ((_c)->channelFlags & CHANNEL_HT40PLUS)
438 #define IS_CHAN_HT40MINUS(_c) ((_c)->channelFlags & CHANNEL_HT40MINUS)
440 enum ath9k_power_mode {
443 ATH9K_PM_NETWORK_SLEEP,
448 SER_REG_MODE_OFF = 0,
450 SER_REG_MODE_AUTO = 2,
453 enum ath9k_rx_qtype {
459 struct ath9k_beacon_state {
463 #define ATH9K_TSFOOR_THRESHOLD 0x00004240 /* 16k us */
465 u16 bs_bmissthreshold;
466 u32 bs_sleepduration;
467 u32 bs_tsfoor_threshold;
470 struct chan_centers {
477 ATH9K_RESET_POWER_ON,
482 struct ath9k_hw_version {
491 enum ath_usb_dev usbdev;
494 /* Generic TSF timer definitions */
496 #define ATH_MAX_GEN_TIMER 16
498 #define AR_GENTMR_BIT(_index) (1 << (_index))
500 struct ath_gen_timer_configuration {
507 struct ath_gen_timer {
508 void (*trigger)(void *arg);
509 void (*overflow)(void *arg);
514 struct ath_gen_timer_table {
515 struct ath_gen_timer *timers[ATH_MAX_GEN_TIMER];
519 struct ath_hw_antcomb_conf {
526 int lna1_lna2_switch_delta;
531 * struct ath_hw_radar_conf - radar detection initialization parameters
533 * @pulse_inband: threshold for checking the ratio of in-band power
534 * to total power for short radar pulses (half dB steps)
535 * @pulse_inband_step: threshold for checking an in-band power to total
536 * power ratio increase for short radar pulses (half dB steps)
537 * @pulse_height: threshold for detecting the beginning of a short
538 * radar pulse (dB step)
539 * @pulse_rssi: threshold for detecting if a short radar pulse is
541 * @pulse_maxlen: maximum pulse length (0.8 us steps)
543 * @radar_rssi: RSSI threshold for starting long radar detection (dB steps)
544 * @radar_inband: threshold for checking the ratio of in-band power
545 * to total power for long radar pulses (half dB steps)
546 * @fir_power: threshold for detecting the end of a long radar pulse (dB)
548 * @ext_channel: enable extension channel radar detection
550 struct ath_hw_radar_conf {
551 unsigned int pulse_inband;
552 unsigned int pulse_inband_step;
553 unsigned int pulse_height;
554 unsigned int pulse_rssi;
555 unsigned int pulse_maxlen;
557 unsigned int radar_rssi;
558 unsigned int radar_inband;
565 * struct ath_hw_private_ops - callbacks used internally by hardware code
567 * This structure contains private callbacks designed to only be used internally
568 * by the hardware core.
570 * @init_cal_settings: setup types of calibrations supported
571 * @init_cal: starts actual calibration
573 * @init_mode_gain_regs: Initialize TX/RX gain registers
575 * @rf_set_freq: change frequency
576 * @spur_mitigate_freq: spur mitigation
578 * @compute_pll_control: compute the PLL control value to use for
579 * AR_RTC_PLL_CONTROL for a given channel
580 * @setup_calibration: set up calibration
581 * @iscal_supported: used to query if a type of calibration is supported
583 * @ani_cache_ini_regs: cache the values for ANI from the initial
584 * register settings through the register initialization.
586 struct ath_hw_private_ops {
587 void (*init_hang_checks)(struct ath_hw *ah);
588 bool (*detect_mac_hang)(struct ath_hw *ah);
589 bool (*detect_bb_hang)(struct ath_hw *ah);
591 /* Calibration ops */
592 void (*init_cal_settings)(struct ath_hw *ah);
593 bool (*init_cal)(struct ath_hw *ah, struct ath9k_channel *chan);
595 void (*init_mode_gain_regs)(struct ath_hw *ah);
596 void (*setup_calibration)(struct ath_hw *ah,
597 struct ath9k_cal_list *currCal);
600 int (*rf_set_freq)(struct ath_hw *ah,
601 struct ath9k_channel *chan);
602 void (*spur_mitigate_freq)(struct ath_hw *ah,
603 struct ath9k_channel *chan);
604 bool (*set_rf_regs)(struct ath_hw *ah,
605 struct ath9k_channel *chan,
607 void (*set_channel_regs)(struct ath_hw *ah, struct ath9k_channel *chan);
608 void (*init_bb)(struct ath_hw *ah,
609 struct ath9k_channel *chan);
610 int (*process_ini)(struct ath_hw *ah, struct ath9k_channel *chan);
611 void (*olc_init)(struct ath_hw *ah);
612 void (*set_rfmode)(struct ath_hw *ah, struct ath9k_channel *chan);
613 void (*mark_phy_inactive)(struct ath_hw *ah);
614 void (*set_delta_slope)(struct ath_hw *ah, struct ath9k_channel *chan);
615 bool (*rfbus_req)(struct ath_hw *ah);
616 void (*rfbus_done)(struct ath_hw *ah);
617 void (*restore_chainmask)(struct ath_hw *ah);
618 u32 (*compute_pll_control)(struct ath_hw *ah,
619 struct ath9k_channel *chan);
620 bool (*ani_control)(struct ath_hw *ah, enum ath9k_ani_cmd cmd,
622 void (*do_getnf)(struct ath_hw *ah, int16_t nfarray[NUM_NF_READINGS]);
623 void (*set_radar_params)(struct ath_hw *ah,
624 struct ath_hw_radar_conf *conf);
625 int (*fast_chan_change)(struct ath_hw *ah, struct ath9k_channel *chan,
629 void (*ani_cache_ini_regs)(struct ath_hw *ah);
633 * struct ath_spec_scan - parameters for Atheros spectral scan
635 * @enabled: enable/disable spectral scan
636 * @short_repeat: controls whether the chip is in spectral scan mode
637 * for 4 usec (enabled) or 204 usec (disabled)
638 * @count: number of scan results requested. There are special meanings
639 * in some chip revisions:
640 * AR92xx: highest bit set (>=128) for endless mode
641 * (spectral scan won't stopped until explicitly disabled)
642 * AR9300 and newer: 0 for endless mode
643 * @endless: true if endless mode is intended. Otherwise, count value is
644 * corrected to the next possible value.
645 * @period: time duration between successive spectral scan entry points
646 * (period*256*Tclk). Tclk = ath_common->clockrate
647 * @fft_period: PHY passes FFT frames to MAC every (fft_period+1)*4uS
649 * Note: Tclk = 40MHz or 44MHz depending upon operating mode.
650 * Typically it's 44MHz in 2/5GHz on later chips, but there's
651 * a "fast clock" check for this in 5GHz.
654 struct ath_spec_scan {
664 * struct ath_hw_ops - callbacks used by hardware code and driver code
666 * This structure contains callbacks designed to to be used internally by
667 * hardware code and also by the lower level driver.
669 * @config_pci_powersave:
670 * @calibrate: periodic calibration for NF, ANI, IQ, ADC gain, ADC-DC
672 * @spectral_scan_config: set parameters for spectral scan and enable/disable it
673 * @spectral_scan_trigger: trigger a spectral scan run
674 * @spectral_scan_wait: wait for a spectral scan run to finish
677 void (*config_pci_powersave)(struct ath_hw *ah,
679 void (*rx_enable)(struct ath_hw *ah);
680 void (*set_desc_link)(void *ds, u32 link);
681 bool (*calibrate)(struct ath_hw *ah,
682 struct ath9k_channel *chan,
685 bool (*get_isr)(struct ath_hw *ah, enum ath9k_int *masked,
687 void (*set_txdesc)(struct ath_hw *ah, void *ds,
688 struct ath_tx_info *i);
689 int (*proc_txdesc)(struct ath_hw *ah, void *ds,
690 struct ath_tx_status *ts);
691 void (*antdiv_comb_conf_get)(struct ath_hw *ah,
692 struct ath_hw_antcomb_conf *antconf);
693 void (*antdiv_comb_conf_set)(struct ath_hw *ah,
694 struct ath_hw_antcomb_conf *antconf);
695 void (*spectral_scan_config)(struct ath_hw *ah,
696 struct ath_spec_scan *param);
697 void (*spectral_scan_trigger)(struct ath_hw *ah);
698 void (*spectral_scan_wait)(struct ath_hw *ah);
700 void (*tx99_start)(struct ath_hw *ah, u32 qnum);
701 void (*tx99_stop)(struct ath_hw *ah);
702 void (*tx99_set_txpower)(struct ath_hw *ah, u8 power);
704 #ifdef CONFIG_ATH9K_BTCOEX_SUPPORT
705 void (*set_bt_ant_diversity)(struct ath_hw *hw, bool enable);
709 struct ath_nf_limits {
717 TX_IQ_ON_AGC_CAL = BIT(1),
722 #define AH_USE_EEPROM 0x1
723 #define AH_UNPLUGGED 0x2 /* The card has been physically removed. */
724 #define AH_FASTCC 0x4
727 struct ath_ops reg_ops;
730 struct ieee80211_hw *hw;
731 struct ath_common common;
732 struct ath9k_hw_version hw_version;
733 struct ath9k_ops_config config;
734 struct ath9k_hw_capabilities caps;
735 struct ath9k_channel channels[ATH9K_NUM_CHANNELS];
736 struct ath9k_channel *curchan;
739 struct ar5416_eeprom_def def;
740 struct ar5416_eeprom_4k map4k;
741 struct ar9287_eeprom map9287;
742 struct ar9300_eeprom ar9300_eep;
744 const struct eeprom_ops *eep_ops;
750 bool need_an_top2_fixup;
754 struct ath_nf_limits nf_2g;
755 struct ath_nf_limits nf_5g;
764 enum nl80211_iftype opmode;
765 enum ath9k_power_mode power_mode;
768 struct ath9k_hw_cal_data *caldata;
769 struct ath9k_pacal_info pacal_info;
770 struct ar5416Stats stats;
771 struct ath9k_tx_queue_info txq[ATH9K_NUM_TX_QUEUES];
773 enum ath9k_int imask;
775 u32 txok_interrupt_mask;
776 u32 txerr_interrupt_mask;
777 u32 txdesc_interrupt_mask;
778 u32 txeol_interrupt_mask;
779 u32 txurn_interrupt_mask;
780 atomic_t intr_ref_cnt;
786 struct ath9k_cal_list iq_caldata;
787 struct ath9k_cal_list adcgain_caldata;
788 struct ath9k_cal_list adcdc_caldata;
789 struct ath9k_cal_list *cal_list;
790 struct ath9k_cal_list *cal_list_last;
791 struct ath9k_cal_list *cal_list_curr;
792 #define totalPowerMeasI meas0.unsign
793 #define totalPowerMeasQ meas1.unsign
794 #define totalIqCorrMeas meas2.sign
795 #define totalAdcIOddPhase meas0.unsign
796 #define totalAdcIEvenPhase meas1.unsign
797 #define totalAdcQOddPhase meas2.unsign
798 #define totalAdcQEvenPhase meas3.unsign
799 #define totalAdcDcOffsetIOddPhase meas0.sign
800 #define totalAdcDcOffsetIEvenPhase meas1.sign
801 #define totalAdcDcOffsetQOddPhase meas2.sign
802 #define totalAdcDcOffsetQEvenPhase meas3.sign
804 u32 unsign[AR5416_MAX_CHAINS];
805 int32_t sign[AR5416_MAX_CHAINS];
808 u32 unsign[AR5416_MAX_CHAINS];
809 int32_t sign[AR5416_MAX_CHAINS];
812 u32 unsign[AR5416_MAX_CHAINS];
813 int32_t sign[AR5416_MAX_CHAINS];
816 u32 unsign[AR5416_MAX_CHAINS];
817 int32_t sign[AR5416_MAX_CHAINS];
822 u32 sta_id1_defaults;
825 /* Private to hardware code */
826 struct ath_hw_private_ops private_ops;
827 /* Accessed by the lower level driver */
828 struct ath_hw_ops ops;
830 /* Used to program the radio on non single-chip devices */
831 u32 *analogBank6Data;
839 enum ath9k_ani_cmd ani_function;
841 struct ar5416AniState ani;
843 #ifdef CONFIG_ATH9K_BTCOEX_SUPPORT
844 struct ath_btcoex_hw btcoex_hw;
851 struct ath_hw_radar_conf radar_conf;
853 u32 originalGain[22];
860 struct ar5416IniArray ini_dfs;
861 struct ar5416IniArray iniModes;
862 struct ar5416IniArray iniCommon;
863 struct ar5416IniArray iniBB_RfGain;
864 struct ar5416IniArray iniBank6;
865 struct ar5416IniArray iniAddac;
866 struct ar5416IniArray iniPcieSerdes;
867 struct ar5416IniArray iniPcieSerdesLowPower;
868 struct ar5416IniArray iniModesFastClock;
869 struct ar5416IniArray iniAdditional;
870 struct ar5416IniArray iniModesRxGain;
871 struct ar5416IniArray ini_modes_rx_gain_bounds;
872 struct ar5416IniArray iniModesTxGain;
873 struct ar5416IniArray iniCckfirNormal;
874 struct ar5416IniArray iniCckfirJapan2484;
875 struct ar5416IniArray iniModes_9271_ANI_reg;
876 struct ar5416IniArray ini_radio_post_sys2ant;
877 struct ar5416IniArray ini_modes_rxgain_5g_xlna;
878 struct ar5416IniArray ini_modes_rxgain_bb_core;
879 struct ar5416IniArray ini_modes_rxgain_bb_postamble;
881 struct ar5416IniArray iniMac[ATH_INI_NUM_SPLIT];
882 struct ar5416IniArray iniBB[ATH_INI_NUM_SPLIT];
883 struct ar5416IniArray iniRadio[ATH_INI_NUM_SPLIT];
884 struct ar5416IniArray iniSOC[ATH_INI_NUM_SPLIT];
886 u32 intr_gen_timer_trigger;
887 u32 intr_gen_timer_thresh;
888 struct ath_gen_timer_table hw_gen_timers;
890 struct ar9003_txs *ts_ring;
896 u32 bb_watchdog_last_status;
897 u32 bb_watchdog_timeout_ms; /* in ms, 0 to disable */
898 u8 bb_hang_rx_ofdm; /* true if bb hang due to rx_ofdm */
900 unsigned int paprd_target_power;
901 unsigned int paprd_training_power;
902 unsigned int paprd_ratemask;
903 unsigned int paprd_ratemask_ht40;
904 bool paprd_table_write_done;
905 u32 paprd_gain_table_entries[PAPRD_GAIN_TABLE_ENTRIES];
906 u8 paprd_gain_table_index[PAPRD_GAIN_TABLE_ENTRIES];
908 * Store the permanent value of Reg 0x4004in WARegVal
909 * so we dont have to R/M/W. We should not be reading
910 * this register when in sleep states.
914 /* Enterprise mode cap */
917 #ifdef CONFIG_ATH9K_WOW
921 int (*get_mac_revision)(void);
922 int (*external_reset)(void);
924 const struct firmware *eeprom_blob;
928 enum ath_bus_type ath_bus_type;
929 void (*read_cachesize)(struct ath_common *common, int *csz);
930 bool (*eeprom_read)(struct ath_common *common, u32 off, u16 *data);
931 void (*bt_coex_prep)(struct ath_common *common);
932 void (*aspm_init)(struct ath_common *common);
935 static inline struct ath_common *ath9k_hw_common(struct ath_hw *ah)
940 static inline struct ath_regulatory *ath9k_hw_regulatory(struct ath_hw *ah)
942 return &(ath9k_hw_common(ah)->regulatory);
945 static inline struct ath_hw_private_ops *ath9k_hw_private_ops(struct ath_hw *ah)
947 return &ah->private_ops;
950 static inline struct ath_hw_ops *ath9k_hw_ops(struct ath_hw *ah)
955 static inline u8 get_streams(int mask)
957 return !!(mask & BIT(0)) + !!(mask & BIT(1)) + !!(mask & BIT(2));
960 /* Initialization, Detach, Reset */
961 void ath9k_hw_deinit(struct ath_hw *ah);
962 int ath9k_hw_init(struct ath_hw *ah);
963 int ath9k_hw_reset(struct ath_hw *ah, struct ath9k_channel *chan,
964 struct ath9k_hw_cal_data *caldata, bool fastcc);
965 int ath9k_hw_fill_cap_info(struct ath_hw *ah);
966 u32 ath9k_regd_get_ctl(struct ath_regulatory *reg, struct ath9k_channel *chan);
968 /* GPIO / RFKILL / Antennae */
969 void ath9k_hw_cfg_gpio_input(struct ath_hw *ah, u32 gpio);
970 u32 ath9k_hw_gpio_get(struct ath_hw *ah, u32 gpio);
971 void ath9k_hw_cfg_output(struct ath_hw *ah, u32 gpio,
973 void ath9k_hw_set_gpio(struct ath_hw *ah, u32 gpio, u32 val);
974 void ath9k_hw_setantenna(struct ath_hw *ah, u32 antenna);
976 /* General Operation */
977 void ath9k_hw_synth_delay(struct ath_hw *ah, struct ath9k_channel *chan,
979 bool ath9k_hw_wait(struct ath_hw *ah, u32 reg, u32 mask, u32 val, u32 timeout);
980 void ath9k_hw_write_array(struct ath_hw *ah, const struct ar5416IniArray *array,
981 int column, unsigned int *writecnt);
982 u32 ath9k_hw_reverse_bits(u32 val, u32 n);
983 u16 ath9k_hw_computetxtime(struct ath_hw *ah,
985 u32 frameLen, u16 rateix, bool shortPreamble);
986 void ath9k_hw_get_channel_centers(struct ath_hw *ah,
987 struct ath9k_channel *chan,
988 struct chan_centers *centers);
989 u32 ath9k_hw_getrxfilter(struct ath_hw *ah);
990 void ath9k_hw_setrxfilter(struct ath_hw *ah, u32 bits);
991 bool ath9k_hw_phy_disable(struct ath_hw *ah);
992 bool ath9k_hw_disable(struct ath_hw *ah);
993 void ath9k_hw_set_txpowerlimit(struct ath_hw *ah, u32 limit, bool test);
994 void ath9k_hw_setopmode(struct ath_hw *ah);
995 void ath9k_hw_setmcastfilter(struct ath_hw *ah, u32 filter0, u32 filter1);
996 void ath9k_hw_write_associd(struct ath_hw *ah);
997 u32 ath9k_hw_gettsf32(struct ath_hw *ah);
998 u64 ath9k_hw_gettsf64(struct ath_hw *ah);
999 void ath9k_hw_settsf64(struct ath_hw *ah, u64 tsf64);
1000 void ath9k_hw_reset_tsf(struct ath_hw *ah);
1001 void ath9k_hw_set_tsfadjust(struct ath_hw *ah, bool set);
1002 void ath9k_hw_init_global_settings(struct ath_hw *ah);
1003 u32 ar9003_get_pll_sqsum_dvc(struct ath_hw *ah);
1004 void ath9k_hw_set11nmac2040(struct ath_hw *ah, struct ath9k_channel *chan);
1005 void ath9k_hw_beaconinit(struct ath_hw *ah, u32 next_beacon, u32 beacon_period);
1006 void ath9k_hw_set_sta_beacon_timers(struct ath_hw *ah,
1007 const struct ath9k_beacon_state *bs);
1008 void ath9k_hw_check_nav(struct ath_hw *ah);
1009 bool ath9k_hw_check_alive(struct ath_hw *ah);
1011 bool ath9k_hw_setpower(struct ath_hw *ah, enum ath9k_power_mode mode);
1013 /* Generic hw timer primitives */
1014 struct ath_gen_timer *ath_gen_timer_alloc(struct ath_hw *ah,
1015 void (*trigger)(void *),
1016 void (*overflow)(void *),
1019 void ath9k_hw_gen_timer_start(struct ath_hw *ah,
1020 struct ath_gen_timer *timer,
1023 void ath9k_hw_gen_timer_stop(struct ath_hw *ah, struct ath_gen_timer *timer);
1025 void ath_gen_timer_free(struct ath_hw *ah, struct ath_gen_timer *timer);
1026 void ath_gen_timer_isr(struct ath_hw *hw);
1028 void ath9k_hw_name(struct ath_hw *ah, char *hw_name, size_t len);
1031 void ath9k_hw_get_delta_slope_vals(struct ath_hw *ah, u32 coef_scaled,
1032 u32 *coef_mantissa, u32 *coef_exponent);
1033 void ath9k_hw_apply_txpower(struct ath_hw *ah, struct ath9k_channel *chan,
1037 * Code Specific to AR5008, AR9001 or AR9002,
1038 * we stuff these here to avoid callbacks for AR9003.
1040 int ar9002_hw_rf_claim(struct ath_hw *ah);
1041 void ar9002_hw_enable_async_fifo(struct ath_hw *ah);
1044 * Code specific to AR9003, we stuff these here to avoid callbacks
1045 * for older families
1047 bool ar9003_hw_bb_watchdog_check(struct ath_hw *ah);
1048 void ar9003_hw_bb_watchdog_config(struct ath_hw *ah);
1049 void ar9003_hw_bb_watchdog_read(struct ath_hw *ah);
1050 void ar9003_hw_bb_watchdog_dbg_info(struct ath_hw *ah);
1051 void ar9003_hw_disable_phy_restart(struct ath_hw *ah);
1052 void ar9003_paprd_enable(struct ath_hw *ah, bool val);
1053 void ar9003_paprd_populate_single_table(struct ath_hw *ah,
1054 struct ath9k_hw_cal_data *caldata,
1056 int ar9003_paprd_create_curve(struct ath_hw *ah,
1057 struct ath9k_hw_cal_data *caldata, int chain);
1058 void ar9003_paprd_setup_gain_table(struct ath_hw *ah, int chain);
1059 int ar9003_paprd_init_table(struct ath_hw *ah);
1060 bool ar9003_paprd_is_done(struct ath_hw *ah);
1061 bool ar9003_is_paprd_enabled(struct ath_hw *ah);
1062 void ar9003_hw_set_chain_masks(struct ath_hw *ah, u8 rx, u8 tx);
1064 /* Hardware family op attach helpers */
1065 int ar5008_hw_attach_phy_ops(struct ath_hw *ah);
1066 void ar9002_hw_attach_phy_ops(struct ath_hw *ah);
1067 void ar9003_hw_attach_phy_ops(struct ath_hw *ah);
1069 void ar9002_hw_attach_calib_ops(struct ath_hw *ah);
1070 void ar9003_hw_attach_calib_ops(struct ath_hw *ah);
1072 int ar9002_hw_attach_ops(struct ath_hw *ah);
1073 void ar9003_hw_attach_ops(struct ath_hw *ah);
1075 void ar9002_hw_load_ani_reg(struct ath_hw *ah, struct ath9k_channel *chan);
1077 void ath9k_ani_reset(struct ath_hw *ah, bool is_scanning);
1078 void ath9k_hw_ani_monitor(struct ath_hw *ah, struct ath9k_channel *chan);
1080 #ifdef CONFIG_ATH9K_BTCOEX_SUPPORT
1081 static inline bool ath9k_hw_btcoex_is_enabled(struct ath_hw *ah)
1083 return ah->btcoex_hw.enabled;
1085 static inline bool ath9k_hw_mci_is_enabled(struct ath_hw *ah)
1087 return ah->common.btcoex_enabled &&
1088 (ah->caps.hw_caps & ATH9K_HW_CAP_MCI);
1091 void ath9k_hw_btcoex_enable(struct ath_hw *ah);
1092 static inline enum ath_btcoex_scheme
1093 ath9k_hw_get_btcoex_scheme(struct ath_hw *ah)
1095 return ah->btcoex_hw.scheme;
1098 static inline bool ath9k_hw_btcoex_is_enabled(struct ath_hw *ah)
1102 static inline bool ath9k_hw_mci_is_enabled(struct ath_hw *ah)
1106 static inline void ath9k_hw_btcoex_enable(struct ath_hw *ah)
1109 static inline enum ath_btcoex_scheme
1110 ath9k_hw_get_btcoex_scheme(struct ath_hw *ah)
1112 return ATH_BTCOEX_CFG_NONE;
1114 #endif /* CONFIG_ATH9K_BTCOEX_SUPPORT */
1117 #ifdef CONFIG_ATH9K_WOW
1118 const char *ath9k_hw_wow_event_to_string(u32 wow_event);
1119 void ath9k_hw_wow_apply_pattern(struct ath_hw *ah, u8 *user_pattern,
1120 u8 *user_mask, int pattern_count,
1122 u32 ath9k_hw_wow_wakeup(struct ath_hw *ah);
1123 void ath9k_hw_wow_enable(struct ath_hw *ah, u32 pattern_enable);
1125 static inline const char *ath9k_hw_wow_event_to_string(u32 wow_event)
1129 static inline void ath9k_hw_wow_apply_pattern(struct ath_hw *ah,
1136 static inline u32 ath9k_hw_wow_wakeup(struct ath_hw *ah)
1140 static inline void ath9k_hw_wow_enable(struct ath_hw *ah, u32 pattern_enable)
1145 #define ATH9K_CLOCK_RATE_CCK 22
1146 #define ATH9K_CLOCK_RATE_5GHZ_OFDM 40
1147 #define ATH9K_CLOCK_RATE_2GHZ_OFDM 44
1148 #define ATH9K_CLOCK_FAST_RATE_5GHZ_OFDM 44