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