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