xref: /freebsd/sys/dev/ath/ath_hal/ar5416/ar5416.h (revision 39beb93c3f8bdbf72a61fda42300b5ebed7390c8)
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 struct ath_hal_5416 {
49 	struct ath_hal_5212 ah_5212;
50 
51 	/* NB: RF data setup at attach */
52 	HAL_INI_ARRAY	ah_ini_bb_rfgain;
53 	HAL_INI_ARRAY	ah_ini_bank0;
54 	HAL_INI_ARRAY	ah_ini_bank1;
55 	HAL_INI_ARRAY	ah_ini_bank2;
56 	HAL_INI_ARRAY	ah_ini_bank3;
57 	HAL_INI_ARRAY	ah_ini_bank6;
58 	HAL_INI_ARRAY	ah_ini_bank7;
59 	HAL_INI_ARRAY	ah_ini_addac;
60 	HAL_INI_ARRAY	ah_ini_pcieserdes;
61 
62 	u_int       	ah_globaltxtimeout;	/* global tx timeout */
63 	u_int		ah_gpioMask;
64 	int		ah_hangs;		/* h/w hangs state */
65 	uint8_t		ah_keytype[AR5416_KEYTABLE_SIZE];
66 	/*
67 	 * Extension Channel Rx Clear State
68 	 */
69 	uint32_t	ah_cycleCount;
70 	uint32_t	ah_ctlBusy;
71 	uint32_t	ah_extBusy;
72 	uint32_t	ah_rx_chainmask;
73 	uint32_t	ah_tx_chainmask;
74 
75 	struct ar5416PerCal ah_cal;		/* periodic calibration state */
76 };
77 #define	AH5416(_ah)	((struct ath_hal_5416 *)(_ah))
78 
79 #define IS_5416_PCI(ah) ((AH_PRIVATE(ah)->ah_macVersion) == AR_SREV_VERSION_OWL_PCI)
80 #define IS_5416_PCIE(ah) ((AH_PRIVATE(ah)->ah_macVersion) == AR_SREV_VERSION_OWL_PCIE)
81 #undef IS_PCIE
82 #define IS_PCIE(ah) (IS_5416_PCIE(ah))
83 
84 extern	HAL_BOOL ar2133RfAttach(struct ath_hal *, HAL_STATUS *);
85 
86 struct ath_hal;
87 
88 extern	uint32_t ar5416GetRadioRev(struct ath_hal *ah);
89 extern	void ar5416InitState(struct ath_hal_5416 *, uint16_t devid,
90 		HAL_SOFTC sc, HAL_BUS_TAG st, HAL_BUS_HANDLE sh,
91 		HAL_STATUS *status);
92 extern	void ar5416Detach(struct ath_hal *ah);
93 extern	void ar5416AttachPCIE(struct ath_hal *ah);
94 extern	HAL_BOOL ar5416FillCapabilityInfo(struct ath_hal *ah);
95 
96 #define	IS_5GHZ_FAST_CLOCK_EN(_ah, _c) \
97 	(IEEE80211_IS_CHAN_5GHZ(_c) && \
98 	 ath_hal_eepromGetFlag(ah, AR_EEP_FSTCLK_5G))
99 
100 extern	void ar5416AniAttach(struct ath_hal *, const struct ar5212AniParams *,
101 		const struct ar5212AniParams *, HAL_BOOL ena);
102 extern	void ar5416AniDetach(struct ath_hal *);
103 extern	HAL_BOOL ar5416AniControl(struct ath_hal *, HAL_ANI_CMD cmd, int param);
104 extern	HAL_BOOL ar5416AniSetParams(struct ath_hal *,
105 		const struct ar5212AniParams *, const struct ar5212AniParams *);
106 extern	void ar5416ProcessMibIntr(struct ath_hal *, const HAL_NODE_STATS *);
107 extern	void ar5416AniPoll(struct ath_hal *, const HAL_NODE_STATS *,
108 			     const struct ieee80211_channel *);
109 extern	void ar5416AniReset(struct ath_hal *, const struct ieee80211_channel *,
110 		HAL_OPMODE, int);
111 
112 extern	void ar5416SetBeaconTimers(struct ath_hal *, const HAL_BEACON_TIMERS *);
113 extern	void ar5416BeaconInit(struct ath_hal *ah,
114 		uint32_t next_beacon, uint32_t beacon_period);
115 extern	void ar5416ResetStaBeaconTimers(struct ath_hal *ah);
116 extern	void ar5416SetStaBeaconTimers(struct ath_hal *ah,
117 		const HAL_BEACON_STATE *);
118 
119 extern	HAL_BOOL ar5416EepromRead(struct ath_hal *, u_int off, uint16_t *data);
120 extern	HAL_BOOL ar5416EepromWrite(struct ath_hal *, u_int off, uint16_t data);
121 
122 extern	HAL_BOOL ar5416IsInterruptPending(struct ath_hal *ah);
123 extern	HAL_BOOL ar5416GetPendingInterrupts(struct ath_hal *, HAL_INT *masked);
124 extern	HAL_INT ar5416SetInterrupts(struct ath_hal *ah, HAL_INT ints);
125 
126 extern	HAL_BOOL ar5416GpioCfgOutput(struct ath_hal *, uint32_t gpio,
127 		HAL_GPIO_MUX_TYPE);
128 extern	HAL_BOOL ar5416GpioCfgInput(struct ath_hal *, uint32_t gpio);
129 extern	HAL_BOOL ar5416GpioSet(struct ath_hal *, uint32_t gpio, uint32_t val);
130 extern	uint32_t ar5416GpioGet(struct ath_hal *ah, uint32_t gpio);
131 extern	void ar5416GpioSetIntr(struct ath_hal *ah, u_int, uint32_t ilevel);
132 
133 extern	u_int ar5416GetWirelessModes(struct ath_hal *ah);
134 extern	void ar5416SetLedState(struct ath_hal *ah, HAL_LED_STATE state);
135 extern	void ar5416ResetTsf(struct ath_hal *ah);
136 extern	HAL_BOOL ar5416SetAntennaSwitch(struct ath_hal *, HAL_ANT_SETTING);
137 extern	HAL_BOOL ar5416SetDecompMask(struct ath_hal *, uint16_t, int);
138 extern	void ar5416SetCoverageClass(struct ath_hal *, uint8_t, int);
139 extern	uint32_t ar5416Get11nExtBusy(struct ath_hal *ah);
140 extern	void ar5416Set11nMac2040(struct ath_hal *ah, HAL_HT_MACMODE mode);
141 extern	HAL_HT_RXCLEAR ar5416Get11nRxClear(struct ath_hal *ah);
142 extern	void ar5416Set11nRxClear(struct ath_hal *ah, HAL_HT_RXCLEAR rxclear);
143 extern	HAL_STATUS ar5416GetCapability(struct ath_hal *ah,
144 	    HAL_CAPABILITY_TYPE type, uint32_t capability, uint32_t *result);
145 extern	HAL_BOOL ar5416GetDiagState(struct ath_hal *ah, int request,
146 	    const void *args, uint32_t argsize,
147 	    void **result, uint32_t *resultsize);
148 
149 extern	HAL_BOOL ar5416SetPowerMode(struct ath_hal *ah, HAL_POWER_MODE mode,
150 		int setChip);
151 extern	HAL_POWER_MODE ar5416GetPowerMode(struct ath_hal *ah);
152 extern	HAL_BOOL ar5416GetPowerStatus(struct ath_hal *ah);
153 
154 extern	HAL_BOOL ar5416ResetKeyCacheEntry(struct ath_hal *ah, uint16_t entry);
155 extern	HAL_BOOL ar5416SetKeyCacheEntry(struct ath_hal *ah, uint16_t entry,
156 	       const HAL_KEYVAL *k, const uint8_t *mac, int xorKey);
157 
158 extern	void ar5416StartPcuReceive(struct ath_hal *ah);
159 extern	void ar5416StopPcuReceive(struct ath_hal *ah);
160 extern	HAL_BOOL ar5416SetupRxDesc(struct ath_hal *,
161 		struct ath_desc *, uint32_t size, u_int flags);
162 extern	HAL_STATUS ar5416ProcRxDesc(struct ath_hal *ah, struct ath_desc *,
163 		uint32_t, struct ath_desc *, uint64_t,
164 		struct ath_rx_status *);
165 
166 extern	HAL_BOOL ar5416Reset(struct ath_hal *ah, HAL_OPMODE opmode,
167 		struct ieee80211_channel *chan,
168 		HAL_BOOL bChannelChange, HAL_STATUS *status);
169 extern	HAL_BOOL ar5416PhyDisable(struct ath_hal *ah);
170 extern	HAL_RFGAIN ar5416GetRfgain(struct ath_hal *ah);
171 extern	HAL_BOOL ar5416Disable(struct ath_hal *ah);
172 extern	HAL_BOOL ar5416ChipReset(struct ath_hal *ah,
173 		const struct ieee80211_channel *);
174 extern	HAL_BOOL ar5416SetResetReg(struct ath_hal *, uint32_t type);
175 extern	HAL_BOOL ar5416SetTxPowerLimit(struct ath_hal *ah, uint32_t limit);
176 extern	HAL_BOOL ar5416GetChipPowerLimits(struct ath_hal *ah,
177 		struct ieee80211_channel *chan);
178 extern	void ar5416GetChannelCenters(struct ath_hal *,
179 		const struct ieee80211_channel *chan, CHAN_CENTERS *centers);
180 
181 extern	HAL_BOOL ar5416StopTxDma(struct ath_hal *ah, u_int q);
182 extern	HAL_BOOL ar5416SetupTxDesc(struct ath_hal *ah, struct ath_desc *ds,
183 		u_int pktLen, u_int hdrLen, HAL_PKT_TYPE type, u_int txPower,
184 		u_int txRate0, u_int txTries0,
185 		u_int keyIx, u_int antMode, u_int flags,
186 		u_int rtsctsRate, u_int rtsctsDuration,
187 		u_int compicvLen, u_int compivLen, u_int comp);
188 extern	HAL_BOOL ar5416SetupXTxDesc(struct ath_hal *, struct ath_desc *,
189 		u_int txRate1, u_int txRetries1,
190 		u_int txRate2, u_int txRetries2,
191 		u_int txRate3, u_int txRetries3);
192 extern	HAL_BOOL ar5416FillTxDesc(struct ath_hal *ah, struct ath_desc *ds,
193 		u_int segLen, HAL_BOOL firstSeg, HAL_BOOL lastSeg,
194 		const struct ath_desc *ds0);
195 extern	HAL_STATUS ar5416ProcTxDesc(struct ath_hal *ah,
196 		struct ath_desc *, struct ath_tx_status *);
197 
198 extern	const HAL_RATE_TABLE *ar5416GetRateTable(struct ath_hal *, u_int mode);
199 #endif	/* _ATH_AR5416_H_ */
200