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