1 /*-
2 * SPDX-License-Identifier: ISC
3 *
4 * Copyright (c) 2002-2009 Sam Leffler, Errno Consulting
5 * Copyright (c) 2002-2004 Atheros Communications, Inc.
6 *
7 * Permission to use, copy, modify, and/or distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
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_setQuiet = ar5210SetQuiet,
139 .ah_get11nExtBusy = ar5210Get11nExtBusy,
140 .ah_getMibCycleCounts = ar5210GetMibCycleCounts,
141 .ah_setChainMasks = ar5210SetChainMasks,
142 .ah_enableDfs = ar5210EnableDfs,
143 .ah_getDfsThresh = ar5210GetDfsThresh,
144 /* XXX procRadarEvent */
145 /* XXX isFastClockEnabled */
146 .ah_getNav = ar5210GetNav,
147 .ah_setNav = ar5210SetNav,
148
149 /* Key Cache Functions */
150 .ah_getKeyCacheSize = ar5210GetKeyCacheSize,
151 .ah_resetKeyCacheEntry = ar5210ResetKeyCacheEntry,
152 .ah_isKeyCacheEntryValid = ar5210IsKeyCacheEntryValid,
153 .ah_setKeyCacheEntry = ar5210SetKeyCacheEntry,
154 .ah_setKeyCacheEntryMac = ar5210SetKeyCacheEntryMac,
155
156 /* Power Management Functions */
157 .ah_setPowerMode = ar5210SetPowerMode,
158 .ah_getPowerMode = ar5210GetPowerMode,
159
160 /* Beacon Functions */
161 .ah_setBeaconTimers = ar5210SetBeaconTimers,
162 .ah_beaconInit = ar5210BeaconInit,
163 .ah_setStationBeaconTimers = ar5210SetStaBeaconTimers,
164 .ah_resetStationBeaconTimers = ar5210ResetStaBeaconTimers,
165 .ah_getNextTBTT = ar5210GetNextTBTT,
166
167 /* Interrupt Functions */
168 .ah_isInterruptPending = ar5210IsInterruptPending,
169 .ah_getPendingInterrupts = ar5210GetPendingInterrupts,
170 .ah_getInterrupts = ar5210GetInterrupts,
171 .ah_setInterrupts = ar5210SetInterrupts },
172
173 .ah_getChannelEdges = ar5210GetChannelEdges,
174 .ah_getWirelessModes = ar5210GetWirelessModes,
175 .ah_eepromRead = ar5210EepromRead,
176 #ifdef AH_SUPPORT_WRITE_EEPROM
177 .ah_eepromWrite = ar5210EepromWrite,
178 #endif
179 .ah_getChipPowerLimits = ar5210GetChipPowerLimits,
180 };
181
182 static HAL_BOOL ar5210FillCapabilityInfo(struct ath_hal *ah);
183
184 /*
185 * Attach for an AR5210 part.
186 */
187 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)188 ar5210Attach(uint16_t devid, HAL_SOFTC sc, HAL_BUS_TAG st, HAL_BUS_HANDLE sh,
189 uint16_t *eepromdata, HAL_OPS_CONFIG *ah_config, HAL_STATUS *status)
190 {
191 #define N(a) (sizeof(a)/sizeof(a[0]))
192 struct ath_hal_5210 *ahp;
193 struct ath_hal *ah;
194 uint32_t revid, pcicfg;
195 uint16_t eeval;
196 HAL_STATUS ecode;
197 int i;
198
199 HALDEBUG(AH_NULL, HAL_DEBUG_ATTACH,
200 "%s: devid 0x%x sc %p st %p sh %p\n", __func__, devid,
201 sc, (void*) st, (void*) sh);
202
203 /* NB: memory is returned zero'd */
204 ahp = ath_hal_malloc(sizeof (struct ath_hal_5210));
205 if (ahp == AH_NULL) {
206 HALDEBUG(AH_NULL, HAL_DEBUG_ANY,
207 "%s: no memory for state block\n", __func__);
208 ecode = HAL_ENOMEM;
209 goto bad;
210 }
211 ah = &ahp->ah_priv.h;
212 /* set initial values */
213 OS_MEMCPY(&ahp->ah_priv, &ar5210hal, sizeof(struct ath_hal_private));
214 ah->ah_sc = sc;
215 ah->ah_st = st;
216 ah->ah_sh = sh;
217
218 ah->ah_devid = devid; /* NB: for AH_DEBUG_ALQ */
219 AH_PRIVATE(ah)->ah_devid = devid;
220 AH_PRIVATE(ah)->ah_subvendorid = 0; /* XXX */
221
222 AH_PRIVATE(ah)->ah_powerLimit = AR5210_MAX_RATE_POWER;
223 AH_PRIVATE(ah)->ah_tpScale = HAL_TP_SCALE_MAX; /* no scaling */
224
225 ah->ah_powerMode = HAL_PM_UNDEFINED;
226 ahp->ah_staId1Defaults = 0;
227 ahp->ah_rssiThr = INIT_RSSI_THR;
228 ahp->ah_sifstime = (u_int) -1;
229 ahp->ah_slottime = (u_int) -1;
230 ahp->ah_acktimeout = (u_int) -1;
231 ahp->ah_ctstimeout = (u_int) -1;
232
233 if (!ar5210ChipReset(ah, AH_NULL)) { /* reset chip */
234 HALDEBUG(ah, HAL_DEBUG_ANY, "%s: chip reset failed\n",
235 __func__);
236 ecode = HAL_EIO;
237 goto bad;
238 }
239
240 /* Read Revisions from Chips */
241 AH_PRIVATE(ah)->ah_macVersion = 1;
242 AH_PRIVATE(ah)->ah_macRev = OS_REG_READ(ah, AR_SREV) & 0xff;
243 AH_PRIVATE(ah)->ah_phyRev = OS_REG_READ(ah, AR_PHY_CHIPID);
244 AH_PRIVATE(ah)->ah_analog2GhzRev = 0;
245
246 /* Read Radio Chip Rev Extract */
247 OS_REG_WRITE(ah, (AR_PHY_BASE + (0x34 << 2)), 0x00001c16);
248 for (i = 0; i < 4; i++)
249 OS_REG_WRITE(ah, (AR_PHY_BASE + (0x20 << 2)), 0x00010000);
250 revid = (OS_REG_READ(ah, AR_PHY_BASE + (256 << 2)) >> 28) & 0xf;
251
252 /* Chip labelling is 1 greater than revision register for AR5110 */
253 AH_PRIVATE(ah)->ah_analog5GhzRev = ath_hal_reverseBits(revid, 4) + 1;
254
255 /*
256 * Read all the settings from the EEPROM and stash
257 * ones we'll use later.
258 */
259 pcicfg = OS_REG_READ(ah, AR_PCICFG);
260 OS_REG_WRITE(ah, AR_PCICFG, pcicfg | AR_PCICFG_EEPROMSEL);
261 ecode = ath_hal_v1EepromAttach(ah);
262 if (ecode != HAL_OK) {
263 goto eebad;
264 }
265 ecode = ath_hal_eepromGet(ah, AR_EEP_REGDMN_0, &eeval);
266 if (ecode != HAL_OK) {
267 HALDEBUG(ah, HAL_DEBUG_ANY,
268 "%s: cannot read regulatory domain from EEPROM\n",
269 __func__);
270 goto eebad;
271 }
272 AH_PRIVATE(ah)->ah_currentRD = eeval;
273 ecode = ath_hal_eepromGet(ah, AR_EEP_MACADDR, ahp->ah_macaddr);
274 if (ecode != HAL_OK) {
275 HALDEBUG(ah, HAL_DEBUG_ANY,
276 "%s: error getting mac address from EEPROM\n", __func__);
277 goto eebad;
278 }
279 OS_REG_WRITE(ah, AR_PCICFG, pcicfg); /* disable EEPROM access */
280
281 AH_PRIVATE(ah)->ah_getNfAdjust = ar5210GetNfAdjust;
282
283 /*
284 * Got everything we need now to setup the capabilities.
285 */
286 (void) ar5210FillCapabilityInfo(ah);
287
288 HALDEBUG(ah, HAL_DEBUG_ATTACH, "%s: return\n", __func__);
289
290 return ah;
291 eebad:
292 OS_REG_WRITE(ah, AR_PCICFG, pcicfg); /* disable EEPROM access */
293 bad:
294 if (ahp)
295 ath_hal_free(ahp);
296 if (status)
297 *status = ecode;
298 return AH_NULL;
299 #undef N
300 }
301
302 void
ar5210Detach(struct ath_hal * ah)303 ar5210Detach(struct ath_hal *ah)
304 {
305 HALDEBUG(ah, HAL_DEBUG_ATTACH, "%s:\n", __func__);
306
307 HALASSERT(ah != AH_NULL);
308 HALASSERT(ah->ah_magic == AR5210_MAGIC);
309
310 ath_hal_eepromDetach(ah);
311 ath_hal_free(ah);
312 }
313
314 /*
315 * Store the channel edges for the requested operational mode
316 */
317 static HAL_BOOL
ar5210GetChannelEdges(struct ath_hal * ah,uint16_t flags,uint16_t * low,uint16_t * high)318 ar5210GetChannelEdges(struct ath_hal *ah,
319 uint16_t flags, uint16_t *low, uint16_t *high)
320 {
321 if (flags & IEEE80211_CHAN_5GHZ) {
322 *low = 5120;
323 *high = 5430;
324 return AH_TRUE;
325 } else {
326 return AH_FALSE;
327 }
328 }
329
330 static HAL_BOOL
ar5210GetChipPowerLimits(struct ath_hal * ah,struct ieee80211_channel * chan)331 ar5210GetChipPowerLimits(struct ath_hal *ah, struct ieee80211_channel *chan)
332 {
333 /* XXX fill in, this is just a placeholder */
334 HALDEBUG(ah, HAL_DEBUG_ATTACH,
335 "%s: no min/max power for %u/0x%x\n",
336 __func__, chan->ic_freq, chan->ic_flags);
337 chan->ic_maxpower = AR5210_MAX_RATE_POWER;
338 chan->ic_minpower = 0;
339 return AH_TRUE;
340 }
341
342 static void
ar5210ConfigPCIE(struct ath_hal * ah,HAL_BOOL restore,HAL_BOOL power_off)343 ar5210ConfigPCIE(struct ath_hal *ah, HAL_BOOL restore, HAL_BOOL power_off)
344 {
345 }
346
347 static void
ar5210DisablePCIE(struct ath_hal * ah)348 ar5210DisablePCIE(struct ath_hal *ah)
349 {
350 }
351
352 /*
353 * Fill all software cached or static hardware state information.
354 */
355 static HAL_BOOL
ar5210FillCapabilityInfo(struct ath_hal * ah)356 ar5210FillCapabilityInfo(struct ath_hal *ah)
357 {
358 struct ath_hal_private *ahpriv = AH_PRIVATE(ah);
359 HAL_CAPABILITIES *pCap = &ahpriv->ah_caps;
360
361 pCap->halWirelessModes |= HAL_MODE_11A;
362
363 pCap->halLow5GhzChan = 5120;
364 pCap->halHigh5GhzChan = 5430;
365
366 pCap->halSleepAfterBeaconBroken = AH_TRUE;
367 pCap->halPSPollBroken = AH_FALSE;
368 pCap->halNumMRRetries = 1; /* No hardware MRR support */
369 pCap->halNumTxMaps = 1; /* Single TX ptr per descr */
370
371 pCap->halTotalQueues = HAL_NUM_TX_QUEUES;
372 pCap->halKeyCacheSize = 64;
373
374 /* XXX not needed */
375 pCap->halChanHalfRate = AH_FALSE;
376 pCap->halChanQuarterRate = AH_FALSE;
377
378 /*
379 * RSSI uses the combined field; some 11n NICs may use
380 * the control chain RSSI.
381 */
382 pCap->halUseCombinedRadarRssi = AH_TRUE;
383
384 if (ath_hal_eepromGetFlag(ah, AR_EEP_RFKILL)) {
385 /*
386 * Setup initial rfsilent settings based on the EEPROM
387 * contents. Pin 0, polarity 0 is fixed; record this
388 * using the EEPROM format found in later parts.
389 */
390 ahpriv->ah_rfsilent = SM(0, AR_EEPROM_RFSILENT_GPIO_SEL)
391 | SM(0, AR_EEPROM_RFSILENT_POLARITY);
392 ahpriv->ah_rfkillEnabled = AH_TRUE;
393 pCap->halRfSilentSupport = AH_TRUE;
394 }
395
396 pCap->halTxTstampPrecision = 16;
397 pCap->halRxTstampPrecision = 15; /* NB: s/w extended from 13 */
398 pCap->halIntrMask = (HAL_INT_COMMON - HAL_INT_BNR)
399 | HAL_INT_RX
400 | HAL_INT_TX
401 | HAL_INT_FATAL
402 ;
403
404 pCap->hal4kbSplitTransSupport = AH_TRUE;
405 pCap->halHasRxSelfLinkedTail = AH_TRUE;
406
407 ahpriv->ah_rxornIsFatal = AH_TRUE;
408 return AH_TRUE;
409 }
410
411 static const char*
ar5210Probe(uint16_t vendorid,uint16_t devid)412 ar5210Probe(uint16_t vendorid, uint16_t devid)
413 {
414 if (vendorid == ATHEROS_VENDOR_ID &&
415 (devid == AR5210_PROD || devid == AR5210_DEFAULT))
416 return "Atheros 5210";
417 return AH_NULL;
418 }
419 AH_CHIP(AR5210, ar5210Probe, ar5210Attach);
420