aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/net/wireless/iwlwifi/iwl-commands.h
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/net/wireless/iwlwifi/iwl-commands.h')
-rw-r--r--drivers/net/wireless/iwlwifi/iwl-commands.h3024
1 files changed, 3024 insertions, 0 deletions
diff --git a/drivers/net/wireless/iwlwifi/iwl-commands.h b/drivers/net/wireless/iwlwifi/iwl-commands.h
new file mode 100644
index 000000000000..e9bb1de0ce3f
--- /dev/null
+++ b/drivers/net/wireless/iwlwifi/iwl-commands.h
@@ -0,0 +1,3024 @@
1/******************************************************************************
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 *
8 * Copyright(c) 2005 - 2008 Intel Corporation. All rights reserved.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of version 2 of the GNU General Public License as
12 * 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:
28 * James P. Ketrenos <ipw2100-admin@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30 *
31 * BSD LICENSE
32 *
33 * Copyright(c) 2005 - 2008 Intel Corporation. All rights reserved.
34 * 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 *****************************************************************************/
63/*
64 * Please use this file (iwl-commands.h) only for uCode API definitions.
65 * Please use iwl-4965-hw.h for hardware-related definitions.
66 * Please use iwl-dev.h for driver implementation definitions.
67 */
68
69#ifndef __iwl4965_commands_h__
70#define __iwl4965_commands_h__
71
72enum {
73 REPLY_ALIVE = 0x1,
74 REPLY_ERROR = 0x2,
75
76 /* RXON and QOS commands */
77 REPLY_RXON = 0x10,
78 REPLY_RXON_ASSOC = 0x11,
79 REPLY_QOS_PARAM = 0x13,
80 REPLY_RXON_TIMING = 0x14,
81
82 /* Multi-Station support */
83 REPLY_ADD_STA = 0x18,
84 REPLY_REMOVE_STA = 0x19, /* not used */
85 REPLY_REMOVE_ALL_STA = 0x1a, /* not used */
86
87 /* Security */
88 REPLY_WEPKEY = 0x20,
89
90 /* RX, TX, LEDs */
91 REPLY_TX = 0x1c,
92 REPLY_RATE_SCALE = 0x47, /* 3945 only */
93 REPLY_LEDS_CMD = 0x48,
94 REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */
95
96 /* WiMAX coexistence */
97 COEX_PRIORITY_TABLE_CMD = 0x5a, /*5000 only */
98 COEX_MEDIUM_NOTIFICATION = 0x5b,
99 COEX_EVENT_CMD = 0x5c,
100
101 /* 802.11h related */
102 RADAR_NOTIFICATION = 0x70, /* not used */
103 REPLY_QUIET_CMD = 0x71, /* not used */
104 REPLY_CHANNEL_SWITCH = 0x72,
105 CHANNEL_SWITCH_NOTIFICATION = 0x73,
106 REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
107 SPECTRUM_MEASURE_NOTIFICATION = 0x75,
108
109 /* Power Management */
110 POWER_TABLE_CMD = 0x77,
111 PM_SLEEP_NOTIFICATION = 0x7A,
112 PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
113
114 /* Scan commands and notifications */
115 REPLY_SCAN_CMD = 0x80,
116 REPLY_SCAN_ABORT_CMD = 0x81,
117 SCAN_START_NOTIFICATION = 0x82,
118 SCAN_RESULTS_NOTIFICATION = 0x83,
119 SCAN_COMPLETE_NOTIFICATION = 0x84,
120
121 /* IBSS/AP commands */
122 BEACON_NOTIFICATION = 0x90,
123 REPLY_TX_BEACON = 0x91,
124 WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */
125
126 /* Miscellaneous commands */
127 QUIET_NOTIFICATION = 0x96, /* not used */
128 REPLY_TX_PWR_TABLE_CMD = 0x97,
129 REPLY_TX_POWER_DBM_CMD = 0x98,
130 MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */
131
132 /* Bluetooth device coexistance config command */
133 REPLY_BT_CONFIG = 0x9b,
134
135 /* Statistics */
136 REPLY_STATISTICS_CMD = 0x9c,
137 STATISTICS_NOTIFICATION = 0x9d,
138
139 /* RF-KILL commands and notifications */
140 REPLY_CARD_STATE_CMD = 0xa0,
141 CARD_STATE_NOTIFICATION = 0xa1,
142
143 /* Missed beacons notification */
144 MISSED_BEACONS_NOTIFICATION = 0xa2,
145
146 REPLY_CT_KILL_CONFIG_CMD = 0xa4,
147 SENSITIVITY_CMD = 0xa8,
148 REPLY_PHY_CALIBRATION_CMD = 0xb0,
149 REPLY_RX_PHY_CMD = 0xc0,
150 REPLY_RX_MPDU_CMD = 0xc1,
151 REPLY_RX = 0xc3,
152 REPLY_COMPRESSED_BA = 0xc5,
153 REPLY_MAX = 0xff
154};
155
156/******************************************************************************
157 * (0)
158 * Commonly used structures and definitions:
159 * Command header, rate_n_flags, txpower
160 *
161 *****************************************************************************/
162
163/* iwl_cmd_header flags value */
164#define IWL_CMD_FAILED_MSK 0x40
165
166/**
167 * struct iwl_cmd_header
168 *
169 * This header format appears in the beginning of each command sent from the
170 * driver, and each response/notification received from uCode.
171 */
172struct iwl_cmd_header {
173 u8 cmd; /* Command ID: REPLY_RXON, etc. */
174 u8 flags; /* IWL_CMD_* */
175 /*
176 * The driver sets up the sequence number to values of its chosing.
177 * uCode does not use this value, but passes it back to the driver
178 * when sending the response to each driver-originated command, so
179 * the driver can match the response to the command. Since the values
180 * don't get used by uCode, the driver may set up an arbitrary format.
181 *
182 * There is one exception: uCode sets bit 15 when it originates
183 * the response/notification, i.e. when the response/notification
184 * is not a direct response to a command sent by the driver. For
185 * example, uCode issues REPLY_3945_RX when it sends a received frame
186 * to the driver; it is not a direct response to any driver command.
187 *
188 * The Linux driver uses the following format:
189 *
190 * 0:7 index/position within Tx queue
191 * 8:13 Tx queue selection
192 * 14:14 driver sets this to indicate command is in the 'huge'
193 * storage at the end of the command buffers, i.e. scan cmd
194 * 15:15 uCode sets this in uCode-originated response/notification
195 */
196 __le16 sequence;
197
198 /* command or response/notification data follows immediately */
199 u8 data[0];
200} __attribute__ ((packed));
201
202/**
203 * 4965 rate_n_flags bit fields
204 *
205 * rate_n_flags format is used in following 4965 commands:
206 * REPLY_RX (response only)
207 * REPLY_TX (both command and response)
208 * REPLY_TX_LINK_QUALITY_CMD
209 *
210 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
211 * 2-0: 0) 6 Mbps
212 * 1) 12 Mbps
213 * 2) 18 Mbps
214 * 3) 24 Mbps
215 * 4) 36 Mbps
216 * 5) 48 Mbps
217 * 6) 54 Mbps
218 * 7) 60 Mbps
219 *
220 * 3: 0) Single stream (SISO)
221 * 1) Dual stream (MIMO)
222 *
223 * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps FAT duplicate data
224 *
225 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
226 * 3-0: 0xD) 6 Mbps
227 * 0xF) 9 Mbps
228 * 0x5) 12 Mbps
229 * 0x7) 18 Mbps
230 * 0x9) 24 Mbps
231 * 0xB) 36 Mbps
232 * 0x1) 48 Mbps
233 * 0x3) 54 Mbps
234 *
235 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
236 * 3-0: 10) 1 Mbps
237 * 20) 2 Mbps
238 * 55) 5.5 Mbps
239 * 110) 11 Mbps
240 */
241#define RATE_MCS_CODE_MSK 0x7
242#define RATE_MCS_MIMO_POS 3
243#define RATE_MCS_MIMO_MSK 0x8
244#define RATE_MCS_HT_DUP_POS 5
245#define RATE_MCS_HT_DUP_MSK 0x20
246
247/* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
248#define RATE_MCS_FLAGS_POS 8
249#define RATE_MCS_HT_POS 8
250#define RATE_MCS_HT_MSK 0x100
251
252/* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */
253#define RATE_MCS_CCK_POS 9
254#define RATE_MCS_CCK_MSK 0x200
255
256/* Bit 10: (1) Use Green Field preamble */
257#define RATE_MCS_GF_POS 10
258#define RATE_MCS_GF_MSK 0x400
259
260/* Bit 11: (1) Use 40Mhz FAT chnl width, (0) use 20 MHz legacy chnl width */
261#define RATE_MCS_FAT_POS 11
262#define RATE_MCS_FAT_MSK 0x800
263
264/* Bit 12: (1) Duplicate data on both 20MHz chnls. FAT (bit 11) must be set. */
265#define RATE_MCS_DUP_POS 12
266#define RATE_MCS_DUP_MSK 0x1000
267
268/* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
269#define RATE_MCS_SGI_POS 13
270#define RATE_MCS_SGI_MSK 0x2000
271
272/**
273 * rate_n_flags Tx antenna masks (4965 has 2 transmitters):
274 * bit14:15 01 B inactive, A active
275 * 10 B active, A inactive
276 * 11 Both active
277 */
278#define RATE_MCS_ANT_POS 14
279#define RATE_MCS_ANT_A_MSK 0x04000
280#define RATE_MCS_ANT_B_MSK 0x08000
281#define RATE_MCS_ANT_C_MSK 0x10000
282#define RATE_MCS_ANT_ABC_MSK 0x1C000
283
284#define RATE_MCS_ANT_INIT_IND 1
285
286#define POWER_TABLE_NUM_ENTRIES 33
287#define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32
288#define POWER_TABLE_CCK_ENTRY 32
289
290/**
291 * union iwl4965_tx_power_dual_stream
292 *
293 * Host format used for REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
294 * Use __le32 version (struct tx_power_dual_stream) when building command.
295 *
296 * Driver provides radio gain and DSP attenuation settings to device in pairs,
297 * one value for each transmitter chain. The first value is for transmitter A,
298 * second for transmitter B.
299 *
300 * For SISO bit rates, both values in a pair should be identical.
301 * For MIMO rates, one value may be different from the other,
302 * in order to balance the Tx output between the two transmitters.
303 *
304 * See more details in doc for TXPOWER in iwl-4965-hw.h.
305 */
306union iwl4965_tx_power_dual_stream {
307 struct {
308 u8 radio_tx_gain[2];
309 u8 dsp_predis_atten[2];
310 } s;
311 u32 dw;
312};
313
314/**
315 * struct tx_power_dual_stream
316 *
317 * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
318 *
319 * Same format as iwl_tx_power_dual_stream, but __le32
320 */
321struct tx_power_dual_stream {
322 __le32 dw;
323} __attribute__ ((packed));
324
325/**
326 * struct iwl4965_tx_power_db
327 *
328 * Entire table within REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
329 */
330struct iwl4965_tx_power_db {
331 struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES];
332} __attribute__ ((packed));
333
334/**
335 * Commad REPLY_TX_POWER_DBM_CMD = 0x98
336 * struct iwl5000_tx_power_dbm_cmd
337 */
338#define IWL50_TX_POWER_AUTO 0x7f
339#define IWL50_TX_POWER_NO_CLOSED (0x1 << 6)
340
341struct iwl5000_tx_power_dbm_cmd {
342 s8 global_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
343 u8 flags;
344 s8 srv_chan_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
345 u8 reserved;
346} __attribute__ ((packed));
347
348/******************************************************************************
349 * (0a)
350 * Alive and Error Commands & Responses:
351 *
352 *****************************************************************************/
353
354#define UCODE_VALID_OK __constant_cpu_to_le32(0x1)
355#define INITIALIZE_SUBTYPE (9)
356
357/*
358 * ("Initialize") REPLY_ALIVE = 0x1 (response only, not a command)
359 *
360 * uCode issues this "initialize alive" notification once the initialization
361 * uCode image has completed its work, and is ready to load the runtime image.
362 * This is the *first* "alive" notification that the driver will receive after
363 * rebooting uCode; the "initialize" alive is indicated by subtype field == 9.
364 *
365 * See comments documenting "BSM" (bootstrap state machine).
366 *
367 * For 4965, this notification contains important calibration data for
368 * calculating txpower settings:
369 *
370 * 1) Power supply voltage indication. The voltage sensor outputs higher
371 * values for lower voltage, and vice versa.
372 *
373 * 2) Temperature measurement parameters, for each of two channel widths
374 * (20 MHz and 40 MHz) supported by the radios. Temperature sensing
375 * is done via one of the receiver chains, and channel width influences
376 * the results.
377 *
378 * 3) Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation,
379 * for each of 5 frequency ranges.
380 */
381struct iwl_init_alive_resp {
382 u8 ucode_minor;
383 u8 ucode_major;
384 __le16 reserved1;
385 u8 sw_rev[8];
386 u8 ver_type;
387 u8 ver_subtype; /* "9" for initialize alive */
388 __le16 reserved2;
389 __le32 log_event_table_ptr;
390 __le32 error_event_table_ptr;
391 __le32 timestamp;
392 __le32 is_valid;
393
394 /* calibration values from "initialize" uCode */
395 __le32 voltage; /* signed, higher value is lower voltage */
396 __le32 therm_r1[2]; /* signed, 1st for normal, 2nd for FAT channel*/
397 __le32 therm_r2[2]; /* signed */
398 __le32 therm_r3[2]; /* signed */
399 __le32 therm_r4[2]; /* signed */
400 __le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups,
401 * 2 Tx chains */
402} __attribute__ ((packed));
403
404
405/**
406 * REPLY_ALIVE = 0x1 (response only, not a command)
407 *
408 * uCode issues this "alive" notification once the runtime image is ready
409 * to receive commands from the driver. This is the *second* "alive"
410 * notification that the driver will receive after rebooting uCode;
411 * this "alive" is indicated by subtype field != 9.
412 *
413 * See comments documenting "BSM" (bootstrap state machine).
414 *
415 * This response includes two pointers to structures within the device's
416 * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
417 *
418 * 1) log_event_table_ptr indicates base of the event log. This traces
419 * a 256-entry history of uCode execution within a circular buffer.
420 * Its header format is:
421 *
422 * __le32 log_size; log capacity (in number of entries)
423 * __le32 type; (1) timestamp with each entry, (0) no timestamp
424 * __le32 wraps; # times uCode has wrapped to top of circular buffer
425 * __le32 write_index; next circular buffer entry that uCode would fill
426 *
427 * The header is followed by the circular buffer of log entries. Entries
428 * with timestamps have the following format:
429 *
430 * __le32 event_id; range 0 - 1500
431 * __le32 timestamp; low 32 bits of TSF (of network, if associated)
432 * __le32 data; event_id-specific data value
433 *
434 * Entries without timestamps contain only event_id and data.
435 *
436 * 2) error_event_table_ptr indicates base of the error log. This contains
437 * information about any uCode error that occurs. For 4965, the format
438 * of the error log is:
439 *
440 * __le32 valid; (nonzero) valid, (0) log is empty
441 * __le32 error_id; type of error
442 * __le32 pc; program counter
443 * __le32 blink1; branch link
444 * __le32 blink2; branch link
445 * __le32 ilink1; interrupt link
446 * __le32 ilink2; interrupt link
447 * __le32 data1; error-specific data
448 * __le32 data2; error-specific data
449 * __le32 line; source code line of error
450 * __le32 bcon_time; beacon timer
451 * __le32 tsf_low; network timestamp function timer
452 * __le32 tsf_hi; network timestamp function timer
453 *
454 * The Linux driver can print both logs to the system log when a uCode error
455 * occurs.
456 */
457struct iwl_alive_resp {
458 u8 ucode_minor;
459 u8 ucode_major;
460 __le16 reserved1;
461 u8 sw_rev[8];
462 u8 ver_type;
463 u8 ver_subtype; /* not "9" for runtime alive */
464 __le16 reserved2;
465 __le32 log_event_table_ptr; /* SRAM address for event log */
466 __le32 error_event_table_ptr; /* SRAM address for error log */
467 __le32 timestamp;
468 __le32 is_valid;
469} __attribute__ ((packed));
470
471
472union tsf {
473 u8 byte[8];
474 __le16 word[4];
475 __le32 dw[2];
476};
477
478/*
479 * REPLY_ERROR = 0x2 (response only, not a command)
480 */
481struct iwl_error_resp {
482 __le32 error_type;
483 u8 cmd_id;
484 u8 reserved1;
485 __le16 bad_cmd_seq_num;
486 __le32 error_info;
487 union tsf timestamp;
488} __attribute__ ((packed));
489
490/******************************************************************************
491 * (1)
492 * RXON Commands & Responses:
493 *
494 *****************************************************************************/
495
496/*
497 * Rx config defines & structure
498 */
499/* rx_config device types */
500enum {
501 RXON_DEV_TYPE_AP = 1,
502 RXON_DEV_TYPE_ESS = 3,
503 RXON_DEV_TYPE_IBSS = 4,
504 RXON_DEV_TYPE_SNIFFER = 6,
505};
506
507
508#define RXON_RX_CHAIN_DRIVER_FORCE_MSK __constant_cpu_to_le16(0x1 << 0)
509#define RXON_RX_CHAIN_VALID_MSK __constant_cpu_to_le16(0x7 << 1)
510#define RXON_RX_CHAIN_VALID_POS (1)
511#define RXON_RX_CHAIN_FORCE_SEL_MSK __constant_cpu_to_le16(0x7 << 4)
512#define RXON_RX_CHAIN_FORCE_SEL_POS (4)
513#define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK __constant_cpu_to_le16(0x7 << 7)
514#define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
515#define RXON_RX_CHAIN_CNT_MSK __constant_cpu_to_le16(0x3 << 10)
516#define RXON_RX_CHAIN_CNT_POS (10)
517#define RXON_RX_CHAIN_MIMO_CNT_MSK __constant_cpu_to_le16(0x3 << 12)
518#define RXON_RX_CHAIN_MIMO_CNT_POS (12)
519#define RXON_RX_CHAIN_MIMO_FORCE_MSK __constant_cpu_to_le16(0x1 << 14)
520#define RXON_RX_CHAIN_MIMO_FORCE_POS (14)
521
522/* rx_config flags */
523/* band & modulation selection */
524#define RXON_FLG_BAND_24G_MSK __constant_cpu_to_le32(1 << 0)
525#define RXON_FLG_CCK_MSK __constant_cpu_to_le32(1 << 1)
526/* auto detection enable */
527#define RXON_FLG_AUTO_DETECT_MSK __constant_cpu_to_le32(1 << 2)
528/* TGg protection when tx */
529#define RXON_FLG_TGG_PROTECT_MSK __constant_cpu_to_le32(1 << 3)
530/* cck short slot & preamble */
531#define RXON_FLG_SHORT_SLOT_MSK __constant_cpu_to_le32(1 << 4)
532#define RXON_FLG_SHORT_PREAMBLE_MSK __constant_cpu_to_le32(1 << 5)
533/* antenna selection */
534#define RXON_FLG_DIS_DIV_MSK __constant_cpu_to_le32(1 << 7)
535#define RXON_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0x0f00)
536#define RXON_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8)
537#define RXON_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9)
538/* radar detection enable */
539#define RXON_FLG_RADAR_DETECT_MSK __constant_cpu_to_le32(1 << 12)
540#define RXON_FLG_TGJ_NARROW_BAND_MSK __constant_cpu_to_le32(1 << 13)
541/* rx response to host with 8-byte TSF
542* (according to ON_AIR deassertion) */
543#define RXON_FLG_TSF2HOST_MSK __constant_cpu_to_le32(1 << 15)
544
545
546/* HT flags */
547#define RXON_FLG_CTRL_CHANNEL_LOC_POS (22)
548#define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK __constant_cpu_to_le32(0x1 << 22)
549
550#define RXON_FLG_HT_OPERATING_MODE_POS (23)
551
552#define RXON_FLG_HT_PROT_MSK __constant_cpu_to_le32(0x1 << 23)
553#define RXON_FLG_FAT_PROT_MSK __constant_cpu_to_le32(0x2 << 23)
554
555#define RXON_FLG_CHANNEL_MODE_POS (25)
556#define RXON_FLG_CHANNEL_MODE_MSK __constant_cpu_to_le32(0x3 << 25)
557#define RXON_FLG_CHANNEL_MODE_PURE_40_MSK __constant_cpu_to_le32(0x1 << 25)
558#define RXON_FLG_CHANNEL_MODE_MIXED_MSK __constant_cpu_to_le32(0x2 << 25)
559/* CTS to self (if spec allows) flag */
560#define RXON_FLG_SELF_CTS_EN __constant_cpu_to_le32(0x1<<30)
561
562/* rx_config filter flags */
563/* accept all data frames */
564#define RXON_FILTER_PROMISC_MSK __constant_cpu_to_le32(1 << 0)
565/* pass control & management to host */
566#define RXON_FILTER_CTL2HOST_MSK __constant_cpu_to_le32(1 << 1)
567/* accept multi-cast */
568#define RXON_FILTER_ACCEPT_GRP_MSK __constant_cpu_to_le32(1 << 2)
569/* don't decrypt uni-cast frames */
570#define RXON_FILTER_DIS_DECRYPT_MSK __constant_cpu_to_le32(1 << 3)
571/* don't decrypt multi-cast frames */
572#define RXON_FILTER_DIS_GRP_DECRYPT_MSK __constant_cpu_to_le32(1 << 4)
573/* STA is associated */
574#define RXON_FILTER_ASSOC_MSK __constant_cpu_to_le32(1 << 5)
575/* transfer to host non bssid beacons in associated state */
576#define RXON_FILTER_BCON_AWARE_MSK __constant_cpu_to_le32(1 << 6)
577
578/**
579 * REPLY_RXON = 0x10 (command, has simple generic response)
580 *
581 * RXON tunes the radio tuner to a service channel, and sets up a number
582 * of parameters that are used primarily for Rx, but also for Tx operations.
583 *
584 * NOTE: When tuning to a new channel, driver must set the
585 * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent
586 * info within the device, including the station tables, tx retry
587 * rate tables, and txpower tables. Driver must build a new station
588 * table and txpower table before transmitting anything on the RXON
589 * channel.
590 *
591 * NOTE: All RXONs wipe clean the internal txpower table. Driver must
592 * issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
593 * regardless of whether RXON_FILTER_ASSOC_MSK is set.
594 */
595struct iwl4965_rxon_cmd {
596 u8 node_addr[6];
597 __le16 reserved1;
598 u8 bssid_addr[6];
599 __le16 reserved2;
600 u8 wlap_bssid_addr[6];
601 __le16 reserved3;
602 u8 dev_type;
603 u8 air_propagation;
604 __le16 rx_chain;
605 u8 ofdm_basic_rates;
606 u8 cck_basic_rates;
607 __le16 assoc_id;
608 __le32 flags;
609 __le32 filter_flags;
610 __le16 channel;
611 u8 ofdm_ht_single_stream_basic_rates;
612 u8 ofdm_ht_dual_stream_basic_rates;
613} __attribute__ ((packed));
614
615/* 5000 HW just extend this cmmand */
616struct iwl_rxon_cmd {
617 u8 node_addr[6];
618 __le16 reserved1;
619 u8 bssid_addr[6];
620 __le16 reserved2;
621 u8 wlap_bssid_addr[6];
622 __le16 reserved3;
623 u8 dev_type;
624 u8 air_propagation;
625 __le16 rx_chain;
626 u8 ofdm_basic_rates;
627 u8 cck_basic_rates;
628 __le16 assoc_id;
629 __le32 flags;
630 __le32 filter_flags;
631 __le16 channel;
632 u8 ofdm_ht_single_stream_basic_rates;
633 u8 ofdm_ht_dual_stream_basic_rates;
634 u8 ofdm_ht_triple_stream_basic_rates;
635 u8 reserved5;
636 __le16 acquisition_data;
637 __le16 reserved6;
638} __attribute__ ((packed));
639
640struct iwl5000_rxon_assoc_cmd {
641 __le32 flags;
642 __le32 filter_flags;
643 u8 ofdm_basic_rates;
644 u8 cck_basic_rates;
645 __le16 reserved1;
646 u8 ofdm_ht_single_stream_basic_rates;
647 u8 ofdm_ht_dual_stream_basic_rates;
648 u8 ofdm_ht_triple_stream_basic_rates;
649 u8 reserved2;
650 __le16 rx_chain_select_flags;
651 __le16 acquisition_data;
652 __le32 reserved3;
653} __attribute__ ((packed));
654
655/*
656 * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
657 */
658struct iwl4965_rxon_assoc_cmd {
659 __le32 flags;
660 __le32 filter_flags;
661 u8 ofdm_basic_rates;
662 u8 cck_basic_rates;
663 u8 ofdm_ht_single_stream_basic_rates;
664 u8 ofdm_ht_dual_stream_basic_rates;
665 __le16 rx_chain_select_flags;
666 __le16 reserved;
667} __attribute__ ((packed));
668
669
670
671
672/*
673 * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
674 */
675struct iwl4965_rxon_time_cmd {
676 union tsf timestamp;
677 __le16 beacon_interval;
678 __le16 atim_window;
679 __le32 beacon_init_val;
680 __le16 listen_interval;
681 __le16 reserved;
682} __attribute__ ((packed));
683
684/*
685 * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
686 */
687struct iwl4965_channel_switch_cmd {
688 u8 band;
689 u8 expect_beacon;
690 __le16 channel;
691 __le32 rxon_flags;
692 __le32 rxon_filter_flags;
693 __le32 switch_time;
694 struct iwl4965_tx_power_db tx_power;
695} __attribute__ ((packed));
696
697/*
698 * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
699 */
700struct iwl4965_csa_notification {
701 __le16 band;
702 __le16 channel;
703 __le32 status; /* 0 - OK, 1 - fail */
704} __attribute__ ((packed));
705
706/******************************************************************************
707 * (2)
708 * Quality-of-Service (QOS) Commands & Responses:
709 *
710 *****************************************************************************/
711
712/**
713 * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
714 * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
715 *
716 * @cw_min: Contention window, start value in numbers of slots.
717 * Should be a power-of-2, minus 1. Device's default is 0x0f.
718 * @cw_max: Contention window, max value in numbers of slots.
719 * Should be a power-of-2, minus 1. Device's default is 0x3f.
720 * @aifsn: Number of slots in Arbitration Interframe Space (before
721 * performing random backoff timing prior to Tx). Device default 1.
722 * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
723 *
724 * Device will automatically increase contention window by (2*CW) + 1 for each
725 * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
726 * value, to cap the CW value.
727 */
728struct iwl_ac_qos {
729 __le16 cw_min;
730 __le16 cw_max;
731 u8 aifsn;
732 u8 reserved1;
733 __le16 edca_txop;
734} __attribute__ ((packed));
735
736/* QoS flags defines */
737#define QOS_PARAM_FLG_UPDATE_EDCA_MSK __constant_cpu_to_le32(0x01)
738#define QOS_PARAM_FLG_TGN_MSK __constant_cpu_to_le32(0x02)
739#define QOS_PARAM_FLG_TXOP_TYPE_MSK __constant_cpu_to_le32(0x10)
740
741/* Number of Access Categories (AC) (EDCA), queues 0..3 */
742#define AC_NUM 4
743
744/*
745 * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
746 *
747 * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
748 * 0: Background, 1: Best Effort, 2: Video, 3: Voice.
749 */
750struct iwl_qosparam_cmd {
751 __le32 qos_flags;
752 struct iwl_ac_qos ac[AC_NUM];
753} __attribute__ ((packed));
754
755/******************************************************************************
756 * (3)
757 * Add/Modify Stations Commands & Responses:
758 *
759 *****************************************************************************/
760/*
761 * Multi station support
762 */
763
764/* Special, dedicated locations within device's station table */
765#define IWL_AP_ID 0
766#define IWL_MULTICAST_ID 1
767#define IWL_STA_ID 2
768#define IWL4965_BROADCAST_ID 31
769#define IWL4965_STATION_COUNT 32
770#define IWL5000_BROADCAST_ID 15
771#define IWL5000_STATION_COUNT 16
772
773#define IWL_STATION_COUNT 32 /* MAX(3945,4965)*/
774#define IWL_INVALID_STATION 255
775
776#define STA_FLG_PWR_SAVE_MSK __constant_cpu_to_le32(1 << 8);
777#define STA_FLG_RTS_MIMO_PROT_MSK __constant_cpu_to_le32(1 << 17)
778#define STA_FLG_AGG_MPDU_8US_MSK __constant_cpu_to_le32(1 << 18)
779#define STA_FLG_MAX_AGG_SIZE_POS (19)
780#define STA_FLG_MAX_AGG_SIZE_MSK __constant_cpu_to_le32(3 << 19)
781#define STA_FLG_FAT_EN_MSK __constant_cpu_to_le32(1 << 21)
782#define STA_FLG_MIMO_DIS_MSK __constant_cpu_to_le32(1 << 22)
783#define STA_FLG_AGG_MPDU_DENSITY_POS (23)
784#define STA_FLG_AGG_MPDU_DENSITY_MSK __constant_cpu_to_le32(7 << 23)
785
786/* Use in mode field. 1: modify existing entry, 0: add new station entry */
787#define STA_CONTROL_MODIFY_MSK 0x01
788
789/* key flags __le16*/
790#define STA_KEY_FLG_ENCRYPT_MSK __constant_cpu_to_le16(0x0007)
791#define STA_KEY_FLG_NO_ENC __constant_cpu_to_le16(0x0000)
792#define STA_KEY_FLG_WEP __constant_cpu_to_le16(0x0001)
793#define STA_KEY_FLG_CCMP __constant_cpu_to_le16(0x0002)
794#define STA_KEY_FLG_TKIP __constant_cpu_to_le16(0x0003)
795
796#define STA_KEY_FLG_KEYID_POS 8
797#define STA_KEY_FLG_INVALID __constant_cpu_to_le16(0x0800)
798/* wep key is either from global key (0) or from station info array (1) */
799#define STA_KEY_FLG_MAP_KEY_MSK __constant_cpu_to_le16(0x0008)
800
801/* wep key in STA: 5-bytes (0) or 13-bytes (1) */
802#define STA_KEY_FLG_KEY_SIZE_MSK __constant_cpu_to_le16(0x1000)
803#define STA_KEY_MULTICAST_MSK __constant_cpu_to_le16(0x4000)
804#define STA_KEY_MAX_NUM 8
805
806/* Flags indicate whether to modify vs. don't change various station params */
807#define STA_MODIFY_KEY_MASK 0x01
808#define STA_MODIFY_TID_DISABLE_TX 0x02
809#define STA_MODIFY_TX_RATE_MSK 0x04
810#define STA_MODIFY_ADDBA_TID_MSK 0x08
811#define STA_MODIFY_DELBA_TID_MSK 0x10
812
813/* Receiver address (actually, Rx station's index into station table),
814 * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
815#define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid))
816
817struct iwl4965_keyinfo {
818 __le16 key_flags;
819 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
820 u8 reserved1;
821 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
822 u8 key_offset;
823 u8 reserved2;
824 u8 key[16]; /* 16-byte unicast decryption key */
825} __attribute__ ((packed));
826
827/* 5000 */
828struct iwl_keyinfo {
829 __le16 key_flags;
830 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
831 u8 reserved1;
832 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
833 u8 key_offset;
834 u8 reserved2;
835 u8 key[16]; /* 16-byte unicast decryption key */
836 __le64 tx_secur_seq_cnt;
837 __le64 hw_tkip_mic_rx_key;
838 __le64 hw_tkip_mic_tx_key;
839} __attribute__ ((packed));
840
841/**
842 * struct sta_id_modify
843 * @addr[ETH_ALEN]: station's MAC address
844 * @sta_id: index of station in uCode's station table
845 * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
846 *
847 * Driver selects unused table index when adding new station,
848 * or the index to a pre-existing station entry when modifying that station.
849 * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
850 *
851 * modify_mask flags select which parameters to modify vs. leave alone.
852 */
853struct sta_id_modify {
854 u8 addr[ETH_ALEN];
855 __le16 reserved1;
856 u8 sta_id;
857 u8 modify_mask;
858 __le16 reserved2;
859} __attribute__ ((packed));
860
861/*
862 * REPLY_ADD_STA = 0x18 (command)
863 *
864 * The device contains an internal table of per-station information,
865 * with info on security keys, aggregation parameters, and Tx rates for
866 * initial Tx attempt and any retries (4965 uses REPLY_TX_LINK_QUALITY_CMD,
867 * 3945 uses REPLY_RATE_SCALE to set up rate tables).
868 *
869 * REPLY_ADD_STA sets up the table entry for one station, either creating
870 * a new entry, or modifying a pre-existing one.
871 *
872 * NOTE: RXON command (without "associated" bit set) wipes the station table
873 * clean. Moving into RF_KILL state does this also. Driver must set up
874 * new station table before transmitting anything on the RXON channel
875 * (except active scans or active measurements; those commands carry
876 * their own txpower/rate setup data).
877 *
878 * When getting started on a new channel, driver must set up the
879 * IWL_BROADCAST_ID entry (last entry in the table). For a client
880 * station in a BSS, once an AP is selected, driver sets up the AP STA
881 * in the IWL_AP_ID entry (1st entry in the table). BROADCAST and AP
882 * are all that are needed for a BSS client station. If the device is
883 * used as AP, or in an IBSS network, driver must set up station table
884 * entries for all STAs in network, starting with index IWL_STA_ID.
885 */
886struct iwl4965_addsta_cmd {
887 u8 mode; /* 1: modify existing, 0: add new station */
888 u8 reserved[3];
889 struct sta_id_modify sta;
890 struct iwl4965_keyinfo key;
891 __le32 station_flags; /* STA_FLG_* */
892 __le32 station_flags_msk; /* STA_FLG_* */
893
894 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
895 * corresponding to bit (e.g. bit 5 controls TID 5).
896 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
897 __le16 tid_disable_tx;
898
899 __le16 reserved1;
900
901 /* TID for which to add block-ack support.
902 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
903 u8 add_immediate_ba_tid;
904
905 /* TID for which to remove block-ack support.
906 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
907 u8 remove_immediate_ba_tid;
908
909 /* Starting Sequence Number for added block-ack support.
910 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
911 __le16 add_immediate_ba_ssn;
912
913 __le32 reserved2;
914} __attribute__ ((packed));
915
916/* 5000 */
917struct iwl_addsta_cmd {
918 u8 mode; /* 1: modify existing, 0: add new station */
919 u8 reserved[3];
920 struct sta_id_modify sta;
921 struct iwl_keyinfo key;
922 __le32 station_flags; /* STA_FLG_* */
923 __le32 station_flags_msk; /* STA_FLG_* */
924
925 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
926 * corresponding to bit (e.g. bit 5 controls TID 5).
927 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
928 __le16 tid_disable_tx;
929
930 __le16 reserved1;
931
932 /* TID for which to add block-ack support.
933 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
934 u8 add_immediate_ba_tid;
935
936 /* TID for which to remove block-ack support.
937 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
938 u8 remove_immediate_ba_tid;
939
940 /* Starting Sequence Number for added block-ack support.
941 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
942 __le16 add_immediate_ba_ssn;
943
944 __le32 reserved2;
945} __attribute__ ((packed));
946
947
948#define ADD_STA_SUCCESS_MSK 0x1
949#define ADD_STA_NO_ROOM_IN_TABLE 0x2
950#define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4
951#define ADD_STA_MODIFY_NON_EXIST_STA 0x8
952/*
953 * REPLY_ADD_STA = 0x18 (response)
954 */
955struct iwl_add_sta_resp {
956 u8 status; /* ADD_STA_* */
957} __attribute__ ((packed));
958
959#define REM_STA_SUCCESS_MSK 0x1
960/*
961 * REPLY_REM_STA = 0x19 (response)
962 */
963struct iwl_rem_sta_resp {
964 u8 status;
965} __attribute__ ((packed));
966
967/*
968 * REPLY_REM_STA = 0x19 (command)
969 */
970struct iwl_rem_sta_cmd {
971 u8 num_sta; /* number of removed stations */
972 u8 reserved[3];
973 u8 addr[ETH_ALEN]; /* MAC addr of the first station */
974 u8 reserved2[2];
975} __attribute__ ((packed));
976
977/*
978 * REPLY_WEP_KEY = 0x20
979 */
980struct iwl_wep_key {
981 u8 key_index;
982 u8 key_offset;
983 u8 reserved1[2];
984 u8 key_size;
985 u8 reserved2[3];
986 u8 key[16];
987} __attribute__ ((packed));
988
989struct iwl_wep_cmd {
990 u8 num_keys;
991 u8 global_key_type;
992 u8 flags;
993 u8 reserved;
994 struct iwl_wep_key key[0];
995} __attribute__ ((packed));
996
997#define WEP_KEY_WEP_TYPE 1
998#define WEP_KEYS_MAX 4
999#define WEP_INVALID_OFFSET 0xff
1000#define WEP_KEY_LEN_64 5
1001#define WEP_KEY_LEN_128 13
1002
1003/******************************************************************************
1004 * (4)
1005 * Rx Responses:
1006 *
1007 *****************************************************************************/
1008
1009struct iwl4965_rx_frame_stats {
1010 u8 phy_count;
1011 u8 id;
1012 u8 rssi;
1013 u8 agc;
1014 __le16 sig_avg;
1015 __le16 noise_diff;
1016 u8 payload[0];
1017} __attribute__ ((packed));
1018
1019struct iwl4965_rx_frame_hdr {
1020 __le16 channel;
1021 __le16 phy_flags;
1022 u8 reserved1;
1023 u8 rate;
1024 __le16 len;
1025 u8 payload[0];
1026} __attribute__ ((packed));
1027
1028#define RX_RES_STATUS_NO_CRC32_ERROR __constant_cpu_to_le32(1 << 0)
1029#define RX_RES_STATUS_NO_RXE_OVERFLOW __constant_cpu_to_le32(1 << 1)
1030
1031#define RX_RES_PHY_FLAGS_BAND_24_MSK __constant_cpu_to_le16(1 << 0)
1032#define RX_RES_PHY_FLAGS_MOD_CCK_MSK __constant_cpu_to_le16(1 << 1)
1033#define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK __constant_cpu_to_le16(1 << 2)
1034#define RX_RES_PHY_FLAGS_NARROW_BAND_MSK __constant_cpu_to_le16(1 << 3)
1035#define RX_RES_PHY_FLAGS_ANTENNA_MSK __constant_cpu_to_le16(0xf0)
1036
1037#define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)
1038#define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)
1039#define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)
1040#define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)
1041#define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)
1042#define RX_RES_STATUS_SEC_TYPE_ERR (0x7 << 8)
1043
1044#define RX_RES_STATUS_STATION_FOUND (1<<6)
1045#define RX_RES_STATUS_NO_STATION_INFO_MISMATCH (1<<7)
1046
1047#define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)
1048#define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)
1049#define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)
1050#define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)
1051#define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)
1052
1053#define RX_MPDU_RES_STATUS_ICV_OK (0x20)
1054#define RX_MPDU_RES_STATUS_MIC_OK (0x40)
1055#define RX_MPDU_RES_STATUS_TTAK_OK (1 << 7)
1056#define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800)
1057
1058struct iwl4965_rx_frame_end {
1059 __le32 status;
1060 __le64 timestamp;
1061 __le32 beacon_timestamp;
1062} __attribute__ ((packed));
1063
1064/*
1065 * REPLY_3945_RX = 0x1b (response only, not a command)
1066 *
1067 * NOTE: DO NOT dereference from casts to this structure
1068 * It is provided only for calculating minimum data set size.
1069 * The actual offsets of the hdr and end are dynamic based on
1070 * stats.phy_count
1071 */
1072struct iwl4965_rx_frame {
1073 struct iwl4965_rx_frame_stats stats;
1074 struct iwl4965_rx_frame_hdr hdr;
1075 struct iwl4965_rx_frame_end end;
1076} __attribute__ ((packed));
1077
1078/* Fixed (non-configurable) rx data from phy */
1079#define RX_PHY_FLAGS_ANTENNAE_OFFSET (4)
1080#define RX_PHY_FLAGS_ANTENNAE_MASK (0x70)
1081#define IWL_AGC_DB_MASK (0x3f80) /* MASK(7,13) */
1082#define IWL_AGC_DB_POS (7)
1083struct iwl4965_rx_non_cfg_phy {
1084 __le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */
1085 __le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */
1086 u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */
1087 u8 pad[0];
1088} __attribute__ ((packed));
1089
1090/*
1091 * REPLY_RX = 0xc3 (response only, not a command)
1092 * Used only for legacy (non 11n) frames.
1093 */
1094#define RX_RES_PHY_CNT 14
1095struct iwl4965_rx_phy_res {
1096 u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */
1097 u8 cfg_phy_cnt; /* configurable DSP phy data byte count */
1098 u8 stat_id; /* configurable DSP phy data set ID */
1099 u8 reserved1;
1100 __le64 timestamp; /* TSF at on air rise */
1101 __le32 beacon_time_stamp; /* beacon at on-air rise */
1102 __le16 phy_flags; /* general phy flags: band, modulation, ... */
1103 __le16 channel; /* channel number */
1104 __le16 non_cfg_phy[RX_RES_PHY_CNT]; /* upto 14 phy entries */
1105 __le32 reserved2;
1106 __le32 rate_n_flags; /* RATE_MCS_* */
1107 __le16 byte_count; /* frame's byte-count */
1108 __le16 reserved3;
1109} __attribute__ ((packed));
1110
1111struct iwl4965_rx_mpdu_res_start {
1112 __le16 byte_count;
1113 __le16 reserved;
1114} __attribute__ ((packed));
1115
1116
1117/******************************************************************************
1118 * (5)
1119 * Tx Commands & Responses:
1120 *
1121 * Driver must place each REPLY_TX command into one of the prioritized Tx
1122 * queues in host DRAM, shared between driver and device (see comments for
1123 * SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode
1124 * are preparing to transmit, the device pulls the Tx command over the PCI
1125 * bus via one of the device's Tx DMA channels, to fill an internal FIFO
1126 * from which data will be transmitted.
1127 *
1128 * uCode handles all timing and protocol related to control frames
1129 * (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler
1130 * handle reception of block-acks; uCode updates the host driver via
1131 * REPLY_COMPRESSED_BA (4965).
1132 *
1133 * uCode handles retrying Tx when an ACK is expected but not received.
1134 * This includes trying lower data rates than the one requested in the Tx
1135 * command, as set up by the REPLY_RATE_SCALE (for 3945) or
1136 * REPLY_TX_LINK_QUALITY_CMD (4965).
1137 *
1138 * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
1139 * This command must be executed after every RXON command, before Tx can occur.
1140 *****************************************************************************/
1141
1142/* REPLY_TX Tx flags field */
1143
1144/* 1: Use RTS/CTS protocol or CTS-to-self if spec alows it
1145 * before this frame. if CTS-to-self required check
1146 * RXON_FLG_SELF_CTS_EN status. */
1147#define TX_CMD_FLG_RTS_CTS_MSK __constant_cpu_to_le32(1 << 0)
1148
1149/* 1: Use Request-To-Send protocol before this frame.
1150 * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK. */
1151#define TX_CMD_FLG_RTS_MSK __constant_cpu_to_le32(1 << 1)
1152
1153/* 1: Transmit Clear-To-Send to self before this frame.
1154 * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
1155 * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK. */
1156#define TX_CMD_FLG_CTS_MSK __constant_cpu_to_le32(1 << 2)
1157
1158/* 1: Expect ACK from receiving station
1159 * 0: Don't expect ACK (MAC header's duration field s/b 0)
1160 * Set this for unicast frames, but not broadcast/multicast. */
1161#define TX_CMD_FLG_ACK_MSK __constant_cpu_to_le32(1 << 3)
1162
1163/* For 4965:
1164 * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
1165 * Tx command's initial_rate_index indicates first rate to try;
1166 * uCode walks through table for additional Tx attempts.
1167 * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
1168 * This rate will be used for all Tx attempts; it will not be scaled. */
1169#define TX_CMD_FLG_STA_RATE_MSK __constant_cpu_to_le32(1 << 4)
1170
1171/* 1: Expect immediate block-ack.
1172 * Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */
1173#define TX_CMD_FLG_IMM_BA_RSP_MASK __constant_cpu_to_le32(1 << 6)
1174
1175/* 1: Frame requires full Tx-Op protection.
1176 * Set this if either RTS or CTS Tx Flag gets set. */
1177#define TX_CMD_FLG_FULL_TXOP_PROT_MSK __constant_cpu_to_le32(1 << 7)
1178
1179/* Tx antenna selection field; used only for 3945, reserved (0) for 4965.
1180 * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
1181#define TX_CMD_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0xf00)
1182#define TX_CMD_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8)
1183#define TX_CMD_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9)
1184
1185/* 1: Ignore Bluetooth priority for this frame.
1186 * 0: Delay Tx until Bluetooth device is done (normal usage). */
1187#define TX_CMD_FLG_BT_DIS_MSK __constant_cpu_to_le32(1 << 12)
1188
1189/* 1: uCode overrides sequence control field in MAC header.
1190 * 0: Driver provides sequence control field in MAC header.
1191 * Set this for management frames, non-QOS data frames, non-unicast frames,
1192 * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
1193#define TX_CMD_FLG_SEQ_CTL_MSK __constant_cpu_to_le32(1 << 13)
1194
1195/* 1: This frame is non-last MPDU; more fragments are coming.
1196 * 0: Last fragment, or not using fragmentation. */
1197#define TX_CMD_FLG_MORE_FRAG_MSK __constant_cpu_to_le32(1 << 14)
1198
1199/* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
1200 * 0: No TSF required in outgoing frame.
1201 * Set this for transmitting beacons and probe responses. */
1202#define TX_CMD_FLG_TSF_MSK __constant_cpu_to_le32(1 << 16)
1203
1204/* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
1205 * alignment of frame's payload data field.
1206 * 0: No pad
1207 * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
1208 * field (but not both). Driver must align frame data (i.e. data following
1209 * MAC header) to DWORD boundary. */
1210#define TX_CMD_FLG_MH_PAD_MSK __constant_cpu_to_le32(1 << 20)
1211
1212/* accelerate aggregation support
1213 * 0 - no CCMP encryption; 1 - CCMP encryption */
1214#define TX_CMD_FLG_AGG_CCMP_MSK __constant_cpu_to_le32(1 << 22)
1215
1216/* HCCA-AP - disable duration overwriting. */
1217#define TX_CMD_FLG_DUR_MSK __constant_cpu_to_le32(1 << 25)
1218
1219
1220/*
1221 * TX command security control
1222 */
1223#define TX_CMD_SEC_WEP 0x01
1224#define TX_CMD_SEC_CCM 0x02
1225#define TX_CMD_SEC_TKIP 0x03
1226#define TX_CMD_SEC_MSK 0x03
1227#define TX_CMD_SEC_SHIFT 6
1228#define TX_CMD_SEC_KEY128 0x08
1229
1230/*
1231 * security overhead sizes
1232 */
1233#define WEP_IV_LEN 4
1234#define WEP_ICV_LEN 4
1235#define CCMP_MIC_LEN 8
1236#define TKIP_ICV_LEN 4
1237
1238/*
1239 * 4965 uCode updates these Tx attempt count values in host DRAM.
1240 * Used for managing Tx retries when expecting block-acks.
1241 * Driver should set these fields to 0.
1242 */
1243struct iwl4965_dram_scratch {
1244 u8 try_cnt; /* Tx attempts */
1245 u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */
1246 __le16 reserved;
1247} __attribute__ ((packed));
1248
1249/*
1250 * REPLY_TX = 0x1c (command)
1251 */
1252struct iwl_tx_cmd {
1253 /*
1254 * MPDU byte count:
1255 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
1256 * + 8 byte IV for CCM or TKIP (not used for WEP)
1257 * + Data payload
1258 * + 8-byte MIC (not used for CCM/WEP)
1259 * NOTE: Does not include Tx command bytes, post-MAC pad bytes,
1260 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
1261 * Range: 14-2342 bytes.
1262 */
1263 __le16 len;
1264
1265 /*
1266 * MPDU or MSDU byte count for next frame.
1267 * Used for fragmentation and bursting, but not 11n aggregation.
1268 * Same as "len", but for next frame. Set to 0 if not applicable.
1269 */
1270 __le16 next_frame_len;
1271
1272 __le32 tx_flags; /* TX_CMD_FLG_* */
1273
1274 /* 4965's uCode may modify this field of the Tx command (in host DRAM!).
1275 * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
1276 struct iwl4965_dram_scratch scratch;
1277
1278 /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
1279 __le32 rate_n_flags; /* RATE_MCS_* */
1280
1281 /* Index of destination station in uCode's station table */
1282 u8 sta_id;
1283
1284 /* Type of security encryption: CCM or TKIP */
1285 u8 sec_ctl; /* TX_CMD_SEC_* */
1286
1287 /*
1288 * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial
1289 * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for
1290 * data frames, this field may be used to selectively reduce initial
1291 * rate (via non-0 value) for special frames (e.g. management), while
1292 * still supporting rate scaling for all frames.
1293 */
1294 u8 initial_rate_index;
1295 u8 reserved;
1296 u8 key[16];
1297 __le16 next_frame_flags;
1298 __le16 reserved2;
1299 union {
1300 __le32 life_time;
1301 __le32 attempt;
1302 } stop_time;
1303
1304 /* Host DRAM physical address pointer to "scratch" in this command.
1305 * Must be dword aligned. "0" in dram_lsb_ptr disables usage. */
1306 __le32 dram_lsb_ptr;
1307 u8 dram_msb_ptr;
1308
1309 u8 rts_retry_limit; /*byte 50 */
1310 u8 data_retry_limit; /*byte 51 */
1311 u8 tid_tspec;
1312 union {
1313 __le16 pm_frame_timeout;
1314 __le16 attempt_duration;
1315 } timeout;
1316
1317 /*
1318 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
1319 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
1320 */
1321 __le16 driver_txop;
1322
1323 /*
1324 * MAC header goes here, followed by 2 bytes padding if MAC header
1325 * length is 26 or 30 bytes, followed by payload data
1326 */
1327 u8 payload[0];
1328 struct ieee80211_hdr hdr[0];
1329} __attribute__ ((packed));
1330
1331/* TX command response is sent after *all* transmission attempts.
1332 *
1333 * NOTES:
1334 *
1335 * TX_STATUS_FAIL_NEXT_FRAG
1336 *
1337 * If the fragment flag in the MAC header for the frame being transmitted
1338 * is set and there is insufficient time to transmit the next frame, the
1339 * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
1340 *
1341 * TX_STATUS_FIFO_UNDERRUN
1342 *
1343 * Indicates the host did not provide bytes to the FIFO fast enough while
1344 * a TX was in progress.
1345 *
1346 * TX_STATUS_FAIL_MGMNT_ABORT
1347 *
1348 * This status is only possible if the ABORT ON MGMT RX parameter was
1349 * set to true with the TX command.
1350 *
1351 * If the MSB of the status parameter is set then an abort sequence is
1352 * required. This sequence consists of the host activating the TX Abort
1353 * control line, and then waiting for the TX Abort command response. This
1354 * indicates that a the device is no longer in a transmit state, and that the
1355 * command FIFO has been cleared. The host must then deactivate the TX Abort
1356 * control line. Receiving is still allowed in this case.
1357 */
1358enum {
1359 TX_STATUS_SUCCESS = 0x01,
1360 TX_STATUS_DIRECT_DONE = 0x02,
1361 TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
1362 TX_STATUS_FAIL_LONG_LIMIT = 0x83,
1363 TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
1364 TX_STATUS_FAIL_MGMNT_ABORT = 0x85,
1365 TX_STATUS_FAIL_NEXT_FRAG = 0x86,
1366 TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
1367 TX_STATUS_FAIL_DEST_PS = 0x88,
1368 TX_STATUS_FAIL_ABORTED = 0x89,
1369 TX_STATUS_FAIL_BT_RETRY = 0x8a,
1370 TX_STATUS_FAIL_STA_INVALID = 0x8b,
1371 TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
1372 TX_STATUS_FAIL_TID_DISABLE = 0x8d,
1373 TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
1374 TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
1375 TX_STATUS_FAIL_TX_LOCKED = 0x90,
1376 TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
1377};
1378
1379#define TX_PACKET_MODE_REGULAR 0x0000
1380#define TX_PACKET_MODE_BURST_SEQ 0x0100
1381#define TX_PACKET_MODE_BURST_FIRST 0x0200
1382
1383enum {
1384 TX_POWER_PA_NOT_ACTIVE = 0x0,
1385};
1386
1387enum {
1388 TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */
1389 TX_STATUS_DELAY_MSK = 0x00000040,
1390 TX_STATUS_ABORT_MSK = 0x00000080,
1391 TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */
1392 TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */
1393 TX_RESERVED = 0x00780000, /* bits 19:22 */
1394 TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */
1395 TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */
1396};
1397
1398static inline int iwl_is_tx_success(u32 status)
1399{
1400 status &= TX_STATUS_MSK;
1401 return (status == TX_STATUS_SUCCESS)
1402 || (status == TX_STATUS_DIRECT_DONE);
1403}
1404
1405
1406
1407/* *******************************
1408 * TX aggregation status
1409 ******************************* */
1410
1411enum {
1412 AGG_TX_STATE_TRANSMITTED = 0x00,
1413 AGG_TX_STATE_UNDERRUN_MSK = 0x01,
1414 AGG_TX_STATE_BT_PRIO_MSK = 0x02,
1415 AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
1416 AGG_TX_STATE_ABORT_MSK = 0x08,
1417 AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
1418 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
1419 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
1420 AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
1421 AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
1422 AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
1423 AGG_TX_STATE_DUMP_TX_MSK = 0x200,
1424 AGG_TX_STATE_DELAY_TX_MSK = 0x400
1425};
1426
1427#define AGG_TX_STATE_LAST_SENT_MSK \
1428(AGG_TX_STATE_LAST_SENT_TTL_MSK | \
1429 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
1430 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
1431
1432/* # tx attempts for first frame in aggregation */
1433#define AGG_TX_STATE_TRY_CNT_POS 12
1434#define AGG_TX_STATE_TRY_CNT_MSK 0xf000
1435
1436/* Command ID and sequence number of Tx command for this frame */
1437#define AGG_TX_STATE_SEQ_NUM_POS 16
1438#define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
1439
1440/*
1441 * REPLY_TX = 0x1c (response)
1442 *
1443 * This response may be in one of two slightly different formats, indicated
1444 * by the frame_count field:
1445 *
1446 * 1) No aggregation (frame_count == 1). This reports Tx results for
1447 * a single frame. Multiple attempts, at various bit rates, may have
1448 * been made for this frame.
1449 *
1450 * 2) Aggregation (frame_count > 1). This reports Tx results for
1451 * 2 or more frames that used block-acknowledge. All frames were
1452 * transmitted at same rate. Rate scaling may have been used if first
1453 * frame in this new agg block failed in previous agg block(s).
1454 *
1455 * Note that, for aggregation, ACK (block-ack) status is not delivered here;
1456 * block-ack has not been received by the time the 4965 records this status.
1457 * This status relates to reasons the tx might have been blocked or aborted
1458 * within the sending station (this 4965), rather than whether it was
1459 * received successfully by the destination station.
1460 */
1461struct agg_tx_status {
1462 __le16 status;
1463 __le16 sequence;
1464} __attribute__ ((packed));
1465
1466struct iwl4965_tx_resp {
1467 u8 frame_count; /* 1 no aggregation, >1 aggregation */
1468 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
1469 u8 failure_rts; /* # failures due to unsuccessful RTS */
1470 u8 failure_frame; /* # failures due to no ACK (unused for agg) */
1471
1472 /* For non-agg: Rate at which frame was successful.
1473 * For agg: Rate at which all frames were transmitted. */
1474 __le32 rate_n_flags; /* RATE_MCS_* */
1475
1476 /* For non-agg: RTS + CTS + frame tx attempts time + ACK.
1477 * For agg: RTS + CTS + aggregation tx time + block-ack time. */
1478 __le16 wireless_media_time; /* uSecs */
1479
1480 __le16 reserved;
1481 __le32 pa_power1; /* RF power amplifier measurement (not used) */
1482 __le32 pa_power2;
1483
1484 /*
1485 * For non-agg: frame status TX_STATUS_*
1486 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1487 * fields follow this one, up to frame_count.
1488 * Bit fields:
1489 * 11- 0: AGG_TX_STATE_* status code
1490 * 15-12: Retry count for 1st frame in aggregation (retries
1491 * occur if tx failed for this frame when it was a
1492 * member of a previous aggregation block). If rate
1493 * scaling is used, retry count indicates the rate
1494 * table entry used for all frames in the new agg.
1495 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1496 */
1497 union {
1498 __le32 status;
1499 struct agg_tx_status agg_status[0]; /* for each agg frame */
1500 } u;
1501} __attribute__ ((packed));
1502
1503struct iwl5000_tx_resp {
1504 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
1517 __le16 reserved;
1518 __le32 pa_power1; /* RF power amplifier measurement (not used) */
1519 __le32 pa_power2;
1520
1521 __le32 tfd_info;
1522 __le16 seq_ctl;
1523 __le16 byte_cnt;
1524 __le32 tlc_info;
1525 /*
1526 * For non-agg: frame status TX_STATUS_*
1527 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1528 * fields follow this one, up to frame_count.
1529 * Bit fields:
1530 * 11- 0: AGG_TX_STATE_* status code
1531 * 15-12: Retry count for 1st frame in aggregation (retries
1532 * occur if tx failed for this frame when it was a
1533 * member of a previous aggregation block). If rate
1534 * scaling is used, retry count indicates the rate
1535 * table entry used for all frames in the new agg.
1536 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1537 */
1538 struct agg_tx_status status; /* TX status (in aggregation -
1539 * status of 1st frame) */
1540} __attribute__ ((packed));
1541/*
1542 * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
1543 *
1544 * Reports Block-Acknowledge from recipient station
1545 */
1546struct iwl_compressed_ba_resp {
1547 __le32 sta_addr_lo32;
1548 __le16 sta_addr_hi16;
1549 __le16 reserved;
1550
1551 /* Index of recipient (BA-sending) station in uCode's station table */
1552 u8 sta_id;
1553 u8 tid;
1554 __le16 seq_ctl;
1555 __le64 bitmap;
1556 __le16 scd_flow;
1557 __le16 scd_ssn;
1558} __attribute__ ((packed));
1559
1560/*
1561 * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
1562 *
1563 * See details under "TXPOWER" in iwl-4965-hw.h.
1564 */
1565struct iwl4965_txpowertable_cmd {
1566 u8 band; /* 0: 5 GHz, 1: 2.4 GHz */
1567 u8 reserved;
1568 __le16 channel;
1569 struct iwl4965_tx_power_db tx_power;
1570} __attribute__ ((packed));
1571
1572/*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
1573#define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0)
1574
1575/* # of EDCA prioritized tx fifos */
1576#define LINK_QUAL_AC_NUM AC_NUM
1577
1578/* # entries in rate scale table to support Tx retries */
1579#define LINK_QUAL_MAX_RETRY_NUM 16
1580
1581/* Tx antenna selection values */
1582#define LINK_QUAL_ANT_A_MSK (1 << 0)
1583#define LINK_QUAL_ANT_B_MSK (1 << 1)
1584#define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
1585
1586
1587/**
1588 * struct iwl_link_qual_general_params
1589 *
1590 * Used in REPLY_TX_LINK_QUALITY_CMD
1591 */
1592struct iwl_link_qual_general_params {
1593 u8 flags;
1594
1595 /* No entries at or above this (driver chosen) index contain MIMO */
1596 u8 mimo_delimiter;
1597
1598 /* Best single antenna to use for single stream (legacy, SISO). */
1599 u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */
1600
1601 /* Best antennas to use for MIMO (unused for 4965, assumes both). */
1602 u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */
1603
1604 /*
1605 * If driver needs to use different initial rates for different
1606 * EDCA QOS access categories (as implemented by tx fifos 0-3),
1607 * this table will set that up, by indicating the indexes in the
1608 * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
1609 * Otherwise, driver should set all entries to 0.
1610 *
1611 * Entry usage:
1612 * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
1613 * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
1614 */
1615 u8 start_rate_index[LINK_QUAL_AC_NUM];
1616} __attribute__ ((packed));
1617
1618/**
1619 * struct iwl_link_qual_agg_params
1620 *
1621 * Used in REPLY_TX_LINK_QUALITY_CMD
1622 */
1623struct iwl_link_qual_agg_params {
1624
1625 /* Maximum number of uSec in aggregation.
1626 * Driver should set this to 4000 (4 milliseconds). */
1627 __le16 agg_time_limit;
1628
1629 /*
1630 * Number of Tx retries allowed for a frame, before that frame will
1631 * no longer be considered for the start of an aggregation sequence
1632 * (scheduler will then try to tx it as single frame).
1633 * Driver should set this to 3.
1634 */
1635 u8 agg_dis_start_th;
1636
1637 /*
1638 * Maximum number of frames in aggregation.
1639 * 0 = no limit (default). 1 = no aggregation.
1640 * Other values = max # frames in aggregation.
1641 */
1642 u8 agg_frame_cnt_limit;
1643
1644 __le32 reserved;
1645} __attribute__ ((packed));
1646
1647/*
1648 * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
1649 *
1650 * For 4965 only; 3945 uses REPLY_RATE_SCALE.
1651 *
1652 * Each station in the 4965's internal station table has its own table of 16
1653 * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
1654 * an ACK is not received. This command replaces the entire table for
1655 * one station.
1656 *
1657 * NOTE: Station must already be in 4965's station table. Use REPLY_ADD_STA.
1658 *
1659 * The rate scaling procedures described below work well. Of course, other
1660 * procedures are possible, and may work better for particular environments.
1661 *
1662 *
1663 * FILLING THE RATE TABLE
1664 *
1665 * Given a particular initial rate and mode, as determined by the rate
1666 * scaling algorithm described below, the Linux driver uses the following
1667 * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
1668 * Link Quality command:
1669 *
1670 *
1671 * 1) If using High-throughput (HT) (SISO or MIMO) initial rate:
1672 * a) Use this same initial rate for first 3 entries.
1673 * b) Find next lower available rate using same mode (SISO or MIMO),
1674 * use for next 3 entries. If no lower rate available, switch to
1675 * legacy mode (no FAT channel, no MIMO, no short guard interval).
1676 * c) If using MIMO, set command's mimo_delimiter to number of entries
1677 * using MIMO (3 or 6).
1678 * d) After trying 2 HT rates, switch to legacy mode (no FAT channel,
1679 * no MIMO, no short guard interval), at the next lower bit rate
1680 * (e.g. if second HT bit rate was 54, try 48 legacy), and follow
1681 * legacy procedure for remaining table entries.
1682 *
1683 * 2) If using legacy initial rate:
1684 * a) Use the initial rate for only one entry.
1685 * b) For each following entry, reduce the rate to next lower available
1686 * rate, until reaching the lowest available rate.
1687 * c) When reducing rate, also switch antenna selection.
1688 * d) Once lowest available rate is reached, repeat this rate until
1689 * rate table is filled (16 entries), switching antenna each entry.
1690 *
1691 *
1692 * ACCUMULATING HISTORY
1693 *
1694 * The rate scaling algorithm for 4965, as implemented in Linux driver, uses
1695 * two sets of frame Tx success history: One for the current/active modulation
1696 * mode, and one for a speculative/search mode that is being attempted. If the
1697 * speculative mode turns out to be more effective (i.e. actual transfer
1698 * rate is better), then the driver continues to use the speculative mode
1699 * as the new current active mode.
1700 *
1701 * Each history set contains, separately for each possible rate, data for a
1702 * sliding window of the 62 most recent tx attempts at that rate. The data
1703 * includes a shifting bitmap of success(1)/failure(0), and sums of successful
1704 * and attempted frames, from which the driver can additionally calculate a
1705 * success ratio (success / attempted) and number of failures
1706 * (attempted - success), and control the size of the window (attempted).
1707 * The driver uses the bit map to remove successes from the success sum, as
1708 * the oldest tx attempts fall out of the window.
1709 *
1710 * When the 4965 makes multiple tx attempts for a given frame, each attempt
1711 * might be at a different rate, and have different modulation characteristics
1712 * (e.g. antenna, fat channel, short guard interval), as set up in the rate
1713 * scaling table in the Link Quality command. The driver must determine
1714 * which rate table entry was used for each tx attempt, to determine which
1715 * rate-specific history to update, and record only those attempts that
1716 * match the modulation characteristics of the history set.
1717 *
1718 * When using block-ack (aggregation), all frames are transmitted at the same
1719 * rate, since there is no per-attempt acknowledgement from the destination
1720 * station. The Tx response struct iwl_tx_resp indicates the Tx rate in
1721 * rate_n_flags field. After receiving a block-ack, the driver can update
1722 * history for the entire block all at once.
1723 *
1724 *
1725 * FINDING BEST STARTING RATE:
1726 *
1727 * When working with a selected initial modulation mode (see below), the
1728 * driver attempts to find a best initial rate. The initial rate is the
1729 * first entry in the Link Quality command's rate table.
1730 *
1731 * 1) Calculate actual throughput (success ratio * expected throughput, see
1732 * table below) for current initial rate. Do this only if enough frames
1733 * have been attempted to make the value meaningful: at least 6 failed
1734 * tx attempts, or at least 8 successes. If not enough, don't try rate
1735 * scaling yet.
1736 *
1737 * 2) Find available rates adjacent to current initial rate. Available means:
1738 * a) supported by hardware &&
1739 * b) supported by association &&
1740 * c) within any constraints selected by user
1741 *
1742 * 3) Gather measured throughputs for adjacent rates. These might not have
1743 * enough history to calculate a throughput. That's okay, we might try
1744 * using one of them anyway!
1745 *
1746 * 4) Try decreasing rate if, for current rate:
1747 * a) success ratio is < 15% ||
1748 * b) lower adjacent rate has better measured throughput ||
1749 * c) higher adjacent rate has worse throughput, and lower is unmeasured
1750 *
1751 * As a sanity check, if decrease was determined above, leave rate
1752 * unchanged if:
1753 * a) lower rate unavailable
1754 * b) success ratio at current rate > 85% (very good)
1755 * c) current measured throughput is better than expected throughput
1756 * of lower rate (under perfect 100% tx conditions, see table below)
1757 *
1758 * 5) Try increasing rate if, for current rate:
1759 * a) success ratio is < 15% ||
1760 * b) both adjacent rates' throughputs are unmeasured (try it!) ||
1761 * b) higher adjacent rate has better measured throughput ||
1762 * c) lower adjacent rate has worse throughput, and higher is unmeasured
1763 *
1764 * As a sanity check, if increase was determined above, leave rate
1765 * unchanged if:
1766 * a) success ratio at current rate < 70%. This is not particularly
1767 * good performance; higher rate is sure to have poorer success.
1768 *
1769 * 6) Re-evaluate the rate after each tx frame. If working with block-
1770 * acknowledge, history and statistics may be calculated for the entire
1771 * block (including prior history that fits within the history windows),
1772 * before re-evaluation.
1773 *
1774 * FINDING BEST STARTING MODULATION MODE:
1775 *
1776 * After working with a modulation mode for a "while" (and doing rate scaling),
1777 * the driver searches for a new initial mode in an attempt to improve
1778 * throughput. The "while" is measured by numbers of attempted frames:
1779 *
1780 * For legacy mode, search for new mode after:
1781 * 480 successful frames, or 160 failed frames
1782 * For high-throughput modes (SISO or MIMO), search for new mode after:
1783 * 4500 successful frames, or 400 failed frames
1784 *
1785 * Mode switch possibilities are (3 for each mode):
1786 *
1787 * For legacy:
1788 * Change antenna, try SISO (if HT association), try MIMO (if HT association)
1789 * For SISO:
1790 * Change antenna, try MIMO, try shortened guard interval (SGI)
1791 * For MIMO:
1792 * Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)
1793 *
1794 * When trying a new mode, use the same bit rate as the old/current mode when
1795 * trying antenna switches and shortened guard interval. When switching to
1796 * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate
1797 * for which the expected throughput (under perfect conditions) is about the
1798 * same or slightly better than the actual measured throughput delivered by
1799 * the old/current mode.
1800 *
1801 * Actual throughput can be estimated by multiplying the expected throughput
1802 * by the success ratio (successful / attempted tx frames). Frame size is
1803 * not considered in this calculation; it assumes that frame size will average
1804 * out to be fairly consistent over several samples. The following are
1805 * metric values for expected throughput assuming 100% success ratio.
1806 * Only G band has support for CCK rates:
1807 *
1808 * RATE: 1 2 5 11 6 9 12 18 24 36 48 54 60
1809 *
1810 * G: 7 13 35 58 40 57 72 98 121 154 177 186 186
1811 * A: 0 0 0 0 40 57 72 98 121 154 177 186 186
1812 * SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 202
1813 * SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 211
1814 * MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 251
1815 * SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 257
1816 * SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 257
1817 * SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 264
1818 * MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 289
1819 * SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 293
1820 *
1821 * After the new mode has been tried for a short while (minimum of 6 failed
1822 * frames or 8 successful frames), compare success ratio and actual throughput
1823 * estimate of the new mode with the old. If either is better with the new
1824 * mode, continue to use the new mode.
1825 *
1826 * Continue comparing modes until all 3 possibilities have been tried.
1827 * If moving from legacy to HT, try all 3 possibilities from the new HT
1828 * mode. After trying all 3, a best mode is found. Continue to use this mode
1829 * for the longer "while" described above (e.g. 480 successful frames for
1830 * legacy), and then repeat the search process.
1831 *
1832 */
1833struct iwl_link_quality_cmd {
1834
1835 /* Index of destination/recipient station in uCode's station table */
1836 u8 sta_id;
1837 u8 reserved1;
1838 __le16 control; /* not used */
1839 struct iwl_link_qual_general_params general_params;
1840 struct iwl_link_qual_agg_params agg_params;
1841
1842 /*
1843 * Rate info; when using rate-scaling, Tx command's initial_rate_index
1844 * specifies 1st Tx rate attempted, via index into this table.
1845 * 4965 works its way through table when retrying Tx.
1846 */
1847 struct {
1848 __le32 rate_n_flags; /* RATE_MCS_*, IWL_RATE_* */
1849 } rs_table[LINK_QUAL_MAX_RETRY_NUM];
1850 __le32 reserved2;
1851} __attribute__ ((packed));
1852
1853/*
1854 * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
1855 *
1856 * 3945 and 4965 support hardware handshake with Bluetooth device on
1857 * same platform. Bluetooth device alerts wireless device when it will Tx;
1858 * wireless device can delay or kill its own Tx to accomodate.
1859 */
1860struct iwl4965_bt_cmd {
1861 u8 flags;
1862 u8 lead_time;
1863 u8 max_kill;
1864 u8 reserved;
1865 __le32 kill_ack_mask;
1866 __le32 kill_cts_mask;
1867} __attribute__ ((packed));
1868
1869/******************************************************************************
1870 * (6)
1871 * Spectrum Management (802.11h) Commands, Responses, Notifications:
1872 *
1873 *****************************************************************************/
1874
1875/*
1876 * Spectrum Management
1877 */
1878#define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \
1879 RXON_FILTER_CTL2HOST_MSK | \
1880 RXON_FILTER_ACCEPT_GRP_MSK | \
1881 RXON_FILTER_DIS_DECRYPT_MSK | \
1882 RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
1883 RXON_FILTER_ASSOC_MSK | \
1884 RXON_FILTER_BCON_AWARE_MSK)
1885
1886struct iwl4965_measure_channel {
1887 __le32 duration; /* measurement duration in extended beacon
1888 * format */
1889 u8 channel; /* channel to measure */
1890 u8 type; /* see enum iwl4965_measure_type */
1891 __le16 reserved;
1892} __attribute__ ((packed));
1893
1894/*
1895 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
1896 */
1897struct iwl4965_spectrum_cmd {
1898 __le16 len; /* number of bytes starting from token */
1899 u8 token; /* token id */
1900 u8 id; /* measurement id -- 0 or 1 */
1901 u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */
1902 u8 periodic; /* 1 = periodic */
1903 __le16 path_loss_timeout;
1904 __le32 start_time; /* start time in extended beacon format */
1905 __le32 reserved2;
1906 __le32 flags; /* rxon flags */
1907 __le32 filter_flags; /* rxon filter flags */
1908 __le16 channel_count; /* minimum 1, maximum 10 */
1909 __le16 reserved3;
1910 struct iwl4965_measure_channel channels[10];
1911} __attribute__ ((packed));
1912
1913/*
1914 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
1915 */
1916struct iwl4965_spectrum_resp {
1917 u8 token;
1918 u8 id; /* id of the prior command replaced, or 0xff */
1919 __le16 status; /* 0 - command will be handled
1920 * 1 - cannot handle (conflicts with another
1921 * measurement) */
1922} __attribute__ ((packed));
1923
1924enum iwl4965_measurement_state {
1925 IWL_MEASUREMENT_START = 0,
1926 IWL_MEASUREMENT_STOP = 1,
1927};
1928
1929enum iwl4965_measurement_status {
1930 IWL_MEASUREMENT_OK = 0,
1931 IWL_MEASUREMENT_CONCURRENT = 1,
1932 IWL_MEASUREMENT_CSA_CONFLICT = 2,
1933 IWL_MEASUREMENT_TGH_CONFLICT = 3,
1934 /* 4-5 reserved */
1935 IWL_MEASUREMENT_STOPPED = 6,
1936 IWL_MEASUREMENT_TIMEOUT = 7,
1937 IWL_MEASUREMENT_PERIODIC_FAILED = 8,
1938};
1939
1940#define NUM_ELEMENTS_IN_HISTOGRAM 8
1941
1942struct iwl4965_measurement_histogram {
1943 __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
1944 __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */
1945} __attribute__ ((packed));
1946
1947/* clear channel availability counters */
1948struct iwl4965_measurement_cca_counters {
1949 __le32 ofdm;
1950 __le32 cck;
1951} __attribute__ ((packed));
1952
1953enum iwl4965_measure_type {
1954 IWL_MEASURE_BASIC = (1 << 0),
1955 IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
1956 IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
1957 IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
1958 IWL_MEASURE_FRAME = (1 << 4),
1959 /* bits 5:6 are reserved */
1960 IWL_MEASURE_IDLE = (1 << 7),
1961};
1962
1963/*
1964 * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
1965 */
1966struct iwl4965_spectrum_notification {
1967 u8 id; /* measurement id -- 0 or 1 */
1968 u8 token;
1969 u8 channel_index; /* index in measurement channel list */
1970 u8 state; /* 0 - start, 1 - stop */
1971 __le32 start_time; /* lower 32-bits of TSF */
1972 u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */
1973 u8 channel;
1974 u8 type; /* see enum iwl4965_measurement_type */
1975 u8 reserved1;
1976 /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only
1977 * valid if applicable for measurement type requested. */
1978 __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */
1979 __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */
1980 __le32 cca_time; /* channel load time in usecs */
1981 u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 -
1982 * unidentified */
1983 u8 reserved2[3];
1984 struct iwl4965_measurement_histogram histogram;
1985 __le32 stop_time; /* lower 32-bits of TSF */
1986 __le32 status; /* see iwl4965_measurement_status */
1987} __attribute__ ((packed));
1988
1989/******************************************************************************
1990 * (7)
1991 * Power Management Commands, Responses, Notifications:
1992 *
1993 *****************************************************************************/
1994
1995/**
1996 * struct iwl4965_powertable_cmd - Power Table Command
1997 * @flags: See below:
1998 *
1999 * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
2000 *
2001 * PM allow:
2002 * bit 0 - '0' Driver not allow power management
2003 * '1' Driver allow PM (use rest of parameters)
2004 * uCode send sleep notifications:
2005 * bit 1 - '0' Don't send sleep notification
2006 * '1' send sleep notification (SEND_PM_NOTIFICATION)
2007 * Sleep over DTIM
2008 * bit 2 - '0' PM have to walk up every DTIM
2009 * '1' PM could sleep over DTIM till listen Interval.
2010 * PCI power managed
2011 * bit 3 - '0' (PCI_LINK_CTRL & 0x1)
2012 * '1' !(PCI_LINK_CTRL & 0x1)
2013 * Force sleep Modes
2014 * bit 31/30- '00' use both mac/xtal sleeps
2015 * '01' force Mac sleep
2016 * '10' force xtal sleep
2017 * '11' Illegal set
2018 *
2019 * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
2020 * ucode assume sleep over DTIM is allowed and we don't need to wakeup
2021 * for every DTIM.
2022 */
2023#define IWL_POWER_VEC_SIZE 5
2024
2025#define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK __constant_cpu_to_le16(1 << 0)
2026#define IWL_POWER_SLEEP_OVER_DTIM_MSK __constant_cpu_to_le16(1 << 2)
2027#define IWL_POWER_PCI_PM_MSK __constant_cpu_to_le16(1 << 3)
2028#define IWL_POWER_FAST_PD __constant_cpu_to_le16(1 << 4)
2029
2030struct iwl4965_powertable_cmd {
2031 __le16 flags;
2032 u8 keep_alive_seconds;
2033 u8 debug_flags;
2034 __le32 rx_data_timeout;
2035 __le32 tx_data_timeout;
2036 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
2037 __le32 keep_alive_beacons;
2038} __attribute__ ((packed));
2039
2040/*
2041 * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
2042 * 3945 and 4965 identical.
2043 */
2044struct iwl4965_sleep_notification {
2045 u8 pm_sleep_mode;
2046 u8 pm_wakeup_src;
2047 __le16 reserved;
2048 __le32 sleep_time;
2049 __le32 tsf_low;
2050 __le32 bcon_timer;
2051} __attribute__ ((packed));
2052
2053/* Sleep states. 3945 and 4965 identical. */
2054enum {
2055 IWL_PM_NO_SLEEP = 0,
2056 IWL_PM_SLP_MAC = 1,
2057 IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
2058 IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
2059 IWL_PM_SLP_PHY = 4,
2060 IWL_PM_SLP_REPENT = 5,
2061 IWL_PM_WAKEUP_BY_TIMER = 6,
2062 IWL_PM_WAKEUP_BY_DRIVER = 7,
2063 IWL_PM_WAKEUP_BY_RFKILL = 8,
2064 /* 3 reserved */
2065 IWL_PM_NUM_OF_MODES = 12,
2066};
2067
2068/*
2069 * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
2070 */
2071#define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */
2072#define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */
2073#define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */
2074struct iwl4965_card_state_cmd {
2075 __le32 status; /* CARD_STATE_CMD_* request new power state */
2076} __attribute__ ((packed));
2077
2078/*
2079 * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
2080 */
2081struct iwl4965_card_state_notif {
2082 __le32 flags;
2083} __attribute__ ((packed));
2084
2085#define HW_CARD_DISABLED 0x01
2086#define SW_CARD_DISABLED 0x02
2087#define RF_CARD_DISABLED 0x04
2088#define RXON_CARD_DISABLED 0x10
2089
2090struct iwl_ct_kill_config {
2091 __le32 reserved;
2092 __le32 critical_temperature_M;
2093 __le32 critical_temperature_R;
2094} __attribute__ ((packed));
2095
2096/******************************************************************************
2097 * (8)
2098 * Scan Commands, Responses, Notifications:
2099 *
2100 *****************************************************************************/
2101
2102#define SCAN_CHANNEL_TYPE_PASSIVE __constant_cpu_to_le32(0)
2103#define SCAN_CHANNEL_TYPE_ACTIVE __constant_cpu_to_le32(1)
2104
2105/**
2106 * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table
2107 *
2108 * One for each channel in the scan list.
2109 * Each channel can independently select:
2110 * 1) SSID for directed active scans
2111 * 2) Txpower setting (for rate specified within Tx command)
2112 * 3) How long to stay on-channel (behavior may be modified by quiet_time,
2113 * quiet_plcp_th, good_CRC_th)
2114 *
2115 * To avoid uCode errors, make sure the following are true (see comments
2116 * under struct iwl_scan_cmd about max_out_time and quiet_time):
2117 * 1) If using passive_dwell (i.e. passive_dwell != 0):
2118 * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
2119 * 2) quiet_time <= active_dwell
2120 * 3) If restricting off-channel time (i.e. max_out_time !=0):
2121 * passive_dwell < max_out_time
2122 * active_dwell < max_out_time
2123 */
2124struct iwl_scan_channel {
2125 /*
2126 * type is defined as:
2127 * 0:0 1 = active, 0 = passive
2128 * 1:20 SSID direct bit map; if a bit is set, then corresponding
2129 * SSID IE is transmitted in probe request.
2130 * 21:31 reserved
2131 */
2132 __le32 type;
2133 __le16 channel; /* band is selected by iwl_scan_cmd "flags" field */
2134 u8 tx_gain; /* gain for analog radio */
2135 u8 dsp_atten; /* gain for DSP */
2136 __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */
2137 __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */
2138} __attribute__ ((packed));
2139
2140/**
2141 * struct iwl_ssid_ie - directed scan network information element
2142 *
2143 * Up to 4 of these may appear in REPLY_SCAN_CMD, selected by "type" field
2144 * in struct iwl4965_scan_channel; each channel may select different ssids from
2145 * among the 4 entries. SSID IEs get transmitted in reverse order of entry.
2146 */
2147struct iwl_ssid_ie {
2148 u8 id;
2149 u8 len;
2150 u8 ssid[32];
2151} __attribute__ ((packed));
2152
2153#define PROBE_OPTION_MAX 0x14
2154#define TX_CMD_LIFE_TIME_INFINITE __constant_cpu_to_le32(0xFFFFFFFF)
2155#define IWL_GOOD_CRC_TH __constant_cpu_to_le16(1)
2156#define IWL_MAX_SCAN_SIZE 1024
2157
2158/*
2159 * REPLY_SCAN_CMD = 0x80 (command)
2160 *
2161 * The hardware scan command is very powerful; the driver can set it up to
2162 * maintain (relatively) normal network traffic while doing a scan in the
2163 * background. The max_out_time and suspend_time control the ratio of how
2164 * long the device stays on an associated network channel ("service channel")
2165 * vs. how long it's away from the service channel, i.e. tuned to other channels
2166 * for scanning.
2167 *
2168 * max_out_time is the max time off-channel (in usec), and suspend_time
2169 * is how long (in "extended beacon" format) that the scan is "suspended"
2170 * after returning to the service channel. That is, suspend_time is the
2171 * time that we stay on the service channel, doing normal work, between
2172 * scan segments. The driver may set these parameters differently to support
2173 * scanning when associated vs. not associated, and light vs. heavy traffic
2174 * loads when associated.
2175 *
2176 * After receiving this command, the device's scan engine does the following;
2177 *
2178 * 1) Sends SCAN_START notification to driver
2179 * 2) Checks to see if it has time to do scan for one channel
2180 * 3) Sends NULL packet, with power-save (PS) bit set to 1,
2181 * to tell AP that we're going off-channel
2182 * 4) Tunes to first channel in scan list, does active or passive scan
2183 * 5) Sends SCAN_RESULT notification to driver
2184 * 6) Checks to see if it has time to do scan on *next* channel in list
2185 * 7) Repeats 4-6 until it no longer has time to scan the next channel
2186 * before max_out_time expires
2187 * 8) Returns to service channel
2188 * 9) Sends NULL packet with PS=0 to tell AP that we're back
2189 * 10) Stays on service channel until suspend_time expires
2190 * 11) Repeats entire process 2-10 until list is complete
2191 * 12) Sends SCAN_COMPLETE notification
2192 *
2193 * For fast, efficient scans, the scan command also has support for staying on
2194 * a channel for just a short time, if doing active scanning and getting no
2195 * responses to the transmitted probe request. This time is controlled by
2196 * quiet_time, and the number of received packets below which a channel is
2197 * considered "quiet" is controlled by quiet_plcp_threshold.
2198 *
2199 * For active scanning on channels that have regulatory restrictions against
2200 * blindly transmitting, the scan can listen before transmitting, to make sure
2201 * that there is already legitimate activity on the channel. If enough
2202 * packets are cleanly received on the channel (controlled by good_CRC_th,
2203 * typical value 1), the scan engine starts transmitting probe requests.
2204 *
2205 * Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
2206 *
2207 * To avoid uCode errors, see timing restrictions described under
2208 * struct iwl_scan_channel.
2209 */
2210struct iwl_scan_cmd {
2211 __le16 len;
2212 u8 reserved0;
2213 u8 channel_count; /* # channels in channel list */
2214 __le16 quiet_time; /* dwell only this # millisecs on quiet channel
2215 * (only for active scan) */
2216 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
2217 __le16 good_CRC_th; /* passive -> active promotion threshold */
2218 __le16 rx_chain; /* RXON_RX_CHAIN_* */
2219 __le32 max_out_time; /* max usec to be away from associated (service)
2220 * channel */
2221 __le32 suspend_time; /* pause scan this long (in "extended beacon
2222 * format") when returning to service chnl:
2223 * 3945; 31:24 # beacons, 19:0 additional usec,
2224 * 4965; 31:22 # beacons, 21:0 additional usec.
2225 */
2226 __le32 flags; /* RXON_FLG_* */
2227 __le32 filter_flags; /* RXON_FILTER_* */
2228
2229 /* For active scans (set to all-0s for passive scans).
2230 * Does not include payload. Must specify Tx rate; no rate scaling. */
2231 struct iwl_tx_cmd tx_cmd;
2232
2233 /* For directed active scans (set to all-0s otherwise) */
2234 struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
2235
2236 /*
2237 * Probe request frame, followed by channel list.
2238 *
2239 * Size of probe request frame is specified by byte count in tx_cmd.
2240 * Channel list follows immediately after probe request frame.
2241 * Number of channels in list is specified by channel_count.
2242 * Each channel in list is of type:
2243 *
2244 * struct iwl4965_scan_channel channels[0];
2245 *
2246 * NOTE: Only one band of channels can be scanned per pass. You
2247 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
2248 * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
2249 * before requesting another scan.
2250 */
2251 u8 data[0];
2252} __attribute__ ((packed));
2253
2254/* Can abort will notify by complete notification with abort status. */
2255#define CAN_ABORT_STATUS __constant_cpu_to_le32(0x1)
2256/* complete notification statuses */
2257#define ABORT_STATUS 0x2
2258
2259/*
2260 * REPLY_SCAN_CMD = 0x80 (response)
2261 */
2262struct iwl_scanreq_notification {
2263 __le32 status; /* 1: okay, 2: cannot fulfill request */
2264} __attribute__ ((packed));
2265
2266/*
2267 * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
2268 */
2269struct iwl_scanstart_notification {
2270 __le32 tsf_low;
2271 __le32 tsf_high;
2272 __le32 beacon_timer;
2273 u8 channel;
2274 u8 band;
2275 u8 reserved[2];
2276 __le32 status;
2277} __attribute__ ((packed));
2278
2279#define SCAN_OWNER_STATUS 0x1;
2280#define MEASURE_OWNER_STATUS 0x2;
2281
2282#define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */
2283/*
2284 * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
2285 */
2286struct iwl_scanresults_notification {
2287 u8 channel;
2288 u8 band;
2289 u8 reserved[2];
2290 __le32 tsf_low;
2291 __le32 tsf_high;
2292 __le32 statistics[NUMBER_OF_STATISTICS];
2293} __attribute__ ((packed));
2294
2295/*
2296 * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
2297 */
2298struct iwl_scancomplete_notification {
2299 u8 scanned_channels;
2300 u8 status;
2301 u8 reserved;
2302 u8 last_channel;
2303 __le32 tsf_low;
2304 __le32 tsf_high;
2305} __attribute__ ((packed));
2306
2307
2308/******************************************************************************
2309 * (9)
2310 * IBSS/AP Commands and Notifications:
2311 *
2312 *****************************************************************************/
2313
2314/*
2315 * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
2316 */
2317struct iwl4965_beacon_notif {
2318 struct iwl4965_tx_resp beacon_notify_hdr;
2319 __le32 low_tsf;
2320 __le32 high_tsf;
2321 __le32 ibss_mgr_status;
2322} __attribute__ ((packed));
2323
2324/*
2325 * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
2326 */
2327struct iwl4965_tx_beacon_cmd {
2328 struct iwl_tx_cmd tx;
2329 __le16 tim_idx;
2330 u8 tim_size;
2331 u8 reserved1;
2332 struct ieee80211_hdr frame[0]; /* beacon frame */
2333} __attribute__ ((packed));
2334
2335/******************************************************************************
2336 * (10)
2337 * Statistics Commands and Notifications:
2338 *
2339 *****************************************************************************/
2340
2341#define IWL_TEMP_CONVERT 260
2342
2343#define SUP_RATE_11A_MAX_NUM_CHANNELS 8
2344#define SUP_RATE_11B_MAX_NUM_CHANNELS 4
2345#define SUP_RATE_11G_MAX_NUM_CHANNELS 12
2346
2347/* Used for passing to driver number of successes and failures per rate */
2348struct rate_histogram {
2349 union {
2350 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2351 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2352 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2353 } success;
2354 union {
2355 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2356 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2357 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2358 } failed;
2359} __attribute__ ((packed));
2360
2361/* statistics command response */
2362
2363struct statistics_rx_phy {
2364 __le32 ina_cnt;
2365 __le32 fina_cnt;
2366 __le32 plcp_err;
2367 __le32 crc32_err;
2368 __le32 overrun_err;
2369 __le32 early_overrun_err;
2370 __le32 crc32_good;
2371 __le32 false_alarm_cnt;
2372 __le32 fina_sync_err_cnt;
2373 __le32 sfd_timeout;
2374 __le32 fina_timeout;
2375 __le32 unresponded_rts;
2376 __le32 rxe_frame_limit_overrun;
2377 __le32 sent_ack_cnt;
2378 __le32 sent_cts_cnt;
2379 __le32 sent_ba_rsp_cnt;
2380 __le32 dsp_self_kill;
2381 __le32 mh_format_err;
2382 __le32 re_acq_main_rssi_sum;
2383 __le32 reserved3;
2384} __attribute__ ((packed));
2385
2386struct statistics_rx_ht_phy {
2387 __le32 plcp_err;
2388 __le32 overrun_err;
2389 __le32 early_overrun_err;
2390 __le32 crc32_good;
2391 __le32 crc32_err;
2392 __le32 mh_format_err;
2393 __le32 agg_crc32_good;
2394 __le32 agg_mpdu_cnt;
2395 __le32 agg_cnt;
2396 __le32 reserved2;
2397} __attribute__ ((packed));
2398
2399struct statistics_rx_non_phy {
2400 __le32 bogus_cts; /* CTS received when not expecting CTS */
2401 __le32 bogus_ack; /* ACK received when not expecting ACK */
2402 __le32 non_bssid_frames; /* number of frames with BSSID that
2403 * doesn't belong to the STA BSSID */
2404 __le32 filtered_frames; /* count frames that were dumped in the
2405 * filtering process */
2406 __le32 non_channel_beacons; /* beacons with our bss id but not on
2407 * our serving channel */
2408 __le32 channel_beacons; /* beacons with our bss id and in our
2409 * serving channel */
2410 __le32 num_missed_bcon; /* number of missed beacons */
2411 __le32 adc_rx_saturation_time; /* count in 0.8us units the time the
2412 * ADC was in saturation */
2413 __le32 ina_detection_search_time;/* total time (in 0.8us) searched
2414 * for INA */
2415 __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */
2416 __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */
2417 __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */
2418 __le32 interference_data_flag; /* flag for interference data
2419 * availability. 1 when data is
2420 * available. */
2421 __le32 channel_load; /* counts RX Enable time in uSec */
2422 __le32 dsp_false_alarms; /* DSP false alarm (both OFDM
2423 * and CCK) counter */
2424 __le32 beacon_rssi_a;
2425 __le32 beacon_rssi_b;
2426 __le32 beacon_rssi_c;
2427 __le32 beacon_energy_a;
2428 __le32 beacon_energy_b;
2429 __le32 beacon_energy_c;
2430} __attribute__ ((packed));
2431
2432struct statistics_rx {
2433 struct statistics_rx_phy ofdm;
2434 struct statistics_rx_phy cck;
2435 struct statistics_rx_non_phy general;
2436 struct statistics_rx_ht_phy ofdm_ht;
2437} __attribute__ ((packed));
2438
2439struct statistics_tx_non_phy_agg {
2440 __le32 ba_timeout;
2441 __le32 ba_reschedule_frames;
2442 __le32 scd_query_agg_frame_cnt;
2443 __le32 scd_query_no_agg;
2444 __le32 scd_query_agg;
2445 __le32 scd_query_mismatch;
2446 __le32 frame_not_ready;
2447 __le32 underrun;
2448 __le32 bt_prio_kill;
2449 __le32 rx_ba_rsp_cnt;
2450 __le32 reserved2;
2451 __le32 reserved3;
2452} __attribute__ ((packed));
2453
2454struct statistics_tx {
2455 __le32 preamble_cnt;
2456 __le32 rx_detected_cnt;
2457 __le32 bt_prio_defer_cnt;
2458 __le32 bt_prio_kill_cnt;
2459 __le32 few_bytes_cnt;
2460 __le32 cts_timeout;
2461 __le32 ack_timeout;
2462 __le32 expected_ack_cnt;
2463 __le32 actual_ack_cnt;
2464 __le32 dump_msdu_cnt;
2465 __le32 burst_abort_next_frame_mismatch_cnt;
2466 __le32 burst_abort_missing_next_frame_cnt;
2467 __le32 cts_timeout_collision;
2468 __le32 ack_or_ba_timeout_collision;
2469 struct statistics_tx_non_phy_agg agg;
2470} __attribute__ ((packed));
2471
2472struct statistics_dbg {
2473 __le32 burst_check;
2474 __le32 burst_count;
2475 __le32 reserved[4];
2476} __attribute__ ((packed));
2477
2478struct statistics_div {
2479 __le32 tx_on_a;
2480 __le32 tx_on_b;
2481 __le32 exec_time;
2482 __le32 probe_time;
2483 __le32 reserved1;
2484 __le32 reserved2;
2485} __attribute__ ((packed));
2486
2487struct statistics_general {
2488 __le32 temperature;
2489 __le32 temperature_m;
2490 struct statistics_dbg dbg;
2491 __le32 sleep_time;
2492 __le32 slots_out;
2493 __le32 slots_idle;
2494 __le32 ttl_timestamp;
2495 struct statistics_div div;
2496 __le32 rx_enable_counter;
2497 __le32 reserved1;
2498 __le32 reserved2;
2499 __le32 reserved3;
2500} __attribute__ ((packed));
2501
2502/*
2503 * REPLY_STATISTICS_CMD = 0x9c,
2504 * 3945 and 4965 identical.
2505 *
2506 * This command triggers an immediate response containing uCode statistics.
2507 * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
2508 *
2509 * If the CLEAR_STATS configuration flag is set, uCode will clear its
2510 * internal copy of the statistics (counters) after issuing the response.
2511 * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
2512 *
2513 * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
2514 * STATISTICS_NOTIFICATIONs after received beacons (see below). This flag
2515 * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
2516 */
2517#define IWL_STATS_CONF_CLEAR_STATS __constant_cpu_to_le32(0x1) /* see above */
2518#define IWL_STATS_CONF_DISABLE_NOTIF __constant_cpu_to_le32(0x2)/* see above */
2519struct iwl_statistics_cmd {
2520 __le32 configuration_flags; /* IWL_STATS_CONF_* */
2521} __attribute__ ((packed));
2522
2523/*
2524 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
2525 *
2526 * By default, uCode issues this notification after receiving a beacon
2527 * while associated. To disable this behavior, set DISABLE_NOTIF flag in the
2528 * REPLY_STATISTICS_CMD 0x9c, above.
2529 *
2530 * Statistics counters continue to increment beacon after beacon, but are
2531 * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
2532 * 0x9c with CLEAR_STATS bit set (see above).
2533 *
2534 * uCode also issues this notification during scans. uCode clears statistics
2535 * appropriately so that each notification contains statistics for only the
2536 * one channel that has just been scanned.
2537 */
2538#define STATISTICS_REPLY_FLG_BAND_24G_MSK __constant_cpu_to_le32(0x2)
2539#define STATISTICS_REPLY_FLG_FAT_MODE_MSK __constant_cpu_to_le32(0x8)
2540struct iwl_notif_statistics {
2541 __le32 flag;
2542 struct statistics_rx rx;
2543 struct statistics_tx tx;
2544 struct statistics_general general;
2545} __attribute__ ((packed));
2546
2547
2548/*
2549 * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
2550 */
2551/* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row,
2552 * then this notification will be sent. */
2553#define CONSECUTIVE_MISSED_BCONS_TH 20
2554
2555struct iwl4965_missed_beacon_notif {
2556 __le32 consequtive_missed_beacons;
2557 __le32 total_missed_becons;
2558 __le32 num_expected_beacons;
2559 __le32 num_recvd_beacons;
2560} __attribute__ ((packed));
2561
2562
2563/******************************************************************************
2564 * (11)
2565 * Rx Calibration Commands:
2566 *
2567 * With the uCode used for open source drivers, most Tx calibration (except
2568 * for Tx Power) and most Rx calibration is done by uCode during the
2569 * "initialize" phase of uCode boot. Driver must calibrate only:
2570 *
2571 * 1) Tx power (depends on temperature), described elsewhere
2572 * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas)
2573 * 3) Receiver sensitivity (to optimize signal detection)
2574 *
2575 *****************************************************************************/
2576
2577/**
2578 * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
2579 *
2580 * This command sets up the Rx signal detector for a sensitivity level that
2581 * is high enough to lock onto all signals within the associated network,
2582 * but low enough to ignore signals that are below a certain threshold, so as
2583 * not to have too many "false alarms". False alarms are signals that the
2584 * Rx DSP tries to lock onto, but then discards after determining that they
2585 * are noise.
2586 *
2587 * The optimum number of false alarms is between 5 and 50 per 200 TUs
2588 * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
2589 * time listening, not transmitting). Driver must adjust sensitivity so that
2590 * the ratio of actual false alarms to actual Rx time falls within this range.
2591 *
2592 * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
2593 * received beacon. These provide information to the driver to analyze the
2594 * sensitivity. Don't analyze statistics that come in from scanning, or any
2595 * other non-associated-network source. Pertinent statistics include:
2596 *
2597 * From "general" statistics (struct statistics_rx_non_phy):
2598 *
2599 * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
2600 * Measure of energy of desired signal. Used for establishing a level
2601 * below which the device does not detect signals.
2602 *
2603 * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
2604 * Measure of background noise in silent period after beacon.
2605 *
2606 * channel_load
2607 * uSecs of actual Rx time during beacon period (varies according to
2608 * how much time was spent transmitting).
2609 *
2610 * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
2611 *
2612 * false_alarm_cnt
2613 * Signal locks abandoned early (before phy-level header).
2614 *
2615 * plcp_err
2616 * Signal locks abandoned late (during phy-level header).
2617 *
2618 * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from
2619 * beacon to beacon, i.e. each value is an accumulation of all errors
2620 * before and including the latest beacon. Values will wrap around to 0
2621 * after counting up to 2^32 - 1. Driver must differentiate vs.
2622 * previous beacon's values to determine # false alarms in the current
2623 * beacon period.
2624 *
2625 * Total number of false alarms = false_alarms + plcp_errs
2626 *
2627 * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
2628 * (notice that the start points for OFDM are at or close to settings for
2629 * maximum sensitivity):
2630 *
2631 * START / MIN / MAX
2632 * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120
2633 * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210
2634 * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140
2635 * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270
2636 *
2637 * If actual rate of OFDM false alarms (+ plcp_errors) is too high
2638 * (greater than 50 for each 204.8 msecs listening), reduce sensitivity
2639 * by *adding* 1 to all 4 of the table entries above, up to the max for
2640 * each entry. Conversely, if false alarm rate is too low (less than 5
2641 * for each 204.8 msecs listening), *subtract* 1 from each entry to
2642 * increase sensitivity.
2643 *
2644 * For CCK sensitivity, keep track of the following:
2645 *
2646 * 1). 20-beacon history of maximum background noise, indicated by
2647 * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
2648 * 3 receivers. For any given beacon, the "silence reference" is
2649 * the maximum of last 60 samples (20 beacons * 3 receivers).
2650 *
2651 * 2). 10-beacon history of strongest signal level, as indicated
2652 * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
2653 * i.e. the strength of the signal through the best receiver at the
2654 * moment. These measurements are "upside down", with lower values
2655 * for stronger signals, so max energy will be *minimum* value.
2656 *
2657 * Then for any given beacon, the driver must determine the *weakest*
2658 * of the strongest signals; this is the minimum level that needs to be
2659 * successfully detected, when using the best receiver at the moment.
2660 * "Max cck energy" is the maximum (higher value means lower energy!)
2661 * of the last 10 minima. Once this is determined, driver must add
2662 * a little margin by adding "6" to it.
2663 *
2664 * 3). Number of consecutive beacon periods with too few false alarms.
2665 * Reset this to 0 at the first beacon period that falls within the
2666 * "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
2667 *
2668 * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
2669 * (notice that the start points for CCK are at maximum sensitivity):
2670 *
2671 * START / MIN / MAX
2672 * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200
2673 * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400
2674 * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100
2675 *
2676 * If actual rate of CCK false alarms (+ plcp_errors) is too high
2677 * (greater than 50 for each 204.8 msecs listening), method for reducing
2678 * sensitivity is:
2679 *
2680 * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2681 * up to max 400.
2682 *
2683 * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
2684 * sensitivity has been reduced a significant amount; bring it up to
2685 * a moderate 161. Otherwise, *add* 3, up to max 200.
2686 *
2687 * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
2688 * sensitivity has been reduced only a moderate or small amount;
2689 * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
2690 * down to min 0. Otherwise (if gain has been significantly reduced),
2691 * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
2692 *
2693 * b) Save a snapshot of the "silence reference".
2694 *
2695 * If actual rate of CCK false alarms (+ plcp_errors) is too low
2696 * (less than 5 for each 204.8 msecs listening), method for increasing
2697 * sensitivity is used only if:
2698 *
2699 * 1a) Previous beacon did not have too many false alarms
2700 * 1b) AND difference between previous "silence reference" and current
2701 * "silence reference" (prev - current) is 2 or more,
2702 * OR 2) 100 or more consecutive beacon periods have had rate of
2703 * less than 5 false alarms per 204.8 milliseconds rx time.
2704 *
2705 * Method for increasing sensitivity:
2706 *
2707 * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
2708 * down to min 125.
2709 *
2710 * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2711 * down to min 200.
2712 *
2713 * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
2714 *
2715 * If actual rate of CCK false alarms (+ plcp_errors) is within good range
2716 * (between 5 and 50 for each 204.8 msecs listening):
2717 *
2718 * 1) Save a snapshot of the silence reference.
2719 *
2720 * 2) If previous beacon had too many CCK false alarms (+ plcp_errors),
2721 * give some extra margin to energy threshold by *subtracting* 8
2722 * from value in HD_MIN_ENERGY_CCK_DET_INDEX.
2723 *
2724 * For all cases (too few, too many, good range), make sure that the CCK
2725 * detection threshold (energy) is below the energy level for robust
2726 * detection over the past 10 beacon periods, the "Max cck energy".
2727 * Lower values mean higher energy; this means making sure that the value
2728 * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
2729 *
2730 * Driver should set the following entries to fixed values:
2731 *
2732 * HD_MIN_ENERGY_OFDM_DET_INDEX 100
2733 * HD_BARKER_CORR_TH_ADD_MIN_INDEX 190
2734 * HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX 390
2735 * HD_OFDM_ENERGY_TH_IN_INDEX 62
2736 */
2737
2738/*
2739 * Table entries in SENSITIVITY_CMD (struct iwl_sensitivity_cmd)
2740 */
2741#define HD_TABLE_SIZE (11) /* number of entries */
2742#define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */
2743#define HD_MIN_ENERGY_OFDM_DET_INDEX (1)
2744#define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2)
2745#define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3)
2746#define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4)
2747#define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5)
2748#define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6)
2749#define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7)
2750#define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8)
2751#define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9)
2752#define HD_OFDM_ENERGY_TH_IN_INDEX (10)
2753
2754/* Control field in struct iwl_sensitivity_cmd */
2755#define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE __constant_cpu_to_le16(0)
2756#define SENSITIVITY_CMD_CONTROL_WORK_TABLE __constant_cpu_to_le16(1)
2757
2758/**
2759 * struct iwl_sensitivity_cmd
2760 * @control: (1) updates working table, (0) updates default table
2761 * @table: energy threshold values, use HD_* as index into table
2762 *
2763 * Always use "1" in "control" to update uCode's working table and DSP.
2764 */
2765struct iwl_sensitivity_cmd {
2766 __le16 control; /* always use "1" */
2767 __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */
2768} __attribute__ ((packed));
2769
2770
2771/**
2772 * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
2773 *
2774 * This command sets the relative gains of 4965's 3 radio receiver chains.
2775 *
2776 * After the first association, driver should accumulate signal and noise
2777 * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
2778 * beacons from the associated network (don't collect statistics that come
2779 * in from scanning, or any other non-network source).
2780 *
2781 * DISCONNECTED ANTENNA:
2782 *
2783 * Driver should determine which antennas are actually connected, by comparing
2784 * average beacon signal levels for the 3 Rx chains. Accumulate (add) the
2785 * following values over 20 beacons, one accumulator for each of the chains
2786 * a/b/c, from struct statistics_rx_non_phy:
2787 *
2788 * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
2789 *
2790 * Find the strongest signal from among a/b/c. Compare the other two to the
2791 * strongest. If any signal is more than 15 dB (times 20, unless you
2792 * divide the accumulated values by 20) below the strongest, the driver
2793 * considers that antenna to be disconnected, and should not try to use that
2794 * antenna/chain for Rx or Tx. If both A and B seem to be disconnected,
2795 * driver should declare the stronger one as connected, and attempt to use it
2796 * (A and B are the only 2 Tx chains!).
2797 *
2798 *
2799 * RX BALANCE:
2800 *
2801 * Driver should balance the 3 receivers (but just the ones that are connected
2802 * to antennas, see above) for gain, by comparing the average signal levels
2803 * detected during the silence after each beacon (background noise).
2804 * Accumulate (add) the following values over 20 beacons, one accumulator for
2805 * each of the chains a/b/c, from struct statistics_rx_non_phy:
2806 *
2807 * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
2808 *
2809 * Find the weakest background noise level from among a/b/c. This Rx chain
2810 * will be the reference, with 0 gain adjustment. Attenuate other channels by
2811 * finding noise difference:
2812 *
2813 * (accum_noise[i] - accum_noise[reference]) / 30
2814 *
2815 * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
2816 * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
2817 * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
2818 * and set bit 2 to indicate "reduce gain". The value for the reference
2819 * (weakest) chain should be "0".
2820 *
2821 * diff_gain_[abc] bit fields:
2822 * 2: (1) reduce gain, (0) increase gain
2823 * 1-0: amount of gain, units of 1.5 dB
2824 */
2825
2826/* "Differential Gain" opcode used in REPLY_PHY_CALIBRATION_CMD. */
2827#define PHY_CALIBRATE_DIFF_GAIN_CMD (7)
2828
2829struct iwl4965_calibration_cmd {
2830 u8 opCode; /* PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
2831 u8 flags; /* not used */
2832 __le16 reserved;
2833 s8 diff_gain_a; /* see above */
2834 s8 diff_gain_b;
2835 s8 diff_gain_c;
2836 u8 reserved1;
2837} __attribute__ ((packed));
2838
2839/* Phy calibration command for 5000 series */
2840
2841enum {
2842 IWL5000_PHY_CALIBRATE_DC_CMD = 8,
2843 IWL5000_PHY_CALIBRATE_LO_CMD = 9,
2844 IWL5000_PHY_CALIBRATE_RX_BB_CMD = 10,
2845 IWL5000_PHY_CALIBRATE_TX_IQ_CMD = 11,
2846 IWL5000_PHY_CALIBRATE_RX_IQ_CMD = 12,
2847 IWL5000_PHY_CALIBRATION_NOISE_CMD = 13,
2848 IWL5000_PHY_CALIBRATE_AGC_TABLE_CMD = 14,
2849 IWL5000_PHY_CALIBRATE_CRYSTAL_FRQ_CMD = 15,
2850 IWL5000_PHY_CALIBRATE_BASE_BAND_CMD = 16,
2851 IWL5000_PHY_CALIBRATE_TX_IQ_PERD_CMD = 17,
2852 IWL5000_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD = 18,
2853 IWL5000_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD = 19,
2854};
2855
2856enum {
2857 CALIBRATION_CFG_CMD = 0x65,
2858 CALIBRATION_RES_NOTIFICATION = 0x66,
2859 CALIBRATION_COMPLETE_NOTIFICATION = 0x67
2860};
2861
2862struct iwl_cal_crystal_freq_cmd {
2863 u8 cap_pin1;
2864 u8 cap_pin2;
2865} __attribute__ ((packed));
2866
2867struct iwl5000_calibration {
2868 u8 op_code;
2869 u8 first_group;
2870 u8 num_groups;
2871 u8 all_data_valid;
2872 struct iwl_cal_crystal_freq_cmd data;
2873} __attribute__ ((packed));
2874
2875#define IWL_CALIB_INIT_CFG_ALL __constant_cpu_to_le32(0xffffffff)
2876
2877struct iwl_calib_cfg_elmnt_s {
2878 __le32 is_enable;
2879 __le32 start;
2880 __le32 send_res;
2881 __le32 apply_res;
2882 __le32 reserved;
2883} __attribute__ ((packed));
2884
2885struct iwl_calib_cfg_status_s {
2886 struct iwl_calib_cfg_elmnt_s once;
2887 struct iwl_calib_cfg_elmnt_s perd;
2888 __le32 flags;
2889} __attribute__ ((packed));
2890
2891struct iwl5000_calib_cfg_cmd {
2892 struct iwl_calib_cfg_status_s ucd_calib_cfg;
2893 struct iwl_calib_cfg_status_s drv_calib_cfg;
2894 __le32 reserved1;
2895} __attribute__ ((packed));
2896
2897struct iwl5000_calib_hdr {
2898 u8 op_code;
2899 u8 first_group;
2900 u8 groups_num;
2901 u8 data_valid;
2902} __attribute__ ((packed));
2903
2904struct iwl5000_calibration_chain_noise_reset_cmd {
2905 u8 op_code; /* IWL5000_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD */
2906 u8 flags; /* not used */
2907 __le16 reserved;
2908} __attribute__ ((packed));
2909
2910struct iwl5000_calibration_chain_noise_gain_cmd {
2911 u8 op_code; /* IWL5000_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD */
2912 u8 flags; /* not used */
2913 __le16 reserved;
2914 u8 delta_gain_1;
2915 u8 delta_gain_2;
2916 __le16 reserved1;
2917} __attribute__ ((packed));
2918
2919/******************************************************************************
2920 * (12)
2921 * Miscellaneous Commands:
2922 *
2923 *****************************************************************************/
2924
2925/*
2926 * LEDs Command & Response
2927 * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
2928 *
2929 * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
2930 * this command turns it on or off, or sets up a periodic blinking cycle.
2931 */
2932struct iwl_led_cmd {
2933 __le32 interval; /* "interval" in uSec */
2934 u8 id; /* 1: Activity, 2: Link, 3: Tech */
2935 u8 off; /* # intervals off while blinking;
2936 * "0", with >0 "on" value, turns LED on */
2937 u8 on; /* # intervals on while blinking;
2938 * "0", regardless of "off", turns LED off */
2939 u8 reserved;
2940} __attribute__ ((packed));
2941
2942/*
2943 * Coexistence WIFI/WIMAX Command
2944 * COEX_PRIORITY_TABLE_CMD = 0x5a
2945 *
2946 */
2947enum {
2948 COEX_UNASSOC_IDLE = 0,
2949 COEX_UNASSOC_MANUAL_SCAN = 1,
2950 COEX_UNASSOC_AUTO_SCAN = 2,
2951 COEX_CALIBRATION = 3,
2952 COEX_PERIODIC_CALIBRATION = 4,
2953 COEX_CONNECTION_ESTAB = 5,
2954 COEX_ASSOCIATED_IDLE = 6,
2955 COEX_ASSOC_MANUAL_SCAN = 7,
2956 COEX_ASSOC_AUTO_SCAN = 8,
2957 COEX_ASSOC_ACTIVE_LEVEL = 9,
2958 COEX_RF_ON = 10,
2959 COEX_RF_OFF = 11,
2960 COEX_STAND_ALONE_DEBUG = 12,
2961 COEX_IPAN_ASSOC_LEVEL = 13,
2962 COEX_RSRVD1 = 14,
2963 COEX_RSRVD2 = 15,
2964 COEX_NUM_OF_EVENTS = 16
2965};
2966
2967struct iwl_wimax_coex_event_entry {
2968 u8 request_prio;
2969 u8 win_medium_prio;
2970 u8 reserved;
2971 u8 flags;
2972} __attribute__ ((packed));
2973
2974/* COEX flag masks */
2975
2976/* Staion table is valid */
2977#define COEX_FLAGS_STA_TABLE_VALID_MSK (0x1)
2978/* UnMask wakeup src at unassociated sleep */
2979#define COEX_FLAGS_UNASSOC_WA_UNMASK_MSK (0x4)
2980/* UnMask wakeup src at associated sleep */
2981#define COEX_FLAGS_ASSOC_WA_UNMASK_MSK (0x8)
2982/* Enable CoEx feature. */
2983#define COEX_FLAGS_COEX_ENABLE_MSK (0x80)
2984
2985struct iwl_wimax_coex_cmd {
2986 u8 flags;
2987 u8 reserved[3];
2988 struct iwl_wimax_coex_event_entry sta_prio[COEX_NUM_OF_EVENTS];
2989} __attribute__ ((packed));
2990
2991/******************************************************************************
2992 * (13)
2993 * Union of all expected notifications/responses:
2994 *
2995 *****************************************************************************/
2996
2997struct iwl_rx_packet {
2998 __le32 len;
2999 struct iwl_cmd_header hdr;
3000 union {
3001 struct iwl_alive_resp alive_frame;
3002 struct iwl4965_rx_frame rx_frame;
3003 struct iwl4965_tx_resp tx_resp;
3004 struct iwl4965_spectrum_notification spectrum_notif;
3005 struct iwl4965_csa_notification csa_notif;
3006 struct iwl_error_resp err_resp;
3007 struct iwl4965_card_state_notif card_state_notif;
3008 struct iwl4965_beacon_notif beacon_status;
3009 struct iwl_add_sta_resp add_sta;
3010 struct iwl_rem_sta_resp rem_sta;
3011 struct iwl4965_sleep_notification sleep_notif;
3012 struct iwl4965_spectrum_resp spectrum;
3013 struct iwl_notif_statistics stats;
3014 struct iwl_compressed_ba_resp compressed_ba;
3015 struct iwl4965_missed_beacon_notif missed_beacon;
3016 struct iwl5000_calibration calib;
3017 __le32 status;
3018 u8 raw[0];
3019 } u;
3020} __attribute__ ((packed));
3021
3022#define IWL_RX_FRAME_SIZE (4 + sizeof(struct iwl4965_rx_frame))
3023
3024#endif /* __iwl4965_commands_h__ */
generated by cgit v1.2.2 (git 2.25.0) at 2025-03-01 13:24:43 -0500