blob: 5fdad6532118884aebdbf9854597cbf2e0928ad6 [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 *
Wey-Yi Guy901069c2011-04-05 09:42:00 -07008 * Copyright(c) 2005 - 2011 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 *
Wey-Yi Guy901069c2011-04-05 09:42:00 -070033 * Copyright(c) 2005 - 2011 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.
Wey-Yi Guy767d0552010-08-23 07:56:53 -070065 * Please use iwl-xxxx-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,
Wey-Yi Guyfc66be22010-05-14 16:21:55 -070098 REPLY_REMOVE_STA = 0x19,
Zhu Yib481de92007-09-25 17:54:57 -070099 REPLY_REMOVE_ALL_STA = 0x1a, /* not used */
Wey-Yi Guy947279e2010-06-24 13:18:33 -0700100 REPLY_TXFIFO_FLUSH = 0x1e,
Zhu Yib481de92007-09-25 17:54:57 -0700101
Emmanuel Grumbach0a0bed12008-04-14 21:16:05 -0700102 /* Security */
103 REPLY_WEPKEY = 0x20,
104
Zhu Yib481de92007-09-25 17:54:57 -0700105 /* RX, TX, LEDs */
Zhu Yib481de92007-09-25 17:54:57 -0700106 REPLY_TX = 0x1c,
Zhu Yib481de92007-09-25 17:54:57 -0700107 REPLY_LEDS_CMD = 0x48,
Wey-Yi Guy4c8d1912010-03-31 18:16:52 -0700108 REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* for 4965 and up */
Zhu Yib481de92007-09-25 17:54:57 -0700109
Ron Rindjunsky9636e582008-05-15 13:54:14 +0800110 /* WiMAX coexistence */
Wey-Yi Guyd23000c2009-10-23 13:42:36 -0700111 COEX_PRIORITY_TABLE_CMD = 0x5a, /* for 5000 series and up */
Ron Rindjunsky9636e582008-05-15 13:54:14 +0800112 COEX_MEDIUM_NOTIFICATION = 0x5b,
113 COEX_EVENT_CMD = 0x5c,
114
Tomas Winklerbe5d56e2008-10-08 09:37:27 +0800115 /* Calibration */
Jay Sternberg1a5c3d62009-10-23 13:42:19 -0700116 TEMPERATURE_NOTIFICATION = 0x62,
Tomas Winklerbe5d56e2008-10-08 09:37:27 +0800117 CALIBRATION_CFG_CMD = 0x65,
118 CALIBRATION_RES_NOTIFICATION = 0x66,
119 CALIBRATION_COMPLETE_NOTIFICATION = 0x67,
120
Zhu Yib481de92007-09-25 17:54:57 -0700121 /* 802.11h related */
Zhu Yib481de92007-09-25 17:54:57 -0700122 REPLY_QUIET_CMD = 0x71, /* not used */
123 REPLY_CHANNEL_SWITCH = 0x72,
124 CHANNEL_SWITCH_NOTIFICATION = 0x73,
125 REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
126 SPECTRUM_MEASURE_NOTIFICATION = 0x75,
127
128 /* Power Management */
129 POWER_TABLE_CMD = 0x77,
130 PM_SLEEP_NOTIFICATION = 0x7A,
131 PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
132
133 /* Scan commands and notifications */
134 REPLY_SCAN_CMD = 0x80,
135 REPLY_SCAN_ABORT_CMD = 0x81,
136 SCAN_START_NOTIFICATION = 0x82,
137 SCAN_RESULTS_NOTIFICATION = 0x83,
138 SCAN_COMPLETE_NOTIFICATION = 0x84,
139
140 /* IBSS/AP commands */
141 BEACON_NOTIFICATION = 0x90,
142 REPLY_TX_BEACON = 0x91,
143 WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */
144
145 /* Miscellaneous commands */
Jay Sternberg76a24072009-01-29 11:09:14 -0800146 REPLY_TX_POWER_DBM_CMD = 0x95,
Zhu Yib481de92007-09-25 17:54:57 -0700147 QUIET_NOTIFICATION = 0x96, /* not used */
148 REPLY_TX_PWR_TABLE_CMD = 0x97,
Jay Sternberg76a24072009-01-29 11:09:14 -0800149 REPLY_TX_POWER_DBM_CMD_V1 = 0x98, /* old version of API */
Wey-Yi Guy2f748de2009-09-17 10:43:51 -0700150 TX_ANT_CONFIGURATION_CMD = 0x98,
Zhu Yib481de92007-09-25 17:54:57 -0700151 MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */
152
Tomas Winklera96a27f2008-10-23 23:48:56 -0700153 /* Bluetooth device coexistence config command */
Zhu Yib481de92007-09-25 17:54:57 -0700154 REPLY_BT_CONFIG = 0x9b,
155
Ben Cahill80cc0c32007-11-29 11:10:09 +0800156 /* Statistics */
Zhu Yib481de92007-09-25 17:54:57 -0700157 REPLY_STATISTICS_CMD = 0x9c,
158 STATISTICS_NOTIFICATION = 0x9d,
159
160 /* RF-KILL commands and notifications */
161 REPLY_CARD_STATE_CMD = 0xa0,
162 CARD_STATE_NOTIFICATION = 0xa1,
163
164 /* Missed beacons notification */
165 MISSED_BEACONS_NOTIFICATION = 0xa2,
166
Zhu Yib481de92007-09-25 17:54:57 -0700167 REPLY_CT_KILL_CONFIG_CMD = 0xa4,
168 SENSITIVITY_CMD = 0xa8,
169 REPLY_PHY_CALIBRATION_CMD = 0xb0,
170 REPLY_RX_PHY_CMD = 0xc0,
171 REPLY_RX_MPDU_CMD = 0xc1,
Tomas Winkler857485c2008-03-21 13:53:44 -0700172 REPLY_RX = 0xc3,
Zhu Yib481de92007-09-25 17:54:57 -0700173 REPLY_COMPRESSED_BA = 0xc5,
Johannes Berg0288d232010-08-23 07:56:54 -0700174
175 /* BT Coex */
176 REPLY_BT_COEX_PRIO_TABLE = 0xcc,
177 REPLY_BT_COEX_PROT_ENV = 0xcd,
178 REPLY_BT_COEX_PROFILE_NOTIF = 0xce,
179
Johannes Berg946ba302010-08-23 10:46:48 +0200180 /* PAN commands */
181 REPLY_WIPAN_PARAMS = 0xb2,
182 REPLY_WIPAN_RXON = 0xb3, /* use REPLY_RXON structure */
183 REPLY_WIPAN_RXON_TIMING = 0xb4, /* use REPLY_RXON_TIMING structure */
184 REPLY_WIPAN_RXON_ASSOC = 0xb6, /* use REPLY_RXON_ASSOC structure */
185 REPLY_WIPAN_QOS_PARAM = 0xb7, /* use REPLY_QOS_PARAM structure */
186 REPLY_WIPAN_WEPKEY = 0xb8, /* use REPLY_WEPKEY structure */
187 REPLY_WIPAN_P2P_CHANNEL_SWITCH = 0xb9,
188 REPLY_WIPAN_NOA_NOTIFICATION = 0xbc,
Johannes Berg311dce72011-01-04 16:22:01 -0800189 REPLY_WIPAN_DEACTIVATION_COMPLETE = 0xbd,
Johannes Berg946ba302010-08-23 10:46:48 +0200190
Zhu Yib481de92007-09-25 17:54:57 -0700191 REPLY_MAX = 0xff
192};
193
194/******************************************************************************
195 * (0)
Ben Cahillabceddb2007-11-29 11:09:50 +0800196 * Commonly used structures and definitions:
Ben Cahill80cc0c32007-11-29 11:10:09 +0800197 * Command header, rate_n_flags, txpower
Zhu Yib481de92007-09-25 17:54:57 -0700198 *
199 *****************************************************************************/
200
Tomas Winkler857485c2008-03-21 13:53:44 -0700201/* iwl_cmd_header flags value */
Zhu Yib481de92007-09-25 17:54:57 -0700202#define IWL_CMD_FAILED_MSK 0x40
203
Tomas Winkler9734cb22008-09-03 11:26:52 +0800204#define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
205#define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
206#define SEQ_TO_INDEX(s) ((s) & 0xff)
207#define INDEX_TO_SEQ(i) ((i) & 0xff)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800208#define SEQ_HUGE_FRAME cpu_to_le16(0x4000)
209#define SEQ_RX_FRAME cpu_to_le16(0x8000)
Tomas Winkler9734cb22008-09-03 11:26:52 +0800210
Ben Cahill075416c2007-11-29 11:10:08 +0800211/**
Tomas Winkler857485c2008-03-21 13:53:44 -0700212 * struct iwl_cmd_header
Ben Cahill075416c2007-11-29 11:10:08 +0800213 *
214 * This header format appears in the beginning of each command sent from the
215 * driver, and each response/notification received from uCode.
216 */
Tomas Winkler857485c2008-03-21 13:53:44 -0700217struct iwl_cmd_header {
Ben Cahill075416c2007-11-29 11:10:08 +0800218 u8 cmd; /* Command ID: REPLY_RXON, etc. */
Tomas Winkler9734cb22008-09-03 11:26:52 +0800219 u8 flags; /* 0:5 reserved, 6 abort, 7 internal */
Ben Cahill075416c2007-11-29 11:10:08 +0800220 /*
Tomas Winklera96a27f2008-10-23 23:48:56 -0700221 * The driver sets up the sequence number to values of its choosing.
Ben Cahill075416c2007-11-29 11:10:08 +0800222 * uCode does not use this value, but passes it back to the driver
223 * when sending the response to each driver-originated command, so
224 * the driver can match the response to the command. Since the values
225 * don't get used by uCode, the driver may set up an arbitrary format.
Zhu Yib481de92007-09-25 17:54:57 -0700226 *
Ben Cahill075416c2007-11-29 11:10:08 +0800227 * There is one exception: uCode sets bit 15 when it originates
228 * the response/notification, i.e. when the response/notification
229 * is not a direct response to a command sent by the driver. For
Johannes Berg3240cab2011-04-05 09:41:49 -0700230 * example, uCode issues REPLY_RX when it sends a received frame
Ben Cahill075416c2007-11-29 11:10:08 +0800231 * to the driver; it is not a direct response to any driver command.
Zhu Yib481de92007-09-25 17:54:57 -0700232 *
Ben Cahill075416c2007-11-29 11:10:08 +0800233 * The Linux driver uses the following format:
234 *
Tomas Winkler9734cb22008-09-03 11:26:52 +0800235 * 0:7 tfd index - position within TX queue
236 * 8:12 TX queue id
237 * 13 reserved
238 * 14 huge - driver sets this to indicate command is in the
239 * 'huge' storage at the end of the command buffers
240 * 15 unsolicited RX or uCode-originated notification
Zhu Yib481de92007-09-25 17:54:57 -0700241 */
242 __le16 sequence;
243
Ben Cahill075416c2007-11-29 11:10:08 +0800244 /* command or response/notification data follows immediately */
Zhu Yib481de92007-09-25 17:54:57 -0700245 u8 data[0];
Eric Dumazetba2d3582010-06-02 18:10:09 +0000246} __packed;
Zhu Yib481de92007-09-25 17:54:57 -0700247
Tomas Winkler3d24a9f2008-12-19 10:37:07 +0800248
249/**
Halperin, Daniel C5c5aa3f2008-11-07 09:58:38 -0800250 * iwlagn rate_n_flags bit fields
Ben Cahillabceddb2007-11-29 11:09:50 +0800251 *
Halperin, Daniel C5c5aa3f2008-11-07 09:58:38 -0800252 * rate_n_flags format is used in following iwlagn commands:
Tomas Winkler857485c2008-03-21 13:53:44 -0700253 * REPLY_RX (response only)
Halperin, Daniel C5c5aa3f2008-11-07 09:58:38 -0800254 * REPLY_RX_MPDU (response only)
Ben Cahillabceddb2007-11-29 11:09:50 +0800255 * REPLY_TX (both command and response)
256 * REPLY_TX_LINK_QUALITY_CMD
257 *
258 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
259 * 2-0: 0) 6 Mbps
260 * 1) 12 Mbps
261 * 2) 18 Mbps
262 * 3) 24 Mbps
263 * 4) 36 Mbps
264 * 5) 48 Mbps
265 * 6) 54 Mbps
266 * 7) 60 Mbps
267 *
Halperin, Daniel C5c5aa3f2008-11-07 09:58:38 -0800268 * 4-3: 0) Single stream (SISO)
Ben Cahillabceddb2007-11-29 11:09:50 +0800269 * 1) Dual stream (MIMO)
Halperin, Daniel C5c5aa3f2008-11-07 09:58:38 -0800270 * 2) Triple stream (MIMO)
Ben Cahillabceddb2007-11-29 11:09:50 +0800271 *
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700272 * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data
Ben Cahillabceddb2007-11-29 11:09:50 +0800273 *
274 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
275 * 3-0: 0xD) 6 Mbps
276 * 0xF) 9 Mbps
277 * 0x5) 12 Mbps
278 * 0x7) 18 Mbps
279 * 0x9) 24 Mbps
280 * 0xB) 36 Mbps
281 * 0x1) 48 Mbps
282 * 0x3) 54 Mbps
283 *
284 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
Daniel Wu10617872008-12-20 10:53:29 -0800285 * 6-0: 10) 1 Mbps
Ben Cahillabceddb2007-11-29 11:09:50 +0800286 * 20) 2 Mbps
287 * 55) 5.5 Mbps
288 * 110) 11 Mbps
289 */
290#define RATE_MCS_CODE_MSK 0x7
Halperin, Daniel C5c5aa3f2008-11-07 09:58:38 -0800291#define RATE_MCS_SPATIAL_POS 3
292#define RATE_MCS_SPATIAL_MSK 0x18
Ben Cahillabceddb2007-11-29 11:09:50 +0800293#define RATE_MCS_HT_DUP_POS 5
294#define RATE_MCS_HT_DUP_MSK 0x20
Daniel Halperin25205462011-03-18 18:48:55 -0700295/* Both legacy and HT use bits 7:0 as the CCK/OFDM rate or HT MCS */
296#define RATE_MCS_RATE_MSK 0xff
Ben Cahillabceddb2007-11-29 11:09:50 +0800297
Ben Cahill075416c2007-11-29 11:10:08 +0800298/* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
Ben Cahillabceddb2007-11-29 11:09:50 +0800299#define RATE_MCS_FLAGS_POS 8
300#define RATE_MCS_HT_POS 8
301#define RATE_MCS_HT_MSK 0x100
302
Ben Cahill075416c2007-11-29 11:10:08 +0800303/* 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 +0800304#define RATE_MCS_CCK_POS 9
305#define RATE_MCS_CCK_MSK 0x200
306
Ben Cahill075416c2007-11-29 11:10:08 +0800307/* Bit 10: (1) Use Green Field preamble */
Ben Cahillabceddb2007-11-29 11:09:50 +0800308#define RATE_MCS_GF_POS 10
309#define RATE_MCS_GF_MSK 0x400
310
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700311/* Bit 11: (1) Use 40Mhz HT40 chnl width, (0) use 20 MHz legacy chnl width */
312#define RATE_MCS_HT40_POS 11
313#define RATE_MCS_HT40_MSK 0x800
Ben Cahillabceddb2007-11-29 11:09:50 +0800314
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700315/* Bit 12: (1) Duplicate data on both 20MHz chnls. HT40 (bit 11) must be set. */
Ben Cahillabceddb2007-11-29 11:09:50 +0800316#define RATE_MCS_DUP_POS 12
317#define RATE_MCS_DUP_MSK 0x1000
318
Ben Cahill075416c2007-11-29 11:10:08 +0800319/* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
Ben Cahillabceddb2007-11-29 11:09:50 +0800320#define RATE_MCS_SGI_POS 13
321#define RATE_MCS_SGI_MSK 0x2000
322
323/**
Tomas Winkler76eff182008-10-14 12:32:45 -0700324 * rate_n_flags Tx antenna masks
325 * 4965 has 2 transmitters
326 * 5100 has 1 transmitter B
327 * 5150 has 1 transmitter A
328 * 5300 has 3 transmitters
329 * 5350 has 3 transmitters
330 * bit14:16
Ben Cahillabceddb2007-11-29 11:09:50 +0800331 */
Tomas Winkler600c0e12008-12-19 10:37:04 +0800332#define RATE_MCS_ANT_POS 14
333#define RATE_MCS_ANT_A_MSK 0x04000
334#define RATE_MCS_ANT_B_MSK 0x08000
335#define RATE_MCS_ANT_C_MSK 0x10000
336#define RATE_MCS_ANT_AB_MSK (RATE_MCS_ANT_A_MSK | RATE_MCS_ANT_B_MSK)
337#define RATE_MCS_ANT_ABC_MSK (RATE_MCS_ANT_AB_MSK | RATE_MCS_ANT_C_MSK)
Tomas Winkler76eff182008-10-14 12:32:45 -0700338#define RATE_ANT_NUM 3
Ben Cahill80cc0c32007-11-29 11:10:09 +0800339
340#define POWER_TABLE_NUM_ENTRIES 33
341#define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32
342#define POWER_TABLE_CCK_ENTRY 32
343
Wey-Yi Guye57f1482009-10-09 13:20:34 -0700344#define IWL_PWR_NUM_HT_OFDM_ENTRIES 24
345#define IWL_PWR_CCK_ENTRIES 2
346
Ben Cahill80cc0c32007-11-29 11:10:09 +0800347/**
Ben Cahill80cc0c32007-11-29 11:10:09 +0800348 * struct tx_power_dual_stream
349 *
350 * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
351 *
352 * Same format as iwl_tx_power_dual_stream, but __le32
353 */
354struct tx_power_dual_stream {
355 __le32 dw;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000356} __packed;
Ben Cahill80cc0c32007-11-29 11:10:09 +0800357
358/**
Tomas Winklera96a27f2008-10-23 23:48:56 -0700359 * Command REPLY_TX_POWER_DBM_CMD = 0x98
Wey-Yi Guyab63c682010-09-20 09:12:31 -0700360 * struct iwlagn_tx_power_dbm_cmd
Tomas Winkler630fe9b2008-06-12 09:47:08 +0800361 */
Wey-Yi Guyab63c682010-09-20 09:12:31 -0700362#define IWLAGN_TX_POWER_AUTO 0x7f
363#define IWLAGN_TX_POWER_NO_CLOSED (0x1 << 6)
Gregory Greenman853554a2008-06-30 17:23:01 +0800364
Wey-Yi Guyab63c682010-09-20 09:12:31 -0700365struct iwlagn_tx_power_dbm_cmd {
Tomas Winkler630fe9b2008-06-12 09:47:08 +0800366 s8 global_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
367 u8 flags;
368 s8 srv_chan_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
369 u8 reserved;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000370} __packed;
Ben Cahill80cc0c32007-11-29 11:10:09 +0800371
Wey-Yi Guy2f748de2009-09-17 10:43:51 -0700372/**
373 * Command TX_ANT_CONFIGURATION_CMD = 0x98
374 * This command is used to configure valid Tx antenna.
375 * By default uCode concludes the valid antenna according to the radio flavor.
376 * This command enables the driver to override/modify this conclusion.
377 */
378struct iwl_tx_ant_config_cmd {
379 __le32 valid;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000380} __packed;
Wey-Yi Guy2f748de2009-09-17 10:43:51 -0700381
Zhu Yib481de92007-09-25 17:54:57 -0700382/******************************************************************************
383 * (0a)
384 * Alive and Error Commands & Responses:
385 *
386 *****************************************************************************/
387
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800388#define UCODE_VALID_OK cpu_to_le32(0x1)
Johannes Bergca7966c2011-04-22 10:15:23 -0700389
390enum iwlagn_ucode_subtype {
391 UCODE_SUBTYPE_REGULAR = 0,
392 UCODE_SUBTYPE_REGULAR_NEW = 1,
393 UCODE_SUBTYPE_INIT = 9,
394
395 /*
396 * Not a valid subtype, the ucode has just a u8, so
397 * we can use something > 0xff for this value.
398 */
399 UCODE_SUBTYPE_NONE_LOADED = 0x100,
400};
Zhu Yib481de92007-09-25 17:54:57 -0700401
Ben Cahill075416c2007-11-29 11:10:08 +0800402/**
403 * REPLY_ALIVE = 0x1 (response only, not a command)
404 *
405 * uCode issues this "alive" notification once the runtime image is ready
406 * to receive commands from the driver. This is the *second* "alive"
407 * notification that the driver will receive after rebooting uCode;
408 * this "alive" is indicated by subtype field != 9.
409 *
410 * See comments documenting "BSM" (bootstrap state machine).
411 *
412 * This response includes two pointers to structures within the device's
413 * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
414 *
415 * 1) log_event_table_ptr indicates base of the event log. This traces
416 * a 256-entry history of uCode execution within a circular buffer.
417 * Its header format is:
418 *
419 * __le32 log_size; log capacity (in number of entries)
420 * __le32 type; (1) timestamp with each entry, (0) no timestamp
421 * __le32 wraps; # times uCode has wrapped to top of circular buffer
422 * __le32 write_index; next circular buffer entry that uCode would fill
423 *
424 * The header is followed by the circular buffer of log entries. Entries
425 * with timestamps have the following format:
426 *
427 * __le32 event_id; range 0 - 1500
428 * __le32 timestamp; low 32 bits of TSF (of network, if associated)
429 * __le32 data; event_id-specific data value
430 *
431 * Entries without timestamps contain only event_id and data.
432 *
Wey-Yi Guy461ef382010-03-30 17:57:53 -0700433 *
Ben Cahill075416c2007-11-29 11:10:08 +0800434 * 2) error_event_table_ptr indicates base of the error log. This contains
Wey-Yi Guy461ef382010-03-30 17:57:53 -0700435 * information about any uCode error that occurs. For agn, the format
Johannes Berge46f6532011-04-13 03:14:43 -0700436 * of the error log is defined by struct iwl_error_event_table.
Ben Cahill075416c2007-11-29 11:10:08 +0800437 *
438 * The Linux driver can print both logs to the system log when a uCode error
439 * occurs.
440 */
Johannes Berge46f6532011-04-13 03:14:43 -0700441
442/*
443 * Note: This structure is read from the device with IO accesses,
444 * and the reading already does the endian conversion. As it is
445 * read with u32-sized accesses, any members with a different size
446 * need to be ordered correctly though!
447 */
448struct iwl_error_event_table {
449 u32 valid; /* (nonzero) valid, (0) log is empty */
450 u32 error_id; /* type of error */
451 u32 pc; /* program counter */
452 u32 blink1; /* branch link */
453 u32 blink2; /* branch link */
454 u32 ilink1; /* interrupt link */
455 u32 ilink2; /* interrupt link */
456 u32 data1; /* error-specific data */
457 u32 data2; /* error-specific data */
458 u32 line; /* source code line of error */
459 u32 bcon_time; /* beacon timer */
460 u32 tsf_low; /* network timestamp function timer */
461 u32 tsf_hi; /* network timestamp function timer */
462 u32 gp1; /* GP1 timer register */
463 u32 gp2; /* GP2 timer register */
464 u32 gp3; /* GP3 timer register */
465 u32 ucode_ver; /* uCode version */
466 u32 hw_ver; /* HW Silicon version */
467 u32 brd_ver; /* HW board version */
468 u32 log_pc; /* log program counter */
469 u32 frame_ptr; /* frame pointer */
470 u32 stack_ptr; /* stack pointer */
471 u32 hcmd; /* last host command header */
472#if 0
473 /* no need to read the remainder, we don't use the values */
474 u32 isr0; /* isr status register LMPM_NIC_ISR0: rxtx_flag */
475 u32 isr1; /* isr status register LMPM_NIC_ISR1: host_flag */
476 u32 isr2; /* isr status register LMPM_NIC_ISR2: enc_flag */
477 u32 isr3; /* isr status register LMPM_NIC_ISR3: time_flag */
478 u32 isr4; /* isr status register LMPM_NIC_ISR4: wico interrupt */
479 u32 isr_pref; /* isr status register LMPM_NIC_PREF_STAT */
480 u32 wait_event; /* wait event() caller address */
481 u32 l2p_control; /* L2pControlField */
482 u32 l2p_duration; /* L2pDurationField */
483 u32 l2p_mhvalid; /* L2pMhValidBits */
484 u32 l2p_addr_match; /* L2pAddrMatchStat */
485 u32 lmpm_pmg_sel; /* indicate which clocks are turned on (LMPM_PMG_SEL) */
486 u32 u_timestamp; /* indicate when the date and time of the compilation */
487 u32 flow_handler; /* FH read/write pointers, RX credit */
488#endif
489} __packed;
490
Tomas Winkler885ba202008-05-29 16:34:55 +0800491struct iwl_alive_resp {
Ben Cahill075416c2007-11-29 11:10:08 +0800492 u8 ucode_minor;
493 u8 ucode_major;
494 __le16 reserved1;
495 u8 sw_rev[8];
496 u8 ver_type;
497 u8 ver_subtype; /* not "9" for runtime alive */
498 __le16 reserved2;
499 __le32 log_event_table_ptr; /* SRAM address for event log */
500 __le32 error_event_table_ptr; /* SRAM address for error log */
501 __le32 timestamp;
502 __le32 is_valid;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000503} __packed;
Ben Cahill075416c2007-11-29 11:10:08 +0800504
Zhu Yib481de92007-09-25 17:54:57 -0700505/*
506 * REPLY_ERROR = 0x2 (response only, not a command)
507 */
Tomas Winkler885ba202008-05-29 16:34:55 +0800508struct iwl_error_resp {
Zhu Yib481de92007-09-25 17:54:57 -0700509 __le32 error_type;
510 u8 cmd_id;
511 u8 reserved1;
512 __le16 bad_cmd_seq_num;
Zhu Yib481de92007-09-25 17:54:57 -0700513 __le32 error_info;
Tomas Winkler3195c1f2008-10-08 09:37:30 +0800514 __le64 timestamp;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000515} __packed;
Zhu Yib481de92007-09-25 17:54:57 -0700516
517/******************************************************************************
518 * (1)
519 * RXON Commands & Responses:
520 *
521 *****************************************************************************/
522
523/*
524 * Rx config defines & structure
525 */
526/* rx_config device types */
527enum {
528 RXON_DEV_TYPE_AP = 1,
529 RXON_DEV_TYPE_ESS = 3,
530 RXON_DEV_TYPE_IBSS = 4,
531 RXON_DEV_TYPE_SNIFFER = 6,
Johannes Berg946ba302010-08-23 10:46:48 +0200532 RXON_DEV_TYPE_CP = 7,
533 RXON_DEV_TYPE_2STA = 8,
534 RXON_DEV_TYPE_P2P = 9,
Zhu Yib481de92007-09-25 17:54:57 -0700535};
536
Ben Cahill14519a02007-11-29 11:09:59 +0800537
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800538#define RXON_RX_CHAIN_DRIVER_FORCE_MSK cpu_to_le16(0x1 << 0)
Rick Farrington7b841722009-01-23 13:45:10 -0800539#define RXON_RX_CHAIN_DRIVER_FORCE_POS (0)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800540#define RXON_RX_CHAIN_VALID_MSK cpu_to_le16(0x7 << 1)
Ben Cahill14519a02007-11-29 11:09:59 +0800541#define RXON_RX_CHAIN_VALID_POS (1)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800542#define RXON_RX_CHAIN_FORCE_SEL_MSK cpu_to_le16(0x7 << 4)
Ben Cahill14519a02007-11-29 11:09:59 +0800543#define RXON_RX_CHAIN_FORCE_SEL_POS (4)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800544#define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK cpu_to_le16(0x7 << 7)
Ben Cahill14519a02007-11-29 11:09:59 +0800545#define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800546#define RXON_RX_CHAIN_CNT_MSK cpu_to_le16(0x3 << 10)
Ben Cahill14519a02007-11-29 11:09:59 +0800547#define RXON_RX_CHAIN_CNT_POS (10)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800548#define RXON_RX_CHAIN_MIMO_CNT_MSK cpu_to_le16(0x3 << 12)
Ben Cahill14519a02007-11-29 11:09:59 +0800549#define RXON_RX_CHAIN_MIMO_CNT_POS (12)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800550#define RXON_RX_CHAIN_MIMO_FORCE_MSK cpu_to_le16(0x1 << 14)
Ben Cahill14519a02007-11-29 11:09:59 +0800551#define RXON_RX_CHAIN_MIMO_FORCE_POS (14)
552
Zhu Yib481de92007-09-25 17:54:57 -0700553/* rx_config flags */
554/* band & modulation selection */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800555#define RXON_FLG_BAND_24G_MSK cpu_to_le32(1 << 0)
556#define RXON_FLG_CCK_MSK cpu_to_le32(1 << 1)
Zhu Yib481de92007-09-25 17:54:57 -0700557/* auto detection enable */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800558#define RXON_FLG_AUTO_DETECT_MSK cpu_to_le32(1 << 2)
Zhu Yib481de92007-09-25 17:54:57 -0700559/* TGg protection when tx */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800560#define RXON_FLG_TGG_PROTECT_MSK cpu_to_le32(1 << 3)
Zhu Yib481de92007-09-25 17:54:57 -0700561/* cck short slot & preamble */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800562#define RXON_FLG_SHORT_SLOT_MSK cpu_to_le32(1 << 4)
563#define RXON_FLG_SHORT_PREAMBLE_MSK cpu_to_le32(1 << 5)
Zhu Yib481de92007-09-25 17:54:57 -0700564/* antenna selection */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800565#define RXON_FLG_DIS_DIV_MSK cpu_to_le32(1 << 7)
566#define RXON_FLG_ANT_SEL_MSK cpu_to_le32(0x0f00)
567#define RXON_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
568#define RXON_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
Zhu Yib481de92007-09-25 17:54:57 -0700569/* radar detection enable */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800570#define RXON_FLG_RADAR_DETECT_MSK cpu_to_le32(1 << 12)
571#define RXON_FLG_TGJ_NARROW_BAND_MSK cpu_to_le32(1 << 13)
Zhu Yib481de92007-09-25 17:54:57 -0700572/* rx response to host with 8-byte TSF
573* (according to ON_AIR deassertion) */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800574#define RXON_FLG_TSF2HOST_MSK cpu_to_le32(1 << 15)
Zhu Yib481de92007-09-25 17:54:57 -0700575
Ben Cahill14519a02007-11-29 11:09:59 +0800576
577/* HT flags */
578#define RXON_FLG_CTRL_CHANNEL_LOC_POS (22)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800579#define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK cpu_to_le32(0x1 << 22)
Ben Cahill14519a02007-11-29 11:09:59 +0800580
581#define RXON_FLG_HT_OPERATING_MODE_POS (23)
582
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800583#define RXON_FLG_HT_PROT_MSK cpu_to_le32(0x1 << 23)
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700584#define RXON_FLG_HT40_PROT_MSK cpu_to_le32(0x2 << 23)
Ben Cahill14519a02007-11-29 11:09:59 +0800585
586#define RXON_FLG_CHANNEL_MODE_POS (25)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800587#define RXON_FLG_CHANNEL_MODE_MSK cpu_to_le32(0x3 << 25)
Wey-Yi Guya2b0f022009-05-22 11:01:49 -0700588
589/* channel mode */
590enum {
591 CHANNEL_MODE_LEGACY = 0,
592 CHANNEL_MODE_PURE_40 = 1,
593 CHANNEL_MODE_MIXED = 2,
594 CHANNEL_MODE_RESERVED = 3,
595};
596#define RXON_FLG_CHANNEL_MODE_LEGACY cpu_to_le32(CHANNEL_MODE_LEGACY << RXON_FLG_CHANNEL_MODE_POS)
597#define RXON_FLG_CHANNEL_MODE_PURE_40 cpu_to_le32(CHANNEL_MODE_PURE_40 << RXON_FLG_CHANNEL_MODE_POS)
598#define RXON_FLG_CHANNEL_MODE_MIXED cpu_to_le32(CHANNEL_MODE_MIXED << RXON_FLG_CHANNEL_MODE_POS)
599
Emmanuel Grumbacha326a5d2008-07-11 11:53:31 +0800600/* CTS to self (if spec allows) flag */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800601#define RXON_FLG_SELF_CTS_EN cpu_to_le32(0x1<<30)
Ben Cahill14519a02007-11-29 11:09:59 +0800602
Zhu Yib481de92007-09-25 17:54:57 -0700603/* rx_config filter flags */
604/* accept all data frames */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800605#define RXON_FILTER_PROMISC_MSK cpu_to_le32(1 << 0)
Zhu Yib481de92007-09-25 17:54:57 -0700606/* pass control & management to host */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800607#define RXON_FILTER_CTL2HOST_MSK cpu_to_le32(1 << 1)
Zhu Yib481de92007-09-25 17:54:57 -0700608/* accept multi-cast */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800609#define RXON_FILTER_ACCEPT_GRP_MSK cpu_to_le32(1 << 2)
Zhu Yib481de92007-09-25 17:54:57 -0700610/* don't decrypt uni-cast frames */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800611#define RXON_FILTER_DIS_DECRYPT_MSK cpu_to_le32(1 << 3)
Zhu Yib481de92007-09-25 17:54:57 -0700612/* don't decrypt multi-cast frames */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800613#define RXON_FILTER_DIS_GRP_DECRYPT_MSK cpu_to_le32(1 << 4)
Zhu Yib481de92007-09-25 17:54:57 -0700614/* STA is associated */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800615#define RXON_FILTER_ASSOC_MSK cpu_to_le32(1 << 5)
Zhu Yib481de92007-09-25 17:54:57 -0700616/* transfer to host non bssid beacons in associated state */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800617#define RXON_FILTER_BCON_AWARE_MSK cpu_to_le32(1 << 6)
Zhu Yib481de92007-09-25 17:54:57 -0700618
Ben Cahill80cc0c32007-11-29 11:10:09 +0800619/**
Zhu Yib481de92007-09-25 17:54:57 -0700620 * REPLY_RXON = 0x10 (command, has simple generic response)
Ben Cahill80cc0c32007-11-29 11:10:09 +0800621 *
622 * RXON tunes the radio tuner to a service channel, and sets up a number
623 * of parameters that are used primarily for Rx, but also for Tx operations.
624 *
625 * NOTE: When tuning to a new channel, driver must set the
626 * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent
627 * info within the device, including the station tables, tx retry
628 * rate tables, and txpower tables. Driver must build a new station
629 * table and txpower table before transmitting anything on the RXON
630 * channel.
631 *
632 * NOTE: All RXONs wipe clean the internal txpower table. Driver must
633 * issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
634 * regardless of whether RXON_FILTER_ASSOC_MSK is set.
Zhu Yib481de92007-09-25 17:54:57 -0700635 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +0800636
Gregory Greenmanc1adf9f2008-05-15 13:53:59 +0800637struct iwl_rxon_cmd {
638 u8 node_addr[6];
639 __le16 reserved1;
640 u8 bssid_addr[6];
641 __le16 reserved2;
642 u8 wlap_bssid_addr[6];
643 __le16 reserved3;
644 u8 dev_type;
645 u8 air_propagation;
646 __le16 rx_chain;
647 u8 ofdm_basic_rates;
648 u8 cck_basic_rates;
649 __le16 assoc_id;
650 __le32 flags;
651 __le32 filter_flags;
652 __le16 channel;
653 u8 ofdm_ht_single_stream_basic_rates;
654 u8 ofdm_ht_dual_stream_basic_rates;
655 u8 ofdm_ht_triple_stream_basic_rates;
656 u8 reserved5;
657 __le16 acquisition_data;
658 __le16 reserved6;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000659} __packed;
Gregory Greenmanc1adf9f2008-05-15 13:53:59 +0800660
Tomas Winkler3d24a9f2008-12-19 10:37:07 +0800661/*
662 * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
663 */
Wey-Yi Guy89e746b2011-04-19 16:52:58 -0700664struct iwl_rxon_assoc_cmd {
Ron Rindjunskyfe7a90c2008-05-29 16:35:14 +0800665 __le32 flags;
666 __le32 filter_flags;
667 u8 ofdm_basic_rates;
668 u8 cck_basic_rates;
669 __le16 reserved1;
670 u8 ofdm_ht_single_stream_basic_rates;
671 u8 ofdm_ht_dual_stream_basic_rates;
672 u8 ofdm_ht_triple_stream_basic_rates;
673 u8 reserved2;
674 __le16 rx_chain_select_flags;
675 __le16 acquisition_data;
676 __le32 reserved3;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000677} __packed;
Gregory Greenmanc1adf9f2008-05-15 13:53:59 +0800678
Tomas Winklerb5d7be52008-07-19 04:41:24 +0300679#define IWL_CONN_MAX_LISTEN_INTERVAL 10
Tomas Winkler2c2f3b32009-06-19 13:52:45 -0700680#define IWL_MAX_UCODE_BEACON_INTERVAL 4 /* 4096 */
681#define IWL39_MAX_UCODE_BEACON_INTERVAL 1 /* 1024 */
Ron Rindjunskyfe7a90c2008-05-29 16:35:14 +0800682
Zhu Yib481de92007-09-25 17:54:57 -0700683/*
684 * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
685 */
Tomas Winkler3195c1f2008-10-08 09:37:30 +0800686struct iwl_rxon_time_cmd {
687 __le64 timestamp;
Zhu Yib481de92007-09-25 17:54:57 -0700688 __le16 beacon_interval;
689 __le16 atim_window;
690 __le32 beacon_init_val;
691 __le16 listen_interval;
Johannes Berg946ba302010-08-23 10:46:48 +0200692 u8 dtim_period;
693 u8 delta_cp_bss_tbtts;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000694} __packed;
Zhu Yib481de92007-09-25 17:54:57 -0700695
Zhu Yib481de92007-09-25 17:54:57 -0700696/*
697 * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
698 */
Wey-Yi Guye57f1482009-10-09 13:20:34 -0700699/**
700 * struct iwl5000_channel_switch_cmd
701 * @band: 0- 5.2GHz, 1- 2.4GHz
702 * @expect_beacon: 0- resume transmits after channel switch
703 * 1- wait for beacon to resume transmits
704 * @channel: new channel number
705 * @rxon_flags: Rx on flags
706 * @rxon_filter_flags: filtering parameters
707 * @switch_time: switch time in extended beacon format
708 * @reserved: reserved bytes
709 */
710struct iwl5000_channel_switch_cmd {
711 u8 band;
712 u8 expect_beacon;
713 __le16 channel;
714 __le32 rxon_flags;
715 __le32 rxon_filter_flags;
716 __le32 switch_time;
717 __le32 reserved[2][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES];
Eric Dumazetba2d3582010-06-02 18:10:09 +0000718} __packed;
Wey-Yi Guye57f1482009-10-09 13:20:34 -0700719
720/**
721 * struct iwl6000_channel_switch_cmd
722 * @band: 0- 5.2GHz, 1- 2.4GHz
723 * @expect_beacon: 0- resume transmits after channel switch
724 * 1- wait for beacon to resume transmits
725 * @channel: new channel number
726 * @rxon_flags: Rx on flags
727 * @rxon_filter_flags: filtering parameters
728 * @switch_time: switch time in extended beacon format
729 * @reserved: reserved bytes
730 */
731struct iwl6000_channel_switch_cmd {
732 u8 band;
733 u8 expect_beacon;
734 __le16 channel;
735 __le32 rxon_flags;
736 __le32 rxon_filter_flags;
737 __le32 switch_time;
738 __le32 reserved[3][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES];
Eric Dumazetba2d3582010-06-02 18:10:09 +0000739} __packed;
Wey-Yi Guye57f1482009-10-09 13:20:34 -0700740
Zhu Yib481de92007-09-25 17:54:57 -0700741/*
742 * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
743 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -0800744struct iwl_csa_notification {
Zhu Yib481de92007-09-25 17:54:57 -0700745 __le16 band;
746 __le16 channel;
747 __le32 status; /* 0 - OK, 1 - fail */
Eric Dumazetba2d3582010-06-02 18:10:09 +0000748} __packed;
Zhu Yib481de92007-09-25 17:54:57 -0700749
750/******************************************************************************
751 * (2)
752 * Quality-of-Service (QOS) Commands & Responses:
753 *
754 *****************************************************************************/
Ben Cahill2054a002007-11-29 11:10:10 +0800755
756/**
757 * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
758 * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
759 *
760 * @cw_min: Contention window, start value in numbers of slots.
761 * Should be a power-of-2, minus 1. Device's default is 0x0f.
762 * @cw_max: Contention window, max value in numbers of slots.
763 * Should be a power-of-2, minus 1. Device's default is 0x3f.
764 * @aifsn: Number of slots in Arbitration Interframe Space (before
765 * performing random backoff timing prior to Tx). Device default 1.
766 * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
767 *
768 * Device will automatically increase contention window by (2*CW) + 1 for each
769 * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
770 * value, to cap the CW value.
771 */
Emmanuel Grumbach1ff50bd2008-07-11 11:53:34 +0800772struct iwl_ac_qos {
Zhu Yib481de92007-09-25 17:54:57 -0700773 __le16 cw_min;
774 __le16 cw_max;
775 u8 aifsn;
776 u8 reserved1;
777 __le16 edca_txop;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000778} __packed;
Zhu Yib481de92007-09-25 17:54:57 -0700779
780/* QoS flags defines */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800781#define QOS_PARAM_FLG_UPDATE_EDCA_MSK cpu_to_le32(0x01)
782#define QOS_PARAM_FLG_TGN_MSK cpu_to_le32(0x02)
783#define QOS_PARAM_FLG_TXOP_TYPE_MSK cpu_to_le32(0x10)
Zhu Yib481de92007-09-25 17:54:57 -0700784
Ben Cahill2054a002007-11-29 11:10:10 +0800785/* Number of Access Categories (AC) (EDCA), queues 0..3 */
Zhu Yib481de92007-09-25 17:54:57 -0700786#define AC_NUM 4
787
788/*
789 * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
Ben Cahill2054a002007-11-29 11:10:10 +0800790 *
791 * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
792 * 0: Background, 1: Best Effort, 2: Video, 3: Voice.
Zhu Yib481de92007-09-25 17:54:57 -0700793 */
Emmanuel Grumbach1ff50bd2008-07-11 11:53:34 +0800794struct iwl_qosparam_cmd {
Zhu Yib481de92007-09-25 17:54:57 -0700795 __le32 qos_flags;
Emmanuel Grumbach1ff50bd2008-07-11 11:53:34 +0800796 struct iwl_ac_qos ac[AC_NUM];
Eric Dumazetba2d3582010-06-02 18:10:09 +0000797} __packed;
Zhu Yib481de92007-09-25 17:54:57 -0700798
799/******************************************************************************
800 * (3)
801 * Add/Modify Stations Commands & Responses:
802 *
803 *****************************************************************************/
804/*
805 * Multi station support
806 */
Ben Cahill2054a002007-11-29 11:10:10 +0800807
808/* Special, dedicated locations within device's station table */
Zhu Yib481de92007-09-25 17:54:57 -0700809#define IWL_AP_ID 0
Johannes Berg946ba302010-08-23 10:46:48 +0200810#define IWL_AP_ID_PAN 1
Zhu Yib481de92007-09-25 17:54:57 -0700811#define IWL_STA_ID 2
Johannes Berg946ba302010-08-23 10:46:48 +0200812#define IWLAGN_PAN_BCAST_ID 14
Wey-Yi Guybf3c7fd2010-06-24 14:08:05 -0700813#define IWLAGN_BROADCAST_ID 15
814#define IWLAGN_STATION_COUNT 16
Zhu Yib481de92007-09-25 17:54:57 -0700815
Zhu Yib481de92007-09-25 17:54:57 -0700816#define IWL_INVALID_STATION 255
817
Johannes Berg1bd14ea2010-07-15 11:48:21 -0700818#define STA_FLG_TX_RATE_MSK cpu_to_le32(1 << 2)
819#define STA_FLG_PWR_SAVE_MSK cpu_to_le32(1 << 8)
Johannes Berg946ba302010-08-23 10:46:48 +0200820#define STA_FLG_PAN_STATION cpu_to_le32(1 << 13)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800821#define STA_FLG_RTS_MIMO_PROT_MSK cpu_to_le32(1 << 17)
822#define STA_FLG_AGG_MPDU_8US_MSK cpu_to_le32(1 << 18)
Ben Cahill74093dd2007-11-29 11:09:53 +0800823#define STA_FLG_MAX_AGG_SIZE_POS (19)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800824#define STA_FLG_MAX_AGG_SIZE_MSK cpu_to_le32(3 << 19)
Wey-Yi Guy7aafef12009-08-07 15:41:38 -0700825#define STA_FLG_HT40_EN_MSK cpu_to_le32(1 << 21)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800826#define STA_FLG_MIMO_DIS_MSK cpu_to_le32(1 << 22)
Ben Cahill74093dd2007-11-29 11:09:53 +0800827#define STA_FLG_AGG_MPDU_DENSITY_POS (23)
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800828#define STA_FLG_AGG_MPDU_DENSITY_MSK cpu_to_le32(7 << 23)
Zhu Yib481de92007-09-25 17:54:57 -0700829
Ben Cahill2054a002007-11-29 11:10:10 +0800830/* Use in mode field. 1: modify existing entry, 0: add new station entry */
Zhu Yib481de92007-09-25 17:54:57 -0700831#define STA_CONTROL_MODIFY_MSK 0x01
832
833/* key flags __le16*/
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800834#define STA_KEY_FLG_ENCRYPT_MSK cpu_to_le16(0x0007)
835#define STA_KEY_FLG_NO_ENC cpu_to_le16(0x0000)
836#define STA_KEY_FLG_WEP cpu_to_le16(0x0001)
837#define STA_KEY_FLG_CCMP cpu_to_le16(0x0002)
838#define STA_KEY_FLG_TKIP cpu_to_le16(0x0003)
Zhu Yib481de92007-09-25 17:54:57 -0700839
840#define STA_KEY_FLG_KEYID_POS 8
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800841#define STA_KEY_FLG_INVALID cpu_to_le16(0x0800)
Emmanuel Grumbacheaaf7892008-02-13 11:32:29 -0800842/* wep key is either from global key (0) or from station info array (1) */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800843#define STA_KEY_FLG_MAP_KEY_MSK cpu_to_le16(0x0008)
Emmanuel Grumbacheaaf7892008-02-13 11:32:29 -0800844
845/* wep key in STA: 5-bytes (0) or 13-bytes (1) */
Harvey Harrison51e9bf52008-11-26 13:12:52 -0800846#define STA_KEY_FLG_KEY_SIZE_MSK cpu_to_le16(0x1000)
847#define STA_KEY_MULTICAST_MSK cpu_to_le16(0x4000)
Emmanuel Grumbachdeb09c42008-03-19 16:41:41 -0700848#define STA_KEY_MAX_NUM 8
Johannes Bergc10afb62010-08-23 10:46:43 +0200849#define STA_KEY_MAX_NUM_PAN 16
Zhu Yib481de92007-09-25 17:54:57 -0700850
Ben Cahill2054a002007-11-29 11:10:10 +0800851/* Flags indicate whether to modify vs. don't change various station params */
Zhu Yib481de92007-09-25 17:54:57 -0700852#define STA_MODIFY_KEY_MASK 0x01
853#define STA_MODIFY_TID_DISABLE_TX 0x02
854#define STA_MODIFY_TX_RATE_MSK 0x04
855#define STA_MODIFY_ADDBA_TID_MSK 0x08
856#define STA_MODIFY_DELBA_TID_MSK 0x10
Johannes Berg6ab10ff2009-11-13 11:56:37 -0800857#define STA_MODIFY_SLEEP_TX_COUNT_MSK 0x20
Ben Cahill2054a002007-11-29 11:10:10 +0800858
859/* Receiver address (actually, Rx station's index into station table),
860 * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
Zhu Yib481de92007-09-25 17:54:57 -0700861#define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid))
862
Wey-Yi Guya8029bb2010-09-20 09:12:32 -0700863/* agn */
Tomas Winkler133636d2008-05-05 10:22:34 +0800864struct iwl_keyinfo {
865 __le16 key_flags;
866 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
867 u8 reserved1;
868 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
869 u8 key_offset;
870 u8 reserved2;
871 u8 key[16]; /* 16-byte unicast decryption key */
872 __le64 tx_secur_seq_cnt;
873 __le64 hw_tkip_mic_rx_key;
874 __le64 hw_tkip_mic_tx_key;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000875} __packed;
Tomas Winkler133636d2008-05-05 10:22:34 +0800876
Ben Cahill2054a002007-11-29 11:10:10 +0800877/**
878 * struct sta_id_modify
879 * @addr[ETH_ALEN]: station's MAC address
880 * @sta_id: index of station in uCode's station table
881 * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
882 *
883 * Driver selects unused table index when adding new station,
884 * or the index to a pre-existing station entry when modifying that station.
885 * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
886 *
887 * modify_mask flags select which parameters to modify vs. leave alone.
888 */
Zhu Yib481de92007-09-25 17:54:57 -0700889struct sta_id_modify {
890 u8 addr[ETH_ALEN];
891 __le16 reserved1;
892 u8 sta_id;
893 u8 modify_mask;
894 __le16 reserved2;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000895} __packed;
Zhu Yib481de92007-09-25 17:54:57 -0700896
897/*
898 * REPLY_ADD_STA = 0x18 (command)
Ben Cahill2054a002007-11-29 11:10:10 +0800899 *
900 * The device contains an internal table of per-station information,
901 * with info on security keys, aggregation parameters, and Tx rates for
Wey-Yi Guy767d0552010-08-23 07:56:53 -0700902 * initial Tx attempt and any retries (agn devices uses
903 * REPLY_TX_LINK_QUALITY_CMD,
Ben Cahill2054a002007-11-29 11:10:10 +0800904 *
905 * REPLY_ADD_STA sets up the table entry for one station, either creating
906 * a new entry, or modifying a pre-existing one.
907 *
908 * NOTE: RXON command (without "associated" bit set) wipes the station table
909 * clean. Moving into RF_KILL state does this also. Driver must set up
910 * new station table before transmitting anything on the RXON channel
911 * (except active scans or active measurements; those commands carry
912 * their own txpower/rate setup data).
913 *
914 * When getting started on a new channel, driver must set up the
915 * IWL_BROADCAST_ID entry (last entry in the table). For a client
916 * station in a BSS, once an AP is selected, driver sets up the AP STA
917 * in the IWL_AP_ID entry (1st entry in the table). BROADCAST and AP
918 * are all that are needed for a BSS client station. If the device is
919 * used as AP, or in an IBSS network, driver must set up station table
920 * entries for all STAs in network, starting with index IWL_STA_ID.
Zhu Yib481de92007-09-25 17:54:57 -0700921 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +0800922
Tomas Winkler133636d2008-05-05 10:22:34 +0800923struct iwl_addsta_cmd {
924 u8 mode; /* 1: modify existing, 0: add new station */
925 u8 reserved[3];
926 struct sta_id_modify sta;
927 struct iwl_keyinfo key;
928 __le32 station_flags; /* STA_FLG_* */
929 __le32 station_flags_msk; /* STA_FLG_* */
930
931 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
932 * corresponding to bit (e.g. bit 5 controls TID 5).
933 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
934 __le16 tid_disable_tx;
935
Tomas Winklerc587de02009-06-03 11:44:07 -0700936 __le16 rate_n_flags; /* 3945 only */
Tomas Winkler133636d2008-05-05 10:22:34 +0800937
938 /* TID for which to add block-ack support.
939 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
940 u8 add_immediate_ba_tid;
941
942 /* TID for which to remove block-ack support.
943 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
944 u8 remove_immediate_ba_tid;
945
946 /* Starting Sequence Number for added block-ack support.
947 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
948 __le16 add_immediate_ba_ssn;
949
Johannes Berg9bb487b2009-11-13 11:56:36 -0800950 /*
951 * Number of packets OK to transmit to station even though
952 * it is asleep -- used to synchronise PS-poll and u-APSD
953 * responses while ucode keeps track of STA sleep state.
954 */
955 __le16 sleep_tx_count;
956
957 __le16 reserved2;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000958} __packed;
Tomas Winkler133636d2008-05-05 10:22:34 +0800959
960
Ben Cahill2054a002007-11-29 11:10:10 +0800961#define ADD_STA_SUCCESS_MSK 0x1
962#define ADD_STA_NO_ROOM_IN_TABLE 0x2
963#define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4
964#define ADD_STA_MODIFY_NON_EXIST_STA 0x8
Zhu Yib481de92007-09-25 17:54:57 -0700965/*
966 * REPLY_ADD_STA = 0x18 (response)
967 */
Tomas Winkler7a999bf2008-05-29 16:35:02 +0800968struct iwl_add_sta_resp {
Ben Cahill2054a002007-11-29 11:10:10 +0800969 u8 status; /* ADD_STA_* */
Eric Dumazetba2d3582010-06-02 18:10:09 +0000970} __packed;
Zhu Yib481de92007-09-25 17:54:57 -0700971
Tomas Winkler7a999bf2008-05-29 16:35:02 +0800972#define REM_STA_SUCCESS_MSK 0x1
973/*
974 * REPLY_REM_STA = 0x19 (response)
975 */
976struct iwl_rem_sta_resp {
977 u8 status;
Eric Dumazetba2d3582010-06-02 18:10:09 +0000978} __packed;
Tomas Winkler7a999bf2008-05-29 16:35:02 +0800979
980/*
981 * REPLY_REM_STA = 0x19 (command)
982 */
983struct iwl_rem_sta_cmd {
984 u8 num_sta; /* number of removed stations */
985 u8 reserved[3];
986 u8 addr[ETH_ALEN]; /* MAC addr of the first station */
987 u8 reserved2[2];
Eric Dumazetba2d3582010-06-02 18:10:09 +0000988} __packed;
Tomas Winkler7a999bf2008-05-29 16:35:02 +0800989
Wey-Yi Guy947279e2010-06-24 13:18:33 -0700990#define IWL_TX_FIFO_BK_MSK cpu_to_le32(BIT(0))
991#define IWL_TX_FIFO_BE_MSK cpu_to_le32(BIT(1))
992#define IWL_TX_FIFO_VI_MSK cpu_to_le32(BIT(2))
993#define IWL_TX_FIFO_VO_MSK cpu_to_le32(BIT(3))
994#define IWL_AGG_TX_QUEUE_MSK cpu_to_le32(0xffc00)
995
Wey-Yi Guy716c74b2010-06-24 13:22:36 -0700996#define IWL_DROP_SINGLE 0
997#define IWL_DROP_SELECTED 1
998#define IWL_DROP_ALL 2
999
Wey-Yi Guy947279e2010-06-24 13:18:33 -07001000/*
1001 * REPLY_TXFIFO_FLUSH = 0x1e(command and response)
1002 *
1003 * When using full FIFO flush this command checks the scheduler HW block WR/RD
1004 * pointers to check if all the frames were transferred by DMA into the
1005 * relevant TX FIFO queue. Only when the DMA is finished and the queue is
1006 * empty the command can finish.
1007 * This command is used to flush the TXFIFO from transmit commands, it may
1008 * operate on single or multiple queues, the command queue can't be flushed by
1009 * this command. The command response is returned when all the queue flush
1010 * operations are done. Each TX command flushed return response with the FLUSH
1011 * status set in the TX response status. When FIFO flush operation is used,
1012 * the flush operation ends when both the scheduler DMA done and TXFIFO empty
1013 * are set.
1014 *
1015 * @fifo_control: bit mask for which queues to flush
1016 * @flush_control: flush controls
1017 * 0: Dump single MSDU
1018 * 1: Dump multiple MSDU according to PS, INVALID STA, TTL, TID disable.
1019 * 2: Dump all FIFO
1020 */
1021struct iwl_txfifo_flush_cmd {
1022 __le32 fifo_control;
1023 __le16 flush_control;
1024 __le16 reserved;
John W. Linville0e954092010-07-14 10:37:32 -04001025} __packed;
Wey-Yi Guy947279e2010-06-24 13:18:33 -07001026
Emmanuel Grumbach0a0bed12008-04-14 21:16:05 -07001027/*
1028 * REPLY_WEP_KEY = 0x20
1029 */
1030struct iwl_wep_key {
1031 u8 key_index;
1032 u8 key_offset;
1033 u8 reserved1[2];
1034 u8 key_size;
1035 u8 reserved2[3];
1036 u8 key[16];
Eric Dumazetba2d3582010-06-02 18:10:09 +00001037} __packed;
Emmanuel Grumbach0a0bed12008-04-14 21:16:05 -07001038
1039struct iwl_wep_cmd {
1040 u8 num_keys;
1041 u8 global_key_type;
1042 u8 flags;
1043 u8 reserved;
1044 struct iwl_wep_key key[0];
Eric Dumazetba2d3582010-06-02 18:10:09 +00001045} __packed;
Emmanuel Grumbach0a0bed12008-04-14 21:16:05 -07001046
1047#define WEP_KEY_WEP_TYPE 1
1048#define WEP_KEYS_MAX 4
1049#define WEP_INVALID_OFFSET 0xff
Emmanuel Grumbach4564ce82008-06-12 09:47:09 +08001050#define WEP_KEY_LEN_64 5
Emmanuel Grumbach0a0bed12008-04-14 21:16:05 -07001051#define WEP_KEY_LEN_128 13
Zhu Yib481de92007-09-25 17:54:57 -07001052
1053/******************************************************************************
1054 * (4)
1055 * Rx Responses:
1056 *
1057 *****************************************************************************/
1058
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001059#define RX_RES_STATUS_NO_CRC32_ERROR cpu_to_le32(1 << 0)
1060#define RX_RES_STATUS_NO_RXE_OVERFLOW cpu_to_le32(1 << 1)
Zhu Yib481de92007-09-25 17:54:57 -07001061
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001062#define RX_RES_PHY_FLAGS_BAND_24_MSK cpu_to_le16(1 << 0)
1063#define RX_RES_PHY_FLAGS_MOD_CCK_MSK cpu_to_le16(1 << 1)
1064#define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK cpu_to_le16(1 << 2)
1065#define RX_RES_PHY_FLAGS_NARROW_BAND_MSK cpu_to_le16(1 << 3)
Reinette Chatre9024adf2009-10-02 13:43:57 -07001066#define RX_RES_PHY_FLAGS_ANTENNA_MSK 0xf0
Daniel C Halperin9f30e042009-08-13 13:30:56 -07001067#define RX_RES_PHY_FLAGS_ANTENNA_POS 4
Zhu Yib481de92007-09-25 17:54:57 -07001068
Tomas Winkler8211ef72008-03-02 01:36:04 +02001069#define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)
1070#define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)
1071#define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)
1072#define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)
1073#define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)
Emmanuel Grumbach17e476b2008-03-19 16:41:42 -07001074#define RX_RES_STATUS_SEC_TYPE_ERR (0x7 << 8)
1075
1076#define RX_RES_STATUS_STATION_FOUND (1<<6)
1077#define RX_RES_STATUS_NO_STATION_INFO_MISMATCH (1<<7)
Zhu Yib481de92007-09-25 17:54:57 -07001078
Tomas Winkler8211ef72008-03-02 01:36:04 +02001079#define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)
1080#define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)
1081#define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)
1082#define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)
1083#define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)
Zhu Yib481de92007-09-25 17:54:57 -07001084
Emmanuel Grumbach17e476b2008-03-19 16:41:42 -07001085#define RX_MPDU_RES_STATUS_ICV_OK (0x20)
1086#define RX_MPDU_RES_STATUS_MIC_OK (0x40)
1087#define RX_MPDU_RES_STATUS_TTAK_OK (1 << 7)
1088#define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800)
1089
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08001090
Wey-Yi Guy7ccc8962010-08-04 08:42:17 -07001091#define IWLAGN_RX_RES_PHY_CNT 8
1092#define IWLAGN_RX_RES_AGC_IDX 1
1093#define IWLAGN_RX_RES_RSSI_AB_IDX 2
1094#define IWLAGN_RX_RES_RSSI_C_IDX 3
1095#define IWLAGN_OFDM_AGC_MSK 0xfe00
1096#define IWLAGN_OFDM_AGC_BIT_POS 9
1097#define IWLAGN_OFDM_RSSI_INBAND_A_BITMSK 0x00ff
1098#define IWLAGN_OFDM_RSSI_ALLBAND_A_BITMSK 0xff00
1099#define IWLAGN_OFDM_RSSI_A_BIT_POS 0
1100#define IWLAGN_OFDM_RSSI_INBAND_B_BITMSK 0xff0000
1101#define IWLAGN_OFDM_RSSI_ALLBAND_B_BITMSK 0xff000000
1102#define IWLAGN_OFDM_RSSI_B_BIT_POS 16
1103#define IWLAGN_OFDM_RSSI_INBAND_C_BITMSK 0x00ff
1104#define IWLAGN_OFDM_RSSI_ALLBAND_C_BITMSK 0xff00
1105#define IWLAGN_OFDM_RSSI_C_BIT_POS 0
Tomas Winklercaab8f12008-08-04 16:00:42 +08001106
Wey-Yi Guy7ccc8962010-08-04 08:42:17 -07001107struct iwlagn_non_cfg_phy {
1108 __le32 non_cfg_phy[IWLAGN_RX_RES_PHY_CNT]; /* up to 8 phy entries */
Eric Dumazetba2d3582010-06-02 18:10:09 +00001109} __packed;
Tomas Winklercaab8f12008-08-04 16:00:42 +08001110
1111
Zhu Yib481de92007-09-25 17:54:57 -07001112/*
Tomas Winkler857485c2008-03-21 13:53:44 -07001113 * REPLY_RX = 0xc3 (response only, not a command)
Zhu Yib481de92007-09-25 17:54:57 -07001114 * Used only for legacy (non 11n) frames.
1115 */
Tomas Winklercaab8f12008-08-04 16:00:42 +08001116struct iwl_rx_phy_res {
Zhu Yib481de92007-09-25 17:54:57 -07001117 u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */
1118 u8 cfg_phy_cnt; /* configurable DSP phy data byte count */
1119 u8 stat_id; /* configurable DSP phy data set ID */
1120 u8 reserved1;
1121 __le64 timestamp; /* TSF at on air rise */
1122 __le32 beacon_time_stamp; /* beacon at on-air rise */
1123 __le16 phy_flags; /* general phy flags: band, modulation, ... */
1124 __le16 channel; /* channel number */
Tomas Winklercaab8f12008-08-04 16:00:42 +08001125 u8 non_cfg_phy_buf[32]; /* for various implementations of non_cfg_phy */
Ben Cahill52969982007-11-29 11:10:11 +08001126 __le32 rate_n_flags; /* RATE_MCS_* */
1127 __le16 byte_count; /* frame's byte-count */
Wey-Yi Guy30c1b0f2010-08-04 08:05:33 -07001128 __le16 frame_time; /* frame's time on the air */
Eric Dumazetba2d3582010-06-02 18:10:09 +00001129} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07001130
Emmanuel Grumbach2fb291e2010-06-07 13:21:47 -07001131struct iwl_rx_mpdu_res_start {
Zhu Yib481de92007-09-25 17:54:57 -07001132 __le16 byte_count;
1133 __le16 reserved;
Eric Dumazetba2d3582010-06-02 18:10:09 +00001134} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07001135
1136
1137/******************************************************************************
1138 * (5)
1139 * Tx Commands & Responses:
1140 *
Ben Cahill52969982007-11-29 11:10:11 +08001141 * Driver must place each REPLY_TX command into one of the prioritized Tx
1142 * queues in host DRAM, shared between driver and device (see comments for
1143 * SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode
1144 * are preparing to transmit, the device pulls the Tx command over the PCI
1145 * bus via one of the device's Tx DMA channels, to fill an internal FIFO
1146 * from which data will be transmitted.
1147 *
1148 * uCode handles all timing and protocol related to control frames
1149 * (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler
1150 * handle reception of block-acks; uCode updates the host driver via
Wey-Yi Guy767d0552010-08-23 07:56:53 -07001151 * REPLY_COMPRESSED_BA.
Ben Cahill52969982007-11-29 11:10:11 +08001152 *
1153 * uCode handles retrying Tx when an ACK is expected but not received.
1154 * This includes trying lower data rates than the one requested in the Tx
1155 * command, as set up by the REPLY_RATE_SCALE (for 3945) or
Wey-Yi Guy767d0552010-08-23 07:56:53 -07001156 * REPLY_TX_LINK_QUALITY_CMD (agn).
Ben Cahill52969982007-11-29 11:10:11 +08001157 *
1158 * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
1159 * This command must be executed after every RXON command, before Tx can occur.
Zhu Yib481de92007-09-25 17:54:57 -07001160 *****************************************************************************/
1161
Ben Cahill52969982007-11-29 11:10:11 +08001162/* REPLY_TX Tx flags field */
1163
Wey-Yi Guy4e3243f2010-06-18 11:33:16 -07001164/*
1165 * 1: Use RTS/CTS protocol or CTS-to-self if spec allows it
Emmanuel Grumbacha326a5d2008-07-11 11:53:31 +08001166 * before this frame. if CTS-to-self required check
Wey-Yi Guy4e3243f2010-06-18 11:33:16 -07001167 * RXON_FLG_SELF_CTS_EN status.
1168 * unused in 3945/4965, used in 5000 series and after
1169 */
1170#define TX_CMD_FLG_PROT_REQUIRE_MSK cpu_to_le32(1 << 0)
Emmanuel Grumbacha326a5d2008-07-11 11:53:31 +08001171
Wey-Yi Guy4e3243f2010-06-18 11:33:16 -07001172/*
1173 * 1: Use Request-To-Send protocol before this frame.
1174 * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK.
1175 * used in 3945/4965, unused in 5000 series and after
1176 */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001177#define TX_CMD_FLG_RTS_MSK cpu_to_le32(1 << 1)
Ben Cahill52969982007-11-29 11:10:11 +08001178
Wey-Yi Guy4e3243f2010-06-18 11:33:16 -07001179/*
1180 * 1: Transmit Clear-To-Send to self before this frame.
Ben Cahill52969982007-11-29 11:10:11 +08001181 * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
Wey-Yi Guy4e3243f2010-06-18 11:33:16 -07001182 * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK.
1183 * used in 3945/4965, unused in 5000 series and after
1184 */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001185#define TX_CMD_FLG_CTS_MSK cpu_to_le32(1 << 2)
Ben Cahill52969982007-11-29 11:10:11 +08001186
1187/* 1: Expect ACK from receiving station
1188 * 0: Don't expect ACK (MAC header's duration field s/b 0)
1189 * Set this for unicast frames, but not broadcast/multicast. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001190#define TX_CMD_FLG_ACK_MSK cpu_to_le32(1 << 3)
Ben Cahill52969982007-11-29 11:10:11 +08001191
Wey-Yi Guy767d0552010-08-23 07:56:53 -07001192/* For agn devices:
Ben Cahill52969982007-11-29 11:10:11 +08001193 * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
1194 * Tx command's initial_rate_index indicates first rate to try;
1195 * uCode walks through table for additional Tx attempts.
1196 * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
1197 * This rate will be used for all Tx attempts; it will not be scaled. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001198#define TX_CMD_FLG_STA_RATE_MSK cpu_to_le32(1 << 4)
Ben Cahill52969982007-11-29 11:10:11 +08001199
1200/* 1: Expect immediate block-ack.
1201 * Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001202#define TX_CMD_FLG_IMM_BA_RSP_MASK cpu_to_le32(1 << 6)
Ben Cahill52969982007-11-29 11:10:11 +08001203
Wey-Yi Guy4e3243f2010-06-18 11:33:16 -07001204/*
1205 * 1: Frame requires full Tx-Op protection.
1206 * Set this if either RTS or CTS Tx Flag gets set.
1207 * used in 3945/4965, unused in 5000 series and after
1208 */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001209#define TX_CMD_FLG_FULL_TXOP_PROT_MSK cpu_to_le32(1 << 7)
Ben Cahill52969982007-11-29 11:10:11 +08001210
Wey-Yi Guy767d0552010-08-23 07:56:53 -07001211/* Tx antenna selection field; used only for 3945, reserved (0) for agn devices.
Ben Cahill52969982007-11-29 11:10:11 +08001212 * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001213#define TX_CMD_FLG_ANT_SEL_MSK cpu_to_le32(0xf00)
1214#define TX_CMD_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
1215#define TX_CMD_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
Zhu Yib481de92007-09-25 17:54:57 -07001216
Ben Cahill52969982007-11-29 11:10:11 +08001217/* 1: Ignore Bluetooth priority for this frame.
1218 * 0: Delay Tx until Bluetooth device is done (normal usage). */
Johannes Bergb2e86902010-04-13 01:04:32 -07001219#define TX_CMD_FLG_IGNORE_BT cpu_to_le32(1 << 12)
Zhu Yib481de92007-09-25 17:54:57 -07001220
Ben Cahill52969982007-11-29 11:10:11 +08001221/* 1: uCode overrides sequence control field in MAC header.
1222 * 0: Driver provides sequence control field in MAC header.
1223 * Set this for management frames, non-QOS data frames, non-unicast frames,
1224 * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001225#define TX_CMD_FLG_SEQ_CTL_MSK cpu_to_le32(1 << 13)
Zhu Yib481de92007-09-25 17:54:57 -07001226
Ben Cahill52969982007-11-29 11:10:11 +08001227/* 1: This frame is non-last MPDU; more fragments are coming.
1228 * 0: Last fragment, or not using fragmentation. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001229#define TX_CMD_FLG_MORE_FRAG_MSK cpu_to_le32(1 << 14)
Zhu Yib481de92007-09-25 17:54:57 -07001230
Ben Cahill52969982007-11-29 11:10:11 +08001231/* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
1232 * 0: No TSF required in outgoing frame.
1233 * Set this for transmitting beacons and probe responses. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001234#define TX_CMD_FLG_TSF_MSK cpu_to_le32(1 << 16)
Zhu Yib481de92007-09-25 17:54:57 -07001235
Ben Cahill52969982007-11-29 11:10:11 +08001236/* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
1237 * alignment of frame's payload data field.
1238 * 0: No pad
1239 * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
1240 * field (but not both). Driver must align frame data (i.e. data following
1241 * MAC header) to DWORD boundary. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001242#define TX_CMD_FLG_MH_PAD_MSK cpu_to_le32(1 << 20)
Zhu Yib481de92007-09-25 17:54:57 -07001243
Max Stepanov8236e182008-03-12 16:58:48 -07001244/* accelerate aggregation support
1245 * 0 - no CCMP encryption; 1 - CCMP encryption */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001246#define TX_CMD_FLG_AGG_CCMP_MSK cpu_to_le32(1 << 22)
Max Stepanov8236e182008-03-12 16:58:48 -07001247
Zhu Yib481de92007-09-25 17:54:57 -07001248/* HCCA-AP - disable duration overwriting. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08001249#define TX_CMD_FLG_DUR_MSK cpu_to_le32(1 << 25)
Zhu Yib481de92007-09-25 17:54:57 -07001250
Ben Cahill52969982007-11-29 11:10:11 +08001251
Zhu Yib481de92007-09-25 17:54:57 -07001252/*
1253 * TX command security control
1254 */
1255#define TX_CMD_SEC_WEP 0x01
1256#define TX_CMD_SEC_CCM 0x02
1257#define TX_CMD_SEC_TKIP 0x03
1258#define TX_CMD_SEC_MSK 0x03
1259#define TX_CMD_SEC_SHIFT 6
1260#define TX_CMD_SEC_KEY128 0x08
1261
1262/*
Tomas Winkler3195cdb2008-04-23 17:15:00 -07001263 * security overhead sizes
1264 */
1265#define WEP_IV_LEN 4
1266#define WEP_ICV_LEN 4
1267#define CCMP_MIC_LEN 8
1268#define TKIP_ICV_LEN 4
1269
1270/*
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08001271 * REPLY_TX = 0x1c (command)
1272 */
1273
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08001274/*
Ben Cahill52969982007-11-29 11:10:11 +08001275 * 4965 uCode updates these Tx attempt count values in host DRAM.
1276 * Used for managing Tx retries when expecting block-acks.
1277 * Driver should set these fields to 0.
Zhu Yib481de92007-09-25 17:54:57 -07001278 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08001279struct iwl_dram_scratch {
Ben Cahill52969982007-11-29 11:10:11 +08001280 u8 try_cnt; /* Tx attempts */
1281 u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */
Zhu Yib481de92007-09-25 17:54:57 -07001282 __le16 reserved;
Eric Dumazetba2d3582010-06-02 18:10:09 +00001283} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07001284
Tomas Winkler83d527d2008-05-15 13:54:05 +08001285struct iwl_tx_cmd {
Ben Cahill52969982007-11-29 11:10:11 +08001286 /*
1287 * MPDU byte count:
1288 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
1289 * + 8 byte IV for CCM or TKIP (not used for WEP)
1290 * + Data payload
1291 * + 8-byte MIC (not used for CCM/WEP)
1292 * NOTE: Does not include Tx command bytes, post-MAC pad bytes,
1293 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
1294 * Range: 14-2342 bytes.
1295 */
Zhu Yib481de92007-09-25 17:54:57 -07001296 __le16 len;
Ben Cahill52969982007-11-29 11:10:11 +08001297
1298 /*
1299 * MPDU or MSDU byte count for next frame.
1300 * Used for fragmentation and bursting, but not 11n aggregation.
1301 * Same as "len", but for next frame. Set to 0 if not applicable.
1302 */
Zhu Yib481de92007-09-25 17:54:57 -07001303 __le16 next_frame_len;
Ben Cahill52969982007-11-29 11:10:11 +08001304
1305 __le32 tx_flags; /* TX_CMD_FLG_* */
1306
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08001307 /* uCode may modify this field of the Tx command (in host DRAM!).
Ben Cahill52969982007-11-29 11:10:11 +08001308 * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08001309 struct iwl_dram_scratch scratch;
Ben Cahill52969982007-11-29 11:10:11 +08001310
1311 /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
1312 __le32 rate_n_flags; /* RATE_MCS_* */
1313
1314 /* Index of destination station in uCode's station table */
Zhu Yib481de92007-09-25 17:54:57 -07001315 u8 sta_id;
Ben Cahill52969982007-11-29 11:10:11 +08001316
1317 /* Type of security encryption: CCM or TKIP */
1318 u8 sec_ctl; /* TX_CMD_SEC_* */
1319
1320 /*
1321 * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial
1322 * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for
1323 * data frames, this field may be used to selectively reduce initial
1324 * rate (via non-0 value) for special frames (e.g. management), while
1325 * still supporting rate scaling for all frames.
1326 */
Zhu Yib481de92007-09-25 17:54:57 -07001327 u8 initial_rate_index;
1328 u8 reserved;
Zhu Yib481de92007-09-25 17:54:57 -07001329 u8 key[16];
Zhu Yib481de92007-09-25 17:54:57 -07001330 __le16 next_frame_flags;
1331 __le16 reserved2;
Zhu Yib481de92007-09-25 17:54:57 -07001332 union {
1333 __le32 life_time;
1334 __le32 attempt;
1335 } stop_time;
Ben Cahill52969982007-11-29 11:10:11 +08001336
1337 /* Host DRAM physical address pointer to "scratch" in this command.
1338 * Must be dword aligned. "0" in dram_lsb_ptr disables usage. */
Zhu Yib481de92007-09-25 17:54:57 -07001339 __le32 dram_lsb_ptr;
1340 u8 dram_msb_ptr;
Ben Cahill52969982007-11-29 11:10:11 +08001341
Zhu Yib481de92007-09-25 17:54:57 -07001342 u8 rts_retry_limit; /*byte 50 */
1343 u8 data_retry_limit; /*byte 51 */
Zhu Yib481de92007-09-25 17:54:57 -07001344 u8 tid_tspec;
Zhu Yib481de92007-09-25 17:54:57 -07001345 union {
1346 __le16 pm_frame_timeout;
1347 __le16 attempt_duration;
1348 } timeout;
Ben Cahill52969982007-11-29 11:10:11 +08001349
1350 /*
1351 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
1352 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
1353 */
Zhu Yib481de92007-09-25 17:54:57 -07001354 __le16 driver_txop;
Ben Cahill52969982007-11-29 11:10:11 +08001355
1356 /*
1357 * MAC header goes here, followed by 2 bytes padding if MAC header
1358 * length is 26 or 30 bytes, followed by payload data
1359 */
Zhu Yib481de92007-09-25 17:54:57 -07001360 u8 payload[0];
1361 struct ieee80211_hdr hdr[0];
Eric Dumazetba2d3582010-06-02 18:10:09 +00001362} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07001363
Wey-Yi Guy04569cb2010-03-31 17:57:28 -07001364/*
1365 * TX command response is sent after *agn* transmission attempts.
1366 *
1367 * both postpone and abort status are expected behavior from uCode. there is
1368 * no special operation required from driver; except for RFKILL_FLUSH,
1369 * which required tx flush host command to flush all the tx frames in queues
1370 */
1371enum {
Zhu Yib481de92007-09-25 17:54:57 -07001372 TX_STATUS_SUCCESS = 0x01,
1373 TX_STATUS_DIRECT_DONE = 0x02,
Wey-Yi Guy04569cb2010-03-31 17:57:28 -07001374 /* postpone TX */
1375 TX_STATUS_POSTPONE_DELAY = 0x40,
1376 TX_STATUS_POSTPONE_FEW_BYTES = 0x41,
1377 TX_STATUS_POSTPONE_BT_PRIO = 0x42,
1378 TX_STATUS_POSTPONE_QUIET_PERIOD = 0x43,
1379 TX_STATUS_POSTPONE_CALC_TTAK = 0x44,
1380 /* abort TX */
1381 TX_STATUS_FAIL_INTERNAL_CROSSED_RETRY = 0x81,
Zhu Yib481de92007-09-25 17:54:57 -07001382 TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
1383 TX_STATUS_FAIL_LONG_LIMIT = 0x83,
1384 TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
Wey-Yi Guy04569cb2010-03-31 17:57:28 -07001385 TX_STATUS_FAIL_DRAIN_FLOW = 0x85,
1386 TX_STATUS_FAIL_RFKILL_FLUSH = 0x86,
Zhu Yib481de92007-09-25 17:54:57 -07001387 TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
1388 TX_STATUS_FAIL_DEST_PS = 0x88,
Wey-Yi Guy04569cb2010-03-31 17:57:28 -07001389 TX_STATUS_FAIL_HOST_ABORTED = 0x89,
Zhu Yib481de92007-09-25 17:54:57 -07001390 TX_STATUS_FAIL_BT_RETRY = 0x8a,
1391 TX_STATUS_FAIL_STA_INVALID = 0x8b,
1392 TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
1393 TX_STATUS_FAIL_TID_DISABLE = 0x8d,
Wey-Yi Guy04569cb2010-03-31 17:57:28 -07001394 TX_STATUS_FAIL_FIFO_FLUSHED = 0x8e,
Zhu Yib481de92007-09-25 17:54:57 -07001395 TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
Wey-Yi Guy1d270072010-09-07 12:42:20 -07001396 TX_STATUS_FAIL_PASSIVE_NO_RX = 0x90,
1397 TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
Zhu Yib481de92007-09-25 17:54:57 -07001398};
1399
1400#define TX_PACKET_MODE_REGULAR 0x0000
1401#define TX_PACKET_MODE_BURST_SEQ 0x0100
1402#define TX_PACKET_MODE_BURST_FIRST 0x0200
1403
1404enum {
1405 TX_POWER_PA_NOT_ACTIVE = 0x0,
1406};
1407
1408enum {
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001409 TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */
Zhu Yib481de92007-09-25 17:54:57 -07001410 TX_STATUS_DELAY_MSK = 0x00000040,
1411 TX_STATUS_ABORT_MSK = 0x00000080,
1412 TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */
1413 TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001414 TX_RESERVED = 0x00780000, /* bits 19:22 */
Zhu Yib481de92007-09-25 17:54:57 -07001415 TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */
1416 TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */
1417};
1418
1419/* *******************************
Ben Cahill52969982007-11-29 11:10:11 +08001420 * TX aggregation status
Zhu Yib481de92007-09-25 17:54:57 -07001421 ******************************* */
1422
1423enum {
1424 AGG_TX_STATE_TRANSMITTED = 0x00,
1425 AGG_TX_STATE_UNDERRUN_MSK = 0x01,
1426 AGG_TX_STATE_BT_PRIO_MSK = 0x02,
1427 AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
1428 AGG_TX_STATE_ABORT_MSK = 0x08,
1429 AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
1430 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
1431 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
1432 AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
1433 AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
1434 AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
1435 AGG_TX_STATE_DUMP_TX_MSK = 0x200,
1436 AGG_TX_STATE_DELAY_TX_MSK = 0x400
1437};
1438
Wey-Yi Guye1b3fa02010-09-05 10:49:43 -07001439#define AGG_TX_STATUS_MSK 0x00000fff /* bits 0:11 */
1440#define AGG_TX_TRY_MSK 0x0000f000 /* bits 12:15 */
1441
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001442#define AGG_TX_STATE_LAST_SENT_MSK (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
1443 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
1444 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
Zhu Yib481de92007-09-25 17:54:57 -07001445
Ben Cahill52969982007-11-29 11:10:11 +08001446/* # tx attempts for first frame in aggregation */
Zhu Yib481de92007-09-25 17:54:57 -07001447#define AGG_TX_STATE_TRY_CNT_POS 12
1448#define AGG_TX_STATE_TRY_CNT_MSK 0xf000
1449
Ben Cahill52969982007-11-29 11:10:11 +08001450/* Command ID and sequence number of Tx command for this frame */
Zhu Yib481de92007-09-25 17:54:57 -07001451#define AGG_TX_STATE_SEQ_NUM_POS 16
1452#define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
1453
1454/*
1455 * REPLY_TX = 0x1c (response)
Ben Cahill52969982007-11-29 11:10:11 +08001456 *
1457 * This response may be in one of two slightly different formats, indicated
1458 * by the frame_count field:
1459 *
1460 * 1) No aggregation (frame_count == 1). This reports Tx results for
1461 * a single frame. Multiple attempts, at various bit rates, may have
1462 * been made for this frame.
1463 *
1464 * 2) Aggregation (frame_count > 1). This reports Tx results for
1465 * 2 or more frames that used block-acknowledge. All frames were
1466 * transmitted at same rate. Rate scaling may have been used if first
1467 * frame in this new agg block failed in previous agg block(s).
1468 *
1469 * Note that, for aggregation, ACK (block-ack) status is not delivered here;
Wey-Yi Guy767d0552010-08-23 07:56:53 -07001470 * block-ack has not been received by the time the agn device records
1471 * this status.
Ben Cahill52969982007-11-29 11:10:11 +08001472 * This status relates to reasons the tx might have been blocked or aborted
Wey-Yi Guy767d0552010-08-23 07:56:53 -07001473 * within the sending station (this agn device), rather than whether it was
Ben Cahill52969982007-11-29 11:10:11 +08001474 * received successfully by the destination station.
Zhu Yib481de92007-09-25 17:54:57 -07001475 */
Ron Rindjunsky001caff2008-05-29 16:35:07 +08001476struct agg_tx_status {
1477 __le16 status;
1478 __le16 sequence;
Eric Dumazetba2d3582010-06-02 18:10:09 +00001479} __packed;
Ron Rindjunsky001caff2008-05-29 16:35:07 +08001480
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001481/*
1482 * definitions for initial rate index field
Tomas Winklera96a27f2008-10-23 23:48:56 -07001483 * bits [3:0] initial rate index
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001484 * bits [6:4] rate table color, used for the initial rate
1485 * bit-7 invalid rate indication
1486 * i.e. rate was not chosen from rate table
1487 * or rate table color was changed during frame retries
1488 * refer tlc rate info
1489 */
1490
1491#define IWL50_TX_RES_INIT_RATE_INDEX_POS 0
1492#define IWL50_TX_RES_INIT_RATE_INDEX_MSK 0x0f
1493#define IWL50_TX_RES_RATE_TABLE_COLOR_POS 4
1494#define IWL50_TX_RES_RATE_TABLE_COLOR_MSK 0x70
1495#define IWL50_TX_RES_INV_RATE_INDEX_MSK 0x80
1496
1497/* refer to ra_tid */
Wey-Yi Guy898dade2010-09-20 09:12:33 -07001498#define IWLAGN_TX_RES_TID_POS 0
1499#define IWLAGN_TX_RES_TID_MSK 0x0f
1500#define IWLAGN_TX_RES_RA_POS 4
1501#define IWLAGN_TX_RES_RA_MSK 0xf0
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001502
Wey-Yi Guy898dade2010-09-20 09:12:33 -07001503struct iwlagn_tx_resp {
Ron Rindjunsky001caff2008-05-29 16:35:07 +08001504 u8 frame_count; /* 1 no aggregation, >1 aggregation */
1505 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
1506 u8 failure_rts; /* # failures due to unsuccessful RTS */
1507 u8 failure_frame; /* # failures due to no ACK (unused for agg) */
1508
1509 /* For non-agg: Rate at which frame was successful.
1510 * For agg: Rate at which all frames were transmitted. */
1511 __le32 rate_n_flags; /* RATE_MCS_* */
1512
1513 /* For non-agg: RTS + CTS + frame tx attempts time + ACK.
1514 * For agg: RTS + CTS + aggregation tx time + block-ack time. */
1515 __le16 wireless_media_time; /* uSecs */
1516
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001517 u8 pa_status; /* RF power amplifier measurement (not used) */
1518 u8 pa_integ_res_a[3];
1519 u8 pa_integ_res_b[3];
1520 u8 pa_integ_res_C[3];
Ron Rindjunsky001caff2008-05-29 16:35:07 +08001521
1522 __le32 tfd_info;
1523 __le16 seq_ctl;
1524 __le16 byte_cnt;
Tomas Winkler3fd07a12008-10-23 23:48:49 -07001525 u8 tlc_info;
1526 u8 ra_tid; /* tid (0:3), sta_id (4:7) */
1527 __le16 frame_ctrl;
Ron Rindjunsky001caff2008-05-29 16:35:07 +08001528 /*
1529 * For non-agg: frame status TX_STATUS_*
1530 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1531 * fields follow this one, up to frame_count.
1532 * Bit fields:
1533 * 11- 0: AGG_TX_STATE_* status code
1534 * 15-12: Retry count for 1st frame in aggregation (retries
1535 * occur if tx failed for this frame when it was a
1536 * member of a previous aggregation block). If rate
1537 * scaling is used, retry count indicates the rate
1538 * table entry used for all frames in the new agg.
1539 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1540 */
1541 struct agg_tx_status status; /* TX status (in aggregation -
1542 * status of 1st frame) */
Eric Dumazetba2d3582010-06-02 18:10:09 +00001543} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07001544/*
1545 * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
Ben Cahill52969982007-11-29 11:10:11 +08001546 *
1547 * Reports Block-Acknowledge from recipient station
Zhu Yib481de92007-09-25 17:54:57 -07001548 */
Emmanuel Grumbach653fa4a2008-06-30 17:23:11 +08001549struct iwl_compressed_ba_resp {
Zhu Yib481de92007-09-25 17:54:57 -07001550 __le32 sta_addr_lo32;
1551 __le16 sta_addr_hi16;
1552 __le16 reserved;
Ben Cahill52969982007-11-29 11:10:11 +08001553
1554 /* Index of recipient (BA-sending) station in uCode's station table */
Zhu Yib481de92007-09-25 17:54:57 -07001555 u8 sta_id;
1556 u8 tid;
Ron Rindjunskyfe01b472008-01-28 14:07:24 +02001557 __le16 seq_ctl;
1558 __le64 bitmap;
Zhu Yib481de92007-09-25 17:54:57 -07001559 __le16 scd_flow;
1560 __le16 scd_ssn;
Wey-Yi Guy8829c9e2010-11-10 11:05:38 -08001561 /* following only for 5000 series and up */
1562 u8 txed; /* number of frames sent */
1563 u8 txed_2_done; /* number of frames acked */
Eric Dumazetba2d3582010-06-02 18:10:09 +00001564} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07001565
1566/*
1567 * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
Ben Cahill2bdc7032007-11-29 11:10:12 +08001568 *
Zhu Yib481de92007-09-25 17:54:57 -07001569 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08001570
Zhu Yib481de92007-09-25 17:54:57 -07001571/*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
Reinette Chatre8a1b0242008-01-14 17:46:25 -08001572#define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0)
Zhu Yib481de92007-09-25 17:54:57 -07001573
Ben Cahill2bdc7032007-11-29 11:10:12 +08001574/* # of EDCA prioritized tx fifos */
Zhu Yib481de92007-09-25 17:54:57 -07001575#define LINK_QUAL_AC_NUM AC_NUM
Ben Cahill2bdc7032007-11-29 11:10:12 +08001576
1577/* # entries in rate scale table to support Tx retries */
Zhu Yib481de92007-09-25 17:54:57 -07001578#define LINK_QUAL_MAX_RETRY_NUM 16
1579
Ben Cahill2bdc7032007-11-29 11:10:12 +08001580/* Tx antenna selection values */
Reinette Chatre8a1b0242008-01-14 17:46:25 -08001581#define LINK_QUAL_ANT_A_MSK (1 << 0)
1582#define LINK_QUAL_ANT_B_MSK (1 << 1)
Zhu Yib481de92007-09-25 17:54:57 -07001583#define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
1584
Ben Cahill2bdc7032007-11-29 11:10:12 +08001585
1586/**
Tomas Winkler66c73db2008-04-15 16:01:40 -07001587 * struct iwl_link_qual_general_params
Ben Cahill2bdc7032007-11-29 11:10:12 +08001588 *
1589 * Used in REPLY_TX_LINK_QUALITY_CMD
1590 */
Tomas Winkler66c73db2008-04-15 16:01:40 -07001591struct iwl_link_qual_general_params {
Zhu Yib481de92007-09-25 17:54:57 -07001592 u8 flags;
Ben Cahill2bdc7032007-11-29 11:10:12 +08001593
1594 /* No entries at or above this (driver chosen) index contain MIMO */
Zhu Yib481de92007-09-25 17:54:57 -07001595 u8 mimo_delimiter;
Ben Cahill2bdc7032007-11-29 11:10:12 +08001596
1597 /* Best single antenna to use for single stream (legacy, SISO). */
1598 u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */
1599
1600 /* Best antennas to use for MIMO (unused for 4965, assumes both). */
1601 u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */
1602
1603 /*
1604 * If driver needs to use different initial rates for different
1605 * EDCA QOS access categories (as implemented by tx fifos 0-3),
1606 * this table will set that up, by indicating the indexes in the
1607 * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
1608 * Otherwise, driver should set all entries to 0.
1609 *
1610 * Entry usage:
1611 * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
1612 * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
1613 */
Zhu Yib481de92007-09-25 17:54:57 -07001614 u8 start_rate_index[LINK_QUAL_AC_NUM];
Eric Dumazetba2d3582010-06-02 18:10:09 +00001615} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07001616
Wey-Yi Guy13c33a02009-06-03 11:44:11 -07001617#define LINK_QUAL_AGG_TIME_LIMIT_DEF (4000) /* 4 milliseconds */
Wey-Yi Guyb15826a2010-07-28 09:18:53 -07001618#define LINK_QUAL_AGG_TIME_LIMIT_MAX (8000)
1619#define LINK_QUAL_AGG_TIME_LIMIT_MIN (100)
Wey-Yi Guy13c33a02009-06-03 11:44:11 -07001620
1621#define LINK_QUAL_AGG_DISABLE_START_DEF (3)
1622#define LINK_QUAL_AGG_DISABLE_START_MAX (255)
1623#define LINK_QUAL_AGG_DISABLE_START_MIN (0)
1624
Daniel Halperin42631082011-03-21 15:27:34 -07001625#define LINK_QUAL_AGG_FRAME_LIMIT_DEF (63)
Johannes Bergb623a9f2009-07-01 14:57:59 +02001626#define LINK_QUAL_AGG_FRAME_LIMIT_MAX (63)
Wey-Yi Guy13c33a02009-06-03 11:44:11 -07001627#define LINK_QUAL_AGG_FRAME_LIMIT_MIN (0)
1628
Ben Cahill2bdc7032007-11-29 11:10:12 +08001629/**
Tomas Winkler66c73db2008-04-15 16:01:40 -07001630 * struct iwl_link_qual_agg_params
Ben Cahill2bdc7032007-11-29 11:10:12 +08001631 *
1632 * Used in REPLY_TX_LINK_QUALITY_CMD
1633 */
Tomas Winkler66c73db2008-04-15 16:01:40 -07001634struct iwl_link_qual_agg_params {
Ben Cahill2bdc7032007-11-29 11:10:12 +08001635
Wey-Yi Guy74697012010-07-28 09:18:54 -07001636 /*
1637 *Maximum number of uSec in aggregation.
1638 * default set to 4000 (4 milliseconds) if not configured in .cfg
1639 */
Zhu Yib481de92007-09-25 17:54:57 -07001640 __le16 agg_time_limit;
Ben Cahill2bdc7032007-11-29 11:10:12 +08001641
1642 /*
1643 * Number of Tx retries allowed for a frame, before that frame will
1644 * no longer be considered for the start of an aggregation sequence
1645 * (scheduler will then try to tx it as single frame).
1646 * Driver should set this to 3.
1647 */
Zhu Yib481de92007-09-25 17:54:57 -07001648 u8 agg_dis_start_th;
Ben Cahill2bdc7032007-11-29 11:10:12 +08001649
1650 /*
1651 * Maximum number of frames in aggregation.
1652 * 0 = no limit (default). 1 = no aggregation.
1653 * Other values = max # frames in aggregation.
1654 */
Zhu Yib481de92007-09-25 17:54:57 -07001655 u8 agg_frame_cnt_limit;
Ben Cahill2bdc7032007-11-29 11:10:12 +08001656
Zhu Yib481de92007-09-25 17:54:57 -07001657 __le32 reserved;
Eric Dumazetba2d3582010-06-02 18:10:09 +00001658} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07001659
1660/*
1661 * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
Ben Cahill2bdc7032007-11-29 11:10:12 +08001662 *
Wey-Yi Guy767d0552010-08-23 07:56:53 -07001663 * For agn devices only; 3945 uses REPLY_RATE_SCALE.
Ben Cahill2bdc7032007-11-29 11:10:12 +08001664 *
Wey-Yi Guy767d0552010-08-23 07:56:53 -07001665 * Each station in the agn device's internal station table has its own table
1666 * of 16
Ben Cahill2bdc7032007-11-29 11:10:12 +08001667 * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
1668 * an ACK is not received. This command replaces the entire table for
1669 * one station.
1670 *
Wey-Yi Guy767d0552010-08-23 07:56:53 -07001671 * NOTE: Station must already be in agn device's station table.
1672 * Use REPLY_ADD_STA.
Ben Cahill2bdc7032007-11-29 11:10:12 +08001673 *
1674 * The rate scaling procedures described below work well. Of course, other
1675 * procedures are possible, and may work better for particular environments.
1676 *
1677 *
1678 * FILLING THE RATE TABLE
1679 *
1680 * Given a particular initial rate and mode, as determined by the rate
1681 * scaling algorithm described below, the Linux driver uses the following
1682 * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
1683 * Link Quality command:
1684 *
1685 *
1686 * 1) If using High-throughput (HT) (SISO or MIMO) initial rate:
1687 * a) Use this same initial rate for first 3 entries.
1688 * b) Find next lower available rate using same mode (SISO or MIMO),
1689 * use for next 3 entries. If no lower rate available, switch to
Wey-Yi Guy7aafef12009-08-07 15:41:38 -07001690 * legacy mode (no HT40 channel, no MIMO, no short guard interval).
Ben Cahill2bdc7032007-11-29 11:10:12 +08001691 * c) If using MIMO, set command's mimo_delimiter to number of entries
1692 * using MIMO (3 or 6).
Wey-Yi Guy7aafef12009-08-07 15:41:38 -07001693 * d) After trying 2 HT rates, switch to legacy mode (no HT40 channel,
Ben Cahill2bdc7032007-11-29 11:10:12 +08001694 * no MIMO, no short guard interval), at the next lower bit rate
1695 * (e.g. if second HT bit rate was 54, try 48 legacy), and follow
1696 * legacy procedure for remaining table entries.
1697 *
1698 * 2) If using legacy initial rate:
1699 * a) Use the initial rate for only one entry.
1700 * b) For each following entry, reduce the rate to next lower available
1701 * rate, until reaching the lowest available rate.
1702 * c) When reducing rate, also switch antenna selection.
1703 * d) Once lowest available rate is reached, repeat this rate until
1704 * rate table is filled (16 entries), switching antenna each entry.
1705 *
1706 *
1707 * ACCUMULATING HISTORY
1708 *
Wey-Yi Guy767d0552010-08-23 07:56:53 -07001709 * The rate scaling algorithm for agn devices, as implemented in Linux driver,
1710 * uses two sets of frame Tx success history: One for the current/active
1711 * modulation mode, and one for a speculative/search mode that is being
1712 * attempted. If the speculative mode turns out to be more effective (i.e.
1713 * actual transfer rate is better), then the driver continues to use the
1714 * speculative mode as the new current active mode.
Ben Cahill2bdc7032007-11-29 11:10:12 +08001715 *
1716 * Each history set contains, separately for each possible rate, data for a
1717 * sliding window of the 62 most recent tx attempts at that rate. The data
1718 * includes a shifting bitmap of success(1)/failure(0), and sums of successful
1719 * and attempted frames, from which the driver can additionally calculate a
1720 * success ratio (success / attempted) and number of failures
1721 * (attempted - success), and control the size of the window (attempted).
1722 * The driver uses the bit map to remove successes from the success sum, as
1723 * the oldest tx attempts fall out of the window.
1724 *
Wey-Yi Guy767d0552010-08-23 07:56:53 -07001725 * When the agn device makes multiple tx attempts for a given frame, each
1726 * attempt might be at a different rate, and have different modulation
1727 * characteristics (e.g. antenna, fat channel, short guard interval), as set
1728 * up in the rate scaling table in the Link Quality command. The driver must
1729 * determine which rate table entry was used for each tx attempt, to determine
1730 * which rate-specific history to update, and record only those attempts that
Ben Cahill2bdc7032007-11-29 11:10:12 +08001731 * match the modulation characteristics of the history set.
1732 *
1733 * When using block-ack (aggregation), all frames are transmitted at the same
Tomas Winklera96a27f2008-10-23 23:48:56 -07001734 * rate, since there is no per-attempt acknowledgment from the destination
Ben Cahill2bdc7032007-11-29 11:10:12 +08001735 * station. The Tx response struct iwl_tx_resp indicates the Tx rate in
1736 * rate_n_flags field. After receiving a block-ack, the driver can update
1737 * history for the entire block all at once.
1738 *
1739 *
1740 * FINDING BEST STARTING RATE:
1741 *
1742 * When working with a selected initial modulation mode (see below), the
1743 * driver attempts to find a best initial rate. The initial rate is the
1744 * first entry in the Link Quality command's rate table.
1745 *
1746 * 1) Calculate actual throughput (success ratio * expected throughput, see
1747 * table below) for current initial rate. Do this only if enough frames
1748 * have been attempted to make the value meaningful: at least 6 failed
1749 * tx attempts, or at least 8 successes. If not enough, don't try rate
1750 * scaling yet.
1751 *
1752 * 2) Find available rates adjacent to current initial rate. Available means:
1753 * a) supported by hardware &&
1754 * b) supported by association &&
1755 * c) within any constraints selected by user
1756 *
1757 * 3) Gather measured throughputs for adjacent rates. These might not have
1758 * enough history to calculate a throughput. That's okay, we might try
1759 * using one of them anyway!
1760 *
1761 * 4) Try decreasing rate if, for current rate:
1762 * a) success ratio is < 15% ||
1763 * b) lower adjacent rate has better measured throughput ||
1764 * c) higher adjacent rate has worse throughput, and lower is unmeasured
1765 *
1766 * As a sanity check, if decrease was determined above, leave rate
1767 * unchanged if:
1768 * a) lower rate unavailable
1769 * b) success ratio at current rate > 85% (very good)
1770 * c) current measured throughput is better than expected throughput
1771 * of lower rate (under perfect 100% tx conditions, see table below)
1772 *
1773 * 5) Try increasing rate if, for current rate:
1774 * a) success ratio is < 15% ||
1775 * b) both adjacent rates' throughputs are unmeasured (try it!) ||
1776 * b) higher adjacent rate has better measured throughput ||
1777 * c) lower adjacent rate has worse throughput, and higher is unmeasured
1778 *
1779 * As a sanity check, if increase was determined above, leave rate
1780 * unchanged if:
1781 * a) success ratio at current rate < 70%. This is not particularly
1782 * good performance; higher rate is sure to have poorer success.
1783 *
1784 * 6) Re-evaluate the rate after each tx frame. If working with block-
1785 * acknowledge, history and statistics may be calculated for the entire
1786 * block (including prior history that fits within the history windows),
1787 * before re-evaluation.
1788 *
1789 * FINDING BEST STARTING MODULATION MODE:
1790 *
1791 * After working with a modulation mode for a "while" (and doing rate scaling),
1792 * the driver searches for a new initial mode in an attempt to improve
1793 * throughput. The "while" is measured by numbers of attempted frames:
1794 *
1795 * For legacy mode, search for new mode after:
1796 * 480 successful frames, or 160 failed frames
1797 * For high-throughput modes (SISO or MIMO), search for new mode after:
1798 * 4500 successful frames, or 400 failed frames
1799 *
1800 * Mode switch possibilities are (3 for each mode):
1801 *
1802 * For legacy:
1803 * Change antenna, try SISO (if HT association), try MIMO (if HT association)
1804 * For SISO:
1805 * Change antenna, try MIMO, try shortened guard interval (SGI)
1806 * For MIMO:
1807 * Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)
1808 *
1809 * When trying a new mode, use the same bit rate as the old/current mode when
1810 * trying antenna switches and shortened guard interval. When switching to
1811 * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate
1812 * for which the expected throughput (under perfect conditions) is about the
1813 * same or slightly better than the actual measured throughput delivered by
1814 * the old/current mode.
1815 *
1816 * Actual throughput can be estimated by multiplying the expected throughput
1817 * by the success ratio (successful / attempted tx frames). Frame size is
1818 * not considered in this calculation; it assumes that frame size will average
1819 * out to be fairly consistent over several samples. The following are
1820 * metric values for expected throughput assuming 100% success ratio.
1821 * Only G band has support for CCK rates:
1822 *
1823 * RATE: 1 2 5 11 6 9 12 18 24 36 48 54 60
1824 *
1825 * G: 7 13 35 58 40 57 72 98 121 154 177 186 186
1826 * A: 0 0 0 0 40 57 72 98 121 154 177 186 186
1827 * SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 202
1828 * SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 211
1829 * MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 251
1830 * SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 257
1831 * SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 257
1832 * SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 264
1833 * MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 289
1834 * SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 293
1835 *
1836 * After the new mode has been tried for a short while (minimum of 6 failed
1837 * frames or 8 successful frames), compare success ratio and actual throughput
1838 * estimate of the new mode with the old. If either is better with the new
1839 * mode, continue to use the new mode.
1840 *
1841 * Continue comparing modes until all 3 possibilities have been tried.
1842 * If moving from legacy to HT, try all 3 possibilities from the new HT
1843 * mode. After trying all 3, a best mode is found. Continue to use this mode
1844 * for the longer "while" described above (e.g. 480 successful frames for
1845 * legacy), and then repeat the search process.
1846 *
Zhu Yib481de92007-09-25 17:54:57 -07001847 */
Tomas Winkler66c73db2008-04-15 16:01:40 -07001848struct iwl_link_quality_cmd {
Ben Cahill2bdc7032007-11-29 11:10:12 +08001849
1850 /* Index of destination/recipient station in uCode's station table */
Zhu Yib481de92007-09-25 17:54:57 -07001851 u8 sta_id;
1852 u8 reserved1;
Ben Cahill2bdc7032007-11-29 11:10:12 +08001853 __le16 control; /* not used */
Tomas Winkler66c73db2008-04-15 16:01:40 -07001854 struct iwl_link_qual_general_params general_params;
1855 struct iwl_link_qual_agg_params agg_params;
Ben Cahill2bdc7032007-11-29 11:10:12 +08001856
1857 /*
1858 * Rate info; when using rate-scaling, Tx command's initial_rate_index
1859 * specifies 1st Tx rate attempted, via index into this table.
Wey-Yi Guy767d0552010-08-23 07:56:53 -07001860 * agn devices works its way through table when retrying Tx.
Ben Cahill2bdc7032007-11-29 11:10:12 +08001861 */
Zhu Yib481de92007-09-25 17:54:57 -07001862 struct {
Ben Cahill2bdc7032007-11-29 11:10:12 +08001863 __le32 rate_n_flags; /* RATE_MCS_*, IWL_RATE_* */
Zhu Yib481de92007-09-25 17:54:57 -07001864 } rs_table[LINK_QUAL_MAX_RETRY_NUM];
1865 __le32 reserved2;
Eric Dumazetba2d3582010-06-02 18:10:09 +00001866} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07001867
Wey-Yi Guydab1c162010-01-22 14:22:50 -08001868/*
1869 * BT configuration enable flags:
1870 * bit 0 - 1: BT channel announcement enabled
1871 * 0: disable
1872 * bit 1 - 1: priority of BT device enabled
1873 * 0: disable
1874 * bit 2 - 1: BT 2 wire support enabled
1875 * 0: disable
1876 */
Wey-Yi Guy456d0f72009-10-23 13:42:23 -07001877#define BT_COEX_DISABLE (0x0)
Wey-Yi Guydab1c162010-01-22 14:22:50 -08001878#define BT_ENABLE_CHANNEL_ANNOUNCE BIT(0)
1879#define BT_ENABLE_PRIORITY BIT(1)
1880#define BT_ENABLE_2_WIRE BIT(2)
Wey-Yi Guy456d0f72009-10-23 13:42:23 -07001881
Wey-Yi Guy06702a72010-01-22 14:22:51 -08001882#define BT_COEX_DISABLE (0x0)
1883#define BT_COEX_ENABLE (BT_ENABLE_CHANNEL_ANNOUNCE | BT_ENABLE_PRIORITY)
1884
Wey-Yi Guy456d0f72009-10-23 13:42:23 -07001885#define BT_LEAD_TIME_MIN (0x0)
1886#define BT_LEAD_TIME_DEF (0x1E)
1887#define BT_LEAD_TIME_MAX (0xFF)
1888
1889#define BT_MAX_KILL_MIN (0x1)
1890#define BT_MAX_KILL_DEF (0x5)
1891#define BT_MAX_KILL_MAX (0xFF)
1892
Wey-Yi Guy22bf59a2010-08-23 07:57:11 -07001893#define BT_DURATION_LIMIT_DEF 625
1894#define BT_DURATION_LIMIT_MAX 1250
1895#define BT_DURATION_LIMIT_MIN 625
1896
1897#define BT_ON_THRESHOLD_DEF 4
1898#define BT_ON_THRESHOLD_MAX 1000
1899#define BT_ON_THRESHOLD_MIN 1
1900
1901#define BT_FRAG_THRESHOLD_DEF 0
1902#define BT_FRAG_THRESHOLD_MAX 0
1903#define BT_FRAG_THRESHOLD_MIN 0
1904
Wey-Yi Guy95a5ede2010-11-08 14:55:43 -08001905#define BT_AGG_THRESHOLD_DEF 1200
1906#define BT_AGG_THRESHOLD_MAX 8000
1907#define BT_AGG_THRESHOLD_MIN 400
Wey-Yi Guy22bf59a2010-08-23 07:57:11 -07001908
Zhu Yib481de92007-09-25 17:54:57 -07001909/*
1910 * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
Ben Cahill3058f022008-01-14 17:46:17 -08001911 *
Wey-Yi Guy767d0552010-08-23 07:56:53 -07001912 * 3945 and agn devices support hardware handshake with Bluetooth device on
Ben Cahill3058f022008-01-14 17:46:17 -08001913 * same platform. Bluetooth device alerts wireless device when it will Tx;
Tomas Winklera96a27f2008-10-23 23:48:56 -07001914 * wireless device can delay or kill its own Tx to accommodate.
Zhu Yib481de92007-09-25 17:54:57 -07001915 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08001916struct iwl_bt_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07001917 u8 flags;
1918 u8 lead_time;
1919 u8 max_kill;
1920 u8 reserved;
1921 __le32 kill_ack_mask;
1922 __le32 kill_cts_mask;
Eric Dumazetba2d3582010-06-02 18:10:09 +00001923} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07001924
Wey-Yi Guyb6e116e2010-08-23 07:57:14 -07001925#define IWLAGN_BT_FLAG_CHANNEL_INHIBITION BIT(0)
Johannes Berg670245e2010-08-23 07:56:55 -07001926
Wey-Yi Guyb6e116e2010-08-23 07:57:14 -07001927#define IWLAGN_BT_FLAG_COEX_MODE_MASK (BIT(3)|BIT(4)|BIT(5))
1928#define IWLAGN_BT_FLAG_COEX_MODE_SHIFT 3
1929#define IWLAGN_BT_FLAG_COEX_MODE_DISABLED 0
1930#define IWLAGN_BT_FLAG_COEX_MODE_LEGACY_2W 1
1931#define IWLAGN_BT_FLAG_COEX_MODE_3W 2
1932#define IWLAGN_BT_FLAG_COEX_MODE_4W 3
Johannes Berg670245e2010-08-23 07:56:55 -07001933
Wey-Yi Guyeeb1f832010-11-23 10:58:52 -08001934#define IWLAGN_BT_FLAG_UCODE_DEFAULT BIT(6)
1935/* Disable Sync PSPoll on SCO/eSCO */
1936#define IWLAGN_BT_FLAG_SYNC_2_BT_DISABLE BIT(7)
Johannes Berg670245e2010-08-23 07:56:55 -07001937
Wey-Yi Guyb6e116e2010-08-23 07:57:14 -07001938#define IWLAGN_BT_PRIO_BOOST_MAX 0xFF
1939#define IWLAGN_BT_PRIO_BOOST_MIN 0x00
1940#define IWLAGN_BT_PRIO_BOOST_DEFAULT 0xF0
Johannes Berg670245e2010-08-23 07:56:55 -07001941
Wey-Yi Guyb6e116e2010-08-23 07:57:14 -07001942#define IWLAGN_BT_MAX_KILL_DEFAULT 5
Johannes Berg670245e2010-08-23 07:56:55 -07001943
Wey-Yi Guyb6e116e2010-08-23 07:57:14 -07001944#define IWLAGN_BT3_T7_DEFAULT 1
Johannes Berg670245e2010-08-23 07:56:55 -07001945
Wey-Yi Guy05433df2010-11-08 12:37:20 -08001946#define IWLAGN_BT_KILL_ACK_MASK_DEFAULT cpu_to_le32(0xffff0000)
1947#define IWLAGN_BT_KILL_CTS_MASK_DEFAULT cpu_to_le32(0xffff0000)
Wey-Yi Guy506aa152010-11-24 17:25:03 -08001948#define IWLAGN_BT_KILL_ACK_CTS_MASK_SCO cpu_to_le32(0xffffffff)
Johannes Berg670245e2010-08-23 07:56:55 -07001949
Wey-Yi Guyb6e116e2010-08-23 07:57:14 -07001950#define IWLAGN_BT3_PRIO_SAMPLE_DEFAULT 2
Johannes Berg670245e2010-08-23 07:56:55 -07001951
Wey-Yi Guyb6e116e2010-08-23 07:57:14 -07001952#define IWLAGN_BT3_T2_DEFAULT 0xc
Johannes Berg670245e2010-08-23 07:56:55 -07001953
Wey-Yi Guyb6e116e2010-08-23 07:57:14 -07001954#define IWLAGN_BT_VALID_ENABLE_FLAGS cpu_to_le16(BIT(0))
1955#define IWLAGN_BT_VALID_BOOST cpu_to_le16(BIT(1))
1956#define IWLAGN_BT_VALID_MAX_KILL cpu_to_le16(BIT(2))
1957#define IWLAGN_BT_VALID_3W_TIMERS cpu_to_le16(BIT(3))
1958#define IWLAGN_BT_VALID_KILL_ACK_MASK cpu_to_le16(BIT(4))
1959#define IWLAGN_BT_VALID_KILL_CTS_MASK cpu_to_le16(BIT(5))
1960#define IWLAGN_BT_VALID_BT4_TIMES cpu_to_le16(BIT(6))
1961#define IWLAGN_BT_VALID_3W_LUT cpu_to_le16(BIT(7))
Johannes Berg670245e2010-08-23 07:56:55 -07001962
Wey-Yi Guyb6e116e2010-08-23 07:57:14 -07001963#define IWLAGN_BT_ALL_VALID_MSK (IWLAGN_BT_VALID_ENABLE_FLAGS | \
1964 IWLAGN_BT_VALID_BOOST | \
1965 IWLAGN_BT_VALID_MAX_KILL | \
1966 IWLAGN_BT_VALID_3W_TIMERS | \
1967 IWLAGN_BT_VALID_KILL_ACK_MASK | \
1968 IWLAGN_BT_VALID_KILL_CTS_MASK | \
1969 IWLAGN_BT_VALID_BT4_TIMES | \
1970 IWLAGN_BT_VALID_3W_LUT)
Johannes Berg670245e2010-08-23 07:56:55 -07001971
Wey-Yi Guy60132702011-02-18 17:23:54 -08001972struct iwl_basic_bt_cmd {
Johannes Berg670245e2010-08-23 07:56:55 -07001973 u8 flags;
1974 u8 ledtime; /* unused */
1975 u8 max_kill;
1976 u8 bt3_timer_t7_value;
1977 __le32 kill_ack_mask;
1978 __le32 kill_cts_mask;
1979 u8 bt3_prio_sample_time;
1980 u8 bt3_timer_t2_value;
1981 __le16 bt4_reaction_time; /* unused */
1982 __le32 bt3_lookup_table[12];
1983 __le16 bt4_decision_time; /* unused */
1984 __le16 valid;
Wey-Yi Guy60132702011-02-18 17:23:54 -08001985};
1986
1987struct iwl6000_bt_cmd {
1988 struct iwl_basic_bt_cmd basic;
Johannes Berg670245e2010-08-23 07:56:55 -07001989 u8 prio_boost;
Wey-Yi Guyb345f4d2010-09-13 07:51:03 -07001990 /*
1991 * set IWLAGN_BT_VALID_BOOST to "1" in "valid" bitmask
1992 * if configure the following patterns
1993 */
1994 u8 tx_prio_boost; /* SW boost of WiFi tx priority */
1995 __le16 rx_prio_boost; /* SW boost of WiFi rx priority */
Johannes Berg670245e2010-08-23 07:56:55 -07001996};
1997
Wey-Yi Guyd6f62652011-02-18 17:23:51 -08001998struct iwl2000_bt_cmd {
Wey-Yi Guy60132702011-02-18 17:23:54 -08001999 struct iwl_basic_bt_cmd basic;
Wey-Yi Guyd6f62652011-02-18 17:23:51 -08002000 __le32 prio_boost;
2001 /*
2002 * set IWLAGN_BT_VALID_BOOST to "1" in "valid" bitmask
2003 * if configure the following patterns
2004 */
2005 u8 reserved;
2006 u8 tx_prio_boost; /* SW boost of WiFi tx priority */
2007 __le16 rx_prio_boost; /* SW boost of WiFi rx priority */
2008};
2009
Wey-Yi Guyb6e116e2010-08-23 07:57:14 -07002010#define IWLAGN_BT_SCO_ACTIVE cpu_to_le32(BIT(0))
Johannes Berg9e4afc22010-08-23 07:56:57 -07002011
Wey-Yi Guyb6e116e2010-08-23 07:57:14 -07002012struct iwlagn_bt_sco_cmd {
Johannes Berg9e4afc22010-08-23 07:56:57 -07002013 __le32 flags;
2014};
2015
Zhu Yib481de92007-09-25 17:54:57 -07002016/******************************************************************************
2017 * (6)
2018 * Spectrum Management (802.11h) Commands, Responses, Notifications:
2019 *
2020 *****************************************************************************/
2021
2022/*
2023 * Spectrum Management
2024 */
2025#define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \
2026 RXON_FILTER_CTL2HOST_MSK | \
2027 RXON_FILTER_ACCEPT_GRP_MSK | \
2028 RXON_FILTER_DIS_DECRYPT_MSK | \
2029 RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
2030 RXON_FILTER_ASSOC_MSK | \
2031 RXON_FILTER_BCON_AWARE_MSK)
2032
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002033struct iwl_measure_channel {
Zhu Yib481de92007-09-25 17:54:57 -07002034 __le32 duration; /* measurement duration in extended beacon
2035 * format */
2036 u8 channel; /* channel to measure */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002037 u8 type; /* see enum iwl_measure_type */
Zhu Yib481de92007-09-25 17:54:57 -07002038 __le16 reserved;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002039} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002040
2041/*
2042 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
2043 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002044struct iwl_spectrum_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07002045 __le16 len; /* number of bytes starting from token */
2046 u8 token; /* token id */
2047 u8 id; /* measurement id -- 0 or 1 */
2048 u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */
2049 u8 periodic; /* 1 = periodic */
2050 __le16 path_loss_timeout;
2051 __le32 start_time; /* start time in extended beacon format */
2052 __le32 reserved2;
2053 __le32 flags; /* rxon flags */
2054 __le32 filter_flags; /* rxon filter flags */
2055 __le16 channel_count; /* minimum 1, maximum 10 */
2056 __le16 reserved3;
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002057 struct iwl_measure_channel channels[10];
Eric Dumazetba2d3582010-06-02 18:10:09 +00002058} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002059
2060/*
2061 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
2062 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002063struct iwl_spectrum_resp {
Zhu Yib481de92007-09-25 17:54:57 -07002064 u8 token;
2065 u8 id; /* id of the prior command replaced, or 0xff */
2066 __le16 status; /* 0 - command will be handled
2067 * 1 - cannot handle (conflicts with another
2068 * measurement) */
Eric Dumazetba2d3582010-06-02 18:10:09 +00002069} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002070
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002071enum iwl_measurement_state {
Zhu Yib481de92007-09-25 17:54:57 -07002072 IWL_MEASUREMENT_START = 0,
2073 IWL_MEASUREMENT_STOP = 1,
2074};
2075
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002076enum iwl_measurement_status {
Zhu Yib481de92007-09-25 17:54:57 -07002077 IWL_MEASUREMENT_OK = 0,
2078 IWL_MEASUREMENT_CONCURRENT = 1,
2079 IWL_MEASUREMENT_CSA_CONFLICT = 2,
2080 IWL_MEASUREMENT_TGH_CONFLICT = 3,
2081 /* 4-5 reserved */
2082 IWL_MEASUREMENT_STOPPED = 6,
2083 IWL_MEASUREMENT_TIMEOUT = 7,
2084 IWL_MEASUREMENT_PERIODIC_FAILED = 8,
2085};
2086
2087#define NUM_ELEMENTS_IN_HISTOGRAM 8
2088
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002089struct iwl_measurement_histogram {
Zhu Yib481de92007-09-25 17:54:57 -07002090 __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
2091 __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */
Eric Dumazetba2d3582010-06-02 18:10:09 +00002092} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002093
2094/* clear channel availability counters */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002095struct iwl_measurement_cca_counters {
Zhu Yib481de92007-09-25 17:54:57 -07002096 __le32 ofdm;
2097 __le32 cck;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002098} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002099
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002100enum iwl_measure_type {
Zhu Yib481de92007-09-25 17:54:57 -07002101 IWL_MEASURE_BASIC = (1 << 0),
2102 IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
2103 IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
2104 IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
2105 IWL_MEASURE_FRAME = (1 << 4),
2106 /* bits 5:6 are reserved */
2107 IWL_MEASURE_IDLE = (1 << 7),
2108};
2109
2110/*
2111 * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
2112 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002113struct iwl_spectrum_notification {
Zhu Yib481de92007-09-25 17:54:57 -07002114 u8 id; /* measurement id -- 0 or 1 */
2115 u8 token;
2116 u8 channel_index; /* index in measurement channel list */
2117 u8 state; /* 0 - start, 1 - stop */
2118 __le32 start_time; /* lower 32-bits of TSF */
2119 u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */
2120 u8 channel;
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002121 u8 type; /* see enum iwl_measurement_type */
Zhu Yib481de92007-09-25 17:54:57 -07002122 u8 reserved1;
2123 /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only
2124 * valid if applicable for measurement type requested. */
2125 __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */
2126 __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */
2127 __le32 cca_time; /* channel load time in usecs */
2128 u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 -
2129 * unidentified */
2130 u8 reserved2[3];
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002131 struct iwl_measurement_histogram histogram;
Zhu Yib481de92007-09-25 17:54:57 -07002132 __le32 stop_time; /* lower 32-bits of TSF */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002133 __le32 status; /* see iwl_measurement_status */
Eric Dumazetba2d3582010-06-02 18:10:09 +00002134} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002135
2136/******************************************************************************
2137 * (7)
2138 * Power Management Commands, Responses, Notifications:
2139 *
2140 *****************************************************************************/
2141
2142/**
Mohamed Abbasca579612008-07-18 13:52:57 +08002143 * struct iwl_powertable_cmd - Power Table Command
Zhu Yib481de92007-09-25 17:54:57 -07002144 * @flags: See below:
2145 *
2146 * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
2147 *
2148 * PM allow:
2149 * bit 0 - '0' Driver not allow power management
2150 * '1' Driver allow PM (use rest of parameters)
Johannes Berge312c242009-08-07 15:41:51 -07002151 *
Zhu Yib481de92007-09-25 17:54:57 -07002152 * uCode send sleep notifications:
2153 * bit 1 - '0' Don't send sleep notification
2154 * '1' send sleep notification (SEND_PM_NOTIFICATION)
Johannes Berge312c242009-08-07 15:41:51 -07002155 *
Zhu Yib481de92007-09-25 17:54:57 -07002156 * Sleep over DTIM
2157 * bit 2 - '0' PM have to walk up every DTIM
2158 * '1' PM could sleep over DTIM till listen Interval.
Johannes Berge312c242009-08-07 15:41:51 -07002159 *
Zhu Yib481de92007-09-25 17:54:57 -07002160 * PCI power managed
Tomas Winklere7b63582008-09-03 11:26:49 +08002161 * bit 3 - '0' (PCI_CFG_LINK_CTRL & 0x1)
2162 * '1' !(PCI_CFG_LINK_CTRL & 0x1)
Johannes Berge312c242009-08-07 15:41:51 -07002163 *
2164 * Fast PD
2165 * bit 4 - '1' Put radio to sleep when receiving frame for others
2166 *
Zhu Yib481de92007-09-25 17:54:57 -07002167 * Force sleep Modes
2168 * bit 31/30- '00' use both mac/xtal sleeps
2169 * '01' force Mac sleep
2170 * '10' force xtal sleep
2171 * '11' Illegal set
2172 *
2173 * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
Tomas Winklera96a27f2008-10-23 23:48:56 -07002174 * ucode assume sleep over DTIM is allowed and we don't need to wake up
Zhu Yib481de92007-09-25 17:54:57 -07002175 * for every DTIM.
2176 */
2177#define IWL_POWER_VEC_SIZE 5
2178
Tomas Winkler600c0e12008-12-19 10:37:04 +08002179#define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK cpu_to_le16(BIT(0))
Wey-Yi Guy35162ba2010-11-23 10:58:56 -08002180#define IWL_POWER_POWER_SAVE_ENA_MSK cpu_to_le16(BIT(0))
2181#define IWL_POWER_POWER_MANAGEMENT_ENA_MSK cpu_to_le16(BIT(1))
Tomas Winkler600c0e12008-12-19 10:37:04 +08002182#define IWL_POWER_SLEEP_OVER_DTIM_MSK cpu_to_le16(BIT(2))
2183#define IWL_POWER_PCI_PM_MSK cpu_to_le16(BIT(3))
2184#define IWL_POWER_FAST_PD cpu_to_le16(BIT(4))
Wey-Yi Guy97badb02010-11-23 10:58:53 -08002185#define IWL_POWER_BEACON_FILTERING cpu_to_le16(BIT(5))
2186#define IWL_POWER_SHADOW_REG_ENA cpu_to_le16(BIT(6))
2187#define IWL_POWER_CT_KILL_SET cpu_to_le16(BIT(7))
2188#define IWL_POWER_BT_SCO_ENA cpu_to_le16(BIT(8))
Wey-Yi Guy35162ba2010-11-23 10:58:56 -08002189#define IWL_POWER_ADVANCE_PM_ENA_MSK cpu_to_le16(BIT(9))
Tomas Winkler600c0e12008-12-19 10:37:04 +08002190
Mohamed Abbasca579612008-07-18 13:52:57 +08002191struct iwl_powertable_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07002192 __le16 flags;
Tomas Winkler600c0e12008-12-19 10:37:04 +08002193 u8 keep_alive_seconds; /* 3945 reserved */
2194 u8 debug_flags; /* 3945 reserved */
Zhu Yib481de92007-09-25 17:54:57 -07002195 __le32 rx_data_timeout;
2196 __le32 tx_data_timeout;
2197 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
2198 __le32 keep_alive_beacons;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002199} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002200
2201/*
2202 * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
Wey-Yi Guy767d0552010-08-23 07:56:53 -07002203 * all devices identical.
Zhu Yib481de92007-09-25 17:54:57 -07002204 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002205struct iwl_sleep_notification {
Zhu Yib481de92007-09-25 17:54:57 -07002206 u8 pm_sleep_mode;
2207 u8 pm_wakeup_src;
2208 __le16 reserved;
2209 __le32 sleep_time;
2210 __le32 tsf_low;
2211 __le32 bcon_timer;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002212} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002213
Wey-Yi Guy767d0552010-08-23 07:56:53 -07002214/* Sleep states. all devices identical. */
Zhu Yib481de92007-09-25 17:54:57 -07002215enum {
2216 IWL_PM_NO_SLEEP = 0,
2217 IWL_PM_SLP_MAC = 1,
2218 IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
2219 IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
2220 IWL_PM_SLP_PHY = 4,
2221 IWL_PM_SLP_REPENT = 5,
2222 IWL_PM_WAKEUP_BY_TIMER = 6,
2223 IWL_PM_WAKEUP_BY_DRIVER = 7,
2224 IWL_PM_WAKEUP_BY_RFKILL = 8,
2225 /* 3 reserved */
2226 IWL_PM_NUM_OF_MODES = 12,
2227};
2228
2229/*
2230 * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
2231 */
2232#define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */
2233#define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */
2234#define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002235struct iwl_card_state_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07002236 __le32 status; /* CARD_STATE_CMD_* request new power state */
Eric Dumazetba2d3582010-06-02 18:10:09 +00002237} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002238
2239/*
2240 * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
2241 */
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002242struct iwl_card_state_notif {
Zhu Yib481de92007-09-25 17:54:57 -07002243 __le32 flags;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002244} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002245
2246#define HW_CARD_DISABLED 0x01
2247#define SW_CARD_DISABLED 0x02
Wey-Yi Guy3a41bbd2009-12-10 14:37:24 -08002248#define CT_CARD_DISABLED 0x04
Zhu Yib481de92007-09-25 17:54:57 -07002249#define RXON_CARD_DISABLED 0x10
2250
Emmanuel Grumbach47f4a582008-06-12 09:47:13 +08002251struct iwl_ct_kill_config {
Zhu Yib481de92007-09-25 17:54:57 -07002252 __le32 reserved;
2253 __le32 critical_temperature_M;
2254 __le32 critical_temperature_R;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002255} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002256
Wey-Yi Guy672639d2009-07-24 11:13:01 -07002257/* 1000, and 6x00 */
2258struct iwl_ct_kill_throttling_config {
2259 __le32 critical_temperature_exit;
2260 __le32 reserved;
2261 __le32 critical_temperature_enter;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002262} __packed;
Wey-Yi Guy672639d2009-07-24 11:13:01 -07002263
Zhu Yib481de92007-09-25 17:54:57 -07002264/******************************************************************************
2265 * (8)
2266 * Scan Commands, Responses, Notifications:
2267 *
2268 *****************************************************************************/
2269
Harvey Harrison51e9bf52008-11-26 13:12:52 -08002270#define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0)
2271#define SCAN_CHANNEL_TYPE_ACTIVE cpu_to_le32(1)
Tomas Winklerd16dc482008-07-11 11:53:38 +08002272
Ben Cahill3058f022008-01-14 17:46:17 -08002273/**
Tomas Winkler2a421b92008-06-12 09:47:10 +08002274 * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table
Ben Cahill3058f022008-01-14 17:46:17 -08002275 *
2276 * One for each channel in the scan list.
2277 * Each channel can independently select:
2278 * 1) SSID for directed active scans
2279 * 2) Txpower setting (for rate specified within Tx command)
2280 * 3) How long to stay on-channel (behavior may be modified by quiet_time,
2281 * quiet_plcp_th, good_CRC_th)
2282 *
2283 * To avoid uCode errors, make sure the following are true (see comments
Tomas Winkler2a421b92008-06-12 09:47:10 +08002284 * under struct iwl_scan_cmd about max_out_time and quiet_time):
Ben Cahill3058f022008-01-14 17:46:17 -08002285 * 1) If using passive_dwell (i.e. passive_dwell != 0):
2286 * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
2287 * 2) quiet_time <= active_dwell
2288 * 3) If restricting off-channel time (i.e. max_out_time !=0):
2289 * passive_dwell < max_out_time
2290 * active_dwell < max_out_time
2291 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08002292
Tomas Winkler2a421b92008-06-12 09:47:10 +08002293struct iwl_scan_channel {
Ben Cahill3058f022008-01-14 17:46:17 -08002294 /*
2295 * type is defined as:
2296 * 0:0 1 = active, 0 = passive
Tomas Winklerd16dc482008-07-11 11:53:38 +08002297 * 1:20 SSID direct bit map; if a bit is set, then corresponding
Ben Cahill3058f022008-01-14 17:46:17 -08002298 * SSID IE is transmitted in probe request.
Tomas Winklerd16dc482008-07-11 11:53:38 +08002299 * 21:31 reserved
Zhu Yib481de92007-09-25 17:54:57 -07002300 */
Tomas Winklerd16dc482008-07-11 11:53:38 +08002301 __le32 type;
2302 __le16 channel; /* band is selected by iwl_scan_cmd "flags" field */
Tomas Winklerf53696d2008-06-12 09:47:12 +08002303 u8 tx_gain; /* gain for analog radio */
2304 u8 dsp_atten; /* gain for DSP */
Ben Cahill3058f022008-01-14 17:46:17 -08002305 __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */
2306 __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */
Eric Dumazetba2d3582010-06-02 18:10:09 +00002307} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002308
Winkler, Tomas0d210442009-01-23 13:45:21 -08002309/* set number of direct probes __le32 type */
2310#define IWL_SCAN_PROBE_MASK(n) cpu_to_le32((BIT(n) | (BIT(n) - BIT(1))))
2311
Ben Cahill3058f022008-01-14 17:46:17 -08002312/**
Tomas Winkler2a421b92008-06-12 09:47:10 +08002313 * struct iwl_ssid_ie - directed scan network information element
Ben Cahill3058f022008-01-14 17:46:17 -08002314 *
Ben Cahill2a3b7932009-11-06 14:52:59 -08002315 * Up to 20 of these may appear in REPLY_SCAN_CMD (Note: Only 4 are in
2316 * 3945 SCAN api), selected by "type" bit field in struct iwl_scan_channel;
2317 * each channel may select different ssids from among the 20 (4) entries.
2318 * SSID IEs get transmitted in reverse order of entry.
Ben Cahill3058f022008-01-14 17:46:17 -08002319 */
Tomas Winkler2a421b92008-06-12 09:47:10 +08002320struct iwl_ssid_ie {
Zhu Yib481de92007-09-25 17:54:57 -07002321 u8 id;
2322 u8 len;
2323 u8 ssid[32];
Eric Dumazetba2d3582010-06-02 18:10:09 +00002324} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002325
Johannes Berg9b3bf062009-04-20 14:36:55 -07002326#define PROBE_OPTION_MAX_3945 4
2327#define PROBE_OPTION_MAX 20
Harvey Harrison51e9bf52008-11-26 13:12:52 -08002328#define TX_CMD_LIFE_TIME_INFINITE cpu_to_le32(0xFFFFFFFF)
Johannes Berg96ff5642010-04-30 14:42:15 -07002329#define IWL_GOOD_CRC_TH_DISABLED 0
2330#define IWL_GOOD_CRC_TH_DEFAULT cpu_to_le16(1)
2331#define IWL_GOOD_CRC_TH_NEVER cpu_to_le16(0xffff)
Zhu Yib481de92007-09-25 17:54:57 -07002332#define IWL_MAX_SCAN_SIZE 1024
Abhijeet Kolekar89612122010-02-19 11:49:49 -08002333#define IWL_MAX_CMD_SIZE 4096
Zhu Yib481de92007-09-25 17:54:57 -07002334
2335/*
2336 * REPLY_SCAN_CMD = 0x80 (command)
Ben Cahill3058f022008-01-14 17:46:17 -08002337 *
2338 * The hardware scan command is very powerful; the driver can set it up to
2339 * maintain (relatively) normal network traffic while doing a scan in the
2340 * background. The max_out_time and suspend_time control the ratio of how
2341 * long the device stays on an associated network channel ("service channel")
2342 * vs. how long it's away from the service channel, i.e. tuned to other channels
2343 * for scanning.
2344 *
2345 * max_out_time is the max time off-channel (in usec), and suspend_time
2346 * is how long (in "extended beacon" format) that the scan is "suspended"
2347 * after returning to the service channel. That is, suspend_time is the
2348 * time that we stay on the service channel, doing normal work, between
2349 * scan segments. The driver may set these parameters differently to support
2350 * scanning when associated vs. not associated, and light vs. heavy traffic
2351 * loads when associated.
2352 *
2353 * After receiving this command, the device's scan engine does the following;
2354 *
2355 * 1) Sends SCAN_START notification to driver
2356 * 2) Checks to see if it has time to do scan for one channel
2357 * 3) Sends NULL packet, with power-save (PS) bit set to 1,
2358 * to tell AP that we're going off-channel
2359 * 4) Tunes to first channel in scan list, does active or passive scan
2360 * 5) Sends SCAN_RESULT notification to driver
2361 * 6) Checks to see if it has time to do scan on *next* channel in list
2362 * 7) Repeats 4-6 until it no longer has time to scan the next channel
2363 * before max_out_time expires
2364 * 8) Returns to service channel
2365 * 9) Sends NULL packet with PS=0 to tell AP that we're back
2366 * 10) Stays on service channel until suspend_time expires
2367 * 11) Repeats entire process 2-10 until list is complete
2368 * 12) Sends SCAN_COMPLETE notification
2369 *
2370 * For fast, efficient scans, the scan command also has support for staying on
2371 * a channel for just a short time, if doing active scanning and getting no
2372 * responses to the transmitted probe request. This time is controlled by
2373 * quiet_time, and the number of received packets below which a channel is
2374 * considered "quiet" is controlled by quiet_plcp_threshold.
2375 *
2376 * For active scanning on channels that have regulatory restrictions against
2377 * blindly transmitting, the scan can listen before transmitting, to make sure
2378 * that there is already legitimate activity on the channel. If enough
2379 * packets are cleanly received on the channel (controlled by good_CRC_th,
2380 * typical value 1), the scan engine starts transmitting probe requests.
2381 *
2382 * Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
2383 *
2384 * To avoid uCode errors, see timing restrictions described under
Tomas Winkler2a421b92008-06-12 09:47:10 +08002385 * struct iwl_scan_channel.
Zhu Yib481de92007-09-25 17:54:57 -07002386 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08002387
Johannes Berg266af4c72011-03-10 20:13:26 -08002388enum iwl_scan_flags {
2389 /* BIT(0) currently unused */
2390 IWL_SCAN_FLAGS_ACTION_FRAME_TX = BIT(1),
2391 /* bits 2-7 reserved */
2392};
2393
Tomas Winkler2a421b92008-06-12 09:47:10 +08002394struct iwl_scan_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07002395 __le16 len;
Johannes Berg266af4c72011-03-10 20:13:26 -08002396 u8 scan_flags; /* scan flags: see enum iwl_scan_flags */
Ben Cahill3058f022008-01-14 17:46:17 -08002397 u8 channel_count; /* # channels in channel list */
2398 __le16 quiet_time; /* dwell only this # millisecs on quiet channel
2399 * (only for active scan) */
2400 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
2401 __le16 good_CRC_th; /* passive -> active promotion threshold */
2402 __le16 rx_chain; /* RXON_RX_CHAIN_* */
2403 __le32 max_out_time; /* max usec to be away from associated (service)
2404 * channel */
2405 __le32 suspend_time; /* pause scan this long (in "extended beacon
2406 * format") when returning to service chnl:
2407 * 3945; 31:24 # beacons, 19:0 additional usec,
2408 * 4965; 31:22 # beacons, 21:0 additional usec.
2409 */
2410 __le32 flags; /* RXON_FLG_* */
2411 __le32 filter_flags; /* RXON_FILTER_* */
Zhu Yib481de92007-09-25 17:54:57 -07002412
Ben Cahill3058f022008-01-14 17:46:17 -08002413 /* For active scans (set to all-0s for passive scans).
2414 * Does not include payload. Must specify Tx rate; no rate scaling. */
Tomas Winkler83d527d2008-05-15 13:54:05 +08002415 struct iwl_tx_cmd tx_cmd;
Ben Cahill3058f022008-01-14 17:46:17 -08002416
2417 /* For directed active scans (set to all-0s otherwise) */
Tomas Winkler2a421b92008-06-12 09:47:10 +08002418 struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
Zhu Yib481de92007-09-25 17:54:57 -07002419
Zhu Yib481de92007-09-25 17:54:57 -07002420 /*
Ben Cahill3058f022008-01-14 17:46:17 -08002421 * Probe request frame, followed by channel list.
2422 *
2423 * Size of probe request frame is specified by byte count in tx_cmd.
2424 * Channel list follows immediately after probe request frame.
2425 * Number of channels in list is specified by channel_count.
2426 * Each channel in list is of type:
Zhu Yib481de92007-09-25 17:54:57 -07002427 *
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002428 * struct iwl_scan_channel channels[0];
Zhu Yib481de92007-09-25 17:54:57 -07002429 *
2430 * NOTE: Only one band of channels can be scanned per pass. You
Ben Cahill3058f022008-01-14 17:46:17 -08002431 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
2432 * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
2433 * before requesting another scan.
Zhu Yib481de92007-09-25 17:54:57 -07002434 */
Ben Cahill3058f022008-01-14 17:46:17 -08002435 u8 data[0];
Eric Dumazetba2d3582010-06-02 18:10:09 +00002436} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002437
2438/* Can abort will notify by complete notification with abort status. */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08002439#define CAN_ABORT_STATUS cpu_to_le32(0x1)
Zhu Yib481de92007-09-25 17:54:57 -07002440/* complete notification statuses */
2441#define ABORT_STATUS 0x2
2442
2443/*
2444 * REPLY_SCAN_CMD = 0x80 (response)
2445 */
Tomas Winkler2a421b92008-06-12 09:47:10 +08002446struct iwl_scanreq_notification {
Zhu Yib481de92007-09-25 17:54:57 -07002447 __le32 status; /* 1: okay, 2: cannot fulfill request */
Eric Dumazetba2d3582010-06-02 18:10:09 +00002448} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002449
2450/*
2451 * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
2452 */
Tomas Winkler2a421b92008-06-12 09:47:10 +08002453struct iwl_scanstart_notification {
Zhu Yib481de92007-09-25 17:54:57 -07002454 __le32 tsf_low;
2455 __le32 tsf_high;
2456 __le32 beacon_timer;
2457 u8 channel;
2458 u8 band;
2459 u8 reserved[2];
2460 __le32 status;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002461} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002462
2463#define SCAN_OWNER_STATUS 0x1;
2464#define MEASURE_OWNER_STATUS 0x2;
2465
Johannes Berg0288d232010-08-23 07:56:54 -07002466#define IWL_PROBE_STATUS_OK 0
2467#define IWL_PROBE_STATUS_TX_FAILED BIT(0)
2468/* error statuses combined with TX_FAILED */
2469#define IWL_PROBE_STATUS_FAIL_TTL BIT(1)
2470#define IWL_PROBE_STATUS_FAIL_BT BIT(2)
2471
Zhu Yib481de92007-09-25 17:54:57 -07002472#define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */
2473/*
2474 * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
2475 */
Tomas Winkler2a421b92008-06-12 09:47:10 +08002476struct iwl_scanresults_notification {
Zhu Yib481de92007-09-25 17:54:57 -07002477 u8 channel;
2478 u8 band;
Johannes Berg0288d232010-08-23 07:56:54 -07002479 u8 probe_status;
2480 u8 num_probe_not_sent; /* not enough time to send */
Zhu Yib481de92007-09-25 17:54:57 -07002481 __le32 tsf_low;
2482 __le32 tsf_high;
2483 __le32 statistics[NUMBER_OF_STATISTICS];
Eric Dumazetba2d3582010-06-02 18:10:09 +00002484} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002485
2486/*
2487 * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
2488 */
Tomas Winkler2a421b92008-06-12 09:47:10 +08002489struct iwl_scancomplete_notification {
Zhu Yib481de92007-09-25 17:54:57 -07002490 u8 scanned_channels;
2491 u8 status;
Wey-Yi Guyf78e5452010-08-23 07:57:15 -07002492 u8 bt_status; /* BT On/Off status */
Zhu Yib481de92007-09-25 17:54:57 -07002493 u8 last_channel;
2494 __le32 tsf_low;
2495 __le32 tsf_high;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002496} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002497
2498
2499/******************************************************************************
2500 * (9)
2501 * IBSS/AP Commands and Notifications:
2502 *
2503 *****************************************************************************/
2504
Johannes Berga85d7cc2010-07-31 08:34:10 -07002505enum iwl_ibss_manager {
2506 IWL_NOT_IBSS_MANAGER = 0,
2507 IWL_IBSS_MANAGER = 1,
2508};
2509
Zhu Yib481de92007-09-25 17:54:57 -07002510/*
2511 * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
2512 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08002513
Johannes Berg241887a2011-01-19 11:11:22 -08002514struct iwlagn_beacon_notif {
2515 struct iwlagn_tx_resp beacon_notify_hdr;
2516 __le32 low_tsf;
2517 __le32 high_tsf;
2518 __le32 ibss_mgr_status;
2519} __packed;
2520
Zhu Yib481de92007-09-25 17:54:57 -07002521/*
2522 * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
2523 */
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08002524
Tomas Winkler4bf64ef2008-07-18 13:53:03 +08002525struct iwl_tx_beacon_cmd {
Tomas Winkler83d527d2008-05-15 13:54:05 +08002526 struct iwl_tx_cmd tx;
Zhu Yib481de92007-09-25 17:54:57 -07002527 __le16 tim_idx;
2528 u8 tim_size;
2529 u8 reserved1;
2530 struct ieee80211_hdr frame[0]; /* beacon frame */
Eric Dumazetba2d3582010-06-02 18:10:09 +00002531} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002532
2533/******************************************************************************
2534 * (10)
2535 * Statistics Commands and Notifications:
2536 *
2537 *****************************************************************************/
2538
2539#define IWL_TEMP_CONVERT 260
2540
2541#define SUP_RATE_11A_MAX_NUM_CHANNELS 8
2542#define SUP_RATE_11B_MAX_NUM_CHANNELS 4
2543#define SUP_RATE_11G_MAX_NUM_CHANNELS 12
2544
2545/* Used for passing to driver number of successes and failures per rate */
2546struct rate_histogram {
2547 union {
2548 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2549 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2550 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2551 } success;
2552 union {
2553 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2554 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2555 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2556 } failed;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002557} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002558
2559/* statistics command response */
2560
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08002561struct statistics_dbg {
2562 __le32 burst_check;
2563 __le32 burst_count;
Wey-Yi Guy7c094c52010-07-06 10:39:32 -07002564 __le32 wait_for_silence_timeout_cnt;
2565 __le32 reserved[3];
Eric Dumazetba2d3582010-06-02 18:10:09 +00002566} __packed;
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08002567
Zhu Yib481de92007-09-25 17:54:57 -07002568struct statistics_rx_phy {
2569 __le32 ina_cnt;
2570 __le32 fina_cnt;
2571 __le32 plcp_err;
2572 __le32 crc32_err;
2573 __le32 overrun_err;
2574 __le32 early_overrun_err;
2575 __le32 crc32_good;
2576 __le32 false_alarm_cnt;
2577 __le32 fina_sync_err_cnt;
2578 __le32 sfd_timeout;
2579 __le32 fina_timeout;
2580 __le32 unresponded_rts;
2581 __le32 rxe_frame_limit_overrun;
2582 __le32 sent_ack_cnt;
2583 __le32 sent_cts_cnt;
Zhu Yib481de92007-09-25 17:54:57 -07002584 __le32 sent_ba_rsp_cnt;
2585 __le32 dsp_self_kill;
2586 __le32 mh_format_err;
2587 __le32 re_acq_main_rssi_sum;
2588 __le32 reserved3;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002589} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002590
Zhu Yib481de92007-09-25 17:54:57 -07002591struct statistics_rx_ht_phy {
2592 __le32 plcp_err;
2593 __le32 overrun_err;
2594 __le32 early_overrun_err;
2595 __le32 crc32_good;
2596 __le32 crc32_err;
2597 __le32 mh_format_err;
2598 __le32 agg_crc32_good;
2599 __le32 agg_mpdu_cnt;
2600 __le32 agg_cnt;
Wey-Yi Guyf0118a42010-01-08 10:04:42 -08002601 __le32 unsupport_mcs;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002602} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002603
Harvey Harrisonc1b4aa32009-01-29 13:26:44 -08002604#define INTERFERENCE_DATA_AVAILABLE cpu_to_le32(1)
Winkler, Tomas34c22cf2008-12-17 16:52:27 +08002605
Zhu Yib481de92007-09-25 17:54:57 -07002606struct statistics_rx_non_phy {
2607 __le32 bogus_cts; /* CTS received when not expecting CTS */
2608 __le32 bogus_ack; /* ACK received when not expecting ACK */
2609 __le32 non_bssid_frames; /* number of frames with BSSID that
2610 * doesn't belong to the STA BSSID */
2611 __le32 filtered_frames; /* count frames that were dumped in the
2612 * filtering process */
2613 __le32 non_channel_beacons; /* beacons with our bss id but not on
2614 * our serving channel */
Zhu Yib481de92007-09-25 17:54:57 -07002615 __le32 channel_beacons; /* beacons with our bss id and in our
2616 * serving channel */
2617 __le32 num_missed_bcon; /* number of missed beacons */
2618 __le32 adc_rx_saturation_time; /* count in 0.8us units the time the
2619 * ADC was in saturation */
2620 __le32 ina_detection_search_time;/* total time (in 0.8us) searched
2621 * for INA */
2622 __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */
2623 __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */
2624 __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */
2625 __le32 interference_data_flag; /* flag for interference data
2626 * availability. 1 when data is
2627 * available. */
Ben Cahill3058f022008-01-14 17:46:17 -08002628 __le32 channel_load; /* counts RX Enable time in uSec */
Zhu Yib481de92007-09-25 17:54:57 -07002629 __le32 dsp_false_alarms; /* DSP false alarm (both OFDM
2630 * and CCK) counter */
2631 __le32 beacon_rssi_a;
2632 __le32 beacon_rssi_b;
2633 __le32 beacon_rssi_c;
2634 __le32 beacon_energy_a;
2635 __le32 beacon_energy_b;
2636 __le32 beacon_energy_c;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002637} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002638
Wey-Yi Guy325322e2010-07-14 08:07:27 -07002639struct statistics_rx_non_phy_bt {
2640 struct statistics_rx_non_phy common;
2641 /* additional stats for bt */
2642 __le32 num_bt_kills;
2643 __le32 reserved[2];
John W. Linvilleda22f792010-07-26 15:04:12 -04002644} __packed;
Wey-Yi Guy325322e2010-07-14 08:07:27 -07002645
Zhu Yib481de92007-09-25 17:54:57 -07002646struct statistics_rx {
2647 struct statistics_rx_phy ofdm;
2648 struct statistics_rx_phy cck;
2649 struct statistics_rx_non_phy general;
Zhu Yib481de92007-09-25 17:54:57 -07002650 struct statistics_rx_ht_phy ofdm_ht;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002651} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002652
Wey-Yi Guy325322e2010-07-14 08:07:27 -07002653struct statistics_rx_bt {
2654 struct statistics_rx_phy ofdm;
2655 struct statistics_rx_phy cck;
2656 struct statistics_rx_non_phy_bt general;
2657 struct statistics_rx_ht_phy ofdm_ht;
John W. Linvilleda22f792010-07-26 15:04:12 -04002658} __packed;
Wey-Yi Guy325322e2010-07-14 08:07:27 -07002659
Wey-Yi Guyfcbaf8b2009-08-21 13:34:18 -07002660/**
2661 * struct statistics_tx_power - current tx power
2662 *
2663 * @ant_a: current tx power on chain a in 1/2 dB step
2664 * @ant_b: current tx power on chain b in 1/2 dB step
2665 * @ant_c: current tx power on chain c in 1/2 dB step
2666 */
2667struct statistics_tx_power {
2668 u8 ant_a;
2669 u8 ant_b;
2670 u8 ant_c;
2671 u8 reserved;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002672} __packed;
Wey-Yi Guyfcbaf8b2009-08-21 13:34:18 -07002673
Zhu Yib481de92007-09-25 17:54:57 -07002674struct statistics_tx_non_phy_agg {
2675 __le32 ba_timeout;
2676 __le32 ba_reschedule_frames;
2677 __le32 scd_query_agg_frame_cnt;
2678 __le32 scd_query_no_agg;
2679 __le32 scd_query_agg;
2680 __le32 scd_query_mismatch;
2681 __le32 frame_not_ready;
2682 __le32 underrun;
2683 __le32 bt_prio_kill;
2684 __le32 rx_ba_rsp_cnt;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002685} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002686
2687struct statistics_tx {
2688 __le32 preamble_cnt;
2689 __le32 rx_detected_cnt;
2690 __le32 bt_prio_defer_cnt;
2691 __le32 bt_prio_kill_cnt;
2692 __le32 few_bytes_cnt;
2693 __le32 cts_timeout;
2694 __le32 ack_timeout;
2695 __le32 expected_ack_cnt;
2696 __le32 actual_ack_cnt;
Zhu Yib481de92007-09-25 17:54:57 -07002697 __le32 dump_msdu_cnt;
2698 __le32 burst_abort_next_frame_mismatch_cnt;
2699 __le32 burst_abort_missing_next_frame_cnt;
2700 __le32 cts_timeout_collision;
2701 __le32 ack_or_ba_timeout_collision;
2702 struct statistics_tx_non_phy_agg agg;
Wey-Yi Guy470356b2010-04-30 11:35:15 -07002703 /*
2704 * "tx_power" are optional parameters provided by uCode,
2705 * 6000 series is the only device provide the information,
2706 * Those are reserved fields for all the other devices
2707 */
Wey-Yi Guyfcbaf8b2009-08-21 13:34:18 -07002708 struct statistics_tx_power tx_power;
2709 __le32 reserved1;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002710} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002711
Zhu Yib481de92007-09-25 17:54:57 -07002712
2713struct statistics_div {
2714 __le32 tx_on_a;
2715 __le32 tx_on_b;
2716 __le32 exec_time;
2717 __le32 probe_time;
Zhu Yib481de92007-09-25 17:54:57 -07002718 __le32 reserved1;
2719 __le32 reserved2;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002720} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002721
Wey-Yi Guy325322e2010-07-14 08:07:27 -07002722struct statistics_general_common {
Wey-Yi Guyf0118a42010-01-08 10:04:42 -08002723 __le32 temperature; /* radio temperature */
2724 __le32 temperature_m; /* for 5000 and up, this is radio voltage */
Zhu Yib481de92007-09-25 17:54:57 -07002725 struct statistics_dbg dbg;
2726 __le32 sleep_time;
2727 __le32 slots_out;
2728 __le32 slots_idle;
2729 __le32 ttl_timestamp;
2730 struct statistics_div div;
Zhu Yib481de92007-09-25 17:54:57 -07002731 __le32 rx_enable_counter;
Wey-Yi Guy11fc5242010-01-15 13:43:35 -08002732 /*
2733 * num_of_sos_states:
2734 * count the number of times we have to re-tune
2735 * in order to get out of bad PHY status
2736 */
2737 __le32 num_of_sos_states;
John W. Linvilleda22f792010-07-26 15:04:12 -04002738} __packed;
Wey-Yi Guy325322e2010-07-14 08:07:27 -07002739
2740struct statistics_bt_activity {
2741 /* Tx statistics */
2742 __le32 hi_priority_tx_req_cnt;
2743 __le32 hi_priority_tx_denied_cnt;
2744 __le32 lo_priority_tx_req_cnt;
2745 __le32 lo_priority_tx_denied_cnt;
2746 /* Rx statistics */
2747 __le32 hi_priority_rx_req_cnt;
2748 __le32 hi_priority_rx_denied_cnt;
2749 __le32 lo_priority_rx_req_cnt;
2750 __le32 lo_priority_rx_denied_cnt;
John W. Linvilleda22f792010-07-26 15:04:12 -04002751} __packed;
Wey-Yi Guy325322e2010-07-14 08:07:27 -07002752
2753struct statistics_general {
2754 struct statistics_general_common common;
2755 __le32 reserved2;
2756 __le32 reserved3;
John W. Linvilleda22f792010-07-26 15:04:12 -04002757} __packed;
Wey-Yi Guy325322e2010-07-14 08:07:27 -07002758
2759struct statistics_general_bt {
2760 struct statistics_general_common common;
2761 struct statistics_bt_activity activity;
Zhu Yib481de92007-09-25 17:54:57 -07002762 __le32 reserved2;
2763 __le32 reserved3;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002764} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002765
Wey-Yi Guyef8d5522009-11-13 11:56:28 -08002766#define UCODE_STATISTICS_CLEAR_MSK (0x1 << 0)
2767#define UCODE_STATISTICS_FREQUENCY_MSK (0x1 << 1)
2768#define UCODE_STATISTICS_NARROW_BAND_MSK (0x1 << 2)
2769
Zhu Yib481de92007-09-25 17:54:57 -07002770/*
2771 * REPLY_STATISTICS_CMD = 0x9c,
Wey-Yi Guy767d0552010-08-23 07:56:53 -07002772 * all devices identical.
Zhu Yib481de92007-09-25 17:54:57 -07002773 *
2774 * This command triggers an immediate response containing uCode statistics.
2775 * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
2776 *
2777 * If the CLEAR_STATS configuration flag is set, uCode will clear its
2778 * internal copy of the statistics (counters) after issuing the response.
2779 * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
2780 *
2781 * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
2782 * STATISTICS_NOTIFICATIONs after received beacons (see below). This flag
2783 * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
2784 */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08002785#define IWL_STATS_CONF_CLEAR_STATS cpu_to_le32(0x1) /* see above */
2786#define IWL_STATS_CONF_DISABLE_NOTIF cpu_to_le32(0x2)/* see above */
Emmanuel Grumbach8f91aec2008-06-30 17:23:07 +08002787struct iwl_statistics_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07002788 __le32 configuration_flags; /* IWL_STATS_CONF_* */
Eric Dumazetba2d3582010-06-02 18:10:09 +00002789} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002790
2791/*
2792 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
2793 *
2794 * By default, uCode issues this notification after receiving a beacon
2795 * while associated. To disable this behavior, set DISABLE_NOTIF flag in the
2796 * REPLY_STATISTICS_CMD 0x9c, above.
2797 *
2798 * Statistics counters continue to increment beacon after beacon, but are
2799 * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
2800 * 0x9c with CLEAR_STATS bit set (see above).
2801 *
2802 * uCode also issues this notification during scans. uCode clears statistics
2803 * appropriately so that each notification contains statistics for only the
2804 * one channel that has just been scanned.
2805 */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08002806#define STATISTICS_REPLY_FLG_BAND_24G_MSK cpu_to_le32(0x2)
Wey-Yi Guy7aafef12009-08-07 15:41:38 -07002807#define STATISTICS_REPLY_FLG_HT40_MODE_MSK cpu_to_le32(0x8)
Tomas Winkler3d24a9f2008-12-19 10:37:07 +08002808
Emmanuel Grumbach8f91aec2008-06-30 17:23:07 +08002809struct iwl_notif_statistics {
Zhu Yib481de92007-09-25 17:54:57 -07002810 __le32 flag;
2811 struct statistics_rx rx;
2812 struct statistics_tx tx;
2813 struct statistics_general general;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002814} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002815
Wey-Yi Guy325322e2010-07-14 08:07:27 -07002816struct iwl_bt_notif_statistics {
2817 __le32 flag;
2818 struct statistics_rx_bt rx;
2819 struct statistics_tx tx;
2820 struct statistics_general_bt general;
John W. Linvilleda22f792010-07-26 15:04:12 -04002821} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002822
2823/*
2824 * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
Wey-Yi Guya13d2762010-01-22 14:22:42 -08002825 *
2826 * uCode send MISSED_BEACONS_NOTIFICATION to driver when detect beacon missed
2827 * in regardless of how many missed beacons, which mean when driver receive the
2828 * notification, inside the command, it can find all the beacons information
2829 * which include number of total missed beacons, number of consecutive missed
2830 * beacons, number of beacons received and number of beacons expected to
2831 * receive.
2832 *
2833 * If uCode detected consecutive_missed_beacons > 5, it will reset the radio
2834 * in order to bring the radio/PHY back to working state; which has no relation
2835 * to when driver will perform sensitivity calibration.
2836 *
2837 * Driver should set it own missed_beacon_threshold to decide when to perform
2838 * sensitivity calibration based on number of consecutive missed beacons in
2839 * order to improve overall performance, especially in noisy environment.
2840 *
Zhu Yib481de92007-09-25 17:54:57 -07002841 */
Wey-Yi Guya13d2762010-01-22 14:22:42 -08002842
2843#define IWL_MISSED_BEACON_THRESHOLD_MIN (1)
2844#define IWL_MISSED_BEACON_THRESHOLD_DEF (5)
2845#define IWL_MISSED_BEACON_THRESHOLD_MAX IWL_MISSED_BEACON_THRESHOLD_DEF
Zhu Yib481de92007-09-25 17:54:57 -07002846
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08002847struct iwl_missed_beacon_notif {
Wey-Yi Guya13d2762010-01-22 14:22:42 -08002848 __le32 consecutive_missed_beacons;
Zhu Yib481de92007-09-25 17:54:57 -07002849 __le32 total_missed_becons;
2850 __le32 num_expected_beacons;
2851 __le32 num_recvd_beacons;
Eric Dumazetba2d3582010-06-02 18:10:09 +00002852} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07002853
Ben Cahillf7d09d72007-11-29 11:09:51 +08002854
Zhu Yib481de92007-09-25 17:54:57 -07002855/******************************************************************************
2856 * (11)
2857 * Rx Calibration Commands:
2858 *
Ben Cahillf7d09d72007-11-29 11:09:51 +08002859 * With the uCode used for open source drivers, most Tx calibration (except
2860 * for Tx Power) and most Rx calibration is done by uCode during the
2861 * "initialize" phase of uCode boot. Driver must calibrate only:
2862 *
2863 * 1) Tx power (depends on temperature), described elsewhere
2864 * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas)
2865 * 3) Receiver sensitivity (to optimize signal detection)
2866 *
Zhu Yib481de92007-09-25 17:54:57 -07002867 *****************************************************************************/
2868
Ben Cahillf7d09d72007-11-29 11:09:51 +08002869/**
2870 * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
2871 *
2872 * This command sets up the Rx signal detector for a sensitivity level that
2873 * is high enough to lock onto all signals within the associated network,
2874 * but low enough to ignore signals that are below a certain threshold, so as
2875 * not to have too many "false alarms". False alarms are signals that the
2876 * Rx DSP tries to lock onto, but then discards after determining that they
2877 * are noise.
2878 *
2879 * The optimum number of false alarms is between 5 and 50 per 200 TUs
2880 * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
2881 * time listening, not transmitting). Driver must adjust sensitivity so that
2882 * the ratio of actual false alarms to actual Rx time falls within this range.
2883 *
2884 * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
2885 * received beacon. These provide information to the driver to analyze the
2886 * sensitivity. Don't analyze statistics that come in from scanning, or any
2887 * other non-associated-network source. Pertinent statistics include:
2888 *
2889 * From "general" statistics (struct statistics_rx_non_phy):
2890 *
2891 * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
2892 * Measure of energy of desired signal. Used for establishing a level
2893 * below which the device does not detect signals.
2894 *
2895 * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
2896 * Measure of background noise in silent period after beacon.
2897 *
2898 * channel_load
2899 * uSecs of actual Rx time during beacon period (varies according to
2900 * how much time was spent transmitting).
2901 *
2902 * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
2903 *
2904 * false_alarm_cnt
2905 * Signal locks abandoned early (before phy-level header).
2906 *
2907 * plcp_err
2908 * Signal locks abandoned late (during phy-level header).
2909 *
2910 * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from
2911 * beacon to beacon, i.e. each value is an accumulation of all errors
2912 * before and including the latest beacon. Values will wrap around to 0
2913 * after counting up to 2^32 - 1. Driver must differentiate vs.
2914 * previous beacon's values to determine # false alarms in the current
2915 * beacon period.
2916 *
2917 * Total number of false alarms = false_alarms + plcp_errs
2918 *
2919 * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
2920 * (notice that the start points for OFDM are at or close to settings for
2921 * maximum sensitivity):
2922 *
2923 * START / MIN / MAX
2924 * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120
2925 * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210
2926 * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140
2927 * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270
2928 *
2929 * If actual rate of OFDM false alarms (+ plcp_errors) is too high
2930 * (greater than 50 for each 204.8 msecs listening), reduce sensitivity
2931 * by *adding* 1 to all 4 of the table entries above, up to the max for
2932 * each entry. Conversely, if false alarm rate is too low (less than 5
2933 * for each 204.8 msecs listening), *subtract* 1 from each entry to
2934 * increase sensitivity.
2935 *
2936 * For CCK sensitivity, keep track of the following:
2937 *
2938 * 1). 20-beacon history of maximum background noise, indicated by
2939 * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
2940 * 3 receivers. For any given beacon, the "silence reference" is
2941 * the maximum of last 60 samples (20 beacons * 3 receivers).
2942 *
2943 * 2). 10-beacon history of strongest signal level, as indicated
2944 * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
2945 * i.e. the strength of the signal through the best receiver at the
2946 * moment. These measurements are "upside down", with lower values
2947 * for stronger signals, so max energy will be *minimum* value.
2948 *
2949 * Then for any given beacon, the driver must determine the *weakest*
2950 * of the strongest signals; this is the minimum level that needs to be
2951 * successfully detected, when using the best receiver at the moment.
2952 * "Max cck energy" is the maximum (higher value means lower energy!)
2953 * of the last 10 minima. Once this is determined, driver must add
2954 * a little margin by adding "6" to it.
2955 *
2956 * 3). Number of consecutive beacon periods with too few false alarms.
2957 * Reset this to 0 at the first beacon period that falls within the
2958 * "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
2959 *
2960 * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
2961 * (notice that the start points for CCK are at maximum sensitivity):
2962 *
2963 * START / MIN / MAX
2964 * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200
2965 * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400
2966 * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100
2967 *
2968 * If actual rate of CCK false alarms (+ plcp_errors) is too high
2969 * (greater than 50 for each 204.8 msecs listening), method for reducing
2970 * sensitivity is:
2971 *
2972 * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2973 * up to max 400.
2974 *
2975 * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
2976 * sensitivity has been reduced a significant amount; bring it up to
2977 * a moderate 161. Otherwise, *add* 3, up to max 200.
2978 *
2979 * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
2980 * sensitivity has been reduced only a moderate or small amount;
2981 * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
2982 * down to min 0. Otherwise (if gain has been significantly reduced),
2983 * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
2984 *
2985 * b) Save a snapshot of the "silence reference".
2986 *
2987 * If actual rate of CCK false alarms (+ plcp_errors) is too low
2988 * (less than 5 for each 204.8 msecs listening), method for increasing
2989 * sensitivity is used only if:
2990 *
2991 * 1a) Previous beacon did not have too many false alarms
2992 * 1b) AND difference between previous "silence reference" and current
2993 * "silence reference" (prev - current) is 2 or more,
2994 * OR 2) 100 or more consecutive beacon periods have had rate of
2995 * less than 5 false alarms per 204.8 milliseconds rx time.
2996 *
2997 * Method for increasing sensitivity:
2998 *
2999 * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
3000 * down to min 125.
3001 *
3002 * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
3003 * down to min 200.
3004 *
3005 * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
3006 *
3007 * If actual rate of CCK false alarms (+ plcp_errors) is within good range
3008 * (between 5 and 50 for each 204.8 msecs listening):
3009 *
3010 * 1) Save a snapshot of the silence reference.
3011 *
3012 * 2) If previous beacon had too many CCK false alarms (+ plcp_errors),
3013 * give some extra margin to energy threshold by *subtracting* 8
3014 * from value in HD_MIN_ENERGY_CCK_DET_INDEX.
3015 *
3016 * For all cases (too few, too many, good range), make sure that the CCK
3017 * detection threshold (energy) is below the energy level for robust
3018 * detection over the past 10 beacon periods, the "Max cck energy".
3019 * Lower values mean higher energy; this means making sure that the value
3020 * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
3021 *
Ben Cahillf7d09d72007-11-29 11:09:51 +08003022 */
Zhu Yib481de92007-09-25 17:54:57 -07003023
Ben Cahillf7d09d72007-11-29 11:09:51 +08003024/*
Emmanuel Grumbachf0832f12008-04-16 16:34:47 -07003025 * Table entries in SENSITIVITY_CMD (struct iwl_sensitivity_cmd)
Ben Cahillf7d09d72007-11-29 11:09:51 +08003026 */
3027#define HD_TABLE_SIZE (11) /* number of entries */
3028#define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */
3029#define HD_MIN_ENERGY_OFDM_DET_INDEX (1)
3030#define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2)
3031#define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3)
3032#define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4)
3033#define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5)
3034#define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6)
3035#define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7)
3036#define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8)
3037#define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9)
3038#define HD_OFDM_ENERGY_TH_IN_INDEX (10)
3039
Wey-Yi Guyc8312fa2010-06-28 13:05:17 -07003040/*
3041 * Additional table entries in enhance SENSITIVITY_CMD
3042 */
3043#define HD_INA_NON_SQUARE_DET_OFDM_INDEX (11)
3044#define HD_INA_NON_SQUARE_DET_CCK_INDEX (12)
3045#define HD_CORR_11_INSTEAD_OF_CORR_9_EN_INDEX (13)
3046#define HD_OFDM_NON_SQUARE_DET_SLOPE_MRC_INDEX (14)
3047#define HD_OFDM_NON_SQUARE_DET_INTERCEPT_MRC_INDEX (15)
3048#define HD_OFDM_NON_SQUARE_DET_SLOPE_INDEX (16)
3049#define HD_OFDM_NON_SQUARE_DET_INTERCEPT_INDEX (17)
3050#define HD_CCK_NON_SQUARE_DET_SLOPE_MRC_INDEX (18)
3051#define HD_CCK_NON_SQUARE_DET_INTERCEPT_MRC_INDEX (19)
3052#define HD_CCK_NON_SQUARE_DET_SLOPE_INDEX (20)
3053#define HD_CCK_NON_SQUARE_DET_INTERCEPT_INDEX (21)
3054#define HD_RESERVED (22)
3055
3056/* number of entries for enhanced tbl */
3057#define ENHANCE_HD_TABLE_SIZE (23)
3058
3059/* number of additional entries for enhanced tbl */
3060#define ENHANCE_HD_TABLE_ENTRIES (ENHANCE_HD_TABLE_SIZE - HD_TABLE_SIZE)
3061
3062#define HD_INA_NON_SQUARE_DET_OFDM_DATA cpu_to_le16(0)
3063#define HD_INA_NON_SQUARE_DET_CCK_DATA cpu_to_le16(0)
3064#define HD_CORR_11_INSTEAD_OF_CORR_9_EN_DATA cpu_to_le16(0)
3065#define HD_OFDM_NON_SQUARE_DET_SLOPE_MRC_DATA cpu_to_le16(668)
3066#define HD_OFDM_NON_SQUARE_DET_INTERCEPT_MRC_DATA cpu_to_le16(4)
3067#define HD_OFDM_NON_SQUARE_DET_SLOPE_DATA cpu_to_le16(486)
3068#define HD_OFDM_NON_SQUARE_DET_INTERCEPT_DATA cpu_to_le16(37)
3069#define HD_CCK_NON_SQUARE_DET_SLOPE_MRC_DATA cpu_to_le16(853)
3070#define HD_CCK_NON_SQUARE_DET_INTERCEPT_MRC_DATA cpu_to_le16(4)
3071#define HD_CCK_NON_SQUARE_DET_SLOPE_DATA cpu_to_le16(476)
3072#define HD_CCK_NON_SQUARE_DET_INTERCEPT_DATA cpu_to_le16(99)
3073
3074
Emmanuel Grumbachf0832f12008-04-16 16:34:47 -07003075/* Control field in struct iwl_sensitivity_cmd */
Harvey Harrison51e9bf52008-11-26 13:12:52 -08003076#define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE cpu_to_le16(0)
3077#define SENSITIVITY_CMD_CONTROL_WORK_TABLE cpu_to_le16(1)
Ben Cahillf7d09d72007-11-29 11:09:51 +08003078
3079/**
Emmanuel Grumbachf0832f12008-04-16 16:34:47 -07003080 * struct iwl_sensitivity_cmd
Ben Cahillf7d09d72007-11-29 11:09:51 +08003081 * @control: (1) updates working table, (0) updates default table
3082 * @table: energy threshold values, use HD_* as index into table
3083 *
3084 * Always use "1" in "control" to update uCode's working table and DSP.
3085 */
Emmanuel Grumbachf0832f12008-04-16 16:34:47 -07003086struct iwl_sensitivity_cmd {
Ben Cahillf7d09d72007-11-29 11:09:51 +08003087 __le16 control; /* always use "1" */
3088 __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */
Eric Dumazetba2d3582010-06-02 18:10:09 +00003089} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07003090
Wey-Yi Guyc8312fa2010-06-28 13:05:17 -07003091/*
3092 *
3093 */
3094struct iwl_enhance_sensitivity_cmd {
3095 __le16 control; /* always use "1" */
3096 __le16 enhance_table[ENHANCE_HD_TABLE_SIZE]; /* use HD_* as index */
John W. Linville0e954092010-07-14 10:37:32 -04003097} __packed;
Wey-Yi Guyc8312fa2010-06-28 13:05:17 -07003098
Ben Cahillf7d09d72007-11-29 11:09:51 +08003099
3100/**
3101 * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
3102 *
Wey-Yi Guy767d0552010-08-23 07:56:53 -07003103 * This command sets the relative gains of agn device's 3 radio receiver chains.
Ben Cahillf7d09d72007-11-29 11:09:51 +08003104 *
3105 * After the first association, driver should accumulate signal and noise
3106 * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
3107 * beacons from the associated network (don't collect statistics that come
3108 * in from scanning, or any other non-network source).
3109 *
3110 * DISCONNECTED ANTENNA:
3111 *
3112 * Driver should determine which antennas are actually connected, by comparing
3113 * average beacon signal levels for the 3 Rx chains. Accumulate (add) the
3114 * following values over 20 beacons, one accumulator for each of the chains
3115 * a/b/c, from struct statistics_rx_non_phy:
3116 *
3117 * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
3118 *
3119 * Find the strongest signal from among a/b/c. Compare the other two to the
3120 * strongest. If any signal is more than 15 dB (times 20, unless you
3121 * divide the accumulated values by 20) below the strongest, the driver
3122 * considers that antenna to be disconnected, and should not try to use that
3123 * antenna/chain for Rx or Tx. If both A and B seem to be disconnected,
3124 * driver should declare the stronger one as connected, and attempt to use it
3125 * (A and B are the only 2 Tx chains!).
3126 *
3127 *
3128 * RX BALANCE:
3129 *
3130 * Driver should balance the 3 receivers (but just the ones that are connected
3131 * to antennas, see above) for gain, by comparing the average signal levels
3132 * detected during the silence after each beacon (background noise).
3133 * Accumulate (add) the following values over 20 beacons, one accumulator for
3134 * each of the chains a/b/c, from struct statistics_rx_non_phy:
3135 *
3136 * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
3137 *
3138 * Find the weakest background noise level from among a/b/c. This Rx chain
3139 * will be the reference, with 0 gain adjustment. Attenuate other channels by
3140 * finding noise difference:
3141 *
3142 * (accum_noise[i] - accum_noise[reference]) / 30
3143 *
3144 * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
3145 * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
3146 * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
3147 * and set bit 2 to indicate "reduce gain". The value for the reference
3148 * (weakest) chain should be "0".
3149 *
3150 * diff_gain_[abc] bit fields:
3151 * 2: (1) reduce gain, (0) increase gain
3152 * 1-0: amount of gain, units of 1.5 dB
3153 */
3154
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003155/* Phy calibration command for series */
Shanyu Zhao642454c2010-09-21 12:06:18 -07003156/* The default calibrate table size if not specified by firmware */
3157#define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
Emmanuel Grumbach33fd5032008-04-24 11:55:30 -07003158enum {
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003159 IWL_PHY_CALIBRATE_DIFF_GAIN_CMD = 7,
3160 IWL_PHY_CALIBRATE_DC_CMD = 8,
3161 IWL_PHY_CALIBRATE_LO_CMD = 9,
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003162 IWL_PHY_CALIBRATE_TX_IQ_CMD = 11,
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003163 IWL_PHY_CALIBRATE_CRYSTAL_FRQ_CMD = 15,
3164 IWL_PHY_CALIBRATE_BASE_BAND_CMD = 16,
3165 IWL_PHY_CALIBRATE_TX_IQ_PERD_CMD = 17,
Shanyu Zhaobf53f932010-09-21 16:54:01 -07003166 IWL_PHY_CALIBRATE_TEMP_OFFSET_CMD = 18,
3167 IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE = 19,
Emmanuel Grumbach33fd5032008-04-24 11:55:30 -07003168};
3169
Wey-Yi Guy6a822d02010-07-13 17:13:15 -07003170#define IWL_MAX_PHY_CALIBRATE_TBL_SIZE (253)
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003171
Harvey Harrison51e9bf52008-11-26 13:12:52 -08003172#define IWL_CALIB_INIT_CFG_ALL cpu_to_le32(0xffffffff)
Tomas Winkler7c616cb2008-05-29 16:35:05 +08003173
Shanyu Zhao6d6a1af2010-09-14 18:13:31 -07003174/* This enum defines the bitmap of various calibrations to enable in both
3175 * init ucode and runtime ucode through CALIBRATION_CFG_CMD.
3176 */
3177enum iwl_ucode_calib_cfg {
3178 IWL_CALIB_CFG_RX_BB_IDX,
3179 IWL_CALIB_CFG_DC_IDX,
3180 IWL_CALIB_CFG_TX_IQ_IDX,
3181 IWL_CALIB_CFG_RX_IQ_IDX,
3182 IWL_CALIB_CFG_NOISE_IDX,
3183 IWL_CALIB_CFG_CRYSTAL_IDX,
3184 IWL_CALIB_CFG_TEMPERATURE_IDX,
3185 IWL_CALIB_CFG_PAPD_IDX,
3186};
3187
3188
Tomas Winkler7c616cb2008-05-29 16:35:05 +08003189struct iwl_calib_cfg_elmnt_s {
3190 __le32 is_enable;
3191 __le32 start;
3192 __le32 send_res;
3193 __le32 apply_res;
3194 __le32 reserved;
Eric Dumazetba2d3582010-06-02 18:10:09 +00003195} __packed;
Tomas Winkler7c616cb2008-05-29 16:35:05 +08003196
3197struct iwl_calib_cfg_status_s {
3198 struct iwl_calib_cfg_elmnt_s once;
3199 struct iwl_calib_cfg_elmnt_s perd;
3200 __le32 flags;
Eric Dumazetba2d3582010-06-02 18:10:09 +00003201} __packed;
Tomas Winkler7c616cb2008-05-29 16:35:05 +08003202
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003203struct iwl_calib_cfg_cmd {
Tomas Winkler7c616cb2008-05-29 16:35:05 +08003204 struct iwl_calib_cfg_status_s ucd_calib_cfg;
3205 struct iwl_calib_cfg_status_s drv_calib_cfg;
3206 __le32 reserved1;
Eric Dumazetba2d3582010-06-02 18:10:09 +00003207} __packed;
Tomas Winkler7c616cb2008-05-29 16:35:05 +08003208
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003209struct iwl_calib_hdr {
Tomas Winkler7c616cb2008-05-29 16:35:05 +08003210 u8 op_code;
3211 u8 first_group;
3212 u8 groups_num;
3213 u8 data_valid;
Eric Dumazetba2d3582010-06-02 18:10:09 +00003214} __packed;
Tomas Winkler7c616cb2008-05-29 16:35:05 +08003215
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003216struct iwl_calib_cmd {
3217 struct iwl_calib_hdr hdr;
Tomas Winklerbe5d56e2008-10-08 09:37:27 +08003218 u8 data[0];
Eric Dumazetba2d3582010-06-02 18:10:09 +00003219} __packed;
Tomas Winklerbe5d56e2008-10-08 09:37:27 +08003220
Tomas Winkler0d950d82008-11-25 13:36:01 -08003221/* IWL_PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003222struct iwl_calib_diff_gain_cmd {
Tomas Winkler0d950d82008-11-25 13:36:01 -08003223 struct iwl_calib_hdr hdr;
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003224 s8 diff_gain_a; /* see above */
3225 s8 diff_gain_b;
3226 s8 diff_gain_c;
3227 u8 reserved1;
Eric Dumazetba2d3582010-06-02 18:10:09 +00003228} __packed;
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003229
Tomas Winkler0d950d82008-11-25 13:36:01 -08003230struct iwl_calib_xtal_freq_cmd {
3231 struct iwl_calib_hdr hdr;
3232 u8 cap_pin1;
3233 u8 cap_pin2;
3234 u8 pad[2];
Eric Dumazetba2d3582010-06-02 18:10:09 +00003235} __packed;
Emmanuel Grumbach33fd5032008-04-24 11:55:30 -07003236
Shanyu Zhaobf53f932010-09-21 16:54:01 -07003237#define DEFAULT_RADIO_SENSOR_OFFSET 2700
3238struct iwl_calib_temperature_offset_cmd {
3239 struct iwl_calib_hdr hdr;
3240 s16 radio_sensor_offset;
3241 s16 reserved;
3242} __packed;
3243
Tomas Winkler0d950d82008-11-25 13:36:01 -08003244/* IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD */
3245struct iwl_calib_chain_noise_reset_cmd {
3246 struct iwl_calib_hdr hdr;
3247 u8 data[0];
3248};
3249
3250/* IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD */
Tomas Winklerf69f42a2008-10-23 23:48:52 -07003251struct iwl_calib_chain_noise_gain_cmd {
Tomas Winkler0d950d82008-11-25 13:36:01 -08003252 struct iwl_calib_hdr hdr;
Emmanuel Grumbach33fd5032008-04-24 11:55:30 -07003253 u8 delta_gain_1;
3254 u8 delta_gain_2;
Tomas Winkler0d950d82008-11-25 13:36:01 -08003255 u8 pad[2];
Eric Dumazetba2d3582010-06-02 18:10:09 +00003256} __packed;
Emmanuel Grumbach33fd5032008-04-24 11:55:30 -07003257
Zhu Yib481de92007-09-25 17:54:57 -07003258/******************************************************************************
3259 * (12)
3260 * Miscellaneous Commands:
3261 *
3262 *****************************************************************************/
3263
3264/*
3265 * LEDs Command & Response
3266 * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
3267 *
3268 * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
3269 * this command turns it on or off, or sets up a periodic blinking cycle.
3270 */
Tomas Winklerec1a7462008-07-11 11:53:37 +08003271struct iwl_led_cmd {
Zhu Yib481de92007-09-25 17:54:57 -07003272 __le32 interval; /* "interval" in uSec */
3273 u8 id; /* 1: Activity, 2: Link, 3: Tech */
3274 u8 off; /* # intervals off while blinking;
3275 * "0", with >0 "on" value, turns LED on */
3276 u8 on; /* # intervals on while blinking;
3277 * "0", regardless of "off", turns LED off */
3278 u8 reserved;
Eric Dumazetba2d3582010-06-02 18:10:09 +00003279} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07003280
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003281/*
Wey-Yi Guyfe1bcbf2009-10-30 14:36:16 -07003282 * station priority table entries
3283 * also used as potential "events" value for both
3284 * COEX_MEDIUM_NOTIFICATION and COEX_EVENT_CMD
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003285 */
Wey-Yi Guy1933ac42009-10-30 14:36:18 -07003286
3287/*
3288 * COEX events entry flag masks
3289 * RP - Requested Priority
3290 * WP - Win Medium Priority: priority assigned when the contention has been won
3291 */
3292#define COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG (0x1)
3293#define COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG (0x2)
3294#define COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG (0x4)
3295
3296#define COEX_CU_UNASSOC_IDLE_RP 4
3297#define COEX_CU_UNASSOC_MANUAL_SCAN_RP 4
3298#define COEX_CU_UNASSOC_AUTO_SCAN_RP 4
3299#define COEX_CU_CALIBRATION_RP 4
3300#define COEX_CU_PERIODIC_CALIBRATION_RP 4
3301#define COEX_CU_CONNECTION_ESTAB_RP 4
3302#define COEX_CU_ASSOCIATED_IDLE_RP 4
3303#define COEX_CU_ASSOC_MANUAL_SCAN_RP 4
3304#define COEX_CU_ASSOC_AUTO_SCAN_RP 4
3305#define COEX_CU_ASSOC_ACTIVE_LEVEL_RP 4
3306#define COEX_CU_RF_ON_RP 6
3307#define COEX_CU_RF_OFF_RP 4
3308#define COEX_CU_STAND_ALONE_DEBUG_RP 6
3309#define COEX_CU_IPAN_ASSOC_LEVEL_RP 4
3310#define COEX_CU_RSRVD1_RP 4
3311#define COEX_CU_RSRVD2_RP 4
3312
3313#define COEX_CU_UNASSOC_IDLE_WP 3
3314#define COEX_CU_UNASSOC_MANUAL_SCAN_WP 3
3315#define COEX_CU_UNASSOC_AUTO_SCAN_WP 3
3316#define COEX_CU_CALIBRATION_WP 3
3317#define COEX_CU_PERIODIC_CALIBRATION_WP 3
3318#define COEX_CU_CONNECTION_ESTAB_WP 3
3319#define COEX_CU_ASSOCIATED_IDLE_WP 3
3320#define COEX_CU_ASSOC_MANUAL_SCAN_WP 3
3321#define COEX_CU_ASSOC_AUTO_SCAN_WP 3
3322#define COEX_CU_ASSOC_ACTIVE_LEVEL_WP 3
3323#define COEX_CU_RF_ON_WP 3
3324#define COEX_CU_RF_OFF_WP 3
3325#define COEX_CU_STAND_ALONE_DEBUG_WP 6
3326#define COEX_CU_IPAN_ASSOC_LEVEL_WP 3
3327#define COEX_CU_RSRVD1_WP 3
3328#define COEX_CU_RSRVD2_WP 3
3329
3330#define COEX_UNASSOC_IDLE_FLAGS 0
3331#define COEX_UNASSOC_MANUAL_SCAN_FLAGS \
3332 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3333 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3334#define COEX_UNASSOC_AUTO_SCAN_FLAGS \
3335 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3336 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3337#define COEX_CALIBRATION_FLAGS \
3338 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3339 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3340#define COEX_PERIODIC_CALIBRATION_FLAGS 0
3341/*
3342 * COEX_CONNECTION_ESTAB:
3343 * we need DELAY_MEDIUM_FREE_NTFY to let WiMAX disconnect from network.
3344 */
3345#define COEX_CONNECTION_ESTAB_FLAGS \
3346 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3347 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG | \
3348 COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
3349#define COEX_ASSOCIATED_IDLE_FLAGS 0
3350#define COEX_ASSOC_MANUAL_SCAN_FLAGS \
3351 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3352 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3353#define COEX_ASSOC_AUTO_SCAN_FLAGS \
3354 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3355 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3356#define COEX_ASSOC_ACTIVE_LEVEL_FLAGS 0
3357#define COEX_RF_ON_FLAGS 0
3358#define COEX_RF_OFF_FLAGS 0
3359#define COEX_STAND_ALONE_DEBUG_FLAGS \
3360 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3361 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3362#define COEX_IPAN_ASSOC_LEVEL_FLAGS \
3363 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3364 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG | \
3365 COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
3366#define COEX_RSRVD1_FLAGS 0
3367#define COEX_RSRVD2_FLAGS 0
3368/*
3369 * COEX_CU_RF_ON is the event wrapping all radio ownership.
3370 * We need DELAY_MEDIUM_FREE_NTFY to let WiMAX disconnect from network.
3371 */
3372#define COEX_CU_RF_ON_FLAGS \
3373 (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
3374 COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG | \
3375 COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
3376
3377
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003378enum {
Wey-Yi Guyfe1bcbf2009-10-30 14:36:16 -07003379 /* un-association part */
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003380 COEX_UNASSOC_IDLE = 0,
3381 COEX_UNASSOC_MANUAL_SCAN = 1,
3382 COEX_UNASSOC_AUTO_SCAN = 2,
Wey-Yi Guyfe1bcbf2009-10-30 14:36:16 -07003383 /* calibration */
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003384 COEX_CALIBRATION = 3,
3385 COEX_PERIODIC_CALIBRATION = 4,
Wey-Yi Guyfe1bcbf2009-10-30 14:36:16 -07003386 /* connection */
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003387 COEX_CONNECTION_ESTAB = 5,
Wey-Yi Guyfe1bcbf2009-10-30 14:36:16 -07003388 /* association part */
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003389 COEX_ASSOCIATED_IDLE = 6,
3390 COEX_ASSOC_MANUAL_SCAN = 7,
3391 COEX_ASSOC_AUTO_SCAN = 8,
3392 COEX_ASSOC_ACTIVE_LEVEL = 9,
Wey-Yi Guyfe1bcbf2009-10-30 14:36:16 -07003393 /* RF ON/OFF */
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003394 COEX_RF_ON = 10,
3395 COEX_RF_OFF = 11,
3396 COEX_STAND_ALONE_DEBUG = 12,
Wey-Yi Guyfe1bcbf2009-10-30 14:36:16 -07003397 /* IPAN */
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003398 COEX_IPAN_ASSOC_LEVEL = 13,
Wey-Yi Guyfe1bcbf2009-10-30 14:36:16 -07003399 /* reserved */
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003400 COEX_RSRVD1 = 14,
3401 COEX_RSRVD2 = 15,
3402 COEX_NUM_OF_EVENTS = 16
3403};
3404
Wey-Yi Guyfe1bcbf2009-10-30 14:36:16 -07003405/*
3406 * Coexistence WIFI/WIMAX Command
3407 * COEX_PRIORITY_TABLE_CMD = 0x5a
3408 *
3409 */
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003410struct iwl_wimax_coex_event_entry {
3411 u8 request_prio;
3412 u8 win_medium_prio;
3413 u8 reserved;
3414 u8 flags;
Eric Dumazetba2d3582010-06-02 18:10:09 +00003415} __packed;
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003416
3417/* COEX flag masks */
3418
Tomas Winklera96a27f2008-10-23 23:48:56 -07003419/* Station table is valid */
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003420#define COEX_FLAGS_STA_TABLE_VALID_MSK (0x1)
Tomas Winklera96a27f2008-10-23 23:48:56 -07003421/* UnMask wake up src at unassociated sleep */
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003422#define COEX_FLAGS_UNASSOC_WA_UNMASK_MSK (0x4)
Tomas Winklera96a27f2008-10-23 23:48:56 -07003423/* UnMask wake up src at associated sleep */
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003424#define COEX_FLAGS_ASSOC_WA_UNMASK_MSK (0x8)
3425/* Enable CoEx feature. */
3426#define COEX_FLAGS_COEX_ENABLE_MSK (0x80)
3427
3428struct iwl_wimax_coex_cmd {
3429 u8 flags;
3430 u8 reserved[3];
3431 struct iwl_wimax_coex_event_entry sta_prio[COEX_NUM_OF_EVENTS];
Eric Dumazetba2d3582010-06-02 18:10:09 +00003432} __packed;
Ron Rindjunsky9636e582008-05-15 13:54:14 +08003433
Wey-Yi Guyfe1bcbf2009-10-30 14:36:16 -07003434/*
3435 * Coexistence MEDIUM NOTIFICATION
3436 * COEX_MEDIUM_NOTIFICATION = 0x5b
3437 *
3438 * notification from uCode to host to indicate medium changes
3439 *
3440 */
3441/*
3442 * status field
3443 * bit 0 - 2: medium status
3444 * bit 3: medium change indication
3445 * bit 4 - 31: reserved
3446 */
3447/* status option values, (0 - 2 bits) */
3448#define COEX_MEDIUM_BUSY (0x0) /* radio belongs to WiMAX */
3449#define COEX_MEDIUM_ACTIVE (0x1) /* radio belongs to WiFi */
3450#define COEX_MEDIUM_PRE_RELEASE (0x2) /* received radio release */
3451#define COEX_MEDIUM_MSK (0x7)
3452
3453/* send notification status (1 bit) */
3454#define COEX_MEDIUM_CHANGED (0x8)
3455#define COEX_MEDIUM_CHANGED_MSK (0x8)
3456#define COEX_MEDIUM_SHIFT (3)
3457
3458struct iwl_coex_medium_notification {
3459 __le32 status;
3460 __le32 events;
Eric Dumazetba2d3582010-06-02 18:10:09 +00003461} __packed;
Wey-Yi Guyfe1bcbf2009-10-30 14:36:16 -07003462
3463/*
3464 * Coexistence EVENT Command
3465 * COEX_EVENT_CMD = 0x5c
3466 *
3467 * send from host to uCode for coex event request.
3468 */
3469/* flags options */
3470#define COEX_EVENT_REQUEST_MSK (0x1)
3471
3472struct iwl_coex_event_cmd {
3473 u8 flags;
3474 u8 event;
3475 __le16 reserved;
Eric Dumazetba2d3582010-06-02 18:10:09 +00003476} __packed;
Wey-Yi Guyfe1bcbf2009-10-30 14:36:16 -07003477
3478struct iwl_coex_event_resp {
3479 __le32 status;
Eric Dumazetba2d3582010-06-02 18:10:09 +00003480} __packed;
Wey-Yi Guyfe1bcbf2009-10-30 14:36:16 -07003481
3482
Zhu Yib481de92007-09-25 17:54:57 -07003483/******************************************************************************
Johannes Berg0288d232010-08-23 07:56:54 -07003484 * Bluetooth Coexistence commands
3485 *
3486 *****************************************************************************/
3487
3488/*
3489 * BT Status notification
Wey-Yi Guyfbba9412010-08-23 07:57:10 -07003490 * REPLY_BT_COEX_PROFILE_NOTIF = 0xce
Johannes Berg0288d232010-08-23 07:56:54 -07003491 */
3492enum iwl_bt_coex_profile_traffic_load {
3493 IWL_BT_COEX_TRAFFIC_LOAD_NONE = 0,
3494 IWL_BT_COEX_TRAFFIC_LOAD_LOW = 1,
3495 IWL_BT_COEX_TRAFFIC_LOAD_HIGH = 2,
3496 IWL_BT_COEX_TRAFFIC_LOAD_CONTINUOUS = 3,
3497/*
3498 * There are no more even though below is a u8, the
3499 * indication from the BT device only has two bits.
3500 */
3501};
3502
Wey-Yi Guy60132702011-02-18 17:23:54 -08003503#define BT_SESSION_ACTIVITY_1_UART_MSG 0x1
3504#define BT_SESSION_ACTIVITY_2_UART_MSG 0x2
3505
Wey-Yi Guyd7220f02011-02-18 17:23:52 -08003506/* BT UART message - Share Part (BT -> WiFi) */
Wey-Yi Guyfbba9412010-08-23 07:57:10 -07003507#define BT_UART_MSG_FRAME1MSGTYPE_POS (0)
3508#define BT_UART_MSG_FRAME1MSGTYPE_MSK \
3509 (0x7 << BT_UART_MSG_FRAME1MSGTYPE_POS)
3510#define BT_UART_MSG_FRAME1SSN_POS (3)
3511#define BT_UART_MSG_FRAME1SSN_MSK \
3512 (0x3 << BT_UART_MSG_FRAME1SSN_POS)
3513#define BT_UART_MSG_FRAME1UPDATEREQ_POS (5)
3514#define BT_UART_MSG_FRAME1UPDATEREQ_MSK \
3515 (0x1 << BT_UART_MSG_FRAME1UPDATEREQ_POS)
3516#define BT_UART_MSG_FRAME1RESERVED_POS (6)
3517#define BT_UART_MSG_FRAME1RESERVED_MSK \
3518 (0x3 << BT_UART_MSG_FRAME1RESERVED_POS)
3519
3520#define BT_UART_MSG_FRAME2OPENCONNECTIONS_POS (0)
3521#define BT_UART_MSG_FRAME2OPENCONNECTIONS_MSK \
3522 (0x3 << BT_UART_MSG_FRAME2OPENCONNECTIONS_POS)
3523#define BT_UART_MSG_FRAME2TRAFFICLOAD_POS (2)
3524#define BT_UART_MSG_FRAME2TRAFFICLOAD_MSK \
3525 (0x3 << BT_UART_MSG_FRAME2TRAFFICLOAD_POS)
3526#define BT_UART_MSG_FRAME2CHLSEQN_POS (4)
3527#define BT_UART_MSG_FRAME2CHLSEQN_MSK \
3528 (0x1 << BT_UART_MSG_FRAME2CHLSEQN_POS)
3529#define BT_UART_MSG_FRAME2INBAND_POS (5)
3530#define BT_UART_MSG_FRAME2INBAND_MSK \
3531 (0x1 << BT_UART_MSG_FRAME2INBAND_POS)
3532#define BT_UART_MSG_FRAME2RESERVED_POS (6)
3533#define BT_UART_MSG_FRAME2RESERVED_MSK \
3534 (0x3 << BT_UART_MSG_FRAME2RESERVED_POS)
3535
3536#define BT_UART_MSG_FRAME3SCOESCO_POS (0)
3537#define BT_UART_MSG_FRAME3SCOESCO_MSK \
3538 (0x1 << BT_UART_MSG_FRAME3SCOESCO_POS)
3539#define BT_UART_MSG_FRAME3SNIFF_POS (1)
3540#define BT_UART_MSG_FRAME3SNIFF_MSK \
3541 (0x1 << BT_UART_MSG_FRAME3SNIFF_POS)
3542#define BT_UART_MSG_FRAME3A2DP_POS (2)
3543#define BT_UART_MSG_FRAME3A2DP_MSK \
3544 (0x1 << BT_UART_MSG_FRAME3A2DP_POS)
3545#define BT_UART_MSG_FRAME3ACL_POS (3)
3546#define BT_UART_MSG_FRAME3ACL_MSK \
3547 (0x1 << BT_UART_MSG_FRAME3ACL_POS)
3548#define BT_UART_MSG_FRAME3MASTER_POS (4)
3549#define BT_UART_MSG_FRAME3MASTER_MSK \
3550 (0x1 << BT_UART_MSG_FRAME3MASTER_POS)
3551#define BT_UART_MSG_FRAME3OBEX_POS (5)
3552#define BT_UART_MSG_FRAME3OBEX_MSK \
3553 (0x1 << BT_UART_MSG_FRAME3OBEX_POS)
3554#define BT_UART_MSG_FRAME3RESERVED_POS (6)
3555#define BT_UART_MSG_FRAME3RESERVED_MSK \
3556 (0x3 << BT_UART_MSG_FRAME3RESERVED_POS)
3557
3558#define BT_UART_MSG_FRAME4IDLEDURATION_POS (0)
3559#define BT_UART_MSG_FRAME4IDLEDURATION_MSK \
3560 (0x3F << BT_UART_MSG_FRAME4IDLEDURATION_POS)
3561#define BT_UART_MSG_FRAME4RESERVED_POS (6)
3562#define BT_UART_MSG_FRAME4RESERVED_MSK \
3563 (0x3 << BT_UART_MSG_FRAME4RESERVED_POS)
3564
3565#define BT_UART_MSG_FRAME5TXACTIVITY_POS (0)
3566#define BT_UART_MSG_FRAME5TXACTIVITY_MSK \
3567 (0x3 << BT_UART_MSG_FRAME5TXACTIVITY_POS)
3568#define BT_UART_MSG_FRAME5RXACTIVITY_POS (2)
3569#define BT_UART_MSG_FRAME5RXACTIVITY_MSK \
3570 (0x3 << BT_UART_MSG_FRAME5RXACTIVITY_POS)
3571#define BT_UART_MSG_FRAME5ESCORETRANSMIT_POS (4)
3572#define BT_UART_MSG_FRAME5ESCORETRANSMIT_MSK \
3573 (0x3 << BT_UART_MSG_FRAME5ESCORETRANSMIT_POS)
3574#define BT_UART_MSG_FRAME5RESERVED_POS (6)
3575#define BT_UART_MSG_FRAME5RESERVED_MSK \
3576 (0x3 << BT_UART_MSG_FRAME5RESERVED_POS)
3577
3578#define BT_UART_MSG_FRAME6SNIFFINTERVAL_POS (0)
3579#define BT_UART_MSG_FRAME6SNIFFINTERVAL_MSK \
3580 (0x1F << BT_UART_MSG_FRAME6SNIFFINTERVAL_POS)
3581#define BT_UART_MSG_FRAME6DISCOVERABLE_POS (5)
3582#define BT_UART_MSG_FRAME6DISCOVERABLE_MSK \
3583 (0x1 << BT_UART_MSG_FRAME6DISCOVERABLE_POS)
3584#define BT_UART_MSG_FRAME6RESERVED_POS (6)
3585#define BT_UART_MSG_FRAME6RESERVED_MSK \
3586 (0x3 << BT_UART_MSG_FRAME6RESERVED_POS)
3587
3588#define BT_UART_MSG_FRAME7SNIFFACTIVITY_POS (0)
3589#define BT_UART_MSG_FRAME7SNIFFACTIVITY_MSK \
3590 (0x7 << BT_UART_MSG_FRAME7SNIFFACTIVITY_POS)
Wey-Yi Guy399f66f2011-02-22 08:24:22 -08003591#define BT_UART_MSG_FRAME7PAGE_POS (3)
3592#define BT_UART_MSG_FRAME7PAGE_MSK \
3593 (0x1 << BT_UART_MSG_FRAME7PAGE_POS)
3594#define BT_UART_MSG_FRAME7INQUIRY_POS (4)
3595#define BT_UART_MSG_FRAME7INQUIRY_MSK \
3596 (0x1 << BT_UART_MSG_FRAME7INQUIRY_POS)
Wey-Yi Guyfbba9412010-08-23 07:57:10 -07003597#define BT_UART_MSG_FRAME7CONNECTABLE_POS (5)
3598#define BT_UART_MSG_FRAME7CONNECTABLE_MSK \
3599 (0x1 << BT_UART_MSG_FRAME7CONNECTABLE_POS)
3600#define BT_UART_MSG_FRAME7RESERVED_POS (6)
3601#define BT_UART_MSG_FRAME7RESERVED_MSK \
3602 (0x3 << BT_UART_MSG_FRAME7RESERVED_POS)
3603
Wey-Yi Guyd7220f02011-02-18 17:23:52 -08003604/* BT Session Activity 2 UART message (BT -> WiFi) */
3605#define BT_UART_MSG_2_FRAME1RESERVED1_POS (5)
3606#define BT_UART_MSG_2_FRAME1RESERVED1_MSK \
3607 (0x1<<BT_UART_MSG_2_FRAME1RESERVED1_POS)
3608#define BT_UART_MSG_2_FRAME1RESERVED2_POS (6)
3609#define BT_UART_MSG_2_FRAME1RESERVED2_MSK \
3610 (0x3<<BT_UART_MSG_2_FRAME1RESERVED2_POS)
3611
3612#define BT_UART_MSG_2_FRAME2AGGTRAFFICLOAD_POS (0)
3613#define BT_UART_MSG_2_FRAME2AGGTRAFFICLOAD_MSK \
3614 (0x3F<<BT_UART_MSG_2_FRAME2AGGTRAFFICLOAD_POS)
3615#define BT_UART_MSG_2_FRAME2RESERVED_POS (6)
3616#define BT_UART_MSG_2_FRAME2RESERVED_MSK \
3617 (0x3<<BT_UART_MSG_2_FRAME2RESERVED_POS)
3618
3619#define BT_UART_MSG_2_FRAME3BRLASTTXPOWER_POS (0)
3620#define BT_UART_MSG_2_FRAME3BRLASTTXPOWER_MSK \
3621 (0xF<<BT_UART_MSG_2_FRAME3BRLASTTXPOWER_POS)
3622#define BT_UART_MSG_2_FRAME3INQPAGESRMODE_POS (4)
3623#define BT_UART_MSG_2_FRAME3INQPAGESRMODE_MSK \
3624 (0x1<<BT_UART_MSG_2_FRAME3INQPAGESRMODE_POS)
3625#define BT_UART_MSG_2_FRAME3LEMASTER_POS (5)
3626#define BT_UART_MSG_2_FRAME3LEMASTER_MSK \
3627 (0x1<<BT_UART_MSG_2_FRAME3LEMASTER_POS)
3628#define BT_UART_MSG_2_FRAME3RESERVED_POS (6)
3629#define BT_UART_MSG_2_FRAME3RESERVED_MSK \
3630 (0x3<<BT_UART_MSG_2_FRAME3RESERVED_POS)
3631
3632#define BT_UART_MSG_2_FRAME4LELASTTXPOWER_POS (0)
3633#define BT_UART_MSG_2_FRAME4LELASTTXPOWER_MSK \
3634 (0xF<<BT_UART_MSG_2_FRAME4LELASTTXPOWER_POS)
3635#define BT_UART_MSG_2_FRAME4NUMLECONN_POS (4)
3636#define BT_UART_MSG_2_FRAME4NUMLECONN_MSK \
3637 (0x3<<BT_UART_MSG_2_FRAME4NUMLECONN_POS)
3638#define BT_UART_MSG_2_FRAME4RESERVED_POS (6)
3639#define BT_UART_MSG_2_FRAME4RESERVED_MSK \
3640 (0x3<<BT_UART_MSG_2_FRAME4RESERVED_POS)
3641
3642#define BT_UART_MSG_2_FRAME5BTMINRSSI_POS (0)
3643#define BT_UART_MSG_2_FRAME5BTMINRSSI_MSK \
3644 (0xF<<BT_UART_MSG_2_FRAME5BTMINRSSI_POS)
3645#define BT_UART_MSG_2_FRAME5LESCANINITMODE_POS (4)
3646#define BT_UART_MSG_2_FRAME5LESCANINITMODE_MSK \
3647 (0x1<<BT_UART_MSG_2_FRAME5LESCANINITMODE_POS)
3648#define BT_UART_MSG_2_FRAME5LEADVERMODE_POS (5)
3649#define BT_UART_MSG_2_FRAME5LEADVERMODE_MSK \
3650 (0x1<<BT_UART_MSG_2_FRAME5LEADVERMODE_POS)
3651#define BT_UART_MSG_2_FRAME5RESERVED_POS (6)
3652#define BT_UART_MSG_2_FRAME5RESERVED_MSK \
3653 (0x3<<BT_UART_MSG_2_FRAME5RESERVED_POS)
3654
3655#define BT_UART_MSG_2_FRAME6LECONNINTERVAL_POS (0)
3656#define BT_UART_MSG_2_FRAME6LECONNINTERVAL_MSK \
3657 (0x1F<<BT_UART_MSG_2_FRAME6LECONNINTERVAL_POS)
3658#define BT_UART_MSG_2_FRAME6RFU_POS (5)
3659#define BT_UART_MSG_2_FRAME6RFU_MSK \
3660 (0x1<<BT_UART_MSG_2_FRAME6RFU_POS)
3661#define BT_UART_MSG_2_FRAME6RESERVED_POS (6)
3662#define BT_UART_MSG_2_FRAME6RESERVED_MSK \
3663 (0x3<<BT_UART_MSG_2_FRAME6RESERVED_POS)
3664
3665#define BT_UART_MSG_2_FRAME7LECONNSLAVELAT_POS (0)
3666#define BT_UART_MSG_2_FRAME7LECONNSLAVELAT_MSK \
3667 (0x7<<BT_UART_MSG_2_FRAME7LECONNSLAVELAT_POS)
3668#define BT_UART_MSG_2_FRAME7LEPROFILE1_POS (3)
3669#define BT_UART_MSG_2_FRAME7LEPROFILE1_MSK \
3670 (0x1<<BT_UART_MSG_2_FRAME7LEPROFILE1_POS)
3671#define BT_UART_MSG_2_FRAME7LEPROFILE2_POS (4)
3672#define BT_UART_MSG_2_FRAME7LEPROFILE2_MSK \
3673 (0x1<<BT_UART_MSG_2_FRAME7LEPROFILE2_POS)
3674#define BT_UART_MSG_2_FRAME7LEPROFILEOTHER_POS (5)
3675#define BT_UART_MSG_2_FRAME7LEPROFILEOTHER_MSK \
3676 (0x1<<BT_UART_MSG_2_FRAME7LEPROFILEOTHER_POS)
3677#define BT_UART_MSG_2_FRAME7RESERVED_POS (6)
3678#define BT_UART_MSG_2_FRAME7RESERVED_MSK \
3679 (0x3<<BT_UART_MSG_2_FRAME7RESERVED_POS)
3680
Wey-Yi Guyfbba9412010-08-23 07:57:10 -07003681
3682struct iwl_bt_uart_msg {
3683 u8 header;
3684 u8 frame1;
3685 u8 frame2;
3686 u8 frame3;
3687 u8 frame4;
3688 u8 frame5;
3689 u8 frame6;
3690 u8 frame7;
3691} __attribute__((packed));
3692
Johannes Berg0288d232010-08-23 07:56:54 -07003693struct iwl_bt_coex_profile_notif {
Wey-Yi Guyfbba9412010-08-23 07:57:10 -07003694 struct iwl_bt_uart_msg last_bt_uart_msg;
Johannes Berg0288d232010-08-23 07:56:54 -07003695 u8 bt_status; /* 0 - off, 1 - on */
3696 u8 bt_traffic_load; /* 0 .. 3? */
3697 u8 bt_ci_compliance; /* 0 - not complied, 1 - complied */
3698 u8 reserved;
3699} __attribute__((packed));
3700
Wey-Yi Guyaeb4a2e2010-08-23 07:57:05 -07003701#define IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_POS 0
3702#define IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_MSK 0x1
3703#define IWL_BT_COEX_PRIO_TBL_PRIO_POS 1
3704#define IWL_BT_COEX_PRIO_TBL_PRIO_MASK 0x0e
3705#define IWL_BT_COEX_PRIO_TBL_RESERVED_POS 4
3706#define IWL_BT_COEX_PRIO_TBL_RESERVED_MASK 0xf0
3707#define IWL_BT_COEX_PRIO_TBL_PRIO_SHIFT 1
Johannes Berg0288d232010-08-23 07:56:54 -07003708
3709/*
3710 * BT Coexistence Priority table
3711 * REPLY_BT_COEX_PRIO_TABLE = 0xcc
3712 */
Wey-Yi Guyaeb4a2e2010-08-23 07:57:05 -07003713enum bt_coex_prio_table_events {
3714 BT_COEX_PRIO_TBL_EVT_INIT_CALIB1 = 0,
3715 BT_COEX_PRIO_TBL_EVT_INIT_CALIB2 = 1,
3716 BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_LOW1 = 2,
3717 BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_LOW2 = 3, /* DC calib */
3718 BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_HIGH1 = 4,
3719 BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_HIGH2 = 5,
3720 BT_COEX_PRIO_TBL_EVT_DTIM = 6,
3721 BT_COEX_PRIO_TBL_EVT_SCAN52 = 7,
3722 BT_COEX_PRIO_TBL_EVT_SCAN24 = 8,
3723 BT_COEX_PRIO_TBL_EVT_RESERVED0 = 9,
3724 BT_COEX_PRIO_TBL_EVT_RESERVED1 = 10,
3725 BT_COEX_PRIO_TBL_EVT_RESERVED2 = 11,
3726 BT_COEX_PRIO_TBL_EVT_RESERVED3 = 12,
3727 BT_COEX_PRIO_TBL_EVT_RESERVED4 = 13,
3728 BT_COEX_PRIO_TBL_EVT_RESERVED5 = 14,
3729 BT_COEX_PRIO_TBL_EVT_RESERVED6 = 15,
3730 /* BT_COEX_PRIO_TBL_EVT_MAX should always be last */
3731 BT_COEX_PRIO_TBL_EVT_MAX,
3732};
3733
3734enum bt_coex_prio_table_priorities {
3735 BT_COEX_PRIO_TBL_DISABLED = 0,
3736 BT_COEX_PRIO_TBL_PRIO_LOW = 1,
3737 BT_COEX_PRIO_TBL_PRIO_HIGH = 2,
3738 BT_COEX_PRIO_TBL_PRIO_BYPASS = 3,
3739 BT_COEX_PRIO_TBL_PRIO_COEX_OFF = 4,
3740 BT_COEX_PRIO_TBL_PRIO_COEX_ON = 5,
3741 BT_COEX_PRIO_TBL_PRIO_RSRVD1 = 6,
3742 BT_COEX_PRIO_TBL_PRIO_RSRVD2 = 7,
3743 BT_COEX_PRIO_TBL_MAX,
3744};
3745
Johannes Berg0288d232010-08-23 07:56:54 -07003746struct iwl_bt_coex_prio_table_cmd {
Wey-Yi Guyaeb4a2e2010-08-23 07:57:05 -07003747 u8 prio_tbl[BT_COEX_PRIO_TBL_EVT_MAX];
Johannes Berg0288d232010-08-23 07:56:54 -07003748} __attribute__((packed));
3749
Wey-Yi Guyaeb4a2e2010-08-23 07:57:05 -07003750#define IWL_BT_COEX_ENV_CLOSE 0
3751#define IWL_BT_COEX_ENV_OPEN 1
Johannes Berg0288d232010-08-23 07:56:54 -07003752/*
3753 * BT Protection Envelope
3754 * REPLY_BT_COEX_PROT_ENV = 0xcd
3755 */
3756struct iwl_bt_coex_prot_env_cmd {
Wey-Yi Guyaeb4a2e2010-08-23 07:57:05 -07003757 u8 action; /* 0 = closed, 1 = open */
Johannes Berg0288d232010-08-23 07:56:54 -07003758 u8 type; /* 0 .. 15 */
3759 u8 reserved[2];
3760} __attribute__((packed));
3761
3762/******************************************************************************
Zhu Yib481de92007-09-25 17:54:57 -07003763 * (13)
3764 * Union of all expected notifications/responses:
3765 *
3766 *****************************************************************************/
3767
Tomas Winklerdb11d632008-05-05 10:22:33 +08003768struct iwl_rx_packet {
Zhu Yi2f301222009-10-09 17:19:45 +08003769 /*
3770 * The first 4 bytes of the RX frame header contain both the RX frame
3771 * size and some flags.
3772 * Bit fields:
3773 * 31: flag flush RB request
3774 * 30: flag ignore TC (terminal counter) request
3775 * 29: flag fast IRQ request
3776 * 28-14: Reserved
3777 * 13-00: RX frame size
3778 */
Daniel C Halperin396887a2009-08-13 13:31:01 -07003779 __le32 len_n_flags;
Tomas Winkler857485c2008-03-21 13:53:44 -07003780 struct iwl_cmd_header hdr;
Zhu Yib481de92007-09-25 17:54:57 -07003781 union {
Tomas Winkler885ba202008-05-29 16:34:55 +08003782 struct iwl_alive_resp alive_frame;
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08003783 struct iwl_spectrum_notification spectrum_notif;
3784 struct iwl_csa_notification csa_notif;
Tomas Winkler885ba202008-05-29 16:34:55 +08003785 struct iwl_error_resp err_resp;
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08003786 struct iwl_card_state_notif card_state_notif;
Tomas Winkler7a999bf2008-05-29 16:35:02 +08003787 struct iwl_add_sta_resp add_sta;
3788 struct iwl_rem_sta_resp rem_sta;
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08003789 struct iwl_sleep_notification sleep_notif;
3790 struct iwl_spectrum_resp spectrum;
Emmanuel Grumbach8f91aec2008-06-30 17:23:07 +08003791 struct iwl_notif_statistics stats;
Wey-Yi Guy7980fba2010-07-14 08:08:57 -07003792 struct iwl_bt_notif_statistics stats_bt;
Emmanuel Grumbach653fa4a2008-06-30 17:23:11 +08003793 struct iwl_compressed_ba_resp compressed_ba;
Tomas Winkler2aa6ab82008-12-11 10:33:40 -08003794 struct iwl_missed_beacon_notif missed_beacon;
Wey-Yi Guyfe1bcbf2009-10-30 14:36:16 -07003795 struct iwl_coex_medium_notification coex_medium_notif;
3796 struct iwl_coex_event_resp coex_event;
Johannes Berg0288d232010-08-23 07:56:54 -07003797 struct iwl_bt_coex_profile_notif bt_coex_profile_notif;
Zhu Yib481de92007-09-25 17:54:57 -07003798 __le32 status;
3799 u8 raw[0];
3800 } u;
Eric Dumazetba2d3582010-06-02 18:10:09 +00003801} __packed;
Zhu Yib481de92007-09-25 17:54:57 -07003802
Samuel Ortiza3139c52008-12-19 10:37:09 +08003803int iwl_agn_check_rxon_cmd(struct iwl_priv *priv);
Winkler, Tomas8f5c87d2008-12-02 12:13:57 -08003804
Johannes Berg946ba302010-08-23 10:46:48 +02003805/*
3806 * REPLY_WIPAN_PARAMS = 0xb2 (Commands and Notification)
3807 */
3808
Johannes Berg94073912011-01-06 08:07:11 -08003809/*
3810 * Minimum slot time in TU
3811 */
3812#define IWL_MIN_SLOT_TIME 20
3813
Johannes Berg946ba302010-08-23 10:46:48 +02003814/**
3815 * struct iwl_wipan_slot
3816 * @width: Time in TU
3817 * @type:
3818 * 0 - BSS
3819 * 1 - PAN
3820 */
3821struct iwl_wipan_slot {
3822 __le16 width;
3823 u8 type;
3824 u8 reserved;
3825} __packed;
3826
3827#define IWL_WIPAN_PARAMS_FLG_LEAVE_CHANNEL_CTS BIT(1) /* reserved */
3828#define IWL_WIPAN_PARAMS_FLG_LEAVE_CHANNEL_QUIET BIT(2) /* reserved */
3829#define IWL_WIPAN_PARAMS_FLG_SLOTTED_MODE BIT(3) /* reserved */
3830#define IWL_WIPAN_PARAMS_FLG_FILTER_BEACON_NOTIF BIT(4)
3831#define IWL_WIPAN_PARAMS_FLG_FULL_SLOTTED_MODE BIT(5)
3832
3833/**
3834 * struct iwl_wipan_params_cmd
3835 * @flags:
3836 * bit0: reserved
3837 * bit1: CP leave channel with CTS
3838 * bit2: CP leave channel qith Quiet
3839 * bit3: slotted mode
3840 * 1 - work in slotted mode
3841 * 0 - work in non slotted mode
3842 * bit4: filter beacon notification
3843 * bit5: full tx slotted mode. if this flag is set,
3844 * uCode will perform leaving channel methods in context switch
3845 * also when working in same channel mode
3846 * @num_slots: 1 - 10
3847 */
3848struct iwl_wipan_params_cmd {
3849 __le16 flags;
3850 u8 reserved;
3851 u8 num_slots;
3852 struct iwl_wipan_slot slots[10];
3853} __packed;
3854
3855/*
3856 * REPLY_WIPAN_P2P_CHANNEL_SWITCH = 0xb9
3857 *
3858 * TODO: Figure out what this is used for,
3859 * it can only switch between 2.4 GHz
3860 * channels!!
3861 */
3862
3863struct iwl_wipan_p2p_channel_switch_cmd {
3864 __le16 channel;
3865 __le16 reserved;
3866};
3867
3868/*
3869 * REPLY_WIPAN_NOA_NOTIFICATION = 0xbc
3870 *
3871 * This is used by the device to notify us of the
3872 * NoA schedule it determined so we can forward it
3873 * to userspace for inclusion in probe responses.
3874 *
3875 * In beacons, the NoA schedule is simply appended
3876 * to the frame we give the device.
3877 */
3878
3879struct iwl_wipan_noa_descriptor {
3880 u8 count;
3881 __le32 duration;
3882 __le32 interval;
3883 __le32 starttime;
3884} __packed;
3885
3886struct iwl_wipan_noa_attribute {
3887 u8 id;
3888 __le16 length;
3889 u8 index;
3890 u8 ct_window;
3891 struct iwl_wipan_noa_descriptor descr0, descr1;
3892 u8 reserved;
3893} __packed;
3894
3895struct iwl_wipan_noa_notification {
3896 u32 noa_active;
3897 struct iwl_wipan_noa_attribute noa_attribute;
3898} __packed;
3899
Emmanuel Grumbach6a635782008-10-29 14:05:47 -07003900#endif /* __iwl_commands_h__ */