1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ 2 /* 3 * Copyright (C) 2017 Intel Deutschland GmbH 4 * Copyright (C) 2018-2024 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-eeprom-parse.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 bool (*fw_running)(void *ctx); 23 int (*send_hcmd)(void *ctx, struct iwl_host_cmd *host_cmd); 24 bool (*d3_debug_enable)(void *ctx); 25 }; 26 27 #define MAX_NUM_LMAC 2 28 #define MAX_NUM_TCM 2 29 #define MAX_NUM_RCM 2 30 struct iwl_fwrt_shared_mem_cfg { 31 int num_lmacs; 32 int num_txfifo_entries; 33 struct { 34 u32 txfifo_size[TX_FIFO_MAX_NUM]; 35 u32 rxfifo1_size; 36 } lmac[MAX_NUM_LMAC]; 37 u32 rxfifo2_size; 38 u32 rxfifo2_control_size; 39 u32 internal_txfifo_addr; 40 u32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM]; 41 }; 42 43 #define IWL_FW_RUNTIME_DUMP_WK_NUM 5 44 45 /** 46 * struct iwl_fwrt_dump_data - dump data 47 * @trig: trigger the worker was scheduled upon 48 * @fw_pkt: packet received from FW 49 */ 50 struct iwl_fwrt_dump_data { 51 union { 52 struct { 53 struct iwl_fw_ini_trigger_tlv *trig; 54 struct iwl_rx_packet *fw_pkt; 55 }; 56 struct { 57 const struct iwl_fw_dump_desc *desc; 58 bool monitor_only; 59 }; 60 }; 61 }; 62 63 /** 64 * struct iwl_fwrt_wk_data - dump worker data struct 65 * @idx: index of the worker 66 * @wk: worker 67 */ 68 struct iwl_fwrt_wk_data { 69 u8 idx; 70 struct delayed_work wk; 71 struct iwl_fwrt_dump_data dump_data; 72 }; 73 74 /** 75 * struct iwl_txf_iter_data - Tx fifo iterator data struct 76 * @fifo: fifo number 77 * @lmac: lmac number 78 * @fifo_size: fifo size 79 * @internal_txf: non zero if fifo is internal Tx fifo 80 */ 81 struct iwl_txf_iter_data { 82 int fifo; 83 int lmac; 84 u32 fifo_size; 85 u8 internal_txf; 86 }; 87 88 /** 89 * struct iwl_fw_runtime - runtime data for firmware 90 * @fw: firmware image 91 * @cfg: NIC configuration 92 * @dev: device pointer 93 * @ops: user ops 94 * @ops_ctx: user ops context 95 * @fw_paging_db: paging database 96 * @num_of_paging_blk: number of paging blocks 97 * @num_of_pages_in_last_blk: number of pages in the last block 98 * @smem_cfg: saved firmware SMEM configuration 99 * @cur_fw_img: current firmware image, must be maintained by 100 * the driver by calling &iwl_fw_set_current_image() 101 * @dump: debug dump data 102 * @uats_enabled: VLP or AFC AP is enabled 103 * @uats_table: AP type table 104 * @uefi_tables_lock_status: The status of the WIFI GUID UEFI variables lock: 105 * 0: Unlocked, 1 and 2: Locked. 106 * Only read the UEFI variables if locked. 107 * @sar_profiles: sar profiles as read from WRDS/EWRD BIOS tables 108 * @geo_profiles: geographic profiles as read from WGDS BIOS table 109 */ 110 struct iwl_fw_runtime { 111 struct iwl_trans *trans; 112 const struct iwl_fw *fw; 113 struct device *dev; 114 115 const struct iwl_fw_runtime_ops *ops; 116 void *ops_ctx; 117 118 const struct iwl_dump_sanitize_ops *sanitize_ops; 119 void *sanitize_ctx; 120 121 /* Paging */ 122 struct iwl_fw_paging fw_paging_db[NUM_OF_FW_PAGING_BLOCKS]; 123 u16 num_of_paging_blk; 124 u16 num_of_pages_in_last_blk; 125 126 enum iwl_ucode_type cur_fw_img; 127 128 /* memory configuration */ 129 struct iwl_fwrt_shared_mem_cfg smem_cfg; 130 131 /* debug */ 132 struct { 133 struct iwl_fwrt_wk_data wks[IWL_FW_RUNTIME_DUMP_WK_NUM]; 134 unsigned long active_wks; 135 136 u8 conf; 137 138 /* ts of the beginning of a non-collect fw dbg data period */ 139 unsigned long non_collect_ts_start[IWL_FW_INI_TIME_POINT_NUM]; 140 u32 *d3_debug_data; 141 u32 lmac_err_id[MAX_NUM_LMAC]; 142 u32 tcm_err_id[MAX_NUM_TCM]; 143 u32 rcm_err_id[MAX_NUM_RCM]; 144 u32 umac_err_id; 145 146 struct iwl_txf_iter_data txf_iter_data; 147 148 struct { 149 u8 type; 150 u8 subtype; 151 u32 lmac_major; 152 u32 lmac_minor; 153 u32 umac_major; 154 u32 umac_minor; 155 } fw_ver; 156 } dump; 157 struct { 158 #ifdef CONFIG_IWLWIFI_DEBUGFS 159 struct delayed_work wk; 160 u32 delay; 161 #endif 162 u64 seq; 163 } timestamp; 164 #ifdef CONFIG_IWLWIFI_DEBUGFS 165 bool tpc_enabled; 166 #endif /* CONFIG_IWLWIFI_DEBUGFS */ 167 struct iwl_sar_profile sar_profiles[BIOS_SAR_MAX_PROFILE_NUM]; 168 u8 sar_chain_a_profile; 169 u8 sar_chain_b_profile; 170 u8 reduced_power_flags; 171 struct iwl_geo_profile geo_profiles[BIOS_GEO_MAX_PROFILE_NUM]; 172 u32 geo_rev; 173 u32 geo_num_profiles; 174 bool geo_enabled; 175 struct iwl_ppag_chain ppag_chains[IWL_NUM_CHAIN_LIMITS]; 176 u32 ppag_flags; 177 u8 ppag_ver; 178 struct iwl_sar_offset_mapping_cmd sgom_table; 179 bool sgom_enabled; 180 struct iwl_uats_table_cmd uats_table; 181 u8 uefi_tables_lock_status; 182 bool uats_enabled; 183 }; 184 185 void iwl_fw_runtime_init(struct iwl_fw_runtime *fwrt, struct iwl_trans *trans, 186 const struct iwl_fw *fw, 187 const struct iwl_fw_runtime_ops *ops, void *ops_ctx, 188 const struct iwl_dump_sanitize_ops *sanitize_ops, 189 void *sanitize_ctx, 190 struct dentry *dbgfs_dir); 191 192 static inline void iwl_fw_runtime_free(struct iwl_fw_runtime *fwrt) 193 { 194 int i; 195 196 kfree(fwrt->dump.d3_debug_data); 197 fwrt->dump.d3_debug_data = NULL; 198 199 iwl_dbg_tlv_del_timers(fwrt->trans); 200 for (i = 0; i < IWL_FW_RUNTIME_DUMP_WK_NUM; i++) 201 cancel_delayed_work_sync(&fwrt->dump.wks[i].wk); 202 } 203 204 void iwl_fw_runtime_suspend(struct iwl_fw_runtime *fwrt); 205 206 void iwl_fw_runtime_resume(struct iwl_fw_runtime *fwrt); 207 208 static inline void iwl_fw_set_current_image(struct iwl_fw_runtime *fwrt, 209 enum iwl_ucode_type cur_fw_img) 210 { 211 fwrt->cur_fw_img = cur_fw_img; 212 } 213 214 int iwl_init_paging(struct iwl_fw_runtime *fwrt, enum iwl_ucode_type type); 215 void iwl_free_fw_paging(struct iwl_fw_runtime *fwrt); 216 217 void iwl_get_shared_mem_conf(struct iwl_fw_runtime *fwrt); 218 int iwl_set_soc_latency(struct iwl_fw_runtime *fwrt); 219 int iwl_configure_rxq(struct iwl_fw_runtime *fwrt); 220 221 #endif /* __iwl_fw_runtime_h__ */ 222