| 1 | /****************************************************************************** |
| 2 | * |
| 3 | * This file is provided under a dual BSD/GPLv2 license. When using or |
| 4 | * redistributing this file, you may do so under either license. |
| 5 | * |
| 6 | * GPL LICENSE SUMMARY |
| 7 | * |
| 8 | * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved. |
| 9 | * |
| 10 | * This program is free software; you can redistribute it and/or modify |
| 11 | * it under the terms of version 2 of the GNU General Public License as |
| 12 | * published by the Free Software Foundation. |
| 13 | * |
| 14 | * This program is distributed in the hope that it will be useful, but |
| 15 | * WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 17 | * General Public License for more details. |
| 18 | * |
| 19 | * You should have received a copy of the GNU General Public License |
| 20 | * along with this program; if not, write to the Free Software |
| 21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, |
| 22 | * USA |
| 23 | * |
| 24 | * The full GNU General Public License is included in this distribution |
| 25 | * in the file called LICENSE.GPL. |
| 26 | * |
| 27 | * Contact Information: |
| 28 | * Intel Linux Wireless <ilw@linux.intel.com> |
| 29 | * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 |
| 30 | * |
| 31 | * BSD LICENSE |
| 32 | * |
| 33 | * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved. |
| 34 | * All rights reserved. |
| 35 | * |
| 36 | * Redistribution and use in source and binary forms, with or without |
| 37 | * modification, are permitted provided that the following conditions |
| 38 | * are met: |
| 39 | * |
| 40 | * * Redistributions of source code must retain the above copyright |
| 41 | * notice, this list of conditions and the following disclaimer. |
| 42 | * * Redistributions in binary form must reproduce the above copyright |
| 43 | * notice, this list of conditions and the following disclaimer in |
| 44 | * the documentation and/or other materials provided with the |
| 45 | * distribution. |
| 46 | * * Neither the name Intel Corporation nor the names of its |
| 47 | * contributors may be used to endorse or promote products derived |
| 48 | * from this software without specific prior written permission. |
| 49 | * |
| 50 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 51 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 52 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 53 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 54 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 55 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 56 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 57 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 58 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 59 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 60 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 61 | * |
| 62 | *****************************************************************************/ |
| 63 | |
| 64 | #ifndef __il_commands_h__ |
| 65 | #define __il_commands_h__ |
| 66 | |
| 67 | #include <linux/ieee80211.h> |
| 68 | |
| 69 | struct 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 4 |
| 79 | #define IL_OFDM_RATES 8 |
| 80 | #define IL_MAX_RATES (IL_CCK_RATES + IL_OFDM_RATES) |
| 81 | |
| 82 | enum { |
| 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 = 0xff |
| 153 | }; |
| 154 | |
| 155 | /****************************************************************************** |
| 156 | * (0) |
| 157 | * Commonly used structures and definitions: |
| 158 | * Command header, rate_n_flags, txpower |
| 159 | * |
| 160 | *****************************************************************************/ |
| 161 | |
| 162 | /* il_cmd_header flags value */ |
| 163 | #define IL_CMD_FAILED_MSK 0x40 |
| 164 | |
| 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_header |
| 174 | * |
| 175 | * This header format appears in the beginning of each command sent from the |
| 176 | * driver, and each response/notification received from uCode. |
| 177 | */ |
| 178 | struct 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 driver |
| 184 | * when sending the response to each driver-originated command, so |
| 185 | * the driver can match the response to the command. Since the values |
| 186 | * 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 originates |
| 189 | * the response/notification, i.e. when the response/notification |
| 190 | * is not a direct response to a command sent by the driver. For |
| 191 | * example, uCode issues N_3945_RX when it sends a received frame |
| 192 | * 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 queue |
| 197 | * 8:12 TX queue id |
| 198 | * 13 reserved |
| 199 | * 14 huge - driver sets this to indicate command is in the |
| 200 | * 'huge' storage at the end of the command buffers |
| 201 | * 15 unsolicited RX or uCode-originated notification |
| 202 | */ |
| 203 | __le16 sequence; |
| 204 | |
| 205 | /* command or response/notification data follows immediately */ |
| 206 | u8 data[0]; |
| 207 | } __packed; |
| 208 | |
| 209 | /** |
| 210 | * struct il3945_tx_power |
| 211 | * |
| 212 | * Used in C_TX_PWR_TBL, C_SCAN, C_CHANNEL_SWITCH |
| 213 | * |
| 214 | * Each entry contains two values: |
| 215 | * 1) DSP gain (or sometimes called DSP attenuation). This is a fine-grained |
| 216 | * linear value that multiplies the output of the digital signal processor, |
| 217 | * before being sent to the analog radio. |
| 218 | * 2) Radio gain. This sets the analog gain of the radio Tx path. |
| 219 | * It is a coarser setting, and behaves in a logarithmic (dB) fashion. |
| 220 | * |
| 221 | * Driver obtains values from struct il3945_tx_power power_gain_table[][]. |
| 222 | */ |
| 223 | struct il3945_tx_power { |
| 224 | u8 tx_gain; /* gain for analog radio */ |
| 225 | u8 dsp_atten; /* gain for DSP */ |
| 226 | } __packed; |
| 227 | |
| 228 | /** |
| 229 | * struct il3945_power_per_rate |
| 230 | * |
| 231 | * Used in C_TX_PWR_TBL, C_CHANNEL_SWITCH |
| 232 | */ |
| 233 | struct il3945_power_per_rate { |
| 234 | u8 rate; /* plcp */ |
| 235 | struct il3945_tx_power tpc; |
| 236 | u8 reserved; |
| 237 | } __packed; |
| 238 | |
| 239 | /** |
| 240 | * iwl4965 rate_n_flags bit fields |
| 241 | * |
| 242 | * rate_n_flags format is used in following iwl4965 commands: |
| 243 | * N_RX (response only) |
| 244 | * N_RX_MPDU (response only) |
| 245 | * C_TX (both command and response) |
| 246 | * C_TX_LINK_QUALITY_CMD |
| 247 | * |
| 248 | * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"): |
| 249 | * 2-0: 0) 6 Mbps |
| 250 | * 1) 12 Mbps |
| 251 | * 2) 18 Mbps |
| 252 | * 3) 24 Mbps |
| 253 | * 4) 36 Mbps |
| 254 | * 5) 48 Mbps |
| 255 | * 6) 54 Mbps |
| 256 | * 7) 60 Mbps |
| 257 | * |
| 258 | * 4-3: 0) Single stream (SISO) |
| 259 | * 1) Dual stream (MIMO) |
| 260 | * 2) Triple stream (MIMO) |
| 261 | * |
| 262 | * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data |
| 263 | * |
| 264 | * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"): |
| 265 | * 3-0: 0xD) 6 Mbps |
| 266 | * 0xF) 9 Mbps |
| 267 | * 0x5) 12 Mbps |
| 268 | * 0x7) 18 Mbps |
| 269 | * 0x9) 24 Mbps |
| 270 | * 0xB) 36 Mbps |
| 271 | * 0x1) 48 Mbps |
| 272 | * 0x3) 54 Mbps |
| 273 | * |
| 274 | * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"): |
| 275 | * 6-0: 10) 1 Mbps |
| 276 | * 20) 2 Mbps |
| 277 | * 55) 5.5 Mbps |
| 278 | * 110) 11 Mbps |
| 279 | */ |
| 280 | #define RATE_MCS_CODE_MSK 0x7 |
| 281 | #define RATE_MCS_SPATIAL_POS 3 |
| 282 | #define RATE_MCS_SPATIAL_MSK 0x18 |
| 283 | #define RATE_MCS_HT_DUP_POS 5 |
| 284 | #define RATE_MCS_HT_DUP_MSK 0x20 |
| 285 | |
| 286 | /* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */ |
| 287 | #define RATE_MCS_FLAGS_POS 8 |
| 288 | #define RATE_MCS_HT_POS 8 |
| 289 | #define RATE_MCS_HT_MSK 0x100 |
| 290 | |
| 291 | /* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */ |
| 292 | #define RATE_MCS_CCK_POS 9 |
| 293 | #define RATE_MCS_CCK_MSK 0x200 |
| 294 | |
| 295 | /* Bit 10: (1) Use Green Field preamble */ |
| 296 | #define RATE_MCS_GF_POS 10 |
| 297 | #define RATE_MCS_GF_MSK 0x400 |
| 298 | |
| 299 | /* Bit 11: (1) Use 40Mhz HT40 chnl width, (0) use 20 MHz legacy chnl width */ |
| 300 | #define RATE_MCS_HT40_POS 11 |
| 301 | #define RATE_MCS_HT40_MSK 0x800 |
| 302 | |
| 303 | /* Bit 12: (1) Duplicate data on both 20MHz chnls. HT40 (bit 11) must be set. */ |
| 304 | #define RATE_MCS_DUP_POS 12 |
| 305 | #define RATE_MCS_DUP_MSK 0x1000 |
| 306 | |
| 307 | /* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */ |
| 308 | #define RATE_MCS_SGI_POS 13 |
| 309 | #define RATE_MCS_SGI_MSK 0x2000 |
| 310 | |
| 311 | /** |
| 312 | * rate_n_flags Tx antenna masks |
| 313 | * 4965 has 2 transmitters |
| 314 | * bit14:16 |
| 315 | */ |
| 316 | #define RATE_MCS_ANT_POS 14 |
| 317 | #define RATE_MCS_ANT_A_MSK 0x04000 |
| 318 | #define RATE_MCS_ANT_B_MSK 0x08000 |
| 319 | #define RATE_MCS_ANT_C_MSK 0x10000 |
| 320 | #define RATE_MCS_ANT_AB_MSK (RATE_MCS_ANT_A_MSK | RATE_MCS_ANT_B_MSK) |
| 321 | #define RATE_MCS_ANT_ABC_MSK (RATE_MCS_ANT_AB_MSK | RATE_MCS_ANT_C_MSK) |
| 322 | #define RATE_ANT_NUM 3 |
| 323 | |
| 324 | #define POWER_TBL_NUM_ENTRIES 33 |
| 325 | #define POWER_TBL_NUM_HT_OFDM_ENTRIES 32 |
| 326 | #define POWER_TBL_CCK_ENTRY 32 |
| 327 | |
| 328 | #define IL_PWR_NUM_HT_OFDM_ENTRIES 24 |
| 329 | #define IL_PWR_CCK_ENTRIES 2 |
| 330 | |
| 331 | /** |
| 332 | * union il4965_tx_power_dual_stream |
| 333 | * |
| 334 | * Host format used for C_TX_PWR_TBL, C_CHANNEL_SWITCH |
| 335 | * Use __le32 version (struct tx_power_dual_stream) when building command. |
| 336 | * |
| 337 | * Driver provides radio gain and DSP attenuation settings to device in pairs, |
| 338 | * one value for each transmitter chain. The first value is for transmitter A, |
| 339 | * second for transmitter B. |
| 340 | * |
| 341 | * For SISO bit rates, both values in a pair should be identical. |
| 342 | * For MIMO rates, one value may be different from the other, |
| 343 | * in order to balance the Tx output between the two transmitters. |
| 344 | * |
| 345 | * See more details in doc for TXPOWER in 4965.h. |
| 346 | */ |
| 347 | union il4965_tx_power_dual_stream { |
| 348 | struct { |
| 349 | u8 radio_tx_gain[2]; |
| 350 | u8 dsp_predis_atten[2]; |
| 351 | } s; |
| 352 | u32 dw; |
| 353 | }; |
| 354 | |
| 355 | /** |
| 356 | * struct tx_power_dual_stream |
| 357 | * |
| 358 | * Table entries in C_TX_PWR_TBL, C_CHANNEL_SWITCH |
| 359 | * |
| 360 | * Same format as il_tx_power_dual_stream, but __le32 |
| 361 | */ |
| 362 | struct tx_power_dual_stream { |
| 363 | __le32 dw; |
| 364 | } __packed; |
| 365 | |
| 366 | /** |
| 367 | * struct il4965_tx_power_db |
| 368 | * |
| 369 | * Entire table within C_TX_PWR_TBL, C_CHANNEL_SWITCH |
| 370 | */ |
| 371 | struct il4965_tx_power_db { |
| 372 | struct tx_power_dual_stream power_tbl[POWER_TBL_NUM_ENTRIES]; |
| 373 | } __packed; |
| 374 | |
| 375 | /****************************************************************************** |
| 376 | * (0a) |
| 377 | * Alive and Error Commands & Responses: |
| 378 | * |
| 379 | *****************************************************************************/ |
| 380 | |
| 381 | #define UCODE_VALID_OK cpu_to_le32(0x1) |
| 382 | #define INITIALIZE_SUBTYPE (9) |
| 383 | |
| 384 | /* |
| 385 | * ("Initialize") N_ALIVE = 0x1 (response only, not a command) |
| 386 | * |
| 387 | * uCode issues this "initialize alive" notification once the initialization |
| 388 | * uCode image has completed its work, and is ready to load the runtime image. |
| 389 | * This is the *first* "alive" notification that the driver will receive after |
| 390 | * rebooting uCode; the "initialize" alive is indicated by subtype field == 9. |
| 391 | * |
| 392 | * See comments documenting "BSM" (bootstrap state machine). |
| 393 | * |
| 394 | * For 4965, this notification contains important calibration data for |
| 395 | * calculating txpower settings: |
| 396 | * |
| 397 | * 1) Power supply voltage indication. The voltage sensor outputs higher |
| 398 | * values for lower voltage, and vice verse. |
| 399 | * |
| 400 | * 2) Temperature measurement parameters, for each of two channel widths |
| 401 | * (20 MHz and 40 MHz) supported by the radios. Temperature sensing |
| 402 | * is done via one of the receiver chains, and channel width influences |
| 403 | * the results. |
| 404 | * |
| 405 | * 3) Tx gain compensation to balance 4965's 2 Tx chains for MIMO operation, |
| 406 | * for each of 5 frequency ranges. |
| 407 | */ |
| 408 | struct il_init_alive_resp { |
| 409 | u8 ucode_minor; |
| 410 | u8 ucode_major; |
| 411 | __le16 reserved1; |
| 412 | u8 sw_rev[8]; |
| 413 | u8 ver_type; |
| 414 | u8 ver_subtype; /* "9" for initialize alive */ |
| 415 | __le16 reserved2; |
| 416 | __le32 log_event_table_ptr; |
| 417 | __le32 error_event_table_ptr; |
| 418 | __le32 timestamp; |
| 419 | __le32 is_valid; |
| 420 | |
| 421 | /* calibration values from "initialize" uCode */ |
| 422 | __le32 voltage; /* signed, higher value is lower voltage */ |
| 423 | __le32 therm_r1[2]; /* signed, 1st for normal, 2nd for HT40 */ |
| 424 | __le32 therm_r2[2]; /* signed */ |
| 425 | __le32 therm_r3[2]; /* signed */ |
| 426 | __le32 therm_r4[2]; /* signed */ |
| 427 | __le32 tx_atten[5][2]; /* signed MIMO gain comp, 5 freq groups, |
| 428 | * 2 Tx chains */ |
| 429 | } __packed; |
| 430 | |
| 431 | /** |
| 432 | * N_ALIVE = 0x1 (response only, not a command) |
| 433 | * |
| 434 | * uCode issues this "alive" notification once the runtime image is ready |
| 435 | * to receive commands from the driver. This is the *second* "alive" |
| 436 | * notification that the driver will receive after rebooting uCode; |
| 437 | * this "alive" is indicated by subtype field != 9. |
| 438 | * |
| 439 | * See comments documenting "BSM" (bootstrap state machine). |
| 440 | * |
| 441 | * This response includes two pointers to structures within the device's |
| 442 | * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging: |
| 443 | * |
| 444 | * 1) log_event_table_ptr indicates base of the event log. This traces |
| 445 | * a 256-entry history of uCode execution within a circular buffer. |
| 446 | * Its header format is: |
| 447 | * |
| 448 | * __le32 log_size; log capacity (in number of entries) |
| 449 | * __le32 type; (1) timestamp with each entry, (0) no timestamp |
| 450 | * __le32 wraps; # times uCode has wrapped to top of circular buffer |
| 451 | * __le32 write_idx; next circular buffer entry that uCode would fill |
| 452 | * |
| 453 | * The header is followed by the circular buffer of log entries. Entries |
| 454 | * with timestamps have the following format: |
| 455 | * |
| 456 | * __le32 event_id; range 0 - 1500 |
| 457 | * __le32 timestamp; low 32 bits of TSF (of network, if associated) |
| 458 | * __le32 data; event_id-specific data value |
| 459 | * |
| 460 | * Entries without timestamps contain only event_id and data. |
| 461 | * |
| 462 | * |
| 463 | * 2) error_event_table_ptr indicates base of the error log. This contains |
| 464 | * information about any uCode error that occurs. For 4965, the format |
| 465 | * of the error log is: |
| 466 | * |
| 467 | * __le32 valid; (nonzero) valid, (0) log is empty |
| 468 | * __le32 error_id; type of error |
| 469 | * __le32 pc; program counter |
| 470 | * __le32 blink1; branch link |
| 471 | * __le32 blink2; branch link |
| 472 | * __le32 ilink1; interrupt link |
| 473 | * __le32 ilink2; interrupt link |
| 474 | * __le32 data1; error-specific data |
| 475 | * __le32 data2; error-specific data |
| 476 | * __le32 line; source code line of error |
| 477 | * __le32 bcon_time; beacon timer |
| 478 | * __le32 tsf_low; network timestamp function timer |
| 479 | * __le32 tsf_hi; network timestamp function timer |
| 480 | * __le32 gp1; GP1 timer register |
| 481 | * __le32 gp2; GP2 timer register |
| 482 | * __le32 gp3; GP3 timer register |
| 483 | * __le32 ucode_ver; uCode version |
| 484 | * __le32 hw_ver; HW Silicon version |
| 485 | * __le32 brd_ver; HW board version |
| 486 | * __le32 log_pc; log program counter |
| 487 | * __le32 frame_ptr; frame pointer |
| 488 | * __le32 stack_ptr; stack pointer |
| 489 | * __le32 hcmd; last host command |
| 490 | * __le32 isr0; isr status register LMPM_NIC_ISR0: rxtx_flag |
| 491 | * __le32 isr1; isr status register LMPM_NIC_ISR1: host_flag |
| 492 | * __le32 isr2; isr status register LMPM_NIC_ISR2: enc_flag |
| 493 | * __le32 isr3; isr status register LMPM_NIC_ISR3: time_flag |
| 494 | * __le32 isr4; isr status register LMPM_NIC_ISR4: wico interrupt |
| 495 | * __le32 isr_pref; isr status register LMPM_NIC_PREF_STAT |
| 496 | * __le32 wait_event; wait event() caller address |
| 497 | * __le32 l2p_control; L2pControlField |
| 498 | * __le32 l2p_duration; L2pDurationField |
| 499 | * __le32 l2p_mhvalid; L2pMhValidBits |
| 500 | * __le32 l2p_addr_match; L2pAddrMatchStat |
| 501 | * __le32 lmpm_pmg_sel; indicate which clocks are turned on (LMPM_PMG_SEL) |
| 502 | * __le32 u_timestamp; indicate when the date and time of the compilation |
| 503 | * __le32 reserved; |
| 504 | * |
| 505 | * The Linux driver can print both logs to the system log when a uCode error |
| 506 | * occurs. |
| 507 | */ |
| 508 | struct il_alive_resp { |
| 509 | u8 ucode_minor; |
| 510 | u8 ucode_major; |
| 511 | __le16 reserved1; |
| 512 | u8 sw_rev[8]; |
| 513 | u8 ver_type; |
| 514 | u8 ver_subtype; /* not "9" for runtime alive */ |
| 515 | __le16 reserved2; |
| 516 | __le32 log_event_table_ptr; /* SRAM address for event log */ |
| 517 | __le32 error_event_table_ptr; /* SRAM address for error log */ |
| 518 | __le32 timestamp; |
| 519 | __le32 is_valid; |
| 520 | } __packed; |
| 521 | |
| 522 | /* |
| 523 | * N_ERROR = 0x2 (response only, not a command) |
| 524 | */ |
| 525 | struct il_error_resp { |
| 526 | __le32 error_type; |
| 527 | u8 cmd_id; |
| 528 | u8 reserved1; |
| 529 | __le16 bad_cmd_seq_num; |
| 530 | __le32 error_info; |
| 531 | __le64 timestamp; |
| 532 | } __packed; |
| 533 | |
| 534 | /****************************************************************************** |
| 535 | * (1) |
| 536 | * RXON Commands & Responses: |
| 537 | * |
| 538 | *****************************************************************************/ |
| 539 | |
| 540 | /* |
| 541 | * Rx config defines & structure |
| 542 | */ |
| 543 | /* rx_config device types */ |
| 544 | enum { |
| 545 | RXON_DEV_TYPE_AP = 1, |
| 546 | RXON_DEV_TYPE_ESS = 3, |
| 547 | RXON_DEV_TYPE_IBSS = 4, |
| 548 | RXON_DEV_TYPE_SNIFFER = 6, |
| 549 | }; |
| 550 | |
| 551 | #define RXON_RX_CHAIN_DRIVER_FORCE_MSK cpu_to_le16(0x1 << 0) |
| 552 | #define RXON_RX_CHAIN_DRIVER_FORCE_POS (0) |
| 553 | #define RXON_RX_CHAIN_VALID_MSK cpu_to_le16(0x7 << 1) |
| 554 | #define RXON_RX_CHAIN_VALID_POS (1) |
| 555 | #define RXON_RX_CHAIN_FORCE_SEL_MSK cpu_to_le16(0x7 << 4) |
| 556 | #define RXON_RX_CHAIN_FORCE_SEL_POS (4) |
| 557 | #define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK cpu_to_le16(0x7 << 7) |
| 558 | #define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7) |
| 559 | #define RXON_RX_CHAIN_CNT_MSK cpu_to_le16(0x3 << 10) |
| 560 | #define RXON_RX_CHAIN_CNT_POS (10) |
| 561 | #define RXON_RX_CHAIN_MIMO_CNT_MSK cpu_to_le16(0x3 << 12) |
| 562 | #define RXON_RX_CHAIN_MIMO_CNT_POS (12) |
| 563 | #define RXON_RX_CHAIN_MIMO_FORCE_MSK cpu_to_le16(0x1 << 14) |
| 564 | #define RXON_RX_CHAIN_MIMO_FORCE_POS (14) |
| 565 | |
| 566 | /* rx_config flags */ |
| 567 | /* band & modulation selection */ |
| 568 | #define RXON_FLG_BAND_24G_MSK cpu_to_le32(1 << 0) |
| 569 | #define RXON_FLG_CCK_MSK cpu_to_le32(1 << 1) |
| 570 | /* auto detection enable */ |
| 571 | #define RXON_FLG_AUTO_DETECT_MSK cpu_to_le32(1 << 2) |
| 572 | /* TGg protection when tx */ |
| 573 | #define RXON_FLG_TGG_PROTECT_MSK cpu_to_le32(1 << 3) |
| 574 | /* cck short slot & preamble */ |
| 575 | #define RXON_FLG_SHORT_SLOT_MSK cpu_to_le32(1 << 4) |
| 576 | #define RXON_FLG_SHORT_PREAMBLE_MSK cpu_to_le32(1 << 5) |
| 577 | /* antenna selection */ |
| 578 | #define RXON_FLG_DIS_DIV_MSK cpu_to_le32(1 << 7) |
| 579 | #define RXON_FLG_ANT_SEL_MSK cpu_to_le32(0x0f00) |
| 580 | #define RXON_FLG_ANT_A_MSK cpu_to_le32(1 << 8) |
| 581 | #define RXON_FLG_ANT_B_MSK cpu_to_le32(1 << 9) |
| 582 | /* radar detection enable */ |
| 583 | #define RXON_FLG_RADAR_DETECT_MSK cpu_to_le32(1 << 12) |
| 584 | #define RXON_FLG_TGJ_NARROW_BAND_MSK cpu_to_le32(1 << 13) |
| 585 | /* rx response to host with 8-byte TSF |
| 586 | * (according to ON_AIR deassertion) */ |
| 587 | #define RXON_FLG_TSF2HOST_MSK cpu_to_le32(1 << 15) |
| 588 | |
| 589 | /* HT flags */ |
| 590 | #define RXON_FLG_CTRL_CHANNEL_LOC_POS (22) |
| 591 | #define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK cpu_to_le32(0x1 << 22) |
| 592 | |
| 593 | #define RXON_FLG_HT_OPERATING_MODE_POS (23) |
| 594 | |
| 595 | #define RXON_FLG_HT_PROT_MSK cpu_to_le32(0x1 << 23) |
| 596 | #define RXON_FLG_HT40_PROT_MSK cpu_to_le32(0x2 << 23) |
| 597 | |
| 598 | #define RXON_FLG_CHANNEL_MODE_POS (25) |
| 599 | #define RXON_FLG_CHANNEL_MODE_MSK cpu_to_le32(0x3 << 25) |
| 600 | |
| 601 | /* channel mode */ |
| 602 | enum { |
| 603 | CHANNEL_MODE_LEGACY = 0, |
| 604 | CHANNEL_MODE_PURE_40 = 1, |
| 605 | CHANNEL_MODE_MIXED = 2, |
| 606 | CHANNEL_MODE_RESERVED = 3, |
| 607 | }; |
| 608 | #define RXON_FLG_CHANNEL_MODE_LEGACY \ |
| 609 | cpu_to_le32(CHANNEL_MODE_LEGACY << RXON_FLG_CHANNEL_MODE_POS) |
| 610 | #define RXON_FLG_CHANNEL_MODE_PURE_40 \ |
| 611 | cpu_to_le32(CHANNEL_MODE_PURE_40 << RXON_FLG_CHANNEL_MODE_POS) |
| 612 | #define RXON_FLG_CHANNEL_MODE_MIXED \ |
| 613 | cpu_to_le32(CHANNEL_MODE_MIXED << RXON_FLG_CHANNEL_MODE_POS) |
| 614 | |
| 615 | /* CTS to self (if spec allows) flag */ |
| 616 | #define RXON_FLG_SELF_CTS_EN cpu_to_le32(0x1<<30) |
| 617 | |
| 618 | /* rx_config filter flags */ |
| 619 | /* accept all data frames */ |
| 620 | #define RXON_FILTER_PROMISC_MSK cpu_to_le32(1 << 0) |
| 621 | /* pass control & management to host */ |
| 622 | #define RXON_FILTER_CTL2HOST_MSK cpu_to_le32(1 << 1) |
| 623 | /* accept multi-cast */ |
| 624 | #define RXON_FILTER_ACCEPT_GRP_MSK cpu_to_le32(1 << 2) |
| 625 | /* don't decrypt uni-cast frames */ |
| 626 | #define RXON_FILTER_DIS_DECRYPT_MSK cpu_to_le32(1 << 3) |
| 627 | /* don't decrypt multi-cast frames */ |
| 628 | #define RXON_FILTER_DIS_GRP_DECRYPT_MSK cpu_to_le32(1 << 4) |
| 629 | /* STA is associated */ |
| 630 | #define RXON_FILTER_ASSOC_MSK cpu_to_le32(1 << 5) |
| 631 | /* transfer to host non bssid beacons in associated state */ |
| 632 | #define RXON_FILTER_BCON_AWARE_MSK cpu_to_le32(1 << 6) |
| 633 | |
| 634 | /** |
| 635 | * C_RXON = 0x10 (command, has simple generic response) |
| 636 | * |
| 637 | * RXON tunes the radio tuner to a service channel, and sets up a number |
| 638 | * of parameters that are used primarily for Rx, but also for Tx operations. |
| 639 | * |
| 640 | * NOTE: When tuning to a new channel, driver must set the |
| 641 | * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent |
| 642 | * info within the device, including the station tables, tx retry |
| 643 | * rate tables, and txpower tables. Driver must build a new station |
| 644 | * table and txpower table before transmitting anything on the RXON |
| 645 | * channel. |
| 646 | * |
| 647 | * NOTE: All RXONs wipe clean the internal txpower table. Driver must |
| 648 | * issue a new C_TX_PWR_TBL after each C_RXON (0x10), |
| 649 | * regardless of whether RXON_FILTER_ASSOC_MSK is set. |
| 650 | */ |
| 651 | |
| 652 | struct il3945_rxon_cmd { |
| 653 | u8 node_addr[6]; |
| 654 | __le16 reserved1; |
| 655 | u8 bssid_addr[6]; |
| 656 | __le16 reserved2; |
| 657 | u8 wlap_bssid_addr[6]; |
| 658 | __le16 reserved3; |
| 659 | u8 dev_type; |
| 660 | u8 air_propagation; |
| 661 | __le16 reserved4; |
| 662 | u8 ofdm_basic_rates; |
| 663 | u8 cck_basic_rates; |
| 664 | __le16 assoc_id; |
| 665 | __le32 flags; |
| 666 | __le32 filter_flags; |
| 667 | __le16 channel; |
| 668 | __le16 reserved5; |
| 669 | } __packed; |
| 670 | |
| 671 | struct il4965_rxon_cmd { |
| 672 | u8 node_addr[6]; |
| 673 | __le16 reserved1; |
| 674 | u8 bssid_addr[6]; |
| 675 | __le16 reserved2; |
| 676 | u8 wlap_bssid_addr[6]; |
| 677 | __le16 reserved3; |
| 678 | u8 dev_type; |
| 679 | u8 air_propagation; |
| 680 | __le16 rx_chain; |
| 681 | u8 ofdm_basic_rates; |
| 682 | u8 cck_basic_rates; |
| 683 | __le16 assoc_id; |
| 684 | __le32 flags; |
| 685 | __le32 filter_flags; |
| 686 | __le16 channel; |
| 687 | u8 ofdm_ht_single_stream_basic_rates; |
| 688 | u8 ofdm_ht_dual_stream_basic_rates; |
| 689 | } __packed; |
| 690 | |
| 691 | /* Create a common rxon cmd which will be typecast into the 3945 or 4965 |
| 692 | * specific rxon cmd, depending on where it is called from. |
| 693 | */ |
| 694 | struct il_rxon_cmd { |
| 695 | u8 node_addr[6]; |
| 696 | __le16 reserved1; |
| 697 | u8 bssid_addr[6]; |
| 698 | __le16 reserved2; |
| 699 | u8 wlap_bssid_addr[6]; |
| 700 | __le16 reserved3; |
| 701 | u8 dev_type; |
| 702 | u8 air_propagation; |
| 703 | __le16 rx_chain; |
| 704 | u8 ofdm_basic_rates; |
| 705 | u8 cck_basic_rates; |
| 706 | __le16 assoc_id; |
| 707 | __le32 flags; |
| 708 | __le32 filter_flags; |
| 709 | __le16 channel; |
| 710 | u8 ofdm_ht_single_stream_basic_rates; |
| 711 | u8 ofdm_ht_dual_stream_basic_rates; |
| 712 | u8 reserved4; |
| 713 | u8 reserved5; |
| 714 | } __packed; |
| 715 | |
| 716 | /* |
| 717 | * C_RXON_ASSOC = 0x11 (command, has simple generic response) |
| 718 | */ |
| 719 | struct il3945_rxon_assoc_cmd { |
| 720 | __le32 flags; |
| 721 | __le32 filter_flags; |
| 722 | u8 ofdm_basic_rates; |
| 723 | u8 cck_basic_rates; |
| 724 | __le16 reserved; |
| 725 | } __packed; |
| 726 | |
| 727 | struct il4965_rxon_assoc_cmd { |
| 728 | __le32 flags; |
| 729 | __le32 filter_flags; |
| 730 | u8 ofdm_basic_rates; |
| 731 | u8 cck_basic_rates; |
| 732 | u8 ofdm_ht_single_stream_basic_rates; |
| 733 | u8 ofdm_ht_dual_stream_basic_rates; |
| 734 | __le16 rx_chain_select_flags; |
| 735 | __le16 reserved; |
| 736 | } __packed; |
| 737 | |
| 738 | #define IL_CONN_MAX_LISTEN_INTERVAL 10 |
| 739 | #define IL_MAX_UCODE_BEACON_INTERVAL 4 /* 4096 */ |
| 740 | #define IL39_MAX_UCODE_BEACON_INTERVAL 1 /* 1024 */ |
| 741 | |
| 742 | /* |
| 743 | * C_RXON_TIMING = 0x14 (command, has simple generic response) |
| 744 | */ |
| 745 | struct il_rxon_time_cmd { |
| 746 | __le64 timestamp; |
| 747 | __le16 beacon_interval; |
| 748 | __le16 atim_win; |
| 749 | __le32 beacon_init_val; |
| 750 | __le16 listen_interval; |
| 751 | u8 dtim_period; |
| 752 | u8 delta_cp_bss_tbtts; |
| 753 | } __packed; |
| 754 | |
| 755 | /* |
| 756 | * C_CHANNEL_SWITCH = 0x72 (command, has simple generic response) |
| 757 | */ |
| 758 | struct il3945_channel_switch_cmd { |
| 759 | u8 band; |
| 760 | u8 expect_beacon; |
| 761 | __le16 channel; |
| 762 | __le32 rxon_flags; |
| 763 | __le32 rxon_filter_flags; |
| 764 | __le32 switch_time; |
| 765 | struct il3945_power_per_rate power[IL_MAX_RATES]; |
| 766 | } __packed; |
| 767 | |
| 768 | struct il4965_channel_switch_cmd { |
| 769 | u8 band; |
| 770 | u8 expect_beacon; |
| 771 | __le16 channel; |
| 772 | __le32 rxon_flags; |
| 773 | __le32 rxon_filter_flags; |
| 774 | __le32 switch_time; |
| 775 | struct il4965_tx_power_db tx_power; |
| 776 | } __packed; |
| 777 | |
| 778 | /* |
| 779 | * N_CHANNEL_SWITCH = 0x73 (notification only, not a command) |
| 780 | */ |
| 781 | struct il_csa_notification { |
| 782 | __le16 band; |
| 783 | __le16 channel; |
| 784 | __le32 status; /* 0 - OK, 1 - fail */ |
| 785 | } __packed; |
| 786 | |
| 787 | /****************************************************************************** |
| 788 | * (2) |
| 789 | * Quality-of-Service (QOS) Commands & Responses: |
| 790 | * |
| 791 | *****************************************************************************/ |
| 792 | |
| 793 | /** |
| 794 | * struct il_ac_qos -- QOS timing params for C_QOS_PARAM |
| 795 | * One for each of 4 EDCA access categories in struct il_qosparam_cmd |
| 796 | * |
| 797 | * @cw_min: Contention win, start value in numbers of slots. |
| 798 | * Should be a power-of-2, minus 1. Device's default is 0x0f. |
| 799 | * @cw_max: Contention win, max value in numbers of slots. |
| 800 | * Should be a power-of-2, minus 1. Device's default is 0x3f. |
| 801 | * @aifsn: Number of slots in Arbitration Interframe Space (before |
| 802 | * performing random backoff timing prior to Tx). Device default 1. |
| 803 | * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0. |
| 804 | * |
| 805 | * Device will automatically increase contention win by (2*CW) + 1 for each |
| 806 | * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW |
| 807 | * value, to cap the CW value. |
| 808 | */ |
| 809 | struct il_ac_qos { |
| 810 | __le16 cw_min; |
| 811 | __le16 cw_max; |
| 812 | u8 aifsn; |
| 813 | u8 reserved1; |
| 814 | __le16 edca_txop; |
| 815 | } __packed; |
| 816 | |
| 817 | /* QoS flags defines */ |
| 818 | #define QOS_PARAM_FLG_UPDATE_EDCA_MSK cpu_to_le32(0x01) |
| 819 | #define QOS_PARAM_FLG_TGN_MSK cpu_to_le32(0x02) |
| 820 | #define QOS_PARAM_FLG_TXOP_TYPE_MSK cpu_to_le32(0x10) |
| 821 | |
| 822 | /* Number of Access Categories (AC) (EDCA), queues 0..3 */ |
| 823 | #define AC_NUM 4 |
| 824 | |
| 825 | /* |
| 826 | * C_QOS_PARAM = 0x13 (command, has simple generic response) |
| 827 | * |
| 828 | * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs |
| 829 | * 0: Background, 1: Best Effort, 2: Video, 3: Voice. |
| 830 | */ |
| 831 | struct il_qosparam_cmd { |
| 832 | __le32 qos_flags; |
| 833 | struct il_ac_qos ac[AC_NUM]; |
| 834 | } __packed; |
| 835 | |
| 836 | /****************************************************************************** |
| 837 | * (3) |
| 838 | * Add/Modify Stations Commands & Responses: |
| 839 | * |
| 840 | *****************************************************************************/ |
| 841 | /* |
| 842 | * Multi station support |
| 843 | */ |
| 844 | |
| 845 | /* Special, dedicated locations within device's station table */ |
| 846 | #define IL_AP_ID 0 |
| 847 | #define IL_STA_ID 2 |
| 848 | #define IL3945_BROADCAST_ID 24 |
| 849 | #define IL3945_STATION_COUNT 25 |
| 850 | #define IL4965_BROADCAST_ID 31 |
| 851 | #define IL4965_STATION_COUNT 32 |
| 852 | |
| 853 | #define IL_STATION_COUNT 32 /* MAX(3945,4965) */ |
| 854 | #define IL_INVALID_STATION 255 |
| 855 | |
| 856 | #define STA_FLG_TX_RATE_MSK cpu_to_le32(1 << 2) |
| 857 | #define STA_FLG_PWR_SAVE_MSK cpu_to_le32(1 << 8) |
| 858 | #define STA_FLG_RTS_MIMO_PROT_MSK cpu_to_le32(1 << 17) |
| 859 | #define STA_FLG_AGG_MPDU_8US_MSK cpu_to_le32(1 << 18) |
| 860 | #define STA_FLG_MAX_AGG_SIZE_POS (19) |
| 861 | #define STA_FLG_MAX_AGG_SIZE_MSK cpu_to_le32(3 << 19) |
| 862 | #define STA_FLG_HT40_EN_MSK cpu_to_le32(1 << 21) |
| 863 | #define STA_FLG_MIMO_DIS_MSK cpu_to_le32(1 << 22) |
| 864 | #define STA_FLG_AGG_MPDU_DENSITY_POS (23) |
| 865 | #define STA_FLG_AGG_MPDU_DENSITY_MSK cpu_to_le32(7 << 23) |
| 866 | |
| 867 | /* Use in mode field. 1: modify existing entry, 0: add new station entry */ |
| 868 | #define STA_CONTROL_MODIFY_MSK 0x01 |
| 869 | |
| 870 | /* key flags __le16*/ |
| 871 | #define STA_KEY_FLG_ENCRYPT_MSK cpu_to_le16(0x0007) |
| 872 | #define STA_KEY_FLG_NO_ENC cpu_to_le16(0x0000) |
| 873 | #define STA_KEY_FLG_WEP cpu_to_le16(0x0001) |
| 874 | #define STA_KEY_FLG_CCMP cpu_to_le16(0x0002) |
| 875 | #define STA_KEY_FLG_TKIP cpu_to_le16(0x0003) |
| 876 | |
| 877 | #define STA_KEY_FLG_KEYID_POS 8 |
| 878 | #define STA_KEY_FLG_INVALID cpu_to_le16(0x0800) |
| 879 | /* wep key is either from global key (0) or from station info array (1) */ |
| 880 | #define STA_KEY_FLG_MAP_KEY_MSK cpu_to_le16(0x0008) |
| 881 | |
| 882 | /* wep key in STA: 5-bytes (0) or 13-bytes (1) */ |
| 883 | #define STA_KEY_FLG_KEY_SIZE_MSK cpu_to_le16(0x1000) |
| 884 | #define STA_KEY_MULTICAST_MSK cpu_to_le16(0x4000) |
| 885 | #define STA_KEY_MAX_NUM 8 |
| 886 | |
| 887 | /* Flags indicate whether to modify vs. don't change various station params */ |
| 888 | #define STA_MODIFY_KEY_MASK 0x01 |
| 889 | #define STA_MODIFY_TID_DISABLE_TX 0x02 |
| 890 | #define STA_MODIFY_TX_RATE_MSK 0x04 |
| 891 | #define STA_MODIFY_ADDBA_TID_MSK 0x08 |
| 892 | #define STA_MODIFY_DELBA_TID_MSK 0x10 |
| 893 | #define STA_MODIFY_SLEEP_TX_COUNT_MSK 0x20 |
| 894 | |
| 895 | /* Receiver address (actually, Rx station's idx into station table), |
| 896 | * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */ |
| 897 | #define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid)) |
| 898 | |
| 899 | struct il4965_keyinfo { |
| 900 | __le16 key_flags; |
| 901 | u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */ |
| 902 | u8 reserved1; |
| 903 | __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */ |
| 904 | u8 key_offset; |
| 905 | u8 reserved2; |
| 906 | u8 key[16]; /* 16-byte unicast decryption key */ |
| 907 | } __packed; |
| 908 | |
| 909 | /** |
| 910 | * struct sta_id_modify |
| 911 | * @addr[ETH_ALEN]: station's MAC address |
| 912 | * @sta_id: idx of station in uCode's station table |
| 913 | * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change |
| 914 | * |
| 915 | * Driver selects unused table idx when adding new station, |
| 916 | * or the idx to a pre-existing station entry when modifying that station. |
| 917 | * Some idxes have special purposes (IL_AP_ID, idx 0, is for AP). |
| 918 | * |
| 919 | * modify_mask flags select which parameters to modify vs. leave alone. |
| 920 | */ |
| 921 | struct sta_id_modify { |
| 922 | u8 addr[ETH_ALEN]; |
| 923 | __le16 reserved1; |
| 924 | u8 sta_id; |
| 925 | u8 modify_mask; |
| 926 | __le16 reserved2; |
| 927 | } __packed; |
| 928 | |
| 929 | /* |
| 930 | * C_ADD_STA = 0x18 (command) |
| 931 | * |
| 932 | * The device contains an internal table of per-station information, |
| 933 | * with info on security keys, aggregation parameters, and Tx rates for |
| 934 | * initial Tx attempt and any retries (4965 devices uses |
| 935 | * C_TX_LINK_QUALITY_CMD, |
| 936 | * 3945 uses C_RATE_SCALE to set up rate tables). |
| 937 | * |
| 938 | * C_ADD_STA sets up the table entry for one station, either creating |
| 939 | * a new entry, or modifying a pre-existing one. |
| 940 | * |
| 941 | * NOTE: RXON command (without "associated" bit set) wipes the station table |
| 942 | * clean. Moving into RF_KILL state does this also. Driver must set up |
| 943 | * new station table before transmitting anything on the RXON channel |
| 944 | * (except active scans or active measurements; those commands carry |
| 945 | * their own txpower/rate setup data). |
| 946 | * |
| 947 | * When getting started on a new channel, driver must set up the |
| 948 | * IL_BROADCAST_ID entry (last entry in the table). For a client |
| 949 | * station in a BSS, once an AP is selected, driver sets up the AP STA |
| 950 | * in the IL_AP_ID entry (1st entry in the table). BROADCAST and AP |
| 951 | * are all that are needed for a BSS client station. If the device is |
| 952 | * used as AP, or in an IBSS network, driver must set up station table |
| 953 | * entries for all STAs in network, starting with idx IL_STA_ID. |
| 954 | */ |
| 955 | |
| 956 | struct il3945_addsta_cmd { |
| 957 | u8 mode; /* 1: modify existing, 0: add new station */ |
| 958 | u8 reserved[3]; |
| 959 | struct sta_id_modify sta; |
| 960 | struct il4965_keyinfo key; |
| 961 | __le32 station_flags; /* STA_FLG_* */ |
| 962 | __le32 station_flags_msk; /* STA_FLG_* */ |
| 963 | |
| 964 | /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID) |
| 965 | * corresponding to bit (e.g. bit 5 controls TID 5). |
| 966 | * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */ |
| 967 | __le16 tid_disable_tx; |
| 968 | |
| 969 | __le16 rate_n_flags; |
| 970 | |
| 971 | /* TID for which to add block-ack support. |
| 972 | * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */ |
| 973 | u8 add_immediate_ba_tid; |
| 974 | |
| 975 | /* TID for which to remove block-ack support. |
| 976 | * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */ |
| 977 | u8 remove_immediate_ba_tid; |
| 978 | |
| 979 | /* Starting Sequence Number for added block-ack support. |
| 980 | * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */ |
| 981 | __le16 add_immediate_ba_ssn; |
| 982 | } __packed; |
| 983 | |
| 984 | struct il4965_addsta_cmd { |
| 985 | u8 mode; /* 1: modify existing, 0: add new station */ |
| 986 | u8 reserved[3]; |
| 987 | struct sta_id_modify sta; |
| 988 | struct il4965_keyinfo key; |
| 989 | __le32 station_flags; /* STA_FLG_* */ |
| 990 | __le32 station_flags_msk; /* STA_FLG_* */ |
| 991 | |
| 992 | /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID) |
| 993 | * corresponding to bit (e.g. bit 5 controls TID 5). |
| 994 | * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */ |
| 995 | __le16 tid_disable_tx; |
| 996 | |
| 997 | __le16 reserved1; |
| 998 | |
| 999 | /* TID for which to add block-ack support. |
| 1000 | * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */ |
| 1001 | u8 add_immediate_ba_tid; |
| 1002 | |
| 1003 | /* TID for which to remove block-ack support. |
| 1004 | * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */ |
| 1005 | u8 remove_immediate_ba_tid; |
| 1006 | |
| 1007 | /* Starting Sequence Number for added block-ack support. |
| 1008 | * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */ |
| 1009 | __le16 add_immediate_ba_ssn; |
| 1010 | |
| 1011 | /* |
| 1012 | * Number of packets OK to transmit to station even though |
| 1013 | * it is asleep -- used to synchronise PS-poll and u-APSD |
| 1014 | * responses while ucode keeps track of STA sleep state. |
| 1015 | */ |
| 1016 | __le16 sleep_tx_count; |
| 1017 | |
| 1018 | __le16 reserved2; |
| 1019 | } __packed; |
| 1020 | |
| 1021 | /* Wrapper struct for 3945 and 4965 addsta_cmd structures */ |
| 1022 | struct il_addsta_cmd { |
| 1023 | u8 mode; /* 1: modify existing, 0: add new station */ |
| 1024 | u8 reserved[3]; |
| 1025 | struct sta_id_modify sta; |
| 1026 | struct il4965_keyinfo key; |
| 1027 | __le32 station_flags; /* STA_FLG_* */ |
| 1028 | __le32 station_flags_msk; /* STA_FLG_* */ |
| 1029 | |
| 1030 | /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID) |
| 1031 | * corresponding to bit (e.g. bit 5 controls TID 5). |
| 1032 | * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */ |
| 1033 | __le16 tid_disable_tx; |
| 1034 | |
| 1035 | __le16 rate_n_flags; /* 3945 only */ |
| 1036 | |
| 1037 | /* TID for which to add block-ack support. |
| 1038 | * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */ |
| 1039 | u8 add_immediate_ba_tid; |
| 1040 | |
| 1041 | /* TID for which to remove block-ack support. |
| 1042 | * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */ |
| 1043 | u8 remove_immediate_ba_tid; |
| 1044 | |
| 1045 | /* Starting Sequence Number for added block-ack support. |
| 1046 | * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */ |
| 1047 | __le16 add_immediate_ba_ssn; |
| 1048 | |
| 1049 | /* |
| 1050 | * Number of packets OK to transmit to station even though |
| 1051 | * it is asleep -- used to synchronise PS-poll and u-APSD |
| 1052 | * responses while ucode keeps track of STA sleep state. |
| 1053 | */ |
| 1054 | __le16 sleep_tx_count; |
| 1055 | |
| 1056 | __le16 reserved2; |
| 1057 | } __packed; |
| 1058 | |
| 1059 | #define ADD_STA_SUCCESS_MSK 0x1 |
| 1060 | #define ADD_STA_NO_ROOM_IN_TBL 0x2 |
| 1061 | #define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4 |
| 1062 | #define ADD_STA_MODIFY_NON_EXIST_STA 0x8 |
| 1063 | /* |
| 1064 | * C_ADD_STA = 0x18 (response) |
| 1065 | */ |
| 1066 | struct il_add_sta_resp { |
| 1067 | u8 status; /* ADD_STA_* */ |
| 1068 | } __packed; |
| 1069 | |
| 1070 | #define REM_STA_SUCCESS_MSK 0x1 |
| 1071 | /* |
| 1072 | * C_REM_STA = 0x19 (response) |
| 1073 | */ |
| 1074 | struct il_rem_sta_resp { |
| 1075 | u8 status; |
| 1076 | } __packed; |
| 1077 | |
| 1078 | /* |
| 1079 | * C_REM_STA = 0x19 (command) |
| 1080 | */ |
| 1081 | struct il_rem_sta_cmd { |
| 1082 | u8 num_sta; /* number of removed stations */ |
| 1083 | u8 reserved[3]; |
| 1084 | u8 addr[ETH_ALEN]; /* MAC addr of the first station */ |
| 1085 | u8 reserved2[2]; |
| 1086 | } __packed; |
| 1087 | |
| 1088 | #define IL_TX_FIFO_BK_MSK cpu_to_le32(BIT(0)) |
| 1089 | #define IL_TX_FIFO_BE_MSK cpu_to_le32(BIT(1)) |
| 1090 | #define IL_TX_FIFO_VI_MSK cpu_to_le32(BIT(2)) |
| 1091 | #define IL_TX_FIFO_VO_MSK cpu_to_le32(BIT(3)) |
| 1092 | #define IL_AGG_TX_QUEUE_MSK cpu_to_le32(0xffc00) |
| 1093 | |
| 1094 | #define IL_DROP_SINGLE 0 |
| 1095 | #define IL_DROP_SELECTED 1 |
| 1096 | #define IL_DROP_ALL 2 |
| 1097 | |
| 1098 | /* |
| 1099 | * REPLY_WEP_KEY = 0x20 |
| 1100 | */ |
| 1101 | struct il_wep_key { |
| 1102 | u8 key_idx; |
| 1103 | u8 key_offset; |
| 1104 | u8 reserved1[2]; |
| 1105 | u8 key_size; |
| 1106 | u8 reserved2[3]; |
| 1107 | u8 key[16]; |
| 1108 | } __packed; |
| 1109 | |
| 1110 | struct il_wep_cmd { |
| 1111 | u8 num_keys; |
| 1112 | u8 global_key_type; |
| 1113 | u8 flags; |
| 1114 | u8 reserved; |
| 1115 | struct il_wep_key key[0]; |
| 1116 | } __packed; |
| 1117 | |
| 1118 | #define WEP_KEY_WEP_TYPE 1 |
| 1119 | #define WEP_KEYS_MAX 4 |
| 1120 | #define WEP_INVALID_OFFSET 0xff |
| 1121 | #define WEP_KEY_LEN_64 5 |
| 1122 | #define WEP_KEY_LEN_128 13 |
| 1123 | |
| 1124 | /****************************************************************************** |
| 1125 | * (4) |
| 1126 | * Rx Responses: |
| 1127 | * |
| 1128 | *****************************************************************************/ |
| 1129 | |
| 1130 | #define RX_RES_STATUS_NO_CRC32_ERROR cpu_to_le32(1 << 0) |
| 1131 | #define RX_RES_STATUS_NO_RXE_OVERFLOW cpu_to_le32(1 << 1) |
| 1132 | |
| 1133 | #define RX_RES_PHY_FLAGS_BAND_24_MSK cpu_to_le16(1 << 0) |
| 1134 | #define RX_RES_PHY_FLAGS_MOD_CCK_MSK cpu_to_le16(1 << 1) |
| 1135 | #define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK cpu_to_le16(1 << 2) |
| 1136 | #define RX_RES_PHY_FLAGS_NARROW_BAND_MSK cpu_to_le16(1 << 3) |
| 1137 | #define RX_RES_PHY_FLAGS_ANTENNA_MSK 0x70 |
| 1138 | #define RX_RES_PHY_FLAGS_ANTENNA_POS 4 |
| 1139 | #define RX_RES_PHY_FLAGS_AGG_MSK cpu_to_le16(1 << 7) |
| 1140 | |
| 1141 | #define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8) |
| 1142 | #define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8) |
| 1143 | #define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8) |
| 1144 | #define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8) |
| 1145 | #define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8) |
| 1146 | #define RX_RES_STATUS_SEC_TYPE_ERR (0x7 << 8) |
| 1147 | |
| 1148 | #define RX_RES_STATUS_STATION_FOUND (1<<6) |
| 1149 | #define RX_RES_STATUS_NO_STATION_INFO_MISMATCH (1<<7) |
| 1150 | |
| 1151 | #define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11) |
| 1152 | #define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11) |
| 1153 | #define RX_RES_STATUS_DECRYPT_OK (0x3 << 11) |
| 1154 | #define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11) |
| 1155 | #define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11) |
| 1156 | |
| 1157 | #define RX_MPDU_RES_STATUS_ICV_OK (0x20) |
| 1158 | #define RX_MPDU_RES_STATUS_MIC_OK (0x40) |
| 1159 | #define RX_MPDU_RES_STATUS_TTAK_OK (1 << 7) |
| 1160 | #define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800) |
| 1161 | |
| 1162 | struct il3945_rx_frame_stats { |
| 1163 | u8 phy_count; |
| 1164 | u8 id; |
| 1165 | u8 rssi; |
| 1166 | u8 agc; |
| 1167 | __le16 sig_avg; |
| 1168 | __le16 noise_diff; |
| 1169 | u8 payload[0]; |
| 1170 | } __packed; |
| 1171 | |
| 1172 | struct il3945_rx_frame_hdr { |
| 1173 | __le16 channel; |
| 1174 | __le16 phy_flags; |
| 1175 | u8 reserved1; |
| 1176 | u8 rate; |
| 1177 | __le16 len; |
| 1178 | u8 payload[0]; |
| 1179 | } __packed; |
| 1180 | |
| 1181 | struct il3945_rx_frame_end { |
| 1182 | __le32 status; |
| 1183 | __le64 timestamp; |
| 1184 | __le32 beacon_timestamp; |
| 1185 | } __packed; |
| 1186 | |
| 1187 | /* |
| 1188 | * N_3945_RX = 0x1b (response only, not a command) |
| 1189 | * |
| 1190 | * NOTE: DO NOT dereference from casts to this structure |
| 1191 | * It is provided only for calculating minimum data set size. |
| 1192 | * The actual offsets of the hdr and end are dynamic based on |
| 1193 | * stats.phy_count |
| 1194 | */ |
| 1195 | struct il3945_rx_frame { |
| 1196 | struct il3945_rx_frame_stats stats; |
| 1197 | struct il3945_rx_frame_hdr hdr; |
| 1198 | struct il3945_rx_frame_end end; |
| 1199 | } __packed; |
| 1200 | |
| 1201 | #define IL39_RX_FRAME_SIZE (4 + sizeof(struct il3945_rx_frame)) |
| 1202 | |
| 1203 | /* Fixed (non-configurable) rx data from phy */ |
| 1204 | |
| 1205 | #define IL49_RX_RES_PHY_CNT 14 |
| 1206 | #define IL49_RX_PHY_FLAGS_ANTENNAE_OFFSET (4) |
| 1207 | #define IL49_RX_PHY_FLAGS_ANTENNAE_MASK (0x70) |
| 1208 | #define IL49_AGC_DB_MASK (0x3f80) /* MASK(7,13) */ |
| 1209 | #define IL49_AGC_DB_POS (7) |
| 1210 | struct il4965_rx_non_cfg_phy { |
| 1211 | __le16 ant_selection; /* ant A bit 4, ant B bit 5, ant C bit 6 */ |
| 1212 | __le16 agc_info; /* agc code 0:6, agc dB 7:13, reserved 14:15 */ |
| 1213 | u8 rssi_info[6]; /* we use even entries, 0/2/4 for A/B/C rssi */ |
| 1214 | u8 pad[0]; |
| 1215 | } __packed; |
| 1216 | |
| 1217 | /* |
| 1218 | * N_RX = 0xc3 (response only, not a command) |
| 1219 | * Used only for legacy (non 11n) frames. |
| 1220 | */ |
| 1221 | struct il_rx_phy_res { |
| 1222 | u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */ |
| 1223 | u8 cfg_phy_cnt; /* configurable DSP phy data byte count */ |
| 1224 | u8 stat_id; /* configurable DSP phy data set ID */ |
| 1225 | u8 reserved1; |
| 1226 | __le64 timestamp; /* TSF at on air rise */ |
| 1227 | __le32 beacon_time_stamp; /* beacon at on-air rise */ |
| 1228 | __le16 phy_flags; /* general phy flags: band, modulation, ... */ |
| 1229 | __le16 channel; /* channel number */ |
| 1230 | u8 non_cfg_phy_buf[32]; /* for various implementations of non_cfg_phy */ |
| 1231 | __le32 rate_n_flags; /* RATE_MCS_* */ |
| 1232 | __le16 byte_count; /* frame's byte-count */ |
| 1233 | __le16 frame_time; /* frame's time on the air */ |
| 1234 | } __packed; |
| 1235 | |
| 1236 | struct il_rx_mpdu_res_start { |
| 1237 | __le16 byte_count; |
| 1238 | __le16 reserved; |
| 1239 | } __packed; |
| 1240 | |
| 1241 | /****************************************************************************** |
| 1242 | * (5) |
| 1243 | * Tx Commands & Responses: |
| 1244 | * |
| 1245 | * Driver must place each C_TX command into one of the prioritized Tx |
| 1246 | * queues in host DRAM, shared between driver and device (see comments for |
| 1247 | * SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode |
| 1248 | * are preparing to transmit, the device pulls the Tx command over the PCI |
| 1249 | * bus via one of the device's Tx DMA channels, to fill an internal FIFO |
| 1250 | * from which data will be transmitted. |
| 1251 | * |
| 1252 | * uCode handles all timing and protocol related to control frames |
| 1253 | * (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler |
| 1254 | * handle reception of block-acks; uCode updates the host driver via |
| 1255 | * N_COMPRESSED_BA. |
| 1256 | * |
| 1257 | * uCode handles retrying Tx when an ACK is expected but not received. |
| 1258 | * This includes trying lower data rates than the one requested in the Tx |
| 1259 | * command, as set up by the C_RATE_SCALE (for 3945) or |
| 1260 | * C_TX_LINK_QUALITY_CMD (4965). |
| 1261 | * |
| 1262 | * Driver sets up transmit power for various rates via C_TX_PWR_TBL. |
| 1263 | * This command must be executed after every RXON command, before Tx can occur. |
| 1264 | *****************************************************************************/ |
| 1265 | |
| 1266 | /* C_TX Tx flags field */ |
| 1267 | |
| 1268 | /* |
| 1269 | * 1: Use Request-To-Send protocol before this frame. |
| 1270 | * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK. |
| 1271 | */ |
| 1272 | #define TX_CMD_FLG_RTS_MSK cpu_to_le32(1 << 1) |
| 1273 | |
| 1274 | /* |
| 1275 | * 1: Transmit Clear-To-Send to self before this frame. |
| 1276 | * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames. |
| 1277 | * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK. |
| 1278 | */ |
| 1279 | #define TX_CMD_FLG_CTS_MSK cpu_to_le32(1 << 2) |
| 1280 | |
| 1281 | /* 1: Expect ACK from receiving station |
| 1282 | * 0: Don't expect ACK (MAC header's duration field s/b 0) |
| 1283 | * Set this for unicast frames, but not broadcast/multicast. */ |
| 1284 | #define TX_CMD_FLG_ACK_MSK cpu_to_le32(1 << 3) |
| 1285 | |
| 1286 | /* For 4965 devices: |
| 1287 | * 1: Use rate scale table (see C_TX_LINK_QUALITY_CMD). |
| 1288 | * Tx command's initial_rate_idx indicates first rate to try; |
| 1289 | * uCode walks through table for additional Tx attempts. |
| 1290 | * 0: Use Tx rate/MCS from Tx command's rate_n_flags field. |
| 1291 | * This rate will be used for all Tx attempts; it will not be scaled. */ |
| 1292 | #define TX_CMD_FLG_STA_RATE_MSK cpu_to_le32(1 << 4) |
| 1293 | |
| 1294 | /* 1: Expect immediate block-ack. |
| 1295 | * Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */ |
| 1296 | #define TX_CMD_FLG_IMM_BA_RSP_MASK cpu_to_le32(1 << 6) |
| 1297 | |
| 1298 | /* |
| 1299 | * 1: Frame requires full Tx-Op protection. |
| 1300 | * Set this if either RTS or CTS Tx Flag gets set. |
| 1301 | */ |
| 1302 | #define TX_CMD_FLG_FULL_TXOP_PROT_MSK cpu_to_le32(1 << 7) |
| 1303 | |
| 1304 | /* Tx antenna selection field; used only for 3945, reserved (0) for 4965 devices. |
| 1305 | * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */ |
| 1306 | #define TX_CMD_FLG_ANT_SEL_MSK cpu_to_le32(0xf00) |
| 1307 | #define TX_CMD_FLG_ANT_A_MSK cpu_to_le32(1 << 8) |
| 1308 | #define TX_CMD_FLG_ANT_B_MSK cpu_to_le32(1 << 9) |
| 1309 | |
| 1310 | /* 1: uCode overrides sequence control field in MAC header. |
| 1311 | * 0: Driver provides sequence control field in MAC header. |
| 1312 | * Set this for management frames, non-QOS data frames, non-unicast frames, |
| 1313 | * and also in Tx command embedded in C_SCAN for active scans. */ |
| 1314 | #define TX_CMD_FLG_SEQ_CTL_MSK cpu_to_le32(1 << 13) |
| 1315 | |
| 1316 | /* 1: This frame is non-last MPDU; more fragments are coming. |
| 1317 | * 0: Last fragment, or not using fragmentation. */ |
| 1318 | #define TX_CMD_FLG_MORE_FRAG_MSK cpu_to_le32(1 << 14) |
| 1319 | |
| 1320 | /* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame. |
| 1321 | * 0: No TSF required in outgoing frame. |
| 1322 | * Set this for transmitting beacons and probe responses. */ |
| 1323 | #define TX_CMD_FLG_TSF_MSK cpu_to_le32(1 << 16) |
| 1324 | |
| 1325 | /* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword |
| 1326 | * alignment of frame's payload data field. |
| 1327 | * 0: No pad |
| 1328 | * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4 |
| 1329 | * field (but not both). Driver must align frame data (i.e. data following |
| 1330 | * MAC header) to DWORD boundary. */ |
| 1331 | #define TX_CMD_FLG_MH_PAD_MSK cpu_to_le32(1 << 20) |
| 1332 | |
| 1333 | /* accelerate aggregation support |
| 1334 | * 0 - no CCMP encryption; 1 - CCMP encryption */ |
| 1335 | #define TX_CMD_FLG_AGG_CCMP_MSK cpu_to_le32(1 << 22) |
| 1336 | |
| 1337 | /* HCCA-AP - disable duration overwriting. */ |
| 1338 | #define TX_CMD_FLG_DUR_MSK cpu_to_le32(1 << 25) |
| 1339 | |
| 1340 | /* |
| 1341 | * TX command security control |
| 1342 | */ |
| 1343 | #define TX_CMD_SEC_WEP 0x01 |
| 1344 | #define TX_CMD_SEC_CCM 0x02 |
| 1345 | #define TX_CMD_SEC_TKIP 0x03 |
| 1346 | #define TX_CMD_SEC_MSK 0x03 |
| 1347 | #define TX_CMD_SEC_SHIFT 6 |
| 1348 | #define TX_CMD_SEC_KEY128 0x08 |
| 1349 | |
| 1350 | /* |
| 1351 | * security overhead sizes |
| 1352 | */ |
| 1353 | #define WEP_IV_LEN 4 |
| 1354 | #define WEP_ICV_LEN 4 |
| 1355 | #define CCMP_MIC_LEN 8 |
| 1356 | #define TKIP_ICV_LEN 4 |
| 1357 | |
| 1358 | /* |
| 1359 | * C_TX = 0x1c (command) |
| 1360 | */ |
| 1361 | |
| 1362 | struct il3945_tx_cmd { |
| 1363 | /* |
| 1364 | * MPDU byte count: |
| 1365 | * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size, |
| 1366 | * + 8 byte IV for CCM or TKIP (not used for WEP) |
| 1367 | * + Data payload |
| 1368 | * + 8-byte MIC (not used for CCM/WEP) |
| 1369 | * NOTE: Does not include Tx command bytes, post-MAC pad bytes, |
| 1370 | * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i |
| 1371 | * Range: 14-2342 bytes. |
| 1372 | */ |
| 1373 | __le16 len; |
| 1374 | |
| 1375 | /* |
| 1376 | * MPDU or MSDU byte count for next frame. |
| 1377 | * Used for fragmentation and bursting, but not 11n aggregation. |
| 1378 | * Same as "len", but for next frame. Set to 0 if not applicable. |
| 1379 | */ |
| 1380 | __le16 next_frame_len; |
| 1381 | |
| 1382 | __le32 tx_flags; /* TX_CMD_FLG_* */ |
| 1383 | |
| 1384 | u8 rate; |
| 1385 | |
| 1386 | /* Index of recipient station in uCode's station table */ |
| 1387 | u8 sta_id; |
| 1388 | u8 tid_tspec; |
| 1389 | u8 sec_ctl; |
| 1390 | u8 key[16]; |
| 1391 | union { |
| 1392 | u8 byte[8]; |
| 1393 | __le16 word[4]; |
| 1394 | __le32 dw[2]; |
| 1395 | } tkip_mic; |
| 1396 | __le32 next_frame_info; |
| 1397 | union { |
| 1398 | __le32 life_time; |
| 1399 | __le32 attempt; |
| 1400 | } stop_time; |
| 1401 | u8 supp_rates[2]; |
| 1402 | u8 rts_retry_limit; /*byte 50 */ |
| 1403 | u8 data_retry_limit; /*byte 51 */ |
| 1404 | union { |
| 1405 | __le16 pm_frame_timeout; |
| 1406 | __le16 attempt_duration; |
| 1407 | } timeout; |
| 1408 | |
| 1409 | /* |
| 1410 | * Duration of EDCA burst Tx Opportunity, in 32-usec units. |
| 1411 | * Set this if txop time is not specified by HCCA protocol (e.g. by AP). |
| 1412 | */ |
| 1413 | __le16 driver_txop; |
| 1414 | |
| 1415 | /* |
| 1416 | * MAC header goes here, followed by 2 bytes padding if MAC header |
| 1417 | * length is 26 or 30 bytes, followed by payload data |
| 1418 | */ |
| 1419 | u8 payload[0]; |
| 1420 | struct ieee80211_hdr hdr[0]; |
| 1421 | } __packed; |
| 1422 | |
| 1423 | /* |
| 1424 | * C_TX = 0x1c (response) |
| 1425 | */ |
| 1426 | struct il3945_tx_resp { |
| 1427 | u8 failure_rts; |
| 1428 | u8 failure_frame; |
| 1429 | u8 bt_kill_count; |
| 1430 | u8 rate; |
| 1431 | __le32 wireless_media_time; |
| 1432 | __le32 status; /* TX status */ |
| 1433 | } __packed; |
| 1434 | |
| 1435 | /* |
| 1436 | * 4965 uCode updates these Tx attempt count values in host DRAM. |
| 1437 | * Used for managing Tx retries when expecting block-acks. |
| 1438 | * Driver should set these fields to 0. |
| 1439 | */ |
| 1440 | struct il_dram_scratch { |
| 1441 | u8 try_cnt; /* Tx attempts */ |
| 1442 | u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */ |
| 1443 | __le16 reserved; |
| 1444 | } __packed; |
| 1445 | |
| 1446 | struct il_tx_cmd { |
| 1447 | /* |
| 1448 | * MPDU byte count: |
| 1449 | * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size, |
| 1450 | * + 8 byte IV for CCM or TKIP (not used for WEP) |
| 1451 | * + Data payload |
| 1452 | * + 8-byte MIC (not used for CCM/WEP) |
| 1453 | * NOTE: Does not include Tx command bytes, post-MAC pad bytes, |
| 1454 | * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i |
| 1455 | * Range: 14-2342 bytes. |
| 1456 | */ |
| 1457 | __le16 len; |
| 1458 | |
| 1459 | /* |
| 1460 | * MPDU or MSDU byte count for next frame. |
| 1461 | * Used for fragmentation and bursting, but not 11n aggregation. |
| 1462 | * Same as "len", but for next frame. Set to 0 if not applicable. |
| 1463 | */ |
| 1464 | __le16 next_frame_len; |
| 1465 | |
| 1466 | __le32 tx_flags; /* TX_CMD_FLG_* */ |
| 1467 | |
| 1468 | /* uCode may modify this field of the Tx command (in host DRAM!). |
| 1469 | * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */ |
| 1470 | struct il_dram_scratch scratch; |
| 1471 | |
| 1472 | /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */ |
| 1473 | __le32 rate_n_flags; /* RATE_MCS_* */ |
| 1474 | |
| 1475 | /* Index of destination station in uCode's station table */ |
| 1476 | u8 sta_id; |
| 1477 | |
| 1478 | /* Type of security encryption: CCM or TKIP */ |
| 1479 | u8 sec_ctl; /* TX_CMD_SEC_* */ |
| 1480 | |
| 1481 | /* |
| 1482 | * Index into rate table (see C_TX_LINK_QUALITY_CMD) for initial |
| 1483 | * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for |
| 1484 | * data frames, this field may be used to selectively reduce initial |
| 1485 | * rate (via non-0 value) for special frames (e.g. management), while |
| 1486 | * still supporting rate scaling for all frames. |
| 1487 | */ |
| 1488 | u8 initial_rate_idx; |
| 1489 | u8 reserved; |
| 1490 | u8 key[16]; |
| 1491 | __le16 next_frame_flags; |
| 1492 | __le16 reserved2; |
| 1493 | union { |
| 1494 | __le32 life_time; |
| 1495 | __le32 attempt; |
| 1496 | } stop_time; |
| 1497 | |
| 1498 | /* Host DRAM physical address pointer to "scratch" in this command. |
| 1499 | * Must be dword aligned. "0" in dram_lsb_ptr disables usage. */ |
| 1500 | __le32 dram_lsb_ptr; |
| 1501 | u8 dram_msb_ptr; |
| 1502 | |
| 1503 | u8 rts_retry_limit; /*byte 50 */ |
| 1504 | u8 data_retry_limit; /*byte 51 */ |
| 1505 | u8 tid_tspec; |
| 1506 | union { |
| 1507 | __le16 pm_frame_timeout; |
| 1508 | __le16 attempt_duration; |
| 1509 | } timeout; |
| 1510 | |
| 1511 | /* |
| 1512 | * Duration of EDCA burst Tx Opportunity, in 32-usec units. |
| 1513 | * Set this if txop time is not specified by HCCA protocol (e.g. by AP). |
| 1514 | */ |
| 1515 | __le16 driver_txop; |
| 1516 | |
| 1517 | /* |
| 1518 | * MAC header goes here, followed by 2 bytes padding if MAC header |
| 1519 | * length is 26 or 30 bytes, followed by payload data |
| 1520 | */ |
| 1521 | u8 payload[0]; |
| 1522 | struct ieee80211_hdr hdr[0]; |
| 1523 | } __packed; |
| 1524 | |
| 1525 | /* TX command response is sent after *3945* transmission attempts. |
| 1526 | * |
| 1527 | * NOTES: |
| 1528 | * |
| 1529 | * TX_STATUS_FAIL_NEXT_FRAG |
| 1530 | * |
| 1531 | * If the fragment flag in the MAC header for the frame being transmitted |
| 1532 | * is set and there is insufficient time to transmit the next frame, the |
| 1533 | * TX status will be returned with 'TX_STATUS_FAIL_NEXT_FRAG'. |
| 1534 | * |
| 1535 | * TX_STATUS_FIFO_UNDERRUN |
| 1536 | * |
| 1537 | * Indicates the host did not provide bytes to the FIFO fast enough while |
| 1538 | * a TX was in progress. |
| 1539 | * |
| 1540 | * TX_STATUS_FAIL_MGMNT_ABORT |
| 1541 | * |
| 1542 | * This status is only possible if the ABORT ON MGMT RX parameter was |
| 1543 | * set to true with the TX command. |
| 1544 | * |
| 1545 | * If the MSB of the status parameter is set then an abort sequence is |
| 1546 | * required. This sequence consists of the host activating the TX Abort |
| 1547 | * control line, and then waiting for the TX Abort command response. This |
| 1548 | * indicates that a the device is no longer in a transmit state, and that the |
| 1549 | * command FIFO has been cleared. The host must then deactivate the TX Abort |
| 1550 | * control line. Receiving is still allowed in this case. |
| 1551 | */ |
| 1552 | enum { |
| 1553 | TX_3945_STATUS_SUCCESS = 0x01, |
| 1554 | TX_3945_STATUS_DIRECT_DONE = 0x02, |
| 1555 | TX_3945_STATUS_FAIL_SHORT_LIMIT = 0x82, |
| 1556 | TX_3945_STATUS_FAIL_LONG_LIMIT = 0x83, |
| 1557 | TX_3945_STATUS_FAIL_FIFO_UNDERRUN = 0x84, |
| 1558 | TX_3945_STATUS_FAIL_MGMNT_ABORT = 0x85, |
| 1559 | TX_3945_STATUS_FAIL_NEXT_FRAG = 0x86, |
| 1560 | TX_3945_STATUS_FAIL_LIFE_EXPIRE = 0x87, |
| 1561 | TX_3945_STATUS_FAIL_DEST_PS = 0x88, |
| 1562 | TX_3945_STATUS_FAIL_ABORTED = 0x89, |
| 1563 | TX_3945_STATUS_FAIL_BT_RETRY = 0x8a, |
| 1564 | TX_3945_STATUS_FAIL_STA_INVALID = 0x8b, |
| 1565 | TX_3945_STATUS_FAIL_FRAG_DROPPED = 0x8c, |
| 1566 | TX_3945_STATUS_FAIL_TID_DISABLE = 0x8d, |
| 1567 | TX_3945_STATUS_FAIL_FRAME_FLUSHED = 0x8e, |
| 1568 | TX_3945_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f, |
| 1569 | TX_3945_STATUS_FAIL_TX_LOCKED = 0x90, |
| 1570 | TX_3945_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91, |
| 1571 | }; |
| 1572 | |
| 1573 | /* |
| 1574 | * TX command response is sent after *4965* transmission attempts. |
| 1575 | * |
| 1576 | * both postpone and abort status are expected behavior from uCode. there is |
| 1577 | * no special operation required from driver; except for RFKILL_FLUSH, |
| 1578 | * which required tx flush host command to flush all the tx frames in queues |
| 1579 | */ |
| 1580 | enum { |
| 1581 | TX_STATUS_SUCCESS = 0x01, |
| 1582 | TX_STATUS_DIRECT_DONE = 0x02, |
| 1583 | /* postpone TX */ |
| 1584 | TX_STATUS_POSTPONE_DELAY = 0x40, |
| 1585 | TX_STATUS_POSTPONE_FEW_BYTES = 0x41, |
| 1586 | TX_STATUS_POSTPONE_QUIET_PERIOD = 0x43, |
| 1587 | TX_STATUS_POSTPONE_CALC_TTAK = 0x44, |
| 1588 | /* abort TX */ |
| 1589 | TX_STATUS_FAIL_INTERNAL_CROSSED_RETRY = 0x81, |
| 1590 | TX_STATUS_FAIL_SHORT_LIMIT = 0x82, |
| 1591 | TX_STATUS_FAIL_LONG_LIMIT = 0x83, |
| 1592 | TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84, |
| 1593 | TX_STATUS_FAIL_DRAIN_FLOW = 0x85, |
| 1594 | TX_STATUS_FAIL_RFKILL_FLUSH = 0x86, |
| 1595 | TX_STATUS_FAIL_LIFE_EXPIRE = 0x87, |
| 1596 | TX_STATUS_FAIL_DEST_PS = 0x88, |
| 1597 | TX_STATUS_FAIL_HOST_ABORTED = 0x89, |
| 1598 | TX_STATUS_FAIL_BT_RETRY = 0x8a, |
| 1599 | TX_STATUS_FAIL_STA_INVALID = 0x8b, |
| 1600 | TX_STATUS_FAIL_FRAG_DROPPED = 0x8c, |
| 1601 | TX_STATUS_FAIL_TID_DISABLE = 0x8d, |
| 1602 | TX_STATUS_FAIL_FIFO_FLUSHED = 0x8e, |
| 1603 | TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f, |
| 1604 | TX_STATUS_FAIL_PASSIVE_NO_RX = 0x90, |
| 1605 | TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91, |
| 1606 | }; |
| 1607 | |
| 1608 | #define TX_PACKET_MODE_REGULAR 0x0000 |
| 1609 | #define TX_PACKET_MODE_BURST_SEQ 0x0100 |
| 1610 | #define TX_PACKET_MODE_BURST_FIRST 0x0200 |
| 1611 | |
| 1612 | enum { |
| 1613 | TX_POWER_PA_NOT_ACTIVE = 0x0, |
| 1614 | }; |
| 1615 | |
| 1616 | enum { |
| 1617 | TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */ |
| 1618 | TX_STATUS_DELAY_MSK = 0x00000040, |
| 1619 | TX_STATUS_ABORT_MSK = 0x00000080, |
| 1620 | TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */ |
| 1621 | TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */ |
| 1622 | TX_RESERVED = 0x00780000, /* bits 19:22 */ |
| 1623 | TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */ |
| 1624 | TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */ |
| 1625 | }; |
| 1626 | |
| 1627 | /* ******************************* |
| 1628 | * TX aggregation status |
| 1629 | ******************************* */ |
| 1630 | |
| 1631 | enum { |
| 1632 | AGG_TX_STATE_TRANSMITTED = 0x00, |
| 1633 | AGG_TX_STATE_UNDERRUN_MSK = 0x01, |
| 1634 | AGG_TX_STATE_FEW_BYTES_MSK = 0x04, |
| 1635 | AGG_TX_STATE_ABORT_MSK = 0x08, |
| 1636 | AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10, |
| 1637 | AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20, |
| 1638 | AGG_TX_STATE_SCD_QUERY_MSK = 0x80, |
| 1639 | AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100, |
| 1640 | AGG_TX_STATE_RESPONSE_MSK = 0x1ff, |
| 1641 | AGG_TX_STATE_DUMP_TX_MSK = 0x200, |
| 1642 | AGG_TX_STATE_DELAY_TX_MSK = 0x400 |
| 1643 | }; |
| 1644 | |
| 1645 | #define AGG_TX_STATUS_MSK 0x00000fff /* bits 0:11 */ |
| 1646 | #define AGG_TX_TRY_MSK 0x0000f000 /* bits 12:15 */ |
| 1647 | |
| 1648 | #define AGG_TX_STATE_LAST_SENT_MSK (AGG_TX_STATE_LAST_SENT_TTL_MSK | \ |
| 1649 | AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK) |
| 1650 | |
| 1651 | /* # tx attempts for first frame in aggregation */ |
| 1652 | #define AGG_TX_STATE_TRY_CNT_POS 12 |
| 1653 | #define AGG_TX_STATE_TRY_CNT_MSK 0xf000 |
| 1654 | |
| 1655 | /* Command ID and sequence number of Tx command for this frame */ |
| 1656 | #define AGG_TX_STATE_SEQ_NUM_POS 16 |
| 1657 | #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000 |
| 1658 | |
| 1659 | /* |
| 1660 | * C_TX = 0x1c (response) |
| 1661 | * |
| 1662 | * This response may be in one of two slightly different formats, indicated |
| 1663 | * by the frame_count field: |
| 1664 | * |
| 1665 | * 1) No aggregation (frame_count == 1). This reports Tx results for |
| 1666 | * a single frame. Multiple attempts, at various bit rates, may have |
| 1667 | * been made for this frame. |
| 1668 | * |
| 1669 | * 2) Aggregation (frame_count > 1). This reports Tx results for |
| 1670 | * 2 or more frames that used block-acknowledge. All frames were |
| 1671 | * transmitted at same rate. Rate scaling may have been used if first |
| 1672 | * frame in this new agg block failed in previous agg block(s). |
| 1673 | * |
| 1674 | * Note that, for aggregation, ACK (block-ack) status is not delivered here; |
| 1675 | * block-ack has not been received by the time the 4965 device records |
| 1676 | * this status. |
| 1677 | * This status relates to reasons the tx might have been blocked or aborted |
| 1678 | * within the sending station (this 4965 device), rather than whether it was |
| 1679 | * received successfully by the destination station. |
| 1680 | */ |
| 1681 | struct agg_tx_status { |
| 1682 | __le16 status; |
| 1683 | __le16 sequence; |
| 1684 | } __packed; |
| 1685 | |
| 1686 | struct il4965_tx_resp { |
| 1687 | u8 frame_count; /* 1 no aggregation, >1 aggregation */ |
| 1688 | u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */ |
| 1689 | u8 failure_rts; /* # failures due to unsuccessful RTS */ |
| 1690 | u8 failure_frame; /* # failures due to no ACK (unused for agg) */ |
| 1691 | |
| 1692 | /* For non-agg: Rate at which frame was successful. |
| 1693 | * For agg: Rate at which all frames were transmitted. */ |
| 1694 | __le32 rate_n_flags; /* RATE_MCS_* */ |
| 1695 | |
| 1696 | /* For non-agg: RTS + CTS + frame tx attempts time + ACK. |
| 1697 | * For agg: RTS + CTS + aggregation tx time + block-ack time. */ |
| 1698 | __le16 wireless_media_time; /* uSecs */ |
| 1699 | |
| 1700 | __le16 reserved; |
| 1701 | __le32 pa_power1; /* RF power amplifier measurement (not used) */ |
| 1702 | __le32 pa_power2; |
| 1703 | |
| 1704 | /* |
| 1705 | * For non-agg: frame status TX_STATUS_* |
| 1706 | * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status |
| 1707 | * fields follow this one, up to frame_count. |
| 1708 | * Bit fields: |
| 1709 | * 11- 0: AGG_TX_STATE_* status code |
| 1710 | * 15-12: Retry count for 1st frame in aggregation (retries |
| 1711 | * occur if tx failed for this frame when it was a |
| 1712 | * member of a previous aggregation block). If rate |
| 1713 | * scaling is used, retry count indicates the rate |
| 1714 | * table entry used for all frames in the new agg. |
| 1715 | * 31-16: Sequence # for this frame's Tx cmd (not SSN!) |
| 1716 | */ |
| 1717 | union { |
| 1718 | __le32 status; |
| 1719 | struct agg_tx_status agg_status[0]; /* for each agg frame */ |
| 1720 | } u; |
| 1721 | } __packed; |
| 1722 | |
| 1723 | /* |
| 1724 | * N_COMPRESSED_BA = 0xc5 (response only, not a command) |
| 1725 | * |
| 1726 | * Reports Block-Acknowledge from recipient station |
| 1727 | */ |
| 1728 | struct il_compressed_ba_resp { |
| 1729 | __le32 sta_addr_lo32; |
| 1730 | __le16 sta_addr_hi16; |
| 1731 | __le16 reserved; |
| 1732 | |
| 1733 | /* Index of recipient (BA-sending) station in uCode's station table */ |
| 1734 | u8 sta_id; |
| 1735 | u8 tid; |
| 1736 | __le16 seq_ctl; |
| 1737 | __le64 bitmap; |
| 1738 | __le16 scd_flow; |
| 1739 | __le16 scd_ssn; |
| 1740 | } __packed; |
| 1741 | |
| 1742 | /* |
| 1743 | * C_TX_PWR_TBL = 0x97 (command, has simple generic response) |
| 1744 | * |
| 1745 | * See details under "TXPOWER" in 4965.h. |
| 1746 | */ |
| 1747 | |
| 1748 | struct il3945_txpowertable_cmd { |
| 1749 | u8 band; /* 0: 5 GHz, 1: 2.4 GHz */ |
| 1750 | u8 reserved; |
| 1751 | __le16 channel; |
| 1752 | struct il3945_power_per_rate power[IL_MAX_RATES]; |
| 1753 | } __packed; |
| 1754 | |
| 1755 | struct il4965_txpowertable_cmd { |
| 1756 | u8 band; /* 0: 5 GHz, 1: 2.4 GHz */ |
| 1757 | u8 reserved; |
| 1758 | __le16 channel; |
| 1759 | struct il4965_tx_power_db tx_power; |
| 1760 | } __packed; |
| 1761 | |
| 1762 | /** |
| 1763 | * struct il3945_rate_scaling_cmd - Rate Scaling Command & Response |
| 1764 | * |
| 1765 | * C_RATE_SCALE = 0x47 (command, has simple generic response) |
| 1766 | * |
| 1767 | * NOTE: The table of rates passed to the uCode via the |
| 1768 | * RATE_SCALE command sets up the corresponding order of |
| 1769 | * rates used for all related commands, including rate |
| 1770 | * masks, etc. |
| 1771 | * |
| 1772 | * For example, if you set 9MB (PLCP 0x0f) as the first |
| 1773 | * rate in the rate table, the bit mask for that rate |
| 1774 | * when passed through ofdm_basic_rates on the C_RXON |
| 1775 | * command would be bit 0 (1 << 0) |
| 1776 | */ |
| 1777 | struct il3945_rate_scaling_info { |
| 1778 | __le16 rate_n_flags; |
| 1779 | u8 try_cnt; |
| 1780 | u8 next_rate_idx; |
| 1781 | } __packed; |
| 1782 | |
| 1783 | struct il3945_rate_scaling_cmd { |
| 1784 | u8 table_id; |
| 1785 | u8 reserved[3]; |
| 1786 | struct il3945_rate_scaling_info table[IL_MAX_RATES]; |
| 1787 | } __packed; |
| 1788 | |
| 1789 | /*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */ |
| 1790 | #define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0) |
| 1791 | |
| 1792 | /* # of EDCA prioritized tx fifos */ |
| 1793 | #define LINK_QUAL_AC_NUM AC_NUM |
| 1794 | |
| 1795 | /* # entries in rate scale table to support Tx retries */ |
| 1796 | #define LINK_QUAL_MAX_RETRY_NUM 16 |
| 1797 | |
| 1798 | /* Tx antenna selection values */ |
| 1799 | #define LINK_QUAL_ANT_A_MSK (1 << 0) |
| 1800 | #define LINK_QUAL_ANT_B_MSK (1 << 1) |
| 1801 | #define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK) |
| 1802 | |
| 1803 | /** |
| 1804 | * struct il_link_qual_general_params |
| 1805 | * |
| 1806 | * Used in C_TX_LINK_QUALITY_CMD |
| 1807 | */ |
| 1808 | struct il_link_qual_general_params { |
| 1809 | u8 flags; |
| 1810 | |
| 1811 | /* No entries at or above this (driver chosen) idx contain MIMO */ |
| 1812 | u8 mimo_delimiter; |
| 1813 | |
| 1814 | /* Best single antenna to use for single stream (legacy, SISO). */ |
| 1815 | u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */ |
| 1816 | |
| 1817 | /* Best antennas to use for MIMO (unused for 4965, assumes both). */ |
| 1818 | u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */ |
| 1819 | |
| 1820 | /* |
| 1821 | * If driver needs to use different initial rates for different |
| 1822 | * EDCA QOS access categories (as implemented by tx fifos 0-3), |
| 1823 | * this table will set that up, by indicating the idxes in the |
| 1824 | * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start. |
| 1825 | * Otherwise, driver should set all entries to 0. |
| 1826 | * |
| 1827 | * Entry usage: |
| 1828 | * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice |
| 1829 | * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3. |
| 1830 | */ |
| 1831 | u8 start_rate_idx[LINK_QUAL_AC_NUM]; |
| 1832 | } __packed; |
| 1833 | |
| 1834 | #define LINK_QUAL_AGG_TIME_LIMIT_DEF (4000) /* 4 milliseconds */ |
| 1835 | #define LINK_QUAL_AGG_TIME_LIMIT_MAX (8000) |
| 1836 | #define LINK_QUAL_AGG_TIME_LIMIT_MIN (100) |
| 1837 | |
| 1838 | #define LINK_QUAL_AGG_DISABLE_START_DEF (3) |
| 1839 | #define LINK_QUAL_AGG_DISABLE_START_MAX (255) |
| 1840 | #define LINK_QUAL_AGG_DISABLE_START_MIN (0) |
| 1841 | |
| 1842 | #define LINK_QUAL_AGG_FRAME_LIMIT_DEF (31) |
| 1843 | #define LINK_QUAL_AGG_FRAME_LIMIT_MAX (63) |
| 1844 | #define LINK_QUAL_AGG_FRAME_LIMIT_MIN (0) |
| 1845 | |
| 1846 | /** |
| 1847 | * struct il_link_qual_agg_params |
| 1848 | * |
| 1849 | * Used in C_TX_LINK_QUALITY_CMD |
| 1850 | */ |
| 1851 | struct il_link_qual_agg_params { |
| 1852 | |
| 1853 | /* |
| 1854 | *Maximum number of uSec in aggregation. |
| 1855 | * default set to 4000 (4 milliseconds) if not configured in .cfg |
| 1856 | */ |
| 1857 | __le16 agg_time_limit; |
| 1858 | |
| 1859 | /* |
| 1860 | * Number of Tx retries allowed for a frame, before that frame will |
| 1861 | * no longer be considered for the start of an aggregation sequence |
| 1862 | * (scheduler will then try to tx it as single frame). |
| 1863 | * Driver should set this to 3. |
| 1864 | */ |
| 1865 | u8 agg_dis_start_th; |
| 1866 | |
| 1867 | /* |
| 1868 | * Maximum number of frames in aggregation. |
| 1869 | * 0 = no limit (default). 1 = no aggregation. |
| 1870 | * Other values = max # frames in aggregation. |
| 1871 | */ |
| 1872 | u8 agg_frame_cnt_limit; |
| 1873 | |
| 1874 | __le32 reserved; |
| 1875 | } __packed; |
| 1876 | |
| 1877 | /* |
| 1878 | * C_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response) |
| 1879 | * |
| 1880 | * For 4965 devices only; 3945 uses C_RATE_SCALE. |
| 1881 | * |
| 1882 | * Each station in the 4965 device's internal station table has its own table |
| 1883 | * of 16 |
| 1884 | * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when |
| 1885 | * an ACK is not received. This command replaces the entire table for |
| 1886 | * one station. |
| 1887 | * |
| 1888 | * NOTE: Station must already be in 4965 device's station table. |
| 1889 | * Use C_ADD_STA. |
| 1890 | * |
| 1891 | * The rate scaling procedures described below work well. Of course, other |
| 1892 | * procedures are possible, and may work better for particular environments. |
| 1893 | * |
| 1894 | * |
| 1895 | * FILLING THE RATE TBL |
| 1896 | * |
| 1897 | * Given a particular initial rate and mode, as determined by the rate |
| 1898 | * scaling algorithm described below, the Linux driver uses the following |
| 1899 | * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the |
| 1900 | * Link Quality command: |
| 1901 | * |
| 1902 | * |
| 1903 | * 1) If using High-throughput (HT) (SISO or MIMO) initial rate: |
| 1904 | * a) Use this same initial rate for first 3 entries. |
| 1905 | * b) Find next lower available rate using same mode (SISO or MIMO), |
| 1906 | * use for next 3 entries. If no lower rate available, switch to |
| 1907 | * legacy mode (no HT40 channel, no MIMO, no short guard interval). |
| 1908 | * c) If using MIMO, set command's mimo_delimiter to number of entries |
| 1909 | * using MIMO (3 or 6). |
| 1910 | * d) After trying 2 HT rates, switch to legacy mode (no HT40 channel, |
| 1911 | * no MIMO, no short guard interval), at the next lower bit rate |
| 1912 | * (e.g. if second HT bit rate was 54, try 48 legacy), and follow |
| 1913 | * legacy procedure for remaining table entries. |
| 1914 | * |
| 1915 | * 2) If using legacy initial rate: |
| 1916 | * a) Use the initial rate for only one entry. |
| 1917 | * b) For each following entry, reduce the rate to next lower available |
| 1918 | * rate, until reaching the lowest available rate. |
| 1919 | * c) When reducing rate, also switch antenna selection. |
| 1920 | * d) Once lowest available rate is reached, repeat this rate until |
| 1921 | * rate table is filled (16 entries), switching antenna each entry. |
| 1922 | * |
| 1923 | * |
| 1924 | * ACCUMULATING HISTORY |
| 1925 | * |
| 1926 | * The rate scaling algorithm for 4965 devices, as implemented in Linux driver, |
| 1927 | * uses two sets of frame Tx success history: One for the current/active |
| 1928 | * modulation mode, and one for a speculative/search mode that is being |
| 1929 | * attempted. If the speculative mode turns out to be more effective (i.e. |
| 1930 | * actual transfer rate is better), then the driver continues to use the |
| 1931 | * speculative mode as the new current active mode. |
| 1932 | * |
| 1933 | * Each history set contains, separately for each possible rate, data for a |
| 1934 | * sliding win of the 62 most recent tx attempts at that rate. The data |
| 1935 | * includes a shifting bitmap of success(1)/failure(0), and sums of successful |
| 1936 | * and attempted frames, from which the driver can additionally calculate a |
| 1937 | * success ratio (success / attempted) and number of failures |
| 1938 | * (attempted - success), and control the size of the win (attempted). |
| 1939 | * The driver uses the bit map to remove successes from the success sum, as |
| 1940 | * the oldest tx attempts fall out of the win. |
| 1941 | * |
| 1942 | * When the 4965 device makes multiple tx attempts for a given frame, each |
| 1943 | * attempt might be at a different rate, and have different modulation |
| 1944 | * characteristics (e.g. antenna, fat channel, short guard interval), as set |
| 1945 | * up in the rate scaling table in the Link Quality command. The driver must |
| 1946 | * determine which rate table entry was used for each tx attempt, to determine |
| 1947 | * which rate-specific history to update, and record only those attempts that |
| 1948 | * match the modulation characteristics of the history set. |
| 1949 | * |
| 1950 | * When using block-ack (aggregation), all frames are transmitted at the same |
| 1951 | * rate, since there is no per-attempt acknowledgment from the destination |
| 1952 | * station. The Tx response struct il_tx_resp indicates the Tx rate in |
| 1953 | * rate_n_flags field. After receiving a block-ack, the driver can update |
| 1954 | * history for the entire block all at once. |
| 1955 | * |
| 1956 | * |
| 1957 | * FINDING BEST STARTING RATE: |
| 1958 | * |
| 1959 | * When working with a selected initial modulation mode (see below), the |
| 1960 | * driver attempts to find a best initial rate. The initial rate is the |
| 1961 | * first entry in the Link Quality command's rate table. |
| 1962 | * |
| 1963 | * 1) Calculate actual throughput (success ratio * expected throughput, see |
| 1964 | * table below) for current initial rate. Do this only if enough frames |
| 1965 | * have been attempted to make the value meaningful: at least 6 failed |
| 1966 | * tx attempts, or at least 8 successes. If not enough, don't try rate |
| 1967 | * scaling yet. |
| 1968 | * |
| 1969 | * 2) Find available rates adjacent to current initial rate. Available means: |
| 1970 | * a) supported by hardware && |
| 1971 | * b) supported by association && |
| 1972 | * c) within any constraints selected by user |
| 1973 | * |
| 1974 | * 3) Gather measured throughputs for adjacent rates. These might not have |
| 1975 | * enough history to calculate a throughput. That's okay, we might try |
| 1976 | * using one of them anyway! |
| 1977 | * |
| 1978 | * 4) Try decreasing rate if, for current rate: |
| 1979 | * a) success ratio is < 15% || |
| 1980 | * b) lower adjacent rate has better measured throughput || |
| 1981 | * c) higher adjacent rate has worse throughput, and lower is unmeasured |
| 1982 | * |
| 1983 | * As a sanity check, if decrease was determined above, leave rate |
| 1984 | * unchanged if: |
| 1985 | * a) lower rate unavailable |
| 1986 | * b) success ratio at current rate > 85% (very good) |
| 1987 | * c) current measured throughput is better than expected throughput |
| 1988 | * of lower rate (under perfect 100% tx conditions, see table below) |
| 1989 | * |
| 1990 | * 5) Try increasing rate if, for current rate: |
| 1991 | * a) success ratio is < 15% || |
| 1992 | * b) both adjacent rates' throughputs are unmeasured (try it!) || |
| 1993 | * b) higher adjacent rate has better measured throughput || |
| 1994 | * c) lower adjacent rate has worse throughput, and higher is unmeasured |
| 1995 | * |
| 1996 | * As a sanity check, if increase was determined above, leave rate |
| 1997 | * unchanged if: |
| 1998 | * a) success ratio at current rate < 70%. This is not particularly |
| 1999 | * good performance; higher rate is sure to have poorer success. |
| 2000 | * |
| 2001 | * 6) Re-evaluate the rate after each tx frame. If working with block- |
| 2002 | * acknowledge, history and stats may be calculated for the entire |
| 2003 | * block (including prior history that fits within the history wins), |
| 2004 | * before re-evaluation. |
| 2005 | * |
| 2006 | * FINDING BEST STARTING MODULATION MODE: |
| 2007 | * |
| 2008 | * After working with a modulation mode for a "while" (and doing rate scaling), |
| 2009 | * the driver searches for a new initial mode in an attempt to improve |
| 2010 | * throughput. The "while" is measured by numbers of attempted frames: |
| 2011 | * |
| 2012 | * For legacy mode, search for new mode after: |
| 2013 | * 480 successful frames, or 160 failed frames |
| 2014 | * For high-throughput modes (SISO or MIMO), search for new mode after: |
| 2015 | * 4500 successful frames, or 400 failed frames |
| 2016 | * |
| 2017 | * Mode switch possibilities are (3 for each mode): |
| 2018 | * |
| 2019 | * For legacy: |
| 2020 | * Change antenna, try SISO (if HT association), try MIMO (if HT association) |
| 2021 | * For SISO: |
| 2022 | * Change antenna, try MIMO, try shortened guard interval (SGI) |
| 2023 | * For MIMO: |
| 2024 | * Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI) |
| 2025 | * |
| 2026 | * When trying a new mode, use the same bit rate as the old/current mode when |
| 2027 | * trying antenna switches and shortened guard interval. When switching to |
| 2028 | * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate |
| 2029 | * for which the expected throughput (under perfect conditions) is about the |
| 2030 | * same or slightly better than the actual measured throughput delivered by |
| 2031 | * the old/current mode. |
| 2032 | * |
| 2033 | * Actual throughput can be estimated by multiplying the expected throughput |
| 2034 | * by the success ratio (successful / attempted tx frames). Frame size is |
| 2035 | * not considered in this calculation; it assumes that frame size will average |
| 2036 | * out to be fairly consistent over several samples. The following are |
| 2037 | * metric values for expected throughput assuming 100% success ratio. |
| 2038 | * Only G band has support for CCK rates: |
| 2039 | * |
| 2040 | * RATE: 1 2 5 11 6 9 12 18 24 36 48 54 60 |
| 2041 | * |
| 2042 | * G: 7 13 35 58 40 57 72 98 121 154 177 186 186 |
| 2043 | * A: 0 0 0 0 40 57 72 98 121 154 177 186 186 |
| 2044 | * SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 202 |
| 2045 | * SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 211 |
| 2046 | * MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 251 |
| 2047 | * SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 257 |
| 2048 | * SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 257 |
| 2049 | * SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 264 |
| 2050 | * MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 289 |
| 2051 | * SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 293 |
| 2052 | * |
| 2053 | * After the new mode has been tried for a short while (minimum of 6 failed |
| 2054 | * frames or 8 successful frames), compare success ratio and actual throughput |
| 2055 | * estimate of the new mode with the old. If either is better with the new |
| 2056 | * mode, continue to use the new mode. |
| 2057 | * |
| 2058 | * Continue comparing modes until all 3 possibilities have been tried. |
| 2059 | * If moving from legacy to HT, try all 3 possibilities from the new HT |
| 2060 | * mode. After trying all 3, a best mode is found. Continue to use this mode |
| 2061 | * for the longer "while" described above (e.g. 480 successful frames for |
| 2062 | * legacy), and then repeat the search process. |
| 2063 | * |
| 2064 | */ |
| 2065 | struct il_link_quality_cmd { |
| 2066 | |
| 2067 | /* Index of destination/recipient station in uCode's station table */ |
| 2068 | u8 sta_id; |
| 2069 | u8 reserved1; |
| 2070 | __le16 control; /* not used */ |
| 2071 | struct il_link_qual_general_params general_params; |
| 2072 | struct il_link_qual_agg_params agg_params; |
| 2073 | |
| 2074 | /* |
| 2075 | * Rate info; when using rate-scaling, Tx command's initial_rate_idx |
| 2076 | * specifies 1st Tx rate attempted, via idx into this table. |
| 2077 | * 4965 devices works its way through table when retrying Tx. |
| 2078 | */ |
| 2079 | struct { |
| 2080 | __le32 rate_n_flags; /* RATE_MCS_*, RATE_* */ |
| 2081 | } rs_table[LINK_QUAL_MAX_RETRY_NUM]; |
| 2082 | __le32 reserved2; |
| 2083 | } __packed; |
| 2084 | |
| 2085 | /* |
| 2086 | * BT configuration enable flags: |
| 2087 | * bit 0 - 1: BT channel announcement enabled |
| 2088 | * 0: disable |
| 2089 | * bit 1 - 1: priority of BT device enabled |
| 2090 | * 0: disable |
| 2091 | */ |
| 2092 | #define BT_COEX_DISABLE (0x0) |
| 2093 | #define BT_ENABLE_CHANNEL_ANNOUNCE BIT(0) |
| 2094 | #define BT_ENABLE_PRIORITY BIT(1) |
| 2095 | |
| 2096 | #define BT_COEX_ENABLE (BT_ENABLE_CHANNEL_ANNOUNCE | BT_ENABLE_PRIORITY) |
| 2097 | |
| 2098 | #define BT_LEAD_TIME_DEF (0x1E) |
| 2099 | |
| 2100 | #define BT_MAX_KILL_DEF (0x5) |
| 2101 | |
| 2102 | /* |
| 2103 | * C_BT_CONFIG = 0x9b (command, has simple generic response) |
| 2104 | * |
| 2105 | * 3945 and 4965 devices support hardware handshake with Bluetooth device on |
| 2106 | * same platform. Bluetooth device alerts wireless device when it will Tx; |
| 2107 | * wireless device can delay or kill its own Tx to accommodate. |
| 2108 | */ |
| 2109 | struct il_bt_cmd { |
| 2110 | u8 flags; |
| 2111 | u8 lead_time; |
| 2112 | u8 max_kill; |
| 2113 | u8 reserved; |
| 2114 | __le32 kill_ack_mask; |
| 2115 | __le32 kill_cts_mask; |
| 2116 | } __packed; |
| 2117 | |
| 2118 | /****************************************************************************** |
| 2119 | * (6) |
| 2120 | * Spectrum Management (802.11h) Commands, Responses, Notifications: |
| 2121 | * |
| 2122 | *****************************************************************************/ |
| 2123 | |
| 2124 | /* |
| 2125 | * Spectrum Management |
| 2126 | */ |
| 2127 | #define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \ |
| 2128 | RXON_FILTER_CTL2HOST_MSK | \ |
| 2129 | RXON_FILTER_ACCEPT_GRP_MSK | \ |
| 2130 | RXON_FILTER_DIS_DECRYPT_MSK | \ |
| 2131 | RXON_FILTER_DIS_GRP_DECRYPT_MSK | \ |
| 2132 | RXON_FILTER_ASSOC_MSK | \ |
| 2133 | RXON_FILTER_BCON_AWARE_MSK) |
| 2134 | |
| 2135 | struct il_measure_channel { |
| 2136 | __le32 duration; /* measurement duration in extended beacon |
| 2137 | * format */ |
| 2138 | u8 channel; /* channel to measure */ |
| 2139 | u8 type; /* see enum il_measure_type */ |
| 2140 | __le16 reserved; |
| 2141 | } __packed; |
| 2142 | |
| 2143 | /* |
| 2144 | * C_SPECTRUM_MEASUREMENT = 0x74 (command) |
| 2145 | */ |
| 2146 | struct il_spectrum_cmd { |
| 2147 | __le16 len; /* number of bytes starting from token */ |
| 2148 | u8 token; /* token id */ |
| 2149 | u8 id; /* measurement id -- 0 or 1 */ |
| 2150 | u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */ |
| 2151 | u8 periodic; /* 1 = periodic */ |
| 2152 | __le16 path_loss_timeout; |
| 2153 | __le32 start_time; /* start time in extended beacon format */ |
| 2154 | __le32 reserved2; |
| 2155 | __le32 flags; /* rxon flags */ |
| 2156 | __le32 filter_flags; /* rxon filter flags */ |
| 2157 | __le16 channel_count; /* minimum 1, maximum 10 */ |
| 2158 | __le16 reserved3; |
| 2159 | struct il_measure_channel channels[10]; |
| 2160 | } __packed; |
| 2161 | |
| 2162 | /* |
| 2163 | * C_SPECTRUM_MEASUREMENT = 0x74 (response) |
| 2164 | */ |
| 2165 | struct il_spectrum_resp { |
| 2166 | u8 token; |
| 2167 | u8 id; /* id of the prior command replaced, or 0xff */ |
| 2168 | __le16 status; /* 0 - command will be handled |
| 2169 | * 1 - cannot handle (conflicts with another |
| 2170 | * measurement) */ |
| 2171 | } __packed; |
| 2172 | |
| 2173 | enum il_measurement_state { |
| 2174 | IL_MEASUREMENT_START = 0, |
| 2175 | IL_MEASUREMENT_STOP = 1, |
| 2176 | }; |
| 2177 | |
| 2178 | enum il_measurement_status { |
| 2179 | IL_MEASUREMENT_OK = 0, |
| 2180 | IL_MEASUREMENT_CONCURRENT = 1, |
| 2181 | IL_MEASUREMENT_CSA_CONFLICT = 2, |
| 2182 | IL_MEASUREMENT_TGH_CONFLICT = 3, |
| 2183 | /* 4-5 reserved */ |
| 2184 | IL_MEASUREMENT_STOPPED = 6, |
| 2185 | IL_MEASUREMENT_TIMEOUT = 7, |
| 2186 | IL_MEASUREMENT_PERIODIC_FAILED = 8, |
| 2187 | }; |
| 2188 | |
| 2189 | #define NUM_ELEMENTS_IN_HISTOGRAM 8 |
| 2190 | |
| 2191 | struct il_measurement_histogram { |
| 2192 | __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */ |
| 2193 | __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */ |
| 2194 | } __packed; |
| 2195 | |
| 2196 | /* clear channel availability counters */ |
| 2197 | struct il_measurement_cca_counters { |
| 2198 | __le32 ofdm; |
| 2199 | __le32 cck; |
| 2200 | } __packed; |
| 2201 | |
| 2202 | enum il_measure_type { |
| 2203 | IL_MEASURE_BASIC = (1 << 0), |
| 2204 | IL_MEASURE_CHANNEL_LOAD = (1 << 1), |
| 2205 | IL_MEASURE_HISTOGRAM_RPI = (1 << 2), |
| 2206 | IL_MEASURE_HISTOGRAM_NOISE = (1 << 3), |
| 2207 | IL_MEASURE_FRAME = (1 << 4), |
| 2208 | /* bits 5:6 are reserved */ |
| 2209 | IL_MEASURE_IDLE = (1 << 7), |
| 2210 | }; |
| 2211 | |
| 2212 | /* |
| 2213 | * N_SPECTRUM_MEASUREMENT = 0x75 (notification only, not a command) |
| 2214 | */ |
| 2215 | struct il_spectrum_notification { |
| 2216 | u8 id; /* measurement id -- 0 or 1 */ |
| 2217 | u8 token; |
| 2218 | u8 channel_idx; /* idx in measurement channel list */ |
| 2219 | u8 state; /* 0 - start, 1 - stop */ |
| 2220 | __le32 start_time; /* lower 32-bits of TSF */ |
| 2221 | u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */ |
| 2222 | u8 channel; |
| 2223 | u8 type; /* see enum il_measurement_type */ |
| 2224 | u8 reserved1; |
| 2225 | /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only |
| 2226 | * valid if applicable for measurement type requested. */ |
| 2227 | __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */ |
| 2228 | __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */ |
| 2229 | __le32 cca_time; /* channel load time in usecs */ |
| 2230 | u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 - |
| 2231 | * unidentified */ |
| 2232 | u8 reserved2[3]; |
| 2233 | struct il_measurement_histogram histogram; |
| 2234 | __le32 stop_time; /* lower 32-bits of TSF */ |
| 2235 | __le32 status; /* see il_measurement_status */ |
| 2236 | } __packed; |
| 2237 | |
| 2238 | /****************************************************************************** |
| 2239 | * (7) |
| 2240 | * Power Management Commands, Responses, Notifications: |
| 2241 | * |
| 2242 | *****************************************************************************/ |
| 2243 | |
| 2244 | /** |
| 2245 | * struct il_powertable_cmd - Power Table Command |
| 2246 | * @flags: See below: |
| 2247 | * |
| 2248 | * C_POWER_TBL = 0x77 (command, has simple generic response) |
| 2249 | * |
| 2250 | * PM allow: |
| 2251 | * bit 0 - '0' Driver not allow power management |
| 2252 | * '1' Driver allow PM (use rest of parameters) |
| 2253 | * |
| 2254 | * uCode send sleep notifications: |
| 2255 | * bit 1 - '0' Don't send sleep notification |
| 2256 | * '1' send sleep notification (SEND_PM_NOTIFICATION) |
| 2257 | * |
| 2258 | * Sleep over DTIM |
| 2259 | * bit 2 - '0' PM have to walk up every DTIM |
| 2260 | * '1' PM could sleep over DTIM till listen Interval. |
| 2261 | * |
| 2262 | * PCI power managed |
| 2263 | * bit 3 - '0' (PCI_CFG_LINK_CTRL & 0x1) |
| 2264 | * '1' !(PCI_CFG_LINK_CTRL & 0x1) |
| 2265 | * |
| 2266 | * Fast PD |
| 2267 | * bit 4 - '1' Put radio to sleep when receiving frame for others |
| 2268 | * |
| 2269 | * Force sleep Modes |
| 2270 | * bit 31/30- '00' use both mac/xtal sleeps |
| 2271 | * '01' force Mac sleep |
| 2272 | * '10' force xtal sleep |
| 2273 | * '11' Illegal set |
| 2274 | * |
| 2275 | * NOTE: if sleep_interval[SLEEP_INTRVL_TBL_SIZE-1] > DTIM period then |
| 2276 | * ucode assume sleep over DTIM is allowed and we don't need to wake up |
| 2277 | * for every DTIM. |
| 2278 | */ |
| 2279 | #define IL_POWER_VEC_SIZE 5 |
| 2280 | |
| 2281 | #define IL_POWER_DRIVER_ALLOW_SLEEP_MSK cpu_to_le16(BIT(0)) |
| 2282 | #define IL_POWER_PCI_PM_MSK cpu_to_le16(BIT(3)) |
| 2283 | |
| 2284 | struct il3945_powertable_cmd { |
| 2285 | __le16 flags; |
| 2286 | u8 reserved[2]; |
| 2287 | __le32 rx_data_timeout; |
| 2288 | __le32 tx_data_timeout; |
| 2289 | __le32 sleep_interval[IL_POWER_VEC_SIZE]; |
| 2290 | } __packed; |
| 2291 | |
| 2292 | struct il_powertable_cmd { |
| 2293 | __le16 flags; |
| 2294 | u8 keep_alive_seconds; /* 3945 reserved */ |
| 2295 | u8 debug_flags; /* 3945 reserved */ |
| 2296 | __le32 rx_data_timeout; |
| 2297 | __le32 tx_data_timeout; |
| 2298 | __le32 sleep_interval[IL_POWER_VEC_SIZE]; |
| 2299 | __le32 keep_alive_beacons; |
| 2300 | } __packed; |
| 2301 | |
| 2302 | /* |
| 2303 | * N_PM_SLEEP = 0x7A (notification only, not a command) |
| 2304 | * all devices identical. |
| 2305 | */ |
| 2306 | struct il_sleep_notification { |
| 2307 | u8 pm_sleep_mode; |
| 2308 | u8 pm_wakeup_src; |
| 2309 | __le16 reserved; |
| 2310 | __le32 sleep_time; |
| 2311 | __le32 tsf_low; |
| 2312 | __le32 bcon_timer; |
| 2313 | } __packed; |
| 2314 | |
| 2315 | /* Sleep states. all devices identical. */ |
| 2316 | enum { |
| 2317 | IL_PM_NO_SLEEP = 0, |
| 2318 | IL_PM_SLP_MAC = 1, |
| 2319 | IL_PM_SLP_FULL_MAC_UNASSOCIATE = 2, |
| 2320 | IL_PM_SLP_FULL_MAC_CARD_STATE = 3, |
| 2321 | IL_PM_SLP_PHY = 4, |
| 2322 | IL_PM_SLP_REPENT = 5, |
| 2323 | IL_PM_WAKEUP_BY_TIMER = 6, |
| 2324 | IL_PM_WAKEUP_BY_DRIVER = 7, |
| 2325 | IL_PM_WAKEUP_BY_RFKILL = 8, |
| 2326 | /* 3 reserved */ |
| 2327 | IL_PM_NUM_OF_MODES = 12, |
| 2328 | }; |
| 2329 | |
| 2330 | /* |
| 2331 | * N_CARD_STATE = 0xa1 (notification only, not a command) |
| 2332 | */ |
| 2333 | struct il_card_state_notif { |
| 2334 | __le32 flags; |
| 2335 | } __packed; |
| 2336 | |
| 2337 | #define HW_CARD_DISABLED 0x01 |
| 2338 | #define SW_CARD_DISABLED 0x02 |
| 2339 | #define CT_CARD_DISABLED 0x04 |
| 2340 | #define RXON_CARD_DISABLED 0x10 |
| 2341 | |
| 2342 | struct il_ct_kill_config { |
| 2343 | __le32 reserved; |
| 2344 | __le32 critical_temperature_M; |
| 2345 | __le32 critical_temperature_R; |
| 2346 | } __packed; |
| 2347 | |
| 2348 | /****************************************************************************** |
| 2349 | * (8) |
| 2350 | * Scan Commands, Responses, Notifications: |
| 2351 | * |
| 2352 | *****************************************************************************/ |
| 2353 | |
| 2354 | #define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0) |
| 2355 | #define SCAN_CHANNEL_TYPE_ACTIVE cpu_to_le32(1) |
| 2356 | |
| 2357 | /** |
| 2358 | * struct il_scan_channel - entry in C_SCAN channel table |
| 2359 | * |
| 2360 | * One for each channel in the scan list. |
| 2361 | * Each channel can independently select: |
| 2362 | * 1) SSID for directed active scans |
| 2363 | * 2) Txpower setting (for rate specified within Tx command) |
| 2364 | * 3) How long to stay on-channel (behavior may be modified by quiet_time, |
| 2365 | * quiet_plcp_th, good_CRC_th) |
| 2366 | * |
| 2367 | * To avoid uCode errors, make sure the following are true (see comments |
| 2368 | * under struct il_scan_cmd about max_out_time and quiet_time): |
| 2369 | * 1) If using passive_dwell (i.e. passive_dwell != 0): |
| 2370 | * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0) |
| 2371 | * 2) quiet_time <= active_dwell |
| 2372 | * 3) If restricting off-channel time (i.e. max_out_time !=0): |
| 2373 | * passive_dwell < max_out_time |
| 2374 | * active_dwell < max_out_time |
| 2375 | */ |
| 2376 | struct il3945_scan_channel { |
| 2377 | /* |
| 2378 | * type is defined as: |
| 2379 | * 0:0 1 = active, 0 = passive |
| 2380 | * 1:4 SSID direct bit map; if a bit is set, then corresponding |
| 2381 | * SSID IE is transmitted in probe request. |
| 2382 | * 5:7 reserved |
| 2383 | */ |
| 2384 | u8 type; |
| 2385 | u8 channel; /* band is selected by il3945_scan_cmd "flags" field */ |
| 2386 | struct il3945_tx_power tpc; |
| 2387 | __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */ |
| 2388 | __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */ |
| 2389 | } __packed; |
| 2390 | |
| 2391 | /* set number of direct probes u8 type */ |
| 2392 | #define IL39_SCAN_PROBE_MASK(n) ((BIT(n) | (BIT(n) - BIT(1)))) |
| 2393 | |
| 2394 | struct il_scan_channel { |
| 2395 | /* |
| 2396 | * type is defined as: |
| 2397 | * 0:0 1 = active, 0 = passive |
| 2398 | * 1:20 SSID direct bit map; if a bit is set, then corresponding |
| 2399 | * SSID IE is transmitted in probe request. |
| 2400 | * 21:31 reserved |
| 2401 | */ |
| 2402 | __le32 type; |
| 2403 | __le16 channel; /* band is selected by il_scan_cmd "flags" field */ |
| 2404 | u8 tx_gain; /* gain for analog radio */ |
| 2405 | u8 dsp_atten; /* gain for DSP */ |
| 2406 | __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */ |
| 2407 | __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */ |
| 2408 | } __packed; |
| 2409 | |
| 2410 | /* set number of direct probes __le32 type */ |
| 2411 | #define IL_SCAN_PROBE_MASK(n) cpu_to_le32((BIT(n) | (BIT(n) - BIT(1)))) |
| 2412 | |
| 2413 | /** |
| 2414 | * struct il_ssid_ie - directed scan network information element |
| 2415 | * |
| 2416 | * Up to 20 of these may appear in C_SCAN (Note: Only 4 are in |
| 2417 | * 3945 SCAN api), selected by "type" bit field in struct il_scan_channel; |
| 2418 | * each channel may select different ssids from among the 20 (4) entries. |
| 2419 | * SSID IEs get transmitted in reverse order of entry. |
| 2420 | */ |
| 2421 | struct il_ssid_ie { |
| 2422 | u8 id; |
| 2423 | u8 len; |
| 2424 | u8 ssid[32]; |
| 2425 | } __packed; |
| 2426 | |
| 2427 | #define PROBE_OPTION_MAX_3945 4 |
| 2428 | #define PROBE_OPTION_MAX 20 |
| 2429 | #define TX_CMD_LIFE_TIME_INFINITE cpu_to_le32(0xFFFFFFFF) |
| 2430 | #define IL_GOOD_CRC_TH_DISABLED 0 |
| 2431 | #define IL_GOOD_CRC_TH_DEFAULT cpu_to_le16(1) |
| 2432 | #define IL_GOOD_CRC_TH_NEVER cpu_to_le16(0xffff) |
| 2433 | #define IL_MAX_SCAN_SIZE 1024 |
| 2434 | #define IL_MAX_CMD_SIZE 4096 |
| 2435 | |
| 2436 | /* |
| 2437 | * C_SCAN = 0x80 (command) |
| 2438 | * |
| 2439 | * The hardware scan command is very powerful; the driver can set it up to |
| 2440 | * maintain (relatively) normal network traffic while doing a scan in the |
| 2441 | * background. The max_out_time and suspend_time control the ratio of how |
| 2442 | * long the device stays on an associated network channel ("service channel") |
| 2443 | * vs. how long it's away from the service channel, i.e. tuned to other channels |
| 2444 | * for scanning. |
| 2445 | * |
| 2446 | * max_out_time is the max time off-channel (in usec), and suspend_time |
| 2447 | * is how long (in "extended beacon" format) that the scan is "suspended" |
| 2448 | * after returning to the service channel. That is, suspend_time is the |
| 2449 | * time that we stay on the service channel, doing normal work, between |
| 2450 | * scan segments. The driver may set these parameters differently to support |
| 2451 | * scanning when associated vs. not associated, and light vs. heavy traffic |
| 2452 | * loads when associated. |
| 2453 | * |
| 2454 | * After receiving this command, the device's scan engine does the following; |
| 2455 | * |
| 2456 | * 1) Sends SCAN_START notification to driver |
| 2457 | * 2) Checks to see if it has time to do scan for one channel |
| 2458 | * 3) Sends NULL packet, with power-save (PS) bit set to 1, |
| 2459 | * to tell AP that we're going off-channel |
| 2460 | * 4) Tunes to first channel in scan list, does active or passive scan |
| 2461 | * 5) Sends SCAN_RESULT notification to driver |
| 2462 | * 6) Checks to see if it has time to do scan on *next* channel in list |
| 2463 | * 7) Repeats 4-6 until it no longer has time to scan the next channel |
| 2464 | * before max_out_time expires |
| 2465 | * 8) Returns to service channel |
| 2466 | * 9) Sends NULL packet with PS=0 to tell AP that we're back |
| 2467 | * 10) Stays on service channel until suspend_time expires |
| 2468 | * 11) Repeats entire process 2-10 until list is complete |
| 2469 | * 12) Sends SCAN_COMPLETE notification |
| 2470 | * |
| 2471 | * For fast, efficient scans, the scan command also has support for staying on |
| 2472 | * a channel for just a short time, if doing active scanning and getting no |
| 2473 | * responses to the transmitted probe request. This time is controlled by |
| 2474 | * quiet_time, and the number of received packets below which a channel is |
| 2475 | * considered "quiet" is controlled by quiet_plcp_threshold. |
| 2476 | * |
| 2477 | * For active scanning on channels that have regulatory restrictions against |
| 2478 | * blindly transmitting, the scan can listen before transmitting, to make sure |
| 2479 | * that there is already legitimate activity on the channel. If enough |
| 2480 | * packets are cleanly received on the channel (controlled by good_CRC_th, |
| 2481 | * typical value 1), the scan engine starts transmitting probe requests. |
| 2482 | * |
| 2483 | * Driver must use separate scan commands for 2.4 vs. 5 GHz bands. |
| 2484 | * |
| 2485 | * To avoid uCode errors, see timing restrictions described under |
| 2486 | * struct il_scan_channel. |
| 2487 | */ |
| 2488 | |
| 2489 | struct il3945_scan_cmd { |
| 2490 | __le16 len; |
| 2491 | u8 reserved0; |
| 2492 | u8 channel_count; /* # channels in channel list */ |
| 2493 | __le16 quiet_time; /* dwell only this # millisecs on quiet channel |
| 2494 | * (only for active scan) */ |
| 2495 | __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */ |
| 2496 | __le16 good_CRC_th; /* passive -> active promotion threshold */ |
| 2497 | __le16 reserved1; |
| 2498 | __le32 max_out_time; /* max usec to be away from associated (service) |
| 2499 | * channel */ |
| 2500 | __le32 suspend_time; /* pause scan this long (in "extended beacon |
| 2501 | * format") when returning to service channel: |
| 2502 | * 3945; 31:24 # beacons, 19:0 additional usec, |
| 2503 | * 4965; 31:22 # beacons, 21:0 additional usec. |
| 2504 | */ |
| 2505 | __le32 flags; /* RXON_FLG_* */ |
| 2506 | __le32 filter_flags; /* RXON_FILTER_* */ |
| 2507 | |
| 2508 | /* For active scans (set to all-0s for passive scans). |
| 2509 | * Does not include payload. Must specify Tx rate; no rate scaling. */ |
| 2510 | struct il3945_tx_cmd tx_cmd; |
| 2511 | |
| 2512 | /* For directed active scans (set to all-0s otherwise) */ |
| 2513 | struct il_ssid_ie direct_scan[PROBE_OPTION_MAX_3945]; |
| 2514 | |
| 2515 | /* |
| 2516 | * Probe request frame, followed by channel list. |
| 2517 | * |
| 2518 | * Size of probe request frame is specified by byte count in tx_cmd. |
| 2519 | * Channel list follows immediately after probe request frame. |
| 2520 | * Number of channels in list is specified by channel_count. |
| 2521 | * Each channel in list is of type: |
| 2522 | * |
| 2523 | * struct il3945_scan_channel channels[0]; |
| 2524 | * |
| 2525 | * NOTE: Only one band of channels can be scanned per pass. You |
| 2526 | * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait |
| 2527 | * for one scan to complete (i.e. receive N_SCAN_COMPLETE) |
| 2528 | * before requesting another scan. |
| 2529 | */ |
| 2530 | u8 data[0]; |
| 2531 | } __packed; |
| 2532 | |
| 2533 | struct il_scan_cmd { |
| 2534 | __le16 len; |
| 2535 | u8 reserved0; |
| 2536 | u8 channel_count; /* # channels in channel list */ |
| 2537 | __le16 quiet_time; /* dwell only this # millisecs on quiet channel |
| 2538 | * (only for active scan) */ |
| 2539 | __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */ |
| 2540 | __le16 good_CRC_th; /* passive -> active promotion threshold */ |
| 2541 | __le16 rx_chain; /* RXON_RX_CHAIN_* */ |
| 2542 | __le32 max_out_time; /* max usec to be away from associated (service) |
| 2543 | * channel */ |
| 2544 | __le32 suspend_time; /* pause scan this long (in "extended beacon |
| 2545 | * format") when returning to service chnl: |
| 2546 | * 3945; 31:24 # beacons, 19:0 additional usec, |
| 2547 | * 4965; 31:22 # beacons, 21:0 additional usec. |
| 2548 | */ |
| 2549 | __le32 flags; /* RXON_FLG_* */ |
| 2550 | __le32 filter_flags; /* RXON_FILTER_* */ |
| 2551 | |
| 2552 | /* For active scans (set to all-0s for passive scans). |
| 2553 | * Does not include payload. Must specify Tx rate; no rate scaling. */ |
| 2554 | struct il_tx_cmd tx_cmd; |
| 2555 | |
| 2556 | /* For directed active scans (set to all-0s otherwise) */ |
| 2557 | struct il_ssid_ie direct_scan[PROBE_OPTION_MAX]; |
| 2558 | |
| 2559 | /* |
| 2560 | * Probe request frame, followed by channel list. |
| 2561 | * |
| 2562 | * Size of probe request frame is specified by byte count in tx_cmd. |
| 2563 | * Channel list follows immediately after probe request frame. |
| 2564 | * Number of channels in list is specified by channel_count. |
| 2565 | * Each channel in list is of type: |
| 2566 | * |
| 2567 | * struct il_scan_channel channels[0]; |
| 2568 | * |
| 2569 | * NOTE: Only one band of channels can be scanned per pass. You |
| 2570 | * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait |
| 2571 | * for one scan to complete (i.e. receive N_SCAN_COMPLETE) |
| 2572 | * before requesting another scan. |
| 2573 | */ |
| 2574 | u8 data[0]; |
| 2575 | } __packed; |
| 2576 | |
| 2577 | /* Can abort will notify by complete notification with abort status. */ |
| 2578 | #define CAN_ABORT_STATUS cpu_to_le32(0x1) |
| 2579 | /* complete notification statuses */ |
| 2580 | #define ABORT_STATUS 0x2 |
| 2581 | |
| 2582 | /* |
| 2583 | * C_SCAN = 0x80 (response) |
| 2584 | */ |
| 2585 | struct il_scanreq_notification { |
| 2586 | __le32 status; /* 1: okay, 2: cannot fulfill request */ |
| 2587 | } __packed; |
| 2588 | |
| 2589 | /* |
| 2590 | * N_SCAN_START = 0x82 (notification only, not a command) |
| 2591 | */ |
| 2592 | struct il_scanstart_notification { |
| 2593 | __le32 tsf_low; |
| 2594 | __le32 tsf_high; |
| 2595 | __le32 beacon_timer; |
| 2596 | u8 channel; |
| 2597 | u8 band; |
| 2598 | u8 reserved[2]; |
| 2599 | __le32 status; |
| 2600 | } __packed; |
| 2601 | |
| 2602 | #define SCAN_OWNER_STATUS 0x1 |
| 2603 | #define MEASURE_OWNER_STATUS 0x2 |
| 2604 | |
| 2605 | #define IL_PROBE_STATUS_OK 0 |
| 2606 | #define IL_PROBE_STATUS_TX_FAILED BIT(0) |
| 2607 | /* error statuses combined with TX_FAILED */ |
| 2608 | #define IL_PROBE_STATUS_FAIL_TTL BIT(1) |
| 2609 | #define IL_PROBE_STATUS_FAIL_BT BIT(2) |
| 2610 | |
| 2611 | #define NUMBER_OF_STATS 1 /* first __le32 is good CRC */ |
| 2612 | /* |
| 2613 | * N_SCAN_RESULTS = 0x83 (notification only, not a command) |
| 2614 | */ |
| 2615 | struct il_scanresults_notification { |
| 2616 | u8 channel; |
| 2617 | u8 band; |
| 2618 | u8 probe_status; |
| 2619 | u8 num_probe_not_sent; /* not enough time to send */ |
| 2620 | __le32 tsf_low; |
| 2621 | __le32 tsf_high; |
| 2622 | __le32 stats[NUMBER_OF_STATS]; |
| 2623 | } __packed; |
| 2624 | |
| 2625 | /* |
| 2626 | * N_SCAN_COMPLETE = 0x84 (notification only, not a command) |
| 2627 | */ |
| 2628 | struct il_scancomplete_notification { |
| 2629 | u8 scanned_channels; |
| 2630 | u8 status; |
| 2631 | u8 last_channel; |
| 2632 | __le32 tsf_low; |
| 2633 | __le32 tsf_high; |
| 2634 | } __packed; |
| 2635 | |
| 2636 | /****************************************************************************** |
| 2637 | * (9) |
| 2638 | * IBSS/AP Commands and Notifications: |
| 2639 | * |
| 2640 | *****************************************************************************/ |
| 2641 | |
| 2642 | enum il_ibss_manager { |
| 2643 | IL_NOT_IBSS_MANAGER = 0, |
| 2644 | IL_IBSS_MANAGER = 1, |
| 2645 | }; |
| 2646 | |
| 2647 | /* |
| 2648 | * N_BEACON = 0x90 (notification only, not a command) |
| 2649 | */ |
| 2650 | |
| 2651 | struct il3945_beacon_notif { |
| 2652 | struct il3945_tx_resp beacon_notify_hdr; |
| 2653 | __le32 low_tsf; |
| 2654 | __le32 high_tsf; |
| 2655 | __le32 ibss_mgr_status; |
| 2656 | } __packed; |
| 2657 | |
| 2658 | struct il4965_beacon_notif { |
| 2659 | struct il4965_tx_resp beacon_notify_hdr; |
| 2660 | __le32 low_tsf; |
| 2661 | __le32 high_tsf; |
| 2662 | __le32 ibss_mgr_status; |
| 2663 | } __packed; |
| 2664 | |
| 2665 | /* |
| 2666 | * C_TX_BEACON= 0x91 (command, has simple generic response) |
| 2667 | */ |
| 2668 | |
| 2669 | struct il3945_tx_beacon_cmd { |
| 2670 | struct il3945_tx_cmd tx; |
| 2671 | __le16 tim_idx; |
| 2672 | u8 tim_size; |
| 2673 | u8 reserved1; |
| 2674 | struct ieee80211_hdr frame[0]; /* beacon frame */ |
| 2675 | } __packed; |
| 2676 | |
| 2677 | struct il_tx_beacon_cmd { |
| 2678 | struct il_tx_cmd tx; |
| 2679 | __le16 tim_idx; |
| 2680 | u8 tim_size; |
| 2681 | u8 reserved1; |
| 2682 | struct ieee80211_hdr frame[0]; /* beacon frame */ |
| 2683 | } __packed; |
| 2684 | |
| 2685 | /****************************************************************************** |
| 2686 | * (10) |
| 2687 | * Statistics Commands and Notifications: |
| 2688 | * |
| 2689 | *****************************************************************************/ |
| 2690 | |
| 2691 | #define IL_TEMP_CONVERT 260 |
| 2692 | |
| 2693 | #define SUP_RATE_11A_MAX_NUM_CHANNELS 8 |
| 2694 | #define SUP_RATE_11B_MAX_NUM_CHANNELS 4 |
| 2695 | #define SUP_RATE_11G_MAX_NUM_CHANNELS 12 |
| 2696 | |
| 2697 | /* Used for passing to driver number of successes and failures per rate */ |
| 2698 | struct rate_histogram { |
| 2699 | union { |
| 2700 | __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS]; |
| 2701 | __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS]; |
| 2702 | __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS]; |
| 2703 | } success; |
| 2704 | union { |
| 2705 | __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS]; |
| 2706 | __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS]; |
| 2707 | __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS]; |
| 2708 | } failed; |
| 2709 | } __packed; |
| 2710 | |
| 2711 | /* stats command response */ |
| 2712 | |
| 2713 | struct iwl39_stats_rx_phy { |
| 2714 | __le32 ina_cnt; |
| 2715 | __le32 fina_cnt; |
| 2716 | __le32 plcp_err; |
| 2717 | __le32 crc32_err; |
| 2718 | __le32 overrun_err; |
| 2719 | __le32 early_overrun_err; |
| 2720 | __le32 crc32_good; |
| 2721 | __le32 false_alarm_cnt; |
| 2722 | __le32 fina_sync_err_cnt; |
| 2723 | __le32 sfd_timeout; |
| 2724 | __le32 fina_timeout; |
| 2725 | __le32 unresponded_rts; |
| 2726 | __le32 rxe_frame_limit_overrun; |
| 2727 | __le32 sent_ack_cnt; |
| 2728 | __le32 sent_cts_cnt; |
| 2729 | } __packed; |
| 2730 | |
| 2731 | struct iwl39_stats_rx_non_phy { |
| 2732 | __le32 bogus_cts; /* CTS received when not expecting CTS */ |
| 2733 | __le32 bogus_ack; /* ACK received when not expecting ACK */ |
| 2734 | __le32 non_bssid_frames; /* number of frames with BSSID that |
| 2735 | * doesn't belong to the STA BSSID */ |
| 2736 | __le32 filtered_frames; /* count frames that were dumped in the |
| 2737 | * filtering process */ |
| 2738 | __le32 non_channel_beacons; /* beacons with our bss id but not on |
| 2739 | * our serving channel */ |
| 2740 | } __packed; |
| 2741 | |
| 2742 | struct iwl39_stats_rx { |
| 2743 | struct iwl39_stats_rx_phy ofdm; |
| 2744 | struct iwl39_stats_rx_phy cck; |
| 2745 | struct iwl39_stats_rx_non_phy general; |
| 2746 | } __packed; |
| 2747 | |
| 2748 | struct iwl39_stats_tx { |
| 2749 | __le32 preamble_cnt; |
| 2750 | __le32 rx_detected_cnt; |
| 2751 | __le32 bt_prio_defer_cnt; |
| 2752 | __le32 bt_prio_kill_cnt; |
| 2753 | __le32 few_bytes_cnt; |
| 2754 | __le32 cts_timeout; |
| 2755 | __le32 ack_timeout; |
| 2756 | __le32 expected_ack_cnt; |
| 2757 | __le32 actual_ack_cnt; |
| 2758 | } __packed; |
| 2759 | |
| 2760 | struct stats_dbg { |
| 2761 | __le32 burst_check; |
| 2762 | __le32 burst_count; |
| 2763 | __le32 wait_for_silence_timeout_cnt; |
| 2764 | __le32 reserved[3]; |
| 2765 | } __packed; |
| 2766 | |
| 2767 | struct iwl39_stats_div { |
| 2768 | __le32 tx_on_a; |
| 2769 | __le32 tx_on_b; |
| 2770 | __le32 exec_time; |
| 2771 | __le32 probe_time; |
| 2772 | } __packed; |
| 2773 | |
| 2774 | struct iwl39_stats_general { |
| 2775 | __le32 temperature; |
| 2776 | struct stats_dbg dbg; |
| 2777 | __le32 sleep_time; |
| 2778 | __le32 slots_out; |
| 2779 | __le32 slots_idle; |
| 2780 | __le32 ttl_timestamp; |
| 2781 | struct iwl39_stats_div div; |
| 2782 | } __packed; |
| 2783 | |
| 2784 | struct stats_rx_phy { |
| 2785 | __le32 ina_cnt; |
| 2786 | __le32 fina_cnt; |
| 2787 | __le32 plcp_err; |
| 2788 | __le32 crc32_err; |
| 2789 | __le32 overrun_err; |
| 2790 | __le32 early_overrun_err; |
| 2791 | __le32 crc32_good; |
| 2792 | __le32 false_alarm_cnt; |
| 2793 | __le32 fina_sync_err_cnt; |
| 2794 | __le32 sfd_timeout; |
| 2795 | __le32 fina_timeout; |
| 2796 | __le32 unresponded_rts; |
| 2797 | __le32 rxe_frame_limit_overrun; |
| 2798 | __le32 sent_ack_cnt; |
| 2799 | __le32 sent_cts_cnt; |
| 2800 | __le32 sent_ba_rsp_cnt; |
| 2801 | __le32 dsp_self_kill; |
| 2802 | __le32 mh_format_err; |
| 2803 | __le32 re_acq_main_rssi_sum; |
| 2804 | __le32 reserved3; |
| 2805 | } __packed; |
| 2806 | |
| 2807 | struct stats_rx_ht_phy { |
| 2808 | __le32 plcp_err; |
| 2809 | __le32 overrun_err; |
| 2810 | __le32 early_overrun_err; |
| 2811 | __le32 crc32_good; |
| 2812 | __le32 crc32_err; |
| 2813 | __le32 mh_format_err; |
| 2814 | __le32 agg_crc32_good; |
| 2815 | __le32 agg_mpdu_cnt; |
| 2816 | __le32 agg_cnt; |
| 2817 | __le32 unsupport_mcs; |
| 2818 | } __packed; |
| 2819 | |
| 2820 | #define INTERFERENCE_DATA_AVAILABLE cpu_to_le32(1) |
| 2821 | |
| 2822 | struct stats_rx_non_phy { |
| 2823 | __le32 bogus_cts; /* CTS received when not expecting CTS */ |
| 2824 | __le32 bogus_ack; /* ACK received when not expecting ACK */ |
| 2825 | __le32 non_bssid_frames; /* number of frames with BSSID that |
| 2826 | * doesn't belong to the STA BSSID */ |
| 2827 | __le32 filtered_frames; /* count frames that were dumped in the |
| 2828 | * filtering process */ |
| 2829 | __le32 non_channel_beacons; /* beacons with our bss id but not on |
| 2830 | * our serving channel */ |
| 2831 | __le32 channel_beacons; /* beacons with our bss id and in our |
| 2832 | * serving channel */ |
| 2833 | __le32 num_missed_bcon; /* number of missed beacons */ |
| 2834 | __le32 adc_rx_saturation_time; /* count in 0.8us units the time the |
| 2835 | * ADC was in saturation */ |
| 2836 | __le32 ina_detection_search_time; /* total time (in 0.8us) searched |
| 2837 | * for INA */ |
| 2838 | __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */ |
| 2839 | __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */ |
| 2840 | __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */ |
| 2841 | __le32 interference_data_flag; /* flag for interference data |
| 2842 | * availability. 1 when data is |
| 2843 | * available. */ |
| 2844 | __le32 channel_load; /* counts RX Enable time in uSec */ |
| 2845 | __le32 dsp_false_alarms; /* DSP false alarm (both OFDM |
| 2846 | * and CCK) counter */ |
| 2847 | __le32 beacon_rssi_a; |
| 2848 | __le32 beacon_rssi_b; |
| 2849 | __le32 beacon_rssi_c; |
| 2850 | __le32 beacon_energy_a; |
| 2851 | __le32 beacon_energy_b; |
| 2852 | __le32 beacon_energy_c; |
| 2853 | } __packed; |
| 2854 | |
| 2855 | struct stats_rx { |
| 2856 | struct stats_rx_phy ofdm; |
| 2857 | struct stats_rx_phy cck; |
| 2858 | struct stats_rx_non_phy general; |
| 2859 | struct stats_rx_ht_phy ofdm_ht; |
| 2860 | } __packed; |
| 2861 | |
| 2862 | /** |
| 2863 | * struct stats_tx_power - current tx power |
| 2864 | * |
| 2865 | * @ant_a: current tx power on chain a in 1/2 dB step |
| 2866 | * @ant_b: current tx power on chain b in 1/2 dB step |
| 2867 | * @ant_c: current tx power on chain c in 1/2 dB step |
| 2868 | */ |
| 2869 | struct stats_tx_power { |
| 2870 | u8 ant_a; |
| 2871 | u8 ant_b; |
| 2872 | u8 ant_c; |
| 2873 | u8 reserved; |
| 2874 | } __packed; |
| 2875 | |
| 2876 | struct stats_tx_non_phy_agg { |
| 2877 | __le32 ba_timeout; |
| 2878 | __le32 ba_reschedule_frames; |
| 2879 | __le32 scd_query_agg_frame_cnt; |
| 2880 | __le32 scd_query_no_agg; |
| 2881 | __le32 scd_query_agg; |
| 2882 | __le32 scd_query_mismatch; |
| 2883 | __le32 frame_not_ready; |
| 2884 | __le32 underrun; |
| 2885 | __le32 bt_prio_kill; |
| 2886 | __le32 rx_ba_rsp_cnt; |
| 2887 | } __packed; |
| 2888 | |
| 2889 | struct stats_tx { |
| 2890 | __le32 preamble_cnt; |
| 2891 | __le32 rx_detected_cnt; |
| 2892 | __le32 bt_prio_defer_cnt; |
| 2893 | __le32 bt_prio_kill_cnt; |
| 2894 | __le32 few_bytes_cnt; |
| 2895 | __le32 cts_timeout; |
| 2896 | __le32 ack_timeout; |
| 2897 | __le32 expected_ack_cnt; |
| 2898 | __le32 actual_ack_cnt; |
| 2899 | __le32 dump_msdu_cnt; |
| 2900 | __le32 burst_abort_next_frame_mismatch_cnt; |
| 2901 | __le32 burst_abort_missing_next_frame_cnt; |
| 2902 | __le32 cts_timeout_collision; |
| 2903 | __le32 ack_or_ba_timeout_collision; |
| 2904 | struct stats_tx_non_phy_agg agg; |
| 2905 | |
| 2906 | __le32 reserved1; |
| 2907 | } __packed; |
| 2908 | |
| 2909 | struct stats_div { |
| 2910 | __le32 tx_on_a; |
| 2911 | __le32 tx_on_b; |
| 2912 | __le32 exec_time; |
| 2913 | __le32 probe_time; |
| 2914 | __le32 reserved1; |
| 2915 | __le32 reserved2; |
| 2916 | } __packed; |
| 2917 | |
| 2918 | struct stats_general_common { |
| 2919 | __le32 temperature; /* radio temperature */ |
| 2920 | struct stats_dbg dbg; |
| 2921 | __le32 sleep_time; |
| 2922 | __le32 slots_out; |
| 2923 | __le32 slots_idle; |
| 2924 | __le32 ttl_timestamp; |
| 2925 | struct stats_div div; |
| 2926 | __le32 rx_enable_counter; |
| 2927 | /* |
| 2928 | * num_of_sos_states: |
| 2929 | * count the number of times we have to re-tune |
| 2930 | * in order to get out of bad PHY status |
| 2931 | */ |
| 2932 | __le32 num_of_sos_states; |
| 2933 | } __packed; |
| 2934 | |
| 2935 | struct stats_general { |
| 2936 | struct stats_general_common common; |
| 2937 | __le32 reserved2; |
| 2938 | __le32 reserved3; |
| 2939 | } __packed; |
| 2940 | |
| 2941 | #define UCODE_STATS_CLEAR_MSK (0x1 << 0) |
| 2942 | #define UCODE_STATS_FREQUENCY_MSK (0x1 << 1) |
| 2943 | #define UCODE_STATS_NARROW_BAND_MSK (0x1 << 2) |
| 2944 | |
| 2945 | /* |
| 2946 | * C_STATS = 0x9c, |
| 2947 | * all devices identical. |
| 2948 | * |
| 2949 | * This command triggers an immediate response containing uCode stats. |
| 2950 | * The response is in the same format as N_STATS 0x9d, below. |
| 2951 | * |
| 2952 | * If the CLEAR_STATS configuration flag is set, uCode will clear its |
| 2953 | * internal copy of the stats (counters) after issuing the response. |
| 2954 | * This flag does not affect N_STATSs after beacons (see below). |
| 2955 | * |
| 2956 | * If the DISABLE_NOTIF configuration flag is set, uCode will not issue |
| 2957 | * N_STATSs after received beacons (see below). This flag |
| 2958 | * does not affect the response to the C_STATS 0x9c itself. |
| 2959 | */ |
| 2960 | #define IL_STATS_CONF_CLEAR_STATS cpu_to_le32(0x1) /* see above */ |
| 2961 | #define IL_STATS_CONF_DISABLE_NOTIF cpu_to_le32(0x2) /* see above */ |
| 2962 | struct il_stats_cmd { |
| 2963 | __le32 configuration_flags; /* IL_STATS_CONF_* */ |
| 2964 | } __packed; |
| 2965 | |
| 2966 | /* |
| 2967 | * N_STATS = 0x9d (notification only, not a command) |
| 2968 | * |
| 2969 | * By default, uCode issues this notification after receiving a beacon |
| 2970 | * while associated. To disable this behavior, set DISABLE_NOTIF flag in the |
| 2971 | * C_STATS 0x9c, above. |
| 2972 | * |
| 2973 | * Statistics counters continue to increment beacon after beacon, but are |
| 2974 | * cleared when changing channels or when driver issues C_STATS |
| 2975 | * 0x9c with CLEAR_STATS bit set (see above). |
| 2976 | * |
| 2977 | * uCode also issues this notification during scans. uCode clears stats |
| 2978 | * appropriately so that each notification contains stats for only the |
| 2979 | * one channel that has just been scanned. |
| 2980 | */ |
| 2981 | #define STATS_REPLY_FLG_BAND_24G_MSK cpu_to_le32(0x2) |
| 2982 | #define STATS_REPLY_FLG_HT40_MODE_MSK cpu_to_le32(0x8) |
| 2983 | |
| 2984 | struct il3945_notif_stats { |
| 2985 | __le32 flag; |
| 2986 | struct iwl39_stats_rx rx; |
| 2987 | struct iwl39_stats_tx tx; |
| 2988 | struct iwl39_stats_general general; |
| 2989 | } __packed; |
| 2990 | |
| 2991 | struct il_notif_stats { |
| 2992 | __le32 flag; |
| 2993 | struct stats_rx rx; |
| 2994 | struct stats_tx tx; |
| 2995 | struct stats_general general; |
| 2996 | } __packed; |
| 2997 | |
| 2998 | /* |
| 2999 | * N_MISSED_BEACONS = 0xa2 (notification only, not a command) |
| 3000 | * |
| 3001 | * uCode send N_MISSED_BEACONS to driver when detect beacon missed |
| 3002 | * in regardless of how many missed beacons, which mean when driver receive the |
| 3003 | * notification, inside the command, it can find all the beacons information |
| 3004 | * which include number of total missed beacons, number of consecutive missed |
| 3005 | * beacons, number of beacons received and number of beacons expected to |
| 3006 | * receive. |
| 3007 | * |
| 3008 | * If uCode detected consecutive_missed_beacons > 5, it will reset the radio |
| 3009 | * in order to bring the radio/PHY back to working state; which has no relation |
| 3010 | * to when driver will perform sensitivity calibration. |
| 3011 | * |
| 3012 | * Driver should set it own missed_beacon_threshold to decide when to perform |
| 3013 | * sensitivity calibration based on number of consecutive missed beacons in |
| 3014 | * order to improve overall performance, especially in noisy environment. |
| 3015 | * |
| 3016 | */ |
| 3017 | |
| 3018 | #define IL_MISSED_BEACON_THRESHOLD_MIN (1) |
| 3019 | #define IL_MISSED_BEACON_THRESHOLD_DEF (5) |
| 3020 | #define IL_MISSED_BEACON_THRESHOLD_MAX IL_MISSED_BEACON_THRESHOLD_DEF |
| 3021 | |
| 3022 | struct il_missed_beacon_notif { |
| 3023 | __le32 consecutive_missed_beacons; |
| 3024 | __le32 total_missed_becons; |
| 3025 | __le32 num_expected_beacons; |
| 3026 | __le32 num_recvd_beacons; |
| 3027 | } __packed; |
| 3028 | |
| 3029 | /****************************************************************************** |
| 3030 | * (11) |
| 3031 | * Rx Calibration Commands: |
| 3032 | * |
| 3033 | * With the uCode used for open source drivers, most Tx calibration (except |
| 3034 | * for Tx Power) and most Rx calibration is done by uCode during the |
| 3035 | * "initialize" phase of uCode boot. Driver must calibrate only: |
| 3036 | * |
| 3037 | * 1) Tx power (depends on temperature), described elsewhere |
| 3038 | * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas) |
| 3039 | * 3) Receiver sensitivity (to optimize signal detection) |
| 3040 | * |
| 3041 | *****************************************************************************/ |
| 3042 | |
| 3043 | /** |
| 3044 | * C_SENSITIVITY = 0xa8 (command, has simple generic response) |
| 3045 | * |
| 3046 | * This command sets up the Rx signal detector for a sensitivity level that |
| 3047 | * is high enough to lock onto all signals within the associated network, |
| 3048 | * but low enough to ignore signals that are below a certain threshold, so as |
| 3049 | * not to have too many "false alarms". False alarms are signals that the |
| 3050 | * Rx DSP tries to lock onto, but then discards after determining that they |
| 3051 | * are noise. |
| 3052 | * |
| 3053 | * The optimum number of false alarms is between 5 and 50 per 200 TUs |
| 3054 | * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e. |
| 3055 | * time listening, not transmitting). Driver must adjust sensitivity so that |
| 3056 | * the ratio of actual false alarms to actual Rx time falls within this range. |
| 3057 | * |
| 3058 | * While associated, uCode delivers N_STATSs after each |
| 3059 | * received beacon. These provide information to the driver to analyze the |
| 3060 | * sensitivity. Don't analyze stats that come in from scanning, or any |
| 3061 | * other non-associated-network source. Pertinent stats include: |
| 3062 | * |
| 3063 | * From "general" stats (struct stats_rx_non_phy): |
| 3064 | * |
| 3065 | * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level) |
| 3066 | * Measure of energy of desired signal. Used for establishing a level |
| 3067 | * below which the device does not detect signals. |
| 3068 | * |
| 3069 | * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB) |
| 3070 | * Measure of background noise in silent period after beacon. |
| 3071 | * |
| 3072 | * channel_load |
| 3073 | * uSecs of actual Rx time during beacon period (varies according to |
| 3074 | * how much time was spent transmitting). |
| 3075 | * |
| 3076 | * From "cck" and "ofdm" stats (struct stats_rx_phy), separately: |
| 3077 | * |
| 3078 | * false_alarm_cnt |
| 3079 | * Signal locks abandoned early (before phy-level header). |
| 3080 | * |
| 3081 | * plcp_err |
| 3082 | * Signal locks abandoned late (during phy-level header). |
| 3083 | * |
| 3084 | * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from |
| 3085 | * beacon to beacon, i.e. each value is an accumulation of all errors |
| 3086 | * before and including the latest beacon. Values will wrap around to 0 |
| 3087 | * after counting up to 2^32 - 1. Driver must differentiate vs. |
| 3088 | * previous beacon's values to determine # false alarms in the current |
| 3089 | * beacon period. |
| 3090 | * |
| 3091 | * Total number of false alarms = false_alarms + plcp_errs |
| 3092 | * |
| 3093 | * For OFDM, adjust the following table entries in struct il_sensitivity_cmd |
| 3094 | * (notice that the start points for OFDM are at or close to settings for |
| 3095 | * maximum sensitivity): |
| 3096 | * |
| 3097 | * START / MIN / MAX |
| 3098 | * HD_AUTO_CORR32_X1_TH_ADD_MIN_IDX 90 / 85 / 120 |
| 3099 | * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_IDX 170 / 170 / 210 |
| 3100 | * HD_AUTO_CORR32_X4_TH_ADD_MIN_IDX 105 / 105 / 140 |
| 3101 | * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_IDX 220 / 220 / 270 |
| 3102 | * |
| 3103 | * If actual rate of OFDM false alarms (+ plcp_errors) is too high |
| 3104 | * (greater than 50 for each 204.8 msecs listening), reduce sensitivity |
| 3105 | * by *adding* 1 to all 4 of the table entries above, up to the max for |
| 3106 | * each entry. Conversely, if false alarm rate is too low (less than 5 |
| 3107 | * for each 204.8 msecs listening), *subtract* 1 from each entry to |
| 3108 | * increase sensitivity. |
| 3109 | * |
| 3110 | * For CCK sensitivity, keep track of the following: |
| 3111 | * |
| 3112 | * 1). 20-beacon history of maximum background noise, indicated by |
| 3113 | * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the |
| 3114 | * 3 receivers. For any given beacon, the "silence reference" is |
| 3115 | * the maximum of last 60 samples (20 beacons * 3 receivers). |
| 3116 | * |
| 3117 | * 2). 10-beacon history of strongest signal level, as indicated |
| 3118 | * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers, |
| 3119 | * i.e. the strength of the signal through the best receiver at the |
| 3120 | * moment. These measurements are "upside down", with lower values |
| 3121 | * for stronger signals, so max energy will be *minimum* value. |
| 3122 | * |
| 3123 | * Then for any given beacon, the driver must determine the *weakest* |
| 3124 | * of the strongest signals; this is the minimum level that needs to be |
| 3125 | * successfully detected, when using the best receiver at the moment. |
| 3126 | * "Max cck energy" is the maximum (higher value means lower energy!) |
| 3127 | * of the last 10 minima. Once this is determined, driver must add |
| 3128 | * a little margin by adding "6" to it. |
| 3129 | * |
| 3130 | * 3). Number of consecutive beacon periods with too few false alarms. |
| 3131 | * Reset this to 0 at the first beacon period that falls within the |
| 3132 | * "good" range (5 to 50 false alarms per 204.8 milliseconds rx). |
| 3133 | * |
| 3134 | * Then, adjust the following CCK table entries in struct il_sensitivity_cmd |
| 3135 | * (notice that the start points for CCK are at maximum sensitivity): |
| 3136 | * |
| 3137 | * START / MIN / MAX |
| 3138 | * HD_AUTO_CORR40_X4_TH_ADD_MIN_IDX 125 / 125 / 200 |
| 3139 | * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_IDX 200 / 200 / 400 |
| 3140 | * HD_MIN_ENERGY_CCK_DET_IDX 100 / 0 / 100 |
| 3141 | * |
| 3142 | * If actual rate of CCK false alarms (+ plcp_errors) is too high |
| 3143 | * (greater than 50 for each 204.8 msecs listening), method for reducing |
| 3144 | * sensitivity is: |
| 3145 | * |
| 3146 | * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_IDX, |
| 3147 | * up to max 400. |
| 3148 | * |
| 3149 | * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_IDX is < 160, |
| 3150 | * sensitivity has been reduced a significant amount; bring it up to |
| 3151 | * a moderate 161. Otherwise, *add* 3, up to max 200. |
| 3152 | * |
| 3153 | * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_IDX is > 160, |
| 3154 | * sensitivity has been reduced only a moderate or small amount; |
| 3155 | * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_IDX, |
| 3156 | * down to min 0. Otherwise (if gain has been significantly reduced), |
| 3157 | * don't change the HD_MIN_ENERGY_CCK_DET_IDX value. |
| 3158 | * |
| 3159 | * b) Save a snapshot of the "silence reference". |
| 3160 | * |
| 3161 | * If actual rate of CCK false alarms (+ plcp_errors) is too low |
| 3162 | * (less than 5 for each 204.8 msecs listening), method for increasing |
| 3163 | * sensitivity is used only if: |
| 3164 | * |
| 3165 | * 1a) Previous beacon did not have too many false alarms |
| 3166 | * 1b) AND difference between previous "silence reference" and current |
| 3167 | * "silence reference" (prev - current) is 2 or more, |
| 3168 | * OR 2) 100 or more consecutive beacon periods have had rate of |
| 3169 | * less than 5 false alarms per 204.8 milliseconds rx time. |
| 3170 | * |
| 3171 | * Method for increasing sensitivity: |
| 3172 | * |
| 3173 | * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_IDX, |
| 3174 | * down to min 125. |
| 3175 | * |
| 3176 | * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_IDX, |
| 3177 | * down to min 200. |
| 3178 | * |
| 3179 | * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_IDX, up to max 100. |
| 3180 | * |
| 3181 | * If actual rate of CCK false alarms (+ plcp_errors) is within good range |
| 3182 | * (between 5 and 50 for each 204.8 msecs listening): |
| 3183 | * |
| 3184 | * 1) Save a snapshot of the silence reference. |
| 3185 | * |
| 3186 | * 2) If previous beacon had too many CCK false alarms (+ plcp_errors), |
| 3187 | * give some extra margin to energy threshold by *subtracting* 8 |
| 3188 | * from value in HD_MIN_ENERGY_CCK_DET_IDX. |
| 3189 | * |
| 3190 | * For all cases (too few, too many, good range), make sure that the CCK |
| 3191 | * detection threshold (energy) is below the energy level for robust |
| 3192 | * detection over the past 10 beacon periods, the "Max cck energy". |
| 3193 | * Lower values mean higher energy; this means making sure that the value |
| 3194 | * in HD_MIN_ENERGY_CCK_DET_IDX is at or *above* "Max cck energy". |
| 3195 | * |
| 3196 | */ |
| 3197 | |
| 3198 | /* |
| 3199 | * Table entries in C_SENSITIVITY (struct il_sensitivity_cmd) |
| 3200 | */ |
| 3201 | #define HD_TBL_SIZE (11) /* number of entries */ |
| 3202 | #define HD_MIN_ENERGY_CCK_DET_IDX (0) /* table idxes */ |
| 3203 | #define HD_MIN_ENERGY_OFDM_DET_IDX (1) |
| 3204 | #define HD_AUTO_CORR32_X1_TH_ADD_MIN_IDX (2) |
| 3205 | #define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_IDX (3) |
| 3206 | #define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_IDX (4) |
| 3207 | #define HD_AUTO_CORR32_X4_TH_ADD_MIN_IDX (5) |
| 3208 | #define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_IDX (6) |
| 3209 | #define HD_BARKER_CORR_TH_ADD_MIN_IDX (7) |
| 3210 | #define HD_BARKER_CORR_TH_ADD_MIN_MRC_IDX (8) |
| 3211 | #define HD_AUTO_CORR40_X4_TH_ADD_MIN_IDX (9) |
| 3212 | #define HD_OFDM_ENERGY_TH_IN_IDX (10) |
| 3213 | |
| 3214 | /* Control field in struct il_sensitivity_cmd */ |
| 3215 | #define C_SENSITIVITY_CONTROL_DEFAULT_TBL cpu_to_le16(0) |
| 3216 | #define C_SENSITIVITY_CONTROL_WORK_TBL cpu_to_le16(1) |
| 3217 | |
| 3218 | /** |
| 3219 | * struct il_sensitivity_cmd |
| 3220 | * @control: (1) updates working table, (0) updates default table |
| 3221 | * @table: energy threshold values, use HD_* as idx into table |
| 3222 | * |
| 3223 | * Always use "1" in "control" to update uCode's working table and DSP. |
| 3224 | */ |
| 3225 | struct il_sensitivity_cmd { |
| 3226 | __le16 control; /* always use "1" */ |
| 3227 | __le16 table[HD_TBL_SIZE]; /* use HD_* as idx */ |
| 3228 | } __packed; |
| 3229 | |
| 3230 | /** |
| 3231 | * C_PHY_CALIBRATION = 0xb0 (command, has simple generic response) |
| 3232 | * |
| 3233 | * This command sets the relative gains of 4965 device's 3 radio receiver chains. |
| 3234 | * |
| 3235 | * After the first association, driver should accumulate signal and noise |
| 3236 | * stats from the N_STATSs that follow the first 20 |
| 3237 | * beacons from the associated network (don't collect stats that come |
| 3238 | * in from scanning, or any other non-network source). |
| 3239 | * |
| 3240 | * DISCONNECTED ANTENNA: |
| 3241 | * |
| 3242 | * Driver should determine which antennas are actually connected, by comparing |
| 3243 | * average beacon signal levels for the 3 Rx chains. Accumulate (add) the |
| 3244 | * following values over 20 beacons, one accumulator for each of the chains |
| 3245 | * a/b/c, from struct stats_rx_non_phy: |
| 3246 | * |
| 3247 | * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB) |
| 3248 | * |
| 3249 | * Find the strongest signal from among a/b/c. Compare the other two to the |
| 3250 | * strongest. If any signal is more than 15 dB (times 20, unless you |
| 3251 | * divide the accumulated values by 20) below the strongest, the driver |
| 3252 | * considers that antenna to be disconnected, and should not try to use that |
| 3253 | * antenna/chain for Rx or Tx. If both A and B seem to be disconnected, |
| 3254 | * driver should declare the stronger one as connected, and attempt to use it |
| 3255 | * (A and B are the only 2 Tx chains!). |
| 3256 | * |
| 3257 | * |
| 3258 | * RX BALANCE: |
| 3259 | * |
| 3260 | * Driver should balance the 3 receivers (but just the ones that are connected |
| 3261 | * to antennas, see above) for gain, by comparing the average signal levels |
| 3262 | * detected during the silence after each beacon (background noise). |
| 3263 | * Accumulate (add) the following values over 20 beacons, one accumulator for |
| 3264 | * each of the chains a/b/c, from struct stats_rx_non_phy: |
| 3265 | * |
| 3266 | * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB) |
| 3267 | * |
| 3268 | * Find the weakest background noise level from among a/b/c. This Rx chain |
| 3269 | * will be the reference, with 0 gain adjustment. Attenuate other channels by |
| 3270 | * finding noise difference: |
| 3271 | * |
| 3272 | * (accum_noise[i] - accum_noise[reference]) / 30 |
| 3273 | * |
| 3274 | * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB. |
| 3275 | * For use in diff_gain_[abc] fields of struct il_calibration_cmd, the |
| 3276 | * driver should limit the difference results to a range of 0-3 (0-4.5 dB), |
| 3277 | * and set bit 2 to indicate "reduce gain". The value for the reference |
| 3278 | * (weakest) chain should be "0". |
| 3279 | * |
| 3280 | * diff_gain_[abc] bit fields: |
| 3281 | * 2: (1) reduce gain, (0) increase gain |
| 3282 | * 1-0: amount of gain, units of 1.5 dB |
| 3283 | */ |
| 3284 | |
| 3285 | /* Phy calibration command for series */ |
| 3286 | /* The default calibrate table size if not specified by firmware */ |
| 3287 | #define IL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18 |
| 3288 | enum { |
| 3289 | IL_PHY_CALIBRATE_DIFF_GAIN_CMD = 7, |
| 3290 | IL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE = 19, |
| 3291 | }; |
| 3292 | |
| 3293 | #define IL_MAX_PHY_CALIBRATE_TBL_SIZE (253) |
| 3294 | |
| 3295 | struct il_calib_hdr { |
| 3296 | u8 op_code; |
| 3297 | u8 first_group; |
| 3298 | u8 groups_num; |
| 3299 | u8 data_valid; |
| 3300 | } __packed; |
| 3301 | |
| 3302 | /* IL_PHY_CALIBRATE_DIFF_GAIN_CMD (7) */ |
| 3303 | struct il_calib_diff_gain_cmd { |
| 3304 | struct il_calib_hdr hdr; |
| 3305 | s8 diff_gain_a; /* see above */ |
| 3306 | s8 diff_gain_b; |
| 3307 | s8 diff_gain_c; |
| 3308 | u8 reserved1; |
| 3309 | } __packed; |
| 3310 | |
| 3311 | /****************************************************************************** |
| 3312 | * (12) |
| 3313 | * Miscellaneous Commands: |
| 3314 | * |
| 3315 | *****************************************************************************/ |
| 3316 | |
| 3317 | /* |
| 3318 | * LEDs Command & Response |
| 3319 | * C_LEDS = 0x48 (command, has simple generic response) |
| 3320 | * |
| 3321 | * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field), |
| 3322 | * this command turns it on or off, or sets up a periodic blinking cycle. |
| 3323 | */ |
| 3324 | struct il_led_cmd { |
| 3325 | __le32 interval; /* "interval" in uSec */ |
| 3326 | u8 id; /* 1: Activity, 2: Link, 3: Tech */ |
| 3327 | u8 off; /* # intervals off while blinking; |
| 3328 | * "0", with >0 "on" value, turns LED on */ |
| 3329 | u8 on; /* # intervals on while blinking; |
| 3330 | * "0", regardless of "off", turns LED off */ |
| 3331 | u8 reserved; |
| 3332 | } __packed; |
| 3333 | |
| 3334 | /****************************************************************************** |
| 3335 | * (13) |
| 3336 | * Union of all expected notifications/responses: |
| 3337 | * |
| 3338 | *****************************************************************************/ |
| 3339 | |
| 3340 | #define IL_RX_FRAME_SIZE_MSK 0x00003fff |
| 3341 | |
| 3342 | struct il_rx_pkt { |
| 3343 | /* |
| 3344 | * The first 4 bytes of the RX frame header contain both the RX frame |
| 3345 | * size and some flags. |
| 3346 | * Bit fields: |
| 3347 | * 31: flag flush RB request |
| 3348 | * 30: flag ignore TC (terminal counter) request |
| 3349 | * 29: flag fast IRQ request |
| 3350 | * 28-14: Reserved |
| 3351 | * 13-00: RX frame size |
| 3352 | */ |
| 3353 | __le32 len_n_flags; |
| 3354 | struct il_cmd_header hdr; |
| 3355 | union { |
| 3356 | struct il3945_rx_frame rx_frame; |
| 3357 | struct il3945_tx_resp tx_resp; |
| 3358 | struct il3945_beacon_notif beacon_status; |
| 3359 | |
| 3360 | struct il_alive_resp alive_frame; |
| 3361 | struct il_spectrum_notification spectrum_notif; |
| 3362 | struct il_csa_notification csa_notif; |
| 3363 | struct il_error_resp err_resp; |
| 3364 | struct il_card_state_notif card_state_notif; |
| 3365 | struct il_add_sta_resp add_sta; |
| 3366 | struct il_rem_sta_resp rem_sta; |
| 3367 | struct il_sleep_notification sleep_notif; |
| 3368 | struct il_spectrum_resp spectrum; |
| 3369 | struct il_notif_stats stats; |
| 3370 | struct il_compressed_ba_resp compressed_ba; |
| 3371 | struct il_missed_beacon_notif missed_beacon; |
| 3372 | __le32 status; |
| 3373 | u8 raw[0]; |
| 3374 | } u; |
| 3375 | } __packed; |
| 3376 | |
| 3377 | #endif /* __il_commands_h__ */ |