drivers/net/wireless/intel/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 - 2015 Intel Mobile Communications GmbH
  10  * Copyright(c) 2016        Intel Deutschland GmbH
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of version 2 of the GNU General Public License as
  14  * published by the Free Software Foundation.
  15  *
  16  * This program is distributed in the hope that it will be useful, but
  17  * WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  24  * USA
  25  *
  26  * The full GNU General Public License is included in this distribution
  27  * in the file called COPYING.
  28  *
  29  * Contact Information:
  30  *  Intel Linux Wireless <linuxwifi@intel.com>
  31  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  32  *
  33  * BSD LICENSE
  34  *
  35  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
  36  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
  37  * Copyright(c) 2016        Intel Deutschland GmbH
  38  * All rights reserved.
  39  *
  40  * Redistribution and use in source and binary forms, with or without
  41  * modification, are permitted provided that the following conditions
  42  * are met:
  43  *
  44  *  * Redistributions of source code must retain the above copyright
  45  *    notice, this list of conditions and the following disclaimer.
  46  *  * Redistributions in binary form must reproduce the above copyright
  47  *    notice, this list of conditions and the following disclaimer in
  48  *    the documentation and/or other materials provided with the
  49  *    distribution.
  50  *  * Neither the name Intel Corporation nor the names of its
  51  *    contributors may be used to endorse or promote products derived
  52  *    from this software without specific prior written permission.
  53  *
  54  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  55  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  56  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  57  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  58  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  59  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  60  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  61  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  62  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  63  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  64  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  65  *
  66  *****************************************************************************/
  67
  68 #ifndef __fw_api_h__
  69 #define __fw_api_h__
  70
  71 #include "fw-api-rs.h"
  72 #include "fw-api-rx.h"
  73 #include "fw-api-tx.h"
  74 #include "fw-api-sta.h"
  75 #include "fw-api-mac.h"
  76 #include "fw-api-power.h"
  77 #include "fw-api-d3.h"
  78 #include "fw-api-coex.h"
  79 #include "fw-api-scan.h"
  80 #include "fw-api-stats.h"
  81 #include "fw-api-tof.h"
  82
  83 /* Tx queue numbers for non-DQA mode */
  84 enum {
  85         IWL_MVM_OFFCHANNEL_QUEUE = 8,
  86         IWL_MVM_CMD_QUEUE = 9,
  87 };
  88
  89 /*
  90  * DQA queue numbers
  91  *
  92  * @IWL_MVM_DQA_CMD_QUEUE: a queue reserved for sending HCMDs to the FW
  93  * @IWL_MVM_DQA_P2P_DEVICE_QUEUE: a queue reserved for P2P device frames
  94  * @IWL_MVM_DQA_GCAST_QUEUE: a queue reserved for P2P GO/SoftAP GCAST frames
  95  * @IWL_MVM_DQA_BSS_CLIENT_QUEUE: a queue reserved for BSS activity, to ensure
  96  *      that we are never left without the possibility to connect to an AP.
  97  * @IWL_MVM_DQA_MIN_MGMT_QUEUE: first TXQ in pool for MGMT and non-QOS frames.
  98  *      Each MGMT queue is mapped to a single STA
  99  *      MGMT frames are frames that return true on ieee80211_is_mgmt()
 100  * @IWL_MVM_DQA_MAX_MGMT_QUEUE: last TXQ in pool for MGMT frames
 101  * @IWL_MVM_DQA_AP_PROBE_RESP_QUEUE: a queue reserved for P2P GO/SoftAP probe
 102  *      responses
 103  * @IWL_MVM_DQA_MIN_DATA_QUEUE: first TXQ in pool for DATA frames.
 104  *      DATA frames are intended for !ieee80211_is_mgmt() frames, but if
 105  *      the MGMT TXQ pool is exhausted, mgmt frames can be sent on DATA queues
 106  *      as well
 107  * @IWL_MVM_DQA_MAX_DATA_QUEUE: last TXQ in pool for DATA frames
 108  */
 109 enum iwl_mvm_dqa_txq {
 110         IWL_MVM_DQA_CMD_QUEUE = 0,
 111         IWL_MVM_DQA_P2P_DEVICE_QUEUE = 2,
 112         IWL_MVM_DQA_GCAST_QUEUE = 3,
 113         IWL_MVM_DQA_BSS_CLIENT_QUEUE = 4,
 114         IWL_MVM_DQA_MIN_MGMT_QUEUE = 5,
 115         IWL_MVM_DQA_MAX_MGMT_QUEUE = 8,
 116         IWL_MVM_DQA_AP_PROBE_RESP_QUEUE = 9,
 117         IWL_MVM_DQA_MIN_DATA_QUEUE = 10,
 118         IWL_MVM_DQA_MAX_DATA_QUEUE = 31,
 119 };
 120
 121 enum iwl_mvm_tx_fifo {
 122         IWL_MVM_TX_FIFO_BK = 0,
 123         IWL_MVM_TX_FIFO_BE,
 124         IWL_MVM_TX_FIFO_VI,
 125         IWL_MVM_TX_FIFO_VO,
 126         IWL_MVM_TX_FIFO_MCAST = 5,
 127         IWL_MVM_TX_FIFO_CMD = 7,
 128 };
 129
 130 #define IWL_MVM_STATION_COUNT   16
 131
 132 #define IWL_MVM_TDLS_STA_COUNT  4
 133
 134 /* commands */
 135 enum {
 136         MVM_ALIVE = 0x1,
 137         REPLY_ERROR = 0x2,
 138         ECHO_CMD = 0x3,
 139
 140         INIT_COMPLETE_NOTIF = 0x4,
 141
 142         /* PHY context commands */
 143         PHY_CONTEXT_CMD = 0x8,
 144         DBG_CFG = 0x9,
 145         ANTENNA_COUPLING_NOTIFICATION = 0xa,
 146
 147         /* UMAC scan commands */
 148         SCAN_ITERATION_COMPLETE_UMAC = 0xb5,
 149         SCAN_CFG_CMD = 0xc,
 150         SCAN_REQ_UMAC = 0xd,
 151         SCAN_ABORT_UMAC = 0xe,
 152         SCAN_COMPLETE_UMAC = 0xf,
 153
 154         BA_WINDOW_STATUS_NOTIFICATION_ID = 0x13,
 155
 156         /* station table */
 157         ADD_STA_KEY = 0x17,
 158         ADD_STA = 0x18,
 159         REMOVE_STA = 0x19,
 160
 161         /* paging get item */
 162         FW_GET_ITEM_CMD = 0x1a,
 163
 164         /* TX */
 165         TX_CMD = 0x1c,
 166         TXPATH_FLUSH = 0x1e,
 167         MGMT_MCAST_KEY = 0x1f,
 168
 169         /* scheduler config */
 170         SCD_QUEUE_CFG = 0x1d,
 171
 172         /* global key */
 173         WEP_KEY = 0x20,
 174
 175         /* Memory */
 176         SHARED_MEM_CFG = 0x25,
 177
 178         /* TDLS */
 179         TDLS_CHANNEL_SWITCH_CMD = 0x27,
 180         TDLS_CHANNEL_SWITCH_NOTIFICATION = 0xaa,
 181         TDLS_CONFIG_CMD = 0xa7,
 182
 183         /* MAC and Binding commands */
 184         MAC_CONTEXT_CMD = 0x28,
 185         TIME_EVENT_CMD = 0x29, /* both CMD and response */
 186         TIME_EVENT_NOTIFICATION = 0x2a,
 187         BINDING_CONTEXT_CMD = 0x2b,
 188         TIME_QUOTA_CMD = 0x2c,
 189         NON_QOS_TX_COUNTER_CMD = 0x2d,
 190
 191         LQ_CMD = 0x4e,
 192
 193         /* paging block to FW cpu2 */
 194         FW_PAGING_BLOCK_CMD = 0x4f,
 195
 196         /* Scan offload */
 197         SCAN_OFFLOAD_REQUEST_CMD = 0x51,
 198         SCAN_OFFLOAD_ABORT_CMD = 0x52,
 199         HOT_SPOT_CMD = 0x53,
 200         SCAN_OFFLOAD_COMPLETE = 0x6D,
 201         SCAN_OFFLOAD_UPDATE_PROFILES_CMD = 0x6E,
 202         SCAN_OFFLOAD_CONFIG_CMD = 0x6f,
 203         MATCH_FOUND_NOTIFICATION = 0xd9,
 204         SCAN_ITERATION_COMPLETE = 0xe7,
 205
 206         /* Phy */
 207         PHY_CONFIGURATION_CMD = 0x6a,
 208         CALIB_RES_NOTIF_PHY_DB = 0x6b,
 209         /* PHY_DB_CMD = 0x6c, */
 210
 211         /* ToF - 802.11mc FTM */
 212         TOF_CMD = 0x10,
 213         TOF_NOTIFICATION = 0x11,
 214
 215         /* Power - legacy power table command */
 216         POWER_TABLE_CMD = 0x77,
 217         PSM_UAPSD_AP_MISBEHAVING_NOTIFICATION = 0x78,
 218         LTR_CONFIG = 0xee,
 219
 220         /* Thermal Throttling*/
 221         REPLY_THERMAL_MNG_BACKOFF = 0x7e,
 222
 223         /* Set/Get DC2DC frequency tune */
 224         DC2DC_CONFIG_CMD = 0x83,
 225
 226         /* NVM */
 227         NVM_ACCESS_CMD = 0x88,
 228
 229         SET_CALIB_DEFAULT_CMD = 0x8e,
 230
 231         BEACON_NOTIFICATION = 0x90,
 232         BEACON_TEMPLATE_CMD = 0x91,
 233         TX_ANT_CONFIGURATION_CMD = 0x98,
 234         STATISTICS_CMD = 0x9c,
 235         STATISTICS_NOTIFICATION = 0x9d,
 236         EOSP_NOTIFICATION = 0x9e,
 237         REDUCE_TX_POWER_CMD = 0x9f,
 238
 239         /* RF-KILL commands and notifications */
 240         CARD_STATE_CMD = 0xa0,
 241         CARD_STATE_NOTIFICATION = 0xa1,
 242
 243         MISSED_BEACONS_NOTIFICATION = 0xa2,
 244
 245         /* Power - new power table command */
 246         MAC_PM_POWER_TABLE = 0xa9,
 247
 248         MFUART_LOAD_NOTIFICATION = 0xb1,
 249
 250         RSS_CONFIG_CMD = 0xb3,
 251
 252         REPLY_RX_PHY_CMD = 0xc0,
 253         REPLY_RX_MPDU_CMD = 0xc1,
 254         FRAME_RELEASE = 0xc3,
 255         BA_NOTIF = 0xc5,
 256
 257         /* Location Aware Regulatory */
 258         MCC_UPDATE_CMD = 0xc8,
 259         MCC_CHUB_UPDATE_CMD = 0xc9,
 260
 261         MARKER_CMD = 0xcb,
 262
 263         /* BT Coex */
 264         BT_COEX_PRIO_TABLE = 0xcc,
 265         BT_COEX_PROT_ENV = 0xcd,
 266         BT_PROFILE_NOTIFICATION = 0xce,
 267         BT_CONFIG = 0x9b,
 268         BT_COEX_UPDATE_SW_BOOST = 0x5a,
 269         BT_COEX_UPDATE_CORUN_LUT = 0x5b,
 270         BT_COEX_UPDATE_REDUCED_TXP = 0x5c,
 271         BT_COEX_CI = 0x5d,
 272
 273         REPLY_SF_CFG_CMD = 0xd1,
 274         REPLY_BEACON_FILTERING_CMD = 0xd2,
 275
 276         /* DTS measurements */
 277         CMD_DTS_MEASUREMENT_TRIGGER = 0xdc,
 278         DTS_MEASUREMENT_NOTIFICATION = 0xdd,
 279
 280         REPLY_DEBUG_CMD = 0xf0,
 281         LDBG_CONFIG_CMD = 0xf6,
 282         DEBUG_LOG_MSG = 0xf7,
 283
 284         BCAST_FILTER_CMD = 0xcf,
 285         MCAST_FILTER_CMD = 0xd0,
 286
 287         /* D3 commands/notifications */
 288         D3_CONFIG_CMD = 0xd3,
 289         PROT_OFFLOAD_CONFIG_CMD = 0xd4,
 290         OFFLOADS_QUERY_CMD = 0xd5,
 291         REMOTE_WAKE_CONFIG_CMD = 0xd6,
 292         D0I3_END_CMD = 0xed,
 293
 294         /* for WoWLAN in particular */
 295         WOWLAN_PATTERNS = 0xe0,
 296         WOWLAN_CONFIGURATION = 0xe1,
 297         WOWLAN_TSC_RSC_PARAM = 0xe2,
 298         WOWLAN_TKIP_PARAM = 0xe3,
 299         WOWLAN_KEK_KCK_MATERIAL = 0xe4,
 300         WOWLAN_GET_STATUSES = 0xe5,
 301         WOWLAN_TX_POWER_PER_DB = 0xe6,
 302
 303         /* and for NetDetect */
 304         SCAN_OFFLOAD_PROFILES_QUERY_CMD = 0x56,
 305         SCAN_OFFLOAD_HOTSPOTS_CONFIG_CMD = 0x58,
 306         SCAN_OFFLOAD_HOTSPOTS_QUERY_CMD = 0x59,
 307
 308         REPLY_MAX = 0xff,
 309 };
 310
 311 /* Please keep this enum *SORTED* by hex value.
 312  * Needed for binary search, otherwise a warning will be triggered.
 313  */
 314 enum iwl_mac_conf_subcmd_ids {
 315         LINK_QUALITY_MEASUREMENT_CMD = 0x1,
 316         LINK_QUALITY_MEASUREMENT_COMPLETE_NOTIF = 0xFE,
 317         CHANNEL_SWITCH_NOA_NOTIF = 0xFF,
 318 };
 319
 320 enum iwl_phy_ops_subcmd_ids {
 321         CMD_DTS_MEASUREMENT_TRIGGER_WIDE = 0x0,
 322         CTDP_CONFIG_CMD = 0x03,
 323         TEMP_REPORTING_THRESHOLDS_CMD = 0x04,
 324         CT_KILL_NOTIFICATION = 0xFE,
 325         DTS_MEASUREMENT_NOTIF_WIDE = 0xFF,
 326 };
 327
 328 enum iwl_system_subcmd_ids {
 329         SHARED_MEM_CFG_CMD = 0x0,
 330 };
 331
 332 enum iwl_data_path_subcmd_ids {
 333         UPDATE_MU_GROUPS_CMD = 0x1,
 334         TRIGGER_RX_QUEUES_NOTIF_CMD = 0x2,
 335         MU_GROUP_MGMT_NOTIF = 0xFE,
 336         RX_QUEUES_NOTIFICATION = 0xFF,
 337 };
 338
 339 enum iwl_prot_offload_subcmd_ids {
 340         STORED_BEACON_NTF = 0xFF,
 341 };
 342
 343 /* command groups */
 344 enum {
 345         LEGACY_GROUP = 0x0,
 346         LONG_GROUP = 0x1,
 347         SYSTEM_GROUP = 0x2,
 348         MAC_CONF_GROUP = 0x3,
 349         PHY_OPS_GROUP = 0x4,
 350         DATA_PATH_GROUP = 0x5,
 351         PROT_OFFLOAD_GROUP = 0xb,
 352 };
 353
 354 /**
 355  * struct iwl_cmd_response - generic response struct for most commands
 356  * @status: status of the command asked, changes for each one
 357  */
 358 struct iwl_cmd_response {
 359         __le32 status;
 360 };
 361
 362 /*
 363  * struct iwl_tx_ant_cfg_cmd
 364  * @valid: valid antenna configuration
 365  */
 366 struct iwl_tx_ant_cfg_cmd {
 367         __le32 valid;
 368 } __packed;
 369
 370 /*
 371  * Calibration control struct.
 372  * Sent as part of the phy configuration command.
 373  * @flow_trigger: bitmap for which calibrations to perform according to
 374  *              flow triggers.
 375  * @event_trigger: bitmap for which calibrations to perform according to
 376  *              event triggers.
 377  */
 378 struct iwl_calib_ctrl {
 379         __le32 flow_trigger;
 380         __le32 event_trigger;
 381 } __packed;
 382
 383 /* This enum defines the bitmap of various calibrations to enable in both
 384  * init ucode and runtime ucode through CALIBRATION_CFG_CMD.
 385  */
 386 enum iwl_calib_cfg {
 387         IWL_CALIB_CFG_XTAL_IDX                  = BIT(0),
 388         IWL_CALIB_CFG_TEMPERATURE_IDX           = BIT(1),
 389         IWL_CALIB_CFG_VOLTAGE_READ_IDX          = BIT(2),
 390         IWL_CALIB_CFG_PAPD_IDX                  = BIT(3),
 391         IWL_CALIB_CFG_TX_PWR_IDX                = BIT(4),
 392         IWL_CALIB_CFG_DC_IDX                    = BIT(5),
 393         IWL_CALIB_CFG_BB_FILTER_IDX             = BIT(6),
 394         IWL_CALIB_CFG_LO_LEAKAGE_IDX            = BIT(7),
 395         IWL_CALIB_CFG_TX_IQ_IDX                 = BIT(8),
 396         IWL_CALIB_CFG_TX_IQ_SKEW_IDX            = BIT(9),
 397         IWL_CALIB_CFG_RX_IQ_IDX                 = BIT(10),
 398         IWL_CALIB_CFG_RX_IQ_SKEW_IDX            = BIT(11),
 399         IWL_CALIB_CFG_SENSITIVITY_IDX           = BIT(12),
 400         IWL_CALIB_CFG_CHAIN_NOISE_IDX           = BIT(13),
 401         IWL_CALIB_CFG_DISCONNECTED_ANT_IDX      = BIT(14),
 402         IWL_CALIB_CFG_ANT_COUPLING_IDX          = BIT(15),
 403         IWL_CALIB_CFG_DAC_IDX                   = BIT(16),
 404         IWL_CALIB_CFG_ABS_IDX                   = BIT(17),
 405         IWL_CALIB_CFG_AGC_IDX                   = BIT(18),
 406 };
 407
 408 /*
 409  * Phy configuration command.
 410  */
 411 struct iwl_phy_cfg_cmd {
 412         __le32  phy_cfg;
 413         struct iwl_calib_ctrl calib_control;
 414 } __packed;
 415
 416 #define PHY_CFG_RADIO_TYPE      (BIT(0) | BIT(1))
 417 #define PHY_CFG_RADIO_STEP      (BIT(2) | BIT(3))
 418 #define PHY_CFG_RADIO_DASH      (BIT(4) | BIT(5))
 419 #define PHY_CFG_PRODUCT_NUMBER  (BIT(6) | BIT(7))
 420 #define PHY_CFG_TX_CHAIN_A      BIT(8)
 421 #define PHY_CFG_TX_CHAIN_B      BIT(9)
 422 #define PHY_CFG_TX_CHAIN_C      BIT(10)
 423 #define PHY_CFG_RX_CHAIN_A      BIT(12)
 424 #define PHY_CFG_RX_CHAIN_B      BIT(13)
 425 #define PHY_CFG_RX_CHAIN_C      BIT(14)
 426
 427
 428 /* Target of the NVM_ACCESS_CMD */
 429 enum {
 430         NVM_ACCESS_TARGET_CACHE = 0,
 431         NVM_ACCESS_TARGET_OTP = 1,
 432         NVM_ACCESS_TARGET_EEPROM = 2,
 433 };
 434
 435 /* Section types for NVM_ACCESS_CMD */
 436 enum {
 437         NVM_SECTION_TYPE_SW = 1,
 438         NVM_SECTION_TYPE_REGULATORY = 3,
 439         NVM_SECTION_TYPE_CALIBRATION = 4,
 440         NVM_SECTION_TYPE_PRODUCTION = 5,
 441         NVM_SECTION_TYPE_MAC_OVERRIDE = 11,
 442         NVM_SECTION_TYPE_PHY_SKU = 12,
 443         NVM_MAX_NUM_SECTIONS = 13,
 444 };
 445
 446 /**
 447  * struct iwl_nvm_access_cmd_ver2 - Request the device to send an NVM section
 448  * @op_code: 0 - read, 1 - write
 449  * @target: NVM_ACCESS_TARGET_*
 450  * @type: NVM_SECTION_TYPE_*
 451  * @offset: offset in bytes into the section
 452  * @length: in bytes, to read/write
 453  * @data: if write operation, the data to write. On read its empty
 454  */
 455 struct iwl_nvm_access_cmd {
 456         u8 op_code;
 457         u8 target;
 458         __le16 type;
 459         __le16 offset;
 460         __le16 length;
 461         u8 data[];
 462 } __packed; /* NVM_ACCESS_CMD_API_S_VER_2 */
 463
 464 #define NUM_OF_FW_PAGING_BLOCKS 33 /* 32 for data and 1 block for CSS */
 465
 466 /*
 467  * struct iwl_fw_paging_cmd - paging layout
 468  *
 469  * (FW_PAGING_BLOCK_CMD = 0x4f)
 470  *
 471  * Send to FW the paging layout in the driver.
 472  *
 473  * @flags: various flags for the command
 474  * @block_size: the block size in powers of 2
 475  * @block_num: number of blocks specified in the command.
 476  * @device_phy_addr: virtual addresses from device side
 477 */
 478 struct iwl_fw_paging_cmd {
 479         __le32 flags;
 480         __le32 block_size;
 481         __le32 block_num;
 482         __le32 device_phy_addr[NUM_OF_FW_PAGING_BLOCKS];
 483 } __packed; /* FW_PAGING_BLOCK_CMD_API_S_VER_1 */
 484
 485 /*
 486  * Fw items ID's
 487  *
 488  * @IWL_FW_ITEM_ID_PAGING: Address of the pages that the FW will upload
 489  *      download
 490  */
 491 enum iwl_fw_item_id {
 492         IWL_FW_ITEM_ID_PAGING = 3,
 493 };
 494
 495 /*
 496  * struct iwl_fw_get_item_cmd - get an item from the fw
 497  */
 498 struct iwl_fw_get_item_cmd {
 499         __le32 item_id;
 500 } __packed; /* FW_GET_ITEM_CMD_API_S_VER_1 */
 501
 502 #define CONT_REC_COMMAND_SIZE   80
 503 #define ENABLE_CONT_RECORDING   0x15
 504 #define DISABLE_CONT_RECORDING  0x16
 505
 506 /*
 507  * struct iwl_continuous_record_mode - recording mode
 508  */
 509 struct iwl_continuous_record_mode {
 510         __le16 enable_recording;
 511 } __packed;
 512
 513 /*
 514  * struct iwl_continuous_record_cmd - enable/disable continuous recording
 515  */
 516 struct iwl_continuous_record_cmd {
 517         struct iwl_continuous_record_mode record_mode;
 518         u8 pad[CONT_REC_COMMAND_SIZE -
 519                 sizeof(struct iwl_continuous_record_mode)];
 520 } __packed;
 521
 522 struct iwl_fw_get_item_resp {
 523         __le32 item_id;
 524         __le32 item_byte_cnt;
 525         __le32 item_val;
 526 } __packed; /* FW_GET_ITEM_RSP_S_VER_1 */
 527
 528 /**
 529  * struct iwl_nvm_access_resp_ver2 - response to NVM_ACCESS_CMD
 530  * @offset: offset in bytes into the section
 531  * @length: in bytes, either how much was written or read
 532  * @type: NVM_SECTION_TYPE_*
 533  * @status: 0 for success, fail otherwise
 534  * @data: if read operation, the data returned. Empty on write.
 535  */
 536 struct iwl_nvm_access_resp {
 537         __le16 offset;
 538         __le16 length;
 539         __le16 type;
 540         __le16 status;
 541         u8 data[];
 542 } __packed; /* NVM_ACCESS_CMD_RESP_API_S_VER_2 */
 543
 544 /* MVM_ALIVE 0x1 */
 545
 546 /* alive response is_valid values */
 547 #define ALIVE_RESP_UCODE_OK     BIT(0)
 548 #define ALIVE_RESP_RFKILL       BIT(1)
 549
 550 /* alive response ver_type values */
 551 enum {
 552         FW_TYPE_HW = 0,
 553         FW_TYPE_PROT = 1,
 554         FW_TYPE_AP = 2,
 555         FW_TYPE_WOWLAN = 3,
 556         FW_TYPE_TIMING = 4,
 557         FW_TYPE_WIPAN = 5
 558 };
 559
 560 /* alive response ver_subtype values */
 561 enum {
 562         FW_SUBTYPE_FULL_FEATURE = 0,
 563         FW_SUBTYPE_BOOTSRAP = 1, /* Not valid */
 564         FW_SUBTYPE_REDUCED = 2,
 565         FW_SUBTYPE_ALIVE_ONLY = 3,
 566         FW_SUBTYPE_WOWLAN = 4,
 567         FW_SUBTYPE_AP_SUBTYPE = 5,
 568         FW_SUBTYPE_WIPAN = 6,
 569         FW_SUBTYPE_INITIALIZE = 9
 570 };
 571
 572 #define IWL_ALIVE_STATUS_ERR 0xDEAD
 573 #define IWL_ALIVE_STATUS_OK 0xCAFE
 574
 575 #define IWL_ALIVE_FLG_RFKILL    BIT(0)
 576
 577 struct mvm_alive_resp_ver1 {
 578         __le16 status;
 579         __le16 flags;
 580         u8 ucode_minor;
 581         u8 ucode_major;
 582         __le16 id;
 583         u8 api_minor;
 584         u8 api_major;
 585         u8 ver_subtype;
 586         u8 ver_type;
 587         u8 mac;
 588         u8 opt;
 589         __le16 reserved2;
 590         __le32 timestamp;
 591         __le32 error_event_table_ptr;   /* SRAM address for error log */
 592         __le32 log_event_table_ptr;     /* SRAM address for event log */
 593         __le32 cpu_register_ptr;
 594         __le32 dbgm_config_ptr;
 595         __le32 alive_counter_ptr;
 596         __le32 scd_base_ptr;            /* SRAM address for SCD */
 597 } __packed; /* ALIVE_RES_API_S_VER_1 */
 598
 599 struct mvm_alive_resp_ver2 {
 600         __le16 status;
 601         __le16 flags;
 602         u8 ucode_minor;
 603         u8 ucode_major;
 604         __le16 id;
 605         u8 api_minor;
 606         u8 api_major;
 607         u8 ver_subtype;
 608         u8 ver_type;
 609         u8 mac;
 610         u8 opt;
 611         __le16 reserved2;
 612         __le32 timestamp;
 613         __le32 error_event_table_ptr;   /* SRAM address for error log */
 614         __le32 log_event_table_ptr;     /* SRAM address for LMAC event log */
 615         __le32 cpu_register_ptr;
 616         __le32 dbgm_config_ptr;
 617         __le32 alive_counter_ptr;
 618         __le32 scd_base_ptr;            /* SRAM address for SCD */
 619         __le32 st_fwrd_addr;            /* pointer to Store and forward */
 620         __le32 st_fwrd_size;
 621         u8 umac_minor;                  /* UMAC version: minor */
 622         u8 umac_major;                  /* UMAC version: major */
 623         __le16 umac_id;                 /* UMAC version: id */
 624         __le32 error_info_addr;         /* SRAM address for UMAC error log */
 625         __le32 dbg_print_buff_addr;
 626 } __packed; /* ALIVE_RES_API_S_VER_2 */
 627
 628 struct mvm_alive_resp {
 629         __le16 status;
 630         __le16 flags;
 631         __le32 ucode_minor;
 632         __le32 ucode_major;
 633         u8 ver_subtype;
 634         u8 ver_type;
 635         u8 mac;
 636         u8 opt;
 637         __le32 timestamp;
 638         __le32 error_event_table_ptr;   /* SRAM address for error log */
 639         __le32 log_event_table_ptr;     /* SRAM address for LMAC event log */
 640         __le32 cpu_register_ptr;
 641         __le32 dbgm_config_ptr;
 642         __le32 alive_counter_ptr;
 643         __le32 scd_base_ptr;            /* SRAM address for SCD */
 644         __le32 st_fwrd_addr;            /* pointer to Store and forward */
 645         __le32 st_fwrd_size;
 646         __le32 umac_minor;              /* UMAC version: minor */
 647         __le32 umac_major;              /* UMAC version: major */
 648         __le32 error_info_addr;         /* SRAM address for UMAC error log */
 649         __le32 dbg_print_buff_addr;
 650 } __packed; /* ALIVE_RES_API_S_VER_3 */
 651
 652 /* Error response/notification */
 653 enum {
 654         FW_ERR_UNKNOWN_CMD = 0x0,
 655         FW_ERR_INVALID_CMD_PARAM = 0x1,
 656         FW_ERR_SERVICE = 0x2,
 657         FW_ERR_ARC_MEMORY = 0x3,
 658         FW_ERR_ARC_CODE = 0x4,
 659         FW_ERR_WATCH_DOG = 0x5,
 660         FW_ERR_WEP_GRP_KEY_INDX = 0x10,
 661         FW_ERR_WEP_KEY_SIZE = 0x11,
 662         FW_ERR_OBSOLETE_FUNC = 0x12,
 663         FW_ERR_UNEXPECTED = 0xFE,
 664         FW_ERR_FATAL = 0xFF
 665 };
 666
 667 /**
 668  * struct iwl_error_resp - FW error indication
 669  * ( REPLY_ERROR = 0x2 )
 670  * @error_type: one of FW_ERR_*
 671  * @cmd_id: the command ID for which the error occured
 672  * @bad_cmd_seq_num: sequence number of the erroneous command
 673  * @error_service: which service created the error, applicable only if
 674  *      error_type = 2, otherwise 0
 675  * @timestamp: TSF in usecs.
 676  */
 677 struct iwl_error_resp {
 678         __le32 error_type;
 679         u8 cmd_id;
 680         u8 reserved1;
 681         __le16 bad_cmd_seq_num;
 682         __le32 error_service;
 683         __le64 timestamp;
 684 } __packed;
 685
 686
 687 /* Common PHY, MAC and Bindings definitions */
 688
 689 #define MAX_MACS_IN_BINDING     (3)
 690 #define MAX_BINDINGS            (4)
 691 #define AUX_BINDING_INDEX       (3)
 692 #define MAX_PHYS                (4)
 693
 694 /* Used to extract ID and color from the context dword */
 695 #define FW_CTXT_ID_POS    (0)
 696 #define FW_CTXT_ID_MSK    (0xff << FW_CTXT_ID_POS)
 697 #define FW_CTXT_COLOR_POS (8)
 698 #define FW_CTXT_COLOR_MSK (0xff << FW_CTXT_COLOR_POS)
 699 #define FW_CTXT_INVALID   (0xffffffff)
 700
 701 #define FW_CMD_ID_AND_COLOR(_id, _color) ((_id << FW_CTXT_ID_POS) |\
 702                                           (_color << FW_CTXT_COLOR_POS))
 703
 704 /* Possible actions on PHYs, MACs and Bindings */
 705 enum {
 706         FW_CTXT_ACTION_STUB = 0,
 707         FW_CTXT_ACTION_ADD,
 708         FW_CTXT_ACTION_MODIFY,
 709         FW_CTXT_ACTION_REMOVE,
 710         FW_CTXT_ACTION_NUM
 711 }; /* COMMON_CONTEXT_ACTION_API_E_VER_1 */
 712
 713 /* Time Events */
 714
 715 /* Time Event types, according to MAC type */
 716 enum iwl_time_event_type {
 717         /* BSS Station Events */
 718         TE_BSS_STA_AGGRESSIVE_ASSOC,
 719         TE_BSS_STA_ASSOC,
 720         TE_BSS_EAP_DHCP_PROT,
 721         TE_BSS_QUIET_PERIOD,
 722
 723         /* P2P Device Events */
 724         TE_P2P_DEVICE_DISCOVERABLE,
 725         TE_P2P_DEVICE_LISTEN,
 726         TE_P2P_DEVICE_ACTION_SCAN,
 727         TE_P2P_DEVICE_FULL_SCAN,
 728
 729         /* P2P Client Events */
 730         TE_P2P_CLIENT_AGGRESSIVE_ASSOC,
 731         TE_P2P_CLIENT_ASSOC,
 732         TE_P2P_CLIENT_QUIET_PERIOD,
 733
 734         /* P2P GO Events */
 735         TE_P2P_GO_ASSOC_PROT,
 736         TE_P2P_GO_REPETITIVET_NOA,
 737         TE_P2P_GO_CT_WINDOW,
 738
 739         /* WiDi Sync Events */
 740         TE_WIDI_TX_SYNC,
 741
 742         /* Channel Switch NoA */
 743         TE_CHANNEL_SWITCH_PERIOD,
 744
 745         TE_MAX
 746 }; /* MAC_EVENT_TYPE_API_E_VER_1 */
 747
 748
 749
 750 /* Time event - defines for command API v1 */
 751
 752 /*
 753  * @TE_V1_FRAG_NONE: fragmentation of the time event is NOT allowed.
 754  * @TE_V1_FRAG_SINGLE: fragmentation of the time event is allowed, but only
 755  *      the first fragment is scheduled.
 756  * @TE_V1_FRAG_DUAL: fragmentation of the time event is allowed, but only
 757  *      the first 2 fragments are scheduled.
 758  * @TE_V1_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
 759  *      number of fragments are valid.
 760  *
 761  * Other than the constant defined above, specifying a fragmentation value 'x'
 762  * means that the event can be fragmented but only the first 'x' will be
 763  * scheduled.
 764  */
 765 enum {
 766         TE_V1_FRAG_NONE = 0,
 767         TE_V1_FRAG_SINGLE = 1,
 768         TE_V1_FRAG_DUAL = 2,
 769         TE_V1_FRAG_ENDLESS = 0xffffffff
 770 };
 771
 772 /* If a Time Event can be fragmented, this is the max number of fragments */
 773 #define TE_V1_FRAG_MAX_MSK      0x0fffffff
 774 /* Repeat the time event endlessly (until removed) */
 775 #define TE_V1_REPEAT_ENDLESS    0xffffffff
 776 /* If a Time Event has bounded repetitions, this is the maximal value */
 777 #define TE_V1_REPEAT_MAX_MSK_V1 0x0fffffff
 778
 779 /* Time Event dependencies: none, on another TE, or in a specific time */
 780 enum {
 781         TE_V1_INDEPENDENT               = 0,
 782         TE_V1_DEP_OTHER                 = BIT(0),
 783         TE_V1_DEP_TSF                   = BIT(1),
 784         TE_V1_EVENT_SOCIOPATHIC         = BIT(2),
 785 }; /* MAC_EVENT_DEPENDENCY_POLICY_API_E_VER_2 */
 786
 787 /*
 788  * @TE_V1_NOTIF_NONE: no notifications
 789  * @TE_V1_NOTIF_HOST_EVENT_START: request/receive notification on event start
 790  * @TE_V1_NOTIF_HOST_EVENT_END:request/receive notification on event end
 791  * @TE_V1_NOTIF_INTERNAL_EVENT_START: internal FW use
 792  * @TE_V1_NOTIF_INTERNAL_EVENT_END: internal FW use.
 793  * @TE_V1_NOTIF_HOST_FRAG_START: request/receive notification on frag start
 794  * @TE_V1_NOTIF_HOST_FRAG_END:request/receive notification on frag end
 795  * @TE_V1_NOTIF_INTERNAL_FRAG_START: internal FW use.
 796  * @TE_V1_NOTIF_INTERNAL_FRAG_END: internal FW use.
 797  *
 798  * Supported Time event notifications configuration.
 799  * A notification (both event and fragment) includes a status indicating weather
 800  * the FW was able to schedule the event or not. For fragment start/end
 801  * notification the status is always success. There is no start/end fragment
 802  * notification for monolithic events.
 803  */
 804 enum {
 805         TE_V1_NOTIF_NONE = 0,
 806         TE_V1_NOTIF_HOST_EVENT_START = BIT(0),
 807         TE_V1_NOTIF_HOST_EVENT_END = BIT(1),
 808         TE_V1_NOTIF_INTERNAL_EVENT_START = BIT(2),
 809         TE_V1_NOTIF_INTERNAL_EVENT_END = BIT(3),
 810         TE_V1_NOTIF_HOST_FRAG_START = BIT(4),
 811         TE_V1_NOTIF_HOST_FRAG_END = BIT(5),
 812         TE_V1_NOTIF_INTERNAL_FRAG_START = BIT(6),
 813         TE_V1_NOTIF_INTERNAL_FRAG_END = BIT(7),
 814 }; /* MAC_EVENT_ACTION_API_E_VER_2 */
 815
 816 /* Time event - defines for command API */
 817
 818 /*
 819  * @TE_V2_FRAG_NONE: fragmentation of the time event is NOT allowed.
 820  * @TE_V2_FRAG_SINGLE: fragmentation of the time event is allowed, but only
 821  *  the first fragment is scheduled.
 822  * @TE_V2_FRAG_DUAL: fragmentation of the time event is allowed, but only
 823  *  the first 2 fragments are scheduled.
 824  * @TE_V2_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
 825  *  number of fragments are valid.
 826  *
 827  * Other than the constant defined above, specifying a fragmentation value 'x'
 828  * means that the event can be fragmented but only the first 'x' will be
 829  * scheduled.
 830  */
 831 enum {
 832         TE_V2_FRAG_NONE = 0,
 833         TE_V2_FRAG_SINGLE = 1,
 834         TE_V2_FRAG_DUAL = 2,
 835         TE_V2_FRAG_MAX = 0xfe,
 836         TE_V2_FRAG_ENDLESS = 0xff
 837 };
 838
 839 /* Repeat the time event endlessly (until removed) */
 840 #define TE_V2_REPEAT_ENDLESS    0xff
 841 /* If a Time Event has bounded repetitions, this is the maximal value */
 842 #define TE_V2_REPEAT_MAX        0xfe
 843
 844 #define TE_V2_PLACEMENT_POS     12
 845 #define TE_V2_ABSENCE_POS       15
 846
 847 /* Time event policy values
 848  * A notification (both event and fragment) includes a status indicating weather
 849  * the FW was able to schedule the event or not. For fragment start/end
 850  * notification the status is always success. There is no start/end fragment
 851  * notification for monolithic events.
 852  *
 853  * @TE_V2_DEFAULT_POLICY: independent, social, present, unoticable
 854  * @TE_V2_NOTIF_HOST_EVENT_START: request/receive notification on event start
 855  * @TE_V2_NOTIF_HOST_EVENT_END:request/receive notification on event end
 856  * @TE_V2_NOTIF_INTERNAL_EVENT_START: internal FW use
 857  * @TE_V2_NOTIF_INTERNAL_EVENT_END: internal FW use.
 858  * @TE_V2_NOTIF_HOST_FRAG_START: request/receive notification on frag start
 859  * @TE_V2_NOTIF_HOST_FRAG_END:request/receive notification on frag end
 860  * @TE_V2_NOTIF_INTERNAL_FRAG_START: internal FW use.
 861  * @TE_V2_NOTIF_INTERNAL_FRAG_END: internal FW use.
 862  * @TE_V2_DEP_OTHER: depends on another time event
 863  * @TE_V2_DEP_TSF: depends on a specific time
 864  * @TE_V2_EVENT_SOCIOPATHIC: can't co-exist with other events of tha same MAC
 865  * @TE_V2_ABSENCE: are we present or absent during the Time Event.
 866  */
 867 enum {
 868         TE_V2_DEFAULT_POLICY = 0x0,
 869
 870         /* notifications (event start/stop, fragment start/stop) */
 871         TE_V2_NOTIF_HOST_EVENT_START = BIT(0),
 872         TE_V2_NOTIF_HOST_EVENT_END = BIT(1),
 873         TE_V2_NOTIF_INTERNAL_EVENT_START = BIT(2),
 874         TE_V2_NOTIF_INTERNAL_EVENT_END = BIT(3),
 875
 876         TE_V2_NOTIF_HOST_FRAG_START = BIT(4),
 877         TE_V2_NOTIF_HOST_FRAG_END = BIT(5),
 878         TE_V2_NOTIF_INTERNAL_FRAG_START = BIT(6),
 879         TE_V2_NOTIF_INTERNAL_FRAG_END = BIT(7),
 880         T2_V2_START_IMMEDIATELY = BIT(11),
 881
 882         TE_V2_NOTIF_MSK = 0xff,
 883
 884         /* placement characteristics */
 885         TE_V2_DEP_OTHER = BIT(TE_V2_PLACEMENT_POS),
 886         TE_V2_DEP_TSF = BIT(TE_V2_PLACEMENT_POS + 1),
 887         TE_V2_EVENT_SOCIOPATHIC = BIT(TE_V2_PLACEMENT_POS + 2),
 888
 889         /* are we present or absent during the Time Event. */
 890         TE_V2_ABSENCE = BIT(TE_V2_ABSENCE_POS),
 891 };
 892
 893 /**
 894  * struct iwl_time_event_cmd_api - configuring Time Events
 895  * with struct MAC_TIME_EVENT_DATA_API_S_VER_2 (see also
 896  * with version 1. determined by IWL_UCODE_TLV_FLAGS)
 897  * ( TIME_EVENT_CMD = 0x29 )
 898  * @id_and_color: ID and color of the relevant MAC
 899  * @action: action to perform, one of FW_CTXT_ACTION_*
 900  * @id: this field has two meanings, depending on the action:
 901  *      If the action is ADD, then it means the type of event to add.
 902  *      For all other actions it is the unique event ID assigned when the
 903  *      event was added by the FW.
 904  * @apply_time: When to start the Time Event (in GP2)
 905  * @max_delay: maximum delay to event's start (apply time), in TU
 906  * @depends_on: the unique ID of the event we depend on (if any)
 907  * @interval: interval between repetitions, in TU
 908  * @duration: duration of event in TU
 909  * @repeat: how many repetitions to do, can be TE_REPEAT_ENDLESS
 910  * @max_frags: maximal number of fragments the Time Event can be divided to
 911  * @policy: defines whether uCode shall notify the host or other uCode modules
 912  *      on event and/or fragment start and/or end
 913  *      using one of TE_INDEPENDENT, TE_DEP_OTHER, TE_DEP_TSF
 914  *      TE_EVENT_SOCIOPATHIC
 915  *      using TE_ABSENCE and using TE_NOTIF_*
 916  */
 917 struct iwl_time_event_cmd {
 918         /* COMMON_INDEX_HDR_API_S_VER_1 */
 919         __le32 id_and_color;
 920         __le32 action;
 921         __le32 id;
 922         /* MAC_TIME_EVENT_DATA_API_S_VER_2 */
 923         __le32 apply_time;
 924         __le32 max_delay;
 925         __le32 depends_on;
 926         __le32 interval;
 927         __le32 duration;
 928         u8 repeat;
 929         u8 max_frags;
 930         __le16 policy;
 931 } __packed; /* MAC_TIME_EVENT_CMD_API_S_VER_2 */
 932
 933 /**
 934  * struct iwl_time_event_resp - response structure to iwl_time_event_cmd
 935  * @status: bit 0 indicates success, all others specify errors
 936  * @id: the Time Event type
 937  * @unique_id: the unique ID assigned (in ADD) or given (others) to the TE
 938  * @id_and_color: ID and color of the relevant MAC
 939  */
 940 struct iwl_time_event_resp {
 941         __le32 status;
 942         __le32 id;
 943         __le32 unique_id;
 944         __le32 id_and_color;
 945 } __packed; /* MAC_TIME_EVENT_RSP_API_S_VER_1 */
 946
 947 /**
 948  * struct iwl_time_event_notif - notifications of time event start/stop
 949  * ( TIME_EVENT_NOTIFICATION = 0x2a )
 950  * @timestamp: action timestamp in GP2
 951  * @session_id: session's unique id
 952  * @unique_id: unique id of the Time Event itself
 953  * @id_and_color: ID and color of the relevant MAC
 954  * @action: one of TE_NOTIF_START or TE_NOTIF_END
 955  * @status: true if scheduled, false otherwise (not executed)
 956  */
 957 struct iwl_time_event_notif {
 958         __le32 timestamp;
 959         __le32 session_id;
 960         __le32 unique_id;
 961         __le32 id_and_color;
 962         __le32 action;
 963         __le32 status;
 964 } __packed; /* MAC_TIME_EVENT_NTFY_API_S_VER_1 */
 965
 966
 967 /* Bindings and Time Quota */
 968
 969 /**
 970  * struct iwl_binding_cmd - configuring bindings
 971  * ( BINDING_CONTEXT_CMD = 0x2b )
 972  * @id_and_color: ID and color of the relevant Binding
 973  * @action: action to perform, one of FW_CTXT_ACTION_*
 974  * @macs: array of MAC id and colors which belong to the binding
 975  * @phy: PHY id and color which belongs to the binding
 976  */
 977 struct iwl_binding_cmd {
 978         /* COMMON_INDEX_HDR_API_S_VER_1 */
 979         __le32 id_and_color;
 980         __le32 action;
 981         /* BINDING_DATA_API_S_VER_1 */
 982         __le32 macs[MAX_MACS_IN_BINDING];
 983         __le32 phy;
 984 } __packed; /* BINDING_CMD_API_S_VER_1 */
 985
 986 /* The maximal number of fragments in the FW's schedule session */
 987 #define IWL_MVM_MAX_QUOTA 128
 988
 989 /**
 990  * struct iwl_time_quota_data - configuration of time quota per binding
 991  * @id_and_color: ID and color of the relevant Binding
 992  * @quota: absolute time quota in TU. The scheduler will try to divide the
 993  *      remainig quota (after Time Events) according to this quota.
 994  * @max_duration: max uninterrupted context duration in TU
 995  */
 996 struct iwl_time_quota_data {
 997         __le32 id_and_color;
 998         __le32 quota;
 999         __le32 max_duration;
1000 } __packed; /* TIME_QUOTA_DATA_API_S_VER_1 */
1001
1002 /**
1003  * struct iwl_time_quota_cmd - configuration of time quota between bindings
1004  * ( TIME_QUOTA_CMD = 0x2c )
1005  * @quotas: allocations per binding
1006  */
1007 struct iwl_time_quota_cmd {
1008         struct iwl_time_quota_data quotas[MAX_BINDINGS];
1009 } __packed; /* TIME_QUOTA_ALLOCATION_CMD_API_S_VER_1 */
1010
1011
1012 /* PHY context */
1013
1014 /* Supported bands */
1015 #define PHY_BAND_5  (0)
1016 #define PHY_BAND_24 (1)
1017
1018 /* Supported channel width, vary if there is VHT support */
1019 #define PHY_VHT_CHANNEL_MODE20  (0x0)
1020 #define PHY_VHT_CHANNEL_MODE40  (0x1)
1021 #define PHY_VHT_CHANNEL_MODE80  (0x2)
1022 #define PHY_VHT_CHANNEL_MODE160 (0x3)
1023
1024 /*
1025  * Control channel position:
1026  * For legacy set bit means upper channel, otherwise lower.
1027  * For VHT - bit-2 marks if the control is lower/upper relative to center-freq
1028  *   bits-1:0 mark the distance from the center freq. for 20Mhz, offset is 0.
1029  *                                   center_freq
1030  *                                        |
1031  * 40Mhz                          |_______|_______|
1032  * 80Mhz                  |_______|_______|_______|_______|
1033  * 160Mhz |_______|_______|_______|_______|_______|_______|_______|_______|
1034  * code      011     010     001     000  |  100     101     110    111
1035  */
1036 #define PHY_VHT_CTRL_POS_1_BELOW  (0x0)
1037 #define PHY_VHT_CTRL_POS_2_BELOW  (0x1)
1038 #define PHY_VHT_CTRL_POS_3_BELOW  (0x2)
1039 #define PHY_VHT_CTRL_POS_4_BELOW  (0x3)
1040 #define PHY_VHT_CTRL_POS_1_ABOVE  (0x4)
1041 #define PHY_VHT_CTRL_POS_2_ABOVE  (0x5)
1042 #define PHY_VHT_CTRL_POS_3_ABOVE  (0x6)
1043 #define PHY_VHT_CTRL_POS_4_ABOVE  (0x7)
1044
1045 /*
1046  * @band: PHY_BAND_*
1047  * @channel: channel number
1048  * @width: PHY_[VHT|LEGACY]_CHANNEL_*
1049  * @ctrl channel: PHY_[VHT|LEGACY]_CTRL_*
1050  */
1051 struct iwl_fw_channel_info {
1052         u8 band;
1053         u8 channel;
1054         u8 width;
1055         u8 ctrl_pos;
1056 } __packed;
1057
1058 #define PHY_RX_CHAIN_DRIVER_FORCE_POS   (0)
1059 #define PHY_RX_CHAIN_DRIVER_FORCE_MSK \
1060         (0x1 << PHY_RX_CHAIN_DRIVER_FORCE_POS)
1061 #define PHY_RX_CHAIN_VALID_POS          (1)
1062 #define PHY_RX_CHAIN_VALID_MSK \
1063         (0x7 << PHY_RX_CHAIN_VALID_POS)
1064 #define PHY_RX_CHAIN_FORCE_SEL_POS      (4)
1065 #define PHY_RX_CHAIN_FORCE_SEL_MSK \
1066         (0x7 << PHY_RX_CHAIN_FORCE_SEL_POS)
1067 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
1068 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_MSK \
1069         (0x7 << PHY_RX_CHAIN_FORCE_MIMO_SEL_POS)
1070 #define PHY_RX_CHAIN_CNT_POS            (10)
1071 #define PHY_RX_CHAIN_CNT_MSK \
1072         (0x3 << PHY_RX_CHAIN_CNT_POS)
1073 #define PHY_RX_CHAIN_MIMO_CNT_POS       (12)
1074 #define PHY_RX_CHAIN_MIMO_CNT_MSK \
1075         (0x3 << PHY_RX_CHAIN_MIMO_CNT_POS)
1076 #define PHY_RX_CHAIN_MIMO_FORCE_POS     (14)
1077 #define PHY_RX_CHAIN_MIMO_FORCE_MSK \
1078         (0x1 << PHY_RX_CHAIN_MIMO_FORCE_POS)
1079
1080 /* TODO: fix the value, make it depend on firmware at runtime? */
1081 #define NUM_PHY_CTX     3
1082
1083 /* TODO: complete missing documentation */
1084 /**
1085  * struct iwl_phy_context_cmd - config of the PHY context
1086  * ( PHY_CONTEXT_CMD = 0x8 )
1087  * @id_and_color: ID and color of the relevant Binding
1088  * @action: action to perform, one of FW_CTXT_ACTION_*
1089  * @apply_time: 0 means immediate apply and context switch.
1090  *      other value means apply new params after X usecs
1091  * @tx_param_color: ???
1092  * @channel_info:
1093  * @txchain_info: ???
1094  * @rxchain_info: ???
1095  * @acquisition_data: ???
1096  * @dsp_cfg_flags: set to 0
1097  */
1098 struct iwl_phy_context_cmd {
1099         /* COMMON_INDEX_HDR_API_S_VER_1 */
1100         __le32 id_and_color;
1101         __le32 action;
1102         /* PHY_CONTEXT_DATA_API_S_VER_1 */
1103         __le32 apply_time;
1104         __le32 tx_param_color;
1105         struct iwl_fw_channel_info ci;
1106         __le32 txchain_info;
1107         __le32 rxchain_info;
1108         __le32 acquisition_data;
1109         __le32 dsp_cfg_flags;
1110 } __packed; /* PHY_CONTEXT_CMD_API_VER_1 */
1111
1112 /*
1113  * Aux ROC command
1114  *
1115  * Command requests the firmware to create a time event for a certain duration
1116  * and remain on the given channel. This is done by using the Aux framework in
1117  * the FW.
1118  * The command was first used for Hot Spot issues - but can be used regardless
1119  * to Hot Spot.
1120  *
1121  * ( HOT_SPOT_CMD 0x53 )
1122  *
1123  * @id_and_color: ID and color of the MAC
1124  * @action: action to perform, one of FW_CTXT_ACTION_*
1125  * @event_unique_id: If the action FW_CTXT_ACTION_REMOVE then the
1126  *      event_unique_id should be the id of the time event assigned by ucode.
1127  *      Otherwise ignore the event_unique_id.
1128  * @sta_id_and_color: station id and color, resumed during "Remain On Channel"
1129  *      activity.
1130  * @channel_info: channel info
1131  * @node_addr: Our MAC Address
1132  * @reserved: reserved for alignment
1133  * @apply_time: GP2 value to start (should always be the current GP2 value)
1134  * @apply_time_max_delay: Maximum apply time delay value in TU. Defines max
1135  *      time by which start of the event is allowed to be postponed.
1136  * @duration: event duration in TU To calculate event duration:
1137  *      timeEventDuration = min(duration, remainingQuota)
1138  */
1139 struct iwl_hs20_roc_req {
1140         /* COMMON_INDEX_HDR_API_S_VER_1 hdr */
1141         __le32 id_and_color;
1142         __le32 action;
1143         __le32 event_unique_id;
1144         __le32 sta_id_and_color;
1145         struct iwl_fw_channel_info channel_info;
1146         u8 node_addr[ETH_ALEN];
1147         __le16 reserved;
1148         __le32 apply_time;
1149         __le32 apply_time_max_delay;
1150         __le32 duration;
1151 } __packed; /* HOT_SPOT_CMD_API_S_VER_1 */
1152
1153 /*
1154  * values for AUX ROC result values
1155  */
1156 enum iwl_mvm_hot_spot {
1157         HOT_SPOT_RSP_STATUS_OK,
1158         HOT_SPOT_RSP_STATUS_TOO_MANY_EVENTS,
1159         HOT_SPOT_MAX_NUM_OF_SESSIONS,
1160 };
1161
1162 /*
1163  * Aux ROC command response
1164  *
1165  * In response to iwl_hs20_roc_req the FW sends this command to notify the
1166  * driver the uid of the timevent.
1167  *
1168  * ( HOT_SPOT_CMD 0x53 )
1169  *
1170  * @event_unique_id: Unique ID of time event assigned by ucode
1171  * @status: Return status 0 is success, all the rest used for specific errors
1172  */
1173 struct iwl_hs20_roc_res {
1174         __le32 event_unique_id;
1175         __le32 status;
1176 } __packed; /* HOT_SPOT_RSP_API_S_VER_1 */
1177
1178 /**
1179  * struct iwl_radio_version_notif - information on the radio version
1180  * ( RADIO_VERSION_NOTIFICATION = 0x68 )
1181  * @radio_flavor:
1182  * @radio_step:
1183  * @radio_dash:
1184  */
1185 struct iwl_radio_version_notif {
1186         __le32 radio_flavor;
1187         __le32 radio_step;
1188         __le32 radio_dash;
1189 } __packed; /* RADIO_VERSION_NOTOFICATION_S_VER_1 */
1190
1191 enum iwl_card_state_flags {
1192         CARD_ENABLED            = 0x00,
1193         HW_CARD_DISABLED        = 0x01,
1194         SW_CARD_DISABLED        = 0x02,
1195         CT_KILL_CARD_DISABLED   = 0x04,
1196         HALT_CARD_DISABLED      = 0x08,
1197         CARD_DISABLED_MSK       = 0x0f,
1198         CARD_IS_RX_ON           = 0x10,
1199 };
1200
1201 /**
1202  * struct iwl_radio_version_notif - information on the radio version
1203  * ( CARD_STATE_NOTIFICATION = 0xa1 )
1204  * @flags: %iwl_card_state_flags
1205  */
1206 struct iwl_card_state_notif {
1207         __le32 flags;
1208 } __packed; /* CARD_STATE_NTFY_API_S_VER_1 */
1209
1210 /**
1211  * struct iwl_missed_beacons_notif - information on missed beacons
1212  * ( MISSED_BEACONS_NOTIFICATION = 0xa2 )
1213  * @mac_id: interface ID
1214  * @consec_missed_beacons_since_last_rx: number of consecutive missed
1215  *      beacons since last RX.
1216  * @consec_missed_beacons: number of consecutive missed beacons
1217  * @num_expected_beacons:
1218  * @num_recvd_beacons:
1219  */
1220 struct iwl_missed_beacons_notif {
1221         __le32 mac_id;
1222         __le32 consec_missed_beacons_since_last_rx;
1223         __le32 consec_missed_beacons;
1224         __le32 num_expected_beacons;
1225         __le32 num_recvd_beacons;
1226 } __packed; /* MISSED_BEACON_NTFY_API_S_VER_3 */
1227
1228 /**
1229  * struct iwl_mfuart_load_notif - mfuart image version & status
1230  * ( MFUART_LOAD_NOTIFICATION = 0xb1 )
1231  * @installed_ver: installed image version
1232  * @external_ver: external image version
1233  * @status: MFUART loading status
1234  * @duration: MFUART loading time
1235 */
1236 struct iwl_mfuart_load_notif {
1237         __le32 installed_ver;
1238         __le32 external_ver;
1239         __le32 status;
1240         __le32 duration;
1241 } __packed; /*MFU_LOADER_NTFY_API_S_VER_1*/
1242
1243 /**
1244  * struct iwl_set_calib_default_cmd - set default value for calibration.
1245  * ( SET_CALIB_DEFAULT_CMD = 0x8e )
1246  * @calib_index: the calibration to set value for
1247  * @length: of data
1248  * @data: the value to set for the calibration result
1249  */
1250 struct iwl_set_calib_default_cmd {
1251         __le16 calib_index;
1252         __le16 length;
1253         u8 data[0];
1254 } __packed; /* PHY_CALIB_OVERRIDE_VALUES_S */
1255
1256 #define MAX_PORT_ID_NUM 2
1257 #define MAX_MCAST_FILTERING_ADDRESSES 256
1258
1259 /**
1260  * struct iwl_mcast_filter_cmd - configure multicast filter.
1261  * @filter_own: Set 1 to filter out multicast packets sent by station itself
1262  * @port_id:    Multicast MAC addresses array specifier. This is a strange way
1263  *              to identify network interface adopted in host-device IF.
1264  *              It is used by FW as index in array of addresses. This array has
1265  *              MAX_PORT_ID_NUM members.
1266  * @count:      Number of MAC addresses in the array
1267  * @pass_all:   Set 1 to pass all multicast packets.
1268  * @bssid:      current association BSSID.
1269  * @addr_list:  Place holder for array of MAC addresses.
1270  *              IMPORTANT: add padding if necessary to ensure DWORD alignment.
1271  */
1272 struct iwl_mcast_filter_cmd {
1273         u8 filter_own;
1274         u8 port_id;
1275         u8 count;
1276         u8 pass_all;
1277         u8 bssid[6];
1278         u8 reserved[2];
1279         u8 addr_list[0];
1280 } __packed; /* MCAST_FILTERING_CMD_API_S_VER_1 */
1281
1282 #define MAX_BCAST_FILTERS 8
1283 #define MAX_BCAST_FILTER_ATTRS 2
1284
1285 /**
1286  * enum iwl_mvm_bcast_filter_attr_offset - written by fw for each Rx packet
1287  * @BCAST_FILTER_OFFSET_PAYLOAD_START: offset is from payload start.
1288  * @BCAST_FILTER_OFFSET_IP_END: offset is from ip header end (i.e.
1289  *      start of ip payload).
1290  */
1291 enum iwl_mvm_bcast_filter_attr_offset {
1292         BCAST_FILTER_OFFSET_PAYLOAD_START = 0,
1293         BCAST_FILTER_OFFSET_IP_END = 1,
1294 };
1295
1296 /**
1297  * struct iwl_fw_bcast_filter_attr - broadcast filter attribute
1298  * @offset_type:        &enum iwl_mvm_bcast_filter_attr_offset.
1299  * @offset:     starting offset of this pattern.
1300  * @val:                value to match - big endian (MSB is the first
1301  *              byte to match from offset pos).
1302  * @mask:       mask to match (big endian).
1303  */
1304 struct iwl_fw_bcast_filter_attr {
1305         u8 offset_type;
1306         u8 offset;
1307         __le16 reserved1;
1308         __be32 val;
1309         __be32 mask;
1310 } __packed; /* BCAST_FILTER_ATT_S_VER_1 */
1311
1312 /**
1313  * enum iwl_mvm_bcast_filter_frame_type - filter frame type
1314  * @BCAST_FILTER_FRAME_TYPE_ALL: consider all frames.
1315  * @BCAST_FILTER_FRAME_TYPE_IPV4: consider only ipv4 frames
1316  */
1317 enum iwl_mvm_bcast_filter_frame_type {
1318         BCAST_FILTER_FRAME_TYPE_ALL = 0,
1319         BCAST_FILTER_FRAME_TYPE_IPV4 = 1,
1320 };
1321
1322 /**
1323  * struct iwl_fw_bcast_filter - broadcast filter
1324  * @discard: discard frame (1) or let it pass (0).
1325  * @frame_type: &enum iwl_mvm_bcast_filter_frame_type.
1326  * @num_attrs: number of valid attributes in this filter.
1327  * @attrs: attributes of this filter. a filter is considered matched
1328  *      only when all its attributes are matched (i.e. AND relationship)
1329  */
1330 struct iwl_fw_bcast_filter {
1331         u8 discard;
1332         u8 frame_type;
1333         u8 num_attrs;
1334         u8 reserved1;
1335         struct iwl_fw_bcast_filter_attr attrs[MAX_BCAST_FILTER_ATTRS];
1336 } __packed; /* BCAST_FILTER_S_VER_1 */
1337
1338 #define BA_WINDOW_STREAMS_MAX           16
1339 #define BA_WINDOW_STATUS_TID_MSK        0x000F
1340 #define BA_WINDOW_STATUS_STA_ID_POS     4
1341 #define BA_WINDOW_STATUS_STA_ID_MSK     0x01F0
1342 #define BA_WINDOW_STATUS_VALID_MSK      BIT(9)
1343
1344 /**
1345  * struct iwl_ba_window_status_notif - reordering window's status notification
1346  * @bitmap: bitmap of received frames [start_seq_num + 0]..[start_seq_num + 63]
1347  * @ra_tid: bit 3:0 - TID, bit 8:4 - STA_ID, bit 9 - valid
1348  * @start_seq_num: the start sequence number of the bitmap
1349  * @mpdu_rx_count: the number of received MPDUs since entering D0i3
1350  */
1351 struct iwl_ba_window_status_notif {
1352         __le64 bitmap[BA_WINDOW_STREAMS_MAX];
1353         __le16 ra_tid[BA_WINDOW_STREAMS_MAX];
1354         __le32 start_seq_num[BA_WINDOW_STREAMS_MAX];
1355         __le16 mpdu_rx_count[BA_WINDOW_STREAMS_MAX];
1356 } __packed; /* BA_WINDOW_STATUS_NTFY_API_S_VER_1 */
1357
1358 /**
1359  * struct iwl_fw_bcast_mac - per-mac broadcast filtering configuration.
1360  * @default_discard: default action for this mac (discard (1) / pass (0)).
1361  * @attached_filters: bitmap of relevant filters for this mac.
1362  */
1363 struct iwl_fw_bcast_mac {
1364         u8 default_discard;
1365         u8 reserved1;
1366         __le16 attached_filters;
1367 } __packed; /* BCAST_MAC_CONTEXT_S_VER_1 */
1368
1369 /**
1370  * struct iwl_bcast_filter_cmd - broadcast filtering configuration
1371  * @disable: enable (0) / disable (1)
1372  * @max_bcast_filters: max number of filters (MAX_BCAST_FILTERS)
1373  * @max_macs: max number of macs (NUM_MAC_INDEX_DRIVER)
1374  * @filters: broadcast filters
1375  * @macs: broadcast filtering configuration per-mac
1376  */
1377 struct iwl_bcast_filter_cmd {
1378         u8 disable;
1379         u8 max_bcast_filters;
1380         u8 max_macs;
1381         u8 reserved1;
1382         struct iwl_fw_bcast_filter filters[MAX_BCAST_FILTERS];
1383         struct iwl_fw_bcast_mac macs[NUM_MAC_INDEX_DRIVER];
1384 } __packed; /* BCAST_FILTERING_HCMD_API_S_VER_1 */
1385
1386 /*
1387  * enum iwl_mvm_marker_id - maker ids
1388  *
1389  * The ids for different type of markers to insert into the usniffer logs
1390  */
1391 enum iwl_mvm_marker_id {
1392         MARKER_ID_TX_FRAME_LATENCY = 1,
1393 }; /* MARKER_ID_API_E_VER_1 */
1394
1395 /**
1396  * struct iwl_mvm_marker - mark info into the usniffer logs
1397  *
1398  * (MARKER_CMD = 0xcb)
1399  *
1400  * Mark the UTC time stamp into the usniffer logs together with additional
1401  * metadata, so the usniffer output can be parsed.
1402  * In the command response the ucode will return the GP2 time.
1403  *
1404  * @dw_len: The amount of dwords following this byte including this byte.
1405  * @marker_id: A unique marker id (iwl_mvm_marker_id).
1406  * @reserved: reserved.
1407  * @timestamp: in milliseconds since 1970-01-01 00:00:00 UTC
1408  * @metadata: additional meta data that will be written to the unsiffer log
1409  */
1410 struct iwl_mvm_marker {
1411         u8 dwLen;
1412         u8 markerId;
1413         __le16 reserved;
1414         __le64 timestamp;
1415         __le32 metadata[0];
1416 } __packed; /* MARKER_API_S_VER_1 */
1417
1418 /*
1419  * enum iwl_dc2dc_config_id - flag ids
1420  *
1421  * Ids of dc2dc configuration flags
1422  */
1423 enum iwl_dc2dc_config_id {
1424         DCDC_LOW_POWER_MODE_MSK_SET  = 0x1, /* not used */
1425         DCDC_FREQ_TUNE_SET = 0x2,
1426 }; /* MARKER_ID_API_E_VER_1 */
1427
1428 /**
1429  * struct iwl_dc2dc_config_cmd - configure dc2dc values
1430  *
1431  * (DC2DC_CONFIG_CMD = 0x83)
1432  *
1433  * Set/Get & configure dc2dc values.
1434  * The command always returns the current dc2dc values.
1435  *
1436  * @flags: set/get dc2dc
1437  * @enable_low_power_mode: not used.
1438  * @dc2dc_freq_tune0: frequency divider - digital domain
1439  * @dc2dc_freq_tune1: frequency divider - analog domain
1440  */
1441 struct iwl_dc2dc_config_cmd {
1442         __le32 flags;
1443         __le32 enable_low_power_mode; /* not used */
1444         __le32 dc2dc_freq_tune0;
1445         __le32 dc2dc_freq_tune1;
1446 } __packed; /* DC2DC_CONFIG_CMD_API_S_VER_1 */
1447
1448 /**
1449  * struct iwl_dc2dc_config_resp - response for iwl_dc2dc_config_cmd
1450  *
1451  * Current dc2dc values returned by the FW.
1452  *
1453  * @dc2dc_freq_tune0: frequency divider - digital domain
1454  * @dc2dc_freq_tune1: frequency divider - analog domain
1455  */
1456 struct iwl_dc2dc_config_resp {
1457         __le32 dc2dc_freq_tune0;
1458         __le32 dc2dc_freq_tune1;
1459 } __packed; /* DC2DC_CONFIG_RESP_API_S_VER_1 */
1460
1461 /***********************************
1462  * Smart Fifo API
1463  ***********************************/
1464 /* Smart Fifo state */
1465 enum iwl_sf_state {
1466         SF_LONG_DELAY_ON = 0, /* should never be called by driver */
1467         SF_FULL_ON,
1468         SF_UNINIT,
1469         SF_INIT_OFF,
1470         SF_HW_NUM_STATES
1471 };
1472
1473 /* Smart Fifo possible scenario */
1474 enum iwl_sf_scenario {
1475         SF_SCENARIO_SINGLE_UNICAST,
1476         SF_SCENARIO_AGG_UNICAST,
1477         SF_SCENARIO_MULTICAST,
1478         SF_SCENARIO_BA_RESP,
1479         SF_SCENARIO_TX_RESP,
1480         SF_NUM_SCENARIO
1481 };
1482
1483 #define SF_TRANSIENT_STATES_NUMBER 2    /* SF_LONG_DELAY_ON and SF_FULL_ON */
1484 #define SF_NUM_TIMEOUT_TYPES 2          /* Aging timer and Idle timer */
1485
1486 /* smart FIFO default values */
1487 #define SF_W_MARK_SISO 6144
1488 #define SF_W_MARK_MIMO2 8192
1489 #define SF_W_MARK_MIMO3 6144
1490 #define SF_W_MARK_LEGACY 4096
1491 #define SF_W_MARK_SCAN 4096
1492
1493 /* SF Scenarios timers for default configuration (aligned to 32 uSec) */
1494 #define SF_SINGLE_UNICAST_IDLE_TIMER_DEF 160    /* 150 uSec  */
1495 #define SF_SINGLE_UNICAST_AGING_TIMER_DEF 400   /* 0.4 mSec */
1496 #define SF_AGG_UNICAST_IDLE_TIMER_DEF 160               /* 150 uSec */
1497 #define SF_AGG_UNICAST_AGING_TIMER_DEF 400              /* 0.4 mSec */
1498 #define SF_MCAST_IDLE_TIMER_DEF 160             /* 150 mSec */
1499 #define SF_MCAST_AGING_TIMER_DEF 400            /* 0.4 mSec */
1500 #define SF_BA_IDLE_TIMER_DEF 160                        /* 150 uSec */
1501 #define SF_BA_AGING_TIMER_DEF 400                       /* 0.4 mSec */
1502 #define SF_TX_RE_IDLE_TIMER_DEF 160                     /* 150 uSec */
1503 #define SF_TX_RE_AGING_TIMER_DEF 400            /* 0.4 mSec */
1504
1505 /* SF Scenarios timers for BSS MAC configuration (aligned to 32 uSec) */
1506 #define SF_SINGLE_UNICAST_IDLE_TIMER 320        /* 300 uSec  */
1507 #define SF_SINGLE_UNICAST_AGING_TIMER 2016      /* 2 mSec */
1508 #define SF_AGG_UNICAST_IDLE_TIMER 320           /* 300 uSec */
1509 #define SF_AGG_UNICAST_AGING_TIMER 2016         /* 2 mSec */
1510 #define SF_MCAST_IDLE_TIMER 2016                /* 2 mSec */
1511 #define SF_MCAST_AGING_TIMER 10016              /* 10 mSec */
1512 #define SF_BA_IDLE_TIMER 320                    /* 300 uSec */
1513 #define SF_BA_AGING_TIMER 2016                  /* 2 mSec */
1514 #define SF_TX_RE_IDLE_TIMER 320                 /* 300 uSec */
1515 #define SF_TX_RE_AGING_TIMER 2016               /* 2 mSec */
1516
1517 #define SF_LONG_DELAY_AGING_TIMER 1000000       /* 1 Sec */
1518
1519 #define SF_CFG_DUMMY_NOTIF_OFF  BIT(16)
1520
1521 /**
1522  * Smart Fifo configuration command.
1523  * @state: smart fifo state, types listed in enum %iwl_sf_sate.
1524  * @watermark: Minimum allowed availabe free space in RXF for transient state.
1525  * @long_delay_timeouts: aging and idle timer values for each scenario
1526  * in long delay state.
1527  * @full_on_timeouts: timer values for each scenario in full on state.
1528  */
1529 struct iwl_sf_cfg_cmd {
1530         __le32 state;
1531         __le32 watermark[SF_TRANSIENT_STATES_NUMBER];
1532         __le32 long_delay_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES];
1533         __le32 full_on_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES];
1534 } __packed; /* SF_CFG_API_S_VER_2 */
1535
1536 /***********************************
1537  * Location Aware Regulatory (LAR) API - MCC updates
1538  ***********************************/
1539
1540 /**
1541  * struct iwl_mcc_update_cmd_v1 - Request the device to update geographic
1542  * regulatory profile according to the given MCC (Mobile Country Code).
1543  * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain.
1544  * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the
1545  * MCC in the cmd response will be the relevant MCC in the NVM.
1546  * @mcc: given mobile country code
1547  * @source_id: the source from where we got the MCC, see iwl_mcc_source
1548  * @reserved: reserved for alignment
1549  */
1550 struct iwl_mcc_update_cmd_v1 {
1551         __le16 mcc;
1552         u8 source_id;
1553         u8 reserved;
1554 } __packed; /* LAR_UPDATE_MCC_CMD_API_S_VER_1 */
1555
1556 /**
1557  * struct iwl_mcc_update_cmd - Request the device to update geographic
1558  * regulatory profile according to the given MCC (Mobile Country Code).
1559  * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain.
1560  * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the
1561  * MCC in the cmd response will be the relevant MCC in the NVM.
1562  * @mcc: given mobile country code
1563  * @source_id: the source from where we got the MCC, see iwl_mcc_source
1564  * @reserved: reserved for alignment
1565  * @key: integrity key for MCC API OEM testing
1566  * @reserved2: reserved
1567  */
1568 struct iwl_mcc_update_cmd {
1569         __le16 mcc;
1570         u8 source_id;
1571         u8 reserved;
1572         __le32 key;
1573         __le32 reserved2[5];
1574 } __packed; /* LAR_UPDATE_MCC_CMD_API_S_VER_2 */
1575
1576 /**
1577  * iwl_mcc_update_resp_v1  - response to MCC_UPDATE_CMD.
1578  * Contains the new channel control profile map, if changed, and the new MCC
1579  * (mobile country code).
1580  * The new MCC may be different than what was requested in MCC_UPDATE_CMD.
1581  * @status: see &enum iwl_mcc_update_status
1582  * @mcc: the new applied MCC
1583  * @cap: capabilities for all channels which matches the MCC
1584  * @source_id: the MCC source, see iwl_mcc_source
1585  * @n_channels: number of channels in @channels_data (may be 14, 39, 50 or 51
1586  *              channels, depending on platform)
1587  * @channels: channel control data map, DWORD for each channel. Only the first
1588  *      16bits are used.
1589  */
1590 struct iwl_mcc_update_resp_v1  {
1591         __le32 status;
1592         __le16 mcc;
1593         u8 cap;
1594         u8 source_id;
1595         __le32 n_channels;
1596         __le32 channels[0];
1597 } __packed; /* LAR_UPDATE_MCC_CMD_RESP_S_VER_1 */
1598
1599 /**
1600  * iwl_mcc_update_resp - response to MCC_UPDATE_CMD.
1601  * Contains the new channel control profile map, if changed, and the new MCC
1602  * (mobile country code).
1603  * The new MCC may be different than what was requested in MCC_UPDATE_CMD.
1604  * @status: see &enum iwl_mcc_update_status
1605  * @mcc: the new applied MCC
1606  * @cap: capabilities for all channels which matches the MCC
1607  * @source_id: the MCC source, see iwl_mcc_source
1608  * @time: time elapsed from the MCC test start (in 30 seconds TU)
1609  * @reserved: reserved.
1610  * @n_channels: number of channels in @channels_data (may be 14, 39, 50 or 51
1611  *              channels, depending on platform)
1612  * @channels: channel control data map, DWORD for each channel. Only the first
1613  *      16bits are used.
1614  */
1615 struct iwl_mcc_update_resp {
1616         __le32 status;
1617         __le16 mcc;
1618         u8 cap;
1619         u8 source_id;
1620         __le16 time;
1621         __le16 reserved;
1622         __le32 n_channels;
1623         __le32 channels[0];
1624 } __packed; /* LAR_UPDATE_MCC_CMD_RESP_S_VER_2 */
1625
1626 /**
1627  * struct iwl_mcc_chub_notif - chub notifies of mcc change
1628  * (MCC_CHUB_UPDATE_CMD = 0xc9)
1629  * The Chub (Communication Hub, CommsHUB) is a HW component that connects to
1630  * the cellular and connectivity cores that gets updates of the mcc, and
1631  * notifies the ucode directly of any mcc change.
1632  * The ucode requests the driver to request the device to update geographic
1633  * regulatory  profile according to the given MCC (Mobile Country Code).
1634  * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain.
1635  * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the
1636  * MCC in the cmd response will be the relevant MCC in the NVM.
1637  * @mcc: given mobile country code
1638  * @source_id: identity of the change originator, see iwl_mcc_source
1639  * @reserved1: reserved for alignment
1640  */
1641 struct iwl_mcc_chub_notif {
1642         u16 mcc;
1643         u8 source_id;
1644         u8 reserved1;
1645 } __packed; /* LAR_MCC_NOTIFY_S */
1646
1647 enum iwl_mcc_update_status {
1648         MCC_RESP_NEW_CHAN_PROFILE,
1649         MCC_RESP_SAME_CHAN_PROFILE,
1650         MCC_RESP_INVALID,
1651         MCC_RESP_NVM_DISABLED,
1652         MCC_RESP_ILLEGAL,
1653         MCC_RESP_LOW_PRIORITY,
1654         MCC_RESP_TEST_MODE_ACTIVE,
1655         MCC_RESP_TEST_MODE_NOT_ACTIVE,
1656         MCC_RESP_TEST_MODE_DENIAL_OF_SERVICE,
1657 };
1658
1659 enum iwl_mcc_source {
1660         MCC_SOURCE_OLD_FW = 0,
1661         MCC_SOURCE_ME = 1,
1662         MCC_SOURCE_BIOS = 2,
1663         MCC_SOURCE_3G_LTE_HOST = 3,
1664         MCC_SOURCE_3G_LTE_DEVICE = 4,
1665         MCC_SOURCE_WIFI = 5,
1666         MCC_SOURCE_RESERVED = 6,
1667         MCC_SOURCE_DEFAULT = 7,
1668         MCC_SOURCE_UNINITIALIZED = 8,
1669         MCC_SOURCE_MCC_API = 9,
1670         MCC_SOURCE_GET_CURRENT = 0x10,
1671         MCC_SOURCE_GETTING_MCC_TEST_MODE = 0x11,
1672 };
1673
1674 /* DTS measurements */
1675
1676 enum iwl_dts_measurement_flags {
1677         DTS_TRIGGER_CMD_FLAGS_TEMP      = BIT(0),
1678         DTS_TRIGGER_CMD_FLAGS_VOLT      = BIT(1),
1679 };
1680
1681 /**
1682  * iwl_dts_measurement_cmd - request DTS temperature and/or voltage measurements
1683  *
1684  * @flags: indicates which measurements we want as specified in &enum
1685  *         iwl_dts_measurement_flags
1686  */
1687 struct iwl_dts_measurement_cmd {
1688         __le32 flags;
1689 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_CMD_S */
1690
1691 /**
1692 * enum iwl_dts_control_measurement_mode - DTS measurement type
1693 * @DTS_AUTOMATIC: Automatic mode (full SW control). Provide temperature read
1694 *                 back (latest value. Not waiting for new value). Use automatic
1695 *                 SW DTS configuration.
1696 * @DTS_REQUEST_READ: Request DTS read. Configure DTS with manual settings,
1697 *                    trigger DTS reading and provide read back temperature read
1698 *                    when available.
1699 * @DTS_OVER_WRITE: over-write the DTS temperatures in the SW until next read
1700 * @DTS_DIRECT_WITHOUT_MEASURE: DTS returns its latest temperature result,
1701 *                              without measurement trigger.
1702 */
1703 enum iwl_dts_control_measurement_mode {
1704         DTS_AUTOMATIC                   = 0,
1705         DTS_REQUEST_READ                = 1,
1706         DTS_OVER_WRITE                  = 2,
1707         DTS_DIRECT_WITHOUT_MEASURE      = 3,
1708 };
1709
1710 /**
1711 * enum iwl_dts_used - DTS to use or used for measurement in the DTS request
1712 * @DTS_USE_TOP: Top
1713 * @DTS_USE_CHAIN_A: chain A
1714 * @DTS_USE_CHAIN_B: chain B
1715 * @DTS_USE_CHAIN_C: chain C
1716 * @XTAL_TEMPERATURE - read temperature from xtal
1717 */
1718 enum iwl_dts_used {
1719         DTS_USE_TOP             = 0,
1720         DTS_USE_CHAIN_A         = 1,
1721         DTS_USE_CHAIN_B         = 2,
1722         DTS_USE_CHAIN_C         = 3,
1723         XTAL_TEMPERATURE        = 4,
1724 };
1725
1726 /**
1727 * enum iwl_dts_bit_mode - bit-mode to use in DTS request read mode
1728 * @DTS_BIT6_MODE: bit 6 mode
1729 * @DTS_BIT8_MODE: bit 8 mode
1730 */
1731 enum iwl_dts_bit_mode {
1732         DTS_BIT6_MODE   = 0,
1733         DTS_BIT8_MODE   = 1,
1734 };
1735
1736 /**
1737  * iwl_ext_dts_measurement_cmd - request extended DTS temperature measurements
1738  * @control_mode: see &enum iwl_dts_control_measurement_mode
1739  * @temperature: used when over write DTS mode is selected
1740  * @sensor: set temperature sensor to use. See &enum iwl_dts_used
1741  * @avg_factor: average factor to DTS in request DTS read mode
1742  * @bit_mode: value defines the DTS bit mode to use. See &enum iwl_dts_bit_mode
1743  * @step_duration: step duration for the DTS
1744  */
1745 struct iwl_ext_dts_measurement_cmd {
1746         __le32 control_mode;
1747         __le32 temperature;
1748         __le32 sensor;
1749         __le32 avg_factor;
1750         __le32 bit_mode;
1751         __le32 step_duration;
1752 } __packed; /* XVT_FW_DTS_CONTROL_MEASUREMENT_REQUEST_API_S */
1753
1754 /**
1755  * struct iwl_dts_measurement_notif_v1 - measurements notification
1756  *
1757  * @temp: the measured temperature
1758  * @voltage: the measured voltage
1759  */
1760 struct iwl_dts_measurement_notif_v1 {
1761         __le32 temp;
1762         __le32 voltage;
1763 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_NTFY_S_VER_1*/
1764
1765 /**
1766  * struct iwl_dts_measurement_notif_v2 - measurements notification
1767  *
1768  * @temp: the measured temperature
1769  * @voltage: the measured voltage
1770  * @threshold_idx: the trip index that was crossed
1771  */
1772 struct iwl_dts_measurement_notif_v2 {
1773         __le32 temp;
1774         __le32 voltage;
1775         __le32 threshold_idx;
1776 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_NTFY_S_VER_2 */
1777
1778 /**
1779  * struct ct_kill_notif - CT-kill entry notification
1780  *
1781  * @temperature: the current temperature in celsius
1782  * @reserved: reserved
1783  */
1784 struct ct_kill_notif {
1785         __le16 temperature;
1786         __le16 reserved;
1787 } __packed; /* GRP_PHY_CT_KILL_NTF */
1788
1789 /**
1790 * enum ctdp_cmd_operation - CTDP command operations
1791 * @CTDP_CMD_OPERATION_START: update the current budget
1792 * @CTDP_CMD_OPERATION_STOP: stop ctdp
1793 * @CTDP_CMD_OPERATION_REPORT: get the avgerage budget
1794 */
1795 enum iwl_mvm_ctdp_cmd_operation {
1796         CTDP_CMD_OPERATION_START        = 0x1,
1797         CTDP_CMD_OPERATION_STOP         = 0x2,
1798         CTDP_CMD_OPERATION_REPORT       = 0x4,
1799 };/* CTDP_CMD_OPERATION_TYPE_E */
1800
1801 /**
1802  * struct iwl_mvm_ctdp_cmd - track and manage the FW power consumption budget
1803  *
1804  * @operation: see &enum iwl_mvm_ctdp_cmd_operation
1805  * @budget: the budget in milliwatt
1806  * @window_size: defined in API but not used
1807  */
1808 struct iwl_mvm_ctdp_cmd {
1809         __le32 operation;
1810         __le32 budget;
1811         __le32 window_size;
1812 } __packed;
1813
1814 #define IWL_MAX_DTS_TRIPS       8
1815
1816 /**
1817  * struct iwl_temp_report_ths_cmd - set temperature thresholds
1818  *
1819  * @num_temps: number of temperature thresholds passed
1820  * @thresholds: array with the thresholds to be configured
1821  */
1822 struct temp_report_ths_cmd {
1823         __le32 num_temps;
1824         __le16 thresholds[IWL_MAX_DTS_TRIPS];
1825 } __packed; /* GRP_PHY_TEMP_REPORTING_THRESHOLDS_CMD */
1826
1827 /***********************************
1828  * TDLS API
1829  ***********************************/
1830
1831 /* Type of TDLS request */
1832 enum iwl_tdls_channel_switch_type {
1833         TDLS_SEND_CHAN_SW_REQ = 0,
1834         TDLS_SEND_CHAN_SW_RESP_AND_MOVE_CH,
1835         TDLS_MOVE_CH,
1836 }; /* TDLS_STA_CHANNEL_SWITCH_CMD_TYPE_API_E_VER_1 */
1837
1838 /**
1839  * Switch timing sub-element in a TDLS channel-switch command
1840  * @frame_timestamp: GP2 timestamp of channel-switch request/response packet
1841  *      received from peer
1842  * @max_offchan_duration: What amount of microseconds out of a DTIM is given
1843  *      to the TDLS off-channel communication. For instance if the DTIM is
1844  *      200TU and the TDLS peer is to be given 25% of the time, the value
1845  *      given will be 50TU, or 50 * 1024 if translated into microseconds.
1846  * @switch_time: switch time the peer sent in its channel switch timing IE
1847  * @switch_timout: switch timeout the peer sent in its channel switch timing IE
1848  */
1849 struct iwl_tdls_channel_switch_timing {
1850         __le32 frame_timestamp; /* GP2 time of peer packet Rx */
1851         __le32 max_offchan_duration; /* given in micro-seconds */
1852         __le32 switch_time; /* given in micro-seconds */
1853         __le32 switch_timeout; /* given in micro-seconds */
1854 } __packed; /* TDLS_STA_CHANNEL_SWITCH_TIMING_DATA_API_S_VER_1 */
1855
1856 #define IWL_TDLS_CH_SW_FRAME_MAX_SIZE 200
1857
1858 /**
1859  * TDLS channel switch frame template
1860  *
1861  * A template representing a TDLS channel-switch request or response frame
1862  *
1863  * @switch_time_offset: offset to the channel switch timing IE in the template
1864  * @tx_cmd: Tx parameters for the frame
1865  * @data: frame data
1866  */
1867 struct iwl_tdls_channel_switch_frame {
1868         __le32 switch_time_offset;
1869         struct iwl_tx_cmd tx_cmd;
1870         u8 data[IWL_TDLS_CH_SW_FRAME_MAX_SIZE];
1871 } __packed; /* TDLS_STA_CHANNEL_SWITCH_FRAME_API_S_VER_1 */
1872
1873 /**
1874  * TDLS channel switch command
1875  *
1876  * The command is sent to initiate a channel switch and also in response to
1877  * incoming TDLS channel-switch request/response packets from remote peers.
1878  *
1879  * @switch_type: see &enum iwl_tdls_channel_switch_type
1880  * @peer_sta_id: station id of TDLS peer
1881  * @ci: channel we switch to
1882  * @timing: timing related data for command
1883  * @frame: channel-switch request/response template, depending to switch_type
1884  */
1885 struct iwl_tdls_channel_switch_cmd {
1886         u8 switch_type;
1887         __le32 peer_sta_id;
1888         struct iwl_fw_channel_info ci;
1889         struct iwl_tdls_channel_switch_timing timing;
1890         struct iwl_tdls_channel_switch_frame frame;
1891 } __packed; /* TDLS_STA_CHANNEL_SWITCH_CMD_API_S_VER_1 */
1892
1893 /**
1894  * TDLS channel switch start notification
1895  *
1896  * @status: non-zero on success
1897  * @offchannel_duration: duration given in microseconds
1898  * @sta_id: peer currently performing the channel-switch with
1899  */
1900 struct iwl_tdls_channel_switch_notif {
1901         __le32 status;
1902         __le32 offchannel_duration;
1903         __le32 sta_id;
1904 } __packed; /* TDLS_STA_CHANNEL_SWITCH_NTFY_API_S_VER_1 */
1905
1906 /**
1907  * TDLS station info
1908  *
1909  * @sta_id: station id of the TDLS peer
1910  * @tx_to_peer_tid: TID reserved vs. the peer for FW based Tx
1911  * @tx_to_peer_ssn: initial SSN the FW should use for Tx on its TID vs the peer
1912  * @is_initiator: 1 if the peer is the TDLS link initiator, 0 otherwise
1913  */
1914 struct iwl_tdls_sta_info {
1915         u8 sta_id;
1916         u8 tx_to_peer_tid;
1917         __le16 tx_to_peer_ssn;
1918         __le32 is_initiator;
1919 } __packed; /* TDLS_STA_INFO_VER_1 */
1920
1921 /**
1922  * TDLS basic config command
1923  *
1924  * @id_and_color: MAC id and color being configured
1925  * @tdls_peer_count: amount of currently connected TDLS peers
1926  * @tx_to_ap_tid: TID reverved vs. the AP for FW based Tx
1927  * @tx_to_ap_ssn: initial SSN the FW should use for Tx on its TID vs. the AP
1928  * @sta_info: per-station info. Only the first tdls_peer_count entries are set
1929  * @pti_req_data_offset: offset of network-level data for the PTI template
1930  * @pti_req_tx_cmd: Tx parameters for PTI request template
1931  * @pti_req_template: PTI request template data
1932  */
1933 struct iwl_tdls_config_cmd {
1934         __le32 id_and_color; /* mac id and color */
1935         u8 tdls_peer_count;
1936         u8 tx_to_ap_tid;
1937         __le16 tx_to_ap_ssn;
1938         struct iwl_tdls_sta_info sta_info[IWL_MVM_TDLS_STA_COUNT];
1939
1940         __le32 pti_req_data_offset;
1941         struct iwl_tx_cmd pti_req_tx_cmd;
1942         u8 pti_req_template[0];
1943 } __packed; /* TDLS_CONFIG_CMD_API_S_VER_1 */
1944
1945 /**
1946  * TDLS per-station config information from FW
1947  *
1948  * @sta_id: station id of the TDLS peer
1949  * @tx_to_peer_last_seq: last sequence number used by FW during FW-based Tx to
1950  *      the peer
1951  */
1952 struct iwl_tdls_config_sta_info_res {
1953         __le16 sta_id;
1954         __le16 tx_to_peer_last_seq;
1955 } __packed; /* TDLS_STA_INFO_RSP_VER_1 */
1956
1957 /**
1958  * TDLS config information from FW
1959  *
1960  * @tx_to_ap_last_seq: last sequence number used by FW during FW-based Tx to AP
1961  * @sta_info: per-station TDLS config information
1962  */
1963 struct iwl_tdls_config_res {
1964         __le32 tx_to_ap_last_seq;
1965         struct iwl_tdls_config_sta_info_res sta_info[IWL_MVM_TDLS_STA_COUNT];
1966 } __packed; /* TDLS_CONFIG_RSP_API_S_VER_1 */
1967
1968 #define TX_FIFO_MAX_NUM         8
1969 #define RX_FIFO_MAX_NUM         2
1970 #define TX_FIFO_INTERNAL_MAX_NUM        6
1971
1972 /**
1973  * Shared memory configuration information from the FW
1974  *
1975  * @shared_mem_addr: shared memory addr (pre 8000 HW set to 0x0 as MARBH is not
1976  *      accessible)
1977  * @shared_mem_size: shared memory size
1978  * @sample_buff_addr: internal sample (mon/adc) buff addr (pre 8000 HW set to
1979  *      0x0 as accessible only via DBGM RDAT)
1980  * @sample_buff_size: internal sample buff size
1981  * @txfifo_addr: start addr of TXF0 (excluding the context table 0.5KB), (pre
1982  *      8000 HW set to 0x0 as not accessible)
1983  * @txfifo_size: size of TXF0 ... TXF7
1984  * @rxfifo_size: RXF1, RXF2 sizes. If there is no RXF2, it'll have a value of 0
1985  * @page_buff_addr: used by UMAC and performance debug (page miss analysis),
1986  *      when paging is not supported this should be 0
1987  * @page_buff_size: size of %page_buff_addr
1988  * @rxfifo_addr: Start address of rxFifo
1989  * @internal_txfifo_addr: start address of internalFifo
1990  * @internal_txfifo_size: internal fifos' size
1991  *
1992  * NOTE: on firmware that don't have IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG
1993  *       set, the last 3 members don't exist.
1994  */
1995 struct iwl_shared_mem_cfg {
1996         __le32 shared_mem_addr;
1997         __le32 shared_mem_size;
1998         __le32 sample_buff_addr;
1999         __le32 sample_buff_size;
2000         __le32 txfifo_addr;
2001         __le32 txfifo_size[TX_FIFO_MAX_NUM];
2002         __le32 rxfifo_size[RX_FIFO_MAX_NUM];
2003         __le32 page_buff_addr;
2004         __le32 page_buff_size;
2005         __le32 rxfifo_addr;
2006         __le32 internal_txfifo_addr;
2007         __le32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM];
2008 } __packed; /* SHARED_MEM_ALLOC_API_S_VER_2 */
2009
2010 /**
2011  * VHT MU-MIMO group configuration
2012  *
2013  * @membership_status: a bitmap of MU groups
2014  * @user_position:the position of station in a group. If the station is in the
2015  *      group then bits (group * 2) is the position -1
2016  */
2017 struct iwl_mu_group_mgmt_cmd {
2018         __le32 reserved;
2019         __le32 membership_status[2];
2020         __le32 user_position[4];
2021 } __packed; /* MU_GROUP_ID_MNG_TABLE_API_S_VER_1 */
2022
2023 /**
2024  * struct iwl_mu_group_mgmt_notif - VHT MU-MIMO group id notification
2025  *
2026  * @membership_status: a bitmap of MU groups
2027  * @user_position: the position of station in a group. If the station is in the
2028  *      group then bits (group * 2) is the position -1
2029  */
2030 struct iwl_mu_group_mgmt_notif {
2031         __le32 membership_status[2];
2032         __le32 user_position[4];
2033 } __packed; /* MU_GROUP_MNG_NTFY_API_S_VER_1 */
2034
2035 #define MAX_STORED_BEACON_SIZE 600
2036
2037 /**
2038  * Stored beacon notification
2039  *
2040  * @system_time: system time on air rise
2041  * @tsf: TSF on air rise
2042  * @beacon_timestamp: beacon on air rise
2043  * @phy_flags: general phy flags: band, modulation, etc.
2044  * @channel: channel this beacon was received on
2045  * @rates: rate in ucode internal format
2046  * @byte_count: frame's byte count
2047  */
2048 struct iwl_stored_beacon_notif {
2049         __le32 system_time;
2050         __le64 tsf;
2051         __le32 beacon_timestamp;
2052         __le16 phy_flags;
2053         __le16 channel;
2054         __le32 rates;
2055         __le32 byte_count;
2056         u8 data[MAX_STORED_BEACON_SIZE];
2057 } __packed; /* WOWLAN_STROED_BEACON_INFO_S_VER_1 */
2058
2059 #define LQM_NUMBER_OF_STATIONS_IN_REPORT 16
2060
2061 enum iwl_lqm_cmd_operatrions {
2062         LQM_CMD_OPERATION_START_MEASUREMENT = 0x01,
2063         LQM_CMD_OPERATION_STOP_MEASUREMENT = 0x02,
2064 };
2065
2066 enum iwl_lqm_status {
2067         LQM_STATUS_SUCCESS = 0,
2068         LQM_STATUS_TIMEOUT = 1,
2069         LQM_STATUS_ABORT = 2,
2070 };
2071
2072 /**
2073  * Link Quality Measurement command
2074  * @cmd_operatrion: command operation to be performed (start or stop)
2075  *      as defined above.
2076  * @mac_id: MAC ID the measurement applies to.
2077  * @measurement_time: time of the total measurement to be performed, in uSec.
2078  * @timeout: maximum time allowed until a response is sent, in uSec.
2079  */
2080 struct iwl_link_qual_msrmnt_cmd {
2081         __le32 cmd_operation;
2082         __le32 mac_id;
2083         __le32 measurement_time;
2084         __le32 timeout;
2085 } __packed /* LQM_CMD_API_S_VER_1 */;
2086
2087 /**
2088  * Link Quality Measurement notification
2089  *
2090  * @frequent_stations_air_time: an array containing the total air time
2091  *      (in uSec) used by the most frequently transmitting stations.
2092  * @number_of_stations: the number of uniqe stations included in the array
2093  *      (a number between 0 to 16)
2094  * @total_air_time_other_stations: the total air time (uSec) used by all the
2095  *      stations which are not included in the above report.
2096  * @time_in_measurement_window: the total time in uSec in which a measurement
2097  *      took place.
2098  * @tx_frame_dropped: the number of TX frames dropped due to retry limit during
2099  *      measurement
2100  * @mac_id: MAC ID the measurement applies to.
2101  * @status: return status. may be one of the LQM_STATUS_* defined above.
2102  * @reserved: reserved.
2103  */
2104 struct iwl_link_qual_msrmnt_notif {
2105         __le32 frequent_stations_air_time[LQM_NUMBER_OF_STATIONS_IN_REPORT];
2106         __le32 number_of_stations;
2107         __le32 total_air_time_other_stations;
2108         __le32 time_in_measurement_window;
2109         __le32 tx_frame_dropped;
2110         __le32 mac_id;
2111         __le32 status;
2112         __le32 reserved[3];
2113 } __packed; /* LQM_MEASUREMENT_COMPLETE_NTF_API_S_VER1 */
2114
2115 /**
2116  * Channel switch NOA notification
2117  *
2118  * @id_and_color: ID and color of the MAC
2119  */
2120 struct iwl_channel_switch_noa_notif {
2121         __le32 id_and_color;
2122 } __packed; /* CHANNEL_SWITCH_START_NTFY_API_S_VER_1 */
2123
2124 #endif /* __fw_api_h__ */