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

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