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         memset(&bp, 0, sizeof(bp));
 254         bp.size = size;
 255         bp.byte_align = align;
 256         bp.domain = domain;
 257         bp.flags = AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED |
 258                 AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS;
 259         bp.type = ttm_bo_type_kernel;
 260         bp.resv = NULL;
 261
 262         if (!*bo_ptr) {
 263                 r = amdgpu_bo_create(adev, &bp, bo_ptr);
 264                 if (r) {
 265                         dev_err(adev->dev, "(%d) failed to allocate kernel bo\n",
 266                                 r);
 267                         return r;
 268                 }
 269                 free = true;
 270         }
 271
 272         r = amdgpu_bo_reserve(*bo_ptr, false);
 273         if (r) {
 274                 dev_err(adev->dev, "(%d) failed to reserve kernel bo\n", r);
 275                 goto error_free;
 276         }
 277
 278         r = amdgpu_bo_pin(*bo_ptr, domain);
 279         if (r) {
 280                 dev_err(adev->dev, "(%d) kernel bo pin failed\n", r);
 281                 goto error_unreserve;
 282         }
 283
 284         r = amdgpu_ttm_alloc_gart(&(*bo_ptr)->tbo);
 285         if (r) {
 286                 dev_err(adev->dev, "%p bind failed\n", *bo_ptr);
 287                 goto error_unpin;
 288         }
 289
 290         if (gpu_addr)
 291                 *gpu_addr = amdgpu_bo_gpu_offset(*bo_ptr);
 292
 293         if (cpu_addr) {
 294                 r = amdgpu_bo_kmap(*bo_ptr, cpu_addr);
 295                 if (r) {
 296                         dev_err(adev->dev, "(%d) kernel bo map failed\n", r);
 297                         goto error_unpin;
 298                 }
 299         }
 300
 301         return 0;
 302
 303 error_unpin:
 304         amdgpu_bo_unpin(*bo_ptr);
 305 error_unreserve:
 306         amdgpu_bo_unreserve(*bo_ptr);
 307
 308 error_free:
 309         if (free)
 310                 amdgpu_bo_unref(bo_ptr);
 311
 312         return r;
 313 }
 314
 315 /**
 316  * amdgpu_bo_create_kernel - create BO for kernel use
 317  *
 318  * @adev: amdgpu device object
 319  * @size: size for the new BO
 320  * @align: alignment for the new BO
 321  * @domain: where to place it
 322  * @bo_ptr:  used to initialize BOs in structures
 323  * @gpu_addr: GPU addr of the pinned BO
 324  * @cpu_addr: optional CPU address mapping
 325  *
 326  * Allocates and pins a BO for kernel internal use.
 327  *
 328  * Note: For bo_ptr new BO is only created if bo_ptr points to NULL.
 329  *
 330  * Returns:
 331  * 0 on success, negative error code otherwise.
 332  */
 333 int amdgpu_bo_create_kernel(struct amdgpu_device *adev,
 334                             unsigned long size, int align,
 335                             u32 domain, struct amdgpu_bo **bo_ptr,
 336                             u64 *gpu_addr, void **cpu_addr)
 337 {
 338         int r;
 339
 340         r = amdgpu_bo_create_reserved(adev, size, align, domain, bo_ptr,
 341                                       gpu_addr, cpu_addr);
 342
 343         if (r)
 344                 return r;
 345
 346         amdgpu_bo_unreserve(*bo_ptr);
 347
 348         return 0;
 349 }
 350
 351 /**
 352  * amdgpu_bo_free_kernel - free BO for kernel use
 353  *
 354  * @bo: amdgpu BO to free
 355  * @gpu_addr: pointer to where the BO's GPU memory space address was stored
 356  * @cpu_addr: pointer to where the BO's CPU memory space address was stored
 357  *
 358  * unmaps and unpin a BO for kernel internal use.
 359  */
 360 void amdgpu_bo_free_kernel(struct amdgpu_bo **bo, u64 *gpu_addr,
 361                            void **cpu_addr)
 362 {
 363         if (*bo == NULL)
 364                 return;
 365
 366         if (likely(amdgpu_bo_reserve(*bo, true) == 0)) {
 367                 if (cpu_addr)
 368                         amdgpu_bo_kunmap(*bo);
 369
 370                 amdgpu_bo_unpin(*bo);
 371                 amdgpu_bo_unreserve(*bo);
 372         }
 373         amdgpu_bo_unref(bo);
 374
 375         if (gpu_addr)
 376                 *gpu_addr = 0;
 377
 378         if (cpu_addr)
 379                 *cpu_addr = NULL;
 380 }
 381
 382 /* Validate bo size is bit bigger then the request domain */
 383 static bool amdgpu_bo_validate_size(struct amdgpu_device *adev,
 384                                           unsigned long size, u32 domain)
 385 {
 386         struct ttm_mem_type_manager *man = NULL;
 387
 388         /*
 389          * If GTT is part of requested domains the check must succeed to
 390          * allow fall back to GTT
 391          */
 392         if (domain & AMDGPU_GEM_DOMAIN_GTT) {
 393                 man = &adev->mman.bdev.man[TTM_PL_TT];
 394
 395                 if (size < (man->size << PAGE_SHIFT))
 396                         return true;
 397                 else
 398                         goto fail;
 399         }
 400
 401         if (domain & AMDGPU_GEM_DOMAIN_VRAM) {
 402                 man = &adev->mman.bdev.man[TTM_PL_VRAM];
 403
 404                 if (size < (man->size << PAGE_SHIFT))
 405                         return true;
 406                 else
 407                         goto fail;
 408         }
 409
 410
 411         /* TODO add more domains checks, such as AMDGPU_GEM_DOMAIN_CPU */
 412         return true;
 413
 414 fail:
 415         DRM_DEBUG("BO size %lu > total memory in domain: %llu\n", size,
 416                   man->size << PAGE_SHIFT);
 417         return false;
 418 }
 419
 420 static int amdgpu_bo_do_create(struct amdgpu_device *adev,
 421                                struct amdgpu_bo_param *bp,
 422                                struct amdgpu_bo **bo_ptr)
 423 {
 424         struct ttm_operation_ctx ctx = {
 425                 .interruptible = (bp->type != ttm_bo_type_kernel),
 426                 .no_wait_gpu = false,
 427                 .resv = bp->resv,
 428                 .flags = TTM_OPT_FLAG_ALLOW_RES_EVICT
 429         };
 430         struct amdgpu_bo *bo;
 431         unsigned long page_align, size = bp->size;
 432         size_t acc_size;
 433         int r;
 434
 435         page_align = roundup(bp->byte_align, PAGE_SIZE) >> PAGE_SHIFT;
 436         size = ALIGN(size, PAGE_SIZE);
 437
 438         if (!amdgpu_bo_validate_size(adev, size, bp->domain))
 439                 return -ENOMEM;
 440
 441         *bo_ptr = NULL;
 442
 443         acc_size = ttm_bo_dma_acc_size(&adev->mman.bdev, size,
 444                                        sizeof(struct amdgpu_bo));
 445
 446         bo = kzalloc(sizeof(struct amdgpu_bo), GFP_KERNEL);
 447         if (bo == NULL)
 448                 return -ENOMEM;
 449         drm_gem_private_object_init(adev->ddev, &bo->gem_base, size);
 450         INIT_LIST_HEAD(&bo->shadow_list);
 451         INIT_LIST_HEAD(&bo->va);
 452         bo->preferred_domains = bp->preferred_domain ? bp->preferred_domain :
 453                 bp->domain;
 454         bo->allowed_domains = bo->preferred_domains;
 455         if (bp->type != ttm_bo_type_kernel &&
 456             bo->allowed_domains == AMDGPU_GEM_DOMAIN_VRAM)
 457                 bo->allowed_domains |= AMDGPU_GEM_DOMAIN_GTT;
 458
 459         bo->flags = bp->flags;
 460
 461 #ifdef CONFIG_X86_32
 462         /* XXX: Write-combined CPU mappings of GTT seem broken on 32-bit
 463          * See https://bugs.freedesktop.org/show_bug.cgi?id=84627
 464          */
 465         bo->flags &= ~AMDGPU_GEM_CREATE_CPU_GTT_USWC;
 466 #elif defined(CONFIG_X86) && !defined(CONFIG_X86_PAT)
 467         /* Don't try to enable write-combining when it can't work, or things
 468          * may be slow
 469          * See https://bugs.freedesktop.org/show_bug.cgi?id=88758
 470          */
 471
 472 #ifndef CONFIG_COMPILE_TEST
 473 #warning Please enable CONFIG_MTRR and CONFIG_X86_PAT for better performance \
 474          thanks to write-combining
 475 #endif
 476
 477         if (bo->flags & AMDGPU_GEM_CREATE_CPU_GTT_USWC)
 478                 DRM_INFO_ONCE("Please enable CONFIG_MTRR and CONFIG_X86_PAT for "
 479                               "better performance thanks to write-combining\n");
 480         bo->flags &= ~AMDGPU_GEM_CREATE_CPU_GTT_USWC;
 481 #else
 482         /* For architectures that don't support WC memory,
 483          * mask out the WC flag from the BO
 484          */
 485         if (!drm_arch_can_wc_memory())
 486                 bo->flags &= ~AMDGPU_GEM_CREATE_CPU_GTT_USWC;
 487 #endif
 488
 489         bo->tbo.bdev = &adev->mman.bdev;
 490         amdgpu_bo_placement_from_domain(bo, bp->domain);
 491         if (bp->type == ttm_bo_type_kernel)
 492                 bo->tbo.priority = 1;
 493
 494         r = ttm_bo_init_reserved(&adev->mman.bdev, &bo->tbo, size, bp->type,
 495                                  &bo->placement, page_align, &ctx, acc_size,
 496                                  NULL, bp->resv, &amdgpu_bo_destroy);
 497         if (unlikely(r != 0))
 498                 return r;
 499
 500         if (!amdgpu_gmc_vram_full_visible(&adev->gmc) &&
 501             bo->tbo.mem.mem_type == TTM_PL_VRAM &&
 502             bo->tbo.mem.start < adev->gmc.visible_vram_size >> PAGE_SHIFT)
 503                 amdgpu_cs_report_moved_bytes(adev, ctx.bytes_moved,
 504                                              ctx.bytes_moved);
 505         else
 506                 amdgpu_cs_report_moved_bytes(adev, ctx.bytes_moved, 0);
 507
 508         if (bp->flags & AMDGPU_GEM_CREATE_VRAM_CLEARED &&
 509             bo->tbo.mem.placement & TTM_PL_FLAG_VRAM) {
 510                 struct dma_fence *fence;
 511
 512                 r = amdgpu_fill_buffer(bo, 0, bo->tbo.resv, &fence);
 513                 if (unlikely(r))
 514                         goto fail_unreserve;
 515
 516                 amdgpu_bo_fence(bo, fence, false);
 517                 dma_fence_put(bo->tbo.moving);
 518                 bo->tbo.moving = dma_fence_get(fence);
 519                 dma_fence_put(fence);
 520         }
 521         if (!bp->resv)
 522                 amdgpu_bo_unreserve(bo);
 523         *bo_ptr = bo;
 524
 525         trace_amdgpu_bo_create(bo);
 526
 527         /* Treat CPU_ACCESS_REQUIRED only as a hint if given by UMD */
 528         if (bp->type == ttm_bo_type_device)
 529                 bo->flags &= ~AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
 530
 531         return 0;
 532
 533 fail_unreserve:
 534         if (!bp->resv)
 535                 ww_mutex_unlock(&bo->tbo.resv->lock);
 536         amdgpu_bo_unref(&bo);
 537         return r;
 538 }
 539
 540 static int amdgpu_bo_create_shadow(struct amdgpu_device *adev,
 541                                    unsigned long size, int byte_align,
 542                                    struct amdgpu_bo *bo)
 543 {
 544         struct amdgpu_bo_param bp;
 545         int r;
 546
 547         if (bo->shadow)
 548                 return 0;
 549
 550         memset(&bp, 0, sizeof(bp));
 551         bp.size = size;
 552         bp.byte_align = byte_align;
 553         bp.domain = AMDGPU_GEM_DOMAIN_GTT;
 554         bp.flags = AMDGPU_GEM_CREATE_CPU_GTT_USWC |
 555                 AMDGPU_GEM_CREATE_SHADOW;
 556         bp.type = ttm_bo_type_kernel;
 557         bp.resv = bo->tbo.resv;
 558
 559         r = amdgpu_bo_do_create(adev, &bp, &bo->shadow);
 560         if (!r) {
 561                 bo->shadow->parent = amdgpu_bo_ref(bo);
 562                 mutex_lock(&adev->shadow_list_lock);
 563                 list_add_tail(&bo->shadow_list, &adev->shadow_list);
 564                 mutex_unlock(&adev->shadow_list_lock);
 565         }
 566
 567         return r;
 568 }
 569
 570 /**
 571  * amdgpu_bo_create - create an &amdgpu_bo buffer object
 572  * @adev: amdgpu device object
 573  * @bp: parameters to be used for the buffer object
 574  * @bo_ptr: pointer to the buffer object pointer
 575  *
 576  * Creates an &amdgpu_bo buffer object; and if requested, also creates a
 577  * shadow object.
 578  * Shadow object is used to backup the original buffer object, and is always
 579  * in GTT.
 580  *
 581  * Returns:
 582  * 0 for success or a negative error code on failure.
 583  */
 584 int amdgpu_bo_create(struct amdgpu_device *adev,
 585                      struct amdgpu_bo_param *bp,
 586                      struct amdgpu_bo **bo_ptr)
 587 {
 588         u64 flags = bp->flags;
 589         int r;
 590
 591         bp->flags = bp->flags & ~AMDGPU_GEM_CREATE_SHADOW;
 592         r = amdgpu_bo_do_create(adev, bp, bo_ptr);
 593         if (r)
 594                 return r;
 595
 596         if ((flags & AMDGPU_GEM_CREATE_SHADOW) && amdgpu_bo_need_backup(adev)) {
 597                 if (!bp->resv)
 598                         WARN_ON(reservation_object_lock((*bo_ptr)->tbo.resv,
 599                                                         NULL));
 600
 601                 r = amdgpu_bo_create_shadow(adev, bp->size, bp->byte_align, (*bo_ptr));
 602
 603                 if (!bp->resv)
 604                         reservation_object_unlock((*bo_ptr)->tbo.resv);
 605
 606                 if (r)
 607                         amdgpu_bo_unref(bo_ptr);
 608         }
 609
 610         return r;
 611 }
 612
 613 /**
 614  * amdgpu_bo_backup_to_shadow - Backs up an &amdgpu_bo buffer object
 615  * @adev: amdgpu device object
 616  * @ring: amdgpu_ring for the engine handling the buffer operations
 617  * @bo: &amdgpu_bo buffer to be backed up
 618  * @resv: reservation object with embedded fence
 619  * @fence: dma_fence associated with the operation
 620  * @direct: whether to submit the job directly
 621  *
 622  * Copies an &amdgpu_bo buffer object to its shadow object.
 623  * Not used for now.
 624  *
 625  * Returns:
 626  * 0 for success or a negative error code on failure.
 627  */
 628 int amdgpu_bo_backup_to_shadow(struct amdgpu_device *adev,
 629                                struct amdgpu_ring *ring,
 630                                struct amdgpu_bo *bo,
 631                                struct reservation_object *resv,
 632                                struct dma_fence **fence,
 633                                bool direct)
 634
 635 {
 636         struct amdgpu_bo *shadow = bo->shadow;
 637         uint64_t bo_addr, shadow_addr;
 638         int r;
 639
 640         if (!shadow)
 641                 return -EINVAL;
 642
 643         bo_addr = amdgpu_bo_gpu_offset(bo);
 644         shadow_addr = amdgpu_bo_gpu_offset(bo->shadow);
 645
 646         r = reservation_object_reserve_shared(bo->tbo.resv);
 647         if (r)
 648                 goto err;
 649
 650         r = amdgpu_copy_buffer(ring, bo_addr, shadow_addr,
 651                                amdgpu_bo_size(bo), resv, fence,
 652                                direct, false);
 653         if (!r)
 654                 amdgpu_bo_fence(bo, *fence, true);
 655
 656 err:
 657         return r;
 658 }
 659
 660 /**
 661  * amdgpu_bo_validate - validate an &amdgpu_bo buffer object
 662  * @bo: pointer to the buffer object
 663  *
 664  * Sets placement according to domain; and changes placement and caching
 665  * policy of the buffer object according to the placement.
 666  * This is used for validating shadow bos.  It calls ttm_bo_validate() to
 667  * make sure the buffer is resident where it needs to be.
 668  *
 669  * Returns:
 670  * 0 for success or a negative error code on failure.
 671  */
 672 int amdgpu_bo_validate(struct amdgpu_bo *bo)
 673 {
 674         struct ttm_operation_ctx ctx = { false, false };
 675         uint32_t domain;
 676         int r;
 677
 678         if (bo->pin_count)
 679                 return 0;
 680
 681         domain = bo->preferred_domains;
 682
 683 retry:
 684         amdgpu_bo_placement_from_domain(bo, domain);
 685         r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
 686         if (unlikely(r == -ENOMEM) && domain != bo->allowed_domains) {
 687                 domain = bo->allowed_domains;
 688                 goto retry;
 689         }
 690
 691         return r;
 692 }
 693
 694 /**
 695  * amdgpu_bo_restore_from_shadow - restore an &amdgpu_bo buffer object
 696  * @adev: amdgpu device object
 697  * @ring: amdgpu_ring for the engine handling the buffer operations
 698  * @bo: &amdgpu_bo buffer to be restored
 699  * @resv: reservation object with embedded fence
 700  * @fence: dma_fence associated with the operation
 701  * @direct: whether to submit the job directly
 702  *
 703  * Copies a buffer object's shadow content back to the object.
 704  * This is used for recovering a buffer from its shadow in case of a gpu
 705  * reset where vram context may be lost.
 706  *
 707  * Returns:
 708  * 0 for success or a negative error code on failure.
 709  */
 710 int amdgpu_bo_restore_from_shadow(struct amdgpu_device *adev,
 711                                   struct amdgpu_ring *ring,
 712                                   struct amdgpu_bo *bo,
 713                                   struct reservation_object *resv,
 714                                   struct dma_fence **fence,
 715                                   bool direct)
 716
 717 {
 718         struct amdgpu_bo *shadow = bo->shadow;
 719         uint64_t bo_addr, shadow_addr;
 720         int r;
 721
 722         if (!shadow)
 723                 return -EINVAL;
 724
 725         bo_addr = amdgpu_bo_gpu_offset(bo);
 726         shadow_addr = amdgpu_bo_gpu_offset(bo->shadow);
 727
 728         r = reservation_object_reserve_shared(bo->tbo.resv);
 729         if (r)
 730                 goto err;
 731
 732         r = amdgpu_copy_buffer(ring, shadow_addr, bo_addr,
 733                                amdgpu_bo_size(bo), resv, fence,
 734                                direct, false);
 735         if (!r)
 736                 amdgpu_bo_fence(bo, *fence, true);
 737
 738 err:
 739         return r;
 740 }
 741
 742 /**
 743  * amdgpu_bo_kmap - map an &amdgpu_bo buffer object
 744  * @bo: &amdgpu_bo buffer object to be mapped
 745  * @ptr: kernel virtual address to be returned
 746  *
 747  * Calls ttm_bo_kmap() to set up the kernel virtual mapping; calls
 748  * amdgpu_bo_kptr() to get the kernel virtual address.
 749  *
 750  * Returns:
 751  * 0 for success or a negative error code on failure.
 752  */
 753 int amdgpu_bo_kmap(struct amdgpu_bo *bo, void **ptr)
 754 {
 755         void *kptr;
 756         long r;
 757
 758         if (bo->flags & AMDGPU_GEM_CREATE_NO_CPU_ACCESS)
 759                 return -EPERM;
 760
 761         kptr = amdgpu_bo_kptr(bo);
 762         if (kptr) {
 763                 if (ptr)
 764                         *ptr = kptr;
 765                 return 0;
 766         }
 767
 768         r = reservation_object_wait_timeout_rcu(bo->tbo.resv, false, false,
 769                                                 MAX_SCHEDULE_TIMEOUT);
 770         if (r < 0)
 771                 return r;
 772
 773         r = ttm_bo_kmap(&bo->tbo, 0, bo->tbo.num_pages, &bo->kmap);
 774         if (r)
 775                 return r;
 776
 777         if (ptr)
 778                 *ptr = amdgpu_bo_kptr(bo);
 779
 780         return 0;
 781 }
 782
 783 /**
 784  * amdgpu_bo_kptr - returns a kernel virtual address of the buffer object
 785  * @bo: &amdgpu_bo buffer object
 786  *
 787  * Calls ttm_kmap_obj_virtual() to get the kernel virtual address
 788  *
 789  * Returns:
 790  * the virtual address of a buffer object area.
 791  */
 792 void *amdgpu_bo_kptr(struct amdgpu_bo *bo)
 793 {
 794         bool is_iomem;
 795
 796         return ttm_kmap_obj_virtual(&bo->kmap, &is_iomem);
 797 }
 798
 799 /**
 800  * amdgpu_bo_kunmap - unmap an &amdgpu_bo buffer object
 801  * @bo: &amdgpu_bo buffer object to be unmapped
 802  *
 803  * Unmaps a kernel map set up by amdgpu_bo_kmap().
 804  */
 805 void amdgpu_bo_kunmap(struct amdgpu_bo *bo)
 806 {
 807         if (bo->kmap.bo)
 808                 ttm_bo_kunmap(&bo->kmap);
 809 }
 810
 811 /**
 812  * amdgpu_bo_ref - reference an &amdgpu_bo buffer object
 813  * @bo: &amdgpu_bo buffer object
 814  *
 815  * References the contained &ttm_buffer_object.
 816  *
 817  * Returns:
 818  * a refcounted pointer to the &amdgpu_bo buffer object.
 819  */
 820 struct amdgpu_bo *amdgpu_bo_ref(struct amdgpu_bo *bo)
 821 {
 822         if (bo == NULL)
 823                 return NULL;
 824
 825         ttm_bo_get(&bo->tbo);
 826         return bo;
 827 }
 828
 829 /**
 830  * amdgpu_bo_unref - unreference an &amdgpu_bo buffer object
 831  * @bo: &amdgpu_bo buffer object
 832  *
 833  * Unreferences the contained &ttm_buffer_object and clear the pointer
 834  */
 835 void amdgpu_bo_unref(struct amdgpu_bo **bo)
 836 {
 837         struct ttm_buffer_object *tbo;
 838
 839         if ((*bo) == NULL)
 840                 return;
 841
 842         tbo = &((*bo)->tbo);
 843         ttm_bo_put(tbo);
 844         *bo = NULL;
 845 }
 846
 847 /**
 848  * amdgpu_bo_pin_restricted - pin an &amdgpu_bo buffer object
 849  * @bo: &amdgpu_bo buffer object to be pinned
 850  * @domain: domain to be pinned to
 851  * @min_offset: the start of requested address range
 852  * @max_offset: the end of requested address range
 853  *
 854  * Pins the buffer object according to requested domain and address range. If
 855  * the memory is unbound gart memory, binds the pages into gart table. Adjusts
 856  * pin_count and pin_size accordingly.
 857  *
 858  * Pinning means to lock pages in memory along with keeping them at a fixed
 859  * offset. It is required when a buffer can not be moved, for example, when
 860  * a display buffer is being scanned out.
 861  *
 862  * Compared with amdgpu_bo_pin(), this function gives more flexibility on
 863  * where to pin a buffer if there are specific restrictions on where a buffer
 864  * must be located.
 865  *
 866  * Returns:
 867  * 0 for success or a negative error code on failure.
 868  */
 869 int amdgpu_bo_pin_restricted(struct amdgpu_bo *bo, u32 domain,
 870                              u64 min_offset, u64 max_offset)
 871 {
 872         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
 873         struct ttm_operation_ctx ctx = { false, false };
 874         int r, i;
 875
 876         if (amdgpu_ttm_tt_get_usermm(bo->tbo.ttm))
 877                 return -EPERM;
 878
 879         if (WARN_ON_ONCE(min_offset > max_offset))
 880                 return -EINVAL;
 881
 882         /* A shared bo cannot be migrated to VRAM */
 883         if (bo->prime_shared_count) {
 884                 if (domain & AMDGPU_GEM_DOMAIN_GTT)
 885                         domain = AMDGPU_GEM_DOMAIN_GTT;
 886                 else
 887                         return -EINVAL;
 888         }
 889
 890         /* This assumes only APU display buffers are pinned with (VRAM|GTT).
 891          * See function amdgpu_display_supported_domains()
 892          */
 893         domain = amdgpu_bo_get_preferred_pin_domain(adev, domain);
 894
 895         if (bo->pin_count) {
 896                 uint32_t mem_type = bo->tbo.mem.mem_type;
 897
 898                 if (!(domain & amdgpu_mem_type_to_domain(mem_type)))
 899                         return -EINVAL;
 900
 901                 bo->pin_count++;
 902
 903                 if (max_offset != 0) {
 904                         u64 domain_start = bo->tbo.bdev->man[mem_type].gpu_offset;
 905                         WARN_ON_ONCE(max_offset <
 906                                      (amdgpu_bo_gpu_offset(bo) - domain_start));
 907                 }
 908
 909                 return 0;
 910         }
 911
 912         bo->flags |= AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS;
 913         /* force to pin into visible video ram */
 914         if (!(bo->flags & AMDGPU_GEM_CREATE_NO_CPU_ACCESS))
 915                 bo->flags |= AMDGPU_GEM_CREATE_CPU_ACCESS_REQUIRED;
 916         amdgpu_bo_placement_from_domain(bo, domain);
 917         for (i = 0; i < bo->placement.num_placement; i++) {
 918                 unsigned fpfn, lpfn;
 919
 920                 fpfn = min_offset >> PAGE_SHIFT;
 921                 lpfn = max_offset >> PAGE_SHIFT;
 922
 923                 if (fpfn > bo->placements[i].fpfn)
 924                         bo->placements[i].fpfn = fpfn;
 925                 if (!bo->placements[i].lpfn ||
 926                     (lpfn && lpfn < bo->placements[i].lpfn))
 927                         bo->placements[i].lpfn = lpfn;
 928                 bo->placements[i].flags |= TTM_PL_FLAG_NO_EVICT;
 929         }
 930
 931         r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
 932         if (unlikely(r)) {
 933                 dev_err(adev->dev, "%p pin failed\n", bo);
 934                 goto error;
 935         }
 936
 937         bo->pin_count = 1;
 938
 939         domain = amdgpu_mem_type_to_domain(bo->tbo.mem.mem_type);
 940         if (domain == AMDGPU_GEM_DOMAIN_VRAM) {
 941                 atomic64_add(amdgpu_bo_size(bo), &adev->vram_pin_size);
 942                 atomic64_add(amdgpu_vram_mgr_bo_visible_size(bo),
 943                              &adev->visible_pin_size);
 944         } else if (domain == AMDGPU_GEM_DOMAIN_GTT) {
 945                 atomic64_add(amdgpu_bo_size(bo), &adev->gart_pin_size);
 946         }
 947
 948 error:
 949         return r;
 950 }
 951
 952 /**
 953  * amdgpu_bo_pin - pin an &amdgpu_bo buffer object
 954  * @bo: &amdgpu_bo buffer object to be pinned
 955  * @domain: domain to be pinned to
 956  *
 957  * A simple wrapper to amdgpu_bo_pin_restricted().
 958  * Provides a simpler API for buffers that do not have any strict restrictions
 959  * on where a buffer must be located.
 960  *
 961  * Returns:
 962  * 0 for success or a negative error code on failure.
 963  */
 964 int amdgpu_bo_pin(struct amdgpu_bo *bo, u32 domain)
 965 {
 966         return amdgpu_bo_pin_restricted(bo, domain, 0, 0);
 967 }
 968
 969 /**
 970  * amdgpu_bo_unpin - unpin an &amdgpu_bo buffer object
 971  * @bo: &amdgpu_bo buffer object to be unpinned
 972  *
 973  * Decreases the pin_count, and clears the flags if pin_count reaches 0.
 974  * Changes placement and pin size accordingly.
 975  *
 976  * Returns:
 977  * 0 for success or a negative error code on failure.
 978  */
 979 int amdgpu_bo_unpin(struct amdgpu_bo *bo)
 980 {
 981         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
 982         struct ttm_operation_ctx ctx = { false, false };
 983         int r, i;
 984
 985         if (!bo->pin_count) {
 986                 dev_warn(adev->dev, "%p unpin not necessary\n", bo);
 987                 return 0;
 988         }
 989         bo->pin_count--;
 990         if (bo->pin_count)
 991                 return 0;
 992
 993         amdgpu_bo_subtract_pin_size(bo);
 994
 995         for (i = 0; i < bo->placement.num_placement; i++) {
 996                 bo->placements[i].lpfn = 0;
 997                 bo->placements[i].flags &= ~TTM_PL_FLAG_NO_EVICT;
 998         }
 999         r = ttm_bo_validate(&bo->tbo, &bo->placement, &ctx);
1000         if (unlikely(r))
1001                 dev_err(adev->dev, "%p validate failed for unpin\n", bo);
1002
1003         return r;
1004 }
1005
1006 /**
1007  * amdgpu_bo_evict_vram - evict VRAM buffers
1008  * @adev: amdgpu device object
1009  *
1010  * Evicts all VRAM buffers on the lru list of the memory type.
1011  * Mainly used for evicting vram at suspend time.
1012  *
1013  * Returns:
1014  * 0 for success or a negative error code on failure.
1015  */
1016 int amdgpu_bo_evict_vram(struct amdgpu_device *adev)
1017 {
1018         /* late 2.6.33 fix IGP hibernate - we need pm ops to do this correct */
1019 #ifndef CONFIG_HIBERNATION
1020         if (adev->flags & AMD_IS_APU) {
1021                 /* Useless to evict on IGP chips */
1022                 return 0;
1023         }
1024 #endif
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_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_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_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_bo_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(!ww_mutex_is_locked(&bo->tbo.resv->lock) &&
1363                      !bo->pin_count);
1364         WARN_ON_ONCE(bo->tbo.mem.start == AMDGPU_BO_INVALID_OFFSET);
1365         WARN_ON_ONCE(bo->tbo.mem.mem_type == TTM_PL_VRAM &&
1366                      !(bo->flags & AMDGPU_GEM_CREATE_VRAM_CONTIGUOUS));
1367
1368         return amdgpu_gmc_sign_extend(bo->tbo.offset);
1369 }
1370
1371 /**
1372  * amdgpu_bo_get_preferred_pin_domain - get preferred domain for scanout
1373  * @adev: amdgpu device object
1374  * @domain: allowed :ref:`memory domains <amdgpu_memory_domains>`
1375  *
1376  * Returns:
1377  * Which of the allowed domains is preferred for pinning the BO for scanout.
1378  */
1379 uint32_t amdgpu_bo_get_preferred_pin_domain(struct amdgpu_device *adev,
1380                                             uint32_t domain)
1381 {
1382         if (domain == (AMDGPU_GEM_DOMAIN_VRAM | AMDGPU_GEM_DOMAIN_GTT)) {
1383                 domain = AMDGPU_GEM_DOMAIN_VRAM;
1384                 if (adev->gmc.real_vram_size <= AMDGPU_SG_THRESHOLD)
1385                         domain = AMDGPU_GEM_DOMAIN_GTT;
1386         }
1387         return domain;
1388 }