00d4ab7c7ace5e3f7ad2adea00f286533dda5d12
[linux-2.6.git] / drivers / net / wireless / iwlwifi / iwl-4965-commands.h
1 /******************************************************************************
2  *
3  * This file is provided under a dual BSD/GPLv2 license.  When using or
4  * redistributing this file, you may do so under either license.
5  *
6  * GPL LICENSE SUMMARY
7  *
8  * Copyright(c) 2005 - 2007 Intel Corporation. All rights reserved.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of version 2 of the GNU General Public License as
12  * published by the Free Software Foundation.
13  *
14  * This program is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
22  * USA
23  *
24  * The full GNU General Public License is included in this distribution
25  * in the file called LICENSE.GPL.
26  *
27  * Contact Information:
28  * James P. Ketrenos <ipw2100-admin@linux.intel.com>
29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30  *
31  * BSD LICENSE
32  *
33  * Copyright(c) 2005 - 2007 Intel Corporation. All rights reserved.
34  * All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  *
40  *  * Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  *  * Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in
44  *    the documentation and/or other materials provided with the
45  *    distribution.
46  *  * Neither the name Intel Corporation nor the names of its
47  *    contributors may be used to endorse or promote products derived
48  *    from this software without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61  *
62  *****************************************************************************/
63
64 #ifndef __iwl4965_commands_h__
65 #define __iwl4965_commands_h__
66
67 enum {
68         REPLY_ALIVE = 0x1,
69         REPLY_ERROR = 0x2,
70
71         /* RXON and QOS commands */
72         REPLY_RXON = 0x10,
73         REPLY_RXON_ASSOC = 0x11,
74         REPLY_QOS_PARAM = 0x13,
75         REPLY_RXON_TIMING = 0x14,
76
77         /* Multi-Station support */
78         REPLY_ADD_STA = 0x18,
79         REPLY_REMOVE_STA = 0x19,        /* not used */
80         REPLY_REMOVE_ALL_STA = 0x1a,    /* not used */
81
82         /* RX, TX, LEDs */
83         REPLY_TX = 0x1c,
84         REPLY_RATE_SCALE = 0x47,        /* 3945 only */
85         REPLY_LEDS_CMD = 0x48,
86         REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */
87
88         /* 802.11h related */
89         RADAR_NOTIFICATION = 0x70,      /* not used */
90         REPLY_QUIET_CMD = 0x71,         /* not used */
91         REPLY_CHANNEL_SWITCH = 0x72,
92         CHANNEL_SWITCH_NOTIFICATION = 0x73,
93         REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
94         SPECTRUM_MEASURE_NOTIFICATION = 0x75,
95
96         /* Power Management */
97         POWER_TABLE_CMD = 0x77,
98         PM_SLEEP_NOTIFICATION = 0x7A,
99         PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
100
101         /* Scan commands and notifications */
102         REPLY_SCAN_CMD = 0x80,
103         REPLY_SCAN_ABORT_CMD = 0x81,
104         SCAN_START_NOTIFICATION = 0x82,
105         SCAN_RESULTS_NOTIFICATION = 0x83,
106         SCAN_COMPLETE_NOTIFICATION = 0x84,
107
108         /* IBSS/AP commands */
109         BEACON_NOTIFICATION = 0x90,
110         REPLY_TX_BEACON = 0x91,
111         WHO_IS_AWAKE_NOTIFICATION = 0x94,       /* not used */
112
113         /* Miscellaneous commands */
114         QUIET_NOTIFICATION = 0x96,              /* not used */
115         REPLY_TX_PWR_TABLE_CMD = 0x97,
116         MEASURE_ABORT_NOTIFICATION = 0x99,      /* not used */
117
118         /* BT config command */
119         REPLY_BT_CONFIG = 0x9b,
120
121         /* 4965 Statistics */
122         REPLY_STATISTICS_CMD = 0x9c,
123         STATISTICS_NOTIFICATION = 0x9d,
124
125         /* RF-KILL commands and notifications */
126         REPLY_CARD_STATE_CMD = 0xa0,
127         CARD_STATE_NOTIFICATION = 0xa1,
128
129         /* Missed beacons notification */
130         MISSED_BEACONS_NOTIFICATION = 0xa2,
131
132         REPLY_CT_KILL_CONFIG_CMD = 0xa4,
133         SENSITIVITY_CMD = 0xa8,
134         REPLY_PHY_CALIBRATION_CMD = 0xb0,
135         REPLY_RX_PHY_CMD = 0xc0,
136         REPLY_RX_MPDU_CMD = 0xc1,
137         REPLY_4965_RX = 0xc3,
138         REPLY_COMPRESSED_BA = 0xc5,
139         REPLY_MAX = 0xff
140 };
141
142 /******************************************************************************
143  * (0)
144  * Commonly used structures and definitions:
145  * Command header, rate_n_flags
146  *
147  *****************************************************************************/
148
149 #define IWL_CMD_FAILED_MSK 0x40
150
151 struct iwl4965_cmd_header {
152         u8 cmd;
153         u8 flags;
154         /* We have 15 LSB to use as we please (MSB indicates
155          * a frame Rx'd from the HW).  We encode the following
156          * information into the sequence field:
157          *
158          *  0:7    index in fifo
159          *  8:13   fifo selection
160          * 14:14   bit indicating if this packet references the 'extra'
161          *         storage at the end of the memory queue
162          * 15:15   (Rx indication)
163          *
164          */
165         __le16 sequence;
166
167         /* command data follows immediately */
168         u8 data[0];
169 } __attribute__ ((packed));
170
171 /**
172  * 4965 rate_n_flags bit fields
173  *
174  * rate_n_flags format is used in following 4965 commands:
175  *  REPLY_4965_RX (response only)
176  *  REPLY_TX (both command and response)
177  *  REPLY_TX_LINK_QUALITY_CMD
178  *
179  * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
180  *  2-0:  0)   6 Mbps
181  *        1)  12 Mbps
182  *        2)  18 Mbps
183  *        3)  24 Mbps
184  *        4)  36 Mbps
185  *        5)  48 Mbps
186  *        6)  54 Mbps
187  *        7)  60 Mbps
188  *
189  *    3:  0)  Single stream (SISO)
190  *        1)  Dual stream (MIMO)
191  *
192  *    5:  Value of 0x20 in bits 7:0 indicates 6 Mbps FAT duplicate data
193  *
194  * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
195  *  3-0:  0xD)   6 Mbps
196  *        0xF)   9 Mbps
197  *        0x5)  12 Mbps
198  *        0x7)  18 Mbps
199  *        0x9)  24 Mbps
200  *        0xB)  36 Mbps
201  *        0x1)  48 Mbps
202  *        0x3)  54 Mbps
203  *
204  * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
205  *  3-0:   10)  1 Mbps
206  *         20)  2 Mbps
207  *         55)  5.5 Mbps
208  *        110)  11 Mbps
209  */
210 #define RATE_MCS_CODE_MSK 0x7
211 #define RATE_MCS_MIMO_POS 3
212 #define RATE_MCS_MIMO_MSK 0x8
213 #define RATE_MCS_HT_DUP_POS 5
214 #define RATE_MCS_HT_DUP_MSK 0x20
215
216 /* (1) HT format, (0) legacy format in bits 7:0 */
217 #define RATE_MCS_FLAGS_POS 8
218 #define RATE_MCS_HT_POS 8
219 #define RATE_MCS_HT_MSK 0x100
220
221 /* (1) CCK, (0) OFDM.  HT (bit 8) must be "0" for this bit to be valid */
222 #define RATE_MCS_CCK_POS 9
223 #define RATE_MCS_CCK_MSK 0x200
224
225 /* (1) Use Green Field preamble */
226 #define RATE_MCS_GF_POS 10
227 #define RATE_MCS_GF_MSK 0x400
228
229 /* (1) Use 40Mhz FAT channel width, (0) use 20 MHz legacy channel width */
230 #define RATE_MCS_FAT_POS 11
231 #define RATE_MCS_FAT_MSK 0x800
232
233 /* (1) Duplicate data on both 20MHz channels.  FAT (bit 11) must be set. */
234 #define RATE_MCS_DUP_POS 12
235 #define RATE_MCS_DUP_MSK 0x1000
236
237 /* (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
238 #define RATE_MCS_SGI_POS 13
239 #define RATE_MCS_SGI_MSK 0x2000
240
241 /**
242  * rate_n_flags Tx antenna masks (4965 has 2 transmitters):
243  * bit14:15 01 B inactive, A active
244  *          10 B active, A inactive
245  *          11 Both active
246  */
247 #define RATE_MCS_ANT_A_POS      14
248 #define RATE_MCS_ANT_B_POS      15
249 #define RATE_MCS_ANT_A_MSK      0x4000
250 #define RATE_MCS_ANT_B_MSK      0x8000
251 #define RATE_MCS_ANT_AB_MSK     0xc000
252
253
254 /******************************************************************************
255  * (0a)
256  * Alive and Error Commands & Responses:
257  *
258  *****************************************************************************/
259
260 #define UCODE_VALID_OK  __constant_cpu_to_le32(0x1)
261 #define INITIALIZE_SUBTYPE    (9)
262
263 /*
264  * REPLY_ALIVE = 0x1 (response only, not a command)
265  */
266 struct iwl4965_alive_resp {
267         u8 ucode_minor;
268         u8 ucode_major;
269         __le16 reserved1;
270         u8 sw_rev[8];
271         u8 ver_type;
272         u8 ver_subtype;
273         __le16 reserved2;
274         __le32 log_event_table_ptr;
275         __le32 error_event_table_ptr;
276         __le32 timestamp;
277         __le32 is_valid;
278 } __attribute__ ((packed));
279
280 struct iwl4965_init_alive_resp {
281         u8 ucode_minor;
282         u8 ucode_major;
283         __le16 reserved1;
284         u8 sw_rev[8];
285         u8 ver_type;
286         u8 ver_subtype;
287         __le16 reserved2;
288         __le32 log_event_table_ptr;
289         __le32 error_event_table_ptr;
290         __le32 timestamp;
291         __le32 is_valid;
292
293         /* calibration values from "initialize" uCode */
294         __le32 voltage;         /* signed */
295         __le32 therm_r1[2];     /* signed 1st for normal, 2nd for FAT channel */
296         __le32 therm_r2[2];     /* signed */
297         __le32 therm_r3[2];     /* signed */
298         __le32 therm_r4[2];     /* signed */
299         __le32 tx_atten[5][2];  /* signed MIMO gain comp, 5 freq groups,
300                                  * 2 Tx chains */
301 } __attribute__ ((packed));
302
303 union tsf {
304         u8 byte[8];
305         __le16 word[4];
306         __le32 dw[2];
307 };
308
309 /*
310  * REPLY_ERROR = 0x2 (response only, not a command)
311  */
312 struct iwl4965_error_resp {
313         __le32 error_type;
314         u8 cmd_id;
315         u8 reserved1;
316         __le16 bad_cmd_seq_num;
317         __le32 error_info;
318         union tsf timestamp;
319 } __attribute__ ((packed));
320
321 /******************************************************************************
322  * (1)
323  * RXON Commands & Responses:
324  *
325  *****************************************************************************/
326
327 /*
328  * Rx config defines & structure
329  */
330 /* rx_config device types  */
331 enum {
332         RXON_DEV_TYPE_AP = 1,
333         RXON_DEV_TYPE_ESS = 3,
334         RXON_DEV_TYPE_IBSS = 4,
335         RXON_DEV_TYPE_SNIFFER = 6,
336 };
337
338 /* rx_config flags */
339 /* band & modulation selection */
340 #define RXON_FLG_BAND_24G_MSK           __constant_cpu_to_le32(1 << 0)
341 #define RXON_FLG_CCK_MSK                __constant_cpu_to_le32(1 << 1)
342 /* auto detection enable */
343 #define RXON_FLG_AUTO_DETECT_MSK        __constant_cpu_to_le32(1 << 2)
344 /* TGg protection when tx */
345 #define RXON_FLG_TGG_PROTECT_MSK        __constant_cpu_to_le32(1 << 3)
346 /* cck short slot & preamble */
347 #define RXON_FLG_SHORT_SLOT_MSK          __constant_cpu_to_le32(1 << 4)
348 #define RXON_FLG_SHORT_PREAMBLE_MSK     __constant_cpu_to_le32(1 << 5)
349 /* antenna selection */
350 #define RXON_FLG_DIS_DIV_MSK            __constant_cpu_to_le32(1 << 7)
351 #define RXON_FLG_ANT_SEL_MSK            __constant_cpu_to_le32(0x0f00)
352 #define RXON_FLG_ANT_A_MSK              __constant_cpu_to_le32(1 << 8)
353 #define RXON_FLG_ANT_B_MSK              __constant_cpu_to_le32(1 << 9)
354 /* radar detection enable */
355 #define RXON_FLG_RADAR_DETECT_MSK       __constant_cpu_to_le32(1 << 12)
356 #define RXON_FLG_TGJ_NARROW_BAND_MSK    __constant_cpu_to_le32(1 << 13)
357 /* rx response to host with 8-byte TSF
358 * (according to ON_AIR deassertion) */
359 #define RXON_FLG_TSF2HOST_MSK           __constant_cpu_to_le32(1 << 15)
360
361 /* rx_config filter flags */
362 /* accept all data frames */
363 #define RXON_FILTER_PROMISC_MSK         __constant_cpu_to_le32(1 << 0)
364 /* pass control & management to host */
365 #define RXON_FILTER_CTL2HOST_MSK        __constant_cpu_to_le32(1 << 1)
366 /* accept multi-cast */
367 #define RXON_FILTER_ACCEPT_GRP_MSK      __constant_cpu_to_le32(1 << 2)
368 /* don't decrypt uni-cast frames */
369 #define RXON_FILTER_DIS_DECRYPT_MSK     __constant_cpu_to_le32(1 << 3)
370 /* don't decrypt multi-cast frames */
371 #define RXON_FILTER_DIS_GRP_DECRYPT_MSK __constant_cpu_to_le32(1 << 4)
372 /* STA is associated */
373 #define RXON_FILTER_ASSOC_MSK           __constant_cpu_to_le32(1 << 5)
374 /* transfer to host non bssid beacons in associated state */
375 #define RXON_FILTER_BCON_AWARE_MSK      __constant_cpu_to_le32(1 << 6)
376
377 /*
378  * REPLY_RXON = 0x10 (command, has simple generic response)
379  */
380 struct iwl4965_rxon_cmd {
381         u8 node_addr[6];
382         __le16 reserved1;
383         u8 bssid_addr[6];
384         __le16 reserved2;
385         u8 wlap_bssid_addr[6];
386         __le16 reserved3;
387         u8 dev_type;
388         u8 air_propagation;
389         __le16 rx_chain;
390         u8 ofdm_basic_rates;
391         u8 cck_basic_rates;
392         __le16 assoc_id;
393         __le32 flags;
394         __le32 filter_flags;
395         __le16 channel;
396         u8 ofdm_ht_single_stream_basic_rates;
397         u8 ofdm_ht_dual_stream_basic_rates;
398 } __attribute__ ((packed));
399
400 /*
401  * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
402  */
403 struct iwl4965_rxon_assoc_cmd {
404         __le32 flags;
405         __le32 filter_flags;
406         u8 ofdm_basic_rates;
407         u8 cck_basic_rates;
408         u8 ofdm_ht_single_stream_basic_rates;
409         u8 ofdm_ht_dual_stream_basic_rates;
410         __le16 rx_chain_select_flags;
411         __le16 reserved;
412 } __attribute__ ((packed));
413
414 /*
415  * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
416  */
417 struct iwl4965_rxon_time_cmd {
418         union tsf timestamp;
419         __le16 beacon_interval;
420         __le16 atim_window;
421         __le32 beacon_init_val;
422         __le16 listen_interval;
423         __le16 reserved;
424 } __attribute__ ((packed));
425
426 struct iwl4965_tx_power {
427         u8 tx_gain;             /* gain for analog radio */
428         u8 dsp_atten;           /* gain for DSP */
429 } __attribute__ ((packed));
430
431 #define POWER_TABLE_NUM_ENTRIES                 33
432 #define POWER_TABLE_NUM_HT_OFDM_ENTRIES         32
433 #define POWER_TABLE_CCK_ENTRY                   32
434 struct tx_power_dual_stream {
435         __le32 dw;
436 } __attribute__ ((packed));
437
438 struct iwl4965_tx_power_db {
439         struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES];
440 } __attribute__ ((packed));
441
442 /*
443  * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
444  */
445 struct iwl4965_channel_switch_cmd {
446         u8 band;
447         u8 expect_beacon;
448         __le16 channel;
449         __le32 rxon_flags;
450         __le32 rxon_filter_flags;
451         __le32 switch_time;
452         struct iwl4965_tx_power_db tx_power;
453 } __attribute__ ((packed));
454
455 /*
456  * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
457  */
458 struct iwl4965_csa_notification {
459         __le16 band;
460         __le16 channel;
461         __le32 status;          /* 0 - OK, 1 - fail */
462 } __attribute__ ((packed));
463
464 /******************************************************************************
465  * (2)
466  * Quality-of-Service (QOS) Commands & Responses:
467  *
468  *****************************************************************************/
469 struct iwl4965_ac_qos {
470         __le16 cw_min;
471         __le16 cw_max;
472         u8 aifsn;
473         u8 reserved1;
474         __le16 edca_txop;
475 } __attribute__ ((packed));
476
477 /* QoS flags defines */
478 #define QOS_PARAM_FLG_UPDATE_EDCA_MSK   __constant_cpu_to_le32(0x01)
479 #define QOS_PARAM_FLG_TGN_MSK           __constant_cpu_to_le32(0x02)
480 #define QOS_PARAM_FLG_TXOP_TYPE_MSK     __constant_cpu_to_le32(0x10)
481
482 /*
483  *  TXFIFO Queue number defines
484  */
485 /* number of Access categories (AC) (EDCA), queues 0..3 */
486 #define AC_NUM                4
487
488 /*
489  * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
490  */
491 struct iwl4965_qosparam_cmd {
492         __le32 qos_flags;
493         struct iwl4965_ac_qos ac[AC_NUM];
494 } __attribute__ ((packed));
495
496 /******************************************************************************
497  * (3)
498  * Add/Modify Stations Commands & Responses:
499  *
500  *****************************************************************************/
501 /*
502  * Multi station support
503  */
504 #define IWL_AP_ID               0
505 #define IWL_MULTICAST_ID        1
506 #define IWL_STA_ID              2
507
508 #define IWL3945_BROADCAST_ID    24
509 #define IWL3945_STATION_COUNT   25
510
511 #define IWL4965_BROADCAST_ID    31
512 #define IWL4965_STATION_COUNT   32
513
514 #define IWL_STATION_COUNT       32      /* MAX(3945,4965)*/
515 #define IWL_INVALID_STATION     255
516
517 #define STA_FLG_PWR_SAVE_MSK            __constant_cpu_to_le32(1<<8);
518
519 #define STA_CONTROL_MODIFY_MSK          0x01
520
521 /* key flags __le16*/
522 #define STA_KEY_FLG_ENCRYPT_MSK __constant_cpu_to_le16(0x7)
523 #define STA_KEY_FLG_NO_ENC      __constant_cpu_to_le16(0x0)
524 #define STA_KEY_FLG_WEP         __constant_cpu_to_le16(0x1)
525 #define STA_KEY_FLG_CCMP        __constant_cpu_to_le16(0x2)
526 #define STA_KEY_FLG_TKIP        __constant_cpu_to_le16(0x3)
527
528 #define STA_KEY_FLG_KEYID_POS   8
529 #define STA_KEY_FLG_INVALID     __constant_cpu_to_le16(0x0800)
530
531 /* modify flags  */
532 #define STA_MODIFY_KEY_MASK             0x01
533 #define STA_MODIFY_TID_DISABLE_TX       0x02
534 #define STA_MODIFY_TX_RATE_MSK          0x04
535 #define STA_MODIFY_ADDBA_TID_MSK        0x08
536 #define STA_MODIFY_DELBA_TID_MSK        0x10
537 #define BUILD_RAxTID(sta_id, tid)       (((sta_id) << 4) + (tid))
538
539 struct iwl4965_keyinfo {
540         __le16 key_flags;
541         u8 tkip_rx_tsc_byte2;   /* TSC[2] for key mix ph1 detection */
542         u8 reserved1;
543         __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
544         __le16 reserved2;
545         u8 key[16];             /* 16-byte unicast decryption key */
546 } __attribute__ ((packed));
547
548 struct sta_id_modify {
549         u8 addr[ETH_ALEN];
550         __le16 reserved1;
551         u8 sta_id;
552         u8 modify_mask;
553         __le16 reserved2;
554 } __attribute__ ((packed));
555
556 /*
557  * REPLY_ADD_STA = 0x18 (command)
558  */
559 struct iwl4965_addsta_cmd {
560         u8 mode;
561         u8 reserved[3];
562         struct sta_id_modify sta;
563         struct iwl4965_keyinfo key;
564         __le32 station_flags;
565         __le32 station_flags_msk;
566         __le16 tid_disable_tx;
567         __le16  reserved1;
568         u8 add_immediate_ba_tid;
569         u8 remove_immediate_ba_tid;
570         __le16 add_immediate_ba_ssn;
571         __le32 reserved2;
572 } __attribute__ ((packed));
573
574 /*
575  * REPLY_ADD_STA = 0x18 (response)
576  */
577 struct iwl4965_add_sta_resp {
578         u8 status;
579 } __attribute__ ((packed));
580
581 #define ADD_STA_SUCCESS_MSK              0x1
582
583 /******************************************************************************
584  * (4)
585  * Rx Responses:
586  *
587  *****************************************************************************/
588
589 struct iwl4965_rx_frame_stats {
590         u8 phy_count;
591         u8 id;
592         u8 rssi;
593         u8 agc;
594         __le16 sig_avg;
595         __le16 noise_diff;
596         u8 payload[0];
597 } __attribute__ ((packed));
598
599 struct iwl4965_rx_frame_hdr {
600         __le16 channel;
601         __le16 phy_flags;
602         u8 reserved1;
603         u8 rate;
604         __le16 len;
605         u8 payload[0];
606 } __attribute__ ((packed));
607
608 #define RX_RES_STATUS_NO_CRC32_ERROR    __constant_cpu_to_le32(1 << 0)
609 #define RX_RES_STATUS_NO_RXE_OVERFLOW   __constant_cpu_to_le32(1 << 1)
610
611 #define RX_RES_PHY_FLAGS_BAND_24_MSK    __constant_cpu_to_le16(1 << 0)
612 #define RX_RES_PHY_FLAGS_MOD_CCK_MSK            __constant_cpu_to_le16(1 << 1)
613 #define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK     __constant_cpu_to_le16(1 << 2)
614 #define RX_RES_PHY_FLAGS_NARROW_BAND_MSK        __constant_cpu_to_le16(1 << 3)
615 #define RX_RES_PHY_FLAGS_ANTENNA_MSK            __constant_cpu_to_le16(0xf0)
616
617 #define RX_RES_STATUS_SEC_TYPE_MSK      (0x7 << 8)
618 #define RX_RES_STATUS_SEC_TYPE_NONE     (0x0 << 8)
619 #define RX_RES_STATUS_SEC_TYPE_WEP      (0x1 << 8)
620 #define RX_RES_STATUS_SEC_TYPE_CCMP     (0x2 << 8)
621 #define RX_RES_STATUS_SEC_TYPE_TKIP     (0x3 << 8)
622
623 #define RX_RES_STATUS_DECRYPT_TYPE_MSK  (0x3 << 11)
624 #define RX_RES_STATUS_NOT_DECRYPT       (0x0 << 11)
625 #define RX_RES_STATUS_DECRYPT_OK        (0x3 << 11)
626 #define RX_RES_STATUS_BAD_ICV_MIC       (0x1 << 11)
627 #define RX_RES_STATUS_BAD_KEY_TTAK      (0x2 << 11)
628
629 struct iwl4965_rx_frame_end {
630         __le32 status;
631         __le64 timestamp;
632         __le32 beacon_timestamp;
633 } __attribute__ ((packed));
634
635 /*
636  * REPLY_3945_RX = 0x1b (response only, not a command)
637  *
638  * NOTE:  DO NOT dereference from casts to this structure
639  * It is provided only for calculating minimum data set size.
640  * The actual offsets of the hdr and end are dynamic based on
641  * stats.phy_count
642  */
643 struct iwl4965_rx_frame {
644         struct iwl4965_rx_frame_stats stats;
645         struct iwl4965_rx_frame_hdr hdr;
646         struct iwl4965_rx_frame_end end;
647 } __attribute__ ((packed));
648
649 /* Fixed (non-configurable) rx data from phy */
650 #define RX_PHY_FLAGS_ANTENNAE_OFFSET            (4)
651 #define RX_PHY_FLAGS_ANTENNAE_MASK              (0x70)
652 #define IWL_AGC_DB_MASK         (0x3f80)        /* MASK(7,13) */
653 #define IWL_AGC_DB_POS          (7)
654 struct iwl4965_rx_non_cfg_phy {
655         __le16 ant_selection;   /* ant A bit 4, ant B bit 5, ant C bit 6 */
656         __le16 agc_info;        /* agc code 0:6, agc dB 7:13, reserved 14:15 */
657         u8 rssi_info[6];        /* we use even entries, 0/2/4 for A/B/C rssi */
658         u8 pad[0];
659 } __attribute__ ((packed));
660
661 /*
662  * REPLY_4965_RX = 0xc3 (response only, not a command)
663  * Used only for legacy (non 11n) frames.
664  */
665 #define RX_RES_PHY_CNT 14
666 struct iwl4965_rx_phy_res {
667         u8 non_cfg_phy_cnt;     /* non configurable DSP phy data byte count */
668         u8 cfg_phy_cnt;         /* configurable DSP phy data byte count */
669         u8 stat_id;             /* configurable DSP phy data set ID */
670         u8 reserved1;
671         __le64 timestamp;       /* TSF at on air rise */
672         __le32 beacon_time_stamp; /* beacon at on-air rise */
673         __le16 phy_flags;       /* general phy flags: band, modulation, ... */
674         __le16 channel;         /* channel number */
675         __le16 non_cfg_phy[RX_RES_PHY_CNT];     /* upto 14 phy entries */
676         __le32 reserved2;
677         __le32 rate_n_flags;
678         __le16 byte_count;              /* frame's byte-count */
679         __le16 reserved3;
680 } __attribute__ ((packed));
681
682 struct iwl4965_rx_mpdu_res_start {
683         __le16 byte_count;
684         __le16 reserved;
685 } __attribute__ ((packed));
686
687
688 /******************************************************************************
689  * (5)
690  * Tx Commands & Responses:
691  *
692  *****************************************************************************/
693
694 /* Tx flags */
695 #define TX_CMD_FLG_RTS_MSK __constant_cpu_to_le32(1 << 1)
696 #define TX_CMD_FLG_CTS_MSK __constant_cpu_to_le32(1 << 2)
697 #define TX_CMD_FLG_ACK_MSK __constant_cpu_to_le32(1 << 3)
698 #define TX_CMD_FLG_STA_RATE_MSK __constant_cpu_to_le32(1 << 4)
699 #define TX_CMD_FLG_IMM_BA_RSP_MASK  __constant_cpu_to_le32(1 << 6)
700 #define TX_CMD_FLG_FULL_TXOP_PROT_MSK __constant_cpu_to_le32(1 << 7)
701 #define TX_CMD_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0xf00)
702 #define TX_CMD_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8)
703 #define TX_CMD_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9)
704
705 /* ucode ignores BT priority for this frame */
706 #define TX_CMD_FLG_BT_DIS_MSK __constant_cpu_to_le32(1 << 12)
707
708 /* ucode overrides sequence control */
709 #define TX_CMD_FLG_SEQ_CTL_MSK __constant_cpu_to_le32(1 << 13)
710
711 /* signal that this frame is non-last MPDU */
712 #define TX_CMD_FLG_MORE_FRAG_MSK __constant_cpu_to_le32(1 << 14)
713
714 /* calculate TSF in outgoing frame */
715 #define TX_CMD_FLG_TSF_MSK __constant_cpu_to_le32(1 << 16)
716
717 /* activate TX calibration. */
718 #define TX_CMD_FLG_CALIB_MSK __constant_cpu_to_le32(1 << 17)
719
720 /* signals that 2 bytes pad was inserted
721    after the MAC header */
722 #define TX_CMD_FLG_MH_PAD_MSK __constant_cpu_to_le32(1 << 20)
723
724 /* HCCA-AP - disable duration overwriting. */
725 #define TX_CMD_FLG_DUR_MSK __constant_cpu_to_le32(1 << 25)
726
727 /*
728  * TX command security control
729  */
730 #define TX_CMD_SEC_WEP          0x01
731 #define TX_CMD_SEC_CCM          0x02
732 #define TX_CMD_SEC_TKIP         0x03
733 #define TX_CMD_SEC_MSK          0x03
734 #define TX_CMD_SEC_SHIFT        6
735 #define TX_CMD_SEC_KEY128       0x08
736
737 /*
738  * TX command Frame life time
739  */
740
741 struct iwl4965_dram_scratch {
742         u8 try_cnt;
743         u8 bt_kill_cnt;
744         __le16 reserved;
745 } __attribute__ ((packed));
746
747 /*
748  * REPLY_TX = 0x1c (command)
749  */
750 struct iwl4965_tx_cmd {
751         __le16 len;
752         __le16 next_frame_len;
753         __le32 tx_flags;
754         struct iwl4965_dram_scratch scratch;
755         __le32 rate_n_flags;
756         u8 sta_id;
757         u8 sec_ctl;
758         u8 initial_rate_index;
759         u8 reserved;
760         u8 key[16];
761         __le16 next_frame_flags;
762         __le16 reserved2;
763         union {
764                 __le32 life_time;
765                 __le32 attempt;
766         } stop_time;
767         __le32 dram_lsb_ptr;
768         u8 dram_msb_ptr;
769         u8 rts_retry_limit;     /*byte 50 */
770         u8 data_retry_limit;    /*byte 51 */
771         u8 tid_tspec;
772         union {
773                 __le16 pm_frame_timeout;
774                 __le16 attempt_duration;
775         } timeout;
776         __le16 driver_txop;
777         u8 payload[0];
778         struct ieee80211_hdr hdr[0];
779 } __attribute__ ((packed));
780
781 /* TX command response is sent after *all* transmission attempts.
782  *
783  * NOTES:
784  *
785  * TX_STATUS_FAIL_NEXT_FRAG
786  *
787  * If the fragment flag in the MAC header for the frame being transmitted
788  * is set and there is insufficient time to transmit the next frame, the
789  * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
790  *
791  * TX_STATUS_FIFO_UNDERRUN
792  *
793  * Indicates the host did not provide bytes to the FIFO fast enough while
794  * a TX was in progress.
795  *
796  * TX_STATUS_FAIL_MGMNT_ABORT
797  *
798  * This status is only possible if the ABORT ON MGMT RX parameter was
799  * set to true with the TX command.
800  *
801  * If the MSB of the status parameter is set then an abort sequence is
802  * required.  This sequence consists of the host activating the TX Abort
803  * control line, and then waiting for the TX Abort command response.  This
804  * indicates that a the device is no longer in a transmit state, and that the
805  * command FIFO has been cleared.  The host must then deactivate the TX Abort
806  * control line.  Receiving is still allowed in this case.
807  */
808 enum {
809         TX_STATUS_SUCCESS = 0x01,
810         TX_STATUS_DIRECT_DONE = 0x02,
811         TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
812         TX_STATUS_FAIL_LONG_LIMIT = 0x83,
813         TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
814         TX_STATUS_FAIL_MGMNT_ABORT = 0x85,
815         TX_STATUS_FAIL_NEXT_FRAG = 0x86,
816         TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
817         TX_STATUS_FAIL_DEST_PS = 0x88,
818         TX_STATUS_FAIL_ABORTED = 0x89,
819         TX_STATUS_FAIL_BT_RETRY = 0x8a,
820         TX_STATUS_FAIL_STA_INVALID = 0x8b,
821         TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
822         TX_STATUS_FAIL_TID_DISABLE = 0x8d,
823         TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
824         TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
825         TX_STATUS_FAIL_TX_LOCKED = 0x90,
826         TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
827 };
828
829 #define TX_PACKET_MODE_REGULAR          0x0000
830 #define TX_PACKET_MODE_BURST_SEQ        0x0100
831 #define TX_PACKET_MODE_BURST_FIRST      0x0200
832
833 enum {
834         TX_POWER_PA_NOT_ACTIVE = 0x0,
835 };
836
837 enum {
838         TX_STATUS_MSK = 0x000000ff,     /* bits 0:7 */
839         TX_STATUS_DELAY_MSK = 0x00000040,
840         TX_STATUS_ABORT_MSK = 0x00000080,
841         TX_PACKET_MODE_MSK = 0x0000ff00,        /* bits 8:15 */
842         TX_FIFO_NUMBER_MSK = 0x00070000,        /* bits 16:18 */
843         TX_RESERVED = 0x00780000,       /* bits 19:22 */
844         TX_POWER_PA_DETECT_MSK = 0x7f800000,    /* bits 23:30 */
845         TX_ABORT_REQUIRED_MSK = 0x80000000,     /* bits 31:31 */
846 };
847
848 /* *******************************
849  * TX aggregation state
850  ******************************* */
851
852 enum {
853         AGG_TX_STATE_TRANSMITTED = 0x00,
854         AGG_TX_STATE_UNDERRUN_MSK = 0x01,
855         AGG_TX_STATE_BT_PRIO_MSK = 0x02,
856         AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
857         AGG_TX_STATE_ABORT_MSK = 0x08,
858         AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
859         AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
860         AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
861         AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
862         AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
863         AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
864         AGG_TX_STATE_DUMP_TX_MSK = 0x200,
865         AGG_TX_STATE_DELAY_TX_MSK = 0x400
866 };
867
868 #define AGG_TX_STATE_LAST_SENT_MSK \
869 (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
870  AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
871  AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
872
873 #define AGG_TX_STATE_TRY_CNT_POS 12
874 #define AGG_TX_STATE_TRY_CNT_MSK 0xf000
875
876 #define AGG_TX_STATE_SEQ_NUM_POS 16
877 #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
878
879 /*
880  * REPLY_TX = 0x1c (response)
881  */
882 struct iwl4965_tx_resp {
883         u8 frame_count;         /* 1 no aggregation, >1 aggregation */
884         u8 bt_kill_count;
885         u8 failure_rts;
886         u8 failure_frame;
887         __le32 rate_n_flags;
888         __le16 wireless_media_time;
889         __le16 reserved;
890         __le32 pa_power1;
891         __le32 pa_power2;
892         __le32 status;  /* TX status (for aggregation status of 1st frame) */
893 } __attribute__ ((packed));
894
895 /*
896  * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
897  */
898 struct iwl4965_compressed_ba_resp {
899         __le32 sta_addr_lo32;
900         __le16 sta_addr_hi16;
901         __le16 reserved;
902         u8 sta_id;
903         u8 tid;
904         __le16 ba_seq_ctl;
905         __le32 ba_bitmap0;
906         __le32 ba_bitmap1;
907         __le16 scd_flow;
908         __le16 scd_ssn;
909 } __attribute__ ((packed));
910
911 /*
912  * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
913  */
914 struct iwl4965_txpowertable_cmd {
915         u8 band;                /* 0: 5 GHz, 1: 2.4 GHz */
916         u8 reserved;
917         __le16 channel;
918         struct iwl4965_tx_power_db tx_power;
919 } __attribute__ ((packed));
920
921 /*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
922 #define  LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK    (1<<0)
923
924 #define  LINK_QUAL_AC_NUM AC_NUM
925 #define  LINK_QUAL_MAX_RETRY_NUM 16
926
927 #define  LINK_QUAL_ANT_A_MSK (1<<0)
928 #define  LINK_QUAL_ANT_B_MSK (1<<1)
929 #define  LINK_QUAL_ANT_MSK   (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
930
931 struct iwl4965_link_qual_general_params {
932         u8 flags;
933         u8 mimo_delimiter;
934         u8 single_stream_ant_msk;
935         u8 dual_stream_ant_msk;
936         u8 start_rate_index[LINK_QUAL_AC_NUM];
937 } __attribute__ ((packed));
938
939 struct iwl4965_link_qual_agg_params {
940         __le16 agg_time_limit;
941         u8 agg_dis_start_th;
942         u8 agg_frame_cnt_limit;
943         __le32 reserved;
944 } __attribute__ ((packed));
945
946 /*
947  * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
948  */
949 struct iwl4965_link_quality_cmd {
950         u8 sta_id;
951         u8 reserved1;
952         __le16 control;
953         struct iwl4965_link_qual_general_params general_params;
954         struct iwl4965_link_qual_agg_params agg_params;
955         struct {
956                 __le32 rate_n_flags;
957         } rs_table[LINK_QUAL_MAX_RETRY_NUM];
958         __le32 reserved2;
959 } __attribute__ ((packed));
960
961 /*
962  * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
963  */
964 struct iwl4965_bt_cmd {
965         u8 flags;
966         u8 lead_time;
967         u8 max_kill;
968         u8 reserved;
969         __le32 kill_ack_mask;
970         __le32 kill_cts_mask;
971 } __attribute__ ((packed));
972
973 /******************************************************************************
974  * (6)
975  * Spectrum Management (802.11h) Commands, Responses, Notifications:
976  *
977  *****************************************************************************/
978
979 /*
980  * Spectrum Management
981  */
982 #define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK         | \
983                                  RXON_FILTER_CTL2HOST_MSK        | \
984                                  RXON_FILTER_ACCEPT_GRP_MSK      | \
985                                  RXON_FILTER_DIS_DECRYPT_MSK     | \
986                                  RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
987                                  RXON_FILTER_ASSOC_MSK           | \
988                                  RXON_FILTER_BCON_AWARE_MSK)
989
990 struct iwl4965_measure_channel {
991         __le32 duration;        /* measurement duration in extended beacon
992                                  * format */
993         u8 channel;             /* channel to measure */
994         u8 type;                /* see enum iwl4965_measure_type */
995         __le16 reserved;
996 } __attribute__ ((packed));
997
998 /*
999  * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
1000  */
1001 struct iwl4965_spectrum_cmd {
1002         __le16 len;             /* number of bytes starting from token */
1003         u8 token;               /* token id */
1004         u8 id;                  /* measurement id -- 0 or 1 */
1005         u8 origin;              /* 0 = TGh, 1 = other, 2 = TGk */
1006         u8 periodic;            /* 1 = periodic */
1007         __le16 path_loss_timeout;
1008         __le32 start_time;      /* start time in extended beacon format */
1009         __le32 reserved2;
1010         __le32 flags;           /* rxon flags */
1011         __le32 filter_flags;    /* rxon filter flags */
1012         __le16 channel_count;   /* minimum 1, maximum 10 */
1013         __le16 reserved3;
1014         struct iwl4965_measure_channel channels[10];
1015 } __attribute__ ((packed));
1016
1017 /*
1018  * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
1019  */
1020 struct iwl4965_spectrum_resp {
1021         u8 token;
1022         u8 id;                  /* id of the prior command replaced, or 0xff */
1023         __le16 status;          /* 0 - command will be handled
1024                                  * 1 - cannot handle (conflicts with another
1025                                  *     measurement) */
1026 } __attribute__ ((packed));
1027
1028 enum iwl4965_measurement_state {
1029         IWL_MEASUREMENT_START = 0,
1030         IWL_MEASUREMENT_STOP = 1,
1031 };
1032
1033 enum iwl4965_measurement_status {
1034         IWL_MEASUREMENT_OK = 0,
1035         IWL_MEASUREMENT_CONCURRENT = 1,
1036         IWL_MEASUREMENT_CSA_CONFLICT = 2,
1037         IWL_MEASUREMENT_TGH_CONFLICT = 3,
1038         /* 4-5 reserved */
1039         IWL_MEASUREMENT_STOPPED = 6,
1040         IWL_MEASUREMENT_TIMEOUT = 7,
1041         IWL_MEASUREMENT_PERIODIC_FAILED = 8,
1042 };
1043
1044 #define NUM_ELEMENTS_IN_HISTOGRAM 8
1045
1046 struct iwl4965_measurement_histogram {
1047         __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
1048         __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM];  /* in 1usec counts */
1049 } __attribute__ ((packed));
1050
1051 /* clear channel availability counters */
1052 struct iwl4965_measurement_cca_counters {
1053         __le32 ofdm;
1054         __le32 cck;
1055 } __attribute__ ((packed));
1056
1057 enum iwl4965_measure_type {
1058         IWL_MEASURE_BASIC = (1 << 0),
1059         IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
1060         IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
1061         IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
1062         IWL_MEASURE_FRAME = (1 << 4),
1063         /* bits 5:6 are reserved */
1064         IWL_MEASURE_IDLE = (1 << 7),
1065 };
1066
1067 /*
1068  * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
1069  */
1070 struct iwl4965_spectrum_notification {
1071         u8 id;                  /* measurement id -- 0 or 1 */
1072         u8 token;
1073         u8 channel_index;       /* index in measurement channel list */
1074         u8 state;               /* 0 - start, 1 - stop */
1075         __le32 start_time;      /* lower 32-bits of TSF */
1076         u8 band;                /* 0 - 5.2GHz, 1 - 2.4GHz */
1077         u8 channel;
1078         u8 type;                /* see enum iwl4965_measurement_type */
1079         u8 reserved1;
1080         /* NOTE:  cca_ofdm, cca_cck, basic_type, and histogram are only only
1081          * valid if applicable for measurement type requested. */
1082         __le32 cca_ofdm;        /* cca fraction time in 40Mhz clock periods */
1083         __le32 cca_cck;         /* cca fraction time in 44Mhz clock periods */
1084         __le32 cca_time;        /* channel load time in usecs */
1085         u8 basic_type;          /* 0 - bss, 1 - ofdm preamble, 2 -
1086                                  * unidentified */
1087         u8 reserved2[3];
1088         struct iwl4965_measurement_histogram histogram;
1089         __le32 stop_time;       /* lower 32-bits of TSF */
1090         __le32 status;          /* see iwl4965_measurement_status */
1091 } __attribute__ ((packed));
1092
1093 /******************************************************************************
1094  * (7)
1095  * Power Management Commands, Responses, Notifications:
1096  *
1097  *****************************************************************************/
1098
1099 /**
1100  * struct iwl4965_powertable_cmd - Power Table Command
1101  * @flags: See below:
1102  *
1103  * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
1104  *
1105  * PM allow:
1106  *   bit 0 - '0' Driver not allow power management
1107  *           '1' Driver allow PM (use rest of parameters)
1108  * uCode send sleep notifications:
1109  *   bit 1 - '0' Don't send sleep notification
1110  *           '1' send sleep notification (SEND_PM_NOTIFICATION)
1111  * Sleep over DTIM
1112  *   bit 2 - '0' PM have to walk up every DTIM
1113  *           '1' PM could sleep over DTIM till listen Interval.
1114  * PCI power managed
1115  *   bit 3 - '0' (PCI_LINK_CTRL & 0x1)
1116  *           '1' !(PCI_LINK_CTRL & 0x1)
1117  * Force sleep Modes
1118  *   bit 31/30- '00' use both mac/xtal sleeps
1119  *              '01' force Mac sleep
1120  *              '10' force xtal sleep
1121  *              '11' Illegal set
1122  *
1123  * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
1124  * ucode assume sleep over DTIM is allowed and we don't need to wakeup
1125  * for every DTIM.
1126  */
1127 #define IWL_POWER_VEC_SIZE 5
1128
1129 #define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK        __constant_cpu_to_le16(1<<0)
1130 #define IWL_POWER_SLEEP_OVER_DTIM_MSK           __constant_cpu_to_le16(1<<2)
1131 #define IWL_POWER_PCI_PM_MSK                    __constant_cpu_to_le16(1<<3)
1132
1133 struct iwl4965_powertable_cmd {
1134         __le16 flags;
1135         u8 keep_alive_seconds;
1136         u8 debug_flags;
1137         __le32 rx_data_timeout;
1138         __le32 tx_data_timeout;
1139         __le32 sleep_interval[IWL_POWER_VEC_SIZE];
1140         __le32 keep_alive_beacons;
1141 } __attribute__ ((packed));
1142
1143 /*
1144  * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
1145  * 3945 and 4965 identical.
1146  */
1147 struct iwl4965_sleep_notification {
1148         u8 pm_sleep_mode;
1149         u8 pm_wakeup_src;
1150         __le16 reserved;
1151         __le32 sleep_time;
1152         __le32 tsf_low;
1153         __le32 bcon_timer;
1154 } __attribute__ ((packed));
1155
1156 /* Sleep states.  3945 and 4965 identical. */
1157 enum {
1158         IWL_PM_NO_SLEEP = 0,
1159         IWL_PM_SLP_MAC = 1,
1160         IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
1161         IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
1162         IWL_PM_SLP_PHY = 4,
1163         IWL_PM_SLP_REPENT = 5,
1164         IWL_PM_WAKEUP_BY_TIMER = 6,
1165         IWL_PM_WAKEUP_BY_DRIVER = 7,
1166         IWL_PM_WAKEUP_BY_RFKILL = 8,
1167         /* 3 reserved */
1168         IWL_PM_NUM_OF_MODES = 12,
1169 };
1170
1171 /*
1172  * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
1173  */
1174 #define CARD_STATE_CMD_DISABLE 0x00     /* Put card to sleep */
1175 #define CARD_STATE_CMD_ENABLE  0x01     /* Wake up card */
1176 #define CARD_STATE_CMD_HALT    0x02     /* Power down permanently */
1177 struct iwl4965_card_state_cmd {
1178         __le32 status;          /* CARD_STATE_CMD_* request new power state */
1179 } __attribute__ ((packed));
1180
1181 /*
1182  * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
1183  */
1184 struct iwl4965_card_state_notif {
1185         __le32 flags;
1186 } __attribute__ ((packed));
1187
1188 #define HW_CARD_DISABLED   0x01
1189 #define SW_CARD_DISABLED   0x02
1190 #define RF_CARD_DISABLED   0x04
1191 #define RXON_CARD_DISABLED 0x10
1192
1193 struct iwl4965_ct_kill_config {
1194         __le32   reserved;
1195         __le32   critical_temperature_M;
1196         __le32   critical_temperature_R;
1197 }  __attribute__ ((packed));
1198
1199 /******************************************************************************
1200  * (8)
1201  * Scan Commands, Responses, Notifications:
1202  *
1203  *****************************************************************************/
1204
1205 struct iwl4965_scan_channel {
1206         /* type is defined as:
1207          * 0:0 active (0 - passive)
1208          * 1:4 SSID direct
1209          *     If 1 is set then corresponding SSID IE is transmitted in probe
1210          * 5:7 reserved
1211          */
1212         u8 type;
1213         u8 channel;
1214         struct iwl4965_tx_power tpc;
1215         __le16 active_dwell;
1216         __le16 passive_dwell;
1217 } __attribute__ ((packed));
1218
1219 struct iwl4965_ssid_ie {
1220         u8 id;
1221         u8 len;
1222         u8 ssid[32];
1223 } __attribute__ ((packed));
1224
1225 #define PROBE_OPTION_MAX        0x4
1226 #define TX_CMD_LIFE_TIME_INFINITE       __constant_cpu_to_le32(0xFFFFFFFF)
1227 #define IWL_GOOD_CRC_TH         __constant_cpu_to_le16(1)
1228 #define IWL_MAX_SCAN_SIZE 1024
1229
1230 /*
1231  * REPLY_SCAN_CMD = 0x80 (command)
1232  */
1233 struct iwl4965_scan_cmd {
1234         __le16 len;
1235         u8 reserved0;
1236         u8 channel_count;
1237         __le16 quiet_time;     /* dwell only this long on quiet chnl
1238                                 * (active scan) */
1239         __le16 quiet_plcp_th;  /* quiet chnl is < this # pkts (typ. 1) */
1240         __le16 good_CRC_th;    /* passive -> active promotion threshold */
1241         __le16 rx_chain;
1242         __le32 max_out_time;   /* max usec to be out of associated (service)
1243                                 * chnl */
1244         __le32 suspend_time;   /* pause scan this long when returning to svc
1245                                 * chnl.
1246                                 * 3945 -- 31:24 # beacons, 19:0 additional usec,
1247                                 * 4965 -- 31:22 # beacons, 21:0 additional usec.
1248                                 */
1249         __le32 flags;
1250         __le32 filter_flags;
1251
1252         struct iwl4965_tx_cmd tx_cmd;
1253         struct iwl4965_ssid_ie direct_scan[PROBE_OPTION_MAX];
1254
1255         u8 data[0];
1256         /*
1257          * The channels start after the probe request payload and are of type:
1258          *
1259          * struct iwl4965_scan_channel channels[0];
1260          *
1261          * NOTE:  Only one band of channels can be scanned per pass.  You
1262          * can not mix 2.4GHz channels and 5.2GHz channels and must
1263          * request a scan multiple times (not concurrently)
1264          *
1265          */
1266 } __attribute__ ((packed));
1267
1268 /* Can abort will notify by complete notification with abort status. */
1269 #define CAN_ABORT_STATUS        __constant_cpu_to_le32(0x1)
1270 /* complete notification statuses */
1271 #define ABORT_STATUS            0x2
1272
1273 /*
1274  * REPLY_SCAN_CMD = 0x80 (response)
1275  */
1276 struct iwl4965_scanreq_notification {
1277         __le32 status;          /* 1: okay, 2: cannot fulfill request */
1278 } __attribute__ ((packed));
1279
1280 /*
1281  * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
1282  */
1283 struct iwl4965_scanstart_notification {
1284         __le32 tsf_low;
1285         __le32 tsf_high;
1286         __le32 beacon_timer;
1287         u8 channel;
1288         u8 band;
1289         u8 reserved[2];
1290         __le32 status;
1291 } __attribute__ ((packed));
1292
1293 #define  SCAN_OWNER_STATUS 0x1;
1294 #define  MEASURE_OWNER_STATUS 0x2;
1295
1296 #define NUMBER_OF_STATISTICS 1  /* first __le32 is good CRC */
1297 /*
1298  * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
1299  */
1300 struct iwl4965_scanresults_notification {
1301         u8 channel;
1302         u8 band;
1303         u8 reserved[2];
1304         __le32 tsf_low;
1305         __le32 tsf_high;
1306         __le32 statistics[NUMBER_OF_STATISTICS];
1307 } __attribute__ ((packed));
1308
1309 /*
1310  * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
1311  */
1312 struct iwl4965_scancomplete_notification {
1313         u8 scanned_channels;
1314         u8 status;
1315         u8 reserved;
1316         u8 last_channel;
1317         __le32 tsf_low;
1318         __le32 tsf_high;
1319 } __attribute__ ((packed));
1320
1321
1322 /******************************************************************************
1323  * (9)
1324  * IBSS/AP Commands and Notifications:
1325  *
1326  *****************************************************************************/
1327
1328 /*
1329  * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
1330  */
1331 struct iwl4965_beacon_notif {
1332         struct iwl4965_tx_resp beacon_notify_hdr;
1333         __le32 low_tsf;
1334         __le32 high_tsf;
1335         __le32 ibss_mgr_status;
1336 } __attribute__ ((packed));
1337
1338 /*
1339  * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
1340  */
1341 struct iwl4965_tx_beacon_cmd {
1342         struct iwl4965_tx_cmd tx;
1343         __le16 tim_idx;
1344         u8 tim_size;
1345         u8 reserved1;
1346         struct ieee80211_hdr frame[0];  /* beacon frame */
1347 } __attribute__ ((packed));
1348
1349 /******************************************************************************
1350  * (10)
1351  * Statistics Commands and Notifications:
1352  *
1353  *****************************************************************************/
1354
1355 #define IWL_TEMP_CONVERT 260
1356
1357 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
1358 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
1359 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
1360
1361 /* Used for passing to driver number of successes and failures per rate */
1362 struct rate_histogram {
1363         union {
1364                 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
1365                 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
1366                 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
1367         } success;
1368         union {
1369                 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
1370                 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
1371                 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
1372         } failed;
1373 } __attribute__ ((packed));
1374
1375 /* statistics command response */
1376
1377 struct statistics_rx_phy {
1378         __le32 ina_cnt;
1379         __le32 fina_cnt;
1380         __le32 plcp_err;
1381         __le32 crc32_err;
1382         __le32 overrun_err;
1383         __le32 early_overrun_err;
1384         __le32 crc32_good;
1385         __le32 false_alarm_cnt;
1386         __le32 fina_sync_err_cnt;
1387         __le32 sfd_timeout;
1388         __le32 fina_timeout;
1389         __le32 unresponded_rts;
1390         __le32 rxe_frame_limit_overrun;
1391         __le32 sent_ack_cnt;
1392         __le32 sent_cts_cnt;
1393         __le32 sent_ba_rsp_cnt;
1394         __le32 dsp_self_kill;
1395         __le32 mh_format_err;
1396         __le32 re_acq_main_rssi_sum;
1397         __le32 reserved3;
1398 } __attribute__ ((packed));
1399
1400 struct statistics_rx_ht_phy {
1401         __le32 plcp_err;
1402         __le32 overrun_err;
1403         __le32 early_overrun_err;
1404         __le32 crc32_good;
1405         __le32 crc32_err;
1406         __le32 mh_format_err;
1407         __le32 agg_crc32_good;
1408         __le32 agg_mpdu_cnt;
1409         __le32 agg_cnt;
1410         __le32 reserved2;
1411 } __attribute__ ((packed));
1412
1413 struct statistics_rx_non_phy {
1414         __le32 bogus_cts;       /* CTS received when not expecting CTS */
1415         __le32 bogus_ack;       /* ACK received when not expecting ACK */
1416         __le32 non_bssid_frames;        /* number of frames with BSSID that
1417                                          * doesn't belong to the STA BSSID */
1418         __le32 filtered_frames; /* count frames that were dumped in the
1419                                  * filtering process */
1420         __le32 non_channel_beacons;     /* beacons with our bss id but not on
1421                                          * our serving channel */
1422         __le32 channel_beacons; /* beacons with our bss id and in our
1423                                  * serving channel */
1424         __le32 num_missed_bcon; /* number of missed beacons */
1425         __le32 adc_rx_saturation_time;  /* count in 0.8us units the time the
1426                                          * ADC was in saturation */
1427         __le32 ina_detection_search_time;/* total time (in 0.8us) searched
1428                                           * for INA */
1429         __le32 beacon_silence_rssi_a;   /* RSSI silence after beacon frame */
1430         __le32 beacon_silence_rssi_b;   /* RSSI silence after beacon frame */
1431         __le32 beacon_silence_rssi_c;   /* RSSI silence after beacon frame */
1432         __le32 interference_data_flag;  /* flag for interference data
1433                                          * availability. 1 when data is
1434                                          * available. */
1435         __le32 channel_load;    /* counts RX Enable time */
1436         __le32 dsp_false_alarms;        /* DSP false alarm (both OFDM
1437                                          * and CCK) counter */
1438         __le32 beacon_rssi_a;
1439         __le32 beacon_rssi_b;
1440         __le32 beacon_rssi_c;
1441         __le32 beacon_energy_a;
1442         __le32 beacon_energy_b;
1443         __le32 beacon_energy_c;
1444 } __attribute__ ((packed));
1445
1446 struct statistics_rx {
1447         struct statistics_rx_phy ofdm;
1448         struct statistics_rx_phy cck;
1449         struct statistics_rx_non_phy general;
1450         struct statistics_rx_ht_phy ofdm_ht;
1451 } __attribute__ ((packed));
1452
1453 struct statistics_tx_non_phy_agg {
1454         __le32 ba_timeout;
1455         __le32 ba_reschedule_frames;
1456         __le32 scd_query_agg_frame_cnt;
1457         __le32 scd_query_no_agg;
1458         __le32 scd_query_agg;
1459         __le32 scd_query_mismatch;
1460         __le32 frame_not_ready;
1461         __le32 underrun;
1462         __le32 bt_prio_kill;
1463         __le32 rx_ba_rsp_cnt;
1464         __le32 reserved2;
1465         __le32 reserved3;
1466 } __attribute__ ((packed));
1467
1468 struct statistics_tx {
1469         __le32 preamble_cnt;
1470         __le32 rx_detected_cnt;
1471         __le32 bt_prio_defer_cnt;
1472         __le32 bt_prio_kill_cnt;
1473         __le32 few_bytes_cnt;
1474         __le32 cts_timeout;
1475         __le32 ack_timeout;
1476         __le32 expected_ack_cnt;
1477         __le32 actual_ack_cnt;
1478         __le32 dump_msdu_cnt;
1479         __le32 burst_abort_next_frame_mismatch_cnt;
1480         __le32 burst_abort_missing_next_frame_cnt;
1481         __le32 cts_timeout_collision;
1482         __le32 ack_or_ba_timeout_collision;
1483         struct statistics_tx_non_phy_agg agg;
1484 } __attribute__ ((packed));
1485
1486 struct statistics_dbg {
1487         __le32 burst_check;
1488         __le32 burst_count;
1489         __le32 reserved[4];
1490 } __attribute__ ((packed));
1491
1492 struct statistics_div {
1493         __le32 tx_on_a;
1494         __le32 tx_on_b;
1495         __le32 exec_time;
1496         __le32 probe_time;
1497         __le32 reserved1;
1498         __le32 reserved2;
1499 } __attribute__ ((packed));
1500
1501 struct statistics_general {
1502         __le32 temperature;
1503         __le32 temperature_m;
1504         struct statistics_dbg dbg;
1505         __le32 sleep_time;
1506         __le32 slots_out;
1507         __le32 slots_idle;
1508         __le32 ttl_timestamp;
1509         struct statistics_div div;
1510         __le32 rx_enable_counter;
1511         __le32 reserved1;
1512         __le32 reserved2;
1513         __le32 reserved3;
1514 } __attribute__ ((packed));
1515
1516 /*
1517  * REPLY_STATISTICS_CMD = 0x9c,
1518  * 3945 and 4965 identical.
1519  *
1520  * This command triggers an immediate response containing uCode statistics.
1521  * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
1522  *
1523  * If the CLEAR_STATS configuration flag is set, uCode will clear its
1524  * internal copy of the statistics (counters) after issuing the response.
1525  * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
1526  *
1527  * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
1528  * STATISTICS_NOTIFICATIONs after received beacons (see below).  This flag
1529  * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
1530  */
1531 #define IWL_STATS_CONF_CLEAR_STATS __constant_cpu_to_le32(0x1)  /* see above */
1532 #define IWL_STATS_CONF_DISABLE_NOTIF __constant_cpu_to_le32(0x2)/* see above */
1533 struct iwl4965_statistics_cmd {
1534         __le32 configuration_flags;     /* IWL_STATS_CONF_* */
1535 } __attribute__ ((packed));
1536
1537 /*
1538  * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
1539  *
1540  * By default, uCode issues this notification after receiving a beacon
1541  * while associated.  To disable this behavior, set DISABLE_NOTIF flag in the
1542  * REPLY_STATISTICS_CMD 0x9c, above.
1543  *
1544  * Statistics counters continue to increment beacon after beacon, but are
1545  * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
1546  * 0x9c with CLEAR_STATS bit set (see above).
1547  *
1548  * uCode also issues this notification during scans.  uCode clears statistics
1549  * appropriately so that each notification contains statistics for only the
1550  * one channel that has just been scanned.
1551  */
1552 #define STATISTICS_REPLY_FLG_BAND_24G_MSK         __constant_cpu_to_le32(0x2)
1553 #define STATISTICS_REPLY_FLG_FAT_MODE_MSK         __constant_cpu_to_le32(0x8)
1554 struct iwl4965_notif_statistics {
1555         __le32 flag;
1556         struct statistics_rx rx;
1557         struct statistics_tx tx;
1558         struct statistics_general general;
1559 } __attribute__ ((packed));
1560
1561
1562 /*
1563  * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
1564  */
1565 /* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row,
1566  * then this notification will be sent. */
1567 #define CONSECUTIVE_MISSED_BCONS_TH 20
1568
1569 struct iwl4965_missed_beacon_notif {
1570         __le32 consequtive_missed_beacons;
1571         __le32 total_missed_becons;
1572         __le32 num_expected_beacons;
1573         __le32 num_recvd_beacons;
1574 } __attribute__ ((packed));
1575
1576 /******************************************************************************
1577  * (11)
1578  * Rx Calibration Commands:
1579  *
1580  *****************************************************************************/
1581
1582 #define PHY_CALIBRATE_DIFF_GAIN_CMD (7)
1583 #define HD_TABLE_SIZE  (11)
1584
1585 struct iwl4965_sensitivity_cmd {
1586         __le16 control;
1587         __le16 table[HD_TABLE_SIZE];
1588 } __attribute__ ((packed));
1589
1590 struct iwl4965_calibration_cmd {
1591         u8 opCode;
1592         u8 flags;
1593         __le16 reserved;
1594         s8 diff_gain_a;
1595         s8 diff_gain_b;
1596         s8 diff_gain_c;
1597         u8 reserved1;
1598 } __attribute__ ((packed));
1599
1600 /******************************************************************************
1601  * (12)
1602  * Miscellaneous Commands:
1603  *
1604  *****************************************************************************/
1605
1606 /*
1607  * LEDs Command & Response
1608  * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
1609  *
1610  * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
1611  * this command turns it on or off, or sets up a periodic blinking cycle.
1612  */
1613 struct iwl4965_led_cmd {
1614         __le32 interval;        /* "interval" in uSec */
1615         u8 id;                  /* 1: Activity, 2: Link, 3: Tech */
1616         u8 off;                 /* # intervals off while blinking;
1617                                  * "0", with >0 "on" value, turns LED on */
1618         u8 on;                  /* # intervals on while blinking;
1619                                  * "0", regardless of "off", turns LED off */
1620         u8 reserved;
1621 } __attribute__ ((packed));
1622
1623 /******************************************************************************
1624  * (13)
1625  * Union of all expected notifications/responses:
1626  *
1627  *****************************************************************************/
1628
1629 struct iwl4965_rx_packet {
1630         __le32 len;
1631         struct iwl4965_cmd_header hdr;
1632         union {
1633                 struct iwl4965_alive_resp alive_frame;
1634                 struct iwl4965_rx_frame rx_frame;
1635                 struct iwl4965_tx_resp tx_resp;
1636                 struct iwl4965_spectrum_notification spectrum_notif;
1637                 struct iwl4965_csa_notification csa_notif;
1638                 struct iwl4965_error_resp err_resp;
1639                 struct iwl4965_card_state_notif card_state_notif;
1640                 struct iwl4965_beacon_notif beacon_status;
1641                 struct iwl4965_add_sta_resp add_sta;
1642                 struct iwl4965_sleep_notification sleep_notif;
1643                 struct iwl4965_spectrum_resp spectrum;
1644                 struct iwl4965_notif_statistics stats;
1645                 struct iwl4965_compressed_ba_resp compressed_ba;
1646                 struct iwl4965_missed_beacon_notif missed_beacon;
1647                 __le32 status;
1648                 u8 raw[0];
1649         } u;
1650 } __attribute__ ((packed));
1651
1652 #define IWL_RX_FRAME_SIZE        (4 + sizeof(struct iwl4965_rx_frame))
1653
1654 #endif                          /* __iwl4965_commands_h__ */