runtime.h

  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
 19struct 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
 29struct 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 */
 55struct 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 */
 75struct 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 */
 88struct 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 * @acpi_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 * @geo_enabled: WGDS table is present
124 * @geo_num_profiles: number of geo profiles
125 * @geo_rev: geo profiles table revision
126 * @ppag_chains: PPAG table data
127 * @ppag_flags: PPAG flags
128 * @reduced_power_flags: reduced power flags
129 * @sanitize_ctx: context for dump sanitizer
130 * @sanitize_ops: dump sanitizer ops
131 * @sar_chain_a_profile: SAR chain A profile
132 * @sar_chain_b_profile: SAR chain B profile
133 * @sgom_enabled: SGOM enabled
134 * @sgom_table: SGOM table
135 * @timestamp: timestamp marker data
136 * @timestamp.wk: timestamp marking worker
137 * @timestamp.seq: timestamp marking sequence
138 * @timestamp.delay: timestamp marking worker delay
139 * @tpc_enabled: TPC enabled
140 */
141struct iwl_fw_runtime {
142	struct iwl_trans *trans;
143	const struct iwl_fw *fw;
144	struct device *dev;
145
146	const struct iwl_fw_runtime_ops *ops;
147	void *ops_ctx;
148
149	const struct iwl_dump_sanitize_ops *sanitize_ops;
150	void *sanitize_ctx;
151
152	/* Paging */
153	struct iwl_fw_paging fw_paging_db[NUM_OF_FW_PAGING_BLOCKS];
154	u16 num_of_paging_blk;
155	u16 num_of_pages_in_last_blk;
156
157	enum iwl_ucode_type cur_fw_img;
158
159	/* memory configuration */
160	struct iwl_fwrt_shared_mem_cfg smem_cfg;
161
162	/* debug */
163	struct {
164		struct iwl_fwrt_wk_data wks[IWL_FW_RUNTIME_DUMP_WK_NUM];
165		unsigned long active_wks;
166
167		u8 conf;
168
169		/* ts of the beginning of a non-collect fw dbg data period */
170		unsigned long non_collect_ts_start[IWL_FW_INI_TIME_POINT_NUM];
171		u32 *d3_debug_data;
172		u32 lmac_err_id[MAX_NUM_LMAC];
173		u32 umac_err_id;
174
175		struct iwl_txf_iter_data txf_iter_data;
176
177		struct {
178			u8 type;
179			u8 subtype;
180			u32 lmac_major;
181			u32 lmac_minor;
182			u32 umac_major;
183			u32 umac_minor;
184		} fw_ver;
185	} dump;
186	struct {
187#ifdef CONFIG_IWLWIFI_DEBUGFS
188		struct delayed_work wk;
189		u32 delay;
190#endif
191		u64 seq;
192	} timestamp;
193#ifdef CONFIG_IWLWIFI_DEBUGFS
194	bool tpc_enabled;
195#endif /* CONFIG_IWLWIFI_DEBUGFS */
196	struct iwl_sar_profile sar_profiles[BIOS_SAR_MAX_PROFILE_NUM];
197	u8 sar_chain_a_profile;
198	u8 sar_chain_b_profile;
199	u8 reduced_power_flags;
200	struct iwl_geo_profile geo_profiles[BIOS_GEO_MAX_PROFILE_NUM];
201	u32 geo_rev;
202	u32 geo_num_profiles;
203	bool geo_enabled;
204	struct iwl_ppag_chain ppag_chains[IWL_NUM_CHAIN_LIMITS];
205	u32 ppag_flags;
206	u8 ppag_bios_rev;
207	u8 ppag_bios_source;
208	struct iwl_sar_offset_mapping_cmd sgom_table;
209	bool sgom_enabled;
210	struct iwl_mcc_allowed_ap_type_cmd uats_table;
211	bool uats_valid;
212	u8 uefi_tables_lock_status;
213	struct iwl_phy_specific_cfg phy_filters;
214
215#ifdef CONFIG_ACPI
216	u32 acpi_dsm_funcs_valid;
217#endif
218};
219
220void iwl_fw_runtime_init(struct iwl_fw_runtime *fwrt, struct iwl_trans *trans,
221			const struct iwl_fw *fw,
222			const struct iwl_fw_runtime_ops *ops, void *ops_ctx,
223			const struct iwl_dump_sanitize_ops *sanitize_ops,
224			void *sanitize_ctx,
225			struct dentry *dbgfs_dir);
226
227static inline void iwl_fw_runtime_free(struct iwl_fw_runtime *fwrt)
228{
229	int i;
230
231	kfree(fwrt->dump.d3_debug_data);
232	fwrt->dump.d3_debug_data = NULL;
233
234	iwl_dbg_tlv_del_timers(fwrt->trans);
235	for (i = 0; i < IWL_FW_RUNTIME_DUMP_WK_NUM; i++)
236		cancel_delayed_work_sync(&fwrt->dump.wks[i].wk);
237}
238
239void iwl_fw_runtime_suspend(struct iwl_fw_runtime *fwrt);
240
241void iwl_fw_runtime_resume(struct iwl_fw_runtime *fwrt);
242
243static inline void iwl_fw_set_current_image(struct iwl_fw_runtime *fwrt,
244					    enum iwl_ucode_type cur_fw_img)
245{
246	fwrt->cur_fw_img = cur_fw_img;
247}
248
249int iwl_init_paging(struct iwl_fw_runtime *fwrt, enum iwl_ucode_type type);
250void iwl_free_fw_paging(struct iwl_fw_runtime *fwrt);
251
252void iwl_get_shared_mem_conf(struct iwl_fw_runtime *fwrt);
253int iwl_set_soc_latency(struct iwl_fw_runtime *fwrt);
254int iwl_configure_rxq(struct iwl_fw_runtime *fwrt);
255
256#endif /* __iwl_fw_runtime_h__ */