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