Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/linville/wireless
[firefly-linux-kernel-4.4.55.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
26 #include "debug.h"
27 #include "common.h"
28 #include "mci.h"
29 #include "dfs.h"
30
31 /*
32  * Header for the ath9k.ko driver core *only* -- hw code nor any other driver
33  * should rely on this file or its contents.
34  */
35
36 struct ath_node;
37
38 /* Macro to expand scalars to 64-bit objects */
39
40 #define ito64(x) (sizeof(x) == 1) ?                     \
41         (((unsigned long long int)(x)) & (0xff)) :      \
42         (sizeof(x) == 2) ?                              \
43         (((unsigned long long int)(x)) & 0xffff) :      \
44         ((sizeof(x) == 4) ?                             \
45          (((unsigned long long int)(x)) & 0xffffffff) : \
46          (unsigned long long int)(x))
47
48 /* increment with wrap-around */
49 #define INCR(_l, _sz)   do {                    \
50                 (_l)++;                         \
51                 (_l) &= ((_sz) - 1);            \
52         } while (0)
53
54 /* decrement with wrap-around */
55 #define DECR(_l,  _sz)  do {                    \
56                 (_l)--;                         \
57                 (_l) &= ((_sz) - 1);            \
58         } while (0)
59
60 #define TSF_TO_TU(_h,_l) \
61         ((((u32)(_h)) << 22) | (((u32)(_l)) >> 10))
62
63 #define ATH_TXQ_SETUP(sc, i)        ((sc)->tx.txqsetup & (1<<i))
64
65 struct ath_config {
66         u16 txpowlimit;
67         u8 cabqReadytime;
68 };
69
70 /*************************/
71 /* Descriptor Management */
72 /*************************/
73
74 #define ATH_TXBUF_RESET(_bf) do {                               \
75                 (_bf)->bf_stale = false;                        \
76                 (_bf)->bf_lastbf = NULL;                        \
77                 (_bf)->bf_next = NULL;                          \
78                 memset(&((_bf)->bf_state), 0,                   \
79                        sizeof(struct ath_buf_state));           \
80         } while (0)
81
82 #define ATH_RXBUF_RESET(_bf) do {               \
83                 (_bf)->bf_stale = false;        \
84         } while (0)
85
86 /**
87  * enum buffer_type - Buffer type flags
88  *
89  * @BUF_AMPDU: This buffer is an ampdu, as part of an aggregate (during TX)
90  * @BUF_AGGR: Indicates whether the buffer can be aggregated
91  *      (used in aggregation scheduling)
92  */
93 enum buffer_type {
94         BUF_AMPDU               = BIT(0),
95         BUF_AGGR                = BIT(1),
96 };
97
98 #define bf_isampdu(bf)          (bf->bf_state.bf_type & BUF_AMPDU)
99 #define bf_isaggr(bf)           (bf->bf_state.bf_type & BUF_AGGR)
100
101 #define ATH_TXSTATUS_RING_SIZE 512
102
103 #define DS2PHYS(_dd, _ds)                                               \
104         ((_dd)->dd_desc_paddr + ((caddr_t)(_ds) - (caddr_t)(_dd)->dd_desc))
105 #define ATH_DESC_4KB_BOUND_CHECK(_daddr) ((((_daddr) & 0xFFF) > 0xF7F) ? 1 : 0)
106 #define ATH_DESC_4KB_BOUND_NUM_SKIPPED(_len) ((_len) / 4096)
107
108 struct ath_descdma {
109         void *dd_desc;
110         dma_addr_t dd_desc_paddr;
111         u32 dd_desc_len;
112 };
113
114 int ath_descdma_setup(struct ath_softc *sc, struct ath_descdma *dd,
115                       struct list_head *head, const char *name,
116                       int nbuf, int ndesc, bool is_tx);
117
118 /***********/
119 /* RX / TX */
120 /***********/
121
122 #define ATH_RXBUF               512
123 #define ATH_TXBUF               512
124 #define ATH_TXBUF_RESERVE       5
125 #define ATH_MAX_QDEPTH          (ATH_TXBUF / 4 - ATH_TXBUF_RESERVE)
126 #define ATH_TXMAXTRY            13
127
128 #define TID_TO_WME_AC(_tid)                             \
129         ((((_tid) == 0) || ((_tid) == 3)) ? IEEE80211_AC_BE :   \
130          (((_tid) == 1) || ((_tid) == 2)) ? IEEE80211_AC_BK :   \
131          (((_tid) == 4) || ((_tid) == 5)) ? IEEE80211_AC_VI :   \
132          IEEE80211_AC_VO)
133
134 #define ATH_AGGR_DELIM_SZ          4
135 #define ATH_AGGR_MINPLEN           256 /* in bytes, minimum packet length */
136 /* number of delimiters for encryption padding */
137 #define ATH_AGGR_ENCRYPTDELIM      10
138 /* minimum h/w qdepth to be sustained to maximize aggregation */
139 #define ATH_AGGR_MIN_QDEPTH        2
140 #define ATH_AMPDU_SUBFRAME_DEFAULT 32
141
142 #define IEEE80211_SEQ_SEQ_SHIFT    4
143 #define IEEE80211_SEQ_MAX          4096
144 #define IEEE80211_WEP_IVLEN        3
145 #define IEEE80211_WEP_KIDLEN       1
146 #define IEEE80211_WEP_CRCLEN       4
147 #define IEEE80211_MAX_MPDU_LEN     (3840 + FCS_LEN +            \
148                                     (IEEE80211_WEP_IVLEN +      \
149                                      IEEE80211_WEP_KIDLEN +     \
150                                      IEEE80211_WEP_CRCLEN))
151
152 /* return whether a bit at index _n in bitmap _bm is set
153  * _sz is the size of the bitmap  */
154 #define ATH_BA_ISSET(_bm, _n)  (((_n) < (WME_BA_BMP_SIZE)) &&           \
155                                 ((_bm)[(_n) >> 5] & (1 << ((_n) & 31))))
156
157 /* return block-ack bitmap index given sequence and starting sequence */
158 #define ATH_BA_INDEX(_st, _seq) (((_seq) - (_st)) & (IEEE80211_SEQ_MAX - 1))
159
160 /* return the seqno for _start + _offset */
161 #define ATH_BA_INDEX2SEQ(_seq, _offset) (((_seq) + (_offset)) & (IEEE80211_SEQ_MAX - 1))
162
163 /* returns delimiter padding required given the packet length */
164 #define ATH_AGGR_GET_NDELIM(_len)                                       \
165        (((_len) >= ATH_AGGR_MINPLEN) ? 0 :                             \
166         DIV_ROUND_UP(ATH_AGGR_MINPLEN - (_len), ATH_AGGR_DELIM_SZ))
167
168 #define BAW_WITHIN(_start, _bawsz, _seqno) \
169         ((((_seqno) - (_start)) & 4095) < (_bawsz))
170
171 #define ATH_AN_2_TID(_an, _tidno)  (&(_an)->tid[(_tidno)])
172
173 #define IS_CCK_RATE(rate) ((rate >= 0x18) && (rate <= 0x1e))
174
175 #define ATH_TX_COMPLETE_POLL_INT        1000
176
177 enum ATH_AGGR_STATUS {
178         ATH_AGGR_DONE,
179         ATH_AGGR_BAW_CLOSED,
180         ATH_AGGR_LIMITED,
181 };
182
183 #define ATH_TXFIFO_DEPTH 8
184 struct ath_txq {
185         int mac80211_qnum; /* mac80211 queue number, -1 means not mac80211 Q */
186         u32 axq_qnum; /* ath9k hardware queue number */
187         void *axq_link;
188         struct list_head axq_q;
189         spinlock_t axq_lock;
190         u32 axq_depth;
191         u32 axq_ampdu_depth;
192         bool stopped;
193         bool axq_tx_inprogress;
194         struct list_head axq_acq;
195         struct list_head txq_fifo[ATH_TXFIFO_DEPTH];
196         u8 txq_headidx;
197         u8 txq_tailidx;
198         int pending_frames;
199         struct sk_buff_head complete_q;
200 };
201
202 struct ath_atx_ac {
203         struct ath_txq *txq;
204         int sched;
205         struct list_head list;
206         struct list_head tid_q;
207         bool clear_ps_filter;
208 };
209
210 struct ath_frame_info {
211         struct ath_buf *bf;
212         int framelen;
213         enum ath9k_key_type keytype;
214         u8 keyix;
215         u8 retries;
216         u8 rtscts_rate;
217 };
218
219 struct ath_buf_state {
220         u8 bf_type;
221         u8 bfs_paprd;
222         u8 ndelim;
223         u16 seqno;
224         unsigned long bfs_paprd_timestamp;
225 };
226
227 struct ath_buf {
228         struct list_head list;
229         struct ath_buf *bf_lastbf;      /* last buf of this unit (a frame or
230                                            an aggregate) */
231         struct ath_buf *bf_next;        /* next subframe in the aggregate */
232         struct sk_buff *bf_mpdu;        /* enclosing frame structure */
233         void *bf_desc;                  /* virtual addr of desc */
234         dma_addr_t bf_daddr;            /* physical addr of desc */
235         dma_addr_t bf_buf_addr; /* physical addr of data buffer, for DMA */
236         bool bf_stale;
237         struct ath_buf_state bf_state;
238 };
239
240 struct ath_atx_tid {
241         struct list_head list;
242         struct sk_buff_head buf_q;
243         struct ath_node *an;
244         struct ath_atx_ac *ac;
245         unsigned long tx_buf[BITS_TO_LONGS(ATH_TID_MAX_BUFS)];
246         int bar_index;
247         u16 seq_start;
248         u16 seq_next;
249         u16 baw_size;
250         int tidno;
251         int baw_head;   /* first un-acked tx buffer */
252         int baw_tail;   /* next unused tx buffer slot */
253         int sched;
254         int paused;
255         u8 state;
256 };
257
258 struct ath_node {
259         struct ath_softc *sc;
260         struct ieee80211_sta *sta; /* station struct we're part of */
261         struct ieee80211_vif *vif; /* interface with which we're associated */
262         struct ath_atx_tid tid[IEEE80211_NUM_TIDS];
263         struct ath_atx_ac ac[IEEE80211_NUM_ACS];
264         int ps_key;
265
266         u16 maxampdu;
267         u8 mpdudensity;
268
269         bool sleeping;
270
271 #if defined(CONFIG_MAC80211_DEBUGFS) && defined(CONFIG_ATH9K_DEBUGFS)
272         struct dentry *node_stat;
273 #endif
274 };
275
276 #define AGGR_CLEANUP         BIT(1)
277 #define AGGR_ADDBA_COMPLETE  BIT(2)
278 #define AGGR_ADDBA_PROGRESS  BIT(3)
279
280 struct ath_tx_control {
281         struct ath_txq *txq;
282         struct ath_node *an;
283         u8 paprd;
284         struct ieee80211_sta *sta;
285 };
286
287 #define ATH_TX_ERROR        0x01
288
289 /**
290  * @txq_map:  Index is mac80211 queue number.  This is
291  *  not necessarily the same as the hardware queue number
292  *  (axq_qnum).
293  */
294 struct ath_tx {
295         u16 seq_no;
296         u32 txqsetup;
297         spinlock_t txbuflock;
298         struct list_head txbuf;
299         struct ath_txq txq[ATH9K_NUM_TX_QUEUES];
300         struct ath_descdma txdma;
301         struct ath_txq *txq_map[IEEE80211_NUM_ACS];
302         u32 txq_max_pending[IEEE80211_NUM_ACS];
303         u16 max_aggr_framelen[IEEE80211_NUM_ACS][4][32];
304 };
305
306 struct ath_rx_edma {
307         struct sk_buff_head rx_fifo;
308         u32 rx_fifo_hwsize;
309 };
310
311 struct ath_rx {
312         u8 defant;
313         u8 rxotherant;
314         u32 *rxlink;
315         u32 num_pkts;
316         unsigned int rxfilter;
317         struct list_head rxbuf;
318         struct ath_descdma rxdma;
319         struct ath_rx_edma rx_edma[ATH9K_RX_QUEUE_MAX];
320
321         struct sk_buff *frag;
322 };
323
324 int ath_startrecv(struct ath_softc *sc);
325 bool ath_stoprecv(struct ath_softc *sc);
326 u32 ath_calcrxfilter(struct ath_softc *sc);
327 int ath_rx_init(struct ath_softc *sc, int nbufs);
328 void ath_rx_cleanup(struct ath_softc *sc);
329 int ath_rx_tasklet(struct ath_softc *sc, int flush, bool hp);
330 struct ath_txq *ath_txq_setup(struct ath_softc *sc, int qtype, int subtype);
331 void ath_txq_lock(struct ath_softc *sc, struct ath_txq *txq);
332 void ath_txq_unlock(struct ath_softc *sc, struct ath_txq *txq);
333 void ath_txq_unlock_complete(struct ath_softc *sc, struct ath_txq *txq);
334 void ath_tx_cleanupq(struct ath_softc *sc, struct ath_txq *txq);
335 bool ath_drain_all_txq(struct ath_softc *sc);
336 void ath_draintxq(struct ath_softc *sc, struct ath_txq *txq);
337 void ath_tx_node_init(struct ath_softc *sc, struct ath_node *an);
338 void ath_tx_node_cleanup(struct ath_softc *sc, struct ath_node *an);
339 void ath_txq_schedule(struct ath_softc *sc, struct ath_txq *txq);
340 int ath_tx_init(struct ath_softc *sc, int nbufs);
341 int ath_txq_update(struct ath_softc *sc, int qnum,
342                    struct ath9k_tx_queue_info *q);
343 void ath_update_max_aggr_framelen(struct ath_softc *sc, int queue, int txop);
344 int ath_tx_start(struct ieee80211_hw *hw, struct sk_buff *skb,
345                  struct ath_tx_control *txctl);
346 void ath_tx_tasklet(struct ath_softc *sc);
347 void ath_tx_edma_tasklet(struct ath_softc *sc);
348 int ath_tx_aggr_start(struct ath_softc *sc, struct ieee80211_sta *sta,
349                       u16 tid, u16 *ssn);
350 void ath_tx_aggr_stop(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
351 void ath_tx_aggr_resume(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
352
353 void ath_tx_aggr_wakeup(struct ath_softc *sc, struct ath_node *an);
354 void ath_tx_aggr_sleep(struct ieee80211_sta *sta, struct ath_softc *sc,
355                        struct ath_node *an);
356
357 /********/
358 /* VIFs */
359 /********/
360
361 struct ath_vif {
362         int av_bslot;
363         bool primary_sta_vif;
364         __le64 tsf_adjust; /* TSF adjustment for staggered beacons */
365         struct ath_buf *av_bcbuf;
366 };
367
368 /*******************/
369 /* Beacon Handling */
370 /*******************/
371
372 /*
373  * Regardless of the number of beacons we stagger, (i.e. regardless of the
374  * number of BSSIDs) if a given beacon does not go out even after waiting this
375  * number of beacon intervals, the game's up.
376  */
377 #define BSTUCK_THRESH                   9
378 #define ATH_BCBUF                       8
379 #define ATH_DEFAULT_BINTVAL             100 /* TU */
380 #define ATH_DEFAULT_BMISS_LIMIT         10
381 #define IEEE80211_MS_TO_TU(x)           (((x) * 1000) / 1024)
382
383 struct ath_beacon_config {
384         int beacon_interval;
385         u16 listen_interval;
386         u16 dtim_period;
387         u16 bmiss_timeout;
388         u8 dtim_count;
389         bool enable_beacon;
390 };
391
392 struct ath_beacon {
393         enum {
394                 OK,             /* no change needed */
395                 UPDATE,         /* update pending */
396                 COMMIT          /* beacon sent, commit change */
397         } updateslot;           /* slot time update fsm */
398
399         u32 beaconq;
400         u32 bmisscnt;
401         u32 bc_tstamp;
402         struct ieee80211_vif *bslot[ATH_BCBUF];
403         int slottime;
404         int slotupdate;
405         struct ath9k_tx_queue_info beacon_qi;
406         struct ath_descdma bdma;
407         struct ath_txq *cabq;
408         struct list_head bbuf;
409
410         bool tx_processed;
411         bool tx_last;
412 };
413
414 void ath9k_beacon_tasklet(unsigned long data);
415 bool ath9k_allow_beacon_config(struct ath_softc *sc, struct ieee80211_vif *vif);
416 void ath9k_beacon_config(struct ath_softc *sc, struct ieee80211_vif *vif,
417                          u32 changed);
418 void ath9k_beacon_assign_slot(struct ath_softc *sc, struct ieee80211_vif *vif);
419 void ath9k_beacon_remove_slot(struct ath_softc *sc, struct ieee80211_vif *vif);
420 void ath9k_set_tsfadjust(struct ath_softc *sc, struct ieee80211_vif *vif);
421 void ath9k_set_beacon(struct ath_softc *sc);
422
423 /*******************/
424 /* Link Monitoring */
425 /*******************/
426
427 #define ATH_STA_SHORT_CALINTERVAL 1000    /* 1 second */
428 #define ATH_AP_SHORT_CALINTERVAL  100     /* 100 ms */
429 #define ATH_ANI_POLLINTERVAL_OLD  100     /* 100 ms */
430 #define ATH_ANI_POLLINTERVAL_NEW  1000    /* 1000 ms */
431 #define ATH_LONG_CALINTERVAL_INT  1000    /* 1000 ms */
432 #define ATH_LONG_CALINTERVAL      30000   /* 30 seconds */
433 #define ATH_RESTART_CALINTERVAL   1200000 /* 20 minutes */
434 #define ATH_ANI_MAX_SKIP_COUNT  10
435
436 #define ATH_PAPRD_TIMEOUT       100 /* msecs */
437 #define ATH_PLL_WORK_INTERVAL   100
438
439 void ath_tx_complete_poll_work(struct work_struct *work);
440 void ath_reset_work(struct work_struct *work);
441 void ath_hw_check(struct work_struct *work);
442 void ath_hw_pll_work(struct work_struct *work);
443 void ath_rx_poll(unsigned long data);
444 void ath_start_rx_poll(struct ath_softc *sc, u8 nbeacon);
445 void ath_paprd_calibrate(struct work_struct *work);
446 void ath_ani_calibrate(unsigned long data);
447 void ath_start_ani(struct ath_softc *sc);
448 void ath_stop_ani(struct ath_softc *sc);
449 void ath_check_ani(struct ath_softc *sc);
450 int ath_update_survey_stats(struct ath_softc *sc);
451 void ath_update_survey_nf(struct ath_softc *sc, int channel);
452 void ath9k_queue_reset(struct ath_softc *sc, enum ath_reset_type type);
453
454 /**********/
455 /* BTCOEX */
456 /**********/
457
458 #define ATH_DUMP_BTCOEX(_s, _val)                               \
459         do {                                                    \
460                 len += snprintf(buf + len, size - len,          \
461                                 "%20s : %10d\n", _s, (_val));   \
462         } while (0)
463
464 enum bt_op_flags {
465         BT_OP_PRIORITY_DETECTED,
466         BT_OP_SCAN,
467 };
468
469 struct ath_btcoex {
470         bool hw_timer_enabled;
471         spinlock_t btcoex_lock;
472         struct timer_list period_timer; /* Timer for BT period */
473         u32 bt_priority_cnt;
474         unsigned long bt_priority_time;
475         unsigned long op_flags;
476         int bt_stomp_type; /* Types of BT stomping */
477         u32 btcoex_no_stomp; /* in usec */
478         u32 btcoex_period; /* in msec */
479         u32 btscan_no_stomp; /* in usec */
480         u32 duty_cycle;
481         u32 bt_wait_time;
482         int rssi_count;
483         struct ath_gen_timer *no_stomp_timer; /* Timer for no BT stomping */
484         struct ath_mci_profile mci;
485         u8 stomp_audio;
486 };
487
488 #ifdef CONFIG_ATH9K_BTCOEX_SUPPORT
489 int ath9k_init_btcoex(struct ath_softc *sc);
490 void ath9k_deinit_btcoex(struct ath_softc *sc);
491 void ath9k_start_btcoex(struct ath_softc *sc);
492 void ath9k_stop_btcoex(struct ath_softc *sc);
493 void ath9k_btcoex_timer_resume(struct ath_softc *sc);
494 void ath9k_btcoex_timer_pause(struct ath_softc *sc);
495 void ath9k_btcoex_handle_interrupt(struct ath_softc *sc, u32 status);
496 u16 ath9k_btcoex_aggr_limit(struct ath_softc *sc, u32 max_4ms_framelen);
497 void ath9k_btcoex_stop_gen_timer(struct ath_softc *sc);
498 int ath9k_dump_btcoex(struct ath_softc *sc, u8 *buf, u32 size);
499 #else
500 static inline int ath9k_init_btcoex(struct ath_softc *sc)
501 {
502         return 0;
503 }
504 static inline void ath9k_deinit_btcoex(struct ath_softc *sc)
505 {
506 }
507 static inline void ath9k_start_btcoex(struct ath_softc *sc)
508 {
509 }
510 static inline void ath9k_stop_btcoex(struct ath_softc *sc)
511 {
512 }
513 static inline void ath9k_btcoex_handle_interrupt(struct ath_softc *sc,
514                                                  u32 status)
515 {
516 }
517 static inline u16 ath9k_btcoex_aggr_limit(struct ath_softc *sc,
518                                           u32 max_4ms_framelen)
519 {
520         return 0;
521 }
522 static inline void ath9k_btcoex_stop_gen_timer(struct ath_softc *sc)
523 {
524 }
525 static inline int ath9k_dump_btcoex(struct ath_softc *sc, u8 *buf, u32 size)
526 {
527         return 0;
528 }
529 #endif /* CONFIG_ATH9K_BTCOEX_SUPPORT */
530
531 struct ath9k_wow_pattern {
532         u8 pattern_bytes[MAX_PATTERN_SIZE];
533         u8 mask_bytes[MAX_PATTERN_SIZE];
534         u32 pattern_len;
535 };
536
537 /********************/
538 /*   LED Control    */
539 /********************/
540
541 #define ATH_LED_PIN_DEF                 1
542 #define ATH_LED_PIN_9287                8
543 #define ATH_LED_PIN_9300                10
544 #define ATH_LED_PIN_9485                6
545 #define ATH_LED_PIN_9462                4
546
547 #ifdef CONFIG_MAC80211_LEDS
548 void ath_init_leds(struct ath_softc *sc);
549 void ath_deinit_leds(struct ath_softc *sc);
550 void ath_fill_led_pin(struct ath_softc *sc);
551 #else
552 static inline void ath_init_leds(struct ath_softc *sc)
553 {
554 }
555
556 static inline void ath_deinit_leds(struct ath_softc *sc)
557 {
558 }
559 static inline void ath_fill_led_pin(struct ath_softc *sc)
560 {
561 }
562 #endif
563
564 /*******************************/
565 /* Antenna diversity/combining */
566 /*******************************/
567
568 #define ATH_ANT_RX_CURRENT_SHIFT 4
569 #define ATH_ANT_RX_MAIN_SHIFT 2
570 #define ATH_ANT_RX_MASK 0x3
571
572 #define ATH_ANT_DIV_COMB_SHORT_SCAN_INTR 50
573 #define ATH_ANT_DIV_COMB_SHORT_SCAN_PKTCOUNT 0x100
574 #define ATH_ANT_DIV_COMB_MAX_PKTCOUNT 0x200
575 #define ATH_ANT_DIV_COMB_INIT_COUNT 95
576 #define ATH_ANT_DIV_COMB_MAX_COUNT 100
577 #define ATH_ANT_DIV_COMB_ALT_ANT_RATIO 30
578 #define ATH_ANT_DIV_COMB_ALT_ANT_RATIO2 20
579
580 #define ATH_ANT_DIV_COMB_LNA1_LNA2_SWITCH_DELTA -1
581 #define ATH_ANT_DIV_COMB_LNA1_DELTA_HI -4
582 #define ATH_ANT_DIV_COMB_LNA1_DELTA_MID -2
583 #define ATH_ANT_DIV_COMB_LNA1_DELTA_LOW 2
584
585 enum ath9k_ant_div_comb_lna_conf {
586         ATH_ANT_DIV_COMB_LNA1_MINUS_LNA2,
587         ATH_ANT_DIV_COMB_LNA2,
588         ATH_ANT_DIV_COMB_LNA1,
589         ATH_ANT_DIV_COMB_LNA1_PLUS_LNA2,
590 };
591
592 struct ath_ant_comb {
593         u16 count;
594         u16 total_pkt_count;
595         bool scan;
596         bool scan_not_start;
597         int main_total_rssi;
598         int alt_total_rssi;
599         int alt_recv_cnt;
600         int main_recv_cnt;
601         int rssi_lna1;
602         int rssi_lna2;
603         int rssi_add;
604         int rssi_sub;
605         int rssi_first;
606         int rssi_second;
607         int rssi_third;
608         bool alt_good;
609         int quick_scan_cnt;
610         int main_conf;
611         enum ath9k_ant_div_comb_lna_conf first_quick_scan_conf;
612         enum ath9k_ant_div_comb_lna_conf second_quick_scan_conf;
613         bool first_ratio;
614         bool second_ratio;
615         unsigned long scan_start_time;
616 };
617
618 void ath_ant_comb_scan(struct ath_softc *sc, struct ath_rx_status *rs);
619 void ath_ant_comb_update(struct ath_softc *sc);
620
621 /********************/
622 /* Main driver core */
623 /********************/
624
625 /*
626  * Default cache line size, in bytes.
627  * Used when PCI device not fully initialized by bootrom/BIOS
628 */
629 #define DEFAULT_CACHELINE       32
630 #define ATH_REGCLASSIDS_MAX     10
631 #define ATH_CABQ_READY_TIME     80      /* % of beacon interval */
632 #define ATH_MAX_SW_RETRIES      30
633 #define ATH_CHAN_MAX            255
634
635 #define ATH_TXPOWER_MAX         100     /* .5 dBm units */
636 #define ATH_RATE_DUMMY_MARKER   0
637
638 enum sc_op_flags {
639         SC_OP_INVALID,
640         SC_OP_BEACONS,
641         SC_OP_ANI_RUN,
642         SC_OP_PRIM_STA_VIF,
643         SC_OP_HW_RESET,
644 };
645
646 /* Powersave flags */
647 #define PS_WAIT_FOR_BEACON        BIT(0)
648 #define PS_WAIT_FOR_CAB           BIT(1)
649 #define PS_WAIT_FOR_PSPOLL_DATA   BIT(2)
650 #define PS_WAIT_FOR_TX_ACK        BIT(3)
651 #define PS_BEACON_SYNC            BIT(4)
652 #define PS_WAIT_FOR_ANI           BIT(5)
653
654 struct ath_rate_table;
655
656 struct ath9k_vif_iter_data {
657         const u8 *hw_macaddr; /* phy's hardware address, set
658                                * before starting iteration for
659                                * valid bssid mask.
660                                */
661         u8 mask[ETH_ALEN]; /* bssid mask */
662         int naps;      /* number of AP vifs */
663         int nmeshes;   /* number of mesh vifs */
664         int nstations; /* number of station vifs */
665         int nwds;      /* number of WDS vifs */
666         int nadhocs;   /* number of adhoc vifs */
667 };
668
669 /* enum spectral_mode:
670  *
671  * @SPECTRAL_DISABLED: spectral mode is disabled
672  * @SPECTRAL_BACKGROUND: hardware sends samples when it is not busy with
673  *      something else.
674  * @SPECTRAL_MANUAL: spectral scan is enabled, triggering for samples
675  *      is performed manually.
676  * @SPECTRAL_CHANSCAN: Like manual, but also triggered when changing channels
677  *      during a channel scan.
678  */
679 enum spectral_mode {
680         SPECTRAL_DISABLED = 0,
681         SPECTRAL_BACKGROUND,
682         SPECTRAL_MANUAL,
683         SPECTRAL_CHANSCAN,
684 };
685
686 struct ath_softc {
687         struct ieee80211_hw *hw;
688         struct device *dev;
689
690         struct survey_info *cur_survey;
691         struct survey_info survey[ATH9K_NUM_CHANNELS];
692
693         struct tasklet_struct intr_tq;
694         struct tasklet_struct bcon_tasklet;
695         struct ath_hw *sc_ah;
696         void __iomem *mem;
697         int irq;
698         spinlock_t sc_serial_rw;
699         spinlock_t sc_pm_lock;
700         spinlock_t sc_pcu_lock;
701         struct mutex mutex;
702         struct work_struct paprd_work;
703         struct work_struct hw_check_work;
704         struct work_struct hw_reset_work;
705         struct completion paprd_complete;
706
707         unsigned int hw_busy_count;
708         unsigned long sc_flags;
709
710         u32 intrstatus;
711         u16 ps_flags; /* PS_* */
712         u16 curtxpow;
713         bool ps_enabled;
714         bool ps_idle;
715         short nbcnvifs;
716         short nvifs;
717         unsigned long ps_usecount;
718
719         struct ath_config config;
720         struct ath_rx rx;
721         struct ath_tx tx;
722         struct ath_beacon beacon;
723         struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
724
725 #ifdef CONFIG_MAC80211_LEDS
726         bool led_registered;
727         char led_name[32];
728         struct led_classdev led_cdev;
729 #endif
730
731         struct ath9k_hw_cal_data caldata;
732         int last_rssi;
733
734 #ifdef CONFIG_ATH9K_DEBUGFS
735         struct ath9k_debug debug;
736 #endif
737         struct ath_beacon_config cur_beacon_conf;
738         struct delayed_work tx_complete_work;
739         struct delayed_work hw_pll_work;
740         struct timer_list rx_poll_timer;
741
742 #ifdef CONFIG_ATH9K_BTCOEX_SUPPORT
743         struct ath_btcoex btcoex;
744         struct ath_mci_coex mci_coex;
745         struct work_struct mci_work;
746 #endif
747
748         struct ath_descdma txsdma;
749
750         struct ath_ant_comb ant_comb;
751         u8 ant_tx, ant_rx;
752         struct dfs_pattern_detector *dfs_detector;
753         u32 wow_enabled;
754         /* relay(fs) channel for spectral scan */
755         struct rchan *rfs_chan_spec_scan;
756         enum spectral_mode spectral_mode;
757         int scanning;
758
759 #ifdef CONFIG_PM_SLEEP
760         atomic_t wow_got_bmiss_intr;
761         atomic_t wow_sleep_proc_intr; /* in the middle of WoW sleep ? */
762         u32 wow_intr_before_sleep;
763 #endif
764 };
765
766 #define SPECTRAL_SCAN_BITMASK           0x10
767 /* Radar info packet format, used for DFS and spectral formats. */
768 struct ath_radar_info {
769         u8 pulse_length_pri;
770         u8 pulse_length_ext;
771         u8 pulse_bw_info;
772 } __packed;
773
774 /* The HT20 spectral data has 4 bytes of additional information at it's end.
775  *
776  * [7:0]: all bins {max_magnitude[1:0], bitmap_weight[5:0]}
777  * [7:0]: all bins  max_magnitude[9:2]
778  * [7:0]: all bins {max_index[5:0], max_magnitude[11:10]}
779  * [3:0]: max_exp (shift amount to size max bin to 8-bit unsigned)
780  */
781 struct ath_ht20_mag_info {
782         u8 all_bins[3];
783         u8 max_exp;
784 } __packed;
785
786 #define SPECTRAL_HT20_NUM_BINS          56
787
788 /* WARNING: don't actually use this struct! MAC may vary the amount of
789  * data by -1/+2. This struct is for reference only.
790  */
791 struct ath_ht20_fft_packet {
792         u8 data[SPECTRAL_HT20_NUM_BINS];
793         struct ath_ht20_mag_info mag_info;
794         struct ath_radar_info radar_info;
795 } __packed;
796
797 #define SPECTRAL_HT20_TOTAL_DATA_LEN    (sizeof(struct ath_ht20_fft_packet))
798
799 /* Dynamic 20/40 mode:
800  *
801  * [7:0]: lower bins {max_magnitude[1:0], bitmap_weight[5:0]}
802  * [7:0]: lower bins  max_magnitude[9:2]
803  * [7:0]: lower bins {max_index[5:0], max_magnitude[11:10]}
804  * [7:0]: upper bins {max_magnitude[1:0], bitmap_weight[5:0]}
805  * [7:0]: upper bins  max_magnitude[9:2]
806  * [7:0]: upper bins {max_index[5:0], max_magnitude[11:10]}
807  * [3:0]: max_exp (shift amount to size max bin to 8-bit unsigned)
808  */
809 struct ath_ht20_40_mag_info {
810         u8 lower_bins[3];
811         u8 upper_bins[3];
812         u8 max_exp;
813 } __packed;
814
815 #define SPECTRAL_HT20_40_NUM_BINS               128
816
817 /* WARNING: don't actually use this struct! MAC may vary the amount of
818  * data. This struct is for reference only.
819  */
820 struct ath_ht20_40_fft_packet {
821         u8 data[SPECTRAL_HT20_40_NUM_BINS];
822         struct ath_ht20_40_mag_info mag_info;
823         struct ath_radar_info radar_info;
824 } __packed;
825
826
827 #define SPECTRAL_HT20_40_TOTAL_DATA_LEN (sizeof(struct ath_ht20_40_fft_packet))
828
829 /* grabs the max magnitude from the all/upper/lower bins */
830 static inline u16 spectral_max_magnitude(u8 *bins)
831 {
832         return (bins[0] & 0xc0) >> 6 |
833                (bins[1] & 0xff) << 2 |
834                (bins[2] & 0x03) << 10;
835 }
836
837 /* return the max magnitude from the all/upper/lower bins */
838 static inline u8 spectral_max_index(u8 *bins)
839 {
840         s8 m = (bins[2] & 0xfc) >> 2;
841
842         /* TODO: this still doesn't always report the right values ... */
843         if (m > 32)
844                 m |= 0xe0;
845         else
846                 m &= ~0xe0;
847
848         return m + 29;
849 }
850
851 /* return the bitmap weight from the all/upper/lower bins */
852 static inline u8 spectral_bitmap_weight(u8 *bins)
853 {
854         return bins[0] & 0x3f;
855 }
856
857 /* FFT sample format given to userspace via debugfs.
858  *
859  * Please keep the type/length at the front position and change
860  * other fields after adding another sample type
861  *
862  * TODO: this might need rework when switching to nl80211-based
863  * interface.
864  */
865 enum ath_fft_sample_type {
866         ATH_FFT_SAMPLE_HT20 = 0,
867 };
868
869 struct fft_sample_tlv {
870         u8 type;        /* see ath_fft_sample */
871         u16 length;
872         /* type dependent data follows */
873 } __packed;
874
875 struct fft_sample_ht20 {
876         struct fft_sample_tlv tlv;
877
878         u8 __alignment;
879
880         u16 freq;
881         s8 rssi;
882         s8 noise;
883
884         u16 max_magnitude;
885         u8 max_index;
886         u8 bitmap_weight;
887
888         u64 tsf;
889
890         u16 data[SPECTRAL_HT20_NUM_BINS];
891 } __packed;
892
893 void ath9k_tasklet(unsigned long data);
894 int ath_cabq_update(struct ath_softc *);
895
896 static inline void ath_read_cachesize(struct ath_common *common, int *csz)
897 {
898         common->bus_ops->read_cachesize(common, csz);
899 }
900
901 extern struct ieee80211_ops ath9k_ops;
902 extern int ath9k_modparam_nohwcrypt;
903 extern int led_blink;
904 extern bool is_ath9k_unloaded;
905
906 u8 ath9k_parse_mpdudensity(u8 mpdudensity);
907 irqreturn_t ath_isr(int irq, void *dev);
908 int ath9k_init_device(u16 devid, struct ath_softc *sc,
909                     const struct ath_bus_ops *bus_ops);
910 void ath9k_deinit_device(struct ath_softc *sc);
911 void ath9k_set_hw_capab(struct ath_softc *sc, struct ieee80211_hw *hw);
912 void ath9k_reload_chainmask_settings(struct ath_softc *sc);
913
914 bool ath9k_uses_beacons(int type);
915 void ath9k_spectral_scan_trigger(struct ieee80211_hw *hw);
916 int ath9k_spectral_scan_config(struct ieee80211_hw *hw,
917                                enum spectral_mode spectral_mode);
918
919
920 #ifdef CONFIG_ATH9K_PCI
921 int ath_pci_init(void);
922 void ath_pci_exit(void);
923 #else
924 static inline int ath_pci_init(void) { return 0; };
925 static inline void ath_pci_exit(void) {};
926 #endif
927
928 #ifdef CONFIG_ATH9K_AHB
929 int ath_ahb_init(void);
930 void ath_ahb_exit(void);
931 #else
932 static inline int ath_ahb_init(void) { return 0; };
933 static inline void ath_ahb_exit(void) {};
934 #endif
935
936 void ath9k_ps_wakeup(struct ath_softc *sc);
937 void ath9k_ps_restore(struct ath_softc *sc);
938
939 u8 ath_txchainmask_reduction(struct ath_softc *sc, u8 chainmask, u32 rate);
940
941 void ath_start_rfkill_poll(struct ath_softc *sc);
942 extern void ath9k_rfkill_poll_state(struct ieee80211_hw *hw);
943 void ath9k_calculate_iter_data(struct ieee80211_hw *hw,
944                                struct ieee80211_vif *vif,
945                                struct ath9k_vif_iter_data *iter_data);
946
947 #endif /* ATH9K_H */