xref: /freebsd/sys/dev/ath/ath_hal/ar5416/ar5416.h (revision eb6d21b4ca6d668cf89afd99eef7baeafa712197)
1 /*
2  * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
3  * Copyright (c) 2002-2008 Atheros Communications, Inc.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  *
17  * $FreeBSD$
18  */
19 #ifndef _ATH_AR5416_H_
20 #define _ATH_AR5416_H_
21 
22 #include "ar5212/ar5212.h"
23 #include "ar5416_cal.h"
24 
25 #define	AR5416_MAGIC	0x20065416
26 
27 enum {
28 	HAL_RESET_POWER_ON,
29 	HAL_RESET_WARM,
30 	HAL_RESET_COLD,
31 };
32 
33 typedef struct {
34 	uint16_t	synth_center;
35 	uint16_t	ctl_center;
36 	uint16_t	ext_center;
37 } CHAN_CENTERS;
38 
39 #define	AR5416_DEFAULT_RXCHAINMASK	7
40 #define	AR5416_DEFAULT_TXCHAINMASK	1
41 #define	AR5416_MAX_RATE_POWER		63
42 #define	AR5416_KEYTABLE_SIZE		128
43 
44 #define	AR5416_CCA_MAX_GOOD_VALUE	-85
45 #define	AR5416_CCA_MAX_HIGH_VALUE	-62
46 #define	AR5416_CCA_MIN_BAD_VALUE	-140
47 
48 #define AR5416_SPUR_RSSI_THRESH		40
49 
50 struct ath_hal_5416 {
51 	struct ath_hal_5212 ah_5212;
52 
53 	/* NB: RF data setup at attach */
54 	HAL_INI_ARRAY	ah_ini_bb_rfgain;
55 	HAL_INI_ARRAY	ah_ini_bank0;
56 	HAL_INI_ARRAY	ah_ini_bank1;
57 	HAL_INI_ARRAY	ah_ini_bank2;
58 	HAL_INI_ARRAY	ah_ini_bank3;
59 	HAL_INI_ARRAY	ah_ini_bank6;
60 	HAL_INI_ARRAY	ah_ini_bank7;
61 	HAL_INI_ARRAY	ah_ini_addac;
62 	HAL_INI_ARRAY	ah_ini_pcieserdes;
63 
64 	void		(*ah_writeIni)(struct ath_hal *,
65 			    const struct ieee80211_channel *);
66 	void		(*ah_spurMitigate)(struct ath_hal *,
67 			    const struct ieee80211_channel *);
68 
69 	u_int       	ah_globaltxtimeout;	/* global tx timeout */
70 	u_int		ah_gpioMask;
71 	int		ah_hangs;		/* h/w hangs state */
72 	uint8_t		ah_keytype[AR5416_KEYTABLE_SIZE];
73 	/*
74 	 * Extension Channel Rx Clear State
75 	 */
76 	uint32_t	ah_cycleCount;
77 	uint32_t	ah_ctlBusy;
78 	uint32_t	ah_extBusy;
79 	uint32_t	ah_rx_chainmask;
80 	uint32_t	ah_tx_chainmask;
81 
82 	struct ar5416PerCal ah_cal;		/* periodic calibration state */
83 };
84 #define	AH5416(_ah)	((struct ath_hal_5416 *)(_ah))
85 
86 #define IS_5416_PCI(ah) ((AH_PRIVATE(ah)->ah_macVersion) == AR_SREV_VERSION_OWL_PCI)
87 #define IS_5416_PCIE(ah) ((AH_PRIVATE(ah)->ah_macVersion) == AR_SREV_VERSION_OWL_PCIE)
88 #undef IS_PCIE
89 #define IS_PCIE(ah) (IS_5416_PCIE(ah))
90 
91 extern	HAL_BOOL ar2133RfAttach(struct ath_hal *, HAL_STATUS *);
92 
93 struct ath_hal;
94 
95 extern	uint32_t ar5416GetRadioRev(struct ath_hal *ah);
96 extern	void ar5416InitState(struct ath_hal_5416 *, uint16_t devid,
97 		HAL_SOFTC sc, HAL_BUS_TAG st, HAL_BUS_HANDLE sh,
98 		HAL_STATUS *status);
99 extern	void ar5416Detach(struct ath_hal *ah);
100 extern	void ar5416AttachPCIE(struct ath_hal *ah);
101 extern	HAL_BOOL ar5416FillCapabilityInfo(struct ath_hal *ah);
102 
103 #define	IS_5GHZ_FAST_CLOCK_EN(_ah, _c) \
104 	(IEEE80211_IS_CHAN_5GHZ(_c) && \
105 	 ath_hal_eepromGetFlag(ah, AR_EEP_FSTCLK_5G))
106 
107 extern	void ar5416AniAttach(struct ath_hal *, const struct ar5212AniParams *,
108 		const struct ar5212AniParams *, HAL_BOOL ena);
109 extern	void ar5416AniDetach(struct ath_hal *);
110 extern	HAL_BOOL ar5416AniControl(struct ath_hal *, HAL_ANI_CMD cmd, int param);
111 extern	HAL_BOOL ar5416AniSetParams(struct ath_hal *,
112 		const struct ar5212AniParams *, const struct ar5212AniParams *);
113 extern	void ar5416ProcessMibIntr(struct ath_hal *, const HAL_NODE_STATS *);
114 extern	void ar5416AniPoll(struct ath_hal *, const HAL_NODE_STATS *,
115 			     const struct ieee80211_channel *);
116 extern	void ar5416AniReset(struct ath_hal *, const struct ieee80211_channel *,
117 		HAL_OPMODE, int);
118 
119 extern	void ar5416SetBeaconTimers(struct ath_hal *, const HAL_BEACON_TIMERS *);
120 extern	void ar5416BeaconInit(struct ath_hal *ah,
121 		uint32_t next_beacon, uint32_t beacon_period);
122 extern	void ar5416ResetStaBeaconTimers(struct ath_hal *ah);
123 extern	void ar5416SetStaBeaconTimers(struct ath_hal *ah,
124 		const HAL_BEACON_STATE *);
125 
126 extern	HAL_BOOL ar5416EepromRead(struct ath_hal *, u_int off, uint16_t *data);
127 extern	HAL_BOOL ar5416EepromWrite(struct ath_hal *, u_int off, uint16_t data);
128 
129 extern	HAL_BOOL ar5416IsInterruptPending(struct ath_hal *ah);
130 extern	HAL_BOOL ar5416GetPendingInterrupts(struct ath_hal *, HAL_INT *masked);
131 extern	HAL_INT ar5416SetInterrupts(struct ath_hal *ah, HAL_INT ints);
132 
133 extern	HAL_BOOL ar5416GpioCfgOutput(struct ath_hal *, uint32_t gpio,
134 		HAL_GPIO_MUX_TYPE);
135 extern	HAL_BOOL ar5416GpioCfgInput(struct ath_hal *, uint32_t gpio);
136 extern	HAL_BOOL ar5416GpioSet(struct ath_hal *, uint32_t gpio, uint32_t val);
137 extern	uint32_t ar5416GpioGet(struct ath_hal *ah, uint32_t gpio);
138 extern	void ar5416GpioSetIntr(struct ath_hal *ah, u_int, uint32_t ilevel);
139 
140 extern	u_int ar5416GetWirelessModes(struct ath_hal *ah);
141 extern	void ar5416SetLedState(struct ath_hal *ah, HAL_LED_STATE state);
142 extern	void ar5416ResetTsf(struct ath_hal *ah);
143 extern	HAL_BOOL ar5416SetAntennaSwitch(struct ath_hal *, HAL_ANT_SETTING);
144 extern	HAL_BOOL ar5416SetDecompMask(struct ath_hal *, uint16_t, int);
145 extern	void ar5416SetCoverageClass(struct ath_hal *, uint8_t, int);
146 extern	uint32_t ar5416Get11nExtBusy(struct ath_hal *ah);
147 extern	void ar5416Set11nMac2040(struct ath_hal *ah, HAL_HT_MACMODE mode);
148 extern	HAL_HT_RXCLEAR ar5416Get11nRxClear(struct ath_hal *ah);
149 extern	void ar5416Set11nRxClear(struct ath_hal *ah, HAL_HT_RXCLEAR rxclear);
150 extern	HAL_STATUS ar5416GetCapability(struct ath_hal *ah,
151 	    HAL_CAPABILITY_TYPE type, uint32_t capability, uint32_t *result);
152 extern	HAL_BOOL ar5416GetDiagState(struct ath_hal *ah, int request,
153 	    const void *args, uint32_t argsize,
154 	    void **result, uint32_t *resultsize);
155 
156 extern	HAL_BOOL ar5416SetPowerMode(struct ath_hal *ah, HAL_POWER_MODE mode,
157 		int setChip);
158 extern	HAL_POWER_MODE ar5416GetPowerMode(struct ath_hal *ah);
159 extern	HAL_BOOL ar5416GetPowerStatus(struct ath_hal *ah);
160 
161 extern	HAL_BOOL ar5416ResetKeyCacheEntry(struct ath_hal *ah, uint16_t entry);
162 extern	HAL_BOOL ar5416SetKeyCacheEntry(struct ath_hal *ah, uint16_t entry,
163 	       const HAL_KEYVAL *k, const uint8_t *mac, int xorKey);
164 
165 extern	void ar5416StartPcuReceive(struct ath_hal *ah);
166 extern	void ar5416StopPcuReceive(struct ath_hal *ah);
167 extern	HAL_BOOL ar5416SetupRxDesc(struct ath_hal *,
168 		struct ath_desc *, uint32_t size, u_int flags);
169 extern	HAL_STATUS ar5416ProcRxDesc(struct ath_hal *ah, struct ath_desc *,
170 		uint32_t, struct ath_desc *, uint64_t,
171 		struct ath_rx_status *);
172 
173 extern	HAL_BOOL ar5416Reset(struct ath_hal *ah, HAL_OPMODE opmode,
174 		struct ieee80211_channel *chan,
175 		HAL_BOOL bChannelChange, HAL_STATUS *status);
176 extern	HAL_BOOL ar5416PhyDisable(struct ath_hal *ah);
177 extern	HAL_RFGAIN ar5416GetRfgain(struct ath_hal *ah);
178 extern	HAL_BOOL ar5416Disable(struct ath_hal *ah);
179 extern	HAL_BOOL ar5416ChipReset(struct ath_hal *ah,
180 		const struct ieee80211_channel *);
181 extern	HAL_BOOL ar5416SetResetReg(struct ath_hal *, uint32_t type);
182 extern	HAL_BOOL ar5416SetTxPowerLimit(struct ath_hal *ah, uint32_t limit);
183 extern	HAL_BOOL ar5416GetChipPowerLimits(struct ath_hal *ah,
184 		struct ieee80211_channel *chan);
185 extern	void ar5416GetChannelCenters(struct ath_hal *,
186 		const struct ieee80211_channel *chan, CHAN_CENTERS *centers);
187 
188 extern	HAL_BOOL ar5416StopTxDma(struct ath_hal *ah, u_int q);
189 extern	HAL_BOOL ar5416SetupTxDesc(struct ath_hal *ah, struct ath_desc *ds,
190 		u_int pktLen, u_int hdrLen, HAL_PKT_TYPE type, u_int txPower,
191 		u_int txRate0, u_int txTries0,
192 		u_int keyIx, u_int antMode, u_int flags,
193 		u_int rtsctsRate, u_int rtsctsDuration,
194 		u_int compicvLen, u_int compivLen, u_int comp);
195 extern	HAL_BOOL ar5416SetupXTxDesc(struct ath_hal *, struct ath_desc *,
196 		u_int txRate1, u_int txRetries1,
197 		u_int txRate2, u_int txRetries2,
198 		u_int txRate3, u_int txRetries3);
199 extern	HAL_BOOL ar5416FillTxDesc(struct ath_hal *ah, struct ath_desc *ds,
200 		u_int segLen, HAL_BOOL firstSeg, HAL_BOOL lastSeg,
201 		const struct ath_desc *ds0);
202 extern	HAL_STATUS ar5416ProcTxDesc(struct ath_hal *ah,
203 		struct ath_desc *, struct ath_tx_status *);
204 
205 extern	const HAL_RATE_TABLE *ar5416GetRateTable(struct ath_hal *, u_int mode);
206 #endif	/* _ATH_AR5416_H_ */
207