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