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 */
92 REPLY_RATE_SCALE = 0x47, /* 3945 only */
93 REPLY_LEDS_CMD = 0x48,
94 REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */
97 RADAR_NOTIFICATION = 0x70, /* not used */
98 REPLY_QUIET_CMD = 0x71, /* not used */
99 REPLY_CHANNEL_SWITCH = 0x72,
100 CHANNEL_SWITCH_NOTIFICATION = 0x73,
101 REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
102 SPECTRUM_MEASURE_NOTIFICATION = 0x75,
104 /* Power Management */
105 POWER_TABLE_CMD = 0x77,
106 PM_SLEEP_NOTIFICATION = 0x7A,
107 PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
109 /* Scan commands and notifications */
110 REPLY_SCAN_CMD = 0x80,
111 REPLY_SCAN_ABORT_CMD = 0x81,
112 SCAN_START_NOTIFICATION = 0x82,
113 SCAN_RESULTS_NOTIFICATION = 0x83,
114 SCAN_COMPLETE_NOTIFICATION = 0x84,
116 /* IBSS/AP commands */
117 BEACON_NOTIFICATION = 0x90,
118 REPLY_TX_BEACON = 0x91,
119 WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */
121 /* Miscellaneous commands */
122 QUIET_NOTIFICATION = 0x96, /* not used */
123 REPLY_TX_PWR_TABLE_CMD = 0x97,
124 MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */
126 /* Bluetooth device coexistance config command */
127 REPLY_BT_CONFIG = 0x9b,
130 REPLY_STATISTICS_CMD = 0x9c,
131 STATISTICS_NOTIFICATION = 0x9d,
133 /* RF-KILL commands and notifications */
134 REPLY_CARD_STATE_CMD = 0xa0,
135 CARD_STATE_NOTIFICATION = 0xa1,
137 /* Missed beacons notification */
138 MISSED_BEACONS_NOTIFICATION = 0xa2,
140 REPLY_CT_KILL_CONFIG_CMD = 0xa4,
141 SENSITIVITY_CMD = 0xa8,
142 REPLY_PHY_CALIBRATION_CMD = 0xb0,
143 REPLY_RX_PHY_CMD = 0xc0,
144 REPLY_RX_MPDU_CMD = 0xc1,
146 REPLY_COMPRESSED_BA = 0xc5,
150 /******************************************************************************
152 * Commonly used structures and definitions:
153 * Command header, rate_n_flags, txpower
155 *****************************************************************************/
157 /* iwl_cmd_header flags value */
158 #define IWL_CMD_FAILED_MSK 0x40
161 * struct iwl_cmd_header
163 * This header format appears in the beginning of each command sent from the
164 * driver, and each response/notification received from uCode.
166 struct iwl_cmd_header {
167 u8 cmd; /* Command ID: REPLY_RXON, etc. */
168 u8 flags; /* IWL_CMD_* */
170 * The driver sets up the sequence number to values of its chosing.
171 * uCode does not use this value, but passes it back to the driver
172 * when sending the response to each driver-originated command, so
173 * the driver can match the response to the command. Since the values
174 * don't get used by uCode, the driver may set up an arbitrary format.
176 * There is one exception: uCode sets bit 15 when it originates
177 * the response/notification, i.e. when the response/notification
178 * is not a direct response to a command sent by the driver. For
179 * example, uCode issues REPLY_3945_RX when it sends a received frame
180 * to the driver; it is not a direct response to any driver command.
182 * The Linux driver uses the following format:
184 * 0:7 index/position within Tx queue
185 * 8:13 Tx queue selection
186 * 14:14 driver sets this to indicate command is in the 'huge'
187 * storage at the end of the command buffers, i.e. scan cmd
188 * 15:15 uCode sets this in uCode-originated response/notification
192 /* command or response/notification data follows immediately */
194 } __attribute__ ((packed));
197 * 4965 rate_n_flags bit fields
199 * rate_n_flags format is used in following 4965 commands:
200 * REPLY_RX (response only)
201 * REPLY_TX (both command and response)
202 * REPLY_TX_LINK_QUALITY_CMD
204 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
214 * 3: 0) Single stream (SISO)
215 * 1) Dual stream (MIMO)
217 * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps FAT duplicate data
219 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
229 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
235 #define RATE_MCS_CODE_MSK 0x7
236 #define RATE_MCS_MIMO_POS 3
237 #define RATE_MCS_MIMO_MSK 0x8
238 #define RATE_MCS_HT_DUP_POS 5
239 #define RATE_MCS_HT_DUP_MSK 0x20
241 /* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
242 #define RATE_MCS_FLAGS_POS 8
243 #define RATE_MCS_HT_POS 8
244 #define RATE_MCS_HT_MSK 0x100
246 /* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */
247 #define RATE_MCS_CCK_POS 9
248 #define RATE_MCS_CCK_MSK 0x200
250 /* Bit 10: (1) Use Green Field preamble */
251 #define RATE_MCS_GF_POS 10
252 #define RATE_MCS_GF_MSK 0x400
254 /* Bit 11: (1) Use 40Mhz FAT chnl width, (0) use 20 MHz legacy chnl width */
255 #define RATE_MCS_FAT_POS 11
256 #define RATE_MCS_FAT_MSK 0x800
258 /* Bit 12: (1) Duplicate data on both 20MHz chnls. FAT (bit 11) must be set. */
259 #define RATE_MCS_DUP_POS 12
260 #define RATE_MCS_DUP_MSK 0x1000
262 /* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
263 #define RATE_MCS_SGI_POS 13
264 #define RATE_MCS_SGI_MSK 0x2000
267 * rate_n_flags Tx antenna masks (4965 has 2 transmitters):
268 * bit14:15 01 B inactive, A active
269 * 10 B active, A inactive
272 #define RATE_MCS_ANT_POS 14
273 #define RATE_MCS_ANT_A_MSK 0x04000
274 #define RATE_MCS_ANT_B_MSK 0x08000
275 #define RATE_MCS_ANT_AB_MSK 0x0C000
279 * struct iwl4965_tx_power - txpower format used in REPLY_SCAN_CMD
281 * Scan uses only one transmitter, so only one analog/dsp gain pair is needed.
283 struct iwl4965_tx_power {
284 u8 tx_gain; /* gain for analog radio */
285 u8 dsp_atten; /* gain for DSP */
286 } __attribute__ ((packed));
288 #define POWER_TABLE_NUM_ENTRIES 33
289 #define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32
290 #define POWER_TABLE_CCK_ENTRY 32
293 * union iwl4965_tx_power_dual_stream
295 * Host format used for REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
296 * Use __le32 version (struct tx_power_dual_stream) when building command.
298 * Driver provides radio gain and DSP attenuation settings to device in pairs,
299 * one value for each transmitter chain. The first value is for transmitter A,
300 * second for transmitter B.
302 * For SISO bit rates, both values in a pair should be identical.
303 * For MIMO rates, one value may be different from the other,
304 * in order to balance the Tx output between the two transmitters.
306 * See more details in doc for TXPOWER in iwl-4965-hw.h.
308 union iwl4965_tx_power_dual_stream {
311 u8 dsp_predis_atten[2];
317 * struct tx_power_dual_stream
319 * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
321 * Same format as iwl_tx_power_dual_stream, but __le32
323 struct tx_power_dual_stream {
325 } __attribute__ ((packed));
328 * struct iwl4965_tx_power_db
330 * Entire table within REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
332 struct iwl4965_tx_power_db {
333 struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES];
334 } __attribute__ ((packed));
337 /******************************************************************************
339 * Alive and Error Commands & Responses:
341 *****************************************************************************/
343 #define UCODE_VALID_OK __constant_cpu_to_le32(0x1)
344 #define INITIALIZE_SUBTYPE (9)
347 * ("Initialize") REPLY_ALIVE = 0x1 (response only, not a command)
349 * uCode issues this "initialize alive" notification once the initialization
350 * uCode image has completed its work, and is ready to load the runtime image.
351 * This is the *first* "alive" notification that the driver will receive after
352 * rebooting uCode; the "initialize" alive is indicated by subtype field == 9.
354 * See comments documenting "BSM" (bootstrap state machine).
356 * For 4965, this notification contains important calibration data for
357 * calculating txpower settings:
359 * 1) Power supply voltage indication. The voltage sensor outputs higher
360 * values for lower voltage, and vice versa.
362 * 2) Temperature measurement parameters, for each of two channel widths
363 * (20 MHz and 40 MHz) supported by the radios. Temperature sensing
364 * is done via one of the receiver chains, and channel width influences
367 * 3) Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation,
368 * for each of 5 frequency ranges.
370 struct iwl4965_init_alive_resp {
376 u8 ver_subtype; /* "9" for initialize alive */
378 __le32 log_event_table_ptr;
379 __le32 error_event_table_ptr;
383 /* calibration values from "initialize" uCode */
384 __le32 voltage; /* signed, higher value is lower voltage */
385 __le32 therm_r1[2]; /* signed, 1st for normal, 2nd for FAT channel*/
386 __le32 therm_r2[2]; /* signed */
387 __le32 therm_r3[2]; /* signed */
388 __le32 therm_r4[2]; /* signed */
389 __le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups,
391 } __attribute__ ((packed));
395 * REPLY_ALIVE = 0x1 (response only, not a command)
397 * uCode issues this "alive" notification once the runtime image is ready
398 * to receive commands from the driver. This is the *second* "alive"
399 * notification that the driver will receive after rebooting uCode;
400 * this "alive" is indicated by subtype field != 9.
402 * See comments documenting "BSM" (bootstrap state machine).
404 * This response includes two pointers to structures within the device's
405 * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
407 * 1) log_event_table_ptr indicates base of the event log. This traces
408 * a 256-entry history of uCode execution within a circular buffer.
409 * Its header format is:
411 * __le32 log_size; log capacity (in number of entries)
412 * __le32 type; (1) timestamp with each entry, (0) no timestamp
413 * __le32 wraps; # times uCode has wrapped to top of circular buffer
414 * __le32 write_index; next circular buffer entry that uCode would fill
416 * The header is followed by the circular buffer of log entries. Entries
417 * with timestamps have the following format:
419 * __le32 event_id; range 0 - 1500
420 * __le32 timestamp; low 32 bits of TSF (of network, if associated)
421 * __le32 data; event_id-specific data value
423 * Entries without timestamps contain only event_id and data.
425 * 2) error_event_table_ptr indicates base of the error log. This contains
426 * information about any uCode error that occurs. For 4965, the format
427 * of the error log is:
429 * __le32 valid; (nonzero) valid, (0) log is empty
430 * __le32 error_id; type of error
431 * __le32 pc; program counter
432 * __le32 blink1; branch link
433 * __le32 blink2; branch link
434 * __le32 ilink1; interrupt link
435 * __le32 ilink2; interrupt link
436 * __le32 data1; error-specific data
437 * __le32 data2; error-specific data
438 * __le32 line; source code line of error
439 * __le32 bcon_time; beacon timer
440 * __le32 tsf_low; network timestamp function timer
441 * __le32 tsf_hi; network timestamp function timer
443 * The Linux driver can print both logs to the system log when a uCode error
446 struct iwl4965_alive_resp {
452 u8 ver_subtype; /* not "9" for runtime alive */
454 __le32 log_event_table_ptr; /* SRAM address for event log */
455 __le32 error_event_table_ptr; /* SRAM address for error log */
458 } __attribute__ ((packed));
468 * REPLY_ERROR = 0x2 (response only, not a command)
470 struct iwl4965_error_resp {
474 __le16 bad_cmd_seq_num;
477 } __attribute__ ((packed));
479 /******************************************************************************
481 * RXON Commands & Responses:
483 *****************************************************************************/
486 * Rx config defines & structure
488 /* rx_config device types */
490 RXON_DEV_TYPE_AP = 1,
491 RXON_DEV_TYPE_ESS = 3,
492 RXON_DEV_TYPE_IBSS = 4,
493 RXON_DEV_TYPE_SNIFFER = 6,
497 #define RXON_RX_CHAIN_DRIVER_FORCE_MSK __constant_cpu_to_le16(0x1 << 0)
498 #define RXON_RX_CHAIN_VALID_MSK __constant_cpu_to_le16(0x7 << 1)
499 #define RXON_RX_CHAIN_VALID_POS (1)
500 #define RXON_RX_CHAIN_FORCE_SEL_MSK __constant_cpu_to_le16(0x7 << 4)
501 #define RXON_RX_CHAIN_FORCE_SEL_POS (4)
502 #define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK __constant_cpu_to_le16(0x7 << 7)
503 #define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
504 #define RXON_RX_CHAIN_CNT_MSK __constant_cpu_to_le16(0x3 << 10)
505 #define RXON_RX_CHAIN_CNT_POS (10)
506 #define RXON_RX_CHAIN_MIMO_CNT_MSK __constant_cpu_to_le16(0x3 << 12)
507 #define RXON_RX_CHAIN_MIMO_CNT_POS (12)
508 #define RXON_RX_CHAIN_MIMO_FORCE_MSK __constant_cpu_to_le16(0x1 << 14)
509 #define RXON_RX_CHAIN_MIMO_FORCE_POS (14)
511 /* rx_config flags */
512 /* band & modulation selection */
513 #define RXON_FLG_BAND_24G_MSK __constant_cpu_to_le32(1 << 0)
514 #define RXON_FLG_CCK_MSK __constant_cpu_to_le32(1 << 1)
515 /* auto detection enable */
516 #define RXON_FLG_AUTO_DETECT_MSK __constant_cpu_to_le32(1 << 2)
517 /* TGg protection when tx */
518 #define RXON_FLG_TGG_PROTECT_MSK __constant_cpu_to_le32(1 << 3)
519 /* cck short slot & preamble */
520 #define RXON_FLG_SHORT_SLOT_MSK __constant_cpu_to_le32(1 << 4)
521 #define RXON_FLG_SHORT_PREAMBLE_MSK __constant_cpu_to_le32(1 << 5)
522 /* antenna selection */
523 #define RXON_FLG_DIS_DIV_MSK __constant_cpu_to_le32(1 << 7)
524 #define RXON_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0x0f00)
525 #define RXON_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8)
526 #define RXON_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9)
527 /* radar detection enable */
528 #define RXON_FLG_RADAR_DETECT_MSK __constant_cpu_to_le32(1 << 12)
529 #define RXON_FLG_TGJ_NARROW_BAND_MSK __constant_cpu_to_le32(1 << 13)
530 /* rx response to host with 8-byte TSF
531 * (according to ON_AIR deassertion) */
532 #define RXON_FLG_TSF2HOST_MSK __constant_cpu_to_le32(1 << 15)
536 #define RXON_FLG_CTRL_CHANNEL_LOC_POS (22)
537 #define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK __constant_cpu_to_le32(0x1 << 22)
539 #define RXON_FLG_HT_OPERATING_MODE_POS (23)
541 #define RXON_FLG_HT_PROT_MSK __constant_cpu_to_le32(0x1 << 23)
542 #define RXON_FLG_FAT_PROT_MSK __constant_cpu_to_le32(0x2 << 23)
544 #define RXON_FLG_CHANNEL_MODE_POS (25)
545 #define RXON_FLG_CHANNEL_MODE_MSK __constant_cpu_to_le32(0x3 << 25)
546 #define RXON_FLG_CHANNEL_MODE_PURE_40_MSK __constant_cpu_to_le32(0x1 << 25)
547 #define RXON_FLG_CHANNEL_MODE_MIXED_MSK __constant_cpu_to_le32(0x2 << 25)
549 /* rx_config filter flags */
550 /* accept all data frames */
551 #define RXON_FILTER_PROMISC_MSK __constant_cpu_to_le32(1 << 0)
552 /* pass control & management to host */
553 #define RXON_FILTER_CTL2HOST_MSK __constant_cpu_to_le32(1 << 1)
554 /* accept multi-cast */
555 #define RXON_FILTER_ACCEPT_GRP_MSK __constant_cpu_to_le32(1 << 2)
556 /* don't decrypt uni-cast frames */
557 #define RXON_FILTER_DIS_DECRYPT_MSK __constant_cpu_to_le32(1 << 3)
558 /* don't decrypt multi-cast frames */
559 #define RXON_FILTER_DIS_GRP_DECRYPT_MSK __constant_cpu_to_le32(1 << 4)
560 /* STA is associated */
561 #define RXON_FILTER_ASSOC_MSK __constant_cpu_to_le32(1 << 5)
562 /* transfer to host non bssid beacons in associated state */
563 #define RXON_FILTER_BCON_AWARE_MSK __constant_cpu_to_le32(1 << 6)
566 * REPLY_RXON = 0x10 (command, has simple generic response)
568 * RXON tunes the radio tuner to a service channel, and sets up a number
569 * of parameters that are used primarily for Rx, but also for Tx operations.
571 * NOTE: When tuning to a new channel, driver must set the
572 * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent
573 * info within the device, including the station tables, tx retry
574 * rate tables, and txpower tables. Driver must build a new station
575 * table and txpower table before transmitting anything on the RXON
578 * NOTE: All RXONs wipe clean the internal txpower table. Driver must
579 * issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
580 * regardless of whether RXON_FILTER_ASSOC_MSK is set.
582 struct iwl4965_rxon_cmd {
587 u8 wlap_bssid_addr[6];
598 u8 ofdm_ht_single_stream_basic_rates;
599 u8 ofdm_ht_dual_stream_basic_rates;
600 } __attribute__ ((packed));
603 * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
605 struct iwl4965_rxon_assoc_cmd {
610 u8 ofdm_ht_single_stream_basic_rates;
611 u8 ofdm_ht_dual_stream_basic_rates;
612 __le16 rx_chain_select_flags;
614 } __attribute__ ((packed));
617 * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
619 struct iwl4965_rxon_time_cmd {
621 __le16 beacon_interval;
623 __le32 beacon_init_val;
624 __le16 listen_interval;
626 } __attribute__ ((packed));
629 * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
631 struct iwl4965_channel_switch_cmd {
636 __le32 rxon_filter_flags;
638 struct iwl4965_tx_power_db tx_power;
639 } __attribute__ ((packed));
642 * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
644 struct iwl4965_csa_notification {
647 __le32 status; /* 0 - OK, 1 - fail */
648 } __attribute__ ((packed));
650 /******************************************************************************
652 * Quality-of-Service (QOS) Commands & Responses:
654 *****************************************************************************/
657 * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
658 * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
660 * @cw_min: Contention window, start value in numbers of slots.
661 * Should be a power-of-2, minus 1. Device's default is 0x0f.
662 * @cw_max: Contention window, max value in numbers of slots.
663 * Should be a power-of-2, minus 1. Device's default is 0x3f.
664 * @aifsn: Number of slots in Arbitration Interframe Space (before
665 * performing random backoff timing prior to Tx). Device default 1.
666 * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
668 * Device will automatically increase contention window by (2*CW) + 1 for each
669 * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
670 * value, to cap the CW value.
672 struct iwl4965_ac_qos {
678 } __attribute__ ((packed));
680 /* QoS flags defines */
681 #define QOS_PARAM_FLG_UPDATE_EDCA_MSK __constant_cpu_to_le32(0x01)
682 #define QOS_PARAM_FLG_TGN_MSK __constant_cpu_to_le32(0x02)
683 #define QOS_PARAM_FLG_TXOP_TYPE_MSK __constant_cpu_to_le32(0x10)
685 /* Number of Access Categories (AC) (EDCA), queues 0..3 */
689 * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
691 * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
692 * 0: Background, 1: Best Effort, 2: Video, 3: Voice.
694 struct iwl4965_qosparam_cmd {
696 struct iwl4965_ac_qos ac[AC_NUM];
697 } __attribute__ ((packed));
699 /******************************************************************************
701 * Add/Modify Stations Commands & Responses:
703 *****************************************************************************/
705 * Multi station support
708 /* Special, dedicated locations within device's station table */
710 #define IWL_MULTICAST_ID 1
712 #define IWL4965_BROADCAST_ID 31
713 #define IWL4965_STATION_COUNT 32
715 #define IWL_STATION_COUNT 32 /* MAX(3945,4965)*/
716 #define IWL_INVALID_STATION 255
718 #define STA_FLG_PWR_SAVE_MSK __constant_cpu_to_le32(1 << 8);
719 #define STA_FLG_RTS_MIMO_PROT_MSK __constant_cpu_to_le32(1 << 17)
720 #define STA_FLG_AGG_MPDU_8US_MSK __constant_cpu_to_le32(1 << 18)
721 #define STA_FLG_MAX_AGG_SIZE_POS (19)
722 #define STA_FLG_MAX_AGG_SIZE_MSK __constant_cpu_to_le32(3 << 19)
723 #define STA_FLG_FAT_EN_MSK __constant_cpu_to_le32(1 << 21)
724 #define STA_FLG_MIMO_DIS_MSK __constant_cpu_to_le32(1 << 22)
725 #define STA_FLG_AGG_MPDU_DENSITY_POS (23)
726 #define STA_FLG_AGG_MPDU_DENSITY_MSK __constant_cpu_to_le32(7 << 23)
728 /* Use in mode field. 1: modify existing entry, 0: add new station entry */
729 #define STA_CONTROL_MODIFY_MSK 0x01
731 /* key flags __le16*/
732 #define STA_KEY_FLG_ENCRYPT_MSK __constant_cpu_to_le16(0x0007)
733 #define STA_KEY_FLG_NO_ENC __constant_cpu_to_le16(0x0000)
734 #define STA_KEY_FLG_WEP __constant_cpu_to_le16(0x0001)
735 #define STA_KEY_FLG_CCMP __constant_cpu_to_le16(0x0002)
736 #define STA_KEY_FLG_TKIP __constant_cpu_to_le16(0x0003)
738 #define STA_KEY_FLG_KEYID_POS 8
739 #define STA_KEY_FLG_INVALID __constant_cpu_to_le16(0x0800)
740 /* wep key is either from global key (0) or from station info array (1) */
741 #define STA_KEY_FLG_MAP_KEY_MSK __constant_cpu_to_le16(0x0008)
743 /* wep key in STA: 5-bytes (0) or 13-bytes (1) */
744 #define STA_KEY_FLG_KEY_SIZE_MSK __constant_cpu_to_le16(0x1000)
745 #define STA_KEY_MULTICAST_MSK __constant_cpu_to_le16(0x4000)
746 #define STA_KEY_MAX_NUM 8
748 /* Flags indicate whether to modify vs. don't change various station params */
749 #define STA_MODIFY_KEY_MASK 0x01
750 #define STA_MODIFY_TID_DISABLE_TX 0x02
751 #define STA_MODIFY_TX_RATE_MSK 0x04
752 #define STA_MODIFY_ADDBA_TID_MSK 0x08
753 #define STA_MODIFY_DELBA_TID_MSK 0x10
755 /* Receiver address (actually, Rx station's index into station table),
756 * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
757 #define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid))
759 struct iwl4965_keyinfo {
761 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
763 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
766 u8 key[16]; /* 16-byte unicast decryption key */
767 } __attribute__ ((packed));
770 * struct sta_id_modify
771 * @addr[ETH_ALEN]: station's MAC address
772 * @sta_id: index of station in uCode's station table
773 * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
775 * Driver selects unused table index when adding new station,
776 * or the index to a pre-existing station entry when modifying that station.
777 * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
779 * modify_mask flags select which parameters to modify vs. leave alone.
781 struct sta_id_modify {
787 } __attribute__ ((packed));
790 * REPLY_ADD_STA = 0x18 (command)
792 * The device contains an internal table of per-station information,
793 * with info on security keys, aggregation parameters, and Tx rates for
794 * initial Tx attempt and any retries (4965 uses REPLY_TX_LINK_QUALITY_CMD,
795 * 3945 uses REPLY_RATE_SCALE to set up rate tables).
797 * REPLY_ADD_STA sets up the table entry for one station, either creating
798 * a new entry, or modifying a pre-existing one.
800 * NOTE: RXON command (without "associated" bit set) wipes the station table
801 * clean. Moving into RF_KILL state does this also. Driver must set up
802 * new station table before transmitting anything on the RXON channel
803 * (except active scans or active measurements; those commands carry
804 * their own txpower/rate setup data).
806 * When getting started on a new channel, driver must set up the
807 * IWL_BROADCAST_ID entry (last entry in the table). For a client
808 * station in a BSS, once an AP is selected, driver sets up the AP STA
809 * in the IWL_AP_ID entry (1st entry in the table). BROADCAST and AP
810 * are all that are needed for a BSS client station. If the device is
811 * used as AP, or in an IBSS network, driver must set up station table
812 * entries for all STAs in network, starting with index IWL_STA_ID.
814 struct iwl4965_addsta_cmd {
815 u8 mode; /* 1: modify existing, 0: add new station */
817 struct sta_id_modify sta;
818 struct iwl4965_keyinfo key;
819 __le32 station_flags; /* STA_FLG_* */
820 __le32 station_flags_msk; /* STA_FLG_* */
822 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
823 * corresponding to bit (e.g. bit 5 controls TID 5).
824 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
825 __le16 tid_disable_tx;
829 /* TID for which to add block-ack support.
830 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
831 u8 add_immediate_ba_tid;
833 /* TID for which to remove block-ack support.
834 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
835 u8 remove_immediate_ba_tid;
837 /* Starting Sequence Number for added block-ack support.
838 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
839 __le16 add_immediate_ba_ssn;
842 } __attribute__ ((packed));
844 #define ADD_STA_SUCCESS_MSK 0x1
845 #define ADD_STA_NO_ROOM_IN_TABLE 0x2
846 #define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4
847 #define ADD_STA_MODIFY_NON_EXIST_STA 0x8
849 * REPLY_ADD_STA = 0x18 (response)
851 struct iwl4965_add_sta_resp {
852 u8 status; /* ADD_STA_* */
853 } __attribute__ ((packed));
856 * REPLY_WEP_KEY = 0x20
865 } __attribute__ ((packed));
872 struct iwl_wep_key key[0];
873 } __attribute__ ((packed));
875 #define WEP_KEY_WEP_TYPE 1
876 #define WEP_KEYS_MAX 4
877 #define WEP_INVALID_OFFSET 0xff
878 #define WEP_KEY_LEN_128 13
880 /******************************************************************************
884 *****************************************************************************/
886 struct iwl4965_rx_frame_stats {
894 } __attribute__ ((packed));
896 struct iwl4965_rx_frame_hdr {
903 } __attribute__ ((packed));
905 #define RX_RES_STATUS_NO_CRC32_ERROR __constant_cpu_to_le32(1 << 0)
906 #define RX_RES_STATUS_NO_RXE_OVERFLOW __constant_cpu_to_le32(1 << 1)
908 #define RX_RES_PHY_FLAGS_BAND_24_MSK __constant_cpu_to_le16(1 << 0)
909 #define RX_RES_PHY_FLAGS_MOD_CCK_MSK __constant_cpu_to_le16(1 << 1)
910 #define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK __constant_cpu_to_le16(1 << 2)
911 #define RX_RES_PHY_FLAGS_NARROW_BAND_MSK __constant_cpu_to_le16(1 << 3)
912 #define RX_RES_PHY_FLAGS_ANTENNA_MSK __constant_cpu_to_le16(0xf0)
914 #define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)
915 #define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)
916 #define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)
917 #define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)
918 #define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)
919 #define RX_RES_STATUS_SEC_TYPE_ERR (0x7 << 8)
921 #define RX_RES_STATUS_STATION_FOUND (1<<6)
922 #define RX_RES_STATUS_NO_STATION_INFO_MISMATCH (1<<7)
924 #define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)
925 #define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)
926 #define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)
927 #define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)
928 #define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)
930 #define RX_MPDU_RES_STATUS_ICV_OK (0x20)
931 #define RX_MPDU_RES_STATUS_MIC_OK (0x40)
932 #define RX_MPDU_RES_STATUS_TTAK_OK (1 << 7)
933 #define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800)
935 struct iwl4965_rx_frame_end {
938 __le32 beacon_timestamp;
939 } __attribute__ ((packed));
942 * REPLY_3945_RX = 0x1b (response only, not a command)
944 * NOTE: DO NOT dereference from casts to this structure
945 * It is provided only for calculating minimum data set size.
946 * The actual offsets of the hdr and end are dynamic based on
949 struct iwl4965_rx_frame {
950 struct iwl4965_rx_frame_stats stats;
951 struct iwl4965_rx_frame_hdr hdr;
952 struct iwl4965_rx_frame_end end;
953 } __attribute__ ((packed));
955 /* Fixed (non-configurable) rx data from phy */
956 #define RX_PHY_FLAGS_ANTENNAE_OFFSET (4)
957 #define RX_PHY_FLAGS_ANTENNAE_MASK (0x70)
958 #define IWL_AGC_DB_MASK (0x3f80) /* MASK(7,13) */
959 #define IWL_AGC_DB_POS (7)
960 struct iwl4965_rx_non_cfg_phy {
961 __le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */
962 __le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */
963 u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */
965 } __attribute__ ((packed));
968 * REPLY_RX = 0xc3 (response only, not a command)
969 * Used only for legacy (non 11n) frames.
971 #define RX_RES_PHY_CNT 14
972 struct iwl4965_rx_phy_res {
973 u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */
974 u8 cfg_phy_cnt; /* configurable DSP phy data byte count */
975 u8 stat_id; /* configurable DSP phy data set ID */
977 __le64 timestamp; /* TSF at on air rise */
978 __le32 beacon_time_stamp; /* beacon at on-air rise */
979 __le16 phy_flags; /* general phy flags: band, modulation, ... */
980 __le16 channel; /* channel number */
981 __le16 non_cfg_phy[RX_RES_PHY_CNT]; /* upto 14 phy entries */
983 __le32 rate_n_flags; /* RATE_MCS_* */
984 __le16 byte_count; /* frame's byte-count */
986 } __attribute__ ((packed));
988 struct iwl4965_rx_mpdu_res_start {
991 } __attribute__ ((packed));
994 /******************************************************************************
996 * Tx Commands & Responses:
998 * Driver must place each REPLY_TX command into one of the prioritized Tx
999 * queues in host DRAM, shared between driver and device (see comments for
1000 * SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode
1001 * are preparing to transmit, the device pulls the Tx command over the PCI
1002 * bus via one of the device's Tx DMA channels, to fill an internal FIFO
1003 * from which data will be transmitted.
1005 * uCode handles all timing and protocol related to control frames
1006 * (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler
1007 * handle reception of block-acks; uCode updates the host driver via
1008 * REPLY_COMPRESSED_BA (4965).
1010 * uCode handles retrying Tx when an ACK is expected but not received.
1011 * This includes trying lower data rates than the one requested in the Tx
1012 * command, as set up by the REPLY_RATE_SCALE (for 3945) or
1013 * REPLY_TX_LINK_QUALITY_CMD (4965).
1015 * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
1016 * This command must be executed after every RXON command, before Tx can occur.
1017 *****************************************************************************/
1019 /* REPLY_TX Tx flags field */
1021 /* 1: Use Request-To-Send protocol before this frame.
1022 * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK. */
1023 #define TX_CMD_FLG_RTS_MSK __constant_cpu_to_le32(1 << 1)
1025 /* 1: Transmit Clear-To-Send to self before this frame.
1026 * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
1027 * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK. */
1028 #define TX_CMD_FLG_CTS_MSK __constant_cpu_to_le32(1 << 2)
1030 /* 1: Expect ACK from receiving station
1031 * 0: Don't expect ACK (MAC header's duration field s/b 0)
1032 * Set this for unicast frames, but not broadcast/multicast. */
1033 #define TX_CMD_FLG_ACK_MSK __constant_cpu_to_le32(1 << 3)
1036 * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
1037 * Tx command's initial_rate_index indicates first rate to try;
1038 * uCode walks through table for additional Tx attempts.
1039 * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
1040 * This rate will be used for all Tx attempts; it will not be scaled. */
1041 #define TX_CMD_FLG_STA_RATE_MSK __constant_cpu_to_le32(1 << 4)
1043 /* 1: Expect immediate block-ack.
1044 * Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */
1045 #define TX_CMD_FLG_IMM_BA_RSP_MASK __constant_cpu_to_le32(1 << 6)
1047 /* 1: Frame requires full Tx-Op protection.
1048 * Set this if either RTS or CTS Tx Flag gets set. */
1049 #define TX_CMD_FLG_FULL_TXOP_PROT_MSK __constant_cpu_to_le32(1 << 7)
1051 /* Tx antenna selection field; used only for 3945, reserved (0) for 4965.
1052 * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
1053 #define TX_CMD_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0xf00)
1054 #define TX_CMD_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8)
1055 #define TX_CMD_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9)
1057 /* 1: Ignore Bluetooth priority for this frame.
1058 * 0: Delay Tx until Bluetooth device is done (normal usage). */
1059 #define TX_CMD_FLG_BT_DIS_MSK __constant_cpu_to_le32(1 << 12)
1061 /* 1: uCode overrides sequence control field in MAC header.
1062 * 0: Driver provides sequence control field in MAC header.
1063 * Set this for management frames, non-QOS data frames, non-unicast frames,
1064 * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
1065 #define TX_CMD_FLG_SEQ_CTL_MSK __constant_cpu_to_le32(1 << 13)
1067 /* 1: This frame is non-last MPDU; more fragments are coming.
1068 * 0: Last fragment, or not using fragmentation. */
1069 #define TX_CMD_FLG_MORE_FRAG_MSK __constant_cpu_to_le32(1 << 14)
1071 /* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
1072 * 0: No TSF required in outgoing frame.
1073 * Set this for transmitting beacons and probe responses. */
1074 #define TX_CMD_FLG_TSF_MSK __constant_cpu_to_le32(1 << 16)
1076 /* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
1077 * alignment of frame's payload data field.
1079 * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
1080 * field (but not both). Driver must align frame data (i.e. data following
1081 * MAC header) to DWORD boundary. */
1082 #define TX_CMD_FLG_MH_PAD_MSK __constant_cpu_to_le32(1 << 20)
1084 /* accelerate aggregation support
1085 * 0 - no CCMP encryption; 1 - CCMP encryption */
1086 #define TX_CMD_FLG_AGG_CCMP_MSK __constant_cpu_to_le32(1 << 22)
1088 /* HCCA-AP - disable duration overwriting. */
1089 #define TX_CMD_FLG_DUR_MSK __constant_cpu_to_le32(1 << 25)
1093 * TX command security control
1095 #define TX_CMD_SEC_WEP 0x01
1096 #define TX_CMD_SEC_CCM 0x02
1097 #define TX_CMD_SEC_TKIP 0x03
1098 #define TX_CMD_SEC_MSK 0x03
1099 #define TX_CMD_SEC_SHIFT 6
1100 #define TX_CMD_SEC_KEY128 0x08
1103 * 4965 uCode updates these Tx attempt count values in host DRAM.
1104 * Used for managing Tx retries when expecting block-acks.
1105 * Driver should set these fields to 0.
1107 struct iwl4965_dram_scratch {
1108 u8 try_cnt; /* Tx attempts */
1109 u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */
1111 } __attribute__ ((packed));
1114 * REPLY_TX = 0x1c (command)
1116 struct iwl4965_tx_cmd {
1119 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
1120 * + 8 byte IV for CCM or TKIP (not used for WEP)
1122 * + 8-byte MIC (not used for CCM/WEP)
1123 * NOTE: Does not include Tx command bytes, post-MAC pad bytes,
1124 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
1125 * Range: 14-2342 bytes.
1130 * MPDU or MSDU byte count for next frame.
1131 * Used for fragmentation and bursting, but not 11n aggregation.
1132 * Same as "len", but for next frame. Set to 0 if not applicable.
1134 __le16 next_frame_len;
1136 __le32 tx_flags; /* TX_CMD_FLG_* */
1138 /* 4965's uCode may modify this field of the Tx command (in host DRAM!).
1139 * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
1140 struct iwl4965_dram_scratch scratch;
1142 /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
1143 __le32 rate_n_flags; /* RATE_MCS_* */
1145 /* Index of destination station in uCode's station table */
1148 /* Type of security encryption: CCM or TKIP */
1149 u8 sec_ctl; /* TX_CMD_SEC_* */
1152 * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial
1153 * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for
1154 * data frames, this field may be used to selectively reduce initial
1155 * rate (via non-0 value) for special frames (e.g. management), while
1156 * still supporting rate scaling for all frames.
1158 u8 initial_rate_index;
1161 __le16 next_frame_flags;
1168 /* Host DRAM physical address pointer to "scratch" in this command.
1169 * Must be dword aligned. "0" in dram_lsb_ptr disables usage. */
1170 __le32 dram_lsb_ptr;
1173 u8 rts_retry_limit; /*byte 50 */
1174 u8 data_retry_limit; /*byte 51 */
1177 __le16 pm_frame_timeout;
1178 __le16 attempt_duration;
1182 * Duration of EDCA burst Tx Opportunity, in 32-usec units.
1183 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
1188 * MAC header goes here, followed by 2 bytes padding if MAC header
1189 * length is 26 or 30 bytes, followed by payload data
1192 struct ieee80211_hdr hdr[0];
1193 } __attribute__ ((packed));
1195 /* TX command response is sent after *all* transmission attempts.
1199 * TX_STATUS_FAIL_NEXT_FRAG
1201 * If the fragment flag in the MAC header for the frame being transmitted
1202 * is set and there is insufficient time to transmit the next frame, the
1203 * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
1205 * TX_STATUS_FIFO_UNDERRUN
1207 * Indicates the host did not provide bytes to the FIFO fast enough while
1208 * a TX was in progress.
1210 * TX_STATUS_FAIL_MGMNT_ABORT
1212 * This status is only possible if the ABORT ON MGMT RX parameter was
1213 * set to true with the TX command.
1215 * If the MSB of the status parameter is set then an abort sequence is
1216 * required. This sequence consists of the host activating the TX Abort
1217 * control line, and then waiting for the TX Abort command response. This
1218 * indicates that a the device is no longer in a transmit state, and that the
1219 * command FIFO has been cleared. The host must then deactivate the TX Abort
1220 * control line. Receiving is still allowed in this case.
1223 TX_STATUS_SUCCESS = 0x01,
1224 TX_STATUS_DIRECT_DONE = 0x02,
1225 TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
1226 TX_STATUS_FAIL_LONG_LIMIT = 0x83,
1227 TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
1228 TX_STATUS_FAIL_MGMNT_ABORT = 0x85,
1229 TX_STATUS_FAIL_NEXT_FRAG = 0x86,
1230 TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
1231 TX_STATUS_FAIL_DEST_PS = 0x88,
1232 TX_STATUS_FAIL_ABORTED = 0x89,
1233 TX_STATUS_FAIL_BT_RETRY = 0x8a,
1234 TX_STATUS_FAIL_STA_INVALID = 0x8b,
1235 TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
1236 TX_STATUS_FAIL_TID_DISABLE = 0x8d,
1237 TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
1238 TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
1239 TX_STATUS_FAIL_TX_LOCKED = 0x90,
1240 TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
1243 #define TX_PACKET_MODE_REGULAR 0x0000
1244 #define TX_PACKET_MODE_BURST_SEQ 0x0100
1245 #define TX_PACKET_MODE_BURST_FIRST 0x0200
1248 TX_POWER_PA_NOT_ACTIVE = 0x0,
1252 TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */
1253 TX_STATUS_DELAY_MSK = 0x00000040,
1254 TX_STATUS_ABORT_MSK = 0x00000080,
1255 TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */
1256 TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */
1257 TX_RESERVED = 0x00780000, /* bits 19:22 */
1258 TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */
1259 TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */
1262 /* *******************************
1263 * TX aggregation status
1264 ******************************* */
1267 AGG_TX_STATE_TRANSMITTED = 0x00,
1268 AGG_TX_STATE_UNDERRUN_MSK = 0x01,
1269 AGG_TX_STATE_BT_PRIO_MSK = 0x02,
1270 AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
1271 AGG_TX_STATE_ABORT_MSK = 0x08,
1272 AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
1273 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
1274 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
1275 AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
1276 AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
1277 AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
1278 AGG_TX_STATE_DUMP_TX_MSK = 0x200,
1279 AGG_TX_STATE_DELAY_TX_MSK = 0x400
1282 #define AGG_TX_STATE_LAST_SENT_MSK \
1283 (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
1284 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
1285 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
1287 /* # tx attempts for first frame in aggregation */
1288 #define AGG_TX_STATE_TRY_CNT_POS 12
1289 #define AGG_TX_STATE_TRY_CNT_MSK 0xf000
1291 /* Command ID and sequence number of Tx command for this frame */
1292 #define AGG_TX_STATE_SEQ_NUM_POS 16
1293 #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
1296 * REPLY_TX = 0x1c (response)
1298 * This response may be in one of two slightly different formats, indicated
1299 * by the frame_count field:
1301 * 1) No aggregation (frame_count == 1). This reports Tx results for
1302 * a single frame. Multiple attempts, at various bit rates, may have
1303 * been made for this frame.
1305 * 2) Aggregation (frame_count > 1). This reports Tx results for
1306 * 2 or more frames that used block-acknowledge. All frames were
1307 * transmitted at same rate. Rate scaling may have been used if first
1308 * frame in this new agg block failed in previous agg block(s).
1310 * Note that, for aggregation, ACK (block-ack) status is not delivered here;
1311 * block-ack has not been received by the time the 4965 records this status.
1312 * This status relates to reasons the tx might have been blocked or aborted
1313 * within the sending station (this 4965), rather than whether it was
1314 * received successfully by the destination station.
1316 struct iwl4965_tx_resp {
1317 u8 frame_count; /* 1 no aggregation, >1 aggregation */
1318 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
1319 u8 failure_rts; /* # failures due to unsuccessful RTS */
1320 u8 failure_frame; /* # failures due to no ACK (unused for agg) */
1322 /* For non-agg: Rate at which frame was successful.
1323 * For agg: Rate at which all frames were transmitted. */
1324 __le32 rate_n_flags; /* RATE_MCS_* */
1326 /* For non-agg: RTS + CTS + frame tx attempts time + ACK.
1327 * For agg: RTS + CTS + aggregation tx time + block-ack time. */
1328 __le16 wireless_media_time; /* uSecs */
1331 __le32 pa_power1; /* RF power amplifier measurement (not used) */
1335 * For non-agg: frame status TX_STATUS_*
1336 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1337 * fields follow this one, up to frame_count.
1339 * 11- 0: AGG_TX_STATE_* status code
1340 * 15-12: Retry count for 1st frame in aggregation (retries
1341 * occur if tx failed for this frame when it was a
1342 * member of a previous aggregation block). If rate
1343 * scaling is used, retry count indicates the rate
1344 * table entry used for all frames in the new agg.
1345 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1347 __le32 status; /* TX status (for aggregation status of 1st frame) */
1348 } __attribute__ ((packed));
1350 struct agg_tx_status {
1353 } __attribute__ ((packed));
1355 struct iwl4965_tx_resp_agg {
1356 u8 frame_count; /* 1 no aggregation, >1 aggregation */
1360 __le32 rate_n_flags;
1361 __le16 wireless_media_time;
1365 struct agg_tx_status status; /* TX status (for aggregation status */
1367 } __attribute__ ((packed));
1370 * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
1372 * Reports Block-Acknowledge from recipient station
1374 struct iwl4965_compressed_ba_resp {
1375 __le32 sta_addr_lo32;
1376 __le16 sta_addr_hi16;
1379 /* Index of recipient (BA-sending) station in uCode's station table */
1386 } __attribute__ ((packed));
1389 * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
1391 * See details under "TXPOWER" in iwl-4965-hw.h.
1393 struct iwl4965_txpowertable_cmd {
1394 u8 band; /* 0: 5 GHz, 1: 2.4 GHz */
1397 struct iwl4965_tx_power_db tx_power;
1398 } __attribute__ ((packed));
1400 /*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
1401 #define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0)
1403 /* # of EDCA prioritized tx fifos */
1404 #define LINK_QUAL_AC_NUM AC_NUM
1406 /* # entries in rate scale table to support Tx retries */
1407 #define LINK_QUAL_MAX_RETRY_NUM 16
1409 /* Tx antenna selection values */
1410 #define LINK_QUAL_ANT_A_MSK (1 << 0)
1411 #define LINK_QUAL_ANT_B_MSK (1 << 1)
1412 #define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
1416 * struct iwl_link_qual_general_params
1418 * Used in REPLY_TX_LINK_QUALITY_CMD
1420 struct iwl_link_qual_general_params {
1423 /* No entries at or above this (driver chosen) index contain MIMO */
1426 /* Best single antenna to use for single stream (legacy, SISO). */
1427 u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */
1429 /* Best antennas to use for MIMO (unused for 4965, assumes both). */
1430 u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */
1433 * If driver needs to use different initial rates for different
1434 * EDCA QOS access categories (as implemented by tx fifos 0-3),
1435 * this table will set that up, by indicating the indexes in the
1436 * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
1437 * Otherwise, driver should set all entries to 0.
1440 * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
1441 * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
1443 u8 start_rate_index[LINK_QUAL_AC_NUM];
1444 } __attribute__ ((packed));
1447 * struct iwl_link_qual_agg_params
1449 * Used in REPLY_TX_LINK_QUALITY_CMD
1451 struct iwl_link_qual_agg_params {
1453 /* Maximum number of uSec in aggregation.
1454 * Driver should set this to 4000 (4 milliseconds). */
1455 __le16 agg_time_limit;
1458 * Number of Tx retries allowed for a frame, before that frame will
1459 * no longer be considered for the start of an aggregation sequence
1460 * (scheduler will then try to tx it as single frame).
1461 * Driver should set this to 3.
1463 u8 agg_dis_start_th;
1466 * Maximum number of frames in aggregation.
1467 * 0 = no limit (default). 1 = no aggregation.
1468 * Other values = max # frames in aggregation.
1470 u8 agg_frame_cnt_limit;
1473 } __attribute__ ((packed));
1476 * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
1478 * For 4965 only; 3945 uses REPLY_RATE_SCALE.
1480 * Each station in the 4965's internal station table has its own table of 16
1481 * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
1482 * an ACK is not received. This command replaces the entire table for
1485 * NOTE: Station must already be in 4965's station table. Use REPLY_ADD_STA.
1487 * The rate scaling procedures described below work well. Of course, other
1488 * procedures are possible, and may work better for particular environments.
1491 * FILLING THE RATE TABLE
1493 * Given a particular initial rate and mode, as determined by the rate
1494 * scaling algorithm described below, the Linux driver uses the following
1495 * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
1496 * Link Quality command:
1499 * 1) If using High-throughput (HT) (SISO or MIMO) initial rate:
1500 * a) Use this same initial rate for first 3 entries.
1501 * b) Find next lower available rate using same mode (SISO or MIMO),
1502 * use for next 3 entries. If no lower rate available, switch to
1503 * legacy mode (no FAT channel, no MIMO, no short guard interval).
1504 * c) If using MIMO, set command's mimo_delimiter to number of entries
1505 * using MIMO (3 or 6).
1506 * d) After trying 2 HT rates, switch to legacy mode (no FAT channel,
1507 * no MIMO, no short guard interval), at the next lower bit rate
1508 * (e.g. if second HT bit rate was 54, try 48 legacy), and follow
1509 * legacy procedure for remaining table entries.
1511 * 2) If using legacy initial rate:
1512 * a) Use the initial rate for only one entry.
1513 * b) For each following entry, reduce the rate to next lower available
1514 * rate, until reaching the lowest available rate.
1515 * c) When reducing rate, also switch antenna selection.
1516 * d) Once lowest available rate is reached, repeat this rate until
1517 * rate table is filled (16 entries), switching antenna each entry.
1520 * ACCUMULATING HISTORY
1522 * The rate scaling algorithm for 4965, as implemented in Linux driver, uses
1523 * two sets of frame Tx success history: One for the current/active modulation
1524 * mode, and one for a speculative/search mode that is being attempted. If the
1525 * speculative mode turns out to be more effective (i.e. actual transfer
1526 * rate is better), then the driver continues to use the speculative mode
1527 * as the new current active mode.
1529 * Each history set contains, separately for each possible rate, data for a
1530 * sliding window of the 62 most recent tx attempts at that rate. The data
1531 * includes a shifting bitmap of success(1)/failure(0), and sums of successful
1532 * and attempted frames, from which the driver can additionally calculate a
1533 * success ratio (success / attempted) and number of failures
1534 * (attempted - success), and control the size of the window (attempted).
1535 * The driver uses the bit map to remove successes from the success sum, as
1536 * the oldest tx attempts fall out of the window.
1538 * When the 4965 makes multiple tx attempts for a given frame, each attempt
1539 * might be at a different rate, and have different modulation characteristics
1540 * (e.g. antenna, fat channel, short guard interval), as set up in the rate
1541 * scaling table in the Link Quality command. The driver must determine
1542 * which rate table entry was used for each tx attempt, to determine which
1543 * rate-specific history to update, and record only those attempts that
1544 * match the modulation characteristics of the history set.
1546 * When using block-ack (aggregation), all frames are transmitted at the same
1547 * rate, since there is no per-attempt acknowledgement from the destination
1548 * station. The Tx response struct iwl_tx_resp indicates the Tx rate in
1549 * rate_n_flags field. After receiving a block-ack, the driver can update
1550 * history for the entire block all at once.
1553 * FINDING BEST STARTING RATE:
1555 * When working with a selected initial modulation mode (see below), the
1556 * driver attempts to find a best initial rate. The initial rate is the
1557 * first entry in the Link Quality command's rate table.
1559 * 1) Calculate actual throughput (success ratio * expected throughput, see
1560 * table below) for current initial rate. Do this only if enough frames
1561 * have been attempted to make the value meaningful: at least 6 failed
1562 * tx attempts, or at least 8 successes. If not enough, don't try rate
1565 * 2) Find available rates adjacent to current initial rate. Available means:
1566 * a) supported by hardware &&
1567 * b) supported by association &&
1568 * c) within any constraints selected by user
1570 * 3) Gather measured throughputs for adjacent rates. These might not have
1571 * enough history to calculate a throughput. That's okay, we might try
1572 * using one of them anyway!
1574 * 4) Try decreasing rate if, for current rate:
1575 * a) success ratio is < 15% ||
1576 * b) lower adjacent rate has better measured throughput ||
1577 * c) higher adjacent rate has worse throughput, and lower is unmeasured
1579 * As a sanity check, if decrease was determined above, leave rate
1581 * a) lower rate unavailable
1582 * b) success ratio at current rate > 85% (very good)
1583 * c) current measured throughput is better than expected throughput
1584 * of lower rate (under perfect 100% tx conditions, see table below)
1586 * 5) Try increasing rate if, for current rate:
1587 * a) success ratio is < 15% ||
1588 * b) both adjacent rates' throughputs are unmeasured (try it!) ||
1589 * b) higher adjacent rate has better measured throughput ||
1590 * c) lower adjacent rate has worse throughput, and higher is unmeasured
1592 * As a sanity check, if increase was determined above, leave rate
1594 * a) success ratio at current rate < 70%. This is not particularly
1595 * good performance; higher rate is sure to have poorer success.
1597 * 6) Re-evaluate the rate after each tx frame. If working with block-
1598 * acknowledge, history and statistics may be calculated for the entire
1599 * block (including prior history that fits within the history windows),
1600 * before re-evaluation.
1602 * FINDING BEST STARTING MODULATION MODE:
1604 * After working with a modulation mode for a "while" (and doing rate scaling),
1605 * the driver searches for a new initial mode in an attempt to improve
1606 * throughput. The "while" is measured by numbers of attempted frames:
1608 * For legacy mode, search for new mode after:
1609 * 480 successful frames, or 160 failed frames
1610 * For high-throughput modes (SISO or MIMO), search for new mode after:
1611 * 4500 successful frames, or 400 failed frames
1613 * Mode switch possibilities are (3 for each mode):
1616 * Change antenna, try SISO (if HT association), try MIMO (if HT association)
1618 * Change antenna, try MIMO, try shortened guard interval (SGI)
1620 * Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)
1622 * When trying a new mode, use the same bit rate as the old/current mode when
1623 * trying antenna switches and shortened guard interval. When switching to
1624 * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate
1625 * for which the expected throughput (under perfect conditions) is about the
1626 * same or slightly better than the actual measured throughput delivered by
1627 * the old/current mode.
1629 * Actual throughput can be estimated by multiplying the expected throughput
1630 * by the success ratio (successful / attempted tx frames). Frame size is
1631 * not considered in this calculation; it assumes that frame size will average
1632 * out to be fairly consistent over several samples. The following are
1633 * metric values for expected throughput assuming 100% success ratio.
1634 * Only G band has support for CCK rates:
1636 * RATE: 1 2 5 11 6 9 12 18 24 36 48 54 60
1638 * G: 7 13 35 58 40 57 72 98 121 154 177 186 186
1639 * A: 0 0 0 0 40 57 72 98 121 154 177 186 186
1640 * SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 202
1641 * SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 211
1642 * MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 251
1643 * SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 257
1644 * SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 257
1645 * SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 264
1646 * MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 289
1647 * SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 293
1649 * After the new mode has been tried for a short while (minimum of 6 failed
1650 * frames or 8 successful frames), compare success ratio and actual throughput
1651 * estimate of the new mode with the old. If either is better with the new
1652 * mode, continue to use the new mode.
1654 * Continue comparing modes until all 3 possibilities have been tried.
1655 * If moving from legacy to HT, try all 3 possibilities from the new HT
1656 * mode. After trying all 3, a best mode is found. Continue to use this mode
1657 * for the longer "while" described above (e.g. 480 successful frames for
1658 * legacy), and then repeat the search process.
1661 struct iwl_link_quality_cmd {
1663 /* Index of destination/recipient station in uCode's station table */
1666 __le16 control; /* not used */
1667 struct iwl_link_qual_general_params general_params;
1668 struct iwl_link_qual_agg_params agg_params;
1671 * Rate info; when using rate-scaling, Tx command's initial_rate_index
1672 * specifies 1st Tx rate attempted, via index into this table.
1673 * 4965 works its way through table when retrying Tx.
1676 __le32 rate_n_flags; /* RATE_MCS_*, IWL_RATE_* */
1677 } rs_table[LINK_QUAL_MAX_RETRY_NUM];
1679 } __attribute__ ((packed));
1682 * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
1684 * 3945 and 4965 support hardware handshake with Bluetooth device on
1685 * same platform. Bluetooth device alerts wireless device when it will Tx;
1686 * wireless device can delay or kill its own Tx to accomodate.
1688 struct iwl4965_bt_cmd {
1693 __le32 kill_ack_mask;
1694 __le32 kill_cts_mask;
1695 } __attribute__ ((packed));
1697 /******************************************************************************
1699 * Spectrum Management (802.11h) Commands, Responses, Notifications:
1701 *****************************************************************************/
1704 * Spectrum Management
1706 #define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \
1707 RXON_FILTER_CTL2HOST_MSK | \
1708 RXON_FILTER_ACCEPT_GRP_MSK | \
1709 RXON_FILTER_DIS_DECRYPT_MSK | \
1710 RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
1711 RXON_FILTER_ASSOC_MSK | \
1712 RXON_FILTER_BCON_AWARE_MSK)
1714 struct iwl4965_measure_channel {
1715 __le32 duration; /* measurement duration in extended beacon
1717 u8 channel; /* channel to measure */
1718 u8 type; /* see enum iwl4965_measure_type */
1720 } __attribute__ ((packed));
1723 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
1725 struct iwl4965_spectrum_cmd {
1726 __le16 len; /* number of bytes starting from token */
1727 u8 token; /* token id */
1728 u8 id; /* measurement id -- 0 or 1 */
1729 u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */
1730 u8 periodic; /* 1 = periodic */
1731 __le16 path_loss_timeout;
1732 __le32 start_time; /* start time in extended beacon format */
1734 __le32 flags; /* rxon flags */
1735 __le32 filter_flags; /* rxon filter flags */
1736 __le16 channel_count; /* minimum 1, maximum 10 */
1738 struct iwl4965_measure_channel channels[10];
1739 } __attribute__ ((packed));
1742 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
1744 struct iwl4965_spectrum_resp {
1746 u8 id; /* id of the prior command replaced, or 0xff */
1747 __le16 status; /* 0 - command will be handled
1748 * 1 - cannot handle (conflicts with another
1750 } __attribute__ ((packed));
1752 enum iwl4965_measurement_state {
1753 IWL_MEASUREMENT_START = 0,
1754 IWL_MEASUREMENT_STOP = 1,
1757 enum iwl4965_measurement_status {
1758 IWL_MEASUREMENT_OK = 0,
1759 IWL_MEASUREMENT_CONCURRENT = 1,
1760 IWL_MEASUREMENT_CSA_CONFLICT = 2,
1761 IWL_MEASUREMENT_TGH_CONFLICT = 3,
1763 IWL_MEASUREMENT_STOPPED = 6,
1764 IWL_MEASUREMENT_TIMEOUT = 7,
1765 IWL_MEASUREMENT_PERIODIC_FAILED = 8,
1768 #define NUM_ELEMENTS_IN_HISTOGRAM 8
1770 struct iwl4965_measurement_histogram {
1771 __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
1772 __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */
1773 } __attribute__ ((packed));
1775 /* clear channel availability counters */
1776 struct iwl4965_measurement_cca_counters {
1779 } __attribute__ ((packed));
1781 enum iwl4965_measure_type {
1782 IWL_MEASURE_BASIC = (1 << 0),
1783 IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
1784 IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
1785 IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
1786 IWL_MEASURE_FRAME = (1 << 4),
1787 /* bits 5:6 are reserved */
1788 IWL_MEASURE_IDLE = (1 << 7),
1792 * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
1794 struct iwl4965_spectrum_notification {
1795 u8 id; /* measurement id -- 0 or 1 */
1797 u8 channel_index; /* index in measurement channel list */
1798 u8 state; /* 0 - start, 1 - stop */
1799 __le32 start_time; /* lower 32-bits of TSF */
1800 u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */
1802 u8 type; /* see enum iwl4965_measurement_type */
1804 /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only
1805 * valid if applicable for measurement type requested. */
1806 __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */
1807 __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */
1808 __le32 cca_time; /* channel load time in usecs */
1809 u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 -
1812 struct iwl4965_measurement_histogram histogram;
1813 __le32 stop_time; /* lower 32-bits of TSF */
1814 __le32 status; /* see iwl4965_measurement_status */
1815 } __attribute__ ((packed));
1817 /******************************************************************************
1819 * Power Management Commands, Responses, Notifications:
1821 *****************************************************************************/
1824 * struct iwl4965_powertable_cmd - Power Table Command
1825 * @flags: See below:
1827 * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
1830 * bit 0 - '0' Driver not allow power management
1831 * '1' Driver allow PM (use rest of parameters)
1832 * uCode send sleep notifications:
1833 * bit 1 - '0' Don't send sleep notification
1834 * '1' send sleep notification (SEND_PM_NOTIFICATION)
1836 * bit 2 - '0' PM have to walk up every DTIM
1837 * '1' PM could sleep over DTIM till listen Interval.
1839 * bit 3 - '0' (PCI_LINK_CTRL & 0x1)
1840 * '1' !(PCI_LINK_CTRL & 0x1)
1842 * bit 31/30- '00' use both mac/xtal sleeps
1843 * '01' force Mac sleep
1844 * '10' force xtal sleep
1847 * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
1848 * ucode assume sleep over DTIM is allowed and we don't need to wakeup
1851 #define IWL_POWER_VEC_SIZE 5
1853 #define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK __constant_cpu_to_le16(1 << 0)
1854 #define IWL_POWER_SLEEP_OVER_DTIM_MSK __constant_cpu_to_le16(1 << 2)
1855 #define IWL_POWER_PCI_PM_MSK __constant_cpu_to_le16(1 << 3)
1857 struct iwl4965_powertable_cmd {
1859 u8 keep_alive_seconds;
1861 __le32 rx_data_timeout;
1862 __le32 tx_data_timeout;
1863 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
1864 __le32 keep_alive_beacons;
1865 } __attribute__ ((packed));
1868 * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
1869 * 3945 and 4965 identical.
1871 struct iwl4965_sleep_notification {
1878 } __attribute__ ((packed));
1880 /* Sleep states. 3945 and 4965 identical. */
1882 IWL_PM_NO_SLEEP = 0,
1884 IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
1885 IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
1887 IWL_PM_SLP_REPENT = 5,
1888 IWL_PM_WAKEUP_BY_TIMER = 6,
1889 IWL_PM_WAKEUP_BY_DRIVER = 7,
1890 IWL_PM_WAKEUP_BY_RFKILL = 8,
1892 IWL_PM_NUM_OF_MODES = 12,
1896 * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
1898 #define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */
1899 #define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */
1900 #define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */
1901 struct iwl4965_card_state_cmd {
1902 __le32 status; /* CARD_STATE_CMD_* request new power state */
1903 } __attribute__ ((packed));
1906 * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
1908 struct iwl4965_card_state_notif {
1910 } __attribute__ ((packed));
1912 #define HW_CARD_DISABLED 0x01
1913 #define SW_CARD_DISABLED 0x02
1914 #define RF_CARD_DISABLED 0x04
1915 #define RXON_CARD_DISABLED 0x10
1917 struct iwl4965_ct_kill_config {
1919 __le32 critical_temperature_M;
1920 __le32 critical_temperature_R;
1921 } __attribute__ ((packed));
1923 /******************************************************************************
1925 * Scan Commands, Responses, Notifications:
1927 *****************************************************************************/
1930 * struct iwl4965_scan_channel - entry in REPLY_SCAN_CMD channel table
1932 * One for each channel in the scan list.
1933 * Each channel can independently select:
1934 * 1) SSID for directed active scans
1935 * 2) Txpower setting (for rate specified within Tx command)
1936 * 3) How long to stay on-channel (behavior may be modified by quiet_time,
1937 * quiet_plcp_th, good_CRC_th)
1939 * To avoid uCode errors, make sure the following are true (see comments
1940 * under struct iwl4965_scan_cmd about max_out_time and quiet_time):
1941 * 1) If using passive_dwell (i.e. passive_dwell != 0):
1942 * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
1943 * 2) quiet_time <= active_dwell
1944 * 3) If restricting off-channel time (i.e. max_out_time !=0):
1945 * passive_dwell < max_out_time
1946 * active_dwell < max_out_time
1948 struct iwl4965_scan_channel {
1950 * type is defined as:
1951 * 0:0 1 = active, 0 = passive
1952 * 1:4 SSID direct bit map; if a bit is set, then corresponding
1953 * SSID IE is transmitted in probe request.
1957 u8 channel; /* band is selected by iwl4965_scan_cmd "flags" field */
1958 struct iwl4965_tx_power tpc;
1959 __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */
1960 __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */
1961 } __attribute__ ((packed));
1964 * struct iwl4965_ssid_ie - directed scan network information element
1966 * Up to 4 of these may appear in REPLY_SCAN_CMD, selected by "type" field
1967 * in struct iwl4965_scan_channel; each channel may select different ssids from
1968 * among the 4 entries. SSID IEs get transmitted in reverse order of entry.
1970 struct iwl4965_ssid_ie {
1974 } __attribute__ ((packed));
1976 #define PROBE_OPTION_MAX 0x4
1977 #define TX_CMD_LIFE_TIME_INFINITE __constant_cpu_to_le32(0xFFFFFFFF)
1978 #define IWL_GOOD_CRC_TH __constant_cpu_to_le16(1)
1979 #define IWL_MAX_SCAN_SIZE 1024
1982 * REPLY_SCAN_CMD = 0x80 (command)
1984 * The hardware scan command is very powerful; the driver can set it up to
1985 * maintain (relatively) normal network traffic while doing a scan in the
1986 * background. The max_out_time and suspend_time control the ratio of how
1987 * long the device stays on an associated network channel ("service channel")
1988 * vs. how long it's away from the service channel, i.e. tuned to other channels
1991 * max_out_time is the max time off-channel (in usec), and suspend_time
1992 * is how long (in "extended beacon" format) that the scan is "suspended"
1993 * after returning to the service channel. That is, suspend_time is the
1994 * time that we stay on the service channel, doing normal work, between
1995 * scan segments. The driver may set these parameters differently to support
1996 * scanning when associated vs. not associated, and light vs. heavy traffic
1997 * loads when associated.
1999 * After receiving this command, the device's scan engine does the following;
2001 * 1) Sends SCAN_START notification to driver
2002 * 2) Checks to see if it has time to do scan for one channel
2003 * 3) Sends NULL packet, with power-save (PS) bit set to 1,
2004 * to tell AP that we're going off-channel
2005 * 4) Tunes to first channel in scan list, does active or passive scan
2006 * 5) Sends SCAN_RESULT notification to driver
2007 * 6) Checks to see if it has time to do scan on *next* channel in list
2008 * 7) Repeats 4-6 until it no longer has time to scan the next channel
2009 * before max_out_time expires
2010 * 8) Returns to service channel
2011 * 9) Sends NULL packet with PS=0 to tell AP that we're back
2012 * 10) Stays on service channel until suspend_time expires
2013 * 11) Repeats entire process 2-10 until list is complete
2014 * 12) Sends SCAN_COMPLETE notification
2016 * For fast, efficient scans, the scan command also has support for staying on
2017 * a channel for just a short time, if doing active scanning and getting no
2018 * responses to the transmitted probe request. This time is controlled by
2019 * quiet_time, and the number of received packets below which a channel is
2020 * considered "quiet" is controlled by quiet_plcp_threshold.
2022 * For active scanning on channels that have regulatory restrictions against
2023 * blindly transmitting, the scan can listen before transmitting, to make sure
2024 * that there is already legitimate activity on the channel. If enough
2025 * packets are cleanly received on the channel (controlled by good_CRC_th,
2026 * typical value 1), the scan engine starts transmitting probe requests.
2028 * Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
2030 * To avoid uCode errors, see timing restrictions described under
2031 * struct iwl4965_scan_channel.
2033 struct iwl4965_scan_cmd {
2036 u8 channel_count; /* # channels in channel list */
2037 __le16 quiet_time; /* dwell only this # millisecs on quiet channel
2038 * (only for active scan) */
2039 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
2040 __le16 good_CRC_th; /* passive -> active promotion threshold */
2041 __le16 rx_chain; /* RXON_RX_CHAIN_* */
2042 __le32 max_out_time; /* max usec to be away from associated (service)
2044 __le32 suspend_time; /* pause scan this long (in "extended beacon
2045 * format") when returning to service chnl:
2046 * 3945; 31:24 # beacons, 19:0 additional usec,
2047 * 4965; 31:22 # beacons, 21:0 additional usec.
2049 __le32 flags; /* RXON_FLG_* */
2050 __le32 filter_flags; /* RXON_FILTER_* */
2052 /* For active scans (set to all-0s for passive scans).
2053 * Does not include payload. Must specify Tx rate; no rate scaling. */
2054 struct iwl4965_tx_cmd tx_cmd;
2056 /* For directed active scans (set to all-0s otherwise) */
2057 struct iwl4965_ssid_ie direct_scan[PROBE_OPTION_MAX];
2060 * Probe request frame, followed by channel list.
2062 * Size of probe request frame is specified by byte count in tx_cmd.
2063 * Channel list follows immediately after probe request frame.
2064 * Number of channels in list is specified by channel_count.
2065 * Each channel in list is of type:
2067 * struct iwl4965_scan_channel channels[0];
2069 * NOTE: Only one band of channels can be scanned per pass. You
2070 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
2071 * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
2072 * before requesting another scan.
2075 } __attribute__ ((packed));
2077 /* Can abort will notify by complete notification with abort status. */
2078 #define CAN_ABORT_STATUS __constant_cpu_to_le32(0x1)
2079 /* complete notification statuses */
2080 #define ABORT_STATUS 0x2
2083 * REPLY_SCAN_CMD = 0x80 (response)
2085 struct iwl4965_scanreq_notification {
2086 __le32 status; /* 1: okay, 2: cannot fulfill request */
2087 } __attribute__ ((packed));
2090 * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
2092 struct iwl4965_scanstart_notification {
2095 __le32 beacon_timer;
2100 } __attribute__ ((packed));
2102 #define SCAN_OWNER_STATUS 0x1;
2103 #define MEASURE_OWNER_STATUS 0x2;
2105 #define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */
2107 * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
2109 struct iwl4965_scanresults_notification {
2115 __le32 statistics[NUMBER_OF_STATISTICS];
2116 } __attribute__ ((packed));
2119 * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
2121 struct iwl4965_scancomplete_notification {
2122 u8 scanned_channels;
2128 } __attribute__ ((packed));
2131 /******************************************************************************
2133 * IBSS/AP Commands and Notifications:
2135 *****************************************************************************/
2138 * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
2140 struct iwl4965_beacon_notif {
2141 struct iwl4965_tx_resp beacon_notify_hdr;
2144 __le32 ibss_mgr_status;
2145 } __attribute__ ((packed));
2148 * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
2150 struct iwl4965_tx_beacon_cmd {
2151 struct iwl4965_tx_cmd tx;
2155 struct ieee80211_hdr frame[0]; /* beacon frame */
2156 } __attribute__ ((packed));
2158 /******************************************************************************
2160 * Statistics Commands and Notifications:
2162 *****************************************************************************/
2164 #define IWL_TEMP_CONVERT 260
2166 #define SUP_RATE_11A_MAX_NUM_CHANNELS 8
2167 #define SUP_RATE_11B_MAX_NUM_CHANNELS 4
2168 #define SUP_RATE_11G_MAX_NUM_CHANNELS 12
2170 /* Used for passing to driver number of successes and failures per rate */
2171 struct rate_histogram {
2173 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2174 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2175 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2178 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2179 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2180 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2182 } __attribute__ ((packed));
2184 /* statistics command response */
2186 struct statistics_rx_phy {
2192 __le32 early_overrun_err;
2194 __le32 false_alarm_cnt;
2195 __le32 fina_sync_err_cnt;
2197 __le32 fina_timeout;
2198 __le32 unresponded_rts;
2199 __le32 rxe_frame_limit_overrun;
2200 __le32 sent_ack_cnt;
2201 __le32 sent_cts_cnt;
2202 __le32 sent_ba_rsp_cnt;
2203 __le32 dsp_self_kill;
2204 __le32 mh_format_err;
2205 __le32 re_acq_main_rssi_sum;
2207 } __attribute__ ((packed));
2209 struct statistics_rx_ht_phy {
2212 __le32 early_overrun_err;
2215 __le32 mh_format_err;
2216 __le32 agg_crc32_good;
2217 __le32 agg_mpdu_cnt;
2220 } __attribute__ ((packed));
2222 struct statistics_rx_non_phy {
2223 __le32 bogus_cts; /* CTS received when not expecting CTS */
2224 __le32 bogus_ack; /* ACK received when not expecting ACK */
2225 __le32 non_bssid_frames; /* number of frames with BSSID that
2226 * doesn't belong to the STA BSSID */
2227 __le32 filtered_frames; /* count frames that were dumped in the
2228 * filtering process */
2229 __le32 non_channel_beacons; /* beacons with our bss id but not on
2230 * our serving channel */
2231 __le32 channel_beacons; /* beacons with our bss id and in our
2232 * serving channel */
2233 __le32 num_missed_bcon; /* number of missed beacons */
2234 __le32 adc_rx_saturation_time; /* count in 0.8us units the time the
2235 * ADC was in saturation */
2236 __le32 ina_detection_search_time;/* total time (in 0.8us) searched
2238 __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */
2239 __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */
2240 __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */
2241 __le32 interference_data_flag; /* flag for interference data
2242 * availability. 1 when data is
2244 __le32 channel_load; /* counts RX Enable time in uSec */
2245 __le32 dsp_false_alarms; /* DSP false alarm (both OFDM
2246 * and CCK) counter */
2247 __le32 beacon_rssi_a;
2248 __le32 beacon_rssi_b;
2249 __le32 beacon_rssi_c;
2250 __le32 beacon_energy_a;
2251 __le32 beacon_energy_b;
2252 __le32 beacon_energy_c;
2253 } __attribute__ ((packed));
2255 struct statistics_rx {
2256 struct statistics_rx_phy ofdm;
2257 struct statistics_rx_phy cck;
2258 struct statistics_rx_non_phy general;
2259 struct statistics_rx_ht_phy ofdm_ht;
2260 } __attribute__ ((packed));
2262 struct statistics_tx_non_phy_agg {
2264 __le32 ba_reschedule_frames;
2265 __le32 scd_query_agg_frame_cnt;
2266 __le32 scd_query_no_agg;
2267 __le32 scd_query_agg;
2268 __le32 scd_query_mismatch;
2269 __le32 frame_not_ready;
2271 __le32 bt_prio_kill;
2272 __le32 rx_ba_rsp_cnt;
2275 } __attribute__ ((packed));
2277 struct statistics_tx {
2278 __le32 preamble_cnt;
2279 __le32 rx_detected_cnt;
2280 __le32 bt_prio_defer_cnt;
2281 __le32 bt_prio_kill_cnt;
2282 __le32 few_bytes_cnt;
2285 __le32 expected_ack_cnt;
2286 __le32 actual_ack_cnt;
2287 __le32 dump_msdu_cnt;
2288 __le32 burst_abort_next_frame_mismatch_cnt;
2289 __le32 burst_abort_missing_next_frame_cnt;
2290 __le32 cts_timeout_collision;
2291 __le32 ack_or_ba_timeout_collision;
2292 struct statistics_tx_non_phy_agg agg;
2293 } __attribute__ ((packed));
2295 struct statistics_dbg {
2299 } __attribute__ ((packed));
2301 struct statistics_div {
2308 } __attribute__ ((packed));
2310 struct statistics_general {
2312 __le32 temperature_m;
2313 struct statistics_dbg dbg;
2317 __le32 ttl_timestamp;
2318 struct statistics_div div;
2319 __le32 rx_enable_counter;
2323 } __attribute__ ((packed));
2326 * REPLY_STATISTICS_CMD = 0x9c,
2327 * 3945 and 4965 identical.
2329 * This command triggers an immediate response containing uCode statistics.
2330 * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
2332 * If the CLEAR_STATS configuration flag is set, uCode will clear its
2333 * internal copy of the statistics (counters) after issuing the response.
2334 * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
2336 * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
2337 * STATISTICS_NOTIFICATIONs after received beacons (see below). This flag
2338 * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
2340 #define IWL_STATS_CONF_CLEAR_STATS __constant_cpu_to_le32(0x1) /* see above */
2341 #define IWL_STATS_CONF_DISABLE_NOTIF __constant_cpu_to_le32(0x2)/* see above */
2342 struct iwl4965_statistics_cmd {
2343 __le32 configuration_flags; /* IWL_STATS_CONF_* */
2344 } __attribute__ ((packed));
2347 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
2349 * By default, uCode issues this notification after receiving a beacon
2350 * while associated. To disable this behavior, set DISABLE_NOTIF flag in the
2351 * REPLY_STATISTICS_CMD 0x9c, above.
2353 * Statistics counters continue to increment beacon after beacon, but are
2354 * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
2355 * 0x9c with CLEAR_STATS bit set (see above).
2357 * uCode also issues this notification during scans. uCode clears statistics
2358 * appropriately so that each notification contains statistics for only the
2359 * one channel that has just been scanned.
2361 #define STATISTICS_REPLY_FLG_BAND_24G_MSK __constant_cpu_to_le32(0x2)
2362 #define STATISTICS_REPLY_FLG_FAT_MODE_MSK __constant_cpu_to_le32(0x8)
2363 struct iwl4965_notif_statistics {
2365 struct statistics_rx rx;
2366 struct statistics_tx tx;
2367 struct statistics_general general;
2368 } __attribute__ ((packed));
2372 * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
2374 /* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row,
2375 * then this notification will be sent. */
2376 #define CONSECUTIVE_MISSED_BCONS_TH 20
2378 struct iwl4965_missed_beacon_notif {
2379 __le32 consequtive_missed_beacons;
2380 __le32 total_missed_becons;
2381 __le32 num_expected_beacons;
2382 __le32 num_recvd_beacons;
2383 } __attribute__ ((packed));
2386 /******************************************************************************
2388 * Rx Calibration Commands:
2390 * With the uCode used for open source drivers, most Tx calibration (except
2391 * for Tx Power) and most Rx calibration is done by uCode during the
2392 * "initialize" phase of uCode boot. Driver must calibrate only:
2394 * 1) Tx power (depends on temperature), described elsewhere
2395 * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas)
2396 * 3) Receiver sensitivity (to optimize signal detection)
2398 *****************************************************************************/
2401 * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
2403 * This command sets up the Rx signal detector for a sensitivity level that
2404 * is high enough to lock onto all signals within the associated network,
2405 * but low enough to ignore signals that are below a certain threshold, so as
2406 * not to have too many "false alarms". False alarms are signals that the
2407 * Rx DSP tries to lock onto, but then discards after determining that they
2410 * The optimum number of false alarms is between 5 and 50 per 200 TUs
2411 * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
2412 * time listening, not transmitting). Driver must adjust sensitivity so that
2413 * the ratio of actual false alarms to actual Rx time falls within this range.
2415 * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
2416 * received beacon. These provide information to the driver to analyze the
2417 * sensitivity. Don't analyze statistics that come in from scanning, or any
2418 * other non-associated-network source. Pertinent statistics include:
2420 * From "general" statistics (struct statistics_rx_non_phy):
2422 * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
2423 * Measure of energy of desired signal. Used for establishing a level
2424 * below which the device does not detect signals.
2426 * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
2427 * Measure of background noise in silent period after beacon.
2430 * uSecs of actual Rx time during beacon period (varies according to
2431 * how much time was spent transmitting).
2433 * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
2436 * Signal locks abandoned early (before phy-level header).
2439 * Signal locks abandoned late (during phy-level header).
2441 * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from
2442 * beacon to beacon, i.e. each value is an accumulation of all errors
2443 * before and including the latest beacon. Values will wrap around to 0
2444 * after counting up to 2^32 - 1. Driver must differentiate vs.
2445 * previous beacon's values to determine # false alarms in the current
2448 * Total number of false alarms = false_alarms + plcp_errs
2450 * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
2451 * (notice that the start points for OFDM are at or close to settings for
2452 * maximum sensitivity):
2455 * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120
2456 * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210
2457 * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140
2458 * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270
2460 * If actual rate of OFDM false alarms (+ plcp_errors) is too high
2461 * (greater than 50 for each 204.8 msecs listening), reduce sensitivity
2462 * by *adding* 1 to all 4 of the table entries above, up to the max for
2463 * each entry. Conversely, if false alarm rate is too low (less than 5
2464 * for each 204.8 msecs listening), *subtract* 1 from each entry to
2465 * increase sensitivity.
2467 * For CCK sensitivity, keep track of the following:
2469 * 1). 20-beacon history of maximum background noise, indicated by
2470 * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
2471 * 3 receivers. For any given beacon, the "silence reference" is
2472 * the maximum of last 60 samples (20 beacons * 3 receivers).
2474 * 2). 10-beacon history of strongest signal level, as indicated
2475 * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
2476 * i.e. the strength of the signal through the best receiver at the
2477 * moment. These measurements are "upside down", with lower values
2478 * for stronger signals, so max energy will be *minimum* value.
2480 * Then for any given beacon, the driver must determine the *weakest*
2481 * of the strongest signals; this is the minimum level that needs to be
2482 * successfully detected, when using the best receiver at the moment.
2483 * "Max cck energy" is the maximum (higher value means lower energy!)
2484 * of the last 10 minima. Once this is determined, driver must add
2485 * a little margin by adding "6" to it.
2487 * 3). Number of consecutive beacon periods with too few false alarms.
2488 * Reset this to 0 at the first beacon period that falls within the
2489 * "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
2491 * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
2492 * (notice that the start points for CCK are at maximum sensitivity):
2495 * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200
2496 * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400
2497 * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100
2499 * If actual rate of CCK false alarms (+ plcp_errors) is too high
2500 * (greater than 50 for each 204.8 msecs listening), method for reducing
2503 * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2506 * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
2507 * sensitivity has been reduced a significant amount; bring it up to
2508 * a moderate 161. Otherwise, *add* 3, up to max 200.
2510 * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
2511 * sensitivity has been reduced only a moderate or small amount;
2512 * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
2513 * down to min 0. Otherwise (if gain has been significantly reduced),
2514 * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
2516 * b) Save a snapshot of the "silence reference".
2518 * If actual rate of CCK false alarms (+ plcp_errors) is too low
2519 * (less than 5 for each 204.8 msecs listening), method for increasing
2520 * sensitivity is used only if:
2522 * 1a) Previous beacon did not have too many false alarms
2523 * 1b) AND difference between previous "silence reference" and current
2524 * "silence reference" (prev - current) is 2 or more,
2525 * OR 2) 100 or more consecutive beacon periods have had rate of
2526 * less than 5 false alarms per 204.8 milliseconds rx time.
2528 * Method for increasing sensitivity:
2530 * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
2533 * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2536 * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
2538 * If actual rate of CCK false alarms (+ plcp_errors) is within good range
2539 * (between 5 and 50 for each 204.8 msecs listening):
2541 * 1) Save a snapshot of the silence reference.
2543 * 2) If previous beacon had too many CCK false alarms (+ plcp_errors),
2544 * give some extra margin to energy threshold by *subtracting* 8
2545 * from value in HD_MIN_ENERGY_CCK_DET_INDEX.
2547 * For all cases (too few, too many, good range), make sure that the CCK
2548 * detection threshold (energy) is below the energy level for robust
2549 * detection over the past 10 beacon periods, the "Max cck energy".
2550 * Lower values mean higher energy; this means making sure that the value
2551 * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
2553 * Driver should set the following entries to fixed values:
2555 * HD_MIN_ENERGY_OFDM_DET_INDEX 100
2556 * HD_BARKER_CORR_TH_ADD_MIN_INDEX 190
2557 * HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX 390
2558 * HD_OFDM_ENERGY_TH_IN_INDEX 62
2562 * Table entries in SENSITIVITY_CMD (struct iwl_sensitivity_cmd)
2564 #define HD_TABLE_SIZE (11) /* number of entries */
2565 #define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */
2566 #define HD_MIN_ENERGY_OFDM_DET_INDEX (1)
2567 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2)
2568 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3)
2569 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4)
2570 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5)
2571 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6)
2572 #define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7)
2573 #define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8)
2574 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9)
2575 #define HD_OFDM_ENERGY_TH_IN_INDEX (10)
2577 /* Control field in struct iwl_sensitivity_cmd */
2578 #define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE __constant_cpu_to_le16(0)
2579 #define SENSITIVITY_CMD_CONTROL_WORK_TABLE __constant_cpu_to_le16(1)
2582 * struct iwl_sensitivity_cmd
2583 * @control: (1) updates working table, (0) updates default table
2584 * @table: energy threshold values, use HD_* as index into table
2586 * Always use "1" in "control" to update uCode's working table and DSP.
2588 struct iwl_sensitivity_cmd {
2589 __le16 control; /* always use "1" */
2590 __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */
2591 } __attribute__ ((packed));
2595 * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
2597 * This command sets the relative gains of 4965's 3 radio receiver chains.
2599 * After the first association, driver should accumulate signal and noise
2600 * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
2601 * beacons from the associated network (don't collect statistics that come
2602 * in from scanning, or any other non-network source).
2604 * DISCONNECTED ANTENNA:
2606 * Driver should determine which antennas are actually connected, by comparing
2607 * average beacon signal levels for the 3 Rx chains. Accumulate (add) the
2608 * following values over 20 beacons, one accumulator for each of the chains
2609 * a/b/c, from struct statistics_rx_non_phy:
2611 * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
2613 * Find the strongest signal from among a/b/c. Compare the other two to the
2614 * strongest. If any signal is more than 15 dB (times 20, unless you
2615 * divide the accumulated values by 20) below the strongest, the driver
2616 * considers that antenna to be disconnected, and should not try to use that
2617 * antenna/chain for Rx or Tx. If both A and B seem to be disconnected,
2618 * driver should declare the stronger one as connected, and attempt to use it
2619 * (A and B are the only 2 Tx chains!).
2624 * Driver should balance the 3 receivers (but just the ones that are connected
2625 * to antennas, see above) for gain, by comparing the average signal levels
2626 * detected during the silence after each beacon (background noise).
2627 * Accumulate (add) the following values over 20 beacons, one accumulator for
2628 * each of the chains a/b/c, from struct statistics_rx_non_phy:
2630 * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
2632 * Find the weakest background noise level from among a/b/c. This Rx chain
2633 * will be the reference, with 0 gain adjustment. Attenuate other channels by
2634 * finding noise difference:
2636 * (accum_noise[i] - accum_noise[reference]) / 30
2638 * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
2639 * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
2640 * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
2641 * and set bit 2 to indicate "reduce gain". The value for the reference
2642 * (weakest) chain should be "0".
2644 * diff_gain_[abc] bit fields:
2645 * 2: (1) reduce gain, (0) increase gain
2646 * 1-0: amount of gain, units of 1.5 dB
2649 /* "Differential Gain" opcode used in REPLY_PHY_CALIBRATION_CMD. */
2650 #define PHY_CALIBRATE_DIFF_GAIN_CMD (7)
2652 struct iwl4965_calibration_cmd {
2653 u8 opCode; /* PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
2654 u8 flags; /* not used */
2656 s8 diff_gain_a; /* see above */
2660 } __attribute__ ((packed));
2662 /******************************************************************************
2664 * Miscellaneous Commands:
2666 *****************************************************************************/
2669 * LEDs Command & Response
2670 * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
2672 * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
2673 * this command turns it on or off, or sets up a periodic blinking cycle.
2675 struct iwl4965_led_cmd {
2676 __le32 interval; /* "interval" in uSec */
2677 u8 id; /* 1: Activity, 2: Link, 3: Tech */
2678 u8 off; /* # intervals off while blinking;
2679 * "0", with >0 "on" value, turns LED on */
2680 u8 on; /* # intervals on while blinking;
2681 * "0", regardless of "off", turns LED off */
2683 } __attribute__ ((packed));
2685 /******************************************************************************
2687 * Union of all expected notifications/responses:
2689 *****************************************************************************/
2691 struct iwl4965_rx_packet {
2693 struct iwl_cmd_header hdr;
2695 struct iwl4965_alive_resp alive_frame;
2696 struct iwl4965_rx_frame rx_frame;
2697 struct iwl4965_tx_resp tx_resp;
2698 struct iwl4965_spectrum_notification spectrum_notif;
2699 struct iwl4965_csa_notification csa_notif;
2700 struct iwl4965_error_resp err_resp;
2701 struct iwl4965_card_state_notif card_state_notif;
2702 struct iwl4965_beacon_notif beacon_status;
2703 struct iwl4965_add_sta_resp add_sta;
2704 struct iwl4965_sleep_notification sleep_notif;
2705 struct iwl4965_spectrum_resp spectrum;
2706 struct iwl4965_notif_statistics stats;
2707 struct iwl4965_compressed_ba_resp compressed_ba;
2708 struct iwl4965_missed_beacon_notif missed_beacon;
2712 } __attribute__ ((packed));
2714 #define IWL_RX_FRAME_SIZE (4 + sizeof(struct iwl4965_rx_frame))
2716 #endif /* __iwl4965_commands_h__ */