2 * Copyright (c) 2008 Sam Leffler, Errno Consulting
3 * Copyright (c) 2008 Atheros Communications, Inc.
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.
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.
17 * $FreeBSD: head/sys/dev/ath/ath_hal/ah_eeprom_v14.h 203682 2010-02-08 20:12:01Z rpaulo $
20 #ifndef _AH_EEPROM_V14_H_
21 #define _AH_EEPROM_V14_H_
23 #include "ah_eeprom.h"
25 /* reg_off = 4 * (eep_off) */
26 #define AR5416_EEPROM_S 2
27 #define AR5416_EEPROM_OFFSET 0x2000
28 #define AR5416_EEPROM_START_ADDR 0x503f1200
29 #define AR5416_EEPROM_MAX 0xae0 /* Ignore for the moment used only on the flash implementations */
30 #define AR5416_EEPROM_MAGIC 0xa55a
31 #define AR5416_EEPROM_MAGIC_OFFSET 0x0
33 #define owl_get_ntxchains(_txchainmask) \
34 (((_txchainmask >> 2) & 1) + ((_txchainmask >> 1) & 1) + (_txchainmask & 1))
36 #ifdef __LINUX_ARM_ARCH__ /* AP71 */
37 #define owl_eep_start_loc 0
39 #define owl_eep_start_loc 256
42 /* End temp defines */
44 #define AR5416_EEP_NO_BACK_VER 0x1
45 #define AR5416_EEP_VER 0xE
46 #define AR5416_EEP_VER_MINOR_MASK 0xFFF
47 // Adds modal params txFrameToPaOn, txFrametoDataStart, ht40PowerInc
48 #define AR5416_EEP_MINOR_VER_2 0x2
49 // Adds modal params bswAtten, bswMargin, swSettle and base OpFlags for HT20/40 Disable
50 #define AR5416_EEP_MINOR_VER_3 0x3
51 #define AR5416_EEP_MINOR_VER_7 0x7
52 #define AR5416_EEP_MINOR_VER_9 0x9
53 #define AR5416_EEP_MINOR_VER_16 0x10
54 #define AR5416_EEP_MINOR_VER_17 0x11
55 #define AR5416_EEP_MINOR_VER_19 0x13
57 // 16-bit offset location start of calibration struct
58 #define AR5416_EEP_START_LOC 256
59 #define AR5416_NUM_5G_CAL_PIERS 8
60 #define AR5416_NUM_2G_CAL_PIERS 4
61 #define AR5416_NUM_5G_20_TARGET_POWERS 8
62 #define AR5416_NUM_5G_40_TARGET_POWERS 8
63 #define AR5416_NUM_2G_CCK_TARGET_POWERS 3
64 #define AR5416_NUM_2G_20_TARGET_POWERS 4
65 #define AR5416_NUM_2G_40_TARGET_POWERS 4
66 #define AR5416_NUM_CTLS 24
67 #define AR5416_NUM_BAND_EDGES 8
68 #define AR5416_NUM_PD_GAINS 4
69 #define AR5416_PD_GAINS_IN_MASK 4
70 #define AR5416_PD_GAIN_ICEPTS 5
71 #define AR5416_EEPROM_MODAL_SPURS 5
72 #define AR5416_MAX_RATE_POWER 63
73 #define AR5416_NUM_PDADC_VALUES 128
74 #define AR5416_NUM_RATES 16
75 #define AR5416_BCHAN_UNUSED 0xFF
76 #define AR5416_MAX_PWR_RANGE_IN_HALF_DB 64
77 #define AR5416_EEPMISC_BIG_ENDIAN 0x01
78 #define FREQ2FBIN(x,y) ((y) ? ((x) - 2300) : (((x) - 4800) / 5))
79 #define AR5416_MAX_CHAINS 3
80 #define AR5416_PWR_TABLE_OFFSET_DB -5
81 #define AR5416_ANT_16S 25
83 #define AR5416_NUM_ANT_CHAIN_FIELDS 7
84 #define AR5416_NUM_ANT_COMMON_FIELDS 4
85 #define AR5416_SIZE_ANT_CHAIN_FIELD 3
86 #define AR5416_SIZE_ANT_COMMON_FIELD 4
87 #define AR5416_ANT_CHAIN_MASK 0x7
88 #define AR5416_ANT_COMMON_MASK 0xf
89 #define AR5416_CHAIN_0_IDX 0
90 #define AR5416_CHAIN_1_IDX 1
91 #define AR5416_CHAIN_2_IDX 2
93 #define AR5416_OPFLAGS_11A 0x01
94 #define AR5416_OPFLAGS_11G 0x02
95 #define AR5416_OPFLAGS_5G_HT40 0x04
96 #define AR5416_OPFLAGS_2G_HT40 0x08
97 #define AR5416_OPFLAGS_5G_HT20 0x10
98 #define AR5416_OPFLAGS_2G_HT20 0x20
100 /* RF silent fields in EEPROM */
101 #define EEP_RFSILENT_ENABLED 0x0001 /* enabled/disabled */
102 #define EEP_RFSILENT_ENABLED_S 0
103 #define EEP_RFSILENT_POLARITY 0x0002 /* polarity */
104 #define EEP_RFSILENT_POLARITY_S 1
105 #define EEP_RFSILENT_GPIO_SEL 0x001c /* gpio PIN */
106 #define EEP_RFSILENT_GPIO_SEL_S 2
108 /* Rx gain type values */
109 #define AR5416_EEP_RXGAIN_23dB_BACKOFF 0
110 #define AR5416_EEP_RXGAIN_13dB_BACKOFF 1
111 #define AR5416_EEP_RXGAIN_ORIG 2
113 /* Tx gain type values */
114 #define AR5416_EEP_TXGAIN_ORIG 0
115 #define AR5416_EEP_TXGAIN_HIGH_POWER 1
117 typedef struct spurChanStruct {
119 uint8_t spurRangeLow;
120 uint8_t spurRangeHigh;
121 } __packed SPUR_CHAN;
123 typedef struct CalTargetPowerLegacy {
126 } __packed CAL_TARGET_POWER_LEG;
128 typedef struct CalTargetPowerHt {
131 } __packed CAL_TARGET_POWER_HT;
133 typedef struct CalCtlEdges {
135 uint8_t tPowerFlag; /* [0..5] tPower [6..7] flag */
136 #define CAL_CTL_EDGES_POWER 0x3f
137 #define CAL_CTL_EDGES_POWER_S 0
138 #define CAL_CTL_EDGES_FLAG 0xc0
139 #define CAL_CTL_EDGES_FLAG_S 6
140 } __packed CAL_CTL_EDGES;
143 * NB: The format in EEPROM has words 0 and 2 swapped (i.e. version
144 * and length are swapped). We reverse their position after reading
145 * the data into host memory so the version field is at the same
146 * offset as in previous EEPROM layouts. This makes utilities that
147 * inspect the EEPROM contents work without looking at the PCI device
148 * id which may or may not be reliable.
150 typedef struct BaseEepHeader {
151 uint16_t version; /* NB: length in EEPROM */
153 uint16_t length; /* NB: version in EEPROM */
161 uint16_t blueToothOptions;
163 uint32_t binBuildNumber;
169 uint8_t dacHiPwrMode; /* use the DAC high power mode (MB91) */
170 uint8_t openLoopPwrCntl;/* 1: use open loop power control,
171 0: use closed loop power control */
173 uint8_t txGainType; /* high power tx gain table support */
174 uint8_t rcChainMask; /* "1" if the card is an HB93 1x2 */
175 uint8_t futureBase[24];
176 } __packed BASE_EEP_HEADER; // 64 B
178 typedef struct ModalEepHeader {
179 uint32_t antCtrlChain[AR5416_MAX_CHAINS]; // 12
180 uint32_t antCtrlCommon; // 4
181 int8_t antennaGainCh[AR5416_MAX_CHAINS]; // 3
182 uint8_t switchSettling; // 1
183 uint8_t txRxAttenCh[AR5416_MAX_CHAINS]; // 3
184 uint8_t rxTxMarginCh[AR5416_MAX_CHAINS]; // 3
185 uint8_t adcDesiredSize; // 1
186 int8_t pgaDesiredSize; // 1
187 uint8_t xlnaGainCh[AR5416_MAX_CHAINS]; // 3
188 uint8_t txEndToXpaOff; // 1
189 uint8_t txEndToRxOn; // 1
190 uint8_t txFrameToXpaOn; // 1
191 uint8_t thresh62; // 1
192 uint8_t noiseFloorThreshCh[AR5416_MAX_CHAINS]; // 3
193 uint8_t xpdGain; // 1
195 int8_t iqCalICh[AR5416_MAX_CHAINS]; // 1
196 int8_t iqCalQCh[AR5416_MAX_CHAINS]; // 1
197 uint8_t pdGainOverlap; // 1
200 uint8_t xpaBiasLvl; // 1
201 uint8_t pwrDecreaseFor2Chain; // 1
202 uint8_t pwrDecreaseFor3Chain; // 1 -> 48 B
203 uint8_t txFrameToDataStart; // 1
204 uint8_t txFrameToPaOn; // 1
205 uint8_t ht40PowerIncForPdadc; // 1
206 uint8_t bswAtten[AR5416_MAX_CHAINS]; // 3
207 uint8_t bswMargin[AR5416_MAX_CHAINS]; // 3
208 uint8_t swSettleHt40; // 1
209 uint8_t xatten2Db[AR5416_MAX_CHAINS]; // 3 -> New for AR9280 (0xa20c/b20c 11:6)
210 uint8_t xatten2Margin[AR5416_MAX_CHAINS]; // 3 -> New for AR9280 (0xa20c/b20c 21:17)
211 uint8_t ob_ch1; // 1 -> ob and db become chain specific from AR9280
213 uint8_t flagBits; // 1
214 #define AR5416_EEP_FLAG_USEANT1 0x01 /* +1 configured antenna */
215 #define AR5416_EEP_FLAG_FORCEXPAON 0x02 /* force XPA bit for 5G */
216 #define AR5416_EEP_FLAG_LOCALBIAS 0x04 /* enable local bias */
217 #define AR5416_EEP_FLAG_FEMBANDSELECT 0x08 /* FEM band select used */
218 #define AR5416_EEP_FLAG_XLNABUFIN 0x10
219 #define AR5416_EEP_FLAG_XLNAISEL 0x60
220 #define AR5416_EEP_FLAG_XLNAISEL_S 5
221 #define AR5416_EEP_FLAG_XLNABUFMODE 0x80
222 uint8_t miscBits; // [0..1]: bb_tx_dac_scale_cck
223 uint16_t xpaBiasLvlFreq[3]; // 3
224 uint8_t futureModal[6]; // 6
226 SPUR_CHAN spurChans[AR5416_EEPROM_MODAL_SPURS]; // 20 B
227 } __packed MODAL_EEP_HEADER; // == 100 B
229 typedef struct calDataPerFreqOpLoop {
230 uint8_t pwrPdg[2][5]; /* power measurement */
231 uint8_t vpdPdg[2][5]; /* pdadc voltage at power measurement */
232 uint8_t pcdac[2][5]; /* pcdac used for power measurement */
233 uint8_t empty[2][5]; /* future use */
234 } __packed CAL_DATA_PER_FREQ_OP_LOOP;
236 typedef struct CalCtlData {
237 CAL_CTL_EDGES ctlEdges[AR5416_MAX_CHAINS][AR5416_NUM_BAND_EDGES];
238 } __packed CAL_CTL_DATA;
240 typedef struct calDataPerFreq {
241 uint8_t pwrPdg[AR5416_NUM_PD_GAINS][AR5416_PD_GAIN_ICEPTS];
242 uint8_t vpdPdg[AR5416_NUM_PD_GAINS][AR5416_PD_GAIN_ICEPTS];
243 } __packed CAL_DATA_PER_FREQ;
245 struct ar5416eeprom {
246 BASE_EEP_HEADER baseEepHeader; // 64 B
247 uint8_t custData[64]; // 64 B
248 MODAL_EEP_HEADER modalHeader[2]; // 200 B
249 uint8_t calFreqPier5G[AR5416_NUM_5G_CAL_PIERS];
250 uint8_t calFreqPier2G[AR5416_NUM_2G_CAL_PIERS];
251 CAL_DATA_PER_FREQ calPierData5G[AR5416_MAX_CHAINS][AR5416_NUM_5G_CAL_PIERS];
252 CAL_DATA_PER_FREQ calPierData2G[AR5416_MAX_CHAINS][AR5416_NUM_2G_CAL_PIERS];
253 CAL_TARGET_POWER_LEG calTargetPower5G[AR5416_NUM_5G_20_TARGET_POWERS];
254 CAL_TARGET_POWER_HT calTargetPower5GHT20[AR5416_NUM_5G_20_TARGET_POWERS];
255 CAL_TARGET_POWER_HT calTargetPower5GHT40[AR5416_NUM_5G_40_TARGET_POWERS];
256 CAL_TARGET_POWER_LEG calTargetPowerCck[AR5416_NUM_2G_CCK_TARGET_POWERS];
257 CAL_TARGET_POWER_LEG calTargetPower2G[AR5416_NUM_2G_20_TARGET_POWERS];
258 CAL_TARGET_POWER_HT calTargetPower2GHT20[AR5416_NUM_2G_20_TARGET_POWERS];
259 CAL_TARGET_POWER_HT calTargetPower2GHT40[AR5416_NUM_2G_40_TARGET_POWERS];
260 uint8_t ctlIndex[AR5416_NUM_CTLS];
261 CAL_CTL_DATA ctlData[AR5416_NUM_CTLS];
266 struct ar5416eeprom ee_base;
269 RD_EDGES_POWER ee_rdEdgesPower[NUM_EDGES*AR5416_NUM_CTLS];
270 /* XXX these are dynamically calculated for use by shared code */
271 int8_t ee_antennaGainMax[2];
273 #endif /* _AH_EEPROM_V14_H_ */