xref: /linux/drivers/gpu/drm/xe/xe_lrc.h (revision ca220141fa8ebae09765a242076b2b77338106b0)
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 	u32 ctx_timestamp;
41 	u32 ctx_job_timestamp;
42 };
43 
44 #define LRC_PPHWSP_FLUSH_INVAL_SCRATCH_ADDR (0x34 * 4)
45 #define LRC_PPHWSP_PXP_INVAL_SCRATCH_ADDR (0x40 * 4)
46 
47 #define LRC_WA_BB_SIZE SZ_4K
48 
49 #define XE_LRC_CREATE_RUNALONE		BIT(0)
50 #define XE_LRC_CREATE_PXP		BIT(1)
51 #define XE_LRC_CREATE_USER_CTX		BIT(2)
52 
53 struct xe_lrc *xe_lrc_create(struct xe_hw_engine *hwe, struct xe_vm *vm,
54 			     void *replay_state, u32 ring_size, u16 msix_vec, u32 flags);
55 void xe_lrc_destroy(struct kref *ref);
56 
57 /**
58  * xe_lrc_get - Get reference to the LRC
59  * @lrc: Logical Ring Context
60  *
61  * Increment reference count of @lrc
62  */
63 static inline struct xe_lrc *xe_lrc_get(struct xe_lrc *lrc)
64 {
65 	kref_get(&lrc->refcount);
66 	return lrc;
67 }
68 
69 /**
70  * xe_lrc_put - Put reference of the LRC
71  * @lrc: Logical Ring Context
72  *
73  * Decrement reference count of @lrc, call xe_lrc_destroy when
74  * reference count reaches 0.
75  */
76 static inline void xe_lrc_put(struct xe_lrc *lrc)
77 {
78 	kref_put(&lrc->refcount, xe_lrc_destroy);
79 }
80 
81 /**
82  * xe_lrc_ring_size() - Xe LRC ring size
83  *
84  * Return: Size of LRC ring buffer
85  */
86 static inline size_t xe_lrc_ring_size(void)
87 {
88 	return SZ_16K;
89 }
90 
91 size_t xe_gt_lrc_hang_replay_size(struct xe_gt *gt, enum xe_engine_class class);
92 size_t xe_gt_lrc_size(struct xe_gt *gt, enum xe_engine_class class);
93 u32 xe_lrc_pphwsp_offset(struct xe_lrc *lrc);
94 u32 xe_lrc_regs_offset(struct xe_lrc *lrc);
95 
96 void xe_lrc_set_ring_tail(struct xe_lrc *lrc, u32 tail);
97 u32 xe_lrc_ring_tail(struct xe_lrc *lrc);
98 void xe_lrc_set_ring_head(struct xe_lrc *lrc, u32 head);
99 u32 xe_lrc_ring_head(struct xe_lrc *lrc);
100 u32 xe_lrc_ring_space(struct xe_lrc *lrc);
101 void xe_lrc_write_ring(struct xe_lrc *lrc, const void *data, size_t size);
102 
103 bool xe_lrc_ring_is_idle(struct xe_lrc *lrc);
104 
105 u32 xe_lrc_indirect_ring_ggtt_addr(struct xe_lrc *lrc);
106 u32 xe_lrc_ggtt_addr(struct xe_lrc *lrc);
107 u32 *xe_lrc_regs(struct xe_lrc *lrc);
108 void xe_lrc_update_hwctx_regs_with_address(struct xe_lrc *lrc);
109 void xe_default_lrc_update_memirq_regs_with_address(struct xe_hw_engine *hwe);
110 void xe_lrc_update_memirq_regs_with_address(struct xe_lrc *lrc, struct xe_hw_engine *hwe,
111 					    u32 *regs);
112 
113 u32 xe_lrc_read_ctx_reg(struct xe_lrc *lrc, int reg_nr);
114 void xe_lrc_write_ctx_reg(struct xe_lrc *lrc, int reg_nr, u32 val);
115 
116 u64 xe_lrc_descriptor(struct xe_lrc *lrc);
117 
118 u32 xe_lrc_seqno_ggtt_addr(struct xe_lrc *lrc);
119 struct dma_fence *xe_lrc_alloc_seqno_fence(void);
120 void xe_lrc_free_seqno_fence(struct dma_fence *fence);
121 void xe_lrc_init_seqno_fence(struct xe_lrc *lrc, struct dma_fence *fence);
122 s32 xe_lrc_seqno(struct xe_lrc *lrc);
123 
124 u32 xe_lrc_start_seqno_ggtt_addr(struct xe_lrc *lrc);
125 s32 xe_lrc_start_seqno(struct xe_lrc *lrc);
126 
127 u32 xe_lrc_parallel_ggtt_addr(struct xe_lrc *lrc);
128 struct iosys_map xe_lrc_parallel_map(struct xe_lrc *lrc);
129 
130 size_t xe_lrc_reg_size(struct xe_device *xe);
131 size_t xe_lrc_skip_size(struct xe_device *xe);
132 
133 void xe_lrc_dump_default(struct drm_printer *p,
134 			 struct xe_gt *gt,
135 			 enum xe_engine_class);
136 
137 u32 *xe_lrc_emit_hwe_state_instructions(struct xe_exec_queue *q, u32 *cs);
138 
139 void xe_lrc_set_multi_queue_priority(struct xe_lrc *lrc, enum xe_multi_queue_priority priority);
140 
141 struct xe_lrc_snapshot *xe_lrc_snapshot_capture(struct xe_lrc *lrc);
142 void xe_lrc_snapshot_capture_delayed(struct xe_lrc_snapshot *snapshot);
143 void xe_lrc_snapshot_print(struct xe_lrc_snapshot *snapshot, struct drm_printer *p);
144 void xe_lrc_snapshot_free(struct xe_lrc_snapshot *snapshot);
145 
146 u32 xe_lrc_ctx_timestamp_ggtt_addr(struct xe_lrc *lrc);
147 u32 xe_lrc_ctx_timestamp_udw_ggtt_addr(struct xe_lrc *lrc);
148 u32 xe_lrc_ctx_job_timestamp_ggtt_addr(struct xe_lrc *lrc);
149 u32 xe_lrc_ctx_job_timestamp(struct xe_lrc *lrc);
150 int xe_lrc_setup_wa_bb_with_scratch(struct xe_lrc *lrc, struct xe_hw_engine *hwe,
151 				    u32 *scratch);
152 
153 /**
154  * xe_lrc_update_timestamp - readout LRC timestamp and update cached value
155  * @lrc: logical ring context for this exec queue
156  * @old_ts: pointer where to save the previous timestamp
157  *
158  * Read the current timestamp for this LRC and update the cached value. The
159  * previous cached value is also returned in @old_ts so the caller can calculate
160  * the delta between 2 updates. Note that this is not intended to be called from
161  * any place, but just by the paths updating the drm client utilization.
162  *
163  * Returns the current LRC timestamp
164  */
165 u64 xe_lrc_update_timestamp(struct xe_lrc *lrc, u64 *old_ts);
166 
167 u64 xe_lrc_timestamp(struct xe_lrc *lrc);
168 
169 #endif
170