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

   1 /*
   2  * Copyright 2008 Advanced Micro Devices, Inc.
   3  * Copyright 2008 Red Hat Inc.
   4  * Copyright 2009 Jerome Glisse.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
  20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  22  * OTHER DEALINGS IN THE SOFTWARE.
  23  *
  24  * Authors: Dave Airlie
  25  *          Alex Deucher
  26  *          Jerome Glisse
  27  */
  28 #ifndef __AMDGPU_OBJECT_H__
  29 #define __AMDGPU_OBJECT_H__
  30
  31 #include <drm/amdgpu_drm.h>
  32 #include "amdgpu.h"
  33
  34 #define AMDGPU_BO_INVALID_OFFSET        LONG_MAX
  35
  36 struct amdgpu_bo_param {
  37         unsigned long                   size;
  38         int                             byte_align;
  39         u32                             domain;
  40         u64                             flags;
  41         enum ttm_bo_type                type;
  42         struct reservation_object       *resv;
  43 };
  44
  45 /* bo virtual addresses in a vm */
  46 struct amdgpu_bo_va_mapping {
  47         struct amdgpu_bo_va             *bo_va;
  48         struct list_head                list;
  49         struct rb_node                  rb;
  50         uint64_t                        start;
  51         uint64_t                        last;
  52         uint64_t                        __subtree_last;
  53         uint64_t                        offset;
  54         uint64_t                        flags;
  55 };
  56
  57 /* User space allocated BO in a VM */
  58 struct amdgpu_bo_va {
  59         struct amdgpu_vm_bo_base        base;
  60
  61         /* protected by bo being reserved */
  62         unsigned                        ref_count;
  63
  64         /* all other members protected by the VM PD being reserved */
  65         struct dma_fence                *last_pt_update;
  66
  67         /* mappings for this bo_va */
  68         struct list_head                invalids;
  69         struct list_head                valids;
  70
  71         /* If the mappings are cleared or filled */
  72         bool                            cleared;
  73 };
  74
  75 struct amdgpu_bo {
  76         /* Protected by tbo.reserved */
  77         u32                             preferred_domains;
  78         u32                             allowed_domains;
  79         struct ttm_place                placements[AMDGPU_GEM_DOMAIN_MAX + 1];
  80         struct ttm_placement            placement;
  81         struct ttm_buffer_object        tbo;
  82         struct ttm_bo_kmap_obj          kmap;
  83         u64                             flags;
  84         unsigned                        pin_count;
  85         u64                             tiling_flags;
  86         u64                             metadata_flags;
  87         void                            *metadata;
  88         u32                             metadata_size;
  89         unsigned                        prime_shared_count;
  90         /* list of all virtual address to which this bo is associated to */
  91         struct list_head                va;
  92         /* Constant after initialization */
  93         struct drm_gem_object           gem_base;
  94         struct amdgpu_bo                *parent;
  95         struct amdgpu_bo                *shadow;
  96
  97         struct ttm_bo_kmap_obj          dma_buf_vmap;
  98         struct amdgpu_mn                *mn;
  99
 100         union {
 101                 struct list_head        mn_list;
 102                 struct list_head        shadow_list;
 103         };
 104
 105         struct kgd_mem                  *kfd_bo;
 106 };
 107
 108 static inline struct amdgpu_bo *ttm_to_amdgpu_bo(struct ttm_buffer_object *tbo)
 109 {
 110         return container_of(tbo, struct amdgpu_bo, tbo);
 111 }
 112
 113 /**
 114  * amdgpu_mem_type_to_domain - return domain corresponding to mem_type
 115  * @mem_type:   ttm memory type
 116  *
 117  * Returns corresponding domain of the ttm mem_type
 118  */
 119 static inline unsigned amdgpu_mem_type_to_domain(u32 mem_type)
 120 {
 121         switch (mem_type) {
 122         case TTM_PL_VRAM:
 123                 return AMDGPU_GEM_DOMAIN_VRAM;
 124         case TTM_PL_TT:
 125                 return AMDGPU_GEM_DOMAIN_GTT;
 126         case TTM_PL_SYSTEM:
 127                 return AMDGPU_GEM_DOMAIN_CPU;
 128         case AMDGPU_PL_GDS:
 129                 return AMDGPU_GEM_DOMAIN_GDS;
 130         case AMDGPU_PL_GWS:
 131                 return AMDGPU_GEM_DOMAIN_GWS;
 132         case AMDGPU_PL_OA:
 133                 return AMDGPU_GEM_DOMAIN_OA;
 134         default:
 135                 break;
 136         }
 137         return 0;
 138 }
 139
 140 /**
 141  * amdgpu_bo_reserve - reserve bo
 142  * @bo:         bo structure
 143  * @no_intr:    don't return -ERESTARTSYS on pending signal
 144  *
 145  * Returns:
 146  * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
 147  * a signal. Release all buffer reservations and return to user-space.
 148  */
 149 static inline int amdgpu_bo_reserve(struct amdgpu_bo *bo, bool no_intr)
 150 {
 151         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
 152         int r;
 153
 154         r = ttm_bo_reserve(&bo->tbo, !no_intr, false, NULL);
 155         if (unlikely(r != 0)) {
 156                 if (r != -ERESTARTSYS)
 157                         dev_err(adev->dev, "%p reserve failed\n", bo);
 158                 return r;
 159         }
 160         return 0;
 161 }
 162
 163 static inline void amdgpu_bo_unreserve(struct amdgpu_bo *bo)
 164 {
 165         ttm_bo_unreserve(&bo->tbo);
 166 }
 167
 168 static inline unsigned long amdgpu_bo_size(struct amdgpu_bo *bo)
 169 {
 170         return bo->tbo.num_pages << PAGE_SHIFT;
 171 }
 172
 173 static inline unsigned amdgpu_bo_ngpu_pages(struct amdgpu_bo *bo)
 174 {
 175         return (bo->tbo.num_pages << PAGE_SHIFT) / AMDGPU_GPU_PAGE_SIZE;
 176 }
 177
 178 static inline unsigned amdgpu_bo_gpu_page_alignment(struct amdgpu_bo *bo)
 179 {
 180         return (bo->tbo.mem.page_alignment << PAGE_SHIFT) / AMDGPU_GPU_PAGE_SIZE;
 181 }
 182
 183 /**
 184  * amdgpu_bo_mmap_offset - return mmap offset of bo
 185  * @bo: amdgpu object for which we query the offset
 186  *
 187  * Returns mmap offset of the object.
 188  */
 189 static inline u64 amdgpu_bo_mmap_offset(struct amdgpu_bo *bo)
 190 {
 191         return drm_vma_node_offset_addr(&bo->tbo.vma_node);
 192 }
 193
 194 /**
 195  * amdgpu_bo_gpu_accessible - return whether the bo is currently in memory that
 196  * is accessible to the GPU.
 197  */
 198 static inline bool amdgpu_bo_gpu_accessible(struct amdgpu_bo *bo)
 199 {
 200         switch (bo->tbo.mem.mem_type) {
 201         case TTM_PL_TT: return amdgpu_gtt_mgr_has_gart_addr(&bo->tbo.mem);
 202         case TTM_PL_VRAM: return true;
 203         default: return false;
 204         }
 205 }
 206
 207 /**
 208  * amdgpu_bo_in_cpu_visible_vram - check if BO is (partly) in visible VRAM
 209  */
 210 static inline bool amdgpu_bo_in_cpu_visible_vram(struct amdgpu_bo *bo)
 211 {
 212         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
 213         unsigned fpfn = adev->gmc.visible_vram_size >> PAGE_SHIFT;
 214         struct drm_mm_node *node = bo->tbo.mem.mm_node;
 215         unsigned long pages_left;
 216
 217         if (bo->tbo.mem.mem_type != TTM_PL_VRAM)
 218                 return false;
 219
 220         for (pages_left = bo->tbo.mem.num_pages; pages_left;
 221              pages_left -= node->size, node++)
 222                 if (node->start < fpfn)
 223                         return true;
 224
 225         return false;
 226 }
 227
 228 /**
 229  * amdgpu_bo_explicit_sync - return whether the bo is explicitly synced
 230  */
 231 static inline bool amdgpu_bo_explicit_sync(struct amdgpu_bo *bo)
 232 {
 233         return bo->flags & AMDGPU_GEM_CREATE_EXPLICIT_SYNC;
 234 }
 235
 236 int amdgpu_bo_create(struct amdgpu_device *adev,
 237                      struct amdgpu_bo_param *bp,
 238                      struct amdgpu_bo **bo_ptr);
 239 int amdgpu_bo_create_reserved(struct amdgpu_device *adev,
 240                               unsigned long size, int align,
 241                               u32 domain, struct amdgpu_bo **bo_ptr,
 242                               u64 *gpu_addr, void **cpu_addr);
 243 int amdgpu_bo_create_kernel(struct amdgpu_device *adev,
 244                             unsigned long size, int align,
 245                             u32 domain, struct amdgpu_bo **bo_ptr,
 246                             u64 *gpu_addr, void **cpu_addr);
 247 void amdgpu_bo_free_kernel(struct amdgpu_bo **bo, u64 *gpu_addr,
 248                            void **cpu_addr);
 249 int amdgpu_bo_kmap(struct amdgpu_bo *bo, void **ptr);
 250 void *amdgpu_bo_kptr(struct amdgpu_bo *bo);
 251 void amdgpu_bo_kunmap(struct amdgpu_bo *bo);
 252 struct amdgpu_bo *amdgpu_bo_ref(struct amdgpu_bo *bo);
 253 void amdgpu_bo_unref(struct amdgpu_bo **bo);
 254 int amdgpu_bo_pin(struct amdgpu_bo *bo, u32 domain, u64 *gpu_addr);
 255 int amdgpu_bo_pin_restricted(struct amdgpu_bo *bo, u32 domain,
 256                              u64 min_offset, u64 max_offset,
 257                              u64 *gpu_addr);
 258 int amdgpu_bo_unpin(struct amdgpu_bo *bo);
 259 int amdgpu_bo_evict_vram(struct amdgpu_device *adev);
 260 int amdgpu_bo_init(struct amdgpu_device *adev);
 261 int amdgpu_bo_late_init(struct amdgpu_device *adev);
 262 void amdgpu_bo_fini(struct amdgpu_device *adev);
 263 int amdgpu_bo_fbdev_mmap(struct amdgpu_bo *bo,
 264                                 struct vm_area_struct *vma);
 265 int amdgpu_bo_set_tiling_flags(struct amdgpu_bo *bo, u64 tiling_flags);
 266 void amdgpu_bo_get_tiling_flags(struct amdgpu_bo *bo, u64 *tiling_flags);
 267 int amdgpu_bo_set_metadata (struct amdgpu_bo *bo, void *metadata,
 268                             uint32_t metadata_size, uint64_t flags);
 269 int amdgpu_bo_get_metadata(struct amdgpu_bo *bo, void *buffer,
 270                            size_t buffer_size, uint32_t *metadata_size,
 271                            uint64_t *flags);
 272 void amdgpu_bo_move_notify(struct ttm_buffer_object *bo,
 273                            bool evict,
 274                            struct ttm_mem_reg *new_mem);
 275 int amdgpu_bo_fault_reserve_notify(struct ttm_buffer_object *bo);
 276 void amdgpu_bo_fence(struct amdgpu_bo *bo, struct dma_fence *fence,
 277                      bool shared);
 278 u64 amdgpu_bo_gpu_offset(struct amdgpu_bo *bo);
 279 int amdgpu_bo_backup_to_shadow(struct amdgpu_device *adev,
 280                                struct amdgpu_ring *ring,
 281                                struct amdgpu_bo *bo,
 282                                struct reservation_object *resv,
 283                                struct dma_fence **fence, bool direct);
 284 int amdgpu_bo_validate(struct amdgpu_bo *bo);
 285 int amdgpu_bo_restore_from_shadow(struct amdgpu_device *adev,
 286                                   struct amdgpu_ring *ring,
 287                                   struct amdgpu_bo *bo,
 288                                   struct reservation_object *resv,
 289                                   struct dma_fence **fence,
 290                                   bool direct);
 291
 292
 293 /*
 294  * sub allocation
 295  */
 296
 297 static inline uint64_t amdgpu_sa_bo_gpu_addr(struct amdgpu_sa_bo *sa_bo)
 298 {
 299         return sa_bo->manager->gpu_addr + sa_bo->soffset;
 300 }
 301
 302 static inline void * amdgpu_sa_bo_cpu_addr(struct amdgpu_sa_bo *sa_bo)
 303 {
 304         return sa_bo->manager->cpu_ptr + sa_bo->soffset;
 305 }
 306
 307 int amdgpu_sa_bo_manager_init(struct amdgpu_device *adev,
 308                                      struct amdgpu_sa_manager *sa_manager,
 309                                      unsigned size, u32 align, u32 domain);
 310 void amdgpu_sa_bo_manager_fini(struct amdgpu_device *adev,
 311                                       struct amdgpu_sa_manager *sa_manager);
 312 int amdgpu_sa_bo_manager_start(struct amdgpu_device *adev,
 313                                       struct amdgpu_sa_manager *sa_manager);
 314 int amdgpu_sa_bo_new(struct amdgpu_sa_manager *sa_manager,
 315                      struct amdgpu_sa_bo **sa_bo,
 316                      unsigned size, unsigned align);
 317 void amdgpu_sa_bo_free(struct amdgpu_device *adev,
 318                               struct amdgpu_sa_bo **sa_bo,
 319                               struct dma_fence *fence);
 320 #if defined(CONFIG_DEBUG_FS)
 321 void amdgpu_sa_bo_dump_debug_info(struct amdgpu_sa_manager *sa_manager,
 322                                          struct seq_file *m);
 323 #endif
 324
 325
 326 #endif