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

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