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