1 /*
2  * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
3  * Copyright (c) 2002-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$
18  */
19 #include "opt_ah.h"
20 
21 #include "ah.h"
22 #include "ah_internal.h"
23 
24 #include "ar5416/ar5416.h"
25 #include "ar5416/ar5416reg.h"
26 #include "ar5416/ar5416phy.h"
27 
28 #define TU_TO_USEC(_tu)		((_tu) << 10)
29 #define	ONE_EIGHTH_TU_TO_USEC(_tu8)	((_tu8) << 7)
30 
31 /*
32  * Return the hardware NextTBTT in TSF
33  */
34 uint64_t
35 ar5416GetNextTBTT(struct ath_hal *ah)
36 {
37 	return OS_REG_READ(ah, AR_NEXT_TBTT);
38 }
39 
40 /*
41  * Initialize all of the hardware registers used to
42  * send beacons.  Note that for station operation the
43  * driver calls ar5416SetStaBeaconTimers instead.
44  */
45 void
46 ar5416SetBeaconTimers(struct ath_hal *ah, const HAL_BEACON_TIMERS *bt)
47 {
48 	uint32_t bperiod;
49 	struct ath_hal_5212 *ahp = AH5212(ah);
50 
51 	OS_REG_WRITE(ah, AR_NEXT_TBTT, TU_TO_USEC(bt->bt_nexttbtt));
52 	OS_REG_WRITE(ah, AR_NEXT_DBA, ONE_EIGHTH_TU_TO_USEC(bt->bt_nextdba));
53 	OS_REG_WRITE(ah, AR_NEXT_SWBA, ONE_EIGHTH_TU_TO_USEC(bt->bt_nextswba));
54 	OS_REG_WRITE(ah, AR_NEXT_NDP, TU_TO_USEC(bt->bt_nextatim));
55 
56 	bperiod = TU_TO_USEC(bt->bt_intval & HAL_BEACON_PERIOD);
57 	ahp->ah_beaconInterval = bt->bt_intval & HAL_BEACON_PERIOD;
58 	OS_REG_WRITE(ah, AR5416_BEACON_PERIOD, bperiod);
59 	OS_REG_WRITE(ah, AR_DBA_PERIOD, bperiod);
60 	OS_REG_WRITE(ah, AR_SWBA_PERIOD, bperiod);
61 	OS_REG_WRITE(ah, AR_NDP_PERIOD, bperiod);
62 
63 	/*
64 	 * Reset TSF if required.
65 	 */
66 	if (bt->bt_intval & AR_BEACON_RESET_TSF)
67 		ar5416ResetTsf(ah);
68 
69 	/* enable timers */
70 	/* NB: flags == 0 handled specially for backwards compatibility */
71 	OS_REG_SET_BIT(ah, AR_TIMER_MODE,
72 	    bt->bt_flags != 0 ? bt->bt_flags :
73 		AR_TIMER_MODE_TBTT | AR_TIMER_MODE_DBA | AR_TIMER_MODE_SWBA);
74 }
75 
76 /*
77  * Initializes all of the hardware registers used to
78  * send beacons.  Note that for station operation the
79  * driver calls ar5212SetStaBeaconTimers instead.
80  */
81 void
82 ar5416BeaconInit(struct ath_hal *ah,
83 	uint32_t next_beacon, uint32_t beacon_period)
84 {
85 	HAL_BEACON_TIMERS bt;
86 
87 	bzero(&bt, sizeof(bt));	/* avoid gcc warnings */
88 	bt.bt_nexttbtt = next_beacon;
89 	/*
90 	 * TIMER1: in AP/adhoc mode this controls the DMA beacon
91 	 * alert timer; otherwise it controls the next wakeup time.
92 	 * TIMER2: in AP mode, it controls the SBA beacon alert
93 	 * interrupt; otherwise it sets the start of the next CFP.
94 	 */
95 	bt.bt_flags = 0;
96 	switch (AH_PRIVATE(ah)->ah_opmode) {
97 	case HAL_M_STA:
98 	case HAL_M_MONITOR:
99 		bt.bt_nextdba = 0xffff;
100 		bt.bt_nextswba = 0x7ffff;
101 		bt.bt_flags |= AR_TIMER_MODE_TBTT;
102 		break;
103 	case HAL_M_IBSS:
104 		OS_REG_SET_BIT(ah, AR_TXCFG, AR_TXCFG_ATIM_TXPOLICY);
105 		bt.bt_flags |= AR_TIMER_MODE_NDP;
106 		/* fall thru... */
107 	case HAL_M_HOSTAP:
108 		bt.bt_nextdba = (next_beacon -
109 		    ah->ah_config.ah_dma_beacon_response_time) << 3;	/* 1/8 TU */
110 		bt.bt_nextswba = (next_beacon -
111 		    ah->ah_config.ah_sw_beacon_response_time) << 3;	/* 1/8 TU */
112 		bt.bt_flags |= AR_TIMER_MODE_TBTT
113 			    |  AR_TIMER_MODE_DBA
114 			    |  AR_TIMER_MODE_SWBA;
115 		break;
116 	}
117 	/*
118 	 * Set the ATIM window
119 	 * Our hardware does not support an ATIM window of 0
120 	 * (beacons will not work).  If the ATIM windows is 0,
121 	 * force it to 1.
122 	 */
123 	bt.bt_nextatim = next_beacon + 1;
124 	bt.bt_intval = beacon_period &
125 		(AR_BEACON_PERIOD | AR_BEACON_RESET_TSF | AR_BEACON_EN);
126 	ar5416SetBeaconTimers(ah, &bt);
127 }
128 
129 #define AR_BEACON_PERIOD_MAX	0xffff
130 
131 void
132 ar5416ResetStaBeaconTimers(struct ath_hal *ah)
133 {
134 	uint32_t val;
135 
136 	OS_REG_WRITE(ah, AR_NEXT_TBTT, 0);		/* no beacons */
137 	val = OS_REG_READ(ah, AR_STA_ID1);
138 	val |= AR_STA_ID1_PWR_SAV;		/* XXX */
139 	/* tell the h/w that the associated AP is not PCF capable */
140 	OS_REG_WRITE(ah, AR_STA_ID1,
141 		val & ~(AR_STA_ID1_USE_DEFANT | AR_STA_ID1_PCF));
142 	OS_REG_WRITE(ah, AR5416_BEACON_PERIOD, AR_BEACON_PERIOD_MAX);
143 	OS_REG_WRITE(ah, AR_DBA_PERIOD, AR_BEACON_PERIOD_MAX);
144 }
145 
146 /*
147  * Set all the beacon related bits on the h/w for stations
148  * i.e. initializes the corresponding h/w timers;
149  * also tells the h/w whether to anticipate PCF beacons
150  */
151 void
152 ar5416SetStaBeaconTimers(struct ath_hal *ah, const HAL_BEACON_STATE *bs)
153 {
154 	uint32_t nextTbtt, nextdtim,beaconintval, dtimperiod;
155 
156 	HALASSERT(bs->bs_intval != 0);
157 
158 	/* NB: no cfp setting since h/w automatically takes care */
159 
160 	OS_REG_WRITE(ah, AR_NEXT_TBTT, TU_TO_USEC(bs->bs_nexttbtt));
161 
162 	/*
163 	 * Start the beacon timers by setting the BEACON register
164 	 * to the beacon interval; no need to write tim offset since
165 	 * h/w parses IEs.
166 	 */
167 	OS_REG_WRITE(ah, AR5416_BEACON_PERIOD,
168 			 TU_TO_USEC(bs->bs_intval & HAL_BEACON_PERIOD));
169 	OS_REG_WRITE(ah, AR_DBA_PERIOD,
170 			 TU_TO_USEC(bs->bs_intval & HAL_BEACON_PERIOD));
171 
172 	/*
173 	 * Configure the BMISS interrupt.  Note that we
174 	 * assume the caller blocks interrupts while enabling
175 	 * the threshold.
176 	 */
177 	HALASSERT(bs->bs_bmissthreshold <=
178 		(AR_RSSI_THR_BM_THR >> AR_RSSI_THR_BM_THR_S));
179 	OS_REG_RMW_FIELD(ah, AR_RSSI_THR,
180 		AR_RSSI_THR_BM_THR, bs->bs_bmissthreshold);
181 
182 	/*
183 	 * Program the sleep registers to correlate with the beacon setup.
184 	 */
185 
186 	/*
187 	 * Oahu beacons timers on the station were used for power
188 	 * save operation (waking up in anticipation of a beacon)
189 	 * and any CFP function; Venice does sleep/power-save timers
190 	 * differently - so this is the right place to set them up;
191 	 * don't think the beacon timers are used by venice sta hw
192 	 * for any useful purpose anymore
193 	 * Setup venice's sleep related timers
194 	 * Current implementation assumes sw processing of beacons -
195 	 *   assuming an interrupt is generated every beacon which
196 	 *   causes the hardware to become awake until the sw tells
197 	 *   it to go to sleep again; beacon timeout is to allow for
198 	 *   beacon jitter; cab timeout is max time to wait for cab
199 	 *   after seeing the last DTIM or MORE CAB bit
200 	 */
201 
202 /*
203  * I've bumped these to 30TU for now.
204  *
205  * Some APs (AR933x/AR934x?) in 2GHz especially seem to not always
206  * transmit beacon frames at exactly the right times and with it set
207  * to 10TU, the NIC starts not waking up at the right times to hear
208  * these slightly-larger-jitering beacons.  It also never recovers
209  * from that (it doesn't resync? I'm not sure.)
210  *
211  * So for now bump this to 30TU.  Ideally we'd cap this based on
212  * the beacon interval so the sum of CAB+BEACON timeouts never
213  * exceeded the beacon interval.
214  *
215  * Now, since we're doing all the math in the ath(4) driver in TU
216  * rather than TSF, we may be seeing the result of dumb rounding
217  * errors causing the jitter to actually be a much bigger problem.
218  * I'll have to investigate that with a fine tooth comb.
219  */
220 #define CAB_TIMEOUT_VAL     10 /* in TU */
221 #define BEACON_TIMEOUT_VAL  10 /* in TU */
222 #define SLEEP_SLOP          3  /* in TU */
223 
224 	/*
225 	 * For max powersave mode we may want to sleep for longer than a
226 	 * beacon period and not want to receive all beacons; modify the
227 	 * timers accordingly; make sure to align the next TIM to the
228 	 * next DTIM if we decide to wake for DTIMs only
229 	 */
230 	beaconintval = bs->bs_intval & HAL_BEACON_PERIOD;
231 	HALASSERT(beaconintval != 0);
232 	if (bs->bs_sleepduration > beaconintval) {
233 		HALASSERT(roundup(bs->bs_sleepduration, beaconintval) ==
234 				bs->bs_sleepduration);
235 		beaconintval = bs->bs_sleepduration;
236 	}
237 	dtimperiod = bs->bs_dtimperiod;
238 	if (bs->bs_sleepduration > dtimperiod) {
239 		HALASSERT(dtimperiod == 0 ||
240 			roundup(bs->bs_sleepduration, dtimperiod) ==
241 				bs->bs_sleepduration);
242 		dtimperiod = bs->bs_sleepduration;
243 	}
244 	HALASSERT(beaconintval <= dtimperiod);
245 	if (beaconintval == dtimperiod)
246 		nextTbtt = bs->bs_nextdtim;
247 	else
248 		nextTbtt = bs->bs_nexttbtt;
249 	nextdtim = bs->bs_nextdtim;
250 
251 	OS_REG_WRITE(ah, AR_NEXT_DTIM,
252 		TU_TO_USEC(bs->bs_nextdtim - SLEEP_SLOP));
253 	OS_REG_WRITE(ah, AR_NEXT_TIM, TU_TO_USEC(nextTbtt - SLEEP_SLOP));
254 
255 	/* cab timeout is now in 1/8 TU */
256 	OS_REG_WRITE(ah, AR5416_SLEEP1,
257 		SM((CAB_TIMEOUT_VAL << 3), AR5416_SLEEP1_CAB_TIMEOUT)
258 		| AR5416_SLEEP1_ASSUME_DTIM);
259 
260 	/* XXX autosleep? Use min beacon timeout; check ath9k -adrian */
261 	/* beacon timeout is now in 1/8 TU */
262 	OS_REG_WRITE(ah, AR5416_SLEEP2,
263 		SM((BEACON_TIMEOUT_VAL << 3), AR5416_SLEEP2_BEACON_TIMEOUT));
264 
265 	/* TIM_PERIOD and DTIM_PERIOD are now in uS. */
266 	OS_REG_WRITE(ah, AR_TIM_PERIOD, TU_TO_USEC(beaconintval));
267 	OS_REG_WRITE(ah, AR_DTIM_PERIOD, TU_TO_USEC(dtimperiod));
268 
269 	OS_REG_SET_BIT(ah, AR_TIMER_MODE,
270 	     AR_TIMER_MODE_TBTT | AR_TIMER_MODE_TIM | AR_TIMER_MODE_DTIM);
271 
272 #define	HAL_TSFOOR_THRESHOLD	0x00004240 /* TSF OOR threshold (16k us) */
273 
274 	/* TSF out of range threshold */
275 //	OS_REG_WRITE(ah, AR_TSFOOR_THRESHOLD, bs->bs_tsfoor_threshold);
276 	OS_REG_WRITE(ah, AR_TSFOOR_THRESHOLD, HAL_TSFOOR_THRESHOLD);
277 
278 	HALDEBUG(ah, HAL_DEBUG_BEACON, "%s: next DTIM %d\n",
279 	    __func__, bs->bs_nextdtim);
280 	HALDEBUG(ah, HAL_DEBUG_BEACON, "%s: next beacon %d\n",
281 	    __func__, nextTbtt);
282 	HALDEBUG(ah, HAL_DEBUG_BEACON, "%s: beacon period %d\n",
283 	    __func__, beaconintval);
284 	HALDEBUG(ah, HAL_DEBUG_BEACON, "%s: DTIM period %d\n",
285 	    __func__, dtimperiod);
286 #undef CAB_TIMEOUT_VAL
287 #undef BEACON_TIMEOUT_VAL
288 #undef SLEEP_SLOP
289 }
290