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