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
40 #include "util/list.h"
42 #if defined(__cplusplus)
46 struct gen_device_info
;
50 * Size in bytes of the buffer object.
52 * The size may be larger than the size originally requested for the
53 * allocation, such as being aligned to page size.
58 * Alignment requirement for object
60 * Used for GTT mapping & pinning the object.
65 * Virtual address for accessing the buffer data. Only valid while
74 /** Buffer manager context associated with this buffer object */
75 struct brw_bufmgr
*bufmgr
;
77 /** The GEM handle for this buffer object. */
81 * Last seen card virtual address (offset from the beginning of the
82 * aperture) for the object. This should be used to fill relocation
83 * entries when calling brw_bo_emit_reloc()
88 * Boolean of whether the GPU is definitely not accessing the buffer.
90 * This is only valid when reusable, since non-reusable
91 * buffers are those that have been shared with other
92 * processes, so we don't know their state.
100 * Kenel-assigned global name for this object
102 * List contains both flink named and prime fd'd objects
104 unsigned int global_name
;
107 * Current tiling mode
109 uint32_t tiling_mode
;
110 uint32_t swizzle_mode
;
111 unsigned long stride
;
115 /** Mapped address for the buffer, saved across map/unmap cycles */
117 /** GTT virtual address for the buffer, saved across map/unmap cycles */
119 /** WC CPU address for the buffer, saved across map/unmap cycles */
122 struct list_head vma_list
;
125 struct list_head head
;
128 * Boolean of whether this buffer can be re-used
133 #define BO_ALLOC_FOR_RENDER (1<<0)
136 * Allocate a buffer object.
138 * Buffer objects are not necessarily initially mapped into CPU virtual
139 * address space or graphics device aperture. They must be mapped
140 * using bo_map() or brw_bo_map_gtt() to be used by the CPU.
142 struct brw_bo
*brw_bo_alloc(struct brw_bufmgr
*bufmgr
, const char *name
,
143 unsigned long size
, unsigned int alignment
);
145 * Allocate a buffer object, hinting that it will be used as a
148 * This is otherwise the same as bo_alloc.
150 struct brw_bo
*brw_bo_alloc_for_render(struct brw_bufmgr
*bufmgr
,
153 unsigned int alignment
);
156 * Allocate a tiled buffer object.
158 * Alignment for tiled objects is set automatically; the 'flags'
159 * argument provides a hint about how the object will be used initially.
161 * Valid tiling formats are:
166 * Note the tiling format may be rejected; callers should check the
167 * 'tiling_mode' field on return, as well as the pitch value, which
168 * may have been rounded up to accommodate for tiling restrictions.
170 struct brw_bo
*brw_bo_alloc_tiled(struct brw_bufmgr
*bufmgr
,
172 int x
, int y
, int cpp
,
173 uint32_t *tiling_mode
,
174 unsigned long *pitch
,
175 unsigned long flags
);
177 /** Takes a reference on a buffer object */
178 void brw_bo_reference(struct brw_bo
*bo
);
181 * Releases a reference on a buffer object, freeing the data if
182 * no references remain.
184 void brw_bo_unreference(struct brw_bo
*bo
);
187 * Maps the buffer into userspace.
189 * This function will block waiting for any existing execution on the
190 * buffer to complete, first. The resulting mapping is available at
193 int brw_bo_map(struct brw_bo
*bo
, int write_enable
);
196 * Reduces the refcount on the userspace mapping of the buffer
199 int brw_bo_unmap(struct brw_bo
*bo
);
201 /** Write data into an object. */
202 int brw_bo_subdata(struct brw_bo
*bo
, unsigned long offset
,
203 unsigned long size
, const void *data
);
204 /** Read data from an object. */
205 int brw_bo_get_subdata(struct brw_bo
*bo
, unsigned long offset
,
206 unsigned long size
, void *data
);
208 * Waits for rendering to an object by the GPU to have completed.
210 * This is not required for any access to the BO by bo_map,
211 * bo_subdata, etc. It is merely a way for the driver to implement
214 void brw_bo_wait_rendering(struct brw_bo
*bo
);
217 * Tears down the buffer manager instance.
219 void brw_bufmgr_destroy(struct brw_bufmgr
*bufmgr
);
222 * Ask that the buffer be placed in tiling mode
224 * \param buf Buffer to set tiling mode for
225 * \param tiling_mode desired, and returned tiling mode
227 int brw_bo_set_tiling(struct brw_bo
*bo
, uint32_t * tiling_mode
,
230 * Get the current tiling (and resulting swizzling) mode for the bo.
232 * \param buf Buffer to get tiling mode for
233 * \param tiling_mode returned tiling mode
234 * \param swizzle_mode returned swizzling mode
236 int brw_bo_get_tiling(struct brw_bo
*bo
, uint32_t * tiling_mode
,
237 uint32_t * swizzle_mode
);
240 * Create a visible name for a buffer which can be used by other apps
242 * \param buf Buffer to create a name for
243 * \param name Returned name
245 int brw_bo_flink(struct brw_bo
*bo
, uint32_t * name
);
248 * Returns 1 if mapping the buffer for write could cause the process
249 * to block, due to the object being active in the GPU.
251 int brw_bo_busy(struct brw_bo
*bo
);
254 * Specify the volatility of the buffer.
255 * \param bo Buffer to create a name for
256 * \param madv The purgeable status
258 * Use I915_MADV_DONTNEED to mark the buffer as purgeable, and it will be
259 * reclaimed under memory pressure. If you subsequently require the buffer,
260 * then you must pass I915_MADV_WILLNEED to mark the buffer as required.
262 * Returns 1 if the buffer was retained, or 0 if it was discarded whilst
263 * marked as I915_MADV_DONTNEED.
265 int brw_bo_madvise(struct brw_bo
*bo
, int madv
);
268 * Disable buffer reuse for buffers which will be shared in some way,
269 * as with scanout buffers. When the buffer reference count goes to
270 * zero, it will be freed and not placed in the reuse list.
272 * \param bo Buffer to disable reuse for
274 int brw_bo_disable_reuse(struct brw_bo
*bo
);
277 * Query whether a buffer is reusable.
279 * \param bo Buffer to query
281 int brw_bo_is_reusable(struct brw_bo
*bo
);
283 /* drm_bacon_bufmgr_gem.c */
284 struct brw_bufmgr
*brw_bufmgr_init(struct gen_device_info
*devinfo
,
285 int fd
, int batch_size
);
286 struct brw_bo
*brw_bo_gem_create_from_name(struct brw_bufmgr
*bufmgr
,
288 unsigned int handle
);
289 void brw_bufmgr_enable_reuse(struct brw_bufmgr
*bufmgr
);
290 void brw_bufmgr_gem_set_vma_cache_size(struct brw_bufmgr
*bufmgr
,
292 int brw_bo_map_unsynchronized(struct brw_bo
*bo
);
293 int brw_bo_map_gtt(struct brw_bo
*bo
);
295 void *brw_bo_map__cpu(struct brw_bo
*bo
);
296 void *brw_bo_map__gtt(struct brw_bo
*bo
);
297 void *brw_bo_map__wc(struct brw_bo
*bo
);
299 void brw_bo_start_gtt_access(struct brw_bo
*bo
, int write_enable
);
301 int brw_bo_wait(struct brw_bo
*bo
, int64_t timeout_ns
);
303 uint32_t brw_create_hw_context(struct brw_bufmgr
*bufmgr
);
304 void brw_destroy_hw_context(struct brw_bufmgr
*bufmgr
, uint32_t ctx_id
);
306 int brw_bo_gem_export_to_prime(struct brw_bo
*bo
, int *prime_fd
);
307 struct brw_bo
*brw_bo_gem_create_from_prime(struct brw_bufmgr
*bufmgr
,
308 int prime_fd
, int size
);
310 int brw_reg_read(struct brw_bufmgr
*bufmgr
, uint32_t offset
, uint64_t *result
);
314 #if defined(__cplusplus)
318 #endif /* INTEL_BUFMGR_H */