drivers/net/wireless/iwlegacy/common.h

   1 /******************************************************************************
   2  *
   3  * Copyright(c) 2003 - 2011 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  *  Intel Linux Wireless <ilw@linux.intel.com>
  23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  24  *
  25  *****************************************************************************/
  26 #ifndef __il_core_h__
  27 #define __il_core_h__
  28
  29 #include <linux/interrupt.h>
  30 #include <linux/pci.h>          /* for struct pci_device_id */
  31 #include <linux/kernel.h>
  32 #include <linux/leds.h>
  33 #include <linux/wait.h>
  34 #include <linux/io.h>
  35 #include <net/mac80211.h>
  36 #include <net/ieee80211_radiotap.h>
  37
  38 #include "commands.h"
  39 #include "csr.h"
  40 #include "prph.h"
  41
  42 struct il_host_cmd;
  43 struct il_cmd;
  44 struct il_tx_queue;
  45
  46 #define IL_ERR(f, a...) dev_err(&il->pci_dev->dev, f, ## a)
  47 #define IL_WARN(f, a...) dev_warn(&il->pci_dev->dev, f, ## a)
  48 #define IL_INFO(f, a...) dev_info(&il->pci_dev->dev, f, ## a)
  49
  50 #define RX_QUEUE_SIZE                         256
  51 #define RX_QUEUE_MASK                         255
  52 #define RX_QUEUE_SIZE_LOG                     8
  53
  54 /*
  55  * RX related structures and functions
  56  */
  57 #define RX_FREE_BUFFERS 64
  58 #define RX_LOW_WATERMARK 8
  59
  60 #define U32_PAD(n)              ((4-(n))&0x3)
  61
  62 /* CT-KILL constants */
  63 #define CT_KILL_THRESHOLD_LEGACY   110  /* in Celsius */
  64
  65 /* Default noise level to report when noise measurement is not available.
  66  *   This may be because we're:
  67  *   1)  Not associated (4965, no beacon stats being sent to driver)
  68  *   2)  Scanning (noise measurement does not apply to associated channel)
  69  *   3)  Receiving CCK (3945 delivers noise info only for OFDM frames)
  70  * Use default noise value of -127 ... this is below the range of measurable
  71  *   Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
  72  *   Also, -127 works better than 0 when averaging frames with/without
  73  *   noise info (e.g. averaging might be done in app); measured dBm values are
  74  *   always negative ... using a negative value as the default keeps all
  75  *   averages within an s8's (used in some apps) range of negative values. */
  76 #define IL_NOISE_MEAS_NOT_AVAILABLE (-127)
  77
  78 /*
  79  * RTS threshold here is total size [2347] minus 4 FCS bytes
  80  * Per spec:
  81  *   a value of 0 means RTS on all data/management packets
  82  *   a value > max MSDU size means no RTS
  83  * else RTS for data/management frames where MPDU is larger
  84  *   than RTS value.
  85  */
  86 #define DEFAULT_RTS_THRESHOLD     2347U
  87 #define MIN_RTS_THRESHOLD         0U
  88 #define MAX_RTS_THRESHOLD         2347U
  89 #define MAX_MSDU_SIZE             2304U
  90 #define MAX_MPDU_SIZE             2346U
  91 #define DEFAULT_BEACON_INTERVAL   100U
  92 #define DEFAULT_SHORT_RETRY_LIMIT 7U
  93 #define DEFAULT_LONG_RETRY_LIMIT  4U
  94
  95 struct il_rx_buf {
  96         dma_addr_t page_dma;
  97         struct page *page;
  98         struct list_head list;
  99 };
 100
 101 #define rxb_addr(r) page_address(r->page)
 102
 103 /* defined below */
 104 struct il_device_cmd;
 105
 106 struct il_cmd_meta {
 107         /* only for SYNC commands, iff the reply skb is wanted */
 108         struct il_host_cmd *source;
 109         /*
 110          * only for ASYNC commands
 111          * (which is somewhat stupid -- look at common.c for instance
 112          * which duplicates a bunch of code because the callback isn't
 113          * invoked for SYNC commands, if it were and its result passed
 114          * through it would be simpler...)
 115          */
 116         void (*callback) (struct il_priv *il, struct il_device_cmd *cmd,
 117                           struct il_rx_pkt *pkt);
 118
 119         /* The CMD_SIZE_HUGE flag bit indicates that the command
 120          * structure is stored at the end of the shared queue memory. */
 121         u32 flags;
 122
 123          DEFINE_DMA_UNMAP_ADDR(mapping);
 124          DEFINE_DMA_UNMAP_LEN(len);
 125 };
 126
 127 /*
 128  * Generic queue structure
 129  *
 130  * Contains common data for Rx and Tx queues
 131  */
 132 struct il_queue {
 133         int n_bd;               /* number of BDs in this queue */
 134         int write_ptr;          /* 1-st empty entry (idx) host_w */
 135         int read_ptr;           /* last used entry (idx) host_r */
 136         /* use for monitoring and recovering the stuck queue */
 137         dma_addr_t dma_addr;    /* physical addr for BD's */
 138         int n_win;              /* safe queue win */
 139         u32 id;
 140         int low_mark;           /* low watermark, resume queue if free
 141                                  * space more than this */
 142         int high_mark;          /* high watermark, stop queue if free
 143                                  * space less than this */
 144 };
 145
 146 /**
 147  * struct il_tx_queue - Tx Queue for DMA
 148  * @q: generic Rx/Tx queue descriptor
 149  * @bd: base of circular buffer of TFDs
 150  * @cmd: array of command/TX buffer pointers
 151  * @meta: array of meta data for each command/tx buffer
 152  * @dma_addr_cmd: physical address of cmd/tx buffer array
 153  * @skbs: array of per-TFD socket buffer pointers
 154  * @time_stamp: time (in jiffies) of last read_ptr change
 155  * @need_update: indicates need to update read/write idx
 156  * @sched_retry: indicates queue is high-throughput aggregation (HT AGG) enabled
 157  *
 158  * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
 159  * descriptors) and required locking structures.
 160  */
 161 #define TFD_TX_CMD_SLOTS 256
 162 #define TFD_CMD_SLOTS 32
 163
 164 struct il_tx_queue {
 165         struct il_queue q;
 166         void *tfds;
 167         struct il_device_cmd **cmd;
 168         struct il_cmd_meta *meta;
 169         struct sk_buff **skbs;
 170         unsigned long time_stamp;
 171         u8 need_update;
 172         u8 sched_retry;
 173         u8 active;
 174         u8 swq_id;
 175 };
 176
 177 /*
 178  * EEPROM access time values:
 179  *
 180  * Driver initiates EEPROM read by writing byte address << 1 to CSR_EEPROM_REG.
 181  * Driver then polls CSR_EEPROM_REG for CSR_EEPROM_REG_READ_VALID_MSK (0x1).
 182  * When polling, wait 10 uSec between polling loops, up to a maximum 5000 uSec.
 183  * Driver reads 16-bit value from bits 31-16 of CSR_EEPROM_REG.
 184  */
 185 #define IL_EEPROM_ACCESS_TIMEOUT        5000    /* uSec */
 186
 187 #define IL_EEPROM_SEM_TIMEOUT           10      /* microseconds */
 188 #define IL_EEPROM_SEM_RETRY_LIMIT       1000    /* number of attempts (not time) */
 189
 190 /*
 191  * Regulatory channel usage flags in EEPROM struct il4965_eeprom_channel.flags.
 192  *
 193  * IBSS and/or AP operation is allowed *only* on those channels with
 194  * (VALID && IBSS && ACTIVE && !RADAR).  This restriction is in place because
 195  * RADAR detection is not supported by the 4965 driver, but is a
 196  * requirement for establishing a new network for legal operation on channels
 197  * requiring RADAR detection or restricting ACTIVE scanning.
 198  *
 199  * NOTE:  "WIDE" flag does not indicate anything about "HT40" 40 MHz channels.
 200  *        It only indicates that 20 MHz channel use is supported; HT40 channel
 201  *        usage is indicated by a separate set of regulatory flags for each
 202  *        HT40 channel pair.
 203  *
 204  * NOTE:  Using a channel inappropriately will result in a uCode error!
 205  */
 206 #define IL_NUM_TX_CALIB_GROUPS 5
 207 enum {
 208         EEPROM_CHANNEL_VALID = (1 << 0),        /* usable for this SKU/geo */
 209         EEPROM_CHANNEL_IBSS = (1 << 1), /* usable as an IBSS channel */
 210         /* Bit 2 Reserved */
 211         EEPROM_CHANNEL_ACTIVE = (1 << 3),       /* active scanning allowed */
 212         EEPROM_CHANNEL_RADAR = (1 << 4),        /* radar detection required */
 213         EEPROM_CHANNEL_WIDE = (1 << 5), /* 20 MHz channel okay */
 214         /* Bit 6 Reserved (was Narrow Channel) */
 215         EEPROM_CHANNEL_DFS = (1 << 7),  /* dynamic freq selection candidate */
 216 };
 217
 218 /* SKU Capabilities */
 219 /* 3945 only */
 220 #define EEPROM_SKU_CAP_SW_RF_KILL_ENABLE                (1 << 0)
 221 #define EEPROM_SKU_CAP_HW_RF_KILL_ENABLE                (1 << 1)
 222
 223 /* *regulatory* channel data format in eeprom, one for each channel.
 224  * There are separate entries for HT40 (40 MHz) vs. normal (20 MHz) channels. */
 225 struct il_eeprom_channel {
 226         u8 flags;               /* EEPROM_CHANNEL_* flags copied from EEPROM */
 227         s8 max_power_avg;       /* max power (dBm) on this chnl, limit 31 */
 228 } __packed;
 229
 230 /* 3945 Specific */
 231 #define EEPROM_3945_EEPROM_VERSION      (0x2f)
 232
 233 /* 4965 has two radio transmitters (and 3 radio receivers) */
 234 #define EEPROM_TX_POWER_TX_CHAINS      (2)
 235
 236 /* 4965 has room for up to 8 sets of txpower calibration data */
 237 #define EEPROM_TX_POWER_BANDS          (8)
 238
 239 /* 4965 factory calibration measures txpower gain settings for
 240  * each of 3 target output levels */
 241 #define EEPROM_TX_POWER_MEASUREMENTS   (3)
 242
 243 /* 4965 Specific */
 244 /* 4965 driver does not work with txpower calibration version < 5 */
 245 #define EEPROM_4965_TX_POWER_VERSION    (5)
 246 #define EEPROM_4965_EEPROM_VERSION      (0x2f)
 247 #define EEPROM_4965_CALIB_VERSION_OFFSET       (2*0xB6) /* 2 bytes */
 248 #define EEPROM_4965_CALIB_TXPOWER_OFFSET       (2*0xE8) /* 48  bytes */
 249 #define EEPROM_4965_BOARD_REVISION             (2*0x4F) /* 2 bytes */
 250 #define EEPROM_4965_BOARD_PBA                  (2*0x56+1)       /* 9 bytes */
 251
 252 /* 2.4 GHz */
 253 extern const u8 il_eeprom_band_1[14];
 254
 255 /*
 256  * factory calibration data for one txpower level, on one channel,
 257  * measured on one of the 2 tx chains (radio transmitter and associated
 258  * antenna).  EEPROM contains:
 259  *
 260  * 1)  Temperature (degrees Celsius) of device when measurement was made.
 261  *
 262  * 2)  Gain table idx used to achieve the target measurement power.
 263  *     This refers to the "well-known" gain tables (see 4965.h).
 264  *
 265  * 3)  Actual measured output power, in half-dBm ("34" = 17 dBm).
 266  *
 267  * 4)  RF power amplifier detector level measurement (not used).
 268  */
 269 struct il_eeprom_calib_measure {
 270         u8 temperature;         /* Device temperature (Celsius) */
 271         u8 gain_idx;            /* Index into gain table */
 272         u8 actual_pow;          /* Measured RF output power, half-dBm */
 273         s8 pa_det;              /* Power amp detector level (not used) */
 274 } __packed;
 275
 276 /*
 277  * measurement set for one channel.  EEPROM contains:
 278  *
 279  * 1)  Channel number measured
 280  *
 281  * 2)  Measurements for each of 3 power levels for each of 2 radio transmitters
 282  *     (a.k.a. "tx chains") (6 measurements altogether)
 283  */
 284 struct il_eeprom_calib_ch_info {
 285         u8 ch_num;
 286         struct il_eeprom_calib_measure
 287             measurements[EEPROM_TX_POWER_TX_CHAINS]
 288             [EEPROM_TX_POWER_MEASUREMENTS];
 289 } __packed;
 290
 291 /*
 292  * txpower subband info.
 293  *
 294  * For each frequency subband, EEPROM contains the following:
 295  *
 296  * 1)  First and last channels within range of the subband.  "0" values
 297  *     indicate that this sample set is not being used.
 298  *
 299  * 2)  Sample measurement sets for 2 channels close to the range endpoints.
 300  */
 301 struct il_eeprom_calib_subband_info {
 302         u8 ch_from;             /* channel number of lowest channel in subband */
 303         u8 ch_to;               /* channel number of highest channel in subband */
 304         struct il_eeprom_calib_ch_info ch1;
 305         struct il_eeprom_calib_ch_info ch2;
 306 } __packed;
 307
 308 /*
 309  * txpower calibration info.  EEPROM contains:
 310  *
 311  * 1)  Factory-measured saturation power levels (maximum levels at which
 312  *     tx power amplifier can output a signal without too much distortion).
 313  *     There is one level for 2.4 GHz band and one for 5 GHz band.  These
 314  *     values apply to all channels within each of the bands.
 315  *
 316  * 2)  Factory-measured power supply voltage level.  This is assumed to be
 317  *     constant (i.e. same value applies to all channels/bands) while the
 318  *     factory measurements are being made.
 319  *
 320  * 3)  Up to 8 sets of factory-measured txpower calibration values.
 321  *     These are for different frequency ranges, since txpower gain
 322  *     characteristics of the analog radio circuitry vary with frequency.
 323  *
 324  *     Not all sets need to be filled with data;
 325  *     struct il_eeprom_calib_subband_info contains range of channels
 326  *     (0 if unused) for each set of data.
 327  */
 328 struct il_eeprom_calib_info {
 329         u8 saturation_power24;  /* half-dBm (e.g. "34" = 17 dBm) */
 330         u8 saturation_power52;  /* half-dBm */
 331         __le16 voltage;         /* signed */
 332         struct il_eeprom_calib_subband_info band_info[EEPROM_TX_POWER_BANDS];
 333 } __packed;
 334
 335 /* General */
 336 #define EEPROM_DEVICE_ID                    (2*0x08)    /* 2 bytes */
 337 #define EEPROM_MAC_ADDRESS                  (2*0x15)    /* 6  bytes */
 338 #define EEPROM_BOARD_REVISION               (2*0x35)    /* 2  bytes */
 339 #define EEPROM_BOARD_PBA_NUMBER             (2*0x3B+1)  /* 9  bytes */
 340 #define EEPROM_VERSION                      (2*0x44)    /* 2  bytes */
 341 #define EEPROM_SKU_CAP                      (2*0x45)    /* 2  bytes */
 342 #define EEPROM_OEM_MODE                     (2*0x46)    /* 2  bytes */
 343 #define EEPROM_WOWLAN_MODE                  (2*0x47)    /* 2  bytes */
 344 #define EEPROM_RADIO_CONFIG                 (2*0x48)    /* 2  bytes */
 345 #define EEPROM_NUM_MAC_ADDRESS              (2*0x4C)    /* 2  bytes */
 346
 347 /* The following masks are to be applied on EEPROM_RADIO_CONFIG */
 348 #define EEPROM_RF_CFG_TYPE_MSK(x)   (x & 0x3)   /* bits 0-1   */
 349 #define EEPROM_RF_CFG_STEP_MSK(x)   ((x >> 2)  & 0x3)   /* bits 2-3   */
 350 #define EEPROM_RF_CFG_DASH_MSK(x)   ((x >> 4)  & 0x3)   /* bits 4-5   */
 351 #define EEPROM_RF_CFG_PNUM_MSK(x)   ((x >> 6)  & 0x3)   /* bits 6-7   */
 352 #define EEPROM_RF_CFG_TX_ANT_MSK(x) ((x >> 8)  & 0xF)   /* bits 8-11  */
 353 #define EEPROM_RF_CFG_RX_ANT_MSK(x) ((x >> 12) & 0xF)   /* bits 12-15 */
 354
 355 #define EEPROM_3945_RF_CFG_TYPE_MAX  0x0
 356 #define EEPROM_4965_RF_CFG_TYPE_MAX  0x1
 357
 358 /*
 359  * Per-channel regulatory data.
 360  *
 361  * Each channel that *might* be supported by iwl has a fixed location
 362  * in EEPROM containing EEPROM_CHANNEL_* usage flags (LSB) and max regulatory
 363  * txpower (MSB).
 364  *
 365  * Entries immediately below are for 20 MHz channel width.  HT40 (40 MHz)
 366  * channels (only for 4965, not supported by 3945) appear later in the EEPROM.
 367  *
 368  * 2.4 GHz channels 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14
 369  */
 370 #define EEPROM_REGULATORY_SKU_ID            (2*0x60)    /* 4  bytes */
 371 #define EEPROM_REGULATORY_BAND_1            (2*0x62)    /* 2  bytes */
 372 #define EEPROM_REGULATORY_BAND_1_CHANNELS   (2*0x63)    /* 28 bytes */
 373
 374 /*
 375  * 4.9 GHz channels 183, 184, 185, 187, 188, 189, 192, 196,
 376  * 5.0 GHz channels 7, 8, 11, 12, 16
 377  * (4915-5080MHz) (none of these is ever supported)
 378  */
 379 #define EEPROM_REGULATORY_BAND_2            (2*0x71)    /* 2  bytes */
 380 #define EEPROM_REGULATORY_BAND_2_CHANNELS   (2*0x72)    /* 26 bytes */
 381
 382 /*
 383  * 5.2 GHz channels 34, 36, 38, 40, 42, 44, 46, 48, 52, 56, 60, 64
 384  * (5170-5320MHz)
 385  */
 386 #define EEPROM_REGULATORY_BAND_3            (2*0x7F)    /* 2  bytes */
 387 #define EEPROM_REGULATORY_BAND_3_CHANNELS   (2*0x80)    /* 24 bytes */
 388
 389 /*
 390  * 5.5 GHz channels 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140
 391  * (5500-5700MHz)
 392  */
 393 #define EEPROM_REGULATORY_BAND_4            (2*0x8C)    /* 2  bytes */
 394 #define EEPROM_REGULATORY_BAND_4_CHANNELS   (2*0x8D)    /* 22 bytes */
 395
 396 /*
 397  * 5.7 GHz channels 145, 149, 153, 157, 161, 165
 398  * (5725-5825MHz)
 399  */
 400 #define EEPROM_REGULATORY_BAND_5            (2*0x98)    /* 2  bytes */
 401 #define EEPROM_REGULATORY_BAND_5_CHANNELS   (2*0x99)    /* 12 bytes */
 402
 403 /*
 404  * 2.4 GHz HT40 channels 1 (5), 2 (6), 3 (7), 4 (8), 5 (9), 6 (10), 7 (11)
 405  *
 406  * The channel listed is the center of the lower 20 MHz half of the channel.
 407  * The overall center frequency is actually 2 channels (10 MHz) above that,
 408  * and the upper half of each HT40 channel is centered 4 channels (20 MHz) away
 409  * from the lower half; e.g. the upper half of HT40 channel 1 is channel 5,
 410  * and the overall HT40 channel width centers on channel 3.
 411  *
 412  * NOTE:  The RXON command uses 20 MHz channel numbers to specify the
 413  *        control channel to which to tune.  RXON also specifies whether the
 414  *        control channel is the upper or lower half of a HT40 channel.
 415  *
 416  * NOTE:  4965 does not support HT40 channels on 2.4 GHz.
 417  */
 418 #define EEPROM_4965_REGULATORY_BAND_24_HT40_CHANNELS (2*0xA0)   /* 14 bytes */
 419
 420 /*
 421  * 5.2 GHz HT40 channels 36 (40), 44 (48), 52 (56), 60 (64),
 422  * 100 (104), 108 (112), 116 (120), 124 (128), 132 (136), 149 (153), 157 (161)
 423  */
 424 #define EEPROM_4965_REGULATORY_BAND_52_HT40_CHANNELS (2*0xA8)   /* 22 bytes */
 425
 426 #define EEPROM_REGULATORY_BAND_NO_HT40                  (0)
 427
 428 struct il_eeprom_ops {
 429         const u32 regulatory_bands[7];
 430         int (*acquire_semaphore) (struct il_priv *il);
 431         void (*release_semaphore) (struct il_priv *il);
 432 };
 433
 434 int il_eeprom_init(struct il_priv *il);
 435 void il_eeprom_free(struct il_priv *il);
 436 const u8 *il_eeprom_query_addr(const struct il_priv *il, size_t offset);
 437 u16 il_eeprom_query16(const struct il_priv *il, size_t offset);
 438 int il_init_channel_map(struct il_priv *il);
 439 void il_free_channel_map(struct il_priv *il);
 440 const struct il_channel_info *il_get_channel_info(const struct il_priv *il,
 441                                                   enum ieee80211_band band,
 442                                                   u16 channel);
 443
 444 #define IL_NUM_SCAN_RATES         (2)
 445
 446 struct il4965_channel_tgd_info {
 447         u8 type;
 448         s8 max_power;
 449 };
 450
 451 struct il4965_channel_tgh_info {
 452         s64 last_radar_time;
 453 };
 454
 455 #define IL4965_MAX_RATE (33)
 456
 457 struct il3945_clip_group {
 458         /* maximum power level to prevent clipping for each rate, derived by
 459          *   us from this band's saturation power in EEPROM */
 460         const s8 clip_powers[IL_MAX_RATES];
 461 };
 462
 463 /* current Tx power values to use, one for each rate for each channel.
 464  * requested power is limited by:
 465  * -- regulatory EEPROM limits for this channel
 466  * -- hardware capabilities (clip-powers)
 467  * -- spectrum management
 468  * -- user preference (e.g. iwconfig)
 469  * when requested power is set, base power idx must also be set. */
 470 struct il3945_channel_power_info {
 471         struct il3945_tx_power tpc;     /* actual radio and DSP gain settings */
 472         s8 power_table_idx;     /* actual (compenst'd) idx into gain table */
 473         s8 base_power_idx;      /* gain idx for power at factory temp. */
 474         s8 requested_power;     /* power (dBm) requested for this chnl/rate */
 475 };
 476
 477 /* current scan Tx power values to use, one for each scan rate for each
 478  * channel. */
 479 struct il3945_scan_power_info {
 480         struct il3945_tx_power tpc;     /* actual radio and DSP gain settings */
 481         s8 power_table_idx;     /* actual (compenst'd) idx into gain table */
 482         s8 requested_power;     /* scan pwr (dBm) requested for chnl/rate */
 483 };
 484
 485 /*
 486  * One for each channel, holds all channel setup data
 487  * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
 488  *     with one another!
 489  */
 490 struct il_channel_info {
 491         struct il4965_channel_tgd_info tgd;
 492         struct il4965_channel_tgh_info tgh;
 493         struct il_eeprom_channel eeprom;        /* EEPROM regulatory limit */
 494         struct il_eeprom_channel ht40_eeprom;   /* EEPROM regulatory limit for
 495                                                  * HT40 channel */
 496
 497         u8 channel;             /* channel number */
 498         u8 flags;               /* flags copied from EEPROM */
 499         s8 max_power_avg;       /* (dBm) regul. eeprom, normal Tx, any rate */
 500         s8 curr_txpow;          /* (dBm) regulatory/spectrum/user (not h/w) limit */
 501         s8 min_power;           /* always 0 */
 502         s8 scan_power;          /* (dBm) regul. eeprom, direct scans, any rate */
 503
 504         u8 group_idx;           /* 0-4, maps channel to group1/2/3/4/5 */
 505         u8 band_idx;            /* 0-4, maps channel to band1/2/3/4/5 */
 506         enum ieee80211_band band;
 507
 508         /* HT40 channel info */
 509         s8 ht40_max_power_avg;  /* (dBm) regul. eeprom, normal Tx, any rate */
 510         u8 ht40_flags;          /* flags copied from EEPROM */
 511         u8 ht40_extension_channel;      /* HT_IE_EXT_CHANNEL_* */
 512
 513         /* Radio/DSP gain settings for each "normal" data Tx rate.
 514          * These include, in addition to RF and DSP gain, a few fields for
 515          *   remembering/modifying gain settings (idxes). */
 516         struct il3945_channel_power_info power_info[IL4965_MAX_RATE];
 517
 518         /* Radio/DSP gain settings for each scan rate, for directed scans. */
 519         struct il3945_scan_power_info scan_pwr_info[IL_NUM_SCAN_RATES];
 520 };
 521
 522 #define IL_TX_FIFO_BK           0       /* shared */
 523 #define IL_TX_FIFO_BE           1
 524 #define IL_TX_FIFO_VI           2       /* shared */
 525 #define IL_TX_FIFO_VO           3
 526 #define IL_TX_FIFO_UNUSED       -1
 527
 528 /* Minimum number of queues. MAX_NUM is defined in hw specific files.
 529  * Set the minimum to accommodate the 4 standard TX queues, 1 command
 530  * queue, 2 (unused) HCCA queues, and 4 HT queues (one for each AC) */
 531 #define IL_MIN_NUM_QUEUES       10
 532
 533 #define IL_DEFAULT_CMD_QUEUE_NUM        4
 534
 535 #define IEEE80211_DATA_LEN              2304
 536 #define IEEE80211_4ADDR_LEN             30
 537 #define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
 538 #define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
 539
 540 struct il_frame {
 541         union {
 542                 struct ieee80211_hdr frame;
 543                 struct il_tx_beacon_cmd beacon;
 544                 u8 raw[IEEE80211_FRAME_LEN];
 545                 u8 cmd[360];
 546         } u;
 547         struct list_head list;
 548 };
 549
 550 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
 551 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
 552 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
 553
 554 enum {
 555         CMD_SYNC = 0,
 556         CMD_SIZE_NORMAL = 0,
 557         CMD_NO_SKB = 0,
 558         CMD_SIZE_HUGE = (1 << 0),
 559         CMD_ASYNC = (1 << 1),
 560         CMD_WANT_SKB = (1 << 2),
 561         CMD_MAPPED = (1 << 3),
 562 };
 563
 564 #define DEF_CMD_PAYLOAD_SIZE 320
 565
 566 /**
 567  * struct il_device_cmd
 568  *
 569  * For allocation of the command and tx queues, this establishes the overall
 570  * size of the largest command we send to uCode, except for a scan command
 571  * (which is relatively huge; space is allocated separately).
 572  */
 573 struct il_device_cmd {
 574         struct il_cmd_header hdr;       /* uCode API */
 575         union {
 576                 u32 flags;
 577                 u8 val8;
 578                 u16 val16;
 579                 u32 val32;
 580                 struct il_tx_cmd tx;
 581                 u8 payload[DEF_CMD_PAYLOAD_SIZE];
 582         } __packed cmd;
 583 } __packed;
 584
 585 #define TFD_MAX_PAYLOAD_SIZE (sizeof(struct il_device_cmd))
 586
 587 struct il_host_cmd {
 588         const void *data;
 589         unsigned long reply_page;
 590         void (*callback) (struct il_priv *il, struct il_device_cmd *cmd,
 591                           struct il_rx_pkt *pkt);
 592         u32 flags;
 593         u16 len;
 594         u8 id;
 595 };
 596
 597 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
 598 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
 599 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
 600
 601 /**
 602  * struct il_rx_queue - Rx queue
 603  * @bd: driver's pointer to buffer of receive buffer descriptors (rbd)
 604  * @bd_dma: bus address of buffer of receive buffer descriptors (rbd)
 605  * @read: Shared idx to newest available Rx buffer
 606  * @write: Shared idx to oldest written Rx packet
 607  * @free_count: Number of pre-allocated buffers in rx_free
 608  * @rx_free: list of free SKBs for use
 609  * @rx_used: List of Rx buffers with no SKB
 610  * @need_update: flag to indicate we need to update read/write idx
 611  * @rb_stts: driver's pointer to receive buffer status
 612  * @rb_stts_dma: bus address of receive buffer status
 613  *
 614  * NOTE:  rx_free and rx_used are used as a FIFO for il_rx_bufs
 615  */
 616 struct il_rx_queue {
 617         __le32 *bd;
 618         dma_addr_t bd_dma;
 619         struct il_rx_buf pool[RX_QUEUE_SIZE + RX_FREE_BUFFERS];
 620         struct il_rx_buf *queue[RX_QUEUE_SIZE];
 621         u32 read;
 622         u32 write;
 623         u32 free_count;
 624         u32 write_actual;
 625         struct list_head rx_free;
 626         struct list_head rx_used;
 627         int need_update;
 628         struct il_rb_status *rb_stts;
 629         dma_addr_t rb_stts_dma;
 630         spinlock_t lock;
 631 };
 632
 633 #define IL_SUPPORTED_RATES_IE_LEN         8
 634
 635 #define MAX_TID_COUNT        9
 636
 637 #define IL_INVALID_RATE     0xFF
 638 #define IL_INVALID_VALUE    -1
 639
 640 /**
 641  * struct il_ht_agg -- aggregation status while waiting for block-ack
 642  * @txq_id: Tx queue used for Tx attempt
 643  * @frame_count: # frames attempted by Tx command
 644  * @wait_for_ba: Expect block-ack before next Tx reply
 645  * @start_idx: Index of 1st Transmit Frame Descriptor (TFD) in Tx win
 646  * @bitmap0: Low order bitmap, one bit for each frame pending ACK in Tx win
 647  * @bitmap1: High order, one bit for each frame pending ACK in Tx win
 648  * @rate_n_flags: Rate at which Tx was attempted
 649  *
 650  * If C_TX indicates that aggregation was attempted, driver must wait
 651  * for block ack (N_COMPRESSED_BA).  This struct stores tx reply info
 652  * until block ack arrives.
 653  */
 654 struct il_ht_agg {
 655         u16 txq_id;
 656         u16 frame_count;
 657         u16 wait_for_ba;
 658         u16 start_idx;
 659         u64 bitmap;
 660         u32 rate_n_flags;
 661 #define IL_AGG_OFF 0
 662 #define IL_AGG_ON 1
 663 #define IL_EMPTYING_HW_QUEUE_ADDBA 2
 664 #define IL_EMPTYING_HW_QUEUE_DELBA 3
 665         u8 state;
 666 };
 667
 668 struct il_tid_data {
 669         u16 seq_number;         /* 4965 only */
 670         u16 tfds_in_queue;
 671         struct il_ht_agg agg;
 672 };
 673
 674 struct il_hw_key {
 675         u32 cipher;
 676         int keylen;
 677         u8 keyidx;
 678         u8 key[32];
 679 };
 680
 681 union il_ht_rate_supp {
 682         u16 rates;
 683         struct {
 684                 u8 siso_rate;
 685                 u8 mimo_rate;
 686         };
 687 };
 688
 689 #define CFG_HT_RX_AMPDU_FACTOR_8K   (0x0)
 690 #define CFG_HT_RX_AMPDU_FACTOR_16K  (0x1)
 691 #define CFG_HT_RX_AMPDU_FACTOR_32K  (0x2)
 692 #define CFG_HT_RX_AMPDU_FACTOR_64K  (0x3)
 693 #define CFG_HT_RX_AMPDU_FACTOR_DEF  CFG_HT_RX_AMPDU_FACTOR_64K
 694 #define CFG_HT_RX_AMPDU_FACTOR_MAX  CFG_HT_RX_AMPDU_FACTOR_64K
 695 #define CFG_HT_RX_AMPDU_FACTOR_MIN  CFG_HT_RX_AMPDU_FACTOR_8K
 696
 697 /*
 698  * Maximal MPDU density for TX aggregation
 699  * 4 - 2us density
 700  * 5 - 4us density
 701  * 6 - 8us density
 702  * 7 - 16us density
 703  */
 704 #define CFG_HT_MPDU_DENSITY_2USEC   (0x4)
 705 #define CFG_HT_MPDU_DENSITY_4USEC   (0x5)
 706 #define CFG_HT_MPDU_DENSITY_8USEC   (0x6)
 707 #define CFG_HT_MPDU_DENSITY_16USEC  (0x7)
 708 #define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_4USEC
 709 #define CFG_HT_MPDU_DENSITY_MAX CFG_HT_MPDU_DENSITY_16USEC
 710 #define CFG_HT_MPDU_DENSITY_MIN     (0x1)
 711
 712 struct il_ht_config {
 713         bool single_chain_sufficient;
 714         enum ieee80211_smps_mode smps;  /* current smps mode */
 715 };
 716
 717 /* QoS structures */
 718 struct il_qos_info {
 719         int qos_active;
 720         struct il_qosparam_cmd def_qos_parm;
 721 };
 722
 723 /*
 724  * Structure should be accessed with sta_lock held. When station addition
 725  * is in progress (IL_STA_UCODE_INPROGRESS) it is possible to access only
 726  * the commands (il_addsta_cmd and il_link_quality_cmd) without
 727  * sta_lock held.
 728  */
 729 struct il_station_entry {
 730         struct il_addsta_cmd sta;
 731         struct il_tid_data tid[MAX_TID_COUNT];
 732         u8 used;
 733         struct il_hw_key keyinfo;
 734         struct il_link_quality_cmd *lq;
 735 };
 736
 737 struct il_station_priv_common {
 738         u8 sta_id;
 739 };
 740
 741 /**
 742  * struct il_vif_priv - driver's ilate per-interface information
 743  *
 744  * When mac80211 allocates a virtual interface, it can allocate
 745  * space for us to put data into.
 746  */
 747 struct il_vif_priv {
 748         u8 ibss_bssid_sta_id;
 749 };
 750
 751 /* one for each uCode image (inst/data, boot/init/runtime) */
 752 struct fw_desc {
 753         void *v_addr;           /* access by driver */
 754         dma_addr_t p_addr;      /* access by card's busmaster DMA */
 755         u32 len;                /* bytes */
 756 };
 757
 758 /* uCode file layout */
 759 struct il_ucode_header {
 760         __le32 ver;             /* major/minor/API/serial */
 761         struct {
 762                 __le32 inst_size;       /* bytes of runtime code */
 763                 __le32 data_size;       /* bytes of runtime data */
 764                 __le32 init_size;       /* bytes of init code */
 765                 __le32 init_data_size;  /* bytes of init data */
 766                 __le32 boot_size;       /* bytes of bootstrap code */
 767                 u8 data[0];     /* in same order as sizes */
 768         } v1;
 769 };
 770
 771 struct il4965_ibss_seq {
 772         u8 mac[ETH_ALEN];
 773         u16 seq_num;
 774         u16 frag_num;
 775         unsigned long packet_time;
 776         struct list_head list;
 777 };
 778
 779 struct il_sensitivity_ranges {
 780         u16 min_nrg_cck;
 781         u16 max_nrg_cck;
 782
 783         u16 nrg_th_cck;
 784         u16 nrg_th_ofdm;
 785
 786         u16 auto_corr_min_ofdm;
 787         u16 auto_corr_min_ofdm_mrc;
 788         u16 auto_corr_min_ofdm_x1;
 789         u16 auto_corr_min_ofdm_mrc_x1;
 790
 791         u16 auto_corr_max_ofdm;
 792         u16 auto_corr_max_ofdm_mrc;
 793         u16 auto_corr_max_ofdm_x1;
 794         u16 auto_corr_max_ofdm_mrc_x1;
 795
 796         u16 auto_corr_max_cck;
 797         u16 auto_corr_max_cck_mrc;
 798         u16 auto_corr_min_cck;
 799         u16 auto_corr_min_cck_mrc;
 800
 801         u16 barker_corr_th_min;
 802         u16 barker_corr_th_min_mrc;
 803         u16 nrg_th_cca;
 804 };
 805
 806 #define KELVIN_TO_CELSIUS(x) ((x)-273)
 807 #define CELSIUS_TO_KELVIN(x) ((x)+273)
 808
 809 /**
 810  * struct il_hw_params
 811  * @bcast_id: f/w broadcast station ID
 812  * @max_txq_num: Max # Tx queues supported
 813  * @dma_chnl_num: Number of Tx DMA/FIFO channels
 814  * @scd_bc_tbls_size: size of scheduler byte count tables
 815  * @tfd_size: TFD size
 816  * @tx/rx_chains_num: Number of TX/RX chains
 817  * @valid_tx/rx_ant: usable antennas
 818  * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
 819  * @max_rxq_log: Log-base-2 of max_rxq_size
 820  * @rx_page_order: Rx buffer page order
 821  * @rx_wrt_ptr_reg: FH{39}_RSCSR_CHNL0_WPTR
 822  * @max_stations:
 823  * @ht40_channel: is 40MHz width possible in band 2.4
 824  * BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ)
 825  * @sw_crypto: 0 for hw, 1 for sw
 826  * @max_xxx_size: for ucode uses
 827  * @ct_kill_threshold: temperature threshold
 828  * @beacon_time_tsf_bits: number of valid tsf bits for beacon time
 829  * @struct il_sensitivity_ranges: range of sensitivity values
 830  */
 831 struct il_hw_params {
 832         u8 bcast_id;
 833         u8 max_txq_num;
 834         u8 dma_chnl_num;
 835         u16 scd_bc_tbls_size;
 836         u32 tfd_size;
 837         u8 tx_chains_num;
 838         u8 rx_chains_num;
 839         u8 valid_tx_ant;
 840         u8 valid_rx_ant;
 841         u16 max_rxq_size;
 842         u16 max_rxq_log;
 843         u32 rx_page_order;
 844         u32 rx_wrt_ptr_reg;
 845         u8 max_stations;
 846         u8 ht40_channel;
 847         u8 max_beacon_itrvl;    /* in 1024 ms */
 848         u32 max_inst_size;
 849         u32 max_data_size;
 850         u32 max_bsm_size;
 851         u32 ct_kill_threshold;  /* value in hw-dependent units */
 852         u16 beacon_time_tsf_bits;
 853         const struct il_sensitivity_ranges *sens;
 854 };
 855
 856 /******************************************************************************
 857  *
 858  * Functions implemented in core module which are forward declared here
 859  * for use by iwl-[4-5].c
 860  *
 861  * NOTE:  The implementation of these functions are not hardware specific
 862  * which is why they are in the core module files.
 863  *
 864  * Naming convention --
 865  * il_         <-- Is part of iwlwifi
 866  * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
 867  * il4965_bg_      <-- Called from work queue context
 868  * il4965_mac_     <-- mac80211 callback
 869  *
 870  ****************************************************************************/
 871 extern void il4965_update_chain_flags(struct il_priv *il);
 872 extern const u8 il_bcast_addr[ETH_ALEN];
 873 extern int il_queue_space(const struct il_queue *q);
 874 static inline int
 875 il_queue_used(const struct il_queue *q, int i)
 876 {
 877         return q->write_ptr >= q->read_ptr ? (i >= q->read_ptr &&
 878                                               i < q->write_ptr) : !(i <
 879                                                                     q->read_ptr
 880                                                                     && i >=
 881                                                                     q->
 882                                                                     write_ptr);
 883 }
 884
 885 static inline u8
 886 il_get_cmd_idx(struct il_queue *q, u32 idx, int is_huge)
 887 {
 888         /*
 889          * This is for init calibration result and scan command which
 890          * required buffer > TFD_MAX_PAYLOAD_SIZE,
 891          * the big buffer at end of command array
 892          */
 893         if (is_huge)
 894                 return q->n_win;        /* must be power of 2 */
 895
 896         /* Otherwise, use normal size buffers */
 897         return idx & (q->n_win - 1);
 898 }
 899
 900 struct il_dma_ptr {
 901         dma_addr_t dma;
 902         void *addr;
 903         size_t size;
 904 };
 905
 906 #define IL_OPERATION_MODE_AUTO     0
 907 #define IL_OPERATION_MODE_HT_ONLY  1
 908 #define IL_OPERATION_MODE_MIXED    2
 909 #define IL_OPERATION_MODE_20MHZ    3
 910
 911 #define IL_TX_CRC_SIZE 4
 912 #define IL_TX_DELIMITER_SIZE 4
 913
 914 #define TX_POWER_IL_ILLEGAL_VOLTAGE -10000
 915
 916 /* Sensitivity and chain noise calibration */
 917 #define INITIALIZATION_VALUE            0xFFFF
 918 #define IL4965_CAL_NUM_BEACONS          20
 919 #define IL_CAL_NUM_BEACONS              16
 920 #define MAXIMUM_ALLOWED_PATHLOSS        15
 921
 922 #define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
 923
 924 #define MAX_FA_OFDM  50
 925 #define MIN_FA_OFDM  5
 926 #define MAX_FA_CCK   50
 927 #define MIN_FA_CCK   5
 928
 929 #define AUTO_CORR_STEP_OFDM       1
 930
 931 #define AUTO_CORR_STEP_CCK     3
 932 #define AUTO_CORR_MAX_TH_CCK   160
 933
 934 #define NRG_DIFF               2
 935 #define NRG_STEP_CCK           2
 936 #define NRG_MARGIN             8
 937 #define MAX_NUMBER_CCK_NO_FA 100
 938
 939 #define AUTO_CORR_CCK_MIN_VAL_DEF    (125)
 940
 941 #define CHAIN_A             0
 942 #define CHAIN_B             1
 943 #define CHAIN_C             2
 944 #define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
 945 #define ALL_BAND_FILTER                 0xFF00
 946 #define IN_BAND_FILTER                  0xFF
 947 #define MIN_AVERAGE_NOISE_MAX_VALUE     0xFFFFFFFF
 948
 949 #define NRG_NUM_PREV_STAT_L     20
 950 #define NUM_RX_CHAINS           3
 951
 952 enum il4965_false_alarm_state {
 953         IL_FA_TOO_MANY = 0,
 954         IL_FA_TOO_FEW = 1,
 955         IL_FA_GOOD_RANGE = 2,
 956 };
 957
 958 enum il4965_chain_noise_state {
 959         IL_CHAIN_NOISE_ALIVE = 0,       /* must be 0 */
 960         IL_CHAIN_NOISE_ACCUMULATE,
 961         IL_CHAIN_NOISE_CALIBRATED,
 962         IL_CHAIN_NOISE_DONE,
 963 };
 964
 965 enum il4965_calib_enabled_state {
 966         IL_CALIB_DISABLED = 0,  /* must be 0 */
 967         IL_CALIB_ENABLED = 1,
 968 };
 969
 970 /*
 971  * enum il_calib
 972  * defines the order in which results of initial calibrations
 973  * should be sent to the runtime uCode
 974  */
 975 enum il_calib {
 976         IL_CALIB_MAX,
 977 };
 978
 979 /* Opaque calibration results */
 980 struct il_calib_result {
 981         void *buf;
 982         size_t buf_len;
 983 };
 984
 985 enum ucode_type {
 986         UCODE_NONE = 0,
 987         UCODE_INIT,
 988         UCODE_RT
 989 };
 990
 991 /* Sensitivity calib data */
 992 struct il_sensitivity_data {
 993         u32 auto_corr_ofdm;
 994         u32 auto_corr_ofdm_mrc;
 995         u32 auto_corr_ofdm_x1;
 996         u32 auto_corr_ofdm_mrc_x1;
 997         u32 auto_corr_cck;
 998         u32 auto_corr_cck_mrc;
 999
1000         u32 last_bad_plcp_cnt_ofdm;
1001         u32 last_fa_cnt_ofdm;
1002         u32 last_bad_plcp_cnt_cck;
1003         u32 last_fa_cnt_cck;
1004
1005         u32 nrg_curr_state;
1006         u32 nrg_prev_state;
1007         u32 nrg_value[10];
1008         u8 nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
1009         u32 nrg_silence_ref;
1010         u32 nrg_energy_idx;
1011         u32 nrg_silence_idx;
1012         u32 nrg_th_cck;
1013         s32 nrg_auto_corr_silence_diff;
1014         u32 num_in_cck_no_fa;
1015         u32 nrg_th_ofdm;
1016
1017         u16 barker_corr_th_min;
1018         u16 barker_corr_th_min_mrc;
1019         u16 nrg_th_cca;
1020 };
1021
1022 /* Chain noise (differential Rx gain) calib data */
1023 struct il_chain_noise_data {
1024         u32 active_chains;
1025         u32 chain_noise_a;
1026         u32 chain_noise_b;
1027         u32 chain_noise_c;
1028         u32 chain_signal_a;
1029         u32 chain_signal_b;
1030         u32 chain_signal_c;
1031         u16 beacon_count;
1032         u8 disconn_array[NUM_RX_CHAINS];
1033         u8 delta_gain_code[NUM_RX_CHAINS];
1034         u8 radio_write;
1035         u8 state;
1036 };
1037
1038 #define EEPROM_SEM_TIMEOUT 10   /* milliseconds */
1039 #define EEPROM_SEM_RETRY_LIMIT 1000     /* number of attempts (not time) */
1040
1041 #define IL_TRAFFIC_ENTRIES      (256)
1042 #define IL_TRAFFIC_ENTRY_SIZE  (64)
1043
1044 enum {
1045         MEASUREMENT_READY = (1 << 0),
1046         MEASUREMENT_ACTIVE = (1 << 1),
1047 };
1048
1049 /* interrupt stats */
1050 struct isr_stats {
1051         u32 hw;
1052         u32 sw;
1053         u32 err_code;
1054         u32 sch;
1055         u32 alive;
1056         u32 rfkill;
1057         u32 ctkill;
1058         u32 wakeup;
1059         u32 rx;
1060         u32 handlers[IL_CN_MAX];
1061         u32 tx;
1062         u32 unhandled;
1063 };
1064
1065 /* management stats */
1066 enum il_mgmt_stats {
1067         MANAGEMENT_ASSOC_REQ = 0,
1068         MANAGEMENT_ASSOC_RESP,
1069         MANAGEMENT_REASSOC_REQ,
1070         MANAGEMENT_REASSOC_RESP,
1071         MANAGEMENT_PROBE_REQ,
1072         MANAGEMENT_PROBE_RESP,
1073         MANAGEMENT_BEACON,
1074         MANAGEMENT_ATIM,
1075         MANAGEMENT_DISASSOC,
1076         MANAGEMENT_AUTH,
1077         MANAGEMENT_DEAUTH,
1078         MANAGEMENT_ACTION,
1079         MANAGEMENT_MAX,
1080 };
1081 /* control stats */
1082 enum il_ctrl_stats {
1083         CONTROL_BACK_REQ = 0,
1084         CONTROL_BACK,
1085         CONTROL_PSPOLL,
1086         CONTROL_RTS,
1087         CONTROL_CTS,
1088         CONTROL_ACK,
1089         CONTROL_CFEND,
1090         CONTROL_CFENDACK,
1091         CONTROL_MAX,
1092 };
1093
1094 struct traffic_stats {
1095 #ifdef CONFIG_IWLEGACY_DEBUGFS
1096         u32 mgmt[MANAGEMENT_MAX];
1097         u32 ctrl[CONTROL_MAX];
1098         u32 data_cnt;
1099         u64 data_bytes;
1100 #endif
1101 };
1102
1103 /*
1104  * host interrupt timeout value
1105  * used with setting interrupt coalescing timer
1106  * the CSR_INT_COALESCING is an 8 bit register in 32-usec unit
1107  *
1108  * default interrupt coalescing timer is 64 x 32 = 2048 usecs
1109  * default interrupt coalescing calibration timer is 16 x 32 = 512 usecs
1110  */
1111 #define IL_HOST_INT_TIMEOUT_MAX (0xFF)
1112 #define IL_HOST_INT_TIMEOUT_DEF (0x40)
1113 #define IL_HOST_INT_TIMEOUT_MIN (0x0)
1114 #define IL_HOST_INT_CALIB_TIMEOUT_MAX   (0xFF)
1115 #define IL_HOST_INT_CALIB_TIMEOUT_DEF   (0x10)
1116 #define IL_HOST_INT_CALIB_TIMEOUT_MIN   (0x0)
1117
1118 #define IL_DELAY_NEXT_FORCE_FW_RELOAD (HZ*5)
1119
1120 /* TX queue watchdog timeouts in mSecs */
1121 #define IL_DEF_WD_TIMEOUT       (2000)
1122 #define IL_LONG_WD_TIMEOUT      (10000)
1123 #define IL_MAX_WD_TIMEOUT       (120000)
1124
1125 struct il_force_reset {
1126         int reset_request_count;
1127         int reset_success_count;
1128         int reset_reject_count;
1129         unsigned long reset_duration;
1130         unsigned long last_force_reset_jiffies;
1131 };
1132
1133 /* extend beacon time format bit shifting  */
1134 /*
1135  * for _3945 devices
1136  * bits 31:24 - extended
1137  * bits 23:0  - interval
1138  */
1139 #define IL3945_EXT_BEACON_TIME_POS      24
1140 /*
1141  * for _4965 devices
1142  * bits 31:22 - extended
1143  * bits 21:0  - interval
1144  */
1145 #define IL4965_EXT_BEACON_TIME_POS      22
1146
1147 struct il_rxon_context {
1148         struct ieee80211_vif *vif;
1149 };
1150
1151 struct il_power_mgr {
1152         struct il_powertable_cmd sleep_cmd;
1153         struct il_powertable_cmd sleep_cmd_next;
1154         int debug_sleep_level_override;
1155         bool pci_pm;
1156 };
1157
1158 struct il_priv {
1159
1160         /* ieee device used by generic ieee processing code */
1161         struct ieee80211_hw *hw;
1162         struct ieee80211_channel *ieee_channels;
1163         struct ieee80211_rate *ieee_rates;
1164         struct il_cfg *cfg;
1165         const struct il_ops *ops;
1166
1167         /* temporary frame storage list */
1168         struct list_head free_frames;
1169         int frames_count;
1170
1171         enum ieee80211_band band;
1172         int alloc_rxb_page;
1173
1174         void (*handlers[IL_CN_MAX]) (struct il_priv *il,
1175                                      struct il_rx_buf *rxb);
1176
1177         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
1178
1179         /* spectrum measurement report caching */
1180         struct il_spectrum_notification measure_report;
1181         u8 measurement_status;
1182
1183         /* ucode beacon time */
1184         u32 ucode_beacon_time;
1185         int missed_beacon_threshold;
1186
1187         /* track IBSS manager (last beacon) status */
1188         u32 ibss_manager;
1189
1190         /* force reset */
1191         struct il_force_reset force_reset;
1192
1193         /* we allocate array of il_channel_info for NIC's valid channels.
1194          *    Access via channel # using indirect idx array */
1195         struct il_channel_info *channel_info;   /* channel info array */
1196         u8 channel_count;       /* # of channels */
1197
1198         /* thermal calibration */
1199         s32 temperature;        /* degrees Kelvin */
1200         s32 last_temperature;
1201
1202         /* init calibration results */
1203         struct il_calib_result calib_results[IL_CALIB_MAX];
1204
1205         /* Scan related variables */
1206         unsigned long scan_start;
1207         unsigned long scan_start_tsf;
1208         void *scan_cmd;
1209         enum ieee80211_band scan_band;
1210         struct cfg80211_scan_request *scan_request;
1211         struct ieee80211_vif *scan_vif;
1212         u8 scan_tx_ant[IEEE80211_NUM_BANDS];
1213         u8 mgmt_tx_ant;
1214
1215         /* spinlock */
1216         spinlock_t lock;        /* protect general shared data */
1217         spinlock_t hcmd_lock;   /* protect hcmd */
1218         spinlock_t reg_lock;    /* protect hw register access */
1219         struct mutex mutex;
1220
1221         /* basic pci-network driver stuff */
1222         struct pci_dev *pci_dev;
1223
1224         /* pci hardware address support */
1225         void __iomem *hw_base;
1226         u32 hw_rev;
1227         u32 hw_wa_rev;
1228         u8 rev_id;
1229
1230         /* command queue number */
1231         u8 cmd_queue;
1232
1233         /* max number of station keys */
1234         u8 sta_key_max_num;
1235
1236         /* EEPROM MAC addresses */
1237         struct mac_address addresses[1];
1238
1239         /* uCode images, save to reload in case of failure */
1240         int fw_idx;             /* firmware we're trying to load */
1241         u32 ucode_ver;          /* version of ucode, copy of
1242                                    il_ucode.ver */
1243         struct fw_desc ucode_code;      /* runtime inst */
1244         struct fw_desc ucode_data;      /* runtime data original */
1245         struct fw_desc ucode_data_backup;       /* runtime data save/restore */
1246         struct fw_desc ucode_init;      /* initialization inst */
1247         struct fw_desc ucode_init_data; /* initialization data */
1248         struct fw_desc ucode_boot;      /* bootstrap inst */
1249         enum ucode_type ucode_type;
1250         u8 ucode_write_complete;        /* the image write is complete */
1251         char firmware_name[25];
1252
1253         struct ieee80211_vif *vif;
1254
1255         struct il_qos_info qos_data;
1256
1257         struct {
1258                 bool enabled;
1259                 bool is_40mhz;
1260                 bool non_gf_sta_present;
1261                 u8 protection;
1262                 u8 extension_chan_offset;
1263         } ht;
1264
1265         /*
1266          * We declare this const so it can only be
1267          * changed via explicit cast within the
1268          * routines that actually update the physical
1269          * hardware.
1270          */
1271         const struct il_rxon_cmd active;
1272         struct il_rxon_cmd staging;
1273
1274         struct il_rxon_time_cmd timing;
1275
1276         __le16 switch_channel;
1277
1278         /* 1st responses from initialize and runtime uCode images.
1279          * _4965's initialize alive response contains some calibration data. */
1280         struct il_init_alive_resp card_alive_init;
1281         struct il_alive_resp card_alive;
1282
1283         u16 active_rate;
1284
1285         u8 start_calib;
1286         struct il_sensitivity_data sensitivity_data;
1287         struct il_chain_noise_data chain_noise_data;
1288         __le16 sensitivity_tbl[HD_TBL_SIZE];
1289
1290         struct il_ht_config current_ht_config;
1291
1292         /* Rate scaling data */
1293         u8 retry_rate;
1294
1295         wait_queue_head_t wait_command_queue;
1296
1297         int activity_timer_active;
1298
1299         /* Rx and Tx DMA processing queues */
1300         struct il_rx_queue rxq;
1301         struct il_tx_queue *txq;
1302         unsigned long txq_ctx_active_msk;
1303         struct il_dma_ptr kw;   /* keep warm address */
1304         struct il_dma_ptr scd_bc_tbls;
1305
1306         u32 scd_base_addr;      /* scheduler sram base address */
1307
1308         unsigned long status;
1309
1310         /* counts mgmt, ctl, and data packets */
1311         struct traffic_stats tx_stats;
1312         struct traffic_stats rx_stats;
1313
1314         /* counts interrupts */
1315         struct isr_stats isr_stats;
1316
1317         struct il_power_mgr power_data;
1318
1319         /* context information */
1320         u8 bssid[ETH_ALEN];     /* used only on 3945 but filled by core */
1321
1322         /* station table variables */
1323
1324         /* Note: if lock and sta_lock are needed, lock must be acquired first */
1325         spinlock_t sta_lock;
1326         int num_stations;
1327         struct il_station_entry stations[IL_STATION_COUNT];
1328         unsigned long ucode_key_table;
1329
1330         /* queue refcounts */
1331 #define IL_MAX_HW_QUEUES        32
1332         unsigned long queue_stopped[BITS_TO_LONGS(IL_MAX_HW_QUEUES)];
1333         /* for each AC */
1334         atomic_t queue_stop_count[4];
1335
1336         /* Indication if ieee80211_ops->open has been called */
1337         u8 is_open;
1338
1339         u8 mac80211_registered;
1340
1341         /* eeprom -- this is in the card's little endian byte order */
1342         u8 *eeprom;
1343         struct il_eeprom_calib_info *calib_info;
1344
1345         enum nl80211_iftype iw_mode;
1346
1347         /* Last Rx'd beacon timestamp */
1348         u64 timestamp;
1349
1350         union {
1351 #if defined(CONFIG_IWL3945) || defined(CONFIG_IWL3945_MODULE)
1352                 struct {
1353                         void *shared_virt;
1354                         dma_addr_t shared_phys;
1355
1356                         struct delayed_work thermal_periodic;
1357                         struct delayed_work rfkill_poll;
1358
1359                         struct il3945_notif_stats stats;
1360 #ifdef CONFIG_IWLEGACY_DEBUGFS
1361                         struct il3945_notif_stats accum_stats;
1362                         struct il3945_notif_stats delta_stats;
1363                         struct il3945_notif_stats max_delta;
1364 #endif
1365
1366                         u32 sta_supp_rates;
1367                         int last_rx_rssi;       /* From Rx packet stats */
1368
1369                         /* Rx'd packet timing information */
1370                         u32 last_beacon_time;
1371                         u64 last_tsf;
1372
1373                         /*
1374                          * each calibration channel group in the
1375                          * EEPROM has a derived clip setting for
1376                          * each rate.
1377                          */
1378                         const struct il3945_clip_group clip_groups[5];
1379
1380                 } _3945;
1381 #endif
1382 #if defined(CONFIG_IWL4965) || defined(CONFIG_IWL4965_MODULE)
1383                 struct {
1384                         struct il_rx_phy_res last_phy_res;
1385                         bool last_phy_res_valid;
1386
1387                         struct completion firmware_loading_complete;
1388
1389                         /*
1390                          * chain noise reset and gain commands are the
1391                          * two extra calibration commands follows the standard
1392                          * phy calibration commands
1393                          */
1394                         u8 phy_calib_chain_noise_reset_cmd;
1395                         u8 phy_calib_chain_noise_gain_cmd;
1396
1397                         u8 key_mapping_keys;
1398                         struct il_wep_key wep_keys[WEP_KEYS_MAX];
1399
1400                         struct il_notif_stats stats;
1401 #ifdef CONFIG_IWLEGACY_DEBUGFS
1402                         struct il_notif_stats accum_stats;
1403                         struct il_notif_stats delta_stats;
1404                         struct il_notif_stats max_delta;
1405 #endif
1406
1407                 } _4965;
1408 #endif
1409         };
1410
1411         struct il_hw_params hw_params;
1412
1413         u32 inta_mask;
1414
1415         struct workqueue_struct *workqueue;
1416
1417         struct work_struct restart;
1418         struct work_struct scan_completed;
1419         struct work_struct rx_replenish;
1420         struct work_struct abort_scan;
1421
1422         bool beacon_enabled;
1423         struct sk_buff *beacon_skb;
1424
1425         struct work_struct tx_flush;
1426
1427         struct tasklet_struct irq_tasklet;
1428
1429         struct delayed_work init_alive_start;
1430         struct delayed_work alive_start;
1431         struct delayed_work scan_check;
1432
1433         /* TX Power */
1434         s8 tx_power_user_lmt;
1435         s8 tx_power_device_lmt;
1436         s8 tx_power_next;
1437
1438 #ifdef CONFIG_IWLEGACY_DEBUG
1439         /* debugging info */
1440         u32 debug_level;        /* per device debugging will override global
1441                                    il_debug_level if set */
1442 #endif                          /* CONFIG_IWLEGACY_DEBUG */
1443 #ifdef CONFIG_IWLEGACY_DEBUGFS
1444         /* debugfs */
1445         u16 tx_traffic_idx;
1446         u16 rx_traffic_idx;
1447         u8 *tx_traffic;
1448         u8 *rx_traffic;
1449         struct dentry *debugfs_dir;
1450         u32 dbgfs_sram_offset, dbgfs_sram_len;
1451         bool disable_ht40;
1452 #endif                          /* CONFIG_IWLEGACY_DEBUGFS */
1453
1454         struct work_struct txpower_work;
1455         u32 disable_sens_cal;
1456         u32 disable_chain_noise_cal;
1457         u32 disable_tx_power_cal;
1458         struct work_struct run_time_calib_work;
1459         struct timer_list stats_periodic;
1460         struct timer_list watchdog;
1461         bool hw_ready;
1462
1463         struct led_classdev led;
1464         unsigned long blink_on, blink_off;
1465         bool led_registered;
1466 };                              /*il_priv */
1467
1468 static inline void
1469 il_txq_ctx_activate(struct il_priv *il, int txq_id)
1470 {
1471         set_bit(txq_id, &il->txq_ctx_active_msk);
1472 }
1473
1474 static inline void
1475 il_txq_ctx_deactivate(struct il_priv *il, int txq_id)
1476 {
1477         clear_bit(txq_id, &il->txq_ctx_active_msk);
1478 }
1479
1480 static inline int
1481 il_is_associated(struct il_priv *il)
1482 {
1483         return (il->active.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1484 }
1485
1486 static inline int
1487 il_is_any_associated(struct il_priv *il)
1488 {
1489         return il_is_associated(il);
1490 }
1491
1492 static inline int
1493 il_is_channel_valid(const struct il_channel_info *ch_info)
1494 {
1495         if (ch_info == NULL)
1496                 return 0;
1497         return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1498 }
1499
1500 static inline int
1501 il_is_channel_radar(const struct il_channel_info *ch_info)
1502 {
1503         return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1504 }
1505
1506 static inline u8
1507 il_is_channel_a_band(const struct il_channel_info *ch_info)
1508 {
1509         return ch_info->band == IEEE80211_BAND_5GHZ;
1510 }
1511
1512 static inline int
1513 il_is_channel_passive(const struct il_channel_info *ch)
1514 {
1515         return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1516 }
1517
1518 static inline int
1519 il_is_channel_ibss(const struct il_channel_info *ch)
1520 {
1521         return (ch->flags & EEPROM_CHANNEL_IBSS) ? 1 : 0;
1522 }
1523
1524 static inline void
1525 __il_free_pages(struct il_priv *il, struct page *page)
1526 {
1527         __free_pages(page, il->hw_params.rx_page_order);
1528         il->alloc_rxb_page--;
1529 }
1530
1531 static inline void
1532 il_free_pages(struct il_priv *il, unsigned long page)
1533 {
1534         free_pages(page, il->hw_params.rx_page_order);
1535         il->alloc_rxb_page--;
1536 }
1537
1538 #define IWLWIFI_VERSION "in-tree:"
1539 #define DRV_COPYRIGHT   "Copyright(c) 2003-2011 Intel Corporation"
1540 #define DRV_AUTHOR     "<ilw@linux.intel.com>"
1541
1542 #define IL_PCI_DEVICE(dev, subdev, cfg) \
1543         .vendor = PCI_VENDOR_ID_INTEL,  .device = (dev), \
1544         .subvendor = PCI_ANY_ID, .subdevice = (subdev), \
1545         .driver_data = (kernel_ulong_t)&(cfg)
1546
1547 #define TIME_UNIT               1024
1548
1549 #define IL_SKU_G       0x1
1550 #define IL_SKU_A       0x2
1551 #define IL_SKU_N       0x8
1552
1553 #define IL_CMD(x) case x: return #x
1554
1555 /* Size of one Rx buffer in host DRAM */
1556 #define IL_RX_BUF_SIZE_3K (3 * 1000)    /* 3945 only */
1557 #define IL_RX_BUF_SIZE_4K (4 * 1024)
1558 #define IL_RX_BUF_SIZE_8K (8 * 1024)
1559
1560 struct il_hcmd_ops {
1561         int (*rxon_assoc) (struct il_priv *il);
1562         int (*commit_rxon) (struct il_priv *il);
1563         void (*set_rxon_chain) (struct il_priv *il);
1564 };
1565
1566 struct il_hcmd_utils_ops {
1567         u16(*get_hcmd_size) (u8 cmd_id, u16 len);
1568         u16(*build_addsta_hcmd) (const struct il_addsta_cmd *cmd, u8 *data);
1569         int (*request_scan) (struct il_priv *il, struct ieee80211_vif *vif);
1570         void (*post_scan) (struct il_priv *il);
1571 };
1572
1573 struct il_apm_ops {
1574         int (*init) (struct il_priv *il);
1575         void (*config) (struct il_priv *il);
1576 };
1577
1578 #ifdef CONFIG_IWLEGACY_DEBUGFS
1579 struct il_debugfs_ops {
1580         ssize_t(*rx_stats_read) (struct file *file, char __user *user_buf,
1581                                  size_t count, loff_t *ppos);
1582         ssize_t(*tx_stats_read) (struct file *file, char __user *user_buf,
1583                                  size_t count, loff_t *ppos);
1584         ssize_t(*general_stats_read) (struct file *file,
1585                                       char __user *user_buf, size_t count,
1586                                       loff_t *ppos);
1587 };
1588 #endif
1589
1590 struct il_temp_ops {
1591         void (*temperature) (struct il_priv *il);
1592 };
1593
1594 struct il_lib_ops {
1595         /* Handling TX */
1596         void (*txq_update_byte_cnt_tbl) (struct il_priv *il,
1597                                          struct il_tx_queue *txq,
1598                                          u16 byte_cnt);
1599         int (*txq_attach_buf_to_tfd) (struct il_priv *il,
1600                                       struct il_tx_queue *txq, dma_addr_t addr,
1601                                       u16 len, u8 reset, u8 pad);
1602         void (*txq_free_tfd) (struct il_priv *il, struct il_tx_queue *txq);
1603         int (*txq_init) (struct il_priv *il, struct il_tx_queue *txq);
1604         /* setup Rx handler */
1605         void (*handler_setup) (struct il_priv *il);
1606         /* alive notification after init uCode load */
1607         void (*init_alive_start) (struct il_priv *il);
1608         /* check validity of rtc data address */
1609         int (*is_valid_rtc_data_addr) (u32 addr);
1610         /* 1st ucode load */
1611         int (*load_ucode) (struct il_priv *il);
1612
1613         void (*dump_nic_error_log) (struct il_priv *il);
1614         int (*dump_fh) (struct il_priv *il, char **buf, bool display);
1615         int (*set_channel_switch) (struct il_priv *il,
1616                                    struct ieee80211_channel_switch *ch_switch);
1617         /* power management */
1618         struct il_apm_ops apm_ops;
1619
1620         /* power */
1621         int (*send_tx_power) (struct il_priv *il);
1622         void (*update_chain_flags) (struct il_priv *il);
1623
1624         /* eeprom operations */
1625         struct il_eeprom_ops eeprom_ops;
1626
1627         /* temperature */
1628         struct il_temp_ops temp_ops;
1629
1630 #ifdef CONFIG_IWLEGACY_DEBUGFS
1631         struct il_debugfs_ops debugfs_ops;
1632 #endif
1633
1634 };
1635
1636 struct il_led_ops {
1637         int (*cmd) (struct il_priv *il, struct il_led_cmd *led_cmd);
1638 };
1639
1640 struct il_legacy_ops {
1641         void (*post_associate) (struct il_priv *il);
1642         void (*config_ap) (struct il_priv *il);
1643         /* station management */
1644         int (*update_bcast_stations) (struct il_priv *il);
1645         int (*manage_ibss_station) (struct il_priv *il,
1646                                     struct ieee80211_vif *vif, bool add);
1647 };
1648
1649 struct il_ops {
1650         const struct il_lib_ops *lib;
1651         const struct il_hcmd_ops *hcmd;
1652         const struct il_hcmd_utils_ops *utils;
1653         const struct il_led_ops *led;
1654         const struct il_nic_ops *nic;
1655         const struct il_legacy_ops *legacy;
1656 };
1657
1658 struct il_mod_params {
1659         int sw_crypto;          /* def: 0 = using hardware encryption */
1660         int disable_hw_scan;    /* def: 0 = use h/w scan */
1661         int num_of_queues;      /* def: HW dependent */
1662         int disable_11n;        /* def: 0 = 11n capabilities enabled */
1663         int amsdu_size_8K;      /* def: 1 = enable 8K amsdu size */
1664         int antenna;            /* def: 0 = both antennas (use diversity) */
1665         int restart_fw;         /* def: 1 = restart firmware */
1666 };
1667
1668 /*
1669  * @led_compensation: compensate on the led on/off time per HW according
1670  *      to the deviation to achieve the desired led frequency.
1671  *      The detail algorithm is described in common.c
1672  * @chain_noise_num_beacons: number of beacons used to compute chain noise
1673  * @wd_timeout: TX queues watchdog timeout
1674  * @temperature_kelvin: temperature report by uCode in kelvin
1675  * @ucode_tracing: support ucode continuous tracing
1676  * @sensitivity_calib_by_driver: driver has the capability to perform
1677  *      sensitivity calibration operation
1678  * @chain_noise_calib_by_driver: driver has the capability to perform
1679  *      chain noise calibration operation
1680  */
1681 struct il_base_params {
1682 };
1683
1684 #define IL_LED_SOLID 11
1685 #define IL_DEF_LED_INTRVL cpu_to_le32(1000)
1686
1687 #define IL_LED_ACTIVITY       (0<<1)
1688 #define IL_LED_LINK           (1<<1)
1689
1690 /*
1691  * LED mode
1692  *    IL_LED_DEFAULT:  use device default
1693  *    IL_LED_RF_STATE: turn LED on/off based on RF state
1694  *                      LED ON  = RF ON
1695  *                      LED OFF = RF OFF
1696  *    IL_LED_BLINK:    adjust led blink rate based on blink table
1697  */
1698 enum il_led_mode {
1699         IL_LED_DEFAULT,
1700         IL_LED_RF_STATE,
1701         IL_LED_BLINK,
1702 };
1703
1704 void il_leds_init(struct il_priv *il);
1705 void il_leds_exit(struct il_priv *il);
1706
1707 /**
1708  * struct il_cfg
1709  * @fw_name_pre: Firmware filename prefix. The api version and extension
1710  *      (.ucode) will be added to filename before loading from disk. The
1711  *      filename is constructed as fw_name_pre<api>.ucode.
1712  * @ucode_api_max: Highest version of uCode API supported by driver.
1713  * @ucode_api_min: Lowest version of uCode API supported by driver.
1714  * @scan_antennas: available antenna for scan operation
1715  * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
1716  *
1717  * We enable the driver to be backward compatible wrt API version. The
1718  * driver specifies which APIs it supports (with @ucode_api_max being the
1719  * highest and @ucode_api_min the lowest). Firmware will only be loaded if
1720  * it has a supported API version. The firmware's API version will be
1721  * stored in @il_priv, enabling the driver to make runtime changes based
1722  * on firmware version used.
1723  *
1724  * For example,
1725  * if (IL_UCODE_API(il->ucode_ver) >= 2) {
1726  *      Driver interacts with Firmware API version >= 2.
1727  * } else {
1728  *      Driver interacts with Firmware API version 1.
1729  * }
1730  *
1731  * The ideal usage of this infrastructure is to treat a new ucode API
1732  * release as a new hardware revision. That is, through utilizing the
1733  * il_hcmd_utils_ops etc. we accommodate different command structures
1734  * and flows between hardware versions as well as their API
1735  * versions.
1736  *
1737  */
1738 struct il_cfg {
1739         /* params specific to an individual device within a device family */
1740         const char *name;
1741         const char *fw_name_pre;
1742         const unsigned int ucode_api_max;
1743         const unsigned int ucode_api_min;
1744         u8 valid_tx_ant;
1745         u8 valid_rx_ant;
1746         unsigned int sku;
1747         u16 eeprom_ver;
1748         u16 eeprom_calib_ver;
1749         /* module based parameters which can be set from modprobe cmd */
1750         const struct il_mod_params *mod_params;
1751         /* params not likely to change within a device family */
1752         struct il_base_params *base_params;
1753         /* params likely to change within a device family */
1754         u8 scan_rx_antennas[IEEE80211_NUM_BANDS];
1755         enum il_led_mode led_mode;
1756
1757         int eeprom_size;
1758         int num_of_queues;              /* def: HW dependent */
1759         int num_of_ampdu_queues;        /* def: HW dependent */
1760         /* for il_apm_init() */
1761         u32 pll_cfg_val;
1762         bool set_l0s;
1763         bool use_bsm;
1764
1765         u16 led_compensation;
1766         int chain_noise_num_beacons;
1767         unsigned int wd_timeout;
1768         bool temperature_kelvin;
1769         const bool ucode_tracing;
1770         const bool sensitivity_calib_by_driver;
1771         const bool chain_noise_calib_by_driver;
1772 };
1773
1774 /***************************
1775  *   L i b                 *
1776  ***************************/
1777
1778 int il_mac_conf_tx(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1779                    u16 queue, const struct ieee80211_tx_queue_params *params);
1780 int il_mac_tx_last_beacon(struct ieee80211_hw *hw);
1781
1782 void il_set_rxon_hwcrypto(struct il_priv *il, int hw_decrypt);
1783 int il_check_rxon_cmd(struct il_priv *il);
1784 int il_full_rxon_required(struct il_priv *il);
1785 int il_set_rxon_channel(struct il_priv *il, struct ieee80211_channel *ch);
1786 void il_set_flags_for_band(struct il_priv *il, enum ieee80211_band band,
1787                            struct ieee80211_vif *vif);
1788 u8 il_get_single_channel_number(struct il_priv *il, enum ieee80211_band band);
1789 void il_set_rxon_ht(struct il_priv *il, struct il_ht_config *ht_conf);
1790 bool il_is_ht40_tx_allowed(struct il_priv *il,
1791                            struct ieee80211_sta_ht_cap *ht_cap);
1792 void il_connection_init_rx_config(struct il_priv *il);
1793 void il_set_rate(struct il_priv *il);
1794 int il_set_decrypted_flag(struct il_priv *il, struct ieee80211_hdr *hdr,
1795                           u32 decrypt_res, struct ieee80211_rx_status *stats);
1796 void il_irq_handle_error(struct il_priv *il);
1797 int il_mac_add_interface(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
1798 void il_mac_remove_interface(struct ieee80211_hw *hw,
1799                              struct ieee80211_vif *vif);
1800 int il_mac_change_interface(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1801                             enum nl80211_iftype newtype, bool newp2p);
1802 int il_alloc_txq_mem(struct il_priv *il);
1803 void il_txq_mem(struct il_priv *il);
1804
1805 #ifdef CONFIG_IWLEGACY_DEBUGFS
1806 int il_alloc_traffic_mem(struct il_priv *il);
1807 void il_free_traffic_mem(struct il_priv *il);
1808 void il_reset_traffic_log(struct il_priv *il);
1809 void il_dbg_log_tx_data_frame(struct il_priv *il, u16 length,
1810                               struct ieee80211_hdr *header);
1811 void il_dbg_log_rx_data_frame(struct il_priv *il, u16 length,
1812                               struct ieee80211_hdr *header);
1813 const char *il_get_mgmt_string(int cmd);
1814 const char *il_get_ctrl_string(int cmd);
1815 void il_clear_traffic_stats(struct il_priv *il);
1816 void il_update_stats(struct il_priv *il, bool is_tx, __le16 fc, u16 len);
1817 #else
1818 static inline int
1819 il_alloc_traffic_mem(struct il_priv *il)
1820 {
1821         return 0;
1822 }
1823
1824 static inline void
1825 il_free_traffic_mem(struct il_priv *il)
1826 {
1827 }
1828
1829 static inline void
1830 il_reset_traffic_log(struct il_priv *il)
1831 {
1832 }
1833
1834 static inline void
1835 il_dbg_log_tx_data_frame(struct il_priv *il, u16 length,
1836                          struct ieee80211_hdr *header)
1837 {
1838 }
1839
1840 static inline void
1841 il_dbg_log_rx_data_frame(struct il_priv *il, u16 length,
1842                          struct ieee80211_hdr *header)
1843 {
1844 }
1845
1846 static inline void
1847 il_update_stats(struct il_priv *il, bool is_tx, __le16 fc, u16 len)
1848 {
1849 }
1850 #endif
1851 /*****************************************************
1852  * RX handlers.
1853  * **************************************************/
1854 void il_hdl_pm_sleep(struct il_priv *il, struct il_rx_buf *rxb);
1855 void il_hdl_pm_debug_stats(struct il_priv *il, struct il_rx_buf *rxb);
1856 void il_hdl_error(struct il_priv *il, struct il_rx_buf *rxb);
1857
1858 /*****************************************************
1859 * RX
1860 ******************************************************/
1861 void il_cmd_queue_unmap(struct il_priv *il);
1862 void il_cmd_queue_free(struct il_priv *il);
1863 int il_rx_queue_alloc(struct il_priv *il);
1864 void il_rx_queue_update_write_ptr(struct il_priv *il, struct il_rx_queue *q);
1865 int il_rx_queue_space(const struct il_rx_queue *q);
1866 void il_tx_cmd_complete(struct il_priv *il, struct il_rx_buf *rxb);
1867 /* Handlers */
1868 void il_hdl_spectrum_measurement(struct il_priv *il, struct il_rx_buf *rxb);
1869 void il_recover_from_stats(struct il_priv *il, struct il_rx_pkt *pkt);
1870 void il_chswitch_done(struct il_priv *il, bool is_success);
1871 void il_hdl_csa(struct il_priv *il, struct il_rx_buf *rxb);
1872
1873 /* TX helpers */
1874
1875 /*****************************************************
1876 * TX
1877 ******************************************************/
1878 void il_txq_update_write_ptr(struct il_priv *il, struct il_tx_queue *txq);
1879 int il_tx_queue_init(struct il_priv *il, struct il_tx_queue *txq, int slots_num,
1880                      u32 txq_id);
1881 void il_tx_queue_reset(struct il_priv *il, struct il_tx_queue *txq,
1882                        int slots_num, u32 txq_id);
1883 void il_tx_queue_unmap(struct il_priv *il, int txq_id);
1884 void il_tx_queue_free(struct il_priv *il, int txq_id);
1885 void il_setup_watchdog(struct il_priv *il);
1886 /*****************************************************
1887  * TX power
1888  ****************************************************/
1889 int il_set_tx_power(struct il_priv *il, s8 tx_power, bool force);
1890
1891 /*******************************************************************************
1892  * Rate
1893  ******************************************************************************/
1894
1895 u8 il_get_lowest_plcp(struct il_priv *il);
1896
1897 /*******************************************************************************
1898  * Scanning
1899  ******************************************************************************/
1900 void il_init_scan_params(struct il_priv *il);
1901 int il_scan_cancel(struct il_priv *il);
1902 int il_scan_cancel_timeout(struct il_priv *il, unsigned long ms);
1903 void il_force_scan_end(struct il_priv *il);
1904 int il_mac_hw_scan(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1905                    struct cfg80211_scan_request *req);
1906 void il_internal_short_hw_scan(struct il_priv *il);
1907 int il_force_reset(struct il_priv *il, bool external);
1908 u16 il_fill_probe_req(struct il_priv *il, struct ieee80211_mgmt *frame,
1909                       const u8 *ta, const u8 *ie, int ie_len, int left);
1910 void il_setup_rx_scan_handlers(struct il_priv *il);
1911 u16 il_get_active_dwell_time(struct il_priv *il, enum ieee80211_band band,
1912                              u8 n_probes);
1913 u16 il_get_passive_dwell_time(struct il_priv *il, enum ieee80211_band band,
1914                               struct ieee80211_vif *vif);
1915 void il_setup_scan_deferred_work(struct il_priv *il);
1916 void il_cancel_scan_deferred_work(struct il_priv *il);
1917
1918 /* For faster active scanning, scan will move to the next channel if fewer than
1919  * PLCP_QUIET_THRESH packets are heard on this channel within
1920  * ACTIVE_QUIET_TIME after sending probe request.  This shortens the dwell
1921  * time if it's a quiet channel (nothing responded to our probe, and there's
1922  * no other traffic).
1923  * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
1924 #define IL_ACTIVE_QUIET_TIME       cpu_to_le16(10)      /* msec */
1925 #define IL_PLCP_QUIET_THRESH       cpu_to_le16(1)       /* packets */
1926
1927 #define IL_SCAN_CHECK_WATCHDOG          (HZ * 7)
1928
1929 /*****************************************************
1930  *   S e n d i n g     H o s t     C o m m a n d s   *
1931  *****************************************************/
1932
1933 const char *il_get_cmd_string(u8 cmd);
1934 int __must_check il_send_cmd_sync(struct il_priv *il, struct il_host_cmd *cmd);
1935 int il_send_cmd(struct il_priv *il, struct il_host_cmd *cmd);
1936 int __must_check il_send_cmd_pdu(struct il_priv *il, u8 id, u16 len,
1937                                  const void *data);
1938 int il_send_cmd_pdu_async(struct il_priv *il, u8 id, u16 len, const void *data,
1939                           void (*callback) (struct il_priv *il,
1940                                             struct il_device_cmd *cmd,
1941                                             struct il_rx_pkt *pkt));
1942
1943 int il_enqueue_hcmd(struct il_priv *il, struct il_host_cmd *cmd);
1944
1945 /*****************************************************
1946  * PCI                                               *
1947  *****************************************************/
1948
1949 static inline u16
1950 il_pcie_link_ctl(struct il_priv *il)
1951 {
1952         int pos;
1953         u16 pci_lnk_ctl;
1954         pos = pci_pcie_cap(il->pci_dev);
1955         pci_read_config_word(il->pci_dev, pos + PCI_EXP_LNKCTL, &pci_lnk_ctl);
1956         return pci_lnk_ctl;
1957 }
1958
1959 void il_bg_watchdog(unsigned long data);
1960 u32 il_usecs_to_beacons(struct il_priv *il, u32 usec, u32 beacon_interval);
1961 __le32 il_add_beacon_time(struct il_priv *il, u32 base, u32 addon,
1962                           u32 beacon_interval);
1963
1964 #ifdef CONFIG_PM
1965 int il_pci_suspend(struct device *device);
1966 int il_pci_resume(struct device *device);
1967 extern const struct dev_pm_ops il_pm_ops;
1968
1969 #define IL_LEGACY_PM_OPS        (&il_pm_ops)
1970
1971 #else /* !CONFIG_PM */
1972
1973 #define IL_LEGACY_PM_OPS        NULL
1974
1975 #endif /* !CONFIG_PM */
1976
1977 /*****************************************************
1978 *  Error Handling Debugging
1979 ******************************************************/
1980 void il4965_dump_nic_error_log(struct il_priv *il);
1981 #ifdef CONFIG_IWLEGACY_DEBUG
1982 void il_print_rx_config_cmd(struct il_priv *il);
1983 #else
1984 static inline void
1985 il_print_rx_config_cmd(struct il_priv *il)
1986 {
1987 }
1988 #endif
1989
1990 void il_clear_isr_stats(struct il_priv *il);
1991
1992 /*****************************************************
1993 *  GEOS
1994 ******************************************************/
1995 int il_init_geos(struct il_priv *il);
1996 void il_free_geos(struct il_priv *il);
1997
1998 /*************** DRIVER STATUS FUNCTIONS   *****/
1999
2000 #define S_HCMD_ACTIVE   0       /* host command in progress */
2001 /* 1 is unused (used to be S_HCMD_SYNC_ACTIVE) */
2002 #define S_INT_ENABLED   2
2003 #define S_RF_KILL_HW    3
2004 #define S_CT_KILL               4
2005 #define S_INIT          5
2006 #define S_ALIVE         6
2007 #define S_READY         7
2008 #define S_TEMPERATURE   8
2009 #define S_GEO_CONFIGURED        9
2010 #define S_EXIT_PENDING  10
2011 #define S_STATS         12
2012 #define S_SCANNING              13
2013 #define S_SCAN_ABORTING 14
2014 #define S_SCAN_HW               15
2015 #define S_POWER_PMI     16
2016 #define S_FW_ERROR              17
2017 #define S_CHANNEL_SWITCH_PENDING 18
2018
2019 static inline int
2020 il_is_ready(struct il_priv *il)
2021 {
2022         /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
2023          * set but EXIT_PENDING is not */
2024         return test_bit(S_READY, &il->status) &&
2025             test_bit(S_GEO_CONFIGURED, &il->status) &&
2026             !test_bit(S_EXIT_PENDING, &il->status);
2027 }
2028
2029 static inline int
2030 il_is_alive(struct il_priv *il)
2031 {
2032         return test_bit(S_ALIVE, &il->status);
2033 }
2034
2035 static inline int
2036 il_is_init(struct il_priv *il)
2037 {
2038         return test_bit(S_INIT, &il->status);
2039 }
2040
2041 static inline int
2042 il_is_rfkill_hw(struct il_priv *il)
2043 {
2044         return test_bit(S_RF_KILL_HW, &il->status);
2045 }
2046
2047 static inline int
2048 il_is_rfkill(struct il_priv *il)
2049 {
2050         return il_is_rfkill_hw(il);
2051 }
2052
2053 static inline int
2054 il_is_ctkill(struct il_priv *il)
2055 {
2056         return test_bit(S_CT_KILL, &il->status);
2057 }
2058
2059 static inline int
2060 il_is_ready_rf(struct il_priv *il)
2061 {
2062
2063         if (il_is_rfkill(il))
2064                 return 0;
2065
2066         return il_is_ready(il);
2067 }
2068
2069 extern void il_send_bt_config(struct il_priv *il);
2070 extern int il_send_stats_request(struct il_priv *il, u8 flags, bool clear);
2071 void il_apm_stop(struct il_priv *il);
2072 int il_apm_init(struct il_priv *il);
2073
2074 int il_send_rxon_timing(struct il_priv *il);
2075
2076 static inline int
2077 il_send_rxon_assoc(struct il_priv *il)
2078 {
2079         return il->ops->hcmd->rxon_assoc(il);
2080 }
2081
2082 static inline int
2083 il_commit_rxon(struct il_priv *il)
2084 {
2085         return il->ops->hcmd->commit_rxon(il);
2086 }
2087
2088 static inline const struct ieee80211_supported_band *
2089 il_get_hw_mode(struct il_priv *il, enum ieee80211_band band)
2090 {
2091         return il->hw->wiphy->bands[band];
2092 }
2093
2094 /* mac80211 handlers */
2095 int il_mac_config(struct ieee80211_hw *hw, u32 changed);
2096 void il_mac_reset_tsf(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2097 void il_mac_bss_info_changed(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2098                              struct ieee80211_bss_conf *bss_conf, u32 changes);
2099 void il_tx_cmd_protection(struct il_priv *il, struct ieee80211_tx_info *info,
2100                           __le16 fc, __le32 *tx_flags);
2101
2102 irqreturn_t il_isr(int irq, void *data);
2103
2104 extern void il_set_bit(struct il_priv *p, u32 r, u32 m);
2105 extern void il_clear_bit(struct il_priv *p, u32 r, u32 m);
2106 extern bool _il_grab_nic_access(struct il_priv *il);
2107 extern int _il_poll_bit(struct il_priv *il, u32 addr, u32 bits, u32 mask, int timeout);
2108 extern int il_poll_bit(struct il_priv *il, u32 addr, u32 mask, int timeout);
2109 extern u32 il_rd_prph(struct il_priv *il, u32 reg);
2110 extern void il_wr_prph(struct il_priv *il, u32 addr, u32 val);
2111 extern u32 il_read_targ_mem(struct il_priv *il, u32 addr);
2112 extern void il_write_targ_mem(struct il_priv *il, u32 addr, u32 val);
2113
2114 static inline void
2115 _il_write8(struct il_priv *il, u32 ofs, u8 val)
2116 {
2117         iowrite8(val, il->hw_base + ofs);
2118 }
2119 #define il_write8(il, ofs, val) _il_write8(il, ofs, val)
2120
2121 static inline void
2122 _il_wr(struct il_priv *il, u32 ofs, u32 val)
2123 {
2124         iowrite32(val, il->hw_base + ofs);
2125 }
2126
2127 static inline u32
2128 _il_rd(struct il_priv *il, u32 ofs)
2129 {
2130         return ioread32(il->hw_base + ofs);
2131 }
2132
2133 static inline void
2134 _il_clear_bit(struct il_priv *il, u32 reg, u32 mask)
2135 {
2136         _il_wr(il, reg, _il_rd(il, reg) & ~mask);
2137 }
2138
2139 static inline void
2140 _il_set_bit(struct il_priv *il, u32 reg, u32 mask)
2141 {
2142         _il_wr(il, reg, _il_rd(il, reg) | mask);
2143 }
2144
2145 static inline void
2146 _il_release_nic_access(struct il_priv *il)
2147 {
2148         _il_clear_bit(il, CSR_GP_CNTRL, CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
2149         /*
2150          * In above we are reading CSR_GP_CNTRL register, what will flush any
2151          * previous writes, but still want write, which clear MAC_ACCESS_REQ
2152          * bit, be performed on PCI bus before any other writes scheduled on
2153          * different CPUs (after we drop reg_lock).
2154          */
2155         mmiowb();
2156 }
2157
2158 static inline u32
2159 il_rd(struct il_priv *il, u32 reg)
2160 {
2161         u32 value;
2162         unsigned long reg_flags;
2163
2164         spin_lock_irqsave(&il->reg_lock, reg_flags);
2165         _il_grab_nic_access(il);
2166         value = _il_rd(il, reg);
2167         _il_release_nic_access(il);
2168         spin_unlock_irqrestore(&il->reg_lock, reg_flags);
2169         return value;
2170 }
2171
2172 static inline void
2173 il_wr(struct il_priv *il, u32 reg, u32 value)
2174 {
2175         unsigned long reg_flags;
2176
2177         spin_lock_irqsave(&il->reg_lock, reg_flags);
2178         if (likely(_il_grab_nic_access(il))) {
2179                 _il_wr(il, reg, value);
2180                 _il_release_nic_access(il);
2181         }
2182         spin_unlock_irqrestore(&il->reg_lock, reg_flags);
2183 }
2184
2185 static inline u32
2186 _il_rd_prph(struct il_priv *il, u32 reg)
2187 {
2188         _il_wr(il, HBUS_TARG_PRPH_RADDR, reg | (3 << 24));
2189         return _il_rd(il, HBUS_TARG_PRPH_RDAT);
2190 }
2191
2192 static inline void
2193 _il_wr_prph(struct il_priv *il, u32 addr, u32 val)
2194 {
2195         _il_wr(il, HBUS_TARG_PRPH_WADDR, ((addr & 0x0000FFFF) | (3 << 24)));
2196         _il_wr(il, HBUS_TARG_PRPH_WDAT, val);
2197 }
2198
2199 static inline void
2200 il_set_bits_prph(struct il_priv *il, u32 reg, u32 mask)
2201 {
2202         unsigned long reg_flags;
2203
2204         spin_lock_irqsave(&il->reg_lock, reg_flags);
2205         if (likely(_il_grab_nic_access(il))) {
2206                 _il_wr_prph(il, reg, (_il_rd_prph(il, reg) | mask));
2207                 _il_release_nic_access(il);
2208         }
2209         spin_unlock_irqrestore(&il->reg_lock, reg_flags);
2210 }
2211
2212 static inline void
2213 il_set_bits_mask_prph(struct il_priv *il, u32 reg, u32 bits, u32 mask)
2214 {
2215         unsigned long reg_flags;
2216
2217         spin_lock_irqsave(&il->reg_lock, reg_flags);
2218         if (likely(_il_grab_nic_access(il))) {
2219                 _il_wr_prph(il, reg, ((_il_rd_prph(il, reg) & mask) | bits));
2220                 _il_release_nic_access(il);
2221         }
2222         spin_unlock_irqrestore(&il->reg_lock, reg_flags);
2223 }
2224
2225 static inline void
2226 il_clear_bits_prph(struct il_priv *il, u32 reg, u32 mask)
2227 {
2228         unsigned long reg_flags;
2229         u32 val;
2230
2231         spin_lock_irqsave(&il->reg_lock, reg_flags);
2232         if (likely(_il_grab_nic_access(il))) {
2233                 val = _il_rd_prph(il, reg);
2234                 _il_wr_prph(il, reg, (val & ~mask));
2235                 _il_release_nic_access(il);
2236         }
2237         spin_unlock_irqrestore(&il->reg_lock, reg_flags);
2238 }
2239
2240 #define HW_KEY_DYNAMIC 0
2241 #define HW_KEY_DEFAULT 1
2242
2243 #define IL_STA_DRIVER_ACTIVE BIT(0)     /* driver entry is active */
2244 #define IL_STA_UCODE_ACTIVE  BIT(1)     /* ucode entry is active */
2245 #define IL_STA_UCODE_INPROGRESS  BIT(2) /* ucode entry is in process of
2246                                            being activated */
2247 #define IL_STA_LOCAL BIT(3)     /* station state not directed by mac80211;
2248                                    (this is for the IBSS BSSID stations) */
2249 #define IL_STA_BCAST BIT(4)     /* this station is the special bcast station */
2250
2251 void il_restore_stations(struct il_priv *il);
2252 void il_clear_ucode_stations(struct il_priv *il);
2253 void il_dealloc_bcast_stations(struct il_priv *il);
2254 int il_get_free_ucode_key_idx(struct il_priv *il);
2255 int il_send_add_sta(struct il_priv *il, struct il_addsta_cmd *sta, u8 flags);
2256 int il_add_station_common(struct il_priv *il, const u8 *addr, bool is_ap,
2257                           struct ieee80211_sta *sta, u8 *sta_id_r);
2258 int il_remove_station(struct il_priv *il, const u8 sta_id, const u8 * addr);
2259 int il_mac_sta_remove(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2260                       struct ieee80211_sta *sta);
2261
2262 u8 il_prep_station(struct il_priv *il, const u8 *addr, bool is_ap,
2263                    struct ieee80211_sta *sta);
2264
2265 int il_send_lq_cmd(struct il_priv *il, struct il_link_quality_cmd *lq,
2266                    u8 flags, bool init);
2267
2268 /**
2269  * il_clear_driver_stations - clear knowledge of all stations from driver
2270  * @il: iwl il struct
2271  *
2272  * This is called during il_down() to make sure that in the case
2273  * we're coming there from a hardware restart mac80211 will be
2274  * able to reconfigure stations -- if we're getting there in the
2275  * normal down flow then the stations will already be cleared.
2276  */
2277 static inline void
2278 il_clear_driver_stations(struct il_priv *il)
2279 {
2280         unsigned long flags;
2281
2282         spin_lock_irqsave(&il->sta_lock, flags);
2283         memset(il->stations, 0, sizeof(il->stations));
2284         il->num_stations = 0;
2285         il->ucode_key_table = 0;
2286         spin_unlock_irqrestore(&il->sta_lock, flags);
2287 }
2288
2289 static inline int
2290 il_sta_id(struct ieee80211_sta *sta)
2291 {
2292         if (WARN_ON(!sta))
2293                 return IL_INVALID_STATION;
2294
2295         return ((struct il_station_priv_common *)sta->drv_priv)->sta_id;
2296 }
2297
2298 /**
2299  * il_sta_id_or_broadcast - return sta_id or broadcast sta
2300  * @il: iwl il
2301  * @context: the current context
2302  * @sta: mac80211 station
2303  *
2304  * In certain circumstances mac80211 passes a station pointer
2305  * that may be %NULL, for example during TX or key setup. In
2306  * that case, we need to use the broadcast station, so this
2307  * inline wraps that pattern.
2308  */
2309 static inline int
2310 il_sta_id_or_broadcast(struct il_priv *il, struct ieee80211_sta *sta)
2311 {
2312         int sta_id;
2313
2314         if (!sta)
2315                 return il->hw_params.bcast_id;
2316
2317         sta_id = il_sta_id(sta);
2318
2319         /*
2320          * mac80211 should not be passing a partially
2321          * initialised station!
2322          */
2323         WARN_ON(sta_id == IL_INVALID_STATION);
2324
2325         return sta_id;
2326 }
2327
2328 /**
2329  * il_queue_inc_wrap - increment queue idx, wrap back to beginning
2330  * @idx -- current idx
2331  * @n_bd -- total number of entries in queue (must be power of 2)
2332  */
2333 static inline int
2334 il_queue_inc_wrap(int idx, int n_bd)
2335 {
2336         return ++idx & (n_bd - 1);
2337 }
2338
2339 /**
2340  * il_queue_dec_wrap - decrement queue idx, wrap back to end
2341  * @idx -- current idx
2342  * @n_bd -- total number of entries in queue (must be power of 2)
2343  */
2344 static inline int
2345 il_queue_dec_wrap(int idx, int n_bd)
2346 {
2347         return --idx & (n_bd - 1);
2348 }
2349
2350 /* TODO: Move fw_desc functions to iwl-pci.ko */
2351 static inline void
2352 il_free_fw_desc(struct pci_dev *pci_dev, struct fw_desc *desc)
2353 {
2354         if (desc->v_addr)
2355                 dma_free_coherent(&pci_dev->dev, desc->len, desc->v_addr,
2356                                   desc->p_addr);
2357         desc->v_addr = NULL;
2358         desc->len = 0;
2359 }
2360
2361 static inline int
2362 il_alloc_fw_desc(struct pci_dev *pci_dev, struct fw_desc *desc)
2363 {
2364         if (!desc->len) {
2365                 desc->v_addr = NULL;
2366                 return -EINVAL;
2367         }
2368
2369         desc->v_addr =
2370             dma_alloc_coherent(&pci_dev->dev, desc->len, &desc->p_addr,
2371                                GFP_KERNEL);
2372         return (desc->v_addr != NULL) ? 0 : -ENOMEM;
2373 }
2374
2375 /*
2376  * we have 8 bits used like this:
2377  *
2378  * 7 6 5 4 3 2 1 0
2379  * | | | | | | | |
2380  * | | | | | | +-+-------- AC queue (0-3)
2381  * | | | | | |
2382  * | +-+-+-+-+------------ HW queue ID
2383  * |
2384  * +---------------------- unused
2385  */
2386 static inline void
2387 il_set_swq_id(struct il_tx_queue *txq, u8 ac, u8 hwq)
2388 {
2389         BUG_ON(ac > 3);         /* only have 2 bits */
2390         BUG_ON(hwq > 31);       /* only use 5 bits */
2391
2392         txq->swq_id = (hwq << 2) | ac;
2393 }
2394
2395 static inline void
2396 il_wake_queue(struct il_priv *il, struct il_tx_queue *txq)
2397 {
2398         u8 queue = txq->swq_id;
2399         u8 ac = queue & 3;
2400         u8 hwq = (queue >> 2) & 0x1f;
2401
2402         if (test_and_clear_bit(hwq, il->queue_stopped))
2403                 if (atomic_dec_return(&il->queue_stop_count[ac]) <= 0)
2404                         ieee80211_wake_queue(il->hw, ac);
2405 }
2406
2407 static inline void
2408 il_stop_queue(struct il_priv *il, struct il_tx_queue *txq)
2409 {
2410         u8 queue = txq->swq_id;
2411         u8 ac = queue & 3;
2412         u8 hwq = (queue >> 2) & 0x1f;
2413
2414         if (!test_and_set_bit(hwq, il->queue_stopped))
2415                 if (atomic_inc_return(&il->queue_stop_count[ac]) > 0)
2416                         ieee80211_stop_queue(il->hw, ac);
2417 }
2418
2419 #ifdef ieee80211_stop_queue
2420 #undef ieee80211_stop_queue
2421 #endif
2422
2423 #define ieee80211_stop_queue DO_NOT_USE_ieee80211_stop_queue
2424
2425 #ifdef ieee80211_wake_queue
2426 #undef ieee80211_wake_queue
2427 #endif
2428
2429 #define ieee80211_wake_queue DO_NOT_USE_ieee80211_wake_queue
2430
2431 static inline void
2432 il_disable_interrupts(struct il_priv *il)
2433 {
2434         clear_bit(S_INT_ENABLED, &il->status);
2435
2436         /* disable interrupts from uCode/NIC to host */
2437         _il_wr(il, CSR_INT_MASK, 0x00000000);
2438
2439         /* acknowledge/clear/reset any interrupts still pending
2440          * from uCode or flow handler (Rx/Tx DMA) */
2441         _il_wr(il, CSR_INT, 0xffffffff);
2442         _il_wr(il, CSR_FH_INT_STATUS, 0xffffffff);
2443 }
2444
2445 static inline void
2446 il_enable_rfkill_int(struct il_priv *il)
2447 {
2448         _il_wr(il, CSR_INT_MASK, CSR_INT_BIT_RF_KILL);
2449 }
2450
2451 static inline void
2452 il_enable_interrupts(struct il_priv *il)
2453 {
2454         set_bit(S_INT_ENABLED, &il->status);
2455         _il_wr(il, CSR_INT_MASK, il->inta_mask);
2456 }
2457
2458 /**
2459  * il_beacon_time_mask_low - mask of lower 32 bit of beacon time
2460  * @il -- pointer to il_priv data structure
2461  * @tsf_bits -- number of bits need to shift for masking)
2462  */
2463 static inline u32
2464 il_beacon_time_mask_low(struct il_priv *il, u16 tsf_bits)
2465 {
2466         return (1 << tsf_bits) - 1;
2467 }
2468
2469 /**
2470  * il_beacon_time_mask_high - mask of higher 32 bit of beacon time
2471  * @il -- pointer to il_priv data structure
2472  * @tsf_bits -- number of bits need to shift for masking)
2473  */
2474 static inline u32
2475 il_beacon_time_mask_high(struct il_priv *il, u16 tsf_bits)
2476 {
2477         return ((1 << (32 - tsf_bits)) - 1) << tsf_bits;
2478 }
2479
2480 /**
2481  * struct il_rb_status - reseve buffer status host memory mapped FH registers
2482  *
2483  * @closed_rb_num [0:11] - Indicates the idx of the RB which was closed
2484  * @closed_fr_num [0:11] - Indicates the idx of the RX Frame which was closed
2485  * @finished_rb_num [0:11] - Indicates the idx of the current RB
2486  *                           in which the last frame was written to
2487  * @finished_fr_num [0:11] - Indicates the idx of the RX Frame
2488  *                           which was transferred
2489  */
2490 struct il_rb_status {
2491         __le16 closed_rb_num;
2492         __le16 closed_fr_num;
2493         __le16 finished_rb_num;
2494         __le16 finished_fr_nam;
2495         __le32 __unused;        /* 3945 only */
2496 } __packed;
2497
2498 #define TFD_QUEUE_SIZE_MAX      (256)
2499 #define TFD_QUEUE_SIZE_BC_DUP   (64)
2500 #define TFD_QUEUE_BC_SIZE       (TFD_QUEUE_SIZE_MAX + TFD_QUEUE_SIZE_BC_DUP)
2501 #define IL_TX_DMA_MASK        DMA_BIT_MASK(36)
2502 #define IL_NUM_OF_TBS           20
2503
2504 static inline u8
2505 il_get_dma_hi_addr(dma_addr_t addr)
2506 {
2507         return (sizeof(addr) > sizeof(u32) ? (addr >> 16) >> 16 : 0) & 0xF;
2508 }
2509
2510 /**
2511  * struct il_tfd_tb transmit buffer descriptor within transmit frame descriptor
2512  *
2513  * This structure contains dma address and length of transmission address
2514  *
2515  * @lo: low [31:0] portion of the dma address of TX buffer every even is
2516  *      unaligned on 16 bit boundary
2517  * @hi_n_len: 0-3 [35:32] portion of dma
2518  *            4-15 length of the tx buffer
2519  */
2520 struct il_tfd_tb {
2521         __le32 lo;
2522         __le16 hi_n_len;
2523 } __packed;
2524
2525 /**
2526  * struct il_tfd
2527  *
2528  * Transmit Frame Descriptor (TFD)
2529  *
2530  * @ __reserved1[3] reserved
2531  * @ num_tbs 0-4 number of active tbs
2532  *           5   reserved
2533  *           6-7 padding (not used)
2534  * @ tbs[20]    transmit frame buffer descriptors
2535  * @ __pad      padding
2536  *
2537  * Each Tx queue uses a circular buffer of 256 TFDs stored in host DRAM.
2538  * Both driver and device share these circular buffers, each of which must be
2539  * contiguous 256 TFDs x 128 bytes-per-TFD = 32 KBytes
2540  *
2541  * Driver must indicate the physical address of the base of each
2542  * circular buffer via the FH49_MEM_CBBC_QUEUE registers.
2543  *
2544  * Each TFD contains pointer/size information for up to 20 data buffers
2545  * in host DRAM.  These buffers collectively contain the (one) frame described
2546  * by the TFD.  Each buffer must be a single contiguous block of memory within
2547  * itself, but buffers may be scattered in host DRAM.  Each buffer has max size
2548  * of (4K - 4).  The concatenates all of a TFD's buffers into a single
2549  * Tx frame, up to 8 KBytes in size.
2550  *
2551  * A maximum of 255 (not 256!) TFDs may be on a queue waiting for Tx.
2552  */
2553 struct il_tfd {
2554         u8 __reserved1[3];
2555         u8 num_tbs;
2556         struct il_tfd_tb tbs[IL_NUM_OF_TBS];
2557         __le32 __pad;
2558 } __packed;
2559 /* PCI registers */
2560 #define PCI_CFG_RETRY_TIMEOUT   0x041
2561
2562 /* PCI register values */
2563 #define PCI_CFG_LINK_CTRL_VAL_L0S_EN    0x01
2564 #define PCI_CFG_LINK_CTRL_VAL_L1_EN     0x02
2565
2566 struct il_rate_info {
2567         u8 plcp;                /* uCode API:  RATE_6M_PLCP, etc. */
2568         u8 plcp_siso;           /* uCode API:  RATE_SISO_6M_PLCP, etc. */
2569         u8 plcp_mimo2;          /* uCode API:  RATE_MIMO2_6M_PLCP, etc. */
2570         u8 ieee;                /* MAC header:  RATE_6M_IEEE, etc. */
2571         u8 prev_ieee;           /* previous rate in IEEE speeds */
2572         u8 next_ieee;           /* next rate in IEEE speeds */
2573         u8 prev_rs;             /* previous rate used in rs algo */
2574         u8 next_rs;             /* next rate used in rs algo */
2575         u8 prev_rs_tgg;         /* previous rate used in TGG rs algo */
2576         u8 next_rs_tgg;         /* next rate used in TGG rs algo */
2577 };
2578
2579 struct il3945_rate_info {
2580         u8 plcp;                /* uCode API:  RATE_6M_PLCP, etc. */
2581         u8 ieee;                /* MAC header:  RATE_6M_IEEE, etc. */
2582         u8 prev_ieee;           /* previous rate in IEEE speeds */
2583         u8 next_ieee;           /* next rate in IEEE speeds */
2584         u8 prev_rs;             /* previous rate used in rs algo */
2585         u8 next_rs;             /* next rate used in rs algo */
2586         u8 prev_rs_tgg;         /* previous rate used in TGG rs algo */
2587         u8 next_rs_tgg;         /* next rate used in TGG rs algo */
2588         u8 table_rs_idx;        /* idx in rate scale table cmd */
2589         u8 prev_table_rs;       /* prev in rate table cmd */
2590 };
2591
2592 /*
2593  * These serve as idxes into
2594  * struct il_rate_info il_rates[RATE_COUNT];
2595  */
2596 enum {
2597         RATE_1M_IDX = 0,
2598         RATE_2M_IDX,
2599         RATE_5M_IDX,
2600         RATE_11M_IDX,
2601         RATE_6M_IDX,
2602         RATE_9M_IDX,
2603         RATE_12M_IDX,
2604         RATE_18M_IDX,
2605         RATE_24M_IDX,
2606         RATE_36M_IDX,
2607         RATE_48M_IDX,
2608         RATE_54M_IDX,
2609         RATE_60M_IDX,
2610         RATE_COUNT,
2611         RATE_COUNT_LEGACY = RATE_COUNT - 1,     /* Excluding 60M */
2612         RATE_COUNT_3945 = RATE_COUNT - 1,
2613         RATE_INVM_IDX = RATE_COUNT,
2614         RATE_INVALID = RATE_COUNT,
2615 };
2616
2617 enum {
2618         RATE_6M_IDX_TBL = 0,
2619         RATE_9M_IDX_TBL,
2620         RATE_12M_IDX_TBL,
2621         RATE_18M_IDX_TBL,
2622         RATE_24M_IDX_TBL,
2623         RATE_36M_IDX_TBL,
2624         RATE_48M_IDX_TBL,
2625         RATE_54M_IDX_TBL,
2626         RATE_1M_IDX_TBL,
2627         RATE_2M_IDX_TBL,
2628         RATE_5M_IDX_TBL,
2629         RATE_11M_IDX_TBL,
2630         RATE_INVM_IDX_TBL = RATE_INVM_IDX - 1,
2631 };
2632
2633 enum {
2634         IL_FIRST_OFDM_RATE = RATE_6M_IDX,
2635         IL39_LAST_OFDM_RATE = RATE_54M_IDX,
2636         IL_LAST_OFDM_RATE = RATE_60M_IDX,
2637         IL_FIRST_CCK_RATE = RATE_1M_IDX,
2638         IL_LAST_CCK_RATE = RATE_11M_IDX,
2639 };
2640
2641 /* #define vs. enum to keep from defaulting to 'large integer' */
2642 #define RATE_6M_MASK   (1 << RATE_6M_IDX)
2643 #define RATE_9M_MASK   (1 << RATE_9M_IDX)
2644 #define RATE_12M_MASK  (1 << RATE_12M_IDX)
2645 #define RATE_18M_MASK  (1 << RATE_18M_IDX)
2646 #define RATE_24M_MASK  (1 << RATE_24M_IDX)
2647 #define RATE_36M_MASK  (1 << RATE_36M_IDX)
2648 #define RATE_48M_MASK  (1 << RATE_48M_IDX)
2649 #define RATE_54M_MASK  (1 << RATE_54M_IDX)
2650 #define RATE_60M_MASK  (1 << RATE_60M_IDX)
2651 #define RATE_1M_MASK   (1 << RATE_1M_IDX)
2652 #define RATE_2M_MASK   (1 << RATE_2M_IDX)
2653 #define RATE_5M_MASK   (1 << RATE_5M_IDX)
2654 #define RATE_11M_MASK  (1 << RATE_11M_IDX)
2655
2656 /* uCode API values for legacy bit rates, both OFDM and CCK */
2657 enum {
2658         RATE_6M_PLCP = 13,
2659         RATE_9M_PLCP = 15,
2660         RATE_12M_PLCP = 5,
2661         RATE_18M_PLCP = 7,
2662         RATE_24M_PLCP = 9,
2663         RATE_36M_PLCP = 11,
2664         RATE_48M_PLCP = 1,
2665         RATE_54M_PLCP = 3,
2666         RATE_60M_PLCP = 3,      /*FIXME:RS:should be removed */
2667         RATE_1M_PLCP = 10,
2668         RATE_2M_PLCP = 20,
2669         RATE_5M_PLCP = 55,
2670         RATE_11M_PLCP = 110,
2671         /*FIXME:RS:add RATE_LEGACY_INVM_PLCP = 0, */
2672 };
2673
2674 /* uCode API values for OFDM high-throughput (HT) bit rates */
2675 enum {
2676         RATE_SISO_6M_PLCP = 0,
2677         RATE_SISO_12M_PLCP = 1,
2678         RATE_SISO_18M_PLCP = 2,
2679         RATE_SISO_24M_PLCP = 3,
2680         RATE_SISO_36M_PLCP = 4,
2681         RATE_SISO_48M_PLCP = 5,
2682         RATE_SISO_54M_PLCP = 6,
2683         RATE_SISO_60M_PLCP = 7,
2684         RATE_MIMO2_6M_PLCP = 0x8,
2685         RATE_MIMO2_12M_PLCP = 0x9,
2686         RATE_MIMO2_18M_PLCP = 0xa,
2687         RATE_MIMO2_24M_PLCP = 0xb,
2688         RATE_MIMO2_36M_PLCP = 0xc,
2689         RATE_MIMO2_48M_PLCP = 0xd,
2690         RATE_MIMO2_54M_PLCP = 0xe,
2691         RATE_MIMO2_60M_PLCP = 0xf,
2692         RATE_SISO_INVM_PLCP,
2693         RATE_MIMO2_INVM_PLCP = RATE_SISO_INVM_PLCP,
2694 };
2695
2696 /* MAC header values for bit rates */
2697 enum {
2698         RATE_6M_IEEE = 12,
2699         RATE_9M_IEEE = 18,
2700         RATE_12M_IEEE = 24,
2701         RATE_18M_IEEE = 36,
2702         RATE_24M_IEEE = 48,
2703         RATE_36M_IEEE = 72,
2704         RATE_48M_IEEE = 96,
2705         RATE_54M_IEEE = 108,
2706         RATE_60M_IEEE = 120,
2707         RATE_1M_IEEE = 2,
2708         RATE_2M_IEEE = 4,
2709         RATE_5M_IEEE = 11,
2710         RATE_11M_IEEE = 22,
2711 };
2712
2713 #define IL_CCK_BASIC_RATES_MASK    \
2714         (RATE_1M_MASK          | \
2715         RATE_2M_MASK)
2716
2717 #define IL_CCK_RATES_MASK          \
2718         (IL_CCK_BASIC_RATES_MASK  | \
2719         RATE_5M_MASK          | \
2720         RATE_11M_MASK)
2721
2722 #define IL_OFDM_BASIC_RATES_MASK   \
2723         (RATE_6M_MASK         | \
2724         RATE_12M_MASK         | \
2725         RATE_24M_MASK)
2726
2727 #define IL_OFDM_RATES_MASK         \
2728         (IL_OFDM_BASIC_RATES_MASK | \
2729         RATE_9M_MASK          | \
2730         RATE_18M_MASK         | \
2731         RATE_36M_MASK         | \
2732         RATE_48M_MASK         | \
2733         RATE_54M_MASK)
2734
2735 #define IL_BASIC_RATES_MASK         \
2736         (IL_OFDM_BASIC_RATES_MASK | \
2737          IL_CCK_BASIC_RATES_MASK)
2738
2739 #define RATES_MASK ((1 << RATE_COUNT) - 1)
2740 #define RATES_MASK_3945 ((1 << RATE_COUNT_3945) - 1)
2741
2742 #define IL_INVALID_VALUE    -1
2743
2744 #define IL_MIN_RSSI_VAL                 -100
2745 #define IL_MAX_RSSI_VAL                    0
2746
2747 /* These values specify how many Tx frame attempts before
2748  * searching for a new modulation mode */
2749 #define IL_LEGACY_FAILURE_LIMIT 160
2750 #define IL_LEGACY_SUCCESS_LIMIT 480
2751 #define IL_LEGACY_TBL_COUNT             160
2752
2753 #define IL_NONE_LEGACY_FAILURE_LIMIT    400
2754 #define IL_NONE_LEGACY_SUCCESS_LIMIT    4500
2755 #define IL_NONE_LEGACY_TBL_COUNT        1500
2756
2757 /* Success ratio (ACKed / attempted tx frames) values (perfect is 128 * 100) */
2758 #define IL_RS_GOOD_RATIO                12800   /* 100% */
2759 #define RATE_SCALE_SWITCH               10880   /*  85% */
2760 #define RATE_HIGH_TH            10880   /*  85% */
2761 #define RATE_INCREASE_TH                6400    /*  50% */
2762 #define RATE_DECREASE_TH                1920    /*  15% */
2763
2764 /* possible actions when in legacy mode */
2765 #define IL_LEGACY_SWITCH_ANTENNA1      0
2766 #define IL_LEGACY_SWITCH_ANTENNA2      1
2767 #define IL_LEGACY_SWITCH_SISO          2
2768 #define IL_LEGACY_SWITCH_MIMO2_AB      3
2769 #define IL_LEGACY_SWITCH_MIMO2_AC      4
2770 #define IL_LEGACY_SWITCH_MIMO2_BC      5
2771
2772 /* possible actions when in siso mode */
2773 #define IL_SISO_SWITCH_ANTENNA1        0
2774 #define IL_SISO_SWITCH_ANTENNA2        1
2775 #define IL_SISO_SWITCH_MIMO2_AB        2
2776 #define IL_SISO_SWITCH_MIMO2_AC        3
2777 #define IL_SISO_SWITCH_MIMO2_BC        4
2778 #define IL_SISO_SWITCH_GI              5
2779
2780 /* possible actions when in mimo mode */
2781 #define IL_MIMO2_SWITCH_ANTENNA1       0
2782 #define IL_MIMO2_SWITCH_ANTENNA2       1
2783 #define IL_MIMO2_SWITCH_SISO_A         2
2784 #define IL_MIMO2_SWITCH_SISO_B         3
2785 #define IL_MIMO2_SWITCH_SISO_C         4
2786 #define IL_MIMO2_SWITCH_GI             5
2787
2788 #define IL_MAX_SEARCH IL_MIMO2_SWITCH_GI
2789
2790 #define IL_ACTION_LIMIT         3       /* # possible actions */
2791
2792 #define LQ_SIZE         2       /* 2 mode tables:  "Active" and "Search" */
2793
2794 /* load per tid defines for A-MPDU activation */
2795 #define IL_AGG_TPT_THREHOLD     0
2796 #define IL_AGG_LOAD_THRESHOLD   10
2797 #define IL_AGG_ALL_TID          0xff
2798 #define TID_QUEUE_CELL_SPACING  50      /*mS */
2799 #define TID_QUEUE_MAX_SIZE      20
2800 #define TID_ROUND_VALUE         5       /* mS */
2801 #define TID_MAX_LOAD_COUNT      8
2802
2803 #define TID_MAX_TIME_DIFF ((TID_QUEUE_MAX_SIZE - 1) * TID_QUEUE_CELL_SPACING)
2804 #define TIME_WRAP_AROUND(x, y) (((y) > (x)) ? (y) - (x) : (0-(x)) + (y))
2805
2806 extern const struct il_rate_info il_rates[RATE_COUNT];
2807
2808 enum il_table_type {
2809         LQ_NONE,
2810         LQ_G,                   /* legacy types */
2811         LQ_A,
2812         LQ_SISO,                /* high-throughput types */
2813         LQ_MIMO2,
2814         LQ_MAX,
2815 };
2816
2817 #define is_legacy(tbl) ((tbl) == LQ_G || (tbl) == LQ_A)
2818 #define is_siso(tbl) ((tbl) == LQ_SISO)
2819 #define is_mimo2(tbl) ((tbl) == LQ_MIMO2)
2820 #define is_mimo(tbl) (is_mimo2(tbl))
2821 #define is_Ht(tbl) (is_siso(tbl) || is_mimo(tbl))
2822 #define is_a_band(tbl) ((tbl) == LQ_A)
2823 #define is_g_and(tbl) ((tbl) == LQ_G)
2824
2825 #define ANT_NONE        0x0
2826 #define ANT_A           BIT(0)
2827 #define ANT_B           BIT(1)
2828 #define ANT_AB          (ANT_A | ANT_B)
2829 #define ANT_C           BIT(2)
2830 #define ANT_AC          (ANT_A | ANT_C)
2831 #define ANT_BC          (ANT_B | ANT_C)
2832 #define ANT_ABC         (ANT_AB | ANT_C)
2833
2834 #define IL_MAX_MCS_DISPLAY_SIZE 12
2835
2836 struct il_rate_mcs_info {
2837         char mbps[IL_MAX_MCS_DISPLAY_SIZE];
2838         char mcs[IL_MAX_MCS_DISPLAY_SIZE];
2839 };
2840
2841 /**
2842  * struct il_rate_scale_data -- tx success history for one rate
2843  */
2844 struct il_rate_scale_data {
2845         u64 data;               /* bitmap of successful frames */
2846         s32 success_counter;    /* number of frames successful */
2847         s32 success_ratio;      /* per-cent * 128  */
2848         s32 counter;            /* number of frames attempted */
2849         s32 average_tpt;        /* success ratio * expected throughput */
2850         unsigned long stamp;
2851 };
2852
2853 /**
2854  * struct il_scale_tbl_info -- tx params and success history for all rates
2855  *
2856  * There are two of these in struct il_lq_sta,
2857  * one for "active", and one for "search".
2858  */
2859 struct il_scale_tbl_info {
2860         enum il_table_type lq_type;
2861         u8 ant_type;
2862         u8 is_SGI;              /* 1 = short guard interval */
2863         u8 is_ht40;             /* 1 = 40 MHz channel width */
2864         u8 is_dup;              /* 1 = duplicated data streams */
2865         u8 action;              /* change modulation; IL_[LEGACY/SISO/MIMO]_SWITCH_* */
2866         u8 max_search;          /* maximun number of tables we can search */
2867         s32 *expected_tpt;      /* throughput metrics; expected_tpt_G, etc. */
2868         u32 current_rate;       /* rate_n_flags, uCode API format */
2869         struct il_rate_scale_data win[RATE_COUNT];      /* rate histories */
2870 };
2871
2872 struct il_traffic_load {
2873         unsigned long time_stamp;       /* age of the oldest stats */
2874         u32 packet_count[TID_QUEUE_MAX_SIZE];   /* packet count in this time
2875                                                  * slice */
2876         u32 total;              /* total num of packets during the
2877                                  * last TID_MAX_TIME_DIFF */
2878         u8 queue_count;         /* number of queues that has
2879                                  * been used since the last cleanup */
2880         u8 head;                /* start of the circular buffer */
2881 };
2882
2883 /**
2884  * struct il_lq_sta -- driver's rate scaling ilate structure
2885  *
2886  * Pointer to this gets passed back and forth between driver and mac80211.
2887  */
2888 struct il_lq_sta {
2889         u8 active_tbl;          /* idx of active table, range 0-1 */
2890         u8 enable_counter;      /* indicates HT mode */
2891         u8 stay_in_tbl;         /* 1: disallow, 0: allow search for new mode */
2892         u8 search_better_tbl;   /* 1: currently trying alternate mode */
2893         s32 last_tpt;
2894
2895         /* The following determine when to search for a new mode */
2896         u32 table_count_limit;
2897         u32 max_failure_limit;  /* # failed frames before new search */
2898         u32 max_success_limit;  /* # successful frames before new search */
2899         u32 table_count;
2900         u32 total_failed;       /* total failed frames, any/all rates */
2901         u32 total_success;      /* total successful frames, any/all rates */
2902         u64 flush_timer;        /* time staying in mode before new search */
2903
2904         u8 action_counter;      /* # mode-switch actions tried */
2905         u8 is_green;
2906         u8 is_dup;
2907         enum ieee80211_band band;
2908
2909         /* The following are bitmaps of rates; RATE_6M_MASK, etc. */
2910         u32 supp_rates;
2911         u16 active_legacy_rate;
2912         u16 active_siso_rate;
2913         u16 active_mimo2_rate;
2914         s8 max_rate_idx;        /* Max rate set by user */
2915         u8 missed_rate_counter;
2916
2917         struct il_link_quality_cmd lq;
2918         struct il_scale_tbl_info lq_info[LQ_SIZE];      /* "active", "search" */
2919         struct il_traffic_load load[TID_MAX_LOAD_COUNT];
2920         u8 tx_agg_tid_en;
2921 #ifdef CONFIG_MAC80211_DEBUGFS
2922         struct dentry *rs_sta_dbgfs_scale_table_file;
2923         struct dentry *rs_sta_dbgfs_stats_table_file;
2924         struct dentry *rs_sta_dbgfs_rate_scale_data_file;
2925         struct dentry *rs_sta_dbgfs_tx_agg_tid_en_file;
2926         u32 dbg_fixed_rate;
2927 #endif
2928         struct il_priv *drv;
2929
2930         /* used to be in sta_info */
2931         int last_txrate_idx;
2932         /* last tx rate_n_flags */
2933         u32 last_rate_n_flags;
2934         /* packets destined for this STA are aggregated */
2935         u8 is_agg;
2936 };
2937
2938 /*
2939  * il_station_priv: Driver's ilate station information
2940  *
2941  * When mac80211 creates a station it reserves some space (hw->sta_data_size)
2942  * in the structure for use by driver. This structure is places in that
2943  * space.
2944  *
2945  * The common struct MUST be first because it is shared between
2946  * 3945 and 4965!
2947  */
2948 struct il_station_priv {
2949         struct il_station_priv_common common;
2950         struct il_lq_sta lq_sta;
2951         atomic_t pending_frames;
2952         bool client;
2953         bool asleep;
2954 };
2955
2956 static inline u8
2957 il4965_num_of_ant(u8 m)
2958 {
2959         return !!(m & ANT_A) + !!(m & ANT_B) + !!(m & ANT_C);
2960 }
2961
2962 static inline u8
2963 il4965_first_antenna(u8 mask)
2964 {
2965         if (mask & ANT_A)
2966                 return ANT_A;
2967         if (mask & ANT_B)
2968                 return ANT_B;
2969         return ANT_C;
2970 }
2971
2972 /**
2973  * il3945_rate_scale_init - Initialize the rate scale table based on assoc info
2974  *
2975  * The specific throughput table used is based on the type of network
2976  * the associated with, including A, B, G, and G w/ TGG protection
2977  */
2978 extern void il3945_rate_scale_init(struct ieee80211_hw *hw, s32 sta_id);
2979
2980 /* Initialize station's rate scaling information after adding station */
2981 extern void il4965_rs_rate_init(struct il_priv *il, struct ieee80211_sta *sta,
2982                                 u8 sta_id);
2983 extern void il3945_rs_rate_init(struct il_priv *il, struct ieee80211_sta *sta,
2984                                 u8 sta_id);
2985
2986 /**
2987  * il_rate_control_register - Register the rate control algorithm callbacks
2988  *
2989  * Since the rate control algorithm is hardware specific, there is no need
2990  * or reason to place it as a stand alone module.  The driver can call
2991  * il_rate_control_register in order to register the rate control callbacks
2992  * with the mac80211 subsystem.  This should be performed prior to calling
2993  * ieee80211_register_hw
2994  *
2995  */
2996 extern int il4965_rate_control_register(void);
2997 extern int il3945_rate_control_register(void);
2998
2999 /**
3000  * il_rate_control_unregister - Unregister the rate control callbacks
3001  *
3002  * This should be called after calling ieee80211_unregister_hw, but before
3003  * the driver is unloaded.
3004  */
3005 extern void il4965_rate_control_unregister(void);
3006 extern void il3945_rate_control_unregister(void);
3007
3008 extern int il_power_update_mode(struct il_priv *il, bool force);
3009 extern void il_power_initialize(struct il_priv *il);
3010
3011 extern u32 il_debug_level;
3012
3013 #ifdef CONFIG_IWLEGACY_DEBUG
3014 /*
3015  * il_get_debug_level: Return active debug level for device
3016  *
3017  * Using sysfs it is possible to set per device debug level. This debug
3018  * level will be used if set, otherwise the global debug level which can be
3019  * set via module parameter is used.
3020  */
3021 static inline u32
3022 il_get_debug_level(struct il_priv *il)
3023 {
3024         if (il->debug_level)
3025                 return il->debug_level;
3026         else
3027                 return il_debug_level;
3028 }
3029 #else
3030 static inline u32
3031 il_get_debug_level(struct il_priv *il)
3032 {
3033         return il_debug_level;
3034 }
3035 #endif
3036
3037 #define il_print_hex_error(il, p, len)                                  \
3038 do {                                                                    \
3039         print_hex_dump(KERN_ERR, "iwl data: ",                          \
3040                        DUMP_PREFIX_OFFSET, 16, 1, p, len, 1);           \
3041 } while (0)
3042
3043 #ifdef CONFIG_IWLEGACY_DEBUG
3044 #define IL_DBG(level, fmt, args...)                                     \
3045 do {                                                                    \
3046         if (il_get_debug_level(il) & level)                             \
3047                 dev_printk(KERN_ERR, &il->hw->wiphy->dev,               \
3048                          "%c %s " fmt, in_interrupt() ? 'I' : 'U',      \
3049                         __func__ , ## args);                            \
3050 } while (0)
3051
3052 #define il_print_hex_dump(il, level, p, len)                            \
3053 do {                                                                    \
3054         if (il_get_debug_level(il) & level)                             \
3055                 print_hex_dump(KERN_DEBUG, "iwl data: ",                \
3056                                DUMP_PREFIX_OFFSET, 16, 1, p, len, 1);   \
3057 } while (0)
3058
3059 #else
3060 #define IL_DBG(level, fmt, args...)
3061 static inline void
3062 il_print_hex_dump(struct il_priv *il, int level, const void *p, u32 len)
3063 {
3064 }
3065 #endif /* CONFIG_IWLEGACY_DEBUG */
3066
3067 #ifdef CONFIG_IWLEGACY_DEBUGFS
3068 int il_dbgfs_register(struct il_priv *il, const char *name);
3069 void il_dbgfs_unregister(struct il_priv *il);
3070 #else
3071 static inline int
3072 il_dbgfs_register(struct il_priv *il, const char *name)
3073 {
3074         return 0;
3075 }
3076
3077 static inline void
3078 il_dbgfs_unregister(struct il_priv *il)
3079 {
3080 }
3081 #endif /* CONFIG_IWLEGACY_DEBUGFS */
3082
3083 /*
3084  * To use the debug system:
3085  *
3086  * If you are defining a new debug classification, simply add it to the #define
3087  * list here in the form of
3088  *
3089  * #define IL_DL_xxxx VALUE
3090  *
3091  * where xxxx should be the name of the classification (for example, WEP).
3092  *
3093  * You then need to either add a IL_xxxx_DEBUG() macro definition for your
3094  * classification, or use IL_DBG(IL_DL_xxxx, ...) whenever you want
3095  * to send output to that classification.
3096  *
3097  * The active debug levels can be accessed via files
3098  *
3099  *      /sys/module/iwl4965/parameters/debug
3100  *      /sys/module/iwl3945/parameters/debug
3101  *      /sys/class/net/wlan0/device/debug_level
3102  *
3103  * when CONFIG_IWLEGACY_DEBUG=y.
3104  */
3105
3106 /* 0x0000000F - 0x00000001 */
3107 #define IL_DL_INFO              (1 << 0)
3108 #define IL_DL_MAC80211          (1 << 1)
3109 #define IL_DL_HCMD              (1 << 2)
3110 #define IL_DL_STATE             (1 << 3)
3111 /* 0x000000F0 - 0x00000010 */
3112 #define IL_DL_MACDUMP           (1 << 4)
3113 #define IL_DL_HCMD_DUMP         (1 << 5)
3114 #define IL_DL_EEPROM            (1 << 6)
3115 #define IL_DL_RADIO             (1 << 7)
3116 /* 0x00000F00 - 0x00000100 */
3117 #define IL_DL_POWER             (1 << 8)
3118 #define IL_DL_TEMP              (1 << 9)
3119 #define IL_DL_NOTIF             (1 << 10)
3120 #define IL_DL_SCAN              (1 << 11)
3121 /* 0x0000F000 - 0x00001000 */
3122 #define IL_DL_ASSOC             (1 << 12)
3123 #define IL_DL_DROP              (1 << 13)
3124 #define IL_DL_TXPOWER           (1 << 14)
3125 #define IL_DL_AP                (1 << 15)
3126 /* 0x000F0000 - 0x00010000 */
3127 #define IL_DL_FW                (1 << 16)
3128 #define IL_DL_RF_KILL           (1 << 17)
3129 #define IL_DL_FW_ERRORS         (1 << 18)
3130 #define IL_DL_LED               (1 << 19)
3131 /* 0x00F00000 - 0x00100000 */
3132 #define IL_DL_RATE              (1 << 20)
3133 #define IL_DL_CALIB             (1 << 21)
3134 #define IL_DL_WEP               (1 << 22)
3135 #define IL_DL_TX                (1 << 23)
3136 /* 0x0F000000 - 0x01000000 */
3137 #define IL_DL_RX                (1 << 24)
3138 #define IL_DL_ISR               (1 << 25)
3139 #define IL_DL_HT                (1 << 26)
3140 /* 0xF0000000 - 0x10000000 */
3141 #define IL_DL_11H               (1 << 28)
3142 #define IL_DL_STATS             (1 << 29)
3143 #define IL_DL_TX_REPLY          (1 << 30)
3144 #define IL_DL_QOS               (1 << 31)
3145
3146 #define D_INFO(f, a...)         IL_DBG(IL_DL_INFO, f, ## a)
3147 #define D_MAC80211(f, a...)     IL_DBG(IL_DL_MAC80211, f, ## a)
3148 #define D_MACDUMP(f, a...)      IL_DBG(IL_DL_MACDUMP, f, ## a)
3149 #define D_TEMP(f, a...)         IL_DBG(IL_DL_TEMP, f, ## a)
3150 #define D_SCAN(f, a...)         IL_DBG(IL_DL_SCAN, f, ## a)
3151 #define D_RX(f, a...)           IL_DBG(IL_DL_RX, f, ## a)
3152 #define D_TX(f, a...)           IL_DBG(IL_DL_TX, f, ## a)
3153 #define D_ISR(f, a...)          IL_DBG(IL_DL_ISR, f, ## a)
3154 #define D_LED(f, a...)          IL_DBG(IL_DL_LED, f, ## a)
3155 #define D_WEP(f, a...)          IL_DBG(IL_DL_WEP, f, ## a)
3156 #define D_HC(f, a...)           IL_DBG(IL_DL_HCMD, f, ## a)
3157 #define D_HC_DUMP(f, a...)      IL_DBG(IL_DL_HCMD_DUMP, f, ## a)
3158 #define D_EEPROM(f, a...)       IL_DBG(IL_DL_EEPROM, f, ## a)
3159 #define D_CALIB(f, a...)        IL_DBG(IL_DL_CALIB, f, ## a)
3160 #define D_FW(f, a...)           IL_DBG(IL_DL_FW, f, ## a)
3161 #define D_RF_KILL(f, a...)      IL_DBG(IL_DL_RF_KILL, f, ## a)
3162 #define D_DROP(f, a...)         IL_DBG(IL_DL_DROP, f, ## a)
3163 #define D_AP(f, a...)           IL_DBG(IL_DL_AP, f, ## a)
3164 #define D_TXPOWER(f, a...)      IL_DBG(IL_DL_TXPOWER, f, ## a)
3165 #define D_RATE(f, a...)         IL_DBG(IL_DL_RATE, f, ## a)
3166 #define D_NOTIF(f, a...)        IL_DBG(IL_DL_NOTIF, f, ## a)
3167 #define D_ASSOC(f, a...)        IL_DBG(IL_DL_ASSOC, f, ## a)
3168 #define D_HT(f, a...)           IL_DBG(IL_DL_HT, f, ## a)
3169 #define D_STATS(f, a...)        IL_DBG(IL_DL_STATS, f, ## a)
3170 #define D_TX_REPLY(f, a...)     IL_DBG(IL_DL_TX_REPLY, f, ## a)
3171 #define D_QOS(f, a...)          IL_DBG(IL_DL_QOS, f, ## a)
3172 #define D_RADIO(f, a...)        IL_DBG(IL_DL_RADIO, f, ## a)
3173 #define D_POWER(f, a...)        IL_DBG(IL_DL_POWER, f, ## a)
3174 #define D_11H(f, a...)          IL_DBG(IL_DL_11H, f, ## a)
3175
3176 #endif /* __il_core_h__ */