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