1 /******************************************************************************
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.
8 * Copyright(c) 2005 - 2007 Intel Corporation. All rights reserved.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
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
33 * Copyright(c) 2005 - 2007 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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.
62 *****************************************************************************/
64 #ifndef __iwl4965_commands_h__
65 #define __iwl4965_commands_h__
71 /* RXON and QOS commands */
73 REPLY_RXON_ASSOC = 0x11,
74 REPLY_QOS_PARAM = 0x13,
75 REPLY_RXON_TIMING = 0x14,
77 /* Multi-Station support */
79 REPLY_REMOVE_STA = 0x19, /* not used */
80 REPLY_REMOVE_ALL_STA = 0x1a, /* not used */
84 REPLY_RATE_SCALE = 0x47, /* 3945 only */
85 REPLY_LEDS_CMD = 0x48,
86 REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */
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,
96 /* Power Management */
97 POWER_TABLE_CMD = 0x77,
98 PM_SLEEP_NOTIFICATION = 0x7A,
99 PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
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,
108 /* IBSS/AP commands */
109 BEACON_NOTIFICATION = 0x90,
110 REPLY_TX_BEACON = 0x91,
111 WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */
113 /* Miscellaneous commands */
114 QUIET_NOTIFICATION = 0x96, /* not used */
115 REPLY_TX_PWR_TABLE_CMD = 0x97,
116 MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */
118 /* BT config command */
119 REPLY_BT_CONFIG = 0x9b,
121 /* 4965 Statistics */
122 REPLY_STATISTICS_CMD = 0x9c,
123 STATISTICS_NOTIFICATION = 0x9d,
125 /* RF-KILL commands and notifications */
126 REPLY_CARD_STATE_CMD = 0xa0,
127 CARD_STATE_NOTIFICATION = 0xa1,
129 /* Missed beacons notification */
130 MISSED_BEACONS_NOTIFICATION = 0xa2,
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,
142 /******************************************************************************
144 * Commonly used structures and definitions:
145 * Command header, rate_n_flags
147 *****************************************************************************/
149 #define IWL_CMD_FAILED_MSK 0x40
151 struct iwl4965_cmd_header {
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:
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)
167 /* command data follows immediately */
169 } __attribute__ ((packed));
172 * 4965 rate_n_flags bit fields
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
179 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
189 * 3: 0) Single stream (SISO)
190 * 1) Dual stream (MIMO)
192 * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps FAT duplicate data
194 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
204 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
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
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
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
225 /* (1) Use Green Field preamble */
226 #define RATE_MCS_GF_POS 10
227 #define RATE_MCS_GF_MSK 0x400
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
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
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
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
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
254 /******************************************************************************
256 * Alive and Error Commands & Responses:
258 *****************************************************************************/
260 #define UCODE_VALID_OK __constant_cpu_to_le32(0x1)
261 #define INITIALIZE_SUBTYPE (9)
264 * REPLY_ALIVE = 0x1 (response only, not a command)
266 struct iwl4965_alive_resp {
274 __le32 log_event_table_ptr;
275 __le32 error_event_table_ptr;
278 } __attribute__ ((packed));
280 struct iwl4965_init_alive_resp {
288 __le32 log_event_table_ptr;
289 __le32 error_event_table_ptr;
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,
301 } __attribute__ ((packed));
310 * REPLY_ERROR = 0x2 (response only, not a command)
312 struct iwl4965_error_resp {
316 __le16 bad_cmd_seq_num;
319 } __attribute__ ((packed));
321 /******************************************************************************
323 * RXON Commands & Responses:
325 *****************************************************************************/
328 * Rx config defines & structure
330 /* rx_config device types */
332 RXON_DEV_TYPE_AP = 1,
333 RXON_DEV_TYPE_ESS = 3,
334 RXON_DEV_TYPE_IBSS = 4,
335 RXON_DEV_TYPE_SNIFFER = 6,
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)
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)
378 * REPLY_RXON = 0x10 (command, has simple generic response)
380 struct iwl4965_rxon_cmd {
385 u8 wlap_bssid_addr[6];
396 u8 ofdm_ht_single_stream_basic_rates;
397 u8 ofdm_ht_dual_stream_basic_rates;
398 } __attribute__ ((packed));
401 * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
403 struct iwl4965_rxon_assoc_cmd {
408 u8 ofdm_ht_single_stream_basic_rates;
409 u8 ofdm_ht_dual_stream_basic_rates;
410 __le16 rx_chain_select_flags;
412 } __attribute__ ((packed));
415 * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
417 struct iwl4965_rxon_time_cmd {
419 __le16 beacon_interval;
421 __le32 beacon_init_val;
422 __le16 listen_interval;
424 } __attribute__ ((packed));
426 struct iwl4965_tx_power {
427 u8 tx_gain; /* gain for analog radio */
428 u8 dsp_atten; /* gain for DSP */
429 } __attribute__ ((packed));
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 {
436 } __attribute__ ((packed));
438 struct iwl4965_tx_power_db {
439 struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES];
440 } __attribute__ ((packed));
443 * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
445 struct iwl4965_channel_switch_cmd {
450 __le32 rxon_filter_flags;
452 struct iwl4965_tx_power_db tx_power;
453 } __attribute__ ((packed));
456 * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
458 struct iwl4965_csa_notification {
461 __le32 status; /* 0 - OK, 1 - fail */
462 } __attribute__ ((packed));
464 /******************************************************************************
466 * Quality-of-Service (QOS) Commands & Responses:
468 *****************************************************************************/
469 struct iwl4965_ac_qos {
475 } __attribute__ ((packed));
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)
483 * TXFIFO Queue number defines
485 /* number of Access categories (AC) (EDCA), queues 0..3 */
489 * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
491 struct iwl4965_qosparam_cmd {
493 struct iwl4965_ac_qos ac[AC_NUM];
494 } __attribute__ ((packed));
496 /******************************************************************************
498 * Add/Modify Stations Commands & Responses:
500 *****************************************************************************/
502 * Multi station support
505 #define IWL_MULTICAST_ID 1
508 #define IWL3945_BROADCAST_ID 24
509 #define IWL3945_STATION_COUNT 25
511 #define IWL4965_BROADCAST_ID 31
512 #define IWL4965_STATION_COUNT 32
514 #define IWL_STATION_COUNT 32 /* MAX(3945,4965)*/
515 #define IWL_INVALID_STATION 255
517 #define STA_FLG_PWR_SAVE_MSK __constant_cpu_to_le32(1<<8);
519 #define STA_CONTROL_MODIFY_MSK 0x01
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)
528 #define STA_KEY_FLG_KEYID_POS 8
529 #define STA_KEY_FLG_INVALID __constant_cpu_to_le16(0x0800)
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))
539 struct iwl4965_keyinfo {
541 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
543 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
545 u8 key[16]; /* 16-byte unicast decryption key */
546 } __attribute__ ((packed));
548 struct sta_id_modify {
554 } __attribute__ ((packed));
557 * REPLY_ADD_STA = 0x18 (command)
559 struct iwl4965_addsta_cmd {
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;
568 u8 add_immediate_ba_tid;
569 u8 remove_immediate_ba_tid;
570 __le16 add_immediate_ba_ssn;
572 } __attribute__ ((packed));
575 * REPLY_ADD_STA = 0x18 (response)
577 struct iwl4965_add_sta_resp {
579 } __attribute__ ((packed));
581 #define ADD_STA_SUCCESS_MSK 0x1
583 /******************************************************************************
587 *****************************************************************************/
589 struct iwl4965_rx_frame_stats {
597 } __attribute__ ((packed));
599 struct iwl4965_rx_frame_hdr {
606 } __attribute__ ((packed));
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)
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)
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)
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)
629 struct iwl4965_rx_frame_end {
632 __le32 beacon_timestamp;
633 } __attribute__ ((packed));
636 * REPLY_3945_RX = 0x1b (response only, not a command)
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
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));
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 */
659 } __attribute__ ((packed));
662 * REPLY_4965_RX = 0xc3 (response only, not a command)
663 * Used only for legacy (non 11n) frames.
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 */
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 */
678 __le16 byte_count; /* frame's byte-count */
680 } __attribute__ ((packed));
682 struct iwl4965_rx_mpdu_res_start {
685 } __attribute__ ((packed));
688 /******************************************************************************
690 * Tx Commands & Responses:
692 *****************************************************************************/
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)
705 /* ucode ignores BT priority for this frame */
706 #define TX_CMD_FLG_BT_DIS_MSK __constant_cpu_to_le32(1 << 12)
708 /* ucode overrides sequence control */
709 #define TX_CMD_FLG_SEQ_CTL_MSK __constant_cpu_to_le32(1 << 13)
711 /* signal that this frame is non-last MPDU */
712 #define TX_CMD_FLG_MORE_FRAG_MSK __constant_cpu_to_le32(1 << 14)
714 /* calculate TSF in outgoing frame */
715 #define TX_CMD_FLG_TSF_MSK __constant_cpu_to_le32(1 << 16)
717 /* activate TX calibration. */
718 #define TX_CMD_FLG_CALIB_MSK __constant_cpu_to_le32(1 << 17)
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)
724 /* HCCA-AP - disable duration overwriting. */
725 #define TX_CMD_FLG_DUR_MSK __constant_cpu_to_le32(1 << 25)
728 * TX command security control
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
738 * TX command Frame life time
741 struct iwl4965_dram_scratch {
745 } __attribute__ ((packed));
748 * REPLY_TX = 0x1c (command)
750 struct iwl4965_tx_cmd {
752 __le16 next_frame_len;
754 struct iwl4965_dram_scratch scratch;
758 u8 initial_rate_index;
761 __le16 next_frame_flags;
769 u8 rts_retry_limit; /*byte 50 */
770 u8 data_retry_limit; /*byte 51 */
773 __le16 pm_frame_timeout;
774 __le16 attempt_duration;
778 struct ieee80211_hdr hdr[0];
779 } __attribute__ ((packed));
781 /* TX command response is sent after *all* transmission attempts.
785 * TX_STATUS_FAIL_NEXT_FRAG
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'.
791 * TX_STATUS_FIFO_UNDERRUN
793 * Indicates the host did not provide bytes to the FIFO fast enough while
794 * a TX was in progress.
796 * TX_STATUS_FAIL_MGMNT_ABORT
798 * This status is only possible if the ABORT ON MGMT RX parameter was
799 * set to true with the TX command.
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.
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,
829 #define TX_PACKET_MODE_REGULAR 0x0000
830 #define TX_PACKET_MODE_BURST_SEQ 0x0100
831 #define TX_PACKET_MODE_BURST_FIRST 0x0200
834 TX_POWER_PA_NOT_ACTIVE = 0x0,
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 */
848 /* *******************************
849 * TX aggregation state
850 ******************************* */
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
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)
873 #define AGG_TX_STATE_TRY_CNT_POS 12
874 #define AGG_TX_STATE_TRY_CNT_MSK 0xf000
876 #define AGG_TX_STATE_SEQ_NUM_POS 16
877 #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
880 * REPLY_TX = 0x1c (response)
882 struct iwl4965_tx_resp {
883 u8 frame_count; /* 1 no aggregation, >1 aggregation */
888 __le16 wireless_media_time;
892 __le32 status; /* TX status (for aggregation status of 1st frame) */
893 } __attribute__ ((packed));
896 * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
898 struct iwl4965_compressed_ba_resp {
899 __le32 sta_addr_lo32;
900 __le16 sta_addr_hi16;
909 } __attribute__ ((packed));
912 * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
914 struct iwl4965_txpowertable_cmd {
915 u8 band; /* 0: 5 GHz, 1: 2.4 GHz */
918 struct iwl4965_tx_power_db tx_power;
919 } __attribute__ ((packed));
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)
924 #define LINK_QUAL_AC_NUM AC_NUM
925 #define LINK_QUAL_MAX_RETRY_NUM 16
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)
931 struct iwl4965_link_qual_general_params {
934 u8 single_stream_ant_msk;
935 u8 dual_stream_ant_msk;
936 u8 start_rate_index[LINK_QUAL_AC_NUM];
937 } __attribute__ ((packed));
939 struct iwl4965_link_qual_agg_params {
940 __le16 agg_time_limit;
942 u8 agg_frame_cnt_limit;
944 } __attribute__ ((packed));
947 * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
949 struct iwl4965_link_quality_cmd {
953 struct iwl4965_link_qual_general_params general_params;
954 struct iwl4965_link_qual_agg_params agg_params;
957 } rs_table[LINK_QUAL_MAX_RETRY_NUM];
959 } __attribute__ ((packed));
962 * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
964 struct iwl4965_bt_cmd {
969 __le32 kill_ack_mask;
970 __le32 kill_cts_mask;
971 } __attribute__ ((packed));
973 /******************************************************************************
975 * Spectrum Management (802.11h) Commands, Responses, Notifications:
977 *****************************************************************************/
980 * Spectrum Management
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)
990 struct iwl4965_measure_channel {
991 __le32 duration; /* measurement duration in extended beacon
993 u8 channel; /* channel to measure */
994 u8 type; /* see enum iwl4965_measure_type */
996 } __attribute__ ((packed));
999 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
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 */
1010 __le32 flags; /* rxon flags */
1011 __le32 filter_flags; /* rxon filter flags */
1012 __le16 channel_count; /* minimum 1, maximum 10 */
1014 struct iwl4965_measure_channel channels[10];
1015 } __attribute__ ((packed));
1018 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
1020 struct iwl4965_spectrum_resp {
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
1026 } __attribute__ ((packed));
1028 enum iwl4965_measurement_state {
1029 IWL_MEASUREMENT_START = 0,
1030 IWL_MEASUREMENT_STOP = 1,
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,
1039 IWL_MEASUREMENT_STOPPED = 6,
1040 IWL_MEASUREMENT_TIMEOUT = 7,
1041 IWL_MEASUREMENT_PERIODIC_FAILED = 8,
1044 #define NUM_ELEMENTS_IN_HISTOGRAM 8
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));
1051 /* clear channel availability counters */
1052 struct iwl4965_measurement_cca_counters {
1055 } __attribute__ ((packed));
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),
1068 * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
1070 struct iwl4965_spectrum_notification {
1071 u8 id; /* measurement id -- 0 or 1 */
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 */
1078 u8 type; /* see enum iwl4965_measurement_type */
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 -
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));
1093 /******************************************************************************
1095 * Power Management Commands, Responses, Notifications:
1097 *****************************************************************************/
1100 * struct iwl4965_powertable_cmd - Power Table Command
1101 * @flags: See below:
1103 * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
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)
1112 * bit 2 - '0' PM have to walk up every DTIM
1113 * '1' PM could sleep over DTIM till listen Interval.
1115 * bit 3 - '0' (PCI_LINK_CTRL & 0x1)
1116 * '1' !(PCI_LINK_CTRL & 0x1)
1118 * bit 31/30- '00' use both mac/xtal sleeps
1119 * '01' force Mac sleep
1120 * '10' force xtal sleep
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
1127 #define IWL_POWER_VEC_SIZE 5
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)
1133 struct iwl4965_powertable_cmd {
1135 u8 keep_alive_seconds;
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));
1144 * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
1145 * 3945 and 4965 identical.
1147 struct iwl4965_sleep_notification {
1154 } __attribute__ ((packed));
1156 /* Sleep states. 3945 and 4965 identical. */
1158 IWL_PM_NO_SLEEP = 0,
1160 IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
1161 IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
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,
1168 IWL_PM_NUM_OF_MODES = 12,
1172 * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
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));
1182 * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
1184 struct iwl4965_card_state_notif {
1186 } __attribute__ ((packed));
1188 #define HW_CARD_DISABLED 0x01
1189 #define SW_CARD_DISABLED 0x02
1190 #define RF_CARD_DISABLED 0x04
1191 #define RXON_CARD_DISABLED 0x10
1193 struct iwl4965_ct_kill_config {
1195 __le32 critical_temperature_M;
1196 __le32 critical_temperature_R;
1197 } __attribute__ ((packed));
1199 /******************************************************************************
1201 * Scan Commands, Responses, Notifications:
1203 *****************************************************************************/
1205 struct iwl4965_scan_channel {
1206 /* type is defined as:
1207 * 0:0 active (0 - passive)
1209 * If 1 is set then corresponding SSID IE is transmitted in probe
1214 struct iwl4965_tx_power tpc;
1215 __le16 active_dwell;
1216 __le16 passive_dwell;
1217 } __attribute__ ((packed));
1219 struct iwl4965_ssid_ie {
1223 } __attribute__ ((packed));
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
1231 * REPLY_SCAN_CMD = 0x80 (command)
1233 struct iwl4965_scan_cmd {
1237 __le16 quiet_time; /* dwell only this long on quiet chnl
1239 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
1240 __le16 good_CRC_th; /* passive -> active promotion threshold */
1242 __le32 max_out_time; /* max usec to be out of associated (service)
1244 __le32 suspend_time; /* pause scan this long when returning to svc
1246 * 3945 -- 31:24 # beacons, 19:0 additional usec,
1247 * 4965 -- 31:22 # beacons, 21:0 additional usec.
1250 __le32 filter_flags;
1252 struct iwl4965_tx_cmd tx_cmd;
1253 struct iwl4965_ssid_ie direct_scan[PROBE_OPTION_MAX];
1257 * The channels start after the probe request payload and are of type:
1259 * struct iwl4965_scan_channel channels[0];
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)
1266 } __attribute__ ((packed));
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
1274 * REPLY_SCAN_CMD = 0x80 (response)
1276 struct iwl4965_scanreq_notification {
1277 __le32 status; /* 1: okay, 2: cannot fulfill request */
1278 } __attribute__ ((packed));
1281 * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
1283 struct iwl4965_scanstart_notification {
1286 __le32 beacon_timer;
1291 } __attribute__ ((packed));
1293 #define SCAN_OWNER_STATUS 0x1;
1294 #define MEASURE_OWNER_STATUS 0x2;
1296 #define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */
1298 * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
1300 struct iwl4965_scanresults_notification {
1306 __le32 statistics[NUMBER_OF_STATISTICS];
1307 } __attribute__ ((packed));
1310 * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
1312 struct iwl4965_scancomplete_notification {
1313 u8 scanned_channels;
1319 } __attribute__ ((packed));
1322 /******************************************************************************
1324 * IBSS/AP Commands and Notifications:
1326 *****************************************************************************/
1329 * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
1331 struct iwl4965_beacon_notif {
1332 struct iwl4965_tx_resp beacon_notify_hdr;
1335 __le32 ibss_mgr_status;
1336 } __attribute__ ((packed));
1339 * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
1341 struct iwl4965_tx_beacon_cmd {
1342 struct iwl4965_tx_cmd tx;
1346 struct ieee80211_hdr frame[0]; /* beacon frame */
1347 } __attribute__ ((packed));
1349 /******************************************************************************
1351 * Statistics Commands and Notifications:
1353 *****************************************************************************/
1355 #define IWL_TEMP_CONVERT 260
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
1361 /* Used for passing to driver number of successes and failures per rate */
1362 struct rate_histogram {
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];
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];
1373 } __attribute__ ((packed));
1375 /* statistics command response */
1377 struct statistics_rx_phy {
1383 __le32 early_overrun_err;
1385 __le32 false_alarm_cnt;
1386 __le32 fina_sync_err_cnt;
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;
1398 } __attribute__ ((packed));
1400 struct statistics_rx_ht_phy {
1403 __le32 early_overrun_err;
1406 __le32 mh_format_err;
1407 __le32 agg_crc32_good;
1408 __le32 agg_mpdu_cnt;
1411 } __attribute__ ((packed));
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
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
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));
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));
1453 struct statistics_tx_non_phy_agg {
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;
1462 __le32 bt_prio_kill;
1463 __le32 rx_ba_rsp_cnt;
1466 } __attribute__ ((packed));
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;
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));
1486 struct statistics_dbg {
1490 } __attribute__ ((packed));
1492 struct statistics_div {
1499 } __attribute__ ((packed));
1501 struct statistics_general {
1503 __le32 temperature_m;
1504 struct statistics_dbg dbg;
1508 __le32 ttl_timestamp;
1509 struct statistics_div div;
1510 __le32 rx_enable_counter;
1514 } __attribute__ ((packed));
1517 * REPLY_STATISTICS_CMD = 0x9c,
1518 * 3945 and 4965 identical.
1520 * This command triggers an immediate response containing uCode statistics.
1521 * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
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).
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.
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));
1538 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
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.
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).
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.
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 {
1556 struct statistics_rx rx;
1557 struct statistics_tx tx;
1558 struct statistics_general general;
1559 } __attribute__ ((packed));
1563 * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
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
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));
1577 /******************************************************************************
1579 * Rx Calibration Commands:
1581 * With the uCode used for open source drivers, most Tx calibration (except
1582 * for Tx Power) and most Rx calibration is done by uCode during the
1583 * "initialize" phase of uCode boot. Driver must calibrate only:
1585 * 1) Tx power (depends on temperature), described elsewhere
1586 * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas)
1587 * 3) Receiver sensitivity (to optimize signal detection)
1589 *****************************************************************************/
1592 * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
1594 * This command sets up the Rx signal detector for a sensitivity level that
1595 * is high enough to lock onto all signals within the associated network,
1596 * but low enough to ignore signals that are below a certain threshold, so as
1597 * not to have too many "false alarms". False alarms are signals that the
1598 * Rx DSP tries to lock onto, but then discards after determining that they
1601 * The optimum number of false alarms is between 5 and 50 per 200 TUs
1602 * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
1603 * time listening, not transmitting). Driver must adjust sensitivity so that
1604 * the ratio of actual false alarms to actual Rx time falls within this range.
1606 * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
1607 * received beacon. These provide information to the driver to analyze the
1608 * sensitivity. Don't analyze statistics that come in from scanning, or any
1609 * other non-associated-network source. Pertinent statistics include:
1611 * From "general" statistics (struct statistics_rx_non_phy):
1613 * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
1614 * Measure of energy of desired signal. Used for establishing a level
1615 * below which the device does not detect signals.
1617 * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
1618 * Measure of background noise in silent period after beacon.
1621 * uSecs of actual Rx time during beacon period (varies according to
1622 * how much time was spent transmitting).
1624 * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
1627 * Signal locks abandoned early (before phy-level header).
1630 * Signal locks abandoned late (during phy-level header).
1632 * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from
1633 * beacon to beacon, i.e. each value is an accumulation of all errors
1634 * before and including the latest beacon. Values will wrap around to 0
1635 * after counting up to 2^32 - 1. Driver must differentiate vs.
1636 * previous beacon's values to determine # false alarms in the current
1639 * Total number of false alarms = false_alarms + plcp_errs
1641 * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
1642 * (notice that the start points for OFDM are at or close to settings for
1643 * maximum sensitivity):
1646 * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120
1647 * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210
1648 * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140
1649 * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270
1651 * If actual rate of OFDM false alarms (+ plcp_errors) is too high
1652 * (greater than 50 for each 204.8 msecs listening), reduce sensitivity
1653 * by *adding* 1 to all 4 of the table entries above, up to the max for
1654 * each entry. Conversely, if false alarm rate is too low (less than 5
1655 * for each 204.8 msecs listening), *subtract* 1 from each entry to
1656 * increase sensitivity.
1658 * For CCK sensitivity, keep track of the following:
1660 * 1). 20-beacon history of maximum background noise, indicated by
1661 * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
1662 * 3 receivers. For any given beacon, the "silence reference" is
1663 * the maximum of last 60 samples (20 beacons * 3 receivers).
1665 * 2). 10-beacon history of strongest signal level, as indicated
1666 * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
1667 * i.e. the strength of the signal through the best receiver at the
1668 * moment. These measurements are "upside down", with lower values
1669 * for stronger signals, so max energy will be *minimum* value.
1671 * Then for any given beacon, the driver must determine the *weakest*
1672 * of the strongest signals; this is the minimum level that needs to be
1673 * successfully detected, when using the best receiver at the moment.
1674 * "Max cck energy" is the maximum (higher value means lower energy!)
1675 * of the last 10 minima. Once this is determined, driver must add
1676 * a little margin by adding "6" to it.
1678 * 3). Number of consecutive beacon periods with too few false alarms.
1679 * Reset this to 0 at the first beacon period that falls within the
1680 * "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
1682 * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
1683 * (notice that the start points for CCK are at maximum sensitivity):
1686 * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200
1687 * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400
1688 * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100
1690 * If actual rate of CCK false alarms (+ plcp_errors) is too high
1691 * (greater than 50 for each 204.8 msecs listening), method for reducing
1694 * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
1697 * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
1698 * sensitivity has been reduced a significant amount; bring it up to
1699 * a moderate 161. Otherwise, *add* 3, up to max 200.
1701 * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
1702 * sensitivity has been reduced only a moderate or small amount;
1703 * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
1704 * down to min 0. Otherwise (if gain has been significantly reduced),
1705 * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
1707 * b) Save a snapshot of the "silence reference".
1709 * If actual rate of CCK false alarms (+ plcp_errors) is too low
1710 * (less than 5 for each 204.8 msecs listening), method for increasing
1711 * sensitivity is used only if:
1713 * 1a) Previous beacon did not have too many false alarms
1714 * 1b) AND difference between previous "silence reference" and current
1715 * "silence reference" (prev - current) is 2 or more,
1716 * OR 2) 100 or more consecutive beacon periods have had rate of
1717 * less than 5 false alarms per 204.8 milliseconds rx time.
1719 * Method for increasing sensitivity:
1721 * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
1724 * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
1727 * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
1729 * If actual rate of CCK false alarms (+ plcp_errors) is within good range
1730 * (between 5 and 50 for each 204.8 msecs listening):
1732 * 1) Save a snapshot of the silence reference.
1734 * 2) If previous beacon had too many CCK false alarms (+ plcp_errors),
1735 * give some extra margin to energy threshold by *subtracting* 8
1736 * from value in HD_MIN_ENERGY_CCK_DET_INDEX.
1738 * For all cases (too few, too many, good range), make sure that the CCK
1739 * detection threshold (energy) is below the energy level for robust
1740 * detection over the past 10 beacon periods, the "Max cck energy".
1741 * Lower values mean higher energy; this means making sure that the value
1742 * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
1744 * Driver should set the following entries to fixed values:
1746 * HD_MIN_ENERGY_OFDM_DET_INDEX 100
1747 * HD_BARKER_CORR_TH_ADD_MIN_INDEX 190
1748 * HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX 390
1749 * HD_OFDM_ENERGY_TH_IN_INDEX 62
1753 * Table entries in SENSITIVITY_CMD (struct iwl4965_sensitivity_cmd)
1755 #define HD_TABLE_SIZE (11) /* number of entries */
1756 #define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */
1757 #define HD_MIN_ENERGY_OFDM_DET_INDEX (1)
1758 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2)
1759 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3)
1760 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4)
1761 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5)
1762 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6)
1763 #define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7)
1764 #define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8)
1765 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9)
1766 #define HD_OFDM_ENERGY_TH_IN_INDEX (10)
1768 /* Control field in struct iwl4965_sensitivity_cmd */
1769 #define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE __constant_cpu_to_le16(0)
1770 #define SENSITIVITY_CMD_CONTROL_WORK_TABLE __constant_cpu_to_le16(1)
1773 * struct iwl4965_sensitivity_cmd
1774 * @control: (1) updates working table, (0) updates default table
1775 * @table: energy threshold values, use HD_* as index into table
1777 * Always use "1" in "control" to update uCode's working table and DSP.
1779 struct iwl4965_sensitivity_cmd {
1780 __le16 control; /* always use "1" */
1781 __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */
1782 } __attribute__ ((packed));
1786 * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
1788 * This command sets the relative gains of 4965's 3 radio receiver chains.
1790 * After the first association, driver should accumulate signal and noise
1791 * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
1792 * beacons from the associated network (don't collect statistics that come
1793 * in from scanning, or any other non-network source).
1795 * DISCONNECTED ANTENNA:
1797 * Driver should determine which antennas are actually connected, by comparing
1798 * average beacon signal levels for the 3 Rx chains. Accumulate (add) the
1799 * following values over 20 beacons, one accumulator for each of the chains
1800 * a/b/c, from struct statistics_rx_non_phy:
1802 * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
1804 * Find the strongest signal from among a/b/c. Compare the other two to the
1805 * strongest. If any signal is more than 15 dB (times 20, unless you
1806 * divide the accumulated values by 20) below the strongest, the driver
1807 * considers that antenna to be disconnected, and should not try to use that
1808 * antenna/chain for Rx or Tx. If both A and B seem to be disconnected,
1809 * driver should declare the stronger one as connected, and attempt to use it
1810 * (A and B are the only 2 Tx chains!).
1815 * Driver should balance the 3 receivers (but just the ones that are connected
1816 * to antennas, see above) for gain, by comparing the average signal levels
1817 * detected during the silence after each beacon (background noise).
1818 * Accumulate (add) the following values over 20 beacons, one accumulator for
1819 * each of the chains a/b/c, from struct statistics_rx_non_phy:
1821 * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
1823 * Find the weakest background noise level from among a/b/c. This Rx chain
1824 * will be the reference, with 0 gain adjustment. Attenuate other channels by
1825 * finding noise difference:
1827 * (accum_noise[i] - accum_noise[reference]) / 30
1829 * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
1830 * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
1831 * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
1832 * and set bit 2 to indicate "reduce gain". The value for the reference
1833 * (weakest) chain should be "0".
1835 * diff_gain_[abc] bit fields:
1836 * 2: (1) reduce gain, (0) increase gain
1837 * 1-0: amount of gain, units of 1.5 dB
1840 /* "Differential Gain" opcode used in REPLY_PHY_CALIBRATION_CMD. */
1841 #define PHY_CALIBRATE_DIFF_GAIN_CMD (7)
1843 struct iwl4965_calibration_cmd {
1844 u8 opCode; /* PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
1845 u8 flags; /* not used */
1847 s8 diff_gain_a; /* see above */
1851 } __attribute__ ((packed));
1853 /******************************************************************************
1855 * Miscellaneous Commands:
1857 *****************************************************************************/
1860 * LEDs Command & Response
1861 * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
1863 * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
1864 * this command turns it on or off, or sets up a periodic blinking cycle.
1866 struct iwl4965_led_cmd {
1867 __le32 interval; /* "interval" in uSec */
1868 u8 id; /* 1: Activity, 2: Link, 3: Tech */
1869 u8 off; /* # intervals off while blinking;
1870 * "0", with >0 "on" value, turns LED on */
1871 u8 on; /* # intervals on while blinking;
1872 * "0", regardless of "off", turns LED off */
1874 } __attribute__ ((packed));
1876 /******************************************************************************
1878 * Union of all expected notifications/responses:
1880 *****************************************************************************/
1882 struct iwl4965_rx_packet {
1884 struct iwl4965_cmd_header hdr;
1886 struct iwl4965_alive_resp alive_frame;
1887 struct iwl4965_rx_frame rx_frame;
1888 struct iwl4965_tx_resp tx_resp;
1889 struct iwl4965_spectrum_notification spectrum_notif;
1890 struct iwl4965_csa_notification csa_notif;
1891 struct iwl4965_error_resp err_resp;
1892 struct iwl4965_card_state_notif card_state_notif;
1893 struct iwl4965_beacon_notif beacon_status;
1894 struct iwl4965_add_sta_resp add_sta;
1895 struct iwl4965_sleep_notification sleep_notif;
1896 struct iwl4965_spectrum_resp spectrum;
1897 struct iwl4965_notif_statistics stats;
1898 struct iwl4965_compressed_ba_resp compressed_ba;
1899 struct iwl4965_missed_beacon_notif missed_beacon;
1903 } __attribute__ ((packed));
1905 #define IWL_RX_FRAME_SIZE (4 + sizeof(struct iwl4965_rx_frame))
1907 #endif /* __iwl4965_commands_h__ */