Loading...
Note: File does not exist in v6.2.
1/* SPDX-License-Identifier: MIT */
2/*
3 * Copyright © 2022 Intel Corporation
4 */
5
6#ifndef _XE_GUC_FWIF_H
7#define _XE_GUC_FWIF_H
8
9#include <linux/bits.h>
10
11#include "abi/guc_capture_abi.h"
12#include "abi/guc_klvs_abi.h"
13#include "xe_hw_engine_types.h"
14
15#define G2H_LEN_DW_SCHED_CONTEXT_MODE_SET 4
16#define G2H_LEN_DW_DEREGISTER_CONTEXT 3
17#define G2H_LEN_DW_TLB_INVALIDATE 3
18
19#define GUC_ID_MAX 65535
20
21#define GUC_CONTEXT_DISABLE 0
22#define GUC_CONTEXT_ENABLE 1
23
24#define GUC_CLIENT_PRIORITY_KMD_HIGH 0
25#define GUC_CLIENT_PRIORITY_HIGH 1
26#define GUC_CLIENT_PRIORITY_KMD_NORMAL 2
27#define GUC_CLIENT_PRIORITY_NORMAL 3
28#define GUC_CLIENT_PRIORITY_NUM 4
29
30#define GUC_RENDER_ENGINE 0
31#define GUC_VIDEO_ENGINE 1
32#define GUC_BLITTER_ENGINE 2
33#define GUC_VIDEOENHANCE_ENGINE 3
34#define GUC_VIDEO_ENGINE2 4
35#define GUC_MAX_ENGINES_NUM (GUC_VIDEO_ENGINE2 + 1)
36
37#define GUC_RENDER_CLASS 0
38#define GUC_VIDEO_CLASS 1
39#define GUC_VIDEOENHANCE_CLASS 2
40#define GUC_BLITTER_CLASS 3
41#define GUC_COMPUTE_CLASS 4
42#define GUC_GSC_OTHER_CLASS 5
43#define GUC_LAST_ENGINE_CLASS GUC_GSC_OTHER_CLASS
44#define GUC_MAX_ENGINE_CLASSES 16
45#define GUC_MAX_INSTANCES_PER_CLASS 32
46
47/* Helper for context registration H2G */
48struct guc_ctxt_registration_info {
49 u32 flags;
50 u32 context_idx;
51 u32 engine_class;
52 u32 engine_submit_mask;
53 u32 wq_desc_lo;
54 u32 wq_desc_hi;
55 u32 wq_base_lo;
56 u32 wq_base_hi;
57 u32 wq_size;
58 u32 hwlrca_lo;
59 u32 hwlrca_hi;
60};
61#define CONTEXT_REGISTRATION_FLAG_KMD BIT(0)
62
63/* 32-bit KLV structure as used by policy updates and others */
64struct guc_klv_generic_dw_t {
65 u32 kl;
66 u32 value;
67} __packed;
68
69/* Format of the UPDATE_CONTEXT_POLICIES H2G data packet */
70struct guc_update_exec_queue_policy_header {
71 u32 action;
72 u32 guc_id;
73} __packed;
74
75struct guc_update_exec_queue_policy {
76 struct guc_update_exec_queue_policy_header header;
77 struct guc_klv_generic_dw_t klv[GUC_CONTEXT_POLICIES_KLV_NUM_IDS];
78} __packed;
79
80/* GUC_CTL_* - Parameters for loading the GuC */
81#define GUC_CTL_LOG_PARAMS 0
82#define GUC_LOG_VALID BIT(0)
83#define GUC_LOG_NOTIFY_ON_HALF_FULL BIT(1)
84#define GUC_LOG_CAPTURE_ALLOC_UNITS BIT(2)
85#define GUC_LOG_LOG_ALLOC_UNITS BIT(3)
86#define GUC_LOG_CRASH_SHIFT 4
87#define GUC_LOG_CRASH_MASK (0x3 << GUC_LOG_CRASH_SHIFT)
88#define GUC_LOG_DEBUG_SHIFT 6
89#define GUC_LOG_DEBUG_MASK (0xF << GUC_LOG_DEBUG_SHIFT)
90#define GUC_LOG_CAPTURE_SHIFT 10
91#define GUC_LOG_CAPTURE_MASK (0x3 << GUC_LOG_CAPTURE_SHIFT)
92#define GUC_LOG_BUF_ADDR_SHIFT 12
93
94#define GUC_CTL_WA 1
95#define GUC_WA_GAM_CREDITS BIT(10)
96#define GUC_WA_DUAL_QUEUE BIT(11)
97#define GUC_WA_RCS_RESET_BEFORE_RC6 BIT(13)
98#define GUC_WA_CONTEXT_ISOLATION BIT(15)
99#define GUC_WA_PRE_PARSER BIT(14)
100#define GUC_WA_HOLD_CCS_SWITCHOUT BIT(17)
101#define GUC_WA_POLLCS BIT(18)
102#define GUC_WA_RENDER_RST_RC6_EXIT BIT(19)
103#define GUC_WA_RCS_REGS_IN_CCS_REGS_LIST BIT(21)
104#define GUC_WA_ENABLE_TSC_CHECK_ON_RC6 BIT(22)
105
106#define GUC_CTL_FEATURE 2
107#define GUC_CTL_ENABLE_SLPC BIT(2)
108#define GUC_CTL_ENABLE_LITE_RESTORE BIT(4)
109#define GUC_CTL_DISABLE_SCHEDULER BIT(14)
110
111#define GUC_CTL_DEBUG 3
112#define GUC_LOG_VERBOSITY_SHIFT 0
113#define GUC_LOG_VERBOSITY_LOW (0 << GUC_LOG_VERBOSITY_SHIFT)
114#define GUC_LOG_VERBOSITY_MED (1 << GUC_LOG_VERBOSITY_SHIFT)
115#define GUC_LOG_VERBOSITY_HIGH (2 << GUC_LOG_VERBOSITY_SHIFT)
116#define GUC_LOG_VERBOSITY_ULTRA (3 << GUC_LOG_VERBOSITY_SHIFT)
117#define GUC_LOG_VERBOSITY_MIN 0
118#define GUC_LOG_VERBOSITY_MAX 3
119#define GUC_LOG_VERBOSITY_MASK 0x0000000f
120#define GUC_LOG_DESTINATION_MASK (3 << 4)
121#define GUC_LOG_DISABLED (1 << 6)
122#define GUC_PROFILE_ENABLED (1 << 7)
123
124#define GUC_CTL_ADS 4
125#define GUC_ADS_ADDR_SHIFT 1
126#define GUC_ADS_ADDR_MASK (0xFFFFF << GUC_ADS_ADDR_SHIFT)
127
128#define GUC_CTL_DEVID 5
129
130#define GUC_CTL_MAX_DWORDS 14
131
132/* Scheduling policy settings */
133
134#define GLOBAL_POLICY_MAX_NUM_WI 15
135
136/* Don't reset an engine upon preemption failure */
137#define GLOBAL_POLICY_DISABLE_ENGINE_RESET BIT(0)
138
139#define GLOBAL_POLICY_DEFAULT_DPC_PROMOTE_TIME_US 500000
140
141struct guc_policies {
142 u32 submission_queue_depth[GUC_MAX_ENGINE_CLASSES];
143 /*
144 * In micro seconds. How much time to allow before DPC processing is
145 * called back via interrupt (to prevent DPC queue drain starving).
146 * Typically 1000s of micro seconds (example only, not granularity).
147 */
148 u32 dpc_promote_time;
149
150 /* Must be set to take these new values. */
151 u32 is_valid;
152
153 /*
154 * Max number of WIs to process per call. A large value may keep CS
155 * idle.
156 */
157 u32 max_num_work_items;
158
159 u32 global_flags;
160 u32 reserved[4];
161} __packed;
162
163/* Generic GT SysInfo data types */
164#define GUC_GENERIC_GT_SYSINFO_SLICE_ENABLED 0
165#define GUC_GENERIC_GT_SYSINFO_VDBOX_SFC_SUPPORT_MASK 1
166#define GUC_GENERIC_GT_SYSINFO_DOORBELL_COUNT_PER_SQIDI 2
167#define GUC_GENERIC_GT_SYSINFO_MAX 16
168
169/* HW info */
170struct guc_gt_system_info {
171 u8 mapping_table[GUC_MAX_ENGINE_CLASSES][GUC_MAX_INSTANCES_PER_CLASS];
172 u32 engine_enabled_masks[GUC_MAX_ENGINE_CLASSES];
173 u32 generic_gt_sysinfo[GUC_GENERIC_GT_SYSINFO_MAX];
174} __packed;
175
176/* GuC Additional Data Struct */
177struct guc_ads {
178 struct guc_mmio_reg_set reg_state_list[GUC_MAX_ENGINE_CLASSES][GUC_MAX_INSTANCES_PER_CLASS];
179 u32 reserved0;
180 u32 scheduler_policies;
181 u32 gt_system_info;
182 u32 reserved1;
183 u32 control_data;
184 u32 golden_context_lrca[GUC_MAX_ENGINE_CLASSES];
185 u32 eng_state_size[GUC_MAX_ENGINE_CLASSES];
186 u32 private_data;
187 u32 um_init_data;
188 u32 capture_instance[GUC_CAPTURE_LIST_INDEX_MAX][GUC_MAX_ENGINE_CLASSES];
189 u32 capture_class[GUC_CAPTURE_LIST_INDEX_MAX][GUC_MAX_ENGINE_CLASSES];
190 u32 capture_global[GUC_CAPTURE_LIST_INDEX_MAX];
191 u32 wa_klv_addr_lo;
192 u32 wa_klv_addr_hi;
193 u32 wa_klv_size;
194 u32 reserved[11];
195} __packed;
196
197/* Engine usage stats */
198struct guc_engine_usage_record {
199 u32 current_context_index;
200 u32 last_switch_in_stamp;
201 u32 reserved0;
202 u32 total_runtime;
203 u32 reserved1[4];
204} __packed;
205
206struct guc_engine_usage {
207 struct guc_engine_usage_record engines[GUC_MAX_ENGINE_CLASSES][GUC_MAX_INSTANCES_PER_CLASS];
208} __packed;
209
210/* This action will be programmed in C1BC - SOFT_SCRATCH_15_REG */
211enum xe_guc_recv_message {
212 XE_GUC_RECV_MSG_CRASH_DUMP_POSTED = BIT(1),
213 XE_GUC_RECV_MSG_EXCEPTION = BIT(30),
214};
215
216/* Page fault structures */
217struct access_counter_desc {
218 u32 dw0;
219#define ACCESS_COUNTER_TYPE BIT(0)
220#define ACCESS_COUNTER_SUBG_LO GENMASK(31, 1)
221
222 u32 dw1;
223#define ACCESS_COUNTER_SUBG_HI BIT(0)
224#define ACCESS_COUNTER_RSVD0 GENMASK(2, 1)
225#define ACCESS_COUNTER_ENG_INSTANCE GENMASK(8, 3)
226#define ACCESS_COUNTER_ENG_CLASS GENMASK(11, 9)
227#define ACCESS_COUNTER_ASID GENMASK(31, 12)
228
229 u32 dw2;
230#define ACCESS_COUNTER_VFID GENMASK(5, 0)
231#define ACCESS_COUNTER_RSVD1 GENMASK(7, 6)
232#define ACCESS_COUNTER_GRANULARITY GENMASK(10, 8)
233#define ACCESS_COUNTER_RSVD2 GENMASK(16, 11)
234#define ACCESS_COUNTER_VIRTUAL_ADDR_RANGE_LO GENMASK(31, 17)
235
236 u32 dw3;
237#define ACCESS_COUNTER_VIRTUAL_ADDR_RANGE_HI GENMASK(31, 0)
238} __packed;
239
240enum guc_um_queue_type {
241 GUC_UM_HW_QUEUE_PAGE_FAULT = 0,
242 GUC_UM_HW_QUEUE_PAGE_FAULT_RESPONSE,
243 GUC_UM_HW_QUEUE_ACCESS_COUNTER,
244 GUC_UM_HW_QUEUE_MAX
245};
246
247struct guc_um_queue_params {
248 u64 base_dpa;
249 u32 base_ggtt_address;
250 u32 size_in_bytes;
251 u32 rsvd[4];
252} __packed;
253
254struct guc_um_init_params {
255 u64 page_response_timeout_in_us;
256 u32 rsvd[6];
257 struct guc_um_queue_params queue_params[GUC_UM_HW_QUEUE_MAX];
258} __packed;
259
260enum xe_guc_fault_reply_type {
261 PFR_ACCESS = 0,
262 PFR_ENGINE,
263 PFR_VFID,
264 PFR_ALL,
265 PFR_INVALID
266};
267
268enum xe_guc_response_desc_type {
269 TLB_INVALIDATION_DESC = 0,
270 FAULT_RESPONSE_DESC
271};
272
273struct xe_guc_pagefault_desc {
274 u32 dw0;
275#define PFD_FAULT_LEVEL GENMASK(2, 0)
276#define PFD_SRC_ID GENMASK(10, 3)
277#define PFD_RSVD_0 GENMASK(17, 11)
278#define XE2_PFD_TRVA_FAULT BIT(18)
279#define PFD_ENG_INSTANCE GENMASK(24, 19)
280#define PFD_ENG_CLASS GENMASK(27, 25)
281#define PFD_PDATA_LO GENMASK(31, 28)
282
283 u32 dw1;
284#define PFD_PDATA_HI GENMASK(11, 0)
285#define PFD_PDATA_HI_SHIFT 4
286#define PFD_ASID GENMASK(31, 12)
287
288 u32 dw2;
289#define PFD_ACCESS_TYPE GENMASK(1, 0)
290#define PFD_FAULT_TYPE GENMASK(3, 2)
291#define PFD_VFID GENMASK(9, 4)
292#define PFD_RSVD_1 GENMASK(11, 10)
293#define PFD_VIRTUAL_ADDR_LO GENMASK(31, 12)
294#define PFD_VIRTUAL_ADDR_LO_SHIFT 12
295
296 u32 dw3;
297#define PFD_VIRTUAL_ADDR_HI GENMASK(31, 0)
298#define PFD_VIRTUAL_ADDR_HI_SHIFT 32
299} __packed;
300
301struct xe_guc_pagefault_reply {
302 u32 dw0;
303#define PFR_VALID BIT(0)
304#define PFR_SUCCESS BIT(1)
305#define PFR_REPLY GENMASK(4, 2)
306#define PFR_RSVD_0 GENMASK(9, 5)
307#define PFR_DESC_TYPE GENMASK(11, 10)
308#define PFR_ASID GENMASK(31, 12)
309
310 u32 dw1;
311#define PFR_VFID GENMASK(5, 0)
312#define PFR_RSVD_1 BIT(6)
313#define PFR_ENG_INSTANCE GENMASK(12, 7)
314#define PFR_ENG_CLASS GENMASK(15, 13)
315#define PFR_PDATA GENMASK(31, 16)
316
317 u32 dw2;
318#define PFR_RSVD_2 GENMASK(31, 0)
319} __packed;
320
321struct xe_guc_acc_desc {
322 u32 dw0;
323#define ACC_TYPE BIT(0)
324#define ACC_TRIGGER 0
325#define ACC_NOTIFY 1
326#define ACC_SUBG_LO GENMASK(31, 1)
327
328 u32 dw1;
329#define ACC_SUBG_HI BIT(0)
330#define ACC_RSVD0 GENMASK(2, 1)
331#define ACC_ENG_INSTANCE GENMASK(8, 3)
332#define ACC_ENG_CLASS GENMASK(11, 9)
333#define ACC_ASID GENMASK(31, 12)
334
335 u32 dw2;
336#define ACC_VFID GENMASK(5, 0)
337#define ACC_RSVD1 GENMASK(7, 6)
338#define ACC_GRANULARITY GENMASK(10, 8)
339#define ACC_RSVD2 GENMASK(16, 11)
340#define ACC_VIRTUAL_ADDR_RANGE_LO GENMASK(31, 17)
341
342 u32 dw3;
343#define ACC_VIRTUAL_ADDR_RANGE_HI GENMASK(31, 0)
344} __packed;
345
346#endif