drivers/net/wireless/iwlwifi/mvm/fw-api.h

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