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