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