iwlwifi: clean up some unused definitions in iwl-4965.h and iwl-3945.h
[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 #define STA_FLG_RTS_MIMO_PROT_MSK       __constant_cpu_to_le32(1 << 17)
519 #define STA_FLG_AGG_MPDU_8US_MSK        __constant_cpu_to_le32(1 << 18)
520 #define STA_FLG_MAX_AGG_SIZE_POS        (19)
521 #define STA_FLG_MAX_AGG_SIZE_MSK        __constant_cpu_to_le32(3 << 19)
522 #define STA_FLG_FAT_EN_MSK              __constant_cpu_to_le32(1 << 21)
523 #define STA_FLG_MIMO_DIS_MSK            __constant_cpu_to_le32(1 << 22)
524 #define STA_FLG_AGG_MPDU_DENSITY_POS    (23)
525 #define STA_FLG_AGG_MPDU_DENSITY_MSK    __constant_cpu_to_le32(7 << 23)
526
527 #define STA_CONTROL_MODIFY_MSK          0x01
528
529 /* key flags __le16*/
530 #define STA_KEY_FLG_ENCRYPT_MSK __constant_cpu_to_le16(0x7)
531 #define STA_KEY_FLG_NO_ENC      __constant_cpu_to_le16(0x0)
532 #define STA_KEY_FLG_WEP         __constant_cpu_to_le16(0x1)
533 #define STA_KEY_FLG_CCMP        __constant_cpu_to_le16(0x2)
534 #define STA_KEY_FLG_TKIP        __constant_cpu_to_le16(0x3)
535
536 #define STA_KEY_FLG_KEYID_POS   8
537 #define STA_KEY_FLG_INVALID     __constant_cpu_to_le16(0x0800)
538
539 /* modify flags  */
540 #define STA_MODIFY_KEY_MASK             0x01
541 #define STA_MODIFY_TID_DISABLE_TX       0x02
542 #define STA_MODIFY_TX_RATE_MSK          0x04
543 #define STA_MODIFY_ADDBA_TID_MSK        0x08
544 #define STA_MODIFY_DELBA_TID_MSK        0x10
545 #define BUILD_RAxTID(sta_id, tid)       (((sta_id) << 4) + (tid))
546
547 struct iwl4965_keyinfo {
548         __le16 key_flags;
549         u8 tkip_rx_tsc_byte2;   /* TSC[2] for key mix ph1 detection */
550         u8 reserved1;
551         __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
552         __le16 reserved2;
553         u8 key[16];             /* 16-byte unicast decryption key */
554 } __attribute__ ((packed));
555
556 struct sta_id_modify {
557         u8 addr[ETH_ALEN];
558         __le16 reserved1;
559         u8 sta_id;
560         u8 modify_mask;
561         __le16 reserved2;
562 } __attribute__ ((packed));
563
564 /*
565  * REPLY_ADD_STA = 0x18 (command)
566  */
567 struct iwl4965_addsta_cmd {
568         u8 mode;
569         u8 reserved[3];
570         struct sta_id_modify sta;
571         struct iwl4965_keyinfo key;
572         __le32 station_flags;
573         __le32 station_flags_msk;
574         __le16 tid_disable_tx;
575         __le16  reserved1;
576         u8 add_immediate_ba_tid;
577         u8 remove_immediate_ba_tid;
578         __le16 add_immediate_ba_ssn;
579         __le32 reserved2;
580 } __attribute__ ((packed));
581
582 /*
583  * REPLY_ADD_STA = 0x18 (response)
584  */
585 struct iwl4965_add_sta_resp {
586         u8 status;
587 } __attribute__ ((packed));
588
589 #define ADD_STA_SUCCESS_MSK              0x1
590
591 /******************************************************************************
592  * (4)
593  * Rx Responses:
594  *
595  *****************************************************************************/
596
597 struct iwl4965_rx_frame_stats {
598         u8 phy_count;
599         u8 id;
600         u8 rssi;
601         u8 agc;
602         __le16 sig_avg;
603         __le16 noise_diff;
604         u8 payload[0];
605 } __attribute__ ((packed));
606
607 struct iwl4965_rx_frame_hdr {
608         __le16 channel;
609         __le16 phy_flags;
610         u8 reserved1;
611         u8 rate;
612         __le16 len;
613         u8 payload[0];
614 } __attribute__ ((packed));
615
616 #define RX_RES_STATUS_NO_CRC32_ERROR    __constant_cpu_to_le32(1 << 0)
617 #define RX_RES_STATUS_NO_RXE_OVERFLOW   __constant_cpu_to_le32(1 << 1)
618
619 #define RX_RES_PHY_FLAGS_BAND_24_MSK    __constant_cpu_to_le16(1 << 0)
620 #define RX_RES_PHY_FLAGS_MOD_CCK_MSK            __constant_cpu_to_le16(1 << 1)
621 #define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK     __constant_cpu_to_le16(1 << 2)
622 #define RX_RES_PHY_FLAGS_NARROW_BAND_MSK        __constant_cpu_to_le16(1 << 3)
623 #define RX_RES_PHY_FLAGS_ANTENNA_MSK            __constant_cpu_to_le16(0xf0)
624
625 #define RX_RES_STATUS_SEC_TYPE_MSK      (0x7 << 8)
626 #define RX_RES_STATUS_SEC_TYPE_NONE     (0x0 << 8)
627 #define RX_RES_STATUS_SEC_TYPE_WEP      (0x1 << 8)
628 #define RX_RES_STATUS_SEC_TYPE_CCMP     (0x2 << 8)
629 #define RX_RES_STATUS_SEC_TYPE_TKIP     (0x3 << 8)
630
631 #define RX_RES_STATUS_DECRYPT_TYPE_MSK  (0x3 << 11)
632 #define RX_RES_STATUS_NOT_DECRYPT       (0x0 << 11)
633 #define RX_RES_STATUS_DECRYPT_OK        (0x3 << 11)
634 #define RX_RES_STATUS_BAD_ICV_MIC       (0x1 << 11)
635 #define RX_RES_STATUS_BAD_KEY_TTAK      (0x2 << 11)
636
637 struct iwl4965_rx_frame_end {
638         __le32 status;
639         __le64 timestamp;
640         __le32 beacon_timestamp;
641 } __attribute__ ((packed));
642
643 /*
644  * REPLY_3945_RX = 0x1b (response only, not a command)
645  *
646  * NOTE:  DO NOT dereference from casts to this structure
647  * It is provided only for calculating minimum data set size.
648  * The actual offsets of the hdr and end are dynamic based on
649  * stats.phy_count
650  */
651 struct iwl4965_rx_frame {
652         struct iwl4965_rx_frame_stats stats;
653         struct iwl4965_rx_frame_hdr hdr;
654         struct iwl4965_rx_frame_end end;
655 } __attribute__ ((packed));
656
657 /* Fixed (non-configurable) rx data from phy */
658 #define RX_PHY_FLAGS_ANTENNAE_OFFSET            (4)
659 #define RX_PHY_FLAGS_ANTENNAE_MASK              (0x70)
660 #define IWL_AGC_DB_MASK         (0x3f80)        /* MASK(7,13) */
661 #define IWL_AGC_DB_POS          (7)
662 struct iwl4965_rx_non_cfg_phy {
663         __le16 ant_selection;   /* ant A bit 4, ant B bit 5, ant C bit 6 */
664         __le16 agc_info;        /* agc code 0:6, agc dB 7:13, reserved 14:15 */
665         u8 rssi_info[6];        /* we use even entries, 0/2/4 for A/B/C rssi */
666         u8 pad[0];
667 } __attribute__ ((packed));
668
669 /*
670  * REPLY_4965_RX = 0xc3 (response only, not a command)
671  * Used only for legacy (non 11n) frames.
672  */
673 #define RX_RES_PHY_CNT 14
674 struct iwl4965_rx_phy_res {
675         u8 non_cfg_phy_cnt;     /* non configurable DSP phy data byte count */
676         u8 cfg_phy_cnt;         /* configurable DSP phy data byte count */
677         u8 stat_id;             /* configurable DSP phy data set ID */
678         u8 reserved1;
679         __le64 timestamp;       /* TSF at on air rise */
680         __le32 beacon_time_stamp; /* beacon at on-air rise */
681         __le16 phy_flags;       /* general phy flags: band, modulation, ... */
682         __le16 channel;         /* channel number */
683         __le16 non_cfg_phy[RX_RES_PHY_CNT];     /* upto 14 phy entries */
684         __le32 reserved2;
685         __le32 rate_n_flags;
686         __le16 byte_count;              /* frame's byte-count */
687         __le16 reserved3;
688 } __attribute__ ((packed));
689
690 struct iwl4965_rx_mpdu_res_start {
691         __le16 byte_count;
692         __le16 reserved;
693 } __attribute__ ((packed));
694
695
696 /******************************************************************************
697  * (5)
698  * Tx Commands & Responses:
699  *
700  *****************************************************************************/
701
702 /* Tx flags */
703 #define TX_CMD_FLG_RTS_MSK __constant_cpu_to_le32(1 << 1)
704 #define TX_CMD_FLG_CTS_MSK __constant_cpu_to_le32(1 << 2)
705 #define TX_CMD_FLG_ACK_MSK __constant_cpu_to_le32(1 << 3)
706 #define TX_CMD_FLG_STA_RATE_MSK __constant_cpu_to_le32(1 << 4)
707 #define TX_CMD_FLG_IMM_BA_RSP_MASK  __constant_cpu_to_le32(1 << 6)
708 #define TX_CMD_FLG_FULL_TXOP_PROT_MSK __constant_cpu_to_le32(1 << 7)
709 #define TX_CMD_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0xf00)
710 #define TX_CMD_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8)
711 #define TX_CMD_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9)
712
713 /* ucode ignores BT priority for this frame */
714 #define TX_CMD_FLG_BT_DIS_MSK __constant_cpu_to_le32(1 << 12)
715
716 /* ucode overrides sequence control */
717 #define TX_CMD_FLG_SEQ_CTL_MSK __constant_cpu_to_le32(1 << 13)
718
719 /* signal that this frame is non-last MPDU */
720 #define TX_CMD_FLG_MORE_FRAG_MSK __constant_cpu_to_le32(1 << 14)
721
722 /* calculate TSF in outgoing frame */
723 #define TX_CMD_FLG_TSF_MSK __constant_cpu_to_le32(1 << 16)
724
725 /* activate TX calibration. */
726 #define TX_CMD_FLG_CALIB_MSK __constant_cpu_to_le32(1 << 17)
727
728 /* signals that 2 bytes pad was inserted
729    after the MAC header */
730 #define TX_CMD_FLG_MH_PAD_MSK __constant_cpu_to_le32(1 << 20)
731
732 /* HCCA-AP - disable duration overwriting. */
733 #define TX_CMD_FLG_DUR_MSK __constant_cpu_to_le32(1 << 25)
734
735 /*
736  * TX command security control
737  */
738 #define TX_CMD_SEC_WEP          0x01
739 #define TX_CMD_SEC_CCM          0x02
740 #define TX_CMD_SEC_TKIP         0x03
741 #define TX_CMD_SEC_MSK          0x03
742 #define TX_CMD_SEC_SHIFT        6
743 #define TX_CMD_SEC_KEY128       0x08
744
745 /*
746  * TX command Frame life time
747  */
748
749 struct iwl4965_dram_scratch {
750         u8 try_cnt;
751         u8 bt_kill_cnt;
752         __le16 reserved;
753 } __attribute__ ((packed));
754
755 /*
756  * REPLY_TX = 0x1c (command)
757  */
758 struct iwl4965_tx_cmd {
759         __le16 len;
760         __le16 next_frame_len;
761         __le32 tx_flags;
762         struct iwl4965_dram_scratch scratch;
763         __le32 rate_n_flags;
764         u8 sta_id;
765         u8 sec_ctl;
766         u8 initial_rate_index;
767         u8 reserved;
768         u8 key[16];
769         __le16 next_frame_flags;
770         __le16 reserved2;
771         union {
772                 __le32 life_time;
773                 __le32 attempt;
774         } stop_time;
775         __le32 dram_lsb_ptr;
776         u8 dram_msb_ptr;
777         u8 rts_retry_limit;     /*byte 50 */
778         u8 data_retry_limit;    /*byte 51 */
779         u8 tid_tspec;
780         union {
781                 __le16 pm_frame_timeout;
782                 __le16 attempt_duration;
783         } timeout;
784         __le16 driver_txop;
785         u8 payload[0];
786         struct ieee80211_hdr hdr[0];
787 } __attribute__ ((packed));
788
789 /* TX command response is sent after *all* transmission attempts.
790  *
791  * NOTES:
792  *
793  * TX_STATUS_FAIL_NEXT_FRAG
794  *
795  * If the fragment flag in the MAC header for the frame being transmitted
796  * is set and there is insufficient time to transmit the next frame, the
797  * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
798  *
799  * TX_STATUS_FIFO_UNDERRUN
800  *
801  * Indicates the host did not provide bytes to the FIFO fast enough while
802  * a TX was in progress.
803  *
804  * TX_STATUS_FAIL_MGMNT_ABORT
805  *
806  * This status is only possible if the ABORT ON MGMT RX parameter was
807  * set to true with the TX command.
808  *
809  * If the MSB of the status parameter is set then an abort sequence is
810  * required.  This sequence consists of the host activating the TX Abort
811  * control line, and then waiting for the TX Abort command response.  This
812  * indicates that a the device is no longer in a transmit state, and that the
813  * command FIFO has been cleared.  The host must then deactivate the TX Abort
814  * control line.  Receiving is still allowed in this case.
815  */
816 enum {
817         TX_STATUS_SUCCESS = 0x01,
818         TX_STATUS_DIRECT_DONE = 0x02,
819         TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
820         TX_STATUS_FAIL_LONG_LIMIT = 0x83,
821         TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
822         TX_STATUS_FAIL_MGMNT_ABORT = 0x85,
823         TX_STATUS_FAIL_NEXT_FRAG = 0x86,
824         TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
825         TX_STATUS_FAIL_DEST_PS = 0x88,
826         TX_STATUS_FAIL_ABORTED = 0x89,
827         TX_STATUS_FAIL_BT_RETRY = 0x8a,
828         TX_STATUS_FAIL_STA_INVALID = 0x8b,
829         TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
830         TX_STATUS_FAIL_TID_DISABLE = 0x8d,
831         TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
832         TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
833         TX_STATUS_FAIL_TX_LOCKED = 0x90,
834         TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
835 };
836
837 #define TX_PACKET_MODE_REGULAR          0x0000
838 #define TX_PACKET_MODE_BURST_SEQ        0x0100
839 #define TX_PACKET_MODE_BURST_FIRST      0x0200
840
841 enum {
842         TX_POWER_PA_NOT_ACTIVE = 0x0,
843 };
844
845 enum {
846         TX_STATUS_MSK = 0x000000ff,     /* bits 0:7 */
847         TX_STATUS_DELAY_MSK = 0x00000040,
848         TX_STATUS_ABORT_MSK = 0x00000080,
849         TX_PACKET_MODE_MSK = 0x0000ff00,        /* bits 8:15 */
850         TX_FIFO_NUMBER_MSK = 0x00070000,        /* bits 16:18 */
851         TX_RESERVED = 0x00780000,       /* bits 19:22 */
852         TX_POWER_PA_DETECT_MSK = 0x7f800000,    /* bits 23:30 */
853         TX_ABORT_REQUIRED_MSK = 0x80000000,     /* bits 31:31 */
854 };
855
856 /* *******************************
857  * TX aggregation state
858  ******************************* */
859
860 enum {
861         AGG_TX_STATE_TRANSMITTED = 0x00,
862         AGG_TX_STATE_UNDERRUN_MSK = 0x01,
863         AGG_TX_STATE_BT_PRIO_MSK = 0x02,
864         AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
865         AGG_TX_STATE_ABORT_MSK = 0x08,
866         AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
867         AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
868         AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
869         AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
870         AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
871         AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
872         AGG_TX_STATE_DUMP_TX_MSK = 0x200,
873         AGG_TX_STATE_DELAY_TX_MSK = 0x400
874 };
875
876 #define AGG_TX_STATE_LAST_SENT_MSK \
877 (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
878  AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
879  AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
880
881 #define AGG_TX_STATE_TRY_CNT_POS 12
882 #define AGG_TX_STATE_TRY_CNT_MSK 0xf000
883
884 #define AGG_TX_STATE_SEQ_NUM_POS 16
885 #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
886
887 /*
888  * REPLY_TX = 0x1c (response)
889  */
890 struct iwl4965_tx_resp {
891         u8 frame_count;         /* 1 no aggregation, >1 aggregation */
892         u8 bt_kill_count;
893         u8 failure_rts;
894         u8 failure_frame;
895         __le32 rate_n_flags;
896         __le16 wireless_media_time;
897         __le16 reserved;
898         __le32 pa_power1;
899         __le32 pa_power2;
900         __le32 status;  /* TX status (for aggregation status of 1st frame) */
901 } __attribute__ ((packed));
902
903 /*
904  * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
905  */
906 struct iwl4965_compressed_ba_resp {
907         __le32 sta_addr_lo32;
908         __le16 sta_addr_hi16;
909         __le16 reserved;
910         u8 sta_id;
911         u8 tid;
912         __le16 ba_seq_ctl;
913         __le32 ba_bitmap0;
914         __le32 ba_bitmap1;
915         __le16 scd_flow;
916         __le16 scd_ssn;
917 } __attribute__ ((packed));
918
919 /*
920  * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
921  */
922 struct iwl4965_txpowertable_cmd {
923         u8 band;                /* 0: 5 GHz, 1: 2.4 GHz */
924         u8 reserved;
925         __le16 channel;
926         struct iwl4965_tx_power_db tx_power;
927 } __attribute__ ((packed));
928
929 /*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
930 #define  LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK    (1<<0)
931
932 #define  LINK_QUAL_AC_NUM AC_NUM
933 #define  LINK_QUAL_MAX_RETRY_NUM 16
934
935 #define  LINK_QUAL_ANT_A_MSK (1<<0)
936 #define  LINK_QUAL_ANT_B_MSK (1<<1)
937 #define  LINK_QUAL_ANT_MSK   (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
938
939 struct iwl4965_link_qual_general_params {
940         u8 flags;
941         u8 mimo_delimiter;
942         u8 single_stream_ant_msk;
943         u8 dual_stream_ant_msk;
944         u8 start_rate_index[LINK_QUAL_AC_NUM];
945 } __attribute__ ((packed));
946
947 struct iwl4965_link_qual_agg_params {
948         __le16 agg_time_limit;
949         u8 agg_dis_start_th;
950         u8 agg_frame_cnt_limit;
951         __le32 reserved;
952 } __attribute__ ((packed));
953
954 /*
955  * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
956  */
957 struct iwl4965_link_quality_cmd {
958         u8 sta_id;
959         u8 reserved1;
960         __le16 control;
961         struct iwl4965_link_qual_general_params general_params;
962         struct iwl4965_link_qual_agg_params agg_params;
963         struct {
964                 __le32 rate_n_flags;
965         } rs_table[LINK_QUAL_MAX_RETRY_NUM];
966         __le32 reserved2;
967 } __attribute__ ((packed));
968
969 /*
970  * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
971  */
972 struct iwl4965_bt_cmd {
973         u8 flags;
974         u8 lead_time;
975         u8 max_kill;
976         u8 reserved;
977         __le32 kill_ack_mask;
978         __le32 kill_cts_mask;
979 } __attribute__ ((packed));
980
981 /******************************************************************************
982  * (6)
983  * Spectrum Management (802.11h) Commands, Responses, Notifications:
984  *
985  *****************************************************************************/
986
987 /*
988  * Spectrum Management
989  */
990 #define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK         | \
991                                  RXON_FILTER_CTL2HOST_MSK        | \
992                                  RXON_FILTER_ACCEPT_GRP_MSK      | \
993                                  RXON_FILTER_DIS_DECRYPT_MSK     | \
994                                  RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
995                                  RXON_FILTER_ASSOC_MSK           | \
996                                  RXON_FILTER_BCON_AWARE_MSK)
997
998 struct iwl4965_measure_channel {
999         __le32 duration;        /* measurement duration in extended beacon
1000                                  * format */
1001         u8 channel;             /* channel to measure */
1002         u8 type;                /* see enum iwl4965_measure_type */
1003         __le16 reserved;
1004 } __attribute__ ((packed));
1005
1006 /*
1007  * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
1008  */
1009 struct iwl4965_spectrum_cmd {
1010         __le16 len;             /* number of bytes starting from token */
1011         u8 token;               /* token id */
1012         u8 id;                  /* measurement id -- 0 or 1 */
1013         u8 origin;              /* 0 = TGh, 1 = other, 2 = TGk */
1014         u8 periodic;            /* 1 = periodic */
1015         __le16 path_loss_timeout;
1016         __le32 start_time;      /* start time in extended beacon format */
1017         __le32 reserved2;
1018         __le32 flags;           /* rxon flags */
1019         __le32 filter_flags;    /* rxon filter flags */
1020         __le16 channel_count;   /* minimum 1, maximum 10 */
1021         __le16 reserved3;
1022         struct iwl4965_measure_channel channels[10];
1023 } __attribute__ ((packed));
1024
1025 /*
1026  * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
1027  */
1028 struct iwl4965_spectrum_resp {
1029         u8 token;
1030         u8 id;                  /* id of the prior command replaced, or 0xff */
1031         __le16 status;          /* 0 - command will be handled
1032                                  * 1 - cannot handle (conflicts with another
1033                                  *     measurement) */
1034 } __attribute__ ((packed));
1035
1036 enum iwl4965_measurement_state {
1037         IWL_MEASUREMENT_START = 0,
1038         IWL_MEASUREMENT_STOP = 1,
1039 };
1040
1041 enum iwl4965_measurement_status {
1042         IWL_MEASUREMENT_OK = 0,
1043         IWL_MEASUREMENT_CONCURRENT = 1,
1044         IWL_MEASUREMENT_CSA_CONFLICT = 2,
1045         IWL_MEASUREMENT_TGH_CONFLICT = 3,
1046         /* 4-5 reserved */
1047         IWL_MEASUREMENT_STOPPED = 6,
1048         IWL_MEASUREMENT_TIMEOUT = 7,
1049         IWL_MEASUREMENT_PERIODIC_FAILED = 8,
1050 };
1051
1052 #define NUM_ELEMENTS_IN_HISTOGRAM 8
1053
1054 struct iwl4965_measurement_histogram {
1055         __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
1056         __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM];  /* in 1usec counts */
1057 } __attribute__ ((packed));
1058
1059 /* clear channel availability counters */
1060 struct iwl4965_measurement_cca_counters {
1061         __le32 ofdm;
1062         __le32 cck;
1063 } __attribute__ ((packed));
1064
1065 enum iwl4965_measure_type {
1066         IWL_MEASURE_BASIC = (1 << 0),
1067         IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
1068         IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
1069         IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
1070         IWL_MEASURE_FRAME = (1 << 4),
1071         /* bits 5:6 are reserved */
1072         IWL_MEASURE_IDLE = (1 << 7),
1073 };
1074
1075 /*
1076  * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
1077  */
1078 struct iwl4965_spectrum_notification {
1079         u8 id;                  /* measurement id -- 0 or 1 */
1080         u8 token;
1081         u8 channel_index;       /* index in measurement channel list */
1082         u8 state;               /* 0 - start, 1 - stop */
1083         __le32 start_time;      /* lower 32-bits of TSF */
1084         u8 band;                /* 0 - 5.2GHz, 1 - 2.4GHz */
1085         u8 channel;
1086         u8 type;                /* see enum iwl4965_measurement_type */
1087         u8 reserved1;
1088         /* NOTE:  cca_ofdm, cca_cck, basic_type, and histogram are only only
1089          * valid if applicable for measurement type requested. */
1090         __le32 cca_ofdm;        /* cca fraction time in 40Mhz clock periods */
1091         __le32 cca_cck;         /* cca fraction time in 44Mhz clock periods */
1092         __le32 cca_time;        /* channel load time in usecs */
1093         u8 basic_type;          /* 0 - bss, 1 - ofdm preamble, 2 -
1094                                  * unidentified */
1095         u8 reserved2[3];
1096         struct iwl4965_measurement_histogram histogram;
1097         __le32 stop_time;       /* lower 32-bits of TSF */
1098         __le32 status;          /* see iwl4965_measurement_status */
1099 } __attribute__ ((packed));
1100
1101 /******************************************************************************
1102  * (7)
1103  * Power Management Commands, Responses, Notifications:
1104  *
1105  *****************************************************************************/
1106
1107 /**
1108  * struct iwl4965_powertable_cmd - Power Table Command
1109  * @flags: See below:
1110  *
1111  * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
1112  *
1113  * PM allow:
1114  *   bit 0 - '0' Driver not allow power management
1115  *           '1' Driver allow PM (use rest of parameters)
1116  * uCode send sleep notifications:
1117  *   bit 1 - '0' Don't send sleep notification
1118  *           '1' send sleep notification (SEND_PM_NOTIFICATION)
1119  * Sleep over DTIM
1120  *   bit 2 - '0' PM have to walk up every DTIM
1121  *           '1' PM could sleep over DTIM till listen Interval.
1122  * PCI power managed
1123  *   bit 3 - '0' (PCI_LINK_CTRL & 0x1)
1124  *           '1' !(PCI_LINK_CTRL & 0x1)
1125  * Force sleep Modes
1126  *   bit 31/30- '00' use both mac/xtal sleeps
1127  *              '01' force Mac sleep
1128  *              '10' force xtal sleep
1129  *              '11' Illegal set
1130  *
1131  * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
1132  * ucode assume sleep over DTIM is allowed and we don't need to wakeup
1133  * for every DTIM.
1134  */
1135 #define IWL_POWER_VEC_SIZE 5
1136
1137 #define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK        __constant_cpu_to_le16(1<<0)
1138 #define IWL_POWER_SLEEP_OVER_DTIM_MSK           __constant_cpu_to_le16(1<<2)
1139 #define IWL_POWER_PCI_PM_MSK                    __constant_cpu_to_le16(1<<3)
1140
1141 struct iwl4965_powertable_cmd {
1142         __le16 flags;
1143         u8 keep_alive_seconds;
1144         u8 debug_flags;
1145         __le32 rx_data_timeout;
1146         __le32 tx_data_timeout;
1147         __le32 sleep_interval[IWL_POWER_VEC_SIZE];
1148         __le32 keep_alive_beacons;
1149 } __attribute__ ((packed));
1150
1151 /*
1152  * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
1153  * 3945 and 4965 identical.
1154  */
1155 struct iwl4965_sleep_notification {
1156         u8 pm_sleep_mode;
1157         u8 pm_wakeup_src;
1158         __le16 reserved;
1159         __le32 sleep_time;
1160         __le32 tsf_low;
1161         __le32 bcon_timer;
1162 } __attribute__ ((packed));
1163
1164 /* Sleep states.  3945 and 4965 identical. */
1165 enum {
1166         IWL_PM_NO_SLEEP = 0,
1167         IWL_PM_SLP_MAC = 1,
1168         IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
1169         IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
1170         IWL_PM_SLP_PHY = 4,
1171         IWL_PM_SLP_REPENT = 5,
1172         IWL_PM_WAKEUP_BY_TIMER = 6,
1173         IWL_PM_WAKEUP_BY_DRIVER = 7,
1174         IWL_PM_WAKEUP_BY_RFKILL = 8,
1175         /* 3 reserved */
1176         IWL_PM_NUM_OF_MODES = 12,
1177 };
1178
1179 /*
1180  * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
1181  */
1182 #define CARD_STATE_CMD_DISABLE 0x00     /* Put card to sleep */
1183 #define CARD_STATE_CMD_ENABLE  0x01     /* Wake up card */
1184 #define CARD_STATE_CMD_HALT    0x02     /* Power down permanently */
1185 struct iwl4965_card_state_cmd {
1186         __le32 status;          /* CARD_STATE_CMD_* request new power state */
1187 } __attribute__ ((packed));
1188
1189 /*
1190  * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
1191  */
1192 struct iwl4965_card_state_notif {
1193         __le32 flags;
1194 } __attribute__ ((packed));
1195
1196 #define HW_CARD_DISABLED   0x01
1197 #define SW_CARD_DISABLED   0x02
1198 #define RF_CARD_DISABLED   0x04
1199 #define RXON_CARD_DISABLED 0x10
1200
1201 struct iwl4965_ct_kill_config {
1202         __le32   reserved;
1203         __le32   critical_temperature_M;
1204         __le32   critical_temperature_R;
1205 }  __attribute__ ((packed));
1206
1207 /******************************************************************************
1208  * (8)
1209  * Scan Commands, Responses, Notifications:
1210  *
1211  *****************************************************************************/
1212
1213 struct iwl4965_scan_channel {
1214         /* type is defined as:
1215          * 0:0 active (0 - passive)
1216          * 1:4 SSID direct
1217          *     If 1 is set then corresponding SSID IE is transmitted in probe
1218          * 5:7 reserved
1219          */
1220         u8 type;
1221         u8 channel;
1222         struct iwl4965_tx_power tpc;
1223         __le16 active_dwell;
1224         __le16 passive_dwell;
1225 } __attribute__ ((packed));
1226
1227 struct iwl4965_ssid_ie {
1228         u8 id;
1229         u8 len;
1230         u8 ssid[32];
1231 } __attribute__ ((packed));
1232
1233 #define PROBE_OPTION_MAX        0x4
1234 #define TX_CMD_LIFE_TIME_INFINITE       __constant_cpu_to_le32(0xFFFFFFFF)
1235 #define IWL_GOOD_CRC_TH         __constant_cpu_to_le16(1)
1236 #define IWL_MAX_SCAN_SIZE 1024
1237
1238 /*
1239  * REPLY_SCAN_CMD = 0x80 (command)
1240  */
1241 struct iwl4965_scan_cmd {
1242         __le16 len;
1243         u8 reserved0;
1244         u8 channel_count;
1245         __le16 quiet_time;     /* dwell only this long on quiet chnl
1246                                 * (active scan) */
1247         __le16 quiet_plcp_th;  /* quiet chnl is < this # pkts (typ. 1) */
1248         __le16 good_CRC_th;    /* passive -> active promotion threshold */
1249         __le16 rx_chain;
1250         __le32 max_out_time;   /* max usec to be out of associated (service)
1251                                 * chnl */
1252         __le32 suspend_time;   /* pause scan this long when returning to svc
1253                                 * chnl.
1254                                 * 3945 -- 31:24 # beacons, 19:0 additional usec,
1255                                 * 4965 -- 31:22 # beacons, 21:0 additional usec.
1256                                 */
1257         __le32 flags;
1258         __le32 filter_flags;
1259
1260         struct iwl4965_tx_cmd tx_cmd;
1261         struct iwl4965_ssid_ie direct_scan[PROBE_OPTION_MAX];
1262
1263         u8 data[0];
1264         /*
1265          * The channels start after the probe request payload and are of type:
1266          *
1267          * struct iwl4965_scan_channel channels[0];
1268          *
1269          * NOTE:  Only one band of channels can be scanned per pass.  You
1270          * can not mix 2.4GHz channels and 5.2GHz channels and must
1271          * request a scan multiple times (not concurrently)
1272          *
1273          */
1274 } __attribute__ ((packed));
1275
1276 /* Can abort will notify by complete notification with abort status. */
1277 #define CAN_ABORT_STATUS        __constant_cpu_to_le32(0x1)
1278 /* complete notification statuses */
1279 #define ABORT_STATUS            0x2
1280
1281 /*
1282  * REPLY_SCAN_CMD = 0x80 (response)
1283  */
1284 struct iwl4965_scanreq_notification {
1285         __le32 status;          /* 1: okay, 2: cannot fulfill request */
1286 } __attribute__ ((packed));
1287
1288 /*
1289  * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
1290  */
1291 struct iwl4965_scanstart_notification {
1292         __le32 tsf_low;
1293         __le32 tsf_high;
1294         __le32 beacon_timer;
1295         u8 channel;
1296         u8 band;
1297         u8 reserved[2];
1298         __le32 status;
1299 } __attribute__ ((packed));
1300
1301 #define  SCAN_OWNER_STATUS 0x1;
1302 #define  MEASURE_OWNER_STATUS 0x2;
1303
1304 #define NUMBER_OF_STATISTICS 1  /* first __le32 is good CRC */
1305 /*
1306  * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
1307  */
1308 struct iwl4965_scanresults_notification {
1309         u8 channel;
1310         u8 band;
1311         u8 reserved[2];
1312         __le32 tsf_low;
1313         __le32 tsf_high;
1314         __le32 statistics[NUMBER_OF_STATISTICS];
1315 } __attribute__ ((packed));
1316
1317 /*
1318  * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
1319  */
1320 struct iwl4965_scancomplete_notification {
1321         u8 scanned_channels;
1322         u8 status;
1323         u8 reserved;
1324         u8 last_channel;
1325         __le32 tsf_low;
1326         __le32 tsf_high;
1327 } __attribute__ ((packed));
1328
1329
1330 /******************************************************************************
1331  * (9)
1332  * IBSS/AP Commands and Notifications:
1333  *
1334  *****************************************************************************/
1335
1336 /*
1337  * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
1338  */
1339 struct iwl4965_beacon_notif {
1340         struct iwl4965_tx_resp beacon_notify_hdr;
1341         __le32 low_tsf;
1342         __le32 high_tsf;
1343         __le32 ibss_mgr_status;
1344 } __attribute__ ((packed));
1345
1346 /*
1347  * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
1348  */
1349 struct iwl4965_tx_beacon_cmd {
1350         struct iwl4965_tx_cmd tx;
1351         __le16 tim_idx;
1352         u8 tim_size;
1353         u8 reserved1;
1354         struct ieee80211_hdr frame[0];  /* beacon frame */
1355 } __attribute__ ((packed));
1356
1357 /******************************************************************************
1358  * (10)
1359  * Statistics Commands and Notifications:
1360  *
1361  *****************************************************************************/
1362
1363 #define IWL_TEMP_CONVERT 260
1364
1365 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
1366 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
1367 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
1368
1369 /* Used for passing to driver number of successes and failures per rate */
1370 struct rate_histogram {
1371         union {
1372                 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
1373                 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
1374                 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
1375         } success;
1376         union {
1377                 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
1378                 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
1379                 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
1380         } failed;
1381 } __attribute__ ((packed));
1382
1383 /* statistics command response */
1384
1385 struct statistics_rx_phy {
1386         __le32 ina_cnt;
1387         __le32 fina_cnt;
1388         __le32 plcp_err;
1389         __le32 crc32_err;
1390         __le32 overrun_err;
1391         __le32 early_overrun_err;
1392         __le32 crc32_good;
1393         __le32 false_alarm_cnt;
1394         __le32 fina_sync_err_cnt;
1395         __le32 sfd_timeout;
1396         __le32 fina_timeout;
1397         __le32 unresponded_rts;
1398         __le32 rxe_frame_limit_overrun;
1399         __le32 sent_ack_cnt;
1400         __le32 sent_cts_cnt;
1401         __le32 sent_ba_rsp_cnt;
1402         __le32 dsp_self_kill;
1403         __le32 mh_format_err;
1404         __le32 re_acq_main_rssi_sum;
1405         __le32 reserved3;
1406 } __attribute__ ((packed));
1407
1408 struct statistics_rx_ht_phy {
1409         __le32 plcp_err;
1410         __le32 overrun_err;
1411         __le32 early_overrun_err;
1412         __le32 crc32_good;
1413         __le32 crc32_err;
1414         __le32 mh_format_err;
1415         __le32 agg_crc32_good;
1416         __le32 agg_mpdu_cnt;
1417         __le32 agg_cnt;
1418         __le32 reserved2;
1419 } __attribute__ ((packed));
1420
1421 struct statistics_rx_non_phy {
1422         __le32 bogus_cts;       /* CTS received when not expecting CTS */
1423         __le32 bogus_ack;       /* ACK received when not expecting ACK */
1424         __le32 non_bssid_frames;        /* number of frames with BSSID that
1425                                          * doesn't belong to the STA BSSID */
1426         __le32 filtered_frames; /* count frames that were dumped in the
1427                                  * filtering process */
1428         __le32 non_channel_beacons;     /* beacons with our bss id but not on
1429                                          * our serving channel */
1430         __le32 channel_beacons; /* beacons with our bss id and in our
1431                                  * serving channel */
1432         __le32 num_missed_bcon; /* number of missed beacons */
1433         __le32 adc_rx_saturation_time;  /* count in 0.8us units the time the
1434                                          * ADC was in saturation */
1435         __le32 ina_detection_search_time;/* total time (in 0.8us) searched
1436                                           * for INA */
1437         __le32 beacon_silence_rssi_a;   /* RSSI silence after beacon frame */
1438         __le32 beacon_silence_rssi_b;   /* RSSI silence after beacon frame */
1439         __le32 beacon_silence_rssi_c;   /* RSSI silence after beacon frame */
1440         __le32 interference_data_flag;  /* flag for interference data
1441                                          * availability. 1 when data is
1442                                          * available. */
1443         __le32 channel_load;    /* counts RX Enable time */
1444         __le32 dsp_false_alarms;        /* DSP false alarm (both OFDM
1445                                          * and CCK) counter */
1446         __le32 beacon_rssi_a;
1447         __le32 beacon_rssi_b;
1448         __le32 beacon_rssi_c;
1449         __le32 beacon_energy_a;
1450         __le32 beacon_energy_b;
1451         __le32 beacon_energy_c;
1452 } __attribute__ ((packed));
1453
1454 struct statistics_rx {
1455         struct statistics_rx_phy ofdm;
1456         struct statistics_rx_phy cck;
1457         struct statistics_rx_non_phy general;
1458         struct statistics_rx_ht_phy ofdm_ht;
1459 } __attribute__ ((packed));
1460
1461 struct statistics_tx_non_phy_agg {
1462         __le32 ba_timeout;
1463         __le32 ba_reschedule_frames;
1464         __le32 scd_query_agg_frame_cnt;
1465         __le32 scd_query_no_agg;
1466         __le32 scd_query_agg;
1467         __le32 scd_query_mismatch;
1468         __le32 frame_not_ready;
1469         __le32 underrun;
1470         __le32 bt_prio_kill;
1471         __le32 rx_ba_rsp_cnt;
1472         __le32 reserved2;
1473         __le32 reserved3;
1474 } __attribute__ ((packed));
1475
1476 struct statistics_tx {
1477         __le32 preamble_cnt;
1478         __le32 rx_detected_cnt;
1479         __le32 bt_prio_defer_cnt;
1480         __le32 bt_prio_kill_cnt;
1481         __le32 few_bytes_cnt;
1482         __le32 cts_timeout;
1483         __le32 ack_timeout;
1484         __le32 expected_ack_cnt;
1485         __le32 actual_ack_cnt;
1486         __le32 dump_msdu_cnt;
1487         __le32 burst_abort_next_frame_mismatch_cnt;
1488         __le32 burst_abort_missing_next_frame_cnt;
1489         __le32 cts_timeout_collision;
1490         __le32 ack_or_ba_timeout_collision;
1491         struct statistics_tx_non_phy_agg agg;
1492 } __attribute__ ((packed));
1493
1494 struct statistics_dbg {
1495         __le32 burst_check;
1496         __le32 burst_count;
1497         __le32 reserved[4];
1498 } __attribute__ ((packed));
1499
1500 struct statistics_div {
1501         __le32 tx_on_a;
1502         __le32 tx_on_b;
1503         __le32 exec_time;
1504         __le32 probe_time;
1505         __le32 reserved1;
1506         __le32 reserved2;
1507 } __attribute__ ((packed));
1508
1509 struct statistics_general {
1510         __le32 temperature;
1511         __le32 temperature_m;
1512         struct statistics_dbg dbg;
1513         __le32 sleep_time;
1514         __le32 slots_out;
1515         __le32 slots_idle;
1516         __le32 ttl_timestamp;
1517         struct statistics_div div;
1518         __le32 rx_enable_counter;
1519         __le32 reserved1;
1520         __le32 reserved2;
1521         __le32 reserved3;
1522 } __attribute__ ((packed));
1523
1524 /*
1525  * REPLY_STATISTICS_CMD = 0x9c,
1526  * 3945 and 4965 identical.
1527  *
1528  * This command triggers an immediate response containing uCode statistics.
1529  * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
1530  *
1531  * If the CLEAR_STATS configuration flag is set, uCode will clear its
1532  * internal copy of the statistics (counters) after issuing the response.
1533  * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
1534  *
1535  * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
1536  * STATISTICS_NOTIFICATIONs after received beacons (see below).  This flag
1537  * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
1538  */
1539 #define IWL_STATS_CONF_CLEAR_STATS __constant_cpu_to_le32(0x1)  /* see above */
1540 #define IWL_STATS_CONF_DISABLE_NOTIF __constant_cpu_to_le32(0x2)/* see above */
1541 struct iwl4965_statistics_cmd {
1542         __le32 configuration_flags;     /* IWL_STATS_CONF_* */
1543 } __attribute__ ((packed));
1544
1545 /*
1546  * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
1547  *
1548  * By default, uCode issues this notification after receiving a beacon
1549  * while associated.  To disable this behavior, set DISABLE_NOTIF flag in the
1550  * REPLY_STATISTICS_CMD 0x9c, above.
1551  *
1552  * Statistics counters continue to increment beacon after beacon, but are
1553  * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
1554  * 0x9c with CLEAR_STATS bit set (see above).
1555  *
1556  * uCode also issues this notification during scans.  uCode clears statistics
1557  * appropriately so that each notification contains statistics for only the
1558  * one channel that has just been scanned.
1559  */
1560 #define STATISTICS_REPLY_FLG_BAND_24G_MSK         __constant_cpu_to_le32(0x2)
1561 #define STATISTICS_REPLY_FLG_FAT_MODE_MSK         __constant_cpu_to_le32(0x8)
1562 struct iwl4965_notif_statistics {
1563         __le32 flag;
1564         struct statistics_rx rx;
1565         struct statistics_tx tx;
1566         struct statistics_general general;
1567 } __attribute__ ((packed));
1568
1569
1570 /*
1571  * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
1572  */
1573 /* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row,
1574  * then this notification will be sent. */
1575 #define CONSECUTIVE_MISSED_BCONS_TH 20
1576
1577 struct iwl4965_missed_beacon_notif {
1578         __le32 consequtive_missed_beacons;
1579         __le32 total_missed_becons;
1580         __le32 num_expected_beacons;
1581         __le32 num_recvd_beacons;
1582 } __attribute__ ((packed));
1583
1584
1585 /******************************************************************************
1586  * (11)
1587  * Rx Calibration Commands:
1588  *
1589  * With the uCode used for open source drivers, most Tx calibration (except
1590  * for Tx Power) and most Rx calibration is done by uCode during the
1591  * "initialize" phase of uCode boot.  Driver must calibrate only:
1592  *
1593  * 1)  Tx power (depends on temperature), described elsewhere
1594  * 2)  Receiver gain balance (optimize MIMO, and detect disconnected antennas)
1595  * 3)  Receiver sensitivity (to optimize signal detection)
1596  *
1597  *****************************************************************************/
1598
1599 /**
1600  * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
1601  *
1602  * This command sets up the Rx signal detector for a sensitivity level that
1603  * is high enough to lock onto all signals within the associated network,
1604  * but low enough to ignore signals that are below a certain threshold, so as
1605  * not to have too many "false alarms".  False alarms are signals that the
1606  * Rx DSP tries to lock onto, but then discards after determining that they
1607  * are noise.
1608  *
1609  * The optimum number of false alarms is between 5 and 50 per 200 TUs
1610  * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
1611  * time listening, not transmitting).  Driver must adjust sensitivity so that
1612  * the ratio of actual false alarms to actual Rx time falls within this range.
1613  *
1614  * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
1615  * received beacon.  These provide information to the driver to analyze the
1616  * sensitivity.  Don't analyze statistics that come in from scanning, or any
1617  * other non-associated-network source.  Pertinent statistics include:
1618  *
1619  * From "general" statistics (struct statistics_rx_non_phy):
1620  *
1621  * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
1622  *   Measure of energy of desired signal.  Used for establishing a level
1623  *   below which the device does not detect signals.
1624  *
1625  * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
1626  *   Measure of background noise in silent period after beacon.
1627  *
1628  * channel_load
1629  *   uSecs of actual Rx time during beacon period (varies according to
1630  *   how much time was spent transmitting).
1631  *
1632  * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
1633  *
1634  * false_alarm_cnt
1635  *   Signal locks abandoned early (before phy-level header).
1636  *
1637  * plcp_err
1638  *   Signal locks abandoned late (during phy-level header).
1639  *
1640  * NOTE:  Both false_alarm_cnt and plcp_err increment monotonically from
1641  *        beacon to beacon, i.e. each value is an accumulation of all errors
1642  *        before and including the latest beacon.  Values will wrap around to 0
1643  *        after counting up to 2^32 - 1.  Driver must differentiate vs.
1644  *        previous beacon's values to determine # false alarms in the current
1645  *        beacon period.
1646  *
1647  * Total number of false alarms = false_alarms + plcp_errs
1648  *
1649  * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
1650  * (notice that the start points for OFDM are at or close to settings for
1651  * maximum sensitivity):
1652  *
1653  *                                             START  /  MIN  /  MAX
1654  *   HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX          90   /   85  /  120
1655  *   HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX     170   /  170  /  210
1656  *   HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX         105   /  105  /  140
1657  *   HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX     220   /  220  /  270
1658  *
1659  *   If actual rate of OFDM false alarms (+ plcp_errors) is too high
1660  *   (greater than 50 for each 204.8 msecs listening), reduce sensitivity
1661  *   by *adding* 1 to all 4 of the table entries above, up to the max for
1662  *   each entry.  Conversely, if false alarm rate is too low (less than 5
1663  *   for each 204.8 msecs listening), *subtract* 1 from each entry to
1664  *   increase sensitivity.
1665  *
1666  * For CCK sensitivity, keep track of the following:
1667  *
1668  *   1).  20-beacon history of maximum background noise, indicated by
1669  *        (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
1670  *        3 receivers.  For any given beacon, the "silence reference" is
1671  *        the maximum of last 60 samples (20 beacons * 3 receivers).
1672  *
1673  *   2).  10-beacon history of strongest signal level, as indicated
1674  *        by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
1675  *        i.e. the strength of the signal through the best receiver at the
1676  *        moment.  These measurements are "upside down", with lower values
1677  *        for stronger signals, so max energy will be *minimum* value.
1678  *
1679  *        Then for any given beacon, the driver must determine the *weakest*
1680  *        of the strongest signals; this is the minimum level that needs to be
1681  *        successfully detected, when using the best receiver at the moment.
1682  *        "Max cck energy" is the maximum (higher value means lower energy!)
1683  *        of the last 10 minima.  Once this is determined, driver must add
1684  *        a little margin by adding "6" to it.
1685  *
1686  *   3).  Number of consecutive beacon periods with too few false alarms.
1687  *        Reset this to 0 at the first beacon period that falls within the
1688  *        "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
1689  *
1690  * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
1691  * (notice that the start points for CCK are at maximum sensitivity):
1692  *
1693  *                                             START  /  MIN  /  MAX
1694  *   HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX         125   /  125  /  200
1695  *   HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX     200   /  200  /  400
1696  *   HD_MIN_ENERGY_CCK_DET_INDEX                100   /    0  /  100
1697  *
1698  *   If actual rate of CCK false alarms (+ plcp_errors) is too high
1699  *   (greater than 50 for each 204.8 msecs listening), method for reducing
1700  *   sensitivity is:
1701  *
1702  *   1)  *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
1703  *       up to max 400.
1704  *
1705  *   2)  If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
1706  *       sensitivity has been reduced a significant amount; bring it up to
1707  *       a moderate 161.  Otherwise, *add* 3, up to max 200.
1708  *
1709  *   3)  a)  If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
1710  *       sensitivity has been reduced only a moderate or small amount;
1711  *       *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
1712  *       down to min 0.  Otherwise (if gain has been significantly reduced),
1713  *       don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
1714  *
1715  *       b)  Save a snapshot of the "silence reference".
1716  *
1717  *   If actual rate of CCK false alarms (+ plcp_errors) is too low
1718  *   (less than 5 for each 204.8 msecs listening), method for increasing
1719  *   sensitivity is used only if:
1720  *
1721  *   1a)  Previous beacon did not have too many false alarms
1722  *   1b)  AND difference between previous "silence reference" and current
1723  *        "silence reference" (prev - current) is 2 or more,
1724  *   OR 2)  100 or more consecutive beacon periods have had rate of
1725  *          less than 5 false alarms per 204.8 milliseconds rx time.
1726  *
1727  *   Method for increasing sensitivity:
1728  *
1729  *   1)  *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
1730  *       down to min 125.
1731  *
1732  *   2)  *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
1733  *       down to min 200.
1734  *
1735  *   3)  *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
1736  *
1737  *   If actual rate of CCK false alarms (+ plcp_errors) is within good range
1738  *   (between 5 and 50 for each 204.8 msecs listening):
1739  *
1740  *   1)  Save a snapshot of the silence reference.
1741  *
1742  *   2)  If previous beacon had too many CCK false alarms (+ plcp_errors),
1743  *       give some extra margin to energy threshold by *subtracting* 8
1744  *       from value in HD_MIN_ENERGY_CCK_DET_INDEX.
1745  *
1746  *   For all cases (too few, too many, good range), make sure that the CCK
1747  *   detection threshold (energy) is below the energy level for robust
1748  *   detection over the past 10 beacon periods, the "Max cck energy".
1749  *   Lower values mean higher energy; this means making sure that the value
1750  *   in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
1751  *
1752  * Driver should set the following entries to fixed values:
1753  *
1754  *   HD_MIN_ENERGY_OFDM_DET_INDEX               100
1755  *   HD_BARKER_CORR_TH_ADD_MIN_INDEX            190
1756  *   HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX        390
1757  *   HD_OFDM_ENERGY_TH_IN_INDEX                  62
1758  */
1759
1760 /*
1761  * Table entries in SENSITIVITY_CMD (struct iwl4965_sensitivity_cmd)
1762  */
1763 #define HD_TABLE_SIZE  (11)     /* number of entries */
1764 #define HD_MIN_ENERGY_CCK_DET_INDEX                 (0) /* table indexes */
1765 #define HD_MIN_ENERGY_OFDM_DET_INDEX                (1)
1766 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX          (2)
1767 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX      (3)
1768 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX      (4)
1769 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX          (5)
1770 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX      (6)
1771 #define HD_BARKER_CORR_TH_ADD_MIN_INDEX             (7)
1772 #define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX         (8)
1773 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX          (9)
1774 #define HD_OFDM_ENERGY_TH_IN_INDEX                  (10)
1775
1776 /* Control field in struct iwl4965_sensitivity_cmd */
1777 #define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE   __constant_cpu_to_le16(0)
1778 #define SENSITIVITY_CMD_CONTROL_WORK_TABLE      __constant_cpu_to_le16(1)
1779
1780 /**
1781  * struct iwl4965_sensitivity_cmd
1782  * @control:  (1) updates working table, (0) updates default table
1783  * @table:  energy threshold values, use HD_* as index into table
1784  *
1785  * Always use "1" in "control" to update uCode's working table and DSP.
1786  */
1787 struct iwl4965_sensitivity_cmd {
1788         __le16 control;                 /* always use "1" */
1789         __le16 table[HD_TABLE_SIZE];    /* use HD_* as index */
1790 } __attribute__ ((packed));
1791
1792
1793 /**
1794  * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
1795  *
1796  * This command sets the relative gains of 4965's 3 radio receiver chains.
1797  *
1798  * After the first association, driver should accumulate signal and noise
1799  * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
1800  * beacons from the associated network (don't collect statistics that come
1801  * in from scanning, or any other non-network source).
1802  *
1803  * DISCONNECTED ANTENNA:
1804  *
1805  * Driver should determine which antennas are actually connected, by comparing
1806  * average beacon signal levels for the 3 Rx chains.  Accumulate (add) the
1807  * following values over 20 beacons, one accumulator for each of the chains
1808  * a/b/c, from struct statistics_rx_non_phy:
1809  *
1810  * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
1811  *
1812  * Find the strongest signal from among a/b/c.  Compare the other two to the
1813  * strongest.  If any signal is more than 15 dB (times 20, unless you
1814  * divide the accumulated values by 20) below the strongest, the driver
1815  * considers that antenna to be disconnected, and should not try to use that
1816  * antenna/chain for Rx or Tx.  If both A and B seem to be disconnected,
1817  * driver should declare the stronger one as connected, and attempt to use it
1818  * (A and B are the only 2 Tx chains!).
1819  *
1820  *
1821  * RX BALANCE:
1822  *
1823  * Driver should balance the 3 receivers (but just the ones that are connected
1824  * to antennas, see above) for gain, by comparing the average signal levels
1825  * detected during the silence after each beacon (background noise).
1826  * Accumulate (add) the following values over 20 beacons, one accumulator for
1827  * each of the chains a/b/c, from struct statistics_rx_non_phy:
1828  *
1829  * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
1830  *
1831  * Find the weakest background noise level from among a/b/c.  This Rx chain
1832  * will be the reference, with 0 gain adjustment.  Attenuate other channels by
1833  * finding noise difference:
1834  *
1835  * (accum_noise[i] - accum_noise[reference]) / 30
1836  *
1837  * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
1838  * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
1839  * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
1840  * and set bit 2 to indicate "reduce gain".  The value for the reference
1841  * (weakest) chain should be "0".
1842  *
1843  * diff_gain_[abc] bit fields:
1844  *   2: (1) reduce gain, (0) increase gain
1845  * 1-0: amount of gain, units of 1.5 dB
1846  */
1847
1848 /* "Differential Gain" opcode used in REPLY_PHY_CALIBRATION_CMD. */
1849 #define PHY_CALIBRATE_DIFF_GAIN_CMD (7)
1850
1851 struct iwl4965_calibration_cmd {
1852         u8 opCode;              /* PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
1853         u8 flags;               /* not used */
1854         __le16 reserved;
1855         s8 diff_gain_a;         /* see above */
1856         s8 diff_gain_b;
1857         s8 diff_gain_c;
1858         u8 reserved1;
1859 } __attribute__ ((packed));
1860
1861 /******************************************************************************
1862  * (12)
1863  * Miscellaneous Commands:
1864  *
1865  *****************************************************************************/
1866
1867 /*
1868  * LEDs Command & Response
1869  * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
1870  *
1871  * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
1872  * this command turns it on or off, or sets up a periodic blinking cycle.
1873  */
1874 struct iwl4965_led_cmd {
1875         __le32 interval;        /* "interval" in uSec */
1876         u8 id;                  /* 1: Activity, 2: Link, 3: Tech */
1877         u8 off;                 /* # intervals off while blinking;
1878                                  * "0", with >0 "on" value, turns LED on */
1879         u8 on;                  /* # intervals on while blinking;
1880                                  * "0", regardless of "off", turns LED off */
1881         u8 reserved;
1882 } __attribute__ ((packed));
1883
1884 /******************************************************************************
1885  * (13)
1886  * Union of all expected notifications/responses:
1887  *
1888  *****************************************************************************/
1889
1890 struct iwl4965_rx_packet {
1891         __le32 len;
1892         struct iwl4965_cmd_header hdr;
1893         union {
1894                 struct iwl4965_alive_resp alive_frame;
1895                 struct iwl4965_rx_frame rx_frame;
1896                 struct iwl4965_tx_resp tx_resp;
1897                 struct iwl4965_spectrum_notification spectrum_notif;
1898                 struct iwl4965_csa_notification csa_notif;
1899                 struct iwl4965_error_resp err_resp;
1900                 struct iwl4965_card_state_notif card_state_notif;
1901                 struct iwl4965_beacon_notif beacon_status;
1902                 struct iwl4965_add_sta_resp add_sta;
1903                 struct iwl4965_sleep_notification sleep_notif;
1904                 struct iwl4965_spectrum_resp spectrum;
1905                 struct iwl4965_notif_statistics stats;
1906                 struct iwl4965_compressed_ba_resp compressed_ba;
1907                 struct iwl4965_missed_beacon_notif missed_beacon;
1908                 __le32 status;
1909                 u8 raw[0];
1910         } u;
1911 } __attribute__ ((packed));
1912
1913 #define IWL_RX_FRAME_SIZE        (4 + sizeof(struct iwl4965_rx_frame))
1914
1915 #endif                          /* __iwl4965_commands_h__ */