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 static void ar5210DisablePCIE(struct ath_hal *ah); 38 39 static 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 = ar5210RxMonitor, 93 .ah_aniPoll = ar5210AniPoll, 94 .ah_procMibEvent = ar5210MibEvent, 95 96 /* Misc Functions */ 97 .ah_getCapability = ar5210GetCapability, 98 .ah_setCapability = ar5210SetCapability, 99 .ah_getDiagState = ar5210GetDiagState, 100 .ah_getMacAddress = ar5210GetMacAddress, 101 .ah_setMacAddress = ar5210SetMacAddress, 102 .ah_getBssIdMask = ar5210GetBssIdMask, 103 .ah_setBssIdMask = ar5210SetBssIdMask, 104 .ah_setRegulatoryDomain = ar5210SetRegulatoryDomain, 105 .ah_setLedState = ar5210SetLedState, 106 .ah_writeAssocid = ar5210WriteAssocid, 107 .ah_gpioCfgInput = ar5210GpioCfgInput, 108 .ah_gpioCfgOutput = ar5210GpioCfgOutput, 109 .ah_gpioGet = ar5210GpioGet, 110 .ah_gpioSet = ar5210GpioSet, 111 .ah_gpioSetIntr = ar5210Gpio0SetIntr, 112 .ah_getTsf32 = ar5210GetTsf32, 113 .ah_getTsf64 = ar5210GetTsf64, 114 .ah_resetTsf = ar5210ResetTsf, 115 .ah_detectCardPresent = ar5210DetectCardPresent, 116 .ah_updateMibCounters = ar5210UpdateMibCounters, 117 .ah_getRfGain = ar5210GetRfgain, 118 .ah_getDefAntenna = ar5210GetDefAntenna, 119 .ah_setDefAntenna = ar5210SetDefAntenna, 120 .ah_getAntennaSwitch = ar5210GetAntennaSwitch, 121 .ah_setAntennaSwitch = ar5210SetAntennaSwitch, 122 .ah_setSifsTime = ar5210SetSifsTime, 123 .ah_getSifsTime = ar5210GetSifsTime, 124 .ah_setSlotTime = ar5210SetSlotTime, 125 .ah_getSlotTime = ar5210GetSlotTime, 126 .ah_setAckTimeout = ar5210SetAckTimeout, 127 .ah_getAckTimeout = ar5210GetAckTimeout, 128 .ah_setAckCTSRate = ar5210SetAckCTSRate, 129 .ah_getAckCTSRate = ar5210GetAckCTSRate, 130 .ah_setCTSTimeout = ar5210SetCTSTimeout, 131 .ah_getCTSTimeout = ar5210GetCTSTimeout, 132 .ah_setDecompMask = ar5210SetDecompMask, 133 .ah_setCoverageClass = ar5210SetCoverageClass, 134 135 /* Key Cache Functions */ 136 .ah_getKeyCacheSize = ar5210GetKeyCacheSize, 137 .ah_resetKeyCacheEntry = ar5210ResetKeyCacheEntry, 138 .ah_isKeyCacheEntryValid = ar5210IsKeyCacheEntryValid, 139 .ah_setKeyCacheEntry = ar5210SetKeyCacheEntry, 140 .ah_setKeyCacheEntryMac = ar5210SetKeyCacheEntryMac, 141 142 /* Power Management Functions */ 143 .ah_setPowerMode = ar5210SetPowerMode, 144 .ah_getPowerMode = ar5210GetPowerMode, 145 146 /* Beacon Functions */ 147 .ah_setBeaconTimers = ar5210SetBeaconTimers, 148 .ah_beaconInit = ar5210BeaconInit, 149 .ah_setStationBeaconTimers = ar5210SetStaBeaconTimers, 150 .ah_resetStationBeaconTimers = ar5210ResetStaBeaconTimers, 151 152 /* Interrupt Functions */ 153 .ah_isInterruptPending = ar5210IsInterruptPending, 154 .ah_getPendingInterrupts = ar5210GetPendingInterrupts, 155 .ah_getInterrupts = ar5210GetInterrupts, 156 .ah_setInterrupts = ar5210SetInterrupts }, 157 158 .ah_getChannelEdges = ar5210GetChannelEdges, 159 .ah_getWirelessModes = ar5210GetWirelessModes, 160 .ah_eepromRead = ar5210EepromRead, 161 #ifdef AH_SUPPORT_WRITE_EEPROM 162 .ah_eepromWrite = ar5210EepromWrite, 163 #endif 164 .ah_getChipPowerLimits = ar5210GetChipPowerLimits, 165 }; 166 167 static HAL_BOOL ar5210FillCapabilityInfo(struct ath_hal *ah); 168 169 /* 170 * Attach for an AR5210 part. 171 */ 172 static struct ath_hal * 173 ar5210Attach(uint16_t devid, HAL_SOFTC sc, HAL_BUS_TAG st, HAL_BUS_HANDLE sh, 174 uint16_t *eepromdata, HAL_STATUS *status) 175 { 176 #define N(a) (sizeof(a)/sizeof(a[0])) 177 struct ath_hal_5210 *ahp; 178 struct ath_hal *ah; 179 uint32_t revid, pcicfg; 180 uint16_t eeval; 181 HAL_STATUS ecode; 182 int i; 183 184 HALDEBUG(AH_NULL, HAL_DEBUG_ATTACH, 185 "%s: devid 0x%x sc %p st %p sh %p\n", __func__, devid, 186 sc, (void*) st, (void*) sh); 187 188 /* NB: memory is returned zero'd */ 189 ahp = ath_hal_malloc(sizeof (struct ath_hal_5210)); 190 if (ahp == AH_NULL) { 191 HALDEBUG(AH_NULL, HAL_DEBUG_ANY, 192 "%s: no memory for state block\n", __func__); 193 ecode = HAL_ENOMEM; 194 goto bad; 195 } 196 ah = &ahp->ah_priv.h; 197 /* set initial values */ 198 OS_MEMCPY(&ahp->ah_priv, &ar5210hal, sizeof(struct ath_hal_private)); 199 ah->ah_sc = sc; 200 ah->ah_st = st; 201 ah->ah_sh = sh; 202 203 ah->ah_devid = devid; /* NB: for AH_DEBUG_ALQ */ 204 AH_PRIVATE(ah)->ah_devid = devid; 205 AH_PRIVATE(ah)->ah_subvendorid = 0; /* XXX */ 206 207 AH_PRIVATE(ah)->ah_powerLimit = AR5210_MAX_RATE_POWER; 208 AH_PRIVATE(ah)->ah_tpScale = HAL_TP_SCALE_MAX; /* no scaling */ 209 210 ahp->ah_powerMode = HAL_PM_UNDEFINED; 211 ahp->ah_staId1Defaults = 0; 212 ahp->ah_rssiThr = INIT_RSSI_THR; 213 ahp->ah_sifstime = (u_int) -1; 214 ahp->ah_slottime = (u_int) -1; 215 ahp->ah_acktimeout = (u_int) -1; 216 ahp->ah_ctstimeout = (u_int) -1; 217 218 if (!ar5210ChipReset(ah, AH_NULL)) { /* reset chip */ 219 HALDEBUG(ah, HAL_DEBUG_ANY, "%s: chip reset failed\n", 220 __func__); 221 ecode = HAL_EIO; 222 goto bad; 223 } 224 225 /* Read Revisions from Chips */ 226 AH_PRIVATE(ah)->ah_macVersion = 1; 227 AH_PRIVATE(ah)->ah_macRev = OS_REG_READ(ah, AR_SREV) & 0xff; 228 AH_PRIVATE(ah)->ah_phyRev = OS_REG_READ(ah, AR_PHY_CHIPID); 229 AH_PRIVATE(ah)->ah_analog2GhzRev = 0; 230 231 /* Read Radio Chip Rev Extract */ 232 OS_REG_WRITE(ah, (AR_PHY_BASE + (0x34 << 2)), 0x00001c16); 233 for (i = 0; i < 4; i++) 234 OS_REG_WRITE(ah, (AR_PHY_BASE + (0x20 << 2)), 0x00010000); 235 revid = (OS_REG_READ(ah, AR_PHY_BASE + (256 << 2)) >> 28) & 0xf; 236 237 /* Chip labelling is 1 greater than revision register for AR5110 */ 238 AH_PRIVATE(ah)->ah_analog5GhzRev = ath_hal_reverseBits(revid, 4) + 1; 239 240 /* 241 * Read all the settings from the EEPROM and stash 242 * ones we'll use later. 243 */ 244 pcicfg = OS_REG_READ(ah, AR_PCICFG); 245 OS_REG_WRITE(ah, AR_PCICFG, pcicfg | AR_PCICFG_EEPROMSEL); 246 ecode = ath_hal_v1EepromAttach(ah); 247 if (ecode != HAL_OK) { 248 goto eebad; 249 } 250 ecode = ath_hal_eepromGet(ah, AR_EEP_REGDMN_0, &eeval); 251 if (ecode != HAL_OK) { 252 HALDEBUG(ah, HAL_DEBUG_ANY, 253 "%s: cannot read regulatory domain from EEPROM\n", 254 __func__); 255 goto eebad; 256 } 257 AH_PRIVATE(ah)->ah_currentRD = eeval; 258 ecode = ath_hal_eepromGet(ah, AR_EEP_MACADDR, ahp->ah_macaddr); 259 if (ecode != HAL_OK) { 260 HALDEBUG(ah, HAL_DEBUG_ANY, 261 "%s: error getting mac address from EEPROM\n", __func__); 262 goto eebad; 263 } 264 OS_REG_WRITE(ah, AR_PCICFG, pcicfg); /* disable EEPROM access */ 265 266 AH_PRIVATE(ah)->ah_getNfAdjust = ar5210GetNfAdjust; 267 268 /* 269 * Got everything we need now to setup the capabilities. 270 */ 271 (void) ar5210FillCapabilityInfo(ah); 272 273 HALDEBUG(ah, HAL_DEBUG_ATTACH, "%s: return\n", __func__); 274 275 return ah; 276 eebad: 277 OS_REG_WRITE(ah, AR_PCICFG, pcicfg); /* disable EEPROM access */ 278 bad: 279 if (ahp) 280 ath_hal_free(ahp); 281 if (status) 282 *status = ecode; 283 return AH_NULL; 284 #undef N 285 } 286 287 void 288 ar5210Detach(struct ath_hal *ah) 289 { 290 HALDEBUG(ah, HAL_DEBUG_ATTACH, "%s:\n", __func__); 291 292 HALASSERT(ah != AH_NULL); 293 HALASSERT(ah->ah_magic == AR5210_MAGIC); 294 295 ath_hal_eepromDetach(ah); 296 ath_hal_free(ah); 297 } 298 299 /* 300 * Store the channel edges for the requested operational mode 301 */ 302 static HAL_BOOL 303 ar5210GetChannelEdges(struct ath_hal *ah, 304 uint16_t flags, uint16_t *low, uint16_t *high) 305 { 306 if (flags & IEEE80211_CHAN_5GHZ) { 307 *low = 5120; 308 *high = 5430; 309 return AH_TRUE; 310 } else { 311 return AH_FALSE; 312 } 313 } 314 315 static HAL_BOOL 316 ar5210GetChipPowerLimits(struct ath_hal *ah, struct ieee80211_channel *chan) 317 { 318 /* XXX fill in, this is just a placeholder */ 319 HALDEBUG(ah, HAL_DEBUG_ATTACH, 320 "%s: no min/max power for %u/0x%x\n", 321 __func__, chan->ic_freq, chan->ic_flags); 322 chan->ic_maxpower = AR5210_MAX_RATE_POWER; 323 chan->ic_minpower = 0; 324 return AH_TRUE; 325 } 326 327 static void 328 ar5210ConfigPCIE(struct ath_hal *ah, HAL_BOOL restore) 329 { 330 } 331 332 static void 333 ar5210DisablePCIE(struct ath_hal *ah) 334 { 335 } 336 337 /* 338 * Fill all software cached or static hardware state information. 339 */ 340 static HAL_BOOL 341 ar5210FillCapabilityInfo(struct ath_hal *ah) 342 { 343 struct ath_hal_private *ahpriv = AH_PRIVATE(ah); 344 HAL_CAPABILITIES *pCap = &ahpriv->ah_caps; 345 346 pCap->halWirelessModes |= HAL_MODE_11A; 347 348 pCap->halLow5GhzChan = 5120; 349 pCap->halHigh5GhzChan = 5430; 350 351 pCap->halSleepAfterBeaconBroken = AH_TRUE; 352 pCap->halPSPollBroken = AH_FALSE; 353 354 pCap->halTotalQueues = HAL_NUM_TX_QUEUES; 355 pCap->halKeyCacheSize = 64; 356 357 /* XXX not needed */ 358 pCap->halChanHalfRate = AH_FALSE; 359 pCap->halChanQuarterRate = AH_FALSE; 360 361 if (ath_hal_eepromGetFlag(ah, AR_EEP_RFKILL)) { 362 /* 363 * Setup initial rfsilent settings based on the EEPROM 364 * contents. Pin 0, polarity 0 is fixed; record this 365 * using the EEPROM format found in later parts. 366 */ 367 ahpriv->ah_rfsilent = SM(0, AR_EEPROM_RFSILENT_GPIO_SEL) 368 | SM(0, AR_EEPROM_RFSILENT_POLARITY); 369 ahpriv->ah_rfkillEnabled = AH_TRUE; 370 pCap->halRfSilentSupport = AH_TRUE; 371 } 372 373 pCap->halTstampPrecision = 15; /* NB: s/w extended from 13 */ 374 pCap->halIntrMask = (HAL_INT_COMMON - HAL_INT_BNR) 375 | HAL_INT_RX 376 | HAL_INT_TX 377 | HAL_INT_FATAL 378 ; 379 380 pCap->hal4kbSplitTransSupport = AH_TRUE; 381 382 ahpriv->ah_rxornIsFatal = AH_TRUE; 383 return AH_TRUE; 384 } 385 386 static const char* 387 ar5210Probe(uint16_t vendorid, uint16_t devid) 388 { 389 if (vendorid == ATHEROS_VENDOR_ID && 390 (devid == AR5210_PROD || devid == AR5210_DEFAULT)) 391 return "Atheros 5210"; 392 return AH_NULL; 393 } 394 AH_CHIP(AR5210, ar5210Probe, ar5210Attach); 395