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