3386 lines · c
1/******************************************************************************2 *3 * This file is provided under a dual BSD/GPLv2 license. When using or4 * redistributing this file, you may do so under either license.5 *6 * GPL LICENSE SUMMARY7 *8 * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved.9 *10 * This program is free software; you can redistribute it and/or modify11 * it under the terms of version 2 of the GNU General Public License as12 * published by the Free Software Foundation.13 *14 * This program is distributed in the hope that it will be useful, but15 * WITHOUT ANY WARRANTY; without even the implied warranty of16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU17 * General Public License for more details.18 *19 * You should have received a copy of the GNU General Public License20 * along with this program; if not, write to the Free Software21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,22 * USA23 *24 * The full GNU General Public License is included in this distribution25 * 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-649730 *31 * BSD LICENSE32 *33 * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved.34 * All rights reserved.35 *36 * Redistribution and use in source and binary forms, with or without37 * modification, are permitted provided that the following conditions38 * are met:39 *40 * * Redistributions of source code must retain the above copyright41 * notice, this list of conditions and the following disclaimer.42 * * Redistributions in binary form must reproduce the above copyright43 * notice, this list of conditions and the following disclaimer in44 * the documentation and/or other materials provided with the45 * distribution.46 * * Neither the name Intel Corporation nor the names of its47 * contributors may be used to endorse or promote products derived48 * from this software without specific prior written permission.49 *50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT54 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,55 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT56 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,57 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY58 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT59 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.61 *62 *****************************************************************************/63 64#ifndef __il_commands_h__65#define __il_commands_h__66 67#include <linux/ieee80211.h>68 69struct il_priv;70 71/* uCode version contains 4 values: Major/Minor/API/Serial */72#define IL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)73#define IL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)74#define IL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)75#define IL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)76 77/* Tx rates */78#define IL_CCK_RATES 479#define IL_OFDM_RATES 880#define IL_MAX_RATES (IL_CCK_RATES + IL_OFDM_RATES)81 82enum {83 N_ALIVE = 0x1,84 N_ERROR = 0x2,85 86 /* RXON and QOS commands */87 C_RXON = 0x10,88 C_RXON_ASSOC = 0x11,89 C_QOS_PARAM = 0x13,90 C_RXON_TIMING = 0x14,91 92 /* Multi-Station support */93 C_ADD_STA = 0x18,94 C_REM_STA = 0x19,95 96 /* Security */97 C_WEPKEY = 0x20,98 99 /* RX, TX, LEDs */100 N_3945_RX = 0x1b, /* 3945 only */101 C_TX = 0x1c,102 C_RATE_SCALE = 0x47, /* 3945 only */103 C_LEDS = 0x48,104 C_TX_LINK_QUALITY_CMD = 0x4e, /* for 4965 */105 106 /* 802.11h related */107 C_CHANNEL_SWITCH = 0x72,108 N_CHANNEL_SWITCH = 0x73,109 C_SPECTRUM_MEASUREMENT = 0x74,110 N_SPECTRUM_MEASUREMENT = 0x75,111 112 /* Power Management */113 C_POWER_TBL = 0x77,114 N_PM_SLEEP = 0x7A,115 N_PM_DEBUG_STATS = 0x7B,116 117 /* Scan commands and notifications */118 C_SCAN = 0x80,119 C_SCAN_ABORT = 0x81,120 N_SCAN_START = 0x82,121 N_SCAN_RESULTS = 0x83,122 N_SCAN_COMPLETE = 0x84,123 124 /* IBSS/AP commands */125 N_BEACON = 0x90,126 C_TX_BEACON = 0x91,127 128 /* Miscellaneous commands */129 C_TX_PWR_TBL = 0x97,130 131 /* Bluetooth device coexistence config command */132 C_BT_CONFIG = 0x9b,133 134 /* Statistics */135 C_STATS = 0x9c,136 N_STATS = 0x9d,137 138 /* RF-KILL commands and notifications */139 N_CARD_STATE = 0xa1,140 141 /* Missed beacons notification */142 N_MISSED_BEACONS = 0xa2,143 144 C_CT_KILL_CONFIG = 0xa4,145 C_SENSITIVITY = 0xa8,146 C_PHY_CALIBRATION = 0xb0,147 N_RX_PHY = 0xc0,148 N_RX_MPDU = 0xc1,149 N_RX = 0xc3,150 N_COMPRESSED_BA = 0xc5,151 152 IL_CN_MAX = 0xff153};154 155/******************************************************************************156 * (0)157 * Commonly used structures and definitions:158 * Command header, rate_n_flags, txpower159 *160 *****************************************************************************/161 162/* il_cmd_header flags value */163#define IL_CMD_FAILED_MSK 0x40164 165#define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)166#define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)167#define SEQ_TO_IDX(s) ((s) & 0xff)168#define IDX_TO_SEQ(i) ((i) & 0xff)169#define SEQ_HUGE_FRAME cpu_to_le16(0x4000)170#define SEQ_RX_FRAME cpu_to_le16(0x8000)171 172/**173 * struct il_cmd_header174 *175 * This header format appears in the beginning of each command sent from the176 * driver, and each response/notification received from uCode.177 */178struct il_cmd_header {179 u8 cmd; /* Command ID: C_RXON, etc. */180 u8 flags; /* 0:5 reserved, 6 abort, 7 internal */181 /*182 * The driver sets up the sequence number to values of its choosing.183 * uCode does not use this value, but passes it back to the driver184 * when sending the response to each driver-originated command, so185 * the driver can match the response to the command. Since the values186 * don't get used by uCode, the driver may set up an arbitrary format.187 *188 * There is one exception: uCode sets bit 15 when it originates189 * the response/notification, i.e. when the response/notification190 * is not a direct response to a command sent by the driver. For191 * example, uCode issues N_3945_RX when it sends a received frame192 * to the driver; it is not a direct response to any driver command.193 *194 * The Linux driver uses the following format:195 *196 * 0:7 tfd idx - position within TX queue197 * 8:12 TX queue id198 * 13 reserved199 * 14 huge - driver sets this to indicate command is in the200 * 'huge' storage at the end of the command buffers201 * 15 unsolicited RX or uCode-originated notification202 */203 __le16 sequence;204} __packed;205 206/**207 * struct il3945_tx_power208 *209 * Used in C_TX_PWR_TBL, C_SCAN, C_CHANNEL_SWITCH210 *211 * Each entry contains two values:212 * 1) DSP gain (or sometimes called DSP attenuation). This is a fine-grained213 * linear value that multiplies the output of the digital signal processor,214 * before being sent to the analog radio.215 * 2) Radio gain. This sets the analog gain of the radio Tx path.216 * It is a coarser setting, and behaves in a logarithmic (dB) fashion.217 *218 * Driver obtains values from struct il3945_tx_power power_gain_table[][].219 */220struct il3945_tx_power {221 u8 tx_gain; /* gain for analog radio */222 u8 dsp_atten; /* gain for DSP */223} __packed;224 225/**226 * struct il3945_power_per_rate227 *228 * Used in C_TX_PWR_TBL, C_CHANNEL_SWITCH229 */230struct il3945_power_per_rate {231 u8 rate; /* plcp */232 struct il3945_tx_power tpc;233 u8 reserved;234} __packed;235 236/**237 * iwl4965 rate_n_flags bit fields238 *239 * rate_n_flags format is used in following iwl4965 commands:240 * N_RX (response only)241 * N_RX_MPDU (response only)242 * C_TX (both command and response)243 * C_TX_LINK_QUALITY_CMD244 *245 * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):246 * 2-0: 0) 6 Mbps247 * 1) 12 Mbps248 * 2) 18 Mbps249 * 3) 24 Mbps250 * 4) 36 Mbps251 * 5) 48 Mbps252 * 6) 54 Mbps253 * 7) 60 Mbps254 *255 * 4-3: 0) Single stream (SISO)256 * 1) Dual stream (MIMO)257 * 2) Triple stream (MIMO)258 *259 * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data260 *261 * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):262 * 3-0: 0xD) 6 Mbps263 * 0xF) 9 Mbps264 * 0x5) 12 Mbps265 * 0x7) 18 Mbps266 * 0x9) 24 Mbps267 * 0xB) 36 Mbps268 * 0x1) 48 Mbps269 * 0x3) 54 Mbps270 *271 * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):272 * 6-0: 10) 1 Mbps273 * 20) 2 Mbps274 * 55) 5.5 Mbps275 * 110) 11 Mbps276 */277#define RATE_MCS_CODE_MSK 0x7278#define RATE_MCS_SPATIAL_POS 3279#define RATE_MCS_SPATIAL_MSK 0x18280#define RATE_MCS_HT_DUP_POS 5281#define RATE_MCS_HT_DUP_MSK 0x20282 283/* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */284#define RATE_MCS_FLAGS_POS 8285#define RATE_MCS_HT_POS 8286#define RATE_MCS_HT_MSK 0x100287 288/* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */289#define RATE_MCS_CCK_POS 9290#define RATE_MCS_CCK_MSK 0x200291 292/* Bit 10: (1) Use Green Field preamble */293#define RATE_MCS_GF_POS 10294#define RATE_MCS_GF_MSK 0x400295 296/* Bit 11: (1) Use 40Mhz HT40 chnl width, (0) use 20 MHz legacy chnl width */297#define RATE_MCS_HT40_POS 11298#define RATE_MCS_HT40_MSK 0x800299 300/* Bit 12: (1) Duplicate data on both 20MHz chnls. HT40 (bit 11) must be set. */301#define RATE_MCS_DUP_POS 12302#define RATE_MCS_DUP_MSK 0x1000303 304/* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */305#define RATE_MCS_SGI_POS 13306#define RATE_MCS_SGI_MSK 0x2000307 308/**309 * rate_n_flags Tx antenna masks310 * 4965 has 2 transmitters311 * bit14:16312 */313#define RATE_MCS_ANT_POS 14314#define RATE_MCS_ANT_A_MSK 0x04000315#define RATE_MCS_ANT_B_MSK 0x08000316#define RATE_MCS_ANT_C_MSK 0x10000317#define RATE_MCS_ANT_AB_MSK (RATE_MCS_ANT_A_MSK | RATE_MCS_ANT_B_MSK)318#define RATE_MCS_ANT_ABC_MSK (RATE_MCS_ANT_AB_MSK | RATE_MCS_ANT_C_MSK)319#define RATE_ANT_NUM 3320 321#define POWER_TBL_NUM_ENTRIES 33322#define POWER_TBL_NUM_HT_OFDM_ENTRIES 32323#define POWER_TBL_CCK_ENTRY 32324 325#define IL_PWR_NUM_HT_OFDM_ENTRIES 24326#define IL_PWR_CCK_ENTRIES 2327 328/**329 * union il4965_tx_power_dual_stream330 *331 * Host format used for C_TX_PWR_TBL, C_CHANNEL_SWITCH332 * Use __le32 version (struct tx_power_dual_stream) when building command.333 *334 * Driver provides radio gain and DSP attenuation settings to device in pairs,335 * one value for each transmitter chain. The first value is for transmitter A,336 * second for transmitter B.337 *338 * For SISO bit rates, both values in a pair should be identical.339 * For MIMO rates, one value may be different from the other,340 * in order to balance the Tx output between the two transmitters.341 *342 * See more details in doc for TXPOWER in 4965.h.343 */344union il4965_tx_power_dual_stream {345 struct {346 u8 radio_tx_gain[2];347 u8 dsp_predis_atten[2];348 } s;349 u32 dw;350};351 352/**353 * struct tx_power_dual_stream354 *355 * Table entries in C_TX_PWR_TBL, C_CHANNEL_SWITCH356 *357 * Same format as il_tx_power_dual_stream, but __le32358 */359struct tx_power_dual_stream {360 __le32 dw;361} __packed;362 363/**364 * struct il4965_tx_power_db365 *366 * Entire table within C_TX_PWR_TBL, C_CHANNEL_SWITCH367 */368struct il4965_tx_power_db {369 struct tx_power_dual_stream power_tbl[POWER_TBL_NUM_ENTRIES];370} __packed;371 372/******************************************************************************373 * (0a)374 * Alive and Error Commands & Responses:375 *376 *****************************************************************************/377 378#define UCODE_VALID_OK cpu_to_le32(0x1)379#define INITIALIZE_SUBTYPE (9)380 381/*382 * ("Initialize") N_ALIVE = 0x1 (response only, not a command)383 *384 * uCode issues this "initialize alive" notification once the initialization385 * uCode image has completed its work, and is ready to load the runtime image.386 * This is the *first* "alive" notification that the driver will receive after387 * rebooting uCode; the "initialize" alive is indicated by subtype field == 9.388 *389 * See comments documenting "BSM" (bootstrap state machine).390 *391 * For 4965, this notification contains important calibration data for392 * calculating txpower settings:393 *394 * 1) Power supply voltage indication. The voltage sensor outputs higher395 * values for lower voltage, and vice verse.396 *397 * 2) Temperature measurement parameters, for each of two channel widths398 * (20 MHz and 40 MHz) supported by the radios. Temperature sensing399 * is done via one of the receiver chains, and channel width influences400 * the results.401 *402 * 3) Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation,403 * for each of 5 frequency ranges.404 */405struct il_init_alive_resp {406 u8 ucode_minor;407 u8 ucode_major;408 __le16 reserved1;409 u8 sw_rev[8];410 u8 ver_type;411 u8 ver_subtype; /* "9" for initialize alive */412 __le16 reserved2;413 __le32 log_event_table_ptr;414 __le32 error_event_table_ptr;415 __le32 timestamp;416 __le32 is_valid;417 418 /* calibration values from "initialize" uCode */419 __le32 voltage; /* signed, higher value is lower voltage */420 __le32 therm_r1[2]; /* signed, 1st for normal, 2nd for HT40 */421 __le32 therm_r2[2]; /* signed */422 __le32 therm_r3[2]; /* signed */423 __le32 therm_r4[2]; /* signed */424 __le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups,425 * 2 Tx chains */426} __packed;427 428/**429 * N_ALIVE = 0x1 (response only, not a command)430 *431 * uCode issues this "alive" notification once the runtime image is ready432 * to receive commands from the driver. This is the *second* "alive"433 * notification that the driver will receive after rebooting uCode;434 * this "alive" is indicated by subtype field != 9.435 *436 * See comments documenting "BSM" (bootstrap state machine).437 *438 * This response includes two pointers to structures within the device's439 * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:440 *441 * 1) log_event_table_ptr indicates base of the event log. This traces442 * a 256-entry history of uCode execution within a circular buffer.443 * Its header format is:444 *445 * __le32 log_size; log capacity (in number of entries)446 * __le32 type; (1) timestamp with each entry, (0) no timestamp447 * __le32 wraps; # times uCode has wrapped to top of circular buffer448 * __le32 write_idx; next circular buffer entry that uCode would fill449 *450 * The header is followed by the circular buffer of log entries. Entries451 * with timestamps have the following format:452 *453 * __le32 event_id; range 0 - 1500454 * __le32 timestamp; low 32 bits of TSF (of network, if associated)455 * __le32 data; event_id-specific data value456 *457 * Entries without timestamps contain only event_id and data.458 *459 *460 * 2) error_event_table_ptr indicates base of the error log. This contains461 * information about any uCode error that occurs. For 4965, the format462 * of the error log is:463 *464 * __le32 valid; (nonzero) valid, (0) log is empty465 * __le32 error_id; type of error466 * __le32 pc; program counter467 * __le32 blink1; branch link468 * __le32 blink2; branch link469 * __le32 ilink1; interrupt link470 * __le32 ilink2; interrupt link471 * __le32 data1; error-specific data472 * __le32 data2; error-specific data473 * __le32 line; source code line of error474 * __le32 bcon_time; beacon timer475 * __le32 tsf_low; network timestamp function timer476 * __le32 tsf_hi; network timestamp function timer477 * __le32 gp1; GP1 timer register478 * __le32 gp2; GP2 timer register479 * __le32 gp3; GP3 timer register480 * __le32 ucode_ver; uCode version481 * __le32 hw_ver; HW Silicon version482 * __le32 brd_ver; HW board version483 * __le32 log_pc; log program counter484 * __le32 frame_ptr; frame pointer485 * __le32 stack_ptr; stack pointer486 * __le32 hcmd; last host command487 * __le32 isr0; isr status register LMPM_NIC_ISR0: rxtx_flag488 * __le32 isr1; isr status register LMPM_NIC_ISR1: host_flag489 * __le32 isr2; isr status register LMPM_NIC_ISR2: enc_flag490 * __le32 isr3; isr status register LMPM_NIC_ISR3: time_flag491 * __le32 isr4; isr status register LMPM_NIC_ISR4: wico interrupt492 * __le32 isr_pref; isr status register LMPM_NIC_PREF_STAT493 * __le32 wait_event; wait event() caller address494 * __le32 l2p_control; L2pControlField495 * __le32 l2p_duration; L2pDurationField496 * __le32 l2p_mhvalid; L2pMhValidBits497 * __le32 l2p_addr_match; L2pAddrMatchStat498 * __le32 lmpm_pmg_sel; indicate which clocks are turned on (LMPM_PMG_SEL)499 * __le32 u_timestamp; indicate when the date and time of the compilation500 * __le32 reserved;501 *502 * The Linux driver can print both logs to the system log when a uCode error503 * occurs.504 */505struct il_alive_resp {506 u8 ucode_minor;507 u8 ucode_major;508 __le16 reserved1;509 u8 sw_rev[8];510 u8 ver_type;511 u8 ver_subtype; /* not "9" for runtime alive */512 __le16 reserved2;513 __le32 log_event_table_ptr; /* SRAM address for event log */514 __le32 error_event_table_ptr; /* SRAM address for error log */515 __le32 timestamp;516 __le32 is_valid;517} __packed;518 519/*520 * N_ERROR = 0x2 (response only, not a command)521 */522struct il_error_resp {523 __le32 error_type;524 u8 cmd_id;525 u8 reserved1;526 __le16 bad_cmd_seq_num;527 __le32 error_info;528 __le64 timestamp;529} __packed;530 531/******************************************************************************532 * (1)533 * RXON Commands & Responses:534 *535 *****************************************************************************/536 537/*538 * Rx config defines & structure539 */540/* rx_config device types */541enum {542 RXON_DEV_TYPE_AP = 1,543 RXON_DEV_TYPE_ESS = 3,544 RXON_DEV_TYPE_IBSS = 4,545 RXON_DEV_TYPE_SNIFFER = 6,546};547 548#define RXON_RX_CHAIN_DRIVER_FORCE_MSK cpu_to_le16(0x1 << 0)549#define RXON_RX_CHAIN_DRIVER_FORCE_POS (0)550#define RXON_RX_CHAIN_VALID_MSK cpu_to_le16(0x7 << 1)551#define RXON_RX_CHAIN_VALID_POS (1)552#define RXON_RX_CHAIN_FORCE_SEL_MSK cpu_to_le16(0x7 << 4)553#define RXON_RX_CHAIN_FORCE_SEL_POS (4)554#define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK cpu_to_le16(0x7 << 7)555#define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7)556#define RXON_RX_CHAIN_CNT_MSK cpu_to_le16(0x3 << 10)557#define RXON_RX_CHAIN_CNT_POS (10)558#define RXON_RX_CHAIN_MIMO_CNT_MSK cpu_to_le16(0x3 << 12)559#define RXON_RX_CHAIN_MIMO_CNT_POS (12)560#define RXON_RX_CHAIN_MIMO_FORCE_MSK cpu_to_le16(0x1 << 14)561#define RXON_RX_CHAIN_MIMO_FORCE_POS (14)562 563/* rx_config flags */564/* band & modulation selection */565#define RXON_FLG_BAND_24G_MSK cpu_to_le32(1 << 0)566#define RXON_FLG_CCK_MSK cpu_to_le32(1 << 1)567/* auto detection enable */568#define RXON_FLG_AUTO_DETECT_MSK cpu_to_le32(1 << 2)569/* TGg protection when tx */570#define RXON_FLG_TGG_PROTECT_MSK cpu_to_le32(1 << 3)571/* cck short slot & preamble */572#define RXON_FLG_SHORT_SLOT_MSK cpu_to_le32(1 << 4)573#define RXON_FLG_SHORT_PREAMBLE_MSK cpu_to_le32(1 << 5)574/* antenna selection */575#define RXON_FLG_DIS_DIV_MSK cpu_to_le32(1 << 7)576#define RXON_FLG_ANT_SEL_MSK cpu_to_le32(0x0f00)577#define RXON_FLG_ANT_A_MSK cpu_to_le32(1 << 8)578#define RXON_FLG_ANT_B_MSK cpu_to_le32(1 << 9)579/* radar detection enable */580#define RXON_FLG_RADAR_DETECT_MSK cpu_to_le32(1 << 12)581#define RXON_FLG_TGJ_NARROW_BAND_MSK cpu_to_le32(1 << 13)582/* rx response to host with 8-byte TSF583* (according to ON_AIR deassertion) */584#define RXON_FLG_TSF2HOST_MSK cpu_to_le32(1 << 15)585 586/* HT flags */587#define RXON_FLG_CTRL_CHANNEL_LOC_POS (22)588#define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK cpu_to_le32(0x1 << 22)589 590#define RXON_FLG_HT_OPERATING_MODE_POS (23)591 592#define RXON_FLG_HT_PROT_MSK cpu_to_le32(0x1 << 23)593#define RXON_FLG_HT40_PROT_MSK cpu_to_le32(0x2 << 23)594 595#define RXON_FLG_CHANNEL_MODE_POS (25)596#define RXON_FLG_CHANNEL_MODE_MSK cpu_to_le32(0x3 << 25)597 598/* channel mode */599enum {600 CHANNEL_MODE_LEGACY = 0,601 CHANNEL_MODE_PURE_40 = 1,602 CHANNEL_MODE_MIXED = 2,603 CHANNEL_MODE_RESERVED = 3,604};605#define RXON_FLG_CHANNEL_MODE_LEGACY \606 cpu_to_le32(CHANNEL_MODE_LEGACY << RXON_FLG_CHANNEL_MODE_POS)607#define RXON_FLG_CHANNEL_MODE_PURE_40 \608 cpu_to_le32(CHANNEL_MODE_PURE_40 << RXON_FLG_CHANNEL_MODE_POS)609#define RXON_FLG_CHANNEL_MODE_MIXED \610 cpu_to_le32(CHANNEL_MODE_MIXED << RXON_FLG_CHANNEL_MODE_POS)611 612/* CTS to self (if spec allows) flag */613#define RXON_FLG_SELF_CTS_EN cpu_to_le32(0x1<<30)614 615/* rx_config filter flags */616/* accept all data frames */617#define RXON_FILTER_PROMISC_MSK cpu_to_le32(1 << 0)618/* pass control & management to host */619#define RXON_FILTER_CTL2HOST_MSK cpu_to_le32(1 << 1)620/* accept multi-cast */621#define RXON_FILTER_ACCEPT_GRP_MSK cpu_to_le32(1 << 2)622/* don't decrypt uni-cast frames */623#define RXON_FILTER_DIS_DECRYPT_MSK cpu_to_le32(1 << 3)624/* don't decrypt multi-cast frames */625#define RXON_FILTER_DIS_GRP_DECRYPT_MSK cpu_to_le32(1 << 4)626/* STA is associated */627#define RXON_FILTER_ASSOC_MSK cpu_to_le32(1 << 5)628/* transfer to host non bssid beacons in associated state */629#define RXON_FILTER_BCON_AWARE_MSK cpu_to_le32(1 << 6)630 631/**632 * C_RXON = 0x10 (command, has simple generic response)633 *634 * RXON tunes the radio tuner to a service channel, and sets up a number635 * of parameters that are used primarily for Rx, but also for Tx operations.636 *637 * NOTE: When tuning to a new channel, driver must set the638 * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent639 * info within the device, including the station tables, tx retry640 * rate tables, and txpower tables. Driver must build a new station641 * table and txpower table before transmitting anything on the RXON642 * channel.643 *644 * NOTE: All RXONs wipe clean the internal txpower table. Driver must645 * issue a new C_TX_PWR_TBL after each C_RXON (0x10),646 * regardless of whether RXON_FILTER_ASSOC_MSK is set.647 */648 649struct il3945_rxon_cmd {650 u8 node_addr[6];651 __le16 reserved1;652 u8 bssid_addr[6];653 __le16 reserved2;654 u8 wlap_bssid_addr[6];655 __le16 reserved3;656 u8 dev_type;657 u8 air_propagation;658 __le16 reserved4;659 u8 ofdm_basic_rates;660 u8 cck_basic_rates;661 __le16 assoc_id;662 __le32 flags;663 __le32 filter_flags;664 __le16 channel;665 __le16 reserved5;666} __packed;667 668struct il4965_rxon_cmd {669 u8 node_addr[6];670 __le16 reserved1;671 u8 bssid_addr[6];672 __le16 reserved2;673 u8 wlap_bssid_addr[6];674 __le16 reserved3;675 u8 dev_type;676 u8 air_propagation;677 __le16 rx_chain;678 u8 ofdm_basic_rates;679 u8 cck_basic_rates;680 __le16 assoc_id;681 __le32 flags;682 __le32 filter_flags;683 __le16 channel;684 u8 ofdm_ht_single_stream_basic_rates;685 u8 ofdm_ht_dual_stream_basic_rates;686} __packed;687 688/* Create a common rxon cmd which will be typecast into the 3945 or 4965689 * specific rxon cmd, depending on where it is called from.690 */691struct il_rxon_cmd {692 u8 node_addr[6];693 __le16 reserved1;694 u8 bssid_addr[6];695 __le16 reserved2;696 u8 wlap_bssid_addr[6];697 __le16 reserved3;698 u8 dev_type;699 u8 air_propagation;700 __le16 rx_chain;701 u8 ofdm_basic_rates;702 u8 cck_basic_rates;703 __le16 assoc_id;704 __le32 flags;705 __le32 filter_flags;706 __le16 channel;707 u8 ofdm_ht_single_stream_basic_rates;708 u8 ofdm_ht_dual_stream_basic_rates;709 u8 reserved4;710 u8 reserved5;711} __packed;712 713/*714 * C_RXON_ASSOC = 0x11 (command, has simple generic response)715 */716struct il3945_rxon_assoc_cmd {717 __le32 flags;718 __le32 filter_flags;719 u8 ofdm_basic_rates;720 u8 cck_basic_rates;721 __le16 reserved;722} __packed;723 724struct il4965_rxon_assoc_cmd {725 __le32 flags;726 __le32 filter_flags;727 u8 ofdm_basic_rates;728 u8 cck_basic_rates;729 u8 ofdm_ht_single_stream_basic_rates;730 u8 ofdm_ht_dual_stream_basic_rates;731 __le16 rx_chain_select_flags;732 __le16 reserved;733} __packed;734 735#define IL_CONN_MAX_LISTEN_INTERVAL 10736#define IL_MAX_UCODE_BEACON_INTERVAL 4 /* 4096 */737#define IL39_MAX_UCODE_BEACON_INTERVAL 1 /* 1024 */738 739/*740 * C_RXON_TIMING = 0x14 (command, has simple generic response)741 */742struct il_rxon_time_cmd {743 __le64 timestamp;744 __le16 beacon_interval;745 __le16 atim_win;746 __le32 beacon_init_val;747 __le16 listen_interval;748 u8 dtim_period;749 u8 delta_cp_bss_tbtts;750} __packed;751 752/*753 * C_CHANNEL_SWITCH = 0x72 (command, has simple generic response)754 */755struct il3945_channel_switch_cmd {756 u8 band;757 u8 expect_beacon;758 __le16 channel;759 __le32 rxon_flags;760 __le32 rxon_filter_flags;761 __le32 switch_time;762 struct il3945_power_per_rate power[IL_MAX_RATES];763} __packed;764 765struct il4965_channel_switch_cmd {766 u8 band;767 u8 expect_beacon;768 __le16 channel;769 __le32 rxon_flags;770 __le32 rxon_filter_flags;771 __le32 switch_time;772 struct il4965_tx_power_db tx_power;773} __packed;774 775/*776 * N_CHANNEL_SWITCH = 0x73 (notification only, not a command)777 */778struct il_csa_notification {779 __le16 band;780 __le16 channel;781 __le32 status; /* 0 - OK, 1 - fail */782} __packed;783 784/******************************************************************************785 * (2)786 * Quality-of-Service (QOS) Commands & Responses:787 *788 *****************************************************************************/789 790/**791 * struct il_ac_qos -- QOS timing params for C_QOS_PARAM792 * One for each of 4 EDCA access categories in struct il_qosparam_cmd793 *794 * @cw_min: Contention win, start value in numbers of slots.795 * Should be a power-of-2, minus 1. Device's default is 0x0f.796 * @cw_max: Contention win, max value in numbers of slots.797 * Should be a power-of-2, minus 1. Device's default is 0x3f.798 * @aifsn: Number of slots in Arbitration Interframe Space (before799 * performing random backoff timing prior to Tx). Device default 1.800 * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.801 *802 * Device will automatically increase contention win by (2*CW) + 1 for each803 * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW804 * value, to cap the CW value.805 */806struct il_ac_qos {807 __le16 cw_min;808 __le16 cw_max;809 u8 aifsn;810 u8 reserved1;811 __le16 edca_txop;812} __packed;813 814/* QoS flags defines */815#define QOS_PARAM_FLG_UPDATE_EDCA_MSK cpu_to_le32(0x01)816#define QOS_PARAM_FLG_TGN_MSK cpu_to_le32(0x02)817#define QOS_PARAM_FLG_TXOP_TYPE_MSK cpu_to_le32(0x10)818 819/* Number of Access Categories (AC) (EDCA), queues 0..3 */820#define AC_NUM 4821 822/*823 * C_QOS_PARAM = 0x13 (command, has simple generic response)824 *825 * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs826 * 0: Background, 1: Best Effort, 2: Video, 3: Voice.827 */828struct il_qosparam_cmd {829 __le32 qos_flags;830 struct il_ac_qos ac[AC_NUM];831} __packed;832 833/******************************************************************************834 * (3)835 * Add/Modify Stations Commands & Responses:836 *837 *****************************************************************************/838/*839 * Multi station support840 */841 842/* Special, dedicated locations within device's station table */843#define IL_AP_ID 0844#define IL_STA_ID 2845#define IL3945_BROADCAST_ID 24846#define IL3945_STATION_COUNT 25847#define IL4965_BROADCAST_ID 31848#define IL4965_STATION_COUNT 32849 850#define IL_STATION_COUNT 32 /* MAX(3945,4965) */851#define IL_INVALID_STATION 255852 853#define STA_FLG_TX_RATE_MSK cpu_to_le32(1 << 2)854#define STA_FLG_PWR_SAVE_MSK cpu_to_le32(1 << 8)855#define STA_FLG_RTS_MIMO_PROT_MSK cpu_to_le32(1 << 17)856#define STA_FLG_AGG_MPDU_8US_MSK cpu_to_le32(1 << 18)857#define STA_FLG_MAX_AGG_SIZE_POS (19)858#define STA_FLG_MAX_AGG_SIZE_MSK cpu_to_le32(3 << 19)859#define STA_FLG_HT40_EN_MSK cpu_to_le32(1 << 21)860#define STA_FLG_MIMO_DIS_MSK cpu_to_le32(1 << 22)861#define STA_FLG_AGG_MPDU_DENSITY_POS (23)862#define STA_FLG_AGG_MPDU_DENSITY_MSK cpu_to_le32(7 << 23)863 864/* Use in mode field. 1: modify existing entry, 0: add new station entry */865#define STA_CONTROL_MODIFY_MSK 0x01866 867/* key flags __le16*/868#define STA_KEY_FLG_ENCRYPT_MSK cpu_to_le16(0x0007)869#define STA_KEY_FLG_NO_ENC cpu_to_le16(0x0000)870#define STA_KEY_FLG_WEP cpu_to_le16(0x0001)871#define STA_KEY_FLG_CCMP cpu_to_le16(0x0002)872#define STA_KEY_FLG_TKIP cpu_to_le16(0x0003)873 874#define STA_KEY_FLG_KEYID_POS 8875#define STA_KEY_FLG_INVALID cpu_to_le16(0x0800)876/* wep key is either from global key (0) or from station info array (1) */877#define STA_KEY_FLG_MAP_KEY_MSK cpu_to_le16(0x0008)878 879/* wep key in STA: 5-bytes (0) or 13-bytes (1) */880#define STA_KEY_FLG_KEY_SIZE_MSK cpu_to_le16(0x1000)881#define STA_KEY_MULTICAST_MSK cpu_to_le16(0x4000)882#define STA_KEY_MAX_NUM 8883 884/* Flags indicate whether to modify vs. don't change various station params */885#define STA_MODIFY_KEY_MASK 0x01886#define STA_MODIFY_TID_DISABLE_TX 0x02887#define STA_MODIFY_TX_RATE_MSK 0x04888#define STA_MODIFY_ADDBA_TID_MSK 0x08889#define STA_MODIFY_DELBA_TID_MSK 0x10890#define STA_MODIFY_SLEEP_TX_COUNT_MSK 0x20891 892/* Receiver address (actually, Rx station's idx into station table),893 * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */894#define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid))895 896struct il4965_keyinfo {897 __le16 key_flags;898 u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */899 u8 reserved1;900 __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */901 u8 key_offset;902 u8 reserved2;903 u8 key[16]; /* 16-byte unicast decryption key */904} __packed;905 906/**907 * struct sta_id_modify908 * @addr[ETH_ALEN]: station's MAC address909 * @sta_id: idx of station in uCode's station table910 * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change911 *912 * Driver selects unused table idx when adding new station,913 * or the idx to a pre-existing station entry when modifying that station.914 * Some idxes have special purposes (IL_AP_ID, idx 0, is for AP).915 *916 * modify_mask flags select which parameters to modify vs. leave alone.917 */918struct sta_id_modify {919 u8 addr[ETH_ALEN];920 __le16 reserved1;921 u8 sta_id;922 u8 modify_mask;923 __le16 reserved2;924} __packed;925 926/*927 * C_ADD_STA = 0x18 (command)928 *929 * The device contains an internal table of per-station information,930 * with info on security keys, aggregation parameters, and Tx rates for931 * initial Tx attempt and any retries (4965 devices uses932 * C_TX_LINK_QUALITY_CMD,933 * 3945 uses C_RATE_SCALE to set up rate tables).934 *935 * C_ADD_STA sets up the table entry for one station, either creating936 * a new entry, or modifying a pre-existing one.937 *938 * NOTE: RXON command (without "associated" bit set) wipes the station table939 * clean. Moving into RF_KILL state does this also. Driver must set up940 * new station table before transmitting anything on the RXON channel941 * (except active scans or active measurements; those commands carry942 * their own txpower/rate setup data).943 *944 * When getting started on a new channel, driver must set up the945 * IL_BROADCAST_ID entry (last entry in the table). For a client946 * station in a BSS, once an AP is selected, driver sets up the AP STA947 * in the IL_AP_ID entry (1st entry in the table). BROADCAST and AP948 * are all that are needed for a BSS client station. If the device is949 * used as AP, or in an IBSS network, driver must set up station table950 * entries for all STAs in network, starting with idx IL_STA_ID.951 */952 953struct il3945_addsta_cmd {954 u8 mode; /* 1: modify existing, 0: add new station */955 u8 reserved[3];956 struct sta_id_modify sta;957 struct il4965_keyinfo key;958 __le32 station_flags; /* STA_FLG_* */959 __le32 station_flags_msk; /* STA_FLG_* */960 961 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)962 * corresponding to bit (e.g. bit 5 controls TID 5).963 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */964 __le16 tid_disable_tx;965 966 __le16 rate_n_flags;967 968 /* TID for which to add block-ack support.969 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */970 u8 add_immediate_ba_tid;971 972 /* TID for which to remove block-ack support.973 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */974 u8 remove_immediate_ba_tid;975 976 /* Starting Sequence Number for added block-ack support.977 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */978 __le16 add_immediate_ba_ssn;979} __packed;980 981struct il4965_addsta_cmd {982 u8 mode; /* 1: modify existing, 0: add new station */983 u8 reserved[3];984 struct sta_id_modify sta;985 struct il4965_keyinfo key;986 __le32 station_flags; /* STA_FLG_* */987 __le32 station_flags_msk; /* STA_FLG_* */988 989 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)990 * corresponding to bit (e.g. bit 5 controls TID 5).991 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */992 __le16 tid_disable_tx;993 994 __le16 reserved1;995 996 /* TID for which to add block-ack support.997 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */998 u8 add_immediate_ba_tid;999 1000 /* TID for which to remove block-ack support.1001 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */1002 u8 remove_immediate_ba_tid;1003 1004 /* Starting Sequence Number for added block-ack support.1005 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */1006 __le16 add_immediate_ba_ssn;1007 1008 /*1009 * Number of packets OK to transmit to station even though1010 * it is asleep -- used to synchronise PS-poll and u-APSD1011 * responses while ucode keeps track of STA sleep state.1012 */1013 __le16 sleep_tx_count;1014 1015 __le16 reserved2;1016} __packed;1017 1018/* Wrapper struct for 3945 and 4965 addsta_cmd structures */1019struct il_addsta_cmd {1020 u8 mode; /* 1: modify existing, 0: add new station */1021 u8 reserved[3];1022 struct sta_id_modify sta;1023 struct il4965_keyinfo key;1024 __le32 station_flags; /* STA_FLG_* */1025 __le32 station_flags_msk; /* STA_FLG_* */1026 1027 /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)1028 * corresponding to bit (e.g. bit 5 controls TID 5).1029 * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */1030 __le16 tid_disable_tx;1031 1032 __le16 rate_n_flags; /* 3945 only */1033 1034 /* TID for which to add block-ack support.1035 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */1036 u8 add_immediate_ba_tid;1037 1038 /* TID for which to remove block-ack support.1039 * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */1040 u8 remove_immediate_ba_tid;1041 1042 /* Starting Sequence Number for added block-ack support.1043 * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */1044 __le16 add_immediate_ba_ssn;1045 1046 /*1047 * Number of packets OK to transmit to station even though1048 * it is asleep -- used to synchronise PS-poll and u-APSD1049 * responses while ucode keeps track of STA sleep state.1050 */1051 __le16 sleep_tx_count;1052 1053 __le16 reserved2;1054} __packed;1055 1056#define ADD_STA_SUCCESS_MSK 0x11057#define ADD_STA_NO_ROOM_IN_TBL 0x21058#define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x41059#define ADD_STA_MODIFY_NON_EXIST_STA 0x81060/*1061 * C_ADD_STA = 0x18 (response)1062 */1063struct il_add_sta_resp {1064 u8 status; /* ADD_STA_* */1065} __packed;1066 1067#define REM_STA_SUCCESS_MSK 0x11068/*1069 * C_REM_STA = 0x19 (response)1070 */1071struct il_rem_sta_resp {1072 u8 status;1073} __packed;1074 1075/*1076 * C_REM_STA = 0x19 (command)1077 */1078struct il_rem_sta_cmd {1079 u8 num_sta; /* number of removed stations */1080 u8 reserved[3];1081 u8 addr[ETH_ALEN]; /* MAC addr of the first station */1082 u8 reserved2[2];1083} __packed;1084 1085#define IL_TX_FIFO_BK_MSK cpu_to_le32(BIT(0))1086#define IL_TX_FIFO_BE_MSK cpu_to_le32(BIT(1))1087#define IL_TX_FIFO_VI_MSK cpu_to_le32(BIT(2))1088#define IL_TX_FIFO_VO_MSK cpu_to_le32(BIT(3))1089#define IL_AGG_TX_QUEUE_MSK cpu_to_le32(0xffc00)1090 1091#define IL_DROP_SINGLE 01092#define IL_DROP_SELECTED 11093#define IL_DROP_ALL 21094 1095/*1096 * REPLY_WEP_KEY = 0x201097 */1098struct il_wep_key {1099 u8 key_idx;1100 u8 key_offset;1101 u8 reserved1[2];1102 u8 key_size;1103 u8 reserved2[3];1104 u8 key[16];1105} __packed;1106 1107struct il_wep_cmd {1108 u8 num_keys;1109 u8 global_key_type;1110 u8 flags;1111 u8 reserved;1112 struct il_wep_key key[];1113} __packed;1114 1115#define WEP_KEY_WEP_TYPE 11116#define WEP_KEYS_MAX 41117#define WEP_INVALID_OFFSET 0xff1118#define WEP_KEY_LEN_64 51119#define WEP_KEY_LEN_128 131120 1121/******************************************************************************1122 * (4)1123 * Rx Responses:1124 *1125 *****************************************************************************/1126 1127#define RX_RES_STATUS_NO_CRC32_ERROR cpu_to_le32(1 << 0)1128#define RX_RES_STATUS_NO_RXE_OVERFLOW cpu_to_le32(1 << 1)1129 1130#define RX_RES_PHY_FLAGS_BAND_24_MSK cpu_to_le16(1 << 0)1131#define RX_RES_PHY_FLAGS_MOD_CCK_MSK cpu_to_le16(1 << 1)1132#define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK cpu_to_le16(1 << 2)1133#define RX_RES_PHY_FLAGS_NARROW_BAND_MSK cpu_to_le16(1 << 3)1134#define RX_RES_PHY_FLAGS_ANTENNA_MSK 0x701135#define RX_RES_PHY_FLAGS_ANTENNA_POS 41136#define RX_RES_PHY_FLAGS_AGG_MSK cpu_to_le16(1 << 7)1137 1138#define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)1139#define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)1140#define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)1141#define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)1142#define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)1143#define RX_RES_STATUS_SEC_TYPE_ERR (0x7 << 8)1144 1145#define RX_RES_STATUS_STATION_FOUND (1<<6)1146#define RX_RES_STATUS_NO_STATION_INFO_MISMATCH (1<<7)1147 1148#define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)1149#define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)1150#define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)1151#define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)1152#define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)1153 1154#define RX_MPDU_RES_STATUS_ICV_OK (0x20)1155#define RX_MPDU_RES_STATUS_MIC_OK (0x40)1156#define RX_MPDU_RES_STATUS_TTAK_OK (1 << 7)1157#define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800)1158 1159struct il3945_rx_frame_stats {1160 /* New members MUST be added within the __struct_group() macro below. */1161 __struct_group(il3945_rx_frame_stats_hdr, hdr, __packed,1162 u8 phy_count;1163 u8 id;1164 u8 rssi;1165 u8 agc;1166 __le16 sig_avg;1167 __le16 noise_diff;1168 );1169 u8 payload[];1170} __packed;1171static_assert(offsetof(struct il3945_rx_frame_stats, payload) == sizeof(struct il3945_rx_frame_stats_hdr),1172 "struct member likely outside of __struct_group()");1173 1174struct il3945_rx_frame_hdr {1175 /* New members MUST be added within the __struct_group() macro below. */1176 __struct_group(il3945_rx_frame_hdr_hdr, hdr, __packed,1177 __le16 channel;1178 __le16 phy_flags;1179 u8 reserved1;1180 u8 rate;1181 __le16 len;1182 );1183 u8 payload[];1184} __packed;1185static_assert(offsetof(struct il3945_rx_frame_hdr, payload) == sizeof(struct il3945_rx_frame_hdr_hdr),1186 "struct member likely outside of __struct_group()");1187 1188struct il3945_rx_frame_end {1189 __le32 status;1190 __le64 timestamp;1191 __le32 beacon_timestamp;1192} __packed;1193 1194/*1195 * N_3945_RX = 0x1b (response only, not a command)1196 *1197 * NOTE: DO NOT dereference from casts to this structure1198 * It is provided only for calculating minimum data set size.1199 * The actual offsets of the hdr and end are dynamic based on1200 * stats.phy_count1201 */1202struct il3945_rx_frame {1203 struct il3945_rx_frame_stats_hdr stats;1204 struct il3945_rx_frame_hdr_hdr hdr;1205 struct il3945_rx_frame_end end;1206} __packed;1207 1208#define IL39_RX_FRAME_SIZE (4 + sizeof(struct il3945_rx_frame))1209 1210/* Fixed (non-configurable) rx data from phy */1211 1212#define IL49_RX_RES_PHY_CNT 141213#define IL49_RX_PHY_FLAGS_ANTENNAE_OFFSET (4)1214#define IL49_RX_PHY_FLAGS_ANTENNAE_MASK (0x70)1215#define IL49_AGC_DB_MASK (0x3f80) /* MASK(7,13) */1216#define IL49_AGC_DB_POS (7)1217struct il4965_rx_non_cfg_phy {1218 __le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */1219 __le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */1220 u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */1221 u8 pad[];1222} __packed;1223 1224/*1225 * N_RX = 0xc3 (response only, not a command)1226 * Used only for legacy (non 11n) frames.1227 */1228struct il_rx_phy_res {1229 u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */1230 u8 cfg_phy_cnt; /* configurable DSP phy data byte count */1231 u8 stat_id; /* configurable DSP phy data set ID */1232 u8 reserved1;1233 __le64 timestamp; /* TSF at on air rise */1234 __le32 beacon_time_stamp; /* beacon at on-air rise */1235 __le16 phy_flags; /* general phy flags: band, modulation, ... */1236 __le16 channel; /* channel number */1237 u8 non_cfg_phy_buf[32]; /* for various implementations of non_cfg_phy */1238 __le32 rate_n_flags; /* RATE_MCS_* */1239 __le16 byte_count; /* frame's byte-count */1240 __le16 frame_time; /* frame's time on the air */1241} __packed;1242 1243struct il_rx_mpdu_res_start {1244 __le16 byte_count;1245 __le16 reserved;1246} __packed;1247 1248/******************************************************************************1249 * (5)1250 * Tx Commands & Responses:1251 *1252 * Driver must place each C_TX command into one of the prioritized Tx1253 * queues in host DRAM, shared between driver and device (see comments for1254 * SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode1255 * are preparing to transmit, the device pulls the Tx command over the PCI1256 * bus via one of the device's Tx DMA channels, to fill an internal FIFO1257 * from which data will be transmitted.1258 *1259 * uCode handles all timing and protocol related to control frames1260 * (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler1261 * handle reception of block-acks; uCode updates the host driver via1262 * N_COMPRESSED_BA.1263 *1264 * uCode handles retrying Tx when an ACK is expected but not received.1265 * This includes trying lower data rates than the one requested in the Tx1266 * command, as set up by the C_RATE_SCALE (for 3945) or1267 * C_TX_LINK_QUALITY_CMD (4965).1268 *1269 * Driver sets up transmit power for various rates via C_TX_PWR_TBL.1270 * This command must be executed after every RXON command, before Tx can occur.1271 *****************************************************************************/1272 1273/* C_TX Tx flags field */1274 1275/*1276 * 1: Use Request-To-Send protocol before this frame.1277 * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK.1278 */1279#define TX_CMD_FLG_RTS_MSK cpu_to_le32(1 << 1)1280 1281/*1282 * 1: Transmit Clear-To-Send to self before this frame.1283 * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.1284 * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK.1285 */1286#define TX_CMD_FLG_CTS_MSK cpu_to_le32(1 << 2)1287 1288/* 1: Expect ACK from receiving station1289 * 0: Don't expect ACK (MAC header's duration field s/b 0)1290 * Set this for unicast frames, but not broadcast/multicast. */1291#define TX_CMD_FLG_ACK_MSK cpu_to_le32(1 << 3)1292 1293/* For 4965 devices:1294 * 1: Use rate scale table (see C_TX_LINK_QUALITY_CMD).1295 * Tx command's initial_rate_idx indicates first rate to try;1296 * uCode walks through table for additional Tx attempts.1297 * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.1298 * This rate will be used for all Tx attempts; it will not be scaled. */1299#define TX_CMD_FLG_STA_RATE_MSK cpu_to_le32(1 << 4)1300 1301/* 1: Expect immediate block-ack.1302 * Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */1303#define TX_CMD_FLG_IMM_BA_RSP_MASK cpu_to_le32(1 << 6)1304 1305/*1306 * 1: Frame requires full Tx-Op protection.1307 * Set this if either RTS or CTS Tx Flag gets set.1308 */1309#define TX_CMD_FLG_FULL_TXOP_PROT_MSK cpu_to_le32(1 << 7)1310 1311/* Tx antenna selection field; used only for 3945, reserved (0) for 4965 devices.1312 * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */1313#define TX_CMD_FLG_ANT_SEL_MSK cpu_to_le32(0xf00)1314#define TX_CMD_FLG_ANT_A_MSK cpu_to_le32(1 << 8)1315#define TX_CMD_FLG_ANT_B_MSK cpu_to_le32(1 << 9)1316 1317/* 1: uCode overrides sequence control field in MAC header.1318 * 0: Driver provides sequence control field in MAC header.1319 * Set this for management frames, non-QOS data frames, non-unicast frames,1320 * and also in Tx command embedded in C_SCAN for active scans. */1321#define TX_CMD_FLG_SEQ_CTL_MSK cpu_to_le32(1 << 13)1322 1323/* 1: This frame is non-last MPDU; more fragments are coming.1324 * 0: Last fragment, or not using fragmentation. */1325#define TX_CMD_FLG_MORE_FRAG_MSK cpu_to_le32(1 << 14)1326 1327/* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.1328 * 0: No TSF required in outgoing frame.1329 * Set this for transmitting beacons and probe responses. */1330#define TX_CMD_FLG_TSF_MSK cpu_to_le32(1 << 16)1331 1332/* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword1333 * alignment of frame's payload data field.1334 * 0: No pad1335 * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR41336 * field (but not both). Driver must align frame data (i.e. data following1337 * MAC header) to DWORD boundary. */1338#define TX_CMD_FLG_MH_PAD_MSK cpu_to_le32(1 << 20)1339 1340/* accelerate aggregation support1341 * 0 - no CCMP encryption; 1 - CCMP encryption */1342#define TX_CMD_FLG_AGG_CCMP_MSK cpu_to_le32(1 << 22)1343 1344/* HCCA-AP - disable duration overwriting. */1345#define TX_CMD_FLG_DUR_MSK cpu_to_le32(1 << 25)1346 1347/*1348 * TX command security control1349 */1350#define TX_CMD_SEC_WEP 0x011351#define TX_CMD_SEC_CCM 0x021352#define TX_CMD_SEC_TKIP 0x031353#define TX_CMD_SEC_MSK 0x031354#define TX_CMD_SEC_SHIFT 61355#define TX_CMD_SEC_KEY128 0x081356 1357/*1358 * C_TX = 0x1c (command)1359 */1360 1361struct il3945_tx_cmd {1362 /* New members MUST be added within the __struct_group() macro below. */1363 __struct_group(il3945_tx_cmd_hdr, __hdr, __packed,1364 /*1365 * MPDU byte count:1366 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,1367 * + 8 byte IV for CCM or TKIP (not used for WEP)1368 * + Data payload1369 * + 8-byte MIC (not used for CCM/WEP)1370 * NOTE: Does not include Tx command bytes, post-MAC pad bytes,1371 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i1372 * Range: 14-2342 bytes.1373 */1374 __le16 len;1375 1376 /*1377 * MPDU or MSDU byte count for next frame.1378 * Used for fragmentation and bursting, but not 11n aggregation.1379 * Same as "len", but for next frame. Set to 0 if not applicable.1380 */1381 __le16 next_frame_len;1382 1383 __le32 tx_flags; /* TX_CMD_FLG_* */1384 1385 u8 rate;1386 1387 /* Index of recipient station in uCode's station table */1388 u8 sta_id;1389 u8 tid_tspec;1390 u8 sec_ctl;1391 u8 key[16];1392 union {1393 u8 byte[8];1394 __le16 word[4];1395 __le32 dw[2];1396 } tkip_mic;1397 __le32 next_frame_info;1398 union {1399 __le32 life_time;1400 __le32 attempt;1401 } stop_time;1402 u8 supp_rates[2];1403 u8 rts_retry_limit; /*byte 50 */1404 u8 data_retry_limit; /*byte 51 */1405 union {1406 __le16 pm_frame_timeout;1407 __le16 attempt_duration;1408 } timeout;1409 1410 /*1411 * Duration of EDCA burst Tx Opportunity, in 32-usec units.1412 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).1413 */1414 __le16 driver_txop;1415 );1416 1417 /*1418 * MAC header goes here, followed by 2 bytes padding if MAC header1419 * length is 26 or 30 bytes, followed by payload data1420 */1421 struct ieee80211_hdr hdr[];1422} __packed;1423static_assert(offsetof(struct il3945_tx_cmd, hdr) == sizeof(struct il3945_tx_cmd_hdr),1424 "struct member likely outside of __struct_group()");1425 1426/*1427 * C_TX = 0x1c (response)1428 */1429struct il3945_tx_resp {1430 u8 failure_rts;1431 u8 failure_frame;1432 u8 bt_kill_count;1433 u8 rate;1434 __le32 wireless_media_time;1435 __le32 status; /* TX status */1436} __packed;1437 1438/*1439 * 4965 uCode updates these Tx attempt count values in host DRAM.1440 * Used for managing Tx retries when expecting block-acks.1441 * Driver should set these fields to 0.1442 */1443struct il_dram_scratch {1444 u8 try_cnt; /* Tx attempts */1445 u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */1446 __le16 reserved;1447} __packed;1448 1449struct il_tx_cmd {1450 /* New members MUST be added within the __struct_group() macro below. */1451 __struct_group(il_tx_cmd_hdr, __hdr, __packed,1452 /*1453 * MPDU byte count:1454 * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,1455 * + 8 byte IV for CCM or TKIP (not used for WEP)1456 * + Data payload1457 * + 8-byte MIC (not used for CCM/WEP)1458 * NOTE: Does not include Tx command bytes, post-MAC pad bytes,1459 * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i1460 * Range: 14-2342 bytes.1461 */1462 __le16 len;1463 1464 /*1465 * MPDU or MSDU byte count for next frame.1466 * Used for fragmentation and bursting, but not 11n aggregation.1467 * Same as "len", but for next frame. Set to 0 if not applicable.1468 */1469 __le16 next_frame_len;1470 1471 __le32 tx_flags; /* TX_CMD_FLG_* */1472 1473 /* uCode may modify this field of the Tx command (in host DRAM!).1474 * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */1475 struct il_dram_scratch scratch;1476 1477 /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */1478 __le32 rate_n_flags; /* RATE_MCS_* */1479 1480 /* Index of destination station in uCode's station table */1481 u8 sta_id;1482 1483 /* Type of security encryption: CCM or TKIP */1484 u8 sec_ctl; /* TX_CMD_SEC_* */1485 1486 /*1487 * Index into rate table (see C_TX_LINK_QUALITY_CMD) for initial1488 * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for1489 * data frames, this field may be used to selectively reduce initial1490 * rate (via non-0 value) for special frames (e.g. management), while1491 * still supporting rate scaling for all frames.1492 */1493 u8 initial_rate_idx;1494 u8 reserved;1495 u8 key[16];1496 __le16 next_frame_flags;1497 __le16 reserved2;1498 union {1499 __le32 life_time;1500 __le32 attempt;1501 } stop_time;1502 1503 /* Host DRAM physical address pointer to "scratch" in this command.1504 * Must be dword aligned. "0" in dram_lsb_ptr disables usage. */1505 __le32 dram_lsb_ptr;1506 u8 dram_msb_ptr;1507 1508 u8 rts_retry_limit; /*byte 50 */1509 u8 data_retry_limit; /*byte 51 */1510 u8 tid_tspec;1511 union {1512 __le16 pm_frame_timeout;1513 __le16 attempt_duration;1514 } timeout;1515 1516 /*1517 * Duration of EDCA burst Tx Opportunity, in 32-usec units.1518 * Set this if txop time is not specified by HCCA protocol (e.g. by AP).1519 */1520 __le16 driver_txop;1521 );1522 1523 /*1524 * MAC header goes here, followed by 2 bytes padding if MAC header1525 * length is 26 or 30 bytes, followed by payload data1526 */1527 struct ieee80211_hdr hdr[];1528} __packed;1529static_assert(offsetof(struct il_tx_cmd, hdr) == sizeof(struct il_tx_cmd_hdr),1530 "struct member likely outside of __struct_group()");1531 1532/* TX command response is sent after *3945* transmission attempts.1533 *1534 * NOTES:1535 *1536 * TX_STATUS_FAIL_NEXT_FRAG1537 *1538 * If the fragment flag in the MAC header for the frame being transmitted1539 * is set and there is insufficient time to transmit the next frame, the1540 * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'.1541 *1542 * TX_STATUS_FIFO_UNDERRUN1543 *1544 * Indicates the host did not provide bytes to the FIFO fast enough while1545 * a TX was in progress.1546 *1547 * TX_STATUS_FAIL_MGMNT_ABORT1548 *1549 * This status is only possible if the ABORT ON MGMT RX parameter was1550 * set to true with the TX command.1551 *1552 * If the MSB of the status parameter is set then an abort sequence is1553 * required. This sequence consists of the host activating the TX Abort1554 * control line, and then waiting for the TX Abort command response. This1555 * indicates that a the device is no longer in a transmit state, and that the1556 * command FIFO has been cleared. The host must then deactivate the TX Abort1557 * control line. Receiving is still allowed in this case.1558 */1559enum {1560 TX_3945_STATUS_SUCCESS = 0x01,1561 TX_3945_STATUS_DIRECT_DONE = 0x02,1562 TX_3945_STATUS_FAIL_SHORT_LIMIT = 0x82,1563 TX_3945_STATUS_FAIL_LONG_LIMIT = 0x83,1564 TX_3945_STATUS_FAIL_FIFO_UNDERRUN = 0x84,1565 TX_3945_STATUS_FAIL_MGMNT_ABORT = 0x85,1566 TX_3945_STATUS_FAIL_NEXT_FRAG = 0x86,1567 TX_3945_STATUS_FAIL_LIFE_EXPIRE = 0x87,1568 TX_3945_STATUS_FAIL_DEST_PS = 0x88,1569 TX_3945_STATUS_FAIL_ABORTED = 0x89,1570 TX_3945_STATUS_FAIL_BT_RETRY = 0x8a,1571 TX_3945_STATUS_FAIL_STA_INVALID = 0x8b,1572 TX_3945_STATUS_FAIL_FRAG_DROPPED = 0x8c,1573 TX_3945_STATUS_FAIL_TID_DISABLE = 0x8d,1574 TX_3945_STATUS_FAIL_FRAME_FLUSHED = 0x8e,1575 TX_3945_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,1576 TX_3945_STATUS_FAIL_TX_LOCKED = 0x90,1577 TX_3945_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,1578};1579 1580/*1581 * TX command response is sent after *4965* transmission attempts.1582 *1583 * both postpone and abort status are expected behavior from uCode. there is1584 * no special operation required from driver; except for RFKILL_FLUSH,1585 * which required tx flush host command to flush all the tx frames in queues1586 */1587enum {1588 TX_STATUS_SUCCESS = 0x01,1589 TX_STATUS_DIRECT_DONE = 0x02,1590 /* postpone TX */1591 TX_STATUS_POSTPONE_DELAY = 0x40,1592 TX_STATUS_POSTPONE_FEW_BYTES = 0x41,1593 TX_STATUS_POSTPONE_QUIET_PERIOD = 0x43,1594 TX_STATUS_POSTPONE_CALC_TTAK = 0x44,1595 /* abort TX */1596 TX_STATUS_FAIL_INTERNAL_CROSSED_RETRY = 0x81,1597 TX_STATUS_FAIL_SHORT_LIMIT = 0x82,1598 TX_STATUS_FAIL_LONG_LIMIT = 0x83,1599 TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,1600 TX_STATUS_FAIL_DRAIN_FLOW = 0x85,1601 TX_STATUS_FAIL_RFKILL_FLUSH = 0x86,1602 TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,1603 TX_STATUS_FAIL_DEST_PS = 0x88,1604 TX_STATUS_FAIL_HOST_ABORTED = 0x89,1605 TX_STATUS_FAIL_BT_RETRY = 0x8a,1606 TX_STATUS_FAIL_STA_INVALID = 0x8b,1607 TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,1608 TX_STATUS_FAIL_TID_DISABLE = 0x8d,1609 TX_STATUS_FAIL_FIFO_FLUSHED = 0x8e,1610 TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,1611 TX_STATUS_FAIL_PASSIVE_NO_RX = 0x90,1612 TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,1613};1614 1615#define TX_PACKET_MODE_REGULAR 0x00001616#define TX_PACKET_MODE_BURST_SEQ 0x01001617#define TX_PACKET_MODE_BURST_FIRST 0x02001618 1619enum {1620 TX_POWER_PA_NOT_ACTIVE = 0x0,1621};1622 1623enum {1624 TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */1625 TX_STATUS_DELAY_MSK = 0x00000040,1626 TX_STATUS_ABORT_MSK = 0x00000080,1627 TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */1628 TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */1629 TX_RESERVED = 0x00780000, /* bits 19:22 */1630 TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */1631 TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */1632};1633 1634/* *******************************1635 * TX aggregation status1636 ******************************* */1637 1638enum {1639 AGG_TX_STATE_TRANSMITTED = 0x00,1640 AGG_TX_STATE_UNDERRUN_MSK = 0x01,1641 AGG_TX_STATE_FEW_BYTES_MSK = 0x04,1642 AGG_TX_STATE_ABORT_MSK = 0x08,1643 AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,1644 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,1645 AGG_TX_STATE_SCD_QUERY_MSK = 0x80,1646 AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,1647 AGG_TX_STATE_RESPONSE_MSK = 0x1ff,1648 AGG_TX_STATE_DUMP_TX_MSK = 0x200,1649 AGG_TX_STATE_DELAY_TX_MSK = 0x4001650};1651 1652#define AGG_TX_STATUS_MSK 0x00000fff /* bits 0:11 */1653#define AGG_TX_TRY_MSK 0x0000f000 /* bits 12:15 */1654 1655#define AGG_TX_STATE_LAST_SENT_MSK (AGG_TX_STATE_LAST_SENT_TTL_MSK | \1656 AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK)1657 1658/* # tx attempts for first frame in aggregation */1659#define AGG_TX_STATE_TRY_CNT_POS 121660#define AGG_TX_STATE_TRY_CNT_MSK 0xf0001661 1662/* Command ID and sequence number of Tx command for this frame */1663#define AGG_TX_STATE_SEQ_NUM_POS 161664#define AGG_TX_STATE_SEQ_NUM_MSK 0xffff00001665 1666/*1667 * C_TX = 0x1c (response)1668 *1669 * This response may be in one of two slightly different formats, indicated1670 * by the frame_count field:1671 *1672 * 1) No aggregation (frame_count == 1). This reports Tx results for1673 * a single frame. Multiple attempts, at various bit rates, may have1674 * been made for this frame.1675 *1676 * 2) Aggregation (frame_count > 1). This reports Tx results for1677 * 2 or more frames that used block-acknowledge. All frames were1678 * transmitted at same rate. Rate scaling may have been used if first1679 * frame in this new agg block failed in previous agg block(s).1680 *1681 * Note that, for aggregation, ACK (block-ack) status is not delivered here;1682 * block-ack has not been received by the time the 4965 device records1683 * this status.1684 * This status relates to reasons the tx might have been blocked or aborted1685 * within the sending station (this 4965 device), rather than whether it was1686 * received successfully by the destination station.1687 */1688struct agg_tx_status {1689 __le16 status;1690 __le16 sequence;1691} __packed;1692 1693struct il4965_tx_resp {1694 u8 frame_count; /* 1 no aggregation, >1 aggregation */1695 u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */1696 u8 failure_rts; /* # failures due to unsuccessful RTS */1697 u8 failure_frame; /* # failures due to no ACK (unused for agg) */1698 1699 /* For non-agg: Rate at which frame was successful.1700 * For agg: Rate at which all frames were transmitted. */1701 __le32 rate_n_flags; /* RATE_MCS_* */1702 1703 /* For non-agg: RTS + CTS + frame tx attempts time + ACK.1704 * For agg: RTS + CTS + aggregation tx time + block-ack time. */1705 __le16 wireless_media_time; /* uSecs */1706 1707 __le16 reserved;1708 __le32 pa_power1; /* RF power amplifier measurement (not used) */1709 __le32 pa_power2;1710 1711 /*1712 * For non-agg: frame status TX_STATUS_*1713 * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status1714 * fields follow this one, up to frame_count.1715 * Bit fields:1716 * 11- 0: AGG_TX_STATE_* status code1717 * 15-12: Retry count for 1st frame in aggregation (retries1718 * occur if tx failed for this frame when it was a1719 * member of a previous aggregation block). If rate1720 * scaling is used, retry count indicates the rate1721 * table entry used for all frames in the new agg.1722 * 31-16: Sequence # for this frame's Tx cmd (not SSN!)1723 */1724 union {1725 __le32 status;1726 DECLARE_FLEX_ARRAY(struct agg_tx_status, agg_status); /* for each agg frame */1727 } u;1728} __packed;1729 1730/*1731 * N_COMPRESSED_BA = 0xc5 (response only, not a command)1732 *1733 * Reports Block-Acknowledge from recipient station1734 */1735struct il_compressed_ba_resp {1736 __le32 sta_addr_lo32;1737 __le16 sta_addr_hi16;1738 __le16 reserved;1739 1740 /* Index of recipient (BA-sending) station in uCode's station table */1741 u8 sta_id;1742 u8 tid;1743 __le16 seq_ctl;1744 __le64 bitmap;1745 __le16 scd_flow;1746 __le16 scd_ssn;1747} __packed;1748 1749/*1750 * C_TX_PWR_TBL = 0x97 (command, has simple generic response)1751 *1752 * See details under "TXPOWER" in 4965.h.1753 */1754 1755struct il3945_txpowertable_cmd {1756 u8 band; /* 0: 5 GHz, 1: 2.4 GHz */1757 u8 reserved;1758 __le16 channel;1759 struct il3945_power_per_rate power[IL_MAX_RATES];1760} __packed;1761 1762struct il4965_txpowertable_cmd {1763 u8 band; /* 0: 5 GHz, 1: 2.4 GHz */1764 u8 reserved;1765 __le16 channel;1766 struct il4965_tx_power_db tx_power;1767} __packed;1768 1769/**1770 * struct il3945_rate_scaling_cmd - Rate Scaling Command & Response1771 *1772 * C_RATE_SCALE = 0x47 (command, has simple generic response)1773 *1774 * NOTE: The table of rates passed to the uCode via the1775 * RATE_SCALE command sets up the corresponding order of1776 * rates used for all related commands, including rate1777 * masks, etc.1778 *1779 * For example, if you set 9MB (PLCP 0x0f) as the first1780 * rate in the rate table, the bit mask for that rate1781 * when passed through ofdm_basic_rates on the C_RXON1782 * command would be bit 0 (1 << 0)1783 */1784struct il3945_rate_scaling_info {1785 __le16 rate_n_flags;1786 u8 try_cnt;1787 u8 next_rate_idx;1788} __packed;1789 1790struct il3945_rate_scaling_cmd {1791 u8 table_id;1792 u8 reserved[3];1793 struct il3945_rate_scaling_info table[IL_MAX_RATES];1794} __packed;1795 1796/*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */1797#define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0)1798 1799/* # of EDCA prioritized tx fifos */1800#define LINK_QUAL_AC_NUM AC_NUM1801 1802/* # entries in rate scale table to support Tx retries */1803#define LINK_QUAL_MAX_RETRY_NUM 161804 1805/* Tx antenna selection values */1806#define LINK_QUAL_ANT_A_MSK (1 << 0)1807#define LINK_QUAL_ANT_B_MSK (1 << 1)1808#define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)1809 1810/**1811 * struct il_link_qual_general_params1812 *1813 * Used in C_TX_LINK_QUALITY_CMD1814 */1815struct il_link_qual_general_params {1816 u8 flags;1817 1818 /* No entries at or above this (driver chosen) idx contain MIMO */1819 u8 mimo_delimiter;1820 1821 /* Best single antenna to use for single stream (legacy, SISO). */1822 u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */1823 1824 /* Best antennas to use for MIMO (unused for 4965, assumes both). */1825 u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */1826 1827 /*1828 * If driver needs to use different initial rates for different1829 * EDCA QOS access categories (as implemented by tx fifos 0-3),1830 * this table will set that up, by indicating the idxes in the1831 * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.1832 * Otherwise, driver should set all entries to 0.1833 *1834 * Entry usage:1835 * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice1836 * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.1837 */1838 u8 start_rate_idx[LINK_QUAL_AC_NUM];1839} __packed;1840 1841#define LINK_QUAL_AGG_TIME_LIMIT_DEF (4000) /* 4 milliseconds */1842#define LINK_QUAL_AGG_TIME_LIMIT_MAX (8000)1843#define LINK_QUAL_AGG_TIME_LIMIT_MIN (100)1844 1845#define LINK_QUAL_AGG_DISABLE_START_DEF (3)1846#define LINK_QUAL_AGG_DISABLE_START_MAX (255)1847#define LINK_QUAL_AGG_DISABLE_START_MIN (0)1848 1849#define LINK_QUAL_AGG_FRAME_LIMIT_DEF (31)1850#define LINK_QUAL_AGG_FRAME_LIMIT_MAX (63)1851#define LINK_QUAL_AGG_FRAME_LIMIT_MIN (0)1852 1853/**1854 * struct il_link_qual_agg_params1855 *1856 * Used in C_TX_LINK_QUALITY_CMD1857 */1858struct il_link_qual_agg_params {1859 1860 /*1861 *Maximum number of uSec in aggregation.1862 * default set to 4000 (4 milliseconds) if not configured in .cfg1863 */1864 __le16 agg_time_limit;1865 1866 /*1867 * Number of Tx retries allowed for a frame, before that frame will1868 * no longer be considered for the start of an aggregation sequence1869 * (scheduler will then try to tx it as single frame).1870 * Driver should set this to 3.1871 */1872 u8 agg_dis_start_th;1873 1874 /*1875 * Maximum number of frames in aggregation.1876 * 0 = no limit (default). 1 = no aggregation.1877 * Other values = max # frames in aggregation.1878 */1879 u8 agg_frame_cnt_limit;1880 1881 __le32 reserved;1882} __packed;1883 1884/*1885 * C_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)1886 *1887 * For 4965 devices only; 3945 uses C_RATE_SCALE.1888 *1889 * Each station in the 4965 device's internal station table has its own table1890 * of 161891 * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when1892 * an ACK is not received. This command replaces the entire table for1893 * one station.1894 *1895 * NOTE: Station must already be in 4965 device's station table.1896 * Use C_ADD_STA.1897 *1898 * The rate scaling procedures described below work well. Of course, other1899 * procedures are possible, and may work better for particular environments.1900 *1901 *1902 * FILLING THE RATE TBL1903 *1904 * Given a particular initial rate and mode, as determined by the rate1905 * scaling algorithm described below, the Linux driver uses the following1906 * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the1907 * Link Quality command:1908 *1909 *1910 * 1) If using High-throughput (HT) (SISO or MIMO) initial rate:1911 * a) Use this same initial rate for first 3 entries.1912 * b) Find next lower available rate using same mode (SISO or MIMO),1913 * use for next 3 entries. If no lower rate available, switch to1914 * legacy mode (no HT40 channel, no MIMO, no short guard interval).1915 * c) If using MIMO, set command's mimo_delimiter to number of entries1916 * using MIMO (3 or 6).1917 * d) After trying 2 HT rates, switch to legacy mode (no HT40 channel,1918 * no MIMO, no short guard interval), at the next lower bit rate1919 * (e.g. if second HT bit rate was 54, try 48 legacy), and follow1920 * legacy procedure for remaining table entries.1921 *1922 * 2) If using legacy initial rate:1923 * a) Use the initial rate for only one entry.1924 * b) For each following entry, reduce the rate to next lower available1925 * rate, until reaching the lowest available rate.1926 * c) When reducing rate, also switch antenna selection.1927 * d) Once lowest available rate is reached, repeat this rate until1928 * rate table is filled (16 entries), switching antenna each entry.1929 *1930 *1931 * ACCUMULATING HISTORY1932 *1933 * The rate scaling algorithm for 4965 devices, as implemented in Linux driver,1934 * uses two sets of frame Tx success history: One for the current/active1935 * modulation mode, and one for a speculative/search mode that is being1936 * attempted. If the speculative mode turns out to be more effective (i.e.1937 * actual transfer rate is better), then the driver continues to use the1938 * speculative mode as the new current active mode.1939 *1940 * Each history set contains, separately for each possible rate, data for a1941 * sliding win of the 62 most recent tx attempts at that rate. The data1942 * includes a shifting bitmap of success(1)/failure(0), and sums of successful1943 * and attempted frames, from which the driver can additionally calculate a1944 * success ratio (success / attempted) and number of failures1945 * (attempted - success), and control the size of the win (attempted).1946 * The driver uses the bit map to remove successes from the success sum, as1947 * the oldest tx attempts fall out of the win.1948 *1949 * When the 4965 device makes multiple tx attempts for a given frame, each1950 * attempt might be at a different rate, and have different modulation1951 * characteristics (e.g. antenna, fat channel, short guard interval), as set1952 * up in the rate scaling table in the Link Quality command. The driver must1953 * determine which rate table entry was used for each tx attempt, to determine1954 * which rate-specific history to update, and record only those attempts that1955 * match the modulation characteristics of the history set.1956 *1957 * When using block-ack (aggregation), all frames are transmitted at the same1958 * rate, since there is no per-attempt acknowledgment from the destination1959 * station. The Tx response struct il_tx_resp indicates the Tx rate in1960 * rate_n_flags field. After receiving a block-ack, the driver can update1961 * history for the entire block all at once.1962 *1963 *1964 * FINDING BEST STARTING RATE:1965 *1966 * When working with a selected initial modulation mode (see below), the1967 * driver attempts to find a best initial rate. The initial rate is the1968 * first entry in the Link Quality command's rate table.1969 *1970 * 1) Calculate actual throughput (success ratio * expected throughput, see1971 * table below) for current initial rate. Do this only if enough frames1972 * have been attempted to make the value meaningful: at least 6 failed1973 * tx attempts, or at least 8 successes. If not enough, don't try rate1974 * scaling yet.1975 *1976 * 2) Find available rates adjacent to current initial rate. Available means:1977 * a) supported by hardware &&1978 * b) supported by association &&1979 * c) within any constraints selected by user1980 *1981 * 3) Gather measured throughputs for adjacent rates. These might not have1982 * enough history to calculate a throughput. That's okay, we might try1983 * using one of them anyway!1984 *1985 * 4) Try decreasing rate if, for current rate:1986 * a) success ratio is < 15% ||1987 * b) lower adjacent rate has better measured throughput ||1988 * c) higher adjacent rate has worse throughput, and lower is unmeasured1989 *1990 * As a sanity check, if decrease was determined above, leave rate1991 * unchanged if:1992 * a) lower rate unavailable1993 * b) success ratio at current rate > 85% (very good)1994 * c) current measured throughput is better than expected throughput1995 * of lower rate (under perfect 100% tx conditions, see table below)1996 *1997 * 5) Try increasing rate if, for current rate:1998 * a) success ratio is < 15% ||1999 * b) both adjacent rates' throughputs are unmeasured (try it!) ||2000 * b) higher adjacent rate has better measured throughput ||2001 * c) lower adjacent rate has worse throughput, and higher is unmeasured2002 *2003 * As a sanity check, if increase was determined above, leave rate2004 * unchanged if:2005 * a) success ratio at current rate < 70%. This is not particularly2006 * good performance; higher rate is sure to have poorer success.2007 *2008 * 6) Re-evaluate the rate after each tx frame. If working with block-2009 * acknowledge, history and stats may be calculated for the entire2010 * block (including prior history that fits within the history wins),2011 * before re-evaluation.2012 *2013 * FINDING BEST STARTING MODULATION MODE:2014 *2015 * After working with a modulation mode for a "while" (and doing rate scaling),2016 * the driver searches for a new initial mode in an attempt to improve2017 * throughput. The "while" is measured by numbers of attempted frames:2018 *2019 * For legacy mode, search for new mode after:2020 * 480 successful frames, or 160 failed frames2021 * For high-throughput modes (SISO or MIMO), search for new mode after:2022 * 4500 successful frames, or 400 failed frames2023 *2024 * Mode switch possibilities are (3 for each mode):2025 *2026 * For legacy:2027 * Change antenna, try SISO (if HT association), try MIMO (if HT association)2028 * For SISO:2029 * Change antenna, try MIMO, try shortened guard interval (SGI)2030 * For MIMO:2031 * Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)2032 *2033 * When trying a new mode, use the same bit rate as the old/current mode when2034 * trying antenna switches and shortened guard interval. When switching to2035 * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate2036 * for which the expected throughput (under perfect conditions) is about the2037 * same or slightly better than the actual measured throughput delivered by2038 * the old/current mode.2039 *2040 * Actual throughput can be estimated by multiplying the expected throughput2041 * by the success ratio (successful / attempted tx frames). Frame size is2042 * not considered in this calculation; it assumes that frame size will average2043 * out to be fairly consistent over several samples. The following are2044 * metric values for expected throughput assuming 100% success ratio.2045 * Only G band has support for CCK rates:2046 *2047 * RATE: 1 2 5 11 6 9 12 18 24 36 48 54 602048 *2049 * G: 7 13 35 58 40 57 72 98 121 154 177 186 1862050 * A: 0 0 0 0 40 57 72 98 121 154 177 186 1862051 * SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 2022052 * SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 2112053 * MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 2512054 * SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 2572055 * SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 2572056 * SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 2642057 * MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 2892058 * SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 2932059 *2060 * After the new mode has been tried for a short while (minimum of 6 failed2061 * frames or 8 successful frames), compare success ratio and actual throughput2062 * estimate of the new mode with the old. If either is better with the new2063 * mode, continue to use the new mode.2064 *2065 * Continue comparing modes until all 3 possibilities have been tried.2066 * If moving from legacy to HT, try all 3 possibilities from the new HT2067 * mode. After trying all 3, a best mode is found. Continue to use this mode2068 * for the longer "while" described above (e.g. 480 successful frames for2069 * legacy), and then repeat the search process.2070 *2071 */2072struct il_link_quality_cmd {2073 2074 /* Index of destination/recipient station in uCode's station table */2075 u8 sta_id;2076 u8 reserved1;2077 __le16 control; /* not used */2078 struct il_link_qual_general_params general_params;2079 struct il_link_qual_agg_params agg_params;2080 2081 /*2082 * Rate info; when using rate-scaling, Tx command's initial_rate_idx2083 * specifies 1st Tx rate attempted, via idx into this table.2084 * 4965 devices works its way through table when retrying Tx.2085 */2086 struct {2087 __le32 rate_n_flags; /* RATE_MCS_*, RATE_* */2088 } rs_table[LINK_QUAL_MAX_RETRY_NUM];2089 __le32 reserved2;2090} __packed;2091 2092/*2093 * BT configuration enable flags:2094 * bit 0 - 1: BT channel announcement enabled2095 * 0: disable2096 * bit 1 - 1: priority of BT device enabled2097 * 0: disable2098 */2099#define BT_COEX_DISABLE (0x0)2100#define BT_ENABLE_CHANNEL_ANNOUNCE BIT(0)2101#define BT_ENABLE_PRIORITY BIT(1)2102 2103#define BT_COEX_ENABLE (BT_ENABLE_CHANNEL_ANNOUNCE | BT_ENABLE_PRIORITY)2104 2105#define BT_LEAD_TIME_DEF (0x1E)2106 2107#define BT_MAX_KILL_DEF (0x5)2108 2109/*2110 * C_BT_CONFIG = 0x9b (command, has simple generic response)2111 *2112 * 3945 and 4965 devices support hardware handshake with Bluetooth device on2113 * same platform. Bluetooth device alerts wireless device when it will Tx;2114 * wireless device can delay or kill its own Tx to accommodate.2115 */2116struct il_bt_cmd {2117 u8 flags;2118 u8 lead_time;2119 u8 max_kill;2120 u8 reserved;2121 __le32 kill_ack_mask;2122 __le32 kill_cts_mask;2123} __packed;2124 2125/******************************************************************************2126 * (6)2127 * Spectrum Management (802.11h) Commands, Responses, Notifications:2128 *2129 *****************************************************************************/2130 2131/*2132 * Spectrum Management2133 */2134#define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \2135 RXON_FILTER_CTL2HOST_MSK | \2136 RXON_FILTER_ACCEPT_GRP_MSK | \2137 RXON_FILTER_DIS_DECRYPT_MSK | \2138 RXON_FILTER_DIS_GRP_DECRYPT_MSK | \2139 RXON_FILTER_ASSOC_MSK | \2140 RXON_FILTER_BCON_AWARE_MSK)2141 2142struct il_measure_channel {2143 __le32 duration; /* measurement duration in extended beacon2144 * format */2145 u8 channel; /* channel to measure */2146 u8 type; /* see enum il_measure_type */2147 __le16 reserved;2148} __packed;2149 2150/*2151 * C_SPECTRUM_MEASUREMENT = 0x74 (command)2152 */2153struct il_spectrum_cmd {2154 __le16 len; /* number of bytes starting from token */2155 u8 token; /* token id */2156 u8 id; /* measurement id -- 0 or 1 */2157 u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */2158 u8 periodic; /* 1 = periodic */2159 __le16 path_loss_timeout;2160 __le32 start_time; /* start time in extended beacon format */2161 __le32 reserved2;2162 __le32 flags; /* rxon flags */2163 __le32 filter_flags; /* rxon filter flags */2164 __le16 channel_count; /* minimum 1, maximum 10 */2165 __le16 reserved3;2166 struct il_measure_channel channels[10];2167} __packed;2168 2169/*2170 * C_SPECTRUM_MEASUREMENT = 0x74 (response)2171 */2172struct il_spectrum_resp {2173 u8 token;2174 u8 id; /* id of the prior command replaced, or 0xff */2175 __le16 status; /* 0 - command will be handled2176 * 1 - cannot handle (conflicts with another2177 * measurement) */2178} __packed;2179 2180enum il_measurement_state {2181 IL_MEASUREMENT_START = 0,2182 IL_MEASUREMENT_STOP = 1,2183};2184 2185enum il_measurement_status {2186 IL_MEASUREMENT_OK = 0,2187 IL_MEASUREMENT_CONCURRENT = 1,2188 IL_MEASUREMENT_CSA_CONFLICT = 2,2189 IL_MEASUREMENT_TGH_CONFLICT = 3,2190 /* 4-5 reserved */2191 IL_MEASUREMENT_STOPPED = 6,2192 IL_MEASUREMENT_TIMEOUT = 7,2193 IL_MEASUREMENT_PERIODIC_FAILED = 8,2194};2195 2196#define NUM_ELEMENTS_IN_HISTOGRAM 82197 2198struct il_measurement_histogram {2199 __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */2200 __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */2201} __packed;2202 2203/* clear channel availability counters */2204struct il_measurement_cca_counters {2205 __le32 ofdm;2206 __le32 cck;2207} __packed;2208 2209enum il_measure_type {2210 IL_MEASURE_BASIC = (1 << 0),2211 IL_MEASURE_CHANNEL_LOAD = (1 << 1),2212 IL_MEASURE_HISTOGRAM_RPI = (1 << 2),2213 IL_MEASURE_HISTOGRAM_NOISE = (1 << 3),2214 IL_MEASURE_FRAME = (1 << 4),2215 /* bits 5:6 are reserved */2216 IL_MEASURE_IDLE = (1 << 7),2217};2218 2219/*2220 * N_SPECTRUM_MEASUREMENT = 0x75 (notification only, not a command)2221 */2222struct il_spectrum_notification {2223 u8 id; /* measurement id -- 0 or 1 */2224 u8 token;2225 u8 channel_idx; /* idx in measurement channel list */2226 u8 state; /* 0 - start, 1 - stop */2227 __le32 start_time; /* lower 32-bits of TSF */2228 u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */2229 u8 channel;2230 u8 type; /* see enum il_measurement_type */2231 u8 reserved1;2232 /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only2233 * valid if applicable for measurement type requested. */2234 __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */2235 __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */2236 __le32 cca_time; /* channel load time in usecs */2237 u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 -2238 * unidentified */2239 u8 reserved2[3];2240 struct il_measurement_histogram histogram;2241 __le32 stop_time; /* lower 32-bits of TSF */2242 __le32 status; /* see il_measurement_status */2243} __packed;2244 2245/******************************************************************************2246 * (7)2247 * Power Management Commands, Responses, Notifications:2248 *2249 *****************************************************************************/2250 2251/**2252 * struct il_powertable_cmd - Power Table Command2253 * @flags: See below:2254 *2255 * C_POWER_TBL = 0x77 (command, has simple generic response)2256 *2257 * PM allow:2258 * bit 0 - '0' Driver not allow power management2259 * '1' Driver allow PM (use rest of parameters)2260 *2261 * uCode send sleep notifications:2262 * bit 1 - '0' Don't send sleep notification2263 * '1' send sleep notification (SEND_PM_NOTIFICATION)2264 *2265 * Sleep over DTIM2266 * bit 2 - '0' PM have to walk up every DTIM2267 * '1' PM could sleep over DTIM till listen Interval.2268 *2269 * PCI power managed2270 * bit 3 - '0' (PCI_CFG_LINK_CTRL & 0x1)2271 * '1' !(PCI_CFG_LINK_CTRL & 0x1)2272 *2273 * Fast PD2274 * bit 4 - '1' Put radio to sleep when receiving frame for others2275 *2276 * Force sleep Modes2277 * bit 31/30- '00' use both mac/xtal sleeps2278 * '01' force Mac sleep2279 * '10' force xtal sleep2280 * '11' Illegal set2281 *2282 * NOTE: if sleep_interval[SLEEP_INTRVL_TBL_SIZE-1] > DTIM period then2283 * ucode assume sleep over DTIM is allowed and we don't need to wake up2284 * for every DTIM.2285 */2286#define IL_POWER_VEC_SIZE 52287 2288#define IL_POWER_DRIVER_ALLOW_SLEEP_MSK cpu_to_le16(BIT(0))2289#define IL_POWER_SLEEP_OVER_DTIM_MSK cpu_to_le16(BIT(2))2290#define IL_POWER_PCI_PM_MSK cpu_to_le16(BIT(3))2291 2292struct il3945_powertable_cmd {2293 __le16 flags;2294 u8 reserved[2];2295 __le32 rx_data_timeout;2296 __le32 tx_data_timeout;2297 __le32 sleep_interval[IL_POWER_VEC_SIZE];2298} __packed;2299 2300struct il_powertable_cmd {2301 __le16 flags;2302 u8 keep_alive_seconds; /* 3945 reserved */2303 u8 debug_flags; /* 3945 reserved */2304 __le32 rx_data_timeout;2305 __le32 tx_data_timeout;2306 __le32 sleep_interval[IL_POWER_VEC_SIZE];2307 __le32 keep_alive_beacons;2308} __packed;2309 2310/*2311 * N_PM_SLEEP = 0x7A (notification only, not a command)2312 * all devices identical.2313 */2314struct il_sleep_notification {2315 u8 pm_sleep_mode;2316 u8 pm_wakeup_src;2317 __le16 reserved;2318 __le32 sleep_time;2319 __le32 tsf_low;2320 __le32 bcon_timer;2321} __packed;2322 2323/* Sleep states. all devices identical. */2324enum {2325 IL_PM_NO_SLEEP = 0,2326 IL_PM_SLP_MAC = 1,2327 IL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,2328 IL_PM_SLP_FULL_MAC_CARD_STATE = 3,2329 IL_PM_SLP_PHY = 4,2330 IL_PM_SLP_REPENT = 5,2331 IL_PM_WAKEUP_BY_TIMER = 6,2332 IL_PM_WAKEUP_BY_DRIVER = 7,2333 IL_PM_WAKEUP_BY_RFKILL = 8,2334 /* 3 reserved */2335 IL_PM_NUM_OF_MODES = 12,2336};2337 2338/*2339 * N_CARD_STATE = 0xa1 (notification only, not a command)2340 */2341struct il_card_state_notif {2342 __le32 flags;2343} __packed;2344 2345#define HW_CARD_DISABLED 0x012346#define SW_CARD_DISABLED 0x022347#define CT_CARD_DISABLED 0x042348#define RXON_CARD_DISABLED 0x102349 2350struct il_ct_kill_config {2351 __le32 reserved;2352 __le32 critical_temperature_M;2353 __le32 critical_temperature_R;2354} __packed;2355 2356/******************************************************************************2357 * (8)2358 * Scan Commands, Responses, Notifications:2359 *2360 *****************************************************************************/2361 2362#define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0)2363#define SCAN_CHANNEL_TYPE_ACTIVE cpu_to_le32(1)2364 2365/**2366 * struct il_scan_channel - entry in C_SCAN channel table2367 *2368 * One for each channel in the scan list.2369 * Each channel can independently select:2370 * 1) SSID for directed active scans2371 * 2) Txpower setting (for rate specified within Tx command)2372 * 3) How long to stay on-channel (behavior may be modified by quiet_time,2373 * quiet_plcp_th, good_CRC_th)2374 *2375 * To avoid uCode errors, make sure the following are true (see comments2376 * under struct il_scan_cmd about max_out_time and quiet_time):2377 * 1) If using passive_dwell (i.e. passive_dwell != 0):2378 * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)2379 * 2) quiet_time <= active_dwell2380 * 3) If restricting off-channel time (i.e. max_out_time !=0):2381 * passive_dwell < max_out_time2382 * active_dwell < max_out_time2383 */2384struct il3945_scan_channel {2385 /*2386 * type is defined as:2387 * 0:0 1 = active, 0 = passive2388 * 1:4 SSID direct bit map; if a bit is set, then corresponding2389 * SSID IE is transmitted in probe request.2390 * 5:7 reserved2391 */2392 u8 type;2393 u8 channel; /* band is selected by il3945_scan_cmd "flags" field */2394 struct il3945_tx_power tpc;2395 __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */2396 __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */2397} __packed;2398 2399/* set number of direct probes u8 type */2400#define IL39_SCAN_PROBE_MASK(n) ((BIT(n) | (BIT(n) - BIT(1))))2401 2402struct il_scan_channel {2403 /*2404 * type is defined as:2405 * 0:0 1 = active, 0 = passive2406 * 1:20 SSID direct bit map; if a bit is set, then corresponding2407 * SSID IE is transmitted in probe request.2408 * 21:31 reserved2409 */2410 __le32 type;2411 __le16 channel; /* band is selected by il_scan_cmd "flags" field */2412 u8 tx_gain; /* gain for analog radio */2413 u8 dsp_atten; /* gain for DSP */2414 __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */2415 __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */2416} __packed;2417 2418/* set number of direct probes __le32 type */2419#define IL_SCAN_PROBE_MASK(n) cpu_to_le32((BIT(n) | (BIT(n) - BIT(1))))2420 2421/**2422 * struct il_ssid_ie - directed scan network information element2423 *2424 * Up to 20 of these may appear in C_SCAN (Note: Only 4 are in2425 * 3945 SCAN api), selected by "type" bit field in struct il_scan_channel;2426 * each channel may select different ssids from among the 20 (4) entries.2427 * SSID IEs get transmitted in reverse order of entry.2428 */2429struct il_ssid_ie {2430 u8 id;2431 u8 len;2432 u8 ssid[32];2433} __packed;2434 2435#define PROBE_OPTION_MAX_3945 42436#define PROBE_OPTION_MAX 202437#define TX_CMD_LIFE_TIME_INFINITE cpu_to_le32(0xFFFFFFFF)2438#define IL_GOOD_CRC_TH_DISABLED 02439#define IL_GOOD_CRC_TH_DEFAULT cpu_to_le16(1)2440#define IL_GOOD_CRC_TH_NEVER cpu_to_le16(0xffff)2441#define IL_MAX_SCAN_SIZE 10242442#define IL_MAX_CMD_SIZE 40962443 2444/*2445 * C_SCAN = 0x80 (command)2446 *2447 * The hardware scan command is very powerful; the driver can set it up to2448 * maintain (relatively) normal network traffic while doing a scan in the2449 * background. The max_out_time and suspend_time control the ratio of how2450 * long the device stays on an associated network channel ("service channel")2451 * vs. how long it's away from the service channel, i.e. tuned to other channels2452 * for scanning.2453 *2454 * max_out_time is the max time off-channel (in usec), and suspend_time2455 * is how long (in "extended beacon" format) that the scan is "suspended"2456 * after returning to the service channel. That is, suspend_time is the2457 * time that we stay on the service channel, doing normal work, between2458 * scan segments. The driver may set these parameters differently to support2459 * scanning when associated vs. not associated, and light vs. heavy traffic2460 * loads when associated.2461 *2462 * After receiving this command, the device's scan engine does the following;2463 *2464 * 1) Sends SCAN_START notification to driver2465 * 2) Checks to see if it has time to do scan for one channel2466 * 3) Sends NULL packet, with power-save (PS) bit set to 1,2467 * to tell AP that we're going off-channel2468 * 4) Tunes to first channel in scan list, does active or passive scan2469 * 5) Sends SCAN_RESULT notification to driver2470 * 6) Checks to see if it has time to do scan on *next* channel in list2471 * 7) Repeats 4-6 until it no longer has time to scan the next channel2472 * before max_out_time expires2473 * 8) Returns to service channel2474 * 9) Sends NULL packet with PS=0 to tell AP that we're back2475 * 10) Stays on service channel until suspend_time expires2476 * 11) Repeats entire process 2-10 until list is complete2477 * 12) Sends SCAN_COMPLETE notification2478 *2479 * For fast, efficient scans, the scan command also has support for staying on2480 * a channel for just a short time, if doing active scanning and getting no2481 * responses to the transmitted probe request. This time is controlled by2482 * quiet_time, and the number of received packets below which a channel is2483 * considered "quiet" is controlled by quiet_plcp_threshold.2484 *2485 * For active scanning on channels that have regulatory restrictions against2486 * blindly transmitting, the scan can listen before transmitting, to make sure2487 * that there is already legitimate activity on the channel. If enough2488 * packets are cleanly received on the channel (controlled by good_CRC_th,2489 * typical value 1), the scan engine starts transmitting probe requests.2490 *2491 * Driver must use separate scan commands for 2.4 vs. 5 GHz bands.2492 *2493 * To avoid uCode errors, see timing restrictions described under2494 * struct il_scan_channel.2495 */2496 2497struct il3945_scan_cmd {2498 __le16 len;2499 u8 reserved0;2500 u8 channel_count; /* # channels in channel list */2501 __le16 quiet_time; /* dwell only this # millisecs on quiet channel2502 * (only for active scan) */2503 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */2504 __le16 good_CRC_th; /* passive -> active promotion threshold */2505 __le16 reserved1;2506 __le32 max_out_time; /* max usec to be away from associated (service)2507 * channel */2508 __le32 suspend_time; /* pause scan this long (in "extended beacon2509 * format") when returning to service channel:2510 * 3945; 31:24 # beacons, 19:0 additional usec,2511 * 4965; 31:22 # beacons, 21:0 additional usec.2512 */2513 __le32 flags; /* RXON_FLG_* */2514 __le32 filter_flags; /* RXON_FILTER_* */2515 2516 /* For active scans (set to all-0s for passive scans).2517 * Does not include payload. Must specify Tx rate; no rate scaling. */2518 struct il3945_tx_cmd_hdr tx_cmd;2519 2520 /* For directed active scans (set to all-0s otherwise) */2521 struct il_ssid_ie direct_scan[PROBE_OPTION_MAX_3945];2522 2523 /*2524 * Probe request frame, followed by channel list.2525 *2526 * Size of probe request frame is specified by byte count in tx_cmd.2527 * Channel list follows immediately after probe request frame.2528 * Number of channels in list is specified by channel_count.2529 * Each channel in list is of type:2530 *2531 * struct il3945_scan_channel channels[0];2532 *2533 * NOTE: Only one band of channels can be scanned per pass. You2534 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait2535 * for one scan to complete (i.e. receive N_SCAN_COMPLETE)2536 * before requesting another scan.2537 */2538 u8 data[];2539} __packed;2540 2541struct il_scan_cmd {2542 __le16 len;2543 u8 reserved0;2544 u8 channel_count; /* # channels in channel list */2545 __le16 quiet_time; /* dwell only this # millisecs on quiet channel2546 * (only for active scan) */2547 __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */2548 __le16 good_CRC_th; /* passive -> active promotion threshold */2549 __le16 rx_chain; /* RXON_RX_CHAIN_* */2550 __le32 max_out_time; /* max usec to be away from associated (service)2551 * channel */2552 __le32 suspend_time; /* pause scan this long (in "extended beacon2553 * format") when returning to service chnl:2554 * 3945; 31:24 # beacons, 19:0 additional usec,2555 * 4965; 31:22 # beacons, 21:0 additional usec.2556 */2557 __le32 flags; /* RXON_FLG_* */2558 __le32 filter_flags; /* RXON_FILTER_* */2559 2560 /* For active scans (set to all-0s for passive scans).2561 * Does not include payload. Must specify Tx rate; no rate scaling. */2562 struct il_tx_cmd_hdr tx_cmd;2563 2564 /* For directed active scans (set to all-0s otherwise) */2565 struct il_ssid_ie direct_scan[PROBE_OPTION_MAX];2566 2567 /*2568 * Probe request frame, followed by channel list.2569 *2570 * Size of probe request frame is specified by byte count in tx_cmd.2571 * Channel list follows immediately after probe request frame.2572 * Number of channels in list is specified by channel_count.2573 * Each channel in list is of type:2574 *2575 * struct il_scan_channel channels[0];2576 *2577 * NOTE: Only one band of channels can be scanned per pass. You2578 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait2579 * for one scan to complete (i.e. receive N_SCAN_COMPLETE)2580 * before requesting another scan.2581 */2582 u8 data[];2583} __packed;2584 2585/* Can abort will notify by complete notification with abort status. */2586#define CAN_ABORT_STATUS cpu_to_le32(0x1)2587/* complete notification statuses */2588#define ABORT_STATUS 0x22589 2590/*2591 * C_SCAN = 0x80 (response)2592 */2593struct il_scanreq_notification {2594 __le32 status; /* 1: okay, 2: cannot fulfill request */2595} __packed;2596 2597/*2598 * N_SCAN_START = 0x82 (notification only, not a command)2599 */2600struct il_scanstart_notification {2601 __le32 tsf_low;2602 __le32 tsf_high;2603 __le32 beacon_timer;2604 u8 channel;2605 u8 band;2606 u8 reserved[2];2607 __le32 status;2608} __packed;2609 2610#define SCAN_OWNER_STATUS 0x12611#define MEASURE_OWNER_STATUS 0x22612 2613#define IL_PROBE_STATUS_OK 02614#define IL_PROBE_STATUS_TX_FAILED BIT(0)2615/* error statuses combined with TX_FAILED */2616#define IL_PROBE_STATUS_FAIL_TTL BIT(1)2617#define IL_PROBE_STATUS_FAIL_BT BIT(2)2618 2619#define NUMBER_OF_STATS 1 /* first __le32 is good CRC */2620/*2621 * N_SCAN_RESULTS = 0x83 (notification only, not a command)2622 */2623struct il_scanresults_notification {2624 u8 channel;2625 u8 band;2626 u8 probe_status;2627 u8 num_probe_not_sent; /* not enough time to send */2628 __le32 tsf_low;2629 __le32 tsf_high;2630 __le32 stats[NUMBER_OF_STATS];2631} __packed;2632 2633/*2634 * N_SCAN_COMPLETE = 0x84 (notification only, not a command)2635 */2636struct il_scancomplete_notification {2637 u8 scanned_channels;2638 u8 status;2639 u8 last_channel;2640 __le32 tsf_low;2641 __le32 tsf_high;2642} __packed;2643 2644/******************************************************************************2645 * (9)2646 * IBSS/AP Commands and Notifications:2647 *2648 *****************************************************************************/2649 2650enum il_ibss_manager {2651 IL_NOT_IBSS_MANAGER = 0,2652 IL_IBSS_MANAGER = 1,2653};2654 2655/*2656 * N_BEACON = 0x90 (notification only, not a command)2657 */2658 2659struct il3945_beacon_notif {2660 struct il3945_tx_resp beacon_notify_hdr;2661 __le32 low_tsf;2662 __le32 high_tsf;2663 __le32 ibss_mgr_status;2664} __packed;2665 2666struct il4965_beacon_notif {2667 struct il4965_tx_resp beacon_notify_hdr;2668 __le32 low_tsf;2669 __le32 high_tsf;2670 __le32 ibss_mgr_status;2671} __packed;2672 2673/*2674 * C_TX_BEACON= 0x91 (command, has simple generic response)2675 */2676 2677struct il3945_tx_beacon_cmd {2678 struct il3945_tx_cmd_hdr tx;2679 __le16 tim_idx;2680 u8 tim_size;2681 u8 reserved1;2682 struct ieee80211_hdr frame[]; /* beacon frame */2683} __packed;2684 2685struct il_tx_beacon_cmd {2686 struct il_tx_cmd_hdr tx;2687 __le16 tim_idx;2688 u8 tim_size;2689 u8 reserved1;2690 struct ieee80211_hdr frame[]; /* beacon frame */2691} __packed;2692 2693/******************************************************************************2694 * (10)2695 * Statistics Commands and Notifications:2696 *2697 *****************************************************************************/2698 2699#define IL_TEMP_CONVERT 2602700 2701#define SUP_RATE_11A_MAX_NUM_CHANNELS 82702#define SUP_RATE_11B_MAX_NUM_CHANNELS 42703#define SUP_RATE_11G_MAX_NUM_CHANNELS 122704 2705/* Used for passing to driver number of successes and failures per rate */2706struct rate_histogram {2707 union {2708 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];2709 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];2710 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];2711 } success;2712 union {2713 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];2714 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];2715 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];2716 } failed;2717} __packed;2718 2719/* stats command response */2720 2721struct iwl39_stats_rx_phy {2722 __le32 ina_cnt;2723 __le32 fina_cnt;2724 __le32 plcp_err;2725 __le32 crc32_err;2726 __le32 overrun_err;2727 __le32 early_overrun_err;2728 __le32 crc32_good;2729 __le32 false_alarm_cnt;2730 __le32 fina_sync_err_cnt;2731 __le32 sfd_timeout;2732 __le32 fina_timeout;2733 __le32 unresponded_rts;2734 __le32 rxe_frame_limit_overrun;2735 __le32 sent_ack_cnt;2736 __le32 sent_cts_cnt;2737} __packed;2738 2739struct iwl39_stats_rx_non_phy {2740 __le32 bogus_cts; /* CTS received when not expecting CTS */2741 __le32 bogus_ack; /* ACK received when not expecting ACK */2742 __le32 non_bssid_frames; /* number of frames with BSSID that2743 * doesn't belong to the STA BSSID */2744 __le32 filtered_frames; /* count frames that were dumped in the2745 * filtering process */2746 __le32 non_channel_beacons; /* beacons with our bss id but not on2747 * our serving channel */2748} __packed;2749 2750struct iwl39_stats_rx {2751 struct iwl39_stats_rx_phy ofdm;2752 struct iwl39_stats_rx_phy cck;2753 struct iwl39_stats_rx_non_phy general;2754} __packed;2755 2756struct iwl39_stats_tx {2757 __le32 preamble_cnt;2758 __le32 rx_detected_cnt;2759 __le32 bt_prio_defer_cnt;2760 __le32 bt_prio_kill_cnt;2761 __le32 few_bytes_cnt;2762 __le32 cts_timeout;2763 __le32 ack_timeout;2764 __le32 expected_ack_cnt;2765 __le32 actual_ack_cnt;2766} __packed;2767 2768struct stats_dbg {2769 __le32 burst_check;2770 __le32 burst_count;2771 __le32 wait_for_silence_timeout_cnt;2772 __le32 reserved[3];2773} __packed;2774 2775struct iwl39_stats_div {2776 __le32 tx_on_a;2777 __le32 tx_on_b;2778 __le32 exec_time;2779 __le32 probe_time;2780} __packed;2781 2782struct iwl39_stats_general {2783 __le32 temperature;2784 struct stats_dbg dbg;2785 __le32 sleep_time;2786 __le32 slots_out;2787 __le32 slots_idle;2788 __le32 ttl_timestamp;2789 struct iwl39_stats_div div;2790} __packed;2791 2792struct stats_rx_phy {2793 __le32 ina_cnt;2794 __le32 fina_cnt;2795 __le32 plcp_err;2796 __le32 crc32_err;2797 __le32 overrun_err;2798 __le32 early_overrun_err;2799 __le32 crc32_good;2800 __le32 false_alarm_cnt;2801 __le32 fina_sync_err_cnt;2802 __le32 sfd_timeout;2803 __le32 fina_timeout;2804 __le32 unresponded_rts;2805 __le32 rxe_frame_limit_overrun;2806 __le32 sent_ack_cnt;2807 __le32 sent_cts_cnt;2808 __le32 sent_ba_rsp_cnt;2809 __le32 dsp_self_kill;2810 __le32 mh_format_err;2811 __le32 re_acq_main_rssi_sum;2812 __le32 reserved3;2813} __packed;2814 2815struct stats_rx_ht_phy {2816 __le32 plcp_err;2817 __le32 overrun_err;2818 __le32 early_overrun_err;2819 __le32 crc32_good;2820 __le32 crc32_err;2821 __le32 mh_format_err;2822 __le32 agg_crc32_good;2823 __le32 agg_mpdu_cnt;2824 __le32 agg_cnt;2825 __le32 unsupport_mcs;2826} __packed;2827 2828#define INTERFERENCE_DATA_AVAILABLE cpu_to_le32(1)2829 2830struct stats_rx_non_phy {2831 __le32 bogus_cts; /* CTS received when not expecting CTS */2832 __le32 bogus_ack; /* ACK received when not expecting ACK */2833 __le32 non_bssid_frames; /* number of frames with BSSID that2834 * doesn't belong to the STA BSSID */2835 __le32 filtered_frames; /* count frames that were dumped in the2836 * filtering process */2837 __le32 non_channel_beacons; /* beacons with our bss id but not on2838 * our serving channel */2839 __le32 channel_beacons; /* beacons with our bss id and in our2840 * serving channel */2841 __le32 num_missed_bcon; /* number of missed beacons */2842 __le32 adc_rx_saturation_time; /* count in 0.8us units the time the2843 * ADC was in saturation */2844 __le32 ina_detection_search_time; /* total time (in 0.8us) searched2845 * for INA */2846 __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */2847 __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */2848 __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */2849 __le32 interference_data_flag; /* flag for interference data2850 * availability. 1 when data is2851 * available. */2852 __le32 channel_load; /* counts RX Enable time in uSec */2853 __le32 dsp_false_alarms; /* DSP false alarm (both OFDM2854 * and CCK) counter */2855 __le32 beacon_rssi_a;2856 __le32 beacon_rssi_b;2857 __le32 beacon_rssi_c;2858 __le32 beacon_energy_a;2859 __le32 beacon_energy_b;2860 __le32 beacon_energy_c;2861} __packed;2862 2863struct stats_rx {2864 struct stats_rx_phy ofdm;2865 struct stats_rx_phy cck;2866 struct stats_rx_non_phy general;2867 struct stats_rx_ht_phy ofdm_ht;2868} __packed;2869 2870/**2871 * struct stats_tx_power - current tx power2872 *2873 * @ant_a: current tx power on chain a in 1/2 dB step2874 * @ant_b: current tx power on chain b in 1/2 dB step2875 * @ant_c: current tx power on chain c in 1/2 dB step2876 */2877struct stats_tx_power {2878 u8 ant_a;2879 u8 ant_b;2880 u8 ant_c;2881 u8 reserved;2882} __packed;2883 2884struct stats_tx_non_phy_agg {2885 __le32 ba_timeout;2886 __le32 ba_reschedule_frames;2887 __le32 scd_query_agg_frame_cnt;2888 __le32 scd_query_no_agg;2889 __le32 scd_query_agg;2890 __le32 scd_query_mismatch;2891 __le32 frame_not_ready;2892 __le32 underrun;2893 __le32 bt_prio_kill;2894 __le32 rx_ba_rsp_cnt;2895} __packed;2896 2897struct stats_tx {2898 __le32 preamble_cnt;2899 __le32 rx_detected_cnt;2900 __le32 bt_prio_defer_cnt;2901 __le32 bt_prio_kill_cnt;2902 __le32 few_bytes_cnt;2903 __le32 cts_timeout;2904 __le32 ack_timeout;2905 __le32 expected_ack_cnt;2906 __le32 actual_ack_cnt;2907 __le32 dump_msdu_cnt;2908 __le32 burst_abort_next_frame_mismatch_cnt;2909 __le32 burst_abort_missing_next_frame_cnt;2910 __le32 cts_timeout_collision;2911 __le32 ack_or_ba_timeout_collision;2912 struct stats_tx_non_phy_agg agg;2913 2914 __le32 reserved1;2915} __packed;2916 2917struct stats_div {2918 __le32 tx_on_a;2919 __le32 tx_on_b;2920 __le32 exec_time;2921 __le32 probe_time;2922 __le32 reserved1;2923 __le32 reserved2;2924} __packed;2925 2926struct stats_general_common {2927 __le32 temperature; /* radio temperature */2928 struct stats_dbg dbg;2929 __le32 sleep_time;2930 __le32 slots_out;2931 __le32 slots_idle;2932 __le32 ttl_timestamp;2933 struct stats_div div;2934 __le32 rx_enable_counter;2935 /*2936 * num_of_sos_states:2937 * count the number of times we have to re-tune2938 * in order to get out of bad PHY status2939 */2940 __le32 num_of_sos_states;2941} __packed;2942 2943struct stats_general {2944 struct stats_general_common common;2945 __le32 reserved2;2946 __le32 reserved3;2947} __packed;2948 2949#define UCODE_STATS_CLEAR_MSK (0x1 << 0)2950#define UCODE_STATS_FREQUENCY_MSK (0x1 << 1)2951#define UCODE_STATS_NARROW_BAND_MSK (0x1 << 2)2952 2953/*2954 * C_STATS = 0x9c,2955 * all devices identical.2956 *2957 * This command triggers an immediate response containing uCode stats.2958 * The response is in the same format as N_STATS 0x9d, below.2959 *2960 * If the CLEAR_STATS configuration flag is set, uCode will clear its2961 * internal copy of the stats (counters) after issuing the response.2962 * This flag does not affect N_STATSs after beacons (see below).2963 *2964 * If the DISABLE_NOTIF configuration flag is set, uCode will not issue2965 * N_STATSs after received beacons (see below). This flag2966 * does not affect the response to the C_STATS 0x9c itself.2967 */2968#define IL_STATS_CONF_CLEAR_STATS cpu_to_le32(0x1) /* see above */2969#define IL_STATS_CONF_DISABLE_NOTIF cpu_to_le32(0x2) /* see above */2970struct il_stats_cmd {2971 __le32 configuration_flags; /* IL_STATS_CONF_* */2972} __packed;2973 2974/*2975 * N_STATS = 0x9d (notification only, not a command)2976 *2977 * By default, uCode issues this notification after receiving a beacon2978 * while associated. To disable this behavior, set DISABLE_NOTIF flag in the2979 * C_STATS 0x9c, above.2980 *2981 * Statistics counters continue to increment beacon after beacon, but are2982 * cleared when changing channels or when driver issues C_STATS2983 * 0x9c with CLEAR_STATS bit set (see above).2984 *2985 * uCode also issues this notification during scans. uCode clears stats2986 * appropriately so that each notification contains stats for only the2987 * one channel that has just been scanned.2988 */2989#define STATS_REPLY_FLG_BAND_24G_MSK cpu_to_le32(0x2)2990#define STATS_REPLY_FLG_HT40_MODE_MSK cpu_to_le32(0x8)2991 2992struct il3945_notif_stats {2993 __le32 flag;2994 struct iwl39_stats_rx rx;2995 struct iwl39_stats_tx tx;2996 struct iwl39_stats_general general;2997} __packed;2998 2999struct il_notif_stats {3000 __le32 flag;3001 struct stats_rx rx;3002 struct stats_tx tx;3003 struct stats_general general;3004} __packed;3005 3006/*3007 * N_MISSED_BEACONS = 0xa2 (notification only, not a command)3008 *3009 * uCode send N_MISSED_BEACONS to driver when detect beacon missed3010 * in regardless of how many missed beacons, which mean when driver receive the3011 * notification, inside the command, it can find all the beacons information3012 * which include number of total missed beacons, number of consecutive missed3013 * beacons, number of beacons received and number of beacons expected to3014 * receive.3015 *3016 * If uCode detected consecutive_missed_beacons > 5, it will reset the radio3017 * in order to bring the radio/PHY back to working state; which has no relation3018 * to when driver will perform sensitivity calibration.3019 *3020 * Driver should set it own missed_beacon_threshold to decide when to perform3021 * sensitivity calibration based on number of consecutive missed beacons in3022 * order to improve overall performance, especially in noisy environment.3023 *3024 */3025 3026#define IL_MISSED_BEACON_THRESHOLD_MIN (1)3027#define IL_MISSED_BEACON_THRESHOLD_DEF (5)3028#define IL_MISSED_BEACON_THRESHOLD_MAX IL_MISSED_BEACON_THRESHOLD_DEF3029 3030struct il_missed_beacon_notif {3031 __le32 consecutive_missed_beacons;3032 __le32 total_missed_becons;3033 __le32 num_expected_beacons;3034 __le32 num_recvd_beacons;3035} __packed;3036 3037/******************************************************************************3038 * (11)3039 * Rx Calibration Commands:3040 *3041 * With the uCode used for open source drivers, most Tx calibration (except3042 * for Tx Power) and most Rx calibration is done by uCode during the3043 * "initialize" phase of uCode boot. Driver must calibrate only:3044 *3045 * 1) Tx power (depends on temperature), described elsewhere3046 * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas)3047 * 3) Receiver sensitivity (to optimize signal detection)3048 *3049 *****************************************************************************/3050 3051/**3052 * C_SENSITIVITY = 0xa8 (command, has simple generic response)3053 *3054 * This command sets up the Rx signal detector for a sensitivity level that3055 * is high enough to lock onto all signals within the associated network,3056 * but low enough to ignore signals that are below a certain threshold, so as3057 * not to have too many "false alarms". False alarms are signals that the3058 * Rx DSP tries to lock onto, but then discards after determining that they3059 * are noise.3060 *3061 * The optimum number of false alarms is between 5 and 50 per 200 TUs3062 * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.3063 * time listening, not transmitting). Driver must adjust sensitivity so that3064 * the ratio of actual false alarms to actual Rx time falls within this range.3065 *3066 * While associated, uCode delivers N_STATSs after each3067 * received beacon. These provide information to the driver to analyze the3068 * sensitivity. Don't analyze stats that come in from scanning, or any3069 * other non-associated-network source. Pertinent stats include:3070 *3071 * From "general" stats (struct stats_rx_non_phy):3072 *3073 * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)3074 * Measure of energy of desired signal. Used for establishing a level3075 * below which the device does not detect signals.3076 *3077 * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)3078 * Measure of background noise in silent period after beacon.3079 *3080 * channel_load3081 * uSecs of actual Rx time during beacon period (varies according to3082 * how much time was spent transmitting).3083 *3084 * From "cck" and "ofdm" stats (struct stats_rx_phy), separately:3085 *3086 * false_alarm_cnt3087 * Signal locks abandoned early (before phy-level header).3088 *3089 * plcp_err3090 * Signal locks abandoned late (during phy-level header).3091 *3092 * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from3093 * beacon to beacon, i.e. each value is an accumulation of all errors3094 * before and including the latest beacon. Values will wrap around to 03095 * after counting up to 2^32 - 1. Driver must differentiate vs.3096 * previous beacon's values to determine # false alarms in the current3097 * beacon period.3098 *3099 * Total number of false alarms = false_alarms + plcp_errs3100 *3101 * For OFDM, adjust the following table entries in struct il_sensitivity_cmd3102 * (notice that the start points for OFDM are at or close to settings for3103 * maximum sensitivity):3104 *3105 * START / MIN / MAX3106 * HD_AUTO_CORR32_X1_TH_ADD_MIN_IDX 90 / 85 / 1203107 * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_IDX 170 / 170 / 2103108 * HD_AUTO_CORR32_X4_TH_ADD_MIN_IDX 105 / 105 / 1403109 * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_IDX 220 / 220 / 2703110 *3111 * If actual rate of OFDM false alarms (+ plcp_errors) is too high3112 * (greater than 50 for each 204.8 msecs listening), reduce sensitivity3113 * by *adding* 1 to all 4 of the table entries above, up to the max for3114 * each entry. Conversely, if false alarm rate is too low (less than 53115 * for each 204.8 msecs listening), *subtract* 1 from each entry to3116 * increase sensitivity.3117 *3118 * For CCK sensitivity, keep track of the following:3119 *3120 * 1). 20-beacon history of maximum background noise, indicated by3121 * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the3122 * 3 receivers. For any given beacon, the "silence reference" is3123 * the maximum of last 60 samples (20 beacons * 3 receivers).3124 *3125 * 2). 10-beacon history of strongest signal level, as indicated3126 * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,3127 * i.e. the strength of the signal through the best receiver at the3128 * moment. These measurements are "upside down", with lower values3129 * for stronger signals, so max energy will be *minimum* value.3130 *3131 * Then for any given beacon, the driver must determine the *weakest*3132 * of the strongest signals; this is the minimum level that needs to be3133 * successfully detected, when using the best receiver at the moment.3134 * "Max cck energy" is the maximum (higher value means lower energy!)3135 * of the last 10 minima. Once this is determined, driver must add3136 * a little margin by adding "6" to it.3137 *3138 * 3). Number of consecutive beacon periods with too few false alarms.3139 * Reset this to 0 at the first beacon period that falls within the3140 * "good" range (5 to 50 false alarms per 204.8 milliseconds rx).3141 *3142 * Then, adjust the following CCK table entries in struct il_sensitivity_cmd3143 * (notice that the start points for CCK are at maximum sensitivity):3144 *3145 * START / MIN / MAX3146 * HD_AUTO_CORR40_X4_TH_ADD_MIN_IDX 125 / 125 / 2003147 * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_IDX 200 / 200 / 4003148 * HD_MIN_ENERGY_CCK_DET_IDX 100 / 0 / 1003149 *3150 * If actual rate of CCK false alarms (+ plcp_errors) is too high3151 * (greater than 50 for each 204.8 msecs listening), method for reducing3152 * sensitivity is:3153 *3154 * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_IDX,3155 * up to max 400.3156 *3157 * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_IDX is < 160,3158 * sensitivity has been reduced a significant amount; bring it up to3159 * a moderate 161. Otherwise, *add* 3, up to max 200.3160 *3161 * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_IDX is > 160,3162 * sensitivity has been reduced only a moderate or small amount;3163 * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_IDX,3164 * down to min 0. Otherwise (if gain has been significantly reduced),3165 * don't change the HD_MIN_ENERGY_CCK_DET_IDX value.3166 *3167 * b) Save a snapshot of the "silence reference".3168 *3169 * If actual rate of CCK false alarms (+ plcp_errors) is too low3170 * (less than 5 for each 204.8 msecs listening), method for increasing3171 * sensitivity is used only if:3172 *3173 * 1a) Previous beacon did not have too many false alarms3174 * 1b) AND difference between previous "silence reference" and current3175 * "silence reference" (prev - current) is 2 or more,3176 * OR 2) 100 or more consecutive beacon periods have had rate of3177 * less than 5 false alarms per 204.8 milliseconds rx time.3178 *3179 * Method for increasing sensitivity:3180 *3181 * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_IDX,3182 * down to min 125.3183 *3184 * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_IDX,3185 * down to min 200.3186 *3187 * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_IDX, up to max 100.3188 *3189 * If actual rate of CCK false alarms (+ plcp_errors) is within good range3190 * (between 5 and 50 for each 204.8 msecs listening):3191 *3192 * 1) Save a snapshot of the silence reference.3193 *3194 * 2) If previous beacon had too many CCK false alarms (+ plcp_errors),3195 * give some extra margin to energy threshold by *subtracting* 83196 * from value in HD_MIN_ENERGY_CCK_DET_IDX.3197 *3198 * For all cases (too few, too many, good range), make sure that the CCK3199 * detection threshold (energy) is below the energy level for robust3200 * detection over the past 10 beacon periods, the "Max cck energy".3201 * Lower values mean higher energy; this means making sure that the value3202 * in HD_MIN_ENERGY_CCK_DET_IDX is at or *above* "Max cck energy".3203 *3204 */3205 3206/*3207 * Table entries in C_SENSITIVITY (struct il_sensitivity_cmd)3208 */3209#define HD_TBL_SIZE (11) /* number of entries */3210#define HD_MIN_ENERGY_CCK_DET_IDX (0) /* table idxes */3211#define HD_MIN_ENERGY_OFDM_DET_IDX (1)3212#define HD_AUTO_CORR32_X1_TH_ADD_MIN_IDX (2)3213#define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_IDX (3)3214#define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_IDX (4)3215#define HD_AUTO_CORR32_X4_TH_ADD_MIN_IDX (5)3216#define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_IDX (6)3217#define HD_BARKER_CORR_TH_ADD_MIN_IDX (7)3218#define HD_BARKER_CORR_TH_ADD_MIN_MRC_IDX (8)3219#define HD_AUTO_CORR40_X4_TH_ADD_MIN_IDX (9)3220#define HD_OFDM_ENERGY_TH_IN_IDX (10)3221 3222/* Control field in struct il_sensitivity_cmd */3223#define C_SENSITIVITY_CONTROL_DEFAULT_TBL cpu_to_le16(0)3224#define C_SENSITIVITY_CONTROL_WORK_TBL cpu_to_le16(1)3225 3226/**3227 * struct il_sensitivity_cmd3228 * @control: (1) updates working table, (0) updates default table3229 * @table: energy threshold values, use HD_* as idx into table3230 *3231 * Always use "1" in "control" to update uCode's working table and DSP.3232 */3233struct il_sensitivity_cmd {3234 __le16 control; /* always use "1" */3235 __le16 table[HD_TBL_SIZE]; /* use HD_* as idx */3236} __packed;3237 3238/**3239 * C_PHY_CALIBRATION = 0xb0 (command, has simple generic response)3240 *3241 * This command sets the relative gains of 4965 device's 3 radio receiver chains.3242 *3243 * After the first association, driver should accumulate signal and noise3244 * stats from the N_STATSs that follow the first 203245 * beacons from the associated network (don't collect stats that come3246 * in from scanning, or any other non-network source).3247 *3248 * DISCONNECTED ANTENNA:3249 *3250 * Driver should determine which antennas are actually connected, by comparing3251 * average beacon signal levels for the 3 Rx chains. Accumulate (add) the3252 * following values over 20 beacons, one accumulator for each of the chains3253 * a/b/c, from struct stats_rx_non_phy:3254 *3255 * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)3256 *3257 * Find the strongest signal from among a/b/c. Compare the other two to the3258 * strongest. If any signal is more than 15 dB (times 20, unless you3259 * divide the accumulated values by 20) below the strongest, the driver3260 * considers that antenna to be disconnected, and should not try to use that3261 * antenna/chain for Rx or Tx. If both A and B seem to be disconnected,3262 * driver should declare the stronger one as connected, and attempt to use it3263 * (A and B are the only 2 Tx chains!).3264 *3265 *3266 * RX BALANCE:3267 *3268 * Driver should balance the 3 receivers (but just the ones that are connected3269 * to antennas, see above) for gain, by comparing the average signal levels3270 * detected during the silence after each beacon (background noise).3271 * Accumulate (add) the following values over 20 beacons, one accumulator for3272 * each of the chains a/b/c, from struct stats_rx_non_phy:3273 *3274 * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)3275 *3276 * Find the weakest background noise level from among a/b/c. This Rx chain3277 * will be the reference, with 0 gain adjustment. Attenuate other channels by3278 * finding noise difference:3279 *3280 * (accum_noise[i] - accum_noise[reference]) / 303281 *3282 * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.3283 * For use in diff_gain_[abc] fields of struct il_calibration_cmd, the3284 * driver should limit the difference results to a range of 0-3 (0-4.5 dB),3285 * and set bit 2 to indicate "reduce gain". The value for the reference3286 * (weakest) chain should be "0".3287 *3288 * diff_gain_[abc] bit fields:3289 * 2: (1) reduce gain, (0) increase gain3290 * 1-0: amount of gain, units of 1.5 dB3291 */3292 3293/* Phy calibration command for series */3294/* The default calibrate table size if not specified by firmware */3295#define IL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 183296enum {3297 IL_PHY_CALIBRATE_DIFF_GAIN_CMD = 7,3298 IL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE = 19,3299};3300 3301#define IL_MAX_PHY_CALIBRATE_TBL_SIZE (253)3302 3303struct il_calib_hdr {3304 u8 op_code;3305 u8 first_group;3306 u8 groups_num;3307 u8 data_valid;3308} __packed;3309 3310/* IL_PHY_CALIBRATE_DIFF_GAIN_CMD (7) */3311struct il_calib_diff_gain_cmd {3312 struct il_calib_hdr hdr;3313 s8 diff_gain_a; /* see above */3314 s8 diff_gain_b;3315 s8 diff_gain_c;3316 u8 reserved1;3317} __packed;3318 3319/******************************************************************************3320 * (12)3321 * Miscellaneous Commands:3322 *3323 *****************************************************************************/3324 3325/*3326 * LEDs Command & Response3327 * C_LEDS = 0x48 (command, has simple generic response)3328 *3329 * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),3330 * this command turns it on or off, or sets up a periodic blinking cycle.3331 */3332struct il_led_cmd {3333 __le32 interval; /* "interval" in uSec */3334 u8 id; /* 1: Activity, 2: Link, 3: Tech */3335 u8 off; /* # intervals off while blinking;3336 * "0", with >0 "on" value, turns LED on */3337 u8 on; /* # intervals on while blinking;3338 * "0", regardless of "off", turns LED off */3339 u8 reserved;3340} __packed;3341 3342/******************************************************************************3343 * (13)3344 * Union of all expected notifications/responses:3345 *3346 *****************************************************************************/3347 3348#define IL_RX_FRAME_SIZE_MSK 0x00003fff3349 3350struct il_rx_pkt {3351 /*3352 * The first 4 bytes of the RX frame header contain both the RX frame3353 * size and some flags.3354 * Bit fields:3355 * 31: flag flush RB request3356 * 30: flag ignore TC (terminal counter) request3357 * 29: flag fast IRQ request3358 * 28-14: Reserved3359 * 13-00: RX frame size3360 */3361 __le32 len_n_flags;3362 struct il_cmd_header hdr;3363 union {3364 struct il3945_rx_frame rx_frame;3365 struct il3945_tx_resp tx_resp;3366 struct il3945_beacon_notif beacon_status;3367 3368 struct il_alive_resp alive_frame;3369 struct il_spectrum_notification spectrum_notif;3370 struct il_csa_notification csa_notif;3371 struct il_error_resp err_resp;3372 struct il_card_state_notif card_state_notif;3373 struct il_add_sta_resp add_sta;3374 struct il_rem_sta_resp rem_sta;3375 struct il_sleep_notification sleep_notif;3376 struct il_spectrum_resp spectrum;3377 struct il_notif_stats stats;3378 struct il_compressed_ba_resp compressed_ba;3379 struct il_missed_beacon_notif missed_beacon;3380 __le32 status;3381 DECLARE_FLEX_ARRAY(u8, raw);3382 } u;3383} __packed;3384 3385#endif /* __il_commands_h__ */3386