2 * Copyright (c) 2004-2008 Reyk Floeter <reyk@openbsd.org>
3 * Copyright (c) 2006-2008 Nick Kossifidis <mickflemm@gmail.com>
4 * Copyright (c) 2007-2008 Pavel Roskin <proski@gnu.org>
6 * Lightly modified for gPXE, July 2009, by Joshua Oreman <oremanj@rwcr.net>.
8 * Permission to use, copy, modify, and distribute this software for any
9 * purpose with or without fee is hereby granted, provided that the above
10 * copyright notice and this permission notice appear in all copies.
12 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
24 /******************************\
25 Hardware Descriptor Functions
26 \******************************/
39 * Initialize the 2-word tx control descriptor on 5210/5211
42 ath5k_hw_setup_2word_tx_desc(struct ath5k_hw
*ah
, struct ath5k_desc
*desc
,
43 unsigned int pkt_len
, unsigned int hdr_len
, enum ath5k_pkt_type type
,
44 unsigned int tx_power __unused
, unsigned int tx_rate0
, unsigned int tx_tries0
,
45 unsigned int key_index __unused
, unsigned int antenna_mode
, unsigned int flags
,
46 unsigned int rtscts_rate __unused
, unsigned int rtscts_duration
)
49 struct ath5k_hw_2w_tx_ctl
*tx_ctl
;
50 unsigned int frame_len
;
52 tx_ctl
= &desc
->ud
.ds_tx5210
.tx_ctl
;
56 * - Zero retries don't make sense.
57 * - A zero rate will put the HW into a mode where it continously sends
58 * noise on the channel, so it is important to avoid this.
61 DBG("ath5k: zero retries\n");
65 DBG("ath5k: zero rate\n");
69 /* Clear descriptor */
70 memset(&desc
->ud
.ds_tx5210
, 0, sizeof(struct ath5k_hw_5210_tx_desc
));
72 /* Setup control descriptor */
74 /* Verify and set frame length */
76 frame_len
= pkt_len
+ FCS_LEN
;
78 if (frame_len
& ~AR5K_2W_TX_DESC_CTL0_FRAME_LEN
)
81 tx_ctl
->tx_control_0
= frame_len
& AR5K_2W_TX_DESC_CTL0_FRAME_LEN
;
83 /* Verify and set buffer length */
85 if (pkt_len
& ~AR5K_2W_TX_DESC_CTL1_BUF_LEN
)
88 tx_ctl
->tx_control_1
= pkt_len
& AR5K_2W_TX_DESC_CTL1_BUF_LEN
;
91 * Verify and set header length
92 * XXX: I only found that on 5210 code, does it work on 5211 ?
94 if (ah
->ah_version
== AR5K_AR5210
) {
95 if (hdr_len
& ~AR5K_2W_TX_DESC_CTL0_HEADER_LEN
)
97 tx_ctl
->tx_control_0
|=
98 AR5K_REG_SM(hdr_len
, AR5K_2W_TX_DESC_CTL0_HEADER_LEN
);
101 /*Diferences between 5210-5211*/
102 if (ah
->ah_version
== AR5K_AR5210
) {
104 case AR5K_PKT_TYPE_BEACON
:
105 case AR5K_PKT_TYPE_PROBE_RESP
:
106 frame_type
= AR5K_AR5210_TX_DESC_FRAME_TYPE_NO_DELAY
;
107 case AR5K_PKT_TYPE_PIFS
:
108 frame_type
= AR5K_AR5210_TX_DESC_FRAME_TYPE_PIFS
;
110 frame_type
= type
/*<< 2 ?*/;
113 tx_ctl
->tx_control_0
|=
114 AR5K_REG_SM(frame_type
, AR5K_2W_TX_DESC_CTL0_FRAME_TYPE
) |
115 AR5K_REG_SM(tx_rate0
, AR5K_2W_TX_DESC_CTL0_XMIT_RATE
);
118 tx_ctl
->tx_control_0
|=
119 AR5K_REG_SM(tx_rate0
, AR5K_2W_TX_DESC_CTL0_XMIT_RATE
) |
120 AR5K_REG_SM(antenna_mode
,
121 AR5K_2W_TX_DESC_CTL0_ANT_MODE_XMIT
);
122 tx_ctl
->tx_control_1
|=
123 AR5K_REG_SM(type
, AR5K_2W_TX_DESC_CTL1_FRAME_TYPE
);
125 #define _TX_FLAGS(_c, _flag) \
126 if (flags & AR5K_TXDESC_##_flag) { \
127 tx_ctl->tx_control_##_c |= \
128 AR5K_2W_TX_DESC_CTL##_c##_##_flag; \
131 _TX_FLAGS(0, CLRDMASK
);
133 _TX_FLAGS(0, INTREQ
);
134 _TX_FLAGS(0, RTSENA
);
140 * RTS/CTS Duration [5210 ?]
142 if ((ah
->ah_version
== AR5K_AR5210
) &&
143 (flags
& (AR5K_TXDESC_RTSENA
| AR5K_TXDESC_CTSENA
)))
144 tx_ctl
->tx_control_1
|= rtscts_duration
&
145 AR5K_2W_TX_DESC_CTL1_RTS_DURATION
;
151 * Initialize the 4-word tx control descriptor on 5212
153 static int ath5k_hw_setup_4word_tx_desc(struct ath5k_hw
*ah
,
154 struct ath5k_desc
*desc
, unsigned int pkt_len
, unsigned int hdr_len __unused
,
155 enum ath5k_pkt_type type
, unsigned int tx_power
, unsigned int tx_rate0
,
156 unsigned int tx_tries0
, unsigned int key_index __unused
,
157 unsigned int antenna_mode
, unsigned int flags
,
158 unsigned int rtscts_rate
,
159 unsigned int rtscts_duration
)
161 struct ath5k_hw_4w_tx_ctl
*tx_ctl
;
162 unsigned int frame_len
;
164 tx_ctl
= &desc
->ud
.ds_tx5212
.tx_ctl
;
168 * - Zero retries don't make sense.
169 * - A zero rate will put the HW into a mode where it continously sends
170 * noise on the channel, so it is important to avoid this.
172 if (tx_tries0
== 0) {
173 DBG("ath5k: zero retries\n");
177 DBG("ath5k: zero rate\n");
181 tx_power
+= ah
->ah_txpower
.txp_offset
;
182 if (tx_power
> AR5K_TUNE_MAX_TXPOWER
)
183 tx_power
= AR5K_TUNE_MAX_TXPOWER
;
185 /* Clear descriptor */
186 memset(&desc
->ud
.ds_tx5212
, 0, sizeof(struct ath5k_hw_5212_tx_desc
));
188 /* Setup control descriptor */
190 /* Verify and set frame length */
192 frame_len
= pkt_len
+ FCS_LEN
;
194 if (frame_len
& ~AR5K_4W_TX_DESC_CTL0_FRAME_LEN
)
197 tx_ctl
->tx_control_0
= frame_len
& AR5K_4W_TX_DESC_CTL0_FRAME_LEN
;
199 /* Verify and set buffer length */
201 if (pkt_len
& ~AR5K_4W_TX_DESC_CTL1_BUF_LEN
)
204 tx_ctl
->tx_control_1
= pkt_len
& AR5K_4W_TX_DESC_CTL1_BUF_LEN
;
206 tx_ctl
->tx_control_0
|=
207 AR5K_REG_SM(tx_power
, AR5K_4W_TX_DESC_CTL0_XMIT_POWER
) |
208 AR5K_REG_SM(antenna_mode
, AR5K_4W_TX_DESC_CTL0_ANT_MODE_XMIT
);
209 tx_ctl
->tx_control_1
|= AR5K_REG_SM(type
,
210 AR5K_4W_TX_DESC_CTL1_FRAME_TYPE
);
211 tx_ctl
->tx_control_2
= AR5K_REG_SM(tx_tries0
+ AR5K_TUNE_HWTXTRIES
,
212 AR5K_4W_TX_DESC_CTL2_XMIT_TRIES0
);
213 tx_ctl
->tx_control_3
= tx_rate0
& AR5K_4W_TX_DESC_CTL3_XMIT_RATE0
;
215 #define _TX_FLAGS(_c, _flag) \
216 if (flags & AR5K_TXDESC_##_flag) { \
217 tx_ctl->tx_control_##_c |= \
218 AR5K_4W_TX_DESC_CTL##_c##_##_flag; \
221 _TX_FLAGS(0, CLRDMASK
);
223 _TX_FLAGS(0, INTREQ
);
224 _TX_FLAGS(0, RTSENA
);
225 _TX_FLAGS(0, CTSENA
);
233 if (flags
& (AR5K_TXDESC_RTSENA
| AR5K_TXDESC_CTSENA
)) {
234 if ((flags
& AR5K_TXDESC_RTSENA
) &&
235 (flags
& AR5K_TXDESC_CTSENA
))
237 tx_ctl
->tx_control_2
|= rtscts_duration
&
238 AR5K_4W_TX_DESC_CTL2_RTS_DURATION
;
239 tx_ctl
->tx_control_3
|= AR5K_REG_SM(rtscts_rate
,
240 AR5K_4W_TX_DESC_CTL3_RTS_CTS_RATE
);
247 * Proccess the tx status descriptor on 5210/5211
249 static int ath5k_hw_proc_2word_tx_status(struct ath5k_hw
*ah __unused
,
250 struct ath5k_desc
*desc
, struct ath5k_tx_status
*ts
)
252 struct ath5k_hw_2w_tx_ctl
*tx_ctl
;
253 struct ath5k_hw_tx_status
*tx_status
;
255 tx_ctl
= &desc
->ud
.ds_tx5210
.tx_ctl
;
256 tx_status
= &desc
->ud
.ds_tx5210
.tx_stat
;
258 /* No frame has been send or error */
259 if ((tx_status
->tx_status_1
& AR5K_DESC_TX_STATUS1_DONE
) == 0)
263 * Get descriptor status
265 ts
->ts_tstamp
= AR5K_REG_MS(tx_status
->tx_status_0
,
266 AR5K_DESC_TX_STATUS0_SEND_TIMESTAMP
);
267 ts
->ts_shortretry
= AR5K_REG_MS(tx_status
->tx_status_0
,
268 AR5K_DESC_TX_STATUS0_SHORT_RETRY_COUNT
);
269 ts
->ts_longretry
= AR5K_REG_MS(tx_status
->tx_status_0
,
270 AR5K_DESC_TX_STATUS0_LONG_RETRY_COUNT
);
271 /*TODO: ts->ts_virtcol + test*/
272 ts
->ts_seqnum
= AR5K_REG_MS(tx_status
->tx_status_1
,
273 AR5K_DESC_TX_STATUS1_SEQ_NUM
);
274 ts
->ts_rssi
= AR5K_REG_MS(tx_status
->tx_status_1
,
275 AR5K_DESC_TX_STATUS1_ACK_SIG_STRENGTH
);
278 ts
->ts_rate
[0] = AR5K_REG_MS(tx_ctl
->tx_control_0
,
279 AR5K_2W_TX_DESC_CTL0_XMIT_RATE
);
280 ts
->ts_retry
[0] = ts
->ts_longretry
;
281 ts
->ts_final_idx
= 0;
283 if (!(tx_status
->tx_status_0
& AR5K_DESC_TX_STATUS0_FRAME_XMIT_OK
)) {
284 if (tx_status
->tx_status_0
&
285 AR5K_DESC_TX_STATUS0_EXCESSIVE_RETRIES
)
286 ts
->ts_status
|= AR5K_TXERR_XRETRY
;
288 if (tx_status
->tx_status_0
& AR5K_DESC_TX_STATUS0_FIFO_UNDERRUN
)
289 ts
->ts_status
|= AR5K_TXERR_FIFO
;
291 if (tx_status
->tx_status_0
& AR5K_DESC_TX_STATUS0_FILTERED
)
292 ts
->ts_status
|= AR5K_TXERR_FILT
;
299 * Proccess a tx status descriptor on 5212
301 static int ath5k_hw_proc_4word_tx_status(struct ath5k_hw
*ah __unused
,
302 struct ath5k_desc
*desc
, struct ath5k_tx_status
*ts
)
304 struct ath5k_hw_4w_tx_ctl
*tx_ctl
;
305 struct ath5k_hw_tx_status
*tx_status
;
307 tx_ctl
= &desc
->ud
.ds_tx5212
.tx_ctl
;
308 tx_status
= &desc
->ud
.ds_tx5212
.tx_stat
;
310 /* No frame has been send or error */
311 if (!(tx_status
->tx_status_1
& AR5K_DESC_TX_STATUS1_DONE
))
315 * Get descriptor status
317 ts
->ts_tstamp
= AR5K_REG_MS(tx_status
->tx_status_0
,
318 AR5K_DESC_TX_STATUS0_SEND_TIMESTAMP
);
319 ts
->ts_shortretry
= AR5K_REG_MS(tx_status
->tx_status_0
,
320 AR5K_DESC_TX_STATUS0_SHORT_RETRY_COUNT
);
321 ts
->ts_longretry
= AR5K_REG_MS(tx_status
->tx_status_0
,
322 AR5K_DESC_TX_STATUS0_LONG_RETRY_COUNT
);
323 ts
->ts_seqnum
= AR5K_REG_MS(tx_status
->tx_status_1
,
324 AR5K_DESC_TX_STATUS1_SEQ_NUM
);
325 ts
->ts_rssi
= AR5K_REG_MS(tx_status
->tx_status_1
,
326 AR5K_DESC_TX_STATUS1_ACK_SIG_STRENGTH
);
327 ts
->ts_antenna
= (tx_status
->tx_status_1
&
328 AR5K_DESC_TX_STATUS1_XMIT_ANTENNA
) ? 2 : 1;
331 ts
->ts_final_idx
= AR5K_REG_MS(tx_status
->tx_status_1
,
332 AR5K_DESC_TX_STATUS1_FINAL_TS_INDEX
);
334 ts
->ts_retry
[0] = ts
->ts_longretry
;
335 ts
->ts_rate
[0] = tx_ctl
->tx_control_3
&
336 AR5K_4W_TX_DESC_CTL3_XMIT_RATE0
;
339 if (!(tx_status
->tx_status_0
& AR5K_DESC_TX_STATUS0_FRAME_XMIT_OK
)) {
340 if (tx_status
->tx_status_0
&
341 AR5K_DESC_TX_STATUS0_EXCESSIVE_RETRIES
)
342 ts
->ts_status
|= AR5K_TXERR_XRETRY
;
344 if (tx_status
->tx_status_0
& AR5K_DESC_TX_STATUS0_FIFO_UNDERRUN
)
345 ts
->ts_status
|= AR5K_TXERR_FIFO
;
347 if (tx_status
->tx_status_0
& AR5K_DESC_TX_STATUS0_FILTERED
)
348 ts
->ts_status
|= AR5K_TXERR_FILT
;
359 * Initialize an rx control descriptor
361 static int ath5k_hw_setup_rx_desc(struct ath5k_hw
*ah __unused
,
362 struct ath5k_desc
*desc
,
363 u32 size
, unsigned int flags
)
365 struct ath5k_hw_rx_ctl
*rx_ctl
;
367 rx_ctl
= &desc
->ud
.ds_rx
.rx_ctl
;
370 * Clear the descriptor
371 * If we don't clean the status descriptor,
372 * while scanning we get too many results,
373 * most of them virtual, after some secs
374 * of scanning system hangs. M.F.
376 memset(&desc
->ud
.ds_rx
, 0, sizeof(struct ath5k_hw_all_rx_desc
));
378 /* Setup descriptor */
379 rx_ctl
->rx_control_1
= size
& AR5K_DESC_RX_CTL1_BUF_LEN
;
380 if (rx_ctl
->rx_control_1
!= size
)
383 if (flags
& AR5K_RXDESC_INTREQ
)
384 rx_ctl
->rx_control_1
|= AR5K_DESC_RX_CTL1_INTREQ
;
390 * Proccess the rx status descriptor on 5210/5211
392 static int ath5k_hw_proc_5210_rx_status(struct ath5k_hw
*ah __unused
,
393 struct ath5k_desc
*desc
, struct ath5k_rx_status
*rs
)
395 struct ath5k_hw_rx_status
*rx_status
;
397 rx_status
= &desc
->ud
.ds_rx
.u
.rx_stat
;
399 /* No frame received / not ready */
400 if (!(rx_status
->rx_status_1
& AR5K_5210_RX_DESC_STATUS1_DONE
))
404 * Frame receive status
406 rs
->rs_datalen
= rx_status
->rx_status_0
&
407 AR5K_5210_RX_DESC_STATUS0_DATA_LEN
;
408 rs
->rs_rssi
= AR5K_REG_MS(rx_status
->rx_status_0
,
409 AR5K_5210_RX_DESC_STATUS0_RECEIVE_SIGNAL
);
410 rs
->rs_rate
= AR5K_REG_MS(rx_status
->rx_status_0
,
411 AR5K_5210_RX_DESC_STATUS0_RECEIVE_RATE
);
412 rs
->rs_antenna
= AR5K_REG_MS(rx_status
->rx_status_0
,
413 AR5K_5210_RX_DESC_STATUS0_RECEIVE_ANTENNA
);
414 rs
->rs_more
= !!(rx_status
->rx_status_0
&
415 AR5K_5210_RX_DESC_STATUS0_MORE
);
416 /* TODO: this timestamp is 13 bit, later on we assume 15 bit */
417 rs
->rs_tstamp
= AR5K_REG_MS(rx_status
->rx_status_1
,
418 AR5K_5210_RX_DESC_STATUS1_RECEIVE_TIMESTAMP
);
421 rs
->rs_keyix
= AR5K_RXKEYIX_INVALID
;
424 * Receive/descriptor errors
426 if (!(rx_status
->rx_status_1
&
427 AR5K_5210_RX_DESC_STATUS1_FRAME_RECEIVE_OK
)) {
428 if (rx_status
->rx_status_1
&
429 AR5K_5210_RX_DESC_STATUS1_CRC_ERROR
)
430 rs
->rs_status
|= AR5K_RXERR_CRC
;
432 if (rx_status
->rx_status_1
&
433 AR5K_5210_RX_DESC_STATUS1_FIFO_OVERRUN
)
434 rs
->rs_status
|= AR5K_RXERR_FIFO
;
436 if (rx_status
->rx_status_1
&
437 AR5K_5210_RX_DESC_STATUS1_PHY_ERROR
) {
438 rs
->rs_status
|= AR5K_RXERR_PHY
;
439 rs
->rs_phyerr
|= AR5K_REG_MS(rx_status
->rx_status_1
,
440 AR5K_5210_RX_DESC_STATUS1_PHY_ERROR
);
443 if (rx_status
->rx_status_1
&
444 AR5K_5210_RX_DESC_STATUS1_DECRYPT_CRC_ERROR
)
445 rs
->rs_status
|= AR5K_RXERR_DECRYPT
;
452 * Proccess the rx status descriptor on 5212
454 static int ath5k_hw_proc_5212_rx_status(struct ath5k_hw
*ah __unused
,
455 struct ath5k_desc
*desc
, struct ath5k_rx_status
*rs
)
457 struct ath5k_hw_rx_status
*rx_status
;
458 struct ath5k_hw_rx_error
*rx_err
;
460 rx_status
= &desc
->ud
.ds_rx
.u
.rx_stat
;
462 /* Overlay on error */
463 rx_err
= &desc
->ud
.ds_rx
.u
.rx_err
;
465 /* No frame received / not ready */
466 if (!(rx_status
->rx_status_1
& AR5K_5212_RX_DESC_STATUS1_DONE
))
470 * Frame receive status
472 rs
->rs_datalen
= rx_status
->rx_status_0
&
473 AR5K_5212_RX_DESC_STATUS0_DATA_LEN
;
474 rs
->rs_rssi
= AR5K_REG_MS(rx_status
->rx_status_0
,
475 AR5K_5212_RX_DESC_STATUS0_RECEIVE_SIGNAL
);
476 rs
->rs_rate
= AR5K_REG_MS(rx_status
->rx_status_0
,
477 AR5K_5212_RX_DESC_STATUS0_RECEIVE_RATE
);
478 rs
->rs_antenna
= AR5K_REG_MS(rx_status
->rx_status_0
,
479 AR5K_5212_RX_DESC_STATUS0_RECEIVE_ANTENNA
);
480 rs
->rs_more
= !!(rx_status
->rx_status_0
&
481 AR5K_5212_RX_DESC_STATUS0_MORE
);
482 rs
->rs_tstamp
= AR5K_REG_MS(rx_status
->rx_status_1
,
483 AR5K_5212_RX_DESC_STATUS1_RECEIVE_TIMESTAMP
);
486 rs
->rs_keyix
= AR5K_RXKEYIX_INVALID
;
489 * Receive/descriptor errors
491 if (!(rx_status
->rx_status_1
&
492 AR5K_5212_RX_DESC_STATUS1_FRAME_RECEIVE_OK
)) {
493 if (rx_status
->rx_status_1
&
494 AR5K_5212_RX_DESC_STATUS1_CRC_ERROR
)
495 rs
->rs_status
|= AR5K_RXERR_CRC
;
497 if (rx_status
->rx_status_1
&
498 AR5K_5212_RX_DESC_STATUS1_PHY_ERROR
) {
499 rs
->rs_status
|= AR5K_RXERR_PHY
;
500 rs
->rs_phyerr
|= AR5K_REG_MS(rx_err
->rx_error_1
,
501 AR5K_RX_DESC_ERROR1_PHY_ERROR_CODE
);
504 if (rx_status
->rx_status_1
&
505 AR5K_5212_RX_DESC_STATUS1_DECRYPT_CRC_ERROR
)
506 rs
->rs_status
|= AR5K_RXERR_DECRYPT
;
508 if (rx_status
->rx_status_1
&
509 AR5K_5212_RX_DESC_STATUS1_MIC_ERROR
)
510 rs
->rs_status
|= AR5K_RXERR_MIC
;
517 * Init function pointers inside ath5k_hw struct
519 int ath5k_hw_init_desc_functions(struct ath5k_hw
*ah
)
522 if (ah
->ah_version
!= AR5K_AR5210
&&
523 ah
->ah_version
!= AR5K_AR5211
&&
524 ah
->ah_version
!= AR5K_AR5212
)
527 if (ah
->ah_version
== AR5K_AR5212
) {
528 ah
->ah_setup_rx_desc
= ath5k_hw_setup_rx_desc
;
529 ah
->ah_setup_tx_desc
= ath5k_hw_setup_4word_tx_desc
;
530 ah
->ah_proc_tx_desc
= ath5k_hw_proc_4word_tx_status
;
532 ah
->ah_setup_rx_desc
= ath5k_hw_setup_rx_desc
;
533 ah
->ah_setup_tx_desc
= ath5k_hw_setup_2word_tx_desc
;
534 ah
->ah_proc_tx_desc
= ath5k_hw_proc_2word_tx_status
;
537 if (ah
->ah_version
== AR5K_AR5212
)
538 ah
->ah_proc_rx_desc
= ath5k_hw_proc_5212_rx_status
;
539 else if (ah
->ah_version
<= AR5K_AR5211
)
540 ah
->ah_proc_rx_desc
= ath5k_hw_proc_5210_rx_status
;