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