ar5210_attach.c revision 217621 
1/*
2 * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
3 * Copyright (c) 2002-2004 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: head/sys/dev/ath/ath_hal/ar5210/ar5210_attach.c 217621 2011-01-20 05:49:15Z adrian $
18 */
19#include "opt_ah.h"
20
21#include "ah.h"
22#include "ah_internal.h"
23#include "ah_devid.h"
24
25#include "ar5210/ar5210.h"
26#include "ar5210/ar5210reg.h"
27#include "ar5210/ar5210phy.h"
28
29#include "ah_eeprom_v1.h"
30
31static	HAL_BOOL ar5210GetChannelEdges(struct ath_hal *,
32		uint16_t flags, uint16_t *low, uint16_t *high);
33static	HAL_BOOL ar5210GetChipPowerLimits(struct ath_hal *ah,
34		struct ieee80211_channel *chan);
35
36static void ar5210ConfigPCIE(struct ath_hal *ah, HAL_BOOL restore);
37static void ar5210DisablePCIE(struct ath_hal *ah);
38
39static const struct ath_hal_private ar5210hal = {{
40	.ah_magic			= AR5210_MAGIC,
41
42	.ah_getRateTable		= ar5210GetRateTable,
43	.ah_detach			= ar5210Detach,
44
45	/* Reset Functions */
46	.ah_reset			= ar5210Reset,
47	.ah_phyDisable			= ar5210PhyDisable,
48	.ah_disable			= ar5210Disable,
49	.ah_configPCIE			= ar5210ConfigPCIE,
50	.ah_disablePCIE			= ar5210DisablePCIE,
51	.ah_setPCUConfig		= ar5210SetPCUConfig,
52	.ah_perCalibration		= ar5210PerCalibration,
53	.ah_perCalibrationN		= ar5210PerCalibrationN,
54	.ah_resetCalValid		= ar5210ResetCalValid,
55	.ah_setTxPowerLimit		= ar5210SetTxPowerLimit,
56	.ah_getChanNoise		= ath_hal_getChanNoise,
57
58	/* Transmit functions */
59	.ah_updateTxTrigLevel		= ar5210UpdateTxTrigLevel,
60	.ah_setupTxQueue		= ar5210SetupTxQueue,
61	.ah_setTxQueueProps             = ar5210SetTxQueueProps,
62	.ah_getTxQueueProps             = ar5210GetTxQueueProps,
63	.ah_releaseTxQueue		= ar5210ReleaseTxQueue,
64	.ah_resetTxQueue		= ar5210ResetTxQueue,
65	.ah_getTxDP			= ar5210GetTxDP,
66	.ah_setTxDP			= ar5210SetTxDP,
67	.ah_numTxPending		= ar5210NumTxPending,
68	.ah_startTxDma			= ar5210StartTxDma,
69	.ah_stopTxDma			= ar5210StopTxDma,
70	.ah_setupTxDesc			= ar5210SetupTxDesc,
71	.ah_setupXTxDesc		= ar5210SetupXTxDesc,
72	.ah_fillTxDesc			= ar5210FillTxDesc,
73	.ah_procTxDesc			= ar5210ProcTxDesc,
74	.ah_getTxIntrQueue		= ar5210GetTxIntrQueue,
75	.ah_reqTxIntrDesc 		= ar5210IntrReqTxDesc,
76	.ah_getTxCompletionRates	= ar5210GetTxCompletionRates,
77
78	/* RX Functions */
79	.ah_getRxDP			= ar5210GetRxDP,
80	.ah_setRxDP			= ar5210SetRxDP,
81	.ah_enableReceive		= ar5210EnableReceive,
82	.ah_stopDmaReceive		= ar5210StopDmaReceive,
83	.ah_startPcuReceive		= ar5210StartPcuReceive,
84	.ah_stopPcuReceive		= ar5210StopPcuReceive,
85	.ah_setMulticastFilter		= ar5210SetMulticastFilter,
86	.ah_setMulticastFilterIndex	= ar5210SetMulticastFilterIndex,
87	.ah_clrMulticastFilterIndex	= ar5210ClrMulticastFilterIndex,
88	.ah_getRxFilter			= ar5210GetRxFilter,
89	.ah_setRxFilter			= ar5210SetRxFilter,
90	.ah_setupRxDesc			= ar5210SetupRxDesc,
91	.ah_procRxDesc			= ar5210ProcRxDesc,
92	.ah_rxMonitor			= ar5210AniPoll,
93	.ah_procMibEvent		= ar5210MibEvent,
94
95	/* Misc Functions */
96	.ah_getCapability		= ar5210GetCapability,
97	.ah_setCapability		= ar5210SetCapability,
98	.ah_getDiagState		= ar5210GetDiagState,
99	.ah_getMacAddress		= ar5210GetMacAddress,
100	.ah_setMacAddress		= ar5210SetMacAddress,
101	.ah_getBssIdMask		= ar5210GetBssIdMask,
102	.ah_setBssIdMask		= ar5210SetBssIdMask,
103	.ah_setRegulatoryDomain		= ar5210SetRegulatoryDomain,
104	.ah_setLedState			= ar5210SetLedState,
105	.ah_writeAssocid		= ar5210WriteAssocid,
106	.ah_gpioCfgInput		= ar5210GpioCfgInput,
107	.ah_gpioCfgOutput		= ar5210GpioCfgOutput,
108	.ah_gpioGet			= ar5210GpioGet,
109	.ah_gpioSet			= ar5210GpioSet,
110	.ah_gpioSetIntr			= ar5210Gpio0SetIntr,
111	.ah_getTsf32			= ar5210GetTsf32,
112	.ah_getTsf64			= ar5210GetTsf64,
113	.ah_resetTsf			= ar5210ResetTsf,
114	.ah_detectCardPresent		= ar5210DetectCardPresent,
115	.ah_updateMibCounters		= ar5210UpdateMibCounters,
116	.ah_getRfGain			= ar5210GetRfgain,
117	.ah_getDefAntenna		= ar5210GetDefAntenna,
118	.ah_setDefAntenna		= ar5210SetDefAntenna,
119	.ah_getAntennaSwitch		= ar5210GetAntennaSwitch,
120	.ah_setAntennaSwitch		= ar5210SetAntennaSwitch,
121	.ah_setSifsTime			= ar5210SetSifsTime,
122	.ah_getSifsTime			= ar5210GetSifsTime,
123	.ah_setSlotTime			= ar5210SetSlotTime,
124	.ah_getSlotTime			= ar5210GetSlotTime,
125	.ah_setAckTimeout		= ar5210SetAckTimeout,
126	.ah_getAckTimeout		= ar5210GetAckTimeout,
127	.ah_setAckCTSRate		= ar5210SetAckCTSRate,
128	.ah_getAckCTSRate		= ar5210GetAckCTSRate,
129	.ah_setCTSTimeout		= ar5210SetCTSTimeout,
130	.ah_getCTSTimeout		= ar5210GetCTSTimeout,
131	.ah_setDecompMask               = ar5210SetDecompMask,
132	.ah_setCoverageClass            = ar5210SetCoverageClass,
133
134	/* Key Cache Functions */
135	.ah_getKeyCacheSize		= ar5210GetKeyCacheSize,
136	.ah_resetKeyCacheEntry		= ar5210ResetKeyCacheEntry,
137	.ah_isKeyCacheEntryValid	= ar5210IsKeyCacheEntryValid,
138	.ah_setKeyCacheEntry		= ar5210SetKeyCacheEntry,
139	.ah_setKeyCacheEntryMac		= ar5210SetKeyCacheEntryMac,
140
141	/* Power Management Functions */
142	.ah_setPowerMode		= ar5210SetPowerMode,
143	.ah_getPowerMode		= ar5210GetPowerMode,
144
145	/* Beacon Functions */
146	.ah_setBeaconTimers		= ar5210SetBeaconTimers,
147	.ah_beaconInit			= ar5210BeaconInit,
148	.ah_setStationBeaconTimers	= ar5210SetStaBeaconTimers,
149	.ah_resetStationBeaconTimers	= ar5210ResetStaBeaconTimers,
150
151	/* Interrupt Functions */
152	.ah_isInterruptPending		= ar5210IsInterruptPending,
153	.ah_getPendingInterrupts	= ar5210GetPendingInterrupts,
154	.ah_getInterrupts		= ar5210GetInterrupts,
155	.ah_setInterrupts		= ar5210SetInterrupts },
156
157	.ah_getChannelEdges		= ar5210GetChannelEdges,
158	.ah_getWirelessModes		= ar5210GetWirelessModes,
159	.ah_eepromRead			= ar5210EepromRead,
160#ifdef AH_SUPPORT_WRITE_EEPROM
161	.ah_eepromWrite			= ar5210EepromWrite,
162#endif
163	.ah_getChipPowerLimits		= ar5210GetChipPowerLimits,
164};
165
166static HAL_BOOL ar5210FillCapabilityInfo(struct ath_hal *ah);
167
168/*
169 * Attach for an AR5210 part.
170 */
171static struct ath_hal *
172ar5210Attach(uint16_t devid, HAL_SOFTC sc, HAL_BUS_TAG st, HAL_BUS_HANDLE sh,
173	HAL_STATUS *status)
174{
175#define	N(a)	(sizeof(a)/sizeof(a[0]))
176	struct ath_hal_5210 *ahp;
177	struct ath_hal *ah;
178	uint32_t revid, pcicfg;
179	uint16_t eeval;
180	HAL_STATUS ecode;
181	int i;
182
183	HALDEBUG(AH_NULL, HAL_DEBUG_ATTACH,
184	    "%s: devid 0x%x sc %p st %p sh %p\n", __func__, devid,
185	    sc, (void*) st, (void*) sh);
186
187	/* NB: memory is returned zero'd */
188	ahp = ath_hal_malloc(sizeof (struct ath_hal_5210));
189	if (ahp == AH_NULL) {
190		HALDEBUG(AH_NULL, HAL_DEBUG_ANY,
191		    "%s: no memory for state block\n", __func__);
192		ecode = HAL_ENOMEM;
193		goto bad;
194	}
195	ah = &ahp->ah_priv.h;
196	/* set initial values */
197	OS_MEMCPY(&ahp->ah_priv, &ar5210hal, sizeof(struct ath_hal_private));
198	ah->ah_sc = sc;
199	ah->ah_st = st;
200	ah->ah_sh = sh;
201
202	ah->ah_devid = devid;			/* NB: for AH_DEBUG_ALQ */
203	AH_PRIVATE(ah)->ah_devid = devid;
204	AH_PRIVATE(ah)->ah_subvendorid = 0;	/* XXX */
205
206	AH_PRIVATE(ah)->ah_powerLimit = AR5210_MAX_RATE_POWER;
207	AH_PRIVATE(ah)->ah_tpScale = HAL_TP_SCALE_MAX;	/* no scaling */
208
209	ahp->ah_powerMode = HAL_PM_UNDEFINED;
210	ahp->ah_staId1Defaults = 0;
211	ahp->ah_rssiThr = INIT_RSSI_THR;
212	ahp->ah_sifstime = (u_int) -1;
213	ahp->ah_slottime = (u_int) -1;
214	ahp->ah_acktimeout = (u_int) -1;
215	ahp->ah_ctstimeout = (u_int) -1;
216
217	if (!ar5210ChipReset(ah, AH_NULL)) {	/* reset chip */
218		HALDEBUG(ah, HAL_DEBUG_ANY, "%s: chip reset failed\n",
219		    __func__);
220		ecode = HAL_EIO;
221		goto bad;
222	}
223
224	/* Read Revisions from Chips */
225	AH_PRIVATE(ah)->ah_macVersion = 1;
226	AH_PRIVATE(ah)->ah_macRev = OS_REG_READ(ah, AR_SREV) & 0xff;
227	AH_PRIVATE(ah)->ah_phyRev = OS_REG_READ(ah, AR_PHY_CHIPID);
228	AH_PRIVATE(ah)->ah_analog2GhzRev = 0;
229
230	/* Read Radio Chip Rev Extract */
231	OS_REG_WRITE(ah, (AR_PHY_BASE + (0x34 << 2)), 0x00001c16);
232	for (i = 0; i < 4; i++)
233		OS_REG_WRITE(ah, (AR_PHY_BASE + (0x20 << 2)), 0x00010000);
234	revid = (OS_REG_READ(ah, AR_PHY_BASE + (256 << 2)) >> 28) & 0xf;
235
236	/* Chip labelling is 1 greater than revision register for AR5110 */
237	AH_PRIVATE(ah)->ah_analog5GhzRev = ath_hal_reverseBits(revid, 4) + 1;
238
239	/*
240	 * Read all the settings from the EEPROM and stash
241	 * ones we'll use later.
242	 */
243	pcicfg = OS_REG_READ(ah, AR_PCICFG);
244	OS_REG_WRITE(ah, AR_PCICFG, pcicfg | AR_PCICFG_EEPROMSEL);
245	ecode = ath_hal_v1EepromAttach(ah);
246	if (ecode != HAL_OK) {
247		goto eebad;
248	}
249	ecode = ath_hal_eepromGet(ah, AR_EEP_REGDMN_0, &eeval);
250	if (ecode != HAL_OK) {
251		HALDEBUG(ah, HAL_DEBUG_ANY,
252		    "%s: cannot read regulatory domain from EEPROM\n",
253		    __func__);
254		goto eebad;
255        }
256	AH_PRIVATE(ah)->ah_currentRD = eeval;
257	ecode = ath_hal_eepromGet(ah, AR_EEP_MACADDR, ahp->ah_macaddr);
258	if (ecode != HAL_OK) {
259		HALDEBUG(ah, HAL_DEBUG_ANY,
260		    "%s: error getting mac address from EEPROM\n", __func__);
261		goto eebad;
262        }
263	OS_REG_WRITE(ah, AR_PCICFG, pcicfg);	/* disable EEPROM access */
264
265	AH_PRIVATE(ah)->ah_getNfAdjust = ar5210GetNfAdjust;
266
267	/*
268	 * Got everything we need now to setup the capabilities.
269	 */
270	(void) ar5210FillCapabilityInfo(ah);
271
272	HALDEBUG(ah, HAL_DEBUG_ATTACH, "%s: return\n", __func__);
273
274	return ah;
275eebad:
276	OS_REG_WRITE(ah, AR_PCICFG, pcicfg);	/* disable EEPROM access */
277bad:
278	if (ahp)
279		ath_hal_free(ahp);
280	if (status)
281		*status = ecode;
282	return AH_NULL;
283#undef N
284}
285
286void
287ar5210Detach(struct ath_hal *ah)
288{
289	HALDEBUG(ah, HAL_DEBUG_ATTACH, "%s:\n", __func__);
290
291	HALASSERT(ah != AH_NULL);
292	HALASSERT(ah->ah_magic == AR5210_MAGIC);
293
294	ath_hal_eepromDetach(ah);
295	ath_hal_free(ah);
296}
297
298/*
299 * Store the channel edges for the requested operational mode
300 */
301static HAL_BOOL
302ar5210GetChannelEdges(struct ath_hal *ah,
303	uint16_t flags, uint16_t *low, uint16_t *high)
304{
305	if (flags & IEEE80211_CHAN_5GHZ) {
306		*low = 5120;
307		*high = 5430;
308		return AH_TRUE;
309	} else {
310		return AH_FALSE;
311	}
312}
313
314static HAL_BOOL
315ar5210GetChipPowerLimits(struct ath_hal *ah, struct ieee80211_channel *chan)
316{
317	/* XXX fill in, this is just a placeholder */
318	HALDEBUG(ah, HAL_DEBUG_ATTACH,
319	    "%s: no min/max power for %u/0x%x\n",
320	    __func__, chan->ic_freq, chan->ic_flags);
321	chan->ic_maxpower = AR5210_MAX_RATE_POWER;
322	chan->ic_minpower = 0;
323	return AH_TRUE;
324}
325
326static void
327ar5210ConfigPCIE(struct ath_hal *ah, HAL_BOOL restore)
328{
329}
330
331static void
332ar5210DisablePCIE(struct ath_hal *ah)
333{
334}
335
336/*
337 * Fill all software cached or static hardware state information.
338 */
339static HAL_BOOL
340ar5210FillCapabilityInfo(struct ath_hal *ah)
341{
342	struct ath_hal_private *ahpriv = AH_PRIVATE(ah);
343	HAL_CAPABILITIES *pCap = &ahpriv->ah_caps;
344
345	pCap->halWirelessModes |= HAL_MODE_11A;
346
347	pCap->halLow5GhzChan = 5120;
348	pCap->halHigh5GhzChan = 5430;
349
350	pCap->halSleepAfterBeaconBroken = AH_TRUE;
351	pCap->halPSPollBroken = AH_FALSE;
352
353	pCap->halTotalQueues = HAL_NUM_TX_QUEUES;
354	pCap->halKeyCacheSize = 64;
355
356	/* XXX not needed */
357	pCap->halChanHalfRate = AH_FALSE;
358	pCap->halChanQuarterRate = AH_FALSE;
359
360	if (ath_hal_eepromGetFlag(ah, AR_EEP_RFKILL)) {
361		/*
362		 * Setup initial rfsilent settings based on the EEPROM
363		 * contents.  Pin 0, polarity 0 is fixed; record this
364		 * using the EEPROM format found in later parts.
365		 */
366		ahpriv->ah_rfsilent = SM(0, AR_EEPROM_RFSILENT_GPIO_SEL)
367				    | SM(0, AR_EEPROM_RFSILENT_POLARITY);
368		ahpriv->ah_rfkillEnabled = AH_TRUE;
369		pCap->halRfSilentSupport = AH_TRUE;
370	}
371
372	pCap->halTstampPrecision = 15;		/* NB: s/w extended from 13 */
373	pCap->halIntrMask = (HAL_INT_COMMON - HAL_INT_BNR)
374			| HAL_INT_RX
375			| HAL_INT_TX
376			| HAL_INT_FATAL
377			;
378
379	ahpriv->ah_rxornIsFatal = AH_TRUE;
380	return AH_TRUE;
381}
382
383static const char*
384ar5210Probe(uint16_t vendorid, uint16_t devid)
385{
386	if (vendorid == ATHEROS_VENDOR_ID &&
387	    (devid == AR5210_PROD || devid == AR5210_DEFAULT))
388		return "Atheros 5210";
389	return AH_NULL;
390}
391AH_CHIP(AR5210, ar5210Probe, ar5210Attach);
392