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