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

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