2 * carl9170 firmware - used by the ar9170 wireless device
4 * WLAN transmit and tx status
6 * Copyright (c) 2000-2005 ZyDAS Technology Corporation
7 * Copyright (c) 2007-2009 Atheros Communications, Inc.
8 * Copyright 2009 Johannes Berg <johannes@sipsolutions.net>
9 * Copyright 2009-2012 Christian Lamparter <chunkeey@googlemail.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 #include "shared/phy.h"
33 #include "linux/ieee80211.h"
36 static void wlan_txunstuck(unsigned int queue)
38 set_wlan_txq_dma_addr(queue, ((uint32_t) fw.wlan.tx_queue[queue].head) | 1);
41 #ifdef CONFIG_CARL9170FW_DMA_QUEUE_BUMP
42 static void wlan_txupdate(unsigned int queue)
44 set_wlan_txq_dma_addr(queue, ((uint32_t) fw.wlan.tx_queue[queue].head));
47 void wlan_dma_bump(unsigned int qidx)
49 unsigned int offset = qidx;
50 uint32_t status, trigger;
52 status = get(AR9170_MAC_REG_DMA_STATUS) >> 12;
53 trigger = get(AR9170_MAC_REG_DMA_TRIGGER) >> 12;
64 if ((trigger == 0xa) && (status == 0x8)) {
73 void wlan_dma_bump(unsigned int __unused qidx)
76 #endif /* CONFIG_CARL9170FW_DMA_QUEUE_BUMP */
78 void wlan_send_buffered_tx_status(void)
82 while (fw.wlan.tx_status_pending) {
83 len = min((unsigned int)fw.wlan.tx_status_pending,
84 CARL9170_RSP_TX_STATUS_NUM);
85 len = min(len, CARL9170_TX_STATUS_NUM - fw.wlan.tx_status_head_idx);
88 * rather than memcpy each individual request into a large buffer,
89 * we _splice_ them all together.
91 * The only downside is however that we have to be careful around
92 * the edges of the tx_status_cache.
95 * Each tx_status is about 2 bytes. However every command package
96 * must have a size which is a multiple of 4.
99 send_cmd_to_host((len * sizeof(struct carl9170_tx_status) + 3) & ~3,
100 CARL9170_RSP_TXCOMP, len, (void *)
101 &fw.wlan.tx_status_cache[fw.wlan.tx_status_head_idx]);
103 fw.wlan.tx_status_pending -= len;
104 fw.wlan.tx_status_head_idx += len;
105 fw.wlan.tx_status_head_idx %= CARL9170_TX_STATUS_NUM;
109 static struct carl9170_tx_status *wlan_get_tx_status_buffer(void)
111 struct carl9170_tx_status *tmp;
113 tmp = &fw.wlan.tx_status_cache[fw.wlan.tx_status_tail_idx++];
114 fw.wlan.tx_status_tail_idx %= CARL9170_TX_STATUS_NUM;
116 if (fw.wlan.tx_status_pending == CARL9170_TX_STATUS_NUM)
117 wlan_send_buffered_tx_status();
119 fw.wlan.tx_status_pending++;
124 /* generate _aggregated_ tx_status for the host */
125 void wlan_tx_complete(struct carl9170_tx_superframe *super,
128 struct carl9170_tx_status *status;
130 status = wlan_get_tx_status_buffer();
133 * The *unique* cookie and AC_ID is used by the driver for
136 status->cookie = super->s.cookie;
137 status->queue = super->s.queue;
141 * This field holds the number of tries of the rate in
142 * the rate index field (rix).
144 status->rix = super->s.rix;
145 status->tries = super->s.cnt;
146 status->success = (txs) ? 1 : 0;
149 static bool wlan_tx_consume_retry(struct carl9170_tx_superframe *super)
151 /* check if this was the last possible retry with this rate */
152 if (unlikely(super->s.cnt >= super->s.ri[super->s.rix].tries)) {
153 /* end of the road - indicate tx failure */
154 if (unlikely(super->s.rix == CARL9170_TX_MAX_RETRY_RATES))
157 /* check if there are alternative rates available */
158 if (!super->s.rr[super->s.rix].set)
161 /* try next retry rate */
162 super->f.hdr.phy.set = super->s.rr[super->s.rix].set;
164 /* finally - mark the old rate as USED */
167 /* update MAC flags */
168 super->f.hdr.mac.erp_prot = super->s.ri[super->s.rix].erp_prot;
169 super->f.hdr.mac.ampdu = super->s.ri[super->s.rix].ampdu;
171 /* reinitialize try counter */
174 /* just increase retry counter */
181 static inline u16 get_tid(struct ieee80211_hdr *hdr)
183 return (ieee80211_get_qos_ctl(hdr))[0] & IEEE80211_QOS_CTL_TID_MASK;
186 /* This function will only work on uint32_t-aligned pointers! */
187 static bool same_hdr(const void *_d0, const void *_d1)
189 const uint32_t *d0 = _d0;
190 const uint32_t *d1 = _d1;
192 /* BUG_ON((unsigned long)d0 & 3 || (unsigned long)d1 & 3)) */
193 return !((d0[0] ^ d1[0]) | /* FC + DU */
194 (d0[1] ^ d1[1]) | /* addr1 */
195 (d0[2] ^ d1[2]) | (d0[3] ^ d1[3]) | /* addr2 + addr3 */
196 (d0[4] ^ d1[4])); /* addr3 */
199 static inline bool same_aggr(struct ieee80211_hdr *a, struct ieee80211_hdr *b)
201 return (get_tid(a) == get_tid(b)) || same_hdr(a, b);
204 static void wlan_tx_ampdu_reset(unsigned int qidx)
206 fw.wlan.ampdu_prev[qidx] = NULL;
209 static void wlan_tx_ampdu_end(unsigned int qidx)
211 struct carl9170_tx_superframe *ht_prev = fw.wlan.ampdu_prev[qidx];
214 ht_prev->f.hdr.mac.ba_end = 1;
216 wlan_tx_ampdu_reset(qidx);
219 static void wlan_tx_ampdu(struct carl9170_tx_superframe *super)
221 unsigned int qidx = super->s.queue;
222 struct carl9170_tx_superframe *ht_prev = fw.wlan.ampdu_prev[qidx];
224 if (super->f.hdr.mac.ampdu) {
226 !same_aggr(&super->f.data.i3e, &ht_prev->f.data.i3e))
227 ht_prev->f.hdr.mac.ba_end = 1;
229 super->f.hdr.mac.ba_end = 0;
231 fw.wlan.ampdu_prev[qidx] = super;
233 wlan_tx_ampdu_end(qidx);
238 static void __wlan_tx(struct dma_desc *desc)
240 struct carl9170_tx_superframe *super = get_super(desc);
242 if (unlikely(super->s.fill_in_tsf)) {
243 struct ieee80211_mgmt *mgmt = (void *) &super->f.data.i3e;
244 uint32_t *tsf = (uint32_t *) &mgmt->u.probe_resp.timestamp;
247 * Truth be told: this is a hack.
249 * The *real* TSF is definitely going to be higher/older.
250 * But this hardware emulation code is head and shoulders
251 * above anything a driver can possibly do.
253 * (even, if it's got an accurate atomic clock source).
259 wlan_tx_ampdu(super);
261 #ifdef CONFIG_CARL9170FW_DEBUG
262 BUG_ON(fw.phy.psm.state != CARL9170_PSM_WAKE);
263 #endif /* CONFIG_CARL9170FW_DEBUG */
265 /* insert desc into the right queue */
266 dma_put(&fw.wlan.tx_queue[super->s.queue], desc);
269 static void wlan_assign_seq(struct ieee80211_hdr *hdr, unsigned int vif)
271 hdr->seq_ctrl &= cpu_to_le16(~IEEE80211_SCTL_SEQ);
272 hdr->seq_ctrl |= cpu_to_le16(fw.wlan.sequence[vif]);
274 if (ieee80211_is_first_frag(hdr->seq_ctrl))
275 fw.wlan.sequence[vif] += 0x10;
278 /* prepares frame for the first transmission */
279 static void _wlan_tx(struct dma_desc *desc)
281 struct carl9170_tx_superframe *super = get_super(desc);
283 if (unlikely(super->s.assign_seq))
284 wlan_assign_seq(&super->f.data.i3e, super->s.vif_id);
286 if (unlikely(super->s.ampdu_commit_density)) {
287 set(AR9170_MAC_REG_AMPDU_DENSITY,
288 MOD_VAL(AR9170_MAC_AMPDU_DENSITY,
289 get(AR9170_MAC_REG_AMPDU_DENSITY),
290 super->s.ampdu_density));
293 if (unlikely(super->s.ampdu_commit_factor)) {
294 set(AR9170_MAC_REG_AMPDU_FACTOR,
295 MOD_VAL(AR9170_MAC_AMPDU_FACTOR,
296 get(AR9170_MAC_REG_AMPDU_FACTOR),
297 8 << super->s.ampdu_factor));
301 /* propagate transmission status back to the driver */
302 static bool wlan_tx_status(struct dma_queue *queue,
303 struct dma_desc *desc)
305 struct carl9170_tx_superframe *super = get_super(desc);
306 unsigned int qidx = super->s.queue;
307 bool txfail = false, success;
311 /* update hangcheck */
312 fw.wlan.last_super_num[qidx] = 0;
316 * There could be a corner case when the TXFAIL is set
317 * even though the frame was properly ACKed by the peer:
318 * a BlockAckReq with the immediate policy will cause
319 * the receiving peer to produce a BlockACK unfortunately
320 * the MAC in this chip seems to be expecting a legacy
321 * ACK and marks the BAR as failed!
324 if (!!(desc->ctrl & AR9170_CTRL_FAIL)) {
325 txfail = !!(desc->ctrl & AR9170_CTRL_TXFAIL);
327 /* reset retry indicator flags */
328 desc->ctrl &= ~(AR9170_CTRL_TXFAIL | AR9170_CTRL_BAFAIL);
331 * Note: wlan_tx_consume_retry will override the old
332 * phy [CCK,OFDM, HT, BW20/40, MCS...] and mac vectors
333 * [AMPDU,RTS/CTS,...] therefore be careful when they
336 if (wlan_tx_consume_retry(super)) {
338 * retry for simple and aggregated 802.11 frames.
340 * Note: We must not mess up the original frame
344 if (!super->f.hdr.mac.ampdu) {
346 * 802.11 - 7.1.3.1.5.
347 * set "Retry Field" for consecutive attempts
349 * Note: For AMPDU see:
350 * 802.11n 9.9.1.6 "Retransmit Procedures"
352 super->f.data.i3e.frame_control |=
353 cpu_to_le16(IEEE80211_FCTL_RETRY);
357 /* Normal TX Failure */
359 /* demise descriptor ownership back to the hardware */
363 * And this will get the queue going again.
364 * To understand why: you have to get the HW
365 * specs... But sadly I never saw them.
367 wlan_txunstuck(qidx);
369 /* abort cycle - this is necessary due to HW design */
372 /* (HT-) BlockACK failure */
375 * Unlink the failed attempt and put it into
376 * the retry queue. The caller routine must
377 * be aware of this so the frames don't get lost.
380 #ifndef CONFIG_CARL9170FW_DEBUG
381 dma_unlink_head(queue);
382 #else /* CONFIG_CARL9170FW_DEBUG */
383 BUG_ON(dma_unlink_head(queue) != desc);
384 #endif /* CONFIG_CARL9170FW_DEBUG */
385 dma_put(&fw.wlan.tx_retry, desc);
389 /* out of frame attempts - discard frame */
394 #ifndef CONFIG_CARL9170FW_DEBUG
395 dma_unlink_head(queue);
396 #else /* CONFIG_CARL9170FW_DEBUG */
397 BUG_ON(dma_unlink_head(queue) != desc);
398 #endif /* CONFIG_CARL9170FW_DEBUG */
401 * Issue the queue bump,
402 * We need to do this in case this was the frame's last
403 * possible retry attempt and it unfortunately: it failed.
406 wlan_txunstuck(qidx);
411 if (unlikely(super == fw.wlan.fw_desc_data)) {
412 fw.wlan.fw_desc = desc;
413 fw.wlan.fw_desc_available = 1;
415 if (fw.wlan.fw_desc_callback)
416 fw.wlan.fw_desc_callback(super, success);
421 if (unlikely(super->s.cab))
422 fw.wlan.cab_queue_len[super->s.vif_id]--;
424 wlan_tx_complete(super, success);
426 if (ieee80211_is_back_req(super->f.data.i3e.frame_control)) {
427 fw.wlan.queued_bar--;
430 /* recycle freed descriptors */
431 dma_reclaim(&fw.pta.down_queue, desc);
436 void handle_wlan_tx_completion(void)
438 struct dma_desc *desc;
441 for (i = AR9170_TXQ_SPECIAL; i >= AR9170_TXQ0; i--) {
442 __while_desc_bits(desc, &fw.wlan.tx_queue[i], AR9170_OWN_BITS_SW) {
443 if (!wlan_tx_status(&fw.wlan.tx_queue[i], desc)) {
444 /* termination requested. */
449 wlan_tx_ampdu_reset(i);
451 for_each_desc(desc, &fw.wlan.tx_retry)
454 wlan_tx_ampdu_end(i);
455 if (!queue_empty(&fw.wlan.tx_queue[i]))
456 wlan_trigger(BIT(i));
460 void __hot wlan_tx(struct dma_desc *desc)
462 struct carl9170_tx_superframe *super = DESC_PAYLOAD(desc);
464 if (ieee80211_is_back_req(super->f.data.i3e.frame_control)) {
465 fw.wlan.queued_bar++;
468 /* initialize rate control struct */
473 if (unlikely(super->s.cab)) {
474 fw.wlan.cab_queue_len[super->s.vif_id]++;
475 dma_put(&fw.wlan.cab_queue[super->s.vif_id], desc);
481 wlan_trigger(BIT(super->s.queue));
484 void wlan_tx_fw(struct carl9170_tx_superdesc *super, fw_desc_callback_t cb)
486 if (!fw.wlan.fw_desc_available)
489 fw.wlan.fw_desc_available = 0;
491 /* Format BlockAck */
492 fw.wlan.fw_desc->ctrl = AR9170_CTRL_FS_BIT | AR9170_CTRL_LS_BIT;
493 fw.wlan.fw_desc->status = AR9170_OWN_BITS_SW;
495 fw.wlan.fw_desc->totalLen = fw.wlan.fw_desc->dataSize = super->len;
496 fw.wlan.fw_desc_data = fw.wlan.fw_desc->dataAddr = super;
497 fw.wlan.fw_desc->nextAddr = fw.wlan.fw_desc->lastAddr =
499 fw.wlan.fw_desc_callback = cb;
500 wlan_tx(fw.wlan.fw_desc);
503 void wlan_send_buffered_ba(void)
505 struct carl9170_tx_ba_superframe *baf = &dma_mem.reserved.ba.ba;
506 struct ieee80211_ba *ba = (struct ieee80211_ba *) &baf->f.ba;
507 struct carl9170_bar_ctx *ctx;
509 if (likely(!fw.wlan.queued_ba))
512 /* there's no point to continue when the ba_desc is not available. */
513 if (!fw.wlan.fw_desc_available)
516 ctx = &fw.wlan.ba_cache[fw.wlan.ba_head_idx];
517 fw.wlan.ba_head_idx++;
518 fw.wlan.ba_head_idx %= CONFIG_CARL9170FW_BACK_REQS_NUM;
521 baf->s.len = sizeof(struct carl9170_tx_superdesc) +
522 sizeof(struct ar9170_tx_hwdesc) +
523 sizeof(struct ieee80211_ba);
524 baf->s.ri[0].tries = 1;
526 baf->s.queue = AR9170_TXQ_VO;
527 baf->f.hdr.length = sizeof(struct ieee80211_ba) + FCS_LEN;
529 baf->f.hdr.mac.no_ack = 1;
531 baf->f.hdr.phy.modulation = 1; /* OFDM */
532 baf->f.hdr.phy.tx_power = 34; /* 17 dBm */
533 baf->f.hdr.phy.chains = 1;
534 baf->f.hdr.phy.mcs = AR9170_TXRX_PHY_RATE_OFDM_6M;
536 /* format outgoing BA */
537 ba->frame_control = cpu_to_le16(IEEE80211_FTYPE_CTL | IEEE80211_STYPE_BACK);
538 ba->duration = cpu_to_le16(0);
540 /* the BAR contains all necessary MACs. All we need is to swap them */
541 memcpy(ba->ra, ctx->ta, 6);
542 memcpy(ba->ta, ctx->ra, 6);
545 * Unfortunately, we cannot look into the hardware's scoreboard.
546 * Therefore we have to proceed as described in 802.11n 9.10.7.5
547 * and send a null BlockAck.
549 memset(ba->bitmap, 0x0, sizeof(ba->bitmap));
552 * Both, the original firmare and ath9k set the NO ACK flag in
553 * the BA Ack Policy subfield.
555 ba->control = ctx->control | cpu_to_le16(1);
556 ba->start_seq_num = ctx->start_seq_num;
557 wlan_tx_fw(&baf->s, NULL);
560 void wlan_cab_flush_queue(const unsigned int vif)
562 struct dma_queue *cab_queue = &fw.wlan.cab_queue[vif];
563 struct dma_desc *desc;
565 /* move queued frames into the main tx queues */
566 for_each_desc(desc, cab_queue) {
567 struct carl9170_tx_superframe *super = get_super(desc);
568 if (!queue_empty(cab_queue)) {
570 * Set MOREDATA flag for all,
571 * but the last queued frame.
572 * see: 802.11-2007 11.2.1.5 f)
574 * This is actually the reason to why
575 * we need to prevent the reentry.
578 super->f.data.i3e.frame_control |=
579 cpu_to_le16(IEEE80211_FCTL_MOREDATA);
581 super->f.data.i3e.frame_control &=
582 cpu_to_le16(~IEEE80211_FCTL_MOREDATA);
588 wlan_trigger(BIT(super->s.queue));
592 static uint8_t *beacon_find_ie(uint8_t ie, void *addr,
593 const unsigned int len)
595 struct ieee80211_mgmt *mgmt = addr;
598 pos = mgmt->u.beacon.variable;
599 end = (uint8_t *) ((unsigned long)mgmt + (len - FCS_LEN));
601 if (pos + 2 + pos[1] > end)
613 void wlan_modify_beacon(const unsigned int vif,
614 const unsigned int addr, const unsigned int len)
617 struct ieee80211_tim_ie *ie;
619 _ie = beacon_find_ie(WLAN_EID_TIM, (void *)addr, len);
621 ie = (struct ieee80211_tim_ie *) &_ie[2];
623 if (!queue_empty(&fw.wlan.cab_queue[vif]) && (ie->dtim_count == 0)) {
624 /* schedule DTIM transfer */
625 fw.wlan.cab_flush_trigger[vif] = CARL9170_CAB_TRIGGER_ARMED;
626 } else if ((fw.wlan.cab_queue_len[vif] == 0) && (fw.wlan.cab_flush_trigger[vif])) {
627 /* undo all chances to the beacon structure */
628 ie->bitmap_ctrl &= ~0x1;
629 fw.wlan.cab_flush_trigger[vif] = CARL9170_CAB_TRIGGER_EMPTY;
632 /* Triggered by CARL9170_CAB_TRIGGER_ARMED || CARL9170_CAB_TRIGGER_DEFER */
633 if (fw.wlan.cab_flush_trigger[vif]) {
634 /* Set the almighty Multicast Traffic Indication Bit. */
635 ie->bitmap_ctrl |= 0x1;
640 * Ideally, the sequence number should be assigned by the TX arbiter
641 * hardware. But AFAIK that's not possible, so we have to go for the
642 * next best thing and write it into the beacon fifo during the open
643 * beacon update window.
646 wlan_assign_seq((struct ieee80211_hdr *)addr, vif);
649 void wlan_send_buffered_cab(void)
653 for (i = 0; i < CARL9170_INTF_NUM; i++) {
654 if (unlikely(fw.wlan.cab_flush_trigger[i] == CARL9170_CAB_TRIGGER_ARMED)) {
656 * This is hardcoded into carl9170usb driver.
658 * The driver must set the PRETBTT event to beacon_interval -
659 * CARL9170_PRETBTT_KUS (usually 6) Kus.
661 * But still, we can only do so much about 802.11-2007 9.3.2.1 &
662 * 11.2.1.6. Let's hope the current solution is adequate enough.
665 if (is_after_msecs(fw.wlan.cab_flush_time, (CARL9170_TBTT_DELTA))) {
666 wlan_cab_flush_queue(i);
669 * This prevents the code from sending new BC/MC frames
670 * which were queued after the previous buffered traffic
671 * has been sent out... They will have to wait until the
672 * next DTIM beacon comes along.
674 fw.wlan.cab_flush_trigger[i] = CARL9170_CAB_TRIGGER_DEFER;