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