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