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