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