blob: 1a7c0d02c19cca2e76e6fa069cc6cc2fb70676cd [file] [log] [blame]
Zhu Yib481de92007-09-25 17:54:57 -07001/******************************************************************************
2 *
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
5 *
6 * GPL LICENSE SUMMARY
7 *
Reinette Chatre01f81622009-01-08 10:20:02 -08008 * Copyright(c) 2005 - 2009 Intel Corporation. All rights reserved.
Zhu Yib481de92007-09-25 17:54:57 -07009 *
10 * This program is free software; you can redistribute it and/or modify
Ian Schram01ebd062007-10-25 17:15:22 +080011 * it under the terms of version 2 of the GNU General Public License as
Zhu Yib481de92007-09-25 17:54:57 -070012 * published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
22 * USA
23 *
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
26 *
27 * Contact Information:
Winkler, Tomas759ef892008-12-09 11:28:58 -080028 * Intel Linux Wireless <ilw@linux.intel.com>
Zhu Yib481de92007-09-25 17:54:57 -070029 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30 *
31 * BSD LICENSE
32 *
Reinette Chatre01f81622009-01-08 10:20:02 -080033 * Copyright(c) 2005 - 2009 Intel Corporation. All rights reserved.
Zhu Yib481de92007-09-25 17:54:57 -070034 * All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 *
40 * * Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * * Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in
44 * the documentation and/or other materials provided with the
45 * distribution.
46 * * Neither the name Intel Corporation nor the names of its
47 * contributors may be used to endorse or promote products derived
48 * from this software without specific prior written permission.
49 *
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61 *
62 *****************************************************************************/
Ben Cahillfcd427b2007-11-29 11:10:00 +080063/*
Tomas Winkler5a36ba02008-04-24 11:55:37 -070064 * Please use this file (iwl-commands.h) only for uCode API definitions.
Ben Cahillfcd427b2007-11-29 11:10:00 +080065 * Please use iwl-4965-hw.h for hardware-related definitions.
Tomas Winkler3e0d4cb2008-04-24 11:55:38 -070066 * Please use iwl-dev.h for driver implementation definitions.
Ben Cahillfcd427b2007-11-29 11:10:00 +080067 */
Zhu Yib481de92007-09-25 17:54:57 -070068
Emmanuel Grumbach6a635782008-10-29 14:05:47 -070069#ifndef __iwl_commands_h__
70#define __iwl_commands_h__
Zhu Yib481de92007-09-25 17:54:57 -070071
Samuel Ortiza3139c52008-12-19 10:37:09 +080072struct iwl_priv;
73
Chatre, Reinettec02b3ac2008-12-02 12:14:05 -080074/* uCode version contains 4 values: Major/Minor/API/Serial */
75#define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
76#define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
77#define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
78#define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
79
Tomas Winkler4c897252008-12-19 10:37:05 +080080
81/* Tx rates */
82#define IWL_CCK_RATES 4
83#define IWL_OFDM_RATES 8
84#define IWL_MAX_RATES (IWL_CCK_RATES + IWL_OFDM_RATES)
85
Zhu Yib481de92007-09-25 17:54:57 -070086enum {
87 REPLY_ALIVE = 0x1,
88 REPLY_ERROR = 0x2,
89
90 /* RXON and QOS commands */
91 REPLY_RXON = 0x10,
92 REPLY_RXON_ASSOC = 0x11,
93 REPLY_QOS_PARAM = 0x13,
94 REPLY_RXON_TIMING = 0x14,
95
96 /* Multi-Station support */
97 REPLY_ADD_STA = 0x18,
98 REPLY_REMOVE_STA = 0x19, /* not used */
99 REPLY_REMOVE_ALL_STA = 0x1a, /* not used */
100
Emmanuel Grumbach0a0bed12008-04-14 21:16:05 -0700101 /* Security */
102 REPLY_WEPKEY = 0x20,
103
Zhu Yib481de92007-09-25 17:54:57 -0700104 /* RX, TX, LEDs */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -0800105 REPLY_3945_RX = 0x1b, /* 3945 only */
Zhu Yib481de92007-09-25 17:54:57 -0700106 REPLY_TX = 0x1c,
107 REPLY_RATE_SCALE = 0x47, /* 3945 only */
108 REPLY_LEDS_CMD = 0x48,
109 REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */
110
Ron Rindjunsky9636e582008-05-15 13:54:14 +0800111 /* WiMAX coexistence */
112 COEX_PRIORITY_TABLE_CMD = 0x5a, /*5000 only */
113 COEX_MEDIUM_NOTIFICATION = 0x5b,
114 COEX_EVENT_CMD = 0x5c,
115
Tomas Winklerbe5d56e2008-10-08 09:37:27 +0800116 /* Calibration */
Jay Sternberg1a5c3d62009-10-23 13:42:19 -0700117 TEMPERATURE_NOTIFICATION = 0x62,
Tomas Winklerbe5d56e2008-10-08 09:37:27 +0800118 CALIBRATION_CFG_CMD = 0x65,
119 CALIBRATION_RES_NOTIFICATION = 0x66,
120 CALIBRATION_COMPLETE_NOTIFICATION = 0x67,
121
Zhu Yib481de92007-09-25 17:54:57 -0700122 /* 802.11h related */
123 RADAR_NOTIFICATION = 0x70, /* not used */
124 REPLY_QUIET_CMD = 0x71, /* not used */
125 REPLY_CHANNEL_SWITCH = 0x72,
126 CHANNEL_SWITCH_NOTIFICATION = 0x73,
127 REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
128 SPECTRUM_MEASURE_NOTIFICATION = 0x75,
129
130 /* Power Management */
131 POWER_TABLE_CMD = 0x77,
132 PM_SLEEP_NOTIFICATION = 0x7A,
133 PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
134
135 /* Scan commands and notifications */
136 REPLY_SCAN_CMD = 0x80,
137 REPLY_SCAN_ABORT_CMD = 0x81,
138 SCAN_START_NOTIFICATION = 0x82,
139 SCAN_RESULTS_NOTIFICATION = 0x83,
140 SCAN_COMPLETE_NOTIFICATION = 0x84,
141
142 /* IBSS/AP commands */
143 BEACON_NOTIFICATION = 0x90,
144 REPLY_TX_BEACON = 0x91,
145 WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */
146
147 /* Miscellaneous commands */
Jay Sternberg76a24072009-01-29 11:09:14 -0800148 REPLY_TX_POWER_DBM_CMD = 0x95,
Zhu Yib481de92007-09-25 17:54:57 -0700149 QUIET_NOTIFICATION = 0x96, /* not used */
150 REPLY_TX_PWR_TABLE_CMD = 0x97,
Jay Sternberg76a24072009-01-29 11:09:14 -0800151 REPLY_TX_POWER_DBM_CMD_V1 = 0x98, /* old version of API */
Wey-Yi Guy2f748de2009-09-17 10:43:51 -0700152 TX_ANT_CONFIGURATION_CMD = 0x98,
Zhu Yib481de92007-09-25 17:54:57 -0700153 MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */
154
Tomas Winklera96a27f2008-10-23 23:48:56 -0700155 /* Bluetooth device coexistence config command */
Zhu Yib481de92007-09-25 17:54:57 -0700156 REPLY_BT_CONFIG = 0x9b,
157
Ben Cahill80cc0c32007-11-29 11:10:09 +0800158 /* Statistics */
Zhu Yib481de92007-09-25 17:54:57 -0700159 REPLY_STATISTICS_CMD = 0x9c,
160 STATISTICS_NOTIFICATION = 0x9d,
161
162 /* RF-KILL commands and notifications */
163 REPLY_CARD_STATE_CMD = 0xa0,
164 CARD_STATE_NOTIFICATION = 0xa1,
165
166 /* Missed beacons notification */
167 MISSED_BEACONS_NOTIFICATION = 0xa2,
168
Zhu Yib481de92007-09-25 17:54:57 -0700169 REPLY_CT_KILL_CONFIG_CMD = 0xa4,
170 SENSITIVITY_CMD = 0xa8,
171 REPLY_PHY_CALIBRATION_CMD = 0xb0,
172 REPLY_RX_PHY_CMD = 0xc0,
173 REPLY_RX_MPDU_CMD = 0xc1,
Tomas Winkler857485c2008-03-21 13:53:44 -0700174 REPLY_RX = 0xc3,
Zhu Yib481de92007-09-25 17:54:57 -0700175 REPLY_COMPRESSED_BA = 0xc5,
Zhu Yib481de92007-09-25 17:54:57 -0700176 REPLY_MAX = 0xff
177};
178
179/******************************************************************************
180 * (0)
Ben Cahillabceddb2007-11-29 11:09:50 +0800181 * Commonly used structures and definitions:
Ben Cahill80cc0c32007-11-29 11:10:09 +0800182 * Command header, rate_n_flags, txpower
Zhu Yib481de92007-09-25 17:54:57 -0700183 *
184 *****************************************************************************/
185
Tomas Winkler857485c2008-03-21 13:53:44 -0700186/* iwl_cmd_header flags value */
Zhu Yib481de92007-09-25 17:54:57 -0700187#define IWL_CMD_FAILED_MSK 0x40
188
Tomas Winkler9734cb22008-09-03 11:26:52 +0800189#define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
190#define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
191#define SEQ_TO_INDEX(s) ((s) & 0xff)
192#define INDEX_TO_SEQ(i) ((i) & 0xff)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800193#define SEQ_HUGE_FRAME cpu_to_le16(0x4000)
194#define SEQ_RX_FRAME cpu_to_le16(0x8000)
Tomas Winkler9734cb22008-09-03 11:26:52 +0800195
Ben Cahill075416c2007-11-29 11:10:08 +0800196/**
Tomas Winkler857485c2008-03-21 13:53:44 -0700197 * struct iwl_cmd_header
Ben Cahill075416c2007-11-29 11:10:08 +0800198 *
199 * This header format appears in the beginning of each command sent from the
200 * driver, and each response/notification received from uCode.
201 */
Tomas Winkler857485c2008-03-21 13:53:44 -0700202struct iwl_cmd_header {
Ben Cahill075416c2007-11-29 11:10:08 +0800203 u8 cmd; /* Command ID: REPLY_RXON, etc. */
Tomas Winkler9734cb22008-09-03 11:26:52 +0800204 u8 flags; /* 0:5 reserved, 6 abort, 7 internal */
Ben Cahill075416c2007-11-29 11:10:08 +0800205 /*
Tomas Winklera96a27f2008-10-23 23:48:56 -0700206 * The driver sets up the sequence number to values of its choosing.
Ben Cahill075416c2007-11-29 11:10:08 +0800207 * uCode does not use this value, but passes it back to the driver
208 * when sending the response to each driver-originated command, so
209 * the driver can match the response to the command. Since the values
210 * don't get used by uCode, the driver may set up an arbitrary format.
Zhu Yib481de92007-09-25 17:54:57 -0700211 *
Ben Cahill075416c2007-11-29 11:10:08 +0800212 * There is one exception: uCode sets bit 15 when it originates
213 * the response/notification, i.e. when the response/notification
214 * is not a direct response to a command sent by the driver. For
215 * example, uCode issues REPLY_3945_RX when it sends a received frame
216 * to the driver; it is not a direct response to any driver command.
Zhu Yib481de92007-09-25 17:54:57 -0700217 *
Ben Cahill075416c2007-11-29 11:10:08 +0800218 * The Linux driver uses the following format:
219 *
Tomas Winkler9734cb22008-09-03 11:26:52 +0800220 * 0:7 tfd index - position within TX queue
221 * 8:12 TX queue id
222 * 13 reserved
223 * 14 huge - driver sets this to indicate command is in the
224 * 'huge' storage at the end of the command buffers
225 * 15 unsolicited RX or uCode-originated notification
Zhu Yib481de92007-09-25 17:54:57 -0700226 */
227 __le16 sequence;
228
Ben Cahill075416c2007-11-29 11:10:08 +0800229 /* command or response/notification data follows immediately */
Zhu Yib481de92007-09-25 17:54:57 -0700230 u8 data[0];
231} __attribute__ ((packed));
232
Tomas Winkler3d24a9f2008-12-19 10:37:07 +0800233
234/**
235 * struct iwl3945_tx_power
236 *
237 * Used in REPLY_TX_PWR_TABLE_CMD, REPLY_SCAN_CMD, REPLY_CHANNEL_SWITCH
238 *
239 * Each entry contains two values:
240 * 1) DSP gain (or sometimes called DSP attenuation). This is a fine-grained
241 * linear value that multiplies the output of the digital signal processor,
242 * before being sent to the analog radio.
243 * 2) Radio gain. This sets the analog gain of the radio Tx path.
244 * It is a coarser setting, and behaves in a logarithmic (dB) fashion.
245 *
246 * Driver obtains values from struct iwl3945_tx_power power_gain_table[][].
247 */
248struct iwl3945_tx_power {
249 u8 tx_gain; /* gain for analog radio */
250 u8 dsp_atten; /* gain for DSP */
251} __attribute__ ((packed));
252
253/**
254 * struct iwl3945_power_per_rate
255 *
256 * Used in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
257 */
258struct iwl3945_power_per_rate {
259 u8 rate; /* plcp */
260 struct iwl3945_tx_power tpc;
261 u8 reserved;
262} __attribute__ ((packed));
263
Ben Cahillabceddb2007-11-29 11:09:50 +0800264/**
Halperin, Daniel C5c5aa3f2008-11-07 09:58:38 -0800265 * iwlagn rate_n_flags bit fields
Ben Cahillabceddb2007-11-29 11:09:50 +0800266 *
Halperin, Daniel C5c5aa3f2008-11-07 09:58:38 -0800267 * rate_n_flags format is used in following iwlagn commands:
Tomas Winkler857485c2008-03-21 13:53:44 -0700268 * REPLY_RX (response only)
Halperin, Daniel C5c5aa3f2008-11-07 09:58:38 -0800269 * REPLY_RX_MPDU (response only)
Ben Cahillabceddb2007-11-29 11:09:50 +0800270 * REPLY_TX (both command and response)
271 * REPLY_TX_LINK_QUALITY_CMD
272 *
273 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
274 * 2-0: 0) 6 Mbps
275 * 1) 12 Mbps
276 * 2) 18 Mbps
277 * 3) 24 Mbps
278 * 4) 36 Mbps
279 * 5) 48 Mbps
280 * 6) 54 Mbps
281 * 7) 60 Mbps
282 *
Halperin, Daniel C5c5aa3f2008-11-07 09:58:38 -0800283 * 4-3: 0) Single stream (SISO)
Ben Cahillabceddb2007-11-29 11:09:50 +0800284 * 1) Dual stream (MIMO)
Halperin, Daniel C5c5aa3f2008-11-07 09:58:38 -0800285 * 2) Triple stream (MIMO)
Ben Cahillabceddb2007-11-29 11:09:50 +0800286 *
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700287 * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data
Ben Cahillabceddb2007-11-29 11:09:50 +0800288 *
289 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
290 * 3-0: 0xD) 6 Mbps
291 * 0xF) 9 Mbps
292 * 0x5) 12 Mbps
293 * 0x7) 18 Mbps
294 * 0x9) 24 Mbps
295 * 0xB) 36 Mbps
296 * 0x1) 48 Mbps
297 * 0x3) 54 Mbps
298 *
299 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
Daniel Wu10617872008-12-20 10:53:29 -0800300 * 6-0: 10) 1 Mbps
Ben Cahillabceddb2007-11-29 11:09:50 +0800301 * 20) 2 Mbps
302 * 55) 5.5 Mbps
303 * 110) 11 Mbps
304 */
305#define RATE_MCS_CODE_MSK 0x7
Halperin, Daniel C5c5aa3f2008-11-07 09:58:38 -0800306#define RATE_MCS_SPATIAL_POS 3
307#define RATE_MCS_SPATIAL_MSK 0x18
Ben Cahillabceddb2007-11-29 11:09:50 +0800308#define RATE_MCS_HT_DUP_POS 5
309#define RATE_MCS_HT_DUP_MSK 0x20
310
Ben Cahill075416c2007-11-29 11:10:08 +0800311/* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
Ben Cahillabceddb2007-11-29 11:09:50 +0800312#define RATE_MCS_FLAGS_POS 8
313#define RATE_MCS_HT_POS 8
314#define RATE_MCS_HT_MSK 0x100
315
Ben Cahill075416c2007-11-29 11:10:08 +0800316/* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */
Ben Cahillabceddb2007-11-29 11:09:50 +0800317#define RATE_MCS_CCK_POS 9
318#define RATE_MCS_CCK_MSK 0x200
319
Ben Cahill075416c2007-11-29 11:10:08 +0800320/* Bit 10: (1) Use Green Field preamble */
Ben Cahillabceddb2007-11-29 11:09:50 +0800321#define RATE_MCS_GF_POS 10
322#define RATE_MCS_GF_MSK 0x400
323
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700324/* Bit 11: (1) Use 40Mhz HT40 chnl width, (0) use 20 MHz legacy chnl width */
325#define RATE_MCS_HT40_POS 11
326#define RATE_MCS_HT40_MSK 0x800
Ben Cahillabceddb2007-11-29 11:09:50 +0800327
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700328/* Bit 12: (1) Duplicate data on both 20MHz chnls. HT40 (bit 11) must be set. */
Ben Cahillabceddb2007-11-29 11:09:50 +0800329#define RATE_MCS_DUP_POS 12
330#define RATE_MCS_DUP_MSK 0x1000
331
Ben Cahill075416c2007-11-29 11:10:08 +0800332/* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
Ben Cahillabceddb2007-11-29 11:09:50 +0800333#define RATE_MCS_SGI_POS 13
334#define RATE_MCS_SGI_MSK 0x2000
335
336/**
Tomas Winkler76eff182008-10-14 12:32:45 -0700337 * rate_n_flags Tx antenna masks
338 * 4965 has 2 transmitters
339 * 5100 has 1 transmitter B
340 * 5150 has 1 transmitter A
341 * 5300 has 3 transmitters
342 * 5350 has 3 transmitters
343 * bit14:16
Ben Cahillabceddb2007-11-29 11:09:50 +0800344 */
Tomas Winkler600c0e12008-12-19 10:37:04 +0800345#define RATE_MCS_ANT_POS 14
346#define RATE_MCS_ANT_A_MSK 0x04000
347#define RATE_MCS_ANT_B_MSK 0x08000
348#define RATE_MCS_ANT_C_MSK 0x10000
349#define RATE_MCS_ANT_AB_MSK (RATE_MCS_ANT_A_MSK | RATE_MCS_ANT_B_MSK)
350#define RATE_MCS_ANT_ABC_MSK (RATE_MCS_ANT_AB_MSK | RATE_MCS_ANT_C_MSK)
Tomas Winkler76eff182008-10-14 12:32:45 -0700351#define RATE_ANT_NUM 3
Ben Cahill80cc0c32007-11-29 11:10:09 +0800352
353#define POWER_TABLE_NUM_ENTRIES 33
354#define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32
355#define POWER_TABLE_CCK_ENTRY 32
356
Wey-Yi Guye57f1482009-10-09 13:20:34 -0700357#define IWL_PWR_NUM_HT_OFDM_ENTRIES 24
358#define IWL_PWR_CCK_ENTRIES 2
359
Ben Cahill80cc0c32007-11-29 11:10:09 +0800360/**
361 * union iwl4965_tx_power_dual_stream
362 *
363 * Host format used for REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
364 * Use __le32 version (struct tx_power_dual_stream) when building command.
365 *
366 * Driver provides radio gain and DSP attenuation settings to device in pairs,
367 * one value for each transmitter chain. The first value is for transmitter A,
368 * second for transmitter B.
369 *
370 * For SISO bit rates, both values in a pair should be identical.
371 * For MIMO rates, one value may be different from the other,
372 * in order to balance the Tx output between the two transmitters.
373 *
374 * See more details in doc for TXPOWER in iwl-4965-hw.h.
375 */
376union iwl4965_tx_power_dual_stream {
377 struct {
378 u8 radio_tx_gain[2];
379 u8 dsp_predis_atten[2];
380 } s;
381 u32 dw;
382};
383
384/**
385 * struct tx_power_dual_stream
386 *
387 * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
388 *
389 * Same format as iwl_tx_power_dual_stream, but __le32
390 */
391struct tx_power_dual_stream {
392 __le32 dw;
393} __attribute__ ((packed));
394
395/**
396 * struct iwl4965_tx_power_db
397 *
398 * Entire table within REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
399 */
400struct iwl4965_tx_power_db {
401 struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES];
402} __attribute__ ((packed));
403
Tomas Winkler630fe9b2008-06-12 09:47:08 +0800404/**
Tomas Winklera96a27f2008-10-23 23:48:56 -0700405 * Command REPLY_TX_POWER_DBM_CMD = 0x98
Tomas Winkler630fe9b2008-06-12 09:47:08 +0800406 * struct iwl5000_tx_power_dbm_cmd
407 */
408#define IWL50_TX_POWER_AUTO 0x7f
Gregory Greenman853554a2008-06-30 17:23:01 +0800409#define IWL50_TX_POWER_NO_CLOSED (0x1 << 6)
410
Tomas Winkler630fe9b2008-06-12 09:47:08 +0800411struct iwl5000_tx_power_dbm_cmd {
412 s8 global_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
413 u8 flags;
414 s8 srv_chan_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
415 u8 reserved;
416} __attribute__ ((packed));
Ben Cahill80cc0c32007-11-29 11:10:09 +0800417
Wey-Yi Guy2f748de2009-09-17 10:43:51 -0700418/**
419 * Command TX_ANT_CONFIGURATION_CMD = 0x98
420 * This command is used to configure valid Tx antenna.
421 * By default uCode concludes the valid antenna according to the radio flavor.
422 * This command enables the driver to override/modify this conclusion.
423 */
424struct iwl_tx_ant_config_cmd {
425 __le32 valid;
426} __attribute__ ((packed));
427
Zhu Yib481de92007-09-25 17:54:57 -0700428/******************************************************************************
429 * (0a)
430 * Alive and Error Commands & Responses:
431 *
432 *****************************************************************************/
433
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800434#define UCODE_VALID_OK cpu_to_le32(0x1)
Zhu Yib481de92007-09-25 17:54:57 -0700435#define INITIALIZE_SUBTYPE (9)
436
437/*
Ben Cahill075416c2007-11-29 11:10:08 +0800438 * ("Initialize") REPLY_ALIVE = 0x1 (response only, not a command)
439 *
440 * uCode issues this "initialize alive" notification once the initialization
441 * uCode image has completed its work, and is ready to load the runtime image.
442 * This is the *first* "alive" notification that the driver will receive after
443 * rebooting uCode; the "initialize" alive is indicated by subtype field == 9.
444 *
445 * See comments documenting "BSM" (bootstrap state machine).
446 *
447 * For 4965, this notification contains important calibration data for
448 * calculating txpower settings:
449 *
450 * 1) Power supply voltage indication. The voltage sensor outputs higher
Tomas Winklera96a27f2008-10-23 23:48:56 -0700451 * values for lower voltage, and vice verse.
Ben Cahill075416c2007-11-29 11:10:08 +0800452 *
453 * 2) Temperature measurement parameters, for each of two channel widths
454 * (20 MHz and 40 MHz) supported by the radios. Temperature sensing
455 * is done via one of the receiver chains, and channel width influences
456 * the results.
457 *
458 * 3) Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation,
459 * for each of 5 frequency ranges.
Zhu Yib481de92007-09-25 17:54:57 -0700460 */
Tomas Winkler885ba202008-05-29 16:34:55 +0800461struct iwl_init_alive_resp {
Zhu Yib481de92007-09-25 17:54:57 -0700462 u8 ucode_minor;
463 u8 ucode_major;
464 __le16 reserved1;
465 u8 sw_rev[8];
466 u8 ver_type;
Ben Cahill075416c2007-11-29 11:10:08 +0800467 u8 ver_subtype; /* "9" for initialize alive */
Zhu Yib481de92007-09-25 17:54:57 -0700468 __le16 reserved2;
469 __le32 log_event_table_ptr;
470 __le32 error_event_table_ptr;
471 __le32 timestamp;
472 __le32 is_valid;
473
Zhu Yib481de92007-09-25 17:54:57 -0700474 /* calibration values from "initialize" uCode */
Ben Cahill075416c2007-11-29 11:10:08 +0800475 __le32 voltage; /* signed, higher value is lower voltage */
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700476 __le32 therm_r1[2]; /* signed, 1st for normal, 2nd for HT40 */
Zhu Yib481de92007-09-25 17:54:57 -0700477 __le32 therm_r2[2]; /* signed */
478 __le32 therm_r3[2]; /* signed */
479 __le32 therm_r4[2]; /* signed */
480 __le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups,
481 * 2 Tx chains */
Zhu Yib481de92007-09-25 17:54:57 -0700482} __attribute__ ((packed));
483
Ben Cahill075416c2007-11-29 11:10:08 +0800484
485/**
486 * REPLY_ALIVE = 0x1 (response only, not a command)
487 *
488 * uCode issues this "alive" notification once the runtime image is ready
489 * to receive commands from the driver. This is the *second* "alive"
490 * notification that the driver will receive after rebooting uCode;
491 * this "alive" is indicated by subtype field != 9.
492 *
493 * See comments documenting "BSM" (bootstrap state machine).
494 *
495 * This response includes two pointers to structures within the device's
496 * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
497 *
498 * 1) log_event_table_ptr indicates base of the event log. This traces
499 * a 256-entry history of uCode execution within a circular buffer.
500 * Its header format is:
501 *
502 * __le32 log_size; log capacity (in number of entries)
503 * __le32 type; (1) timestamp with each entry, (0) no timestamp
504 * __le32 wraps; # times uCode has wrapped to top of circular buffer
505 * __le32 write_index; next circular buffer entry that uCode would fill
506 *
507 * The header is followed by the circular buffer of log entries. Entries
508 * with timestamps have the following format:
509 *
510 * __le32 event_id; range 0 - 1500
511 * __le32 timestamp; low 32 bits of TSF (of network, if associated)
512 * __le32 data; event_id-specific data value
513 *
514 * Entries without timestamps contain only event_id and data.
515 *
516 * 2) error_event_table_ptr indicates base of the error log. This contains
517 * information about any uCode error that occurs. For 4965, the format
518 * of the error log is:
519 *
520 * __le32 valid; (nonzero) valid, (0) log is empty
521 * __le32 error_id; type of error
522 * __le32 pc; program counter
523 * __le32 blink1; branch link
524 * __le32 blink2; branch link
525 * __le32 ilink1; interrupt link
526 * __le32 ilink2; interrupt link
527 * __le32 data1; error-specific data
528 * __le32 data2; error-specific data
529 * __le32 line; source code line of error
530 * __le32 bcon_time; beacon timer
531 * __le32 tsf_low; network timestamp function timer
532 * __le32 tsf_hi; network timestamp function timer
533 *
534 * The Linux driver can print both logs to the system log when a uCode error
535 * occurs.
536 */
Tomas Winkler885ba202008-05-29 16:34:55 +0800537struct iwl_alive_resp {
Ben Cahill075416c2007-11-29 11:10:08 +0800538 u8 ucode_minor;
539 u8 ucode_major;
540 __le16 reserved1;
541 u8 sw_rev[8];
542 u8 ver_type;
543 u8 ver_subtype; /* not "9" for runtime alive */
544 __le16 reserved2;
545 __le32 log_event_table_ptr; /* SRAM address for event log */
546 __le32 error_event_table_ptr; /* SRAM address for error log */
547 __le32 timestamp;
548 __le32 is_valid;
549} __attribute__ ((packed));
550
Zhu Yib481de92007-09-25 17:54:57 -0700551/*
552 * REPLY_ERROR = 0x2 (response only, not a command)
553 */
Tomas Winkler885ba202008-05-29 16:34:55 +0800554struct iwl_error_resp {
Zhu Yib481de92007-09-25 17:54:57 -0700555 __le32 error_type;
556 u8 cmd_id;
557 u8 reserved1;
558 __le16 bad_cmd_seq_num;
Zhu Yib481de92007-09-25 17:54:57 -0700559 __le32 error_info;
Tomas Winkler3195c1f2008-10-08 09:37:30 +0800560 __le64 timestamp;
Zhu Yib481de92007-09-25 17:54:57 -0700561} __attribute__ ((packed));
562
563/******************************************************************************
564 * (1)
565 * RXON Commands & Responses:
566 *
567 *****************************************************************************/
568
569/*
570 * Rx config defines & structure
571 */
572/* rx_config device types */
573enum {
574 RXON_DEV_TYPE_AP = 1,
575 RXON_DEV_TYPE_ESS = 3,
576 RXON_DEV_TYPE_IBSS = 4,
577 RXON_DEV_TYPE_SNIFFER = 6,
578};
579
Ben Cahill14519a02007-11-29 11:09:59 +0800580
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800581#define RXON_RX_CHAIN_DRIVER_FORCE_MSK cpu_to_le16(0x1 << 0)
Rick Farrington7b841722009-01-23 13:45:10 -0800582#define RXON_RX_CHAIN_DRIVER_FORCE_POS (0)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800583#define RXON_RX_CHAIN_VALID_MSK cpu_to_le16(0x7 << 1)
Ben Cahill14519a02007-11-29 11:09:59 +0800584#define RXON_RX_CHAIN_VALID_POS (1)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800585#define RXON_RX_CHAIN_FORCE_SEL_MSK cpu_to_le16(0x7 << 4)
Ben Cahill14519a02007-11-29 11:09:59 +0800586#define RXON_RX_CHAIN_FORCE_SEL_POS (4)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800587#define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK cpu_to_le16(0x7 << 7)
Ben Cahill14519a02007-11-29 11:09:59 +0800588#define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800589#define RXON_RX_CHAIN_CNT_MSK cpu_to_le16(0x3 << 10)
Ben Cahill14519a02007-11-29 11:09:59 +0800590#define RXON_RX_CHAIN_CNT_POS (10)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800591#define RXON_RX_CHAIN_MIMO_CNT_MSK cpu_to_le16(0x3 << 12)
Ben Cahill14519a02007-11-29 11:09:59 +0800592#define RXON_RX_CHAIN_MIMO_CNT_POS (12)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800593#define RXON_RX_CHAIN_MIMO_FORCE_MSK cpu_to_le16(0x1 << 14)
Ben Cahill14519a02007-11-29 11:09:59 +0800594#define RXON_RX_CHAIN_MIMO_FORCE_POS (14)
595
Zhu Yib481de92007-09-25 17:54:57 -0700596/* rx_config flags */
597/* band & modulation selection */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800598#define RXON_FLG_BAND_24G_MSK cpu_to_le32(1 << 0)
599#define RXON_FLG_CCK_MSK cpu_to_le32(1 << 1)
Zhu Yib481de92007-09-25 17:54:57 -0700600/* auto detection enable */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800601#define RXON_FLG_AUTO_DETECT_MSK cpu_to_le32(1 << 2)
Zhu Yib481de92007-09-25 17:54:57 -0700602/* TGg protection when tx */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800603#define RXON_FLG_TGG_PROTECT_MSK cpu_to_le32(1 << 3)
Zhu Yib481de92007-09-25 17:54:57 -0700604/* cck short slot & preamble */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800605#define RXON_FLG_SHORT_SLOT_MSK cpu_to_le32(1 << 4)
606#define RXON_FLG_SHORT_PREAMBLE_MSK cpu_to_le32(1 << 5)
Zhu Yib481de92007-09-25 17:54:57 -0700607/* antenna selection */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800608#define RXON_FLG_DIS_DIV_MSK cpu_to_le32(1 << 7)
609#define RXON_FLG_ANT_SEL_MSK cpu_to_le32(0x0f00)
610#define RXON_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
611#define RXON_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
Zhu Yib481de92007-09-25 17:54:57 -0700612/* radar detection enable */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800613#define RXON_FLG_RADAR_DETECT_MSK cpu_to_le32(1 << 12)
614#define RXON_FLG_TGJ_NARROW_BAND_MSK cpu_to_le32(1 << 13)
Zhu Yib481de92007-09-25 17:54:57 -0700615/* rx response to host with 8-byte TSF
616* (according to ON_AIR deassertion) */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800617#define RXON_FLG_TSF2HOST_MSK cpu_to_le32(1 << 15)
Zhu Yib481de92007-09-25 17:54:57 -0700618
Ben Cahill14519a02007-11-29 11:09:59 +0800619
620/* HT flags */
621#define RXON_FLG_CTRL_CHANNEL_LOC_POS (22)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800622#define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK cpu_to_le32(0x1 << 22)
Ben Cahill14519a02007-11-29 11:09:59 +0800623
624#define RXON_FLG_HT_OPERATING_MODE_POS (23)
625
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800626#define RXON_FLG_HT_PROT_MSK cpu_to_le32(0x1 << 23)
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700627#define RXON_FLG_HT40_PROT_MSK cpu_to_le32(0x2 << 23)
Ben Cahill14519a02007-11-29 11:09:59 +0800628
629#define RXON_FLG_CHANNEL_MODE_POS (25)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800630#define RXON_FLG_CHANNEL_MODE_MSK cpu_to_le32(0x3 << 25)
Wey-Yi Guya2b0f022009-05-22 11:01:49 -0700631
632/* channel mode */
633enum {
634 CHANNEL_MODE_LEGACY = 0,
635 CHANNEL_MODE_PURE_40 = 1,
636 CHANNEL_MODE_MIXED = 2,
637 CHANNEL_MODE_RESERVED = 3,
638};
639#define RXON_FLG_CHANNEL_MODE_LEGACY cpu_to_le32(CHANNEL_MODE_LEGACY << RXON_FLG_CHANNEL_MODE_POS)
640#define RXON_FLG_CHANNEL_MODE_PURE_40 cpu_to_le32(CHANNEL_MODE_PURE_40 << RXON_FLG_CHANNEL_MODE_POS)
641#define RXON_FLG_CHANNEL_MODE_MIXED cpu_to_le32(CHANNEL_MODE_MIXED << RXON_FLG_CHANNEL_MODE_POS)
642
Emmanuel Grumbacha326a5d2008-07-11 11:53:31 +0800643/* CTS to self (if spec allows) flag */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800644#define RXON_FLG_SELF_CTS_EN cpu_to_le32(0x1<<30)
Ben Cahill14519a02007-11-29 11:09:59 +0800645
Zhu Yib481de92007-09-25 17:54:57 -0700646/* rx_config filter flags */
647/* accept all data frames */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800648#define RXON_FILTER_PROMISC_MSK cpu_to_le32(1 << 0)
Zhu Yib481de92007-09-25 17:54:57 -0700649/* pass control & management to host */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800650#define RXON_FILTER_CTL2HOST_MSK cpu_to_le32(1 << 1)
Zhu Yib481de92007-09-25 17:54:57 -0700651/* accept multi-cast */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800652#define RXON_FILTER_ACCEPT_GRP_MSK cpu_to_le32(1 << 2)
Zhu Yib481de92007-09-25 17:54:57 -0700653/* don't decrypt uni-cast frames */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800654#define RXON_FILTER_DIS_DECRYPT_MSK cpu_to_le32(1 << 3)
Zhu Yib481de92007-09-25 17:54:57 -0700655/* don't decrypt multi-cast frames */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800656#define RXON_FILTER_DIS_GRP_DECRYPT_MSK cpu_to_le32(1 << 4)
Zhu Yib481de92007-09-25 17:54:57 -0700657/* STA is associated */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800658#define RXON_FILTER_ASSOC_MSK cpu_to_le32(1 << 5)
Zhu Yib481de92007-09-25 17:54:57 -0700659/* transfer to host non bssid beacons in associated state */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800660#define RXON_FILTER_BCON_AWARE_MSK cpu_to_le32(1 << 6)
Zhu Yib481de92007-09-25 17:54:57 -0700661
Ben Cahill80cc0c32007-11-29 11:10:09 +0800662/**
Zhu Yib481de92007-09-25 17:54:57 -0700663 * REPLY_RXON = 0x10 (command, has simple generic response)
Ben Cahill80cc0c32007-11-29 11:10:09 +0800664 *
665 * RXON tunes the radio tuner to a service channel, and sets up a number
666 * of parameters that are used primarily for Rx, but also for Tx operations.
667 *
668 * NOTE: When tuning to a new channel, driver must set the
669 * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent
670 * info within the device, including the station tables, tx retry
671 * rate tables, and txpower tables. Driver must build a new station
672 * table and txpower table before transmitting anything on the RXON
673 * channel.
674 *
675 * NOTE: All RXONs wipe clean the internal txpower table. Driver must
676 * issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
677 * regardless of whether RXON_FILTER_ASSOC_MSK is set.
Zhu Yib481de92007-09-25 17:54:57 -0700678 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +0800679
680struct iwl3945_rxon_cmd {
681 u8 node_addr[6];
682 __le16 reserved1;
683 u8 bssid_addr[6];
684 __le16 reserved2;
685 u8 wlap_bssid_addr[6];
686 __le16 reserved3;
687 u8 dev_type;
688 u8 air_propagation;
689 __le16 reserved4;
690 u8 ofdm_basic_rates;
691 u8 cck_basic_rates;
692 __le16 assoc_id;
693 __le32 flags;
694 __le32 filter_flags;
695 __le16 channel;
696 __le16 reserved5;
697} __attribute__ ((packed));
698
Christoph Hellwigbb8c0932008-01-27 16:41:47 -0800699struct iwl4965_rxon_cmd {
Zhu Yib481de92007-09-25 17:54:57 -0700700 u8 node_addr[6];
701 __le16 reserved1;
702 u8 bssid_addr[6];
703 __le16 reserved2;
704 u8 wlap_bssid_addr[6];
705 __le16 reserved3;
706 u8 dev_type;
707 u8 air_propagation;
Zhu Yib481de92007-09-25 17:54:57 -0700708 __le16 rx_chain;
Zhu Yib481de92007-09-25 17:54:57 -0700709 u8 ofdm_basic_rates;
710 u8 cck_basic_rates;
711 __le16 assoc_id;
712 __le32 flags;
713 __le32 filter_flags;
714 __le16 channel;
Zhu Yib481de92007-09-25 17:54:57 -0700715 u8 ofdm_ht_single_stream_basic_rates;
716 u8 ofdm_ht_dual_stream_basic_rates;
Zhu Yib481de92007-09-25 17:54:57 -0700717} __attribute__ ((packed));
718
Tomas Winklera96a27f2008-10-23 23:48:56 -0700719/* 5000 HW just extend this command */
Gregory Greenmanc1adf9f2008-05-15 13:53:59 +0800720struct iwl_rxon_cmd {
721 u8 node_addr[6];
722 __le16 reserved1;
723 u8 bssid_addr[6];
724 __le16 reserved2;
725 u8 wlap_bssid_addr[6];
726 __le16 reserved3;
727 u8 dev_type;
728 u8 air_propagation;
729 __le16 rx_chain;
730 u8 ofdm_basic_rates;
731 u8 cck_basic_rates;
732 __le16 assoc_id;
733 __le32 flags;
734 __le32 filter_flags;
735 __le16 channel;
736 u8 ofdm_ht_single_stream_basic_rates;
737 u8 ofdm_ht_dual_stream_basic_rates;
738 u8 ofdm_ht_triple_stream_basic_rates;
739 u8 reserved5;
740 __le16 acquisition_data;
741 __le16 reserved6;
742} __attribute__ ((packed));
743
Tomas Winkler3d24a9f2008-12-19 10:37:07 +0800744/*
745 * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
746 */
747struct iwl3945_rxon_assoc_cmd {
748 __le32 flags;
749 __le32 filter_flags;
750 u8 ofdm_basic_rates;
751 u8 cck_basic_rates;
752 __le16 reserved;
753} __attribute__ ((packed));
754
755struct iwl4965_rxon_assoc_cmd {
756 __le32 flags;
757 __le32 filter_flags;
758 u8 ofdm_basic_rates;
759 u8 cck_basic_rates;
760 u8 ofdm_ht_single_stream_basic_rates;
761 u8 ofdm_ht_dual_stream_basic_rates;
762 __le16 rx_chain_select_flags;
763 __le16 reserved;
764} __attribute__ ((packed));
765
Ron Rindjunskyfe7a90c2008-05-29 16:35:14 +0800766struct iwl5000_rxon_assoc_cmd {
767 __le32 flags;
768 __le32 filter_flags;
769 u8 ofdm_basic_rates;
770 u8 cck_basic_rates;
771 __le16 reserved1;
772 u8 ofdm_ht_single_stream_basic_rates;
773 u8 ofdm_ht_dual_stream_basic_rates;
774 u8 ofdm_ht_triple_stream_basic_rates;
775 u8 reserved2;
776 __le16 rx_chain_select_flags;
777 __le16 acquisition_data;
778 __le32 reserved3;
779} __attribute__ ((packed));
Gregory Greenmanc1adf9f2008-05-15 13:53:59 +0800780
Tomas Winklerb5d7be52008-07-19 04:41:24 +0300781#define IWL_CONN_MAX_LISTEN_INTERVAL 10
Tomas Winkler2c2f3b32009-06-19 13:52:45 -0700782#define IWL_MAX_UCODE_BEACON_INTERVAL 4 /* 4096 */
783#define IWL39_MAX_UCODE_BEACON_INTERVAL 1 /* 1024 */
Ron Rindjunskyfe7a90c2008-05-29 16:35:14 +0800784
Zhu Yib481de92007-09-25 17:54:57 -0700785/*
786 * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
787 */
Tomas Winkler3195c1f2008-10-08 09:37:30 +0800788struct iwl_rxon_time_cmd {
789 __le64 timestamp;
Zhu Yib481de92007-09-25 17:54:57 -0700790 __le16 beacon_interval;
791 __le16 atim_window;
792 __le32 beacon_init_val;
793 __le16 listen_interval;
794 __le16 reserved;
795} __attribute__ ((packed));
796
Zhu Yib481de92007-09-25 17:54:57 -0700797/*
798 * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
799 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +0800800struct iwl3945_channel_switch_cmd {
801 u8 band;
802 u8 expect_beacon;
803 __le16 channel;
804 __le32 rxon_flags;
805 __le32 rxon_filter_flags;
806 __le32 switch_time;
807 struct iwl3945_power_per_rate power[IWL_MAX_RATES];
808} __attribute__ ((packed));
809
Wey-Yi Guye57f1482009-10-09 13:20:34 -0700810struct iwl4965_channel_switch_cmd {
Zhu Yib481de92007-09-25 17:54:57 -0700811 u8 band;
812 u8 expect_beacon;
813 __le16 channel;
814 __le32 rxon_flags;
815 __le32 rxon_filter_flags;
816 __le32 switch_time;
Christoph Hellwigbb8c0932008-01-27 16:41:47 -0800817 struct iwl4965_tx_power_db tx_power;
Zhu Yib481de92007-09-25 17:54:57 -0700818} __attribute__ ((packed));
819
Wey-Yi Guye57f1482009-10-09 13:20:34 -0700820/**
821 * struct iwl5000_channel_switch_cmd
822 * @band: 0- 5.2GHz, 1- 2.4GHz
823 * @expect_beacon: 0- resume transmits after channel switch
824 * 1- wait for beacon to resume transmits
825 * @channel: new channel number
826 * @rxon_flags: Rx on flags
827 * @rxon_filter_flags: filtering parameters
828 * @switch_time: switch time in extended beacon format
829 * @reserved: reserved bytes
830 */
831struct iwl5000_channel_switch_cmd {
832 u8 band;
833 u8 expect_beacon;
834 __le16 channel;
835 __le32 rxon_flags;
836 __le32 rxon_filter_flags;
837 __le32 switch_time;
838 __le32 reserved[2][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES];
839} __attribute__ ((packed));
840
841/**
842 * struct iwl6000_channel_switch_cmd
843 * @band: 0- 5.2GHz, 1- 2.4GHz
844 * @expect_beacon: 0- resume transmits after channel switch
845 * 1- wait for beacon to resume transmits
846 * @channel: new channel number
847 * @rxon_flags: Rx on flags
848 * @rxon_filter_flags: filtering parameters
849 * @switch_time: switch time in extended beacon format
850 * @reserved: reserved bytes
851 */
852struct iwl6000_channel_switch_cmd {
853 u8 band;
854 u8 expect_beacon;
855 __le16 channel;
856 __le32 rxon_flags;
857 __le32 rxon_filter_flags;
858 __le32 switch_time;
859 __le32 reserved[3][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES];
860} __attribute__ ((packed));
861
Zhu Yib481de92007-09-25 17:54:57 -0700862/*
863 * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
864 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -0800865struct iwl_csa_notification {
Zhu Yib481de92007-09-25 17:54:57 -0700866 __le16 band;
867 __le16 channel;
868 __le32 status; /* 0 - OK, 1 - fail */
869} __attribute__ ((packed));
870
871/******************************************************************************
872 * (2)
873 * Quality-of-Service (QOS) Commands & Responses:
874 *
875 *****************************************************************************/
Ben Cahill2054a002007-11-29 11:10:10 +0800876
877/**
878 * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
879 * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
880 *
881 * @cw_min: Contention window, start value in numbers of slots.
882 * Should be a power-of-2, minus 1. Device's default is 0x0f.
883 * @cw_max: Contention window, max value in numbers of slots.
884 * Should be a power-of-2, minus 1. Device's default is 0x3f.
885 * @aifsn: Number of slots in Arbitration Interframe Space (before
886 * performing random backoff timing prior to Tx). Device default 1.
887 * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
888 *
889 * Device will automatically increase contention window by (2*CW) + 1 for each
890 * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
891 * value, to cap the CW value.
892 */
Emmanuel Grumbach1ff50bd2008-07-11 11:53:34 +0800893struct iwl_ac_qos {
Zhu Yib481de92007-09-25 17:54:57 -0700894 __le16 cw_min;
895 __le16 cw_max;
896 u8 aifsn;
897 u8 reserved1;
898 __le16 edca_txop;
899} __attribute__ ((packed));
900
901/* QoS flags defines */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800902#define QOS_PARAM_FLG_UPDATE_EDCA_MSK cpu_to_le32(0x01)
903#define QOS_PARAM_FLG_TGN_MSK cpu_to_le32(0x02)
904#define QOS_PARAM_FLG_TXOP_TYPE_MSK cpu_to_le32(0x10)
Zhu Yib481de92007-09-25 17:54:57 -0700905
Ben Cahill2054a002007-11-29 11:10:10 +0800906/* Number of Access Categories (AC) (EDCA), queues 0..3 */
Zhu Yib481de92007-09-25 17:54:57 -0700907#define AC_NUM 4
908
909/*
910 * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
Ben Cahill2054a002007-11-29 11:10:10 +0800911 *
912 * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
913 * 0: Background, 1: Best Effort, 2: Video, 3: Voice.
Zhu Yib481de92007-09-25 17:54:57 -0700914 */
Emmanuel Grumbach1ff50bd2008-07-11 11:53:34 +0800915struct iwl_qosparam_cmd {
Zhu Yib481de92007-09-25 17:54:57 -0700916 __le32 qos_flags;
Emmanuel Grumbach1ff50bd2008-07-11 11:53:34 +0800917 struct iwl_ac_qos ac[AC_NUM];
Zhu Yib481de92007-09-25 17:54:57 -0700918} __attribute__ ((packed));
919
920/******************************************************************************
921 * (3)
922 * Add/Modify Stations Commands & Responses:
923 *
924 *****************************************************************************/
925/*
926 * Multi station support
927 */
Ben Cahill2054a002007-11-29 11:10:10 +0800928
929/* Special, dedicated locations within device's station table */
Zhu Yib481de92007-09-25 17:54:57 -0700930#define IWL_AP_ID 0
931#define IWL_MULTICAST_ID 1
932#define IWL_STA_ID 2
Tomas Winkler4c897252008-12-19 10:37:05 +0800933#define IWL3945_BROADCAST_ID 24
934#define IWL3945_STATION_COUNT 25
Zhu Yib481de92007-09-25 17:54:57 -0700935#define IWL4965_BROADCAST_ID 31
936#define IWL4965_STATION_COUNT 32
Tomas Winklerfdd3e8a2008-04-24 11:55:28 -0700937#define IWL5000_BROADCAST_ID 15
938#define IWL5000_STATION_COUNT 16
Zhu Yib481de92007-09-25 17:54:57 -0700939
940#define IWL_STATION_COUNT 32 /* MAX(3945,4965)*/
941#define IWL_INVALID_STATION 255
942
Tomas Winkler4c897252008-12-19 10:37:05 +0800943#define STA_FLG_TX_RATE_MSK cpu_to_le32(1 << 2);
944#define STA_FLG_PWR_SAVE_MSK cpu_to_le32(1 << 8);
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800945#define STA_FLG_RTS_MIMO_PROT_MSK cpu_to_le32(1 << 17)
946#define STA_FLG_AGG_MPDU_8US_MSK cpu_to_le32(1 << 18)
Ben Cahill74093dd2007-11-29 11:09:53 +0800947#define STA_FLG_MAX_AGG_SIZE_POS (19)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800948#define STA_FLG_MAX_AGG_SIZE_MSK cpu_to_le32(3 << 19)
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700949#define STA_FLG_HT40_EN_MSK cpu_to_le32(1 << 21)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800950#define STA_FLG_MIMO_DIS_MSK cpu_to_le32(1 << 22)
Ben Cahill74093dd2007-11-29 11:09:53 +0800951#define STA_FLG_AGG_MPDU_DENSITY_POS (23)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800952#define STA_FLG_AGG_MPDU_DENSITY_MSK cpu_to_le32(7 << 23)
Zhu Yib481de92007-09-25 17:54:57 -0700953
Ben Cahill2054a002007-11-29 11:10:10 +0800954/* Use in mode field. 1: modify existing entry, 0: add new station entry */
Zhu Yib481de92007-09-25 17:54:57 -0700955#define STA_CONTROL_MODIFY_MSK 0x01
956
957/* key flags __le16*/
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800958#define STA_KEY_FLG_ENCRYPT_MSK cpu_to_le16(0x0007)
959#define STA_KEY_FLG_NO_ENC cpu_to_le16(0x0000)
960#define STA_KEY_FLG_WEP cpu_to_le16(0x0001)
961#define STA_KEY_FLG_CCMP cpu_to_le16(0x0002)
962#define STA_KEY_FLG_TKIP cpu_to_le16(0x0003)
Zhu Yib481de92007-09-25 17:54:57 -0700963
964#define STA_KEY_FLG_KEYID_POS 8
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800965#define STA_KEY_FLG_INVALID cpu_to_le16(0x0800)
Emmanuel Grumbacheaaf7892008-02-13 11:32:29 -0800966/* wep key is either from global key (0) or from station info array (1) */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800967#define STA_KEY_FLG_MAP_KEY_MSK cpu_to_le16(0x0008)
Emmanuel Grumbacheaaf7892008-02-13 11:32:29 -0800968
969/* wep key in STA: 5-bytes (0) or 13-bytes (1) */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800970#define STA_KEY_FLG_KEY_SIZE_MSK cpu_to_le16(0x1000)
971#define STA_KEY_MULTICAST_MSK cpu_to_le16(0x4000)
Emmanuel Grumbachdeb09c42008-03-19 16:41:41 -0700972#define STA_KEY_MAX_NUM 8
Zhu Yib481de92007-09-25 17:54:57 -0700973
Ben Cahill2054a002007-11-29 11:10:10 +0800974/* Flags indicate whether to modify vs. don't change various station params */
Zhu Yib481de92007-09-25 17:54:57 -0700975#define STA_MODIFY_KEY_MASK 0x01
976#define STA_MODIFY_TID_DISABLE_TX 0x02
977#define STA_MODIFY_TX_RATE_MSK 0x04
978#define STA_MODIFY_ADDBA_TID_MSK 0x08
979#define STA_MODIFY_DELBA_TID_MSK 0x10
Ben Cahill2054a002007-11-29 11:10:10 +0800980
981/* Receiver address (actually, Rx station's index into station table),
982 * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
Zhu Yib481de92007-09-25 17:54:57 -0700983#define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid))
984
Christoph Hellwigbb8c0932008-01-27 16:41:47 -0800985struct iwl4965_keyinfo {
Zhu Yib481de92007-09-25 17:54:57 -0700986 __le16 key_flags;
987 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
988 u8 reserved1;
989 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
Emmanuel Grumbacheaaf7892008-02-13 11:32:29 -0800990 u8 key_offset;
991 u8 reserved2;
Zhu Yib481de92007-09-25 17:54:57 -0700992 u8 key[16]; /* 16-byte unicast decryption key */
993} __attribute__ ((packed));
994
Tomas Winkler133636d2008-05-05 10:22:34 +0800995/* 5000 */
996struct iwl_keyinfo {
997 __le16 key_flags;
998 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
999 u8 reserved1;
1000 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
1001 u8 key_offset;
1002 u8 reserved2;
1003 u8 key[16]; /* 16-byte unicast decryption key */
1004 __le64 tx_secur_seq_cnt;
1005 __le64 hw_tkip_mic_rx_key;
1006 __le64 hw_tkip_mic_tx_key;
1007} __attribute__ ((packed));
1008
Ben Cahill2054a002007-11-29 11:10:10 +08001009/**
1010 * struct sta_id_modify
1011 * @addr[ETH_ALEN]: station's MAC address
1012 * @sta_id: index of station in uCode's station table
1013 * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
1014 *
1015 * Driver selects unused table index when adding new station,
1016 * or the index to a pre-existing station entry when modifying that station.
1017 * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
1018 *
1019 * modify_mask flags select which parameters to modify vs. leave alone.
1020 */
Zhu Yib481de92007-09-25 17:54:57 -07001021struct sta_id_modify {
1022 u8 addr[ETH_ALEN];
1023 __le16 reserved1;
1024 u8 sta_id;
1025 u8 modify_mask;
1026 __le16 reserved2;
1027} __attribute__ ((packed));
1028
1029/*
1030 * REPLY_ADD_STA = 0x18 (command)
Ben Cahill2054a002007-11-29 11:10:10 +08001031 *
1032 * The device contains an internal table of per-station information,
1033 * with info on security keys, aggregation parameters, and Tx rates for
1034 * initial Tx attempt and any retries (4965 uses REPLY_TX_LINK_QUALITY_CMD,
1035 * 3945 uses REPLY_RATE_SCALE to set up rate tables).
1036 *
1037 * REPLY_ADD_STA sets up the table entry for one station, either creating
1038 * a new entry, or modifying a pre-existing one.
1039 *
1040 * NOTE: RXON command (without "associated" bit set) wipes the station table
1041 * clean. Moving into RF_KILL state does this also. Driver must set up
1042 * new station table before transmitting anything on the RXON channel
1043 * (except active scans or active measurements; those commands carry
1044 * their own txpower/rate setup data).
1045 *
1046 * When getting started on a new channel, driver must set up the
1047 * IWL_BROADCAST_ID entry (last entry in the table). For a client
1048 * station in a BSS, once an AP is selected, driver sets up the AP STA
1049 * in the IWL_AP_ID entry (1st entry in the table). BROADCAST and AP
1050 * are all that are needed for a BSS client station. If the device is
1051 * used as AP, or in an IBSS network, driver must set up station table
1052 * entries for all STAs in network, starting with index IWL_STA_ID.
Zhu Yib481de92007-09-25 17:54:57 -07001053 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08001054
1055struct iwl3945_addsta_cmd {
1056 u8 mode; /* 1: modify existing, 0: add new station */
1057 u8 reserved[3];
1058 struct sta_id_modify sta;
1059 struct iwl4965_keyinfo key;
1060 __le32 station_flags; /* STA_FLG_* */
1061 __le32 station_flags_msk; /* STA_FLG_* */
1062
1063 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
1064 * corresponding to bit (e.g. bit 5 controls TID 5).
1065 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
1066 __le16 tid_disable_tx;
1067
1068 __le16 rate_n_flags;
1069
1070 /* TID for which to add block-ack support.
1071 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
1072 u8 add_immediate_ba_tid;
1073
1074 /* TID for which to remove block-ack support.
1075 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
1076 u8 remove_immediate_ba_tid;
1077
1078 /* Starting Sequence Number for added block-ack support.
1079 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
1080 __le16 add_immediate_ba_ssn;
1081} __attribute__ ((packed));
1082
Christoph Hellwigbb8c0932008-01-27 16:41:47 -08001083struct iwl4965_addsta_cmd {
Ben Cahill2054a002007-11-29 11:10:10 +08001084 u8 mode; /* 1: modify existing, 0: add new station */
Zhu Yib481de92007-09-25 17:54:57 -07001085 u8 reserved[3];
1086 struct sta_id_modify sta;
Christoph Hellwigbb8c0932008-01-27 16:41:47 -08001087 struct iwl4965_keyinfo key;
Ben Cahill2054a002007-11-29 11:10:10 +08001088 __le32 station_flags; /* STA_FLG_* */
1089 __le32 station_flags_msk; /* STA_FLG_* */
1090
1091 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
1092 * corresponding to bit (e.g. bit 5 controls TID 5).
1093 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
Zhu Yib481de92007-09-25 17:54:57 -07001094 __le16 tid_disable_tx;
Ben Cahill2054a002007-11-29 11:10:10 +08001095
Zhu Yib481de92007-09-25 17:54:57 -07001096 __le16 reserved1;
Ben Cahill2054a002007-11-29 11:10:10 +08001097
1098 /* TID for which to add block-ack support.
1099 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
Zhu Yib481de92007-09-25 17:54:57 -07001100 u8 add_immediate_ba_tid;
Ben Cahill2054a002007-11-29 11:10:10 +08001101
1102 /* TID for which to remove block-ack support.
1103 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
Zhu Yib481de92007-09-25 17:54:57 -07001104 u8 remove_immediate_ba_tid;
Ben Cahill2054a002007-11-29 11:10:10 +08001105
1106 /* Starting Sequence Number for added block-ack support.
1107 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
Zhu Yib481de92007-09-25 17:54:57 -07001108 __le16 add_immediate_ba_ssn;
Ben Cahill2054a002007-11-29 11:10:10 +08001109
Zhu Yib481de92007-09-25 17:54:57 -07001110 __le32 reserved2;
Zhu Yib481de92007-09-25 17:54:57 -07001111} __attribute__ ((packed));
1112
Tomas Winkler133636d2008-05-05 10:22:34 +08001113/* 5000 */
1114struct iwl_addsta_cmd {
1115 u8 mode; /* 1: modify existing, 0: add new station */
1116 u8 reserved[3];
1117 struct sta_id_modify sta;
1118 struct iwl_keyinfo key;
1119 __le32 station_flags; /* STA_FLG_* */
1120 __le32 station_flags_msk; /* STA_FLG_* */
1121
1122 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
1123 * corresponding to bit (e.g. bit 5 controls TID 5).
1124 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
1125 __le16 tid_disable_tx;
1126
Tomas Winklerc587de02009-06-03 11:44:07 -07001127 __le16 rate_n_flags; /* 3945 only */
Tomas Winkler133636d2008-05-05 10:22:34 +08001128
1129 /* TID for which to add block-ack support.
1130 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
1131 u8 add_immediate_ba_tid;
1132
1133 /* TID for which to remove block-ack support.
1134 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
1135 u8 remove_immediate_ba_tid;
1136
1137 /* Starting Sequence Number for added block-ack support.
1138 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
1139 __le16 add_immediate_ba_ssn;
1140
1141 __le32 reserved2;
1142} __attribute__ ((packed));
1143
1144
Ben Cahill2054a002007-11-29 11:10:10 +08001145#define ADD_STA_SUCCESS_MSK 0x1
1146#define ADD_STA_NO_ROOM_IN_TABLE 0x2
1147#define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4
1148#define ADD_STA_MODIFY_NON_EXIST_STA 0x8
Zhu Yib481de92007-09-25 17:54:57 -07001149/*
1150 * REPLY_ADD_STA = 0x18 (response)
1151 */
Tomas Winkler7a999bf2008-05-29 16:35:02 +08001152struct iwl_add_sta_resp {
Ben Cahill2054a002007-11-29 11:10:10 +08001153 u8 status; /* ADD_STA_* */
Zhu Yib481de92007-09-25 17:54:57 -07001154} __attribute__ ((packed));
1155
Tomas Winkler7a999bf2008-05-29 16:35:02 +08001156#define REM_STA_SUCCESS_MSK 0x1
1157/*
1158 * REPLY_REM_STA = 0x19 (response)
1159 */
1160struct iwl_rem_sta_resp {
1161 u8 status;
1162} __attribute__ ((packed));
1163
1164/*
1165 * REPLY_REM_STA = 0x19 (command)
1166 */
1167struct iwl_rem_sta_cmd {
1168 u8 num_sta; /* number of removed stations */
1169 u8 reserved[3];
1170 u8 addr[ETH_ALEN]; /* MAC addr of the first station */
1171 u8 reserved2[2];
1172} __attribute__ ((packed));
1173
Emmanuel Grumbach0a0bed12008-04-14 21:16:05 -07001174/*
1175 * REPLY_WEP_KEY = 0x20
1176 */
1177struct iwl_wep_key {
1178 u8 key_index;
1179 u8 key_offset;
1180 u8 reserved1[2];
1181 u8 key_size;
1182 u8 reserved2[3];
1183 u8 key[16];
1184} __attribute__ ((packed));
1185
1186struct iwl_wep_cmd {
1187 u8 num_keys;
1188 u8 global_key_type;
1189 u8 flags;
1190 u8 reserved;
1191 struct iwl_wep_key key[0];
1192} __attribute__ ((packed));
1193
1194#define WEP_KEY_WEP_TYPE 1
1195#define WEP_KEYS_MAX 4
1196#define WEP_INVALID_OFFSET 0xff
Emmanuel Grumbach4564ce82008-06-12 09:47:09 +08001197#define WEP_KEY_LEN_64 5
Emmanuel Grumbach0a0bed12008-04-14 21:16:05 -07001198#define WEP_KEY_LEN_128 13
Zhu Yib481de92007-09-25 17:54:57 -07001199
1200/******************************************************************************
1201 * (4)
1202 * Rx Responses:
1203 *
1204 *****************************************************************************/
1205
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001206#define RX_RES_STATUS_NO_CRC32_ERROR cpu_to_le32(1 << 0)
1207#define RX_RES_STATUS_NO_RXE_OVERFLOW cpu_to_le32(1 << 1)
Zhu Yib481de92007-09-25 17:54:57 -07001208
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001209#define RX_RES_PHY_FLAGS_BAND_24_MSK cpu_to_le16(1 << 0)
1210#define RX_RES_PHY_FLAGS_MOD_CCK_MSK cpu_to_le16(1 << 1)
1211#define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK cpu_to_le16(1 << 2)
1212#define RX_RES_PHY_FLAGS_NARROW_BAND_MSK cpu_to_le16(1 << 3)
Reinette Chatre9024adf2009-10-02 13:43:57 -07001213#define RX_RES_PHY_FLAGS_ANTENNA_MSK 0xf0
Daniel C Halperin9f30e042009-08-13 13:30:56 -07001214#define RX_RES_PHY_FLAGS_ANTENNA_POS 4
Zhu Yib481de92007-09-25 17:54:57 -07001215
Tomas Winkler8211ef72008-03-02 01:36:04 +02001216#define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)
1217#define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)
1218#define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)
1219#define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)
1220#define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)
Emmanuel Grumbach17e476b2008-03-19 16:41:42 -07001221#define RX_RES_STATUS_SEC_TYPE_ERR (0x7 << 8)
1222
1223#define RX_RES_STATUS_STATION_FOUND (1<<6)
1224#define RX_RES_STATUS_NO_STATION_INFO_MISMATCH (1<<7)
Zhu Yib481de92007-09-25 17:54:57 -07001225
Tomas Winkler8211ef72008-03-02 01:36:04 +02001226#define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)
1227#define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)
1228#define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)
1229#define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)
1230#define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)
Zhu Yib481de92007-09-25 17:54:57 -07001231
Emmanuel Grumbach17e476b2008-03-19 16:41:42 -07001232#define RX_MPDU_RES_STATUS_ICV_OK (0x20)
1233#define RX_MPDU_RES_STATUS_MIC_OK (0x40)
1234#define RX_MPDU_RES_STATUS_TTAK_OK (1 << 7)
1235#define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800)
1236
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08001237
1238struct iwl3945_rx_frame_stats {
1239 u8 phy_count;
1240 u8 id;
1241 u8 rssi;
1242 u8 agc;
1243 __le16 sig_avg;
1244 __le16 noise_diff;
1245 u8 payload[0];
1246} __attribute__ ((packed));
1247
1248struct iwl3945_rx_frame_hdr {
1249 __le16 channel;
1250 __le16 phy_flags;
1251 u8 reserved1;
1252 u8 rate;
1253 __le16 len;
1254 u8 payload[0];
1255} __attribute__ ((packed));
1256
1257struct iwl3945_rx_frame_end {
1258 __le32 status;
1259 __le64 timestamp;
1260 __le32 beacon_timestamp;
1261} __attribute__ ((packed));
1262
1263/*
1264 * REPLY_3945_RX = 0x1b (response only, not a command)
1265 *
1266 * NOTE: DO NOT dereference from casts to this structure
1267 * It is provided only for calculating minimum data set size.
1268 * The actual offsets of the hdr and end are dynamic based on
1269 * stats.phy_count
1270 */
1271struct iwl3945_rx_frame {
1272 struct iwl3945_rx_frame_stats stats;
1273 struct iwl3945_rx_frame_hdr hdr;
1274 struct iwl3945_rx_frame_end end;
1275} __attribute__ ((packed));
1276
1277#define IWL39_RX_FRAME_SIZE (4 + sizeof(struct iwl3945_rx_frame))
1278
Zhu Yib481de92007-09-25 17:54:57 -07001279/* Fixed (non-configurable) rx data from phy */
Tomas Winklercaab8f12008-08-04 16:00:42 +08001280
1281#define IWL49_RX_RES_PHY_CNT 14
1282#define IWL49_RX_PHY_FLAGS_ANTENNAE_OFFSET (4)
1283#define IWL49_RX_PHY_FLAGS_ANTENNAE_MASK (0x70)
1284#define IWL49_AGC_DB_MASK (0x3f80) /* MASK(7,13) */
1285#define IWL49_AGC_DB_POS (7)
Zhu Yib481de92007-09-25 17:54:57 -07001286struct iwl4965_rx_non_cfg_phy {
1287 __le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */
1288 __le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */
1289 u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */
1290 u8 pad[0];
1291} __attribute__ ((packed));
1292
Tomas Winklercaab8f12008-08-04 16:00:42 +08001293
1294#define IWL50_RX_RES_PHY_CNT 8
1295#define IWL50_RX_RES_AGC_IDX 1
1296#define IWL50_RX_RES_RSSI_AB_IDX 2
1297#define IWL50_RX_RES_RSSI_C_IDX 3
1298#define IWL50_OFDM_AGC_MSK 0xfe00
1299#define IWL50_OFDM_AGC_BIT_POS 9
1300#define IWL50_OFDM_RSSI_A_MSK 0x00ff
1301#define IWL50_OFDM_RSSI_A_BIT_POS 0
1302#define IWL50_OFDM_RSSI_B_MSK 0xff0000
1303#define IWL50_OFDM_RSSI_B_BIT_POS 16
1304#define IWL50_OFDM_RSSI_C_MSK 0x00ff
1305#define IWL50_OFDM_RSSI_C_BIT_POS 0
1306
1307struct iwl5000_non_cfg_phy {
Tomas Winklera96a27f2008-10-23 23:48:56 -07001308 __le32 non_cfg_phy[IWL50_RX_RES_PHY_CNT]; /* up to 8 phy entries */
Tomas Winklercaab8f12008-08-04 16:00:42 +08001309} __attribute__ ((packed));
1310
1311
Zhu Yib481de92007-09-25 17:54:57 -07001312/*
Tomas Winkler857485c2008-03-21 13:53:44 -07001313 * REPLY_RX = 0xc3 (response only, not a command)
Zhu Yib481de92007-09-25 17:54:57 -07001314 * Used only for legacy (non 11n) frames.
1315 */
Tomas Winklercaab8f12008-08-04 16:00:42 +08001316struct iwl_rx_phy_res {
Zhu Yib481de92007-09-25 17:54:57 -07001317 u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */
1318 u8 cfg_phy_cnt; /* configurable DSP phy data byte count */
1319 u8 stat_id; /* configurable DSP phy data set ID */
1320 u8 reserved1;
1321 __le64 timestamp; /* TSF at on air rise */
1322 __le32 beacon_time_stamp; /* beacon at on-air rise */
1323 __le16 phy_flags; /* general phy flags: band, modulation, ... */
1324 __le16 channel; /* channel number */
Tomas Winklercaab8f12008-08-04 16:00:42 +08001325 u8 non_cfg_phy_buf[32]; /* for various implementations of non_cfg_phy */
Ben Cahill52969982007-11-29 11:10:11 +08001326 __le32 rate_n_flags; /* RATE_MCS_* */
1327 __le16 byte_count; /* frame's byte-count */
Zhu Yib481de92007-09-25 17:54:57 -07001328 __le16 reserved3;
1329} __attribute__ ((packed));
1330
1331struct iwl4965_rx_mpdu_res_start {
1332 __le16 byte_count;
1333 __le16 reserved;
1334} __attribute__ ((packed));
1335
1336
1337/******************************************************************************
1338 * (5)
1339 * Tx Commands & Responses:
1340 *
Ben Cahill52969982007-11-29 11:10:11 +08001341 * Driver must place each REPLY_TX command into one of the prioritized Tx
1342 * queues in host DRAM, shared between driver and device (see comments for
1343 * SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode
1344 * are preparing to transmit, the device pulls the Tx command over the PCI
1345 * bus via one of the device's Tx DMA channels, to fill an internal FIFO
1346 * from which data will be transmitted.
1347 *
1348 * uCode handles all timing and protocol related to control frames
1349 * (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler
1350 * handle reception of block-acks; uCode updates the host driver via
1351 * REPLY_COMPRESSED_BA (4965).
1352 *
1353 * uCode handles retrying Tx when an ACK is expected but not received.
1354 * This includes trying lower data rates than the one requested in the Tx
1355 * command, as set up by the REPLY_RATE_SCALE (for 3945) or
1356 * REPLY_TX_LINK_QUALITY_CMD (4965).
1357 *
1358 * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
1359 * This command must be executed after every RXON command, before Tx can occur.
Zhu Yib481de92007-09-25 17:54:57 -07001360 *****************************************************************************/
1361
Ben Cahill52969982007-11-29 11:10:11 +08001362/* REPLY_TX Tx flags field */
1363
Tomas Winklera96a27f2008-10-23 23:48:56 -07001364/* 1: Use RTS/CTS protocol or CTS-to-self if spec allows it
Emmanuel Grumbacha326a5d2008-07-11 11:53:31 +08001365 * before this frame. if CTS-to-self required check
1366 * RXON_FLG_SELF_CTS_EN status. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001367#define TX_CMD_FLG_RTS_CTS_MSK cpu_to_le32(1 << 0)
Emmanuel Grumbacha326a5d2008-07-11 11:53:31 +08001368
Ben Cahill52969982007-11-29 11:10:11 +08001369/* 1: Use Request-To-Send protocol before this frame.
1370 * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001371#define TX_CMD_FLG_RTS_MSK cpu_to_le32(1 << 1)
Ben Cahill52969982007-11-29 11:10:11 +08001372
1373/* 1: Transmit Clear-To-Send to self before this frame.
1374 * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
1375 * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001376#define TX_CMD_FLG_CTS_MSK cpu_to_le32(1 << 2)
Ben Cahill52969982007-11-29 11:10:11 +08001377
1378/* 1: Expect ACK from receiving station
1379 * 0: Don't expect ACK (MAC header's duration field s/b 0)
1380 * Set this for unicast frames, but not broadcast/multicast. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001381#define TX_CMD_FLG_ACK_MSK cpu_to_le32(1 << 3)
Ben Cahill52969982007-11-29 11:10:11 +08001382
1383/* For 4965:
1384 * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
1385 * Tx command's initial_rate_index indicates first rate to try;
1386 * uCode walks through table for additional Tx attempts.
1387 * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
1388 * This rate will be used for all Tx attempts; it will not be scaled. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001389#define TX_CMD_FLG_STA_RATE_MSK cpu_to_le32(1 << 4)
Ben Cahill52969982007-11-29 11:10:11 +08001390
1391/* 1: Expect immediate block-ack.
1392 * Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001393#define TX_CMD_FLG_IMM_BA_RSP_MASK cpu_to_le32(1 << 6)
Ben Cahill52969982007-11-29 11:10:11 +08001394
1395/* 1: Frame requires full Tx-Op protection.
1396 * Set this if either RTS or CTS Tx Flag gets set. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001397#define TX_CMD_FLG_FULL_TXOP_PROT_MSK cpu_to_le32(1 << 7)
Ben Cahill52969982007-11-29 11:10:11 +08001398
1399/* Tx antenna selection field; used only for 3945, reserved (0) for 4965.
1400 * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001401#define TX_CMD_FLG_ANT_SEL_MSK cpu_to_le32(0xf00)
1402#define TX_CMD_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
1403#define TX_CMD_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
Zhu Yib481de92007-09-25 17:54:57 -07001404
Ben Cahill52969982007-11-29 11:10:11 +08001405/* 1: Ignore Bluetooth priority for this frame.
1406 * 0: Delay Tx until Bluetooth device is done (normal usage). */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001407#define TX_CMD_FLG_BT_DIS_MSK cpu_to_le32(1 << 12)
Zhu Yib481de92007-09-25 17:54:57 -07001408
Ben Cahill52969982007-11-29 11:10:11 +08001409/* 1: uCode overrides sequence control field in MAC header.
1410 * 0: Driver provides sequence control field in MAC header.
1411 * Set this for management frames, non-QOS data frames, non-unicast frames,
1412 * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001413#define TX_CMD_FLG_SEQ_CTL_MSK cpu_to_le32(1 << 13)
Zhu Yib481de92007-09-25 17:54:57 -07001414
Ben Cahill52969982007-11-29 11:10:11 +08001415/* 1: This frame is non-last MPDU; more fragments are coming.
1416 * 0: Last fragment, or not using fragmentation. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001417#define TX_CMD_FLG_MORE_FRAG_MSK cpu_to_le32(1 << 14)
Zhu Yib481de92007-09-25 17:54:57 -07001418
Ben Cahill52969982007-11-29 11:10:11 +08001419/* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
1420 * 0: No TSF required in outgoing frame.
1421 * Set this for transmitting beacons and probe responses. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001422#define TX_CMD_FLG_TSF_MSK cpu_to_le32(1 << 16)
Zhu Yib481de92007-09-25 17:54:57 -07001423
Ben Cahill52969982007-11-29 11:10:11 +08001424/* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
1425 * alignment of frame's payload data field.
1426 * 0: No pad
1427 * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
1428 * field (but not both). Driver must align frame data (i.e. data following
1429 * MAC header) to DWORD boundary. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001430#define TX_CMD_FLG_MH_PAD_MSK cpu_to_le32(1 << 20)
Zhu Yib481de92007-09-25 17:54:57 -07001431
Max Stepanov8236e182008-03-12 16:58:48 -07001432/* accelerate aggregation support
1433 * 0 - no CCMP encryption; 1 - CCMP encryption */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001434#define TX_CMD_FLG_AGG_CCMP_MSK cpu_to_le32(1 << 22)
Max Stepanov8236e182008-03-12 16:58:48 -07001435
Zhu Yib481de92007-09-25 17:54:57 -07001436/* HCCA-AP - disable duration overwriting. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001437#define TX_CMD_FLG_DUR_MSK cpu_to_le32(1 << 25)
Zhu Yib481de92007-09-25 17:54:57 -07001438
Ben Cahill52969982007-11-29 11:10:11 +08001439
Zhu Yib481de92007-09-25 17:54:57 -07001440/*
1441 * TX command security control
1442 */
1443#define TX_CMD_SEC_WEP 0x01
1444#define TX_CMD_SEC_CCM 0x02
1445#define TX_CMD_SEC_TKIP 0x03
1446#define TX_CMD_SEC_MSK 0x03
1447#define TX_CMD_SEC_SHIFT 6
1448#define TX_CMD_SEC_KEY128 0x08
1449
1450/*
Tomas Winkler3195cdb2008-04-23 17:15:00 -07001451 * security overhead sizes
1452 */
1453#define WEP_IV_LEN 4
1454#define WEP_ICV_LEN 4
1455#define CCMP_MIC_LEN 8
1456#define TKIP_ICV_LEN 4
1457
1458/*
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08001459 * REPLY_TX = 0x1c (command)
1460 */
1461
1462struct iwl3945_tx_cmd {
1463 /*
1464 * MPDU byte count:
1465 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
1466 * + 8 byte IV for CCM or TKIP (not used for WEP)
1467 * + Data payload
1468 * + 8-byte MIC (not used for CCM/WEP)
1469 * NOTE: Does not include Tx command bytes, post-MAC pad bytes,
1470 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
1471 * Range: 14-2342 bytes.
1472 */
1473 __le16 len;
1474
1475 /*
1476 * MPDU or MSDU byte count for next frame.
1477 * Used for fragmentation and bursting, but not 11n aggregation.
1478 * Same as "len", but for next frame. Set to 0 if not applicable.
1479 */
1480 __le16 next_frame_len;
1481
1482 __le32 tx_flags; /* TX_CMD_FLG_* */
1483
1484 u8 rate;
1485
1486 /* Index of recipient station in uCode's station table */
1487 u8 sta_id;
1488 u8 tid_tspec;
1489 u8 sec_ctl;
1490 u8 key[16];
1491 union {
1492 u8 byte[8];
1493 __le16 word[4];
1494 __le32 dw[2];
1495 } tkip_mic;
1496 __le32 next_frame_info;
1497 union {
1498 __le32 life_time;
1499 __le32 attempt;
1500 } stop_time;
1501 u8 supp_rates[2];
1502 u8 rts_retry_limit; /*byte 50 */
1503 u8 data_retry_limit; /*byte 51 */
1504 union {
1505 __le16 pm_frame_timeout;
1506 __le16 attempt_duration;
1507 } timeout;
1508
1509 /*
1510 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
1511 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
1512 */
1513 __le16 driver_txop;
1514
1515 /*
1516 * MAC header goes here, followed by 2 bytes padding if MAC header
1517 * length is 26 or 30 bytes, followed by payload data
1518 */
1519 u8 payload[0];
1520 struct ieee80211_hdr hdr[0];
1521} __attribute__ ((packed));
1522
1523/*
1524 * REPLY_TX = 0x1c (response)
1525 */
1526struct iwl3945_tx_resp {
1527 u8 failure_rts;
1528 u8 failure_frame;
1529 u8 bt_kill_count;
1530 u8 rate;
1531 __le32 wireless_media_time;
1532 __le32 status; /* TX status */
1533} __attribute__ ((packed));
1534
1535
1536/*
Ben Cahill52969982007-11-29 11:10:11 +08001537 * 4965 uCode updates these Tx attempt count values in host DRAM.
1538 * Used for managing Tx retries when expecting block-acks.
1539 * Driver should set these fields to 0.
Zhu Yib481de92007-09-25 17:54:57 -07001540 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08001541struct iwl_dram_scratch {
Ben Cahill52969982007-11-29 11:10:11 +08001542 u8 try_cnt; /* Tx attempts */
1543 u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */
Zhu Yib481de92007-09-25 17:54:57 -07001544 __le16 reserved;
1545} __attribute__ ((packed));
1546
Tomas Winkler83d527d2008-05-15 13:54:05 +08001547struct iwl_tx_cmd {
Ben Cahill52969982007-11-29 11:10:11 +08001548 /*
1549 * MPDU byte count:
1550 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
1551 * + 8 byte IV for CCM or TKIP (not used for WEP)
1552 * + Data payload
1553 * + 8-byte MIC (not used for CCM/WEP)
1554 * NOTE: Does not include Tx command bytes, post-MAC pad bytes,
1555 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
1556 * Range: 14-2342 bytes.
1557 */
Zhu Yib481de92007-09-25 17:54:57 -07001558 __le16 len;
Ben Cahill52969982007-11-29 11:10:11 +08001559
1560 /*
1561 * MPDU or MSDU byte count for next frame.
1562 * Used for fragmentation and bursting, but not 11n aggregation.
1563 * Same as "len", but for next frame. Set to 0 if not applicable.
1564 */
Zhu Yib481de92007-09-25 17:54:57 -07001565 __le16 next_frame_len;
Ben Cahill52969982007-11-29 11:10:11 +08001566
1567 __le32 tx_flags; /* TX_CMD_FLG_* */
1568
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08001569 /* uCode may modify this field of the Tx command (in host DRAM!).
Ben Cahill52969982007-11-29 11:10:11 +08001570 * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08001571 struct iwl_dram_scratch scratch;
Ben Cahill52969982007-11-29 11:10:11 +08001572
1573 /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
1574 __le32 rate_n_flags; /* RATE_MCS_* */
1575
1576 /* Index of destination station in uCode's station table */
Zhu Yib481de92007-09-25 17:54:57 -07001577 u8 sta_id;
Ben Cahill52969982007-11-29 11:10:11 +08001578
1579 /* Type of security encryption: CCM or TKIP */
1580 u8 sec_ctl; /* TX_CMD_SEC_* */
1581
1582 /*
1583 * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial
1584 * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for
1585 * data frames, this field may be used to selectively reduce initial
1586 * rate (via non-0 value) for special frames (e.g. management), while
1587 * still supporting rate scaling for all frames.
1588 */
Zhu Yib481de92007-09-25 17:54:57 -07001589 u8 initial_rate_index;
1590 u8 reserved;
Zhu Yib481de92007-09-25 17:54:57 -07001591 u8 key[16];
Zhu Yib481de92007-09-25 17:54:57 -07001592 __le16 next_frame_flags;
1593 __le16 reserved2;
Zhu Yib481de92007-09-25 17:54:57 -07001594 union {
1595 __le32 life_time;
1596 __le32 attempt;
1597 } stop_time;
Ben Cahill52969982007-11-29 11:10:11 +08001598
1599 /* Host DRAM physical address pointer to "scratch" in this command.
1600 * Must be dword aligned. "0" in dram_lsb_ptr disables usage. */
Zhu Yib481de92007-09-25 17:54:57 -07001601 __le32 dram_lsb_ptr;
1602 u8 dram_msb_ptr;
Ben Cahill52969982007-11-29 11:10:11 +08001603
Zhu Yib481de92007-09-25 17:54:57 -07001604 u8 rts_retry_limit; /*byte 50 */
1605 u8 data_retry_limit; /*byte 51 */
Zhu Yib481de92007-09-25 17:54:57 -07001606 u8 tid_tspec;
Zhu Yib481de92007-09-25 17:54:57 -07001607 union {
1608 __le16 pm_frame_timeout;
1609 __le16 attempt_duration;
1610 } timeout;
Ben Cahill52969982007-11-29 11:10:11 +08001611
1612 /*
1613 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
1614 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
1615 */
Zhu Yib481de92007-09-25 17:54:57 -07001616 __le16 driver_txop;
Ben Cahill52969982007-11-29 11:10:11 +08001617
1618 /*
1619 * MAC header goes here, followed by 2 bytes padding if MAC header
1620 * length is 26 or 30 bytes, followed by payload data
1621 */
Zhu Yib481de92007-09-25 17:54:57 -07001622 u8 payload[0];
1623 struct ieee80211_hdr hdr[0];
1624} __attribute__ ((packed));
1625
1626/* TX command response is sent after *all* transmission attempts.
1627 *
1628 * NOTES:
1629 *
1630 * TX_STATUS_FAIL_NEXT_FRAG
1631 *
1632 * If the fragment flag in the MAC header for the frame being transmitted
1633 * is set and there is insufficient time to transmit the next frame, the
1634 * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
1635 *
1636 * TX_STATUS_FIFO_UNDERRUN
1637 *
1638 * Indicates the host did not provide bytes to the FIFO fast enough while
1639 * a TX was in progress.
1640 *
1641 * TX_STATUS_FAIL_MGMNT_ABORT
1642 *
1643 * This status is only possible if the ABORT ON MGMT RX parameter was
1644 * set to true with the TX command.
1645 *
1646 * If the MSB of the status parameter is set then an abort sequence is
1647 * required. This sequence consists of the host activating the TX Abort
1648 * control line, and then waiting for the TX Abort command response. This
1649 * indicates that a the device is no longer in a transmit state, and that the
1650 * command FIFO has been cleared. The host must then deactivate the TX Abort
1651 * control line. Receiving is still allowed in this case.
1652 */
1653enum {
1654 TX_STATUS_SUCCESS = 0x01,
1655 TX_STATUS_DIRECT_DONE = 0x02,
1656 TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
1657 TX_STATUS_FAIL_LONG_LIMIT = 0x83,
1658 TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
1659 TX_STATUS_FAIL_MGMNT_ABORT = 0x85,
1660 TX_STATUS_FAIL_NEXT_FRAG = 0x86,
1661 TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
1662 TX_STATUS_FAIL_DEST_PS = 0x88,
1663 TX_STATUS_FAIL_ABORTED = 0x89,
1664 TX_STATUS_FAIL_BT_RETRY = 0x8a,
1665 TX_STATUS_FAIL_STA_INVALID = 0x8b,
1666 TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
1667 TX_STATUS_FAIL_TID_DISABLE = 0x8d,
1668 TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
1669 TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
1670 TX_STATUS_FAIL_TX_LOCKED = 0x90,
1671 TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
1672};
1673
1674#define TX_PACKET_MODE_REGULAR 0x0000
1675#define TX_PACKET_MODE_BURST_SEQ 0x0100
1676#define TX_PACKET_MODE_BURST_FIRST 0x0200
1677
1678enum {
1679 TX_POWER_PA_NOT_ACTIVE = 0x0,
1680};
1681
1682enum {
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001683 TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */
Zhu Yib481de92007-09-25 17:54:57 -07001684 TX_STATUS_DELAY_MSK = 0x00000040,
1685 TX_STATUS_ABORT_MSK = 0x00000080,
1686 TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */
1687 TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001688 TX_RESERVED = 0x00780000, /* bits 19:22 */
Zhu Yib481de92007-09-25 17:54:57 -07001689 TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */
1690 TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */
1691};
1692
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001693static inline bool iwl_is_tx_success(u32 status)
Tomas Winklera332f8d2008-05-29 16:35:08 +08001694{
1695 status &= TX_STATUS_MSK;
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001696 return (status == TX_STATUS_SUCCESS) ||
1697 (status == TX_STATUS_DIRECT_DONE);
Tomas Winklera332f8d2008-05-29 16:35:08 +08001698}
1699
1700
1701
Zhu Yib481de92007-09-25 17:54:57 -07001702/* *******************************
Ben Cahill52969982007-11-29 11:10:11 +08001703 * TX aggregation status
Zhu Yib481de92007-09-25 17:54:57 -07001704 ******************************* */
1705
1706enum {
1707 AGG_TX_STATE_TRANSMITTED = 0x00,
1708 AGG_TX_STATE_UNDERRUN_MSK = 0x01,
1709 AGG_TX_STATE_BT_PRIO_MSK = 0x02,
1710 AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
1711 AGG_TX_STATE_ABORT_MSK = 0x08,
1712 AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
1713 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
1714 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
1715 AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
1716 AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
1717 AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
1718 AGG_TX_STATE_DUMP_TX_MSK = 0x200,
1719 AGG_TX_STATE_DELAY_TX_MSK = 0x400
1720};
1721
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001722#define AGG_TX_STATE_LAST_SENT_MSK (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
1723 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
1724 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
Zhu Yib481de92007-09-25 17:54:57 -07001725
Ben Cahill52969982007-11-29 11:10:11 +08001726/* # tx attempts for first frame in aggregation */
Zhu Yib481de92007-09-25 17:54:57 -07001727#define AGG_TX_STATE_TRY_CNT_POS 12
1728#define AGG_TX_STATE_TRY_CNT_MSK 0xf000
1729
Ben Cahill52969982007-11-29 11:10:11 +08001730/* Command ID and sequence number of Tx command for this frame */
Zhu Yib481de92007-09-25 17:54:57 -07001731#define AGG_TX_STATE_SEQ_NUM_POS 16
1732#define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
1733
1734/*
1735 * REPLY_TX = 0x1c (response)
Ben Cahill52969982007-11-29 11:10:11 +08001736 *
1737 * This response may be in one of two slightly different formats, indicated
1738 * by the frame_count field:
1739 *
1740 * 1) No aggregation (frame_count == 1). This reports Tx results for
1741 * a single frame. Multiple attempts, at various bit rates, may have
1742 * been made for this frame.
1743 *
1744 * 2) Aggregation (frame_count > 1). This reports Tx results for
1745 * 2 or more frames that used block-acknowledge. All frames were
1746 * transmitted at same rate. Rate scaling may have been used if first
1747 * frame in this new agg block failed in previous agg block(s).
1748 *
1749 * Note that, for aggregation, ACK (block-ack) status is not delivered here;
1750 * block-ack has not been received by the time the 4965 records this status.
1751 * This status relates to reasons the tx might have been blocked or aborted
1752 * within the sending station (this 4965), rather than whether it was
1753 * received successfully by the destination station.
Zhu Yib481de92007-09-25 17:54:57 -07001754 */
Ron Rindjunsky001caff2008-05-29 16:35:07 +08001755struct agg_tx_status {
1756 __le16 status;
1757 __le16 sequence;
1758} __attribute__ ((packed));
1759
Christoph Hellwigbb8c0932008-01-27 16:41:47 -08001760struct iwl4965_tx_resp {
Zhu Yib481de92007-09-25 17:54:57 -07001761 u8 frame_count; /* 1 no aggregation, >1 aggregation */
Ben Cahill52969982007-11-29 11:10:11 +08001762 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
1763 u8 failure_rts; /* # failures due to unsuccessful RTS */
1764 u8 failure_frame; /* # failures due to no ACK (unused for agg) */
1765
1766 /* For non-agg: Rate at which frame was successful.
1767 * For agg: Rate at which all frames were transmitted. */
1768 __le32 rate_n_flags; /* RATE_MCS_* */
1769
1770 /* For non-agg: RTS + CTS + frame tx attempts time + ACK.
1771 * For agg: RTS + CTS + aggregation tx time + block-ack time. */
1772 __le16 wireless_media_time; /* uSecs */
1773
Zhu Yib481de92007-09-25 17:54:57 -07001774 __le16 reserved;
Ben Cahill52969982007-11-29 11:10:11 +08001775 __le32 pa_power1; /* RF power amplifier measurement (not used) */
Zhu Yib481de92007-09-25 17:54:57 -07001776 __le32 pa_power2;
Ben Cahill52969982007-11-29 11:10:11 +08001777
1778 /*
1779 * For non-agg: frame status TX_STATUS_*
1780 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1781 * fields follow this one, up to frame_count.
1782 * Bit fields:
1783 * 11- 0: AGG_TX_STATE_* status code
1784 * 15-12: Retry count for 1st frame in aggregation (retries
1785 * occur if tx failed for this frame when it was a
1786 * member of a previous aggregation block). If rate
1787 * scaling is used, retry count indicates the rate
1788 * table entry used for all frames in the new agg.
1789 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1790 */
Tomas Winkler25a65722008-06-12 09:47:07 +08001791 union {
1792 __le32 status;
1793 struct agg_tx_status agg_status[0]; /* for each agg frame */
1794 } u;
Ron Rindjunskyfe01b472008-01-28 14:07:24 +02001795} __attribute__ ((packed));
1796
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001797/*
1798 * definitions for initial rate index field
Tomas Winklera96a27f2008-10-23 23:48:56 -07001799 * bits [3:0] initial rate index
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001800 * bits [6:4] rate table color, used for the initial rate
1801 * bit-7 invalid rate indication
1802 * i.e. rate was not chosen from rate table
1803 * or rate table color was changed during frame retries
1804 * refer tlc rate info
1805 */
1806
1807#define IWL50_TX_RES_INIT_RATE_INDEX_POS 0
1808#define IWL50_TX_RES_INIT_RATE_INDEX_MSK 0x0f
1809#define IWL50_TX_RES_RATE_TABLE_COLOR_POS 4
1810#define IWL50_TX_RES_RATE_TABLE_COLOR_MSK 0x70
1811#define IWL50_TX_RES_INV_RATE_INDEX_MSK 0x80
1812
1813/* refer to ra_tid */
1814#define IWL50_TX_RES_TID_POS 0
1815#define IWL50_TX_RES_TID_MSK 0x0f
1816#define IWL50_TX_RES_RA_POS 4
1817#define IWL50_TX_RES_RA_MSK 0xf0
1818
Ron Rindjunsky001caff2008-05-29 16:35:07 +08001819struct iwl5000_tx_resp {
1820 u8 frame_count; /* 1 no aggregation, >1 aggregation */
1821 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
1822 u8 failure_rts; /* # failures due to unsuccessful RTS */
1823 u8 failure_frame; /* # failures due to no ACK (unused for agg) */
1824
1825 /* For non-agg: Rate at which frame was successful.
1826 * For agg: Rate at which all frames were transmitted. */
1827 __le32 rate_n_flags; /* RATE_MCS_* */
1828
1829 /* For non-agg: RTS + CTS + frame tx attempts time + ACK.
1830 * For agg: RTS + CTS + aggregation tx time + block-ack time. */
1831 __le16 wireless_media_time; /* uSecs */
1832
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001833 u8 pa_status; /* RF power amplifier measurement (not used) */
1834 u8 pa_integ_res_a[3];
1835 u8 pa_integ_res_b[3];
1836 u8 pa_integ_res_C[3];
Ron Rindjunsky001caff2008-05-29 16:35:07 +08001837
1838 __le32 tfd_info;
1839 __le16 seq_ctl;
1840 __le16 byte_cnt;
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001841 u8 tlc_info;
1842 u8 ra_tid; /* tid (0:3), sta_id (4:7) */
1843 __le16 frame_ctrl;
Ron Rindjunsky001caff2008-05-29 16:35:07 +08001844 /*
1845 * For non-agg: frame status TX_STATUS_*
1846 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1847 * fields follow this one, up to frame_count.
1848 * Bit fields:
1849 * 11- 0: AGG_TX_STATE_* status code
1850 * 15-12: Retry count for 1st frame in aggregation (retries
1851 * occur if tx failed for this frame when it was a
1852 * member of a previous aggregation block). If rate
1853 * scaling is used, retry count indicates the rate
1854 * table entry used for all frames in the new agg.
1855 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1856 */
1857 struct agg_tx_status status; /* TX status (in aggregation -
1858 * status of 1st frame) */
1859} __attribute__ ((packed));
Zhu Yib481de92007-09-25 17:54:57 -07001860/*
1861 * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
Ben Cahill52969982007-11-29 11:10:11 +08001862 *
1863 * Reports Block-Acknowledge from recipient station
Zhu Yib481de92007-09-25 17:54:57 -07001864 */
Emmanuel Grumbach653fa4a2008-06-30 17:23:11 +08001865struct iwl_compressed_ba_resp {
Zhu Yib481de92007-09-25 17:54:57 -07001866 __le32 sta_addr_lo32;
1867 __le16 sta_addr_hi16;
1868 __le16 reserved;
Ben Cahill52969982007-11-29 11:10:11 +08001869
1870 /* Index of recipient (BA-sending) station in uCode's station table */
Zhu Yib481de92007-09-25 17:54:57 -07001871 u8 sta_id;
1872 u8 tid;
Ron Rindjunskyfe01b472008-01-28 14:07:24 +02001873 __le16 seq_ctl;
1874 __le64 bitmap;
Zhu Yib481de92007-09-25 17:54:57 -07001875 __le16 scd_flow;
1876 __le16 scd_ssn;
1877} __attribute__ ((packed));
1878
1879/*
1880 * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
Ben Cahill2bdc7032007-11-29 11:10:12 +08001881 *
1882 * See details under "TXPOWER" in iwl-4965-hw.h.
Zhu Yib481de92007-09-25 17:54:57 -07001883 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08001884
1885struct iwl3945_txpowertable_cmd {
1886 u8 band; /* 0: 5 GHz, 1: 2.4 GHz */
1887 u8 reserved;
1888 __le16 channel;
1889 struct iwl3945_power_per_rate power[IWL_MAX_RATES];
1890} __attribute__ ((packed));
1891
Christoph Hellwigbb8c0932008-01-27 16:41:47 -08001892struct iwl4965_txpowertable_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07001893 u8 band; /* 0: 5 GHz, 1: 2.4 GHz */
1894 u8 reserved;
1895 __le16 channel;
Christoph Hellwigbb8c0932008-01-27 16:41:47 -08001896 struct iwl4965_tx_power_db tx_power;
Zhu Yib481de92007-09-25 17:54:57 -07001897} __attribute__ ((packed));
1898
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08001899
1900/**
1901 * struct iwl3945_rate_scaling_cmd - Rate Scaling Command & Response
1902 *
1903 * REPLY_RATE_SCALE = 0x47 (command, has simple generic response)
1904 *
1905 * NOTE: The table of rates passed to the uCode via the
1906 * RATE_SCALE command sets up the corresponding order of
1907 * rates used for all related commands, including rate
1908 * masks, etc.
1909 *
1910 * For example, if you set 9MB (PLCP 0x0f) as the first
1911 * rate in the rate table, the bit mask for that rate
1912 * when passed through ofdm_basic_rates on the REPLY_RXON
1913 * command would be bit 0 (1 << 0)
1914 */
1915struct iwl3945_rate_scaling_info {
1916 __le16 rate_n_flags;
1917 u8 try_cnt;
1918 u8 next_rate_index;
1919} __attribute__ ((packed));
1920
1921struct iwl3945_rate_scaling_cmd {
1922 u8 table_id;
1923 u8 reserved[3];
1924 struct iwl3945_rate_scaling_info table[IWL_MAX_RATES];
1925} __attribute__ ((packed));
1926
1927
Zhu Yib481de92007-09-25 17:54:57 -07001928/*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
Reinette Chatre8a1b0242008-01-14 17:46:25 -08001929#define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0)
Zhu Yib481de92007-09-25 17:54:57 -07001930
Ben Cahill2bdc7032007-11-29 11:10:12 +08001931/* # of EDCA prioritized tx fifos */
Zhu Yib481de92007-09-25 17:54:57 -07001932#define LINK_QUAL_AC_NUM AC_NUM
Ben Cahill2bdc7032007-11-29 11:10:12 +08001933
1934/* # entries in rate scale table to support Tx retries */
Zhu Yib481de92007-09-25 17:54:57 -07001935#define LINK_QUAL_MAX_RETRY_NUM 16
1936
Ben Cahill2bdc7032007-11-29 11:10:12 +08001937/* Tx antenna selection values */
Reinette Chatre8a1b0242008-01-14 17:46:25 -08001938#define LINK_QUAL_ANT_A_MSK (1 << 0)
1939#define LINK_QUAL_ANT_B_MSK (1 << 1)
Zhu Yib481de92007-09-25 17:54:57 -07001940#define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
1941
Ben Cahill2bdc7032007-11-29 11:10:12 +08001942
1943/**
Tomas Winkler66c73db2008-04-15 16:01:40 -07001944 * struct iwl_link_qual_general_params
Ben Cahill2bdc7032007-11-29 11:10:12 +08001945 *
1946 * Used in REPLY_TX_LINK_QUALITY_CMD
1947 */
Tomas Winkler66c73db2008-04-15 16:01:40 -07001948struct iwl_link_qual_general_params {
Zhu Yib481de92007-09-25 17:54:57 -07001949 u8 flags;
Ben Cahill2bdc7032007-11-29 11:10:12 +08001950
1951 /* No entries at or above this (driver chosen) index contain MIMO */
Zhu Yib481de92007-09-25 17:54:57 -07001952 u8 mimo_delimiter;
Ben Cahill2bdc7032007-11-29 11:10:12 +08001953
1954 /* Best single antenna to use for single stream (legacy, SISO). */
1955 u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */
1956
1957 /* Best antennas to use for MIMO (unused for 4965, assumes both). */
1958 u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */
1959
1960 /*
1961 * If driver needs to use different initial rates for different
1962 * EDCA QOS access categories (as implemented by tx fifos 0-3),
1963 * this table will set that up, by indicating the indexes in the
1964 * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
1965 * Otherwise, driver should set all entries to 0.
1966 *
1967 * Entry usage:
1968 * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
1969 * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
1970 */
Zhu Yib481de92007-09-25 17:54:57 -07001971 u8 start_rate_index[LINK_QUAL_AC_NUM];
1972} __attribute__ ((packed));
1973
Wey-Yi Guy13c33a02009-06-03 11:44:11 -07001974#define LINK_QUAL_AGG_TIME_LIMIT_DEF (4000) /* 4 milliseconds */
1975#define LINK_QUAL_AGG_TIME_LIMIT_MAX (65535)
1976#define LINK_QUAL_AGG_TIME_LIMIT_MIN (0)
1977
1978#define LINK_QUAL_AGG_DISABLE_START_DEF (3)
1979#define LINK_QUAL_AGG_DISABLE_START_MAX (255)
1980#define LINK_QUAL_AGG_DISABLE_START_MIN (0)
1981
1982#define LINK_QUAL_AGG_FRAME_LIMIT_DEF (31)
Johannes Bergb623a9f2009-07-01 14:57:59 +02001983#define LINK_QUAL_AGG_FRAME_LIMIT_MAX (63)
Wey-Yi Guy13c33a02009-06-03 11:44:11 -07001984#define LINK_QUAL_AGG_FRAME_LIMIT_MIN (0)
1985
Ben Cahill2bdc7032007-11-29 11:10:12 +08001986/**
Tomas Winkler66c73db2008-04-15 16:01:40 -07001987 * struct iwl_link_qual_agg_params
Ben Cahill2bdc7032007-11-29 11:10:12 +08001988 *
1989 * Used in REPLY_TX_LINK_QUALITY_CMD
1990 */
Tomas Winkler66c73db2008-04-15 16:01:40 -07001991struct iwl_link_qual_agg_params {
Ben Cahill2bdc7032007-11-29 11:10:12 +08001992
1993 /* Maximum number of uSec in aggregation.
1994 * Driver should set this to 4000 (4 milliseconds). */
Zhu Yib481de92007-09-25 17:54:57 -07001995 __le16 agg_time_limit;
Ben Cahill2bdc7032007-11-29 11:10:12 +08001996
1997 /*
1998 * Number of Tx retries allowed for a frame, before that frame will
1999 * no longer be considered for the start of an aggregation sequence
2000 * (scheduler will then try to tx it as single frame).
2001 * Driver should set this to 3.
2002 */
Zhu Yib481de92007-09-25 17:54:57 -07002003 u8 agg_dis_start_th;
Ben Cahill2bdc7032007-11-29 11:10:12 +08002004
2005 /*
2006 * Maximum number of frames in aggregation.
2007 * 0 = no limit (default). 1 = no aggregation.
2008 * Other values = max # frames in aggregation.
2009 */
Zhu Yib481de92007-09-25 17:54:57 -07002010 u8 agg_frame_cnt_limit;
Ben Cahill2bdc7032007-11-29 11:10:12 +08002011
Zhu Yib481de92007-09-25 17:54:57 -07002012 __le32 reserved;
2013} __attribute__ ((packed));
2014
2015/*
2016 * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
Ben Cahill2bdc7032007-11-29 11:10:12 +08002017 *
2018 * For 4965 only; 3945 uses REPLY_RATE_SCALE.
2019 *
2020 * Each station in the 4965's internal station table has its own table of 16
2021 * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
2022 * an ACK is not received. This command replaces the entire table for
2023 * one station.
2024 *
2025 * NOTE: Station must already be in 4965's station table. Use REPLY_ADD_STA.
2026 *
2027 * The rate scaling procedures described below work well. Of course, other
2028 * procedures are possible, and may work better for particular environments.
2029 *
2030 *
2031 * FILLING THE RATE TABLE
2032 *
2033 * Given a particular initial rate and mode, as determined by the rate
2034 * scaling algorithm described below, the Linux driver uses the following
2035 * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
2036 * Link Quality command:
2037 *
2038 *
2039 * 1) If using High-throughput (HT) (SISO or MIMO) initial rate:
2040 * a) Use this same initial rate for first 3 entries.
2041 * b) Find next lower available rate using same mode (SISO or MIMO),
2042 * use for next 3 entries. If no lower rate available, switch to
Wey-Yi Guy7aafef12009-08-07 15:41:38 -07002043 * legacy mode (no HT40 channel, no MIMO, no short guard interval).
Ben Cahill2bdc7032007-11-29 11:10:12 +08002044 * c) If using MIMO, set command's mimo_delimiter to number of entries
2045 * using MIMO (3 or 6).
Wey-Yi Guy7aafef12009-08-07 15:41:38 -07002046 * d) After trying 2 HT rates, switch to legacy mode (no HT40 channel,
Ben Cahill2bdc7032007-11-29 11:10:12 +08002047 * no MIMO, no short guard interval), at the next lower bit rate
2048 * (e.g. if second HT bit rate was 54, try 48 legacy), and follow
2049 * legacy procedure for remaining table entries.
2050 *
2051 * 2) If using legacy initial rate:
2052 * a) Use the initial rate for only one entry.
2053 * b) For each following entry, reduce the rate to next lower available
2054 * rate, until reaching the lowest available rate.
2055 * c) When reducing rate, also switch antenna selection.
2056 * d) Once lowest available rate is reached, repeat this rate until
2057 * rate table is filled (16 entries), switching antenna each entry.
2058 *
2059 *
2060 * ACCUMULATING HISTORY
2061 *
2062 * The rate scaling algorithm for 4965, as implemented in Linux driver, uses
2063 * two sets of frame Tx success history: One for the current/active modulation
2064 * mode, and one for a speculative/search mode that is being attempted. If the
2065 * speculative mode turns out to be more effective (i.e. actual transfer
2066 * rate is better), then the driver continues to use the speculative mode
2067 * as the new current active mode.
2068 *
2069 * Each history set contains, separately for each possible rate, data for a
2070 * sliding window of the 62 most recent tx attempts at that rate. The data
2071 * includes a shifting bitmap of success(1)/failure(0), and sums of successful
2072 * and attempted frames, from which the driver can additionally calculate a
2073 * success ratio (success / attempted) and number of failures
2074 * (attempted - success), and control the size of the window (attempted).
2075 * The driver uses the bit map to remove successes from the success sum, as
2076 * the oldest tx attempts fall out of the window.
2077 *
2078 * When the 4965 makes multiple tx attempts for a given frame, each attempt
2079 * might be at a different rate, and have different modulation characteristics
2080 * (e.g. antenna, fat channel, short guard interval), as set up in the rate
2081 * scaling table in the Link Quality command. The driver must determine
2082 * which rate table entry was used for each tx attempt, to determine which
2083 * rate-specific history to update, and record only those attempts that
2084 * match the modulation characteristics of the history set.
2085 *
2086 * When using block-ack (aggregation), all frames are transmitted at the same
Tomas Winklera96a27f2008-10-23 23:48:56 -07002087 * rate, since there is no per-attempt acknowledgment from the destination
Ben Cahill2bdc7032007-11-29 11:10:12 +08002088 * station. The Tx response struct iwl_tx_resp indicates the Tx rate in
2089 * rate_n_flags field. After receiving a block-ack, the driver can update
2090 * history for the entire block all at once.
2091 *
2092 *
2093 * FINDING BEST STARTING RATE:
2094 *
2095 * When working with a selected initial modulation mode (see below), the
2096 * driver attempts to find a best initial rate. The initial rate is the
2097 * first entry in the Link Quality command's rate table.
2098 *
2099 * 1) Calculate actual throughput (success ratio * expected throughput, see
2100 * table below) for current initial rate. Do this only if enough frames
2101 * have been attempted to make the value meaningful: at least 6 failed
2102 * tx attempts, or at least 8 successes. If not enough, don't try rate
2103 * scaling yet.
2104 *
2105 * 2) Find available rates adjacent to current initial rate. Available means:
2106 * a) supported by hardware &&
2107 * b) supported by association &&
2108 * c) within any constraints selected by user
2109 *
2110 * 3) Gather measured throughputs for adjacent rates. These might not have
2111 * enough history to calculate a throughput. That's okay, we might try
2112 * using one of them anyway!
2113 *
2114 * 4) Try decreasing rate if, for current rate:
2115 * a) success ratio is < 15% ||
2116 * b) lower adjacent rate has better measured throughput ||
2117 * c) higher adjacent rate has worse throughput, and lower is unmeasured
2118 *
2119 * As a sanity check, if decrease was determined above, leave rate
2120 * unchanged if:
2121 * a) lower rate unavailable
2122 * b) success ratio at current rate > 85% (very good)
2123 * c) current measured throughput is better than expected throughput
2124 * of lower rate (under perfect 100% tx conditions, see table below)
2125 *
2126 * 5) Try increasing rate if, for current rate:
2127 * a) success ratio is < 15% ||
2128 * b) both adjacent rates' throughputs are unmeasured (try it!) ||
2129 * b) higher adjacent rate has better measured throughput ||
2130 * c) lower adjacent rate has worse throughput, and higher is unmeasured
2131 *
2132 * As a sanity check, if increase was determined above, leave rate
2133 * unchanged if:
2134 * a) success ratio at current rate < 70%. This is not particularly
2135 * good performance; higher rate is sure to have poorer success.
2136 *
2137 * 6) Re-evaluate the rate after each tx frame. If working with block-
2138 * acknowledge, history and statistics may be calculated for the entire
2139 * block (including prior history that fits within the history windows),
2140 * before re-evaluation.
2141 *
2142 * FINDING BEST STARTING MODULATION MODE:
2143 *
2144 * After working with a modulation mode for a "while" (and doing rate scaling),
2145 * the driver searches for a new initial mode in an attempt to improve
2146 * throughput. The "while" is measured by numbers of attempted frames:
2147 *
2148 * For legacy mode, search for new mode after:
2149 * 480 successful frames, or 160 failed frames
2150 * For high-throughput modes (SISO or MIMO), search for new mode after:
2151 * 4500 successful frames, or 400 failed frames
2152 *
2153 * Mode switch possibilities are (3 for each mode):
2154 *
2155 * For legacy:
2156 * Change antenna, try SISO (if HT association), try MIMO (if HT association)
2157 * For SISO:
2158 * Change antenna, try MIMO, try shortened guard interval (SGI)
2159 * For MIMO:
2160 * Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)
2161 *
2162 * When trying a new mode, use the same bit rate as the old/current mode when
2163 * trying antenna switches and shortened guard interval. When switching to
2164 * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate
2165 * for which the expected throughput (under perfect conditions) is about the
2166 * same or slightly better than the actual measured throughput delivered by
2167 * the old/current mode.
2168 *
2169 * Actual throughput can be estimated by multiplying the expected throughput
2170 * by the success ratio (successful / attempted tx frames). Frame size is
2171 * not considered in this calculation; it assumes that frame size will average
2172 * out to be fairly consistent over several samples. The following are
2173 * metric values for expected throughput assuming 100% success ratio.
2174 * Only G band has support for CCK rates:
2175 *
2176 * RATE: 1 2 5 11 6 9 12 18 24 36 48 54 60
2177 *
2178 * G: 7 13 35 58 40 57 72 98 121 154 177 186 186
2179 * A: 0 0 0 0 40 57 72 98 121 154 177 186 186
2180 * SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 202
2181 * SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 211
2182 * MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 251
2183 * SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 257
2184 * SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 257
2185 * SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 264
2186 * MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 289
2187 * SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 293
2188 *
2189 * After the new mode has been tried for a short while (minimum of 6 failed
2190 * frames or 8 successful frames), compare success ratio and actual throughput
2191 * estimate of the new mode with the old. If either is better with the new
2192 * mode, continue to use the new mode.
2193 *
2194 * Continue comparing modes until all 3 possibilities have been tried.
2195 * If moving from legacy to HT, try all 3 possibilities from the new HT
2196 * mode. After trying all 3, a best mode is found. Continue to use this mode
2197 * for the longer "while" described above (e.g. 480 successful frames for
2198 * legacy), and then repeat the search process.
2199 *
Zhu Yib481de92007-09-25 17:54:57 -07002200 */
Tomas Winkler66c73db2008-04-15 16:01:40 -07002201struct iwl_link_quality_cmd {
Ben Cahill2bdc7032007-11-29 11:10:12 +08002202
2203 /* Index of destination/recipient station in uCode's station table */
Zhu Yib481de92007-09-25 17:54:57 -07002204 u8 sta_id;
2205 u8 reserved1;
Ben Cahill2bdc7032007-11-29 11:10:12 +08002206 __le16 control; /* not used */
Tomas Winkler66c73db2008-04-15 16:01:40 -07002207 struct iwl_link_qual_general_params general_params;
2208 struct iwl_link_qual_agg_params agg_params;
Ben Cahill2bdc7032007-11-29 11:10:12 +08002209
2210 /*
2211 * Rate info; when using rate-scaling, Tx command's initial_rate_index
2212 * specifies 1st Tx rate attempted, via index into this table.
2213 * 4965 works its way through table when retrying Tx.
2214 */
Zhu Yib481de92007-09-25 17:54:57 -07002215 struct {
Ben Cahill2bdc7032007-11-29 11:10:12 +08002216 __le32 rate_n_flags; /* RATE_MCS_*, IWL_RATE_* */
Zhu Yib481de92007-09-25 17:54:57 -07002217 } rs_table[LINK_QUAL_MAX_RETRY_NUM];
2218 __le32 reserved2;
2219} __attribute__ ((packed));
Zhu Yib481de92007-09-25 17:54:57 -07002220
2221/*
2222 * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
Ben Cahill3058f022008-01-14 17:46:17 -08002223 *
2224 * 3945 and 4965 support hardware handshake with Bluetooth device on
2225 * same platform. Bluetooth device alerts wireless device when it will Tx;
Tomas Winklera96a27f2008-10-23 23:48:56 -07002226 * wireless device can delay or kill its own Tx to accommodate.
Zhu Yib481de92007-09-25 17:54:57 -07002227 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002228struct iwl_bt_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07002229 u8 flags;
2230 u8 lead_time;
2231 u8 max_kill;
2232 u8 reserved;
2233 __le32 kill_ack_mask;
2234 __le32 kill_cts_mask;
2235} __attribute__ ((packed));
2236
2237/******************************************************************************
2238 * (6)
2239 * Spectrum Management (802.11h) Commands, Responses, Notifications:
2240 *
2241 *****************************************************************************/
2242
2243/*
2244 * Spectrum Management
2245 */
2246#define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \
2247 RXON_FILTER_CTL2HOST_MSK | \
2248 RXON_FILTER_ACCEPT_GRP_MSK | \
2249 RXON_FILTER_DIS_DECRYPT_MSK | \
2250 RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
2251 RXON_FILTER_ASSOC_MSK | \
2252 RXON_FILTER_BCON_AWARE_MSK)
2253
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002254struct iwl_measure_channel {
Zhu Yib481de92007-09-25 17:54:57 -07002255 __le32 duration; /* measurement duration in extended beacon
2256 * format */
2257 u8 channel; /* channel to measure */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002258 u8 type; /* see enum iwl_measure_type */
Zhu Yib481de92007-09-25 17:54:57 -07002259 __le16 reserved;
2260} __attribute__ ((packed));
2261
2262/*
2263 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
2264 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002265struct iwl_spectrum_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07002266 __le16 len; /* number of bytes starting from token */
2267 u8 token; /* token id */
2268 u8 id; /* measurement id -- 0 or 1 */
2269 u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */
2270 u8 periodic; /* 1 = periodic */
2271 __le16 path_loss_timeout;
2272 __le32 start_time; /* start time in extended beacon format */
2273 __le32 reserved2;
2274 __le32 flags; /* rxon flags */
2275 __le32 filter_flags; /* rxon filter flags */
2276 __le16 channel_count; /* minimum 1, maximum 10 */
2277 __le16 reserved3;
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002278 struct iwl_measure_channel channels[10];
Zhu Yib481de92007-09-25 17:54:57 -07002279} __attribute__ ((packed));
2280
2281/*
2282 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
2283 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002284struct iwl_spectrum_resp {
Zhu Yib481de92007-09-25 17:54:57 -07002285 u8 token;
2286 u8 id; /* id of the prior command replaced, or 0xff */
2287 __le16 status; /* 0 - command will be handled
2288 * 1 - cannot handle (conflicts with another
2289 * measurement) */
2290} __attribute__ ((packed));
2291
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002292enum iwl_measurement_state {
Zhu Yib481de92007-09-25 17:54:57 -07002293 IWL_MEASUREMENT_START = 0,
2294 IWL_MEASUREMENT_STOP = 1,
2295};
2296
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002297enum iwl_measurement_status {
Zhu Yib481de92007-09-25 17:54:57 -07002298 IWL_MEASUREMENT_OK = 0,
2299 IWL_MEASUREMENT_CONCURRENT = 1,
2300 IWL_MEASUREMENT_CSA_CONFLICT = 2,
2301 IWL_MEASUREMENT_TGH_CONFLICT = 3,
2302 /* 4-5 reserved */
2303 IWL_MEASUREMENT_STOPPED = 6,
2304 IWL_MEASUREMENT_TIMEOUT = 7,
2305 IWL_MEASUREMENT_PERIODIC_FAILED = 8,
2306};
2307
2308#define NUM_ELEMENTS_IN_HISTOGRAM 8
2309
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002310struct iwl_measurement_histogram {
Zhu Yib481de92007-09-25 17:54:57 -07002311 __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
2312 __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */
2313} __attribute__ ((packed));
2314
2315/* clear channel availability counters */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002316struct iwl_measurement_cca_counters {
Zhu Yib481de92007-09-25 17:54:57 -07002317 __le32 ofdm;
2318 __le32 cck;
2319} __attribute__ ((packed));
2320
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002321enum iwl_measure_type {
Zhu Yib481de92007-09-25 17:54:57 -07002322 IWL_MEASURE_BASIC = (1 << 0),
2323 IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
2324 IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
2325 IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
2326 IWL_MEASURE_FRAME = (1 << 4),
2327 /* bits 5:6 are reserved */
2328 IWL_MEASURE_IDLE = (1 << 7),
2329};
2330
2331/*
2332 * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
2333 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002334struct iwl_spectrum_notification {
Zhu Yib481de92007-09-25 17:54:57 -07002335 u8 id; /* measurement id -- 0 or 1 */
2336 u8 token;
2337 u8 channel_index; /* index in measurement channel list */
2338 u8 state; /* 0 - start, 1 - stop */
2339 __le32 start_time; /* lower 32-bits of TSF */
2340 u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */
2341 u8 channel;
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002342 u8 type; /* see enum iwl_measurement_type */
Zhu Yib481de92007-09-25 17:54:57 -07002343 u8 reserved1;
2344 /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only
2345 * valid if applicable for measurement type requested. */
2346 __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */
2347 __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */
2348 __le32 cca_time; /* channel load time in usecs */
2349 u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 -
2350 * unidentified */
2351 u8 reserved2[3];
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002352 struct iwl_measurement_histogram histogram;
Zhu Yib481de92007-09-25 17:54:57 -07002353 __le32 stop_time; /* lower 32-bits of TSF */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002354 __le32 status; /* see iwl_measurement_status */
Zhu Yib481de92007-09-25 17:54:57 -07002355} __attribute__ ((packed));
2356
2357/******************************************************************************
2358 * (7)
2359 * Power Management Commands, Responses, Notifications:
2360 *
2361 *****************************************************************************/
2362
2363/**
Mohamed Abbasca579612008-07-18 13:52:57 +08002364 * struct iwl_powertable_cmd - Power Table Command
Zhu Yib481de92007-09-25 17:54:57 -07002365 * @flags: See below:
2366 *
2367 * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
2368 *
2369 * PM allow:
2370 * bit 0 - '0' Driver not allow power management
2371 * '1' Driver allow PM (use rest of parameters)
Johannes Berge312c242009-08-07 15:41:51 -07002372 *
Zhu Yib481de92007-09-25 17:54:57 -07002373 * uCode send sleep notifications:
2374 * bit 1 - '0' Don't send sleep notification
2375 * '1' send sleep notification (SEND_PM_NOTIFICATION)
Johannes Berge312c242009-08-07 15:41:51 -07002376 *
Zhu Yib481de92007-09-25 17:54:57 -07002377 * Sleep over DTIM
2378 * bit 2 - '0' PM have to walk up every DTIM
2379 * '1' PM could sleep over DTIM till listen Interval.
Johannes Berge312c242009-08-07 15:41:51 -07002380 *
Zhu Yib481de92007-09-25 17:54:57 -07002381 * PCI power managed
Tomas Winklere7b63582008-09-03 11:26:49 +08002382 * bit 3 - '0' (PCI_CFG_LINK_CTRL & 0x1)
2383 * '1' !(PCI_CFG_LINK_CTRL & 0x1)
Johannes Berge312c242009-08-07 15:41:51 -07002384 *
2385 * Fast PD
2386 * bit 4 - '1' Put radio to sleep when receiving frame for others
2387 *
Zhu Yib481de92007-09-25 17:54:57 -07002388 * Force sleep Modes
2389 * bit 31/30- '00' use both mac/xtal sleeps
2390 * '01' force Mac sleep
2391 * '10' force xtal sleep
2392 * '11' Illegal set
2393 *
2394 * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
Tomas Winklera96a27f2008-10-23 23:48:56 -07002395 * ucode assume sleep over DTIM is allowed and we don't need to wake up
Zhu Yib481de92007-09-25 17:54:57 -07002396 * for every DTIM.
2397 */
2398#define IWL_POWER_VEC_SIZE 5
2399
Tomas Winkler600c0e12008-12-19 10:37:04 +08002400#define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK cpu_to_le16(BIT(0))
2401#define IWL_POWER_SLEEP_OVER_DTIM_MSK cpu_to_le16(BIT(2))
2402#define IWL_POWER_PCI_PM_MSK cpu_to_le16(BIT(3))
2403#define IWL_POWER_FAST_PD cpu_to_le16(BIT(4))
2404
2405struct iwl3945_powertable_cmd {
2406 __le16 flags;
2407 u8 reserved[2];
2408 __le32 rx_data_timeout;
2409 __le32 tx_data_timeout;
2410 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
2411} __attribute__ ((packed));
Zhu Yib481de92007-09-25 17:54:57 -07002412
Mohamed Abbasca579612008-07-18 13:52:57 +08002413struct iwl_powertable_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07002414 __le16 flags;
Tomas Winkler600c0e12008-12-19 10:37:04 +08002415 u8 keep_alive_seconds; /* 3945 reserved */
2416 u8 debug_flags; /* 3945 reserved */
Zhu Yib481de92007-09-25 17:54:57 -07002417 __le32 rx_data_timeout;
2418 __le32 tx_data_timeout;
2419 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
2420 __le32 keep_alive_beacons;
2421} __attribute__ ((packed));
Zhu Yib481de92007-09-25 17:54:57 -07002422
2423/*
2424 * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
2425 * 3945 and 4965 identical.
2426 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002427struct iwl_sleep_notification {
Zhu Yib481de92007-09-25 17:54:57 -07002428 u8 pm_sleep_mode;
2429 u8 pm_wakeup_src;
2430 __le16 reserved;
2431 __le32 sleep_time;
2432 __le32 tsf_low;
2433 __le32 bcon_timer;
2434} __attribute__ ((packed));
2435
2436/* Sleep states. 3945 and 4965 identical. */
2437enum {
2438 IWL_PM_NO_SLEEP = 0,
2439 IWL_PM_SLP_MAC = 1,
2440 IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
2441 IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
2442 IWL_PM_SLP_PHY = 4,
2443 IWL_PM_SLP_REPENT = 5,
2444 IWL_PM_WAKEUP_BY_TIMER = 6,
2445 IWL_PM_WAKEUP_BY_DRIVER = 7,
2446 IWL_PM_WAKEUP_BY_RFKILL = 8,
2447 /* 3 reserved */
2448 IWL_PM_NUM_OF_MODES = 12,
2449};
2450
2451/*
2452 * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
2453 */
2454#define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */
2455#define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */
2456#define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002457struct iwl_card_state_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07002458 __le32 status; /* CARD_STATE_CMD_* request new power state */
2459} __attribute__ ((packed));
2460
2461/*
2462 * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
2463 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002464struct iwl_card_state_notif {
Zhu Yib481de92007-09-25 17:54:57 -07002465 __le32 flags;
2466} __attribute__ ((packed));
2467
2468#define HW_CARD_DISABLED 0x01
2469#define SW_CARD_DISABLED 0x02
2470#define RF_CARD_DISABLED 0x04
2471#define RXON_CARD_DISABLED 0x10
2472
Emmanuel Grumbach47f4a582008-06-12 09:47:13 +08002473struct iwl_ct_kill_config {
Zhu Yib481de92007-09-25 17:54:57 -07002474 __le32 reserved;
2475 __le32 critical_temperature_M;
2476 __le32 critical_temperature_R;
2477} __attribute__ ((packed));
2478
Wey-Yi Guy672639d2009-07-24 11:13:01 -07002479/* 1000, and 6x00 */
2480struct iwl_ct_kill_throttling_config {
2481 __le32 critical_temperature_exit;
2482 __le32 reserved;
2483 __le32 critical_temperature_enter;
2484} __attribute__ ((packed));
2485
Zhu Yib481de92007-09-25 17:54:57 -07002486/******************************************************************************
2487 * (8)
2488 * Scan Commands, Responses, Notifications:
2489 *
2490 *****************************************************************************/
2491
Harvey Harrison51e9bf52008-11-26 13:12:52 -08002492#define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0)
2493#define SCAN_CHANNEL_TYPE_ACTIVE cpu_to_le32(1)
Tomas Winklerd16dc482008-07-11 11:53:38 +08002494
Ben Cahill3058f022008-01-14 17:46:17 -08002495/**
Tomas Winkler2a421b92008-06-12 09:47:10 +08002496 * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table
Ben Cahill3058f022008-01-14 17:46:17 -08002497 *
2498 * One for each channel in the scan list.
2499 * Each channel can independently select:
2500 * 1) SSID for directed active scans
2501 * 2) Txpower setting (for rate specified within Tx command)
2502 * 3) How long to stay on-channel (behavior may be modified by quiet_time,
2503 * quiet_plcp_th, good_CRC_th)
2504 *
2505 * To avoid uCode errors, make sure the following are true (see comments
Tomas Winkler2a421b92008-06-12 09:47:10 +08002506 * under struct iwl_scan_cmd about max_out_time and quiet_time):
Ben Cahill3058f022008-01-14 17:46:17 -08002507 * 1) If using passive_dwell (i.e. passive_dwell != 0):
2508 * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
2509 * 2) quiet_time <= active_dwell
2510 * 3) If restricting off-channel time (i.e. max_out_time !=0):
2511 * passive_dwell < max_out_time
2512 * active_dwell < max_out_time
2513 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08002514
2515/* FIXME: rename to AP1, remove tpc */
2516struct iwl3945_scan_channel {
2517 /*
2518 * type is defined as:
2519 * 0:0 1 = active, 0 = passive
2520 * 1:4 SSID direct bit map; if a bit is set, then corresponding
2521 * SSID IE is transmitted in probe request.
2522 * 5:7 reserved
2523 */
2524 u8 type;
2525 u8 channel; /* band is selected by iwl3945_scan_cmd "flags" field */
2526 struct iwl3945_tx_power tpc;
2527 __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */
2528 __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */
2529} __attribute__ ((packed));
2530
Winkler, Tomas0d210442009-01-23 13:45:21 -08002531/* set number of direct probes u8 type */
2532#define IWL39_SCAN_PROBE_MASK(n) ((BIT(n) | (BIT(n) - BIT(1))))
2533
Tomas Winkler2a421b92008-06-12 09:47:10 +08002534struct iwl_scan_channel {
Ben Cahill3058f022008-01-14 17:46:17 -08002535 /*
2536 * type is defined as:
2537 * 0:0 1 = active, 0 = passive
Tomas Winklerd16dc482008-07-11 11:53:38 +08002538 * 1:20 SSID direct bit map; if a bit is set, then corresponding
Ben Cahill3058f022008-01-14 17:46:17 -08002539 * SSID IE is transmitted in probe request.
Tomas Winklerd16dc482008-07-11 11:53:38 +08002540 * 21:31 reserved
Zhu Yib481de92007-09-25 17:54:57 -07002541 */
Tomas Winklerd16dc482008-07-11 11:53:38 +08002542 __le32 type;
2543 __le16 channel; /* band is selected by iwl_scan_cmd "flags" field */
Tomas Winklerf53696d2008-06-12 09:47:12 +08002544 u8 tx_gain; /* gain for analog radio */
2545 u8 dsp_atten; /* gain for DSP */
Ben Cahill3058f022008-01-14 17:46:17 -08002546 __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */
2547 __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */
Zhu Yib481de92007-09-25 17:54:57 -07002548} __attribute__ ((packed));
2549
Winkler, Tomas0d210442009-01-23 13:45:21 -08002550/* set number of direct probes __le32 type */
2551#define IWL_SCAN_PROBE_MASK(n) cpu_to_le32((BIT(n) | (BIT(n) - BIT(1))))
2552
Ben Cahill3058f022008-01-14 17:46:17 -08002553/**
Tomas Winkler2a421b92008-06-12 09:47:10 +08002554 * struct iwl_ssid_ie - directed scan network information element
Ben Cahill3058f022008-01-14 17:46:17 -08002555 *
2556 * Up to 4 of these may appear in REPLY_SCAN_CMD, selected by "type" field
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002557 * in struct iwl_scan_channel; each channel may select different ssids from
Ben Cahill3058f022008-01-14 17:46:17 -08002558 * among the 4 entries. SSID IEs get transmitted in reverse order of entry.
2559 */
Tomas Winkler2a421b92008-06-12 09:47:10 +08002560struct iwl_ssid_ie {
Zhu Yib481de92007-09-25 17:54:57 -07002561 u8 id;
2562 u8 len;
2563 u8 ssid[32];
2564} __attribute__ ((packed));
2565
Johannes Berg9b3bf062009-04-20 14:36:55 -07002566#define PROBE_OPTION_MAX_3945 4
2567#define PROBE_OPTION_MAX 20
Harvey Harrison51e9bf52008-11-26 13:12:52 -08002568#define TX_CMD_LIFE_TIME_INFINITE cpu_to_le32(0xFFFFFFFF)
2569#define IWL_GOOD_CRC_TH cpu_to_le16(1)
Zhu Yib481de92007-09-25 17:54:57 -07002570#define IWL_MAX_SCAN_SIZE 1024
Johannes Berg1ecf9fc2009-04-20 14:36:56 -07002571#define IWL_MAX_PROBE_REQUEST 200
Zhu Yib481de92007-09-25 17:54:57 -07002572
2573/*
2574 * REPLY_SCAN_CMD = 0x80 (command)
Ben Cahill3058f022008-01-14 17:46:17 -08002575 *
2576 * The hardware scan command is very powerful; the driver can set it up to
2577 * maintain (relatively) normal network traffic while doing a scan in the
2578 * background. The max_out_time and suspend_time control the ratio of how
2579 * long the device stays on an associated network channel ("service channel")
2580 * vs. how long it's away from the service channel, i.e. tuned to other channels
2581 * for scanning.
2582 *
2583 * max_out_time is the max time off-channel (in usec), and suspend_time
2584 * is how long (in "extended beacon" format) that the scan is "suspended"
2585 * after returning to the service channel. That is, suspend_time is the
2586 * time that we stay on the service channel, doing normal work, between
2587 * scan segments. The driver may set these parameters differently to support
2588 * scanning when associated vs. not associated, and light vs. heavy traffic
2589 * loads when associated.
2590 *
2591 * After receiving this command, the device's scan engine does the following;
2592 *
2593 * 1) Sends SCAN_START notification to driver
2594 * 2) Checks to see if it has time to do scan for one channel
2595 * 3) Sends NULL packet, with power-save (PS) bit set to 1,
2596 * to tell AP that we're going off-channel
2597 * 4) Tunes to first channel in scan list, does active or passive scan
2598 * 5) Sends SCAN_RESULT notification to driver
2599 * 6) Checks to see if it has time to do scan on *next* channel in list
2600 * 7) Repeats 4-6 until it no longer has time to scan the next channel
2601 * before max_out_time expires
2602 * 8) Returns to service channel
2603 * 9) Sends NULL packet with PS=0 to tell AP that we're back
2604 * 10) Stays on service channel until suspend_time expires
2605 * 11) Repeats entire process 2-10 until list is complete
2606 * 12) Sends SCAN_COMPLETE notification
2607 *
2608 * For fast, efficient scans, the scan command also has support for staying on
2609 * a channel for just a short time, if doing active scanning and getting no
2610 * responses to the transmitted probe request. This time is controlled by
2611 * quiet_time, and the number of received packets below which a channel is
2612 * considered "quiet" is controlled by quiet_plcp_threshold.
2613 *
2614 * For active scanning on channels that have regulatory restrictions against
2615 * blindly transmitting, the scan can listen before transmitting, to make sure
2616 * that there is already legitimate activity on the channel. If enough
2617 * packets are cleanly received on the channel (controlled by good_CRC_th,
2618 * typical value 1), the scan engine starts transmitting probe requests.
2619 *
2620 * Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
2621 *
2622 * To avoid uCode errors, see timing restrictions described under
Tomas Winkler2a421b92008-06-12 09:47:10 +08002623 * struct iwl_scan_channel.
Zhu Yib481de92007-09-25 17:54:57 -07002624 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08002625
2626struct iwl3945_scan_cmd {
2627 __le16 len;
2628 u8 reserved0;
2629 u8 channel_count; /* # channels in channel list */
2630 __le16 quiet_time; /* dwell only this # millisecs on quiet channel
2631 * (only for active scan) */
2632 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
2633 __le16 good_CRC_th; /* passive -> active promotion threshold */
2634 __le16 reserved1;
2635 __le32 max_out_time; /* max usec to be away from associated (service)
2636 * channel */
2637 __le32 suspend_time; /* pause scan this long (in "extended beacon
2638 * format") when returning to service channel:
2639 * 3945; 31:24 # beacons, 19:0 additional usec,
2640 * 4965; 31:22 # beacons, 21:0 additional usec.
2641 */
2642 __le32 flags; /* RXON_FLG_* */
2643 __le32 filter_flags; /* RXON_FILTER_* */
2644
2645 /* For active scans (set to all-0s for passive scans).
2646 * Does not include payload. Must specify Tx rate; no rate scaling. */
2647 struct iwl3945_tx_cmd tx_cmd;
2648
2649 /* For directed active scans (set to all-0s otherwise) */
Johannes Berg9b3bf062009-04-20 14:36:55 -07002650 struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX_3945];
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08002651
2652 /*
2653 * Probe request frame, followed by channel list.
2654 *
2655 * Size of probe request frame is specified by byte count in tx_cmd.
2656 * Channel list follows immediately after probe request frame.
2657 * Number of channels in list is specified by channel_count.
2658 * Each channel in list is of type:
2659 *
2660 * struct iwl3945_scan_channel channels[0];
2661 *
2662 * NOTE: Only one band of channels can be scanned per pass. You
2663 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
2664 * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
2665 * before requesting another scan.
2666 */
2667 u8 data[0];
2668} __attribute__ ((packed));
2669
Tomas Winkler2a421b92008-06-12 09:47:10 +08002670struct iwl_scan_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07002671 __le16 len;
2672 u8 reserved0;
Ben Cahill3058f022008-01-14 17:46:17 -08002673 u8 channel_count; /* # channels in channel list */
2674 __le16 quiet_time; /* dwell only this # millisecs on quiet channel
2675 * (only for active scan) */
2676 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
2677 __le16 good_CRC_th; /* passive -> active promotion threshold */
2678 __le16 rx_chain; /* RXON_RX_CHAIN_* */
2679 __le32 max_out_time; /* max usec to be away from associated (service)
2680 * channel */
2681 __le32 suspend_time; /* pause scan this long (in "extended beacon
2682 * format") when returning to service chnl:
2683 * 3945; 31:24 # beacons, 19:0 additional usec,
2684 * 4965; 31:22 # beacons, 21:0 additional usec.
2685 */
2686 __le32 flags; /* RXON_FLG_* */
2687 __le32 filter_flags; /* RXON_FILTER_* */
Zhu Yib481de92007-09-25 17:54:57 -07002688
Ben Cahill3058f022008-01-14 17:46:17 -08002689 /* For active scans (set to all-0s for passive scans).
2690 * Does not include payload. Must specify Tx rate; no rate scaling. */
Tomas Winkler83d527d2008-05-15 13:54:05 +08002691 struct iwl_tx_cmd tx_cmd;
Ben Cahill3058f022008-01-14 17:46:17 -08002692
2693 /* For directed active scans (set to all-0s otherwise) */
Tomas Winkler2a421b92008-06-12 09:47:10 +08002694 struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
Zhu Yib481de92007-09-25 17:54:57 -07002695
Zhu Yib481de92007-09-25 17:54:57 -07002696 /*
Ben Cahill3058f022008-01-14 17:46:17 -08002697 * Probe request frame, followed by channel list.
2698 *
2699 * Size of probe request frame is specified by byte count in tx_cmd.
2700 * Channel list follows immediately after probe request frame.
2701 * Number of channels in list is specified by channel_count.
2702 * Each channel in list is of type:
Zhu Yib481de92007-09-25 17:54:57 -07002703 *
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002704 * struct iwl_scan_channel channels[0];
Zhu Yib481de92007-09-25 17:54:57 -07002705 *
2706 * NOTE: Only one band of channels can be scanned per pass. You
Ben Cahill3058f022008-01-14 17:46:17 -08002707 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
2708 * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
2709 * before requesting another scan.
Zhu Yib481de92007-09-25 17:54:57 -07002710 */
Ben Cahill3058f022008-01-14 17:46:17 -08002711 u8 data[0];
Zhu Yib481de92007-09-25 17:54:57 -07002712} __attribute__ ((packed));
2713
2714/* Can abort will notify by complete notification with abort status. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08002715#define CAN_ABORT_STATUS cpu_to_le32(0x1)
Zhu Yib481de92007-09-25 17:54:57 -07002716/* complete notification statuses */
2717#define ABORT_STATUS 0x2
2718
2719/*
2720 * REPLY_SCAN_CMD = 0x80 (response)
2721 */
Tomas Winkler2a421b92008-06-12 09:47:10 +08002722struct iwl_scanreq_notification {
Zhu Yib481de92007-09-25 17:54:57 -07002723 __le32 status; /* 1: okay, 2: cannot fulfill request */
2724} __attribute__ ((packed));
2725
2726/*
2727 * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
2728 */
Tomas Winkler2a421b92008-06-12 09:47:10 +08002729struct iwl_scanstart_notification {
Zhu Yib481de92007-09-25 17:54:57 -07002730 __le32 tsf_low;
2731 __le32 tsf_high;
2732 __le32 beacon_timer;
2733 u8 channel;
2734 u8 band;
2735 u8 reserved[2];
2736 __le32 status;
2737} __attribute__ ((packed));
2738
2739#define SCAN_OWNER_STATUS 0x1;
2740#define MEASURE_OWNER_STATUS 0x2;
2741
2742#define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */
2743/*
2744 * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
2745 */
Tomas Winkler2a421b92008-06-12 09:47:10 +08002746struct iwl_scanresults_notification {
Zhu Yib481de92007-09-25 17:54:57 -07002747 u8 channel;
2748 u8 band;
2749 u8 reserved[2];
2750 __le32 tsf_low;
2751 __le32 tsf_high;
2752 __le32 statistics[NUMBER_OF_STATISTICS];
2753} __attribute__ ((packed));
2754
2755/*
2756 * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
2757 */
Tomas Winkler2a421b92008-06-12 09:47:10 +08002758struct iwl_scancomplete_notification {
Zhu Yib481de92007-09-25 17:54:57 -07002759 u8 scanned_channels;
2760 u8 status;
2761 u8 reserved;
2762 u8 last_channel;
2763 __le32 tsf_low;
2764 __le32 tsf_high;
2765} __attribute__ ((packed));
2766
2767
2768/******************************************************************************
2769 * (9)
2770 * IBSS/AP Commands and Notifications:
2771 *
2772 *****************************************************************************/
2773
2774/*
2775 * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
2776 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08002777
2778struct iwl3945_beacon_notif {
2779 struct iwl3945_tx_resp beacon_notify_hdr;
2780 __le32 low_tsf;
2781 __le32 high_tsf;
2782 __le32 ibss_mgr_status;
2783} __attribute__ ((packed));
2784
Christoph Hellwigbb8c0932008-01-27 16:41:47 -08002785struct iwl4965_beacon_notif {
2786 struct iwl4965_tx_resp beacon_notify_hdr;
Zhu Yib481de92007-09-25 17:54:57 -07002787 __le32 low_tsf;
2788 __le32 high_tsf;
2789 __le32 ibss_mgr_status;
2790} __attribute__ ((packed));
2791
2792/*
2793 * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
2794 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08002795
2796struct iwl3945_tx_beacon_cmd {
2797 struct iwl3945_tx_cmd tx;
2798 __le16 tim_idx;
2799 u8 tim_size;
2800 u8 reserved1;
2801 struct ieee80211_hdr frame[0]; /* beacon frame */
2802} __attribute__ ((packed));
2803
Tomas Winkler4bf64ef2008-07-18 13:53:03 +08002804struct iwl_tx_beacon_cmd {
Tomas Winkler83d527d2008-05-15 13:54:05 +08002805 struct iwl_tx_cmd tx;
Zhu Yib481de92007-09-25 17:54:57 -07002806 __le16 tim_idx;
2807 u8 tim_size;
2808 u8 reserved1;
2809 struct ieee80211_hdr frame[0]; /* beacon frame */
2810} __attribute__ ((packed));
2811
2812/******************************************************************************
2813 * (10)
2814 * Statistics Commands and Notifications:
2815 *
2816 *****************************************************************************/
2817
2818#define IWL_TEMP_CONVERT 260
2819
2820#define SUP_RATE_11A_MAX_NUM_CHANNELS 8
2821#define SUP_RATE_11B_MAX_NUM_CHANNELS 4
2822#define SUP_RATE_11G_MAX_NUM_CHANNELS 12
2823
2824/* Used for passing to driver number of successes and failures per rate */
2825struct rate_histogram {
2826 union {
2827 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2828 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2829 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2830 } success;
2831 union {
2832 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2833 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2834 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2835 } failed;
2836} __attribute__ ((packed));
2837
2838/* statistics command response */
2839
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08002840struct iwl39_statistics_rx_phy {
2841 __le32 ina_cnt;
2842 __le32 fina_cnt;
2843 __le32 plcp_err;
2844 __le32 crc32_err;
2845 __le32 overrun_err;
2846 __le32 early_overrun_err;
2847 __le32 crc32_good;
2848 __le32 false_alarm_cnt;
2849 __le32 fina_sync_err_cnt;
2850 __le32 sfd_timeout;
2851 __le32 fina_timeout;
2852 __le32 unresponded_rts;
2853 __le32 rxe_frame_limit_overrun;
2854 __le32 sent_ack_cnt;
2855 __le32 sent_cts_cnt;
2856} __attribute__ ((packed));
2857
2858struct iwl39_statistics_rx_non_phy {
2859 __le32 bogus_cts; /* CTS received when not expecting CTS */
2860 __le32 bogus_ack; /* ACK received when not expecting ACK */
2861 __le32 non_bssid_frames; /* number of frames with BSSID that
2862 * doesn't belong to the STA BSSID */
2863 __le32 filtered_frames; /* count frames that were dumped in the
2864 * filtering process */
2865 __le32 non_channel_beacons; /* beacons with our bss id but not on
2866 * our serving channel */
2867} __attribute__ ((packed));
2868
2869struct iwl39_statistics_rx {
2870 struct iwl39_statistics_rx_phy ofdm;
2871 struct iwl39_statistics_rx_phy cck;
2872 struct iwl39_statistics_rx_non_phy general;
2873} __attribute__ ((packed));
2874
2875struct iwl39_statistics_tx {
2876 __le32 preamble_cnt;
2877 __le32 rx_detected_cnt;
2878 __le32 bt_prio_defer_cnt;
2879 __le32 bt_prio_kill_cnt;
2880 __le32 few_bytes_cnt;
2881 __le32 cts_timeout;
2882 __le32 ack_timeout;
2883 __le32 expected_ack_cnt;
2884 __le32 actual_ack_cnt;
2885} __attribute__ ((packed));
2886
2887struct statistics_dbg {
2888 __le32 burst_check;
2889 __le32 burst_count;
2890 __le32 reserved[4];
2891} __attribute__ ((packed));
2892
2893struct iwl39_statistics_div {
2894 __le32 tx_on_a;
2895 __le32 tx_on_b;
2896 __le32 exec_time;
2897 __le32 probe_time;
2898} __attribute__ ((packed));
2899
2900struct iwl39_statistics_general {
2901 __le32 temperature;
2902 struct statistics_dbg dbg;
2903 __le32 sleep_time;
2904 __le32 slots_out;
2905 __le32 slots_idle;
2906 __le32 ttl_timestamp;
2907 struct iwl39_statistics_div div;
2908} __attribute__ ((packed));
2909
Zhu Yib481de92007-09-25 17:54:57 -07002910struct statistics_rx_phy {
2911 __le32 ina_cnt;
2912 __le32 fina_cnt;
2913 __le32 plcp_err;
2914 __le32 crc32_err;
2915 __le32 overrun_err;
2916 __le32 early_overrun_err;
2917 __le32 crc32_good;
2918 __le32 false_alarm_cnt;
2919 __le32 fina_sync_err_cnt;
2920 __le32 sfd_timeout;
2921 __le32 fina_timeout;
2922 __le32 unresponded_rts;
2923 __le32 rxe_frame_limit_overrun;
2924 __le32 sent_ack_cnt;
2925 __le32 sent_cts_cnt;
Zhu Yib481de92007-09-25 17:54:57 -07002926 __le32 sent_ba_rsp_cnt;
2927 __le32 dsp_self_kill;
2928 __le32 mh_format_err;
2929 __le32 re_acq_main_rssi_sum;
2930 __le32 reserved3;
Zhu Yib481de92007-09-25 17:54:57 -07002931} __attribute__ ((packed));
2932
Zhu Yib481de92007-09-25 17:54:57 -07002933struct statistics_rx_ht_phy {
2934 __le32 plcp_err;
2935 __le32 overrun_err;
2936 __le32 early_overrun_err;
2937 __le32 crc32_good;
2938 __le32 crc32_err;
2939 __le32 mh_format_err;
2940 __le32 agg_crc32_good;
2941 __le32 agg_mpdu_cnt;
2942 __le32 agg_cnt;
2943 __le32 reserved2;
2944} __attribute__ ((packed));
Zhu Yib481de92007-09-25 17:54:57 -07002945
Harvey Harrisonc1b4aa32009-01-29 13:26:44 -08002946#define INTERFERENCE_DATA_AVAILABLE cpu_to_le32(1)
Winkler, Tomas34c22cf2008-12-17 16:52:27 +08002947
Zhu Yib481de92007-09-25 17:54:57 -07002948struct statistics_rx_non_phy {
2949 __le32 bogus_cts; /* CTS received when not expecting CTS */
2950 __le32 bogus_ack; /* ACK received when not expecting ACK */
2951 __le32 non_bssid_frames; /* number of frames with BSSID that
2952 * doesn't belong to the STA BSSID */
2953 __le32 filtered_frames; /* count frames that were dumped in the
2954 * filtering process */
2955 __le32 non_channel_beacons; /* beacons with our bss id but not on
2956 * our serving channel */
Zhu Yib481de92007-09-25 17:54:57 -07002957 __le32 channel_beacons; /* beacons with our bss id and in our
2958 * serving channel */
2959 __le32 num_missed_bcon; /* number of missed beacons */
2960 __le32 adc_rx_saturation_time; /* count in 0.8us units the time the
2961 * ADC was in saturation */
2962 __le32 ina_detection_search_time;/* total time (in 0.8us) searched
2963 * for INA */
2964 __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */
2965 __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */
2966 __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */
2967 __le32 interference_data_flag; /* flag for interference data
2968 * availability. 1 when data is
2969 * available. */
Ben Cahill3058f022008-01-14 17:46:17 -08002970 __le32 channel_load; /* counts RX Enable time in uSec */
Zhu Yib481de92007-09-25 17:54:57 -07002971 __le32 dsp_false_alarms; /* DSP false alarm (both OFDM
2972 * and CCK) counter */
2973 __le32 beacon_rssi_a;
2974 __le32 beacon_rssi_b;
2975 __le32 beacon_rssi_c;
2976 __le32 beacon_energy_a;
2977 __le32 beacon_energy_b;
2978 __le32 beacon_energy_c;
Zhu Yib481de92007-09-25 17:54:57 -07002979} __attribute__ ((packed));
2980
2981struct statistics_rx {
2982 struct statistics_rx_phy ofdm;
2983 struct statistics_rx_phy cck;
2984 struct statistics_rx_non_phy general;
Zhu Yib481de92007-09-25 17:54:57 -07002985 struct statistics_rx_ht_phy ofdm_ht;
Zhu Yib481de92007-09-25 17:54:57 -07002986} __attribute__ ((packed));
2987
Wey-Yi Guyfcbaf8b2009-08-21 13:34:18 -07002988/**
2989 * struct statistics_tx_power - current tx power
2990 *
2991 * @ant_a: current tx power on chain a in 1/2 dB step
2992 * @ant_b: current tx power on chain b in 1/2 dB step
2993 * @ant_c: current tx power on chain c in 1/2 dB step
2994 */
2995struct statistics_tx_power {
2996 u8 ant_a;
2997 u8 ant_b;
2998 u8 ant_c;
2999 u8 reserved;
3000} __attribute__ ((packed));
3001
Zhu Yib481de92007-09-25 17:54:57 -07003002struct statistics_tx_non_phy_agg {
3003 __le32 ba_timeout;
3004 __le32 ba_reschedule_frames;
3005 __le32 scd_query_agg_frame_cnt;
3006 __le32 scd_query_no_agg;
3007 __le32 scd_query_agg;
3008 __le32 scd_query_mismatch;
3009 __le32 frame_not_ready;
3010 __le32 underrun;
3011 __le32 bt_prio_kill;
3012 __le32 rx_ba_rsp_cnt;
Zhu Yib481de92007-09-25 17:54:57 -07003013} __attribute__ ((packed));
Zhu Yib481de92007-09-25 17:54:57 -07003014
3015struct statistics_tx {
3016 __le32 preamble_cnt;
3017 __le32 rx_detected_cnt;
3018 __le32 bt_prio_defer_cnt;
3019 __le32 bt_prio_kill_cnt;
3020 __le32 few_bytes_cnt;
3021 __le32 cts_timeout;
3022 __le32 ack_timeout;
3023 __le32 expected_ack_cnt;
3024 __le32 actual_ack_cnt;
Zhu Yib481de92007-09-25 17:54:57 -07003025 __le32 dump_msdu_cnt;
3026 __le32 burst_abort_next_frame_mismatch_cnt;
3027 __le32 burst_abort_missing_next_frame_cnt;
3028 __le32 cts_timeout_collision;
3029 __le32 ack_or_ba_timeout_collision;
3030 struct statistics_tx_non_phy_agg agg;
Wey-Yi Guyfcbaf8b2009-08-21 13:34:18 -07003031 struct statistics_tx_power tx_power;
3032 __le32 reserved1;
Zhu Yib481de92007-09-25 17:54:57 -07003033} __attribute__ ((packed));
3034
Zhu Yib481de92007-09-25 17:54:57 -07003035
3036struct statistics_div {
3037 __le32 tx_on_a;
3038 __le32 tx_on_b;
3039 __le32 exec_time;
3040 __le32 probe_time;
Zhu Yib481de92007-09-25 17:54:57 -07003041 __le32 reserved1;
3042 __le32 reserved2;
Zhu Yib481de92007-09-25 17:54:57 -07003043} __attribute__ ((packed));
3044
3045struct statistics_general {
3046 __le32 temperature;
Zhu Yib481de92007-09-25 17:54:57 -07003047 __le32 temperature_m;
Zhu Yib481de92007-09-25 17:54:57 -07003048 struct statistics_dbg dbg;
3049 __le32 sleep_time;
3050 __le32 slots_out;
3051 __le32 slots_idle;
3052 __le32 ttl_timestamp;
3053 struct statistics_div div;
Zhu Yib481de92007-09-25 17:54:57 -07003054 __le32 rx_enable_counter;
3055 __le32 reserved1;
3056 __le32 reserved2;
3057 __le32 reserved3;
Zhu Yib481de92007-09-25 17:54:57 -07003058} __attribute__ ((packed));
3059
3060/*
3061 * REPLY_STATISTICS_CMD = 0x9c,
3062 * 3945 and 4965 identical.
3063 *
3064 * This command triggers an immediate response containing uCode statistics.
3065 * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
3066 *
3067 * If the CLEAR_STATS configuration flag is set, uCode will clear its
3068 * internal copy of the statistics (counters) after issuing the response.
3069 * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
3070 *
3071 * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
3072 * STATISTICS_NOTIFICATIONs after received beacons (see below). This flag
3073 * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
3074 */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08003075#define IWL_STATS_CONF_CLEAR_STATS cpu_to_le32(0x1) /* see above */
3076#define IWL_STATS_CONF_DISABLE_NOTIF cpu_to_le32(0x2)/* see above */
Emmanuel Grumbach8f91aec2008-06-30 17:23:07 +08003077struct iwl_statistics_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07003078 __le32 configuration_flags; /* IWL_STATS_CONF_* */
3079} __attribute__ ((packed));
3080
3081/*
3082 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
3083 *
3084 * By default, uCode issues this notification after receiving a beacon
3085 * while associated. To disable this behavior, set DISABLE_NOTIF flag in the
3086 * REPLY_STATISTICS_CMD 0x9c, above.
3087 *
3088 * Statistics counters continue to increment beacon after beacon, but are
3089 * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
3090 * 0x9c with CLEAR_STATS bit set (see above).
3091 *
3092 * uCode also issues this notification during scans. uCode clears statistics
3093 * appropriately so that each notification contains statistics for only the
3094 * one channel that has just been scanned.
3095 */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08003096#define STATISTICS_REPLY_FLG_BAND_24G_MSK cpu_to_le32(0x2)
Wey-Yi Guy7aafef12009-08-07 15:41:38 -07003097#define STATISTICS_REPLY_FLG_HT40_MODE_MSK cpu_to_le32(0x8)
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08003098
3099struct iwl3945_notif_statistics {
3100 __le32 flag;
3101 struct iwl39_statistics_rx rx;
3102 struct iwl39_statistics_tx tx;
3103 struct iwl39_statistics_general general;
3104} __attribute__ ((packed));
3105
Emmanuel Grumbach8f91aec2008-06-30 17:23:07 +08003106struct iwl_notif_statistics {
Zhu Yib481de92007-09-25 17:54:57 -07003107 __le32 flag;
3108 struct statistics_rx rx;
3109 struct statistics_tx tx;
3110 struct statistics_general general;
3111} __attribute__ ((packed));
3112
3113
3114/*
3115 * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
3116 */
3117/* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row,
3118 * then this notification will be sent. */
3119#define CONSECUTIVE_MISSED_BCONS_TH 20
3120
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08003121struct iwl_missed_beacon_notif {
Zhu Yib481de92007-09-25 17:54:57 -07003122 __le32 consequtive_missed_beacons;
3123 __le32 total_missed_becons;
3124 __le32 num_expected_beacons;
3125 __le32 num_recvd_beacons;
3126} __attribute__ ((packed));
3127
Ben Cahillf7d09d72007-11-29 11:09:51 +08003128
Zhu Yib481de92007-09-25 17:54:57 -07003129/******************************************************************************
3130 * (11)
3131 * Rx Calibration Commands:
3132 *
Ben Cahillf7d09d72007-11-29 11:09:51 +08003133 * With the uCode used for open source drivers, most Tx calibration (except
3134 * for Tx Power) and most Rx calibration is done by uCode during the
3135 * "initialize" phase of uCode boot. Driver must calibrate only:
3136 *
3137 * 1) Tx power (depends on temperature), described elsewhere
3138 * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas)
3139 * 3) Receiver sensitivity (to optimize signal detection)
3140 *
Zhu Yib481de92007-09-25 17:54:57 -07003141 *****************************************************************************/
3142
Ben Cahillf7d09d72007-11-29 11:09:51 +08003143/**
3144 * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
3145 *
3146 * This command sets up the Rx signal detector for a sensitivity level that
3147 * is high enough to lock onto all signals within the associated network,
3148 * but low enough to ignore signals that are below a certain threshold, so as
3149 * not to have too many "false alarms". False alarms are signals that the
3150 * Rx DSP tries to lock onto, but then discards after determining that they
3151 * are noise.
3152 *
3153 * The optimum number of false alarms is between 5 and 50 per 200 TUs
3154 * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
3155 * time listening, not transmitting). Driver must adjust sensitivity so that
3156 * the ratio of actual false alarms to actual Rx time falls within this range.
3157 *
3158 * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
3159 * received beacon. These provide information to the driver to analyze the
3160 * sensitivity. Don't analyze statistics that come in from scanning, or any
3161 * other non-associated-network source. Pertinent statistics include:
3162 *
3163 * From "general" statistics (struct statistics_rx_non_phy):
3164 *
3165 * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
3166 * Measure of energy of desired signal. Used for establishing a level
3167 * below which the device does not detect signals.
3168 *
3169 * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
3170 * Measure of background noise in silent period after beacon.
3171 *
3172 * channel_load
3173 * uSecs of actual Rx time during beacon period (varies according to
3174 * how much time was spent transmitting).
3175 *
3176 * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
3177 *
3178 * false_alarm_cnt
3179 * Signal locks abandoned early (before phy-level header).
3180 *
3181 * plcp_err
3182 * Signal locks abandoned late (during phy-level header).
3183 *
3184 * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from
3185 * beacon to beacon, i.e. each value is an accumulation of all errors
3186 * before and including the latest beacon. Values will wrap around to 0
3187 * after counting up to 2^32 - 1. Driver must differentiate vs.
3188 * previous beacon's values to determine # false alarms in the current
3189 * beacon period.
3190 *
3191 * Total number of false alarms = false_alarms + plcp_errs
3192 *
3193 * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
3194 * (notice that the start points for OFDM are at or close to settings for
3195 * maximum sensitivity):
3196 *
3197 * START / MIN / MAX
3198 * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120
3199 * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210
3200 * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140
3201 * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270
3202 *
3203 * If actual rate of OFDM false alarms (+ plcp_errors) is too high
3204 * (greater than 50 for each 204.8 msecs listening), reduce sensitivity
3205 * by *adding* 1 to all 4 of the table entries above, up to the max for
3206 * each entry. Conversely, if false alarm rate is too low (less than 5
3207 * for each 204.8 msecs listening), *subtract* 1 from each entry to
3208 * increase sensitivity.
3209 *
3210 * For CCK sensitivity, keep track of the following:
3211 *
3212 * 1). 20-beacon history of maximum background noise, indicated by
3213 * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
3214 * 3 receivers. For any given beacon, the "silence reference" is
3215 * the maximum of last 60 samples (20 beacons * 3 receivers).
3216 *
3217 * 2). 10-beacon history of strongest signal level, as indicated
3218 * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
3219 * i.e. the strength of the signal through the best receiver at the
3220 * moment. These measurements are "upside down", with lower values
3221 * for stronger signals, so max energy will be *minimum* value.
3222 *
3223 * Then for any given beacon, the driver must determine the *weakest*
3224 * of the strongest signals; this is the minimum level that needs to be
3225 * successfully detected, when using the best receiver at the moment.
3226 * "Max cck energy" is the maximum (higher value means lower energy!)
3227 * of the last 10 minima. Once this is determined, driver must add
3228 * a little margin by adding "6" to it.
3229 *
3230 * 3). Number of consecutive beacon periods with too few false alarms.
3231 * Reset this to 0 at the first beacon period that falls within the
3232 * "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
3233 *
3234 * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
3235 * (notice that the start points for CCK are at maximum sensitivity):
3236 *
3237 * START / MIN / MAX
3238 * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200
3239 * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400
3240 * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100
3241 *
3242 * If actual rate of CCK false alarms (+ plcp_errors) is too high
3243 * (greater than 50 for each 204.8 msecs listening), method for reducing
3244 * sensitivity is:
3245 *
3246 * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
3247 * up to max 400.
3248 *
3249 * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
3250 * sensitivity has been reduced a significant amount; bring it up to
3251 * a moderate 161. Otherwise, *add* 3, up to max 200.
3252 *
3253 * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
3254 * sensitivity has been reduced only a moderate or small amount;
3255 * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
3256 * down to min 0. Otherwise (if gain has been significantly reduced),
3257 * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
3258 *
3259 * b) Save a snapshot of the "silence reference".
3260 *
3261 * If actual rate of CCK false alarms (+ plcp_errors) is too low
3262 * (less than 5 for each 204.8 msecs listening), method for increasing
3263 * sensitivity is used only if:
3264 *
3265 * 1a) Previous beacon did not have too many false alarms
3266 * 1b) AND difference between previous "silence reference" and current
3267 * "silence reference" (prev - current) is 2 or more,
3268 * OR 2) 100 or more consecutive beacon periods have had rate of
3269 * less than 5 false alarms per 204.8 milliseconds rx time.
3270 *
3271 * Method for increasing sensitivity:
3272 *
3273 * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
3274 * down to min 125.
3275 *
3276 * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
3277 * down to min 200.
3278 *
3279 * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
3280 *
3281 * If actual rate of CCK false alarms (+ plcp_errors) is within good range
3282 * (between 5 and 50 for each 204.8 msecs listening):
3283 *
3284 * 1) Save a snapshot of the silence reference.
3285 *
3286 * 2) If previous beacon had too many CCK false alarms (+ plcp_errors),
3287 * give some extra margin to energy threshold by *subtracting* 8
3288 * from value in HD_MIN_ENERGY_CCK_DET_INDEX.
3289 *
3290 * For all cases (too few, too many, good range), make sure that the CCK
3291 * detection threshold (energy) is below the energy level for robust
3292 * detection over the past 10 beacon periods, the "Max cck energy".
3293 * Lower values mean higher energy; this means making sure that the value
3294 * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
3295 *
Ben Cahillf7d09d72007-11-29 11:09:51 +08003296 */
Zhu Yib481de92007-09-25 17:54:57 -07003297
Ben Cahillf7d09d72007-11-29 11:09:51 +08003298/*
Emmanuel Grumbachf0832f12008-04-16 16:34:47 -07003299 * Table entries in SENSITIVITY_CMD (struct iwl_sensitivity_cmd)
Ben Cahillf7d09d72007-11-29 11:09:51 +08003300 */
3301#define HD_TABLE_SIZE (11) /* number of entries */
3302#define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */
3303#define HD_MIN_ENERGY_OFDM_DET_INDEX (1)
3304#define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2)
3305#define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3)
3306#define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4)
3307#define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5)
3308#define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6)
3309#define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7)
3310#define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8)
3311#define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9)
3312#define HD_OFDM_ENERGY_TH_IN_INDEX (10)
3313
Emmanuel Grumbachf0832f12008-04-16 16:34:47 -07003314/* Control field in struct iwl_sensitivity_cmd */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08003315#define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE cpu_to_le16(0)
3316#define SENSITIVITY_CMD_CONTROL_WORK_TABLE cpu_to_le16(1)
Ben Cahillf7d09d72007-11-29 11:09:51 +08003317
3318/**
Emmanuel Grumbachf0832f12008-04-16 16:34:47 -07003319 * struct iwl_sensitivity_cmd
Ben Cahillf7d09d72007-11-29 11:09:51 +08003320 * @control: (1) updates working table, (0) updates default table
3321 * @table: energy threshold values, use HD_* as index into table
3322 *
3323 * Always use "1" in "control" to update uCode's working table and DSP.
3324 */
Emmanuel Grumbachf0832f12008-04-16 16:34:47 -07003325struct iwl_sensitivity_cmd {
Ben Cahillf7d09d72007-11-29 11:09:51 +08003326 __le16 control; /* always use "1" */
3327 __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */
Zhu Yib481de92007-09-25 17:54:57 -07003328} __attribute__ ((packed));
3329
Ben Cahillf7d09d72007-11-29 11:09:51 +08003330
3331/**
3332 * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
3333 *
3334 * This command sets the relative gains of 4965's 3 radio receiver chains.
3335 *
3336 * After the first association, driver should accumulate signal and noise
3337 * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
3338 * beacons from the associated network (don't collect statistics that come
3339 * in from scanning, or any other non-network source).
3340 *
3341 * DISCONNECTED ANTENNA:
3342 *
3343 * Driver should determine which antennas are actually connected, by comparing
3344 * average beacon signal levels for the 3 Rx chains. Accumulate (add) the
3345 * following values over 20 beacons, one accumulator for each of the chains
3346 * a/b/c, from struct statistics_rx_non_phy:
3347 *
3348 * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
3349 *
3350 * Find the strongest signal from among a/b/c. Compare the other two to the
3351 * strongest. If any signal is more than 15 dB (times 20, unless you
3352 * divide the accumulated values by 20) below the strongest, the driver
3353 * considers that antenna to be disconnected, and should not try to use that
3354 * antenna/chain for Rx or Tx. If both A and B seem to be disconnected,
3355 * driver should declare the stronger one as connected, and attempt to use it
3356 * (A and B are the only 2 Tx chains!).
3357 *
3358 *
3359 * RX BALANCE:
3360 *
3361 * Driver should balance the 3 receivers (but just the ones that are connected
3362 * to antennas, see above) for gain, by comparing the average signal levels
3363 * detected during the silence after each beacon (background noise).
3364 * Accumulate (add) the following values over 20 beacons, one accumulator for
3365 * each of the chains a/b/c, from struct statistics_rx_non_phy:
3366 *
3367 * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
3368 *
3369 * Find the weakest background noise level from among a/b/c. This Rx chain
3370 * will be the reference, with 0 gain adjustment. Attenuate other channels by
3371 * finding noise difference:
3372 *
3373 * (accum_noise[i] - accum_noise[reference]) / 30
3374 *
3375 * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
3376 * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
3377 * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
3378 * and set bit 2 to indicate "reduce gain". The value for the reference
3379 * (weakest) chain should be "0".
3380 *
3381 * diff_gain_[abc] bit fields:
3382 * 2: (1) reduce gain, (0) increase gain
3383 * 1-0: amount of gain, units of 1.5 dB
3384 */
3385
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003386/* Phy calibration command for series */
Emmanuel Grumbach33fd5032008-04-24 11:55:30 -07003387
3388enum {
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003389 IWL_PHY_CALIBRATE_DIFF_GAIN_CMD = 7,
3390 IWL_PHY_CALIBRATE_DC_CMD = 8,
3391 IWL_PHY_CALIBRATE_LO_CMD = 9,
3392 IWL_PHY_CALIBRATE_RX_BB_CMD = 10,
3393 IWL_PHY_CALIBRATE_TX_IQ_CMD = 11,
3394 IWL_PHY_CALIBRATE_RX_IQ_CMD = 12,
3395 IWL_PHY_CALIBRATION_NOISE_CMD = 13,
3396 IWL_PHY_CALIBRATE_AGC_TABLE_CMD = 14,
3397 IWL_PHY_CALIBRATE_CRYSTAL_FRQ_CMD = 15,
3398 IWL_PHY_CALIBRATE_BASE_BAND_CMD = 16,
3399 IWL_PHY_CALIBRATE_TX_IQ_PERD_CMD = 17,
3400 IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD = 18,
3401 IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD = 19,
Emmanuel Grumbach33fd5032008-04-24 11:55:30 -07003402};
3403
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003404
Harvey Harrison51e9bf52008-11-26 13:12:52 -08003405#define IWL_CALIB_INIT_CFG_ALL cpu_to_le32(0xffffffff)
Tomas Winkler7c616cb2008-05-29 16:35:05 +08003406
3407struct iwl_calib_cfg_elmnt_s {
3408 __le32 is_enable;
3409 __le32 start;
3410 __le32 send_res;
3411 __le32 apply_res;
3412 __le32 reserved;
3413} __attribute__ ((packed));
3414
3415struct iwl_calib_cfg_status_s {
3416 struct iwl_calib_cfg_elmnt_s once;
3417 struct iwl_calib_cfg_elmnt_s perd;
3418 __le32 flags;
3419} __attribute__ ((packed));
3420
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003421struct iwl_calib_cfg_cmd {
Tomas Winkler7c616cb2008-05-29 16:35:05 +08003422 struct iwl_calib_cfg_status_s ucd_calib_cfg;
3423 struct iwl_calib_cfg_status_s drv_calib_cfg;
3424 __le32 reserved1;
3425} __attribute__ ((packed));
3426
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003427struct iwl_calib_hdr {
Tomas Winkler7c616cb2008-05-29 16:35:05 +08003428 u8 op_code;
3429 u8 first_group;
3430 u8 groups_num;
3431 u8 data_valid;
3432} __attribute__ ((packed));
3433
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003434struct iwl_calib_cmd {
3435 struct iwl_calib_hdr hdr;
Tomas Winklerbe5d56e2008-10-08 09:37:27 +08003436 u8 data[0];
3437} __attribute__ ((packed));
3438
Tomas Winkler0d950d82008-11-25 13:36:01 -08003439/* IWL_PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003440struct iwl_calib_diff_gain_cmd {
Tomas Winkler0d950d82008-11-25 13:36:01 -08003441 struct iwl_calib_hdr hdr;
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003442 s8 diff_gain_a; /* see above */
3443 s8 diff_gain_b;
3444 s8 diff_gain_c;
3445 u8 reserved1;
3446} __attribute__ ((packed));
3447
Tomas Winkler0d950d82008-11-25 13:36:01 -08003448struct iwl_calib_xtal_freq_cmd {
3449 struct iwl_calib_hdr hdr;
3450 u8 cap_pin1;
3451 u8 cap_pin2;
3452 u8 pad[2];
Emmanuel Grumbach33fd5032008-04-24 11:55:30 -07003453} __attribute__ ((packed));
3454
Tomas Winkler0d950d82008-11-25 13:36:01 -08003455/* IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD */
3456struct iwl_calib_chain_noise_reset_cmd {
3457 struct iwl_calib_hdr hdr;
3458 u8 data[0];
3459};
3460
3461/* IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD */
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003462struct iwl_calib_chain_noise_gain_cmd {
Tomas Winkler0d950d82008-11-25 13:36:01 -08003463 struct iwl_calib_hdr hdr;
Emmanuel Grumbach33fd5032008-04-24 11:55:30 -07003464 u8 delta_gain_1;
3465 u8 delta_gain_2;
Tomas Winkler0d950d82008-11-25 13:36:01 -08003466 u8 pad[2];
Emmanuel Grumbach33fd5032008-04-24 11:55:30 -07003467} __attribute__ ((packed));
3468
Zhu Yib481de92007-09-25 17:54:57 -07003469/******************************************************************************
3470 * (12)
3471 * Miscellaneous Commands:
3472 *
3473 *****************************************************************************/
3474
3475/*
3476 * LEDs Command & Response
3477 * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
3478 *
3479 * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
3480 * this command turns it on or off, or sets up a periodic blinking cycle.
3481 */
Tomas Winklerec1a7462008-07-11 11:53:37 +08003482struct iwl_led_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07003483 __le32 interval; /* "interval" in uSec */
3484 u8 id; /* 1: Activity, 2: Link, 3: Tech */
3485 u8 off; /* # intervals off while blinking;
3486 * "0", with >0 "on" value, turns LED on */
3487 u8 on; /* # intervals on while blinking;
3488 * "0", regardless of "off", turns LED off */
3489 u8 reserved;
3490} __attribute__ ((packed));
3491
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003492/*
3493 * Coexistence WIFI/WIMAX Command
3494 * COEX_PRIORITY_TABLE_CMD = 0x5a
3495 *
3496 */
3497enum {
3498 COEX_UNASSOC_IDLE = 0,
3499 COEX_UNASSOC_MANUAL_SCAN = 1,
3500 COEX_UNASSOC_AUTO_SCAN = 2,
3501 COEX_CALIBRATION = 3,
3502 COEX_PERIODIC_CALIBRATION = 4,
3503 COEX_CONNECTION_ESTAB = 5,
3504 COEX_ASSOCIATED_IDLE = 6,
3505 COEX_ASSOC_MANUAL_SCAN = 7,
3506 COEX_ASSOC_AUTO_SCAN = 8,
3507 COEX_ASSOC_ACTIVE_LEVEL = 9,
3508 COEX_RF_ON = 10,
3509 COEX_RF_OFF = 11,
3510 COEX_STAND_ALONE_DEBUG = 12,
3511 COEX_IPAN_ASSOC_LEVEL = 13,
3512 COEX_RSRVD1 = 14,
3513 COEX_RSRVD2 = 15,
3514 COEX_NUM_OF_EVENTS = 16
3515};
3516
3517struct iwl_wimax_coex_event_entry {
3518 u8 request_prio;
3519 u8 win_medium_prio;
3520 u8 reserved;
3521 u8 flags;
3522} __attribute__ ((packed));
3523
3524/* COEX flag masks */
3525
Tomas Winklera96a27f2008-10-23 23:48:56 -07003526/* Station table is valid */
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003527#define COEX_FLAGS_STA_TABLE_VALID_MSK (0x1)
Tomas Winklera96a27f2008-10-23 23:48:56 -07003528/* UnMask wake up src at unassociated sleep */
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003529#define COEX_FLAGS_UNASSOC_WA_UNMASK_MSK (0x4)
Tomas Winklera96a27f2008-10-23 23:48:56 -07003530/* UnMask wake up src at associated sleep */
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003531#define COEX_FLAGS_ASSOC_WA_UNMASK_MSK (0x8)
3532/* Enable CoEx feature. */
3533#define COEX_FLAGS_COEX_ENABLE_MSK (0x80)
3534
3535struct iwl_wimax_coex_cmd {
3536 u8 flags;
3537 u8 reserved[3];
3538 struct iwl_wimax_coex_event_entry sta_prio[COEX_NUM_OF_EVENTS];
3539} __attribute__ ((packed));
3540
Zhu Yib481de92007-09-25 17:54:57 -07003541/******************************************************************************
3542 * (13)
3543 * Union of all expected notifications/responses:
3544 *
3545 *****************************************************************************/
3546
Tomas Winklerdb11d632008-05-05 10:22:33 +08003547struct iwl_rx_packet {
Zhu Yi2f301222009-10-09 17:19:45 +08003548 /*
3549 * The first 4 bytes of the RX frame header contain both the RX frame
3550 * size and some flags.
3551 * Bit fields:
3552 * 31: flag flush RB request
3553 * 30: flag ignore TC (terminal counter) request
3554 * 29: flag fast IRQ request
3555 * 28-14: Reserved
3556 * 13-00: RX frame size
3557 */
Daniel C Halperin396887a2009-08-13 13:31:01 -07003558 __le32 len_n_flags;
Tomas Winkler857485c2008-03-21 13:53:44 -07003559 struct iwl_cmd_header hdr;
Zhu Yib481de92007-09-25 17:54:57 -07003560 union {
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08003561 struct iwl3945_rx_frame rx_frame;
3562 struct iwl3945_tx_resp tx_resp;
3563 struct iwl3945_beacon_notif beacon_status;
3564
Tomas Winkler885ba202008-05-29 16:34:55 +08003565 struct iwl_alive_resp alive_frame;
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08003566 struct iwl_spectrum_notification spectrum_notif;
3567 struct iwl_csa_notification csa_notif;
Tomas Winkler885ba202008-05-29 16:34:55 +08003568 struct iwl_error_resp err_resp;
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08003569 struct iwl_card_state_notif card_state_notif;
Tomas Winkler7a999bf2008-05-29 16:35:02 +08003570 struct iwl_add_sta_resp add_sta;
3571 struct iwl_rem_sta_resp rem_sta;
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08003572 struct iwl_sleep_notification sleep_notif;
3573 struct iwl_spectrum_resp spectrum;
Emmanuel Grumbach8f91aec2008-06-30 17:23:07 +08003574 struct iwl_notif_statistics stats;
Emmanuel Grumbach653fa4a2008-06-30 17:23:11 +08003575 struct iwl_compressed_ba_resp compressed_ba;
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08003576 struct iwl_missed_beacon_notif missed_beacon;
Zhu Yib481de92007-09-25 17:54:57 -07003577 __le32 status;
3578 u8 raw[0];
3579 } u;
3580} __attribute__ ((packed));
3581
Samuel Ortiza3139c52008-12-19 10:37:09 +08003582int iwl_agn_check_rxon_cmd(struct iwl_priv *priv);
Winkler, Tomas8f5c87d2008-12-02 12:13:57 -08003583
Emmanuel Grumbach6a635782008-10-29 14:05:47 -07003584#endif /* __iwl_commands_h__ */