~ubuntu-branches/ubuntu/maverick/linux-backports-modules-2.6.32/maverick

« back to all changes in this revision

Viewing changes to updates/compat-wireless-2.6/drivers/net/wireless/iwlwifi/iwl-commands.h

  • Committer: Bazaar Package Importer
  • Author(s): Andy Whitcroft, Andy Whitcroft
  • Date: 2010-02-04 23:15:51 UTC
  • Revision ID: james.westby@ubuntu.com-20100204231551-vjz5pkvxclukjxm1
Tags: 2.6.32-12.1
[ Andy Whitcroft ]

* initial LBM for lucid
* drop generated files
* printchanges -- rebase tree does not have stable tags use changelog
* printenv -- add revisions to printenv output
* formally rename compat-wireless to linux-backports-modules-wireless
* Update to compat-wireless-2.6.33-rc5
* update nouveau to mainline 2.6.33-rc4
* add new LBM package for nouveau
* nouveau -- fix major numbers and proc entry names
* fix up firmware installs for -wireless
* clean up UPDATE-NOVEAU
* update Nouveau to v2.6.33-rc6

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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 - 2009 Intel Corporation. All rights reserved.
 
9
 *
 
10
 * This program is free software; you can redistribute it and/or modify
 
11
 * it under the terms of version 2 of the GNU General Public License as
 
12
 * published by the Free Software Foundation.
 
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
 *  Intel Linux Wireless <ilw@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 - 2009 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
/*
 
64
 * Please use this file (iwl-commands.h) only for uCode API definitions.
 
65
 * Please use iwl-4965-hw.h for hardware-related definitions.
 
66
 * Please use iwl-dev.h for driver implementation definitions.
 
67
 */
 
68
 
 
69
#ifndef __iwl_commands_h__
 
70
#define __iwl_commands_h__
 
71
 
 
72
struct iwl_priv;
 
73
 
 
74
/* uCode version contains 4 values: Major/Minor/API/Serial */
 
75
#define IWL_UCODE_MAJOR(ver)    (((ver) & 0xFF000000) >> 24)
 
76
#define IWL_UCODE_MINOR(ver)    (((ver) & 0x00FF0000) >> 16)
 
77
#define IWL_UCODE_API(ver)      (((ver) & 0x0000FF00) >> 8)
 
78
#define IWL_UCODE_SERIAL(ver)   ((ver) & 0x000000FF)
 
79
 
 
80
 
 
81
/* Tx rates */
 
82
#define IWL_CCK_RATES   4
 
83
#define IWL_OFDM_RATES  8
 
84
#define IWL_MAX_RATES   (IWL_CCK_RATES + IWL_OFDM_RATES)
 
85
 
 
86
enum {
 
87
        REPLY_ALIVE = 0x1,
 
88
        REPLY_ERROR = 0x2,
 
89
 
 
90
        /* RXON and QOS commands */
 
91
        REPLY_RXON = 0x10,
 
92
        REPLY_RXON_ASSOC = 0x11,
 
93
        REPLY_QOS_PARAM = 0x13,
 
94
        REPLY_RXON_TIMING = 0x14,
 
95
 
 
96
        /* Multi-Station support */
 
97
        REPLY_ADD_STA = 0x18,
 
98
        REPLY_REMOVE_STA = 0x19,        /* not used */
 
99
        REPLY_REMOVE_ALL_STA = 0x1a,    /* not used */
 
100
 
 
101
        /* Security */
 
102
        REPLY_WEPKEY = 0x20,
 
103
 
 
104
        /* RX, TX, LEDs */
 
105
        REPLY_3945_RX = 0x1b,           /* 3945 only */
 
106
        REPLY_TX = 0x1c,
 
107
        REPLY_RATE_SCALE = 0x47,        /* 3945 only */
 
108
        REPLY_LEDS_CMD = 0x48,
 
109
        REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */
 
110
 
 
111
        /* WiMAX coexistence */
 
112
        COEX_PRIORITY_TABLE_CMD = 0x5a, /* for 5000 series and up */
 
113
        COEX_MEDIUM_NOTIFICATION = 0x5b,
 
114
        COEX_EVENT_CMD = 0x5c,
 
115
 
 
116
        /* Calibration */
 
117
        TEMPERATURE_NOTIFICATION = 0x62,
 
118
        CALIBRATION_CFG_CMD = 0x65,
 
119
        CALIBRATION_RES_NOTIFICATION = 0x66,
 
120
        CALIBRATION_COMPLETE_NOTIFICATION = 0x67,
 
121
 
 
122
        /* 802.11h related */
 
123
        RADAR_NOTIFICATION = 0x70,      /* not used */
 
124
        REPLY_QUIET_CMD = 0x71,         /* not used */
 
125
        REPLY_CHANNEL_SWITCH = 0x72,
 
126
        CHANNEL_SWITCH_NOTIFICATION = 0x73,
 
127
        REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
 
128
        SPECTRUM_MEASURE_NOTIFICATION = 0x75,
 
129
 
 
130
        /* Power Management */
 
131
        POWER_TABLE_CMD = 0x77,
 
132
        PM_SLEEP_NOTIFICATION = 0x7A,
 
133
        PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
 
134
 
 
135
        /* Scan commands and notifications */
 
136
        REPLY_SCAN_CMD = 0x80,
 
137
        REPLY_SCAN_ABORT_CMD = 0x81,
 
138
        SCAN_START_NOTIFICATION = 0x82,
 
139
        SCAN_RESULTS_NOTIFICATION = 0x83,
 
140
        SCAN_COMPLETE_NOTIFICATION = 0x84,
 
141
 
 
142
        /* IBSS/AP commands */
 
143
        BEACON_NOTIFICATION = 0x90,
 
144
        REPLY_TX_BEACON = 0x91,
 
145
        WHO_IS_AWAKE_NOTIFICATION = 0x94,       /* not used */
 
146
 
 
147
        /* Miscellaneous commands */
 
148
        REPLY_TX_POWER_DBM_CMD = 0x95,
 
149
        QUIET_NOTIFICATION = 0x96,              /* not used */
 
150
        REPLY_TX_PWR_TABLE_CMD = 0x97,
 
151
        REPLY_TX_POWER_DBM_CMD_V1 = 0x98,       /* old version of API */
 
152
        TX_ANT_CONFIGURATION_CMD = 0x98,
 
153
        MEASURE_ABORT_NOTIFICATION = 0x99,      /* not used */
 
154
 
 
155
        /* Bluetooth device coexistence config command */
 
156
        REPLY_BT_CONFIG = 0x9b,
 
157
 
 
158
        /* Statistics */
 
159
        REPLY_STATISTICS_CMD = 0x9c,
 
160
        STATISTICS_NOTIFICATION = 0x9d,
 
161
 
 
162
        /* RF-KILL commands and notifications */
 
163
        REPLY_CARD_STATE_CMD = 0xa0,
 
164
        CARD_STATE_NOTIFICATION = 0xa1,
 
165
 
 
166
        /* Missed beacons notification */
 
167
        MISSED_BEACONS_NOTIFICATION = 0xa2,
 
168
 
 
169
        REPLY_CT_KILL_CONFIG_CMD = 0xa4,
 
170
        SENSITIVITY_CMD = 0xa8,
 
171
        REPLY_PHY_CALIBRATION_CMD = 0xb0,
 
172
        REPLY_RX_PHY_CMD = 0xc0,
 
173
        REPLY_RX_MPDU_CMD = 0xc1,
 
174
        REPLY_RX = 0xc3,
 
175
        REPLY_COMPRESSED_BA = 0xc5,
 
176
        REPLY_MAX = 0xff
 
177
};
 
178
 
 
179
/******************************************************************************
 
180
 * (0)
 
181
 * Commonly used structures and definitions:
 
182
 * Command header, rate_n_flags, txpower
 
183
 *
 
184
 *****************************************************************************/
 
185
 
 
186
/* iwl_cmd_header flags value */
 
187
#define IWL_CMD_FAILED_MSK 0x40
 
188
 
 
189
#define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
 
190
#define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
 
191
#define SEQ_TO_INDEX(s) ((s) & 0xff)
 
192
#define INDEX_TO_SEQ(i) ((i) & 0xff)
 
193
#define SEQ_HUGE_FRAME  cpu_to_le16(0x4000)
 
194
#define SEQ_RX_FRAME    cpu_to_le16(0x8000)
 
195
 
 
196
/**
 
197
 * struct iwl_cmd_header
 
198
 *
 
199
 * This header format appears in the beginning of each command sent from the
 
200
 * driver, and each response/notification received from uCode.
 
201
 */
 
202
struct iwl_cmd_header {
 
203
        u8 cmd;         /* Command ID:  REPLY_RXON, etc. */
 
204
        u8 flags;       /* 0:5 reserved, 6 abort, 7 internal */
 
205
        /*
 
206
         * The driver sets up the sequence number to values of its choosing.
 
207
         * uCode does not use this value, but passes it back to the driver
 
208
         * when sending the response to each driver-originated command, so
 
209
         * the driver can match the response to the command.  Since the values
 
210
         * don't get used by uCode, the driver may set up an arbitrary format.
 
211
         *
 
212
         * There is one exception:  uCode sets bit 15 when it originates
 
213
         * the response/notification, i.e. when the response/notification
 
214
         * is not a direct response to a command sent by the driver.  For
 
215
         * example, uCode issues REPLY_3945_RX when it sends a received frame
 
216
         * to the driver; it is not a direct response to any driver command.
 
217
         *
 
218
         * The Linux driver uses the following format:
 
219
         *
 
220
         *  0:7         tfd index - position within TX queue
 
221
         *  8:12        TX queue id
 
222
         *  13          reserved
 
223
         *  14          huge - driver sets this to indicate command is in the
 
224
         *              'huge' storage at the end of the command buffers
 
225
         *  15          unsolicited RX or uCode-originated notification
 
226
         */
 
227
        __le16 sequence;
 
228
 
 
229
        /* command or response/notification data follows immediately */
 
230
        u8 data[0];
 
231
} __attribute__ ((packed));
 
232
 
 
233
 
 
234
/**
 
235
 * struct iwl3945_tx_power
 
236
 *
 
237
 * Used in REPLY_TX_PWR_TABLE_CMD, REPLY_SCAN_CMD, REPLY_CHANNEL_SWITCH
 
238
 *
 
239
 * Each entry contains two values:
 
240
 * 1)  DSP gain (or sometimes called DSP attenuation).  This is a fine-grained
 
241
 *     linear value that multiplies the output of the digital signal processor,
 
242
 *     before being sent to the analog radio.
 
243
 * 2)  Radio gain.  This sets the analog gain of the radio Tx path.
 
244
 *     It is a coarser setting, and behaves in a logarithmic (dB) fashion.
 
245
 *
 
246
 * Driver obtains values from struct iwl3945_tx_power power_gain_table[][].
 
247
 */
 
248
struct iwl3945_tx_power {
 
249
        u8 tx_gain;             /* gain for analog radio */
 
250
        u8 dsp_atten;           /* gain for DSP */
 
251
} __attribute__ ((packed));
 
252
 
 
253
/**
 
254
 * struct iwl3945_power_per_rate
 
255
 *
 
256
 * Used in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
 
257
 */
 
258
struct iwl3945_power_per_rate {
 
259
        u8 rate;                /* plcp */
 
260
        struct iwl3945_tx_power tpc;
 
261
        u8 reserved;
 
262
} __attribute__ ((packed));
 
263
 
 
264
/**
 
265
 * iwlagn rate_n_flags bit fields
 
266
 *
 
267
 * rate_n_flags format is used in following iwlagn commands:
 
268
 *  REPLY_RX (response only)
 
269
 *  REPLY_RX_MPDU (response only)
 
270
 *  REPLY_TX (both command and response)
 
271
 *  REPLY_TX_LINK_QUALITY_CMD
 
272
 *
 
273
 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
 
274
 *  2-0:  0)   6 Mbps
 
275
 *        1)  12 Mbps
 
276
 *        2)  18 Mbps
 
277
 *        3)  24 Mbps
 
278
 *        4)  36 Mbps
 
279
 *        5)  48 Mbps
 
280
 *        6)  54 Mbps
 
281
 *        7)  60 Mbps
 
282
 *
 
283
 *  4-3:  0)  Single stream (SISO)
 
284
 *        1)  Dual stream (MIMO)
 
285
 *        2)  Triple stream (MIMO)
 
286
 *
 
287
 *    5:  Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data
 
288
 *
 
289
 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
 
290
 *  3-0:  0xD)   6 Mbps
 
291
 *        0xF)   9 Mbps
 
292
 *        0x5)  12 Mbps
 
293
 *        0x7)  18 Mbps
 
294
 *        0x9)  24 Mbps
 
295
 *        0xB)  36 Mbps
 
296
 *        0x1)  48 Mbps
 
297
 *        0x3)  54 Mbps
 
298
 *
 
299
 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
 
300
 *  6-0:   10)  1 Mbps
 
301
 *         20)  2 Mbps
 
302
 *         55)  5.5 Mbps
 
303
 *        110)  11 Mbps
 
304
 */
 
305
#define RATE_MCS_CODE_MSK 0x7
 
306
#define RATE_MCS_SPATIAL_POS 3
 
307
#define RATE_MCS_SPATIAL_MSK 0x18
 
308
#define RATE_MCS_HT_DUP_POS 5
 
309
#define RATE_MCS_HT_DUP_MSK 0x20
 
310
 
 
311
/* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
 
312
#define RATE_MCS_FLAGS_POS 8
 
313
#define RATE_MCS_HT_POS 8
 
314
#define RATE_MCS_HT_MSK 0x100
 
315
 
 
316
/* Bit 9: (1) CCK, (0) OFDM.  HT (bit 8) must be "0" for this bit to be valid */
 
317
#define RATE_MCS_CCK_POS 9
 
318
#define RATE_MCS_CCK_MSK 0x200
 
319
 
 
320
/* Bit 10: (1) Use Green Field preamble */
 
321
#define RATE_MCS_GF_POS 10
 
322
#define RATE_MCS_GF_MSK 0x400
 
323
 
 
324
/* Bit 11: (1) Use 40Mhz HT40 chnl width, (0) use 20 MHz legacy chnl width */
 
325
#define RATE_MCS_HT40_POS 11
 
326
#define RATE_MCS_HT40_MSK 0x800
 
327
 
 
328
/* Bit 12: (1) Duplicate data on both 20MHz chnls. HT40 (bit 11) must be set. */
 
329
#define RATE_MCS_DUP_POS 12
 
330
#define RATE_MCS_DUP_MSK 0x1000
 
331
 
 
332
/* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
 
333
#define RATE_MCS_SGI_POS 13
 
334
#define RATE_MCS_SGI_MSK 0x2000
 
335
 
 
336
/**
 
337
 * rate_n_flags Tx antenna masks
 
338
 * 4965 has 2 transmitters
 
339
 * 5100 has 1 transmitter B
 
340
 * 5150 has 1 transmitter A
 
341
 * 5300 has 3 transmitters
 
342
 * 5350 has 3 transmitters
 
343
 * bit14:16
 
344
 */
 
345
#define RATE_MCS_ANT_POS        14
 
346
#define RATE_MCS_ANT_A_MSK      0x04000
 
347
#define RATE_MCS_ANT_B_MSK      0x08000
 
348
#define RATE_MCS_ANT_C_MSK      0x10000
 
349
#define RATE_MCS_ANT_AB_MSK     (RATE_MCS_ANT_A_MSK | RATE_MCS_ANT_B_MSK)
 
350
#define RATE_MCS_ANT_ABC_MSK    (RATE_MCS_ANT_AB_MSK | RATE_MCS_ANT_C_MSK)
 
351
#define RATE_ANT_NUM 3
 
352
 
 
353
#define POWER_TABLE_NUM_ENTRIES                 33
 
354
#define POWER_TABLE_NUM_HT_OFDM_ENTRIES         32
 
355
#define POWER_TABLE_CCK_ENTRY                   32
 
356
 
 
357
#define IWL_PWR_NUM_HT_OFDM_ENTRIES             24
 
358
#define IWL_PWR_CCK_ENTRIES                     2
 
359
 
 
360
/**
 
361
 * union iwl4965_tx_power_dual_stream
 
362
 *
 
363
 * Host format used for REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
 
364
 * Use __le32 version (struct tx_power_dual_stream) when building command.
 
365
 *
 
366
 * Driver provides radio gain and DSP attenuation settings to device in pairs,
 
367
 * one value for each transmitter chain.  The first value is for transmitter A,
 
368
 * second for transmitter B.
 
369
 *
 
370
 * For SISO bit rates, both values in a pair should be identical.
 
371
 * For MIMO rates, one value may be different from the other,
 
372
 * in order to balance the Tx output between the two transmitters.
 
373
 *
 
374
 * See more details in doc for TXPOWER in iwl-4965-hw.h.
 
375
 */
 
376
union iwl4965_tx_power_dual_stream {
 
377
        struct {
 
378
                u8 radio_tx_gain[2];
 
379
                u8 dsp_predis_atten[2];
 
380
        } s;
 
381
        u32 dw;
 
382
};
 
383
 
 
384
/**
 
385
 * struct tx_power_dual_stream
 
386
 *
 
387
 * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
 
388
 *
 
389
 * Same format as iwl_tx_power_dual_stream, but __le32
 
390
 */
 
391
struct tx_power_dual_stream {
 
392
        __le32 dw;
 
393
} __attribute__ ((packed));
 
394
 
 
395
/**
 
396
 * struct iwl4965_tx_power_db
 
397
 *
 
398
 * Entire table within REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
 
399
 */
 
400
struct iwl4965_tx_power_db {
 
401
        struct tx_power_dual_stream power_tbl[POWER_TABLE_NUM_ENTRIES];
 
402
} __attribute__ ((packed));
 
403
 
 
404
/**
 
405
 * Command REPLY_TX_POWER_DBM_CMD = 0x98
 
406
 * struct iwl5000_tx_power_dbm_cmd
 
407
 */
 
408
#define IWL50_TX_POWER_AUTO 0x7f
 
409
#define IWL50_TX_POWER_NO_CLOSED (0x1 << 6)
 
410
 
 
411
struct iwl5000_tx_power_dbm_cmd {
 
412
        s8 global_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
 
413
        u8 flags;
 
414
        s8 srv_chan_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
 
415
        u8 reserved;
 
416
} __attribute__ ((packed));
 
417
 
 
418
/**
 
419
 * Command TX_ANT_CONFIGURATION_CMD = 0x98
 
420
 * This command is used to configure valid Tx antenna.
 
421
 * By default uCode concludes the valid antenna according to the radio flavor.
 
422
 * This command enables the driver to override/modify this conclusion.
 
423
 */
 
424
struct iwl_tx_ant_config_cmd {
 
425
        __le32 valid;
 
426
} __attribute__ ((packed));
 
427
 
 
428
/******************************************************************************
 
429
 * (0a)
 
430
 * Alive and Error Commands & Responses:
 
431
 *
 
432
 *****************************************************************************/
 
433
 
 
434
#define UCODE_VALID_OK  cpu_to_le32(0x1)
 
435
#define INITIALIZE_SUBTYPE    (9)
 
436
 
 
437
/*
 
438
 * ("Initialize") REPLY_ALIVE = 0x1 (response only, not a command)
 
439
 *
 
440
 * uCode issues this "initialize alive" notification once the initialization
 
441
 * uCode image has completed its work, and is ready to load the runtime image.
 
442
 * This is the *first* "alive" notification that the driver will receive after
 
443
 * rebooting uCode; the "initialize" alive is indicated by subtype field == 9.
 
444
 *
 
445
 * See comments documenting "BSM" (bootstrap state machine).
 
446
 *
 
447
 * For 4965, this notification contains important calibration data for
 
448
 * calculating txpower settings:
 
449
 *
 
450
 * 1)  Power supply voltage indication.  The voltage sensor outputs higher
 
451
 *     values for lower voltage, and vice verse.
 
452
 *
 
453
 * 2)  Temperature measurement parameters, for each of two channel widths
 
454
 *     (20 MHz and 40 MHz) supported by the radios.  Temperature sensing
 
455
 *     is done via one of the receiver chains, and channel width influences
 
456
 *     the results.
 
457
 *
 
458
 * 3)  Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation,
 
459
 *     for each of 5 frequency ranges.
 
460
 */
 
461
struct iwl_init_alive_resp {
 
462
        u8 ucode_minor;
 
463
        u8 ucode_major;
 
464
        __le16 reserved1;
 
465
        u8 sw_rev[8];
 
466
        u8 ver_type;
 
467
        u8 ver_subtype;         /* "9" for initialize alive */
 
468
        __le16 reserved2;
 
469
        __le32 log_event_table_ptr;
 
470
        __le32 error_event_table_ptr;
 
471
        __le32 timestamp;
 
472
        __le32 is_valid;
 
473
 
 
474
        /* calibration values from "initialize" uCode */
 
475
        __le32 voltage;         /* signed, higher value is lower voltage */
 
476
        __le32 therm_r1[2];     /* signed, 1st for normal, 2nd for HT40 */
 
477
        __le32 therm_r2[2];     /* signed */
 
478
        __le32 therm_r3[2];     /* signed */
 
479
        __le32 therm_r4[2];     /* signed */
 
480
        __le32 tx_atten[5][2];  /* signed MIMO gain comp, 5 freq groups,
 
481
                                 * 2 Tx chains */
 
482
} __attribute__ ((packed));
 
483
 
 
484
 
 
485
/**
 
486
 * REPLY_ALIVE = 0x1 (response only, not a command)
 
487
 *
 
488
 * uCode issues this "alive" notification once the runtime image is ready
 
489
 * to receive commands from the driver.  This is the *second* "alive"
 
490
 * notification that the driver will receive after rebooting uCode;
 
491
 * this "alive" is indicated by subtype field != 9.
 
492
 *
 
493
 * See comments documenting "BSM" (bootstrap state machine).
 
494
 *
 
495
 * This response includes two pointers to structures within the device's
 
496
 * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
 
497
 *
 
498
 * 1)  log_event_table_ptr indicates base of the event log.  This traces
 
499
 *     a 256-entry history of uCode execution within a circular buffer.
 
500
 *     Its header format is:
 
501
 *
 
502
 *      __le32 log_size;     log capacity (in number of entries)
 
503
 *      __le32 type;         (1) timestamp with each entry, (0) no timestamp
 
504
 *      __le32 wraps;        # times uCode has wrapped to top of circular buffer
 
505
 *      __le32 write_index;  next circular buffer entry that uCode would fill
 
506
 *
 
507
 *     The header is followed by the circular buffer of log entries.  Entries
 
508
 *     with timestamps have the following format:
 
509
 *
 
510
 *      __le32 event_id;     range 0 - 1500
 
511
 *      __le32 timestamp;    low 32 bits of TSF (of network, if associated)
 
512
 *      __le32 data;         event_id-specific data value
 
513
 *
 
514
 *     Entries without timestamps contain only event_id and data.
 
515
 *
 
516
 * 2)  error_event_table_ptr indicates base of the error log.  This contains
 
517
 *     information about any uCode error that occurs.  For 4965, the format
 
518
 *     of the error log is:
 
519
 *
 
520
 *      __le32 valid;        (nonzero) valid, (0) log is empty
 
521
 *      __le32 error_id;     type of error
 
522
 *      __le32 pc;           program counter
 
523
 *      __le32 blink1;       branch link
 
524
 *      __le32 blink2;       branch link
 
525
 *      __le32 ilink1;       interrupt link
 
526
 *      __le32 ilink2;       interrupt link
 
527
 *      __le32 data1;        error-specific data
 
528
 *      __le32 data2;        error-specific data
 
529
 *      __le32 line;         source code line of error
 
530
 *      __le32 bcon_time;    beacon timer
 
531
 *      __le32 tsf_low;      network timestamp function timer
 
532
 *      __le32 tsf_hi;       network timestamp function timer
 
533
 *
 
534
 * The Linux driver can print both logs to the system log when a uCode error
 
535
 * occurs.
 
536
 */
 
537
struct iwl_alive_resp {
 
538
        u8 ucode_minor;
 
539
        u8 ucode_major;
 
540
        __le16 reserved1;
 
541
        u8 sw_rev[8];
 
542
        u8 ver_type;
 
543
        u8 ver_subtype;                 /* not "9" for runtime alive */
 
544
        __le16 reserved2;
 
545
        __le32 log_event_table_ptr;     /* SRAM address for event log */
 
546
        __le32 error_event_table_ptr;   /* SRAM address for error log */
 
547
        __le32 timestamp;
 
548
        __le32 is_valid;
 
549
} __attribute__ ((packed));
 
550
 
 
551
/*
 
552
 * REPLY_ERROR = 0x2 (response only, not a command)
 
553
 */
 
554
struct iwl_error_resp {
 
555
        __le32 error_type;
 
556
        u8 cmd_id;
 
557
        u8 reserved1;
 
558
        __le16 bad_cmd_seq_num;
 
559
        __le32 error_info;
 
560
        __le64 timestamp;
 
561
} __attribute__ ((packed));
 
562
 
 
563
/******************************************************************************
 
564
 * (1)
 
565
 * RXON Commands & Responses:
 
566
 *
 
567
 *****************************************************************************/
 
568
 
 
569
/*
 
570
 * Rx config defines & structure
 
571
 */
 
572
/* rx_config device types  */
 
573
enum {
 
574
        RXON_DEV_TYPE_AP = 1,
 
575
        RXON_DEV_TYPE_ESS = 3,
 
576
        RXON_DEV_TYPE_IBSS = 4,
 
577
        RXON_DEV_TYPE_SNIFFER = 6,
 
578
};
 
579
 
 
580
 
 
581
#define RXON_RX_CHAIN_DRIVER_FORCE_MSK          cpu_to_le16(0x1 << 0)
 
582
#define RXON_RX_CHAIN_DRIVER_FORCE_POS          (0)
 
583
#define RXON_RX_CHAIN_VALID_MSK                 cpu_to_le16(0x7 << 1)
 
584
#define RXON_RX_CHAIN_VALID_POS                 (1)
 
585
#define RXON_RX_CHAIN_FORCE_SEL_MSK             cpu_to_le16(0x7 << 4)
 
586
#define RXON_RX_CHAIN_FORCE_SEL_POS             (4)
 
587
#define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK        cpu_to_le16(0x7 << 7)
 
588
#define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS        (7)
 
589
#define RXON_RX_CHAIN_CNT_MSK                   cpu_to_le16(0x3 << 10)
 
590
#define RXON_RX_CHAIN_CNT_POS                   (10)
 
591
#define RXON_RX_CHAIN_MIMO_CNT_MSK              cpu_to_le16(0x3 << 12)
 
592
#define RXON_RX_CHAIN_MIMO_CNT_POS              (12)
 
593
#define RXON_RX_CHAIN_MIMO_FORCE_MSK            cpu_to_le16(0x1 << 14)
 
594
#define RXON_RX_CHAIN_MIMO_FORCE_POS            (14)
 
595
 
 
596
/* rx_config flags */
 
597
/* band & modulation selection */
 
598
#define RXON_FLG_BAND_24G_MSK           cpu_to_le32(1 << 0)
 
599
#define RXON_FLG_CCK_MSK                cpu_to_le32(1 << 1)
 
600
/* auto detection enable */
 
601
#define RXON_FLG_AUTO_DETECT_MSK        cpu_to_le32(1 << 2)
 
602
/* TGg protection when tx */
 
603
#define RXON_FLG_TGG_PROTECT_MSK        cpu_to_le32(1 << 3)
 
604
/* cck short slot & preamble */
 
605
#define RXON_FLG_SHORT_SLOT_MSK          cpu_to_le32(1 << 4)
 
606
#define RXON_FLG_SHORT_PREAMBLE_MSK     cpu_to_le32(1 << 5)
 
607
/* antenna selection */
 
608
#define RXON_FLG_DIS_DIV_MSK            cpu_to_le32(1 << 7)
 
609
#define RXON_FLG_ANT_SEL_MSK            cpu_to_le32(0x0f00)
 
610
#define RXON_FLG_ANT_A_MSK              cpu_to_le32(1 << 8)
 
611
#define RXON_FLG_ANT_B_MSK              cpu_to_le32(1 << 9)
 
612
/* radar detection enable */
 
613
#define RXON_FLG_RADAR_DETECT_MSK       cpu_to_le32(1 << 12)
 
614
#define RXON_FLG_TGJ_NARROW_BAND_MSK    cpu_to_le32(1 << 13)
 
615
/* rx response to host with 8-byte TSF
 
616
* (according to ON_AIR deassertion) */
 
617
#define RXON_FLG_TSF2HOST_MSK           cpu_to_le32(1 << 15)
 
618
 
 
619
 
 
620
/* HT flags */
 
621
#define RXON_FLG_CTRL_CHANNEL_LOC_POS           (22)
 
622
#define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK        cpu_to_le32(0x1 << 22)
 
623
 
 
624
#define RXON_FLG_HT_OPERATING_MODE_POS          (23)
 
625
 
 
626
#define RXON_FLG_HT_PROT_MSK                    cpu_to_le32(0x1 << 23)
 
627
#define RXON_FLG_HT40_PROT_MSK                  cpu_to_le32(0x2 << 23)
 
628
 
 
629
#define RXON_FLG_CHANNEL_MODE_POS               (25)
 
630
#define RXON_FLG_CHANNEL_MODE_MSK               cpu_to_le32(0x3 << 25)
 
631
 
 
632
/* channel mode */
 
633
enum {
 
634
        CHANNEL_MODE_LEGACY = 0,
 
635
        CHANNEL_MODE_PURE_40 = 1,
 
636
        CHANNEL_MODE_MIXED = 2,
 
637
        CHANNEL_MODE_RESERVED = 3,
 
638
};
 
639
#define RXON_FLG_CHANNEL_MODE_LEGACY    cpu_to_le32(CHANNEL_MODE_LEGACY << RXON_FLG_CHANNEL_MODE_POS)
 
640
#define RXON_FLG_CHANNEL_MODE_PURE_40   cpu_to_le32(CHANNEL_MODE_PURE_40 << RXON_FLG_CHANNEL_MODE_POS)
 
641
#define RXON_FLG_CHANNEL_MODE_MIXED     cpu_to_le32(CHANNEL_MODE_MIXED << RXON_FLG_CHANNEL_MODE_POS)
 
642
 
 
643
/* CTS to self (if spec allows) flag */
 
644
#define RXON_FLG_SELF_CTS_EN                    cpu_to_le32(0x1<<30)
 
645
 
 
646
/* rx_config filter flags */
 
647
/* accept all data frames */
 
648
#define RXON_FILTER_PROMISC_MSK         cpu_to_le32(1 << 0)
 
649
/* pass control & management to host */
 
650
#define RXON_FILTER_CTL2HOST_MSK        cpu_to_le32(1 << 1)
 
651
/* accept multi-cast */
 
652
#define RXON_FILTER_ACCEPT_GRP_MSK      cpu_to_le32(1 << 2)
 
653
/* don't decrypt uni-cast frames */
 
654
#define RXON_FILTER_DIS_DECRYPT_MSK     cpu_to_le32(1 << 3)
 
655
/* don't decrypt multi-cast frames */
 
656
#define RXON_FILTER_DIS_GRP_DECRYPT_MSK cpu_to_le32(1 << 4)
 
657
/* STA is associated */
 
658
#define RXON_FILTER_ASSOC_MSK           cpu_to_le32(1 << 5)
 
659
/* transfer to host non bssid beacons in associated state */
 
660
#define RXON_FILTER_BCON_AWARE_MSK      cpu_to_le32(1 << 6)
 
661
 
 
662
/**
 
663
 * REPLY_RXON = 0x10 (command, has simple generic response)
 
664
 *
 
665
 * RXON tunes the radio tuner to a service channel, and sets up a number
 
666
 * of parameters that are used primarily for Rx, but also for Tx operations.
 
667
 *
 
668
 * NOTE:  When tuning to a new channel, driver must set the
 
669
 *        RXON_FILTER_ASSOC_MSK to 0.  This will clear station-dependent
 
670
 *        info within the device, including the station tables, tx retry
 
671
 *        rate tables, and txpower tables.  Driver must build a new station
 
672
 *        table and txpower table before transmitting anything on the RXON
 
673
 *        channel.
 
674
 *
 
675
 * NOTE:  All RXONs wipe clean the internal txpower table.  Driver must
 
676
 *        issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
 
677
 *        regardless of whether RXON_FILTER_ASSOC_MSK is set.
 
678
 */
 
679
 
 
680
struct iwl3945_rxon_cmd {
 
681
        u8 node_addr[6];
 
682
        __le16 reserved1;
 
683
        u8 bssid_addr[6];
 
684
        __le16 reserved2;
 
685
        u8 wlap_bssid_addr[6];
 
686
        __le16 reserved3;
 
687
        u8 dev_type;
 
688
        u8 air_propagation;
 
689
        __le16 reserved4;
 
690
        u8 ofdm_basic_rates;
 
691
        u8 cck_basic_rates;
 
692
        __le16 assoc_id;
 
693
        __le32 flags;
 
694
        __le32 filter_flags;
 
695
        __le16 channel;
 
696
        __le16 reserved5;
 
697
} __attribute__ ((packed));
 
698
 
 
699
struct iwl4965_rxon_cmd {
 
700
        u8 node_addr[6];
 
701
        __le16 reserved1;
 
702
        u8 bssid_addr[6];
 
703
        __le16 reserved2;
 
704
        u8 wlap_bssid_addr[6];
 
705
        __le16 reserved3;
 
706
        u8 dev_type;
 
707
        u8 air_propagation;
 
708
        __le16 rx_chain;
 
709
        u8 ofdm_basic_rates;
 
710
        u8 cck_basic_rates;
 
711
        __le16 assoc_id;
 
712
        __le32 flags;
 
713
        __le32 filter_flags;
 
714
        __le16 channel;
 
715
        u8 ofdm_ht_single_stream_basic_rates;
 
716
        u8 ofdm_ht_dual_stream_basic_rates;
 
717
} __attribute__ ((packed));
 
718
 
 
719
/* 5000 HW just extend this command */
 
720
struct iwl_rxon_cmd {
 
721
        u8 node_addr[6];
 
722
        __le16 reserved1;
 
723
        u8 bssid_addr[6];
 
724
        __le16 reserved2;
 
725
        u8 wlap_bssid_addr[6];
 
726
        __le16 reserved3;
 
727
        u8 dev_type;
 
728
        u8 air_propagation;
 
729
        __le16 rx_chain;
 
730
        u8 ofdm_basic_rates;
 
731
        u8 cck_basic_rates;
 
732
        __le16 assoc_id;
 
733
        __le32 flags;
 
734
        __le32 filter_flags;
 
735
        __le16 channel;
 
736
        u8 ofdm_ht_single_stream_basic_rates;
 
737
        u8 ofdm_ht_dual_stream_basic_rates;
 
738
        u8 ofdm_ht_triple_stream_basic_rates;
 
739
        u8 reserved5;
 
740
        __le16 acquisition_data;
 
741
        __le16 reserved6;
 
742
} __attribute__ ((packed));
 
743
 
 
744
/*
 
745
 * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
 
746
 */
 
747
struct iwl3945_rxon_assoc_cmd {
 
748
        __le32 flags;
 
749
        __le32 filter_flags;
 
750
        u8 ofdm_basic_rates;
 
751
        u8 cck_basic_rates;
 
752
        __le16 reserved;
 
753
} __attribute__ ((packed));
 
754
 
 
755
struct iwl4965_rxon_assoc_cmd {
 
756
        __le32 flags;
 
757
        __le32 filter_flags;
 
758
        u8 ofdm_basic_rates;
 
759
        u8 cck_basic_rates;
 
760
        u8 ofdm_ht_single_stream_basic_rates;
 
761
        u8 ofdm_ht_dual_stream_basic_rates;
 
762
        __le16 rx_chain_select_flags;
 
763
        __le16 reserved;
 
764
} __attribute__ ((packed));
 
765
 
 
766
struct iwl5000_rxon_assoc_cmd {
 
767
        __le32 flags;
 
768
        __le32 filter_flags;
 
769
        u8 ofdm_basic_rates;
 
770
        u8 cck_basic_rates;
 
771
        __le16 reserved1;
 
772
        u8 ofdm_ht_single_stream_basic_rates;
 
773
        u8 ofdm_ht_dual_stream_basic_rates;
 
774
        u8 ofdm_ht_triple_stream_basic_rates;
 
775
        u8 reserved2;
 
776
        __le16 rx_chain_select_flags;
 
777
        __le16 acquisition_data;
 
778
        __le32 reserved3;
 
779
} __attribute__ ((packed));
 
780
 
 
781
#define IWL_CONN_MAX_LISTEN_INTERVAL    10
 
782
#define IWL_MAX_UCODE_BEACON_INTERVAL   4 /* 4096 */
 
783
#define IWL39_MAX_UCODE_BEACON_INTERVAL 1 /* 1024 */
 
784
 
 
785
/*
 
786
 * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
 
787
 */
 
788
struct iwl_rxon_time_cmd {
 
789
        __le64 timestamp;
 
790
        __le16 beacon_interval;
 
791
        __le16 atim_window;
 
792
        __le32 beacon_init_val;
 
793
        __le16 listen_interval;
 
794
        __le16 reserved;
 
795
} __attribute__ ((packed));
 
796
 
 
797
/*
 
798
 * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
 
799
 */
 
800
struct iwl3945_channel_switch_cmd {
 
801
        u8 band;
 
802
        u8 expect_beacon;
 
803
        __le16 channel;
 
804
        __le32 rxon_flags;
 
805
        __le32 rxon_filter_flags;
 
806
        __le32 switch_time;
 
807
        struct iwl3945_power_per_rate power[IWL_MAX_RATES];
 
808
} __attribute__ ((packed));
 
809
 
 
810
struct iwl4965_channel_switch_cmd {
 
811
        u8 band;
 
812
        u8 expect_beacon;
 
813
        __le16 channel;
 
814
        __le32 rxon_flags;
 
815
        __le32 rxon_filter_flags;
 
816
        __le32 switch_time;
 
817
        struct iwl4965_tx_power_db tx_power;
 
818
} __attribute__ ((packed));
 
819
 
 
820
/**
 
821
 * struct iwl5000_channel_switch_cmd
 
822
 * @band: 0- 5.2GHz, 1- 2.4GHz
 
823
 * @expect_beacon: 0- resume transmits after channel switch
 
824
 *                 1- wait for beacon to resume transmits
 
825
 * @channel: new channel number
 
826
 * @rxon_flags: Rx on flags
 
827
 * @rxon_filter_flags: filtering parameters
 
828
 * @switch_time: switch time in extended beacon format
 
829
 * @reserved: reserved bytes
 
830
 */
 
831
struct iwl5000_channel_switch_cmd {
 
832
        u8 band;
 
833
        u8 expect_beacon;
 
834
        __le16 channel;
 
835
        __le32 rxon_flags;
 
836
        __le32 rxon_filter_flags;
 
837
        __le32 switch_time;
 
838
        __le32 reserved[2][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES];
 
839
} __attribute__ ((packed));
 
840
 
 
841
/**
 
842
 * struct iwl6000_channel_switch_cmd
 
843
 * @band: 0- 5.2GHz, 1- 2.4GHz
 
844
 * @expect_beacon: 0- resume transmits after channel switch
 
845
 *                 1- wait for beacon to resume transmits
 
846
 * @channel: new channel number
 
847
 * @rxon_flags: Rx on flags
 
848
 * @rxon_filter_flags: filtering parameters
 
849
 * @switch_time: switch time in extended beacon format
 
850
 * @reserved: reserved bytes
 
851
 */
 
852
struct iwl6000_channel_switch_cmd {
 
853
        u8 band;
 
854
        u8 expect_beacon;
 
855
        __le16 channel;
 
856
        __le32 rxon_flags;
 
857
        __le32 rxon_filter_flags;
 
858
        __le32 switch_time;
 
859
        __le32 reserved[3][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES];
 
860
} __attribute__ ((packed));
 
861
 
 
862
/*
 
863
 * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
 
864
 */
 
865
struct iwl_csa_notification {
 
866
        __le16 band;
 
867
        __le16 channel;
 
868
        __le32 status;          /* 0 - OK, 1 - fail */
 
869
} __attribute__ ((packed));
 
870
 
 
871
/******************************************************************************
 
872
 * (2)
 
873
 * Quality-of-Service (QOS) Commands & Responses:
 
874
 *
 
875
 *****************************************************************************/
 
876
 
 
877
/**
 
878
 * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
 
879
 * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
 
880
 *
 
881
 * @cw_min: Contention window, start value in numbers of slots.
 
882
 *          Should be a power-of-2, minus 1.  Device's default is 0x0f.
 
883
 * @cw_max: Contention window, max value in numbers of slots.
 
884
 *          Should be a power-of-2, minus 1.  Device's default is 0x3f.
 
885
 * @aifsn:  Number of slots in Arbitration Interframe Space (before
 
886
 *          performing random backoff timing prior to Tx).  Device default 1.
 
887
 * @edca_txop:  Length of Tx opportunity, in uSecs.  Device default is 0.
 
888
 *
 
889
 * Device will automatically increase contention window by (2*CW) + 1 for each
 
890
 * transmission retry.  Device uses cw_max as a bit mask, ANDed with new CW
 
891
 * value, to cap the CW value.
 
892
 */
 
893
struct iwl_ac_qos {
 
894
        __le16 cw_min;
 
895
        __le16 cw_max;
 
896
        u8 aifsn;
 
897
        u8 reserved1;
 
898
        __le16 edca_txop;
 
899
} __attribute__ ((packed));
 
900
 
 
901
/* QoS flags defines */
 
902
#define QOS_PARAM_FLG_UPDATE_EDCA_MSK   cpu_to_le32(0x01)
 
903
#define QOS_PARAM_FLG_TGN_MSK           cpu_to_le32(0x02)
 
904
#define QOS_PARAM_FLG_TXOP_TYPE_MSK     cpu_to_le32(0x10)
 
905
 
 
906
/* Number of Access Categories (AC) (EDCA), queues 0..3 */
 
907
#define AC_NUM                4
 
908
 
 
909
/*
 
910
 * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
 
911
 *
 
912
 * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
 
913
 * 0: Background, 1: Best Effort, 2: Video, 3: Voice.
 
914
 */
 
915
struct iwl_qosparam_cmd {
 
916
        __le32 qos_flags;
 
917
        struct iwl_ac_qos ac[AC_NUM];
 
918
} __attribute__ ((packed));
 
919
 
 
920
/******************************************************************************
 
921
 * (3)
 
922
 * Add/Modify Stations Commands & Responses:
 
923
 *
 
924
 *****************************************************************************/
 
925
/*
 
926
 * Multi station support
 
927
 */
 
928
 
 
929
/* Special, dedicated locations within device's station table */
 
930
#define IWL_AP_ID               0
 
931
#define IWL_MULTICAST_ID        1
 
932
#define IWL_STA_ID              2
 
933
#define IWL3945_BROADCAST_ID    24
 
934
#define IWL3945_STATION_COUNT   25
 
935
#define IWL4965_BROADCAST_ID    31
 
936
#define IWL4965_STATION_COUNT   32
 
937
#define IWL5000_BROADCAST_ID    15
 
938
#define IWL5000_STATION_COUNT   16
 
939
 
 
940
#define IWL_STATION_COUNT       32      /* MAX(3945,4965)*/
 
941
#define IWL_INVALID_STATION     255
 
942
 
 
943
#define STA_FLG_TX_RATE_MSK             cpu_to_le32(1 << 2);
 
944
#define STA_FLG_PWR_SAVE_MSK            cpu_to_le32(1 << 8);
 
945
#define STA_FLG_RTS_MIMO_PROT_MSK       cpu_to_le32(1 << 17)
 
946
#define STA_FLG_AGG_MPDU_8US_MSK        cpu_to_le32(1 << 18)
 
947
#define STA_FLG_MAX_AGG_SIZE_POS        (19)
 
948
#define STA_FLG_MAX_AGG_SIZE_MSK        cpu_to_le32(3 << 19)
 
949
#define STA_FLG_HT40_EN_MSK             cpu_to_le32(1 << 21)
 
950
#define STA_FLG_MIMO_DIS_MSK            cpu_to_le32(1 << 22)
 
951
#define STA_FLG_AGG_MPDU_DENSITY_POS    (23)
 
952
#define STA_FLG_AGG_MPDU_DENSITY_MSK    cpu_to_le32(7 << 23)
 
953
 
 
954
/* Use in mode field.  1: modify existing entry, 0: add new station entry */
 
955
#define STA_CONTROL_MODIFY_MSK          0x01
 
956
 
 
957
/* key flags __le16*/
 
958
#define STA_KEY_FLG_ENCRYPT_MSK cpu_to_le16(0x0007)
 
959
#define STA_KEY_FLG_NO_ENC      cpu_to_le16(0x0000)
 
960
#define STA_KEY_FLG_WEP         cpu_to_le16(0x0001)
 
961
#define STA_KEY_FLG_CCMP        cpu_to_le16(0x0002)
 
962
#define STA_KEY_FLG_TKIP        cpu_to_le16(0x0003)
 
963
 
 
964
#define STA_KEY_FLG_KEYID_POS   8
 
965
#define STA_KEY_FLG_INVALID     cpu_to_le16(0x0800)
 
966
/* wep key is either from global key (0) or from station info array (1) */
 
967
#define STA_KEY_FLG_MAP_KEY_MSK cpu_to_le16(0x0008)
 
968
 
 
969
/* wep key in STA: 5-bytes (0) or 13-bytes (1) */
 
970
#define STA_KEY_FLG_KEY_SIZE_MSK     cpu_to_le16(0x1000)
 
971
#define STA_KEY_MULTICAST_MSK        cpu_to_le16(0x4000)
 
972
#define STA_KEY_MAX_NUM         8
 
973
 
 
974
/* Flags indicate whether to modify vs. don't change various station params */
 
975
#define STA_MODIFY_KEY_MASK             0x01
 
976
#define STA_MODIFY_TID_DISABLE_TX       0x02
 
977
#define STA_MODIFY_TX_RATE_MSK          0x04
 
978
#define STA_MODIFY_ADDBA_TID_MSK        0x08
 
979
#define STA_MODIFY_DELBA_TID_MSK        0x10
 
980
#define STA_MODIFY_SLEEP_TX_COUNT_MSK   0x20
 
981
 
 
982
/* Receiver address (actually, Rx station's index into station table),
 
983
 * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
 
984
#define BUILD_RAxTID(sta_id, tid)       (((sta_id) << 4) + (tid))
 
985
 
 
986
struct iwl4965_keyinfo {
 
987
        __le16 key_flags;
 
988
        u8 tkip_rx_tsc_byte2;   /* TSC[2] for key mix ph1 detection */
 
989
        u8 reserved1;
 
990
        __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
 
991
        u8 key_offset;
 
992
        u8 reserved2;
 
993
        u8 key[16];             /* 16-byte unicast decryption key */
 
994
} __attribute__ ((packed));
 
995
 
 
996
/* 5000 */
 
997
struct iwl_keyinfo {
 
998
        __le16 key_flags;
 
999
        u8 tkip_rx_tsc_byte2;   /* TSC[2] for key mix ph1 detection */
 
1000
        u8 reserved1;
 
1001
        __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
 
1002
        u8 key_offset;
 
1003
        u8 reserved2;
 
1004
        u8 key[16];             /* 16-byte unicast decryption key */
 
1005
        __le64 tx_secur_seq_cnt;
 
1006
        __le64 hw_tkip_mic_rx_key;
 
1007
        __le64 hw_tkip_mic_tx_key;
 
1008
} __attribute__ ((packed));
 
1009
 
 
1010
/**
 
1011
 * struct sta_id_modify
 
1012
 * @addr[ETH_ALEN]: station's MAC address
 
1013
 * @sta_id: index of station in uCode's station table
 
1014
 * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
 
1015
 *
 
1016
 * Driver selects unused table index when adding new station,
 
1017
 * or the index to a pre-existing station entry when modifying that station.
 
1018
 * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
 
1019
 *
 
1020
 * modify_mask flags select which parameters to modify vs. leave alone.
 
1021
 */
 
1022
struct sta_id_modify {
 
1023
        u8 addr[ETH_ALEN];
 
1024
        __le16 reserved1;
 
1025
        u8 sta_id;
 
1026
        u8 modify_mask;
 
1027
        __le16 reserved2;
 
1028
} __attribute__ ((packed));
 
1029
 
 
1030
/*
 
1031
 * REPLY_ADD_STA = 0x18 (command)
 
1032
 *
 
1033
 * The device contains an internal table of per-station information,
 
1034
 * with info on security keys, aggregation parameters, and Tx rates for
 
1035
 * initial Tx attempt and any retries (4965 uses REPLY_TX_LINK_QUALITY_CMD,
 
1036
 * 3945 uses REPLY_RATE_SCALE to set up rate tables).
 
1037
 *
 
1038
 * REPLY_ADD_STA sets up the table entry for one station, either creating
 
1039
 * a new entry, or modifying a pre-existing one.
 
1040
 *
 
1041
 * NOTE:  RXON command (without "associated" bit set) wipes the station table
 
1042
 *        clean.  Moving into RF_KILL state does this also.  Driver must set up
 
1043
 *        new station table before transmitting anything on the RXON channel
 
1044
 *        (except active scans or active measurements; those commands carry
 
1045
 *        their own txpower/rate setup data).
 
1046
 *
 
1047
 *        When getting started on a new channel, driver must set up the
 
1048
 *        IWL_BROADCAST_ID entry (last entry in the table).  For a client
 
1049
 *        station in a BSS, once an AP is selected, driver sets up the AP STA
 
1050
 *        in the IWL_AP_ID entry (1st entry in the table).  BROADCAST and AP
 
1051
 *        are all that are needed for a BSS client station.  If the device is
 
1052
 *        used as AP, or in an IBSS network, driver must set up station table
 
1053
 *        entries for all STAs in network, starting with index IWL_STA_ID.
 
1054
 */
 
1055
 
 
1056
struct iwl3945_addsta_cmd {
 
1057
        u8 mode;                /* 1: modify existing, 0: add new station */
 
1058
        u8 reserved[3];
 
1059
        struct sta_id_modify sta;
 
1060
        struct iwl4965_keyinfo key;
 
1061
        __le32 station_flags;           /* STA_FLG_* */
 
1062
        __le32 station_flags_msk;       /* STA_FLG_* */
 
1063
 
 
1064
        /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
 
1065
         * corresponding to bit (e.g. bit 5 controls TID 5).
 
1066
         * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
 
1067
        __le16 tid_disable_tx;
 
1068
 
 
1069
        __le16 rate_n_flags;
 
1070
 
 
1071
        /* TID for which to add block-ack support.
 
1072
         * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
 
1073
        u8 add_immediate_ba_tid;
 
1074
 
 
1075
        /* TID for which to remove block-ack support.
 
1076
         * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
 
1077
        u8 remove_immediate_ba_tid;
 
1078
 
 
1079
        /* Starting Sequence Number for added block-ack support.
 
1080
         * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
 
1081
        __le16 add_immediate_ba_ssn;
 
1082
} __attribute__ ((packed));
 
1083
 
 
1084
struct iwl4965_addsta_cmd {
 
1085
        u8 mode;                /* 1: modify existing, 0: add new station */
 
1086
        u8 reserved[3];
 
1087
        struct sta_id_modify sta;
 
1088
        struct iwl4965_keyinfo key;
 
1089
        __le32 station_flags;           /* STA_FLG_* */
 
1090
        __le32 station_flags_msk;       /* STA_FLG_* */
 
1091
 
 
1092
        /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
 
1093
         * corresponding to bit (e.g. bit 5 controls TID 5).
 
1094
         * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
 
1095
        __le16 tid_disable_tx;
 
1096
 
 
1097
        __le16  reserved1;
 
1098
 
 
1099
        /* TID for which to add block-ack support.
 
1100
         * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
 
1101
        u8 add_immediate_ba_tid;
 
1102
 
 
1103
        /* TID for which to remove block-ack support.
 
1104
         * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
 
1105
        u8 remove_immediate_ba_tid;
 
1106
 
 
1107
        /* Starting Sequence Number for added block-ack support.
 
1108
         * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
 
1109
        __le16 add_immediate_ba_ssn;
 
1110
 
 
1111
        /*
 
1112
         * Number of packets OK to transmit to station even though
 
1113
         * it is asleep -- used to synchronise PS-poll and u-APSD
 
1114
         * responses while ucode keeps track of STA sleep state.
 
1115
         */
 
1116
        __le16 sleep_tx_count;
 
1117
 
 
1118
        __le16 reserved2;
 
1119
} __attribute__ ((packed));
 
1120
 
 
1121
/* 5000 */
 
1122
struct iwl_addsta_cmd {
 
1123
        u8 mode;                /* 1: modify existing, 0: add new station */
 
1124
        u8 reserved[3];
 
1125
        struct sta_id_modify sta;
 
1126
        struct iwl_keyinfo key;
 
1127
        __le32 station_flags;           /* STA_FLG_* */
 
1128
        __le32 station_flags_msk;       /* STA_FLG_* */
 
1129
 
 
1130
        /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
 
1131
         * corresponding to bit (e.g. bit 5 controls TID 5).
 
1132
         * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
 
1133
        __le16 tid_disable_tx;
 
1134
 
 
1135
        __le16  rate_n_flags;           /* 3945 only */
 
1136
 
 
1137
        /* TID for which to add block-ack support.
 
1138
         * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
 
1139
        u8 add_immediate_ba_tid;
 
1140
 
 
1141
        /* TID for which to remove block-ack support.
 
1142
         * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
 
1143
        u8 remove_immediate_ba_tid;
 
1144
 
 
1145
        /* Starting Sequence Number for added block-ack support.
 
1146
         * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
 
1147
        __le16 add_immediate_ba_ssn;
 
1148
 
 
1149
        /*
 
1150
         * Number of packets OK to transmit to station even though
 
1151
         * it is asleep -- used to synchronise PS-poll and u-APSD
 
1152
         * responses while ucode keeps track of STA sleep state.
 
1153
         */
 
1154
        __le16 sleep_tx_count;
 
1155
 
 
1156
        __le16 reserved2;
 
1157
} __attribute__ ((packed));
 
1158
 
 
1159
 
 
1160
#define ADD_STA_SUCCESS_MSK             0x1
 
1161
#define ADD_STA_NO_ROOM_IN_TABLE        0x2
 
1162
#define ADD_STA_NO_BLOCK_ACK_RESOURCE   0x4
 
1163
#define ADD_STA_MODIFY_NON_EXIST_STA    0x8
 
1164
/*
 
1165
 * REPLY_ADD_STA = 0x18 (response)
 
1166
 */
 
1167
struct iwl_add_sta_resp {
 
1168
        u8 status;      /* ADD_STA_* */
 
1169
} __attribute__ ((packed));
 
1170
 
 
1171
#define REM_STA_SUCCESS_MSK              0x1
 
1172
/*
 
1173
 *  REPLY_REM_STA = 0x19 (response)
 
1174
 */
 
1175
struct iwl_rem_sta_resp {
 
1176
        u8 status;
 
1177
} __attribute__ ((packed));
 
1178
 
 
1179
/*
 
1180
 *  REPLY_REM_STA = 0x19 (command)
 
1181
 */
 
1182
struct iwl_rem_sta_cmd {
 
1183
        u8 num_sta;     /* number of removed stations */
 
1184
        u8 reserved[3];
 
1185
        u8 addr[ETH_ALEN]; /* MAC addr of the first station */
 
1186
        u8 reserved2[2];
 
1187
} __attribute__ ((packed));
 
1188
 
 
1189
/*
 
1190
 * REPLY_WEP_KEY = 0x20
 
1191
 */
 
1192
struct iwl_wep_key {
 
1193
        u8 key_index;
 
1194
        u8 key_offset;
 
1195
        u8 reserved1[2];
 
1196
        u8 key_size;
 
1197
        u8 reserved2[3];
 
1198
        u8 key[16];
 
1199
} __attribute__ ((packed));
 
1200
 
 
1201
struct iwl_wep_cmd {
 
1202
        u8 num_keys;
 
1203
        u8 global_key_type;
 
1204
        u8 flags;
 
1205
        u8 reserved;
 
1206
        struct iwl_wep_key key[0];
 
1207
} __attribute__ ((packed));
 
1208
 
 
1209
#define WEP_KEY_WEP_TYPE 1
 
1210
#define WEP_KEYS_MAX 4
 
1211
#define WEP_INVALID_OFFSET 0xff
 
1212
#define WEP_KEY_LEN_64 5
 
1213
#define WEP_KEY_LEN_128 13
 
1214
 
 
1215
/******************************************************************************
 
1216
 * (4)
 
1217
 * Rx Responses:
 
1218
 *
 
1219
 *****************************************************************************/
 
1220
 
 
1221
#define RX_RES_STATUS_NO_CRC32_ERROR    cpu_to_le32(1 << 0)
 
1222
#define RX_RES_STATUS_NO_RXE_OVERFLOW   cpu_to_le32(1 << 1)
 
1223
 
 
1224
#define RX_RES_PHY_FLAGS_BAND_24_MSK    cpu_to_le16(1 << 0)
 
1225
#define RX_RES_PHY_FLAGS_MOD_CCK_MSK            cpu_to_le16(1 << 1)
 
1226
#define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK     cpu_to_le16(1 << 2)
 
1227
#define RX_RES_PHY_FLAGS_NARROW_BAND_MSK        cpu_to_le16(1 << 3)
 
1228
#define RX_RES_PHY_FLAGS_ANTENNA_MSK            0xf0
 
1229
#define RX_RES_PHY_FLAGS_ANTENNA_POS            4
 
1230
 
 
1231
#define RX_RES_STATUS_SEC_TYPE_MSK      (0x7 << 8)
 
1232
#define RX_RES_STATUS_SEC_TYPE_NONE     (0x0 << 8)
 
1233
#define RX_RES_STATUS_SEC_TYPE_WEP      (0x1 << 8)
 
1234
#define RX_RES_STATUS_SEC_TYPE_CCMP     (0x2 << 8)
 
1235
#define RX_RES_STATUS_SEC_TYPE_TKIP     (0x3 << 8)
 
1236
#define RX_RES_STATUS_SEC_TYPE_ERR      (0x7 << 8)
 
1237
 
 
1238
#define RX_RES_STATUS_STATION_FOUND     (1<<6)
 
1239
#define RX_RES_STATUS_NO_STATION_INFO_MISMATCH  (1<<7)
 
1240
 
 
1241
#define RX_RES_STATUS_DECRYPT_TYPE_MSK  (0x3 << 11)
 
1242
#define RX_RES_STATUS_NOT_DECRYPT       (0x0 << 11)
 
1243
#define RX_RES_STATUS_DECRYPT_OK        (0x3 << 11)
 
1244
#define RX_RES_STATUS_BAD_ICV_MIC       (0x1 << 11)
 
1245
#define RX_RES_STATUS_BAD_KEY_TTAK      (0x2 << 11)
 
1246
 
 
1247
#define RX_MPDU_RES_STATUS_ICV_OK       (0x20)
 
1248
#define RX_MPDU_RES_STATUS_MIC_OK       (0x40)
 
1249
#define RX_MPDU_RES_STATUS_TTAK_OK      (1 << 7)
 
1250
#define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800)
 
1251
 
 
1252
 
 
1253
struct iwl3945_rx_frame_stats {
 
1254
        u8 phy_count;
 
1255
        u8 id;
 
1256
        u8 rssi;
 
1257
        u8 agc;
 
1258
        __le16 sig_avg;
 
1259
        __le16 noise_diff;
 
1260
        u8 payload[0];
 
1261
} __attribute__ ((packed));
 
1262
 
 
1263
struct iwl3945_rx_frame_hdr {
 
1264
        __le16 channel;
 
1265
        __le16 phy_flags;
 
1266
        u8 reserved1;
 
1267
        u8 rate;
 
1268
        __le16 len;
 
1269
        u8 payload[0];
 
1270
} __attribute__ ((packed));
 
1271
 
 
1272
struct iwl3945_rx_frame_end {
 
1273
        __le32 status;
 
1274
        __le64 timestamp;
 
1275
        __le32 beacon_timestamp;
 
1276
} __attribute__ ((packed));
 
1277
 
 
1278
/*
 
1279
 * REPLY_3945_RX = 0x1b (response only, not a command)
 
1280
 *
 
1281
 * NOTE:  DO NOT dereference from casts to this structure
 
1282
 * It is provided only for calculating minimum data set size.
 
1283
 * The actual offsets of the hdr and end are dynamic based on
 
1284
 * stats.phy_count
 
1285
 */
 
1286
struct iwl3945_rx_frame {
 
1287
        struct iwl3945_rx_frame_stats stats;
 
1288
        struct iwl3945_rx_frame_hdr hdr;
 
1289
        struct iwl3945_rx_frame_end end;
 
1290
} __attribute__ ((packed));
 
1291
 
 
1292
#define IWL39_RX_FRAME_SIZE     (4 + sizeof(struct iwl3945_rx_frame))
 
1293
 
 
1294
/* Fixed (non-configurable) rx data from phy */
 
1295
 
 
1296
#define IWL49_RX_RES_PHY_CNT 14
 
1297
#define IWL49_RX_PHY_FLAGS_ANTENNAE_OFFSET      (4)
 
1298
#define IWL49_RX_PHY_FLAGS_ANTENNAE_MASK        (0x70)
 
1299
#define IWL49_AGC_DB_MASK                       (0x3f80)        /* MASK(7,13) */
 
1300
#define IWL49_AGC_DB_POS                        (7)
 
1301
struct iwl4965_rx_non_cfg_phy {
 
1302
        __le16 ant_selection;   /* ant A bit 4, ant B bit 5, ant C bit 6 */
 
1303
        __le16 agc_info;        /* agc code 0:6, agc dB 7:13, reserved 14:15 */
 
1304
        u8 rssi_info[6];        /* we use even entries, 0/2/4 for A/B/C rssi */
 
1305
        u8 pad[0];
 
1306
} __attribute__ ((packed));
 
1307
 
 
1308
 
 
1309
#define IWL50_RX_RES_PHY_CNT 8
 
1310
#define IWL50_RX_RES_AGC_IDX     1
 
1311
#define IWL50_RX_RES_RSSI_AB_IDX 2
 
1312
#define IWL50_RX_RES_RSSI_C_IDX  3
 
1313
#define IWL50_OFDM_AGC_MSK 0xfe00
 
1314
#define IWL50_OFDM_AGC_BIT_POS 9
 
1315
#define IWL50_OFDM_RSSI_A_MSK 0x00ff
 
1316
#define IWL50_OFDM_RSSI_A_BIT_POS 0
 
1317
#define IWL50_OFDM_RSSI_B_MSK 0xff0000
 
1318
#define IWL50_OFDM_RSSI_B_BIT_POS 16
 
1319
#define IWL50_OFDM_RSSI_C_MSK 0x00ff
 
1320
#define IWL50_OFDM_RSSI_C_BIT_POS 0
 
1321
 
 
1322
struct iwl5000_non_cfg_phy {
 
1323
        __le32 non_cfg_phy[IWL50_RX_RES_PHY_CNT];  /* up to 8 phy entries */
 
1324
} __attribute__ ((packed));
 
1325
 
 
1326
 
 
1327
/*
 
1328
 * REPLY_RX = 0xc3 (response only, not a command)
 
1329
 * Used only for legacy (non 11n) frames.
 
1330
 */
 
1331
struct iwl_rx_phy_res {
 
1332
        u8 non_cfg_phy_cnt;     /* non configurable DSP phy data byte count */
 
1333
        u8 cfg_phy_cnt;         /* configurable DSP phy data byte count */
 
1334
        u8 stat_id;             /* configurable DSP phy data set ID */
 
1335
        u8 reserved1;
 
1336
        __le64 timestamp;       /* TSF at on air rise */
 
1337
        __le32 beacon_time_stamp; /* beacon at on-air rise */
 
1338
        __le16 phy_flags;       /* general phy flags: band, modulation, ... */
 
1339
        __le16 channel;         /* channel number */
 
1340
        u8 non_cfg_phy_buf[32]; /* for various implementations of non_cfg_phy */
 
1341
        __le32 rate_n_flags;    /* RATE_MCS_* */
 
1342
        __le16 byte_count;      /* frame's byte-count */
 
1343
        __le16 reserved3;
 
1344
} __attribute__ ((packed));
 
1345
 
 
1346
struct iwl4965_rx_mpdu_res_start {
 
1347
        __le16 byte_count;
 
1348
        __le16 reserved;
 
1349
} __attribute__ ((packed));
 
1350
 
 
1351
 
 
1352
/******************************************************************************
 
1353
 * (5)
 
1354
 * Tx Commands & Responses:
 
1355
 *
 
1356
 * Driver must place each REPLY_TX command into one of the prioritized Tx
 
1357
 * queues in host DRAM, shared between driver and device (see comments for
 
1358
 * SCD registers and Tx/Rx Queues).  When the device's Tx scheduler and uCode
 
1359
 * are preparing to transmit, the device pulls the Tx command over the PCI
 
1360
 * bus via one of the device's Tx DMA channels, to fill an internal FIFO
 
1361
 * from which data will be transmitted.
 
1362
 *
 
1363
 * uCode handles all timing and protocol related to control frames
 
1364
 * (RTS/CTS/ACK), based on flags in the Tx command.  uCode and Tx scheduler
 
1365
 * handle reception of block-acks; uCode updates the host driver via
 
1366
 * REPLY_COMPRESSED_BA (4965).
 
1367
 *
 
1368
 * uCode handles retrying Tx when an ACK is expected but not received.
 
1369
 * This includes trying lower data rates than the one requested in the Tx
 
1370
 * command, as set up by the REPLY_RATE_SCALE (for 3945) or
 
1371
 * REPLY_TX_LINK_QUALITY_CMD (4965).
 
1372
 *
 
1373
 * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
 
1374
 * This command must be executed after every RXON command, before Tx can occur.
 
1375
 *****************************************************************************/
 
1376
 
 
1377
/* REPLY_TX Tx flags field */
 
1378
 
 
1379
/* 1: Use RTS/CTS protocol or CTS-to-self if spec allows it
 
1380
 * before this frame. if CTS-to-self required check
 
1381
 * RXON_FLG_SELF_CTS_EN status. */
 
1382
#define TX_CMD_FLG_RTS_CTS_MSK cpu_to_le32(1 << 0)
 
1383
 
 
1384
/* 1: Use Request-To-Send protocol before this frame.
 
1385
 * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK. */
 
1386
#define TX_CMD_FLG_RTS_MSK cpu_to_le32(1 << 1)
 
1387
 
 
1388
/* 1: Transmit Clear-To-Send to self before this frame.
 
1389
 * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
 
1390
 * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK. */
 
1391
#define TX_CMD_FLG_CTS_MSK cpu_to_le32(1 << 2)
 
1392
 
 
1393
/* 1: Expect ACK from receiving station
 
1394
 * 0: Don't expect ACK (MAC header's duration field s/b 0)
 
1395
 * Set this for unicast frames, but not broadcast/multicast. */
 
1396
#define TX_CMD_FLG_ACK_MSK cpu_to_le32(1 << 3)
 
1397
 
 
1398
/* For 4965:
 
1399
 * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
 
1400
 *    Tx command's initial_rate_index indicates first rate to try;
 
1401
 *    uCode walks through table for additional Tx attempts.
 
1402
 * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
 
1403
 *    This rate will be used for all Tx attempts; it will not be scaled. */
 
1404
#define TX_CMD_FLG_STA_RATE_MSK cpu_to_le32(1 << 4)
 
1405
 
 
1406
/* 1: Expect immediate block-ack.
 
1407
 * Set when Txing a block-ack request frame.  Also set TX_CMD_FLG_ACK_MSK. */
 
1408
#define TX_CMD_FLG_IMM_BA_RSP_MASK  cpu_to_le32(1 << 6)
 
1409
 
 
1410
/* 1: Frame requires full Tx-Op protection.
 
1411
 * Set this if either RTS or CTS Tx Flag gets set. */
 
1412
#define TX_CMD_FLG_FULL_TXOP_PROT_MSK cpu_to_le32(1 << 7)
 
1413
 
 
1414
/* Tx antenna selection field; used only for 3945, reserved (0) for 4965.
 
1415
 * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
 
1416
#define TX_CMD_FLG_ANT_SEL_MSK cpu_to_le32(0xf00)
 
1417
#define TX_CMD_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
 
1418
#define TX_CMD_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
 
1419
 
 
1420
/* 1: Ignore Bluetooth priority for this frame.
 
1421
 * 0: Delay Tx until Bluetooth device is done (normal usage). */
 
1422
#define TX_CMD_FLG_BT_DIS_MSK cpu_to_le32(1 << 12)
 
1423
 
 
1424
/* 1: uCode overrides sequence control field in MAC header.
 
1425
 * 0: Driver provides sequence control field in MAC header.
 
1426
 * Set this for management frames, non-QOS data frames, non-unicast frames,
 
1427
 * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
 
1428
#define TX_CMD_FLG_SEQ_CTL_MSK cpu_to_le32(1 << 13)
 
1429
 
 
1430
/* 1: This frame is non-last MPDU; more fragments are coming.
 
1431
 * 0: Last fragment, or not using fragmentation. */
 
1432
#define TX_CMD_FLG_MORE_FRAG_MSK cpu_to_le32(1 << 14)
 
1433
 
 
1434
/* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
 
1435
 * 0: No TSF required in outgoing frame.
 
1436
 * Set this for transmitting beacons and probe responses. */
 
1437
#define TX_CMD_FLG_TSF_MSK cpu_to_le32(1 << 16)
 
1438
 
 
1439
/* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
 
1440
 *    alignment of frame's payload data field.
 
1441
 * 0: No pad
 
1442
 * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
 
1443
 * field (but not both).  Driver must align frame data (i.e. data following
 
1444
 * MAC header) to DWORD boundary. */
 
1445
#define TX_CMD_FLG_MH_PAD_MSK cpu_to_le32(1 << 20)
 
1446
 
 
1447
/* accelerate aggregation support
 
1448
 * 0 - no CCMP encryption; 1 - CCMP encryption */
 
1449
#define TX_CMD_FLG_AGG_CCMP_MSK cpu_to_le32(1 << 22)
 
1450
 
 
1451
/* HCCA-AP - disable duration overwriting. */
 
1452
#define TX_CMD_FLG_DUR_MSK cpu_to_le32(1 << 25)
 
1453
 
 
1454
 
 
1455
/*
 
1456
 * TX command security control
 
1457
 */
 
1458
#define TX_CMD_SEC_WEP          0x01
 
1459
#define TX_CMD_SEC_CCM          0x02
 
1460
#define TX_CMD_SEC_TKIP         0x03
 
1461
#define TX_CMD_SEC_MSK          0x03
 
1462
#define TX_CMD_SEC_SHIFT        6
 
1463
#define TX_CMD_SEC_KEY128       0x08
 
1464
 
 
1465
/*
 
1466
 * security overhead sizes
 
1467
 */
 
1468
#define WEP_IV_LEN 4
 
1469
#define WEP_ICV_LEN 4
 
1470
#define CCMP_MIC_LEN 8
 
1471
#define TKIP_ICV_LEN 4
 
1472
 
 
1473
/*
 
1474
 * REPLY_TX = 0x1c (command)
 
1475
 */
 
1476
 
 
1477
struct iwl3945_tx_cmd {
 
1478
        /*
 
1479
         * MPDU byte count:
 
1480
         * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
 
1481
         * + 8 byte IV for CCM or TKIP (not used for WEP)
 
1482
         * + Data payload
 
1483
         * + 8-byte MIC (not used for CCM/WEP)
 
1484
         * NOTE:  Does not include Tx command bytes, post-MAC pad bytes,
 
1485
         *        MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
 
1486
         * Range: 14-2342 bytes.
 
1487
         */
 
1488
        __le16 len;
 
1489
 
 
1490
        /*
 
1491
         * MPDU or MSDU byte count for next frame.
 
1492
         * Used for fragmentation and bursting, but not 11n aggregation.
 
1493
         * Same as "len", but for next frame.  Set to 0 if not applicable.
 
1494
         */
 
1495
        __le16 next_frame_len;
 
1496
 
 
1497
        __le32 tx_flags;        /* TX_CMD_FLG_* */
 
1498
 
 
1499
        u8 rate;
 
1500
 
 
1501
        /* Index of recipient station in uCode's station table */
 
1502
        u8 sta_id;
 
1503
        u8 tid_tspec;
 
1504
        u8 sec_ctl;
 
1505
        u8 key[16];
 
1506
        union {
 
1507
                u8 byte[8];
 
1508
                __le16 word[4];
 
1509
                __le32 dw[2];
 
1510
        } tkip_mic;
 
1511
        __le32 next_frame_info;
 
1512
        union {
 
1513
                __le32 life_time;
 
1514
                __le32 attempt;
 
1515
        } stop_time;
 
1516
        u8 supp_rates[2];
 
1517
        u8 rts_retry_limit;     /*byte 50 */
 
1518
        u8 data_retry_limit;    /*byte 51 */
 
1519
        union {
 
1520
                __le16 pm_frame_timeout;
 
1521
                __le16 attempt_duration;
 
1522
        } timeout;
 
1523
 
 
1524
        /*
 
1525
         * Duration of EDCA burst Tx Opportunity, in 32-usec units.
 
1526
         * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
 
1527
         */
 
1528
        __le16 driver_txop;
 
1529
 
 
1530
        /*
 
1531
         * MAC header goes here, followed by 2 bytes padding if MAC header
 
1532
         * length is 26 or 30 bytes, followed by payload data
 
1533
         */
 
1534
        u8 payload[0];
 
1535
        struct ieee80211_hdr hdr[0];
 
1536
} __attribute__ ((packed));
 
1537
 
 
1538
/*
 
1539
 * REPLY_TX = 0x1c (response)
 
1540
 */
 
1541
struct iwl3945_tx_resp {
 
1542
        u8 failure_rts;
 
1543
        u8 failure_frame;
 
1544
        u8 bt_kill_count;
 
1545
        u8 rate;
 
1546
        __le32 wireless_media_time;
 
1547
        __le32 status;          /* TX status */
 
1548
} __attribute__ ((packed));
 
1549
 
 
1550
 
 
1551
/*
 
1552
 * 4965 uCode updates these Tx attempt count values in host DRAM.
 
1553
 * Used for managing Tx retries when expecting block-acks.
 
1554
 * Driver should set these fields to 0.
 
1555
 */
 
1556
struct iwl_dram_scratch {
 
1557
        u8 try_cnt;             /* Tx attempts */
 
1558
        u8 bt_kill_cnt;         /* Tx attempts blocked by Bluetooth device */
 
1559
        __le16 reserved;
 
1560
} __attribute__ ((packed));
 
1561
 
 
1562
struct iwl_tx_cmd {
 
1563
        /*
 
1564
         * MPDU byte count:
 
1565
         * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
 
1566
         * + 8 byte IV for CCM or TKIP (not used for WEP)
 
1567
         * + Data payload
 
1568
         * + 8-byte MIC (not used for CCM/WEP)
 
1569
         * NOTE:  Does not include Tx command bytes, post-MAC pad bytes,
 
1570
         *        MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
 
1571
         * Range: 14-2342 bytes.
 
1572
         */
 
1573
        __le16 len;
 
1574
 
 
1575
        /*
 
1576
         * MPDU or MSDU byte count for next frame.
 
1577
         * Used for fragmentation and bursting, but not 11n aggregation.
 
1578
         * Same as "len", but for next frame.  Set to 0 if not applicable.
 
1579
         */
 
1580
        __le16 next_frame_len;
 
1581
 
 
1582
        __le32 tx_flags;        /* TX_CMD_FLG_* */
 
1583
 
 
1584
        /* uCode may modify this field of the Tx command (in host DRAM!).
 
1585
         * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
 
1586
        struct iwl_dram_scratch scratch;
 
1587
 
 
1588
        /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
 
1589
        __le32 rate_n_flags;    /* RATE_MCS_* */
 
1590
 
 
1591
        /* Index of destination station in uCode's station table */
 
1592
        u8 sta_id;
 
1593
 
 
1594
        /* Type of security encryption:  CCM or TKIP */
 
1595
        u8 sec_ctl;             /* TX_CMD_SEC_* */
 
1596
 
 
1597
        /*
 
1598
         * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial
 
1599
         * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set.  Normally "0" for
 
1600
         * data frames, this field may be used to selectively reduce initial
 
1601
         * rate (via non-0 value) for special frames (e.g. management), while
 
1602
         * still supporting rate scaling for all frames.
 
1603
         */
 
1604
        u8 initial_rate_index;
 
1605
        u8 reserved;
 
1606
        u8 key[16];
 
1607
        __le16 next_frame_flags;
 
1608
        __le16 reserved2;
 
1609
        union {
 
1610
                __le32 life_time;
 
1611
                __le32 attempt;
 
1612
        } stop_time;
 
1613
 
 
1614
        /* Host DRAM physical address pointer to "scratch" in this command.
 
1615
         * Must be dword aligned.  "0" in dram_lsb_ptr disables usage. */
 
1616
        __le32 dram_lsb_ptr;
 
1617
        u8 dram_msb_ptr;
 
1618
 
 
1619
        u8 rts_retry_limit;     /*byte 50 */
 
1620
        u8 data_retry_limit;    /*byte 51 */
 
1621
        u8 tid_tspec;
 
1622
        union {
 
1623
                __le16 pm_frame_timeout;
 
1624
                __le16 attempt_duration;
 
1625
        } timeout;
 
1626
 
 
1627
        /*
 
1628
         * Duration of EDCA burst Tx Opportunity, in 32-usec units.
 
1629
         * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
 
1630
         */
 
1631
        __le16 driver_txop;
 
1632
 
 
1633
        /*
 
1634
         * MAC header goes here, followed by 2 bytes padding if MAC header
 
1635
         * length is 26 or 30 bytes, followed by payload data
 
1636
         */
 
1637
        u8 payload[0];
 
1638
        struct ieee80211_hdr hdr[0];
 
1639
} __attribute__ ((packed));
 
1640
 
 
1641
/* TX command response is sent after *all* transmission attempts.
 
1642
 *
 
1643
 * NOTES:
 
1644
 *
 
1645
 * TX_STATUS_FAIL_NEXT_FRAG
 
1646
 *
 
1647
 * If the fragment flag in the MAC header for the frame being transmitted
 
1648
 * is set and there is insufficient time to transmit the next frame, the
 
1649
 * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
 
1650
 *
 
1651
 * TX_STATUS_FIFO_UNDERRUN
 
1652
 *
 
1653
 * Indicates the host did not provide bytes to the FIFO fast enough while
 
1654
 * a TX was in progress.
 
1655
 *
 
1656
 * TX_STATUS_FAIL_MGMNT_ABORT
 
1657
 *
 
1658
 * This status is only possible if the ABORT ON MGMT RX parameter was
 
1659
 * set to true with the TX command.
 
1660
 *
 
1661
 * If the MSB of the status parameter is set then an abort sequence is
 
1662
 * required.  This sequence consists of the host activating the TX Abort
 
1663
 * control line, and then waiting for the TX Abort command response.  This
 
1664
 * indicates that a the device is no longer in a transmit state, and that the
 
1665
 * command FIFO has been cleared.  The host must then deactivate the TX Abort
 
1666
 * control line.  Receiving is still allowed in this case.
 
1667
 */
 
1668
enum {
 
1669
        TX_STATUS_SUCCESS = 0x01,
 
1670
        TX_STATUS_DIRECT_DONE = 0x02,
 
1671
        TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
 
1672
        TX_STATUS_FAIL_LONG_LIMIT = 0x83,
 
1673
        TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
 
1674
        TX_STATUS_FAIL_MGMNT_ABORT = 0x85,
 
1675
        TX_STATUS_FAIL_NEXT_FRAG = 0x86,
 
1676
        TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
 
1677
        TX_STATUS_FAIL_DEST_PS = 0x88,
 
1678
        TX_STATUS_FAIL_ABORTED = 0x89,
 
1679
        TX_STATUS_FAIL_BT_RETRY = 0x8a,
 
1680
        TX_STATUS_FAIL_STA_INVALID = 0x8b,
 
1681
        TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
 
1682
        TX_STATUS_FAIL_TID_DISABLE = 0x8d,
 
1683
        TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
 
1684
        TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
 
1685
        TX_STATUS_FAIL_TX_LOCKED = 0x90,
 
1686
        TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
 
1687
};
 
1688
 
 
1689
#define TX_PACKET_MODE_REGULAR          0x0000
 
1690
#define TX_PACKET_MODE_BURST_SEQ        0x0100
 
1691
#define TX_PACKET_MODE_BURST_FIRST      0x0200
 
1692
 
 
1693
enum {
 
1694
        TX_POWER_PA_NOT_ACTIVE = 0x0,
 
1695
};
 
1696
 
 
1697
enum {
 
1698
        TX_STATUS_MSK = 0x000000ff,             /* bits 0:7 */
 
1699
        TX_STATUS_DELAY_MSK = 0x00000040,
 
1700
        TX_STATUS_ABORT_MSK = 0x00000080,
 
1701
        TX_PACKET_MODE_MSK = 0x0000ff00,        /* bits 8:15 */
 
1702
        TX_FIFO_NUMBER_MSK = 0x00070000,        /* bits 16:18 */
 
1703
        TX_RESERVED = 0x00780000,               /* bits 19:22 */
 
1704
        TX_POWER_PA_DETECT_MSK = 0x7f800000,    /* bits 23:30 */
 
1705
        TX_ABORT_REQUIRED_MSK = 0x80000000,     /* bits 31:31 */
 
1706
};
 
1707
 
 
1708
static inline u32 iwl_tx_status_to_mac80211(u32 status)
 
1709
{
 
1710
        status &= TX_STATUS_MSK;
 
1711
 
 
1712
        switch (status) {
 
1713
        case TX_STATUS_SUCCESS:
 
1714
        case TX_STATUS_DIRECT_DONE:
 
1715
                return IEEE80211_TX_STAT_ACK;
 
1716
        case TX_STATUS_FAIL_DEST_PS:
 
1717
                return IEEE80211_TX_STAT_TX_FILTERED;
 
1718
        default:
 
1719
                return 0;
 
1720
        }
 
1721
}
 
1722
 
 
1723
static inline bool iwl_is_tx_success(u32 status)
 
1724
{
 
1725
        status &= TX_STATUS_MSK;
 
1726
        return (status == TX_STATUS_SUCCESS) ||
 
1727
               (status == TX_STATUS_DIRECT_DONE);
 
1728
}
 
1729
 
 
1730
 
 
1731
 
 
1732
/* *******************************
 
1733
 * TX aggregation status
 
1734
 ******************************* */
 
1735
 
 
1736
enum {
 
1737
        AGG_TX_STATE_TRANSMITTED = 0x00,
 
1738
        AGG_TX_STATE_UNDERRUN_MSK = 0x01,
 
1739
        AGG_TX_STATE_BT_PRIO_MSK = 0x02,
 
1740
        AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
 
1741
        AGG_TX_STATE_ABORT_MSK = 0x08,
 
1742
        AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
 
1743
        AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
 
1744
        AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
 
1745
        AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
 
1746
        AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
 
1747
        AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
 
1748
        AGG_TX_STATE_DUMP_TX_MSK = 0x200,
 
1749
        AGG_TX_STATE_DELAY_TX_MSK = 0x400
 
1750
};
 
1751
 
 
1752
#define AGG_TX_STATE_LAST_SENT_MSK  (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
 
1753
                                     AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
 
1754
                                     AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
 
1755
 
 
1756
/* # tx attempts for first frame in aggregation */
 
1757
#define AGG_TX_STATE_TRY_CNT_POS 12
 
1758
#define AGG_TX_STATE_TRY_CNT_MSK 0xf000
 
1759
 
 
1760
/* Command ID and sequence number of Tx command for this frame */
 
1761
#define AGG_TX_STATE_SEQ_NUM_POS 16
 
1762
#define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
 
1763
 
 
1764
/*
 
1765
 * REPLY_TX = 0x1c (response)
 
1766
 *
 
1767
 * This response may be in one of two slightly different formats, indicated
 
1768
 * by the frame_count field:
 
1769
 *
 
1770
 * 1)  No aggregation (frame_count == 1).  This reports Tx results for
 
1771
 *     a single frame.  Multiple attempts, at various bit rates, may have
 
1772
 *     been made for this frame.
 
1773
 *
 
1774
 * 2)  Aggregation (frame_count > 1).  This reports Tx results for
 
1775
 *     2 or more frames that used block-acknowledge.  All frames were
 
1776
 *     transmitted at same rate.  Rate scaling may have been used if first
 
1777
 *     frame in this new agg block failed in previous agg block(s).
 
1778
 *
 
1779
 *     Note that, for aggregation, ACK (block-ack) status is not delivered here;
 
1780
 *     block-ack has not been received by the time the 4965 records this status.
 
1781
 *     This status relates to reasons the tx might have been blocked or aborted
 
1782
 *     within the sending station (this 4965), rather than whether it was
 
1783
 *     received successfully by the destination station.
 
1784
 */
 
1785
struct agg_tx_status {
 
1786
        __le16 status;
 
1787
        __le16 sequence;
 
1788
} __attribute__ ((packed));
 
1789
 
 
1790
struct iwl4965_tx_resp {
 
1791
        u8 frame_count;         /* 1 no aggregation, >1 aggregation */
 
1792
        u8 bt_kill_count;       /* # blocked by bluetooth (unused for agg) */
 
1793
        u8 failure_rts;         /* # failures due to unsuccessful RTS */
 
1794
        u8 failure_frame;       /* # failures due to no ACK (unused for agg) */
 
1795
 
 
1796
        /* For non-agg:  Rate at which frame was successful.
 
1797
         * For agg:  Rate at which all frames were transmitted. */
 
1798
        __le32 rate_n_flags;    /* RATE_MCS_*  */
 
1799
 
 
1800
        /* For non-agg:  RTS + CTS + frame tx attempts time + ACK.
 
1801
         * For agg:  RTS + CTS + aggregation tx time + block-ack time. */
 
1802
        __le16 wireless_media_time;     /* uSecs */
 
1803
 
 
1804
        __le16 reserved;
 
1805
        __le32 pa_power1;       /* RF power amplifier measurement (not used) */
 
1806
        __le32 pa_power2;
 
1807
 
 
1808
        /*
 
1809
         * For non-agg:  frame status TX_STATUS_*
 
1810
         * For agg:  status of 1st frame, AGG_TX_STATE_*; other frame status
 
1811
         *           fields follow this one, up to frame_count.
 
1812
         *           Bit fields:
 
1813
         *           11- 0:  AGG_TX_STATE_* status code
 
1814
         *           15-12:  Retry count for 1st frame in aggregation (retries
 
1815
         *                   occur if tx failed for this frame when it was a
 
1816
         *                   member of a previous aggregation block).  If rate
 
1817
         *                   scaling is used, retry count indicates the rate
 
1818
         *                   table entry used for all frames in the new agg.
 
1819
         *           31-16:  Sequence # for this frame's Tx cmd (not SSN!)
 
1820
         */
 
1821
        union {
 
1822
                __le32 status;
 
1823
                struct agg_tx_status agg_status[0]; /* for each agg frame */
 
1824
        } u;
 
1825
} __attribute__ ((packed));
 
1826
 
 
1827
/*
 
1828
 * definitions for initial rate index field
 
1829
 * bits [3:0] initial rate index
 
1830
 * bits [6:4] rate table color, used for the initial rate
 
1831
 * bit-7 invalid rate indication
 
1832
 *   i.e. rate was not chosen from rate table
 
1833
 *   or rate table color was changed during frame retries
 
1834
 * refer tlc rate info
 
1835
 */
 
1836
 
 
1837
#define IWL50_TX_RES_INIT_RATE_INDEX_POS        0
 
1838
#define IWL50_TX_RES_INIT_RATE_INDEX_MSK        0x0f
 
1839
#define IWL50_TX_RES_RATE_TABLE_COLOR_POS       4
 
1840
#define IWL50_TX_RES_RATE_TABLE_COLOR_MSK       0x70
 
1841
#define IWL50_TX_RES_INV_RATE_INDEX_MSK 0x80
 
1842
 
 
1843
/* refer to ra_tid */
 
1844
#define IWL50_TX_RES_TID_POS    0
 
1845
#define IWL50_TX_RES_TID_MSK    0x0f
 
1846
#define IWL50_TX_RES_RA_POS     4
 
1847
#define IWL50_TX_RES_RA_MSK     0xf0
 
1848
 
 
1849
struct iwl5000_tx_resp {
 
1850
        u8 frame_count;         /* 1 no aggregation, >1 aggregation */
 
1851
        u8 bt_kill_count;       /* # blocked by bluetooth (unused for agg) */
 
1852
        u8 failure_rts;         /* # failures due to unsuccessful RTS */
 
1853
        u8 failure_frame;       /* # failures due to no ACK (unused for agg) */
 
1854
 
 
1855
        /* For non-agg:  Rate at which frame was successful.
 
1856
         * For agg:  Rate at which all frames were transmitted. */
 
1857
        __le32 rate_n_flags;    /* RATE_MCS_*  */
 
1858
 
 
1859
        /* For non-agg:  RTS + CTS + frame tx attempts time + ACK.
 
1860
         * For agg:  RTS + CTS + aggregation tx time + block-ack time. */
 
1861
        __le16 wireless_media_time;     /* uSecs */
 
1862
 
 
1863
        u8 pa_status;           /* RF power amplifier measurement (not used) */
 
1864
        u8 pa_integ_res_a[3];
 
1865
        u8 pa_integ_res_b[3];
 
1866
        u8 pa_integ_res_C[3];
 
1867
 
 
1868
        __le32 tfd_info;
 
1869
        __le16 seq_ctl;
 
1870
        __le16 byte_cnt;
 
1871
        u8 tlc_info;
 
1872
        u8 ra_tid;              /* tid (0:3), sta_id (4:7) */
 
1873
        __le16 frame_ctrl;
 
1874
        /*
 
1875
         * For non-agg:  frame status TX_STATUS_*
 
1876
         * For agg:  status of 1st frame, AGG_TX_STATE_*; other frame status
 
1877
         *           fields follow this one, up to frame_count.
 
1878
         *           Bit fields:
 
1879
         *           11- 0:  AGG_TX_STATE_* status code
 
1880
         *           15-12:  Retry count for 1st frame in aggregation (retries
 
1881
         *                   occur if tx failed for this frame when it was a
 
1882
         *                   member of a previous aggregation block).  If rate
 
1883
         *                   scaling is used, retry count indicates the rate
 
1884
         *                   table entry used for all frames in the new agg.
 
1885
         *           31-16:  Sequence # for this frame's Tx cmd (not SSN!)
 
1886
         */
 
1887
        struct agg_tx_status status;    /* TX status (in aggregation -
 
1888
                                         * status of 1st frame) */
 
1889
} __attribute__ ((packed));
 
1890
/*
 
1891
 * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
 
1892
 *
 
1893
 * Reports Block-Acknowledge from recipient station
 
1894
 */
 
1895
struct iwl_compressed_ba_resp {
 
1896
        __le32 sta_addr_lo32;
 
1897
        __le16 sta_addr_hi16;
 
1898
        __le16 reserved;
 
1899
 
 
1900
        /* Index of recipient (BA-sending) station in uCode's station table */
 
1901
        u8 sta_id;
 
1902
        u8 tid;
 
1903
        __le16 seq_ctl;
 
1904
        __le64 bitmap;
 
1905
        __le16 scd_flow;
 
1906
        __le16 scd_ssn;
 
1907
} __attribute__ ((packed));
 
1908
 
 
1909
/*
 
1910
 * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
 
1911
 *
 
1912
 * See details under "TXPOWER" in iwl-4965-hw.h.
 
1913
 */
 
1914
 
 
1915
struct iwl3945_txpowertable_cmd {
 
1916
        u8 band;                /* 0: 5 GHz, 1: 2.4 GHz */
 
1917
        u8 reserved;
 
1918
        __le16 channel;
 
1919
        struct iwl3945_power_per_rate power[IWL_MAX_RATES];
 
1920
} __attribute__ ((packed));
 
1921
 
 
1922
struct iwl4965_txpowertable_cmd {
 
1923
        u8 band;                /* 0: 5 GHz, 1: 2.4 GHz */
 
1924
        u8 reserved;
 
1925
        __le16 channel;
 
1926
        struct iwl4965_tx_power_db tx_power;
 
1927
} __attribute__ ((packed));
 
1928
 
 
1929
 
 
1930
/**
 
1931
 * struct iwl3945_rate_scaling_cmd - Rate Scaling Command & Response
 
1932
 *
 
1933
 * REPLY_RATE_SCALE = 0x47 (command, has simple generic response)
 
1934
 *
 
1935
 * NOTE: The table of rates passed to the uCode via the
 
1936
 * RATE_SCALE command sets up the corresponding order of
 
1937
 * rates used for all related commands, including rate
 
1938
 * masks, etc.
 
1939
 *
 
1940
 * For example, if you set 9MB (PLCP 0x0f) as the first
 
1941
 * rate in the rate table, the bit mask for that rate
 
1942
 * when passed through ofdm_basic_rates on the REPLY_RXON
 
1943
 * command would be bit 0 (1 << 0)
 
1944
 */
 
1945
struct iwl3945_rate_scaling_info {
 
1946
        __le16 rate_n_flags;
 
1947
        u8 try_cnt;
 
1948
        u8 next_rate_index;
 
1949
} __attribute__ ((packed));
 
1950
 
 
1951
struct iwl3945_rate_scaling_cmd {
 
1952
        u8 table_id;
 
1953
        u8 reserved[3];
 
1954
        struct iwl3945_rate_scaling_info table[IWL_MAX_RATES];
 
1955
} __attribute__ ((packed));
 
1956
 
 
1957
 
 
1958
/*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
 
1959
#define  LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK    (1 << 0)
 
1960
 
 
1961
/* # of EDCA prioritized tx fifos */
 
1962
#define  LINK_QUAL_AC_NUM AC_NUM
 
1963
 
 
1964
/* # entries in rate scale table to support Tx retries */
 
1965
#define  LINK_QUAL_MAX_RETRY_NUM 16
 
1966
 
 
1967
/* Tx antenna selection values */
 
1968
#define  LINK_QUAL_ANT_A_MSK (1 << 0)
 
1969
#define  LINK_QUAL_ANT_B_MSK (1 << 1)
 
1970
#define  LINK_QUAL_ANT_MSK   (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
 
1971
 
 
1972
 
 
1973
/**
 
1974
 * struct iwl_link_qual_general_params
 
1975
 *
 
1976
 * Used in REPLY_TX_LINK_QUALITY_CMD
 
1977
 */
 
1978
struct iwl_link_qual_general_params {
 
1979
        u8 flags;
 
1980
 
 
1981
        /* No entries at or above this (driver chosen) index contain MIMO */
 
1982
        u8 mimo_delimiter;
 
1983
 
 
1984
        /* Best single antenna to use for single stream (legacy, SISO). */
 
1985
        u8 single_stream_ant_msk;       /* LINK_QUAL_ANT_* */
 
1986
 
 
1987
        /* Best antennas to use for MIMO (unused for 4965, assumes both). */
 
1988
        u8 dual_stream_ant_msk;         /* LINK_QUAL_ANT_* */
 
1989
 
 
1990
        /*
 
1991
         * If driver needs to use different initial rates for different
 
1992
         * EDCA QOS access categories (as implemented by tx fifos 0-3),
 
1993
         * this table will set that up, by indicating the indexes in the
 
1994
         * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
 
1995
         * Otherwise, driver should set all entries to 0.
 
1996
         *
 
1997
         * Entry usage:
 
1998
         * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
 
1999
         * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
 
2000
         */
 
2001
        u8 start_rate_index[LINK_QUAL_AC_NUM];
 
2002
} __attribute__ ((packed));
 
2003
 
 
2004
#define LINK_QUAL_AGG_TIME_LIMIT_DEF    (4000) /* 4 milliseconds */
 
2005
#define LINK_QUAL_AGG_TIME_LIMIT_MAX    (65535)
 
2006
#define LINK_QUAL_AGG_TIME_LIMIT_MIN    (0)
 
2007
 
 
2008
#define LINK_QUAL_AGG_DISABLE_START_DEF (3)
 
2009
#define LINK_QUAL_AGG_DISABLE_START_MAX (255)
 
2010
#define LINK_QUAL_AGG_DISABLE_START_MIN (0)
 
2011
 
 
2012
#define LINK_QUAL_AGG_FRAME_LIMIT_DEF   (31)
 
2013
#define LINK_QUAL_AGG_FRAME_LIMIT_MAX   (63)
 
2014
#define LINK_QUAL_AGG_FRAME_LIMIT_MIN   (0)
 
2015
 
 
2016
/**
 
2017
 * struct iwl_link_qual_agg_params
 
2018
 *
 
2019
 * Used in REPLY_TX_LINK_QUALITY_CMD
 
2020
 */
 
2021
struct iwl_link_qual_agg_params {
 
2022
 
 
2023
        /* Maximum number of uSec in aggregation.
 
2024
         * Driver should set this to 4000 (4 milliseconds). */
 
2025
        __le16 agg_time_limit;
 
2026
 
 
2027
        /*
 
2028
         * Number of Tx retries allowed for a frame, before that frame will
 
2029
         * no longer be considered for the start of an aggregation sequence
 
2030
         * (scheduler will then try to tx it as single frame).
 
2031
         * Driver should set this to 3.
 
2032
         */
 
2033
        u8 agg_dis_start_th;
 
2034
 
 
2035
        /*
 
2036
         * Maximum number of frames in aggregation.
 
2037
         * 0 = no limit (default).  1 = no aggregation.
 
2038
         * Other values = max # frames in aggregation.
 
2039
         */
 
2040
        u8 agg_frame_cnt_limit;
 
2041
 
 
2042
        __le32 reserved;
 
2043
} __attribute__ ((packed));
 
2044
 
 
2045
/*
 
2046
 * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
 
2047
 *
 
2048
 * For 4965 only; 3945 uses REPLY_RATE_SCALE.
 
2049
 *
 
2050
 * Each station in the 4965's internal station table has its own table of 16
 
2051
 * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
 
2052
 * an ACK is not received.  This command replaces the entire table for
 
2053
 * one station.
 
2054
 *
 
2055
 * NOTE:  Station must already be in 4965's station table.  Use REPLY_ADD_STA.
 
2056
 *
 
2057
 * The rate scaling procedures described below work well.  Of course, other
 
2058
 * procedures are possible, and may work better for particular environments.
 
2059
 *
 
2060
 *
 
2061
 * FILLING THE RATE TABLE
 
2062
 *
 
2063
 * Given a particular initial rate and mode, as determined by the rate
 
2064
 * scaling algorithm described below, the Linux driver uses the following
 
2065
 * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
 
2066
 * Link Quality command:
 
2067
 *
 
2068
 *
 
2069
 * 1)  If using High-throughput (HT) (SISO or MIMO) initial rate:
 
2070
 *     a) Use this same initial rate for first 3 entries.
 
2071
 *     b) Find next lower available rate using same mode (SISO or MIMO),
 
2072
 *        use for next 3 entries.  If no lower rate available, switch to
 
2073
 *        legacy mode (no HT40 channel, no MIMO, no short guard interval).
 
2074
 *     c) If using MIMO, set command's mimo_delimiter to number of entries
 
2075
 *        using MIMO (3 or 6).
 
2076
 *     d) After trying 2 HT rates, switch to legacy mode (no HT40 channel,
 
2077
 *        no MIMO, no short guard interval), at the next lower bit rate
 
2078
 *        (e.g. if second HT bit rate was 54, try 48 legacy), and follow
 
2079
 *        legacy procedure for remaining table entries.
 
2080
 *
 
2081
 * 2)  If using legacy initial rate:
 
2082
 *     a) Use the initial rate for only one entry.
 
2083
 *     b) For each following entry, reduce the rate to next lower available
 
2084
 *        rate, until reaching the lowest available rate.
 
2085
 *     c) When reducing rate, also switch antenna selection.
 
2086
 *     d) Once lowest available rate is reached, repeat this rate until
 
2087
 *        rate table is filled (16 entries), switching antenna each entry.
 
2088
 *
 
2089
 *
 
2090
 * ACCUMULATING HISTORY
 
2091
 *
 
2092
 * The rate scaling algorithm for 4965, as implemented in Linux driver, uses
 
2093
 * two sets of frame Tx success history:  One for the current/active modulation
 
2094
 * mode, and one for a speculative/search mode that is being attempted.  If the
 
2095
 * speculative mode turns out to be more effective (i.e. actual transfer
 
2096
 * rate is better), then the driver continues to use the speculative mode
 
2097
 * as the new current active mode.
 
2098
 *
 
2099
 * Each history set contains, separately for each possible rate, data for a
 
2100
 * sliding window of the 62 most recent tx attempts at that rate.  The data
 
2101
 * includes a shifting bitmap of success(1)/failure(0), and sums of successful
 
2102
 * and attempted frames, from which the driver can additionally calculate a
 
2103
 * success ratio (success / attempted) and number of failures
 
2104
 * (attempted - success), and control the size of the window (attempted).
 
2105
 * The driver uses the bit map to remove successes from the success sum, as
 
2106
 * the oldest tx attempts fall out of the window.
 
2107
 *
 
2108
 * When the 4965 makes multiple tx attempts for a given frame, each attempt
 
2109
 * might be at a different rate, and have different modulation characteristics
 
2110
 * (e.g. antenna, fat channel, short guard interval), as set up in the rate
 
2111
 * scaling table in the Link Quality command.  The driver must determine
 
2112
 * which rate table entry was used for each tx attempt, to determine which
 
2113
 * rate-specific history to update, and record only those attempts that
 
2114
 * match the modulation characteristics of the history set.
 
2115
 *
 
2116
 * When using block-ack (aggregation), all frames are transmitted at the same
 
2117
 * rate, since there is no per-attempt acknowledgment from the destination
 
2118
 * station.  The Tx response struct iwl_tx_resp indicates the Tx rate in
 
2119
 * rate_n_flags field.  After receiving a block-ack, the driver can update
 
2120
 * history for the entire block all at once.
 
2121
 *
 
2122
 *
 
2123
 * FINDING BEST STARTING RATE:
 
2124
 *
 
2125
 * When working with a selected initial modulation mode (see below), the
 
2126
 * driver attempts to find a best initial rate.  The initial rate is the
 
2127
 * first entry in the Link Quality command's rate table.
 
2128
 *
 
2129
 * 1)  Calculate actual throughput (success ratio * expected throughput, see
 
2130
 *     table below) for current initial rate.  Do this only if enough frames
 
2131
 *     have been attempted to make the value meaningful:  at least 6 failed
 
2132
 *     tx attempts, or at least 8 successes.  If not enough, don't try rate
 
2133
 *     scaling yet.
 
2134
 *
 
2135
 * 2)  Find available rates adjacent to current initial rate.  Available means:
 
2136
 *     a)  supported by hardware &&
 
2137
 *     b)  supported by association &&
 
2138
 *     c)  within any constraints selected by user
 
2139
 *
 
2140
 * 3)  Gather measured throughputs for adjacent rates.  These might not have
 
2141
 *     enough history to calculate a throughput.  That's okay, we might try
 
2142
 *     using one of them anyway!
 
2143
 *
 
2144
 * 4)  Try decreasing rate if, for current rate:
 
2145
 *     a)  success ratio is < 15% ||
 
2146
 *     b)  lower adjacent rate has better measured throughput ||
 
2147
 *     c)  higher adjacent rate has worse throughput, and lower is unmeasured
 
2148
 *
 
2149
 *     As a sanity check, if decrease was determined above, leave rate
 
2150
 *     unchanged if:
 
2151
 *     a)  lower rate unavailable
 
2152
 *     b)  success ratio at current rate > 85% (very good)
 
2153
 *     c)  current measured throughput is better than expected throughput
 
2154
 *         of lower rate (under perfect 100% tx conditions, see table below)
 
2155
 *
 
2156
 * 5)  Try increasing rate if, for current rate:
 
2157
 *     a)  success ratio is < 15% ||
 
2158
 *     b)  both adjacent rates' throughputs are unmeasured (try it!) ||
 
2159
 *     b)  higher adjacent rate has better measured throughput ||
 
2160
 *     c)  lower adjacent rate has worse throughput, and higher is unmeasured
 
2161
 *
 
2162
 *     As a sanity check, if increase was determined above, leave rate
 
2163
 *     unchanged if:
 
2164
 *     a)  success ratio at current rate < 70%.  This is not particularly
 
2165
 *         good performance; higher rate is sure to have poorer success.
 
2166
 *
 
2167
 * 6)  Re-evaluate the rate after each tx frame.  If working with block-
 
2168
 *     acknowledge, history and statistics may be calculated for the entire
 
2169
 *     block (including prior history that fits within the history windows),
 
2170
 *     before re-evaluation.
 
2171
 *
 
2172
 * FINDING BEST STARTING MODULATION MODE:
 
2173
 *
 
2174
 * After working with a modulation mode for a "while" (and doing rate scaling),
 
2175
 * the driver searches for a new initial mode in an attempt to improve
 
2176
 * throughput.  The "while" is measured by numbers of attempted frames:
 
2177
 *
 
2178
 * For legacy mode, search for new mode after:
 
2179
 *   480 successful frames, or 160 failed frames
 
2180
 * For high-throughput modes (SISO or MIMO), search for new mode after:
 
2181
 *   4500 successful frames, or 400 failed frames
 
2182
 *
 
2183
 * Mode switch possibilities are (3 for each mode):
 
2184
 *
 
2185
 * For legacy:
 
2186
 *   Change antenna, try SISO (if HT association), try MIMO (if HT association)
 
2187
 * For SISO:
 
2188
 *   Change antenna, try MIMO, try shortened guard interval (SGI)
 
2189
 * For MIMO:
 
2190
 *   Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)
 
2191
 *
 
2192
 * When trying a new mode, use the same bit rate as the old/current mode when
 
2193
 * trying antenna switches and shortened guard interval.  When switching to
 
2194
 * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate
 
2195
 * for which the expected throughput (under perfect conditions) is about the
 
2196
 * same or slightly better than the actual measured throughput delivered by
 
2197
 * the old/current mode.
 
2198
 *
 
2199
 * Actual throughput can be estimated by multiplying the expected throughput
 
2200
 * by the success ratio (successful / attempted tx frames).  Frame size is
 
2201
 * not considered in this calculation; it assumes that frame size will average
 
2202
 * out to be fairly consistent over several samples.  The following are
 
2203
 * metric values for expected throughput assuming 100% success ratio.
 
2204
 * Only G band has support for CCK rates:
 
2205
 *
 
2206
 *           RATE:  1    2    5   11    6   9   12   18   24   36   48   54   60
 
2207
 *
 
2208
 *              G:  7   13   35   58   40  57   72   98  121  154  177  186  186
 
2209
 *              A:  0    0    0    0   40  57   72   98  121  154  177  186  186
 
2210
 *     SISO 20MHz:  0    0    0    0   42  42   76  102  124  159  183  193  202
 
2211
 * SGI SISO 20MHz:  0    0    0    0   46  46   82  110  132  168  192  202  211
 
2212
 *     MIMO 20MHz:  0    0    0    0   74  74  123  155  179  214  236  244  251
 
2213
 * SGI MIMO 20MHz:  0    0    0    0   81  81  131  164  188  222  243  251  257
 
2214
 *     SISO 40MHz:  0    0    0    0   77  77  127  160  184  220  242  250  257
 
2215
 * SGI SISO 40MHz:  0    0    0    0   83  83  135  169  193  229  250  257  264
 
2216
 *     MIMO 40MHz:  0    0    0    0  123 123  182  214  235  264  279  285  289
 
2217
 * SGI MIMO 40MHz:  0    0    0    0  131 131  191  222  242  270  284  289  293
 
2218
 *
 
2219
 * After the new mode has been tried for a short while (minimum of 6 failed
 
2220
 * frames or 8 successful frames), compare success ratio and actual throughput
 
2221
 * estimate of the new mode with the old.  If either is better with the new
 
2222
 * mode, continue to use the new mode.
 
2223
 *
 
2224
 * Continue comparing modes until all 3 possibilities have been tried.
 
2225
 * If moving from legacy to HT, try all 3 possibilities from the new HT
 
2226
 * mode.  After trying all 3, a best mode is found.  Continue to use this mode
 
2227
 * for the longer "while" described above (e.g. 480 successful frames for
 
2228
 * legacy), and then repeat the search process.
 
2229
 *
 
2230
 */
 
2231
struct iwl_link_quality_cmd {
 
2232
 
 
2233
        /* Index of destination/recipient station in uCode's station table */
 
2234
        u8 sta_id;
 
2235
        u8 reserved1;
 
2236
        __le16 control;         /* not used */
 
2237
        struct iwl_link_qual_general_params general_params;
 
2238
        struct iwl_link_qual_agg_params agg_params;
 
2239
 
 
2240
        /*
 
2241
         * Rate info; when using rate-scaling, Tx command's initial_rate_index
 
2242
         * specifies 1st Tx rate attempted, via index into this table.
 
2243
         * 4965 works its way through table when retrying Tx.
 
2244
         */
 
2245
        struct {
 
2246
                __le32 rate_n_flags;    /* RATE_MCS_*, IWL_RATE_* */
 
2247
        } rs_table[LINK_QUAL_MAX_RETRY_NUM];
 
2248
        __le32 reserved2;
 
2249
} __attribute__ ((packed));
 
2250
 
 
2251
#define BT_COEX_DISABLE (0x0)
 
2252
#define BT_COEX_MODE_2W (0x1)
 
2253
#define BT_COEX_MODE_3W (0x2)
 
2254
#define BT_COEX_MODE_4W (0x3)
 
2255
 
 
2256
#define BT_LEAD_TIME_MIN (0x0)
 
2257
#define BT_LEAD_TIME_DEF (0x1E)
 
2258
#define BT_LEAD_TIME_MAX (0xFF)
 
2259
 
 
2260
#define BT_MAX_KILL_MIN (0x1)
 
2261
#define BT_MAX_KILL_DEF (0x5)
 
2262
#define BT_MAX_KILL_MAX (0xFF)
 
2263
 
 
2264
/*
 
2265
 * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
 
2266
 *
 
2267
 * 3945 and 4965 support hardware handshake with Bluetooth device on
 
2268
 * same platform.  Bluetooth device alerts wireless device when it will Tx;
 
2269
 * wireless device can delay or kill its own Tx to accommodate.
 
2270
 */
 
2271
struct iwl_bt_cmd {
 
2272
        u8 flags;
 
2273
        u8 lead_time;
 
2274
        u8 max_kill;
 
2275
        u8 reserved;
 
2276
        __le32 kill_ack_mask;
 
2277
        __le32 kill_cts_mask;
 
2278
} __attribute__ ((packed));
 
2279
 
 
2280
/******************************************************************************
 
2281
 * (6)
 
2282
 * Spectrum Management (802.11h) Commands, Responses, Notifications:
 
2283
 *
 
2284
 *****************************************************************************/
 
2285
 
 
2286
/*
 
2287
 * Spectrum Management
 
2288
 */
 
2289
#define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK         | \
 
2290
                                 RXON_FILTER_CTL2HOST_MSK        | \
 
2291
                                 RXON_FILTER_ACCEPT_GRP_MSK      | \
 
2292
                                 RXON_FILTER_DIS_DECRYPT_MSK     | \
 
2293
                                 RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
 
2294
                                 RXON_FILTER_ASSOC_MSK           | \
 
2295
                                 RXON_FILTER_BCON_AWARE_MSK)
 
2296
 
 
2297
struct iwl_measure_channel {
 
2298
        __le32 duration;        /* measurement duration in extended beacon
 
2299
                                 * format */
 
2300
        u8 channel;             /* channel to measure */
 
2301
        u8 type;                /* see enum iwl_measure_type */
 
2302
        __le16 reserved;
 
2303
} __attribute__ ((packed));
 
2304
 
 
2305
/*
 
2306
 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
 
2307
 */
 
2308
struct iwl_spectrum_cmd {
 
2309
        __le16 len;             /* number of bytes starting from token */
 
2310
        u8 token;               /* token id */
 
2311
        u8 id;                  /* measurement id -- 0 or 1 */
 
2312
        u8 origin;              /* 0 = TGh, 1 = other, 2 = TGk */
 
2313
        u8 periodic;            /* 1 = periodic */
 
2314
        __le16 path_loss_timeout;
 
2315
        __le32 start_time;      /* start time in extended beacon format */
 
2316
        __le32 reserved2;
 
2317
        __le32 flags;           /* rxon flags */
 
2318
        __le32 filter_flags;    /* rxon filter flags */
 
2319
        __le16 channel_count;   /* minimum 1, maximum 10 */
 
2320
        __le16 reserved3;
 
2321
        struct iwl_measure_channel channels[10];
 
2322
} __attribute__ ((packed));
 
2323
 
 
2324
/*
 
2325
 * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
 
2326
 */
 
2327
struct iwl_spectrum_resp {
 
2328
        u8 token;
 
2329
        u8 id;                  /* id of the prior command replaced, or 0xff */
 
2330
        __le16 status;          /* 0 - command will be handled
 
2331
                                 * 1 - cannot handle (conflicts with another
 
2332
                                 *     measurement) */
 
2333
} __attribute__ ((packed));
 
2334
 
 
2335
enum iwl_measurement_state {
 
2336
        IWL_MEASUREMENT_START = 0,
 
2337
        IWL_MEASUREMENT_STOP = 1,
 
2338
};
 
2339
 
 
2340
enum iwl_measurement_status {
 
2341
        IWL_MEASUREMENT_OK = 0,
 
2342
        IWL_MEASUREMENT_CONCURRENT = 1,
 
2343
        IWL_MEASUREMENT_CSA_CONFLICT = 2,
 
2344
        IWL_MEASUREMENT_TGH_CONFLICT = 3,
 
2345
        /* 4-5 reserved */
 
2346
        IWL_MEASUREMENT_STOPPED = 6,
 
2347
        IWL_MEASUREMENT_TIMEOUT = 7,
 
2348
        IWL_MEASUREMENT_PERIODIC_FAILED = 8,
 
2349
};
 
2350
 
 
2351
#define NUM_ELEMENTS_IN_HISTOGRAM 8
 
2352
 
 
2353
struct iwl_measurement_histogram {
 
2354
        __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
 
2355
        __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM];  /* in 1usec counts */
 
2356
} __attribute__ ((packed));
 
2357
 
 
2358
/* clear channel availability counters */
 
2359
struct iwl_measurement_cca_counters {
 
2360
        __le32 ofdm;
 
2361
        __le32 cck;
 
2362
} __attribute__ ((packed));
 
2363
 
 
2364
enum iwl_measure_type {
 
2365
        IWL_MEASURE_BASIC = (1 << 0),
 
2366
        IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
 
2367
        IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
 
2368
        IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
 
2369
        IWL_MEASURE_FRAME = (1 << 4),
 
2370
        /* bits 5:6 are reserved */
 
2371
        IWL_MEASURE_IDLE = (1 << 7),
 
2372
};
 
2373
 
 
2374
/*
 
2375
 * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
 
2376
 */
 
2377
struct iwl_spectrum_notification {
 
2378
        u8 id;                  /* measurement id -- 0 or 1 */
 
2379
        u8 token;
 
2380
        u8 channel_index;       /* index in measurement channel list */
 
2381
        u8 state;               /* 0 - start, 1 - stop */
 
2382
        __le32 start_time;      /* lower 32-bits of TSF */
 
2383
        u8 band;                /* 0 - 5.2GHz, 1 - 2.4GHz */
 
2384
        u8 channel;
 
2385
        u8 type;                /* see enum iwl_measurement_type */
 
2386
        u8 reserved1;
 
2387
        /* NOTE:  cca_ofdm, cca_cck, basic_type, and histogram are only only
 
2388
         * valid if applicable for measurement type requested. */
 
2389
        __le32 cca_ofdm;        /* cca fraction time in 40Mhz clock periods */
 
2390
        __le32 cca_cck;         /* cca fraction time in 44Mhz clock periods */
 
2391
        __le32 cca_time;        /* channel load time in usecs */
 
2392
        u8 basic_type;          /* 0 - bss, 1 - ofdm preamble, 2 -
 
2393
                                 * unidentified */
 
2394
        u8 reserved2[3];
 
2395
        struct iwl_measurement_histogram histogram;
 
2396
        __le32 stop_time;       /* lower 32-bits of TSF */
 
2397
        __le32 status;          /* see iwl_measurement_status */
 
2398
} __attribute__ ((packed));
 
2399
 
 
2400
/******************************************************************************
 
2401
 * (7)
 
2402
 * Power Management Commands, Responses, Notifications:
 
2403
 *
 
2404
 *****************************************************************************/
 
2405
 
 
2406
/**
 
2407
 * struct iwl_powertable_cmd - Power Table Command
 
2408
 * @flags: See below:
 
2409
 *
 
2410
 * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
 
2411
 *
 
2412
 * PM allow:
 
2413
 *   bit 0 - '0' Driver not allow power management
 
2414
 *           '1' Driver allow PM (use rest of parameters)
 
2415
 *
 
2416
 * uCode send sleep notifications:
 
2417
 *   bit 1 - '0' Don't send sleep notification
 
2418
 *           '1' send sleep notification (SEND_PM_NOTIFICATION)
 
2419
 *
 
2420
 * Sleep over DTIM
 
2421
 *   bit 2 - '0' PM have to walk up every DTIM
 
2422
 *           '1' PM could sleep over DTIM till listen Interval.
 
2423
 *
 
2424
 * PCI power managed
 
2425
 *   bit 3 - '0' (PCI_CFG_LINK_CTRL & 0x1)
 
2426
 *           '1' !(PCI_CFG_LINK_CTRL & 0x1)
 
2427
 *
 
2428
 * Fast PD
 
2429
 *   bit 4 - '1' Put radio to sleep when receiving frame for others
 
2430
 *
 
2431
 * Force sleep Modes
 
2432
 *   bit 31/30- '00' use both mac/xtal sleeps
 
2433
 *              '01' force Mac sleep
 
2434
 *              '10' force xtal sleep
 
2435
 *              '11' Illegal set
 
2436
 *
 
2437
 * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
 
2438
 * ucode assume sleep over DTIM is allowed and we don't need to wake up
 
2439
 * for every DTIM.
 
2440
 */
 
2441
#define IWL_POWER_VEC_SIZE 5
 
2442
 
 
2443
#define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK        cpu_to_le16(BIT(0))
 
2444
#define IWL_POWER_SLEEP_OVER_DTIM_MSK           cpu_to_le16(BIT(2))
 
2445
#define IWL_POWER_PCI_PM_MSK                    cpu_to_le16(BIT(3))
 
2446
#define IWL_POWER_FAST_PD                       cpu_to_le16(BIT(4))
 
2447
 
 
2448
struct iwl3945_powertable_cmd {
 
2449
        __le16 flags;
 
2450
        u8 reserved[2];
 
2451
        __le32 rx_data_timeout;
 
2452
        __le32 tx_data_timeout;
 
2453
        __le32 sleep_interval[IWL_POWER_VEC_SIZE];
 
2454
} __attribute__ ((packed));
 
2455
 
 
2456
struct iwl_powertable_cmd {
 
2457
        __le16 flags;
 
2458
        u8 keep_alive_seconds;          /* 3945 reserved */
 
2459
        u8 debug_flags;                 /* 3945 reserved */
 
2460
        __le32 rx_data_timeout;
 
2461
        __le32 tx_data_timeout;
 
2462
        __le32 sleep_interval[IWL_POWER_VEC_SIZE];
 
2463
        __le32 keep_alive_beacons;
 
2464
} __attribute__ ((packed));
 
2465
 
 
2466
/*
 
2467
 * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
 
2468
 * 3945 and 4965 identical.
 
2469
 */
 
2470
struct iwl_sleep_notification {
 
2471
        u8 pm_sleep_mode;
 
2472
        u8 pm_wakeup_src;
 
2473
        __le16 reserved;
 
2474
        __le32 sleep_time;
 
2475
        __le32 tsf_low;
 
2476
        __le32 bcon_timer;
 
2477
} __attribute__ ((packed));
 
2478
 
 
2479
/* Sleep states.  3945 and 4965 identical. */
 
2480
enum {
 
2481
        IWL_PM_NO_SLEEP = 0,
 
2482
        IWL_PM_SLP_MAC = 1,
 
2483
        IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
 
2484
        IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
 
2485
        IWL_PM_SLP_PHY = 4,
 
2486
        IWL_PM_SLP_REPENT = 5,
 
2487
        IWL_PM_WAKEUP_BY_TIMER = 6,
 
2488
        IWL_PM_WAKEUP_BY_DRIVER = 7,
 
2489
        IWL_PM_WAKEUP_BY_RFKILL = 8,
 
2490
        /* 3 reserved */
 
2491
        IWL_PM_NUM_OF_MODES = 12,
 
2492
};
 
2493
 
 
2494
/*
 
2495
 * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
 
2496
 */
 
2497
#define CARD_STATE_CMD_DISABLE 0x00     /* Put card to sleep */
 
2498
#define CARD_STATE_CMD_ENABLE  0x01     /* Wake up card */
 
2499
#define CARD_STATE_CMD_HALT    0x02     /* Power down permanently */
 
2500
struct iwl_card_state_cmd {
 
2501
        __le32 status;          /* CARD_STATE_CMD_* request new power state */
 
2502
} __attribute__ ((packed));
 
2503
 
 
2504
/*
 
2505
 * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
 
2506
 */
 
2507
struct iwl_card_state_notif {
 
2508
        __le32 flags;
 
2509
} __attribute__ ((packed));
 
2510
 
 
2511
#define HW_CARD_DISABLED   0x01
 
2512
#define SW_CARD_DISABLED   0x02
 
2513
#define RF_CARD_DISABLED   0x04
 
2514
#define RXON_CARD_DISABLED 0x10
 
2515
 
 
2516
struct iwl_ct_kill_config {
 
2517
        __le32   reserved;
 
2518
        __le32   critical_temperature_M;
 
2519
        __le32   critical_temperature_R;
 
2520
}  __attribute__ ((packed));
 
2521
 
 
2522
/* 1000, and 6x00 */
 
2523
struct iwl_ct_kill_throttling_config {
 
2524
        __le32   critical_temperature_exit;
 
2525
        __le32   reserved;
 
2526
        __le32   critical_temperature_enter;
 
2527
}  __attribute__ ((packed));
 
2528
 
 
2529
/******************************************************************************
 
2530
 * (8)
 
2531
 * Scan Commands, Responses, Notifications:
 
2532
 *
 
2533
 *****************************************************************************/
 
2534
 
 
2535
#define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0)
 
2536
#define SCAN_CHANNEL_TYPE_ACTIVE  cpu_to_le32(1)
 
2537
 
 
2538
/**
 
2539
 * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table
 
2540
 *
 
2541
 * One for each channel in the scan list.
 
2542
 * Each channel can independently select:
 
2543
 * 1)  SSID for directed active scans
 
2544
 * 2)  Txpower setting (for rate specified within Tx command)
 
2545
 * 3)  How long to stay on-channel (behavior may be modified by quiet_time,
 
2546
 *     quiet_plcp_th, good_CRC_th)
 
2547
 *
 
2548
 * To avoid uCode errors, make sure the following are true (see comments
 
2549
 * under struct iwl_scan_cmd about max_out_time and quiet_time):
 
2550
 * 1)  If using passive_dwell (i.e. passive_dwell != 0):
 
2551
 *     active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
 
2552
 * 2)  quiet_time <= active_dwell
 
2553
 * 3)  If restricting off-channel time (i.e. max_out_time !=0):
 
2554
 *     passive_dwell < max_out_time
 
2555
 *     active_dwell < max_out_time
 
2556
 */
 
2557
 
 
2558
/* FIXME: rename to AP1, remove tpc */
 
2559
struct iwl3945_scan_channel {
 
2560
        /*
 
2561
         * type is defined as:
 
2562
         * 0:0 1 = active, 0 = passive
 
2563
         * 1:4 SSID direct bit map; if a bit is set, then corresponding
 
2564
         *     SSID IE is transmitted in probe request.
 
2565
         * 5:7 reserved
 
2566
         */
 
2567
        u8 type;
 
2568
        u8 channel;     /* band is selected by iwl3945_scan_cmd "flags" field */
 
2569
        struct iwl3945_tx_power tpc;
 
2570
        __le16 active_dwell;    /* in 1024-uSec TU (time units), typ 5-50 */
 
2571
        __le16 passive_dwell;   /* in 1024-uSec TU (time units), typ 20-500 */
 
2572
} __attribute__ ((packed));
 
2573
 
 
2574
/* set number of direct probes u8 type */
 
2575
#define IWL39_SCAN_PROBE_MASK(n) ((BIT(n) | (BIT(n) - BIT(1))))
 
2576
 
 
2577
struct iwl_scan_channel {
 
2578
        /*
 
2579
         * type is defined as:
 
2580
         * 0:0 1 = active, 0 = passive
 
2581
         * 1:20 SSID direct bit map; if a bit is set, then corresponding
 
2582
         *     SSID IE is transmitted in probe request.
 
2583
         * 21:31 reserved
 
2584
         */
 
2585
        __le32 type;
 
2586
        __le16 channel; /* band is selected by iwl_scan_cmd "flags" field */
 
2587
        u8 tx_gain;             /* gain for analog radio */
 
2588
        u8 dsp_atten;           /* gain for DSP */
 
2589
        __le16 active_dwell;    /* in 1024-uSec TU (time units), typ 5-50 */
 
2590
        __le16 passive_dwell;   /* in 1024-uSec TU (time units), typ 20-500 */
 
2591
} __attribute__ ((packed));
 
2592
 
 
2593
/* set number of direct probes __le32 type */
 
2594
#define IWL_SCAN_PROBE_MASK(n)  cpu_to_le32((BIT(n) | (BIT(n) - BIT(1))))
 
2595
 
 
2596
/**
 
2597
 * struct iwl_ssid_ie - directed scan network information element
 
2598
 *
 
2599
 * Up to 20 of these may appear in REPLY_SCAN_CMD (Note: Only 4 are in
 
2600
 * 3945 SCAN api), selected by "type" bit field in struct iwl_scan_channel;
 
2601
 * each channel may select different ssids from among the 20 (4) entries.
 
2602
 * SSID IEs get transmitted in reverse order of entry.
 
2603
 */
 
2604
struct iwl_ssid_ie {
 
2605
        u8 id;
 
2606
        u8 len;
 
2607
        u8 ssid[32];
 
2608
} __attribute__ ((packed));
 
2609
 
 
2610
#define PROBE_OPTION_MAX_3945           4
 
2611
#define PROBE_OPTION_MAX                20
 
2612
#define TX_CMD_LIFE_TIME_INFINITE       cpu_to_le32(0xFFFFFFFF)
 
2613
#define IWL_GOOD_CRC_TH                 cpu_to_le16(1)
 
2614
#define IWL_MAX_SCAN_SIZE 1024
 
2615
#define IWL_MAX_PROBE_REQUEST           200
 
2616
 
 
2617
/*
 
2618
 * REPLY_SCAN_CMD = 0x80 (command)
 
2619
 *
 
2620
 * The hardware scan command is very powerful; the driver can set it up to
 
2621
 * maintain (relatively) normal network traffic while doing a scan in the
 
2622
 * background.  The max_out_time and suspend_time control the ratio of how
 
2623
 * long the device stays on an associated network channel ("service channel")
 
2624
 * vs. how long it's away from the service channel, i.e. tuned to other channels
 
2625
 * for scanning.
 
2626
 *
 
2627
 * max_out_time is the max time off-channel (in usec), and suspend_time
 
2628
 * is how long (in "extended beacon" format) that the scan is "suspended"
 
2629
 * after returning to the service channel.  That is, suspend_time is the
 
2630
 * time that we stay on the service channel, doing normal work, between
 
2631
 * scan segments.  The driver may set these parameters differently to support
 
2632
 * scanning when associated vs. not associated, and light vs. heavy traffic
 
2633
 * loads when associated.
 
2634
 *
 
2635
 * After receiving this command, the device's scan engine does the following;
 
2636
 *
 
2637
 * 1)  Sends SCAN_START notification to driver
 
2638
 * 2)  Checks to see if it has time to do scan for one channel
 
2639
 * 3)  Sends NULL packet, with power-save (PS) bit set to 1,
 
2640
 *     to tell AP that we're going off-channel
 
2641
 * 4)  Tunes to first channel in scan list, does active or passive scan
 
2642
 * 5)  Sends SCAN_RESULT notification to driver
 
2643
 * 6)  Checks to see if it has time to do scan on *next* channel in list
 
2644
 * 7)  Repeats 4-6 until it no longer has time to scan the next channel
 
2645
 *     before max_out_time expires
 
2646
 * 8)  Returns to service channel
 
2647
 * 9)  Sends NULL packet with PS=0 to tell AP that we're back
 
2648
 * 10) Stays on service channel until suspend_time expires
 
2649
 * 11) Repeats entire process 2-10 until list is complete
 
2650
 * 12) Sends SCAN_COMPLETE notification
 
2651
 *
 
2652
 * For fast, efficient scans, the scan command also has support for staying on
 
2653
 * a channel for just a short time, if doing active scanning and getting no
 
2654
 * responses to the transmitted probe request.  This time is controlled by
 
2655
 * quiet_time, and the number of received packets below which a channel is
 
2656
 * considered "quiet" is controlled by quiet_plcp_threshold.
 
2657
 *
 
2658
 * For active scanning on channels that have regulatory restrictions against
 
2659
 * blindly transmitting, the scan can listen before transmitting, to make sure
 
2660
 * that there is already legitimate activity on the channel.  If enough
 
2661
 * packets are cleanly received on the channel (controlled by good_CRC_th,
 
2662
 * typical value 1), the scan engine starts transmitting probe requests.
 
2663
 *
 
2664
 * Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
 
2665
 *
 
2666
 * To avoid uCode errors, see timing restrictions described under
 
2667
 * struct iwl_scan_channel.
 
2668
 */
 
2669
 
 
2670
struct iwl3945_scan_cmd {
 
2671
        __le16 len;
 
2672
        u8 reserved0;
 
2673
        u8 channel_count;       /* # channels in channel list */
 
2674
        __le16 quiet_time;      /* dwell only this # millisecs on quiet channel
 
2675
                                 * (only for active scan) */
 
2676
        __le16 quiet_plcp_th;   /* quiet chnl is < this # pkts (typ. 1) */
 
2677
        __le16 good_CRC_th;     /* passive -> active promotion threshold */
 
2678
        __le16 reserved1;
 
2679
        __le32 max_out_time;    /* max usec to be away from associated (service)
 
2680
                                 * channel */
 
2681
        __le32 suspend_time;    /* pause scan this long (in "extended beacon
 
2682
                                 * format") when returning to service channel:
 
2683
                                 * 3945; 31:24 # beacons, 19:0 additional usec,
 
2684
                                 * 4965; 31:22 # beacons, 21:0 additional usec.
 
2685
                                 */
 
2686
        __le32 flags;           /* RXON_FLG_* */
 
2687
        __le32 filter_flags;    /* RXON_FILTER_* */
 
2688
 
 
2689
        /* For active scans (set to all-0s for passive scans).
 
2690
         * Does not include payload.  Must specify Tx rate; no rate scaling. */
 
2691
        struct iwl3945_tx_cmd tx_cmd;
 
2692
 
 
2693
        /* For directed active scans (set to all-0s otherwise) */
 
2694
        struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX_3945];
 
2695
 
 
2696
        /*
 
2697
         * Probe request frame, followed by channel list.
 
2698
         *
 
2699
         * Size of probe request frame is specified by byte count in tx_cmd.
 
2700
         * Channel list follows immediately after probe request frame.
 
2701
         * Number of channels in list is specified by channel_count.
 
2702
         * Each channel in list is of type:
 
2703
         *
 
2704
         * struct iwl3945_scan_channel channels[0];
 
2705
         *
 
2706
         * NOTE:  Only one band of channels can be scanned per pass.  You
 
2707
         * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
 
2708
         * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
 
2709
         * before requesting another scan.
 
2710
         */
 
2711
        u8 data[0];
 
2712
} __attribute__ ((packed));
 
2713
 
 
2714
struct iwl_scan_cmd {
 
2715
        __le16 len;
 
2716
        u8 reserved0;
 
2717
        u8 channel_count;       /* # channels in channel list */
 
2718
        __le16 quiet_time;      /* dwell only this # millisecs on quiet channel
 
2719
                                 * (only for active scan) */
 
2720
        __le16 quiet_plcp_th;   /* quiet chnl is < this # pkts (typ. 1) */
 
2721
        __le16 good_CRC_th;     /* passive -> active promotion threshold */
 
2722
        __le16 rx_chain;        /* RXON_RX_CHAIN_* */
 
2723
        __le32 max_out_time;    /* max usec to be away from associated (service)
 
2724
                                 * channel */
 
2725
        __le32 suspend_time;    /* pause scan this long (in "extended beacon
 
2726
                                 * format") when returning to service chnl:
 
2727
                                 * 3945; 31:24 # beacons, 19:0 additional usec,
 
2728
                                 * 4965; 31:22 # beacons, 21:0 additional usec.
 
2729
                                 */
 
2730
        __le32 flags;           /* RXON_FLG_* */
 
2731
        __le32 filter_flags;    /* RXON_FILTER_* */
 
2732
 
 
2733
        /* For active scans (set to all-0s for passive scans).
 
2734
         * Does not include payload.  Must specify Tx rate; no rate scaling. */
 
2735
        struct iwl_tx_cmd tx_cmd;
 
2736
 
 
2737
        /* For directed active scans (set to all-0s otherwise) */
 
2738
        struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
 
2739
 
 
2740
        /*
 
2741
         * Probe request frame, followed by channel list.
 
2742
         *
 
2743
         * Size of probe request frame is specified by byte count in tx_cmd.
 
2744
         * Channel list follows immediately after probe request frame.
 
2745
         * Number of channels in list is specified by channel_count.
 
2746
         * Each channel in list is of type:
 
2747
         *
 
2748
         * struct iwl_scan_channel channels[0];
 
2749
         *
 
2750
         * NOTE:  Only one band of channels can be scanned per pass.  You
 
2751
         * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
 
2752
         * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
 
2753
         * before requesting another scan.
 
2754
         */
 
2755
        u8 data[0];
 
2756
} __attribute__ ((packed));
 
2757
 
 
2758
/* Can abort will notify by complete notification with abort status. */
 
2759
#define CAN_ABORT_STATUS        cpu_to_le32(0x1)
 
2760
/* complete notification statuses */
 
2761
#define ABORT_STATUS            0x2
 
2762
 
 
2763
/*
 
2764
 * REPLY_SCAN_CMD = 0x80 (response)
 
2765
 */
 
2766
struct iwl_scanreq_notification {
 
2767
        __le32 status;          /* 1: okay, 2: cannot fulfill request */
 
2768
} __attribute__ ((packed));
 
2769
 
 
2770
/*
 
2771
 * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
 
2772
 */
 
2773
struct iwl_scanstart_notification {
 
2774
        __le32 tsf_low;
 
2775
        __le32 tsf_high;
 
2776
        __le32 beacon_timer;
 
2777
        u8 channel;
 
2778
        u8 band;
 
2779
        u8 reserved[2];
 
2780
        __le32 status;
 
2781
} __attribute__ ((packed));
 
2782
 
 
2783
#define  SCAN_OWNER_STATUS 0x1;
 
2784
#define  MEASURE_OWNER_STATUS 0x2;
 
2785
 
 
2786
#define NUMBER_OF_STATISTICS 1  /* first __le32 is good CRC */
 
2787
/*
 
2788
 * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
 
2789
 */
 
2790
struct iwl_scanresults_notification {
 
2791
        u8 channel;
 
2792
        u8 band;
 
2793
        u8 reserved[2];
 
2794
        __le32 tsf_low;
 
2795
        __le32 tsf_high;
 
2796
        __le32 statistics[NUMBER_OF_STATISTICS];
 
2797
} __attribute__ ((packed));
 
2798
 
 
2799
/*
 
2800
 * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
 
2801
 */
 
2802
struct iwl_scancomplete_notification {
 
2803
        u8 scanned_channels;
 
2804
        u8 status;
 
2805
        u8 reserved;
 
2806
        u8 last_channel;
 
2807
        __le32 tsf_low;
 
2808
        __le32 tsf_high;
 
2809
} __attribute__ ((packed));
 
2810
 
 
2811
 
 
2812
/******************************************************************************
 
2813
 * (9)
 
2814
 * IBSS/AP Commands and Notifications:
 
2815
 *
 
2816
 *****************************************************************************/
 
2817
 
 
2818
/*
 
2819
 * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
 
2820
 */
 
2821
 
 
2822
struct iwl3945_beacon_notif {
 
2823
        struct iwl3945_tx_resp beacon_notify_hdr;
 
2824
        __le32 low_tsf;
 
2825
        __le32 high_tsf;
 
2826
        __le32 ibss_mgr_status;
 
2827
} __attribute__ ((packed));
 
2828
 
 
2829
struct iwl4965_beacon_notif {
 
2830
        struct iwl4965_tx_resp beacon_notify_hdr;
 
2831
        __le32 low_tsf;
 
2832
        __le32 high_tsf;
 
2833
        __le32 ibss_mgr_status;
 
2834
} __attribute__ ((packed));
 
2835
 
 
2836
/*
 
2837
 * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
 
2838
 */
 
2839
 
 
2840
struct iwl3945_tx_beacon_cmd {
 
2841
        struct iwl3945_tx_cmd tx;
 
2842
        __le16 tim_idx;
 
2843
        u8 tim_size;
 
2844
        u8 reserved1;
 
2845
        struct ieee80211_hdr frame[0];  /* beacon frame */
 
2846
} __attribute__ ((packed));
 
2847
 
 
2848
struct iwl_tx_beacon_cmd {
 
2849
        struct iwl_tx_cmd tx;
 
2850
        __le16 tim_idx;
 
2851
        u8 tim_size;
 
2852
        u8 reserved1;
 
2853
        struct ieee80211_hdr frame[0];  /* beacon frame */
 
2854
} __attribute__ ((packed));
 
2855
 
 
2856
/******************************************************************************
 
2857
 * (10)
 
2858
 * Statistics Commands and Notifications:
 
2859
 *
 
2860
 *****************************************************************************/
 
2861
 
 
2862
#define IWL_TEMP_CONVERT 260
 
2863
 
 
2864
#define SUP_RATE_11A_MAX_NUM_CHANNELS  8
 
2865
#define SUP_RATE_11B_MAX_NUM_CHANNELS  4
 
2866
#define SUP_RATE_11G_MAX_NUM_CHANNELS  12
 
2867
 
 
2868
/* Used for passing to driver number of successes and failures per rate */
 
2869
struct rate_histogram {
 
2870
        union {
 
2871
                __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
 
2872
                __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
 
2873
                __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
 
2874
        } success;
 
2875
        union {
 
2876
                __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
 
2877
                __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
 
2878
                __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
 
2879
        } failed;
 
2880
} __attribute__ ((packed));
 
2881
 
 
2882
/* statistics command response */
 
2883
 
 
2884
struct iwl39_statistics_rx_phy {
 
2885
        __le32 ina_cnt;
 
2886
        __le32 fina_cnt;
 
2887
        __le32 plcp_err;
 
2888
        __le32 crc32_err;
 
2889
        __le32 overrun_err;
 
2890
        __le32 early_overrun_err;
 
2891
        __le32 crc32_good;
 
2892
        __le32 false_alarm_cnt;
 
2893
        __le32 fina_sync_err_cnt;
 
2894
        __le32 sfd_timeout;
 
2895
        __le32 fina_timeout;
 
2896
        __le32 unresponded_rts;
 
2897
        __le32 rxe_frame_limit_overrun;
 
2898
        __le32 sent_ack_cnt;
 
2899
        __le32 sent_cts_cnt;
 
2900
} __attribute__ ((packed));
 
2901
 
 
2902
struct iwl39_statistics_rx_non_phy {
 
2903
        __le32 bogus_cts;       /* CTS received when not expecting CTS */
 
2904
        __le32 bogus_ack;       /* ACK received when not expecting ACK */
 
2905
        __le32 non_bssid_frames;        /* number of frames with BSSID that
 
2906
                                         * doesn't belong to the STA BSSID */
 
2907
        __le32 filtered_frames; /* count frames that were dumped in the
 
2908
                                 * filtering process */
 
2909
        __le32 non_channel_beacons;     /* beacons with our bss id but not on
 
2910
                                         * our serving channel */
 
2911
} __attribute__ ((packed));
 
2912
 
 
2913
struct iwl39_statistics_rx {
 
2914
        struct iwl39_statistics_rx_phy ofdm;
 
2915
        struct iwl39_statistics_rx_phy cck;
 
2916
        struct iwl39_statistics_rx_non_phy general;
 
2917
} __attribute__ ((packed));
 
2918
 
 
2919
struct iwl39_statistics_tx {
 
2920
        __le32 preamble_cnt;
 
2921
        __le32 rx_detected_cnt;
 
2922
        __le32 bt_prio_defer_cnt;
 
2923
        __le32 bt_prio_kill_cnt;
 
2924
        __le32 few_bytes_cnt;
 
2925
        __le32 cts_timeout;
 
2926
        __le32 ack_timeout;
 
2927
        __le32 expected_ack_cnt;
 
2928
        __le32 actual_ack_cnt;
 
2929
} __attribute__ ((packed));
 
2930
 
 
2931
struct statistics_dbg {
 
2932
        __le32 burst_check;
 
2933
        __le32 burst_count;
 
2934
        __le32 reserved[4];
 
2935
} __attribute__ ((packed));
 
2936
 
 
2937
struct iwl39_statistics_div {
 
2938
        __le32 tx_on_a;
 
2939
        __le32 tx_on_b;
 
2940
        __le32 exec_time;
 
2941
        __le32 probe_time;
 
2942
} __attribute__ ((packed));
 
2943
 
 
2944
struct iwl39_statistics_general {
 
2945
        __le32 temperature;
 
2946
        struct statistics_dbg dbg;
 
2947
        __le32 sleep_time;
 
2948
        __le32 slots_out;
 
2949
        __le32 slots_idle;
 
2950
        __le32 ttl_timestamp;
 
2951
        struct iwl39_statistics_div div;
 
2952
} __attribute__ ((packed));
 
2953
 
 
2954
struct statistics_rx_phy {
 
2955
        __le32 ina_cnt;
 
2956
        __le32 fina_cnt;
 
2957
        __le32 plcp_err;
 
2958
        __le32 crc32_err;
 
2959
        __le32 overrun_err;
 
2960
        __le32 early_overrun_err;
 
2961
        __le32 crc32_good;
 
2962
        __le32 false_alarm_cnt;
 
2963
        __le32 fina_sync_err_cnt;
 
2964
        __le32 sfd_timeout;
 
2965
        __le32 fina_timeout;
 
2966
        __le32 unresponded_rts;
 
2967
        __le32 rxe_frame_limit_overrun;
 
2968
        __le32 sent_ack_cnt;
 
2969
        __le32 sent_cts_cnt;
 
2970
        __le32 sent_ba_rsp_cnt;
 
2971
        __le32 dsp_self_kill;
 
2972
        __le32 mh_format_err;
 
2973
        __le32 re_acq_main_rssi_sum;
 
2974
        __le32 reserved3;
 
2975
} __attribute__ ((packed));
 
2976
 
 
2977
struct statistics_rx_ht_phy {
 
2978
        __le32 plcp_err;
 
2979
        __le32 overrun_err;
 
2980
        __le32 early_overrun_err;
 
2981
        __le32 crc32_good;
 
2982
        __le32 crc32_err;
 
2983
        __le32 mh_format_err;
 
2984
        __le32 agg_crc32_good;
 
2985
        __le32 agg_mpdu_cnt;
 
2986
        __le32 agg_cnt;
 
2987
        __le32 reserved2;
 
2988
} __attribute__ ((packed));
 
2989
 
 
2990
#define INTERFERENCE_DATA_AVAILABLE      cpu_to_le32(1)
 
2991
 
 
2992
struct statistics_rx_non_phy {
 
2993
        __le32 bogus_cts;       /* CTS received when not expecting CTS */
 
2994
        __le32 bogus_ack;       /* ACK received when not expecting ACK */
 
2995
        __le32 non_bssid_frames;        /* number of frames with BSSID that
 
2996
                                         * doesn't belong to the STA BSSID */
 
2997
        __le32 filtered_frames; /* count frames that were dumped in the
 
2998
                                 * filtering process */
 
2999
        __le32 non_channel_beacons;     /* beacons with our bss id but not on
 
3000
                                         * our serving channel */
 
3001
        __le32 channel_beacons; /* beacons with our bss id and in our
 
3002
                                 * serving channel */
 
3003
        __le32 num_missed_bcon; /* number of missed beacons */
 
3004
        __le32 adc_rx_saturation_time;  /* count in 0.8us units the time the
 
3005
                                         * ADC was in saturation */
 
3006
        __le32 ina_detection_search_time;/* total time (in 0.8us) searched
 
3007
                                          * for INA */
 
3008
        __le32 beacon_silence_rssi_a;   /* RSSI silence after beacon frame */
 
3009
        __le32 beacon_silence_rssi_b;   /* RSSI silence after beacon frame */
 
3010
        __le32 beacon_silence_rssi_c;   /* RSSI silence after beacon frame */
 
3011
        __le32 interference_data_flag;  /* flag for interference data
 
3012
                                         * availability. 1 when data is
 
3013
                                         * available. */
 
3014
        __le32 channel_load;            /* counts RX Enable time in uSec */
 
3015
        __le32 dsp_false_alarms;        /* DSP false alarm (both OFDM
 
3016
                                         * and CCK) counter */
 
3017
        __le32 beacon_rssi_a;
 
3018
        __le32 beacon_rssi_b;
 
3019
        __le32 beacon_rssi_c;
 
3020
        __le32 beacon_energy_a;
 
3021
        __le32 beacon_energy_b;
 
3022
        __le32 beacon_energy_c;
 
3023
} __attribute__ ((packed));
 
3024
 
 
3025
struct statistics_rx {
 
3026
        struct statistics_rx_phy ofdm;
 
3027
        struct statistics_rx_phy cck;
 
3028
        struct statistics_rx_non_phy general;
 
3029
        struct statistics_rx_ht_phy ofdm_ht;
 
3030
} __attribute__ ((packed));
 
3031
 
 
3032
/**
 
3033
 * struct statistics_tx_power - current tx power
 
3034
 *
 
3035
 * @ant_a: current tx power on chain a in 1/2 dB step
 
3036
 * @ant_b: current tx power on chain b in 1/2 dB step
 
3037
 * @ant_c: current tx power on chain c in 1/2 dB step
 
3038
 */
 
3039
struct statistics_tx_power {
 
3040
        u8 ant_a;
 
3041
        u8 ant_b;
 
3042
        u8 ant_c;
 
3043
        u8 reserved;
 
3044
} __attribute__ ((packed));
 
3045
 
 
3046
struct statistics_tx_non_phy_agg {
 
3047
        __le32 ba_timeout;
 
3048
        __le32 ba_reschedule_frames;
 
3049
        __le32 scd_query_agg_frame_cnt;
 
3050
        __le32 scd_query_no_agg;
 
3051
        __le32 scd_query_agg;
 
3052
        __le32 scd_query_mismatch;
 
3053
        __le32 frame_not_ready;
 
3054
        __le32 underrun;
 
3055
        __le32 bt_prio_kill;
 
3056
        __le32 rx_ba_rsp_cnt;
 
3057
} __attribute__ ((packed));
 
3058
 
 
3059
struct statistics_tx {
 
3060
        __le32 preamble_cnt;
 
3061
        __le32 rx_detected_cnt;
 
3062
        __le32 bt_prio_defer_cnt;
 
3063
        __le32 bt_prio_kill_cnt;
 
3064
        __le32 few_bytes_cnt;
 
3065
        __le32 cts_timeout;
 
3066
        __le32 ack_timeout;
 
3067
        __le32 expected_ack_cnt;
 
3068
        __le32 actual_ack_cnt;
 
3069
        __le32 dump_msdu_cnt;
 
3070
        __le32 burst_abort_next_frame_mismatch_cnt;
 
3071
        __le32 burst_abort_missing_next_frame_cnt;
 
3072
        __le32 cts_timeout_collision;
 
3073
        __le32 ack_or_ba_timeout_collision;
 
3074
        struct statistics_tx_non_phy_agg agg;
 
3075
        struct statistics_tx_power tx_power;
 
3076
        __le32 reserved1;
 
3077
} __attribute__ ((packed));
 
3078
 
 
3079
 
 
3080
struct statistics_div {
 
3081
        __le32 tx_on_a;
 
3082
        __le32 tx_on_b;
 
3083
        __le32 exec_time;
 
3084
        __le32 probe_time;
 
3085
        __le32 reserved1;
 
3086
        __le32 reserved2;
 
3087
} __attribute__ ((packed));
 
3088
 
 
3089
struct statistics_general {
 
3090
        __le32 temperature;
 
3091
        __le32 temperature_m;
 
3092
        struct statistics_dbg dbg;
 
3093
        __le32 sleep_time;
 
3094
        __le32 slots_out;
 
3095
        __le32 slots_idle;
 
3096
        __le32 ttl_timestamp;
 
3097
        struct statistics_div div;
 
3098
        __le32 rx_enable_counter;
 
3099
        __le32 reserved1;
 
3100
        __le32 reserved2;
 
3101
        __le32 reserved3;
 
3102
} __attribute__ ((packed));
 
3103
 
 
3104
#define UCODE_STATISTICS_CLEAR_MSK              (0x1 << 0)
 
3105
#define UCODE_STATISTICS_FREQUENCY_MSK          (0x1 << 1)
 
3106
#define UCODE_STATISTICS_NARROW_BAND_MSK        (0x1 << 2)
 
3107
 
 
3108
/*
 
3109
 * REPLY_STATISTICS_CMD = 0x9c,
 
3110
 * 3945 and 4965 identical.
 
3111
 *
 
3112
 * This command triggers an immediate response containing uCode statistics.
 
3113
 * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
 
3114
 *
 
3115
 * If the CLEAR_STATS configuration flag is set, uCode will clear its
 
3116
 * internal copy of the statistics (counters) after issuing the response.
 
3117
 * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
 
3118
 *
 
3119
 * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
 
3120
 * STATISTICS_NOTIFICATIONs after received beacons (see below).  This flag
 
3121
 * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
 
3122
 */
 
3123
#define IWL_STATS_CONF_CLEAR_STATS cpu_to_le32(0x1)     /* see above */
 
3124
#define IWL_STATS_CONF_DISABLE_NOTIF cpu_to_le32(0x2)/* see above */
 
3125
struct iwl_statistics_cmd {
 
3126
        __le32 configuration_flags;     /* IWL_STATS_CONF_* */
 
3127
} __attribute__ ((packed));
 
3128
 
 
3129
/*
 
3130
 * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
 
3131
 *
 
3132
 * By default, uCode issues this notification after receiving a beacon
 
3133
 * while associated.  To disable this behavior, set DISABLE_NOTIF flag in the
 
3134
 * REPLY_STATISTICS_CMD 0x9c, above.
 
3135
 *
 
3136
 * Statistics counters continue to increment beacon after beacon, but are
 
3137
 * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
 
3138
 * 0x9c with CLEAR_STATS bit set (see above).
 
3139
 *
 
3140
 * uCode also issues this notification during scans.  uCode clears statistics
 
3141
 * appropriately so that each notification contains statistics for only the
 
3142
 * one channel that has just been scanned.
 
3143
 */
 
3144
#define STATISTICS_REPLY_FLG_BAND_24G_MSK         cpu_to_le32(0x2)
 
3145
#define STATISTICS_REPLY_FLG_HT40_MODE_MSK        cpu_to_le32(0x8)
 
3146
 
 
3147
struct iwl3945_notif_statistics {
 
3148
        __le32 flag;
 
3149
        struct iwl39_statistics_rx rx;
 
3150
        struct iwl39_statistics_tx tx;
 
3151
        struct iwl39_statistics_general general;
 
3152
} __attribute__ ((packed));
 
3153
 
 
3154
struct iwl_notif_statistics {
 
3155
        __le32 flag;
 
3156
        struct statistics_rx rx;
 
3157
        struct statistics_tx tx;
 
3158
        struct statistics_general general;
 
3159
} __attribute__ ((packed));
 
3160
 
 
3161
 
 
3162
/*
 
3163
 * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
 
3164
 */
 
3165
/* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row,
 
3166
 * then this notification will be sent. */
 
3167
#define CONSECUTIVE_MISSED_BCONS_TH 20
 
3168
 
 
3169
struct iwl_missed_beacon_notif {
 
3170
        __le32 consequtive_missed_beacons;
 
3171
        __le32 total_missed_becons;
 
3172
        __le32 num_expected_beacons;
 
3173
        __le32 num_recvd_beacons;
 
3174
} __attribute__ ((packed));
 
3175
 
 
3176
 
 
3177
/******************************************************************************
 
3178
 * (11)
 
3179
 * Rx Calibration Commands:
 
3180
 *
 
3181
 * With the uCode used for open source drivers, most Tx calibration (except
 
3182
 * for Tx Power) and most Rx calibration is done by uCode during the
 
3183
 * "initialize" phase of uCode boot.  Driver must calibrate only:
 
3184
 *
 
3185
 * 1)  Tx power (depends on temperature), described elsewhere
 
3186
 * 2)  Receiver gain balance (optimize MIMO, and detect disconnected antennas)
 
3187
 * 3)  Receiver sensitivity (to optimize signal detection)
 
3188
 *
 
3189
 *****************************************************************************/
 
3190
 
 
3191
/**
 
3192
 * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
 
3193
 *
 
3194
 * This command sets up the Rx signal detector for a sensitivity level that
 
3195
 * is high enough to lock onto all signals within the associated network,
 
3196
 * but low enough to ignore signals that are below a certain threshold, so as
 
3197
 * not to have too many "false alarms".  False alarms are signals that the
 
3198
 * Rx DSP tries to lock onto, but then discards after determining that they
 
3199
 * are noise.
 
3200
 *
 
3201
 * The optimum number of false alarms is between 5 and 50 per 200 TUs
 
3202
 * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
 
3203
 * time listening, not transmitting).  Driver must adjust sensitivity so that
 
3204
 * the ratio of actual false alarms to actual Rx time falls within this range.
 
3205
 *
 
3206
 * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
 
3207
 * received beacon.  These provide information to the driver to analyze the
 
3208
 * sensitivity.  Don't analyze statistics that come in from scanning, or any
 
3209
 * other non-associated-network source.  Pertinent statistics include:
 
3210
 *
 
3211
 * From "general" statistics (struct statistics_rx_non_phy):
 
3212
 *
 
3213
 * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
 
3214
 *   Measure of energy of desired signal.  Used for establishing a level
 
3215
 *   below which the device does not detect signals.
 
3216
 *
 
3217
 * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
 
3218
 *   Measure of background noise in silent period after beacon.
 
3219
 *
 
3220
 * channel_load
 
3221
 *   uSecs of actual Rx time during beacon period (varies according to
 
3222
 *   how much time was spent transmitting).
 
3223
 *
 
3224
 * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
 
3225
 *
 
3226
 * false_alarm_cnt
 
3227
 *   Signal locks abandoned early (before phy-level header).
 
3228
 *
 
3229
 * plcp_err
 
3230
 *   Signal locks abandoned late (during phy-level header).
 
3231
 *
 
3232
 * NOTE:  Both false_alarm_cnt and plcp_err increment monotonically from
 
3233
 *        beacon to beacon, i.e. each value is an accumulation of all errors
 
3234
 *        before and including the latest beacon.  Values will wrap around to 0
 
3235
 *        after counting up to 2^32 - 1.  Driver must differentiate vs.
 
3236
 *        previous beacon's values to determine # false alarms in the current
 
3237
 *        beacon period.
 
3238
 *
 
3239
 * Total number of false alarms = false_alarms + plcp_errs
 
3240
 *
 
3241
 * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
 
3242
 * (notice that the start points for OFDM are at or close to settings for
 
3243
 * maximum sensitivity):
 
3244
 *
 
3245
 *                                             START  /  MIN  /  MAX
 
3246
 *   HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX          90   /   85  /  120
 
3247
 *   HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX     170   /  170  /  210
 
3248
 *   HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX         105   /  105  /  140
 
3249
 *   HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX     220   /  220  /  270
 
3250
 *
 
3251
 *   If actual rate of OFDM false alarms (+ plcp_errors) is too high
 
3252
 *   (greater than 50 for each 204.8 msecs listening), reduce sensitivity
 
3253
 *   by *adding* 1 to all 4 of the table entries above, up to the max for
 
3254
 *   each entry.  Conversely, if false alarm rate is too low (less than 5
 
3255
 *   for each 204.8 msecs listening), *subtract* 1 from each entry to
 
3256
 *   increase sensitivity.
 
3257
 *
 
3258
 * For CCK sensitivity, keep track of the following:
 
3259
 *
 
3260
 *   1).  20-beacon history of maximum background noise, indicated by
 
3261
 *        (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
 
3262
 *        3 receivers.  For any given beacon, the "silence reference" is
 
3263
 *        the maximum of last 60 samples (20 beacons * 3 receivers).
 
3264
 *
 
3265
 *   2).  10-beacon history of strongest signal level, as indicated
 
3266
 *        by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
 
3267
 *        i.e. the strength of the signal through the best receiver at the
 
3268
 *        moment.  These measurements are "upside down", with lower values
 
3269
 *        for stronger signals, so max energy will be *minimum* value.
 
3270
 *
 
3271
 *        Then for any given beacon, the driver must determine the *weakest*
 
3272
 *        of the strongest signals; this is the minimum level that needs to be
 
3273
 *        successfully detected, when using the best receiver at the moment.
 
3274
 *        "Max cck energy" is the maximum (higher value means lower energy!)
 
3275
 *        of the last 10 minima.  Once this is determined, driver must add
 
3276
 *        a little margin by adding "6" to it.
 
3277
 *
 
3278
 *   3).  Number of consecutive beacon periods with too few false alarms.
 
3279
 *        Reset this to 0 at the first beacon period that falls within the
 
3280
 *        "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
 
3281
 *
 
3282
 * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
 
3283
 * (notice that the start points for CCK are at maximum sensitivity):
 
3284
 *
 
3285
 *                                             START  /  MIN  /  MAX
 
3286
 *   HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX         125   /  125  /  200
 
3287
 *   HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX     200   /  200  /  400
 
3288
 *   HD_MIN_ENERGY_CCK_DET_INDEX                100   /    0  /  100
 
3289
 *
 
3290
 *   If actual rate of CCK false alarms (+ plcp_errors) is too high
 
3291
 *   (greater than 50 for each 204.8 msecs listening), method for reducing
 
3292
 *   sensitivity is:
 
3293
 *
 
3294
 *   1)  *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
 
3295
 *       up to max 400.
 
3296
 *
 
3297
 *   2)  If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
 
3298
 *       sensitivity has been reduced a significant amount; bring it up to
 
3299
 *       a moderate 161.  Otherwise, *add* 3, up to max 200.
 
3300
 *
 
3301
 *   3)  a)  If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
 
3302
 *       sensitivity has been reduced only a moderate or small amount;
 
3303
 *       *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
 
3304
 *       down to min 0.  Otherwise (if gain has been significantly reduced),
 
3305
 *       don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
 
3306
 *
 
3307
 *       b)  Save a snapshot of the "silence reference".
 
3308
 *
 
3309
 *   If actual rate of CCK false alarms (+ plcp_errors) is too low
 
3310
 *   (less than 5 for each 204.8 msecs listening), method for increasing
 
3311
 *   sensitivity is used only if:
 
3312
 *
 
3313
 *   1a)  Previous beacon did not have too many false alarms
 
3314
 *   1b)  AND difference between previous "silence reference" and current
 
3315
 *        "silence reference" (prev - current) is 2 or more,
 
3316
 *   OR 2)  100 or more consecutive beacon periods have had rate of
 
3317
 *          less than 5 false alarms per 204.8 milliseconds rx time.
 
3318
 *
 
3319
 *   Method for increasing sensitivity:
 
3320
 *
 
3321
 *   1)  *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
 
3322
 *       down to min 125.
 
3323
 *
 
3324
 *   2)  *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
 
3325
 *       down to min 200.
 
3326
 *
 
3327
 *   3)  *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
 
3328
 *
 
3329
 *   If actual rate of CCK false alarms (+ plcp_errors) is within good range
 
3330
 *   (between 5 and 50 for each 204.8 msecs listening):
 
3331
 *
 
3332
 *   1)  Save a snapshot of the silence reference.
 
3333
 *
 
3334
 *   2)  If previous beacon had too many CCK false alarms (+ plcp_errors),
 
3335
 *       give some extra margin to energy threshold by *subtracting* 8
 
3336
 *       from value in HD_MIN_ENERGY_CCK_DET_INDEX.
 
3337
 *
 
3338
 *   For all cases (too few, too many, good range), make sure that the CCK
 
3339
 *   detection threshold (energy) is below the energy level for robust
 
3340
 *   detection over the past 10 beacon periods, the "Max cck energy".
 
3341
 *   Lower values mean higher energy; this means making sure that the value
 
3342
 *   in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
 
3343
 *
 
3344
 */
 
3345
 
 
3346
/*
 
3347
 * Table entries in SENSITIVITY_CMD (struct iwl_sensitivity_cmd)
 
3348
 */
 
3349
#define HD_TABLE_SIZE  (11)     /* number of entries */
 
3350
#define HD_MIN_ENERGY_CCK_DET_INDEX                 (0) /* table indexes */
 
3351
#define HD_MIN_ENERGY_OFDM_DET_INDEX                (1)
 
3352
#define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX          (2)
 
3353
#define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX      (3)
 
3354
#define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX      (4)
 
3355
#define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX          (5)
 
3356
#define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX      (6)
 
3357
#define HD_BARKER_CORR_TH_ADD_MIN_INDEX             (7)
 
3358
#define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX         (8)
 
3359
#define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX          (9)
 
3360
#define HD_OFDM_ENERGY_TH_IN_INDEX                  (10)
 
3361
 
 
3362
/* Control field in struct iwl_sensitivity_cmd */
 
3363
#define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE   cpu_to_le16(0)
 
3364
#define SENSITIVITY_CMD_CONTROL_WORK_TABLE      cpu_to_le16(1)
 
3365
 
 
3366
/**
 
3367
 * struct iwl_sensitivity_cmd
 
3368
 * @control:  (1) updates working table, (0) updates default table
 
3369
 * @table:  energy threshold values, use HD_* as index into table
 
3370
 *
 
3371
 * Always use "1" in "control" to update uCode's working table and DSP.
 
3372
 */
 
3373
struct iwl_sensitivity_cmd {
 
3374
        __le16 control;                 /* always use "1" */
 
3375
        __le16 table[HD_TABLE_SIZE];    /* use HD_* as index */
 
3376
} __attribute__ ((packed));
 
3377
 
 
3378
 
 
3379
/**
 
3380
 * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
 
3381
 *
 
3382
 * This command sets the relative gains of 4965's 3 radio receiver chains.
 
3383
 *
 
3384
 * After the first association, driver should accumulate signal and noise
 
3385
 * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
 
3386
 * beacons from the associated network (don't collect statistics that come
 
3387
 * in from scanning, or any other non-network source).
 
3388
 *
 
3389
 * DISCONNECTED ANTENNA:
 
3390
 *
 
3391
 * Driver should determine which antennas are actually connected, by comparing
 
3392
 * average beacon signal levels for the 3 Rx chains.  Accumulate (add) the
 
3393
 * following values over 20 beacons, one accumulator for each of the chains
 
3394
 * a/b/c, from struct statistics_rx_non_phy:
 
3395
 *
 
3396
 * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
 
3397
 *
 
3398
 * Find the strongest signal from among a/b/c.  Compare the other two to the
 
3399
 * strongest.  If any signal is more than 15 dB (times 20, unless you
 
3400
 * divide the accumulated values by 20) below the strongest, the driver
 
3401
 * considers that antenna to be disconnected, and should not try to use that
 
3402
 * antenna/chain for Rx or Tx.  If both A and B seem to be disconnected,
 
3403
 * driver should declare the stronger one as connected, and attempt to use it
 
3404
 * (A and B are the only 2 Tx chains!).
 
3405
 *
 
3406
 *
 
3407
 * RX BALANCE:
 
3408
 *
 
3409
 * Driver should balance the 3 receivers (but just the ones that are connected
 
3410
 * to antennas, see above) for gain, by comparing the average signal levels
 
3411
 * detected during the silence after each beacon (background noise).
 
3412
 * Accumulate (add) the following values over 20 beacons, one accumulator for
 
3413
 * each of the chains a/b/c, from struct statistics_rx_non_phy:
 
3414
 *
 
3415
 * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
 
3416
 *
 
3417
 * Find the weakest background noise level from among a/b/c.  This Rx chain
 
3418
 * will be the reference, with 0 gain adjustment.  Attenuate other channels by
 
3419
 * finding noise difference:
 
3420
 *
 
3421
 * (accum_noise[i] - accum_noise[reference]) / 30
 
3422
 *
 
3423
 * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
 
3424
 * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
 
3425
 * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
 
3426
 * and set bit 2 to indicate "reduce gain".  The value for the reference
 
3427
 * (weakest) chain should be "0".
 
3428
 *
 
3429
 * diff_gain_[abc] bit fields:
 
3430
 *   2: (1) reduce gain, (0) increase gain
 
3431
 * 1-0: amount of gain, units of 1.5 dB
 
3432
 */
 
3433
 
 
3434
/* Phy calibration command for series */
 
3435
 
 
3436
enum {
 
3437
        IWL_PHY_CALIBRATE_DIFF_GAIN_CMD         = 7,
 
3438
        IWL_PHY_CALIBRATE_DC_CMD                = 8,
 
3439
        IWL_PHY_CALIBRATE_LO_CMD                = 9,
 
3440
        IWL_PHY_CALIBRATE_RX_BB_CMD             = 10,
 
3441
        IWL_PHY_CALIBRATE_TX_IQ_CMD             = 11,
 
3442
        IWL_PHY_CALIBRATE_RX_IQ_CMD             = 12,
 
3443
        IWL_PHY_CALIBRATION_NOISE_CMD           = 13,
 
3444
        IWL_PHY_CALIBRATE_AGC_TABLE_CMD         = 14,
 
3445
        IWL_PHY_CALIBRATE_CRYSTAL_FRQ_CMD       = 15,
 
3446
        IWL_PHY_CALIBRATE_BASE_BAND_CMD         = 16,
 
3447
        IWL_PHY_CALIBRATE_TX_IQ_PERD_CMD        = 17,
 
3448
        IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD = 18,
 
3449
        IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD  = 19,
 
3450
};
 
3451
 
 
3452
 
 
3453
#define IWL_CALIB_INIT_CFG_ALL  cpu_to_le32(0xffffffff)
 
3454
 
 
3455
struct iwl_calib_cfg_elmnt_s {
 
3456
        __le32 is_enable;
 
3457
        __le32 start;
 
3458
        __le32 send_res;
 
3459
        __le32 apply_res;
 
3460
        __le32 reserved;
 
3461
} __attribute__ ((packed));
 
3462
 
 
3463
struct iwl_calib_cfg_status_s {
 
3464
        struct iwl_calib_cfg_elmnt_s once;
 
3465
        struct iwl_calib_cfg_elmnt_s perd;
 
3466
        __le32 flags;
 
3467
} __attribute__ ((packed));
 
3468
 
 
3469
struct iwl_calib_cfg_cmd {
 
3470
        struct iwl_calib_cfg_status_s ucd_calib_cfg;
 
3471
        struct iwl_calib_cfg_status_s drv_calib_cfg;
 
3472
        __le32 reserved1;
 
3473
} __attribute__ ((packed));
 
3474
 
 
3475
struct iwl_calib_hdr {
 
3476
        u8 op_code;
 
3477
        u8 first_group;
 
3478
        u8 groups_num;
 
3479
        u8 data_valid;
 
3480
} __attribute__ ((packed));
 
3481
 
 
3482
struct iwl_calib_cmd {
 
3483
        struct iwl_calib_hdr hdr;
 
3484
        u8 data[0];
 
3485
} __attribute__ ((packed));
 
3486
 
 
3487
/* IWL_PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
 
3488
struct iwl_calib_diff_gain_cmd {
 
3489
        struct iwl_calib_hdr hdr;
 
3490
        s8 diff_gain_a;         /* see above */
 
3491
        s8 diff_gain_b;
 
3492
        s8 diff_gain_c;
 
3493
        u8 reserved1;
 
3494
} __attribute__ ((packed));
 
3495
 
 
3496
struct iwl_calib_xtal_freq_cmd {
 
3497
        struct iwl_calib_hdr hdr;
 
3498
        u8 cap_pin1;
 
3499
        u8 cap_pin2;
 
3500
        u8 pad[2];
 
3501
} __attribute__ ((packed));
 
3502
 
 
3503
/* IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD */
 
3504
struct iwl_calib_chain_noise_reset_cmd {
 
3505
        struct iwl_calib_hdr hdr;
 
3506
        u8 data[0];
 
3507
};
 
3508
 
 
3509
/* IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD */
 
3510
struct iwl_calib_chain_noise_gain_cmd {
 
3511
        struct iwl_calib_hdr hdr;
 
3512
        u8 delta_gain_1;
 
3513
        u8 delta_gain_2;
 
3514
        u8 pad[2];
 
3515
} __attribute__ ((packed));
 
3516
 
 
3517
/******************************************************************************
 
3518
 * (12)
 
3519
 * Miscellaneous Commands:
 
3520
 *
 
3521
 *****************************************************************************/
 
3522
 
 
3523
/*
 
3524
 * LEDs Command & Response
 
3525
 * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
 
3526
 *
 
3527
 * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
 
3528
 * this command turns it on or off, or sets up a periodic blinking cycle.
 
3529
 */
 
3530
struct iwl_led_cmd {
 
3531
        __le32 interval;        /* "interval" in uSec */
 
3532
        u8 id;                  /* 1: Activity, 2: Link, 3: Tech */
 
3533
        u8 off;                 /* # intervals off while blinking;
 
3534
                                 * "0", with >0 "on" value, turns LED on */
 
3535
        u8 on;                  /* # intervals on while blinking;
 
3536
                                 * "0", regardless of "off", turns LED off */
 
3537
        u8 reserved;
 
3538
} __attribute__ ((packed));
 
3539
 
 
3540
/*
 
3541
 * station priority table entries
 
3542
 * also used as potential "events" value for both
 
3543
 * COEX_MEDIUM_NOTIFICATION and COEX_EVENT_CMD
 
3544
 */
 
3545
 
 
3546
/*
 
3547
 * COEX events entry flag masks
 
3548
 * RP - Requested Priority
 
3549
 * WP - Win Medium Priority: priority assigned when the contention has been won
 
3550
 */
 
3551
#define COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG        (0x1)
 
3552
#define COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG        (0x2)
 
3553
#define COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG  (0x4)
 
3554
 
 
3555
#define COEX_CU_UNASSOC_IDLE_RP               4
 
3556
#define COEX_CU_UNASSOC_MANUAL_SCAN_RP        4
 
3557
#define COEX_CU_UNASSOC_AUTO_SCAN_RP          4
 
3558
#define COEX_CU_CALIBRATION_RP                4
 
3559
#define COEX_CU_PERIODIC_CALIBRATION_RP       4
 
3560
#define COEX_CU_CONNECTION_ESTAB_RP           4
 
3561
#define COEX_CU_ASSOCIATED_IDLE_RP            4
 
3562
#define COEX_CU_ASSOC_MANUAL_SCAN_RP          4
 
3563
#define COEX_CU_ASSOC_AUTO_SCAN_RP            4
 
3564
#define COEX_CU_ASSOC_ACTIVE_LEVEL_RP         4
 
3565
#define COEX_CU_RF_ON_RP                      6
 
3566
#define COEX_CU_RF_OFF_RP                     4
 
3567
#define COEX_CU_STAND_ALONE_DEBUG_RP          6
 
3568
#define COEX_CU_IPAN_ASSOC_LEVEL_RP           4
 
3569
#define COEX_CU_RSRVD1_RP                     4
 
3570
#define COEX_CU_RSRVD2_RP                     4
 
3571
 
 
3572
#define COEX_CU_UNASSOC_IDLE_WP               3
 
3573
#define COEX_CU_UNASSOC_MANUAL_SCAN_WP        3
 
3574
#define COEX_CU_UNASSOC_AUTO_SCAN_WP          3
 
3575
#define COEX_CU_CALIBRATION_WP                3
 
3576
#define COEX_CU_PERIODIC_CALIBRATION_WP       3
 
3577
#define COEX_CU_CONNECTION_ESTAB_WP           3
 
3578
#define COEX_CU_ASSOCIATED_IDLE_WP            3
 
3579
#define COEX_CU_ASSOC_MANUAL_SCAN_WP          3
 
3580
#define COEX_CU_ASSOC_AUTO_SCAN_WP            3
 
3581
#define COEX_CU_ASSOC_ACTIVE_LEVEL_WP         3
 
3582
#define COEX_CU_RF_ON_WP                      3
 
3583
#define COEX_CU_RF_OFF_WP                     3
 
3584
#define COEX_CU_STAND_ALONE_DEBUG_WP          6
 
3585
#define COEX_CU_IPAN_ASSOC_LEVEL_WP           3
 
3586
#define COEX_CU_RSRVD1_WP                     3
 
3587
#define COEX_CU_RSRVD2_WP                     3
 
3588
 
 
3589
#define COEX_UNASSOC_IDLE_FLAGS                     0
 
3590
#define COEX_UNASSOC_MANUAL_SCAN_FLAGS          \
 
3591
        (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
 
3592
        COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
 
3593
#define COEX_UNASSOC_AUTO_SCAN_FLAGS            \
 
3594
        (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
 
3595
        COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
 
3596
#define COEX_CALIBRATION_FLAGS                  \
 
3597
        (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
 
3598
        COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
 
3599
#define COEX_PERIODIC_CALIBRATION_FLAGS             0
 
3600
/*
 
3601
 * COEX_CONNECTION_ESTAB:
 
3602
 * we need DELAY_MEDIUM_FREE_NTFY to let WiMAX disconnect from network.
 
3603
 */
 
3604
#define COEX_CONNECTION_ESTAB_FLAGS             \
 
3605
        (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
 
3606
        COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG |    \
 
3607
        COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
 
3608
#define COEX_ASSOCIATED_IDLE_FLAGS                  0
 
3609
#define COEX_ASSOC_MANUAL_SCAN_FLAGS            \
 
3610
        (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
 
3611
        COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
 
3612
#define COEX_ASSOC_AUTO_SCAN_FLAGS              \
 
3613
        (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
 
3614
         COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
 
3615
#define COEX_ASSOC_ACTIVE_LEVEL_FLAGS               0
 
3616
#define COEX_RF_ON_FLAGS                            0
 
3617
#define COEX_RF_OFF_FLAGS                           0
 
3618
#define COEX_STAND_ALONE_DEBUG_FLAGS            \
 
3619
        (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
 
3620
         COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
 
3621
#define COEX_IPAN_ASSOC_LEVEL_FLAGS             \
 
3622
        (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
 
3623
         COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG |   \
 
3624
         COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
 
3625
#define COEX_RSRVD1_FLAGS                           0
 
3626
#define COEX_RSRVD2_FLAGS                           0
 
3627
/*
 
3628
 * COEX_CU_RF_ON is the event wrapping all radio ownership.
 
3629
 * We need DELAY_MEDIUM_FREE_NTFY to let WiMAX disconnect from network.
 
3630
 */
 
3631
#define COEX_CU_RF_ON_FLAGS                     \
 
3632
        (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
 
3633
         COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG |   \
 
3634
         COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
 
3635
 
 
3636
 
 
3637
enum {
 
3638
        /* un-association part */
 
3639
        COEX_UNASSOC_IDLE               = 0,
 
3640
        COEX_UNASSOC_MANUAL_SCAN        = 1,
 
3641
        COEX_UNASSOC_AUTO_SCAN          = 2,
 
3642
        /* calibration */
 
3643
        COEX_CALIBRATION                = 3,
 
3644
        COEX_PERIODIC_CALIBRATION       = 4,
 
3645
        /* connection */
 
3646
        COEX_CONNECTION_ESTAB           = 5,
 
3647
        /* association part */
 
3648
        COEX_ASSOCIATED_IDLE            = 6,
 
3649
        COEX_ASSOC_MANUAL_SCAN          = 7,
 
3650
        COEX_ASSOC_AUTO_SCAN            = 8,
 
3651
        COEX_ASSOC_ACTIVE_LEVEL         = 9,
 
3652
        /* RF ON/OFF */
 
3653
        COEX_RF_ON                      = 10,
 
3654
        COEX_RF_OFF                     = 11,
 
3655
        COEX_STAND_ALONE_DEBUG          = 12,
 
3656
        /* IPAN */
 
3657
        COEX_IPAN_ASSOC_LEVEL           = 13,
 
3658
        /* reserved */
 
3659
        COEX_RSRVD1                     = 14,
 
3660
        COEX_RSRVD2                     = 15,
 
3661
        COEX_NUM_OF_EVENTS              = 16
 
3662
};
 
3663
 
 
3664
/*
 
3665
 * Coexistence WIFI/WIMAX  Command
 
3666
 * COEX_PRIORITY_TABLE_CMD = 0x5a
 
3667
 *
 
3668
 */
 
3669
struct iwl_wimax_coex_event_entry {
 
3670
        u8 request_prio;
 
3671
        u8 win_medium_prio;
 
3672
        u8 reserved;
 
3673
        u8 flags;
 
3674
} __attribute__ ((packed));
 
3675
 
 
3676
/* COEX flag masks */
 
3677
 
 
3678
/* Station table is valid */
 
3679
#define COEX_FLAGS_STA_TABLE_VALID_MSK      (0x1)
 
3680
/* UnMask wake up src at unassociated sleep */
 
3681
#define COEX_FLAGS_UNASSOC_WA_UNMASK_MSK    (0x4)
 
3682
/* UnMask wake up src at associated sleep */
 
3683
#define COEX_FLAGS_ASSOC_WA_UNMASK_MSK      (0x8)
 
3684
/* Enable CoEx feature. */
 
3685
#define COEX_FLAGS_COEX_ENABLE_MSK          (0x80)
 
3686
 
 
3687
struct iwl_wimax_coex_cmd {
 
3688
        u8 flags;
 
3689
        u8 reserved[3];
 
3690
        struct iwl_wimax_coex_event_entry sta_prio[COEX_NUM_OF_EVENTS];
 
3691
} __attribute__ ((packed));
 
3692
 
 
3693
/*
 
3694
 * Coexistence MEDIUM NOTIFICATION
 
3695
 * COEX_MEDIUM_NOTIFICATION = 0x5b
 
3696
 *
 
3697
 * notification from uCode to host to indicate medium changes
 
3698
 *
 
3699
 */
 
3700
/*
 
3701
 * status field
 
3702
 * bit 0 - 2: medium status
 
3703
 * bit 3: medium change indication
 
3704
 * bit 4 - 31: reserved
 
3705
 */
 
3706
/* status option values, (0 - 2 bits) */
 
3707
#define COEX_MEDIUM_BUSY        (0x0) /* radio belongs to WiMAX */
 
3708
#define COEX_MEDIUM_ACTIVE      (0x1) /* radio belongs to WiFi */
 
3709
#define COEX_MEDIUM_PRE_RELEASE (0x2) /* received radio release */
 
3710
#define COEX_MEDIUM_MSK         (0x7)
 
3711
 
 
3712
/* send notification status (1 bit) */
 
3713
#define COEX_MEDIUM_CHANGED     (0x8)
 
3714
#define COEX_MEDIUM_CHANGED_MSK (0x8)
 
3715
#define COEX_MEDIUM_SHIFT       (3)
 
3716
 
 
3717
struct iwl_coex_medium_notification {
 
3718
        __le32 status;
 
3719
        __le32 events;
 
3720
} __attribute__ ((packed));
 
3721
 
 
3722
/*
 
3723
 * Coexistence EVENT  Command
 
3724
 * COEX_EVENT_CMD = 0x5c
 
3725
 *
 
3726
 * send from host to uCode for coex event request.
 
3727
 */
 
3728
/* flags options */
 
3729
#define COEX_EVENT_REQUEST_MSK  (0x1)
 
3730
 
 
3731
struct iwl_coex_event_cmd {
 
3732
        u8 flags;
 
3733
        u8 event;
 
3734
        __le16 reserved;
 
3735
} __attribute__ ((packed));
 
3736
 
 
3737
struct iwl_coex_event_resp {
 
3738
        __le32 status;
 
3739
} __attribute__ ((packed));
 
3740
 
 
3741
 
 
3742
/******************************************************************************
 
3743
 * (13)
 
3744
 * Union of all expected notifications/responses:
 
3745
 *
 
3746
 *****************************************************************************/
 
3747
 
 
3748
struct iwl_rx_packet {
 
3749
        /*
 
3750
         * The first 4 bytes of the RX frame header contain both the RX frame
 
3751
         * size and some flags.
 
3752
         * Bit fields:
 
3753
         * 31:    flag flush RB request
 
3754
         * 30:    flag ignore TC (terminal counter) request
 
3755
         * 29:    flag fast IRQ request
 
3756
         * 28-14: Reserved
 
3757
         * 13-00: RX frame size
 
3758
         */
 
3759
        __le32 len_n_flags;
 
3760
        struct iwl_cmd_header hdr;
 
3761
        union {
 
3762
                struct iwl3945_rx_frame rx_frame;
 
3763
                struct iwl3945_tx_resp tx_resp;
 
3764
                struct iwl3945_beacon_notif beacon_status;
 
3765
 
 
3766
                struct iwl_alive_resp alive_frame;
 
3767
                struct iwl_spectrum_notification spectrum_notif;
 
3768
                struct iwl_csa_notification csa_notif;
 
3769
                struct iwl_error_resp err_resp;
 
3770
                struct iwl_card_state_notif card_state_notif;
 
3771
                struct iwl_add_sta_resp add_sta;
 
3772
                struct iwl_rem_sta_resp rem_sta;
 
3773
                struct iwl_sleep_notification sleep_notif;
 
3774
                struct iwl_spectrum_resp spectrum;
 
3775
                struct iwl_notif_statistics stats;
 
3776
                struct iwl_compressed_ba_resp compressed_ba;
 
3777
                struct iwl_missed_beacon_notif missed_beacon;
 
3778
                struct iwl_coex_medium_notification coex_medium_notif;
 
3779
                struct iwl_coex_event_resp coex_event;
 
3780
                __le32 status;
 
3781
                u8 raw[0];
 
3782
        } u;
 
3783
} __attribute__ ((packed));
 
3784
 
 
3785
int iwl_agn_check_rxon_cmd(struct iwl_priv *priv);
 
3786
 
 
3787
#endif                          /* __iwl_commands_h__ */