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

   1 /*
   2  * Copyright 2009 Jerome Glisse.
   3  * All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sub license, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  16  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  17  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  18  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  19  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  20  *
  21  * The above copyright notice and this permission notice (including the
  22  * next paragraph) shall be included in all copies or substantial portions
  23  * of the Software.
  24  *
  25  */
  26 /*
  27  * Authors:
  28  *    Jerome Glisse <[email protected]>
  29  *    Thomas Hellstrom <thomas-at-tungstengraphics-dot-com>
  30  *    Dave Airlie
  31  */
  32 #include <linux/list.h>
  33 #include <linux/slab.h>
  34 #include <drm/drmP.h>
  35 #include <drm/amdgpu_drm.h>
  36 #include <drm/drm_cache.h>
  37 #include "amdgpu.h"
  38 #include "amdgpu_trace.h"
  39 #include "amdgpu_amdkfd.h"
  40
  41 /**
  42  * DOC: amdgpu_object
  43  *
  44  * This defines the interfaces to operate on an &amdgpu_bo buffer object which
  45  * represents memory used by driver (VRAM, system memory, etc.). The driver
  46  * provides DRM/GEM APIs to userspace. DRM/GEM APIs then use these interfaces
  47  * to create/destroy/set buffer object which are then managed by the kernel TTM
  48  * memory manager.
  49  * The interfaces are also used internally by kernel clients, including gfx,
  50  * uvd, etc. for kernel managed allocations used by the GPU.
  51  *
  52  */
  53
  54 static bool amdgpu_need_backup(struct amdgpu_device *adev)
  55 {
  56         if (adev->flags & AMD_IS_APU)
  57                 return false;
  58
  59         if (amdgpu_gpu_recovery == 0 ||
  60             (amdgpu_gpu_recovery == -1  && !amdgpu_sriov_vf(adev)))
  61                 return false;
  62
  63         return true;
  64 }
  65
  66 /**
  67  * amdgpu_bo_subtract_pin_size - Remove BO from pin_size accounting
  68  *
  69  * @bo: &amdgpu_bo buffer object
  70  *
  71  * This function is called when a BO stops being pinned, and updates the
  72  * &amdgpu_device pin_size values accordingly.
  73  */
  74 static void amdgpu_bo_subtract_pin_size(struct amdgpu_bo *bo)
  75 {
  76         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
  77
  78         if (bo->tbo.mem.mem_type == TTM_PL_VRAM) {
  79                 atomic64_sub(amdgpu_bo_size(bo), &adev->vram_pin_size);
  80                 atomic64_sub(amdgpu_vram_mgr_bo_visible_size(bo),
  81                              &adev->visible_pin_size);
  82         } else if (bo->tbo.mem.mem_type == TTM_PL_TT) {
  83                 atomic64_sub(amdgpu_bo_size(bo), &adev->gart_pin_size);
  84         }
  85 }
  86
  87 static void amdgpu_ttm_bo_destroy(struct ttm_buffer_object *tbo)
  88 {
  89         struct amdgpu_device *adev = amdgpu_ttm_adev(tbo->bdev);
  90         struct amdgpu_bo *bo = ttm_to_amdgpu_bo(tbo);
  91
  92         if (WARN_ON_ONCE(bo->pin_count > 0))
  93                 amdgpu_bo_subtract_pin_size(bo);
  94
  95         if (bo->kfd_bo)
  96                 amdgpu_amdkfd_unreserve_system_memory_limit(bo);
  97
  98         amdgpu_bo_kunmap(bo);
  99
 100         if (bo->gem_base.import_attach)
 101                 drm_prime_gem_destroy(&bo->gem_base, bo->tbo.sg);
 102         drm_gem_object_release(&bo->gem_base);
 103         amdgpu_bo_unref(&bo->parent);
 104         if (!list_empty(&bo->shadow_list)) {
 105                 mutex_lock(&adev->shadow_list_lock);
 106                 list_del_init(&bo->shadow_list);
 107                 mutex_unlock(&adev->shadow_list_lock);
 108         }
 109         kfree(bo->metadata);
 110         kfree(bo);
 111 }
 112
 113 /**
 114  * amdgpu_ttm_bo_is_amdgpu_bo - check if the buffer object is an &amdgpu_bo
 115  * @bo: buffer object to be checked
 116  *
 117  * Uses destroy function associated with the object to determine if this is
 118  * an &amdgpu_bo.
 119  *
 120  * Returns:
 121  * true if the object belongs to &amdgpu_bo, false if not.
 122  */
 123 bool amdgpu_ttm_bo_is_amdgpu_bo(struct ttm_buffer_object *bo)
 124 {
 125         if (bo->destroy == &amdgpu_ttm_bo_destroy)
 126                 return true;
 127         return false;
 128 }
 129
 130 /**
 131  * amdgpu_ttm_placement_from_domain - set buffer's placement
 132  * @abo: &amdgpu_bo buffer object whose placement is to be set
 133  * @domain: requested domain
 134  *
 135  * Sets buffer's placement according to requested domain and the buffer's
 136  * flags.
 137  */
 138 void amdgpu_ttm_placement_from_domain(struct amdgpu_bo *abo, u32 domain)
 139 {
 140         struct amdgpu_device *adev = amdgpu_ttm_adev(abo->tbo.bdev);
 141         struct ttm_placement *placement = &abo->placement;
 142         struct ttm_place *places = abo->placements;
 143         u64 flags = abo->flags;
 144         u32 c = 0;
 145
 146         if (domain & AMDGPU_GEM_DOMAIN_VRAM) {
 147                 unsigned visible_pfn = adev->gmc.visible_vram_size >> PAGE_SHIFT;
 148
 149                 places[c].fpfn = 0;
 150                 places[c].lpfn = 0;
 151                 places[c].flags = TTM_PL_FLAG_WC | TTM_PL_FLAG_UNCACHED |
 152                         TTM_PL_FLAG_VRAM;
 153
 154                 if (flags & AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED)
 155                         places[c].lpfn = visible_pfn;
 156                 else
 157                         places[c].flags |= TTM_PL_FLAG_TOPDOWN;
 158
 159                 if (flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS)
 160                         places[c].flags |= TTM_PL_FLAG_CONTIGUOUS;
 161                 c++;
 162         }
 163
 164         if (domain & AMDGPU_GEM_DOMAIN_GTT) {
 165                 places[c].fpfn = 0;
 166                 if (flags & AMDGPU_GEM_CREATE_SHADOW)
 167                         places[c].lpfn = adev->gmc.gart_size >> PAGE_SHIFT;
 168                 else
 169                         places[c].lpfn = 0;
 170                 places[c].flags = TTM_PL_FLAG_TT;
 171                 if (flags & AMDGPU_GEM_CREATE_CPU_GTT_USWC)
 172                         places[c].flags |= TTM_PL_FLAG_WC |
 173                                 TTM_PL_FLAG_UNCACHED;
 174                 else
 175                         places[c].flags |= TTM_PL_FLAG_CACHED;
 176                 c++;
 177         }
 178
 179         if (domain & AMDGPU_GEM_DOMAIN_CPU) {
 180                 places[c].fpfn = 0;
 181                 places[c].lpfn = 0;
 182                 places[c].flags = TTM_PL_FLAG_SYSTEM;
 183                 if (flags & AMDGPU_GEM_CREATE_CPU_GTT_USWC)
 184                         places[c].flags |= TTM_PL_FLAG_WC |
 185                                 TTM_PL_FLAG_UNCACHED;
 186                 else
 187                         places[c].flags |= TTM_PL_FLAG_CACHED;
 188                 c++;
 189         }
 190
 191         if (domain & AMDGPU_GEM_DOMAIN_GDS) {
 192                 places[c].fpfn = 0;
 193                 places[c].lpfn = 0;
 194                 places[c].flags = TTM_PL_FLAG_UNCACHED | AMDGPU_PL_FLAG_GDS;
 195                 c++;
 196         }
 197
 198         if (domain & AMDGPU_GEM_DOMAIN_GWS) {
 199                 places[c].fpfn = 0;
 200                 places[c].lpfn = 0;
 201                 places[c].flags = TTM_PL_FLAG_UNCACHED | AMDGPU_PL_FLAG_GWS;
 202                 c++;
 203         }
 204
 205         if (domain & AMDGPU_GEM_DOMAIN_OA) {
 206                 places[c].fpfn = 0;
 207                 places[c].lpfn = 0;
 208                 places[c].flags = TTM_PL_FLAG_UNCACHED | AMDGPU_PL_FLAG_OA;
 209                 c++;
 210         }
 211
 212         if (!c) {
 213                 places[c].fpfn = 0;
 214                 places[c].lpfn = 0;
 215                 places[c].flags = TTM_PL_MASK_CACHING | TTM_PL_FLAG_SYSTEM;
 216                 c++;
 217         }
 218
 219         placement->num_placement = c;
 220         placement->placement = places;
 221
 222         placement->num_busy_placement = c;
 223         placement->busy_placement = places;
 224 }
 225
 226 /**
 227  * amdgpu_bo_create_reserved - create reserved BO for kernel use
 228  *
 229  * @adev: amdgpu device object
 230  * @size: size for the new BO
 231  * @align: alignment for the new BO
 232  * @domain: where to place it
 233  * @bo_ptr: used to initialize BOs in structures
 234  * @gpu_addr: GPU addr of the pinned BO
 235  * @cpu_addr: optional CPU address mapping
 236  *
 237  * Allocates and pins a BO for kernel internal use, and returns it still
 238  * reserved.
 239  *
 240  * Note: For bo_ptr new BO is only created if bo_ptr points to NULL.
 241  *
 242  * Returns:
 243  * 0 on success, negative error code otherwise.
 244  */
 245 int amdgpu_bo_create_reserved(struct amdgpu_device *adev,
 246                               unsigned long size, int align,
 247                               u32 domain, struct amdgpu_bo **bo_ptr,
 248                               u64 *gpu_addr, void **cpu_addr)
 249 {
 250         struct amdgpu_bo_param bp;
 251         bool free = false;
 252         int r;
 253
 254         memset(&bp, 0, sizeof(bp));
 255         bp.size = size;
 256         bp.byte_align = align;
 257         bp.domain = domain;
 258         bp.flags = AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED |
 259                 AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS;
 260         bp.type = ttm_bo_type_kernel;
 261         bp.resv = NULL;
 262
 263         if (!*bo_ptr) {
 264                 r = amdgpu_bo_create(adev, &bp, bo_ptr);
 265                 if (r) {
 266                         dev_err(adev->dev, "(%d) failed to allocate kernel bo\n",
 267                                 r);
 268                         return r;
 269                 }
 270                 free = true;
 271         }
 272
 273         r = amdgpu_bo_reserve(*bo_ptr, false);
 274         if (r) {
 275                 dev_err(adev->dev, "(%d) failed to reserve kernel bo\n", r);
 276                 goto error_free;
 277         }
 278
 279         r = amdgpu_bo_pin(*bo_ptr, domain);
 280         if (r) {
 281                 dev_err(adev->dev, "(%d) kernel bo pin failed\n", r);
 282                 goto error_unreserve;
 283         }
 284
 285         r = amdgpu_ttm_alloc_gart(&(*bo_ptr)->tbo);
 286         if (r) {
 287                 dev_err(adev->dev, "%p bind failed\n", *bo_ptr);
 288                 goto error_unpin;
 289         }
 290
 291         if (gpu_addr)
 292                 *gpu_addr = amdgpu_bo_gpu_offset(*bo_ptr);
 293
 294         if (cpu_addr) {
 295                 r = amdgpu_bo_kmap(*bo_ptr, cpu_addr);
 296                 if (r) {
 297                         dev_err(adev->dev, "(%d) kernel bo map failed\n", r);
 298                         goto error_unpin;
 299                 }
 300         }
 301
 302         return 0;
 303
 304 error_unpin:
 305         amdgpu_bo_unpin(*bo_ptr);
 306 error_unreserve:
 307         amdgpu_bo_unreserve(*bo_ptr);
 308
 309 error_free:
 310         if (free)
 311                 amdgpu_bo_unref(bo_ptr);
 312
 313         return r;
 314 }
 315
 316 /**
 317  * amdgpu_bo_create_kernel - create BO for kernel use
 318  *
 319  * @adev: amdgpu device object
 320  * @size: size for the new BO
 321  * @align: alignment for the new BO
 322  * @domain: where to place it
 323  * @bo_ptr:  used to initialize BOs in structures
 324  * @gpu_addr: GPU addr of the pinned BO
 325  * @cpu_addr: optional CPU address mapping
 326  *
 327  * Allocates and pins a BO for kernel internal use.
 328  *
 329  * Note: For bo_ptr new BO is only created if bo_ptr points to NULL.
 330  *
 331  * Returns:
 332  * 0 on success, negative error code otherwise.
 333  */
 334 int amdgpu_bo_create_kernel(struct amdgpu_device *adev,
 335                             unsigned long size, int align,
 336                             u32 domain, struct amdgpu_bo **bo_ptr,
 337                             u64 *gpu_addr, void **cpu_addr)
 338 {
 339         int r;
 340
 341         r = amdgpu_bo_create_reserved(adev, size, align, domain, bo_ptr,
 342                                       gpu_addr, cpu_addr);
 343
 344         if (r)
 345                 return r;
 346
 347         amdgpu_bo_unreserve(*bo_ptr);
 348
 349         return 0;
 350 }
 351
 352 /**
 353  * amdgpu_bo_free_kernel - free BO for kernel use
 354  *
 355  * @bo: amdgpu BO to free
 356  * @gpu_addr: pointer to where the BO's GPU memory space address was stored
 357  * @cpu_addr: pointer to where the BO's CPU memory space address was stored
 358  *
 359  * unmaps and unpin a BO for kernel internal use.
 360  */
 361 void amdgpu_bo_free_kernel(struct amdgpu_bo **bo, u64 *gpu_addr,
 362                            void **cpu_addr)
 363 {
 364         if (*bo == NULL)
 365                 return;
 366
 367         if (likely(amdgpu_bo_reserve(*bo, true) == 0)) {
 368                 if (cpu_addr)
 369                         amdgpu_bo_kunmap(*bo);
 370
 371                 amdgpu_bo_unpin(*bo);
 372                 amdgpu_bo_unreserve(*bo);
 373         }
 374         amdgpu_bo_unref(bo);
 375
 376         if (gpu_addr)
 377                 *gpu_addr = 0;
 378
 379         if (cpu_addr)
 380                 *cpu_addr = NULL;
 381 }
 382
 383 /* Validate bo size is bit bigger then the request domain */
 384 static bool amdgpu_bo_validate_size(struct amdgpu_device *adev,
 385                                           unsigned long size, u32 domain)
 386 {
 387         struct ttm_mem_type_manager *man = NULL;
 388
 389         /*
 390          * If GTT is part of requested domains the check must succeed to
 391          * allow fall back to GTT
 392          */
 393         if (domain & AMDGPU_GEM_DOMAIN_GTT) {
 394                 man = &adev->mman.bdev.man[TTM_PL_TT];
 395
 396                 if (size < (man->size << PAGE_SHIFT))
 397                         return true;
 398                 else
 399                         goto fail;
 400         }
 401
 402         if (domain & AMDGPU_GEM_DOMAIN_VRAM) {
 403                 man = &adev->mman.bdev.man[TTM_PL_VRAM];
 404
 405                 if (size < (man->size << PAGE_SHIFT))
 406                         return true;
 407                 else
 408                         goto fail;
 409         }
 410
 411
 412         /* TODO add more domains checks, such as AMDGPU_GEM_DOMAIN_CPU */
 413         return true;
 414
 415 fail:
 416         DRM_DEBUG("BO size %lu > total memory in domain: %llu\n", size,
 417                   man->size << PAGE_SHIFT);
 418         return false;
 419 }
 420
 421 static int amdgpu_bo_do_create(struct amdgpu_device *adev,
 422                                struct amdgpu_bo_param *bp,
 423                                struct amdgpu_bo **bo_ptr)
 424 {
 425         struct ttm_operation_ctx ctx = {
 426                 .interruptible = (bp->type != ttm_bo_type_kernel),
 427                 .no_wait_gpu = false,
 428                 .resv = bp->resv,
 429                 .flags = TTM_OPT_FLAG_ALLOW_RES_EVICT
 430         };
 431         struct amdgpu_bo *bo;
 432         unsigned long page_align, size = bp->size;
 433         size_t acc_size;
 434         int r;
 435
 436         page_align = roundup(bp->byte_align, PAGE_SIZE) >> PAGE_SHIFT;
 437         size = ALIGN(size, PAGE_SIZE);
 438
 439         if (!amdgpu_bo_validate_size(adev, size, bp->domain))
 440                 return -ENOMEM;
 441
 442         *bo_ptr = NULL;
 443
 444         acc_size = ttm_bo_dma_acc_size(&adev->mman.bdev, size,
 445                                        sizeof(struct amdgpu_bo));
 446
 447         bo = kzalloc(sizeof(struct amdgpu_bo), GFP_KERNEL);
 448         if (bo == NULL)
 449                 return -ENOMEM;
 450         drm_gem_private_object_init(adev->ddev, &bo->gem_base, size);
 451         INIT_LIST_HEAD(&bo->shadow_list);
 452         INIT_LIST_HEAD(&bo->va);
 453         bo->preferred_domains = bp->preferred_domain ? bp->preferred_domain :
 454                 bp->domain;
 455         bo->allowed_domains = bo->preferred_domains;
 456         if (bp->type != ttm_bo_type_kernel &&
 457             bo->allowed_domains == AMDGPU_GEM_DOMAIN_VRAM)
 458                 bo->allowed_domains |= AMDGPU_GEM_DOMAIN_GTT;
 459
 460         bo->flags = bp->flags;
 461
 462 #ifdef CONFIG_X86_32
 463         /* XXX: Write-combined CPU mappings of GTT seem broken on 32-bit
 464          * See https://bugs.freedesktop.org/show_bug.cgi?id=84627
 465          */
 466         bo->flags &= ~AMDGPU_GEM_CREATE_CPU_GTT_USWC;
 467 #elif defined(CONFIG_X86) && !defined(CONFIG_X86_PAT)
 468         /* Don't try to enable write-combining when it can't work, or things
 469          * may be slow
 470          * See https://bugs.freedesktop.org/show_bug.cgi?id=88758
 471          */
 472
 473 #ifndef CONFIG_COMPILE_TEST
 474 #warning Please enable CONFIG_MTRR and CONFIG_X86_PAT for better performance \
 475          thanks to write-combining
 476 #endif
 477
 478         if (bo->flags & AMDGPU_GEM_CREATE_CPU_GTT_USWC)
 479                 DRM_INFO_ONCE("Please enable CONFIG_MTRR and CONFIG_X86_PAT for "
 480                               "better performance thanks to write-combining\n");
 481         bo->flags &= ~AMDGPU_GEM_CREATE_CPU_GTT_USWC;
 482 #else
 483         /* For architectures that don't support WC memory,
 484          * mask out the WC flag from the BO
 485          */
 486         if (!drm_arch_can_wc_memory())
 487                 bo->flags &= ~AMDGPU_GEM_CREATE_CPU_GTT_USWC;
 488 #endif
 489
 490         bo->tbo.bdev = &adev->mman.bdev;
 491         amdgpu_ttm_placement_from_domain(bo, bp->domain);
 492         if (bp->type == ttm_bo_type_kernel)
 493                 bo->tbo.priority = 1;
 494
 495         r = ttm_bo_init_reserved(&adev->mman.bdev, &bo->tbo, size, bp->type,
 496                                  &bo->placement, page_align, &ctx, acc_size,
 497                                  NULL, bp->resv, &amdgpu_ttm_bo_destroy);
 498         if (unlikely(r != 0))
 499                 return r;
 500
 501         if (!amdgpu_gmc_vram_full_visible(&adev->gmc) &&
 502             bo->tbo.mem.mem_type == TTM_PL_VRAM &&
 503             bo->tbo.mem.start < adev->gmc.visible_vram_size >> PAGE_SHIFT)
 504                 amdgpu_cs_report_moved_bytes(adev, ctx.bytes_moved,
 505                                              ctx.bytes_moved);
 506         else
 507                 amdgpu_cs_report_moved_bytes(adev, ctx.bytes_moved, 0);
 508
 509         if (bp->flags & AMDGPU_GEM_CREATE_VRAM_CLEARED &&
 510             bo->tbo.mem.placement & TTM_PL_FLAG_VRAM) {
 511                 struct dma_fence *fence;
 512
 513                 r = amdgpu_fill_buffer(bo, 0, bo->tbo.resv, &fence);
 514                 if (unlikely(r))
 515                         goto fail_unreserve;
 516
 517                 amdgpu_bo_fence(bo, fence, false);
 518                 dma_fence_put(bo->tbo.moving);
 519                 bo->tbo.moving = dma_fence_get(fence);
 520                 dma_fence_put(fence);
 521         }
 522         if (!bp->resv)
 523                 amdgpu_bo_unreserve(bo);
 524         *bo_ptr = bo;
 525
 526         trace_amdgpu_bo_create(bo);
 527
 528         /* Treat CPU_ACCESS_REQUIRED only as a hint if given by UMD */
 529         if (bp->type == ttm_bo_type_device)
 530                 bo->flags &= ~AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
 531
 532         return 0;
 533
 534 fail_unreserve:
 535         if (!bp->resv)
 536                 ww_mutex_unlock(&bo->tbo.resv->lock);
 537         amdgpu_bo_unref(&bo);
 538         return r;
 539 }
 540
 541 static int amdgpu_bo_create_shadow(struct amdgpu_device *adev,
 542                                    unsigned long size, int byte_align,
 543                                    struct amdgpu_bo *bo)
 544 {
 545         struct amdgpu_bo_param bp;
 546         int r;
 547
 548         if (bo->shadow)
 549                 return 0;
 550
 551         memset(&bp, 0, sizeof(bp));
 552         bp.size = size;
 553         bp.byte_align = byte_align;
 554         bp.domain = AMDGPU_GEM_DOMAIN_GTT;
 555         bp.flags = AMDGPU_GEM_CREATE_CPU_GTT_USWC |
 556                 AMDGPU_GEM_CREATE_SHADOW;
 557         bp.type = ttm_bo_type_kernel;
 558         bp.resv = bo->tbo.resv;
 559
 560         r = amdgpu_bo_do_create(adev, &bp, &bo->shadow);
 561         if (!r) {
 562                 bo->shadow->parent = amdgpu_bo_ref(bo);
 563                 mutex_lock(&adev->shadow_list_lock);
 564                 list_add_tail(&bo->shadow_list, &adev->shadow_list);
 565                 mutex_unlock(&adev->shadow_list_lock);
 566         }
 567
 568         return r;
 569 }
 570
 571 /**
 572  * amdgpu_bo_create - create an &amdgpu_bo buffer object
 573  * @adev: amdgpu device object
 574  * @bp: parameters to be used for the buffer object
 575  * @bo_ptr: pointer to the buffer object pointer
 576  *
 577  * Creates an &amdgpu_bo buffer object; and if requested, also creates a
 578  * shadow object.
 579  * Shadow object is used to backup the original buffer object, and is always
 580  * in GTT.
 581  *
 582  * Returns:
 583  * 0 for success or a negative error code on failure.
 584  */
 585 int amdgpu_bo_create(struct amdgpu_device *adev,
 586                      struct amdgpu_bo_param *bp,
 587                      struct amdgpu_bo **bo_ptr)
 588 {
 589         u64 flags = bp->flags;
 590         int r;
 591
 592         bp->flags = bp->flags & ~AMDGPU_GEM_CREATE_SHADOW;
 593         r = amdgpu_bo_do_create(adev, bp, bo_ptr);
 594         if (r)
 595                 return r;
 596
 597         if ((flags & AMDGPU_GEM_CREATE_SHADOW) && amdgpu_need_backup(adev)) {
 598                 if (!bp->resv)
 599                         WARN_ON(reservation_object_lock((*bo_ptr)->tbo.resv,
 600                                                         NULL));
 601
 602                 r = amdgpu_bo_create_shadow(adev, bp->size, bp->byte_align, (*bo_ptr));
 603
 604                 if (!bp->resv)
 605                         reservation_object_unlock((*bo_ptr)->tbo.resv);
 606
 607                 if (r)
 608                         amdgpu_bo_unref(bo_ptr);
 609         }
 610
 611         return r;
 612 }
 613
 614 /**
 615  * amdgpu_bo_backup_to_shadow - Backs up an &amdgpu_bo buffer object
 616  * @adev: amdgpu device object
 617  * @ring: amdgpu_ring for the engine handling the buffer operations
 618  * @bo: &amdgpu_bo buffer to be backed up
 619  * @resv: reservation object with embedded fence
 620  * @fence: dma_fence associated with the operation
 621  * @direct: whether to submit the job directly
 622  *
 623  * Copies an &amdgpu_bo buffer object to its shadow object.
 624  * Not used for now.
 625  *
 626  * Returns:
 627  * 0 for success or a negative error code on failure.
 628  */
 629 int amdgpu_bo_backup_to_shadow(struct amdgpu_device *adev,
 630                                struct amdgpu_ring *ring,
 631                                struct amdgpu_bo *bo,
 632                                struct reservation_object *resv,
 633                                struct dma_fence **fence,
 634                                bool direct)
 635
 636 {
 637         struct amdgpu_bo *shadow = bo->shadow;
 638         uint64_t bo_addr, shadow_addr;
 639         int r;
 640
 641         if (!shadow)
 642                 return -EINVAL;
 643
 644         bo_addr = amdgpu_bo_gpu_offset(bo);
 645         shadow_addr = amdgpu_bo_gpu_offset(bo->shadow);
 646
 647         r = reservation_object_reserve_shared(bo->tbo.resv);
 648         if (r)
 649                 goto err;
 650
 651         r = amdgpu_copy_buffer(ring, bo_addr, shadow_addr,
 652                                amdgpu_bo_size(bo), resv, fence,
 653                                direct, false);
 654         if (!r)
 655                 amdgpu_bo_fence(bo, *fence, true);
 656
 657 err:
 658         return r;
 659 }
 660
 661 /**
 662  * amdgpu_bo_validate - validate an &amdgpu_bo buffer object
 663  * @bo: pointer to the buffer object
 664  *
 665  * Sets placement according to domain; and changes placement and caching
 666  * policy of the buffer object according to the placement.
 667  * This is used for validating shadow bos.  It calls ttm_bo_validate() to
 668  * make sure the buffer is resident where it needs to be.
 669  *
 670  * Returns:
 671  * 0 for success or a negative error code on failure.
 672  */
 673 int amdgpu_bo_validate(struct amdgpu_bo *bo)
 674 {
 675         struct ttm_operation_ctx ctx = { false, false };
 676         uint32_t domain;
 677         int r;
 678
 679         if (bo->pin_count)
 680                 return 0;
 681
 682         domain = bo->preferred_domains;
 683
 684 retry:
 685         amdgpu_ttm_placement_from_domain(bo, domain);
 686         r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
 687         if (unlikely(r == -ENOMEM) && domain != bo->allowed_domains) {
 688                 domain = bo->allowed_domains;
 689                 goto retry;
 690         }
 691
 692         return r;
 693 }
 694
 695 /**
 696  * amdgpu_bo_restore_from_shadow - restore an &amdgpu_bo buffer object
 697  * @adev: amdgpu device object
 698  * @ring: amdgpu_ring for the engine handling the buffer operations
 699  * @bo: &amdgpu_bo buffer to be restored
 700  * @resv: reservation object with embedded fence
 701  * @fence: dma_fence associated with the operation
 702  * @direct: whether to submit the job directly
 703  *
 704  * Copies a buffer object's shadow content back to the object.
 705  * This is used for recovering a buffer from its shadow in case of a gpu
 706  * reset where vram context may be lost.
 707  *
 708  * Returns:
 709  * 0 for success or a negative error code on failure.
 710  */
 711 int amdgpu_bo_restore_from_shadow(struct amdgpu_device *adev,
 712                                   struct amdgpu_ring *ring,
 713                                   struct amdgpu_bo *bo,
 714                                   struct reservation_object *resv,
 715                                   struct dma_fence **fence,
 716                                   bool direct)
 717
 718 {
 719         struct amdgpu_bo *shadow = bo->shadow;
 720         uint64_t bo_addr, shadow_addr;
 721         int r;
 722
 723         if (!shadow)
 724                 return -EINVAL;
 725
 726         bo_addr = amdgpu_bo_gpu_offset(bo);
 727         shadow_addr = amdgpu_bo_gpu_offset(bo->shadow);
 728
 729         r = reservation_object_reserve_shared(bo->tbo.resv);
 730         if (r)
 731                 goto err;
 732
 733         r = amdgpu_copy_buffer(ring, shadow_addr, bo_addr,
 734                                amdgpu_bo_size(bo), resv, fence,
 735                                direct, false);
 736         if (!r)
 737                 amdgpu_bo_fence(bo, *fence, true);
 738
 739 err:
 740         return r;
 741 }
 742
 743 /**
 744  * amdgpu_bo_kmap - map an &amdgpu_bo buffer object
 745  * @bo: &amdgpu_bo buffer object to be mapped
 746  * @ptr: kernel virtual address to be returned
 747  *
 748  * Calls ttm_bo_kmap() to set up the kernel virtual mapping; calls
 749  * amdgpu_bo_kptr() to get the kernel virtual address.
 750  *
 751  * Returns:
 752  * 0 for success or a negative error code on failure.
 753  */
 754 int amdgpu_bo_kmap(struct amdgpu_bo *bo, void **ptr)
 755 {
 756         void *kptr;
 757         long r;
 758
 759         if (bo->flags & AMDGPU_GEM_CREATE_NO_CPU_ACCESS)
 760                 return -EPERM;
 761
 762         kptr = amdgpu_bo_kptr(bo);
 763         if (kptr) {
 764                 if (ptr)
 765                         *ptr = kptr;
 766                 return 0;
 767         }
 768
 769         r = reservation_object_wait_timeout_rcu(bo->tbo.resv, false, false,
 770                                                 MAX_SCHEDULE_TIMEOUT);
 771         if (r < 0)
 772                 return r;
 773
 774         r = ttm_bo_kmap(&bo->tbo, 0, bo->tbo.num_pages, &bo->kmap);
 775         if (r)
 776                 return r;
 777
 778         if (ptr)
 779                 *ptr = amdgpu_bo_kptr(bo);
 780
 781         return 0;
 782 }
 783
 784 /**
 785  * amdgpu_bo_kptr - returns a kernel virtual address of the buffer object
 786  * @bo: &amdgpu_bo buffer object
 787  *
 788  * Calls ttm_kmap_obj_virtual() to get the kernel virtual address
 789  *
 790  * Returns:
 791  * the virtual address of a buffer object area.
 792  */
 793 void *amdgpu_bo_kptr(struct amdgpu_bo *bo)
 794 {
 795         bool is_iomem;
 796
 797         return ttm_kmap_obj_virtual(&bo->kmap, &is_iomem);
 798 }
 799
 800 /**
 801  * amdgpu_bo_kunmap - unmap an &amdgpu_bo buffer object
 802  * @bo: &amdgpu_bo buffer object to be unmapped
 803  *
 804  * Unmaps a kernel map set up by amdgpu_bo_kmap().
 805  */
 806 void amdgpu_bo_kunmap(struct amdgpu_bo *bo)
 807 {
 808         if (bo->kmap.bo)
 809                 ttm_bo_kunmap(&bo->kmap);
 810 }
 811
 812 /**
 813  * amdgpu_bo_ref - reference an &amdgpu_bo buffer object
 814  * @bo: &amdgpu_bo buffer object
 815  *
 816  * References the contained &ttm_buffer_object.
 817  *
 818  * Returns:
 819  * a refcounted pointer to the &amdgpu_bo buffer object.
 820  */
 821 struct amdgpu_bo *amdgpu_bo_ref(struct amdgpu_bo *bo)
 822 {
 823         if (bo == NULL)
 824                 return NULL;
 825
 826         ttm_bo_reference(&bo->tbo);
 827         return bo;
 828 }
 829
 830 /**
 831  * amdgpu_bo_unref - unreference an &amdgpu_bo buffer object
 832  * @bo: &amdgpu_bo buffer object
 833  *
 834  * Unreferences the contained &ttm_buffer_object and clear the pointer
 835  */
 836 void amdgpu_bo_unref(struct amdgpu_bo **bo)
 837 {
 838         struct ttm_buffer_object *tbo;
 839
 840         if ((*bo) == NULL)
 841                 return;
 842
 843         tbo = &((*bo)->tbo);
 844         ttm_bo_unref(&tbo);
 845         if (tbo == NULL)
 846                 *bo = NULL;
 847 }
 848
 849 /**
 850  * amdgpu_bo_pin_restricted - pin an &amdgpu_bo buffer object
 851  * @bo: &amdgpu_bo buffer object to be pinned
 852  * @domain: domain to be pinned to
 853  * @min_offset: the start of requested address range
 854  * @max_offset: the end of requested address range
 855  *
 856  * Pins the buffer object according to requested domain and address range. If
 857  * the memory is unbound gart memory, binds the pages into gart table. Adjusts
 858  * pin_count and pin_size accordingly.
 859  *
 860  * Pinning means to lock pages in memory along with keeping them at a fixed
 861  * offset. It is required when a buffer can not be moved, for example, when
 862  * a display buffer is being scanned out.
 863  *
 864  * Compared with amdgpu_bo_pin(), this function gives more flexibility on
 865  * where to pin a buffer if there are specific restrictions on where a buffer
 866  * must be located.
 867  *
 868  * Returns:
 869  * 0 for success or a negative error code on failure.
 870  */
 871 int amdgpu_bo_pin_restricted(struct amdgpu_bo *bo, u32 domain,
 872                              u64 min_offset, u64 max_offset)
 873 {
 874         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
 875         struct ttm_operation_ctx ctx = { false, false };
 876         int r, i;
 877
 878         if (amdgpu_ttm_tt_get_usermm(bo->tbo.ttm))
 879                 return -EPERM;
 880
 881         if (WARN_ON_ONCE(min_offset > max_offset))
 882                 return -EINVAL;
 883
 884         /* A shared bo cannot be migrated to VRAM */
 885         if (bo->prime_shared_count) {
 886                 if (domain & AMDGPU_GEM_DOMAIN_GTT)
 887                         domain = AMDGPU_GEM_DOMAIN_GTT;
 888                 else
 889                         return -EINVAL;
 890         }
 891
 892         /* This assumes only APU display buffers are pinned with (VRAM|GTT).
 893          * See function amdgpu_display_supported_domains()
 894          */
 895         domain = amdgpu_bo_get_preferred_pin_domain(adev, domain);
 896
 897         if (bo->pin_count) {
 898                 uint32_t mem_type = bo->tbo.mem.mem_type;
 899
 900                 if (!(domain & amdgpu_mem_type_to_domain(mem_type)))
 901                         return -EINVAL;
 902
 903                 bo->pin_count++;
 904
 905                 if (max_offset != 0) {
 906                         u64 domain_start = bo->tbo.bdev->man[mem_type].gpu_offset;
 907                         WARN_ON_ONCE(max_offset <
 908                                      (amdgpu_bo_gpu_offset(bo) - domain_start));
 909                 }
 910
 911                 return 0;
 912         }
 913
 914         bo->flags |= AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS;
 915         /* force to pin into visible video ram */
 916         if (!(bo->flags & AMDGPU_GEM_CREATE_NO_CPU_ACCESS))
 917                 bo->flags |= AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
 918         amdgpu_ttm_placement_from_domain(bo, domain);
 919         for (i = 0; i < bo->placement.num_placement; i++) {
 920                 unsigned fpfn, lpfn;
 921
 922                 fpfn = min_offset >> PAGE_SHIFT;
 923                 lpfn = max_offset >> PAGE_SHIFT;
 924
 925                 if (fpfn > bo->placements[i].fpfn)
 926                         bo->placements[i].fpfn = fpfn;
 927                 if (!bo->placements[i].lpfn ||
 928                     (lpfn && lpfn < bo->placements[i].lpfn))
 929                         bo->placements[i].lpfn = lpfn;
 930                 bo->placements[i].flags |= TTM_PL_FLAG_NO_EVICT;
 931         }
 932
 933         r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
 934         if (unlikely(r)) {
 935                 dev_err(adev->dev, "%p pin failed\n", bo);
 936                 goto error;
 937         }
 938
 939         bo->pin_count = 1;
 940
 941         domain = amdgpu_mem_type_to_domain(bo->tbo.mem.mem_type);
 942         if (domain == AMDGPU_GEM_DOMAIN_VRAM) {
 943                 atomic64_add(amdgpu_bo_size(bo), &adev->vram_pin_size);
 944                 atomic64_add(amdgpu_vram_mgr_bo_visible_size(bo),
 945                              &adev->visible_pin_size);
 946         } else if (domain == AMDGPU_GEM_DOMAIN_GTT) {
 947                 atomic64_add(amdgpu_bo_size(bo), &adev->gart_pin_size);
 948         }
 949
 950 error:
 951         return r;
 952 }
 953
 954 /**
 955  * amdgpu_bo_pin - pin an &amdgpu_bo buffer object
 956  * @bo: &amdgpu_bo buffer object to be pinned
 957  * @domain: domain to be pinned to
 958  *
 959  * A simple wrapper to amdgpu_bo_pin_restricted().
 960  * Provides a simpler API for buffers that do not have any strict restrictions
 961  * on where a buffer must be located.
 962  *
 963  * Returns:
 964  * 0 for success or a negative error code on failure.
 965  */
 966 int amdgpu_bo_pin(struct amdgpu_bo *bo, u32 domain)
 967 {
 968         return amdgpu_bo_pin_restricted(bo, domain, 0, 0);
 969 }
 970
 971 /**
 972  * amdgpu_bo_unpin - unpin an &amdgpu_bo buffer object
 973  * @bo: &amdgpu_bo buffer object to be unpinned
 974  *
 975  * Decreases the pin_count, and clears the flags if pin_count reaches 0.
 976  * Changes placement and pin size accordingly.
 977  *
 978  * Returns:
 979  * 0 for success or a negative error code on failure.
 980  */
 981 int amdgpu_bo_unpin(struct amdgpu_bo *bo)
 982 {
 983         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
 984         struct ttm_operation_ctx ctx = { false, false };
 985         int r, i;
 986
 987         if (!bo->pin_count) {
 988                 dev_warn(adev->dev, "%p unpin not necessary\n", bo);
 989                 return 0;
 990         }
 991         bo->pin_count--;
 992         if (bo->pin_count)
 993                 return 0;
 994
 995         amdgpu_bo_subtract_pin_size(bo);
 996
 997         for (i = 0; i < bo->placement.num_placement; i++) {
 998                 bo->placements[i].lpfn = 0;
 999                 bo->placements[i].flags &= ~TTM_PL_FLAG_NO_EVICT;
1000         }
1001         r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
1002         if (unlikely(r))
1003                 dev_err(adev->dev, "%p validate failed for unpin\n", bo);
1004
1005         return r;
1006 }
1007
1008 /**
1009  * amdgpu_bo_evict_vram - evict VRAM buffers
1010  * @adev: amdgpu device object
1011  *
1012  * Evicts all VRAM buffers on the lru list of the memory type.
1013  * Mainly used for evicting vram at suspend time.
1014  *
1015  * Returns:
1016  * 0 for success or a negative error code on failure.
1017  */
1018 int amdgpu_bo_evict_vram(struct amdgpu_device *adev)
1019 {
1020         /* late 2.6.33 fix IGP hibernate - we need pm ops to do this correct */
1021         if (0 && (adev->flags & AMD_IS_APU)) {
1022                 /* Useless to evict on IGP chips */
1023                 return 0;
1024         }
1025         return ttm_bo_evict_mm(&adev->mman.bdev, TTM_PL_VRAM);
1026 }
1027
1028 static const char *amdgpu_vram_names[] = {
1029         "UNKNOWN",
1030         "GDDR1",
1031         "DDR2",
1032         "GDDR3",
1033         "GDDR4",
1034         "GDDR5",
1035         "HBM",
1036         "DDR3",
1037         "DDR4",
1038 };
1039
1040 /**
1041  * amdgpu_bo_init - initialize memory manager
1042  * @adev: amdgpu device object
1043  *
1044  * Calls amdgpu_ttm_init() to initialize amdgpu memory manager.
1045  *
1046  * Returns:
1047  * 0 for success or a negative error code on failure.
1048  */
1049 int amdgpu_bo_init(struct amdgpu_device *adev)
1050 {
1051         /* reserve PAT memory space to WC for VRAM */
1052         arch_io_reserve_memtype_wc(adev->gmc.aper_base,
1053                                    adev->gmc.aper_size);
1054
1055         /* Add an MTRR for the VRAM */
1056         adev->gmc.vram_mtrr = arch_phys_wc_add(adev->gmc.aper_base,
1057                                               adev->gmc.aper_size);
1058         DRM_INFO("Detected VRAM RAM=%lluM, BAR=%lluM\n",
1059                  adev->gmc.mc_vram_size >> 20,
1060                  (unsigned long long)adev->gmc.aper_size >> 20);
1061         DRM_INFO("RAM width %dbits %s\n",
1062                  adev->gmc.vram_width, amdgpu_vram_names[adev->gmc.vram_type]);
1063         return amdgpu_ttm_init(adev);
1064 }
1065
1066 /**
1067  * amdgpu_bo_late_init - late init
1068  * @adev: amdgpu device object
1069  *
1070  * Calls amdgpu_ttm_late_init() to free resources used earlier during
1071  * initialization.
1072  *
1073  * Returns:
1074  * 0 for success or a negative error code on failure.
1075  */
1076 int amdgpu_bo_late_init(struct amdgpu_device *adev)
1077 {
1078         amdgpu_ttm_late_init(adev);
1079
1080         return 0;
1081 }
1082
1083 /**
1084  * amdgpu_bo_fini - tear down memory manager
1085  * @adev: amdgpu device object
1086  *
1087  * Reverses amdgpu_bo_init() to tear down memory manager.
1088  */
1089 void amdgpu_bo_fini(struct amdgpu_device *adev)
1090 {
1091         amdgpu_ttm_fini(adev);
1092         arch_phys_wc_del(adev->gmc.vram_mtrr);
1093         arch_io_free_memtype_wc(adev->gmc.aper_base, adev->gmc.aper_size);
1094 }
1095
1096 /**
1097  * amdgpu_bo_fbdev_mmap - mmap fbdev memory
1098  * @bo: &amdgpu_bo buffer object
1099  * @vma: vma as input from the fbdev mmap method
1100  *
1101  * Calls ttm_fbdev_mmap() to mmap fbdev memory if it is backed by a bo.
1102  *
1103  * Returns:
1104  * 0 for success or a negative error code on failure.
1105  */
1106 int amdgpu_bo_fbdev_mmap(struct amdgpu_bo *bo,
1107                              struct vm_area_struct *vma)
1108 {
1109         return ttm_fbdev_mmap(vma, &bo->tbo);
1110 }
1111
1112 /**
1113  * amdgpu_bo_set_tiling_flags - set tiling flags
1114  * @bo: &amdgpu_bo buffer object
1115  * @tiling_flags: new flags
1116  *
1117  * Sets buffer object's tiling flags with the new one. Used by GEM ioctl or
1118  * kernel driver to set the tiling flags on a buffer.
1119  *
1120  * Returns:
1121  * 0 for success or a negative error code on failure.
1122  */
1123 int amdgpu_bo_set_tiling_flags(struct amdgpu_bo *bo, u64 tiling_flags)
1124 {
1125         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
1126
1127         if (adev->family <= AMDGPU_FAMILY_CZ &&
1128             AMDGPU_TILING_GET(tiling_flags, TILE_SPLIT) > 6)
1129                 return -EINVAL;
1130
1131         bo->tiling_flags = tiling_flags;
1132         return 0;
1133 }
1134
1135 /**
1136  * amdgpu_bo_get_tiling_flags - get tiling flags
1137  * @bo: &amdgpu_bo buffer object
1138  * @tiling_flags: returned flags
1139  *
1140  * Gets buffer object's tiling flags. Used by GEM ioctl or kernel driver to
1141  * set the tiling flags on a buffer.
1142  */
1143 void amdgpu_bo_get_tiling_flags(struct amdgpu_bo *bo, u64 *tiling_flags)
1144 {
1145         lockdep_assert_held(&bo->tbo.resv->lock.base);
1146
1147         if (tiling_flags)
1148                 *tiling_flags = bo->tiling_flags;
1149 }
1150
1151 /**
1152  * amdgpu_bo_set_metadata - set metadata
1153  * @bo: &amdgpu_bo buffer object
1154  * @metadata: new metadata
1155  * @metadata_size: size of the new metadata
1156  * @flags: flags of the new metadata
1157  *
1158  * Sets buffer object's metadata, its size and flags.
1159  * Used via GEM ioctl.
1160  *
1161  * Returns:
1162  * 0 for success or a negative error code on failure.
1163  */
1164 int amdgpu_bo_set_metadata (struct amdgpu_bo *bo, void *metadata,
1165                             uint32_t metadata_size, uint64_t flags)
1166 {
1167         void *buffer;
1168
1169         if (!metadata_size) {
1170                 if (bo->metadata_size) {
1171                         kfree(bo->metadata);
1172                         bo->metadata = NULL;
1173                         bo->metadata_size = 0;
1174                 }
1175                 return 0;
1176         }
1177
1178         if (metadata == NULL)
1179                 return -EINVAL;
1180
1181         buffer = kmemdup(metadata, metadata_size, GFP_KERNEL);
1182         if (buffer == NULL)
1183                 return -ENOMEM;
1184
1185         kfree(bo->metadata);
1186         bo->metadata_flags = flags;
1187         bo->metadata = buffer;
1188         bo->metadata_size = metadata_size;
1189
1190         return 0;
1191 }
1192
1193 /**
1194  * amdgpu_bo_get_metadata - get metadata
1195  * @bo: &amdgpu_bo buffer object
1196  * @buffer: returned metadata
1197  * @buffer_size: size of the buffer
1198  * @metadata_size: size of the returned metadata
1199  * @flags: flags of the returned metadata
1200  *
1201  * Gets buffer object's metadata, its size and flags. buffer_size shall not be
1202  * less than metadata_size.
1203  * Used via GEM ioctl.
1204  *
1205  * Returns:
1206  * 0 for success or a negative error code on failure.
1207  */
1208 int amdgpu_bo_get_metadata(struct amdgpu_bo *bo, void *buffer,
1209                            size_t buffer_size, uint32_t *metadata_size,
1210                            uint64_t *flags)
1211 {
1212         if (!buffer && !metadata_size)
1213                 return -EINVAL;
1214
1215         if (buffer) {
1216                 if (buffer_size < bo->metadata_size)
1217                         return -EINVAL;
1218
1219                 if (bo->metadata_size)
1220                         memcpy(buffer, bo->metadata, bo->metadata_size);
1221         }
1222
1223         if (metadata_size)
1224                 *metadata_size = bo->metadata_size;
1225         if (flags)
1226                 *flags = bo->metadata_flags;
1227
1228         return 0;
1229 }
1230
1231 /**
1232  * amdgpu_bo_move_notify - notification about a memory move
1233  * @bo: pointer to a buffer object
1234  * @evict: if this move is evicting the buffer from the graphics address space
1235  * @new_mem: new information of the bufer object
1236  *
1237  * Marks the corresponding &amdgpu_bo buffer object as invalid, also performs
1238  * bookkeeping.
1239  * TTM driver callback which is called when ttm moves a buffer.
1240  */
1241 void amdgpu_bo_move_notify(struct ttm_buffer_object *bo,
1242                            bool evict,
1243                            struct ttm_mem_reg *new_mem)
1244 {
1245         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->bdev);
1246         struct amdgpu_bo *abo;
1247         struct ttm_mem_reg *old_mem = &bo->mem;
1248
1249         if (!amdgpu_ttm_bo_is_amdgpu_bo(bo))
1250                 return;
1251
1252         abo = ttm_to_amdgpu_bo(bo);
1253         amdgpu_vm_bo_invalidate(adev, abo, evict);
1254
1255         amdgpu_bo_kunmap(abo);
1256
1257         /* remember the eviction */
1258         if (evict)
1259                 atomic64_inc(&adev->num_evictions);
1260
1261         /* update statistics */
1262         if (!new_mem)
1263                 return;
1264
1265         /* move_notify is called before move happens */
1266         trace_amdgpu_ttm_bo_move(abo, new_mem->mem_type, old_mem->mem_type);
1267 }
1268
1269 /**
1270  * amdgpu_bo_fault_reserve_notify - notification about a memory fault
1271  * @bo: pointer to a buffer object
1272  *
1273  * Notifies the driver we are taking a fault on this BO and have reserved it,
1274  * also performs bookkeeping.
1275  * TTM driver callback for dealing with vm faults.
1276  *
1277  * Returns:
1278  * 0 for success or a negative error code on failure.
1279  */
1280 int amdgpu_bo_fault_reserve_notify(struct ttm_buffer_object *bo)
1281 {
1282         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->bdev);
1283         struct ttm_operation_ctx ctx = { false, false };
1284         struct amdgpu_bo *abo;
1285         unsigned long offset, size;
1286         int r;
1287
1288         if (!amdgpu_ttm_bo_is_amdgpu_bo(bo))
1289                 return 0;
1290
1291         abo = ttm_to_amdgpu_bo(bo);
1292
1293         /* Remember that this BO was accessed by the CPU */
1294         abo->flags |= AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
1295
1296         if (bo->mem.mem_type != TTM_PL_VRAM)
1297                 return 0;
1298
1299         size = bo->mem.num_pages << PAGE_SHIFT;
1300         offset = bo->mem.start << PAGE_SHIFT;
1301         if ((offset + size) <= adev->gmc.visible_vram_size)
1302                 return 0;
1303
1304         /* Can't move a pinned BO to visible VRAM */
1305         if (abo->pin_count > 0)
1306                 return -EINVAL;
1307
1308         /* hurrah the memory is not visible ! */
1309         atomic64_inc(&adev->num_vram_cpu_page_faults);
1310         amdgpu_ttm_placement_from_domain(abo, AMDGPU_GEM_DOMAIN_VRAM |
1311                                          AMDGPU_GEM_DOMAIN_GTT);
1312
1313         /* Avoid costly evictions; only set GTT as a busy placement */
1314         abo->placement.num_busy_placement = 1;
1315         abo->placement.busy_placement = &abo->placements[1];
1316
1317         r = ttm_bo_validate(bo, &abo->placement, &ctx);
1318         if (unlikely(r != 0))
1319                 return r;
1320
1321         offset = bo->mem.start << PAGE_SHIFT;
1322         /* this should never happen */
1323         if (bo->mem.mem_type == TTM_PL_VRAM &&
1324             (offset + size) > adev->gmc.visible_vram_size)
1325                 return -EINVAL;
1326
1327         return 0;
1328 }
1329
1330 /**
1331  * amdgpu_bo_fence - add fence to buffer object
1332  *
1333  * @bo: buffer object in question
1334  * @fence: fence to add
1335  * @shared: true if fence should be added shared
1336  *
1337  */
1338 void amdgpu_bo_fence(struct amdgpu_bo *bo, struct dma_fence *fence,
1339                      bool shared)
1340 {
1341         struct reservation_object *resv = bo->tbo.resv;
1342
1343         if (shared)
1344                 reservation_object_add_shared_fence(resv, fence);
1345         else
1346                 reservation_object_add_excl_fence(resv, fence);
1347 }
1348
1349 /**
1350  * amdgpu_bo_gpu_offset - return GPU offset of bo
1351  * @bo: amdgpu object for which we query the offset
1352  *
1353  * Note: object should either be pinned or reserved when calling this
1354  * function, it might be useful to add check for this for debugging.
1355  *
1356  * Returns:
1357  * current GPU offset of the object.
1358  */
1359 u64 amdgpu_bo_gpu_offset(struct amdgpu_bo *bo)
1360 {
1361         WARN_ON_ONCE(bo->tbo.mem.mem_type == TTM_PL_SYSTEM);
1362         WARN_ON_ONCE(bo->tbo.mem.mem_type == TTM_PL_TT &&
1363                      !amdgpu_gtt_mgr_has_gart_addr(&bo->tbo.mem));
1364         WARN_ON_ONCE(!ww_mutex_is_locked(&bo->tbo.resv->lock) &&
1365                      !bo->pin_count);
1366         WARN_ON_ONCE(bo->tbo.mem.start == AMDGPU_BO_INVALID_OFFSET);
1367         WARN_ON_ONCE(bo->tbo.mem.mem_type == TTM_PL_VRAM &&
1368                      !(bo->flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS));
1369
1370         return bo->tbo.offset;
1371 }
1372
1373 /**
1374  * amdgpu_bo_get_preferred_pin_domain - get preferred domain for scanout
1375  * @adev: amdgpu device object
1376  * @domain: allowed :ref:`memory domains <amdgpu_memory_domains>`
1377  *
1378  * Returns:
1379  * Which of the allowed domains is preferred for pinning the BO for scanout.
1380  */
1381 uint32_t amdgpu_bo_get_preferred_pin_domain(struct amdgpu_device *adev,
1382                                             uint32_t domain)
1383 {
1384         if (domain == (AMDGPU_GEM_DOMAIN_VRAM | AMDGPU_GEM_DOMAIN_GTT)) {
1385                 domain = AMDGPU_GEM_DOMAIN_VRAM;
1386                 if (adev->gmc.real_vram_size <= AMDGPU_SG_THRESHOLD)
1387                         domain = AMDGPU_GEM_DOMAIN_GTT;
1388         }
1389         return domain;
1390 }