ath: move ath_bcast_mac to common header
[linux-2.6.git] / drivers / net / wireless / ath / ath9k / ath9k.h
1 /*
2  * Copyright (c) 2008-2009 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 <net/mac80211.h>
23 #include <linux/leds.h>
24
25 #include "hw.h"
26 #include "rc.h"
27 #include "debug.h"
28 #include "../ath.h"
29
30 struct ath_node;
31
32 /* Macro to expand scalars to 64-bit objects */
33
34 #define ito64(x) (sizeof(x) == 8) ?                     \
35         (((unsigned long long int)(x)) & (0xff)) :      \
36         (sizeof(x) == 16) ?                             \
37         (((unsigned long long int)(x)) & 0xffff) :      \
38         ((sizeof(x) == 32) ?                            \
39          (((unsigned long long int)(x)) & 0xffffffff) : \
40          (unsigned long long int)(x))
41
42 /* increment with wrap-around */
43 #define INCR(_l, _sz)   do {                    \
44                 (_l)++;                         \
45                 (_l) &= ((_sz) - 1);            \
46         } while (0)
47
48 /* decrement with wrap-around */
49 #define DECR(_l,  _sz)  do {                    \
50                 (_l)--;                         \
51                 (_l) &= ((_sz) - 1);            \
52         } while (0)
53
54 #define A_MAX(a, b) ((a) > (b) ? (a) : (b))
55
56 #define ASSERT(exp) BUG_ON(!(exp))
57
58 #define TSF_TO_TU(_h,_l) \
59         ((((u32)(_h)) << 22) | (((u32)(_l)) >> 10))
60
61 #define ATH_TXQ_SETUP(sc, i)        ((sc)->tx.txqsetup & (1<<i))
62
63 struct ath_config {
64         u32 ath_aggr_prot;
65         u16 txpowlimit;
66         u8 cabqReadytime;
67 };
68
69 /*************************/
70 /* Descriptor Management */
71 /*************************/
72
73 #define ATH_TXBUF_RESET(_bf) do {                               \
74                 (_bf)->bf_stale = false;                        \
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 #define ATH_RXBUF_RESET(_bf) do {               \
82                 (_bf)->bf_stale = false;        \
83         } while (0)
84
85 /**
86  * enum buffer_type - Buffer type flags
87  *
88  * @BUF_HT: Send this buffer using HT capabilities
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  * @BUF_RETRY: Indicates whether the buffer is retried
93  * @BUF_XRETRY: To denote excessive retries of the buffer
94  */
95 enum buffer_type {
96         BUF_HT                  = BIT(1),
97         BUF_AMPDU               = BIT(2),
98         BUF_AGGR                = BIT(3),
99         BUF_RETRY               = BIT(4),
100         BUF_XRETRY              = BIT(5),
101 };
102
103 struct ath_buf_state {
104         int bfs_nframes;
105         u16 bfs_al;
106         u16 bfs_frmlen;
107         int bfs_seqno;
108         int bfs_tidno;
109         int bfs_retries;
110         u8 bf_type;
111         u32 bfs_keyix;
112         enum ath9k_key_type bfs_keytype;
113 };
114
115 #define bf_nframes              bf_state.bfs_nframes
116 #define bf_al                   bf_state.bfs_al
117 #define bf_frmlen               bf_state.bfs_frmlen
118 #define bf_retries              bf_state.bfs_retries
119 #define bf_seqno                bf_state.bfs_seqno
120 #define bf_tidno                bf_state.bfs_tidno
121 #define bf_keyix                bf_state.bfs_keyix
122 #define bf_keytype              bf_state.bfs_keytype
123 #define bf_isht(bf)             (bf->bf_state.bf_type & BUF_HT)
124 #define bf_isampdu(bf)          (bf->bf_state.bf_type & BUF_AMPDU)
125 #define bf_isaggr(bf)           (bf->bf_state.bf_type & BUF_AGGR)
126 #define bf_isretried(bf)        (bf->bf_state.bf_type & BUF_RETRY)
127 #define bf_isxretried(bf)       (bf->bf_state.bf_type & BUF_XRETRY)
128
129 struct ath_buf {
130         struct list_head list;
131         struct ath_buf *bf_lastbf;      /* last buf of this unit (a frame or
132                                            an aggregate) */
133         struct ath_buf *bf_next;        /* next subframe in the aggregate */
134         struct sk_buff *bf_mpdu;        /* enclosing frame structure */
135         struct ath_desc *bf_desc;       /* virtual addr of desc */
136         dma_addr_t bf_daddr;            /* physical addr of desc */
137         dma_addr_t bf_buf_addr;         /* physical addr of data buffer */
138         bool bf_stale;
139         u16 bf_flags;
140         struct ath_buf_state bf_state;
141         dma_addr_t bf_dmacontext;
142 };
143
144 struct ath_descdma {
145         struct ath_desc *dd_desc;
146         dma_addr_t dd_desc_paddr;
147         u32 dd_desc_len;
148         struct ath_buf *dd_bufptr;
149 };
150
151 int ath_descdma_setup(struct ath_softc *sc, struct ath_descdma *dd,
152                       struct list_head *head, const char *name,
153                       int nbuf, int ndesc);
154 void ath_descdma_cleanup(struct ath_softc *sc, struct ath_descdma *dd,
155                          struct list_head *head);
156
157 /***********/
158 /* RX / TX */
159 /***********/
160
161 #define ATH_MAX_ANTENNA         3
162 #define ATH_RXBUF               512
163 #define WME_NUM_TID             16
164 #define ATH_TXBUF               512
165 #define ATH_TXMAXTRY            13
166 #define ATH_MGT_TXMAXTRY        4
167 #define WME_BA_BMP_SIZE         64
168 #define WME_MAX_BA              WME_BA_BMP_SIZE
169 #define ATH_TID_MAX_BUFS        (2 * WME_MAX_BA)
170
171 #define TID_TO_WME_AC(_tid)                             \
172         ((((_tid) == 0) || ((_tid) == 3)) ? WME_AC_BE : \
173          (((_tid) == 1) || ((_tid) == 2)) ? WME_AC_BK : \
174          (((_tid) == 4) || ((_tid) == 5)) ? WME_AC_VI : \
175          WME_AC_VO)
176
177 #define WME_AC_BE   0
178 #define WME_AC_BK   1
179 #define WME_AC_VI   2
180 #define WME_AC_VO   3
181 #define WME_NUM_AC  4
182
183 #define ADDBA_EXCHANGE_ATTEMPTS    10
184 #define ATH_AGGR_DELIM_SZ          4
185 #define ATH_AGGR_MINPLEN           256 /* in bytes, minimum packet length */
186 /* number of delimiters for encryption padding */
187 #define ATH_AGGR_ENCRYPTDELIM      10
188 /* minimum h/w qdepth to be sustained to maximize aggregation */
189 #define ATH_AGGR_MIN_QDEPTH        2
190 #define ATH_AMPDU_SUBFRAME_DEFAULT 32
191 #define ATH_AMPDU_LIMIT_MAX        (64 * 1024 - 1)
192
193 #define IEEE80211_SEQ_SEQ_SHIFT    4
194 #define IEEE80211_SEQ_MAX          4096
195 #define IEEE80211_WEP_IVLEN        3
196 #define IEEE80211_WEP_KIDLEN       1
197 #define IEEE80211_WEP_CRCLEN       4
198 #define IEEE80211_MAX_MPDU_LEN     (3840 + FCS_LEN +            \
199                                     (IEEE80211_WEP_IVLEN +      \
200                                      IEEE80211_WEP_KIDLEN +     \
201                                      IEEE80211_WEP_CRCLEN))
202
203 /* return whether a bit at index _n in bitmap _bm is set
204  * _sz is the size of the bitmap  */
205 #define ATH_BA_ISSET(_bm, _n)  (((_n) < (WME_BA_BMP_SIZE)) &&           \
206                                 ((_bm)[(_n) >> 5] & (1 << ((_n) & 31))))
207
208 /* return block-ack bitmap index given sequence and starting sequence */
209 #define ATH_BA_INDEX(_st, _seq) (((_seq) - (_st)) & (IEEE80211_SEQ_MAX - 1))
210
211 /* returns delimiter padding required given the packet length */
212 #define ATH_AGGR_GET_NDELIM(_len)                                       \
213         (((((_len) + ATH_AGGR_DELIM_SZ) < ATH_AGGR_MINPLEN) ?           \
214           (ATH_AGGR_MINPLEN - (_len) - ATH_AGGR_DELIM_SZ) : 0) >> 2)
215
216 #define BAW_WITHIN(_start, _bawsz, _seqno) \
217         ((((_seqno) - (_start)) & 4095) < (_bawsz))
218
219 #define ATH_DS_BA_SEQ(_ds)         ((_ds)->ds_us.tx.ts_seqnum)
220 #define ATH_DS_BA_BITMAP(_ds)      (&(_ds)->ds_us.tx.ba_low)
221 #define ATH_DS_TX_BA(_ds)          ((_ds)->ds_us.tx.ts_flags & ATH9K_TX_BA)
222 #define ATH_AN_2_TID(_an, _tidno)  (&(_an)->tid[(_tidno)])
223
224 #define ATH_TX_COMPLETE_POLL_INT        1000
225
226 enum ATH_AGGR_STATUS {
227         ATH_AGGR_DONE,
228         ATH_AGGR_BAW_CLOSED,
229         ATH_AGGR_LIMITED,
230 };
231
232 struct ath_txq {
233         u32 axq_qnum;
234         u32 *axq_link;
235         struct list_head axq_q;
236         spinlock_t axq_lock;
237         u32 axq_depth;
238         u8 axq_aggr_depth;
239         bool stopped;
240         bool axq_tx_inprogress;
241         struct ath_buf *axq_linkbuf;
242
243         /* first desc of the last descriptor that contains CTS */
244         struct ath_desc *axq_lastdsWithCTS;
245
246         /* final desc of the gating desc that determines whether
247            lastdsWithCTS has been DMA'ed or not */
248         struct ath_desc *axq_gatingds;
249
250         struct list_head axq_acq;
251 };
252
253 #define AGGR_CLEANUP         BIT(1)
254 #define AGGR_ADDBA_COMPLETE  BIT(2)
255 #define AGGR_ADDBA_PROGRESS  BIT(3)
256
257 struct ath_atx_tid {
258         struct list_head list;
259         struct list_head buf_q;
260         struct ath_node *an;
261         struct ath_atx_ac *ac;
262         struct ath_buf *tx_buf[ATH_TID_MAX_BUFS];
263         u16 seq_start;
264         u16 seq_next;
265         u16 baw_size;
266         int tidno;
267         int baw_head;   /* first un-acked tx buffer */
268         int baw_tail;   /* next unused tx buffer slot */
269         int sched;
270         int paused;
271         u8 state;
272 };
273
274 struct ath_atx_ac {
275         int sched;
276         int qnum;
277         struct list_head list;
278         struct list_head tid_q;
279 };
280
281 struct ath_tx_control {
282         struct ath_txq *txq;
283         int if_id;
284         enum ath9k_internal_frame_type frame_type;
285 };
286
287 #define ATH_TX_ERROR        0x01
288 #define ATH_TX_XRETRY       0x02
289 #define ATH_TX_BAR          0x04
290
291 #define ATH_RSSI_LPF_LEN                10
292 #define RSSI_LPF_THRESHOLD              -20
293 #define ATH9K_RSSI_BAD                  0x80
294 #define ATH_RSSI_EP_MULTIPLIER     (1<<7)
295 #define ATH_EP_MUL(x, mul)         ((x) * (mul))
296 #define ATH_RSSI_IN(x)             (ATH_EP_MUL((x), ATH_RSSI_EP_MULTIPLIER))
297 #define ATH_LPF_RSSI(x, y, len) \
298     ((x != ATH_RSSI_DUMMY_MARKER) ? (((x) * ((len) - 1) + (y)) / (len)) : (y))
299 #define ATH_RSSI_LPF(x, y) do {                                         \
300     if ((y) >= RSSI_LPF_THRESHOLD)                                      \
301         x = ATH_LPF_RSSI((x), ATH_RSSI_IN((y)), ATH_RSSI_LPF_LEN);      \
302 } while (0)
303 #define ATH_EP_RND(x, mul)                                              \
304         ((((x)%(mul)) >= ((mul)/2)) ? ((x) + ((mul) - 1)) / (mul) : (x)/(mul))
305
306 struct ath_node {
307         struct ath_softc *an_sc;
308         struct ath_atx_tid tid[WME_NUM_TID];
309         struct ath_atx_ac ac[WME_NUM_AC];
310         u16 maxampdu;
311         u8 mpdudensity;
312         int last_rssi;
313 };
314
315 struct ath_tx {
316         u16 seq_no;
317         u32 txqsetup;
318         int hwq_map[ATH9K_WME_AC_VO+1];
319         spinlock_t txbuflock;
320         struct list_head txbuf;
321         struct ath_txq txq[ATH9K_NUM_TX_QUEUES];
322         struct ath_descdma txdma;
323 };
324
325 struct ath_rx {
326         u8 defant;
327         u8 rxotherant;
328         u32 *rxlink;
329         int bufsize;
330         unsigned int rxfilter;
331         spinlock_t rxflushlock;
332         spinlock_t rxbuflock;
333         struct list_head rxbuf;
334         struct ath_descdma rxdma;
335 };
336
337 int ath_startrecv(struct ath_softc *sc);
338 bool ath_stoprecv(struct ath_softc *sc);
339 void ath_flushrecv(struct ath_softc *sc);
340 u32 ath_calcrxfilter(struct ath_softc *sc);
341 int ath_rx_init(struct ath_softc *sc, int nbufs);
342 void ath_rx_cleanup(struct ath_softc *sc);
343 int ath_rx_tasklet(struct ath_softc *sc, int flush);
344 struct ath_txq *ath_txq_setup(struct ath_softc *sc, int qtype, int subtype);
345 void ath_tx_cleanupq(struct ath_softc *sc, struct ath_txq *txq);
346 int ath_tx_setup(struct ath_softc *sc, int haltype);
347 void ath_drain_all_txq(struct ath_softc *sc, bool retry_tx);
348 void ath_draintxq(struct ath_softc *sc,
349                      struct ath_txq *txq, bool retry_tx);
350 void ath_tx_node_init(struct ath_softc *sc, struct ath_node *an);
351 void ath_tx_node_cleanup(struct ath_softc *sc, struct ath_node *an);
352 void ath_txq_schedule(struct ath_softc *sc, struct ath_txq *txq);
353 int ath_tx_init(struct ath_softc *sc, int nbufs);
354 void ath_tx_cleanup(struct ath_softc *sc);
355 struct ath_txq *ath_test_get_txq(struct ath_softc *sc, struct sk_buff *skb);
356 int ath_txq_update(struct ath_softc *sc, int qnum,
357                    struct ath9k_tx_queue_info *q);
358 int ath_tx_start(struct ieee80211_hw *hw, struct sk_buff *skb,
359                  struct ath_tx_control *txctl);
360 void ath_tx_tasklet(struct ath_softc *sc);
361 void ath_tx_cabq(struct ieee80211_hw *hw, struct sk_buff *skb);
362 bool ath_tx_aggr_check(struct ath_softc *sc, struct ath_node *an, u8 tidno);
363 void ath_tx_aggr_start(struct ath_softc *sc, struct ieee80211_sta *sta,
364                        u16 tid, u16 *ssn);
365 void ath_tx_aggr_stop(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
366 void ath_tx_aggr_resume(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
367
368 /********/
369 /* VIFs */
370 /********/
371
372 struct ath_vif {
373         int av_bslot;
374         __le64 tsf_adjust; /* TSF adjustment for staggered beacons */
375         enum nl80211_iftype av_opmode;
376         struct ath_buf *av_bcbuf;
377         struct ath_tx_control av_btxctl;
378         u8 bssid[ETH_ALEN]; /* current BSSID from config_interface */
379 };
380
381 /*******************/
382 /* Beacon Handling */
383 /*******************/
384
385 /*
386  * Regardless of the number of beacons we stagger, (i.e. regardless of the
387  * number of BSSIDs) if a given beacon does not go out even after waiting this
388  * number of beacon intervals, the game's up.
389  */
390 #define BSTUCK_THRESH                   (9 * ATH_BCBUF)
391 #define ATH_BCBUF                       4
392 #define ATH_DEFAULT_BINTVAL             100 /* TU */
393 #define ATH_DEFAULT_BMISS_LIMIT         10
394 #define IEEE80211_MS_TO_TU(x)           (((x) * 1000) / 1024)
395
396 struct ath_beacon_config {
397         u16 beacon_interval;
398         u16 listen_interval;
399         u16 dtim_period;
400         u16 bmiss_timeout;
401         u8 dtim_count;
402 };
403
404 struct ath_beacon {
405         enum {
406                 OK,             /* no change needed */
407                 UPDATE,         /* update pending */
408                 COMMIT          /* beacon sent, commit change */
409         } updateslot;           /* slot time update fsm */
410
411         u32 beaconq;
412         u32 bmisscnt;
413         u32 ast_be_xmit;
414         u64 bc_tstamp;
415         struct ieee80211_vif *bslot[ATH_BCBUF];
416         struct ath_wiphy *bslot_aphy[ATH_BCBUF];
417         int slottime;
418         int slotupdate;
419         struct ath9k_tx_queue_info beacon_qi;
420         struct ath_descdma bdma;
421         struct ath_txq *cabq;
422         struct list_head bbuf;
423 };
424
425 void ath_beacon_tasklet(unsigned long data);
426 void ath_beacon_config(struct ath_softc *sc, struct ieee80211_vif *vif);
427 int ath_beaconq_setup(struct ath_hw *ah);
428 int ath_beacon_alloc(struct ath_wiphy *aphy, struct ieee80211_vif *vif);
429 void ath_beacon_return(struct ath_softc *sc, struct ath_vif *avp);
430
431 /*******/
432 /* ANI */
433 /*******/
434
435 #define ATH_STA_SHORT_CALINTERVAL 1000    /* 1 second */
436 #define ATH_AP_SHORT_CALINTERVAL  100     /* 100 ms */
437 #define ATH_ANI_POLLINTERVAL      100     /* 100 ms */
438 #define ATH_LONG_CALINTERVAL      30000   /* 30 seconds */
439 #define ATH_RESTART_CALINTERVAL   1200000 /* 20 minutes */
440
441 struct ath_ani {
442         bool caldone;
443         int16_t noise_floor;
444         unsigned int longcal_timer;
445         unsigned int shortcal_timer;
446         unsigned int resetcal_timer;
447         unsigned int checkani_timer;
448         struct timer_list timer;
449 };
450
451 /* Defines the BT AR_BT_COEX_WGHT used */
452 enum ath_stomp_type {
453         ATH_BTCOEX_NO_STOMP,
454         ATH_BTCOEX_STOMP_ALL,
455         ATH_BTCOEX_STOMP_LOW,
456         ATH_BTCOEX_STOMP_NONE
457 };
458
459 struct ath_btcoex {
460         bool hw_timer_enabled;
461         spinlock_t btcoex_lock;
462         struct timer_list period_timer; /* Timer for BT period */
463         u32 bt_priority_cnt;
464         unsigned long bt_priority_time;
465         int bt_stomp_type; /* Types of BT stomping */
466         u32 btcoex_no_stomp; /* in usec */
467         u32 btcoex_period; /* in usec */
468         struct ath_gen_timer *no_stomp_timer; /* Timer for no BT stomping */
469 };
470
471 /********************/
472 /*   LED Control    */
473 /********************/
474
475 #define ATH_LED_PIN_DEF                 1
476 #define ATH_LED_PIN_9287                8
477 #define ATH_LED_ON_DURATION_IDLE        350     /* in msecs */
478 #define ATH_LED_OFF_DURATION_IDLE       250     /* in msecs */
479
480 enum ath_led_type {
481         ATH_LED_RADIO,
482         ATH_LED_ASSOC,
483         ATH_LED_TX,
484         ATH_LED_RX
485 };
486
487 struct ath_led {
488         struct ath_softc *sc;
489         struct led_classdev led_cdev;
490         enum ath_led_type led_type;
491         char name[32];
492         bool registered;
493 };
494
495 /********************/
496 /* Main driver core */
497 /********************/
498
499 /*
500  * Default cache line size, in bytes.
501  * Used when PCI device not fully initialized by bootrom/BIOS
502 */
503 #define DEFAULT_CACHELINE       32
504 #define ATH_DEFAULT_NOISE_FLOOR -95
505 #define ATH_REGCLASSIDS_MAX     10
506 #define ATH_CABQ_READY_TIME     80      /* % of beacon interval */
507 #define ATH_MAX_SW_RETRIES      10
508 #define ATH_CHAN_MAX            255
509 #define IEEE80211_WEP_NKID      4       /* number of key ids */
510
511 /*
512  * The key cache is used for h/w cipher state and also for
513  * tracking station state such as the current tx antenna.
514  * We also setup a mapping table between key cache slot indices
515  * and station state to short-circuit node lookups on rx.
516  * Different parts have different size key caches.  We handle
517  * up to ATH_KEYMAX entries (could dynamically allocate state).
518  */
519 #define ATH_KEYMAX              128     /* max key cache size we handle */
520
521 #define ATH_TXPOWER_MAX         100     /* .5 dBm units */
522 #define ATH_RSSI_DUMMY_MARKER   0x127
523 #define ATH_RATE_DUMMY_MARKER   0
524
525 #define SC_OP_INVALID           BIT(0)
526 #define SC_OP_BEACONS           BIT(1)
527 #define SC_OP_RXAGGR            BIT(2)
528 #define SC_OP_TXAGGR            BIT(3)
529 #define SC_OP_FULL_RESET        BIT(4)
530 #define SC_OP_PREAMBLE_SHORT    BIT(5)
531 #define SC_OP_PROTECT_ENABLE    BIT(6)
532 #define SC_OP_RXFLUSH           BIT(7)
533 #define SC_OP_LED_ASSOCIATED    BIT(8)
534 #define SC_OP_WAIT_FOR_BEACON   BIT(12)
535 #define SC_OP_LED_ON            BIT(13)
536 #define SC_OP_SCANNING          BIT(14)
537 #define SC_OP_TSF_RESET         BIT(15)
538 #define SC_OP_WAIT_FOR_CAB      BIT(16)
539 #define SC_OP_WAIT_FOR_PSPOLL_DATA BIT(17)
540 #define SC_OP_WAIT_FOR_TX_ACK   BIT(18)
541 #define SC_OP_BEACON_SYNC       BIT(19)
542 #define SC_OP_BT_PRIORITY_DETECTED BIT(21)
543
544 struct ath_bus_ops {
545         void            (*read_cachesize)(struct ath_softc *sc, int *csz);
546         void            (*cleanup)(struct ath_softc *sc);
547         bool            (*eeprom_read)(struct ath_hw *ah, u32 off, u16 *data);
548 };
549
550 struct ath_wiphy;
551
552 struct ath_softc {
553         struct ieee80211_hw *hw;
554         struct device *dev;
555
556         struct ath_common common;
557
558         spinlock_t wiphy_lock; /* spinlock to protect ath_wiphy data */
559         struct ath_wiphy *pri_wiphy;
560         struct ath_wiphy **sec_wiphy; /* secondary wiphys (virtual radios); may
561                                        * have NULL entries */
562         int num_sec_wiphy; /* number of sec_wiphy pointers in the array */
563         int chan_idx;
564         int chan_is_ht;
565         struct ath_wiphy *next_wiphy;
566         struct work_struct chan_work;
567         int wiphy_select_failures;
568         unsigned long wiphy_select_first_fail;
569         struct delayed_work wiphy_work;
570         unsigned long wiphy_scheduler_int;
571         int wiphy_scheduler_index;
572
573         struct tasklet_struct intr_tq;
574         struct tasklet_struct bcon_tasklet;
575         struct ath_hw *sc_ah;
576         void __iomem *mem;
577         int irq;
578         spinlock_t sc_resetlock;
579         spinlock_t sc_serial_rw;
580         spinlock_t ani_lock;
581         spinlock_t sc_pm_lock;
582         struct mutex mutex;
583
584         u8 curbssid[ETH_ALEN];
585         u8 bssidmask[ETH_ALEN];
586         u32 intrstatus;
587         u32 sc_flags; /* SC_OP_* */
588         u16 curtxpow;
589         u16 curaid;
590         u8 nbcnvifs;
591         u16 nvifs;
592         u8 tx_chainmask;
593         u8 rx_chainmask;
594         u32 keymax;
595         DECLARE_BITMAP(keymap, ATH_KEYMAX);
596         u8 splitmic;
597         bool ps_enabled;
598         unsigned long ps_usecount;
599         enum ath9k_int imask;
600         enum ath9k_ht_extprotspacing ht_extprotspacing;
601         enum ath9k_ht_macmode tx_chan_width;
602
603         struct ath_config config;
604         struct ath_rx rx;
605         struct ath_tx tx;
606         struct ath_beacon beacon;
607         struct ieee80211_rate rates[IEEE80211_NUM_BANDS][ATH_RATE_MAX];
608         const struct ath_rate_table *hw_rate_table[ATH9K_MODE_MAX];
609         const struct ath_rate_table *cur_rate_table;
610         struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
611
612         struct ath_led radio_led;
613         struct ath_led assoc_led;
614         struct ath_led tx_led;
615         struct ath_led rx_led;
616         struct delayed_work ath_led_blink_work;
617         int led_on_duration;
618         int led_off_duration;
619         int led_on_cnt;
620         int led_off_cnt;
621
622         int beacon_interval;
623
624         struct ath_ani ani;
625 #ifdef CONFIG_ATH9K_DEBUG
626         struct ath9k_debug debug;
627 #endif
628         struct ath_bus_ops *bus_ops;
629         struct ath_beacon_config cur_beacon_conf;
630         struct delayed_work tx_complete_work;
631         struct ath_btcoex btcoex;
632 };
633
634 struct ath_wiphy {
635         struct ath_softc *sc; /* shared for all virtual wiphys */
636         struct ieee80211_hw *hw;
637         enum ath_wiphy_state {
638                 ATH_WIPHY_INACTIVE,
639                 ATH_WIPHY_ACTIVE,
640                 ATH_WIPHY_PAUSING,
641                 ATH_WIPHY_PAUSED,
642                 ATH_WIPHY_SCAN,
643         } state;
644         int chan_idx;
645         int chan_is_ht;
646 };
647
648 int ath_reset(struct ath_softc *sc, bool retry_tx);
649 int ath_get_hal_qnum(u16 queue, struct ath_softc *sc);
650 int ath_get_mac80211_qnum(u32 queue, struct ath_softc *sc);
651 int ath_cabq_update(struct ath_softc *);
652
653 static inline struct ath_common *ath9k_hw_common(struct ath_hw *ah)
654 {
655         return &ah->ah_sc->common;
656 }
657
658 static inline struct ath_regulatory *ath9k_hw_regulatory(struct ath_hw *ah)
659 {
660         return &(ath9k_hw_common(ah)->regulatory);
661 }
662
663 static inline void ath_read_cachesize(struct ath_softc *sc, int *csz)
664 {
665         sc->bus_ops->read_cachesize(sc, csz);
666 }
667
668 static inline void ath_bus_cleanup(struct ath_softc *sc)
669 {
670         sc->bus_ops->cleanup(sc);
671 }
672
673 extern struct ieee80211_ops ath9k_ops;
674
675 irqreturn_t ath_isr(int irq, void *dev);
676 void ath_cleanup(struct ath_softc *sc);
677 int ath_init_device(u16 devid, struct ath_softc *sc, u16 subsysid);
678 void ath_detach(struct ath_softc *sc);
679 const char *ath_mac_bb_name(u32 mac_bb_version);
680 const char *ath_rf_name(u16 rf_version);
681 void ath_set_hw_capab(struct ath_softc *sc, struct ieee80211_hw *hw);
682 void ath9k_update_ichannel(struct ath_softc *sc, struct ieee80211_hw *hw,
683                            struct ath9k_channel *ichan);
684 void ath_update_chainmask(struct ath_softc *sc, int is_ht);
685 int ath_set_channel(struct ath_softc *sc, struct ieee80211_hw *hw,
686                     struct ath9k_channel *hchan);
687 void ath_radio_enable(struct ath_softc *sc);
688 void ath_radio_disable(struct ath_softc *sc);
689
690 #ifdef CONFIG_PCI
691 int ath_pci_init(void);
692 void ath_pci_exit(void);
693 #else
694 static inline int ath_pci_init(void) { return 0; };
695 static inline void ath_pci_exit(void) {};
696 #endif
697
698 #ifdef CONFIG_ATHEROS_AR71XX
699 int ath_ahb_init(void);
700 void ath_ahb_exit(void);
701 #else
702 static inline int ath_ahb_init(void) { return 0; };
703 static inline void ath_ahb_exit(void) {};
704 #endif
705
706 void ath9k_ps_wakeup(struct ath_softc *sc);
707 void ath9k_ps_restore(struct ath_softc *sc);
708
709 void ath9k_set_bssid_mask(struct ieee80211_hw *hw);
710 int ath9k_wiphy_add(struct ath_softc *sc);
711 int ath9k_wiphy_del(struct ath_wiphy *aphy);
712 void ath9k_tx_status(struct ieee80211_hw *hw, struct sk_buff *skb);
713 int ath9k_wiphy_pause(struct ath_wiphy *aphy);
714 int ath9k_wiphy_unpause(struct ath_wiphy *aphy);
715 int ath9k_wiphy_select(struct ath_wiphy *aphy);
716 void ath9k_wiphy_set_scheduler(struct ath_softc *sc, unsigned int msec_int);
717 void ath9k_wiphy_chan_work(struct work_struct *work);
718 bool ath9k_wiphy_started(struct ath_softc *sc);
719 void ath9k_wiphy_pause_all_forced(struct ath_softc *sc,
720                                   struct ath_wiphy *selected);
721 bool ath9k_wiphy_scanning(struct ath_softc *sc);
722 void ath9k_wiphy_work(struct work_struct *work);
723 bool ath9k_all_wiphys_idle(struct ath_softc *sc);
724
725 void ath9k_iowrite32(struct ath_hw *ah, u32 reg_offset, u32 val);
726 unsigned int ath9k_ioread32(struct ath_hw *ah, u32 reg_offset);
727
728 int ath_tx_get_qnum(struct ath_softc *sc, int qtype, int haltype);
729 #endif /* ATH9K_H */