projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
iwlwifi: document 4965 Tx scheduler
[deliverable/linux.git] / drivers / net / wireless / iwlwifi / iwl-4965-commands.h
CommitLineData
b481de9c
ZY		 1/******************************************************************************
2 *
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
5 *
6 * GPL LICENSE SUMMARY
7 *
8 * Copyright(c) 2005 - 2007 Intel Corporation. All rights reserved.
9 *
10 * This program is free software; you can redistribute it and/or modify
01ebd063 11 * it under the terms of version 2 of the GNU General Public License as
b481de9c
ZY		 12 * published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
22 * USA
23 *
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
26 *
27 * Contact Information:
28 * James P. Ketrenos <ipw2100-admin@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30 *
31 * BSD LICENSE
32 *
33 * Copyright(c) 2005 - 2007 Intel Corporation. All rights reserved.
34 * All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 *
40 * * Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * * Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in
44 * the documentation and/or other materials provided with the
45 * distribution.
46 * * Neither the name Intel Corporation nor the names of its
47 * contributors may be used to endorse or promote products derived
48 * from this software without specific prior written permission.
49 *
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
61 *
62 *****************************************************************************/
fcd427bb
BC		 63/*
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.
67 */
b481de9c 68
bb8c093b
CH		 69#ifndef __iwl4965_commands_h__
70#define __iwl4965_commands_h__
b481de9c
ZY		 71
72enum {
73 REPLY_ALIVE = 0x1,
74 REPLY_ERROR = 0x2,
75
76 /* RXON and QOS commands */
77 REPLY_RXON = 0x10,
78 REPLY_RXON_ASSOC = 0x11,
79 REPLY_QOS_PARAM = 0x13,
80 REPLY_RXON_TIMING = 0x14,
81
82 /* Multi-Station support */
83 REPLY_ADD_STA = 0x18,
84 REPLY_REMOVE_STA = 0x19, /* not used */
85 REPLY_REMOVE_ALL_STA = 0x1a, /* not used */
86
87 /* RX, TX, LEDs */
b481de9c
ZY		 88 REPLY_TX = 0x1c,
89 REPLY_RATE_SCALE = 0x47, /* 3945 only */
90 REPLY_LEDS_CMD = 0x48,
91 REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */
92
93 /* 802.11h related */
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,
100
101 /* Power Management */
102 POWER_TABLE_CMD = 0x77,
103 PM_SLEEP_NOTIFICATION = 0x7A,
104 PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
105
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,
112
113 /* IBSS/AP commands */
114 BEACON_NOTIFICATION = 0x90,
115 REPLY_TX_BEACON = 0x91,
116 WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */
117
118 /* Miscellaneous commands */
119 QUIET_NOTIFICATION = 0x96, /* not used */
120 REPLY_TX_PWR_TABLE_CMD = 0x97,
121 MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */
122
123 /* BT config command */
124 REPLY_BT_CONFIG = 0x9b,
125
126 /* 4965 Statistics */
127 REPLY_STATISTICS_CMD = 0x9c,
128 STATISTICS_NOTIFICATION = 0x9d,
129
130 /* RF-KILL commands and notifications */
131 REPLY_CARD_STATE_CMD = 0xa0,
132 CARD_STATE_NOTIFICATION = 0xa1,
133
134 /* Missed beacons notification */
135 MISSED_BEACONS_NOTIFICATION = 0xa2,
136
b481de9c
ZY		 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,
b481de9c
ZY		 144 REPLY_MAX = 0xff
145};
146
147/******************************************************************************
148 * (0)
abceddb4
BC		 149 * Commonly used structures and definitions:
150 * Command header, rate_n_flags
b481de9c
ZY		 151 *
152 *****************************************************************************/
153
154#define IWL_CMD_FAILED_MSK 0x40
155
bb8c093b 156struct iwl4965_cmd_header {
b481de9c
ZY		 157 u8 cmd;
158 u8 flags;
159 /* We have 15 LSB to use as we please (MSB indicates
160 * a frame Rx'd from the HW). We encode the following
161 * information into the sequence field:
162 *
163 * 0:7 index in fifo
164 * 8:13 fifo selection
165 * 14:14 bit indicating if this packet references the 'extra'
166 * storage at the end of the memory queue
167 * 15:15 (Rx indication)
168 *
169 */
170 __le16 sequence;
171
172 /* command data follows immediately */
173 u8 data[0];
174} __attribute__ ((packed));
175
abceddb4
BC		 176/**
177 * 4965 rate_n_flags bit fields
178 *
179 * rate_n_flags format is used in following 4965 commands:
180 * REPLY_4965_RX (response only)
181 * REPLY_TX (both command and response)
182 * REPLY_TX_LINK_QUALITY_CMD
183 *
184 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
185 * 2-0: 0) 6 Mbps
186 * 1) 12 Mbps
187 * 2) 18 Mbps
188 * 3) 24 Mbps
189 * 4) 36 Mbps
190 * 5) 48 Mbps
191 * 6) 54 Mbps
192 * 7) 60 Mbps
193 *
194 * 3: 0) Single stream (SISO)
195 * 1) Dual stream (MIMO)
196 *
197 * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps FAT duplicate data
198 *
199 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
200 * 3-0: 0xD) 6 Mbps
201 * 0xF) 9 Mbps
202 * 0x5) 12 Mbps
203 * 0x7) 18 Mbps
204 * 0x9) 24 Mbps
205 * 0xB) 36 Mbps
206 * 0x1) 48 Mbps
207 * 0x3) 54 Mbps
208 *
209 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
210 * 3-0: 10) 1 Mbps
211 * 20) 2 Mbps
212 * 55) 5.5 Mbps
213 * 110) 11 Mbps
214 */
215#define RATE_MCS_CODE_MSK 0x7
216#define RATE_MCS_MIMO_POS 3
217#define RATE_MCS_MIMO_MSK 0x8
218#define RATE_MCS_HT_DUP_POS 5
219#define RATE_MCS_HT_DUP_MSK 0x20
220
221/* (1) HT format, (0) legacy format in bits 7:0 */
222#define RATE_MCS_FLAGS_POS 8
223#define RATE_MCS_HT_POS 8
224#define RATE_MCS_HT_MSK 0x100
225
226/* (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */
227#define RATE_MCS_CCK_POS 9
228#define RATE_MCS_CCK_MSK 0x200
229
230/* (1) Use Green Field preamble */
231#define RATE_MCS_GF_POS 10
232#define RATE_MCS_GF_MSK 0x400
233
234/* (1) Use 40Mhz FAT channel width, (0) use 20 MHz legacy channel width */
235#define RATE_MCS_FAT_POS 11
236#define RATE_MCS_FAT_MSK 0x800
237
238/* (1) Duplicate data on both 20MHz channels. FAT (bit 11) must be set. */
239#define RATE_MCS_DUP_POS 12
240#define RATE_MCS_DUP_MSK 0x1000
241
242/* (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
243#define RATE_MCS_SGI_POS 13
244#define RATE_MCS_SGI_MSK 0x2000
245
246/**
247 * rate_n_flags Tx antenna masks (4965 has 2 transmitters):
248 * bit14:15 01 B inactive, A active
249 * 10 B active, A inactive
250 * 11 Both active
251 */
252#define RATE_MCS_ANT_A_POS 14
253#define RATE_MCS_ANT_B_POS 15
254#define RATE_MCS_ANT_A_MSK 0x4000
255#define RATE_MCS_ANT_B_MSK 0x8000
256#define RATE_MCS_ANT_AB_MSK 0xc000
257
258
b481de9c
ZY		 259/******************************************************************************
260 * (0a)
261 * Alive and Error Commands & Responses:
262 *
263 *****************************************************************************/
264
265#define UCODE_VALID_OK __constant_cpu_to_le32(0x1)
266#define INITIALIZE_SUBTYPE (9)
267
268/*
269 * REPLY_ALIVE = 0x1 (response only, not a command)
270 */
bb8c093b 271struct iwl4965_alive_resp {
b481de9c
ZY		 272 u8 ucode_minor;
273 u8 ucode_major;
274 __le16 reserved1;
275 u8 sw_rev[8];
276 u8 ver_type;
277 u8 ver_subtype;
278 __le16 reserved2;
279 __le32 log_event_table_ptr;
280 __le32 error_event_table_ptr;
281 __le32 timestamp;
282 __le32 is_valid;
283} __attribute__ ((packed));
284
bb8c093b 285struct iwl4965_init_alive_resp {
b481de9c
ZY		 286 u8 ucode_minor;
287 u8 ucode_major;
288 __le16 reserved1;
289 u8 sw_rev[8];
290 u8 ver_type;
291 u8 ver_subtype;
292 __le16 reserved2;
293 __le32 log_event_table_ptr;
294 __le32 error_event_table_ptr;
295 __le32 timestamp;
296 __le32 is_valid;
297
b481de9c
ZY		 298 /* calibration values from "initialize" uCode */
299 __le32 voltage; /* signed */
300 __le32 therm_r1[2]; /* signed 1st for normal, 2nd for FAT channel */
301 __le32 therm_r2[2]; /* signed */
302 __le32 therm_r3[2]; /* signed */
303 __le32 therm_r4[2]; /* signed */
304 __le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups,
305 * 2 Tx chains */
b481de9c
ZY		 306} __attribute__ ((packed));
307
308union tsf {
309 u8 byte[8];
310 __le16 word[4];
311 __le32 dw[2];
312};
313
314/*
315 * REPLY_ERROR = 0x2 (response only, not a command)
316 */
bb8c093b 317struct iwl4965_error_resp {
b481de9c
ZY		 318 __le32 error_type;
319 u8 cmd_id;
320 u8 reserved1;
321 __le16 bad_cmd_seq_num;
b481de9c
ZY		 322 __le32 error_info;
323 union tsf timestamp;
324} __attribute__ ((packed));
325
326/******************************************************************************
327 * (1)
328 * RXON Commands & Responses:
329 *
330 *****************************************************************************/
331
332/*
333 * Rx config defines & structure
334 */
335/* rx_config device types */
336enum {
337 RXON_DEV_TYPE_AP = 1,
338 RXON_DEV_TYPE_ESS = 3,
339 RXON_DEV_TYPE_IBSS = 4,
340 RXON_DEV_TYPE_SNIFFER = 6,
341};
342
14519a0b
BC		 343
344#define RXON_RX_CHAIN_DRIVER_FORCE_MSK __constant_cpu_to_le16(0x1<<0)
345#define RXON_RX_CHAIN_VALID_MSK __constant_cpu_to_le16(0x7<<1)
346#define RXON_RX_CHAIN_VALID_POS (1)
347#define RXON_RX_CHAIN_FORCE_SEL_MSK __constant_cpu_to_le16(0x7<<4)
348#define RXON_RX_CHAIN_FORCE_SEL_POS (4)
349#define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK __constant_cpu_to_le16(0x7<<7)
350#define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
351#define RXON_RX_CHAIN_CNT_MSK __constant_cpu_to_le16(0x3<<10)
352#define RXON_RX_CHAIN_CNT_POS (10)
353#define RXON_RX_CHAIN_MIMO_CNT_MSK __constant_cpu_to_le16(0x3<<12)
354#define RXON_RX_CHAIN_MIMO_CNT_POS (12)
355#define RXON_RX_CHAIN_MIMO_FORCE_MSK __constant_cpu_to_le16(0x1<<14)
356#define RXON_RX_CHAIN_MIMO_FORCE_POS (14)
357
b481de9c
ZY		 358/* rx_config flags */
359/* band & modulation selection */
360#define RXON_FLG_BAND_24G_MSK __constant_cpu_to_le32(1 << 0)
361#define RXON_FLG_CCK_MSK __constant_cpu_to_le32(1 << 1)
362/* auto detection enable */
363#define RXON_FLG_AUTO_DETECT_MSK __constant_cpu_to_le32(1 << 2)
364/* TGg protection when tx */
365#define RXON_FLG_TGG_PROTECT_MSK __constant_cpu_to_le32(1 << 3)
366/* cck short slot & preamble */
367#define RXON_FLG_SHORT_SLOT_MSK __constant_cpu_to_le32(1 << 4)
368#define RXON_FLG_SHORT_PREAMBLE_MSK __constant_cpu_to_le32(1 << 5)
369/* antenna selection */
370#define RXON_FLG_DIS_DIV_MSK __constant_cpu_to_le32(1 << 7)
371#define RXON_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0x0f00)
372#define RXON_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8)
373#define RXON_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9)
374/* radar detection enable */
375#define RXON_FLG_RADAR_DETECT_MSK __constant_cpu_to_le32(1 << 12)
376#define RXON_FLG_TGJ_NARROW_BAND_MSK __constant_cpu_to_le32(1 << 13)
377/* rx response to host with 8-byte TSF
378* (according to ON_AIR deassertion) */
379#define RXON_FLG_TSF2HOST_MSK __constant_cpu_to_le32(1 << 15)
380
14519a0b
BC		 381
382/* HT flags */
383#define RXON_FLG_CTRL_CHANNEL_LOC_POS (22)
384#define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK __constant_cpu_to_le32(0x1<<22)
385
386#define RXON_FLG_HT_OPERATING_MODE_POS (23)
387
388#define RXON_FLG_HT_PROT_MSK __constant_cpu_to_le32(0x1<<23)
389#define RXON_FLG_FAT_PROT_MSK __constant_cpu_to_le32(0x2<<23)
390
391#define RXON_FLG_CHANNEL_MODE_POS (25)
392#define RXON_FLG_CHANNEL_MODE_MSK __constant_cpu_to_le32(0x3<<25)
393#define RXON_FLG_CHANNEL_MODE_PURE_40_MSK __constant_cpu_to_le32(0x1<<25)
394#define RXON_FLG_CHANNEL_MODE_MIXED_MSK __constant_cpu_to_le32(0x2<<25)
395
b481de9c
ZY		 396/* rx_config filter flags */
397/* accept all data frames */
398#define RXON_FILTER_PROMISC_MSK __constant_cpu_to_le32(1 << 0)
399/* pass control & management to host */
400#define RXON_FILTER_CTL2HOST_MSK __constant_cpu_to_le32(1 << 1)
401/* accept multi-cast */
402#define RXON_FILTER_ACCEPT_GRP_MSK __constant_cpu_to_le32(1 << 2)
403/* don't decrypt uni-cast frames */
404#define RXON_FILTER_DIS_DECRYPT_MSK __constant_cpu_to_le32(1 << 3)
405/* don't decrypt multi-cast frames */
406#define RXON_FILTER_DIS_GRP_DECRYPT_MSK __constant_cpu_to_le32(1 << 4)
407/* STA is associated */
408#define RXON_FILTER_ASSOC_MSK __constant_cpu_to_le32(1 << 5)
409/* transfer to host non bssid beacons in associated state */
410#define RXON_FILTER_BCON_AWARE_MSK __constant_cpu_to_le32(1 << 6)
411
412/*
413 * REPLY_RXON = 0x10 (command, has simple generic response)
414 */
bb8c093b 415struct iwl4965_rxon_cmd {
b481de9c
ZY		 416 u8 node_addr[6];
417 __le16 reserved1;
418 u8 bssid_addr[6];
419 __le16 reserved2;
420 u8 wlap_bssid_addr[6];
421 __le16 reserved3;
422 u8 dev_type;
423 u8 air_propagation;
b481de9c 424 __le16 rx_chain;
b481de9c
ZY		 425 u8 ofdm_basic_rates;
426 u8 cck_basic_rates;
427 __le16 assoc_id;
428 __le32 flags;
429 __le32 filter_flags;
430 __le16 channel;
b481de9c
ZY		 431 u8 ofdm_ht_single_stream_basic_rates;
432 u8 ofdm_ht_dual_stream_basic_rates;
b481de9c
ZY		 433} __attribute__ ((packed));
434
435/*
436 * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
437 */
bb8c093b 438struct iwl4965_rxon_assoc_cmd {
b481de9c
ZY		 439 __le32 flags;
440 __le32 filter_flags;
441 u8 ofdm_basic_rates;
442 u8 cck_basic_rates;
b481de9c
ZY		 443 u8 ofdm_ht_single_stream_basic_rates;
444 u8 ofdm_ht_dual_stream_basic_rates;
445 __le16 rx_chain_select_flags;
b481de9c
ZY		 446 __le16 reserved;
447} __attribute__ ((packed));
448
449/*
450 * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
451 */
bb8c093b 452struct iwl4965_rxon_time_cmd {
b481de9c
ZY		 453 union tsf timestamp;
454 __le16 beacon_interval;
455 __le16 atim_window;
456 __le32 beacon_init_val;
457 __le16 listen_interval;
458 __le16 reserved;
459} __attribute__ ((packed));
460
bb8c093b 461struct iwl4965_tx_power {
b481de9c
ZY		 462 u8 tx_gain; /* gain for analog radio */
463 u8 dsp_atten; /* gain for DSP */
464} __attribute__ ((packed));
465
b481de9c
ZY		 466#define POWER_TABLE_NUM_ENTRIES 33
467#define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32
468#define POWER_TABLE_CCK_ENTRY 32
14519a0b
BC		 469
470union iwl4965_tx_power_dual_stream {
471 struct {
472 u8 radio_tx_gain[2];
473 u8 dsp_predis_atten[2];
474 } s;
475 u32 dw;
476};
477
b481de9c
ZY		 478struct tx_power_dual_stream {
479 __le32 dw;
480} __attribute__ ((packed));
481
bb8c093b 482struct iwl4965_tx_power_db {
b481de9c
ZY		 483 struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES];
484} __attribute__ ((packed));
b481de9c
ZY		 485
486/*
487 * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
488 */
bb8c093b 489struct iwl4965_channel_switch_cmd {
b481de9c
ZY		 490 u8 band;
491 u8 expect_beacon;
492 __le16 channel;
493 __le32 rxon_flags;
494 __le32 rxon_filter_flags;
495 __le32 switch_time;
bb8c093b 496 struct iwl4965_tx_power_db tx_power;
b481de9c
ZY		 497} __attribute__ ((packed));
498
499/*
500 * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
501 */
bb8c093b 502struct iwl4965_csa_notification {
b481de9c
ZY		 503 __le16 band;
504 __le16 channel;
505 __le32 status; /* 0 - OK, 1 - fail */
506} __attribute__ ((packed));
507
508/******************************************************************************
509 * (2)
510 * Quality-of-Service (QOS) Commands & Responses:
511 *
512 *****************************************************************************/
bb8c093b 513struct iwl4965_ac_qos {
b481de9c
ZY		 514 __le16 cw_min;
515 __le16 cw_max;
516 u8 aifsn;
517 u8 reserved1;
518 __le16 edca_txop;
519} __attribute__ ((packed));
520
521/* QoS flags defines */
522#define QOS_PARAM_FLG_UPDATE_EDCA_MSK __constant_cpu_to_le32(0x01)
523#define QOS_PARAM_FLG_TGN_MSK __constant_cpu_to_le32(0x02)
524#define QOS_PARAM_FLG_TXOP_TYPE_MSK __constant_cpu_to_le32(0x10)
525
526/*
527 * TXFIFO Queue number defines
528 */
529/* number of Access categories (AC) (EDCA), queues 0..3 */
530#define AC_NUM 4
531
532/*
533 * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
534 */
bb8c093b 535struct iwl4965_qosparam_cmd {
b481de9c 536 __le32 qos_flags;
bb8c093b 537 struct iwl4965_ac_qos ac[AC_NUM];
b481de9c
ZY		 538} __attribute__ ((packed));
539
540/******************************************************************************
541 * (3)
542 * Add/Modify Stations Commands & Responses:
543 *
544 *****************************************************************************/
545/*
546 * Multi station support
547 */
548#define IWL_AP_ID 0
549#define IWL_MULTICAST_ID 1
550#define IWL_STA_ID 2
551
552#define IWL3945_BROADCAST_ID 24
553#define IWL3945_STATION_COUNT 25
554
555#define IWL4965_BROADCAST_ID 31
556#define IWL4965_STATION_COUNT 32
557
558#define IWL_STATION_COUNT 32 /* MAX(3945,4965)*/
559#define IWL_INVALID_STATION 255
560
b481de9c 561#define STA_FLG_PWR_SAVE_MSK __constant_cpu_to_le32(1<<8);
74093ddf
BC		 562#define STA_FLG_RTS_MIMO_PROT_MSK __constant_cpu_to_le32(1 << 17)
563#define STA_FLG_AGG_MPDU_8US_MSK __constant_cpu_to_le32(1 << 18)
564#define STA_FLG_MAX_AGG_SIZE_POS (19)
565#define STA_FLG_MAX_AGG_SIZE_MSK __constant_cpu_to_le32(3 << 19)
566#define STA_FLG_FAT_EN_MSK __constant_cpu_to_le32(1 << 21)
567#define STA_FLG_MIMO_DIS_MSK __constant_cpu_to_le32(1 << 22)
568#define STA_FLG_AGG_MPDU_DENSITY_POS (23)
569#define STA_FLG_AGG_MPDU_DENSITY_MSK __constant_cpu_to_le32(7 << 23)
b481de9c
ZY		 570
571#define STA_CONTROL_MODIFY_MSK 0x01
572
573/* key flags __le16*/
574#define STA_KEY_FLG_ENCRYPT_MSK __constant_cpu_to_le16(0x7)
575#define STA_KEY_FLG_NO_ENC __constant_cpu_to_le16(0x0)
576#define STA_KEY_FLG_WEP __constant_cpu_to_le16(0x1)
577#define STA_KEY_FLG_CCMP __constant_cpu_to_le16(0x2)
578#define STA_KEY_FLG_TKIP __constant_cpu_to_le16(0x3)
579
580#define STA_KEY_FLG_KEYID_POS 8
581#define STA_KEY_FLG_INVALID __constant_cpu_to_le16(0x0800)
582
583/* modify flags */
584#define STA_MODIFY_KEY_MASK 0x01
585#define STA_MODIFY_TID_DISABLE_TX 0x02
586#define STA_MODIFY_TX_RATE_MSK 0x04
587#define STA_MODIFY_ADDBA_TID_MSK 0x08
588#define STA_MODIFY_DELBA_TID_MSK 0x10
589#define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid))
590
bb8c093b 591struct iwl4965_keyinfo {
b481de9c
ZY		 592 __le16 key_flags;
593 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
594 u8 reserved1;
595 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
596 __le16 reserved2;
597 u8 key[16]; /* 16-byte unicast decryption key */
598} __attribute__ ((packed));
599
600struct sta_id_modify {
601 u8 addr[ETH_ALEN];
602 __le16 reserved1;
603 u8 sta_id;
604 u8 modify_mask;
605 __le16 reserved2;
606} __attribute__ ((packed));
607
608/*
609 * REPLY_ADD_STA = 0x18 (command)
610 */
bb8c093b 611struct iwl4965_addsta_cmd {
b481de9c
ZY		 612 u8 mode;
613 u8 reserved[3];
614 struct sta_id_modify sta;
bb8c093b 615 struct iwl4965_keyinfo key;
b481de9c
ZY		 616 __le32 station_flags;
617 __le32 station_flags_msk;
618 __le16 tid_disable_tx;
b481de9c 619 __le16 reserved1;
b481de9c
ZY		 620 u8 add_immediate_ba_tid;
621 u8 remove_immediate_ba_tid;
622 __le16 add_immediate_ba_ssn;
b481de9c 623 __le32 reserved2;
b481de9c
ZY		 624} __attribute__ ((packed));
625
626/*
627 * REPLY_ADD_STA = 0x18 (response)
628 */
bb8c093b 629struct iwl4965_add_sta_resp {
b481de9c
ZY		 630 u8 status;
631} __attribute__ ((packed));
632
633#define ADD_STA_SUCCESS_MSK 0x1
634
635/******************************************************************************
636 * (4)
637 * Rx Responses:
638 *
639 *****************************************************************************/
640
bb8c093b 641struct iwl4965_rx_frame_stats {
b481de9c
ZY		 642 u8 phy_count;
643 u8 id;
644 u8 rssi;
645 u8 agc;
646 __le16 sig_avg;
647 __le16 noise_diff;
648 u8 payload[0];
649} __attribute__ ((packed));
650
bb8c093b 651struct iwl4965_rx_frame_hdr {
b481de9c
ZY		 652 __le16 channel;
653 __le16 phy_flags;
654 u8 reserved1;
655 u8 rate;
656 __le16 len;
657 u8 payload[0];
658} __attribute__ ((packed));
659
660#define RX_RES_STATUS_NO_CRC32_ERROR __constant_cpu_to_le32(1 << 0)
661#define RX_RES_STATUS_NO_RXE_OVERFLOW __constant_cpu_to_le32(1 << 1)
662
663#define RX_RES_PHY_FLAGS_BAND_24_MSK __constant_cpu_to_le16(1 << 0)
664#define RX_RES_PHY_FLAGS_MOD_CCK_MSK __constant_cpu_to_le16(1 << 1)
665#define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK __constant_cpu_to_le16(1 << 2)
666#define RX_RES_PHY_FLAGS_NARROW_BAND_MSK __constant_cpu_to_le16(1 << 3)
667#define RX_RES_PHY_FLAGS_ANTENNA_MSK __constant_cpu_to_le16(0xf0)
668
669#define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)
670#define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)
671#define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)
672#define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)
673#define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)
674
675#define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)
676#define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)
677#define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)
678#define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)
679#define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)
680
bb8c093b 681struct iwl4965_rx_frame_end {
b481de9c
ZY		 682 __le32 status;
683 __le64 timestamp;
684 __le32 beacon_timestamp;
685} __attribute__ ((packed));
686
687/*
688 * REPLY_3945_RX = 0x1b (response only, not a command)
689 *
690 * NOTE: DO NOT dereference from casts to this structure
691 * It is provided only for calculating minimum data set size.
692 * The actual offsets of the hdr and end are dynamic based on
693 * stats.phy_count
694 */
bb8c093b
CH		 695struct iwl4965_rx_frame {
696 struct iwl4965_rx_frame_stats stats;
697 struct iwl4965_rx_frame_hdr hdr;
698 struct iwl4965_rx_frame_end end;
b481de9c
ZY		 699} __attribute__ ((packed));
700
701/* Fixed (non-configurable) rx data from phy */
702#define RX_PHY_FLAGS_ANTENNAE_OFFSET (4)
703#define RX_PHY_FLAGS_ANTENNAE_MASK (0x70)
704#define IWL_AGC_DB_MASK (0x3f80) /* MASK(7,13) */
705#define IWL_AGC_DB_POS (7)
706struct iwl4965_rx_non_cfg_phy {
707 __le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */
708 __le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */
709 u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */
710 u8 pad[0];
711} __attribute__ ((packed));
712
713/*
714 * REPLY_4965_RX = 0xc3 (response only, not a command)
715 * Used only for legacy (non 11n) frames.
716 */
717#define RX_RES_PHY_CNT 14
718struct iwl4965_rx_phy_res {
719 u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */
720 u8 cfg_phy_cnt; /* configurable DSP phy data byte count */
721 u8 stat_id; /* configurable DSP phy data set ID */
722 u8 reserved1;
723 __le64 timestamp; /* TSF at on air rise */
724 __le32 beacon_time_stamp; /* beacon at on-air rise */
725 __le16 phy_flags; /* general phy flags: band, modulation, ... */
726 __le16 channel; /* channel number */
727 __le16 non_cfg_phy[RX_RES_PHY_CNT]; /* upto 14 phy entries */
728 __le32 reserved2;
729 __le32 rate_n_flags;
730 __le16 byte_count; /* frame's byte-count */
731 __le16 reserved3;
732} __attribute__ ((packed));
733
734struct iwl4965_rx_mpdu_res_start {
735 __le16 byte_count;
736 __le16 reserved;
737} __attribute__ ((packed));
738
739
740/******************************************************************************
741 * (5)
742 * Tx Commands & Responses:
743 *
744 *****************************************************************************/
745
746/* Tx flags */
747#define TX_CMD_FLG_RTS_MSK __constant_cpu_to_le32(1 << 1)
748#define TX_CMD_FLG_CTS_MSK __constant_cpu_to_le32(1 << 2)
749#define TX_CMD_FLG_ACK_MSK __constant_cpu_to_le32(1 << 3)
750#define TX_CMD_FLG_STA_RATE_MSK __constant_cpu_to_le32(1 << 4)
751#define TX_CMD_FLG_IMM_BA_RSP_MASK __constant_cpu_to_le32(1 << 6)
752#define TX_CMD_FLG_FULL_TXOP_PROT_MSK __constant_cpu_to_le32(1 << 7)
753#define TX_CMD_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0xf00)
754#define TX_CMD_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8)
755#define TX_CMD_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9)
756
757/* ucode ignores BT priority for this frame */
758#define TX_CMD_FLG_BT_DIS_MSK __constant_cpu_to_le32(1 << 12)
759
760/* ucode overrides sequence control */
761#define TX_CMD_FLG_SEQ_CTL_MSK __constant_cpu_to_le32(1 << 13)
762
763/* signal that this frame is non-last MPDU */
764#define TX_CMD_FLG_MORE_FRAG_MSK __constant_cpu_to_le32(1 << 14)
765
766/* calculate TSF in outgoing frame */
767#define TX_CMD_FLG_TSF_MSK __constant_cpu_to_le32(1 << 16)
768
769/* activate TX calibration. */
770#define TX_CMD_FLG_CALIB_MSK __constant_cpu_to_le32(1 << 17)
771
772/* signals that 2 bytes pad was inserted
773 after the MAC header */
774#define TX_CMD_FLG_MH_PAD_MSK __constant_cpu_to_le32(1 << 20)
775
776/* HCCA-AP - disable duration overwriting. */
777#define TX_CMD_FLG_DUR_MSK __constant_cpu_to_le32(1 << 25)
778
779/*
780 * TX command security control
781 */
782#define TX_CMD_SEC_WEP 0x01
783#define TX_CMD_SEC_CCM 0x02
784#define TX_CMD_SEC_TKIP 0x03
785#define TX_CMD_SEC_MSK 0x03
786#define TX_CMD_SEC_SHIFT 6
787#define TX_CMD_SEC_KEY128 0x08
788
789/*
790 * TX command Frame life time
791 */
792
bb8c093b 793struct iwl4965_dram_scratch {
b481de9c
ZY		 794 u8 try_cnt;
795 u8 bt_kill_cnt;
796 __le16 reserved;
797} __attribute__ ((packed));
798
799/*
800 * REPLY_TX = 0x1c (command)
801 */
bb8c093b 802struct iwl4965_tx_cmd {
b481de9c
ZY		 803 __le16 len;
804 __le16 next_frame_len;
805 __le32 tx_flags;
bb8c093b 806 struct iwl4965_dram_scratch scratch;
b481de9c
ZY		 807 __le32 rate_n_flags;
808 u8 sta_id;
b481de9c 809 u8 sec_ctl;
b481de9c
ZY		 810 u8 initial_rate_index;
811 u8 reserved;
b481de9c 812 u8 key[16];
b481de9c
ZY		 813 __le16 next_frame_flags;
814 __le16 reserved2;
b481de9c
ZY		 815 union {
816 __le32 life_time;
817 __le32 attempt;
818 } stop_time;
b481de9c
ZY		 819 __le32 dram_lsb_ptr;
820 u8 dram_msb_ptr;
b481de9c
ZY		 821 u8 rts_retry_limit; /*byte 50 */
822 u8 data_retry_limit; /*byte 51 */
b481de9c 823 u8 tid_tspec;
b481de9c
ZY		 824 union {
825 __le16 pm_frame_timeout;
826 __le16 attempt_duration;
827 } timeout;
828 __le16 driver_txop;
829 u8 payload[0];
830 struct ieee80211_hdr hdr[0];
831} __attribute__ ((packed));
832
833/* TX command response is sent after *all* transmission attempts.
834 *
835 * NOTES:
836 *
837 * TX_STATUS_FAIL_NEXT_FRAG
838 *
839 * If the fragment flag in the MAC header for the frame being transmitted
840 * is set and there is insufficient time to transmit the next frame, the
841 * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
842 *
843 * TX_STATUS_FIFO_UNDERRUN
844 *
845 * Indicates the host did not provide bytes to the FIFO fast enough while
846 * a TX was in progress.
847 *
848 * TX_STATUS_FAIL_MGMNT_ABORT
849 *
850 * This status is only possible if the ABORT ON MGMT RX parameter was
851 * set to true with the TX command.
852 *
853 * If the MSB of the status parameter is set then an abort sequence is
854 * required. This sequence consists of the host activating the TX Abort
855 * control line, and then waiting for the TX Abort command response. This
856 * indicates that a the device is no longer in a transmit state, and that the
857 * command FIFO has been cleared. The host must then deactivate the TX Abort
858 * control line. Receiving is still allowed in this case.
859 */
860enum {
861 TX_STATUS_SUCCESS = 0x01,
862 TX_STATUS_DIRECT_DONE = 0x02,
863 TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
864 TX_STATUS_FAIL_LONG_LIMIT = 0x83,
865 TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
866 TX_STATUS_FAIL_MGMNT_ABORT = 0x85,
867 TX_STATUS_FAIL_NEXT_FRAG = 0x86,
868 TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
869 TX_STATUS_FAIL_DEST_PS = 0x88,
870 TX_STATUS_FAIL_ABORTED = 0x89,
871 TX_STATUS_FAIL_BT_RETRY = 0x8a,
872 TX_STATUS_FAIL_STA_INVALID = 0x8b,
873 TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
874 TX_STATUS_FAIL_TID_DISABLE = 0x8d,
875 TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
876 TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
877 TX_STATUS_FAIL_TX_LOCKED = 0x90,
878 TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
879};
880
881#define TX_PACKET_MODE_REGULAR 0x0000
882#define TX_PACKET_MODE_BURST_SEQ 0x0100
883#define TX_PACKET_MODE_BURST_FIRST 0x0200
884
885enum {
886 TX_POWER_PA_NOT_ACTIVE = 0x0,
887};
888
889enum {
890 TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */
891 TX_STATUS_DELAY_MSK = 0x00000040,
892 TX_STATUS_ABORT_MSK = 0x00000080,
893 TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */
894 TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */
895 TX_RESERVED = 0x00780000, /* bits 19:22 */
896 TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */
897 TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */
898};
899
900/* *******************************
901 * TX aggregation state
902 ******************************* */
903
904enum {
905 AGG_TX_STATE_TRANSMITTED = 0x00,
906 AGG_TX_STATE_UNDERRUN_MSK = 0x01,
907 AGG_TX_STATE_BT_PRIO_MSK = 0x02,
908 AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
909 AGG_TX_STATE_ABORT_MSK = 0x08,
910 AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
911 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
912 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
913 AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
914 AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
915 AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
916 AGG_TX_STATE_DUMP_TX_MSK = 0x200,
917 AGG_TX_STATE_DELAY_TX_MSK = 0x400
918};
919
920#define AGG_TX_STATE_LAST_SENT_MSK \
921(AGG_TX_STATE_LAST_SENT_TTL_MSK | \
922 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
923 AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
924
925#define AGG_TX_STATE_TRY_CNT_POS 12
926#define AGG_TX_STATE_TRY_CNT_MSK 0xf000
927
928#define AGG_TX_STATE_SEQ_NUM_POS 16
929#define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
930
931/*
932 * REPLY_TX = 0x1c (response)
933 */
bb8c093b 934struct iwl4965_tx_resp {
b481de9c
ZY		 935 u8 frame_count; /* 1 no aggregation, >1 aggregation */
936 u8 bt_kill_count;
937 u8 failure_rts;
938 u8 failure_frame;
939 __le32 rate_n_flags;
940 __le16 wireless_media_time;
941 __le16 reserved;
942 __le32 pa_power1;
943 __le32 pa_power2;
944 __le32 status; /* TX status (for aggregation status of 1st frame) */
945} __attribute__ ((packed));
946
b481de9c
ZY		 947/*
948 * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
949 */
bb8c093b 950struct iwl4965_compressed_ba_resp {
b481de9c
ZY		 951 __le32 sta_addr_lo32;
952 __le16 sta_addr_hi16;
953 __le16 reserved;
954 u8 sta_id;
955 u8 tid;
956 __le16 ba_seq_ctl;
957 __le32 ba_bitmap0;
958 __le32 ba_bitmap1;
959 __le16 scd_flow;
960 __le16 scd_ssn;
961} __attribute__ ((packed));
962
963/*
964 * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
965 */
bb8c093b 966struct iwl4965_txpowertable_cmd {
b481de9c
ZY		 967 u8 band; /* 0: 5 GHz, 1: 2.4 GHz */
968 u8 reserved;
969 __le16 channel;
bb8c093b 970 struct iwl4965_tx_power_db tx_power;
b481de9c
ZY		 971} __attribute__ ((packed));
972
b481de9c
ZY		 973/*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
974#define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1<<0)
975
976#define LINK_QUAL_AC_NUM AC_NUM
977#define LINK_QUAL_MAX_RETRY_NUM 16
978
979#define LINK_QUAL_ANT_A_MSK (1<<0)
980#define LINK_QUAL_ANT_B_MSK (1<<1)
981#define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
982
bb8c093b 983struct iwl4965_link_qual_general_params {
b481de9c
ZY		 984 u8 flags;
985 u8 mimo_delimiter;
986 u8 single_stream_ant_msk;
987 u8 dual_stream_ant_msk;
988 u8 start_rate_index[LINK_QUAL_AC_NUM];
989} __attribute__ ((packed));
990
bb8c093b 991struct iwl4965_link_qual_agg_params {
b481de9c
ZY		 992 __le16 agg_time_limit;
993 u8 agg_dis_start_th;
994 u8 agg_frame_cnt_limit;
995 __le32 reserved;
996} __attribute__ ((packed));
997
998/*
999 * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
1000 */
bb8c093b 1001struct iwl4965_link_quality_cmd {
b481de9c
ZY		 1002 u8 sta_id;
1003 u8 reserved1;
1004 __le16 control;
bb8c093b
CH		 1005 struct iwl4965_link_qual_general_params general_params;
1006 struct iwl4965_link_qual_agg_params agg_params;
b481de9c
ZY		 1007 struct {
1008 __le32 rate_n_flags;
1009 } rs_table[LINK_QUAL_MAX_RETRY_NUM];
1010 __le32 reserved2;
1011} __attribute__ ((packed));
b481de9c
ZY		 1012
1013/*
1014 * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
1015 */
bb8c093b 1016struct iwl4965_bt_cmd {
b481de9c
ZY		 1017 u8 flags;
1018 u8 lead_time;
1019 u8 max_kill;
1020 u8 reserved;
1021 __le32 kill_ack_mask;
1022 __le32 kill_cts_mask;
1023} __attribute__ ((packed));
1024
1025/******************************************************************************
1026 * (6)
1027 * Spectrum Management (802.11h) Commands, Responses, Notifications:
1028 *
1029 *****************************************************************************/
1030
1031/*
1032 * Spectrum Management
1033 */
1034#define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \
1035 RXON_FILTER_CTL2HOST_MSK | \
1036 RXON_FILTER_ACCEPT_GRP_MSK | \
1037 RXON_FILTER_DIS_DECRYPT_MSK | \
1038 RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
1039 RXON_FILTER_ASSOC_MSK | \
1040 RXON_FILTER_BCON_AWARE_MSK)
1041
bb8c093b 1042struct iwl4965_measure_channel {
b481de9c
ZY		 1043 __le32 duration; /* measurement duration in extended beacon
1044 * format */
1045 u8 channel; /* channel to measure */
bb8c093b 1046 u8 type; /* see enum iwl4965_measure_type */
b481de9c
ZY		 1047 __le16 reserved;
1048} __attribute__ ((packed));
1049
1050/*
1051 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
1052 */
bb8c093b 1053struct iwl4965_spectrum_cmd {
b481de9c
ZY		 1054 __le16 len; /* number of bytes starting from token */
1055 u8 token; /* token id */
1056 u8 id; /* measurement id -- 0 or 1 */
1057 u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */
1058 u8 periodic; /* 1 = periodic */
1059 __le16 path_loss_timeout;
1060 __le32 start_time; /* start time in extended beacon format */
1061 __le32 reserved2;
1062 __le32 flags; /* rxon flags */
1063 __le32 filter_flags; /* rxon filter flags */
1064 __le16 channel_count; /* minimum 1, maximum 10 */
1065 __le16 reserved3;
bb8c093b 1066 struct iwl4965_measure_channel channels[10];
b481de9c
ZY		 1067} __attribute__ ((packed));
1068
1069/*
1070 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
1071 */
bb8c093b 1072struct iwl4965_spectrum_resp {
b481de9c
ZY		 1073 u8 token;
1074 u8 id; /* id of the prior command replaced, or 0xff */
1075 __le16 status; /* 0 - command will be handled
1076 * 1 - cannot handle (conflicts with another
1077 * measurement) */
1078} __attribute__ ((packed));
1079
bb8c093b 1080enum iwl4965_measurement_state {
b481de9c
ZY		 1081 IWL_MEASUREMENT_START = 0,
1082 IWL_MEASUREMENT_STOP = 1,
1083};
1084
bb8c093b 1085enum iwl4965_measurement_status {
b481de9c
ZY		 1086 IWL_MEASUREMENT_OK = 0,
1087 IWL_MEASUREMENT_CONCURRENT = 1,
1088 IWL_MEASUREMENT_CSA_CONFLICT = 2,
1089 IWL_MEASUREMENT_TGH_CONFLICT = 3,
1090 /* 4-5 reserved */
1091 IWL_MEASUREMENT_STOPPED = 6,
1092 IWL_MEASUREMENT_TIMEOUT = 7,
1093 IWL_MEASUREMENT_PERIODIC_FAILED = 8,
1094};
1095
1096#define NUM_ELEMENTS_IN_HISTOGRAM 8
1097
bb8c093b 1098struct iwl4965_measurement_histogram {
b481de9c
ZY		 1099 __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
1100 __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */
1101} __attribute__ ((packed));
1102
1103/* clear channel availability counters */
bb8c093b 1104struct iwl4965_measurement_cca_counters {
b481de9c
ZY		 1105 __le32 ofdm;
1106 __le32 cck;
1107} __attribute__ ((packed));
1108
bb8c093b 1109enum iwl4965_measure_type {
b481de9c
ZY		 1110 IWL_MEASURE_BASIC = (1 << 0),
1111 IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
1112 IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
1113 IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
1114 IWL_MEASURE_FRAME = (1 << 4),
1115 /* bits 5:6 are reserved */
1116 IWL_MEASURE_IDLE = (1 << 7),
1117};
1118
1119/*
1120 * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
1121 */
bb8c093b 1122struct iwl4965_spectrum_notification {
b481de9c
ZY		 1123 u8 id; /* measurement id -- 0 or 1 */
1124 u8 token;
1125 u8 channel_index; /* index in measurement channel list */
1126 u8 state; /* 0 - start, 1 - stop */
1127 __le32 start_time; /* lower 32-bits of TSF */
1128 u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */
1129 u8 channel;
bb8c093b 1130 u8 type; /* see enum iwl4965_measurement_type */
b481de9c
ZY		 1131 u8 reserved1;
1132 /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only
1133 * valid if applicable for measurement type requested. */
1134 __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */
1135 __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */
1136 __le32 cca_time; /* channel load time in usecs */
1137 u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 -
1138 * unidentified */
1139 u8 reserved2[3];
bb8c093b 1140 struct iwl4965_measurement_histogram histogram;
b481de9c 1141 __le32 stop_time; /* lower 32-bits of TSF */
bb8c093b 1142 __le32 status; /* see iwl4965_measurement_status */
b481de9c
ZY		 1143} __attribute__ ((packed));
1144
1145/******************************************************************************
1146 * (7)
1147 * Power Management Commands, Responses, Notifications:
1148 *
1149 *****************************************************************************/
1150
1151/**
bb8c093b 1152 * struct iwl4965_powertable_cmd - Power Table Command
b481de9c
ZY		 1153 * @flags: See below:
1154 *
1155 * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
1156 *
1157 * PM allow:
1158 * bit 0 - '0' Driver not allow power management
1159 * '1' Driver allow PM (use rest of parameters)
1160 * uCode send sleep notifications:
1161 * bit 1 - '0' Don't send sleep notification
1162 * '1' send sleep notification (SEND_PM_NOTIFICATION)
1163 * Sleep over DTIM
1164 * bit 2 - '0' PM have to walk up every DTIM
1165 * '1' PM could sleep over DTIM till listen Interval.
1166 * PCI power managed
1167 * bit 3 - '0' (PCI_LINK_CTRL & 0x1)
1168 * '1' !(PCI_LINK_CTRL & 0x1)
1169 * Force sleep Modes
1170 * bit 31/30- '00' use both mac/xtal sleeps
1171 * '01' force Mac sleep
1172 * '10' force xtal sleep
1173 * '11' Illegal set
1174 *
1175 * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
1176 * ucode assume sleep over DTIM is allowed and we don't need to wakeup
1177 * for every DTIM.
1178 */
1179#define IWL_POWER_VEC_SIZE 5
1180
b481de9c
ZY		 1181#define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK __constant_cpu_to_le16(1<<0)
1182#define IWL_POWER_SLEEP_OVER_DTIM_MSK __constant_cpu_to_le16(1<<2)
1183#define IWL_POWER_PCI_PM_MSK __constant_cpu_to_le16(1<<3)
1184
bb8c093b 1185struct iwl4965_powertable_cmd {
b481de9c
ZY		 1186 __le16 flags;
1187 u8 keep_alive_seconds;
1188 u8 debug_flags;
1189 __le32 rx_data_timeout;
1190 __le32 tx_data_timeout;
1191 __le32 sleep_interval[IWL_POWER_VEC_SIZE];
1192 __le32 keep_alive_beacons;
1193} __attribute__ ((packed));
b481de9c
ZY		 1194
1195/*
1196 * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
1197 * 3945 and 4965 identical.
1198 */
bb8c093b 1199struct iwl4965_sleep_notification {
b481de9c
ZY		 1200 u8 pm_sleep_mode;
1201 u8 pm_wakeup_src;
1202 __le16 reserved;
1203 __le32 sleep_time;
1204 __le32 tsf_low;
1205 __le32 bcon_timer;
1206} __attribute__ ((packed));
1207
1208/* Sleep states. 3945 and 4965 identical. */
1209enum {
1210 IWL_PM_NO_SLEEP = 0,
1211 IWL_PM_SLP_MAC = 1,
1212 IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
1213 IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
1214 IWL_PM_SLP_PHY = 4,
1215 IWL_PM_SLP_REPENT = 5,
1216 IWL_PM_WAKEUP_BY_TIMER = 6,
1217 IWL_PM_WAKEUP_BY_DRIVER = 7,
1218 IWL_PM_WAKEUP_BY_RFKILL = 8,
1219 /* 3 reserved */
1220 IWL_PM_NUM_OF_MODES = 12,
1221};
1222
1223/*
1224 * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
1225 */
1226#define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */
1227#define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */
1228#define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */
bb8c093b 1229struct iwl4965_card_state_cmd {
b481de9c
ZY		 1230 __le32 status; /* CARD_STATE_CMD_* request new power state */
1231} __attribute__ ((packed));
1232
1233/*
1234 * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
1235 */
bb8c093b 1236struct iwl4965_card_state_notif {
b481de9c
ZY		 1237 __le32 flags;
1238} __attribute__ ((packed));
1239
1240#define HW_CARD_DISABLED 0x01
1241#define SW_CARD_DISABLED 0x02
1242#define RF_CARD_DISABLED 0x04
1243#define RXON_CARD_DISABLED 0x10
1244
bb8c093b 1245struct iwl4965_ct_kill_config {
b481de9c
ZY		 1246 __le32 reserved;
1247 __le32 critical_temperature_M;
1248 __le32 critical_temperature_R;
1249} __attribute__ ((packed));
1250
1251/******************************************************************************
1252 * (8)
1253 * Scan Commands, Responses, Notifications:
1254 *
1255 *****************************************************************************/
1256
bb8c093b 1257struct iwl4965_scan_channel {
b481de9c
ZY		 1258 /* type is defined as:
1259 * 0:0 active (0 - passive)
1260 * 1:4 SSID direct
1261 * If 1 is set then corresponding SSID IE is transmitted in probe
1262 * 5:7 reserved
1263 */
1264 u8 type;
1265 u8 channel;
bb8c093b 1266 struct iwl4965_tx_power tpc;
b481de9c
ZY		 1267 __le16 active_dwell;
1268 __le16 passive_dwell;
1269} __attribute__ ((packed));
1270
bb8c093b 1271struct iwl4965_ssid_ie {
b481de9c
ZY		 1272 u8 id;
1273 u8 len;
1274 u8 ssid[32];
1275} __attribute__ ((packed));
1276
1277#define PROBE_OPTION_MAX 0x4
1278#define TX_CMD_LIFE_TIME_INFINITE __constant_cpu_to_le32(0xFFFFFFFF)
1279#define IWL_GOOD_CRC_TH __constant_cpu_to_le16(1)
1280#define IWL_MAX_SCAN_SIZE 1024
1281
1282/*
1283 * REPLY_SCAN_CMD = 0x80 (command)
1284 */
bb8c093b 1285struct iwl4965_scan_cmd {
b481de9c
ZY		 1286 __le16 len;
1287 u8 reserved0;
1288 u8 channel_count;
1289 __le16 quiet_time; /* dwell only this long on quiet chnl
1290 * (active scan) */
1291 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
1292 __le16 good_CRC_th; /* passive -> active promotion threshold */
b481de9c 1293 __le16 rx_chain;
b481de9c
ZY		 1294 __le32 max_out_time; /* max usec to be out of associated (service)
1295 * chnl */
1296 __le32 suspend_time; /* pause scan this long when returning to svc
1297 * chnl.
1298 * 3945 -- 31:24 # beacons, 19:0 additional usec,
1299 * 4965 -- 31:22 # beacons, 21:0 additional usec.
1300 */
1301 __le32 flags;
1302 __le32 filter_flags;
1303
bb8c093b
CH		 1304 struct iwl4965_tx_cmd tx_cmd;
1305 struct iwl4965_ssid_ie direct_scan[PROBE_OPTION_MAX];
b481de9c
ZY		 1306
1307 u8 data[0];
1308 /*
1309 * The channels start after the probe request payload and are of type:
1310 *
bb8c093b 1311 * struct iwl4965_scan_channel channels[0];
b481de9c
ZY		 1312 *
1313 * NOTE: Only one band of channels can be scanned per pass. You
1314 * can not mix 2.4GHz channels and 5.2GHz channels and must
1315 * request a scan multiple times (not concurrently)
1316 *
1317 */
1318} __attribute__ ((packed));
1319
1320/* Can abort will notify by complete notification with abort status. */
1321#define CAN_ABORT_STATUS __constant_cpu_to_le32(0x1)
1322/* complete notification statuses */
1323#define ABORT_STATUS 0x2
1324
1325/*
1326 * REPLY_SCAN_CMD = 0x80 (response)
1327 */
bb8c093b 1328struct iwl4965_scanreq_notification {
b481de9c
ZY		 1329 __le32 status; /* 1: okay, 2: cannot fulfill request */
1330} __attribute__ ((packed));
1331
1332/*
1333 * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
1334 */
bb8c093b 1335struct iwl4965_scanstart_notification {
b481de9c
ZY		 1336 __le32 tsf_low;
1337 __le32 tsf_high;
1338 __le32 beacon_timer;
1339 u8 channel;
1340 u8 band;
1341 u8 reserved[2];
1342 __le32 status;
1343} __attribute__ ((packed));
1344
1345#define SCAN_OWNER_STATUS 0x1;
1346#define MEASURE_OWNER_STATUS 0x2;
1347
1348#define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */
1349/*
1350 * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
1351 */
bb8c093b 1352struct iwl4965_scanresults_notification {
b481de9c
ZY		 1353 u8 channel;
1354 u8 band;
1355 u8 reserved[2];
1356 __le32 tsf_low;
1357 __le32 tsf_high;
1358 __le32 statistics[NUMBER_OF_STATISTICS];
1359} __attribute__ ((packed));
1360
1361/*
1362 * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
1363 */
bb8c093b 1364struct iwl4965_scancomplete_notification {
b481de9c
ZY		 1365 u8 scanned_channels;
1366 u8 status;
1367 u8 reserved;
1368 u8 last_channel;
1369 __le32 tsf_low;
1370 __le32 tsf_high;
1371} __attribute__ ((packed));
1372
1373
1374/******************************************************************************
1375 * (9)
1376 * IBSS/AP Commands and Notifications:
1377 *
1378 *****************************************************************************/
1379
1380/*
1381 * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
1382 */
bb8c093b
CH		 1383struct iwl4965_beacon_notif {
1384 struct iwl4965_tx_resp beacon_notify_hdr;
b481de9c
ZY		 1385 __le32 low_tsf;
1386 __le32 high_tsf;
1387 __le32 ibss_mgr_status;
1388} __attribute__ ((packed));
1389
1390/*
1391 * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
1392 */
bb8c093b
CH		 1393struct iwl4965_tx_beacon_cmd {
1394 struct iwl4965_tx_cmd tx;
b481de9c
ZY		 1395 __le16 tim_idx;
1396 u8 tim_size;
1397 u8 reserved1;
1398 struct ieee80211_hdr frame[0]; /* beacon frame */
1399} __attribute__ ((packed));
1400
1401/******************************************************************************
1402 * (10)
1403 * Statistics Commands and Notifications:
1404 *
1405 *****************************************************************************/
1406
1407#define IWL_TEMP_CONVERT 260
1408
1409#define SUP_RATE_11A_MAX_NUM_CHANNELS 8
1410#define SUP_RATE_11B_MAX_NUM_CHANNELS 4
1411#define SUP_RATE_11G_MAX_NUM_CHANNELS 12
1412
1413/* Used for passing to driver number of successes and failures per rate */
1414struct rate_histogram {
1415 union {
1416 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
1417 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
1418 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
1419 } success;
1420 union {
1421 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
1422 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
1423 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
1424 } failed;
1425} __attribute__ ((packed));
1426
1427/* statistics command response */
1428
1429struct statistics_rx_phy {
1430 __le32 ina_cnt;
1431 __le32 fina_cnt;
1432 __le32 plcp_err;
1433 __le32 crc32_err;
1434 __le32 overrun_err;
1435 __le32 early_overrun_err;
1436 __le32 crc32_good;
1437 __le32 false_alarm_cnt;
1438 __le32 fina_sync_err_cnt;
1439 __le32 sfd_timeout;
1440 __le32 fina_timeout;
1441 __le32 unresponded_rts;
1442 __le32 rxe_frame_limit_overrun;
1443 __le32 sent_ack_cnt;
1444 __le32 sent_cts_cnt;
b481de9c
ZY		 1445 __le32 sent_ba_rsp_cnt;
1446 __le32 dsp_self_kill;
1447 __le32 mh_format_err;
1448 __le32 re_acq_main_rssi_sum;
1449 __le32 reserved3;
b481de9c
ZY		 1450} __attribute__ ((packed));
1451
b481de9c
ZY		 1452struct statistics_rx_ht_phy {
1453 __le32 plcp_err;
1454 __le32 overrun_err;
1455 __le32 early_overrun_err;
1456 __le32 crc32_good;
1457 __le32 crc32_err;
1458 __le32 mh_format_err;
1459 __le32 agg_crc32_good;
1460 __le32 agg_mpdu_cnt;
1461 __le32 agg_cnt;
1462 __le32 reserved2;
1463} __attribute__ ((packed));
b481de9c
ZY		 1464
1465struct statistics_rx_non_phy {
1466 __le32 bogus_cts; /* CTS received when not expecting CTS */
1467 __le32 bogus_ack; /* ACK received when not expecting ACK */
1468 __le32 non_bssid_frames; /* number of frames with BSSID that
1469 * doesn't belong to the STA BSSID */
1470 __le32 filtered_frames; /* count frames that were dumped in the
1471 * filtering process */
1472 __le32 non_channel_beacons; /* beacons with our bss id but not on
1473 * our serving channel */
b481de9c
ZY		 1474 __le32 channel_beacons; /* beacons with our bss id and in our
1475 * serving channel */
1476 __le32 num_missed_bcon; /* number of missed beacons */
1477 __le32 adc_rx_saturation_time; /* count in 0.8us units the time the
1478 * ADC was in saturation */
1479 __le32 ina_detection_search_time;/* total time (in 0.8us) searched
1480 * for INA */
1481 __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */
1482 __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */
1483 __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */
1484 __le32 interference_data_flag; /* flag for interference data
1485 * availability. 1 when data is
1486 * available. */
1487 __le32 channel_load; /* counts RX Enable time */
1488 __le32 dsp_false_alarms; /* DSP false alarm (both OFDM
1489 * and CCK) counter */
1490 __le32 beacon_rssi_a;
1491 __le32 beacon_rssi_b;
1492 __le32 beacon_rssi_c;
1493 __le32 beacon_energy_a;
1494 __le32 beacon_energy_b;
1495 __le32 beacon_energy_c;
b481de9c
ZY		 1496} __attribute__ ((packed));
1497
1498struct statistics_rx {
1499 struct statistics_rx_phy ofdm;
1500 struct statistics_rx_phy cck;
1501 struct statistics_rx_non_phy general;
b481de9c 1502 struct statistics_rx_ht_phy ofdm_ht;
b481de9c
ZY		 1503} __attribute__ ((packed));
1504
b481de9c
ZY		 1505struct statistics_tx_non_phy_agg {
1506 __le32 ba_timeout;
1507 __le32 ba_reschedule_frames;
1508 __le32 scd_query_agg_frame_cnt;
1509 __le32 scd_query_no_agg;
1510 __le32 scd_query_agg;
1511 __le32 scd_query_mismatch;
1512 __le32 frame_not_ready;
1513 __le32 underrun;
1514 __le32 bt_prio_kill;
1515 __le32 rx_ba_rsp_cnt;
1516 __le32 reserved2;
1517 __le32 reserved3;
1518} __attribute__ ((packed));
b481de9c
ZY		 1519
1520struct statistics_tx {
1521 __le32 preamble_cnt;
1522 __le32 rx_detected_cnt;
1523 __le32 bt_prio_defer_cnt;
1524 __le32 bt_prio_kill_cnt;
1525 __le32 few_bytes_cnt;
1526 __le32 cts_timeout;
1527 __le32 ack_timeout;
1528 __le32 expected_ack_cnt;
1529 __le32 actual_ack_cnt;
b481de9c
ZY		 1530 __le32 dump_msdu_cnt;
1531 __le32 burst_abort_next_frame_mismatch_cnt;
1532 __le32 burst_abort_missing_next_frame_cnt;
1533 __le32 cts_timeout_collision;
1534 __le32 ack_or_ba_timeout_collision;
1535 struct statistics_tx_non_phy_agg agg;
b481de9c
ZY		 1536} __attribute__ ((packed));
1537
1538struct statistics_dbg {
1539 __le32 burst_check;
1540 __le32 burst_count;
1541 __le32 reserved[4];
1542} __attribute__ ((packed));
1543
1544struct statistics_div {
1545 __le32 tx_on_a;
1546 __le32 tx_on_b;
1547 __le32 exec_time;
1548 __le32 probe_time;
b481de9c
ZY		 1549 __le32 reserved1;
1550 __le32 reserved2;
b481de9c
ZY		 1551} __attribute__ ((packed));
1552
1553struct statistics_general {
1554 __le32 temperature;
b481de9c 1555 __le32 temperature_m;
b481de9c
ZY		 1556 struct statistics_dbg dbg;
1557 __le32 sleep_time;
1558 __le32 slots_out;
1559 __le32 slots_idle;
1560 __le32 ttl_timestamp;
1561 struct statistics_div div;
b481de9c
ZY		 1562 __le32 rx_enable_counter;
1563 __le32 reserved1;
1564 __le32 reserved2;
1565 __le32 reserved3;
b481de9c
ZY		 1566} __attribute__ ((packed));
1567
1568/*
1569 * REPLY_STATISTICS_CMD = 0x9c,
1570 * 3945 and 4965 identical.
1571 *
1572 * This command triggers an immediate response containing uCode statistics.
1573 * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
1574 *
1575 * If the CLEAR_STATS configuration flag is set, uCode will clear its
1576 * internal copy of the statistics (counters) after issuing the response.
1577 * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
1578 *
1579 * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
1580 * STATISTICS_NOTIFICATIONs after received beacons (see below). This flag
1581 * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
1582 */
1583#define IWL_STATS_CONF_CLEAR_STATS __constant_cpu_to_le32(0x1) /* see above */
1584#define IWL_STATS_CONF_DISABLE_NOTIF __constant_cpu_to_le32(0x2)/* see above */
bb8c093b 1585struct iwl4965_statistics_cmd {
b481de9c
ZY		 1586 __le32 configuration_flags; /* IWL_STATS_CONF_* */
1587} __attribute__ ((packed));
1588
1589/*
1590 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
1591 *
1592 * By default, uCode issues this notification after receiving a beacon
1593 * while associated. To disable this behavior, set DISABLE_NOTIF flag in the
1594 * REPLY_STATISTICS_CMD 0x9c, above.
1595 *
1596 * Statistics counters continue to increment beacon after beacon, but are
1597 * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
1598 * 0x9c with CLEAR_STATS bit set (see above).
1599 *
1600 * uCode also issues this notification during scans. uCode clears statistics
1601 * appropriately so that each notification contains statistics for only the
1602 * one channel that has just been scanned.
1603 */
1604#define STATISTICS_REPLY_FLG_BAND_24G_MSK __constant_cpu_to_le32(0x2)
1605#define STATISTICS_REPLY_FLG_FAT_MODE_MSK __constant_cpu_to_le32(0x8)
bb8c093b 1606struct iwl4965_notif_statistics {
b481de9c
ZY		 1607 __le32 flag;
1608 struct statistics_rx rx;
1609 struct statistics_tx tx;
1610 struct statistics_general general;
1611} __attribute__ ((packed));
1612
1613
1614/*
1615 * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
1616 */
1617/* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row,
1618 * then this notification will be sent. */
1619#define CONSECUTIVE_MISSED_BCONS_TH 20
1620
bb8c093b 1621struct iwl4965_missed_beacon_notif {
b481de9c
ZY		 1622 __le32 consequtive_missed_beacons;
1623 __le32 total_missed_becons;
1624 __le32 num_expected_beacons;
1625 __le32 num_recvd_beacons;
1626} __attribute__ ((packed));
1627
f7d09d7c 1628
b481de9c
ZY		 1629/******************************************************************************
1630 * (11)
1631 * Rx Calibration Commands:
1632 *
f7d09d7c
BC		 1633 * With the uCode used for open source drivers, most Tx calibration (except
1634 * for Tx Power) and most Rx calibration is done by uCode during the
1635 * "initialize" phase of uCode boot. Driver must calibrate only:
1636 *
1637 * 1) Tx power (depends on temperature), described elsewhere
1638 * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas)
1639 * 3) Receiver sensitivity (to optimize signal detection)
1640 *
b481de9c
ZY		 1641 *****************************************************************************/
1642
f7d09d7c
BC		 1643/**
1644 * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
1645 *
1646 * This command sets up the Rx signal detector for a sensitivity level that
1647 * is high enough to lock onto all signals within the associated network,
1648 * but low enough to ignore signals that are below a certain threshold, so as
1649 * not to have too many "false alarms". False alarms are signals that the
1650 * Rx DSP tries to lock onto, but then discards after determining that they
1651 * are noise.
1652 *
1653 * The optimum number of false alarms is between 5 and 50 per 200 TUs
1654 * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
1655 * time listening, not transmitting). Driver must adjust sensitivity so that
1656 * the ratio of actual false alarms to actual Rx time falls within this range.
1657 *
1658 * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
1659 * received beacon. These provide information to the driver to analyze the
1660 * sensitivity. Don't analyze statistics that come in from scanning, or any
1661 * other non-associated-network source. Pertinent statistics include:
1662 *
1663 * From "general" statistics (struct statistics_rx_non_phy):
1664 *
1665 * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
1666 * Measure of energy of desired signal. Used for establishing a level
1667 * below which the device does not detect signals.
1668 *
1669 * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
1670 * Measure of background noise in silent period after beacon.
1671 *
1672 * channel_load
1673 * uSecs of actual Rx time during beacon period (varies according to
1674 * how much time was spent transmitting).
1675 *
1676 * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
1677 *
1678 * false_alarm_cnt
1679 * Signal locks abandoned early (before phy-level header).
1680 *
1681 * plcp_err
1682 * Signal locks abandoned late (during phy-level header).
1683 *
1684 * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from
1685 * beacon to beacon, i.e. each value is an accumulation of all errors
1686 * before and including the latest beacon. Values will wrap around to 0
1687 * after counting up to 2^32 - 1. Driver must differentiate vs.
1688 * previous beacon's values to determine # false alarms in the current
1689 * beacon period.
1690 *
1691 * Total number of false alarms = false_alarms + plcp_errs
1692 *
1693 * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
1694 * (notice that the start points for OFDM are at or close to settings for
1695 * maximum sensitivity):
1696 *
1697 * START / MIN / MAX
1698 * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120
1699 * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210
1700 * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140
1701 * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270
1702 *
1703 * If actual rate of OFDM false alarms (+ plcp_errors) is too high
1704 * (greater than 50 for each 204.8 msecs listening), reduce sensitivity
1705 * by *adding* 1 to all 4 of the table entries above, up to the max for
1706 * each entry. Conversely, if false alarm rate is too low (less than 5
1707 * for each 204.8 msecs listening), *subtract* 1 from each entry to
1708 * increase sensitivity.
1709 *
1710 * For CCK sensitivity, keep track of the following:
1711 *
1712 * 1). 20-beacon history of maximum background noise, indicated by
1713 * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
1714 * 3 receivers. For any given beacon, the "silence reference" is
1715 * the maximum of last 60 samples (20 beacons * 3 receivers).
1716 *
1717 * 2). 10-beacon history of strongest signal level, as indicated
1718 * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
1719 * i.e. the strength of the signal through the best receiver at the
1720 * moment. These measurements are "upside down", with lower values
1721 * for stronger signals, so max energy will be *minimum* value.
1722 *
1723 * Then for any given beacon, the driver must determine the *weakest*
1724 * of the strongest signals; this is the minimum level that needs to be
1725 * successfully detected, when using the best receiver at the moment.
1726 * "Max cck energy" is the maximum (higher value means lower energy!)
1727 * of the last 10 minima. Once this is determined, driver must add
1728 * a little margin by adding "6" to it.
1729 *
1730 * 3). Number of consecutive beacon periods with too few false alarms.
1731 * Reset this to 0 at the first beacon period that falls within the
1732 * "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
1733 *
1734 * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
1735 * (notice that the start points for CCK are at maximum sensitivity):
1736 *
1737 * START / MIN / MAX
1738 * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200
1739 * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400
1740 * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100
1741 *
1742 * If actual rate of CCK false alarms (+ plcp_errors) is too high
1743 * (greater than 50 for each 204.8 msecs listening), method for reducing
1744 * sensitivity is:
1745 *
1746 * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
1747 * up to max 400.
1748 *
1749 * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
1750 * sensitivity has been reduced a significant amount; bring it up to
1751 * a moderate 161. Otherwise, *add* 3, up to max 200.
1752 *
1753 * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
1754 * sensitivity has been reduced only a moderate or small amount;
1755 * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
1756 * down to min 0. Otherwise (if gain has been significantly reduced),
1757 * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
1758 *
1759 * b) Save a snapshot of the "silence reference".
1760 *
1761 * If actual rate of CCK false alarms (+ plcp_errors) is too low
1762 * (less than 5 for each 204.8 msecs listening), method for increasing
1763 * sensitivity is used only if:
1764 *
1765 * 1a) Previous beacon did not have too many false alarms
1766 * 1b) AND difference between previous "silence reference" and current
1767 * "silence reference" (prev - current) is 2 or more,
1768 * OR 2) 100 or more consecutive beacon periods have had rate of
1769 * less than 5 false alarms per 204.8 milliseconds rx time.
1770 *
1771 * Method for increasing sensitivity:
1772 *
1773 * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
1774 * down to min 125.
1775 *
1776 * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
1777 * down to min 200.
1778 *
1779 * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
1780 *
1781 * If actual rate of CCK false alarms (+ plcp_errors) is within good range
1782 * (between 5 and 50 for each 204.8 msecs listening):
1783 *
1784 * 1) Save a snapshot of the silence reference.
1785 *
1786 * 2) If previous beacon had too many CCK false alarms (+ plcp_errors),
1787 * give some extra margin to energy threshold by *subtracting* 8
1788 * from value in HD_MIN_ENERGY_CCK_DET_INDEX.
1789 *
1790 * For all cases (too few, too many, good range), make sure that the CCK
1791 * detection threshold (energy) is below the energy level for robust
1792 * detection over the past 10 beacon periods, the "Max cck energy".
1793 * Lower values mean higher energy; this means making sure that the value
1794 * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
1795 *
1796 * Driver should set the following entries to fixed values:
1797 *
1798 * HD_MIN_ENERGY_OFDM_DET_INDEX 100
1799 * HD_BARKER_CORR_TH_ADD_MIN_INDEX 190
1800 * HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX 390
1801 * HD_OFDM_ENERGY_TH_IN_INDEX 62
1802 */
1803
1804/*
1805 * Table entries in SENSITIVITY_CMD (struct iwl4965_sensitivity_cmd)
1806 */
1807#define HD_TABLE_SIZE (11) /* number of entries */
1808#define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */
1809#define HD_MIN_ENERGY_OFDM_DET_INDEX (1)
1810#define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2)
1811#define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3)
1812#define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4)
1813#define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5)
1814#define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6)
1815#define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7)
1816#define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8)
1817#define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9)
1818#define HD_OFDM_ENERGY_TH_IN_INDEX (10)
1819
1820/* Control field in struct iwl4965_sensitivity_cmd */
1821#define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE __constant_cpu_to_le16(0)
1822#define SENSITIVITY_CMD_CONTROL_WORK_TABLE __constant_cpu_to_le16(1)
b481de9c 1823
f7d09d7c
BC		 1824/**
1825 * struct iwl4965_sensitivity_cmd
1826 * @control: (1) updates working table, (0) updates default table
1827 * @table: energy threshold values, use HD_* as index into table
1828 *
1829 * Always use "1" in "control" to update uCode's working table and DSP.
1830 */
bb8c093b 1831struct iwl4965_sensitivity_cmd {
f7d09d7c
BC		 1832 __le16 control; /* always use "1" */
1833 __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */
b481de9c
ZY		 1834} __attribute__ ((packed));
1835
f7d09d7c
BC		 1836
1837/**
1838 * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
1839 *
1840 * This command sets the relative gains of 4965's 3 radio receiver chains.
1841 *
1842 * After the first association, driver should accumulate signal and noise
1843 * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
1844 * beacons from the associated network (don't collect statistics that come
1845 * in from scanning, or any other non-network source).
1846 *
1847 * DISCONNECTED ANTENNA:
1848 *
1849 * Driver should determine which antennas are actually connected, by comparing
1850 * average beacon signal levels for the 3 Rx chains. Accumulate (add) the
1851 * following values over 20 beacons, one accumulator for each of the chains
1852 * a/b/c, from struct statistics_rx_non_phy:
1853 *
1854 * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
1855 *
1856 * Find the strongest signal from among a/b/c. Compare the other two to the
1857 * strongest. If any signal is more than 15 dB (times 20, unless you
1858 * divide the accumulated values by 20) below the strongest, the driver
1859 * considers that antenna to be disconnected, and should not try to use that
1860 * antenna/chain for Rx or Tx. If both A and B seem to be disconnected,
1861 * driver should declare the stronger one as connected, and attempt to use it
1862 * (A and B are the only 2 Tx chains!).
1863 *
1864 *
1865 * RX BALANCE:
1866 *
1867 * Driver should balance the 3 receivers (but just the ones that are connected
1868 * to antennas, see above) for gain, by comparing the average signal levels
1869 * detected during the silence after each beacon (background noise).
1870 * Accumulate (add) the following values over 20 beacons, one accumulator for
1871 * each of the chains a/b/c, from struct statistics_rx_non_phy:
1872 *
1873 * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
1874 *
1875 * Find the weakest background noise level from among a/b/c. This Rx chain
1876 * will be the reference, with 0 gain adjustment. Attenuate other channels by
1877 * finding noise difference:
1878 *
1879 * (accum_noise[i] - accum_noise[reference]) / 30
1880 *
1881 * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
1882 * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
1883 * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
1884 * and set bit 2 to indicate "reduce gain". The value for the reference
1885 * (weakest) chain should be "0".
1886 *
1887 * diff_gain_[abc] bit fields:
1888 * 2: (1) reduce gain, (0) increase gain
1889 * 1-0: amount of gain, units of 1.5 dB
1890 */
1891
1892/* "Differential Gain" opcode used in REPLY_PHY_CALIBRATION_CMD. */
1893#define PHY_CALIBRATE_DIFF_GAIN_CMD (7)
1894
bb8c093b 1895struct iwl4965_calibration_cmd {
f7d09d7c
BC		 1896 u8 opCode; /* PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
1897 u8 flags; /* not used */
b481de9c 1898 __le16 reserved;
f7d09d7c 1899 s8 diff_gain_a; /* see above */
b481de9c
ZY		 1900 s8 diff_gain_b;
1901 s8 diff_gain_c;
1902 u8 reserved1;
1903} __attribute__ ((packed));
1904
1905/******************************************************************************
1906 * (12)
1907 * Miscellaneous Commands:
1908 *
1909 *****************************************************************************/
1910
1911/*
1912 * LEDs Command & Response
1913 * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
1914 *
1915 * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
1916 * this command turns it on or off, or sets up a periodic blinking cycle.
1917 */
bb8c093b 1918struct iwl4965_led_cmd {
b481de9c
ZY		 1919 __le32 interval; /* "interval" in uSec */
1920 u8 id; /* 1: Activity, 2: Link, 3: Tech */
1921 u8 off; /* # intervals off while blinking;
1922 * "0", with >0 "on" value, turns LED on */
1923 u8 on; /* # intervals on while blinking;
1924 * "0", regardless of "off", turns LED off */
1925 u8 reserved;
1926} __attribute__ ((packed));
1927
1928/******************************************************************************
1929 * (13)
1930 * Union of all expected notifications/responses:
1931 *
1932 *****************************************************************************/
1933
bb8c093b 1934struct iwl4965_rx_packet {
b481de9c 1935 __le32 len;
bb8c093b 1936 struct iwl4965_cmd_header hdr;
b481de9c 1937 union {
bb8c093b
CH		 1938 struct iwl4965_alive_resp alive_frame;
1939 struct iwl4965_rx_frame rx_frame;
1940 struct iwl4965_tx_resp tx_resp;
1941 struct iwl4965_spectrum_notification spectrum_notif;
1942 struct iwl4965_csa_notification csa_notif;
1943 struct iwl4965_error_resp err_resp;
1944 struct iwl4965_card_state_notif card_state_notif;
1945 struct iwl4965_beacon_notif beacon_status;
1946 struct iwl4965_add_sta_resp add_sta;
1947 struct iwl4965_sleep_notification sleep_notif;
1948 struct iwl4965_spectrum_resp spectrum;
1949 struct iwl4965_notif_statistics stats;
1950 struct iwl4965_compressed_ba_resp compressed_ba;
1951 struct iwl4965_missed_beacon_notif missed_beacon;
b481de9c
ZY		 1952 __le32 status;
1953 u8 raw[0];
1954 } u;
1955} __attribute__ ((packed));
1956
bb8c093b 1957#define IWL_RX_FRAME_SIZE (4 + sizeof(struct iwl4965_rx_frame))
b481de9c 1958
bb8c093b 1959#endif /* __iwl4965_commands_h__ */
Linux kernel - Deliverables
This page took 0.18937 seconds and 5 git commands to generate.