| 1 |
/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ |
| 2 |
/* |
| 3 |
* Copyright (C) 2017 Intel Deutschland GmbH |
| 4 |
* Copyright (C) 2018-2025 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 |
* @uats_table: AP type table |
| 110 |
* @uats_valid: is AP type table valid |
| 111 |
* @uefi_tables_lock_status: The status of the WIFI GUID UEFI variables lock: |
| 112 |
* 0: Unlocked, 1 and 2: Locked. |
| 113 |
* Only read the UEFI variables if locked. |
| 114 |
* @sar_profiles: sar profiles as read from WRDS/EWRD BIOS tables |
| 115 |
* @geo_profiles: geographic profiles as read from WGDS BIOS table |
| 116 |
* @phy_filters: specific phy filters as read from WPFC BIOS table |
| 117 |
* @ppag_bios_rev: PPAG BIOS revision |
| 118 |
* @ppag_bios_source: see &enum bios_source |
| 119 |
* @dsm_funcs_valid: bitmap indicating which DSM values are valid, |
| 120 |
* zero (default initialization) means it hasn't been read yet, |
| 121 |
* and BIT(0) is set when it has since function 0 also has this |
| 122 |
* bitmap and is always supported. |
| 123 |
* If the bit is set for a specific function, then the corresponding |
| 124 |
* entry in &dsm_values is valid. |
| 125 |
* @dsm_values: cache of the DSM values. The validity of each entry is |
| 126 |
* determined by &dsm_funcs_valid. |
| 127 |
* @geo_enabled: WGDS table is present |
| 128 |
* @geo_num_profiles: number of geo profiles |
| 129 |
* @geo_rev: geo profiles table revision |
| 130 |
* @ppag_chains: PPAG table data |
| 131 |
* @ppag_flags: PPAG flags |
| 132 |
* @reduced_power_flags: reduced power flags |
| 133 |
* @sanitize_ctx: context for dump sanitizer |
| 134 |
* @sanitize_ops: dump sanitizer ops |
| 135 |
* @sar_chain_a_profile: SAR chain A profile |
| 136 |
* @sar_chain_b_profile: SAR chain B profile |
| 137 |
* @sgom_enabled: SGOM enabled |
| 138 |
* @sgom_table: SGOM table |
| 139 |
* @timestamp: timestamp marker data |
| 140 |
* @timestamp.wk: timestamp marking worker |
| 141 |
* @timestamp.seq: timestamp marking sequence |
| 142 |
* @timestamp.delay: timestamp marking worker delay |
| 143 |
* @tpc_enabled: TPC enabled |
| 144 |
* @dsm_source: one of &enum bios_source. UEFI, ACPI or NONE |
| 145 |
* @dsm_revision: the revision of the DSM table |
| 146 |
*/ |
| 147 |
struct iwl_fw_runtime { |
| 148 |
struct iwl_trans *trans; |
| 149 |
const struct iwl_fw *fw; |
| 150 |
struct device *dev; |
| 151 |
|
| 152 |
const struct iwl_fw_runtime_ops *ops; |
| 153 |
void *ops_ctx; |
| 154 |
|
| 155 |
const struct iwl_dump_sanitize_ops *sanitize_ops; |
| 156 |
void *sanitize_ctx; |
| 157 |
|
| 158 |
/* Paging */ |
| 159 |
struct iwl_fw_paging fw_paging_db[NUM_OF_FW_PAGING_BLOCKS]; |
| 160 |
u16 num_of_paging_blk; |
| 161 |
u16 num_of_pages_in_last_blk; |
| 162 |
|
| 163 |
enum iwl_ucode_type cur_fw_img; |
| 164 |
|
| 165 |
/* memory configuration */ |
| 166 |
struct iwl_fwrt_shared_mem_cfg smem_cfg; |
| 167 |
|
| 168 |
/* debug */ |
| 169 |
struct { |
| 170 |
struct iwl_fwrt_wk_data wks[IWL_FW_RUNTIME_DUMP_WK_NUM]; |
| 171 |
unsigned long active_wks; |
| 172 |
|
| 173 |
u8 conf; |
| 174 |
|
| 175 |
/* ts of the beginning of a non-collect fw dbg data period */ |
| 176 |
unsigned long non_collect_ts_start[IWL_FW_INI_TIME_POINT_NUM]; |
| 177 |
u32 *d3_debug_data; |
| 178 |
u32 lmac_err_id[MAX_NUM_LMAC]; |
| 179 |
u32 umac_err_id; |
| 180 |
|
| 181 |
struct iwl_txf_iter_data txf_iter_data; |
| 182 |
|
| 183 |
struct { |
| 184 |
u8 type; |
| 185 |
u8 subtype; |
| 186 |
u32 lmac_major; |
| 187 |
u32 lmac_minor; |
| 188 |
u32 umac_major; |
| 189 |
u32 umac_minor; |
| 190 |
} fw_ver; |
| 191 |
} dump; |
| 192 |
struct { |
| 193 |
#ifdef CONFIG_IWLWIFI_DEBUGFS |
| 194 |
struct delayed_work wk; |
| 195 |
u32 delay; |
| 196 |
#endif |
| 197 |
u64 seq; |
| 198 |
} timestamp; |
| 199 |
#ifdef CONFIG_IWLWIFI_DEBUGFS |
| 200 |
bool tpc_enabled; |
| 201 |
#endif /* CONFIG_IWLWIFI_DEBUGFS */ |
| 202 |
struct iwl_sar_profile sar_profiles[BIOS_SAR_MAX_PROFILE_NUM]; |
| 203 |
u8 sar_chain_a_profile; |
| 204 |
u8 sar_chain_b_profile; |
| 205 |
u8 reduced_power_flags; |
| 206 |
struct iwl_geo_profile geo_profiles[BIOS_GEO_MAX_PROFILE_NUM]; |
| 207 |
u32 geo_rev; |
| 208 |
u32 geo_num_profiles; |
| 209 |
bool geo_enabled; |
| 210 |
struct iwl_ppag_chain ppag_chains[IWL_NUM_CHAIN_LIMITS]; |
| 211 |
u32 ppag_flags; |
| 212 |
u8 ppag_bios_rev; |
| 213 |
u8 ppag_bios_source; |
| 214 |
struct iwl_sar_offset_mapping_cmd sgom_table; |
| 215 |
bool sgom_enabled; |
| 216 |
struct iwl_mcc_allowed_ap_type_cmd uats_table; |
| 217 |
bool uats_valid; |
| 218 |
u8 uefi_tables_lock_status; |
| 219 |
struct iwl_phy_specific_cfg phy_filters; |
| 220 |
enum bios_source dsm_source; |
| 221 |
u8 dsm_revision; |
| 222 |
|
| 223 |
#if defined(CONFIG_ACPI) || defined(CONFIG_EFI) |
| 224 |
u32 dsm_funcs_valid; |
| 225 |
u32 dsm_values[DSM_FUNC_NUM_FUNCS]; |
| 226 |
#endif |
| 227 |
}; |
| 228 |
|
| 229 |
void iwl_fw_runtime_init(struct iwl_fw_runtime *fwrt, struct iwl_trans *trans, |
| 230 |
const struct iwl_fw *fw, |
| 231 |
const struct iwl_fw_runtime_ops *ops, void *ops_ctx, |
| 232 |
const struct iwl_dump_sanitize_ops *sanitize_ops, |
| 233 |
void *sanitize_ctx, |
| 234 |
struct dentry *dbgfs_dir); |
| 235 |
|
| 236 |
static inline void iwl_fw_runtime_free(struct iwl_fw_runtime *fwrt) |
| 237 |
{ |
| 238 |
int i; |
| 239 |
|
| 240 |
kfree(fwrt->dump.d3_debug_data); |
| 241 |
fwrt->dump.d3_debug_data = NULL; |
| 242 |
|
| 243 |
iwl_dbg_tlv_del_timers(fwrt->trans); |
| 244 |
for (i = 0; i < IWL_FW_RUNTIME_DUMP_WK_NUM; i++) |
| 245 |
cancel_delayed_work_sync(&fwrt->dump.wks[i].wk); |
| 246 |
} |
| 247 |
|
| 248 |
void iwl_fw_runtime_suspend(struct iwl_fw_runtime *fwrt); |
| 249 |
|
| 250 |
void iwl_fw_runtime_resume(struct iwl_fw_runtime *fwrt); |
| 251 |
|
| 252 |
static inline void iwl_fw_set_current_image(struct iwl_fw_runtime *fwrt, |
| 253 |
enum iwl_ucode_type cur_fw_img) |
| 254 |
{ |
| 255 |
fwrt->cur_fw_img = cur_fw_img; |
| 256 |
} |
| 257 |
|
| 258 |
int iwl_init_paging(struct iwl_fw_runtime *fwrt, enum iwl_ucode_type type); |
| 259 |
void iwl_free_fw_paging(struct iwl_fw_runtime *fwrt); |
| 260 |
|
| 261 |
void iwl_get_shared_mem_conf(struct iwl_fw_runtime *fwrt); |
| 262 |
int iwl_set_soc_latency(struct iwl_fw_runtime *fwrt); |
| 263 |
int iwl_configure_rxq(struct iwl_fw_runtime *fwrt); |
| 264 |
|
| 265 |
#endif /* __iwl_fw_runtime_h__ */ |