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 - 2015 Intel Mobile Communications GmbH 10 * Copyright(c) 2016 Intel Deutschland GmbH 11 * 12 * This program is free software; you can redistribute it and/or modify 13 * it under the terms of version 2 of the GNU General Public License as 14 * published by the Free Software Foundation. 15 * 16 * This program is distributed in the hope that it will be useful, but 17 * WITHOUT ANY WARRANTY; without even the implied warranty of 18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 19 * General Public License for more details. 20 * 21 * You should have received a copy of the GNU General Public License 22 * along with this program; if not, write to the Free Software 23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, 24 * USA 25 * 26 * The full GNU General Public License is included in this distribution 27 * in the file called COPYING. 28 * 29 * Contact Information: 30 * Intel Linux Wireless <linuxwifi@intel.com> 31 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 32 * 33 * BSD LICENSE 34 * 35 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved. 36 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH 37 * Copyright(c) 2016 Intel Deutschland GmbH 38 * All rights reserved. 39 * 40 * Redistribution and use in source and binary forms, with or without 41 * modification, are permitted provided that the following conditions 42 * are met: 43 * 44 * * Redistributions of source code must retain the above copyright 45 * notice, this list of conditions and the following disclaimer. 46 * * Redistributions in binary form must reproduce the above copyright 47 * notice, this list of conditions and the following disclaimer in 48 * the documentation and/or other materials provided with the 49 * distribution. 50 * * Neither the name Intel Corporation nor the names of its 51 * contributors may be used to endorse or promote products derived 52 * from this software without specific prior written permission. 53 * 54 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 55 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 56 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 57 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 58 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 59 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 60 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 61 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 62 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 63 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 64 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 65 * 66 *****************************************************************************/ 67 68 #ifndef __fw_api_h__ 69 #define __fw_api_h__ 70 71 #include "fw-api-rs.h" 72 #include "fw-api-rx.h" 73 #include "fw-api-tx.h" 74 #include "fw-api-sta.h" 75 #include "fw-api-mac.h" 76 #include "fw-api-power.h" 77 #include "fw-api-d3.h" 78 #include "fw-api-coex.h" 79 #include "fw-api-scan.h" 80 #include "fw-api-stats.h" 81 #include "fw-api-tof.h" 82 83 /* Tx queue numbers for non-DQA mode */ 84 enum { 85 IWL_MVM_OFFCHANNEL_QUEUE = 8, 86 IWL_MVM_CMD_QUEUE = 9, 87 }; 88 89 /* 90 * DQA queue numbers 91 * 92 * @IWL_MVM_DQA_CMD_QUEUE: a queue reserved for sending HCMDs to the FW 93 * @IWL_MVM_DQA_P2P_DEVICE_QUEUE: a queue reserved for P2P device frames 94 * @IWL_MVM_DQA_GCAST_QUEUE: a queue reserved for P2P GO/SoftAP GCAST frames 95 * @IWL_MVM_DQA_BSS_CLIENT_QUEUE: a queue reserved for BSS activity, to ensure 96 * that we are never left without the possibility to connect to an AP. 97 * @IWL_MVM_DQA_MIN_MGMT_QUEUE: first TXQ in pool for MGMT and non-QOS frames. 98 * Each MGMT queue is mapped to a single STA 99 * MGMT frames are frames that return true on ieee80211_is_mgmt() 100 * @IWL_MVM_DQA_MAX_MGMT_QUEUE: last TXQ in pool for MGMT frames 101 * @IWL_MVM_DQA_AP_PROBE_RESP_QUEUE: a queue reserved for P2P GO/SoftAP probe 102 * responses 103 * @IWL_MVM_DQA_MIN_DATA_QUEUE: first TXQ in pool for DATA frames. 104 * DATA frames are intended for !ieee80211_is_mgmt() frames, but if 105 * the MGMT TXQ pool is exhausted, mgmt frames can be sent on DATA queues 106 * as well 107 * @IWL_MVM_DQA_MAX_DATA_QUEUE: last TXQ in pool for DATA frames 108 */ 109 enum iwl_mvm_dqa_txq { 110 IWL_MVM_DQA_CMD_QUEUE = 0, 111 IWL_MVM_DQA_P2P_DEVICE_QUEUE = 2, 112 IWL_MVM_DQA_GCAST_QUEUE = 3, 113 IWL_MVM_DQA_BSS_CLIENT_QUEUE = 4, 114 IWL_MVM_DQA_MIN_MGMT_QUEUE = 5, 115 IWL_MVM_DQA_MAX_MGMT_QUEUE = 8, 116 IWL_MVM_DQA_AP_PROBE_RESP_QUEUE = 9, 117 IWL_MVM_DQA_MIN_DATA_QUEUE = 10, 118 IWL_MVM_DQA_MAX_DATA_QUEUE = 31, 119 }; 120 121 enum iwl_mvm_tx_fifo { 122 IWL_MVM_TX_FIFO_BK = 0, 123 IWL_MVM_TX_FIFO_BE, 124 IWL_MVM_TX_FIFO_VI, 125 IWL_MVM_TX_FIFO_VO, 126 IWL_MVM_TX_FIFO_MCAST = 5, 127 IWL_MVM_TX_FIFO_CMD = 7, 128 }; 129 130 #define IWL_MVM_STATION_COUNT 16 131 132 #define IWL_MVM_TDLS_STA_COUNT 4 133 134 /* commands */ 135 enum { 136 MVM_ALIVE = 0x1, 137 REPLY_ERROR = 0x2, 138 ECHO_CMD = 0x3, 139 140 INIT_COMPLETE_NOTIF = 0x4, 141 142 /* PHY context commands */ 143 PHY_CONTEXT_CMD = 0x8, 144 DBG_CFG = 0x9, 145 ANTENNA_COUPLING_NOTIFICATION = 0xa, 146 147 /* UMAC scan commands */ 148 SCAN_ITERATION_COMPLETE_UMAC = 0xb5, 149 SCAN_CFG_CMD = 0xc, 150 SCAN_REQ_UMAC = 0xd, 151 SCAN_ABORT_UMAC = 0xe, 152 SCAN_COMPLETE_UMAC = 0xf, 153 154 BA_WINDOW_STATUS_NOTIFICATION_ID = 0x13, 155 156 /* station table */ 157 ADD_STA_KEY = 0x17, 158 ADD_STA = 0x18, 159 REMOVE_STA = 0x19, 160 161 /* paging get item */ 162 FW_GET_ITEM_CMD = 0x1a, 163 164 /* TX */ 165 TX_CMD = 0x1c, 166 TXPATH_FLUSH = 0x1e, 167 MGMT_MCAST_KEY = 0x1f, 168 169 /* scheduler config */ 170 SCD_QUEUE_CFG = 0x1d, 171 172 /* global key */ 173 WEP_KEY = 0x20, 174 175 /* Memory */ 176 SHARED_MEM_CFG = 0x25, 177 178 /* TDLS */ 179 TDLS_CHANNEL_SWITCH_CMD = 0x27, 180 TDLS_CHANNEL_SWITCH_NOTIFICATION = 0xaa, 181 TDLS_CONFIG_CMD = 0xa7, 182 183 /* MAC and Binding commands */ 184 MAC_CONTEXT_CMD = 0x28, 185 TIME_EVENT_CMD = 0x29, /* both CMD and response */ 186 TIME_EVENT_NOTIFICATION = 0x2a, 187 BINDING_CONTEXT_CMD = 0x2b, 188 TIME_QUOTA_CMD = 0x2c, 189 NON_QOS_TX_COUNTER_CMD = 0x2d, 190 191 LQ_CMD = 0x4e, 192 193 /* paging block to FW cpu2 */ 194 FW_PAGING_BLOCK_CMD = 0x4f, 195 196 /* Scan offload */ 197 SCAN_OFFLOAD_REQUEST_CMD = 0x51, 198 SCAN_OFFLOAD_ABORT_CMD = 0x52, 199 HOT_SPOT_CMD = 0x53, 200 SCAN_OFFLOAD_COMPLETE = 0x6D, 201 SCAN_OFFLOAD_UPDATE_PROFILES_CMD = 0x6E, 202 SCAN_OFFLOAD_CONFIG_CMD = 0x6f, 203 MATCH_FOUND_NOTIFICATION = 0xd9, 204 SCAN_ITERATION_COMPLETE = 0xe7, 205 206 /* Phy */ 207 PHY_CONFIGURATION_CMD = 0x6a, 208 CALIB_RES_NOTIF_PHY_DB = 0x6b, 209 /* PHY_DB_CMD = 0x6c, */ 210 211 /* ToF - 802.11mc FTM */ 212 TOF_CMD = 0x10, 213 TOF_NOTIFICATION = 0x11, 214 215 /* Power - legacy power table command */ 216 POWER_TABLE_CMD = 0x77, 217 PSM_UAPSD_AP_MISBEHAVING_NOTIFICATION = 0x78, 218 LTR_CONFIG = 0xee, 219 220 /* Thermal Throttling*/ 221 REPLY_THERMAL_MNG_BACKOFF = 0x7e, 222 223 /* Set/Get DC2DC frequency tune */ 224 DC2DC_CONFIG_CMD = 0x83, 225 226 /* NVM */ 227 NVM_ACCESS_CMD = 0x88, 228 229 SET_CALIB_DEFAULT_CMD = 0x8e, 230 231 BEACON_NOTIFICATION = 0x90, 232 BEACON_TEMPLATE_CMD = 0x91, 233 TX_ANT_CONFIGURATION_CMD = 0x98, 234 STATISTICS_CMD = 0x9c, 235 STATISTICS_NOTIFICATION = 0x9d, 236 EOSP_NOTIFICATION = 0x9e, 237 REDUCE_TX_POWER_CMD = 0x9f, 238 239 /* RF-KILL commands and notifications */ 240 CARD_STATE_CMD = 0xa0, 241 CARD_STATE_NOTIFICATION = 0xa1, 242 243 MISSED_BEACONS_NOTIFICATION = 0xa2, 244 245 /* Power - new power table command */ 246 MAC_PM_POWER_TABLE = 0xa9, 247 248 MFUART_LOAD_NOTIFICATION = 0xb1, 249 250 RSS_CONFIG_CMD = 0xb3, 251 252 REPLY_RX_PHY_CMD = 0xc0, 253 REPLY_RX_MPDU_CMD = 0xc1, 254 FRAME_RELEASE = 0xc3, 255 BA_NOTIF = 0xc5, 256 257 /* Location Aware Regulatory */ 258 MCC_UPDATE_CMD = 0xc8, 259 MCC_CHUB_UPDATE_CMD = 0xc9, 260 261 MARKER_CMD = 0xcb, 262 263 /* BT Coex */ 264 BT_COEX_PRIO_TABLE = 0xcc, 265 BT_COEX_PROT_ENV = 0xcd, 266 BT_PROFILE_NOTIFICATION = 0xce, 267 BT_CONFIG = 0x9b, 268 BT_COEX_UPDATE_SW_BOOST = 0x5a, 269 BT_COEX_UPDATE_CORUN_LUT = 0x5b, 270 BT_COEX_UPDATE_REDUCED_TXP = 0x5c, 271 BT_COEX_CI = 0x5d, 272 273 REPLY_SF_CFG_CMD = 0xd1, 274 REPLY_BEACON_FILTERING_CMD = 0xd2, 275 276 /* DTS measurements */ 277 CMD_DTS_MEASUREMENT_TRIGGER = 0xdc, 278 DTS_MEASUREMENT_NOTIFICATION = 0xdd, 279 280 REPLY_DEBUG_CMD = 0xf0, 281 LDBG_CONFIG_CMD = 0xf6, 282 DEBUG_LOG_MSG = 0xf7, 283 284 BCAST_FILTER_CMD = 0xcf, 285 MCAST_FILTER_CMD = 0xd0, 286 287 /* D3 commands/notifications */ 288 D3_CONFIG_CMD = 0xd3, 289 PROT_OFFLOAD_CONFIG_CMD = 0xd4, 290 OFFLOADS_QUERY_CMD = 0xd5, 291 REMOTE_WAKE_CONFIG_CMD = 0xd6, 292 D0I3_END_CMD = 0xed, 293 294 /* for WoWLAN in particular */ 295 WOWLAN_PATTERNS = 0xe0, 296 WOWLAN_CONFIGURATION = 0xe1, 297 WOWLAN_TSC_RSC_PARAM = 0xe2, 298 WOWLAN_TKIP_PARAM = 0xe3, 299 WOWLAN_KEK_KCK_MATERIAL = 0xe4, 300 WOWLAN_GET_STATUSES = 0xe5, 301 WOWLAN_TX_POWER_PER_DB = 0xe6, 302 303 /* and for NetDetect */ 304 SCAN_OFFLOAD_PROFILES_QUERY_CMD = 0x56, 305 SCAN_OFFLOAD_HOTSPOTS_CONFIG_CMD = 0x58, 306 SCAN_OFFLOAD_HOTSPOTS_QUERY_CMD = 0x59, 307 308 REPLY_MAX = 0xff, 309 }; 310 311 /* Please keep this enum *SORTED* by hex value. 312 * Needed for binary search, otherwise a warning will be triggered. 313 */ 314 enum iwl_mac_conf_subcmd_ids { 315 LINK_QUALITY_MEASUREMENT_CMD = 0x1, 316 LINK_QUALITY_MEASUREMENT_COMPLETE_NOTIF = 0xFE, 317 }; 318 319 enum iwl_phy_ops_subcmd_ids { 320 CMD_DTS_MEASUREMENT_TRIGGER_WIDE = 0x0, 321 CTDP_CONFIG_CMD = 0x03, 322 TEMP_REPORTING_THRESHOLDS_CMD = 0x04, 323 CT_KILL_NOTIFICATION = 0xFE, 324 DTS_MEASUREMENT_NOTIF_WIDE = 0xFF, 325 }; 326 327 enum iwl_system_subcmd_ids { 328 SHARED_MEM_CFG_CMD = 0x0, 329 }; 330 331 enum iwl_data_path_subcmd_ids { 332 UPDATE_MU_GROUPS_CMD = 0x1, 333 TRIGGER_RX_QUEUES_NOTIF_CMD = 0x2, 334 MU_GROUP_MGMT_NOTIF = 0xFE, 335 RX_QUEUES_NOTIFICATION = 0xFF, 336 }; 337 338 enum iwl_prot_offload_subcmd_ids { 339 STORED_BEACON_NTF = 0xFF, 340 }; 341 342 /* command groups */ 343 enum { 344 LEGACY_GROUP = 0x0, 345 LONG_GROUP = 0x1, 346 SYSTEM_GROUP = 0x2, 347 MAC_CONF_GROUP = 0x3, 348 PHY_OPS_GROUP = 0x4, 349 DATA_PATH_GROUP = 0x5, 350 PROT_OFFLOAD_GROUP = 0xb, 351 }; 352 353 /** 354 * struct iwl_cmd_response - generic response struct for most commands 355 * @status: status of the command asked, changes for each one 356 */ 357 struct iwl_cmd_response { 358 __le32 status; 359 }; 360 361 /* 362 * struct iwl_tx_ant_cfg_cmd 363 * @valid: valid antenna configuration 364 */ 365 struct iwl_tx_ant_cfg_cmd { 366 __le32 valid; 367 } __packed; 368 369 /* 370 * Calibration control struct. 371 * Sent as part of the phy configuration command. 372 * @flow_trigger: bitmap for which calibrations to perform according to 373 * flow triggers. 374 * @event_trigger: bitmap for which calibrations to perform according to 375 * event triggers. 376 */ 377 struct iwl_calib_ctrl { 378 __le32 flow_trigger; 379 __le32 event_trigger; 380 } __packed; 381 382 /* This enum defines the bitmap of various calibrations to enable in both 383 * init ucode and runtime ucode through CALIBRATION_CFG_CMD. 384 */ 385 enum iwl_calib_cfg { 386 IWL_CALIB_CFG_XTAL_IDX = BIT(0), 387 IWL_CALIB_CFG_TEMPERATURE_IDX = BIT(1), 388 IWL_CALIB_CFG_VOLTAGE_READ_IDX = BIT(2), 389 IWL_CALIB_CFG_PAPD_IDX = BIT(3), 390 IWL_CALIB_CFG_TX_PWR_IDX = BIT(4), 391 IWL_CALIB_CFG_DC_IDX = BIT(5), 392 IWL_CALIB_CFG_BB_FILTER_IDX = BIT(6), 393 IWL_CALIB_CFG_LO_LEAKAGE_IDX = BIT(7), 394 IWL_CALIB_CFG_TX_IQ_IDX = BIT(8), 395 IWL_CALIB_CFG_TX_IQ_SKEW_IDX = BIT(9), 396 IWL_CALIB_CFG_RX_IQ_IDX = BIT(10), 397 IWL_CALIB_CFG_RX_IQ_SKEW_IDX = BIT(11), 398 IWL_CALIB_CFG_SENSITIVITY_IDX = BIT(12), 399 IWL_CALIB_CFG_CHAIN_NOISE_IDX = BIT(13), 400 IWL_CALIB_CFG_DISCONNECTED_ANT_IDX = BIT(14), 401 IWL_CALIB_CFG_ANT_COUPLING_IDX = BIT(15), 402 IWL_CALIB_CFG_DAC_IDX = BIT(16), 403 IWL_CALIB_CFG_ABS_IDX = BIT(17), 404 IWL_CALIB_CFG_AGC_IDX = BIT(18), 405 }; 406 407 /* 408 * Phy configuration command. 409 */ 410 struct iwl_phy_cfg_cmd { 411 __le32 phy_cfg; 412 struct iwl_calib_ctrl calib_control; 413 } __packed; 414 415 #define PHY_CFG_RADIO_TYPE (BIT(0) | BIT(1)) 416 #define PHY_CFG_RADIO_STEP (BIT(2) | BIT(3)) 417 #define PHY_CFG_RADIO_DASH (BIT(4) | BIT(5)) 418 #define PHY_CFG_PRODUCT_NUMBER (BIT(6) | BIT(7)) 419 #define PHY_CFG_TX_CHAIN_A BIT(8) 420 #define PHY_CFG_TX_CHAIN_B BIT(9) 421 #define PHY_CFG_TX_CHAIN_C BIT(10) 422 #define PHY_CFG_RX_CHAIN_A BIT(12) 423 #define PHY_CFG_RX_CHAIN_B BIT(13) 424 #define PHY_CFG_RX_CHAIN_C BIT(14) 425 426 427 /* Target of the NVM_ACCESS_CMD */ 428 enum { 429 NVM_ACCESS_TARGET_CACHE = 0, 430 NVM_ACCESS_TARGET_OTP = 1, 431 NVM_ACCESS_TARGET_EEPROM = 2, 432 }; 433 434 /* Section types for NVM_ACCESS_CMD */ 435 enum { 436 NVM_SECTION_TYPE_SW = 1, 437 NVM_SECTION_TYPE_REGULATORY = 3, 438 NVM_SECTION_TYPE_CALIBRATION = 4, 439 NVM_SECTION_TYPE_PRODUCTION = 5, 440 NVM_SECTION_TYPE_MAC_OVERRIDE = 11, 441 NVM_SECTION_TYPE_PHY_SKU = 12, 442 NVM_MAX_NUM_SECTIONS = 13, 443 }; 444 445 /** 446 * struct iwl_nvm_access_cmd_ver2 - Request the device to send an NVM section 447 * @op_code: 0 - read, 1 - write 448 * @target: NVM_ACCESS_TARGET_* 449 * @type: NVM_SECTION_TYPE_* 450 * @offset: offset in bytes into the section 451 * @length: in bytes, to read/write 452 * @data: if write operation, the data to write. On read its empty 453 */ 454 struct iwl_nvm_access_cmd { 455 u8 op_code; 456 u8 target; 457 __le16 type; 458 __le16 offset; 459 __le16 length; 460 u8 data[]; 461 } __packed; /* NVM_ACCESS_CMD_API_S_VER_2 */ 462 463 #define NUM_OF_FW_PAGING_BLOCKS 33 /* 32 for data and 1 block for CSS */ 464 465 /* 466 * struct iwl_fw_paging_cmd - paging layout 467 * 468 * (FW_PAGING_BLOCK_CMD = 0x4f) 469 * 470 * Send to FW the paging layout in the driver. 471 * 472 * @flags: various flags for the command 473 * @block_size: the block size in powers of 2 474 * @block_num: number of blocks specified in the command. 475 * @device_phy_addr: virtual addresses from device side 476 */ 477 struct iwl_fw_paging_cmd { 478 __le32 flags; 479 __le32 block_size; 480 __le32 block_num; 481 __le32 device_phy_addr[NUM_OF_FW_PAGING_BLOCKS]; 482 } __packed; /* FW_PAGING_BLOCK_CMD_API_S_VER_1 */ 483 484 /* 485 * Fw items ID's 486 * 487 * @IWL_FW_ITEM_ID_PAGING: Address of the pages that the FW will upload 488 * download 489 */ 490 enum iwl_fw_item_id { 491 IWL_FW_ITEM_ID_PAGING = 3, 492 }; 493 494 /* 495 * struct iwl_fw_get_item_cmd - get an item from the fw 496 */ 497 struct iwl_fw_get_item_cmd { 498 __le32 item_id; 499 } __packed; /* FW_GET_ITEM_CMD_API_S_VER_1 */ 500 501 #define CONT_REC_COMMAND_SIZE 80 502 #define ENABLE_CONT_RECORDING 0x15 503 #define DISABLE_CONT_RECORDING 0x16 504 505 /* 506 * struct iwl_continuous_record_mode - recording mode 507 */ 508 struct iwl_continuous_record_mode { 509 __le16 enable_recording; 510 } __packed; 511 512 /* 513 * struct iwl_continuous_record_cmd - enable/disable continuous recording 514 */ 515 struct iwl_continuous_record_cmd { 516 struct iwl_continuous_record_mode record_mode; 517 u8 pad[CONT_REC_COMMAND_SIZE - 518 sizeof(struct iwl_continuous_record_mode)]; 519 } __packed; 520 521 struct iwl_fw_get_item_resp { 522 __le32 item_id; 523 __le32 item_byte_cnt; 524 __le32 item_val; 525 } __packed; /* FW_GET_ITEM_RSP_S_VER_1 */ 526 527 /** 528 * struct iwl_nvm_access_resp_ver2 - response to NVM_ACCESS_CMD 529 * @offset: offset in bytes into the section 530 * @length: in bytes, either how much was written or read 531 * @type: NVM_SECTION_TYPE_* 532 * @status: 0 for success, fail otherwise 533 * @data: if read operation, the data returned. Empty on write. 534 */ 535 struct iwl_nvm_access_resp { 536 __le16 offset; 537 __le16 length; 538 __le16 type; 539 __le16 status; 540 u8 data[]; 541 } __packed; /* NVM_ACCESS_CMD_RESP_API_S_VER_2 */ 542 543 /* MVM_ALIVE 0x1 */ 544 545 /* alive response is_valid values */ 546 #define ALIVE_RESP_UCODE_OK BIT(0) 547 #define ALIVE_RESP_RFKILL BIT(1) 548 549 /* alive response ver_type values */ 550 enum { 551 FW_TYPE_HW = 0, 552 FW_TYPE_PROT = 1, 553 FW_TYPE_AP = 2, 554 FW_TYPE_WOWLAN = 3, 555 FW_TYPE_TIMING = 4, 556 FW_TYPE_WIPAN = 5 557 }; 558 559 /* alive response ver_subtype values */ 560 enum { 561 FW_SUBTYPE_FULL_FEATURE = 0, 562 FW_SUBTYPE_BOOTSRAP = 1, /* Not valid */ 563 FW_SUBTYPE_REDUCED = 2, 564 FW_SUBTYPE_ALIVE_ONLY = 3, 565 FW_SUBTYPE_WOWLAN = 4, 566 FW_SUBTYPE_AP_SUBTYPE = 5, 567 FW_SUBTYPE_WIPAN = 6, 568 FW_SUBTYPE_INITIALIZE = 9 569 }; 570 571 #define IWL_ALIVE_STATUS_ERR 0xDEAD 572 #define IWL_ALIVE_STATUS_OK 0xCAFE 573 574 #define IWL_ALIVE_FLG_RFKILL BIT(0) 575 576 struct mvm_alive_resp_ver1 { 577 __le16 status; 578 __le16 flags; 579 u8 ucode_minor; 580 u8 ucode_major; 581 __le16 id; 582 u8 api_minor; 583 u8 api_major; 584 u8 ver_subtype; 585 u8 ver_type; 586 u8 mac; 587 u8 opt; 588 __le16 reserved2; 589 __le32 timestamp; 590 __le32 error_event_table_ptr; /* SRAM address for error log */ 591 __le32 log_event_table_ptr; /* SRAM address for event log */ 592 __le32 cpu_register_ptr; 593 __le32 dbgm_config_ptr; 594 __le32 alive_counter_ptr; 595 __le32 scd_base_ptr; /* SRAM address for SCD */ 596 } __packed; /* ALIVE_RES_API_S_VER_1 */ 597 598 struct mvm_alive_resp_ver2 { 599 __le16 status; 600 __le16 flags; 601 u8 ucode_minor; 602 u8 ucode_major; 603 __le16 id; 604 u8 api_minor; 605 u8 api_major; 606 u8 ver_subtype; 607 u8 ver_type; 608 u8 mac; 609 u8 opt; 610 __le16 reserved2; 611 __le32 timestamp; 612 __le32 error_event_table_ptr; /* SRAM address for error log */ 613 __le32 log_event_table_ptr; /* SRAM address for LMAC event log */ 614 __le32 cpu_register_ptr; 615 __le32 dbgm_config_ptr; 616 __le32 alive_counter_ptr; 617 __le32 scd_base_ptr; /* SRAM address for SCD */ 618 __le32 st_fwrd_addr; /* pointer to Store and forward */ 619 __le32 st_fwrd_size; 620 u8 umac_minor; /* UMAC version: minor */ 621 u8 umac_major; /* UMAC version: major */ 622 __le16 umac_id; /* UMAC version: id */ 623 __le32 error_info_addr; /* SRAM address for UMAC error log */ 624 __le32 dbg_print_buff_addr; 625 } __packed; /* ALIVE_RES_API_S_VER_2 */ 626 627 struct mvm_alive_resp { 628 __le16 status; 629 __le16 flags; 630 __le32 ucode_minor; 631 __le32 ucode_major; 632 u8 ver_subtype; 633 u8 ver_type; 634 u8 mac; 635 u8 opt; 636 __le32 timestamp; 637 __le32 error_event_table_ptr; /* SRAM address for error log */ 638 __le32 log_event_table_ptr; /* SRAM address for LMAC event log */ 639 __le32 cpu_register_ptr; 640 __le32 dbgm_config_ptr; 641 __le32 alive_counter_ptr; 642 __le32 scd_base_ptr; /* SRAM address for SCD */ 643 __le32 st_fwrd_addr; /* pointer to Store and forward */ 644 __le32 st_fwrd_size; 645 __le32 umac_minor; /* UMAC version: minor */ 646 __le32 umac_major; /* UMAC version: major */ 647 __le32 error_info_addr; /* SRAM address for UMAC error log */ 648 __le32 dbg_print_buff_addr; 649 } __packed; /* ALIVE_RES_API_S_VER_3 */ 650 651 /* Error response/notification */ 652 enum { 653 FW_ERR_UNKNOWN_CMD = 0x0, 654 FW_ERR_INVALID_CMD_PARAM = 0x1, 655 FW_ERR_SERVICE = 0x2, 656 FW_ERR_ARC_MEMORY = 0x3, 657 FW_ERR_ARC_CODE = 0x4, 658 FW_ERR_WATCH_DOG = 0x5, 659 FW_ERR_WEP_GRP_KEY_INDX = 0x10, 660 FW_ERR_WEP_KEY_SIZE = 0x11, 661 FW_ERR_OBSOLETE_FUNC = 0x12, 662 FW_ERR_UNEXPECTED = 0xFE, 663 FW_ERR_FATAL = 0xFF 664 }; 665 666 /** 667 * struct iwl_error_resp - FW error indication 668 * ( REPLY_ERROR = 0x2 ) 669 * @error_type: one of FW_ERR_* 670 * @cmd_id: the command ID for which the error occured 671 * @bad_cmd_seq_num: sequence number of the erroneous command 672 * @error_service: which service created the error, applicable only if 673 * error_type = 2, otherwise 0 674 * @timestamp: TSF in usecs. 675 */ 676 struct iwl_error_resp { 677 __le32 error_type; 678 u8 cmd_id; 679 u8 reserved1; 680 __le16 bad_cmd_seq_num; 681 __le32 error_service; 682 __le64 timestamp; 683 } __packed; 684 685 686 /* Common PHY, MAC and Bindings definitions */ 687 688 #define MAX_MACS_IN_BINDING (3) 689 #define MAX_BINDINGS (4) 690 #define AUX_BINDING_INDEX (3) 691 #define MAX_PHYS (4) 692 693 /* Used to extract ID and color from the context dword */ 694 #define FW_CTXT_ID_POS (0) 695 #define FW_CTXT_ID_MSK (0xff << FW_CTXT_ID_POS) 696 #define FW_CTXT_COLOR_POS (8) 697 #define FW_CTXT_COLOR_MSK (0xff << FW_CTXT_COLOR_POS) 698 #define FW_CTXT_INVALID (0xffffffff) 699 700 #define FW_CMD_ID_AND_COLOR(_id, _color) ((_id << FW_CTXT_ID_POS) |\ 701 (_color << FW_CTXT_COLOR_POS)) 702 703 /* Possible actions on PHYs, MACs and Bindings */ 704 enum { 705 FW_CTXT_ACTION_STUB = 0, 706 FW_CTXT_ACTION_ADD, 707 FW_CTXT_ACTION_MODIFY, 708 FW_CTXT_ACTION_REMOVE, 709 FW_CTXT_ACTION_NUM 710 }; /* COMMON_CONTEXT_ACTION_API_E_VER_1 */ 711 712 /* Time Events */ 713 714 /* Time Event types, according to MAC type */ 715 enum iwl_time_event_type { 716 /* BSS Station Events */ 717 TE_BSS_STA_AGGRESSIVE_ASSOC, 718 TE_BSS_STA_ASSOC, 719 TE_BSS_EAP_DHCP_PROT, 720 TE_BSS_QUIET_PERIOD, 721 722 /* P2P Device Events */ 723 TE_P2P_DEVICE_DISCOVERABLE, 724 TE_P2P_DEVICE_LISTEN, 725 TE_P2P_DEVICE_ACTION_SCAN, 726 TE_P2P_DEVICE_FULL_SCAN, 727 728 /* P2P Client Events */ 729 TE_P2P_CLIENT_AGGRESSIVE_ASSOC, 730 TE_P2P_CLIENT_ASSOC, 731 TE_P2P_CLIENT_QUIET_PERIOD, 732 733 /* P2P GO Events */ 734 TE_P2P_GO_ASSOC_PROT, 735 TE_P2P_GO_REPETITIVE_NOA, 736 TE_P2P_GO_CT_WINDOW, 737 738 /* WiDi Sync Events */ 739 TE_WIDI_TX_SYNC, 740 741 /* Channel Switch NoA */ 742 TE_CHANNEL_SWITCH_PERIOD, 743 744 TE_MAX 745 }; /* MAC_EVENT_TYPE_API_E_VER_1 */ 746 747 748 749 /* Time event - defines for command API v1 */ 750 751 /* 752 * @TE_V1_FRAG_NONE: fragmentation of the time event is NOT allowed. 753 * @TE_V1_FRAG_SINGLE: fragmentation of the time event is allowed, but only 754 * the first fragment is scheduled. 755 * @TE_V1_FRAG_DUAL: fragmentation of the time event is allowed, but only 756 * the first 2 fragments are scheduled. 757 * @TE_V1_FRAG_ENDLESS: fragmentation of the time event is allowed, and any 758 * number of fragments are valid. 759 * 760 * Other than the constant defined above, specifying a fragmentation value 'x' 761 * means that the event can be fragmented but only the first 'x' will be 762 * scheduled. 763 */ 764 enum { 765 TE_V1_FRAG_NONE = 0, 766 TE_V1_FRAG_SINGLE = 1, 767 TE_V1_FRAG_DUAL = 2, 768 TE_V1_FRAG_ENDLESS = 0xffffffff 769 }; 770 771 /* If a Time Event can be fragmented, this is the max number of fragments */ 772 #define TE_V1_FRAG_MAX_MSK 0x0fffffff 773 /* Repeat the time event endlessly (until removed) */ 774 #define TE_V1_REPEAT_ENDLESS 0xffffffff 775 /* If a Time Event has bounded repetitions, this is the maximal value */ 776 #define TE_V1_REPEAT_MAX_MSK_V1 0x0fffffff 777 778 /* Time Event dependencies: none, on another TE, or in a specific time */ 779 enum { 780 TE_V1_INDEPENDENT = 0, 781 TE_V1_DEP_OTHER = BIT(0), 782 TE_V1_DEP_TSF = BIT(1), 783 TE_V1_EVENT_SOCIOPATHIC = BIT(2), 784 }; /* MAC_EVENT_DEPENDENCY_POLICY_API_E_VER_2 */ 785 786 /* 787 * @TE_V1_NOTIF_NONE: no notifications 788 * @TE_V1_NOTIF_HOST_EVENT_START: request/receive notification on event start 789 * @TE_V1_NOTIF_HOST_EVENT_END:request/receive notification on event end 790 * @TE_V1_NOTIF_INTERNAL_EVENT_START: internal FW use 791 * @TE_V1_NOTIF_INTERNAL_EVENT_END: internal FW use. 792 * @TE_V1_NOTIF_HOST_FRAG_START: request/receive notification on frag start 793 * @TE_V1_NOTIF_HOST_FRAG_END:request/receive notification on frag end 794 * @TE_V1_NOTIF_INTERNAL_FRAG_START: internal FW use. 795 * @TE_V1_NOTIF_INTERNAL_FRAG_END: internal FW use. 796 * 797 * Supported Time event notifications configuration. 798 * A notification (both event and fragment) includes a status indicating weather 799 * the FW was able to schedule the event or not. For fragment start/end 800 * notification the status is always success. There is no start/end fragment 801 * notification for monolithic events. 802 */ 803 enum { 804 TE_V1_NOTIF_NONE = 0, 805 TE_V1_NOTIF_HOST_EVENT_START = BIT(0), 806 TE_V1_NOTIF_HOST_EVENT_END = BIT(1), 807 TE_V1_NOTIF_INTERNAL_EVENT_START = BIT(2), 808 TE_V1_NOTIF_INTERNAL_EVENT_END = BIT(3), 809 TE_V1_NOTIF_HOST_FRAG_START = BIT(4), 810 TE_V1_NOTIF_HOST_FRAG_END = BIT(5), 811 TE_V1_NOTIF_INTERNAL_FRAG_START = BIT(6), 812 TE_V1_NOTIF_INTERNAL_FRAG_END = BIT(7), 813 }; /* MAC_EVENT_ACTION_API_E_VER_2 */ 814 815 /* Time event - defines for command API */ 816 817 /* 818 * @TE_V2_FRAG_NONE: fragmentation of the time event is NOT allowed. 819 * @TE_V2_FRAG_SINGLE: fragmentation of the time event is allowed, but only 820 * the first fragment is scheduled. 821 * @TE_V2_FRAG_DUAL: fragmentation of the time event is allowed, but only 822 * the first 2 fragments are scheduled. 823 * @TE_V2_FRAG_ENDLESS: fragmentation of the time event is allowed, and any 824 * number of fragments are valid. 825 * 826 * Other than the constant defined above, specifying a fragmentation value 'x' 827 * means that the event can be fragmented but only the first 'x' will be 828 * scheduled. 829 */ 830 enum { 831 TE_V2_FRAG_NONE = 0, 832 TE_V2_FRAG_SINGLE = 1, 833 TE_V2_FRAG_DUAL = 2, 834 TE_V2_FRAG_MAX = 0xfe, 835 TE_V2_FRAG_ENDLESS = 0xff 836 }; 837 838 /* Repeat the time event endlessly (until removed) */ 839 #define TE_V2_REPEAT_ENDLESS 0xff 840 /* If a Time Event has bounded repetitions, this is the maximal value */ 841 #define TE_V2_REPEAT_MAX 0xfe 842 843 #define TE_V2_PLACEMENT_POS 12 844 #define TE_V2_ABSENCE_POS 15 845 846 /* Time event policy values 847 * A notification (both event and fragment) includes a status indicating weather 848 * the FW was able to schedule the event or not. For fragment start/end 849 * notification the status is always success. There is no start/end fragment 850 * notification for monolithic events. 851 * 852 * @TE_V2_DEFAULT_POLICY: independent, social, present, unoticable 853 * @TE_V2_NOTIF_HOST_EVENT_START: request/receive notification on event start 854 * @TE_V2_NOTIF_HOST_EVENT_END:request/receive notification on event end 855 * @TE_V2_NOTIF_INTERNAL_EVENT_START: internal FW use 856 * @TE_V2_NOTIF_INTERNAL_EVENT_END: internal FW use. 857 * @TE_V2_NOTIF_HOST_FRAG_START: request/receive notification on frag start 858 * @TE_V2_NOTIF_HOST_FRAG_END:request/receive notification on frag end 859 * @TE_V2_NOTIF_INTERNAL_FRAG_START: internal FW use. 860 * @TE_V2_NOTIF_INTERNAL_FRAG_END: internal FW use. 861 * @TE_V2_DEP_OTHER: depends on another time event 862 * @TE_V2_DEP_TSF: depends on a specific time 863 * @TE_V2_EVENT_SOCIOPATHIC: can't co-exist with other events of tha same MAC 864 * @TE_V2_ABSENCE: are we present or absent during the Time Event. 865 */ 866 enum { 867 TE_V2_DEFAULT_POLICY = 0x0, 868 869 /* notifications (event start/stop, fragment start/stop) */ 870 TE_V2_NOTIF_HOST_EVENT_START = BIT(0), 871 TE_V2_NOTIF_HOST_EVENT_END = BIT(1), 872 TE_V2_NOTIF_INTERNAL_EVENT_START = BIT(2), 873 TE_V2_NOTIF_INTERNAL_EVENT_END = BIT(3), 874 875 TE_V2_NOTIF_HOST_FRAG_START = BIT(4), 876 TE_V2_NOTIF_HOST_FRAG_END = BIT(5), 877 TE_V2_NOTIF_INTERNAL_FRAG_START = BIT(6), 878 TE_V2_NOTIF_INTERNAL_FRAG_END = BIT(7), 879 T2_V2_START_IMMEDIATELY = BIT(11), 880 881 TE_V2_NOTIF_MSK = 0xff, 882 883 /* placement characteristics */ 884 TE_V2_DEP_OTHER = BIT(TE_V2_PLACEMENT_POS), 885 TE_V2_DEP_TSF = BIT(TE_V2_PLACEMENT_POS + 1), 886 TE_V2_EVENT_SOCIOPATHIC = BIT(TE_V2_PLACEMENT_POS + 2), 887 888 /* are we present or absent during the Time Event. */ 889 TE_V2_ABSENCE = BIT(TE_V2_ABSENCE_POS), 890 }; 891 892 /** 893 * struct iwl_time_event_cmd_api - configuring Time Events 894 * with struct MAC_TIME_EVENT_DATA_API_S_VER_2 (see also 895 * with version 1. determined by IWL_UCODE_TLV_FLAGS) 896 * ( TIME_EVENT_CMD = 0x29 ) 897 * @id_and_color: ID and color of the relevant MAC 898 * @action: action to perform, one of FW_CTXT_ACTION_* 899 * @id: this field has two meanings, depending on the action: 900 * If the action is ADD, then it means the type of event to add. 901 * For all other actions it is the unique event ID assigned when the 902 * event was added by the FW. 903 * @apply_time: When to start the Time Event (in GP2) 904 * @max_delay: maximum delay to event's start (apply time), in TU 905 * @depends_on: the unique ID of the event we depend on (if any) 906 * @interval: interval between repetitions, in TU 907 * @duration: duration of event in TU 908 * @repeat: how many repetitions to do, can be TE_REPEAT_ENDLESS 909 * @max_frags: maximal number of fragments the Time Event can be divided to 910 * @policy: defines whether uCode shall notify the host or other uCode modules 911 * on event and/or fragment start and/or end 912 * using one of TE_INDEPENDENT, TE_DEP_OTHER, TE_DEP_TSF 913 * TE_EVENT_SOCIOPATHIC 914 * using TE_ABSENCE and using TE_NOTIF_* 915 */ 916 struct iwl_time_event_cmd { 917 /* COMMON_INDEX_HDR_API_S_VER_1 */ 918 __le32 id_and_color; 919 __le32 action; 920 __le32 id; 921 /* MAC_TIME_EVENT_DATA_API_S_VER_2 */ 922 __le32 apply_time; 923 __le32 max_delay; 924 __le32 depends_on; 925 __le32 interval; 926 __le32 duration; 927 u8 repeat; 928 u8 max_frags; 929 __le16 policy; 930 } __packed; /* MAC_TIME_EVENT_CMD_API_S_VER_2 */ 931 932 /** 933 * struct iwl_time_event_resp - response structure to iwl_time_event_cmd 934 * @status: bit 0 indicates success, all others specify errors 935 * @id: the Time Event type 936 * @unique_id: the unique ID assigned (in ADD) or given (others) to the TE 937 * @id_and_color: ID and color of the relevant MAC 938 */ 939 struct iwl_time_event_resp { 940 __le32 status; 941 __le32 id; 942 __le32 unique_id; 943 __le32 id_and_color; 944 } __packed; /* MAC_TIME_EVENT_RSP_API_S_VER_1 */ 945 946 /** 947 * struct iwl_time_event_notif - notifications of time event start/stop 948 * ( TIME_EVENT_NOTIFICATION = 0x2a ) 949 * @timestamp: action timestamp in GP2 950 * @session_id: session's unique id 951 * @unique_id: unique id of the Time Event itself 952 * @id_and_color: ID and color of the relevant MAC 953 * @action: one of TE_NOTIF_START or TE_NOTIF_END 954 * @status: true if scheduled, false otherwise (not executed) 955 */ 956 struct iwl_time_event_notif { 957 __le32 timestamp; 958 __le32 session_id; 959 __le32 unique_id; 960 __le32 id_and_color; 961 __le32 action; 962 __le32 status; 963 } __packed; /* MAC_TIME_EVENT_NTFY_API_S_VER_1 */ 964 965 966 /* Bindings and Time Quota */ 967 968 /** 969 * struct iwl_binding_cmd - configuring bindings 970 * ( BINDING_CONTEXT_CMD = 0x2b ) 971 * @id_and_color: ID and color of the relevant Binding 972 * @action: action to perform, one of FW_CTXT_ACTION_* 973 * @macs: array of MAC id and colors which belong to the binding 974 * @phy: PHY id and color which belongs to the binding 975 */ 976 struct iwl_binding_cmd { 977 /* COMMON_INDEX_HDR_API_S_VER_1 */ 978 __le32 id_and_color; 979 __le32 action; 980 /* BINDING_DATA_API_S_VER_1 */ 981 __le32 macs[MAX_MACS_IN_BINDING]; 982 __le32 phy; 983 } __packed; /* BINDING_CMD_API_S_VER_1 */ 984 985 /* The maximal number of fragments in the FW's schedule session */ 986 #define IWL_MVM_MAX_QUOTA 128 987 988 /** 989 * struct iwl_time_quota_data - configuration of time quota per binding 990 * @id_and_color: ID and color of the relevant Binding 991 * @quota: absolute time quota in TU. The scheduler will try to divide the 992 * remainig quota (after Time Events) according to this quota. 993 * @max_duration: max uninterrupted context duration in TU 994 */ 995 struct iwl_time_quota_data { 996 __le32 id_and_color; 997 __le32 quota; 998 __le32 max_duration; 999 } __packed; /* TIME_QUOTA_DATA_API_S_VER_1 */ 1000 1001 /** 1002 * struct iwl_time_quota_cmd - configuration of time quota between bindings 1003 * ( TIME_QUOTA_CMD = 0x2c ) 1004 * @quotas: allocations per binding 1005 */ 1006 struct iwl_time_quota_cmd { 1007 struct iwl_time_quota_data quotas[MAX_BINDINGS]; 1008 } __packed; /* TIME_QUOTA_ALLOCATION_CMD_API_S_VER_1 */ 1009 1010 1011 /* PHY context */ 1012 1013 /* Supported bands */ 1014 #define PHY_BAND_5 (0) 1015 #define PHY_BAND_24 (1) 1016 1017 /* Supported channel width, vary if there is VHT support */ 1018 #define PHY_VHT_CHANNEL_MODE20 (0x0) 1019 #define PHY_VHT_CHANNEL_MODE40 (0x1) 1020 #define PHY_VHT_CHANNEL_MODE80 (0x2) 1021 #define PHY_VHT_CHANNEL_MODE160 (0x3) 1022 1023 /* 1024 * Control channel position: 1025 * For legacy set bit means upper channel, otherwise lower. 1026 * For VHT - bit-2 marks if the control is lower/upper relative to center-freq 1027 * bits-1:0 mark the distance from the center freq. for 20Mhz, offset is 0. 1028 * center_freq 1029 * | 1030 * 40Mhz |_______|_______| 1031 * 80Mhz |_______|_______|_______|_______| 1032 * 160Mhz |_______|_______|_______|_______|_______|_______|_______|_______| 1033 * code 011 010 001 000 | 100 101 110 111 1034 */ 1035 #define PHY_VHT_CTRL_POS_1_BELOW (0x0) 1036 #define PHY_VHT_CTRL_POS_2_BELOW (0x1) 1037 #define PHY_VHT_CTRL_POS_3_BELOW (0x2) 1038 #define PHY_VHT_CTRL_POS_4_BELOW (0x3) 1039 #define PHY_VHT_CTRL_POS_1_ABOVE (0x4) 1040 #define PHY_VHT_CTRL_POS_2_ABOVE (0x5) 1041 #define PHY_VHT_CTRL_POS_3_ABOVE (0x6) 1042 #define PHY_VHT_CTRL_POS_4_ABOVE (0x7) 1043 1044 /* 1045 * @band: PHY_BAND_* 1046 * @channel: channel number 1047 * @width: PHY_[VHT|LEGACY]_CHANNEL_* 1048 * @ctrl channel: PHY_[VHT|LEGACY]_CTRL_* 1049 */ 1050 struct iwl_fw_channel_info { 1051 u8 band; 1052 u8 channel; 1053 u8 width; 1054 u8 ctrl_pos; 1055 } __packed; 1056 1057 #define PHY_RX_CHAIN_DRIVER_FORCE_POS (0) 1058 #define PHY_RX_CHAIN_DRIVER_FORCE_MSK \ 1059 (0x1 << PHY_RX_CHAIN_DRIVER_FORCE_POS) 1060 #define PHY_RX_CHAIN_VALID_POS (1) 1061 #define PHY_RX_CHAIN_VALID_MSK \ 1062 (0x7 << PHY_RX_CHAIN_VALID_POS) 1063 #define PHY_RX_CHAIN_FORCE_SEL_POS (4) 1064 #define PHY_RX_CHAIN_FORCE_SEL_MSK \ 1065 (0x7 << PHY_RX_CHAIN_FORCE_SEL_POS) 1066 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_POS (7) 1067 #define PHY_RX_CHAIN_FORCE_MIMO_SEL_MSK \ 1068 (0x7 << PHY_RX_CHAIN_FORCE_MIMO_SEL_POS) 1069 #define PHY_RX_CHAIN_CNT_POS (10) 1070 #define PHY_RX_CHAIN_CNT_MSK \ 1071 (0x3 << PHY_RX_CHAIN_CNT_POS) 1072 #define PHY_RX_CHAIN_MIMO_CNT_POS (12) 1073 #define PHY_RX_CHAIN_MIMO_CNT_MSK \ 1074 (0x3 << PHY_RX_CHAIN_MIMO_CNT_POS) 1075 #define PHY_RX_CHAIN_MIMO_FORCE_POS (14) 1076 #define PHY_RX_CHAIN_MIMO_FORCE_MSK \ 1077 (0x1 << PHY_RX_CHAIN_MIMO_FORCE_POS) 1078 1079 /* TODO: fix the value, make it depend on firmware at runtime? */ 1080 #define NUM_PHY_CTX 3 1081 1082 /* TODO: complete missing documentation */ 1083 /** 1084 * struct iwl_phy_context_cmd - config of the PHY context 1085 * ( PHY_CONTEXT_CMD = 0x8 ) 1086 * @id_and_color: ID and color of the relevant Binding 1087 * @action: action to perform, one of FW_CTXT_ACTION_* 1088 * @apply_time: 0 means immediate apply and context switch. 1089 * other value means apply new params after X usecs 1090 * @tx_param_color: ??? 1091 * @channel_info: 1092 * @txchain_info: ??? 1093 * @rxchain_info: ??? 1094 * @acquisition_data: ??? 1095 * @dsp_cfg_flags: set to 0 1096 */ 1097 struct iwl_phy_context_cmd { 1098 /* COMMON_INDEX_HDR_API_S_VER_1 */ 1099 __le32 id_and_color; 1100 __le32 action; 1101 /* PHY_CONTEXT_DATA_API_S_VER_1 */ 1102 __le32 apply_time; 1103 __le32 tx_param_color; 1104 struct iwl_fw_channel_info ci; 1105 __le32 txchain_info; 1106 __le32 rxchain_info; 1107 __le32 acquisition_data; 1108 __le32 dsp_cfg_flags; 1109 } __packed; /* PHY_CONTEXT_CMD_API_VER_1 */ 1110 1111 /* 1112 * Aux ROC command 1113 * 1114 * Command requests the firmware to create a time event for a certain duration 1115 * and remain on the given channel. This is done by using the Aux framework in 1116 * the FW. 1117 * The command was first used for Hot Spot issues - but can be used regardless 1118 * to Hot Spot. 1119 * 1120 * ( HOT_SPOT_CMD 0x53 ) 1121 * 1122 * @id_and_color: ID and color of the MAC 1123 * @action: action to perform, one of FW_CTXT_ACTION_* 1124 * @event_unique_id: If the action FW_CTXT_ACTION_REMOVE then the 1125 * event_unique_id should be the id of the time event assigned by ucode. 1126 * Otherwise ignore the event_unique_id. 1127 * @sta_id_and_color: station id and color, resumed during "Remain On Channel" 1128 * activity. 1129 * @channel_info: channel info 1130 * @node_addr: Our MAC Address 1131 * @reserved: reserved for alignment 1132 * @apply_time: GP2 value to start (should always be the current GP2 value) 1133 * @apply_time_max_delay: Maximum apply time delay value in TU. Defines max 1134 * time by which start of the event is allowed to be postponed. 1135 * @duration: event duration in TU To calculate event duration: 1136 * timeEventDuration = min(duration, remainingQuota) 1137 */ 1138 struct iwl_hs20_roc_req { 1139 /* COMMON_INDEX_HDR_API_S_VER_1 hdr */ 1140 __le32 id_and_color; 1141 __le32 action; 1142 __le32 event_unique_id; 1143 __le32 sta_id_and_color; 1144 struct iwl_fw_channel_info channel_info; 1145 u8 node_addr[ETH_ALEN]; 1146 __le16 reserved; 1147 __le32 apply_time; 1148 __le32 apply_time_max_delay; 1149 __le32 duration; 1150 } __packed; /* HOT_SPOT_CMD_API_S_VER_1 */ 1151 1152 /* 1153 * values for AUX ROC result values 1154 */ 1155 enum iwl_mvm_hot_spot { 1156 HOT_SPOT_RSP_STATUS_OK, 1157 HOT_SPOT_RSP_STATUS_TOO_MANY_EVENTS, 1158 HOT_SPOT_MAX_NUM_OF_SESSIONS, 1159 }; 1160 1161 /* 1162 * Aux ROC command response 1163 * 1164 * In response to iwl_hs20_roc_req the FW sends this command to notify the 1165 * driver the uid of the timevent. 1166 * 1167 * ( HOT_SPOT_CMD 0x53 ) 1168 * 1169 * @event_unique_id: Unique ID of time event assigned by ucode 1170 * @status: Return status 0 is success, all the rest used for specific errors 1171 */ 1172 struct iwl_hs20_roc_res { 1173 __le32 event_unique_id; 1174 __le32 status; 1175 } __packed; /* HOT_SPOT_RSP_API_S_VER_1 */ 1176 1177 /** 1178 * struct iwl_radio_version_notif - information on the radio version 1179 * ( RADIO_VERSION_NOTIFICATION = 0x68 ) 1180 * @radio_flavor: 1181 * @radio_step: 1182 * @radio_dash: 1183 */ 1184 struct iwl_radio_version_notif { 1185 __le32 radio_flavor; 1186 __le32 radio_step; 1187 __le32 radio_dash; 1188 } __packed; /* RADIO_VERSION_NOTOFICATION_S_VER_1 */ 1189 1190 enum iwl_card_state_flags { 1191 CARD_ENABLED = 0x00, 1192 HW_CARD_DISABLED = 0x01, 1193 SW_CARD_DISABLED = 0x02, 1194 CT_KILL_CARD_DISABLED = 0x04, 1195 HALT_CARD_DISABLED = 0x08, 1196 CARD_DISABLED_MSK = 0x0f, 1197 CARD_IS_RX_ON = 0x10, 1198 }; 1199 1200 /** 1201 * struct iwl_radio_version_notif - information on the radio version 1202 * ( CARD_STATE_NOTIFICATION = 0xa1 ) 1203 * @flags: %iwl_card_state_flags 1204 */ 1205 struct iwl_card_state_notif { 1206 __le32 flags; 1207 } __packed; /* CARD_STATE_NTFY_API_S_VER_1 */ 1208 1209 /** 1210 * struct iwl_missed_beacons_notif - information on missed beacons 1211 * ( MISSED_BEACONS_NOTIFICATION = 0xa2 ) 1212 * @mac_id: interface ID 1213 * @consec_missed_beacons_since_last_rx: number of consecutive missed 1214 * beacons since last RX. 1215 * @consec_missed_beacons: number of consecutive missed beacons 1216 * @num_expected_beacons: 1217 * @num_recvd_beacons: 1218 */ 1219 struct iwl_missed_beacons_notif { 1220 __le32 mac_id; 1221 __le32 consec_missed_beacons_since_last_rx; 1222 __le32 consec_missed_beacons; 1223 __le32 num_expected_beacons; 1224 __le32 num_recvd_beacons; 1225 } __packed; /* MISSED_BEACON_NTFY_API_S_VER_3 */ 1226 1227 /** 1228 * struct iwl_mfuart_load_notif - mfuart image version & status 1229 * ( MFUART_LOAD_NOTIFICATION = 0xb1 ) 1230 * @installed_ver: installed image version 1231 * @external_ver: external image version 1232 * @status: MFUART loading status 1233 * @duration: MFUART loading time 1234 */ 1235 struct iwl_mfuart_load_notif { 1236 __le32 installed_ver; 1237 __le32 external_ver; 1238 __le32 status; 1239 __le32 duration; 1240 } __packed; /*MFU_LOADER_NTFY_API_S_VER_1*/ 1241 1242 /** 1243 * struct iwl_set_calib_default_cmd - set default value for calibration. 1244 * ( SET_CALIB_DEFAULT_CMD = 0x8e ) 1245 * @calib_index: the calibration to set value for 1246 * @length: of data 1247 * @data: the value to set for the calibration result 1248 */ 1249 struct iwl_set_calib_default_cmd { 1250 __le16 calib_index; 1251 __le16 length; 1252 u8 data[0]; 1253 } __packed; /* PHY_CALIB_OVERRIDE_VALUES_S */ 1254 1255 #define MAX_PORT_ID_NUM 2 1256 #define MAX_MCAST_FILTERING_ADDRESSES 256 1257 1258 /** 1259 * struct iwl_mcast_filter_cmd - configure multicast filter. 1260 * @filter_own: Set 1 to filter out multicast packets sent by station itself 1261 * @port_id: Multicast MAC addresses array specifier. This is a strange way 1262 * to identify network interface adopted in host-device IF. 1263 * It is used by FW as index in array of addresses. This array has 1264 * MAX_PORT_ID_NUM members. 1265 * @count: Number of MAC addresses in the array 1266 * @pass_all: Set 1 to pass all multicast packets. 1267 * @bssid: current association BSSID. 1268 * @addr_list: Place holder for array of MAC addresses. 1269 * IMPORTANT: add padding if necessary to ensure DWORD alignment. 1270 */ 1271 struct iwl_mcast_filter_cmd { 1272 u8 filter_own; 1273 u8 port_id; 1274 u8 count; 1275 u8 pass_all; 1276 u8 bssid[6]; 1277 u8 reserved[2]; 1278 u8 addr_list[0]; 1279 } __packed; /* MCAST_FILTERING_CMD_API_S_VER_1 */ 1280 1281 #define MAX_BCAST_FILTERS 8 1282 #define MAX_BCAST_FILTER_ATTRS 2 1283 1284 /** 1285 * enum iwl_mvm_bcast_filter_attr_offset - written by fw for each Rx packet 1286 * @BCAST_FILTER_OFFSET_PAYLOAD_START: offset is from payload start. 1287 * @BCAST_FILTER_OFFSET_IP_END: offset is from ip header end (i.e. 1288 * start of ip payload). 1289 */ 1290 enum iwl_mvm_bcast_filter_attr_offset { 1291 BCAST_FILTER_OFFSET_PAYLOAD_START = 0, 1292 BCAST_FILTER_OFFSET_IP_END = 1, 1293 }; 1294 1295 /** 1296 * struct iwl_fw_bcast_filter_attr - broadcast filter attribute 1297 * @offset_type: &enum iwl_mvm_bcast_filter_attr_offset. 1298 * @offset: starting offset of this pattern. 1299 * @val: value to match - big endian (MSB is the first 1300 * byte to match from offset pos). 1301 * @mask: mask to match (big endian). 1302 */ 1303 struct iwl_fw_bcast_filter_attr { 1304 u8 offset_type; 1305 u8 offset; 1306 __le16 reserved1; 1307 __be32 val; 1308 __be32 mask; 1309 } __packed; /* BCAST_FILTER_ATT_S_VER_1 */ 1310 1311 /** 1312 * enum iwl_mvm_bcast_filter_frame_type - filter frame type 1313 * @BCAST_FILTER_FRAME_TYPE_ALL: consider all frames. 1314 * @BCAST_FILTER_FRAME_TYPE_IPV4: consider only ipv4 frames 1315 */ 1316 enum iwl_mvm_bcast_filter_frame_type { 1317 BCAST_FILTER_FRAME_TYPE_ALL = 0, 1318 BCAST_FILTER_FRAME_TYPE_IPV4 = 1, 1319 }; 1320 1321 /** 1322 * struct iwl_fw_bcast_filter - broadcast filter 1323 * @discard: discard frame (1) or let it pass (0). 1324 * @frame_type: &enum iwl_mvm_bcast_filter_frame_type. 1325 * @num_attrs: number of valid attributes in this filter. 1326 * @attrs: attributes of this filter. a filter is considered matched 1327 * only when all its attributes are matched (i.e. AND relationship) 1328 */ 1329 struct iwl_fw_bcast_filter { 1330 u8 discard; 1331 u8 frame_type; 1332 u8 num_attrs; 1333 u8 reserved1; 1334 struct iwl_fw_bcast_filter_attr attrs[MAX_BCAST_FILTER_ATTRS]; 1335 } __packed; /* BCAST_FILTER_S_VER_1 */ 1336 1337 #define BA_WINDOW_STREAMS_MAX 16 1338 #define BA_WINDOW_STATUS_TID_MSK 0x000F 1339 #define BA_WINDOW_STATUS_STA_ID_POS 4 1340 #define BA_WINDOW_STATUS_STA_ID_MSK 0x01F0 1341 #define BA_WINDOW_STATUS_VALID_MSK BIT(9) 1342 1343 /** 1344 * struct iwl_ba_window_status_notif - reordering window's status notification 1345 * @bitmap: bitmap of received frames [start_seq_num + 0]..[start_seq_num + 63] 1346 * @ra_tid: bit 3:0 - TID, bit 8:4 - STA_ID, bit 9 - valid 1347 * @start_seq_num: the start sequence number of the bitmap 1348 * @mpdu_rx_count: the number of received MPDUs since entering D0i3 1349 */ 1350 struct iwl_ba_window_status_notif { 1351 __le64 bitmap[BA_WINDOW_STREAMS_MAX]; 1352 __le16 ra_tid[BA_WINDOW_STREAMS_MAX]; 1353 __le32 start_seq_num[BA_WINDOW_STREAMS_MAX]; 1354 __le16 mpdu_rx_count[BA_WINDOW_STREAMS_MAX]; 1355 } __packed; /* BA_WINDOW_STATUS_NTFY_API_S_VER_1 */ 1356 1357 /** 1358 * struct iwl_fw_bcast_mac - per-mac broadcast filtering configuration. 1359 * @default_discard: default action for this mac (discard (1) / pass (0)). 1360 * @attached_filters: bitmap of relevant filters for this mac. 1361 */ 1362 struct iwl_fw_bcast_mac { 1363 u8 default_discard; 1364 u8 reserved1; 1365 __le16 attached_filters; 1366 } __packed; /* BCAST_MAC_CONTEXT_S_VER_1 */ 1367 1368 /** 1369 * struct iwl_bcast_filter_cmd - broadcast filtering configuration 1370 * @disable: enable (0) / disable (1) 1371 * @max_bcast_filters: max number of filters (MAX_BCAST_FILTERS) 1372 * @max_macs: max number of macs (NUM_MAC_INDEX_DRIVER) 1373 * @filters: broadcast filters 1374 * @macs: broadcast filtering configuration per-mac 1375 */ 1376 struct iwl_bcast_filter_cmd { 1377 u8 disable; 1378 u8 max_bcast_filters; 1379 u8 max_macs; 1380 u8 reserved1; 1381 struct iwl_fw_bcast_filter filters[MAX_BCAST_FILTERS]; 1382 struct iwl_fw_bcast_mac macs[NUM_MAC_INDEX_DRIVER]; 1383 } __packed; /* BCAST_FILTERING_HCMD_API_S_VER_1 */ 1384 1385 /* 1386 * enum iwl_mvm_marker_id - maker ids 1387 * 1388 * The ids for different type of markers to insert into the usniffer logs 1389 */ 1390 enum iwl_mvm_marker_id { 1391 MARKER_ID_TX_FRAME_LATENCY = 1, 1392 }; /* MARKER_ID_API_E_VER_1 */ 1393 1394 /** 1395 * struct iwl_mvm_marker - mark info into the usniffer logs 1396 * 1397 * (MARKER_CMD = 0xcb) 1398 * 1399 * Mark the UTC time stamp into the usniffer logs together with additional 1400 * metadata, so the usniffer output can be parsed. 1401 * In the command response the ucode will return the GP2 time. 1402 * 1403 * @dw_len: The amount of dwords following this byte including this byte. 1404 * @marker_id: A unique marker id (iwl_mvm_marker_id). 1405 * @reserved: reserved. 1406 * @timestamp: in milliseconds since 1970-01-01 00:00:00 UTC 1407 * @metadata: additional meta data that will be written to the unsiffer log 1408 */ 1409 struct iwl_mvm_marker { 1410 u8 dwLen; 1411 u8 markerId; 1412 __le16 reserved; 1413 __le64 timestamp; 1414 __le32 metadata[0]; 1415 } __packed; /* MARKER_API_S_VER_1 */ 1416 1417 /* 1418 * enum iwl_dc2dc_config_id - flag ids 1419 * 1420 * Ids of dc2dc configuration flags 1421 */ 1422 enum iwl_dc2dc_config_id { 1423 DCDC_LOW_POWER_MODE_MSK_SET = 0x1, /* not used */ 1424 DCDC_FREQ_TUNE_SET = 0x2, 1425 }; /* MARKER_ID_API_E_VER_1 */ 1426 1427 /** 1428 * struct iwl_dc2dc_config_cmd - configure dc2dc values 1429 * 1430 * (DC2DC_CONFIG_CMD = 0x83) 1431 * 1432 * Set/Get & configure dc2dc values. 1433 * The command always returns the current dc2dc values. 1434 * 1435 * @flags: set/get dc2dc 1436 * @enable_low_power_mode: not used. 1437 * @dc2dc_freq_tune0: frequency divider - digital domain 1438 * @dc2dc_freq_tune1: frequency divider - analog domain 1439 */ 1440 struct iwl_dc2dc_config_cmd { 1441 __le32 flags; 1442 __le32 enable_low_power_mode; /* not used */ 1443 __le32 dc2dc_freq_tune0; 1444 __le32 dc2dc_freq_tune1; 1445 } __packed; /* DC2DC_CONFIG_CMD_API_S_VER_1 */ 1446 1447 /** 1448 * struct iwl_dc2dc_config_resp - response for iwl_dc2dc_config_cmd 1449 * 1450 * Current dc2dc values returned by the FW. 1451 * 1452 * @dc2dc_freq_tune0: frequency divider - digital domain 1453 * @dc2dc_freq_tune1: frequency divider - analog domain 1454 */ 1455 struct iwl_dc2dc_config_resp { 1456 __le32 dc2dc_freq_tune0; 1457 __le32 dc2dc_freq_tune1; 1458 } __packed; /* DC2DC_CONFIG_RESP_API_S_VER_1 */ 1459 1460 /*********************************** 1461 * Smart Fifo API 1462 ***********************************/ 1463 /* Smart Fifo state */ 1464 enum iwl_sf_state { 1465 SF_LONG_DELAY_ON = 0, /* should never be called by driver */ 1466 SF_FULL_ON, 1467 SF_UNINIT, 1468 SF_INIT_OFF, 1469 SF_HW_NUM_STATES 1470 }; 1471 1472 /* Smart Fifo possible scenario */ 1473 enum iwl_sf_scenario { 1474 SF_SCENARIO_SINGLE_UNICAST, 1475 SF_SCENARIO_AGG_UNICAST, 1476 SF_SCENARIO_MULTICAST, 1477 SF_SCENARIO_BA_RESP, 1478 SF_SCENARIO_TX_RESP, 1479 SF_NUM_SCENARIO 1480 }; 1481 1482 #define SF_TRANSIENT_STATES_NUMBER 2 /* SF_LONG_DELAY_ON and SF_FULL_ON */ 1483 #define SF_NUM_TIMEOUT_TYPES 2 /* Aging timer and Idle timer */ 1484 1485 /* smart FIFO default values */ 1486 #define SF_W_MARK_SISO 6144 1487 #define SF_W_MARK_MIMO2 8192 1488 #define SF_W_MARK_MIMO3 6144 1489 #define SF_W_MARK_LEGACY 4096 1490 #define SF_W_MARK_SCAN 4096 1491 1492 /* SF Scenarios timers for default configuration (aligned to 32 uSec) */ 1493 #define SF_SINGLE_UNICAST_IDLE_TIMER_DEF 160 /* 150 uSec */ 1494 #define SF_SINGLE_UNICAST_AGING_TIMER_DEF 400 /* 0.4 mSec */ 1495 #define SF_AGG_UNICAST_IDLE_TIMER_DEF 160 /* 150 uSec */ 1496 #define SF_AGG_UNICAST_AGING_TIMER_DEF 400 /* 0.4 mSec */ 1497 #define SF_MCAST_IDLE_TIMER_DEF 160 /* 150 mSec */ 1498 #define SF_MCAST_AGING_TIMER_DEF 400 /* 0.4 mSec */ 1499 #define SF_BA_IDLE_TIMER_DEF 160 /* 150 uSec */ 1500 #define SF_BA_AGING_TIMER_DEF 400 /* 0.4 mSec */ 1501 #define SF_TX_RE_IDLE_TIMER_DEF 160 /* 150 uSec */ 1502 #define SF_TX_RE_AGING_TIMER_DEF 400 /* 0.4 mSec */ 1503 1504 /* SF Scenarios timers for BSS MAC configuration (aligned to 32 uSec) */ 1505 #define SF_SINGLE_UNICAST_IDLE_TIMER 320 /* 300 uSec */ 1506 #define SF_SINGLE_UNICAST_AGING_TIMER 2016 /* 2 mSec */ 1507 #define SF_AGG_UNICAST_IDLE_TIMER 320 /* 300 uSec */ 1508 #define SF_AGG_UNICAST_AGING_TIMER 2016 /* 2 mSec */ 1509 #define SF_MCAST_IDLE_TIMER 2016 /* 2 mSec */ 1510 #define SF_MCAST_AGING_TIMER 10016 /* 10 mSec */ 1511 #define SF_BA_IDLE_TIMER 320 /* 300 uSec */ 1512 #define SF_BA_AGING_TIMER 2016 /* 2 mSec */ 1513 #define SF_TX_RE_IDLE_TIMER 320 /* 300 uSec */ 1514 #define SF_TX_RE_AGING_TIMER 2016 /* 2 mSec */ 1515 1516 #define SF_LONG_DELAY_AGING_TIMER 1000000 /* 1 Sec */ 1517 1518 #define SF_CFG_DUMMY_NOTIF_OFF BIT(16) 1519 1520 /** 1521 * Smart Fifo configuration command. 1522 * @state: smart fifo state, types listed in enum %iwl_sf_sate. 1523 * @watermark: Minimum allowed availabe free space in RXF for transient state. 1524 * @long_delay_timeouts: aging and idle timer values for each scenario 1525 * in long delay state. 1526 * @full_on_timeouts: timer values for each scenario in full on state. 1527 */ 1528 struct iwl_sf_cfg_cmd { 1529 __le32 state; 1530 __le32 watermark[SF_TRANSIENT_STATES_NUMBER]; 1531 __le32 long_delay_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES]; 1532 __le32 full_on_timeouts[SF_NUM_SCENARIO][SF_NUM_TIMEOUT_TYPES]; 1533 } __packed; /* SF_CFG_API_S_VER_2 */ 1534 1535 /*********************************** 1536 * Location Aware Regulatory (LAR) API - MCC updates 1537 ***********************************/ 1538 1539 /** 1540 * struct iwl_mcc_update_cmd_v1 - Request the device to update geographic 1541 * regulatory profile according to the given MCC (Mobile Country Code). 1542 * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain. 1543 * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the 1544 * MCC in the cmd response will be the relevant MCC in the NVM. 1545 * @mcc: given mobile country code 1546 * @source_id: the source from where we got the MCC, see iwl_mcc_source 1547 * @reserved: reserved for alignment 1548 */ 1549 struct iwl_mcc_update_cmd_v1 { 1550 __le16 mcc; 1551 u8 source_id; 1552 u8 reserved; 1553 } __packed; /* LAR_UPDATE_MCC_CMD_API_S_VER_1 */ 1554 1555 /** 1556 * struct iwl_mcc_update_cmd - Request the device to update geographic 1557 * regulatory profile according to the given MCC (Mobile Country Code). 1558 * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain. 1559 * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the 1560 * MCC in the cmd response will be the relevant MCC in the NVM. 1561 * @mcc: given mobile country code 1562 * @source_id: the source from where we got the MCC, see iwl_mcc_source 1563 * @reserved: reserved for alignment 1564 * @key: integrity key for MCC API OEM testing 1565 * @reserved2: reserved 1566 */ 1567 struct iwl_mcc_update_cmd { 1568 __le16 mcc; 1569 u8 source_id; 1570 u8 reserved; 1571 __le32 key; 1572 __le32 reserved2[5]; 1573 } __packed; /* LAR_UPDATE_MCC_CMD_API_S_VER_2 */ 1574 1575 /** 1576 * iwl_mcc_update_resp_v1 - response to MCC_UPDATE_CMD. 1577 * Contains the new channel control profile map, if changed, and the new MCC 1578 * (mobile country code). 1579 * The new MCC may be different than what was requested in MCC_UPDATE_CMD. 1580 * @status: see &enum iwl_mcc_update_status 1581 * @mcc: the new applied MCC 1582 * @cap: capabilities for all channels which matches the MCC 1583 * @source_id: the MCC source, see iwl_mcc_source 1584 * @n_channels: number of channels in @channels_data (may be 14, 39, 50 or 51 1585 * channels, depending on platform) 1586 * @channels: channel control data map, DWORD for each channel. Only the first 1587 * 16bits are used. 1588 */ 1589 struct iwl_mcc_update_resp_v1 { 1590 __le32 status; 1591 __le16 mcc; 1592 u8 cap; 1593 u8 source_id; 1594 __le32 n_channels; 1595 __le32 channels[0]; 1596 } __packed; /* LAR_UPDATE_MCC_CMD_RESP_S_VER_1 */ 1597 1598 /** 1599 * iwl_mcc_update_resp - response to MCC_UPDATE_CMD. 1600 * Contains the new channel control profile map, if changed, and the new MCC 1601 * (mobile country code). 1602 * The new MCC may be different than what was requested in MCC_UPDATE_CMD. 1603 * @status: see &enum iwl_mcc_update_status 1604 * @mcc: the new applied MCC 1605 * @cap: capabilities for all channels which matches the MCC 1606 * @source_id: the MCC source, see iwl_mcc_source 1607 * @time: time elapsed from the MCC test start (in 30 seconds TU) 1608 * @reserved: reserved. 1609 * @n_channels: number of channels in @channels_data (may be 14, 39, 50 or 51 1610 * channels, depending on platform) 1611 * @channels: channel control data map, DWORD for each channel. Only the first 1612 * 16bits are used. 1613 */ 1614 struct iwl_mcc_update_resp { 1615 __le32 status; 1616 __le16 mcc; 1617 u8 cap; 1618 u8 source_id; 1619 __le16 time; 1620 __le16 reserved; 1621 __le32 n_channels; 1622 __le32 channels[0]; 1623 } __packed; /* LAR_UPDATE_MCC_CMD_RESP_S_VER_2 */ 1624 1625 /** 1626 * struct iwl_mcc_chub_notif - chub notifies of mcc change 1627 * (MCC_CHUB_UPDATE_CMD = 0xc9) 1628 * The Chub (Communication Hub, CommsHUB) is a HW component that connects to 1629 * the cellular and connectivity cores that gets updates of the mcc, and 1630 * notifies the ucode directly of any mcc change. 1631 * The ucode requests the driver to request the device to update geographic 1632 * regulatory profile according to the given MCC (Mobile Country Code). 1633 * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain. 1634 * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the 1635 * MCC in the cmd response will be the relevant MCC in the NVM. 1636 * @mcc: given mobile country code 1637 * @source_id: identity of the change originator, see iwl_mcc_source 1638 * @reserved1: reserved for alignment 1639 */ 1640 struct iwl_mcc_chub_notif { 1641 u16 mcc; 1642 u8 source_id; 1643 u8 reserved1; 1644 } __packed; /* LAR_MCC_NOTIFY_S */ 1645 1646 enum iwl_mcc_update_status { 1647 MCC_RESP_NEW_CHAN_PROFILE, 1648 MCC_RESP_SAME_CHAN_PROFILE, 1649 MCC_RESP_INVALID, 1650 MCC_RESP_NVM_DISABLED, 1651 MCC_RESP_ILLEGAL, 1652 MCC_RESP_LOW_PRIORITY, 1653 MCC_RESP_TEST_MODE_ACTIVE, 1654 MCC_RESP_TEST_MODE_NOT_ACTIVE, 1655 MCC_RESP_TEST_MODE_DENIAL_OF_SERVICE, 1656 }; 1657 1658 enum iwl_mcc_source { 1659 MCC_SOURCE_OLD_FW = 0, 1660 MCC_SOURCE_ME = 1, 1661 MCC_SOURCE_BIOS = 2, 1662 MCC_SOURCE_3G_LTE_HOST = 3, 1663 MCC_SOURCE_3G_LTE_DEVICE = 4, 1664 MCC_SOURCE_WIFI = 5, 1665 MCC_SOURCE_RESERVED = 6, 1666 MCC_SOURCE_DEFAULT = 7, 1667 MCC_SOURCE_UNINITIALIZED = 8, 1668 MCC_SOURCE_MCC_API = 9, 1669 MCC_SOURCE_GET_CURRENT = 0x10, 1670 MCC_SOURCE_GETTING_MCC_TEST_MODE = 0x11, 1671 }; 1672 1673 /* DTS measurements */ 1674 1675 enum iwl_dts_measurement_flags { 1676 DTS_TRIGGER_CMD_FLAGS_TEMP = BIT(0), 1677 DTS_TRIGGER_CMD_FLAGS_VOLT = BIT(1), 1678 }; 1679 1680 /** 1681 * iwl_dts_measurement_cmd - request DTS temperature and/or voltage measurements 1682 * 1683 * @flags: indicates which measurements we want as specified in &enum 1684 * iwl_dts_measurement_flags 1685 */ 1686 struct iwl_dts_measurement_cmd { 1687 __le32 flags; 1688 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_CMD_S */ 1689 1690 /** 1691 * enum iwl_dts_control_measurement_mode - DTS measurement type 1692 * @DTS_AUTOMATIC: Automatic mode (full SW control). Provide temperature read 1693 * back (latest value. Not waiting for new value). Use automatic 1694 * SW DTS configuration. 1695 * @DTS_REQUEST_READ: Request DTS read. Configure DTS with manual settings, 1696 * trigger DTS reading and provide read back temperature read 1697 * when available. 1698 * @DTS_OVER_WRITE: over-write the DTS temperatures in the SW until next read 1699 * @DTS_DIRECT_WITHOUT_MEASURE: DTS returns its latest temperature result, 1700 * without measurement trigger. 1701 */ 1702 enum iwl_dts_control_measurement_mode { 1703 DTS_AUTOMATIC = 0, 1704 DTS_REQUEST_READ = 1, 1705 DTS_OVER_WRITE = 2, 1706 DTS_DIRECT_WITHOUT_MEASURE = 3, 1707 }; 1708 1709 /** 1710 * enum iwl_dts_used - DTS to use or used for measurement in the DTS request 1711 * @DTS_USE_TOP: Top 1712 * @DTS_USE_CHAIN_A: chain A 1713 * @DTS_USE_CHAIN_B: chain B 1714 * @DTS_USE_CHAIN_C: chain C 1715 * @XTAL_TEMPERATURE - read temperature from xtal 1716 */ 1717 enum iwl_dts_used { 1718 DTS_USE_TOP = 0, 1719 DTS_USE_CHAIN_A = 1, 1720 DTS_USE_CHAIN_B = 2, 1721 DTS_USE_CHAIN_C = 3, 1722 XTAL_TEMPERATURE = 4, 1723 }; 1724 1725 /** 1726 * enum iwl_dts_bit_mode - bit-mode to use in DTS request read mode 1727 * @DTS_BIT6_MODE: bit 6 mode 1728 * @DTS_BIT8_MODE: bit 8 mode 1729 */ 1730 enum iwl_dts_bit_mode { 1731 DTS_BIT6_MODE = 0, 1732 DTS_BIT8_MODE = 1, 1733 }; 1734 1735 /** 1736 * iwl_ext_dts_measurement_cmd - request extended DTS temperature measurements 1737 * @control_mode: see &enum iwl_dts_control_measurement_mode 1738 * @temperature: used when over write DTS mode is selected 1739 * @sensor: set temperature sensor to use. See &enum iwl_dts_used 1740 * @avg_factor: average factor to DTS in request DTS read mode 1741 * @bit_mode: value defines the DTS bit mode to use. See &enum iwl_dts_bit_mode 1742 * @step_duration: step duration for the DTS 1743 */ 1744 struct iwl_ext_dts_measurement_cmd { 1745 __le32 control_mode; 1746 __le32 temperature; 1747 __le32 sensor; 1748 __le32 avg_factor; 1749 __le32 bit_mode; 1750 __le32 step_duration; 1751 } __packed; /* XVT_FW_DTS_CONTROL_MEASUREMENT_REQUEST_API_S */ 1752 1753 /** 1754 * struct iwl_dts_measurement_notif_v1 - measurements notification 1755 * 1756 * @temp: the measured temperature 1757 * @voltage: the measured voltage 1758 */ 1759 struct iwl_dts_measurement_notif_v1 { 1760 __le32 temp; 1761 __le32 voltage; 1762 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_NTFY_S_VER_1*/ 1763 1764 /** 1765 * struct iwl_dts_measurement_notif_v2 - measurements notification 1766 * 1767 * @temp: the measured temperature 1768 * @voltage: the measured voltage 1769 * @threshold_idx: the trip index that was crossed 1770 */ 1771 struct iwl_dts_measurement_notif_v2 { 1772 __le32 temp; 1773 __le32 voltage; 1774 __le32 threshold_idx; 1775 } __packed; /* TEMPERATURE_MEASUREMENT_TRIGGER_NTFY_S_VER_2 */ 1776 1777 /** 1778 * struct ct_kill_notif - CT-kill entry notification 1779 * 1780 * @temperature: the current temperature in celsius 1781 * @reserved: reserved 1782 */ 1783 struct ct_kill_notif { 1784 __le16 temperature; 1785 __le16 reserved; 1786 } __packed; /* GRP_PHY_CT_KILL_NTF */ 1787 1788 /** 1789 * enum ctdp_cmd_operation - CTDP command operations 1790 * @CTDP_CMD_OPERATION_START: update the current budget 1791 * @CTDP_CMD_OPERATION_STOP: stop ctdp 1792 * @CTDP_CMD_OPERATION_REPORT: get the avgerage budget 1793 */ 1794 enum iwl_mvm_ctdp_cmd_operation { 1795 CTDP_CMD_OPERATION_START = 0x1, 1796 CTDP_CMD_OPERATION_STOP = 0x2, 1797 CTDP_CMD_OPERATION_REPORT = 0x4, 1798 };/* CTDP_CMD_OPERATION_TYPE_E */ 1799 1800 /** 1801 * struct iwl_mvm_ctdp_cmd - track and manage the FW power consumption budget 1802 * 1803 * @operation: see &enum iwl_mvm_ctdp_cmd_operation 1804 * @budget: the budget in milliwatt 1805 * @window_size: defined in API but not used 1806 */ 1807 struct iwl_mvm_ctdp_cmd { 1808 __le32 operation; 1809 __le32 budget; 1810 __le32 window_size; 1811 } __packed; 1812 1813 #define IWL_MAX_DTS_TRIPS 8 1814 1815 /** 1816 * struct iwl_temp_report_ths_cmd - set temperature thresholds 1817 * 1818 * @num_temps: number of temperature thresholds passed 1819 * @thresholds: array with the thresholds to be configured 1820 */ 1821 struct temp_report_ths_cmd { 1822 __le32 num_temps; 1823 __le16 thresholds[IWL_MAX_DTS_TRIPS]; 1824 } __packed; /* GRP_PHY_TEMP_REPORTING_THRESHOLDS_CMD */ 1825 1826 /*********************************** 1827 * TDLS API 1828 ***********************************/ 1829 1830 /* Type of TDLS request */ 1831 enum iwl_tdls_channel_switch_type { 1832 TDLS_SEND_CHAN_SW_REQ = 0, 1833 TDLS_SEND_CHAN_SW_RESP_AND_MOVE_CH, 1834 TDLS_MOVE_CH, 1835 }; /* TDLS_STA_CHANNEL_SWITCH_CMD_TYPE_API_E_VER_1 */ 1836 1837 /** 1838 * Switch timing sub-element in a TDLS channel-switch command 1839 * @frame_timestamp: GP2 timestamp of channel-switch request/response packet 1840 * received from peer 1841 * @max_offchan_duration: What amount of microseconds out of a DTIM is given 1842 * to the TDLS off-channel communication. For instance if the DTIM is 1843 * 200TU and the TDLS peer is to be given 25% of the time, the value 1844 * given will be 50TU, or 50 * 1024 if translated into microseconds. 1845 * @switch_time: switch time the peer sent in its channel switch timing IE 1846 * @switch_timout: switch timeout the peer sent in its channel switch timing IE 1847 */ 1848 struct iwl_tdls_channel_switch_timing { 1849 __le32 frame_timestamp; /* GP2 time of peer packet Rx */ 1850 __le32 max_offchan_duration; /* given in micro-seconds */ 1851 __le32 switch_time; /* given in micro-seconds */ 1852 __le32 switch_timeout; /* given in micro-seconds */ 1853 } __packed; /* TDLS_STA_CHANNEL_SWITCH_TIMING_DATA_API_S_VER_1 */ 1854 1855 #define IWL_TDLS_CH_SW_FRAME_MAX_SIZE 200 1856 1857 /** 1858 * TDLS channel switch frame template 1859 * 1860 * A template representing a TDLS channel-switch request or response frame 1861 * 1862 * @switch_time_offset: offset to the channel switch timing IE in the template 1863 * @tx_cmd: Tx parameters for the frame 1864 * @data: frame data 1865 */ 1866 struct iwl_tdls_channel_switch_frame { 1867 __le32 switch_time_offset; 1868 struct iwl_tx_cmd tx_cmd; 1869 u8 data[IWL_TDLS_CH_SW_FRAME_MAX_SIZE]; 1870 } __packed; /* TDLS_STA_CHANNEL_SWITCH_FRAME_API_S_VER_1 */ 1871 1872 /** 1873 * TDLS channel switch command 1874 * 1875 * The command is sent to initiate a channel switch and also in response to 1876 * incoming TDLS channel-switch request/response packets from remote peers. 1877 * 1878 * @switch_type: see &enum iwl_tdls_channel_switch_type 1879 * @peer_sta_id: station id of TDLS peer 1880 * @ci: channel we switch to 1881 * @timing: timing related data for command 1882 * @frame: channel-switch request/response template, depending to switch_type 1883 */ 1884 struct iwl_tdls_channel_switch_cmd { 1885 u8 switch_type; 1886 __le32 peer_sta_id; 1887 struct iwl_fw_channel_info ci; 1888 struct iwl_tdls_channel_switch_timing timing; 1889 struct iwl_tdls_channel_switch_frame frame; 1890 } __packed; /* TDLS_STA_CHANNEL_SWITCH_CMD_API_S_VER_1 */ 1891 1892 /** 1893 * TDLS channel switch start notification 1894 * 1895 * @status: non-zero on success 1896 * @offchannel_duration: duration given in microseconds 1897 * @sta_id: peer currently performing the channel-switch with 1898 */ 1899 struct iwl_tdls_channel_switch_notif { 1900 __le32 status; 1901 __le32 offchannel_duration; 1902 __le32 sta_id; 1903 } __packed; /* TDLS_STA_CHANNEL_SWITCH_NTFY_API_S_VER_1 */ 1904 1905 /** 1906 * TDLS station info 1907 * 1908 * @sta_id: station id of the TDLS peer 1909 * @tx_to_peer_tid: TID reserved vs. the peer for FW based Tx 1910 * @tx_to_peer_ssn: initial SSN the FW should use for Tx on its TID vs the peer 1911 * @is_initiator: 1 if the peer is the TDLS link initiator, 0 otherwise 1912 */ 1913 struct iwl_tdls_sta_info { 1914 u8 sta_id; 1915 u8 tx_to_peer_tid; 1916 __le16 tx_to_peer_ssn; 1917 __le32 is_initiator; 1918 } __packed; /* TDLS_STA_INFO_VER_1 */ 1919 1920 /** 1921 * TDLS basic config command 1922 * 1923 * @id_and_color: MAC id and color being configured 1924 * @tdls_peer_count: amount of currently connected TDLS peers 1925 * @tx_to_ap_tid: TID reverved vs. the AP for FW based Tx 1926 * @tx_to_ap_ssn: initial SSN the FW should use for Tx on its TID vs. the AP 1927 * @sta_info: per-station info. Only the first tdls_peer_count entries are set 1928 * @pti_req_data_offset: offset of network-level data for the PTI template 1929 * @pti_req_tx_cmd: Tx parameters for PTI request template 1930 * @pti_req_template: PTI request template data 1931 */ 1932 struct iwl_tdls_config_cmd { 1933 __le32 id_and_color; /* mac id and color */ 1934 u8 tdls_peer_count; 1935 u8 tx_to_ap_tid; 1936 __le16 tx_to_ap_ssn; 1937 struct iwl_tdls_sta_info sta_info[IWL_MVM_TDLS_STA_COUNT]; 1938 1939 __le32 pti_req_data_offset; 1940 struct iwl_tx_cmd pti_req_tx_cmd; 1941 u8 pti_req_template[0]; 1942 } __packed; /* TDLS_CONFIG_CMD_API_S_VER_1 */ 1943 1944 /** 1945 * TDLS per-station config information from FW 1946 * 1947 * @sta_id: station id of the TDLS peer 1948 * @tx_to_peer_last_seq: last sequence number used by FW during FW-based Tx to 1949 * the peer 1950 */ 1951 struct iwl_tdls_config_sta_info_res { 1952 __le16 sta_id; 1953 __le16 tx_to_peer_last_seq; 1954 } __packed; /* TDLS_STA_INFO_RSP_VER_1 */ 1955 1956 /** 1957 * TDLS config information from FW 1958 * 1959 * @tx_to_ap_last_seq: last sequence number used by FW during FW-based Tx to AP 1960 * @sta_info: per-station TDLS config information 1961 */ 1962 struct iwl_tdls_config_res { 1963 __le32 tx_to_ap_last_seq; 1964 struct iwl_tdls_config_sta_info_res sta_info[IWL_MVM_TDLS_STA_COUNT]; 1965 } __packed; /* TDLS_CONFIG_RSP_API_S_VER_1 */ 1966 1967 #define TX_FIFO_MAX_NUM 8 1968 #define RX_FIFO_MAX_NUM 2 1969 #define TX_FIFO_INTERNAL_MAX_NUM 6 1970 1971 /** 1972 * Shared memory configuration information from the FW 1973 * 1974 * @shared_mem_addr: shared memory addr (pre 8000 HW set to 0x0 as MARBH is not 1975 * accessible) 1976 * @shared_mem_size: shared memory size 1977 * @sample_buff_addr: internal sample (mon/adc) buff addr (pre 8000 HW set to 1978 * 0x0 as accessible only via DBGM RDAT) 1979 * @sample_buff_size: internal sample buff size 1980 * @txfifo_addr: start addr of TXF0 (excluding the context table 0.5KB), (pre 1981 * 8000 HW set to 0x0 as not accessible) 1982 * @txfifo_size: size of TXF0 ... TXF7 1983 * @rxfifo_size: RXF1, RXF2 sizes. If there is no RXF2, it'll have a value of 0 1984 * @page_buff_addr: used by UMAC and performance debug (page miss analysis), 1985 * when paging is not supported this should be 0 1986 * @page_buff_size: size of %page_buff_addr 1987 * @rxfifo_addr: Start address of rxFifo 1988 * @internal_txfifo_addr: start address of internalFifo 1989 * @internal_txfifo_size: internal fifos' size 1990 * 1991 * NOTE: on firmware that don't have IWL_UCODE_TLV_CAPA_EXTEND_SHARED_MEM_CFG 1992 * set, the last 3 members don't exist. 1993 */ 1994 struct iwl_shared_mem_cfg { 1995 __le32 shared_mem_addr; 1996 __le32 shared_mem_size; 1997 __le32 sample_buff_addr; 1998 __le32 sample_buff_size; 1999 __le32 txfifo_addr; 2000 __le32 txfifo_size[TX_FIFO_MAX_NUM]; 2001 __le32 rxfifo_size[RX_FIFO_MAX_NUM]; 2002 __le32 page_buff_addr; 2003 __le32 page_buff_size; 2004 __le32 rxfifo_addr; 2005 __le32 internal_txfifo_addr; 2006 __le32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM]; 2007 } __packed; /* SHARED_MEM_ALLOC_API_S_VER_2 */ 2008 2009 /** 2010 * VHT MU-MIMO group configuration 2011 * 2012 * @membership_status: a bitmap of MU groups 2013 * @user_position:the position of station in a group. If the station is in the 2014 * group then bits (group * 2) is the position -1 2015 */ 2016 struct iwl_mu_group_mgmt_cmd { 2017 __le32 reserved; 2018 __le32 membership_status[2]; 2019 __le32 user_position[4]; 2020 } __packed; /* MU_GROUP_ID_MNG_TABLE_API_S_VER_1 */ 2021 2022 /** 2023 * struct iwl_mu_group_mgmt_notif - VHT MU-MIMO group id notification 2024 * 2025 * @membership_status: a bitmap of MU groups 2026 * @user_position: the position of station in a group. If the station is in the 2027 * group then bits (group * 2) is the position -1 2028 */ 2029 struct iwl_mu_group_mgmt_notif { 2030 __le32 membership_status[2]; 2031 __le32 user_position[4]; 2032 } __packed; /* MU_GROUP_MNG_NTFY_API_S_VER_1 */ 2033 2034 #define MAX_STORED_BEACON_SIZE 600 2035 2036 /** 2037 * Stored beacon notification 2038 * 2039 * @system_time: system time on air rise 2040 * @tsf: TSF on air rise 2041 * @beacon_timestamp: beacon on air rise 2042 * @phy_flags: general phy flags: band, modulation, etc. 2043 * @channel: channel this beacon was received on 2044 * @rates: rate in ucode internal format 2045 * @byte_count: frame's byte count 2046 */ 2047 struct iwl_stored_beacon_notif { 2048 __le32 system_time; 2049 __le64 tsf; 2050 __le32 beacon_timestamp; 2051 __le16 phy_flags; 2052 __le16 channel; 2053 __le32 rates; 2054 __le32 byte_count; 2055 u8 data[MAX_STORED_BEACON_SIZE]; 2056 } __packed; /* WOWLAN_STROED_BEACON_INFO_S_VER_1 */ 2057 2058 #define LQM_NUMBER_OF_STATIONS_IN_REPORT 16 2059 2060 enum iwl_lqm_cmd_operatrions { 2061 LQM_CMD_OPERATION_START_MEASUREMENT = 0x01, 2062 LQM_CMD_OPERATION_STOP_MEASUREMENT = 0x02, 2063 }; 2064 2065 enum iwl_lqm_status { 2066 LQM_STATUS_SUCCESS = 0, 2067 LQM_STATUS_TIMEOUT = 1, 2068 LQM_STATUS_ABORT = 2, 2069 }; 2070 2071 /** 2072 * Link Quality Measurement command 2073 * @cmd_operatrion: command operation to be performed (start or stop) 2074 * as defined above. 2075 * @mac_id: MAC ID the measurement applies to. 2076 * @measurement_time: time of the total measurement to be performed, in uSec. 2077 * @timeout: maximum time allowed until a response is sent, in uSec. 2078 */ 2079 struct iwl_link_qual_msrmnt_cmd { 2080 __le32 cmd_operation; 2081 __le32 mac_id; 2082 __le32 measurement_time; 2083 __le32 timeout; 2084 } __packed /* LQM_CMD_API_S_VER_1 */; 2085 2086 /** 2087 * Link Quality Measurement notification 2088 * 2089 * @frequent_stations_air_time: an array containing the total air time 2090 * (in uSec) used by the most frequently transmitting stations. 2091 * @number_of_stations: the number of uniqe stations included in the array 2092 * (a number between 0 to 16) 2093 * @total_air_time_other_stations: the total air time (uSec) used by all the 2094 * stations which are not included in the above report. 2095 * @time_in_measurement_window: the total time in uSec in which a measurement 2096 * took place. 2097 * @tx_frame_dropped: the number of TX frames dropped due to retry limit during 2098 * measurement 2099 * @mac_id: MAC ID the measurement applies to. 2100 * @status: return status. may be one of the LQM_STATUS_* defined above. 2101 * @reserved: reserved. 2102 */ 2103 struct iwl_link_qual_msrmnt_notif { 2104 __le32 frequent_stations_air_time[LQM_NUMBER_OF_STATIONS_IN_REPORT]; 2105 __le32 number_of_stations; 2106 __le32 total_air_time_other_stations; 2107 __le32 time_in_measurement_window; 2108 __le32 tx_frame_dropped; 2109 __le32 mac_id; 2110 __le32 status; 2111 __le32 reserved[3]; 2112 } __packed; /* LQM_MEASUREMENT_COMPLETE_NTF_API_S_VER1 */ 2113 2114 #endif /* __fw_api_h__ */ 2115