1
/******************************************************************************
3
* This file is provided under a dual BSD/GPLv2 license. When using or
4
* redistributing this file, you may do so under either license.
8
* Copyright(c) 2005 - 2007 Intel Corporation. All rights reserved.
10
* This program is free software; you can redistribute it and/or modify
11
* it under the terms of version 2 of the GNU General Public License as
12
* published by the Free Software Foundation.
14
* This program is distributed in the hope that it will be useful, but
15
* WITHOUT ANY WARRANTY; without even the implied warranty of
16
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17
* General Public License for more details.
19
* You should have received a copy of the GNU General Public License
20
* along with this program; if not, write to the Free Software
21
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
24
* The full GNU General Public License is included in this distribution
25
* in the file called LICENSE.GPL.
27
* Contact Information:
28
* James P. Ketrenos <ipw2100-admin@linux.intel.com>
29
* Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33
* Copyright(c) 2005 - 2007 Intel Corporation. All rights reserved.
34
* All rights reserved.
36
* Redistribution and use in source and binary forms, with or without
37
* modification, are permitted provided that the following conditions
40
* * Redistributions of source code must retain the above copyright
41
* notice, this list of conditions and the following disclaimer.
42
* * Redistributions in binary form must reproduce the above copyright
43
* notice, this list of conditions and the following disclaimer in
44
* the documentation and/or other materials provided with the
46
* * Neither the name Intel Corporation nor the names of its
47
* contributors may be used to endorse or promote products derived
48
* from this software without specific prior written permission.
50
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62
*****************************************************************************/
64
* Please use this file (iwl-3945-commands.h) only for uCode API definitions.
65
* Please use iwl-3945-hw.h for hardware-related definitions.
66
* Please use iwl-3945.h for driver implementation definitions.
69
#ifndef __iwl_3945_commands_h__
70
#define __iwl_3945_commands_h__
76
/* RXON and QOS commands */
78
REPLY_RXON_ASSOC = 0x11,
79
REPLY_QOS_PARAM = 0x13,
80
REPLY_RXON_TIMING = 0x14,
82
/* Multi-Station support */
84
REPLY_REMOVE_STA = 0x19, /* not used */
85
REPLY_REMOVE_ALL_STA = 0x1a, /* not used */
88
REPLY_3945_RX = 0x1b, /* 3945 only */
90
REPLY_RATE_SCALE = 0x47, /* 3945 only */
91
REPLY_LEDS_CMD = 0x48,
92
REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* 4965 only */
95
RADAR_NOTIFICATION = 0x70, /* not used */
96
REPLY_QUIET_CMD = 0x71, /* not used */
97
REPLY_CHANNEL_SWITCH = 0x72,
98
CHANNEL_SWITCH_NOTIFICATION = 0x73,
99
REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
100
SPECTRUM_MEASURE_NOTIFICATION = 0x75,
102
/* Power Management */
103
POWER_TABLE_CMD = 0x77,
104
PM_SLEEP_NOTIFICATION = 0x7A,
105
PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
107
/* Scan commands and notifications */
108
REPLY_SCAN_CMD = 0x80,
109
REPLY_SCAN_ABORT_CMD = 0x81,
110
SCAN_START_NOTIFICATION = 0x82,
111
SCAN_RESULTS_NOTIFICATION = 0x83,
112
SCAN_COMPLETE_NOTIFICATION = 0x84,
114
/* IBSS/AP commands */
115
BEACON_NOTIFICATION = 0x90,
116
REPLY_TX_BEACON = 0x91,
117
WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */
119
/* Miscellaneous commands */
120
QUIET_NOTIFICATION = 0x96, /* not used */
121
REPLY_TX_PWR_TABLE_CMD = 0x97,
122
MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */
124
/* Bluetooth device coexistance config command */
125
REPLY_BT_CONFIG = 0x9b,
128
REPLY_STATISTICS_CMD = 0x9c,
129
STATISTICS_NOTIFICATION = 0x9d,
131
/* RF-KILL commands and notifications */
132
REPLY_CARD_STATE_CMD = 0xa0,
133
CARD_STATE_NOTIFICATION = 0xa1,
135
/* Missed beacons notification */
136
MISSED_BEACONS_NOTIFICATION = 0xa2,
141
/******************************************************************************
143
* Commonly used structures and definitions:
144
* Command header, txpower
146
*****************************************************************************/
148
/* iwl3945_cmd_header flags value */
149
#define IWL_CMD_FAILED_MSK 0x40
152
* struct iwl3945_cmd_header
154
* This header format appears in the beginning of each command sent from the
155
* driver, and each response/notification received from uCode.
157
struct iwl3945_cmd_header {
158
u8 cmd; /* Command ID: REPLY_RXON, etc. */
159
u8 flags; /* IWL_CMD_* */
161
* The driver sets up the sequence number to values of its chosing.
162
* uCode does not use this value, but passes it back to the driver
163
* when sending the response to each driver-originated command, so
164
* the driver can match the response to the command. Since the values
165
* don't get used by uCode, the driver may set up an arbitrary format.
167
* There is one exception: uCode sets bit 15 when it originates
168
* the response/notification, i.e. when the response/notification
169
* is not a direct response to a command sent by the driver. For
170
* example, uCode issues REPLY_3945_RX when it sends a received frame
171
* to the driver; it is not a direct response to any driver command.
173
* The Linux driver uses the following format:
175
* 0:7 index/position within Tx queue
176
* 8:13 Tx queue selection
177
* 14:14 driver sets this to indicate command is in the 'huge'
178
* storage at the end of the command buffers, i.e. scan cmd
179
* 15:15 uCode sets this in uCode-originated response/notification
183
/* command or response/notification data follows immediately */
185
} __attribute__ ((packed));
188
* struct iwl3945_tx_power
190
* Used in REPLY_TX_PWR_TABLE_CMD, REPLY_SCAN_CMD, REPLY_CHANNEL_SWITCH
192
* Each entry contains two values:
193
* 1) DSP gain (or sometimes called DSP attenuation). This is a fine-grained
194
* linear value that multiplies the output of the digital signal processor,
195
* before being sent to the analog radio.
196
* 2) Radio gain. This sets the analog gain of the radio Tx path.
197
* It is a coarser setting, and behaves in a logarithmic (dB) fashion.
199
* Driver obtains values from struct iwl3945_tx_power power_gain_table[][].
201
struct iwl3945_tx_power {
202
u8 tx_gain; /* gain for analog radio */
203
u8 dsp_atten; /* gain for DSP */
204
} __attribute__ ((packed));
207
* struct iwl3945_power_per_rate
209
* Used in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
211
struct iwl3945_power_per_rate {
213
struct iwl3945_tx_power tpc;
215
} __attribute__ ((packed));
217
/******************************************************************************
219
* Alive and Error Commands & Responses:
221
*****************************************************************************/
223
#define UCODE_VALID_OK __constant_cpu_to_le32(0x1)
224
#define INITIALIZE_SUBTYPE (9)
227
* ("Initialize") REPLY_ALIVE = 0x1 (response only, not a command)
229
* uCode issues this "initialize alive" notification once the initialization
230
* uCode image has completed its work, and is ready to load the runtime image.
231
* This is the *first* "alive" notification that the driver will receive after
232
* rebooting uCode; the "initialize" alive is indicated by subtype field == 9.
234
* See comments documenting "BSM" (bootstrap state machine).
236
struct iwl3945_init_alive_resp {
242
u8 ver_subtype; /* "9" for initialize alive */
244
__le32 log_event_table_ptr;
245
__le32 error_event_table_ptr;
248
} __attribute__ ((packed));
252
* REPLY_ALIVE = 0x1 (response only, not a command)
254
* uCode issues this "alive" notification once the runtime image is ready
255
* to receive commands from the driver. This is the *second* "alive"
256
* notification that the driver will receive after rebooting uCode;
257
* this "alive" is indicated by subtype field != 9.
259
* See comments documenting "BSM" (bootstrap state machine).
261
* This response includes two pointers to structures within the device's
262
* data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
264
* 1) log_event_table_ptr indicates base of the event log. This traces
265
* a 256-entry history of uCode execution within a circular buffer.
267
* 2) error_event_table_ptr indicates base of the error log. This contains
268
* information about any uCode error that occurs.
270
* The Linux driver can print both logs to the system log when a uCode error
273
struct iwl3945_alive_resp {
279
u8 ver_subtype; /* not "9" for runtime alive */
281
__le32 log_event_table_ptr; /* SRAM address for event log */
282
__le32 error_event_table_ptr; /* SRAM address for error log */
285
} __attribute__ ((packed));
294
* REPLY_ERROR = 0x2 (response only, not a command)
296
struct iwl3945_error_resp {
300
__le16 bad_cmd_seq_num;
304
} __attribute__ ((packed));
306
/******************************************************************************
308
* RXON Commands & Responses:
310
*****************************************************************************/
313
* Rx config defines & structure
315
/* rx_config device types */
317
RXON_DEV_TYPE_AP = 1,
318
RXON_DEV_TYPE_ESS = 3,
319
RXON_DEV_TYPE_IBSS = 4,
320
RXON_DEV_TYPE_SNIFFER = 6,
323
/* rx_config flags */
324
/* band & modulation selection */
325
#define RXON_FLG_BAND_24G_MSK __constant_cpu_to_le32(1 << 0)
326
#define RXON_FLG_CCK_MSK __constant_cpu_to_le32(1 << 1)
327
/* auto detection enable */
328
#define RXON_FLG_AUTO_DETECT_MSK __constant_cpu_to_le32(1 << 2)
329
/* TGg protection when tx */
330
#define RXON_FLG_TGG_PROTECT_MSK __constant_cpu_to_le32(1 << 3)
331
/* cck short slot & preamble */
332
#define RXON_FLG_SHORT_SLOT_MSK __constant_cpu_to_le32(1 << 4)
333
#define RXON_FLG_SHORT_PREAMBLE_MSK __constant_cpu_to_le32(1 << 5)
334
/* antenna selection */
335
#define RXON_FLG_DIS_DIV_MSK __constant_cpu_to_le32(1 << 7)
336
#define RXON_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0x0f00)
337
#define RXON_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8)
338
#define RXON_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9)
339
/* radar detection enable */
340
#define RXON_FLG_RADAR_DETECT_MSK __constant_cpu_to_le32(1 << 12)
341
#define RXON_FLG_TGJ_NARROW_BAND_MSK __constant_cpu_to_le32(1 << 13)
342
/* rx response to host with 8-byte TSF
343
* (according to ON_AIR deassertion) */
344
#define RXON_FLG_TSF2HOST_MSK __constant_cpu_to_le32(1 << 15)
346
/* rx_config filter flags */
347
/* accept all data frames */
348
#define RXON_FILTER_PROMISC_MSK __constant_cpu_to_le32(1 << 0)
349
/* pass control & management to host */
350
#define RXON_FILTER_CTL2HOST_MSK __constant_cpu_to_le32(1 << 1)
351
/* accept multi-cast */
352
#define RXON_FILTER_ACCEPT_GRP_MSK __constant_cpu_to_le32(1 << 2)
353
/* don't decrypt uni-cast frames */
354
#define RXON_FILTER_DIS_DECRYPT_MSK __constant_cpu_to_le32(1 << 3)
355
/* don't decrypt multi-cast frames */
356
#define RXON_FILTER_DIS_GRP_DECRYPT_MSK __constant_cpu_to_le32(1 << 4)
357
/* STA is associated */
358
#define RXON_FILTER_ASSOC_MSK __constant_cpu_to_le32(1 << 5)
359
/* transfer to host non bssid beacons in associated state */
360
#define RXON_FILTER_BCON_AWARE_MSK __constant_cpu_to_le32(1 << 6)
363
* REPLY_RXON = 0x10 (command, has simple generic response)
365
* RXON tunes the radio tuner to a service channel, and sets up a number
366
* of parameters that are used primarily for Rx, but also for Tx operations.
368
* NOTE: When tuning to a new channel, driver must set the
369
* RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent
370
* info within the device, including the station tables, tx retry
371
* rate tables, and txpower tables. Driver must build a new station
372
* table and txpower table before transmitting anything on the RXON
375
* NOTE: All RXONs wipe clean the internal txpower table. Driver must
376
* issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
377
* regardless of whether RXON_FILTER_ASSOC_MSK is set.
379
struct iwl3945_rxon_cmd {
384
u8 wlap_bssid_addr[6];
396
} __attribute__ ((packed));
399
* REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
401
struct iwl3945_rxon_assoc_cmd {
407
} __attribute__ ((packed));
410
* REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
412
struct iwl3945_rxon_time_cmd {
414
__le16 beacon_interval;
416
__le32 beacon_init_val;
417
__le16 listen_interval;
419
} __attribute__ ((packed));
422
* REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
424
struct iwl3945_channel_switch_cmd {
429
__le32 rxon_filter_flags;
431
struct iwl3945_power_per_rate power[IWL_MAX_RATES];
432
} __attribute__ ((packed));
435
* CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
437
struct iwl3945_csa_notification {
440
__le32 status; /* 0 - OK, 1 - fail */
441
} __attribute__ ((packed));
443
/******************************************************************************
445
* Quality-of-Service (QOS) Commands & Responses:
447
*****************************************************************************/
450
* struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
451
* One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
453
* @cw_min: Contention window, start value in numbers of slots.
454
* Should be a power-of-2, minus 1. Device's default is 0x0f.
455
* @cw_max: Contention window, max value in numbers of slots.
456
* Should be a power-of-2, minus 1. Device's default is 0x3f.
457
* @aifsn: Number of slots in Arbitration Interframe Space (before
458
* performing random backoff timing prior to Tx). Device default 1.
459
* @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
461
* Device will automatically increase contention window by (2*CW) + 1 for each
462
* transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
463
* value, to cap the CW value.
465
struct iwl3945_ac_qos {
471
} __attribute__ ((packed));
473
/* QoS flags defines */
474
#define QOS_PARAM_FLG_UPDATE_EDCA_MSK __constant_cpu_to_le32(0x01)
475
#define QOS_PARAM_FLG_TGN_MSK __constant_cpu_to_le32(0x02)
476
#define QOS_PARAM_FLG_TXOP_TYPE_MSK __constant_cpu_to_le32(0x10)
478
/* Number of Access Categories (AC) (EDCA), queues 0..3 */
482
* REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
484
* This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
485
* 0: Background, 1: Best Effort, 2: Video, 3: Voice.
487
struct iwl3945_qosparam_cmd {
489
struct iwl3945_ac_qos ac[AC_NUM];
490
} __attribute__ ((packed));
492
/******************************************************************************
494
* Add/Modify Stations Commands & Responses:
496
*****************************************************************************/
498
* Multi station support
501
/* Special, dedicated locations within device's station table */
503
#define IWL_MULTICAST_ID 1
505
#define IWL3945_BROADCAST_ID 24
506
#define IWL3945_STATION_COUNT 25
508
#define IWL_STATION_COUNT 32 /* MAX(3945,4965)*/
509
#define IWL_INVALID_STATION 255
511
#define STA_FLG_TX_RATE_MSK __constant_cpu_to_le32(1<<2);
512
#define STA_FLG_PWR_SAVE_MSK __constant_cpu_to_le32(1<<8);
514
/* Use in mode field. 1: modify existing entry, 0: add new station entry */
515
#define STA_CONTROL_MODIFY_MSK 0x01
517
/* key flags __le16*/
518
#define STA_KEY_FLG_ENCRYPT_MSK __constant_cpu_to_le16(0x7)
519
#define STA_KEY_FLG_NO_ENC __constant_cpu_to_le16(0x0)
520
#define STA_KEY_FLG_WEP __constant_cpu_to_le16(0x1)
521
#define STA_KEY_FLG_CCMP __constant_cpu_to_le16(0x2)
522
#define STA_KEY_FLG_TKIP __constant_cpu_to_le16(0x3)
524
#define STA_KEY_FLG_KEYID_POS 8
525
#define STA_KEY_FLG_INVALID __constant_cpu_to_le16(0x0800)
527
/* Flags indicate whether to modify vs. don't change various station params */
528
#define STA_MODIFY_KEY_MASK 0x01
529
#define STA_MODIFY_TID_DISABLE_TX 0x02
530
#define STA_MODIFY_TX_RATE_MSK 0x04
534
* bit14:15 01 B inactive, A active
535
* 10 B active, A inactive
538
#define RATE_MCS_ANT_A_POS 14
539
#define RATE_MCS_ANT_B_POS 15
540
#define RATE_MCS_ANT_A_MSK 0x4000
541
#define RATE_MCS_ANT_B_MSK 0x8000
542
#define RATE_MCS_ANT_AB_MSK 0xc000
544
struct iwl3945_keyinfo {
546
u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
548
__le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
550
u8 key[16]; /* 16-byte unicast decryption key */
551
} __attribute__ ((packed));
554
* struct sta_id_modify
555
* @addr[ETH_ALEN]: station's MAC address
556
* @sta_id: index of station in uCode's station table
557
* @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
559
* Driver selects unused table index when adding new station,
560
* or the index to a pre-existing station entry when modifying that station.
561
* Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
563
* modify_mask flags select which parameters to modify vs. leave alone.
565
struct sta_id_modify {
571
} __attribute__ ((packed));
574
* REPLY_ADD_STA = 0x18 (command)
576
* The device contains an internal table of per-station information,
577
* with info on security keys, aggregation parameters, and Tx rates for
578
* initial Tx attempt and any retries (4965 uses REPLY_TX_LINK_QUALITY_CMD,
579
* 3945 uses REPLY_RATE_SCALE to set up rate tables).
581
* REPLY_ADD_STA sets up the table entry for one station, either creating
582
* a new entry, or modifying a pre-existing one.
584
* NOTE: RXON command (without "associated" bit set) wipes the station table
585
* clean. Moving into RF_KILL state does this also. Driver must set up
586
* new station table before transmitting anything on the RXON channel
587
* (except active scans or active measurements; those commands carry
588
* their own txpower/rate setup data).
590
* When getting started on a new channel, driver must set up the
591
* IWL_BROADCAST_ID entry (last entry in the table). For a client
592
* station in a BSS, once an AP is selected, driver sets up the AP STA
593
* in the IWL_AP_ID entry (1st entry in the table). BROADCAST and AP
594
* are all that are needed for a BSS client station. If the device is
595
* used as AP, or in an IBSS network, driver must set up station table
596
* entries for all STAs in network, starting with index IWL_STA_ID.
598
struct iwl3945_addsta_cmd {
599
u8 mode; /* 1: modify existing, 0: add new station */
601
struct sta_id_modify sta;
602
struct iwl3945_keyinfo key;
603
__le32 station_flags; /* STA_FLG_* */
604
__le32 station_flags_msk; /* STA_FLG_* */
606
/* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
607
* corresponding to bit (e.g. bit 5 controls TID 5).
608
* Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
609
__le16 tid_disable_tx;
613
/* TID for which to add block-ack support.
614
* Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
615
u8 add_immediate_ba_tid;
617
/* TID for which to remove block-ack support.
618
* Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
619
u8 remove_immediate_ba_tid;
621
/* Starting Sequence Number for added block-ack support.
622
* Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
623
__le16 add_immediate_ba_ssn;
624
} __attribute__ ((packed));
626
#define ADD_STA_SUCCESS_MSK 0x1
627
#define ADD_STA_NO_ROOM_IN_TABLE 0x2
628
#define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4
630
* REPLY_ADD_STA = 0x18 (response)
632
struct iwl3945_add_sta_resp {
633
u8 status; /* ADD_STA_* */
634
} __attribute__ ((packed));
637
/******************************************************************************
641
*****************************************************************************/
643
struct iwl3945_rx_frame_stats {
651
} __attribute__ ((packed));
653
struct iwl3945_rx_frame_hdr {
660
} __attribute__ ((packed));
662
#define RX_RES_STATUS_NO_CRC32_ERROR __constant_cpu_to_le32(1 << 0)
663
#define RX_RES_STATUS_NO_RXE_OVERFLOW __constant_cpu_to_le32(1 << 1)
665
#define RX_RES_PHY_FLAGS_BAND_24_MSK __constant_cpu_to_le16(1 << 0)
666
#define RX_RES_PHY_FLAGS_MOD_CCK_MSK __constant_cpu_to_le16(1 << 1)
667
#define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK __constant_cpu_to_le16(1 << 2)
668
#define RX_RES_PHY_FLAGS_NARROW_BAND_MSK __constant_cpu_to_le16(1 << 3)
669
#define RX_RES_PHY_FLAGS_ANTENNA_MSK __constant_cpu_to_le16(0xf0)
671
#define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)
672
#define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)
673
#define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)
674
#define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)
675
#define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)
677
#define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)
678
#define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)
679
#define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)
680
#define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)
681
#define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)
683
struct iwl3945_rx_frame_end {
686
__le32 beacon_timestamp;
687
} __attribute__ ((packed));
690
* REPLY_3945_RX = 0x1b (response only, not a command)
692
* NOTE: DO NOT dereference from casts to this structure
693
* It is provided only for calculating minimum data set size.
694
* The actual offsets of the hdr and end are dynamic based on
697
struct iwl3945_rx_frame {
698
struct iwl3945_rx_frame_stats stats;
699
struct iwl3945_rx_frame_hdr hdr;
700
struct iwl3945_rx_frame_end end;
701
} __attribute__ ((packed));
703
/* Fixed (non-configurable) rx data from phy */
704
#define RX_PHY_FLAGS_ANTENNAE_OFFSET (4)
705
#define RX_PHY_FLAGS_ANTENNAE_MASK (0x70)
706
#define IWL_AGC_DB_MASK (0x3f80) /* MASK(7,13) */
707
#define IWL_AGC_DB_POS (7)
708
struct iwl4965_rx_non_cfg_phy {
709
__le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */
710
__le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */
711
u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */
713
} __attribute__ ((packed));
716
* REPLY_4965_RX = 0xc3 (response only, not a command)
717
* Used only for legacy (non 11n) frames.
719
#define RX_RES_PHY_CNT 14
720
struct iwl4965_rx_phy_res {
721
u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */
722
u8 cfg_phy_cnt; /* configurable DSP phy data byte count */
723
u8 stat_id; /* configurable DSP phy data set ID */
725
__le64 timestamp; /* TSF at on air rise */
726
__le32 beacon_time_stamp; /* beacon at on-air rise */
727
__le16 phy_flags; /* general phy flags: band, modulation, ... */
728
__le16 channel; /* channel number */
729
__le16 non_cfg_phy[RX_RES_PHY_CNT]; /* upto 14 phy entries */
732
__le16 byte_count; /* frame's byte-count */
734
} __attribute__ ((packed));
736
struct iwl4965_rx_mpdu_res_start {
739
} __attribute__ ((packed));
742
/******************************************************************************
744
* Tx Commands & Responses:
746
* Driver must place each REPLY_TX command into one of the prioritized Tx
747
* queues in host DRAM, shared between driver and device. When the device's
748
* Tx scheduler and uCode are preparing to transmit, the device pulls the
749
* Tx command over the PCI bus via one of the device's Tx DMA channels,
750
* to fill an internal FIFO from which data will be transmitted.
752
* uCode handles all timing and protocol related to control frames
753
* (RTS/CTS/ACK), based on flags in the Tx command.
755
* uCode handles retrying Tx when an ACK is expected but not received.
756
* This includes trying lower data rates than the one requested in the Tx
757
* command, as set up by the REPLY_RATE_SCALE (for 3945) or
758
* REPLY_TX_LINK_QUALITY_CMD (4965).
760
* Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
761
* This command must be executed after every RXON command, before Tx can occur.
762
*****************************************************************************/
764
/* REPLY_TX Tx flags field */
766
/* 1: Use Request-To-Send protocol before this frame.
767
* Mutually exclusive vs. TX_CMD_FLG_CTS_MSK. */
768
#define TX_CMD_FLG_RTS_MSK __constant_cpu_to_le32(1 << 1)
770
/* 1: Transmit Clear-To-Send to self before this frame.
771
* Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
772
* Mutually exclusive vs. TX_CMD_FLG_RTS_MSK. */
773
#define TX_CMD_FLG_CTS_MSK __constant_cpu_to_le32(1 << 2)
775
/* 1: Expect ACK from receiving station
776
* 0: Don't expect ACK (MAC header's duration field s/b 0)
777
* Set this for unicast frames, but not broadcast/multicast. */
778
#define TX_CMD_FLG_ACK_MSK __constant_cpu_to_le32(1 << 3)
780
/* 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
781
* Tx command's initial_rate_index indicates first rate to try;
782
* uCode walks through table for additional Tx attempts.
783
* 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
784
* This rate will be used for all Tx attempts; it will not be scaled. */
785
#define TX_CMD_FLG_STA_RATE_MSK __constant_cpu_to_le32(1 << 4)
787
/* 1: Expect immediate block-ack.
788
* Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */
789
#define TX_CMD_FLG_IMM_BA_RSP_MASK __constant_cpu_to_le32(1 << 6)
791
/* 1: Frame requires full Tx-Op protection.
792
* Set this if either RTS or CTS Tx Flag gets set. */
793
#define TX_CMD_FLG_FULL_TXOP_PROT_MSK __constant_cpu_to_le32(1 << 7)
795
/* Tx antenna selection field; used only for 3945, reserved (0) for 4965.
796
* Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
797
#define TX_CMD_FLG_ANT_SEL_MSK __constant_cpu_to_le32(0xf00)
798
#define TX_CMD_FLG_ANT_A_MSK __constant_cpu_to_le32(1 << 8)
799
#define TX_CMD_FLG_ANT_B_MSK __constant_cpu_to_le32(1 << 9)
801
/* 1: Ignore Bluetooth priority for this frame.
802
* 0: Delay Tx until Bluetooth device is done (normal usage). */
803
#define TX_CMD_FLG_BT_DIS_MSK __constant_cpu_to_le32(1 << 12)
805
/* 1: uCode overrides sequence control field in MAC header.
806
* 0: Driver provides sequence control field in MAC header.
807
* Set this for management frames, non-QOS data frames, non-unicast frames,
808
* and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
809
#define TX_CMD_FLG_SEQ_CTL_MSK __constant_cpu_to_le32(1 << 13)
811
/* 1: This frame is non-last MPDU; more fragments are coming.
812
* 0: Last fragment, or not using fragmentation. */
813
#define TX_CMD_FLG_MORE_FRAG_MSK __constant_cpu_to_le32(1 << 14)
815
/* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
816
* 0: No TSF required in outgoing frame.
817
* Set this for transmitting beacons and probe responses. */
818
#define TX_CMD_FLG_TSF_MSK __constant_cpu_to_le32(1 << 16)
820
/* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
821
* alignment of frame's payload data field.
823
* Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
824
* field (but not both). Driver must align frame data (i.e. data following
825
* MAC header) to DWORD boundary. */
826
#define TX_CMD_FLG_MH_PAD_MSK __constant_cpu_to_le32(1 << 20)
828
/* HCCA-AP - disable duration overwriting. */
829
#define TX_CMD_FLG_DUR_MSK __constant_cpu_to_le32(1 << 25)
832
* TX command security control
834
#define TX_CMD_SEC_WEP 0x01
835
#define TX_CMD_SEC_CCM 0x02
836
#define TX_CMD_SEC_TKIP 0x03
837
#define TX_CMD_SEC_MSK 0x03
838
#define TX_CMD_SEC_SHIFT 6
839
#define TX_CMD_SEC_KEY128 0x08
842
* REPLY_TX = 0x1c (command)
844
struct iwl3945_tx_cmd {
847
* MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
848
* + 8 byte IV for CCM or TKIP (not used for WEP)
850
* + 8-byte MIC (not used for CCM/WEP)
851
* NOTE: Does not include Tx command bytes, post-MAC pad bytes,
852
* MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
853
* Range: 14-2342 bytes.
858
* MPDU or MSDU byte count for next frame.
859
* Used for fragmentation and bursting, but not 11n aggregation.
860
* Same as "len", but for next frame. Set to 0 if not applicable.
862
__le16 next_frame_len;
864
__le32 tx_flags; /* TX_CMD_FLG_* */
868
/* Index of recipient station in uCode's station table */
878
__le32 next_frame_info;
884
u8 rts_retry_limit; /*byte 50 */
885
u8 data_retry_limit; /*byte 51 */
887
__le16 pm_frame_timeout;
888
__le16 attempt_duration;
892
* Duration of EDCA burst Tx Opportunity, in 32-usec units.
893
* Set this if txop time is not specified by HCCA protocol (e.g. by AP).
898
* MAC header goes here, followed by 2 bytes padding if MAC header
899
* length is 26 or 30 bytes, followed by payload data
902
struct ieee80211_hdr hdr[0];
903
} __attribute__ ((packed));
905
/* TX command response is sent after *all* transmission attempts.
909
* TX_STATUS_FAIL_NEXT_FRAG
911
* If the fragment flag in the MAC header for the frame being transmitted
912
* is set and there is insufficient time to transmit the next frame, the
913
* TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.
915
* TX_STATUS_FIFO_UNDERRUN
917
* Indicates the host did not provide bytes to the FIFO fast enough while
918
* a TX was in progress.
920
* TX_STATUS_FAIL_MGMNT_ABORT
922
* This status is only possible if the ABORT ON MGMT RX parameter was
923
* set to true with the TX command.
925
* If the MSB of the status parameter is set then an abort sequence is
926
* required. This sequence consists of the host activating the TX Abort
927
* control line, and then waiting for the TX Abort command response. This
928
* indicates that a the device is no longer in a transmit state, and that the
929
* command FIFO has been cleared. The host must then deactivate the TX Abort
930
* control line. Receiving is still allowed in this case.
933
TX_STATUS_SUCCESS = 0x01,
934
TX_STATUS_DIRECT_DONE = 0x02,
935
TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
936
TX_STATUS_FAIL_LONG_LIMIT = 0x83,
937
TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
938
TX_STATUS_FAIL_MGMNT_ABORT = 0x85,
939
TX_STATUS_FAIL_NEXT_FRAG = 0x86,
940
TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
941
TX_STATUS_FAIL_DEST_PS = 0x88,
942
TX_STATUS_FAIL_ABORTED = 0x89,
943
TX_STATUS_FAIL_BT_RETRY = 0x8a,
944
TX_STATUS_FAIL_STA_INVALID = 0x8b,
945
TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
946
TX_STATUS_FAIL_TID_DISABLE = 0x8d,
947
TX_STATUS_FAIL_FRAME_FLUSHED = 0x8e,
948
TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
949
TX_STATUS_FAIL_TX_LOCKED = 0x90,
950
TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
953
#define TX_PACKET_MODE_REGULAR 0x0000
954
#define TX_PACKET_MODE_BURST_SEQ 0x0100
955
#define TX_PACKET_MODE_BURST_FIRST 0x0200
958
TX_POWER_PA_NOT_ACTIVE = 0x0,
962
TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */
963
TX_STATUS_DELAY_MSK = 0x00000040,
964
TX_STATUS_ABORT_MSK = 0x00000080,
965
TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */
966
TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */
967
TX_RESERVED = 0x00780000, /* bits 19:22 */
968
TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */
969
TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */
973
* REPLY_TX = 0x1c (response)
975
struct iwl3945_tx_resp {
980
__le32 wireless_media_time;
981
__le32 status; /* TX status */
982
} __attribute__ ((packed));
985
* REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
987
struct iwl3945_txpowertable_cmd {
988
u8 band; /* 0: 5 GHz, 1: 2.4 GHz */
991
struct iwl3945_power_per_rate power[IWL_MAX_RATES];
992
} __attribute__ ((packed));
994
struct iwl3945_rate_scaling_info {
998
} __attribute__ ((packed));
1001
* struct iwl3945_rate_scaling_cmd - Rate Scaling Command & Response
1003
* REPLY_RATE_SCALE = 0x47 (command, has simple generic response)
1005
* NOTE: The table of rates passed to the uCode via the
1006
* RATE_SCALE command sets up the corresponding order of
1007
* rates used for all related commands, including rate
1010
* For example, if you set 9MB (PLCP 0x0f) as the first
1011
* rate in the rate table, the bit mask for that rate
1012
* when passed through ofdm_basic_rates on the REPLY_RXON
1013
* command would be bit 0 (1<<0)
1015
struct iwl3945_rate_scaling_cmd {
1018
struct iwl3945_rate_scaling_info table[IWL_MAX_RATES];
1019
} __attribute__ ((packed));
1022
* REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
1024
* 3945 and 4965 support hardware handshake with Bluetooth device on
1025
* same platform. Bluetooth device alerts wireless device when it will Tx;
1026
* wireless device can delay or kill its own Tx to accomodate.
1028
struct iwl3945_bt_cmd {
1033
__le32 kill_ack_mask;
1034
__le32 kill_cts_mask;
1035
} __attribute__ ((packed));
1037
/******************************************************************************
1039
* Spectrum Management (802.11h) Commands, Responses, Notifications:
1041
*****************************************************************************/
1044
* Spectrum Management
1046
#define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \
1047
RXON_FILTER_CTL2HOST_MSK | \
1048
RXON_FILTER_ACCEPT_GRP_MSK | \
1049
RXON_FILTER_DIS_DECRYPT_MSK | \
1050
RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
1051
RXON_FILTER_ASSOC_MSK | \
1052
RXON_FILTER_BCON_AWARE_MSK)
1054
struct iwl3945_measure_channel {
1055
__le32 duration; /* measurement duration in extended beacon
1057
u8 channel; /* channel to measure */
1058
u8 type; /* see enum iwl3945_measure_type */
1060
} __attribute__ ((packed));
1063
* REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
1065
struct iwl3945_spectrum_cmd {
1066
__le16 len; /* number of bytes starting from token */
1067
u8 token; /* token id */
1068
u8 id; /* measurement id -- 0 or 1 */
1069
u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */
1070
u8 periodic; /* 1 = periodic */
1071
__le16 path_loss_timeout;
1072
__le32 start_time; /* start time in extended beacon format */
1074
__le32 flags; /* rxon flags */
1075
__le32 filter_flags; /* rxon filter flags */
1076
__le16 channel_count; /* minimum 1, maximum 10 */
1078
struct iwl3945_measure_channel channels[10];
1079
} __attribute__ ((packed));
1082
* REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
1084
struct iwl3945_spectrum_resp {
1086
u8 id; /* id of the prior command replaced, or 0xff */
1087
__le16 status; /* 0 - command will be handled
1088
* 1 - cannot handle (conflicts with another
1090
} __attribute__ ((packed));
1092
enum iwl3945_measurement_state {
1093
IWL_MEASUREMENT_START = 0,
1094
IWL_MEASUREMENT_STOP = 1,
1097
enum iwl3945_measurement_status {
1098
IWL_MEASUREMENT_OK = 0,
1099
IWL_MEASUREMENT_CONCURRENT = 1,
1100
IWL_MEASUREMENT_CSA_CONFLICT = 2,
1101
IWL_MEASUREMENT_TGH_CONFLICT = 3,
1103
IWL_MEASUREMENT_STOPPED = 6,
1104
IWL_MEASUREMENT_TIMEOUT = 7,
1105
IWL_MEASUREMENT_PERIODIC_FAILED = 8,
1108
#define NUM_ELEMENTS_IN_HISTOGRAM 8
1110
struct iwl3945_measurement_histogram {
1111
__le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
1112
__le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */
1113
} __attribute__ ((packed));
1115
/* clear channel availability counters */
1116
struct iwl3945_measurement_cca_counters {
1119
} __attribute__ ((packed));
1121
enum iwl3945_measure_type {
1122
IWL_MEASURE_BASIC = (1 << 0),
1123
IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
1124
IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
1125
IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
1126
IWL_MEASURE_FRAME = (1 << 4),
1127
/* bits 5:6 are reserved */
1128
IWL_MEASURE_IDLE = (1 << 7),
1132
* SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
1134
struct iwl3945_spectrum_notification {
1135
u8 id; /* measurement id -- 0 or 1 */
1137
u8 channel_index; /* index in measurement channel list */
1138
u8 state; /* 0 - start, 1 - stop */
1139
__le32 start_time; /* lower 32-bits of TSF */
1140
u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */
1142
u8 type; /* see enum iwl3945_measurement_type */
1144
/* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only
1145
* valid if applicable for measurement type requested. */
1146
__le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */
1147
__le32 cca_cck; /* cca fraction time in 44Mhz clock periods */
1148
__le32 cca_time; /* channel load time in usecs */
1149
u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 -
1152
struct iwl3945_measurement_histogram histogram;
1153
__le32 stop_time; /* lower 32-bits of TSF */
1154
__le32 status; /* see iwl3945_measurement_status */
1155
} __attribute__ ((packed));
1157
/******************************************************************************
1159
* Power Management Commands, Responses, Notifications:
1161
*****************************************************************************/
1164
* struct iwl3945_powertable_cmd - Power Table Command
1165
* @flags: See below:
1167
* POWER_TABLE_CMD = 0x77 (command, has simple generic response)
1170
* bit 0 - '0' Driver not allow power management
1171
* '1' Driver allow PM (use rest of parameters)
1172
* uCode send sleep notifications:
1173
* bit 1 - '0' Don't send sleep notification
1174
* '1' send sleep notification (SEND_PM_NOTIFICATION)
1176
* bit 2 - '0' PM have to walk up every DTIM
1177
* '1' PM could sleep over DTIM till listen Interval.
1179
* bit 3 - '0' (PCI_LINK_CTRL & 0x1)
1180
* '1' !(PCI_LINK_CTRL & 0x1)
1182
* bit 31/30- '00' use both mac/xtal sleeps
1183
* '01' force Mac sleep
1184
* '10' force xtal sleep
1187
* NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
1188
* ucode assume sleep over DTIM is allowed and we don't need to wakeup
1191
#define IWL_POWER_VEC_SIZE 5
1193
#define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK __constant_cpu_to_le32(1<<0)
1194
#define IWL_POWER_SLEEP_OVER_DTIM_MSK __constant_cpu_to_le32(1<<2)
1195
#define IWL_POWER_PCI_PM_MSK __constant_cpu_to_le32(1<<3)
1196
struct iwl3945_powertable_cmd {
1198
__le32 rx_data_timeout;
1199
__le32 tx_data_timeout;
1200
__le32 sleep_interval[IWL_POWER_VEC_SIZE];
1201
} __attribute__((packed));
1204
* PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
1205
* 3945 and 4965 identical.
1207
struct iwl3945_sleep_notification {
1214
} __attribute__ ((packed));
1216
/* Sleep states. 3945 and 4965 identical. */
1218
IWL_PM_NO_SLEEP = 0,
1220
IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
1221
IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
1223
IWL_PM_SLP_REPENT = 5,
1224
IWL_PM_WAKEUP_BY_TIMER = 6,
1225
IWL_PM_WAKEUP_BY_DRIVER = 7,
1226
IWL_PM_WAKEUP_BY_RFKILL = 8,
1228
IWL_PM_NUM_OF_MODES = 12,
1232
* REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
1234
#define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */
1235
#define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */
1236
#define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */
1237
struct iwl3945_card_state_cmd {
1238
__le32 status; /* CARD_STATE_CMD_* request new power state */
1239
} __attribute__ ((packed));
1242
* CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
1244
struct iwl3945_card_state_notif {
1246
} __attribute__ ((packed));
1248
#define HW_CARD_DISABLED 0x01
1249
#define SW_CARD_DISABLED 0x02
1250
#define RF_CARD_DISABLED 0x04
1251
#define RXON_CARD_DISABLED 0x10
1253
struct iwl3945_ct_kill_config {
1255
__le32 critical_temperature_M;
1256
__le32 critical_temperature_R;
1257
} __attribute__ ((packed));
1259
/******************************************************************************
1261
* Scan Commands, Responses, Notifications:
1263
*****************************************************************************/
1266
* struct iwl3945_scan_channel - entry in REPLY_SCAN_CMD channel table
1268
* One for each channel in the scan list.
1269
* Each channel can independently select:
1270
* 1) SSID for directed active scans
1271
* 2) Txpower setting (for rate specified within Tx command)
1272
* 3) How long to stay on-channel (behavior may be modified by quiet_time,
1273
* quiet_plcp_th, good_CRC_th)
1275
* To avoid uCode errors, make sure the following are true (see comments
1276
* under struct iwl3945_scan_cmd about max_out_time and quiet_time):
1277
* 1) If using passive_dwell (i.e. passive_dwell != 0):
1278
* active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
1279
* 2) quiet_time <= active_dwell
1280
* 3) If restricting off-channel time (i.e. max_out_time !=0):
1281
* passive_dwell < max_out_time
1282
* active_dwell < max_out_time
1284
struct iwl3945_scan_channel {
1286
* type is defined as:
1287
* 0:0 1 = active, 0 = passive
1288
* 1:4 SSID direct bit map; if a bit is set, then corresponding
1289
* SSID IE is transmitted in probe request.
1293
u8 channel; /* band is selected by iwl3945_scan_cmd "flags" field */
1294
struct iwl3945_tx_power tpc;
1295
__le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */
1296
__le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */
1297
} __attribute__ ((packed));
1300
* struct iwl3945_ssid_ie - directed scan network information element
1302
* Up to 4 of these may appear in REPLY_SCAN_CMD, selected by "type" field
1303
* in struct iwl3945_scan_channel; each channel may select different ssids from
1304
* among the 4 entries. SSID IEs get transmitted in reverse order of entry.
1306
struct iwl3945_ssid_ie {
1310
} __attribute__ ((packed));
1312
#define PROBE_OPTION_MAX 0x4
1313
#define TX_CMD_LIFE_TIME_INFINITE __constant_cpu_to_le32(0xFFFFFFFF)
1314
#define IWL_GOOD_CRC_TH __constant_cpu_to_le16(1)
1315
#define IWL_MAX_SCAN_SIZE 1024
1318
* REPLY_SCAN_CMD = 0x80 (command)
1320
* The hardware scan command is very powerful; the driver can set it up to
1321
* maintain (relatively) normal network traffic while doing a scan in the
1322
* background. The max_out_time and suspend_time control the ratio of how
1323
* long the device stays on an associated network channel ("service channel")
1324
* vs. how long it's away from the service channel, tuned to other channels
1327
* max_out_time is the max time off-channel (in usec), and suspend_time
1328
* is how long (in "extended beacon" format) that the scan is "suspended"
1329
* after returning to the service channel. That is, suspend_time is the
1330
* time that we stay on the service channel, doing normal work, between
1331
* scan segments. The driver may set these parameters differently to support
1332
* scanning when associated vs. not associated, and light vs. heavy traffic
1333
* loads when associated.
1335
* After receiving this command, the device's scan engine does the following;
1337
* 1) Sends SCAN_START notification to driver
1338
* 2) Checks to see if it has time to do scan for one channel
1339
* 3) Sends NULL packet, with power-save (PS) bit set to 1,
1340
* to tell AP that we're going off-channel
1341
* 4) Tunes to first channel in scan list, does active or passive scan
1342
* 5) Sends SCAN_RESULT notification to driver
1343
* 6) Checks to see if it has time to do scan on *next* channel in list
1344
* 7) Repeats 4-6 until it no longer has time to scan the next channel
1345
* before max_out_time expires
1346
* 8) Returns to service channel
1347
* 9) Sends NULL packet with PS=0 to tell AP that we're back
1348
* 10) Stays on service channel until suspend_time expires
1349
* 11) Repeats entire process 2-10 until list is complete
1350
* 12) Sends SCAN_COMPLETE notification
1352
* For fast, efficient scans, the scan command also has support for staying on
1353
* a channel for just a short time, if doing active scanning and getting no
1354
* responses to the transmitted probe request. This time is controlled by
1355
* quiet_time, and the number of received packets below which a channel is
1356
* considered "quiet" is controlled by quiet_plcp_threshold.
1358
* For active scanning on channels that have regulatory restrictions against
1359
* blindly transmitting, the scan can listen before transmitting, to make sure
1360
* that there is already legitimate activity on the channel. If enough
1361
* packets are cleanly received on the channel (controlled by good_CRC_th,
1362
* typical value 1), the scan engine starts transmitting probe requests.
1364
* Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
1366
* To avoid uCode errors, see timing restrictions described under
1367
* struct iwl3945_scan_channel.
1369
struct iwl3945_scan_cmd {
1372
u8 channel_count; /* # channels in channel list */
1373
__le16 quiet_time; /* dwell only this # millisecs on quiet channel
1374
* (only for active scan) */
1375
__le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
1376
__le16 good_CRC_th; /* passive -> active promotion threshold */
1378
__le32 max_out_time; /* max usec to be away from associated (service)
1380
__le32 suspend_time; /* pause scan this long (in "extended beacon
1381
* format") when returning to service channel:
1382
* 3945; 31:24 # beacons, 19:0 additional usec,
1383
* 4965; 31:22 # beacons, 21:0 additional usec.
1385
__le32 flags; /* RXON_FLG_* */
1386
__le32 filter_flags; /* RXON_FILTER_* */
1388
/* For active scans (set to all-0s for passive scans).
1389
* Does not include payload. Must specify Tx rate; no rate scaling. */
1390
struct iwl3945_tx_cmd tx_cmd;
1392
/* For directed active scans (set to all-0s otherwise) */
1393
struct iwl3945_ssid_ie direct_scan[PROBE_OPTION_MAX];
1396
* Probe request frame, followed by channel list.
1398
* Size of probe request frame is specified by byte count in tx_cmd.
1399
* Channel list follows immediately after probe request frame.
1400
* Number of channels in list is specified by channel_count.
1401
* Each channel in list is of type:
1403
* struct iwl3945_scan_channel channels[0];
1405
* NOTE: Only one band of channels can be scanned per pass. You
1406
* must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
1407
* for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
1408
* before requesting another scan.
1411
} __attribute__ ((packed));
1413
/* Can abort will notify by complete notification with abort status. */
1414
#define CAN_ABORT_STATUS __constant_cpu_to_le32(0x1)
1415
/* complete notification statuses */
1416
#define ABORT_STATUS 0x2
1419
* REPLY_SCAN_CMD = 0x80 (response)
1421
struct iwl3945_scanreq_notification {
1422
__le32 status; /* 1: okay, 2: cannot fulfill request */
1423
} __attribute__ ((packed));
1426
* SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
1428
struct iwl3945_scanstart_notification {
1431
__le32 beacon_timer;
1436
} __attribute__ ((packed));
1438
#define SCAN_OWNER_STATUS 0x1;
1439
#define MEASURE_OWNER_STATUS 0x2;
1441
#define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */
1443
* SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
1445
struct iwl3945_scanresults_notification {
1451
__le32 statistics[NUMBER_OF_STATISTICS];
1452
} __attribute__ ((packed));
1455
* SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
1457
struct iwl3945_scancomplete_notification {
1458
u8 scanned_channels;
1464
} __attribute__ ((packed));
1467
/******************************************************************************
1469
* IBSS/AP Commands and Notifications:
1471
*****************************************************************************/
1474
* BEACON_NOTIFICATION = 0x90 (notification only, not a command)
1476
struct iwl3945_beacon_notif {
1477
struct iwl3945_tx_resp beacon_notify_hdr;
1480
__le32 ibss_mgr_status;
1481
} __attribute__ ((packed));
1484
* REPLY_TX_BEACON = 0x91 (command, has simple generic response)
1486
struct iwl3945_tx_beacon_cmd {
1487
struct iwl3945_tx_cmd tx;
1491
struct ieee80211_hdr frame[0]; /* beacon frame */
1492
} __attribute__ ((packed));
1494
/******************************************************************************
1496
* Statistics Commands and Notifications:
1498
*****************************************************************************/
1500
#define IWL_TEMP_CONVERT 260
1502
#define SUP_RATE_11A_MAX_NUM_CHANNELS 8
1503
#define SUP_RATE_11B_MAX_NUM_CHANNELS 4
1504
#define SUP_RATE_11G_MAX_NUM_CHANNELS 12
1506
/* Used for passing to driver number of successes and failures per rate */
1507
struct rate_histogram {
1509
__le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
1510
__le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
1511
__le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
1514
__le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
1515
__le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
1516
__le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
1518
} __attribute__ ((packed));
1520
/* statistics command response */
1522
struct statistics_rx_phy {
1528
__le32 early_overrun_err;
1530
__le32 false_alarm_cnt;
1531
__le32 fina_sync_err_cnt;
1533
__le32 fina_timeout;
1534
__le32 unresponded_rts;
1535
__le32 rxe_frame_limit_overrun;
1536
__le32 sent_ack_cnt;
1537
__le32 sent_cts_cnt;
1538
} __attribute__ ((packed));
1540
struct statistics_rx_non_phy {
1541
__le32 bogus_cts; /* CTS received when not expecting CTS */
1542
__le32 bogus_ack; /* ACK received when not expecting ACK */
1543
__le32 non_bssid_frames; /* number of frames with BSSID that
1544
* doesn't belong to the STA BSSID */
1545
__le32 filtered_frames; /* count frames that were dumped in the
1546
* filtering process */
1547
__le32 non_channel_beacons; /* beacons with our bss id but not on
1548
* our serving channel */
1549
} __attribute__ ((packed));
1551
struct statistics_rx {
1552
struct statistics_rx_phy ofdm;
1553
struct statistics_rx_phy cck;
1554
struct statistics_rx_non_phy general;
1555
} __attribute__ ((packed));
1557
struct statistics_tx {
1558
__le32 preamble_cnt;
1559
__le32 rx_detected_cnt;
1560
__le32 bt_prio_defer_cnt;
1561
__le32 bt_prio_kill_cnt;
1562
__le32 few_bytes_cnt;
1565
__le32 expected_ack_cnt;
1566
__le32 actual_ack_cnt;
1567
} __attribute__ ((packed));
1569
struct statistics_dbg {
1573
} __attribute__ ((packed));
1575
struct statistics_div {
1580
} __attribute__ ((packed));
1582
struct statistics_general {
1584
struct statistics_dbg dbg;
1588
__le32 ttl_timestamp;
1589
struct statistics_div div;
1590
} __attribute__ ((packed));
1593
* REPLY_STATISTICS_CMD = 0x9c,
1594
* 3945 and 4965 identical.
1596
* This command triggers an immediate response containing uCode statistics.
1597
* The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
1599
* If the CLEAR_STATS configuration flag is set, uCode will clear its
1600
* internal copy of the statistics (counters) after issuing the response.
1601
* This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
1603
* If the DISABLE_NOTIF configuration flag is set, uCode will not issue
1604
* STATISTICS_NOTIFICATIONs after received beacons (see below). This flag
1605
* does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
1607
#define IWL_STATS_CONF_CLEAR_STATS __constant_cpu_to_le32(0x1) /* see above */
1608
#define IWL_STATS_CONF_DISABLE_NOTIF __constant_cpu_to_le32(0x2)/* see above */
1609
struct iwl3945_statistics_cmd {
1610
__le32 configuration_flags; /* IWL_STATS_CONF_* */
1611
} __attribute__ ((packed));
1614
* STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
1616
* By default, uCode issues this notification after receiving a beacon
1617
* while associated. To disable this behavior, set DISABLE_NOTIF flag in the
1618
* REPLY_STATISTICS_CMD 0x9c, above.
1620
* Statistics counters continue to increment beacon after beacon, but are
1621
* cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
1622
* 0x9c with CLEAR_STATS bit set (see above).
1624
* uCode also issues this notification during scans. uCode clears statistics
1625
* appropriately so that each notification contains statistics for only the
1626
* one channel that has just been scanned.
1628
#define STATISTICS_REPLY_FLG_BAND_24G_MSK __constant_cpu_to_le32(0x2)
1629
#define STATISTICS_REPLY_FLG_FAT_MODE_MSK __constant_cpu_to_le32(0x8)
1630
struct iwl3945_notif_statistics {
1632
struct statistics_rx rx;
1633
struct statistics_tx tx;
1634
struct statistics_general general;
1635
} __attribute__ ((packed));
1639
* MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
1641
/* if ucode missed CONSECUTIVE_MISSED_BCONS_TH beacons in a row,
1642
* then this notification will be sent. */
1643
#define CONSECUTIVE_MISSED_BCONS_TH 20
1645
struct iwl3945_missed_beacon_notif {
1646
__le32 consequtive_missed_beacons;
1647
__le32 total_missed_becons;
1648
__le32 num_expected_beacons;
1649
__le32 num_recvd_beacons;
1650
} __attribute__ ((packed));
1652
/******************************************************************************
1654
* Rx Calibration Commands:
1656
*****************************************************************************/
1658
#define PHY_CALIBRATE_DIFF_GAIN_CMD (7)
1659
#define HD_TABLE_SIZE (11)
1661
struct iwl3945_sensitivity_cmd {
1663
__le16 table[HD_TABLE_SIZE];
1664
} __attribute__ ((packed));
1666
struct iwl3945_calibration_cmd {
1674
} __attribute__ ((packed));
1676
/******************************************************************************
1678
* Miscellaneous Commands:
1680
*****************************************************************************/
1683
* LEDs Command & Response
1684
* REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
1686
* For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
1687
* this command turns it on or off, or sets up a periodic blinking cycle.
1689
struct iwl3945_led_cmd {
1690
__le32 interval; /* "interval" in uSec */
1691
u8 id; /* 1: Activity, 2: Link, 3: Tech */
1692
u8 off; /* # intervals off while blinking;
1693
* "0", with >0 "on" value, turns LED on */
1694
u8 on; /* # intervals on while blinking;
1695
* "0", regardless of "off", turns LED off */
1697
} __attribute__ ((packed));
1699
/******************************************************************************
1701
* Union of all expected notifications/responses:
1703
*****************************************************************************/
1705
struct iwl3945_rx_packet {
1707
struct iwl3945_cmd_header hdr;
1709
struct iwl3945_alive_resp alive_frame;
1710
struct iwl3945_rx_frame rx_frame;
1711
struct iwl3945_tx_resp tx_resp;
1712
struct iwl3945_spectrum_notification spectrum_notif;
1713
struct iwl3945_csa_notification csa_notif;
1714
struct iwl3945_error_resp err_resp;
1715
struct iwl3945_card_state_notif card_state_notif;
1716
struct iwl3945_beacon_notif beacon_status;
1717
struct iwl3945_add_sta_resp add_sta;
1718
struct iwl3945_sleep_notification sleep_notif;
1719
struct iwl3945_spectrum_resp spectrum;
1720
struct iwl3945_notif_statistics stats;
1724
} __attribute__ ((packed));
1726
#define IWL_RX_FRAME_SIZE (4 + sizeof(struct iwl3945_rx_frame))
1728
#endif /* __iwl3945_3945_commands_h__ */
added
removed
updates/wireless/iwlwifi/iwlwifi/origin/iwl-3945-commands.h
