1/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2/*
3 * Copyright (C) 2017 Intel Deutschland GmbH
4 * Copyright (C) 2018-2023 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
18struct iwl_fw_runtime_ops {
19	void (*dump_start)(void *ctx);
20	void (*dump_end)(void *ctx);
21	bool (*fw_running)(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 */
49struct iwl_fwrt_dump_data {
50	union {
51		struct {
52			struct iwl_fw_ini_trigger_tlv *trig;
53			struct iwl_rx_packet *fw_pkt;
54		};
55		struct {
56			const struct iwl_fw_dump_desc *desc;
57			bool monitor_only;
58		};
59	};
60};
61
62/**
63 * struct iwl_fwrt_wk_data - dump worker data struct
64 * @idx: index of the worker
65 * @wk: worker
66 */
67struct iwl_fwrt_wk_data  {
68	u8 idx;
69	struct delayed_work wk;
70	struct iwl_fwrt_dump_data dump_data;
71};
72
73/**
74 * struct iwl_txf_iter_data - Tx fifo iterator data struct
75 * @fifo: fifo number
76 * @lmac: lmac number
77 * @fifo_size: fifo size
78 * @internal_txf: non zero if fifo is  internal Tx fifo
79 */
80struct iwl_txf_iter_data {
81	int fifo;
82	int lmac;
83	u32 fifo_size;
84	u8 internal_txf;
85};
86
87/**
88 * struct iwl_fw_runtime - runtime data for firmware
89 * @fw: firmware image
90 * @cfg: NIC configuration
91 * @dev: device pointer
92 * @ops: user ops
93 * @ops_ctx: user ops context
94 * @fw_paging_db: paging database
95 * @num_of_paging_blk: number of paging blocks
96 * @num_of_pages_in_last_blk: number of pages in the last block
97 * @smem_cfg: saved firmware SMEM configuration
98 * @cur_fw_img: current firmware image, must be maintained by
99 *	the driver by calling &iwl_fw_set_current_image()
100 * @dump: debug dump data
101 */
102struct iwl_fw_runtime {
103	struct iwl_trans *trans;
104	const struct iwl_fw *fw;
105	struct device *dev;
106
107	const struct iwl_fw_runtime_ops *ops;
108	void *ops_ctx;
109
110	const struct iwl_dump_sanitize_ops *sanitize_ops;
111	void *sanitize_ctx;
112
113	/* Paging */
114	struct iwl_fw_paging fw_paging_db[NUM_OF_FW_PAGING_BLOCKS];
115	u16 num_of_paging_blk;
116	u16 num_of_pages_in_last_blk;
117
118	enum iwl_ucode_type cur_fw_img;
119
120	/* memory configuration */
121	struct iwl_fwrt_shared_mem_cfg smem_cfg;
122
123	/* debug */
124	struct {
125		struct iwl_fwrt_wk_data wks[IWL_FW_RUNTIME_DUMP_WK_NUM];
126		unsigned long active_wks;
127
128		u8 conf;
129
130		/* ts of the beginning of a non-collect fw dbg data period */
131		unsigned long non_collect_ts_start[IWL_FW_INI_TIME_POINT_NUM];
132		u32 *d3_debug_data;
133		u32 lmac_err_id[MAX_NUM_LMAC];
134		u32 tcm_err_id[MAX_NUM_TCM];
135		u32 rcm_err_id[MAX_NUM_RCM];
136		u32 umac_err_id;
137
138		struct iwl_txf_iter_data txf_iter_data;
139
140		struct {
141			u8 type;
142			u8 subtype;
143			u32 lmac_major;
144			u32 lmac_minor;
145			u32 umac_major;
146			u32 umac_minor;
147		} fw_ver;
148	} dump;
149	struct {
150#ifdef CONFIG_IWLWIFI_DEBUGFS
151		struct delayed_work wk;
152		u32 delay;
153#endif
154		u64 seq;
155	} timestamp;
156#ifdef CONFIG_IWLWIFI_DEBUGFS
157	bool tpc_enabled;
158#endif /* CONFIG_IWLWIFI_DEBUGFS */
159#ifdef CONFIG_ACPI
160	struct iwl_sar_profile sar_profiles[ACPI_SAR_PROFILE_NUM];
161	u8 sar_chain_a_profile;
162	u8 sar_chain_b_profile;
163	struct iwl_geo_profile geo_profiles[ACPI_NUM_GEO_PROFILES_REV3];
164	u32 geo_rev;
165	u32 geo_num_profiles;
166	bool geo_enabled;
167	struct iwl_ppag_chain ppag_chains[IWL_NUM_CHAIN_LIMITS];
168	u32 ppag_flags;
169	u32 ppag_ver;
170	bool ppag_table_valid;
171	struct iwl_sar_offset_mapping_cmd sgom_table;
172	bool sgom_enabled;
173	u8 reduced_power_flags;
174#endif
175};
176
177void iwl_fw_runtime_init(struct iwl_fw_runtime *fwrt, struct iwl_trans *trans,
178			const struct iwl_fw *fw,
179			const struct iwl_fw_runtime_ops *ops, void *ops_ctx,
180			const struct iwl_dump_sanitize_ops *sanitize_ops,
181			void *sanitize_ctx,
182			struct dentry *dbgfs_dir);
183
184static inline void iwl_fw_runtime_free(struct iwl_fw_runtime *fwrt)
185{
186	int i;
187
188	kfree(fwrt->dump.d3_debug_data);
189	fwrt->dump.d3_debug_data = NULL;
190
191	iwl_dbg_tlv_del_timers(fwrt->trans);
192	for (i = 0; i < IWL_FW_RUNTIME_DUMP_WK_NUM; i++)
193		cancel_delayed_work_sync(&fwrt->dump.wks[i].wk);
194}
195
196void iwl_fw_runtime_suspend(struct iwl_fw_runtime *fwrt);
197
198void iwl_fw_runtime_resume(struct iwl_fw_runtime *fwrt);
199
200static inline void iwl_fw_set_current_image(struct iwl_fw_runtime *fwrt,
201					    enum iwl_ucode_type cur_fw_img)
202{
203	fwrt->cur_fw_img = cur_fw_img;
204}
205
206int iwl_init_paging(struct iwl_fw_runtime *fwrt, enum iwl_ucode_type type);
207void iwl_free_fw_paging(struct iwl_fw_runtime *fwrt);
208
209void iwl_get_shared_mem_conf(struct iwl_fw_runtime *fwrt);
210int iwl_set_soc_latency(struct iwl_fw_runtime *fwrt);
211int iwl_configure_rxq(struct iwl_fw_runtime *fwrt);
212
213#endif /* __iwl_fw_runtime_h__ */
214