1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ 2 /* 3 * Copyright (C) 2012-2014, 2018, 2020-2021, 2024 Intel Corporation 4 * Copyright (C) 2013-2015 Intel Mobile Communications GmbH 5 * Copyright (C) 2016-2017 Intel Deutschland GmbH 6 */ 7 #ifndef __iwl_fw_api_alive_h__ 8 #define __iwl_fw_api_alive_h__ 9 10 /* alive response is_valid values */ 11 #define ALIVE_RESP_UCODE_OK BIT(0) 12 #define ALIVE_RESP_RFKILL BIT(1) 13 14 /* alive response ver_type values */ 15 enum { 16 FW_TYPE_HW = 0, 17 FW_TYPE_PROT = 1, 18 FW_TYPE_AP = 2, 19 FW_TYPE_WOWLAN = 3, 20 FW_TYPE_TIMING = 4, 21 FW_TYPE_WIPAN = 5 22 }; 23 24 /* alive response ver_subtype values */ 25 enum { 26 FW_SUBTYPE_FULL_FEATURE = 0, 27 FW_SUBTYPE_BOOTSRAP = 1, /* Not valid */ 28 FW_SUBTYPE_REDUCED = 2, 29 FW_SUBTYPE_ALIVE_ONLY = 3, 30 FW_SUBTYPE_WOWLAN = 4, 31 FW_SUBTYPE_AP_SUBTYPE = 5, 32 FW_SUBTYPE_WIPAN = 6, 33 FW_SUBTYPE_INITIALIZE = 9 34 }; 35 36 #define IWL_ALIVE_STATUS_ERR 0xDEAD 37 #define IWL_ALIVE_STATUS_OK 0xCAFE 38 39 #define IWL_ALIVE_FLG_RFKILL BIT(0) 40 41 struct iwl_lmac_debug_addrs { 42 __le32 error_event_table_ptr; /* SRAM address for error log */ 43 __le32 log_event_table_ptr; /* SRAM address for LMAC event log */ 44 __le32 cpu_register_ptr; 45 __le32 dbgm_config_ptr; 46 __le32 alive_counter_ptr; 47 __le32 scd_base_ptr; /* SRAM address for SCD */ 48 __le32 st_fwrd_addr; /* pointer to Store and forward */ 49 __le32 st_fwrd_size; 50 } __packed; /* UCODE_DEBUG_ADDRS_API_S_VER_2 */ 51 52 struct iwl_lmac_alive { 53 __le32 ucode_major; 54 __le32 ucode_minor; 55 u8 ver_subtype; 56 u8 ver_type; 57 u8 mac; 58 u8 opt; 59 __le32 timestamp; 60 struct iwl_lmac_debug_addrs dbg_ptrs; 61 } __packed; /* UCODE_ALIVE_NTFY_API_S_VER_3 */ 62 63 struct iwl_umac_debug_addrs { 64 __le32 error_info_addr; /* SRAM address for UMAC error log */ 65 __le32 dbg_print_buff_addr; 66 } __packed; /* UMAC_DEBUG_ADDRS_API_S_VER_1 */ 67 68 struct iwl_umac_alive { 69 __le32 umac_major; /* UMAC version: major */ 70 __le32 umac_minor; /* UMAC version: minor */ 71 struct iwl_umac_debug_addrs dbg_ptrs; 72 } __packed; /* UMAC_ALIVE_DATA_API_S_VER_2 */ 73 74 struct iwl_sku_id { 75 __le32 data[3]; 76 } __packed; /* SKU_ID_API_S_VER_1 */ 77 78 struct iwl_alive_ntf_v3 { 79 __le16 status; 80 __le16 flags; 81 struct iwl_lmac_alive lmac_data; 82 struct iwl_umac_alive umac_data; 83 } __packed; /* UCODE_ALIVE_NTFY_API_S_VER_3 */ 84 85 struct iwl_alive_ntf_v4 { 86 __le16 status; 87 __le16 flags; 88 struct iwl_lmac_alive lmac_data[2]; 89 struct iwl_umac_alive umac_data; 90 } __packed; /* UCODE_ALIVE_NTFY_API_S_VER_4 */ 91 92 struct iwl_alive_ntf_v5 { 93 __le16 status; 94 __le16 flags; 95 struct iwl_lmac_alive lmac_data[2]; 96 struct iwl_umac_alive umac_data; 97 struct iwl_sku_id sku_id; 98 } __packed; /* UCODE_ALIVE_NTFY_API_S_VER_5 */ 99 100 struct iwl_imr_alive_info { 101 __le64 base_addr; 102 __le32 size; 103 __le32 enabled; 104 } __packed; /* IMR_ALIVE_INFO_API_S_VER_1 */ 105 106 struct iwl_alive_ntf_v6 { 107 __le16 status; 108 __le16 flags; 109 struct iwl_lmac_alive lmac_data[2]; 110 struct iwl_umac_alive umac_data; 111 struct iwl_sku_id sku_id; 112 struct iwl_imr_alive_info imr; 113 } __packed; /* UCODE_ALIVE_NTFY_API_S_VER_6 */ 114 115 /** 116 * enum iwl_extended_cfg_flags - commands driver may send before 117 * finishing init flow 118 * @IWL_INIT_DEBUG_CFG: driver is going to send debug config command 119 * @IWL_INIT_NVM: driver is going to send NVM_ACCESS commands 120 * @IWL_INIT_PHY: driver is going to send PHY_DB commands 121 */ 122 enum iwl_extended_cfg_flags { 123 IWL_INIT_DEBUG_CFG, 124 IWL_INIT_NVM, 125 IWL_INIT_PHY, 126 }; 127 128 /** 129 * struct iwl_init_extended_cfg_cmd - mark what commands ucode should wait for 130 * before finishing init flows 131 * @init_flags: values from iwl_extended_cfg_flags 132 */ 133 struct iwl_init_extended_cfg_cmd { 134 __le32 init_flags; 135 } __packed; /* INIT_EXTENDED_CFG_CMD_API_S_VER_1 */ 136 137 /** 138 * struct iwl_radio_version_notif - information on the radio version 139 * ( RADIO_VERSION_NOTIFICATION = 0x68 ) 140 * @radio_flavor: radio flavor 141 * @radio_step: radio version step 142 * @radio_dash: radio version dash 143 */ 144 struct iwl_radio_version_notif { 145 __le32 radio_flavor; 146 __le32 radio_step; 147 __le32 radio_dash; 148 } __packed; /* RADIO_VERSION_NOTOFICATION_S_VER_1 */ 149 150 enum iwl_card_state_flags { 151 CARD_ENABLED = 0x00, 152 HW_CARD_DISABLED = 0x01, 153 SW_CARD_DISABLED = 0x02, 154 CT_KILL_CARD_DISABLED = 0x04, 155 HALT_CARD_DISABLED = 0x08, 156 CARD_DISABLED_MSK = 0x0f, 157 CARD_IS_RX_ON = 0x10, 158 }; 159 160 /** 161 * enum iwl_error_recovery_flags - flags for error recovery cmd 162 * @ERROR_RECOVERY_UPDATE_DB: update db from blob sent 163 * @ERROR_RECOVERY_END_OF_RECOVERY: end of recovery 164 */ 165 enum iwl_error_recovery_flags { 166 ERROR_RECOVERY_UPDATE_DB = BIT(0), 167 ERROR_RECOVERY_END_OF_RECOVERY = BIT(1), 168 }; 169 170 /** 171 * struct iwl_fw_error_recovery_cmd - recovery cmd sent upon assert 172 * @flags: &enum iwl_error_recovery_flags 173 * @buf_size: db buffer size in bytes 174 */ 175 struct iwl_fw_error_recovery_cmd { 176 __le32 flags; 177 __le32 buf_size; 178 } __packed; /* ERROR_RECOVERY_CMD_HDR_API_S_VER_1 */ 179 180 #endif /* __iwl_fw_api_alive_h__ */ 181