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_max_ibs - Return max IBs that fit in a single submission.
55 * @type: ring type for which to return the limit.
57 unsigned int amdgpu_ring_max_ibs(enum amdgpu_ring_type type)
60 case AMDGPU_RING_TYPE_GFX:
61 /* Need to keep at least 192 on GFX7+ for old radv. */
63 case AMDGPU_RING_TYPE_COMPUTE:
65 case AMDGPU_RING_TYPE_VCN_JPEG:
73 * amdgpu_ring_alloc - allocate space on the ring buffer
75 * @ring: amdgpu_ring structure holding ring information
76 * @ndw: number of dwords to allocate in the ring buffer
78 * Allocate @ndw dwords in the ring buffer (all asics).
79 * Returns 0 on success, error on failure.
81 int amdgpu_ring_alloc(struct amdgpu_ring *ring, unsigned int ndw)
83 /* Align requested size with padding so unlock_commit can
85 ndw = (ndw + ring->funcs->align_mask) & ~ring->funcs->align_mask;
87 /* Make sure we aren't trying to allocate more space
88 * than the maximum for one submission
90 if (WARN_ON_ONCE(ndw > ring->max_dw))
94 ring->wptr_old = ring->wptr;
96 if (ring->funcs->begin_use)
97 ring->funcs->begin_use(ring);
102 /** amdgpu_ring_insert_nop - insert NOP packets
104 * @ring: amdgpu_ring structure holding ring information
105 * @count: the number of NOP packets to insert
107 * This is the generic insert_nop function for rings except SDMA
109 void amdgpu_ring_insert_nop(struct amdgpu_ring *ring, uint32_t count)
113 for (i = 0; i < count; i++)
114 amdgpu_ring_write(ring, ring->funcs->nop);
118 * amdgpu_ring_generic_pad_ib - pad IB with NOP packets
120 * @ring: amdgpu_ring structure holding ring information
121 * @ib: IB to add NOP packets to
123 * This is the generic pad_ib function for rings except SDMA
125 void amdgpu_ring_generic_pad_ib(struct amdgpu_ring *ring, struct amdgpu_ib *ib)
127 while (ib->length_dw & ring->funcs->align_mask)
128 ib->ptr[ib->length_dw++] = ring->funcs->nop;
132 * amdgpu_ring_commit - tell the GPU to execute the new
133 * commands on the ring buffer
135 * @ring: amdgpu_ring structure holding ring information
137 * Update the wptr (write pointer) to tell the GPU to
138 * execute new commands on the ring buffer (all asics).
140 void amdgpu_ring_commit(struct amdgpu_ring *ring)
144 /* We pad to match fetch size */
145 count = ring->funcs->align_mask + 1 -
146 (ring->wptr & ring->funcs->align_mask);
147 count &= ring->funcs->align_mask;
150 ring->funcs->insert_nop(ring, count);
153 amdgpu_ring_set_wptr(ring);
155 if (ring->funcs->end_use)
156 ring->funcs->end_use(ring);
160 * amdgpu_ring_undo - reset the wptr
162 * @ring: amdgpu_ring structure holding ring information
164 * Reset the driver's copy of the wptr (all asics).
166 void amdgpu_ring_undo(struct amdgpu_ring *ring)
168 ring->wptr = ring->wptr_old;
170 if (ring->funcs->end_use)
171 ring->funcs->end_use(ring);
174 #define amdgpu_ring_get_gpu_addr(ring, offset) \
175 (ring->is_mes_queue ? \
176 (ring->mes_ctx->meta_data_gpu_addr + offset) : \
177 (ring->adev->wb.gpu_addr + offset * 4))
179 #define amdgpu_ring_get_cpu_addr(ring, offset) \
180 (ring->is_mes_queue ? \
181 (void *)((uint8_t *)(ring->mes_ctx->meta_data_ptr) + offset) : \
182 (&ring->adev->wb.wb[offset]))
185 * amdgpu_ring_init - init driver ring struct.
187 * @adev: amdgpu_device pointer
188 * @ring: amdgpu_ring structure holding ring information
189 * @max_dw: maximum number of dw for ring alloc
190 * @irq_src: interrupt source to use for this ring
191 * @irq_type: interrupt type to use for this ring
192 * @hw_prio: ring priority (NORMAL/HIGH)
193 * @sched_score: optional score atomic shared with other schedulers
195 * Initialize the driver information for the selected ring (all asics).
196 * Returns 0 on success, error on failure.
198 int amdgpu_ring_init(struct amdgpu_device *adev, struct amdgpu_ring *ring,
199 unsigned int max_dw, struct amdgpu_irq_src *irq_src,
200 unsigned int irq_type, unsigned int hw_prio,
201 atomic_t *sched_score)
204 int sched_hw_submission = amdgpu_sched_hw_submission;
207 unsigned int max_ibs_dw;
209 /* Set the hw submission limit higher for KIQ because
210 * it's used for a number of gfx/compute tasks by both
211 * KFD and KGD which may have outstanding fences and
212 * it doesn't really use the gpu scheduler anyway;
213 * KIQ tasks get submitted directly to the ring.
215 if (ring->funcs->type == AMDGPU_RING_TYPE_KIQ)
216 sched_hw_submission = max(sched_hw_submission, 256);
217 if (ring->funcs->type == AMDGPU_RING_TYPE_MES)
218 sched_hw_submission = 8;
219 else if (ring == &adev->sdma.instance[0].page)
220 sched_hw_submission = 256;
222 if (ring->adev == NULL) {
223 if (adev->num_rings >= AMDGPU_MAX_RINGS)
227 ring->num_hw_submission = sched_hw_submission;
228 ring->sched_score = sched_score;
229 ring->vmid_wait = dma_fence_get_stub();
231 if (!ring->is_mes_queue) {
232 ring->idx = adev->num_rings++;
233 adev->rings[ring->idx] = ring;
236 r = amdgpu_fence_driver_init_ring(ring);
241 if (ring->is_mes_queue) {
242 ring->rptr_offs = amdgpu_mes_ctx_get_offs(ring,
243 AMDGPU_MES_CTX_RPTR_OFFS);
244 ring->wptr_offs = amdgpu_mes_ctx_get_offs(ring,
245 AMDGPU_MES_CTX_WPTR_OFFS);
246 ring->fence_offs = amdgpu_mes_ctx_get_offs(ring,
247 AMDGPU_MES_CTX_FENCE_OFFS);
248 ring->trail_fence_offs = amdgpu_mes_ctx_get_offs(ring,
249 AMDGPU_MES_CTX_TRAIL_FENCE_OFFS);
250 ring->cond_exe_offs = amdgpu_mes_ctx_get_offs(ring,
251 AMDGPU_MES_CTX_COND_EXE_OFFS);
253 r = amdgpu_device_wb_get(adev, &ring->rptr_offs);
255 dev_err(adev->dev, "(%d) ring rptr_offs wb alloc failed\n", r);
259 r = amdgpu_device_wb_get(adev, &ring->wptr_offs);
261 dev_err(adev->dev, "(%d) ring wptr_offs wb alloc failed\n", r);
265 r = amdgpu_device_wb_get(adev, &ring->fence_offs);
267 dev_err(adev->dev, "(%d) ring fence_offs wb alloc failed\n", r);
271 r = amdgpu_device_wb_get(adev, &ring->trail_fence_offs);
273 dev_err(adev->dev, "(%d) ring trail_fence_offs wb alloc failed\n", r);
277 r = amdgpu_device_wb_get(adev, &ring->cond_exe_offs);
279 dev_err(adev->dev, "(%d) ring cond_exec_polling wb alloc failed\n", r);
284 ring->fence_gpu_addr =
285 amdgpu_ring_get_gpu_addr(ring, ring->fence_offs);
286 ring->fence_cpu_addr =
287 amdgpu_ring_get_cpu_addr(ring, ring->fence_offs);
289 ring->rptr_gpu_addr =
290 amdgpu_ring_get_gpu_addr(ring, ring->rptr_offs);
291 ring->rptr_cpu_addr =
292 amdgpu_ring_get_cpu_addr(ring, ring->rptr_offs);
294 ring->wptr_gpu_addr =
295 amdgpu_ring_get_gpu_addr(ring, ring->wptr_offs);
296 ring->wptr_cpu_addr =
297 amdgpu_ring_get_cpu_addr(ring, ring->wptr_offs);
299 ring->trail_fence_gpu_addr =
300 amdgpu_ring_get_gpu_addr(ring, ring->trail_fence_offs);
301 ring->trail_fence_cpu_addr =
302 amdgpu_ring_get_cpu_addr(ring, ring->trail_fence_offs);
304 ring->cond_exe_gpu_addr =
305 amdgpu_ring_get_gpu_addr(ring, ring->cond_exe_offs);
306 ring->cond_exe_cpu_addr =
307 amdgpu_ring_get_cpu_addr(ring, ring->cond_exe_offs);
309 /* always set cond_exec_polling to CONTINUE */
310 *ring->cond_exe_cpu_addr = 1;
312 r = amdgpu_fence_driver_start_ring(ring, irq_src, irq_type);
314 dev_err(adev->dev, "failed initializing fences (%d).\n", r);
318 max_ibs_dw = ring->funcs->emit_frame_size +
319 amdgpu_ring_max_ibs(ring->funcs->type) * ring->funcs->emit_ib_size;
320 max_ibs_dw = (max_ibs_dw + ring->funcs->align_mask) & ~ring->funcs->align_mask;
322 if (WARN_ON(max_ibs_dw > max_dw))
325 ring->ring_size = roundup_pow_of_two(max_dw * 4 * sched_hw_submission);
327 ring->buf_mask = (ring->ring_size / 4) - 1;
328 ring->ptr_mask = ring->funcs->support_64bit_ptrs ?
329 0xffffffffffffffff : ring->buf_mask;
331 /* Allocate ring buffer */
332 if (ring->is_mes_queue) {
335 BUG_ON(ring->ring_size > PAGE_SIZE*4);
337 offset = amdgpu_mes_ctx_get_offs(ring,
338 AMDGPU_MES_CTX_RING_OFFS);
339 ring->gpu_addr = amdgpu_mes_ctx_get_offs_gpu_addr(ring, offset);
340 ring->ring = amdgpu_mes_ctx_get_offs_cpu_addr(ring, offset);
341 amdgpu_ring_clear_ring(ring);
343 } else if (ring->ring_obj == NULL) {
344 r = amdgpu_bo_create_kernel(adev, ring->ring_size + ring->funcs->extra_dw, PAGE_SIZE,
345 AMDGPU_GEM_DOMAIN_GTT,
348 (void **)&ring->ring);
350 dev_err(adev->dev, "(%d) ring create failed\n", r);
353 amdgpu_ring_clear_ring(ring);
356 ring->max_dw = max_dw;
357 ring->hw_prio = hw_prio;
359 if (!ring->no_scheduler && ring->funcs->type < AMDGPU_HW_IP_NUM) {
360 hw_ip = ring->funcs->type;
361 num_sched = &adev->gpu_sched[hw_ip][hw_prio].num_scheds;
362 adev->gpu_sched[hw_ip][hw_prio].sched[(*num_sched)++] =
370 * amdgpu_ring_fini - tear down the driver ring struct.
372 * @ring: amdgpu_ring structure holding ring information
374 * Tear down the driver information for the selected ring (all asics).
376 void amdgpu_ring_fini(struct amdgpu_ring *ring)
379 /* Not to finish a ring which is not initialized */
381 (!ring->is_mes_queue && !(ring->adev->rings[ring->idx])))
384 ring->sched.ready = false;
386 if (!ring->is_mes_queue) {
387 amdgpu_device_wb_free(ring->adev, ring->rptr_offs);
388 amdgpu_device_wb_free(ring->adev, ring->wptr_offs);
390 amdgpu_device_wb_free(ring->adev, ring->cond_exe_offs);
391 amdgpu_device_wb_free(ring->adev, ring->fence_offs);
393 amdgpu_bo_free_kernel(&ring->ring_obj,
395 (void **)&ring->ring);
397 kfree(ring->fence_drv.fences);
400 dma_fence_put(ring->vmid_wait);
401 ring->vmid_wait = NULL;
404 if (!ring->is_mes_queue)
405 ring->adev->rings[ring->idx] = NULL;
409 * amdgpu_ring_emit_reg_write_reg_wait_helper - ring helper
411 * @ring: ring to write to
412 * @reg0: register to write
413 * @reg1: register to wait on
414 * @ref: reference value to write/wait on
415 * @mask: mask to wait on
417 * Helper for rings that don't support write and wait in a
418 * single oneshot packet.
420 void amdgpu_ring_emit_reg_write_reg_wait_helper(struct amdgpu_ring *ring,
421 uint32_t reg0, uint32_t reg1,
422 uint32_t ref, uint32_t mask)
424 amdgpu_ring_emit_wreg(ring, reg0, ref);
425 amdgpu_ring_emit_reg_wait(ring, reg1, mask, mask);
429 * amdgpu_ring_soft_recovery - try to soft recover a ring lockup
431 * @ring: ring to try the recovery on
432 * @vmid: VMID we try to get going again
433 * @fence: timedout fence
435 * Tries to get a ring proceeding again when it is stuck.
437 bool amdgpu_ring_soft_recovery(struct amdgpu_ring *ring, unsigned int vmid,
438 struct dma_fence *fence)
443 if (unlikely(ring->adev->debug_disable_soft_recovery))
446 deadline = ktime_add_us(ktime_get(), 10000);
448 if (amdgpu_sriov_vf(ring->adev) || !ring->funcs->soft_recovery || !fence)
451 spin_lock_irqsave(fence->lock, flags);
452 if (!dma_fence_is_signaled_locked(fence))
453 dma_fence_set_error(fence, -ENODATA);
454 spin_unlock_irqrestore(fence->lock, flags);
456 atomic_inc(&ring->adev->gpu_reset_counter);
457 while (!dma_fence_is_signaled(fence) &&
458 ktime_to_ns(ktime_sub(deadline, ktime_get())) > 0)
459 ring->funcs->soft_recovery(ring, vmid);
461 return dma_fence_is_signaled(fence);
467 #if defined(CONFIG_DEBUG_FS)
469 /* Layout of file is 12 bytes consisting of
472 * - driver's copy of wptr
474 * followed by n-words of ring data
476 static ssize_t amdgpu_debugfs_ring_read(struct file *f, char __user *buf,
477 size_t size, loff_t *pos)
479 struct amdgpu_ring *ring = file_inode(f)->i_private;
480 uint32_t value, result, early[3];
484 if (*pos & 3 || size & 3)
490 early[0] = amdgpu_ring_get_rptr(ring) & ring->buf_mask;
491 early[1] = amdgpu_ring_get_wptr(ring) & ring->buf_mask;
492 early[2] = ring->wptr & ring->buf_mask;
493 for (i = *pos / 4; i < 3 && size; i++) {
494 r = put_user(early[i], (uint32_t *)buf);
505 if (*pos >= (ring->ring_size + 12))
508 value = ring->ring[(*pos - 12)/4];
509 r = put_user(value, (uint32_t *)buf);
521 static const struct file_operations amdgpu_debugfs_ring_fops = {
522 .owner = THIS_MODULE,
523 .read = amdgpu_debugfs_ring_read,
524 .llseek = default_llseek
527 static ssize_t amdgpu_debugfs_mqd_read(struct file *f, char __user *buf,
528 size_t size, loff_t *pos)
530 struct amdgpu_ring *ring = file_inode(f)->i_private;
534 uint32_t value, result;
536 if (*pos & 3 || size & 3)
539 kbuf = kmalloc(ring->mqd_size, GFP_KERNEL);
543 r = amdgpu_bo_reserve(ring->mqd_obj, false);
544 if (unlikely(r != 0))
547 r = amdgpu_bo_kmap(ring->mqd_obj, (void **)&mqd);
552 * Copy to local buffer to avoid put_user(), which might fault
553 * and acquire mmap_sem, under reservation_ww_class_mutex.
555 for (i = 0; i < ring->mqd_size/sizeof(u32); i++)
558 amdgpu_bo_kunmap(ring->mqd_obj);
559 amdgpu_bo_unreserve(ring->mqd_obj);
563 if (*pos >= ring->mqd_size)
566 value = kbuf[*pos/4];
567 r = put_user(value, (uint32_t *)buf);
580 amdgpu_bo_unreserve(ring->mqd_obj);
586 static const struct file_operations amdgpu_debugfs_mqd_fops = {
587 .owner = THIS_MODULE,
588 .read = amdgpu_debugfs_mqd_read,
589 .llseek = default_llseek
592 static int amdgpu_debugfs_ring_error(void *data, u64 val)
594 struct amdgpu_ring *ring = data;
596 amdgpu_fence_driver_set_error(ring, val);
600 DEFINE_DEBUGFS_ATTRIBUTE_SIGNED(amdgpu_debugfs_error_fops, NULL,
601 amdgpu_debugfs_ring_error, "%lld\n");
605 void amdgpu_debugfs_ring_init(struct amdgpu_device *adev,
606 struct amdgpu_ring *ring)
608 #if defined(CONFIG_DEBUG_FS)
609 struct drm_minor *minor = adev_to_drm(adev)->primary;
610 struct dentry *root = minor->debugfs_root;
613 sprintf(name, "amdgpu_ring_%s", ring->name);
614 debugfs_create_file_size(name, S_IFREG | 0444, root, ring,
615 &amdgpu_debugfs_ring_fops,
616 ring->ring_size + 12);
619 sprintf(name, "amdgpu_mqd_%s", ring->name);
620 debugfs_create_file_size(name, S_IFREG | 0444, root, ring,
621 &amdgpu_debugfs_mqd_fops,
625 sprintf(name, "amdgpu_error_%s", ring->name);
626 debugfs_create_file(name, 0200, root, ring,
627 &amdgpu_debugfs_error_fops);
633 * amdgpu_ring_test_helper - tests ring and set sched readiness status
635 * @ring: ring to try the recovery on
637 * Tests ring and set sched readiness status
639 * Returns 0 on success, error on failure.
641 int amdgpu_ring_test_helper(struct amdgpu_ring *ring)
643 struct amdgpu_device *adev = ring->adev;
646 r = amdgpu_ring_test_ring(ring);
648 DRM_DEV_ERROR(adev->dev, "ring %s test failed (%d)\n",
651 DRM_DEV_DEBUG(adev->dev, "ring test on %s succeeded\n",
654 ring->sched.ready = !r;
659 static void amdgpu_ring_to_mqd_prop(struct amdgpu_ring *ring,
660 struct amdgpu_mqd_prop *prop)
662 struct amdgpu_device *adev = ring->adev;
663 bool is_high_prio_compute = ring->funcs->type == AMDGPU_RING_TYPE_COMPUTE &&
664 amdgpu_gfx_is_high_priority_compute_queue(adev, ring);
665 bool is_high_prio_gfx = ring->funcs->type == AMDGPU_RING_TYPE_GFX &&
666 amdgpu_gfx_is_high_priority_graphics_queue(adev, ring);
668 memset(prop, 0, sizeof(*prop));
670 prop->mqd_gpu_addr = ring->mqd_gpu_addr;
671 prop->hqd_base_gpu_addr = ring->gpu_addr;
672 prop->rptr_gpu_addr = ring->rptr_gpu_addr;
673 prop->wptr_gpu_addr = ring->wptr_gpu_addr;
674 prop->queue_size = ring->ring_size;
675 prop->eop_gpu_addr = ring->eop_gpu_addr;
676 prop->use_doorbell = ring->use_doorbell;
677 prop->doorbell_index = ring->doorbell_index;
679 /* map_queues packet doesn't need activate the queue,
680 * so only kiq need set this field.
682 prop->hqd_active = ring->funcs->type == AMDGPU_RING_TYPE_KIQ;
684 prop->allow_tunneling = is_high_prio_compute;
685 if (is_high_prio_compute || is_high_prio_gfx) {
686 prop->hqd_pipe_priority = AMDGPU_GFX_PIPE_PRIO_HIGH;
687 prop->hqd_queue_priority = AMDGPU_GFX_QUEUE_PRIORITY_MAXIMUM;
691 int amdgpu_ring_init_mqd(struct amdgpu_ring *ring)
693 struct amdgpu_device *adev = ring->adev;
694 struct amdgpu_mqd *mqd_mgr;
695 struct amdgpu_mqd_prop prop;
697 amdgpu_ring_to_mqd_prop(ring, &prop);
701 if (ring->funcs->type == AMDGPU_RING_TYPE_KIQ)
702 mqd_mgr = &adev->mqds[AMDGPU_HW_IP_COMPUTE];
704 mqd_mgr = &adev->mqds[ring->funcs->type];
706 return mqd_mgr->init_mqd(adev, ring->mqd_ptr, &prop);
709 void amdgpu_ring_ib_begin(struct amdgpu_ring *ring)
711 if (ring->is_sw_ring)
712 amdgpu_sw_ring_ib_begin(ring);
715 void amdgpu_ring_ib_end(struct amdgpu_ring *ring)
717 if (ring->is_sw_ring)
718 amdgpu_sw_ring_ib_end(ring);
721 void amdgpu_ring_ib_on_emit_cntl(struct amdgpu_ring *ring)
723 if (ring->is_sw_ring)
724 amdgpu_sw_ring_ib_mark_offset(ring, AMDGPU_MUX_OFFSET_TYPE_CONTROL);
727 void amdgpu_ring_ib_on_emit_ce(struct amdgpu_ring *ring)
729 if (ring->is_sw_ring)
730 amdgpu_sw_ring_ib_mark_offset(ring, AMDGPU_MUX_OFFSET_TYPE_CE);
733 void amdgpu_ring_ib_on_emit_de(struct amdgpu_ring *ring)
735 if (ring->is_sw_ring)
736 amdgpu_sw_ring_ib_mark_offset(ring, AMDGPU_MUX_OFFSET_TYPE_DE);
739 bool amdgpu_ring_sched_ready(struct amdgpu_ring *ring)
744 if (ring->no_scheduler || !drm_sched_wqueue_ready(&ring->sched))