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