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