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

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