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

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2003 - 2008 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 #define DRV_NAME        "iwlagn"
  40 #include "iwl-rfkill.h"
  41 #include "iwl-eeprom.h"
  42 #include "iwl-4965-hw.h"
  43 #include "iwl-csr.h"
  44 #include "iwl-prph.h"
  45 #include "iwl-debug.h"
  46 #include "iwl-led.h"
  47 #include "iwl-power.h"
  48 #include "iwl-agn-rs.h"
  49
  50 /* configuration for the iwl4965 */
  51 extern struct iwl_cfg iwl4965_agn_cfg;
  52 extern struct iwl_cfg iwl5300_agn_cfg;
  53 extern struct iwl_cfg iwl5100_agn_cfg;
  54 extern struct iwl_cfg iwl5350_agn_cfg;
  55 extern struct iwl_cfg iwl5100_bg_cfg;
  56 extern struct iwl_cfg iwl5100_abg_cfg;
  57 extern struct iwl_cfg iwl5150_agn_cfg;
  58
  59 /* CT-KILL constants */
  60 #define CT_KILL_THRESHOLD       110 /* in Celsius */
  61
  62 /* Default noise level to report when noise measurement is not available.
  63  *   This may be because we're:
  64  *   1)  Not associated (4965, no beacon statistics being sent to driver)
  65  *   2)  Scanning (noise measurement does not apply to associated channel)
  66  *   3)  Receiving CCK (3945 delivers noise info only for OFDM frames)
  67  * Use default noise value of -127 ... this is below the range of measurable
  68  *   Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
  69  *   Also, -127 works better than 0 when averaging frames with/without
  70  *   noise info (e.g. averaging might be done in app); measured dBm values are
  71  *   always negative ... using a negative value as the default keeps all
  72  *   averages within an s8's (used in some apps) range of negative values. */
  73 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
  74
  75 /*
  76  * RTS threshold here is total size [2347] minus 4 FCS bytes
  77  * Per spec:
  78  *   a value of 0 means RTS on all data/management packets
  79  *   a value > max MSDU size means no RTS
  80  * else RTS for data/management frames where MPDU is larger
  81  *   than RTS value.
  82  */
  83 #define DEFAULT_RTS_THRESHOLD     2347U
  84 #define MIN_RTS_THRESHOLD         0U
  85 #define MAX_RTS_THRESHOLD         2347U
  86 #define MAX_MSDU_SIZE             2304U
  87 #define MAX_MPDU_SIZE             2346U
  88 #define DEFAULT_BEACON_INTERVAL   100U
  89 #define DEFAULT_SHORT_RETRY_LIMIT 7U
  90 #define DEFAULT_LONG_RETRY_LIMIT  4U
  91
  92 struct iwl_rx_mem_buffer {
  93         dma_addr_t real_dma_addr;
  94         dma_addr_t aligned_dma_addr;
  95         struct sk_buff *skb;
  96         struct list_head list;
  97 };
  98
  99 /*
 100  * Generic queue structure
 101  *
 102  * Contains common data for Rx and Tx queues
 103  */
 104 struct iwl_queue {
 105         int n_bd;              /* number of BDs in this queue */
 106         int write_ptr;       /* 1-st empty entry (index) host_w*/
 107         int read_ptr;         /* last used entry (index) host_r*/
 108         dma_addr_t dma_addr;   /* physical addr for BD's */
 109         int n_window;          /* safe queue window */
 110         u32 id;
 111         int low_mark;          /* low watermark, resume queue if free
 112                                 * space more than this */
 113         int high_mark;         /* high watermark, stop queue if free
 114                                 * space less than this */
 115 } __attribute__ ((packed));
 116
 117 /* One for each TFD */
 118 struct iwl_tx_info {
 119         struct sk_buff *skb[IWL_NUM_OF_TBS - 1];
 120 };
 121
 122 /**
 123  * struct iwl_tx_queue - Tx Queue for DMA
 124  * @q: generic Rx/Tx queue descriptor
 125  * @bd: base of circular buffer of TFDs
 126  * @cmd: array of command/Tx buffers
 127  * @dma_addr_cmd: physical address of cmd/tx buffer array
 128  * @txb: array of per-TFD driver data
 129  * @need_update: indicates need to update read/write index
 130  * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
 131  *
 132  * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
 133  * descriptors) and required locking structures.
 134  */
 135 struct iwl_tx_queue {
 136         struct iwl_queue q;
 137         struct iwl_tfd *tfds;
 138         struct iwl_cmd *cmd[TFD_TX_CMD_SLOTS];
 139         struct iwl_tx_info *txb;
 140         u8 need_update;
 141         u8 sched_retry;
 142         u8 active;
 143         u8 swq_id;
 144 };
 145
 146 #define IWL_NUM_SCAN_RATES         (2)
 147
 148 struct iwl4965_channel_tgd_info {
 149         u8 type;
 150         s8 max_power;
 151 };
 152
 153 struct iwl4965_channel_tgh_info {
 154         s64 last_radar_time;
 155 };
 156
 157 /*
 158  * One for each channel, holds all channel setup data
 159  * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
 160  *     with one another!
 161  */
 162 struct iwl_channel_info {
 163         struct iwl4965_channel_tgd_info tgd;
 164         struct iwl4965_channel_tgh_info tgh;
 165         struct iwl_eeprom_channel eeprom;       /* EEPROM regulatory limit */
 166         struct iwl_eeprom_channel fat_eeprom;   /* EEPROM regulatory limit for
 167                                                  * FAT channel */
 168
 169         u8 channel;       /* channel number */
 170         u8 flags;         /* flags copied from EEPROM */
 171         s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
 172         s8 curr_txpow;    /* (dBm) regulatory/spectrum/user (not h/w) limit */
 173         s8 min_power;     /* always 0 */
 174         s8 scan_power;    /* (dBm) regul. eeprom, direct scans, any rate */
 175
 176         u8 group_index;   /* 0-4, maps channel to group1/2/3/4/5 */
 177         u8 band_index;    /* 0-4, maps channel to band1/2/3/4/5 */
 178         enum ieee80211_band band;
 179
 180         /* FAT channel info */
 181         s8 fat_max_power_avg;   /* (dBm) regul. eeprom, normal Tx, any rate */
 182         s8 fat_curr_txpow;      /* (dBm) regulatory/spectrum/user (not h/w) */
 183         s8 fat_min_power;       /* always 0 */
 184         s8 fat_scan_power;      /* (dBm) eeprom, direct scans, any rate */
 185         u8 fat_flags;           /* flags copied from EEPROM */
 186         u8 fat_extension_channel; /* HT_IE_EXT_CHANNEL_* */
 187 };
 188
 189
 190 #define IWL_TX_FIFO_AC0 0
 191 #define IWL_TX_FIFO_AC1 1
 192 #define IWL_TX_FIFO_AC2 2
 193 #define IWL_TX_FIFO_AC3 3
 194 #define IWL_TX_FIFO_HCCA_1      5
 195 #define IWL_TX_FIFO_HCCA_2      6
 196 #define IWL_TX_FIFO_NONE        7
 197
 198 /* Minimum number of queues. MAX_NUM is defined in hw specific files */
 199 #define IWL_MIN_NUM_QUEUES      4
 200
 201 /* Power management (not Tx power) structures */
 202
 203 enum iwl_pwr_src {
 204         IWL_PWR_SRC_VMAIN,
 205         IWL_PWR_SRC_VAUX,
 206 };
 207
 208 #define IEEE80211_DATA_LEN              2304
 209 #define IEEE80211_4ADDR_LEN             30
 210 #define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
 211 #define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
 212
 213 struct iwl_frame {
 214         union {
 215                 struct ieee80211_hdr frame;
 216                 struct iwl_tx_beacon_cmd beacon;
 217                 u8 raw[IEEE80211_FRAME_LEN];
 218                 u8 cmd[360];
 219         } u;
 220         struct list_head list;
 221 };
 222
 223 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
 224 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
 225 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
 226
 227 enum {
 228         /* CMD_SIZE_NORMAL = 0, */
 229         CMD_SIZE_HUGE = (1 << 0),
 230         /* CMD_SYNC = 0, */
 231         CMD_ASYNC = (1 << 1),
 232         /* CMD_NO_SKB = 0, */
 233         CMD_WANT_SKB = (1 << 2),
 234 };
 235
 236 struct iwl_cmd;
 237 struct iwl_priv;
 238
 239 struct iwl_cmd_meta {
 240         struct iwl_cmd_meta *source;
 241         union {
 242                 struct sk_buff *skb;
 243                 int (*callback)(struct iwl_priv *priv,
 244                                 struct iwl_cmd *cmd, struct sk_buff *skb);
 245         } __attribute__ ((packed)) u;
 246
 247         /* The CMD_SIZE_HUGE flag bit indicates that the command
 248          * structure is stored at the end of the shared queue memory. */
 249         u32 flags;
 250         DECLARE_PCI_UNMAP_ADDR(mapping)
 251         DECLARE_PCI_UNMAP_LEN(len)
 252 } __attribute__ ((packed));
 253
 254 #define IWL_CMD_MAX_PAYLOAD 320
 255
 256 /**
 257  * struct iwl_cmd
 258  *
 259  * For allocation of the command and tx queues, this establishes the overall
 260  * size of the largest command we send to uCode, except for a scan command
 261  * (which is relatively huge; space is allocated separately).
 262  */
 263 struct iwl_cmd {
 264         struct iwl_cmd_meta meta;       /* driver data */
 265         struct iwl_cmd_header hdr;      /* uCode API */
 266         union {
 267                 u32 flags;
 268                 u8 val8;
 269                 u16 val16;
 270                 u32 val32;
 271                 struct iwl_tx_cmd tx;
 272                 u8 payload[IWL_CMD_MAX_PAYLOAD];
 273         } __attribute__ ((packed)) cmd;
 274 } __attribute__ ((packed));
 275
 276
 277 struct iwl_host_cmd {
 278         u8 id;
 279         u16 len;
 280         struct iwl_cmd_meta meta;
 281         const void *data;
 282 };
 283
 284 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct iwl_cmd) - \
 285                               sizeof(struct iwl_cmd_meta))
 286
 287 /*
 288  * RX related structures and functions
 289  */
 290 #define RX_FREE_BUFFERS 64
 291 #define RX_LOW_WATERMARK 8
 292
 293 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
 294 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
 295 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
 296
 297 /**
 298  * struct iwl_rx_queue - Rx queue
 299  * @read: Shared index to newest available Rx buffer
 300  * @write: Shared index to oldest written Rx packet
 301  * @free_count: Number of pre-allocated buffers in rx_free
 302  * @rx_free: list of free SKBs for use
 303  * @rx_used: List of Rx buffers with no SKB
 304  * @need_update: flag to indicate we need to update read/write index
 305  *
 306  * NOTE:  rx_free and rx_used are used as a FIFO for iwl_rx_mem_buffers
 307  */
 308 struct iwl_rx_queue {
 309         __le32 *bd;
 310         dma_addr_t dma_addr;
 311         struct iwl_rx_mem_buffer pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
 312         struct iwl_rx_mem_buffer *queue[RX_QUEUE_SIZE];
 313         u32 read;
 314         u32 write;
 315         u32 free_count;
 316         struct list_head rx_free;
 317         struct list_head rx_used;
 318         int need_update;
 319         struct iwl_rb_status *rb_stts;
 320         dma_addr_t rb_stts_dma;
 321         spinlock_t lock;
 322 };
 323
 324 #define IWL_SUPPORTED_RATES_IE_LEN         8
 325
 326 #define MAX_TID_COUNT        9
 327
 328 #define IWL_INVALID_RATE     0xFF
 329 #define IWL_INVALID_VALUE    -1
 330
 331 /**
 332  * struct iwl_ht_agg -- aggregation status while waiting for block-ack
 333  * @txq_id: Tx queue used for Tx attempt
 334  * @frame_count: # frames attempted by Tx command
 335  * @wait_for_ba: Expect block-ack before next Tx reply
 336  * @start_idx: Index of 1st Transmit Frame Descriptor (TFD) in Tx window
 337  * @bitmap0: Low order bitmap, one bit for each frame pending ACK in Tx window
 338  * @bitmap1: High order, one bit for each frame pending ACK in Tx window
 339  * @rate_n_flags: Rate at which Tx was attempted
 340  *
 341  * If REPLY_TX indicates that aggregation was attempted, driver must wait
 342  * for block ack (REPLY_COMPRESSED_BA).  This struct stores tx reply info
 343  * until block ack arrives.
 344  */
 345 struct iwl_ht_agg {
 346         u16 txq_id;
 347         u16 frame_count;
 348         u16 wait_for_ba;
 349         u16 start_idx;
 350         u64 bitmap;
 351         u32 rate_n_flags;
 352 #define IWL_AGG_OFF 0
 353 #define IWL_AGG_ON 1
 354 #define IWL_EMPTYING_HW_QUEUE_ADDBA 2
 355 #define IWL_EMPTYING_HW_QUEUE_DELBA 3
 356         u8 state;
 357 };
 358
 359
 360 struct iwl_tid_data {
 361         u16 seq_number;
 362         u16 tfds_in_queue;
 363         struct iwl_ht_agg agg;
 364 };
 365
 366 struct iwl_hw_key {
 367         enum ieee80211_key_alg alg;
 368         int keylen;
 369         u8 keyidx;
 370         u8 key[32];
 371 };
 372
 373 union iwl4965_ht_rate_supp {
 374         u16 rates;
 375         struct {
 376                 u8 siso_rate;
 377                 u8 mimo_rate;
 378         };
 379 };
 380
 381 #define CFG_HT_RX_AMPDU_FACTOR_DEF  (0x3)
 382 #define CFG_HT_MPDU_DENSITY_2USEC   (0x5)
 383 #define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_2USEC
 384
 385 struct iwl_ht_info {
 386         /* self configuration data */
 387         u8 is_ht;
 388         u8 supported_chan_width;
 389         u8 sm_ps;
 390         u8 is_green_field;
 391         u8 sgf;                 /* HT_SHORT_GI_* short guard interval */
 392         u8 max_amsdu_size;
 393         u8 ampdu_factor;
 394         u8 mpdu_density;
 395         struct ieee80211_mcs_info mcs;
 396         /* BSS related data */
 397         u8 extension_chan_offset;
 398         u8 tx_chan_width;
 399         u8 ht_protection;
 400         u8 non_GF_STA_present;
 401 };
 402
 403 union iwl_qos_capabity {
 404         struct {
 405                 u8 edca_count:4;        /* bit 0-3 */
 406                 u8 q_ack:1;             /* bit 4 */
 407                 u8 queue_request:1;     /* bit 5 */
 408                 u8 txop_request:1;      /* bit 6 */
 409                 u8 reserved:1;          /* bit 7 */
 410         } q_AP;
 411         struct {
 412                 u8 acvo_APSD:1;         /* bit 0 */
 413                 u8 acvi_APSD:1;         /* bit 1 */
 414                 u8 ac_bk_APSD:1;        /* bit 2 */
 415                 u8 ac_be_APSD:1;        /* bit 3 */
 416                 u8 q_ack:1;             /* bit 4 */
 417                 u8 max_len:2;           /* bit 5-6 */
 418                 u8 more_data_ack:1;     /* bit 7 */
 419         } q_STA;
 420         u8 val;
 421 };
 422
 423 /* QoS structures */
 424 struct iwl_qos_info {
 425         int qos_active;
 426         union iwl_qos_capabity qos_cap;
 427         struct iwl_qosparam_cmd def_qos_parm;
 428 };
 429
 430 #define STA_PS_STATUS_WAKE             0
 431 #define STA_PS_STATUS_SLEEP            1
 432
 433 struct iwl_station_entry {
 434         struct iwl_addsta_cmd sta;
 435         struct iwl_tid_data tid[MAX_TID_COUNT];
 436         u8 used;
 437         u8 ps_status;
 438         struct iwl_hw_key keyinfo;
 439 };
 440
 441 /* one for each uCode image (inst/data, boot/init/runtime) */
 442 struct fw_desc {
 443         void *v_addr;           /* access by driver */
 444         dma_addr_t p_addr;      /* access by card's busmaster DMA */
 445         u32 len;                /* bytes */
 446 };
 447
 448 /* uCode file layout */
 449 struct iwl_ucode {
 450         __le32 ver;             /* major/minor/API/serial */
 451         __le32 inst_size;       /* bytes of runtime instructions */
 452         __le32 data_size;       /* bytes of runtime data */
 453         __le32 init_size;       /* bytes of initialization instructions */
 454         __le32 init_data_size;  /* bytes of initialization data */
 455         __le32 boot_size;       /* bytes of bootstrap instructions */
 456         u8 data[0];             /* data in same order as "size" elements */
 457 };
 458
 459 struct iwl4965_ibss_seq {
 460         u8 mac[ETH_ALEN];
 461         u16 seq_num;
 462         u16 frag_num;
 463         unsigned long packet_time;
 464         struct list_head list;
 465 };
 466
 467 struct iwl_sensitivity_ranges {
 468         u16 min_nrg_cck;
 469         u16 max_nrg_cck;
 470
 471         u16 nrg_th_cck;
 472         u16 nrg_th_ofdm;
 473
 474         u16 auto_corr_min_ofdm;
 475         u16 auto_corr_min_ofdm_mrc;
 476         u16 auto_corr_min_ofdm_x1;
 477         u16 auto_corr_min_ofdm_mrc_x1;
 478
 479         u16 auto_corr_max_ofdm;
 480         u16 auto_corr_max_ofdm_mrc;
 481         u16 auto_corr_max_ofdm_x1;
 482         u16 auto_corr_max_ofdm_mrc_x1;
 483
 484         u16 auto_corr_max_cck;
 485         u16 auto_corr_max_cck_mrc;
 486         u16 auto_corr_min_cck;
 487         u16 auto_corr_min_cck_mrc;
 488 };
 489
 490
 491 #define KELVIN_TO_CELSIUS(x) ((x)-273)
 492 #define CELSIUS_TO_KELVIN(x) ((x)+273)
 493
 494
 495 /**
 496  * struct iwl_hw_params
 497  * @max_txq_num: Max # Tx queues supported
 498  * @dma_chnl_num: Number of Tx DMA/FIFO channels
 499  * @scd_bc_tbls_size: size of scheduler byte count tables
 500  * @tx/rx_chains_num: Number of TX/RX chains
 501  * @valid_tx/rx_ant: usable antennas
 502  * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
 503  * @max_rxq_log: Log-base-2 of max_rxq_size
 504  * @rx_buf_size: Rx buffer size
 505  * @max_stations:
 506  * @bcast_sta_id:
 507  * @fat_channel: is 40MHz width possible in band 2.4
 508  * BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ)
 509  * @sw_crypto: 0 for hw, 1 for sw
 510  * @max_xxx_size: for ucode uses
 511  * @ct_kill_threshold: temperature threshold
 512  * @calib_init_cfg: setup initial calibrations for the hw
 513  * @struct iwl_sensitivity_ranges: range of sensitivity values
 514  */
 515 struct iwl_hw_params {
 516         u8 max_txq_num;
 517         u8 dma_chnl_num;
 518         u16 scd_bc_tbls_size;
 519         u8  tx_chains_num;
 520         u8  rx_chains_num;
 521         u8  valid_tx_ant;
 522         u8  valid_rx_ant;
 523         u16 max_rxq_size;
 524         u16 max_rxq_log;
 525         u32 rx_buf_size;
 526         u32 max_pkt_size;
 527         u8  max_stations;
 528         u8  bcast_sta_id;
 529         u8 fat_channel;
 530         u8 sw_crypto;
 531         u32 max_inst_size;
 532         u32 max_data_size;
 533         u32 max_bsm_size;
 534         u32 ct_kill_threshold; /* value in hw-dependent units */
 535         u32 calib_init_cfg;
 536         const struct iwl_sensitivity_ranges *sens;
 537 };
 538
 539
 540 /******************************************************************************
 541  *
 542  * Functions implemented in core module which are forward declared here
 543  * for use by iwl-[4-5].c
 544  *
 545  * NOTE:  The implementation of these functions are not hardware specific
 546  * which is why they are in the core module files.
 547  *
 548  * Naming convention --
 549  * iwl_         <-- Is part of iwlwifi
 550  * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
 551  * iwl4965_bg_      <-- Called from work queue context
 552  * iwl4965_mac_     <-- mac80211 callback
 553  *
 554  ****************************************************************************/
 555 extern void iwl_update_chain_flags(struct iwl_priv *priv);
 556 extern int iwl_set_pwr_src(struct iwl_priv *priv, enum iwl_pwr_src src);
 557 extern const u8 iwl_bcast_addr[ETH_ALEN];
 558 extern int iwl_rxq_stop(struct iwl_priv *priv);
 559 extern void iwl_txq_ctx_stop(struct iwl_priv *priv);
 560 extern int iwl_queue_space(const struct iwl_queue *q);
 561 static inline int iwl_queue_used(const struct iwl_queue *q, int i)
 562 {
 563         return q->write_ptr > q->read_ptr ?
 564                 (i >= q->read_ptr && i < q->write_ptr) :
 565                 !(i < q->read_ptr && i >= q->write_ptr);
 566 }
 567
 568
 569 static inline u8 get_cmd_index(struct iwl_queue *q, u32 index, int is_huge)
 570 {
 571         /* This is for scan command, the big buffer at end of command array */
 572         if (is_huge)
 573                 return q->n_window;     /* must be power of 2 */
 574
 575         /* Otherwise, use normal size buffers */
 576         return index & (q->n_window - 1);
 577 }
 578
 579
 580 struct iwl_dma_ptr {
 581         dma_addr_t dma;
 582         void *addr;
 583         size_t size;
 584 };
 585
 586 #define HT_SHORT_GI_20MHZ       (1 << 0)
 587 #define HT_SHORT_GI_40MHZ       (1 << 1)
 588
 589 #define IWL_CHANNEL_WIDTH_20MHZ   0
 590 #define IWL_CHANNEL_WIDTH_40MHZ   1
 591
 592 #define IWL_OPERATION_MODE_AUTO     0
 593 #define IWL_OPERATION_MODE_HT_ONLY  1
 594 #define IWL_OPERATION_MODE_MIXED    2
 595 #define IWL_OPERATION_MODE_20MHZ    3
 596
 597 #define IWL_TX_CRC_SIZE 4
 598 #define IWL_TX_DELIMITER_SIZE 4
 599
 600 #define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000
 601
 602 /* Sensitivity and chain noise calibration */
 603 #define INITIALIZATION_VALUE            0xFFFF
 604 #define CAL_NUM_OF_BEACONS              20
 605 #define MAXIMUM_ALLOWED_PATHLOSS        15
 606
 607 #define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
 608
 609 #define MAX_FA_OFDM  50
 610 #define MIN_FA_OFDM  5
 611 #define MAX_FA_CCK   50
 612 #define MIN_FA_CCK   5
 613
 614 #define AUTO_CORR_STEP_OFDM       1
 615
 616 #define AUTO_CORR_STEP_CCK     3
 617 #define AUTO_CORR_MAX_TH_CCK   160
 618
 619 #define NRG_DIFF               2
 620 #define NRG_STEP_CCK           2
 621 #define NRG_MARGIN             8
 622 #define MAX_NUMBER_CCK_NO_FA 100
 623
 624 #define AUTO_CORR_CCK_MIN_VAL_DEF    (125)
 625
 626 #define CHAIN_A             0
 627 #define CHAIN_B             1
 628 #define CHAIN_C             2
 629 #define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
 630 #define ALL_BAND_FILTER                 0xFF00
 631 #define IN_BAND_FILTER                  0xFF
 632 #define MIN_AVERAGE_NOISE_MAX_VALUE     0xFFFFFFFF
 633
 634 #define NRG_NUM_PREV_STAT_L     20
 635 #define NUM_RX_CHAINS           3
 636
 637 enum iwl4965_false_alarm_state {
 638         IWL_FA_TOO_MANY = 0,
 639         IWL_FA_TOO_FEW = 1,
 640         IWL_FA_GOOD_RANGE = 2,
 641 };
 642
 643 enum iwl4965_chain_noise_state {
 644         IWL_CHAIN_NOISE_ALIVE = 0,  /* must be 0 */
 645         IWL_CHAIN_NOISE_ACCUMULATE,
 646         IWL_CHAIN_NOISE_CALIBRATED,
 647         IWL_CHAIN_NOISE_DONE,
 648 };
 649
 650 enum iwl4965_calib_enabled_state {
 651         IWL_CALIB_DISABLED = 0,  /* must be 0 */
 652         IWL_CALIB_ENABLED = 1,
 653 };
 654
 655
 656 /*
 657  * enum iwl_calib
 658  * defines the order in which results of initial calibrations
 659  * should be sent to the runtime uCode
 660  */
 661 enum iwl_calib {
 662         IWL_CALIB_XTAL,
 663         IWL_CALIB_DC,
 664         IWL_CALIB_LO,
 665         IWL_CALIB_TX_IQ,
 666         IWL_CALIB_TX_IQ_PERD,
 667         IWL_CALIB_BASE_BAND,
 668         IWL_CALIB_MAX
 669 };
 670
 671 /* Opaque calibration results */
 672 struct iwl_calib_result {
 673         void *buf;
 674         size_t buf_len;
 675 };
 676
 677 enum ucode_type {
 678         UCODE_NONE = 0,
 679         UCODE_INIT,
 680         UCODE_RT
 681 };
 682
 683 /* Sensitivity calib data */
 684 struct iwl_sensitivity_data {
 685         u32 auto_corr_ofdm;
 686         u32 auto_corr_ofdm_mrc;
 687         u32 auto_corr_ofdm_x1;
 688         u32 auto_corr_ofdm_mrc_x1;
 689         u32 auto_corr_cck;
 690         u32 auto_corr_cck_mrc;
 691
 692         u32 last_bad_plcp_cnt_ofdm;
 693         u32 last_fa_cnt_ofdm;
 694         u32 last_bad_plcp_cnt_cck;
 695         u32 last_fa_cnt_cck;
 696
 697         u32 nrg_curr_state;
 698         u32 nrg_prev_state;
 699         u32 nrg_value[10];
 700         u8  nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
 701         u32 nrg_silence_ref;
 702         u32 nrg_energy_idx;
 703         u32 nrg_silence_idx;
 704         u32 nrg_th_cck;
 705         s32 nrg_auto_corr_silence_diff;
 706         u32 num_in_cck_no_fa;
 707         u32 nrg_th_ofdm;
 708 };
 709
 710 /* Chain noise (differential Rx gain) calib data */
 711 struct iwl_chain_noise_data {
 712         u32 active_chains;
 713         u32 chain_noise_a;
 714         u32 chain_noise_b;
 715         u32 chain_noise_c;
 716         u32 chain_signal_a;
 717         u32 chain_signal_b;
 718         u32 chain_signal_c;
 719         u16 beacon_count;
 720         u8 disconn_array[NUM_RX_CHAINS];
 721         u8 delta_gain_code[NUM_RX_CHAINS];
 722         u8 radio_write;
 723         u8 state;
 724 };
 725
 726 #define EEPROM_SEM_TIMEOUT 10           /* milliseconds */
 727 #define EEPROM_SEM_RETRY_LIMIT 1000     /* number of attempts (not time) */
 728
 729
 730 enum {
 731         MEASUREMENT_READY = (1 << 0),
 732         MEASUREMENT_ACTIVE = (1 << 1),
 733 };
 734
 735
 736 #define IWL_MAX_NUM_QUEUES      20 /* FIXME: do dynamic allocation */
 737
 738 struct iwl_priv {
 739
 740         /* ieee device used by generic ieee processing code */
 741         struct ieee80211_hw *hw;
 742         struct ieee80211_channel *ieee_channels;
 743         struct ieee80211_rate *ieee_rates;
 744         struct iwl_cfg *cfg;
 745
 746         /* temporary frame storage list */
 747         struct list_head free_frames;
 748         int frames_count;
 749
 750         enum ieee80211_band band;
 751         int alloc_rxb_skb;
 752
 753         void (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
 754                                        struct iwl_rx_mem_buffer *rxb);
 755
 756         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
 757
 758 #ifdef CONFIG_IWLAGN_SPECTRUM_MEASUREMENT
 759         /* spectrum measurement report caching */
 760         struct iwl_spectrum_notification measure_report;
 761         u8 measurement_status;
 762 #endif
 763         /* ucode beacon time */
 764         u32 ucode_beacon_time;
 765
 766         /* we allocate array of iwl4965_channel_info for NIC's valid channels.
 767          *    Access via channel # using indirect index array */
 768         struct iwl_channel_info *channel_info;  /* channel info array */
 769         u8 channel_count;       /* # of channels */
 770
 771         /* thermal calibration */
 772         s32 temperature;        /* degrees Kelvin */
 773         s32 last_temperature;
 774
 775         /* init calibration results */
 776         struct iwl_calib_result calib_results[IWL_CALIB_MAX];
 777
 778         /* Scan related variables */
 779         unsigned long last_scan_jiffies;
 780         unsigned long next_scan_jiffies;
 781         unsigned long scan_start;
 782         unsigned long scan_pass_start;
 783         unsigned long scan_start_tsf;
 784         struct iwl_scan_cmd *scan;
 785         int scan_bands;
 786         int one_direct_scan;
 787         u8 direct_ssid_len;
 788         u8 direct_ssid[IW_ESSID_MAX_SIZE];
 789         u8 scan_tx_ant[IEEE80211_NUM_BANDS];
 790         u8 mgmt_tx_ant;
 791
 792         /* spinlock */
 793         spinlock_t lock;        /* protect general shared data */
 794         spinlock_t hcmd_lock;   /* protect hcmd */
 795         struct mutex mutex;
 796
 797         /* basic pci-network driver stuff */
 798         struct pci_dev *pci_dev;
 799
 800         /* pci hardware address support */
 801         void __iomem *hw_base;
 802         u32  hw_rev;
 803         u32  hw_wa_rev;
 804         u8   rev_id;
 805
 806         /* uCode images, save to reload in case of failure */
 807         u32 ucode_ver;                  /* version of ucode, copy of
 808                                            iwl_ucode.ver */
 809         struct fw_desc ucode_code;      /* runtime inst */
 810         struct fw_desc ucode_data;      /* runtime data original */
 811         struct fw_desc ucode_data_backup;       /* runtime data save/restore */
 812         struct fw_desc ucode_init;      /* initialization inst */
 813         struct fw_desc ucode_init_data; /* initialization data */
 814         struct fw_desc ucode_boot;      /* bootstrap inst */
 815         enum ucode_type ucode_type;
 816         u8 ucode_write_complete;        /* the image write is complete */
 817
 818
 819         struct iwl_rxon_time_cmd rxon_timing;
 820
 821         /* We declare this const so it can only be
 822          * changed via explicit cast within the
 823          * routines that actually update the physical
 824          * hardware */
 825         const struct iwl_rxon_cmd active_rxon;
 826         struct iwl_rxon_cmd staging_rxon;
 827
 828         int error_recovering;
 829         struct iwl_rxon_cmd recovery_rxon;
 830
 831         /* 1st responses from initialize and runtime uCode images.
 832          * 4965's initialize alive response contains some calibration data. */
 833         struct iwl_init_alive_resp card_alive_init;
 834         struct iwl_alive_resp card_alive;
 835 #ifdef CONFIG_IWLWIFI_RFKILL
 836         struct rfkill *rfkill;
 837 #endif
 838
 839 #ifdef CONFIG_IWLWIFI_LEDS
 840         struct iwl_led led[IWL_LED_TRG_MAX];
 841         unsigned long last_blink_time;
 842         u8 last_blink_rate;
 843         u8 allow_blinking;
 844         u64 led_tpt;
 845 #endif
 846
 847         u16 active_rate;
 848         u16 active_rate_basic;
 849
 850         u8 assoc_station_added;
 851         u8 start_calib;
 852         struct iwl_sensitivity_data sensitivity_data;
 853         struct iwl_chain_noise_data chain_noise_data;
 854         __le16 sensitivity_tbl[HD_TABLE_SIZE];
 855
 856         struct iwl_ht_info current_ht_config;
 857         u8 last_phy_res[100];
 858
 859         /* Rate scaling data */
 860         s8 data_retry_limit;
 861         u8 retry_rate;
 862
 863         wait_queue_head_t wait_command_queue;
 864
 865         int activity_timer_active;
 866
 867         /* Rx and Tx DMA processing queues */
 868         struct iwl_rx_queue rxq;
 869         struct iwl_tx_queue txq[IWL_MAX_NUM_QUEUES];
 870         unsigned long txq_ctx_active_msk;
 871         struct iwl_dma_ptr  kw; /* keep warm address */
 872         struct iwl_dma_ptr  scd_bc_tbls;
 873
 874         u32 scd_base_addr;      /* scheduler sram base address */
 875
 876         unsigned long status;
 877
 878         int last_rx_rssi;       /* From Rx packet statistics */
 879         int last_rx_noise;      /* From beacon statistics */
 880
 881         /* counts mgmt, ctl, and data packets */
 882         struct traffic_stats {
 883                 u32 cnt;
 884                 u64 bytes;
 885         } tx_stats[3], rx_stats[3];
 886
 887         struct iwl_power_mgr power_data;
 888
 889         struct iwl_notif_statistics statistics;
 890         unsigned long last_statistics_time;
 891
 892         /* context information */
 893         u16 rates_mask;
 894
 895         u32 power_mode;
 896         u32 antenna;
 897         u8 bssid[ETH_ALEN];
 898         u16 rts_threshold;
 899         u8 mac_addr[ETH_ALEN];
 900
 901         /*station table variables */
 902         spinlock_t sta_lock;
 903         int num_stations;
 904         struct iwl_station_entry stations[IWL_STATION_COUNT];
 905         struct iwl_wep_key wep_keys[WEP_KEYS_MAX];
 906         u8 default_wep_key;
 907         u8 key_mapping_key;
 908         unsigned long ucode_key_table;
 909
 910         /* Indication if ieee80211_ops->open has been called */
 911         u8 is_open;
 912
 913         u8 mac80211_registered;
 914
 915         /* Rx'd packet timing information */
 916         u32 last_beacon_time;
 917         u64 last_tsf;
 918
 919         /* eeprom */
 920         u8 *eeprom;
 921         struct iwl_eeprom_calib_info *calib_info;
 922
 923         enum nl80211_iftype iw_mode;
 924
 925         struct sk_buff *ibss_beacon;
 926
 927         /* Last Rx'd beacon timestamp */
 928         u64 timestamp;
 929         u16 beacon_int;
 930         struct ieee80211_vif *vif;
 931
 932         struct iwl_hw_params hw_params;
 933
 934
 935         /* Current association information needed to configure the
 936          * hardware */
 937         u16 assoc_id;
 938         u16 assoc_capability;
 939
 940         struct iwl_qos_info qos_data;
 941
 942         struct workqueue_struct *workqueue;
 943
 944         struct work_struct up;
 945         struct work_struct restart;
 946         struct work_struct calibrated_work;
 947         struct work_struct scan_completed;
 948         struct work_struct rx_replenish;
 949         struct work_struct rf_kill;
 950         struct work_struct abort_scan;
 951         struct work_struct update_link_led;
 952         struct work_struct auth_work;
 953         struct work_struct report_work;
 954         struct work_struct request_scan;
 955         struct work_struct beacon_update;
 956
 957         struct tasklet_struct irq_tasklet;
 958
 959         struct delayed_work set_power_save;
 960         struct delayed_work init_alive_start;
 961         struct delayed_work alive_start;
 962         struct delayed_work scan_check;
 963         /* TX Power */
 964         s8 tx_power_user_lmt;
 965         s8 tx_power_channel_lmt;
 966
 967
 968 #ifdef CONFIG_IWLWIFI_DEBUG
 969         /* debugging info */
 970         u32 debug_level;
 971         u32 framecnt_to_us;
 972         atomic_t restrict_refcnt;
 973 #ifdef CONFIG_IWLWIFI_DEBUGFS
 974         /* debugfs */
 975         struct iwl_debugfs *dbgfs;
 976 #endif /* CONFIG_IWLWIFI_DEBUGFS */
 977 #endif /* CONFIG_IWLWIFI_DEBUG */
 978
 979         struct work_struct txpower_work;
 980         u32 disable_sens_cal;
 981         u32 disable_chain_noise_cal;
 982         u32 disable_tx_power_cal;
 983         struct work_struct run_time_calib_work;
 984         struct timer_list statistics_periodic;
 985 }; /*iwl_priv */
 986
 987 static inline void iwl_txq_ctx_activate(struct iwl_priv *priv, int txq_id)
 988 {
 989         set_bit(txq_id, &priv->txq_ctx_active_msk);
 990 }
 991
 992 static inline void iwl_txq_ctx_deactivate(struct iwl_priv *priv, int txq_id)
 993 {
 994         clear_bit(txq_id, &priv->txq_ctx_active_msk);
 995 }
 996
 997 #ifdef CONFIG_IWLWIFI_DEBUG
 998 const char *iwl_get_tx_fail_reason(u32 status);
 999 #else
1000 static inline const char *iwl_get_tx_fail_reason(u32 status) { return ""; }
1001 #endif
1002
1003
1004 static inline struct ieee80211_hdr *iwl_tx_queue_get_hdr(struct iwl_priv *priv,
1005                                                          int txq_id, int idx)
1006 {
1007         if (priv->txq[txq_id].txb[idx].skb[0])
1008                 return (struct ieee80211_hdr *)priv->txq[txq_id].
1009                                 txb[idx].skb[0]->data;
1010         return NULL;
1011 }
1012
1013
1014 static inline int iwl_is_associated(struct iwl_priv *priv)
1015 {
1016         return (priv->active_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1017 }
1018
1019 static inline int is_channel_valid(const struct iwl_channel_info *ch_info)
1020 {
1021         if (ch_info == NULL)
1022                 return 0;
1023         return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1024 }
1025
1026 static inline int is_channel_radar(const struct iwl_channel_info *ch_info)
1027 {
1028         return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1029 }
1030
1031 static inline u8 is_channel_a_band(const struct iwl_channel_info *ch_info)
1032 {
1033         return ch_info->band == IEEE80211_BAND_5GHZ;
1034 }
1035
1036 static inline u8 is_channel_bg_band(const struct iwl_channel_info *ch_info)
1037 {
1038         return ch_info->band == IEEE80211_BAND_2GHZ;
1039 }
1040
1041 static inline int is_channel_passive(const struct iwl_channel_info *ch)
1042 {
1043         return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1044 }
1045
1046 static inline int is_channel_ibss(const struct iwl_channel_info *ch)
1047 {
1048         return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1049 }
1050
1051 #endif                          /* __iwl_dev_h__ */