iwl-commands.h 134.5 KB
Newer Older
Z
Zhu Yi 已提交
1 2 3 4 5 6 7
/******************************************************************************
 *
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
8
 * Copyright(c) 2005 - 2010 Intel Corporation. All rights reserved.
Z
Zhu Yi 已提交
9 10
 *
 * This program is free software; you can redistribute it and/or modify
11
 * it under the terms of version 2 of the GNU General Public License as
Z
Zhu Yi 已提交
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
 * USA
 *
 * The full GNU General Public License is included in this distribution
 * in the file called LICENSE.GPL.
 *
 * Contact Information:
28
 *  Intel Linux Wireless <ilw@linux.intel.com>
Z
Zhu Yi 已提交
29 30 31 32
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 * BSD LICENSE
 *
33
 * Copyright(c) 2005 - 2010 Intel Corporation. All rights reserved.
Z
Zhu Yi 已提交
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name Intel Corporation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
63
/*
64
 * Please use this file (iwl-commands.h) only for uCode API definitions.
W
Wey-Yi Guy 已提交
65
 * Please use iwl-xxxx-hw.h for hardware-related definitions.
66
 * Please use iwl-dev.h for driver implementation definitions.
67
 */
Z
Zhu Yi 已提交
68

69 70
#ifndef __iwl_commands_h__
#define __iwl_commands_h__
Z
Zhu Yi 已提交
71

72 73
struct iwl_priv;

74 75 76 77 78 79
/* uCode version contains 4 values: Major/Minor/API/Serial */
#define IWL_UCODE_MAJOR(ver)	(((ver) & 0xFF000000) >> 24)
#define IWL_UCODE_MINOR(ver)	(((ver) & 0x00FF0000) >> 16)
#define IWL_UCODE_API(ver)	(((ver) & 0x0000FF00) >> 8)
#define IWL_UCODE_SERIAL(ver)	((ver) & 0x000000FF)

80 81 82 83 84 85

/* Tx rates */
#define IWL_CCK_RATES	4
#define IWL_OFDM_RATES	8
#define IWL_MAX_RATES	(IWL_CCK_RATES + IWL_OFDM_RATES)

Z
Zhu Yi 已提交
86 87 88 89 90 91 92 93 94 95 96 97
enum {
	REPLY_ALIVE = 0x1,
	REPLY_ERROR = 0x2,

	/* RXON and QOS commands */
	REPLY_RXON = 0x10,
	REPLY_RXON_ASSOC = 0x11,
	REPLY_QOS_PARAM = 0x13,
	REPLY_RXON_TIMING = 0x14,

	/* Multi-Station support */
	REPLY_ADD_STA = 0x18,
W
Wey-Yi Guy 已提交
98
	REPLY_REMOVE_STA = 0x19,
Z
Zhu Yi 已提交
99
	REPLY_REMOVE_ALL_STA = 0x1a,	/* not used */
100
	REPLY_TXFIFO_FLUSH = 0x1e,
Z
Zhu Yi 已提交
101

102 103 104
	/* Security */
	REPLY_WEPKEY = 0x20,

Z
Zhu Yi 已提交
105
	/* RX, TX, LEDs */
106
	REPLY_3945_RX = 0x1b,           /* 3945 only */
Z
Zhu Yi 已提交
107 108 109
	REPLY_TX = 0x1c,
	REPLY_RATE_SCALE = 0x47,	/* 3945 only */
	REPLY_LEDS_CMD = 0x48,
W
Wey-Yi Guy 已提交
110
	REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* for 4965 and up */
Z
Zhu Yi 已提交
111

112
	/* WiMAX coexistence */
113
	COEX_PRIORITY_TABLE_CMD = 0x5a,	/* for 5000 series and up */
114 115 116
	COEX_MEDIUM_NOTIFICATION = 0x5b,
	COEX_EVENT_CMD = 0x5c,

117
	/* Calibration */
118
	TEMPERATURE_NOTIFICATION = 0x62,
119 120 121 122
	CALIBRATION_CFG_CMD = 0x65,
	CALIBRATION_RES_NOTIFICATION = 0x66,
	CALIBRATION_COMPLETE_NOTIFICATION = 0x67,

Z
Zhu Yi 已提交
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
	/* 802.11h related */
	REPLY_QUIET_CMD = 0x71,		/* not used */
	REPLY_CHANNEL_SWITCH = 0x72,
	CHANNEL_SWITCH_NOTIFICATION = 0x73,
	REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
	SPECTRUM_MEASURE_NOTIFICATION = 0x75,

	/* Power Management */
	POWER_TABLE_CMD = 0x77,
	PM_SLEEP_NOTIFICATION = 0x7A,
	PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,

	/* Scan commands and notifications */
	REPLY_SCAN_CMD = 0x80,
	REPLY_SCAN_ABORT_CMD = 0x81,
	SCAN_START_NOTIFICATION = 0x82,
	SCAN_RESULTS_NOTIFICATION = 0x83,
	SCAN_COMPLETE_NOTIFICATION = 0x84,

	/* IBSS/AP commands */
	BEACON_NOTIFICATION = 0x90,
	REPLY_TX_BEACON = 0x91,
	WHO_IS_AWAKE_NOTIFICATION = 0x94,	/* not used */

	/* Miscellaneous commands */
148
	REPLY_TX_POWER_DBM_CMD = 0x95,
Z
Zhu Yi 已提交
149 150
	QUIET_NOTIFICATION = 0x96,		/* not used */
	REPLY_TX_PWR_TABLE_CMD = 0x97,
151
	REPLY_TX_POWER_DBM_CMD_V1 = 0x98,	/* old version of API */
152
	TX_ANT_CONFIGURATION_CMD = 0x98,
Z
Zhu Yi 已提交
153 154
	MEASURE_ABORT_NOTIFICATION = 0x99,	/* not used */

T
Tomas Winkler 已提交
155
	/* Bluetooth device coexistence config command */
Z
Zhu Yi 已提交
156 157
	REPLY_BT_CONFIG = 0x9b,

158
	/* Statistics */
Z
Zhu Yi 已提交
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
	REPLY_STATISTICS_CMD = 0x9c,
	STATISTICS_NOTIFICATION = 0x9d,

	/* RF-KILL commands and notifications */
	REPLY_CARD_STATE_CMD = 0xa0,
	CARD_STATE_NOTIFICATION = 0xa1,

	/* Missed beacons notification */
	MISSED_BEACONS_NOTIFICATION = 0xa2,

	REPLY_CT_KILL_CONFIG_CMD = 0xa4,
	SENSITIVITY_CMD = 0xa8,
	REPLY_PHY_CALIBRATION_CMD = 0xb0,
	REPLY_RX_PHY_CMD = 0xc0,
	REPLY_RX_MPDU_CMD = 0xc1,
174
	REPLY_RX = 0xc3,
Z
Zhu Yi 已提交
175
	REPLY_COMPRESSED_BA = 0xc5,
176 177 178 179 180 181

	/* BT Coex */
	REPLY_BT_COEX_PRIO_TABLE = 0xcc,
	REPLY_BT_COEX_PROT_ENV = 0xcd,
	REPLY_BT_COEX_PROFILE_NOTIF = 0xce,

Z
Zhu Yi 已提交
182 183 184 185 186
	REPLY_MAX = 0xff
};

/******************************************************************************
 * (0)
187
 * Commonly used structures and definitions:
188
 * Command header, rate_n_flags, txpower
Z
Zhu Yi 已提交
189 190 191
 *
 *****************************************************************************/

192
/* iwl_cmd_header flags value */
Z
Zhu Yi 已提交
193 194
#define IWL_CMD_FAILED_MSK 0x40

195 196 197 198
#define SEQ_TO_QUEUE(s)	(((s) >> 8) & 0x1f)
#define QUEUE_TO_SEQ(q)	(((q) & 0x1f) << 8)
#define SEQ_TO_INDEX(s)	((s) & 0xff)
#define INDEX_TO_SEQ(i)	((i) & 0xff)
199 200
#define SEQ_HUGE_FRAME	cpu_to_le16(0x4000)
#define SEQ_RX_FRAME	cpu_to_le16(0x8000)
201

202
/**
203
 * struct iwl_cmd_header
204 205 206 207
 *
 * This header format appears in the beginning of each command sent from the
 * driver, and each response/notification received from uCode.
 */
208
struct iwl_cmd_header {
209
	u8 cmd;		/* Command ID:  REPLY_RXON, etc. */
210
	u8 flags;	/* 0:5 reserved, 6 abort, 7 internal */
211
	/*
T
Tomas Winkler 已提交
212
	 * The driver sets up the sequence number to values of its choosing.
213 214 215 216
	 * uCode does not use this value, but passes it back to the driver
	 * when sending the response to each driver-originated command, so
	 * the driver can match the response to the command.  Since the values
	 * don't get used by uCode, the driver may set up an arbitrary format.
Z
Zhu Yi 已提交
217
	 *
218 219 220 221 222
	 * There is one exception:  uCode sets bit 15 when it originates
	 * the response/notification, i.e. when the response/notification
	 * is not a direct response to a command sent by the driver.  For
	 * example, uCode issues REPLY_3945_RX when it sends a received frame
	 * to the driver; it is not a direct response to any driver command.
Z
Zhu Yi 已提交
223
	 *
224 225
	 * The Linux driver uses the following format:
	 *
226 227 228 229 230 231
	 *  0:7		tfd index - position within TX queue
	 *  8:12	TX queue id
	 *  13		reserved
	 *  14		huge - driver sets this to indicate command is in the
	 *  		'huge' storage at the end of the command buffers
	 *  15		unsolicited RX or uCode-originated notification
Z
Zhu Yi 已提交
232 233 234
	 */
	__le16 sequence;

235
	/* command or response/notification data follows immediately */
Z
Zhu Yi 已提交
236
	u8 data[0];
237
} __packed;
Z
Zhu Yi 已提交
238

239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

/**
 * struct iwl3945_tx_power
 *
 * Used in REPLY_TX_PWR_TABLE_CMD, REPLY_SCAN_CMD, REPLY_CHANNEL_SWITCH
 *
 * Each entry contains two values:
 * 1)  DSP gain (or sometimes called DSP attenuation).  This is a fine-grained
 *     linear value that multiplies the output of the digital signal processor,
 *     before being sent to the analog radio.
 * 2)  Radio gain.  This sets the analog gain of the radio Tx path.
 *     It is a coarser setting, and behaves in a logarithmic (dB) fashion.
 *
 * Driver obtains values from struct iwl3945_tx_power power_gain_table[][].
 */
struct iwl3945_tx_power {
	u8 tx_gain;		/* gain for analog radio */
	u8 dsp_atten;		/* gain for DSP */
257
} __packed;
258 259 260 261 262 263 264 265 266 267

/**
 * struct iwl3945_power_per_rate
 *
 * Used in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
 */
struct iwl3945_power_per_rate {
	u8 rate;		/* plcp */
	struct iwl3945_tx_power tpc;
	u8 reserved;
268
} __packed;
269

270
/**
271
 * iwlagn rate_n_flags bit fields
272
 *
273
 * rate_n_flags format is used in following iwlagn commands:
274
 *  REPLY_RX (response only)
275
 *  REPLY_RX_MPDU (response only)
276 277 278 279 280 281 282 283 284 285 286 287 288
 *  REPLY_TX (both command and response)
 *  REPLY_TX_LINK_QUALITY_CMD
 *
 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
 *  2-0:  0)   6 Mbps
 *        1)  12 Mbps
 *        2)  18 Mbps
 *        3)  24 Mbps
 *        4)  36 Mbps
 *        5)  48 Mbps
 *        6)  54 Mbps
 *        7)  60 Mbps
 *
289
 *  4-3:  0)  Single stream (SISO)
290
 *        1)  Dual stream (MIMO)
291
 *        2)  Triple stream (MIMO)
292
 *
293
 *    5:  Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data
294 295 296 297 298 299 300 301 302 303 304 305
 *
 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
 *  3-0:  0xD)   6 Mbps
 *        0xF)   9 Mbps
 *        0x5)  12 Mbps
 *        0x7)  18 Mbps
 *        0x9)  24 Mbps
 *        0xB)  36 Mbps
 *        0x1)  48 Mbps
 *        0x3)  54 Mbps
 *
 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
306
 *  6-0:   10)  1 Mbps
307 308 309 310 311
 *         20)  2 Mbps
 *         55)  5.5 Mbps
 *        110)  11 Mbps
 */
#define RATE_MCS_CODE_MSK 0x7
312 313
#define RATE_MCS_SPATIAL_POS 3
#define RATE_MCS_SPATIAL_MSK 0x18
314 315 316
#define RATE_MCS_HT_DUP_POS 5
#define RATE_MCS_HT_DUP_MSK 0x20

317
/* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
318 319 320 321
#define RATE_MCS_FLAGS_POS 8
#define RATE_MCS_HT_POS 8
#define RATE_MCS_HT_MSK 0x100

322
/* Bit 9: (1) CCK, (0) OFDM.  HT (bit 8) must be "0" for this bit to be valid */
323 324 325
#define RATE_MCS_CCK_POS 9
#define RATE_MCS_CCK_MSK 0x200

326
/* Bit 10: (1) Use Green Field preamble */
327 328 329
#define RATE_MCS_GF_POS 10
#define RATE_MCS_GF_MSK 0x400

330 331 332
/* Bit 11: (1) Use 40Mhz HT40 chnl width, (0) use 20 MHz legacy chnl width */
#define RATE_MCS_HT40_POS 11
#define RATE_MCS_HT40_MSK 0x800
333

334
/* Bit 12: (1) Duplicate data on both 20MHz chnls. HT40 (bit 11) must be set. */
335 336 337
#define RATE_MCS_DUP_POS 12
#define RATE_MCS_DUP_MSK 0x1000

338
/* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
339 340 341 342
#define RATE_MCS_SGI_POS 13
#define RATE_MCS_SGI_MSK 0x2000

/**
T
Tomas Winkler 已提交
343 344 345 346 347 348 349
 * rate_n_flags Tx antenna masks
 * 4965 has 2 transmitters
 * 5100 has 1 transmitter B
 * 5150 has 1 transmitter A
 * 5300 has 3 transmitters
 * 5350 has 3 transmitters
 * bit14:16
350
 */
351 352 353 354 355 356
#define RATE_MCS_ANT_POS	14
#define RATE_MCS_ANT_A_MSK	0x04000
#define RATE_MCS_ANT_B_MSK	0x08000
#define RATE_MCS_ANT_C_MSK	0x10000
#define RATE_MCS_ANT_AB_MSK	(RATE_MCS_ANT_A_MSK | RATE_MCS_ANT_B_MSK)
#define RATE_MCS_ANT_ABC_MSK	(RATE_MCS_ANT_AB_MSK | RATE_MCS_ANT_C_MSK)
T
Tomas Winkler 已提交
357
#define RATE_ANT_NUM 3
358 359 360 361 362

#define POWER_TABLE_NUM_ENTRIES			33
#define POWER_TABLE_NUM_HT_OFDM_ENTRIES		32
#define POWER_TABLE_CCK_ENTRY			32

363 364 365
#define IWL_PWR_NUM_HT_OFDM_ENTRIES		24
#define IWL_PWR_CCK_ENTRIES			2

366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
/**
 * union iwl4965_tx_power_dual_stream
 *
 * Host format used for REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
 * Use __le32 version (struct tx_power_dual_stream) when building command.
 *
 * Driver provides radio gain and DSP attenuation settings to device in pairs,
 * one value for each transmitter chain.  The first value is for transmitter A,
 * second for transmitter B.
 *
 * For SISO bit rates, both values in a pair should be identical.
 * For MIMO rates, one value may be different from the other,
 * in order to balance the Tx output between the two transmitters.
 *
 * See more details in doc for TXPOWER in iwl-4965-hw.h.
 */
union iwl4965_tx_power_dual_stream {
	struct {
		u8 radio_tx_gain[2];
		u8 dsp_predis_atten[2];
	} s;
	u32 dw;
};

/**
 * struct tx_power_dual_stream
 *
 * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
 *
 * Same format as iwl_tx_power_dual_stream, but __le32
 */
struct tx_power_dual_stream {
	__le32 dw;
399
} __packed;
400 401 402 403 404 405 406 407

/**
 * struct iwl4965_tx_power_db
 *
 * Entire table within REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
 */
struct iwl4965_tx_power_db {
	struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES];
408
} __packed;
409

410
/**
T
Tomas Winkler 已提交
411
 * Command REPLY_TX_POWER_DBM_CMD = 0x98
412 413 414
 * struct iwl5000_tx_power_dbm_cmd
 */
#define IWL50_TX_POWER_AUTO 0x7f
415 416
#define IWL50_TX_POWER_NO_CLOSED (0x1 << 6)

417 418 419 420 421
struct iwl5000_tx_power_dbm_cmd {
	s8 global_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
	u8 flags;
	s8 srv_chan_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
	u8 reserved;
422
} __packed;
423

424 425 426 427 428 429 430 431
/**
 * Command TX_ANT_CONFIGURATION_CMD = 0x98
 * This command is used to configure valid Tx antenna.
 * By default uCode concludes the valid antenna according to the radio flavor.
 * This command enables the driver to override/modify this conclusion.
 */
struct iwl_tx_ant_config_cmd {
	__le32 valid;
432
} __packed;
433

Z
Zhu Yi 已提交
434 435 436 437 438 439
/******************************************************************************
 * (0a)
 * Alive and Error Commands & Responses:
 *
 *****************************************************************************/

440
#define UCODE_VALID_OK	cpu_to_le32(0x1)
Z
Zhu Yi 已提交
441 442 443
#define INITIALIZE_SUBTYPE    (9)

/*
444 445 446 447 448 449 450 451 452 453 454 455 456
 * ("Initialize") REPLY_ALIVE = 0x1 (response only, not a command)
 *
 * uCode issues this "initialize alive" notification once the initialization
 * uCode image has completed its work, and is ready to load the runtime image.
 * This is the *first* "alive" notification that the driver will receive after
 * rebooting uCode; the "initialize" alive is indicated by subtype field == 9.
 *
 * See comments documenting "BSM" (bootstrap state machine).
 *
 * For 4965, this notification contains important calibration data for
 * calculating txpower settings:
 *
 * 1)  Power supply voltage indication.  The voltage sensor outputs higher
T
Tomas Winkler 已提交
457
 *     values for lower voltage, and vice verse.
458 459 460 461 462 463 464 465
 *
 * 2)  Temperature measurement parameters, for each of two channel widths
 *     (20 MHz and 40 MHz) supported by the radios.  Temperature sensing
 *     is done via one of the receiver chains, and channel width influences
 *     the results.
 *
 * 3)  Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation,
 *     for each of 5 frequency ranges.
Z
Zhu Yi 已提交
466
 */
467
struct iwl_init_alive_resp {
Z
Zhu Yi 已提交
468 469 470 471 472
	u8 ucode_minor;
	u8 ucode_major;
	__le16 reserved1;
	u8 sw_rev[8];
	u8 ver_type;
473
	u8 ver_subtype;		/* "9" for initialize alive */
Z
Zhu Yi 已提交
474 475 476 477 478
	__le16 reserved2;
	__le32 log_event_table_ptr;
	__le32 error_event_table_ptr;
	__le32 timestamp;
	__le32 is_valid;
479 480 481

	/* calibration values from "initialize" uCode */
	__le32 voltage;		/* signed, higher value is lower voltage */
482
	__le32 therm_r1[2];	/* signed, 1st for normal, 2nd for HT40 */
483 484 485 486 487
	__le32 therm_r2[2];	/* signed */
	__le32 therm_r3[2];	/* signed */
	__le32 therm_r4[2];	/* signed */
	__le32 tx_atten[5][2];	/* signed MIMO gain comp, 5 freq groups,
				 * 2 Tx chains */
488
} __packed;
Z
Zhu Yi 已提交
489

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521

/**
 * REPLY_ALIVE = 0x1 (response only, not a command)
 *
 * uCode issues this "alive" notification once the runtime image is ready
 * to receive commands from the driver.  This is the *second* "alive"
 * notification that the driver will receive after rebooting uCode;
 * this "alive" is indicated by subtype field != 9.
 *
 * See comments documenting "BSM" (bootstrap state machine).
 *
 * This response includes two pointers to structures within the device's
 * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
 *
 * 1)  log_event_table_ptr indicates base of the event log.  This traces
 *     a 256-entry history of uCode execution within a circular buffer.
 *     Its header format is:
 *
 *	__le32 log_size;     log capacity (in number of entries)
 *	__le32 type;         (1) timestamp with each entry, (0) no timestamp
 *	__le32 wraps;        # times uCode has wrapped to top of circular buffer
 *      __le32 write_index;  next circular buffer entry that uCode would fill
 *
 *     The header is followed by the circular buffer of log entries.  Entries
 *     with timestamps have the following format:
 *
 *	__le32 event_id;     range 0 - 1500
 *	__le32 timestamp;    low 32 bits of TSF (of network, if associated)
 *	__le32 data;         event_id-specific data value
 *
 *     Entries without timestamps contain only event_id and data.
 *
522
 *
523
 * 2)  error_event_table_ptr indicates base of the error log.  This contains
524
 *     information about any uCode error that occurs.  For agn, the format
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
 *     of the error log is:
 *
 *	__le32 valid;        (nonzero) valid, (0) log is empty
 *	__le32 error_id;     type of error
 *	__le32 pc;           program counter
 *	__le32 blink1;       branch link
 *	__le32 blink2;       branch link
 *	__le32 ilink1;       interrupt link
 *	__le32 ilink2;       interrupt link
 *	__le32 data1;        error-specific data
 *	__le32 data2;        error-specific data
 *	__le32 line;         source code line of error
 *	__le32 bcon_time;    beacon timer
 *	__le32 tsf_low;      network timestamp function timer
 *	__le32 tsf_hi;       network timestamp function timer
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
 *	__le32 gp1;          GP1 timer register
 *	__le32 gp2;          GP2 timer register
 *	__le32 gp3;          GP3 timer register
 *	__le32 ucode_ver;    uCode version
 *	__le32 hw_ver;       HW Silicon version
 *	__le32 brd_ver;      HW board version
 *	__le32 log_pc;       log program counter
 *	__le32 frame_ptr;    frame pointer
 *	__le32 stack_ptr;    stack pointer
 *	__le32 hcmd;         last host command
 *	__le32 isr0;         isr status register LMPM_NIC_ISR0: rxtx_flag
 *	__le32 isr1;         isr status register LMPM_NIC_ISR1: host_flag
 *	__le32 isr2;         isr status register LMPM_NIC_ISR2: enc_flag
 *	__le32 isr3;         isr status register LMPM_NIC_ISR3: time_flag
 *	__le32 isr4;         isr status register LMPM_NIC_ISR4: wico interrupt
 *	__le32 isr_pref;     isr status register LMPM_NIC_PREF_STAT
 *	__le32 wait_event;   wait event() caller address
 *	__le32 l2p_control;  L2pControlField
 *	__le32 l2p_duration; L2pDurationField
 *	__le32 l2p_mhvalid;  L2pMhValidBits
 *	__le32 l2p_addr_match; L2pAddrMatchStat
 *	__le32 lmpm_pmg_sel; indicate which clocks are turned on (LMPM_PMG_SEL)
 *	__le32 u_timestamp;  indicate when the date and time of the compilation
 *	__le32 reserved;
564 565 566 567
 *
 * The Linux driver can print both logs to the system log when a uCode error
 * occurs.
 */
568
struct iwl_alive_resp {
Z
Zhu Yi 已提交
569 570 571 572 573
	u8 ucode_minor;
	u8 ucode_major;
	__le16 reserved1;
	u8 sw_rev[8];
	u8 ver_type;
574
	u8 ver_subtype;			/* not "9" for runtime alive */
Z
Zhu Yi 已提交
575
	__le16 reserved2;
576 577
	__le32 log_event_table_ptr;	/* SRAM address for event log */
	__le32 error_event_table_ptr;	/* SRAM address for error log */
Z
Zhu Yi 已提交
578 579
	__le32 timestamp;
	__le32 is_valid;
580
} __packed;
Z
Zhu Yi 已提交
581 582 583 584

/*
 * REPLY_ERROR = 0x2 (response only, not a command)
 */
585
struct iwl_error_resp {
Z
Zhu Yi 已提交
586 587 588 589 590
	__le32 error_type;
	u8 cmd_id;
	u8 reserved1;
	__le16 bad_cmd_seq_num;
	__le32 error_info;
591
	__le64 timestamp;
592
} __packed;
Z
Zhu Yi 已提交
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610

/******************************************************************************
 * (1)
 * RXON Commands & Responses:
 *
 *****************************************************************************/

/*
 * Rx config defines & structure
 */
/* rx_config device types  */
enum {
	RXON_DEV_TYPE_AP = 1,
	RXON_DEV_TYPE_ESS = 3,
	RXON_DEV_TYPE_IBSS = 4,
	RXON_DEV_TYPE_SNIFFER = 6,
};

611

612
#define RXON_RX_CHAIN_DRIVER_FORCE_MSK		cpu_to_le16(0x1 << 0)
613
#define RXON_RX_CHAIN_DRIVER_FORCE_POS		(0)
614
#define RXON_RX_CHAIN_VALID_MSK			cpu_to_le16(0x7 << 1)
615
#define RXON_RX_CHAIN_VALID_POS			(1)
616
#define RXON_RX_CHAIN_FORCE_SEL_MSK		cpu_to_le16(0x7 << 4)
617
#define RXON_RX_CHAIN_FORCE_SEL_POS		(4)
618
#define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK	cpu_to_le16(0x7 << 7)
619
#define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS	(7)
620
#define RXON_RX_CHAIN_CNT_MSK			cpu_to_le16(0x3 << 10)
621
#define RXON_RX_CHAIN_CNT_POS			(10)
622
#define RXON_RX_CHAIN_MIMO_CNT_MSK		cpu_to_le16(0x3 << 12)
623
#define RXON_RX_CHAIN_MIMO_CNT_POS		(12)
624
#define RXON_RX_CHAIN_MIMO_FORCE_MSK		cpu_to_le16(0x1 << 14)
625 626
#define RXON_RX_CHAIN_MIMO_FORCE_POS		(14)

Z
Zhu Yi 已提交
627 628
/* rx_config flags */
/* band & modulation selection */
629 630
#define RXON_FLG_BAND_24G_MSK           cpu_to_le32(1 << 0)
#define RXON_FLG_CCK_MSK                cpu_to_le32(1 << 1)
Z
Zhu Yi 已提交
631
/* auto detection enable */
632
#define RXON_FLG_AUTO_DETECT_MSK        cpu_to_le32(1 << 2)
Z
Zhu Yi 已提交
633
/* TGg protection when tx */
634
#define RXON_FLG_TGG_PROTECT_MSK        cpu_to_le32(1 << 3)
Z
Zhu Yi 已提交
635
/* cck short slot & preamble */
636 637
#define RXON_FLG_SHORT_SLOT_MSK          cpu_to_le32(1 << 4)
#define RXON_FLG_SHORT_PREAMBLE_MSK     cpu_to_le32(1 << 5)
Z
Zhu Yi 已提交
638
/* antenna selection */
639 640 641 642
#define RXON_FLG_DIS_DIV_MSK            cpu_to_le32(1 << 7)
#define RXON_FLG_ANT_SEL_MSK            cpu_to_le32(0x0f00)
#define RXON_FLG_ANT_A_MSK              cpu_to_le32(1 << 8)
#define RXON_FLG_ANT_B_MSK              cpu_to_le32(1 << 9)
Z
Zhu Yi 已提交
643
/* radar detection enable */
644 645
#define RXON_FLG_RADAR_DETECT_MSK       cpu_to_le32(1 << 12)
#define RXON_FLG_TGJ_NARROW_BAND_MSK    cpu_to_le32(1 << 13)
Z
Zhu Yi 已提交
646 647
/* rx response to host with 8-byte TSF
* (according to ON_AIR deassertion) */
648
#define RXON_FLG_TSF2HOST_MSK           cpu_to_le32(1 << 15)
Z
Zhu Yi 已提交
649

650 651 652

/* HT flags */
#define RXON_FLG_CTRL_CHANNEL_LOC_POS		(22)
653
#define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK	cpu_to_le32(0x1 << 22)
654 655 656

#define RXON_FLG_HT_OPERATING_MODE_POS		(23)

657
#define RXON_FLG_HT_PROT_MSK			cpu_to_le32(0x1 << 23)
658
#define RXON_FLG_HT40_PROT_MSK			cpu_to_le32(0x2 << 23)
659 660

#define RXON_FLG_CHANNEL_MODE_POS		(25)
661
#define RXON_FLG_CHANNEL_MODE_MSK		cpu_to_le32(0x3 << 25)
662 663 664 665 666 667 668 669 670 671 672 673

/* channel mode */
enum {
	CHANNEL_MODE_LEGACY = 0,
	CHANNEL_MODE_PURE_40 = 1,
	CHANNEL_MODE_MIXED = 2,
	CHANNEL_MODE_RESERVED = 3,
};
#define RXON_FLG_CHANNEL_MODE_LEGACY	cpu_to_le32(CHANNEL_MODE_LEGACY << RXON_FLG_CHANNEL_MODE_POS)
#define RXON_FLG_CHANNEL_MODE_PURE_40	cpu_to_le32(CHANNEL_MODE_PURE_40 << RXON_FLG_CHANNEL_MODE_POS)
#define RXON_FLG_CHANNEL_MODE_MIXED	cpu_to_le32(CHANNEL_MODE_MIXED << RXON_FLG_CHANNEL_MODE_POS)

674
/* CTS to self (if spec allows) flag */
675
#define RXON_FLG_SELF_CTS_EN			cpu_to_le32(0x1<<30)
676

Z
Zhu Yi 已提交
677 678
/* rx_config filter flags */
/* accept all data frames */
679
#define RXON_FILTER_PROMISC_MSK         cpu_to_le32(1 << 0)
Z
Zhu Yi 已提交
680
/* pass control & management to host */
681
#define RXON_FILTER_CTL2HOST_MSK        cpu_to_le32(1 << 1)
Z
Zhu Yi 已提交
682
/* accept multi-cast */
683
#define RXON_FILTER_ACCEPT_GRP_MSK      cpu_to_le32(1 << 2)
Z
Zhu Yi 已提交
684
/* don't decrypt uni-cast frames */
685
#define RXON_FILTER_DIS_DECRYPT_MSK     cpu_to_le32(1 << 3)
Z
Zhu Yi 已提交
686
/* don't decrypt multi-cast frames */
687
#define RXON_FILTER_DIS_GRP_DECRYPT_MSK cpu_to_le32(1 << 4)
Z
Zhu Yi 已提交
688
/* STA is associated */
689
#define RXON_FILTER_ASSOC_MSK           cpu_to_le32(1 << 5)
Z
Zhu Yi 已提交
690
/* transfer to host non bssid beacons in associated state */
691
#define RXON_FILTER_BCON_AWARE_MSK      cpu_to_le32(1 << 6)
Z
Zhu Yi 已提交
692

693
/**
Z
Zhu Yi 已提交
694
 * REPLY_RXON = 0x10 (command, has simple generic response)
695 696 697 698 699 700 701 702 703 704 705 706 707 708
 *
 * RXON tunes the radio tuner to a service channel, and sets up a number
 * of parameters that are used primarily for Rx, but also for Tx operations.
 *
 * NOTE:  When tuning to a new channel, driver must set the
 *        RXON_FILTER_ASSOC_MSK to 0.  This will clear station-dependent
 *        info within the device, including the station tables, tx retry
 *        rate tables, and txpower tables.  Driver must build a new station
 *        table and txpower table before transmitting anything on the RXON
 *        channel.
 *
 * NOTE:  All RXONs wipe clean the internal txpower table.  Driver must
 *        issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
 *        regardless of whether RXON_FILTER_ASSOC_MSK is set.
Z
Zhu Yi 已提交
709
 */
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727

struct iwl3945_rxon_cmd {
	u8 node_addr[6];
	__le16 reserved1;
	u8 bssid_addr[6];
	__le16 reserved2;
	u8 wlap_bssid_addr[6];
	__le16 reserved3;
	u8 dev_type;
	u8 air_propagation;
	__le16 reserved4;
	u8 ofdm_basic_rates;
	u8 cck_basic_rates;
	__le16 assoc_id;
	__le32 flags;
	__le32 filter_flags;
	__le16 channel;
	__le16 reserved5;
728
} __packed;
729

C
Christoph Hellwig 已提交
730
struct iwl4965_rxon_cmd {
Z
Zhu Yi 已提交
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
	u8 node_addr[6];
	__le16 reserved1;
	u8 bssid_addr[6];
	__le16 reserved2;
	u8 wlap_bssid_addr[6];
	__le16 reserved3;
	u8 dev_type;
	u8 air_propagation;
	__le16 rx_chain;
	u8 ofdm_basic_rates;
	u8 cck_basic_rates;
	__le16 assoc_id;
	__le32 flags;
	__le32 filter_flags;
	__le16 channel;
	u8 ofdm_ht_single_stream_basic_rates;
	u8 ofdm_ht_dual_stream_basic_rates;
748
} __packed;
Z
Zhu Yi 已提交
749

T
Tomas Winkler 已提交
750
/* 5000 HW just extend this command */
G
Gregory Greenman 已提交
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
struct iwl_rxon_cmd {
	u8 node_addr[6];
	__le16 reserved1;
	u8 bssid_addr[6];
	__le16 reserved2;
	u8 wlap_bssid_addr[6];
	__le16 reserved3;
	u8 dev_type;
	u8 air_propagation;
	__le16 rx_chain;
	u8 ofdm_basic_rates;
	u8 cck_basic_rates;
	__le16 assoc_id;
	__le32 flags;
	__le32 filter_flags;
	__le16 channel;
	u8 ofdm_ht_single_stream_basic_rates;
	u8 ofdm_ht_dual_stream_basic_rates;
	u8 ofdm_ht_triple_stream_basic_rates;
	u8 reserved5;
	__le16 acquisition_data;
	__le16 reserved6;
773
} __packed;
G
Gregory Greenman 已提交
774

775 776 777 778 779 780 781 782 783
/*
 * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
 */
struct iwl3945_rxon_assoc_cmd {
	__le32 flags;
	__le32 filter_flags;
	u8 ofdm_basic_rates;
	u8 cck_basic_rates;
	__le16 reserved;
784
} __packed;
785 786

struct iwl4965_rxon_assoc_cmd {
787 788 789 790 791 792 793
	__le32 flags;
	__le32 filter_flags;
	u8 ofdm_basic_rates;
	u8 cck_basic_rates;
	u8 ofdm_ht_single_stream_basic_rates;
	u8 ofdm_ht_dual_stream_basic_rates;
	__le16 rx_chain_select_flags;
794
	__le16 reserved;
795
} __packed;
G
Gregory Greenman 已提交
796

797
struct iwl5000_rxon_assoc_cmd {
Z
Zhu Yi 已提交
798 799 800 801
	__le32 flags;
	__le32 filter_flags;
	u8 ofdm_basic_rates;
	u8 cck_basic_rates;
802
	__le16 reserved1;
Z
Zhu Yi 已提交
803 804
	u8 ofdm_ht_single_stream_basic_rates;
	u8 ofdm_ht_dual_stream_basic_rates;
805 806
	u8 ofdm_ht_triple_stream_basic_rates;
	u8 reserved2;
Z
Zhu Yi 已提交
807
	__le16 rx_chain_select_flags;
808 809
	__le16 acquisition_data;
	__le32 reserved3;
810
} __packed;
Z
Zhu Yi 已提交
811

812
#define IWL_CONN_MAX_LISTEN_INTERVAL	10
813 814
#define IWL_MAX_UCODE_BEACON_INTERVAL	4 /* 4096 */
#define IWL39_MAX_UCODE_BEACON_INTERVAL	1 /* 1024 */
815

Z
Zhu Yi 已提交
816 817 818
/*
 * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
 */
819 820
struct iwl_rxon_time_cmd {
	__le64 timestamp;
Z
Zhu Yi 已提交
821 822 823 824 825
	__le16 beacon_interval;
	__le16 atim_window;
	__le32 beacon_init_val;
	__le16 listen_interval;
	__le16 reserved;
826
} __packed;
Z
Zhu Yi 已提交
827 828 829 830

/*
 * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
 */
831 832 833 834 835 836 837 838
struct iwl3945_channel_switch_cmd {
	u8 band;
	u8 expect_beacon;
	__le16 channel;
	__le32 rxon_flags;
	__le32 rxon_filter_flags;
	__le32 switch_time;
	struct iwl3945_power_per_rate power[IWL_MAX_RATES];
839
} __packed;
840

841
struct iwl4965_channel_switch_cmd {
Z
Zhu Yi 已提交
842 843 844 845 846 847
	u8 band;
	u8 expect_beacon;
	__le16 channel;
	__le32 rxon_flags;
	__le32 rxon_filter_flags;
	__le32 switch_time;
C
Christoph Hellwig 已提交
848
	struct iwl4965_tx_power_db tx_power;
849
} __packed;
Z
Zhu Yi 已提交
850

851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
/**
 * struct iwl5000_channel_switch_cmd
 * @band: 0- 5.2GHz, 1- 2.4GHz
 * @expect_beacon: 0- resume transmits after channel switch
 *		   1- wait for beacon to resume transmits
 * @channel: new channel number
 * @rxon_flags: Rx on flags
 * @rxon_filter_flags: filtering parameters
 * @switch_time: switch time in extended beacon format
 * @reserved: reserved bytes
 */
struct iwl5000_channel_switch_cmd {
	u8 band;
	u8 expect_beacon;
	__le16 channel;
	__le32 rxon_flags;
	__le32 rxon_filter_flags;
	__le32 switch_time;
	__le32 reserved[2][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES];
870
} __packed;
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890

/**
 * struct iwl6000_channel_switch_cmd
 * @band: 0- 5.2GHz, 1- 2.4GHz
 * @expect_beacon: 0- resume transmits after channel switch
 *		   1- wait for beacon to resume transmits
 * @channel: new channel number
 * @rxon_flags: Rx on flags
 * @rxon_filter_flags: filtering parameters
 * @switch_time: switch time in extended beacon format
 * @reserved: reserved bytes
 */
struct iwl6000_channel_switch_cmd {
	u8 band;
	u8 expect_beacon;
	__le16 channel;
	__le32 rxon_flags;
	__le32 rxon_filter_flags;
	__le32 switch_time;
	__le32 reserved[3][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES];
891
} __packed;
892

Z
Zhu Yi 已提交
893 894 895
/*
 * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
 */
896
struct iwl_csa_notification {
Z
Zhu Yi 已提交
897 898 899
	__le16 band;
	__le16 channel;
	__le32 status;		/* 0 - OK, 1 - fail */
900
} __packed;
Z
Zhu Yi 已提交
901 902 903 904 905 906

/******************************************************************************
 * (2)
 * Quality-of-Service (QOS) Commands & Responses:
 *
 *****************************************************************************/
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923

/**
 * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
 * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
 *
 * @cw_min: Contention window, start value in numbers of slots.
 *          Should be a power-of-2, minus 1.  Device's default is 0x0f.
 * @cw_max: Contention window, max value in numbers of slots.
 *          Should be a power-of-2, minus 1.  Device's default is 0x3f.
 * @aifsn:  Number of slots in Arbitration Interframe Space (before
 *          performing random backoff timing prior to Tx).  Device default 1.
 * @edca_txop:  Length of Tx opportunity, in uSecs.  Device default is 0.
 *
 * Device will automatically increase contention window by (2*CW) + 1 for each
 * transmission retry.  Device uses cw_max as a bit mask, ANDed with new CW
 * value, to cap the CW value.
 */
924
struct iwl_ac_qos {
Z
Zhu Yi 已提交
925 926 927 928 929
	__le16 cw_min;
	__le16 cw_max;
	u8 aifsn;
	u8 reserved1;
	__le16 edca_txop;
930
} __packed;
Z
Zhu Yi 已提交
931 932

/* QoS flags defines */
933 934 935
#define QOS_PARAM_FLG_UPDATE_EDCA_MSK	cpu_to_le32(0x01)
#define QOS_PARAM_FLG_TGN_MSK		cpu_to_le32(0x02)
#define QOS_PARAM_FLG_TXOP_TYPE_MSK	cpu_to_le32(0x10)
Z
Zhu Yi 已提交
936

937
/* Number of Access Categories (AC) (EDCA), queues 0..3 */
Z
Zhu Yi 已提交
938 939 940 941
#define AC_NUM                4

/*
 * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
942 943 944
 *
 * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
 * 0: Background, 1: Best Effort, 2: Video, 3: Voice.
Z
Zhu Yi 已提交
945
 */
946
struct iwl_qosparam_cmd {
Z
Zhu Yi 已提交
947
	__le32 qos_flags;
948
	struct iwl_ac_qos ac[AC_NUM];
949
} __packed;
Z
Zhu Yi 已提交
950 951 952 953 954 955 956 957 958

/******************************************************************************
 * (3)
 * Add/Modify Stations Commands & Responses:
 *
 *****************************************************************************/
/*
 * Multi station support
 */
959 960

/* Special, dedicated locations within device's station table */
Z
Zhu Yi 已提交
961 962
#define	IWL_AP_ID		0
#define	IWL_STA_ID		2
963 964
#define	IWL3945_BROADCAST_ID	24
#define IWL3945_STATION_COUNT	25
Z
Zhu Yi 已提交
965 966
#define IWL4965_BROADCAST_ID	31
#define	IWL4965_STATION_COUNT	32
967 968
#define IWLAGN_BROADCAST_ID	15
#define	IWLAGN_STATION_COUNT	16
Z
Zhu Yi 已提交
969 970 971 972

#define	IWL_STATION_COUNT	32 	/* MAX(3945,4965)*/
#define	IWL_INVALID_STATION 	255

973 974
#define STA_FLG_TX_RATE_MSK		cpu_to_le32(1 << 2)
#define STA_FLG_PWR_SAVE_MSK		cpu_to_le32(1 << 8)
975 976
#define STA_FLG_RTS_MIMO_PROT_MSK	cpu_to_le32(1 << 17)
#define STA_FLG_AGG_MPDU_8US_MSK	cpu_to_le32(1 << 18)
977
#define STA_FLG_MAX_AGG_SIZE_POS	(19)
978
#define STA_FLG_MAX_AGG_SIZE_MSK	cpu_to_le32(3 << 19)
979
#define STA_FLG_HT40_EN_MSK		cpu_to_le32(1 << 21)
980
#define STA_FLG_MIMO_DIS_MSK		cpu_to_le32(1 << 22)
981
#define STA_FLG_AGG_MPDU_DENSITY_POS	(23)
982
#define STA_FLG_AGG_MPDU_DENSITY_MSK	cpu_to_le32(7 << 23)
Z
Zhu Yi 已提交
983

984
/* Use in mode field.  1: modify existing entry, 0: add new station entry */
Z
Zhu Yi 已提交
985 986 987
#define STA_CONTROL_MODIFY_MSK		0x01

/* key flags __le16*/
988 989 990 991 992
#define STA_KEY_FLG_ENCRYPT_MSK	cpu_to_le16(0x0007)
#define STA_KEY_FLG_NO_ENC	cpu_to_le16(0x0000)
#define STA_KEY_FLG_WEP		cpu_to_le16(0x0001)
#define STA_KEY_FLG_CCMP	cpu_to_le16(0x0002)
#define STA_KEY_FLG_TKIP	cpu_to_le16(0x0003)
Z
Zhu Yi 已提交
993 994

#define STA_KEY_FLG_KEYID_POS	8
995
#define STA_KEY_FLG_INVALID 	cpu_to_le16(0x0800)
996
/* wep key is either from global key (0) or from station info array (1) */
997
#define STA_KEY_FLG_MAP_KEY_MSK	cpu_to_le16(0x0008)
998 999

/* wep key in STA: 5-bytes (0) or 13-bytes (1) */
1000 1001
#define STA_KEY_FLG_KEY_SIZE_MSK     cpu_to_le16(0x1000)
#define STA_KEY_MULTICAST_MSK        cpu_to_le16(0x4000)
1002
#define STA_KEY_MAX_NUM		8
Z
Zhu Yi 已提交
1003

1004
/* Flags indicate whether to modify vs. don't change various station params */
Z
Zhu Yi 已提交
1005 1006 1007 1008 1009
#define	STA_MODIFY_KEY_MASK		0x01
#define	STA_MODIFY_TID_DISABLE_TX	0x02
#define	STA_MODIFY_TX_RATE_MSK		0x04
#define STA_MODIFY_ADDBA_TID_MSK	0x08
#define STA_MODIFY_DELBA_TID_MSK	0x10
1010
#define STA_MODIFY_SLEEP_TX_COUNT_MSK	0x20
1011 1012 1013

/* Receiver address (actually, Rx station's index into station table),
 * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
Z
Zhu Yi 已提交
1014 1015
#define BUILD_RAxTID(sta_id, tid)	(((sta_id) << 4) + (tid))

C
Christoph Hellwig 已提交
1016
struct iwl4965_keyinfo {
Z
Zhu Yi 已提交
1017 1018 1019 1020
	__le16 key_flags;
	u8 tkip_rx_tsc_byte2;	/* TSC[2] for key mix ph1 detection */
	u8 reserved1;
	__le16 tkip_rx_ttak[5];	/* 10-byte unicast TKIP TTAK */
1021 1022
	u8 key_offset;
	u8 reserved2;
Z
Zhu Yi 已提交
1023
	u8 key[16];		/* 16-byte unicast decryption key */
1024
} __packed;
Z
Zhu Yi 已提交
1025

1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
/* 5000 */
struct iwl_keyinfo {
	__le16 key_flags;
	u8 tkip_rx_tsc_byte2;	/* TSC[2] for key mix ph1 detection */
	u8 reserved1;
	__le16 tkip_rx_ttak[5];	/* 10-byte unicast TKIP TTAK */
	u8 key_offset;
	u8 reserved2;
	u8 key[16];		/* 16-byte unicast decryption key */
	__le64 tx_secur_seq_cnt;
	__le64 hw_tkip_mic_rx_key;
	__le64 hw_tkip_mic_tx_key;
1038
} __packed;
1039

1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
/**
 * struct sta_id_modify
 * @addr[ETH_ALEN]: station's MAC address
 * @sta_id: index of station in uCode's station table
 * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
 *
 * Driver selects unused table index when adding new station,
 * or the index to a pre-existing station entry when modifying that station.
 * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
 *
 * modify_mask flags select which parameters to modify vs. leave alone.
 */
Z
Zhu Yi 已提交
1052 1053 1054 1055 1056 1057
struct sta_id_modify {
	u8 addr[ETH_ALEN];
	__le16 reserved1;
	u8 sta_id;
	u8 modify_mask;
	__le16 reserved2;
1058
} __packed;
Z
Zhu Yi 已提交
1059 1060 1061

/*
 * REPLY_ADD_STA = 0x18 (command)
1062 1063 1064
 *
 * The device contains an internal table of per-station information,
 * with info on security keys, aggregation parameters, and Tx rates for
W
Wey-Yi Guy 已提交
1065 1066
 * initial Tx attempt and any retries (agn devices uses
 * REPLY_TX_LINK_QUALITY_CMD,
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
 * 3945 uses REPLY_RATE_SCALE to set up rate tables).
 *
 * REPLY_ADD_STA sets up the table entry for one station, either creating
 * a new entry, or modifying a pre-existing one.
 *
 * NOTE:  RXON command (without "associated" bit set) wipes the station table
 *        clean.  Moving into RF_KILL state does this also.  Driver must set up
 *        new station table before transmitting anything on the RXON channel
 *        (except active scans or active measurements; those commands carry
 *        their own txpower/rate setup data).
 *
 *        When getting started on a new channel, driver must set up the
 *        IWL_BROADCAST_ID entry (last entry in the table).  For a client
 *        station in a BSS, once an AP is selected, driver sets up the AP STA
 *        in the IWL_AP_ID entry (1st entry in the table).  BROADCAST and AP
 *        are all that are needed for a BSS client station.  If the device is
 *        used as AP, or in an IBSS network, driver must set up station table
 *        entries for all STAs in network, starting with index IWL_STA_ID.
Z
Zhu Yi 已提交
1085
 */
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112

struct iwl3945_addsta_cmd {
	u8 mode;		/* 1: modify existing, 0: add new station */
	u8 reserved[3];
	struct sta_id_modify sta;
	struct iwl4965_keyinfo key;
	__le32 station_flags;		/* STA_FLG_* */
	__le32 station_flags_msk;	/* STA_FLG_* */

	/* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
	 * corresponding to bit (e.g. bit 5 controls TID 5).
	 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
	__le16 tid_disable_tx;

	__le16 rate_n_flags;

	/* TID for which to add block-ack support.
	 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
	u8 add_immediate_ba_tid;

	/* TID for which to remove block-ack support.
	 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
	u8 remove_immediate_ba_tid;

	/* Starting Sequence Number for added block-ack support.
	 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
	__le16 add_immediate_ba_ssn;
1113
} __packed;
1114

C
Christoph Hellwig 已提交
1115
struct iwl4965_addsta_cmd {
1116
	u8 mode;		/* 1: modify existing, 0: add new station */
Z
Zhu Yi 已提交
1117 1118
	u8 reserved[3];
	struct sta_id_modify sta;
C
Christoph Hellwig 已提交
1119
	struct iwl4965_keyinfo key;
1120 1121 1122 1123 1124 1125
	__le32 station_flags;		/* STA_FLG_* */
	__le32 station_flags_msk;	/* STA_FLG_* */

	/* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
	 * corresponding to bit (e.g. bit 5 controls TID 5).
	 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
Z
Zhu Yi 已提交
1126
	__le16 tid_disable_tx;
1127

Z
Zhu Yi 已提交
1128
	__le16	reserved1;
1129 1130 1131

	/* TID for which to add block-ack support.
	 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
Z
Zhu Yi 已提交
1132
	u8 add_immediate_ba_tid;
1133 1134 1135

	/* TID for which to remove block-ack support.
	 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
Z
Zhu Yi 已提交
1136
	u8 remove_immediate_ba_tid;
1137 1138 1139

	/* Starting Sequence Number for added block-ack support.
	 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
Z
Zhu Yi 已提交
1140
	__le16 add_immediate_ba_ssn;
1141

1142 1143 1144 1145 1146 1147 1148 1149
	/*
	 * Number of packets OK to transmit to station even though
	 * it is asleep -- used to synchronise PS-poll and u-APSD
	 * responses while ucode keeps track of STA sleep state.
	 */
	__le16 sleep_tx_count;

	__le16 reserved2;
1150
} __packed;
Z
Zhu Yi 已提交
1151

1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
/* 5000 */
struct iwl_addsta_cmd {
	u8 mode;		/* 1: modify existing, 0: add new station */
	u8 reserved[3];
	struct sta_id_modify sta;
	struct iwl_keyinfo key;
	__le32 station_flags;		/* STA_FLG_* */
	__le32 station_flags_msk;	/* STA_FLG_* */

	/* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
	 * corresponding to bit (e.g. bit 5 controls TID 5).
	 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
	__le16 tid_disable_tx;

1166
	__le16	rate_n_flags;		/* 3945 only */
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179

	/* TID for which to add block-ack support.
	 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
	u8 add_immediate_ba_tid;

	/* TID for which to remove block-ack support.
	 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
	u8 remove_immediate_ba_tid;

	/* Starting Sequence Number for added block-ack support.
	 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
	__le16 add_immediate_ba_ssn;

1180 1181 1182 1183 1184 1185 1186 1187
	/*
	 * Number of packets OK to transmit to station even though
	 * it is asleep -- used to synchronise PS-poll and u-APSD
	 * responses while ucode keeps track of STA sleep state.
	 */
	__le16 sleep_tx_count;

	__le16 reserved2;
1188
} __packed;
1189 1190


1191 1192 1193 1194
#define ADD_STA_SUCCESS_MSK		0x1
#define ADD_STA_NO_ROOM_IN_TABLE	0x2
#define ADD_STA_NO_BLOCK_ACK_RESOURCE	0x4
#define ADD_STA_MODIFY_NON_EXIST_STA	0x8
Z
Zhu Yi 已提交
1195 1196 1197
/*
 * REPLY_ADD_STA = 0x18 (response)
 */
1198
struct iwl_add_sta_resp {
1199
	u8 status;	/* ADD_STA_* */
1200
} __packed;
Z
Zhu Yi 已提交
1201

1202 1203 1204 1205 1206 1207
#define REM_STA_SUCCESS_MSK              0x1
/*
 *  REPLY_REM_STA = 0x19 (response)
 */
struct iwl_rem_sta_resp {
	u8 status;
1208
} __packed;
1209 1210 1211 1212 1213 1214 1215 1216 1217

/*
 *  REPLY_REM_STA = 0x19 (command)
 */
struct iwl_rem_sta_cmd {
	u8 num_sta;     /* number of removed stations */
	u8 reserved[3];
	u8 addr[ETH_ALEN]; /* MAC addr of the first station */
	u8 reserved2[2];
1218
} __packed;
1219

1220 1221 1222 1223 1224 1225
#define IWL_TX_FIFO_BK_MSK		cpu_to_le32(BIT(0))
#define IWL_TX_FIFO_BE_MSK		cpu_to_le32(BIT(1))
#define IWL_TX_FIFO_VI_MSK		cpu_to_le32(BIT(2))
#define IWL_TX_FIFO_VO_MSK		cpu_to_le32(BIT(3))
#define IWL_AGG_TX_QUEUE_MSK		cpu_to_le32(0xffc00)

1226 1227 1228 1229
#define IWL_DROP_SINGLE		0
#define IWL_DROP_SELECTED	1
#define IWL_DROP_ALL		2

1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
/*
 * REPLY_TXFIFO_FLUSH = 0x1e(command and response)
 *
 * When using full FIFO flush this command checks the scheduler HW block WR/RD
 * pointers to check if all the frames were transferred by DMA into the
 * relevant TX FIFO queue. Only when the DMA is finished and the queue is
 * empty the command can finish.
 * This command is used to flush the TXFIFO from transmit commands, it may
 * operate on single or multiple queues, the command queue can't be flushed by
 * this command. The command response is returned when all the queue flush
 * operations are done. Each TX command flushed return response with the FLUSH
 * status set in the TX response status. When FIFO flush operation is used,
 * the flush operation ends when both the scheduler DMA done and TXFIFO empty
 * are set.
 *
 * @fifo_control: bit mask for which queues to flush
 * @flush_control: flush controls
 *	0: Dump single MSDU
 *	1: Dump multiple MSDU according to PS, INVALID STA, TTL, TID disable.
 *	2: Dump all FIFO
 */
struct iwl_txfifo_flush_cmd {
	__le32 fifo_control;
	__le16 flush_control;
	__le16 reserved;
1255
} __packed;
1256

1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
/*
 * REPLY_WEP_KEY = 0x20
 */
struct iwl_wep_key {
	u8 key_index;
	u8 key_offset;
	u8 reserved1[2];
	u8 key_size;
	u8 reserved2[3];
	u8 key[16];
1267
} __packed;
1268 1269 1270 1271 1272 1273 1274

struct iwl_wep_cmd {
	u8 num_keys;
	u8 global_key_type;
	u8 flags;
	u8 reserved;
	struct iwl_wep_key key[0];
1275
} __packed;
1276 1277 1278 1279

#define WEP_KEY_WEP_TYPE 1
#define WEP_KEYS_MAX 4
#define WEP_INVALID_OFFSET 0xff
1280
#define WEP_KEY_LEN_64 5
1281
#define WEP_KEY_LEN_128 13
Z
Zhu Yi 已提交
1282 1283 1284 1285 1286 1287 1288

/******************************************************************************
 * (4)
 * Rx Responses:
 *
 *****************************************************************************/

1289 1290
#define RX_RES_STATUS_NO_CRC32_ERROR	cpu_to_le32(1 << 0)
#define RX_RES_STATUS_NO_RXE_OVERFLOW	cpu_to_le32(1 << 1)
1291

1292 1293 1294 1295
#define RX_RES_PHY_FLAGS_BAND_24_MSK	cpu_to_le16(1 << 0)
#define RX_RES_PHY_FLAGS_MOD_CCK_MSK		cpu_to_le16(1 << 1)
#define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK	cpu_to_le16(1 << 2)
#define RX_RES_PHY_FLAGS_NARROW_BAND_MSK	cpu_to_le16(1 << 3)
R
Reinette Chatre 已提交
1296
#define RX_RES_PHY_FLAGS_ANTENNA_MSK		0xf0
1297
#define RX_RES_PHY_FLAGS_ANTENNA_POS		4
1298 1299 1300 1301 1302 1303

#define RX_RES_STATUS_SEC_TYPE_MSK	(0x7 << 8)
#define RX_RES_STATUS_SEC_TYPE_NONE	(0x0 << 8)
#define RX_RES_STATUS_SEC_TYPE_WEP	(0x1 << 8)
#define RX_RES_STATUS_SEC_TYPE_CCMP	(0x2 << 8)
#define RX_RES_STATUS_SEC_TYPE_TKIP	(0x3 << 8)
1304 1305 1306 1307
#define	RX_RES_STATUS_SEC_TYPE_ERR	(0x7 << 8)

#define RX_RES_STATUS_STATION_FOUND	(1<<6)
#define RX_RES_STATUS_NO_STATION_INFO_MISMATCH	(1<<7)
1308 1309 1310 1311 1312 1313

#define RX_RES_STATUS_DECRYPT_TYPE_MSK	(0x3 << 11)
#define RX_RES_STATUS_NOT_DECRYPT	(0x0 << 11)
#define RX_RES_STATUS_DECRYPT_OK	(0x3 << 11)
#define RX_RES_STATUS_BAD_ICV_MIC	(0x1 << 11)
#define RX_RES_STATUS_BAD_KEY_TTAK	(0x2 << 11)
Z
Zhu Yi 已提交
1314

1315 1316 1317 1318 1319
#define RX_MPDU_RES_STATUS_ICV_OK	(0x20)
#define RX_MPDU_RES_STATUS_MIC_OK	(0x40)
#define RX_MPDU_RES_STATUS_TTAK_OK	(1 << 7)
#define RX_MPDU_RES_STATUS_DEC_DONE_MSK	(0x800)

1320 1321 1322 1323 1324 1325 1326 1327 1328

struct iwl3945_rx_frame_stats {
	u8 phy_count;
	u8 id;
	u8 rssi;
	u8 agc;
	__le16 sig_avg;
	__le16 noise_diff;
	u8 payload[0];
1329
} __packed;
1330 1331 1332 1333 1334 1335 1336 1337

struct iwl3945_rx_frame_hdr {
	__le16 channel;
	__le16 phy_flags;
	u8 reserved1;
	u8 rate;
	__le16 len;
	u8 payload[0];
1338
} __packed;
1339 1340 1341 1342 1343

struct iwl3945_rx_frame_end {
	__le32 status;
	__le64 timestamp;
	__le32 beacon_timestamp;
1344
} __packed;
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357

/*
 * REPLY_3945_RX = 0x1b (response only, not a command)
 *
 * NOTE:  DO NOT dereference from casts to this structure
 * It is provided only for calculating minimum data set size.
 * The actual offsets of the hdr and end are dynamic based on
 * stats.phy_count
 */
struct iwl3945_rx_frame {
	struct iwl3945_rx_frame_stats stats;
	struct iwl3945_rx_frame_hdr hdr;
	struct iwl3945_rx_frame_end end;
1358
} __packed;
1359 1360 1361

#define IWL39_RX_FRAME_SIZE	(4 + sizeof(struct iwl3945_rx_frame))

Z
Zhu Yi 已提交
1362
/* Fixed (non-configurable) rx data from phy */
1363 1364 1365 1366 1367 1368

#define IWL49_RX_RES_PHY_CNT 14
#define IWL49_RX_PHY_FLAGS_ANTENNAE_OFFSET	(4)
#define IWL49_RX_PHY_FLAGS_ANTENNAE_MASK	(0x70)
#define IWL49_AGC_DB_MASK			(0x3f80)	/* MASK(7,13) */
#define IWL49_AGC_DB_POS			(7)
Z
Zhu Yi 已提交
1369 1370 1371 1372 1373
struct iwl4965_rx_non_cfg_phy {
	__le16 ant_selection;	/* ant A bit 4, ant B bit 5, ant C bit 6 */
	__le16 agc_info;	/* agc code 0:6, agc dB 7:13, reserved 14:15 */
	u8 rssi_info[6];	/* we use even entries, 0/2/4 for A/B/C rssi */
	u8 pad[0];
1374
} __packed;
Z
Zhu Yi 已提交
1375

1376

1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
#define IWLAGN_RX_RES_PHY_CNT 8
#define IWLAGN_RX_RES_AGC_IDX     1
#define IWLAGN_RX_RES_RSSI_AB_IDX 2
#define IWLAGN_RX_RES_RSSI_C_IDX  3
#define IWLAGN_OFDM_AGC_MSK 0xfe00
#define IWLAGN_OFDM_AGC_BIT_POS 9
#define IWLAGN_OFDM_RSSI_INBAND_A_BITMSK 0x00ff
#define IWLAGN_OFDM_RSSI_ALLBAND_A_BITMSK 0xff00
#define IWLAGN_OFDM_RSSI_A_BIT_POS 0
#define IWLAGN_OFDM_RSSI_INBAND_B_BITMSK 0xff0000
#define IWLAGN_OFDM_RSSI_ALLBAND_B_BITMSK 0xff000000
#define IWLAGN_OFDM_RSSI_B_BIT_POS 16
#define IWLAGN_OFDM_RSSI_INBAND_C_BITMSK 0x00ff
#define IWLAGN_OFDM_RSSI_ALLBAND_C_BITMSK 0xff00
#define IWLAGN_OFDM_RSSI_C_BIT_POS 0

struct iwlagn_non_cfg_phy {
	__le32 non_cfg_phy[IWLAGN_RX_RES_PHY_CNT];  /* up to 8 phy entries */
1395
} __packed;
1396 1397


Z
Zhu Yi 已提交
1398
/*
1399
 * REPLY_RX = 0xc3 (response only, not a command)
Z
Zhu Yi 已提交
1400 1401
 * Used only for legacy (non 11n) frames.
 */
1402
struct iwl_rx_phy_res {
Z
Zhu Yi 已提交
1403 1404 1405 1406 1407 1408 1409 1410
	u8 non_cfg_phy_cnt;     /* non configurable DSP phy data byte count */
	u8 cfg_phy_cnt;		/* configurable DSP phy data byte count */
	u8 stat_id;		/* configurable DSP phy data set ID */
	u8 reserved1;
	__le64 timestamp;	/* TSF at on air rise */
	__le32 beacon_time_stamp; /* beacon at on-air rise */
	__le16 phy_flags;	/* general phy flags: band, modulation, ... */
	__le16 channel;		/* channel number */
1411
	u8 non_cfg_phy_buf[32]; /* for various implementations of non_cfg_phy */
1412 1413
	__le32 rate_n_flags;	/* RATE_MCS_* */
	__le16 byte_count;	/* frame's byte-count */
1414
	__le16 frame_time;	/* frame's time on the air */
1415
} __packed;
Z
Zhu Yi 已提交
1416

1417
struct iwl_rx_mpdu_res_start {
Z
Zhu Yi 已提交
1418 1419
	__le16 byte_count;
	__le16 reserved;
1420
} __packed;
Z
Zhu Yi 已提交
1421 1422 1423 1424 1425 1426


/******************************************************************************
 * (5)
 * Tx Commands & Responses:
 *
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436
 * Driver must place each REPLY_TX command into one of the prioritized Tx
 * queues in host DRAM, shared between driver and device (see comments for
 * SCD registers and Tx/Rx Queues).  When the device's Tx scheduler and uCode
 * are preparing to transmit, the device pulls the Tx command over the PCI
 * bus via one of the device's Tx DMA channels, to fill an internal FIFO
 * from which data will be transmitted.
 *
 * uCode handles all timing and protocol related to control frames
 * (RTS/CTS/ACK), based on flags in the Tx command.  uCode and Tx scheduler
 * handle reception of block-acks; uCode updates the host driver via
W
Wey-Yi Guy 已提交
1437
 * REPLY_COMPRESSED_BA.
1438 1439 1440 1441
 *
 * uCode handles retrying Tx when an ACK is expected but not received.
 * This includes trying lower data rates than the one requested in the Tx
 * command, as set up by the REPLY_RATE_SCALE (for 3945) or
W
Wey-Yi Guy 已提交
1442
 * REPLY_TX_LINK_QUALITY_CMD (agn).
1443 1444 1445
 *
 * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
 * This command must be executed after every RXON command, before Tx can occur.
Z
Zhu Yi 已提交
1446 1447
 *****************************************************************************/

1448 1449
/* REPLY_TX Tx flags field */

1450 1451
/*
 * 1: Use RTS/CTS protocol or CTS-to-self if spec allows it
1452
 * before this frame. if CTS-to-self required check
1453 1454 1455 1456
 * RXON_FLG_SELF_CTS_EN status.
 * unused in 3945/4965, used in 5000 series and after
 */
#define TX_CMD_FLG_PROT_REQUIRE_MSK cpu_to_le32(1 << 0)
1457

1458 1459 1460 1461 1462
/*
 * 1: Use Request-To-Send protocol before this frame.
 * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK.
 * used in 3945/4965, unused in 5000 series and after
 */
1463
#define TX_CMD_FLG_RTS_MSK cpu_to_le32(1 << 1)
1464

1465 1466
/*
 * 1: Transmit Clear-To-Send to self before this frame.
1467
 * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
1468 1469 1470
 * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK.
 * used in 3945/4965, unused in 5000 series and after
 */
1471
#define TX_CMD_FLG_CTS_MSK cpu_to_le32(1 << 2)
1472 1473 1474 1475

/* 1: Expect ACK from receiving station
 * 0: Don't expect ACK (MAC header's duration field s/b 0)
 * Set this for unicast frames, but not broadcast/multicast. */
1476
#define TX_CMD_FLG_ACK_MSK cpu_to_le32(1 << 3)
1477

W
Wey-Yi Guy 已提交
1478
/* For agn devices:
1479 1480 1481 1482 1483
 * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
 *    Tx command's initial_rate_index indicates first rate to try;
 *    uCode walks through table for additional Tx attempts.
 * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
 *    This rate will be used for all Tx attempts; it will not be scaled. */
1484
#define TX_CMD_FLG_STA_RATE_MSK cpu_to_le32(1 << 4)
1485 1486 1487

/* 1: Expect immediate block-ack.
 * Set when Txing a block-ack request frame.  Also set TX_CMD_FLG_ACK_MSK. */
1488
#define TX_CMD_FLG_IMM_BA_RSP_MASK  cpu_to_le32(1 << 6)
1489

1490 1491 1492 1493 1494
/*
 * 1: Frame requires full Tx-Op protection.
 * Set this if either RTS or CTS Tx Flag gets set.
 * used in 3945/4965, unused in 5000 series and after
 */
1495
#define TX_CMD_FLG_FULL_TXOP_PROT_MSK cpu_to_le32(1 << 7)
1496

W
Wey-Yi Guy 已提交
1497
/* Tx antenna selection field; used only for 3945, reserved (0) for agn devices.
1498
 * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
1499 1500 1501
#define TX_CMD_FLG_ANT_SEL_MSK cpu_to_le32(0xf00)
#define TX_CMD_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
#define TX_CMD_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
Z
Zhu Yi 已提交
1502

1503 1504
/* 1: Ignore Bluetooth priority for this frame.
 * 0: Delay Tx until Bluetooth device is done (normal usage). */
1505
#define TX_CMD_FLG_IGNORE_BT cpu_to_le32(1 << 12)
Z
Zhu Yi 已提交
1506

1507 1508 1509 1510
/* 1: uCode overrides sequence control field in MAC header.
 * 0: Driver provides sequence control field in MAC header.
 * Set this for management frames, non-QOS data frames, non-unicast frames,
 * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
1511
#define TX_CMD_FLG_SEQ_CTL_MSK cpu_to_le32(1 << 13)
Z
Zhu Yi 已提交
1512

1513 1514
/* 1: This frame is non-last MPDU; more fragments are coming.
 * 0: Last fragment, or not using fragmentation. */
1515
#define TX_CMD_FLG_MORE_FRAG_MSK cpu_to_le32(1 << 14)
Z
Zhu Yi 已提交
1516

1517 1518 1519
/* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
 * 0: No TSF required in outgoing frame.
 * Set this for transmitting beacons and probe responses. */
1520
#define TX_CMD_FLG_TSF_MSK cpu_to_le32(1 << 16)
Z
Zhu Yi 已提交
1521

1522 1523 1524 1525 1526 1527
/* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
 *    alignment of frame's payload data field.
 * 0: No pad
 * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
 * field (but not both).  Driver must align frame data (i.e. data following
 * MAC header) to DWORD boundary. */
1528
#define TX_CMD_FLG_MH_PAD_MSK cpu_to_le32(1 << 20)
Z
Zhu Yi 已提交
1529

1530 1531
/* accelerate aggregation support
 * 0 - no CCMP encryption; 1 - CCMP encryption */
1532
#define TX_CMD_FLG_AGG_CCMP_MSK cpu_to_le32(1 << 22)
1533

Z
Zhu Yi 已提交
1534
/* HCCA-AP - disable duration overwriting. */
1535
#define TX_CMD_FLG_DUR_MSK cpu_to_le32(1 << 25)
Z
Zhu Yi 已提交
1536

1537

Z
Zhu Yi 已提交
1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
/*
 * TX command security control
 */
#define TX_CMD_SEC_WEP  	0x01
#define TX_CMD_SEC_CCM  	0x02
#define TX_CMD_SEC_TKIP		0x03
#define TX_CMD_SEC_MSK		0x03
#define TX_CMD_SEC_SHIFT	6
#define TX_CMD_SEC_KEY128	0x08

1548 1549 1550 1551 1552 1553 1554 1555
/*
 * security overhead sizes
 */
#define WEP_IV_LEN 4
#define WEP_ICV_LEN 4
#define CCMP_MIC_LEN 8
#define TKIP_ICV_LEN 4

1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618
/*
 * REPLY_TX = 0x1c (command)
 */

struct iwl3945_tx_cmd {
	/*
	 * MPDU byte count:
	 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
	 * + 8 byte IV for CCM or TKIP (not used for WEP)
	 * + Data payload
	 * + 8-byte MIC (not used for CCM/WEP)
	 * NOTE:  Does not include Tx command bytes, post-MAC pad bytes,
	 *        MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
	 * Range: 14-2342 bytes.
	 */
	__le16 len;

	/*
	 * MPDU or MSDU byte count for next frame.
	 * Used for fragmentation and bursting, but not 11n aggregation.
	 * Same as "len", but for next frame.  Set to 0 if not applicable.
	 */
	__le16 next_frame_len;

	__le32 tx_flags;	/* TX_CMD_FLG_* */

	u8 rate;

	/* Index of recipient station in uCode's station table */
	u8 sta_id;
	u8 tid_tspec;
	u8 sec_ctl;
	u8 key[16];
	union {
		u8 byte[8];
		__le16 word[4];
		__le32 dw[2];
	} tkip_mic;
	__le32 next_frame_info;
	union {
		__le32 life_time;
		__le32 attempt;
	} stop_time;
	u8 supp_rates[2];
	u8 rts_retry_limit;	/*byte 50 */
	u8 data_retry_limit;	/*byte 51 */
	union {
		__le16 pm_frame_timeout;
		__le16 attempt_duration;
	} timeout;

	/*
	 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
	 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
	 */
	__le16 driver_txop;

	/*
	 * MAC header goes here, followed by 2 bytes padding if MAC header
	 * length is 26 or 30 bytes, followed by payload data
	 */
	u8 payload[0];
	struct ieee80211_hdr hdr[0];
1619
} __packed;
1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630

/*
 * REPLY_TX = 0x1c (response)
 */
struct iwl3945_tx_resp {
	u8 failure_rts;
	u8 failure_frame;
	u8 bt_kill_count;
	u8 rate;
	__le32 wireless_media_time;
	__le32 status;		/* TX status */
1631
} __packed;
1632 1633


Z
Zhu Yi 已提交
1634
/*
1635 1636 1637
 * 4965 uCode updates these Tx attempt count values in host DRAM.
 * Used for managing Tx retries when expecting block-acks.
 * Driver should set these fields to 0.
Z
Zhu Yi 已提交
1638
 */
1639
struct iwl_dram_scratch {
1640 1641
	u8 try_cnt;		/* Tx attempts */
	u8 bt_kill_cnt;		/* Tx attempts blocked by Bluetooth device */
Z
Zhu Yi 已提交
1642
	__le16 reserved;
1643
} __packed;
Z
Zhu Yi 已提交
1644

1645
struct iwl_tx_cmd {
1646 1647 1648 1649 1650 1651 1652 1653 1654 1655
	/*
	 * MPDU byte count:
	 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
	 * + 8 byte IV for CCM or TKIP (not used for WEP)
	 * + Data payload
	 * + 8-byte MIC (not used for CCM/WEP)
	 * NOTE:  Does not include Tx command bytes, post-MAC pad bytes,
	 *        MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
	 * Range: 14-2342 bytes.
	 */
Z
Zhu Yi 已提交
1656
	__le16 len;
1657 1658 1659 1660 1661 1662

	/*
	 * MPDU or MSDU byte count for next frame.
	 * Used for fragmentation and bursting, but not 11n aggregation.
	 * Same as "len", but for next frame.  Set to 0 if not applicable.
	 */
Z
Zhu Yi 已提交
1663
	__le16 next_frame_len;
1664 1665 1666

	__le32 tx_flags;	/* TX_CMD_FLG_* */

1667
	/* uCode may modify this field of the Tx command (in host DRAM!).
1668
	 * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
1669
	struct iwl_dram_scratch scratch;
1670 1671 1672 1673 1674

	/* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
	__le32 rate_n_flags;	/* RATE_MCS_* */

	/* Index of destination station in uCode's station table */
Z
Zhu Yi 已提交
1675
	u8 sta_id;
1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686

	/* Type of security encryption:  CCM or TKIP */
	u8 sec_ctl;		/* TX_CMD_SEC_* */

	/*
	 * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial
	 * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set.  Normally "0" for
	 * data frames, this field may be used to selectively reduce initial
	 * rate (via non-0 value) for special frames (e.g. management), while
	 * still supporting rate scaling for all frames.
	 */
Z
Zhu Yi 已提交
1687 1688 1689 1690 1691 1692 1693 1694 1695
	u8 initial_rate_index;
	u8 reserved;
	u8 key[16];
	__le16 next_frame_flags;
	__le16 reserved2;
	union {
		__le32 life_time;
		__le32 attempt;
	} stop_time;
1696 1697 1698

	/* Host DRAM physical address pointer to "scratch" in this command.
	 * Must be dword aligned.  "0" in dram_lsb_ptr disables usage. */
Z
Zhu Yi 已提交
1699 1700
	__le32 dram_lsb_ptr;
	u8 dram_msb_ptr;
1701

Z
Zhu Yi 已提交
1702 1703 1704 1705 1706 1707 1708
	u8 rts_retry_limit;	/*byte 50 */
	u8 data_retry_limit;	/*byte 51 */
	u8 tid_tspec;
	union {
		__le16 pm_frame_timeout;
		__le16 attempt_duration;
	} timeout;
1709 1710 1711 1712 1713

	/*
	 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
	 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
	 */
Z
Zhu Yi 已提交
1714
	__le16 driver_txop;
1715 1716 1717 1718 1719

	/*
	 * MAC header goes here, followed by 2 bytes padding if MAC header
	 * length is 26 or 30 bytes, followed by payload data
	 */
Z
Zhu Yi 已提交
1720 1721
	u8 payload[0];
	struct ieee80211_hdr hdr[0];
1722
} __packed;
Z
Zhu Yi 已提交
1723

1724
/* TX command response is sent after *3945* transmission attempts.
Z
Zhu Yi 已提交
1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750
 *
 * NOTES:
 *
 * TX_STATUS_FAIL_NEXT_FRAG
 *
 * If the fragment flag in the MAC header for the frame being transmitted
 * is set and there is insufficient time to transmit the next frame, the
 * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
 *
 * TX_STATUS_FIFO_UNDERRUN
 *
 * Indicates the host did not provide bytes to the FIFO fast enough while
 * a TX was in progress.
 *
 * TX_STATUS_FAIL_MGMNT_ABORT
 *
 * This status is only possible if the ABORT ON MGMT RX parameter was
 * set to true with the TX command.
 *
 * If the MSB of the status parameter is set then an abort sequence is
 * required.  This sequence consists of the host activating the TX Abort
 * control line, and then waiting for the TX Abort command response.  This
 * indicates that a the device is no longer in a transmit state, and that the
 * command FIFO has been cleared.  The host must then deactivate the TX Abort
 * control line.  Receiving is still allowed in this case.
 */
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778
enum {
	TX_3945_STATUS_SUCCESS = 0x01,
	TX_3945_STATUS_DIRECT_DONE = 0x02,
	TX_3945_STATUS_FAIL_SHORT_LIMIT = 0x82,
	TX_3945_STATUS_FAIL_LONG_LIMIT = 0x83,
	TX_3945_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
	TX_3945_STATUS_FAIL_MGMNT_ABORT = 0x85,
	TX_3945_STATUS_FAIL_NEXT_FRAG = 0x86,
	TX_3945_STATUS_FAIL_LIFE_EXPIRE = 0x87,
	TX_3945_STATUS_FAIL_DEST_PS = 0x88,
	TX_3945_STATUS_FAIL_ABORTED = 0x89,
	TX_3945_STATUS_FAIL_BT_RETRY = 0x8a,
	TX_3945_STATUS_FAIL_STA_INVALID = 0x8b,
	TX_3945_STATUS_FAIL_FRAG_DROPPED = 0x8c,
	TX_3945_STATUS_FAIL_TID_DISABLE = 0x8d,
	TX_3945_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
	TX_3945_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
	TX_3945_STATUS_FAIL_TX_LOCKED = 0x90,
	TX_3945_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
};

/*
 * TX command response is sent after *agn* transmission attempts.
 *
 * both postpone and abort status are expected behavior from uCode. there is
 * no special operation required from driver; except for RFKILL_FLUSH,
 * which required tx flush host command to flush all the tx frames in queues
 */
Z
Zhu Yi 已提交
1779 1780 1781
enum {
	TX_STATUS_SUCCESS = 0x01,
	TX_STATUS_DIRECT_DONE = 0x02,
1782 1783 1784 1785 1786 1787 1788 1789
	/* postpone TX */
	TX_STATUS_POSTPONE_DELAY = 0x40,
	TX_STATUS_POSTPONE_FEW_BYTES = 0x41,
	TX_STATUS_POSTPONE_BT_PRIO = 0x42,
	TX_STATUS_POSTPONE_QUIET_PERIOD = 0x43,
	TX_STATUS_POSTPONE_CALC_TTAK = 0x44,
	/* abort TX */
	TX_STATUS_FAIL_INTERNAL_CROSSED_RETRY = 0x81,
Z
Zhu Yi 已提交
1790 1791 1792
	TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
	TX_STATUS_FAIL_LONG_LIMIT = 0x83,
	TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
1793 1794
	TX_STATUS_FAIL_DRAIN_FLOW = 0x85,
	TX_STATUS_FAIL_RFKILL_FLUSH = 0x86,
Z
Zhu Yi 已提交
1795 1796
	TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
	TX_STATUS_FAIL_DEST_PS = 0x88,
1797
	TX_STATUS_FAIL_HOST_ABORTED = 0x89,
Z
Zhu Yi 已提交
1798 1799 1800 1801
	TX_STATUS_FAIL_BT_RETRY = 0x8a,
	TX_STATUS_FAIL_STA_INVALID = 0x8b,
	TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
	TX_STATUS_FAIL_TID_DISABLE = 0x8d,
1802
	TX_STATUS_FAIL_FIFO_FLUSHED = 0x8e,
Z
Zhu Yi 已提交
1803
	TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
1804 1805 1806 1807 1808 1809 1810
	/* uCode drop due to FW drop request */
	TX_STATUS_FAIL_FW_DROP = 0x90,
	/*
	 * uCode drop due to station color mismatch
	 * between tx command and station table
	 */
	TX_STATUS_FAIL_STA_COLOR_MISMATCH_DROP = 0x91,
Z
Zhu Yi 已提交
1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821
};

#define	TX_PACKET_MODE_REGULAR		0x0000
#define	TX_PACKET_MODE_BURST_SEQ	0x0100
#define	TX_PACKET_MODE_BURST_FIRST	0x0200

enum {
	TX_POWER_PA_NOT_ACTIVE = 0x0,
};

enum {
T
Tomas Winkler 已提交
1822
	TX_STATUS_MSK = 0x000000ff,		/* bits 0:7 */
Z
Zhu Yi 已提交
1823 1824 1825 1826
	TX_STATUS_DELAY_MSK = 0x00000040,
	TX_STATUS_ABORT_MSK = 0x00000080,
	TX_PACKET_MODE_MSK = 0x0000ff00,	/* bits 8:15 */
	TX_FIFO_NUMBER_MSK = 0x00070000,	/* bits 16:18 */
T
Tomas Winkler 已提交
1827
	TX_RESERVED = 0x00780000,		/* bits 19:22 */
Z
Zhu Yi 已提交
1828 1829 1830 1831 1832
	TX_POWER_PA_DETECT_MSK = 0x7f800000,	/* bits 23:30 */
	TX_ABORT_REQUIRED_MSK = 0x80000000,	/* bits 31:31 */
};

/* *******************************
1833
 * TX aggregation status
Z
Zhu Yi 已提交
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851
 ******************************* */

enum {
	AGG_TX_STATE_TRANSMITTED = 0x00,
	AGG_TX_STATE_UNDERRUN_MSK = 0x01,
	AGG_TX_STATE_BT_PRIO_MSK = 0x02,
	AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
	AGG_TX_STATE_ABORT_MSK = 0x08,
	AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
	AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
	AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
	AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
	AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
	AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
	AGG_TX_STATE_DUMP_TX_MSK = 0x200,
	AGG_TX_STATE_DELAY_TX_MSK = 0x400
};

T
Tomas Winkler 已提交
1852 1853 1854
#define AGG_TX_STATE_LAST_SENT_MSK  (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
				     AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
				     AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
Z
Zhu Yi 已提交
1855

1856
/* # tx attempts for first frame in aggregation */
Z
Zhu Yi 已提交
1857 1858 1859
#define AGG_TX_STATE_TRY_CNT_POS 12
#define AGG_TX_STATE_TRY_CNT_MSK 0xf000

1860
/* Command ID and sequence number of Tx command for this frame */
Z
Zhu Yi 已提交
1861 1862 1863 1864 1865
#define AGG_TX_STATE_SEQ_NUM_POS 16
#define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000

/*
 * REPLY_TX = 0x1c (response)
1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879
 *
 * This response may be in one of two slightly different formats, indicated
 * by the frame_count field:
 *
 * 1)  No aggregation (frame_count == 1).  This reports Tx results for
 *     a single frame.  Multiple attempts, at various bit rates, may have
 *     been made for this frame.
 *
 * 2)  Aggregation (frame_count > 1).  This reports Tx results for
 *     2 or more frames that used block-acknowledge.  All frames were
 *     transmitted at same rate.  Rate scaling may have been used if first
 *     frame in this new agg block failed in previous agg block(s).
 *
 *     Note that, for aggregation, ACK (block-ack) status is not delivered here;
W
Wey-Yi Guy 已提交
1880 1881
 *     block-ack has not been received by the time the agn device records
 *     this status.
1882
 *     This status relates to reasons the tx might have been blocked or aborted
W
Wey-Yi Guy 已提交
1883
 *     within the sending station (this agn device), rather than whether it was
1884
 *     received successfully by the destination station.
Z
Zhu Yi 已提交
1885
 */
1886 1887 1888
struct agg_tx_status {
	__le16 status;
	__le16 sequence;
1889
} __packed;
1890

C
Christoph Hellwig 已提交
1891
struct iwl4965_tx_resp {
Z
Zhu Yi 已提交
1892
	u8 frame_count;		/* 1 no aggregation, >1 aggregation */
1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904
	u8 bt_kill_count;	/* # blocked by bluetooth (unused for agg) */
	u8 failure_rts;		/* # failures due to unsuccessful RTS */
	u8 failure_frame;	/* # failures due to no ACK (unused for agg) */

	/* For non-agg:  Rate at which frame was successful.
	 * For agg:  Rate at which all frames were transmitted. */
	__le32 rate_n_flags;	/* RATE_MCS_*  */

	/* For non-agg:  RTS + CTS + frame tx attempts time + ACK.
	 * For agg:  RTS + CTS + aggregation tx time + block-ack time. */
	__le16 wireless_media_time;	/* uSecs */

Z
Zhu Yi 已提交
1905
	__le16 reserved;
1906
	__le32 pa_power1;	/* RF power amplifier measurement (not used) */
Z
Zhu Yi 已提交
1907
	__le32 pa_power2;
1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921

	/*
	 * For non-agg:  frame status TX_STATUS_*
	 * For agg:  status of 1st frame, AGG_TX_STATE_*; other frame status
	 *           fields follow this one, up to frame_count.
	 *           Bit fields:
	 *           11- 0:  AGG_TX_STATE_* status code
	 *           15-12:  Retry count for 1st frame in aggregation (retries
	 *                   occur if tx failed for this frame when it was a
	 *                   member of a previous aggregation block).  If rate
	 *                   scaling is used, retry count indicates the rate
	 *                   table entry used for all frames in the new agg.
	 *           31-16:  Sequence # for this frame's Tx cmd (not SSN!)
	 */
1922 1923 1924 1925
	union {
		__le32 status;
		struct agg_tx_status agg_status[0]; /* for each agg frame */
	} u;
1926
} __packed;
1927

T
Tomas Winkler 已提交
1928 1929
/*
 * definitions for initial rate index field
T
Tomas Winkler 已提交
1930
 * bits [3:0] initial rate index
T
Tomas Winkler 已提交
1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949
 * bits [6:4] rate table color, used for the initial rate
 * bit-7 invalid rate indication
 *   i.e. rate was not chosen from rate table
 *   or rate table color was changed during frame retries
 * refer tlc rate info
 */

#define IWL50_TX_RES_INIT_RATE_INDEX_POS	0
#define IWL50_TX_RES_INIT_RATE_INDEX_MSK	0x0f
#define IWL50_TX_RES_RATE_TABLE_COLOR_POS	4
#define IWL50_TX_RES_RATE_TABLE_COLOR_MSK	0x70
#define IWL50_TX_RES_INV_RATE_INDEX_MSK	0x80

/* refer to ra_tid */
#define IWL50_TX_RES_TID_POS	0
#define IWL50_TX_RES_TID_MSK	0x0f
#define IWL50_TX_RES_RA_POS	4
#define IWL50_TX_RES_RA_MSK	0xf0

1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963
struct iwl5000_tx_resp {
	u8 frame_count;		/* 1 no aggregation, >1 aggregation */
	u8 bt_kill_count;	/* # blocked by bluetooth (unused for agg) */
	u8 failure_rts;		/* # failures due to unsuccessful RTS */
	u8 failure_frame;	/* # failures due to no ACK (unused for agg) */

	/* For non-agg:  Rate at which frame was successful.
	 * For agg:  Rate at which all frames were transmitted. */
	__le32 rate_n_flags;	/* RATE_MCS_*  */

	/* For non-agg:  RTS + CTS + frame tx attempts time + ACK.
	 * For agg:  RTS + CTS + aggregation tx time + block-ack time. */
	__le16 wireless_media_time;	/* uSecs */

T
Tomas Winkler 已提交
1964 1965 1966 1967
	u8 pa_status;		/* RF power amplifier measurement (not used) */
	u8 pa_integ_res_a[3];
	u8 pa_integ_res_b[3];
	u8 pa_integ_res_C[3];
1968 1969 1970 1971

	__le32 tfd_info;
	__le16 seq_ctl;
	__le16 byte_cnt;
T
Tomas Winkler 已提交
1972 1973 1974
	u8 tlc_info;
	u8 ra_tid;		/* tid (0:3), sta_id (4:7) */
	__le16 frame_ctrl;
1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989
	/*
	 * For non-agg:  frame status TX_STATUS_*
	 * For agg:  status of 1st frame, AGG_TX_STATE_*; other frame status
	 *           fields follow this one, up to frame_count.
	 *           Bit fields:
	 *           11- 0:  AGG_TX_STATE_* status code
	 *           15-12:  Retry count for 1st frame in aggregation (retries
	 *                   occur if tx failed for this frame when it was a
	 *                   member of a previous aggregation block).  If rate
	 *                   scaling is used, retry count indicates the rate
	 *                   table entry used for all frames in the new agg.
	 *           31-16:  Sequence # for this frame's Tx cmd (not SSN!)
	 */
	struct agg_tx_status status;	/* TX status (in aggregation -
					 * status of 1st frame) */
1990
} __packed;
Z
Zhu Yi 已提交
1991 1992
/*
 * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
1993 1994
 *
 * Reports Block-Acknowledge from recipient station
Z
Zhu Yi 已提交
1995
 */
1996
struct iwl_compressed_ba_resp {
Z
Zhu Yi 已提交
1997 1998 1999
	__le32 sta_addr_lo32;
	__le16 sta_addr_hi16;
	__le16 reserved;
2000 2001

	/* Index of recipient (BA-sending) station in uCode's station table */
Z
Zhu Yi 已提交
2002 2003
	u8 sta_id;
	u8 tid;
2004 2005
	__le16 seq_ctl;
	__le64 bitmap;
Z
Zhu Yi 已提交
2006 2007
	__le16 scd_flow;
	__le16 scd_ssn;
2008
} __packed;
Z
Zhu Yi 已提交
2009 2010 2011

/*
 * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
B
Ben Cahill 已提交
2012 2013
 *
 * See details under "TXPOWER" in iwl-4965-hw.h.
Z
Zhu Yi 已提交
2014
 */
2015 2016 2017 2018 2019 2020

struct iwl3945_txpowertable_cmd {
	u8 band;		/* 0: 5 GHz, 1: 2.4 GHz */
	u8 reserved;
	__le16 channel;
	struct iwl3945_power_per_rate power[IWL_MAX_RATES];
2021
} __packed;
2022

C
Christoph Hellwig 已提交
2023
struct iwl4965_txpowertable_cmd {
Z
Zhu Yi 已提交
2024 2025 2026
	u8 band;		/* 0: 5 GHz, 1: 2.4 GHz */
	u8 reserved;
	__le16 channel;
C
Christoph Hellwig 已提交
2027
	struct iwl4965_tx_power_db tx_power;
2028
} __packed;
Z
Zhu Yi 已提交
2029

2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049

/**
 * struct iwl3945_rate_scaling_cmd - Rate Scaling Command & Response
 *
 * REPLY_RATE_SCALE = 0x47 (command, has simple generic response)
 *
 * NOTE: The table of rates passed to the uCode via the
 * RATE_SCALE command sets up the corresponding order of
 * rates used for all related commands, including rate
 * masks, etc.
 *
 * For example, if you set 9MB (PLCP 0x0f) as the first
 * rate in the rate table, the bit mask for that rate
 * when passed through ofdm_basic_rates on the REPLY_RXON
 * command would be bit 0 (1 << 0)
 */
struct iwl3945_rate_scaling_info {
	__le16 rate_n_flags;
	u8 try_cnt;
	u8 next_rate_index;
2050
} __packed;
2051 2052 2053 2054 2055

struct iwl3945_rate_scaling_cmd {
	u8 table_id;
	u8 reserved[3];
	struct iwl3945_rate_scaling_info table[IWL_MAX_RATES];
2056
} __packed;
2057 2058


Z
Zhu Yi 已提交
2059
/*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
2060
#define  LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK	(1 << 0)
Z
Zhu Yi 已提交
2061

B
Ben Cahill 已提交
2062
/* # of EDCA prioritized tx fifos */
Z
Zhu Yi 已提交
2063
#define  LINK_QUAL_AC_NUM AC_NUM
B
Ben Cahill 已提交
2064 2065

/* # entries in rate scale table to support Tx retries */
Z
Zhu Yi 已提交
2066 2067
#define  LINK_QUAL_MAX_RETRY_NUM 16

B
Ben Cahill 已提交
2068
/* Tx antenna selection values */
2069 2070
#define  LINK_QUAL_ANT_A_MSK (1 << 0)
#define  LINK_QUAL_ANT_B_MSK (1 << 1)
Z
Zhu Yi 已提交
2071 2072
#define  LINK_QUAL_ANT_MSK   (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)

B
Ben Cahill 已提交
2073 2074

/**
2075
 * struct iwl_link_qual_general_params
B
Ben Cahill 已提交
2076 2077 2078
 *
 * Used in REPLY_TX_LINK_QUALITY_CMD
 */
2079
struct iwl_link_qual_general_params {
Z
Zhu Yi 已提交
2080
	u8 flags;
B
Ben Cahill 已提交
2081 2082

	/* No entries at or above this (driver chosen) index contain MIMO */
Z
Zhu Yi 已提交
2083
	u8 mimo_delimiter;
B
Ben Cahill 已提交
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101

	/* Best single antenna to use for single stream (legacy, SISO). */
	u8 single_stream_ant_msk;	/* LINK_QUAL_ANT_* */

	/* Best antennas to use for MIMO (unused for 4965, assumes both). */
	u8 dual_stream_ant_msk;		/* LINK_QUAL_ANT_* */

	/*
	 * If driver needs to use different initial rates for different
	 * EDCA QOS access categories (as implemented by tx fifos 0-3),
	 * this table will set that up, by indicating the indexes in the
	 * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
	 * Otherwise, driver should set all entries to 0.
	 *
	 * Entry usage:
	 * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
	 * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
	 */
Z
Zhu Yi 已提交
2102
	u8 start_rate_index[LINK_QUAL_AC_NUM];
2103
} __packed;
Z
Zhu Yi 已提交
2104

2105
#define LINK_QUAL_AGG_TIME_LIMIT_DEF	(4000) /* 4 milliseconds */
2106 2107
#define LINK_QUAL_AGG_TIME_LIMIT_MAX	(8000)
#define LINK_QUAL_AGG_TIME_LIMIT_MIN	(100)
2108 2109 2110 2111 2112 2113

#define LINK_QUAL_AGG_DISABLE_START_DEF	(3)
#define LINK_QUAL_AGG_DISABLE_START_MAX	(255)
#define LINK_QUAL_AGG_DISABLE_START_MIN	(0)

#define LINK_QUAL_AGG_FRAME_LIMIT_DEF	(31)
J
Johannes Berg 已提交
2114
#define LINK_QUAL_AGG_FRAME_LIMIT_MAX	(63)
2115 2116
#define LINK_QUAL_AGG_FRAME_LIMIT_MIN	(0)

B
Ben Cahill 已提交
2117
/**
2118
 * struct iwl_link_qual_agg_params
B
Ben Cahill 已提交
2119 2120 2121
 *
 * Used in REPLY_TX_LINK_QUALITY_CMD
 */
2122
struct iwl_link_qual_agg_params {
B
Ben Cahill 已提交
2123

2124 2125 2126 2127
	/*
	 *Maximum number of uSec in aggregation.
	 * default set to 4000 (4 milliseconds) if not configured in .cfg
	 */
Z
Zhu Yi 已提交
2128
	__le16 agg_time_limit;
B
Ben Cahill 已提交
2129 2130 2131 2132 2133 2134 2135

	/*
	 * Number of Tx retries allowed for a frame, before that frame will
	 * no longer be considered for the start of an aggregation sequence
	 * (scheduler will then try to tx it as single frame).
	 * Driver should set this to 3.
	 */
Z
Zhu Yi 已提交
2136
	u8 agg_dis_start_th;
B
Ben Cahill 已提交
2137 2138 2139 2140 2141 2142

	/*
	 * Maximum number of frames in aggregation.
	 * 0 = no limit (default).  1 = no aggregation.
	 * Other values = max # frames in aggregation.
	 */
Z
Zhu Yi 已提交
2143
	u8 agg_frame_cnt_limit;
B
Ben Cahill 已提交
2144

Z
Zhu Yi 已提交
2145
	__le32 reserved;
2146
} __packed;
Z
Zhu Yi 已提交
2147 2148 2149

/*
 * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
B
Ben Cahill 已提交
2150
 *
W
Wey-Yi Guy 已提交
2151
 * For agn devices only; 3945 uses REPLY_RATE_SCALE.
B
Ben Cahill 已提交
2152
 *
W
Wey-Yi Guy 已提交
2153 2154
 * Each station in the agn device's internal station table has its own table
 * of 16
B
Ben Cahill 已提交
2155 2156 2157 2158
 * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
 * an ACK is not received.  This command replaces the entire table for
 * one station.
 *
W
Wey-Yi Guy 已提交
2159 2160
 * NOTE:  Station must already be in agn device's station table.
 *	  Use REPLY_ADD_STA.
B
Ben Cahill 已提交
2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177
 *
 * The rate scaling procedures described below work well.  Of course, other
 * procedures are possible, and may work better for particular environments.
 *
 *
 * FILLING THE RATE TABLE
 *
 * Given a particular initial rate and mode, as determined by the rate
 * scaling algorithm described below, the Linux driver uses the following
 * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
 * Link Quality command:
 *
 *
 * 1)  If using High-throughput (HT) (SISO or MIMO) initial rate:
 *     a) Use this same initial rate for first 3 entries.
 *     b) Find next lower available rate using same mode (SISO or MIMO),
 *        use for next 3 entries.  If no lower rate available, switch to
2178
 *        legacy mode (no HT40 channel, no MIMO, no short guard interval).
B
Ben Cahill 已提交
2179 2180
 *     c) If using MIMO, set command's mimo_delimiter to number of entries
 *        using MIMO (3 or 6).
2181
 *     d) After trying 2 HT rates, switch to legacy mode (no HT40 channel,
B
Ben Cahill 已提交
2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196
 *        no MIMO, no short guard interval), at the next lower bit rate
 *        (e.g. if second HT bit rate was 54, try 48 legacy), and follow
 *        legacy procedure for remaining table entries.
 *
 * 2)  If using legacy initial rate:
 *     a) Use the initial rate for only one entry.
 *     b) For each following entry, reduce the rate to next lower available
 *        rate, until reaching the lowest available rate.
 *     c) When reducing rate, also switch antenna selection.
 *     d) Once lowest available rate is reached, repeat this rate until
 *        rate table is filled (16 entries), switching antenna each entry.
 *
 *
 * ACCUMULATING HISTORY
 *
W
Wey-Yi Guy 已提交
2197 2198 2199 2200 2201 2202
 * The rate scaling algorithm for agn devices, as implemented in Linux driver,
 * uses two sets of frame Tx success history:  One for the current/active
 * modulation mode, and one for a speculative/search mode that is being
 * attempted. If the speculative mode turns out to be more effective (i.e.
 * actual transfer rate is better), then the driver continues to use the
 * speculative mode as the new current active mode.
B
Ben Cahill 已提交
2203 2204 2205 2206 2207 2208 2209 2210 2211 2212
 *
 * Each history set contains, separately for each possible rate, data for a
 * sliding window of the 62 most recent tx attempts at that rate.  The data
 * includes a shifting bitmap of success(1)/failure(0), and sums of successful
 * and attempted frames, from which the driver can additionally calculate a
 * success ratio (success / attempted) and number of failures
 * (attempted - success), and control the size of the window (attempted).
 * The driver uses the bit map to remove successes from the success sum, as
 * the oldest tx attempts fall out of the window.
 *
W
Wey-Yi Guy 已提交
2213 2214 2215 2216 2217 2218
 * When the agn device makes multiple tx attempts for a given frame, each
 * attempt might be at a different rate, and have different modulation
 * characteristics (e.g. antenna, fat channel, short guard interval), as set
 * up in the rate scaling table in the Link Quality command.  The driver must
 * determine which rate table entry was used for each tx attempt, to determine
 * which rate-specific history to update, and record only those attempts that
B
Ben Cahill 已提交
2219 2220 2221
 * match the modulation characteristics of the history set.
 *
 * When using block-ack (aggregation), all frames are transmitted at the same
T
Tomas Winkler 已提交
2222
 * rate, since there is no per-attempt acknowledgment from the destination
B
Ben Cahill 已提交
2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334
 * station.  The Tx response struct iwl_tx_resp indicates the Tx rate in
 * rate_n_flags field.  After receiving a block-ack, the driver can update
 * history for the entire block all at once.
 *
 *
 * FINDING BEST STARTING RATE:
 *
 * When working with a selected initial modulation mode (see below), the
 * driver attempts to find a best initial rate.  The initial rate is the
 * first entry in the Link Quality command's rate table.
 *
 * 1)  Calculate actual throughput (success ratio * expected throughput, see
 *     table below) for current initial rate.  Do this only if enough frames
 *     have been attempted to make the value meaningful:  at least 6 failed
 *     tx attempts, or at least 8 successes.  If not enough, don't try rate
 *     scaling yet.
 *
 * 2)  Find available rates adjacent to current initial rate.  Available means:
 *     a)  supported by hardware &&
 *     b)  supported by association &&
 *     c)  within any constraints selected by user
 *
 * 3)  Gather measured throughputs for adjacent rates.  These might not have
 *     enough history to calculate a throughput.  That's okay, we might try
 *     using one of them anyway!
 *
 * 4)  Try decreasing rate if, for current rate:
 *     a)  success ratio is < 15% ||
 *     b)  lower adjacent rate has better measured throughput ||
 *     c)  higher adjacent rate has worse throughput, and lower is unmeasured
 *
 *     As a sanity check, if decrease was determined above, leave rate
 *     unchanged if:
 *     a)  lower rate unavailable
 *     b)  success ratio at current rate > 85% (very good)
 *     c)  current measured throughput is better than expected throughput
 *         of lower rate (under perfect 100% tx conditions, see table below)
 *
 * 5)  Try increasing rate if, for current rate:
 *     a)  success ratio is < 15% ||
 *     b)  both adjacent rates' throughputs are unmeasured (try it!) ||
 *     b)  higher adjacent rate has better measured throughput ||
 *     c)  lower adjacent rate has worse throughput, and higher is unmeasured
 *
 *     As a sanity check, if increase was determined above, leave rate
 *     unchanged if:
 *     a)  success ratio at current rate < 70%.  This is not particularly
 *         good performance; higher rate is sure to have poorer success.
 *
 * 6)  Re-evaluate the rate after each tx frame.  If working with block-
 *     acknowledge, history and statistics may be calculated for the entire
 *     block (including prior history that fits within the history windows),
 *     before re-evaluation.
 *
 * FINDING BEST STARTING MODULATION MODE:
 *
 * After working with a modulation mode for a "while" (and doing rate scaling),
 * the driver searches for a new initial mode in an attempt to improve
 * throughput.  The "while" is measured by numbers of attempted frames:
 *
 * For legacy mode, search for new mode after:
 *   480 successful frames, or 160 failed frames
 * For high-throughput modes (SISO or MIMO), search for new mode after:
 *   4500 successful frames, or 400 failed frames
 *
 * Mode switch possibilities are (3 for each mode):
 *
 * For legacy:
 *   Change antenna, try SISO (if HT association), try MIMO (if HT association)
 * For SISO:
 *   Change antenna, try MIMO, try shortened guard interval (SGI)
 * For MIMO:
 *   Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)
 *
 * When trying a new mode, use the same bit rate as the old/current mode when
 * trying antenna switches and shortened guard interval.  When switching to
 * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate
 * for which the expected throughput (under perfect conditions) is about the
 * same or slightly better than the actual measured throughput delivered by
 * the old/current mode.
 *
 * Actual throughput can be estimated by multiplying the expected throughput
 * by the success ratio (successful / attempted tx frames).  Frame size is
 * not considered in this calculation; it assumes that frame size will average
 * out to be fairly consistent over several samples.  The following are
 * metric values for expected throughput assuming 100% success ratio.
 * Only G band has support for CCK rates:
 *
 *           RATE:  1    2    5   11    6   9   12   18   24   36   48   54   60
 *
 *              G:  7   13   35   58   40  57   72   98  121  154  177  186  186
 *              A:  0    0    0    0   40  57   72   98  121  154  177  186  186
 *     SISO 20MHz:  0    0    0    0   42  42   76  102  124  159  183  193  202
 * SGI SISO 20MHz:  0    0    0    0   46  46   82  110  132  168  192  202  211
 *     MIMO 20MHz:  0    0    0    0   74  74  123  155  179  214  236  244  251
 * SGI MIMO 20MHz:  0    0    0    0   81  81  131  164  188  222  243  251  257
 *     SISO 40MHz:  0    0    0    0   77  77  127  160  184  220  242  250  257
 * SGI SISO 40MHz:  0    0    0    0   83  83  135  169  193  229  250  257  264
 *     MIMO 40MHz:  0    0    0    0  123 123  182  214  235  264  279  285  289
 * SGI MIMO 40MHz:  0    0    0    0  131 131  191  222  242  270  284  289  293
 *
 * After the new mode has been tried for a short while (minimum of 6 failed
 * frames or 8 successful frames), compare success ratio and actual throughput
 * estimate of the new mode with the old.  If either is better with the new
 * mode, continue to use the new mode.
 *
 * Continue comparing modes until all 3 possibilities have been tried.
 * If moving from legacy to HT, try all 3 possibilities from the new HT
 * mode.  After trying all 3, a best mode is found.  Continue to use this mode
 * for the longer "while" described above (e.g. 480 successful frames for
 * legacy), and then repeat the search process.
 *
Z
Zhu Yi 已提交
2335
 */
2336
struct iwl_link_quality_cmd {
B
Ben Cahill 已提交
2337 2338

	/* Index of destination/recipient station in uCode's station table */
Z
Zhu Yi 已提交
2339 2340
	u8 sta_id;
	u8 reserved1;
B
Ben Cahill 已提交
2341
	__le16 control;		/* not used */
2342 2343
	struct iwl_link_qual_general_params general_params;
	struct iwl_link_qual_agg_params agg_params;
B
Ben Cahill 已提交
2344 2345 2346 2347

	/*
	 * Rate info; when using rate-scaling, Tx command's initial_rate_index
	 * specifies 1st Tx rate attempted, via index into this table.
W
Wey-Yi Guy 已提交
2348
	 * agn devices works its way through table when retrying Tx.
B
Ben Cahill 已提交
2349
	 */
Z
Zhu Yi 已提交
2350
	struct {
B
Ben Cahill 已提交
2351
		__le32 rate_n_flags;	/* RATE_MCS_*, IWL_RATE_* */
Z
Zhu Yi 已提交
2352 2353
	} rs_table[LINK_QUAL_MAX_RETRY_NUM];
	__le32 reserved2;
2354
} __packed;
Z
Zhu Yi 已提交
2355

2356 2357 2358 2359 2360 2361 2362 2363 2364
/*
 * BT configuration enable flags:
 *   bit 0 - 1: BT channel announcement enabled
 *           0: disable
 *   bit 1 - 1: priority of BT device enabled
 *           0: disable
 *   bit 2 - 1: BT 2 wire support enabled
 *           0: disable
 */
2365
#define BT_COEX_DISABLE (0x0)
2366 2367 2368
#define BT_ENABLE_CHANNEL_ANNOUNCE BIT(0)
#define BT_ENABLE_PRIORITY	   BIT(1)
#define BT_ENABLE_2_WIRE	   BIT(2)
2369

2370 2371 2372
#define BT_COEX_DISABLE (0x0)
#define BT_COEX_ENABLE  (BT_ENABLE_CHANNEL_ANNOUNCE | BT_ENABLE_PRIORITY)

2373 2374 2375 2376 2377 2378 2379 2380
#define BT_LEAD_TIME_MIN (0x0)
#define BT_LEAD_TIME_DEF (0x1E)
#define BT_LEAD_TIME_MAX (0xFF)

#define BT_MAX_KILL_MIN (0x1)
#define BT_MAX_KILL_DEF (0x5)
#define BT_MAX_KILL_MAX (0xFF)

Z
Zhu Yi 已提交
2381 2382
/*
 * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
B
Ben Cahill 已提交
2383
 *
W
Wey-Yi Guy 已提交
2384
 * 3945 and agn devices support hardware handshake with Bluetooth device on
B
Ben Cahill 已提交
2385
 * same platform.  Bluetooth device alerts wireless device when it will Tx;
T
Tomas Winkler 已提交
2386
 * wireless device can delay or kill its own Tx to accommodate.
Z
Zhu Yi 已提交
2387
 */
2388
struct iwl_bt_cmd {
Z
Zhu Yi 已提交
2389 2390 2391 2392 2393 2394
	u8 flags;
	u8 lead_time;
	u8 max_kill;
	u8 reserved;
	__le32 kill_ack_mask;
	__le32 kill_cts_mask;
2395
} __packed;
Z
Zhu Yi 已提交
2396

2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458
#define IWL6000G2B_BT_FLAG_CHANNEL_INHIBITION	BIT(0)

#define IWL6000G2B_BT_FLAG_COEX_MODE_MASK	(BIT(3)|BIT(4)|BIT(5))
#define IWL6000G2B_BT_FLAG_COEX_MODE_SHIFT	3
#define IWL6000G2B_BT_FLAG_COEX_MODE_DISABLED	0
#define IWL6000G2B_BT_FLAG_COEX_MODE_LEGACY_2W	1
#define IWL6000G2B_BT_FLAG_COEX_MODE_3W		2
#define IWL6000G2B_BT_FLAG_COEX_MODE_4W		3

#define IWL6000G2B_BT_FLAG_UCODE_DEFAULT	BIT(6)
#define IWL6000G2B_BT_FLAG_NOCOEX_NOTIF		BIT(7)

#define IWL6000G2B_BT_PRIO_BOOST_MAX		0xFF
#define IWL6000G2B_BT_PRIO_BOOST_MIN		0x00
#define IWL6000G2B_BT_PRIO_BOOST_DEFAULT	0x00

#define IWL6000G2B_BT_MAX_KILL_DEFAULT		5

#define IWL6000G2B_BT3_T7_DEFAULT		1

#define IWL6000G2B_BT_KILL_ACK_MASK_DEFAULT	cpu_to_le32(0xffffffff)
#define IWL6000G2B_BT_KILL_CTS_MASK_DEFAULT	cpu_to_le32(0xffffffff)

#define IWL6000G2B_BT3_PRIO_SAMPLE_DEFAULT	2

#define IWL6000G2B_BT3_T2_DEFAULT		0xc

#define IWL6000G2B_BT_VALID_ENABLE_FLAGS	cpu_to_le16(BIT(0))
#define IWL6000G2B_BT_VALID_BOOST		cpu_to_le16(BIT(1))
#define IWL6000G2B_BT_VALID_MAX_KILL		cpu_to_le16(BIT(2))
#define IWL6000G2B_BT_VALID_3W_TIMERS		cpu_to_le16(BIT(3))
#define IWL6000G2B_BT_VALID_KILL_ACK_MASK	cpu_to_le16(BIT(4))
#define IWL6000G2B_BT_VALID_KILL_CTS_MASK	cpu_to_le16(BIT(5))
#define IWL6000G2B_BT_VALID_BT4_TIMES		cpu_to_le16(BIT(6))
#define IWL6000G2B_BT_VALID_3W_LUT		cpu_to_le16(BIT(7))

#define IWL6000G2B_BT_ALL_VALID_MSK	(IWL6000G2B_BT_VALID_ENABLE_FLAGS | \
					IWL6000G2B_BT_VALID_BOOST | \
					IWL6000G2B_BT_VALID_MAX_KILL | \
					IWL6000G2B_BT_VALID_3W_TIMERS | \
					IWL6000G2B_BT_VALID_KILL_ACK_MASK | \
					IWL6000G2B_BT_VALID_KILL_CTS_MASK | \
					IWL6000G2B_BT_VALID_BT4_TIMES | \
					IWL6000G2B_BT_VALID_3W_LUT)

struct iwl6000g2b_bt_cmd {
	u8 flags;
	u8 ledtime; /* unused */
	u8 max_kill;
	u8 bt3_timer_t7_value;
	__le32 kill_ack_mask;
	__le32 kill_cts_mask;
	u8 bt3_prio_sample_time;
	u8 bt3_timer_t2_value;
	__le16 bt4_reaction_time; /* unused */
	__le32 bt3_lookup_table[12];
	__le16 bt4_decision_time; /* unused */
	__le16 valid;
	u8 prio_boost;
	u8 reserved[3];
};

Z
Zhu Yi 已提交
2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475
/******************************************************************************
 * (6)
 * Spectrum Management (802.11h) Commands, Responses, Notifications:
 *
 *****************************************************************************/

/*
 * Spectrum Management
 */
#define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK         | \
				 RXON_FILTER_CTL2HOST_MSK        | \
				 RXON_FILTER_ACCEPT_GRP_MSK      | \
				 RXON_FILTER_DIS_DECRYPT_MSK     | \
				 RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
				 RXON_FILTER_ASSOC_MSK           | \
				 RXON_FILTER_BCON_AWARE_MSK)

2476
struct iwl_measure_channel {
Z
Zhu Yi 已提交
2477 2478 2479
	__le32 duration;	/* measurement duration in extended beacon
				 * format */
	u8 channel;		/* channel to measure */
2480
	u8 type;		/* see enum iwl_measure_type */
Z
Zhu Yi 已提交
2481
	__le16 reserved;
2482
} __packed;
Z
Zhu Yi 已提交
2483 2484 2485 2486

/*
 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
 */
2487
struct iwl_spectrum_cmd {
Z
Zhu Yi 已提交
2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499
	__le16 len;		/* number of bytes starting from token */
	u8 token;		/* token id */
	u8 id;			/* measurement id -- 0 or 1 */
	u8 origin;		/* 0 = TGh, 1 = other, 2 = TGk */
	u8 periodic;		/* 1 = periodic */
	__le16 path_loss_timeout;
	__le32 start_time;	/* start time in extended beacon format */
	__le32 reserved2;
	__le32 flags;		/* rxon flags */
	__le32 filter_flags;	/* rxon filter flags */
	__le16 channel_count;	/* minimum 1, maximum 10 */
	__le16 reserved3;
2500
	struct iwl_measure_channel channels[10];
2501
} __packed;
Z
Zhu Yi 已提交
2502 2503 2504 2505

/*
 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
 */
2506
struct iwl_spectrum_resp {
Z
Zhu Yi 已提交
2507 2508 2509 2510 2511
	u8 token;
	u8 id;			/* id of the prior command replaced, or 0xff */
	__le16 status;		/* 0 - command will be handled
				 * 1 - cannot handle (conflicts with another
				 *     measurement) */
2512
} __packed;
Z
Zhu Yi 已提交
2513

2514
enum iwl_measurement_state {
Z
Zhu Yi 已提交
2515 2516 2517 2518
	IWL_MEASUREMENT_START = 0,
	IWL_MEASUREMENT_STOP = 1,
};

2519
enum iwl_measurement_status {
Z
Zhu Yi 已提交
2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531
	IWL_MEASUREMENT_OK = 0,
	IWL_MEASUREMENT_CONCURRENT = 1,
	IWL_MEASUREMENT_CSA_CONFLICT = 2,
	IWL_MEASUREMENT_TGH_CONFLICT = 3,
	/* 4-5 reserved */
	IWL_MEASUREMENT_STOPPED = 6,
	IWL_MEASUREMENT_TIMEOUT = 7,
	IWL_MEASUREMENT_PERIODIC_FAILED = 8,
};

#define NUM_ELEMENTS_IN_HISTOGRAM 8

2532
struct iwl_measurement_histogram {
Z
Zhu Yi 已提交
2533 2534
	__le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM];	/* in 0.8usec counts */
	__le32 cck[NUM_ELEMENTS_IN_HISTOGRAM];	/* in 1usec counts */
2535
} __packed;
Z
Zhu Yi 已提交
2536 2537

/* clear channel availability counters */
2538
struct iwl_measurement_cca_counters {
Z
Zhu Yi 已提交
2539 2540
	__le32 ofdm;
	__le32 cck;
2541
} __packed;
Z
Zhu Yi 已提交
2542

2543
enum iwl_measure_type {
Z
Zhu Yi 已提交
2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555
	IWL_MEASURE_BASIC = (1 << 0),
	IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
	IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
	IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
	IWL_MEASURE_FRAME = (1 << 4),
	/* bits 5:6 are reserved */
	IWL_MEASURE_IDLE = (1 << 7),
};

/*
 * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
 */
2556
struct iwl_spectrum_notification {
Z
Zhu Yi 已提交
2557 2558 2559 2560 2561 2562 2563
	u8 id;			/* measurement id -- 0 or 1 */
	u8 token;
	u8 channel_index;	/* index in measurement channel list */
	u8 state;		/* 0 - start, 1 - stop */
	__le32 start_time;	/* lower 32-bits of TSF */
	u8 band;		/* 0 - 5.2GHz, 1 - 2.4GHz */
	u8 channel;
2564
	u8 type;		/* see enum iwl_measurement_type */
Z
Zhu Yi 已提交
2565 2566 2567 2568 2569 2570 2571 2572 2573
	u8 reserved1;
	/* NOTE:  cca_ofdm, cca_cck, basic_type, and histogram are only only
	 * valid if applicable for measurement type requested. */
	__le32 cca_ofdm;	/* cca fraction time in 40Mhz clock periods */
	__le32 cca_cck;		/* cca fraction time in 44Mhz clock periods */
	__le32 cca_time;	/* channel load time in usecs */
	u8 basic_type;		/* 0 - bss, 1 - ofdm preamble, 2 -
				 * unidentified */
	u8 reserved2[3];
2574
	struct iwl_measurement_histogram histogram;
Z
Zhu Yi 已提交
2575
	__le32 stop_time;	/* lower 32-bits of TSF */
2576
	__le32 status;		/* see iwl_measurement_status */
2577
} __packed;
Z
Zhu Yi 已提交
2578 2579 2580 2581 2582 2583 2584 2585

/******************************************************************************
 * (7)
 * Power Management Commands, Responses, Notifications:
 *
 *****************************************************************************/

/**
2586
 * struct iwl_powertable_cmd - Power Table Command
Z
Zhu Yi 已提交
2587 2588 2589 2590 2591 2592 2593
 * @flags: See below:
 *
 * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
 *
 * PM allow:
 *   bit 0 - '0' Driver not allow power management
 *           '1' Driver allow PM (use rest of parameters)
2594
 *
Z
Zhu Yi 已提交
2595 2596 2597
 * uCode send sleep notifications:
 *   bit 1 - '0' Don't send sleep notification
 *           '1' send sleep notification (SEND_PM_NOTIFICATION)
2598
 *
Z
Zhu Yi 已提交
2599 2600 2601
 * Sleep over DTIM
 *   bit 2 - '0' PM have to walk up every DTIM
 *           '1' PM could sleep over DTIM till listen Interval.
2602
 *
Z
Zhu Yi 已提交
2603
 * PCI power managed
2604 2605
 *   bit 3 - '0' (PCI_CFG_LINK_CTRL & 0x1)
 *           '1' !(PCI_CFG_LINK_CTRL & 0x1)
2606 2607 2608 2609
 *
 * Fast PD
 *   bit 4 - '1' Put radio to sleep when receiving frame for others
 *
Z
Zhu Yi 已提交
2610 2611 2612 2613 2614 2615 2616
 * Force sleep Modes
 *   bit 31/30- '00' use both mac/xtal sleeps
 *              '01' force Mac sleep
 *              '10' force xtal sleep
 *              '11' Illegal set
 *
 * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
T
Tomas Winkler 已提交
2617
 * ucode assume sleep over DTIM is allowed and we don't need to wake up
Z
Zhu Yi 已提交
2618 2619 2620 2621
 * for every DTIM.
 */
#define IWL_POWER_VEC_SIZE 5

2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632
#define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK	cpu_to_le16(BIT(0))
#define IWL_POWER_SLEEP_OVER_DTIM_MSK		cpu_to_le16(BIT(2))
#define IWL_POWER_PCI_PM_MSK			cpu_to_le16(BIT(3))
#define IWL_POWER_FAST_PD			cpu_to_le16(BIT(4))

struct iwl3945_powertable_cmd {
	__le16 flags;
	u8 reserved[2];
	__le32 rx_data_timeout;
	__le32 tx_data_timeout;
	__le32 sleep_interval[IWL_POWER_VEC_SIZE];
2633
} __packed;
Z
Zhu Yi 已提交
2634

2635
struct iwl_powertable_cmd {
Z
Zhu Yi 已提交
2636
	__le16 flags;
2637 2638
	u8 keep_alive_seconds;		/* 3945 reserved */
	u8 debug_flags;			/* 3945 reserved */
Z
Zhu Yi 已提交
2639 2640 2641 2642
	__le32 rx_data_timeout;
	__le32 tx_data_timeout;
	__le32 sleep_interval[IWL_POWER_VEC_SIZE];
	__le32 keep_alive_beacons;
2643
} __packed;
Z
Zhu Yi 已提交
2644 2645 2646

/*
 * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
W
Wey-Yi Guy 已提交
2647
 * all devices identical.
Z
Zhu Yi 已提交
2648
 */
2649
struct iwl_sleep_notification {
Z
Zhu Yi 已提交
2650 2651 2652 2653 2654 2655
	u8 pm_sleep_mode;
	u8 pm_wakeup_src;
	__le16 reserved;
	__le32 sleep_time;
	__le32 tsf_low;
	__le32 bcon_timer;
2656
} __packed;
Z
Zhu Yi 已提交
2657

W
Wey-Yi Guy 已提交
2658
/* Sleep states.  all devices identical. */
Z
Zhu Yi 已提交
2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678
enum {
	IWL_PM_NO_SLEEP = 0,
	IWL_PM_SLP_MAC = 1,
	IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
	IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
	IWL_PM_SLP_PHY = 4,
	IWL_PM_SLP_REPENT = 5,
	IWL_PM_WAKEUP_BY_TIMER = 6,
	IWL_PM_WAKEUP_BY_DRIVER = 7,
	IWL_PM_WAKEUP_BY_RFKILL = 8,
	/* 3 reserved */
	IWL_PM_NUM_OF_MODES = 12,
};

/*
 * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
 */
#define CARD_STATE_CMD_DISABLE 0x00	/* Put card to sleep */
#define CARD_STATE_CMD_ENABLE  0x01	/* Wake up card */
#define CARD_STATE_CMD_HALT    0x02	/* Power down permanently */
2679
struct iwl_card_state_cmd {
Z
Zhu Yi 已提交
2680
	__le32 status;		/* CARD_STATE_CMD_* request new power state */
2681
} __packed;
Z
Zhu Yi 已提交
2682 2683 2684 2685

/*
 * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
 */
2686
struct iwl_card_state_notif {
Z
Zhu Yi 已提交
2687
	__le32 flags;
2688
} __packed;
Z
Zhu Yi 已提交
2689 2690 2691

#define HW_CARD_DISABLED   0x01
#define SW_CARD_DISABLED   0x02
W
Wey-Yi Guy 已提交
2692
#define CT_CARD_DISABLED   0x04
Z
Zhu Yi 已提交
2693 2694
#define RXON_CARD_DISABLED 0x10

2695
struct iwl_ct_kill_config {
Z
Zhu Yi 已提交
2696 2697 2698
	__le32   reserved;
	__le32   critical_temperature_M;
	__le32   critical_temperature_R;
2699
}  __packed;
Z
Zhu Yi 已提交
2700

2701 2702 2703 2704 2705
/* 1000, and 6x00 */
struct iwl_ct_kill_throttling_config {
	__le32   critical_temperature_exit;
	__le32   reserved;
	__le32   critical_temperature_enter;
2706
}  __packed;
2707

Z
Zhu Yi 已提交
2708 2709 2710 2711 2712 2713
/******************************************************************************
 * (8)
 * Scan Commands, Responses, Notifications:
 *
 *****************************************************************************/

2714 2715
#define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0)
#define SCAN_CHANNEL_TYPE_ACTIVE  cpu_to_le32(1)
2716

B
Ben Cahill 已提交
2717
/**
2718
 * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table
B
Ben Cahill 已提交
2719 2720 2721 2722 2723 2724 2725 2726 2727
 *
 * One for each channel in the scan list.
 * Each channel can independently select:
 * 1)  SSID for directed active scans
 * 2)  Txpower setting (for rate specified within Tx command)
 * 3)  How long to stay on-channel (behavior may be modified by quiet_time,
 *     quiet_plcp_th, good_CRC_th)
 *
 * To avoid uCode errors, make sure the following are true (see comments
2728
 * under struct iwl_scan_cmd about max_out_time and quiet_time):
B
Ben Cahill 已提交
2729 2730 2731 2732 2733 2734 2735
 * 1)  If using passive_dwell (i.e. passive_dwell != 0):
 *     active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
 * 2)  quiet_time <= active_dwell
 * 3)  If restricting off-channel time (i.e. max_out_time !=0):
 *     passive_dwell < max_out_time
 *     active_dwell < max_out_time
 */
2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750

/* FIXME: rename to AP1, remove tpc */
struct iwl3945_scan_channel {
	/*
	 * type is defined as:
	 * 0:0 1 = active, 0 = passive
	 * 1:4 SSID direct bit map; if a bit is set, then corresponding
	 *     SSID IE is transmitted in probe request.
	 * 5:7 reserved
	 */
	u8 type;
	u8 channel;	/* band is selected by iwl3945_scan_cmd "flags" field */
	struct iwl3945_tx_power tpc;
	__le16 active_dwell;	/* in 1024-uSec TU (time units), typ 5-50 */
	__le16 passive_dwell;	/* in 1024-uSec TU (time units), typ 20-500 */
2751
} __packed;
2752

2753 2754 2755
/* set number of direct probes u8 type */
#define IWL39_SCAN_PROBE_MASK(n) ((BIT(n) | (BIT(n) - BIT(1))))

2756
struct iwl_scan_channel {
B
Ben Cahill 已提交
2757 2758 2759
	/*
	 * type is defined as:
	 * 0:0 1 = active, 0 = passive
2760
	 * 1:20 SSID direct bit map; if a bit is set, then corresponding
B
Ben Cahill 已提交
2761
	 *     SSID IE is transmitted in probe request.
2762
	 * 21:31 reserved
Z
Zhu Yi 已提交
2763
	 */
2764 2765
	__le32 type;
	__le16 channel;	/* band is selected by iwl_scan_cmd "flags" field */
T
Tomas Winkler 已提交
2766 2767
	u8 tx_gain;		/* gain for analog radio */
	u8 dsp_atten;		/* gain for DSP */
B
Ben Cahill 已提交
2768 2769
	__le16 active_dwell;	/* in 1024-uSec TU (time units), typ 5-50 */
	__le16 passive_dwell;	/* in 1024-uSec TU (time units), typ 20-500 */
2770
} __packed;
Z
Zhu Yi 已提交
2771

2772 2773 2774
/* set number of direct probes __le32 type */
#define IWL_SCAN_PROBE_MASK(n) 	cpu_to_le32((BIT(n) | (BIT(n) - BIT(1))))

B
Ben Cahill 已提交
2775
/**
2776
 * struct iwl_ssid_ie - directed scan network information element
B
Ben Cahill 已提交
2777
 *
2778 2779 2780 2781
 * Up to 20 of these may appear in REPLY_SCAN_CMD (Note: Only 4 are in
 * 3945 SCAN api), selected by "type" bit field in struct iwl_scan_channel;
 * each channel may select different ssids from among the 20 (4) entries.
 * SSID IEs get transmitted in reverse order of entry.
B
Ben Cahill 已提交
2782
 */
2783
struct iwl_ssid_ie {
Z
Zhu Yi 已提交
2784 2785 2786
	u8 id;
	u8 len;
	u8 ssid[32];
2787
} __packed;
Z
Zhu Yi 已提交
2788

2789 2790
#define PROBE_OPTION_MAX_3945		4
#define PROBE_OPTION_MAX		20
2791
#define TX_CMD_LIFE_TIME_INFINITE	cpu_to_le32(0xFFFFFFFF)
2792 2793 2794
#define IWL_GOOD_CRC_TH_DISABLED	0
#define IWL_GOOD_CRC_TH_DEFAULT		cpu_to_le16(1)
#define IWL_GOOD_CRC_TH_NEVER		cpu_to_le16(0xffff)
Z
Zhu Yi 已提交
2795
#define IWL_MAX_SCAN_SIZE 1024
2796
#define IWL_MAX_CMD_SIZE 4096
Z
Zhu Yi 已提交
2797 2798 2799

/*
 * REPLY_SCAN_CMD = 0x80 (command)
B
Ben Cahill 已提交
2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847
 *
 * The hardware scan command is very powerful; the driver can set it up to
 * maintain (relatively) normal network traffic while doing a scan in the
 * background.  The max_out_time and suspend_time control the ratio of how
 * long the device stays on an associated network channel ("service channel")
 * vs. how long it's away from the service channel, i.e. tuned to other channels
 * for scanning.
 *
 * max_out_time is the max time off-channel (in usec), and suspend_time
 * is how long (in "extended beacon" format) that the scan is "suspended"
 * after returning to the service channel.  That is, suspend_time is the
 * time that we stay on the service channel, doing normal work, between
 * scan segments.  The driver may set these parameters differently to support
 * scanning when associated vs. not associated, and light vs. heavy traffic
 * loads when associated.
 *
 * After receiving this command, the device's scan engine does the following;
 *
 * 1)  Sends SCAN_START notification to driver
 * 2)  Checks to see if it has time to do scan for one channel
 * 3)  Sends NULL packet, with power-save (PS) bit set to 1,
 *     to tell AP that we're going off-channel
 * 4)  Tunes to first channel in scan list, does active or passive scan
 * 5)  Sends SCAN_RESULT notification to driver
 * 6)  Checks to see if it has time to do scan on *next* channel in list
 * 7)  Repeats 4-6 until it no longer has time to scan the next channel
 *     before max_out_time expires
 * 8)  Returns to service channel
 * 9)  Sends NULL packet with PS=0 to tell AP that we're back
 * 10) Stays on service channel until suspend_time expires
 * 11) Repeats entire process 2-10 until list is complete
 * 12) Sends SCAN_COMPLETE notification
 *
 * For fast, efficient scans, the scan command also has support for staying on
 * a channel for just a short time, if doing active scanning and getting no
 * responses to the transmitted probe request.  This time is controlled by
 * quiet_time, and the number of received packets below which a channel is
 * considered "quiet" is controlled by quiet_plcp_threshold.
 *
 * For active scanning on channels that have regulatory restrictions against
 * blindly transmitting, the scan can listen before transmitting, to make sure
 * that there is already legitimate activity on the channel.  If enough
 * packets are cleanly received on the channel (controlled by good_CRC_th,
 * typical value 1), the scan engine starts transmitting probe requests.
 *
 * Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
 *
 * To avoid uCode errors, see timing restrictions described under
2848
 * struct iwl_scan_channel.
Z
Zhu Yi 已提交
2849
 */
2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874

struct iwl3945_scan_cmd {
	__le16 len;
	u8 reserved0;
	u8 channel_count;	/* # channels in channel list */
	__le16 quiet_time;	/* dwell only this # millisecs on quiet channel
				 * (only for active scan) */
	__le16 quiet_plcp_th;	/* quiet chnl is < this # pkts (typ. 1) */
	__le16 good_CRC_th;	/* passive -> active promotion threshold */
	__le16 reserved1;
	__le32 max_out_time;	/* max usec to be away from associated (service)
				 * channel */
	__le32 suspend_time;	/* pause scan this long (in "extended beacon
				 * format") when returning to service channel:
				 * 3945; 31:24 # beacons, 19:0 additional usec,
				 * 4965; 31:22 # beacons, 21:0 additional usec.
				 */
	__le32 flags;		/* RXON_FLG_* */
	__le32 filter_flags;	/* RXON_FILTER_* */

	/* For active scans (set to all-0s for passive scans).
	 * Does not include payload.  Must specify Tx rate; no rate scaling. */
	struct iwl3945_tx_cmd tx_cmd;

	/* For directed active scans (set to all-0s otherwise) */
2875
	struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX_3945];
2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892

	/*
	 * Probe request frame, followed by channel list.
	 *
	 * Size of probe request frame is specified by byte count in tx_cmd.
	 * Channel list follows immediately after probe request frame.
	 * Number of channels in list is specified by channel_count.
	 * Each channel in list is of type:
	 *
	 * struct iwl3945_scan_channel channels[0];
	 *
	 * NOTE:  Only one band of channels can be scanned per pass.  You
	 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
	 * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
	 * before requesting another scan.
	 */
	u8 data[0];
2893
} __packed;
2894

2895
struct iwl_scan_cmd {
Z
Zhu Yi 已提交
2896 2897
	__le16 len;
	u8 reserved0;
B
Ben Cahill 已提交
2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915
	u8 channel_count;	/* # channels in channel list */
	__le16 quiet_time;	/* dwell only this # millisecs on quiet channel
				 * (only for active scan) */
	__le16 quiet_plcp_th;	/* quiet chnl is < this # pkts (typ. 1) */
	__le16 good_CRC_th;	/* passive -> active promotion threshold */
	__le16 rx_chain;	/* RXON_RX_CHAIN_* */
	__le32 max_out_time;	/* max usec to be away from associated (service)
				 * channel */
	__le32 suspend_time;	/* pause scan this long (in "extended beacon
				 * format") when returning to service chnl:
				 * 3945; 31:24 # beacons, 19:0 additional usec,
				 * 4965; 31:22 # beacons, 21:0 additional usec.
				 */
	__le32 flags;		/* RXON_FLG_* */
	__le32 filter_flags;	/* RXON_FILTER_* */

	/* For active scans (set to all-0s for passive scans).
	 * Does not include payload.  Must specify Tx rate; no rate scaling. */
2916
	struct iwl_tx_cmd tx_cmd;
B
Ben Cahill 已提交
2917 2918

	/* For directed active scans (set to all-0s otherwise) */
2919
	struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
Z
Zhu Yi 已提交
2920 2921

	/*
B
Ben Cahill 已提交
2922 2923 2924 2925 2926 2927
	 * Probe request frame, followed by channel list.
	 *
	 * Size of probe request frame is specified by byte count in tx_cmd.
	 * Channel list follows immediately after probe request frame.
	 * Number of channels in list is specified by channel_count.
	 * Each channel in list is of type:
Z
Zhu Yi 已提交
2928
	 *
2929
	 * struct iwl_scan_channel channels[0];
Z
Zhu Yi 已提交
2930 2931
	 *
	 * NOTE:  Only one band of channels can be scanned per pass.  You
B
Ben Cahill 已提交
2932 2933 2934
	 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
	 * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
	 * before requesting another scan.
Z
Zhu Yi 已提交
2935
	 */
B
Ben Cahill 已提交
2936
	u8 data[0];
2937
} __packed;
Z
Zhu Yi 已提交
2938 2939

/* Can abort will notify by complete notification with abort status. */
2940
#define CAN_ABORT_STATUS	cpu_to_le32(0x1)
Z
Zhu Yi 已提交
2941 2942 2943 2944 2945 2946
/* complete notification statuses */
#define ABORT_STATUS            0x2

/*
 * REPLY_SCAN_CMD = 0x80 (response)
 */
2947
struct iwl_scanreq_notification {
Z
Zhu Yi 已提交
2948
	__le32 status;		/* 1: okay, 2: cannot fulfill request */
2949
} __packed;
Z
Zhu Yi 已提交
2950 2951 2952 2953

/*
 * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
 */
2954
struct iwl_scanstart_notification {
Z
Zhu Yi 已提交
2955 2956 2957 2958 2959 2960 2961
	__le32 tsf_low;
	__le32 tsf_high;
	__le32 beacon_timer;
	u8 channel;
	u8 band;
	u8 reserved[2];
	__le32 status;
2962
} __packed;
Z
Zhu Yi 已提交
2963 2964 2965 2966

#define  SCAN_OWNER_STATUS 0x1;
#define  MEASURE_OWNER_STATUS 0x2;

2967 2968 2969 2970 2971 2972
#define IWL_PROBE_STATUS_OK		0
#define IWL_PROBE_STATUS_TX_FAILED	BIT(0)
/* error statuses combined with TX_FAILED */
#define IWL_PROBE_STATUS_FAIL_TTL	BIT(1)
#define IWL_PROBE_STATUS_FAIL_BT	BIT(2)

Z
Zhu Yi 已提交
2973 2974 2975 2976
#define NUMBER_OF_STATISTICS 1	/* first __le32 is good CRC */
/*
 * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
 */
2977
struct iwl_scanresults_notification {
Z
Zhu Yi 已提交
2978 2979
	u8 channel;
	u8 band;
2980 2981
	u8 probe_status;
	u8 num_probe_not_sent; /* not enough time to send */
Z
Zhu Yi 已提交
2982 2983 2984
	__le32 tsf_low;
	__le32 tsf_high;
	__le32 statistics[NUMBER_OF_STATISTICS];
2985
} __packed;
Z
Zhu Yi 已提交
2986 2987 2988 2989

/*
 * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
 */
2990
struct iwl_scancomplete_notification {
Z
Zhu Yi 已提交
2991 2992 2993 2994 2995 2996
	u8 scanned_channels;
	u8 status;
	u8 reserved;
	u8 last_channel;
	__le32 tsf_low;
	__le32 tsf_high;
2997
} __packed;
Z
Zhu Yi 已提交
2998 2999 3000 3001 3002 3003 3004 3005


/******************************************************************************
 * (9)
 * IBSS/AP Commands and Notifications:
 *
 *****************************************************************************/

3006 3007 3008 3009 3010
enum iwl_ibss_manager {
	IWL_NOT_IBSS_MANAGER = 0,
	IWL_IBSS_MANAGER = 1,
};

Z
Zhu Yi 已提交
3011 3012 3013
/*
 * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
 */
3014 3015 3016 3017 3018 3019

struct iwl3945_beacon_notif {
	struct iwl3945_tx_resp beacon_notify_hdr;
	__le32 low_tsf;
	__le32 high_tsf;
	__le32 ibss_mgr_status;
3020
} __packed;
3021

C
Christoph Hellwig 已提交
3022 3023
struct iwl4965_beacon_notif {
	struct iwl4965_tx_resp beacon_notify_hdr;
Z
Zhu Yi 已提交
3024 3025 3026
	__le32 low_tsf;
	__le32 high_tsf;
	__le32 ibss_mgr_status;
3027
} __packed;
Z
Zhu Yi 已提交
3028 3029 3030 3031

/*
 * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
 */
3032 3033 3034 3035 3036 3037 3038

struct iwl3945_tx_beacon_cmd {
	struct iwl3945_tx_cmd tx;
	__le16 tim_idx;
	u8 tim_size;
	u8 reserved1;
	struct ieee80211_hdr frame[0];	/* beacon frame */
3039
} __packed;
3040

3041
struct iwl_tx_beacon_cmd {
3042
	struct iwl_tx_cmd tx;
Z
Zhu Yi 已提交
3043 3044 3045 3046
	__le16 tim_idx;
	u8 tim_size;
	u8 reserved1;
	struct ieee80211_hdr frame[0];	/* beacon frame */
3047
} __packed;
Z
Zhu Yi 已提交
3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072

/******************************************************************************
 * (10)
 * Statistics Commands and Notifications:
 *
 *****************************************************************************/

#define IWL_TEMP_CONVERT 260

#define SUP_RATE_11A_MAX_NUM_CHANNELS  8
#define SUP_RATE_11B_MAX_NUM_CHANNELS  4
#define SUP_RATE_11G_MAX_NUM_CHANNELS  12

/* Used for passing to driver number of successes and failures per rate */
struct rate_histogram {
	union {
		__le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
		__le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
		__le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
	} success;
	union {
		__le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
		__le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
		__le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
	} failed;
3073
} __packed;
Z
Zhu Yi 已提交
3074 3075 3076

/* statistics command response */

3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092
struct iwl39_statistics_rx_phy {
	__le32 ina_cnt;
	__le32 fina_cnt;
	__le32 plcp_err;
	__le32 crc32_err;
	__le32 overrun_err;
	__le32 early_overrun_err;
	__le32 crc32_good;
	__le32 false_alarm_cnt;
	__le32 fina_sync_err_cnt;
	__le32 sfd_timeout;
	__le32 fina_timeout;
	__le32 unresponded_rts;
	__le32 rxe_frame_limit_overrun;
	__le32 sent_ack_cnt;
	__le32 sent_cts_cnt;
3093
} __packed;
3094 3095 3096 3097 3098 3099 3100 3101 3102 3103

struct iwl39_statistics_rx_non_phy {
	__le32 bogus_cts;	/* CTS received when not expecting CTS */
	__le32 bogus_ack;	/* ACK received when not expecting ACK */
	__le32 non_bssid_frames;	/* number of frames with BSSID that
					 * doesn't belong to the STA BSSID */
	__le32 filtered_frames;	/* count frames that were dumped in the
				 * filtering process */
	__le32 non_channel_beacons;	/* beacons with our bss id but not on
					 * our serving channel */
3104
} __packed;
3105 3106 3107 3108 3109

struct iwl39_statistics_rx {
	struct iwl39_statistics_rx_phy ofdm;
	struct iwl39_statistics_rx_phy cck;
	struct iwl39_statistics_rx_non_phy general;
3110
} __packed;
3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121

struct iwl39_statistics_tx {
	__le32 preamble_cnt;
	__le32 rx_detected_cnt;
	__le32 bt_prio_defer_cnt;
	__le32 bt_prio_kill_cnt;
	__le32 few_bytes_cnt;
	__le32 cts_timeout;
	__le32 ack_timeout;
	__le32 expected_ack_cnt;
	__le32 actual_ack_cnt;
3122
} __packed;
3123 3124 3125 3126

struct statistics_dbg {
	__le32 burst_check;
	__le32 burst_count;
3127 3128
	__le32 wait_for_silence_timeout_cnt;
	__le32 reserved[3];
3129
} __packed;
3130 3131 3132 3133 3134 3135

struct iwl39_statistics_div {
	__le32 tx_on_a;
	__le32 tx_on_b;
	__le32 exec_time;
	__le32 probe_time;
3136
} __packed;
3137 3138 3139 3140 3141 3142 3143 3144 3145

struct iwl39_statistics_general {
	__le32 temperature;
	struct statistics_dbg dbg;
	__le32 sleep_time;
	__le32 slots_out;
	__le32 slots_idle;
	__le32 ttl_timestamp;
	struct iwl39_statistics_div div;
3146
} __packed;
3147

Z
Zhu Yi 已提交
3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168
struct statistics_rx_phy {
	__le32 ina_cnt;
	__le32 fina_cnt;
	__le32 plcp_err;
	__le32 crc32_err;
	__le32 overrun_err;
	__le32 early_overrun_err;
	__le32 crc32_good;
	__le32 false_alarm_cnt;
	__le32 fina_sync_err_cnt;
	__le32 sfd_timeout;
	__le32 fina_timeout;
	__le32 unresponded_rts;
	__le32 rxe_frame_limit_overrun;
	__le32 sent_ack_cnt;
	__le32 sent_cts_cnt;
	__le32 sent_ba_rsp_cnt;
	__le32 dsp_self_kill;
	__le32 mh_format_err;
	__le32 re_acq_main_rssi_sum;
	__le32 reserved3;
3169
} __packed;
Z
Zhu Yi 已提交
3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180

struct statistics_rx_ht_phy {
	__le32 plcp_err;
	__le32 overrun_err;
	__le32 early_overrun_err;
	__le32 crc32_good;
	__le32 crc32_err;
	__le32 mh_format_err;
	__le32 agg_crc32_good;
	__le32 agg_mpdu_cnt;
	__le32 agg_cnt;
3181
	__le32 unsupport_mcs;
3182
} __packed;
Z
Zhu Yi 已提交
3183

3184
#define INTERFERENCE_DATA_AVAILABLE      cpu_to_le32(1)
W
Winkler, Tomas 已提交
3185

Z
Zhu Yi 已提交
3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207
struct statistics_rx_non_phy {
	__le32 bogus_cts;	/* CTS received when not expecting CTS */
	__le32 bogus_ack;	/* ACK received when not expecting ACK */
	__le32 non_bssid_frames;	/* number of frames with BSSID that
					 * doesn't belong to the STA BSSID */
	__le32 filtered_frames;	/* count frames that were dumped in the
				 * filtering process */
	__le32 non_channel_beacons;	/* beacons with our bss id but not on
					 * our serving channel */
	__le32 channel_beacons;	/* beacons with our bss id and in our
				 * serving channel */
	__le32 num_missed_bcon;	/* number of missed beacons */
	__le32 adc_rx_saturation_time;	/* count in 0.8us units the time the
					 * ADC was in saturation */
	__le32 ina_detection_search_time;/* total time (in 0.8us) searched
					  * for INA */
	__le32 beacon_silence_rssi_a;	/* RSSI silence after beacon frame */
	__le32 beacon_silence_rssi_b;	/* RSSI silence after beacon frame */
	__le32 beacon_silence_rssi_c;	/* RSSI silence after beacon frame */
	__le32 interference_data_flag;	/* flag for interference data
					 * availability. 1 when data is
					 * available. */
B
Ben Cahill 已提交
3208
	__le32 channel_load;		/* counts RX Enable time in uSec */
Z
Zhu Yi 已提交
3209 3210 3211 3212 3213 3214 3215 3216
	__le32 dsp_false_alarms;	/* DSP false alarm (both OFDM
					 * and CCK) counter */
	__le32 beacon_rssi_a;
	__le32 beacon_rssi_b;
	__le32 beacon_rssi_c;
	__le32 beacon_energy_a;
	__le32 beacon_energy_b;
	__le32 beacon_energy_c;
3217
} __packed;
Z
Zhu Yi 已提交
3218

3219 3220 3221 3222 3223
struct statistics_rx_non_phy_bt {
	struct statistics_rx_non_phy common;
	/* additional stats for bt */
	__le32 num_bt_kills;
	__le32 reserved[2];
3224
} __packed;
3225

Z
Zhu Yi 已提交
3226 3227 3228 3229 3230
struct statistics_rx {
	struct statistics_rx_phy ofdm;
	struct statistics_rx_phy cck;
	struct statistics_rx_non_phy general;
	struct statistics_rx_ht_phy ofdm_ht;
3231
} __packed;
Z
Zhu Yi 已提交
3232

3233 3234 3235 3236 3237
struct statistics_rx_bt {
	struct statistics_rx_phy ofdm;
	struct statistics_rx_phy cck;
	struct statistics_rx_non_phy_bt general;
	struct statistics_rx_ht_phy ofdm_ht;
3238
} __packed;
3239

3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251
/**
 * struct statistics_tx_power - current tx power
 *
 * @ant_a: current tx power on chain a in 1/2 dB step
 * @ant_b: current tx power on chain b in 1/2 dB step
 * @ant_c: current tx power on chain c in 1/2 dB step
 */
struct statistics_tx_power {
	u8 ant_a;
	u8 ant_b;
	u8 ant_c;
	u8 reserved;
3252
} __packed;
3253

Z
Zhu Yi 已提交
3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264
struct statistics_tx_non_phy_agg {
	__le32 ba_timeout;
	__le32 ba_reschedule_frames;
	__le32 scd_query_agg_frame_cnt;
	__le32 scd_query_no_agg;
	__le32 scd_query_agg;
	__le32 scd_query_mismatch;
	__le32 frame_not_ready;
	__le32 underrun;
	__le32 bt_prio_kill;
	__le32 rx_ba_rsp_cnt;
3265
} __packed;
Z
Zhu Yi 已提交
3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282

struct statistics_tx {
	__le32 preamble_cnt;
	__le32 rx_detected_cnt;
	__le32 bt_prio_defer_cnt;
	__le32 bt_prio_kill_cnt;
	__le32 few_bytes_cnt;
	__le32 cts_timeout;
	__le32 ack_timeout;
	__le32 expected_ack_cnt;
	__le32 actual_ack_cnt;
	__le32 dump_msdu_cnt;
	__le32 burst_abort_next_frame_mismatch_cnt;
	__le32 burst_abort_missing_next_frame_cnt;
	__le32 cts_timeout_collision;
	__le32 ack_or_ba_timeout_collision;
	struct statistics_tx_non_phy_agg agg;
3283 3284 3285 3286 3287
	/*
	 * "tx_power" are optional parameters provided by uCode,
	 * 6000 series is the only device provide the information,
	 * Those are reserved fields for all the other devices
	 */
3288 3289
	struct statistics_tx_power tx_power;
	__le32 reserved1;
3290
} __packed;
Z
Zhu Yi 已提交
3291 3292 3293 3294 3295 3296 3297 3298 3299


struct statistics_div {
	__le32 tx_on_a;
	__le32 tx_on_b;
	__le32 exec_time;
	__le32 probe_time;
	__le32 reserved1;
	__le32 reserved2;
3300
} __packed;
Z
Zhu Yi 已提交
3301

3302
struct statistics_general_common {
3303 3304
	__le32 temperature;   /* radio temperature */
	__le32 temperature_m; /* for 5000 and up, this is radio voltage */
Z
Zhu Yi 已提交
3305 3306 3307 3308 3309 3310 3311
	struct statistics_dbg dbg;
	__le32 sleep_time;
	__le32 slots_out;
	__le32 slots_idle;
	__le32 ttl_timestamp;
	struct statistics_div div;
	__le32 rx_enable_counter;
3312 3313 3314 3315 3316 3317
	/*
	 * num_of_sos_states:
	 *  count the number of times we have to re-tune
	 *  in order to get out of bad PHY status
	 */
	__le32 num_of_sos_states;
3318
} __packed;
3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330

struct statistics_bt_activity {
	/* Tx statistics */
	__le32 hi_priority_tx_req_cnt;
	__le32 hi_priority_tx_denied_cnt;
	__le32 lo_priority_tx_req_cnt;
	__le32 lo_priority_tx_denied_cnt;
	/* Rx statistics */
	__le32 hi_priority_rx_req_cnt;
	__le32 hi_priority_rx_denied_cnt;
	__le32 lo_priority_rx_req_cnt;
	__le32 lo_priority_rx_denied_cnt;
3331
} __packed;
3332 3333 3334 3335 3336

struct statistics_general {
	struct statistics_general_common common;
	__le32 reserved2;
	__le32 reserved3;
3337
} __packed;
3338 3339 3340 3341

struct statistics_general_bt {
	struct statistics_general_common common;
	struct statistics_bt_activity activity;
Z
Zhu Yi 已提交
3342 3343
	__le32 reserved2;
	__le32 reserved3;
3344
} __packed;
Z
Zhu Yi 已提交
3345

3346 3347 3348 3349
#define UCODE_STATISTICS_CLEAR_MSK		(0x1 << 0)
#define UCODE_STATISTICS_FREQUENCY_MSK		(0x1 << 1)
#define UCODE_STATISTICS_NARROW_BAND_MSK	(0x1 << 2)

Z
Zhu Yi 已提交
3350 3351
/*
 * REPLY_STATISTICS_CMD = 0x9c,
W
Wey-Yi Guy 已提交
3352
 * all devices identical.
Z
Zhu Yi 已提交
3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364
 *
 * This command triggers an immediate response containing uCode statistics.
 * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
 *
 * If the CLEAR_STATS configuration flag is set, uCode will clear its
 * internal copy of the statistics (counters) after issuing the response.
 * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
 *
 * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
 * STATISTICS_NOTIFICATIONs after received beacons (see below).  This flag
 * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
 */
3365 3366
#define IWL_STATS_CONF_CLEAR_STATS cpu_to_le32(0x1)	/* see above */
#define IWL_STATS_CONF_DISABLE_NOTIF cpu_to_le32(0x2)/* see above */
3367
struct iwl_statistics_cmd {
Z
Zhu Yi 已提交
3368
	__le32 configuration_flags;	/* IWL_STATS_CONF_* */
3369
} __packed;
Z
Zhu Yi 已提交
3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385

/*
 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
 *
 * By default, uCode issues this notification after receiving a beacon
 * while associated.  To disable this behavior, set DISABLE_NOTIF flag in the
 * REPLY_STATISTICS_CMD 0x9c, above.
 *
 * Statistics counters continue to increment beacon after beacon, but are
 * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
 * 0x9c with CLEAR_STATS bit set (see above).
 *
 * uCode also issues this notification during scans.  uCode clears statistics
 * appropriately so that each notification contains statistics for only the
 * one channel that has just been scanned.
 */
3386
#define STATISTICS_REPLY_FLG_BAND_24G_MSK         cpu_to_le32(0x2)
3387
#define STATISTICS_REPLY_FLG_HT40_MODE_MSK        cpu_to_le32(0x8)
3388 3389 3390 3391 3392 3393

struct iwl3945_notif_statistics {
	__le32 flag;
	struct iwl39_statistics_rx rx;
	struct iwl39_statistics_tx tx;
	struct iwl39_statistics_general general;
3394
} __packed;
3395

3396
struct iwl_notif_statistics {
Z
Zhu Yi 已提交
3397 3398 3399 3400
	__le32 flag;
	struct statistics_rx rx;
	struct statistics_tx tx;
	struct statistics_general general;
3401
} __packed;
Z
Zhu Yi 已提交
3402

3403 3404 3405 3406 3407
struct iwl_bt_notif_statistics {
	__le32 flag;
	struct statistics_rx_bt rx;
	struct statistics_tx tx;
	struct statistics_general_bt general;
3408
} __packed;
Z
Zhu Yi 已提交
3409 3410 3411

/*
 * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427
 *
 * uCode send MISSED_BEACONS_NOTIFICATION to driver when detect beacon missed
 * in regardless of how many missed beacons, which mean when driver receive the
 * notification, inside the command, it can find all the beacons information
 * which include number of total missed beacons, number of consecutive missed
 * beacons, number of beacons received and number of beacons expected to
 * receive.
 *
 * If uCode detected consecutive_missed_beacons > 5, it will reset the radio
 * in order to bring the radio/PHY back to working state; which has no relation
 * to when driver will perform sensitivity calibration.
 *
 * Driver should set it own missed_beacon_threshold to decide when to perform
 * sensitivity calibration based on number of consecutive missed beacons in
 * order to improve overall performance, especially in noisy environment.
 *
Z
Zhu Yi 已提交
3428
 */
3429 3430 3431 3432

#define IWL_MISSED_BEACON_THRESHOLD_MIN	(1)
#define IWL_MISSED_BEACON_THRESHOLD_DEF	(5)
#define IWL_MISSED_BEACON_THRESHOLD_MAX	IWL_MISSED_BEACON_THRESHOLD_DEF
Z
Zhu Yi 已提交
3433

3434
struct iwl_missed_beacon_notif {
3435
	__le32 consecutive_missed_beacons;
Z
Zhu Yi 已提交
3436 3437 3438
	__le32 total_missed_becons;
	__le32 num_expected_beacons;
	__le32 num_recvd_beacons;
3439
} __packed;
Z
Zhu Yi 已提交
3440

B
Ben Cahill 已提交
3441

Z
Zhu Yi 已提交
3442 3443 3444 3445
/******************************************************************************
 * (11)
 * Rx Calibration Commands:
 *
B
Ben Cahill 已提交
3446 3447 3448 3449 3450 3451 3452 3453
 * With the uCode used for open source drivers, most Tx calibration (except
 * for Tx Power) and most Rx calibration is done by uCode during the
 * "initialize" phase of uCode boot.  Driver must calibrate only:
 *
 * 1)  Tx power (depends on temperature), described elsewhere
 * 2)  Receiver gain balance (optimize MIMO, and detect disconnected antennas)
 * 3)  Receiver sensitivity (to optimize signal detection)
 *
Z
Zhu Yi 已提交
3454 3455
 *****************************************************************************/

B
Ben Cahill 已提交
3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611
/**
 * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
 *
 * This command sets up the Rx signal detector for a sensitivity level that
 * is high enough to lock onto all signals within the associated network,
 * but low enough to ignore signals that are below a certain threshold, so as
 * not to have too many "false alarms".  False alarms are signals that the
 * Rx DSP tries to lock onto, but then discards after determining that they
 * are noise.
 *
 * The optimum number of false alarms is between 5 and 50 per 200 TUs
 * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
 * time listening, not transmitting).  Driver must adjust sensitivity so that
 * the ratio of actual false alarms to actual Rx time falls within this range.
 *
 * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
 * received beacon.  These provide information to the driver to analyze the
 * sensitivity.  Don't analyze statistics that come in from scanning, or any
 * other non-associated-network source.  Pertinent statistics include:
 *
 * From "general" statistics (struct statistics_rx_non_phy):
 *
 * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
 *   Measure of energy of desired signal.  Used for establishing a level
 *   below which the device does not detect signals.
 *
 * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
 *   Measure of background noise in silent period after beacon.
 *
 * channel_load
 *   uSecs of actual Rx time during beacon period (varies according to
 *   how much time was spent transmitting).
 *
 * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
 *
 * false_alarm_cnt
 *   Signal locks abandoned early (before phy-level header).
 *
 * plcp_err
 *   Signal locks abandoned late (during phy-level header).
 *
 * NOTE:  Both false_alarm_cnt and plcp_err increment monotonically from
 *        beacon to beacon, i.e. each value is an accumulation of all errors
 *        before and including the latest beacon.  Values will wrap around to 0
 *        after counting up to 2^32 - 1.  Driver must differentiate vs.
 *        previous beacon's values to determine # false alarms in the current
 *        beacon period.
 *
 * Total number of false alarms = false_alarms + plcp_errs
 *
 * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
 * (notice that the start points for OFDM are at or close to settings for
 * maximum sensitivity):
 *
 *                                             START  /  MIN  /  MAX
 *   HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX          90   /   85  /  120
 *   HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX     170   /  170  /  210
 *   HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX         105   /  105  /  140
 *   HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX     220   /  220  /  270
 *
 *   If actual rate of OFDM false alarms (+ plcp_errors) is too high
 *   (greater than 50 for each 204.8 msecs listening), reduce sensitivity
 *   by *adding* 1 to all 4 of the table entries above, up to the max for
 *   each entry.  Conversely, if false alarm rate is too low (less than 5
 *   for each 204.8 msecs listening), *subtract* 1 from each entry to
 *   increase sensitivity.
 *
 * For CCK sensitivity, keep track of the following:
 *
 *   1).  20-beacon history of maximum background noise, indicated by
 *        (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
 *        3 receivers.  For any given beacon, the "silence reference" is
 *        the maximum of last 60 samples (20 beacons * 3 receivers).
 *
 *   2).  10-beacon history of strongest signal level, as indicated
 *        by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
 *        i.e. the strength of the signal through the best receiver at the
 *        moment.  These measurements are "upside down", with lower values
 *        for stronger signals, so max energy will be *minimum* value.
 *
 *        Then for any given beacon, the driver must determine the *weakest*
 *        of the strongest signals; this is the minimum level that needs to be
 *        successfully detected, when using the best receiver at the moment.
 *        "Max cck energy" is the maximum (higher value means lower energy!)
 *        of the last 10 minima.  Once this is determined, driver must add
 *        a little margin by adding "6" to it.
 *
 *   3).  Number of consecutive beacon periods with too few false alarms.
 *        Reset this to 0 at the first beacon period that falls within the
 *        "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
 *
 * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
 * (notice that the start points for CCK are at maximum sensitivity):
 *
 *                                             START  /  MIN  /  MAX
 *   HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX         125   /  125  /  200
 *   HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX     200   /  200  /  400
 *   HD_MIN_ENERGY_CCK_DET_INDEX                100   /    0  /  100
 *
 *   If actual rate of CCK false alarms (+ plcp_errors) is too high
 *   (greater than 50 for each 204.8 msecs listening), method for reducing
 *   sensitivity is:
 *
 *   1)  *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
 *       up to max 400.
 *
 *   2)  If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
 *       sensitivity has been reduced a significant amount; bring it up to
 *       a moderate 161.  Otherwise, *add* 3, up to max 200.
 *
 *   3)  a)  If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
 *       sensitivity has been reduced only a moderate or small amount;
 *       *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
 *       down to min 0.  Otherwise (if gain has been significantly reduced),
 *       don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
 *
 *       b)  Save a snapshot of the "silence reference".
 *
 *   If actual rate of CCK false alarms (+ plcp_errors) is too low
 *   (less than 5 for each 204.8 msecs listening), method for increasing
 *   sensitivity is used only if:
 *
 *   1a)  Previous beacon did not have too many false alarms
 *   1b)  AND difference between previous "silence reference" and current
 *        "silence reference" (prev - current) is 2 or more,
 *   OR 2)  100 or more consecutive beacon periods have had rate of
 *          less than 5 false alarms per 204.8 milliseconds rx time.
 *
 *   Method for increasing sensitivity:
 *
 *   1)  *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
 *       down to min 125.
 *
 *   2)  *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
 *       down to min 200.
 *
 *   3)  *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
 *
 *   If actual rate of CCK false alarms (+ plcp_errors) is within good range
 *   (between 5 and 50 for each 204.8 msecs listening):
 *
 *   1)  Save a snapshot of the silence reference.
 *
 *   2)  If previous beacon had too many CCK false alarms (+ plcp_errors),
 *       give some extra margin to energy threshold by *subtracting* 8
 *       from value in HD_MIN_ENERGY_CCK_DET_INDEX.
 *
 *   For all cases (too few, too many, good range), make sure that the CCK
 *   detection threshold (energy) is below the energy level for robust
 *   detection over the past 10 beacon periods, the "Max cck energy".
 *   Lower values mean higher energy; this means making sure that the value
 *   in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
 *
 */

/*
3612
 * Table entries in SENSITIVITY_CMD (struct iwl_sensitivity_cmd)
B
Ben Cahill 已提交
3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626
 */
#define HD_TABLE_SIZE  (11)	/* number of entries */
#define HD_MIN_ENERGY_CCK_DET_INDEX                 (0)	/* table indexes */
#define HD_MIN_ENERGY_OFDM_DET_INDEX                (1)
#define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX          (2)
#define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX      (3)
#define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX      (4)
#define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX          (5)
#define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX      (6)
#define HD_BARKER_CORR_TH_ADD_MIN_INDEX             (7)
#define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX         (8)
#define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX          (9)
#define HD_OFDM_ENERGY_TH_IN_INDEX                  (10)

3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661
/*
 * Additional table entries in enhance SENSITIVITY_CMD
 */
#define HD_INA_NON_SQUARE_DET_OFDM_INDEX		(11)
#define HD_INA_NON_SQUARE_DET_CCK_INDEX			(12)
#define HD_CORR_11_INSTEAD_OF_CORR_9_EN_INDEX		(13)
#define HD_OFDM_NON_SQUARE_DET_SLOPE_MRC_INDEX		(14)
#define HD_OFDM_NON_SQUARE_DET_INTERCEPT_MRC_INDEX	(15)
#define HD_OFDM_NON_SQUARE_DET_SLOPE_INDEX		(16)
#define HD_OFDM_NON_SQUARE_DET_INTERCEPT_INDEX		(17)
#define HD_CCK_NON_SQUARE_DET_SLOPE_MRC_INDEX		(18)
#define HD_CCK_NON_SQUARE_DET_INTERCEPT_MRC_INDEX	(19)
#define HD_CCK_NON_SQUARE_DET_SLOPE_INDEX		(20)
#define HD_CCK_NON_SQUARE_DET_INTERCEPT_INDEX		(21)
#define HD_RESERVED					(22)

/* number of entries for enhanced tbl */
#define ENHANCE_HD_TABLE_SIZE  (23)

/* number of additional entries for enhanced tbl */
#define ENHANCE_HD_TABLE_ENTRIES  (ENHANCE_HD_TABLE_SIZE - HD_TABLE_SIZE)

#define HD_INA_NON_SQUARE_DET_OFDM_DATA			cpu_to_le16(0)
#define HD_INA_NON_SQUARE_DET_CCK_DATA			cpu_to_le16(0)
#define HD_CORR_11_INSTEAD_OF_CORR_9_EN_DATA		cpu_to_le16(0)
#define HD_OFDM_NON_SQUARE_DET_SLOPE_MRC_DATA		cpu_to_le16(668)
#define HD_OFDM_NON_SQUARE_DET_INTERCEPT_MRC_DATA	cpu_to_le16(4)
#define HD_OFDM_NON_SQUARE_DET_SLOPE_DATA		cpu_to_le16(486)
#define HD_OFDM_NON_SQUARE_DET_INTERCEPT_DATA		cpu_to_le16(37)
#define HD_CCK_NON_SQUARE_DET_SLOPE_MRC_DATA		cpu_to_le16(853)
#define HD_CCK_NON_SQUARE_DET_INTERCEPT_MRC_DATA	cpu_to_le16(4)
#define HD_CCK_NON_SQUARE_DET_SLOPE_DATA		cpu_to_le16(476)
#define HD_CCK_NON_SQUARE_DET_INTERCEPT_DATA		cpu_to_le16(99)


3662
/* Control field in struct iwl_sensitivity_cmd */
3663 3664
#define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE	cpu_to_le16(0)
#define SENSITIVITY_CMD_CONTROL_WORK_TABLE	cpu_to_le16(1)
Z
Zhu Yi 已提交
3665

B
Ben Cahill 已提交
3666
/**
3667
 * struct iwl_sensitivity_cmd
B
Ben Cahill 已提交
3668 3669 3670 3671 3672
 * @control:  (1) updates working table, (0) updates default table
 * @table:  energy threshold values, use HD_* as index into table
 *
 * Always use "1" in "control" to update uCode's working table and DSP.
 */
3673
struct iwl_sensitivity_cmd {
B
Ben Cahill 已提交
3674 3675
	__le16 control;			/* always use "1" */
	__le16 table[HD_TABLE_SIZE];	/* use HD_* as index */
3676
} __packed;
Z
Zhu Yi 已提交
3677

3678 3679 3680 3681 3682 3683
/*
 *
 */
struct iwl_enhance_sensitivity_cmd {
	__le16 control;			/* always use "1" */
	__le16 enhance_table[ENHANCE_HD_TABLE_SIZE];	/* use HD_* as index */
3684
} __packed;
3685

B
Ben Cahill 已提交
3686 3687 3688 3689

/**
 * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
 *
W
Wey-Yi Guy 已提交
3690
 * This command sets the relative gains of agn device's 3 radio receiver chains.
B
Ben Cahill 已提交
3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741
 *
 * After the first association, driver should accumulate signal and noise
 * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
 * beacons from the associated network (don't collect statistics that come
 * in from scanning, or any other non-network source).
 *
 * DISCONNECTED ANTENNA:
 *
 * Driver should determine which antennas are actually connected, by comparing
 * average beacon signal levels for the 3 Rx chains.  Accumulate (add) the
 * following values over 20 beacons, one accumulator for each of the chains
 * a/b/c, from struct statistics_rx_non_phy:
 *
 * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
 *
 * Find the strongest signal from among a/b/c.  Compare the other two to the
 * strongest.  If any signal is more than 15 dB (times 20, unless you
 * divide the accumulated values by 20) below the strongest, the driver
 * considers that antenna to be disconnected, and should not try to use that
 * antenna/chain for Rx or Tx.  If both A and B seem to be disconnected,
 * driver should declare the stronger one as connected, and attempt to use it
 * (A and B are the only 2 Tx chains!).
 *
 *
 * RX BALANCE:
 *
 * Driver should balance the 3 receivers (but just the ones that are connected
 * to antennas, see above) for gain, by comparing the average signal levels
 * detected during the silence after each beacon (background noise).
 * Accumulate (add) the following values over 20 beacons, one accumulator for
 * each of the chains a/b/c, from struct statistics_rx_non_phy:
 *
 * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
 *
 * Find the weakest background noise level from among a/b/c.  This Rx chain
 * will be the reference, with 0 gain adjustment.  Attenuate other channels by
 * finding noise difference:
 *
 * (accum_noise[i] - accum_noise[reference]) / 30
 *
 * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
 * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
 * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
 * and set bit 2 to indicate "reduce gain".  The value for the reference
 * (weakest) chain should be "0".
 *
 * diff_gain_[abc] bit fields:
 *   2: (1) reduce gain, (0) increase gain
 * 1-0: amount of gain, units of 1.5 dB
 */

3742
/* Phy calibration command for series */
3743 3744

enum {
3745 3746 3747 3748 3749 3750 3751
	IWL_PHY_CALIBRATE_DIFF_GAIN_CMD		= 7,
	IWL_PHY_CALIBRATE_DC_CMD		= 8,
	IWL_PHY_CALIBRATE_LO_CMD		= 9,
	IWL_PHY_CALIBRATE_TX_IQ_CMD		= 11,
	IWL_PHY_CALIBRATE_CRYSTAL_FRQ_CMD	= 15,
	IWL_PHY_CALIBRATE_BASE_BAND_CMD		= 16,
	IWL_PHY_CALIBRATE_TX_IQ_PERD_CMD	= 17,
3752
	IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE	= 18,
3753 3754
};

3755
#define IWL_MAX_PHY_CALIBRATE_TBL_SIZE		(253)
3756

3757
#define IWL_CALIB_INIT_CFG_ALL	cpu_to_le32(0xffffffff)
3758 3759 3760 3761 3762 3763 3764

struct iwl_calib_cfg_elmnt_s {
	__le32 is_enable;
	__le32 start;
	__le32 send_res;
	__le32 apply_res;
	__le32 reserved;
3765
} __packed;
3766 3767 3768 3769 3770

struct iwl_calib_cfg_status_s {
	struct iwl_calib_cfg_elmnt_s once;
	struct iwl_calib_cfg_elmnt_s perd;
	__le32 flags;
3771
} __packed;
3772

3773
struct iwl_calib_cfg_cmd {
3774 3775 3776
	struct iwl_calib_cfg_status_s ucd_calib_cfg;
	struct iwl_calib_cfg_status_s drv_calib_cfg;
	__le32 reserved1;
3777
} __packed;
3778

3779
struct iwl_calib_hdr {
3780 3781 3782 3783
	u8 op_code;
	u8 first_group;
	u8 groups_num;
	u8 data_valid;
3784
} __packed;
3785

3786 3787
struct iwl_calib_cmd {
	struct iwl_calib_hdr hdr;
3788
	u8 data[0];
3789
} __packed;
3790

3791
/* IWL_PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
3792
struct iwl_calib_diff_gain_cmd {
3793
	struct iwl_calib_hdr hdr;
3794 3795 3796 3797
	s8 diff_gain_a;		/* see above */
	s8 diff_gain_b;
	s8 diff_gain_c;
	u8 reserved1;
3798
} __packed;
3799

3800 3801 3802 3803 3804
struct iwl_calib_xtal_freq_cmd {
	struct iwl_calib_hdr hdr;
	u8 cap_pin1;
	u8 cap_pin2;
	u8 pad[2];
3805
} __packed;
3806

3807 3808 3809 3810 3811 3812 3813
/* IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD */
struct iwl_calib_chain_noise_reset_cmd {
	struct iwl_calib_hdr hdr;
	u8 data[0];
};

/* IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD */
3814
struct iwl_calib_chain_noise_gain_cmd {
3815
	struct iwl_calib_hdr hdr;
3816 3817
	u8 delta_gain_1;
	u8 delta_gain_2;
3818
	u8 pad[2];
3819
} __packed;
3820

Z
Zhu Yi 已提交
3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833
/******************************************************************************
 * (12)
 * Miscellaneous Commands:
 *
 *****************************************************************************/

/*
 * LEDs Command & Response
 * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
 *
 * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
 * this command turns it on or off, or sets up a periodic blinking cycle.
 */
3834
struct iwl_led_cmd {
Z
Zhu Yi 已提交
3835 3836 3837 3838 3839 3840 3841
	__le32 interval;	/* "interval" in uSec */
	u8 id;			/* 1: Activity, 2: Link, 3: Tech */
	u8 off;			/* # intervals off while blinking;
				 * "0", with >0 "on" value, turns LED on */
	u8 on;			/* # intervals on while blinking;
				 * "0", regardless of "off", turns LED off */
	u8 reserved;
3842
} __packed;
Z
Zhu Yi 已提交
3843

3844
/*
W
Wey-Yi Guy 已提交
3845 3846 3847
 * station priority table entries
 * also used as potential "events" value for both
 * COEX_MEDIUM_NOTIFICATION and COEX_EVENT_CMD
3848
 */
3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940

/*
 * COEX events entry flag masks
 * RP - Requested Priority
 * WP - Win Medium Priority: priority assigned when the contention has been won
 */
#define COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG        (0x1)
#define COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG        (0x2)
#define COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG  (0x4)

#define COEX_CU_UNASSOC_IDLE_RP               4
#define COEX_CU_UNASSOC_MANUAL_SCAN_RP        4
#define COEX_CU_UNASSOC_AUTO_SCAN_RP          4
#define COEX_CU_CALIBRATION_RP                4
#define COEX_CU_PERIODIC_CALIBRATION_RP       4
#define COEX_CU_CONNECTION_ESTAB_RP           4
#define COEX_CU_ASSOCIATED_IDLE_RP            4
#define COEX_CU_ASSOC_MANUAL_SCAN_RP          4
#define COEX_CU_ASSOC_AUTO_SCAN_RP            4
#define COEX_CU_ASSOC_ACTIVE_LEVEL_RP         4
#define COEX_CU_RF_ON_RP                      6
#define COEX_CU_RF_OFF_RP                     4
#define COEX_CU_STAND_ALONE_DEBUG_RP          6
#define COEX_CU_IPAN_ASSOC_LEVEL_RP           4
#define COEX_CU_RSRVD1_RP                     4
#define COEX_CU_RSRVD2_RP                     4

#define COEX_CU_UNASSOC_IDLE_WP               3
#define COEX_CU_UNASSOC_MANUAL_SCAN_WP        3
#define COEX_CU_UNASSOC_AUTO_SCAN_WP          3
#define COEX_CU_CALIBRATION_WP                3
#define COEX_CU_PERIODIC_CALIBRATION_WP       3
#define COEX_CU_CONNECTION_ESTAB_WP           3
#define COEX_CU_ASSOCIATED_IDLE_WP            3
#define COEX_CU_ASSOC_MANUAL_SCAN_WP          3
#define COEX_CU_ASSOC_AUTO_SCAN_WP            3
#define COEX_CU_ASSOC_ACTIVE_LEVEL_WP         3
#define COEX_CU_RF_ON_WP                      3
#define COEX_CU_RF_OFF_WP                     3
#define COEX_CU_STAND_ALONE_DEBUG_WP          6
#define COEX_CU_IPAN_ASSOC_LEVEL_WP           3
#define COEX_CU_RSRVD1_WP                     3
#define COEX_CU_RSRVD2_WP                     3

#define COEX_UNASSOC_IDLE_FLAGS                     0
#define COEX_UNASSOC_MANUAL_SCAN_FLAGS		\
	(COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |	\
	COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
#define COEX_UNASSOC_AUTO_SCAN_FLAGS		\
	(COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |	\
	COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
#define COEX_CALIBRATION_FLAGS			\
	(COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |	\
	COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
#define COEX_PERIODIC_CALIBRATION_FLAGS             0
/*
 * COEX_CONNECTION_ESTAB:
 * we need DELAY_MEDIUM_FREE_NTFY to let WiMAX disconnect from network.
 */
#define COEX_CONNECTION_ESTAB_FLAGS		\
	(COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |	\
	COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG |	\
	COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
#define COEX_ASSOCIATED_IDLE_FLAGS                  0
#define COEX_ASSOC_MANUAL_SCAN_FLAGS		\
	(COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |	\
	COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
#define COEX_ASSOC_AUTO_SCAN_FLAGS		\
	(COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |	\
	 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
#define COEX_ASSOC_ACTIVE_LEVEL_FLAGS               0
#define COEX_RF_ON_FLAGS                            0
#define COEX_RF_OFF_FLAGS                           0
#define COEX_STAND_ALONE_DEBUG_FLAGS		\
	(COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |	\
	 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
#define COEX_IPAN_ASSOC_LEVEL_FLAGS		\
	(COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |	\
	 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG |	\
	 COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
#define COEX_RSRVD1_FLAGS                           0
#define COEX_RSRVD2_FLAGS                           0
/*
 * COEX_CU_RF_ON is the event wrapping all radio ownership.
 * We need DELAY_MEDIUM_FREE_NTFY to let WiMAX disconnect from network.
 */
#define COEX_CU_RF_ON_FLAGS			\
	(COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |	\
	 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG |	\
	 COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)


3941
enum {
W
Wey-Yi Guy 已提交
3942
	/* un-association part */
3943 3944 3945
	COEX_UNASSOC_IDLE		= 0,
	COEX_UNASSOC_MANUAL_SCAN	= 1,
	COEX_UNASSOC_AUTO_SCAN		= 2,
W
Wey-Yi Guy 已提交
3946
	/* calibration */
3947 3948
	COEX_CALIBRATION		= 3,
	COEX_PERIODIC_CALIBRATION	= 4,
W
Wey-Yi Guy 已提交
3949
	/* connection */
3950
	COEX_CONNECTION_ESTAB		= 5,
W
Wey-Yi Guy 已提交
3951
	/* association part */
3952 3953 3954 3955
	COEX_ASSOCIATED_IDLE		= 6,
	COEX_ASSOC_MANUAL_SCAN		= 7,
	COEX_ASSOC_AUTO_SCAN		= 8,
	COEX_ASSOC_ACTIVE_LEVEL		= 9,
W
Wey-Yi Guy 已提交
3956
	/* RF ON/OFF */
3957 3958 3959
	COEX_RF_ON			= 10,
	COEX_RF_OFF			= 11,
	COEX_STAND_ALONE_DEBUG		= 12,
W
Wey-Yi Guy 已提交
3960
	/* IPAN */
3961
	COEX_IPAN_ASSOC_LEVEL		= 13,
W
Wey-Yi Guy 已提交
3962
	/* reserved */
3963 3964 3965 3966 3967
	COEX_RSRVD1			= 14,
	COEX_RSRVD2			= 15,
	COEX_NUM_OF_EVENTS		= 16
};

W
Wey-Yi Guy 已提交
3968 3969 3970 3971 3972
/*
 * Coexistence WIFI/WIMAX  Command
 * COEX_PRIORITY_TABLE_CMD = 0x5a
 *
 */
3973 3974 3975 3976 3977
struct iwl_wimax_coex_event_entry {
	u8 request_prio;
	u8 win_medium_prio;
	u8 reserved;
	u8 flags;
3978
} __packed;
3979 3980 3981

/* COEX flag masks */

T
Tomas Winkler 已提交
3982
/* Station table is valid */
3983
#define COEX_FLAGS_STA_TABLE_VALID_MSK      (0x1)
T
Tomas Winkler 已提交
3984
/* UnMask wake up src at unassociated sleep */
3985
#define COEX_FLAGS_UNASSOC_WA_UNMASK_MSK    (0x4)
T
Tomas Winkler 已提交
3986
/* UnMask wake up src at associated sleep */
3987 3988 3989 3990 3991 3992 3993 3994
#define COEX_FLAGS_ASSOC_WA_UNMASK_MSK      (0x8)
/* Enable CoEx feature. */
#define COEX_FLAGS_COEX_ENABLE_MSK          (0x80)

struct iwl_wimax_coex_cmd {
	u8 flags;
	u8 reserved[3];
	struct iwl_wimax_coex_event_entry sta_prio[COEX_NUM_OF_EVENTS];
3995
} __packed;
3996

W
Wey-Yi Guy 已提交
3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023
/*
 * Coexistence MEDIUM NOTIFICATION
 * COEX_MEDIUM_NOTIFICATION = 0x5b
 *
 * notification from uCode to host to indicate medium changes
 *
 */
/*
 * status field
 * bit 0 - 2: medium status
 * bit 3: medium change indication
 * bit 4 - 31: reserved
 */
/* status option values, (0 - 2 bits) */
#define COEX_MEDIUM_BUSY	(0x0) /* radio belongs to WiMAX */
#define COEX_MEDIUM_ACTIVE	(0x1) /* radio belongs to WiFi */
#define COEX_MEDIUM_PRE_RELEASE	(0x2) /* received radio release */
#define COEX_MEDIUM_MSK		(0x7)

/* send notification status (1 bit) */
#define COEX_MEDIUM_CHANGED	(0x8)
#define COEX_MEDIUM_CHANGED_MSK	(0x8)
#define COEX_MEDIUM_SHIFT	(3)

struct iwl_coex_medium_notification {
	__le32 status;
	__le32 events;
4024
} __packed;
W
Wey-Yi Guy 已提交
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038

/*
 * Coexistence EVENT  Command
 * COEX_EVENT_CMD = 0x5c
 *
 * send from host to uCode for coex event request.
 */
/* flags options */
#define COEX_EVENT_REQUEST_MSK	(0x1)

struct iwl_coex_event_cmd {
	u8 flags;
	u8 event;
	__le16 reserved;
4039
} __packed;
W
Wey-Yi Guy 已提交
4040 4041 4042

struct iwl_coex_event_resp {
	__le32 status;
4043
} __packed;
W
Wey-Yi Guy 已提交
4044 4045


4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105
/******************************************************************************
 * Bluetooth Coexistence commands
 *
 *****************************************************************************/

/*
 * BT Status notification
 * REPLY_BT_COEX_PROFILE_NOTIF = 0xcb
 */
enum iwl_bt_coex_profile_traffic_load {
	IWL_BT_COEX_TRAFFIC_LOAD_NONE = 	0,
	IWL_BT_COEX_TRAFFIC_LOAD_LOW =		1,
	IWL_BT_COEX_TRAFFIC_LOAD_HIGH = 	2,
	IWL_BT_COEX_TRAFFIC_LOAD_CONTINUOUS =	3,
/*
 * There are no more even though below is a u8, the
 * indication from the BT device only has two bits.
 */
};

struct iwl_bt_coex_profile_notif {
	u8 uart_msg[8];
	u8 bt_status; /* 0 - off, 1 - on */
	u8 bt_traffic_load; /* 0 .. 3? */
	u8 bt_ci_compliance; /* 0 - not complied, 1 - complied */
	u8 reserved;
} __attribute__((packed));

#define IWL_BT_COEX_PRIO_SHARED_ANTENNA		0x1
#define IWL_BT_COEX_PRIO_PRIO_MASK		0xe
#define IWL_BT_COEX_PRIO_PRIO_SHIFT		1

/*
 * BT Coexistence Priority table
 * REPLY_BT_COEX_PRIO_TABLE = 0xcc
 */
struct iwl_bt_coex_prio_table_cmd {
	u8 init_calib_protection_cfg1,
	   init_calib_protection_cfg2,
	   init_calib_protection_lowprio_cfg1,
	   init_calib_protection_lowprio_cfg2,
	   init_calib_protection_highprio_cfg1,
	   init_calib_protection_highprio_cfg2,
	   dtim_protection_prio_cfg,
	   scan_52_protection_cfg,
	   scan_24_protection_cfg,
	   bc_mc_protection_cfg;
	u8 reserved[6];
} __attribute__((packed));

/*
 * BT Protection Envelope
 * REPLY_BT_COEX_PROT_ENV = 0xcd
 */
struct iwl_bt_coex_prot_env_cmd {
	u8 open; /* 0 = closed, 1 = open */
	u8 type; /* 0 .. 15 */
	u8 reserved[2];
} __attribute__((packed));

Z
Zhu Yi 已提交
4106 4107 4108 4109 4110 4111
/******************************************************************************
 * (13)
 * Union of all expected notifications/responses:
 *
 *****************************************************************************/

4112
struct iwl_rx_packet {
Z
Zhu Yi 已提交
4113 4114 4115 4116 4117 4118 4119 4120 4121 4122
	/*
	 * The first 4 bytes of the RX frame header contain both the RX frame
	 * size and some flags.
	 * Bit fields:
	 * 31:    flag flush RB request
	 * 30:    flag ignore TC (terminal counter) request
	 * 29:    flag fast IRQ request
	 * 28-14: Reserved
	 * 13-00: RX frame size
	 */
4123
	__le32 len_n_flags;
4124
	struct iwl_cmd_header hdr;
Z
Zhu Yi 已提交
4125
	union {
4126 4127 4128 4129
		struct iwl3945_rx_frame rx_frame;
		struct iwl3945_tx_resp tx_resp;
		struct iwl3945_beacon_notif beacon_status;

4130
		struct iwl_alive_resp alive_frame;
4131 4132
		struct iwl_spectrum_notification spectrum_notif;
		struct iwl_csa_notification csa_notif;
4133
		struct iwl_error_resp err_resp;
4134
		struct iwl_card_state_notif card_state_notif;
4135 4136
		struct iwl_add_sta_resp add_sta;
		struct iwl_rem_sta_resp rem_sta;
4137 4138
		struct iwl_sleep_notification sleep_notif;
		struct iwl_spectrum_resp spectrum;
4139
		struct iwl_notif_statistics stats;
4140
		struct iwl_bt_notif_statistics stats_bt;
4141
		struct iwl_compressed_ba_resp compressed_ba;
4142
		struct iwl_missed_beacon_notif missed_beacon;
W
Wey-Yi Guy 已提交
4143 4144
		struct iwl_coex_medium_notification coex_medium_notif;
		struct iwl_coex_event_resp coex_event;
4145
		struct iwl_bt_coex_profile_notif bt_coex_profile_notif;
Z
Zhu Yi 已提交
4146 4147 4148
		__le32 status;
		u8 raw[0];
	} u;
4149
} __packed;
Z
Zhu Yi 已提交
4150

4151
int iwl_agn_check_rxon_cmd(struct iwl_priv *priv);
4152

4153
#endif				/* __iwl_commands_h__ */