xref: /freebsd/sys/dev/ath/ath_hal/ah_eeprom_v4k.h (revision 10b9d77bf1ccf2f3affafa6261692cb92cf7e992)
1 /*
2  * Copyright (c) 2009 Rui Paulo <rpaulo@FreeBSD.org>
3  * Copyright (c) 2008 Sam Leffler, Errno Consulting
4  * Copyright (c) 2008 Atheros Communications, Inc.
5  *
6  * Permission to use, copy, modify, and/or distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  *
18  * $FreeBSD$
19  */
20 #ifndef _AH_EEPROM_V4K_H_
21 #define _AH_EEPROM_V4K_H_
22 
23 #include "ah_eeprom.h"
24 #include "ah_eeprom_v14.h"
25 
26 #if	_BYTE_ORDER == _BIG_ENDIAN
27 #define	__BIG_ENDIAN_BITFIELD
28 #endif
29 
30 #define	AR9285_RDEXT_DEFAULT	0x1F
31 
32 #undef owl_eep_start_loc
33 #ifdef __LINUX_ARM_ARCH__ /* AP71 */
34 #define owl_eep_start_loc		0
35 #else
36 #define owl_eep_start_loc		64
37 #endif
38 
39 // 16-bit offset location start of calibration struct
40 #define AR5416_4K_EEP_START_LOC         64
41 #define AR5416_4K_NUM_2G_CAL_PIERS     	3
42 #define AR5416_4K_NUM_2G_CCK_TARGET_POWERS 3
43 #define AR5416_4K_NUM_2G_20_TARGET_POWERS  3
44 #define AR5416_4K_NUM_2G_40_TARGET_POWERS  3
45 #define AR5416_4K_NUM_CTLS              12
46 #define AR5416_4K_NUM_BAND_EDGES       	4
47 #define AR5416_4K_NUM_PD_GAINS         	2
48 #define AR5416_4K_MAX_CHAINS           	1
49 
50 /*
51  * NB: The format in EEPROM has words 0 and 2 swapped (i.e. version
52  * and length are swapped).  We reverse their position after reading
53  * the data into host memory so the version field is at the same
54  * offset as in previous EEPROM layouts.  This makes utilities that
55  * inspect the EEPROM contents work without looking at the PCI device
56  * id which may or may not be reliable.
57  */
58 typedef struct BaseEepHeader4k {
59 	uint16_t	version;	/* NB: length in EEPROM */
60 	uint16_t	checksum;
61 	uint16_t	length;		/* NB: version in EEPROM */
62 	uint8_t		opCapFlags;
63 	uint8_t		eepMisc;
64 	uint16_t	regDmn[2];
65 	uint8_t		macAddr[6];
66 	uint8_t		rxMask;
67 	uint8_t		txMask;
68 	uint16_t	rfSilent;
69 	uint16_t	blueToothOptions;
70 	uint16_t	deviceCap;
71 	uint32_t	binBuildNumber;
72 	uint8_t		deviceType;
73 	uint8_t		txGainType;	/* high power tx gain table support */
74 } __packed BASE_EEP4K_HEADER; // 32 B
75 
76 typedef struct ModalEepHeader4k {
77 	uint32_t	antCtrlChain[AR5416_4K_MAX_CHAINS];	// 4
78 	uint32_t	antCtrlCommon;				// 4
79 	int8_t		antennaGainCh[AR5416_4K_MAX_CHAINS];	// 1
80 	uint8_t		switchSettling;				// 1
81 	uint8_t		txRxAttenCh[AR5416_4K_MAX_CHAINS];	// 1
82 	uint8_t		rxTxMarginCh[AR5416_4K_MAX_CHAINS];	// 1
83 	uint8_t		adcDesiredSize;				// 1
84 	int8_t		pgaDesiredSize;				// 1
85 	uint8_t		xlnaGainCh[AR5416_4K_MAX_CHAINS];	// 1
86 	uint8_t		txEndToXpaOff;				// 1
87 	uint8_t		txEndToRxOn;				// 1
88 	uint8_t		txFrameToXpaOn;				// 1
89 	uint8_t		thresh62;				// 1
90 	uint8_t		noiseFloorThreshCh[AR5416_4K_MAX_CHAINS];	// 1
91 	uint8_t		xpdGain;				// 1
92 	uint8_t		xpd;					// 1
93 	int8_t		iqCalICh[AR5416_4K_MAX_CHAINS];		// 1
94 	int8_t		iqCalQCh[AR5416_4K_MAX_CHAINS];		// 1
95 
96 	uint8_t		pdGainOverlap;				// 1
97 
98 #ifdef __BIG_ENDIAN_BITFIELD
99 	uint8_t		ob_1:4, ob_0:4;				// 1
100 	uint8_t		db1_1:4, db1_0:4;			// 1
101 #else
102 	uint8_t		ob_0:4, ob_1:4;
103 	uint8_t		db1_0:4, db1_1:4;
104 #endif
105 
106 	uint8_t		xpaBiasLvl;				// 1
107 	uint8_t		txFrameToDataStart;			// 1
108 	uint8_t		txFrameToPaOn;				// 1
109 	uint8_t		ht40PowerIncForPdadc;			// 1
110 	uint8_t		bswAtten[AR5416_4K_MAX_CHAINS];		// 1
111 	uint8_t		bswMargin[AR5416_4K_MAX_CHAINS];	// 1
112 	uint8_t		swSettleHt40;				// 1
113 	uint8_t		xatten2Db[AR5416_4K_MAX_CHAINS];    	// 1
114 	uint8_t		xatten2Margin[AR5416_4K_MAX_CHAINS];	// 1
115 
116 #ifdef __BIG_ENDIAN_BITFIELD
117         uint8_t		db2_1:4, db2_0:4;			// 1
118 #else
119 	uint8_t		db2_0:4, db2_1:4;			// 1
120 #endif
121 
122 	uint8_t		version;				// 1
123 
124 #ifdef __BIG_ENDIAN_BITFIELD
125 	uint8_t		ob_3:4, ob_2:4;				// 1
126 	uint8_t		antdiv_ctl1:4, ob_4:4;			// 1
127 	uint8_t		db1_3:4, db1_2:4;			// 1
128 	uint8_t		antdiv_ctl2:4, db1_4:4;			// 1
129 	uint8_t		db2_2:4, db2_3:4;			// 1
130 	uint8_t		reserved:4, db2_4:4;			// 1
131 #else
132 	uint8_t		ob_2:4, ob_3:4;
133 	uint8_t		ob_4:4, antdiv_ctl1:4;
134 	uint8_t		db1_2:4, db1_3:4;
135 	uint8_t		db1_4:4, antdiv_ctl2:4;
136 	uint8_t		db2_2:4, db2_3:4;
137 	uint8_t		db2_4:4, reserved:4;
138 #endif
139 	uint8_t		futureModal[4];				// 4
140 
141 	SPUR_CHAN spurChans[AR5416_EEPROM_MODAL_SPURS];	// 20 B
142 } __packed MODAL_EEP4K_HEADER;				// == 68 B
143 
144 typedef struct CalCtlData4k {
145 	CAL_CTL_EDGES		ctlEdges[AR5416_4K_MAX_CHAINS][AR5416_4K_NUM_BAND_EDGES];
146 } __packed CAL_CTL_DATA_4K;
147 
148 typedef struct calDataPerFreq4k {
149 	uint8_t		pwrPdg[AR5416_4K_NUM_PD_GAINS][AR5416_PD_GAIN_ICEPTS];
150 	uint8_t		vpdPdg[AR5416_4K_NUM_PD_GAINS][AR5416_PD_GAIN_ICEPTS];
151 } __packed CAL_DATA_PER_FREQ_4K;
152 
153 struct ar5416eeprom_4k {
154 	BASE_EEP4K_HEADER	baseEepHeader;         // 32 B
155 	uint8_t			custData[20];          // 20 B
156 	MODAL_EEP4K_HEADER	modalHeader;           // 68 B
157 	uint8_t			calFreqPier2G[AR5416_4K_NUM_2G_CAL_PIERS];
158 	CAL_DATA_PER_FREQ_4K	calPierData2G[AR5416_4K_MAX_CHAINS][AR5416_4K_NUM_2G_CAL_PIERS];
159 	CAL_TARGET_POWER_LEG	calTargetPowerCck[AR5416_4K_NUM_2G_CCK_TARGET_POWERS];
160 	CAL_TARGET_POWER_LEG	calTargetPower2G[AR5416_4K_NUM_2G_20_TARGET_POWERS];
161 	CAL_TARGET_POWER_HT	calTargetPower2GHT20[AR5416_4K_NUM_2G_20_TARGET_POWERS];
162 	CAL_TARGET_POWER_HT	calTargetPower2GHT40[AR5416_4K_NUM_2G_40_TARGET_POWERS];
163 	uint8_t			ctlIndex[AR5416_4K_NUM_CTLS];
164 	CAL_CTL_DATA_4K		ctlData[AR5416_4K_NUM_CTLS];
165 	uint8_t			padding;
166 } __packed;
167 
168 typedef struct {
169 	struct ar5416eeprom_4k ee_base;
170 #define NUM_EDGES	 8
171 	uint16_t	ee_numCtls;
172 	RD_EDGES_POWER	ee_rdEdgesPower[NUM_EDGES*AR5416_4K_NUM_CTLS];
173 	/* XXX these are dynamically calculated for use by shared code */
174 	int8_t		ee_antennaGainMax;
175 } HAL_EEPROM_v4k;
176 #endif /* _AH_EEPROM_V4K_H_ */
177