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