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