ath9k: Introduce airtime fairness scheduling between stations
[linux-block.git] / drivers / net / wireless / ath / ath9k / ath9k.h
1 /*
2  * Copyright (c) 2008-2011 Atheros Communications Inc.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16
17 #ifndef ATH9K_H
18 #define ATH9K_H
19
20 #include <linux/etherdevice.h>
21 #include <linux/device.h>
22 #include <linux/interrupt.h>
23 #include <linux/leds.h>
24 #include <linux/completion.h>
25 #include <linux/time.h>
26 #include <linux/hw_random.h>
27
28 #include "common.h"
29 #include "debug.h"
30 #include "mci.h"
31 #include "dfs.h"
32
33 struct ath_node;
34 struct ath_vif;
35
36 extern struct ieee80211_ops ath9k_ops;
37 extern int ath9k_modparam_nohwcrypt;
38 extern int ath9k_led_blink;
39 extern bool is_ath9k_unloaded;
40 extern int ath9k_use_chanctx;
41
42 /*************************/
43 /* Descriptor Management */
44 /*************************/
45
46 #define ATH_TXSTATUS_RING_SIZE 512
47
48 /* Macro to expand scalars to 64-bit objects */
49 #define ito64(x) (sizeof(x) == 1) ?                     \
50         (((unsigned long long int)(x)) & (0xff)) :      \
51         (sizeof(x) == 2) ?                              \
52         (((unsigned long long int)(x)) & 0xffff) :      \
53         ((sizeof(x) == 4) ?                             \
54          (((unsigned long long int)(x)) & 0xffffffff) : \
55          (unsigned long long int)(x))
56
57 #define ATH_TXBUF_RESET(_bf) do {                               \
58                 (_bf)->bf_lastbf = NULL;                        \
59                 (_bf)->bf_next = NULL;                          \
60                 memset(&((_bf)->bf_state), 0,                   \
61                        sizeof(struct ath_buf_state));           \
62         } while (0)
63
64 #define DS2PHYS(_dd, _ds)                                               \
65         ((_dd)->dd_desc_paddr + ((caddr_t)(_ds) - (caddr_t)(_dd)->dd_desc))
66 #define ATH_DESC_4KB_BOUND_CHECK(_daddr) ((((_daddr) & 0xFFF) > 0xF7F) ? 1 : 0)
67 #define ATH_DESC_4KB_BOUND_NUM_SKIPPED(_len) ((_len) / 4096)
68
69 struct ath_descdma {
70         void *dd_desc;
71         dma_addr_t dd_desc_paddr;
72         u32 dd_desc_len;
73 };
74
75 int ath_descdma_setup(struct ath_softc *sc, struct ath_descdma *dd,
76                       struct list_head *head, const char *name,
77                       int nbuf, int ndesc, bool is_tx);
78
79 /***********/
80 /* RX / TX */
81 /***********/
82
83 #define ATH_TXQ_SETUP(sc, i) ((sc)->tx.txqsetup & (1<<i))
84
85 /* increment with wrap-around */
86 #define INCR(_l, _sz)   do {                    \
87                 (_l)++;                         \
88                 (_l) &= ((_sz) - 1);            \
89         } while (0)
90
91 #define ATH_RXBUF               512
92 #define ATH_TXBUF               512
93 #define ATH_TXBUF_RESERVE       5
94 #define ATH_TXMAXTRY            13
95 #define ATH_MAX_SW_RETRIES      30
96
97 #define TID_TO_WME_AC(_tid)                             \
98         ((((_tid) == 0) || ((_tid) == 3)) ? IEEE80211_AC_BE :   \
99          (((_tid) == 1) || ((_tid) == 2)) ? IEEE80211_AC_BK :   \
100          (((_tid) == 4) || ((_tid) == 5)) ? IEEE80211_AC_VI :   \
101          IEEE80211_AC_VO)
102
103 #define ATH_AGGR_DELIM_SZ          4
104 #define ATH_AGGR_MINPLEN           256 /* in bytes, minimum packet length */
105 /* number of delimiters for encryption padding */
106 #define ATH_AGGR_ENCRYPTDELIM      10
107 /* minimum h/w qdepth to be sustained to maximize aggregation */
108 #define ATH_AGGR_MIN_QDEPTH        2
109 /* minimum h/w qdepth for non-aggregated traffic */
110 #define ATH_NON_AGGR_MIN_QDEPTH    8
111 #define ATH_TX_COMPLETE_POLL_INT   1000
112 #define ATH_TXFIFO_DEPTH           8
113 #define ATH_TX_ERROR               0x01
114
115 #define ATH_AIRTIME_QUANTUM        300 /* usec */
116
117 /* Stop tx traffic 1ms before the GO goes away */
118 #define ATH_P2P_PS_STOP_TIME       1000
119
120 #define IEEE80211_SEQ_SEQ_SHIFT    4
121 #define IEEE80211_SEQ_MAX          4096
122 #define IEEE80211_WEP_IVLEN        3
123 #define IEEE80211_WEP_KIDLEN       1
124 #define IEEE80211_WEP_CRCLEN       4
125 #define IEEE80211_MAX_MPDU_LEN     (3840 + FCS_LEN +            \
126                                     (IEEE80211_WEP_IVLEN +      \
127                                      IEEE80211_WEP_KIDLEN +     \
128                                      IEEE80211_WEP_CRCLEN))
129
130 /* return whether a bit at index _n in bitmap _bm is set
131  * _sz is the size of the bitmap  */
132 #define ATH_BA_ISSET(_bm, _n)  (((_n) < (WME_BA_BMP_SIZE)) &&           \
133                                 ((_bm)[(_n) >> 5] & (1 << ((_n) & 31))))
134
135 /* return block-ack bitmap index given sequence and starting sequence */
136 #define ATH_BA_INDEX(_st, _seq) (((_seq) - (_st)) & (IEEE80211_SEQ_MAX - 1))
137
138 /* return the seqno for _start + _offset */
139 #define ATH_BA_INDEX2SEQ(_seq, _offset) (((_seq) + (_offset)) & (IEEE80211_SEQ_MAX - 1))
140
141 /* returns delimiter padding required given the packet length */
142 #define ATH_AGGR_GET_NDELIM(_len)                                       \
143        (((_len) >= ATH_AGGR_MINPLEN) ? 0 :                             \
144         DIV_ROUND_UP(ATH_AGGR_MINPLEN - (_len), ATH_AGGR_DELIM_SZ))
145
146 #define BAW_WITHIN(_start, _bawsz, _seqno) \
147         ((((_seqno) - (_start)) & 4095) < (_bawsz))
148
149 #define ATH_AN_2_TID(_an, _tidno) ath_node_to_tid(_an, _tidno)
150
151 #define IS_HT_RATE(rate)   (rate & 0x80)
152 #define IS_CCK_RATE(rate)  ((rate >= 0x18) && (rate <= 0x1e))
153 #define IS_OFDM_RATE(rate) ((rate >= 0x8) && (rate <= 0xf))
154
155 enum {
156        WLAN_RC_PHY_OFDM,
157        WLAN_RC_PHY_CCK,
158 };
159
160 struct ath_txq {
161         int mac80211_qnum; /* mac80211 queue number, -1 means not mac80211 Q */
162         u32 axq_qnum; /* ath9k hardware queue number */
163         void *axq_link;
164         struct list_head axq_q;
165         spinlock_t axq_lock;
166         u32 axq_depth;
167         u32 axq_ampdu_depth;
168         bool axq_tx_inprogress;
169         struct list_head txq_fifo[ATH_TXFIFO_DEPTH];
170         u8 txq_headidx;
171         u8 txq_tailidx;
172         int pending_frames;
173         struct sk_buff_head complete_q;
174 };
175
176 struct ath_frame_info {
177         struct ath_buf *bf;
178         u16 framelen;
179         s8 txq;
180         u8 keyix;
181         u8 rtscts_rate;
182         u8 retries : 7;
183         u8 baw_tracked : 1;
184         u8 tx_power;
185         enum ath9k_key_type keytype:2;
186 };
187
188 struct ath_rxbuf {
189         struct list_head list;
190         struct sk_buff *bf_mpdu;
191         void *bf_desc;
192         dma_addr_t bf_daddr;
193         dma_addr_t bf_buf_addr;
194 };
195
196 /**
197  * enum buffer_type - Buffer type flags
198  *
199  * @BUF_AMPDU: This buffer is an ampdu, as part of an aggregate (during TX)
200  * @BUF_AGGR: Indicates whether the buffer can be aggregated
201  *      (used in aggregation scheduling)
202  */
203 enum buffer_type {
204         BUF_AMPDU               = BIT(0),
205         BUF_AGGR                = BIT(1),
206 };
207
208 #define bf_isampdu(bf)          (bf->bf_state.bf_type & BUF_AMPDU)
209 #define bf_isaggr(bf)           (bf->bf_state.bf_type & BUF_AGGR)
210
211 struct ath_buf_state {
212         u8 bf_type;
213         u8 bfs_paprd;
214         u8 ndelim;
215         bool stale;
216         u16 seqno;
217         unsigned long bfs_paprd_timestamp;
218 };
219
220 struct ath_buf {
221         struct list_head list;
222         struct ath_buf *bf_lastbf;      /* last buf of this unit (a frame or
223                                            an aggregate) */
224         struct ath_buf *bf_next;        /* next subframe in the aggregate */
225         struct sk_buff *bf_mpdu;        /* enclosing frame structure */
226         void *bf_desc;                  /* virtual addr of desc */
227         dma_addr_t bf_daddr;            /* physical addr of desc */
228         dma_addr_t bf_buf_addr; /* physical addr of data buffer, for DMA */
229         struct ieee80211_tx_rate rates[4];
230         struct ath_buf_state bf_state;
231 };
232
233 struct ath_atx_tid {
234         struct list_head list;
235         struct sk_buff_head retry_q;
236         struct ath_node *an;
237         struct ath_txq *txq;
238         unsigned long tx_buf[BITS_TO_LONGS(ATH_TID_MAX_BUFS)];
239         u16 seq_start;
240         u16 seq_next;
241         u16 baw_size;
242         u8 tidno;
243         int baw_head;   /* first un-acked tx buffer */
244         int baw_tail;   /* next unused tx buffer slot */
245
246         s8 bar_index;
247         bool active;
248         bool clear_ps_filter;
249         bool has_queued;
250 };
251
252 void __ath_tx_queue_tid(struct ath_softc *sc, struct ath_atx_tid *tid);
253 void ath_tx_queue_tid(struct ath_softc *sc, struct ath_atx_tid *tid);
254
255 struct ath_node {
256         struct ath_softc *sc;
257         struct ieee80211_sta *sta; /* station struct we're part of */
258         struct ieee80211_vif *vif; /* interface with which we're associated */
259
260         u16 maxampdu;
261         u8 mpdudensity;
262         s8 ps_key;
263
264         bool sleeping;
265         bool no_ps_filter;
266         s64 airtime_deficit[IEEE80211_NUM_ACS];
267         u32 airtime_rx_start;
268
269 #ifdef CONFIG_ATH9K_STATION_STATISTICS
270         struct ath_rx_rate_stats rx_rate_stats;
271         struct ath_airtime_stats airtime_stats;
272 #endif
273         u8 key_idx[4];
274
275         u32 ackto;
276         struct list_head list;
277 };
278
279 struct ath_tx_control {
280         struct ath_txq *txq;
281         struct ath_node *an;
282         struct ieee80211_sta *sta;
283         u8 paprd;
284 };
285
286
287 /**
288  * @txq_map:  Index is mac80211 queue number.  This is
289  *  not necessarily the same as the hardware queue number
290  *  (axq_qnum).
291  */
292 struct ath_tx {
293         u32 txqsetup;
294         spinlock_t txbuflock;
295         struct list_head txbuf;
296         struct ath_txq txq[ATH9K_NUM_TX_QUEUES];
297         struct ath_descdma txdma;
298         struct ath_txq *txq_map[IEEE80211_NUM_ACS];
299         struct ath_txq *uapsdq;
300         u16 max_aggr_framelen[IEEE80211_NUM_ACS][4][32];
301 };
302
303 struct ath_rx_edma {
304         struct sk_buff_head rx_fifo;
305         u32 rx_fifo_hwsize;
306 };
307
308 struct ath_rx {
309         u8 defant;
310         u8 rxotherant;
311         bool discard_next;
312         u32 *rxlink;
313         u32 num_pkts;
314         struct list_head rxbuf;
315         struct ath_descdma rxdma;
316         struct ath_rx_edma rx_edma[ATH9K_RX_QUEUE_MAX];
317
318         struct ath_rxbuf *buf_hold;
319         struct sk_buff *frag;
320
321         u32 ampdu_ref;
322 };
323
324 /*******************/
325 /* Channel Context */
326 /*******************/
327
328 struct ath_acq {
329         struct list_head acq_new;
330         struct list_head acq_old;
331         spinlock_t lock;
332 };
333
334 struct ath_chanctx {
335         struct cfg80211_chan_def chandef;
336         struct list_head vifs;
337         struct ath_acq acq[IEEE80211_NUM_ACS];
338         int hw_queue_base;
339
340         /* do not dereference, use for comparison only */
341         struct ieee80211_vif *primary_sta;
342
343         struct ath_beacon_config beacon;
344         struct ath9k_hw_cal_data caldata;
345         struct timespec tsf_ts;
346         u64 tsf_val;
347         u32 last_beacon;
348
349         int flush_timeout;
350         u16 txpower;
351         u16 cur_txpower;
352         bool offchannel;
353         bool stopped;
354         bool active;
355         bool assigned;
356         bool switch_after_beacon;
357
358         short nvifs;
359         short nvifs_assigned;
360         unsigned int rxfilter;
361 };
362
363 enum ath_chanctx_event {
364         ATH_CHANCTX_EVENT_BEACON_PREPARE,
365         ATH_CHANCTX_EVENT_BEACON_SENT,
366         ATH_CHANCTX_EVENT_TSF_TIMER,
367         ATH_CHANCTX_EVENT_BEACON_RECEIVED,
368         ATH_CHANCTX_EVENT_AUTHORIZED,
369         ATH_CHANCTX_EVENT_SWITCH,
370         ATH_CHANCTX_EVENT_ASSIGN,
371         ATH_CHANCTX_EVENT_UNASSIGN,
372         ATH_CHANCTX_EVENT_CHANGE,
373         ATH_CHANCTX_EVENT_ENABLE_MULTICHANNEL,
374 };
375
376 enum ath_chanctx_state {
377         ATH_CHANCTX_STATE_IDLE,
378         ATH_CHANCTX_STATE_WAIT_FOR_BEACON,
379         ATH_CHANCTX_STATE_WAIT_FOR_TIMER,
380         ATH_CHANCTX_STATE_SWITCH,
381         ATH_CHANCTX_STATE_FORCE_ACTIVE,
382 };
383
384 struct ath_chanctx_sched {
385         bool beacon_pending;
386         bool beacon_adjust;
387         bool offchannel_pending;
388         bool wait_switch;
389         bool force_noa_update;
390         bool extend_absence;
391         bool mgd_prepare_tx;
392         enum ath_chanctx_state state;
393         u8 beacon_miss;
394
395         u32 next_tbtt;
396         u32 switch_start_time;
397         unsigned int offchannel_duration;
398         unsigned int channel_switch_time;
399
400         /* backup, in case the hardware timer fails */
401         struct timer_list timer;
402 };
403
404 enum ath_offchannel_state {
405         ATH_OFFCHANNEL_IDLE,
406         ATH_OFFCHANNEL_PROBE_SEND,
407         ATH_OFFCHANNEL_PROBE_WAIT,
408         ATH_OFFCHANNEL_SUSPEND,
409         ATH_OFFCHANNEL_ROC_START,
410         ATH_OFFCHANNEL_ROC_WAIT,
411         ATH_OFFCHANNEL_ROC_DONE,
412 };
413
414 enum ath_roc_complete_reason {
415         ATH_ROC_COMPLETE_EXPIRE,
416         ATH_ROC_COMPLETE_ABORT,
417         ATH_ROC_COMPLETE_CANCEL,
418 };
419
420 struct ath_offchannel {
421         struct ath_chanctx chan;
422         struct timer_list timer;
423         struct cfg80211_scan_request *scan_req;
424         struct ieee80211_vif *scan_vif;
425         int scan_idx;
426         enum ath_offchannel_state state;
427         struct ieee80211_channel *roc_chan;
428         struct ieee80211_vif *roc_vif;
429         int roc_duration;
430         int duration;
431 };
432
433 static inline struct ath_atx_tid *
434 ath_node_to_tid(struct ath_node *an, u8 tidno)
435 {
436         struct ieee80211_sta *sta = an->sta;
437         struct ieee80211_vif *vif = an->vif;
438         struct ieee80211_txq *txq;
439
440         BUG_ON(!vif);
441         if (sta)
442                 txq = sta->txq[tidno % ARRAY_SIZE(sta->txq)];
443         else
444                 txq = vif->txq;
445
446         return (struct ath_atx_tid *) txq->drv_priv;
447 }
448
449 #define case_rtn_string(val) case val: return #val
450
451 #define ath_for_each_chanctx(_sc, _ctx)                             \
452         for (ctx = &sc->chanctx[0];                                 \
453              ctx <= &sc->chanctx[ARRAY_SIZE(sc->chanctx) - 1];      \
454              ctx++)
455
456 void ath_chanctx_init(struct ath_softc *sc);
457 void ath_chanctx_set_channel(struct ath_softc *sc, struct ath_chanctx *ctx,
458                              struct cfg80211_chan_def *chandef);
459
460 #ifdef CONFIG_ATH9K_CHANNEL_CONTEXT
461
462 static inline struct ath_chanctx *
463 ath_chanctx_get(struct ieee80211_chanctx_conf *ctx)
464 {
465         struct ath_chanctx **ptr = (void *) ctx->drv_priv;
466         return *ptr;
467 }
468
469 bool ath9k_is_chanctx_enabled(void);
470 void ath9k_fill_chanctx_ops(void);
471 void ath9k_init_channel_context(struct ath_softc *sc);
472 void ath9k_offchannel_init(struct ath_softc *sc);
473 void ath9k_deinit_channel_context(struct ath_softc *sc);
474 int ath9k_init_p2p(struct ath_softc *sc);
475 void ath9k_deinit_p2p(struct ath_softc *sc);
476 void ath9k_p2p_remove_vif(struct ath_softc *sc,
477                           struct ieee80211_vif *vif);
478 void ath9k_p2p_beacon_sync(struct ath_softc *sc);
479 void ath9k_p2p_bss_info_changed(struct ath_softc *sc,
480                                 struct ieee80211_vif *vif);
481 void ath9k_beacon_add_noa(struct ath_softc *sc, struct ath_vif *avp,
482                           struct sk_buff *skb);
483 void ath9k_p2p_ps_timer(void *priv);
484 void ath9k_chanctx_wake_queues(struct ath_softc *sc, struct ath_chanctx *ctx);
485 void ath9k_chanctx_stop_queues(struct ath_softc *sc, struct ath_chanctx *ctx);
486 void ath_chanctx_check_active(struct ath_softc *sc, struct ath_chanctx *ctx);
487
488 void ath_chanctx_beacon_recv_ev(struct ath_softc *sc,
489                                 enum ath_chanctx_event ev);
490 void ath_chanctx_beacon_sent_ev(struct ath_softc *sc,
491                                 enum ath_chanctx_event ev);
492 void ath_chanctx_event(struct ath_softc *sc, struct ieee80211_vif *vif,
493                        enum ath_chanctx_event ev);
494 void ath_chanctx_set_next(struct ath_softc *sc, bool force);
495 void ath_offchannel_next(struct ath_softc *sc);
496 void ath_scan_complete(struct ath_softc *sc, bool abort);
497 void ath_roc_complete(struct ath_softc *sc,
498                       enum ath_roc_complete_reason reason);
499 struct ath_chanctx* ath_is_go_chanctx_present(struct ath_softc *sc);
500
501 #else
502
503 static inline bool ath9k_is_chanctx_enabled(void)
504 {
505         return false;
506 }
507 static inline void ath9k_fill_chanctx_ops(void)
508 {
509 }
510 static inline void ath9k_init_channel_context(struct ath_softc *sc)
511 {
512 }
513 static inline void ath9k_offchannel_init(struct ath_softc *sc)
514 {
515 }
516 static inline void ath9k_deinit_channel_context(struct ath_softc *sc)
517 {
518 }
519 static inline void ath_chanctx_beacon_recv_ev(struct ath_softc *sc,
520                                               enum ath_chanctx_event ev)
521 {
522 }
523 static inline void ath_chanctx_beacon_sent_ev(struct ath_softc *sc,
524                                               enum ath_chanctx_event ev)
525 {
526 }
527 static inline void ath_chanctx_event(struct ath_softc *sc,
528                                      struct ieee80211_vif *vif,
529                                      enum ath_chanctx_event ev)
530 {
531 }
532 static inline int ath9k_init_p2p(struct ath_softc *sc)
533 {
534         return 0;
535 }
536 static inline void ath9k_deinit_p2p(struct ath_softc *sc)
537 {
538 }
539 static inline void ath9k_p2p_remove_vif(struct ath_softc *sc,
540                                         struct ieee80211_vif *vif)
541 {
542 }
543 static inline void ath9k_p2p_beacon_sync(struct ath_softc *sc)
544 {
545 }
546 static inline void ath9k_p2p_bss_info_changed(struct ath_softc *sc,
547                                               struct ieee80211_vif *vif)
548 {
549 }
550 static inline void ath9k_beacon_add_noa(struct ath_softc *sc, struct ath_vif *avp,
551                                         struct sk_buff *skb)
552 {
553 }
554 static inline void ath9k_p2p_ps_timer(struct ath_softc *sc)
555 {
556 }
557 static inline void ath9k_chanctx_wake_queues(struct ath_softc *sc,
558                                              struct ath_chanctx *ctx)
559 {
560 }
561 static inline void ath9k_chanctx_stop_queues(struct ath_softc *sc,
562                                              struct ath_chanctx *ctx)
563 {
564 }
565 static inline void ath_chanctx_check_active(struct ath_softc *sc,
566                                             struct ath_chanctx *ctx)
567 {
568 }
569
570 #endif /* CONFIG_ATH9K_CHANNEL_CONTEXT */
571
572 void ath_startrecv(struct ath_softc *sc);
573 bool ath_stoprecv(struct ath_softc *sc);
574 u32 ath_calcrxfilter(struct ath_softc *sc);
575 int ath_rx_init(struct ath_softc *sc, int nbufs);
576 void ath_rx_cleanup(struct ath_softc *sc);
577 int ath_rx_tasklet(struct ath_softc *sc, int flush, bool hp);
578 struct ath_txq *ath_txq_setup(struct ath_softc *sc, int qtype, int subtype);
579 void ath_txq_lock(struct ath_softc *sc, struct ath_txq *txq);
580 void ath_txq_unlock(struct ath_softc *sc, struct ath_txq *txq);
581 void ath_txq_unlock_complete(struct ath_softc *sc, struct ath_txq *txq);
582 void ath_tx_cleanupq(struct ath_softc *sc, struct ath_txq *txq);
583 bool ath_drain_all_txq(struct ath_softc *sc);
584 void ath_draintxq(struct ath_softc *sc, struct ath_txq *txq);
585 void ath_tx_node_init(struct ath_softc *sc, struct ath_node *an);
586 void ath_tx_node_cleanup(struct ath_softc *sc, struct ath_node *an);
587 void ath_txq_schedule(struct ath_softc *sc, struct ath_txq *txq);
588 void ath_txq_schedule_all(struct ath_softc *sc);
589 int ath_tx_init(struct ath_softc *sc, int nbufs);
590 int ath_txq_update(struct ath_softc *sc, int qnum,
591                    struct ath9k_tx_queue_info *q);
592 u32 ath_pkt_duration(struct ath_softc *sc, u8 rix, int pktlen,
593                      int width, int half_gi, bool shortPreamble);
594 void ath_update_max_aggr_framelen(struct ath_softc *sc, int queue, int txop);
595 void ath_assign_seq(struct ath_common *common, struct sk_buff *skb);
596 int ath_tx_start(struct ieee80211_hw *hw, struct sk_buff *skb,
597                  struct ath_tx_control *txctl);
598 void ath_tx_cabq(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
599                  struct sk_buff *skb);
600 void ath_tx_tasklet(struct ath_softc *sc);
601 void ath_tx_edma_tasklet(struct ath_softc *sc);
602 int ath_tx_aggr_start(struct ath_softc *sc, struct ieee80211_sta *sta,
603                       u16 tid, u16 *ssn);
604 void ath_tx_aggr_stop(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
605
606 void ath_tx_aggr_wakeup(struct ath_softc *sc, struct ath_node *an);
607 void ath_tx_aggr_sleep(struct ieee80211_sta *sta, struct ath_softc *sc,
608                        struct ath_node *an);
609 void ath9k_release_buffered_frames(struct ieee80211_hw *hw,
610                                    struct ieee80211_sta *sta,
611                                    u16 tids, int nframes,
612                                    enum ieee80211_frame_release_type reason,
613                                    bool more_data);
614 void ath9k_wake_tx_queue(struct ieee80211_hw *hw, struct ieee80211_txq *queue);
615
616 /********/
617 /* VIFs */
618 /********/
619
620 #define P2P_DEFAULT_CTWIN 10
621
622 struct ath_vif {
623         struct list_head list;
624
625         u16 seq_no;
626
627         /* BSS info */
628         u8 bssid[ETH_ALEN] __aligned(2);
629         u16 aid;
630         bool assoc;
631
632         struct ieee80211_vif *vif;
633         struct ath_node mcast_node;
634         int av_bslot;
635         __le64 tsf_adjust; /* TSF adjustment for staggered beacons */
636         struct ath_buf *av_bcbuf;
637         struct ath_chanctx *chanctx;
638
639         /* P2P Client */
640         struct ieee80211_noa_data noa;
641
642         /* P2P GO */
643         u8 noa_index;
644         u32 offchannel_start;
645         u32 offchannel_duration;
646
647         /* These are used for both periodic and one-shot */
648         u32 noa_start;
649         u32 noa_duration;
650         bool periodic_noa;
651         bool oneshot_noa;
652 };
653
654 struct ath9k_vif_iter_data {
655         u8 hw_macaddr[ETH_ALEN]; /* address of the first vif */
656         u8 mask[ETH_ALEN]; /* bssid mask */
657         bool has_hw_macaddr;
658         u8 slottime;
659         bool beacons;
660
661         int naps;      /* number of AP vifs */
662         int nmeshes;   /* number of mesh vifs */
663         int nstations; /* number of station vifs */
664         int nwds;      /* number of WDS vifs */
665         int nadhocs;   /* number of adhoc vifs */
666         int nocbs;     /* number of OCB vifs */
667         int nbcnvifs;  /* number of beaconing vifs */
668         struct ieee80211_vif *primary_beacon_vif;
669         struct ieee80211_vif *primary_sta;
670 };
671
672 void ath9k_calculate_iter_data(struct ath_softc *sc,
673                                struct ath_chanctx *ctx,
674                                struct ath9k_vif_iter_data *iter_data);
675 void ath9k_calculate_summary_state(struct ath_softc *sc,
676                                    struct ath_chanctx *ctx);
677 void ath9k_set_txpower(struct ath_softc *sc, struct ieee80211_vif *vif);
678
679 /*******************/
680 /* Beacon Handling */
681 /*******************/
682
683 /*
684  * Regardless of the number of beacons we stagger, (i.e. regardless of the
685  * number of BSSIDs) if a given beacon does not go out even after waiting this
686  * number of beacon intervals, the game's up.
687  */
688 #define BSTUCK_THRESH                   9
689 #define ATH_BCBUF                       8
690 #define ATH_DEFAULT_BINTVAL             100 /* TU */
691 #define ATH_DEFAULT_BMISS_LIMIT         10
692
693 #define TSF_TO_TU(_h,_l) \
694         ((((u32)(_h)) << 22) | (((u32)(_l)) >> 10))
695
696 struct ath_beacon {
697         enum {
698                 OK,             /* no change needed */
699                 UPDATE,         /* update pending */
700                 COMMIT          /* beacon sent, commit change */
701         } updateslot;           /* slot time update fsm */
702
703         u32 beaconq;
704         u32 bmisscnt;
705         struct ieee80211_vif *bslot[ATH_BCBUF];
706         int slottime;
707         int slotupdate;
708         struct ath_descdma bdma;
709         struct ath_txq *cabq;
710         struct list_head bbuf;
711
712         bool tx_processed;
713         bool tx_last;
714 };
715
716 void ath9k_beacon_tasklet(unsigned long data);
717 void ath9k_beacon_config(struct ath_softc *sc, struct ieee80211_vif *main_vif,
718                          bool beacons);
719 void ath9k_beacon_assign_slot(struct ath_softc *sc, struct ieee80211_vif *vif);
720 void ath9k_beacon_remove_slot(struct ath_softc *sc, struct ieee80211_vif *vif);
721 void ath9k_beacon_ensure_primary_slot(struct ath_softc *sc);
722 void ath9k_set_beacon(struct ath_softc *sc);
723 bool ath9k_csa_is_finished(struct ath_softc *sc, struct ieee80211_vif *vif);
724 void ath9k_csa_update(struct ath_softc *sc);
725
726 /*******************/
727 /* Link Monitoring */
728 /*******************/
729
730 #define ATH_STA_SHORT_CALINTERVAL 1000    /* 1 second */
731 #define ATH_AP_SHORT_CALINTERVAL  100     /* 100 ms */
732 #define ATH_ANI_POLLINTERVAL_OLD  100     /* 100 ms */
733 #define ATH_ANI_POLLINTERVAL_NEW  1000    /* 1000 ms */
734 #define ATH_LONG_CALINTERVAL_INT  1000    /* 1000 ms */
735 #define ATH_LONG_CALINTERVAL      30000   /* 30 seconds */
736 #define ATH_RESTART_CALINTERVAL   1200000 /* 20 minutes */
737 #define ATH_ANI_MAX_SKIP_COUNT    10
738 #define ATH_PAPRD_TIMEOUT         100 /* msecs */
739 #define ATH_PLL_WORK_INTERVAL     100
740
741 void ath_tx_complete_poll_work(struct work_struct *work);
742 void ath_reset_work(struct work_struct *work);
743 bool ath_hw_check(struct ath_softc *sc);
744 void ath_hw_pll_work(struct work_struct *work);
745 void ath_paprd_calibrate(struct work_struct *work);
746 void ath_ani_calibrate(unsigned long data);
747 void ath_start_ani(struct ath_softc *sc);
748 void ath_stop_ani(struct ath_softc *sc);
749 void ath_check_ani(struct ath_softc *sc);
750 int ath_update_survey_stats(struct ath_softc *sc);
751 void ath_update_survey_nf(struct ath_softc *sc, int channel);
752 void ath9k_queue_reset(struct ath_softc *sc, enum ath_reset_type type);
753 void ath_ps_full_sleep(unsigned long data);
754 void __ath9k_flush(struct ieee80211_hw *hw, u32 queues, bool drop,
755                    bool sw_pending, bool timeout_override);
756
757 /**********/
758 /* BTCOEX */
759 /**********/
760
761 #define ATH_DUMP_BTCOEX(_s, _val)                               \
762         do {                                                    \
763                 len += scnprintf(buf + len, size - len,         \
764                                  "%20s : %10d\n", _s, (_val));  \
765         } while (0)
766
767 enum bt_op_flags {
768         BT_OP_PRIORITY_DETECTED,
769         BT_OP_SCAN,
770 };
771
772 struct ath_btcoex {
773         spinlock_t btcoex_lock;
774         struct timer_list period_timer; /* Timer for BT period */
775         struct timer_list no_stomp_timer;
776         u32 bt_priority_cnt;
777         unsigned long bt_priority_time;
778         unsigned long op_flags;
779         int bt_stomp_type; /* Types of BT stomping */
780         u32 btcoex_no_stomp; /* in msec */
781         u32 btcoex_period; /* in msec */
782         u32 btscan_no_stomp; /* in msec */
783         u32 duty_cycle;
784         u32 bt_wait_time;
785         int rssi_count;
786         struct ath_mci_profile mci;
787         u8 stomp_audio;
788 };
789
790 #ifdef CONFIG_ATH9K_BTCOEX_SUPPORT
791 int ath9k_init_btcoex(struct ath_softc *sc);
792 void ath9k_deinit_btcoex(struct ath_softc *sc);
793 void ath9k_start_btcoex(struct ath_softc *sc);
794 void ath9k_stop_btcoex(struct ath_softc *sc);
795 void ath9k_btcoex_timer_resume(struct ath_softc *sc);
796 void ath9k_btcoex_timer_pause(struct ath_softc *sc);
797 void ath9k_btcoex_handle_interrupt(struct ath_softc *sc, u32 status);
798 u16 ath9k_btcoex_aggr_limit(struct ath_softc *sc, u32 max_4ms_framelen);
799 void ath9k_btcoex_stop_gen_timer(struct ath_softc *sc);
800 int ath9k_dump_btcoex(struct ath_softc *sc, u8 *buf, u32 size);
801 #else
802 static inline int ath9k_init_btcoex(struct ath_softc *sc)
803 {
804         return 0;
805 }
806 static inline void ath9k_deinit_btcoex(struct ath_softc *sc)
807 {
808 }
809 static inline void ath9k_start_btcoex(struct ath_softc *sc)
810 {
811 }
812 static inline void ath9k_stop_btcoex(struct ath_softc *sc)
813 {
814 }
815 static inline void ath9k_btcoex_handle_interrupt(struct ath_softc *sc,
816                                                  u32 status)
817 {
818 }
819 static inline u16 ath9k_btcoex_aggr_limit(struct ath_softc *sc,
820                                           u32 max_4ms_framelen)
821 {
822         return 0;
823 }
824 static inline void ath9k_btcoex_stop_gen_timer(struct ath_softc *sc)
825 {
826 }
827 static inline int ath9k_dump_btcoex(struct ath_softc *sc, u8 *buf, u32 size)
828 {
829         return 0;
830 }
831 #endif /* CONFIG_ATH9K_BTCOEX_SUPPORT */
832
833 /********************/
834 /*   LED Control    */
835 /********************/
836
837 #define ATH_LED_PIN_DEF                 1
838 #define ATH_LED_PIN_9287                8
839 #define ATH_LED_PIN_9300                10
840 #define ATH_LED_PIN_9485                6
841 #define ATH_LED_PIN_9462                4
842
843 #ifdef CONFIG_MAC80211_LEDS
844 void ath_init_leds(struct ath_softc *sc);
845 void ath_deinit_leds(struct ath_softc *sc);
846 #else
847 static inline void ath_init_leds(struct ath_softc *sc)
848 {
849 }
850
851 static inline void ath_deinit_leds(struct ath_softc *sc)
852 {
853 }
854 #endif
855
856 /************************/
857 /* Wake on Wireless LAN */
858 /************************/
859
860 #ifdef CONFIG_ATH9K_WOW
861 void ath9k_init_wow(struct ieee80211_hw *hw);
862 void ath9k_deinit_wow(struct ieee80211_hw *hw);
863 int ath9k_suspend(struct ieee80211_hw *hw,
864                   struct cfg80211_wowlan *wowlan);
865 int ath9k_resume(struct ieee80211_hw *hw);
866 void ath9k_set_wakeup(struct ieee80211_hw *hw, bool enabled);
867 #else
868 static inline void ath9k_init_wow(struct ieee80211_hw *hw)
869 {
870 }
871 static inline void ath9k_deinit_wow(struct ieee80211_hw *hw)
872 {
873 }
874 static inline int ath9k_suspend(struct ieee80211_hw *hw,
875                                 struct cfg80211_wowlan *wowlan)
876 {
877         return 0;
878 }
879 static inline int ath9k_resume(struct ieee80211_hw *hw)
880 {
881         return 0;
882 }
883 static inline void ath9k_set_wakeup(struct ieee80211_hw *hw, bool enabled)
884 {
885 }
886 #endif /* CONFIG_ATH9K_WOW */
887
888 /*******************************/
889 /* Antenna diversity/combining */
890 /*******************************/
891
892 #define ATH_ANT_RX_CURRENT_SHIFT 4
893 #define ATH_ANT_RX_MAIN_SHIFT 2
894 #define ATH_ANT_RX_MASK 0x3
895
896 #define ATH_ANT_DIV_COMB_SHORT_SCAN_INTR 50
897 #define ATH_ANT_DIV_COMB_SHORT_SCAN_PKTCOUNT 0x100
898 #define ATH_ANT_DIV_COMB_MAX_PKTCOUNT 0x200
899 #define ATH_ANT_DIV_COMB_INIT_COUNT 95
900 #define ATH_ANT_DIV_COMB_MAX_COUNT 100
901 #define ATH_ANT_DIV_COMB_ALT_ANT_RATIO 30
902 #define ATH_ANT_DIV_COMB_ALT_ANT_RATIO2 20
903 #define ATH_ANT_DIV_COMB_ALT_ANT_RATIO_LOW_RSSI 50
904 #define ATH_ANT_DIV_COMB_ALT_ANT_RATIO2_LOW_RSSI 50
905
906 #define ATH_ANT_DIV_COMB_LNA1_DELTA_HI -4
907 #define ATH_ANT_DIV_COMB_LNA1_DELTA_MID -2
908 #define ATH_ANT_DIV_COMB_LNA1_DELTA_LOW 2
909
910 struct ath_ant_comb {
911         u16 count;
912         u16 total_pkt_count;
913         bool scan;
914         bool scan_not_start;
915         int main_total_rssi;
916         int alt_total_rssi;
917         int alt_recv_cnt;
918         int main_recv_cnt;
919         int rssi_lna1;
920         int rssi_lna2;
921         int rssi_add;
922         int rssi_sub;
923         int rssi_first;
924         int rssi_second;
925         int rssi_third;
926         int ant_ratio;
927         int ant_ratio2;
928         bool alt_good;
929         int quick_scan_cnt;
930         enum ath9k_ant_div_comb_lna_conf main_conf;
931         enum ath9k_ant_div_comb_lna_conf first_quick_scan_conf;
932         enum ath9k_ant_div_comb_lna_conf second_quick_scan_conf;
933         bool first_ratio;
934         bool second_ratio;
935         unsigned long scan_start_time;
936
937         /*
938          * Card-specific config values.
939          */
940         int low_rssi_thresh;
941         int fast_div_bias;
942 };
943
944 void ath_ant_comb_scan(struct ath_softc *sc, struct ath_rx_status *rs);
945
946 /********************/
947 /* Main driver core */
948 /********************/
949
950 #define ATH9K_PCI_CUS198          0x0001
951 #define ATH9K_PCI_CUS230          0x0002
952 #define ATH9K_PCI_CUS217          0x0004
953 #define ATH9K_PCI_CUS252          0x0008
954 #define ATH9K_PCI_WOW             0x0010
955 #define ATH9K_PCI_BT_ANT_DIV      0x0020
956 #define ATH9K_PCI_D3_L1_WAR       0x0040
957 #define ATH9K_PCI_AR9565_1ANT     0x0080
958 #define ATH9K_PCI_AR9565_2ANT     0x0100
959 #define ATH9K_PCI_NO_PLL_PWRSAVE  0x0200
960 #define ATH9K_PCI_KILLER          0x0400
961 #define ATH9K_PCI_LED_ACT_HI      0x0800
962
963 /*
964  * Default cache line size, in bytes.
965  * Used when PCI device not fully initialized by bootrom/BIOS
966 */
967 #define DEFAULT_CACHELINE       32
968 #define ATH_CABQ_READY_TIME     80      /* % of beacon interval */
969 #define ATH_TXPOWER_MAX         100     /* .5 dBm units */
970 #define MAX_GTT_CNT             5
971
972 /* Powersave flags */
973 #define PS_WAIT_FOR_BEACON        BIT(0)
974 #define PS_WAIT_FOR_CAB           BIT(1)
975 #define PS_WAIT_FOR_PSPOLL_DATA   BIT(2)
976 #define PS_WAIT_FOR_TX_ACK        BIT(3)
977 #define PS_BEACON_SYNC            BIT(4)
978 #define PS_WAIT_FOR_ANI           BIT(5)
979
980 #define ATH9K_NUM_CHANCTX  2 /* supports 2 operating channels */
981
982 #define AIRTIME_USE_TX          BIT(0)
983 #define AIRTIME_USE_RX          BIT(1)
984 #define AIRTIME_USE_NEW_QUEUES  BIT(2)
985 #define AIRTIME_ACTIVE(flags) (!!(flags & (AIRTIME_USE_TX|AIRTIME_USE_RX)))
986
987 struct ath_softc {
988         struct ieee80211_hw *hw;
989         struct device *dev;
990
991         struct survey_info *cur_survey;
992         struct survey_info survey[ATH9K_NUM_CHANNELS];
993
994         struct tasklet_struct intr_tq;
995         struct tasklet_struct bcon_tasklet;
996         struct ath_hw *sc_ah;
997         void __iomem *mem;
998         int irq;
999         spinlock_t sc_serial_rw;
1000         spinlock_t sc_pm_lock;
1001         spinlock_t sc_pcu_lock;
1002         struct mutex mutex;
1003         struct work_struct paprd_work;
1004         struct work_struct hw_reset_work;
1005         struct completion paprd_complete;
1006         wait_queue_head_t tx_wait;
1007
1008 #ifdef CONFIG_ATH9K_CHANNEL_CONTEXT
1009         struct work_struct chanctx_work;
1010         struct ath_gen_timer *p2p_ps_timer;
1011         struct ath_vif *p2p_ps_vif;
1012         struct ath_chanctx_sched sched;
1013         struct ath_offchannel offchannel;
1014         struct ath_chanctx *next_chan;
1015         struct completion go_beacon;
1016         struct timespec last_event_time;
1017 #endif
1018
1019         unsigned long driver_data;
1020
1021         u8 gtt_cnt;
1022         u32 intrstatus;
1023         u16 ps_flags; /* PS_* */
1024         bool ps_enabled;
1025         bool ps_idle;
1026         short nbcnvifs;
1027         unsigned long ps_usecount;
1028
1029         u16 airtime_flags; /* AIRTIME_* */
1030
1031         struct ath_rx rx;
1032         struct ath_tx tx;
1033         struct ath_beacon beacon;
1034
1035         struct cfg80211_chan_def cur_chandef;
1036         struct ath_chanctx chanctx[ATH9K_NUM_CHANCTX];
1037         struct ath_chanctx *cur_chan;
1038         spinlock_t chan_lock;
1039
1040 #ifdef CONFIG_MAC80211_LEDS
1041         bool led_registered;
1042         char led_name[32];
1043         struct led_classdev led_cdev;
1044 #endif
1045
1046 #ifdef CONFIG_ATH9K_DEBUGFS
1047         struct ath9k_debug debug;
1048 #endif
1049         struct delayed_work tx_complete_work;
1050         struct delayed_work hw_pll_work;
1051         struct timer_list sleep_timer;
1052
1053 #ifdef CONFIG_ATH9K_BTCOEX_SUPPORT
1054         struct ath_btcoex btcoex;
1055         struct ath_mci_coex mci_coex;
1056         struct work_struct mci_work;
1057 #endif
1058
1059         struct ath_descdma txsdma;
1060
1061         struct ath_ant_comb ant_comb;
1062         u8 ant_tx, ant_rx;
1063         struct dfs_pattern_detector *dfs_detector;
1064         u64 dfs_prev_pulse_ts;
1065         u32 wow_enabled;
1066
1067         struct ath_spec_scan_priv spec_priv;
1068
1069         struct ieee80211_vif *tx99_vif;
1070         struct sk_buff *tx99_skb;
1071         bool tx99_state;
1072         s16 tx99_power;
1073
1074 #ifdef CONFIG_ATH9K_WOW
1075         u32 wow_intr_before_sleep;
1076         bool force_wow;
1077 #endif
1078
1079 #ifdef CONFIG_ATH9K_HWRNG
1080         u32 rng_last;
1081         struct task_struct *rng_task;
1082 #endif
1083 };
1084
1085 /********/
1086 /* TX99 */
1087 /********/
1088
1089 #ifdef CONFIG_ATH9K_TX99
1090 void ath9k_tx99_init_debug(struct ath_softc *sc);
1091 int ath9k_tx99_send(struct ath_softc *sc, struct sk_buff *skb,
1092                     struct ath_tx_control *txctl);
1093 #else
1094 static inline void ath9k_tx99_init_debug(struct ath_softc *sc)
1095 {
1096 }
1097 static inline int ath9k_tx99_send(struct ath_softc *sc,
1098                                   struct sk_buff *skb,
1099                                   struct ath_tx_control *txctl)
1100 {
1101         return 0;
1102 }
1103 #endif /* CONFIG_ATH9K_TX99 */
1104
1105 /***************************/
1106 /* Random Number Generator */
1107 /***************************/
1108 #ifdef CONFIG_ATH9K_HWRNG
1109 void ath9k_rng_start(struct ath_softc *sc);
1110 void ath9k_rng_stop(struct ath_softc *sc);
1111 #else
1112 static inline void ath9k_rng_start(struct ath_softc *sc)
1113 {
1114 }
1115
1116 static inline void ath9k_rng_stop(struct ath_softc *sc)
1117 {
1118 }
1119 #endif
1120
1121 static inline void ath_read_cachesize(struct ath_common *common, int *csz)
1122 {
1123         common->bus_ops->read_cachesize(common, csz);
1124 }
1125
1126 void ath9k_tasklet(unsigned long data);
1127 int ath_cabq_update(struct ath_softc *);
1128 u8 ath9k_parse_mpdudensity(u8 mpdudensity);
1129 irqreturn_t ath_isr(int irq, void *dev);
1130 int ath_reset(struct ath_softc *sc, struct ath9k_channel *hchan);
1131 void ath_cancel_work(struct ath_softc *sc);
1132 void ath_restart_work(struct ath_softc *sc);
1133 int ath9k_init_device(u16 devid, struct ath_softc *sc,
1134                     const struct ath_bus_ops *bus_ops);
1135 void ath9k_deinit_device(struct ath_softc *sc);
1136 void ath9k_reload_chainmask_settings(struct ath_softc *sc);
1137 u8 ath_txchainmask_reduction(struct ath_softc *sc, u8 chainmask, u32 rate);
1138 void ath_start_rfkill_poll(struct ath_softc *sc);
1139 void ath9k_rfkill_poll_state(struct ieee80211_hw *hw);
1140 void ath9k_ps_wakeup(struct ath_softc *sc);
1141 void ath9k_ps_restore(struct ath_softc *sc);
1142
1143 #ifdef CONFIG_ATH9K_PCI
1144 int ath_pci_init(void);
1145 void ath_pci_exit(void);
1146 #else
1147 static inline int ath_pci_init(void) { return 0; };
1148 static inline void ath_pci_exit(void) {};
1149 #endif
1150
1151 #ifdef CONFIG_ATH9K_AHB
1152 int ath_ahb_init(void);
1153 void ath_ahb_exit(void);
1154 #else
1155 static inline int ath_ahb_init(void) { return 0; };
1156 static inline void ath_ahb_exit(void) {};
1157 #endif
1158
1159 #endif /* ATH9K_H */