2 * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
3 * Copyright (c) 2002-2006 Atheros Communications, Inc.
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.
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.
17 * $FreeBSD: head/sys/dev/ath/ath_hal/ar5211/ar5211_attach.c 192396 2009-05-19 17:30:13Z sam $
22 #include "ah_internal.h"
25 #include "ar5211/ar5211.h"
26 #include "ar5211/ar5211reg.h"
27 #include "ar5211/ar5211phy.h"
29 #include "ah_eeprom_v3.h"
31 static HAL_BOOL ar5211GetChannelEdges(struct ath_hal *ah,
32 uint16_t flags, uint16_t *low, uint16_t *high);
33 static HAL_BOOL ar5211GetChipPowerLimits(struct ath_hal *ah,
34 struct ieee80211_channel *chan);
36 static void ar5211ConfigPCIE(struct ath_hal *ah, HAL_BOOL restore);
37 static void ar5211DisablePCIE(struct ath_hal *ah);
39 static const struct ath_hal_private ar5211hal = {{
40 .ah_magic = AR5211_MAGIC,
42 .ah_getRateTable = ar5211GetRateTable,
43 .ah_detach = ar5211Detach,
46 .ah_reset = ar5211Reset,
47 .ah_phyDisable = ar5211PhyDisable,
48 .ah_disable = ar5211Disable,
49 .ah_configPCIE = ar5211ConfigPCIE,
50 .ah_disablePCIE = ar5211DisablePCIE,
51 .ah_setPCUConfig = ar5211SetPCUConfig,
52 .ah_perCalibration = ar5211PerCalibration,
53 .ah_perCalibrationN = ar5211PerCalibrationN,
54 .ah_resetCalValid = ar5211ResetCalValid,
55 .ah_setTxPowerLimit = ar5211SetTxPowerLimit,
56 .ah_getChanNoise = ath_hal_getChanNoise,
58 /* Transmit functions */
59 .ah_updateTxTrigLevel = ar5211UpdateTxTrigLevel,
60 .ah_setupTxQueue = ar5211SetupTxQueue,
61 .ah_setTxQueueProps = ar5211SetTxQueueProps,
62 .ah_getTxQueueProps = ar5211GetTxQueueProps,
63 .ah_releaseTxQueue = ar5211ReleaseTxQueue,
64 .ah_resetTxQueue = ar5211ResetTxQueue,
65 .ah_getTxDP = ar5211GetTxDP,
66 .ah_setTxDP = ar5211SetTxDP,
67 .ah_numTxPending = ar5211NumTxPending,
68 .ah_startTxDma = ar5211StartTxDma,
69 .ah_stopTxDma = ar5211StopTxDma,
70 .ah_setupTxDesc = ar5211SetupTxDesc,
71 .ah_setupXTxDesc = ar5211SetupXTxDesc,
72 .ah_fillTxDesc = ar5211FillTxDesc,
73 .ah_procTxDesc = ar5211ProcTxDesc,
74 .ah_getTxIntrQueue = ar5211GetTxIntrQueue,
75 .ah_reqTxIntrDesc = ar5211IntrReqTxDesc,
78 .ah_getRxDP = ar5211GetRxDP,
79 .ah_setRxDP = ar5211SetRxDP,
80 .ah_enableReceive = ar5211EnableReceive,
81 .ah_stopDmaReceive = ar5211StopDmaReceive,
82 .ah_startPcuReceive = ar5211StartPcuReceive,
83 .ah_stopPcuReceive = ar5211StopPcuReceive,
84 .ah_setMulticastFilter = ar5211SetMulticastFilter,
85 .ah_setMulticastFilterIndex = ar5211SetMulticastFilterIndex,
86 .ah_clrMulticastFilterIndex = ar5211ClrMulticastFilterIndex,
87 .ah_getRxFilter = ar5211GetRxFilter,
88 .ah_setRxFilter = ar5211SetRxFilter,
89 .ah_setupRxDesc = ar5211SetupRxDesc,
90 .ah_procRxDesc = ar5211ProcRxDesc,
91 .ah_rxMonitor = ar5211AniPoll,
92 .ah_procMibEvent = ar5211MibEvent,
95 .ah_getCapability = ar5211GetCapability,
96 .ah_setCapability = ar5211SetCapability,
97 .ah_getDiagState = ar5211GetDiagState,
98 .ah_getMacAddress = ar5211GetMacAddress,
99 .ah_setMacAddress = ar5211SetMacAddress,
100 .ah_getBssIdMask = ar5211GetBssIdMask,
101 .ah_setBssIdMask = ar5211SetBssIdMask,
102 .ah_setRegulatoryDomain = ar5211SetRegulatoryDomain,
103 .ah_setLedState = ar5211SetLedState,
104 .ah_writeAssocid = ar5211WriteAssocid,
105 .ah_gpioCfgInput = ar5211GpioCfgInput,
106 .ah_gpioCfgOutput = ar5211GpioCfgOutput,
107 .ah_gpioGet = ar5211GpioGet,
108 .ah_gpioSet = ar5211GpioSet,
109 .ah_gpioSetIntr = ar5211GpioSetIntr,
110 .ah_getTsf32 = ar5211GetTsf32,
111 .ah_getTsf64 = ar5211GetTsf64,
112 .ah_resetTsf = ar5211ResetTsf,
113 .ah_detectCardPresent = ar5211DetectCardPresent,
114 .ah_updateMibCounters = ar5211UpdateMibCounters,
115 .ah_getRfGain = ar5211GetRfgain,
116 .ah_getDefAntenna = ar5211GetDefAntenna,
117 .ah_setDefAntenna = ar5211SetDefAntenna,
118 .ah_getAntennaSwitch = ar5211GetAntennaSwitch,
119 .ah_setAntennaSwitch = ar5211SetAntennaSwitch,
120 .ah_setSifsTime = ar5211SetSifsTime,
121 .ah_getSifsTime = ar5211GetSifsTime,
122 .ah_setSlotTime = ar5211SetSlotTime,
123 .ah_getSlotTime = ar5211GetSlotTime,
124 .ah_setAckTimeout = ar5211SetAckTimeout,
125 .ah_getAckTimeout = ar5211GetAckTimeout,
126 .ah_setAckCTSRate = ar5211SetAckCTSRate,
127 .ah_getAckCTSRate = ar5211GetAckCTSRate,
128 .ah_setCTSTimeout = ar5211SetCTSTimeout,
129 .ah_getCTSTimeout = ar5211GetCTSTimeout,
130 .ah_setDecompMask = ar5211SetDecompMask,
131 .ah_setCoverageClass = ar5211SetCoverageClass,
133 /* Key Cache Functions */
134 .ah_getKeyCacheSize = ar5211GetKeyCacheSize,
135 .ah_resetKeyCacheEntry = ar5211ResetKeyCacheEntry,
136 .ah_isKeyCacheEntryValid = ar5211IsKeyCacheEntryValid,
137 .ah_setKeyCacheEntry = ar5211SetKeyCacheEntry,
138 .ah_setKeyCacheEntryMac = ar5211SetKeyCacheEntryMac,
140 /* Power Management Functions */
141 .ah_setPowerMode = ar5211SetPowerMode,
142 .ah_getPowerMode = ar5211GetPowerMode,
144 /* Beacon Functions */
145 .ah_setBeaconTimers = ar5211SetBeaconTimers,
146 .ah_beaconInit = ar5211BeaconInit,
147 .ah_setStationBeaconTimers = ar5211SetStaBeaconTimers,
148 .ah_resetStationBeaconTimers = ar5211ResetStaBeaconTimers,
150 /* Interrupt Functions */
151 .ah_isInterruptPending = ar5211IsInterruptPending,
152 .ah_getPendingInterrupts = ar5211GetPendingInterrupts,
153 .ah_getInterrupts = ar5211GetInterrupts,
154 .ah_setInterrupts = ar5211SetInterrupts },
156 .ah_getChannelEdges = ar5211GetChannelEdges,
157 .ah_getWirelessModes = ar5211GetWirelessModes,
158 .ah_eepromRead = ar5211EepromRead,
159 #ifdef AH_SUPPORT_WRITE_EEPROM
160 .ah_eepromWrite = ar5211EepromWrite,
162 .ah_getChipPowerLimits = ar5211GetChipPowerLimits,
165 static HAL_BOOL ar5211ChipTest(struct ath_hal *);
166 static HAL_BOOL ar5211FillCapabilityInfo(struct ath_hal *ah);
169 * Return the revsion id for the radio chip. This
170 * fetched via the PHY.
173 ar5211GetRadioRev(struct ath_hal *ah)
178 OS_REG_WRITE(ah, (AR_PHY_BASE + (0x34 << 2)), 0x00001c16);
179 for (i = 0; i < 8; i++)
180 OS_REG_WRITE(ah, (AR_PHY_BASE + (0x20 << 2)), 0x00010000);
181 val = (OS_REG_READ(ah, AR_PHY_BASE + (256 << 2)) >> 24) & 0xff;
182 val = ((val & 0xf0) >> 4) | ((val & 0x0f) << 4);
183 return ath_hal_reverseBits(val, 8);
187 * Attach for an AR5211 part.
189 static struct ath_hal *
190 ar5211Attach(uint16_t devid, HAL_SOFTC sc,
191 HAL_BUS_TAG st, HAL_BUS_HANDLE sh, HAL_STATUS *status)
193 struct ath_hal_5211 *ahp;
199 HALDEBUG(AH_NULL, HAL_DEBUG_ATTACH, "%s: sc %p st %p sh %p\n",
200 __func__, sc, (void*) st, (void*) sh);
202 /* NB: memory is returned zero'd */
203 ahp = ath_hal_malloc(sizeof (struct ath_hal_5211));
204 if (ahp == AH_NULL) {
205 HALDEBUG(AH_NULL, HAL_DEBUG_ANY,
206 "%s: cannot allocate memory for state block\n", __func__);
210 ah = &ahp->ah_priv.h;
211 /* set initial values */
212 OS_MEMCPY(&ahp->ah_priv, &ar5211hal, sizeof(struct ath_hal_private));
217 ah->ah_devid = devid; /* NB: for AH_DEBUG_ALQ */
218 AH_PRIVATE(ah)->ah_devid = devid;
219 AH_PRIVATE(ah)->ah_subvendorid = 0; /* XXX */
221 AH_PRIVATE(ah)->ah_powerLimit = MAX_RATE_POWER;
222 AH_PRIVATE(ah)->ah_tpScale = HAL_TP_SCALE_MAX; /* no scaling */
224 ahp->ah_diversityControl = HAL_ANT_VARIABLE;
225 ahp->ah_staId1Defaults = 0;
226 ahp->ah_rssiThr = INIT_RSSI_THR;
227 ahp->ah_sifstime = (u_int) -1;
228 ahp->ah_slottime = (u_int) -1;
229 ahp->ah_acktimeout = (u_int) -1;
230 ahp->ah_ctstimeout = (u_int) -1;
232 if (!ar5211ChipReset(ah, AH_NULL)) { /* reset chip */
233 HALDEBUG(ah, HAL_DEBUG_ANY, "%s: chip reset failed\n", __func__);
237 if (AH_PRIVATE(ah)->ah_devid == AR5211_FPGA11B) {
238 /* set it back to OFDM mode to be able to read analog rev id */
239 OS_REG_WRITE(ah, AR5211_PHY_MODE, AR5211_PHY_MODE_OFDM);
240 OS_REG_WRITE(ah, AR_PHY_PLL_CTL, AR_PHY_PLL_CTL_44);
244 /* Read Revisions from Chips */
245 val = OS_REG_READ(ah, AR_SREV) & AR_SREV_ID_M;
246 AH_PRIVATE(ah)->ah_macVersion = val >> AR_SREV_ID_S;
247 AH_PRIVATE(ah)->ah_macRev = val & AR_SREV_REVISION_M;
249 if (AH_PRIVATE(ah)->ah_macVersion < AR_SREV_VERSION_MAUI_2 ||
250 AH_PRIVATE(ah)->ah_macVersion > AR_SREV_VERSION_OAHU) {
251 HALDEBUG(ah, HAL_DEBUG_ANY,
252 "%s: Mac Chip Rev 0x%x is not supported by this driver\n",
253 __func__, AH_PRIVATE(ah)->ah_macVersion);
254 ecode = HAL_ENOTSUPP;
258 AH_PRIVATE(ah)->ah_phyRev = OS_REG_READ(ah, AR_PHY_CHIP_ID);
260 if (!ar5211ChipTest(ah)) {
261 HALDEBUG(ah, HAL_DEBUG_ANY, "%s: hardware self-test failed\n",
263 ecode = HAL_ESELFTEST;
267 /* Set correct Baseband to analog shift setting to access analog chips. */
268 if (AH_PRIVATE(ah)->ah_macVersion >= AR_SREV_VERSION_OAHU) {
269 OS_REG_WRITE(ah, AR_PHY_BASE, 0x00000007);
271 OS_REG_WRITE(ah, AR_PHY_BASE, 0x00000047);
275 /* Read Radio Chip Rev Extract */
276 AH_PRIVATE(ah)->ah_analog5GhzRev = ar5211GetRadioRev(ah);
277 if ((AH_PRIVATE(ah)->ah_analog5GhzRev & 0xf0) != RAD5_SREV_MAJOR) {
278 HALDEBUG(ah, HAL_DEBUG_ANY,
279 "%s: 5G Radio Chip Rev 0x%02X is not supported by this "
280 "driver\n", __func__, AH_PRIVATE(ah)->ah_analog5GhzRev);
281 ecode = HAL_ENOTSUPP;
285 val = (OS_REG_READ(ah, AR_PCICFG) & AR_PCICFG_EEPROM_SIZE_M) >>
286 AR_PCICFG_EEPROM_SIZE_S;
287 if (val != AR_PCICFG_EEPROM_SIZE_16K) {
288 HALDEBUG(ah, HAL_DEBUG_ANY, "%s: unsupported EEPROM size "
289 "%u (0x%x) found\n", __func__, val, val);
293 ecode = ath_hal_legacyEepromAttach(ah);
294 if (ecode != HAL_OK) {
298 /* If Bmode and AR5211, verify 2.4 analog exists */
299 if (AH_PRIVATE(ah)->ah_macVersion >= AR_SREV_VERSION_OAHU &&
300 ath_hal_eepromGetFlag(ah, AR_EEP_BMODE)) {
301 /* Set correct Baseband to analog shift setting to access analog chips. */
302 OS_REG_WRITE(ah, AR_PHY_BASE, 0x00004007);
304 AH_PRIVATE(ah)->ah_analog2GhzRev = ar5211GetRadioRev(ah);
306 /* Set baseband for 5GHz chip */
307 OS_REG_WRITE(ah, AR_PHY_BASE, 0x00000007);
309 if ((AH_PRIVATE(ah)->ah_analog2GhzRev & 0xF0) != RAD2_SREV_MAJOR) {
310 HALDEBUG(ah, HAL_DEBUG_ANY,
311 "%s: 2G Radio Chip Rev 0x%x is not supported by "
312 "this driver\n", __func__,
313 AH_PRIVATE(ah)->ah_analog2GhzRev);
314 ecode = HAL_ENOTSUPP;
318 ath_hal_eepromSet(ah, AR_EEP_BMODE, AH_FALSE);
321 ecode = ath_hal_eepromGet(ah, AR_EEP_REGDMN_0, &eeval);
322 if (ecode != HAL_OK) {
323 HALDEBUG(ah, HAL_DEBUG_ANY,
324 "%s: cannot read regulatory domain from EEPROM\n",
328 AH_PRIVATE(ah)->ah_currentRD = eeval;
329 AH_PRIVATE(ah)->ah_getNfAdjust = ar5211GetNfAdjust;
332 * Got everything we need now to setup the capabilities.
334 (void) ar5211FillCapabilityInfo(ah);
336 /* Initialize gain ladder thermal calibration structure */
337 ar5211InitializeGainValues(ah);
339 ecode = ath_hal_eepromGet(ah, AR_EEP_MACADDR, ahp->ah_macaddr);
340 if (ecode != HAL_OK) {
341 HALDEBUG(ah, HAL_DEBUG_ANY,
342 "%s: error getting mac address from EEPROM\n", __func__);
346 HALDEBUG(ah, HAL_DEBUG_ATTACH, "%s: return\n", __func__);
351 ar5211Detach((struct ath_hal *) ahp);
358 ar5211Detach(struct ath_hal *ah)
360 HALDEBUG(ah, HAL_DEBUG_ATTACH, "%s:\n", __func__);
362 HALASSERT(ah != AH_NULL);
363 HALASSERT(ah->ah_magic == AR5211_MAGIC);
365 ath_hal_eepromDetach(ah);
370 ar5211ChipTest(struct ath_hal *ah)
372 uint32_t regAddr[2] = { AR_STA_ID0, AR_PHY_BASE+(8 << 2) };
374 uint32_t patternData[4] =
375 { 0x55555555, 0xaaaaaaaa, 0x66666666, 0x99999999 };
378 /* Test PHY & MAC registers */
379 for (i = 0; i < 2; i++) {
380 uint32_t addr = regAddr[i];
381 uint32_t wrData, rdData;
383 regHold[i] = OS_REG_READ(ah, addr);
384 for (j = 0; j < 0x100; j++) {
385 wrData = (j << 16) | j;
386 OS_REG_WRITE(ah, addr, wrData);
387 rdData = OS_REG_READ(ah, addr);
388 if (rdData != wrData) {
389 HALDEBUG(ah, HAL_DEBUG_ANY,
390 "%s: address test failed addr: 0x%08x - wr:0x%08x != rd:0x%08x\n",
391 __func__, addr, wrData, rdData);
395 for (j = 0; j < 4; j++) {
396 wrData = patternData[j];
397 OS_REG_WRITE(ah, addr, wrData);
398 rdData = OS_REG_READ(ah, addr);
399 if (wrData != rdData) {
400 HALDEBUG(ah, HAL_DEBUG_ANY,
401 "%s: address test failed addr: 0x%08x - wr:0x%08x != rd:0x%08x\n",
402 __func__, addr, wrData, rdData);
406 OS_REG_WRITE(ah, regAddr[i], regHold[i]);
413 * Store the channel edges for the requested operational mode
416 ar5211GetChannelEdges(struct ath_hal *ah,
417 uint16_t flags, uint16_t *low, uint16_t *high)
419 if (flags & IEEE80211_CHAN_5GHZ) {
424 if (flags & IEEE80211_CHAN_2GHZ &&
425 ath_hal_eepromGetFlag(ah, AR_EEP_BMODE)) {
434 ar5211GetChipPowerLimits(struct ath_hal *ah, struct ieee80211_channel *chan)
436 /* XXX fill in, this is just a placeholder */
437 HALDEBUG(ah, HAL_DEBUG_ATTACH,
438 "%s: no min/max power for %u/0x%x\n",
439 __func__, chan->ic_freq, chan->ic_flags);
440 chan->ic_maxpower = MAX_RATE_POWER;
441 chan->ic_minpower = 0;
446 ar5211ConfigPCIE(struct ath_hal *ah, HAL_BOOL restore)
451 ar5211DisablePCIE(struct ath_hal *ah)
456 * Fill all software cached or static hardware state information.
459 ar5211FillCapabilityInfo(struct ath_hal *ah)
461 struct ath_hal_private *ahpriv = AH_PRIVATE(ah);
462 HAL_CAPABILITIES *pCap = &ahpriv->ah_caps;
464 /* Construct wireless mode from EEPROM */
465 pCap->halWirelessModes = 0;
466 if (ath_hal_eepromGetFlag(ah, AR_EEP_AMODE)) {
467 pCap->halWirelessModes |= HAL_MODE_11A;
468 if (!ath_hal_eepromGetFlag(ah, AR_EEP_TURBO5DISABLE))
469 pCap->halWirelessModes |= HAL_MODE_TURBO;
471 if (ath_hal_eepromGetFlag(ah, AR_EEP_BMODE))
472 pCap->halWirelessModes |= HAL_MODE_11B;
474 pCap->halLow2GhzChan = 2312;
475 pCap->halHigh2GhzChan = 2732;
476 pCap->halLow5GhzChan = 4920;
477 pCap->halHigh5GhzChan = 6100;
479 pCap->halChanSpreadSupport = AH_TRUE;
480 pCap->halSleepAfterBeaconBroken = AH_TRUE;
481 pCap->halPSPollBroken = AH_TRUE;
482 pCap->halVEOLSupport = AH_TRUE;
484 pCap->halTotalQueues = HAL_NUM_TX_QUEUES;
485 pCap->halKeyCacheSize = 128;
488 pCap->halChanHalfRate = AH_FALSE;
489 pCap->halChanQuarterRate = AH_FALSE;
491 if (ath_hal_eepromGetFlag(ah, AR_EEP_RFKILL) &&
492 ath_hal_eepromGet(ah, AR_EEP_RFSILENT, &ahpriv->ah_rfsilent) == HAL_OK) {
493 /* NB: enabled by default */
494 ahpriv->ah_rfkillEnabled = AH_TRUE;
495 pCap->halRfSilentSupport = AH_TRUE;
498 pCap->halTstampPrecision = 13;
499 pCap->halIntrMask = HAL_INT_COMMON
507 /* XXX might be ok w/ some chip revs */
508 ahpriv->ah_rxornIsFatal = AH_TRUE;
513 ar5211Probe(uint16_t vendorid, uint16_t devid)
515 if (vendorid == ATHEROS_VENDOR_ID) {
516 if (devid == AR5211_DEVID || devid == AR5311_DEVID ||
517 devid == AR5211_DEFAULT)
518 return "Atheros 5211";
519 if (devid == AR5211_FPGA11B)
520 return "Atheros 5211 (FPGA)";
524 AH_CHIP(AR5211, ar5211Probe, ar5211Attach);