drivers/net/wireless/iwlwifi/iwl-dev.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2003 - 2011 Intel Corporation. All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of version 2 of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
  17  *
  18  * The full GNU General Public License is included in this distribution in the
  19  * file called LICENSE.
  20  *
  21  * Contact Information:
  22  *  Intel Linux Wireless <ilw@linux.intel.com>
  23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  24  *
  25  *****************************************************************************/
  26 /*
  27  * Please use this file (iwl-dev.h) for driver implementation definitions.
  28  * Please use iwl-commands.h for uCode API definitions.
  29  */
  30
  31 #ifndef __iwl_dev_h__
  32 #define __iwl_dev_h__
  33
  34 #include <linux/interrupt.h>
  35 #include <linux/pci.h> /* for struct pci_device_id */
  36 #include <linux/kernel.h>
  37 #include <linux/wait.h>
  38 #include <linux/leds.h>
  39 #include <net/ieee80211_radiotap.h>
  40
  41 #include "iwl-eeprom.h"
  42 #include "iwl-csr.h"
  43 #include "iwl-prph.h"
  44 #include "iwl-fh.h"
  45 #include "iwl-debug.h"
  46 #include "iwl-agn-hw.h"
  47 #include "iwl-led.h"
  48 #include "iwl-power.h"
  49 #include "iwl-agn-rs.h"
  50 #include "iwl-agn-tt.h"
  51 #include "iwl-bus.h"
  52 #include "iwl-trans.h"
  53
  54 #define DRV_NAME        "iwlagn"
  55
  56 struct iwl_tx_queue;
  57
  58 /* CT-KILL constants */
  59 #define CT_KILL_THRESHOLD_LEGACY   110 /* in Celsius */
  60 #define CT_KILL_THRESHOLD          114 /* in Celsius */
  61 #define CT_KILL_EXIT_THRESHOLD     95  /* in Celsius */
  62
  63 /* Default noise level to report when noise measurement is not available.
  64  *   This may be because we're:
  65  *   1)  Not associated (4965, no beacon statistics being sent to driver)
  66  *   2)  Scanning (noise measurement does not apply to associated channel)
  67  *   3)  Receiving CCK (3945 delivers noise info only for OFDM frames)
  68  * Use default noise value of -127 ... this is below the range of measurable
  69  *   Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
  70  *   Also, -127 works better than 0 when averaging frames with/without
  71  *   noise info (e.g. averaging might be done in app); measured dBm values are
  72  *   always negative ... using a negative value as the default keeps all
  73  *   averages within an s8's (used in some apps) range of negative values. */
  74 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
  75
  76 /*
  77  * RTS threshold here is total size [2347] minus 4 FCS bytes
  78  * Per spec:
  79  *   a value of 0 means RTS on all data/management packets
  80  *   a value > max MSDU size means no RTS
  81  * else RTS for data/management frames where MPDU is larger
  82  *   than RTS value.
  83  */
  84 #define DEFAULT_RTS_THRESHOLD     2347U
  85 #define MIN_RTS_THRESHOLD         0U
  86 #define MAX_RTS_THRESHOLD         2347U
  87 #define MAX_MSDU_SIZE             2304U
  88 #define MAX_MPDU_SIZE             2346U
  89 #define DEFAULT_BEACON_INTERVAL   200U
  90 #define DEFAULT_SHORT_RETRY_LIMIT 7U
  91 #define DEFAULT_LONG_RETRY_LIMIT  4U
  92
  93 struct iwl_rx_mem_buffer {
  94         dma_addr_t page_dma;
  95         struct page *page;
  96         struct list_head list;
  97 };
  98
  99 #define rxb_addr(r) page_address(r->page)
 100
 101 /* defined below */
 102 struct iwl_device_cmd;
 103
 104 struct iwl_cmd_meta {
 105         /* only for SYNC commands, iff the reply skb is wanted */
 106         struct iwl_host_cmd *source;
 107         /*
 108          * only for ASYNC commands
 109          * (which is somewhat stupid -- look at iwl-sta.c for instance
 110          * which duplicates a bunch of code because the callback isn't
 111          * invoked for SYNC commands, if it were and its result passed
 112          * through it would be simpler...)
 113          */
 114         void (*callback)(struct iwl_priv *priv,
 115                          struct iwl_device_cmd *cmd,
 116                          struct iwl_rx_packet *pkt);
 117
 118         u32 flags;
 119
 120         DEFINE_DMA_UNMAP_ADDR(mapping);
 121         DEFINE_DMA_UNMAP_LEN(len);
 122 };
 123
 124 /*
 125  * Generic queue structure
 126  *
 127  * Contains common data for Rx and Tx queues.
 128  *
 129  * Note the difference between n_bd and n_window: the hardware
 130  * always assumes 256 descriptors, so n_bd is always 256 (unless
 131  * there might be HW changes in the future). For the normal TX
 132  * queues, n_window, which is the size of the software queue data
 133  * is also 256; however, for the command queue, n_window is only
 134  * 32 since we don't need so many commands pending. Since the HW
 135  * still uses 256 BDs for DMA though, n_bd stays 256. As a result,
 136  * the software buffers (in the variables @meta, @txb in struct
 137  * iwl_tx_queue) only have 32 entries, while the HW buffers (@tfds
 138  * in the same struct) have 256.
 139  * This means that we end up with the following:
 140  *  HW entries: | 0 | ... | N * 32 | ... | N * 32 + 31 | ... | 255 |
 141  *  SW entries:           | 0      | ... | 31          |
 142  * where N is a number between 0 and 7. This means that the SW
 143  * data is a window overlayed over the HW queue.
 144  */
 145 struct iwl_queue {
 146         int n_bd;              /* number of BDs in this queue */
 147         int write_ptr;       /* 1-st empty entry (index) host_w*/
 148         int read_ptr;         /* last used entry (index) host_r*/
 149         /* use for monitoring and recovering the stuck queue */
 150         dma_addr_t dma_addr;   /* physical addr for BD's */
 151         int n_window;          /* safe queue window */
 152         u32 id;
 153         int low_mark;          /* low watermark, resume queue if free
 154                                 * space more than this */
 155         int high_mark;         /* high watermark, stop queue if free
 156                                 * space less than this */
 157 };
 158
 159 /* One for each TFD */
 160 struct iwl_tx_info {
 161         struct sk_buff *skb;
 162         struct iwl_rxon_context *ctx;
 163 };
 164
 165 /**
 166  * struct iwl_tx_queue - Tx Queue for DMA
 167  * @q: generic Rx/Tx queue descriptor
 168  * @bd: base of circular buffer of TFDs
 169  * @cmd: array of command/TX buffer pointers
 170  * @meta: array of meta data for each command/tx buffer
 171  * @dma_addr_cmd: physical address of cmd/tx buffer array
 172  * @txb: array of per-TFD driver data
 173  * @time_stamp: time (in jiffies) of last read_ptr change
 174  * @need_update: indicates need to update read/write index
 175  * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
 176  *
 177  * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
 178  * descriptors) and required locking structures.
 179  */
 180 #define TFD_TX_CMD_SLOTS 256
 181 #define TFD_CMD_SLOTS 32
 182
 183 struct iwl_tx_queue {
 184         struct iwl_queue q;
 185         struct iwl_tfd *tfds;
 186         struct iwl_device_cmd **cmd;
 187         struct iwl_cmd_meta *meta;
 188         struct iwl_tx_info *txb;
 189         unsigned long time_stamp;
 190         u8 need_update;
 191         u8 sched_retry;
 192         u8 active;
 193         u8 swq_id;
 194 };
 195
 196 #define IWL_NUM_SCAN_RATES         (2)
 197
 198 /*
 199  * One for each channel, holds all channel setup data
 200  * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
 201  *     with one another!
 202  */
 203 struct iwl_channel_info {
 204         struct iwl_eeprom_channel eeprom;       /* EEPROM regulatory limit */
 205         struct iwl_eeprom_channel ht40_eeprom;  /* EEPROM regulatory limit for
 206                                                  * HT40 channel */
 207
 208         u8 channel;       /* channel number */
 209         u8 flags;         /* flags copied from EEPROM */
 210         s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
 211         s8 curr_txpow;    /* (dBm) regulatory/spectrum/user (not h/w) limit */
 212         s8 min_power;     /* always 0 */
 213         s8 scan_power;    /* (dBm) regul. eeprom, direct scans, any rate */
 214
 215         u8 group_index;   /* 0-4, maps channel to group1/2/3/4/5 */
 216         u8 band_index;    /* 0-4, maps channel to band1/2/3/4/5 */
 217         enum ieee80211_band band;
 218
 219         /* HT40 channel info */
 220         s8 ht40_max_power_avg;  /* (dBm) regul. eeprom, normal Tx, any rate */
 221         u8 ht40_flags;          /* flags copied from EEPROM */
 222         u8 ht40_extension_channel; /* HT_IE_EXT_CHANNEL_* */
 223 };
 224
 225 #define IWL_TX_FIFO_BK          0       /* shared */
 226 #define IWL_TX_FIFO_BE          1
 227 #define IWL_TX_FIFO_VI          2       /* shared */
 228 #define IWL_TX_FIFO_VO          3
 229 #define IWL_TX_FIFO_BK_IPAN     IWL_TX_FIFO_BK
 230 #define IWL_TX_FIFO_BE_IPAN     4
 231 #define IWL_TX_FIFO_VI_IPAN     IWL_TX_FIFO_VI
 232 #define IWL_TX_FIFO_VO_IPAN     5
 233 #define IWL_TX_FIFO_UNUSED      -1
 234
 235 /* Minimum number of queues. MAX_NUM is defined in hw specific files.
 236  * Set the minimum to accommodate the 4 standard TX queues, 1 command
 237  * queue, 2 (unused) HCCA queues, and 4 HT queues (one for each AC) */
 238 #define IWL_MIN_NUM_QUEUES      10
 239
 240 /*
 241  * Command queue depends on iPAN support.
 242  */
 243 #define IWL_DEFAULT_CMD_QUEUE_NUM       4
 244 #define IWL_IPAN_CMD_QUEUE_NUM          9
 245
 246 /*
 247  * This queue number is required for proper operation
 248  * because the ucode will stop/start the scheduler as
 249  * required.
 250  */
 251 #define IWL_IPAN_MCAST_QUEUE            8
 252
 253 #define IEEE80211_DATA_LEN              2304
 254 #define IEEE80211_4ADDR_LEN             30
 255 #define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
 256 #define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
 257
 258
 259 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
 260 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
 261 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
 262
 263 enum {
 264         CMD_SYNC = 0,
 265         CMD_ASYNC = BIT(0),
 266         CMD_WANT_SKB = BIT(1),
 267         CMD_ON_DEMAND = BIT(2),
 268 };
 269
 270 #define DEF_CMD_PAYLOAD_SIZE 320
 271
 272 /**
 273  * struct iwl_device_cmd
 274  *
 275  * For allocation of the command and tx queues, this establishes the overall
 276  * size of the largest command we send to uCode, except for commands that
 277  * aren't fully copied and use other TFD space.
 278  */
 279 struct iwl_device_cmd {
 280         struct iwl_cmd_header hdr;      /* uCode API */
 281         union {
 282                 u32 flags;
 283                 u8 val8;
 284                 u16 val16;
 285                 u32 val32;
 286                 struct iwl_tx_cmd tx;
 287                 struct iwl6000_channel_switch_cmd chswitch;
 288                 u8 payload[DEF_CMD_PAYLOAD_SIZE];
 289         } __packed cmd;
 290 } __packed;
 291
 292 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_device_cmd))
 293
 294 #define IWL_MAX_CMD_TFDS        2
 295
 296 enum iwl_hcmd_dataflag {
 297         IWL_HCMD_DFL_NOCOPY     = BIT(0),
 298 };
 299
 300 /**
 301  * struct iwl_host_cmd - Host command to the uCode
 302  * @data: array of chunks that composes the data of the host command
 303  * @reply_page: pointer to the page that holds the response to the host command
 304  * @callback:
 305  * @flags: can be CMD_* note CMD_WANT_SKB is incompatible withe CMD_ASYNC
 306  * @len: array of the lenths of the chunks in data
 307  * @dataflags:
 308  * @id: id of the host command
 309  */
 310 struct iwl_host_cmd {
 311         const void *data[IWL_MAX_CMD_TFDS];
 312         unsigned long reply_page;
 313         void (*callback)(struct iwl_priv *priv,
 314                          struct iwl_device_cmd *cmd,
 315                          struct iwl_rx_packet *pkt);
 316         u32 flags;
 317         u16 len[IWL_MAX_CMD_TFDS];
 318         u8 dataflags[IWL_MAX_CMD_TFDS];
 319         u8 id;
 320 };
 321
 322 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
 323 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
 324 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
 325
 326 /**
 327  * struct iwl_rx_queue - Rx queue
 328  * @bd: driver's pointer to buffer of receive buffer descriptors (rbd)
 329  * @bd_dma: bus address of buffer of receive buffer descriptors (rbd)
 330  * @read: Shared index to newest available Rx buffer
 331  * @write: Shared index to oldest written Rx packet
 332  * @free_count: Number of pre-allocated buffers in rx_free
 333  * @rx_free: list of free SKBs for use
 334  * @rx_used: List of Rx buffers with no SKB
 335  * @need_update: flag to indicate we need to update read/write index
 336  * @rb_stts: driver's pointer to receive buffer status
 337  * @rb_stts_dma: bus address of receive buffer status
 338  *
 339  * NOTE:  rx_free and rx_used are used as a FIFO for iwl_rx_mem_buffers
 340  */
 341 struct iwl_rx_queue {
 342         __le32 *bd;
 343         dma_addr_t bd_dma;
 344         struct iwl_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
 345         struct iwl_rx_mem_buffer *queue[RX_QUEUE_SIZE];
 346         u32 read;
 347         u32 write;
 348         u32 free_count;
 349         u32 write_actual;
 350         struct list_head rx_free;
 351         struct list_head rx_used;
 352         int need_update;
 353         struct iwl_rb_status *rb_stts;
 354         dma_addr_t rb_stts_dma;
 355         spinlock_t lock;
 356 };
 357
 358 #define IWL_SUPPORTED_RATES_IE_LEN         8
 359
 360 #define MAX_TID_COUNT        9
 361
 362 #define IWL_INVALID_RATE     0xFF
 363 #define IWL_INVALID_VALUE    -1
 364
 365 /**
 366  * struct iwl_ht_agg -- aggregation status while waiting for block-ack
 367  * @txq_id: Tx queue used for Tx attempt
 368  * @frame_count: # frames attempted by Tx command
 369  * @wait_for_ba: Expect block-ack before next Tx reply
 370  * @start_idx: Index of 1st Transmit Frame Descriptor (TFD) in Tx window
 371  * @bitmap0: Low order bitmap, one bit for each frame pending ACK in Tx window
 372  * @bitmap1: High order, one bit for each frame pending ACK in Tx window
 373  * @rate_n_flags: Rate at which Tx was attempted
 374  *
 375  * If REPLY_TX indicates that aggregation was attempted, driver must wait
 376  * for block ack (REPLY_COMPRESSED_BA).  This struct stores tx reply info
 377  * until block ack arrives.
 378  */
 379 struct iwl_ht_agg {
 380         u16 txq_id;
 381         u16 frame_count;
 382         u16 wait_for_ba;
 383         u16 start_idx;
 384         u64 bitmap;
 385         u32 rate_n_flags;
 386 #define IWL_AGG_OFF 0
 387 #define IWL_AGG_ON 1
 388 #define IWL_EMPTYING_HW_QUEUE_ADDBA 2
 389 #define IWL_EMPTYING_HW_QUEUE_DELBA 3
 390         u8 state;
 391         u8 tx_fifo;
 392 };
 393
 394
 395 struct iwl_tid_data {
 396         u16 seq_number; /* agn only */
 397         u16 tfds_in_queue;
 398         struct iwl_ht_agg agg;
 399 };
 400
 401 union iwl_ht_rate_supp {
 402         u16 rates;
 403         struct {
 404                 u8 siso_rate;
 405                 u8 mimo_rate;
 406         };
 407 };
 408
 409 #define CFG_HT_RX_AMPDU_FACTOR_8K   (0x0)
 410 #define CFG_HT_RX_AMPDU_FACTOR_16K  (0x1)
 411 #define CFG_HT_RX_AMPDU_FACTOR_32K  (0x2)
 412 #define CFG_HT_RX_AMPDU_FACTOR_64K  (0x3)
 413 #define CFG_HT_RX_AMPDU_FACTOR_DEF  CFG_HT_RX_AMPDU_FACTOR_64K
 414 #define CFG_HT_RX_AMPDU_FACTOR_MAX  CFG_HT_RX_AMPDU_FACTOR_64K
 415 #define CFG_HT_RX_AMPDU_FACTOR_MIN  CFG_HT_RX_AMPDU_FACTOR_8K
 416
 417 /*
 418  * Maximal MPDU density for TX aggregation
 419  * 4 - 2us density
 420  * 5 - 4us density
 421  * 6 - 8us density
 422  * 7 - 16us density
 423  */
 424 #define CFG_HT_MPDU_DENSITY_2USEC   (0x4)
 425 #define CFG_HT_MPDU_DENSITY_4USEC   (0x5)
 426 #define CFG_HT_MPDU_DENSITY_8USEC   (0x6)
 427 #define CFG_HT_MPDU_DENSITY_16USEC  (0x7)
 428 #define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_4USEC
 429 #define CFG_HT_MPDU_DENSITY_MAX CFG_HT_MPDU_DENSITY_16USEC
 430 #define CFG_HT_MPDU_DENSITY_MIN     (0x1)
 431
 432 struct iwl_ht_config {
 433         bool single_chain_sufficient;
 434         enum ieee80211_smps_mode smps; /* current smps mode */
 435 };
 436
 437 /* QoS structures */
 438 struct iwl_qos_info {
 439         int qos_active;
 440         struct iwl_qosparam_cmd def_qos_parm;
 441 };
 442
 443 /*
 444  * Structure should be accessed with sta_lock held. When station addition
 445  * is in progress (IWL_STA_UCODE_INPROGRESS) it is possible to access only
 446  * the commands (iwl_addsta_cmd and iwl_link_quality_cmd) without sta_lock
 447  * held.
 448  */
 449 struct iwl_station_entry {
 450         struct iwl_addsta_cmd sta;
 451         struct iwl_tid_data tid[MAX_TID_COUNT];
 452         u8 used, ctxid;
 453         struct iwl_link_quality_cmd *lq;
 454 };
 455
 456 struct iwl_station_priv_common {
 457         struct iwl_rxon_context *ctx;
 458         u8 sta_id;
 459 };
 460
 461 /*
 462  * iwl_station_priv: Driver's private station information
 463  *
 464  * When mac80211 creates a station it reserves some space (hw->sta_data_size)
 465  * in the structure for use by driver. This structure is places in that
 466  * space.
 467  */
 468 struct iwl_station_priv {
 469         struct iwl_station_priv_common common;
 470         struct iwl_lq_sta lq_sta;
 471         atomic_t pending_frames;
 472         bool client;
 473         bool asleep;
 474         u8 max_agg_bufsize;
 475 };
 476
 477 /**
 478  * struct iwl_vif_priv - driver's private per-interface information
 479  *
 480  * When mac80211 allocates a virtual interface, it can allocate
 481  * space for us to put data into.
 482  */
 483 struct iwl_vif_priv {
 484         struct iwl_rxon_context *ctx;
 485         u8 ibss_bssid_sta_id;
 486 };
 487
 488 /* one for each uCode image (inst/data, boot/init/runtime) */
 489 struct fw_desc {
 490         void *v_addr;           /* access by driver */
 491         dma_addr_t p_addr;      /* access by card's busmaster DMA */
 492         u32 len;                /* bytes */
 493 };
 494
 495 struct fw_img {
 496         struct fw_desc code, data;
 497 };
 498
 499 /* v1/v2 uCode file layout */
 500 struct iwl_ucode_header {
 501         __le32 ver;     /* major/minor/API/serial */
 502         union {
 503                 struct {
 504                         __le32 inst_size;       /* bytes of runtime code */
 505                         __le32 data_size;       /* bytes of runtime data */
 506                         __le32 init_size;       /* bytes of init code */
 507                         __le32 init_data_size;  /* bytes of init data */
 508                         __le32 boot_size;       /* bytes of bootstrap code */
 509                         u8 data[0];             /* in same order as sizes */
 510                 } v1;
 511                 struct {
 512                         __le32 build;           /* build number */
 513                         __le32 inst_size;       /* bytes of runtime code */
 514                         __le32 data_size;       /* bytes of runtime data */
 515                         __le32 init_size;       /* bytes of init code */
 516                         __le32 init_data_size;  /* bytes of init data */
 517                         __le32 boot_size;       /* bytes of bootstrap code */
 518                         u8 data[0];             /* in same order as sizes */
 519                 } v2;
 520         } u;
 521 };
 522
 523 /*
 524  * new TLV uCode file layout
 525  *
 526  * The new TLV file format contains TLVs, that each specify
 527  * some piece of data. To facilitate "groups", for example
 528  * different instruction image with different capabilities,
 529  * bundled with the same init image, an alternative mechanism
 530  * is provided:
 531  * When the alternative field is 0, that means that the item
 532  * is always valid. When it is non-zero, then it is only
 533  * valid in conjunction with items of the same alternative,
 534  * in which case the driver (user) selects one alternative
 535  * to use.
 536  */
 537
 538 enum iwl_ucode_tlv_type {
 539         IWL_UCODE_TLV_INVALID           = 0, /* unused */
 540         IWL_UCODE_TLV_INST              = 1,
 541         IWL_UCODE_TLV_DATA              = 2,
 542         IWL_UCODE_TLV_INIT              = 3,
 543         IWL_UCODE_TLV_INIT_DATA         = 4,
 544         IWL_UCODE_TLV_BOOT              = 5,
 545         IWL_UCODE_TLV_PROBE_MAX_LEN     = 6, /* a u32 value */
 546         IWL_UCODE_TLV_PAN               = 7,
 547         IWL_UCODE_TLV_RUNT_EVTLOG_PTR   = 8,
 548         IWL_UCODE_TLV_RUNT_EVTLOG_SIZE  = 9,
 549         IWL_UCODE_TLV_RUNT_ERRLOG_PTR   = 10,
 550         IWL_UCODE_TLV_INIT_EVTLOG_PTR   = 11,
 551         IWL_UCODE_TLV_INIT_EVTLOG_SIZE  = 12,
 552         IWL_UCODE_TLV_INIT_ERRLOG_PTR   = 13,
 553         IWL_UCODE_TLV_ENHANCE_SENS_TBL  = 14,
 554         IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
 555         IWL_UCODE_TLV_WOWLAN_INST       = 16,
 556         IWL_UCODE_TLV_WOWLAN_DATA       = 17,
 557         IWL_UCODE_TLV_FLAGS             = 18,
 558 };
 559
 560 /**
 561  * enum iwl_ucode_tlv_flag - ucode API flags
 562  * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
 563  *      was a separate TLV but moved here to save space.
 564  * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
 565  *      treats good CRC threshold as a boolean
 566  * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
 567  */
 568 enum iwl_ucode_tlv_flag {
 569         IWL_UCODE_TLV_FLAGS_PAN         = BIT(0),
 570         IWL_UCODE_TLV_FLAGS_NEWSCAN     = BIT(1),
 571         IWL_UCODE_TLV_FLAGS_MFP         = BIT(2),
 572 };
 573
 574 struct iwl_ucode_tlv {
 575         __le16 type;            /* see above */
 576         __le16 alternative;     /* see comment */
 577         __le32 length;          /* not including type/length fields */
 578         u8 data[0];
 579 } __packed;
 580
 581 #define IWL_TLV_UCODE_MAGIC     0x0a4c5749
 582
 583 struct iwl_tlv_ucode_header {
 584         /*
 585          * The TLV style ucode header is distinguished from
 586          * the v1/v2 style header by first four bytes being
 587          * zero, as such is an invalid combination of
 588          * major/minor/API/serial versions.
 589          */
 590         __le32 zero;
 591         __le32 magic;
 592         u8 human_readable[64];
 593         __le32 ver;             /* major/minor/API/serial */
 594         __le32 build;
 595         __le64 alternatives;    /* bitmask of valid alternatives */
 596         /*
 597          * The data contained herein has a TLV layout,
 598          * see above for the TLV header and types.
 599          * Note that each TLV is padded to a length
 600          * that is a multiple of 4 for alignment.
 601          */
 602         u8 data[0];
 603 };
 604
 605 struct iwl_sensitivity_ranges {
 606         u16 min_nrg_cck;
 607         u16 max_nrg_cck;
 608
 609         u16 nrg_th_cck;
 610         u16 nrg_th_ofdm;
 611
 612         u16 auto_corr_min_ofdm;
 613         u16 auto_corr_min_ofdm_mrc;
 614         u16 auto_corr_min_ofdm_x1;
 615         u16 auto_corr_min_ofdm_mrc_x1;
 616
 617         u16 auto_corr_max_ofdm;
 618         u16 auto_corr_max_ofdm_mrc;
 619         u16 auto_corr_max_ofdm_x1;
 620         u16 auto_corr_max_ofdm_mrc_x1;
 621
 622         u16 auto_corr_max_cck;
 623         u16 auto_corr_max_cck_mrc;
 624         u16 auto_corr_min_cck;
 625         u16 auto_corr_min_cck_mrc;
 626
 627         u16 barker_corr_th_min;
 628         u16 barker_corr_th_min_mrc;
 629         u16 nrg_th_cca;
 630 };
 631
 632
 633 #define KELVIN_TO_CELSIUS(x) ((x)-273)
 634 #define CELSIUS_TO_KELVIN(x) ((x)+273)
 635
 636
 637 /**
 638  * struct iwl_hw_params
 639  * @max_txq_num: Max # Tx queues supported
 640  * @scd_bc_tbls_size: size of scheduler byte count tables
 641  * @tfd_size: TFD size
 642  * @tx/rx_chains_num: Number of TX/RX chains
 643  * @valid_tx/rx_ant: usable antennas
 644  * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
 645  * @max_rxq_log: Log-base-2 of max_rxq_size
 646  * @rx_page_order: Rx buffer page order
 647  * @rx_wrt_ptr_reg: FH{39}_RSCSR_CHNL0_WPTR
 648  * @max_stations:
 649  * @ht40_channel: is 40MHz width possible in band 2.4
 650  * BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ)
 651  * @sw_crypto: 0 for hw, 1 for sw
 652  * @max_xxx_size: for ucode uses
 653  * @ct_kill_threshold: temperature threshold
 654  * @beacon_time_tsf_bits: number of valid tsf bits for beacon time
 655  * @calib_init_cfg: setup initial calibrations for the hw
 656  * @calib_rt_cfg: setup runtime calibrations for the hw
 657  * @struct iwl_sensitivity_ranges: range of sensitivity values
 658  */
 659 struct iwl_hw_params {
 660         u8 max_txq_num;
 661         u16 scd_bc_tbls_size;
 662         u32 tfd_size;
 663         u8  tx_chains_num;
 664         u8  rx_chains_num;
 665         u8  valid_tx_ant;
 666         u8  valid_rx_ant;
 667         u16 max_rxq_size;
 668         u16 max_rxq_log;
 669         u32 rx_page_order;
 670         u8  max_stations;
 671         u8  ht40_channel;
 672         u8  max_beacon_itrvl;   /* in 1024 ms */
 673         u32 max_inst_size;
 674         u32 max_data_size;
 675         u32 ct_kill_threshold; /* value in hw-dependent units */
 676         u32 ct_kill_exit_threshold; /* value in hw-dependent units */
 677                                     /* for 1000, 6000 series and up */
 678         u16 beacon_time_tsf_bits;
 679         u32 calib_init_cfg;
 680         u32 calib_rt_cfg;
 681         const struct iwl_sensitivity_ranges *sens;
 682 };
 683
 684
 685 /******************************************************************************
 686  *
 687  * Functions implemented in core module which are forward declared here
 688  * for use by iwl-[4-5].c
 689  *
 690  * NOTE:  The implementation of these functions are not hardware specific
 691  * which is why they are in the core module files.
 692  *
 693  * Naming convention --
 694  * iwl_         <-- Is part of iwlwifi
 695  * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
 696  *
 697  ****************************************************************************/
 698 extern void iwl_update_chain_flags(struct iwl_priv *priv);
 699 extern const u8 iwl_bcast_addr[ETH_ALEN];
 700 extern int iwl_queue_space(const struct iwl_queue *q);
 701 static inline int iwl_queue_used(const struct iwl_queue *q, int i)
 702 {
 703         return q->write_ptr >= q->read_ptr ?
 704                 (i >= q->read_ptr && i < q->write_ptr) :
 705                 !(i < q->read_ptr && i >= q->write_ptr);
 706 }
 707
 708
 709 static inline u8 get_cmd_index(struct iwl_queue *q, u32 index)
 710 {
 711         return index & (q->n_window - 1);
 712 }
 713
 714
 715 struct iwl_dma_ptr {
 716         dma_addr_t dma;
 717         void *addr;
 718         size_t size;
 719 };
 720
 721 #define IWL_OPERATION_MODE_AUTO     0
 722 #define IWL_OPERATION_MODE_HT_ONLY  1
 723 #define IWL_OPERATION_MODE_MIXED    2
 724 #define IWL_OPERATION_MODE_20MHZ    3
 725
 726 #define IWL_TX_CRC_SIZE 4
 727 #define IWL_TX_DELIMITER_SIZE 4
 728
 729 #define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000
 730
 731 /* Sensitivity and chain noise calibration */
 732 #define INITIALIZATION_VALUE            0xFFFF
 733 #define IWL_CAL_NUM_BEACONS             16
 734 #define MAXIMUM_ALLOWED_PATHLOSS        15
 735
 736 #define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
 737
 738 #define MAX_FA_OFDM  50
 739 #define MIN_FA_OFDM  5
 740 #define MAX_FA_CCK   50
 741 #define MIN_FA_CCK   5
 742
 743 #define AUTO_CORR_STEP_OFDM       1
 744
 745 #define AUTO_CORR_STEP_CCK     3
 746 #define AUTO_CORR_MAX_TH_CCK   160
 747
 748 #define NRG_DIFF               2
 749 #define NRG_STEP_CCK           2
 750 #define NRG_MARGIN             8
 751 #define MAX_NUMBER_CCK_NO_FA 100
 752
 753 #define AUTO_CORR_CCK_MIN_VAL_DEF    (125)
 754
 755 #define CHAIN_A             0
 756 #define CHAIN_B             1
 757 #define CHAIN_C             2
 758 #define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
 759 #define ALL_BAND_FILTER                 0xFF00
 760 #define IN_BAND_FILTER                  0xFF
 761 #define MIN_AVERAGE_NOISE_MAX_VALUE     0xFFFFFFFF
 762
 763 #define NRG_NUM_PREV_STAT_L     20
 764 #define NUM_RX_CHAINS           3
 765
 766 enum iwlagn_false_alarm_state {
 767         IWL_FA_TOO_MANY = 0,
 768         IWL_FA_TOO_FEW = 1,
 769         IWL_FA_GOOD_RANGE = 2,
 770 };
 771
 772 enum iwlagn_chain_noise_state {
 773         IWL_CHAIN_NOISE_ALIVE = 0,  /* must be 0 */
 774         IWL_CHAIN_NOISE_ACCUMULATE,
 775         IWL_CHAIN_NOISE_CALIBRATED,
 776         IWL_CHAIN_NOISE_DONE,
 777 };
 778
 779
 780 /*
 781  * enum iwl_calib
 782  * defines the order in which results of initial calibrations
 783  * should be sent to the runtime uCode
 784  */
 785 enum iwl_calib {
 786         IWL_CALIB_XTAL,
 787         IWL_CALIB_DC,
 788         IWL_CALIB_LO,
 789         IWL_CALIB_TX_IQ,
 790         IWL_CALIB_TX_IQ_PERD,
 791         IWL_CALIB_BASE_BAND,
 792         IWL_CALIB_TEMP_OFFSET,
 793         IWL_CALIB_MAX
 794 };
 795
 796 /* Opaque calibration results */
 797 struct iwl_calib_result {
 798         void *buf;
 799         size_t buf_len;
 800 };
 801
 802 /* Sensitivity calib data */
 803 struct iwl_sensitivity_data {
 804         u32 auto_corr_ofdm;
 805         u32 auto_corr_ofdm_mrc;
 806         u32 auto_corr_ofdm_x1;
 807         u32 auto_corr_ofdm_mrc_x1;
 808         u32 auto_corr_cck;
 809         u32 auto_corr_cck_mrc;
 810
 811         u32 last_bad_plcp_cnt_ofdm;
 812         u32 last_fa_cnt_ofdm;
 813         u32 last_bad_plcp_cnt_cck;
 814         u32 last_fa_cnt_cck;
 815
 816         u32 nrg_curr_state;
 817         u32 nrg_prev_state;
 818         u32 nrg_value[10];
 819         u8  nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
 820         u32 nrg_silence_ref;
 821         u32 nrg_energy_idx;
 822         u32 nrg_silence_idx;
 823         u32 nrg_th_cck;
 824         s32 nrg_auto_corr_silence_diff;
 825         u32 num_in_cck_no_fa;
 826         u32 nrg_th_ofdm;
 827
 828         u16 barker_corr_th_min;
 829         u16 barker_corr_th_min_mrc;
 830         u16 nrg_th_cca;
 831 };
 832
 833 /* Chain noise (differential Rx gain) calib data */
 834 struct iwl_chain_noise_data {
 835         u32 active_chains;
 836         u32 chain_noise_a;
 837         u32 chain_noise_b;
 838         u32 chain_noise_c;
 839         u32 chain_signal_a;
 840         u32 chain_signal_b;
 841         u32 chain_signal_c;
 842         u16 beacon_count;
 843         u8 disconn_array[NUM_RX_CHAINS];
 844         u8 delta_gain_code[NUM_RX_CHAINS];
 845         u8 radio_write;
 846         u8 state;
 847 };
 848
 849 #define EEPROM_SEM_TIMEOUT 10           /* milliseconds */
 850 #define EEPROM_SEM_RETRY_LIMIT 1000     /* number of attempts (not time) */
 851
 852 #define IWL_TRAFFIC_ENTRIES     (256)
 853 #define IWL_TRAFFIC_ENTRY_SIZE  (64)
 854
 855 enum {
 856         MEASUREMENT_READY = (1 << 0),
 857         MEASUREMENT_ACTIVE = (1 << 1),
 858 };
 859
 860 enum iwl_nvm_type {
 861         NVM_DEVICE_TYPE_EEPROM = 0,
 862         NVM_DEVICE_TYPE_OTP,
 863 };
 864
 865 /*
 866  * Two types of OTP memory access modes
 867  *   IWL_OTP_ACCESS_ABSOLUTE - absolute address mode,
 868  *                              based on physical memory addressing
 869  *   IWL_OTP_ACCESS_RELATIVE - relative address mode,
 870  *                             based on logical memory addressing
 871  */
 872 enum iwl_access_mode {
 873         IWL_OTP_ACCESS_ABSOLUTE,
 874         IWL_OTP_ACCESS_RELATIVE,
 875 };
 876
 877 /**
 878  * enum iwl_pa_type - Power Amplifier type
 879  * @IWL_PA_SYSTEM:  based on uCode configuration
 880  * @IWL_PA_INTERNAL: use Internal only
 881  */
 882 enum iwl_pa_type {
 883         IWL_PA_SYSTEM = 0,
 884         IWL_PA_INTERNAL = 1,
 885 };
 886
 887 /* interrupt statistics */
 888 struct isr_statistics {
 889         u32 hw;
 890         u32 sw;
 891         u32 err_code;
 892         u32 sch;
 893         u32 alive;
 894         u32 rfkill;
 895         u32 ctkill;
 896         u32 wakeup;
 897         u32 rx;
 898         u32 rx_handlers[REPLY_MAX];
 899         u32 tx;
 900         u32 unhandled;
 901 };
 902
 903 /* reply_tx_statistics (for _agn devices) */
 904 struct reply_tx_error_statistics {
 905         u32 pp_delay;
 906         u32 pp_few_bytes;
 907         u32 pp_bt_prio;
 908         u32 pp_quiet_period;
 909         u32 pp_calc_ttak;
 910         u32 int_crossed_retry;
 911         u32 short_limit;
 912         u32 long_limit;
 913         u32 fifo_underrun;
 914         u32 drain_flow;
 915         u32 rfkill_flush;
 916         u32 life_expire;
 917         u32 dest_ps;
 918         u32 host_abort;
 919         u32 bt_retry;
 920         u32 sta_invalid;
 921         u32 frag_drop;
 922         u32 tid_disable;
 923         u32 fifo_flush;
 924         u32 insuff_cf_poll;
 925         u32 fail_hw_drop;
 926         u32 sta_color_mismatch;
 927         u32 unknown;
 928 };
 929
 930 /* reply_agg_tx_statistics (for _agn devices) */
 931 struct reply_agg_tx_error_statistics {
 932         u32 underrun;
 933         u32 bt_prio;
 934         u32 few_bytes;
 935         u32 abort;
 936         u32 last_sent_ttl;
 937         u32 last_sent_try;
 938         u32 last_sent_bt_kill;
 939         u32 scd_query;
 940         u32 bad_crc32;
 941         u32 response;
 942         u32 dump_tx;
 943         u32 delay_tx;
 944         u32 unknown;
 945 };
 946
 947 /* management statistics */
 948 enum iwl_mgmt_stats {
 949         MANAGEMENT_ASSOC_REQ = 0,
 950         MANAGEMENT_ASSOC_RESP,
 951         MANAGEMENT_REASSOC_REQ,
 952         MANAGEMENT_REASSOC_RESP,
 953         MANAGEMENT_PROBE_REQ,
 954         MANAGEMENT_PROBE_RESP,
 955         MANAGEMENT_BEACON,
 956         MANAGEMENT_ATIM,
 957         MANAGEMENT_DISASSOC,
 958         MANAGEMENT_AUTH,
 959         MANAGEMENT_DEAUTH,
 960         MANAGEMENT_ACTION,
 961         MANAGEMENT_MAX,
 962 };
 963 /* control statistics */
 964 enum iwl_ctrl_stats {
 965         CONTROL_BACK_REQ =  0,
 966         CONTROL_BACK,
 967         CONTROL_PSPOLL,
 968         CONTROL_RTS,
 969         CONTROL_CTS,
 970         CONTROL_ACK,
 971         CONTROL_CFEND,
 972         CONTROL_CFENDACK,
 973         CONTROL_MAX,
 974 };
 975
 976 struct traffic_stats {
 977 #ifdef CONFIG_IWLWIFI_DEBUGFS
 978         u32 mgmt[MANAGEMENT_MAX];
 979         u32 ctrl[CONTROL_MAX];
 980         u32 data_cnt;
 981         u64 data_bytes;
 982 #endif
 983 };
 984
 985 /*
 986  * schedule the timer to wake up every UCODE_TRACE_PERIOD milliseconds
 987  * to perform continuous uCode event logging operation if enabled
 988  */
 989 #define UCODE_TRACE_PERIOD (100)
 990
 991 /*
 992  * iwl_event_log: current uCode event log position
 993  *
 994  * @ucode_trace: enable/disable ucode continuous trace timer
 995  * @num_wraps: how many times the event buffer wraps
 996  * @next_entry:  the entry just before the next one that uCode would fill
 997  * @non_wraps_count: counter for no wrap detected when dump ucode events
 998  * @wraps_once_count: counter for wrap once detected when dump ucode events
 999  * @wraps_more_count: counter for wrap more than once detected
1000  *                    when dump ucode events
1001  */
1002 struct iwl_event_log {
1003         bool ucode_trace;
1004         u32 num_wraps;
1005         u32 next_entry;
1006         int non_wraps_count;
1007         int wraps_once_count;
1008         int wraps_more_count;
1009 };
1010
1011 /*
1012  * host interrupt timeout value
1013  * used with setting interrupt coalescing timer
1014  * the CSR_INT_COALESCING is an 8 bit register in 32-usec unit
1015  *
1016  * default interrupt coalescing timer is 64 x 32 = 2048 usecs
1017  * default interrupt coalescing calibration timer is 16 x 32 = 512 usecs
1018  */
1019 #define IWL_HOST_INT_TIMEOUT_MAX        (0xFF)
1020 #define IWL_HOST_INT_TIMEOUT_DEF        (0x40)
1021 #define IWL_HOST_INT_TIMEOUT_MIN        (0x0)
1022 #define IWL_HOST_INT_CALIB_TIMEOUT_MAX  (0xFF)
1023 #define IWL_HOST_INT_CALIB_TIMEOUT_DEF  (0x10)
1024 #define IWL_HOST_INT_CALIB_TIMEOUT_MIN  (0x0)
1025
1026 /*
1027  * This is the threshold value of plcp error rate per 100mSecs.  It is
1028  * used to set and check for the validity of plcp_delta.
1029  */
1030 #define IWL_MAX_PLCP_ERR_THRESHOLD_MIN  (1)
1031 #define IWL_MAX_PLCP_ERR_THRESHOLD_DEF  (50)
1032 #define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF     (100)
1033 #define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF (200)
1034 #define IWL_MAX_PLCP_ERR_THRESHOLD_MAX  (255)
1035 #define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE      (0)
1036
1037 #define IWL_DELAY_NEXT_FORCE_RF_RESET  (HZ*3)
1038 #define IWL_DELAY_NEXT_FORCE_FW_RELOAD (HZ*5)
1039
1040 /* TX queue watchdog timeouts in mSecs */
1041 #define IWL_DEF_WD_TIMEOUT      (2000)
1042 #define IWL_LONG_WD_TIMEOUT     (10000)
1043 #define IWL_MAX_WD_TIMEOUT      (120000)
1044
1045 /* BT Antenna Coupling Threshold (dB) */
1046 #define IWL_BT_ANTENNA_COUPLING_THRESHOLD       (35)
1047
1048 /* Firmware reload counter and Timestamp */
1049 #define IWL_MIN_RELOAD_DURATION         1000 /* 1000 ms */
1050 #define IWL_MAX_CONTINUE_RELOAD_CNT     4
1051
1052
1053 enum iwl_reset {
1054         IWL_RF_RESET = 0,
1055         IWL_FW_RESET,
1056         IWL_MAX_FORCE_RESET,
1057 };
1058
1059 struct iwl_force_reset {
1060         int reset_request_count;
1061         int reset_success_count;
1062         int reset_reject_count;
1063         unsigned long reset_duration;
1064         unsigned long last_force_reset_jiffies;
1065 };
1066
1067 /* extend beacon time format bit shifting  */
1068 /*
1069  * for _agn devices
1070  * bits 31:22 - extended
1071  * bits 21:0  - interval
1072  */
1073 #define IWLAGN_EXT_BEACON_TIME_POS      22
1074
1075 /**
1076  * struct iwl_notification_wait - notification wait entry
1077  * @list: list head for global list
1078  * @fn: function called with the notification
1079  * @cmd: command ID
1080  *
1081  * This structure is not used directly, to wait for a
1082  * notification declare it on the stack, and call
1083  * iwlagn_init_notification_wait() with appropriate
1084  * parameters. Then do whatever will cause the ucode
1085  * to notify the driver, and to wait for that then
1086  * call iwlagn_wait_notification().
1087  *
1088  * Each notification is one-shot. If at some point we
1089  * need to support multi-shot notifications (which
1090  * can't be allocated on the stack) we need to modify
1091  * the code for them.
1092  */
1093 struct iwl_notification_wait {
1094         struct list_head list;
1095
1096         void (*fn)(struct iwl_priv *priv, struct iwl_rx_packet *pkt,
1097                    void *data);
1098         void *fn_data;
1099
1100         u8 cmd;
1101         bool triggered, aborted;
1102 };
1103
1104 enum iwl_rxon_context_id {
1105         IWL_RXON_CTX_BSS,
1106         IWL_RXON_CTX_PAN,
1107
1108         NUM_IWL_RXON_CTX
1109 };
1110
1111 struct iwl_rxon_context {
1112         struct ieee80211_vif *vif;
1113
1114         const u8 *ac_to_fifo;
1115         const u8 *ac_to_queue;
1116         u8 mcast_queue;
1117
1118         /*
1119          * We could use the vif to indicate active, but we
1120          * also need it to be active during disabling when
1121          * we already removed the vif for type setting.
1122          */
1123         bool always_active, is_active;
1124
1125         bool ht_need_multiple_chains;
1126
1127         enum iwl_rxon_context_id ctxid;
1128
1129         u32 interface_modes, exclusive_interface_modes;
1130         u8 unused_devtype, ap_devtype, ibss_devtype, station_devtype;
1131
1132         /*
1133          * We declare this const so it can only be
1134          * changed via explicit cast within the
1135          * routines that actually update the physical
1136          * hardware.
1137          */
1138         const struct iwl_rxon_cmd active;
1139         struct iwl_rxon_cmd staging;
1140
1141         struct iwl_rxon_time_cmd timing;
1142
1143         struct iwl_qos_info qos_data;
1144
1145         u8 bcast_sta_id, ap_sta_id;
1146
1147         u8 rxon_cmd, rxon_assoc_cmd, rxon_timing_cmd;
1148         u8 qos_cmd;
1149         u8 wep_key_cmd;
1150
1151         struct iwl_wep_key wep_keys[WEP_KEYS_MAX];
1152         u8 key_mapping_keys;
1153
1154         __le32 station_flags;
1155
1156         int beacon_int;
1157
1158         struct {
1159                 bool non_gf_sta_present;
1160                 u8 protection;
1161                 bool enabled, is_40mhz;
1162                 u8 extension_chan_offset;
1163         } ht;
1164
1165         bool last_tx_rejected;
1166 };
1167
1168 enum iwl_scan_type {
1169         IWL_SCAN_NORMAL,
1170         IWL_SCAN_RADIO_RESET,
1171         IWL_SCAN_OFFCH_TX,
1172 };
1173
1174 enum iwlagn_ucode_type {
1175         IWL_UCODE_NONE,
1176         IWL_UCODE_REGULAR,
1177         IWL_UCODE_INIT,
1178         IWL_UCODE_WOWLAN,
1179 };
1180
1181 #ifdef CONFIG_IWLWIFI_DEVICE_SVTOOL
1182 struct iwl_testmode_trace {
1183         u32 buff_size;
1184         u32 total_size;
1185         u32 num_chunks;
1186         u8 *cpu_addr;
1187         u8 *trace_addr;
1188         dma_addr_t dma_addr;
1189         bool trace_enabled;
1190 };
1191 #endif
1192
1193 /* uCode ownership */
1194 #define IWL_OWNERSHIP_DRIVER    0
1195 #define IWL_OWNERSHIP_TM        1
1196
1197 struct iwl_priv {
1198
1199         /* ieee device used by generic ieee processing code */
1200         struct ieee80211_hw *hw;
1201         struct ieee80211_channel *ieee_channels;
1202         struct ieee80211_rate *ieee_rates;
1203         struct iwl_cfg *cfg;
1204
1205         enum ieee80211_band band;
1206
1207         void (*pre_rx_handler)(struct iwl_priv *priv,
1208                                struct iwl_rx_mem_buffer *rxb);
1209         void (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
1210                                        struct iwl_rx_mem_buffer *rxb);
1211
1212         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
1213
1214         /* spectrum measurement report caching */
1215         struct iwl_spectrum_notification measure_report;
1216         u8 measurement_status;
1217
1218         /* ucode beacon time */
1219         u32 ucode_beacon_time;
1220         int missed_beacon_threshold;
1221
1222         /* track IBSS manager (last beacon) status */
1223         u32 ibss_manager;
1224
1225         /* jiffies when last recovery from statistics was performed */
1226         unsigned long rx_statistics_jiffies;
1227
1228         /* force reset */
1229         struct iwl_force_reset force_reset[IWL_MAX_FORCE_RESET];
1230
1231         /* firmware reload counter and timestamp */
1232         unsigned long reload_jiffies;
1233         int reload_count;
1234
1235         /* we allocate array of iwl_channel_info for NIC's valid channels.
1236          *    Access via channel # using indirect index array */
1237         struct iwl_channel_info *channel_info;  /* channel info array */
1238         u8 channel_count;       /* # of channels */
1239
1240         /* thermal calibration */
1241         s32 temperature;        /* degrees Kelvin */
1242         s32 last_temperature;
1243
1244         /* init calibration results */
1245         struct iwl_calib_result calib_results[IWL_CALIB_MAX];
1246
1247         /* Scan related variables */
1248         unsigned long scan_start;
1249         unsigned long scan_start_tsf;
1250         void *scan_cmd;
1251         enum ieee80211_band scan_band;
1252         struct cfg80211_scan_request *scan_request;
1253         struct ieee80211_vif *scan_vif;
1254         enum iwl_scan_type scan_type;
1255         u8 scan_tx_ant[IEEE80211_NUM_BANDS];
1256         u8 mgmt_tx_ant;
1257
1258         /* spinlock */
1259         spinlock_t lock;        /* protect general shared data */
1260         spinlock_t hcmd_lock;   /* protect hcmd */
1261         spinlock_t reg_lock;    /* protect hw register access */
1262         struct mutex mutex;
1263
1264         struct iwl_bus *bus;    /* bus specific data */
1265         struct iwl_trans trans;
1266
1267         /* microcode/device supports multiple contexts */
1268         u8 valid_contexts;
1269
1270         /* command queue number */
1271         u8 cmd_queue;
1272
1273         /* max number of station keys */
1274         u8 sta_key_max_num;
1275
1276         bool new_scan_threshold_behaviour;
1277
1278         /* EEPROM MAC addresses */
1279         struct mac_address addresses[2];
1280
1281         /* uCode images, save to reload in case of failure */
1282         int fw_index;                   /* firmware we're trying to load */
1283         u32 ucode_ver;                  /* version of ucode, copy of
1284                                            iwl_ucode.ver */
1285
1286         /* uCode owner: default: IWL_OWNERSHIP_DRIVER */
1287         u8 ucode_owner;
1288
1289         struct fw_img ucode_rt;
1290         struct fw_img ucode_init;
1291         struct fw_img ucode_wowlan;
1292
1293         enum iwlagn_ucode_type ucode_type;
1294         u8 ucode_write_complete;        /* the image write is complete */
1295         char firmware_name[25];
1296
1297         struct iwl_rxon_context contexts[NUM_IWL_RXON_CTX];
1298
1299         __le16 switch_channel;
1300
1301         struct {
1302                 u32 error_event_table;
1303                 u32 log_event_table;
1304         } device_pointers;
1305
1306         u16 active_rate;
1307
1308         u8 start_calib;
1309         struct iwl_sensitivity_data sensitivity_data;
1310         struct iwl_chain_noise_data chain_noise_data;
1311         bool enhance_sensitivity_table;
1312         __le16 sensitivity_tbl[HD_TABLE_SIZE];
1313         __le16 enhance_sensitivity_tbl[ENHANCE_HD_TABLE_ENTRIES];
1314
1315         struct iwl_ht_config current_ht_config;
1316
1317         /* Rate scaling data */
1318         u8 retry_rate;
1319
1320         wait_queue_head_t wait_command_queue;
1321
1322         int activity_timer_active;
1323
1324         /* Rx and Tx DMA processing queues */
1325         struct iwl_rx_queue rxq;
1326         struct iwl_tx_queue *txq;
1327         unsigned long txq_ctx_active_msk;
1328         struct iwl_dma_ptr  kw; /* keep warm address */
1329         struct iwl_dma_ptr  scd_bc_tbls;
1330
1331         u32 scd_base_addr;      /* scheduler sram base address */
1332
1333         unsigned long status;
1334
1335         /* counts mgmt, ctl, and data packets */
1336         struct traffic_stats tx_stats;
1337         struct traffic_stats rx_stats;
1338
1339         /* counts interrupts */
1340         struct isr_statistics isr_stats;
1341
1342         struct iwl_power_mgr power_data;
1343         struct iwl_tt_mgmt thermal_throttle;
1344
1345         /* station table variables */
1346
1347         /* Note: if lock and sta_lock are needed, lock must be acquired first */
1348         spinlock_t sta_lock;
1349         int num_stations;
1350         struct iwl_station_entry stations[IWLAGN_STATION_COUNT];
1351         unsigned long ucode_key_table;
1352
1353         /* queue refcounts */
1354 #define IWL_MAX_HW_QUEUES       32
1355         unsigned long queue_stopped[BITS_TO_LONGS(IWL_MAX_HW_QUEUES)];
1356         /* for each AC */
1357         atomic_t queue_stop_count[4];
1358
1359         /* Indication if ieee80211_ops->open has been called */
1360         u8 is_open;
1361
1362         u8 mac80211_registered;
1363
1364         bool wowlan;
1365
1366         /* eeprom -- this is in the card's little endian byte order */
1367         u8 *eeprom;
1368         int    nvm_device_type;
1369         struct iwl_eeprom_calib_info *calib_info;
1370
1371         enum nl80211_iftype iw_mode;
1372
1373         /* Last Rx'd beacon timestamp */
1374         u64 timestamp;
1375
1376         struct {
1377                 __le32 flag;
1378                 struct statistics_general_common common;
1379                 struct statistics_rx_non_phy rx_non_phy;
1380                 struct statistics_rx_phy rx_ofdm;
1381                 struct statistics_rx_ht_phy rx_ofdm_ht;
1382                 struct statistics_rx_phy rx_cck;
1383                 struct statistics_tx tx;
1384 #ifdef CONFIG_IWLWIFI_DEBUGFS
1385                 struct statistics_bt_activity bt_activity;
1386                 __le32 num_bt_kills, accum_num_bt_kills;
1387 #endif
1388         } statistics;
1389 #ifdef CONFIG_IWLWIFI_DEBUGFS
1390         struct {
1391                 struct statistics_general_common common;
1392                 struct statistics_rx_non_phy rx_non_phy;
1393                 struct statistics_rx_phy rx_ofdm;
1394                 struct statistics_rx_ht_phy rx_ofdm_ht;
1395                 struct statistics_rx_phy rx_cck;
1396                 struct statistics_tx tx;
1397                 struct statistics_bt_activity bt_activity;
1398         } accum_stats, delta_stats, max_delta_stats;
1399 #endif
1400
1401         /* INT ICT Table */
1402         __le32 *ict_tbl;
1403         void *ict_tbl_vir;
1404         dma_addr_t ict_tbl_dma;
1405         dma_addr_t aligned_ict_tbl_dma;
1406         int ict_index;
1407         u32 inta;
1408         bool use_ict;
1409         /*
1410          * reporting the number of tids has AGG on. 0 means
1411          * no AGGREGATION
1412          */
1413         u8 agg_tids_count;
1414
1415         struct iwl_rx_phy_res last_phy_res;
1416         bool last_phy_res_valid;
1417
1418         struct completion firmware_loading_complete;
1419
1420         u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
1421         u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
1422
1423         /*
1424          * chain noise reset and gain commands are the
1425          * two extra calibration commands follows the standard
1426          * phy calibration commands
1427          */
1428         u8 phy_calib_chain_noise_reset_cmd;
1429         u8 phy_calib_chain_noise_gain_cmd;
1430
1431         /* counts reply_tx error */
1432         struct reply_tx_error_statistics reply_tx_stats;
1433         struct reply_agg_tx_error_statistics reply_agg_tx_stats;
1434         /* notification wait support */
1435         struct list_head notif_waits;
1436         spinlock_t notif_wait_lock;
1437         wait_queue_head_t notif_waitq;
1438
1439         /* remain-on-channel offload support */
1440         struct ieee80211_channel *hw_roc_channel;
1441         struct delayed_work hw_roc_work;
1442         enum nl80211_channel_type hw_roc_chantype;
1443         int hw_roc_duration;
1444         bool hw_roc_setup;
1445
1446         struct sk_buff *offchan_tx_skb;
1447         int offchan_tx_timeout;
1448         struct ieee80211_channel *offchan_tx_chan;
1449
1450         /* bt coex */
1451         u8 bt_enable_flag;
1452         u8 bt_status;
1453         u8 bt_traffic_load, last_bt_traffic_load;
1454         bool bt_ch_announce;
1455         bool bt_full_concurrent;
1456         bool bt_ant_couple_ok;
1457         __le32 kill_ack_mask;
1458         __le32 kill_cts_mask;
1459         __le16 bt_valid;
1460         u16 bt_on_thresh;
1461         u16 bt_duration;
1462         u16 dynamic_frag_thresh;
1463         u8 bt_ci_compliance;
1464         struct work_struct bt_traffic_change_work;
1465         bool bt_enable_pspoll;
1466         struct iwl_rxon_context *cur_rssi_ctx;
1467         bool bt_is_sco;
1468
1469         struct iwl_hw_params hw_params;
1470
1471         u32 inta_mask;
1472
1473         struct workqueue_struct *workqueue;
1474
1475         struct work_struct restart;
1476         struct work_struct scan_completed;
1477         struct work_struct rx_replenish;
1478         struct work_struct abort_scan;
1479
1480         struct work_struct beacon_update;
1481         struct iwl_rxon_context *beacon_ctx;
1482         struct sk_buff *beacon_skb;
1483         void *beacon_cmd;
1484
1485         struct work_struct tt_work;
1486         struct work_struct ct_enter;
1487         struct work_struct ct_exit;
1488         struct work_struct start_internal_scan;
1489         struct work_struct tx_flush;
1490         struct work_struct bt_full_concurrency;
1491         struct work_struct bt_runtime_config;
1492
1493         struct tasklet_struct irq_tasklet;
1494
1495         struct delayed_work scan_check;
1496
1497         /* TX Power */
1498         s8 tx_power_user_lmt;
1499         s8 tx_power_device_lmt;
1500         s8 tx_power_lmt_in_half_dbm; /* max tx power in half-dBm format */
1501         s8 tx_power_next;
1502
1503
1504 #ifdef CONFIG_IWLWIFI_DEBUG
1505         /* debugging info */
1506         u32 debug_level; /* per device debugging will override global
1507                             iwl_debug_level if set */
1508 #endif /* CONFIG_IWLWIFI_DEBUG */
1509 #ifdef CONFIG_IWLWIFI_DEBUGFS
1510         /* debugfs */
1511         u16 tx_traffic_idx;
1512         u16 rx_traffic_idx;
1513         u8 *tx_traffic;
1514         u8 *rx_traffic;
1515         struct dentry *debugfs_dir;
1516         u32 dbgfs_sram_offset, dbgfs_sram_len;
1517         bool disable_ht40;
1518         void *wowlan_sram;
1519 #endif /* CONFIG_IWLWIFI_DEBUGFS */
1520
1521         struct work_struct txpower_work;
1522         u32 disable_sens_cal;
1523         u32 disable_chain_noise_cal;
1524         struct work_struct run_time_calib_work;
1525         struct timer_list statistics_periodic;
1526         struct timer_list ucode_trace;
1527         struct timer_list watchdog;
1528
1529         struct iwl_event_log event_log;
1530
1531         struct led_classdev led;
1532         unsigned long blink_on, blink_off;
1533         bool led_registered;
1534 #ifdef CONFIG_IWLWIFI_DEVICE_SVTOOL
1535         struct iwl_testmode_trace testmode_trace;
1536         u32 tm_fixed_rate;
1537 #endif
1538
1539         /* WoWLAN GTK rekey data */
1540         u8 kck[NL80211_KCK_LEN], kek[NL80211_KEK_LEN];
1541         __le64 replay_ctr;
1542         __le16 last_seq_ctl;
1543         bool have_rekey_data;
1544 }; /*iwl_priv */
1545
1546 static inline void iwl_txq_ctx_activate(struct iwl_priv *priv, int txq_id)
1547 {
1548         set_bit(txq_id, &priv->txq_ctx_active_msk);
1549 }
1550
1551 static inline void iwl_txq_ctx_deactivate(struct iwl_priv *priv, int txq_id)
1552 {
1553         clear_bit(txq_id, &priv->txq_ctx_active_msk);
1554 }
1555
1556 #ifdef CONFIG_IWLWIFI_DEBUG
1557 /*
1558  * iwl_get_debug_level: Return active debug level for device
1559  *
1560  * Using sysfs it is possible to set per device debug level. This debug
1561  * level will be used if set, otherwise the global debug level which can be
1562  * set via module parameter is used.
1563  */
1564 static inline u32 iwl_get_debug_level(struct iwl_priv *priv)
1565 {
1566         if (priv->debug_level)
1567                 return priv->debug_level;
1568         else
1569                 return iwl_debug_level;
1570 }
1571 #else
1572 static inline u32 iwl_get_debug_level(struct iwl_priv *priv)
1573 {
1574         return iwl_debug_level;
1575 }
1576 #endif
1577
1578
1579 static inline struct ieee80211_hdr *iwl_tx_queue_get_hdr(struct iwl_priv *priv,
1580                                                          int txq_id, int idx)
1581 {
1582         if (priv->txq[txq_id].txb[idx].skb)
1583                 return (struct ieee80211_hdr *)priv->txq[txq_id].
1584                                 txb[idx].skb->data;
1585         return NULL;
1586 }
1587
1588 static inline struct iwl_rxon_context *
1589 iwl_rxon_ctx_from_vif(struct ieee80211_vif *vif)
1590 {
1591         struct iwl_vif_priv *vif_priv = (void *)vif->drv_priv;
1592
1593         return vif_priv->ctx;
1594 }
1595
1596 #define for_each_context(priv, ctx)                             \
1597         for (ctx = &priv->contexts[IWL_RXON_CTX_BSS];           \
1598              ctx < &priv->contexts[NUM_IWL_RXON_CTX]; ctx++)    \
1599                 if (priv->valid_contexts & BIT(ctx->ctxid))
1600
1601 static inline int iwl_is_associated_ctx(struct iwl_rxon_context *ctx)
1602 {
1603         return (ctx->active.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1604 }
1605
1606 static inline int iwl_is_associated(struct iwl_priv *priv,
1607                                     enum iwl_rxon_context_id ctxid)
1608 {
1609         return iwl_is_associated_ctx(&priv->contexts[ctxid]);
1610 }
1611
1612 static inline int iwl_is_any_associated(struct iwl_priv *priv)
1613 {
1614         struct iwl_rxon_context *ctx;
1615         for_each_context(priv, ctx)
1616                 if (iwl_is_associated_ctx(ctx))
1617                         return true;
1618         return false;
1619 }
1620
1621 static inline int is_channel_valid(const struct iwl_channel_info *ch_info)
1622 {
1623         if (ch_info == NULL)
1624                 return 0;
1625         return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1626 }
1627
1628 static inline int is_channel_radar(const struct iwl_channel_info *ch_info)
1629 {
1630         return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1631 }
1632
1633 static inline u8 is_channel_a_band(const struct iwl_channel_info *ch_info)
1634 {
1635         return ch_info->band == IEEE80211_BAND_5GHZ;
1636 }
1637
1638 static inline u8 is_channel_bg_band(const struct iwl_channel_info *ch_info)
1639 {
1640         return ch_info->band == IEEE80211_BAND_2GHZ;
1641 }
1642
1643 static inline int is_channel_passive(const struct iwl_channel_info *ch)
1644 {
1645         return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1646 }
1647
1648 static inline int is_channel_ibss(const struct iwl_channel_info *ch)
1649 {
1650         return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1651 }
1652
1653 static inline void __iwl_free_pages(struct iwl_priv *priv, struct page *page)
1654 {
1655         __free_pages(page, priv->hw_params.rx_page_order);
1656 }
1657
1658 static inline void iwl_free_pages(struct iwl_priv *priv, unsigned long page)
1659 {
1660         free_pages(page, priv->hw_params.rx_page_order);
1661 }
1662 #endif                          /* __iwl_dev_h__ */