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

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