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 /* bo virtual addresses in a vm */
  37 struct amdgpu_bo_va_mapping {
  38         struct list_head                list;
  39         struct rb_node                  rb;
  40         uint64_t                        start;
  41         uint64_t                        last;
  42         uint64_t                        __subtree_last;
  43         uint64_t                        offset;
  44         uint64_t                        flags;
  45 };
  46
  47 /* User space allocated BO in a VM */
  48 struct amdgpu_bo_va {
  49         struct amdgpu_vm_bo_base        base;
  50
  51         /* protected by bo being reserved */
  52         struct dma_fence                *last_pt_update;
  53         unsigned                        ref_count;
  54
  55         /* mappings for this bo_va */
  56         struct list_head                invalids;
  57         struct list_head                valids;
  58
  59         /* If the mappings are cleared or filled */
  60         bool                            cleared;
  61 };
  62
  63 struct amdgpu_bo {
  64         /* Protected by tbo.reserved */
  65         u32                             preferred_domains;
  66         u32                             allowed_domains;
  67         struct ttm_place                placements[AMDGPU_GEM_DOMAIN_MAX + 1];
  68         struct ttm_placement            placement;
  69         struct ttm_buffer_object        tbo;
  70         struct ttm_bo_kmap_obj          kmap;
  71         u64                             flags;
  72         unsigned                        pin_count;
  73         u64                             tiling_flags;
  74         u64                             metadata_flags;
  75         void                            *metadata;
  76         u32                             metadata_size;
  77         unsigned                        prime_shared_count;
  78         /* list of all virtual address to which this bo is associated to */
  79         struct list_head                va;
  80         /* Constant after initialization */
  81         struct drm_gem_object           gem_base;
  82         struct amdgpu_bo                *parent;
  83         struct amdgpu_bo                *shadow;
  84
  85         struct ttm_bo_kmap_obj          dma_buf_vmap;
  86         struct amdgpu_mn                *mn;
  87
  88         union {
  89                 struct list_head        mn_list;
  90                 struct list_head        shadow_list;
  91         };
  92 };
  93
  94 /**
  95  * amdgpu_mem_type_to_domain - return domain corresponding to mem_type
  96  * @mem_type:   ttm memory type
  97  *
  98  * Returns corresponding domain of the ttm mem_type
  99  */
 100 static inline unsigned amdgpu_mem_type_to_domain(u32 mem_type)
 101 {
 102         switch (mem_type) {
 103         case TTM_PL_VRAM:
 104                 return AMDGPU_GEM_DOMAIN_VRAM;
 105         case TTM_PL_TT:
 106                 return AMDGPU_GEM_DOMAIN_GTT;
 107         case TTM_PL_SYSTEM:
 108                 return AMDGPU_GEM_DOMAIN_CPU;
 109         case AMDGPU_PL_GDS:
 110                 return AMDGPU_GEM_DOMAIN_GDS;
 111         case AMDGPU_PL_GWS:
 112                 return AMDGPU_GEM_DOMAIN_GWS;
 113         case AMDGPU_PL_OA:
 114                 return AMDGPU_GEM_DOMAIN_OA;
 115         default:
 116                 break;
 117         }
 118         return 0;
 119 }
 120
 121 /**
 122  * amdgpu_bo_reserve - reserve bo
 123  * @bo:         bo structure
 124  * @no_intr:    don't return -ERESTARTSYS on pending signal
 125  *
 126  * Returns:
 127  * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
 128  * a signal. Release all buffer reservations and return to user-space.
 129  */
 130 static inline int amdgpu_bo_reserve(struct amdgpu_bo *bo, bool no_intr)
 131 {
 132         struct amdgpu_device *adev = amdgpu_ttm_adev(bo->tbo.bdev);
 133         int r;
 134
 135         r = ttm_bo_reserve(&bo->tbo, !no_intr, false, NULL);
 136         if (unlikely(r != 0)) {
 137                 if (r != -ERESTARTSYS)
 138                         dev_err(adev->dev, "%p reserve failed\n", bo);
 139                 return r;
 140         }
 141         return 0;
 142 }
 143
 144 static inline void amdgpu_bo_unreserve(struct amdgpu_bo *bo)
 145 {
 146         ttm_bo_unreserve(&bo->tbo);
 147 }
 148
 149 static inline unsigned long amdgpu_bo_size(struct amdgpu_bo *bo)
 150 {
 151         return bo->tbo.num_pages << PAGE_SHIFT;
 152 }
 153
 154 static inline unsigned amdgpu_bo_ngpu_pages(struct amdgpu_bo *bo)
 155 {
 156         return (bo->tbo.num_pages << PAGE_SHIFT) / AMDGPU_GPU_PAGE_SIZE;
 157 }
 158
 159 static inline unsigned amdgpu_bo_gpu_page_alignment(struct amdgpu_bo *bo)
 160 {
 161         return (bo->tbo.mem.page_alignment << PAGE_SHIFT) / AMDGPU_GPU_PAGE_SIZE;
 162 }
 163
 164 /**
 165  * amdgpu_bo_mmap_offset - return mmap offset of bo
 166  * @bo: amdgpu object for which we query the offset
 167  *
 168  * Returns mmap offset of the object.
 169  */
 170 static inline u64 amdgpu_bo_mmap_offset(struct amdgpu_bo *bo)
 171 {
 172         return drm_vma_node_offset_addr(&bo->tbo.vma_node);
 173 }
 174
 175 /**
 176  * amdgpu_bo_gpu_accessible - return whether the bo is currently in memory that
 177  * is accessible to the GPU.
 178  */
 179 static inline bool amdgpu_bo_gpu_accessible(struct amdgpu_bo *bo)
 180 {
 181         switch (bo->tbo.mem.mem_type) {
 182         case TTM_PL_TT: return amdgpu_ttm_is_bound(bo->tbo.ttm);
 183         case TTM_PL_VRAM: return true;
 184         default: return false;
 185         }
 186 }
 187
 188 int amdgpu_bo_create(struct amdgpu_device *adev,
 189                             unsigned long size, int byte_align,
 190                             bool kernel, u32 domain, u64 flags,
 191                             struct sg_table *sg,
 192                             struct reservation_object *resv,
 193                             uint64_t init_value,
 194                             struct amdgpu_bo **bo_ptr);
 195 int amdgpu_bo_create_restricted(struct amdgpu_device *adev,
 196                                 unsigned long size, int byte_align,
 197                                 bool kernel, u32 domain, u64 flags,
 198                                 struct sg_table *sg,
 199                                 struct ttm_placement *placement,
 200                                 struct reservation_object *resv,
 201                                 uint64_t init_value,
 202                                 struct amdgpu_bo **bo_ptr);
 203 int amdgpu_bo_create_reserved(struct amdgpu_device *adev,
 204                               unsigned long size, int align,
 205                               u32 domain, struct amdgpu_bo **bo_ptr,
 206                               u64 *gpu_addr, void **cpu_addr);
 207 int amdgpu_bo_create_kernel(struct amdgpu_device *adev,
 208                             unsigned long size, int align,
 209                             u32 domain, struct amdgpu_bo **bo_ptr,
 210                             u64 *gpu_addr, void **cpu_addr);
 211 void amdgpu_bo_free_kernel(struct amdgpu_bo **bo, u64 *gpu_addr,
 212                            void **cpu_addr);
 213 int amdgpu_bo_kmap(struct amdgpu_bo *bo, void **ptr);
 214 void *amdgpu_bo_kptr(struct amdgpu_bo *bo);
 215 void amdgpu_bo_kunmap(struct amdgpu_bo *bo);
 216 struct amdgpu_bo *amdgpu_bo_ref(struct amdgpu_bo *bo);
 217 void amdgpu_bo_unref(struct amdgpu_bo **bo);
 218 int amdgpu_bo_pin(struct amdgpu_bo *bo, u32 domain, u64 *gpu_addr);
 219 int amdgpu_bo_pin_restricted(struct amdgpu_bo *bo, u32 domain,
 220                              u64 min_offset, u64 max_offset,
 221                              u64 *gpu_addr);
 222 int amdgpu_bo_unpin(struct amdgpu_bo *bo);
 223 int amdgpu_bo_evict_vram(struct amdgpu_device *adev);
 224 int amdgpu_bo_init(struct amdgpu_device *adev);
 225 void amdgpu_bo_fini(struct amdgpu_device *adev);
 226 int amdgpu_bo_fbdev_mmap(struct amdgpu_bo *bo,
 227                                 struct vm_area_struct *vma);
 228 int amdgpu_bo_set_tiling_flags(struct amdgpu_bo *bo, u64 tiling_flags);
 229 void amdgpu_bo_get_tiling_flags(struct amdgpu_bo *bo, u64 *tiling_flags);
 230 int amdgpu_bo_set_metadata (struct amdgpu_bo *bo, void *metadata,
 231                             uint32_t metadata_size, uint64_t flags);
 232 int amdgpu_bo_get_metadata(struct amdgpu_bo *bo, void *buffer,
 233                            size_t buffer_size, uint32_t *metadata_size,
 234                            uint64_t *flags);
 235 void amdgpu_bo_move_notify(struct ttm_buffer_object *bo,
 236                            bool evict,
 237                            struct ttm_mem_reg *new_mem);
 238 int amdgpu_bo_fault_reserve_notify(struct ttm_buffer_object *bo);
 239 void amdgpu_bo_fence(struct amdgpu_bo *bo, struct dma_fence *fence,
 240                      bool shared);
 241 u64 amdgpu_bo_gpu_offset(struct amdgpu_bo *bo);
 242 int amdgpu_bo_backup_to_shadow(struct amdgpu_device *adev,
 243                                struct amdgpu_ring *ring,
 244                                struct amdgpu_bo *bo,
 245                                struct reservation_object *resv,
 246                                struct dma_fence **fence, bool direct);
 247 int amdgpu_bo_validate(struct amdgpu_bo *bo);
 248 int amdgpu_bo_restore_from_shadow(struct amdgpu_device *adev,
 249                                   struct amdgpu_ring *ring,
 250                                   struct amdgpu_bo *bo,
 251                                   struct reservation_object *resv,
 252                                   struct dma_fence **fence,
 253                                   bool direct);
 254
 255
 256 /*
 257  * sub allocation
 258  */
 259
 260 static inline uint64_t amdgpu_sa_bo_gpu_addr(struct amdgpu_sa_bo *sa_bo)
 261 {
 262         return sa_bo->manager->gpu_addr + sa_bo->soffset;
 263 }
 264
 265 static inline void * amdgpu_sa_bo_cpu_addr(struct amdgpu_sa_bo *sa_bo)
 266 {
 267         return sa_bo->manager->cpu_ptr + sa_bo->soffset;
 268 }
 269
 270 int amdgpu_sa_bo_manager_init(struct amdgpu_device *adev,
 271                                      struct amdgpu_sa_manager *sa_manager,
 272                                      unsigned size, u32 align, u32 domain);
 273 void amdgpu_sa_bo_manager_fini(struct amdgpu_device *adev,
 274                                       struct amdgpu_sa_manager *sa_manager);
 275 int amdgpu_sa_bo_manager_start(struct amdgpu_device *adev,
 276                                       struct amdgpu_sa_manager *sa_manager);
 277 int amdgpu_sa_bo_manager_suspend(struct amdgpu_device *adev,
 278                                         struct amdgpu_sa_manager *sa_manager);
 279 int amdgpu_sa_bo_new(struct amdgpu_sa_manager *sa_manager,
 280                      struct amdgpu_sa_bo **sa_bo,
 281                      unsigned size, unsigned align);
 282 void amdgpu_sa_bo_free(struct amdgpu_device *adev,
 283                               struct amdgpu_sa_bo **sa_bo,
 284                               struct dma_fence *fence);
 285 #if defined(CONFIG_DEBUG_FS)
 286 void amdgpu_sa_bo_dump_debug_info(struct amdgpu_sa_manager *sa_manager,
 287                                          struct seq_file *m);
 288 #endif
 289
 290
 291 #endif