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