ath9k: Remove includes that are not needed
[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/pci.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)->sc_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 void DPRINTF(struct ath_softc *sc, int dbg_mask, const char *fmt, ...);
92 void ath9k_init_debug(struct ath_softc *sc);
93
94 #else
95
96 static inline void DPRINTF(struct ath_softc *sc, int dbg_mask,
97                            const char *fmt, ...)
98 {
99 }
100
101 static inline ath9k_init_debug(struct ath_softc *sc)
102 {
103 }
104
105 #endif
106
107 struct ath_config {
108         u32 ath_aggr_prot;
109         u16 txpowlimit;
110         u16 txpowlimit_override;
111         u8 cabqReadytime;
112         u8 swBeaconProcess;
113 };
114
115 /*************************/
116 /* Descriptor Management */
117 /*************************/
118
119 #define ATH_TXBUF_RESET(_bf) do {                               \
120                 (_bf)->bf_status = 0;                           \
121                 (_bf)->bf_lastbf = NULL;                        \
122                 (_bf)->bf_lastfrm = NULL;                       \
123                 (_bf)->bf_next = NULL;                          \
124                 memset(&((_bf)->bf_state), 0,                   \
125                             sizeof(struct ath_buf_state));      \
126         } while (0)
127
128 enum buffer_type {
129         BUF_DATA                = BIT(0),
130         BUF_AGGR                = BIT(1),
131         BUF_AMPDU               = BIT(2),
132         BUF_HT                  = BIT(3),
133         BUF_RETRY               = BIT(4),
134         BUF_XRETRY              = BIT(5),
135         BUF_SHORT_PREAMBLE      = BIT(6),
136         BUF_BAR                 = BIT(7),
137         BUF_PSPOLL              = BIT(8),
138         BUF_AGGR_BURST          = BIT(9),
139         BUF_CALC_AIRTIME        = BIT(10),
140 };
141
142 struct ath_buf_state {
143         int bfs_nframes;                /* # frames in aggregate */
144         u16 bfs_al;                     /* length of aggregate */
145         u16 bfs_frmlen;                 /* length of frame */
146         int bfs_seqno;                  /* sequence number */
147         int bfs_tidno;                  /* tid of this frame */
148         int bfs_retries;                /* current retries */
149         u32 bf_type;                    /* BUF_* (enum buffer_type) */
150         u32 bfs_keyix;
151         enum ath9k_key_type bfs_keytype;
152 };
153
154 #define bf_nframes              bf_state.bfs_nframes
155 #define bf_al                   bf_state.bfs_al
156 #define bf_frmlen               bf_state.bfs_frmlen
157 #define bf_retries              bf_state.bfs_retries
158 #define bf_seqno                bf_state.bfs_seqno
159 #define bf_tidno                bf_state.bfs_tidno
160 #define bf_rcs                  bf_state.bfs_rcs
161 #define bf_keyix                bf_state.bfs_keyix
162 #define bf_keytype              bf_state.bfs_keytype
163 #define bf_isdata(bf)           (bf->bf_state.bf_type & BUF_DATA)
164 #define bf_isaggr(bf)           (bf->bf_state.bf_type & BUF_AGGR)
165 #define bf_isampdu(bf)          (bf->bf_state.bf_type & BUF_AMPDU)
166 #define bf_isht(bf)             (bf->bf_state.bf_type & BUF_HT)
167 #define bf_isretried(bf)        (bf->bf_state.bf_type & BUF_RETRY)
168 #define bf_isxretried(bf)       (bf->bf_state.bf_type & BUF_XRETRY)
169 #define bf_isshpreamble(bf)     (bf->bf_state.bf_type & BUF_SHORT_PREAMBLE)
170 #define bf_isbar(bf)            (bf->bf_state.bf_type & BUF_BAR)
171 #define bf_ispspoll(bf)         (bf->bf_state.bf_type & BUF_PSPOLL)
172 #define bf_isaggrburst(bf)      (bf->bf_state.bf_type & BUF_AGGR_BURST)
173
174 /*
175  * Abstraction of a contiguous buffer to transmit/receive.  There is only
176  * a single hw descriptor encapsulated here.
177  */
178 struct ath_buf {
179         struct list_head list;
180         struct list_head *last;
181         struct ath_buf *bf_lastbf;      /* last buf of this unit (a frame or
182                                            an aggregate) */
183         struct ath_buf *bf_lastfrm;     /* last buf of this frame */
184         struct ath_buf *bf_next;        /* next subframe in the aggregate */
185         void *bf_mpdu;                  /* enclosing frame structure */
186         struct ath_desc *bf_desc;       /* virtual addr of desc */
187         dma_addr_t bf_daddr;            /* physical addr of desc */
188         dma_addr_t bf_buf_addr;         /* physical addr of data buffer */
189         u32 bf_status;
190         u16 bf_flags;                   /* tx descriptor flags */
191         struct ath_buf_state bf_state;  /* buffer state */
192         dma_addr_t bf_dmacontext;
193 };
194
195 #define ATH_RXBUF_RESET(_bf)    ((_bf)->bf_status = 0)
196
197 /* hw processing complete, desc processed by hal */
198 #define ATH_BUFSTATUS_DONE      0x00000001
199 /* hw processing complete, desc hold for hw */
200 #define ATH_BUFSTATUS_STALE     0x00000002
201 /* Rx-only: OS is done with this packet and it's ok to queued it to hw */
202 #define ATH_BUFSTATUS_FREE      0x00000004
203
204 /* DMA state for tx/rx descriptors */
205
206 struct ath_descdma {
207         const char *dd_name;
208         struct ath_desc *dd_desc;       /* descriptors  */
209         dma_addr_t dd_desc_paddr;       /* physical addr of dd_desc  */
210         u32 dd_desc_len;                /* size of dd_desc  */
211         struct ath_buf *dd_bufptr;      /* associated buffers */
212         dma_addr_t dd_dmacontext;
213 };
214
215 int ath_descdma_setup(struct ath_softc *sc, struct ath_descdma *dd,
216                       struct list_head *head, const char *name,
217                       int nbuf, int ndesc);
218 void ath_descdma_cleanup(struct ath_softc *sc, struct ath_descdma *dd,
219                          struct list_head *head);
220
221 /***********/
222 /* RX / TX */
223 /***********/
224
225 #define ATH_MAX_ANTENNA          3
226 #define ATH_RXBUF                512
227 #define WME_NUM_TID              16
228
229 int ath_startrecv(struct ath_softc *sc);
230 bool ath_stoprecv(struct ath_softc *sc);
231 void ath_flushrecv(struct ath_softc *sc);
232 u32 ath_calcrxfilter(struct ath_softc *sc);
233 int ath_rx_init(struct ath_softc *sc, int nbufs);
234 void ath_rx_cleanup(struct ath_softc *sc);
235 int ath_rx_tasklet(struct ath_softc *sc, int flush);
236
237 #define ATH_TXBUF               512
238 #define ATH_TXMAXTRY            13
239 #define ATH_11N_TXMAXTRY        10
240 #define ATH_MGT_TXMAXTRY        4
241 #define WME_BA_BMP_SIZE         64
242 #define WME_MAX_BA              WME_BA_BMP_SIZE
243 #define ATH_TID_MAX_BUFS        (2 * WME_MAX_BA)
244 #define TID_TO_WME_AC(_tid)                             \
245         ((((_tid) == 0) || ((_tid) == 3)) ? WME_AC_BE : \
246          (((_tid) == 1) || ((_tid) == 2)) ? WME_AC_BK : \
247          (((_tid) == 4) || ((_tid) == 5)) ? WME_AC_VI : \
248          WME_AC_VO)
249
250
251 #define WME_AC_BE   0
252 #define WME_AC_BK   1
253 #define WME_AC_VI   2
254 #define WME_AC_VO   3
255 #define WME_NUM_AC  4
256
257 struct ath_txq {
258         u32 axq_qnum;                   /* hardware q number */
259         u32 *axq_link;                  /* link ptr in last TX desc */
260         struct list_head axq_q;         /* transmit queue */
261         spinlock_t axq_lock;
262         unsigned long axq_lockflags;    /* intr state when must cli */
263         u32 axq_depth;                  /* queue depth */
264         u8 axq_aggr_depth;              /* aggregates queued */
265         u32 axq_totalqueued;            /* total ever queued */
266
267         bool stopped;                   /* Is mac80211 queue stopped ? */
268         struct ath_buf *axq_linkbuf;    /* virtual addr of last buffer*/
269
270         /* first desc of the last descriptor that contains CTS */
271         struct ath_desc *axq_lastdsWithCTS;
272
273         /* final desc of the gating desc that determines whether
274            lastdsWithCTS has been DMA'ed or not */
275         struct ath_desc *axq_gatingds;
276
277         struct list_head axq_acq;
278 };
279
280 #define AGGR_CLEANUP         BIT(1)
281 #define AGGR_ADDBA_COMPLETE  BIT(2)
282 #define AGGR_ADDBA_PROGRESS  BIT(3)
283
284 /* per TID aggregate tx state for a destination */
285 struct ath_atx_tid {
286         struct list_head list;          /* round-robin tid entry */
287         struct list_head buf_q;         /* pending buffers */
288         struct ath_node *an;
289         struct ath_atx_ac *ac;
290         struct ath_buf *tx_buf[ATH_TID_MAX_BUFS]; /* active tx frames */
291         u16 seq_start;
292         u16 seq_next;
293         u16 baw_size;
294         int tidno;
295         int baw_head;                   /* first un-acked tx buffer */
296         int baw_tail;                   /* next unused tx buffer slot */
297         int sched;
298         int paused;
299         u8 state;
300         int addba_exchangeattempts;
301 };
302
303 /* per access-category aggregate tx state for a destination */
304 struct ath_atx_ac {
305         int sched;                      /* dest-ac is scheduled */
306         int qnum;                       /* H/W queue number associated
307                                            with this AC */
308         struct list_head list;          /* round-robin txq entry */
309         struct list_head tid_q;         /* queue of TIDs with buffers */
310 };
311
312 /* per dest tx state */
313 struct ath_atx {
314         struct ath_atx_tid tid[WME_NUM_TID];
315         struct ath_atx_ac ac[WME_NUM_AC];
316 };
317
318 /* per-frame tx control block */
319 struct ath_tx_control {
320         struct ath_txq *txq;
321         int if_id;
322 };
323
324 /* per frame tx status block */
325 struct ath_xmit_status {
326         int retries;    /* number of retries to successufully
327                            transmit this frame */
328         int flags;      /* status of transmit */
329 #define ATH_TX_ERROR        0x01
330 #define ATH_TX_XRETRY       0x02
331 #define ATH_TX_BAR          0x04
332 };
333
334 /* All RSSI values are noise floor adjusted */
335 struct ath_tx_stat {
336         int rssi;
337         int rssictl[ATH_MAX_ANTENNA];
338         int rssiextn[ATH_MAX_ANTENNA];
339         int rateieee;
340         int rateKbps;
341         int ratecode;
342         int flags;
343 /* if any of ctl,extn chain rssis are valid */
344 #define ATH_TX_CHAIN_RSSI_VALID 0x01
345 /* if extn chain rssis are valid */
346 #define ATH_TX_RSSI_EXTN_VALID  0x02
347         u32 airtime;    /* time on air per final tx rate */
348 };
349
350 struct ath_txq *ath_txq_setup(struct ath_softc *sc, int qtype, int subtype);
351 void ath_tx_cleanupq(struct ath_softc *sc, struct ath_txq *txq);
352 int ath_tx_setup(struct ath_softc *sc, int haltype);
353 void ath_draintxq(struct ath_softc *sc, bool retry_tx);
354 void ath_tx_draintxq(struct ath_softc *sc,
355                      struct ath_txq *txq, bool retry_tx);
356 void ath_tx_node_init(struct ath_softc *sc, struct ath_node *an);
357 void ath_tx_node_cleanup(struct ath_softc *sc, struct ath_node *an);
358 void ath_tx_node_free(struct ath_softc *sc, struct ath_node *an);
359 void ath_txq_schedule(struct ath_softc *sc, struct ath_txq *txq);
360 int ath_tx_init(struct ath_softc *sc, int nbufs);
361 int ath_tx_cleanup(struct ath_softc *sc);
362 int ath_tx_get_qnum(struct ath_softc *sc, int qtype, int haltype);
363 struct ath_txq *ath_test_get_txq(struct ath_softc *sc, struct sk_buff *skb);
364 int ath_txq_update(struct ath_softc *sc, int qnum,
365                    struct ath9k_tx_queue_info *q);
366 int ath_tx_start(struct ath_softc *sc, struct sk_buff *skb,
367                  struct ath_tx_control *txctl);
368 void ath_tx_tasklet(struct ath_softc *sc);
369 u32 ath_txq_depth(struct ath_softc *sc, int qnum);
370 u32 ath_txq_aggr_depth(struct ath_softc *sc, int qnum);
371 void ath_tx_cabq(struct ath_softc *sc, struct sk_buff *skb);
372
373 /**********************/
374 /* Node / Aggregation */
375 /**********************/
376
377 #define ADDBA_EXCHANGE_ATTEMPTS    10
378 #define ATH_AGGR_DELIM_SZ          4
379 #define ATH_AGGR_MINPLEN           256 /* in bytes, minimum packet length */
380 /* number of delimiters for encryption padding */
381 #define ATH_AGGR_ENCRYPTDELIM      10
382 /* minimum h/w qdepth to be sustained to maximize aggregation */
383 #define ATH_AGGR_MIN_QDEPTH        2
384 #define ATH_AMPDU_SUBFRAME_DEFAULT 32
385 #define IEEE80211_SEQ_SEQ_SHIFT    4
386 #define IEEE80211_SEQ_MAX          4096
387 #define IEEE80211_MIN_AMPDU_BUF    0x8
388 #define IEEE80211_HTCAP_MAXRXAMPDU_FACTOR 13
389
390 /* return whether a bit at index _n in bitmap _bm is set
391  * _sz is the size of the bitmap  */
392 #define ATH_BA_ISSET(_bm, _n)  (((_n) < (WME_BA_BMP_SIZE)) &&           \
393                                 ((_bm)[(_n) >> 5] & (1 << ((_n) & 31))))
394
395 /* return block-ack bitmap index given sequence and starting sequence */
396 #define ATH_BA_INDEX(_st, _seq) (((_seq) - (_st)) & (IEEE80211_SEQ_MAX - 1))
397
398 /* returns delimiter padding required given the packet length */
399 #define ATH_AGGR_GET_NDELIM(_len)                                       \
400         (((((_len) + ATH_AGGR_DELIM_SZ) < ATH_AGGR_MINPLEN) ?           \
401           (ATH_AGGR_MINPLEN - (_len) - ATH_AGGR_DELIM_SZ) : 0) >> 2)
402
403 #define BAW_WITHIN(_start, _bawsz, _seqno) \
404         ((((_seqno) - (_start)) & 4095) < (_bawsz))
405
406 #define ATH_DS_BA_SEQ(_ds)               ((_ds)->ds_us.tx.ts_seqnum)
407 #define ATH_DS_BA_BITMAP(_ds)            (&(_ds)->ds_us.tx.ba_low)
408 #define ATH_DS_TX_BA(_ds)       ((_ds)->ds_us.tx.ts_flags & ATH9K_TX_BA)
409 #define ATH_AN_2_TID(_an, _tidno)        (&(_an)->an_aggr.tx.tid[(_tidno)])
410
411 enum ATH_AGGR_STATUS {
412         ATH_AGGR_DONE,
413         ATH_AGGR_BAW_CLOSED,
414         ATH_AGGR_LIMITED,
415         ATH_AGGR_SHORTPKT,
416         ATH_AGGR_8K_LIMITED,
417 };
418
419 struct aggr_rifs_param {
420         int param_max_frames;
421         int param_max_len;
422         int param_rl;
423         int param_al;
424         struct ath_rc_series *param_rcs;
425 };
426
427 /* Per-node aggregation state */
428 struct ath_node_aggr {
429         struct ath_atx tx;
430 };
431
432 struct ath_node {
433         struct ath_softc *an_sc;
434         struct ath_node_aggr an_aggr;
435         u16 maxampdu;
436         u8 mpdudensity;
437 };
438
439 void ath_tx_resume_tid(struct ath_softc *sc, struct ath_atx_tid *tid);
440 bool ath_tx_aggr_check(struct ath_softc *sc, struct ath_node *an, u8 tidno);
441 void ath_tx_aggr_teardown(struct ath_softc *sc, struct ath_node *an, u8 tidno);
442 int ath_tx_aggr_start(struct ath_softc *sc, struct ieee80211_sta *sta,
443                       u16 tid, u16 *ssn);
444 int ath_tx_aggr_stop(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
445 void ath_tx_aggr_resume(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
446
447 /********/
448 /* VAPs */
449 /********/
450
451 /*
452  * Define the scheme that we select MAC address for multiple
453  * BSS on the same radio. The very first VAP will just use the MAC
454  * address from the EEPROM. For the next 3 VAPs, we set the
455  * U/L bit (bit 1) in MAC address, and use the next two bits as the
456  * index of the VAP.
457  */
458
459 #define ATH_SET_VAP_BSSID_MASK(bssid_mask) \
460         ((bssid_mask)[0] &= ~(((ATH_BCBUF-1)<<2)|0x02))
461
462 struct ath_vap {
463         int av_bslot;
464         enum ath9k_opmode av_opmode;
465         struct ath_buf *av_bcbuf;
466         struct ath_tx_control av_btxctl;
467 };
468
469 /*******************/
470 /* Beacon Handling */
471 /*******************/
472
473 /*
474  * Regardless of the number of beacons we stagger, (i.e. regardless of the
475  * number of BSSIDs) if a given beacon does not go out even after waiting this
476  * number of beacon intervals, the game's up.
477  */
478 #define BSTUCK_THRESH                   (9 * ATH_BCBUF)
479 #define ATH_BCBUF                       4
480 #define ATH_DEFAULT_BINTVAL             100 /* TU */
481 #define ATH_DEFAULT_BMISS_LIMIT         10
482 #define IEEE80211_MS_TO_TU(x)           (((x) * 1000) / 1024)
483
484 struct ath_beacon_config {
485         u16 beacon_interval;
486         u16 listen_interval;
487         u16 dtim_period;
488         u16 bmiss_timeout;
489         u8 dtim_count;
490         u8 tim_offset;
491         union {
492                 u64 last_tsf;
493                 u8 last_tstamp[8];
494         } u; /* last received beacon/probe response timestamp of this BSS. */
495 };
496
497 void ath9k_beacon_tasklet(unsigned long data);
498 void ath_beacon_config(struct ath_softc *sc, int if_id);
499 int ath_beaconq_setup(struct ath_hal *ah);
500 int ath_beacon_alloc(struct ath_softc *sc, int if_id);
501 void ath_beacon_return(struct ath_softc *sc, struct ath_vap *avp);
502 void ath_beacon_sync(struct ath_softc *sc, int if_id);
503
504 /*******/
505 /* ANI */
506 /*******/
507
508 /* ANI values for STA only.
509    FIXME: Add appropriate values for AP later */
510
511 #define ATH_ANI_POLLINTERVAL    100     /* 100 milliseconds between ANI poll */
512 #define ATH_SHORT_CALINTERVAL   1000    /* 1 second between calibrations */
513 #define ATH_LONG_CALINTERVAL    30000   /* 30 seconds between calibrations */
514 #define ATH_RESTART_CALINTERVAL 1200000 /* 20 minutes between calibrations */
515
516 struct ath_ani {
517         bool sc_caldone;
518         int16_t sc_noise_floor;
519         unsigned int sc_longcal_timer;
520         unsigned int sc_shortcal_timer;
521         unsigned int sc_resetcal_timer;
522         unsigned int sc_checkani_timer;
523         struct timer_list timer;
524 };
525
526 /********************/
527 /*   LED Control    */
528 /********************/
529
530 #define ATH_LED_PIN     1
531
532 enum ath_led_type {
533         ATH_LED_RADIO,
534         ATH_LED_ASSOC,
535         ATH_LED_TX,
536         ATH_LED_RX
537 };
538
539 struct ath_led {
540         struct ath_softc *sc;
541         struct led_classdev led_cdev;
542         enum ath_led_type led_type;
543         char name[32];
544         bool registered;
545 };
546
547 /* Rfkill */
548 #define ATH_RFKILL_POLL_INTERVAL        2000 /* msecs */
549
550 struct ath_rfkill {
551         struct rfkill *rfkill;
552         struct delayed_work rfkill_poll;
553         char rfkill_name[32];
554 };
555
556 /********************/
557 /* Main driver core */
558 /********************/
559
560 /*
561  * Default cache line size, in bytes.
562  * Used when PCI device not fully initialized by bootrom/BIOS
563 */
564 #define DEFAULT_CACHELINE       32
565 #define ATH_DEFAULT_NOISE_FLOOR -95
566 #define ATH_REGCLASSIDS_MAX     10
567 #define ATH_CABQ_READY_TIME     80  /* % of beacon interval */
568 #define ATH_MAX_SW_RETRIES      10
569 #define ATH_CHAN_MAX            255
570 #define IEEE80211_WEP_NKID      4       /* number of key ids */
571 #define IEEE80211_RATE_VAL      0x7f
572 /*
573  * The key cache is used for h/w cipher state and also for
574  * tracking station state such as the current tx antenna.
575  * We also setup a mapping table between key cache slot indices
576  * and station state to short-circuit node lookups on rx.
577  * Different parts have different size key caches.  We handle
578  * up to ATH_KEYMAX entries (could dynamically allocate state).
579  */
580 #define ATH_KEYMAX              128        /* max key cache size we handle */
581
582 #define ATH_IF_ID_ANY           0xff
583 #define ATH_TXPOWER_MAX         100     /* .5 dBm units */
584 #define ATH_RSSI_DUMMY_MARKER   0x127
585 #define ATH_RATE_DUMMY_MARKER   0
586
587 enum PROT_MODE {
588         PROT_M_NONE = 0,
589         PROT_M_RTSCTS,
590         PROT_M_CTSONLY
591 };
592
593 #define SC_OP_INVALID           BIT(0)
594 #define SC_OP_BEACONS           BIT(1)
595 #define SC_OP_RXAGGR            BIT(2)
596 #define SC_OP_TXAGGR            BIT(3)
597 #define SC_OP_CHAINMASK_UPDATE  BIT(4)
598 #define SC_OP_FULL_RESET        BIT(5)
599 #define SC_OP_NO_RESET          BIT(6)
600 #define SC_OP_PREAMBLE_SHORT    BIT(7)
601 #define SC_OP_PROTECT_ENABLE    BIT(8)
602 #define SC_OP_RXFLUSH           BIT(9)
603 #define SC_OP_LED_ASSOCIATED    BIT(10)
604 #define SC_OP_RFKILL_REGISTERED BIT(11)
605 #define SC_OP_RFKILL_SW_BLOCKED BIT(12)
606 #define SC_OP_RFKILL_HW_BLOCKED BIT(13)
607
608 struct ath_softc {
609         struct ieee80211_hw *hw;
610         struct pci_dev *pdev;
611         struct tasklet_struct intr_tq;
612         struct tasklet_struct bcon_tasklet;
613         struct ath_config sc_config;
614         struct ath_hal *sc_ah;
615         void __iomem *mem;
616
617         u8 sc_curbssid[ETH_ALEN];
618         u8 sc_myaddr[ETH_ALEN];
619         u8 sc_bssidmask[ETH_ALEN];
620
621 #ifdef CONFIG_ATH9K_DEBUG
622         int sc_debug;
623 #endif
624         u32 sc_intrstatus;
625         u32 sc_flags; /* SC_OP_* */
626         unsigned int rx_filter;
627         u16 sc_curtxpow;
628         u16 sc_curaid;
629         u16 sc_cachelsz;
630         int sc_slotupdate;              /* slot to next advance fsm */
631         int sc_slottime;
632         int sc_bslot[ATH_BCBUF];
633         u8 sc_tx_chainmask;
634         u8 sc_rx_chainmask;
635         enum ath9k_int sc_imask;
636         enum wireless_mode sc_curmode;
637         enum PROT_MODE sc_protmode;
638
639         u8 sc_nbcnvaps;
640         u16 sc_nvaps;
641         struct ieee80211_vif *sc_vaps[ATH_BCBUF];
642
643         u8 sc_mcastantenna;
644         u8 sc_defant;
645         u8 sc_rxotherant;
646
647         struct ath9k_node_stats sc_halstats;
648         enum ath9k_ht_extprotspacing sc_ht_extprotspacing;
649         enum ath9k_ht_macmode tx_chan_width;
650
651 #ifdef CONFIG_SLOW_ANT_DIV
652         struct ath_antdiv sc_antdiv;
653 #endif
654         enum {
655                 OK,             /* no change needed */
656                 UPDATE,         /* update pending */
657                 COMMIT          /* beacon sent, commit change */
658         } sc_updateslot;        /* slot time update fsm */
659
660         /* Crypto */
661         u32 sc_keymax;
662         DECLARE_BITMAP(sc_keymap, ATH_KEYMAX);
663         u8 sc_splitmic;         /* split TKIP MIC keys */
664
665         /* RX */
666         struct list_head sc_rxbuf;
667         struct ath_descdma sc_rxdma;
668         int sc_rxbufsize;
669         u32 *sc_rxlink;
670
671         /* TX */
672         struct list_head sc_txbuf;
673         struct ath_txq sc_txq[ATH9K_NUM_TX_QUEUES];
674         struct ath_descdma sc_txdma;
675         u32 sc_txqsetup;
676         int sc_haltype2q[ATH9K_WME_AC_VO+1];
677         u16 seq_no; /* TX sequence number */
678
679         /* Beacon */
680         struct ath9k_tx_queue_info sc_beacon_qi;
681         struct ath_descdma sc_bdma;
682         struct ath_txq *sc_cabq;
683         struct list_head sc_bbuf;
684         u32 sc_bhalq;
685         u32 sc_bmisscount;
686         u32 ast_be_xmit;
687         u64 bc_tstamp;
688
689         /* Rate */
690         struct ieee80211_rate rates[IEEE80211_NUM_BANDS][ATH_RATE_MAX];
691         struct ath_rate_table *hw_rate_table[ATH9K_MODE_MAX];
692         u8 sc_protrix;
693
694         /* Channel, Band */
695         struct ieee80211_channel channels[IEEE80211_NUM_BANDS][ATH_CHAN_MAX];
696         struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
697
698         /* Locks */
699         spinlock_t sc_rxflushlock;
700         spinlock_t sc_rxbuflock;
701         spinlock_t sc_txbuflock;
702         spinlock_t sc_resetlock;
703
704         /* LEDs */
705         struct ath_led radio_led;
706         struct ath_led assoc_led;
707         struct ath_led tx_led;
708         struct ath_led rx_led;
709
710         /* Rfkill */
711         struct ath_rfkill rf_kill;
712
713         /* ANI */
714         struct ath_ani sc_ani;
715 };
716
717 int ath_reset(struct ath_softc *sc, bool retry_tx);
718 int ath_get_hal_qnum(u16 queue, struct ath_softc *sc);
719 int ath_get_mac80211_qnum(u32 queue, struct ath_softc *sc);
720 int ath_cabq_update(struct ath_softc *);
721
722 #endif /* CORE_H */