2 * Copyright 2016 Advanced Micro Devices, Inc.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
22 * Authors: Christian König
24 #ifndef __AMDGPU_RING_H__
25 #define __AMDGPU_RING_H__
27 #include "gpu_scheduler.h"
29 /* max number of rings */
30 #define AMDGPU_MAX_RINGS 16
31 #define AMDGPU_MAX_GFX_RINGS 1
32 #define AMDGPU_MAX_COMPUTE_RINGS 8
33 #define AMDGPU_MAX_VCE_RINGS 3
35 /* some special values for the owner field */
36 #define AMDGPU_FENCE_OWNER_UNDEFINED ((void*)0ul)
37 #define AMDGPU_FENCE_OWNER_VM ((void*)1ul)
39 #define AMDGPU_FENCE_FLAG_64BIT (1 << 0)
40 #define AMDGPU_FENCE_FLAG_INT (1 << 1)
42 enum amdgpu_ring_type {
44 AMDGPU_RING_TYPE_COMPUTE,
45 AMDGPU_RING_TYPE_SDMA,
53 struct amdgpu_cs_parser;
58 struct amdgpu_fence_driver {
60 volatile uint32_t *cpu_addr;
61 /* sync_seq is protected by ring emission lock */
65 struct amdgpu_irq_src *irq_src;
67 struct timer_list fallback_timer;
68 unsigned num_fences_mask;
70 struct dma_fence **fences;
73 int amdgpu_fence_driver_init(struct amdgpu_device *adev);
74 void amdgpu_fence_driver_fini(struct amdgpu_device *adev);
75 void amdgpu_fence_driver_force_completion(struct amdgpu_device *adev);
77 int amdgpu_fence_driver_init_ring(struct amdgpu_ring *ring,
78 unsigned num_hw_submission);
79 int amdgpu_fence_driver_start_ring(struct amdgpu_ring *ring,
80 struct amdgpu_irq_src *irq_src,
82 void amdgpu_fence_driver_suspend(struct amdgpu_device *adev);
83 void amdgpu_fence_driver_resume(struct amdgpu_device *adev);
84 int amdgpu_fence_emit(struct amdgpu_ring *ring, struct dma_fence **fence);
85 void amdgpu_fence_process(struct amdgpu_ring *ring);
86 int amdgpu_fence_wait_empty(struct amdgpu_ring *ring);
87 unsigned amdgpu_fence_count_emitted(struct amdgpu_ring *ring);
93 /* provided by hw blocks that expose a ring buffer for commands */
94 struct amdgpu_ring_funcs {
95 enum amdgpu_ring_type type;
99 /* ring read/write ptr handling */
100 u32 (*get_rptr)(struct amdgpu_ring *ring);
101 u32 (*get_wptr)(struct amdgpu_ring *ring);
102 void (*set_wptr)(struct amdgpu_ring *ring);
103 /* validating and patching of IBs */
104 int (*parse_cs)(struct amdgpu_cs_parser *p, uint32_t ib_idx);
105 /* constants to calculate how many DW are needed for an emit */
106 unsigned emit_frame_size;
107 unsigned emit_ib_size;
108 /* command emit functions */
109 void (*emit_ib)(struct amdgpu_ring *ring,
110 struct amdgpu_ib *ib,
111 unsigned vm_id, bool ctx_switch);
112 void (*emit_fence)(struct amdgpu_ring *ring, uint64_t addr,
113 uint64_t seq, unsigned flags);
114 void (*emit_pipeline_sync)(struct amdgpu_ring *ring);
115 void (*emit_vm_flush)(struct amdgpu_ring *ring, unsigned vm_id,
117 void (*emit_hdp_flush)(struct amdgpu_ring *ring);
118 void (*emit_hdp_invalidate)(struct amdgpu_ring *ring);
119 void (*emit_gds_switch)(struct amdgpu_ring *ring, uint32_t vmid,
120 uint32_t gds_base, uint32_t gds_size,
121 uint32_t gws_base, uint32_t gws_size,
122 uint32_t oa_base, uint32_t oa_size);
123 /* testing functions */
124 int (*test_ring)(struct amdgpu_ring *ring);
125 int (*test_ib)(struct amdgpu_ring *ring, long timeout);
126 /* insert NOP packets */
127 void (*insert_nop)(struct amdgpu_ring *ring, uint32_t count);
128 /* pad the indirect buffer to the necessary number of dw */
129 void (*pad_ib)(struct amdgpu_ring *ring, struct amdgpu_ib *ib);
130 unsigned (*init_cond_exec)(struct amdgpu_ring *ring);
131 void (*patch_cond_exec)(struct amdgpu_ring *ring, unsigned offset);
132 /* note usage for clock and power gating */
133 void (*begin_use)(struct amdgpu_ring *ring);
134 void (*end_use)(struct amdgpu_ring *ring);
135 void (*emit_switch_buffer) (struct amdgpu_ring *ring);
136 void (*emit_cntxcntl) (struct amdgpu_ring *ring, uint32_t flags);
140 struct amdgpu_device *adev;
141 const struct amdgpu_ring_funcs *funcs;
142 struct amdgpu_fence_driver fence_drv;
143 struct amd_gpu_scheduler sched;
145 struct amdgpu_bo *ring_obj;
146 volatile uint32_t *ring;
160 struct amdgpu_bo *mqd_obj;
165 uint64_t current_ctx;
167 unsigned cond_exe_offs;
168 u64 cond_exe_gpu_addr;
169 volatile u32 *cond_exe_cpu_addr;
170 #if defined(CONFIG_DEBUG_FS)
175 int amdgpu_ring_alloc(struct amdgpu_ring *ring, unsigned ndw);
176 void amdgpu_ring_insert_nop(struct amdgpu_ring *ring, uint32_t count);
177 void amdgpu_ring_generic_pad_ib(struct amdgpu_ring *ring, struct amdgpu_ib *ib);
178 void amdgpu_ring_commit(struct amdgpu_ring *ring);
179 void amdgpu_ring_undo(struct amdgpu_ring *ring);
180 int amdgpu_ring_init(struct amdgpu_device *adev, struct amdgpu_ring *ring,
181 unsigned ring_size, struct amdgpu_irq_src *irq_src,
183 void amdgpu_ring_fini(struct amdgpu_ring *ring);