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