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

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