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

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