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