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