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