ar5212.h revision 224709
1185377Ssam/*
2187831Ssam * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
3185377Ssam * Copyright (c) 2002-2008 Atheros Communications, Inc.
4185377Ssam *
5185377Ssam * Permission to use, copy, modify, and/or distribute this software for any
6185377Ssam * purpose with or without fee is hereby granted, provided that the above
7185377Ssam * copyright notice and this permission notice appear in all copies.
8185377Ssam *
9185377Ssam * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10185377Ssam * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11185377Ssam * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12185377Ssam * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13185377Ssam * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14185377Ssam * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15185377Ssam * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16185377Ssam *
17187831Ssam * $FreeBSD: head/sys/dev/ath/ath_hal/ar5212/ar5212.h 224709 2011-08-08 13:15:39Z adrian $
18185377Ssam */
19185377Ssam#ifndef _ATH_AR5212_H_
20185377Ssam#define _ATH_AR5212_H_
21185377Ssam
22185377Ssam#include "ah_eeprom.h"
23185377Ssam
24185377Ssam#define	AR5212_MAGIC	0x19541014
25185377Ssam
26185377Ssam/* DCU Transmit Filter macros */
27185377Ssam#define CALC_MMR(dcu, idx) \
28185377Ssam	( (4 * dcu) + (idx < 32 ? 0 : (idx < 64 ? 1 : (idx < 96 ? 2 : 3))) )
29185377Ssam#define TXBLK_FROM_MMR(mmr) \
30185377Ssam	(AR_D_TXBLK_BASE + ((mmr & 0x1f) << 6) + ((mmr & 0x20) >> 3))
31185377Ssam#define CALC_TXBLK_ADDR(dcu, idx)	(TXBLK_FROM_MMR(CALC_MMR(dcu, idx)))
32185377Ssam#define CALC_TXBLK_VALUE(idx)		(1 << (idx & 0x1f))
33185377Ssam
34185377Ssam/* MAC register values */
35185377Ssam
36185377Ssam#define INIT_INTERRUPT_MASK \
37185377Ssam	( AR_IMR_TXERR  | AR_IMR_TXOK | AR_IMR_RXORN | \
38185377Ssam	  AR_IMR_RXERR  | AR_IMR_RXOK | AR_IMR_TXURN | \
39185377Ssam	  AR_IMR_HIUERR )
40185377Ssam#define INIT_BEACON_CONTROL \
41185377Ssam	((INIT_RESET_TSF << 24)  | (INIT_BEACON_EN << 23) | \
42185377Ssam	  (INIT_TIM_OFFSET << 16) | INIT_BEACON_PERIOD)
43185377Ssam
44185377Ssam#define INIT_CONFIG_STATUS	0x00000000
45185377Ssam#define INIT_RSSI_THR		0x00000781	/* Missed beacon counter initialized to 0x7 (max is 0xff) */
46185377Ssam#define INIT_IQCAL_LOG_COUNT_MAX	0xF
47185377Ssam#define INIT_BCON_CNTRL_REG	0x00000000
48185377Ssam
49185377Ssam#define INIT_USEC		40
50185377Ssam#define HALF_RATE_USEC		19 /* ((40 / 2) - 1 ) */
51185377Ssam#define QUARTER_RATE_USEC	9  /* ((40 / 4) - 1 ) */
52185377Ssam
53185377Ssam#define RX_NON_FULL_RATE_LATENCY	63
54185377Ssam#define TX_HALF_RATE_LATENCY		108
55185377Ssam#define TX_QUARTER_RATE_LATENCY		216
56185377Ssam
57185377Ssam#define IFS_SLOT_FULL_RATE	0x168 /* 9 us half, 40 MHz core clock (9*40) */
58185377Ssam#define IFS_SLOT_HALF_RATE	0x104 /* 13 us half, 20 MHz core clock (13*20) */
59185377Ssam#define IFS_SLOT_QUARTER_RATE	0xD2 /* 21 us quarter, 10 MHz core clock (21*10) */
60185377Ssam#define IFS_EIFS_FULL_RATE	0xE60 /* (74 + (2 * 9)) * 40MHz core clock */
61185377Ssam#define IFS_EIFS_HALF_RATE	0xDAC /* (149 + (2 * 13)) * 20MHz core clock */
62185377Ssam#define IFS_EIFS_QUARTER_RATE	0xD48 /* (298 + (2 * 21)) * 10MHz core clock */
63185377Ssam
64185377Ssam#define ACK_CTS_TIMEOUT_11A	0x3E8 /* ACK timeout in 11a core clocks */
65185377Ssam
66185377Ssam/* Tx frame start to tx data start delay */
67185377Ssam#define TX_FRAME_D_START_HALF_RATE 	0xc
68185377Ssam#define TX_FRAME_D_START_QUARTER_RATE 	0xd
69185377Ssam
70185377Ssam/*
71185377Ssam * Various fifo fill before Tx start, in 64-byte units
72185377Ssam * i.e. put the frame in the air while still DMAing
73185377Ssam */
74185377Ssam#define MIN_TX_FIFO_THRESHOLD	0x1
75185377Ssam#define MAX_TX_FIFO_THRESHOLD	((IEEE80211_MAX_LEN / 64) + 1)
76185377Ssam#define INIT_TX_FIFO_THRESHOLD	MIN_TX_FIFO_THRESHOLD
77185377Ssam
78185377Ssam#define	HAL_DECOMP_MASK_SIZE	128	/* 1 byte per key */
79185377Ssam
80185377Ssam/*
81185377Ssam * Gain support.
82185377Ssam */
83185377Ssam#define	NUM_CORNER_FIX_BITS		4
84185377Ssam#define	NUM_CORNER_FIX_BITS_5112	7
85185377Ssam#define	DYN_ADJ_UP_MARGIN		15
86185377Ssam#define	DYN_ADJ_LO_MARGIN		20
87185377Ssam#define	PHY_PROBE_CCK_CORRECTION	5
88185377Ssam#define	CCK_OFDM_GAIN_DELTA		15
89185377Ssam
90185377Ssamenum GAIN_PARAMS {
91185377Ssam	GP_TXCLIP,
92185377Ssam	GP_PD90,
93185377Ssam	GP_PD84,
94185377Ssam	GP_GSEL,
95185377Ssam};
96185377Ssam
97185377Ssamenum GAIN_PARAMS_5112 {
98185377Ssam	GP_MIXGAIN_OVR,
99185377Ssam	GP_PWD_138,
100185377Ssam	GP_PWD_137,
101185377Ssam	GP_PWD_136,
102185377Ssam	GP_PWD_132,
103185377Ssam	GP_PWD_131,
104185377Ssam	GP_PWD_130,
105185377Ssam};
106185377Ssam
107185377Ssamtypedef struct _gainOptStep {
108185377Ssam	int16_t	paramVal[NUM_CORNER_FIX_BITS_5112];
109185377Ssam	int32_t	stepGain;
110185377Ssam	int8_t	stepName[16];
111185377Ssam} GAIN_OPTIMIZATION_STEP;
112185377Ssam
113185377Ssamtypedef struct {
114185377Ssam	uint32_t	numStepsInLadder;
115185377Ssam	uint32_t	defaultStepNum;
116185377Ssam	GAIN_OPTIMIZATION_STEP optStep[10];
117185377Ssam} GAIN_OPTIMIZATION_LADDER;
118185377Ssam
119185377Ssamtypedef struct {
120185377Ssam	uint32_t	currStepNum;
121185377Ssam	uint32_t	currGain;
122185377Ssam	uint32_t	targetGain;
123185377Ssam	uint32_t	loTrig;
124185377Ssam	uint32_t	hiTrig;
125185377Ssam	uint32_t	active;
126185377Ssam	const GAIN_OPTIMIZATION_STEP *currStep;
127185377Ssam} GAIN_VALUES;
128185377Ssam
129185377Ssam/* RF HAL structures */
130185377Ssamtypedef struct RfHalFuncs {
131185377Ssam	void	  *priv;		/* private state */
132185377Ssam
133185377Ssam	void	  (*rfDetach)(struct ath_hal *ah);
134185377Ssam	void	  (*writeRegs)(struct ath_hal *,
135187831Ssam		      u_int modeIndex, u_int freqIndex, int regWrites);
136185377Ssam	uint32_t *(*getRfBank)(struct ath_hal *ah, int bank);
137187831Ssam	HAL_BOOL  (*setChannel)(struct ath_hal *,
138187831Ssam		      const struct ieee80211_channel *);
139185377Ssam	HAL_BOOL  (*setRfRegs)(struct ath_hal *,
140187831Ssam		      const struct ieee80211_channel *, uint16_t modesIndex,
141185377Ssam		      uint16_t *rfXpdGain);
142185377Ssam	HAL_BOOL  (*setPowerTable)(struct ath_hal *ah,
143185377Ssam		      int16_t *minPower, int16_t *maxPower,
144187831Ssam		      const struct ieee80211_channel *, uint16_t *rfXpdGain);
145187831Ssam	HAL_BOOL  (*getChannelMaxMinPower)(struct ath_hal *ah,
146187831Ssam		      const const struct ieee80211_channel *,
147185377Ssam		      int16_t *maxPow, int16_t *minPow);
148185377Ssam	int16_t	  (*getNfAdjust)(struct ath_hal *, const HAL_CHANNEL_INTERNAL*);
149185377Ssam} RF_HAL_FUNCS;
150185377Ssam
151185377Ssamstruct ar5212AniParams {
152185377Ssam	int		maxNoiseImmunityLevel;	/* [0..4] */
153185377Ssam	int		totalSizeDesired[5];
154185377Ssam	int		coarseHigh[5];
155185377Ssam	int		coarseLow[5];
156185377Ssam	int		firpwr[5];
157185377Ssam
158185377Ssam	int		maxSpurImmunityLevel;	/* [0..7] */
159185377Ssam	int		cycPwrThr1[8];
160185377Ssam
161185377Ssam	int		maxFirstepLevel;	/* [0..2] */
162185377Ssam	int		firstep[3];
163185377Ssam
164185377Ssam	uint32_t	ofdmTrigHigh;
165185377Ssam	uint32_t	ofdmTrigLow;
166185377Ssam	uint32_t	cckTrigHigh;
167185377Ssam	uint32_t	cckTrigLow;
168185377Ssam	int32_t		rssiThrLow;
169185377Ssam	uint32_t	rssiThrHigh;
170185377Ssam
171185377Ssam	int		period;			/* update listen period */
172185377Ssam
173185377Ssam	/* NB: intentionally ordered so data exported to user space is first */
174185377Ssam	uint32_t	ofdmPhyErrBase;	/* Base value for ofdm err counter */
175185377Ssam	uint32_t	cckPhyErrBase;	/* Base value for cck err counters */
176185377Ssam};
177185377Ssam
178185377Ssam/*
179185377Ssam * Per-channel ANI state private to the driver.
180185377Ssam */
181185377Ssamstruct ar5212AniState {
182185377Ssam	uint8_t		noiseImmunityLevel;
183185377Ssam	uint8_t		spurImmunityLevel;
184185377Ssam	uint8_t		firstepLevel;
185185377Ssam	uint8_t		ofdmWeakSigDetectOff;
186185377Ssam	uint8_t		cckWeakSigThreshold;
187185377Ssam	uint32_t	listenTime;
188185377Ssam
189185377Ssam	/* NB: intentionally ordered so data exported to user space is first */
190185377Ssam	uint32_t	txFrameCount;	/* Last txFrameCount */
191185377Ssam	uint32_t	rxFrameCount;	/* Last rx Frame count */
192185377Ssam	uint32_t	cycleCount;	/* Last cycleCount
193185377Ssam					   (to detect wrap-around) */
194185377Ssam	uint32_t	ofdmPhyErrCount;/* OFDM err count since last reset */
195185377Ssam	uint32_t	cckPhyErrCount;	/* CCK err count since last reset */
196185377Ssam
197185377Ssam	const struct ar5212AniParams *params;
198185377Ssam};
199185377Ssam
200185377Ssam#define	HAL_ANI_ENA		0x00000001	/* ANI operation enabled */
201185377Ssam#define	HAL_RSSI_ANI_ENA	0x00000002	/* rssi-based processing ena'd*/
202185377Ssam
203185377Ssamstruct ar5212Stats {
204185377Ssam	uint32_t	ast_ani_niup;	/* ANI increased noise immunity */
205185377Ssam	uint32_t	ast_ani_nidown;	/* ANI decreased noise immunity */
206185377Ssam	uint32_t	ast_ani_spurup;	/* ANI increased spur immunity */
207185377Ssam	uint32_t	ast_ani_spurdown;/* ANI descreased spur immunity */
208185377Ssam	uint32_t	ast_ani_ofdmon;	/* ANI OFDM weak signal detect on */
209185377Ssam	uint32_t	ast_ani_ofdmoff;/* ANI OFDM weak signal detect off */
210185377Ssam	uint32_t	ast_ani_cckhigh;/* ANI CCK weak signal threshold high */
211185377Ssam	uint32_t	ast_ani_ccklow;	/* ANI CCK weak signal threshold low */
212185377Ssam	uint32_t	ast_ani_stepup;	/* ANI increased first step level */
213185377Ssam	uint32_t	ast_ani_stepdown;/* ANI decreased first step level */
214185377Ssam	uint32_t	ast_ani_ofdmerrs;/* ANI cumulative ofdm phy err count */
215185377Ssam	uint32_t	ast_ani_cckerrs;/* ANI cumulative cck phy err count */
216185377Ssam	uint32_t	ast_ani_reset;	/* ANI parameters zero'd for non-STA */
217185377Ssam	uint32_t	ast_ani_lzero;	/* ANI listen time forced to zero */
218185377Ssam	uint32_t	ast_ani_lneg;	/* ANI listen time calculated < 0 */
219185377Ssam	HAL_MIB_STATS	ast_mibstats;	/* MIB counter stats */
220185377Ssam	HAL_NODE_STATS	ast_nodestats;	/* Latest rssi stats from driver */
221185377Ssam};
222185377Ssam
223185377Ssam/*
224185377Ssam * NF Cal history buffer
225185377Ssam */
226185377Ssam#define	AR5212_CCA_MAX_GOOD_VALUE	-95
227185377Ssam#define	AR5212_CCA_MAX_HIGH_VALUE	-62
228185377Ssam#define	AR5212_CCA_MIN_BAD_VALUE	-125
229185377Ssam
230185377Ssam#define	AR512_NF_CAL_HIST_MAX		5
231185377Ssam
232185377Ssamstruct ar5212NfCalHist {
233185377Ssam	int16_t		nfCalBuffer[AR512_NF_CAL_HIST_MAX];
234185377Ssam	int16_t		privNF;
235185377Ssam	uint8_t		currIndex;
236185377Ssam	uint8_t		first_run;
237185377Ssam	uint8_t		invalidNFcount;
238185377Ssam};
239185377Ssam
240185377Ssamstruct ath_hal_5212 {
241185377Ssam	struct ath_hal_private	ah_priv;	/* base class */
242185377Ssam
243185377Ssam	/*
244185377Ssam	 * Per-chip common Initialization data.
245185377Ssam	 * NB: RF backends have their own ini data.
246185377Ssam	 */
247185377Ssam	HAL_INI_ARRAY	ah_ini_modes;
248185377Ssam	HAL_INI_ARRAY	ah_ini_common;
249185377Ssam
250185377Ssam	GAIN_VALUES	ah_gainValues;
251185377Ssam
252185377Ssam	uint8_t		ah_macaddr[IEEE80211_ADDR_LEN];
253185377Ssam	uint8_t		ah_bssid[IEEE80211_ADDR_LEN];
254185377Ssam	uint8_t		ah_bssidmask[IEEE80211_ADDR_LEN];
255185377Ssam
256185377Ssam	/*
257185377Ssam	 * Runtime state.
258185377Ssam	 */
259185377Ssam	uint32_t	ah_maskReg;		/* copy of AR_IMR */
260185377Ssam	struct ar5212Stats ah_stats;		/* various statistics */
261185377Ssam	RF_HAL_FUNCS	*ah_rfHal;
262185377Ssam	uint32_t	ah_txDescMask;		/* mask for TXDESC */
263185377Ssam	uint32_t	ah_txOkInterruptMask;
264185377Ssam	uint32_t	ah_txErrInterruptMask;
265185377Ssam	uint32_t	ah_txDescInterruptMask;
266185377Ssam	uint32_t	ah_txEolInterruptMask;
267185377Ssam	uint32_t	ah_txUrnInterruptMask;
268185377Ssam	HAL_TX_QUEUE_INFO ah_txq[HAL_NUM_TX_QUEUES];
269185380Ssam	uint32_t	ah_intrTxqs;		/* tx q interrupt state */
270185377Ssam						/* decomp mask array */
271185380Ssam	uint8_t		ah_decompMask[HAL_DECOMP_MASK_SIZE];
272185377Ssam	HAL_POWER_MODE	ah_powerMode;
273185380Ssam	HAL_ANT_SETTING ah_antControl;		/* antenna setting */
274185380Ssam	HAL_BOOL	ah_diversity;		/* fast diversity setting */
275185377Ssam	enum {
276185377Ssam		IQ_CAL_INACTIVE,
277185377Ssam		IQ_CAL_RUNNING,
278185377Ssam		IQ_CAL_DONE
279185377Ssam	} ah_bIQCalibration;			/* IQ calibrate state */
280185377Ssam	HAL_RFGAIN	ah_rfgainState;		/* RF gain calibrartion state */
281185377Ssam	uint32_t	ah_tx6PowerInHalfDbm;	/* power output for 6Mb tx */
282185377Ssam	uint32_t	ah_staId1Defaults;	/* STA_ID1 default settings */
283185377Ssam	uint32_t	ah_miscMode;		/* MISC_MODE settings */
284185377Ssam	uint32_t	ah_rssiThr;		/* RSSI_THR settings */
285185377Ssam	HAL_BOOL	ah_cwCalRequire;	/* for ap51 */
286185377Ssam	HAL_BOOL	ah_tpcEnabled;		/* per-packet tpc enabled */
287185380Ssam	HAL_BOOL	ah_phyPowerOn;		/* PHY power state */
288185380Ssam	HAL_BOOL	ah_isHb63;		/* cached HB63 check */
289185377Ssam	uint32_t	ah_macTPC;		/* tpc register */
290185377Ssam	uint32_t	ah_beaconInterval;	/* XXX */
291185377Ssam	enum {
292185377Ssam		AUTO_32KHZ,		/* use it if 32kHz crystal present */
293185377Ssam		USE_32KHZ,		/* do it regardless */
294185377Ssam		DONT_USE_32KHZ,		/* don't use it regardless */
295185377Ssam	} ah_enable32kHzClock;			/* whether to sleep at 32kHz */
296185377Ssam	uint32_t	ah_ofdmTxPower;
297185377Ssam	int16_t		ah_txPowerIndexOffset;
298185377Ssam	/*
299185377Ssam	 * Noise floor cal histogram support.
300185377Ssam	 */
301185377Ssam	struct ar5212NfCalHist ah_nfCalHist;
302185377Ssam
303185377Ssam	u_int		ah_slottime;		/* user-specified slot time */
304185377Ssam	u_int		ah_acktimeout;		/* user-specified ack timeout */
305185377Ssam	u_int		ah_ctstimeout;		/* user-specified cts timeout */
306185377Ssam	u_int		ah_sifstime;		/* user-specified sifs time */
307185377Ssam	/*
308185377Ssam	 * RF Silent handling; setup according to the EEPROM.
309185377Ssam	 */
310185377Ssam	uint32_t	ah_gpioSelect;		/* GPIO pin to use */
311185377Ssam	uint32_t	ah_polarity;		/* polarity to disable RF */
312185377Ssam	uint32_t	ah_gpioBit;		/* after init, prev value */
313185377Ssam	/*
314185377Ssam	 * ANI support.
315185377Ssam	 */
316185377Ssam	uint32_t	ah_procPhyErr;		/* Process Phy errs */
317185377Ssam	HAL_BOOL	ah_hasHwPhyCounters;	/* Hardware has phy counters */
318185377Ssam	struct ar5212AniParams ah_aniParams24;	/* 2.4GHz parameters */
319185377Ssam	struct ar5212AniParams ah_aniParams5;	/* 5GHz parameters */
320185377Ssam	struct ar5212AniState	*ah_curani;	/* cached last reference */
321187831Ssam	struct ar5212AniState	ah_ani[AH_MAXCHAN]; /* per-channel state */
322185377Ssam
323222265Sadrian	/* AR5416 uses some of the AR5212 ANI code; these are the ANI methods */
324222265Sadrian	HAL_BOOL	(*ah_aniControl) (struct ath_hal *, HAL_ANI_CMD cmd, int param);
325222265Sadrian
326185377Ssam	/*
327185377Ssam	 * Transmit power state.  Note these are maintained
328185377Ssam	 * here so they can be retrieved by diagnostic tools.
329185377Ssam	 */
330185377Ssam	uint16_t	*ah_pcdacTable;
331185377Ssam	u_int		ah_pcdacTableSize;
332218012Sadrian	uint16_t	ah_ratesArray[37];
333204579Srpaulo
334204579Srpaulo	uint8_t		ah_txTrigLev;		/* current Tx trigger level */
335204579Srpaulo	uint8_t		ah_maxTxTrigLev;	/* max tx trigger level */
336185377Ssam};
337185377Ssam#define	AH5212(_ah)	((struct ath_hal_5212 *)(_ah))
338185377Ssam
339185380Ssam/*
340185380Ssam * IS_XXXX macros test the MAC version
341185380Ssam * IS_RADXXX macros test the radio/RF version (matching both 2G-only and 2/5G)
342185380Ssam *
343185380Ssam * Some single chip radios have equivalent radio/RF (e.g. 5112)
344185380Ssam * for those use IS_RADXXX_ANY macros.
345185380Ssam */
346185377Ssam#define IS_2317(ah) \
347185377Ssam	((AH_PRIVATE(ah)->ah_devid == AR5212_AR2317_REV1) || \
348185377Ssam	 (AH_PRIVATE(ah)->ah_devid == AR5212_AR2317_REV2))
349185377Ssam#define	IS_2316(ah) \
350185377Ssam	(AH_PRIVATE(ah)->ah_macVersion == AR_SREV_2415)
351185377Ssam#define	IS_2413(ah) \
352185377Ssam	(AH_PRIVATE(ah)->ah_macVersion == AR_SREV_2413 || IS_2316(ah))
353185377Ssam#define IS_5424(ah) \
354185377Ssam	(AH_PRIVATE(ah)->ah_macVersion == AR_SREV_5424 || \
355185377Ssam	(AH_PRIVATE(ah)->ah_macVersion == AR_SREV_5413 && \
356185377Ssam	  AH_PRIVATE(ah)->ah_macRev <= AR_SREV_D2PLUS_MS))
357185377Ssam#define IS_5413(ah) \
358185377Ssam	(AH_PRIVATE(ah)->ah_macVersion == AR_SREV_5413 || IS_5424(ah))
359185377Ssam#define IS_2425(ah) \
360185377Ssam	(AH_PRIVATE(ah)->ah_macVersion == AR_SREV_2425)
361185377Ssam#define IS_2417(ah) \
362185377Ssam	((AH_PRIVATE(ah)->ah_macVersion) == AR_SREV_2417)
363185377Ssam#define IS_HB63(ah)		(AH5212(ah)->ah_isHb63 == AH_TRUE)
364185377Ssam
365185380Ssam#define	AH_RADIO_MAJOR(ah) \
366185380Ssam	(AH_PRIVATE(ah)->ah_analog5GhzRev & AR_RADIO_SREV_MAJOR)
367185380Ssam#define	AH_RADIO_MINOR(ah) \
368185380Ssam	(AH_PRIVATE(ah)->ah_analog5GhzRev & AR_RADIO_SREV_MINOR)
369185380Ssam#define	IS_RAD5111(ah) \
370185380Ssam	(AH_RADIO_MAJOR(ah) == AR_RAD5111_SREV_MAJOR || \
371185380Ssam	 AH_RADIO_MAJOR(ah) == AR_RAD2111_SREV_MAJOR)
372185380Ssam#define	IS_RAD5112(ah) \
373185380Ssam	(AH_RADIO_MAJOR(ah) == AR_RAD5112_SREV_MAJOR || \
374185380Ssam	 AH_RADIO_MAJOR(ah) == AR_RAD2112_SREV_MAJOR)
375185380Ssam/* NB: does not include 5413 as Atheros' IS_5112 macro does */
376185380Ssam#define	IS_RAD5112_ANY(ah) \
377185380Ssam	(AR_RAD5112_SREV_MAJOR <= AH_RADIO_MAJOR(ah) && \
378185380Ssam	 AH_RADIO_MAJOR(ah) <= AR_RAD2413_SREV_MAJOR)
379185380Ssam#define	IS_RAD5112_REV1(ah) \
380185380Ssam	(IS_RAD5112(ah) && \
381185380Ssam	 AH_RADIO_MINOR(ah) < (AR_RAD5112_SREV_2_0 & AR_RADIO_SREV_MINOR))
382185380Ssam#define IS_RADX112_REV2(ah) \
383185380Ssam	(AH_PRIVATE(ah)->ah_analog5GhzRev == AR_RAD5112_SREV_2_0 || \
384185380Ssam	 AH_PRIVATE(ah)->ah_analog5GhzRev == AR_RAD2112_SREV_2_0 || \
385185380Ssam	 AH_PRIVATE(ah)->ah_analog5GhzRev == AR_RAD2112_SREV_2_1 || \
386185380Ssam	 AH_PRIVATE(ah)->ah_analog5GhzRev == AR_RAD5112_SREV_2_1)
387185380Ssam
388185377Ssam#define	ar5212RfDetach(ah) do {				\
389185377Ssam	if (AH5212(ah)->ah_rfHal != AH_NULL)		\
390185377Ssam		AH5212(ah)->ah_rfHal->rfDetach(ah);	\
391185377Ssam} while (0)
392185377Ssam#define	ar5212GetRfBank(ah, b) \
393185377Ssam	AH5212(ah)->ah_rfHal->getRfBank(ah, b)
394185377Ssam
395185377Ssam/*
396185377Ssam * Hack macros for Nala/San: 11b is handled
397185377Ssam * using 11g; flip the channel flags to accomplish this.
398185377Ssam */
399185377Ssam#define SAVE_CCK(_ah, _chan, _flag) do {			\
400185377Ssam	if ((IS_2425(_ah) || IS_2417(_ah)) &&			\
401187831Ssam	    (((_chan)->ic_flags) & IEEE80211_CHAN_CCK)) {	\
402187831Ssam		(_chan)->ic_flags &= ~IEEE80211_CHAN_CCK;	\
403187831Ssam		(_chan)->ic_flags |= IEEE80211_CHAN_DYN;	\
404185377Ssam		(_flag) = AH_TRUE;				\
405188012Ssam	} else							\
406188012Ssam		(_flag) = AH_FALSE;				\
407185377Ssam} while (0)
408185377Ssam#define RESTORE_CCK(_ah, _chan, _flag) do {                     \
409188012Ssam	if ((_flag) && (IS_2425(_ah) || IS_2417(_ah))) {	\
410187831Ssam		(_chan)->ic_flags &= ~IEEE80211_CHAN_DYN;	\
411187831Ssam		(_chan)->ic_flags |= IEEE80211_CHAN_CCK;	\
412185377Ssam	}							\
413185377Ssam} while (0)
414185377Ssam
415185377Ssamstruct ath_hal;
416185377Ssam
417185377Ssamextern	uint32_t ar5212GetRadioRev(struct ath_hal *ah);
418185377Ssamextern	void ar5212InitState(struct ath_hal_5212 *, uint16_t devid, HAL_SOFTC,
419185377Ssam		HAL_BUS_TAG st, HAL_BUS_HANDLE sh, HAL_STATUS *status);
420185377Ssamextern	void ar5212Detach(struct ath_hal *ah);
421185377Ssamextern  HAL_BOOL ar5212ChipTest(struct ath_hal *ah);
422185377Ssamextern  HAL_BOOL ar5212GetChannelEdges(struct ath_hal *ah,
423185377Ssam                uint16_t flags, uint16_t *low, uint16_t *high);
424185377Ssamextern	HAL_BOOL ar5212FillCapabilityInfo(struct ath_hal *ah);
425185377Ssam
426185377Ssamextern	void ar5212SetBeaconTimers(struct ath_hal *ah,
427185377Ssam		const HAL_BEACON_TIMERS *);
428185377Ssamextern	void ar5212BeaconInit(struct ath_hal *ah,
429185377Ssam		uint32_t next_beacon, uint32_t beacon_period);
430185377Ssamextern	void ar5212ResetStaBeaconTimers(struct ath_hal *ah);
431185377Ssamextern	void ar5212SetStaBeaconTimers(struct ath_hal *ah,
432185377Ssam		const HAL_BEACON_STATE *);
433185377Ssam
434185377Ssamextern	HAL_BOOL ar5212IsInterruptPending(struct ath_hal *ah);
435185377Ssamextern	HAL_BOOL ar5212GetPendingInterrupts(struct ath_hal *ah, HAL_INT *);
436185377Ssamextern	HAL_INT ar5212GetInterrupts(struct ath_hal *ah);
437185377Ssamextern	HAL_INT ar5212SetInterrupts(struct ath_hal *ah, HAL_INT ints);
438185377Ssam
439185377Ssamextern	uint32_t ar5212GetKeyCacheSize(struct ath_hal *);
440185377Ssamextern	HAL_BOOL ar5212IsKeyCacheEntryValid(struct ath_hal *, uint16_t entry);
441185377Ssamextern	HAL_BOOL ar5212ResetKeyCacheEntry(struct ath_hal *ah, uint16_t entry);
442185377Ssamextern	HAL_BOOL ar5212SetKeyCacheEntryMac(struct ath_hal *,
443185377Ssam			uint16_t entry, const uint8_t *mac);
444185377Ssamextern	HAL_BOOL ar5212SetKeyCacheEntry(struct ath_hal *ah, uint16_t entry,
445185377Ssam                       const HAL_KEYVAL *k, const uint8_t *mac, int xorKey);
446185377Ssam
447185377Ssamextern	void ar5212GetMacAddress(struct ath_hal *ah, uint8_t *mac);
448185377Ssamextern	HAL_BOOL ar5212SetMacAddress(struct ath_hal *ah, const uint8_t *);
449185377Ssamextern	void ar5212GetBssIdMask(struct ath_hal *ah, uint8_t *mac);
450185377Ssamextern	HAL_BOOL ar5212SetBssIdMask(struct ath_hal *, const uint8_t *);
451185377Ssamextern	HAL_BOOL ar5212EepromRead(struct ath_hal *, u_int off, uint16_t *data);
452185377Ssamextern	HAL_BOOL ar5212EepromWrite(struct ath_hal *, u_int off, uint16_t data);
453185377Ssamextern	HAL_BOOL ar5212SetRegulatoryDomain(struct ath_hal *ah,
454185377Ssam		uint16_t regDomain, HAL_STATUS *stats);
455185377Ssamextern	u_int ar5212GetWirelessModes(struct ath_hal *ah);
456185377Ssamextern	void ar5212EnableRfKill(struct ath_hal *);
457188974Ssamextern	HAL_BOOL ar5212GpioCfgOutput(struct ath_hal *, uint32_t gpio,
458188974Ssam		HAL_GPIO_MUX_TYPE);
459185377Ssamextern	HAL_BOOL ar5212GpioCfgInput(struct ath_hal *, uint32_t gpio);
460185377Ssamextern	HAL_BOOL ar5212GpioSet(struct ath_hal *, uint32_t gpio, uint32_t val);
461185377Ssamextern	uint32_t ar5212GpioGet(struct ath_hal *ah, uint32_t gpio);
462185377Ssamextern	void ar5212GpioSetIntr(struct ath_hal *ah, u_int, uint32_t ilevel);
463185377Ssamextern	void ar5212SetLedState(struct ath_hal *ah, HAL_LED_STATE state);
464185377Ssamextern	void ar5212WriteAssocid(struct ath_hal *ah, const uint8_t *bssid,
465185377Ssam		uint16_t assocId);
466185377Ssamextern	uint32_t ar5212GetTsf32(struct ath_hal *ah);
467185377Ssamextern	uint64_t ar5212GetTsf64(struct ath_hal *ah);
468219419Sadrianextern	void ar5212SetTsf64(struct ath_hal *ah, uint64_t tsf64);
469185377Ssamextern	void ar5212ResetTsf(struct ath_hal *ah);
470185377Ssamextern	void ar5212SetBasicRate(struct ath_hal *ah, HAL_RATE_SET *pSet);
471185377Ssamextern	uint32_t ar5212GetRandomSeed(struct ath_hal *ah);
472185377Ssamextern	HAL_BOOL ar5212DetectCardPresent(struct ath_hal *ah);
473185377Ssamextern	void ar5212EnableMibCounters(struct ath_hal *);
474185377Ssamextern	void ar5212DisableMibCounters(struct ath_hal *);
475185377Ssamextern	void ar5212UpdateMibCounters(struct ath_hal *ah, HAL_MIB_STATS* stats);
476185377Ssamextern	HAL_BOOL ar5212IsJapanChannelSpreadSupported(struct ath_hal *ah);
477185377Ssamextern	uint32_t ar5212GetCurRssi(struct ath_hal *ah);
478185377Ssamextern	u_int ar5212GetDefAntenna(struct ath_hal *ah);
479185377Ssamextern	void ar5212SetDefAntenna(struct ath_hal *ah, u_int antenna);
480185377Ssamextern	HAL_ANT_SETTING ar5212GetAntennaSwitch(struct ath_hal *);
481185377Ssamextern	HAL_BOOL ar5212SetAntennaSwitch(struct ath_hal *, HAL_ANT_SETTING);
482185377Ssamextern	HAL_BOOL ar5212IsSleepAfterBeaconBroken(struct ath_hal *ah);
483185377Ssamextern	HAL_BOOL ar5212SetSifsTime(struct ath_hal *, u_int);
484185377Ssamextern	u_int ar5212GetSifsTime(struct ath_hal *);
485185377Ssamextern	HAL_BOOL ar5212SetSlotTime(struct ath_hal *, u_int);
486185377Ssamextern	u_int ar5212GetSlotTime(struct ath_hal *);
487185377Ssamextern	HAL_BOOL ar5212SetAckTimeout(struct ath_hal *, u_int);
488185377Ssamextern	u_int ar5212GetAckTimeout(struct ath_hal *);
489185377Ssamextern	HAL_BOOL ar5212SetAckCTSRate(struct ath_hal *, u_int);
490185377Ssamextern	u_int ar5212GetAckCTSRate(struct ath_hal *);
491185377Ssamextern	HAL_BOOL ar5212SetCTSTimeout(struct ath_hal *, u_int);
492185377Ssamextern	u_int ar5212GetCTSTimeout(struct ath_hal *);
493185377Ssamextern  HAL_BOOL ar5212SetDecompMask(struct ath_hal *, uint16_t, int);
494185377Ssamvoid 	ar5212SetCoverageClass(struct ath_hal *, uint8_t, int);
495185377Ssamextern	void ar5212SetPCUConfig(struct ath_hal *);
496185377Ssamextern	HAL_BOOL ar5212Use32KHzclock(struct ath_hal *ah, HAL_OPMODE opmode);
497185377Ssamextern	void ar5212SetupClock(struct ath_hal *ah, HAL_OPMODE opmode);
498185377Ssamextern	void ar5212RestoreClock(struct ath_hal *ah, HAL_OPMODE opmode);
499185377Ssamextern	int16_t ar5212GetNfAdjust(struct ath_hal *,
500185377Ssam		const HAL_CHANNEL_INTERNAL *);
501185377Ssamextern	void ar5212SetCompRegs(struct ath_hal *ah);
502185377Ssamextern	HAL_STATUS ar5212GetCapability(struct ath_hal *, HAL_CAPABILITY_TYPE,
503185377Ssam		uint32_t, uint32_t *);
504185377Ssamextern	HAL_BOOL ar5212SetCapability(struct ath_hal *, HAL_CAPABILITY_TYPE,
505185377Ssam		uint32_t, uint32_t, HAL_STATUS *);
506185377Ssamextern	HAL_BOOL ar5212GetDiagState(struct ath_hal *ah, int request,
507185377Ssam		const void *args, uint32_t argsize,
508185377Ssam		void **result, uint32_t *resultsize);
509222644Sadrianextern	HAL_STATUS ar5212SetQuiet(struct ath_hal *ah, uint32_t period,
510222644Sadrian		uint32_t duration, uint32_t nextStart, HAL_QUIET_FLAG flag);
511185377Ssam
512185377Ssamextern	HAL_BOOL ar5212SetPowerMode(struct ath_hal *ah, HAL_POWER_MODE mode,
513185377Ssam		int setChip);
514185377Ssamextern	HAL_POWER_MODE ar5212GetPowerMode(struct ath_hal *ah);
515185377Ssamextern	HAL_BOOL ar5212GetPowerStatus(struct ath_hal *ah);
516185377Ssam
517185377Ssamextern	uint32_t ar5212GetRxDP(struct ath_hal *ath);
518185377Ssamextern	void ar5212SetRxDP(struct ath_hal *ah, uint32_t rxdp);
519185377Ssamextern	void ar5212EnableReceive(struct ath_hal *ah);
520185377Ssamextern	HAL_BOOL ar5212StopDmaReceive(struct ath_hal *ah);
521185377Ssamextern	void ar5212StartPcuReceive(struct ath_hal *ah);
522185377Ssamextern	void ar5212StopPcuReceive(struct ath_hal *ah);
523185377Ssamextern	void ar5212SetMulticastFilter(struct ath_hal *ah,
524185377Ssam		uint32_t filter0, uint32_t filter1);
525185377Ssamextern	HAL_BOOL ar5212ClrMulticastFilterIndex(struct ath_hal *, uint32_t ix);
526185377Ssamextern	HAL_BOOL ar5212SetMulticastFilterIndex(struct ath_hal *, uint32_t ix);
527185377Ssamextern	uint32_t ar5212GetRxFilter(struct ath_hal *ah);
528185377Ssamextern	void ar5212SetRxFilter(struct ath_hal *ah, uint32_t bits);
529185377Ssamextern	HAL_BOOL ar5212SetupRxDesc(struct ath_hal *,
530185377Ssam		struct ath_desc *, uint32_t size, u_int flags);
531185377Ssamextern	HAL_STATUS ar5212ProcRxDesc(struct ath_hal *ah, struct ath_desc *,
532185377Ssam		uint32_t, struct ath_desc *, uint64_t,
533185377Ssam		struct ath_rx_status *);
534185377Ssam
535185377Ssamextern	HAL_BOOL ar5212Reset(struct ath_hal *ah, HAL_OPMODE opmode,
536187831Ssam		struct ieee80211_channel *chan, HAL_BOOL bChannelChange,
537187831Ssam		HAL_STATUS *status);
538187831Ssamextern	HAL_BOOL ar5212SetChannel(struct ath_hal *,
539187831Ssam		const struct ieee80211_channel *);
540185377Ssamextern	void ar5212SetOperatingMode(struct ath_hal *ah, int opmode);
541185377Ssamextern	HAL_BOOL ar5212PhyDisable(struct ath_hal *ah);
542185377Ssamextern	HAL_BOOL ar5212Disable(struct ath_hal *ah);
543187831Ssamextern	HAL_BOOL ar5212ChipReset(struct ath_hal *ah,
544187831Ssam		const struct ieee80211_channel *);
545187831Ssamextern	HAL_BOOL ar5212PerCalibration(struct ath_hal *ah,
546187831Ssam		struct ieee80211_channel *chan, HAL_BOOL *isIQdone);
547187831Ssamextern	HAL_BOOL ar5212PerCalibrationN(struct ath_hal *ah,
548187831Ssam		struct ieee80211_channel *chan, u_int chainMask,
549187831Ssam		HAL_BOOL longCal, HAL_BOOL *isCalDone);
550187831Ssamextern	HAL_BOOL ar5212ResetCalValid(struct ath_hal *ah,
551187831Ssam		const struct ieee80211_channel *);
552185377Ssamextern	int16_t ar5212GetNoiseFloor(struct ath_hal *ah);
553185377Ssamextern	void ar5212InitNfCalHistBuffer(struct ath_hal *);
554185377Ssamextern	int16_t ar5212GetNfHistMid(const int16_t calData[]);
555187831Ssamextern	void ar5212SetSpurMitigation(struct ath_hal *,
556187831Ssam		 const struct ieee80211_channel *);
557185377Ssamextern	HAL_BOOL ar5212SetAntennaSwitchInternal(struct ath_hal *ah,
558187831Ssam		HAL_ANT_SETTING settings, const struct ieee80211_channel *);
559185377Ssamextern	HAL_BOOL ar5212SetTxPowerLimit(struct ath_hal *ah, uint32_t limit);
560185377Ssamextern	HAL_BOOL ar5212GetChipPowerLimits(struct ath_hal *ah,
561187831Ssam		struct ieee80211_channel *chan);
562185377Ssamextern	void ar5212InitializeGainValues(struct ath_hal *);
563185377Ssamextern	HAL_RFGAIN ar5212GetRfgain(struct ath_hal *ah);
564185380Ssamextern	void ar5212RequestRfgain(struct ath_hal *);
565185377Ssam
566185377Ssamextern	HAL_BOOL ar5212UpdateTxTrigLevel(struct ath_hal *,
567185377Ssam		HAL_BOOL IncTrigLevel);
568185377Ssamextern  HAL_BOOL ar5212SetTxQueueProps(struct ath_hal *ah, int q,
569185377Ssam		const HAL_TXQ_INFO *qInfo);
570185377Ssamextern	HAL_BOOL ar5212GetTxQueueProps(struct ath_hal *ah, int q,
571185377Ssam		HAL_TXQ_INFO *qInfo);
572185377Ssamextern	int ar5212SetupTxQueue(struct ath_hal *ah, HAL_TX_QUEUE type,
573185377Ssam		const HAL_TXQ_INFO *qInfo);
574185377Ssamextern	HAL_BOOL ar5212ReleaseTxQueue(struct ath_hal *ah, u_int q);
575185377Ssamextern	HAL_BOOL ar5212ResetTxQueue(struct ath_hal *ah, u_int q);
576185377Ssamextern	uint32_t ar5212GetTxDP(struct ath_hal *ah, u_int q);
577185377Ssamextern	HAL_BOOL ar5212SetTxDP(struct ath_hal *ah, u_int q, uint32_t txdp);
578185377Ssamextern	HAL_BOOL ar5212StartTxDma(struct ath_hal *ah, u_int q);
579185377Ssamextern	uint32_t ar5212NumTxPending(struct ath_hal *ah, u_int q);
580185377Ssamextern	HAL_BOOL ar5212StopTxDma(struct ath_hal *ah, u_int q);
581185377Ssamextern	HAL_BOOL ar5212SetupTxDesc(struct ath_hal *ah, struct ath_desc *ds,
582185377Ssam		u_int pktLen, u_int hdrLen, HAL_PKT_TYPE type, u_int txPower,
583185377Ssam		u_int txRate0, u_int txTries0,
584185377Ssam		u_int keyIx, u_int antMode, u_int flags,
585185377Ssam		u_int rtsctsRate, u_int rtsctsDuration,
586185377Ssam		u_int compicvLen, u_int compivLen, u_int comp);
587185377Ssamextern	HAL_BOOL ar5212SetupXTxDesc(struct ath_hal *, struct ath_desc *,
588185377Ssam		u_int txRate1, u_int txRetries1,
589185377Ssam		u_int txRate2, u_int txRetries2,
590185377Ssam		u_int txRate3, u_int txRetries3);
591185377Ssamextern	HAL_BOOL ar5212FillTxDesc(struct ath_hal *ah, struct ath_desc *ds,
592185377Ssam		u_int segLen, HAL_BOOL firstSeg, HAL_BOOL lastSeg,
593185377Ssam		const struct ath_desc *ds0);
594185377Ssamextern	HAL_STATUS ar5212ProcTxDesc(struct ath_hal *ah,
595185377Ssam		struct ath_desc *, struct ath_tx_status *);
596185377Ssamextern  void ar5212GetTxIntrQueue(struct ath_hal *ah, uint32_t *);
597185377Ssamextern  void ar5212IntrReqTxDesc(struct ath_hal *ah, struct ath_desc *);
598217621Sadrianextern	HAL_BOOL ar5212GetTxCompletionRates(struct ath_hal *ah,
599217621Sadrian		const struct ath_desc *ds0, int *rates, int *tries);
600185377Ssam
601185377Ssamextern	const HAL_RATE_TABLE *ar5212GetRateTable(struct ath_hal *, u_int mode);
602185377Ssam
603185377Ssamextern	void ar5212AniAttach(struct ath_hal *, const struct ar5212AniParams *,
604185377Ssam		const struct ar5212AniParams *, HAL_BOOL ena);
605185377Ssamextern	void ar5212AniDetach(struct ath_hal *);
606185377Ssamextern	struct ar5212AniState *ar5212AniGetCurrentState(struct ath_hal *);
607185377Ssamextern	struct ar5212Stats *ar5212AniGetCurrentStats(struct ath_hal *);
608185377Ssamextern	HAL_BOOL ar5212AniControl(struct ath_hal *, HAL_ANI_CMD cmd, int param);
609185377Ssamextern	HAL_BOOL ar5212AniSetParams(struct ath_hal *,
610185377Ssam		const struct ar5212AniParams *, const struct ar5212AniParams *);
611185377Ssamstruct ath_rx_status;
612185377Ssamextern	void ar5212AniPhyErrReport(struct ath_hal *ah,
613185377Ssam		const struct ath_rx_status *rs);
614185377Ssamextern	void ar5212ProcessMibIntr(struct ath_hal *, const HAL_NODE_STATS *);
615217684Sadrianextern	void ar5212RxMonitor(struct ath_hal *, const HAL_NODE_STATS *,
616187831Ssam			     const struct ieee80211_channel *);
617217684Sadrianextern	void ar5212AniPoll(struct ath_hal *, const struct ieee80211_channel *);
618187831Ssamextern	void ar5212AniReset(struct ath_hal *, const struct ieee80211_channel *,
619185377Ssam		HAL_OPMODE, int);
620211206Sadrian
621211206Sadrianextern	HAL_BOOL ar5212IsNFCalInProgress(struct ath_hal *ah);
622211206Sadrianextern	HAL_BOOL ar5212WaitNFCalComplete(struct ath_hal *ah, int i);
623222584Sadrianextern	void ar5212EnableDfs(struct ath_hal *ah, HAL_PHYERR_PARAM *pe);
624222584Sadrianextern	void ar5212GetDfsThresh(struct ath_hal *ah, HAL_PHYERR_PARAM *pe);
625222815Sadrianextern	HAL_BOOL ar5212ProcessRadarEvent(struct ath_hal *ah,
626222815Sadrian	    struct ath_rx_status *rxs, uint64_t fulltsf, const char *buf,
627222815Sadrian	    HAL_DFS_EVENT *event);
628224709Sadrianextern	HAL_BOOL ar5212IsFastClockEnabled(struct ath_hal *ah);
629211206Sadrian
630185377Ssam#endif	/* _ATH_AR5212_H_ */
631