xref: /linux/drivers/gpu/drm/xe/xe_lrc.h (revision 7f71507851fc7764b36a3221839607d3a45c2025)
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_engine_class;
17 struct xe_gt;
18 struct xe_hw_engine;
19 struct xe_lrc;
20 struct xe_vm;
21 
22 struct xe_lrc_snapshot {
23 	struct xe_bo *lrc_bo;
24 	void *lrc_snapshot;
25 	unsigned long lrc_size, lrc_offset;
26 
27 	u32 context_desc;
28 	u32 indirect_context_desc;
29 	u32 head;
30 	struct {
31 		u32 internal;
32 		u32 memory;
33 	} tail;
34 	u32 start_seqno;
35 	u32 seqno;
36 	u32 ctx_timestamp;
37 	u32 ctx_job_timestamp;
38 };
39 
40 #define LRC_PPHWSP_SCRATCH_ADDR (0x34 * 4)
41 
42 struct xe_lrc *xe_lrc_create(struct xe_hw_engine *hwe, struct xe_vm *vm,
43 			     u32 ring_size);
44 void xe_lrc_destroy(struct kref *ref);
45 
46 /**
47  * xe_lrc_get - Get reference to the LRC
48  * @lrc: Logical Ring Context
49  *
50  * Increment reference count of @lrc
51  */
52 static inline struct xe_lrc *xe_lrc_get(struct xe_lrc *lrc)
53 {
54 	kref_get(&lrc->refcount);
55 	return lrc;
56 }
57 
58 /**
59  * xe_lrc_put - Put reference of the LRC
60  * @lrc: Logical Ring Context
61  *
62  * Decrement reference count of @lrc, call xe_lrc_destroy when
63  * reference count reaches 0.
64  */
65 static inline void xe_lrc_put(struct xe_lrc *lrc)
66 {
67 	kref_put(&lrc->refcount, xe_lrc_destroy);
68 }
69 
70 size_t xe_gt_lrc_size(struct xe_gt *gt, enum xe_engine_class class);
71 u32 xe_lrc_pphwsp_offset(struct xe_lrc *lrc);
72 u32 xe_lrc_regs_offset(struct xe_lrc *lrc);
73 
74 void xe_lrc_set_ring_tail(struct xe_lrc *lrc, u32 tail);
75 u32 xe_lrc_ring_tail(struct xe_lrc *lrc);
76 void xe_lrc_set_ring_head(struct xe_lrc *lrc, u32 head);
77 u32 xe_lrc_ring_head(struct xe_lrc *lrc);
78 u32 xe_lrc_ring_space(struct xe_lrc *lrc);
79 void xe_lrc_write_ring(struct xe_lrc *lrc, const void *data, size_t size);
80 
81 u32 xe_lrc_indirect_ring_ggtt_addr(struct xe_lrc *lrc);
82 u32 xe_lrc_ggtt_addr(struct xe_lrc *lrc);
83 u32 *xe_lrc_regs(struct xe_lrc *lrc);
84 
85 u32 xe_lrc_read_ctx_reg(struct xe_lrc *lrc, int reg_nr);
86 void xe_lrc_write_ctx_reg(struct xe_lrc *lrc, int reg_nr, u32 val);
87 
88 u64 xe_lrc_descriptor(struct xe_lrc *lrc);
89 
90 u32 xe_lrc_seqno_ggtt_addr(struct xe_lrc *lrc);
91 struct dma_fence *xe_lrc_alloc_seqno_fence(void);
92 void xe_lrc_free_seqno_fence(struct dma_fence *fence);
93 void xe_lrc_init_seqno_fence(struct xe_lrc *lrc, struct dma_fence *fence);
94 s32 xe_lrc_seqno(struct xe_lrc *lrc);
95 
96 u32 xe_lrc_start_seqno_ggtt_addr(struct xe_lrc *lrc);
97 s32 xe_lrc_start_seqno(struct xe_lrc *lrc);
98 
99 u32 xe_lrc_parallel_ggtt_addr(struct xe_lrc *lrc);
100 struct iosys_map xe_lrc_parallel_map(struct xe_lrc *lrc);
101 
102 size_t xe_lrc_skip_size(struct xe_device *xe);
103 
104 void xe_lrc_dump_default(struct drm_printer *p,
105 			 struct xe_gt *gt,
106 			 enum xe_engine_class);
107 
108 void xe_lrc_emit_hwe_state_instructions(struct xe_exec_queue *q, struct xe_bb *bb);
109 
110 struct xe_lrc_snapshot *xe_lrc_snapshot_capture(struct xe_lrc *lrc);
111 void xe_lrc_snapshot_capture_delayed(struct xe_lrc_snapshot *snapshot);
112 void xe_lrc_snapshot_print(struct xe_lrc_snapshot *snapshot, struct drm_printer *p);
113 void xe_lrc_snapshot_free(struct xe_lrc_snapshot *snapshot);
114 
115 u32 xe_lrc_ctx_timestamp_ggtt_addr(struct xe_lrc *lrc);
116 u32 xe_lrc_ctx_timestamp(struct xe_lrc *lrc);
117 u32 xe_lrc_ctx_job_timestamp_ggtt_addr(struct xe_lrc *lrc);
118 u32 xe_lrc_ctx_job_timestamp(struct xe_lrc *lrc);
119 
120 /**
121  * xe_lrc_update_timestamp - readout LRC timestamp and update cached value
122  * @lrc: logical ring context for this exec queue
123  * @old_ts: pointer where to save the previous timestamp
124  *
125  * Read the current timestamp for this LRC and update the cached value. The
126  * previous cached value is also returned in @old_ts so the caller can calculate
127  * the delta between 2 updates. Note that this is not intended to be called from
128  * any place, but just by the paths updating the drm client utilization.
129  *
130  * Returns the current LRC timestamp
131  */
132 u32 xe_lrc_update_timestamp(struct xe_lrc *lrc, u32 *old_ts);
133 
134 #endif
135