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.
66 * Virtual address for accessing the buffer data. Only valid while
75 /** Buffer manager context associated with this buffer object */
76 struct brw_bufmgr
*bufmgr
;
78 /** The GEM handle for this buffer object. */
82 * Last seen card virtual address (offset from the beginning of the
83 * aperture) for the object. This should be used to fill relocation
84 * entries when calling brw_bo_emit_reloc()
89 * Boolean of whether the GPU is definitely not accessing the buffer.
91 * This is only valid when reusable, since non-reusable
92 * buffers are those that have been shared with other
93 * processes, so we don't know their state.
101 * Kenel-assigned global name for this object
103 * List contains both flink named and prime fd'd objects
105 unsigned int global_name
;
108 * Current tiling mode
110 uint32_t tiling_mode
;
111 uint32_t swizzle_mode
;
116 /** Mapped address for the buffer, saved across map/unmap cycles */
118 /** GTT virtual address for the buffer, saved across map/unmap cycles */
120 /** WC CPU address for the buffer, saved across map/unmap cycles */
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
);
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
,
165 unsigned long flags
);
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 available at
183 int brw_bo_map(struct brw_context
*brw
, struct brw_bo
*bo
, int write_enable
);
186 * Reduces the refcount on the userspace mapping of the buffer
189 int brw_bo_unmap(struct brw_bo
*bo
);
191 /** Write data into an object. */
192 int brw_bo_subdata(struct brw_bo
*bo
, uint64_t offset
,
193 uint64_t size
, const void *data
);
194 /** Read data from an object. */
195 int brw_bo_get_subdata(struct brw_bo
*bo
, uint64_t offset
,
196 uint64_t size
, void *data
);
198 * Waits for rendering to an object by the GPU to have completed.
200 * This is not required for any access to the BO by bo_map,
201 * bo_subdata, etc. It is merely a way for the driver to implement
204 void brw_bo_wait_rendering(struct brw_context
*brw
, struct brw_bo
*bo
);
207 * Tears down the buffer manager instance.
209 void brw_bufmgr_destroy(struct brw_bufmgr
*bufmgr
);
212 * Get the current tiling (and resulting swizzling) mode for the bo.
214 * \param buf Buffer to get tiling mode for
215 * \param tiling_mode returned tiling mode
216 * \param swizzle_mode returned swizzling mode
218 int brw_bo_get_tiling(struct brw_bo
*bo
, uint32_t *tiling_mode
,
219 uint32_t *swizzle_mode
);
222 * Create a visible name for a buffer which can be used by other apps
224 * \param buf Buffer to create a name for
225 * \param name Returned name
227 int brw_bo_flink(struct brw_bo
*bo
, uint32_t *name
);
230 * Returns 1 if mapping the buffer for write could cause the process
231 * to block, due to the object being active in the GPU.
233 int brw_bo_busy(struct brw_bo
*bo
);
236 * Specify the volatility of the buffer.
237 * \param bo Buffer to create a name for
238 * \param madv The purgeable status
240 * Use I915_MADV_DONTNEED to mark the buffer as purgeable, and it will be
241 * reclaimed under memory pressure. If you subsequently require the buffer,
242 * then you must pass I915_MADV_WILLNEED to mark the buffer as required.
244 * Returns 1 if the buffer was retained, or 0 if it was discarded whilst
245 * marked as I915_MADV_DONTNEED.
247 int brw_bo_madvise(struct brw_bo
*bo
, int madv
);
249 /* drm_bacon_bufmgr_gem.c */
250 struct brw_bufmgr
*brw_bufmgr_init(struct gen_device_info
*devinfo
,
251 int fd
, int batch_size
);
252 struct brw_bo
*brw_bo_gem_create_from_name(struct brw_bufmgr
*bufmgr
,
254 unsigned int handle
);
255 void brw_bufmgr_enable_reuse(struct brw_bufmgr
*bufmgr
);
256 int brw_bo_map_unsynchronized(struct brw_context
*brw
, struct brw_bo
*bo
);
257 int brw_bo_map_gtt(struct brw_context
*brw
, struct brw_bo
*bo
);
259 void *brw_bo_map__cpu(struct brw_bo
*bo
);
260 void *brw_bo_map__gtt(struct brw_bo
*bo
);
261 void *brw_bo_map__wc(struct brw_bo
*bo
);
263 int brw_bo_wait(struct brw_bo
*bo
, int64_t timeout_ns
);
265 uint32_t brw_create_hw_context(struct brw_bufmgr
*bufmgr
);
266 void brw_destroy_hw_context(struct brw_bufmgr
*bufmgr
, uint32_t ctx_id
);
268 int brw_bo_gem_export_to_prime(struct brw_bo
*bo
, int *prime_fd
);
269 struct brw_bo
*brw_bo_gem_create_from_prime(struct brw_bufmgr
*bufmgr
,
270 int prime_fd
, int size
);
272 int brw_reg_read(struct brw_bufmgr
*bufmgr
, uint32_t offset
,
277 #if defined(__cplusplus)
280 #endif /* INTEL_BUFMGR_H */