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

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