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

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