1
/******************************************************************************
3
* This file is provided under a dual BSD/GPLv2 license. When using or
4
* redistributing this file, you may do so under either license.
8
* Copyright(c) 2005 - 2007 Intel Corporation. All rights reserved.
10
* This program is free software; you can redistribute it and/or modify
11
* it under the terms of version 2 of the GNU General Public License as
12
* published by the Free Software Foundation.
14
* This program is distributed in the hope that it will be useful, but
15
* WITHOUT ANY WARRANTY; without even the implied warranty of
16
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17
* General Public License for more details.
19
* You should have received a copy of the GNU General Public License
20
* along with this program; if not, write to the Free Software
21
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
24
* The full GNU General Public License is included in this distribution
25
* in the file called LICENSE.GPL.
27
* Contact Information:
28
* James P. Ketrenos <ipw2100-admin@linux.intel.com>
29
* Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33
* Copyright(c) 2005 - 2007 Intel Corporation. All rights reserved.
34
* All rights reserved.
36
* Redistribution and use in source and binary forms, with or without
37
* modification, are permitted provided that the following conditions
40
* * Redistributions of source code must retain the above copyright
41
* notice, this list of conditions and the following disclaimer.
42
* * Redistributions in binary form must reproduce the above copyright
43
* notice, this list of conditions and the following disclaimer in
44
* the documentation and/or other materials provided with the
46
* * Neither the name Intel Corporation nor the names of its
47
* contributors may be used to endorse or promote products derived
48
* from this software without specific prior written permission.
50
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62
*****************************************************************************/
64
* Please use this file (iwl-4965-commands.h) only for uCode API definitions.
65
* Please use iwl-4965-hw.h for hardware-related definitions.
66
* Please use iwl-4965.h for driver implementation definitions.
69
#ifndef __iwl4965_commands_h__
70
#define __iwl4965_commands_h__
76
/* RXON and QOS commands */
78
REPLY_RXON_ASSOC = 0x11,
79
REPLY_QOS_PARAM = 0x13,
80
REPLY_RXON_TIMING = 0x14,
82
/* Multi-Station support */
84
REPLY_REMOVE_STA = 0x19, /* not used */
85
REPLY_REMOVE_ALL_STA = 0x1a, /* not used */
89
REPLY_RATE_SCALE = 0x47, /* 3945 only */
90
REPLY_LEDS_CMD = 0x48,
91
REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */
94
RADAR_NOTIFICATION = 0x70, /* not used */
95
REPLY_QUIET_CMD = 0x71, /* not used */
96
REPLY_CHANNEL_SWITCH = 0x72,
97
CHANNEL_SWITCH_NOTIFICATION = 0x73,
98
REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
99
SPECTRUM_MEASURE_NOTIFICATION = 0x75,
101
/* Power Management */
102
POWER_TABLE_CMD = 0x77,
103
PM_SLEEP_NOTIFICATION = 0x7A,
104
PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
106
/* Scan commands and notifications */
107
REPLY_SCAN_CMD = 0x80,
108
REPLY_SCAN_ABORT_CMD = 0x81,
109
SCAN_START_NOTIFICATION = 0x82,
110
SCAN_RESULTS_NOTIFICATION = 0x83,
111
SCAN_COMPLETE_NOTIFICATION = 0x84,
113
/* IBSS/AP commands */
114
BEACON_NOTIFICATION = 0x90,
115
REPLY_TX_BEACON = 0x91,
116
WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */
118
/* Miscellaneous commands */
119
QUIET_NOTIFICATION = 0x96, /* not used */
120
REPLY_TX_PWR_TABLE_CMD = 0x97,
121
MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */
123
/* Bluetooth device coexistance config command */
124
REPLY_BT_CONFIG = 0x9b,
127
REPLY_STATISTICS_CMD = 0x9c,
128
STATISTICS_NOTIFICATION = 0x9d,
130
/* RF-KILL commands and notifications */
131
REPLY_CARD_STATE_CMD = 0xa0,
132
CARD_STATE_NOTIFICATION = 0xa1,
134
/* Missed beacons notification */
135
MISSED_BEACONS_NOTIFICATION = 0xa2,
137
REPLY_CT_KILL_CONFIG_CMD = 0xa4,
138
SENSITIVITY_CMD = 0xa8,
139
REPLY_PHY_CALIBRATION_CMD = 0xb0,
140
REPLY_RX_PHY_CMD = 0xc0,
141
REPLY_RX_MPDU_CMD = 0xc1,
142
REPLY_4965_RX = 0xc3,
143
REPLY_COMPRESSED_BA = 0xc5,
147
/******************************************************************************
149
* Commonly used structures and definitions:
150
* Command header, rate_n_flags, txpower
152
*****************************************************************************/
154
/* iwl4965_cmd_header flags value */
155
#define IWL_CMD_FAILED_MSK 0x40
158
* struct iwl4965_cmd_header
160
* This header format appears in the beginning of each command sent from the
161
* driver, and each response/notification received from uCode.
163
struct iwl4965_cmd_header {
164
u8 cmd; /* Command ID: REPLY_RXON, etc. */
165
u8 flags; /* IWL_CMD_* */
167
* The driver sets up the sequence number to values of its chosing.
168
* uCode does not use this value, but passes it back to the driver
169
* when sending the response to each driver-originated command, so
170
* the driver can match the response to the command. Since the values
171
* don't get used by uCode, the driver may set up an arbitrary format.
173
* There is one exception: uCode sets bit 15 when it originates
174
* the response/notification, i.e. when the response/notification
175
* is not a direct response to a command sent by the driver. For
176
* example, uCode issues REPLY_3945_RX when it sends a received frame
177
* to the driver; it is not a direct response to any driver command.
179
* The Linux driver uses the following format:
181
* 0:7 index/position within Tx queue
182
* 8:13 Tx queue selection
183
* 14:14 driver sets this to indicate command is in the 'huge'
184
* storage at the end of the command buffers, i.e. scan cmd
185
* 15:15 uCode sets this in uCode-originated response/notification
189
/* command or response/notification data follows immediately */
191
} __attribute__ ((packed));
194
* 4965 rate_n_flags bit fields
196
* rate_n_flags format is used in following 4965 commands:
197
* REPLY_4965_RX (response only)
198
* REPLY_TX (both command and response)
199
* REPLY_TX_LINK_QUALITY_CMD
201
* High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
211
* 3: 0) Single stream (SISO)
212
* 1) Dual stream (MIMO)
214
* 5: Value of 0x20 in bits 7:0 indicates 6 Mbps FAT duplicate data
216
* Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
226
* Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
232
#define RATE_MCS_CODE_MSK 0x7
233
#define RATE_MCS_MIMO_POS 3
234
#define RATE_MCS_MIMO_MSK 0x8
235
#define RATE_MCS_HT_DUP_POS 5
236
#define RATE_MCS_HT_DUP_MSK 0x20
238
/* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
239
#define RATE_MCS_FLAGS_POS 8
240
#define RATE_MCS_HT_POS 8
241
#define RATE_MCS_HT_MSK 0x100
243
/* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */
244
#define RATE_MCS_CCK_POS 9
245
#define RATE_MCS_CCK_MSK 0x200
247
/* Bit 10: (1) Use Green Field preamble */
248
#define RATE_MCS_GF_POS 10
249
#define RATE_MCS_GF_MSK 0x400
251
/* Bit 11: (1) Use 40Mhz FAT chnl width, (0) use 20 MHz legacy chnl width */
252
#define RATE_MCS_FAT_POS 11
253
#define RATE_MCS_FAT_MSK 0x800
255
/* Bit 12: (1) Duplicate data on both 20MHz chnls. FAT (bit 11) must be set. */
256
#define RATE_MCS_DUP_POS 12
257
#define RATE_MCS_DUP_MSK 0x1000
259
/* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
260
#define RATE_MCS_SGI_POS 13
261
#define RATE_MCS_SGI_MSK 0x2000
264
* rate_n_flags Tx antenna masks (4965 has 2 transmitters):
265
* bit14:15 01 B inactive, A active
266
* 10 B active, A inactive
269
#define RATE_MCS_ANT_A_POS 14
270
#define RATE_MCS_ANT_B_POS 15
271
#define RATE_MCS_ANT_A_MSK 0x4000
272
#define RATE_MCS_ANT_B_MSK 0x8000
273
#define RATE_MCS_ANT_AB_MSK 0xc000
277
* struct iwl4965_tx_power - txpower format used in REPLY_SCAN_CMD
279
* Scan uses only one transmitter, so only one analog/dsp gain pair is needed.
281
struct iwl4965_tx_power {
282
u8 tx_gain; /* gain for analog radio */
283
u8 dsp_atten; /* gain for DSP */
284
} __attribute__ ((packed));
286
#define POWER_TABLE_NUM_ENTRIES 33
287
#define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32
288
#define POWER_TABLE_CCK_ENTRY 32
291
* union iwl4965_tx_power_dual_stream
293
* Host format used for REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
294
* Use __le32 version (struct tx_power_dual_stream) when building command.
296
* Driver provides radio gain and DSP attenuation settings to device in pairs,
297
* one value for each transmitter chain. The first value is for transmitter A,
298
* second for transmitter B.
300
* For SISO bit rates, both values in a pair should be identical.
301
* For MIMO rates, one value may be different from the other,
302
* in order to balance the Tx output between the two transmitters.
304
* See more details in doc for TXPOWER in iwl-4965-hw.h.
306
union iwl4965_tx_power_dual_stream {
309
u8 dsp_predis_atten[2];
315
* struct tx_power_dual_stream
317
* Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
319
* Same format as iwl_tx_power_dual_stream, but __le32
321
struct tx_power_dual_stream {
323
} __attribute__ ((packed));
326
* struct iwl4965_tx_power_db
328
* Entire table within REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
330
struct iwl4965_tx_power_db {
331
struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES];
332
} __attribute__ ((packed));
335
/******************************************************************************
337
* Alive and Error Commands & Responses:
339
*****************************************************************************/
341
#define UCODE_VALID_OK __constant_cpu_to_le32(0x1)
342
#define INITIALIZE_SUBTYPE (9)
345
* ("Initialize") REPLY_ALIVE = 0x1 (response only, not a command)
347
* uCode issues this "initialize alive" notification once the initialization
348
* uCode image has completed its work, and is ready to load the runtime image.
349
* This is the *first* "alive" notification that the driver will receive after
350
* rebooting uCode; the "initialize" alive is indicated by subtype field == 9.
352
* See comments documenting "BSM" (bootstrap state machine).
354
* For 4965, this notification contains important calibration data for
355
* calculating txpower settings:
357
* 1) Power supply voltage indication. The voltage sensor outputs higher
358
* values for lower voltage, and vice versa.
360
* 2) Temperature measurement parameters, for each of two channel widths
361
* (20 MHz and 40 MHz) supported by the radios. Temperature sensing
362
* is done via one of the receiver chains, and channel width influences
365
* 3) Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation,
366
* for each of 5 frequency ranges.
368
struct iwl4965_init_alive_resp {
374
u8 ver_subtype; /* "9" for initialize alive */
376
__le32 log_event_table_ptr;
377
__le32 error_event_table_ptr;
381
/* calibration values from "initialize" uCode */
382
__le32 voltage; /* signed, higher value is lower voltage */
383
__le32 therm_r1[2]; /* signed, 1st for normal, 2nd for FAT channel*/
384
__le32 therm_r2[2]; /* signed */
385
__le32 therm_r3[2]; /* signed */
386
__le32 therm_r4[2]; /* signed */
387
__le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups,
389
} __attribute__ ((packed));
393
* REPLY_ALIVE = 0x1 (response only, not a command)
395
* uCode issues this "alive" notification once the runtime image is ready
396
* to receive commands from the driver. This is the *second* "alive"
397
* notification that the driver will receive after rebooting uCode;
398
* this "alive" is indicated by subtype field != 9.
400
* See comments documenting "BSM" (bootstrap state machine).
402
* This response includes two pointers to structures within the device's
403
* data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
405
* 1) log_event_table_ptr indicates base of the event log. This traces
406
* a 256-entry history of uCode execution within a circular buffer.
407
* Its header format is:
409
* __le32 log_size; log capacity (in number of entries)
410
* __le32 type; (1) timestamp with each entry, (0) no timestamp
411
* __le32 wraps; # times uCode has wrapped to top of circular buffer
412
* __le32 write_index; next circular buffer entry that uCode would fill
414
* The header is followed by the circular buffer of log entries. Entries
415
* with timestamps have the following format:
417
* __le32 event_id; range 0 - 1500
418
* __le32 timestamp; low 32 bits of TSF (of network, if associated)
419
* __le32 data; event_id-specific data value
421
* Entries without timestamps contain only event_id and data.
423
* 2) error_event_table_ptr indicates base of the error log. This contains
424
* information about any uCode error that occurs. For 4965, the format
425
* of the error log is:
427
* __le32 valid; (nonzero) valid, (0) log is empty
428
* __le32 error_id; type of error
429
* __le32 pc; program counter
430
* __le32 blink1; branch link
431
* __le32 blink2; branch link
432
* __le32 ilink1; interrupt link
433
* __le32 ilink2; interrupt link
434
* __le32 data1; error-specific data
435
* __le32 data2; error-specific data
436
* __le32 line; source code line of error
437
* __le32 bcon_time; beacon timer
438
* __le32 tsf_low; network timestamp function timer
439
* __le32 tsf_hi; network timestamp function timer
441
* The Linux driver can print both logs to the system log when a uCode error
444
struct iwl4965_alive_resp {
450
u8 ver_subtype; /* not "9" for runtime alive */
452
__le32 log_event_table_ptr; /* SRAM address for event log */
453
__le32 error_event_table_ptr; /* SRAM address for error log */
456
} __attribute__ ((packed));
466
* REPLY_ERROR = 0x2 (response only, not a command)
468
struct iwl4965_error_resp {
472
__le16 bad_cmd_seq_num;
475
} __attribute__ ((packed));
477
/******************************************************************************
479
* RXON Commands & Responses:
481
*****************************************************************************/
484
* Rx config defines & structure
486
/* rx_config device types */
488
RXON_DEV_TYPE_AP = 1,
489
RXON_DEV_TYPE_ESS = 3,
490
RXON_DEV_TYPE_IBSS = 4,
491
RXON_DEV_TYPE_SNIFFER = 6,
495
#define RXON_RX_CHAIN_DRIVER_FORCE_MSK __constant_cpu_to_le16(0x1<<0)
496
#define RXON_RX_CHAIN_VALID_MSK __constant_cpu_to_le16(0x7<<1)
497
#define RXON_RX_CHAIN_VALID_POS (1)
498
#define RXON_RX_CHAIN_FORCE_SEL_MSK __constant_cpu_to_le16(0x7<<4)
499
#define RXON_RX_CHAIN_FORCE_SEL_POS (4)
500
#define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK __constant_cpu_to_le16(0x7<<7)
501
#define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
502
#define RXON_RX_CHAIN_CNT_MSK __constant_cpu_to_le16(0x3<<10)
503
#define RXON_RX_CHAIN_CNT_POS (10)
504
#define RXON_RX_CHAIN_MIMO_CNT_MSK __constant_cpu_to_le16(0x3<<12)
505
#define RXON_RX_CHAIN_MIMO_CNT_POS (12)
506
#define RXON_RX_CHAIN_MIMO_FORCE_MSK __constant_cpu_to_le16(0x1<<14)
507
#define RXON_RX_CHAIN_MIMO_FORCE_POS (14)
509
/* rx_config flags */
510
/* band & modulation selection */
511
#define RXON_FLG_BAND_24G_MSK __constant_cpu_to_le32(1 << 0)
512
#define RXON_FLG_CCK_MSK __constant_cpu_to_le32(1 << 1)
513
/* auto detection enable */
514
#define RXON_FLG_AUTO_DETECT_MSK __constant_cpu_to_le32(1 << 2)
515
/* TGg protection when tx */
516
#define RXON_FLG_TGG_PROTECT_MSK __constant_cpu_to_le32(1 << 3)
517
/* cck short slot & preamble */
518
#define RXON_FLG_SHORT_SLOT_MSK __constant_cpu_to_le32(1 << 4)
519
#define RXON_FLG_SHORT_PREAMBLE_MSK __constant_cpu_to_le32(1 << 5)
520
/* antenna selection */
521
#define RXON_FLG_DIS_DIV_MSK __constant_cpu_to_le32(1 << 7)
522
#define RXON_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0x0f00)
523
#define RXON_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8)
524
#define RXON_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9)
525
/* radar detection enable */
526
#define RXON_FLG_RADAR_DETECT_MSK __constant_cpu_to_le32(1 << 12)
527
#define RXON_FLG_TGJ_NARROW_BAND_MSK __constant_cpu_to_le32(1 << 13)
528
/* rx response to host with 8-byte TSF
529
* (according to ON_AIR deassertion) */
530
#define RXON_FLG_TSF2HOST_MSK __constant_cpu_to_le32(1 << 15)
534
#define RXON_FLG_CTRL_CHANNEL_LOC_POS (22)
535
#define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK __constant_cpu_to_le32(0x1<<22)
537
#define RXON_FLG_HT_OPERATING_MODE_POS (23)
539
#define RXON_FLG_HT_PROT_MSK __constant_cpu_to_le32(0x1<<23)
540
#define RXON_FLG_FAT_PROT_MSK __constant_cpu_to_le32(0x2<<23)
542
#define RXON_FLG_CHANNEL_MODE_POS (25)
543
#define RXON_FLG_CHANNEL_MODE_MSK __constant_cpu_to_le32(0x3<<25)
544
#define RXON_FLG_CHANNEL_MODE_PURE_40_MSK __constant_cpu_to_le32(0x1<<25)
545
#define RXON_FLG_CHANNEL_MODE_MIXED_MSK __constant_cpu_to_le32(0x2<<25)
547
/* rx_config filter flags */
548
/* accept all data frames */
549
#define RXON_FILTER_PROMISC_MSK __constant_cpu_to_le32(1 << 0)
550
/* pass control & management to host */
551
#define RXON_FILTER_CTL2HOST_MSK __constant_cpu_to_le32(1 << 1)
552
/* accept multi-cast */
553
#define RXON_FILTER_ACCEPT_GRP_MSK __constant_cpu_to_le32(1 << 2)
554
/* don't decrypt uni-cast frames */
555
#define RXON_FILTER_DIS_DECRYPT_MSK __constant_cpu_to_le32(1 << 3)
556
/* don't decrypt multi-cast frames */
557
#define RXON_FILTER_DIS_GRP_DECRYPT_MSK __constant_cpu_to_le32(1 << 4)
558
/* STA is associated */
559
#define RXON_FILTER_ASSOC_MSK __constant_cpu_to_le32(1 << 5)
560
/* transfer to host non bssid beacons in associated state */
561
#define RXON_FILTER_BCON_AWARE_MSK __constant_cpu_to_le32(1 << 6)
564
* REPLY_RXON = 0x10 (command, has simple generic response)
566
* RXON tunes the radio tuner to a service channel, and sets up a number
567
* of parameters that are used primarily for Rx, but also for Tx operations.
569
* NOTE: When tuning to a new channel, driver must set the
570
* RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent
571
* info within the device, including the station tables, tx retry
572
* rate tables, and txpower tables. Driver must build a new station
573
* table and txpower table before transmitting anything on the RXON
576
* NOTE: All RXONs wipe clean the internal txpower table. Driver must
577
* issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
578
* regardless of whether RXON_FILTER_ASSOC_MSK is set.
580
struct iwl4965_rxon_cmd {
585
u8 wlap_bssid_addr[6];
596
u8 ofdm_ht_single_stream_basic_rates;
597
u8 ofdm_ht_dual_stream_basic_rates;
598
} __attribute__ ((packed));
601
* REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
603
struct iwl4965_rxon_assoc_cmd {
608
u8 ofdm_ht_single_stream_basic_rates;
609
u8 ofdm_ht_dual_stream_basic_rates;
610
__le16 rx_chain_select_flags;
612
} __attribute__ ((packed));
615
* REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
617
struct iwl4965_rxon_time_cmd {
619
__le16 beacon_interval;
621
__le32 beacon_init_val;
622
__le16 listen_interval;
624
} __attribute__ ((packed));
627
* REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
629
struct iwl4965_channel_switch_cmd {
634
__le32 rxon_filter_flags;
636
struct iwl4965_tx_power_db tx_power;
637
} __attribute__ ((packed));
640
* CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
642
struct iwl4965_csa_notification {
645
__le32 status; /* 0 - OK, 1 - fail */
646
} __attribute__ ((packed));
648
/******************************************************************************
650
* Quality-of-Service (QOS) Commands & Responses:
652
*****************************************************************************/
655
* struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
656
* One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
658
* @cw_min: Contention window, start value in numbers of slots.
659
* Should be a power-of-2, minus 1. Device's default is 0x0f.
660
* @cw_max: Contention window, max value in numbers of slots.
661
* Should be a power-of-2, minus 1. Device's default is 0x3f.
662
* @aifsn: Number of slots in Arbitration Interframe Space (before
663
* performing random backoff timing prior to Tx). Device default 1.
664
* @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
666
* Device will automatically increase contention window by (2*CW) + 1 for each
667
* transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
668
* value, to cap the CW value.
670
struct iwl4965_ac_qos {
676
} __attribute__ ((packed));
678
/* QoS flags defines */
679
#define QOS_PARAM_FLG_UPDATE_EDCA_MSK __constant_cpu_to_le32(0x01)
680
#define QOS_PARAM_FLG_TGN_MSK __constant_cpu_to_le32(0x02)
681
#define QOS_PARAM_FLG_TXOP_TYPE_MSK __constant_cpu_to_le32(0x10)
683
/* Number of Access Categories (AC) (EDCA), queues 0..3 */
687
* REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
689
* This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
690
* 0: Background, 1: Best Effort, 2: Video, 3: Voice.
692
struct iwl4965_qosparam_cmd {
694
struct iwl4965_ac_qos ac[AC_NUM];
695
} __attribute__ ((packed));
697
/******************************************************************************
699
* Add/Modify Stations Commands & Responses:
701
*****************************************************************************/
703
* Multi station support
706
/* Special, dedicated locations within device's station table */
708
#define IWL_MULTICAST_ID 1
710
#define IWL4965_BROADCAST_ID 31
711
#define IWL4965_STATION_COUNT 32
713
#define IWL_STATION_COUNT 32 /* MAX(3945,4965)*/
714
#define IWL_INVALID_STATION 255
716
#define STA_FLG_PWR_SAVE_MSK __constant_cpu_to_le32(1<<8);
717
#define STA_FLG_RTS_MIMO_PROT_MSK __constant_cpu_to_le32(1 << 17)
718
#define STA_FLG_AGG_MPDU_8US_MSK __constant_cpu_to_le32(1 << 18)
719
#define STA_FLG_MAX_AGG_SIZE_POS (19)
720
#define STA_FLG_MAX_AGG_SIZE_MSK __constant_cpu_to_le32(3 << 19)
721
#define STA_FLG_FAT_EN_MSK __constant_cpu_to_le32(1 << 21)
722
#define STA_FLG_MIMO_DIS_MSK __constant_cpu_to_le32(1 << 22)
723
#define STA_FLG_AGG_MPDU_DENSITY_POS (23)
724
#define STA_FLG_AGG_MPDU_DENSITY_MSK __constant_cpu_to_le32(7 << 23)
726
/* Use in mode field. 1: modify existing entry, 0: add new station entry */
727
#define STA_CONTROL_MODIFY_MSK 0x01
729
/* key flags __le16*/
730
#define STA_KEY_FLG_ENCRYPT_MSK __constant_cpu_to_le16(0x7)
731
#define STA_KEY_FLG_NO_ENC __constant_cpu_to_le16(0x0)
732
#define STA_KEY_FLG_WEP __constant_cpu_to_le16(0x1)
733
#define STA_KEY_FLG_CCMP __constant_cpu_to_le16(0x2)
734
#define STA_KEY_FLG_TKIP __constant_cpu_to_le16(0x3)
736
#define STA_KEY_FLG_KEYID_POS 8
737
#define STA_KEY_FLG_INVALID __constant_cpu_to_le16(0x0800)
739
/* Flags indicate whether to modify vs. don't change various station params */
740
#define STA_MODIFY_KEY_MASK 0x01
741
#define STA_MODIFY_TID_DISABLE_TX 0x02
742
#define STA_MODIFY_TX_RATE_MSK 0x04
743
#define STA_MODIFY_ADDBA_TID_MSK 0x08
744
#define STA_MODIFY_DELBA_TID_MSK 0x10
746
/* Receiver address (actually, Rx station's index into station table),
747
* combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
748
#define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid))
750
struct iwl4965_keyinfo {
752
u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
754
__le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
756
u8 key[16]; /* 16-byte unicast decryption key */
757
} __attribute__ ((packed));
760
* struct sta_id_modify
761
* @addr[ETH_ALEN]: station's MAC address
762
* @sta_id: index of station in uCode's station table
763
* @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
765
* Driver selects unused table index when adding new station,
766
* or the index to a pre-existing station entry when modifying that station.
767
* Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
769
* modify_mask flags select which parameters to modify vs. leave alone.
771
struct sta_id_modify {
777
} __attribute__ ((packed));
780
* REPLY_ADD_STA = 0x18 (command)
782
* The device contains an internal table of per-station information,
783
* with info on security keys, aggregation parameters, and Tx rates for
784
* initial Tx attempt and any retries (4965 uses REPLY_TX_LINK_QUALITY_CMD,
785
* 3945 uses REPLY_RATE_SCALE to set up rate tables).
787
* REPLY_ADD_STA sets up the table entry for one station, either creating
788
* a new entry, or modifying a pre-existing one.
790
* NOTE: RXON command (without "associated" bit set) wipes the station table
791
* clean. Moving into RF_KILL state does this also. Driver must set up
792
* new station table before transmitting anything on the RXON channel
793
* (except active scans or active measurements; those commands carry
794
* their own txpower/rate setup data).
796
* When getting started on a new channel, driver must set up the
797
* IWL_BROADCAST_ID entry (last entry in the table). For a client
798
* station in a BSS, once an AP is selected, driver sets up the AP STA
799
* in the IWL_AP_ID entry (1st entry in the table). BROADCAST and AP
800
* are all that are needed for a BSS client station. If the device is
801
* used as AP, or in an IBSS network, driver must set up station table
802
* entries for all STAs in network, starting with index IWL_STA_ID.
804
struct iwl4965_addsta_cmd {
805
u8 mode; /* 1: modify existing, 0: add new station */
807
struct sta_id_modify sta;
808
struct iwl4965_keyinfo key;
809
__le32 station_flags; /* STA_FLG_* */
810
__le32 station_flags_msk; /* STA_FLG_* */
812
/* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
813
* corresponding to bit (e.g. bit 5 controls TID 5).
814
* Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
815
__le16 tid_disable_tx;
819
/* TID for which to add block-ack support.
820
* Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
821
u8 add_immediate_ba_tid;
823
/* TID for which to remove block-ack support.
824
* Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
825
u8 remove_immediate_ba_tid;
827
/* Starting Sequence Number for added block-ack support.
828
* Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
829
__le16 add_immediate_ba_ssn;
832
} __attribute__ ((packed));
834
#define ADD_STA_SUCCESS_MSK 0x1
835
#define ADD_STA_NO_ROOM_IN_TABLE 0x2
836
#define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4
837
#define ADD_STA_MODIFY_NON_EXIST_STA 0x8
839
* REPLY_ADD_STA = 0x18 (response)
841
struct iwl4965_add_sta_resp {
842
u8 status; /* ADD_STA_* */
843
} __attribute__ ((packed));
846
/******************************************************************************
850
*****************************************************************************/
852
struct iwl4965_rx_frame_stats {
860
} __attribute__ ((packed));
862
struct iwl4965_rx_frame_hdr {
869
} __attribute__ ((packed));
871
#define RX_RES_STATUS_NO_CRC32_ERROR __constant_cpu_to_le32(1 << 0)
872
#define RX_RES_STATUS_NO_RXE_OVERFLOW __constant_cpu_to_le32(1 << 1)
874
#define RX_RES_PHY_FLAGS_BAND_24_MSK __constant_cpu_to_le16(1 << 0)
875
#define RX_RES_PHY_FLAGS_MOD_CCK_MSK __constant_cpu_to_le16(1 << 1)
876
#define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK __constant_cpu_to_le16(1 << 2)
877
#define RX_RES_PHY_FLAGS_NARROW_BAND_MSK __constant_cpu_to_le16(1 << 3)
878
#define RX_RES_PHY_FLAGS_ANTENNA_MSK __constant_cpu_to_le16(0xf0)
880
#define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)
881
#define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)
882
#define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)
883
#define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)
884
#define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)
886
#define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)
887
#define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)
888
#define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)
889
#define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)
890
#define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)
892
struct iwl4965_rx_frame_end {
895
__le32 beacon_timestamp;
896
} __attribute__ ((packed));
899
* REPLY_3945_RX = 0x1b (response only, not a command)
901
* NOTE: DO NOT dereference from casts to this structure
902
* It is provided only for calculating minimum data set size.
903
* The actual offsets of the hdr and end are dynamic based on
906
struct iwl4965_rx_frame {
907
struct iwl4965_rx_frame_stats stats;
908
struct iwl4965_rx_frame_hdr hdr;
909
struct iwl4965_rx_frame_end end;
910
} __attribute__ ((packed));
912
/* Fixed (non-configurable) rx data from phy */
913
#define RX_PHY_FLAGS_ANTENNAE_OFFSET (4)
914
#define RX_PHY_FLAGS_ANTENNAE_MASK (0x70)
915
#define IWL_AGC_DB_MASK (0x3f80) /* MASK(7,13) */
916
#define IWL_AGC_DB_POS (7)
917
struct iwl4965_rx_non_cfg_phy {
918
__le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */
919
__le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */
920
u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */
922
} __attribute__ ((packed));
925
* REPLY_4965_RX = 0xc3 (response only, not a command)
926
* Used only for legacy (non 11n) frames.
928
#define RX_RES_PHY_CNT 14
929
struct iwl4965_rx_phy_res {
930
u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */
931
u8 cfg_phy_cnt; /* configurable DSP phy data byte count */
932
u8 stat_id; /* configurable DSP phy data set ID */
934
__le64 timestamp; /* TSF at on air rise */
935
__le32 beacon_time_stamp; /* beacon at on-air rise */
936
__le16 phy_flags; /* general phy flags: band, modulation, ... */
937
__le16 channel; /* channel number */
938
__le16 non_cfg_phy[RX_RES_PHY_CNT]; /* upto 14 phy entries */
940
__le32 rate_n_flags; /* RATE_MCS_* */
941
__le16 byte_count; /* frame's byte-count */
943
} __attribute__ ((packed));
945
struct iwl4965_rx_mpdu_res_start {
948
} __attribute__ ((packed));
951
/******************************************************************************
953
* Tx Commands & Responses:
955
* Driver must place each REPLY_TX command into one of the prioritized Tx
956
* queues in host DRAM, shared between driver and device (see comments for
957
* SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode
958
* are preparing to transmit, the device pulls the Tx command over the PCI
959
* bus via one of the device's Tx DMA channels, to fill an internal FIFO
960
* from which data will be transmitted.
962
* uCode handles all timing and protocol related to control frames
963
* (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler
964
* handle reception of block-acks; uCode updates the host driver via
965
* REPLY_COMPRESSED_BA (4965).
967
* uCode handles retrying Tx when an ACK is expected but not received.
968
* This includes trying lower data rates than the one requested in the Tx
969
* command, as set up by the REPLY_RATE_SCALE (for 3945) or
970
* REPLY_TX_LINK_QUALITY_CMD (4965).
972
* Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
973
* This command must be executed after every RXON command, before Tx can occur.
974
*****************************************************************************/
976
/* REPLY_TX Tx flags field */
978
/* 1: Use Request-To-Send protocol before this frame.
979
* Mutually exclusive vs. TX_CMD_FLG_CTS_MSK. */
980
#define TX_CMD_FLG_RTS_MSK __constant_cpu_to_le32(1 << 1)
982
/* 1: Transmit Clear-To-Send to self before this frame.
983
* Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
984
* Mutually exclusive vs. TX_CMD_FLG_RTS_MSK. */
985
#define TX_CMD_FLG_CTS_MSK __constant_cpu_to_le32(1 << 2)
987
/* 1: Expect ACK from receiving station
988
* 0: Don't expect ACK (MAC header's duration field s/b 0)
989
* Set this for unicast frames, but not broadcast/multicast. */
990
#define TX_CMD_FLG_ACK_MSK __constant_cpu_to_le32(1 << 3)
993
* 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
994
* Tx command's initial_rate_index indicates first rate to try;
995
* uCode walks through table for additional Tx attempts.
996
* 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
997
* This rate will be used for all Tx attempts; it will not be scaled. */
998
#define TX_CMD_FLG_STA_RATE_MSK __constant_cpu_to_le32(1 << 4)
1000
/* 1: Expect immediate block-ack.
1001
* Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */
1002
#define TX_CMD_FLG_IMM_BA_RSP_MASK __constant_cpu_to_le32(1 << 6)
1004
/* 1: Frame requires full Tx-Op protection.
1005
* Set this if either RTS or CTS Tx Flag gets set. */
1006
#define TX_CMD_FLG_FULL_TXOP_PROT_MSK __constant_cpu_to_le32(1 << 7)
1008
/* Tx antenna selection field; used only for 3945, reserved (0) for 4965.
1009
* Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
1010
#define TX_CMD_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0xf00)
1011
#define TX_CMD_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8)
1012
#define TX_CMD_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9)
1014
/* 1: Ignore Bluetooth priority for this frame.
1015
* 0: Delay Tx until Bluetooth device is done (normal usage). */
1016
#define TX_CMD_FLG_BT_DIS_MSK __constant_cpu_to_le32(1 << 12)
1018
/* 1: uCode overrides sequence control field in MAC header.
1019
* 0: Driver provides sequence control field in MAC header.
1020
* Set this for management frames, non-QOS data frames, non-unicast frames,
1021
* and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
1022
#define TX_CMD_FLG_SEQ_CTL_MSK __constant_cpu_to_le32(1 << 13)
1024
/* 1: This frame is non-last MPDU; more fragments are coming.
1025
* 0: Last fragment, or not using fragmentation. */
1026
#define TX_CMD_FLG_MORE_FRAG_MSK __constant_cpu_to_le32(1 << 14)
1028
/* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
1029
* 0: No TSF required in outgoing frame.
1030
* Set this for transmitting beacons and probe responses. */
1031
#define TX_CMD_FLG_TSF_MSK __constant_cpu_to_le32(1 << 16)
1033
/* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
1034
* alignment of frame's payload data field.
1036
* Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
1037
* field (but not both). Driver must align frame data (i.e. data following
1038
* MAC header) to DWORD boundary. */
1039
#define TX_CMD_FLG_MH_PAD_MSK __constant_cpu_to_le32(1 << 20)
1041
/* HCCA-AP - disable duration overwriting. */
1042
#define TX_CMD_FLG_DUR_MSK __constant_cpu_to_le32(1 << 25)
1046
* TX command security control
1048
#define TX_CMD_SEC_WEP 0x01
1049
#define TX_CMD_SEC_CCM 0x02
1050
#define TX_CMD_SEC_TKIP 0x03
1051
#define TX_CMD_SEC_MSK 0x03
1052
#define TX_CMD_SEC_SHIFT 6
1053
#define TX_CMD_SEC_KEY128 0x08
1056
* 4965 uCode updates these Tx attempt count values in host DRAM.
1057
* Used for managing Tx retries when expecting block-acks.
1058
* Driver should set these fields to 0.
1060
struct iwl4965_dram_scratch {
1061
u8 try_cnt; /* Tx attempts */
1062
u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */
1064
} __attribute__ ((packed));
1067
* REPLY_TX = 0x1c (command)
1069
struct iwl4965_tx_cmd {
1072
* MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
1073
* + 8 byte IV for CCM or TKIP (not used for WEP)
1075
* + 8-byte MIC (not used for CCM/WEP)
1076
* NOTE: Does not include Tx command bytes, post-MAC pad bytes,
1077
* MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
1078
* Range: 14-2342 bytes.
1083
* MPDU or MSDU byte count for next frame.
1084
* Used for fragmentation and bursting, but not 11n aggregation.
1085
* Same as "len", but for next frame. Set to 0 if not applicable.
1087
__le16 next_frame_len;
1089
__le32 tx_flags; /* TX_CMD_FLG_* */
1091
/* 4965's uCode may modify this field of the Tx command (in host DRAM!).
1092
* Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
1093
struct iwl4965_dram_scratch scratch;
1095
/* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
1096
__le32 rate_n_flags; /* RATE_MCS_* */
1098
/* Index of destination station in uCode's station table */
1101
/* Type of security encryption: CCM or TKIP */
1102
u8 sec_ctl; /* TX_CMD_SEC_* */
1105
* Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial
1106
* Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for
1107
* data frames, this field may be used to selectively reduce initial
1108
* rate (via non-0 value) for special frames (e.g. management), while
1109
* still supporting rate scaling for all frames.
1111
u8 initial_rate_index;
1114
__le16 next_frame_flags;
1121
/* Host DRAM physical address pointer to "scratch" in this command.
1122
* Must be dword aligned. "0" in dram_lsb_ptr disables usage. */
1123
__le32 dram_lsb_ptr;
1126
u8 rts_retry_limit; /*byte 50 */
1127
u8 data_retry_limit; /*byte 51 */
1130
__le16 pm_frame_timeout;
1131
__le16 attempt_duration;
1135
* Duration of EDCA burst Tx Opportunity, in 32-usec units.
1136
* Set this if txop time is not specified by HCCA protocol (e.g. by AP).
1141
* MAC header goes here, followed by 2 bytes padding if MAC header
1142
* length is 26 or 30 bytes, followed by payload data
1145
struct ieee80211_hdr hdr[0];
1146
} __attribute__ ((packed));
1148
/* TX command response is sent after *all* transmission attempts.
1152
* TX_STATUS_FAIL_NEXT_FRAG
1154
* If the fragment flag in the MAC header for the frame being transmitted
1155
* is set and there is insufficient time to transmit the next frame, the
1156
* TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
1158
* TX_STATUS_FIFO_UNDERRUN
1160
* Indicates the host did not provide bytes to the FIFO fast enough while
1161
* a TX was in progress.
1163
* TX_STATUS_FAIL_MGMNT_ABORT
1165
* This status is only possible if the ABORT ON MGMT RX parameter was
1166
* set to true with the TX command.
1168
* If the MSB of the status parameter is set then an abort sequence is
1169
* required. This sequence consists of the host activating the TX Abort
1170
* control line, and then waiting for the TX Abort command response. This
1171
* indicates that a the device is no longer in a transmit state, and that the
1172
* command FIFO has been cleared. The host must then deactivate the TX Abort
1173
* control line. Receiving is still allowed in this case.
1176
TX_STATUS_SUCCESS = 0x01,
1177
TX_STATUS_DIRECT_DONE = 0x02,
1178
TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
1179
TX_STATUS_FAIL_LONG_LIMIT = 0x83,
1180
TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
1181
TX_STATUS_FAIL_MGMNT_ABORT = 0x85,
1182
TX_STATUS_FAIL_NEXT_FRAG = 0x86,
1183
TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
1184
TX_STATUS_FAIL_DEST_PS = 0x88,
1185
TX_STATUS_FAIL_ABORTED = 0x89,
1186
TX_STATUS_FAIL_BT_RETRY = 0x8a,
1187
TX_STATUS_FAIL_STA_INVALID = 0x8b,
1188
TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
1189
TX_STATUS_FAIL_TID_DISABLE = 0x8d,
1190
TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
1191
TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
1192
TX_STATUS_FAIL_TX_LOCKED = 0x90,
1193
TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
1196
#define TX_PACKET_MODE_REGULAR 0x0000
1197
#define TX_PACKET_MODE_BURST_SEQ 0x0100
1198
#define TX_PACKET_MODE_BURST_FIRST 0x0200
1201
TX_POWER_PA_NOT_ACTIVE = 0x0,
1205
TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */
1206
TX_STATUS_DELAY_MSK = 0x00000040,
1207
TX_STATUS_ABORT_MSK = 0x00000080,
1208
TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */
1209
TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */
1210
TX_RESERVED = 0x00780000, /* bits 19:22 */
1211
TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */
1212
TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */
1215
/* *******************************
1216
* TX aggregation status
1217
******************************* */
1220
AGG_TX_STATE_TRANSMITTED = 0x00,
1221
AGG_TX_STATE_UNDERRUN_MSK = 0x01,
1222
AGG_TX_STATE_BT_PRIO_MSK = 0x02,
1223
AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
1224
AGG_TX_STATE_ABORT_MSK = 0x08,
1225
AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
1226
AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
1227
AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
1228
AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
1229
AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
1230
AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
1231
AGG_TX_STATE_DUMP_TX_MSK = 0x200,
1232
AGG_TX_STATE_DELAY_TX_MSK = 0x400
1235
#define AGG_TX_STATE_LAST_SENT_MSK \
1236
(AGG_TX_STATE_LAST_SENT_TTL_MSK | \
1237
AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
1238
AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
1240
/* # tx attempts for first frame in aggregation */
1241
#define AGG_TX_STATE_TRY_CNT_POS 12
1242
#define AGG_TX_STATE_TRY_CNT_MSK 0xf000
1244
/* Command ID and sequence number of Tx command for this frame */
1245
#define AGG_TX_STATE_SEQ_NUM_POS 16
1246
#define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
1249
* REPLY_TX = 0x1c (response)
1251
* This response may be in one of two slightly different formats, indicated
1252
* by the frame_count field:
1254
* 1) No aggregation (frame_count == 1). This reports Tx results for
1255
* a single frame. Multiple attempts, at various bit rates, may have
1256
* been made for this frame.
1258
* 2) Aggregation (frame_count > 1). This reports Tx results for
1259
* 2 or more frames that used block-acknowledge. All frames were
1260
* transmitted at same rate. Rate scaling may have been used if first
1261
* frame in this new agg block failed in previous agg block(s).
1263
* Note that, for aggregation, ACK (block-ack) status is not delivered here;
1264
* block-ack has not been received by the time the 4965 records this status.
1265
* This status relates to reasons the tx might have been blocked or aborted
1266
* within the sending station (this 4965), rather than whether it was
1267
* received successfully by the destination station.
1269
struct iwl4965_tx_resp {
1270
u8 frame_count; /* 1 no aggregation, >1 aggregation */
1271
u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
1272
u8 failure_rts; /* # failures due to unsuccessful RTS */
1273
u8 failure_frame; /* # failures due to no ACK (unused for agg) */
1275
/* For non-agg: Rate at which frame was successful.
1276
* For agg: Rate at which all frames were transmitted. */
1277
__le32 rate_n_flags; /* RATE_MCS_* */
1279
/* For non-agg: RTS + CTS + frame tx attempts time + ACK.
1280
* For agg: RTS + CTS + aggregation tx time + block-ack time. */
1281
__le16 wireless_media_time; /* uSecs */
1284
__le32 pa_power1; /* RF power amplifier measurement (not used) */
1288
* For non-agg: frame status TX_STATUS_*
1289
* For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
1290
* fields follow this one, up to frame_count.
1292
* 11- 0: AGG_TX_STATE_* status code
1293
* 15-12: Retry count for 1st frame in aggregation (retries
1294
* occur if tx failed for this frame when it was a
1295
* member of a previous aggregation block). If rate
1296
* scaling is used, retry count indicates the rate
1297
* table entry used for all frames in the new agg.
1298
* 31-16: Sequence # for this frame's Tx cmd (not SSN!)
1300
__le32 status; /* TX status (for aggregation status of 1st frame) */
1301
} __attribute__ ((packed));
1304
* REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
1306
* Reports Block-Acknowledge from recipient station
1308
struct iwl4965_compressed_ba_resp {
1309
__le32 sta_addr_lo32;
1310
__le16 sta_addr_hi16;
1313
/* Index of recipient (BA-sending) station in uCode's station table */
1321
} __attribute__ ((packed));
1324
* REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
1326
* See details under "TXPOWER" in iwl-4965-hw.h.
1328
struct iwl4965_txpowertable_cmd {
1329
u8 band; /* 0: 5 GHz, 1: 2.4 GHz */
1332
struct iwl4965_tx_power_db tx_power;
1333
} __attribute__ ((packed));
1335
/*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
1336
#define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1<<0)
1338
/* # of EDCA prioritized tx fifos */
1339
#define LINK_QUAL_AC_NUM AC_NUM
1341
/* # entries in rate scale table to support Tx retries */
1342
#define LINK_QUAL_MAX_RETRY_NUM 16
1344
/* Tx antenna selection values */
1345
#define LINK_QUAL_ANT_A_MSK (1<<0)
1346
#define LINK_QUAL_ANT_B_MSK (1<<1)
1347
#define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
1351
* struct iwl4965_link_qual_general_params
1353
* Used in REPLY_TX_LINK_QUALITY_CMD
1355
struct iwl4965_link_qual_general_params {
1358
/* No entries at or above this (driver chosen) index contain MIMO */
1361
/* Best single antenna to use for single stream (legacy, SISO). */
1362
u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */
1364
/* Best antennas to use for MIMO (unused for 4965, assumes both). */
1365
u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */
1368
* If driver needs to use different initial rates for different
1369
* EDCA QOS access categories (as implemented by tx fifos 0-3),
1370
* this table will set that up, by indicating the indexes in the
1371
* rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
1372
* Otherwise, driver should set all entries to 0.
1375
* 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
1376
* TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
1378
u8 start_rate_index[LINK_QUAL_AC_NUM];
1379
} __attribute__ ((packed));
1382
* struct iwl4965_link_qual_agg_params
1384
* Used in REPLY_TX_LINK_QUALITY_CMD
1386
struct iwl4965_link_qual_agg_params {
1388
/* Maximum number of uSec in aggregation.
1389
* Driver should set this to 4000 (4 milliseconds). */
1390
__le16 agg_time_limit;
1393
* Number of Tx retries allowed for a frame, before that frame will
1394
* no longer be considered for the start of an aggregation sequence
1395
* (scheduler will then try to tx it as single frame).
1396
* Driver should set this to 3.
1398
u8 agg_dis_start_th;
1401
* Maximum number of frames in aggregation.
1402
* 0 = no limit (default). 1 = no aggregation.
1403
* Other values = max # frames in aggregation.
1405
u8 agg_frame_cnt_limit;
1408
} __attribute__ ((packed));
1411
* REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
1413
* For 4965 only; 3945 uses REPLY_RATE_SCALE.
1415
* Each station in the 4965's internal station table has its own table of 16
1416
* Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
1417
* an ACK is not received. This command replaces the entire table for
1420
* NOTE: Station must already be in 4965's station table. Use REPLY_ADD_STA.
1422
* The rate scaling procedures described below work well. Of course, other
1423
* procedures are possible, and may work better for particular environments.
1426
* FILLING THE RATE TABLE
1428
* Given a particular initial rate and mode, as determined by the rate
1429
* scaling algorithm described below, the Linux driver uses the following
1430
* formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
1431
* Link Quality command:
1434
* 1) If using High-throughput (HT) (SISO or MIMO) initial rate:
1435
* a) Use this same initial rate for first 3 entries.
1436
* b) Find next lower available rate using same mode (SISO or MIMO),
1437
* use for next 3 entries. If no lower rate available, switch to
1438
* legacy mode (no FAT channel, no MIMO, no short guard interval).
1439
* c) If using MIMO, set command's mimo_delimiter to number of entries
1440
* using MIMO (3 or 6).
1441
* d) After trying 2 HT rates, switch to legacy mode (no FAT channel,
1442
* no MIMO, no short guard interval), at the next lower bit rate
1443
* (e.g. if second HT bit rate was 54, try 48 legacy), and follow
1444
* legacy procedure for remaining table entries.
1446
* 2) If using legacy initial rate:
1447
* a) Use the initial rate for only one entry.
1448
* b) For each following entry, reduce the rate to next lower available
1449
* rate, until reaching the lowest available rate.
1450
* c) When reducing rate, also switch antenna selection.
1451
* d) Once lowest available rate is reached, repeat this rate until
1452
* rate table is filled (16 entries), switching antenna each entry.
1455
* ACCUMULATING HISTORY
1457
* The rate scaling algorithm for 4965, as implemented in Linux driver, uses
1458
* two sets of frame Tx success history: One for the current/active modulation
1459
* mode, and one for a speculative/search mode that is being attempted. If the
1460
* speculative mode turns out to be more effective (i.e. actual transfer
1461
* rate is better), then the driver continues to use the speculative mode
1462
* as the new current active mode.
1464
* Each history set contains, separately for each possible rate, data for a
1465
* sliding window of the 62 most recent tx attempts at that rate. The data
1466
* includes a shifting bitmap of success(1)/failure(0), and sums of successful
1467
* and attempted frames, from which the driver can additionally calculate a
1468
* success ratio (success / attempted) and number of failures
1469
* (attempted - success), and control the size of the window (attempted).
1470
* The driver uses the bit map to remove successes from the success sum, as
1471
* the oldest tx attempts fall out of the window.
1473
* When the 4965 makes multiple tx attempts for a given frame, each attempt
1474
* might be at a different rate, and have different modulation characteristics
1475
* (e.g. antenna, fat channel, short guard interval), as set up in the rate
1476
* scaling table in the Link Quality command. The driver must determine
1477
* which rate table entry was used for each tx attempt, to determine which
1478
* rate-specific history to update, and record only those attempts that
1479
* match the modulation characteristics of the history set.
1481
* When using block-ack (aggregation), all frames are transmitted at the same
1482
* rate, since there is no per-attempt acknowledgement from the destination
1483
* station. The Tx response struct iwl_tx_resp indicates the Tx rate in
1484
* rate_n_flags field. After receiving a block-ack, the driver can update
1485
* history for the entire block all at once.
1488
* FINDING BEST STARTING RATE:
1490
* When working with a selected initial modulation mode (see below), the
1491
* driver attempts to find a best initial rate. The initial rate is the
1492
* first entry in the Link Quality command's rate table.
1494
* 1) Calculate actual throughput (success ratio * expected throughput, see
1495
* table below) for current initial rate. Do this only if enough frames
1496
* have been attempted to make the value meaningful: at least 6 failed
1497
* tx attempts, or at least 8 successes. If not enough, don't try rate
1500
* 2) Find available rates adjacent to current initial rate. Available means:
1501
* a) supported by hardware &&
1502
* b) supported by association &&
1503
* c) within any constraints selected by user
1505
* 3) Gather measured throughputs for adjacent rates. These might not have
1506
* enough history to calculate a throughput. That's okay, we might try
1507
* using one of them anyway!
1509
* 4) Try decreasing rate if, for current rate:
1510
* a) success ratio is < 15% ||
1511
* b) lower adjacent rate has better measured throughput ||
1512
* c) higher adjacent rate has worse throughput, and lower is unmeasured
1514
* As a sanity check, if decrease was determined above, leave rate
1516
* a) lower rate unavailable
1517
* b) success ratio at current rate > 85% (very good)
1518
* c) current measured throughput is better than expected throughput
1519
* of lower rate (under perfect 100% tx conditions, see table below)
1521
* 5) Try increasing rate if, for current rate:
1522
* a) success ratio is < 15% ||
1523
* b) both adjacent rates' throughputs are unmeasured (try it!) ||
1524
* b) higher adjacent rate has better measured throughput ||
1525
* c) lower adjacent rate has worse throughput, and higher is unmeasured
1527
* As a sanity check, if increase was determined above, leave rate
1529
* a) success ratio at current rate < 70%. This is not particularly
1530
* good performance; higher rate is sure to have poorer success.
1532
* 6) Re-evaluate the rate after each tx frame. If working with block-
1533
* acknowledge, history and statistics may be calculated for the entire
1534
* block (including prior history that fits within the history windows),
1535
* before re-evaluation.
1537
* FINDING BEST STARTING MODULATION MODE:
1539
* After working with a modulation mode for a "while" (and doing rate scaling),
1540
* the driver searches for a new initial mode in an attempt to improve
1541
* throughput. The "while" is measured by numbers of attempted frames:
1543
* For legacy mode, search for new mode after:
1544
* 480 successful frames, or 160 failed frames
1545
* For high-throughput modes (SISO or MIMO), search for new mode after:
1546
* 4500 successful frames, or 400 failed frames
1548
* Mode switch possibilities are (3 for each mode):
1551
* Change antenna, try SISO (if HT association), try MIMO (if HT association)
1553
* Change antenna, try MIMO, try shortened guard interval (SGI)
1555
* Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)
1557
* When trying a new mode, use the same bit rate as the old/current mode when
1558
* trying antenna switches and shortened guard interval. When switching to
1559
* SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate
1560
* for which the expected throughput (under perfect conditions) is about the
1561
* same or slightly better than the actual measured throughput delivered by
1562
* the old/current mode.
1564
* Actual throughput can be estimated by multiplying the expected throughput
1565
* by the success ratio (successful / attempted tx frames). Frame size is
1566
* not considered in this calculation; it assumes that frame size will average
1567
* out to be fairly consistent over several samples. The following are
1568
* metric values for expected throughput assuming 100% success ratio.
1569
* Only G band has support for CCK rates:
1571
* RATE: 1 2 5 11 6 9 12 18 24 36 48 54 60
1573
* G: 7 13 35 58 40 57 72 98 121 154 177 186 186
1574
* A: 0 0 0 0 40 57 72 98 121 154 177 186 186
1575
* SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 202
1576
* SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 211
1577
* MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 251
1578
* SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 257
1579
* SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 257
1580
* SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 264
1581
* MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 289
1582
* SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 293
1584
* After the new mode has been tried for a short while (minimum of 6 failed
1585
* frames or 8 successful frames), compare success ratio and actual throughput
1586
* estimate of the new mode with the old. If either is better with the new
1587
* mode, continue to use the new mode.
1589
* Continue comparing modes until all 3 possibilities have been tried.
1590
* If moving from legacy to HT, try all 3 possibilities from the new HT
1591
* mode. After trying all 3, a best mode is found. Continue to use this mode
1592
* for the longer "while" described above (e.g. 480 successful frames for
1593
* legacy), and then repeat the search process.
1596
struct iwl4965_link_quality_cmd {
1598
/* Index of destination/recipient station in uCode's station table */
1601
__le16 control; /* not used */
1602
struct iwl4965_link_qual_general_params general_params;
1603
struct iwl4965_link_qual_agg_params agg_params;
1606
* Rate info; when using rate-scaling, Tx command's initial_rate_index
1607
* specifies 1st Tx rate attempted, via index into this table.
1608
* 4965 works its way through table when retrying Tx.
1611
__le32 rate_n_flags; /* RATE_MCS_*, IWL_RATE_* */
1612
} rs_table[LINK_QUAL_MAX_RETRY_NUM];
1614
} __attribute__ ((packed));
1617
* REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
1619
* 3945 and 4965 support hardware handshake with Bluetooth device on
1620
* same platform. Bluetooth device alerts wireless device when it will Tx;
1621
* wireless device can delay or kill its own Tx to accomodate.
1623
struct iwl4965_bt_cmd {
1628
__le32 kill_ack_mask;
1629
__le32 kill_cts_mask;
1630
} __attribute__ ((packed));
1632
/******************************************************************************
1634
* Spectrum Management (802.11h) Commands, Responses, Notifications:
1636
*****************************************************************************/
1639
* Spectrum Management
1641
#define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \
1642
RXON_FILTER_CTL2HOST_MSK | \
1643
RXON_FILTER_ACCEPT_GRP_MSK | \
1644
RXON_FILTER_DIS_DECRYPT_MSK | \
1645
RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
1646
RXON_FILTER_ASSOC_MSK | \
1647
RXON_FILTER_BCON_AWARE_MSK)
1649
struct iwl4965_measure_channel {
1650
__le32 duration; /* measurement duration in extended beacon
1652
u8 channel; /* channel to measure */
1653
u8 type; /* see enum iwl4965_measure_type */
1655
} __attribute__ ((packed));
1658
* REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
1660
struct iwl4965_spectrum_cmd {
1661
__le16 len; /* number of bytes starting from token */
1662
u8 token; /* token id */
1663
u8 id; /* measurement id -- 0 or 1 */
1664
u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */
1665
u8 periodic; /* 1 = periodic */
1666
__le16 path_loss_timeout;
1667
__le32 start_time; /* start time in extended beacon format */
1669
__le32 flags; /* rxon flags */
1670
__le32 filter_flags; /* rxon filter flags */
1671
__le16 channel_count; /* minimum 1, maximum 10 */
1673
struct iwl4965_measure_channel channels[10];
1674
} __attribute__ ((packed));
1677
* REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
1679
struct iwl4965_spectrum_resp {
1681
u8 id; /* id of the prior command replaced, or 0xff */
1682
__le16 status; /* 0 - command will be handled
1683
* 1 - cannot handle (conflicts with another
1685
} __attribute__ ((packed));
1687
enum iwl4965_measurement_state {
1688
IWL_MEASUREMENT_START = 0,
1689
IWL_MEASUREMENT_STOP = 1,
1692
enum iwl4965_measurement_status {
1693
IWL_MEASUREMENT_OK = 0,
1694
IWL_MEASUREMENT_CONCURRENT = 1,
1695
IWL_MEASUREMENT_CSA_CONFLICT = 2,
1696
IWL_MEASUREMENT_TGH_CONFLICT = 3,
1698
IWL_MEASUREMENT_STOPPED = 6,
1699
IWL_MEASUREMENT_TIMEOUT = 7,
1700
IWL_MEASUREMENT_PERIODIC_FAILED = 8,
1703
#define NUM_ELEMENTS_IN_HISTOGRAM 8
1705
struct iwl4965_measurement_histogram {
1706
__le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
1707
__le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */
1708
} __attribute__ ((packed));
1710
/* clear channel availability counters */
1711
struct iwl4965_measurement_cca_counters {
1714
} __attribute__ ((packed));
1716
enum iwl4965_measure_type {
1717
IWL_MEASURE_BASIC = (1 << 0),
1718
IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
1719
IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
1720
IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
1721
IWL_MEASURE_FRAME = (1 << 4),
1722
/* bits 5:6 are reserved */
1723
IWL_MEASURE_IDLE = (1 << 7),
1727
* SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
1729
struct iwl4965_spectrum_notification {
1730
u8 id; /* measurement id -- 0 or 1 */
1732
u8 channel_index; /* index in measurement channel list */
1733
u8 state; /* 0 - start, 1 - stop */
1734
__le32 start_time; /* lower 32-bits of TSF */
1735
u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */
1737
u8 type; /* see enum iwl4965_measurement_type */
1739
/* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only
1740
* valid if applicable for measurement type requested. */
1741
__le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */
1742
__le32 cca_cck; /* cca fraction time in 44Mhz clock periods */
1743
__le32 cca_time; /* channel load time in usecs */
1744
u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 -
1747
struct iwl4965_measurement_histogram histogram;
1748
__le32 stop_time; /* lower 32-bits of TSF */
1749
__le32 status; /* see iwl4965_measurement_status */
1750
} __attribute__ ((packed));
1752
/******************************************************************************
1754
* Power Management Commands, Responses, Notifications:
1756
*****************************************************************************/
1759
* struct iwl4965_powertable_cmd - Power Table Command
1760
* @flags: See below:
1762
* POWER_TABLE_CMD = 0x77 (command, has simple generic response)
1765
* bit 0 - '0' Driver not allow power management
1766
* '1' Driver allow PM (use rest of parameters)
1767
* uCode send sleep notifications:
1768
* bit 1 - '0' Don't send sleep notification
1769
* '1' send sleep notification (SEND_PM_NOTIFICATION)
1771
* bit 2 - '0' PM have to walk up every DTIM
1772
* '1' PM could sleep over DTIM till listen Interval.
1774
* bit 3 - '0' (PCI_LINK_CTRL & 0x1)
1775
* '1' !(PCI_LINK_CTRL & 0x1)
1777
* bit 31/30- '00' use both mac/xtal sleeps
1778
* '01' force Mac sleep
1779
* '10' force xtal sleep
1782
* NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
1783
* ucode assume sleep over DTIM is allowed and we don't need to wakeup
1786
#define IWL_POWER_VEC_SIZE 5
1788
#define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK __constant_cpu_to_le16(1<<0)
1789
#define IWL_POWER_SLEEP_OVER_DTIM_MSK __constant_cpu_to_le16(1<<2)
1790
#define IWL_POWER_PCI_PM_MSK __constant_cpu_to_le16(1<<3)
1792
struct iwl4965_powertable_cmd {
1794
u8 keep_alive_seconds;
1796
__le32 rx_data_timeout;
1797
__le32 tx_data_timeout;
1798
__le32 sleep_interval[IWL_POWER_VEC_SIZE];
1799
__le32 keep_alive_beacons;
1800
} __attribute__ ((packed));
1803
* PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
1804
* 3945 and 4965 identical.
1806
struct iwl4965_sleep_notification {
1813
} __attribute__ ((packed));
1815
/* Sleep states. 3945 and 4965 identical. */
1817
IWL_PM_NO_SLEEP = 0,
1819
IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
1820
IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
1822
IWL_PM_SLP_REPENT = 5,
1823
IWL_PM_WAKEUP_BY_TIMER = 6,
1824
IWL_PM_WAKEUP_BY_DRIVER = 7,
1825
IWL_PM_WAKEUP_BY_RFKILL = 8,
1827
IWL_PM_NUM_OF_MODES = 12,
1831
* REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
1833
#define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */
1834
#define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */
1835
#define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */
1836
struct iwl4965_card_state_cmd {
1837
__le32 status; /* CARD_STATE_CMD_* request new power state */
1838
} __attribute__ ((packed));
1841
* CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
1843
struct iwl4965_card_state_notif {
1845
} __attribute__ ((packed));
1847
#define HW_CARD_DISABLED 0x01
1848
#define SW_CARD_DISABLED 0x02
1849
#define RF_CARD_DISABLED 0x04
1850
#define RXON_CARD_DISABLED 0x10
1852
struct iwl4965_ct_kill_config {
1854
__le32 critical_temperature_M;
1855
__le32 critical_temperature_R;
1856
} __attribute__ ((packed));
1858
/******************************************************************************
1860
* Scan Commands, Responses, Notifications:
1862
*****************************************************************************/
1865
* struct iwl4965_scan_channel - entry in REPLY_SCAN_CMD channel table
1867
* One for each channel in the scan list.
1868
* Each channel can independently select:
1869
* 1) SSID for directed active scans
1870
* 2) Txpower setting (for rate specified within Tx command)
1871
* 3) How long to stay on-channel (behavior may be modified by quiet_time,
1872
* quiet_plcp_th, good_CRC_th)
1874
* To avoid uCode errors, make sure the following are true (see comments
1875
* under struct iwl4965_scan_cmd about max_out_time and quiet_time):
1876
* 1) If using passive_dwell (i.e. passive_dwell != 0):
1877
* active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
1878
* 2) quiet_time <= active_dwell
1879
* 3) If restricting off-channel time (i.e. max_out_time !=0):
1880
* passive_dwell < max_out_time
1881
* active_dwell < max_out_time
1883
struct iwl4965_scan_channel {
1885
* type is defined as:
1886
* 0:0 1 = active, 0 = passive
1887
* 1:4 SSID direct bit map; if a bit is set, then corresponding
1888
* SSID IE is transmitted in probe request.
1892
u8 channel; /* band is selected by iwl4965_scan_cmd "flags" field */
1893
struct iwl4965_tx_power tpc;
1894
__le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */
1895
__le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */
1896
} __attribute__ ((packed));
1899
* struct iwl4965_ssid_ie - directed scan network information element
1901
* Up to 4 of these may appear in REPLY_SCAN_CMD, selected by "type" field
1902
* in struct iwl4965_scan_channel; each channel may select different ssids from
1903
* among the 4 entries. SSID IEs get transmitted in reverse order of entry.
1905
struct iwl4965_ssid_ie {
1909
} __attribute__ ((packed));
1911
#define PROBE_OPTION_MAX 0x4
1912
#define TX_CMD_LIFE_TIME_INFINITE __constant_cpu_to_le32(0xFFFFFFFF)
1913
#define IWL_GOOD_CRC_TH __constant_cpu_to_le16(1)
1914
#define IWL_MAX_SCAN_SIZE 1024
1917
* REPLY_SCAN_CMD = 0x80 (command)
1919
* The hardware scan command is very powerful; the driver can set it up to
1920
* maintain (relatively) normal network traffic while doing a scan in the
1921
* background. The max_out_time and suspend_time control the ratio of how
1922
* long the device stays on an associated network channel ("service channel")
1923
* vs. how long it's away from the service channel, i.e. tuned to other channels
1926
* max_out_time is the max time off-channel (in usec), and suspend_time
1927
* is how long (in "extended beacon" format) that the scan is "suspended"
1928
* after returning to the service channel. That is, suspend_time is the
1929
* time that we stay on the service channel, doing normal work, between
1930
* scan segments. The driver may set these parameters differently to support
1931
* scanning when associated vs. not associated, and light vs. heavy traffic
1932
* loads when associated.
1934
* After receiving this command, the device's scan engine does the following;
1936
* 1) Sends SCAN_START notification to driver
1937
* 2) Checks to see if it has time to do scan for one channel
1938
* 3) Sends NULL packet, with power-save (PS) bit set to 1,
1939
* to tell AP that we're going off-channel
1940
* 4) Tunes to first channel in scan list, does active or passive scan
1941
* 5) Sends SCAN_RESULT notification to driver
1942
* 6) Checks to see if it has time to do scan on *next* channel in list
1943
* 7) Repeats 4-6 until it no longer has time to scan the next channel
1944
* before max_out_time expires
1945
* 8) Returns to service channel
1946
* 9) Sends NULL packet with PS=0 to tell AP that we're back
1947
* 10) Stays on service channel until suspend_time expires
1948
* 11) Repeats entire process 2-10 until list is complete
1949
* 12) Sends SCAN_COMPLETE notification
1951
* For fast, efficient scans, the scan command also has support for staying on
1952
* a channel for just a short time, if doing active scanning and getting no
1953
* responses to the transmitted probe request. This time is controlled by
1954
* quiet_time, and the number of received packets below which a channel is
1955
* considered "quiet" is controlled by quiet_plcp_threshold.
1957
* For active scanning on channels that have regulatory restrictions against
1958
* blindly transmitting, the scan can listen before transmitting, to make sure
1959
* that there is already legitimate activity on the channel. If enough
1960
* packets are cleanly received on the channel (controlled by good_CRC_th,
1961
* typical value 1), the scan engine starts transmitting probe requests.
1963
* Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
1965
* To avoid uCode errors, see timing restrictions described under
1966
* struct iwl4965_scan_channel.
1968
struct iwl4965_scan_cmd {
1971
u8 channel_count; /* # channels in channel list */
1972
__le16 quiet_time; /* dwell only this # millisecs on quiet channel
1973
* (only for active scan) */
1974
__le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
1975
__le16 good_CRC_th; /* passive -> active promotion threshold */
1976
__le16 rx_chain; /* RXON_RX_CHAIN_* */
1977
__le32 max_out_time; /* max usec to be away from associated (service)
1979
__le32 suspend_time; /* pause scan this long (in "extended beacon
1980
* format") when returning to service chnl:
1981
* 3945; 31:24 # beacons, 19:0 additional usec,
1982
* 4965; 31:22 # beacons, 21:0 additional usec.
1984
__le32 flags; /* RXON_FLG_* */
1985
__le32 filter_flags; /* RXON_FILTER_* */
1987
/* For active scans (set to all-0s for passive scans).
1988
* Does not include payload. Must specify Tx rate; no rate scaling. */
1989
struct iwl4965_tx_cmd tx_cmd;
1991
/* For directed active scans (set to all-0s otherwise) */
1992
struct iwl4965_ssid_ie direct_scan[PROBE_OPTION_MAX];
1995
* Probe request frame, followed by channel list.
1997
* Size of probe request frame is specified by byte count in tx_cmd.
1998
* Channel list follows immediately after probe request frame.
1999
* Number of channels in list is specified by channel_count.
2000
* Each channel in list is of type:
2002
* struct iwl4965_scan_channel channels[0];
2004
* NOTE: Only one band of channels can be scanned per pass. You
2005
* must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
2006
* for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
2007
* before requesting another scan.
2010
} __attribute__ ((packed));
2012
/* Can abort will notify by complete notification with abort status. */
2013
#define CAN_ABORT_STATUS __constant_cpu_to_le32(0x1)
2014
/* complete notification statuses */
2015
#define ABORT_STATUS 0x2
2018
* REPLY_SCAN_CMD = 0x80 (response)
2020
struct iwl4965_scanreq_notification {
2021
__le32 status; /* 1: okay, 2: cannot fulfill request */
2022
} __attribute__ ((packed));
2025
* SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
2027
struct iwl4965_scanstart_notification {
2030
__le32 beacon_timer;
2035
} __attribute__ ((packed));
2037
#define SCAN_OWNER_STATUS 0x1;
2038
#define MEASURE_OWNER_STATUS 0x2;
2040
#define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */
2042
* SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
2044
struct iwl4965_scanresults_notification {
2050
__le32 statistics[NUMBER_OF_STATISTICS];
2051
} __attribute__ ((packed));
2054
* SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
2056
struct iwl4965_scancomplete_notification {
2057
u8 scanned_channels;
2063
} __attribute__ ((packed));
2066
/******************************************************************************
2068
* IBSS/AP Commands and Notifications:
2070
*****************************************************************************/
2073
* BEACON_NOTIFICATION = 0x90 (notification only, not a command)
2075
struct iwl4965_beacon_notif {
2076
struct iwl4965_tx_resp beacon_notify_hdr;
2079
__le32 ibss_mgr_status;
2080
} __attribute__ ((packed));
2083
* REPLY_TX_BEACON = 0x91 (command, has simple generic response)
2085
struct iwl4965_tx_beacon_cmd {
2086
struct iwl4965_tx_cmd tx;
2090
struct ieee80211_hdr frame[0]; /* beacon frame */
2091
} __attribute__ ((packed));
2093
/******************************************************************************
2095
* Statistics Commands and Notifications:
2097
*****************************************************************************/
2099
#define IWL_TEMP_CONVERT 260
2101
#define SUP_RATE_11A_MAX_NUM_CHANNELS 8
2102
#define SUP_RATE_11B_MAX_NUM_CHANNELS 4
2103
#define SUP_RATE_11G_MAX_NUM_CHANNELS 12
2105
/* Used for passing to driver number of successes and failures per rate */
2106
struct rate_histogram {
2108
__le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2109
__le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2110
__le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2113
__le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2114
__le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2115
__le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2117
} __attribute__ ((packed));
2119
/* statistics command response */
2121
struct statistics_rx_phy {
2127
__le32 early_overrun_err;
2129
__le32 false_alarm_cnt;
2130
__le32 fina_sync_err_cnt;
2132
__le32 fina_timeout;
2133
__le32 unresponded_rts;
2134
__le32 rxe_frame_limit_overrun;
2135
__le32 sent_ack_cnt;
2136
__le32 sent_cts_cnt;
2137
__le32 sent_ba_rsp_cnt;
2138
__le32 dsp_self_kill;
2139
__le32 mh_format_err;
2140
__le32 re_acq_main_rssi_sum;
2142
} __attribute__ ((packed));
2144
struct statistics_rx_ht_phy {
2147
__le32 early_overrun_err;
2150
__le32 mh_format_err;
2151
__le32 agg_crc32_good;
2152
__le32 agg_mpdu_cnt;
2155
} __attribute__ ((packed));
2157
struct statistics_rx_non_phy {
2158
__le32 bogus_cts; /* CTS received when not expecting CTS */
2159
__le32 bogus_ack; /* ACK received when not expecting ACK */
2160
__le32 non_bssid_frames; /* number of frames with BSSID that
2161
* doesn't belong to the STA BSSID */
2162
__le32 filtered_frames; /* count frames that were dumped in the
2163
* filtering process */
2164
__le32 non_channel_beacons; /* beacons with our bss id but not on
2165
* our serving channel */
2166
__le32 channel_beacons; /* beacons with our bss id and in our
2167
* serving channel */
2168
__le32 num_missed_bcon; /* number of missed beacons */
2169
__le32 adc_rx_saturation_time; /* count in 0.8us units the time the
2170
* ADC was in saturation */
2171
__le32 ina_detection_search_time;/* total time (in 0.8us) searched
2173
__le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */
2174
__le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */
2175
__le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */
2176
__le32 interference_data_flag; /* flag for interference data
2177
* availability. 1 when data is
2179
__le32 channel_load; /* counts RX Enable time in uSec */
2180
__le32 dsp_false_alarms; /* DSP false alarm (both OFDM
2181
* and CCK) counter */
2182
__le32 beacon_rssi_a;
2183
__le32 beacon_rssi_b;
2184
__le32 beacon_rssi_c;
2185
__le32 beacon_energy_a;
2186
__le32 beacon_energy_b;
2187
__le32 beacon_energy_c;
2188
} __attribute__ ((packed));
2190
struct statistics_rx {
2191
struct statistics_rx_phy ofdm;
2192
struct statistics_rx_phy cck;
2193
struct statistics_rx_non_phy general;
2194
struct statistics_rx_ht_phy ofdm_ht;
2195
} __attribute__ ((packed));
2197
struct statistics_tx_non_phy_agg {
2199
__le32 ba_reschedule_frames;
2200
__le32 scd_query_agg_frame_cnt;
2201
__le32 scd_query_no_agg;
2202
__le32 scd_query_agg;
2203
__le32 scd_query_mismatch;
2204
__le32 frame_not_ready;
2206
__le32 bt_prio_kill;
2207
__le32 rx_ba_rsp_cnt;
2210
} __attribute__ ((packed));
2212
struct statistics_tx {
2213
__le32 preamble_cnt;
2214
__le32 rx_detected_cnt;
2215
__le32 bt_prio_defer_cnt;
2216
__le32 bt_prio_kill_cnt;
2217
__le32 few_bytes_cnt;
2220
__le32 expected_ack_cnt;
2221
__le32 actual_ack_cnt;
2222
__le32 dump_msdu_cnt;
2223
__le32 burst_abort_next_frame_mismatch_cnt;
2224
__le32 burst_abort_missing_next_frame_cnt;
2225
__le32 cts_timeout_collision;
2226
__le32 ack_or_ba_timeout_collision;
2227
struct statistics_tx_non_phy_agg agg;
2228
} __attribute__ ((packed));
2230
struct statistics_dbg {
2234
} __attribute__ ((packed));
2236
struct statistics_div {
2243
} __attribute__ ((packed));
2245
struct statistics_general {
2247
__le32 temperature_m;
2248
struct statistics_dbg dbg;
2252
__le32 ttl_timestamp;
2253
struct statistics_div div;
2254
__le32 rx_enable_counter;
2258
} __attribute__ ((packed));
2261
* REPLY_STATISTICS_CMD = 0x9c,
2262
* 3945 and 4965 identical.
2264
* This command triggers an immediate response containing uCode statistics.
2265
* The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
2267
* If the CLEAR_STATS configuration flag is set, uCode will clear its
2268
* internal copy of the statistics (counters) after issuing the response.
2269
* This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
2271
* If the DISABLE_NOTIF configuration flag is set, uCode will not issue
2272
* STATISTICS_NOTIFICATIONs after received beacons (see below). This flag
2273
* does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
2275
#define IWL_STATS_CONF_CLEAR_STATS __constant_cpu_to_le32(0x1) /* see above */
2276
#define IWL_STATS_CONF_DISABLE_NOTIF __constant_cpu_to_le32(0x2)/* see above */
2277
struct iwl4965_statistics_cmd {
2278
__le32 configuration_flags; /* IWL_STATS_CONF_* */
2279
} __attribute__ ((packed));
2282
* STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
2284
* By default, uCode issues this notification after receiving a beacon
2285
* while associated. To disable this behavior, set DISABLE_NOTIF flag in the
2286
* REPLY_STATISTICS_CMD 0x9c, above.
2288
* Statistics counters continue to increment beacon after beacon, but are
2289
* cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
2290
* 0x9c with CLEAR_STATS bit set (see above).
2292
* uCode also issues this notification during scans. uCode clears statistics
2293
* appropriately so that each notification contains statistics for only the
2294
* one channel that has just been scanned.
2296
#define STATISTICS_REPLY_FLG_BAND_24G_MSK __constant_cpu_to_le32(0x2)
2297
#define STATISTICS_REPLY_FLG_FAT_MODE_MSK __constant_cpu_to_le32(0x8)
2298
struct iwl4965_notif_statistics {
2300
struct statistics_rx rx;
2301
struct statistics_tx tx;
2302
struct statistics_general general;
2303
} __attribute__ ((packed));
2307
* MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
2309
/* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row,
2310
* then this notification will be sent. */
2311
#define CONSECUTIVE_MISSED_BCONS_TH 20
2313
struct iwl4965_missed_beacon_notif {
2314
__le32 consequtive_missed_beacons;
2315
__le32 total_missed_becons;
2316
__le32 num_expected_beacons;
2317
__le32 num_recvd_beacons;
2318
} __attribute__ ((packed));
2321
/******************************************************************************
2323
* Rx Calibration Commands:
2325
* With the uCode used for open source drivers, most Tx calibration (except
2326
* for Tx Power) and most Rx calibration is done by uCode during the
2327
* "initialize" phase of uCode boot. Driver must calibrate only:
2329
* 1) Tx power (depends on temperature), described elsewhere
2330
* 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas)
2331
* 3) Receiver sensitivity (to optimize signal detection)
2333
*****************************************************************************/
2336
* SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
2338
* This command sets up the Rx signal detector for a sensitivity level that
2339
* is high enough to lock onto all signals within the associated network,
2340
* but low enough to ignore signals that are below a certain threshold, so as
2341
* not to have too many "false alarms". False alarms are signals that the
2342
* Rx DSP tries to lock onto, but then discards after determining that they
2345
* The optimum number of false alarms is between 5 and 50 per 200 TUs
2346
* (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
2347
* time listening, not transmitting). Driver must adjust sensitivity so that
2348
* the ratio of actual false alarms to actual Rx time falls within this range.
2350
* While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
2351
* received beacon. These provide information to the driver to analyze the
2352
* sensitivity. Don't analyze statistics that come in from scanning, or any
2353
* other non-associated-network source. Pertinent statistics include:
2355
* From "general" statistics (struct statistics_rx_non_phy):
2357
* (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
2358
* Measure of energy of desired signal. Used for establishing a level
2359
* below which the device does not detect signals.
2361
* (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
2362
* Measure of background noise in silent period after beacon.
2365
* uSecs of actual Rx time during beacon period (varies according to
2366
* how much time was spent transmitting).
2368
* From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
2371
* Signal locks abandoned early (before phy-level header).
2374
* Signal locks abandoned late (during phy-level header).
2376
* NOTE: Both false_alarm_cnt and plcp_err increment monotonically from
2377
* beacon to beacon, i.e. each value is an accumulation of all errors
2378
* before and including the latest beacon. Values will wrap around to 0
2379
* after counting up to 2^32 - 1. Driver must differentiate vs.
2380
* previous beacon's values to determine # false alarms in the current
2383
* Total number of false alarms = false_alarms + plcp_errs
2385
* For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
2386
* (notice that the start points for OFDM are at or close to settings for
2387
* maximum sensitivity):
2390
* HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120
2391
* HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210
2392
* HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140
2393
* HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270
2395
* If actual rate of OFDM false alarms (+ plcp_errors) is too high
2396
* (greater than 50 for each 204.8 msecs listening), reduce sensitivity
2397
* by *adding* 1 to all 4 of the table entries above, up to the max for
2398
* each entry. Conversely, if false alarm rate is too low (less than 5
2399
* for each 204.8 msecs listening), *subtract* 1 from each entry to
2400
* increase sensitivity.
2402
* For CCK sensitivity, keep track of the following:
2404
* 1). 20-beacon history of maximum background noise, indicated by
2405
* (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
2406
* 3 receivers. For any given beacon, the "silence reference" is
2407
* the maximum of last 60 samples (20 beacons * 3 receivers).
2409
* 2). 10-beacon history of strongest signal level, as indicated
2410
* by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
2411
* i.e. the strength of the signal through the best receiver at the
2412
* moment. These measurements are "upside down", with lower values
2413
* for stronger signals, so max energy will be *minimum* value.
2415
* Then for any given beacon, the driver must determine the *weakest*
2416
* of the strongest signals; this is the minimum level that needs to be
2417
* successfully detected, when using the best receiver at the moment.
2418
* "Max cck energy" is the maximum (higher value means lower energy!)
2419
* of the last 10 minima. Once this is determined, driver must add
2420
* a little margin by adding "6" to it.
2422
* 3). Number of consecutive beacon periods with too few false alarms.
2423
* Reset this to 0 at the first beacon period that falls within the
2424
* "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
2426
* Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
2427
* (notice that the start points for CCK are at maximum sensitivity):
2430
* HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200
2431
* HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400
2432
* HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100
2434
* If actual rate of CCK false alarms (+ plcp_errors) is too high
2435
* (greater than 50 for each 204.8 msecs listening), method for reducing
2438
* 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2441
* 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
2442
* sensitivity has been reduced a significant amount; bring it up to
2443
* a moderate 161. Otherwise, *add* 3, up to max 200.
2445
* 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
2446
* sensitivity has been reduced only a moderate or small amount;
2447
* *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
2448
* down to min 0. Otherwise (if gain has been significantly reduced),
2449
* don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
2451
* b) Save a snapshot of the "silence reference".
2453
* If actual rate of CCK false alarms (+ plcp_errors) is too low
2454
* (less than 5 for each 204.8 msecs listening), method for increasing
2455
* sensitivity is used only if:
2457
* 1a) Previous beacon did not have too many false alarms
2458
* 1b) AND difference between previous "silence reference" and current
2459
* "silence reference" (prev - current) is 2 or more,
2460
* OR 2) 100 or more consecutive beacon periods have had rate of
2461
* less than 5 false alarms per 204.8 milliseconds rx time.
2463
* Method for increasing sensitivity:
2465
* 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
2468
* 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2471
* 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
2473
* If actual rate of CCK false alarms (+ plcp_errors) is within good range
2474
* (between 5 and 50 for each 204.8 msecs listening):
2476
* 1) Save a snapshot of the silence reference.
2478
* 2) If previous beacon had too many CCK false alarms (+ plcp_errors),
2479
* give some extra margin to energy threshold by *subtracting* 8
2480
* from value in HD_MIN_ENERGY_CCK_DET_INDEX.
2482
* For all cases (too few, too many, good range), make sure that the CCK
2483
* detection threshold (energy) is below the energy level for robust
2484
* detection over the past 10 beacon periods, the "Max cck energy".
2485
* Lower values mean higher energy; this means making sure that the value
2486
* in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
2488
* Driver should set the following entries to fixed values:
2490
* HD_MIN_ENERGY_OFDM_DET_INDEX 100
2491
* HD_BARKER_CORR_TH_ADD_MIN_INDEX 190
2492
* HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX 390
2493
* HD_OFDM_ENERGY_TH_IN_INDEX 62
2497
* Table entries in SENSITIVITY_CMD (struct iwl4965_sensitivity_cmd)
2499
#define HD_TABLE_SIZE (11) /* number of entries */
2500
#define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */
2501
#define HD_MIN_ENERGY_OFDM_DET_INDEX (1)
2502
#define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2)
2503
#define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3)
2504
#define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4)
2505
#define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5)
2506
#define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6)
2507
#define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7)
2508
#define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8)
2509
#define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9)
2510
#define HD_OFDM_ENERGY_TH_IN_INDEX (10)
2512
/* Control field in struct iwl4965_sensitivity_cmd */
2513
#define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE __constant_cpu_to_le16(0)
2514
#define SENSITIVITY_CMD_CONTROL_WORK_TABLE __constant_cpu_to_le16(1)
2517
* struct iwl4965_sensitivity_cmd
2518
* @control: (1) updates working table, (0) updates default table
2519
* @table: energy threshold values, use HD_* as index into table
2521
* Always use "1" in "control" to update uCode's working table and DSP.
2523
struct iwl4965_sensitivity_cmd {
2524
__le16 control; /* always use "1" */
2525
__le16 table[HD_TABLE_SIZE]; /* use HD_* as index */
2526
} __attribute__ ((packed));
2530
* REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
2532
* This command sets the relative gains of 4965's 3 radio receiver chains.
2534
* After the first association, driver should accumulate signal and noise
2535
* statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
2536
* beacons from the associated network (don't collect statistics that come
2537
* in from scanning, or any other non-network source).
2539
* DISCONNECTED ANTENNA:
2541
* Driver should determine which antennas are actually connected, by comparing
2542
* average beacon signal levels for the 3 Rx chains. Accumulate (add) the
2543
* following values over 20 beacons, one accumulator for each of the chains
2544
* a/b/c, from struct statistics_rx_non_phy:
2546
* beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
2548
* Find the strongest signal from among a/b/c. Compare the other two to the
2549
* strongest. If any signal is more than 15 dB (times 20, unless you
2550
* divide the accumulated values by 20) below the strongest, the driver
2551
* considers that antenna to be disconnected, and should not try to use that
2552
* antenna/chain for Rx or Tx. If both A and B seem to be disconnected,
2553
* driver should declare the stronger one as connected, and attempt to use it
2554
* (A and B are the only 2 Tx chains!).
2559
* Driver should balance the 3 receivers (but just the ones that are connected
2560
* to antennas, see above) for gain, by comparing the average signal levels
2561
* detected during the silence after each beacon (background noise).
2562
* Accumulate (add) the following values over 20 beacons, one accumulator for
2563
* each of the chains a/b/c, from struct statistics_rx_non_phy:
2565
* beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
2567
* Find the weakest background noise level from among a/b/c. This Rx chain
2568
* will be the reference, with 0 gain adjustment. Attenuate other channels by
2569
* finding noise difference:
2571
* (accum_noise[i] - accum_noise[reference]) / 30
2573
* The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
2574
* For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
2575
* driver should limit the difference results to a range of 0-3 (0-4.5 dB),
2576
* and set bit 2 to indicate "reduce gain". The value for the reference
2577
* (weakest) chain should be "0".
2579
* diff_gain_[abc] bit fields:
2580
* 2: (1) reduce gain, (0) increase gain
2581
* 1-0: amount of gain, units of 1.5 dB
2584
/* "Differential Gain" opcode used in REPLY_PHY_CALIBRATION_CMD. */
2585
#define PHY_CALIBRATE_DIFF_GAIN_CMD (7)
2587
struct iwl4965_calibration_cmd {
2588
u8 opCode; /* PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
2589
u8 flags; /* not used */
2591
s8 diff_gain_a; /* see above */
2595
} __attribute__ ((packed));
2597
/******************************************************************************
2599
* Miscellaneous Commands:
2601
*****************************************************************************/
2604
* LEDs Command & Response
2605
* REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
2607
* For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
2608
* this command turns it on or off, or sets up a periodic blinking cycle.
2610
struct iwl4965_led_cmd {
2611
__le32 interval; /* "interval" in uSec */
2612
u8 id; /* 1: Activity, 2: Link, 3: Tech */
2613
u8 off; /* # intervals off while blinking;
2614
* "0", with >0 "on" value, turns LED on */
2615
u8 on; /* # intervals on while blinking;
2616
* "0", regardless of "off", turns LED off */
2618
} __attribute__ ((packed));
2620
/******************************************************************************
2622
* Union of all expected notifications/responses:
2624
*****************************************************************************/
2626
struct iwl4965_rx_packet {
2628
struct iwl4965_cmd_header hdr;
2630
struct iwl4965_alive_resp alive_frame;
2631
struct iwl4965_rx_frame rx_frame;
2632
struct iwl4965_tx_resp tx_resp;
2633
struct iwl4965_spectrum_notification spectrum_notif;
2634
struct iwl4965_csa_notification csa_notif;
2635
struct iwl4965_error_resp err_resp;
2636
struct iwl4965_card_state_notif card_state_notif;
2637
struct iwl4965_beacon_notif beacon_status;
2638
struct iwl4965_add_sta_resp add_sta;
2639
struct iwl4965_sleep_notification sleep_notif;
2640
struct iwl4965_spectrum_resp spectrum;
2641
struct iwl4965_notif_statistics stats;
2642
struct iwl4965_compressed_ba_resp compressed_ba;
2643
struct iwl4965_missed_beacon_notif missed_beacon;
2647
} __attribute__ ((packed));
2649
#define IWL_RX_FRAME_SIZE (4 + sizeof(struct iwl4965_rx_frame))
2651
#endif /* __iwl4965_commands_h__ */
added
removed
updates/wireless/iwlwifi/iwlwifi/compatible/iwl-4965-commands.h
