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