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  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of version 2 of the GNU General Public License as
  13  * published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  23  * USA
  24  *
  25  * The full GNU General Public License is included in this distribution
  26  * in the file called COPYING.
  27  *
  28  * Contact Information:
  29  *  Intel Linux Wireless <ilw@linux.intel.com>
  30  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  31  *
  32  * BSD LICENSE
  33  *
  34  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
  35  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
  36  * All rights reserved.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  *
  42  *  * Redistributions of source code must retain the above copyright
  43  *    notice, this list of conditions and the following disclaimer.
  44  *  * Redistributions in binary form must reproduce the above copyright
  45  *    notice, this list of conditions and the following disclaimer in
  46  *    the documentation and/or other materials provided with the
  47  *    distribution.
  48  *  * Neither the name Intel Corporation nor the names of its
  49  *    contributors may be used to endorse or promote products derived
  50  *    from this software without specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  53  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  54  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  55  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  56  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  57  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  58  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  59  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  60  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  61  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  62  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  63  *
  64  *****************************************************************************/
  65
  66 #ifndef __fw_api_h__
  67 #define __fw_api_h__
  68
  69 #include "fw-api-rs.h"
  70 #include "fw-api-tx.h"
  71 #include "fw-api-sta.h"
  72 #include "fw-api-mac.h"
  73 #include "fw-api-power.h"
  74 #include "fw-api-d3.h"
  75 #include "fw-api-coex.h"
  76 #include "fw-api-scan.h"
  77 #include "fw-api-stats.h"
  78
  79 /* Tx queue numbers */
  80 enum {
  81         IWL_MVM_OFFCHANNEL_QUEUE = 8,
  82         IWL_MVM_CMD_QUEUE = 9,
  83 };
  84
  85 enum iwl_mvm_tx_fifo {
  86         IWL_MVM_TX_FIFO_BK = 0,
  87         IWL_MVM_TX_FIFO_BE,
  88         IWL_MVM_TX_FIFO_VI,
  89         IWL_MVM_TX_FIFO_VO,
  90         IWL_MVM_TX_FIFO_MCAST = 5,
  91         IWL_MVM_TX_FIFO_CMD = 7,
  92 };
  93
  94 #define IWL_MVM_STATION_COUNT   16
  95
  96 #define IWL_MVM_TDLS_STA_COUNT  4
  97
  98 /* commands */
  99 enum {
 100         MVM_ALIVE = 0x1,
 101         REPLY_ERROR = 0x2,
 102
 103         INIT_COMPLETE_NOTIF = 0x4,
 104
 105         /* PHY context commands */
 106         PHY_CONTEXT_CMD = 0x8,
 107         DBG_CFG = 0x9,
 108         ANTENNA_COUPLING_NOTIFICATION = 0xa,
 109
 110         /* UMAC scan commands */
 111         SCAN_CFG_CMD = 0xc,
 112         SCAN_REQ_UMAC = 0xd,
 113         SCAN_ABORT_UMAC = 0xe,
 114         SCAN_COMPLETE_UMAC = 0xf,
 115
 116         /* station table */
 117         ADD_STA_KEY = 0x17,
 118         ADD_STA = 0x18,
 119         REMOVE_STA = 0x19,
 120
 121         /* TX */
 122         TX_CMD = 0x1c,
 123         TXPATH_FLUSH = 0x1e,
 124         MGMT_MCAST_KEY = 0x1f,
 125
 126         /* scheduler config */
 127         SCD_QUEUE_CFG = 0x1d,
 128
 129         /* global key */
 130         WEP_KEY = 0x20,
 131
 132         /* Memory */
 133         SHARED_MEM_CFG = 0x25,
 134
 135         /* TDLS */
 136         TDLS_CHANNEL_SWITCH_CMD = 0x27,
 137         TDLS_CHANNEL_SWITCH_NOTIFICATION = 0xaa,
 138         TDLS_CONFIG_CMD = 0xa7,
 139
 140         /* MAC and Binding commands */
 141         MAC_CONTEXT_CMD = 0x28,
 142         TIME_EVENT_CMD = 0x29, /* both CMD and response */
 143         TIME_EVENT_NOTIFICATION = 0x2a,
 144         BINDING_CONTEXT_CMD = 0x2b,
 145         TIME_QUOTA_CMD = 0x2c,
 146         NON_QOS_TX_COUNTER_CMD = 0x2d,
 147
 148         LQ_CMD = 0x4e,
 149
 150         /* Calibration */
 151         TEMPERATURE_NOTIFICATION = 0x62,
 152         CALIBRATION_CFG_CMD = 0x65,
 153         CALIBRATION_RES_NOTIFICATION = 0x66,
 154         CALIBRATION_COMPLETE_NOTIFICATION = 0x67,
 155         RADIO_VERSION_NOTIFICATION = 0x68,
 156
 157         /* Scan offload */
 158         SCAN_OFFLOAD_REQUEST_CMD = 0x51,
 159         SCAN_OFFLOAD_ABORT_CMD = 0x52,
 160         HOT_SPOT_CMD = 0x53,
 161         SCAN_OFFLOAD_COMPLETE = 0x6D,
 162         SCAN_OFFLOAD_UPDATE_PROFILES_CMD = 0x6E,
 163         SCAN_OFFLOAD_CONFIG_CMD = 0x6f,
 164         MATCH_FOUND_NOTIFICATION = 0xd9,
 165         SCAN_ITERATION_COMPLETE = 0xe7,
 166
 167         /* Phy */
 168         PHY_CONFIGURATION_CMD = 0x6a,
 169         CALIB_RES_NOTIF_PHY_DB = 0x6b,
 170         /* PHY_DB_CMD = 0x6c, */
 171
 172         /* Power - legacy power table command */
 173         POWER_TABLE_CMD = 0x77,
 174         PSM_UAPSD_AP_MISBEHAVING_NOTIFICATION = 0x78,
 175         LTR_CONFIG = 0xee,
 176
 177         /* Thermal Throttling*/
 178         REPLY_THERMAL_MNG_BACKOFF = 0x7e,
 179
 180         /* Scanning */
 181         SCAN_REQUEST_CMD = 0x80,
 182         SCAN_ABORT_CMD = 0x81,
 183         SCAN_START_NOTIFICATION = 0x82,
 184         SCAN_RESULTS_NOTIFICATION = 0x83,
 185         SCAN_COMPLETE_NOTIFICATION = 0x84,
 186
 187         /* NVM */
 188         NVM_ACCESS_CMD = 0x88,
 189
 190         SET_CALIB_DEFAULT_CMD = 0x8e,
 191
 192         BEACON_NOTIFICATION = 0x90,
 193         BEACON_TEMPLATE_CMD = 0x91,
 194         TX_ANT_CONFIGURATION_CMD = 0x98,
 195         STATISTICS_NOTIFICATION = 0x9d,
 196         EOSP_NOTIFICATION = 0x9e,
 197         REDUCE_TX_POWER_CMD = 0x9f,
 198
 199         /* RF-KILL commands and notifications */
 200         CARD_STATE_CMD = 0xa0,
 201         CARD_STATE_NOTIFICATION = 0xa1,
 202
 203         MISSED_BEACONS_NOTIFICATION = 0xa2,
 204
 205         /* Power - new power table command */
 206         MAC_PM_POWER_TABLE = 0xa9,
 207
 208         MFUART_LOAD_NOTIFICATION = 0xb1,
 209
 210         REPLY_RX_PHY_CMD = 0xc0,
 211         REPLY_RX_MPDU_CMD = 0xc1,
 212         BA_NOTIF = 0xc5,
 213
 214         MARKER_CMD = 0xcb,
 215
 216         /* BT Coex */
 217         BT_COEX_PRIO_TABLE = 0xcc,
 218         BT_COEX_PROT_ENV = 0xcd,
 219         BT_PROFILE_NOTIFICATION = 0xce,
 220         BT_CONFIG = 0x9b,
 221         BT_COEX_UPDATE_SW_BOOST = 0x5a,
 222         BT_COEX_UPDATE_CORUN_LUT = 0x5b,
 223         BT_COEX_UPDATE_REDUCED_TXP = 0x5c,
 224         BT_COEX_CI = 0x5d,
 225
 226         REPLY_SF_CFG_CMD = 0xd1,
 227         REPLY_BEACON_FILTERING_CMD = 0xd2,
 228
 229         /* DTS measurements */
 230         CMD_DTS_MEASUREMENT_TRIGGER = 0xdc,
 231         DTS_MEASUREMENT_NOTIFICATION = 0xdd,
 232
 233         REPLY_DEBUG_CMD = 0xf0,
 234         DEBUG_LOG_MSG = 0xf7,
 235
 236         BCAST_FILTER_CMD = 0xcf,
 237         MCAST_FILTER_CMD = 0xd0,
 238
 239         /* D3 commands/notifications */
 240         D3_CONFIG_CMD = 0xd3,
 241         PROT_OFFLOAD_CONFIG_CMD = 0xd4,
 242         OFFLOADS_QUERY_CMD = 0xd5,
 243         REMOTE_WAKE_CONFIG_CMD = 0xd6,
 244         D0I3_END_CMD = 0xed,
 245
 246         /* for WoWLAN in particular */
 247         WOWLAN_PATTERNS = 0xe0,
 248         WOWLAN_CONFIGURATION = 0xe1,
 249         WOWLAN_TSC_RSC_PARAM = 0xe2,
 250         WOWLAN_TKIP_PARAM = 0xe3,
 251         WOWLAN_KEK_KCK_MATERIAL = 0xe4,
 252         WOWLAN_GET_STATUSES = 0xe5,
 253         WOWLAN_TX_POWER_PER_DB = 0xe6,
 254
 255         /* and for NetDetect */
 256         SCAN_OFFLOAD_PROFILES_QUERY_CMD = 0x56,
 257         SCAN_OFFLOAD_HOTSPOTS_CONFIG_CMD = 0x58,
 258         SCAN_OFFLOAD_HOTSPOTS_QUERY_CMD = 0x59,
 259
 260         REPLY_MAX = 0xff,
 261 };
 262
 263 /**
 264  * struct iwl_cmd_response - generic response struct for most commands
 265  * @status: status of the command asked, changes for each one
 266  */
 267 struct iwl_cmd_response {
 268         __le32 status;
 269 };
 270
 271 /*
 272  * struct iwl_tx_ant_cfg_cmd
 273  * @valid: valid antenna configuration
 274  */
 275 struct iwl_tx_ant_cfg_cmd {
 276         __le32 valid;
 277 } __packed;
 278
 279 /**
 280  * struct iwl_reduce_tx_power_cmd - TX power reduction command
 281  * REDUCE_TX_POWER_CMD = 0x9f
 282  * @flags: (reserved for future implementation)
 283  * @mac_context_id: id of the mac ctx for which we are reducing TX power.
 284  * @pwr_restriction: TX power restriction in dBms.
 285  */
 286 struct iwl_reduce_tx_power_cmd {
 287         u8 flags;
 288         u8 mac_context_id;
 289         __le16 pwr_restriction;
 290 } __packed; /* TX_REDUCED_POWER_API_S_VER_1 */
 291
 292 /*
 293  * Calibration control struct.
 294  * Sent as part of the phy configuration command.
 295  * @flow_trigger: bitmap for which calibrations to perform according to
 296  *              flow triggers.
 297  * @event_trigger: bitmap for which calibrations to perform according to
 298  *              event triggers.
 299  */
 300 struct iwl_calib_ctrl {
 301         __le32 flow_trigger;
 302         __le32 event_trigger;
 303 } __packed;
 304
 305 /* This enum defines the bitmap of various calibrations to enable in both
 306  * init ucode and runtime ucode through CALIBRATION_CFG_CMD.
 307  */
 308 enum iwl_calib_cfg {
 309         IWL_CALIB_CFG_XTAL_IDX                  = BIT(0),
 310         IWL_CALIB_CFG_TEMPERATURE_IDX           = BIT(1),
 311         IWL_CALIB_CFG_VOLTAGE_READ_IDX          = BIT(2),
 312         IWL_CALIB_CFG_PAPD_IDX                  = BIT(3),
 313         IWL_CALIB_CFG_TX_PWR_IDX                = BIT(4),
 314         IWL_CALIB_CFG_DC_IDX                    = BIT(5),
 315         IWL_CALIB_CFG_BB_FILTER_IDX             = BIT(6),
 316         IWL_CALIB_CFG_LO_LEAKAGE_IDX            = BIT(7),
 317         IWL_CALIB_CFG_TX_IQ_IDX                 = BIT(8),
 318         IWL_CALIB_CFG_TX_IQ_SKEW_IDX            = BIT(9),
 319         IWL_CALIB_CFG_RX_IQ_IDX                 = BIT(10),
 320         IWL_CALIB_CFG_RX_IQ_SKEW_IDX            = BIT(11),
 321         IWL_CALIB_CFG_SENSITIVITY_IDX           = BIT(12),
 322         IWL_CALIB_CFG_CHAIN_NOISE_IDX           = BIT(13),
 323         IWL_CALIB_CFG_DISCONNECTED_ANT_IDX      = BIT(14),
 324         IWL_CALIB_CFG_ANT_COUPLING_IDX          = BIT(15),
 325         IWL_CALIB_CFG_DAC_IDX                   = BIT(16),
 326         IWL_CALIB_CFG_ABS_IDX                   = BIT(17),
 327         IWL_CALIB_CFG_AGC_IDX                   = BIT(18),
 328 };
 329
 330 /*
 331  * Phy configuration command.
 332  */
 333 struct iwl_phy_cfg_cmd {
 334         __le32  phy_cfg;
 335         struct iwl_calib_ctrl calib_control;
 336 } __packed;
 337
 338 #define PHY_CFG_RADIO_TYPE      (BIT(0) | BIT(1))
 339 #define PHY_CFG_RADIO_STEP      (BIT(2) | BIT(3))
 340 #define PHY_CFG_RADIO_DASH      (BIT(4) | BIT(5))
 341 #define PHY_CFG_PRODUCT_NUMBER  (BIT(6) | BIT(7))
 342 #define PHY_CFG_TX_CHAIN_A      BIT(8)
 343 #define PHY_CFG_TX_CHAIN_B      BIT(9)
 344 #define PHY_CFG_TX_CHAIN_C      BIT(10)
 345 #define PHY_CFG_RX_CHAIN_A      BIT(12)
 346 #define PHY_CFG_RX_CHAIN_B      BIT(13)
 347 #define PHY_CFG_RX_CHAIN_C      BIT(14)
 348
 349
 350 /* Target of the NVM_ACCESS_CMD */
 351 enum {
 352         NVM_ACCESS_TARGET_CACHE = 0,
 353         NVM_ACCESS_TARGET_OTP = 1,
 354         NVM_ACCESS_TARGET_EEPROM = 2,
 355 };
 356
 357 /* Section types for NVM_ACCESS_CMD */
 358 enum {
 359         NVM_SECTION_TYPE_SW = 1,
 360         NVM_SECTION_TYPE_REGULATORY = 3,
 361         NVM_SECTION_TYPE_CALIBRATION = 4,
 362         NVM_SECTION_TYPE_PRODUCTION = 5,
 363         NVM_SECTION_TYPE_MAC_OVERRIDE = 11,
 364         NVM_MAX_NUM_SECTIONS = 12,
 365 };
 366
 367 /**
 368  * struct iwl_nvm_access_cmd_ver2 - Request the device to send an NVM section
 369  * @op_code: 0 - read, 1 - write
 370  * @target: NVM_ACCESS_TARGET_*
 371  * @type: NVM_SECTION_TYPE_*
 372  * @offset: offset in bytes into the section
 373  * @length: in bytes, to read/write
 374  * @data: if write operation, the data to write. On read its empty
 375  */
 376 struct iwl_nvm_access_cmd {
 377         u8 op_code;
 378         u8 target;
 379         __le16 type;
 380         __le16 offset;
 381         __le16 length;
 382         u8 data[];
 383 } __packed; /* NVM_ACCESS_CMD_API_S_VER_2 */
 384
 385 /**
 386  * struct iwl_nvm_access_resp_ver2 - response to NVM_ACCESS_CMD
 387  * @offset: offset in bytes into the section
 388  * @length: in bytes, either how much was written or read
 389  * @type: NVM_SECTION_TYPE_*
 390  * @status: 0 for success, fail otherwise
 391  * @data: if read operation, the data returned. Empty on write.
 392  */
 393 struct iwl_nvm_access_resp {
 394         __le16 offset;
 395         __le16 length;
 396         __le16 type;
 397         __le16 status;
 398         u8 data[];
 399 } __packed; /* NVM_ACCESS_CMD_RESP_API_S_VER_2 */
 400
 401 /* MVM_ALIVE 0x1 */
 402
 403 /* alive response is_valid values */
 404 #define ALIVE_RESP_UCODE_OK     BIT(0)
 405 #define ALIVE_RESP_RFKILL       BIT(1)
 406
 407 /* alive response ver_type values */
 408 enum {
 409         FW_TYPE_HW = 0,
 410         FW_TYPE_PROT = 1,
 411         FW_TYPE_AP = 2,
 412         FW_TYPE_WOWLAN = 3,
 413         FW_TYPE_TIMING = 4,
 414         FW_TYPE_WIPAN = 5
 415 };
 416
 417 /* alive response ver_subtype values */
 418 enum {
 419         FW_SUBTYPE_FULL_FEATURE = 0,
 420         FW_SUBTYPE_BOOTSRAP = 1, /* Not valid */
 421         FW_SUBTYPE_REDUCED = 2,
 422         FW_SUBTYPE_ALIVE_ONLY = 3,
 423         FW_SUBTYPE_WOWLAN = 4,
 424         FW_SUBTYPE_AP_SUBTYPE = 5,
 425         FW_SUBTYPE_WIPAN = 6,
 426         FW_SUBTYPE_INITIALIZE = 9
 427 };
 428
 429 #define IWL_ALIVE_STATUS_ERR 0xDEAD
 430 #define IWL_ALIVE_STATUS_OK 0xCAFE
 431
 432 #define IWL_ALIVE_FLG_RFKILL    BIT(0)
 433
 434 struct mvm_alive_resp {
 435         __le16 status;
 436         __le16 flags;
 437         u8 ucode_minor;
 438         u8 ucode_major;
 439         __le16 id;
 440         u8 api_minor;
 441         u8 api_major;
 442         u8 ver_subtype;
 443         u8 ver_type;
 444         u8 mac;
 445         u8 opt;
 446         __le16 reserved2;
 447         __le32 timestamp;
 448         __le32 error_event_table_ptr;   /* SRAM address for error log */
 449         __le32 log_event_table_ptr;     /* SRAM address for event log */
 450         __le32 cpu_register_ptr;
 451         __le32 dbgm_config_ptr;
 452         __le32 alive_counter_ptr;
 453         __le32 scd_base_ptr;            /* SRAM address for SCD */
 454 } __packed; /* ALIVE_RES_API_S_VER_1 */
 455
 456 struct mvm_alive_resp_ver2 {
 457         __le16 status;
 458         __le16 flags;
 459         u8 ucode_minor;
 460         u8 ucode_major;
 461         __le16 id;
 462         u8 api_minor;
 463         u8 api_major;
 464         u8 ver_subtype;
 465         u8 ver_type;
 466         u8 mac;
 467         u8 opt;
 468         __le16 reserved2;
 469         __le32 timestamp;
 470         __le32 error_event_table_ptr;   /* SRAM address for error log */
 471         __le32 log_event_table_ptr;     /* SRAM address for LMAC event log */
 472         __le32 cpu_register_ptr;
 473         __le32 dbgm_config_ptr;
 474         __le32 alive_counter_ptr;
 475         __le32 scd_base_ptr;            /* SRAM address for SCD */
 476         __le32 st_fwrd_addr;            /* pointer to Store and forward */
 477         __le32 st_fwrd_size;
 478         u8 umac_minor;                  /* UMAC version: minor */
 479         u8 umac_major;                  /* UMAC version: major */
 480         __le16 umac_id;                 /* UMAC version: id */
 481         __le32 error_info_addr;         /* SRAM address for UMAC error log */
 482         __le32 dbg_print_buff_addr;
 483 } __packed; /* ALIVE_RES_API_S_VER_2 */
 484
 485 /* Error response/notification */
 486 enum {
 487         FW_ERR_UNKNOWN_CMD = 0x0,
 488         FW_ERR_INVALID_CMD_PARAM = 0x1,
 489         FW_ERR_SERVICE = 0x2,
 490         FW_ERR_ARC_MEMORY = 0x3,
 491         FW_ERR_ARC_CODE = 0x4,
 492         FW_ERR_WATCH_DOG = 0x5,
 493         FW_ERR_WEP_GRP_KEY_INDX = 0x10,
 494         FW_ERR_WEP_KEY_SIZE = 0x11,
 495         FW_ERR_OBSOLETE_FUNC = 0x12,
 496         FW_ERR_UNEXPECTED = 0xFE,
 497         FW_ERR_FATAL = 0xFF
 498 };
 499
 500 /**
 501  * struct iwl_error_resp - FW error indication
 502  * ( REPLY_ERROR = 0x2 )
 503  * @error_type: one of FW_ERR_*
 504  * @cmd_id: the command ID for which the error occured
 505  * @bad_cmd_seq_num: sequence number of the erroneous command
 506  * @error_service: which service created the error, applicable only if
 507  *      error_type = 2, otherwise 0
 508  * @timestamp: TSF in usecs.
 509  */
 510 struct iwl_error_resp {
 511         __le32 error_type;
 512         u8 cmd_id;
 513         u8 reserved1;
 514         __le16 bad_cmd_seq_num;
 515         __le32 error_service;
 516         __le64 timestamp;
 517 } __packed;
 518
 519
 520 /* Common PHY, MAC and Bindings definitions */
 521
 522 #define MAX_MACS_IN_BINDING     (3)
 523 #define MAX_BINDINGS            (4)
 524 #define AUX_BINDING_INDEX       (3)
 525 #define MAX_PHYS                (4)
 526
 527 /* Used to extract ID and color from the context dword */
 528 #define FW_CTXT_ID_POS    (0)
 529 #define FW_CTXT_ID_MSK    (0xff << FW_CTXT_ID_POS)
 530 #define FW_CTXT_COLOR_POS (8)
 531 #define FW_CTXT_COLOR_MSK (0xff << FW_CTXT_COLOR_POS)
 532 #define FW_CTXT_INVALID   (0xffffffff)
 533
 534 #define FW_CMD_ID_AND_COLOR(_id, _color) ((_id << FW_CTXT_ID_POS) |\
 535                                           (_color << FW_CTXT_COLOR_POS))
 536
 537 /* Possible actions on PHYs, MACs and Bindings */
 538 enum {
 539         FW_CTXT_ACTION_STUB = 0,
 540         FW_CTXT_ACTION_ADD,
 541         FW_CTXT_ACTION_MODIFY,
 542         FW_CTXT_ACTION_REMOVE,
 543         FW_CTXT_ACTION_NUM
 544 }; /* COMMON_CONTEXT_ACTION_API_E_VER_1 */
 545
 546 /* Time Events */
 547
 548 /* Time Event types, according to MAC type */
 549 enum iwl_time_event_type {
 550         /* BSS Station Events */
 551         TE_BSS_STA_AGGRESSIVE_ASSOC,
 552         TE_BSS_STA_ASSOC,
 553         TE_BSS_EAP_DHCP_PROT,
 554         TE_BSS_QUIET_PERIOD,
 555
 556         /* P2P Device Events */
 557         TE_P2P_DEVICE_DISCOVERABLE,
 558         TE_P2P_DEVICE_LISTEN,
 559         TE_P2P_DEVICE_ACTION_SCAN,
 560         TE_P2P_DEVICE_FULL_SCAN,
 561
 562         /* P2P Client Events */
 563         TE_P2P_CLIENT_AGGRESSIVE_ASSOC,
 564         TE_P2P_CLIENT_ASSOC,
 565         TE_P2P_CLIENT_QUIET_PERIOD,
 566
 567         /* P2P GO Events */
 568         TE_P2P_GO_ASSOC_PROT,
 569         TE_P2P_GO_REPETITIVE_NOA,
 570         TE_P2P_GO_CT_WINDOW,
 571
 572         /* WiDi Sync Events */
 573         TE_WIDI_TX_SYNC,
 574
 575         /* Channel Switch NoA */
 576         TE_CHANNEL_SWITCH_PERIOD,
 577
 578         TE_MAX
 579 }; /* MAC_EVENT_TYPE_API_E_VER_1 */
 580
 581
 582
 583 /* Time event - defines for command API v1 */
 584
 585 /*
 586  * @TE_V1_FRAG_NONE: fragmentation of the time event is NOT allowed.
 587  * @TE_V1_FRAG_SINGLE: fragmentation of the time event is allowed, but only
 588  *      the first fragment is scheduled.
 589  * @TE_V1_FRAG_DUAL: fragmentation of the time event is allowed, but only
 590  *      the first 2 fragments are scheduled.
 591  * @TE_V1_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
 592  *      number of fragments are valid.
 593  *
 594  * Other than the constant defined above, specifying a fragmentation value 'x'
 595  * means that the event can be fragmented but only the first 'x' will be
 596  * scheduled.
 597  */
 598 enum {
 599         TE_V1_FRAG_NONE = 0,
 600         TE_V1_FRAG_SINGLE = 1,
 601         TE_V1_FRAG_DUAL = 2,
 602         TE_V1_FRAG_ENDLESS = 0xffffffff
 603 };
 604
 605 /* If a Time Event can be fragmented, this is the max number of fragments */
 606 #define TE_V1_FRAG_MAX_MSK      0x0fffffff
 607 /* Repeat the time event endlessly (until removed) */
 608 #define TE_V1_REPEAT_ENDLESS    0xffffffff
 609 /* If a Time Event has bounded repetitions, this is the maximal value */
 610 #define TE_V1_REPEAT_MAX_MSK_V1 0x0fffffff
 611
 612 /* Time Event dependencies: none, on another TE, or in a specific time */
 613 enum {
 614         TE_V1_INDEPENDENT               = 0,
 615         TE_V1_DEP_OTHER                 = BIT(0),
 616         TE_V1_DEP_TSF                   = BIT(1),
 617         TE_V1_EVENT_SOCIOPATHIC         = BIT(2),
 618 }; /* MAC_EVENT_DEPENDENCY_POLICY_API_E_VER_2 */
 619
 620 /*
 621  * @TE_V1_NOTIF_NONE: no notifications
 622  * @TE_V1_NOTIF_HOST_EVENT_START: request/receive notification on event start
 623  * @TE_V1_NOTIF_HOST_EVENT_END:request/receive notification on event end
 624  * @TE_V1_NOTIF_INTERNAL_EVENT_START: internal FW use
 625  * @TE_V1_NOTIF_INTERNAL_EVENT_END: internal FW use.
 626  * @TE_V1_NOTIF_HOST_FRAG_START: request/receive notification on frag start
 627  * @TE_V1_NOTIF_HOST_FRAG_END:request/receive notification on frag end
 628  * @TE_V1_NOTIF_INTERNAL_FRAG_START: internal FW use.
 629  * @TE_V1_NOTIF_INTERNAL_FRAG_END: internal FW use.
 630  *
 631  * Supported Time event notifications configuration.
 632  * A notification (both event and fragment) includes a status indicating weather
 633  * the FW was able to schedule the event or not. For fragment start/end
 634  * notification the status is always success. There is no start/end fragment
 635  * notification for monolithic events.
 636  */
 637 enum {
 638         TE_V1_NOTIF_NONE = 0,
 639         TE_V1_NOTIF_HOST_EVENT_START = BIT(0),
 640         TE_V1_NOTIF_HOST_EVENT_END = BIT(1),
 641         TE_V1_NOTIF_INTERNAL_EVENT_START = BIT(2),
 642         TE_V1_NOTIF_INTERNAL_EVENT_END = BIT(3),
 643         TE_V1_NOTIF_HOST_FRAG_START = BIT(4),
 644         TE_V1_NOTIF_HOST_FRAG_END = BIT(5),
 645         TE_V1_NOTIF_INTERNAL_FRAG_START = BIT(6),
 646         TE_V1_NOTIF_INTERNAL_FRAG_END = BIT(7),
 647 }; /* MAC_EVENT_ACTION_API_E_VER_2 */
 648
 649 /* Time event - defines for command API */
 650
 651 /*
 652  * @TE_V2_FRAG_NONE: fragmentation of the time event is NOT allowed.
 653  * @TE_V2_FRAG_SINGLE: fragmentation of the time event is allowed, but only
 654  *  the first fragment is scheduled.
 655  * @TE_V2_FRAG_DUAL: fragmentation of the time event is allowed, but only
 656  *  the first 2 fragments are scheduled.
 657  * @TE_V2_FRAG_ENDLESS: fragmentation of the time event is allowed, and any
 658  *  number of fragments are valid.
 659  *
 660  * Other than the constant defined above, specifying a fragmentation value 'x'
 661  * means that the event can be fragmented but only the first 'x' will be
 662  * scheduled.
 663  */
 664 enum {
 665         TE_V2_FRAG_NONE = 0,
 666         TE_V2_FRAG_SINGLE = 1,
 667         TE_V2_FRAG_DUAL = 2,
 668         TE_V2_FRAG_MAX = 0xfe,
 669         TE_V2_FRAG_ENDLESS = 0xff
 670 };
 671
 672 /* Repeat the time event endlessly (until removed) */
 673 #define TE_V2_REPEAT_ENDLESS    0xff
 674 /* If a Time Event has bounded repetitions, this is the maximal value */
 675 #define TE_V2_REPEAT_MAX        0xfe
 676
 677 #define TE_V2_PLACEMENT_POS     12
 678 #define TE_V2_ABSENCE_POS       15
 679
 680 /* Time event policy values
 681  * A notification (both event and fragment) includes a status indicating weather
 682  * the FW was able to schedule the event or not. For fragment start/end
 683  * notification the status is always success. There is no start/end fragment
 684  * notification for monolithic events.
 685  *
 686  * @TE_V2_DEFAULT_POLICY: independent, social, present, unoticable
 687  * @TE_V2_NOTIF_HOST_EVENT_START: request/receive notification on event start
 688  * @TE_V2_NOTIF_HOST_EVENT_END:request/receive notification on event end
 689  * @TE_V2_NOTIF_INTERNAL_EVENT_START: internal FW use
 690  * @TE_V2_NOTIF_INTERNAL_EVENT_END: internal FW use.
 691  * @TE_V2_NOTIF_HOST_FRAG_START: request/receive notification on frag start
 692  * @TE_V2_NOTIF_HOST_FRAG_END:request/receive notification on frag end
 693  * @TE_V2_NOTIF_INTERNAL_FRAG_START: internal FW use.
 694  * @TE_V2_NOTIF_INTERNAL_FRAG_END: internal FW use.
 695  * @TE_V2_DEP_OTHER: depends on another time event
 696  * @TE_V2_DEP_TSF: depends on a specific time
 697  * @TE_V2_EVENT_SOCIOPATHIC: can't co-exist with other events of tha same MAC
 698  * @TE_V2_ABSENCE: are we present or absent during the Time Event.
 699  */
 700 enum {
 701         TE_V2_DEFAULT_POLICY = 0x0,
 702
 703         /* notifications (event start/stop, fragment start/stop) */
 704         TE_V2_NOTIF_HOST_EVENT_START = BIT(0),
 705         TE_V2_NOTIF_HOST_EVENT_END = BIT(1),
 706         TE_V2_NOTIF_INTERNAL_EVENT_START = BIT(2),
 707         TE_V2_NOTIF_INTERNAL_EVENT_END = BIT(3),
 708
 709         TE_V2_NOTIF_HOST_FRAG_START = BIT(4),
 710         TE_V2_NOTIF_HOST_FRAG_END = BIT(5),
 711         TE_V2_NOTIF_INTERNAL_FRAG_START = BIT(6),
 712         TE_V2_NOTIF_INTERNAL_FRAG_END = BIT(7),
 713         T2_V2_START_IMMEDIATELY = BIT(11),
 714
 715         TE_V2_NOTIF_MSK = 0xff,
 716
 717         /* placement characteristics */
 718         TE_V2_DEP_OTHER = BIT(TE_V2_PLACEMENT_POS),
 719         TE_V2_DEP_TSF = BIT(TE_V2_PLACEMENT_POS + 1),
 720         TE_V2_EVENT_SOCIOPATHIC = BIT(TE_V2_PLACEMENT_POS + 2),
 721
 722         /* are we present or absent during the Time Event. */
 723         TE_V2_ABSENCE = BIT(TE_V2_ABSENCE_POS),
 724 };
 725
 726 /**
 727  * struct iwl_time_event_cmd_api - configuring Time Events
 728  * with struct MAC_TIME_EVENT_DATA_API_S_VER_2 (see also
 729  * with version 1. determined by IWL_UCODE_TLV_FLAGS)
 730  * ( TIME_EVENT_CMD = 0x29 )
 731  * @id_and_color: ID and color of the relevant MAC
 732  * @action: action to perform, one of FW_CTXT_ACTION_*
 733  * @id: this field has two meanings, depending on the action:
 734  *      If the action is ADD, then it means the type of event to add.
 735  *      For all other actions it is the unique event ID assigned when the
 736  *      event was added by the FW.
 737  * @apply_time: When to start the Time Event (in GP2)
 738  * @max_delay: maximum delay to event's start (apply time), in TU
 739  * @depends_on: the unique ID of the event we depend on (if any)
 740  * @interval: interval between repetitions, in TU
 741  * @duration: duration of event in TU
 742  * @repeat: how many repetitions to do, can be TE_REPEAT_ENDLESS
 743  * @max_frags: maximal number of fragments the Time Event can be divided to
 744  * @policy: defines whether uCode shall notify the host or other uCode modules
 745  *      on event and/or fragment start and/or end
 746  *      using one of TE_INDEPENDENT, TE_DEP_OTHER, TE_DEP_TSF
 747  *      TE_EVENT_SOCIOPATHIC
 748  *      using TE_ABSENCE and using TE_NOTIF_*
 749  */
 750 struct iwl_time_event_cmd {
 751         /* COMMON_INDEX_HDR_API_S_VER_1 */
 752         __le32 id_and_color;
 753         __le32 action;
 754         __le32 id;
 755         /* MAC_TIME_EVENT_DATA_API_S_VER_2 */
 756         __le32 apply_time;
 757         __le32 max_delay;
 758         __le32 depends_on;
 759         __le32 interval;
 760         __le32 duration;
 761         u8 repeat;
 762         u8 max_frags;
 763         __le16 policy;
 764 } __packed; /* MAC_TIME_EVENT_CMD_API_S_VER_2 */
 765
 766 /**
 767  * struct iwl_time_event_resp - response structure to iwl_time_event_cmd
 768  * @status: bit 0 indicates success, all others specify errors
 769  * @id: the Time Event type
 770  * @unique_id: the unique ID assigned (in ADD) or given (others) to the TE
 771  * @id_and_color: ID and color of the relevant MAC
 772  */
 773 struct iwl_time_event_resp {
 774         __le32 status;
 775         __le32 id;
 776         __le32 unique_id;
 777         __le32 id_and_color;
 778 } __packed; /* MAC_TIME_EVENT_RSP_API_S_VER_1 */
 779
 780 /**
 781  * struct iwl_time_event_notif - notifications of time event start/stop
 782  * ( TIME_EVENT_NOTIFICATION = 0x2a )
 783  * @timestamp: action timestamp in GP2
 784  * @session_id: session's unique id
 785  * @unique_id: unique id of the Time Event itself
 786  * @id_and_color: ID and color of the relevant MAC
 787  * @action: one of TE_NOTIF_START or TE_NOTIF_END
 788  * @status: true if scheduled, false otherwise (not executed)
 789  */
 790 struct iwl_time_event_notif {
 791         __le32 timestamp;
 792         __le32 session_id;
 793         __le32 unique_id;
 794         __le32 id_and_color;
 795         __le32 action;
 796         __le32 status;
 797 } __packed; /* MAC_TIME_EVENT_NTFY_API_S_VER_1 */
 798
 799
 800 /* Bindings and Time Quota */
 801
 802 /**
 803  * struct iwl_binding_cmd - configuring bindings
 804  * ( BINDING_CONTEXT_CMD = 0x2b )
 805  * @id_and_color: ID and color of the relevant Binding
 806  * @action: action to perform, one of FW_CTXT_ACTION_*
 807  * @macs: array of MAC id and colors which belong to the binding
 808  * @phy: PHY id and color which belongs to the binding
 809  */
 810 struct iwl_binding_cmd {
 811         /* COMMON_INDEX_HDR_API_S_VER_1 */
 812         __le32 id_and_color;
 813         __le32 action;
 814         /* BINDING_DATA_API_S_VER_1 */
 815         __le32 macs[MAX_MACS_IN_BINDING];
 816         __le32 phy;
 817 } __packed; /* BINDING_CMD_API_S_VER_1 */
 818
 819 /* The maximal number of fragments in the FW's schedule session */
 820 #define IWL_MVM_MAX_QUOTA 128
 821
 822 /**
 823  * struct iwl_time_quota_data - configuration of time quota per binding
 824  * @id_and_color: ID and color of the relevant Binding
 825  * @quota: absolute time quota in TU. The scheduler will try to divide the
 826  *      remainig quota (after Time Events) according to this quota.
 827  * @max_duration: max uninterrupted context duration in TU
 828  */
 829 struct iwl_time_quota_data {
 830         __le32 id_and_color;
 831         __le32 quota;
 832         __le32 max_duration;
 833 } __packed; /* TIME_QUOTA_DATA_API_S_VER_1 */
 834
 835 /**
 836  * struct iwl_time_quota_cmd - configuration of time quota between bindings
 837  * ( TIME_QUOTA_CMD = 0x2c )
 838  * @quotas: allocations per binding
 839  */
 840 struct iwl_time_quota_cmd {
 841         struct iwl_time_quota_data quotas[MAX_BINDINGS];
 842 } __packed; /* TIME_QUOTA_ALLOCATION_CMD_API_S_VER_1 */
 843
 844
 845 /* PHY context */
 846
 847 /* Supported bands */
 848 #define PHY_BAND_5  (0)
 849 #define PHY_BAND_24 (1)
 850
 851 /* Supported channel width, vary if there is VHT support */
 852 #define PHY_VHT_CHANNEL_MODE20  (0x0)
 853 #define PHY_VHT_CHANNEL_MODE40  (0x1)
 854 #define PHY_VHT_CHANNEL_MODE80  (0x2)
 855 #define PHY_VHT_CHANNEL_MODE160 (0x3)
 856
 857 /*
 858  * Control channel position:
 859  * For legacy set bit means upper channel, otherwise lower.
 860  * For VHT - bit-2 marks if the control is lower/upper relative to center-freq
 861  *   bits-1:0 mark the distance from the center freq. for 20Mhz, offset is 0.
 862  *                                   center_freq
 863  *                                        |
 864  * 40Mhz                          |_______|_______|
 865  * 80Mhz                  |_______|_______|_______|_______|
 866  * 160Mhz |_______|_______|_______|_______|_______|_______|_______|_______|
 867  * code      011     010     001     000  |  100     101     110    111
 868  */
 869 #define PHY_VHT_CTRL_POS_1_BELOW  (0x0)
 870 #define PHY_VHT_CTRL_POS_2_BELOW  (0x1)
 871 #define PHY_VHT_CTRL_POS_3_BELOW  (0x2)
 872 #define PHY_VHT_CTRL_POS_4_BELOW  (0x3)
 873 #define PHY_VHT_CTRL_POS_1_ABOVE  (0x4)
 874 #define PHY_VHT_CTRL_POS_2_ABOVE  (0x5)
 875 #define PHY_VHT_CTRL_POS_3_ABOVE  (0x6)
 876 #define PHY_VHT_CTRL_POS_4_ABOVE  (0x7)
 877
 878 /*
 879  * @band: PHY_BAND_*
 880  * @channel: channel number
 881  * @width: PHY_[VHT|LEGACY]_CHANNEL_*
 882  * @ctrl channel: PHY_[VHT|LEGACY]_CTRL_*
 883  */
 884 struct iwl_fw_channel_info {
 885         u8 band;
 886         u8 channel;
 887         u8 width;
 888         u8 ctrl_pos;
 889 } __packed;
 890
 891 #define PHY_RX_CHAIN_DRIVER_FORCE_POS   (0)
 892 #define PHY_RX_CHAIN_DRIVER_FORCE_MSK \
 893         (0x1 << PHY_RX_CHAIN_DRIVER_FORCE_POS)
 894 #define PHY_RX_CHAIN_VALID_POS          (1)
 895 #define PHY_RX_CHAIN_VALID_MSK \
 896         (0x7 << PHY_RX_CHAIN_VALID_POS)
 897 #define PHY_RX_CHAIN_FORCE_SEL_POS      (4)
 898 #define PHY_RX_CHAIN_FORCE_SEL_MSK \
 899         (0x7 << PHY_RX_CHAIN_FORCE_SEL_POS)
 900 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
 901 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_MSK \
 902         (0x7 << PHY_RX_CHAIN_FORCE_MIMO_SEL_POS)
 903 #define PHY_RX_CHAIN_CNT_POS            (10)
 904 #define PHY_RX_CHAIN_CNT_MSK \
 905         (0x3 << PHY_RX_CHAIN_CNT_POS)
 906 #define PHY_RX_CHAIN_MIMO_CNT_POS       (12)
 907 #define PHY_RX_CHAIN_MIMO_CNT_MSK \
 908         (0x3 << PHY_RX_CHAIN_MIMO_CNT_POS)
 909 #define PHY_RX_CHAIN_MIMO_FORCE_POS     (14)
 910 #define PHY_RX_CHAIN_MIMO_FORCE_MSK \
 911         (0x1 << PHY_RX_CHAIN_MIMO_FORCE_POS)
 912
 913 /* TODO: fix the value, make it depend on firmware at runtime? */
 914 #define NUM_PHY_CTX     3
 915
 916 /* TODO: complete missing documentation */
 917 /**
 918  * struct iwl_phy_context_cmd - config of the PHY context
 919  * ( PHY_CONTEXT_CMD = 0x8 )
 920  * @id_and_color: ID and color of the relevant Binding
 921  * @action: action to perform, one of FW_CTXT_ACTION_*
 922  * @apply_time: 0 means immediate apply and context switch.
 923  *      other value means apply new params after X usecs
 924  * @tx_param_color: ???
 925  * @channel_info:
 926  * @txchain_info: ???
 927  * @rxchain_info: ???
 928  * @acquisition_data: ???
 929  * @dsp_cfg_flags: set to 0
 930  */
 931 struct iwl_phy_context_cmd {
 932         /* COMMON_INDEX_HDR_API_S_VER_1 */
 933         __le32 id_and_color;
 934         __le32 action;
 935         /* PHY_CONTEXT_DATA_API_S_VER_1 */
 936         __le32 apply_time;
 937         __le32 tx_param_color;
 938         struct iwl_fw_channel_info ci;
 939         __le32 txchain_info;
 940         __le32 rxchain_info;
 941         __le32 acquisition_data;
 942         __le32 dsp_cfg_flags;
 943 } __packed; /* PHY_CONTEXT_CMD_API_VER_1 */
 944
 945 /*
 946  * Aux ROC command
 947  *
 948  * Command requests the firmware to create a time event for a certain duration
 949  * and remain on the given channel. This is done by using the Aux framework in
 950  * the FW.
 951  * The command was first used for Hot Spot issues - but can be used regardless
 952  * to Hot Spot.
 953  *
 954  * ( HOT_SPOT_CMD 0x53 )
 955  *
 956  * @id_and_color: ID and color of the MAC
 957  * @action: action to perform, one of FW_CTXT_ACTION_*
 958  * @event_unique_id: If the action FW_CTXT_ACTION_REMOVE then the
 959  *      event_unique_id should be the id of the time event assigned by ucode.
 960  *      Otherwise ignore the event_unique_id.
 961  * @sta_id_and_color: station id and color, resumed during "Remain On Channel"
 962  *      activity.
 963  * @channel_info: channel info
 964  * @node_addr: Our MAC Address
 965  * @reserved: reserved for alignment
 966  * @apply_time: GP2 value to start (should always be the current GP2 value)
 967  * @apply_time_max_delay: Maximum apply time delay value in TU. Defines max
 968  *      time by which start of the event is allowed to be postponed.
 969  * @duration: event duration in TU To calculate event duration:
 970  *      timeEventDuration = min(duration, remainingQuota)
 971  */
 972 struct iwl_hs20_roc_req {
 973         /* COMMON_INDEX_HDR_API_S_VER_1 hdr */
 974         __le32 id_and_color;
 975         __le32 action;
 976         __le32 event_unique_id;
 977         __le32 sta_id_and_color;
 978         struct iwl_fw_channel_info channel_info;
 979         u8 node_addr[ETH_ALEN];
 980         __le16 reserved;
 981         __le32 apply_time;
 982         __le32 apply_time_max_delay;
 983         __le32 duration;
 984 } __packed; /* HOT_SPOT_CMD_API_S_VER_1 */
 985
 986 /*
 987  * values for AUX ROC result values
 988  */
 989 enum iwl_mvm_hot_spot {
 990         HOT_SPOT_RSP_STATUS_OK,
 991         HOT_SPOT_RSP_STATUS_TOO_MANY_EVENTS,
 992         HOT_SPOT_MAX_NUM_OF_SESSIONS,
 993 };
 994
 995 /*
 996  * Aux ROC command response
 997  *
 998  * In response to iwl_hs20_roc_req the FW sends this command to notify the
 999  * driver the uid of the timevent.
1000  *
1001  * ( HOT_SPOT_CMD 0x53 )
1002  *
1003  * @event_unique_id: Unique ID of time event assigned by ucode
1004  * @status: Return status 0 is success, all the rest used for specific errors
1005  */
1006 struct iwl_hs20_roc_res {
1007         __le32 event_unique_id;
1008         __le32 status;
1009 } __packed; /* HOT_SPOT_RSP_API_S_VER_1 */
1010
1011 #define IWL_RX_INFO_PHY_CNT 8
1012 #define IWL_RX_INFO_ENERGY_ANT_ABC_IDX 1
1013 #define IWL_RX_INFO_ENERGY_ANT_A_MSK 0x000000ff
1014 #define IWL_RX_INFO_ENERGY_ANT_B_MSK 0x0000ff00
1015 #define IWL_RX_INFO_ENERGY_ANT_C_MSK 0x00ff0000
1016 #define IWL_RX_INFO_ENERGY_ANT_A_POS 0
1017 #define IWL_RX_INFO_ENERGY_ANT_B_POS 8
1018 #define IWL_RX_INFO_ENERGY_ANT_C_POS 16
1019
1020 #define IWL_RX_INFO_AGC_IDX 1
1021 #define IWL_RX_INFO_RSSI_AB_IDX 2
1022 #define IWL_OFDM_AGC_A_MSK 0x0000007f
1023 #define IWL_OFDM_AGC_A_POS 0
1024 #define IWL_OFDM_AGC_B_MSK 0x00003f80
1025 #define IWL_OFDM_AGC_B_POS 7
1026 #define IWL_OFDM_AGC_CODE_MSK 0x3fe00000
1027 #define IWL_OFDM_AGC_CODE_POS 20
1028 #define IWL_OFDM_RSSI_INBAND_A_MSK 0x00ff
1029 #define IWL_OFDM_RSSI_A_POS 0
1030 #define IWL_OFDM_RSSI_ALLBAND_A_MSK 0xff00
1031 #define IWL_OFDM_RSSI_ALLBAND_A_POS 8
1032 #define IWL_OFDM_RSSI_INBAND_B_MSK 0xff0000
1033 #define IWL_OFDM_RSSI_B_POS 16
1034 #define IWL_OFDM_RSSI_ALLBAND_B_MSK 0xff000000
1035 #define IWL_OFDM_RSSI_ALLBAND_B_POS 24
1036
1037 /**
1038  * struct iwl_rx_phy_info - phy info
1039  * (REPLY_RX_PHY_CMD = 0xc0)
1040  * @non_cfg_phy_cnt: non configurable DSP phy data byte count
1041  * @cfg_phy_cnt: configurable DSP phy data byte count
1042  * @stat_id: configurable DSP phy data set ID
1043  * @reserved1:
1044  * @system_timestamp: GP2  at on air rise
1045  * @timestamp: TSF at on air rise
1046  * @beacon_time_stamp: beacon at on-air rise
1047  * @phy_flags: general phy flags: band, modulation, ...
1048  * @channel: channel number
1049  * @non_cfg_phy_buf: for various implementations of non_cfg_phy
1050  * @rate_n_flags: RATE_MCS_*
1051  * @byte_count: frame's byte-count
1052  * @frame_time: frame's time on the air, based on byte count and frame rate
1053  *      calculation
1054  * @mac_active_msk: what MACs were active when the frame was received
1055  *
1056  * Before each Rx, the device sends this data. It contains PHY information
1057  * about the reception of the packet.
1058  */
1059 struct iwl_rx_phy_info {
1060         u8 non_cfg_phy_cnt;
1061         u8 cfg_phy_cnt;
1062         u8 stat_id;
1063         u8 reserved1;
1064         __le32 system_timestamp;
1065         __le64 timestamp;
1066         __le32 beacon_time_stamp;
1067         __le16 phy_flags;
1068         __le16 channel;
1069         __le32 non_cfg_phy[IWL_RX_INFO_PHY_CNT];
1070         __le32 rate_n_flags;
1071         __le32 byte_count;
1072         __le16 mac_active_msk;
1073         __le16 frame_time;
1074 } __packed;
1075
1076 struct iwl_rx_mpdu_res_start {
1077         __le16 byte_count;
1078         __le16 reserved;
1079 } __packed;
1080
1081 /**
1082  * enum iwl_rx_phy_flags - to parse %iwl_rx_phy_info phy_flags
1083  * @RX_RES_PHY_FLAGS_BAND_24: true if the packet was received on 2.4 band
1084  * @RX_RES_PHY_FLAGS_MOD_CCK:
1085  * @RX_RES_PHY_FLAGS_SHORT_PREAMBLE: true if packet's preamble was short
1086  * @RX_RES_PHY_FLAGS_NARROW_BAND:
1087  * @RX_RES_PHY_FLAGS_ANTENNA: antenna on which the packet was received
1088  * @RX_RES_PHY_FLAGS_AGG: set if the packet was part of an A-MPDU
1089  * @RX_RES_PHY_FLAGS_OFDM_HT: The frame was an HT frame
1090  * @RX_RES_PHY_FLAGS_OFDM_GF: The frame used GF preamble
1091  * @RX_RES_PHY_FLAGS_OFDM_VHT: The frame was a VHT frame
1092  */
1093 enum iwl_rx_phy_flags {
1094         RX_RES_PHY_FLAGS_BAND_24        = BIT(0),
1095         RX_RES_PHY_FLAGS_MOD_CCK        = BIT(1),
1096         RX_RES_PHY_FLAGS_SHORT_PREAMBLE = BIT(2),
1097         RX_RES_PHY_FLAGS_NARROW_BAND    = BIT(3),
1098         RX_RES_PHY_FLAGS_ANTENNA        = (0x7 << 4),
1099         RX_RES_PHY_FLAGS_ANTENNA_POS    = 4,
1100         RX_RES_PHY_FLAGS_AGG            = BIT(7),
1101         RX_RES_PHY_FLAGS_OFDM_HT        = BIT(8),
1102         RX_RES_PHY_FLAGS_OFDM_GF        = BIT(9),
1103         RX_RES_PHY_FLAGS_OFDM_VHT       = BIT(10),
1104 };
1105
1106 /**
1107  * enum iwl_mvm_rx_status - written by fw for each Rx packet
1108  * @RX_MPDU_RES_STATUS_CRC_OK: CRC is fine
1109  * @RX_MPDU_RES_STATUS_OVERRUN_OK: there was no RXE overflow
1110  * @RX_MPDU_RES_STATUS_SRC_STA_FOUND:
1111  * @RX_MPDU_RES_STATUS_KEY_VALID:
1112  * @RX_MPDU_RES_STATUS_KEY_PARAM_OK:
1113  * @RX_MPDU_RES_STATUS_ICV_OK: ICV is fine, if not, the packet is destroyed
1114  * @RX_MPDU_RES_STATUS_MIC_OK: used for CCM alg only. TKIP MIC is checked
1115  *      in the driver.
1116  * @RX_MPDU_RES_STATUS_TTAK_OK: TTAK is fine
1117  * @RX_MPDU_RES_STATUS_MNG_FRAME_REPLAY_ERR:  valid for alg = CCM_CMAC or
1118  *      alg = CCM only. Checks replay attack for 11w frames. Relevant only if
1119  *      %RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME is set.
1120  * @RX_MPDU_RES_STATUS_SEC_NO_ENC: this frame is not encrypted
1121  * @RX_MPDU_RES_STATUS_SEC_WEP_ENC: this frame is encrypted using WEP
1122  * @RX_MPDU_RES_STATUS_SEC_CCM_ENC: this frame is encrypted using CCM
1123  * @RX_MPDU_RES_STATUS_SEC_TKIP_ENC: this frame is encrypted using TKIP
1124  * @RX_MPDU_RES_STATUS_SEC_CCM_CMAC_ENC: this frame is encrypted using CCM_CMAC
1125  * @RX_MPDU_RES_STATUS_SEC_ENC_ERR: this frame couldn't be decrypted
1126  * @RX_MPDU_RES_STATUS_SEC_ENC_MSK: bitmask of the encryption algorithm
1127  * @RX_MPDU_RES_STATUS_DEC_DONE: this frame has been successfully decrypted
1128  * @RX_MPDU_RES_STATUS_PROTECT_FRAME_BIT_CMP:
1129  * @RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP:
1130  * @RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT:
1131  * @RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME: this frame is an 11w management frame
1132  * @RX_MPDU_RES_STATUS_HASH_INDEX_MSK:
1133  * @RX_MPDU_RES_STATUS_STA_ID_MSK:
1134  * @RX_MPDU_RES_STATUS_RRF_KILL:
1135  * @RX_MPDU_RES_STATUS_FILTERING_MSK:
1136  * @RX_MPDU_RES_STATUS2_FILTERING_MSK:
1137  */
1138 enum iwl_mvm_rx_status {
1139         RX_MPDU_RES_STATUS_CRC_OK                       = BIT(0),
1140         RX_MPDU_RES_STATUS_OVERRUN_OK                   = BIT(1),
1141         RX_MPDU_RES_STATUS_SRC_STA_FOUND                = BIT(2),
1142         RX_MPDU_RES_STATUS_KEY_VALID                    = BIT(3),
1143         RX_MPDU_RES_STATUS_KEY_PARAM_OK                 = BIT(4),
1144         RX_MPDU_RES_STATUS_ICV_OK                       = BIT(5),
1145         RX_MPDU_RES_STATUS_MIC_OK                       = BIT(6),
1146         RX_MPDU_RES_STATUS_TTAK_OK                      = BIT(7),
1147         RX_MPDU_RES_STATUS_MNG_FRAME_REPLAY_ERR         = BIT(7),
1148         RX_MPDU_RES_STATUS_SEC_NO_ENC                   = (0 << 8),
1149         RX_MPDU_RES_STATUS_SEC_WEP_ENC                  = (1 << 8),
1150         RX_MPDU_RES_STATUS_SEC_CCM_ENC                  = (2 << 8),
1151         RX_MPDU_RES_STATUS_SEC_TKIP_ENC                 = (3 << 8),
1152         RX_MPDU_RES_STATUS_SEC_EXT_ENC                  = (4 << 8),
1153         RX_MPDU_RES_STATUS_SEC_CCM_CMAC_ENC             = (6 << 8),
1154         RX_MPDU_RES_STATUS_SEC_ENC_ERR                  = (7 << 8),
1155         RX_MPDU_RES_STATUS_SEC_ENC_MSK                  = (7 << 8),
1156         RX_MPDU_RES_STATUS_DEC_DONE                     = BIT(11),
1157         RX_MPDU_RES_STATUS_PROTECT_FRAME_BIT_CMP        = BIT(12),
1158         RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP               = BIT(13),
1159         RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT               = BIT(14),
1160         RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME             = BIT(15),
1161         RX_MPDU_RES_STATUS_HASH_INDEX_MSK               = (0x3F0000),
1162         RX_MPDU_RES_STATUS_STA_ID_MSK                   = (0x1f000000),
1163         RX_MPDU_RES_STATUS_RRF_KILL                     = BIT(29),
1164         RX_MPDU_RES_STATUS_FILTERING_MSK                = (0xc00000),
1165         RX_MPDU_RES_STATUS2_FILTERING_MSK               = (0xc0000000),
1166 };
1167
1168 /**
1169  * struct iwl_radio_version_notif - information on the radio version
1170  * ( RADIO_VERSION_NOTIFICATION = 0x68 )
1171  * @radio_flavor:
1172  * @radio_step:
1173  * @radio_dash:
1174  */
1175 struct iwl_radio_version_notif {
1176         __le32 radio_flavor;
1177         __le32 radio_step;
1178         __le32 radio_dash;
1179 } __packed; /* RADIO_VERSION_NOTOFICATION_S_VER_1 */
1180
1181 enum iwl_card_state_flags {
1182         CARD_ENABLED            = 0x00,
1183         HW_CARD_DISABLED        = 0x01,
1184         SW_CARD_DISABLED        = 0x02,
1185         CT_KILL_CARD_DISABLED   = 0x04,
1186         HALT_CARD_DISABLED      = 0x08,
1187         CARD_DISABLED_MSK       = 0x0f,
1188         CARD_IS_RX_ON           = 0x10,
1189 };
1190
1191 /**
1192  * struct iwl_radio_version_notif - information on the radio version
1193  * ( CARD_STATE_NOTIFICATION = 0xa1 )
1194  * @flags: %iwl_card_state_flags
1195  */
1196 struct iwl_card_state_notif {
1197         __le32 flags;
1198 } __packed; /* CARD_STATE_NTFY_API_S_VER_1 */
1199
1200 /**
1201  * struct iwl_missed_beacons_notif - information on missed beacons
1202  * ( MISSED_BEACONS_NOTIFICATION = 0xa2 )
1203  * @mac_id: interface ID
1204  * @consec_missed_beacons_since_last_rx: number of consecutive missed
1205  *      beacons since last RX.
1206  * @consec_missed_beacons: number of consecutive missed beacons
1207  * @num_expected_beacons:
1208  * @num_recvd_beacons:
1209  */
1210 struct iwl_missed_beacons_notif {
1211         __le32 mac_id;
1212         __le32 consec_missed_beacons_since_last_rx;
1213         __le32 consec_missed_beacons;
1214         __le32 num_expected_beacons;
1215         __le32 num_recvd_beacons;
1216 } __packed; /* MISSED_BEACON_NTFY_API_S_VER_3 */
1217
1218 /**
1219  * struct iwl_mfuart_load_notif - mfuart image version & status
1220  * ( MFUART_LOAD_NOTIFICATION = 0xb1 )
1221  * @installed_ver: installed image version
1222  * @external_ver: external image version
1223  * @status: MFUART loading status
1224  * @duration: MFUART loading time
1225 */
1226 struct iwl_mfuart_load_notif {
1227         __le32 installed_ver;
1228         __le32 external_ver;
1229         __le32 status;
1230         __le32 duration;
1231 } __packed; /*MFU_LOADER_NTFY_API_S_VER_1*/
1232
1233 /**
1234  * struct iwl_set_calib_default_cmd - set default value for calibration.
1235  * ( SET_CALIB_DEFAULT_CMD = 0x8e )
1236  * @calib_index: the calibration to set value for
1237  * @length: of data
1238  * @data: the value to set for the calibration result
1239  */
1240 struct iwl_set_calib_default_cmd {
1241         __le16 calib_index;
1242         __le16 length;
1243         u8 data[0];
1244 } __packed; /* PHY_CALIB_OVERRIDE_VALUES_S */
1245
1246 #define MAX_PORT_ID_NUM 2
1247 #define MAX_MCAST_FILTERING_ADDRESSES 256
1248
1249 /**
1250  * struct iwl_mcast_filter_cmd - configure multicast filter.
1251  * @filter_own: Set 1 to filter out multicast packets sent by station itself
1252  * @port_id:    Multicast MAC addresses array specifier. This is a strange way
1253  *              to identify network interface adopted in host-device IF.
1254  *              It is used by FW as index in array of addresses. This array has
1255  *              MAX_PORT_ID_NUM members.
1256  * @count:      Number of MAC addresses in the array
1257  * @pass_all:   Set 1 to pass all multicast packets.
1258  * @bssid:      current association BSSID.
1259  * @addr_list:  Place holder for array of MAC addresses.
1260  *              IMPORTANT: add padding if necessary to ensure DWORD alignment.
1261  */
1262 struct iwl_mcast_filter_cmd {
1263         u8 filter_own;
1264         u8 port_id;
1265         u8 count;
1266         u8 pass_all;
1267         u8 bssid[6];
1268         u8 reserved[2];
1269         u8 addr_list[0];
1270 } __packed; /* MCAST_FILTERING_CMD_API_S_VER_1 */
1271
1272 #define MAX_BCAST_FILTERS 8
1273 #define MAX_BCAST_FILTER_ATTRS 2
1274
1275 /**
1276  * enum iwl_mvm_bcast_filter_attr_offset - written by fw for each Rx packet
1277  * @BCAST_FILTER_OFFSET_PAYLOAD_START: offset is from payload start.
1278  * @BCAST_FILTER_OFFSET_IP_END: offset is from ip header end (i.e.
1279  *      start of ip payload).
1280  */
1281 enum iwl_mvm_bcast_filter_attr_offset {
1282         BCAST_FILTER_OFFSET_PAYLOAD_START = 0,
1283         BCAST_FILTER_OFFSET_IP_END = 1,
1284 };
1285
1286 /**
1287  * struct iwl_fw_bcast_filter_attr - broadcast filter attribute
1288  * @offset_type:        &enum iwl_mvm_bcast_filter_attr_offset.
1289  * @offset:     starting offset of this pattern.
1290  * @val:                value to match - big endian (MSB is the first
1291  *              byte to match from offset pos).
1292  * @mask:       mask to match (big endian).
1293  */
1294 struct iwl_fw_bcast_filter_attr {
1295         u8 offset_type;
1296         u8 offset;
1297         __le16 reserved1;
1298         __be32 val;
1299         __be32 mask;
1300 } __packed; /* BCAST_FILTER_ATT_S_VER_1 */
1301
1302 /**
1303  * enum iwl_mvm_bcast_filter_frame_type - filter frame type
1304  * @BCAST_FILTER_FRAME_TYPE_ALL: consider all frames.
1305  * @BCAST_FILTER_FRAME_TYPE_IPV4: consider only ipv4 frames
1306  */
1307 enum iwl_mvm_bcast_filter_frame_type {
1308         BCAST_FILTER_FRAME_TYPE_ALL = 0,
1309         BCAST_FILTER_FRAME_TYPE_IPV4 = 1,
1310 };
1311
1312 /**
1313  * struct iwl_fw_bcast_filter - broadcast filter
1314  * @discard: discard frame (1) or let it pass (0).
1315  * @frame_type: &enum iwl_mvm_bcast_filter_frame_type.
1316  * @num_attrs: number of valid attributes in this filter.
1317  * @attrs: attributes of this filter. a filter is considered matched
1318  *      only when all its attributes are matched (i.e. AND relationship)
1319  */
1320 struct iwl_fw_bcast_filter {
1321         u8 discard;
1322         u8 frame_type;
1323         u8 num_attrs;
1324         u8 reserved1;
1325         struct iwl_fw_bcast_filter_attr attrs[MAX_BCAST_FILTER_ATTRS];
1326 } __packed; /* BCAST_FILTER_S_VER_1 */
1327
1328 /**
1329  * struct iwl_fw_bcast_mac - per-mac broadcast filtering configuration.
1330  * @default_discard: default action for this mac (discard (1) / pass (0)).
1331  * @attached_filters: bitmap of relevant filters for this mac.
1332  */
1333 struct iwl_fw_bcast_mac {
1334         u8 default_discard;
1335         u8 reserved1;
1336         __le16 attached_filters;
1337 } __packed; /* BCAST_MAC_CONTEXT_S_VER_1 */
1338
1339 /**
1340  * struct iwl_bcast_filter_cmd - broadcast filtering configuration
1341  * @disable: enable (0) / disable (1)
1342  * @max_bcast_filters: max number of filters (MAX_BCAST_FILTERS)
1343  * @max_macs: max number of macs (NUM_MAC_INDEX_DRIVER)
1344  * @filters: broadcast filters
1345  * @macs: broadcast filtering configuration per-mac
1346  */
1347 struct iwl_bcast_filter_cmd {
1348         u8 disable;
1349         u8 max_bcast_filters;
1350         u8 max_macs;
1351         u8 reserved1;
1352         struct iwl_fw_bcast_filter filters[MAX_BCAST_FILTERS];
1353         struct iwl_fw_bcast_mac macs[NUM_MAC_INDEX_DRIVER];
1354 } __packed; /* BCAST_FILTERING_HCMD_API_S_VER_1 */
1355
1356 /*
1357  * enum iwl_mvm_marker_id - maker ids
1358  *
1359  * The ids for different type of markers to insert into the usniffer logs
1360  */
1361 enum iwl_mvm_marker_id {
1362         MARKER_ID_TX_FRAME_LATENCY = 1,
1363 }; /* MARKER_ID_API_E_VER_1 */
1364
1365 /**
1366  * struct iwl_mvm_marker - mark info into the usniffer logs
1367  *
1368  * (MARKER_CMD = 0xcb)
1369  *
1370  * Mark the UTC time stamp into the usniffer logs together with additional
1371  * metadata, so the usniffer output can be parsed.
1372  * In the command response the ucode will return the GP2 time.
1373  *
1374  * @dw_len: The amount of dwords following this byte including this byte.
1375  * @marker_id: A unique marker id (iwl_mvm_marker_id).
1376  * @reserved: reserved.
1377  * @timestamp: in milliseconds since 1970-01-01 00:00:00 UTC
1378  * @metadata: additional meta data that will be written to the unsiffer log
1379  */
1380 struct iwl_mvm_marker {
1381         u8 dwLen;
1382         u8 markerId;
1383         __le16 reserved;
1384         __le64 timestamp;
1385         __le32 metadata[0];
1386 } __packed; /* MARKER_API_S_VER_1 */
1387
1388 /***********************************
1389  * Smart Fifo API
1390  ***********************************/
1391 /* Smart Fifo state */
1392 enum iwl_sf_state {
1393         SF_LONG_DELAY_ON = 0, /* should never be called by driver */
1394         SF_FULL_ON,
1395         SF_UNINIT,
1396         SF_INIT_OFF,
1397         SF_HW_NUM_STATES
1398 };
1399
1400 /* Smart Fifo possible scenario */
1401 enum iwl_sf_scenario {
1402         SF_SCENARIO_SINGLE_UNICAST,
1403         SF_SCENARIO_AGG_UNICAST,
1404         SF_SCENARIO_MULTICAST,
1405         SF_SCENARIO_BA_RESP,
1406         SF_SCENARIO_TX_RESP,
1407         SF_NUM_SCENARIO
1408 };
1409
1410 #define SF_TRANSIENT_STATES_NUMBER 2    /* SF_LONG_DELAY_ON and SF_FULL_ON */
1411 #define SF_NUM_TIMEOUT_TYPES 2          /* Aging timer and Idle timer */
1412
1413 /* smart FIFO default values */
1414 #define SF_W_MARK_SISO 6144
1415 #define SF_W_MARK_MIMO2 8192
1416 #define SF_W_MARK_MIMO3 6144
1417 #define SF_W_MARK_LEGACY 4096
1418 #define SF_W_MARK_SCAN 4096
1419
1420 /* SF Scenarios timers for FULL_ON state (aligned to 32 uSec) */
1421 #define SF_SINGLE_UNICAST_IDLE_TIMER 320        /* 300 uSec  */
1422 #define SF_SINGLE_UNICAST_AGING_TIMER 2016      /* 2 mSec */
1423 #define SF_AGG_UNICAST_IDLE_TIMER 320           /* 300 uSec */
1424 #define SF_AGG_UNICAST_AGING_TIMER 2016         /* 2 mSec */
1425 #define SF_MCAST_IDLE_TIMER 2016                /* 2 mSec */
1426 #define SF_MCAST_AGING_TIMER 10016              /* 10 mSec */
1427 #define SF_BA_IDLE_TIMER 320                    /* 300 uSec */
1428 #define SF_BA_AGING_TIMER 2016                  /* 2 mSec */
1429 #define SF_TX_RE_IDLE_TIMER 320                 /* 300 uSec */
1430 #define SF_TX_RE_AGING_TIMER 2016               /* 2 mSec */
1431
1432 #define SF_LONG_DELAY_AGING_TIMER 1000000       /* 1 Sec */
1433
1434 #define SF_CFG_DUMMY_NOTIF_OFF  BIT(16)
1435
1436 /**
1437  * Smart Fifo configuration command.
1438  * @state: smart fifo state, types listed in enum %iwl_sf_sate.
1439  * @watermark: Minimum allowed availabe free space in RXF for transient state.
1440  * @long_delay_timeouts: aging and idle timer values for each scenario
1441  * in long delay state.
1442  * @full_on_timeouts: timer values for each scenario in full on state.
1443  */
1444 struct iwl_sf_cfg_cmd {
1445         __le32 state;
1446         __le32 watermark[SF_TRANSIENT_STATES_NUMBER];
1447         __le32 long_delay_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES];
1448         __le32 full_on_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES];
1449 } __packed; /* SF_CFG_API_S_VER_2 */
1450
1451 /* DTS measurements */
1452
1453 enum iwl_dts_measurement_flags {
1454         DTS_TRIGGER_CMD_FLAGS_TEMP      = BIT(0),
1455         DTS_TRIGGER_CMD_FLAGS_VOLT      = BIT(1),
1456 };
1457
1458 /**
1459  * iwl_dts_measurement_cmd - request DTS temperature and/or voltage measurements
1460  *
1461  * @flags: indicates which measurements we want as specified in &enum
1462  *         iwl_dts_measurement_flags
1463  */
1464 struct iwl_dts_measurement_cmd {
1465         __le32 flags;
1466 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_CMD_S */
1467
1468 /**
1469  * iwl_dts_measurement_notif - notification received with the measurements
1470  *
1471  * @temp: the measured temperature
1472  * @voltage: the measured voltage
1473  */
1474 struct iwl_dts_measurement_notif {
1475         __le32 temp;
1476         __le32 voltage;
1477 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_NTFY_S */
1478
1479 /***********************************
1480  * TDLS API
1481  ***********************************/
1482
1483 /* Type of TDLS request */
1484 enum iwl_tdls_channel_switch_type {
1485         TDLS_SEND_CHAN_SW_REQ = 0,
1486         TDLS_SEND_CHAN_SW_RESP_AND_MOVE_CH,
1487         TDLS_MOVE_CH,
1488 }; /* TDLS_STA_CHANNEL_SWITCH_CMD_TYPE_API_E_VER_1 */
1489
1490 /**
1491  * Switch timing sub-element in a TDLS channel-switch command
1492  * @frame_timestamp: GP2 timestamp of channel-switch request/response packet
1493  *      received from peer
1494  * @max_offchan_duration: What amount of microseconds out of a DTIM is given
1495  *      to the TDLS off-channel communication. For instance if the DTIM is
1496  *      200TU and the TDLS peer is to be given 25% of the time, the value
1497  *      given will be 50TU, or 50 * 1024 if translated into microseconds.
1498  * @switch_time: switch time the peer sent in its channel switch timing IE
1499  * @switch_timout: switch timeout the peer sent in its channel switch timing IE
1500  */
1501 struct iwl_tdls_channel_switch_timing {
1502         __le32 frame_timestamp; /* GP2 time of peer packet Rx */
1503         __le32 max_offchan_duration; /* given in micro-seconds */
1504         __le32 switch_time; /* given in micro-seconds */
1505         __le32 switch_timeout; /* given in micro-seconds */
1506 } __packed; /* TDLS_STA_CHANNEL_SWITCH_TIMING_DATA_API_S_VER_1 */
1507
1508 #define IWL_TDLS_CH_SW_FRAME_MAX_SIZE 200
1509
1510 /**
1511  * TDLS channel switch frame template
1512  *
1513  * A template representing a TDLS channel-switch request or response frame
1514  *
1515  * @switch_time_offset: offset to the channel switch timing IE in the template
1516  * @tx_cmd: Tx parameters for the frame
1517  * @data: frame data
1518  */
1519 struct iwl_tdls_channel_switch_frame {
1520         __le32 switch_time_offset;
1521         struct iwl_tx_cmd tx_cmd;
1522         u8 data[IWL_TDLS_CH_SW_FRAME_MAX_SIZE];
1523 } __packed; /* TDLS_STA_CHANNEL_SWITCH_FRAME_API_S_VER_1 */
1524
1525 /**
1526  * TDLS channel switch command
1527  *
1528  * The command is sent to initiate a channel switch and also in response to
1529  * incoming TDLS channel-switch request/response packets from remote peers.
1530  *
1531  * @switch_type: see &enum iwl_tdls_channel_switch_type
1532  * @peer_sta_id: station id of TDLS peer
1533  * @ci: channel we switch to
1534  * @timing: timing related data for command
1535  * @frame: channel-switch request/response template, depending to switch_type
1536  */
1537 struct iwl_tdls_channel_switch_cmd {
1538         u8 switch_type;
1539         __le32 peer_sta_id;
1540         struct iwl_fw_channel_info ci;
1541         struct iwl_tdls_channel_switch_timing timing;
1542         struct iwl_tdls_channel_switch_frame frame;
1543 } __packed; /* TDLS_STA_CHANNEL_SWITCH_CMD_API_S_VER_1 */
1544
1545 /**
1546  * TDLS channel switch start notification
1547  *
1548  * @status: non-zero on success
1549  * @offchannel_duration: duration given in microseconds
1550  * @sta_id: peer currently performing the channel-switch with
1551  */
1552 struct iwl_tdls_channel_switch_notif {
1553         __le32 status;
1554         __le32 offchannel_duration;
1555         __le32 sta_id;
1556 } __packed; /* TDLS_STA_CHANNEL_SWITCH_NTFY_API_S_VER_1 */
1557
1558 /**
1559  * TDLS station info
1560  *
1561  * @sta_id: station id of the TDLS peer
1562  * @tx_to_peer_tid: TID reserved vs. the peer for FW based Tx
1563  * @tx_to_peer_ssn: initial SSN the FW should use for Tx on its TID vs the peer
1564  * @is_initiator: 1 if the peer is the TDLS link initiator, 0 otherwise
1565  */
1566 struct iwl_tdls_sta_info {
1567         u8 sta_id;
1568         u8 tx_to_peer_tid;
1569         __le16 tx_to_peer_ssn;
1570         __le32 is_initiator;
1571 } __packed; /* TDLS_STA_INFO_VER_1 */
1572
1573 /**
1574  * TDLS basic config command
1575  *
1576  * @id_and_color: MAC id and color being configured
1577  * @tdls_peer_count: amount of currently connected TDLS peers
1578  * @tx_to_ap_tid: TID reverved vs. the AP for FW based Tx
1579  * @tx_to_ap_ssn: initial SSN the FW should use for Tx on its TID vs. the AP
1580  * @sta_info: per-station info. Only the first tdls_peer_count entries are set
1581  * @pti_req_data_offset: offset of network-level data for the PTI template
1582  * @pti_req_tx_cmd: Tx parameters for PTI request template
1583  * @pti_req_template: PTI request template data
1584  */
1585 struct iwl_tdls_config_cmd {
1586         __le32 id_and_color; /* mac id and color */
1587         u8 tdls_peer_count;
1588         u8 tx_to_ap_tid;
1589         __le16 tx_to_ap_ssn;
1590         struct iwl_tdls_sta_info sta_info[IWL_MVM_TDLS_STA_COUNT];
1591
1592         __le32 pti_req_data_offset;
1593         struct iwl_tx_cmd pti_req_tx_cmd;
1594         u8 pti_req_template[0];
1595 } __packed; /* TDLS_CONFIG_CMD_API_S_VER_1 */
1596
1597 /**
1598  * TDLS per-station config information from FW
1599  *
1600  * @sta_id: station id of the TDLS peer
1601  * @tx_to_peer_last_seq: last sequence number used by FW during FW-based Tx to
1602  *      the peer
1603  */
1604 struct iwl_tdls_config_sta_info_res {
1605         __le16 sta_id;
1606         __le16 tx_to_peer_last_seq;
1607 } __packed; /* TDLS_STA_INFO_RSP_VER_1 */
1608
1609 /**
1610  * TDLS config information from FW
1611  *
1612  * @tx_to_ap_last_seq: last sequence number used by FW during FW-based Tx to AP
1613  * @sta_info: per-station TDLS config information
1614  */
1615 struct iwl_tdls_config_res {
1616         __le32 tx_to_ap_last_seq;
1617         struct iwl_tdls_config_sta_info_res sta_info[IWL_MVM_TDLS_STA_COUNT];
1618 } __packed; /* TDLS_CONFIG_RSP_API_S_VER_1 */
1619
1620 #define TX_FIFO_MAX_NUM         8
1621 #define RX_FIFO_MAX_NUM         2
1622
1623 /**
1624  * Shared memory configuration information from the FW
1625  *
1626  * @shared_mem_addr: shared memory addr (pre 8000 HW set to 0x0 as MARBH is not
1627  *      accessible)
1628  * @shared_mem_size: shared memory size
1629  * @sample_buff_addr: internal sample (mon/adc) buff addr (pre 8000 HW set to
1630  *      0x0 as accessible only via DBGM RDAT)
1631  * @sample_buff_size: internal sample buff size
1632  * @txfifo_addr: start addr of TXF0 (excluding the context table 0.5KB), (pre
1633  *      8000 HW set to 0x0 as not accessible)
1634  * @txfifo_size: size of TXF0 ... TXF7
1635  * @rxfifo_size: RXF1, RXF2 sizes. If there is no RXF2, it'll have a value of 0
1636  * @page_buff_addr: used by UMAC and performance debug (page miss analysis),
1637  *      when paging is not supported this should be 0
1638  * @page_buff_size: size of %page_buff_addr
1639  */
1640 struct iwl_shared_mem_cfg {
1641         __le32 shared_mem_addr;
1642         __le32 shared_mem_size;
1643         __le32 sample_buff_addr;
1644         __le32 sample_buff_size;
1645         __le32 txfifo_addr;
1646         __le32 txfifo_size[TX_FIFO_MAX_NUM];
1647         __le32 rxfifo_size[RX_FIFO_MAX_NUM];
1648         __le32 page_buff_addr;
1649         __le32 page_buff_size;
1650 } __packed; /* SHARED_MEM_ALLOC_API_S_VER_1 */
1651
1652 #endif /* __fw_api_h__ */