2 * Copyright © 2008-2012 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 * Eric Anholt <eric@anholt.net>
31 * Public definitions of Intel-specific bufmgr functions.
34 #ifndef INTEL_BUFMGR_H
35 #define INTEL_BUFMGR_H
41 #if defined(__cplusplus)
45 struct gen_device_info
;
47 typedef struct _drm_bacon_bufmgr drm_bacon_bufmgr
;
48 typedef struct _drm_bacon_context drm_bacon_context
;
49 typedef struct _drm_bacon_bo drm_bacon_bo
;
51 struct _drm_bacon_bo
{
53 * Size in bytes of the buffer object.
55 * The size may be larger than the size originally requested for the
56 * allocation, such as being aligned to page size.
61 * Alignment requirement for object
63 * Used for GTT mapping & pinning the object.
68 * Virtual address for accessing the buffer data. Only valid while
77 /** Buffer manager context associated with this buffer object */
78 drm_bacon_bufmgr
*bufmgr
;
81 * MM-specific handle for accessing object
86 * Last seen card virtual address (offset from the beginning of the
87 * aperture) for the object. This should be used to fill relocation
88 * entries when calling drm_bacon_bo_emit_reloc()
93 #define BO_ALLOC_FOR_RENDER (1<<0)
96 * Allocate a buffer object.
98 * Buffer objects are not necessarily initially mapped into CPU virtual
99 * address space or graphics device aperture. They must be mapped
100 * using bo_map() or drm_bacon_gem_bo_map_gtt() to be used by the CPU.
102 drm_bacon_bo
*drm_bacon_bo_alloc(drm_bacon_bufmgr
*bufmgr
, const char *name
,
103 unsigned long size
, unsigned int alignment
);
105 * Allocate a buffer object, hinting that it will be used as a
108 * This is otherwise the same as bo_alloc.
110 drm_bacon_bo
*drm_bacon_bo_alloc_for_render(drm_bacon_bufmgr
*bufmgr
,
113 unsigned int alignment
);
116 * Allocate a tiled buffer object.
118 * Alignment for tiled objects is set automatically; the 'flags'
119 * argument provides a hint about how the object will be used initially.
121 * Valid tiling formats are:
126 * Note the tiling format may be rejected; callers should check the
127 * 'tiling_mode' field on return, as well as the pitch value, which
128 * may have been rounded up to accommodate for tiling restrictions.
130 drm_bacon_bo
*drm_bacon_bo_alloc_tiled(drm_bacon_bufmgr
*bufmgr
,
132 int x
, int y
, int cpp
,
133 uint32_t *tiling_mode
,
134 unsigned long *pitch
,
135 unsigned long flags
);
137 /** Takes a reference on a buffer object */
138 void drm_bacon_bo_reference(drm_bacon_bo
*bo
);
141 * Releases a reference on a buffer object, freeing the data if
142 * no references remain.
144 void drm_bacon_bo_unreference(drm_bacon_bo
*bo
);
147 * Maps the buffer into userspace.
149 * This function will block waiting for any existing execution on the
150 * buffer to complete, first. The resulting mapping is available at
153 int drm_bacon_bo_map(drm_bacon_bo
*bo
, int write_enable
);
156 * Reduces the refcount on the userspace mapping of the buffer
159 int drm_bacon_bo_unmap(drm_bacon_bo
*bo
);
161 /** Write data into an object. */
162 int drm_bacon_bo_subdata(drm_bacon_bo
*bo
, unsigned long offset
,
163 unsigned long size
, const void *data
);
164 /** Read data from an object. */
165 int drm_bacon_bo_get_subdata(drm_bacon_bo
*bo
, unsigned long offset
,
166 unsigned long size
, void *data
);
168 * Waits for rendering to an object by the GPU to have completed.
170 * This is not required for any access to the BO by bo_map,
171 * bo_subdata, etc. It is merely a way for the driver to implement
174 void drm_bacon_bo_wait_rendering(drm_bacon_bo
*bo
);
177 * Tears down the buffer manager instance.
179 void drm_bacon_bufmgr_destroy(drm_bacon_bufmgr
*bufmgr
);
181 /** Executes the command buffer pointed to by bo. */
182 int drm_bacon_bo_exec(drm_bacon_bo
*bo
, int used
);
184 /** Executes the command buffer pointed to by bo on the selected ring buffer */
185 int drm_bacon_bo_mrb_exec(drm_bacon_bo
*bo
, int used
, unsigned int flags
);
186 int drm_bacon_bufmgr_check_aperture_space(drm_bacon_bo
** bo_array
, int count
);
189 * Add relocation entry in reloc_buf, which will be updated with the
190 * target buffer's real offset on on command submission.
192 * Relocations remain in place for the lifetime of the buffer object.
194 * \param bo Buffer to write the relocation into.
195 * \param offset Byte offset within reloc_bo of the pointer to
197 * \param target_bo Buffer whose offset should be written into the
199 * \param target_offset Constant value to be added to target_bo's
200 * offset in relocation entry.
201 * \param read_domains GEM read domains which the buffer will be
202 * read into by the command that this relocation
204 * \param write_domains GEM read domains which the buffer will be
205 * dirtied in by the command that this
206 * relocation is part of.
208 int drm_bacon_bo_emit_reloc(drm_bacon_bo
*bo
, uint32_t offset
,
209 drm_bacon_bo
*target_bo
, uint32_t target_offset
,
210 uint32_t read_domains
, uint32_t write_domain
);
213 * Ask that the buffer be placed in tiling mode
215 * \param buf Buffer to set tiling mode for
216 * \param tiling_mode desired, and returned tiling mode
218 int drm_bacon_bo_set_tiling(drm_bacon_bo
*bo
, uint32_t * tiling_mode
,
221 * Get the current tiling (and resulting swizzling) mode for the bo.
223 * \param buf Buffer to get tiling mode for
224 * \param tiling_mode returned tiling mode
225 * \param swizzle_mode returned swizzling mode
227 int drm_bacon_bo_get_tiling(drm_bacon_bo
*bo
, uint32_t * tiling_mode
,
228 uint32_t * swizzle_mode
);
231 * Create a visible name for a buffer which can be used by other apps
233 * \param buf Buffer to create a name for
234 * \param name Returned name
236 int drm_bacon_bo_flink(drm_bacon_bo
*bo
, uint32_t * name
);
239 * Returns 1 if mapping the buffer for write could cause the process
240 * to block, due to the object being active in the GPU.
242 int drm_bacon_bo_busy(drm_bacon_bo
*bo
);
245 * Specify the volatility of the buffer.
246 * \param bo Buffer to create a name for
247 * \param madv The purgeable status
249 * Use I915_MADV_DONTNEED to mark the buffer as purgeable, and it will be
250 * reclaimed under memory pressure. If you subsequently require the buffer,
251 * then you must pass I915_MADV_WILLNEED to mark the buffer as required.
253 * Returns 1 if the buffer was retained, or 0 if it was discarded whilst
254 * marked as I915_MADV_DONTNEED.
256 int drm_bacon_bo_madvise(drm_bacon_bo
*bo
, int madv
);
259 * Disable buffer reuse for buffers which will be shared in some way,
260 * as with scanout buffers. When the buffer reference count goes to
261 * zero, it will be freed and not placed in the reuse list.
263 * \param bo Buffer to disable reuse for
265 int drm_bacon_bo_disable_reuse(drm_bacon_bo
*bo
);
268 * Query whether a buffer is reusable.
270 * \param bo Buffer to query
272 int drm_bacon_bo_is_reusable(drm_bacon_bo
*bo
);
274 /** Returns true if target_bo is in the relocation tree rooted at bo. */
275 int drm_bacon_bo_references(drm_bacon_bo
*bo
, drm_bacon_bo
*target_bo
);
277 /* drm_bacon_bufmgr_gem.c */
278 drm_bacon_bufmgr
*drm_bacon_bufmgr_gem_init(struct gen_device_info
*devinfo
,
279 int fd
, int batch_size
);
280 drm_bacon_bo
*drm_bacon_bo_gem_create_from_name(drm_bacon_bufmgr
*bufmgr
,
282 unsigned int handle
);
283 void drm_bacon_bufmgr_gem_enable_reuse(drm_bacon_bufmgr
*bufmgr
);
284 void drm_bacon_bufmgr_gem_set_vma_cache_size(drm_bacon_bufmgr
*bufmgr
,
286 int drm_bacon_gem_bo_map_unsynchronized(drm_bacon_bo
*bo
);
287 int drm_bacon_gem_bo_map_gtt(drm_bacon_bo
*bo
);
289 #define HAVE_DRM_INTEL_GEM_BO_DISABLE_IMPLICIT_SYNC 1
290 int drm_bacon_bufmgr_gem_can_disable_implicit_sync(drm_bacon_bufmgr
*bufmgr
);
291 void drm_bacon_gem_bo_disable_implicit_sync(drm_bacon_bo
*bo
);
292 void drm_bacon_gem_bo_enable_implicit_sync(drm_bacon_bo
*bo
);
294 void *drm_bacon_gem_bo_map__cpu(drm_bacon_bo
*bo
);
295 void *drm_bacon_gem_bo_map__gtt(drm_bacon_bo
*bo
);
296 void *drm_bacon_gem_bo_map__wc(drm_bacon_bo
*bo
);
298 int drm_bacon_gem_bo_get_reloc_count(drm_bacon_bo
*bo
);
299 void drm_bacon_gem_bo_clear_relocs(drm_bacon_bo
*bo
, int start
);
300 void drm_bacon_gem_bo_start_gtt_access(drm_bacon_bo
*bo
, int write_enable
);
302 int drm_bacon_gem_bo_wait(drm_bacon_bo
*bo
, int64_t timeout_ns
);
304 drm_bacon_context
*drm_bacon_gem_context_create(drm_bacon_bufmgr
*bufmgr
);
305 int drm_bacon_gem_context_get_id(drm_bacon_context
*ctx
,
307 void drm_bacon_gem_context_destroy(drm_bacon_context
*ctx
);
308 int drm_bacon_gem_bo_context_exec(drm_bacon_bo
*bo
, drm_bacon_context
*ctx
,
309 int used
, unsigned int flags
);
310 int drm_bacon_gem_bo_fence_exec(drm_bacon_bo
*bo
,
311 drm_bacon_context
*ctx
,
317 int drm_bacon_bo_gem_export_to_prime(drm_bacon_bo
*bo
, int *prime_fd
);
318 drm_bacon_bo
*drm_bacon_bo_gem_create_from_prime(drm_bacon_bufmgr
*bufmgr
,
319 int prime_fd
, int size
);
321 int drm_bacon_reg_read(drm_bacon_bufmgr
*bufmgr
,
325 int drm_bacon_get_reset_stats(drm_bacon_context
*ctx
,
326 uint32_t *reset_count
,
332 #if defined(__cplusplus)
336 #endif /* INTEL_BUFMGR_H */