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

   1 /******************************************************************************
   2  *
   3  * This file is provided under a dual BSD/GPLv2 license.  When using or
   4  * redistributing this file, you may do so under either license.
   5  *
   6  * GPL LICENSE SUMMARY
   7  *
   8  * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of version 2 of the GNU General Public License as
  12  * published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  22  * USA
  23  *
  24  * The full GNU General Public License is included in this distribution
  25  * in the file called LICENSE.GPL.
  26  *
  27  * Contact Information:
  28  *  Intel Linux Wireless <ilw@linux.intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  *
  40  *  * Redistributions of source code must retain the above copyright
  41  *    notice, this list of conditions and the following disclaimer.
  42  *  * Redistributions in binary form must reproduce the above copyright
  43  *    notice, this list of conditions and the following disclaimer in
  44  *    the documentation and/or other materials provided with the
  45  *    distribution.
  46  *  * Neither the name Intel Corporation nor the names of its
  47  *    contributors may be used to endorse or promote products derived
  48  *    from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  54  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  56  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  60  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  *
  62  *****************************************************************************/
  63 /*
  64  * Please use this file (iwl-commands.h) only for uCode API definitions.
  65  * Please use iwl-xxxx-hw.h for hardware-related definitions.
  66  * Please use iwl-dev.h for driver implementation definitions.
  67  */
  68
  69 #ifndef __iwl_commands_h__
  70 #define __iwl_commands_h__
  71
  72 struct iwl_priv;
  73
  74 /* uCode version contains 4 values: Major/Minor/API/Serial */
  75 #define IWL_UCODE_MAJOR(ver)    (((ver) & 0xFF000000) >> 24)
  76 #define IWL_UCODE_MINOR(ver)    (((ver) & 0x00FF0000) >> 16)
  77 #define IWL_UCODE_API(ver)      (((ver) & 0x0000FF00) >> 8)
  78 #define IWL_UCODE_SERIAL(ver)   ((ver) & 0x000000FF)
  79
  80
  81 /* Tx rates */
  82 #define IWL_CCK_RATES   4
  83 #define IWL_OFDM_RATES  8
  84 #define IWL_MAX_RATES   (IWL_CCK_RATES + IWL_OFDM_RATES)
  85
  86 enum {
  87         REPLY_ALIVE = 0x1,
  88         REPLY_ERROR = 0x2,
  89
  90         /* RXON and QOS commands */
  91         REPLY_RXON = 0x10,
  92         REPLY_RXON_ASSOC = 0x11,
  93         REPLY_QOS_PARAM = 0x13,
  94         REPLY_RXON_TIMING = 0x14,
  95
  96         /* Multi-Station support */
  97         REPLY_ADD_STA = 0x18,
  98         REPLY_REMOVE_STA = 0x19,
  99         REPLY_REMOVE_ALL_STA = 0x1a,    /* not used */
 100         REPLY_TXFIFO_FLUSH = 0x1e,
 101
 102         /* Security */
 103         REPLY_WEPKEY = 0x20,
 104
 105         /* RX, TX, LEDs */
 106         REPLY_TX = 0x1c,
 107         REPLY_LEDS_CMD = 0x48,
 108         REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* for 4965 and up */
 109
 110         /* WiMAX coexistence */
 111         COEX_PRIORITY_TABLE_CMD = 0x5a, /* for 5000 series and up */
 112         COEX_MEDIUM_NOTIFICATION = 0x5b,
 113         COEX_EVENT_CMD = 0x5c,
 114
 115         /* Calibration */
 116         TEMPERATURE_NOTIFICATION = 0x62,
 117         CALIBRATION_CFG_CMD = 0x65,
 118         CALIBRATION_RES_NOTIFICATION = 0x66,
 119         CALIBRATION_COMPLETE_NOTIFICATION = 0x67,
 120
 121         /* 802.11h related */
 122         REPLY_QUIET_CMD = 0x71,         /* not used */
 123         REPLY_CHANNEL_SWITCH = 0x72,
 124         CHANNEL_SWITCH_NOTIFICATION = 0x73,
 125         REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
 126         SPECTRUM_MEASURE_NOTIFICATION = 0x75,
 127
 128         /* Power Management */
 129         POWER_TABLE_CMD = 0x77,
 130         PM_SLEEP_NOTIFICATION = 0x7A,
 131         PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
 132
 133         /* Scan commands and notifications */
 134         REPLY_SCAN_CMD = 0x80,
 135         REPLY_SCAN_ABORT_CMD = 0x81,
 136         SCAN_START_NOTIFICATION = 0x82,
 137         SCAN_RESULTS_NOTIFICATION = 0x83,
 138         SCAN_COMPLETE_NOTIFICATION = 0x84,
 139
 140         /* IBSS/AP commands */
 141         BEACON_NOTIFICATION = 0x90,
 142         REPLY_TX_BEACON = 0x91,
 143         WHO_IS_AWAKE_NOTIFICATION = 0x94,       /* not used */
 144
 145         /* Miscellaneous commands */
 146         REPLY_TX_POWER_DBM_CMD = 0x95,
 147         QUIET_NOTIFICATION = 0x96,              /* not used */
 148         REPLY_TX_PWR_TABLE_CMD = 0x97,
 149         REPLY_TX_POWER_DBM_CMD_V1 = 0x98,       /* old version of API */
 150         TX_ANT_CONFIGURATION_CMD = 0x98,
 151         MEASURE_ABORT_NOTIFICATION = 0x99,      /* not used */
 152
 153         /* Bluetooth device coexistence config command */
 154         REPLY_BT_CONFIG = 0x9b,
 155
 156         /* Statistics */
 157         REPLY_STATISTICS_CMD = 0x9c,
 158         STATISTICS_NOTIFICATION = 0x9d,
 159
 160         /* RF-KILL commands and notifications */
 161         REPLY_CARD_STATE_CMD = 0xa0,
 162         CARD_STATE_NOTIFICATION = 0xa1,
 163
 164         /* Missed beacons notification */
 165         MISSED_BEACONS_NOTIFICATION = 0xa2,
 166
 167         REPLY_CT_KILL_CONFIG_CMD = 0xa4,
 168         SENSITIVITY_CMD = 0xa8,
 169         REPLY_PHY_CALIBRATION_CMD = 0xb0,
 170         REPLY_RX_PHY_CMD = 0xc0,
 171         REPLY_RX_MPDU_CMD = 0xc1,
 172         REPLY_RX = 0xc3,
 173         REPLY_COMPRESSED_BA = 0xc5,
 174
 175         /* BT Coex */
 176         REPLY_BT_COEX_PRIO_TABLE = 0xcc,
 177         REPLY_BT_COEX_PROT_ENV = 0xcd,
 178         REPLY_BT_COEX_PROFILE_NOTIF = 0xce,
 179
 180         /* PAN commands */
 181         REPLY_WIPAN_PARAMS = 0xb2,
 182         REPLY_WIPAN_RXON = 0xb3,        /* use REPLY_RXON structure */
 183         REPLY_WIPAN_RXON_TIMING = 0xb4, /* use REPLY_RXON_TIMING structure */
 184         REPLY_WIPAN_RXON_ASSOC = 0xb6,  /* use REPLY_RXON_ASSOC structure */
 185         REPLY_WIPAN_QOS_PARAM = 0xb7,   /* use REPLY_QOS_PARAM structure */
 186         REPLY_WIPAN_WEPKEY = 0xb8,      /* use REPLY_WEPKEY structure */
 187         REPLY_WIPAN_P2P_CHANNEL_SWITCH = 0xb9,
 188         REPLY_WIPAN_NOA_NOTIFICATION = 0xbc,
 189         REPLY_WIPAN_DEACTIVATION_COMPLETE = 0xbd,
 190
 191         REPLY_MAX = 0xff
 192 };
 193
 194 /******************************************************************************
 195  * (0)
 196  * Commonly used structures and definitions:
 197  * Command header, rate_n_flags, txpower
 198  *
 199  *****************************************************************************/
 200
 201 /* iwl_cmd_header flags value */
 202 #define IWL_CMD_FAILED_MSK 0x40
 203
 204 #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
 205 #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
 206 #define SEQ_TO_INDEX(s) ((s) & 0xff)
 207 #define INDEX_TO_SEQ(i) ((i) & 0xff)
 208 #define SEQ_HUGE_FRAME  cpu_to_le16(0x4000)
 209 #define SEQ_RX_FRAME    cpu_to_le16(0x8000)
 210
 211 /**
 212  * struct iwl_cmd_header
 213  *
 214  * This header format appears in the beginning of each command sent from the
 215  * driver, and each response/notification received from uCode.
 216  */
 217 struct iwl_cmd_header {
 218         u8 cmd;         /* Command ID:  REPLY_RXON, etc. */
 219         u8 flags;       /* 0:5 reserved, 6 abort, 7 internal */
 220         /*
 221          * The driver sets up the sequence number to values of its choosing.
 222          * uCode does not use this value, but passes it back to the driver
 223          * when sending the response to each driver-originated command, so
 224          * the driver can match the response to the command.  Since the values
 225          * don't get used by uCode, the driver may set up an arbitrary format.
 226          *
 227          * There is one exception:  uCode sets bit 15 when it originates
 228          * the response/notification, i.e. when the response/notification
 229          * is not a direct response to a command sent by the driver.  For
 230          * example, uCode issues REPLY_RX when it sends a received frame
 231          * to the driver; it is not a direct response to any driver command.
 232          *
 233          * The Linux driver uses the following format:
 234          *
 235          *  0:7         tfd index - position within TX queue
 236          *  8:12        TX queue id
 237          *  13          reserved
 238          *  14          huge - driver sets this to indicate command is in the
 239          *              'huge' storage at the end of the command buffers
 240          *  15          unsolicited RX or uCode-originated notification
 241          */
 242         __le16 sequence;
 243
 244         /* command or response/notification data follows immediately */
 245         u8 data[0];
 246 } __packed;
 247
 248
 249 /**
 250  * iwlagn rate_n_flags bit fields
 251  *
 252  * rate_n_flags format is used in following iwlagn commands:
 253  *  REPLY_RX (response only)
 254  *  REPLY_RX_MPDU (response only)
 255  *  REPLY_TX (both command and response)
 256  *  REPLY_TX_LINK_QUALITY_CMD
 257  *
 258  * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
 259  *  2-0:  0)   6 Mbps
 260  *        1)  12 Mbps
 261  *        2)  18 Mbps
 262  *        3)  24 Mbps
 263  *        4)  36 Mbps
 264  *        5)  48 Mbps
 265  *        6)  54 Mbps
 266  *        7)  60 Mbps
 267  *
 268  *  4-3:  0)  Single stream (SISO)
 269  *        1)  Dual stream (MIMO)
 270  *        2)  Triple stream (MIMO)
 271  *
 272  *    5:  Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data
 273  *
 274  * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
 275  *  3-0:  0xD)   6 Mbps
 276  *        0xF)   9 Mbps
 277  *        0x5)  12 Mbps
 278  *        0x7)  18 Mbps
 279  *        0x9)  24 Mbps
 280  *        0xB)  36 Mbps
 281  *        0x1)  48 Mbps
 282  *        0x3)  54 Mbps
 283  *
 284  * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
 285  *  6-0:   10)  1 Mbps
 286  *         20)  2 Mbps
 287  *         55)  5.5 Mbps
 288  *        110)  11 Mbps
 289  */
 290 #define RATE_MCS_CODE_MSK 0x7
 291 #define RATE_MCS_SPATIAL_POS 3
 292 #define RATE_MCS_SPATIAL_MSK 0x18
 293 #define RATE_MCS_HT_DUP_POS 5
 294 #define RATE_MCS_HT_DUP_MSK 0x20
 295 /* Both legacy and HT use bits 7:0 as the CCK/OFDM rate or HT MCS */
 296 #define RATE_MCS_RATE_MSK 0xff
 297
 298 /* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
 299 #define RATE_MCS_FLAGS_POS 8
 300 #define RATE_MCS_HT_POS 8
 301 #define RATE_MCS_HT_MSK 0x100
 302
 303 /* Bit 9: (1) CCK, (0) OFDM.  HT (bit 8) must be "0" for this bit to be valid */
 304 #define RATE_MCS_CCK_POS 9
 305 #define RATE_MCS_CCK_MSK 0x200
 306
 307 /* Bit 10: (1) Use Green Field preamble */
 308 #define RATE_MCS_GF_POS 10
 309 #define RATE_MCS_GF_MSK 0x400
 310
 311 /* Bit 11: (1) Use 40Mhz HT40 chnl width, (0) use 20 MHz legacy chnl width */
 312 #define RATE_MCS_HT40_POS 11
 313 #define RATE_MCS_HT40_MSK 0x800
 314
 315 /* Bit 12: (1) Duplicate data on both 20MHz chnls. HT40 (bit 11) must be set. */
 316 #define RATE_MCS_DUP_POS 12
 317 #define RATE_MCS_DUP_MSK 0x1000
 318
 319 /* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
 320 #define RATE_MCS_SGI_POS 13
 321 #define RATE_MCS_SGI_MSK 0x2000
 322
 323 /**
 324  * rate_n_flags Tx antenna masks
 325  * 4965 has 2 transmitters
 326  * 5100 has 1 transmitter B
 327  * 5150 has 1 transmitter A
 328  * 5300 has 3 transmitters
 329  * 5350 has 3 transmitters
 330  * bit14:16
 331  */
 332 #define RATE_MCS_ANT_POS        14
 333 #define RATE_MCS_ANT_A_MSK      0x04000
 334 #define RATE_MCS_ANT_B_MSK      0x08000
 335 #define RATE_MCS_ANT_C_MSK      0x10000
 336 #define RATE_MCS_ANT_AB_MSK     (RATE_MCS_ANT_A_MSK | RATE_MCS_ANT_B_MSK)
 337 #define RATE_MCS_ANT_ABC_MSK    (RATE_MCS_ANT_AB_MSK | RATE_MCS_ANT_C_MSK)
 338 #define RATE_ANT_NUM 3
 339
 340 #define POWER_TABLE_NUM_ENTRIES                 33
 341 #define POWER_TABLE_NUM_HT_OFDM_ENTRIES         32
 342 #define POWER_TABLE_CCK_ENTRY                   32
 343
 344 #define IWL_PWR_NUM_HT_OFDM_ENTRIES             24
 345 #define IWL_PWR_CCK_ENTRIES                     2
 346
 347 /**
 348  * struct tx_power_dual_stream
 349  *
 350  * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
 351  *
 352  * Same format as iwl_tx_power_dual_stream, but __le32
 353  */
 354 struct tx_power_dual_stream {
 355         __le32 dw;
 356 } __packed;
 357
 358 /**
 359  * Command REPLY_TX_POWER_DBM_CMD = 0x98
 360  * struct iwlagn_tx_power_dbm_cmd
 361  */
 362 #define IWLAGN_TX_POWER_AUTO 0x7f
 363 #define IWLAGN_TX_POWER_NO_CLOSED (0x1 << 6)
 364
 365 struct iwlagn_tx_power_dbm_cmd {
 366         s8 global_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
 367         u8 flags;
 368         s8 srv_chan_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
 369         u8 reserved;
 370 } __packed;
 371
 372 /**
 373  * Command TX_ANT_CONFIGURATION_CMD = 0x98
 374  * This command is used to configure valid Tx antenna.
 375  * By default uCode concludes the valid antenna according to the radio flavor.
 376  * This command enables the driver to override/modify this conclusion.
 377  */
 378 struct iwl_tx_ant_config_cmd {
 379         __le32 valid;
 380 } __packed;
 381
 382 /******************************************************************************
 383  * (0a)
 384  * Alive and Error Commands & Responses:
 385  *
 386  *****************************************************************************/
 387
 388 #define UCODE_VALID_OK  cpu_to_le32(0x1)
 389 #define INITIALIZE_SUBTYPE    (9)
 390
 391 /**
 392  * REPLY_ALIVE = 0x1 (response only, not a command)
 393  *
 394  * uCode issues this "alive" notification once the runtime image is ready
 395  * to receive commands from the driver.  This is the *second* "alive"
 396  * notification that the driver will receive after rebooting uCode;
 397  * this "alive" is indicated by subtype field != 9.
 398  *
 399  * See comments documenting "BSM" (bootstrap state machine).
 400  *
 401  * This response includes two pointers to structures within the device's
 402  * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
 403  *
 404  * 1)  log_event_table_ptr indicates base of the event log.  This traces
 405  *     a 256-entry history of uCode execution within a circular buffer.
 406  *     Its header format is:
 407  *
 408  *      __le32 log_size;     log capacity (in number of entries)
 409  *      __le32 type;         (1) timestamp with each entry, (0) no timestamp
 410  *      __le32 wraps;        # times uCode has wrapped to top of circular buffer
 411  *      __le32 write_index;  next circular buffer entry that uCode would fill
 412  *
 413  *     The header is followed by the circular buffer of log entries.  Entries
 414  *     with timestamps have the following format:
 415  *
 416  *      __le32 event_id;     range 0 - 1500
 417  *      __le32 timestamp;    low 32 bits of TSF (of network, if associated)
 418  *      __le32 data;         event_id-specific data value
 419  *
 420  *     Entries without timestamps contain only event_id and data.
 421  *
 422  *
 423  * 2)  error_event_table_ptr indicates base of the error log.  This contains
 424  *     information about any uCode error that occurs.  For agn, the format
 425  *     of the error log is defined by struct iwl_error_event_table.
 426  *
 427  * The Linux driver can print both logs to the system log when a uCode error
 428  * occurs.
 429  */
 430
 431 /*
 432  * Note: This structure is read from the device with IO accesses,
 433  * and the reading already does the endian conversion. As it is
 434  * read with u32-sized accesses, any members with a different size
 435  * need to be ordered correctly though!
 436  */
 437 struct iwl_error_event_table {
 438         u32 valid;              /* (nonzero) valid, (0) log is empty */
 439         u32 error_id;           /* type of error */
 440         u32 pc;                 /* program counter */
 441         u32 blink1;             /* branch link */
 442         u32 blink2;             /* branch link */
 443         u32 ilink1;             /* interrupt link */
 444         u32 ilink2;             /* interrupt link */
 445         u32 data1;              /* error-specific data */
 446         u32 data2;              /* error-specific data */
 447         u32 line;               /* source code line of error */
 448         u32 bcon_time;          /* beacon timer */
 449         u32 tsf_low;            /* network timestamp function timer */
 450         u32 tsf_hi;             /* network timestamp function timer */
 451         u32 gp1;                /* GP1 timer register */
 452         u32 gp2;                /* GP2 timer register */
 453         u32 gp3;                /* GP3 timer register */
 454         u32 ucode_ver;          /* uCode version */
 455         u32 hw_ver;             /* HW Silicon version */
 456         u32 brd_ver;            /* HW board version */
 457         u32 log_pc;             /* log program counter */
 458         u32 frame_ptr;          /* frame pointer */
 459         u32 stack_ptr;          /* stack pointer */
 460         u32 hcmd;               /* last host command header */
 461 #if 0
 462         /* no need to read the remainder, we don't use the values */
 463         u32 isr0;               /* isr status register LMPM_NIC_ISR0: rxtx_flag */
 464         u32 isr1;               /* isr status register LMPM_NIC_ISR1: host_flag */
 465         u32 isr2;               /* isr status register LMPM_NIC_ISR2: enc_flag */
 466         u32 isr3;               /* isr status register LMPM_NIC_ISR3: time_flag */
 467         u32 isr4;               /* isr status register LMPM_NIC_ISR4: wico interrupt */
 468         u32 isr_pref;           /* isr status register LMPM_NIC_PREF_STAT */
 469         u32 wait_event;         /* wait event() caller address */
 470         u32 l2p_control;        /* L2pControlField */
 471         u32 l2p_duration;       /* L2pDurationField */
 472         u32 l2p_mhvalid;        /* L2pMhValidBits */
 473         u32 l2p_addr_match;     /* L2pAddrMatchStat */
 474         u32 lmpm_pmg_sel;       /* indicate which clocks are turned on (LMPM_PMG_SEL) */
 475         u32 u_timestamp;        /* indicate when the date and time of the compilation */
 476         u32 flow_handler;       /* FH read/write pointers, RX credit */
 477 #endif
 478 } __packed;
 479
 480 struct iwl_alive_resp {
 481         u8 ucode_minor;
 482         u8 ucode_major;
 483         __le16 reserved1;
 484         u8 sw_rev[8];
 485         u8 ver_type;
 486         u8 ver_subtype;                 /* not "9" for runtime alive */
 487         __le16 reserved2;
 488         __le32 log_event_table_ptr;     /* SRAM address for event log */
 489         __le32 error_event_table_ptr;   /* SRAM address for error log */
 490         __le32 timestamp;
 491         __le32 is_valid;
 492 } __packed;
 493
 494 /*
 495  * REPLY_ERROR = 0x2 (response only, not a command)
 496  */
 497 struct iwl_error_resp {
 498         __le32 error_type;
 499         u8 cmd_id;
 500         u8 reserved1;
 501         __le16 bad_cmd_seq_num;
 502         __le32 error_info;
 503         __le64 timestamp;
 504 } __packed;
 505
 506 /******************************************************************************
 507  * (1)
 508  * RXON Commands & Responses:
 509  *
 510  *****************************************************************************/
 511
 512 /*
 513  * Rx config defines & structure
 514  */
 515 /* rx_config device types  */
 516 enum {
 517         RXON_DEV_TYPE_AP = 1,
 518         RXON_DEV_TYPE_ESS = 3,
 519         RXON_DEV_TYPE_IBSS = 4,
 520         RXON_DEV_TYPE_SNIFFER = 6,
 521         RXON_DEV_TYPE_CP = 7,
 522         RXON_DEV_TYPE_2STA = 8,
 523         RXON_DEV_TYPE_P2P = 9,
 524 };
 525
 526
 527 #define RXON_RX_CHAIN_DRIVER_FORCE_MSK          cpu_to_le16(0x1 << 0)
 528 #define RXON_RX_CHAIN_DRIVER_FORCE_POS          (0)
 529 #define RXON_RX_CHAIN_VALID_MSK                 cpu_to_le16(0x7 << 1)
 530 #define RXON_RX_CHAIN_VALID_POS                 (1)
 531 #define RXON_RX_CHAIN_FORCE_SEL_MSK             cpu_to_le16(0x7 << 4)
 532 #define RXON_RX_CHAIN_FORCE_SEL_POS             (4)
 533 #define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK        cpu_to_le16(0x7 << 7)
 534 #define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS        (7)
 535 #define RXON_RX_CHAIN_CNT_MSK                   cpu_to_le16(0x3 << 10)
 536 #define RXON_RX_CHAIN_CNT_POS                   (10)
 537 #define RXON_RX_CHAIN_MIMO_CNT_MSK              cpu_to_le16(0x3 << 12)
 538 #define RXON_RX_CHAIN_MIMO_CNT_POS              (12)
 539 #define RXON_RX_CHAIN_MIMO_FORCE_MSK            cpu_to_le16(0x1 << 14)
 540 #define RXON_RX_CHAIN_MIMO_FORCE_POS            (14)
 541
 542 /* rx_config flags */
 543 /* band & modulation selection */
 544 #define RXON_FLG_BAND_24G_MSK           cpu_to_le32(1 << 0)
 545 #define RXON_FLG_CCK_MSK                cpu_to_le32(1 << 1)
 546 /* auto detection enable */
 547 #define RXON_FLG_AUTO_DETECT_MSK        cpu_to_le32(1 << 2)
 548 /* TGg protection when tx */
 549 #define RXON_FLG_TGG_PROTECT_MSK        cpu_to_le32(1 << 3)
 550 /* cck short slot & preamble */
 551 #define RXON_FLG_SHORT_SLOT_MSK          cpu_to_le32(1 << 4)
 552 #define RXON_FLG_SHORT_PREAMBLE_MSK     cpu_to_le32(1 << 5)
 553 /* antenna selection */
 554 #define RXON_FLG_DIS_DIV_MSK            cpu_to_le32(1 << 7)
 555 #define RXON_FLG_ANT_SEL_MSK            cpu_to_le32(0x0f00)
 556 #define RXON_FLG_ANT_A_MSK              cpu_to_le32(1 << 8)
 557 #define RXON_FLG_ANT_B_MSK              cpu_to_le32(1 << 9)
 558 /* radar detection enable */
 559 #define RXON_FLG_RADAR_DETECT_MSK       cpu_to_le32(1 << 12)
 560 #define RXON_FLG_TGJ_NARROW_BAND_MSK    cpu_to_le32(1 << 13)
 561 /* rx response to host with 8-byte TSF
 562 * (according to ON_AIR deassertion) */
 563 #define RXON_FLG_TSF2HOST_MSK           cpu_to_le32(1 << 15)
 564
 565
 566 /* HT flags */
 567 #define RXON_FLG_CTRL_CHANNEL_LOC_POS           (22)
 568 #define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK        cpu_to_le32(0x1 << 22)
 569
 570 #define RXON_FLG_HT_OPERATING_MODE_POS          (23)
 571
 572 #define RXON_FLG_HT_PROT_MSK                    cpu_to_le32(0x1 << 23)
 573 #define RXON_FLG_HT40_PROT_MSK                  cpu_to_le32(0x2 << 23)
 574
 575 #define RXON_FLG_CHANNEL_MODE_POS               (25)
 576 #define RXON_FLG_CHANNEL_MODE_MSK               cpu_to_le32(0x3 << 25)
 577
 578 /* channel mode */
 579 enum {
 580         CHANNEL_MODE_LEGACY = 0,
 581         CHANNEL_MODE_PURE_40 = 1,
 582         CHANNEL_MODE_MIXED = 2,
 583         CHANNEL_MODE_RESERVED = 3,
 584 };
 585 #define RXON_FLG_CHANNEL_MODE_LEGACY    cpu_to_le32(CHANNEL_MODE_LEGACY << RXON_FLG_CHANNEL_MODE_POS)
 586 #define RXON_FLG_CHANNEL_MODE_PURE_40   cpu_to_le32(CHANNEL_MODE_PURE_40 << RXON_FLG_CHANNEL_MODE_POS)
 587 #define RXON_FLG_CHANNEL_MODE_MIXED     cpu_to_le32(CHANNEL_MODE_MIXED << RXON_FLG_CHANNEL_MODE_POS)
 588
 589 /* CTS to self (if spec allows) flag */
 590 #define RXON_FLG_SELF_CTS_EN                    cpu_to_le32(0x1<<30)
 591
 592 /* rx_config filter flags */
 593 /* accept all data frames */
 594 #define RXON_FILTER_PROMISC_MSK         cpu_to_le32(1 << 0)
 595 /* pass control & management to host */
 596 #define RXON_FILTER_CTL2HOST_MSK        cpu_to_le32(1 << 1)
 597 /* accept multi-cast */
 598 #define RXON_FILTER_ACCEPT_GRP_MSK      cpu_to_le32(1 << 2)
 599 /* don't decrypt uni-cast frames */
 600 #define RXON_FILTER_DIS_DECRYPT_MSK     cpu_to_le32(1 << 3)
 601 /* don't decrypt multi-cast frames */
 602 #define RXON_FILTER_DIS_GRP_DECRYPT_MSK cpu_to_le32(1 << 4)
 603 /* STA is associated */
 604 #define RXON_FILTER_ASSOC_MSK           cpu_to_le32(1 << 5)
 605 /* transfer to host non bssid beacons in associated state */
 606 #define RXON_FILTER_BCON_AWARE_MSK      cpu_to_le32(1 << 6)
 607
 608 /**
 609  * REPLY_RXON = 0x10 (command, has simple generic response)
 610  *
 611  * RXON tunes the radio tuner to a service channel, and sets up a number
 612  * of parameters that are used primarily for Rx, but also for Tx operations.
 613  *
 614  * NOTE:  When tuning to a new channel, driver must set the
 615  *        RXON_FILTER_ASSOC_MSK to 0.  This will clear station-dependent
 616  *        info within the device, including the station tables, tx retry
 617  *        rate tables, and txpower tables.  Driver must build a new station
 618  *        table and txpower table before transmitting anything on the RXON
 619  *        channel.
 620  *
 621  * NOTE:  All RXONs wipe clean the internal txpower table.  Driver must
 622  *        issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
 623  *        regardless of whether RXON_FILTER_ASSOC_MSK is set.
 624  */
 625
 626 struct iwl_rxon_cmd {
 627         u8 node_addr[6];
 628         __le16 reserved1;
 629         u8 bssid_addr[6];
 630         __le16 reserved2;
 631         u8 wlap_bssid_addr[6];
 632         __le16 reserved3;
 633         u8 dev_type;
 634         u8 air_propagation;
 635         __le16 rx_chain;
 636         u8 ofdm_basic_rates;
 637         u8 cck_basic_rates;
 638         __le16 assoc_id;
 639         __le32 flags;
 640         __le32 filter_flags;
 641         __le16 channel;
 642         u8 ofdm_ht_single_stream_basic_rates;
 643         u8 ofdm_ht_dual_stream_basic_rates;
 644         u8 ofdm_ht_triple_stream_basic_rates;
 645         u8 reserved5;
 646         __le16 acquisition_data;
 647         __le16 reserved6;
 648 } __packed;
 649
 650 /*
 651  * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
 652  */
 653 struct iwl5000_rxon_assoc_cmd {
 654         __le32 flags;
 655         __le32 filter_flags;
 656         u8 ofdm_basic_rates;
 657         u8 cck_basic_rates;
 658         __le16 reserved1;
 659         u8 ofdm_ht_single_stream_basic_rates;
 660         u8 ofdm_ht_dual_stream_basic_rates;
 661         u8 ofdm_ht_triple_stream_basic_rates;
 662         u8 reserved2;
 663         __le16 rx_chain_select_flags;
 664         __le16 acquisition_data;
 665         __le32 reserved3;
 666 } __packed;
 667
 668 #define IWL_CONN_MAX_LISTEN_INTERVAL    10
 669 #define IWL_MAX_UCODE_BEACON_INTERVAL   4 /* 4096 */
 670 #define IWL39_MAX_UCODE_BEACON_INTERVAL 1 /* 1024 */
 671
 672 /*
 673  * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
 674  */
 675 struct iwl_rxon_time_cmd {
 676         __le64 timestamp;
 677         __le16 beacon_interval;
 678         __le16 atim_window;
 679         __le32 beacon_init_val;
 680         __le16 listen_interval;
 681         u8 dtim_period;
 682         u8 delta_cp_bss_tbtts;
 683 } __packed;
 684
 685 /*
 686  * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
 687  */
 688 /**
 689  * struct iwl5000_channel_switch_cmd
 690  * @band: 0- 5.2GHz, 1- 2.4GHz
 691  * @expect_beacon: 0- resume transmits after channel switch
 692  *                 1- wait for beacon to resume transmits
 693  * @channel: new channel number
 694  * @rxon_flags: Rx on flags
 695  * @rxon_filter_flags: filtering parameters
 696  * @switch_time: switch time in extended beacon format
 697  * @reserved: reserved bytes
 698  */
 699 struct iwl5000_channel_switch_cmd {
 700         u8 band;
 701         u8 expect_beacon;
 702         __le16 channel;
 703         __le32 rxon_flags;
 704         __le32 rxon_filter_flags;
 705         __le32 switch_time;
 706         __le32 reserved[2][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES];
 707 } __packed;
 708
 709 /**
 710  * struct iwl6000_channel_switch_cmd
 711  * @band: 0- 5.2GHz, 1- 2.4GHz
 712  * @expect_beacon: 0- resume transmits after channel switch
 713  *                 1- wait for beacon to resume transmits
 714  * @channel: new channel number
 715  * @rxon_flags: Rx on flags
 716  * @rxon_filter_flags: filtering parameters
 717  * @switch_time: switch time in extended beacon format
 718  * @reserved: reserved bytes
 719  */
 720 struct iwl6000_channel_switch_cmd {
 721         u8 band;
 722         u8 expect_beacon;
 723         __le16 channel;
 724         __le32 rxon_flags;
 725         __le32 rxon_filter_flags;
 726         __le32 switch_time;
 727         __le32 reserved[3][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES];
 728 } __packed;
 729
 730 /*
 731  * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
 732  */
 733 struct iwl_csa_notification {
 734         __le16 band;
 735         __le16 channel;
 736         __le32 status;          /* 0 - OK, 1 - fail */
 737 } __packed;
 738
 739 /******************************************************************************
 740  * (2)
 741  * Quality-of-Service (QOS) Commands & Responses:
 742  *
 743  *****************************************************************************/
 744
 745 /**
 746  * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
 747  * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
 748  *
 749  * @cw_min: Contention window, start value in numbers of slots.
 750  *          Should be a power-of-2, minus 1.  Device's default is 0x0f.
 751  * @cw_max: Contention window, max value in numbers of slots.
 752  *          Should be a power-of-2, minus 1.  Device's default is 0x3f.
 753  * @aifsn:  Number of slots in Arbitration Interframe Space (before
 754  *          performing random backoff timing prior to Tx).  Device default 1.
 755  * @edca_txop:  Length of Tx opportunity, in uSecs.  Device default is 0.
 756  *
 757  * Device will automatically increase contention window by (2*CW) + 1 for each
 758  * transmission retry.  Device uses cw_max as a bit mask, ANDed with new CW
 759  * value, to cap the CW value.
 760  */
 761 struct iwl_ac_qos {
 762         __le16 cw_min;
 763         __le16 cw_max;
 764         u8 aifsn;
 765         u8 reserved1;
 766         __le16 edca_txop;
 767 } __packed;
 768
 769 /* QoS flags defines */
 770 #define QOS_PARAM_FLG_UPDATE_EDCA_MSK   cpu_to_le32(0x01)
 771 #define QOS_PARAM_FLG_TGN_MSK           cpu_to_le32(0x02)
 772 #define QOS_PARAM_FLG_TXOP_TYPE_MSK     cpu_to_le32(0x10)
 773
 774 /* Number of Access Categories (AC) (EDCA), queues 0..3 */
 775 #define AC_NUM                4
 776
 777 /*
 778  * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
 779  *
 780  * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
 781  * 0: Background, 1: Best Effort, 2: Video, 3: Voice.
 782  */
 783 struct iwl_qosparam_cmd {
 784         __le32 qos_flags;
 785         struct iwl_ac_qos ac[AC_NUM];
 786 } __packed;
 787
 788 /******************************************************************************
 789  * (3)
 790  * Add/Modify Stations Commands & Responses:
 791  *
 792  *****************************************************************************/
 793 /*
 794  * Multi station support
 795  */
 796
 797 /* Special, dedicated locations within device's station table */
 798 #define IWL_AP_ID               0
 799 #define IWL_AP_ID_PAN           1
 800 #define IWL_STA_ID              2
 801 #define IWLAGN_PAN_BCAST_ID     14
 802 #define IWLAGN_BROADCAST_ID     15
 803 #define IWLAGN_STATION_COUNT    16
 804
 805 #define IWL_INVALID_STATION     255
 806
 807 #define STA_FLG_TX_RATE_MSK             cpu_to_le32(1 << 2)
 808 #define STA_FLG_PWR_SAVE_MSK            cpu_to_le32(1 << 8)
 809 #define STA_FLG_PAN_STATION             cpu_to_le32(1 << 13)
 810 #define STA_FLG_RTS_MIMO_PROT_MSK       cpu_to_le32(1 << 17)
 811 #define STA_FLG_AGG_MPDU_8US_MSK        cpu_to_le32(1 << 18)
 812 #define STA_FLG_MAX_AGG_SIZE_POS        (19)
 813 #define STA_FLG_MAX_AGG_SIZE_MSK        cpu_to_le32(3 << 19)
 814 #define STA_FLG_HT40_EN_MSK             cpu_to_le32(1 << 21)
 815 #define STA_FLG_MIMO_DIS_MSK            cpu_to_le32(1 << 22)
 816 #define STA_FLG_AGG_MPDU_DENSITY_POS    (23)
 817 #define STA_FLG_AGG_MPDU_DENSITY_MSK    cpu_to_le32(7 << 23)
 818
 819 /* Use in mode field.  1: modify existing entry, 0: add new station entry */
 820 #define STA_CONTROL_MODIFY_MSK          0x01
 821
 822 /* key flags __le16*/
 823 #define STA_KEY_FLG_ENCRYPT_MSK cpu_to_le16(0x0007)
 824 #define STA_KEY_FLG_NO_ENC      cpu_to_le16(0x0000)
 825 #define STA_KEY_FLG_WEP         cpu_to_le16(0x0001)
 826 #define STA_KEY_FLG_CCMP        cpu_to_le16(0x0002)
 827 #define STA_KEY_FLG_TKIP        cpu_to_le16(0x0003)
 828
 829 #define STA_KEY_FLG_KEYID_POS   8
 830 #define STA_KEY_FLG_INVALID     cpu_to_le16(0x0800)
 831 /* wep key is either from global key (0) or from station info array (1) */
 832 #define STA_KEY_FLG_MAP_KEY_MSK cpu_to_le16(0x0008)
 833
 834 /* wep key in STA: 5-bytes (0) or 13-bytes (1) */
 835 #define STA_KEY_FLG_KEY_SIZE_MSK     cpu_to_le16(0x1000)
 836 #define STA_KEY_MULTICAST_MSK        cpu_to_le16(0x4000)
 837 #define STA_KEY_MAX_NUM         8
 838 #define STA_KEY_MAX_NUM_PAN     16
 839
 840 /* Flags indicate whether to modify vs. don't change various station params */
 841 #define STA_MODIFY_KEY_MASK             0x01
 842 #define STA_MODIFY_TID_DISABLE_TX       0x02
 843 #define STA_MODIFY_TX_RATE_MSK          0x04
 844 #define STA_MODIFY_ADDBA_TID_MSK        0x08
 845 #define STA_MODIFY_DELBA_TID_MSK        0x10
 846 #define STA_MODIFY_SLEEP_TX_COUNT_MSK   0x20
 847
 848 /* Receiver address (actually, Rx station's index into station table),
 849  * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
 850 #define BUILD_RAxTID(sta_id, tid)       (((sta_id) << 4) + (tid))
 851
 852 /* agn */
 853 struct iwl_keyinfo {
 854         __le16 key_flags;
 855         u8 tkip_rx_tsc_byte2;   /* TSC[2] for key mix ph1 detection */
 856         u8 reserved1;
 857         __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
 858         u8 key_offset;
 859         u8 reserved2;
 860         u8 key[16];             /* 16-byte unicast decryption key */
 861         __le64 tx_secur_seq_cnt;
 862         __le64 hw_tkip_mic_rx_key;
 863         __le64 hw_tkip_mic_tx_key;
 864 } __packed;
 865
 866 /**
 867  * struct sta_id_modify
 868  * @addr[ETH_ALEN]: station's MAC address
 869  * @sta_id: index of station in uCode's station table
 870  * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
 871  *
 872  * Driver selects unused table index when adding new station,
 873  * or the index to a pre-existing station entry when modifying that station.
 874  * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
 875  *
 876  * modify_mask flags select which parameters to modify vs. leave alone.
 877  */
 878 struct sta_id_modify {
 879         u8 addr[ETH_ALEN];
 880         __le16 reserved1;
 881         u8 sta_id;
 882         u8 modify_mask;
 883         __le16 reserved2;
 884 } __packed;
 885
 886 /*
 887  * REPLY_ADD_STA = 0x18 (command)
 888  *
 889  * The device contains an internal table of per-station information,
 890  * with info on security keys, aggregation parameters, and Tx rates for
 891  * initial Tx attempt and any retries (agn devices uses
 892  * REPLY_TX_LINK_QUALITY_CMD,
 893  *
 894  * REPLY_ADD_STA sets up the table entry for one station, either creating
 895  * a new entry, or modifying a pre-existing one.
 896  *
 897  * NOTE:  RXON command (without "associated" bit set) wipes the station table
 898  *        clean.  Moving into RF_KILL state does this also.  Driver must set up
 899  *        new station table before transmitting anything on the RXON channel
 900  *        (except active scans or active measurements; those commands carry
 901  *        their own txpower/rate setup data).
 902  *
 903  *        When getting started on a new channel, driver must set up the
 904  *        IWL_BROADCAST_ID entry (last entry in the table).  For a client
 905  *        station in a BSS, once an AP is selected, driver sets up the AP STA
 906  *        in the IWL_AP_ID entry (1st entry in the table).  BROADCAST and AP
 907  *        are all that are needed for a BSS client station.  If the device is
 908  *        used as AP, or in an IBSS network, driver must set up station table
 909  *        entries for all STAs in network, starting with index IWL_STA_ID.
 910  */
 911
 912 struct iwl_addsta_cmd {
 913         u8 mode;                /* 1: modify existing, 0: add new station */
 914         u8 reserved[3];
 915         struct sta_id_modify sta;
 916         struct iwl_keyinfo key;
 917         __le32 station_flags;           /* STA_FLG_* */
 918         __le32 station_flags_msk;       /* STA_FLG_* */
 919
 920         /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
 921          * corresponding to bit (e.g. bit 5 controls TID 5).
 922          * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
 923         __le16 tid_disable_tx;
 924
 925         __le16  rate_n_flags;           /* 3945 only */
 926
 927         /* TID for which to add block-ack support.
 928          * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
 929         u8 add_immediate_ba_tid;
 930
 931         /* TID for which to remove block-ack support.
 932          * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
 933         u8 remove_immediate_ba_tid;
 934
 935         /* Starting Sequence Number for added block-ack support.
 936          * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
 937         __le16 add_immediate_ba_ssn;
 938
 939         /*
 940          * Number of packets OK to transmit to station even though
 941          * it is asleep -- used to synchronise PS-poll and u-APSD
 942          * responses while ucode keeps track of STA sleep state.
 943          */
 944         __le16 sleep_tx_count;
 945
 946         __le16 reserved2;
 947 } __packed;
 948
 949
 950 #define ADD_STA_SUCCESS_MSK             0x1
 951 #define ADD_STA_NO_ROOM_IN_TABLE        0x2
 952 #define ADD_STA_NO_BLOCK_ACK_RESOURCE   0x4
 953 #define ADD_STA_MODIFY_NON_EXIST_STA    0x8
 954 /*
 955  * REPLY_ADD_STA = 0x18 (response)
 956  */
 957 struct iwl_add_sta_resp {
 958         u8 status;      /* ADD_STA_* */
 959 } __packed;
 960
 961 #define REM_STA_SUCCESS_MSK              0x1
 962 /*
 963  *  REPLY_REM_STA = 0x19 (response)
 964  */
 965 struct iwl_rem_sta_resp {
 966         u8 status;
 967 } __packed;
 968
 969 /*
 970  *  REPLY_REM_STA = 0x19 (command)
 971  */
 972 struct iwl_rem_sta_cmd {
 973         u8 num_sta;     /* number of removed stations */
 974         u8 reserved[3];
 975         u8 addr[ETH_ALEN]; /* MAC addr of the first station */
 976         u8 reserved2[2];
 977 } __packed;
 978
 979 #define IWL_TX_FIFO_BK_MSK              cpu_to_le32(BIT(0))
 980 #define IWL_TX_FIFO_BE_MSK              cpu_to_le32(BIT(1))
 981 #define IWL_TX_FIFO_VI_MSK              cpu_to_le32(BIT(2))
 982 #define IWL_TX_FIFO_VO_MSK              cpu_to_le32(BIT(3))
 983 #define IWL_AGG_TX_QUEUE_MSK            cpu_to_le32(0xffc00)
 984
 985 #define IWL_DROP_SINGLE         0
 986 #define IWL_DROP_SELECTED       1
 987 #define IWL_DROP_ALL            2
 988
 989 /*
 990  * REPLY_TXFIFO_FLUSH = 0x1e(command and response)
 991  *
 992  * When using full FIFO flush this command checks the scheduler HW block WR/RD
 993  * pointers to check if all the frames were transferred by DMA into the
 994  * relevant TX FIFO queue. Only when the DMA is finished and the queue is
 995  * empty the command can finish.
 996  * This command is used to flush the TXFIFO from transmit commands, it may
 997  * operate on single or multiple queues, the command queue can't be flushed by
 998  * this command. The command response is returned when all the queue flush
 999  * operations are done. Each TX command flushed return response with the FLUSH
1000  * status set in the TX response status. When FIFO flush operation is used,
1001  * the flush operation ends when both the scheduler DMA done and TXFIFO empty
1002  * are set.
1003  *
1004  * @fifo_control: bit mask for which queues to flush
1005  * @flush_control: flush controls
1006  *      0: Dump single MSDU
1007  *      1: Dump multiple MSDU according to PS, INVALID STA, TTL, TID disable.
1008  *      2: Dump all FIFO
1009  */
1010 struct iwl_txfifo_flush_cmd {
1011         __le32 fifo_control;
1012         __le16 flush_control;
1013         __le16 reserved;
1014 } __packed;
1015
1016 /*
1017  * REPLY_WEP_KEY = 0x20
1018  */
1019 struct iwl_wep_key {
1020         u8 key_index;
1021         u8 key_offset;
1022         u8 reserved1[2];
1023         u8 key_size;
1024         u8 reserved2[3];
1025         u8 key[16];
1026 } __packed;
1027
1028 struct iwl_wep_cmd {
1029         u8 num_keys;
1030         u8 global_key_type;
1031         u8 flags;
1032         u8 reserved;
1033         struct iwl_wep_key key[0];
1034 } __packed;
1035
1036 #define WEP_KEY_WEP_TYPE 1
1037 #define WEP_KEYS_MAX 4
1038 #define WEP_INVALID_OFFSET 0xff
1039 #define WEP_KEY_LEN_64 5
1040 #define WEP_KEY_LEN_128 13
1041
1042 /******************************************************************************
1043  * (4)
1044  * Rx Responses:
1045  *
1046  *****************************************************************************/
1047
1048 #define RX_RES_STATUS_NO_CRC32_ERROR    cpu_to_le32(1 << 0)
1049 #define RX_RES_STATUS_NO_RXE_OVERFLOW   cpu_to_le32(1 << 1)
1050
1051 #define RX_RES_PHY_FLAGS_BAND_24_MSK    cpu_to_le16(1 << 0)
1052 #define RX_RES_PHY_FLAGS_MOD_CCK_MSK            cpu_to_le16(1 << 1)
1053 #define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK     cpu_to_le16(1 << 2)
1054 #define RX_RES_PHY_FLAGS_NARROW_BAND_MSK        cpu_to_le16(1 << 3)
1055 #define RX_RES_PHY_FLAGS_ANTENNA_MSK            0xf0
1056 #define RX_RES_PHY_FLAGS_ANTENNA_POS            4
1057
1058 #define RX_RES_STATUS_SEC_TYPE_MSK      (0x7 << 8)
1059 #define RX_RES_STATUS_SEC_TYPE_NONE     (0x0 << 8)
1060 #define RX_RES_STATUS_SEC_TYPE_WEP      (0x1 << 8)
1061 #define RX_RES_STATUS_SEC_TYPE_CCMP     (0x2 << 8)
1062 #define RX_RES_STATUS_SEC_TYPE_TKIP     (0x3 << 8)
1063 #define RX_RES_STATUS_SEC_TYPE_ERR      (0x7 << 8)
1064
1065 #define RX_RES_STATUS_STATION_FOUND     (1<<6)
1066 #define RX_RES_STATUS_NO_STATION_INFO_MISMATCH  (1<<7)
1067
1068 #define RX_RES_STATUS_DECRYPT_TYPE_MSK  (0x3 << 11)
1069 #define RX_RES_STATUS_NOT_DECRYPT       (0x0 << 11)
1070 #define RX_RES_STATUS_DECRYPT_OK        (0x3 << 11)
1071 #define RX_RES_STATUS_BAD_ICV_MIC       (0x1 << 11)
1072 #define RX_RES_STATUS_BAD_KEY_TTAK      (0x2 << 11)
1073
1074 #define RX_MPDU_RES_STATUS_ICV_OK       (0x20)
1075 #define RX_MPDU_RES_STATUS_MIC_OK       (0x40)
1076 #define RX_MPDU_RES_STATUS_TTAK_OK      (1 << 7)
1077 #define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800)
1078
1079
1080 #define IWLAGN_RX_RES_PHY_CNT 8
1081 #define IWLAGN_RX_RES_AGC_IDX     1
1082 #define IWLAGN_RX_RES_RSSI_AB_IDX 2
1083 #define IWLAGN_RX_RES_RSSI_C_IDX  3
1084 #define IWLAGN_OFDM_AGC_MSK 0xfe00
1085 #define IWLAGN_OFDM_AGC_BIT_POS 9
1086 #define IWLAGN_OFDM_RSSI_INBAND_A_BITMSK 0x00ff
1087 #define IWLAGN_OFDM_RSSI_ALLBAND_A_BITMSK 0xff00
1088 #define IWLAGN_OFDM_RSSI_A_BIT_POS 0
1089 #define IWLAGN_OFDM_RSSI_INBAND_B_BITMSK 0xff0000
1090 #define IWLAGN_OFDM_RSSI_ALLBAND_B_BITMSK 0xff000000
1091 #define IWLAGN_OFDM_RSSI_B_BIT_POS 16
1092 #define IWLAGN_OFDM_RSSI_INBAND_C_BITMSK 0x00ff
1093 #define IWLAGN_OFDM_RSSI_ALLBAND_C_BITMSK 0xff00
1094 #define IWLAGN_OFDM_RSSI_C_BIT_POS 0
1095
1096 struct iwlagn_non_cfg_phy {
1097         __le32 non_cfg_phy[IWLAGN_RX_RES_PHY_CNT];  /* up to 8 phy entries */
1098 } __packed;
1099
1100
1101 /*
1102  * REPLY_RX = 0xc3 (response only, not a command)
1103  * Used only for legacy (non 11n) frames.
1104  */
1105 struct iwl_rx_phy_res {
1106         u8 non_cfg_phy_cnt;     /* non configurable DSP phy data byte count */
1107         u8 cfg_phy_cnt;         /* configurable DSP phy data byte count */
1108         u8 stat_id;             /* configurable DSP phy data set ID */
1109         u8 reserved1;
1110         __le64 timestamp;       /* TSF at on air rise */
1111         __le32 beacon_time_stamp; /* beacon at on-air rise */
1112         __le16 phy_flags;       /* general phy flags: band, modulation, ... */
1113         __le16 channel;         /* channel number */
1114         u8 non_cfg_phy_buf[32]; /* for various implementations of non_cfg_phy */
1115         __le32 rate_n_flags;    /* RATE_MCS_* */
1116         __le16 byte_count;      /* frame's byte-count */
1117         __le16 frame_time;      /* frame's time on the air */
1118 } __packed;
1119
1120 struct iwl_rx_mpdu_res_start {
1121         __le16 byte_count;
1122         __le16 reserved;
1123 } __packed;
1124
1125
1126 /******************************************************************************
1127  * (5)
1128  * Tx Commands & Responses:
1129  *
1130  * Driver must place each REPLY_TX command into one of the prioritized Tx
1131  * queues in host DRAM, shared between driver and device (see comments for
1132  * SCD registers and Tx/Rx Queues).  When the device's Tx scheduler and uCode
1133  * are preparing to transmit, the device pulls the Tx command over the PCI
1134  * bus via one of the device's Tx DMA channels, to fill an internal FIFO
1135  * from which data will be transmitted.
1136  *
1137  * uCode handles all timing and protocol related to control frames
1138  * (RTS/CTS/ACK), based on flags in the Tx command.  uCode and Tx scheduler
1139  * handle reception of block-acks; uCode updates the host driver via
1140  * REPLY_COMPRESSED_BA.
1141  *
1142  * uCode handles retrying Tx when an ACK is expected but not received.
1143  * This includes trying lower data rates than the one requested in the Tx
1144  * command, as set up by the REPLY_RATE_SCALE (for 3945) or
1145  * REPLY_TX_LINK_QUALITY_CMD (agn).
1146  *
1147  * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
1148  * This command must be executed after every RXON command, before Tx can occur.
1149  *****************************************************************************/
1150
1151 /* REPLY_TX Tx flags field */
1152
1153 /*
1154  * 1: Use RTS/CTS protocol or CTS-to-self if spec allows it
1155  * before this frame. if CTS-to-self required check
1156  * RXON_FLG_SELF_CTS_EN status.
1157  * unused in 3945/4965, used in 5000 series and after
1158  */
1159 #define TX_CMD_FLG_PROT_REQUIRE_MSK cpu_to_le32(1 << 0)
1160
1161 /*
1162  * 1: Use Request-To-Send protocol before this frame.
1163  * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK.
1164  * used in 3945/4965, unused in 5000 series and after
1165  */
1166 #define TX_CMD_FLG_RTS_MSK cpu_to_le32(1 << 1)
1167
1168 /*
1169  * 1: Transmit Clear-To-Send to self before this frame.
1170  * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
1171  * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK.
1172  * used in 3945/4965, unused in 5000 series and after
1173  */
1174 #define TX_CMD_FLG_CTS_MSK cpu_to_le32(1 << 2)
1175
1176 /* 1: Expect ACK from receiving station
1177  * 0: Don't expect ACK (MAC header's duration field s/b 0)
1178  * Set this for unicast frames, but not broadcast/multicast. */
1179 #define TX_CMD_FLG_ACK_MSK cpu_to_le32(1 << 3)
1180
1181 /* For agn devices:
1182  * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
1183  *    Tx command's initial_rate_index indicates first rate to try;
1184  *    uCode walks through table for additional Tx attempts.
1185  * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
1186  *    This rate will be used for all Tx attempts; it will not be scaled. */
1187 #define TX_CMD_FLG_STA_RATE_MSK cpu_to_le32(1 << 4)
1188
1189 /* 1: Expect immediate block-ack.
1190  * Set when Txing a block-ack request frame.  Also set TX_CMD_FLG_ACK_MSK. */
1191 #define TX_CMD_FLG_IMM_BA_RSP_MASK  cpu_to_le32(1 << 6)
1192
1193 /*
1194  * 1: Frame requires full Tx-Op protection.
1195  * Set this if either RTS or CTS Tx Flag gets set.
1196  * used in 3945/4965, unused in 5000 series and after
1197  */
1198 #define TX_CMD_FLG_FULL_TXOP_PROT_MSK cpu_to_le32(1 << 7)
1199
1200 /* Tx antenna selection field; used only for 3945, reserved (0) for agn devices.
1201  * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
1202 #define TX_CMD_FLG_ANT_SEL_MSK cpu_to_le32(0xf00)
1203 #define TX_CMD_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
1204 #define TX_CMD_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
1205
1206 /* 1: Ignore Bluetooth priority for this frame.
1207  * 0: Delay Tx until Bluetooth device is done (normal usage). */
1208 #define TX_CMD_FLG_IGNORE_BT cpu_to_le32(1 << 12)
1209
1210 /* 1: uCode overrides sequence control field in MAC header.
1211  * 0: Driver provides sequence control field in MAC header.
1212  * Set this for management frames, non-QOS data frames, non-unicast frames,
1213  * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
1214 #define TX_CMD_FLG_SEQ_CTL_MSK cpu_to_le32(1 << 13)
1215
1216 /* 1: This frame is non-last MPDU; more fragments are coming.
1217  * 0: Last fragment, or not using fragmentation. */
1218 #define TX_CMD_FLG_MORE_FRAG_MSK cpu_to_le32(1 << 14)
1219
1220 /* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
1221  * 0: No TSF required in outgoing frame.
1222  * Set this for transmitting beacons and probe responses. */
1223 #define TX_CMD_FLG_TSF_MSK cpu_to_le32(1 << 16)
1224
1225 /* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
1226  *    alignment of frame's payload data field.
1227  * 0: No pad
1228  * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
1229  * field (but not both).  Driver must align frame data (i.e. data following
1230  * MAC header) to DWORD boundary. */
1231 #define TX_CMD_FLG_MH_PAD_MSK cpu_to_le32(1 << 20)
1232
1233 /* accelerate aggregation support
1234  * 0 - no CCMP encryption; 1 - CCMP encryption */
1235 #define TX_CMD_FLG_AGG_CCMP_MSK cpu_to_le32(1 << 22)
1236
1237 /* HCCA-AP - disable duration overwriting. */
1238 #define TX_CMD_FLG_DUR_MSK cpu_to_le32(1 << 25)
1239
1240
1241 /*
1242  * TX command security control
1243  */
1244 #define TX_CMD_SEC_WEP          0x01
1245 #define TX_CMD_SEC_CCM          0x02
1246 #define TX_CMD_SEC_TKIP         0x03
1247 #define TX_CMD_SEC_MSK          0x03
1248 #define TX_CMD_SEC_SHIFT        6
1249 #define TX_CMD_SEC_KEY128       0x08
1250
1251 /*
1252  * security overhead sizes
1253  */
1254 #define WEP_IV_LEN 4
1255 #define WEP_ICV_LEN 4
1256 #define CCMP_MIC_LEN 8
1257 #define TKIP_ICV_LEN 4
1258
1259 /*
1260  * REPLY_TX = 0x1c (command)
1261  */
1262
1263 /*
1264  * 4965 uCode updates these Tx attempt count values in host DRAM.
1265  * Used for managing Tx retries when expecting block-acks.
1266  * Driver should set these fields to 0.
1267  */
1268 struct iwl_dram_scratch {
1269         u8 try_cnt;             /* Tx attempts */
1270         u8 bt_kill_cnt;         /* Tx attempts blocked by Bluetooth device */
1271         __le16 reserved;
1272 } __packed;
1273
1274 struct iwl_tx_cmd {
1275         /*
1276          * MPDU byte count:
1277          * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
1278          * + 8 byte IV for CCM or TKIP (not used for WEP)
1279          * + Data payload
1280          * + 8-byte MIC (not used for CCM/WEP)
1281          * NOTE:  Does not include Tx command bytes, post-MAC pad bytes,
1282          *        MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
1283          * Range: 14-2342 bytes.
1284          */
1285         __le16 len;
1286
1287         /*
1288          * MPDU or MSDU byte count for next frame.
1289          * Used for fragmentation and bursting, but not 11n aggregation.
1290          * Same as "len", but for next frame.  Set to 0 if not applicable.
1291          */
1292         __le16 next_frame_len;
1293
1294         __le32 tx_flags;        /* TX_CMD_FLG_* */
1295
1296         /* uCode may modify this field of the Tx command (in host DRAM!).
1297          * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
1298         struct iwl_dram_scratch scratch;
1299
1300         /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
1301         __le32 rate_n_flags;    /* RATE_MCS_* */
1302
1303         /* Index of destination station in uCode's station table */
1304         u8 sta_id;
1305
1306         /* Type of security encryption:  CCM or TKIP */
1307         u8 sec_ctl;             /* TX_CMD_SEC_* */
1308
1309         /*
1310          * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial
1311          * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set.  Normally "0" for
1312          * data frames, this field may be used to selectively reduce initial
1313          * rate (via non-0 value) for special frames (e.g. management), while
1314          * still supporting rate scaling for all frames.
1315          */
1316         u8 initial_rate_index;
1317         u8 reserved;
1318         u8 key[16];
1319         __le16 next_frame_flags;
1320         __le16 reserved2;
1321         union {
1322                 __le32 life_time;
1323                 __le32 attempt;
1324         } stop_time;
1325
1326         /* Host DRAM physical address pointer to "scratch" in this command.
1327          * Must be dword aligned.  "0" in dram_lsb_ptr disables usage. */
1328         __le32 dram_lsb_ptr;
1329         u8 dram_msb_ptr;
1330
1331         u8 rts_retry_limit;     /*byte 50 */
1332         u8 data_retry_limit;    /*byte 51 */
1333         u8 tid_tspec;
1334         union {
1335                 __le16 pm_frame_timeout;
1336                 __le16 attempt_duration;
1337         } timeout;
1338
1339         /*
1340          * Duration of EDCA burst Tx Opportunity, in 32-usec units.
1341          * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
1342          */
1343         __le16 driver_txop;
1344
1345         /*
1346          * MAC header goes here, followed by 2 bytes padding if MAC header
1347          * length is 26 or 30 bytes, followed by payload data
1348          */
1349         u8 payload[0];
1350         struct ieee80211_hdr hdr[0];
1351 } __packed;
1352
1353 /*
1354  * TX command response is sent after *agn* transmission attempts.
1355  *
1356  * both postpone and abort status are expected behavior from uCode. there is
1357  * no special operation required from driver; except for RFKILL_FLUSH,
1358  * which required tx flush host command to flush all the tx frames in queues
1359  */
1360 enum {
1361         TX_STATUS_SUCCESS = 0x01,
1362         TX_STATUS_DIRECT_DONE = 0x02,
1363         /* postpone TX */
1364         TX_STATUS_POSTPONE_DELAY = 0x40,
1365         TX_STATUS_POSTPONE_FEW_BYTES = 0x41,
1366         TX_STATUS_POSTPONE_BT_PRIO = 0x42,
1367         TX_STATUS_POSTPONE_QUIET_PERIOD = 0x43,
1368         TX_STATUS_POSTPONE_CALC_TTAK = 0x44,
1369         /* abort TX */
1370         TX_STATUS_FAIL_INTERNAL_CROSSED_RETRY = 0x81,
1371         TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
1372         TX_STATUS_FAIL_LONG_LIMIT = 0x83,
1373         TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
1374         TX_STATUS_FAIL_DRAIN_FLOW = 0x85,
1375         TX_STATUS_FAIL_RFKILL_FLUSH = 0x86,
1376         TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
1377         TX_STATUS_FAIL_DEST_PS = 0x88,
1378         TX_STATUS_FAIL_HOST_ABORTED = 0x89,
1379         TX_STATUS_FAIL_BT_RETRY = 0x8a,
1380         TX_STATUS_FAIL_STA_INVALID = 0x8b,
1381         TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
1382         TX_STATUS_FAIL_TID_DISABLE = 0x8d,
1383         TX_STATUS_FAIL_FIFO_FLUSHED = 0x8e,
1384         TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
1385         TX_STATUS_FAIL_PASSIVE_NO_RX = 0x90,
1386         TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
1387 };
1388
1389 #define TX_PACKET_MODE_REGULAR          0x0000
1390 #define TX_PACKET_MODE_BURST_SEQ        0x0100
1391 #define TX_PACKET_MODE_BURST_FIRST      0x0200
1392
1393 enum {
1394         TX_POWER_PA_NOT_ACTIVE = 0x0,
1395 };
1396
1397 enum {
1398         TX_STATUS_MSK = 0x000000ff,             /* bits 0:7 */
1399         TX_STATUS_DELAY_MSK = 0x00000040,
1400         TX_STATUS_ABORT_MSK = 0x00000080,
1401         TX_PACKET_MODE_MSK = 0x0000ff00,        /* bits 8:15 */
1402         TX_FIFO_NUMBER_MSK = 0x00070000,        /* bits 16:18 */
1403         TX_RESERVED = 0x00780000,               /* bits 19:22 */
1404         TX_POWER_PA_DETECT_MSK = 0x7f800000,    /* bits 23:30 */
1405         TX_ABORT_REQUIRED_MSK = 0x80000000,     /* bits 31:31 */
1406 };
1407
1408 /* *******************************
1409  * TX aggregation status
1410  ******************************* */
1411
1412 enum {
1413         AGG_TX_STATE_TRANSMITTED = 0x00,
1414         AGG_TX_STATE_UNDERRUN_MSK = 0x01,
1415         AGG_TX_STATE_BT_PRIO_MSK = 0x02,
1416         AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
1417         AGG_TX_STATE_ABORT_MSK = 0x08,
1418         AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
1419         AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
1420         AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
1421         AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
1422         AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
1423         AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
1424         AGG_TX_STATE_DUMP_TX_MSK = 0x200,
1425         AGG_TX_STATE_DELAY_TX_MSK = 0x400
1426 };
1427
1428 #define AGG_TX_STATUS_MSK       0x00000fff      /* bits 0:11 */
1429 #define AGG_TX_TRY_MSK          0x0000f000      /* bits 12:15 */
1430
1431 #define AGG_TX_STATE_LAST_SENT_MSK  (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
1432                                      AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
1433                                      AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
1434
1435 /* # tx attempts for first frame in aggregation */
1436 #define AGG_TX_STATE_TRY_CNT_POS 12
1437 #define AGG_TX_STATE_TRY_CNT_MSK 0xf000
1438
1439 /* Command ID and sequence number of Tx command for this frame */
1440 #define AGG_TX_STATE_SEQ_NUM_POS 16
1441 #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
1442
1443 /*
1444  * REPLY_TX = 0x1c (response)
1445  *
1446  * This response may be in one of two slightly different formats, indicated
1447  * by the frame_count field:
1448  *
1449  * 1)  No aggregation (frame_count == 1).  This reports Tx results for
1450  *     a single frame.  Multiple attempts, at various bit rates, may have
1451  *     been made for this frame.
1452  *
1453  * 2)  Aggregation (frame_count > 1).  This reports Tx results for
1454  *     2 or more frames that used block-acknowledge.  All frames were
1455  *     transmitted at same rate.  Rate scaling may have been used if first
1456  *     frame in this new agg block failed in previous agg block(s).
1457  *
1458  *     Note that, for aggregation, ACK (block-ack) status is not delivered here;
1459  *     block-ack has not been received by the time the agn device records
1460  *     this status.
1461  *     This status relates to reasons the tx might have been blocked or aborted
1462  *     within the sending station (this agn device), rather than whether it was
1463  *     received successfully by the destination station.
1464  */
1465 struct agg_tx_status {
1466         __le16 status;
1467         __le16 sequence;
1468 } __packed;
1469
1470 /*
1471  * definitions for initial rate index field
1472  * bits [3:0] initial rate index
1473  * bits [6:4] rate table color, used for the initial rate
1474  * bit-7 invalid rate indication
1475  *   i.e. rate was not chosen from rate table
1476  *   or rate table color was changed during frame retries
1477  * refer tlc rate info
1478  */
1479
1480 #define IWL50_TX_RES_INIT_RATE_INDEX_POS        0
1481 #define IWL50_TX_RES_INIT_RATE_INDEX_MSK        0x0f
1482 #define IWL50_TX_RES_RATE_TABLE_COLOR_POS       4
1483 #define IWL50_TX_RES_RATE_TABLE_COLOR_MSK       0x70
1484 #define IWL50_TX_RES_INV_RATE_INDEX_MSK 0x80
1485
1486 /* refer to ra_tid */
1487 #define IWLAGN_TX_RES_TID_POS   0
1488 #define IWLAGN_TX_RES_TID_MSK   0x0f
1489 #define IWLAGN_TX_RES_RA_POS    4
1490 #define IWLAGN_TX_RES_RA_MSK    0xf0
1491
1492 struct iwlagn_tx_resp {
1493         u8 frame_count;         /* 1 no aggregation, >1 aggregation */
1494         u8 bt_kill_count;       /* # blocked by bluetooth (unused for agg) */
1495         u8 failure_rts;         /* # failures due to unsuccessful RTS */
1496         u8 failure_frame;       /* # failures due to no ACK (unused for agg) */
1497
1498         /* For non-agg:  Rate at which frame was successful.
1499          * For agg:  Rate at which all frames were transmitted. */
1500         __le32 rate_n_flags;    /* RATE_MCS_*  */
1501
1502         /* For non-agg:  RTS + CTS + frame tx attempts time + ACK.
1503          * For agg:  RTS + CTS + aggregation tx time + block-ack time. */
1504         __le16 wireless_media_time;     /* uSecs */
1505
1506         u8 pa_status;           /* RF power amplifier measurement (not used) */
1507         u8 pa_integ_res_a[3];
1508         u8 pa_integ_res_b[3];
1509         u8 pa_integ_res_C[3];
1510
1511         __le32 tfd_info;
1512         __le16 seq_ctl;
1513         __le16 byte_cnt;
1514         u8 tlc_info;
1515         u8 ra_tid;              /* tid (0:3), sta_id (4:7) */
1516         __le16 frame_ctrl;
1517         /*
1518          * For non-agg:  frame status TX_STATUS_*
1519          * For agg:  status of 1st frame, AGG_TX_STATE_*; other frame status
1520          *           fields follow this one, up to frame_count.
1521          *           Bit fields:
1522          *           11- 0:  AGG_TX_STATE_* status code
1523          *           15-12:  Retry count for 1st frame in aggregation (retries
1524          *                   occur if tx failed for this frame when it was a
1525          *                   member of a previous aggregation block).  If rate
1526          *                   scaling is used, retry count indicates the rate
1527          *                   table entry used for all frames in the new agg.
1528          *           31-16:  Sequence # for this frame's Tx cmd (not SSN!)
1529          */
1530         struct agg_tx_status status;    /* TX status (in aggregation -
1531                                          * status of 1st frame) */
1532 } __packed;
1533 /*
1534  * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
1535  *
1536  * Reports Block-Acknowledge from recipient station
1537  */
1538 struct iwl_compressed_ba_resp {
1539         __le32 sta_addr_lo32;
1540         __le16 sta_addr_hi16;
1541         __le16 reserved;
1542
1543         /* Index of recipient (BA-sending) station in uCode's station table */
1544         u8 sta_id;
1545         u8 tid;
1546         __le16 seq_ctl;
1547         __le64 bitmap;
1548         __le16 scd_flow;
1549         __le16 scd_ssn;
1550         /* following only for 5000 series and up */
1551         u8 txed;        /* number of frames sent */
1552         u8 txed_2_done; /* number of frames acked */
1553 } __packed;
1554
1555 /*
1556  * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
1557  *
1558  */
1559
1560 /*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
1561 #define  LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK    (1 << 0)
1562
1563 /* # of EDCA prioritized tx fifos */
1564 #define  LINK_QUAL_AC_NUM AC_NUM
1565
1566 /* # entries in rate scale table to support Tx retries */
1567 #define  LINK_QUAL_MAX_RETRY_NUM 16
1568
1569 /* Tx antenna selection values */
1570 #define  LINK_QUAL_ANT_A_MSK (1 << 0)
1571 #define  LINK_QUAL_ANT_B_MSK (1 << 1)
1572 #define  LINK_QUAL_ANT_MSK   (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
1573
1574
1575 /**
1576  * struct iwl_link_qual_general_params
1577  *
1578  * Used in REPLY_TX_LINK_QUALITY_CMD
1579  */
1580 struct iwl_link_qual_general_params {
1581         u8 flags;
1582
1583         /* No entries at or above this (driver chosen) index contain MIMO */
1584         u8 mimo_delimiter;
1585
1586         /* Best single antenna to use for single stream (legacy, SISO). */
1587         u8 single_stream_ant_msk;       /* LINK_QUAL_ANT_* */
1588
1589         /* Best antennas to use for MIMO (unused for 4965, assumes both). */
1590         u8 dual_stream_ant_msk;         /* LINK_QUAL_ANT_* */
1591
1592         /*
1593          * If driver needs to use different initial rates for different
1594          * EDCA QOS access categories (as implemented by tx fifos 0-3),
1595          * this table will set that up, by indicating the indexes in the
1596          * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
1597          * Otherwise, driver should set all entries to 0.
1598          *
1599          * Entry usage:
1600          * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
1601          * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
1602          */
1603         u8 start_rate_index[LINK_QUAL_AC_NUM];
1604 } __packed;
1605
1606 #define LINK_QUAL_AGG_TIME_LIMIT_DEF    (4000) /* 4 milliseconds */
1607 #define LINK_QUAL_AGG_TIME_LIMIT_MAX    (8000)
1608 #define LINK_QUAL_AGG_TIME_LIMIT_MIN    (100)
1609
1610 #define LINK_QUAL_AGG_DISABLE_START_DEF (3)
1611 #define LINK_QUAL_AGG_DISABLE_START_MAX (255)
1612 #define LINK_QUAL_AGG_DISABLE_START_MIN (0)
1613
1614 #define LINK_QUAL_AGG_FRAME_LIMIT_DEF   (63)
1615 #define LINK_QUAL_AGG_FRAME_LIMIT_MAX   (63)
1616 #define LINK_QUAL_AGG_FRAME_LIMIT_MIN   (0)
1617
1618 /**
1619  * struct iwl_link_qual_agg_params
1620  *
1621  * Used in REPLY_TX_LINK_QUALITY_CMD
1622  */
1623 struct iwl_link_qual_agg_params {
1624
1625         /*
1626          *Maximum number of uSec in aggregation.
1627          * default set to 4000 (4 milliseconds) if not configured in .cfg
1628          */
1629         __le16 agg_time_limit;
1630
1631         /*
1632          * Number of Tx retries allowed for a frame, before that frame will
1633          * no longer be considered for the start of an aggregation sequence
1634          * (scheduler will then try to tx it as single frame).
1635          * Driver should set this to 3.
1636          */
1637         u8 agg_dis_start_th;
1638
1639         /*
1640          * Maximum number of frames in aggregation.
1641          * 0 = no limit (default).  1 = no aggregation.
1642          * Other values = max # frames in aggregation.
1643          */
1644         u8 agg_frame_cnt_limit;
1645
1646         __le32 reserved;
1647 } __packed;
1648
1649 /*
1650  * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
1651  *
1652  * For agn devices only; 3945 uses REPLY_RATE_SCALE.
1653  *
1654  * Each station in the agn device's internal station table has its own table
1655  * of 16
1656  * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
1657  * an ACK is not received.  This command replaces the entire table for
1658  * one station.
1659  *
1660  * NOTE:  Station must already be in agn device's station table.
1661  *        Use REPLY_ADD_STA.
1662  *
1663  * The rate scaling procedures described below work well.  Of course, other
1664  * procedures are possible, and may work better for particular environments.
1665  *
1666  *
1667  * FILLING THE RATE TABLE
1668  *
1669  * Given a particular initial rate and mode, as determined by the rate
1670  * scaling algorithm described below, the Linux driver uses the following
1671  * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
1672  * Link Quality command:
1673  *
1674  *
1675  * 1)  If using High-throughput (HT) (SISO or MIMO) initial rate:
1676  *     a) Use this same initial rate for first 3 entries.
1677  *     b) Find next lower available rate using same mode (SISO or MIMO),
1678  *        use for next 3 entries.  If no lower rate available, switch to
1679  *        legacy mode (no HT40 channel, no MIMO, no short guard interval).
1680  *     c) If using MIMO, set command's mimo_delimiter to number of entries
1681  *        using MIMO (3 or 6).
1682  *     d) After trying 2 HT rates, switch to legacy mode (no HT40 channel,
1683  *        no MIMO, no short guard interval), at the next lower bit rate
1684  *        (e.g. if second HT bit rate was 54, try 48 legacy), and follow
1685  *        legacy procedure for remaining table entries.
1686  *
1687  * 2)  If using legacy initial rate:
1688  *     a) Use the initial rate for only one entry.
1689  *     b) For each following entry, reduce the rate to next lower available
1690  *        rate, until reaching the lowest available rate.
1691  *     c) When reducing rate, also switch antenna selection.
1692  *     d) Once lowest available rate is reached, repeat this rate until
1693  *        rate table is filled (16 entries), switching antenna each entry.
1694  *
1695  *
1696  * ACCUMULATING HISTORY
1697  *
1698  * The rate scaling algorithm for agn devices, as implemented in Linux driver,
1699  * uses two sets of frame Tx success history:  One for the current/active
1700  * modulation mode, and one for a speculative/search mode that is being
1701  * attempted. If the speculative mode turns out to be more effective (i.e.
1702  * actual transfer rate is better), then the driver continues to use the
1703  * speculative mode as the new current active mode.
1704  *
1705  * Each history set contains, separately for each possible rate, data for a
1706  * sliding window of the 62 most recent tx attempts at that rate.  The data
1707  * includes a shifting bitmap of success(1)/failure(0), and sums of successful
1708  * and attempted frames, from which the driver can additionally calculate a
1709  * success ratio (success / attempted) and number of failures
1710  * (attempted - success), and control the size of the window (attempted).
1711  * The driver uses the bit map to remove successes from the success sum, as
1712  * the oldest tx attempts fall out of the window.
1713  *
1714  * When the agn device makes multiple tx attempts for a given frame, each
1715  * attempt might be at a different rate, and have different modulation
1716  * characteristics (e.g. antenna, fat channel, short guard interval), as set
1717  * up in the rate scaling table in the Link Quality command.  The driver must
1718  * determine which rate table entry was used for each tx attempt, to determine
1719  * which rate-specific history to update, and record only those attempts that
1720  * match the modulation characteristics of the history set.
1721  *
1722  * When using block-ack (aggregation), all frames are transmitted at the same
1723  * rate, since there is no per-attempt acknowledgment from the destination
1724  * station.  The Tx response struct iwl_tx_resp indicates the Tx rate in
1725  * rate_n_flags field.  After receiving a block-ack, the driver can update
1726  * history for the entire block all at once.
1727  *
1728  *
1729  * FINDING BEST STARTING RATE:
1730  *
1731  * When working with a selected initial modulation mode (see below), the
1732  * driver attempts to find a best initial rate.  The initial rate is the
1733  * first entry in the Link Quality command's rate table.
1734  *
1735  * 1)  Calculate actual throughput (success ratio * expected throughput, see
1736  *     table below) for current initial rate.  Do this only if enough frames
1737  *     have been attempted to make the value meaningful:  at least 6 failed
1738  *     tx attempts, or at least 8 successes.  If not enough, don't try rate
1739  *     scaling yet.
1740  *
1741  * 2)  Find available rates adjacent to current initial rate.  Available means:
1742  *     a)  supported by hardware &&
1743  *     b)  supported by association &&
1744  *     c)  within any constraints selected by user
1745  *
1746  * 3)  Gather measured throughputs for adjacent rates.  These might not have
1747  *     enough history to calculate a throughput.  That's okay, we might try
1748  *     using one of them anyway!
1749  *
1750  * 4)  Try decreasing rate if, for current rate:
1751  *     a)  success ratio is < 15% ||
1752  *     b)  lower adjacent rate has better measured throughput ||
1753  *     c)  higher adjacent rate has worse throughput, and lower is unmeasured
1754  *
1755  *     As a sanity check, if decrease was determined above, leave rate
1756  *     unchanged if:
1757  *     a)  lower rate unavailable
1758  *     b)  success ratio at current rate > 85% (very good)
1759  *     c)  current measured throughput is better than expected throughput
1760  *         of lower rate (under perfect 100% tx conditions, see table below)
1761  *
1762  * 5)  Try increasing rate if, for current rate:
1763  *     a)  success ratio is < 15% ||
1764  *     b)  both adjacent rates' throughputs are unmeasured (try it!) ||
1765  *     b)  higher adjacent rate has better measured throughput ||
1766  *     c)  lower adjacent rate has worse throughput, and higher is unmeasured
1767  *
1768  *     As a sanity check, if increase was determined above, leave rate
1769  *     unchanged if:
1770  *     a)  success ratio at current rate < 70%.  This is not particularly
1771  *         good performance; higher rate is sure to have poorer success.
1772  *
1773  * 6)  Re-evaluate the rate after each tx frame.  If working with block-
1774  *     acknowledge, history and statistics may be calculated for the entire
1775  *     block (including prior history that fits within the history windows),
1776  *     before re-evaluation.
1777  *
1778  * FINDING BEST STARTING MODULATION MODE:
1779  *
1780  * After working with a modulation mode for a "while" (and doing rate scaling),
1781  * the driver searches for a new initial mode in an attempt to improve
1782  * throughput.  The "while" is measured by numbers of attempted frames:
1783  *
1784  * For legacy mode, search for new mode after:
1785  *   480 successful frames, or 160 failed frames
1786  * For high-throughput modes (SISO or MIMO), search for new mode after:
1787  *   4500 successful frames, or 400 failed frames
1788  *
1789  * Mode switch possibilities are (3 for each mode):
1790  *
1791  * For legacy:
1792  *   Change antenna, try SISO (if HT association), try MIMO (if HT association)
1793  * For SISO:
1794  *   Change antenna, try MIMO, try shortened guard interval (SGI)
1795  * For MIMO:
1796  *   Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)
1797  *
1798  * When trying a new mode, use the same bit rate as the old/current mode when
1799  * trying antenna switches and shortened guard interval.  When switching to
1800  * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate
1801  * for which the expected throughput (under perfect conditions) is about the
1802  * same or slightly better than the actual measured throughput delivered by
1803  * the old/current mode.
1804  *
1805  * Actual throughput can be estimated by multiplying the expected throughput
1806  * by the success ratio (successful / attempted tx frames).  Frame size is
1807  * not considered in this calculation; it assumes that frame size will average
1808  * out to be fairly consistent over several samples.  The following are
1809  * metric values for expected throughput assuming 100% success ratio.
1810  * Only G band has support for CCK rates:
1811  *
1812  *           RATE:  1    2    5   11    6   9   12   18   24   36   48   54   60
1813  *
1814  *              G:  7   13   35   58   40  57   72   98  121  154  177  186  186
1815  *              A:  0    0    0    0   40  57   72   98  121  154  177  186  186
1816  *     SISO 20MHz:  0    0    0    0   42  42   76  102  124  159  183  193  202
1817  * SGI SISO 20MHz:  0    0    0    0   46  46   82  110  132  168  192  202  211
1818  *     MIMO 20MHz:  0    0    0    0   74  74  123  155  179  214  236  244  251
1819  * SGI MIMO 20MHz:  0    0    0    0   81  81  131  164  188  222  243  251  257
1820  *     SISO 40MHz:  0    0    0    0   77  77  127  160  184  220  242  250  257
1821  * SGI SISO 40MHz:  0    0    0    0   83  83  135  169  193  229  250  257  264
1822  *     MIMO 40MHz:  0    0    0    0  123 123  182  214  235  264  279  285  289
1823  * SGI MIMO 40MHz:  0    0    0    0  131 131  191  222  242  270  284  289  293
1824  *
1825  * After the new mode has been tried for a short while (minimum of 6 failed
1826  * frames or 8 successful frames), compare success ratio and actual throughput
1827  * estimate of the new mode with the old.  If either is better with the new
1828  * mode, continue to use the new mode.
1829  *
1830  * Continue comparing modes until all 3 possibilities have been tried.
1831  * If moving from legacy to HT, try all 3 possibilities from the new HT
1832  * mode.  After trying all 3, a best mode is found.  Continue to use this mode
1833  * for the longer "while" described above (e.g. 480 successful frames for
1834  * legacy), and then repeat the search process.
1835  *
1836  */
1837 struct iwl_link_quality_cmd {
1838
1839         /* Index of destination/recipient station in uCode's station table */
1840         u8 sta_id;
1841         u8 reserved1;
1842         __le16 control;         /* not used */
1843         struct iwl_link_qual_general_params general_params;
1844         struct iwl_link_qual_agg_params agg_params;
1845
1846         /*
1847          * Rate info; when using rate-scaling, Tx command's initial_rate_index
1848          * specifies 1st Tx rate attempted, via index into this table.
1849          * agn devices works its way through table when retrying Tx.
1850          */
1851         struct {
1852                 __le32 rate_n_flags;    /* RATE_MCS_*, IWL_RATE_* */
1853         } rs_table[LINK_QUAL_MAX_RETRY_NUM];
1854         __le32 reserved2;
1855 } __packed;
1856
1857 /*
1858  * BT configuration enable flags:
1859  *   bit 0 - 1: BT channel announcement enabled
1860  *           0: disable
1861  *   bit 1 - 1: priority of BT device enabled
1862  *           0: disable
1863  *   bit 2 - 1: BT 2 wire support enabled
1864  *           0: disable
1865  */
1866 #define BT_COEX_DISABLE (0x0)
1867 #define BT_ENABLE_CHANNEL_ANNOUNCE BIT(0)
1868 #define BT_ENABLE_PRIORITY         BIT(1)
1869 #define BT_ENABLE_2_WIRE           BIT(2)
1870
1871 #define BT_COEX_DISABLE (0x0)
1872 #define BT_COEX_ENABLE  (BT_ENABLE_CHANNEL_ANNOUNCE | BT_ENABLE_PRIORITY)
1873
1874 #define BT_LEAD_TIME_MIN (0x0)
1875 #define BT_LEAD_TIME_DEF (0x1E)
1876 #define BT_LEAD_TIME_MAX (0xFF)
1877
1878 #define BT_MAX_KILL_MIN (0x1)
1879 #define BT_MAX_KILL_DEF (0x5)
1880 #define BT_MAX_KILL_MAX (0xFF)
1881
1882 #define BT_DURATION_LIMIT_DEF   625
1883 #define BT_DURATION_LIMIT_MAX   1250
1884 #define BT_DURATION_LIMIT_MIN   625
1885
1886 #define BT_ON_THRESHOLD_DEF     4
1887 #define BT_ON_THRESHOLD_MAX     1000
1888 #define BT_ON_THRESHOLD_MIN     1
1889
1890 #define BT_FRAG_THRESHOLD_DEF   0
1891 #define BT_FRAG_THRESHOLD_MAX   0
1892 #define BT_FRAG_THRESHOLD_MIN   0
1893
1894 #define BT_AGG_THRESHOLD_DEF    1200
1895 #define BT_AGG_THRESHOLD_MAX    8000
1896 #define BT_AGG_THRESHOLD_MIN    400
1897
1898 /*
1899  * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
1900  *
1901  * 3945 and agn devices support hardware handshake with Bluetooth device on
1902  * same platform.  Bluetooth device alerts wireless device when it will Tx;
1903  * wireless device can delay or kill its own Tx to accommodate.
1904  */
1905 struct iwl_bt_cmd {
1906         u8 flags;
1907         u8 lead_time;
1908         u8 max_kill;
1909         u8 reserved;
1910         __le32 kill_ack_mask;
1911         __le32 kill_cts_mask;
1912 } __packed;
1913
1914 #define IWLAGN_BT_FLAG_CHANNEL_INHIBITION       BIT(0)
1915
1916 #define IWLAGN_BT_FLAG_COEX_MODE_MASK           (BIT(3)|BIT(4)|BIT(5))
1917 #define IWLAGN_BT_FLAG_COEX_MODE_SHIFT          3
1918 #define IWLAGN_BT_FLAG_COEX_MODE_DISABLED       0
1919 #define IWLAGN_BT_FLAG_COEX_MODE_LEGACY_2W      1
1920 #define IWLAGN_BT_FLAG_COEX_MODE_3W             2
1921 #define IWLAGN_BT_FLAG_COEX_MODE_4W             3
1922
1923 #define IWLAGN_BT_FLAG_UCODE_DEFAULT            BIT(6)
1924 /* Disable Sync PSPoll on SCO/eSCO */
1925 #define IWLAGN_BT_FLAG_SYNC_2_BT_DISABLE        BIT(7)
1926
1927 #define IWLAGN_BT_PRIO_BOOST_MAX        0xFF
1928 #define IWLAGN_BT_PRIO_BOOST_MIN        0x00
1929 #define IWLAGN_BT_PRIO_BOOST_DEFAULT    0xF0
1930
1931 #define IWLAGN_BT_MAX_KILL_DEFAULT      5
1932
1933 #define IWLAGN_BT3_T7_DEFAULT           1
1934
1935 #define IWLAGN_BT_KILL_ACK_MASK_DEFAULT cpu_to_le32(0xffff0000)
1936 #define IWLAGN_BT_KILL_CTS_MASK_DEFAULT cpu_to_le32(0xffff0000)
1937 #define IWLAGN_BT_KILL_ACK_CTS_MASK_SCO cpu_to_le32(0xffffffff)
1938
1939 #define IWLAGN_BT3_PRIO_SAMPLE_DEFAULT  2
1940
1941 #define IWLAGN_BT3_T2_DEFAULT           0xc
1942
1943 #define IWLAGN_BT_VALID_ENABLE_FLAGS    cpu_to_le16(BIT(0))
1944 #define IWLAGN_BT_VALID_BOOST           cpu_to_le16(BIT(1))
1945 #define IWLAGN_BT_VALID_MAX_KILL        cpu_to_le16(BIT(2))
1946 #define IWLAGN_BT_VALID_3W_TIMERS       cpu_to_le16(BIT(3))
1947 #define IWLAGN_BT_VALID_KILL_ACK_MASK   cpu_to_le16(BIT(4))
1948 #define IWLAGN_BT_VALID_KILL_CTS_MASK   cpu_to_le16(BIT(5))
1949 #define IWLAGN_BT_VALID_BT4_TIMES       cpu_to_le16(BIT(6))
1950 #define IWLAGN_BT_VALID_3W_LUT          cpu_to_le16(BIT(7))
1951
1952 #define IWLAGN_BT_ALL_VALID_MSK         (IWLAGN_BT_VALID_ENABLE_FLAGS | \
1953                                         IWLAGN_BT_VALID_BOOST | \
1954                                         IWLAGN_BT_VALID_MAX_KILL | \
1955                                         IWLAGN_BT_VALID_3W_TIMERS | \
1956                                         IWLAGN_BT_VALID_KILL_ACK_MASK | \
1957                                         IWLAGN_BT_VALID_KILL_CTS_MASK | \
1958                                         IWLAGN_BT_VALID_BT4_TIMES | \
1959                                         IWLAGN_BT_VALID_3W_LUT)
1960
1961 struct iwl_basic_bt_cmd {
1962         u8 flags;
1963         u8 ledtime; /* unused */
1964         u8 max_kill;
1965         u8 bt3_timer_t7_value;
1966         __le32 kill_ack_mask;
1967         __le32 kill_cts_mask;
1968         u8 bt3_prio_sample_time;
1969         u8 bt3_timer_t2_value;
1970         __le16 bt4_reaction_time; /* unused */
1971         __le32 bt3_lookup_table[12];
1972         __le16 bt4_decision_time; /* unused */
1973         __le16 valid;
1974 };
1975
1976 struct iwl6000_bt_cmd {
1977         struct iwl_basic_bt_cmd basic;
1978         u8 prio_boost;
1979         /*
1980          * set IWLAGN_BT_VALID_BOOST to "1" in "valid" bitmask
1981          * if configure the following patterns
1982          */
1983         u8 tx_prio_boost;       /* SW boost of WiFi tx priority */
1984         __le16 rx_prio_boost;   /* SW boost of WiFi rx priority */
1985 };
1986
1987 struct iwl2000_bt_cmd {
1988         struct iwl_basic_bt_cmd basic;
1989         __le32 prio_boost;
1990         /*
1991          * set IWLAGN_BT_VALID_BOOST to "1" in "valid" bitmask
1992          * if configure the following patterns
1993          */
1994         u8 reserved;
1995         u8 tx_prio_boost;       /* SW boost of WiFi tx priority */
1996         __le16 rx_prio_boost;   /* SW boost of WiFi rx priority */
1997 };
1998
1999 #define IWLAGN_BT_SCO_ACTIVE    cpu_to_le32(BIT(0))
2000
2001 struct iwlagn_bt_sco_cmd {
2002         __le32 flags;
2003 };
2004
2005 /******************************************************************************
2006  * (6)
2007  * Spectrum Management (802.11h) Commands, Responses, Notifications:
2008  *
2009  *****************************************************************************/
2010
2011 /*
2012  * Spectrum Management
2013  */
2014 #define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK         | \
2015                                  RXON_FILTER_CTL2HOST_MSK        | \
2016                                  RXON_FILTER_ACCEPT_GRP_MSK      | \
2017                                  RXON_FILTER_DIS_DECRYPT_MSK     | \
2018                                  RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
2019                                  RXON_FILTER_ASSOC_MSK           | \
2020                                  RXON_FILTER_BCON_AWARE_MSK)
2021
2022 struct iwl_measure_channel {
2023         __le32 duration;        /* measurement duration in extended beacon
2024                                  * format */
2025         u8 channel;             /* channel to measure */
2026         u8 type;                /* see enum iwl_measure_type */
2027         __le16 reserved;
2028 } __packed;
2029
2030 /*
2031  * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
2032  */
2033 struct iwl_spectrum_cmd {
2034         __le16 len;             /* number of bytes starting from token */
2035         u8 token;               /* token id */
2036         u8 id;                  /* measurement id -- 0 or 1 */
2037         u8 origin;              /* 0 = TGh, 1 = other, 2 = TGk */
2038         u8 periodic;            /* 1 = periodic */
2039         __le16 path_loss_timeout;
2040         __le32 start_time;      /* start time in extended beacon format */
2041         __le32 reserved2;
2042         __le32 flags;           /* rxon flags */
2043         __le32 filter_flags;    /* rxon filter flags */
2044         __le16 channel_count;   /* minimum 1, maximum 10 */
2045         __le16 reserved3;
2046         struct iwl_measure_channel channels[10];
2047 } __packed;
2048
2049 /*
2050  * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
2051  */
2052 struct iwl_spectrum_resp {
2053         u8 token;
2054         u8 id;                  /* id of the prior command replaced, or 0xff */
2055         __le16 status;          /* 0 - command will be handled
2056                                  * 1 - cannot handle (conflicts with another
2057                                  *     measurement) */
2058 } __packed;
2059
2060 enum iwl_measurement_state {
2061         IWL_MEASUREMENT_START = 0,
2062         IWL_MEASUREMENT_STOP = 1,
2063 };
2064
2065 enum iwl_measurement_status {
2066         IWL_MEASUREMENT_OK = 0,
2067         IWL_MEASUREMENT_CONCURRENT = 1,
2068         IWL_MEASUREMENT_CSA_CONFLICT = 2,
2069         IWL_MEASUREMENT_TGH_CONFLICT = 3,
2070         /* 4-5 reserved */
2071         IWL_MEASUREMENT_STOPPED = 6,
2072         IWL_MEASUREMENT_TIMEOUT = 7,
2073         IWL_MEASUREMENT_PERIODIC_FAILED = 8,
2074 };
2075
2076 #define NUM_ELEMENTS_IN_HISTOGRAM 8
2077
2078 struct iwl_measurement_histogram {
2079         __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
2080         __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM];  /* in 1usec counts */
2081 } __packed;
2082
2083 /* clear channel availability counters */
2084 struct iwl_measurement_cca_counters {
2085         __le32 ofdm;
2086         __le32 cck;
2087 } __packed;
2088
2089 enum iwl_measure_type {
2090         IWL_MEASURE_BASIC = (1 << 0),
2091         IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
2092         IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
2093         IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
2094         IWL_MEASURE_FRAME = (1 << 4),
2095         /* bits 5:6 are reserved */
2096         IWL_MEASURE_IDLE = (1 << 7),
2097 };
2098
2099 /*
2100  * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
2101  */
2102 struct iwl_spectrum_notification {
2103         u8 id;                  /* measurement id -- 0 or 1 */
2104         u8 token;
2105         u8 channel_index;       /* index in measurement channel list */
2106         u8 state;               /* 0 - start, 1 - stop */
2107         __le32 start_time;      /* lower 32-bits of TSF */
2108         u8 band;                /* 0 - 5.2GHz, 1 - 2.4GHz */
2109         u8 channel;
2110         u8 type;                /* see enum iwl_measurement_type */
2111         u8 reserved1;
2112         /* NOTE:  cca_ofdm, cca_cck, basic_type, and histogram are only only
2113          * valid if applicable for measurement type requested. */
2114         __le32 cca_ofdm;        /* cca fraction time in 40Mhz clock periods */
2115         __le32 cca_cck;         /* cca fraction time in 44Mhz clock periods */
2116         __le32 cca_time;        /* channel load time in usecs */
2117         u8 basic_type;          /* 0 - bss, 1 - ofdm preamble, 2 -
2118                                  * unidentified */
2119         u8 reserved2[3];
2120         struct iwl_measurement_histogram histogram;
2121         __le32 stop_time;       /* lower 32-bits of TSF */
2122         __le32 status;          /* see iwl_measurement_status */
2123 } __packed;
2124
2125 /******************************************************************************
2126  * (7)
2127  * Power Management Commands, Responses, Notifications:
2128  *
2129  *****************************************************************************/
2130
2131 /**
2132  * struct iwl_powertable_cmd - Power Table Command
2133  * @flags: See below:
2134  *
2135  * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
2136  *
2137  * PM allow:
2138  *   bit 0 - '0' Driver not allow power management
2139  *           '1' Driver allow PM (use rest of parameters)
2140  *
2141  * uCode send sleep notifications:
2142  *   bit 1 - '0' Don't send sleep notification
2143  *           '1' send sleep notification (SEND_PM_NOTIFICATION)
2144  *
2145  * Sleep over DTIM
2146  *   bit 2 - '0' PM have to walk up every DTIM
2147  *           '1' PM could sleep over DTIM till listen Interval.
2148  *
2149  * PCI power managed
2150  *   bit 3 - '0' (PCI_CFG_LINK_CTRL & 0x1)
2151  *           '1' !(PCI_CFG_LINK_CTRL & 0x1)
2152  *
2153  * Fast PD
2154  *   bit 4 - '1' Put radio to sleep when receiving frame for others
2155  *
2156  * Force sleep Modes
2157  *   bit 31/30- '00' use both mac/xtal sleeps
2158  *              '01' force Mac sleep
2159  *              '10' force xtal sleep
2160  *              '11' Illegal set
2161  *
2162  * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
2163  * ucode assume sleep over DTIM is allowed and we don't need to wake up
2164  * for every DTIM.
2165  */
2166 #define IWL_POWER_VEC_SIZE 5
2167
2168 #define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK        cpu_to_le16(BIT(0))
2169 #define IWL_POWER_POWER_SAVE_ENA_MSK            cpu_to_le16(BIT(0))
2170 #define IWL_POWER_POWER_MANAGEMENT_ENA_MSK      cpu_to_le16(BIT(1))
2171 #define IWL_POWER_SLEEP_OVER_DTIM_MSK           cpu_to_le16(BIT(2))
2172 #define IWL_POWER_PCI_PM_MSK                    cpu_to_le16(BIT(3))
2173 #define IWL_POWER_FAST_PD                       cpu_to_le16(BIT(4))
2174 #define IWL_POWER_BEACON_FILTERING              cpu_to_le16(BIT(5))
2175 #define IWL_POWER_SHADOW_REG_ENA                cpu_to_le16(BIT(6))
2176 #define IWL_POWER_CT_KILL_SET                   cpu_to_le16(BIT(7))
2177 #define IWL_POWER_BT_SCO_ENA                    cpu_to_le16(BIT(8))
2178 #define IWL_POWER_ADVANCE_PM_ENA_MSK            cpu_to_le16(BIT(9))
2179
2180 struct iwl_powertable_cmd {
2181         __le16 flags;
2182         u8 keep_alive_seconds;          /* 3945 reserved */
2183         u8 debug_flags;                 /* 3945 reserved */
2184         __le32 rx_data_timeout;
2185         __le32 tx_data_timeout;
2186         __le32 sleep_interval[IWL_POWER_VEC_SIZE];
2187         __le32 keep_alive_beacons;
2188 } __packed;
2189
2190 /*
2191  * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
2192  * all devices identical.
2193  */
2194 struct iwl_sleep_notification {
2195         u8 pm_sleep_mode;
2196         u8 pm_wakeup_src;
2197         __le16 reserved;
2198         __le32 sleep_time;
2199         __le32 tsf_low;
2200         __le32 bcon_timer;
2201 } __packed;
2202
2203 /* Sleep states.  all devices identical. */
2204 enum {
2205         IWL_PM_NO_SLEEP = 0,
2206         IWL_PM_SLP_MAC = 1,
2207         IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
2208         IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
2209         IWL_PM_SLP_PHY = 4,
2210         IWL_PM_SLP_REPENT = 5,
2211         IWL_PM_WAKEUP_BY_TIMER = 6,
2212         IWL_PM_WAKEUP_BY_DRIVER = 7,
2213         IWL_PM_WAKEUP_BY_RFKILL = 8,
2214         /* 3 reserved */
2215         IWL_PM_NUM_OF_MODES = 12,
2216 };
2217
2218 /*
2219  * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
2220  */
2221 #define CARD_STATE_CMD_DISABLE 0x00     /* Put card to sleep */
2222 #define CARD_STATE_CMD_ENABLE  0x01     /* Wake up card */
2223 #define CARD_STATE_CMD_HALT    0x02     /* Power down permanently */
2224 struct iwl_card_state_cmd {
2225         __le32 status;          /* CARD_STATE_CMD_* request new power state */
2226 } __packed;
2227
2228 /*
2229  * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
2230  */
2231 struct iwl_card_state_notif {
2232         __le32 flags;
2233 } __packed;
2234
2235 #define HW_CARD_DISABLED   0x01
2236 #define SW_CARD_DISABLED   0x02
2237 #define CT_CARD_DISABLED   0x04
2238 #define RXON_CARD_DISABLED 0x10
2239
2240 struct iwl_ct_kill_config {
2241         __le32   reserved;
2242         __le32   critical_temperature_M;
2243         __le32   critical_temperature_R;
2244 }  __packed;
2245
2246 /* 1000, and 6x00 */
2247 struct iwl_ct_kill_throttling_config {
2248         __le32   critical_temperature_exit;
2249         __le32   reserved;
2250         __le32   critical_temperature_enter;
2251 }  __packed;
2252
2253 /******************************************************************************
2254  * (8)
2255  * Scan Commands, Responses, Notifications:
2256  *
2257  *****************************************************************************/
2258
2259 #define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0)
2260 #define SCAN_CHANNEL_TYPE_ACTIVE  cpu_to_le32(1)
2261
2262 /**
2263  * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table
2264  *
2265  * One for each channel in the scan list.
2266  * Each channel can independently select:
2267  * 1)  SSID for directed active scans
2268  * 2)  Txpower setting (for rate specified within Tx command)
2269  * 3)  How long to stay on-channel (behavior may be modified by quiet_time,
2270  *     quiet_plcp_th, good_CRC_th)
2271  *
2272  * To avoid uCode errors, make sure the following are true (see comments
2273  * under struct iwl_scan_cmd about max_out_time and quiet_time):
2274  * 1)  If using passive_dwell (i.e. passive_dwell != 0):
2275  *     active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
2276  * 2)  quiet_time <= active_dwell
2277  * 3)  If restricting off-channel time (i.e. max_out_time !=0):
2278  *     passive_dwell < max_out_time
2279  *     active_dwell < max_out_time
2280  */
2281
2282 struct iwl_scan_channel {
2283         /*
2284          * type is defined as:
2285          * 0:0 1 = active, 0 = passive
2286          * 1:20 SSID direct bit map; if a bit is set, then corresponding
2287          *     SSID IE is transmitted in probe request.
2288          * 21:31 reserved
2289          */
2290         __le32 type;
2291         __le16 channel; /* band is selected by iwl_scan_cmd "flags" field */
2292         u8 tx_gain;             /* gain for analog radio */
2293         u8 dsp_atten;           /* gain for DSP */
2294         __le16 active_dwell;    /* in 1024-uSec TU (time units), typ 5-50 */
2295         __le16 passive_dwell;   /* in 1024-uSec TU (time units), typ 20-500 */
2296 } __packed;
2297
2298 /* set number of direct probes __le32 type */
2299 #define IWL_SCAN_PROBE_MASK(n)  cpu_to_le32((BIT(n) | (BIT(n) - BIT(1))))
2300
2301 /**
2302  * struct iwl_ssid_ie - directed scan network information element
2303  *
2304  * Up to 20 of these may appear in REPLY_SCAN_CMD (Note: Only 4 are in
2305  * 3945 SCAN api), selected by "type" bit field in struct iwl_scan_channel;
2306  * each channel may select different ssids from among the 20 (4) entries.
2307  * SSID IEs get transmitted in reverse order of entry.
2308  */
2309 struct iwl_ssid_ie {
2310         u8 id;
2311         u8 len;
2312         u8 ssid[32];
2313 } __packed;
2314
2315 #define PROBE_OPTION_MAX_3945           4
2316 #define PROBE_OPTION_MAX                20
2317 #define TX_CMD_LIFE_TIME_INFINITE       cpu_to_le32(0xFFFFFFFF)
2318 #define IWL_GOOD_CRC_TH_DISABLED        0
2319 #define IWL_GOOD_CRC_TH_DEFAULT         cpu_to_le16(1)
2320 #define IWL_GOOD_CRC_TH_NEVER           cpu_to_le16(0xffff)
2321 #define IWL_MAX_SCAN_SIZE 1024
2322 #define IWL_MAX_CMD_SIZE 4096
2323
2324 /*
2325  * REPLY_SCAN_CMD = 0x80 (command)
2326  *
2327  * The hardware scan command is very powerful; the driver can set it up to
2328  * maintain (relatively) normal network traffic while doing a scan in the
2329  * background.  The max_out_time and suspend_time control the ratio of how
2330  * long the device stays on an associated network channel ("service channel")
2331  * vs. how long it's away from the service channel, i.e. tuned to other channels
2332  * for scanning.
2333  *
2334  * max_out_time is the max time off-channel (in usec), and suspend_time
2335  * is how long (in "extended beacon" format) that the scan is "suspended"
2336  * after returning to the service channel.  That is, suspend_time is the
2337  * time that we stay on the service channel, doing normal work, between
2338  * scan segments.  The driver may set these parameters differently to support
2339  * scanning when associated vs. not associated, and light vs. heavy traffic
2340  * loads when associated.
2341  *
2342  * After receiving this command, the device's scan engine does the following;
2343  *
2344  * 1)  Sends SCAN_START notification to driver
2345  * 2)  Checks to see if it has time to do scan for one channel
2346  * 3)  Sends NULL packet, with power-save (PS) bit set to 1,
2347  *     to tell AP that we're going off-channel
2348  * 4)  Tunes to first channel in scan list, does active or passive scan
2349  * 5)  Sends SCAN_RESULT notification to driver
2350  * 6)  Checks to see if it has time to do scan on *next* channel in list
2351  * 7)  Repeats 4-6 until it no longer has time to scan the next channel
2352  *     before max_out_time expires
2353  * 8)  Returns to service channel
2354  * 9)  Sends NULL packet with PS=0 to tell AP that we're back
2355  * 10) Stays on service channel until suspend_time expires
2356  * 11) Repeats entire process 2-10 until list is complete
2357  * 12) Sends SCAN_COMPLETE notification
2358  *
2359  * For fast, efficient scans, the scan command also has support for staying on
2360  * a channel for just a short time, if doing active scanning and getting no
2361  * responses to the transmitted probe request.  This time is controlled by
2362  * quiet_time, and the number of received packets below which a channel is
2363  * considered "quiet" is controlled by quiet_plcp_threshold.
2364  *
2365  * For active scanning on channels that have regulatory restrictions against
2366  * blindly transmitting, the scan can listen before transmitting, to make sure
2367  * that there is already legitimate activity on the channel.  If enough
2368  * packets are cleanly received on the channel (controlled by good_CRC_th,
2369  * typical value 1), the scan engine starts transmitting probe requests.
2370  *
2371  * Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
2372  *
2373  * To avoid uCode errors, see timing restrictions described under
2374  * struct iwl_scan_channel.
2375  */
2376
2377 enum iwl_scan_flags {
2378         /* BIT(0) currently unused */
2379         IWL_SCAN_FLAGS_ACTION_FRAME_TX  = BIT(1),
2380         /* bits 2-7 reserved */
2381 };
2382
2383 struct iwl_scan_cmd {
2384         __le16 len;
2385         u8 scan_flags;          /* scan flags: see enum iwl_scan_flags */
2386         u8 channel_count;       /* # channels in channel list */
2387         __le16 quiet_time;      /* dwell only this # millisecs on quiet channel
2388                                  * (only for active scan) */
2389         __le16 quiet_plcp_th;   /* quiet chnl is < this # pkts (typ. 1) */
2390         __le16 good_CRC_th;     /* passive -> active promotion threshold */
2391         __le16 rx_chain;        /* RXON_RX_CHAIN_* */
2392         __le32 max_out_time;    /* max usec to be away from associated (service)
2393                                  * channel */
2394         __le32 suspend_time;    /* pause scan this long (in "extended beacon
2395                                  * format") when returning to service chnl:
2396                                  * 3945; 31:24 # beacons, 19:0 additional usec,
2397                                  * 4965; 31:22 # beacons, 21:0 additional usec.
2398                                  */
2399         __le32 flags;           /* RXON_FLG_* */
2400         __le32 filter_flags;    /* RXON_FILTER_* */
2401
2402         /* For active scans (set to all-0s for passive scans).
2403          * Does not include payload.  Must specify Tx rate; no rate scaling. */
2404         struct iwl_tx_cmd tx_cmd;
2405
2406         /* For directed active scans (set to all-0s otherwise) */
2407         struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
2408
2409         /*
2410          * Probe request frame, followed by channel list.
2411          *
2412          * Size of probe request frame is specified by byte count in tx_cmd.
2413          * Channel list follows immediately after probe request frame.
2414          * Number of channels in list is specified by channel_count.
2415          * Each channel in list is of type:
2416          *
2417          * struct iwl_scan_channel channels[0];
2418          *
2419          * NOTE:  Only one band of channels can be scanned per pass.  You
2420          * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
2421          * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
2422          * before requesting another scan.
2423          */
2424         u8 data[0];
2425 } __packed;
2426
2427 /* Can abort will notify by complete notification with abort status. */
2428 #define CAN_ABORT_STATUS        cpu_to_le32(0x1)
2429 /* complete notification statuses */
2430 #define ABORT_STATUS            0x2
2431
2432 /*
2433  * REPLY_SCAN_CMD = 0x80 (response)
2434  */
2435 struct iwl_scanreq_notification {
2436         __le32 status;          /* 1: okay, 2: cannot fulfill request */
2437 } __packed;
2438
2439 /*
2440  * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
2441  */
2442 struct iwl_scanstart_notification {
2443         __le32 tsf_low;
2444         __le32 tsf_high;
2445         __le32 beacon_timer;
2446         u8 channel;
2447         u8 band;
2448         u8 reserved[2];
2449         __le32 status;
2450 } __packed;
2451
2452 #define  SCAN_OWNER_STATUS 0x1;
2453 #define  MEASURE_OWNER_STATUS 0x2;
2454
2455 #define IWL_PROBE_STATUS_OK             0
2456 #define IWL_PROBE_STATUS_TX_FAILED      BIT(0)
2457 /* error statuses combined with TX_FAILED */
2458 #define IWL_PROBE_STATUS_FAIL_TTL       BIT(1)
2459 #define IWL_PROBE_STATUS_FAIL_BT        BIT(2)
2460
2461 #define NUMBER_OF_STATISTICS 1  /* first __le32 is good CRC */
2462 /*
2463  * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
2464  */
2465 struct iwl_scanresults_notification {
2466         u8 channel;
2467         u8 band;
2468         u8 probe_status;
2469         u8 num_probe_not_sent; /* not enough time to send */
2470         __le32 tsf_low;
2471         __le32 tsf_high;
2472         __le32 statistics[NUMBER_OF_STATISTICS];
2473 } __packed;
2474
2475 /*
2476  * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
2477  */
2478 struct iwl_scancomplete_notification {
2479         u8 scanned_channels;
2480         u8 status;
2481         u8 bt_status;   /* BT On/Off status */
2482         u8 last_channel;
2483         __le32 tsf_low;
2484         __le32 tsf_high;
2485 } __packed;
2486
2487
2488 /******************************************************************************
2489  * (9)
2490  * IBSS/AP Commands and Notifications:
2491  *
2492  *****************************************************************************/
2493
2494 enum iwl_ibss_manager {
2495         IWL_NOT_IBSS_MANAGER = 0,
2496         IWL_IBSS_MANAGER = 1,
2497 };
2498
2499 /*
2500  * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
2501  */
2502
2503 struct iwlagn_beacon_notif {
2504         struct iwlagn_tx_resp beacon_notify_hdr;
2505         __le32 low_tsf;
2506         __le32 high_tsf;
2507         __le32 ibss_mgr_status;
2508 } __packed;
2509
2510 /*
2511  * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
2512  */
2513
2514 struct iwl_tx_beacon_cmd {
2515         struct iwl_tx_cmd tx;
2516         __le16 tim_idx;
2517         u8 tim_size;
2518         u8 reserved1;
2519         struct ieee80211_hdr frame[0];  /* beacon frame */
2520 } __packed;
2521
2522 /******************************************************************************
2523  * (10)
2524  * Statistics Commands and Notifications:
2525  *
2526  *****************************************************************************/
2527
2528 #define IWL_TEMP_CONVERT 260
2529
2530 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
2531 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
2532 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
2533
2534 /* Used for passing to driver number of successes and failures per rate */
2535 struct rate_histogram {
2536         union {
2537                 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2538                 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2539                 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2540         } success;
2541         union {
2542                 __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
2543                 __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
2544                 __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
2545         } failed;
2546 } __packed;
2547
2548 /* statistics command response */
2549
2550 struct statistics_dbg {
2551         __le32 burst_check;
2552         __le32 burst_count;
2553         __le32 wait_for_silence_timeout_cnt;
2554         __le32 reserved[3];
2555 } __packed;
2556
2557 struct statistics_rx_phy {
2558         __le32 ina_cnt;
2559         __le32 fina_cnt;
2560         __le32 plcp_err;
2561         __le32 crc32_err;
2562         __le32 overrun_err;
2563         __le32 early_overrun_err;
2564         __le32 crc32_good;
2565         __le32 false_alarm_cnt;
2566         __le32 fina_sync_err_cnt;
2567         __le32 sfd_timeout;
2568         __le32 fina_timeout;
2569         __le32 unresponded_rts;
2570         __le32 rxe_frame_limit_overrun;
2571         __le32 sent_ack_cnt;
2572         __le32 sent_cts_cnt;
2573         __le32 sent_ba_rsp_cnt;
2574         __le32 dsp_self_kill;
2575         __le32 mh_format_err;
2576         __le32 re_acq_main_rssi_sum;
2577         __le32 reserved3;
2578 } __packed;
2579
2580 struct statistics_rx_ht_phy {
2581         __le32 plcp_err;
2582         __le32 overrun_err;
2583         __le32 early_overrun_err;
2584         __le32 crc32_good;
2585         __le32 crc32_err;
2586         __le32 mh_format_err;
2587         __le32 agg_crc32_good;
2588         __le32 agg_mpdu_cnt;
2589         __le32 agg_cnt;
2590         __le32 unsupport_mcs;
2591 } __packed;
2592
2593 #define INTERFERENCE_DATA_AVAILABLE      cpu_to_le32(1)
2594
2595 struct statistics_rx_non_phy {
2596         __le32 bogus_cts;       /* CTS received when not expecting CTS */
2597         __le32 bogus_ack;       /* ACK received when not expecting ACK */
2598         __le32 non_bssid_frames;        /* number of frames with BSSID that
2599                                          * doesn't belong to the STA BSSID */
2600         __le32 filtered_frames; /* count frames that were dumped in the
2601                                  * filtering process */
2602         __le32 non_channel_beacons;     /* beacons with our bss id but not on
2603                                          * our serving channel */
2604         __le32 channel_beacons; /* beacons with our bss id and in our
2605                                  * serving channel */
2606         __le32 num_missed_bcon; /* number of missed beacons */
2607         __le32 adc_rx_saturation_time;  /* count in 0.8us units the time the
2608                                          * ADC was in saturation */
2609         __le32 ina_detection_search_time;/* total time (in 0.8us) searched
2610                                           * for INA */
2611         __le32 beacon_silence_rssi_a;   /* RSSI silence after beacon frame */
2612         __le32 beacon_silence_rssi_b;   /* RSSI silence after beacon frame */
2613         __le32 beacon_silence_rssi_c;   /* RSSI silence after beacon frame */
2614         __le32 interference_data_flag;  /* flag for interference data
2615                                          * availability. 1 when data is
2616                                          * available. */
2617         __le32 channel_load;            /* counts RX Enable time in uSec */
2618         __le32 dsp_false_alarms;        /* DSP false alarm (both OFDM
2619                                          * and CCK) counter */
2620         __le32 beacon_rssi_a;
2621         __le32 beacon_rssi_b;
2622         __le32 beacon_rssi_c;
2623         __le32 beacon_energy_a;
2624         __le32 beacon_energy_b;
2625         __le32 beacon_energy_c;
2626 } __packed;
2627
2628 struct statistics_rx_non_phy_bt {
2629         struct statistics_rx_non_phy common;
2630         /* additional stats for bt */
2631         __le32 num_bt_kills;
2632         __le32 reserved[2];
2633 } __packed;
2634
2635 struct statistics_rx {
2636         struct statistics_rx_phy ofdm;
2637         struct statistics_rx_phy cck;
2638         struct statistics_rx_non_phy general;
2639         struct statistics_rx_ht_phy ofdm_ht;
2640 } __packed;
2641
2642 struct statistics_rx_bt {
2643         struct statistics_rx_phy ofdm;
2644         struct statistics_rx_phy cck;
2645         struct statistics_rx_non_phy_bt general;
2646         struct statistics_rx_ht_phy ofdm_ht;
2647 } __packed;
2648
2649 /**
2650  * struct statistics_tx_power - current tx power
2651  *
2652  * @ant_a: current tx power on chain a in 1/2 dB step
2653  * @ant_b: current tx power on chain b in 1/2 dB step
2654  * @ant_c: current tx power on chain c in 1/2 dB step
2655  */
2656 struct statistics_tx_power {
2657         u8 ant_a;
2658         u8 ant_b;
2659         u8 ant_c;
2660         u8 reserved;
2661 } __packed;
2662
2663 struct statistics_tx_non_phy_agg {
2664         __le32 ba_timeout;
2665         __le32 ba_reschedule_frames;
2666         __le32 scd_query_agg_frame_cnt;
2667         __le32 scd_query_no_agg;
2668         __le32 scd_query_agg;
2669         __le32 scd_query_mismatch;
2670         __le32 frame_not_ready;
2671         __le32 underrun;
2672         __le32 bt_prio_kill;
2673         __le32 rx_ba_rsp_cnt;
2674 } __packed;
2675
2676 struct statistics_tx {
2677         __le32 preamble_cnt;
2678         __le32 rx_detected_cnt;
2679         __le32 bt_prio_defer_cnt;
2680         __le32 bt_prio_kill_cnt;
2681         __le32 few_bytes_cnt;
2682         __le32 cts_timeout;
2683         __le32 ack_timeout;
2684         __le32 expected_ack_cnt;
2685         __le32 actual_ack_cnt;
2686         __le32 dump_msdu_cnt;
2687         __le32 burst_abort_next_frame_mismatch_cnt;
2688         __le32 burst_abort_missing_next_frame_cnt;
2689         __le32 cts_timeout_collision;
2690         __le32 ack_or_ba_timeout_collision;
2691         struct statistics_tx_non_phy_agg agg;
2692         /*
2693          * "tx_power" are optional parameters provided by uCode,
2694          * 6000 series is the only device provide the information,
2695          * Those are reserved fields for all the other devices
2696          */
2697         struct statistics_tx_power tx_power;
2698         __le32 reserved1;
2699 } __packed;
2700
2701
2702 struct statistics_div {
2703         __le32 tx_on_a;
2704         __le32 tx_on_b;
2705         __le32 exec_time;
2706         __le32 probe_time;
2707         __le32 reserved1;
2708         __le32 reserved2;
2709 } __packed;
2710
2711 struct statistics_general_common {
2712         __le32 temperature;   /* radio temperature */
2713         __le32 temperature_m; /* for 5000 and up, this is radio voltage */
2714         struct statistics_dbg dbg;
2715         __le32 sleep_time;
2716         __le32 slots_out;
2717         __le32 slots_idle;
2718         __le32 ttl_timestamp;
2719         struct statistics_div div;
2720         __le32 rx_enable_counter;
2721         /*
2722          * num_of_sos_states:
2723          *  count the number of times we have to re-tune
2724          *  in order to get out of bad PHY status
2725          */
2726         __le32 num_of_sos_states;
2727 } __packed;
2728
2729 struct statistics_bt_activity {
2730         /* Tx statistics */
2731         __le32 hi_priority_tx_req_cnt;
2732         __le32 hi_priority_tx_denied_cnt;
2733         __le32 lo_priority_tx_req_cnt;
2734         __le32 lo_priority_tx_denied_cnt;
2735         /* Rx statistics */
2736         __le32 hi_priority_rx_req_cnt;
2737         __le32 hi_priority_rx_denied_cnt;
2738         __le32 lo_priority_rx_req_cnt;
2739         __le32 lo_priority_rx_denied_cnt;
2740 } __packed;
2741
2742 struct statistics_general {
2743         struct statistics_general_common common;
2744         __le32 reserved2;
2745         __le32 reserved3;
2746 } __packed;
2747
2748 struct statistics_general_bt {
2749         struct statistics_general_common common;
2750         struct statistics_bt_activity activity;
2751         __le32 reserved2;
2752         __le32 reserved3;
2753 } __packed;
2754
2755 #define UCODE_STATISTICS_CLEAR_MSK              (0x1 << 0)
2756 #define UCODE_STATISTICS_FREQUENCY_MSK          (0x1 << 1)
2757 #define UCODE_STATISTICS_NARROW_BAND_MSK        (0x1 << 2)
2758
2759 /*
2760  * REPLY_STATISTICS_CMD = 0x9c,
2761  * all devices identical.
2762  *
2763  * This command triggers an immediate response containing uCode statistics.
2764  * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
2765  *
2766  * If the CLEAR_STATS configuration flag is set, uCode will clear its
2767  * internal copy of the statistics (counters) after issuing the response.
2768  * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
2769  *
2770  * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
2771  * STATISTICS_NOTIFICATIONs after received beacons (see below).  This flag
2772  * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
2773  */
2774 #define IWL_STATS_CONF_CLEAR_STATS cpu_to_le32(0x1)     /* see above */
2775 #define IWL_STATS_CONF_DISABLE_NOTIF cpu_to_le32(0x2)/* see above */
2776 struct iwl_statistics_cmd {
2777         __le32 configuration_flags;     /* IWL_STATS_CONF_* */
2778 } __packed;
2779
2780 /*
2781  * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
2782  *
2783  * By default, uCode issues this notification after receiving a beacon
2784  * while associated.  To disable this behavior, set DISABLE_NOTIF flag in the
2785  * REPLY_STATISTICS_CMD 0x9c, above.
2786  *
2787  * Statistics counters continue to increment beacon after beacon, but are
2788  * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
2789  * 0x9c with CLEAR_STATS bit set (see above).
2790  *
2791  * uCode also issues this notification during scans.  uCode clears statistics
2792  * appropriately so that each notification contains statistics for only the
2793  * one channel that has just been scanned.
2794  */
2795 #define STATISTICS_REPLY_FLG_BAND_24G_MSK         cpu_to_le32(0x2)
2796 #define STATISTICS_REPLY_FLG_HT40_MODE_MSK        cpu_to_le32(0x8)
2797
2798 struct iwl_notif_statistics {
2799         __le32 flag;
2800         struct statistics_rx rx;
2801         struct statistics_tx tx;
2802         struct statistics_general general;
2803 } __packed;
2804
2805 struct iwl_bt_notif_statistics {
2806         __le32 flag;
2807         struct statistics_rx_bt rx;
2808         struct statistics_tx tx;
2809         struct statistics_general_bt general;
2810 } __packed;
2811
2812 /*
2813  * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
2814  *
2815  * uCode send MISSED_BEACONS_NOTIFICATION to driver when detect beacon missed
2816  * in regardless of how many missed beacons, which mean when driver receive the
2817  * notification, inside the command, it can find all the beacons information
2818  * which include number of total missed beacons, number of consecutive missed
2819  * beacons, number of beacons received and number of beacons expected to
2820  * receive.
2821  *
2822  * If uCode detected consecutive_missed_beacons > 5, it will reset the radio
2823  * in order to bring the radio/PHY back to working state; which has no relation
2824  * to when driver will perform sensitivity calibration.
2825  *
2826  * Driver should set it own missed_beacon_threshold to decide when to perform
2827  * sensitivity calibration based on number of consecutive missed beacons in
2828  * order to improve overall performance, especially in noisy environment.
2829  *
2830  */
2831
2832 #define IWL_MISSED_BEACON_THRESHOLD_MIN (1)
2833 #define IWL_MISSED_BEACON_THRESHOLD_DEF (5)
2834 #define IWL_MISSED_BEACON_THRESHOLD_MAX IWL_MISSED_BEACON_THRESHOLD_DEF
2835
2836 struct iwl_missed_beacon_notif {
2837         __le32 consecutive_missed_beacons;
2838         __le32 total_missed_becons;
2839         __le32 num_expected_beacons;
2840         __le32 num_recvd_beacons;
2841 } __packed;
2842
2843
2844 /******************************************************************************
2845  * (11)
2846  * Rx Calibration Commands:
2847  *
2848  * With the uCode used for open source drivers, most Tx calibration (except
2849  * for Tx Power) and most Rx calibration is done by uCode during the
2850  * "initialize" phase of uCode boot.  Driver must calibrate only:
2851  *
2852  * 1)  Tx power (depends on temperature), described elsewhere
2853  * 2)  Receiver gain balance (optimize MIMO, and detect disconnected antennas)
2854  * 3)  Receiver sensitivity (to optimize signal detection)
2855  *
2856  *****************************************************************************/
2857
2858 /**
2859  * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
2860  *
2861  * This command sets up the Rx signal detector for a sensitivity level that
2862  * is high enough to lock onto all signals within the associated network,
2863  * but low enough to ignore signals that are below a certain threshold, so as
2864  * not to have too many "false alarms".  False alarms are signals that the
2865  * Rx DSP tries to lock onto, but then discards after determining that they
2866  * are noise.
2867  *
2868  * The optimum number of false alarms is between 5 and 50 per 200 TUs
2869  * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
2870  * time listening, not transmitting).  Driver must adjust sensitivity so that
2871  * the ratio of actual false alarms to actual Rx time falls within this range.
2872  *
2873  * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
2874  * received beacon.  These provide information to the driver to analyze the
2875  * sensitivity.  Don't analyze statistics that come in from scanning, or any
2876  * other non-associated-network source.  Pertinent statistics include:
2877  *
2878  * From "general" statistics (struct statistics_rx_non_phy):
2879  *
2880  * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
2881  *   Measure of energy of desired signal.  Used for establishing a level
2882  *   below which the device does not detect signals.
2883  *
2884  * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
2885  *   Measure of background noise in silent period after beacon.
2886  *
2887  * channel_load
2888  *   uSecs of actual Rx time during beacon period (varies according to
2889  *   how much time was spent transmitting).
2890  *
2891  * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
2892  *
2893  * false_alarm_cnt
2894  *   Signal locks abandoned early (before phy-level header).
2895  *
2896  * plcp_err
2897  *   Signal locks abandoned late (during phy-level header).
2898  *
2899  * NOTE:  Both false_alarm_cnt and plcp_err increment monotonically from
2900  *        beacon to beacon, i.e. each value is an accumulation of all errors
2901  *        before and including the latest beacon.  Values will wrap around to 0
2902  *        after counting up to 2^32 - 1.  Driver must differentiate vs.
2903  *        previous beacon's values to determine # false alarms in the current
2904  *        beacon period.
2905  *
2906  * Total number of false alarms = false_alarms + plcp_errs
2907  *
2908  * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
2909  * (notice that the start points for OFDM are at or close to settings for
2910  * maximum sensitivity):
2911  *
2912  *                                             START  /  MIN  /  MAX
2913  *   HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX          90   /   85  /  120
2914  *   HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX     170   /  170  /  210
2915  *   HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX         105   /  105  /  140
2916  *   HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX     220   /  220  /  270
2917  *
2918  *   If actual rate of OFDM false alarms (+ plcp_errors) is too high
2919  *   (greater than 50 for each 204.8 msecs listening), reduce sensitivity
2920  *   by *adding* 1 to all 4 of the table entries above, up to the max for
2921  *   each entry.  Conversely, if false alarm rate is too low (less than 5
2922  *   for each 204.8 msecs listening), *subtract* 1 from each entry to
2923  *   increase sensitivity.
2924  *
2925  * For CCK sensitivity, keep track of the following:
2926  *
2927  *   1).  20-beacon history of maximum background noise, indicated by
2928  *        (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
2929  *        3 receivers.  For any given beacon, the "silence reference" is
2930  *        the maximum of last 60 samples (20 beacons * 3 receivers).
2931  *
2932  *   2).  10-beacon history of strongest signal level, as indicated
2933  *        by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
2934  *        i.e. the strength of the signal through the best receiver at the
2935  *        moment.  These measurements are "upside down", with lower values
2936  *        for stronger signals, so max energy will be *minimum* value.
2937  *
2938  *        Then for any given beacon, the driver must determine the *weakest*
2939  *        of the strongest signals; this is the minimum level that needs to be
2940  *        successfully detected, when using the best receiver at the moment.
2941  *        "Max cck energy" is the maximum (higher value means lower energy!)
2942  *        of the last 10 minima.  Once this is determined, driver must add
2943  *        a little margin by adding "6" to it.
2944  *
2945  *   3).  Number of consecutive beacon periods with too few false alarms.
2946  *        Reset this to 0 at the first beacon period that falls within the
2947  *        "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
2948  *
2949  * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
2950  * (notice that the start points for CCK are at maximum sensitivity):
2951  *
2952  *                                             START  /  MIN  /  MAX
2953  *   HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX         125   /  125  /  200
2954  *   HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX     200   /  200  /  400
2955  *   HD_MIN_ENERGY_CCK_DET_INDEX                100   /    0  /  100
2956  *
2957  *   If actual rate of CCK false alarms (+ plcp_errors) is too high
2958  *   (greater than 50 for each 204.8 msecs listening), method for reducing
2959  *   sensitivity is:
2960  *
2961  *   1)  *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2962  *       up to max 400.
2963  *
2964  *   2)  If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
2965  *       sensitivity has been reduced a significant amount; bring it up to
2966  *       a moderate 161.  Otherwise, *add* 3, up to max 200.
2967  *
2968  *   3)  a)  If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
2969  *       sensitivity has been reduced only a moderate or small amount;
2970  *       *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
2971  *       down to min 0.  Otherwise (if gain has been significantly reduced),
2972  *       don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
2973  *
2974  *       b)  Save a snapshot of the "silence reference".
2975  *
2976  *   If actual rate of CCK false alarms (+ plcp_errors) is too low
2977  *   (less than 5 for each 204.8 msecs listening), method for increasing
2978  *   sensitivity is used only if:
2979  *
2980  *   1a)  Previous beacon did not have too many false alarms
2981  *   1b)  AND difference between previous "silence reference" and current
2982  *        "silence reference" (prev - current) is 2 or more,
2983  *   OR 2)  100 or more consecutive beacon periods have had rate of
2984  *          less than 5 false alarms per 204.8 milliseconds rx time.
2985  *
2986  *   Method for increasing sensitivity:
2987  *
2988  *   1)  *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
2989  *       down to min 125.
2990  *
2991  *   2)  *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
2992  *       down to min 200.
2993  *
2994  *   3)  *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
2995  *
2996  *   If actual rate of CCK false alarms (+ plcp_errors) is within good range
2997  *   (between 5 and 50 for each 204.8 msecs listening):
2998  *
2999  *   1)  Save a snapshot of the silence reference.
3000  *
3001  *   2)  If previous beacon had too many CCK false alarms (+ plcp_errors),
3002  *       give some extra margin to energy threshold by *subtracting* 8
3003  *       from value in HD_MIN_ENERGY_CCK_DET_INDEX.
3004  *
3005  *   For all cases (too few, too many, good range), make sure that the CCK
3006  *   detection threshold (energy) is below the energy level for robust
3007  *   detection over the past 10 beacon periods, the "Max cck energy".
3008  *   Lower values mean higher energy; this means making sure that the value
3009  *   in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
3010  *
3011  */
3012
3013 /*
3014  * Table entries in SENSITIVITY_CMD (struct iwl_sensitivity_cmd)
3015  */
3016 #define HD_TABLE_SIZE  (11)     /* number of entries */
3017 #define HD_MIN_ENERGY_CCK_DET_INDEX                 (0) /* table indexes */
3018 #define HD_MIN_ENERGY_OFDM_DET_INDEX                (1)
3019 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX          (2)
3020 #define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX      (3)
3021 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX      (4)
3022 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX          (5)
3023 #define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX      (6)
3024 #define HD_BARKER_CORR_TH_ADD_MIN_INDEX             (7)
3025 #define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX         (8)
3026 #define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX          (9)
3027 #define HD_OFDM_ENERGY_TH_IN_INDEX                  (10)
3028
3029 /*
3030  * Additional table entries in enhance SENSITIVITY_CMD
3031  */
3032 #define HD_INA_NON_SQUARE_DET_OFDM_INDEX                (11)
3033 #define HD_INA_NON_SQUARE_DET_CCK_INDEX                 (12)
3034 #define HD_CORR_11_INSTEAD_OF_CORR_9_EN_INDEX           (13)
3035 #define HD_OFDM_NON_SQUARE_DET_SLOPE_MRC_INDEX          (14)
3036 #define HD_OFDM_NON_SQUARE_DET_INTERCEPT_MRC_INDEX      (15)
3037 #define HD_OFDM_NON_SQUARE_DET_SLOPE_INDEX              (16)
3038 #define HD_OFDM_NON_SQUARE_DET_INTERCEPT_INDEX          (17)
3039 #define HD_CCK_NON_SQUARE_DET_SLOPE_MRC_INDEX           (18)
3040 #define HD_CCK_NON_SQUARE_DET_INTERCEPT_MRC_INDEX       (19)
3041 #define HD_CCK_NON_SQUARE_DET_SLOPE_INDEX               (20)
3042 #define HD_CCK_NON_SQUARE_DET_INTERCEPT_INDEX           (21)
3043 #define HD_RESERVED                                     (22)
3044
3045 /* number of entries for enhanced tbl */
3046 #define ENHANCE_HD_TABLE_SIZE  (23)
3047
3048 /* number of additional entries for enhanced tbl */
3049 #define ENHANCE_HD_TABLE_ENTRIES  (ENHANCE_HD_TABLE_SIZE - HD_TABLE_SIZE)
3050
3051 #define HD_INA_NON_SQUARE_DET_OFDM_DATA                 cpu_to_le16(0)
3052 #define HD_INA_NON_SQUARE_DET_CCK_DATA                  cpu_to_le16(0)
3053 #define HD_CORR_11_INSTEAD_OF_CORR_9_EN_DATA            cpu_to_le16(0)
3054 #define HD_OFDM_NON_SQUARE_DET_SLOPE_MRC_DATA           cpu_to_le16(668)
3055 #define HD_OFDM_NON_SQUARE_DET_INTERCEPT_MRC_DATA       cpu_to_le16(4)
3056 #define HD_OFDM_NON_SQUARE_DET_SLOPE_DATA               cpu_to_le16(486)
3057 #define HD_OFDM_NON_SQUARE_DET_INTERCEPT_DATA           cpu_to_le16(37)
3058 #define HD_CCK_NON_SQUARE_DET_SLOPE_MRC_DATA            cpu_to_le16(853)
3059 #define HD_CCK_NON_SQUARE_DET_INTERCEPT_MRC_DATA        cpu_to_le16(4)
3060 #define HD_CCK_NON_SQUARE_DET_SLOPE_DATA                cpu_to_le16(476)
3061 #define HD_CCK_NON_SQUARE_DET_INTERCEPT_DATA            cpu_to_le16(99)
3062
3063
3064 /* Control field in struct iwl_sensitivity_cmd */
3065 #define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE   cpu_to_le16(0)
3066 #define SENSITIVITY_CMD_CONTROL_WORK_TABLE      cpu_to_le16(1)
3067
3068 /**
3069  * struct iwl_sensitivity_cmd
3070  * @control:  (1) updates working table, (0) updates default table
3071  * @table:  energy threshold values, use HD_* as index into table
3072  *
3073  * Always use "1" in "control" to update uCode's working table and DSP.
3074  */
3075 struct iwl_sensitivity_cmd {
3076         __le16 control;                 /* always use "1" */
3077         __le16 table[HD_TABLE_SIZE];    /* use HD_* as index */
3078 } __packed;
3079
3080 /*
3081  *
3082  */
3083 struct iwl_enhance_sensitivity_cmd {
3084         __le16 control;                 /* always use "1" */
3085         __le16 enhance_table[ENHANCE_HD_TABLE_SIZE];    /* use HD_* as index */
3086 } __packed;
3087
3088
3089 /**
3090  * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
3091  *
3092  * This command sets the relative gains of agn device's 3 radio receiver chains.
3093  *
3094  * After the first association, driver should accumulate signal and noise
3095  * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
3096  * beacons from the associated network (don't collect statistics that come
3097  * in from scanning, or any other non-network source).
3098  *
3099  * DISCONNECTED ANTENNA:
3100  *
3101  * Driver should determine which antennas are actually connected, by comparing
3102  * average beacon signal levels for the 3 Rx chains.  Accumulate (add) the
3103  * following values over 20 beacons, one accumulator for each of the chains
3104  * a/b/c, from struct statistics_rx_non_phy:
3105  *
3106  * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
3107  *
3108  * Find the strongest signal from among a/b/c.  Compare the other two to the
3109  * strongest.  If any signal is more than 15 dB (times 20, unless you
3110  * divide the accumulated values by 20) below the strongest, the driver
3111  * considers that antenna to be disconnected, and should not try to use that
3112  * antenna/chain for Rx or Tx.  If both A and B seem to be disconnected,
3113  * driver should declare the stronger one as connected, and attempt to use it
3114  * (A and B are the only 2 Tx chains!).
3115  *
3116  *
3117  * RX BALANCE:
3118  *
3119  * Driver should balance the 3 receivers (but just the ones that are connected
3120  * to antennas, see above) for gain, by comparing the average signal levels
3121  * detected during the silence after each beacon (background noise).
3122  * Accumulate (add) the following values over 20 beacons, one accumulator for
3123  * each of the chains a/b/c, from struct statistics_rx_non_phy:
3124  *
3125  * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
3126  *
3127  * Find the weakest background noise level from among a/b/c.  This Rx chain
3128  * will be the reference, with 0 gain adjustment.  Attenuate other channels by
3129  * finding noise difference:
3130  *
3131  * (accum_noise[i] - accum_noise[reference]) / 30
3132  *
3133  * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
3134  * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
3135  * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
3136  * and set bit 2 to indicate "reduce gain".  The value for the reference
3137  * (weakest) chain should be "0".
3138  *
3139  * diff_gain_[abc] bit fields:
3140  *   2: (1) reduce gain, (0) increase gain
3141  * 1-0: amount of gain, units of 1.5 dB
3142  */
3143
3144 /* Phy calibration command for series */
3145 /* The default calibrate table size if not specified by firmware */
3146 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE     18
3147 enum {
3148         IWL_PHY_CALIBRATE_DIFF_GAIN_CMD         = 7,
3149         IWL_PHY_CALIBRATE_DC_CMD                = 8,
3150         IWL_PHY_CALIBRATE_LO_CMD                = 9,
3151         IWL_PHY_CALIBRATE_TX_IQ_CMD             = 11,
3152         IWL_PHY_CALIBRATE_CRYSTAL_FRQ_CMD       = 15,
3153         IWL_PHY_CALIBRATE_BASE_BAND_CMD         = 16,
3154         IWL_PHY_CALIBRATE_TX_IQ_PERD_CMD        = 17,
3155         IWL_PHY_CALIBRATE_TEMP_OFFSET_CMD       = 18,
3156         IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE = 19,
3157 };
3158
3159 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE          (253)
3160
3161 #define IWL_CALIB_INIT_CFG_ALL  cpu_to_le32(0xffffffff)
3162
3163 /* This enum defines the bitmap of various calibrations to enable in both
3164  * init ucode and runtime ucode through CALIBRATION_CFG_CMD.
3165  */
3166 enum iwl_ucode_calib_cfg {
3167         IWL_CALIB_CFG_RX_BB_IDX,
3168         IWL_CALIB_CFG_DC_IDX,
3169         IWL_CALIB_CFG_TX_IQ_IDX,
3170         IWL_CALIB_CFG_RX_IQ_IDX,
3171         IWL_CALIB_CFG_NOISE_IDX,
3172         IWL_CALIB_CFG_CRYSTAL_IDX,
3173         IWL_CALIB_CFG_TEMPERATURE_IDX,
3174         IWL_CALIB_CFG_PAPD_IDX,
3175 };
3176
3177
3178 struct iwl_calib_cfg_elmnt_s {
3179         __le32 is_enable;
3180         __le32 start;
3181         __le32 send_res;
3182         __le32 apply_res;
3183         __le32 reserved;
3184 } __packed;
3185
3186 struct iwl_calib_cfg_status_s {
3187         struct iwl_calib_cfg_elmnt_s once;
3188         struct iwl_calib_cfg_elmnt_s perd;
3189         __le32 flags;
3190 } __packed;
3191
3192 struct iwl_calib_cfg_cmd {
3193         struct iwl_calib_cfg_status_s ucd_calib_cfg;
3194         struct iwl_calib_cfg_status_s drv_calib_cfg;
3195         __le32 reserved1;
3196 } __packed;
3197
3198 struct iwl_calib_hdr {
3199         u8 op_code;
3200         u8 first_group;
3201         u8 groups_num;
3202         u8 data_valid;
3203 } __packed;
3204
3205 struct iwl_calib_cmd {
3206         struct iwl_calib_hdr hdr;
3207         u8 data[0];
3208 } __packed;
3209
3210 /* IWL_PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
3211 struct iwl_calib_diff_gain_cmd {
3212         struct iwl_calib_hdr hdr;
3213         s8 diff_gain_a;         /* see above */
3214         s8 diff_gain_b;
3215         s8 diff_gain_c;
3216         u8 reserved1;
3217 } __packed;
3218
3219 struct iwl_calib_xtal_freq_cmd {
3220         struct iwl_calib_hdr hdr;
3221         u8 cap_pin1;
3222         u8 cap_pin2;
3223         u8 pad[2];
3224 } __packed;
3225
3226 #define DEFAULT_RADIO_SENSOR_OFFSET    2700
3227 struct iwl_calib_temperature_offset_cmd {
3228         struct iwl_calib_hdr hdr;
3229         s16 radio_sensor_offset;
3230         s16 reserved;
3231 } __packed;
3232
3233 /* IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD */
3234 struct iwl_calib_chain_noise_reset_cmd {
3235         struct iwl_calib_hdr hdr;
3236         u8 data[0];
3237 };
3238
3239 /* IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD */
3240 struct iwl_calib_chain_noise_gain_cmd {
3241         struct iwl_calib_hdr hdr;
3242         u8 delta_gain_1;
3243         u8 delta_gain_2;
3244         u8 pad[2];
3245 } __packed;
3246
3247 /******************************************************************************
3248  * (12)
3249  * Miscellaneous Commands:
3250  *
3251  *****************************************************************************/
3252
3253 /*
3254  * LEDs Command & Response
3255  * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
3256  *
3257  * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
3258  * this command turns it on or off, or sets up a periodic blinking cycle.
3259  */
3260 struct iwl_led_cmd {
3261         __le32 interval;        /* "interval" in uSec */
3262         u8 id;                  /* 1: Activity, 2: Link, 3: Tech */
3263         u8 off;                 /* # intervals off while blinking;
3264                                  * "0", with >0 "on" value, turns LED on */
3265         u8 on;                  /* # intervals on while blinking;
3266                                  * "0", regardless of "off", turns LED off */
3267         u8 reserved;
3268 } __packed;
3269
3270 /*
3271  * station priority table entries
3272  * also used as potential "events" value for both
3273  * COEX_MEDIUM_NOTIFICATION and COEX_EVENT_CMD
3274  */
3275
3276 /*
3277  * COEX events entry flag masks
3278  * RP - Requested Priority
3279  * WP - Win Medium Priority: priority assigned when the contention has been won
3280  */
3281 #define COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG        (0x1)
3282 #define COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG        (0x2)
3283 #define COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG  (0x4)
3284
3285 #define COEX_CU_UNASSOC_IDLE_RP               4
3286 #define COEX_CU_UNASSOC_MANUAL_SCAN_RP        4
3287 #define COEX_CU_UNASSOC_AUTO_SCAN_RP          4
3288 #define COEX_CU_CALIBRATION_RP                4
3289 #define COEX_CU_PERIODIC_CALIBRATION_RP       4
3290 #define COEX_CU_CONNECTION_ESTAB_RP           4
3291 #define COEX_CU_ASSOCIATED_IDLE_RP            4
3292 #define COEX_CU_ASSOC_MANUAL_SCAN_RP          4
3293 #define COEX_CU_ASSOC_AUTO_SCAN_RP            4
3294 #define COEX_CU_ASSOC_ACTIVE_LEVEL_RP         4
3295 #define COEX_CU_RF_ON_RP                      6
3296 #define COEX_CU_RF_OFF_RP                     4
3297 #define COEX_CU_STAND_ALONE_DEBUG_RP          6
3298 #define COEX_CU_IPAN_ASSOC_LEVEL_RP           4
3299 #define COEX_CU_RSRVD1_RP                     4
3300 #define COEX_CU_RSRVD2_RP                     4
3301
3302 #define COEX_CU_UNASSOC_IDLE_WP               3
3303 #define COEX_CU_UNASSOC_MANUAL_SCAN_WP        3
3304 #define COEX_CU_UNASSOC_AUTO_SCAN_WP          3
3305 #define COEX_CU_CALIBRATION_WP                3
3306 #define COEX_CU_PERIODIC_CALIBRATION_WP       3
3307 #define COEX_CU_CONNECTION_ESTAB_WP           3
3308 #define COEX_CU_ASSOCIATED_IDLE_WP            3
3309 #define COEX_CU_ASSOC_MANUAL_SCAN_WP          3
3310 #define COEX_CU_ASSOC_AUTO_SCAN_WP            3
3311 #define COEX_CU_ASSOC_ACTIVE_LEVEL_WP         3
3312 #define COEX_CU_RF_ON_WP                      3
3313 #define COEX_CU_RF_OFF_WP                     3
3314 #define COEX_CU_STAND_ALONE_DEBUG_WP          6
3315 #define COEX_CU_IPAN_ASSOC_LEVEL_WP           3
3316 #define COEX_CU_RSRVD1_WP                     3
3317 #define COEX_CU_RSRVD2_WP                     3
3318
3319 #define COEX_UNASSOC_IDLE_FLAGS                     0
3320 #define COEX_UNASSOC_MANUAL_SCAN_FLAGS          \
3321         (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
3322         COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3323 #define COEX_UNASSOC_AUTO_SCAN_FLAGS            \
3324         (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
3325         COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3326 #define COEX_CALIBRATION_FLAGS                  \
3327         (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
3328         COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3329 #define COEX_PERIODIC_CALIBRATION_FLAGS             0
3330 /*
3331  * COEX_CONNECTION_ESTAB:
3332  * we need DELAY_MEDIUM_FREE_NTFY to let WiMAX disconnect from network.
3333  */
3334 #define COEX_CONNECTION_ESTAB_FLAGS             \
3335         (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
3336         COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG |    \
3337         COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
3338 #define COEX_ASSOCIATED_IDLE_FLAGS                  0
3339 #define COEX_ASSOC_MANUAL_SCAN_FLAGS            \
3340         (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
3341         COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3342 #define COEX_ASSOC_AUTO_SCAN_FLAGS              \
3343         (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
3344          COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3345 #define COEX_ASSOC_ACTIVE_LEVEL_FLAGS               0
3346 #define COEX_RF_ON_FLAGS                            0
3347 #define COEX_RF_OFF_FLAGS                           0
3348 #define COEX_STAND_ALONE_DEBUG_FLAGS            \
3349         (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
3350          COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
3351 #define COEX_IPAN_ASSOC_LEVEL_FLAGS             \
3352         (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
3353          COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG |   \
3354          COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
3355 #define COEX_RSRVD1_FLAGS                           0
3356 #define COEX_RSRVD2_FLAGS                           0
3357 /*
3358  * COEX_CU_RF_ON is the event wrapping all radio ownership.
3359  * We need DELAY_MEDIUM_FREE_NTFY to let WiMAX disconnect from network.
3360  */
3361 #define COEX_CU_RF_ON_FLAGS                     \
3362         (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG |   \
3363          COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG |   \
3364          COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
3365
3366
3367 enum {
3368         /* un-association part */
3369         COEX_UNASSOC_IDLE               = 0,
3370         COEX_UNASSOC_MANUAL_SCAN        = 1,
3371         COEX_UNASSOC_AUTO_SCAN          = 2,
3372         /* calibration */
3373         COEX_CALIBRATION                = 3,
3374         COEX_PERIODIC_CALIBRATION       = 4,
3375         /* connection */
3376         COEX_CONNECTION_ESTAB           = 5,
3377         /* association part */
3378         COEX_ASSOCIATED_IDLE            = 6,
3379         COEX_ASSOC_MANUAL_SCAN          = 7,
3380         COEX_ASSOC_AUTO_SCAN            = 8,
3381         COEX_ASSOC_ACTIVE_LEVEL         = 9,
3382         /* RF ON/OFF */
3383         COEX_RF_ON                      = 10,
3384         COEX_RF_OFF                     = 11,
3385         COEX_STAND_ALONE_DEBUG          = 12,
3386         /* IPAN */
3387         COEX_IPAN_ASSOC_LEVEL           = 13,
3388         /* reserved */
3389         COEX_RSRVD1                     = 14,
3390         COEX_RSRVD2                     = 15,
3391         COEX_NUM_OF_EVENTS              = 16
3392 };
3393
3394 /*
3395  * Coexistence WIFI/WIMAX  Command
3396  * COEX_PRIORITY_TABLE_CMD = 0x5a
3397  *
3398  */
3399 struct iwl_wimax_coex_event_entry {
3400         u8 request_prio;
3401         u8 win_medium_prio;
3402         u8 reserved;
3403         u8 flags;
3404 } __packed;
3405
3406 /* COEX flag masks */
3407
3408 /* Station table is valid */
3409 #define COEX_FLAGS_STA_TABLE_VALID_MSK      (0x1)
3410 /* UnMask wake up src at unassociated sleep */
3411 #define COEX_FLAGS_UNASSOC_WA_UNMASK_MSK    (0x4)
3412 /* UnMask wake up src at associated sleep */
3413 #define COEX_FLAGS_ASSOC_WA_UNMASK_MSK      (0x8)
3414 /* Enable CoEx feature. */
3415 #define COEX_FLAGS_COEX_ENABLE_MSK          (0x80)
3416
3417 struct iwl_wimax_coex_cmd {
3418         u8 flags;
3419         u8 reserved[3];
3420         struct iwl_wimax_coex_event_entry sta_prio[COEX_NUM_OF_EVENTS];
3421 } __packed;
3422
3423 /*
3424  * Coexistence MEDIUM NOTIFICATION
3425  * COEX_MEDIUM_NOTIFICATION = 0x5b
3426  *
3427  * notification from uCode to host to indicate medium changes
3428  *
3429  */
3430 /*
3431  * status field
3432  * bit 0 - 2: medium status
3433  * bit 3: medium change indication
3434  * bit 4 - 31: reserved
3435  */
3436 /* status option values, (0 - 2 bits) */
3437 #define COEX_MEDIUM_BUSY        (0x0) /* radio belongs to WiMAX */
3438 #define COEX_MEDIUM_ACTIVE      (0x1) /* radio belongs to WiFi */
3439 #define COEX_MEDIUM_PRE_RELEASE (0x2) /* received radio release */
3440 #define COEX_MEDIUM_MSK         (0x7)
3441
3442 /* send notification status (1 bit) */
3443 #define COEX_MEDIUM_CHANGED     (0x8)
3444 #define COEX_MEDIUM_CHANGED_MSK (0x8)
3445 #define COEX_MEDIUM_SHIFT       (3)
3446
3447 struct iwl_coex_medium_notification {
3448         __le32 status;
3449         __le32 events;
3450 } __packed;
3451
3452 /*
3453  * Coexistence EVENT  Command
3454  * COEX_EVENT_CMD = 0x5c
3455  *
3456  * send from host to uCode for coex event request.
3457  */
3458 /* flags options */
3459 #define COEX_EVENT_REQUEST_MSK  (0x1)
3460
3461 struct iwl_coex_event_cmd {
3462         u8 flags;
3463         u8 event;
3464         __le16 reserved;
3465 } __packed;
3466
3467 struct iwl_coex_event_resp {
3468         __le32 status;
3469 } __packed;
3470
3471
3472 /******************************************************************************
3473  * Bluetooth Coexistence commands
3474  *
3475  *****************************************************************************/
3476
3477 /*
3478  * BT Status notification
3479  * REPLY_BT_COEX_PROFILE_NOTIF = 0xce
3480  */
3481 enum iwl_bt_coex_profile_traffic_load {
3482         IWL_BT_COEX_TRAFFIC_LOAD_NONE =         0,
3483         IWL_BT_COEX_TRAFFIC_LOAD_LOW =          1,
3484         IWL_BT_COEX_TRAFFIC_LOAD_HIGH =         2,
3485         IWL_BT_COEX_TRAFFIC_LOAD_CONTINUOUS =   3,
3486 /*
3487  * There are no more even though below is a u8, the
3488  * indication from the BT device only has two bits.
3489  */
3490 };
3491
3492 #define BT_SESSION_ACTIVITY_1_UART_MSG          0x1
3493 #define BT_SESSION_ACTIVITY_2_UART_MSG          0x2
3494
3495 /* BT UART message - Share Part (BT -> WiFi) */
3496 #define BT_UART_MSG_FRAME1MSGTYPE_POS           (0)
3497 #define BT_UART_MSG_FRAME1MSGTYPE_MSK           \
3498                 (0x7 << BT_UART_MSG_FRAME1MSGTYPE_POS)
3499 #define BT_UART_MSG_FRAME1SSN_POS               (3)
3500 #define BT_UART_MSG_FRAME1SSN_MSK               \
3501                 (0x3 << BT_UART_MSG_FRAME1SSN_POS)
3502 #define BT_UART_MSG_FRAME1UPDATEREQ_POS         (5)
3503 #define BT_UART_MSG_FRAME1UPDATEREQ_MSK         \
3504                 (0x1 << BT_UART_MSG_FRAME1UPDATEREQ_POS)
3505 #define BT_UART_MSG_FRAME1RESERVED_POS          (6)
3506 #define BT_UART_MSG_FRAME1RESERVED_MSK          \
3507                 (0x3 << BT_UART_MSG_FRAME1RESERVED_POS)
3508
3509 #define BT_UART_MSG_FRAME2OPENCONNECTIONS_POS   (0)
3510 #define BT_UART_MSG_FRAME2OPENCONNECTIONS_MSK   \
3511                 (0x3 << BT_UART_MSG_FRAME2OPENCONNECTIONS_POS)
3512 #define BT_UART_MSG_FRAME2TRAFFICLOAD_POS       (2)
3513 #define BT_UART_MSG_FRAME2TRAFFICLOAD_MSK       \
3514                 (0x3 << BT_UART_MSG_FRAME2TRAFFICLOAD_POS)
3515 #define BT_UART_MSG_FRAME2CHLSEQN_POS           (4)
3516 #define BT_UART_MSG_FRAME2CHLSEQN_MSK           \
3517                 (0x1 << BT_UART_MSG_FRAME2CHLSEQN_POS)
3518 #define BT_UART_MSG_FRAME2INBAND_POS            (5)
3519 #define BT_UART_MSG_FRAME2INBAND_MSK            \
3520                 (0x1 << BT_UART_MSG_FRAME2INBAND_POS)
3521 #define BT_UART_MSG_FRAME2RESERVED_POS          (6)
3522 #define BT_UART_MSG_FRAME2RESERVED_MSK          \
3523                 (0x3 << BT_UART_MSG_FRAME2RESERVED_POS)
3524
3525 #define BT_UART_MSG_FRAME3SCOESCO_POS           (0)
3526 #define BT_UART_MSG_FRAME3SCOESCO_MSK           \
3527                 (0x1 << BT_UART_MSG_FRAME3SCOESCO_POS)
3528 #define BT_UART_MSG_FRAME3SNIFF_POS             (1)
3529 #define BT_UART_MSG_FRAME3SNIFF_MSK             \
3530                 (0x1 << BT_UART_MSG_FRAME3SNIFF_POS)
3531 #define BT_UART_MSG_FRAME3A2DP_POS              (2)
3532 #define BT_UART_MSG_FRAME3A2DP_MSK              \
3533                 (0x1 << BT_UART_MSG_FRAME3A2DP_POS)
3534 #define BT_UART_MSG_FRAME3ACL_POS               (3)
3535 #define BT_UART_MSG_FRAME3ACL_MSK               \
3536                 (0x1 << BT_UART_MSG_FRAME3ACL_POS)
3537 #define BT_UART_MSG_FRAME3MASTER_POS            (4)
3538 #define BT_UART_MSG_FRAME3MASTER_MSK            \
3539                 (0x1 << BT_UART_MSG_FRAME3MASTER_POS)
3540 #define BT_UART_MSG_FRAME3OBEX_POS              (5)
3541 #define BT_UART_MSG_FRAME3OBEX_MSK              \
3542                 (0x1 << BT_UART_MSG_FRAME3OBEX_POS)
3543 #define BT_UART_MSG_FRAME3RESERVED_POS          (6)
3544 #define BT_UART_MSG_FRAME3RESERVED_MSK          \
3545                 (0x3 << BT_UART_MSG_FRAME3RESERVED_POS)
3546
3547 #define BT_UART_MSG_FRAME4IDLEDURATION_POS      (0)
3548 #define BT_UART_MSG_FRAME4IDLEDURATION_MSK      \
3549                 (0x3F << BT_UART_MSG_FRAME4IDLEDURATION_POS)
3550 #define BT_UART_MSG_FRAME4RESERVED_POS          (6)
3551 #define BT_UART_MSG_FRAME4RESERVED_MSK          \
3552                 (0x3 << BT_UART_MSG_FRAME4RESERVED_POS)
3553
3554 #define BT_UART_MSG_FRAME5TXACTIVITY_POS        (0)
3555 #define BT_UART_MSG_FRAME5TXACTIVITY_MSK        \
3556                 (0x3 << BT_UART_MSG_FRAME5TXACTIVITY_POS)
3557 #define BT_UART_MSG_FRAME5RXACTIVITY_POS        (2)
3558 #define BT_UART_MSG_FRAME5RXACTIVITY_MSK        \
3559                 (0x3 << BT_UART_MSG_FRAME5RXACTIVITY_POS)
3560 #define BT_UART_MSG_FRAME5ESCORETRANSMIT_POS    (4)
3561 #define BT_UART_MSG_FRAME5ESCORETRANSMIT_MSK    \
3562                 (0x3 << BT_UART_MSG_FRAME5ESCORETRANSMIT_POS)
3563 #define BT_UART_MSG_FRAME5RESERVED_POS          (6)
3564 #define BT_UART_MSG_FRAME5RESERVED_MSK          \
3565                 (0x3 << BT_UART_MSG_FRAME5RESERVED_POS)
3566
3567 #define BT_UART_MSG_FRAME6SNIFFINTERVAL_POS     (0)
3568 #define BT_UART_MSG_FRAME6SNIFFINTERVAL_MSK     \
3569                 (0x1F << BT_UART_MSG_FRAME6SNIFFINTERVAL_POS)
3570 #define BT_UART_MSG_FRAME6DISCOVERABLE_POS      (5)
3571 #define BT_UART_MSG_FRAME6DISCOVERABLE_MSK      \
3572                 (0x1 << BT_UART_MSG_FRAME6DISCOVERABLE_POS)
3573 #define BT_UART_MSG_FRAME6RESERVED_POS          (6)
3574 #define BT_UART_MSG_FRAME6RESERVED_MSK          \
3575                 (0x3 << BT_UART_MSG_FRAME6RESERVED_POS)
3576
3577 #define BT_UART_MSG_FRAME7SNIFFACTIVITY_POS     (0)
3578 #define BT_UART_MSG_FRAME7SNIFFACTIVITY_MSK     \
3579                 (0x7 << BT_UART_MSG_FRAME7SNIFFACTIVITY_POS)
3580 #define BT_UART_MSG_FRAME7PAGE_POS              (3)
3581 #define BT_UART_MSG_FRAME7PAGE_MSK              \
3582                 (0x1 << BT_UART_MSG_FRAME7PAGE_POS)
3583 #define BT_UART_MSG_FRAME7INQUIRY_POS           (4)
3584 #define BT_UART_MSG_FRAME7INQUIRY_MSK           \
3585                 (0x1 << BT_UART_MSG_FRAME7INQUIRY_POS)
3586 #define BT_UART_MSG_FRAME7CONNECTABLE_POS       (5)
3587 #define BT_UART_MSG_FRAME7CONNECTABLE_MSK       \
3588                 (0x1 << BT_UART_MSG_FRAME7CONNECTABLE_POS)
3589 #define BT_UART_MSG_FRAME7RESERVED_POS          (6)
3590 #define BT_UART_MSG_FRAME7RESERVED_MSK          \
3591                 (0x3 << BT_UART_MSG_FRAME7RESERVED_POS)
3592
3593 /* BT Session Activity 2 UART message (BT -> WiFi) */
3594 #define BT_UART_MSG_2_FRAME1RESERVED1_POS       (5)
3595 #define BT_UART_MSG_2_FRAME1RESERVED1_MSK       \
3596                 (0x1<<BT_UART_MSG_2_FRAME1RESERVED1_POS)
3597 #define BT_UART_MSG_2_FRAME1RESERVED2_POS       (6)
3598 #define BT_UART_MSG_2_FRAME1RESERVED2_MSK       \
3599                 (0x3<<BT_UART_MSG_2_FRAME1RESERVED2_POS)
3600
3601 #define BT_UART_MSG_2_FRAME2AGGTRAFFICLOAD_POS  (0)
3602 #define BT_UART_MSG_2_FRAME2AGGTRAFFICLOAD_MSK  \
3603                 (0x3F<<BT_UART_MSG_2_FRAME2AGGTRAFFICLOAD_POS)
3604 #define BT_UART_MSG_2_FRAME2RESERVED_POS        (6)
3605 #define BT_UART_MSG_2_FRAME2RESERVED_MSK        \
3606                 (0x3<<BT_UART_MSG_2_FRAME2RESERVED_POS)
3607
3608 #define BT_UART_MSG_2_FRAME3BRLASTTXPOWER_POS   (0)
3609 #define BT_UART_MSG_2_FRAME3BRLASTTXPOWER_MSK   \
3610                 (0xF<<BT_UART_MSG_2_FRAME3BRLASTTXPOWER_POS)
3611 #define BT_UART_MSG_2_FRAME3INQPAGESRMODE_POS   (4)
3612 #define BT_UART_MSG_2_FRAME3INQPAGESRMODE_MSK   \
3613                 (0x1<<BT_UART_MSG_2_FRAME3INQPAGESRMODE_POS)
3614 #define BT_UART_MSG_2_FRAME3LEMASTER_POS        (5)
3615 #define BT_UART_MSG_2_FRAME3LEMASTER_MSK        \
3616                 (0x1<<BT_UART_MSG_2_FRAME3LEMASTER_POS)
3617 #define BT_UART_MSG_2_FRAME3RESERVED_POS        (6)
3618 #define BT_UART_MSG_2_FRAME3RESERVED_MSK        \
3619                 (0x3<<BT_UART_MSG_2_FRAME3RESERVED_POS)
3620
3621 #define BT_UART_MSG_2_FRAME4LELASTTXPOWER_POS   (0)
3622 #define BT_UART_MSG_2_FRAME4LELASTTXPOWER_MSK   \
3623                 (0xF<<BT_UART_MSG_2_FRAME4LELASTTXPOWER_POS)
3624 #define BT_UART_MSG_2_FRAME4NUMLECONN_POS       (4)
3625 #define BT_UART_MSG_2_FRAME4NUMLECONN_MSK       \
3626                 (0x3<<BT_UART_MSG_2_FRAME4NUMLECONN_POS)
3627 #define BT_UART_MSG_2_FRAME4RESERVED_POS        (6)
3628 #define BT_UART_MSG_2_FRAME4RESERVED_MSK        \
3629                 (0x3<<BT_UART_MSG_2_FRAME4RESERVED_POS)
3630
3631 #define BT_UART_MSG_2_FRAME5BTMINRSSI_POS       (0)
3632 #define BT_UART_MSG_2_FRAME5BTMINRSSI_MSK       \
3633                 (0xF<<BT_UART_MSG_2_FRAME5BTMINRSSI_POS)
3634 #define BT_UART_MSG_2_FRAME5LESCANINITMODE_POS  (4)
3635 #define BT_UART_MSG_2_FRAME5LESCANINITMODE_MSK  \
3636                 (0x1<<BT_UART_MSG_2_FRAME5LESCANINITMODE_POS)
3637 #define BT_UART_MSG_2_FRAME5LEADVERMODE_POS     (5)
3638 #define BT_UART_MSG_2_FRAME5LEADVERMODE_MSK     \
3639                 (0x1<<BT_UART_MSG_2_FRAME5LEADVERMODE_POS)
3640 #define BT_UART_MSG_2_FRAME5RESERVED_POS        (6)
3641 #define BT_UART_MSG_2_FRAME5RESERVED_MSK        \
3642                 (0x3<<BT_UART_MSG_2_FRAME5RESERVED_POS)
3643
3644 #define BT_UART_MSG_2_FRAME6LECONNINTERVAL_POS  (0)
3645 #define BT_UART_MSG_2_FRAME6LECONNINTERVAL_MSK  \
3646                 (0x1F<<BT_UART_MSG_2_FRAME6LECONNINTERVAL_POS)
3647 #define BT_UART_MSG_2_FRAME6RFU_POS             (5)
3648 #define BT_UART_MSG_2_FRAME6RFU_MSK             \
3649                 (0x1<<BT_UART_MSG_2_FRAME6RFU_POS)
3650 #define BT_UART_MSG_2_FRAME6RESERVED_POS        (6)
3651 #define BT_UART_MSG_2_FRAME6RESERVED_MSK        \
3652                 (0x3<<BT_UART_MSG_2_FRAME6RESERVED_POS)
3653
3654 #define BT_UART_MSG_2_FRAME7LECONNSLAVELAT_POS  (0)
3655 #define BT_UART_MSG_2_FRAME7LECONNSLAVELAT_MSK  \
3656                 (0x7<<BT_UART_MSG_2_FRAME7LECONNSLAVELAT_POS)
3657 #define BT_UART_MSG_2_FRAME7LEPROFILE1_POS      (3)
3658 #define BT_UART_MSG_2_FRAME7LEPROFILE1_MSK      \
3659                 (0x1<<BT_UART_MSG_2_FRAME7LEPROFILE1_POS)
3660 #define BT_UART_MSG_2_FRAME7LEPROFILE2_POS      (4)
3661 #define BT_UART_MSG_2_FRAME7LEPROFILE2_MSK      \
3662                 (0x1<<BT_UART_MSG_2_FRAME7LEPROFILE2_POS)
3663 #define BT_UART_MSG_2_FRAME7LEPROFILEOTHER_POS  (5)
3664 #define BT_UART_MSG_2_FRAME7LEPROFILEOTHER_MSK  \
3665                 (0x1<<BT_UART_MSG_2_FRAME7LEPROFILEOTHER_POS)
3666 #define BT_UART_MSG_2_FRAME7RESERVED_POS        (6)
3667 #define BT_UART_MSG_2_FRAME7RESERVED_MSK        \
3668                 (0x3<<BT_UART_MSG_2_FRAME7RESERVED_POS)
3669
3670
3671 struct iwl_bt_uart_msg {
3672         u8 header;
3673         u8 frame1;
3674         u8 frame2;
3675         u8 frame3;
3676         u8 frame4;
3677         u8 frame5;
3678         u8 frame6;
3679         u8 frame7;
3680 } __attribute__((packed));
3681
3682 struct iwl_bt_coex_profile_notif {
3683         struct iwl_bt_uart_msg last_bt_uart_msg;
3684         u8 bt_status; /* 0 - off, 1 - on */
3685         u8 bt_traffic_load; /* 0 .. 3? */
3686         u8 bt_ci_compliance; /* 0 - not complied, 1 - complied */
3687         u8 reserved;
3688 } __attribute__((packed));
3689
3690 #define IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_POS 0
3691 #define IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_MSK 0x1
3692 #define IWL_BT_COEX_PRIO_TBL_PRIO_POS           1
3693 #define IWL_BT_COEX_PRIO_TBL_PRIO_MASK          0x0e
3694 #define IWL_BT_COEX_PRIO_TBL_RESERVED_POS       4
3695 #define IWL_BT_COEX_PRIO_TBL_RESERVED_MASK      0xf0
3696 #define IWL_BT_COEX_PRIO_TBL_PRIO_SHIFT         1
3697
3698 /*
3699  * BT Coexistence Priority table
3700  * REPLY_BT_COEX_PRIO_TABLE = 0xcc
3701  */
3702 enum bt_coex_prio_table_events {
3703         BT_COEX_PRIO_TBL_EVT_INIT_CALIB1 = 0,
3704         BT_COEX_PRIO_TBL_EVT_INIT_CALIB2 = 1,
3705         BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_LOW1 = 2,
3706         BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_LOW2 = 3, /* DC calib */
3707         BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_HIGH1 = 4,
3708         BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_HIGH2 = 5,
3709         BT_COEX_PRIO_TBL_EVT_DTIM = 6,
3710         BT_COEX_PRIO_TBL_EVT_SCAN52 = 7,
3711         BT_COEX_PRIO_TBL_EVT_SCAN24 = 8,
3712         BT_COEX_PRIO_TBL_EVT_RESERVED0 = 9,
3713         BT_COEX_PRIO_TBL_EVT_RESERVED1 = 10,
3714         BT_COEX_PRIO_TBL_EVT_RESERVED2 = 11,
3715         BT_COEX_PRIO_TBL_EVT_RESERVED3 = 12,
3716         BT_COEX_PRIO_TBL_EVT_RESERVED4 = 13,
3717         BT_COEX_PRIO_TBL_EVT_RESERVED5 = 14,
3718         BT_COEX_PRIO_TBL_EVT_RESERVED6 = 15,
3719         /* BT_COEX_PRIO_TBL_EVT_MAX should always be last */
3720         BT_COEX_PRIO_TBL_EVT_MAX,
3721 };
3722
3723 enum bt_coex_prio_table_priorities {
3724         BT_COEX_PRIO_TBL_DISABLED = 0,
3725         BT_COEX_PRIO_TBL_PRIO_LOW = 1,
3726         BT_COEX_PRIO_TBL_PRIO_HIGH = 2,
3727         BT_COEX_PRIO_TBL_PRIO_BYPASS = 3,
3728         BT_COEX_PRIO_TBL_PRIO_COEX_OFF = 4,
3729         BT_COEX_PRIO_TBL_PRIO_COEX_ON = 5,
3730         BT_COEX_PRIO_TBL_PRIO_RSRVD1 = 6,
3731         BT_COEX_PRIO_TBL_PRIO_RSRVD2 = 7,
3732         BT_COEX_PRIO_TBL_MAX,
3733 };
3734
3735 struct iwl_bt_coex_prio_table_cmd {
3736         u8 prio_tbl[BT_COEX_PRIO_TBL_EVT_MAX];
3737 } __attribute__((packed));
3738
3739 #define IWL_BT_COEX_ENV_CLOSE   0
3740 #define IWL_BT_COEX_ENV_OPEN    1
3741 /*
3742  * BT Protection Envelope
3743  * REPLY_BT_COEX_PROT_ENV = 0xcd
3744  */
3745 struct iwl_bt_coex_prot_env_cmd {
3746         u8 action; /* 0 = closed, 1 = open */
3747         u8 type; /* 0 .. 15 */
3748         u8 reserved[2];
3749 } __attribute__((packed));
3750
3751 /******************************************************************************
3752  * (13)
3753  * Union of all expected notifications/responses:
3754  *
3755  *****************************************************************************/
3756
3757 struct iwl_rx_packet {
3758         /*
3759          * The first 4 bytes of the RX frame header contain both the RX frame
3760          * size and some flags.
3761          * Bit fields:
3762          * 31:    flag flush RB request
3763          * 30:    flag ignore TC (terminal counter) request
3764          * 29:    flag fast IRQ request
3765          * 28-14: Reserved
3766          * 13-00: RX frame size
3767          */
3768         __le32 len_n_flags;
3769         struct iwl_cmd_header hdr;
3770         union {
3771                 struct iwl_alive_resp alive_frame;
3772                 struct iwl_spectrum_notification spectrum_notif;
3773                 struct iwl_csa_notification csa_notif;
3774                 struct iwl_error_resp err_resp;
3775                 struct iwl_card_state_notif card_state_notif;
3776                 struct iwl_add_sta_resp add_sta;
3777                 struct iwl_rem_sta_resp rem_sta;
3778                 struct iwl_sleep_notification sleep_notif;
3779                 struct iwl_spectrum_resp spectrum;
3780                 struct iwl_notif_statistics stats;
3781                 struct iwl_bt_notif_statistics stats_bt;
3782                 struct iwl_compressed_ba_resp compressed_ba;
3783                 struct iwl_missed_beacon_notif missed_beacon;
3784                 struct iwl_coex_medium_notification coex_medium_notif;
3785                 struct iwl_coex_event_resp coex_event;
3786                 struct iwl_bt_coex_profile_notif bt_coex_profile_notif;
3787                 __le32 status;
3788                 u8 raw[0];
3789         } u;
3790 } __packed;
3791
3792 int iwl_agn_check_rxon_cmd(struct iwl_priv *priv);
3793
3794 /*
3795  * REPLY_WIPAN_PARAMS = 0xb2 (Commands and Notification)
3796  */
3797
3798 /*
3799  * Minimum slot time in TU
3800  */
3801 #define IWL_MIN_SLOT_TIME       20
3802
3803 /**
3804  * struct iwl_wipan_slot
3805  * @width: Time in TU
3806  * @type:
3807  *   0 - BSS
3808  *   1 - PAN
3809  */
3810 struct iwl_wipan_slot {
3811         __le16 width;
3812         u8 type;
3813         u8 reserved;
3814 } __packed;
3815
3816 #define IWL_WIPAN_PARAMS_FLG_LEAVE_CHANNEL_CTS          BIT(1)  /* reserved */
3817 #define IWL_WIPAN_PARAMS_FLG_LEAVE_CHANNEL_QUIET        BIT(2)  /* reserved */
3818 #define IWL_WIPAN_PARAMS_FLG_SLOTTED_MODE               BIT(3)  /* reserved */
3819 #define IWL_WIPAN_PARAMS_FLG_FILTER_BEACON_NOTIF        BIT(4)
3820 #define IWL_WIPAN_PARAMS_FLG_FULL_SLOTTED_MODE          BIT(5)
3821
3822 /**
3823  * struct iwl_wipan_params_cmd
3824  * @flags:
3825  *   bit0: reserved
3826  *   bit1: CP leave channel with CTS
3827  *   bit2: CP leave channel qith Quiet
3828  *   bit3: slotted mode
3829  *     1 - work in slotted mode
3830  *     0 - work in non slotted mode
3831  *   bit4: filter beacon notification
3832  *   bit5: full tx slotted mode. if this flag is set,
3833  *         uCode will perform leaving channel methods in context switch
3834  *         also when working in same channel mode
3835  * @num_slots: 1 - 10
3836  */
3837 struct iwl_wipan_params_cmd {
3838         __le16 flags;
3839         u8 reserved;
3840         u8 num_slots;
3841         struct iwl_wipan_slot slots[10];
3842 } __packed;
3843
3844 /*
3845  * REPLY_WIPAN_P2P_CHANNEL_SWITCH = 0xb9
3846  *
3847  * TODO: Figure out what this is used for,
3848  *       it can only switch between 2.4 GHz
3849  *       channels!!
3850  */
3851
3852 struct iwl_wipan_p2p_channel_switch_cmd {
3853         __le16 channel;
3854         __le16 reserved;
3855 };
3856
3857 /*
3858  * REPLY_WIPAN_NOA_NOTIFICATION = 0xbc
3859  *
3860  * This is used by the device to notify us of the
3861  * NoA schedule it determined so we can forward it
3862  * to userspace for inclusion in probe responses.
3863  *
3864  * In beacons, the NoA schedule is simply appended
3865  * to the frame we give the device.
3866  */
3867
3868 struct iwl_wipan_noa_descriptor {
3869         u8 count;
3870         __le32 duration;
3871         __le32 interval;
3872         __le32 starttime;
3873 } __packed;
3874
3875 struct iwl_wipan_noa_attribute {
3876         u8 id;
3877         __le16 length;
3878         u8 index;
3879         u8 ct_window;
3880         struct iwl_wipan_noa_descriptor descr0, descr1;
3881         u8 reserved;
3882 } __packed;
3883
3884 struct iwl_wipan_noa_notification {
3885         u32 noa_active;
3886         struct iwl_wipan_noa_attribute noa_attribute;
3887 } __packed;
3888
3889 #endif                          /* __iwl_commands_h__ */