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