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