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