1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ 2 /* 3 * Copyright (C) 2017 Intel Deutschland GmbH 4 * Copyright (C) 2018-2026 Intel Corporation 5 */ 6 #ifndef __iwl_fw_runtime_h__ 7 #define __iwl_fw_runtime_h__ 8 9 #include "iwl-config.h" 10 #include "iwl-trans.h" 11 #include "img.h" 12 #include "fw/api/debug.h" 13 #include "fw/api/paging.h" 14 #include "fw/api/power.h" 15 #include "iwl-nvm-utils.h" 16 #include "fw/acpi.h" 17 #include "fw/regulatory.h" 18 19 struct iwl_fw_runtime_ops { 20 void (*dump_start)(void *ctx); 21 void (*dump_end)(void *ctx); 22 int (*send_hcmd)(void *ctx, struct iwl_host_cmd *host_cmd); 23 bool (*d3_debug_enable)(void *ctx); 24 }; 25 26 #define MAX_NUM_LMAC 2 27 #define MAX_NUM_TCM 2 28 #define MAX_NUM_RCM 2 29 struct iwl_fwrt_shared_mem_cfg { 30 int num_lmacs; 31 int num_txfifo_entries; 32 struct { 33 u32 txfifo_size[TX_FIFO_MAX_NUM]; 34 u32 rxfifo1_size; 35 } lmac[MAX_NUM_LMAC]; 36 u32 rxfifo2_size; 37 u32 rxfifo2_control_size; 38 u32 internal_txfifo_addr; 39 u32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM]; 40 }; 41 42 #define IWL_FW_RUNTIME_DUMP_WK_NUM 5 43 44 /** 45 * struct iwl_fwrt_dump_data - dump data 46 * @trig: trigger the worker was scheduled upon 47 * @fw_pkt: packet received from FW 48 * @desc: dump descriptor 49 * @monitor_only: only dump for monitor 50 * 51 * Note that the decision which part of the union is used 52 * is based on iwl_trans_dbg_ini_valid(): the 'trig' part 53 * is used if it is %true, the 'desc' part otherwise. 54 */ 55 struct iwl_fwrt_dump_data { 56 union { 57 struct { 58 struct iwl_fw_ini_trigger_tlv *trig; 59 struct iwl_rx_packet *fw_pkt; 60 }; 61 struct { 62 /* must be first to be same as 'trig' */ 63 const struct iwl_fw_dump_desc *desc; 64 bool monitor_only; 65 }; 66 }; 67 }; 68 69 /** 70 * struct iwl_fwrt_wk_data - dump worker data struct 71 * @idx: index of the worker 72 * @wk: worker 73 * @dump_data: dump data 74 */ 75 struct iwl_fwrt_wk_data { 76 u8 idx; 77 struct delayed_work wk; 78 struct iwl_fwrt_dump_data dump_data; 79 }; 80 81 /** 82 * struct iwl_txf_iter_data - Tx fifo iterator data struct 83 * @fifo: fifo number 84 * @lmac: lmac number 85 * @fifo_size: fifo size 86 * @internal_txf: non zero if fifo is internal Tx fifo 87 */ 88 struct iwl_txf_iter_data { 89 int fifo; 90 int lmac; 91 u32 fifo_size; 92 u8 internal_txf; 93 }; 94 95 /** 96 * struct iwl_fw_runtime - runtime data for firmware 97 * @trans: transport pointer 98 * @fw: firmware image 99 * @dev: device pointer 100 * @ops: user ops 101 * @ops_ctx: user ops context 102 * @fw_paging_db: paging database 103 * @num_of_paging_blk: number of paging blocks 104 * @num_of_pages_in_last_blk: number of pages in the last block 105 * @smem_cfg: saved firmware SMEM configuration 106 * @cur_fw_img: current firmware image, must be maintained by 107 * the driver by calling &iwl_fw_set_current_image() 108 * @dump: debug dump data 109 * @ap_type_cmd: AP type tables (for enablement on 6 GHz) 110 * @ap_type_cmd_valid: if &ap_type_cmd is valid 111 * @uefi_tables_lock_status: the status of the WIFI GUID UEFI variables lock, 112 * see &enum iwl_uefi_cnv_guid_status. 113 * Trust the UEFI variables if locked or in test mode. 114 * @sar_profiles: sar profiles as read from WRDS/EWRD BIOS tables 115 * @sar_standalone_profiles: standalone sar profiles as read from 116 * WSSS/EWSS BIOS tables (for Wi-Fi HB/UHB without concurrent BT) 117 * @wrds_table_revision: revision of WRDS BIOS table 118 * @ewrd_table_revision: revision of EWRD BIOS table 119 * @geo_profiles: geographic profiles as read from WGDS BIOS table 120 * @geo_bios_source: see &enum bios_source 121 * @phy_filters: specific phy filters as read from WPFC BIOS table 122 * @ppag_bios_rev: PPAG BIOS revision 123 * @ppag_bios_source: see &enum bios_source 124 * @dsm_funcs_valid: bitmap indicating which DSM values are valid, 125 * zero (default initialization) means it hasn't been read yet, 126 * and BIT(0) is set when it has since function 0 also has this 127 * bitmap and is always supported. 128 * If the bit is set for a specific function, then the corresponding 129 * entry in &dsm_values is valid. 130 * @dsm_values: cache of the DSM values. The validity of each entry is 131 * determined by &dsm_funcs_valid. 132 * @geo_enabled: WGDS table is present 133 * @geo_num_profiles: number of geo profiles 134 * @geo_rev: geo profiles table revision 135 * @ppag_chains: PPAG table data 136 * @ppag_flags: PPAG flags 137 * @reduced_power_flags: reduced power flags 138 * @sanitize_ctx: context for dump sanitizer 139 * @sanitize_ops: dump sanitizer ops 140 * @sar_chain_a_profile: SAR chain A profile 141 * @sar_chain_b_profile: SAR chain B profile 142 * @sgom_enabled: SGOM enabled 143 * @sgom_table: SGOM table 144 * @timestamp: timestamp marker data 145 * @timestamp.wk: timestamp marking worker 146 * @timestamp.seq: timestamp marking sequence 147 * @timestamp.delay: timestamp marking worker delay 148 * @tpc_enabled: TPC enabled 149 * @dsm_source: one of &enum bios_source. UEFI, ACPI or NONE 150 * @dsm_revision: the revision of the DSM table 151 * @wbem_source: one of &enum bios_source for the WBEM table 152 * @wbem_revision: the revision of the WBEM table 153 * @puncturing_source: one of &enum bios_source for the puncturing table 154 * @puncturing_revision: the revision of the puncturing table 155 * @bios_puncturing: per-country puncturing enablement bitmap from BIOS 156 */ 157 struct iwl_fw_runtime { 158 struct iwl_trans *trans; 159 const struct iwl_fw *fw; 160 struct device *dev; 161 162 const struct iwl_fw_runtime_ops *ops; 163 void *ops_ctx; 164 165 const struct iwl_dump_sanitize_ops *sanitize_ops; 166 void *sanitize_ctx; 167 168 /* Paging */ 169 struct iwl_fw_paging fw_paging_db[NUM_OF_FW_PAGING_BLOCKS]; 170 u16 num_of_paging_blk; 171 u16 num_of_pages_in_last_blk; 172 173 enum iwl_ucode_type cur_fw_img; 174 175 /* memory configuration */ 176 struct iwl_fwrt_shared_mem_cfg smem_cfg; 177 178 /* debug */ 179 struct { 180 struct iwl_fwrt_wk_data wks[IWL_FW_RUNTIME_DUMP_WK_NUM]; 181 unsigned long active_wks; 182 183 u8 conf; 184 185 /* ts of the beginning of a non-collect fw dbg data period */ 186 unsigned long non_collect_ts_start[IWL_FW_INI_TIME_POINT_NUM]; 187 u32 *d3_debug_data; 188 u32 lmac_err_id[MAX_NUM_LMAC]; 189 u32 umac_err_id; 190 191 struct iwl_txf_iter_data txf_iter_data; 192 193 struct { 194 u8 type; 195 u8 subtype; 196 u32 lmac_major; 197 u32 lmac_minor; 198 u32 umac_major; 199 u32 umac_minor; 200 } fw_ver; 201 } dump; 202 struct { 203 #ifdef CONFIG_IWLWIFI_DEBUGFS 204 struct delayed_work wk; 205 u32 delay; 206 #endif 207 u64 seq; 208 } timestamp; 209 #ifdef CONFIG_IWLWIFI_DEBUGFS 210 bool tpc_enabled; 211 #endif /* CONFIG_IWLWIFI_DEBUGFS */ 212 struct iwl_sar_profile sar_profiles[BIOS_SAR_MAX_PROFILE_NUM]; 213 struct iwl_sar_profile sar_standalone_profiles[BIOS_SAR_MAX_PROFILE_NUM]; 214 u8 wrds_table_revision; 215 u8 ewrd_table_revision; 216 u8 sar_chain_a_profile; 217 u8 sar_chain_b_profile; 218 u8 reduced_power_flags; 219 struct iwl_geo_profile geo_profiles[BIOS_GEO_MAX_PROFILE_NUM]; 220 enum bios_source geo_bios_source; 221 u32 geo_rev; 222 u32 geo_num_profiles; 223 bool geo_enabled; 224 struct iwl_ppag_chain ppag_chains[IWL_NUM_CHAIN_LIMITS]; 225 u32 ppag_flags; 226 u8 ppag_bios_rev; 227 u8 ppag_bios_source; 228 struct iwl_sar_offset_mapping_cmd sgom_table; 229 bool sgom_enabled; 230 struct iwl_mcc_allowed_ap_type_cmd ap_type_cmd; 231 bool ap_type_cmd_valid; 232 u8 uefi_tables_lock_status; 233 struct iwl_phy_specific_cfg phy_filters; 234 enum bios_source dsm_source; 235 u8 dsm_revision; 236 237 #if defined(CONFIG_ACPI) || defined(CONFIG_EFI) 238 u32 dsm_funcs_valid; 239 u32 dsm_values[DSM_FUNC_NUM_FUNCS]; 240 #endif 241 242 enum bios_source wbem_source; 243 u8 wbem_revision; 244 enum bios_source puncturing_source; 245 u8 puncturing_revision; 246 u32 bios_puncturing; 247 }; 248 249 void iwl_fw_runtime_init(struct iwl_fw_runtime *fwrt, struct iwl_trans *trans, 250 const struct iwl_fw *fw, 251 const struct iwl_fw_runtime_ops *ops, void *ops_ctx, 252 const struct iwl_dump_sanitize_ops *sanitize_ops, 253 void *sanitize_ctx, 254 struct dentry *dbgfs_dir); 255 256 static inline void iwl_fw_runtime_free(struct iwl_fw_runtime *fwrt) 257 { 258 int i; 259 260 kfree(fwrt->dump.d3_debug_data); 261 fwrt->dump.d3_debug_data = NULL; 262 263 iwl_dbg_tlv_del_timers(fwrt->trans); 264 for (i = 0; i < IWL_FW_RUNTIME_DUMP_WK_NUM; i++) 265 cancel_delayed_work_sync(&fwrt->dump.wks[i].wk); 266 } 267 268 void iwl_fw_runtime_suspend(struct iwl_fw_runtime *fwrt); 269 270 void iwl_fw_runtime_resume(struct iwl_fw_runtime *fwrt); 271 272 static inline void iwl_fw_set_current_image(struct iwl_fw_runtime *fwrt, 273 enum iwl_ucode_type cur_fw_img) 274 { 275 fwrt->cur_fw_img = cur_fw_img; 276 } 277 278 int iwl_init_paging(struct iwl_fw_runtime *fwrt, enum iwl_ucode_type type); 279 void iwl_free_fw_paging(struct iwl_fw_runtime *fwrt); 280 281 void iwl_get_shared_mem_conf(struct iwl_fw_runtime *fwrt); 282 int iwl_set_soc_latency(struct iwl_fw_runtime *fwrt); 283 int iwl_configure_rxq(struct iwl_fw_runtime *fwrt); 284 285 #endif /* __iwl_fw_runtime_h__ */ 286