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