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