ah_eeprom_v14.h revision 217623
1185377Ssam/* 2185377Ssam * Copyright (c) 2008 Sam Leffler, Errno Consulting 3185377Ssam * Copyright (c) 2008 Atheros Communications, Inc. 4185377Ssam * 5185377Ssam * Permission to use, copy, modify, and/or distribute this software for any 6185377Ssam * purpose with or without fee is hereby granted, provided that the above 7185377Ssam * copyright notice and this permission notice appear in all copies. 8185377Ssam * 9185377Ssam * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10185377Ssam * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11185377Ssam * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12185377Ssam * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13185377Ssam * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14185377Ssam * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15185377Ssam * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16185377Ssam * 17203682Srpaulo * $FreeBSD: head/sys/dev/ath/ath_hal/ah_eeprom_v14.h 217623 2011-01-20 07:42:39Z adrian $ 18185377Ssam */ 19185377Ssam#ifndef _AH_EEPROM_V14_H_ 20185377Ssam#define _AH_EEPROM_V14_H_ 21185377Ssam 22185377Ssam#include "ah_eeprom.h" 23185377Ssam 24185377Ssam/* reg_off = 4 * (eep_off) */ 25185377Ssam#define AR5416_EEPROM_S 2 26185377Ssam#define AR5416_EEPROM_OFFSET 0x2000 27185377Ssam#define AR5416_EEPROM_START_ADDR 0x503f1200 28185377Ssam#define AR5416_EEPROM_MAX 0xae0 /* Ignore for the moment used only on the flash implementations */ 29185377Ssam#define AR5416_EEPROM_MAGIC 0xa55a 30185377Ssam#define AR5416_EEPROM_MAGIC_OFFSET 0x0 31185377Ssam 32185377Ssam#define owl_get_ntxchains(_txchainmask) \ 33185377Ssam (((_txchainmask >> 2) & 1) + ((_txchainmask >> 1) & 1) + (_txchainmask & 1)) 34185377Ssam 35185377Ssam#ifdef __LINUX_ARM_ARCH__ /* AP71 */ 36185377Ssam#define owl_eep_start_loc 0 37185377Ssam#else 38185377Ssam#define owl_eep_start_loc 256 39185377Ssam#endif 40185377Ssam 41185377Ssam/* End temp defines */ 42185377Ssam 43185377Ssam#define AR5416_EEP_NO_BACK_VER 0x1 44185377Ssam#define AR5416_EEP_VER 0xE 45185377Ssam#define AR5416_EEP_VER_MINOR_MASK 0xFFF 46185377Ssam// Adds modal params txFrameToPaOn, txFrametoDataStart, ht40PowerInc 47185377Ssam#define AR5416_EEP_MINOR_VER_2 0x2 48185377Ssam// Adds modal params bswAtten, bswMargin, swSettle and base OpFlags for HT20/40 Disable 49185377Ssam#define AR5416_EEP_MINOR_VER_3 0x3 50185377Ssam#define AR5416_EEP_MINOR_VER_7 0x7 51185377Ssam#define AR5416_EEP_MINOR_VER_9 0x9 52185377Ssam#define AR5416_EEP_MINOR_VER_16 0x10 53185377Ssam#define AR5416_EEP_MINOR_VER_17 0x11 54185377Ssam#define AR5416_EEP_MINOR_VER_19 0x13 55217623Sadrian#define AR5416_EEP_MINOR_VER_20 0x14 56217623Sadrian#define AR5416_EEP_MINOR_VER_21 0x15 57217623Sadrian#define AR5416_EEP_MINOR_VER_22 0x16 58185377Ssam 59185377Ssam// 16-bit offset location start of calibration struct 60185377Ssam#define AR5416_EEP_START_LOC 256 61185377Ssam#define AR5416_NUM_5G_CAL_PIERS 8 62185377Ssam#define AR5416_NUM_2G_CAL_PIERS 4 63185377Ssam#define AR5416_NUM_5G_20_TARGET_POWERS 8 64185377Ssam#define AR5416_NUM_5G_40_TARGET_POWERS 8 65185377Ssam#define AR5416_NUM_2G_CCK_TARGET_POWERS 3 66185377Ssam#define AR5416_NUM_2G_20_TARGET_POWERS 4 67185377Ssam#define AR5416_NUM_2G_40_TARGET_POWERS 4 68185377Ssam#define AR5416_NUM_CTLS 24 69185377Ssam#define AR5416_NUM_BAND_EDGES 8 70185377Ssam#define AR5416_NUM_PD_GAINS 4 71185377Ssam#define AR5416_PD_GAINS_IN_MASK 4 72185377Ssam#define AR5416_PD_GAIN_ICEPTS 5 73185377Ssam#define AR5416_EEPROM_MODAL_SPURS 5 74185377Ssam#define AR5416_MAX_RATE_POWER 63 75185377Ssam#define AR5416_NUM_PDADC_VALUES 128 76185377Ssam#define AR5416_NUM_RATES 16 77185377Ssam#define AR5416_BCHAN_UNUSED 0xFF 78185377Ssam#define AR5416_MAX_PWR_RANGE_IN_HALF_DB 64 79185377Ssam#define AR5416_EEPMISC_BIG_ENDIAN 0x01 80185377Ssam#define FREQ2FBIN(x,y) ((y) ? ((x) - 2300) : (((x) - 4800) / 5)) 81185377Ssam#define AR5416_MAX_CHAINS 3 82203682Srpaulo#define AR5416_PWR_TABLE_OFFSET_DB -5 83185377Ssam#define AR5416_ANT_16S 25 84185377Ssam 85185377Ssam#define AR5416_NUM_ANT_CHAIN_FIELDS 7 86185377Ssam#define AR5416_NUM_ANT_COMMON_FIELDS 4 87185377Ssam#define AR5416_SIZE_ANT_CHAIN_FIELD 3 88185377Ssam#define AR5416_SIZE_ANT_COMMON_FIELD 4 89185377Ssam#define AR5416_ANT_CHAIN_MASK 0x7 90185377Ssam#define AR5416_ANT_COMMON_MASK 0xf 91185377Ssam#define AR5416_CHAIN_0_IDX 0 92185377Ssam#define AR5416_CHAIN_1_IDX 1 93185377Ssam#define AR5416_CHAIN_2_IDX 2 94185377Ssam 95185377Ssam#define AR5416_OPFLAGS_11A 0x01 96185377Ssam#define AR5416_OPFLAGS_11G 0x02 97185377Ssam#define AR5416_OPFLAGS_5G_HT40 0x04 98185377Ssam#define AR5416_OPFLAGS_2G_HT40 0x08 99185377Ssam#define AR5416_OPFLAGS_5G_HT20 0x10 100185377Ssam#define AR5416_OPFLAGS_2G_HT20 0x20 101185377Ssam 102185377Ssam/* RF silent fields in EEPROM */ 103185377Ssam#define EEP_RFSILENT_ENABLED 0x0001 /* enabled/disabled */ 104185377Ssam#define EEP_RFSILENT_ENABLED_S 0 105185377Ssam#define EEP_RFSILENT_POLARITY 0x0002 /* polarity */ 106185377Ssam#define EEP_RFSILENT_POLARITY_S 1 107185377Ssam#define EEP_RFSILENT_GPIO_SEL 0x001c /* gpio PIN */ 108185377Ssam#define EEP_RFSILENT_GPIO_SEL_S 2 109185377Ssam 110185377Ssam/* Rx gain type values */ 111185377Ssam#define AR5416_EEP_RXGAIN_23dB_BACKOFF 0 112185377Ssam#define AR5416_EEP_RXGAIN_13dB_BACKOFF 1 113185377Ssam#define AR5416_EEP_RXGAIN_ORIG 2 114185377Ssam 115185377Ssam/* Tx gain type values */ 116185377Ssam#define AR5416_EEP_TXGAIN_ORIG 0 117185377Ssam#define AR5416_EEP_TXGAIN_HIGH_POWER 1 118185377Ssam 119185377Ssamtypedef struct spurChanStruct { 120185377Ssam uint16_t spurChan; 121185377Ssam uint8_t spurRangeLow; 122185377Ssam uint8_t spurRangeHigh; 123185377Ssam} __packed SPUR_CHAN; 124185377Ssam 125185377Ssamtypedef struct CalTargetPowerLegacy { 126185377Ssam uint8_t bChannel; 127185377Ssam uint8_t tPow2x[4]; 128185377Ssam} __packed CAL_TARGET_POWER_LEG; 129185377Ssam 130185377Ssamtypedef struct CalTargetPowerHt { 131185377Ssam uint8_t bChannel; 132185377Ssam uint8_t tPow2x[8]; 133185377Ssam} __packed CAL_TARGET_POWER_HT; 134185377Ssam 135185377Ssamtypedef struct CalCtlEdges { 136185377Ssam uint8_t bChannel; 137185377Ssam uint8_t tPowerFlag; /* [0..5] tPower [6..7] flag */ 138185377Ssam#define CAL_CTL_EDGES_POWER 0x3f 139185377Ssam#define CAL_CTL_EDGES_POWER_S 0 140185377Ssam#define CAL_CTL_EDGES_FLAG 0xc0 141185377Ssam#define CAL_CTL_EDGES_FLAG_S 6 142185377Ssam} __packed CAL_CTL_EDGES; 143185377Ssam 144185377Ssam/* 145185377Ssam * NB: The format in EEPROM has words 0 and 2 swapped (i.e. version 146185377Ssam * and length are swapped). We reverse their position after reading 147185377Ssam * the data into host memory so the version field is at the same 148185377Ssam * offset as in previous EEPROM layouts. This makes utilities that 149185377Ssam * inspect the EEPROM contents work without looking at the PCI device 150185377Ssam * id which may or may not be reliable. 151185377Ssam */ 152185377Ssamtypedef struct BaseEepHeader { 153185377Ssam uint16_t version; /* NB: length in EEPROM */ 154185377Ssam uint16_t checksum; 155185377Ssam uint16_t length; /* NB: version in EEPROM */ 156185377Ssam uint8_t opCapFlags; 157185377Ssam uint8_t eepMisc; 158185377Ssam uint16_t regDmn[2]; 159185377Ssam uint8_t macAddr[6]; 160185377Ssam uint8_t rxMask; 161185377Ssam uint8_t txMask; 162185377Ssam uint16_t rfSilent; 163185377Ssam uint16_t blueToothOptions; 164185377Ssam uint16_t deviceCap; 165185377Ssam uint32_t binBuildNumber; 166185377Ssam uint8_t deviceType; 167185377Ssam uint8_t pwdclkind; 168185377Ssam uint8_t fastClk5g; 169185377Ssam uint8_t divChain; 170185377Ssam uint8_t rxGainType; 171185377Ssam uint8_t dacHiPwrMode; /* use the DAC high power mode (MB91) */ 172185377Ssam uint8_t openLoopPwrCntl;/* 1: use open loop power control, 173185377Ssam 0: use closed loop power control */ 174185377Ssam uint8_t dacLpMode; 175185377Ssam uint8_t txGainType; /* high power tx gain table support */ 176185377Ssam uint8_t rcChainMask; /* "1" if the card is an HB93 1x2 */ 177185377Ssam uint8_t futureBase[24]; 178185377Ssam} __packed BASE_EEP_HEADER; // 64 B 179185377Ssam 180185377Ssamtypedef struct ModalEepHeader { 181185377Ssam uint32_t antCtrlChain[AR5416_MAX_CHAINS]; // 12 182185377Ssam uint32_t antCtrlCommon; // 4 183185377Ssam int8_t antennaGainCh[AR5416_MAX_CHAINS]; // 3 184185377Ssam uint8_t switchSettling; // 1 185185377Ssam uint8_t txRxAttenCh[AR5416_MAX_CHAINS]; // 3 186185377Ssam uint8_t rxTxMarginCh[AR5416_MAX_CHAINS]; // 3 187185377Ssam uint8_t adcDesiredSize; // 1 188185377Ssam int8_t pgaDesiredSize; // 1 189185377Ssam uint8_t xlnaGainCh[AR5416_MAX_CHAINS]; // 3 190185377Ssam uint8_t txEndToXpaOff; // 1 191185377Ssam uint8_t txEndToRxOn; // 1 192185377Ssam uint8_t txFrameToXpaOn; // 1 193185377Ssam uint8_t thresh62; // 1 194185377Ssam uint8_t noiseFloorThreshCh[AR5416_MAX_CHAINS]; // 3 195185377Ssam uint8_t xpdGain; // 1 196185377Ssam uint8_t xpd; // 1 197185377Ssam int8_t iqCalICh[AR5416_MAX_CHAINS]; // 1 198185377Ssam int8_t iqCalQCh[AR5416_MAX_CHAINS]; // 1 199185377Ssam uint8_t pdGainOverlap; // 1 200185377Ssam uint8_t ob; // 1 201185377Ssam uint8_t db; // 1 202185377Ssam uint8_t xpaBiasLvl; // 1 203185377Ssam uint8_t pwrDecreaseFor2Chain; // 1 204185377Ssam uint8_t pwrDecreaseFor3Chain; // 1 -> 48 B 205185377Ssam uint8_t txFrameToDataStart; // 1 206185377Ssam uint8_t txFrameToPaOn; // 1 207185377Ssam uint8_t ht40PowerIncForPdadc; // 1 208185377Ssam uint8_t bswAtten[AR5416_MAX_CHAINS]; // 3 209185377Ssam uint8_t bswMargin[AR5416_MAX_CHAINS]; // 3 210185377Ssam uint8_t swSettleHt40; // 1 211185377Ssam uint8_t xatten2Db[AR5416_MAX_CHAINS]; // 3 -> New for AR9280 (0xa20c/b20c 11:6) 212185377Ssam uint8_t xatten2Margin[AR5416_MAX_CHAINS]; // 3 -> New for AR9280 (0xa20c/b20c 21:17) 213185377Ssam uint8_t ob_ch1; // 1 -> ob and db become chain specific from AR9280 214185377Ssam uint8_t db_ch1; // 1 215185377Ssam uint8_t flagBits; // 1 216185377Ssam#define AR5416_EEP_FLAG_USEANT1 0x01 /* +1 configured antenna */ 217185377Ssam#define AR5416_EEP_FLAG_FORCEXPAON 0x02 /* force XPA bit for 5G */ 218185377Ssam#define AR5416_EEP_FLAG_LOCALBIAS 0x04 /* enable local bias */ 219185377Ssam#define AR5416_EEP_FLAG_FEMBANDSELECT 0x08 /* FEM band select used */ 220185377Ssam#define AR5416_EEP_FLAG_XLNABUFIN 0x10 221185377Ssam#define AR5416_EEP_FLAG_XLNAISEL 0x60 222185377Ssam#define AR5416_EEP_FLAG_XLNAISEL_S 5 223185377Ssam#define AR5416_EEP_FLAG_XLNABUFMODE 0x80 224185377Ssam uint8_t miscBits; // [0..1]: bb_tx_dac_scale_cck 225185377Ssam uint16_t xpaBiasLvlFreq[3]; // 3 226185377Ssam uint8_t futureModal[6]; // 6 227185377Ssam 228185377Ssam SPUR_CHAN spurChans[AR5416_EEPROM_MODAL_SPURS]; // 20 B 229185377Ssam} __packed MODAL_EEP_HEADER; // == 100 B 230185377Ssam 231185377Ssamtypedef struct calDataPerFreqOpLoop { 232185377Ssam uint8_t pwrPdg[2][5]; /* power measurement */ 233185377Ssam uint8_t vpdPdg[2][5]; /* pdadc voltage at power measurement */ 234185377Ssam uint8_t pcdac[2][5]; /* pcdac used for power measurement */ 235185377Ssam uint8_t empty[2][5]; /* future use */ 236185377Ssam} __packed CAL_DATA_PER_FREQ_OP_LOOP; 237185377Ssam 238185377Ssamtypedef struct CalCtlData { 239185377Ssam CAL_CTL_EDGES ctlEdges[AR5416_MAX_CHAINS][AR5416_NUM_BAND_EDGES]; 240185377Ssam} __packed CAL_CTL_DATA; 241185377Ssam 242185377Ssamtypedef struct calDataPerFreq { 243185377Ssam uint8_t pwrPdg[AR5416_NUM_PD_GAINS][AR5416_PD_GAIN_ICEPTS]; 244185377Ssam uint8_t vpdPdg[AR5416_NUM_PD_GAINS][AR5416_PD_GAIN_ICEPTS]; 245185377Ssam} __packed CAL_DATA_PER_FREQ; 246185377Ssam 247185377Ssamstruct ar5416eeprom { 248185377Ssam BASE_EEP_HEADER baseEepHeader; // 64 B 249185377Ssam uint8_t custData[64]; // 64 B 250185377Ssam MODAL_EEP_HEADER modalHeader[2]; // 200 B 251185377Ssam uint8_t calFreqPier5G[AR5416_NUM_5G_CAL_PIERS]; 252185377Ssam uint8_t calFreqPier2G[AR5416_NUM_2G_CAL_PIERS]; 253185377Ssam CAL_DATA_PER_FREQ calPierData5G[AR5416_MAX_CHAINS][AR5416_NUM_5G_CAL_PIERS]; 254185377Ssam CAL_DATA_PER_FREQ calPierData2G[AR5416_MAX_CHAINS][AR5416_NUM_2G_CAL_PIERS]; 255185377Ssam CAL_TARGET_POWER_LEG calTargetPower5G[AR5416_NUM_5G_20_TARGET_POWERS]; 256185377Ssam CAL_TARGET_POWER_HT calTargetPower5GHT20[AR5416_NUM_5G_20_TARGET_POWERS]; 257185377Ssam CAL_TARGET_POWER_HT calTargetPower5GHT40[AR5416_NUM_5G_40_TARGET_POWERS]; 258185377Ssam CAL_TARGET_POWER_LEG calTargetPowerCck[AR5416_NUM_2G_CCK_TARGET_POWERS]; 259185377Ssam CAL_TARGET_POWER_LEG calTargetPower2G[AR5416_NUM_2G_20_TARGET_POWERS]; 260185377Ssam CAL_TARGET_POWER_HT calTargetPower2GHT20[AR5416_NUM_2G_20_TARGET_POWERS]; 261185377Ssam CAL_TARGET_POWER_HT calTargetPower2GHT40[AR5416_NUM_2G_40_TARGET_POWERS]; 262185377Ssam uint8_t ctlIndex[AR5416_NUM_CTLS]; 263185377Ssam CAL_CTL_DATA ctlData[AR5416_NUM_CTLS]; 264185377Ssam uint8_t padding; 265185377Ssam} __packed; 266185377Ssam 267185377Ssamtypedef struct { 268185377Ssam struct ar5416eeprom ee_base; 269185377Ssam#define NUM_EDGES 8 270185377Ssam uint16_t ee_numCtls; 271185377Ssam RD_EDGES_POWER ee_rdEdgesPower[NUM_EDGES*AR5416_NUM_CTLS]; 272185377Ssam /* XXX these are dynamically calculated for use by shared code */ 273185377Ssam int8_t ee_antennaGainMax[2]; 274185377Ssam} HAL_EEPROM_v14; 275185377Ssam#endif /* _AH_EEPROM_V14_H_ */ 276