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