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