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