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 ATH_RX_TIMEOUT           40      /* 40 milliseconds */
 308 #define WME_NUM_TID              16
 309 #define IEEE80211_BAR_CTL_TID_M  0xF000  /* tid mask */
 310 #define IEEE80211_BAR_CTL_TID_S  12      /* tid shift */
 311
 312 enum ATH_RX_TYPE {
 313         ATH_RX_NON_CONSUMED = 0,
 314         ATH_RX_CONSUMED
 315 };
 316
 317 /* per frame rx status block */
 318 struct ath_recv_status {
 319         u64 tsf;                /* mac tsf */
 320         int8_t rssi;            /* RSSI (noise floor ajusted) */
 321         int8_t rssictl[ATH_MAX_ANTENNA];        /* RSSI (noise floor ajusted) */
 322         int8_t rssiextn[ATH_MAX_ANTENNA];       /* RSSI (noise floor ajusted) */
 323         int8_t abs_rssi;        /* absolute RSSI */
 324         u8 rateieee;            /* data rate received (IEEE rate code) */
 325         u8 ratecode;            /* phy rate code */
 326         int rateKbps;           /* data rate received (Kbps) */
 327         int antenna;            /* rx antenna */
 328         int flags;              /* status of associated skb */
 329 #define ATH_RX_FCS_ERROR        0x01
 330 #define ATH_RX_MIC_ERROR        0x02
 331 #define ATH_RX_DECRYPT_ERROR    0x04
 332 #define ATH_RX_RSSI_VALID       0x08
 333 /* if any of ctl,extn chainrssis are valid */
 334 #define ATH_RX_CHAIN_RSSI_VALID 0x10
 335 /* if extn chain rssis are valid */
 336 #define ATH_RX_RSSI_EXTN_VALID  0x20
 337 /* set if 40Mhz, clear if 20Mhz */
 338 #define ATH_RX_40MHZ            0x40
 339 /* set if short GI, clear if full GI */
 340 #define ATH_RX_SHORT_GI         0x80
 341 };
 342
 343 struct ath_rxbuf {
 344         struct sk_buff *rx_wbuf;
 345         unsigned long rx_time;                  /* system time when received */
 346         struct ath_recv_status rx_status;       /* cached rx status */
 347 };
 348
 349 /* Per-TID aggregate receiver state for a node */
 350 struct ath_arx_tid {
 351         struct ath_node *an;
 352         struct ath_rxbuf *rxbuf;        /* re-ordering buffer */
 353         struct timer_list timer;
 354         spinlock_t tidlock;
 355         int baw_head;                   /* seq_next at head */
 356         int baw_tail;                   /* tail of block-ack window */
 357         int seq_reset;                  /* need to reset start sequence */
 358         int addba_exchangecomplete;
 359         u16 seq_next;                   /* next expected sequence */
 360         u16 baw_size;                   /* block-ack window size */
 361 };
 362
 363 /* Per-node receiver aggregate state */
 364 struct ath_arx {
 365         struct ath_arx_tid tid[WME_NUM_TID];
 366 };
 367
 368 int ath_startrecv(struct ath_softc *sc);
 369 bool ath_stoprecv(struct ath_softc *sc);
 370 void ath_flushrecv(struct ath_softc *sc);
 371 u32 ath_calcrxfilter(struct ath_softc *sc);
 372 void ath_rx_node_init(struct ath_softc *sc, struct ath_node *an);
 373 void ath_rx_node_cleanup(struct ath_softc *sc, struct ath_node *an);
 374 void ath_handle_rx_intr(struct ath_softc *sc);
 375 int ath_rx_init(struct ath_softc *sc, int nbufs);
 376 void ath_rx_cleanup(struct ath_softc *sc);
 377 int ath_rx_tasklet(struct ath_softc *sc, int flush);
 378 int ath_rx_input(struct ath_softc *sc,
 379                  struct ath_node *node,
 380                  struct sk_buff *skb,
 381                  struct ath_recv_status *rx_status,
 382                  enum ATH_RX_TYPE *status);
 383 int _ath_rx_indicate(struct ath_softc *sc,
 384                      struct sk_buff *skb,
 385                      struct ath_recv_status *status,
 386                      u16 keyix);
 387 int ath_rx_subframe(struct ath_node *an, struct sk_buff *skb,
 388                     struct ath_recv_status *status);
 389
 390 /******/
 391 /* TX */
 392 /******/
 393
 394 #define ATH_TXBUF               512
 395 /* max number of transmit attempts (tries) */
 396 #define ATH_TXMAXTRY            13
 397 /* max number of 11n transmit attempts (tries) */
 398 #define ATH_11N_TXMAXTRY        10
 399 /* max number of tries for management and control frames */
 400 #define ATH_MGT_TXMAXTRY        4
 401 #define WME_BA_BMP_SIZE         64
 402 #define WME_MAX_BA              WME_BA_BMP_SIZE
 403 #define ATH_TID_MAX_BUFS        (2 * WME_MAX_BA)
 404 #define TID_TO_WME_AC(_tid)                             \
 405         ((((_tid) == 0) || ((_tid) == 3)) ? WME_AC_BE : \
 406          (((_tid) == 1) || ((_tid) == 2)) ? WME_AC_BK : \
 407          (((_tid) == 4) || ((_tid) == 5)) ? WME_AC_VI : \
 408          WME_AC_VO)
 409
 410
 411 /* Wireless Multimedia Extension Defines */
 412 #define WME_AC_BE               0 /* best effort */
 413 #define WME_AC_BK               1 /* background */
 414 #define WME_AC_VI               2 /* video */
 415 #define WME_AC_VO               3 /* voice */
 416 #define WME_NUM_AC              4
 417
 418 enum ATH_SM_PWRSAV{
 419         ATH_SM_ENABLE,
 420         ATH_SM_PWRSAV_STATIC,
 421         ATH_SM_PWRSAV_DYNAMIC,
 422 };
 423
 424 /*
 425  * Data transmit queue state.  One of these exists for each
 426  * hardware transmit queue.  Packets sent to us from above
 427  * are assigned to queues based on their priority.  Not all
 428  * devices support a complete set of hardware transmit queues.
 429  * For those devices the array sc_ac2q will map multiple
 430  * priorities to fewer hardware queues (typically all to one
 431  * hardware queue).
 432  */
 433 struct ath_txq {
 434         u32 axq_qnum;                   /* hardware q number */
 435         u32 *axq_link;                  /* link ptr in last TX desc */
 436         struct list_head axq_q;         /* transmit queue */
 437         spinlock_t axq_lock;
 438         unsigned long axq_lockflags;    /* intr state when must cli */
 439         u32 axq_depth;                  /* queue depth */
 440         u8 axq_aggr_depth;              /* aggregates queued */
 441         u32 axq_totalqueued;            /* total ever queued */
 442
 443         bool stopped;                   /* Is mac80211 queue stopped ? */
 444         struct ath_buf *axq_linkbuf;    /* virtual addr of last buffer*/
 445
 446         /* first desc of the last descriptor that contains CTS */
 447         struct ath_desc *axq_lastdsWithCTS;
 448
 449         /* final desc of the gating desc that determines whether
 450            lastdsWithCTS has been DMA'ed or not */
 451         struct ath_desc *axq_gatingds;
 452
 453         struct list_head axq_acq;
 454 };
 455
 456 /* per TID aggregate tx state for a destination */
 457 struct ath_atx_tid {
 458         struct list_head list;          /* round-robin tid entry */
 459         struct list_head buf_q;         /* pending buffers */
 460         struct ath_node *an;
 461         struct ath_atx_ac *ac;
 462         struct ath_buf *tx_buf[ATH_TID_MAX_BUFS]; /* active tx frames */
 463         u16 seq_start;
 464         u16 seq_next;
 465         u16 baw_size;
 466         int tidno;
 467         int baw_head;                   /* first un-acked tx buffer */
 468         int baw_tail;                   /* next unused tx buffer slot */
 469         int sched;
 470         int paused;
 471         int cleanup_inprogress;
 472         u32 addba_exchangecomplete:1;
 473         int32_t addba_exchangeinprogress;
 474         int addba_exchangeattempts;
 475 };
 476
 477 /* per access-category aggregate tx state for a destination */
 478 struct ath_atx_ac {
 479         int sched;                      /* dest-ac is scheduled */
 480         int qnum;                       /* H/W queue number associated
 481                                            with this AC */
 482         struct list_head list;          /* round-robin txq entry */
 483         struct list_head tid_q;         /* queue of TIDs with buffers */
 484 };
 485
 486 /* per dest tx state */
 487 struct ath_atx {
 488         struct ath_atx_tid tid[WME_NUM_TID];
 489         struct ath_atx_ac ac[WME_NUM_AC];
 490 };
 491
 492 /* per-frame tx control block */
 493 struct ath_tx_control {
 494         struct ath_txq *txq;
 495         int if_id;
 496 };
 497
 498 /* per frame tx status block */
 499 struct ath_xmit_status {
 500         int retries;    /* number of retries to successufully
 501                            transmit this frame */
 502         int flags;      /* status of transmit */
 503 #define ATH_TX_ERROR        0x01
 504 #define ATH_TX_XRETRY       0x02
 505 #define ATH_TX_BAR          0x04
 506 };
 507
 508 struct ath_tx_stat {
 509         int rssi;               /* RSSI (noise floor ajusted) */
 510         int rssictl[ATH_MAX_ANTENNA];   /* RSSI (noise floor ajusted) */
 511         int rssiextn[ATH_MAX_ANTENNA];  /* RSSI (noise floor ajusted) */
 512         int rateieee;           /* data rate xmitted (IEEE rate code) */
 513         int rateKbps;           /* data rate xmitted (Kbps) */
 514         int ratecode;           /* phy rate code */
 515         int flags;              /* validity flags */
 516 /* if any of ctl,extn chain rssis are valid */
 517 #define ATH_TX_CHAIN_RSSI_VALID 0x01
 518 /* if extn chain rssis are valid */
 519 #define ATH_TX_RSSI_EXTN_VALID  0x02
 520         u32 airtime;    /* time on air per final tx rate */
 521 };
 522
 523 struct ath_txq *ath_txq_setup(struct ath_softc *sc, int qtype, int subtype);
 524 void ath_tx_cleanupq(struct ath_softc *sc, struct ath_txq *txq);
 525 int ath_tx_setup(struct ath_softc *sc, int haltype);
 526 void ath_draintxq(struct ath_softc *sc, bool retry_tx);
 527 void ath_tx_draintxq(struct ath_softc *sc,
 528                      struct ath_txq *txq, bool retry_tx);
 529 void ath_tx_node_init(struct ath_softc *sc, struct ath_node *an);
 530 void ath_tx_node_cleanup(struct ath_softc *sc, struct ath_node *an);
 531 void ath_tx_node_free(struct ath_softc *sc, struct ath_node *an);
 532 void ath_txq_schedule(struct ath_softc *sc, struct ath_txq *txq);
 533 int ath_tx_init(struct ath_softc *sc, int nbufs);
 534 int ath_tx_cleanup(struct ath_softc *sc);
 535 int ath_tx_get_qnum(struct ath_softc *sc, int qtype, int haltype);
 536 struct ath_txq *ath_test_get_txq(struct ath_softc *sc, struct sk_buff *skb);
 537 int ath_txq_update(struct ath_softc *sc, int qnum,
 538                    struct ath9k_tx_queue_info *q);
 539 int ath_tx_start(struct ath_softc *sc, struct sk_buff *skb,
 540                  struct ath_tx_control *txctl);
 541 void ath_tx_tasklet(struct ath_softc *sc);
 542 u32 ath_txq_depth(struct ath_softc *sc, int qnum);
 543 u32 ath_txq_aggr_depth(struct ath_softc *sc, int qnum);
 544 void ath_notify_txq_status(struct ath_softc *sc, u16 queue_depth);
 545 void ath_tx_complete(struct ath_softc *sc, struct sk_buff *skb,
 546                      struct ath_xmit_status *tx_status);
 547 void ath_tx_cabq(struct ath_softc *sc, struct sk_buff *skb);
 548
 549 /**********************/
 550 /* Node / Aggregation */
 551 /**********************/
 552
 553 #define ADDBA_EXCHANGE_ATTEMPTS    10
 554 #define ATH_AGGR_DELIM_SZ          4   /* delimiter size   */
 555 #define ATH_AGGR_MINPLEN           256 /* in bytes, minimum packet length */
 556 /* number of delimiters for encryption padding */
 557 #define ATH_AGGR_ENCRYPTDELIM      10
 558 /* minimum h/w qdepth to be sustained to maximize aggregation */
 559 #define ATH_AGGR_MIN_QDEPTH        2
 560 #define ATH_AMPDU_SUBFRAME_DEFAULT 32
 561 #define IEEE80211_SEQ_SEQ_SHIFT    4
 562 #define IEEE80211_SEQ_MAX          4096
 563 #define IEEE80211_MIN_AMPDU_BUF    0x8
 564 #define IEEE80211_HTCAP_MAXRXAMPDU_FACTOR 13
 565
 566 /* return whether a bit at index _n in bitmap _bm is set
 567  * _sz is the size of the bitmap  */
 568 #define ATH_BA_ISSET(_bm, _n)  (((_n) < (WME_BA_BMP_SIZE)) &&           \
 569                                 ((_bm)[(_n) >> 5] & (1 << ((_n) & 31))))
 570
 571 /* return block-ack bitmap index given sequence and starting sequence */
 572 #define ATH_BA_INDEX(_st, _seq) (((_seq) - (_st)) & (IEEE80211_SEQ_MAX - 1))
 573
 574 /* returns delimiter padding required given the packet length */
 575 #define ATH_AGGR_GET_NDELIM(_len)                                       \
 576         (((((_len) + ATH_AGGR_DELIM_SZ) < ATH_AGGR_MINPLEN) ?           \
 577           (ATH_AGGR_MINPLEN - (_len) - ATH_AGGR_DELIM_SZ) : 0) >> 2)
 578
 579 #define BAW_WITHIN(_start, _bawsz, _seqno) \
 580         ((((_seqno) - (_start)) & 4095) < (_bawsz))
 581
 582 #define ATH_DS_BA_SEQ(_ds)               ((_ds)->ds_us.tx.ts_seqnum)
 583 #define ATH_DS_BA_BITMAP(_ds)            (&(_ds)->ds_us.tx.ba_low)
 584 #define ATH_DS_TX_BA(_ds)       ((_ds)->ds_us.tx.ts_flags & ATH9K_TX_BA)
 585 #define ATH_AN_2_TID(_an, _tidno)        (&(_an)->an_aggr.tx.tid[(_tidno)])
 586
 587 enum ATH_AGGR_STATUS {
 588         ATH_AGGR_DONE,
 589         ATH_AGGR_BAW_CLOSED,
 590         ATH_AGGR_LIMITED,
 591         ATH_AGGR_SHORTPKT,
 592         ATH_AGGR_8K_LIMITED,
 593 };
 594
 595 enum ATH_AGGR_CHECK {
 596         AGGR_NOT_REQUIRED,
 597         AGGR_REQUIRED,
 598         AGGR_CLEANUP_PROGRESS,
 599         AGGR_EXCHANGE_PROGRESS,
 600         AGGR_EXCHANGE_DONE
 601 };
 602
 603 struct aggr_rifs_param {
 604         int param_max_frames;
 605         int param_max_len;
 606         int param_rl;
 607         int param_al;
 608         struct ath_rc_series *param_rcs;
 609 };
 610
 611 /* Per-node aggregation state */
 612 struct ath_node_aggr {
 613         struct ath_atx tx;      /* node transmit state */
 614         struct ath_arx rx;      /* node receive state */
 615 };
 616
 617 /* driver-specific node state */
 618 struct ath_node {
 619         struct ath_softc *an_sc;
 620         struct ath_chainmask_sel an_chainmask_sel;
 621         struct ath_node_aggr an_aggr;
 622         u8 an_smmode; /* SM Power save mode */
 623         u16 maxampdu;
 624         u8 mpdudensity;
 625 };
 626
 627 void ath_tx_resume_tid(struct ath_softc *sc,
 628         struct ath_atx_tid *tid);
 629 enum ATH_AGGR_CHECK ath_tx_aggr_check(struct ath_softc *sc,
 630         struct ath_node *an, u8 tidno);
 631 void ath_tx_aggr_teardown(struct ath_softc *sc,
 632         struct ath_node *an, u8 tidno);
 633 void ath_rx_aggr_teardown(struct ath_softc *sc,
 634         struct ath_node *an, u8 tidno);
 635 int ath_rx_aggr_start(struct ath_softc *sc, struct ieee80211_sta *sta,
 636                       u16 tid, u16 *ssn);
 637 int ath_rx_aggr_stop(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
 638 int ath_tx_aggr_start(struct ath_softc *sc, struct ieee80211_sta *sta,
 639                       u16 tid, u16 *ssn);
 640 int ath_tx_aggr_stop(struct ath_softc *sc, struct ieee80211_sta *sta, u16 tid);
 641 void ath_newassoc(struct ath_softc *sc,
 642         struct ath_node *node, int isnew, int isuapsd);
 643 void ath_node_attach(struct ath_softc *sc, struct ieee80211_sta *sta,
 644                      int if_id);
 645 void ath_node_detach(struct ath_softc *sc, struct ieee80211_sta *sta);
 646
 647 /*******************/
 648 /* Beacon Handling */
 649 /*******************/
 650
 651 /*
 652  * Regardless of the number of beacons we stagger, (i.e. regardless of the
 653  * number of BSSIDs) if a given beacon does not go out even after waiting this
 654  * number of beacon intervals, the game's up.
 655  */
 656 #define BSTUCK_THRESH                   (9 * ATH_BCBUF)
 657 #define ATH_BCBUF                       4   /* number of beacon buffers */
 658 #define ATH_DEFAULT_BINTVAL             100 /* default beacon interval in TU */
 659 #define ATH_DEFAULT_BMISS_LIMIT         10
 660 #define IEEE80211_MS_TO_TU(x)           (((x) * 1000) / 1024)
 661
 662 /* beacon configuration */
 663 struct ath_beacon_config {
 664         u16 beacon_interval;
 665         u16 listen_interval;
 666         u16 dtim_period;
 667         u16 bmiss_timeout;
 668         u8 dtim_count;
 669         u8 tim_offset;
 670         union {
 671                 u64 last_tsf;
 672                 u8 last_tstamp[8];
 673         } u; /* last received beacon/probe response timestamp of this BSS. */
 674 };
 675
 676 void ath9k_beacon_tasklet(unsigned long data);
 677 void ath_beacon_config(struct ath_softc *sc, int if_id);
 678 int ath_beaconq_setup(struct ath_hal *ah);
 679 int ath_beacon_alloc(struct ath_softc *sc, int if_id);
 680 void ath_bstuck_process(struct ath_softc *sc);
 681 void ath_beacon_return(struct ath_softc *sc, struct ath_vap *avp);
 682 void ath_beacon_sync(struct ath_softc *sc, int if_id);
 683 void ath_get_beaconconfig(struct ath_softc *sc,
 684                           int if_id,
 685                           struct ath_beacon_config *conf);
 686 /********/
 687 /* VAPs */
 688 /********/
 689
 690 /*
 691  * Define the scheme that we select MAC address for multiple
 692  * BSS on the same radio. The very first VAP will just use the MAC
 693  * address from the EEPROM. For the next 3 VAPs, we set the
 694  * U/L bit (bit 1) in MAC address, and use the next two bits as the
 695  * index of the VAP.
 696  */
 697
 698 #define ATH_SET_VAP_BSSID_MASK(bssid_mask) \
 699         ((bssid_mask)[0] &= ~(((ATH_BCBUF-1)<<2)|0x02))
 700
 701 /* VAP configuration (from protocol layer) */
 702 struct ath_vap_config {
 703         u32 av_fixed_rateset;
 704         u32 av_fixed_retryset;
 705 };
 706
 707 /* driver-specific vap state */
 708 struct ath_vap {
 709         struct ieee80211_vif *av_if_data;
 710         enum ath9k_opmode av_opmode;    /* VAP operational mode */
 711         struct ath_buf *av_bcbuf;       /* beacon buffer */
 712         struct ath_tx_control av_btxctl;  /* txctl information for beacon */
 713         int av_bslot;                   /* beacon slot index */
 714         struct ath_vap_config av_config;/* vap configuration parameters*/
 715         struct ath_rate_node *rc_node;
 716 };
 717
 718 int ath_vap_attach(struct ath_softc *sc,
 719                    int if_id,
 720                    struct ieee80211_vif *if_data,
 721                    enum ath9k_opmode opmode);
 722 int ath_vap_detach(struct ath_softc *sc, int if_id);
 723 int ath_vap_config(struct ath_softc *sc,
 724                    int if_id, struct ath_vap_config *if_config);
 725
 726 /*********************/
 727 /* Antenna diversity */
 728 /*********************/
 729
 730 #define ATH_ANT_DIV_MAX_CFG      2
 731 #define ATH_ANT_DIV_MIN_IDLE_US  1000000  /* us */
 732 #define ATH_ANT_DIV_MIN_SCAN_US  50000    /* us */
 733
 734 enum ATH_ANT_DIV_STATE{
 735         ATH_ANT_DIV_IDLE,
 736         ATH_ANT_DIV_SCAN,       /* evaluating antenna */
 737 };
 738
 739 struct ath_antdiv {
 740         struct ath_softc *antdiv_sc;
 741         u8 antdiv_start;
 742         enum ATH_ANT_DIV_STATE antdiv_state;
 743         u8 antdiv_num_antcfg;
 744         u8 antdiv_curcfg;
 745         u8 antdiv_bestcfg;
 746         int32_t antdivf_rssitrig;
 747         int32_t antdiv_lastbrssi[ATH_ANT_DIV_MAX_CFG];
 748         u64 antdiv_lastbtsf[ATH_ANT_DIV_MAX_CFG];
 749         u64 antdiv_laststatetsf;
 750         u8 antdiv_bssid[ETH_ALEN];
 751 };
 752
 753 void ath_slow_ant_div_init(struct ath_antdiv *antdiv,
 754         struct ath_softc *sc, int32_t rssitrig);
 755 void ath_slow_ant_div_start(struct ath_antdiv *antdiv,
 756                             u8 num_antcfg,
 757                             const u8 *bssid);
 758 void ath_slow_ant_div_stop(struct ath_antdiv *antdiv);
 759 void ath_slow_ant_div(struct ath_antdiv *antdiv,
 760                       struct ieee80211_hdr *wh,
 761                       struct ath_rx_status *rx_stats);
 762 void ath_setdefantenna(void *sc, u32 antenna);
 763
 764 /*******/
 765 /* ANI */
 766 /*******/
 767
 768 /* ANI values for STA only.
 769    FIXME: Add appropriate values for AP later */
 770
 771 #define ATH_ANI_POLLINTERVAL    100     /* 100 milliseconds between ANI poll */
 772 #define ATH_SHORT_CALINTERVAL   1000    /* 1 second between calibrations */
 773 #define ATH_LONG_CALINTERVAL    30000   /* 30 seconds between calibrations */
 774 #define ATH_RESTART_CALINTERVAL 1200000 /* 20 minutes between calibrations */
 775
 776 struct ath_ani {
 777         bool sc_caldone;
 778         int16_t sc_noise_floor;
 779         unsigned int sc_longcal_timer;
 780         unsigned int sc_shortcal_timer;
 781         unsigned int sc_resetcal_timer;
 782         unsigned int sc_checkani_timer;
 783         struct timer_list timer;
 784 };
 785
 786 /********************/
 787 /*   LED Control    */
 788 /********************/
 789
 790 #define ATH_LED_PIN     1
 791
 792 enum ath_led_type {
 793         ATH_LED_RADIO,
 794         ATH_LED_ASSOC,
 795         ATH_LED_TX,
 796         ATH_LED_RX
 797 };
 798
 799 struct ath_led {
 800         struct ath_softc *sc;
 801         struct led_classdev led_cdev;
 802         enum ath_led_type led_type;
 803         char name[32];
 804         bool registered;
 805 };
 806
 807 /* Rfkill */
 808 #define ATH_RFKILL_POLL_INTERVAL        2000 /* msecs */
 809
 810 struct ath_rfkill {
 811         struct rfkill *rfkill;
 812         struct delayed_work rfkill_poll;
 813         char rfkill_name[32];
 814 };
 815
 816 /********************/
 817 /* Main driver core */
 818 /********************/
 819
 820 /*
 821  * Default cache line size, in bytes.
 822  * Used when PCI device not fully initialized by bootrom/BIOS
 823 */
 824 #define DEFAULT_CACHELINE       32
 825 #define ATH_DEFAULT_NOISE_FLOOR -95
 826 #define ATH_REGCLASSIDS_MAX     10
 827 #define ATH_CABQ_READY_TIME     80  /* % of beacon interval */
 828 #define ATH_MAX_SW_RETRIES      10
 829 #define ATH_CHAN_MAX            255
 830 #define IEEE80211_WEP_NKID      4       /* number of key ids */
 831 #define IEEE80211_RATE_VAL      0x7f
 832 /*
 833  * The key cache is used for h/w cipher state and also for
 834  * tracking station state such as the current tx antenna.
 835  * We also setup a mapping table between key cache slot indices
 836  * and station state to short-circuit node lookups on rx.
 837  * Different parts have different size key caches.  We handle
 838  * up to ATH_KEYMAX entries (could dynamically allocate state).
 839  */
 840 #define ATH_KEYMAX              128        /* max key cache size we handle */
 841
 842 #define ATH_IF_ID_ANY           0xff
 843 #define ATH_TXPOWER_MAX         100     /* .5 dBm units */
 844
 845 #define RSSI_LPF_THRESHOLD         -20
 846 #define ATH_RSSI_EP_MULTIPLIER     (1<<7)  /* pow2 to optimize out * and / */
 847 #define ATH_RATE_DUMMY_MARKER      0
 848 #define ATH_RSSI_LPF_LEN           10
 849 #define ATH_RSSI_DUMMY_MARKER      0x127
 850
 851 #define ATH_EP_MUL(x, mul)         ((x) * (mul))
 852 #define ATH_EP_RND(x, mul)                                              \
 853         ((((x)%(mul)) >= ((mul)/2)) ? ((x) + ((mul) - 1)) / (mul) : (x)/(mul))
 854 #define ATH_RSSI_OUT(x)                                                 \
 855         (((x) != ATH_RSSI_DUMMY_MARKER) ?                               \
 856          (ATH_EP_RND((x), ATH_RSSI_EP_MULTIPLIER)) : ATH_RSSI_DUMMY_MARKER)
 857 #define ATH_RSSI_IN(x)                                  \
 858         (ATH_EP_MUL((x), ATH_RSSI_EP_MULTIPLIER))
 859 #define ATH_LPF_RSSI(x, y, len)                                         \
 860         ((x != ATH_RSSI_DUMMY_MARKER) ? \
 861                 (((x) * ((len) - 1) + (y)) / (len)) : (y))
 862 #define ATH_RSSI_LPF(x, y) do {                                         \
 863                 if ((y) >= RSSI_LPF_THRESHOLD)                          \
 864                         x = ATH_LPF_RSSI((x), \
 865                                 ATH_RSSI_IN((y)), ATH_RSSI_LPF_LEN); \
 866         } while (0)
 867
 868
 869 enum PROT_MODE {
 870         PROT_M_NONE = 0,
 871         PROT_M_RTSCTS,
 872         PROT_M_CTSONLY
 873 };
 874
 875 enum RATE_TYPE {
 876         NORMAL_RATE = 0,
 877         HALF_RATE,
 878         QUARTER_RATE
 879 };
 880
 881 struct ath_ht_info {
 882         enum ath9k_ht_macmode tx_chan_width;
 883         u8 ext_chan_offset;
 884 };
 885
 886 #define SC_OP_INVALID           BIT(0)
 887 #define SC_OP_BEACONS           BIT(1)
 888 #define SC_OP_RXAGGR            BIT(2)
 889 #define SC_OP_TXAGGR            BIT(3)
 890 #define SC_OP_CHAINMASK_UPDATE  BIT(4)
 891 #define SC_OP_FULL_RESET        BIT(5)
 892 #define SC_OP_NO_RESET          BIT(6)
 893 #define SC_OP_PREAMBLE_SHORT    BIT(7)
 894 #define SC_OP_PROTECT_ENABLE    BIT(8)
 895 #define SC_OP_RXFLUSH           BIT(9)
 896 #define SC_OP_LED_ASSOCIATED    BIT(10)
 897 #define SC_OP_RFKILL_REGISTERED BIT(11)
 898 #define SC_OP_RFKILL_SW_BLOCKED BIT(12)
 899 #define SC_OP_RFKILL_HW_BLOCKED BIT(13)
 900
 901 struct ath_softc {
 902         struct ieee80211_hw *hw;
 903         struct pci_dev *pdev;
 904         struct tasklet_struct intr_tq;
 905         struct tasklet_struct bcon_tasklet;
 906         struct ath_config sc_config;
 907         struct ath_hal *sc_ah;
 908         struct ath_rate_softc *sc_rc;
 909         void __iomem *mem;
 910
 911         u8 sc_curbssid[ETH_ALEN];
 912         u8 sc_myaddr[ETH_ALEN];
 913         u8 sc_bssidmask[ETH_ALEN];
 914
 915         int sc_debug;
 916         u32 sc_intrstatus;
 917         u32 sc_flags; /* SC_OP_* */
 918         unsigned int rx_filter;
 919         u16 sc_curtxpow;
 920         u16 sc_curaid;
 921         u16 sc_cachelsz;
 922         int sc_slotupdate;              /* slot to next advance fsm */
 923         int sc_slottime;
 924         int sc_bslot[ATH_BCBUF];
 925         u8 sc_tx_chainmask;
 926         u8 sc_rx_chainmask;
 927         enum ath9k_int sc_imask;
 928         enum wireless_mode sc_curmode;  /* current phy mode */
 929         enum PROT_MODE sc_protmode;
 930
 931         u8 sc_nbcnvaps;                 /* # of vaps sending beacons */
 932         u16 sc_nvaps;                   /* # of active virtual ap's */
 933         struct ath_vap *sc_vaps[ATH_BCBUF];
 934
 935         u8 sc_mcastantenna;
 936         u8 sc_defant;                   /* current default antenna */
 937         u8 sc_rxotherant;               /* rx's on non-default antenna */
 938
 939         struct ath9k_node_stats sc_halstats; /* station-mode rssi stats */
 940         struct ath_ht_info sc_ht_info;
 941         enum ath9k_ht_extprotspacing sc_ht_extprotspacing;
 942
 943 #ifdef CONFIG_SLOW_ANT_DIV
 944         struct ath_antdiv sc_antdiv;
 945 #endif
 946         enum {
 947                 OK,             /* no change needed */
 948                 UPDATE,         /* update pending */
 949                 COMMIT          /* beacon sent, commit change */
 950         } sc_updateslot;        /* slot time update fsm */
 951
 952         /* Crypto */
 953         u32 sc_keymax;          /* size of key cache */
 954         DECLARE_BITMAP(sc_keymap, ATH_KEYMAX);  /* key use bit map */
 955         u8 sc_splitmic;         /* split TKIP MIC keys */
 956
 957         /* RX */
 958         struct list_head sc_rxbuf;
 959         struct ath_descdma sc_rxdma;
 960         int sc_rxbufsize;       /* rx size based on mtu */
 961         u32 *sc_rxlink;         /* link ptr in last RX desc */
 962
 963         /* TX */
 964         struct list_head sc_txbuf;
 965         struct ath_txq sc_txq[ATH9K_NUM_TX_QUEUES];
 966         struct ath_descdma sc_txdma;
 967         u32 sc_txqsetup;
 968         int sc_haltype2q[ATH9K_WME_AC_VO+1]; /* HAL WME AC -> h/w qnum */
 969         u16 seq_no; /* TX sequence number */
 970
 971         /* Beacon */
 972         struct ath9k_tx_queue_info sc_beacon_qi;
 973         struct ath_descdma sc_bdma;
 974         struct ath_txq *sc_cabq;
 975         struct list_head sc_bbuf;
 976         u32 sc_bhalq;
 977         u32 sc_bmisscount;
 978         u32 ast_be_xmit;        /* beacons transmitted */
 979         u64 bc_tstamp;
 980
 981         /* Rate */
 982         struct ieee80211_rate rates[IEEE80211_NUM_BANDS][ATH_RATE_MAX];
 983         const struct ath9k_rate_table *sc_currates;
 984         u8 sc_rixmap[256];      /* IEEE to h/w rate table ix */
 985         u8 sc_protrix;          /* protection rate index */
 986         struct {
 987                 u32 rateKbps;   /* transfer rate in kbs */
 988                 u8 ieeerate;    /* IEEE rate */
 989         } sc_hwmap[256];        /* h/w rate ix mappings */
 990
 991         /* Channel, Band */
 992         struct ieee80211_channel channels[IEEE80211_NUM_BANDS][ATH_CHAN_MAX];
 993         struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
 994
 995         /* Locks */
 996         spinlock_t sc_rxflushlock;
 997         spinlock_t sc_rxbuflock;
 998         spinlock_t sc_txbuflock;
 999         spinlock_t sc_resetlock;
1000
1001         /* LEDs */
1002         struct ath_led radio_led;
1003         struct ath_led assoc_led;
1004         struct ath_led tx_led;
1005         struct ath_led rx_led;
1006
1007         /* Rfkill */
1008         struct ath_rfkill rf_kill;
1009
1010         /* ANI */
1011         struct ath_ani sc_ani;
1012 };
1013
1014 int ath_init(u16 devid, struct ath_softc *sc);
1015 void ath_deinit(struct ath_softc *sc);
1016 int ath_open(struct ath_softc *sc, struct ath9k_channel *initial_chan);
1017 int ath_suspend(struct ath_softc *sc);
1018 irqreturn_t ath_isr(int irq, void *dev);
1019 int ath_reset(struct ath_softc *sc, bool retry_tx);
1020 int ath_set_channel(struct ath_softc *sc, struct ath9k_channel *hchan);
1021
1022 /*********************/
1023 /* Utility Functions */
1024 /*********************/
1025
1026 void ath_key_reset(struct ath_softc *sc, u16 keyix, int freeslot);
1027 int ath_keyset(struct ath_softc *sc,
1028                u16 keyix,
1029                struct ath9k_keyval *hk,
1030                const u8 mac[ETH_ALEN]);
1031 int ath_get_hal_qnum(u16 queue, struct ath_softc *sc);
1032 int ath_get_mac80211_qnum(u32 queue, struct ath_softc *sc);
1033 void ath_setslottime(struct ath_softc *sc);
1034 void ath_update_txpow(struct ath_softc *sc);
1035 int ath_cabq_update(struct ath_softc *);
1036 void ath_get_currentCountry(struct ath_softc *sc,
1037         struct ath9k_country_entry *ctry);
1038 u64 ath_extend_tsf(struct ath_softc *sc, u32 rstamp);
1039
1040 #endif /* CORE_H */