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