1221888Sadrian/* 2221888Sadrian * Copyright (c) 2008 Sam Leffler, Errno Consulting 3221888Sadrian * Copyright (c) 2010 Atheros Communications, Inc. 4221888Sadrian * 5221888Sadrian * Permission to use, copy, modify, and/or distribute this software for any 6221888Sadrian * purpose with or without fee is hereby granted, provided that the above 7221888Sadrian * copyright notice and this permission notice appear in all copies. 8221888Sadrian * 9221888Sadrian * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10221888Sadrian * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11221888Sadrian * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12221888Sadrian * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13221888Sadrian * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14221888Sadrian * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15221888Sadrian * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16221888Sadrian * 17221888Sadrian * $FreeBSD$ 18221888Sadrian */ 19221888Sadrian#include "opt_ah.h" 20221888Sadrian 21221888Sadrian#include "ah.h" 22221888Sadrian#include "ah_internal.h" 23221888Sadrian#include "ah_eeprom_v14.h" 24221888Sadrian#include "ah_eeprom_9287.h" 25221888Sadrian 26221888Sadrianstatic HAL_STATUS 27221888Sadrianv9287EepromGet(struct ath_hal *ah, int param, void *val) 28221888Sadrian{ 29221888Sadrian#define CHAN_A_IDX 0 30221888Sadrian#define CHAN_B_IDX 1 31221888Sadrian#define IS_VERS(op, v) ((pBase->version & AR5416_EEP_VER_MINOR_MASK) op (v)) 32221888Sadrian HAL_EEPROM_9287 *ee = AH_PRIVATE(ah)->ah_eeprom; 33221888Sadrian const MODAL_EEP_9287_HEADER *pModal = &ee->ee_base.modalHeader; 34221888Sadrian const BASE_EEP_9287_HEADER *pBase = &ee->ee_base.baseEepHeader; 35221888Sadrian uint32_t sum; 36221888Sadrian uint8_t *macaddr; 37221888Sadrian int i; 38221888Sadrian 39221888Sadrian switch (param) { 40221888Sadrian case AR_EEP_NFTHRESH_2: 41221888Sadrian *(int16_t *)val = pModal->noiseFloorThreshCh[0]; 42221888Sadrian return HAL_OK; 43221888Sadrian case AR_EEP_MACADDR: /* Get MAC Address */ 44221888Sadrian sum = 0; 45221888Sadrian macaddr = val; 46221888Sadrian for (i = 0; i < 6; i++) { 47221888Sadrian macaddr[i] = pBase->macAddr[i]; 48221888Sadrian sum += pBase->macAddr[i]; 49221888Sadrian } 50221888Sadrian if (sum == 0 || sum == 0xffff*3) { 51221888Sadrian HALDEBUG(ah, HAL_DEBUG_ANY, "%s: bad mac address %s\n", 52221888Sadrian __func__, ath_hal_ether_sprintf(macaddr)); 53221888Sadrian return HAL_EEBADMAC; 54221888Sadrian } 55221888Sadrian return HAL_OK; 56221888Sadrian case AR_EEP_REGDMN_0: 57221888Sadrian return pBase->regDmn[0]; 58221888Sadrian case AR_EEP_REGDMN_1: 59221888Sadrian return pBase->regDmn[1]; 60221888Sadrian case AR_EEP_OPCAP: 61221888Sadrian return pBase->deviceCap; 62221888Sadrian case AR_EEP_OPMODE: 63221888Sadrian return pBase->opCapFlags; 64221888Sadrian case AR_EEP_RFSILENT: 65221888Sadrian return pBase->rfSilent; 66221888Sadrian case AR_EEP_TXMASK: 67221888Sadrian return pBase->txMask; 68221888Sadrian case AR_EEP_RXMASK: 69221888Sadrian return pBase->rxMask; 70221888Sadrian case AR_EEP_OL_PWRCTRL: 71221888Sadrian HALASSERT(val == AH_NULL); 72221888Sadrian return pBase->openLoopPwrCntl ? HAL_OK : HAL_EIO; 73221888Sadrian case AR_EEP_AMODE: 74221888Sadrian return HAL_EIO; /* no 5GHz for Kiwi */ 75221888Sadrian case AR_EEP_BMODE: 76221888Sadrian case AR_EEP_GMODE: 77221888Sadrian HALASSERT(val == AH_NULL); 78221888Sadrian return pBase->opCapFlags & AR5416_OPFLAGS_11G ? 79221888Sadrian HAL_OK : HAL_EIO; 80221888Sadrian case AR_EEP_32KHZCRYSTAL: 81221888Sadrian case AR_EEP_COMPRESS: 82221888Sadrian case AR_EEP_FASTFRAME: /* XXX policy decision, h/w can do it */ 83221888Sadrian case AR_EEP_WRITEPROTECT: /* NB: no write protect bit */ 84221888Sadrian HALASSERT(val == AH_NULL); 85221888Sadrian /* fall thru... */ 86221888Sadrian case AR_EEP_MAXQCU: /* NB: not in opCapFlags */ 87221888Sadrian case AR_EEP_KCENTRIES: /* NB: not in opCapFlags */ 88221888Sadrian return HAL_EIO; 89221888Sadrian case AR_EEP_AES: 90221888Sadrian case AR_EEP_BURST: 91221888Sadrian case AR_EEP_RFKILL: 92221888Sadrian case AR_EEP_TURBO5DISABLE: 93221888Sadrian case AR_EEP_TURBO2DISABLE: 94221888Sadrian HALASSERT(val == AH_NULL); 95221888Sadrian return HAL_OK; 96221888Sadrian case AR_EEP_ANTGAINMAX_2: 97221888Sadrian *(int8_t *) val = ee->ee_antennaGainMax[1]; 98221888Sadrian return HAL_OK; 99221888Sadrian case AR_EEP_PWR_TABLE_OFFSET: 100221888Sadrian *(int8_t *) val = pBase->pwrTableOffset; 101221888Sadrian return HAL_OK; 102222299Sadrian case AR_EEP_TEMPSENSE_SLOPE: 103222299Sadrian if (IS_VERS(>=, AR9287_EEP_MINOR_VER_2)) 104222299Sadrian *(int8_t *)val = pBase->tempSensSlope; 105222299Sadrian else 106222299Sadrian *(int8_t *)val = 0; 107222299Sadrian return HAL_OK; 108222299Sadrian case AR_EEP_TEMPSENSE_SLOPE_PAL_ON: 109222299Sadrian if (IS_VERS(>=, AR9287_EEP_MINOR_VER_3)) 110222299Sadrian *(int8_t *)val = pBase->tempSensSlopePalOn; 111222299Sadrian else 112222299Sadrian *(int8_t *)val = 0; 113222299Sadrian return HAL_OK; 114221888Sadrian default: 115221888Sadrian HALASSERT(0); 116221888Sadrian return HAL_EINVAL; 117221888Sadrian } 118221888Sadrian#undef IS_VERS 119221888Sadrian#undef CHAN_A_IDX 120221888Sadrian#undef CHAN_B_IDX 121221888Sadrian} 122221888Sadrian 123221896Sadrianstatic HAL_STATUS 124221888Sadrianv9287EepromSet(struct ath_hal *ah, int param, int v) 125221888Sadrian{ 126221888Sadrian HAL_EEPROM_9287 *ee = AH_PRIVATE(ah)->ah_eeprom; 127221888Sadrian 128221888Sadrian switch (param) { 129222303Sadrian case AR_EEP_ANTGAINMAX_2: 130222303Sadrian ee->ee_antennaGainMax[1] = (int8_t) v; 131222303Sadrian return HAL_OK; 132222303Sadrian default: 133222303Sadrian return HAL_EINVAL; 134222303Sadrian } 135221888Sadrian} 136221888Sadrian 137221888Sadrianstatic HAL_BOOL 138221888Sadrianv9287EepromDiag(struct ath_hal *ah, int request, 139221888Sadrian const void *args, uint32_t argsize, void **result, uint32_t *resultsize) 140221888Sadrian{ 141221888Sadrian HAL_EEPROM_9287 *ee = AH_PRIVATE(ah)->ah_eeprom; 142221888Sadrian 143221888Sadrian switch (request) { 144221888Sadrian case HAL_DIAG_EEPROM: 145221888Sadrian *result = ee; 146221888Sadrian *resultsize = sizeof(HAL_EEPROM_9287); 147221888Sadrian return AH_TRUE; 148221888Sadrian } 149221888Sadrian return AH_FALSE; 150221888Sadrian} 151221888Sadrian 152221888Sadrian/* Do structure specific swaps if Eeprom format is non native to host */ 153221888Sadrianstatic void 154221888SadrianeepromSwap(HAL_EEPROM_9287 *ee) 155221888Sadrian{ 156221888Sadrian uint32_t integer, i; 157221888Sadrian uint16_t word; 158221888Sadrian MODAL_EEP_9287_HEADER *pModal; 159221888Sadrian 160221888Sadrian /* convert Base Eep header */ 161221888Sadrian word = __bswap16(ee->ee_base.baseEepHeader.length); 162221888Sadrian ee->ee_base.baseEepHeader.length = word; 163221888Sadrian 164221888Sadrian word = __bswap16(ee->ee_base.baseEepHeader.checksum); 165221888Sadrian ee->ee_base.baseEepHeader.checksum = word; 166221888Sadrian 167221888Sadrian word = __bswap16(ee->ee_base.baseEepHeader.version); 168221888Sadrian ee->ee_base.baseEepHeader.version = word; 169221888Sadrian 170221888Sadrian word = __bswap16(ee->ee_base.baseEepHeader.regDmn[0]); 171221888Sadrian ee->ee_base.baseEepHeader.regDmn[0] = word; 172221888Sadrian 173221888Sadrian word = __bswap16(ee->ee_base.baseEepHeader.regDmn[1]); 174221888Sadrian ee->ee_base.baseEepHeader.regDmn[1] = word; 175221888Sadrian 176221888Sadrian word = __bswap16(ee->ee_base.baseEepHeader.rfSilent); 177221888Sadrian ee->ee_base.baseEepHeader.rfSilent = word; 178221888Sadrian 179221888Sadrian word = __bswap16(ee->ee_base.baseEepHeader.blueToothOptions); 180221888Sadrian ee->ee_base.baseEepHeader.blueToothOptions = word; 181221888Sadrian 182221888Sadrian word = __bswap16(ee->ee_base.baseEepHeader.deviceCap); 183221888Sadrian ee->ee_base.baseEepHeader.deviceCap = word; 184221888Sadrian 185221888Sadrian /* convert Modal Eep header */ 186221888Sadrian 187221888Sadrian /* only 2.4ghz here; so only one modal header entry */ 188221888Sadrian pModal = &ee->ee_base.modalHeader; 189221888Sadrian 190221888Sadrian /* XXX linux/ah_osdep.h only defines __bswap32 for BE */ 191221888Sadrian integer = __bswap32(pModal->antCtrlCommon); 192221888Sadrian pModal->antCtrlCommon = integer; 193221888Sadrian 194221888Sadrian for (i = 0; i < AR9287_MAX_CHAINS; i++) { 195221888Sadrian integer = __bswap32(pModal->antCtrlChain[i]); 196221888Sadrian pModal->antCtrlChain[i] = integer; 197221888Sadrian } 198221888Sadrian for (i = 0; i < AR5416_EEPROM_MODAL_SPURS; i++) { 199221888Sadrian word = __bswap16(pModal->spurChans[i].spurChan); 200221888Sadrian pModal->spurChans[i].spurChan = word; 201221888Sadrian } 202221888Sadrian} 203221888Sadrian 204221888Sadrianstatic uint16_t 205221888Sadrianv9287EepromGetSpurChan(struct ath_hal *ah, int ix, HAL_BOOL is2GHz) 206221888Sadrian{ 207221888Sadrian HAL_EEPROM_9287 *ee = AH_PRIVATE(ah)->ah_eeprom; 208221888Sadrian 209221888Sadrian HALASSERT(is2GHz == AH_TRUE); 210221888Sadrian if (is2GHz != AH_TRUE) 211221888Sadrian return 0; /* XXX ? */ 212221888Sadrian 213221888Sadrian HALASSERT(0 <= ix && ix < AR5416_EEPROM_MODAL_SPURS); 214221888Sadrian return ee->ee_base.modalHeader.spurChans[ix].spurChan; 215221888Sadrian} 216221888Sadrian 217221888Sadrian/************************************************************************** 218221888Sadrian * fbin2freq 219221888Sadrian * 220221888Sadrian * Get channel value from binary representation held in eeprom 221221888Sadrian * RETURNS: the frequency in MHz 222221888Sadrian */ 223221888Sadrianstatic uint16_t 224221888Sadrianfbin2freq(uint8_t fbin, HAL_BOOL is2GHz) 225221888Sadrian{ 226221888Sadrian /* 227221888Sadrian * Reserved value 0xFF provides an empty definition both as 228221888Sadrian * an fbin and as a frequency - do not convert 229221888Sadrian */ 230221888Sadrian if (fbin == AR5416_BCHAN_UNUSED) 231221888Sadrian return fbin; 232221888Sadrian return (uint16_t)((is2GHz) ? (2300 + fbin) : (4800 + 5 * fbin)); 233221888Sadrian} 234221888Sadrian 235221888Sadrian 236221888Sadrian/* 237221888Sadrian * Copy EEPROM Conformance Testing Limits contents 238221888Sadrian * into the allocated space 239221888Sadrian */ 240221888Sadrian/* USE CTLS from chain zero */ 241221888Sadrian#define CTL_CHAIN 0 242221888Sadrian 243221888Sadrianstatic void 244221888Sadrianv9287EepromReadCTLInfo(struct ath_hal *ah, HAL_EEPROM_9287 *ee) 245221888Sadrian{ 246221888Sadrian RD_EDGES_POWER *rep = ee->ee_rdEdgesPower; 247221888Sadrian int i, j; 248221888Sadrian 249221888Sadrian HALASSERT(AR9287_NUM_CTLS <= sizeof(ee->ee_rdEdgesPower)/NUM_EDGES); 250221888Sadrian 251221888Sadrian for (i = 0; ee->ee_base.ctlIndex[i] != 0 && i < AR9287_NUM_CTLS; i++) { 252221888Sadrian for (j = 0; j < NUM_EDGES; j ++) { 253221888Sadrian /* XXX Confirm this is the right thing to do when an invalid channel is stored */ 254221888Sadrian if (ee->ee_base.ctlData[i].ctlEdges[CTL_CHAIN][j].bChannel == AR5416_BCHAN_UNUSED) { 255221888Sadrian rep[j].rdEdge = 0; 256221888Sadrian rep[j].twice_rdEdgePower = 0; 257221888Sadrian rep[j].flag = 0; 258221888Sadrian } else { 259221888Sadrian rep[j].rdEdge = fbin2freq( 260221888Sadrian ee->ee_base.ctlData[i].ctlEdges[CTL_CHAIN][j].bChannel, 261221888Sadrian (ee->ee_base.ctlIndex[i] & CTL_MODE_M) != CTL_11A); 262221888Sadrian rep[j].twice_rdEdgePower = MS(ee->ee_base.ctlData[i].ctlEdges[CTL_CHAIN][j].tPowerFlag, CAL_CTL_EDGES_POWER); 263221888Sadrian rep[j].flag = MS(ee->ee_base.ctlData[i].ctlEdges[CTL_CHAIN][j].tPowerFlag, CAL_CTL_EDGES_FLAG) != 0; 264221888Sadrian } 265221888Sadrian } 266221888Sadrian rep += NUM_EDGES; 267221888Sadrian } 268221888Sadrian ee->ee_numCtls = i; 269221888Sadrian HALDEBUG(ah, HAL_DEBUG_ATTACH | HAL_DEBUG_EEPROM, 270221888Sadrian "%s Numctls = %u\n",__func__,i); 271221888Sadrian} 272221888Sadrian 273221888Sadrian/* 274221888Sadrian * Reclaim any EEPROM-related storage. 275221888Sadrian */ 276221888Sadrianstatic void 277221888Sadrianv9287EepromDetach(struct ath_hal *ah) 278221888Sadrian{ 279221888Sadrian HAL_EEPROM_9287 *ee = AH_PRIVATE(ah)->ah_eeprom; 280221888Sadrian 281221888Sadrian ath_hal_free(ee); 282221888Sadrian AH_PRIVATE(ah)->ah_eeprom = AH_NULL; 283221888Sadrian} 284221888Sadrian 285221888Sadrian#define owl_get_eep_ver(_ee) \ 286221888Sadrian (((_ee)->ee_base.baseEepHeader.version >> 12) & 0xF) 287221888Sadrian#define owl_get_eep_rev(_ee) \ 288221888Sadrian (((_ee)->ee_base.baseEepHeader.version) & 0xFFF) 289221888Sadrian 290221888SadrianHAL_STATUS 291221888Sadrianath_hal_9287EepromAttach(struct ath_hal *ah) 292221888Sadrian{ 293221888Sadrian#define NW(a) (sizeof(a) / sizeof(uint16_t)) 294221888Sadrian HAL_EEPROM_9287 *ee = AH_PRIVATE(ah)->ah_eeprom; 295221888Sadrian uint16_t *eep_data, magic; 296221888Sadrian HAL_BOOL need_swap; 297221888Sadrian u_int w, off, len; 298221888Sadrian uint32_t sum; 299221888Sadrian 300221888Sadrian HALASSERT(ee == AH_NULL); 301224518Sadrian 302224518Sadrian /* 303224518Sadrian * Don't check magic if we're supplied with an EEPROM block, 304224518Sadrian * typically this is from Howl but it may also be from later 305224518Sadrian * boards w/ an embedded WMAC. 306224518Sadrian */ 307224518Sadrian if (ah->ah_eepromdata == NULL) { 308224518Sadrian if (!ath_hal_eepromRead(ah, AR5416_EEPROM_MAGIC_OFFSET, &magic)) { 309224518Sadrian HALDEBUG(ah, HAL_DEBUG_ANY, 310224518Sadrian "%s Error reading Eeprom MAGIC\n", __func__); 311224518Sadrian return HAL_EEREAD; 312224518Sadrian } 313239704Sadrian HALDEBUG(ah, HAL_DEBUG_ATTACH, "%s Eeprom Magic = 0x%x\n", 314239704Sadrian __func__, magic); 315239704Sadrian if (magic != AR5416_EEPROM_MAGIC) { 316239704Sadrian HALDEBUG(ah, HAL_DEBUG_ANY, "Bad magic number\n"); 317239704Sadrian return HAL_EEMAGIC; 318239704Sadrian } 319221888Sadrian } 320221888Sadrian 321221888Sadrian ee = ath_hal_malloc(sizeof(HAL_EEPROM_9287)); 322221888Sadrian if (ee == AH_NULL) { 323221888Sadrian /* XXX message */ 324221888Sadrian return HAL_ENOMEM; 325221888Sadrian } 326221888Sadrian 327221888Sadrian eep_data = (uint16_t *) ee; 328221888Sadrian for (w = 0; w < NW(struct ar9287_eeprom); w++) { 329221888Sadrian off = AR9287_EEP_START_LOC + w; 330221888Sadrian if (!ath_hal_eepromRead(ah, off, &eep_data[w])) { 331221888Sadrian HALDEBUG(ah, HAL_DEBUG_ANY, 332221888Sadrian "%s eeprom read error at offset 0x%x\n", 333221888Sadrian __func__, off); 334221888Sadrian return HAL_EEREAD; 335221888Sadrian } 336221888Sadrian } 337221888Sadrian /* Convert to eeprom native eeprom endian format */ 338224518Sadrian /* 339224518Sadrian * XXX this is likely incorrect but will do for now 340224518Sadrian * XXX to get embedded boards working. 341224518Sadrian */ 342224518Sadrian if (ah->ah_eepromdata == NULL && isBigEndian()) { 343221888Sadrian for (w = 0; w < NW(HAL_EEPROM_9287); w++) 344221888Sadrian eep_data[w] = __bswap16(eep_data[w]); 345221888Sadrian } 346221888Sadrian 347221888Sadrian /* 348221888Sadrian * At this point, we're in the native eeprom endian format 349221888Sadrian * Now, determine the eeprom endian by looking at byte 26?? 350221888Sadrian */ 351221888Sadrian need_swap = ((ee->ee_base.baseEepHeader.eepMisc & AR5416_EEPMISC_BIG_ENDIAN) != 0) ^ isBigEndian(); 352221888Sadrian if (need_swap) { 353221888Sadrian HALDEBUG(ah, HAL_DEBUG_ATTACH | HAL_DEBUG_EEPROM, 354221888Sadrian "Byte swap EEPROM contents.\n"); 355221888Sadrian len = __bswap16(ee->ee_base.baseEepHeader.length); 356221888Sadrian } else { 357221888Sadrian len = ee->ee_base.baseEepHeader.length; 358221888Sadrian } 359221888Sadrian len = AH_MIN(len, sizeof(HAL_EEPROM_9287)) / sizeof(uint16_t); 360221888Sadrian 361221888Sadrian /* Apply the checksum, done in native eeprom format */ 362221888Sadrian /* XXX - Need to check to make sure checksum calculation is done 363221888Sadrian * in the correct endian format. Right now, it seems it would 364221888Sadrian * cast the raw data to host format and do the calculation, which may 365221888Sadrian * not be correct as the calculation may need to be done in the native 366221888Sadrian * eeprom format 367221888Sadrian */ 368221888Sadrian sum = 0; 369221888Sadrian for (w = 0; w < len; w++) 370221888Sadrian sum ^= eep_data[w]; 371221888Sadrian /* Check CRC - Attach should fail on a bad checksum */ 372221888Sadrian if (sum != 0xffff) { 373221888Sadrian HALDEBUG(ah, HAL_DEBUG_ANY, 374221888Sadrian "Bad EEPROM checksum 0x%x (Len=%u)\n", sum, len); 375221888Sadrian return HAL_EEBADSUM; 376221888Sadrian } 377221888Sadrian 378221888Sadrian if (need_swap) 379221888Sadrian eepromSwap(ee); /* byte swap multi-byte data */ 380221888Sadrian 381221888Sadrian /* swap words 0+2 so version is at the front */ 382221888Sadrian magic = eep_data[0]; 383221888Sadrian eep_data[0] = eep_data[2]; 384221888Sadrian eep_data[2] = magic; 385221888Sadrian 386221888Sadrian HALDEBUG(ah, HAL_DEBUG_ATTACH | HAL_DEBUG_EEPROM, 387221888Sadrian "%s Eeprom Version %u.%u\n", __func__, 388221888Sadrian owl_get_eep_ver(ee), owl_get_eep_rev(ee)); 389221888Sadrian 390221888Sadrian /* NB: must be after all byte swapping */ 391221888Sadrian if (owl_get_eep_ver(ee) != AR5416_EEP_VER) { 392221888Sadrian HALDEBUG(ah, HAL_DEBUG_ANY, 393221888Sadrian "Bad EEPROM version 0x%x\n", owl_get_eep_ver(ee)); 394221888Sadrian return HAL_EEBADSUM; 395221888Sadrian } 396221888Sadrian 397221888Sadrian v9287EepromReadCTLInfo(ah, ee); /* Get CTLs */ 398221888Sadrian 399221888Sadrian AH_PRIVATE(ah)->ah_eeprom = ee; 400221888Sadrian AH_PRIVATE(ah)->ah_eeversion = ee->ee_base.baseEepHeader.version; 401221888Sadrian AH_PRIVATE(ah)->ah_eepromDetach = v9287EepromDetach; 402221888Sadrian AH_PRIVATE(ah)->ah_eepromGet = v9287EepromGet; 403221888Sadrian AH_PRIVATE(ah)->ah_eepromSet = v9287EepromSet; 404221888Sadrian AH_PRIVATE(ah)->ah_getSpurChan = v9287EepromGetSpurChan; 405221888Sadrian AH_PRIVATE(ah)->ah_eepromDiag = v9287EepromDiag; 406221888Sadrian return HAL_OK; 407221888Sadrian#undef NW 408221888Sadrian} 409