drivers/net/wireless/iwlwifi/mvm/fw-api.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) 2012 - 2014 Intel Corporation. All rights reserved.
   9  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of version 2 of the GNU General Public License as
  13  * published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  23  * USA
  24  *
  25  * The full GNU General Public License is included in this distribution
  26  * in the file called COPYING.
  27  *
  28  * Contact Information:
  29  *  Intel Linux Wireless <ilw@linux.intel.com>
  30  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  31  *
  32  * BSD LICENSE
  33  *
  34  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
  35  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
  36  * All rights reserved.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  *
  42  *  * Redistributions of source code must retain the above copyright
  43  *    notice, this list of conditions and the following disclaimer.
  44  *  * Redistributions in binary form must reproduce the above copyright
  45  *    notice, this list of conditions and the following disclaimer in
  46  *    the documentation and/or other materials provided with the
  47  *    distribution.
  48  *  * Neither the name Intel Corporation nor the names of its
  49  *    contributors may be used to endorse or promote products derived
  50  *    from this software without specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  53  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  54  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  55  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  56  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  57  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  58  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  59  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  60  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  61  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  62  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  63  *
  64  *****************************************************************************/
  65
  66 #ifndef __fw_api_h__
  67 #define __fw_api_h__
  68
  69 #include "fw-api-rs.h"
  70 #include "fw-api-tx.h"
  71 #include "fw-api-sta.h"
  72 #include "fw-api-mac.h"
  73 #include "fw-api-power.h"
  74 #include "fw-api-d3.h"
  75 #include "fw-api-coex.h"
  76 #include "fw-api-scan.h"
  77
  78 /* Tx queue numbers */
  79 enum {
  80         IWL_MVM_OFFCHANNEL_QUEUE = 8,
  81         IWL_MVM_CMD_QUEUE = 9,
  82 };
  83
  84 enum iwl_mvm_tx_fifo {
  85         IWL_MVM_TX_FIFO_BK = 0,
  86         IWL_MVM_TX_FIFO_BE,
  87         IWL_MVM_TX_FIFO_VI,
  88         IWL_MVM_TX_FIFO_VO,
  89         IWL_MVM_TX_FIFO_MCAST = 5,
  90         IWL_MVM_TX_FIFO_CMD = 7,
  91 };
  92
  93 #define IWL_MVM_STATION_COUNT   16
  94
  95 #define IWL_MVM_TDLS_STA_COUNT  4
  96
  97 /* commands */
  98 enum {
  99         MVM_ALIVE = 0x1,
 100         REPLY_ERROR = 0x2,
 101
 102         INIT_COMPLETE_NOTIF = 0x4,
 103
 104         /* PHY context commands */
 105         PHY_CONTEXT_CMD = 0x8,
 106         DBG_CFG = 0x9,
 107         ANTENNA_COUPLING_NOTIFICATION = 0xa,
 108
 109         /* UMAC scan commands */
 110         SCAN_CFG_CMD = 0xc,
 111         SCAN_REQ_UMAC = 0xd,
 112         SCAN_ABORT_UMAC = 0xe,
 113         SCAN_COMPLETE_UMAC = 0xf,
 114
 115         /* station table */
 116         ADD_STA_KEY = 0x17,
 117         ADD_STA = 0x18,
 118         REMOVE_STA = 0x19,
 119
 120         /* TX */
 121         TX_CMD = 0x1c,
 122         TXPATH_FLUSH = 0x1e,
 123         MGMT_MCAST_KEY = 0x1f,
 124
 125         /* scheduler config */
 126         SCD_QUEUE_CFG = 0x1d,
 127
 128         /* global key */
 129         WEP_KEY = 0x20,
 130
 131         /* TDLS */
 132         TDLS_CHANNEL_SWITCH_CMD = 0x27,
 133         TDLS_CHANNEL_SWITCH_NOTIFICATION = 0xaa,
 134         TDLS_CONFIG_CMD = 0xa7,
 135
 136         /* MAC and Binding commands */
 137         MAC_CONTEXT_CMD = 0x28,
 138         TIME_EVENT_CMD = 0x29, /* both CMD and response */
 139         TIME_EVENT_NOTIFICATION = 0x2a,
 140         BINDING_CONTEXT_CMD = 0x2b,
 141         TIME_QUOTA_CMD = 0x2c,
 142         NON_QOS_TX_COUNTER_CMD = 0x2d,
 143
 144         LQ_CMD = 0x4e,
 145
 146         /* Calibration */
 147         TEMPERATURE_NOTIFICATION = 0x62,
 148         CALIBRATION_CFG_CMD = 0x65,
 149         CALIBRATION_RES_NOTIFICATION = 0x66,
 150         CALIBRATION_COMPLETE_NOTIFICATION = 0x67,
 151         RADIO_VERSION_NOTIFICATION = 0x68,
 152
 153         /* Scan offload */
 154         SCAN_OFFLOAD_REQUEST_CMD = 0x51,
 155         SCAN_OFFLOAD_ABORT_CMD = 0x52,
 156         HOT_SPOT_CMD = 0x53,
 157         SCAN_OFFLOAD_COMPLETE = 0x6D,
 158         SCAN_OFFLOAD_UPDATE_PROFILES_CMD = 0x6E,
 159         SCAN_OFFLOAD_CONFIG_CMD = 0x6f,
 160         MATCH_FOUND_NOTIFICATION = 0xd9,
 161         SCAN_ITERATION_COMPLETE = 0xe7,
 162
 163         /* Phy */
 164         PHY_CONFIGURATION_CMD = 0x6a,
 165         CALIB_RES_NOTIF_PHY_DB = 0x6b,
 166         /* PHY_DB_CMD = 0x6c, */
 167
 168         /* Power - legacy power table command */
 169         POWER_TABLE_CMD = 0x77,
 170         PSM_UAPSD_AP_MISBEHAVING_NOTIFICATION = 0x78,
 171         LTR_CONFIG = 0xee,
 172
 173         /* Thermal Throttling*/
 174         REPLY_THERMAL_MNG_BACKOFF = 0x7e,
 175
 176         /* Scanning */
 177         SCAN_REQUEST_CMD = 0x80,
 178         SCAN_ABORT_CMD = 0x81,
 179         SCAN_START_NOTIFICATION = 0x82,
 180         SCAN_RESULTS_NOTIFICATION = 0x83,
 181         SCAN_COMPLETE_NOTIFICATION = 0x84,
 182
 183         /* NVM */
 184         NVM_ACCESS_CMD = 0x88,
 185
 186         SET_CALIB_DEFAULT_CMD = 0x8e,
 187
 188         BEACON_NOTIFICATION = 0x90,
 189         BEACON_TEMPLATE_CMD = 0x91,
 190         TX_ANT_CONFIGURATION_CMD = 0x98,
 191         STATISTICS_NOTIFICATION = 0x9d,
 192         EOSP_NOTIFICATION = 0x9e,
 193         REDUCE_TX_POWER_CMD = 0x9f,
 194
 195         /* RF-KILL commands and notifications */
 196         CARD_STATE_CMD = 0xa0,
 197         CARD_STATE_NOTIFICATION = 0xa1,
 198
 199         MISSED_BEACONS_NOTIFICATION = 0xa2,
 200
 201         /* Power - new power table command */
 202         MAC_PM_POWER_TABLE = 0xa9,
 203
 204         MFUART_LOAD_NOTIFICATION = 0xb1,
 205
 206         REPLY_RX_PHY_CMD = 0xc0,
 207         REPLY_RX_MPDU_CMD = 0xc1,
 208         BA_NOTIF = 0xc5,
 209
 210         MARKER_CMD = 0xcb,
 211
 212         /* BT Coex */
 213         BT_COEX_PRIO_TABLE = 0xcc,
 214         BT_COEX_PROT_ENV = 0xcd,
 215         BT_PROFILE_NOTIFICATION = 0xce,
 216         BT_CONFIG = 0x9b,
 217         BT_COEX_UPDATE_SW_BOOST = 0x5a,
 218         BT_COEX_UPDATE_CORUN_LUT = 0x5b,
 219         BT_COEX_UPDATE_REDUCED_TXP = 0x5c,
 220         BT_COEX_CI = 0x5d,
 221
 222         REPLY_SF_CFG_CMD = 0xd1,
 223         REPLY_BEACON_FILTERING_CMD = 0xd2,
 224
 225         /* DTS measurements */
 226         CMD_DTS_MEASUREMENT_TRIGGER = 0xdc,
 227         DTS_MEASUREMENT_NOTIFICATION = 0xdd,
 228
 229         REPLY_DEBUG_CMD = 0xf0,
 230         DEBUG_LOG_MSG = 0xf7,
 231
 232         BCAST_FILTER_CMD = 0xcf,
 233         MCAST_FILTER_CMD = 0xd0,
 234
 235         /* D3 commands/notifications */
 236         D3_CONFIG_CMD = 0xd3,
 237         PROT_OFFLOAD_CONFIG_CMD = 0xd4,
 238         OFFLOADS_QUERY_CMD = 0xd5,
 239         REMOTE_WAKE_CONFIG_CMD = 0xd6,
 240         D0I3_END_CMD = 0xed,
 241
 242         /* for WoWLAN in particular */
 243         WOWLAN_PATTERNS = 0xe0,
 244         WOWLAN_CONFIGURATION = 0xe1,
 245         WOWLAN_TSC_RSC_PARAM = 0xe2,
 246         WOWLAN_TKIP_PARAM = 0xe3,
 247         WOWLAN_KEK_KCK_MATERIAL = 0xe4,
 248         WOWLAN_GET_STATUSES = 0xe5,
 249         WOWLAN_TX_POWER_PER_DB = 0xe6,
 250
 251         /* and for NetDetect */
 252         SCAN_OFFLOAD_PROFILES_QUERY_CMD = 0x56,
 253         SCAN_OFFLOAD_HOTSPOTS_CONFIG_CMD = 0x58,
 254         SCAN_OFFLOAD_HOTSPOTS_QUERY_CMD = 0x59,
 255
 256         REPLY_MAX = 0xff,
 257 };
 258
 259 /**
 260  * struct iwl_cmd_response - generic response struct for most commands
 261  * @status: status of the command asked, changes for each one
 262  */
 263 struct iwl_cmd_response {
 264         __le32 status;
 265 };
 266
 267 /*
 268  * struct iwl_tx_ant_cfg_cmd
 269  * @valid: valid antenna configuration
 270  */
 271 struct iwl_tx_ant_cfg_cmd {
 272         __le32 valid;
 273 } __packed;
 274
 275 /**
 276  * struct iwl_reduce_tx_power_cmd - TX power reduction command
 277  * REDUCE_TX_POWER_CMD = 0x9f
 278  * @flags: (reserved for future implementation)
 279  * @mac_context_id: id of the mac ctx for which we are reducing TX power.
 280  * @pwr_restriction: TX power restriction in dBms.
 281  */
 282 struct iwl_reduce_tx_power_cmd {
 283         u8 flags;
 284         u8 mac_context_id;
 285         __le16 pwr_restriction;
 286 } __packed; /* TX_REDUCED_POWER_API_S_VER_1 */
 287
 288 /*
 289  * Calibration control struct.
 290  * Sent as part of the phy configuration command.
 291  * @flow_trigger: bitmap for which calibrations to perform according to
 292  *              flow triggers.
 293  * @event_trigger: bitmap for which calibrations to perform according to
 294  *              event triggers.
 295  */
 296 struct iwl_calib_ctrl {
 297         __le32 flow_trigger;
 298         __le32 event_trigger;
 299 } __packed;
 300
 301 /* This enum defines the bitmap of various calibrations to enable in both
 302  * init ucode and runtime ucode through CALIBRATION_CFG_CMD.
 303  */
 304 enum iwl_calib_cfg {
 305         IWL_CALIB_CFG_XTAL_IDX                  = BIT(0),
 306         IWL_CALIB_CFG_TEMPERATURE_IDX           = BIT(1),
 307         IWL_CALIB_CFG_VOLTAGE_READ_IDX          = BIT(2),
 308         IWL_CALIB_CFG_PAPD_IDX                  = BIT(3),
 309         IWL_CALIB_CFG_TX_PWR_IDX                = BIT(4),
 310         IWL_CALIB_CFG_DC_IDX                    = BIT(5),
 311         IWL_CALIB_CFG_BB_FILTER_IDX             = BIT(6),
 312         IWL_CALIB_CFG_LO_LEAKAGE_IDX            = BIT(7),
 313         IWL_CALIB_CFG_TX_IQ_IDX                 = BIT(8),
 314         IWL_CALIB_CFG_TX_IQ_SKEW_IDX            = BIT(9),
 315         IWL_CALIB_CFG_RX_IQ_IDX                 = BIT(10),
 316         IWL_CALIB_CFG_RX_IQ_SKEW_IDX            = BIT(11),
 317         IWL_CALIB_CFG_SENSITIVITY_IDX           = BIT(12),
 318         IWL_CALIB_CFG_CHAIN_NOISE_IDX           = BIT(13),
 319         IWL_CALIB_CFG_DISCONNECTED_ANT_IDX      = BIT(14),
 320         IWL_CALIB_CFG_ANT_COUPLING_IDX          = BIT(15),
 321         IWL_CALIB_CFG_DAC_IDX                   = BIT(16),
 322         IWL_CALIB_CFG_ABS_IDX                   = BIT(17),
 323         IWL_CALIB_CFG_AGC_IDX                   = BIT(18),
 324 };
 325
 326 /*
 327  * Phy configuration command.
 328  */
 329 struct iwl_phy_cfg_cmd {
 330         __le32  phy_cfg;
 331         struct iwl_calib_ctrl calib_control;
 332 } __packed;
 333
 334 #define PHY_CFG_RADIO_TYPE      (BIT(0) | BIT(1))
 335 #define PHY_CFG_RADIO_STEP      (BIT(2) | BIT(3))
 336 #define PHY_CFG_RADIO_DASH      (BIT(4) | BIT(5))
 337 #define PHY_CFG_PRODUCT_NUMBER  (BIT(6) | BIT(7))
 338 #define PHY_CFG_TX_CHAIN_A      BIT(8)
 339 #define PHY_CFG_TX_CHAIN_B      BIT(9)
 340 #define PHY_CFG_TX_CHAIN_C      BIT(10)
 341 #define PHY_CFG_RX_CHAIN_A      BIT(12)
 342 #define PHY_CFG_RX_CHAIN_B      BIT(13)
 343 #define PHY_CFG_RX_CHAIN_C      BIT(14)
 344
 345
 346 /* Target of the NVM_ACCESS_CMD */
 347 enum {
 348         NVM_ACCESS_TARGET_CACHE = 0,
 349         NVM_ACCESS_TARGET_OTP = 1,
 350         NVM_ACCESS_TARGET_EEPROM = 2,
 351 };
 352
 353 /* Section types for NVM_ACCESS_CMD */
 354 enum {
 355         NVM_SECTION_TYPE_SW = 1,
 356         NVM_SECTION_TYPE_REGULATORY = 3,
 357         NVM_SECTION_TYPE_CALIBRATION = 4,
 358         NVM_SECTION_TYPE_PRODUCTION = 5,
 359         NVM_SECTION_TYPE_MAC_OVERRIDE = 11,
 360         NVM_MAX_NUM_SECTIONS = 12,
 361 };
 362
 363 /**
 364  * struct iwl_nvm_access_cmd_ver2 - Request the device to send an NVM section
 365  * @op_code: 0 - read, 1 - write
 366  * @target: NVM_ACCESS_TARGET_*
 367  * @type: NVM_SECTION_TYPE_*
 368  * @offset: offset in bytes into the section
 369  * @length: in bytes, to read/write
 370  * @data: if write operation, the data to write. On read its empty
 371  */
 372 struct iwl_nvm_access_cmd {
 373         u8 op_code;
 374         u8 target;
 375         __le16 type;
 376         __le16 offset;
 377         __le16 length;
 378         u8 data[];
 379 } __packed; /* NVM_ACCESS_CMD_API_S_VER_2 */
 380
 381 /**
 382  * struct iwl_nvm_access_resp_ver2 - response to NVM_ACCESS_CMD
 383  * @offset: offset in bytes into the section
 384  * @length: in bytes, either how much was written or read
 385  * @type: NVM_SECTION_TYPE_*
 386  * @status: 0 for success, fail otherwise
 387  * @data: if read operation, the data returned. Empty on write.
 388  */
 389 struct iwl_nvm_access_resp {
 390         __le16 offset;
 391         __le16 length;
 392         __le16 type;
 393         __le16 status;
 394         u8 data[];
 395 } __packed; /* NVM_ACCESS_CMD_RESP_API_S_VER_2 */
 396
 397 /* MVM_ALIVE 0x1 */
 398
 399 /* alive response is_valid values */
 400 #define ALIVE_RESP_UCODE_OK     BIT(0)
 401 #define ALIVE_RESP_RFKILL       BIT(1)
 402
 403 /* alive response ver_type values */
 404 enum {
 405         FW_TYPE_HW = 0,
 406         FW_TYPE_PROT = 1,
 407         FW_TYPE_AP = 2,
 408         FW_TYPE_WOWLAN = 3,
 409         FW_TYPE_TIMING = 4,
 410         FW_TYPE_WIPAN = 5
 411 };
 412
 413 /* alive response ver_subtype values */
 414 enum {
 415         FW_SUBTYPE_FULL_FEATURE = 0,
 416         FW_SUBTYPE_BOOTSRAP = 1, /* Not valid */
 417         FW_SUBTYPE_REDUCED = 2,
 418         FW_SUBTYPE_ALIVE_ONLY = 3,
 419         FW_SUBTYPE_WOWLAN = 4,
 420         FW_SUBTYPE_AP_SUBTYPE = 5,
 421         FW_SUBTYPE_WIPAN = 6,
 422         FW_SUBTYPE_INITIALIZE = 9
 423 };
 424
 425 #define IWL_ALIVE_STATUS_ERR 0xDEAD
 426 #define IWL_ALIVE_STATUS_OK 0xCAFE
 427
 428 #define IWL_ALIVE_FLG_RFKILL    BIT(0)
 429
 430 struct mvm_alive_resp {
 431         __le16 status;
 432         __le16 flags;
 433         u8 ucode_minor;
 434         u8 ucode_major;
 435         __le16 id;
 436         u8 api_minor;
 437         u8 api_major;
 438         u8 ver_subtype;
 439         u8 ver_type;
 440         u8 mac;
 441         u8 opt;
 442         __le16 reserved2;
 443         __le32 timestamp;
 444         __le32 error_event_table_ptr;   /* SRAM address for error log */
 445         __le32 log_event_table_ptr;     /* SRAM address for event log */
 446         __le32 cpu_register_ptr;
 447         __le32 dbgm_config_ptr;
 448         __le32 alive_counter_ptr;
 449         __le32 scd_base_ptr;            /* SRAM address for SCD */
 450 } __packed; /* ALIVE_RES_API_S_VER_1 */
 451
 452 struct mvm_alive_resp_ver2 {
 453         __le16 status;
 454         __le16 flags;
 455         u8 ucode_minor;
 456         u8 ucode_major;
 457         __le16 id;
 458         u8 api_minor;
 459         u8 api_major;
 460         u8 ver_subtype;
 461         u8 ver_type;
 462         u8 mac;
 463         u8 opt;
 464         __le16 reserved2;
 465         __le32 timestamp;
 466         __le32 error_event_table_ptr;   /* SRAM address for error log */
 467         __le32 log_event_table_ptr;     /* SRAM address for LMAC event log */
 468         __le32 cpu_register_ptr;
 469         __le32 dbgm_config_ptr;
 470         __le32 alive_counter_ptr;
 471         __le32 scd_base_ptr;            /* SRAM address for SCD */
 472         __le32 st_fwrd_addr;            /* pointer to Store and forward */
 473         __le32 st_fwrd_size;
 474         u8 umac_minor;                  /* UMAC version: minor */
 475         u8 umac_major;                  /* UMAC version: major */
 476         __le16 umac_id;                 /* UMAC version: id */
 477         __le32 error_info_addr;         /* SRAM address for UMAC error log */
 478         __le32 dbg_print_buff_addr;
 479 } __packed; /* ALIVE_RES_API_S_VER_2 */
 480
 481 /* Error response/notification */
 482 enum {
 483         FW_ERR_UNKNOWN_CMD = 0x0,
 484         FW_ERR_INVALID_CMD_PARAM = 0x1,
 485         FW_ERR_SERVICE = 0x2,
 486         FW_ERR_ARC_MEMORY = 0x3,
 487         FW_ERR_ARC_CODE = 0x4,
 488         FW_ERR_WATCH_DOG = 0x5,
 489         FW_ERR_WEP_GRP_KEY_INDX = 0x10,
 490         FW_ERR_WEP_KEY_SIZE = 0x11,
 491         FW_ERR_OBSOLETE_FUNC = 0x12,
 492         FW_ERR_UNEXPECTED = 0xFE,
 493         FW_ERR_FATAL = 0xFF
 494 };
 495
 496 /**
 497  * struct iwl_error_resp - FW error indication
 498  * ( REPLY_ERROR = 0x2 )
 499  * @error_type: one of FW_ERR_*
 500  * @cmd_id: the command ID for which the error occured
 501  * @bad_cmd_seq_num: sequence number of the erroneous command
 502  * @error_service: which service created the error, applicable only if
 503  *      error_type = 2, otherwise 0
 504  * @timestamp: TSF in usecs.
 505  */
 506 struct iwl_error_resp {
 507         __le32 error_type;
 508         u8 cmd_id;
 509         u8 reserved1;
 510         __le16 bad_cmd_seq_num;
 511         __le32 error_service;
 512         __le64 timestamp;
 513 } __packed;
 514
 515
 516 /* Common PHY, MAC and Bindings definitions */
 517
 518 #define MAX_MACS_IN_BINDING     (3)
 519 #define MAX_BINDINGS            (4)
 520 #define AUX_BINDING_INDEX       (3)
 521 #define MAX_PHYS                (4)
 522
 523 /* Used to extract ID and color from the context dword */
 524 #define FW_CTXT_ID_POS    (0)
 525 #define FW_CTXT_ID_MSK    (0xff << FW_CTXT_ID_POS)
 526 #define FW_CTXT_COLOR_POS (8)
 527 #define FW_CTXT_COLOR_MSK (0xff << FW_CTXT_COLOR_POS)
 528 #define FW_CTXT_INVALID   (0xffffffff)
 529
 530 #define FW_CMD_ID_AND_COLOR(_id, _color) ((_id << FW_CTXT_ID_POS) |\
 531                                           (_color << FW_CTXT_COLOR_POS))
 532
 533 /* Possible actions on PHYs, MACs and Bindings */
 534 enum {
 535         FW_CTXT_ACTION_STUB = 0,
 536         FW_CTXT_ACTION_ADD,
 537         FW_CTXT_ACTION_MODIFY,
 538         FW_CTXT_ACTION_REMOVE,
 539         FW_CTXT_ACTION_NUM
 540 }; /* COMMON_CONTEXT_ACTION_API_E_VER_1 */
 541
 542 /* Time Events */
 543
 544 /* Time Event types, according to MAC type */
 545 enum iwl_time_event_type {
 546         /* BSS Station Events */
 547         TE_BSS_STA_AGGRESSIVE_ASSOC,
 548         TE_BSS_STA_ASSOC,
 549         TE_BSS_EAP_DHCP_PROT,
 550         TE_BSS_QUIET_PERIOD,
 551
 552         /* P2P Device Events */
 553         TE_P2P_DEVICE_DISCOVERABLE,
 554         TE_P2P_DEVICE_LISTEN,
 555         TE_P2P_DEVICE_ACTION_SCAN,
 556         TE_P2P_DEVICE_FULL_SCAN,
 557
 558         /* P2P Client Events */
 559         TE_P2P_CLIENT_AGGRESSIVE_ASSOC,
 560         TE_P2P_CLIENT_ASSOC,
 561         TE_P2P_CLIENT_QUIET_PERIOD,
 562
 563         /* P2P GO Events */
 564         TE_P2P_GO_ASSOC_PROT,
 565         TE_P2P_GO_REPETITIVE_NOA,
 566         TE_P2P_GO_CT_WINDOW,
 567
 568         /* WiDi Sync Events */
 569         TE_WIDI_TX_SYNC,
 570
 571         /* Channel Switch NoA */
 572         TE_CHANNEL_SWITCH_PERIOD,
 573
 574         TE_MAX
 575 }; /* MAC_EVENT_TYPE_API_E_VER_1 */
 576
 577
 578
 579 /* Time event - defines for command API v1 */
 580
 581 /*
 582  * @TE_V1_FRAG_NONE: fragmentation of the time event is NOT allowed.
 583  * @TE_V1_FRAG_SINGLE: fragmentation of the time event is allowed, but only
 584  *      the first fragment is scheduled.
 585  * @TE_V1_FRAG_DUAL: fragmentation of the time event is allowed, but only
 586  *      the first 2 fragments are scheduled.
 587  * @TE_V1_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
 588  *      number of fragments are valid.
 589  *
 590  * Other than the constant defined above, specifying a fragmentation value 'x'
 591  * means that the event can be fragmented but only the first 'x' will be
 592  * scheduled.
 593  */
 594 enum {
 595         TE_V1_FRAG_NONE = 0,
 596         TE_V1_FRAG_SINGLE = 1,
 597         TE_V1_FRAG_DUAL = 2,
 598         TE_V1_FRAG_ENDLESS = 0xffffffff
 599 };
 600
 601 /* If a Time Event can be fragmented, this is the max number of fragments */
 602 #define TE_V1_FRAG_MAX_MSK      0x0fffffff
 603 /* Repeat the time event endlessly (until removed) */
 604 #define TE_V1_REPEAT_ENDLESS    0xffffffff
 605 /* If a Time Event has bounded repetitions, this is the maximal value */
 606 #define TE_V1_REPEAT_MAX_MSK_V1 0x0fffffff
 607
 608 /* Time Event dependencies: none, on another TE, or in a specific time */
 609 enum {
 610         TE_V1_INDEPENDENT               = 0,
 611         TE_V1_DEP_OTHER                 = BIT(0),
 612         TE_V1_DEP_TSF                   = BIT(1),
 613         TE_V1_EVENT_SOCIOPATHIC         = BIT(2),
 614 }; /* MAC_EVENT_DEPENDENCY_POLICY_API_E_VER_2 */
 615
 616 /*
 617  * @TE_V1_NOTIF_NONE: no notifications
 618  * @TE_V1_NOTIF_HOST_EVENT_START: request/receive notification on event start
 619  * @TE_V1_NOTIF_HOST_EVENT_END:request/receive notification on event end
 620  * @TE_V1_NOTIF_INTERNAL_EVENT_START: internal FW use
 621  * @TE_V1_NOTIF_INTERNAL_EVENT_END: internal FW use.
 622  * @TE_V1_NOTIF_HOST_FRAG_START: request/receive notification on frag start
 623  * @TE_V1_NOTIF_HOST_FRAG_END:request/receive notification on frag end
 624  * @TE_V1_NOTIF_INTERNAL_FRAG_START: internal FW use.
 625  * @TE_V1_NOTIF_INTERNAL_FRAG_END: internal FW use.
 626  *
 627  * Supported Time event notifications configuration.
 628  * A notification (both event and fragment) includes a status indicating weather
 629  * the FW was able to schedule the event or not. For fragment start/end
 630  * notification the status is always success. There is no start/end fragment
 631  * notification for monolithic events.
 632  */
 633 enum {
 634         TE_V1_NOTIF_NONE = 0,
 635         TE_V1_NOTIF_HOST_EVENT_START = BIT(0),
 636         TE_V1_NOTIF_HOST_EVENT_END = BIT(1),
 637         TE_V1_NOTIF_INTERNAL_EVENT_START = BIT(2),
 638         TE_V1_NOTIF_INTERNAL_EVENT_END = BIT(3),
 639         TE_V1_NOTIF_HOST_FRAG_START = BIT(4),
 640         TE_V1_NOTIF_HOST_FRAG_END = BIT(5),
 641         TE_V1_NOTIF_INTERNAL_FRAG_START = BIT(6),
 642         TE_V1_NOTIF_INTERNAL_FRAG_END = BIT(7),
 643 }; /* MAC_EVENT_ACTION_API_E_VER_2 */
 644
 645 /* Time event - defines for command API */
 646
 647 /*
 648  * @TE_V2_FRAG_NONE: fragmentation of the time event is NOT allowed.
 649  * @TE_V2_FRAG_SINGLE: fragmentation of the time event is allowed, but only
 650  *  the first fragment is scheduled.
 651  * @TE_V2_FRAG_DUAL: fragmentation of the time event is allowed, but only
 652  *  the first 2 fragments are scheduled.
 653  * @TE_V2_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
 654  *  number of fragments are valid.
 655  *
 656  * Other than the constant defined above, specifying a fragmentation value 'x'
 657  * means that the event can be fragmented but only the first 'x' will be
 658  * scheduled.
 659  */
 660 enum {
 661         TE_V2_FRAG_NONE = 0,
 662         TE_V2_FRAG_SINGLE = 1,
 663         TE_V2_FRAG_DUAL = 2,
 664         TE_V2_FRAG_MAX = 0xfe,
 665         TE_V2_FRAG_ENDLESS = 0xff
 666 };
 667
 668 /* Repeat the time event endlessly (until removed) */
 669 #define TE_V2_REPEAT_ENDLESS    0xff
 670 /* If a Time Event has bounded repetitions, this is the maximal value */
 671 #define TE_V2_REPEAT_MAX        0xfe
 672
 673 #define TE_V2_PLACEMENT_POS     12
 674 #define TE_V2_ABSENCE_POS       15
 675
 676 /* Time event policy values
 677  * A notification (both event and fragment) includes a status indicating weather
 678  * the FW was able to schedule the event or not. For fragment start/end
 679  * notification the status is always success. There is no start/end fragment
 680  * notification for monolithic events.
 681  *
 682  * @TE_V2_DEFAULT_POLICY: independent, social, present, unoticable
 683  * @TE_V2_NOTIF_HOST_EVENT_START: request/receive notification on event start
 684  * @TE_V2_NOTIF_HOST_EVENT_END:request/receive notification on event end
 685  * @TE_V2_NOTIF_INTERNAL_EVENT_START: internal FW use
 686  * @TE_V2_NOTIF_INTERNAL_EVENT_END: internal FW use.
 687  * @TE_V2_NOTIF_HOST_FRAG_START: request/receive notification on frag start
 688  * @TE_V2_NOTIF_HOST_FRAG_END:request/receive notification on frag end
 689  * @TE_V2_NOTIF_INTERNAL_FRAG_START: internal FW use.
 690  * @TE_V2_NOTIF_INTERNAL_FRAG_END: internal FW use.
 691  * @TE_V2_DEP_OTHER: depends on another time event
 692  * @TE_V2_DEP_TSF: depends on a specific time
 693  * @TE_V2_EVENT_SOCIOPATHIC: can't co-exist with other events of tha same MAC
 694  * @TE_V2_ABSENCE: are we present or absent during the Time Event.
 695  */
 696 enum {
 697         TE_V2_DEFAULT_POLICY = 0x0,
 698
 699         /* notifications (event start/stop, fragment start/stop) */
 700         TE_V2_NOTIF_HOST_EVENT_START = BIT(0),
 701         TE_V2_NOTIF_HOST_EVENT_END = BIT(1),
 702         TE_V2_NOTIF_INTERNAL_EVENT_START = BIT(2),
 703         TE_V2_NOTIF_INTERNAL_EVENT_END = BIT(3),
 704
 705         TE_V2_NOTIF_HOST_FRAG_START = BIT(4),
 706         TE_V2_NOTIF_HOST_FRAG_END = BIT(5),
 707         TE_V2_NOTIF_INTERNAL_FRAG_START = BIT(6),
 708         TE_V2_NOTIF_INTERNAL_FRAG_END = BIT(7),
 709         T2_V2_START_IMMEDIATELY = BIT(11),
 710
 711         TE_V2_NOTIF_MSK = 0xff,
 712
 713         /* placement characteristics */
 714         TE_V2_DEP_OTHER = BIT(TE_V2_PLACEMENT_POS),
 715         TE_V2_DEP_TSF = BIT(TE_V2_PLACEMENT_POS + 1),
 716         TE_V2_EVENT_SOCIOPATHIC = BIT(TE_V2_PLACEMENT_POS + 2),
 717
 718         /* are we present or absent during the Time Event. */
 719         TE_V2_ABSENCE = BIT(TE_V2_ABSENCE_POS),
 720 };
 721
 722 /**
 723  * struct iwl_time_event_cmd_api - configuring Time Events
 724  * with struct MAC_TIME_EVENT_DATA_API_S_VER_2 (see also
 725  * with version 1. determined by IWL_UCODE_TLV_FLAGS)
 726  * ( TIME_EVENT_CMD = 0x29 )
 727  * @id_and_color: ID and color of the relevant MAC
 728  * @action: action to perform, one of FW_CTXT_ACTION_*
 729  * @id: this field has two meanings, depending on the action:
 730  *      If the action is ADD, then it means the type of event to add.
 731  *      For all other actions it is the unique event ID assigned when the
 732  *      event was added by the FW.
 733  * @apply_time: When to start the Time Event (in GP2)
 734  * @max_delay: maximum delay to event's start (apply time), in TU
 735  * @depends_on: the unique ID of the event we depend on (if any)
 736  * @interval: interval between repetitions, in TU
 737  * @duration: duration of event in TU
 738  * @repeat: how many repetitions to do, can be TE_REPEAT_ENDLESS
 739  * @max_frags: maximal number of fragments the Time Event can be divided to
 740  * @policy: defines whether uCode shall notify the host or other uCode modules
 741  *      on event and/or fragment start and/or end
 742  *      using one of TE_INDEPENDENT, TE_DEP_OTHER, TE_DEP_TSF
 743  *      TE_EVENT_SOCIOPATHIC
 744  *      using TE_ABSENCE and using TE_NOTIF_*
 745  */
 746 struct iwl_time_event_cmd {
 747         /* COMMON_INDEX_HDR_API_S_VER_1 */
 748         __le32 id_and_color;
 749         __le32 action;
 750         __le32 id;
 751         /* MAC_TIME_EVENT_DATA_API_S_VER_2 */
 752         __le32 apply_time;
 753         __le32 max_delay;
 754         __le32 depends_on;
 755         __le32 interval;
 756         __le32 duration;
 757         u8 repeat;
 758         u8 max_frags;
 759         __le16 policy;
 760 } __packed; /* MAC_TIME_EVENT_CMD_API_S_VER_2 */
 761
 762 /**
 763  * struct iwl_time_event_resp - response structure to iwl_time_event_cmd
 764  * @status: bit 0 indicates success, all others specify errors
 765  * @id: the Time Event type
 766  * @unique_id: the unique ID assigned (in ADD) or given (others) to the TE
 767  * @id_and_color: ID and color of the relevant MAC
 768  */
 769 struct iwl_time_event_resp {
 770         __le32 status;
 771         __le32 id;
 772         __le32 unique_id;
 773         __le32 id_and_color;
 774 } __packed; /* MAC_TIME_EVENT_RSP_API_S_VER_1 */
 775
 776 /**
 777  * struct iwl_time_event_notif - notifications of time event start/stop
 778  * ( TIME_EVENT_NOTIFICATION = 0x2a )
 779  * @timestamp: action timestamp in GP2
 780  * @session_id: session's unique id
 781  * @unique_id: unique id of the Time Event itself
 782  * @id_and_color: ID and color of the relevant MAC
 783  * @action: one of TE_NOTIF_START or TE_NOTIF_END
 784  * @status: true if scheduled, false otherwise (not executed)
 785  */
 786 struct iwl_time_event_notif {
 787         __le32 timestamp;
 788         __le32 session_id;
 789         __le32 unique_id;
 790         __le32 id_and_color;
 791         __le32 action;
 792         __le32 status;
 793 } __packed; /* MAC_TIME_EVENT_NTFY_API_S_VER_1 */
 794
 795
 796 /* Bindings and Time Quota */
 797
 798 /**
 799  * struct iwl_binding_cmd - configuring bindings
 800  * ( BINDING_CONTEXT_CMD = 0x2b )
 801  * @id_and_color: ID and color of the relevant Binding
 802  * @action: action to perform, one of FW_CTXT_ACTION_*
 803  * @macs: array of MAC id and colors which belong to the binding
 804  * @phy: PHY id and color which belongs to the binding
 805  */
 806 struct iwl_binding_cmd {
 807         /* COMMON_INDEX_HDR_API_S_VER_1 */
 808         __le32 id_and_color;
 809         __le32 action;
 810         /* BINDING_DATA_API_S_VER_1 */
 811         __le32 macs[MAX_MACS_IN_BINDING];
 812         __le32 phy;
 813 } __packed; /* BINDING_CMD_API_S_VER_1 */
 814
 815 /* The maximal number of fragments in the FW's schedule session */
 816 #define IWL_MVM_MAX_QUOTA 128
 817
 818 /**
 819  * struct iwl_time_quota_data - configuration of time quota per binding
 820  * @id_and_color: ID and color of the relevant Binding
 821  * @quota: absolute time quota in TU. The scheduler will try to divide the
 822  *      remainig quota (after Time Events) according to this quota.
 823  * @max_duration: max uninterrupted context duration in TU
 824  */
 825 struct iwl_time_quota_data {
 826         __le32 id_and_color;
 827         __le32 quota;
 828         __le32 max_duration;
 829 } __packed; /* TIME_QUOTA_DATA_API_S_VER_1 */
 830
 831 /**
 832  * struct iwl_time_quota_cmd - configuration of time quota between bindings
 833  * ( TIME_QUOTA_CMD = 0x2c )
 834  * @quotas: allocations per binding
 835  */
 836 struct iwl_time_quota_cmd {
 837         struct iwl_time_quota_data quotas[MAX_BINDINGS];
 838 } __packed; /* TIME_QUOTA_ALLOCATION_CMD_API_S_VER_1 */
 839
 840
 841 /* PHY context */
 842
 843 /* Supported bands */
 844 #define PHY_BAND_5  (0)
 845 #define PHY_BAND_24 (1)
 846
 847 /* Supported channel width, vary if there is VHT support */
 848 #define PHY_VHT_CHANNEL_MODE20  (0x0)
 849 #define PHY_VHT_CHANNEL_MODE40  (0x1)
 850 #define PHY_VHT_CHANNEL_MODE80  (0x2)
 851 #define PHY_VHT_CHANNEL_MODE160 (0x3)
 852
 853 /*
 854  * Control channel position:
 855  * For legacy set bit means upper channel, otherwise lower.
 856  * For VHT - bit-2 marks if the control is lower/upper relative to center-freq
 857  *   bits-1:0 mark the distance from the center freq. for 20Mhz, offset is 0.
 858  *                                   center_freq
 859  *                                        |
 860  * 40Mhz                          |_______|_______|
 861  * 80Mhz                  |_______|_______|_______|_______|
 862  * 160Mhz |_______|_______|_______|_______|_______|_______|_______|_______|
 863  * code      011     010     001     000  |  100     101     110    111
 864  */
 865 #define PHY_VHT_CTRL_POS_1_BELOW  (0x0)
 866 #define PHY_VHT_CTRL_POS_2_BELOW  (0x1)
 867 #define PHY_VHT_CTRL_POS_3_BELOW  (0x2)
 868 #define PHY_VHT_CTRL_POS_4_BELOW  (0x3)
 869 #define PHY_VHT_CTRL_POS_1_ABOVE  (0x4)
 870 #define PHY_VHT_CTRL_POS_2_ABOVE  (0x5)
 871 #define PHY_VHT_CTRL_POS_3_ABOVE  (0x6)
 872 #define PHY_VHT_CTRL_POS_4_ABOVE  (0x7)
 873
 874 /*
 875  * @band: PHY_BAND_*
 876  * @channel: channel number
 877  * @width: PHY_[VHT|LEGACY]_CHANNEL_*
 878  * @ctrl channel: PHY_[VHT|LEGACY]_CTRL_*
 879  */
 880 struct iwl_fw_channel_info {
 881         u8 band;
 882         u8 channel;
 883         u8 width;
 884         u8 ctrl_pos;
 885 } __packed;
 886
 887 #define PHY_RX_CHAIN_DRIVER_FORCE_POS   (0)
 888 #define PHY_RX_CHAIN_DRIVER_FORCE_MSK \
 889         (0x1 << PHY_RX_CHAIN_DRIVER_FORCE_POS)
 890 #define PHY_RX_CHAIN_VALID_POS          (1)
 891 #define PHY_RX_CHAIN_VALID_MSK \
 892         (0x7 << PHY_RX_CHAIN_VALID_POS)
 893 #define PHY_RX_CHAIN_FORCE_SEL_POS      (4)
 894 #define PHY_RX_CHAIN_FORCE_SEL_MSK \
 895         (0x7 << PHY_RX_CHAIN_FORCE_SEL_POS)
 896 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
 897 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_MSK \
 898         (0x7 << PHY_RX_CHAIN_FORCE_MIMO_SEL_POS)
 899 #define PHY_RX_CHAIN_CNT_POS            (10)
 900 #define PHY_RX_CHAIN_CNT_MSK \
 901         (0x3 << PHY_RX_CHAIN_CNT_POS)
 902 #define PHY_RX_CHAIN_MIMO_CNT_POS       (12)
 903 #define PHY_RX_CHAIN_MIMO_CNT_MSK \
 904         (0x3 << PHY_RX_CHAIN_MIMO_CNT_POS)
 905 #define PHY_RX_CHAIN_MIMO_FORCE_POS     (14)
 906 #define PHY_RX_CHAIN_MIMO_FORCE_MSK \
 907         (0x1 << PHY_RX_CHAIN_MIMO_FORCE_POS)
 908
 909 /* TODO: fix the value, make it depend on firmware at runtime? */
 910 #define NUM_PHY_CTX     3
 911
 912 /* TODO: complete missing documentation */
 913 /**
 914  * struct iwl_phy_context_cmd - config of the PHY context
 915  * ( PHY_CONTEXT_CMD = 0x8 )
 916  * @id_and_color: ID and color of the relevant Binding
 917  * @action: action to perform, one of FW_CTXT_ACTION_*
 918  * @apply_time: 0 means immediate apply and context switch.
 919  *      other value means apply new params after X usecs
 920  * @tx_param_color: ???
 921  * @channel_info:
 922  * @txchain_info: ???
 923  * @rxchain_info: ???
 924  * @acquisition_data: ???
 925  * @dsp_cfg_flags: set to 0
 926  */
 927 struct iwl_phy_context_cmd {
 928         /* COMMON_INDEX_HDR_API_S_VER_1 */
 929         __le32 id_and_color;
 930         __le32 action;
 931         /* PHY_CONTEXT_DATA_API_S_VER_1 */
 932         __le32 apply_time;
 933         __le32 tx_param_color;
 934         struct iwl_fw_channel_info ci;
 935         __le32 txchain_info;
 936         __le32 rxchain_info;
 937         __le32 acquisition_data;
 938         __le32 dsp_cfg_flags;
 939 } __packed; /* PHY_CONTEXT_CMD_API_VER_1 */
 940
 941 /*
 942  * Aux ROC command
 943  *
 944  * Command requests the firmware to create a time event for a certain duration
 945  * and remain on the given channel. This is done by using the Aux framework in
 946  * the FW.
 947  * The command was first used for Hot Spot issues - but can be used regardless
 948  * to Hot Spot.
 949  *
 950  * ( HOT_SPOT_CMD 0x53 )
 951  *
 952  * @id_and_color: ID and color of the MAC
 953  * @action: action to perform, one of FW_CTXT_ACTION_*
 954  * @event_unique_id: If the action FW_CTXT_ACTION_REMOVE then the
 955  *      event_unique_id should be the id of the time event assigned by ucode.
 956  *      Otherwise ignore the event_unique_id.
 957  * @sta_id_and_color: station id and color, resumed during "Remain On Channel"
 958  *      activity.
 959  * @channel_info: channel info
 960  * @node_addr: Our MAC Address
 961  * @reserved: reserved for alignment
 962  * @apply_time: GP2 value to start (should always be the current GP2 value)
 963  * @apply_time_max_delay: Maximum apply time delay value in TU. Defines max
 964  *      time by which start of the event is allowed to be postponed.
 965  * @duration: event duration in TU To calculate event duration:
 966  *      timeEventDuration = min(duration, remainingQuota)
 967  */
 968 struct iwl_hs20_roc_req {
 969         /* COMMON_INDEX_HDR_API_S_VER_1 hdr */
 970         __le32 id_and_color;
 971         __le32 action;
 972         __le32 event_unique_id;
 973         __le32 sta_id_and_color;
 974         struct iwl_fw_channel_info channel_info;
 975         u8 node_addr[ETH_ALEN];
 976         __le16 reserved;
 977         __le32 apply_time;
 978         __le32 apply_time_max_delay;
 979         __le32 duration;
 980 } __packed; /* HOT_SPOT_CMD_API_S_VER_1 */
 981
 982 /*
 983  * values for AUX ROC result values
 984  */
 985 enum iwl_mvm_hot_spot {
 986         HOT_SPOT_RSP_STATUS_OK,
 987         HOT_SPOT_RSP_STATUS_TOO_MANY_EVENTS,
 988         HOT_SPOT_MAX_NUM_OF_SESSIONS,
 989 };
 990
 991 /*
 992  * Aux ROC command response
 993  *
 994  * In response to iwl_hs20_roc_req the FW sends this command to notify the
 995  * driver the uid of the timevent.
 996  *
 997  * ( HOT_SPOT_CMD 0x53 )
 998  *
 999  * @event_unique_id: Unique ID of time event assigned by ucode
1000  * @status: Return status 0 is success, all the rest used for specific errors
1001  */
1002 struct iwl_hs20_roc_res {
1003         __le32 event_unique_id;
1004         __le32 status;
1005 } __packed; /* HOT_SPOT_RSP_API_S_VER_1 */
1006
1007 #define IWL_RX_INFO_PHY_CNT 8
1008 #define IWL_RX_INFO_ENERGY_ANT_ABC_IDX 1
1009 #define IWL_RX_INFO_ENERGY_ANT_A_MSK 0x000000ff
1010 #define IWL_RX_INFO_ENERGY_ANT_B_MSK 0x0000ff00
1011 #define IWL_RX_INFO_ENERGY_ANT_C_MSK 0x00ff0000
1012 #define IWL_RX_INFO_ENERGY_ANT_A_POS 0
1013 #define IWL_RX_INFO_ENERGY_ANT_B_POS 8
1014 #define IWL_RX_INFO_ENERGY_ANT_C_POS 16
1015
1016 #define IWL_RX_INFO_AGC_IDX 1
1017 #define IWL_RX_INFO_RSSI_AB_IDX 2
1018 #define IWL_OFDM_AGC_A_MSK 0x0000007f
1019 #define IWL_OFDM_AGC_A_POS 0
1020 #define IWL_OFDM_AGC_B_MSK 0x00003f80
1021 #define IWL_OFDM_AGC_B_POS 7
1022 #define IWL_OFDM_AGC_CODE_MSK 0x3fe00000
1023 #define IWL_OFDM_AGC_CODE_POS 20
1024 #define IWL_OFDM_RSSI_INBAND_A_MSK 0x00ff
1025 #define IWL_OFDM_RSSI_A_POS 0
1026 #define IWL_OFDM_RSSI_ALLBAND_A_MSK 0xff00
1027 #define IWL_OFDM_RSSI_ALLBAND_A_POS 8
1028 #define IWL_OFDM_RSSI_INBAND_B_MSK 0xff0000
1029 #define IWL_OFDM_RSSI_B_POS 16
1030 #define IWL_OFDM_RSSI_ALLBAND_B_MSK 0xff000000
1031 #define IWL_OFDM_RSSI_ALLBAND_B_POS 24
1032
1033 /**
1034  * struct iwl_rx_phy_info - phy info
1035  * (REPLY_RX_PHY_CMD = 0xc0)
1036  * @non_cfg_phy_cnt: non configurable DSP phy data byte count
1037  * @cfg_phy_cnt: configurable DSP phy data byte count
1038  * @stat_id: configurable DSP phy data set ID
1039  * @reserved1:
1040  * @system_timestamp: GP2  at on air rise
1041  * @timestamp: TSF at on air rise
1042  * @beacon_time_stamp: beacon at on-air rise
1043  * @phy_flags: general phy flags: band, modulation, ...
1044  * @channel: channel number
1045  * @non_cfg_phy_buf: for various implementations of non_cfg_phy
1046  * @rate_n_flags: RATE_MCS_*
1047  * @byte_count: frame's byte-count
1048  * @frame_time: frame's time on the air, based on byte count and frame rate
1049  *      calculation
1050  * @mac_active_msk: what MACs were active when the frame was received
1051  *
1052  * Before each Rx, the device sends this data. It contains PHY information
1053  * about the reception of the packet.
1054  */
1055 struct iwl_rx_phy_info {
1056         u8 non_cfg_phy_cnt;
1057         u8 cfg_phy_cnt;
1058         u8 stat_id;
1059         u8 reserved1;
1060         __le32 system_timestamp;
1061         __le64 timestamp;
1062         __le32 beacon_time_stamp;
1063         __le16 phy_flags;
1064         __le16 channel;
1065         __le32 non_cfg_phy[IWL_RX_INFO_PHY_CNT];
1066         __le32 rate_n_flags;
1067         __le32 byte_count;
1068         __le16 mac_active_msk;
1069         __le16 frame_time;
1070 } __packed;
1071
1072 struct iwl_rx_mpdu_res_start {
1073         __le16 byte_count;
1074         __le16 reserved;
1075 } __packed;
1076
1077 /**
1078  * enum iwl_rx_phy_flags - to parse %iwl_rx_phy_info phy_flags
1079  * @RX_RES_PHY_FLAGS_BAND_24: true if the packet was received on 2.4 band
1080  * @RX_RES_PHY_FLAGS_MOD_CCK:
1081  * @RX_RES_PHY_FLAGS_SHORT_PREAMBLE: true if packet's preamble was short
1082  * @RX_RES_PHY_FLAGS_NARROW_BAND:
1083  * @RX_RES_PHY_FLAGS_ANTENNA: antenna on which the packet was received
1084  * @RX_RES_PHY_FLAGS_AGG: set if the packet was part of an A-MPDU
1085  * @RX_RES_PHY_FLAGS_OFDM_HT: The frame was an HT frame
1086  * @RX_RES_PHY_FLAGS_OFDM_GF: The frame used GF preamble
1087  * @RX_RES_PHY_FLAGS_OFDM_VHT: The frame was a VHT frame
1088  */
1089 enum iwl_rx_phy_flags {
1090         RX_RES_PHY_FLAGS_BAND_24        = BIT(0),
1091         RX_RES_PHY_FLAGS_MOD_CCK        = BIT(1),
1092         RX_RES_PHY_FLAGS_SHORT_PREAMBLE = BIT(2),
1093         RX_RES_PHY_FLAGS_NARROW_BAND    = BIT(3),
1094         RX_RES_PHY_FLAGS_ANTENNA        = (0x7 << 4),
1095         RX_RES_PHY_FLAGS_ANTENNA_POS    = 4,
1096         RX_RES_PHY_FLAGS_AGG            = BIT(7),
1097         RX_RES_PHY_FLAGS_OFDM_HT        = BIT(8),
1098         RX_RES_PHY_FLAGS_OFDM_GF        = BIT(9),
1099         RX_RES_PHY_FLAGS_OFDM_VHT       = BIT(10),
1100 };
1101
1102 /**
1103  * enum iwl_mvm_rx_status - written by fw for each Rx packet
1104  * @RX_MPDU_RES_STATUS_CRC_OK: CRC is fine
1105  * @RX_MPDU_RES_STATUS_OVERRUN_OK: there was no RXE overflow
1106  * @RX_MPDU_RES_STATUS_SRC_STA_FOUND:
1107  * @RX_MPDU_RES_STATUS_KEY_VALID:
1108  * @RX_MPDU_RES_STATUS_KEY_PARAM_OK:
1109  * @RX_MPDU_RES_STATUS_ICV_OK: ICV is fine, if not, the packet is destroyed
1110  * @RX_MPDU_RES_STATUS_MIC_OK: used for CCM alg only. TKIP MIC is checked
1111  *      in the driver.
1112  * @RX_MPDU_RES_STATUS_TTAK_OK: TTAK is fine
1113  * @RX_MPDU_RES_STATUS_MNG_FRAME_REPLAY_ERR:  valid for alg = CCM_CMAC or
1114  *      alg = CCM only. Checks replay attack for 11w frames. Relevant only if
1115  *      %RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME is set.
1116  * @RX_MPDU_RES_STATUS_SEC_NO_ENC: this frame is not encrypted
1117  * @RX_MPDU_RES_STATUS_SEC_WEP_ENC: this frame is encrypted using WEP
1118  * @RX_MPDU_RES_STATUS_SEC_CCM_ENC: this frame is encrypted using CCM
1119  * @RX_MPDU_RES_STATUS_SEC_TKIP_ENC: this frame is encrypted using TKIP
1120  * @RX_MPDU_RES_STATUS_SEC_CCM_CMAC_ENC: this frame is encrypted using CCM_CMAC
1121  * @RX_MPDU_RES_STATUS_SEC_ENC_ERR: this frame couldn't be decrypted
1122  * @RX_MPDU_RES_STATUS_SEC_ENC_MSK: bitmask of the encryption algorithm
1123  * @RX_MPDU_RES_STATUS_DEC_DONE: this frame has been successfully decrypted
1124  * @RX_MPDU_RES_STATUS_PROTECT_FRAME_BIT_CMP:
1125  * @RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP:
1126  * @RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT:
1127  * @RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME: this frame is an 11w management frame
1128  * @RX_MPDU_RES_STATUS_HASH_INDEX_MSK:
1129  * @RX_MPDU_RES_STATUS_STA_ID_MSK:
1130  * @RX_MPDU_RES_STATUS_RRF_KILL:
1131  * @RX_MPDU_RES_STATUS_FILTERING_MSK:
1132  * @RX_MPDU_RES_STATUS2_FILTERING_MSK:
1133  */
1134 enum iwl_mvm_rx_status {
1135         RX_MPDU_RES_STATUS_CRC_OK                       = BIT(0),
1136         RX_MPDU_RES_STATUS_OVERRUN_OK                   = BIT(1),
1137         RX_MPDU_RES_STATUS_SRC_STA_FOUND                = BIT(2),
1138         RX_MPDU_RES_STATUS_KEY_VALID                    = BIT(3),
1139         RX_MPDU_RES_STATUS_KEY_PARAM_OK                 = BIT(4),
1140         RX_MPDU_RES_STATUS_ICV_OK                       = BIT(5),
1141         RX_MPDU_RES_STATUS_MIC_OK                       = BIT(6),
1142         RX_MPDU_RES_STATUS_TTAK_OK                      = BIT(7),
1143         RX_MPDU_RES_STATUS_MNG_FRAME_REPLAY_ERR         = BIT(7),
1144         RX_MPDU_RES_STATUS_SEC_NO_ENC                   = (0 << 8),
1145         RX_MPDU_RES_STATUS_SEC_WEP_ENC                  = (1 << 8),
1146         RX_MPDU_RES_STATUS_SEC_CCM_ENC                  = (2 << 8),
1147         RX_MPDU_RES_STATUS_SEC_TKIP_ENC                 = (3 << 8),
1148         RX_MPDU_RES_STATUS_SEC_EXT_ENC                  = (4 << 8),
1149         RX_MPDU_RES_STATUS_SEC_CCM_CMAC_ENC             = (6 << 8),
1150         RX_MPDU_RES_STATUS_SEC_ENC_ERR                  = (7 << 8),
1151         RX_MPDU_RES_STATUS_SEC_ENC_MSK                  = (7 << 8),
1152         RX_MPDU_RES_STATUS_DEC_DONE                     = BIT(11),
1153         RX_MPDU_RES_STATUS_PROTECT_FRAME_BIT_CMP        = BIT(12),
1154         RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP               = BIT(13),
1155         RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT               = BIT(14),
1156         RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME             = BIT(15),
1157         RX_MPDU_RES_STATUS_HASH_INDEX_MSK               = (0x3F0000),
1158         RX_MPDU_RES_STATUS_STA_ID_MSK                   = (0x1f000000),
1159         RX_MPDU_RES_STATUS_RRF_KILL                     = BIT(29),
1160         RX_MPDU_RES_STATUS_FILTERING_MSK                = (0xc00000),
1161         RX_MPDU_RES_STATUS2_FILTERING_MSK               = (0xc0000000),
1162 };
1163
1164 /**
1165  * struct iwl_radio_version_notif - information on the radio version
1166  * ( RADIO_VERSION_NOTIFICATION = 0x68 )
1167  * @radio_flavor:
1168  * @radio_step:
1169  * @radio_dash:
1170  */
1171 struct iwl_radio_version_notif {
1172         __le32 radio_flavor;
1173         __le32 radio_step;
1174         __le32 radio_dash;
1175 } __packed; /* RADIO_VERSION_NOTOFICATION_S_VER_1 */
1176
1177 enum iwl_card_state_flags {
1178         CARD_ENABLED            = 0x00,
1179         HW_CARD_DISABLED        = 0x01,
1180         SW_CARD_DISABLED        = 0x02,
1181         CT_KILL_CARD_DISABLED   = 0x04,
1182         HALT_CARD_DISABLED      = 0x08,
1183         CARD_DISABLED_MSK       = 0x0f,
1184         CARD_IS_RX_ON           = 0x10,
1185 };
1186
1187 /**
1188  * struct iwl_radio_version_notif - information on the radio version
1189  * ( CARD_STATE_NOTIFICATION = 0xa1 )
1190  * @flags: %iwl_card_state_flags
1191  */
1192 struct iwl_card_state_notif {
1193         __le32 flags;
1194 } __packed; /* CARD_STATE_NTFY_API_S_VER_1 */
1195
1196 /**
1197  * struct iwl_missed_beacons_notif - information on missed beacons
1198  * ( MISSED_BEACONS_NOTIFICATION = 0xa2 )
1199  * @mac_id: interface ID
1200  * @consec_missed_beacons_since_last_rx: number of consecutive missed
1201  *      beacons since last RX.
1202  * @consec_missed_beacons: number of consecutive missed beacons
1203  * @num_expected_beacons:
1204  * @num_recvd_beacons:
1205  */
1206 struct iwl_missed_beacons_notif {
1207         __le32 mac_id;
1208         __le32 consec_missed_beacons_since_last_rx;
1209         __le32 consec_missed_beacons;
1210         __le32 num_expected_beacons;
1211         __le32 num_recvd_beacons;
1212 } __packed; /* MISSED_BEACON_NTFY_API_S_VER_3 */
1213
1214 /**
1215  * struct iwl_mfuart_load_notif - mfuart image version & status
1216  * ( MFUART_LOAD_NOTIFICATION = 0xb1 )
1217  * @installed_ver: installed image version
1218  * @external_ver: external image version
1219  * @status: MFUART loading status
1220  * @duration: MFUART loading time
1221 */
1222 struct iwl_mfuart_load_notif {
1223         __le32 installed_ver;
1224         __le32 external_ver;
1225         __le32 status;
1226         __le32 duration;
1227 } __packed; /*MFU_LOADER_NTFY_API_S_VER_1*/
1228
1229 /**
1230  * struct iwl_set_calib_default_cmd - set default value for calibration.
1231  * ( SET_CALIB_DEFAULT_CMD = 0x8e )
1232  * @calib_index: the calibration to set value for
1233  * @length: of data
1234  * @data: the value to set for the calibration result
1235  */
1236 struct iwl_set_calib_default_cmd {
1237         __le16 calib_index;
1238         __le16 length;
1239         u8 data[0];
1240 } __packed; /* PHY_CALIB_OVERRIDE_VALUES_S */
1241
1242 #define MAX_PORT_ID_NUM 2
1243 #define MAX_MCAST_FILTERING_ADDRESSES 256
1244
1245 /**
1246  * struct iwl_mcast_filter_cmd - configure multicast filter.
1247  * @filter_own: Set 1 to filter out multicast packets sent by station itself
1248  * @port_id:    Multicast MAC addresses array specifier. This is a strange way
1249  *              to identify network interface adopted in host-device IF.
1250  *              It is used by FW as index in array of addresses. This array has
1251  *              MAX_PORT_ID_NUM members.
1252  * @count:      Number of MAC addresses in the array
1253  * @pass_all:   Set 1 to pass all multicast packets.
1254  * @bssid:      current association BSSID.
1255  * @addr_list:  Place holder for array of MAC addresses.
1256  *              IMPORTANT: add padding if necessary to ensure DWORD alignment.
1257  */
1258 struct iwl_mcast_filter_cmd {
1259         u8 filter_own;
1260         u8 port_id;
1261         u8 count;
1262         u8 pass_all;
1263         u8 bssid[6];
1264         u8 reserved[2];
1265         u8 addr_list[0];
1266 } __packed; /* MCAST_FILTERING_CMD_API_S_VER_1 */
1267
1268 #define MAX_BCAST_FILTERS 8
1269 #define MAX_BCAST_FILTER_ATTRS 2
1270
1271 /**
1272  * enum iwl_mvm_bcast_filter_attr_offset - written by fw for each Rx packet
1273  * @BCAST_FILTER_OFFSET_PAYLOAD_START: offset is from payload start.
1274  * @BCAST_FILTER_OFFSET_IP_END: offset is from ip header end (i.e.
1275  *      start of ip payload).
1276  */
1277 enum iwl_mvm_bcast_filter_attr_offset {
1278         BCAST_FILTER_OFFSET_PAYLOAD_START = 0,
1279         BCAST_FILTER_OFFSET_IP_END = 1,
1280 };
1281
1282 /**
1283  * struct iwl_fw_bcast_filter_attr - broadcast filter attribute
1284  * @offset_type:        &enum iwl_mvm_bcast_filter_attr_offset.
1285  * @offset:     starting offset of this pattern.
1286  * @val:                value to match - big endian (MSB is the first
1287  *              byte to match from offset pos).
1288  * @mask:       mask to match (big endian).
1289  */
1290 struct iwl_fw_bcast_filter_attr {
1291         u8 offset_type;
1292         u8 offset;
1293         __le16 reserved1;
1294         __be32 val;
1295         __be32 mask;
1296 } __packed; /* BCAST_FILTER_ATT_S_VER_1 */
1297
1298 /**
1299  * enum iwl_mvm_bcast_filter_frame_type - filter frame type
1300  * @BCAST_FILTER_FRAME_TYPE_ALL: consider all frames.
1301  * @BCAST_FILTER_FRAME_TYPE_IPV4: consider only ipv4 frames
1302  */
1303 enum iwl_mvm_bcast_filter_frame_type {
1304         BCAST_FILTER_FRAME_TYPE_ALL = 0,
1305         BCAST_FILTER_FRAME_TYPE_IPV4 = 1,
1306 };
1307
1308 /**
1309  * struct iwl_fw_bcast_filter - broadcast filter
1310  * @discard: discard frame (1) or let it pass (0).
1311  * @frame_type: &enum iwl_mvm_bcast_filter_frame_type.
1312  * @num_attrs: number of valid attributes in this filter.
1313  * @attrs: attributes of this filter. a filter is considered matched
1314  *      only when all its attributes are matched (i.e. AND relationship)
1315  */
1316 struct iwl_fw_bcast_filter {
1317         u8 discard;
1318         u8 frame_type;
1319         u8 num_attrs;
1320         u8 reserved1;
1321         struct iwl_fw_bcast_filter_attr attrs[MAX_BCAST_FILTER_ATTRS];
1322 } __packed; /* BCAST_FILTER_S_VER_1 */
1323
1324 /**
1325  * struct iwl_fw_bcast_mac - per-mac broadcast filtering configuration.
1326  * @default_discard: default action for this mac (discard (1) / pass (0)).
1327  * @attached_filters: bitmap of relevant filters for this mac.
1328  */
1329 struct iwl_fw_bcast_mac {
1330         u8 default_discard;
1331         u8 reserved1;
1332         __le16 attached_filters;
1333 } __packed; /* BCAST_MAC_CONTEXT_S_VER_1 */
1334
1335 /**
1336  * struct iwl_bcast_filter_cmd - broadcast filtering configuration
1337  * @disable: enable (0) / disable (1)
1338  * @max_bcast_filters: max number of filters (MAX_BCAST_FILTERS)
1339  * @max_macs: max number of macs (NUM_MAC_INDEX_DRIVER)
1340  * @filters: broadcast filters
1341  * @macs: broadcast filtering configuration per-mac
1342  */
1343 struct iwl_bcast_filter_cmd {
1344         u8 disable;
1345         u8 max_bcast_filters;
1346         u8 max_macs;
1347         u8 reserved1;
1348         struct iwl_fw_bcast_filter filters[MAX_BCAST_FILTERS];
1349         struct iwl_fw_bcast_mac macs[NUM_MAC_INDEX_DRIVER];
1350 } __packed; /* BCAST_FILTERING_HCMD_API_S_VER_1 */
1351
1352 /*
1353  * enum iwl_mvm_marker_id - maker ids
1354  *
1355  * The ids for different type of markers to insert into the usniffer logs
1356  */
1357 enum iwl_mvm_marker_id {
1358         MARKER_ID_TX_FRAME_LATENCY = 1,
1359 }; /* MARKER_ID_API_E_VER_1 */
1360
1361 /**
1362  * struct iwl_mvm_marker - mark info into the usniffer logs
1363  *
1364  * (MARKER_CMD = 0xcb)
1365  *
1366  * Mark the UTC time stamp into the usniffer logs together with additional
1367  * metadata, so the usniffer output can be parsed.
1368  * In the command response the ucode will return the GP2 time.
1369  *
1370  * @dw_len: The amount of dwords following this byte including this byte.
1371  * @marker_id: A unique marker id (iwl_mvm_marker_id).
1372  * @reserved: reserved.
1373  * @timestamp: in milliseconds since 1970-01-01 00:00:00 UTC
1374  * @metadata: additional meta data that will be written to the unsiffer log
1375  */
1376 struct iwl_mvm_marker {
1377         u8 dwLen;
1378         u8 markerId;
1379         __le16 reserved;
1380         __le64 timestamp;
1381         __le32 metadata[0];
1382 } __packed; /* MARKER_API_S_VER_1 */
1383
1384 struct mvm_statistics_dbg {
1385         __le32 burst_check;
1386         __le32 burst_count;
1387         __le32 wait_for_silence_timeout_cnt;
1388         __le32 reserved[3];
1389 } __packed; /* STATISTICS_DEBUG_API_S_VER_2 */
1390
1391 struct mvm_statistics_div {
1392         __le32 tx_on_a;
1393         __le32 tx_on_b;
1394         __le32 exec_time;
1395         __le32 probe_time;
1396         __le32 rssi_ant;
1397         __le32 reserved2;
1398 } __packed; /* STATISTICS_SLOW_DIV_API_S_VER_2 */
1399
1400 struct mvm_statistics_general_common {
1401         __le32 temperature;   /* radio temperature */
1402         __le32 temperature_m; /* radio voltage */
1403         struct mvm_statistics_dbg dbg;
1404         __le32 sleep_time;
1405         __le32 slots_out;
1406         __le32 slots_idle;
1407         __le32 ttl_timestamp;
1408         struct mvm_statistics_div div;
1409         __le32 rx_enable_counter;
1410         /*
1411          * num_of_sos_states:
1412          *  count the number of times we have to re-tune
1413          *  in order to get out of bad PHY status
1414          */
1415         __le32 num_of_sos_states;
1416 } __packed; /* STATISTICS_GENERAL_API_S_VER_5 */
1417
1418 struct mvm_statistics_rx_non_phy {
1419         __le32 bogus_cts;       /* CTS received when not expecting CTS */
1420         __le32 bogus_ack;       /* ACK received when not expecting ACK */
1421         __le32 non_bssid_frames;        /* number of frames with BSSID that
1422                                          * doesn't belong to the STA BSSID */
1423         __le32 filtered_frames; /* count frames that were dumped in the
1424                                  * filtering process */
1425         __le32 non_channel_beacons;     /* beacons with our bss id but not on
1426                                          * our serving channel */
1427         __le32 channel_beacons; /* beacons with our bss id and in our
1428                                  * serving channel */
1429         __le32 num_missed_bcon; /* number of missed beacons */
1430         __le32 adc_rx_saturation_time;  /* count in 0.8us units the time the
1431                                          * ADC was in saturation */
1432         __le32 ina_detection_search_time;/* total time (in 0.8us) searched
1433                                           * for INA */
1434         __le32 beacon_silence_rssi_a;   /* RSSI silence after beacon frame */
1435         __le32 beacon_silence_rssi_b;   /* RSSI silence after beacon frame */
1436         __le32 beacon_silence_rssi_c;   /* RSSI silence after beacon frame */
1437         __le32 interference_data_flag;  /* flag for interference data
1438                                          * availability. 1 when data is
1439                                          * available. */
1440         __le32 channel_load;            /* counts RX Enable time in uSec */
1441         __le32 dsp_false_alarms;        /* DSP false alarm (both OFDM
1442                                          * and CCK) counter */
1443         __le32 beacon_rssi_a;
1444         __le32 beacon_rssi_b;
1445         __le32 beacon_rssi_c;
1446         __le32 beacon_energy_a;
1447         __le32 beacon_energy_b;
1448         __le32 beacon_energy_c;
1449         __le32 num_bt_kills;
1450         __le32 mac_id;
1451         __le32 directed_data_mpdu;
1452 } __packed; /* STATISTICS_RX_NON_PHY_API_S_VER_3 */
1453
1454 struct mvm_statistics_rx_phy {
1455         __le32 ina_cnt;
1456         __le32 fina_cnt;
1457         __le32 plcp_err;
1458         __le32 crc32_err;
1459         __le32 overrun_err;
1460         __le32 early_overrun_err;
1461         __le32 crc32_good;
1462         __le32 false_alarm_cnt;
1463         __le32 fina_sync_err_cnt;
1464         __le32 sfd_timeout;
1465         __le32 fina_timeout;
1466         __le32 unresponded_rts;
1467         __le32 rxe_frame_limit_overrun;
1468         __le32 sent_ack_cnt;
1469         __le32 sent_cts_cnt;
1470         __le32 sent_ba_rsp_cnt;
1471         __le32 dsp_self_kill;
1472         __le32 mh_format_err;
1473         __le32 re_acq_main_rssi_sum;
1474         __le32 reserved;
1475 } __packed; /* STATISTICS_RX_PHY_API_S_VER_2 */
1476
1477 struct mvm_statistics_rx_ht_phy {
1478         __le32 plcp_err;
1479         __le32 overrun_err;
1480         __le32 early_overrun_err;
1481         __le32 crc32_good;
1482         __le32 crc32_err;
1483         __le32 mh_format_err;
1484         __le32 agg_crc32_good;
1485         __le32 agg_mpdu_cnt;
1486         __le32 agg_cnt;
1487         __le32 unsupport_mcs;
1488 } __packed;  /* STATISTICS_HT_RX_PHY_API_S_VER_1 */
1489
1490 #define MAX_CHAINS 3
1491
1492 struct mvm_statistics_tx_non_phy_agg {
1493         __le32 ba_timeout;
1494         __le32 ba_reschedule_frames;
1495         __le32 scd_query_agg_frame_cnt;
1496         __le32 scd_query_no_agg;
1497         __le32 scd_query_agg;
1498         __le32 scd_query_mismatch;
1499         __le32 frame_not_ready;
1500         __le32 underrun;
1501         __le32 bt_prio_kill;
1502         __le32 rx_ba_rsp_cnt;
1503         __s8 txpower[MAX_CHAINS];
1504         __s8 reserved;
1505         __le32 reserved2;
1506 } __packed; /* STATISTICS_TX_NON_PHY_AGG_API_S_VER_1 */
1507
1508 struct mvm_statistics_tx_channel_width {
1509         __le32 ext_cca_narrow_ch20[1];
1510         __le32 ext_cca_narrow_ch40[2];
1511         __le32 ext_cca_narrow_ch80[3];
1512         __le32 ext_cca_narrow_ch160[4];
1513         __le32 last_tx_ch_width_indx;
1514         __le32 rx_detected_per_ch_width[4];
1515         __le32 success_per_ch_width[4];
1516         __le32 fail_per_ch_width[4];
1517 }; /* STATISTICS_TX_CHANNEL_WIDTH_API_S_VER_1 */
1518
1519 struct mvm_statistics_tx {
1520         __le32 preamble_cnt;
1521         __le32 rx_detected_cnt;
1522         __le32 bt_prio_defer_cnt;
1523         __le32 bt_prio_kill_cnt;
1524         __le32 few_bytes_cnt;
1525         __le32 cts_timeout;
1526         __le32 ack_timeout;
1527         __le32 expected_ack_cnt;
1528         __le32 actual_ack_cnt;
1529         __le32 dump_msdu_cnt;
1530         __le32 burst_abort_next_frame_mismatch_cnt;
1531         __le32 burst_abort_missing_next_frame_cnt;
1532         __le32 cts_timeout_collision;
1533         __le32 ack_or_ba_timeout_collision;
1534         struct mvm_statistics_tx_non_phy_agg agg;
1535         struct mvm_statistics_tx_channel_width channel_width;
1536 } __packed; /* STATISTICS_TX_API_S_VER_4 */
1537
1538
1539 struct mvm_statistics_bt_activity {
1540         __le32 hi_priority_tx_req_cnt;
1541         __le32 hi_priority_tx_denied_cnt;
1542         __le32 lo_priority_tx_req_cnt;
1543         __le32 lo_priority_tx_denied_cnt;
1544         __le32 hi_priority_rx_req_cnt;
1545         __le32 hi_priority_rx_denied_cnt;
1546         __le32 lo_priority_rx_req_cnt;
1547         __le32 lo_priority_rx_denied_cnt;
1548 } __packed;  /* STATISTICS_BT_ACTIVITY_API_S_VER_1 */
1549
1550 struct mvm_statistics_general {
1551         struct mvm_statistics_general_common common;
1552         __le32 beacon_filtered;
1553         __le32 missed_beacons;
1554         __s8 beacon_filter_average_energy;
1555         __s8 beacon_filter_reason;
1556         __s8 beacon_filter_current_energy;
1557         __s8 beacon_filter_reserved;
1558         __le32 beacon_filter_delta_time;
1559         struct mvm_statistics_bt_activity bt_activity;
1560 } __packed; /* STATISTICS_GENERAL_API_S_VER_5 */
1561
1562 struct mvm_statistics_rx {
1563         struct mvm_statistics_rx_phy ofdm;
1564         struct mvm_statistics_rx_phy cck;
1565         struct mvm_statistics_rx_non_phy general;
1566         struct mvm_statistics_rx_ht_phy ofdm_ht;
1567 } __packed; /* STATISTICS_RX_API_S_VER_3 */
1568
1569 /*
1570  * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
1571  *
1572  * By default, uCode issues this notification after receiving a beacon
1573  * while associated.  To disable this behavior, set DISABLE_NOTIF flag in the
1574  * REPLY_STATISTICS_CMD 0x9c, above.
1575  *
1576  * Statistics counters continue to increment beacon after beacon, but are
1577  * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
1578  * 0x9c with CLEAR_STATS bit set (see above).
1579  *
1580  * uCode also issues this notification during scans.  uCode clears statistics
1581  * appropriately so that each notification contains statistics for only the
1582  * one channel that has just been scanned.
1583  */
1584
1585 struct iwl_notif_statistics { /* STATISTICS_NTFY_API_S_VER_8 */
1586         __le32 flag;
1587         struct mvm_statistics_rx rx;
1588         struct mvm_statistics_tx tx;
1589         struct mvm_statistics_general general;
1590 } __packed;
1591
1592 /***********************************
1593  * Smart Fifo API
1594  ***********************************/
1595 /* Smart Fifo state */
1596 enum iwl_sf_state {
1597         SF_LONG_DELAY_ON = 0, /* should never be called by driver */
1598         SF_FULL_ON,
1599         SF_UNINIT,
1600         SF_INIT_OFF,
1601         SF_HW_NUM_STATES
1602 };
1603
1604 /* Smart Fifo possible scenario */
1605 enum iwl_sf_scenario {
1606         SF_SCENARIO_SINGLE_UNICAST,
1607         SF_SCENARIO_AGG_UNICAST,
1608         SF_SCENARIO_MULTICAST,
1609         SF_SCENARIO_BA_RESP,
1610         SF_SCENARIO_TX_RESP,
1611         SF_NUM_SCENARIO
1612 };
1613
1614 #define SF_TRANSIENT_STATES_NUMBER 2    /* SF_LONG_DELAY_ON and SF_FULL_ON */
1615 #define SF_NUM_TIMEOUT_TYPES 2          /* Aging timer and Idle timer */
1616
1617 /* smart FIFO default values */
1618 #define SF_W_MARK_SISO 6144
1619 #define SF_W_MARK_MIMO2 8192
1620 #define SF_W_MARK_MIMO3 6144
1621 #define SF_W_MARK_LEGACY 4096
1622 #define SF_W_MARK_SCAN 4096
1623
1624 /* SF Scenarios timers for FULL_ON state (aligned to 32 uSec) */
1625 #define SF_SINGLE_UNICAST_IDLE_TIMER 320        /* 300 uSec  */
1626 #define SF_SINGLE_UNICAST_AGING_TIMER 2016      /* 2 mSec */
1627 #define SF_AGG_UNICAST_IDLE_TIMER 320           /* 300 uSec */
1628 #define SF_AGG_UNICAST_AGING_TIMER 2016         /* 2 mSec */
1629 #define SF_MCAST_IDLE_TIMER 2016                /* 2 mSec */
1630 #define SF_MCAST_AGING_TIMER 10016              /* 10 mSec */
1631 #define SF_BA_IDLE_TIMER 320                    /* 300 uSec */
1632 #define SF_BA_AGING_TIMER 2016                  /* 2 mSec */
1633 #define SF_TX_RE_IDLE_TIMER 320                 /* 300 uSec */
1634 #define SF_TX_RE_AGING_TIMER 2016               /* 2 mSec */
1635
1636 #define SF_LONG_DELAY_AGING_TIMER 1000000       /* 1 Sec */
1637
1638 #define SF_CFG_DUMMY_NOTIF_OFF  BIT(16)
1639
1640 /**
1641  * Smart Fifo configuration command.
1642  * @state: smart fifo state, types listed in enum %iwl_sf_sate.
1643  * @watermark: Minimum allowed availabe free space in RXF for transient state.
1644  * @long_delay_timeouts: aging and idle timer values for each scenario
1645  * in long delay state.
1646  * @full_on_timeouts: timer values for each scenario in full on state.
1647  */
1648 struct iwl_sf_cfg_cmd {
1649         __le32 state;
1650         __le32 watermark[SF_TRANSIENT_STATES_NUMBER];
1651         __le32 long_delay_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES];
1652         __le32 full_on_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES];
1653 } __packed; /* SF_CFG_API_S_VER_2 */
1654
1655 /* DTS measurements */
1656
1657 enum iwl_dts_measurement_flags {
1658         DTS_TRIGGER_CMD_FLAGS_TEMP      = BIT(0),
1659         DTS_TRIGGER_CMD_FLAGS_VOLT      = BIT(1),
1660 };
1661
1662 /**
1663  * iwl_dts_measurement_cmd - request DTS temperature and/or voltage measurements
1664  *
1665  * @flags: indicates which measurements we want as specified in &enum
1666  *         iwl_dts_measurement_flags
1667  */
1668 struct iwl_dts_measurement_cmd {
1669         __le32 flags;
1670 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_CMD_S */
1671
1672 /**
1673  * iwl_dts_measurement_notif - notification received with the measurements
1674  *
1675  * @temp: the measured temperature
1676  * @voltage: the measured voltage
1677  */
1678 struct iwl_dts_measurement_notif {
1679         __le32 temp;
1680         __le32 voltage;
1681 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_NTFY_S */
1682
1683 /**
1684  * enum iwl_scd_control - scheduler config command control flags
1685  * @IWL_SCD_CONTROL_RM_TID: remove TID from this queue
1686  * @IWL_SCD_CONTROL_SET_SSN: use the SSN and program it into HW
1687  */
1688 enum iwl_scd_control {
1689         IWL_SCD_CONTROL_RM_TID  = BIT(4),
1690         IWL_SCD_CONTROL_SET_SSN = BIT(5),
1691 };
1692
1693 /**
1694  * enum iwl_scd_flags - scheduler config command flags
1695  * @IWL_SCD_FLAGS_SHARE_TID: multiple TIDs map to this queue
1696  * @IWL_SCD_FLAGS_SHARE_RA: multiple RAs map to this queue
1697  * @IWL_SCD_FLAGS_DQA_ENABLED: DQA is enabled
1698  */
1699 enum iwl_scd_flags {
1700         IWL_SCD_FLAGS_SHARE_TID         = BIT(0),
1701         IWL_SCD_FLAGS_SHARE_RA          = BIT(1),
1702         IWL_SCD_FLAGS_DQA_ENABLED       = BIT(2),
1703 };
1704
1705 #define IWL_SCDQ_INVALID_STA    0xff
1706
1707 /**
1708  * struct iwl_scd_txq_cfg_cmd - New txq hw scheduler config command
1709  * @token:      dialog token addba - unused legacy
1710  * @sta_id:     station id 4-bit
1711  * @tid:        TID 0..7
1712  * @scd_queue:  TFD queue num 0 .. 31
1713  * @enable:     1 queue enable, 0 queue disable
1714  * @aggregate:  1 aggregated queue, 0 otherwise
1715  * @tx_fifo:    tx fifo num 0..7
1716  * @window:     up to 64
1717  * @ssn:        starting seq num 12-bit
1718  * @control:    command control flags
1719  * @flags:      flags - see &enum iwl_scd_flags
1720  *
1721  * Note that every time the command is sent, all parameters must
1722  * be filled with the exception of
1723  *  - the SSN, which is only used with @IWL_SCD_CONTROL_SET_SSN
1724  *  - the window, which is only relevant when starting aggregation
1725  */
1726 struct iwl_scd_txq_cfg_cmd {
1727         u8 token;
1728         u8 sta_id;
1729         u8 tid;
1730         u8 scd_queue;
1731         u8 enable;
1732         u8 aggregate;
1733         u8 tx_fifo;
1734         u8 window;
1735         __le16 ssn;
1736         u8 control;
1737         u8 flags;
1738 } __packed;
1739
1740 /***********************************
1741  * TDLS API
1742  ***********************************/
1743
1744 /* Type of TDLS request */
1745 enum iwl_tdls_channel_switch_type {
1746         TDLS_SEND_CHAN_SW_REQ = 0,
1747         TDLS_SEND_CHAN_SW_RESP_AND_MOVE_CH,
1748         TDLS_MOVE_CH,
1749 }; /* TDLS_STA_CHANNEL_SWITCH_CMD_TYPE_API_E_VER_1 */
1750
1751 /**
1752  * Switch timing sub-element in a TDLS channel-switch command
1753  * @frame_timestamp: GP2 timestamp of channel-switch request/response packet
1754  *      received from peer
1755  * @max_offchan_duration: What amount of microseconds out of a DTIM is given
1756  *      to the TDLS off-channel communication. For instance if the DTIM is
1757  *      200TU and the TDLS peer is to be given 25% of the time, the value
1758  *      given will be 50TU, or 50 * 1024 if translated into microseconds.
1759  * @switch_time: switch time the peer sent in its channel switch timing IE
1760  * @switch_timout: switch timeout the peer sent in its channel switch timing IE
1761  */
1762 struct iwl_tdls_channel_switch_timing {
1763         __le32 frame_timestamp; /* GP2 time of peer packet Rx */
1764         __le32 max_offchan_duration; /* given in micro-seconds */
1765         __le32 switch_time; /* given in micro-seconds */
1766         __le32 switch_timeout; /* given in micro-seconds */
1767 } __packed; /* TDLS_STA_CHANNEL_SWITCH_TIMING_DATA_API_S_VER_1 */
1768
1769 #define IWL_TDLS_CH_SW_FRAME_MAX_SIZE 200
1770
1771 /**
1772  * TDLS channel switch frame template
1773  *
1774  * A template representing a TDLS channel-switch request or response frame
1775  *
1776  * @switch_time_offset: offset to the channel switch timing IE in the template
1777  * @tx_cmd: Tx parameters for the frame
1778  * @data: frame data
1779  */
1780 struct iwl_tdls_channel_switch_frame {
1781         __le32 switch_time_offset;
1782         struct iwl_tx_cmd tx_cmd;
1783         u8 data[IWL_TDLS_CH_SW_FRAME_MAX_SIZE];
1784 } __packed; /* TDLS_STA_CHANNEL_SWITCH_FRAME_API_S_VER_1 */
1785
1786 /**
1787  * TDLS channel switch command
1788  *
1789  * The command is sent to initiate a channel switch and also in response to
1790  * incoming TDLS channel-switch request/response packets from remote peers.
1791  *
1792  * @switch_type: see &enum iwl_tdls_channel_switch_type
1793  * @peer_sta_id: station id of TDLS peer
1794  * @ci: channel we switch to
1795  * @timing: timing related data for command
1796  * @frame: channel-switch request/response template, depending to switch_type
1797  */
1798 struct iwl_tdls_channel_switch_cmd {
1799         u8 switch_type;
1800         __le32 peer_sta_id;
1801         struct iwl_fw_channel_info ci;
1802         struct iwl_tdls_channel_switch_timing timing;
1803         struct iwl_tdls_channel_switch_frame frame;
1804 } __packed; /* TDLS_STA_CHANNEL_SWITCH_CMD_API_S_VER_1 */
1805
1806 /**
1807  * TDLS channel switch start notification
1808  *
1809  * @status: non-zero on success
1810  * @offchannel_duration: duration given in microseconds
1811  * @sta_id: peer currently performing the channel-switch with
1812  */
1813 struct iwl_tdls_channel_switch_notif {
1814         __le32 status;
1815         __le32 offchannel_duration;
1816         __le32 sta_id;
1817 } __packed; /* TDLS_STA_CHANNEL_SWITCH_NTFY_API_S_VER_1 */
1818
1819 /**
1820  * TDLS station info
1821  *
1822  * @sta_id: station id of the TDLS peer
1823  * @tx_to_peer_tid: TID reserved vs. the peer for FW based Tx
1824  * @tx_to_peer_ssn: initial SSN the FW should use for Tx on its TID vs the peer
1825  * @is_initiator: 1 if the peer is the TDLS link initiator, 0 otherwise
1826  */
1827 struct iwl_tdls_sta_info {
1828         u8 sta_id;
1829         u8 tx_to_peer_tid;
1830         __le16 tx_to_peer_ssn;
1831         __le32 is_initiator;
1832 } __packed; /* TDLS_STA_INFO_VER_1 */
1833
1834 /**
1835  * TDLS basic config command
1836  *
1837  * @id_and_color: MAC id and color being configured
1838  * @tdls_peer_count: amount of currently connected TDLS peers
1839  * @tx_to_ap_tid: TID reverved vs. the AP for FW based Tx
1840  * @tx_to_ap_ssn: initial SSN the FW should use for Tx on its TID vs. the AP
1841  * @sta_info: per-station info. Only the first tdls_peer_count entries are set
1842  * @pti_req_data_offset: offset of network-level data for the PTI template
1843  * @pti_req_tx_cmd: Tx parameters for PTI request template
1844  * @pti_req_template: PTI request template data
1845  */
1846 struct iwl_tdls_config_cmd {
1847         __le32 id_and_color; /* mac id and color */
1848         u8 tdls_peer_count;
1849         u8 tx_to_ap_tid;
1850         __le16 tx_to_ap_ssn;
1851         struct iwl_tdls_sta_info sta_info[IWL_MVM_TDLS_STA_COUNT];
1852
1853         __le32 pti_req_data_offset;
1854         struct iwl_tx_cmd pti_req_tx_cmd;
1855         u8 pti_req_template[0];
1856 } __packed; /* TDLS_CONFIG_CMD_API_S_VER_1 */
1857
1858 /**
1859  * TDLS per-station config information from FW
1860  *
1861  * @sta_id: station id of the TDLS peer
1862  * @tx_to_peer_last_seq: last sequence number used by FW during FW-based Tx to
1863  *      the peer
1864  */
1865 struct iwl_tdls_config_sta_info_res {
1866         __le16 sta_id;
1867         __le16 tx_to_peer_last_seq;
1868 } __packed; /* TDLS_STA_INFO_RSP_VER_1 */
1869
1870 /**
1871  * TDLS config information from FW
1872  *
1873  * @tx_to_ap_last_seq: last sequence number used by FW during FW-based Tx to AP
1874  * @sta_info: per-station TDLS config information
1875  */
1876 struct iwl_tdls_config_res {
1877         __le32 tx_to_ap_last_seq;
1878         struct iwl_tdls_config_sta_info_res sta_info[IWL_MVM_TDLS_STA_COUNT];
1879 } __packed; /* TDLS_CONFIG_RSP_API_S_VER_1 */
1880
1881 #endif /* __fw_api_h__ */