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