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