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

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