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