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