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/version.h>
  21 #include <linux/autoconf.h>
  22 #include <linux/kernel.h>
  23 #include <linux/module.h>
  24 #include <linux/spinlock.h>
  25 #include <linux/errno.h>
  26 #include <linux/skbuff.h>
  27 #include <linux/netdevice.h>
  28 #include <linux/etherdevice.h>
  29 #include <linux/ip.h>
  30 #include <linux/tcp.h>
  31 #include <linux/in.h>
  32 #include <linux/delay.h>
  33 #include <linux/wait.h>
  34 #include <linux/pci.h>
  35 #include <linux/interrupt.h>
  36 #include <linux/sched.h>
  37 #include <linux/list.h>
  38 #include <asm/byteorder.h>
  39 #include <linux/scatterlist.h>
  40 #include <asm/page.h>
  41 #include <net/mac80211.h>
  42 #include <linux/leds.h>
  43 #include <linux/rfkill.h>
  44
  45 #include "ath9k.h"
  46 #include "rc.h"
  47
  48 struct ath_node;
  49
  50 /******************/
  51 /* Utility macros */
  52 /******************/
  53
  54 /* Macro to expand scalars to 64-bit objects */
  55
  56 #define ito64(x) (sizeof(x) == 8) ?                     \
  57         (((unsigned long long int)(x)) & (0xff)) :      \
  58         (sizeof(x) == 16) ?                             \
  59         (((unsigned long long int)(x)) & 0xffff) :      \
  60         ((sizeof(x) == 32) ?                            \
  61          (((unsigned long long int)(x)) & 0xffffffff) : \
  62          (unsigned long long int)(x))
  63
  64 /* increment with wrap-around */
  65 #define INCR(_l, _sz)   do {                    \
  66                 (_l)++;                         \
  67                 (_l) &= ((_sz) - 1);            \
  68         } while (0)
  69
  70 /* decrement with wrap-around */
  71 #define DECR(_l,  _sz)  do {                    \
  72                 (_l)--;                         \
  73                 (_l) &= ((_sz) - 1);            \
  74         } while (0)
  75
  76 #define A_MAX(a, b) ((a) > (b) ? (a) : (b))
  77
  78 #define ASSERT(exp) do {                        \
  79                 if (unlikely(!(exp))) {         \
  80                         BUG();                  \
  81                 }                               \
  82         } while (0)
  83
  84 #define TSF_TO_TU(_h,_l) \
  85         ((((u32)(_h)) << 22) | (((u32)(_l)) >> 10))
  86
  87 #define ATH_TXQ_SETUP(sc, i)        ((sc)->sc_txqsetup & (1<<i))
  88
  89 static inline unsigned long get_timestamp(void)
  90 {
  91         return ((jiffies / HZ) * 1000) + (jiffies % HZ) * (1000 / HZ);
  92 }
  93
  94 static const u8 ath_bcast_mac[ETH_ALEN] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
  95
  96 /*************/
  97 /* Debugging */
  98 /*************/
  99
 100 enum ATH_DEBUG {
 101         ATH_DBG_RESET           = 0x00000001,
 102         ATH_DBG_PHY_IO          = 0x00000002,
 103         ATH_DBG_REG_IO          = 0x00000004,
 104         ATH_DBG_QUEUE           = 0x00000008,
 105         ATH_DBG_EEPROM          = 0x00000010,
 106         ATH_DBG_NF_CAL          = 0x00000020,
 107         ATH_DBG_CALIBRATE       = 0x00000040,
 108         ATH_DBG_CHANNEL         = 0x00000080,
 109         ATH_DBG_INTERRUPT       = 0x00000100,
 110         ATH_DBG_REGULATORY      = 0x00000200,
 111         ATH_DBG_ANI             = 0x00000400,
 112         ATH_DBG_POWER_MGMT      = 0x00000800,
 113         ATH_DBG_XMIT            = 0x00001000,
 114         ATH_DBG_BEACON          = 0x00002000,
 115         ATH_DBG_RATE            = 0x00004000,
 116         ATH_DBG_CONFIG          = 0x00008000,
 117         ATH_DBG_KEYCACHE        = 0x00010000,
 118         ATH_DBG_AGGR            = 0x00020000,
 119         ATH_DBG_FATAL           = 0x00040000,
 120         ATH_DBG_ANY             = 0xffffffff
 121 };
 122
 123 #define DBG_DEFAULT (ATH_DBG_FATAL)
 124
 125 #define DPRINTF(sc, _m, _fmt, ...) do {                 \
 126                 if (sc->sc_debug & (_m))                \
 127                         printk(_fmt , ##__VA_ARGS__);   \
 128         } while (0)
 129
 130 /***************************/
 131 /* Load-time Configuration */
 132 /***************************/
 133
 134 /* Per-instance load-time (note: NOT run-time) configurations
 135  * for Atheros Device */
 136 struct ath_config {
 137         u32 ath_aggr_prot;
 138         u16 txpowlimit;
 139         u16 txpowlimit_override;
 140         u8 cabqReadytime; /* Cabq Readytime % */
 141         u8 swBeaconProcess; /* Process received beacons in SW (vs HW) */
 142 };
 143
 144 /***********************/
 145 /* Chainmask Selection */
 146 /***********************/
 147
 148 #define ATH_CHAINMASK_SEL_TIMEOUT          6000
 149 /* Default - Number of last RSSI values that is used for
 150  * chainmask selection */
 151 #define ATH_CHAINMASK_SEL_RSSI_CNT         10
 152 /* Means use 3x3 chainmask instead of configured chainmask */
 153 #define ATH_CHAINMASK_SEL_3X3              7
 154 /* Default - Rssi threshold below which we have to switch to 3x3 */
 155 #define ATH_CHAINMASK_SEL_UP_RSSI_THRES    20
 156 /* Default - Rssi threshold above which we have to switch to
 157  * user configured values */
 158 #define ATH_CHAINMASK_SEL_DOWN_RSSI_THRES  35
 159 /* Struct to store the chainmask select related info */
 160 struct ath_chainmask_sel {
 161         struct timer_list timer;
 162         int cur_tx_mask;        /* user configured or 3x3 */
 163         int cur_rx_mask;        /* user configured or 3x3 */
 164         int tx_avgrssi;
 165         u8 switch_allowed:1,    /* timer will set this */
 166            cm_sel_enabled : 1;
 167 };
 168
 169 int ath_chainmask_sel_logic(struct ath_softc *sc, struct ath_node *an);
 170 void ath_update_chainmask(struct ath_softc *sc, int is_ht);
 171
 172 /*************************/
 173 /* Descriptor Management */
 174 /*************************/
 175
 176 #define ATH_TXBUF_RESET(_bf) do {                               \
 177                 (_bf)->bf_status = 0;                           \
 178                 (_bf)->bf_lastbf = NULL;                        \
 179                 (_bf)->bf_lastfrm = NULL;                       \
 180                 (_bf)->bf_next = NULL;                          \
 181                 memset(&((_bf)->bf_state), 0,                   \
 182                             sizeof(struct ath_buf_state));      \
 183         } while (0)
 184
 185 enum buffer_type {
 186         BUF_DATA                = BIT(0),
 187         BUF_AGGR                = BIT(1),
 188         BUF_AMPDU               = BIT(2),
 189         BUF_HT                  = BIT(3),
 190         BUF_RETRY               = BIT(4),
 191         BUF_XRETRY              = BIT(5),
 192         BUF_SHORT_PREAMBLE      = BIT(6),
 193         BUF_BAR                 = BIT(7),
 194         BUF_PSPOLL              = BIT(8),
 195         BUF_AGGR_BURST          = BIT(9),
 196         BUF_CALC_AIRTIME        = BIT(10),
 197 };
 198
 199 struct ath_buf_state {
 200         int bfs_nframes;                        /* # frames in aggregate */
 201         u16 bfs_al;                             /* length of aggregate */
 202         u16 bfs_frmlen;                         /* length of frame */
 203         int bfs_seqno;                          /* sequence number */
 204         int bfs_tidno;                          /* tid of this frame */
 205         int bfs_retries;                        /* current retries */
 206         struct ath_rc_series bfs_rcs[4];        /* rate series */
 207         u32 bf_type;                            /* BUF_* (enum buffer_type) */
 208         /* key type use to encrypt this frame */
 209         u32 bfs_keyix;
 210         enum ath9k_key_type bfs_keytype;
 211 };
 212
 213 #define bf_nframes              bf_state.bfs_nframes
 214 #define bf_al                   bf_state.bfs_al
 215 #define bf_frmlen               bf_state.bfs_frmlen
 216 #define bf_retries              bf_state.bfs_retries
 217 #define bf_seqno                bf_state.bfs_seqno
 218 #define bf_tidno                bf_state.bfs_tidno
 219 #define bf_rcs                  bf_state.bfs_rcs
 220 #define bf_keyix                bf_state.bfs_keyix
 221 #define bf_keytype              bf_state.bfs_keytype
 222 #define bf_isdata(bf)           (bf->bf_state.bf_type & BUF_DATA)
 223 #define bf_isaggr(bf)           (bf->bf_state.bf_type & BUF_AGGR)
 224 #define bf_isampdu(bf)          (bf->bf_state.bf_type & BUF_AMPDU)
 225 #define bf_isht(bf)             (bf->bf_state.bf_type & BUF_HT)
 226 #define bf_isretried(bf)        (bf->bf_state.bf_type & BUF_RETRY)
 227 #define bf_isxretried(bf)       (bf->bf_state.bf_type & BUF_XRETRY)
 228 #define bf_isshpreamble(bf)     (bf->bf_state.bf_type & BUF_SHORT_PREAMBLE)
 229 #define bf_isbar(bf)            (bf->bf_state.bf_type & BUF_BAR)
 230 #define bf_ispspoll(bf)         (bf->bf_state.bf_type & BUF_PSPOLL)
 231 #define bf_isaggrburst(bf)      (bf->bf_state.bf_type & BUF_AGGR_BURST)
 232
 233 /*
 234  * Abstraction of a contiguous buffer to transmit/receive.  There is only
 235  * a single hw descriptor encapsulated here.
 236  */
 237 struct ath_buf {
 238         struct list_head list;
 239         struct list_head *last;
 240         struct ath_buf *bf_lastbf;      /* last buf of this unit (a frame or
 241                                            an aggregate) */
 242         struct ath_buf *bf_lastfrm;     /* last buf of this frame */
 243         struct ath_buf *bf_next;        /* next subframe in the aggregate */
 244         struct ath_buf *bf_rifslast;    /* last buf for RIFS burst */
 245         void *bf_mpdu;                  /* enclosing frame structure */
 246         struct ath_desc *bf_desc;       /* virtual addr of desc */
 247         dma_addr_t bf_daddr;            /* physical addr of desc */
 248         dma_addr_t bf_buf_addr;         /* physical addr of data buffer */
 249         u32 bf_status;
 250         u16 bf_flags;                   /* tx descriptor flags */
 251         struct ath_buf_state bf_state;  /* buffer state */
 252         dma_addr_t bf_dmacontext;
 253 };
 254
 255 /*
 256  * reset the rx buffer.
 257  * any new fields added to the athbuf and require
 258  * reset need to be added to this macro.
 259  * currently bf_status is the only one requires that
 260  * requires reset.
 261  */
 262 #define ATH_RXBUF_RESET(_bf)    ((_bf)->bf_status = 0)
 263
 264 /* hw processing complete, desc processed by hal */
 265 #define ATH_BUFSTATUS_DONE      0x00000001
 266 /* hw processing complete, desc hold for hw */
 267 #define ATH_BUFSTATUS_STALE     0x00000002
 268 /* Rx-only: OS is done with this packet and it's ok to queued it to hw */
 269 #define ATH_BUFSTATUS_FREE      0x00000004
 270
 271 /* DMA state for tx/rx descriptors */
 272
 273 struct ath_descdma {
 274         const char *dd_name;
 275         struct ath_desc *dd_desc;       /* descriptors  */
 276         dma_addr_t dd_desc_paddr;       /* physical addr of dd_desc  */
 277         u32 dd_desc_len;                /* size of dd_desc  */
 278         struct ath_buf *dd_bufptr;      /* associated buffers */
 279         dma_addr_t dd_dmacontext;
 280 };
 281
 282 /* Abstraction of a received RX MPDU/MMPDU, or a RX fragment */
 283
 284 struct ath_rx_context {
 285         struct ath_buf *ctx_rxbuf;      /* associated ath_buf for rx */
 286 };
 287 #define ATH_RX_CONTEXT(skb) ((struct ath_rx_context *)skb->cb)
 288
 289 int ath_descdma_setup(struct ath_softc *sc,
 290                       struct ath_descdma *dd,
 291                       struct list_head *head,
 292                       const char *name,
 293                       int nbuf,
 294                       int ndesc);
 295 int ath_desc_alloc(struct ath_softc *sc);
 296 void ath_desc_free(struct ath_softc *sc);
 297 void ath_descdma_cleanup(struct ath_softc *sc,
 298                          struct ath_descdma *dd,
 299                          struct list_head *head);
 300
 301 /******/
 302 /* RX */
 303 /******/
 304
 305 #define ATH_MAX_ANTENNA          3
 306 #define ATH_RXBUF                512
 307 #define WME_NUM_TID              16
 308
 309 /* per frame rx status block */
 310 struct ath_recv_status {
 311         u64 tsf;                /* mac tsf */
 312         int8_t rssi;            /* RSSI (noise floor ajusted) */
 313         int8_t rssictl[ATH_MAX_ANTENNA];        /* RSSI (noise floor ajusted) */
 314         int8_t rssiextn[ATH_MAX_ANTENNA];       /* RSSI (noise floor ajusted) */
 315         int8_t abs_rssi;        /* absolute RSSI */
 316         u8 rateieee;            /* data rate received (IEEE rate code) */
 317         u8 ratecode;            /* phy rate code */
 318         int rateKbps;           /* data rate received (Kbps) */
 319         int antenna;            /* rx antenna */
 320         int flags;              /* status of associated skb */
 321 #define ATH_RX_FCS_ERROR        0x01
 322 #define ATH_RX_MIC_ERROR        0x02
 323 #define ATH_RX_DECRYPT_ERROR    0x04
 324 #define ATH_RX_RSSI_VALID       0x08
 325 /* if any of ctl,extn chainrssis are valid */
 326 #define ATH_RX_CHAIN_RSSI_VALID 0x10
 327 /* if extn chain rssis are valid */
 328 #define ATH_RX_RSSI_EXTN_VALID  0x20
 329 /* set if 40Mhz, clear if 20Mhz */
 330 #define ATH_RX_40MHZ            0x40
 331 /* set if short GI, clear if full GI */
 332 #define ATH_RX_SHORT_GI         0x80
 333 };
 334
 335 struct ath_rxbuf {
 336         struct sk_buff *rx_wbuf;
 337         unsigned long rx_time;                  /* system time when received */
 338         struct ath_recv_status rx_status;       /* cached rx status */
 339 };
 340
 341 int ath_startrecv(struct ath_softc *sc);
 342 bool ath_stoprecv(struct ath_softc *sc);
 343 void ath_flushrecv(struct ath_softc *sc);
 344 u32 ath_calcrxfilter(struct ath_softc *sc);
 345 void ath_handle_rx_intr(struct ath_softc *sc);
 346 int ath_rx_init(struct ath_softc *sc, int nbufs);
 347 void ath_rx_cleanup(struct ath_softc *sc);
 348 int ath_rx_tasklet(struct ath_softc *sc, int flush);
 349 int _ath_rx_indicate(struct ath_softc *sc,
 350                      struct sk_buff *skb,
 351                      struct ath_recv_status *status,
 352                      u16 keyix);
 353 /******/
 354 /* TX */
 355 /******/
 356
 357 #define ATH_TXBUF               512
 358 /* max number of transmit attempts (tries) */
 359 #define ATH_TXMAXTRY            13
 360 /* max number of 11n transmit attempts (tries) */
 361 #define ATH_11N_TXMAXTRY        10
 362 /* max number of tries for management and control frames */
 363 #define ATH_MGT_TXMAXTRY        4
 364 #define WME_BA_BMP_SIZE         64
 365 #define WME_MAX_BA              WME_BA_BMP_SIZE
 366 #define ATH_TID_MAX_BUFS        (2 * WME_MAX_BA)
 367 #define TID_TO_WME_AC(_tid)                             \
 368         ((((_tid) == 0) || ((_tid) == 3)) ? WME_AC_BE : \
 369          (((_tid) == 1) || ((_tid) == 2)) ? WME_AC_BK : \
 370          (((_tid) == 4) || ((_tid) == 5)) ? WME_AC_VI : \
 371          WME_AC_VO)
 372
 373
 374 /* Wireless Multimedia Extension Defines */
 375 #define WME_AC_BE               0 /* best effort */
 376 #define WME_AC_BK               1 /* background */
 377 #define WME_AC_VI               2 /* video */
 378 #define WME_AC_VO               3 /* voice */
 379 #define WME_NUM_AC              4
 380
 381 /*
 382  * Data transmit queue state.  One of these exists for each
 383  * hardware transmit queue.  Packets sent to us from above
 384  * are assigned to queues based on their priority.  Not all
 385  * devices support a complete set of hardware transmit queues.
 386  * For those devices the array sc_ac2q will map multiple
 387  * priorities to fewer hardware queues (typically all to one
 388  * hardware queue).
 389  */
 390 struct ath_txq {
 391         u32 axq_qnum;                   /* hardware q number */
 392         u32 *axq_link;                  /* link ptr in last TX desc */
 393         struct list_head axq_q;         /* transmit queue */
 394         spinlock_t axq_lock;
 395         unsigned long axq_lockflags;    /* intr state when must cli */
 396         u32 axq_depth;                  /* queue depth */
 397         u8 axq_aggr_depth;              /* aggregates queued */
 398         u32 axq_totalqueued;            /* total ever queued */
 399
 400         bool stopped;                   /* Is mac80211 queue stopped ? */
 401         struct ath_buf *axq_linkbuf;    /* virtual addr of last buffer*/
 402
 403         /* first desc of the last descriptor that contains CTS */
 404         struct ath_desc *axq_lastdsWithCTS;
 405
 406         /* final desc of the gating desc that determines whether
 407            lastdsWithCTS has been DMA'ed or not */
 408         struct ath_desc *axq_gatingds;
 409
 410         struct list_head axq_acq;
 411 };
 412
 413 #define AGGR_CLEANUP         BIT(1)
 414 #define AGGR_ADDBA_COMPLETE  BIT(2)
 415 #define AGGR_ADDBA_PROGRESS  BIT(3)
 416
 417 /* per TID aggregate tx state for a destination */
 418 struct ath_atx_tid {
 419         struct list_head list;          /* round-robin tid entry */
 420         struct list_head buf_q;         /* pending buffers */
 421         struct ath_node *an;
 422         struct ath_atx_ac *ac;
 423         struct ath_buf *tx_buf[ATH_TID_MAX_BUFS]; /* active tx frames */
 424         u16 seq_start;
 425         u16 seq_next;
 426         u16 baw_size;
 427         int tidno;
 428         int baw_head;                   /* first un-acked tx buffer */
 429         int baw_tail;                   /* next unused tx buffer slot */
 430         int sched;
 431         int paused;
 432         u8 state;
 433         int addba_exchangeattempts;
 434 };
 435
 436 /* per access-category aggregate tx state for a destination */
 437 struct ath_atx_ac {
 438         int sched;                      /* dest-ac is scheduled */
 439         int qnum;                       /* H/W queue number associated
 440                                            with this AC */
 441         struct list_head list;          /* round-robin txq entry */
 442         struct list_head tid_q;         /* queue of TIDs with buffers */
 443 };
 444
 445 /* per dest tx state */
 446 struct ath_atx {
 447         struct ath_atx_tid tid[WME_NUM_TID];
 448         struct ath_atx_ac ac[WME_NUM_AC];
 449 };
 450
 451 /* per-frame tx control block */
 452 struct ath_tx_control {
 453         struct ath_txq *txq;
 454         int if_id;
 455 };
 456
 457 /* per frame tx status block */
 458 struct ath_xmit_status {
 459         int retries;    /* number of retries to successufully
 460                            transmit this frame */
 461         int flags;      /* status of transmit */
 462 #define ATH_TX_ERROR        0x01
 463 #define ATH_TX_XRETRY       0x02
 464 #define ATH_TX_BAR          0x04
 465 };
 466
 467 struct ath_tx_stat {
 468         int rssi;               /* RSSI (noise floor ajusted) */
 469         int rssictl[ATH_MAX_ANTENNA];   /* RSSI (noise floor ajusted) */
 470         int rssiextn[ATH_MAX_ANTENNA];  /* RSSI (noise floor ajusted) */
 471         int rateieee;           /* data rate xmitted (IEEE rate code) */
 472         int rateKbps;           /* data rate xmitted (Kbps) */
 473         int ratecode;           /* phy rate code */
 474         int flags;              /* validity flags */
 475 /* if any of ctl,extn chain rssis are valid */
 476 #define ATH_TX_CHAIN_RSSI_VALID 0x01
 477 /* if extn chain rssis are valid */
 478 #define ATH_TX_RSSI_EXTN_VALID  0x02
 479         u32 airtime;    /* time on air per final tx rate */
 480 };
 481
 482 struct ath_txq *ath_txq_setup(struct ath_softc *sc, int qtype, int subtype);
 483 void ath_tx_cleanupq(struct ath_softc *sc, struct ath_txq *txq);
 484 int ath_tx_setup(struct ath_softc *sc, int haltype);
 485 void ath_draintxq(struct ath_softc *sc, bool retry_tx);
 486 void ath_tx_draintxq(struct ath_softc *sc,
 487                      struct ath_txq *txq, bool retry_tx);
 488 void ath_tx_node_init(struct ath_softc *sc, struct ath_node *an);
 489 void ath_tx_node_cleanup(struct ath_softc *sc, struct ath_node *an);
 490 void ath_tx_node_free(struct ath_softc *sc, struct ath_node *an);
 491 void ath_txq_schedule(struct ath_softc *sc, struct ath_txq *txq);
 492 int ath_tx_init(struct ath_softc *sc, int nbufs);
 493 int ath_tx_cleanup(struct ath_softc *sc);
 494 int ath_tx_get_qnum(struct ath_softc *sc, int qtype, int haltype);
 495 struct ath_txq *ath_test_get_txq(struct ath_softc *sc, struct sk_buff *skb);
 496 int ath_txq_update(struct ath_softc *sc, int qnum,
 497                    struct ath9k_tx_queue_info *q);
 498 int ath_tx_start(struct ath_softc *sc, struct sk_buff *skb,
 499                  struct ath_tx_control *txctl);
 500 void ath_tx_tasklet(struct ath_softc *sc);
 501 u32 ath_txq_depth(struct ath_softc *sc, int qnum);
 502 u32 ath_txq_aggr_depth(struct ath_softc *sc, int qnum);
 503 void ath_notify_txq_status(struct ath_softc *sc, u16 queue_depth);
 504 void ath_tx_complete(struct ath_softc *sc, struct sk_buff *skb,
 505                      struct ath_xmit_status *tx_status);
 506 void ath_tx_cabq(struct ath_softc *sc, struct sk_buff *skb);
 507
 508 /**********************/
 509 /* Node / Aggregation */
 510 /**********************/
 511
 512 #define ADDBA_EXCHANGE_ATTEMPTS    10
 513 #define ATH_AGGR_DELIM_SZ          4   /* delimiter size   */
 514 #define ATH_AGGR_MINPLEN           256 /* in bytes, minimum packet length */
 515 /* number of delimiters for encryption padding */
 516 #define ATH_AGGR_ENCRYPTDELIM      10
 517 /* minimum h/w qdepth to be sustained to maximize aggregation */
 518 #define ATH_AGGR_MIN_QDEPTH        2
 519 #define ATH_AMPDU_SUBFRAME_DEFAULT 32
 520 #define IEEE80211_SEQ_SEQ_SHIFT    4
 521 #define IEEE80211_SEQ_MAX          4096
 522 #define IEEE80211_MIN_AMPDU_BUF    0x8
 523 #define IEEE80211_HTCAP_MAXRXAMPDU_FACTOR 13
 524
 525 /* return whether a bit at index _n in bitmap _bm is set
 526  * _sz is the size of the bitmap  */
 527 #define ATH_BA_ISSET(_bm, _n)  (((_n) < (WME_BA_BMP_SIZE)) &&           \
 528                                 ((_bm)[(_n) >> 5] & (1 << ((_n) & 31))))
 529
 530 /* return block-ack bitmap index given sequence and starting sequence */
 531 #define ATH_BA_INDEX(_st, _seq) (((_seq) - (_st)) & (IEEE80211_SEQ_MAX - 1))
 532
 533 /* returns delimiter padding required given the packet length */
 534 #define ATH_AGGR_GET_NDELIM(_len)                                       \
 535         (((((_len) + ATH_AGGR_DELIM_SZ) < ATH_AGGR_MINPLEN) ?           \
 536           (ATH_AGGR_MINPLEN - (_len) - ATH_AGGR_DELIM_SZ) : 0) >> 2)
 537
 538 #define BAW_WITHIN(_start, _bawsz, _seqno) \
 539         ((((_seqno) - (_start)) & 4095) < (_bawsz))
 540
 541 #define ATH_DS_BA_SEQ(_ds)               ((_ds)->ds_us.tx.ts_seqnum)
 542 #define ATH_DS_BA_BITMAP(_ds)            (&(_ds)->ds_us.tx.ba_low)
 543 #define ATH_DS_TX_BA(_ds)       ((_ds)->ds_us.tx.ts_flags & ATH9K_TX_BA)
 544 #define ATH_AN_2_TID(_an, _tidno)        (&(_an)->an_aggr.tx.tid[(_tidno)])
 545
 546 enum ATH_AGGR_STATUS {
 547         ATH_AGGR_DONE,
 548         ATH_AGGR_BAW_CLOSED,
 549         ATH_AGGR_LIMITED,
 550         ATH_AGGR_SHORTPKT,
 551         ATH_AGGR_8K_LIMITED,
 552 };
 553
 554 struct aggr_rifs_param {
 555         int param_max_frames;
 556         int param_max_len;
 557         int param_rl;
 558         int param_al;
 559         struct ath_rc_series *param_rcs;
 560 };
 561
 562 /* Per-node aggregation state */
 563 struct ath_node_aggr {
 564         struct ath_atx tx;      /* node transmit state */
 565 };
 566
 567 /* driver-specific node state */
 568 struct ath_node {
 569         struct ath_softc *an_sc;
 570         struct ath_chainmask_sel an_chainmask_sel;
 571         struct ath_node_aggr an_aggr;
 572         u16 maxampdu;
 573         u8 mpdudensity;
 574 };
 575
 576 void ath_tx_resume_tid(struct ath_softc *sc,
 577         struct ath_atx_tid *tid);
 578 bool ath_tx_aggr_check(struct ath_softc *sc, struct ath_node *an, u8 tidno);
 579 void ath_tx_aggr_teardown(struct ath_softc *sc,
 580         struct ath_node *an, u8 tidno);
 581 int ath_tx_aggr_start(struct ath_softc *sc, struct ieee80211_sta *sta,
 582                       u16 tid, u16 *ssn);
 583 int ath_tx_aggr_stop(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
 584 void ath_newassoc(struct ath_softc *sc,
 585         struct ath_node *node, int isnew, int isuapsd);
 586 void ath_node_attach(struct ath_softc *sc, struct ieee80211_sta *sta);
 587 void ath_node_detach(struct ath_softc *sc, struct ieee80211_sta *sta);
 588
 589 /*******************/
 590 /* Beacon Handling */
 591 /*******************/
 592
 593 /*
 594  * Regardless of the number of beacons we stagger, (i.e. regardless of the
 595  * number of BSSIDs) if a given beacon does not go out even after waiting this
 596  * number of beacon intervals, the game's up.
 597  */
 598 #define BSTUCK_THRESH                   (9 * ATH_BCBUF)
 599 #define ATH_BCBUF                       4   /* number of beacon buffers */
 600 #define ATH_DEFAULT_BINTVAL             100 /* default beacon interval in TU */
 601 #define ATH_DEFAULT_BMISS_LIMIT         10
 602 #define IEEE80211_MS_TO_TU(x)           (((x) * 1000) / 1024)
 603
 604 /* beacon configuration */
 605 struct ath_beacon_config {
 606         u16 beacon_interval;
 607         u16 listen_interval;
 608         u16 dtim_period;
 609         u16 bmiss_timeout;
 610         u8 dtim_count;
 611         u8 tim_offset;
 612         union {
 613                 u64 last_tsf;
 614                 u8 last_tstamp[8];
 615         } u; /* last received beacon/probe response timestamp of this BSS. */
 616 };
 617
 618 void ath9k_beacon_tasklet(unsigned long data);
 619 void ath_beacon_config(struct ath_softc *sc, int if_id);
 620 int ath_beaconq_setup(struct ath_hal *ah);
 621 int ath_beacon_alloc(struct ath_softc *sc, int if_id);
 622 void ath_bstuck_process(struct ath_softc *sc);
 623 void ath_beacon_return(struct ath_softc *sc, struct ath_vap *avp);
 624 void ath_beacon_sync(struct ath_softc *sc, int if_id);
 625 void ath_get_beaconconfig(struct ath_softc *sc,
 626                           int if_id,
 627                           struct ath_beacon_config *conf);
 628 /********/
 629 /* VAPs */
 630 /********/
 631
 632 /*
 633  * Define the scheme that we select MAC address for multiple
 634  * BSS on the same radio. The very first VAP will just use the MAC
 635  * address from the EEPROM. For the next 3 VAPs, we set the
 636  * U/L bit (bit 1) in MAC address, and use the next two bits as the
 637  * index of the VAP.
 638  */
 639
 640 #define ATH_SET_VAP_BSSID_MASK(bssid_mask) \
 641         ((bssid_mask)[0] &= ~(((ATH_BCBUF-1)<<2)|0x02))
 642
 643 /* VAP configuration (from protocol layer) */
 644 struct ath_vap_config {
 645         u32 av_fixed_rateset;
 646         u32 av_fixed_retryset;
 647 };
 648
 649 /* driver-specific vap state */
 650 struct ath_vap {
 651         int av_bslot;                   /* beacon slot index */
 652         enum ath9k_opmode av_opmode;    /* VAP operational mode */
 653         struct ath_buf *av_bcbuf;       /* beacon buffer */
 654         struct ath_tx_control av_btxctl;  /* txctl information for beacon */
 655         struct ath_vap_config av_config;/* vap configuration parameters*/
 656         struct ath_rate_node *rc_node;
 657 };
 658
 659 /*********************/
 660 /* Antenna diversity */
 661 /*********************/
 662
 663 #define ATH_ANT_DIV_MAX_CFG      2
 664 #define ATH_ANT_DIV_MIN_IDLE_US  1000000  /* us */
 665 #define ATH_ANT_DIV_MIN_SCAN_US  50000    /* us */
 666
 667 enum ATH_ANT_DIV_STATE{
 668         ATH_ANT_DIV_IDLE,
 669         ATH_ANT_DIV_SCAN,       /* evaluating antenna */
 670 };
 671
 672 struct ath_antdiv {
 673         struct ath_softc *antdiv_sc;
 674         u8 antdiv_start;
 675         enum ATH_ANT_DIV_STATE antdiv_state;
 676         u8 antdiv_num_antcfg;
 677         u8 antdiv_curcfg;
 678         u8 antdiv_bestcfg;
 679         int32_t antdivf_rssitrig;
 680         int32_t antdiv_lastbrssi[ATH_ANT_DIV_MAX_CFG];
 681         u64 antdiv_lastbtsf[ATH_ANT_DIV_MAX_CFG];
 682         u64 antdiv_laststatetsf;
 683         u8 antdiv_bssid[ETH_ALEN];
 684 };
 685
 686 void ath_slow_ant_div_init(struct ath_antdiv *antdiv,
 687         struct ath_softc *sc, int32_t rssitrig);
 688 void ath_slow_ant_div_start(struct ath_antdiv *antdiv,
 689                             u8 num_antcfg,
 690                             const u8 *bssid);
 691 void ath_slow_ant_div_stop(struct ath_antdiv *antdiv);
 692 void ath_slow_ant_div(struct ath_antdiv *antdiv,
 693                       struct ieee80211_hdr *wh,
 694                       struct ath_rx_status *rx_stats);
 695 void ath_setdefantenna(void *sc, u32 antenna);
 696
 697 /*******/
 698 /* ANI */
 699 /*******/
 700
 701 /* ANI values for STA only.
 702    FIXME: Add appropriate values for AP later */
 703
 704 #define ATH_ANI_POLLINTERVAL    100     /* 100 milliseconds between ANI poll */
 705 #define ATH_SHORT_CALINTERVAL   1000    /* 1 second between calibrations */
 706 #define ATH_LONG_CALINTERVAL    30000   /* 30 seconds between calibrations */
 707 #define ATH_RESTART_CALINTERVAL 1200000 /* 20 minutes between calibrations */
 708
 709 struct ath_ani {
 710         bool sc_caldone;
 711         int16_t sc_noise_floor;
 712         unsigned int sc_longcal_timer;
 713         unsigned int sc_shortcal_timer;
 714         unsigned int sc_resetcal_timer;
 715         unsigned int sc_checkani_timer;
 716         struct timer_list timer;
 717 };
 718
 719 /********************/
 720 /*   LED Control    */
 721 /********************/
 722
 723 #define ATH_LED_PIN     1
 724
 725 enum ath_led_type {
 726         ATH_LED_RADIO,
 727         ATH_LED_ASSOC,
 728         ATH_LED_TX,
 729         ATH_LED_RX
 730 };
 731
 732 struct ath_led {
 733         struct ath_softc *sc;
 734         struct led_classdev led_cdev;
 735         enum ath_led_type led_type;
 736         char name[32];
 737         bool registered;
 738 };
 739
 740 /* Rfkill */
 741 #define ATH_RFKILL_POLL_INTERVAL        2000 /* msecs */
 742
 743 struct ath_rfkill {
 744         struct rfkill *rfkill;
 745         struct delayed_work rfkill_poll;
 746         char rfkill_name[32];
 747 };
 748
 749 /********************/
 750 /* Main driver core */
 751 /********************/
 752
 753 /*
 754  * Default cache line size, in bytes.
 755  * Used when PCI device not fully initialized by bootrom/BIOS
 756 */
 757 #define DEFAULT_CACHELINE       32
 758 #define ATH_DEFAULT_NOISE_FLOOR -95
 759 #define ATH_REGCLASSIDS_MAX     10
 760 #define ATH_CABQ_READY_TIME     80  /* % of beacon interval */
 761 #define ATH_MAX_SW_RETRIES      10
 762 #define ATH_CHAN_MAX            255
 763 #define IEEE80211_WEP_NKID      4       /* number of key ids */
 764 #define IEEE80211_RATE_VAL      0x7f
 765 /*
 766  * The key cache is used for h/w cipher state and also for
 767  * tracking station state such as the current tx antenna.
 768  * We also setup a mapping table between key cache slot indices
 769  * and station state to short-circuit node lookups on rx.
 770  * Different parts have different size key caches.  We handle
 771  * up to ATH_KEYMAX entries (could dynamically allocate state).
 772  */
 773 #define ATH_KEYMAX              128        /* max key cache size we handle */
 774
 775 #define ATH_IF_ID_ANY           0xff
 776 #define ATH_TXPOWER_MAX         100     /* .5 dBm units */
 777
 778 #define RSSI_LPF_THRESHOLD         -20
 779 #define ATH_RSSI_EP_MULTIPLIER     (1<<7)  /* pow2 to optimize out * and / */
 780 #define ATH_RATE_DUMMY_MARKER      0
 781 #define ATH_RSSI_LPF_LEN           10
 782 #define ATH_RSSI_DUMMY_MARKER      0x127
 783
 784 #define ATH_EP_MUL(x, mul)         ((x) * (mul))
 785 #define ATH_EP_RND(x, mul)                                              \
 786         ((((x)%(mul)) >= ((mul)/2)) ? ((x) + ((mul) - 1)) / (mul) : (x)/(mul))
 787 #define ATH_RSSI_OUT(x)                                                 \
 788         (((x) != ATH_RSSI_DUMMY_MARKER) ?                               \
 789          (ATH_EP_RND((x), ATH_RSSI_EP_MULTIPLIER)) : ATH_RSSI_DUMMY_MARKER)
 790 #define ATH_RSSI_IN(x)                                  \
 791         (ATH_EP_MUL((x), ATH_RSSI_EP_MULTIPLIER))
 792 #define ATH_LPF_RSSI(x, y, len)                                         \
 793         ((x != ATH_RSSI_DUMMY_MARKER) ? \
 794                 (((x) * ((len) - 1) + (y)) / (len)) : (y))
 795 #define ATH_RSSI_LPF(x, y) do {                                         \
 796                 if ((y) >= RSSI_LPF_THRESHOLD)                          \
 797                         x = ATH_LPF_RSSI((x), \
 798                                 ATH_RSSI_IN((y)), ATH_RSSI_LPF_LEN); \
 799         } while (0)
 800
 801
 802 enum PROT_MODE {
 803         PROT_M_NONE = 0,
 804         PROT_M_RTSCTS,
 805         PROT_M_CTSONLY
 806 };
 807
 808 enum RATE_TYPE {
 809         NORMAL_RATE = 0,
 810         HALF_RATE,
 811         QUARTER_RATE
 812 };
 813
 814 struct ath_ht_info {
 815         enum ath9k_ht_macmode tx_chan_width;
 816         u8 ext_chan_offset;
 817 };
 818
 819 #define SC_OP_INVALID           BIT(0)
 820 #define SC_OP_BEACONS           BIT(1)
 821 #define SC_OP_RXAGGR            BIT(2)
 822 #define SC_OP_TXAGGR            BIT(3)
 823 #define SC_OP_CHAINMASK_UPDATE  BIT(4)
 824 #define SC_OP_FULL_RESET        BIT(5)
 825 #define SC_OP_NO_RESET          BIT(6)
 826 #define SC_OP_PREAMBLE_SHORT    BIT(7)
 827 #define SC_OP_PROTECT_ENABLE    BIT(8)
 828 #define SC_OP_RXFLUSH           BIT(9)
 829 #define SC_OP_LED_ASSOCIATED    BIT(10)
 830 #define SC_OP_RFKILL_REGISTERED BIT(11)
 831 #define SC_OP_RFKILL_SW_BLOCKED BIT(12)
 832 #define SC_OP_RFKILL_HW_BLOCKED BIT(13)
 833
 834 struct ath_softc {
 835         struct ieee80211_hw *hw;
 836         struct pci_dev *pdev;
 837         struct tasklet_struct intr_tq;
 838         struct tasklet_struct bcon_tasklet;
 839         struct ath_config sc_config;
 840         struct ath_hal *sc_ah;
 841         struct ath_rate_softc *sc_rc;
 842         void __iomem *mem;
 843
 844         u8 sc_curbssid[ETH_ALEN];
 845         u8 sc_myaddr[ETH_ALEN];
 846         u8 sc_bssidmask[ETH_ALEN];
 847
 848         int sc_debug;
 849         u32 sc_intrstatus;
 850         u32 sc_flags; /* SC_OP_* */
 851         unsigned int rx_filter;
 852         u16 sc_curtxpow;
 853         u16 sc_curaid;
 854         u16 sc_cachelsz;
 855         int sc_slotupdate;              /* slot to next advance fsm */
 856         int sc_slottime;
 857         int sc_bslot[ATH_BCBUF];
 858         u8 sc_tx_chainmask;
 859         u8 sc_rx_chainmask;
 860         enum ath9k_int sc_imask;
 861         enum wireless_mode sc_curmode;  /* current phy mode */
 862         enum PROT_MODE sc_protmode;
 863
 864         u8 sc_nbcnvaps;                 /* # of vaps sending beacons */
 865         u16 sc_nvaps;                   /* # of active virtual ap's */
 866         struct ieee80211_vif *sc_vaps[ATH_BCBUF];
 867
 868         u8 sc_mcastantenna;
 869         u8 sc_defant;                   /* current default antenna */
 870         u8 sc_rxotherant;               /* rx's on non-default antenna */
 871
 872         struct ath9k_node_stats sc_halstats; /* station-mode rssi stats */
 873         struct ath_ht_info sc_ht_info;
 874         enum ath9k_ht_extprotspacing sc_ht_extprotspacing;
 875
 876 #ifdef CONFIG_SLOW_ANT_DIV
 877         struct ath_antdiv sc_antdiv;
 878 #endif
 879         enum {
 880                 OK,             /* no change needed */
 881                 UPDATE,         /* update pending */
 882                 COMMIT          /* beacon sent, commit change */
 883         } sc_updateslot;        /* slot time update fsm */
 884
 885         /* Crypto */
 886         u32 sc_keymax;          /* size of key cache */
 887         DECLARE_BITMAP(sc_keymap, ATH_KEYMAX);  /* key use bit map */
 888         u8 sc_splitmic;         /* split TKIP MIC keys */
 889
 890         /* RX */
 891         struct list_head sc_rxbuf;
 892         struct ath_descdma sc_rxdma;
 893         int sc_rxbufsize;       /* rx size based on mtu */
 894         u32 *sc_rxlink;         /* link ptr in last RX desc */
 895
 896         /* TX */
 897         struct list_head sc_txbuf;
 898         struct ath_txq sc_txq[ATH9K_NUM_TX_QUEUES];
 899         struct ath_descdma sc_txdma;
 900         u32 sc_txqsetup;
 901         int sc_haltype2q[ATH9K_WME_AC_VO+1]; /* HAL WME AC -> h/w qnum */
 902         u16 seq_no; /* TX sequence number */
 903
 904         /* Beacon */
 905         struct ath9k_tx_queue_info sc_beacon_qi;
 906         struct ath_descdma sc_bdma;
 907         struct ath_txq *sc_cabq;
 908         struct list_head sc_bbuf;
 909         u32 sc_bhalq;
 910         u32 sc_bmisscount;
 911         u32 ast_be_xmit;        /* beacons transmitted */
 912         u64 bc_tstamp;
 913
 914         /* Rate */
 915         struct ieee80211_rate rates[IEEE80211_NUM_BANDS][ATH_RATE_MAX];
 916         const struct ath9k_rate_table *sc_currates;
 917         u8 sc_rixmap[256];      /* IEEE to h/w rate table ix */
 918         u8 sc_protrix;          /* protection rate index */
 919         struct {
 920                 u32 rateKbps;   /* transfer rate in kbs */
 921                 u8 ieeerate;    /* IEEE rate */
 922         } sc_hwmap[256];        /* h/w rate ix mappings */
 923
 924         /* Channel, Band */
 925         struct ieee80211_channel channels[IEEE80211_NUM_BANDS][ATH_CHAN_MAX];
 926         struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
 927
 928         /* Locks */
 929         spinlock_t sc_rxflushlock;
 930         spinlock_t sc_rxbuflock;
 931         spinlock_t sc_txbuflock;
 932         spinlock_t sc_resetlock;
 933
 934         /* LEDs */
 935         struct ath_led radio_led;
 936         struct ath_led assoc_led;
 937         struct ath_led tx_led;
 938         struct ath_led rx_led;
 939
 940         /* Rfkill */
 941         struct ath_rfkill rf_kill;
 942
 943         /* ANI */
 944         struct ath_ani sc_ani;
 945 };
 946
 947 int ath_init(u16 devid, struct ath_softc *sc);
 948 int ath_open(struct ath_softc *sc, struct ath9k_channel *initial_chan);
 949 void ath_stop(struct ath_softc *sc);
 950 irqreturn_t ath_isr(int irq, void *dev);
 951 int ath_reset(struct ath_softc *sc, bool retry_tx);
 952 int ath_set_channel(struct ath_softc *sc, struct ath9k_channel *hchan);
 953
 954 /*********************/
 955 /* Utility Functions */
 956 /*********************/
 957
 958 void ath_key_reset(struct ath_softc *sc, u16 keyix, int freeslot);
 959 int ath_keyset(struct ath_softc *sc,
 960                u16 keyix,
 961                struct ath9k_keyval *hk,
 962                const u8 mac[ETH_ALEN]);
 963 int ath_get_hal_qnum(u16 queue, struct ath_softc *sc);
 964 int ath_get_mac80211_qnum(u32 queue, struct ath_softc *sc);
 965 void ath_setslottime(struct ath_softc *sc);
 966 void ath_update_txpow(struct ath_softc *sc);
 967 int ath_cabq_update(struct ath_softc *);
 968 u64 ath_extend_tsf(struct ath_softc *sc, u32 rstamp);
 969
 970 #endif /* CORE_H */