carl9170 firmware: add automatic BA filter
[carl9170fw.git] / carlfw / src / wlan.c
1 /*
2  * carl9170 firmware - used by the ar9170 wireless device
3  *
4  * Interface to the WLAN part of the chip
5  *
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-2011  Christian Lamparter <chunkeey@googlemail.com>
10  *
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.
15  *
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.
20  *
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.
24  */
25
26 #include "carl9170.h"
27 #include "shared/phy.h"
28 #include "hostif.h"
29 #include "timer.h"
30 #include "wl.h"
31 #include "printf.h"
32 #include "rf.h"
33 #include "linux/ieee80211.h"
34 #include "wol.h"
35
36 static void wlan_txunstuck(unsigned int queue)
37 {
38         set_wlan_txq_dma_addr(queue, ((uint32_t) fw.wlan.tx_queue[queue].head) | 1);
39 }
40
41 #ifdef CONFIG_CARL9170FW_DMA_QUEUE_BUMP
42 static void wlan_txupdate(unsigned int queue)
43 {
44         set_wlan_txq_dma_addr(queue, ((uint32_t) fw.wlan.tx_queue[queue].head));
45 }
46
47 static void wlan_dma_bump(unsigned int qidx)
48 {
49         unsigned int offset = qidx;
50         uint32_t status, trigger;
51
52         status = get(AR9170_MAC_REG_DMA_STATUS) >> 12;
53         trigger = get(AR9170_MAC_REG_DMA_TRIGGER) >> 12;
54
55         while (offset != 0) {
56                 status >>= 4;
57                 trigger >>= 4;
58                 offset--;
59         }
60
61         status &= 0xf;
62         trigger &= 0xf;
63
64         if ((trigger == 0xa) && (status == 0x8)) {
65                 DBG("UNSTUCK");
66                 wlan_txunstuck(qidx);
67         } else {
68                 DBG("UPDATE");
69                 wlan_txupdate(qidx);
70         }
71 }
72 #endif /* CONFIG_CARL9170FW_DMA_QUEUE_BUMP */
73
74 #ifdef CONFIG_CARL9170FW_DEBUG
75 static void wlan_dump_queue(unsigned int qidx)
76 {
77
78         struct dma_desc *desc;
79         struct carl9170_tx_superframe *super;
80         int entries = 0;
81
82         __for_each_desc(desc, &fw.wlan.tx_queue[qidx]) {
83                 super = get_super(desc);
84                 DBG("%d: %p s:%x c:%x tl:%x ds:%x n:%p l:%p ", entries, desc,
85                     desc->status, desc->ctrl, desc->totalLen,
86                     desc->dataSize, desc->nextAddr, desc->lastAddr);
87
88                 DBG("c:%x tr:%d ri:%d l:%x m:%x p:%x fc:%x",
89                     super->s.cookie, super->s.cnt, super->s.rix,
90                     super->f.hdr.length, super->f.hdr.mac.set,
91                     (unsigned int) le32_to_cpu(super->f.hdr.phy.set),
92                     super->f.data.i3e.frame_control);
93
94                 entries++;
95         }
96
97         desc = get_wlan_txq_addr(qidx);
98
99         DBG("Queue: %d: te:%d td:%d h:%p c:%p t:%p",
100             qidx, entries, queue_len(&fw.wlan.tx_queue[qidx]),
101             fw.wlan.tx_queue[qidx].head,
102             desc, fw.wlan.tx_queue[qidx].terminator);
103
104         DBG("HW: t:%x s:%x ac:%x c:%x",
105             (unsigned int) get(AR9170_MAC_REG_DMA_TRIGGER),
106             (unsigned int) get(AR9170_MAC_REG_DMA_STATUS),
107             (unsigned int) get(AR9170_MAC_REG_AMPDU_COUNT),
108             (unsigned int) get(AR9170_MAC_REG_DMA_TXQX_ADDR_CURR));
109 }
110 #endif /* CONFIG_CARL9170FW_DEBUG */
111
112 static void wlan_send_buffered_tx_status(void)
113 {
114         unsigned int len;
115
116         while (fw.wlan.tx_status_pending) {
117                 len = min((unsigned int)fw.wlan.tx_status_pending,
118                           CARL9170_RSP_TX_STATUS_NUM);
119                 len = min(len, CARL9170_TX_STATUS_NUM - fw.wlan.tx_status_head_idx);
120
121                 /*
122                  * rather than memcpy each individual request into a large buffer,
123                  * we _splice_ them all together.
124                  *
125                  * The only downside is however that we have to be careful around
126                  * the edges of the tx_status_cache.
127                  *
128                  * Note:
129                  * Each tx_status is about 2 bytes. However every command package
130                  * must have a size which is a multiple of 4.
131                  */
132
133                 send_cmd_to_host((len * sizeof(struct carl9170_tx_status) + 3) & ~3,
134                                  CARL9170_RSP_TXCOMP, len, (void *)
135                                  &fw.wlan.tx_status_cache[fw.wlan.tx_status_head_idx]);
136
137                 fw.wlan.tx_status_pending -= len;
138                 fw.wlan.tx_status_head_idx += len;
139                 fw.wlan.tx_status_head_idx %= CARL9170_TX_STATUS_NUM;
140         }
141 }
142
143 static struct carl9170_tx_status *wlan_get_tx_status_buffer(void)
144 {
145         struct carl9170_tx_status *tmp;
146
147         tmp = &fw.wlan.tx_status_cache[fw.wlan.tx_status_tail_idx++];
148         fw.wlan.tx_status_tail_idx %= CARL9170_TX_STATUS_NUM;
149
150         if (fw.wlan.tx_status_pending == CARL9170_TX_STATUS_NUM)
151                 wlan_send_buffered_tx_status();
152
153         fw.wlan.tx_status_pending++;
154
155         return tmp;
156 }
157
158 /* generate _aggregated_ tx_status for the host */
159 void wlan_tx_complete(struct carl9170_tx_superframe *super,
160                       bool txs)
161 {
162         struct carl9170_tx_status *status;
163
164         status = wlan_get_tx_status_buffer();
165
166         /*
167          * The *unique* cookie and AC_ID is used by the driver for
168          * frame lookup.
169          */
170         status->cookie = super->s.cookie;
171         status->queue = super->s.queue;
172         super->s.cookie = 0;
173
174         /*
175          * This field holds the number of tries of the rate in
176          * the rate index field (rix).
177          */
178         status->rix = super->s.rix;
179         status->tries = super->s.cnt;
180         status->success = (txs) ? 1 : 0;
181 }
182
183 static bool wlan_tx_consume_retry(struct carl9170_tx_superframe *super)
184 {
185         /* check if this was the last possible retry with this rate */
186         if (unlikely(super->s.cnt >= super->s.ri[super->s.rix].tries)) {
187                 /* end of the road - indicate tx failure */
188                 if (unlikely(super->s.rix == CARL9170_TX_MAX_RETRY_RATES))
189                         return false;
190
191                 /* check if there are alternative rates available */
192                 if (!super->s.rr[super->s.rix].set)
193                         return false;
194
195                 /* try next retry rate */
196                 super->f.hdr.phy.set = super->s.rr[super->s.rix].set;
197
198                 /* finally - mark the old rate as USED */
199                 super->s.rix++;
200
201                 /* update MAC flags */
202                 super->f.hdr.mac.erp_prot = super->s.ri[super->s.rix].erp_prot;
203                 super->f.hdr.mac.ampdu = super->s.ri[super->s.rix].ampdu;
204
205                 /* reinitialize try counter */
206                 super->s.cnt = 1;
207         } else {
208                 /* just increase retry counter */
209                 super->s.cnt++;
210         }
211
212         return true;
213 }
214
215 static inline u16 get_tid(struct ieee80211_hdr *hdr)
216 {
217         return (ieee80211_get_qos_ctl(hdr))[0] & IEEE80211_QOS_CTL_TID_MASK;
218 }
219
220 /* This function will only work on uint32_t-aligned pointers! */
221 static bool same_hdr(const void *_d0, const void *_d1)
222 {
223         const uint32_t *d0 = _d0;
224         const uint32_t *d1 = _d1;
225
226         /* BUG_ON((unsigned long)d0 & 3 || (unsigned long)d1 & 3)) */
227         return !((d0[0] ^ d1[0]) |                      /* FC + DU */
228                  (d0[1] ^ d1[1]) |                      /* addr1 */
229                  (d0[2] ^ d1[2]) | (d0[3] ^ d1[3]) |    /* addr2 + addr3 */
230                  (d0[4] ^ d1[4]));                      /* addr3 */
231 }
232
233 static inline bool same_aggr(struct ieee80211_hdr *a, struct ieee80211_hdr *b)
234 {
235         return (get_tid(a) == get_tid(b)) || same_hdr(a, b);
236 }
237
238 static void wlan_tx_ampdu_reset(unsigned int qidx)
239 {
240         fw.wlan.ampdu_prev[qidx] = NULL;
241 }
242
243 static void wlan_tx_ampdu_end(unsigned int qidx)
244 {
245         struct carl9170_tx_superframe *ht_prev = fw.wlan.ampdu_prev[qidx];
246
247         if (ht_prev)
248                 ht_prev->f.hdr.mac.ba_end = 1;
249
250         wlan_tx_ampdu_reset(qidx);
251 }
252
253 static void wlan_tx_ampdu(struct carl9170_tx_superframe *super)
254 {
255         unsigned int qidx = super->s.queue;
256         struct carl9170_tx_superframe *ht_prev = fw.wlan.ampdu_prev[qidx];
257
258         if (super->f.hdr.mac.ampdu) {
259                 if (ht_prev &&
260                     !same_aggr(&super->f.data.i3e, &ht_prev->f.data.i3e))
261                         ht_prev->f.hdr.mac.ba_end = 1;
262                 else
263                         super->f.hdr.mac.ba_end = 0;
264
265                 fw.wlan.ampdu_prev[qidx] = super;
266         } else {
267                 wlan_tx_ampdu_end(qidx);
268         }
269 }
270
271 /* for all tries */
272 static void __wlan_tx(struct dma_desc *desc)
273 {
274         struct carl9170_tx_superframe *super = get_super(desc);
275
276         if (unlikely(super->s.fill_in_tsf)) {
277                 struct ieee80211_mgmt *mgmt = (void *) &super->f.data.i3e;
278                 uint32_t *tsf = (uint32_t *) &mgmt->u.probe_resp.timestamp;
279
280                 /*
281                  * Truth be told: this is a hack.
282                  *
283                  * The *real* TSF is definitely going to be higher/older.
284                  * But this hardware emulation code is head and shoulders
285                  * above anything a driver can possibly do.
286                  *
287                  * (even, if it's got an accurate atomic clock source).
288                  */
289
290                 read_tsf(tsf);
291         }
292
293         wlan_tx_ampdu(super);
294
295 #ifdef CONFIG_CARL9170FW_DEBUG
296         BUG_ON(fw.phy.psm.state != CARL9170_PSM_WAKE);
297 #endif /* CONFIG_CARL9170FW_DEBUG */
298
299         /* insert desc into the right queue */
300         dma_put(&fw.wlan.tx_queue[super->s.queue], desc);
301 }
302
303 static void wlan_assign_seq(struct ieee80211_hdr *hdr, unsigned int vif)
304 {
305         hdr->seq_ctrl &= cpu_to_le16(~IEEE80211_SCTL_SEQ);
306         hdr->seq_ctrl |= cpu_to_le16(fw.wlan.sequence[vif]);
307
308         if (ieee80211_is_first_frag(hdr->seq_ctrl))
309                 fw.wlan.sequence[vif] += 0x10;
310 }
311
312 /* prepares frame for the first transmission */
313 static void _wlan_tx(struct dma_desc *desc)
314 {
315         struct carl9170_tx_superframe *super = get_super(desc);
316
317         if (unlikely(super->s.assign_seq))
318                 wlan_assign_seq(&super->f.data.i3e, super->s.vif_id);
319
320         if (unlikely(super->s.ampdu_commit_density)) {
321                 set(AR9170_MAC_REG_AMPDU_DENSITY,
322                     MOD_VAL(AR9170_MAC_AMPDU_DENSITY,
323                             get(AR9170_MAC_REG_AMPDU_DENSITY),
324                             super->s.ampdu_density));
325         }
326
327         if (unlikely(super->s.ampdu_commit_factor)) {
328                 set(AR9170_MAC_REG_AMPDU_FACTOR,
329                     MOD_VAL(AR9170_MAC_AMPDU_FACTOR,
330                             get(AR9170_MAC_REG_AMPDU_FACTOR),
331                             8 << super->s.ampdu_factor));
332         }
333 }
334
335 /* propagate transmission status back to the driver */
336 static bool wlan_tx_status(struct dma_queue *queue,
337                            struct dma_desc *desc)
338 {
339         struct carl9170_tx_superframe *super = get_super(desc);
340         unsigned int qidx = super->s.queue;
341         bool txfail = false, success;
342
343         success = true;
344
345         /* update hangcheck */
346         fw.wlan.last_super_num[qidx] = 0;
347
348         /*
349          * Note:
350          * There could be a corner case when the TXFAIL is set
351          * even though the frame was properly ACKed by the peer:
352          *   a BlockAckReq with the immediate policy will cause
353          *   the receiving peer to produce a BlockACK unfortunately
354          *   the MAC in this chip seems to be expecting a legacy
355          *   ACK and marks the BAR as failed!
356          */
357
358         if (!!(desc->ctrl & AR9170_CTRL_FAIL)) {
359                 txfail = !!(desc->ctrl & AR9170_CTRL_TXFAIL);
360
361                 /* reset retry indicator flags */
362                 desc->ctrl &= ~(AR9170_CTRL_TXFAIL | AR9170_CTRL_BAFAIL);
363
364                 /*
365                  * Note: wlan_tx_consume_retry will override the old
366                  * phy [CCK,OFDM, HT, BW20/40, MCS...] and mac vectors
367                  * [AMPDU,RTS/CTS,...] therefore be careful when they
368                  * are used.
369                  */
370                 if (wlan_tx_consume_retry(super)) {
371                         /*
372                          * retry for simple and aggregated 802.11 frames.
373                          *
374                          * Note: We must not mess up the original frame
375                          * order.
376                          */
377
378                         if (!super->f.hdr.mac.ampdu) {
379                                 /*
380                                  * 802.11 - 7.1.3.1.5.
381                                  * set "Retry Field" for consecutive attempts
382                                  *
383                                  * Note: For AMPDU see:
384                                  * 802.11n 9.9.1.6 "Retransmit Procedures"
385                                  */
386                                 super->f.data.i3e.frame_control |=
387                                         cpu_to_le16(IEEE80211_FCTL_RETRY);
388                         }
389
390                         if (txfail) {
391                                 /* Normal TX Failure */
392
393                                 /* demise descriptor ownership back to the hardware */
394                                 dma_rearm(desc);
395
396                                 /*
397                                  * And this will get the queue going again.
398                                  * To understand why: you have to get the HW
399                                  * specs... But sadly I never saw them.
400                                  */
401                                 wlan_txunstuck(qidx);
402
403                                 /* abort cycle - this is necessary due to HW design */
404                                 return false;
405                         } else {
406                                 /* (HT-) BlockACK failure */
407
408                                 /*
409                                  * Unlink the failed attempt and put it into
410                                  * the retry queue. The caller routine must
411                                  * be aware of this so the frames don't get lost.
412                                  */
413
414 #ifndef CONFIG_CARL9170FW_DEBUG
415                                 dma_unlink_head(queue);
416 #else /* CONFIG_CARL9170FW_DEBUG */
417                                 BUG_ON(dma_unlink_head(queue) != desc);
418 #endif /* CONFIG_CARL9170FW_DEBUG */
419                                 dma_put(&fw.wlan.tx_retry, desc);
420                                 return true;
421                         }
422                 } else {
423                         /* out of frame attempts - discard frame */
424                         success = false;
425                 }
426         }
427
428 #ifndef CONFIG_CARL9170FW_DEBUG
429         dma_unlink_head(queue);
430 #else /* CONFIG_CARL9170FW_DEBUG */
431         BUG_ON(dma_unlink_head(queue) != desc);
432 #endif /* CONFIG_CARL9170FW_DEBUG */
433         if (txfail) {
434                 /*
435                  * Issue the queue bump,
436                  * We need to do this in case this was the frame's last
437                  * possible retry attempt and it unfortunately: it failed.
438                  */
439
440                 wlan_txunstuck(qidx);
441         }
442
443         unhide_super(desc);
444
445         if (unlikely(super == fw.wlan.fw_desc_data)) {
446                 fw.wlan.fw_desc = desc;
447                 fw.wlan.fw_desc_available = 1;
448
449                 if (fw.wlan.fw_desc_callback)
450                         fw.wlan.fw_desc_callback(super, success);
451
452                 return true;
453         }
454
455 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
456         if (unlikely(super->s.cab))
457                 fw.wlan.cab_queue_len[super->s.vif_id]--;
458 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
459
460         wlan_tx_complete(super, success);
461
462         if (ieee80211_is_back_req(super->f.data.i3e.frame_control)) {
463                 fw.wlan.queued_bar--;
464         }
465
466         /* recycle freed descriptors */
467         dma_reclaim(&fw.pta.down_queue, desc);
468         down_trigger();
469         return true;
470 }
471
472 static void handle_tx_completion(void)
473 {
474         struct dma_desc *desc;
475         int i;
476
477         for (i = AR9170_TXQ_SPECIAL; i >= AR9170_TXQ0; i--) {
478                 __while_desc_bits(desc, &fw.wlan.tx_queue[i], AR9170_OWN_BITS_SW) {
479                         if (!wlan_tx_status(&fw.wlan.tx_queue[i], desc)) {
480                                 /* termination requested. */
481                                 break;
482                         }
483                 }
484
485                 wlan_tx_ampdu_reset(i);
486
487                 for_each_desc(desc, &fw.wlan.tx_retry)
488                         __wlan_tx(desc);
489
490                 wlan_tx_ampdu_end(i);
491                 if (!queue_empty(&fw.wlan.tx_queue[i]))
492                         wlan_trigger(BIT(i));
493         }
494 }
495
496 void __hot wlan_tx(struct dma_desc *desc)
497 {
498         struct carl9170_tx_superframe *super = DESC_PAYLOAD(desc);
499
500         if (ieee80211_is_back_req(super->f.data.i3e.frame_control)) {
501                 fw.wlan.queued_bar++;
502         }
503
504         /* initialize rate control struct */
505         super->s.rix = 0;
506         super->s.cnt = 1;
507         hide_super(desc);
508
509 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
510         if (unlikely(super->s.cab)) {
511                 fw.wlan.cab_queue_len[super->s.vif_id]++;
512                 dma_put(&fw.wlan.cab_queue[super->s.vif_id], desc);
513                 return;
514         }
515 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
516
517         _wlan_tx(desc);
518         __wlan_tx(desc);
519         wlan_trigger(BIT(super->s.queue));
520 }
521
522 void wlan_tx_fw(struct carl9170_tx_superdesc *super, fw_desc_callback_t cb)
523 {
524         if (!fw.wlan.fw_desc_available)
525                 return;
526
527         fw.wlan.fw_desc_available = 0;
528
529         /* Format BlockAck */
530         fw.wlan.fw_desc->ctrl = AR9170_CTRL_FS_BIT | AR9170_CTRL_LS_BIT;
531         fw.wlan.fw_desc->status = AR9170_OWN_BITS_SW;
532
533         fw.wlan.fw_desc->totalLen = fw.wlan.fw_desc->dataSize = super->len;
534         fw.wlan.fw_desc_data = fw.wlan.fw_desc->dataAddr = super;
535         fw.wlan.fw_desc->nextAddr = fw.wlan.fw_desc->lastAddr =
536                 fw.wlan.fw_desc;
537         fw.wlan.fw_desc_callback = cb;
538         wlan_tx(fw.wlan.fw_desc);
539 }
540
541 static void wlan_send_buffered_ba(void)
542 {
543         struct carl9170_tx_ba_superframe *baf = &dma_mem.reserved.ba.ba;
544         struct ieee80211_ba *ba = (struct ieee80211_ba *) &baf->f.ba;
545         struct carl9170_bar_ctx *ctx;
546
547         if (likely(!fw.wlan.queued_ba))
548                 return;
549
550         /* there's no point to continue when the ba_desc is not available. */
551         if (!fw.wlan.fw_desc_available)
552                 return;
553
554         ctx = &fw.wlan.ba_cache[fw.wlan.ba_head_idx];
555         fw.wlan.ba_head_idx++;
556         fw.wlan.ba_head_idx %= CONFIG_CARL9170FW_BACK_REQS_NUM;
557         fw.wlan.queued_ba--;
558
559         baf->s.len = sizeof(struct carl9170_tx_superdesc) +
560                      sizeof(struct ar9170_tx_hwdesc) +
561                      sizeof(struct ieee80211_ba);
562         baf->s.ri[0].tries = 1;
563         baf->s.cookie = 0;
564         baf->s.queue = AR9170_TXQ_VO;
565         baf->f.hdr.length = sizeof(struct ieee80211_ba) + FCS_LEN;
566
567         baf->f.hdr.mac.no_ack = 1;
568
569         baf->f.hdr.phy.modulation = 1; /* OFDM */
570         baf->f.hdr.phy.tx_power = 34; /* 17 dBm */
571         baf->f.hdr.phy.chains = 1;
572         baf->f.hdr.phy.mcs = AR9170_TXRX_PHY_RATE_OFDM_6M;
573
574         /* format outgoing BA */
575         ba->frame_control = cpu_to_le16(IEEE80211_FTYPE_CTL | IEEE80211_STYPE_BACK);
576         ba->duration = cpu_to_le16(0);
577
578         /* the BAR contains all necessary MACs. All we need is to swap them */
579         memcpy(ba->ra, ctx->ta, 6);
580         memcpy(ba->ta, ctx->ra, 6);
581
582         /*
583          * Unfortunately, we cannot look into the hardware's scoreboard.
584          * Therefore we have to proceed as described in 802.11n 9.10.7.5
585          * and send a null BlockAck.
586          */
587         memset(ba->bitmap, 0x0, sizeof(ba->bitmap));
588
589         /*
590          * Both, the original firmare and ath9k set the NO ACK flag in
591          * the BA Ack Policy subfield.
592          */
593         ba->control = ctx->control | cpu_to_le16(1);
594         ba->start_seq_num = ctx->start_seq_num;
595         wlan_tx_fw(&baf->s, NULL);
596 }
597
598 static struct carl9170_bar_ctx *wlan_get_bar_cache_buffer(void)
599 {
600         struct carl9170_bar_ctx *tmp;
601
602         tmp = &fw.wlan.ba_cache[fw.wlan.ba_tail_idx];
603         fw.wlan.ba_tail_idx++;
604         fw.wlan.ba_tail_idx %= CONFIG_CARL9170FW_BACK_REQS_NUM;
605         if (fw.wlan.queued_ba < CONFIG_CARL9170FW_BACK_REQS_NUM)
606                 fw.wlan.queued_ba++;
607
608         return tmp;
609 }
610
611 static void handle_bar(struct dma_desc *desc __unused, struct ieee80211_hdr *hdr,
612                        unsigned int len, unsigned int mac_err)
613 {
614         struct ieee80211_bar *bar;
615         struct carl9170_bar_ctx *ctx;
616
617         if (unlikely(mac_err)) {
618                 /*
619                  * This check does a number of things:
620                  * 1. checks if the frame is in good nick
621                  * 2. checks if the RA (MAC) matches
622                  */
623                 return ;
624         }
625
626         if (unlikely(len < (sizeof(struct ieee80211_bar) + FCS_LEN))) {
627                 /*
628                  * Sneaky, corrupted BARs... but not with us!
629                  */
630
631                 return ;
632         }
633
634         bar = (void *) hdr;
635
636         if ((bar->control & cpu_to_le16(IEEE80211_BAR_CTRL_MULTI_TID)) ||
637             !(bar->control & cpu_to_le16(IEEE80211_BAR_CTRL_CBMTID_COMPRESSED_BA))) {
638                 /* not implemented yet */
639
640                 return ;
641         }
642
643         ctx = wlan_get_bar_cache_buffer();
644
645         memcpy(ctx->ra, bar->ra, 6);
646         memcpy(ctx->ta, bar->ta, 6);
647         ctx->control = bar->control;
648         ctx->start_seq_num = bar->start_seq_num;
649 }
650
651 static void wlan_check_rx_overrun(void)
652 {
653         uint32_t overruns, total;
654
655         fw.tally.rx_total += total = get(AR9170_MAC_REG_RX_TOTAL);
656         fw.tally.rx_overrun += overruns = get(AR9170_MAC_REG_RX_OVERRUN);
657         if (unlikely(overruns)) {
658                 if (overruns == total) {
659                         DBG("RX Overrun");
660                         fw.wlan.mac_reset++;
661                 }
662
663                 wlan_trigger(AR9170_DMA_TRIGGER_RXQ);
664         }
665 }
666
667 static unsigned int wlan_rx_filter(struct dma_desc *desc)
668 {
669         struct ieee80211_hdr *hdr;
670         unsigned int data_len;
671         unsigned int rx_filter;
672         unsigned int mac_err;
673
674         data_len = ar9170_get_rx_mpdu_len(desc);
675         mac_err = ar9170_get_rx_macstatus_error(desc);
676
677 #define AR9170_RX_ERROR_BAD (AR9170_RX_ERROR_FCS | AR9170_RX_ERROR_PLCP)
678
679         if (unlikely(data_len < (4 + 6 + FCS_LEN) ||
680             desc->totalLen > CONFIG_CARL9170FW_RX_FRAME_LEN) ||
681             mac_err & AR9170_RX_ERROR_BAD) {
682                 /*
683                  * This frame is too damaged to do anything
684                  * useful with it.
685                  */
686
687                 return CARL9170_RX_FILTER_BAD;
688         }
689
690         rx_filter = 0;
691         if (mac_err & AR9170_RX_ERROR_WRONG_RA)
692                 rx_filter |= CARL9170_RX_FILTER_OTHER_RA;
693
694         if (mac_err & AR9170_RX_ERROR_DECRYPT)
695                 rx_filter |= CARL9170_RX_FILTER_DECRY_FAIL;
696
697         hdr = ar9170_get_rx_i3e(desc);
698         if (likely(ieee80211_is_data(hdr->frame_control))) {
699                 rx_filter |= CARL9170_RX_FILTER_DATA;
700         } else if (ieee80211_is_ctl(hdr->frame_control)) {
701                 switch (le16_to_cpu(hdr->frame_control) & IEEE80211_FCTL_STYPE) {
702                 case IEEE80211_STYPE_BACK_REQ:
703                         handle_bar(desc, hdr, data_len, mac_err);
704                         rx_filter |= CARL9170_RX_FILTER_CTL_BACKR;
705                         break;
706                 case IEEE80211_STYPE_PSPOLL:
707                         rx_filter |= CARL9170_RX_FILTER_CTL_PSPOLL;
708                         break;
709                 case IEEE80211_STYPE_BACK:
710                         if (fw.wlan.queued_bar) {
711                                 /*
712                                  * Don't filter block acks when the application
713                                  * has queued BARs. This is because the firmware
714                                  * can't do the accouting and the application
715                                  * has to sort out if the BA belongs to any BARs.
716                                  */
717                                 break;
718                         }
719                         /* otherwise fall through */
720                 default:
721                         rx_filter |= CARL9170_RX_FILTER_CTL_OTHER;
722                         break;
723                 }
724         } else {
725                 /* ieee80211_is_mgmt */
726                 rx_filter |= CARL9170_RX_FILTER_MGMT;
727         }
728
729         if (unlikely(fw.suspend_mode == CARL9170_HOST_SUSPENDED)) {
730                 wol_rx(rx_filter, hdr, min(data_len,
731                         (unsigned int)AR9170_BLOCK_SIZE));
732         }
733
734 #undef AR9170_RX_ERROR_BAD
735
736         return rx_filter;
737 }
738
739 static void handle_rx(void)
740 {
741         struct dma_desc *desc;
742
743         for_each_desc_not_bits(desc, &fw.wlan.rx_queue, AR9170_OWN_BITS_HW) {
744                 if (!(wlan_rx_filter(desc) & fw.wlan.rx_filter)) {
745                         dma_put(&fw.pta.up_queue, desc);
746                         up_trigger();
747                 } else {
748                         dma_reclaim(&fw.wlan.rx_queue, desc);
749                         wlan_trigger(AR9170_DMA_TRIGGER_RXQ);
750                 }
751         }
752 }
753
754 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
755 void wlan_cab_flush_queue(const unsigned int vif)
756 {
757         struct dma_queue *cab_queue = &fw.wlan.cab_queue[vif];
758         struct dma_desc *desc;
759
760         /* move queued frames into the main tx queues */
761         for_each_desc(desc, cab_queue) {
762                 struct carl9170_tx_superframe *super = get_super(desc);
763                 if (!queue_empty(cab_queue)) {
764                         /*
765                          * Set MOREDATA flag for all,
766                          * but the last queued frame.
767                          * see: 802.11-2007 11.2.1.5 f)
768                          *
769                          * This is actually the reason to why
770                          * we need to prevent the reentry.
771                          */
772
773                         super->f.data.i3e.frame_control |=
774                                 cpu_to_le16(IEEE80211_FCTL_MOREDATA);
775                 } else {
776                         super->f.data.i3e.frame_control &=
777                                 cpu_to_le16(~IEEE80211_FCTL_MOREDATA);
778                 }
779
780                 /* ready to roll! */
781                 _wlan_tx(desc);
782                 __wlan_tx(desc);
783                 wlan_trigger(BIT(super->s.queue));
784         }
785 }
786
787 static uint8_t *beacon_find_ie(uint8_t ie, void *addr,
788                                const unsigned int len)
789 {
790         struct ieee80211_mgmt *mgmt = addr;
791         uint8_t *pos, *end;
792
793         pos = mgmt->u.beacon.variable;
794         end = (uint8_t *) ((unsigned long)mgmt + (len - FCS_LEN));
795         while (pos < end) {
796                 if (pos + 2 + pos[1] > end)
797                         return NULL;
798
799                 if (pos[0] == ie)
800                         return pos;
801
802                 pos += pos[1] + 2;
803         }
804
805         return NULL;
806 }
807
808 void wlan_modify_beacon(const unsigned int vif,
809         const unsigned int addr, const unsigned int len)
810 {
811         uint8_t *_ie;
812         struct ieee80211_tim_ie *ie;
813
814         _ie = beacon_find_ie(WLAN_EID_TIM, (void *)addr, len);
815         if (likely(_ie)) {
816                 ie = (struct ieee80211_tim_ie *) &_ie[2];
817
818                 if (!queue_empty(&fw.wlan.cab_queue[vif]) && (ie->dtim_count == 0)) {
819                         /* schedule DTIM transfer */
820                         fw.wlan.cab_flush_trigger[vif] = CARL9170_CAB_TRIGGER_ARMED;
821                 } else if ((fw.wlan.cab_queue_len[vif] == 0) && (fw.wlan.cab_flush_trigger[vif])) {
822                         /* undo all chances to the beacon structure */
823                         ie->bitmap_ctrl &= ~0x1;
824                         fw.wlan.cab_flush_trigger[vif] = CARL9170_CAB_TRIGGER_EMPTY;
825                 }
826
827                 /* Triggered by CARL9170_CAB_TRIGGER_ARMED || CARL9170_CAB_TRIGGER_DEFER */
828                 if (fw.wlan.cab_flush_trigger[vif]) {
829                         /* Set the almighty Multicast Traffic Indication Bit. */
830                         ie->bitmap_ctrl |= 0x1;
831                 }
832         }
833
834         /*
835          * Ideally, the sequence number should be assigned by the TX arbiter
836          * hardware. But AFAIK that's not possible, so we have to go for the
837          * next best thing and write it into the beacon fifo during the open
838          * beacon update window.
839          */
840
841         wlan_assign_seq((struct ieee80211_hdr *)addr, vif);
842 }
843
844 static void wlan_send_buffered_cab(void)
845 {
846         unsigned int i;
847
848         for (i = 0; i < CARL9170_INTF_NUM; i++) {
849                 if (unlikely(fw.wlan.cab_flush_trigger[i] == CARL9170_CAB_TRIGGER_ARMED)) {
850                         /*
851                          * This is hardcoded into carl9170usb driver.
852                          *
853                          * The driver must set the PRETBTT event to beacon_interval -
854                          * CARL9170_PRETBTT_KUS (usually 6) Kus.
855                          *
856                          * But still, we can only do so much about 802.11-2007 9.3.2.1 &
857                          * 11.2.1.6. Let's hope the current solution is adequate enough.
858                          */
859
860                         if (is_after_msecs(fw.wlan.cab_flush_time, (CARL9170_TBTT_DELTA))) {
861                                 wlan_cab_flush_queue(i);
862
863                                 /*
864                                  * This prevents the code from sending new BC/MC frames
865                                  * which were queued after the previous buffered traffic
866                                  * has been sent out... They will have to wait until the
867                                  * next DTIM beacon comes along.
868                                  */
869                                 fw.wlan.cab_flush_trigger[i] = CARL9170_CAB_TRIGGER_DEFER;
870                         }
871                 }
872
873         }
874 }
875 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
876
877 static void handle_beacon_config(void)
878 {
879         uint32_t bcn_count;
880
881         bcn_count = get(AR9170_MAC_REG_BCN_COUNT);
882         send_cmd_to_host(4, CARL9170_RSP_BEACON_CONFIG, 0x00,
883                          (uint8_t *) &bcn_count);
884 }
885
886 static void handle_pretbtt(void)
887 {
888 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
889         fw.wlan.cab_flush_time = get_clock_counter();
890 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
891
892 #ifdef CONFIG_CARL9170FW_RADIO_FUNCTIONS
893         rf_psm();
894
895         send_cmd_to_host(4, CARL9170_RSP_PRETBTT, 0x00,
896                          (uint8_t *) &fw.phy.psm.state);
897 #endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
898 }
899
900 static void handle_atim(void)
901 {
902         send_cmd_to_host(0, CARL9170_RSP_ATIM, 0x00, NULL);
903 }
904
905 #ifdef CONFIG_CARL9170FW_DEBUG
906 static void handle_qos(void)
907 {
908         /*
909          * What is the QoS Bit used for?
910          * Is it only an indicator for TXOP & Burst, or
911          * should we do something here?
912          */
913 }
914
915 static void handle_radar(void)
916 {
917         send_cmd_to_host(0, CARL9170_RSP_RADAR, 0x00, NULL);
918 }
919 #endif /* CONFIG_CARL9170FW_DEBUG */
920
921 static void wlan_janitor(void)
922 {
923 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
924         wlan_send_buffered_cab();
925 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
926
927         wlan_send_buffered_tx_status();
928
929         wlan_send_buffered_ba();
930
931         wol_janitor();
932 }
933
934 void handle_wlan(void)
935 {
936         uint32_t intr;
937
938         intr = get(AR9170_MAC_REG_INT_CTRL);
939         /* ACK Interrupt */
940         set(AR9170_MAC_REG_INT_CTRL, intr);
941
942 #define HANDLER(intr, flag, func)                       \
943         do {                                            \
944                 if ((intr & flag) != 0) {               \
945                         func();                         \
946                 }                                       \
947         } while (0)
948
949         intr |= fw.wlan.soft_int;
950         fw.wlan.soft_int = 0;
951
952         HANDLER(intr, AR9170_MAC_INT_PRETBTT, handle_pretbtt);
953
954         HANDLER(intr, AR9170_MAC_INT_ATIM, handle_atim);
955
956         HANDLER(intr, AR9170_MAC_INT_RXC, handle_rx);
957
958         HANDLER(intr, (AR9170_MAC_INT_TXC | AR9170_MAC_INT_RETRY_FAIL),
959                 handle_tx_completion);
960
961 #ifdef CONFIG_CARL9170FW_DEBUG
962         HANDLER(intr, AR9170_MAC_INT_QOS, handle_qos);
963
964         HANDLER(intr, AR9170_MAC_INT_RADAR, handle_radar);
965 #endif /* CONFIG_CARL9170FW_DEBUG */
966
967         HANDLER(intr, AR9170_MAC_INT_CFG_BCN, handle_beacon_config);
968
969         if (unlikely(intr))
970                 DBG("Unhandled Interrupt %x\n", (unsigned int) intr);
971
972         wlan_janitor();
973
974 #undef HANDLER
975 }
976
977 enum {
978         CARL9170FW_TX_MAC_BUMP = 4,
979         CARL9170FW_TX_MAC_DEBUG = 6,
980         CARL9170FW_TX_MAC_RESET = 7,
981 };
982
983 static void wlan_check_hang(void)
984 {
985         struct dma_desc *desc;
986         int i;
987
988         for (i = AR9170_TXQ_SPECIAL; i >= AR9170_TXQ0; i--) {
989                 if (queue_empty(&fw.wlan.tx_queue[i])) {
990                         /* Nothing to do here... move along */
991                         continue;
992                 }
993
994                 /* fetch the current DMA queue position */
995                 desc = (struct dma_desc *)get_wlan_txq_addr(i);
996
997                 /* Stuck frame detection */
998                 if (unlikely(DESC_PAYLOAD(desc) == fw.wlan.last_super[i])) {
999                         fw.wlan.last_super_num[i]++;
1000
1001                         if (unlikely(fw.wlan.last_super_num[i] >= CARL9170FW_TX_MAC_RESET)) {
1002                                 /*
1003                                  * schedule MAC reset (aka OFF/ON => dead)
1004                                  *
1005                                  * This will almost certainly kill
1006                                  * the device for good, but it's the
1007                                  * recommended thing to do...
1008                                  */
1009
1010                                 fw.wlan.mac_reset++;
1011                         }
1012
1013 #ifdef CONFIG_CARL9170FW_DEBUG
1014                         if (unlikely(fw.wlan.last_super_num[i] >= CARL9170FW_TX_MAC_DEBUG)) {
1015                                 /*
1016                                  * Sigh, the queue is almost certainly
1017                                  * dead. Dump the queue content to the
1018                                  * user, maybe we find out why it got
1019                                  * so stuck.
1020                                  */
1021
1022                                 wlan_dump_queue(i);
1023                         }
1024 #endif /* CONFIG_CARL9170FW_DEBUG */
1025
1026 #ifdef CONFIG_CARL9170FW_DMA_QUEUE_BUMP
1027                         if (unlikely(fw.wlan.last_super_num[i] >= CARL9170FW_TX_MAC_BUMP)) {
1028                                 /*
1029                                  * Hrrm, bump the queue a bit.
1030                                  * maybe this will get it going again.
1031                                  */
1032
1033                                 wlan_dma_bump(i);
1034                                 wlan_trigger(BIT(i));
1035                         }
1036 #endif /* CONFIG_CARL9170FW_DMA_QUEUE_BUMP */
1037                 } else {
1038                         /* Nothing stuck */
1039                         fw.wlan.last_super[i] = DESC_PAYLOAD(desc);
1040                         fw.wlan.last_super_num[i] = 0;
1041                 }
1042         }
1043 }
1044
1045 #ifdef CONFIG_CARL9170FW_FW_MAC_RESET
1046 /*
1047  * NB: Resetting the MAC is a two-edged sword.
1048  * On most occasions, it does what it is supposed to do.
1049  * But there is a chance that this will make it
1050  * even worse and the radio dies silently.
1051  */
1052 static void wlan_mac_reset(void)
1053 {
1054         uint32_t val;
1055         uint32_t agg_wait_counter;
1056         uint32_t agg_density;
1057         uint32_t bcn_start_addr;
1058         uint32_t rctl, rcth;
1059         uint32_t cam_mode;
1060         uint32_t ack_power;
1061         uint32_t rts_cts_tpc;
1062         uint32_t rts_cts_rate;
1063         int i;
1064
1065 #ifdef CONFIG_CARL9170FW_RADIO_FUNCTIONS
1066         uint32_t rx_BB;
1067 #endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
1068
1069 #ifdef CONFIG_CARL9170FW_NOISY_MAC_RESET
1070         INFO("MAC RESET");
1071 #endif /* CONFIG_CARL9170FW_NOISY_MAC_RESET */
1072
1073         /* Save aggregation parameters */
1074         agg_wait_counter = get(AR9170_MAC_REG_AMPDU_FACTOR);
1075         agg_density = get(AR9170_MAC_REG_AMPDU_DENSITY);
1076
1077         bcn_start_addr = get(AR9170_MAC_REG_BCN_ADDR);
1078
1079         cam_mode = get(AR9170_MAC_REG_CAM_MODE);
1080         rctl = get(AR9170_MAC_REG_CAM_ROLL_CALL_TBL_L);
1081         rcth = get(AR9170_MAC_REG_CAM_ROLL_CALL_TBL_H);
1082
1083         ack_power = get(AR9170_MAC_REG_ACK_TPC);
1084         rts_cts_tpc = get(AR9170_MAC_REG_RTS_CTS_TPC);
1085         rts_cts_rate = get(AR9170_MAC_REG_RTS_CTS_RATE);
1086
1087 #ifdef CONFIG_CARL9170FW_RADIO_FUNCTIONS
1088         /* 0x1c8960 write only */
1089         rx_BB = get(AR9170_PHY_REG_SWITCH_CHAIN_0);
1090 #endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
1091
1092         /* TX/RX must be stopped by now */
1093         val = get(AR9170_MAC_REG_POWER_STATE_CTRL);
1094
1095         val |= AR9170_MAC_POWER_STATE_CTRL_RESET;
1096
1097         /*
1098          * Manipulate CCA threshold to stop transmission
1099          *
1100          * set(AR9170_PHY_REG_CCA_THRESHOLD, 0x300);
1101          */
1102
1103         /*
1104          * check Rx state in 0(idle) 9(disable)
1105          *
1106          * chState = (get(AR9170_MAC_REG_MISC_684) >> 16) & 0xf;
1107          * while( (chState != 0) && (chState != 9)) {
1108          *      chState = (get(AR9170_MAC_REG_MISC_684) >> 16) & 0xf;
1109          * }
1110          */
1111
1112         set(AR9170_MAC_REG_POWER_STATE_CTRL, val);
1113
1114         delay(2);
1115
1116         /* Restore aggregation parameters */
1117         set(AR9170_MAC_REG_AMPDU_FACTOR, agg_wait_counter);
1118         set(AR9170_MAC_REG_AMPDU_DENSITY, agg_density);
1119
1120         set(AR9170_MAC_REG_BCN_ADDR, bcn_start_addr);
1121         set(AR9170_MAC_REG_CAM_MODE, cam_mode);
1122         set(AR9170_MAC_REG_CAM_ROLL_CALL_TBL_L, rctl);
1123         set(AR9170_MAC_REG_CAM_ROLL_CALL_TBL_H, rcth);
1124
1125         set(AR9170_MAC_REG_RTS_CTS_TPC, rts_cts_tpc);
1126         set(AR9170_MAC_REG_ACK_TPC, ack_power);
1127         set(AR9170_MAC_REG_RTS_CTS_RATE, rts_cts_rate);
1128
1129 #ifdef CONFIG_CARL9170FW_RADIO_FUNCTIONS
1130         set(AR9170_PHY_REG_SWITCH_CHAIN_2, rx_BB);
1131 #endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
1132
1133         /*
1134          * Manipulate CCA threshold to resume transmission
1135          *
1136          * set(AR9170_PHY_REG_CCA_THRESHOLD, 0x0);
1137          */
1138
1139         val = AR9170_DMA_TRIGGER_RXQ;
1140         /* Reinitialize all WLAN TX DMA queues. */
1141         for (i = AR9170_TXQ_SPECIAL; i >= AR9170_TXQ0; i--) {
1142                 struct dma_desc *iter;
1143
1144                 __for_each_desc_bits(iter, &fw.wlan.tx_queue[i], AR9170_OWN_BITS_SW);
1145
1146                 /* kill the stuck frame */
1147                 if (!is_terminator(&fw.wlan.tx_queue[i], iter) &&
1148                     fw.wlan.last_super_num[i] >= CARL9170FW_TX_MAC_RESET &&
1149                     fw.wlan.last_super[i] == DESC_PAYLOAD(iter)) {
1150                         struct carl9170_tx_superframe *super = get_super(iter);
1151
1152                         iter->status = AR9170_OWN_BITS_SW;
1153                         /*
1154                          * Mark the frame as failed.
1155                          * The BAFAIL flag allows the frame to sail through
1156                          * wlan_tx_status without much "unstuck" trouble.
1157                          */
1158                         iter->ctrl &= ~(AR9170_CTRL_FAIL);
1159                         iter->ctrl |= AR9170_CTRL_BAFAIL;
1160
1161                         super->s.cnt = CARL9170_TX_MAX_RATE_TRIES;
1162                         super->s.rix = CARL9170_TX_MAX_RETRY_RATES;
1163
1164                         fw.wlan.last_super_num[i] = 0;
1165                         fw.wlan.last_super[i] = NULL;
1166                         iter = iter->lastAddr->nextAddr;
1167                 }
1168
1169                 set_wlan_txq_dma_addr(i, (uint32_t) iter);
1170                 if (!is_terminator(&fw.wlan.tx_queue[i], iter))
1171                         val |= BIT(i);
1172
1173                 DBG("Q:%d l:%d h:%p t:%p cu:%p it:%p ct:%x st:%x\n", i, queue_len(&fw.wlan.tx_queue[i]),
1174                      fw.wlan.tx_queue[i].head, fw.wlan.tx_queue[i].terminator,
1175                      get_wlan_txq_addr(i), iter, iter->ctrl, iter->status);
1176         }
1177
1178         fw.wlan.soft_int |= AR9170_MAC_INT_RXC | AR9170_MAC_INT_TXC |
1179                             AR9170_MAC_INT_RETRY_FAIL;
1180
1181         set(AR9170_MAC_REG_DMA_RXQ_ADDR, (uint32_t) fw.wlan.rx_queue.head);
1182         wlan_trigger(val);
1183 }
1184 #else
1185 static void wlan_mac_reset(void)
1186 {
1187         /* The driver takes care of reinitializing the device */
1188         BUG("MAC RESET");
1189 }
1190 #endif /* CONFIG_CARL9170FW_FW_MAC_RESET */
1191
1192 void __cold wlan_timer(void)
1193 {
1194         unsigned int cached_mac_reset;
1195
1196         cached_mac_reset = fw.wlan.mac_reset;
1197
1198         /* TX Queue Hang check */
1199         wlan_check_hang();
1200
1201         /* RX Overrun check */
1202         wlan_check_rx_overrun();
1203
1204         if (unlikely(fw.wlan.mac_reset >= CARL9170_MAC_RESET_RESET)) {
1205                 wlan_mac_reset();
1206                 fw.wlan.mac_reset = CARL9170_MAC_RESET_OFF;
1207         } else {
1208                 if (fw.wlan.mac_reset && cached_mac_reset == fw.wlan.mac_reset)
1209                         fw.wlan.mac_reset--;
1210         }
1211 }