2 * Copyright 2008 Advanced Micro Devices, Inc.
3 * Copyright 2008 Red Hat Inc.
4 * Copyright 2009 Jerome Glisse.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
24 * Authors: Dave Airlie
29 #include <linux/seq_file.h>
30 #include <linux/slab.h>
31 #include <linux/uaccess.h>
32 #include <linux/debugfs.h>
34 #include <drm/amdgpu_drm.h>
40 * Most engines on the GPU are fed via ring buffers. Ring
41 * buffers are areas of GPU accessible memory that the host
42 * writes commands into and the GPU reads commands out of.
43 * There is a rptr (read pointer) that determines where the
44 * GPU is currently reading, and a wptr (write pointer)
45 * which determines where the host has written. When the
46 * pointers are equal, the ring is idle. When the host
47 * writes commands to the ring buffer, it increments the
48 * wptr. The GPU then starts fetching commands and executes
49 * them until the pointers are equal again.
53 * amdgpu_ring_alloc - allocate space on the ring buffer
55 * @ring: amdgpu_ring structure holding ring information
56 * @ndw: number of dwords to allocate in the ring buffer
58 * Allocate @ndw dwords in the ring buffer (all asics).
59 * Returns 0 on success, error on failure.
61 int amdgpu_ring_alloc(struct amdgpu_ring *ring, unsigned ndw)
63 /* Align requested size with padding so unlock_commit can
65 ndw = (ndw + ring->funcs->align_mask) & ~ring->funcs->align_mask;
67 /* Make sure we aren't trying to allocate more space
68 * than the maximum for one submission
70 if (WARN_ON_ONCE(ndw > ring->max_dw))
74 ring->wptr_old = ring->wptr;
76 if (ring->funcs->begin_use)
77 ring->funcs->begin_use(ring);
82 /** amdgpu_ring_insert_nop - insert NOP packets
84 * @ring: amdgpu_ring structure holding ring information
85 * @count: the number of NOP packets to insert
87 * This is the generic insert_nop function for rings except SDMA
89 void amdgpu_ring_insert_nop(struct amdgpu_ring *ring, uint32_t count)
93 for (i = 0; i < count; i++)
94 amdgpu_ring_write(ring, ring->funcs->nop);
98 * amdgpu_ring_generic_pad_ib - pad IB with NOP packets
100 * @ring: amdgpu_ring structure holding ring information
101 * @ib: IB to add NOP packets to
103 * This is the generic pad_ib function for rings except SDMA
105 void amdgpu_ring_generic_pad_ib(struct amdgpu_ring *ring, struct amdgpu_ib *ib)
107 while (ib->length_dw & ring->funcs->align_mask)
108 ib->ptr[ib->length_dw++] = ring->funcs->nop;
112 * amdgpu_ring_commit - tell the GPU to execute the new
113 * commands on the ring buffer
115 * @ring: amdgpu_ring structure holding ring information
117 * Update the wptr (write pointer) to tell the GPU to
118 * execute new commands on the ring buffer (all asics).
120 void amdgpu_ring_commit(struct amdgpu_ring *ring)
124 /* We pad to match fetch size */
125 count = ring->funcs->align_mask + 1 -
126 (ring->wptr & ring->funcs->align_mask);
127 count %= ring->funcs->align_mask + 1;
128 ring->funcs->insert_nop(ring, count);
131 amdgpu_ring_set_wptr(ring);
133 if (ring->funcs->end_use)
134 ring->funcs->end_use(ring);
138 * amdgpu_ring_undo - reset the wptr
140 * @ring: amdgpu_ring structure holding ring information
142 * Reset the driver's copy of the wptr (all asics).
144 void amdgpu_ring_undo(struct amdgpu_ring *ring)
146 ring->wptr = ring->wptr_old;
148 if (ring->funcs->end_use)
149 ring->funcs->end_use(ring);
152 #define amdgpu_ring_get_gpu_addr(ring, offset) \
153 (ring->is_mes_queue ? \
154 (ring->mes_ctx->meta_data_gpu_addr + offset) : \
155 (ring->adev->wb.gpu_addr + offset * 4))
157 #define amdgpu_ring_get_cpu_addr(ring, offset) \
158 (ring->is_mes_queue ? \
159 (void *)((uint8_t *)(ring->mes_ctx->meta_data_ptr) + offset) : \
160 (&ring->adev->wb.wb[offset]))
163 * amdgpu_ring_init - init driver ring struct.
165 * @adev: amdgpu_device pointer
166 * @ring: amdgpu_ring structure holding ring information
167 * @max_dw: maximum number of dw for ring alloc
168 * @irq_src: interrupt source to use for this ring
169 * @irq_type: interrupt type to use for this ring
170 * @hw_prio: ring priority (NORMAL/HIGH)
171 * @sched_score: optional score atomic shared with other schedulers
173 * Initialize the driver information for the selected ring (all asics).
174 * Returns 0 on success, error on failure.
176 int amdgpu_ring_init(struct amdgpu_device *adev, struct amdgpu_ring *ring,
177 unsigned int max_dw, struct amdgpu_irq_src *irq_src,
178 unsigned int irq_type, unsigned int hw_prio,
179 atomic_t *sched_score)
182 int sched_hw_submission = amdgpu_sched_hw_submission;
186 /* Set the hw submission limit higher for KIQ because
187 * it's used for a number of gfx/compute tasks by both
188 * KFD and KGD which may have outstanding fences and
189 * it doesn't really use the gpu scheduler anyway;
190 * KIQ tasks get submitted directly to the ring.
192 if (ring->funcs->type == AMDGPU_RING_TYPE_KIQ)
193 sched_hw_submission = max(sched_hw_submission, 256);
194 else if (ring == &adev->sdma.instance[0].page)
195 sched_hw_submission = 256;
197 if (ring->adev == NULL) {
198 if (adev->num_rings >= AMDGPU_MAX_RINGS)
202 ring->num_hw_submission = sched_hw_submission;
203 ring->sched_score = sched_score;
204 ring->vmid_wait = dma_fence_get_stub();
206 if (!ring->is_mes_queue) {
207 ring->idx = adev->num_rings++;
208 adev->rings[ring->idx] = ring;
211 r = amdgpu_fence_driver_init_ring(ring);
216 if (ring->is_mes_queue) {
217 ring->rptr_offs = amdgpu_mes_ctx_get_offs(ring,
218 AMDGPU_MES_CTX_RPTR_OFFS);
219 ring->wptr_offs = amdgpu_mes_ctx_get_offs(ring,
220 AMDGPU_MES_CTX_WPTR_OFFS);
221 ring->fence_offs = amdgpu_mes_ctx_get_offs(ring,
222 AMDGPU_MES_CTX_FENCE_OFFS);
223 ring->trail_fence_offs = amdgpu_mes_ctx_get_offs(ring,
224 AMDGPU_MES_CTX_TRAIL_FENCE_OFFS);
225 ring->cond_exe_offs = amdgpu_mes_ctx_get_offs(ring,
226 AMDGPU_MES_CTX_COND_EXE_OFFS);
228 r = amdgpu_device_wb_get(adev, &ring->rptr_offs);
230 dev_err(adev->dev, "(%d) ring rptr_offs wb alloc failed\n", r);
234 r = amdgpu_device_wb_get(adev, &ring->wptr_offs);
236 dev_err(adev->dev, "(%d) ring wptr_offs wb alloc failed\n", r);
240 r = amdgpu_device_wb_get(adev, &ring->fence_offs);
242 dev_err(adev->dev, "(%d) ring fence_offs wb alloc failed\n", r);
246 r = amdgpu_device_wb_get(adev, &ring->trail_fence_offs);
248 dev_err(adev->dev, "(%d) ring trail_fence_offs wb alloc failed\n", r);
252 r = amdgpu_device_wb_get(adev, &ring->cond_exe_offs);
254 dev_err(adev->dev, "(%d) ring cond_exec_polling wb alloc failed\n", r);
259 ring->fence_gpu_addr =
260 amdgpu_ring_get_gpu_addr(ring, ring->fence_offs);
261 ring->fence_cpu_addr =
262 amdgpu_ring_get_cpu_addr(ring, ring->fence_offs);
264 ring->rptr_gpu_addr =
265 amdgpu_ring_get_gpu_addr(ring, ring->rptr_offs);
266 ring->rptr_cpu_addr =
267 amdgpu_ring_get_cpu_addr(ring, ring->rptr_offs);
269 ring->wptr_gpu_addr =
270 amdgpu_ring_get_gpu_addr(ring, ring->wptr_offs);
271 ring->wptr_cpu_addr =
272 amdgpu_ring_get_cpu_addr(ring, ring->wptr_offs);
274 ring->trail_fence_gpu_addr =
275 amdgpu_ring_get_gpu_addr(ring, ring->trail_fence_offs);
276 ring->trail_fence_cpu_addr =
277 amdgpu_ring_get_cpu_addr(ring, ring->trail_fence_offs);
279 ring->cond_exe_gpu_addr =
280 amdgpu_ring_get_gpu_addr(ring, ring->cond_exe_offs);
281 ring->cond_exe_cpu_addr =
282 amdgpu_ring_get_cpu_addr(ring, ring->cond_exe_offs);
284 /* always set cond_exec_polling to CONTINUE */
285 *ring->cond_exe_cpu_addr = 1;
287 r = amdgpu_fence_driver_start_ring(ring, irq_src, irq_type);
289 dev_err(adev->dev, "failed initializing fences (%d).\n", r);
293 ring->ring_size = roundup_pow_of_two(max_dw * 4 * sched_hw_submission);
295 ring->buf_mask = (ring->ring_size / 4) - 1;
296 ring->ptr_mask = ring->funcs->support_64bit_ptrs ?
297 0xffffffffffffffff : ring->buf_mask;
299 /* Allocate ring buffer */
300 if (ring->is_mes_queue) {
303 BUG_ON(ring->ring_size > PAGE_SIZE*4);
305 offset = amdgpu_mes_ctx_get_offs(ring,
306 AMDGPU_MES_CTX_RING_OFFS);
307 ring->gpu_addr = amdgpu_mes_ctx_get_offs_gpu_addr(ring, offset);
308 ring->ring = amdgpu_mes_ctx_get_offs_cpu_addr(ring, offset);
309 amdgpu_ring_clear_ring(ring);
311 } else if (ring->ring_obj == NULL) {
312 r = amdgpu_bo_create_kernel(adev, ring->ring_size + ring->funcs->extra_dw, PAGE_SIZE,
313 AMDGPU_GEM_DOMAIN_GTT,
316 (void **)&ring->ring);
318 dev_err(adev->dev, "(%d) ring create failed\n", r);
321 amdgpu_ring_clear_ring(ring);
324 ring->max_dw = max_dw;
325 ring->hw_prio = hw_prio;
327 if (!ring->no_scheduler) {
328 hw_ip = ring->funcs->type;
329 num_sched = &adev->gpu_sched[hw_ip][hw_prio].num_scheds;
330 adev->gpu_sched[hw_ip][hw_prio].sched[(*num_sched)++] =
338 * amdgpu_ring_fini - tear down the driver ring struct.
340 * @ring: amdgpu_ring structure holding ring information
342 * Tear down the driver information for the selected ring (all asics).
344 void amdgpu_ring_fini(struct amdgpu_ring *ring)
347 /* Not to finish a ring which is not initialized */
349 (!ring->is_mes_queue && !(ring->adev->rings[ring->idx])))
352 ring->sched.ready = false;
354 if (!ring->is_mes_queue) {
355 amdgpu_device_wb_free(ring->adev, ring->rptr_offs);
356 amdgpu_device_wb_free(ring->adev, ring->wptr_offs);
358 amdgpu_device_wb_free(ring->adev, ring->cond_exe_offs);
359 amdgpu_device_wb_free(ring->adev, ring->fence_offs);
361 amdgpu_bo_free_kernel(&ring->ring_obj,
363 (void **)&ring->ring);
366 dma_fence_put(ring->vmid_wait);
367 ring->vmid_wait = NULL;
370 if (!ring->is_mes_queue)
371 ring->adev->rings[ring->idx] = NULL;
375 * amdgpu_ring_emit_reg_write_reg_wait_helper - ring helper
377 * @ring: ring to write to
378 * @reg0: register to write
379 * @reg1: register to wait on
380 * @ref: reference value to write/wait on
381 * @mask: mask to wait on
383 * Helper for rings that don't support write and wait in a
384 * single oneshot packet.
386 void amdgpu_ring_emit_reg_write_reg_wait_helper(struct amdgpu_ring *ring,
387 uint32_t reg0, uint32_t reg1,
388 uint32_t ref, uint32_t mask)
390 amdgpu_ring_emit_wreg(ring, reg0, ref);
391 amdgpu_ring_emit_reg_wait(ring, reg1, mask, mask);
395 * amdgpu_ring_soft_recovery - try to soft recover a ring lockup
397 * @ring: ring to try the recovery on
398 * @vmid: VMID we try to get going again
399 * @fence: timedout fence
401 * Tries to get a ring proceeding again when it is stuck.
403 bool amdgpu_ring_soft_recovery(struct amdgpu_ring *ring, unsigned int vmid,
404 struct dma_fence *fence)
406 ktime_t deadline = ktime_add_us(ktime_get(), 10000);
408 if (amdgpu_sriov_vf(ring->adev) || !ring->funcs->soft_recovery || !fence)
411 atomic_inc(&ring->adev->gpu_reset_counter);
412 while (!dma_fence_is_signaled(fence) &&
413 ktime_to_ns(ktime_sub(deadline, ktime_get())) > 0)
414 ring->funcs->soft_recovery(ring, vmid);
416 return dma_fence_is_signaled(fence);
422 #if defined(CONFIG_DEBUG_FS)
424 /* Layout of file is 12 bytes consisting of
427 * - driver's copy of wptr
429 * followed by n-words of ring data
431 static ssize_t amdgpu_debugfs_ring_read(struct file *f, char __user *buf,
432 size_t size, loff_t *pos)
434 struct amdgpu_ring *ring = file_inode(f)->i_private;
436 uint32_t value, result, early[3];
438 if (*pos & 3 || size & 3)
444 early[0] = amdgpu_ring_get_rptr(ring) & ring->buf_mask;
445 early[1] = amdgpu_ring_get_wptr(ring) & ring->buf_mask;
446 early[2] = ring->wptr & ring->buf_mask;
447 for (i = *pos / 4; i < 3 && size; i++) {
448 r = put_user(early[i], (uint32_t *)buf);
459 if (*pos >= (ring->ring_size + 12))
462 value = ring->ring[(*pos - 12)/4];
463 r = put_user(value, (uint32_t *)buf);
475 static const struct file_operations amdgpu_debugfs_ring_fops = {
476 .owner = THIS_MODULE,
477 .read = amdgpu_debugfs_ring_read,
478 .llseek = default_llseek
483 void amdgpu_debugfs_ring_init(struct amdgpu_device *adev,
484 struct amdgpu_ring *ring)
486 #if defined(CONFIG_DEBUG_FS)
487 struct drm_minor *minor = adev_to_drm(adev)->primary;
488 struct dentry *root = minor->debugfs_root;
491 sprintf(name, "amdgpu_ring_%s", ring->name);
492 debugfs_create_file_size(name, S_IFREG | S_IRUGO, root, ring,
493 &amdgpu_debugfs_ring_fops,
494 ring->ring_size + 12);
500 * amdgpu_ring_test_helper - tests ring and set sched readiness status
502 * @ring: ring to try the recovery on
504 * Tests ring and set sched readiness status
506 * Returns 0 on success, error on failure.
508 int amdgpu_ring_test_helper(struct amdgpu_ring *ring)
510 struct amdgpu_device *adev = ring->adev;
513 r = amdgpu_ring_test_ring(ring);
515 DRM_DEV_ERROR(adev->dev, "ring %s test failed (%d)\n",
518 DRM_DEV_DEBUG(adev->dev, "ring test on %s succeeded\n",
521 ring->sched.ready = !r;
525 static void amdgpu_ring_to_mqd_prop(struct amdgpu_ring *ring,
526 struct amdgpu_mqd_prop *prop)
528 struct amdgpu_device *adev = ring->adev;
530 memset(prop, 0, sizeof(*prop));
532 prop->mqd_gpu_addr = ring->mqd_gpu_addr;
533 prop->hqd_base_gpu_addr = ring->gpu_addr;
534 prop->rptr_gpu_addr = ring->rptr_gpu_addr;
535 prop->wptr_gpu_addr = ring->wptr_gpu_addr;
536 prop->queue_size = ring->ring_size;
537 prop->eop_gpu_addr = ring->eop_gpu_addr;
538 prop->use_doorbell = ring->use_doorbell;
539 prop->doorbell_index = ring->doorbell_index;
541 /* map_queues packet doesn't need activate the queue,
542 * so only kiq need set this field.
544 prop->hqd_active = ring->funcs->type == AMDGPU_RING_TYPE_KIQ;
546 if (ring->funcs->type == AMDGPU_RING_TYPE_COMPUTE) {
547 if (amdgpu_gfx_is_high_priority_compute_queue(adev, ring)) {
548 prop->hqd_pipe_priority = AMDGPU_GFX_PIPE_PRIO_HIGH;
549 prop->hqd_queue_priority =
550 AMDGPU_GFX_QUEUE_PRIORITY_MAXIMUM;
555 int amdgpu_ring_init_mqd(struct amdgpu_ring *ring)
557 struct amdgpu_device *adev = ring->adev;
558 struct amdgpu_mqd *mqd_mgr;
559 struct amdgpu_mqd_prop prop;
561 amdgpu_ring_to_mqd_prop(ring, &prop);
565 if (ring->funcs->type == AMDGPU_RING_TYPE_KIQ)
566 mqd_mgr = &adev->mqds[AMDGPU_HW_IP_COMPUTE];
568 mqd_mgr = &adev->mqds[ring->funcs->type];
570 return mqd_mgr->init_mqd(adev, ring->mqd_ptr, &prop);