airo: clean up and clarify interrupt-time task handling
[linux-2.6] / drivers / net / wireless / ath9k / core.h
1 /*
2  * Copyright (c) 2008 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 CORE_H
18 #define CORE_H
19
20 #include <linux/etherdevice.h>
21 #include <linux/device.h>
22 #include <net/mac80211.h>
23 #include <linux/leds.h>
24 #include <linux/rfkill.h>
25
26 #include "ath9k.h"
27 #include "rc.h"
28
29 struct ath_node;
30
31 /* Macro to expand scalars to 64-bit objects */
32
33 #define ito64(x) (sizeof(x) == 8) ?                     \
34         (((unsigned long long int)(x)) & (0xff)) :      \
35         (sizeof(x) == 16) ?                             \
36         (((unsigned long long int)(x)) & 0xffff) :      \
37         ((sizeof(x) == 32) ?                            \
38          (((unsigned long long int)(x)) & 0xffffffff) : \
39          (unsigned long long int)(x))
40
41 /* increment with wrap-around */
42 #define INCR(_l, _sz)   do {                    \
43                 (_l)++;                         \
44                 (_l) &= ((_sz) - 1);            \
45         } while (0)
46
47 /* decrement with wrap-around */
48 #define DECR(_l,  _sz)  do {                    \
49                 (_l)--;                         \
50                 (_l) &= ((_sz) - 1);            \
51         } while (0)
52
53 #define A_MAX(a, b) ((a) > (b) ? (a) : (b))
54
55 #define ASSERT(exp) do {                        \
56                 if (unlikely(!(exp))) {         \
57                         BUG();                  \
58                 }                               \
59         } while (0)
60
61 #define TSF_TO_TU(_h,_l) \
62         ((((u32)(_h)) << 22) | (((u32)(_l)) >> 10))
63
64 #define ATH_TXQ_SETUP(sc, i)        ((sc)->tx.txqsetup & (1<<i))
65
66 static const u8 ath_bcast_mac[ETH_ALEN] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
67
68 enum ATH_DEBUG {
69         ATH_DBG_RESET           = 0x00000001,
70         ATH_DBG_REG_IO          = 0x00000002,
71         ATH_DBG_QUEUE           = 0x00000004,
72         ATH_DBG_EEPROM          = 0x00000008,
73         ATH_DBG_CALIBRATE       = 0x00000010,
74         ATH_DBG_CHANNEL         = 0x00000020,
75         ATH_DBG_INTERRUPT       = 0x00000040,
76         ATH_DBG_REGULATORY      = 0x00000080,
77         ATH_DBG_ANI             = 0x00000100,
78         ATH_DBG_POWER_MGMT      = 0x00000200,
79         ATH_DBG_XMIT            = 0x00000400,
80         ATH_DBG_BEACON          = 0x00001000,
81         ATH_DBG_CONFIG          = 0x00002000,
82         ATH_DBG_KEYCACHE        = 0x00004000,
83         ATH_DBG_FATAL           = 0x00008000,
84         ATH_DBG_ANY             = 0xffffffff
85 };
86
87 #define DBG_DEFAULT (ATH_DBG_FATAL)
88
89 #ifdef CONFIG_ATH9K_DEBUG
90
91 /**
92  * struct ath_interrupt_stats - Contains statistics about interrupts
93  * @total: Total no. of interrupts generated so far
94  * @rxok: RX with no errors
95  * @rxeol: RX with no more RXDESC available
96  * @rxorn: RX FIFO overrun
97  * @txok: TX completed at the requested rate
98  * @txurn: TX FIFO underrun
99  * @mib: MIB regs reaching its threshold
100  * @rxphyerr: RX with phy errors
101  * @rx_keycache_miss: RX with key cache misses
102  * @swba: Software Beacon Alert
103  * @bmiss: Beacon Miss
104  * @bnr: Beacon Not Ready
105  * @cst: Carrier Sense TImeout
106  * @gtt: Global TX Timeout
107  * @tim: RX beacon TIM occurrence
108  * @cabend: RX End of CAB traffic
109  * @dtimsync: DTIM sync lossage
110  * @dtim: RX Beacon with DTIM
111  */
112 struct ath_interrupt_stats {
113         u32 total;
114         u32 rxok;
115         u32 rxeol;
116         u32 rxorn;
117         u32 txok;
118         u32 txeol;
119         u32 txurn;
120         u32 mib;
121         u32 rxphyerr;
122         u32 rx_keycache_miss;
123         u32 swba;
124         u32 bmiss;
125         u32 bnr;
126         u32 cst;
127         u32 gtt;
128         u32 tim;
129         u32 cabend;
130         u32 dtimsync;
131         u32 dtim;
132 };
133
134 struct ath_stats {
135         struct ath_interrupt_stats istats;
136 };
137
138 struct ath9k_debug {
139         int debug_mask;
140         struct dentry *debugfs_root;
141         struct dentry *debugfs_phy;
142         struct dentry *debugfs_dma;
143         struct dentry *debugfs_interrupt;
144         struct dentry *debugfs_tsf;
145         struct ath_stats stats;
146 };
147
148 void DPRINTF(struct ath_softc *sc, int dbg_mask, const char *fmt, ...);
149 int ath9k_init_debug(struct ath_softc *sc);
150 void ath9k_exit_debug(struct ath_softc *sc);
151 void ath_debug_stat_interrupt(struct ath_softc *sc, enum ath9k_int status);
152
153 #else
154
155 static inline void DPRINTF(struct ath_softc *sc, int dbg_mask,
156                            const char *fmt, ...)
157 {
158 }
159
160 static inline int ath9k_init_debug(struct ath_softc *sc)
161 {
162         return 0;
163 }
164
165 static inline void ath9k_exit_debug(struct ath_softc *sc)
166 {
167 }
168
169 static inline void ath_debug_stat_interrupt(struct ath_softc *sc,
170                                             enum ath9k_int status)
171 {
172 }
173
174 #endif /* CONFIG_ATH9K_DEBUG */
175
176 struct ath_config {
177         u32 ath_aggr_prot;
178         u16 txpowlimit;
179         u16 txpowlimit_override;
180         u8 cabqReadytime;
181         u8 swBeaconProcess;
182 };
183
184 /*************************/
185 /* Descriptor Management */
186 /*************************/
187
188 #define ATH_TXBUF_RESET(_bf) do {                               \
189                 (_bf)->bf_status = 0;                           \
190                 (_bf)->bf_lastbf = NULL;                        \
191                 (_bf)->bf_next = NULL;                          \
192                 memset(&((_bf)->bf_state), 0,                   \
193                             sizeof(struct ath_buf_state));      \
194         } while (0)
195
196 enum buffer_type {
197         BUF_DATA                = BIT(0),
198         BUF_AGGR                = BIT(1),
199         BUF_AMPDU               = BIT(2),
200         BUF_HT                  = BIT(3),
201         BUF_RETRY               = BIT(4),
202         BUF_XRETRY              = BIT(5),
203         BUF_SHORT_PREAMBLE      = BIT(6),
204         BUF_BAR                 = BIT(7),
205         BUF_PSPOLL              = BIT(8),
206         BUF_AGGR_BURST          = BIT(9),
207         BUF_CALC_AIRTIME        = BIT(10),
208 };
209
210 struct ath_buf_state {
211         int bfs_nframes;                /* # frames in aggregate */
212         u16 bfs_al;                     /* length of aggregate */
213         u16 bfs_frmlen;                 /* length of frame */
214         int bfs_seqno;                  /* sequence number */
215         int bfs_tidno;                  /* tid of this frame */
216         int bfs_retries;                /* current retries */
217         u32 bf_type;                    /* BUF_* (enum buffer_type) */
218         u32 bfs_keyix;
219         enum ath9k_key_type bfs_keytype;
220 };
221
222 #define bf_nframes              bf_state.bfs_nframes
223 #define bf_al                   bf_state.bfs_al
224 #define bf_frmlen               bf_state.bfs_frmlen
225 #define bf_retries              bf_state.bfs_retries
226 #define bf_seqno                bf_state.bfs_seqno
227 #define bf_tidno                bf_state.bfs_tidno
228 #define bf_rcs                  bf_state.bfs_rcs
229 #define bf_keyix                bf_state.bfs_keyix
230 #define bf_keytype              bf_state.bfs_keytype
231 #define bf_isdata(bf)           (bf->bf_state.bf_type & BUF_DATA)
232 #define bf_isaggr(bf)           (bf->bf_state.bf_type & BUF_AGGR)
233 #define bf_isampdu(bf)          (bf->bf_state.bf_type & BUF_AMPDU)
234 #define bf_isht(bf)             (bf->bf_state.bf_type & BUF_HT)
235 #define bf_isretried(bf)        (bf->bf_state.bf_type & BUF_RETRY)
236 #define bf_isxretried(bf)       (bf->bf_state.bf_type & BUF_XRETRY)
237 #define bf_isshpreamble(bf)     (bf->bf_state.bf_type & BUF_SHORT_PREAMBLE)
238 #define bf_isbar(bf)            (bf->bf_state.bf_type & BUF_BAR)
239 #define bf_ispspoll(bf)         (bf->bf_state.bf_type & BUF_PSPOLL)
240 #define bf_isaggrburst(bf)      (bf->bf_state.bf_type & BUF_AGGR_BURST)
241
242 /*
243  * Abstraction of a contiguous buffer to transmit/receive.  There is only
244  * a single hw descriptor encapsulated here.
245  */
246 struct ath_buf {
247         struct list_head list;
248         struct ath_buf *bf_lastbf;      /* last buf of this unit (a frame or
249                                            an aggregate) */
250         struct ath_buf *bf_next;        /* next subframe in the aggregate */
251         void *bf_mpdu;                  /* enclosing frame structure */
252         struct ath_desc *bf_desc;       /* virtual addr of desc */
253         dma_addr_t bf_daddr;            /* physical addr of desc */
254         dma_addr_t bf_buf_addr;         /* physical addr of data buffer */
255         u32 bf_status;
256         u16 bf_flags;                   /* tx descriptor flags */
257         struct ath_buf_state bf_state;  /* buffer state */
258         dma_addr_t bf_dmacontext;
259 };
260
261 #define ATH_RXBUF_RESET(_bf)    ((_bf)->bf_status = 0)
262 #define ATH_BUFSTATUS_STALE     0x00000002
263
264 /* DMA state for tx/rx descriptors */
265
266 struct ath_descdma {
267         const char *dd_name;
268         struct ath_desc *dd_desc;       /* descriptors  */
269         dma_addr_t dd_desc_paddr;       /* physical addr of dd_desc  */
270         u32 dd_desc_len;                /* size of dd_desc  */
271         struct ath_buf *dd_bufptr;      /* associated buffers */
272         dma_addr_t dd_dmacontext;
273 };
274
275 int ath_descdma_setup(struct ath_softc *sc, struct ath_descdma *dd,
276                       struct list_head *head, const char *name,
277                       int nbuf, int ndesc);
278 void ath_descdma_cleanup(struct ath_softc *sc, struct ath_descdma *dd,
279                          struct list_head *head);
280
281 /***********/
282 /* RX / TX */
283 /***********/
284
285 #define ATH_MAX_ANTENNA         3
286 #define ATH_RXBUF               512
287 #define WME_NUM_TID             16
288 #define ATH_TXBUF               512
289 #define ATH_TXMAXTRY            13
290 #define ATH_11N_TXMAXTRY        10
291 #define ATH_MGT_TXMAXTRY        4
292 #define WME_BA_BMP_SIZE         64
293 #define WME_MAX_BA              WME_BA_BMP_SIZE
294 #define ATH_TID_MAX_BUFS        (2 * WME_MAX_BA)
295
296 #define TID_TO_WME_AC(_tid)                             \
297         ((((_tid) == 0) || ((_tid) == 3)) ? WME_AC_BE : \
298          (((_tid) == 1) || ((_tid) == 2)) ? WME_AC_BK : \
299          (((_tid) == 4) || ((_tid) == 5)) ? WME_AC_VI : \
300          WME_AC_VO)
301
302 #define WME_AC_BE   0
303 #define WME_AC_BK   1
304 #define WME_AC_VI   2
305 #define WME_AC_VO   3
306 #define WME_NUM_AC  4
307
308 #define ADDBA_EXCHANGE_ATTEMPTS    10
309 #define ATH_AGGR_DELIM_SZ          4
310 #define ATH_AGGR_MINPLEN           256 /* in bytes, minimum packet length */
311 /* number of delimiters for encryption padding */
312 #define ATH_AGGR_ENCRYPTDELIM      10
313 /* minimum h/w qdepth to be sustained to maximize aggregation */
314 #define ATH_AGGR_MIN_QDEPTH        2
315 #define ATH_AMPDU_SUBFRAME_DEFAULT 32
316 #define IEEE80211_SEQ_SEQ_SHIFT    4
317 #define IEEE80211_SEQ_MAX          4096
318 #define IEEE80211_MIN_AMPDU_BUF    0x8
319 #define IEEE80211_HTCAP_MAXRXAMPDU_FACTOR 13
320
321 /* return whether a bit at index _n in bitmap _bm is set
322  * _sz is the size of the bitmap  */
323 #define ATH_BA_ISSET(_bm, _n)  (((_n) < (WME_BA_BMP_SIZE)) &&           \
324                                 ((_bm)[(_n) >> 5] & (1 << ((_n) & 31))))
325
326 /* return block-ack bitmap index given sequence and starting sequence */
327 #define ATH_BA_INDEX(_st, _seq) (((_seq) - (_st)) & (IEEE80211_SEQ_MAX - 1))
328
329 /* returns delimiter padding required given the packet length */
330 #define ATH_AGGR_GET_NDELIM(_len)                                       \
331         (((((_len) + ATH_AGGR_DELIM_SZ) < ATH_AGGR_MINPLEN) ?           \
332           (ATH_AGGR_MINPLEN - (_len) - ATH_AGGR_DELIM_SZ) : 0) >> 2)
333
334 #define BAW_WITHIN(_start, _bawsz, _seqno) \
335         ((((_seqno) - (_start)) & 4095) < (_bawsz))
336
337 #define ATH_DS_BA_SEQ(_ds)         ((_ds)->ds_us.tx.ts_seqnum)
338 #define ATH_DS_BA_BITMAP(_ds)      (&(_ds)->ds_us.tx.ba_low)
339 #define ATH_DS_TX_BA(_ds)          ((_ds)->ds_us.tx.ts_flags & ATH9K_TX_BA)
340 #define ATH_AN_2_TID(_an, _tidno)  (&(_an)->tid[(_tidno)])
341
342 enum ATH_AGGR_STATUS {
343         ATH_AGGR_DONE,
344         ATH_AGGR_BAW_CLOSED,
345         ATH_AGGR_LIMITED,
346         ATH_AGGR_SHORTPKT,
347         ATH_AGGR_8K_LIMITED,
348 };
349
350 struct ath_txq {
351         u32 axq_qnum;                   /* hardware q number */
352         u32 *axq_link;                  /* link ptr in last TX desc */
353         struct list_head axq_q;         /* transmit queue */
354         spinlock_t axq_lock;
355         u32 axq_depth;                  /* queue depth */
356         u8 axq_aggr_depth;              /* aggregates queued */
357         u32 axq_totalqueued;            /* total ever queued */
358         bool stopped;                   /* Is mac80211 queue stopped ? */
359         struct ath_buf *axq_linkbuf;    /* virtual addr of last buffer*/
360
361         /* first desc of the last descriptor that contains CTS */
362         struct ath_desc *axq_lastdsWithCTS;
363
364         /* final desc of the gating desc that determines whether
365            lastdsWithCTS has been DMA'ed or not */
366         struct ath_desc *axq_gatingds;
367
368         struct list_head axq_acq;
369 };
370
371 #define AGGR_CLEANUP         BIT(1)
372 #define AGGR_ADDBA_COMPLETE  BIT(2)
373 #define AGGR_ADDBA_PROGRESS  BIT(3)
374
375 /* per TID aggregate tx state for a destination */
376 struct ath_atx_tid {
377         struct list_head list;          /* round-robin tid entry */
378         struct list_head buf_q;         /* pending buffers */
379         struct ath_node *an;
380         struct ath_atx_ac *ac;
381         struct ath_buf *tx_buf[ATH_TID_MAX_BUFS]; /* active tx frames */
382         u16 seq_start;
383         u16 seq_next;
384         u16 baw_size;
385         int tidno;
386         int baw_head;                   /* first un-acked tx buffer */
387         int baw_tail;                   /* next unused tx buffer slot */
388         int sched;
389         int paused;
390         u8 state;
391         int addba_exchangeattempts;
392 };
393
394 /* per access-category aggregate tx state for a destination */
395 struct ath_atx_ac {
396         int sched;                      /* dest-ac is scheduled */
397         int qnum;                       /* H/W queue number associated
398                                            with this AC */
399         struct list_head list;          /* round-robin txq entry */
400         struct list_head tid_q;         /* queue of TIDs with buffers */
401 };
402
403 /* per-frame tx control block */
404 struct ath_tx_control {
405         struct ath_txq *txq;
406         int if_id;
407 };
408
409 /* per frame tx status block */
410 struct ath_xmit_status {
411         int retries;    /* number of retries to successufully
412                            transmit this frame */
413         int flags;      /* status of transmit */
414 #define ATH_TX_ERROR        0x01
415 #define ATH_TX_XRETRY       0x02
416 #define ATH_TX_BAR          0x04
417 };
418
419 /* All RSSI values are noise floor adjusted */
420 struct ath_tx_stat {
421         int rssi;
422         int rssictl[ATH_MAX_ANTENNA];
423         int rssiextn[ATH_MAX_ANTENNA];
424         int rateieee;
425         int rateKbps;
426         int ratecode;
427         int flags;
428         u32 airtime;    /* time on air per final tx rate */
429 };
430
431 struct aggr_rifs_param {
432         int param_max_frames;
433         int param_max_len;
434         int param_rl;
435         int param_al;
436         struct ath_rc_series *param_rcs;
437 };
438
439 struct ath_node {
440         struct ath_softc *an_sc;
441         struct ath_atx_tid tid[WME_NUM_TID];
442         struct ath_atx_ac ac[WME_NUM_AC];
443         u16 maxampdu;
444         u8 mpdudensity;
445 };
446
447 struct ath_tx {
448         u16 seq_no;
449         u32 txqsetup;
450         int hwq_map[ATH9K_WME_AC_VO+1];
451         spinlock_t txbuflock;
452         struct list_head txbuf;
453         struct ath_txq txq[ATH9K_NUM_TX_QUEUES];
454         struct ath_descdma txdma;
455 };
456
457 struct ath_rx {
458         u8 defant;
459         u8 rxotherant;
460         u32 *rxlink;
461         int bufsize;
462         unsigned int rxfilter;
463         spinlock_t rxflushlock;
464         spinlock_t rxbuflock;
465         struct list_head rxbuf;
466         struct ath_descdma rxdma;
467 };
468
469 int ath_startrecv(struct ath_softc *sc);
470 bool ath_stoprecv(struct ath_softc *sc);
471 void ath_flushrecv(struct ath_softc *sc);
472 u32 ath_calcrxfilter(struct ath_softc *sc);
473 int ath_rx_init(struct ath_softc *sc, int nbufs);
474 void ath_rx_cleanup(struct ath_softc *sc);
475 int ath_rx_tasklet(struct ath_softc *sc, int flush);
476 struct ath_txq *ath_txq_setup(struct ath_softc *sc, int qtype, int subtype);
477 void ath_tx_cleanupq(struct ath_softc *sc, struct ath_txq *txq);
478 int ath_tx_setup(struct ath_softc *sc, int haltype);
479 void ath_drain_all_txq(struct ath_softc *sc, bool retry_tx);
480 void ath_draintxq(struct ath_softc *sc,
481                      struct ath_txq *txq, bool retry_tx);
482 void ath_tx_node_init(struct ath_softc *sc, struct ath_node *an);
483 void ath_tx_node_cleanup(struct ath_softc *sc, struct ath_node *an);
484 void ath_txq_schedule(struct ath_softc *sc, struct ath_txq *txq);
485 int ath_tx_init(struct ath_softc *sc, int nbufs);
486 int ath_tx_cleanup(struct ath_softc *sc);
487 struct ath_txq *ath_test_get_txq(struct ath_softc *sc, struct sk_buff *skb);
488 int ath_txq_update(struct ath_softc *sc, int qnum,
489                    struct ath9k_tx_queue_info *q);
490 int ath_tx_start(struct ath_softc *sc, struct sk_buff *skb,
491                  struct ath_tx_control *txctl);
492 void ath_tx_tasklet(struct ath_softc *sc);
493 void ath_tx_cabq(struct ath_softc *sc, struct sk_buff *skb);
494 bool ath_tx_aggr_check(struct ath_softc *sc, struct ath_node *an, u8 tidno);
495 int ath_tx_aggr_start(struct ath_softc *sc, struct ieee80211_sta *sta,
496                       u16 tid, u16 *ssn);
497 int ath_tx_aggr_stop(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
498 void ath_tx_aggr_resume(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
499
500 /********/
501 /* VAPs */
502 /********/
503
504 /*
505  * Define the scheme that we select MAC address for multiple
506  * BSS on the same radio. The very first VAP will just use the MAC
507  * address from the EEPROM. For the next 3 VAPs, we set the
508  * U/L bit (bit 1) in MAC address, and use the next two bits as the
509  * index of the VAP.
510  */
511
512 #define ATH_SET_VAP_BSSID_MASK(bssid_mask) \
513         ((bssid_mask)[0] &= ~(((ATH_BCBUF-1)<<2)|0x02))
514
515 struct ath_vap {
516         int av_bslot;
517         enum nl80211_iftype av_opmode;
518         struct ath_buf *av_bcbuf;
519         struct ath_tx_control av_btxctl;
520 };
521
522 /*******************/
523 /* Beacon Handling */
524 /*******************/
525
526 /*
527  * Regardless of the number of beacons we stagger, (i.e. regardless of the
528  * number of BSSIDs) if a given beacon does not go out even after waiting this
529  * number of beacon intervals, the game's up.
530  */
531 #define BSTUCK_THRESH                   (9 * ATH_BCBUF)
532 #define ATH_BCBUF                       1
533 #define ATH_DEFAULT_BINTVAL             100 /* TU */
534 #define ATH_DEFAULT_BMISS_LIMIT         10
535 #define IEEE80211_MS_TO_TU(x)           (((x) * 1000) / 1024)
536
537 struct ath_beacon_config {
538         u16 beacon_interval;
539         u16 listen_interval;
540         u16 dtim_period;
541         u16 bmiss_timeout;
542         u8 dtim_count;
543         u8 tim_offset;
544         union {
545                 u64 last_tsf;
546                 u8 last_tstamp[8];
547         } u; /* last received beacon/probe response timestamp of this BSS. */
548 };
549
550 struct ath_beacon {
551         enum {
552                 OK,             /* no change needed */
553                 UPDATE,         /* update pending */
554                 COMMIT          /* beacon sent, commit change */
555         } updateslot;           /* slot time update fsm */
556
557         u32 beaconq;
558         u32 bmisscnt;
559         u32 ast_be_xmit;
560         u64 bc_tstamp;
561         int bslot[ATH_BCBUF];
562         int slottime;
563         int slotupdate;
564         struct ath9k_tx_queue_info beacon_qi;
565         struct ath_descdma bdma;
566         struct ath_txq *cabq;
567         struct list_head bbuf;
568 };
569
570 void ath9k_beacon_tasklet(unsigned long data);
571 void ath_beacon_config(struct ath_softc *sc, int if_id);
572 int ath_beaconq_setup(struct ath_hal *ah);
573 int ath_beacon_alloc(struct ath_softc *sc, int if_id);
574 void ath_beacon_return(struct ath_softc *sc, struct ath_vap *avp);
575 void ath_beacon_sync(struct ath_softc *sc, int if_id);
576
577 /*******/
578 /* ANI */
579 /*******/
580
581 /* ANI values for STA only.
582    FIXME: Add appropriate values for AP later */
583
584 #define ATH_ANI_POLLINTERVAL    100     /* 100 milliseconds between ANI poll */
585 #define ATH_SHORT_CALINTERVAL   1000    /* 1 second between calibrations */
586 #define ATH_LONG_CALINTERVAL    30000   /* 30 seconds between calibrations */
587 #define ATH_RESTART_CALINTERVAL 1200000 /* 20 minutes between calibrations */
588
589 struct ath_ani {
590         bool sc_caldone;
591         int16_t sc_noise_floor;
592         unsigned int sc_longcal_timer;
593         unsigned int sc_shortcal_timer;
594         unsigned int sc_resetcal_timer;
595         unsigned int sc_checkani_timer;
596         struct timer_list timer;
597 };
598
599 /********************/
600 /*   LED Control    */
601 /********************/
602
603 #define ATH_LED_PIN     1
604
605 enum ath_led_type {
606         ATH_LED_RADIO,
607         ATH_LED_ASSOC,
608         ATH_LED_TX,
609         ATH_LED_RX
610 };
611
612 struct ath_led {
613         struct ath_softc *sc;
614         struct led_classdev led_cdev;
615         enum ath_led_type led_type;
616         char name[32];
617         bool registered;
618 };
619
620 /* Rfkill */
621 #define ATH_RFKILL_POLL_INTERVAL        2000 /* msecs */
622
623 struct ath_rfkill {
624         struct rfkill *rfkill;
625         struct delayed_work rfkill_poll;
626         char rfkill_name[32];
627 };
628
629 /********************/
630 /* Main driver core */
631 /********************/
632
633 /*
634  * Default cache line size, in bytes.
635  * Used when PCI device not fully initialized by bootrom/BIOS
636 */
637 #define DEFAULT_CACHELINE       32
638 #define ATH_DEFAULT_NOISE_FLOOR -95
639 #define ATH_REGCLASSIDS_MAX     10
640 #define ATH_CABQ_READY_TIME     80      /* % of beacon interval */
641 #define ATH_MAX_SW_RETRIES      10
642 #define ATH_CHAN_MAX            255
643 #define IEEE80211_WEP_NKID      4       /* number of key ids */
644 #define IEEE80211_RATE_VAL      0x7f
645 /*
646  * The key cache is used for h/w cipher state and also for
647  * tracking station state such as the current tx antenna.
648  * We also setup a mapping table between key cache slot indices
649  * and station state to short-circuit node lookups on rx.
650  * Different parts have different size key caches.  We handle
651  * up to ATH_KEYMAX entries (could dynamically allocate state).
652  */
653 #define ATH_KEYMAX              128     /* max key cache size we handle */
654
655 #define ATH_IF_ID_ANY           0xff
656 #define ATH_TXPOWER_MAX         100     /* .5 dBm units */
657 #define ATH_RSSI_DUMMY_MARKER   0x127
658 #define ATH_RATE_DUMMY_MARKER   0
659
660 enum PROT_MODE {
661         PROT_M_NONE = 0,
662         PROT_M_RTSCTS,
663         PROT_M_CTSONLY
664 };
665
666 #define SC_OP_INVALID           BIT(0)
667 #define SC_OP_BEACONS           BIT(1)
668 #define SC_OP_RXAGGR            BIT(2)
669 #define SC_OP_TXAGGR            BIT(3)
670 #define SC_OP_CHAINMASK_UPDATE  BIT(4)
671 #define SC_OP_FULL_RESET        BIT(5)
672 #define SC_OP_NO_RESET          BIT(6)
673 #define SC_OP_PREAMBLE_SHORT    BIT(7)
674 #define SC_OP_PROTECT_ENABLE    BIT(8)
675 #define SC_OP_RXFLUSH           BIT(9)
676 #define SC_OP_LED_ASSOCIATED    BIT(10)
677 #define SC_OP_RFKILL_REGISTERED BIT(11)
678 #define SC_OP_RFKILL_SW_BLOCKED BIT(12)
679 #define SC_OP_RFKILL_HW_BLOCKED BIT(13)
680 #define SC_OP_WAIT_FOR_BEACON   BIT(14)
681
682 struct ath_bus_ops {
683         void            (*read_cachesize)(struct ath_softc *sc, int *csz);
684         void            (*cleanup)(struct ath_softc *sc);
685         bool            (*eeprom_read)(struct ath_hal *ah, u32 off, u16 *data);
686 };
687
688 struct ath_softc {
689         struct ieee80211_hw *hw;
690         struct device *dev;
691         struct tasklet_struct intr_tq;
692         struct tasklet_struct bcon_tasklet;
693         struct ath_hal *sc_ah;
694         void __iomem *mem;
695         int irq;
696         spinlock_t sc_resetlock;
697         struct mutex mutex;
698
699         u8 sc_curbssid[ETH_ALEN];
700         u8 sc_myaddr[ETH_ALEN];
701         u8 sc_bssidmask[ETH_ALEN];
702         u32 sc_intrstatus;
703         u32 sc_flags; /* SC_OP_* */
704         u16 sc_curtxpow;
705         u16 sc_curaid;
706         u16 sc_cachelsz;
707         u8 sc_nbcnvaps;
708         u16 sc_nvaps;
709         u8 sc_tx_chainmask;
710         u8 sc_rx_chainmask;
711         u32 sc_keymax;
712         DECLARE_BITMAP(sc_keymap, ATH_KEYMAX);
713         u8 sc_splitmic;
714         atomic_t ps_usecount;
715         enum ath9k_int sc_imask;
716         enum PROT_MODE sc_protmode;
717         enum ath9k_ht_extprotspacing sc_ht_extprotspacing;
718         enum ath9k_ht_macmode tx_chan_width;
719
720         struct ath_config sc_config;
721         struct ath_rx rx;
722         struct ath_tx tx;
723         struct ath_beacon beacon;
724         struct ieee80211_vif *sc_vaps[ATH_BCBUF];
725         struct ieee80211_rate rates[IEEE80211_NUM_BANDS][ATH_RATE_MAX];
726         struct ath_rate_table *hw_rate_table[ATH9K_MODE_MAX];
727         struct ath_rate_table *cur_rate_table;
728         struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
729         struct ath_led radio_led;
730         struct ath_led assoc_led;
731         struct ath_led tx_led;
732         struct ath_led rx_led;
733         struct ath_rfkill rf_kill;
734         struct ath_ani sc_ani;
735         struct ath9k_node_stats sc_halstats;
736 #ifdef CONFIG_ATH9K_DEBUG
737         struct ath9k_debug sc_debug;
738 #endif
739         struct ath_bus_ops *bus_ops;
740 };
741
742 int ath_reset(struct ath_softc *sc, bool retry_tx);
743 int ath_get_hal_qnum(u16 queue, struct ath_softc *sc);
744 int ath_get_mac80211_qnum(u32 queue, struct ath_softc *sc);
745 int ath_cabq_update(struct ath_softc *);
746
747 static inline void ath_read_cachesize(struct ath_softc *sc, int *csz)
748 {
749         sc->bus_ops->read_cachesize(sc, csz);
750 }
751
752 static inline void ath_bus_cleanup(struct ath_softc *sc)
753 {
754         sc->bus_ops->cleanup(sc);
755 }
756
757 extern struct ieee80211_ops ath9k_ops;
758
759 irqreturn_t ath_isr(int irq, void *dev);
760 void ath_cleanup(struct ath_softc *sc);
761 int ath_attach(u16 devid, struct ath_softc *sc);
762 void ath_detach(struct ath_softc *sc);
763 const char *ath_mac_bb_name(u32 mac_bb_version);
764 const char *ath_rf_name(u16 rf_version);
765
766 #ifdef CONFIG_PCI
767 int ath_pci_init(void);
768 void ath_pci_exit(void);
769 #else
770 static inline int ath_pci_init(void) { return 0; };
771 static inline void ath_pci_exit(void) {};
772 #endif
773
774 #ifdef CONFIG_ATHEROS_AR71XX
775 int ath_ahb_init(void);
776 void ath_ahb_exit(void);
777 #else
778 static inline int ath_ahb_init(void) { return 0; };
779 static inline void ath_ahb_exit(void) {};
780 #endif
781
782 static inline void ath9k_ps_wakeup(struct ath_softc *sc)
783 {
784         if (atomic_inc_return(&sc->ps_usecount) == 1)
785                 if (sc->sc_ah->ah_power_mode !=  ATH9K_PM_AWAKE) {
786                         sc->sc_ah->ah_restore_mode = sc->sc_ah->ah_power_mode;
787                         ath9k_hw_setpower(sc->sc_ah, ATH9K_PM_AWAKE);
788                 }
789 }
790
791 static inline void ath9k_ps_restore(struct ath_softc *sc)
792 {
793         if (atomic_dec_and_test(&sc->ps_usecount))
794                 if (sc->hw->conf.flags & IEEE80211_CONF_PS)
795                         ath9k_hw_setpower(sc->sc_ah,
796                                           sc->sc_ah->ah_restore_mode);
797 }
798 #endif /* CORE_H */