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