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 - 2008 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 - 2008 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 * Please use this file (iwl-4965-commands.h) only for uCode API definitions.
65 * Please use iwl-4965-hw.h for hardware-related definitions.
66 * Please use iwl-4965.h for driver implementation definitions.
69 #ifndef __iwl4965_commands_h__
70 #define __iwl4965_commands_h__
76 /* RXON and QOS commands */
78 REPLY_RXON_ASSOC = 0x11,
79 REPLY_QOS_PARAM = 0x13,
80 REPLY_RXON_TIMING = 0x14,
82 /* Multi-Station support */
84 REPLY_REMOVE_STA = 0x19, /* not used */
85 REPLY_REMOVE_ALL_STA = 0x1a, /* not used */
89 REPLY_RATE_SCALE = 0x47, /* 3945 only */
90 REPLY_LEDS_CMD = 0x48,
91 REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */
94 RADAR_NOTIFICATION = 0x70, /* not used */
95 REPLY_QUIET_CMD = 0x71, /* not used */
96 REPLY_CHANNEL_SWITCH = 0x72,
97 CHANNEL_SWITCH_NOTIFICATION = 0x73,
98 REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
99 SPECTRUM_MEASURE_NOTIFICATION = 0x75,
101 /* Power Management */
102 POWER_TABLE_CMD = 0x77,
103 PM_SLEEP_NOTIFICATION = 0x7A,
104 PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
106 /* Scan commands and notifications */
107 REPLY_SCAN_CMD = 0x80,
108 REPLY_SCAN_ABORT_CMD = 0x81,
109 SCAN_START_NOTIFICATION = 0x82,
110 SCAN_RESULTS_NOTIFICATION = 0x83,
111 SCAN_COMPLETE_NOTIFICATION = 0x84,
113 /* IBSS/AP commands */
114 BEACON_NOTIFICATION = 0x90,
115 REPLY_TX_BEACON = 0x91,
116 WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */
118 /* Miscellaneous commands */
119 QUIET_NOTIFICATION = 0x96, /* not used */
120 REPLY_TX_PWR_TABLE_CMD = 0x97,
121 MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */
123 /* Bluetooth device coexistance config command */
124 REPLY_BT_CONFIG = 0x9b,
127 REPLY_STATISTICS_CMD = 0x9c,
128 STATISTICS_NOTIFICATION = 0x9d,
130 /* RF-KILL commands and notifications */
131 REPLY_CARD_STATE_CMD = 0xa0,
132 CARD_STATE_NOTIFICATION = 0xa1,
134 /* Missed beacons notification */
135 MISSED_BEACONS_NOTIFICATION = 0xa2,
137 REPLY_CT_KILL_CONFIG_CMD = 0xa4,
138 SENSITIVITY_CMD = 0xa8,
139 REPLY_PHY_CALIBRATION_CMD = 0xb0,
140 REPLY_RX_PHY_CMD = 0xc0,
141 REPLY_RX_MPDU_CMD = 0xc1,
142 REPLY_4965_RX = 0xc3,
143 REPLY_COMPRESSED_BA = 0xc5,
147 /******************************************************************************
149 * Commonly used structures and definitions:
150 * Command header, rate_n_flags, txpower
152 *****************************************************************************/
154 /* iwl4965_cmd_header flags value */
155 #define IWL_CMD_FAILED_MSK 0x40
158 * struct iwl4965_cmd_header
160 * This header format appears in the beginning of each command sent from the
161 * driver, and each response/notification received from uCode.
163 struct iwl4965_cmd_header {
164 u8 cmd; /* Command ID: REPLY_RXON, etc. */
165 u8 flags; /* IWL_CMD_* */
167 * The driver sets up the sequence number to values of its chosing.
168 * uCode does not use this value, but passes it back to the driver
169 * when sending the response to each driver-originated command, so
170 * the driver can match the response to the command. Since the values
171 * don't get used by uCode, the driver may set up an arbitrary format.
173 * There is one exception: uCode sets bit 15 when it originates
174 * the response/notification, i.e. when the response/notification
175 * is not a direct response to a command sent by the driver. For
176 * example, uCode issues REPLY_3945_RX when it sends a received frame
177 * to the driver; it is not a direct response to any driver command.
179 * The Linux driver uses the following format:
181 * 0:7 index/position within Tx queue
182 * 8:13 Tx queue selection
183 * 14:14 driver sets this to indicate command is in the 'huge'
184 * storage at the end of the command buffers, i.e. scan cmd
185 * 15:15 uCode sets this in uCode-originated response/notification
189 /* command or response/notification data follows immediately */
191 } __attribute__ ((packed));
194 * 4965 rate_n_flags bit fields
196 * rate_n_flags format is used in following 4965 commands:
197 * REPLY_4965_RX (response only)
198 * REPLY_TX (both command and response)
199 * REPLY_TX_LINK_QUALITY_CMD
201 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
211 * 3: 0) Single stream (SISO)
212 * 1) Dual stream (MIMO)
214 * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps FAT duplicate data
216 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
226 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
232 #define RATE_MCS_CODE_MSK 0x7
233 #define RATE_MCS_MIMO_POS 3
234 #define RATE_MCS_MIMO_MSK 0x8
235 #define RATE_MCS_HT_DUP_POS 5
236 #define RATE_MCS_HT_DUP_MSK 0x20
238 /* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
239 #define RATE_MCS_FLAGS_POS 8
240 #define RATE_MCS_HT_POS 8
241 #define RATE_MCS_HT_MSK 0x100
243 /* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */
244 #define RATE_MCS_CCK_POS 9
245 #define RATE_MCS_CCK_MSK 0x200
247 /* Bit 10: (1) Use Green Field preamble */
248 #define RATE_MCS_GF_POS 10
249 #define RATE_MCS_GF_MSK 0x400
251 /* Bit 11: (1) Use 40Mhz FAT chnl width, (0) use 20 MHz legacy chnl width */
252 #define RATE_MCS_FAT_POS 11
253 #define RATE_MCS_FAT_MSK 0x800
255 /* Bit 12: (1) Duplicate data on both 20MHz chnls. FAT (bit 11) must be set. */
256 #define RATE_MCS_DUP_POS 12
257 #define RATE_MCS_DUP_MSK 0x1000
259 /* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
260 #define RATE_MCS_SGI_POS 13
261 #define RATE_MCS_SGI_MSK 0x2000
264 * rate_n_flags Tx antenna masks (4965 has 2 transmitters):
265 * bit14:15 01 B inactive, A active
266 * 10 B active, A inactive
269 #define RATE_MCS_ANT_A_POS 14
270 #define RATE_MCS_ANT_B_POS 15
271 #define RATE_MCS_ANT_A_MSK 0x4000
272 #define RATE_MCS_ANT_B_MSK 0x8000
273 #define RATE_MCS_ANT_AB_MSK 0xc000
277 * struct iwl4965_tx_power - txpower format used in REPLY_SCAN_CMD
279 * Scan uses only one transmitter, so only one analog/dsp gain pair is needed.
281 struct iwl4965_tx_power {
282 u8 tx_gain; /* gain for analog radio */
283 u8 dsp_atten; /* gain for DSP */
284 } __attribute__ ((packed));
286 #define POWER_TABLE_NUM_ENTRIES 33
287 #define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32
288 #define POWER_TABLE_CCK_ENTRY 32
291 * union iwl4965_tx_power_dual_stream
293 * Host format used for REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
294 * Use __le32 version (struct tx_power_dual_stream) when building command.
296 * Driver provides radio gain and DSP attenuation settings to device in pairs,
297 * one value for each transmitter chain. The first value is for transmitter A,
298 * second for transmitter B.
300 * For SISO bit rates, both values in a pair should be identical.
301 * For MIMO rates, one value may be different from the other,
302 * in order to balance the Tx output between the two transmitters.
304 * See more details in doc for TXPOWER in iwl-4965-hw.h.
306 union iwl4965_tx_power_dual_stream {
309 u8 dsp_predis_atten[2];
315 * struct tx_power_dual_stream
317 * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
319 * Same format as iwl_tx_power_dual_stream, but __le32
321 struct tx_power_dual_stream {
323 } __attribute__ ((packed));
326 * struct iwl4965_tx_power_db
328 * Entire table within REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
330 struct iwl4965_tx_power_db {
331 struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES];
332 } __attribute__ ((packed));
335 /******************************************************************************
337 * Alive and Error Commands & Responses:
339 *****************************************************************************/
341 #define UCODE_VALID_OK __constant_cpu_to_le32(0x1)
342 #define INITIALIZE_SUBTYPE (9)
345 * ("Initialize") REPLY_ALIVE = 0x1 (response only, not a command)
347 * uCode issues this "initialize alive" notification once the initialization
348 * uCode image has completed its work, and is ready to load the runtime image.
349 * This is the *first* "alive" notification that the driver will receive after
350 * rebooting uCode; the "initialize" alive is indicated by subtype field == 9.
352 * See comments documenting "BSM" (bootstrap state machine).
354 * For 4965, this notification contains important calibration data for
355 * calculating txpower settings:
357 * 1) Power supply voltage indication. The voltage sensor outputs higher
358 * values for lower voltage, and vice versa.
360 * 2) Temperature measurement parameters, for each of two channel widths
361 * (20 MHz and 40 MHz) supported by the radios. Temperature sensing
362 * is done via one of the receiver chains, and channel width influences
365 * 3) Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation,
366 * for each of 5 frequency ranges.
368 struct iwl4965_init_alive_resp {
374 u8 ver_subtype; /* "9" for initialize alive */
376 __le32 log_event_table_ptr;
377 __le32 error_event_table_ptr;
381 /* calibration values from "initialize" uCode */
382 __le32 voltage; /* signed, higher value is lower voltage */
383 __le32 therm_r1[2]; /* signed, 1st for normal, 2nd for FAT channel*/
384 __le32 therm_r2[2]; /* signed */
385 __le32 therm_r3[2]; /* signed */
386 __le32 therm_r4[2]; /* signed */
387 __le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups,
389 } __attribute__ ((packed));
393 * REPLY_ALIVE = 0x1 (response only, not a command)
395 * uCode issues this "alive" notification once the runtime image is ready
396 * to receive commands from the driver. This is the *second* "alive"
397 * notification that the driver will receive after rebooting uCode;
398 * this "alive" is indicated by subtype field != 9.
400 * See comments documenting "BSM" (bootstrap state machine).
402 * This response includes two pointers to structures within the device's
403 * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
405 * 1) log_event_table_ptr indicates base of the event log. This traces
406 * a 256-entry history of uCode execution within a circular buffer.
407 * Its header format is:
409 * __le32 log_size; log capacity (in number of entries)
410 * __le32 type; (1) timestamp with each entry, (0) no timestamp
411 * __le32 wraps; # times uCode has wrapped to top of circular buffer
412 * __le32 write_index; next circular buffer entry that uCode would fill
414 * The header is followed by the circular buffer of log entries. Entries
415 * with timestamps have the following format:
417 * __le32 event_id; range 0 - 1500
418 * __le32 timestamp; low 32 bits of TSF (of network, if associated)
419 * __le32 data; event_id-specific data value
421 * Entries without timestamps contain only event_id and data.
423 * 2) error_event_table_ptr indicates base of the error log. This contains
424 * information about any uCode error that occurs. For 4965, the format
425 * of the error log is:
427 * __le32 valid; (nonzero) valid, (0) log is empty
428 * __le32 error_id; type of error
429 * __le32 pc; program counter
430 * __le32 blink1; branch link
431 * __le32 blink2; branch link
432 * __le32 ilink1; interrupt link
433 * __le32 ilink2; interrupt link
434 * __le32 data1; error-specific data
435 * __le32 data2; error-specific data
436 * __le32 line; source code line of error
437 * __le32 bcon_time; beacon timer
438 * __le32 tsf_low; network timestamp function timer
439 * __le32 tsf_hi; network timestamp function timer
441 * The Linux driver can print both logs to the system log when a uCode error
444 struct iwl4965_alive_resp {
450 u8 ver_subtype; /* not "9" for runtime alive */
452 __le32 log_event_table_ptr; /* SRAM address for event log */
453 __le32 error_event_table_ptr; /* SRAM address for error log */
456 } __attribute__ ((packed));
466 * REPLY_ERROR = 0x2 (response only, not a command)
468 struct iwl4965_error_resp {
472 __le16 bad_cmd_seq_num;
475 } __attribute__ ((packed));
477 /******************************************************************************
479 * RXON Commands & Responses:
481 *****************************************************************************/
484 * Rx config defines & structure
486 /* rx_config device types */
488 RXON_DEV_TYPE_AP = 1,
489 RXON_DEV_TYPE_ESS = 3,
490 RXON_DEV_TYPE_IBSS = 4,
491 RXON_DEV_TYPE_SNIFFER = 6,
495 #define RXON_RX_CHAIN_DRIVER_FORCE_MSK __constant_cpu_to_le16(0x1 << 0)
496 #define RXON_RX_CHAIN_VALID_MSK __constant_cpu_to_le16(0x7 << 1)
497 #define RXON_RX_CHAIN_VALID_POS (1)
498 #define RXON_RX_CHAIN_FORCE_SEL_MSK __constant_cpu_to_le16(0x7 << 4)
499 #define RXON_RX_CHAIN_FORCE_SEL_POS (4)
500 #define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK __constant_cpu_to_le16(0x7 << 7)
501 #define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
502 #define RXON_RX_CHAIN_CNT_MSK __constant_cpu_to_le16(0x3 << 10)
503 #define RXON_RX_CHAIN_CNT_POS (10)
504 #define RXON_RX_CHAIN_MIMO_CNT_MSK __constant_cpu_to_le16(0x3 << 12)
505 #define RXON_RX_CHAIN_MIMO_CNT_POS (12)
506 #define RXON_RX_CHAIN_MIMO_FORCE_MSK __constant_cpu_to_le16(0x1 << 14)
507 #define RXON_RX_CHAIN_MIMO_FORCE_POS (14)
509 /* rx_config flags */
510 /* band & modulation selection */
511 #define RXON_FLG_BAND_24G_MSK __constant_cpu_to_le32(1 << 0)
512 #define RXON_FLG_CCK_MSK __constant_cpu_to_le32(1 << 1)
513 /* auto detection enable */
514 #define RXON_FLG_AUTO_DETECT_MSK __constant_cpu_to_le32(1 << 2)
515 /* TGg protection when tx */
516 #define RXON_FLG_TGG_PROTECT_MSK __constant_cpu_to_le32(1 << 3)
517 /* cck short slot & preamble */
518 #define RXON_FLG_SHORT_SLOT_MSK __constant_cpu_to_le32(1 << 4)
519 #define RXON_FLG_SHORT_PREAMBLE_MSK __constant_cpu_to_le32(1 << 5)
520 /* antenna selection */
521 #define RXON_FLG_DIS_DIV_MSK __constant_cpu_to_le32(1 << 7)
522 #define RXON_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0x0f00)
523 #define RXON_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8)
524 #define RXON_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9)
525 /* radar detection enable */
526 #define RXON_FLG_RADAR_DETECT_MSK __constant_cpu_to_le32(1 << 12)
527 #define RXON_FLG_TGJ_NARROW_BAND_MSK __constant_cpu_to_le32(1 << 13)
528 /* rx response to host with 8-byte TSF
529 * (according to ON_AIR deassertion) */
530 #define RXON_FLG_TSF2HOST_MSK __constant_cpu_to_le32(1 << 15)
534 #define RXON_FLG_CTRL_CHANNEL_LOC_POS (22)
535 #define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK __constant_cpu_to_le32(0x1 << 22)
537 #define RXON_FLG_HT_OPERATING_MODE_POS (23)
539 #define RXON_FLG_HT_PROT_MSK __constant_cpu_to_le32(0x1 << 23)
540 #define RXON_FLG_FAT_PROT_MSK __constant_cpu_to_le32(0x2 << 23)
542 #define RXON_FLG_CHANNEL_MODE_POS (25)
543 #define RXON_FLG_CHANNEL_MODE_MSK __constant_cpu_to_le32(0x3 << 25)
544 #define RXON_FLG_CHANNEL_MODE_PURE_40_MSK __constant_cpu_to_le32(0x1 << 25)
545 #define RXON_FLG_CHANNEL_MODE_MIXED_MSK __constant_cpu_to_le32(0x2 << 25)
547 /* rx_config filter flags */
548 /* accept all data frames */
549 #define RXON_FILTER_PROMISC_MSK __constant_cpu_to_le32(1 << 0)
550 /* pass control & management to host */
551 #define RXON_FILTER_CTL2HOST_MSK __constant_cpu_to_le32(1 << 1)
552 /* accept multi-cast */
553 #define RXON_FILTER_ACCEPT_GRP_MSK __constant_cpu_to_le32(1 << 2)
554 /* don't decrypt uni-cast frames */
555 #define RXON_FILTER_DIS_DECRYPT_MSK __constant_cpu_to_le32(1 << 3)
556 /* don't decrypt multi-cast frames */
557 #define RXON_FILTER_DIS_GRP_DECRYPT_MSK __constant_cpu_to_le32(1 << 4)
558 /* STA is associated */
559 #define RXON_FILTER_ASSOC_MSK __constant_cpu_to_le32(1 << 5)
560 /* transfer to host non bssid beacons in associated state */
561 #define RXON_FILTER_BCON_AWARE_MSK __constant_cpu_to_le32(1 << 6)
564 * REPLY_RXON = 0x10 (command, has simple generic response)
566 * RXON tunes the radio tuner to a service channel, and sets up a number
567 * of parameters that are used primarily for Rx, but also for Tx operations.
569 * NOTE: When tuning to a new channel, driver must set the
570 * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent
571 * info within the device, including the station tables, tx retry
572 * rate tables, and txpower tables. Driver must build a new station
573 * table and txpower table before transmitting anything on the RXON
576 * NOTE: All RXONs wipe clean the internal txpower table. Driver must
577 * issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
578 * regardless of whether RXON_FILTER_ASSOC_MSK is set.
580 struct iwl4965_rxon_cmd {
585 u8 wlap_bssid_addr[6];
596 u8 ofdm_ht_single_stream_basic_rates;
597 u8 ofdm_ht_dual_stream_basic_rates;
598 } __attribute__ ((packed));
601 * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
603 struct iwl4965_rxon_assoc_cmd {
608 u8 ofdm_ht_single_stream_basic_rates;
609 u8 ofdm_ht_dual_stream_basic_rates;
610 __le16 rx_chain_select_flags;
612 } __attribute__ ((packed));
615 * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
617 struct iwl4965_rxon_time_cmd {
619 __le16 beacon_interval;
621 __le32 beacon_init_val;
622 __le16 listen_interval;
624 } __attribute__ ((packed));
627 * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
629 struct iwl4965_channel_switch_cmd {
634 __le32 rxon_filter_flags;
636 struct iwl4965_tx_power_db tx_power;
637 } __attribute__ ((packed));
640 * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
642 struct iwl4965_csa_notification {
645 __le32 status; /* 0 - OK, 1 - fail */
646 } __attribute__ ((packed));
648 /******************************************************************************
650 * Quality-of-Service (QOS) Commands & Responses:
652 *****************************************************************************/
655 * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
656 * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
658 * @cw_min: Contention window, start value in numbers of slots.
659 * Should be a power-of-2, minus 1. Device's default is 0x0f.
660 * @cw_max: Contention window, max value in numbers of slots.
661 * Should be a power-of-2, minus 1. Device's default is 0x3f.
662 * @aifsn: Number of slots in Arbitration Interframe Space (before
663 * performing random backoff timing prior to Tx). Device default 1.
664 * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
666 * Device will automatically increase contention window by (2*CW) + 1 for each
667 * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
668 * value, to cap the CW value.
670 struct iwl4965_ac_qos {
676 } __attribute__ ((packed));
678 /* QoS flags defines */
679 #define QOS_PARAM_FLG_UPDATE_EDCA_MSK __constant_cpu_to_le32(0x01)
680 #define QOS_PARAM_FLG_TGN_MSK __constant_cpu_to_le32(0x02)
681 #define QOS_PARAM_FLG_TXOP_TYPE_MSK __constant_cpu_to_le32(0x10)
683 /* Number of Access Categories (AC) (EDCA), queues 0..3 */
687 * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
689 * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
690 * 0: Background, 1: Best Effort, 2: Video, 3: Voice.
692 struct iwl4965_qosparam_cmd {
694 struct iwl4965_ac_qos ac[AC_NUM];
695 } __attribute__ ((packed));
697 /******************************************************************************
699 * Add/Modify Stations Commands & Responses:
701 *****************************************************************************/
703 * Multi station support
706 /* Special, dedicated locations within device's station table */
708 #define IWL_MULTICAST_ID 1
710 #define IWL4965_BROADCAST_ID 31
711 #define IWL4965_STATION_COUNT 32
713 #define IWL_STATION_COUNT 32 /* MAX(3945,4965)*/
714 #define IWL_INVALID_STATION 255
716 #define STA_FLG_PWR_SAVE_MSK __constant_cpu_to_le32(1 << 8);
717 #define STA_FLG_RTS_MIMO_PROT_MSK __constant_cpu_to_le32(1 << 17)
718 #define STA_FLG_AGG_MPDU_8US_MSK __constant_cpu_to_le32(1 << 18)
719 #define STA_FLG_MAX_AGG_SIZE_POS (19)
720 #define STA_FLG_MAX_AGG_SIZE_MSK __constant_cpu_to_le32(3 << 19)
721 #define STA_FLG_FAT_EN_MSK __constant_cpu_to_le32(1 << 21)
722 #define STA_FLG_MIMO_DIS_MSK __constant_cpu_to_le32(1 << 22)
723 #define STA_FLG_AGG_MPDU_DENSITY_POS (23)
724 #define STA_FLG_AGG_MPDU_DENSITY_MSK __constant_cpu_to_le32(7 << 23)
726 /* Use in mode field. 1: modify existing entry, 0: add new station entry */
727 #define STA_CONTROL_MODIFY_MSK 0x01
729 /* key flags __le16*/
730 #define STA_KEY_FLG_ENCRYPT_MSK __constant_cpu_to_le16(0x0007)
731 #define STA_KEY_FLG_NO_ENC __constant_cpu_to_le16(0x0000)
732 #define STA_KEY_FLG_WEP __constant_cpu_to_le16(0x0001)
733 #define STA_KEY_FLG_CCMP __constant_cpu_to_le16(0x0002)
734 #define STA_KEY_FLG_TKIP __constant_cpu_to_le16(0x0003)
736 #define STA_KEY_FLG_KEYID_POS 8
737 #define STA_KEY_FLG_INVALID __constant_cpu_to_le16(0x0800)
738 /* wep key is either from global key (0) or from station info array (1) */
739 #define STA_KEY_FLG_MAP_KEY_MSK __constant_cpu_to_le16(0x0008)
741 /* wep key in STA: 5-bytes (0) or 13-bytes (1) */
742 #define STA_KEY_FLG_KEY_SIZE_MSK __constant_cpu_to_le16(0x1000)
743 #define STA_KEY_MULTICAST_MSK __constant_cpu_to_le16(0x4000)
744 #define STA_KEY_MAX_NUM 8
746 /* Flags indicate whether to modify vs. don't change various station params */
747 #define STA_MODIFY_KEY_MASK 0x01
748 #define STA_MODIFY_TID_DISABLE_TX 0x02
749 #define STA_MODIFY_TX_RATE_MSK 0x04
750 #define STA_MODIFY_ADDBA_TID_MSK 0x08
751 #define STA_MODIFY_DELBA_TID_MSK 0x10
753 /* Receiver address (actually, Rx station's index into station table),
754 * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
755 #define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid))
757 struct iwl4965_keyinfo {
759 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
761 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
764 u8 key[16]; /* 16-byte unicast decryption key */
765 } __attribute__ ((packed));
768 * struct sta_id_modify
769 * @addr[ETH_ALEN]: station's MAC address
770 * @sta_id: index of station in uCode's station table
771 * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
773 * Driver selects unused table index when adding new station,
774 * or the index to a pre-existing station entry when modifying that station.
775 * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
777 * modify_mask flags select which parameters to modify vs. leave alone.
779 struct sta_id_modify {
785 } __attribute__ ((packed));
788 * REPLY_ADD_STA = 0x18 (command)
790 * The device contains an internal table of per-station information,
791 * with info on security keys, aggregation parameters, and Tx rates for
792 * initial Tx attempt and any retries (4965 uses REPLY_TX_LINK_QUALITY_CMD,
793 * 3945 uses REPLY_RATE_SCALE to set up rate tables).
795 * REPLY_ADD_STA sets up the table entry for one station, either creating
796 * a new entry, or modifying a pre-existing one.
798 * NOTE: RXON command (without "associated" bit set) wipes the station table
799 * clean. Moving into RF_KILL state does this also. Driver must set up
800 * new station table before transmitting anything on the RXON channel
801 * (except active scans or active measurements; those commands carry
802 * their own txpower/rate setup data).
804 * When getting started on a new channel, driver must set up the
805 * IWL_BROADCAST_ID entry (last entry in the table). For a client
806 * station in a BSS, once an AP is selected, driver sets up the AP STA
807 * in the IWL_AP_ID entry (1st entry in the table). BROADCAST and AP
808 * are all that are needed for a BSS client station. If the device is
809 * used as AP, or in an IBSS network, driver must set up station table
810 * entries for all STAs in network, starting with index IWL_STA_ID.
812 struct iwl4965_addsta_cmd {
813 u8 mode; /* 1: modify existing, 0: add new station */
815 struct sta_id_modify sta;
816 struct iwl4965_keyinfo key;
817 __le32 station_flags; /* STA_FLG_* */
818 __le32 station_flags_msk; /* STA_FLG_* */
820 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
821 * corresponding to bit (e.g. bit 5 controls TID 5).
822 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
823 __le16 tid_disable_tx;
827 /* TID for which to add block-ack support.
828 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
829 u8 add_immediate_ba_tid;
831 /* TID for which to remove block-ack support.
832 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
833 u8 remove_immediate_ba_tid;
835 /* Starting Sequence Number for added block-ack support.
836 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
837 __le16 add_immediate_ba_ssn;
840 } __attribute__ ((packed));
842 #define ADD_STA_SUCCESS_MSK 0x1
843 #define ADD_STA_NO_ROOM_IN_TABLE 0x2
844 #define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4
845 #define ADD_STA_MODIFY_NON_EXIST_STA 0x8
847 * REPLY_ADD_STA = 0x18 (response)
849 struct iwl4965_add_sta_resp {
850 u8 status; /* ADD_STA_* */
851 } __attribute__ ((packed));
854 /******************************************************************************
858 *****************************************************************************/
860 struct iwl4965_rx_frame_stats {
868 } __attribute__ ((packed));
870 struct iwl4965_rx_frame_hdr {
877 } __attribute__ ((packed));
879 #define RX_RES_STATUS_NO_CRC32_ERROR __constant_cpu_to_le32(1 << 0)
880 #define RX_RES_STATUS_NO_RXE_OVERFLOW __constant_cpu_to_le32(1 << 1)
882 #define RX_RES_PHY_FLAGS_BAND_24_MSK __constant_cpu_to_le16(1 << 0)
883 #define RX_RES_PHY_FLAGS_MOD_CCK_MSK __constant_cpu_to_le16(1 << 1)
884 #define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK __constant_cpu_to_le16(1 << 2)
885 #define RX_RES_PHY_FLAGS_NARROW_BAND_MSK __constant_cpu_to_le16(1 << 3)
886 #define RX_RES_PHY_FLAGS_ANTENNA_MSK __constant_cpu_to_le16(0xf0)
888 #define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)
889 #define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)
890 #define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)
891 #define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)
892 #define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)
894 #define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)
895 #define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)
896 #define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)
897 #define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)
898 #define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)
900 struct iwl4965_rx_frame_end {
903 __le32 beacon_timestamp;
904 } __attribute__ ((packed));
907 * REPLY_3945_RX = 0x1b (response only, not a command)
909 * NOTE: DO NOT dereference from casts to this structure
910 * It is provided only for calculating minimum data set size.
911 * The actual offsets of the hdr and end are dynamic based on
914 struct iwl4965_rx_frame {
915 struct iwl4965_rx_frame_stats stats;
916 struct iwl4965_rx_frame_hdr hdr;
917 struct iwl4965_rx_frame_end end;
918 } __attribute__ ((packed));
920 /* Fixed (non-configurable) rx data from phy */
921 #define RX_PHY_FLAGS_ANTENNAE_OFFSET (4)
922 #define RX_PHY_FLAGS_ANTENNAE_MASK (0x70)
923 #define IWL_AGC_DB_MASK (0x3f80) /* MASK(7,13) */
924 #define IWL_AGC_DB_POS (7)
925 struct iwl4965_rx_non_cfg_phy {
926 __le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */
927 __le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */
928 u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */
930 } __attribute__ ((packed));
933 * REPLY_4965_RX = 0xc3 (response only, not a command)
934 * Used only for legacy (non 11n) frames.
936 #define RX_RES_PHY_CNT 14
937 struct iwl4965_rx_phy_res {
938 u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */
939 u8 cfg_phy_cnt; /* configurable DSP phy data byte count */
940 u8 stat_id; /* configurable DSP phy data set ID */
942 __le64 timestamp; /* TSF at on air rise */
943 __le32 beacon_time_stamp; /* beacon at on-air rise */
944 __le16 phy_flags; /* general phy flags: band, modulation, ... */
945 __le16 channel; /* channel number */
946 __le16 non_cfg_phy[RX_RES_PHY_CNT]; /* upto 14 phy entries */
948 __le32 rate_n_flags; /* RATE_MCS_* */
949 __le16 byte_count; /* frame's byte-count */
951 } __attribute__ ((packed));
953 struct iwl4965_rx_mpdu_res_start {
956 } __attribute__ ((packed));
959 /******************************************************************************
961 * Tx Commands & Responses:
963 * Driver must place each REPLY_TX command into one of the prioritized Tx
964 * queues in host DRAM, shared between driver and device (see comments for
965 * SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode
966 * are preparing to transmit, the device pulls the Tx command over the PCI
967 * bus via one of the device's Tx DMA channels, to fill an internal FIFO
968 * from which data will be transmitted.
970 * uCode handles all timing and protocol related to control frames
971 * (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler
972 * handle reception of block-acks; uCode updates the host driver via
973 * REPLY_COMPRESSED_BA (4965).
975 * uCode handles retrying Tx when an ACK is expected but not received.
976 * This includes trying lower data rates than the one requested in the Tx
977 * command, as set up by the REPLY_RATE_SCALE (for 3945) or
978 * REPLY_TX_LINK_QUALITY_CMD (4965).
980 * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
981 * This command must be executed after every RXON command, before Tx can occur.
982 *****************************************************************************/
984 /* REPLY_TX Tx flags field */
986 /* 1: Use Request-To-Send protocol before this frame.
987 * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK. */
988 #define TX_CMD_FLG_RTS_MSK __constant_cpu_to_le32(1 << 1)
990 /* 1: Transmit Clear-To-Send to self before this frame.
991 * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
992 * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK. */
993 #define TX_CMD_FLG_CTS_MSK __constant_cpu_to_le32(1 << 2)
995 /* 1: Expect ACK from receiving station
996 * 0: Don't expect ACK (MAC header's duration field s/b 0)
997 * Set this for unicast frames, but not broadcast/multicast. */
998 #define TX_CMD_FLG_ACK_MSK __constant_cpu_to_le32(1 << 3)
1001 * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
1002 * Tx command's initial_rate_index indicates first rate to try;
1003 * uCode walks through table for additional Tx attempts.
1004 * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
1005 * This rate will be used for all Tx attempts; it will not be scaled. */
1006 #define TX_CMD_FLG_STA_RATE_MSK __constant_cpu_to_le32(1 << 4)
1008 /* 1: Expect immediate block-ack.
1009 * Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */
1010 #define TX_CMD_FLG_IMM_BA_RSP_MASK __constant_cpu_to_le32(1 << 6)
1012 /* 1: Frame requires full Tx-Op protection.
1013 * Set this if either RTS or CTS Tx Flag gets set. */
1014 #define TX_CMD_FLG_FULL_TXOP_PROT_MSK __constant_cpu_to_le32(1 << 7)
1016 /* Tx antenna selection field; used only for 3945, reserved (0) for 4965.
1017 * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
1018 #define TX_CMD_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0xf00)
1019 #define TX_CMD_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8)
1020 #define TX_CMD_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9)
1022 /* 1: Ignore Bluetooth priority for this frame.
1023 * 0: Delay Tx until Bluetooth device is done (normal usage). */
1024 #define TX_CMD_FLG_BT_DIS_MSK __constant_cpu_to_le32(1 << 12)
1026 /* 1: uCode overrides sequence control field in MAC header.
1027 * 0: Driver provides sequence control field in MAC header.
1028 * Set this for management frames, non-QOS data frames, non-unicast frames,
1029 * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
1030 #define TX_CMD_FLG_SEQ_CTL_MSK __constant_cpu_to_le32(1 << 13)
1032 /* 1: This frame is non-last MPDU; more fragments are coming.
1033 * 0: Last fragment, or not using fragmentation. */
1034 #define TX_CMD_FLG_MORE_FRAG_MSK __constant_cpu_to_le32(1 << 14)
1036 /* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
1037 * 0: No TSF required in outgoing frame.
1038 * Set this for transmitting beacons and probe responses. */
1039 #define TX_CMD_FLG_TSF_MSK __constant_cpu_to_le32(1 << 16)
1041 /* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
1042 * alignment of frame's payload data field.
1044 * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
1045 * field (but not both). Driver must align frame data (i.e. data following
1046 * MAC header) to DWORD boundary. */
1047 #define TX_CMD_FLG_MH_PAD_MSK __constant_cpu_to_le32(1 << 20)
1049 /* accelerate aggregation support
1050 * 0 - no CCMP encryption; 1 - CCMP encryption */
1051 #define TX_CMD_FLG_AGG_CCMP_MSK __constant_cpu_to_le32(1 << 22)
1053 /* HCCA-AP - disable duration overwriting. */
1054 #define TX_CMD_FLG_DUR_MSK __constant_cpu_to_le32(1 << 25)
1058 * TX command security control
1060 #define TX_CMD_SEC_WEP 0x01
1061 #define TX_CMD_SEC_CCM 0x02
1062 #define TX_CMD_SEC_TKIP 0x03
1063 #define TX_CMD_SEC_MSK 0x03
1064 #define TX_CMD_SEC_SHIFT 6
1065 #define TX_CMD_SEC_KEY128 0x08
1068 * 4965 uCode updates these Tx attempt count values in host DRAM.
1069 * Used for managing Tx retries when expecting block-acks.
1070 * Driver should set these fields to 0.
1072 struct iwl4965_dram_scratch {
1073 u8 try_cnt; /* Tx attempts */
1074 u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */
1076 } __attribute__ ((packed));
1079 * REPLY_TX = 0x1c (command)
1081 struct iwl4965_tx_cmd {
1084 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
1085 * + 8 byte IV for CCM or TKIP (not used for WEP)
1087 * + 8-byte MIC (not used for CCM/WEP)
1088 * NOTE: Does not include Tx command bytes, post-MAC pad bytes,
1089 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
1090 * Range: 14-2342 bytes.
1095 * MPDU or MSDU byte count for next frame.
1096 * Used for fragmentation and bursting, but not 11n aggregation.
1097 * Same as "len", but for next frame. Set to 0 if not applicable.
1099 __le16 next_frame_len;
1101 __le32 tx_flags; /* TX_CMD_FLG_* */
1103 /* 4965's uCode may modify this field of the Tx command (in host DRAM!).
1104 * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
1105 struct iwl4965_dram_scratch scratch;
1107 /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
1108 __le32 rate_n_flags; /* RATE_MCS_* */
1110 /* Index of destination station in uCode's station table */
1113 /* Type of security encryption: CCM or TKIP */
1114 u8 sec_ctl; /* TX_CMD_SEC_* */
1117 * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial
1118 * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for
1119 * data frames, this field may be used to selectively reduce initial
1120 * rate (via non-0 value) for special frames (e.g. management), while
1121 * still supporting rate scaling for all frames.
1123 u8 initial_rate_index;
1126 __le16 next_frame_flags;
1133 /* Host DRAM physical address pointer to "scratch" in this command.
1134 * Must be dword aligned. "0" in dram_lsb_ptr disables usage. */
1135 __le32 dram_lsb_ptr;
1138 u8 rts_retry_limit; /*byte 50 */
1139 u8 data_retry_limit; /*byte 51 */
1142 __le16 pm_frame_timeout;
1143 __le16 attempt_duration;
1147 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
1148 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
1153 * MAC header goes here, followed by 2 bytes padding if MAC header
1154 * length is 26 or 30 bytes, followed by payload data
1157 struct ieee80211_hdr hdr[0];
1158 } __attribute__ ((packed));
1160 /* TX command response is sent after *all* transmission attempts.
1164 * TX_STATUS_FAIL_NEXT_FRAG
1166 * If the fragment flag in the MAC header for the frame being transmitted
1167 * is set and there is insufficient time to transmit the next frame, the
1168 * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
1170 * TX_STATUS_FIFO_UNDERRUN
1172 * Indicates the host did not provide bytes to the FIFO fast enough while
1173 * a TX was in progress.
1175 * TX_STATUS_FAIL_MGMNT_ABORT
1177 * This status is only possible if the ABORT ON MGMT RX parameter was
1178 * set to true with the TX command.
1180 * If the MSB of the status parameter is set then an abort sequence is
1181 * required. This sequence consists of the host activating the TX Abort
1182 * control line, and then waiting for the TX Abort command response. This
1183 * indicates that a the device is no longer in a transmit state, and that the
1184 * command FIFO has been cleared. The host must then deactivate the TX Abort
1185 * control line. Receiving is still allowed in this case.
1188 TX_STATUS_SUCCESS = 0x01,
1189 TX_STATUS_DIRECT_DONE = 0x02,
1190 TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
1191 TX_STATUS_FAIL_LONG_LIMIT = 0x83,
1192 TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
1193 TX_STATUS_FAIL_MGMNT_ABORT = 0x85,
1194 TX_STATUS_FAIL_NEXT_FRAG = 0x86,
1195 TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
1196 TX_STATUS_FAIL_DEST_PS = 0x88,
1197 TX_STATUS_FAIL_ABORTED = 0x89,
1198 TX_STATUS_FAIL_BT_RETRY = 0x8a,
1199 TX_STATUS_FAIL_STA_INVALID = 0x8b,
1200 TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
1201 TX_STATUS_FAIL_TID_DISABLE = 0x8d,
1202 TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
1203 TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
1204 TX_STATUS_FAIL_TX_LOCKED = 0x90,
1205 TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
1208 #define TX_PACKET_MODE_REGULAR 0x0000
1209 #define TX_PACKET_MODE_BURST_SEQ 0x0100
1210 #define TX_PACKET_MODE_BURST_FIRST 0x0200
1213 TX_POWER_PA_NOT_ACTIVE = 0x0,
1217 TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */
1218 TX_STATUS_DELAY_MSK = 0x00000040,
1219 TX_STATUS_ABORT_MSK = 0x00000080,
1220 TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */
1221 TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */
1222 TX_RESERVED = 0x00780000, /* bits 19:22 */
1223 TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */
1224 TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */
1227 /* *******************************
1228 * TX aggregation status
1229 ******************************* */
1232 AGG_TX_STATE_TRANSMITTED = 0x00,
1233 AGG_TX_STATE_UNDERRUN_MSK = 0x01,
1234 AGG_TX_STATE_BT_PRIO_MSK = 0x02,
1235 AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
1236 AGG_TX_STATE_ABORT_MSK = 0x08,
1237 AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
1238 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
1239 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
1240 AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
1241 AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
1242 AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
1243 AGG_TX_STATE_DUMP_TX_MSK = 0x200,
1244 AGG_TX_STATE_DELAY_TX_MSK = 0x400
1247 #define AGG_TX_STATE_LAST_SENT_MSK \
1248 (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
1249 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
1250 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
1252 /* # tx attempts for first frame in aggregation */
1253 #define AGG_TX_STATE_TRY_CNT_POS 12
1254 #define AGG_TX_STATE_TRY_CNT_MSK 0xf000
1256 /* Command ID and sequence number of Tx command for this frame */
1257 #define AGG_TX_STATE_SEQ_NUM_POS 16
1258 #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
1261 * REPLY_TX = 0x1c (response)
1263 * This response may be in one of two slightly different formats, indicated
1264 * by the frame_count field:
1266 * 1) No aggregation (frame_count == 1). This reports Tx results for
1267 * a single frame. Multiple attempts, at various bit rates, may have
1268 * been made for this frame.
1270 * 2) Aggregation (frame_count > 1). This reports Tx results for
1271 * 2 or more frames that used block-acknowledge. All frames were
1272 * transmitted at same rate. Rate scaling may have been used if first
1273 * frame in this new agg block failed in previous agg block(s).
1275 * Note that, for aggregation, ACK (block-ack) status is not delivered here;
1276 * block-ack has not been received by the time the 4965 records this status.
1277 * This status relates to reasons the tx might have been blocked or aborted
1278 * within the sending station (this 4965), rather than whether it was
1279 * received successfully by the destination station.
1281 struct iwl4965_tx_resp {
1282 u8 frame_count; /* 1 no aggregation, >1 aggregation */
1283 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
1284 u8 failure_rts; /* # failures due to unsuccessful RTS */
1285 u8 failure_frame; /* # failures due to no ACK (unused for agg) */
1287 /* For non-agg: Rate at which frame was successful.
1288 * For agg: Rate at which all frames were transmitted. */
1289 __le32 rate_n_flags; /* RATE_MCS_* */
1291 /* For non-agg: RTS + CTS + frame tx attempts time + ACK.
1292 * For agg: RTS + CTS + aggregation tx time + block-ack time. */
1293 __le16 wireless_media_time; /* uSecs */
1296 __le32 pa_power1; /* RF power amplifier measurement (not used) */
1300 * For non-agg: frame status TX_STATUS_*
1301 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1302 * fields follow this one, up to frame_count.
1304 * 11- 0: AGG_TX_STATE_* status code
1305 * 15-12: Retry count for 1st frame in aggregation (retries
1306 * occur if tx failed for this frame when it was a
1307 * member of a previous aggregation block). If rate
1308 * scaling is used, retry count indicates the rate
1309 * table entry used for all frames in the new agg.
1310 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1312 __le32 status; /* TX status (for aggregation status of 1st frame) */
1313 } __attribute__ ((packed));
1315 struct agg_tx_status {
1318 } __attribute__ ((packed));
1320 struct iwl4965_tx_resp_agg {
1321 u8 frame_count; /* 1 no aggregation, >1 aggregation */
1325 __le32 rate_n_flags;
1326 __le16 wireless_media_time;
1330 struct agg_tx_status status; /* TX status (for aggregation status */
1332 } __attribute__ ((packed));
1335 * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
1337 * Reports Block-Acknowledge from recipient station
1339 struct iwl4965_compressed_ba_resp {
1340 __le32 sta_addr_lo32;
1341 __le16 sta_addr_hi16;
1344 /* Index of recipient (BA-sending) station in uCode's station table */
1351 } __attribute__ ((packed));
1354 * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
1356 * See details under "TXPOWER" in iwl-4965-hw.h.
1358 struct iwl4965_txpowertable_cmd {
1359 u8 band; /* 0: 5 GHz, 1: 2.4 GHz */
1362 struct iwl4965_tx_power_db tx_power;
1363 } __attribute__ ((packed));
1365 /*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
1366 #define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0)
1368 /* # of EDCA prioritized tx fifos */
1369 #define LINK_QUAL_AC_NUM AC_NUM
1371 /* # entries in rate scale table to support Tx retries */
1372 #define LINK_QUAL_MAX_RETRY_NUM 16
1374 /* Tx antenna selection values */
1375 #define LINK_QUAL_ANT_A_MSK (1 << 0)
1376 #define LINK_QUAL_ANT_B_MSK (1 << 1)
1377 #define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
1381 * struct iwl4965_link_qual_general_params
1383 * Used in REPLY_TX_LINK_QUALITY_CMD
1385 struct iwl4965_link_qual_general_params {
1388 /* No entries at or above this (driver chosen) index contain MIMO */
1391 /* Best single antenna to use for single stream (legacy, SISO). */
1392 u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */
1394 /* Best antennas to use for MIMO (unused for 4965, assumes both). */
1395 u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */
1398 * If driver needs to use different initial rates for different
1399 * EDCA QOS access categories (as implemented by tx fifos 0-3),
1400 * this table will set that up, by indicating the indexes in the
1401 * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
1402 * Otherwise, driver should set all entries to 0.
1405 * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
1406 * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
1408 u8 start_rate_index[LINK_QUAL_AC_NUM];
1409 } __attribute__ ((packed));
1412 * struct iwl4965_link_qual_agg_params
1414 * Used in REPLY_TX_LINK_QUALITY_CMD
1416 struct iwl4965_link_qual_agg_params {
1418 /* Maximum number of uSec in aggregation.
1419 * Driver should set this to 4000 (4 milliseconds). */
1420 __le16 agg_time_limit;
1423 * Number of Tx retries allowed for a frame, before that frame will
1424 * no longer be considered for the start of an aggregation sequence
1425 * (scheduler will then try to tx it as single frame).
1426 * Driver should set this to 3.
1428 u8 agg_dis_start_th;
1431 * Maximum number of frames in aggregation.
1432 * 0 = no limit (default). 1 = no aggregation.
1433 * Other values = max # frames in aggregation.
1435 u8 agg_frame_cnt_limit;
1438 } __attribute__ ((packed));
1441 * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
1443 * For 4965 only; 3945 uses REPLY_RATE_SCALE.
1445 * Each station in the 4965's internal station table has its own table of 16
1446 * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
1447 * an ACK is not received. This command replaces the entire table for
1450 * NOTE: Station must already be in 4965's station table. Use REPLY_ADD_STA.
1452 * The rate scaling procedures described below work well. Of course, other
1453 * procedures are possible, and may work better for particular environments.
1456 * FILLING THE RATE TABLE
1458 * Given a particular initial rate and mode, as determined by the rate
1459 * scaling algorithm described below, the Linux driver uses the following
1460 * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
1461 * Link Quality command:
1464 * 1) If using High-throughput (HT) (SISO or MIMO) initial rate:
1465 * a) Use this same initial rate for first 3 entries.
1466 * b) Find next lower available rate using same mode (SISO or MIMO),
1467 * use for next 3 entries. If no lower rate available, switch to
1468 * legacy mode (no FAT channel, no MIMO, no short guard interval).
1469 * c) If using MIMO, set command's mimo_delimiter to number of entries
1470 * using MIMO (3 or 6).
1471 * d) After trying 2 HT rates, switch to legacy mode (no FAT channel,
1472 * no MIMO, no short guard interval), at the next lower bit rate
1473 * (e.g. if second HT bit rate was 54, try 48 legacy), and follow
1474 * legacy procedure for remaining table entries.
1476 * 2) If using legacy initial rate:
1477 * a) Use the initial rate for only one entry.
1478 * b) For each following entry, reduce the rate to next lower available
1479 * rate, until reaching the lowest available rate.
1480 * c) When reducing rate, also switch antenna selection.
1481 * d) Once lowest available rate is reached, repeat this rate until
1482 * rate table is filled (16 entries), switching antenna each entry.
1485 * ACCUMULATING HISTORY
1487 * The rate scaling algorithm for 4965, as implemented in Linux driver, uses
1488 * two sets of frame Tx success history: One for the current/active modulation
1489 * mode, and one for a speculative/search mode that is being attempted. If the
1490 * speculative mode turns out to be more effective (i.e. actual transfer
1491 * rate is better), then the driver continues to use the speculative mode
1492 * as the new current active mode.
1494 * Each history set contains, separately for each possible rate, data for a
1495 * sliding window of the 62 most recent tx attempts at that rate. The data
1496 * includes a shifting bitmap of success(1)/failure(0), and sums of successful
1497 * and attempted frames, from which the driver can additionally calculate a
1498 * success ratio (success / attempted) and number of failures
1499 * (attempted - success), and control the size of the window (attempted).
1500 * The driver uses the bit map to remove successes from the success sum, as
1501 * the oldest tx attempts fall out of the window.
1503 * When the 4965 makes multiple tx attempts for a given frame, each attempt
1504 * might be at a different rate, and have different modulation characteristics
1505 * (e.g. antenna, fat channel, short guard interval), as set up in the rate
1506 * scaling table in the Link Quality command. The driver must determine
1507 * which rate table entry was used for each tx attempt, to determine which
1508 * rate-specific history to update, and record only those attempts that
1509 * match the modulation characteristics of the history set.
1511 * When using block-ack (aggregation), all frames are transmitted at the same
1512 * rate, since there is no per-attempt acknowledgement from the destination
1513 * station. The Tx response struct iwl_tx_resp indicates the Tx rate in
1514 * rate_n_flags field. After receiving a block-ack, the driver can update
1515 * history for the entire block all at once.
1518 * FINDING BEST STARTING RATE:
1520 * When working with a selected initial modulation mode (see below), the
1521 * driver attempts to find a best initial rate. The initial rate is the
1522 * first entry in the Link Quality command's rate table.
1524 * 1) Calculate actual throughput (success ratio * expected throughput, see
1525 * table below) for current initial rate. Do this only if enough frames
1526 * have been attempted to make the value meaningful: at least 6 failed
1527 * tx attempts, or at least 8 successes. If not enough, don't try rate
1530 * 2) Find available rates adjacent to current initial rate. Available means:
1531 * a) supported by hardware &&
1532 * b) supported by association &&
1533 * c) within any constraints selected by user
1535 * 3) Gather measured throughputs for adjacent rates. These might not have
1536 * enough history to calculate a throughput. That's okay, we might try
1537 * using one of them anyway!
1539 * 4) Try decreasing rate if, for current rate:
1540 * a) success ratio is < 15% ||
1541 * b) lower adjacent rate has better measured throughput ||
1542 * c) higher adjacent rate has worse throughput, and lower is unmeasured
1544 * As a sanity check, if decrease was determined above, leave rate
1546 * a) lower rate unavailable
1547 * b) success ratio at current rate > 85% (very good)
1548 * c) current measured throughput is better than expected throughput
1549 * of lower rate (under perfect 100% tx conditions, see table below)
1551 * 5) Try increasing rate if, for current rate:
1552 * a) success ratio is < 15% ||
1553 * b) both adjacent rates' throughputs are unmeasured (try it!) ||
1554 * b) higher adjacent rate has better measured throughput ||
1555 * c) lower adjacent rate has worse throughput, and higher is unmeasured
1557 * As a sanity check, if increase was determined above, leave rate
1559 * a) success ratio at current rate < 70%. This is not particularly
1560 * good performance; higher rate is sure to have poorer success.
1562 * 6) Re-evaluate the rate after each tx frame. If working with block-
1563 * acknowledge, history and statistics may be calculated for the entire
1564 * block (including prior history that fits within the history windows),
1565 * before re-evaluation.
1567 * FINDING BEST STARTING MODULATION MODE:
1569 * After working with a modulation mode for a "while" (and doing rate scaling),
1570 * the driver searches for a new initial mode in an attempt to improve
1571 * throughput. The "while" is measured by numbers of attempted frames:
1573 * For legacy mode, search for new mode after:
1574 * 480 successful frames, or 160 failed frames
1575 * For high-throughput modes (SISO or MIMO), search for new mode after:
1576 * 4500 successful frames, or 400 failed frames
1578 * Mode switch possibilities are (3 for each mode):
1581 * Change antenna, try SISO (if HT association), try MIMO (if HT association)
1583 * Change antenna, try MIMO, try shortened guard interval (SGI)
1585 * Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)
1587 * When trying a new mode, use the same bit rate as the old/current mode when
1588 * trying antenna switches and shortened guard interval. When switching to
1589 * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate
1590 * for which the expected throughput (under perfect conditions) is about the
1591 * same or slightly better than the actual measured throughput delivered by
1592 * the old/current mode.
1594 * Actual throughput can be estimated by multiplying the expected throughput
1595 * by the success ratio (successful / attempted tx frames). Frame size is
1596 * not considered in this calculation; it assumes that frame size will average
1597 * out to be fairly consistent over several samples. The following are
1598 * metric values for expected throughput assuming 100% success ratio.
1599 * Only G band has support for CCK rates:
1601 * RATE: 1 2 5 11 6 9 12 18 24 36 48 54 60
1603 * G: 7 13 35 58 40 57 72 98 121 154 177 186 186
1604 * A: 0 0 0 0 40 57 72 98 121 154 177 186 186
1605 * SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 202
1606 * SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 211
1607 * MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 251
1608 * SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 257
1609 * SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 257
1610 * SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 264
1611 * MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 289
1612 * SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 293
1614 * After the new mode has been tried for a short while (minimum of 6 failed
1615 * frames or 8 successful frames), compare success ratio and actual throughput
1616 * estimate of the new mode with the old. If either is better with the new
1617 * mode, continue to use the new mode.
1619 * Continue comparing modes until all 3 possibilities have been tried.
1620 * If moving from legacy to HT, try all 3 possibilities from the new HT
1621 * mode. After trying all 3, a best mode is found. Continue to use this mode
1622 * for the longer "while" described above (e.g. 480 successful frames for
1623 * legacy), and then repeat the search process.
1626 struct iwl4965_link_quality_cmd {
1628 /* Index of destination/recipient station in uCode's station table */
1631 __le16 control; /* not used */
1632 struct iwl4965_link_qual_general_params general_params;
1633 struct iwl4965_link_qual_agg_params agg_params;
1636 * Rate info; when using rate-scaling, Tx command's initial_rate_index
1637 * specifies 1st Tx rate attempted, via index into this table.
1638 * 4965 works its way through table when retrying Tx.
1641 __le32 rate_n_flags; /* RATE_MCS_*, IWL_RATE_* */
1642 } rs_table[LINK_QUAL_MAX_RETRY_NUM];
1644 } __attribute__ ((packed));
1647 * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
1649 * 3945 and 4965 support hardware handshake with Bluetooth device on
1650 * same platform. Bluetooth device alerts wireless device when it will Tx;
1651 * wireless device can delay or kill its own Tx to accomodate.
1653 struct iwl4965_bt_cmd {
1658 __le32 kill_ack_mask;
1659 __le32 kill_cts_mask;
1660 } __attribute__ ((packed));
1662 /******************************************************************************
1664 * Spectrum Management (802.11h) Commands, Responses, Notifications:
1666 *****************************************************************************/
1669 * Spectrum Management
1671 #define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \
1672 RXON_FILTER_CTL2HOST_MSK | \
1673 RXON_FILTER_ACCEPT_GRP_MSK | \
1674 RXON_FILTER_DIS_DECRYPT_MSK | \
1675 RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
1676 RXON_FILTER_ASSOC_MSK | \
1677 RXON_FILTER_BCON_AWARE_MSK)
1679 struct iwl4965_measure_channel {
1680 __le32 duration; /* measurement duration in extended beacon
1682 u8 channel; /* channel to measure */
1683 u8 type; /* see enum iwl4965_measure_type */
1685 } __attribute__ ((packed));
1688 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
1690 struct iwl4965_spectrum_cmd {
1691 __le16 len; /* number of bytes starting from token */
1692 u8 token; /* token id */
1693 u8 id; /* measurement id -- 0 or 1 */
1694 u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */
1695 u8 periodic; /* 1 = periodic */
1696 __le16 path_loss_timeout;
1697 __le32 start_time; /* start time in extended beacon format */
1699 __le32 flags; /* rxon flags */
1700 __le32 filter_flags; /* rxon filter flags */
1701 __le16 channel_count; /* minimum 1, maximum 10 */
1703 struct iwl4965_measure_channel channels[10];
1704 } __attribute__ ((packed));
1707 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
1709 struct iwl4965_spectrum_resp {
1711 u8 id; /* id of the prior command replaced, or 0xff */
1712 __le16 status; /* 0 - command will be handled
1713 * 1 - cannot handle (conflicts with another
1715 } __attribute__ ((packed));
1717 enum iwl4965_measurement_state {
1718 IWL_MEASUREMENT_START = 0,
1719 IWL_MEASUREMENT_STOP = 1,
1722 enum iwl4965_measurement_status {
1723 IWL_MEASUREMENT_OK = 0,
1724 IWL_MEASUREMENT_CONCURRENT = 1,
1725 IWL_MEASUREMENT_CSA_CONFLICT = 2,
1726 IWL_MEASUREMENT_TGH_CONFLICT = 3,
1728 IWL_MEASUREMENT_STOPPED = 6,
1729 IWL_MEASUREMENT_TIMEOUT = 7,
1730 IWL_MEASUREMENT_PERIODIC_FAILED = 8,
1733 #define NUM_ELEMENTS_IN_HISTOGRAM 8
1735 struct iwl4965_measurement_histogram {
1736 __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
1737 __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */
1738 } __attribute__ ((packed));
1740 /* clear channel availability counters */
1741 struct iwl4965_measurement_cca_counters {
1744 } __attribute__ ((packed));
1746 enum iwl4965_measure_type {
1747 IWL_MEASURE_BASIC = (1 << 0),
1748 IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
1749 IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
1750 IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
1751 IWL_MEASURE_FRAME = (1 << 4),
1752 /* bits 5:6 are reserved */
1753 IWL_MEASURE_IDLE = (1 << 7),
1757 * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
1759 struct iwl4965_spectrum_notification {
1760 u8 id; /* measurement id -- 0 or 1 */
1762 u8 channel_index; /* index in measurement channel list */
1763 u8 state; /* 0 - start, 1 - stop */
1764 __le32 start_time; /* lower 32-bits of TSF */
1765 u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */
1767 u8 type; /* see enum iwl4965_measurement_type */
1769 /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only
1770 * valid if applicable for measurement type requested. */
1771 __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */
1772 __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */
1773 __le32 cca_time; /* channel load time in usecs */
1774 u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 -
1777 struct iwl4965_measurement_histogram histogram;
1778 __le32 stop_time; /* lower 32-bits of TSF */
1779 __le32 status; /* see iwl4965_measurement_status */
1780 } __attribute__ ((packed));
1782 /******************************************************************************
1784 * Power Management Commands, Responses, Notifications:
1786 *****************************************************************************/
1789 * struct iwl4965_powertable_cmd - Power Table Command
1790 * @flags: See below:
1792 * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
1795 * bit 0 - '0' Driver not allow power management
1796 * '1' Driver allow PM (use rest of parameters)
1797 * uCode send sleep notifications:
1798 * bit 1 - '0' Don't send sleep notification
1799 * '1' send sleep notification (SEND_PM_NOTIFICATION)
1801 * bit 2 - '0' PM have to walk up every DTIM
1802 * '1' PM could sleep over DTIM till listen Interval.
1804 * bit 3 - '0' (PCI_LINK_CTRL & 0x1)
1805 * '1' !(PCI_LINK_CTRL & 0x1)
1807 * bit 31/30- '00' use both mac/xtal sleeps
1808 * '01' force Mac sleep
1809 * '10' force xtal sleep
1812 * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
1813 * ucode assume sleep over DTIM is allowed and we don't need to wakeup
1816 #define IWL_POWER_VEC_SIZE 5
1818 #define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK __constant_cpu_to_le16(1 << 0)
1819 #define IWL_POWER_SLEEP_OVER_DTIM_MSK __constant_cpu_to_le16(1 << 2)
1820 #define IWL_POWER_PCI_PM_MSK __constant_cpu_to_le16(1 << 3)
1822 struct iwl4965_powertable_cmd {
1824 u8 keep_alive_seconds;
1826 __le32 rx_data_timeout;
1827 __le32 tx_data_timeout;
1828 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
1829 __le32 keep_alive_beacons;
1830 } __attribute__ ((packed));
1833 * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
1834 * 3945 and 4965 identical.
1836 struct iwl4965_sleep_notification {
1843 } __attribute__ ((packed));
1845 /* Sleep states. 3945 and 4965 identical. */
1847 IWL_PM_NO_SLEEP = 0,
1849 IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
1850 IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
1852 IWL_PM_SLP_REPENT = 5,
1853 IWL_PM_WAKEUP_BY_TIMER = 6,
1854 IWL_PM_WAKEUP_BY_DRIVER = 7,
1855 IWL_PM_WAKEUP_BY_RFKILL = 8,
1857 IWL_PM_NUM_OF_MODES = 12,
1861 * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
1863 #define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */
1864 #define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */
1865 #define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */
1866 struct iwl4965_card_state_cmd {
1867 __le32 status; /* CARD_STATE_CMD_* request new power state */
1868 } __attribute__ ((packed));
1871 * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
1873 struct iwl4965_card_state_notif {
1875 } __attribute__ ((packed));
1877 #define HW_CARD_DISABLED 0x01
1878 #define SW_CARD_DISABLED 0x02
1879 #define RF_CARD_DISABLED 0x04
1880 #define RXON_CARD_DISABLED 0x10
1882 struct iwl4965_ct_kill_config {
1884 __le32 critical_temperature_M;
1885 __le32 critical_temperature_R;
1886 } __attribute__ ((packed));
1888 /******************************************************************************
1890 * Scan Commands, Responses, Notifications:
1892 *****************************************************************************/
1895 * struct iwl4965_scan_channel - entry in REPLY_SCAN_CMD channel table
1897 * One for each channel in the scan list.
1898 * Each channel can independently select:
1899 * 1) SSID for directed active scans
1900 * 2) Txpower setting (for rate specified within Tx command)
1901 * 3) How long to stay on-channel (behavior may be modified by quiet_time,
1902 * quiet_plcp_th, good_CRC_th)
1904 * To avoid uCode errors, make sure the following are true (see comments
1905 * under struct iwl4965_scan_cmd about max_out_time and quiet_time):
1906 * 1) If using passive_dwell (i.e. passive_dwell != 0):
1907 * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
1908 * 2) quiet_time <= active_dwell
1909 * 3) If restricting off-channel time (i.e. max_out_time !=0):
1910 * passive_dwell < max_out_time
1911 * active_dwell < max_out_time
1913 struct iwl4965_scan_channel {
1915 * type is defined as:
1916 * 0:0 1 = active, 0 = passive
1917 * 1:4 SSID direct bit map; if a bit is set, then corresponding
1918 * SSID IE is transmitted in probe request.
1922 u8 channel; /* band is selected by iwl4965_scan_cmd "flags" field */
1923 struct iwl4965_tx_power tpc;
1924 __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */
1925 __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */
1926 } __attribute__ ((packed));
1929 * struct iwl4965_ssid_ie - directed scan network information element
1931 * Up to 4 of these may appear in REPLY_SCAN_CMD, selected by "type" field
1932 * in struct iwl4965_scan_channel; each channel may select different ssids from
1933 * among the 4 entries. SSID IEs get transmitted in reverse order of entry.
1935 struct iwl4965_ssid_ie {
1939 } __attribute__ ((packed));
1941 #define PROBE_OPTION_MAX 0x4
1942 #define TX_CMD_LIFE_TIME_INFINITE __constant_cpu_to_le32(0xFFFFFFFF)
1943 #define IWL_GOOD_CRC_TH __constant_cpu_to_le16(1)
1944 #define IWL_MAX_SCAN_SIZE 1024
1947 * REPLY_SCAN_CMD = 0x80 (command)
1949 * The hardware scan command is very powerful; the driver can set it up to
1950 * maintain (relatively) normal network traffic while doing a scan in the
1951 * background. The max_out_time and suspend_time control the ratio of how
1952 * long the device stays on an associated network channel ("service channel")
1953 * vs. how long it's away from the service channel, i.e. tuned to other channels
1956 * max_out_time is the max time off-channel (in usec), and suspend_time
1957 * is how long (in "extended beacon" format) that the scan is "suspended"
1958 * after returning to the service channel. That is, suspend_time is the
1959 * time that we stay on the service channel, doing normal work, between
1960 * scan segments. The driver may set these parameters differently to support
1961 * scanning when associated vs. not associated, and light vs. heavy traffic
1962 * loads when associated.
1964 * After receiving this command, the device's scan engine does the following;
1966 * 1) Sends SCAN_START notification to driver
1967 * 2) Checks to see if it has time to do scan for one channel
1968 * 3) Sends NULL packet, with power-save (PS) bit set to 1,
1969 * to tell AP that we're going off-channel
1970 * 4) Tunes to first channel in scan list, does active or passive scan
1971 * 5) Sends SCAN_RESULT notification to driver
1972 * 6) Checks to see if it has time to do scan on *next* channel in list
1973 * 7) Repeats 4-6 until it no longer has time to scan the next channel
1974 * before max_out_time expires
1975 * 8) Returns to service channel
1976 * 9) Sends NULL packet with PS=0 to tell AP that we're back
1977 * 10) Stays on service channel until suspend_time expires
1978 * 11) Repeats entire process 2-10 until list is complete
1979 * 12) Sends SCAN_COMPLETE notification
1981 * For fast, efficient scans, the scan command also has support for staying on
1982 * a channel for just a short time, if doing active scanning and getting no
1983 * responses to the transmitted probe request. This time is controlled by
1984 * quiet_time, and the number of received packets below which a channel is
1985 * considered "quiet" is controlled by quiet_plcp_threshold.
1987 * For active scanning on channels that have regulatory restrictions against
1988 * blindly transmitting, the scan can listen before transmitting, to make sure
1989 * that there is already legitimate activity on the channel. If enough
1990 * packets are cleanly received on the channel (controlled by good_CRC_th,
1991 * typical value 1), the scan engine starts transmitting probe requests.
1993 * Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
1995 * To avoid uCode errors, see timing restrictions described under
1996 * struct iwl4965_scan_channel.
1998 struct iwl4965_scan_cmd {
2001 u8 channel_count; /* # channels in channel list */
2002 __le16 quiet_time; /* dwell only this # millisecs on quiet channel
2003 * (only for active scan) */
2004 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
2005 __le16 good_CRC_th; /* passive -> active promotion threshold */
2006 __le16 rx_chain; /* RXON_RX_CHAIN_* */
2007 __le32 max_out_time; /* max usec to be away from associated (service)
2009 __le32 suspend_time; /* pause scan this long (in "extended beacon
2010 * format") when returning to service chnl:
2011 * 3945; 31:24 # beacons, 19:0 additional usec,
2012 * 4965; 31:22 # beacons, 21:0 additional usec.
2014 __le32 flags; /* RXON_FLG_* */
2015 __le32 filter_flags; /* RXON_FILTER_* */
2017 /* For active scans (set to all-0s for passive scans).
2018 * Does not include payload. Must specify Tx rate; no rate scaling. */
2019 struct iwl4965_tx_cmd tx_cmd;
2021 /* For directed active scans (set to all-0s otherwise) */
2022 struct iwl4965_ssid_ie direct_scan[PROBE_OPTION_MAX];
2025 * Probe request frame, followed by channel list.
2027 * Size of probe request frame is specified by byte count in tx_cmd.
2028 * Channel list follows immediately after probe request frame.
2029 * Number of channels in list is specified by channel_count.
2030 * Each channel in list is of type:
2032 * struct iwl4965_scan_channel channels[0];
2034 * NOTE: Only one band of channels can be scanned per pass. You
2035 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
2036 * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
2037 * before requesting another scan.
2040 } __attribute__ ((packed));
2042 /* Can abort will notify by complete notification with abort status. */
2043 #define CAN_ABORT_STATUS __constant_cpu_to_le32(0x1)
2044 /* complete notification statuses */
2045 #define ABORT_STATUS 0x2
2048 * REPLY_SCAN_CMD = 0x80 (response)
2050 struct iwl4965_scanreq_notification {
2051 __le32 status; /* 1: okay, 2: cannot fulfill request */
2052 } __attribute__ ((packed));
2055 * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
2057 struct iwl4965_scanstart_notification {
2060 __le32 beacon_timer;
2065 } __attribute__ ((packed));
2067 #define SCAN_OWNER_STATUS 0x1;
2068 #define MEASURE_OWNER_STATUS 0x2;
2070 #define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */
2072 * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
2074 struct iwl4965_scanresults_notification {
2080 __le32 statistics[NUMBER_OF_STATISTICS];
2081 } __attribute__ ((packed));
2084 * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
2086 struct iwl4965_scancomplete_notification {
2087 u8 scanned_channels;
2093 } __attribute__ ((packed));
2096 /******************************************************************************
2098 * IBSS/AP Commands and Notifications:
2100 *****************************************************************************/
2103 * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
2105 struct iwl4965_beacon_notif {
2106 struct iwl4965_tx_resp beacon_notify_hdr;
2109 __le32 ibss_mgr_status;
2110 } __attribute__ ((packed));
2113 * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
2115 struct iwl4965_tx_beacon_cmd {
2116 struct iwl4965_tx_cmd tx;
2120 struct ieee80211_hdr frame[0]; /* beacon frame */
2121 } __attribute__ ((packed));
2123 /******************************************************************************
2125 * Statistics Commands and Notifications:
2127 *****************************************************************************/
2129 #define IWL_TEMP_CONVERT 260
2131 #define SUP_RATE_11A_MAX_NUM_CHANNELS 8
2132 #define SUP_RATE_11B_MAX_NUM_CHANNELS 4
2133 #define SUP_RATE_11G_MAX_NUM_CHANNELS 12
2135 /* Used for passing to driver number of successes and failures per rate */
2136 struct rate_histogram {
2138 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2139 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2140 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2143 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2144 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2145 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2147 } __attribute__ ((packed));
2149 /* statistics command response */
2151 struct statistics_rx_phy {
2157 __le32 early_overrun_err;
2159 __le32 false_alarm_cnt;
2160 __le32 fina_sync_err_cnt;
2162 __le32 fina_timeout;
2163 __le32 unresponded_rts;
2164 __le32 rxe_frame_limit_overrun;
2165 __le32 sent_ack_cnt;
2166 __le32 sent_cts_cnt;
2167 __le32 sent_ba_rsp_cnt;
2168 __le32 dsp_self_kill;
2169 __le32 mh_format_err;
2170 __le32 re_acq_main_rssi_sum;
2172 } __attribute__ ((packed));
2174 struct statistics_rx_ht_phy {
2177 __le32 early_overrun_err;
2180 __le32 mh_format_err;
2181 __le32 agg_crc32_good;
2182 __le32 agg_mpdu_cnt;
2185 } __attribute__ ((packed));
2187 struct statistics_rx_non_phy {
2188 __le32 bogus_cts; /* CTS received when not expecting CTS */
2189 __le32 bogus_ack; /* ACK received when not expecting ACK */
2190 __le32 non_bssid_frames; /* number of frames with BSSID that
2191 * doesn't belong to the STA BSSID */
2192 __le32 filtered_frames; /* count frames that were dumped in the
2193 * filtering process */
2194 __le32 non_channel_beacons; /* beacons with our bss id but not on
2195 * our serving channel */
2196 __le32 channel_beacons; /* beacons with our bss id and in our
2197 * serving channel */
2198 __le32 num_missed_bcon; /* number of missed beacons */
2199 __le32 adc_rx_saturation_time; /* count in 0.8us units the time the
2200 * ADC was in saturation */
2201 __le32 ina_detection_search_time;/* total time (in 0.8us) searched
2203 __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */
2204 __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */
2205 __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */
2206 __le32 interference_data_flag; /* flag for interference data
2207 * availability. 1 when data is
2209 __le32 channel_load; /* counts RX Enable time in uSec */
2210 __le32 dsp_false_alarms; /* DSP false alarm (both OFDM
2211 * and CCK) counter */
2212 __le32 beacon_rssi_a;
2213 __le32 beacon_rssi_b;
2214 __le32 beacon_rssi_c;
2215 __le32 beacon_energy_a;
2216 __le32 beacon_energy_b;
2217 __le32 beacon_energy_c;
2218 } __attribute__ ((packed));
2220 struct statistics_rx {
2221 struct statistics_rx_phy ofdm;
2222 struct statistics_rx_phy cck;
2223 struct statistics_rx_non_phy general;
2224 struct statistics_rx_ht_phy ofdm_ht;
2225 } __attribute__ ((packed));
2227 struct statistics_tx_non_phy_agg {
2229 __le32 ba_reschedule_frames;
2230 __le32 scd_query_agg_frame_cnt;
2231 __le32 scd_query_no_agg;
2232 __le32 scd_query_agg;
2233 __le32 scd_query_mismatch;
2234 __le32 frame_not_ready;
2236 __le32 bt_prio_kill;
2237 __le32 rx_ba_rsp_cnt;
2240 } __attribute__ ((packed));
2242 struct statistics_tx {
2243 __le32 preamble_cnt;
2244 __le32 rx_detected_cnt;
2245 __le32 bt_prio_defer_cnt;
2246 __le32 bt_prio_kill_cnt;
2247 __le32 few_bytes_cnt;
2250 __le32 expected_ack_cnt;
2251 __le32 actual_ack_cnt;
2252 __le32 dump_msdu_cnt;
2253 __le32 burst_abort_next_frame_mismatch_cnt;
2254 __le32 burst_abort_missing_next_frame_cnt;
2255 __le32 cts_timeout_collision;
2256 __le32 ack_or_ba_timeout_collision;
2257 struct statistics_tx_non_phy_agg agg;
2258 } __attribute__ ((packed));
2260 struct statistics_dbg {
2264 } __attribute__ ((packed));
2266 struct statistics_div {
2273 } __attribute__ ((packed));
2275 struct statistics_general {
2277 __le32 temperature_m;
2278 struct statistics_dbg dbg;
2282 __le32 ttl_timestamp;
2283 struct statistics_div div;
2284 __le32 rx_enable_counter;
2288 } __attribute__ ((packed));
2291 * REPLY_STATISTICS_CMD = 0x9c,
2292 * 3945 and 4965 identical.
2294 * This command triggers an immediate response containing uCode statistics.
2295 * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
2297 * If the CLEAR_STATS configuration flag is set, uCode will clear its
2298 * internal copy of the statistics (counters) after issuing the response.
2299 * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
2301 * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
2302 * STATISTICS_NOTIFICATIONs after received beacons (see below). This flag
2303 * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
2305 #define IWL_STATS_CONF_CLEAR_STATS __constant_cpu_to_le32(0x1) /* see above */
2306 #define IWL_STATS_CONF_DISABLE_NOTIF __constant_cpu_to_le32(0x2)/* see above */
2307 struct iwl4965_statistics_cmd {
2308 __le32 configuration_flags; /* IWL_STATS_CONF_* */
2309 } __attribute__ ((packed));
2312 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
2314 * By default, uCode issues this notification after receiving a beacon
2315 * while associated. To disable this behavior, set DISABLE_NOTIF flag in the
2316 * REPLY_STATISTICS_CMD 0x9c, above.
2318 * Statistics counters continue to increment beacon after beacon, but are
2319 * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
2320 * 0x9c with CLEAR_STATS bit set (see above).
2322 * uCode also issues this notification during scans. uCode clears statistics
2323 * appropriately so that each notification contains statistics for only the
2324 * one channel that has just been scanned.
2326 #define STATISTICS_REPLY_FLG_BAND_24G_MSK __constant_cpu_to_le32(0x2)
2327 #define STATISTICS_REPLY_FLG_FAT_MODE_MSK __constant_cpu_to_le32(0x8)
2328 struct iwl4965_notif_statistics {
2330 struct statistics_rx rx;
2331 struct statistics_tx tx;
2332 struct statistics_general general;
2333 } __attribute__ ((packed));
2337 * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
2339 /* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row,
2340 * then this notification will be sent. */
2341 #define CONSECUTIVE_MISSED_BCONS_TH 20
2343 struct iwl4965_missed_beacon_notif {
2344 __le32 consequtive_missed_beacons;
2345 __le32 total_missed_becons;
2346 __le32 num_expected_beacons;
2347 __le32 num_recvd_beacons;
2348 } __attribute__ ((packed));
2351 /******************************************************************************
2353 * Rx Calibration Commands:
2355 * With the uCode used for open source drivers, most Tx calibration (except
2356 * for Tx Power) and most Rx calibration is done by uCode during the
2357 * "initialize" phase of uCode boot. Driver must calibrate only:
2359 * 1) Tx power (depends on temperature), described elsewhere
2360 * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas)
2361 * 3) Receiver sensitivity (to optimize signal detection)
2363 *****************************************************************************/
2366 * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
2368 * This command sets up the Rx signal detector for a sensitivity level that
2369 * is high enough to lock onto all signals within the associated network,
2370 * but low enough to ignore signals that are below a certain threshold, so as
2371 * not to have too many "false alarms". False alarms are signals that the
2372 * Rx DSP tries to lock onto, but then discards after determining that they
2375 * The optimum number of false alarms is between 5 and 50 per 200 TUs
2376 * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
2377 * time listening, not transmitting). Driver must adjust sensitivity so that
2378 * the ratio of actual false alarms to actual Rx time falls within this range.
2380 * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
2381 * received beacon. These provide information to the driver to analyze the
2382 * sensitivity. Don't analyze statistics that come in from scanning, or any
2383 * other non-associated-network source. Pertinent statistics include:
2385 * From "general" statistics (struct statistics_rx_non_phy):
2387 * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
2388 * Measure of energy of desired signal. Used for establishing a level
2389 * below which the device does not detect signals.
2391 * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
2392 * Measure of background noise in silent period after beacon.
2395 * uSecs of actual Rx time during beacon period (varies according to
2396 * how much time was spent transmitting).
2398 * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
2401 * Signal locks abandoned early (before phy-level header).
2404 * Signal locks abandoned late (during phy-level header).
2406 * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from
2407 * beacon to beacon, i.e. each value is an accumulation of all errors
2408 * before and including the latest beacon. Values will wrap around to 0
2409 * after counting up to 2^32 - 1. Driver must differentiate vs.
2410 * previous beacon's values to determine # false alarms in the current
2413 * Total number of false alarms = false_alarms + plcp_errs
2415 * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
2416 * (notice that the start points for OFDM are at or close to settings for
2417 * maximum sensitivity):
2420 * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120
2421 * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210
2422 * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140
2423 * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270
2425 * If actual rate of OFDM false alarms (+ plcp_errors) is too high
2426 * (greater than 50 for each 204.8 msecs listening), reduce sensitivity
2427 * by *adding* 1 to all 4 of the table entries above, up to the max for
2428 * each entry. Conversely, if false alarm rate is too low (less than 5
2429 * for each 204.8 msecs listening), *subtract* 1 from each entry to
2430 * increase sensitivity.
2432 * For CCK sensitivity, keep track of the following:
2434 * 1). 20-beacon history of maximum background noise, indicated by
2435 * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
2436 * 3 receivers. For any given beacon, the "silence reference" is
2437 * the maximum of last 60 samples (20 beacons * 3 receivers).
2439 * 2). 10-beacon history of strongest signal level, as indicated
2440 * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
2441 * i.e. the strength of the signal through the best receiver at the
2442 * moment. These measurements are "upside down", with lower values
2443 * for stronger signals, so max energy will be *minimum* value.
2445 * Then for any given beacon, the driver must determine the *weakest*
2446 * of the strongest signals; this is the minimum level that needs to be
2447 * successfully detected, when using the best receiver at the moment.
2448 * "Max cck energy" is the maximum (higher value means lower energy!)
2449 * of the last 10 minima. Once this is determined, driver must add
2450 * a little margin by adding "6" to it.
2452 * 3). Number of consecutive beacon periods with too few false alarms.
2453 * Reset this to 0 at the first beacon period that falls within the
2454 * "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
2456 * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
2457 * (notice that the start points for CCK are at maximum sensitivity):
2460 * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200
2461 * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400
2462 * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100
2464 * If actual rate of CCK false alarms (+ plcp_errors) is too high
2465 * (greater than 50 for each 204.8 msecs listening), method for reducing
2468 * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2471 * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
2472 * sensitivity has been reduced a significant amount; bring it up to
2473 * a moderate 161. Otherwise, *add* 3, up to max 200.
2475 * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
2476 * sensitivity has been reduced only a moderate or small amount;
2477 * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
2478 * down to min 0. Otherwise (if gain has been significantly reduced),
2479 * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
2481 * b) Save a snapshot of the "silence reference".
2483 * If actual rate of CCK false alarms (+ plcp_errors) is too low
2484 * (less than 5 for each 204.8 msecs listening), method for increasing
2485 * sensitivity is used only if:
2487 * 1a) Previous beacon did not have too many false alarms
2488 * 1b) AND difference between previous "silence reference" and current
2489 * "silence reference" (prev - current) is 2 or more,
2490 * OR 2) 100 or more consecutive beacon periods have had rate of
2491 * less than 5 false alarms per 204.8 milliseconds rx time.
2493 * Method for increasing sensitivity:
2495 * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
2498 * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2501 * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
2503 * If actual rate of CCK false alarms (+ plcp_errors) is within good range
2504 * (between 5 and 50 for each 204.8 msecs listening):
2506 * 1) Save a snapshot of the silence reference.
2508 * 2) If previous beacon had too many CCK false alarms (+ plcp_errors),
2509 * give some extra margin to energy threshold by *subtracting* 8
2510 * from value in HD_MIN_ENERGY_CCK_DET_INDEX.
2512 * For all cases (too few, too many, good range), make sure that the CCK
2513 * detection threshold (energy) is below the energy level for robust
2514 * detection over the past 10 beacon periods, the "Max cck energy".
2515 * Lower values mean higher energy; this means making sure that the value
2516 * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
2518 * Driver should set the following entries to fixed values:
2520 * HD_MIN_ENERGY_OFDM_DET_INDEX 100
2521 * HD_BARKER_CORR_TH_ADD_MIN_INDEX 190
2522 * HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX 390
2523 * HD_OFDM_ENERGY_TH_IN_INDEX 62
2527 * Table entries in SENSITIVITY_CMD (struct iwl4965_sensitivity_cmd)
2529 #define HD_TABLE_SIZE (11) /* number of entries */
2530 #define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */
2531 #define HD_MIN_ENERGY_OFDM_DET_INDEX (1)
2532 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2)
2533 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3)
2534 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4)
2535 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5)
2536 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6)
2537 #define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7)
2538 #define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8)
2539 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9)
2540 #define HD_OFDM_ENERGY_TH_IN_INDEX (10)
2542 /* Control field in struct iwl4965_sensitivity_cmd */
2543 #define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE __constant_cpu_to_le16(0)
2544 #define SENSITIVITY_CMD_CONTROL_WORK_TABLE __constant_cpu_to_le16(1)
2547 * struct iwl4965_sensitivity_cmd
2548 * @control: (1) updates working table, (0) updates default table
2549 * @table: energy threshold values, use HD_* as index into table
2551 * Always use "1" in "control" to update uCode's working table and DSP.
2553 struct iwl4965_sensitivity_cmd {
2554 __le16 control; /* always use "1" */
2555 __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */
2556 } __attribute__ ((packed));
2560 * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
2562 * This command sets the relative gains of 4965's 3 radio receiver chains.
2564 * After the first association, driver should accumulate signal and noise
2565 * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
2566 * beacons from the associated network (don't collect statistics that come
2567 * in from scanning, or any other non-network source).
2569 * DISCONNECTED ANTENNA:
2571 * Driver should determine which antennas are actually connected, by comparing
2572 * average beacon signal levels for the 3 Rx chains. Accumulate (add) the
2573 * following values over 20 beacons, one accumulator for each of the chains
2574 * a/b/c, from struct statistics_rx_non_phy:
2576 * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
2578 * Find the strongest signal from among a/b/c. Compare the other two to the
2579 * strongest. If any signal is more than 15 dB (times 20, unless you
2580 * divide the accumulated values by 20) below the strongest, the driver
2581 * considers that antenna to be disconnected, and should not try to use that
2582 * antenna/chain for Rx or Tx. If both A and B seem to be disconnected,
2583 * driver should declare the stronger one as connected, and attempt to use it
2584 * (A and B are the only 2 Tx chains!).
2589 * Driver should balance the 3 receivers (but just the ones that are connected
2590 * to antennas, see above) for gain, by comparing the average signal levels
2591 * detected during the silence after each beacon (background noise).
2592 * Accumulate (add) the following values over 20 beacons, one accumulator for
2593 * each of the chains a/b/c, from struct statistics_rx_non_phy:
2595 * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
2597 * Find the weakest background noise level from among a/b/c. This Rx chain
2598 * will be the reference, with 0 gain adjustment. Attenuate other channels by
2599 * finding noise difference:
2601 * (accum_noise[i] - accum_noise[reference]) / 30
2603 * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
2604 * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
2605 * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
2606 * and set bit 2 to indicate "reduce gain". The value for the reference
2607 * (weakest) chain should be "0".
2609 * diff_gain_[abc] bit fields:
2610 * 2: (1) reduce gain, (0) increase gain
2611 * 1-0: amount of gain, units of 1.5 dB
2614 /* "Differential Gain" opcode used in REPLY_PHY_CALIBRATION_CMD. */
2615 #define PHY_CALIBRATE_DIFF_GAIN_CMD (7)
2617 struct iwl4965_calibration_cmd {
2618 u8 opCode; /* PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
2619 u8 flags; /* not used */
2621 s8 diff_gain_a; /* see above */
2625 } __attribute__ ((packed));
2627 /******************************************************************************
2629 * Miscellaneous Commands:
2631 *****************************************************************************/
2634 * LEDs Command & Response
2635 * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
2637 * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
2638 * this command turns it on or off, or sets up a periodic blinking cycle.
2640 struct iwl4965_led_cmd {
2641 __le32 interval; /* "interval" in uSec */
2642 u8 id; /* 1: Activity, 2: Link, 3: Tech */
2643 u8 off; /* # intervals off while blinking;
2644 * "0", with >0 "on" value, turns LED on */
2645 u8 on; /* # intervals on while blinking;
2646 * "0", regardless of "off", turns LED off */
2648 } __attribute__ ((packed));
2650 /******************************************************************************
2652 * Union of all expected notifications/responses:
2654 *****************************************************************************/
2656 struct iwl4965_rx_packet {
2658 struct iwl4965_cmd_header hdr;
2660 struct iwl4965_alive_resp alive_frame;
2661 struct iwl4965_rx_frame rx_frame;
2662 struct iwl4965_tx_resp tx_resp;
2663 struct iwl4965_spectrum_notification spectrum_notif;
2664 struct iwl4965_csa_notification csa_notif;
2665 struct iwl4965_error_resp err_resp;
2666 struct iwl4965_card_state_notif card_state_notif;
2667 struct iwl4965_beacon_notif beacon_status;
2668 struct iwl4965_add_sta_resp add_sta;
2669 struct iwl4965_sleep_notification sleep_notif;
2670 struct iwl4965_spectrum_resp spectrum;
2671 struct iwl4965_notif_statistics stats;
2672 struct iwl4965_compressed_ba_resp compressed_ba;
2673 struct iwl4965_missed_beacon_notif missed_beacon;
2677 } __attribute__ ((packed));
2679 #define IWL_RX_FRAME_SIZE (4 + sizeof(struct iwl4965_rx_frame))
2681 #endif /* __iwl4965_commands_h__ */