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

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