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