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

   1 /******************************************************************************
   2  *
   3  * This file is provided under a dual BSD/GPLv2 license.  When using or
   4  * redistributing this file, you may do so under either license.
   5  *
   6  * GPL LICENSE SUMMARY
   7  *
   8  * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of version 2 of the GNU General Public License as
  12  * published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  22  * USA
  23  *
  24  * The full GNU General Public License is included in this distribution
  25  * in the file called COPYING.
  26  *
  27  * Contact Information:
  28  *  Intel Linux Wireless <ilw@linux.intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  *
  40  *  * Redistributions of source code must retain the above copyright
  41  *    notice, this list of conditions and the following disclaimer.
  42  *  * Redistributions in binary form must reproduce the above copyright
  43  *    notice, this list of conditions and the following disclaimer in
  44  *    the documentation and/or other materials provided with the
  45  *    distribution.
  46  *  * Neither the name Intel Corporation nor the names of its
  47  *    contributors may be used to endorse or promote products derived
  48  *    from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  54  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  56  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  60  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  *
  62  *****************************************************************************/
  63
  64 #ifndef __fw_api_h__
  65 #define __fw_api_h__
  66
  67 #include "fw-api-rs.h"
  68 #include "fw-api-tx.h"
  69 #include "fw-api-sta.h"
  70 #include "fw-api-mac.h"
  71 #include "fw-api-power.h"
  72 #include "fw-api-d3.h"
  73 #include "fw-api-bt-coex.h"
  74
  75 /* queue and FIFO numbers by usage */
  76 enum {
  77         IWL_MVM_OFFCHANNEL_QUEUE = 8,
  78         IWL_MVM_CMD_QUEUE = 9,
  79         IWL_MVM_AUX_QUEUE = 15,
  80         IWL_MVM_FIRST_AGG_QUEUE = 16,
  81         IWL_MVM_NUM_QUEUES = 20,
  82         IWL_MVM_LAST_AGG_QUEUE = IWL_MVM_NUM_QUEUES - 1,
  83         IWL_MVM_CMD_FIFO = 7
  84 };
  85
  86 #define IWL_MVM_STATION_COUNT   16
  87
  88 /* commands */
  89 enum {
  90         MVM_ALIVE = 0x1,
  91         REPLY_ERROR = 0x2,
  92
  93         INIT_COMPLETE_NOTIF = 0x4,
  94
  95         /* PHY context commands */
  96         PHY_CONTEXT_CMD = 0x8,
  97         DBG_CFG = 0x9,
  98
  99         /* station table */
 100         ADD_STA = 0x18,
 101         REMOVE_STA = 0x19,
 102
 103         /* TX */
 104         TX_CMD = 0x1c,
 105         TXPATH_FLUSH = 0x1e,
 106         MGMT_MCAST_KEY = 0x1f,
 107
 108         /* global key */
 109         WEP_KEY = 0x20,
 110
 111         /* MAC and Binding commands */
 112         MAC_CONTEXT_CMD = 0x28,
 113         TIME_EVENT_CMD = 0x29, /* both CMD and response */
 114         TIME_EVENT_NOTIFICATION = 0x2a,
 115         BINDING_CONTEXT_CMD = 0x2b,
 116         TIME_QUOTA_CMD = 0x2c,
 117
 118         LQ_CMD = 0x4e,
 119
 120         /* Calibration */
 121         TEMPERATURE_NOTIFICATION = 0x62,
 122         CALIBRATION_CFG_CMD = 0x65,
 123         CALIBRATION_RES_NOTIFICATION = 0x66,
 124         CALIBRATION_COMPLETE_NOTIFICATION = 0x67,
 125         RADIO_VERSION_NOTIFICATION = 0x68,
 126
 127         /* Scan offload */
 128         SCAN_OFFLOAD_REQUEST_CMD = 0x51,
 129         SCAN_OFFLOAD_ABORT_CMD = 0x52,
 130         SCAN_OFFLOAD_COMPLETE = 0x6D,
 131         SCAN_OFFLOAD_UPDATE_PROFILES_CMD = 0x6E,
 132         SCAN_OFFLOAD_CONFIG_CMD = 0x6f,
 133
 134         /* Phy */
 135         PHY_CONFIGURATION_CMD = 0x6a,
 136         CALIB_RES_NOTIF_PHY_DB = 0x6b,
 137         /* PHY_DB_CMD = 0x6c, */
 138
 139         /* Power */
 140         POWER_TABLE_CMD = 0x77,
 141
 142         /* Scanning */
 143         SCAN_REQUEST_CMD = 0x80,
 144         SCAN_ABORT_CMD = 0x81,
 145         SCAN_START_NOTIFICATION = 0x82,
 146         SCAN_RESULTS_NOTIFICATION = 0x83,
 147         SCAN_COMPLETE_NOTIFICATION = 0x84,
 148
 149         /* NVM */
 150         NVM_ACCESS_CMD = 0x88,
 151
 152         SET_CALIB_DEFAULT_CMD = 0x8e,
 153
 154         BEACON_TEMPLATE_CMD = 0x91,
 155         TX_ANT_CONFIGURATION_CMD = 0x98,
 156         BT_CONFIG = 0x9b,
 157         STATISTICS_NOTIFICATION = 0x9d,
 158
 159         /* RF-KILL commands and notifications */
 160         CARD_STATE_CMD = 0xa0,
 161         CARD_STATE_NOTIFICATION = 0xa1,
 162
 163         REPLY_RX_PHY_CMD = 0xc0,
 164         REPLY_RX_MPDU_CMD = 0xc1,
 165         BA_NOTIF = 0xc5,
 166
 167         /* BT Coex */
 168         BT_COEX_PRIO_TABLE = 0xcc,
 169         BT_COEX_PROT_ENV = 0xcd,
 170         BT_PROFILE_NOTIFICATION = 0xce,
 171
 172         REPLY_DEBUG_CMD = 0xf0,
 173         DEBUG_LOG_MSG = 0xf7,
 174
 175         /* D3 commands/notifications */
 176         D3_CONFIG_CMD = 0xd3,
 177         PROT_OFFLOAD_CONFIG_CMD = 0xd4,
 178         OFFLOADS_QUERY_CMD = 0xd5,
 179         REMOTE_WAKE_CONFIG_CMD = 0xd6,
 180
 181         /* for WoWLAN in particular */
 182         WOWLAN_PATTERNS = 0xe0,
 183         WOWLAN_CONFIGURATION = 0xe1,
 184         WOWLAN_TSC_RSC_PARAM = 0xe2,
 185         WOWLAN_TKIP_PARAM = 0xe3,
 186         WOWLAN_KEK_KCK_MATERIAL = 0xe4,
 187         WOWLAN_GET_STATUSES = 0xe5,
 188         WOWLAN_TX_POWER_PER_DB = 0xe6,
 189
 190         /* and for NetDetect */
 191         NET_DETECT_CONFIG_CMD = 0x54,
 192         NET_DETECT_PROFILES_QUERY_CMD = 0x56,
 193         NET_DETECT_PROFILES_CMD = 0x57,
 194         NET_DETECT_HOTSPOTS_CMD = 0x58,
 195         NET_DETECT_HOTSPOTS_QUERY_CMD = 0x59,
 196
 197         REPLY_MAX = 0xff,
 198 };
 199
 200 /**
 201  * struct iwl_cmd_response - generic response struct for most commands
 202  * @status: status of the command asked, changes for each one
 203  */
 204 struct iwl_cmd_response {
 205         __le32 status;
 206 };
 207
 208 /*
 209  * struct iwl_tx_ant_cfg_cmd
 210  * @valid: valid antenna configuration
 211  */
 212 struct iwl_tx_ant_cfg_cmd {
 213         __le32 valid;
 214 } __packed;
 215
 216 /*
 217  * Calibration control struct.
 218  * Sent as part of the phy configuration command.
 219  * @flow_trigger: bitmap for which calibrations to perform according to
 220  *              flow triggers.
 221  * @event_trigger: bitmap for which calibrations to perform according to
 222  *              event triggers.
 223  */
 224 struct iwl_calib_ctrl {
 225         __le32 flow_trigger;
 226         __le32 event_trigger;
 227 } __packed;
 228
 229 /* This enum defines the bitmap of various calibrations to enable in both
 230  * init ucode and runtime ucode through CALIBRATION_CFG_CMD.
 231  */
 232 enum iwl_calib_cfg {
 233         IWL_CALIB_CFG_XTAL_IDX                  = BIT(0),
 234         IWL_CALIB_CFG_TEMPERATURE_IDX           = BIT(1),
 235         IWL_CALIB_CFG_VOLTAGE_READ_IDX          = BIT(2),
 236         IWL_CALIB_CFG_PAPD_IDX                  = BIT(3),
 237         IWL_CALIB_CFG_TX_PWR_IDX                = BIT(4),
 238         IWL_CALIB_CFG_DC_IDX                    = BIT(5),
 239         IWL_CALIB_CFG_BB_FILTER_IDX             = BIT(6),
 240         IWL_CALIB_CFG_LO_LEAKAGE_IDX            = BIT(7),
 241         IWL_CALIB_CFG_TX_IQ_IDX                 = BIT(8),
 242         IWL_CALIB_CFG_TX_IQ_SKEW_IDX            = BIT(9),
 243         IWL_CALIB_CFG_RX_IQ_IDX                 = BIT(10),
 244         IWL_CALIB_CFG_RX_IQ_SKEW_IDX            = BIT(11),
 245         IWL_CALIB_CFG_SENSITIVITY_IDX           = BIT(12),
 246         IWL_CALIB_CFG_CHAIN_NOISE_IDX           = BIT(13),
 247         IWL_CALIB_CFG_DISCONNECTED_ANT_IDX      = BIT(14),
 248         IWL_CALIB_CFG_ANT_COUPLING_IDX          = BIT(15),
 249         IWL_CALIB_CFG_DAC_IDX                   = BIT(16),
 250         IWL_CALIB_CFG_ABS_IDX                   = BIT(17),
 251         IWL_CALIB_CFG_AGC_IDX                   = BIT(18),
 252 };
 253
 254 /*
 255  * Phy configuration command.
 256  */
 257 struct iwl_phy_cfg_cmd {
 258         __le32  phy_cfg;
 259         struct iwl_calib_ctrl calib_control;
 260 } __packed;
 261
 262 #define PHY_CFG_RADIO_TYPE      (BIT(0) | BIT(1))
 263 #define PHY_CFG_RADIO_STEP      (BIT(2) | BIT(3))
 264 #define PHY_CFG_RADIO_DASH      (BIT(4) | BIT(5))
 265 #define PHY_CFG_PRODUCT_NUMBER  (BIT(6) | BIT(7))
 266 #define PHY_CFG_TX_CHAIN_A      BIT(8)
 267 #define PHY_CFG_TX_CHAIN_B      BIT(9)
 268 #define PHY_CFG_TX_CHAIN_C      BIT(10)
 269 #define PHY_CFG_RX_CHAIN_A      BIT(12)
 270 #define PHY_CFG_RX_CHAIN_B      BIT(13)
 271 #define PHY_CFG_RX_CHAIN_C      BIT(14)
 272
 273
 274 /* Target of the NVM_ACCESS_CMD */
 275 enum {
 276         NVM_ACCESS_TARGET_CACHE = 0,
 277         NVM_ACCESS_TARGET_OTP = 1,
 278         NVM_ACCESS_TARGET_EEPROM = 2,
 279 };
 280
 281 /* Section types for NVM_ACCESS_CMD */
 282 enum {
 283         NVM_SECTION_TYPE_HW = 0,
 284         NVM_SECTION_TYPE_SW,
 285         NVM_SECTION_TYPE_PAPD,
 286         NVM_SECTION_TYPE_BT,
 287         NVM_SECTION_TYPE_CALIBRATION,
 288         NVM_SECTION_TYPE_PRODUCTION,
 289         NVM_SECTION_TYPE_POST_FCS_CALIB,
 290         NVM_NUM_OF_SECTIONS,
 291 };
 292
 293 /**
 294  * struct iwl_nvm_access_cmd_ver2 - Request the device to send an NVM section
 295  * @op_code: 0 - read, 1 - write
 296  * @target: NVM_ACCESS_TARGET_*
 297  * @type: NVM_SECTION_TYPE_*
 298  * @offset: offset in bytes into the section
 299  * @length: in bytes, to read/write
 300  * @data: if write operation, the data to write. On read its empty
 301  */
 302 struct iwl_nvm_access_cmd {
 303         u8 op_code;
 304         u8 target;
 305         __le16 type;
 306         __le16 offset;
 307         __le16 length;
 308         u8 data[];
 309 } __packed; /* NVM_ACCESS_CMD_API_S_VER_2 */
 310
 311 /**
 312  * struct iwl_nvm_access_resp_ver2 - response to NVM_ACCESS_CMD
 313  * @offset: offset in bytes into the section
 314  * @length: in bytes, either how much was written or read
 315  * @type: NVM_SECTION_TYPE_*
 316  * @status: 0 for success, fail otherwise
 317  * @data: if read operation, the data returned. Empty on write.
 318  */
 319 struct iwl_nvm_access_resp {
 320         __le16 offset;
 321         __le16 length;
 322         __le16 type;
 323         __le16 status;
 324         u8 data[];
 325 } __packed; /* NVM_ACCESS_CMD_RESP_API_S_VER_2 */
 326
 327 /* MVM_ALIVE 0x1 */
 328
 329 /* alive response is_valid values */
 330 #define ALIVE_RESP_UCODE_OK     BIT(0)
 331 #define ALIVE_RESP_RFKILL       BIT(1)
 332
 333 /* alive response ver_type values */
 334 enum {
 335         FW_TYPE_HW = 0,
 336         FW_TYPE_PROT = 1,
 337         FW_TYPE_AP = 2,
 338         FW_TYPE_WOWLAN = 3,
 339         FW_TYPE_TIMING = 4,
 340         FW_TYPE_WIPAN = 5
 341 };
 342
 343 /* alive response ver_subtype values */
 344 enum {
 345         FW_SUBTYPE_FULL_FEATURE = 0,
 346         FW_SUBTYPE_BOOTSRAP = 1, /* Not valid */
 347         FW_SUBTYPE_REDUCED = 2,
 348         FW_SUBTYPE_ALIVE_ONLY = 3,
 349         FW_SUBTYPE_WOWLAN = 4,
 350         FW_SUBTYPE_AP_SUBTYPE = 5,
 351         FW_SUBTYPE_WIPAN = 6,
 352         FW_SUBTYPE_INITIALIZE = 9
 353 };
 354
 355 #define IWL_ALIVE_STATUS_ERR 0xDEAD
 356 #define IWL_ALIVE_STATUS_OK 0xCAFE
 357
 358 #define IWL_ALIVE_FLG_RFKILL    BIT(0)
 359
 360 struct mvm_alive_resp {
 361         __le16 status;
 362         __le16 flags;
 363         u8 ucode_minor;
 364         u8 ucode_major;
 365         __le16 id;
 366         u8 api_minor;
 367         u8 api_major;
 368         u8 ver_subtype;
 369         u8 ver_type;
 370         u8 mac;
 371         u8 opt;
 372         __le16 reserved2;
 373         __le32 timestamp;
 374         __le32 error_event_table_ptr;   /* SRAM address for error log */
 375         __le32 log_event_table_ptr;     /* SRAM address for event log */
 376         __le32 cpu_register_ptr;
 377         __le32 dbgm_config_ptr;
 378         __le32 alive_counter_ptr;
 379         __le32 scd_base_ptr;            /* SRAM address for SCD */
 380 } __packed; /* ALIVE_RES_API_S_VER_1 */
 381
 382 /* Error response/notification */
 383 enum {
 384         FW_ERR_UNKNOWN_CMD = 0x0,
 385         FW_ERR_INVALID_CMD_PARAM = 0x1,
 386         FW_ERR_SERVICE = 0x2,
 387         FW_ERR_ARC_MEMORY = 0x3,
 388         FW_ERR_ARC_CODE = 0x4,
 389         FW_ERR_WATCH_DOG = 0x5,
 390         FW_ERR_WEP_GRP_KEY_INDX = 0x10,
 391         FW_ERR_WEP_KEY_SIZE = 0x11,
 392         FW_ERR_OBSOLETE_FUNC = 0x12,
 393         FW_ERR_UNEXPECTED = 0xFE,
 394         FW_ERR_FATAL = 0xFF
 395 };
 396
 397 /**
 398  * struct iwl_error_resp - FW error indication
 399  * ( REPLY_ERROR = 0x2 )
 400  * @error_type: one of FW_ERR_*
 401  * @cmd_id: the command ID for which the error occured
 402  * @bad_cmd_seq_num: sequence number of the erroneous command
 403  * @error_service: which service created the error, applicable only if
 404  *      error_type = 2, otherwise 0
 405  * @timestamp: TSF in usecs.
 406  */
 407 struct iwl_error_resp {
 408         __le32 error_type;
 409         u8 cmd_id;
 410         u8 reserved1;
 411         __le16 bad_cmd_seq_num;
 412         __le32 error_service;
 413         __le64 timestamp;
 414 } __packed;
 415
 416
 417 /* Common PHY, MAC and Bindings definitions */
 418
 419 #define MAX_MACS_IN_BINDING     (3)
 420 #define MAX_BINDINGS            (4)
 421 #define AUX_BINDING_INDEX       (3)
 422 #define MAX_PHYS                (4)
 423
 424 /* Used to extract ID and color from the context dword */
 425 #define FW_CTXT_ID_POS    (0)
 426 #define FW_CTXT_ID_MSK    (0xff << FW_CTXT_ID_POS)
 427 #define FW_CTXT_COLOR_POS (8)
 428 #define FW_CTXT_COLOR_MSK (0xff << FW_CTXT_COLOR_POS)
 429 #define FW_CTXT_INVALID   (0xffffffff)
 430
 431 #define FW_CMD_ID_AND_COLOR(_id, _color) ((_id << FW_CTXT_ID_POS) |\
 432                                           (_color << FW_CTXT_COLOR_POS))
 433
 434 /* Possible actions on PHYs, MACs and Bindings */
 435 enum {
 436         FW_CTXT_ACTION_STUB = 0,
 437         FW_CTXT_ACTION_ADD,
 438         FW_CTXT_ACTION_MODIFY,
 439         FW_CTXT_ACTION_REMOVE,
 440         FW_CTXT_ACTION_NUM
 441 }; /* COMMON_CONTEXT_ACTION_API_E_VER_1 */
 442
 443 /* Time Events */
 444
 445 /* Time Event types, according to MAC type */
 446 enum iwl_time_event_type {
 447         /* BSS Station Events */
 448         TE_BSS_STA_AGGRESSIVE_ASSOC,
 449         TE_BSS_STA_ASSOC,
 450         TE_BSS_EAP_DHCP_PROT,
 451         TE_BSS_QUIET_PERIOD,
 452
 453         /* P2P Device Events */
 454         TE_P2P_DEVICE_DISCOVERABLE,
 455         TE_P2P_DEVICE_LISTEN,
 456         TE_P2P_DEVICE_ACTION_SCAN,
 457         TE_P2P_DEVICE_FULL_SCAN,
 458
 459         /* P2P Client Events */
 460         TE_P2P_CLIENT_AGGRESSIVE_ASSOC,
 461         TE_P2P_CLIENT_ASSOC,
 462         TE_P2P_CLIENT_QUIET_PERIOD,
 463
 464         /* P2P GO Events */
 465         TE_P2P_GO_ASSOC_PROT,
 466         TE_P2P_GO_REPETITIVE_NOA,
 467         TE_P2P_GO_CT_WINDOW,
 468
 469         /* WiDi Sync Events */
 470         TE_WIDI_TX_SYNC,
 471
 472         TE_MAX
 473 }; /* MAC_EVENT_TYPE_API_E_VER_1 */
 474
 475 /* Time Event dependencies: none, on another TE, or in a specific time */
 476 enum {
 477         TE_INDEPENDENT          = 0,
 478         TE_DEP_OTHER            = 1,
 479         TE_DEP_TSF              = 2,
 480         TE_EVENT_SOCIOPATHIC    = 4,
 481 }; /* MAC_EVENT_DEPENDENCY_POLICY_API_E_VER_2 */
 482
 483 /* When to send Time Event notifications and to whom (internal = FW) */
 484 enum {
 485         TE_NOTIF_NONE = 0,
 486         TE_NOTIF_HOST_START = 0x1,
 487         TE_NOTIF_HOST_END = 0x2,
 488         TE_NOTIF_INTERNAL_START = 0x4,
 489         TE_NOTIF_INTERNAL_END = 0x8
 490 }; /* MAC_EVENT_ACTION_API_E_VER_1 */
 491
 492 /*
 493  * @TE_FRAG_NONE: fragmentation of the time event is NOT allowed.
 494  * @TE_FRAG_SINGLE: fragmentation of the time event is allowed, but only
 495  *  the first fragment is scheduled.
 496  * @TE_FRAG_DUAL: fragmentation of the time event is allowed, but only
 497  *  the first 2 fragments are scheduled.
 498  * @TE_FRAG_ENDLESS: fragmentation of the time event is allowed, and any number
 499  *  of fragments are valid.
 500  *
 501  * Other than the constant defined above, specifying a fragmentation value 'x'
 502  * means that the event can be fragmented but only the first 'x' will be
 503  * scheduled.
 504  */
 505 enum {
 506         TE_FRAG_NONE = 0,
 507         TE_FRAG_SINGLE = 1,
 508         TE_FRAG_DUAL = 2,
 509         TE_FRAG_ENDLESS = 0xffffffff
 510 };
 511
 512 /* Repeat the time event endlessly (until removed) */
 513 #define TE_REPEAT_ENDLESS       (0xffffffff)
 514 /* If a Time Event has bounded repetitions, this is the maximal value */
 515 #define TE_REPEAT_MAX_MSK       (0x0fffffff)
 516 /* If a Time Event can be fragmented, this is the max number of fragments */
 517 #define TE_FRAG_MAX_MSK         (0x0fffffff)
 518
 519 /**
 520  * struct iwl_time_event_cmd - configuring Time Events
 521  * ( TIME_EVENT_CMD = 0x29 )
 522  * @id_and_color: ID and color of the relevant MAC
 523  * @action: action to perform, one of FW_CTXT_ACTION_*
 524  * @id: this field has two meanings, depending on the action:
 525  *      If the action is ADD, then it means the type of event to add.
 526  *      For all other actions it is the unique event ID assigned when the
 527  *      event was added by the FW.
 528  * @apply_time: When to start the Time Event (in GP2)
 529  * @max_delay: maximum delay to event's start (apply time), in TU
 530  * @depends_on: the unique ID of the event we depend on (if any)
 531  * @interval: interval between repetitions, in TU
 532  * @interval_reciprocal: 2^32 / interval
 533  * @duration: duration of event in TU
 534  * @repeat: how many repetitions to do, can be TE_REPEAT_ENDLESS
 535  * @dep_policy: one of TE_INDEPENDENT, TE_DEP_OTHER, TE_DEP_TSF
 536  * @is_present: 0 or 1, are we present or absent during the Time Event
 537  * @max_frags: maximal number of fragments the Time Event can be divided to
 538  * @notify: notifications using TE_NOTIF_* (whom to notify when)
 539  */
 540 struct iwl_time_event_cmd {
 541         /* COMMON_INDEX_HDR_API_S_VER_1 */
 542         __le32 id_and_color;
 543         __le32 action;
 544         __le32 id;
 545         /* MAC_TIME_EVENT_DATA_API_S_VER_1 */
 546         __le32 apply_time;
 547         __le32 max_delay;
 548         __le32 dep_policy;
 549         __le32 depends_on;
 550         __le32 is_present;
 551         __le32 max_frags;
 552         __le32 interval;
 553         __le32 interval_reciprocal;
 554         __le32 duration;
 555         __le32 repeat;
 556         __le32 notify;
 557 } __packed; /* MAC_TIME_EVENT_CMD_API_S_VER_1 */
 558
 559 /**
 560  * struct iwl_time_event_resp - response structure to iwl_time_event_cmd
 561  * @status: bit 0 indicates success, all others specify errors
 562  * @id: the Time Event type
 563  * @unique_id: the unique ID assigned (in ADD) or given (others) to the TE
 564  * @id_and_color: ID and color of the relevant MAC
 565  */
 566 struct iwl_time_event_resp {
 567         __le32 status;
 568         __le32 id;
 569         __le32 unique_id;
 570         __le32 id_and_color;
 571 } __packed; /* MAC_TIME_EVENT_RSP_API_S_VER_1 */
 572
 573 /**
 574  * struct iwl_time_event_notif - notifications of time event start/stop
 575  * ( TIME_EVENT_NOTIFICATION = 0x2a )
 576  * @timestamp: action timestamp in GP2
 577  * @session_id: session's unique id
 578  * @unique_id: unique id of the Time Event itself
 579  * @id_and_color: ID and color of the relevant MAC
 580  * @action: one of TE_NOTIF_START or TE_NOTIF_END
 581  * @status: true if scheduled, false otherwise (not executed)
 582  */
 583 struct iwl_time_event_notif {
 584         __le32 timestamp;
 585         __le32 session_id;
 586         __le32 unique_id;
 587         __le32 id_and_color;
 588         __le32 action;
 589         __le32 status;
 590 } __packed; /* MAC_TIME_EVENT_NTFY_API_S_VER_1 */
 591
 592
 593 /* Bindings and Time Quota */
 594
 595 /**
 596  * struct iwl_binding_cmd - configuring bindings
 597  * ( BINDING_CONTEXT_CMD = 0x2b )
 598  * @id_and_color: ID and color of the relevant Binding
 599  * @action: action to perform, one of FW_CTXT_ACTION_*
 600  * @macs: array of MAC id and colors which belong to the binding
 601  * @phy: PHY id and color which belongs to the binding
 602  */
 603 struct iwl_binding_cmd {
 604         /* COMMON_INDEX_HDR_API_S_VER_1 */
 605         __le32 id_and_color;
 606         __le32 action;
 607         /* BINDING_DATA_API_S_VER_1 */
 608         __le32 macs[MAX_MACS_IN_BINDING];
 609         __le32 phy;
 610 } __packed; /* BINDING_CMD_API_S_VER_1 */
 611
 612 /* The maximal number of fragments in the FW's schedule session */
 613 #define IWL_MVM_MAX_QUOTA 128
 614
 615 /**
 616  * struct iwl_time_quota_data - configuration of time quota per binding
 617  * @id_and_color: ID and color of the relevant Binding
 618  * @quota: absolute time quota in TU. The scheduler will try to divide the
 619  *      remainig quota (after Time Events) according to this quota.
 620  * @max_duration: max uninterrupted context duration in TU
 621  */
 622 struct iwl_time_quota_data {
 623         __le32 id_and_color;
 624         __le32 quota;
 625         __le32 max_duration;
 626 } __packed; /* TIME_QUOTA_DATA_API_S_VER_1 */
 627
 628 /**
 629  * struct iwl_time_quota_cmd - configuration of time quota between bindings
 630  * ( TIME_QUOTA_CMD = 0x2c )
 631  * @quotas: allocations per binding
 632  */
 633 struct iwl_time_quota_cmd {
 634         struct iwl_time_quota_data quotas[MAX_BINDINGS];
 635 } __packed; /* TIME_QUOTA_ALLOCATION_CMD_API_S_VER_1 */
 636
 637
 638 /* PHY context */
 639
 640 /* Supported bands */
 641 #define PHY_BAND_5  (0)
 642 #define PHY_BAND_24 (1)
 643
 644 /* Supported channel width, vary if there is VHT support */
 645 #define PHY_VHT_CHANNEL_MODE20  (0x0)
 646 #define PHY_VHT_CHANNEL_MODE40  (0x1)
 647 #define PHY_VHT_CHANNEL_MODE80  (0x2)
 648 #define PHY_VHT_CHANNEL_MODE160 (0x3)
 649
 650 /*
 651  * Control channel position:
 652  * For legacy set bit means upper channel, otherwise lower.
 653  * For VHT - bit-2 marks if the control is lower/upper relative to center-freq
 654  *   bits-1:0 mark the distance from the center freq. for 20Mhz, offset is 0.
 655  *                                   center_freq
 656  *                                        |
 657  * 40Mhz                          |_______|_______|
 658  * 80Mhz                  |_______|_______|_______|_______|
 659  * 160Mhz |_______|_______|_______|_______|_______|_______|_______|_______|
 660  * code      011     010     001     000  |  100     101     110    111
 661  */
 662 #define PHY_VHT_CTRL_POS_1_BELOW  (0x0)
 663 #define PHY_VHT_CTRL_POS_2_BELOW  (0x1)
 664 #define PHY_VHT_CTRL_POS_3_BELOW  (0x2)
 665 #define PHY_VHT_CTRL_POS_4_BELOW  (0x3)
 666 #define PHY_VHT_CTRL_POS_1_ABOVE  (0x4)
 667 #define PHY_VHT_CTRL_POS_2_ABOVE  (0x5)
 668 #define PHY_VHT_CTRL_POS_3_ABOVE  (0x6)
 669 #define PHY_VHT_CTRL_POS_4_ABOVE  (0x7)
 670
 671 /*
 672  * @band: PHY_BAND_*
 673  * @channel: channel number
 674  * @width: PHY_[VHT|LEGACY]_CHANNEL_*
 675  * @ctrl channel: PHY_[VHT|LEGACY]_CTRL_*
 676  */
 677 struct iwl_fw_channel_info {
 678         u8 band;
 679         u8 channel;
 680         u8 width;
 681         u8 ctrl_pos;
 682 } __packed;
 683
 684 #define PHY_RX_CHAIN_DRIVER_FORCE_POS   (0)
 685 #define PHY_RX_CHAIN_DRIVER_FORCE_MSK \
 686         (0x1 << PHY_RX_CHAIN_DRIVER_FORCE_POS)
 687 #define PHY_RX_CHAIN_VALID_POS          (1)
 688 #define PHY_RX_CHAIN_VALID_MSK \
 689         (0x7 << PHY_RX_CHAIN_VALID_POS)
 690 #define PHY_RX_CHAIN_FORCE_SEL_POS      (4)
 691 #define PHY_RX_CHAIN_FORCE_SEL_MSK \
 692         (0x7 << PHY_RX_CHAIN_FORCE_SEL_POS)
 693 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
 694 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_MSK \
 695         (0x7 << PHY_RX_CHAIN_FORCE_MIMO_SEL_POS)
 696 #define PHY_RX_CHAIN_CNT_POS            (10)
 697 #define PHY_RX_CHAIN_CNT_MSK \
 698         (0x3 << PHY_RX_CHAIN_CNT_POS)
 699 #define PHY_RX_CHAIN_MIMO_CNT_POS       (12)
 700 #define PHY_RX_CHAIN_MIMO_CNT_MSK \
 701         (0x3 << PHY_RX_CHAIN_MIMO_CNT_POS)
 702 #define PHY_RX_CHAIN_MIMO_FORCE_POS     (14)
 703 #define PHY_RX_CHAIN_MIMO_FORCE_MSK \
 704         (0x1 << PHY_RX_CHAIN_MIMO_FORCE_POS)
 705
 706 /* TODO: fix the value, make it depend on firmware at runtime? */
 707 #define NUM_PHY_CTX     3
 708
 709 /* TODO: complete missing documentation */
 710 /**
 711  * struct iwl_phy_context_cmd - config of the PHY context
 712  * ( PHY_CONTEXT_CMD = 0x8 )
 713  * @id_and_color: ID and color of the relevant Binding
 714  * @action: action to perform, one of FW_CTXT_ACTION_*
 715  * @apply_time: 0 means immediate apply and context switch.
 716  *      other value means apply new params after X usecs
 717  * @tx_param_color: ???
 718  * @channel_info:
 719  * @txchain_info: ???
 720  * @rxchain_info: ???
 721  * @acquisition_data: ???
 722  * @dsp_cfg_flags: set to 0
 723  */
 724 struct iwl_phy_context_cmd {
 725         /* COMMON_INDEX_HDR_API_S_VER_1 */
 726         __le32 id_and_color;
 727         __le32 action;
 728         /* PHY_CONTEXT_DATA_API_S_VER_1 */
 729         __le32 apply_time;
 730         __le32 tx_param_color;
 731         struct iwl_fw_channel_info ci;
 732         __le32 txchain_info;
 733         __le32 rxchain_info;
 734         __le32 acquisition_data;
 735         __le32 dsp_cfg_flags;
 736 } __packed; /* PHY_CONTEXT_CMD_API_VER_1 */
 737
 738 #define IWL_RX_INFO_PHY_CNT 8
 739 #define IWL_RX_INFO_AGC_IDX 1
 740 #define IWL_RX_INFO_RSSI_AB_IDX 2
 741 #define IWL_OFDM_AGC_A_MSK 0x0000007f
 742 #define IWL_OFDM_AGC_A_POS 0
 743 #define IWL_OFDM_AGC_B_MSK 0x00003f80
 744 #define IWL_OFDM_AGC_B_POS 7
 745 #define IWL_OFDM_AGC_CODE_MSK 0x3fe00000
 746 #define IWL_OFDM_AGC_CODE_POS 20
 747 #define IWL_OFDM_RSSI_INBAND_A_MSK 0x00ff
 748 #define IWL_OFDM_RSSI_A_POS 0
 749 #define IWL_OFDM_RSSI_ALLBAND_A_MSK 0xff00
 750 #define IWL_OFDM_RSSI_ALLBAND_A_POS 8
 751 #define IWL_OFDM_RSSI_INBAND_B_MSK 0xff0000
 752 #define IWL_OFDM_RSSI_B_POS 16
 753 #define IWL_OFDM_RSSI_ALLBAND_B_MSK 0xff000000
 754 #define IWL_OFDM_RSSI_ALLBAND_B_POS 24
 755
 756 /**
 757  * struct iwl_rx_phy_info - phy info
 758  * (REPLY_RX_PHY_CMD = 0xc0)
 759  * @non_cfg_phy_cnt: non configurable DSP phy data byte count
 760  * @cfg_phy_cnt: configurable DSP phy data byte count
 761  * @stat_id: configurable DSP phy data set ID
 762  * @reserved1:
 763  * @system_timestamp: GP2  at on air rise
 764  * @timestamp: TSF at on air rise
 765  * @beacon_time_stamp: beacon at on-air rise
 766  * @phy_flags: general phy flags: band, modulation, ...
 767  * @channel: channel number
 768  * @non_cfg_phy_buf: for various implementations of non_cfg_phy
 769  * @rate_n_flags: RATE_MCS_*
 770  * @byte_count: frame's byte-count
 771  * @frame_time: frame's time on the air, based on byte count and frame rate
 772  *      calculation
 773  * @mac_active_msk: what MACs were active when the frame was received
 774  *
 775  * Before each Rx, the device sends this data. It contains PHY information
 776  * about the reception of the packet.
 777  */
 778 struct iwl_rx_phy_info {
 779         u8 non_cfg_phy_cnt;
 780         u8 cfg_phy_cnt;
 781         u8 stat_id;
 782         u8 reserved1;
 783         __le32 system_timestamp;
 784         __le64 timestamp;
 785         __le32 beacon_time_stamp;
 786         __le16 phy_flags;
 787         __le16 channel;
 788         __le32 non_cfg_phy[IWL_RX_INFO_PHY_CNT];
 789         __le32 rate_n_flags;
 790         __le32 byte_count;
 791         __le16 mac_active_msk;
 792         __le16 frame_time;
 793 } __packed;
 794
 795 struct iwl_rx_mpdu_res_start {
 796         __le16 byte_count;
 797         __le16 reserved;
 798 } __packed;
 799
 800 /**
 801  * enum iwl_rx_phy_flags - to parse %iwl_rx_phy_info phy_flags
 802  * @RX_RES_PHY_FLAGS_BAND_24: true if the packet was received on 2.4 band
 803  * @RX_RES_PHY_FLAGS_MOD_CCK:
 804  * @RX_RES_PHY_FLAGS_SHORT_PREAMBLE: true if packet's preamble was short
 805  * @RX_RES_PHY_FLAGS_NARROW_BAND:
 806  * @RX_RES_PHY_FLAGS_ANTENNA: antenna on which the packet was received
 807  * @RX_RES_PHY_FLAGS_AGG: set if the packet was part of an A-MPDU
 808  * @RX_RES_PHY_FLAGS_OFDM_HT: The frame was an HT frame
 809  * @RX_RES_PHY_FLAGS_OFDM_GF: The frame used GF preamble
 810  * @RX_RES_PHY_FLAGS_OFDM_VHT: The frame was a VHT frame
 811  */
 812 enum iwl_rx_phy_flags {
 813         RX_RES_PHY_FLAGS_BAND_24        = BIT(0),
 814         RX_RES_PHY_FLAGS_MOD_CCK        = BIT(1),
 815         RX_RES_PHY_FLAGS_SHORT_PREAMBLE = BIT(2),
 816         RX_RES_PHY_FLAGS_NARROW_BAND    = BIT(3),
 817         RX_RES_PHY_FLAGS_ANTENNA        = (0x7 << 4),
 818         RX_RES_PHY_FLAGS_ANTENNA_POS    = 4,
 819         RX_RES_PHY_FLAGS_AGG            = BIT(7),
 820         RX_RES_PHY_FLAGS_OFDM_HT        = BIT(8),
 821         RX_RES_PHY_FLAGS_OFDM_GF        = BIT(9),
 822         RX_RES_PHY_FLAGS_OFDM_VHT       = BIT(10),
 823 };
 824
 825 /**
 826  * enum iwl_mvm_rx_status - written by fw for each Rx packet
 827  * @RX_MPDU_RES_STATUS_CRC_OK: CRC is fine
 828  * @RX_MPDU_RES_STATUS_OVERRUN_OK: there was no RXE overflow
 829  * @RX_MPDU_RES_STATUS_SRC_STA_FOUND:
 830  * @RX_MPDU_RES_STATUS_KEY_VALID:
 831  * @RX_MPDU_RES_STATUS_KEY_PARAM_OK:
 832  * @RX_MPDU_RES_STATUS_ICV_OK: ICV is fine, if not, the packet is destroyed
 833  * @RX_MPDU_RES_STATUS_MIC_OK: used for CCM alg only. TKIP MIC is checked
 834  *      in the driver.
 835  * @RX_MPDU_RES_STATUS_TTAK_OK: TTAK is fine
 836  * @RX_MPDU_RES_STATUS_MNG_FRAME_REPLAY_ERR:  valid for alg = CCM_CMAC or
 837  *      alg = CCM only. Checks replay attack for 11w frames. Relevant only if
 838  *      %RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME is set.
 839  * @RX_MPDU_RES_STATUS_SEC_NO_ENC: this frame is not encrypted
 840  * @RX_MPDU_RES_STATUS_SEC_WEP_ENC: this frame is encrypted using WEP
 841  * @RX_MPDU_RES_STATUS_SEC_CCM_ENC: this frame is encrypted using CCM
 842  * @RX_MPDU_RES_STATUS_SEC_TKIP_ENC: this frame is encrypted using TKIP
 843  * @RX_MPDU_RES_STATUS_SEC_CCM_CMAC_ENC: this frame is encrypted using CCM_CMAC
 844  * @RX_MPDU_RES_STATUS_SEC_ENC_ERR: this frame couldn't be decrypted
 845  * @RX_MPDU_RES_STATUS_SEC_ENC_MSK: bitmask of the encryption algorithm
 846  * @RX_MPDU_RES_STATUS_DEC_DONE: this frame has been successfully decrypted
 847  * @RX_MPDU_RES_STATUS_PROTECT_FRAME_BIT_CMP:
 848  * @RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP:
 849  * @RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT:
 850  * @RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME: this frame is an 11w management frame
 851  * @RX_MPDU_RES_STATUS_HASH_INDEX_MSK:
 852  * @RX_MPDU_RES_STATUS_STA_ID_MSK:
 853  * @RX_MPDU_RES_STATUS_RRF_KILL:
 854  * @RX_MPDU_RES_STATUS_FILTERING_MSK:
 855  * @RX_MPDU_RES_STATUS2_FILTERING_MSK:
 856  */
 857 enum iwl_mvm_rx_status {
 858         RX_MPDU_RES_STATUS_CRC_OK                       = BIT(0),
 859         RX_MPDU_RES_STATUS_OVERRUN_OK                   = BIT(1),
 860         RX_MPDU_RES_STATUS_SRC_STA_FOUND                = BIT(2),
 861         RX_MPDU_RES_STATUS_KEY_VALID                    = BIT(3),
 862         RX_MPDU_RES_STATUS_KEY_PARAM_OK                 = BIT(4),
 863         RX_MPDU_RES_STATUS_ICV_OK                       = BIT(5),
 864         RX_MPDU_RES_STATUS_MIC_OK                       = BIT(6),
 865         RX_MPDU_RES_STATUS_TTAK_OK                      = BIT(7),
 866         RX_MPDU_RES_STATUS_MNG_FRAME_REPLAY_ERR         = BIT(7),
 867         RX_MPDU_RES_STATUS_SEC_NO_ENC                   = (0 << 8),
 868         RX_MPDU_RES_STATUS_SEC_WEP_ENC                  = (1 << 8),
 869         RX_MPDU_RES_STATUS_SEC_CCM_ENC                  = (2 << 8),
 870         RX_MPDU_RES_STATUS_SEC_TKIP_ENC                 = (3 << 8),
 871         RX_MPDU_RES_STATUS_SEC_CCM_CMAC_ENC             = (6 << 8),
 872         RX_MPDU_RES_STATUS_SEC_ENC_ERR                  = (7 << 8),
 873         RX_MPDU_RES_STATUS_SEC_ENC_MSK                  = (7 << 8),
 874         RX_MPDU_RES_STATUS_DEC_DONE                     = BIT(11),
 875         RX_MPDU_RES_STATUS_PROTECT_FRAME_BIT_CMP        = BIT(12),
 876         RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP               = BIT(13),
 877         RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT               = BIT(14),
 878         RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME             = BIT(15),
 879         RX_MPDU_RES_STATUS_HASH_INDEX_MSK               = (0x3F0000),
 880         RX_MPDU_RES_STATUS_STA_ID_MSK                   = (0x1f000000),
 881         RX_MPDU_RES_STATUS_RRF_KILL                     = BIT(29),
 882         RX_MPDU_RES_STATUS_FILTERING_MSK                = (0xc00000),
 883         RX_MPDU_RES_STATUS2_FILTERING_MSK               = (0xc0000000),
 884 };
 885
 886 /**
 887  * struct iwl_radio_version_notif - information on the radio version
 888  * ( RADIO_VERSION_NOTIFICATION = 0x68 )
 889  * @radio_flavor:
 890  * @radio_step:
 891  * @radio_dash:
 892  */
 893 struct iwl_radio_version_notif {
 894         __le32 radio_flavor;
 895         __le32 radio_step;
 896         __le32 radio_dash;
 897 } __packed; /* RADIO_VERSION_NOTOFICATION_S_VER_1 */
 898
 899 enum iwl_card_state_flags {
 900         CARD_ENABLED            = 0x00,
 901         HW_CARD_DISABLED        = 0x01,
 902         SW_CARD_DISABLED        = 0x02,
 903         CT_KILL_CARD_DISABLED   = 0x04,
 904         HALT_CARD_DISABLED      = 0x08,
 905         CARD_DISABLED_MSK       = 0x0f,
 906         CARD_IS_RX_ON           = 0x10,
 907 };
 908
 909 /**
 910  * struct iwl_radio_version_notif - information on the radio version
 911  * ( CARD_STATE_NOTIFICATION = 0xa1 )
 912  * @flags: %iwl_card_state_flags
 913  */
 914 struct iwl_card_state_notif {
 915         __le32 flags;
 916 } __packed; /* CARD_STATE_NTFY_API_S_VER_1 */
 917
 918 /**
 919  * struct iwl_set_calib_default_cmd - set default value for calibration.
 920  * ( SET_CALIB_DEFAULT_CMD = 0x8e )
 921  * @calib_index: the calibration to set value for
 922  * @length: of data
 923  * @data: the value to set for the calibration result
 924  */
 925 struct iwl_set_calib_default_cmd {
 926         __le16 calib_index;
 927         __le16 length;
 928         u8 data[0];
 929 } __packed; /* PHY_CALIB_OVERRIDE_VALUES_S */
 930
 931 #endif /* __fw_api_h__ */