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