ar9160_attach.c revision 188973
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 * $FreeBSD: head/sys/dev/ath/ath_hal/ar5416/ar9160_attach.c 188973 2009-02-24 00:03:14Z sam $
18 */
19#include "opt_ah.h"
20
21#include "ah.h"
22#include "ah_internal.h"
23#include "ah_devid.h"
24
25#include "ar5416/ar5416.h"
26#include "ar5416/ar5416reg.h"
27#include "ar5416/ar5416phy.h"
28
29#include "ar5416/ar9160.ini"
30
31static const HAL_PERCAL_DATA ar9160_iq_cal = {		/* multi sample */
32	.calName = "IQ", .calType = IQ_MISMATCH_CAL,
33	.calNumSamples	= MAX_CAL_SAMPLES,
34	.calCountMax	= PER_MIN_LOG_COUNT,
35	.calCollect	= ar5416IQCalCollect,
36	.calPostProc	= ar5416IQCalibration
37};
38static const HAL_PERCAL_DATA ar9160_adc_gain_cal = {	/* multi sample */
39	.calName = "ADC Gain", .calType = ADC_GAIN_CAL,
40	.calNumSamples	= MAX_CAL_SAMPLES,
41	.calCountMax	= PER_MIN_LOG_COUNT,
42	.calCollect	= ar5416AdcGainCalCollect,
43	.calPostProc	= ar5416AdcGainCalibration
44};
45static const HAL_PERCAL_DATA ar9160_adc_dc_cal = {	/* multi sample */
46	.calName = "ADC DC", .calType = ADC_DC_CAL,
47	.calNumSamples	= MAX_CAL_SAMPLES,
48	.calCountMax	= PER_MIN_LOG_COUNT,
49	.calCollect	= ar5416AdcDcCalCollect,
50	.calPostProc	= ar5416AdcDcCalibration
51};
52static const HAL_PERCAL_DATA ar9160_adc_init_dc_cal = {
53	.calName = "ADC Init DC", .calType = ADC_DC_INIT_CAL,
54	.calNumSamples	= MIN_CAL_SAMPLES,
55	.calCountMax	= INIT_LOG_COUNT,
56	.calCollect	= ar5416AdcDcCalCollect,
57	.calPostProc	= ar5416AdcDcCalibration
58};
59
60static void ar9160Detach(struct ath_hal *);
61static HAL_BOOL ar9160FillCapabilityInfo(struct ath_hal *ah);
62
63static void
64ar9160AniSetup(struct ath_hal *ah)
65{
66	static const struct ar5212AniParams aniparams = {
67		.maxNoiseImmunityLevel	= 4,	/* levels 0..4 */
68		.totalSizeDesired	= { -55, -55, -55, -55, -62 },
69		.coarseHigh		= { -14, -14, -14, -14, -12 },
70		.coarseLow		= { -64, -64, -64, -64, -70 },
71		.firpwr			= { -78, -78, -78, -78, -80 },
72		.maxSpurImmunityLevel	= 2,
73		.cycPwrThr1		= { 2, 4, 6 },
74		.maxFirstepLevel	= 2,	/* levels 0..2 */
75		.firstep		= { 0, 4, 8 },
76		.ofdmTrigHigh		= 500,
77		.ofdmTrigLow		= 200,
78		.cckTrigHigh		= 200,
79		.cckTrigLow		= 100,
80		.rssiThrHigh		= 40,
81		.rssiThrLow		= 7,
82		.period			= 100,
83	};
84	/* NB: ANI is not enabled yet */
85	ar5212AniAttach(ah, &aniparams, &aniparams, AH_FALSE);
86}
87
88/*
89 * Attach for an AR9160 part.
90 */
91static struct ath_hal *
92ar9160Attach(uint16_t devid, HAL_SOFTC sc,
93	HAL_BUS_TAG st, HAL_BUS_HANDLE sh, HAL_STATUS *status)
94{
95	struct ath_hal_5416 *ahp5416;
96	struct ath_hal_5212 *ahp;
97	struct ath_hal *ah;
98	uint32_t val;
99	HAL_STATUS ecode;
100	HAL_BOOL rfStatus;
101
102	HALDEBUG(AH_NULL, HAL_DEBUG_ATTACH, "%s: sc %p st %p sh %p\n",
103	    __func__, sc, (void*) st, (void*) sh);
104
105	/* NB: memory is returned zero'd */
106	ahp5416 = ath_hal_malloc(sizeof (struct ath_hal_5416));
107	if (ahp5416 == AH_NULL) {
108		HALDEBUG(AH_NULL, HAL_DEBUG_ANY,
109		    "%s: cannot allocate memory for state block\n", __func__);
110		*status = HAL_ENOMEM;
111		return AH_NULL;
112	}
113	ar5416InitState(ahp5416, devid, sc, st, sh, status);
114	ahp = &ahp5416->ah_5212;
115	ah = &ahp->ah_priv.h;
116
117	/* XXX override with 9160 specific state */
118	/* override 5416 methods for our needs */
119	ah->ah_detach			= ar9160Detach;
120
121	AH5416(ah)->ah_cal.iqCalData.calData = &ar9160_iq_cal;
122	AH5416(ah)->ah_cal.adcGainCalData.calData = &ar9160_adc_gain_cal;
123	AH5416(ah)->ah_cal.adcDcCalData.calData = &ar9160_adc_dc_cal;
124	AH5416(ah)->ah_cal.adcDcCalInitData.calData = &ar9160_adc_init_dc_cal;
125	AH5416(ah)->ah_cal.suppCals = ADC_GAIN_CAL | ADC_DC_CAL | IQ_MISMATCH_CAL;
126
127	if (!ar5416SetResetReg(ah, HAL_RESET_POWER_ON)) {
128		/* reset chip */
129		HALDEBUG(ah, HAL_DEBUG_ANY, "%s: couldn't reset chip\n",
130		    __func__);
131		ecode = HAL_EIO;
132		goto bad;
133	}
134
135	if (!ar5416SetPowerMode(ah, HAL_PM_AWAKE, AH_TRUE)) {
136		HALDEBUG(ah, HAL_DEBUG_ANY, "%s: couldn't wakeup chip\n",
137		    __func__);
138		ecode = HAL_EIO;
139		goto bad;
140	}
141	/* Read Revisions from Chips before taking out of reset */
142	val = OS_REG_READ(ah, AR_SREV);
143	HALDEBUG(ah, HAL_DEBUG_ATTACH,
144	    "%s: ID 0x%x VERSION 0x%x TYPE 0x%x REVISION 0x%x\n",
145	    __func__, MS(val, AR_XSREV_ID), MS(val, AR_XSREV_VERSION),
146	    MS(val, AR_XSREV_TYPE), MS(val, AR_XSREV_REVISION));
147	/* NB: include chip type to differentiate from pre-Sowl versions */
148	AH_PRIVATE(ah)->ah_macVersion =
149	    (val & AR_XSREV_VERSION) >> AR_XSREV_TYPE_S;
150	AH_PRIVATE(ah)->ah_macRev = MS(val, AR_XSREV_REVISION);
151	/* XXX extract pcie info */
152
153	/* setup common ini data; rf backends handle remainder */
154	HAL_INI_INIT(&ahp->ah_ini_modes, ar9160Modes, 6);
155	HAL_INI_INIT(&ahp->ah_ini_common, ar9160Common, 2);
156
157	HAL_INI_INIT(&AH5416(ah)->ah_ini_bb_rfgain, ar9160BB_RfGain, 3);
158	HAL_INI_INIT(&AH5416(ah)->ah_ini_bank0, ar9160Bank0, 2);
159	HAL_INI_INIT(&AH5416(ah)->ah_ini_bank1, ar9160Bank1, 2);
160	HAL_INI_INIT(&AH5416(ah)->ah_ini_bank2, ar9160Bank2, 2);
161	HAL_INI_INIT(&AH5416(ah)->ah_ini_bank3, ar9160Bank3, 3);
162	HAL_INI_INIT(&AH5416(ah)->ah_ini_bank6, ar9160Bank6, 3);
163	HAL_INI_INIT(&AH5416(ah)->ah_ini_bank7, ar9160Bank7, 2);
164	if (AR_SREV_SOWL_11(ah))
165		HAL_INI_INIT(&AH5416(ah)->ah_ini_addac, ar9160Addac_1_1, 2);
166	else
167		HAL_INI_INIT(&AH5416(ah)->ah_ini_addac, ar9160Addac, 2);
168
169	ecode = ath_hal_v14EepromAttach(ah);
170	if (ecode != HAL_OK)
171		goto bad;
172
173	if (!ar5416ChipReset(ah, AH_NULL)) {	/* reset chip */
174		HALDEBUG(ah, HAL_DEBUG_ANY, "%s: chip reset failed\n", __func__);
175		ecode = HAL_EIO;
176		goto bad;
177	}
178
179	AH_PRIVATE(ah)->ah_phyRev = OS_REG_READ(ah, AR_PHY_CHIP_ID);
180
181	if (!ar5212ChipTest(ah)) {
182		HALDEBUG(ah, HAL_DEBUG_ANY, "%s: hardware self-test failed\n",
183		    __func__);
184		ecode = HAL_ESELFTEST;
185		goto bad;
186	}
187
188	/*
189	 * Set correct Baseband to analog shift
190	 * setting to access analog chips.
191	 */
192	OS_REG_WRITE(ah, AR_PHY(0), 0x00000007);
193
194	/* Read Radio Chip Rev Extract */
195	AH_PRIVATE(ah)->ah_analog5GhzRev = ar5416GetRadioRev(ah);
196	switch (AH_PRIVATE(ah)->ah_analog5GhzRev & AR_RADIO_SREV_MAJOR) {
197        case AR_RAD2133_SREV_MAJOR:	/* Sowl: 2G/3x3 */
198	case AR_RAD5133_SREV_MAJOR:	/* Sowl: 2+5G/3x3 */
199		break;
200	default:
201		if (AH_PRIVATE(ah)->ah_analog5GhzRev == 0) {
202			AH_PRIVATE(ah)->ah_analog5GhzRev =
203				AR_RAD5133_SREV_MAJOR;
204			break;
205		}
206#ifdef AH_DEBUG
207		HALDEBUG(ah, HAL_DEBUG_ANY,
208		    "%s: 5G Radio Chip Rev 0x%02X is not supported by "
209		    "this driver\n", __func__,
210		    AH_PRIVATE(ah)->ah_analog5GhzRev);
211		ecode = HAL_ENOTSUPP;
212		goto bad;
213#endif
214	}
215	HALDEBUG(ah, HAL_DEBUG_ATTACH, "%s: Attaching AR2133 radio\n",
216	    __func__);
217	rfStatus = ar2133RfAttach(ah, &ecode);
218	if (!rfStatus) {
219		HALDEBUG(ah, HAL_DEBUG_ANY, "%s: RF setup failed, status %u\n",
220		    __func__, ecode);
221		goto bad;
222	}
223
224	/*
225	 * Got everything we need now to setup the capabilities.
226	 */
227	if (!ar9160FillCapabilityInfo(ah)) {
228		ecode = HAL_EEREAD;
229		goto bad;
230	}
231
232	ecode = ath_hal_eepromGet(ah, AR_EEP_MACADDR, ahp->ah_macaddr);
233	if (ecode != HAL_OK) {
234		HALDEBUG(ah, HAL_DEBUG_ANY,
235		    "%s: error getting mac address from EEPROM\n", __func__);
236		goto bad;
237        }
238	/* XXX How about the serial number ? */
239	/* Read Reg Domain */
240	AH_PRIVATE(ah)->ah_currentRD =
241	    ath_hal_eepromGet(ah, AR_EEP_REGDMN_0, AH_NULL);
242
243	/*
244	 * ah_miscMode is populated by ar5416FillCapabilityInfo()
245	 * starting from griffin. Set here to make sure that
246	 * AR_MISC_MODE_MIC_NEW_LOC_ENABLE is set before a GTK is
247	 * placed into hardware.
248	 */
249	if (ahp->ah_miscMode != 0)
250		OS_REG_WRITE(ah, AR_MISC_MODE, ahp->ah_miscMode);
251
252	ar9160AniSetup(ah);			/* Anti Noise Immunity */
253	ar5416InitNfHistBuff(AH5416(ah)->ah_cal.nfCalHist);
254
255	HALDEBUG(ah, HAL_DEBUG_ATTACH, "%s: return\n", __func__);
256
257	return ah;
258bad:
259	if (ahp)
260		ar9160Detach((struct ath_hal *) ahp);
261	if (status)
262		*status = ecode;
263	return AH_NULL;
264}
265
266void
267ar9160Detach(struct ath_hal *ah)
268{
269	HALDEBUG(ah, HAL_DEBUG_ATTACH, "%s:\n", __func__);
270
271	HALASSERT(ah != AH_NULL);
272	HALASSERT(ah->ah_magic == AR5416_MAGIC);
273
274	ar5416Detach(ah);
275}
276
277/*
278 * Fill all software cached or static hardware state information.
279 * Return failure if capabilities are to come from EEPROM and
280 * cannot be read.
281 */
282static HAL_BOOL
283ar9160FillCapabilityInfo(struct ath_hal *ah)
284{
285	HAL_CAPABILITIES *pCap = &AH_PRIVATE(ah)->ah_caps;
286
287	if (!ar5416FillCapabilityInfo(ah))
288		return AH_FALSE;
289	pCap->halCSTSupport = AH_TRUE;
290	pCap->halRifsRxSupport = AH_TRUE;
291	pCap->halRifsTxSupport = AH_TRUE;
292	pCap->halRtsAggrLimit = 64*1024;	/* 802.11n max */
293	pCap->halExtChanDfsSupport = AH_TRUE;
294	pCap->halAutoSleepSupport = AH_FALSE;	/* XXX? */
295	return AH_TRUE;
296}
297
298static const char*
299ar9160Probe(uint16_t vendorid, uint16_t devid)
300{
301	if (vendorid == ATHEROS_VENDOR_ID && devid == AR9160_DEVID_PCI)
302		return "Atheros 9160";
303	return AH_NULL;
304}
305AH_CHIP(AR9160, ar9160Probe, ar9160Attach);
306