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