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