Linux Audio

Check our new training course

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