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