carl9170 firmware: set NO ACK bit in BA control
[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         /* recycle freed descriptors */
463         dma_reclaim(&fw.pta.down_queue, desc);
464         down_trigger();
465         return true;
466 }
467
468 static void handle_tx_completion(void)
469 {
470         struct dma_desc *desc;
471         int i;
472
473         for (i = AR9170_TXQ_SPECIAL; i >= AR9170_TXQ0; i--) {
474                 __while_desc_bits(desc, &fw.wlan.tx_queue[i], AR9170_OWN_BITS_SW) {
475                         if (!wlan_tx_status(&fw.wlan.tx_queue[i], desc)) {
476                                 /* termination requested. */
477                                 break;
478                         }
479                 }
480
481                 wlan_tx_ampdu_reset(i);
482
483                 for_each_desc(desc, &fw.wlan.tx_retry)
484                         __wlan_tx(desc);
485
486                 wlan_tx_ampdu_end(i);
487                 if (!queue_empty(&fw.wlan.tx_queue[i]))
488                         wlan_trigger(BIT(i));
489         }
490 }
491
492 void __hot wlan_tx(struct dma_desc *desc)
493 {
494         struct carl9170_tx_superframe *super = DESC_PAYLOAD(desc);
495
496         /* initialize rate control struct */
497         super->s.rix = 0;
498         super->s.cnt = 1;
499         hide_super(desc);
500
501 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
502         if (unlikely(super->s.cab)) {
503                 fw.wlan.cab_queue_len[super->s.vif_id]++;
504                 dma_put(&fw.wlan.cab_queue[super->s.vif_id], desc);
505                 return;
506         }
507 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
508
509         _wlan_tx(desc);
510         __wlan_tx(desc);
511         wlan_trigger(BIT(super->s.queue));
512 }
513
514 void wlan_tx_fw(struct carl9170_tx_superdesc *super, fw_desc_callback_t cb)
515 {
516         if (!fw.wlan.fw_desc_available)
517                 return;
518
519         fw.wlan.fw_desc_available = 0;
520
521         /* Format BlockAck */
522         fw.wlan.fw_desc->ctrl = AR9170_CTRL_FS_BIT | AR9170_CTRL_LS_BIT;
523         fw.wlan.fw_desc->status = AR9170_OWN_BITS_SW;
524
525         fw.wlan.fw_desc->totalLen = fw.wlan.fw_desc->dataSize = super->len;
526         fw.wlan.fw_desc_data = fw.wlan.fw_desc->dataAddr = super;
527         fw.wlan.fw_desc->nextAddr = fw.wlan.fw_desc->lastAddr =
528                 fw.wlan.fw_desc;
529         fw.wlan.fw_desc_callback = cb;
530         wlan_tx(fw.wlan.fw_desc);
531 }
532
533 static void wlan_send_buffered_ba(void)
534 {
535         struct carl9170_tx_ba_superframe *baf = &dma_mem.reserved.ba.ba;
536         struct ieee80211_ba *ba = (struct ieee80211_ba *) &baf->f.ba;
537         struct carl9170_bar_ctx *ctx;
538
539         if (likely(!fw.wlan.queued_ba))
540                 return;
541
542         /* there's no point to continue when the ba_desc is not available. */
543         if (!fw.wlan.fw_desc_available)
544                 return;
545
546         ctx = &fw.wlan.ba_cache[fw.wlan.ba_head_idx];
547         fw.wlan.ba_head_idx++;
548         fw.wlan.ba_head_idx %= CONFIG_CARL9170FW_BACK_REQS_NUM;
549         fw.wlan.queued_ba--;
550
551         baf->s.len = sizeof(struct carl9170_tx_superdesc) +
552                      sizeof(struct ar9170_tx_hwdesc) +
553                      sizeof(struct ieee80211_ba);
554         baf->s.ri[0].tries = 1;
555         baf->s.cookie = 0;
556         baf->s.queue = AR9170_TXQ_VO;
557         baf->f.hdr.length = sizeof(struct ieee80211_ba) + FCS_LEN;
558
559         baf->f.hdr.mac.no_ack = 1;
560
561         baf->f.hdr.phy.modulation = 1; /* OFDM */
562         baf->f.hdr.phy.tx_power = 34; /* 17 dBm */
563         baf->f.hdr.phy.chains = 1;
564         baf->f.hdr.phy.mcs = AR9170_TXRX_PHY_RATE_OFDM_6M;
565
566         /* format outgoing BA */
567         ba->frame_control = cpu_to_le16(IEEE80211_FTYPE_CTL | IEEE80211_STYPE_BACK);
568         ba->duration = cpu_to_le16(0);
569
570         /* the BAR contains all necessary MACs. All we need is to swap them */
571         memcpy(ba->ra, ctx->ta, 6);
572         memcpy(ba->ta, ctx->ra, 6);
573
574         /*
575          * Unfortunately, we cannot look into the hardware's scoreboard.
576          * Therefore we have to proceed as described in 802.11n 9.10.7.5
577          * and send a null BlockAck.
578          */
579         memset(ba->bitmap, 0x0, sizeof(ba->bitmap));
580
581         /*
582          * Both, the original firmare and ath9k set the NO ACK flag in
583          * the BA Ack Policy subfield.
584          */
585         ba->control = ctx->control | cpu_to_le16(1);
586         ba->start_seq_num = ctx->start_seq_num;
587         wlan_tx_fw(&baf->s, NULL);
588 }
589
590 static struct carl9170_bar_ctx *wlan_get_bar_cache_buffer(void)
591 {
592         struct carl9170_bar_ctx *tmp;
593
594         tmp = &fw.wlan.ba_cache[fw.wlan.ba_tail_idx];
595         fw.wlan.ba_tail_idx++;
596         fw.wlan.ba_tail_idx %= CONFIG_CARL9170FW_BACK_REQS_NUM;
597         if (fw.wlan.queued_ba < CONFIG_CARL9170FW_BACK_REQS_NUM)
598                 fw.wlan.queued_ba++;
599
600         return tmp;
601 }
602
603 static void handle_bar(struct dma_desc *desc __unused, struct ieee80211_hdr *hdr,
604                        unsigned int len, unsigned int mac_err)
605 {
606         struct ieee80211_bar *bar;
607         struct carl9170_bar_ctx *ctx;
608
609         if (unlikely(mac_err)) {
610                 /*
611                  * This check does a number of things:
612                  * 1. checks if the frame is in good nick
613                  * 2. checks if the RA (MAC) matches
614                  */
615                 return ;
616         }
617
618         if (unlikely(len < (sizeof(struct ieee80211_bar) + FCS_LEN))) {
619                 /*
620                  * Sneaky, corrupted BARs... but not with us!
621                  */
622
623                 return ;
624         }
625
626         bar = (void *) hdr;
627
628         if ((bar->control & cpu_to_le16(IEEE80211_BAR_CTRL_MULTI_TID)) ||
629             !(bar->control & cpu_to_le16(IEEE80211_BAR_CTRL_CBMTID_COMPRESSED_BA))) {
630                 /* not implemented yet */
631
632                 return ;
633         }
634
635         ctx = wlan_get_bar_cache_buffer();
636
637         memcpy(ctx->ra, bar->ra, 6);
638         memcpy(ctx->ta, bar->ta, 6);
639         ctx->control = bar->control;
640         ctx->start_seq_num = bar->start_seq_num;
641 }
642
643 static void wlan_check_rx_overrun(void)
644 {
645         uint32_t overruns, total;
646
647         fw.tally.rx_total += total = get(AR9170_MAC_REG_RX_TOTAL);
648         fw.tally.rx_overrun += overruns = get(AR9170_MAC_REG_RX_OVERRUN);
649         if (unlikely(overruns)) {
650                 if (overruns == total) {
651                         DBG("RX Overrun");
652                         fw.wlan.mac_reset++;
653                 }
654
655                 wlan_trigger(AR9170_DMA_TRIGGER_RXQ);
656         }
657 }
658
659 static unsigned int wlan_rx_filter(struct dma_desc *desc)
660 {
661         struct ieee80211_hdr *hdr;
662         unsigned int data_len;
663         unsigned int rx_filter;
664         unsigned int mac_err;
665
666         data_len = ar9170_get_rx_mpdu_len(desc);
667         mac_err = ar9170_get_rx_macstatus_error(desc);
668
669 #define AR9170_RX_ERROR_BAD (AR9170_RX_ERROR_FCS | AR9170_RX_ERROR_PLCP)
670
671         if (unlikely(data_len < (4 + 6 + FCS_LEN) ||
672             desc->totalLen > CONFIG_CARL9170FW_RX_FRAME_LEN) ||
673             mac_err & AR9170_RX_ERROR_BAD) {
674                 /*
675                  * This frame is too damaged to do anything
676                  * useful with it.
677                  */
678
679                 return CARL9170_RX_FILTER_BAD;
680         }
681
682         rx_filter = 0;
683         if (mac_err & AR9170_RX_ERROR_WRONG_RA)
684                 rx_filter |= CARL9170_RX_FILTER_OTHER_RA;
685
686         if (mac_err & AR9170_RX_ERROR_DECRYPT)
687                 rx_filter |= CARL9170_RX_FILTER_DECRY_FAIL;
688
689         hdr = ar9170_get_rx_i3e(desc);
690         if (likely(ieee80211_is_data(hdr->frame_control))) {
691                 rx_filter |= CARL9170_RX_FILTER_DATA;
692         } else if (ieee80211_is_ctl(hdr->frame_control)) {
693                 switch (le16_to_cpu(hdr->frame_control) & IEEE80211_FCTL_STYPE) {
694                 case IEEE80211_STYPE_BACK_REQ:
695                         handle_bar(desc, hdr, data_len, mac_err);
696                         /* fallthrough */
697                         rx_filter |= CARL9170_RX_FILTER_CTL_BACKR;
698                         break;
699                 case IEEE80211_STYPE_PSPOLL:
700                         rx_filter |= CARL9170_RX_FILTER_CTL_PSPOLL;
701                         break;
702                 default:
703                         rx_filter |= CARL9170_RX_FILTER_CTL_OTHER;
704                         break;
705                 }
706         } else {
707                 /* ieee80211_is_mgmt */
708                 rx_filter |= CARL9170_RX_FILTER_MGMT;
709         }
710
711         if (unlikely(fw.suspend_mode == CARL9170_HOST_SUSPENDED)) {
712                 wol_rx(rx_filter, hdr, min(data_len,
713                         (unsigned int)AR9170_BLOCK_SIZE));
714         }
715
716 #undef AR9170_RX_ERROR_BAD
717
718         return rx_filter;
719 }
720
721 static void handle_rx(void)
722 {
723         struct dma_desc *desc;
724
725         for_each_desc_not_bits(desc, &fw.wlan.rx_queue, AR9170_OWN_BITS_HW) {
726                 if (!(wlan_rx_filter(desc) & fw.wlan.rx_filter)) {
727                         dma_put(&fw.pta.up_queue, desc);
728                         up_trigger();
729                 } else {
730                         dma_reclaim(&fw.wlan.rx_queue, desc);
731                         wlan_trigger(AR9170_DMA_TRIGGER_RXQ);
732                 }
733         }
734 }
735
736 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
737 void wlan_cab_flush_queue(const unsigned int vif)
738 {
739         struct dma_queue *cab_queue = &fw.wlan.cab_queue[vif];
740         struct dma_desc *desc;
741
742         /* move queued frames into the main tx queues */
743         for_each_desc(desc, cab_queue) {
744                 struct carl9170_tx_superframe *super = get_super(desc);
745                 if (!queue_empty(cab_queue)) {
746                         /*
747                          * Set MOREDATA flag for all,
748                          * but the last queued frame.
749                          * see: 802.11-2007 11.2.1.5 f)
750                          *
751                          * This is actually the reason to why
752                          * we need to prevent the reentry.
753                          */
754
755                         super->f.data.i3e.frame_control |=
756                                 cpu_to_le16(IEEE80211_FCTL_MOREDATA);
757                 } else {
758                         super->f.data.i3e.frame_control &=
759                                 cpu_to_le16(~IEEE80211_FCTL_MOREDATA);
760                 }
761
762                 /* ready to roll! */
763                 _wlan_tx(desc);
764                 __wlan_tx(desc);
765                 wlan_trigger(BIT(super->s.queue));
766         }
767 }
768
769 static uint8_t *beacon_find_ie(uint8_t ie, void *addr,
770                                const unsigned int len)
771 {
772         struct ieee80211_mgmt *mgmt = addr;
773         uint8_t *pos, *end;
774
775         pos = mgmt->u.beacon.variable;
776         end = (uint8_t *) ((unsigned long)mgmt + (len - FCS_LEN));
777         while (pos < end) {
778                 if (pos + 2 + pos[1] > end)
779                         return NULL;
780
781                 if (pos[0] == ie)
782                         return pos;
783
784                 pos += pos[1] + 2;
785         }
786
787         return NULL;
788 }
789
790 void wlan_modify_beacon(const unsigned int vif,
791         const unsigned int addr, const unsigned int len)
792 {
793         uint8_t *_ie;
794         struct ieee80211_tim_ie *ie;
795
796         _ie = beacon_find_ie(WLAN_EID_TIM, (void *)addr, len);
797         if (likely(_ie)) {
798                 ie = (struct ieee80211_tim_ie *) &_ie[2];
799
800                 if (!queue_empty(&fw.wlan.cab_queue[vif]) && (ie->dtim_count == 0)) {
801                         /* schedule DTIM transfer */
802                         fw.wlan.cab_flush_trigger[vif] = CARL9170_CAB_TRIGGER_ARMED;
803                 } else if ((fw.wlan.cab_queue_len[vif] == 0) && (fw.wlan.cab_flush_trigger[vif])) {
804                         /* undo all chances to the beacon structure */
805                         ie->bitmap_ctrl &= ~0x1;
806                         fw.wlan.cab_flush_trigger[vif] = CARL9170_CAB_TRIGGER_EMPTY;
807                 }
808
809                 /* Triggered by CARL9170_CAB_TRIGGER_ARMED || CARL9170_CAB_TRIGGER_DEFER */
810                 if (fw.wlan.cab_flush_trigger[vif]) {
811                         /* Set the almighty Multicast Traffic Indication Bit. */
812                         ie->bitmap_ctrl |= 0x1;
813                 }
814         }
815
816         /*
817          * Ideally, the sequence number should be assigned by the TX arbiter
818          * hardware. But AFAIK that's not possible, so we have to go for the
819          * next best thing and write it into the beacon fifo during the open
820          * beacon update window.
821          */
822
823         wlan_assign_seq((struct ieee80211_hdr *)addr, vif);
824 }
825
826 static void wlan_send_buffered_cab(void)
827 {
828         unsigned int i;
829
830         for (i = 0; i < CARL9170_INTF_NUM; i++) {
831                 if (unlikely(fw.wlan.cab_flush_trigger[i] == CARL9170_CAB_TRIGGER_ARMED)) {
832                         /*
833                          * This is hardcoded into carl9170usb driver.
834                          *
835                          * The driver must set the PRETBTT event to beacon_interval -
836                          * CARL9170_PRETBTT_KUS (usually 6) Kus.
837                          *
838                          * But still, we can only do so much about 802.11-2007 9.3.2.1 &
839                          * 11.2.1.6. Let's hope the current solution is adequate enough.
840                          */
841
842                         if (is_after_msecs(fw.wlan.cab_flush_time, (CARL9170_TBTT_DELTA))) {
843                                 wlan_cab_flush_queue(i);
844
845                                 /*
846                                  * This prevents the code from sending new BC/MC frames
847                                  * which were queued after the previous buffered traffic
848                                  * has been sent out... They will have to wait until the
849                                  * next DTIM beacon comes along.
850                                  */
851                                 fw.wlan.cab_flush_trigger[i] = CARL9170_CAB_TRIGGER_DEFER;
852                         }
853                 }
854
855         }
856 }
857 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
858
859 static void handle_beacon_config(void)
860 {
861         uint32_t bcn_count;
862
863         bcn_count = get(AR9170_MAC_REG_BCN_COUNT);
864         send_cmd_to_host(4, CARL9170_RSP_BEACON_CONFIG, 0x00,
865                          (uint8_t *) &bcn_count);
866 }
867
868 static void handle_pretbtt(void)
869 {
870 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
871         fw.wlan.cab_flush_time = get_clock_counter();
872 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
873
874 #ifdef CONFIG_CARL9170FW_RADIO_FUNCTIONS
875         rf_psm();
876
877         send_cmd_to_host(4, CARL9170_RSP_PRETBTT, 0x00,
878                          (uint8_t *) &fw.phy.psm.state);
879 #endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
880 }
881
882 static void handle_atim(void)
883 {
884         send_cmd_to_host(0, CARL9170_RSP_ATIM, 0x00, NULL);
885 }
886
887 #ifdef CONFIG_CARL9170FW_DEBUG
888 static void handle_qos(void)
889 {
890         /*
891          * What is the QoS Bit used for?
892          * Is it only an indicator for TXOP & Burst, or
893          * should we do something here?
894          */
895 }
896
897 static void handle_radar(void)
898 {
899         send_cmd_to_host(0, CARL9170_RSP_RADAR, 0x00, NULL);
900 }
901 #endif /* CONFIG_CARL9170FW_DEBUG */
902
903 static void wlan_janitor(void)
904 {
905 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
906         wlan_send_buffered_cab();
907 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
908
909         wlan_send_buffered_tx_status();
910
911         wlan_send_buffered_ba();
912
913         wol_janitor();
914 }
915
916 void handle_wlan(void)
917 {
918         uint32_t intr;
919
920         intr = get(AR9170_MAC_REG_INT_CTRL);
921         /* ACK Interrupt */
922         set(AR9170_MAC_REG_INT_CTRL, intr);
923
924 #define HANDLER(intr, flag, func)                       \
925         do {                                            \
926                 if ((intr & flag) != 0) {               \
927                         func();                         \
928                 }                                       \
929         } while (0)
930
931         intr |= fw.wlan.soft_int;
932         fw.wlan.soft_int = 0;
933
934         HANDLER(intr, AR9170_MAC_INT_PRETBTT, handle_pretbtt);
935
936         HANDLER(intr, AR9170_MAC_INT_ATIM, handle_atim);
937
938         HANDLER(intr, AR9170_MAC_INT_RXC, handle_rx);
939
940         HANDLER(intr, (AR9170_MAC_INT_TXC | AR9170_MAC_INT_RETRY_FAIL),
941                 handle_tx_completion);
942
943 #ifdef CONFIG_CARL9170FW_DEBUG
944         HANDLER(intr, AR9170_MAC_INT_QOS, handle_qos);
945
946         HANDLER(intr, AR9170_MAC_INT_RADAR, handle_radar);
947 #endif /* CONFIG_CARL9170FW_DEBUG */
948
949         HANDLER(intr, AR9170_MAC_INT_CFG_BCN, handle_beacon_config);
950
951         if (unlikely(intr))
952                 DBG("Unhandled Interrupt %x\n", (unsigned int) intr);
953
954         wlan_janitor();
955
956 #undef HANDLER
957 }
958
959 enum {
960         CARL9170FW_TX_MAC_BUMP = 4,
961         CARL9170FW_TX_MAC_DEBUG = 6,
962         CARL9170FW_TX_MAC_RESET = 7,
963 };
964
965 static void wlan_check_hang(void)
966 {
967         struct dma_desc *desc;
968         int i;
969
970         for (i = AR9170_TXQ_SPECIAL; i >= AR9170_TXQ0; i--) {
971                 if (queue_empty(&fw.wlan.tx_queue[i])) {
972                         /* Nothing to do here... move along */
973                         continue;
974                 }
975
976                 /* fetch the current DMA queue position */
977                 desc = (struct dma_desc *)get_wlan_txq_addr(i);
978
979                 /* Stuck frame detection */
980                 if (unlikely(DESC_PAYLOAD(desc) == fw.wlan.last_super[i])) {
981                         fw.wlan.last_super_num[i]++;
982
983                         if (unlikely(fw.wlan.last_super_num[i] >= CARL9170FW_TX_MAC_RESET)) {
984                                 /*
985                                  * schedule MAC reset (aka OFF/ON => dead)
986                                  *
987                                  * This will almost certainly kill
988                                  * the device for good, but it's the
989                                  * recommended thing to do...
990                                  */
991
992                                 fw.wlan.mac_reset++;
993                         }
994
995 #ifdef CONFIG_CARL9170FW_DEBUG
996                         if (unlikely(fw.wlan.last_super_num[i] >= CARL9170FW_TX_MAC_DEBUG)) {
997                                 /*
998                                  * Sigh, the queue is almost certainly
999                                  * dead. Dump the queue content to the
1000                                  * user, maybe we find out why it got
1001                                  * so stuck.
1002                                  */
1003
1004                                 wlan_dump_queue(i);
1005                         }
1006 #endif /* CONFIG_CARL9170FW_DEBUG */
1007
1008 #ifdef CONFIG_CARL9170FW_DMA_QUEUE_BUMP
1009                         if (unlikely(fw.wlan.last_super_num[i] >= CARL9170FW_TX_MAC_BUMP)) {
1010                                 /*
1011                                  * Hrrm, bump the queue a bit.
1012                                  * maybe this will get it going again.
1013                                  */
1014
1015                                 wlan_dma_bump(i);
1016                                 wlan_trigger(BIT(i));
1017                         }
1018 #endif /* CONFIG_CARL9170FW_DMA_QUEUE_BUMP */
1019                 } else {
1020                         /* Nothing stuck */
1021                         fw.wlan.last_super[i] = DESC_PAYLOAD(desc);
1022                         fw.wlan.last_super_num[i] = 0;
1023                 }
1024         }
1025 }
1026
1027 #ifdef CONFIG_CARL9170FW_FW_MAC_RESET
1028 /*
1029  * NB: Resetting the MAC is a two-edged sword.
1030  * On most occasions, it does what it is supposed to do.
1031  * But there is a chance that this will make it
1032  * even worse and the radio dies silently.
1033  */
1034 static void wlan_mac_reset(void)
1035 {
1036         uint32_t val;
1037         uint32_t agg_wait_counter;
1038         uint32_t agg_density;
1039         uint32_t bcn_start_addr;
1040         uint32_t rctl, rcth;
1041         uint32_t cam_mode;
1042         uint32_t ack_power;
1043         uint32_t rts_cts_tpc;
1044         uint32_t rts_cts_rate;
1045         int i;
1046
1047 #ifdef CONFIG_CARL9170FW_RADIO_FUNCTIONS
1048         uint32_t rx_BB;
1049 #endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
1050
1051 #ifdef CONFIG_CARL9170FW_NOISY_MAC_RESET
1052         INFO("MAC RESET");
1053 #endif /* CONFIG_CARL9170FW_NOISY_MAC_RESET */
1054
1055         /* Save aggregation parameters */
1056         agg_wait_counter = get(AR9170_MAC_REG_AMPDU_FACTOR);
1057         agg_density = get(AR9170_MAC_REG_AMPDU_DENSITY);
1058
1059         bcn_start_addr = get(AR9170_MAC_REG_BCN_ADDR);
1060
1061         cam_mode = get(AR9170_MAC_REG_CAM_MODE);
1062         rctl = get(AR9170_MAC_REG_CAM_ROLL_CALL_TBL_L);
1063         rcth = get(AR9170_MAC_REG_CAM_ROLL_CALL_TBL_H);
1064
1065         ack_power = get(AR9170_MAC_REG_ACK_TPC);
1066         rts_cts_tpc = get(AR9170_MAC_REG_RTS_CTS_TPC);
1067         rts_cts_rate = get(AR9170_MAC_REG_RTS_CTS_RATE);
1068
1069 #ifdef CONFIG_CARL9170FW_RADIO_FUNCTIONS
1070         /* 0x1c8960 write only */
1071         rx_BB = get(AR9170_PHY_REG_SWITCH_CHAIN_0);
1072 #endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
1073
1074         /* TX/RX must be stopped by now */
1075         val = get(AR9170_MAC_REG_POWER_STATE_CTRL);
1076
1077         val |= AR9170_MAC_POWER_STATE_CTRL_RESET;
1078
1079         /*
1080          * Manipulate CCA threshold to stop transmission
1081          *
1082          * set(AR9170_PHY_REG_CCA_THRESHOLD, 0x300);
1083          */
1084
1085         /*
1086          * check Rx state in 0(idle) 9(disable)
1087          *
1088          * chState = (get(AR9170_MAC_REG_MISC_684) >> 16) & 0xf;
1089          * while( (chState != 0) && (chState != 9)) {
1090          *      chState = (get(AR9170_MAC_REG_MISC_684) >> 16) & 0xf;
1091          * }
1092          */
1093
1094         set(AR9170_MAC_REG_POWER_STATE_CTRL, val);
1095
1096         delay(2);
1097
1098         /* Restore aggregation parameters */
1099         set(AR9170_MAC_REG_AMPDU_FACTOR, agg_wait_counter);
1100         set(AR9170_MAC_REG_AMPDU_DENSITY, agg_density);
1101
1102         set(AR9170_MAC_REG_BCN_ADDR, bcn_start_addr);
1103         set(AR9170_MAC_REG_CAM_MODE, cam_mode);
1104         set(AR9170_MAC_REG_CAM_ROLL_CALL_TBL_L, rctl);
1105         set(AR9170_MAC_REG_CAM_ROLL_CALL_TBL_H, rcth);
1106
1107         set(AR9170_MAC_REG_RTS_CTS_TPC, rts_cts_tpc);
1108         set(AR9170_MAC_REG_ACK_TPC, ack_power);
1109         set(AR9170_MAC_REG_RTS_CTS_RATE, rts_cts_rate);
1110
1111 #ifdef CONFIG_CARL9170FW_RADIO_FUNCTIONS
1112         set(AR9170_PHY_REG_SWITCH_CHAIN_2, rx_BB);
1113 #endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
1114
1115         /*
1116          * Manipulate CCA threshold to resume transmission
1117          *
1118          * set(AR9170_PHY_REG_CCA_THRESHOLD, 0x0);
1119          */
1120
1121         val = AR9170_DMA_TRIGGER_RXQ;
1122         /* Reinitialize all WLAN TX DMA queues. */
1123         for (i = AR9170_TXQ_SPECIAL; i >= AR9170_TXQ0; i--) {
1124                 struct dma_desc *iter;
1125
1126                 __for_each_desc_bits(iter, &fw.wlan.tx_queue[i], AR9170_OWN_BITS_SW);
1127
1128                 /* kill the stuck frame */
1129                 if (!is_terminator(&fw.wlan.tx_queue[i], iter) &&
1130                     fw.wlan.last_super_num[i] >= CARL9170FW_TX_MAC_RESET &&
1131                     fw.wlan.last_super[i] == DESC_PAYLOAD(iter)) {
1132                         struct carl9170_tx_superframe *super = get_super(iter);
1133
1134                         iter->status = AR9170_OWN_BITS_SW;
1135                         /*
1136                          * Mark the frame as failed.
1137                          * The BAFAIL flag allows the frame to sail through
1138                          * wlan_tx_status without much "unstuck" trouble.
1139                          */
1140                         iter->ctrl &= ~(AR9170_CTRL_FAIL);
1141                         iter->ctrl |= AR9170_CTRL_BAFAIL;
1142
1143                         super->s.cnt = CARL9170_TX_MAX_RATE_TRIES;
1144                         super->s.rix = CARL9170_TX_MAX_RETRY_RATES;
1145
1146                         fw.wlan.last_super_num[i] = 0;
1147                         fw.wlan.last_super[i] = NULL;
1148                         iter = iter->lastAddr->nextAddr;
1149                 }
1150
1151                 set_wlan_txq_dma_addr(i, (uint32_t) iter);
1152                 if (!is_terminator(&fw.wlan.tx_queue[i], iter))
1153                         val |= BIT(i);
1154
1155                 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]),
1156                      fw.wlan.tx_queue[i].head, fw.wlan.tx_queue[i].terminator,
1157                      get_wlan_txq_addr(i), iter, iter->ctrl, iter->status);
1158         }
1159
1160         fw.wlan.soft_int |= AR9170_MAC_INT_RXC | AR9170_MAC_INT_TXC |
1161                             AR9170_MAC_INT_RETRY_FAIL;
1162
1163         set(AR9170_MAC_REG_DMA_RXQ_ADDR, (uint32_t) fw.wlan.rx_queue.head);
1164         wlan_trigger(val);
1165 }
1166 #else
1167 static void wlan_mac_reset(void)
1168 {
1169         /* The driver takes care of reinitializing the device */
1170         BUG("MAC RESET");
1171 }
1172 #endif /* CONFIG_CARL9170FW_FW_MAC_RESET */
1173
1174 void __cold wlan_timer(void)
1175 {
1176         unsigned int cached_mac_reset;
1177
1178         cached_mac_reset = fw.wlan.mac_reset;
1179
1180         /* TX Queue Hang check */
1181         wlan_check_hang();
1182
1183         /* RX Overrun check */
1184         wlan_check_rx_overrun();
1185
1186         if (unlikely(fw.wlan.mac_reset >= CARL9170_MAC_RESET_RESET)) {
1187                 wlan_mac_reset();
1188                 fw.wlan.mac_reset = CARL9170_MAC_RESET_OFF;
1189         } else {
1190                 if (fw.wlan.mac_reset && cached_mac_reset == fw.wlan.mac_reset)
1191                         fw.wlan.mac_reset--;
1192         }
1193 }