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