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