drivers/net/wireless/iwlwifi/iwl-commands.h

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