drivers/gpu/drm/amd/amdgpu/amdgpu_ring.c

   1 /*
   2  * Copyright 2008 Advanced Micro Devices, Inc.
   3  * Copyright 2008 Red Hat Inc.
   4  * Copyright 2009 Jerome Glisse.
   5  *
   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:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  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.
  23  *
  24  * Authors: Dave Airlie
  25  *          Alex Deucher
  26  *          Jerome Glisse
  27  *          Christian König
  28  */
  29 #include <linux/seq_file.h>
  30 #include <linux/slab.h>
  31 #include <linux/debugfs.h>
  32 #include <drm/drmP.h>
  33 #include <drm/amdgpu_drm.h>
  34 #include "amdgpu.h"
  35 #include "atom.h"
  36
  37 /*
  38  * Rings
  39  * Most engines on the GPU are fed via ring buffers.  Ring
  40  * buffers are areas of GPU accessible memory that the host
  41  * writes commands into and the GPU reads commands out of.
  42  * There is a rptr (read pointer) that determines where the
  43  * GPU is currently reading, and a wptr (write pointer)
  44  * which determines where the host has written.  When the
  45  * pointers are equal, the ring is idle.  When the host
  46  * writes commands to the ring buffer, it increments the
  47  * wptr.  The GPU then starts fetching commands and executes
  48  * them until the pointers are equal again.
  49  */
  50 static int amdgpu_debugfs_ring_init(struct amdgpu_device *adev,
  51                                     struct amdgpu_ring *ring);
  52 static void amdgpu_debugfs_ring_fini(struct amdgpu_ring *ring);
  53
  54 /**
  55  * amdgpu_ring_alloc - allocate space on the ring buffer
  56  *
  57  * @adev: amdgpu_device pointer
  58  * @ring: amdgpu_ring structure holding ring information
  59  * @ndw: number of dwords to allocate in the ring buffer
  60  *
  61  * Allocate @ndw dwords in the ring buffer (all asics).
  62  * Returns 0 on success, error on failure.
  63  */
  64 int amdgpu_ring_alloc(struct amdgpu_ring *ring, unsigned ndw)
  65 {
  66         /* Align requested size with padding so unlock_commit can
  67          * pad safely */
  68         ndw = (ndw + ring->funcs->align_mask) & ~ring->funcs->align_mask;
  69
  70         /* Make sure we aren't trying to allocate more space
  71          * than the maximum for one submission
  72          */
  73         if (WARN_ON_ONCE(ndw > ring->max_dw))
  74                 return -ENOMEM;
  75
  76         ring->count_dw = ndw;
  77         ring->wptr_old = ring->wptr;
  78
  79         if (ring->funcs->begin_use)
  80                 ring->funcs->begin_use(ring);
  81
  82         return 0;
  83 }
  84
  85 /** amdgpu_ring_insert_nop - insert NOP packets
  86  *
  87  * @ring: amdgpu_ring structure holding ring information
  88  * @count: the number of NOP packets to insert
  89  *
  90  * This is the generic insert_nop function for rings except SDMA
  91  */
  92 void amdgpu_ring_insert_nop(struct amdgpu_ring *ring, uint32_t count)
  93 {
  94         int i;
  95
  96         for (i = 0; i < count; i++)
  97                 amdgpu_ring_write(ring, ring->funcs->nop);
  98 }
  99
 100 /** amdgpu_ring_generic_pad_ib - pad IB with NOP packets
 101  *
 102  * @ring: amdgpu_ring structure holding ring information
 103  * @ib: IB to add NOP packets to
 104  *
 105  * This is the generic pad_ib function for rings except SDMA
 106  */
 107 void amdgpu_ring_generic_pad_ib(struct amdgpu_ring *ring, struct amdgpu_ib *ib)
 108 {
 109         while (ib->length_dw & ring->funcs->align_mask)
 110                 ib->ptr[ib->length_dw++] = ring->funcs->nop;
 111 }
 112
 113 /**
 114  * amdgpu_ring_commit - tell the GPU to execute the new
 115  * commands on the ring buffer
 116  *
 117  * @adev: amdgpu_device pointer
 118  * @ring: amdgpu_ring structure holding ring information
 119  *
 120  * Update the wptr (write pointer) to tell the GPU to
 121  * execute new commands on the ring buffer (all asics).
 122  */
 123 void amdgpu_ring_commit(struct amdgpu_ring *ring)
 124 {
 125         uint32_t count;
 126
 127         /* We pad to match fetch size */
 128         count = ring->funcs->align_mask + 1 -
 129                 (ring->wptr & ring->funcs->align_mask);
 130         count %= ring->funcs->align_mask + 1;
 131         ring->funcs->insert_nop(ring, count);
 132
 133         mb();
 134         amdgpu_ring_set_wptr(ring);
 135
 136         if (ring->funcs->end_use)
 137                 ring->funcs->end_use(ring);
 138
 139         if (ring->funcs->type != AMDGPU_RING_TYPE_KIQ)
 140                 amdgpu_ring_lru_touch(ring->adev, ring);
 141 }
 142
 143 /**
 144  * amdgpu_ring_undo - reset the wptr
 145  *
 146  * @ring: amdgpu_ring structure holding ring information
 147  *
 148  * Reset the driver's copy of the wptr (all asics).
 149  */
 150 void amdgpu_ring_undo(struct amdgpu_ring *ring)
 151 {
 152         ring->wptr = ring->wptr_old;
 153
 154         if (ring->funcs->end_use)
 155                 ring->funcs->end_use(ring);
 156 }
 157
 158 /**
 159  * amdgpu_ring_init - init driver ring struct.
 160  *
 161  * @adev: amdgpu_device pointer
 162  * @ring: amdgpu_ring structure holding ring information
 163  * @max_ndw: maximum number of dw for ring alloc
 164  * @nop: nop packet for this ring
 165  *
 166  * Initialize the driver information for the selected ring (all asics).
 167  * Returns 0 on success, error on failure.
 168  */
 169 int amdgpu_ring_init(struct amdgpu_device *adev, struct amdgpu_ring *ring,
 170                      unsigned max_dw, struct amdgpu_irq_src *irq_src,
 171                      unsigned irq_type)
 172 {
 173         int r;
 174         int sched_hw_submission = amdgpu_sched_hw_submission;
 175
 176         /* Set the hw submission limit higher for KIQ because
 177          * it's used for a number of gfx/compute tasks by both
 178          * KFD and KGD which may have outstanding fences and
 179          * it doesn't really use the gpu scheduler anyway;
 180          * KIQ tasks get submitted directly to the ring.
 181          */
 182         if (ring->funcs->type == AMDGPU_RING_TYPE_KIQ)
 183                 sched_hw_submission = max(sched_hw_submission, 256);
 184
 185         if (ring->adev == NULL) {
 186                 if (adev->num_rings >= AMDGPU_MAX_RINGS)
 187                         return -EINVAL;
 188
 189                 ring->adev = adev;
 190                 ring->idx = adev->num_rings++;
 191                 adev->rings[ring->idx] = ring;
 192                 r = amdgpu_fence_driver_init_ring(ring, sched_hw_submission);
 193                 if (r)
 194                         return r;
 195         }
 196
 197         r = amdgpu_wb_get(adev, &ring->rptr_offs);
 198         if (r) {
 199                 dev_err(adev->dev, "(%d) ring rptr_offs wb alloc failed\n", r);
 200                 return r;
 201         }
 202
 203         r = amdgpu_wb_get(adev, &ring->wptr_offs);
 204         if (r) {
 205                 dev_err(adev->dev, "(%d) ring wptr_offs wb alloc failed\n", r);
 206                 return r;
 207         }
 208
 209         r = amdgpu_wb_get(adev, &ring->fence_offs);
 210         if (r) {
 211                 dev_err(adev->dev, "(%d) ring fence_offs wb alloc failed\n", r);
 212                 return r;
 213         }
 214
 215         r = amdgpu_wb_get(adev, &ring->cond_exe_offs);
 216         if (r) {
 217                 dev_err(adev->dev, "(%d) ring cond_exec_polling wb alloc failed\n", r);
 218                 return r;
 219         }
 220         ring->cond_exe_gpu_addr = adev->wb.gpu_addr + (ring->cond_exe_offs * 4);
 221         ring->cond_exe_cpu_addr = &adev->wb.wb[ring->cond_exe_offs];
 222         /* always set cond_exec_polling to CONTINUE */
 223         *ring->cond_exe_cpu_addr = 1;
 224
 225         r = amdgpu_fence_driver_start_ring(ring, irq_src, irq_type);
 226         if (r) {
 227                 dev_err(adev->dev, "failed initializing fences (%d).\n", r);
 228                 return r;
 229         }
 230
 231         ring->ring_size = roundup_pow_of_two(max_dw * 4 * sched_hw_submission);
 232
 233         ring->buf_mask = (ring->ring_size / 4) - 1;
 234         ring->ptr_mask = ring->funcs->support_64bit_ptrs ?
 235                 0xffffffffffffffff : ring->buf_mask;
 236         /* Allocate ring buffer */
 237         if (ring->ring_obj == NULL) {
 238                 r = amdgpu_bo_create_kernel(adev, ring->ring_size, PAGE_SIZE,
 239                                             AMDGPU_GEM_DOMAIN_GTT,
 240                                             &ring->ring_obj,
 241                                             &ring->gpu_addr,
 242                                             (void **)&ring->ring);
 243                 if (r) {
 244                         dev_err(adev->dev, "(%d) ring create failed\n", r);
 245                         return r;
 246                 }
 247                 amdgpu_ring_clear_ring(ring);
 248         }
 249
 250         ring->max_dw = max_dw;
 251         INIT_LIST_HEAD(&ring->lru_list);
 252         amdgpu_ring_lru_touch(adev, ring);
 253
 254         if (amdgpu_debugfs_ring_init(adev, ring)) {
 255                 DRM_ERROR("Failed to register debugfs file for rings !\n");
 256         }
 257
 258         return 0;
 259 }
 260
 261 /**
 262  * amdgpu_ring_fini - tear down the driver ring struct.
 263  *
 264  * @adev: amdgpu_device pointer
 265  * @ring: amdgpu_ring structure holding ring information
 266  *
 267  * Tear down the driver information for the selected ring (all asics).
 268  */
 269 void amdgpu_ring_fini(struct amdgpu_ring *ring)
 270 {
 271         ring->ready = false;
 272
 273         /* Not to finish a ring which is not initialized */
 274         if (!(ring->adev) || !(ring->adev->rings[ring->idx]))
 275                 return;
 276
 277         amdgpu_wb_free(ring->adev, ring->rptr_offs);
 278         amdgpu_wb_free(ring->adev, ring->wptr_offs);
 279
 280         amdgpu_wb_free(ring->adev, ring->cond_exe_offs);
 281         amdgpu_wb_free(ring->adev, ring->fence_offs);
 282
 283         amdgpu_bo_free_kernel(&ring->ring_obj,
 284                               &ring->gpu_addr,
 285                               (void **)&ring->ring);
 286
 287         amdgpu_debugfs_ring_fini(ring);
 288
 289         ring->adev->rings[ring->idx] = NULL;
 290 }
 291
 292 static void amdgpu_ring_lru_touch_locked(struct amdgpu_device *adev,
 293                                          struct amdgpu_ring *ring)
 294 {
 295         /* list_move_tail handles the case where ring isn't part of the list */
 296         list_move_tail(&ring->lru_list, &adev->ring_lru_list);
 297 }
 298
 299 static bool amdgpu_ring_is_blacklisted(struct amdgpu_ring *ring,
 300                                        int *blacklist, int num_blacklist)
 301 {
 302         int i;
 303
 304         for (i = 0; i < num_blacklist; i++) {
 305                 if (ring->idx == blacklist[i])
 306                         return true;
 307         }
 308
 309         return false;
 310 }
 311
 312 /**
 313  * amdgpu_ring_lru_get - get the least recently used ring for a HW IP block
 314  *
 315  * @adev: amdgpu_device pointer
 316  * @type: amdgpu_ring_type enum
 317  * @blacklist: blacklisted ring ids array
 318  * @num_blacklist: number of entries in @blacklist
 319  * @ring: output ring
 320  *
 321  * Retrieve the amdgpu_ring structure for the least recently used ring of
 322  * a specific IP block (all asics).
 323  * Returns 0 on success, error on failure.
 324  */
 325 int amdgpu_ring_lru_get(struct amdgpu_device *adev, int type, int *blacklist,
 326                         int num_blacklist, struct amdgpu_ring **ring)
 327 {
 328         struct amdgpu_ring *entry;
 329
 330         /* List is sorted in LRU order, find first entry corresponding
 331          * to the desired HW IP */
 332         *ring = NULL;
 333         spin_lock(&adev->ring_lru_list_lock);
 334         list_for_each_entry(entry, &adev->ring_lru_list, lru_list) {
 335                 if (entry->funcs->type != type)
 336                         continue;
 337
 338                 if (amdgpu_ring_is_blacklisted(entry, blacklist, num_blacklist))
 339                         continue;
 340
 341                 *ring = entry;
 342                 amdgpu_ring_lru_touch_locked(adev, *ring);
 343                 break;
 344         }
 345         spin_unlock(&adev->ring_lru_list_lock);
 346
 347         if (!*ring) {
 348                 DRM_ERROR("Ring LRU contains no entries for ring type:%d\n", type);
 349                 return -EINVAL;
 350         }
 351
 352         return 0;
 353 }
 354
 355 /**
 356  * amdgpu_ring_lru_touch - mark a ring as recently being used
 357  *
 358  * @adev: amdgpu_device pointer
 359  * @ring: ring to touch
 360  *
 361  * Move @ring to the tail of the lru list
 362  */
 363 void amdgpu_ring_lru_touch(struct amdgpu_device *adev, struct amdgpu_ring *ring)
 364 {
 365         spin_lock(&adev->ring_lru_list_lock);
 366         amdgpu_ring_lru_touch_locked(adev, ring);
 367         spin_unlock(&adev->ring_lru_list_lock);
 368 }
 369
 370 /*
 371  * Debugfs info
 372  */
 373 #if defined(CONFIG_DEBUG_FS)
 374
 375 /* Layout of file is 12 bytes consisting of
 376  * - rptr
 377  * - wptr
 378  * - driver's copy of wptr
 379  *
 380  * followed by n-words of ring data
 381  */
 382 static ssize_t amdgpu_debugfs_ring_read(struct file *f, char __user *buf,
 383                                         size_t size, loff_t *pos)
 384 {
 385         struct amdgpu_ring *ring = file_inode(f)->i_private;
 386         int r, i;
 387         uint32_t value, result, early[3];
 388
 389         if (*pos & 3 || size & 3)
 390                 return -EINVAL;
 391
 392         result = 0;
 393
 394         if (*pos < 12) {
 395                 early[0] = amdgpu_ring_get_rptr(ring);
 396                 early[1] = amdgpu_ring_get_wptr(ring) & ring->buf_mask;
 397                 early[2] = ring->wptr & ring->buf_mask;
 398                 for (i = *pos / 4; i < 3 && size; i++) {
 399                         r = put_user(early[i], (uint32_t *)buf);
 400                         if (r)
 401                                 return r;
 402                         buf += 4;
 403                         result += 4;
 404                         size -= 4;
 405                         *pos += 4;
 406                 }
 407         }
 408
 409         while (size) {
 410                 if (*pos >= (ring->ring_size + 12))
 411                         return result;
 412
 413                 value = ring->ring[(*pos - 12)/4];
 414                 r = put_user(value, (uint32_t*)buf);
 415                 if (r)
 416                         return r;
 417                 buf += 4;
 418                 result += 4;
 419                 size -= 4;
 420                 *pos += 4;
 421         }
 422
 423         return result;
 424 }
 425
 426 static const struct file_operations amdgpu_debugfs_ring_fops = {
 427         .owner = THIS_MODULE,
 428         .read = amdgpu_debugfs_ring_read,
 429         .llseek = default_llseek
 430 };
 431
 432 #endif
 433
 434 static int amdgpu_debugfs_ring_init(struct amdgpu_device *adev,
 435                                     struct amdgpu_ring *ring)
 436 {
 437 #if defined(CONFIG_DEBUG_FS)
 438         struct drm_minor *minor = adev->ddev->primary;
 439         struct dentry *ent, *root = minor->debugfs_root;
 440         char name[32];
 441
 442         sprintf(name, "amdgpu_ring_%s", ring->name);
 443
 444         ent = debugfs_create_file(name,
 445                                   S_IFREG | S_IRUGO, root,
 446                                   ring, &amdgpu_debugfs_ring_fops);
 447         if (!ent)
 448                 return -ENOMEM;
 449
 450         i_size_write(ent->d_inode, ring->ring_size + 12);
 451         ring->ent = ent;
 452 #endif
 453         return 0;
 454 }
 455
 456 static void amdgpu_debugfs_ring_fini(struct amdgpu_ring *ring)
 457 {
 458 #if defined(CONFIG_DEBUG_FS)
 459         debugfs_remove(ring->ent);
 460 #endif
 461 }