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
;
51 * Size in bytes of the buffer object.
53 * The size may be larger than the size originally requested for the
54 * allocation, such as being aligned to page size.
59 * Alignment requirement for object
61 * Used for GTT mapping & pinning the object.
65 /** Buffer manager context associated with this buffer object */
66 struct brw_bufmgr
*bufmgr
;
68 /** The GEM handle for this buffer object. */
72 * Last seen card virtual address (offset from the beginning of the
73 * aperture) for the object. This should be used to fill relocation
74 * entries when calling brw_bo_emit_reloc()
79 * Boolean of whether the GPU is definitely not accessing the buffer.
81 * This is only valid when reusable, since non-reusable
82 * buffers are those that have been shared with other
83 * processes, so we don't know their state.
90 #ifndef EXEC_OBJECT_CAPTURE
91 #define EXEC_OBJECT_CAPTURE (1<<7)
96 * Kenel-assigned global name for this object
98 * List contains both flink named and prime fd'd objects
100 unsigned int global_name
;
103 * Current tiling mode
105 uint32_t tiling_mode
;
106 uint32_t swizzle_mode
;
111 /** Mapped address for the buffer, saved across map/unmap cycles */
113 /** GTT virtual address for the buffer, saved across map/unmap cycles */
115 /** WC CPU address for the buffer, saved across map/unmap cycles */
120 struct list_head head
;
123 * Boolean of whether this buffer can be re-used
128 * Boolean of whether this buffer is cache coherent
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 uint64_t size
, uint64_t alignment
);
146 * Allocate a tiled buffer object.
148 * Alignment for tiled objects is set automatically; the 'flags'
149 * argument provides a hint about how the object will be used initially.
151 * Valid tiling formats are:
156 * Note the tiling format may be rejected; callers should check the
157 * 'tiling_mode' field on return, as well as the pitch value, which
158 * may have been rounded up to accommodate for tiling restrictions.
160 struct brw_bo
*brw_bo_alloc_tiled(struct brw_bufmgr
*bufmgr
,
162 int x
, int y
, int cpp
,
163 uint32_t tiling_mode
,
167 /** Takes a reference on a buffer object */
168 void brw_bo_reference(struct brw_bo
*bo
);
171 * Releases a reference on a buffer object, freeing the data if
172 * no references remain.
174 void brw_bo_unreference(struct brw_bo
*bo
);
177 * Maps the buffer into userspace.
179 * This function will block waiting for any existing execution on the
180 * buffer to complete, first. The resulting mapping is returned.
182 MUST_CHECK
void *brw_bo_map(struct brw_context
*brw
, struct brw_bo
*bo
, int write_enable
);
185 * Reduces the refcount on the userspace mapping of the buffer
188 int brw_bo_unmap(struct brw_bo
*bo
);
190 /** Write data into an object. */
191 int brw_bo_subdata(struct brw_bo
*bo
, uint64_t offset
,
192 uint64_t size
, const void *data
);
193 /** Read data from an object. */
194 int brw_bo_get_subdata(struct brw_bo
*bo
, uint64_t offset
,
195 uint64_t size
, void *data
);
197 * Waits for rendering to an object by the GPU to have completed.
199 * This is not required for any access to the BO by bo_map,
200 * bo_subdata, etc. It is merely a way for the driver to implement
203 void brw_bo_wait_rendering(struct brw_context
*brw
, struct brw_bo
*bo
);
206 * Tears down the buffer manager instance.
208 void brw_bufmgr_destroy(struct brw_bufmgr
*bufmgr
);
211 * Get the current tiling (and resulting swizzling) mode for the bo.
213 * \param buf Buffer to get tiling mode for
214 * \param tiling_mode returned tiling mode
215 * \param swizzle_mode returned swizzling mode
217 int brw_bo_get_tiling(struct brw_bo
*bo
, uint32_t *tiling_mode
,
218 uint32_t *swizzle_mode
);
221 * Create a visible name for a buffer which can be used by other apps
223 * \param buf Buffer to create a name for
224 * \param name Returned name
226 int brw_bo_flink(struct brw_bo
*bo
, uint32_t *name
);
229 * Returns 1 if mapping the buffer for write could cause the process
230 * to block, due to the object being active in the GPU.
232 int brw_bo_busy(struct brw_bo
*bo
);
235 * Specify the volatility of the buffer.
236 * \param bo Buffer to create a name for
237 * \param madv The purgeable status
239 * Use I915_MADV_DONTNEED to mark the buffer as purgeable, and it will be
240 * reclaimed under memory pressure. If you subsequently require the buffer,
241 * then you must pass I915_MADV_WILLNEED to mark the buffer as required.
243 * Returns 1 if the buffer was retained, or 0 if it was discarded whilst
244 * marked as I915_MADV_DONTNEED.
246 int brw_bo_madvise(struct brw_bo
*bo
, int madv
);
248 /* drm_bacon_bufmgr_gem.c */
249 struct brw_bufmgr
*brw_bufmgr_init(struct gen_device_info
*devinfo
,
250 int fd
, int batch_size
);
251 struct brw_bo
*brw_bo_gem_create_from_name(struct brw_bufmgr
*bufmgr
,
253 unsigned int handle
);
254 void brw_bufmgr_enable_reuse(struct brw_bufmgr
*bufmgr
);
255 MUST_CHECK
void *brw_bo_map_unsynchronized(struct brw_context
*brw
, struct brw_bo
*bo
);
256 MUST_CHECK
void *brw_bo_map_gtt(struct brw_context
*brw
, struct brw_bo
*bo
);
258 int brw_bo_wait(struct brw_bo
*bo
, int64_t timeout_ns
);
260 uint32_t brw_create_hw_context(struct brw_bufmgr
*bufmgr
);
261 void brw_destroy_hw_context(struct brw_bufmgr
*bufmgr
, uint32_t ctx_id
);
263 int brw_bo_gem_export_to_prime(struct brw_bo
*bo
, int *prime_fd
);
264 struct brw_bo
*brw_bo_gem_create_from_prime(struct brw_bufmgr
*bufmgr
,
265 int prime_fd
, int size
);
267 int brw_reg_read(struct brw_bufmgr
*bufmgr
, uint32_t offset
,
272 #if defined(__cplusplus)
275 #endif /* INTEL_BUFMGR_H */