xref: /freebsd/sys/dev/ath/ath_hal/ar5211/ar5211_recv.c (revision 7afb8adff33d47f10a11368ff54bb2eec5b30165)
1 /*
2  * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
3  * Copyright (c) 2002-2006 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 #include "ah_desc.h"
24 
25 #include "ar5211/ar5211.h"
26 #include "ar5211/ar5211reg.h"
27 #include "ar5211/ar5211desc.h"
28 
29 /*
30  * Get the RXDP.
31  */
32 uint32_t
33 ar5211GetRxDP(struct ath_hal *ah, HAL_RX_QUEUE qtype)
34 {
35 
36 	HALASSERT(qtype == HAL_RX_QUEUE_HP);
37 	return OS_REG_READ(ah, AR_RXDP);
38 }
39 
40 /*
41  * Set the RxDP.
42  */
43 void
44 ar5211SetRxDP(struct ath_hal *ah, uint32_t rxdp, HAL_RX_QUEUE qtype)
45 {
46 
47 	HALASSERT(qtype == HAL_RX_QUEUE_HP);
48 	OS_REG_WRITE(ah, AR_RXDP, rxdp);
49 	HALASSERT(OS_REG_READ(ah, AR_RXDP) == rxdp);
50 }
51 
52 
53 /*
54  * Set Receive Enable bits.
55  */
56 void
57 ar5211EnableReceive(struct ath_hal *ah)
58 {
59 	OS_REG_WRITE(ah, AR_CR, AR_CR_RXE);
60 }
61 
62 /*
63  * Stop Receive at the DMA engine
64  */
65 HAL_BOOL
66 ar5211StopDmaReceive(struct ath_hal *ah)
67 {
68 	OS_REG_WRITE(ah, AR_CR, AR_CR_RXD);	/* Set receive disable bit */
69 	if (!ath_hal_wait(ah, AR_CR, AR_CR_RXE, 0)) {
70 #ifdef AH_DEBUG
71 		ath_hal_printf(ah, "%s failed to stop in 10ms\n"
72 				   "AR_CR=0x%08X\nAR_DIAG_SW=0x%08X\n"
73 				   , __func__
74 				   , OS_REG_READ(ah, AR_CR)
75 				   , OS_REG_READ(ah, AR_DIAG_SW)
76 		);
77 #endif
78 		return AH_FALSE;
79 	} else {
80 		return AH_TRUE;
81 	}
82 }
83 
84 /*
85  * Start Transmit at the PCU engine (unpause receive)
86  */
87 void
88 ar5211StartPcuReceive(struct ath_hal *ah)
89 {
90 	OS_REG_WRITE(ah, AR_DIAG_SW,
91 		OS_REG_READ(ah, AR_DIAG_SW) & ~(AR_DIAG_SW_DIS_RX));
92 }
93 
94 /*
95  * Stop Transmit at the PCU engine (pause receive)
96  */
97 void
98 ar5211StopPcuReceive(struct ath_hal *ah)
99 {
100 	OS_REG_WRITE(ah, AR_DIAG_SW,
101 		OS_REG_READ(ah, AR_DIAG_SW) | AR_DIAG_SW_DIS_RX);
102 }
103 
104 /*
105  * Set multicast filter 0 (lower 32-bits)
106  *			   filter 1 (upper 32-bits)
107  */
108 void
109 ar5211SetMulticastFilter(struct ath_hal *ah, uint32_t filter0, uint32_t filter1)
110 {
111 	OS_REG_WRITE(ah, AR_MCAST_FIL0, filter0);
112 	OS_REG_WRITE(ah, AR_MCAST_FIL1, filter1);
113 }
114 
115 /*
116  * Clear multicast filter by index
117  */
118 HAL_BOOL
119 ar5211ClrMulticastFilterIndex(struct ath_hal *ah, uint32_t ix)
120 {
121 	uint32_t val;
122 
123 	if (ix >= 64)
124 		return AH_FALSE;
125 	if (ix >= 32) {
126 		val = OS_REG_READ(ah, AR_MCAST_FIL1);
127 		OS_REG_WRITE(ah, AR_MCAST_FIL1, (val &~ (1<<(ix-32))));
128 	} else {
129 		val = OS_REG_READ(ah, AR_MCAST_FIL0);
130 		OS_REG_WRITE(ah, AR_MCAST_FIL0, (val &~ (1<<ix)));
131 	}
132 	return AH_TRUE;
133 }
134 
135 /*
136  * Set multicast filter by index
137  */
138 HAL_BOOL
139 ar5211SetMulticastFilterIndex(struct ath_hal *ah, uint32_t ix)
140 {
141 	uint32_t val;
142 
143 	if (ix >= 64)
144 		return AH_FALSE;
145 	if (ix >= 32) {
146 		val = OS_REG_READ(ah, AR_MCAST_FIL1);
147 		OS_REG_WRITE(ah, AR_MCAST_FIL1, (val | (1<<(ix-32))));
148 	} else {
149 		val = OS_REG_READ(ah, AR_MCAST_FIL0);
150 		OS_REG_WRITE(ah, AR_MCAST_FIL0, (val | (1<<ix)));
151 	}
152 	return AH_TRUE;
153 }
154 
155 /*
156  * Get receive filter.
157  */
158 uint32_t
159 ar5211GetRxFilter(struct ath_hal *ah)
160 {
161 	return OS_REG_READ(ah, AR_RX_FILTER);
162 }
163 
164 /*
165  * Set receive filter.
166  */
167 void
168 ar5211SetRxFilter(struct ath_hal *ah, uint32_t bits)
169 {
170 	OS_REG_WRITE(ah, AR_RX_FILTER, bits);
171 }
172 
173 /*
174  * Initialize RX descriptor, by clearing the status and clearing
175  * the size.  This is not strictly HW dependent, but we want the
176  * control and status words to be opaque above the hal.
177  */
178 HAL_BOOL
179 ar5211SetupRxDesc(struct ath_hal *ah, struct ath_desc *ds,
180 	uint32_t size, u_int flags)
181 {
182 	struct ar5211_desc *ads = AR5211DESC(ds);
183 
184 	ads->ds_ctl0 = 0;
185 	ads->ds_ctl1 = size & AR_BufLen;
186 	if (ads->ds_ctl1 != size) {
187 		HALDEBUG(ah, HAL_DEBUG_ANY, "%s: buffer size %u too large\n",
188 		    __func__, size);
189 		return AH_FALSE;
190 	}
191 	if (flags & HAL_RXDESC_INTREQ)
192 		ads->ds_ctl1 |= AR_RxInterReq;
193 	ads->ds_status0 = ads->ds_status1 = 0;
194 
195 	return AH_TRUE;
196 }
197 
198 /*
199  * Process an RX descriptor, and return the status to the caller.
200  * Copy some hardware specific items into the software portion
201  * of the descriptor.
202  *
203  * NB: the caller is responsible for validating the memory contents
204  *     of the descriptor (e.g. flushing any cached copy).
205  */
206 HAL_STATUS
207 ar5211ProcRxDesc(struct ath_hal *ah, struct ath_desc *ds,
208 	uint32_t pa, struct ath_desc *nds, uint64_t tsf,
209 	struct ath_rx_status *rs)
210 {
211 	struct ar5211_desc *ads = AR5211DESC(ds);
212 	struct ar5211_desc *ands = AR5211DESC(nds);
213 
214 	if ((ads->ds_status1 & AR_Done) == 0)
215 		return HAL_EINPROGRESS;
216 	/*
217 	 * Given the use of a self-linked tail be very sure that the hw is
218 	 * done with this descriptor; the hw may have done this descriptor
219 	 * once and picked it up again...make sure the hw has moved on.
220 	 */
221 	if ((ands->ds_status1 & AR_Done) == 0 && OS_REG_READ(ah, AR_RXDP) == pa)
222 		return HAL_EINPROGRESS;
223 
224 	rs->rs_datalen = ads->ds_status0 & AR_DataLen;
225 	rs->rs_tstamp = MS(ads->ds_status1, AR_RcvTimestamp);
226 	rs->rs_status = 0;
227 	if ((ads->ds_status1 & AR_FrmRcvOK) == 0) {
228 		if (ads->ds_status1 & AR_CRCErr)
229 			rs->rs_status |= HAL_RXERR_CRC;
230 		else if (ads->ds_status1 & AR_DecryptCRCErr)
231 			rs->rs_status |= HAL_RXERR_DECRYPT;
232 		else {
233 			rs->rs_status |= HAL_RXERR_PHY;
234 			rs->rs_phyerr = MS(ads->ds_status1, AR_PHYErr);
235 		}
236 	}
237 	/* XXX what about KeyCacheMiss? */
238 	rs->rs_rssi = MS(ads->ds_status0, AR_RcvSigStrength);
239 	if (ads->ds_status1 & AR_KeyIdxValid)
240 		rs->rs_keyix = MS(ads->ds_status1, AR_KeyIdx);
241 	else
242 		rs->rs_keyix = HAL_RXKEYIX_INVALID;
243 	/* NB: caller expected to do rate table mapping */
244 	rs->rs_rate = MS(ads->ds_status0, AR_RcvRate);
245 	rs->rs_antenna  = MS(ads->ds_status0, AR_RcvAntenna);
246 	rs->rs_more = (ads->ds_status0 & AR_More) ? 1 : 0;
247 
248 	return HAL_OK;
249 }
250