drm/msm: bump kernel api version for explicit fencing
[cascardo/linux.git] / 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 /**
35  * amdgpu_mem_type_to_domain - return domain corresponding to mem_type
36  * @mem_type:   ttm memory type
37  *
38  * Returns corresponding domain of the ttm mem_type
39  */
40 static inline unsigned amdgpu_mem_type_to_domain(u32 mem_type)
41 {
42         switch (mem_type) {
43         case TTM_PL_VRAM:
44                 return AMDGPU_GEM_DOMAIN_VRAM;
45         case TTM_PL_TT:
46                 return AMDGPU_GEM_DOMAIN_GTT;
47         case TTM_PL_SYSTEM:
48                 return AMDGPU_GEM_DOMAIN_CPU;
49         case AMDGPU_PL_GDS:
50                 return AMDGPU_GEM_DOMAIN_GDS;
51         case AMDGPU_PL_GWS:
52                 return AMDGPU_GEM_DOMAIN_GWS;
53         case AMDGPU_PL_OA:
54                 return AMDGPU_GEM_DOMAIN_OA;
55         default:
56                 break;
57         }
58         return 0;
59 }
60
61 /**
62  * amdgpu_bo_reserve - reserve bo
63  * @bo:         bo structure
64  * @no_intr:    don't return -ERESTARTSYS on pending signal
65  *
66  * Returns:
67  * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
68  * a signal. Release all buffer reservations and return to user-space.
69  */
70 static inline int amdgpu_bo_reserve(struct amdgpu_bo *bo, bool no_intr)
71 {
72         int r;
73
74         r = ttm_bo_reserve(&bo->tbo, !no_intr, false, NULL);
75         if (unlikely(r != 0)) {
76                 if (r != -ERESTARTSYS)
77                         dev_err(bo->adev->dev, "%p reserve failed\n", bo);
78                 return r;
79         }
80         return 0;
81 }
82
83 static inline void amdgpu_bo_unreserve(struct amdgpu_bo *bo)
84 {
85         ttm_bo_unreserve(&bo->tbo);
86 }
87
88 static inline unsigned long amdgpu_bo_size(struct amdgpu_bo *bo)
89 {
90         return bo->tbo.num_pages << PAGE_SHIFT;
91 }
92
93 static inline unsigned amdgpu_bo_ngpu_pages(struct amdgpu_bo *bo)
94 {
95         return (bo->tbo.num_pages << PAGE_SHIFT) / AMDGPU_GPU_PAGE_SIZE;
96 }
97
98 static inline unsigned amdgpu_bo_gpu_page_alignment(struct amdgpu_bo *bo)
99 {
100         return (bo->tbo.mem.page_alignment << PAGE_SHIFT) / AMDGPU_GPU_PAGE_SIZE;
101 }
102
103 /**
104  * amdgpu_bo_mmap_offset - return mmap offset of bo
105  * @bo: amdgpu object for which we query the offset
106  *
107  * Returns mmap offset of the object.
108  */
109 static inline u64 amdgpu_bo_mmap_offset(struct amdgpu_bo *bo)
110 {
111         return drm_vma_node_offset_addr(&bo->tbo.vma_node);
112 }
113
114 int amdgpu_bo_create(struct amdgpu_device *adev,
115                             unsigned long size, int byte_align,
116                             bool kernel, u32 domain, u64 flags,
117                             struct sg_table *sg,
118                             struct reservation_object *resv,
119                             struct amdgpu_bo **bo_ptr);
120 int amdgpu_bo_create_restricted(struct amdgpu_device *adev,
121                                 unsigned long size, int byte_align,
122                                 bool kernel, u32 domain, u64 flags,
123                                 struct sg_table *sg,
124                                 struct ttm_placement *placement,
125                                 struct reservation_object *resv,
126                                 struct amdgpu_bo **bo_ptr);
127 int amdgpu_bo_create_kernel(struct amdgpu_device *adev,
128                             unsigned long size, int align,
129                             u32 domain, struct amdgpu_bo **bo_ptr,
130                             u64 *gpu_addr, void **cpu_addr);
131 int amdgpu_bo_kmap(struct amdgpu_bo *bo, void **ptr);
132 void amdgpu_bo_kunmap(struct amdgpu_bo *bo);
133 struct amdgpu_bo *amdgpu_bo_ref(struct amdgpu_bo *bo);
134 void amdgpu_bo_unref(struct amdgpu_bo **bo);
135 int amdgpu_bo_pin(struct amdgpu_bo *bo, u32 domain, u64 *gpu_addr);
136 int amdgpu_bo_pin_restricted(struct amdgpu_bo *bo, u32 domain,
137                              u64 min_offset, u64 max_offset,
138                              u64 *gpu_addr);
139 int amdgpu_bo_unpin(struct amdgpu_bo *bo);
140 int amdgpu_bo_evict_vram(struct amdgpu_device *adev);
141 int amdgpu_bo_init(struct amdgpu_device *adev);
142 void amdgpu_bo_fini(struct amdgpu_device *adev);
143 int amdgpu_bo_fbdev_mmap(struct amdgpu_bo *bo,
144                                 struct vm_area_struct *vma);
145 int amdgpu_bo_set_tiling_flags(struct amdgpu_bo *bo, u64 tiling_flags);
146 void amdgpu_bo_get_tiling_flags(struct amdgpu_bo *bo, u64 *tiling_flags);
147 int amdgpu_bo_set_metadata (struct amdgpu_bo *bo, void *metadata,
148                             uint32_t metadata_size, uint64_t flags);
149 int amdgpu_bo_get_metadata(struct amdgpu_bo *bo, void *buffer,
150                            size_t buffer_size, uint32_t *metadata_size,
151                            uint64_t *flags);
152 void amdgpu_bo_move_notify(struct ttm_buffer_object *bo,
153                                   struct ttm_mem_reg *new_mem);
154 int amdgpu_bo_fault_reserve_notify(struct ttm_buffer_object *bo);
155 void amdgpu_bo_fence(struct amdgpu_bo *bo, struct fence *fence,
156                      bool shared);
157 u64 amdgpu_bo_gpu_offset(struct amdgpu_bo *bo);
158 int amdgpu_bo_backup_to_shadow(struct amdgpu_device *adev,
159                                struct amdgpu_ring *ring,
160                                struct amdgpu_bo *bo,
161                                struct reservation_object *resv,
162                                struct fence **fence, bool direct);
163 int amdgpu_bo_restore_from_shadow(struct amdgpu_device *adev,
164                                   struct amdgpu_ring *ring,
165                                   struct amdgpu_bo *bo,
166                                   struct reservation_object *resv,
167                                   struct fence **fence,
168                                   bool direct);
169
170
171 /*
172  * sub allocation
173  */
174
175 static inline uint64_t amdgpu_sa_bo_gpu_addr(struct amdgpu_sa_bo *sa_bo)
176 {
177         return sa_bo->manager->gpu_addr + sa_bo->soffset;
178 }
179
180 static inline void * amdgpu_sa_bo_cpu_addr(struct amdgpu_sa_bo *sa_bo)
181 {
182         return sa_bo->manager->cpu_ptr + sa_bo->soffset;
183 }
184
185 int amdgpu_sa_bo_manager_init(struct amdgpu_device *adev,
186                                      struct amdgpu_sa_manager *sa_manager,
187                                      unsigned size, u32 align, u32 domain);
188 void amdgpu_sa_bo_manager_fini(struct amdgpu_device *adev,
189                                       struct amdgpu_sa_manager *sa_manager);
190 int amdgpu_sa_bo_manager_start(struct amdgpu_device *adev,
191                                       struct amdgpu_sa_manager *sa_manager);
192 int amdgpu_sa_bo_manager_suspend(struct amdgpu_device *adev,
193                                         struct amdgpu_sa_manager *sa_manager);
194 int amdgpu_sa_bo_new(struct amdgpu_sa_manager *sa_manager,
195                      struct amdgpu_sa_bo **sa_bo,
196                      unsigned size, unsigned align);
197 void amdgpu_sa_bo_free(struct amdgpu_device *adev,
198                               struct amdgpu_sa_bo **sa_bo,
199                               struct fence *fence);
200 #if defined(CONFIG_DEBUG_FS)
201 void amdgpu_sa_bo_dump_debug_info(struct amdgpu_sa_manager *sa_manager,
202                                          struct seq_file *m);
203 #endif
204
205
206 #endif