xref: /linux/drivers/gpu/drm/xe/xe_lrc.h (revision be50e7dbd1cd3e752221f41f548ed1c77760dcee)
1 /* SPDX-License-Identifier: MIT */
2 /*
3  * Copyright © 2021 Intel Corporation
4  */
5 #ifndef _XE_LRC_H_
6 #define _XE_LRC_H_
7 
8 #include <linux/types.h>
9 
10 #include "xe_lrc_types.h"
11 
12 struct drm_printer;
13 struct xe_bb;
14 struct xe_device;
15 struct xe_exec_queue;
16 enum xe_multi_queue_priority;
17 enum xe_engine_class;
18 struct xe_gt;
19 struct xe_hw_engine;
20 struct xe_lrc;
21 struct xe_vm;
22 
23 struct xe_lrc_snapshot {
24 	struct xe_bo *lrc_bo;
25 	void *lrc_snapshot;
26 	unsigned long lrc_size, lrc_offset;
27 	unsigned long replay_size, replay_offset;
28 
29 	u32 context_desc;
30 	u32 ring_addr;
31 	u32 indirect_context_desc;
32 	u32 head;
33 	u32 start;
34 	struct {
35 		u32 internal;
36 		u32 memory;
37 	} tail;
38 	u32 start_seqno;
39 	u32 seqno;
40 	u64 ctx_timestamp;
41 	u64 ctx_timestamp_ms;
42 	u64 queue_timestamp;
43 	u64 queue_timestamp_ms;
44 	u32 ctx_job_timestamp;
45 };
46 
47 #define LRC_PPHWSP_FLUSH_INVAL_SCRATCH_ADDR (0x34 * 4)
48 #define LRC_PPHWSP_PXP_INVAL_SCRATCH_ADDR (0x40 * 4)
49 
50 #define LRC_WA_BB_SIZE SZ_4K
51 
52 #define XE_LRC_CREATE_RUNALONE		BIT(0)
53 #define XE_LRC_CREATE_PXP		BIT(1)
54 #define XE_LRC_CREATE_USER_CTX		BIT(2)
55 #define XE_LRC_DISABLE_STATE_CACHE_PERF_FIX	BIT(3)
56 
57 struct xe_lrc *xe_lrc_create(struct xe_hw_engine *hwe, struct xe_vm *vm,
58 			     void *replay_state, u32 ring_size, u16 msix_vec, u32 flags);
59 void xe_lrc_destroy(struct kref *ref);
60 
61 /**
62  * xe_lrc_get - Get reference to the LRC
63  * @lrc: Logical Ring Context
64  *
65  * Increment reference count of @lrc
66  */
67 static inline struct xe_lrc *xe_lrc_get(struct xe_lrc *lrc)
68 {
69 	kref_get(&lrc->refcount);
70 	return lrc;
71 }
72 
73 /**
74  * xe_lrc_put - Put reference of the LRC
75  * @lrc: Logical Ring Context
76  *
77  * Decrement reference count of @lrc, call xe_lrc_destroy when
78  * reference count reaches 0.
79  */
80 static inline void xe_lrc_put(struct xe_lrc *lrc)
81 {
82 	if (lrc)
83 		kref_put(&lrc->refcount, xe_lrc_destroy);
84 }
85 
86 /**
87  * xe_lrc_ring_size() - Xe LRC ring size
88  *
89  * Return: Size of LRC ring buffer
90  */
91 static inline size_t xe_lrc_ring_size(void)
92 {
93 	return SZ_16K;
94 }
95 
96 static inline bool xe_lrc_is_multi_queue(struct xe_lrc *lrc)
97 {
98 	return lrc->multi_queue.primary_lrc;
99 }
100 
101 size_t xe_gt_lrc_hang_replay_size(struct xe_gt *gt, enum xe_engine_class class);
102 size_t xe_gt_lrc_size(struct xe_gt *gt, enum xe_engine_class class);
103 u32 xe_lrc_pphwsp_offset(struct xe_lrc *lrc);
104 u32 xe_lrc_regs_offset(struct xe_lrc *lrc);
105 
106 void xe_lrc_set_ring_tail(struct xe_lrc *lrc, u32 tail);
107 u32 xe_lrc_ring_tail(struct xe_lrc *lrc);
108 void xe_lrc_set_ring_head(struct xe_lrc *lrc, u32 head);
109 u32 xe_lrc_ring_head(struct xe_lrc *lrc);
110 u32 xe_lrc_ring_space(struct xe_lrc *lrc);
111 void xe_lrc_write_ring(struct xe_lrc *lrc, const void *data, size_t size);
112 
113 bool xe_lrc_ring_is_idle(struct xe_lrc *lrc);
114 
115 u32 xe_lrc_indirect_ring_ggtt_addr(struct xe_lrc *lrc);
116 u32 xe_lrc_ggtt_addr(struct xe_lrc *lrc);
117 u32 *xe_lrc_regs(struct xe_lrc *lrc);
118 void xe_lrc_update_hwctx_regs_with_address(struct xe_lrc *lrc);
119 void xe_default_lrc_update_memirq_regs_with_address(struct xe_hw_engine *hwe);
120 void xe_lrc_update_memirq_regs_with_address(struct xe_lrc *lrc, struct xe_hw_engine *hwe,
121 					    u32 *regs);
122 
123 u32 xe_lrc_read_ctx_reg(struct xe_lrc *lrc, int reg_nr);
124 void xe_lrc_write_ctx_reg(struct xe_lrc *lrc, int reg_nr, u32 val);
125 
126 u64 xe_lrc_descriptor(struct xe_lrc *lrc);
127 
128 u32 xe_lrc_seqno_ggtt_addr(struct xe_lrc *lrc);
129 struct dma_fence *xe_lrc_alloc_seqno_fence(void);
130 void xe_lrc_free_seqno_fence(struct dma_fence *fence);
131 void xe_lrc_init_seqno_fence(struct xe_lrc *lrc, struct dma_fence *fence);
132 s32 xe_lrc_seqno(struct xe_lrc *lrc);
133 
134 u32 xe_lrc_start_seqno_ggtt_addr(struct xe_lrc *lrc);
135 s32 xe_lrc_start_seqno(struct xe_lrc *lrc);
136 
137 u32 xe_lrc_parallel_ggtt_addr(struct xe_lrc *lrc);
138 struct iosys_map xe_lrc_parallel_map(struct xe_lrc *lrc);
139 
140 size_t xe_lrc_reg_size(struct xe_device *xe);
141 size_t xe_lrc_engine_state_size(struct xe_gt *gt, enum xe_engine_class class);
142 
143 void xe_lrc_dump_default(struct drm_printer *p,
144 			 struct xe_gt *gt,
145 			 enum xe_engine_class);
146 int xe_lrc_lookup_default_reg_value(struct xe_gt *gt,
147 				    enum xe_engine_class hwe_class,
148 				    u32 offset,
149 				    u32 *value);
150 
151 u32 *xe_lrc_emit_hwe_state_instructions(struct xe_exec_queue *q, u32 *cs);
152 
153 void xe_lrc_set_multi_queue_priority(struct xe_lrc *lrc, enum xe_multi_queue_priority priority);
154 
155 struct xe_lrc_snapshot *xe_lrc_snapshot_capture(struct xe_lrc *lrc);
156 void xe_lrc_snapshot_capture_delayed(struct xe_lrc_snapshot *snapshot);
157 void xe_lrc_snapshot_print(struct xe_lrc_snapshot *snapshot, struct drm_printer *p);
158 void xe_lrc_snapshot_free(struct xe_lrc_snapshot *snapshot);
159 
160 u32 xe_lrc_ctx_timestamp_ggtt_addr(struct xe_lrc *lrc);
161 u32 xe_lrc_ctx_timestamp_udw_ggtt_addr(struct xe_lrc *lrc);
162 u32 xe_lrc_ctx_job_timestamp_ggtt_addr(struct xe_lrc *lrc);
163 u32 xe_lrc_ctx_job_timestamp(struct xe_lrc *lrc);
164 int xe_lrc_setup_wa_bb_with_scratch(struct xe_lrc *lrc, struct xe_hw_engine *hwe,
165 				    u32 *scratch);
166 
167 /**
168  * xe_lrc_update_timestamp - readout LRC timestamp and update cached value
169  * @lrc: logical ring context for this exec queue
170  * @old_ts: pointer where to save the previous timestamp
171  *
172  * Read the current timestamp for this LRC and update the cached value. The
173  * previous cached value is also returned in @old_ts so the caller can calculate
174  * the delta between 2 updates. Note that this is not intended to be called from
175  * any place, but just by the paths updating the drm client utilization.
176  *
177  * Returns the current LRC timestamp
178  */
179 u64 xe_lrc_update_timestamp(struct xe_lrc *lrc, u64 *old_ts);
180 
181 u64 xe_lrc_timestamp(struct xe_lrc *lrc);
182 
183 #endif
184