git.oblomov.eu Git - linux-2.6/blob - drivers/net/wireless/iwlwifi/iwl-dev.h

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