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