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