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