Merge remote branch 'origin/master' into libdrm
[glsdk/libdrm.git] / intel / intel_bufmgr_priv.h
1 /*
2  * Copyright © 2008 Intel Corporation
3  *
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:
10  *
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
13  * Software.
14  *
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
21  * IN THE SOFTWARE.
22  *
23  * Authors:
24  *    Eric Anholt <eric@anholt.net>
25  *
26  */
28 /**
29  * @file intel_bufmgr_priv.h
30  *
31  * Private definitions of Intel-specific bufmgr functions and structures.
32  */
34 #ifndef INTEL_BUFMGR_PRIV_H
35 #define INTEL_BUFMGR_PRIV_H
37 /**
38  * Context for a buffer manager instance.
39  *
40  * Contains public methods followed by private storage for the buffer manager.
41  */
42 struct _drm_intel_bufmgr {
43         /**
44          * Allocate a buffer object.
45          *
46          * Buffer objects are not necessarily initially mapped into CPU virtual
47          * address space or graphics device aperture.  They must be mapped
48          * using bo_map() or drm_intel_gem_bo_map_gtt() to be used by the CPU.
49          */
50         drm_intel_bo *(*bo_alloc) (drm_intel_bufmgr *bufmgr, const char *name,
51                                    unsigned long size, unsigned int alignment);
53         /**
54          * Allocate a buffer object, hinting that it will be used as a
55          * render target.
56          *
57          * This is otherwise the same as bo_alloc.
58          */
59         drm_intel_bo *(*bo_alloc_for_render) (drm_intel_bufmgr *bufmgr,
60                                               const char *name,
61                                               unsigned long size,
62                                               unsigned int alignment);
64         /**
65          * Allocate a tiled buffer object.
66          *
67          * Alignment for tiled objects is set automatically; the 'flags'
68          * argument provides a hint about how the object will be used initially.
69          *
70          * Valid tiling formats are:
71          *  I915_TILING_NONE
72          *  I915_TILING_X
73          *  I915_TILING_Y
74          *
75          * Note the tiling format may be rejected; callers should check the
76          * 'tiling_mode' field on return, as well as the pitch value, which
77          * may have been rounded up to accommodate for tiling restrictions.
78          */
79         drm_intel_bo *(*bo_alloc_tiled) (drm_intel_bufmgr *bufmgr,
80                                          const char *name,
81                                          int x, int y, int cpp,
82                                          uint32_t *tiling_mode,
83                                          unsigned long *pitch,
84                                          unsigned long flags);
86         /** Takes a reference on a buffer object */
87         void (*bo_reference) (drm_intel_bo *bo);
89         /**
90          * Releases a reference on a buffer object, freeing the data if
91          * no references remain.
92          */
93         void (*bo_unreference) (drm_intel_bo *bo);
95         /**
96          * Maps the buffer into userspace.
97          *
98          * This function will block waiting for any existing execution on the
99          * buffer to complete, first.  The resulting mapping is available at
100          * buf->virtual.
101          */
102         int (*bo_map) (drm_intel_bo *bo, int write_enable);
104         /**
105          * Reduces the refcount on the userspace mapping of the buffer
106          * object.
107          */
108         int (*bo_unmap) (drm_intel_bo *bo);
110         /**
111          * Write data into an object.
112          *
113          * This is an optional function, if missing,
114          * drm_intel_bo will map/memcpy/unmap.
115          */
116         int (*bo_subdata) (drm_intel_bo *bo, unsigned long offset,
117                            unsigned long size, const void *data);
119         /**
120          * Read data from an object
121          *
122          * This is an optional function, if missing,
123          * drm_intel_bo will map/memcpy/unmap.
124          */
125         int (*bo_get_subdata) (drm_intel_bo *bo, unsigned long offset,
126                                unsigned long size, void *data);
128         /**
129          * Waits for rendering to an object by the GPU to have completed.
130          *
131          * This is not required for any access to the BO by bo_map,
132          * bo_subdata, etc.  It is merely a way for the driver to implement
133          * glFinish.
134          */
135         void (*bo_wait_rendering) (drm_intel_bo *bo);
137         /**
138          * Tears down the buffer manager instance.
139          */
140         void (*destroy) (drm_intel_bufmgr *bufmgr);
142         /**
143          * Add relocation entry in reloc_buf, which will be updated with the
144          * target buffer's real offset on on command submission.
145          *
146          * Relocations remain in place for the lifetime of the buffer object.
147          *
148          * \param bo Buffer to write the relocation into.
149          * \param offset Byte offset within reloc_bo of the pointer to
150          *                      target_bo.
151          * \param target_bo Buffer whose offset should be written into the
152          *                  relocation entry.
153          * \param target_offset Constant value to be added to target_bo's
154          *                      offset in relocation entry.
155          * \param read_domains GEM read domains which the buffer will be
156          *                      read into by the command that this relocation
157          *                      is part of.
158          * \param write_domains GEM read domains which the buffer will be
159          *                      dirtied in by the command that this
160          *                      relocation is part of.
161          */
162         int (*bo_emit_reloc) (drm_intel_bo *bo, uint32_t offset,
163                               drm_intel_bo *target_bo, uint32_t target_offset,
164                               uint32_t read_domains, uint32_t write_domain);
166         /** Executes the command buffer pointed to by bo. */
167         int (*bo_exec) (drm_intel_bo *bo, int used,
168                         drm_clip_rect_t *cliprects, int num_cliprects,
169                         int DR4);
171         /**
172          * Pin a buffer to the aperture and fix the offset until unpinned
173          *
174          * \param buf Buffer to pin
175          * \param alignment Required alignment for aperture, in bytes
176          */
177         int (*bo_pin) (drm_intel_bo *bo, uint32_t alignment);
179         /**
180          * Unpin a buffer from the aperture, allowing it to be removed
181          *
182          * \param buf Buffer to unpin
183          */
184         int (*bo_unpin) (drm_intel_bo *bo);
186         /**
187          * Ask that the buffer be placed in tiling mode
188          *
189          * \param buf Buffer to set tiling mode for
190          * \param tiling_mode desired, and returned tiling mode
191          */
192         int (*bo_set_tiling) (drm_intel_bo *bo, uint32_t * tiling_mode,
193                               uint32_t stride);
195         /**
196          * Get the current tiling (and resulting swizzling) mode for the bo.
197          *
198          * \param buf Buffer to get tiling mode for
199          * \param tiling_mode returned tiling mode
200          * \param swizzle_mode returned swizzling mode
201          */
202         int (*bo_get_tiling) (drm_intel_bo *bo, uint32_t * tiling_mode,
203                               uint32_t * swizzle_mode);
205         /**
206          * Create a visible name for a buffer which can be used by other apps
207          *
208          * \param buf Buffer to create a name for
209          * \param name Returned name
210          */
211         int (*bo_flink) (drm_intel_bo *bo, uint32_t * name);
213         /**
214          * Returns 1 if mapping the buffer for write could cause the process
215          * to block, due to the object being active in the GPU.
216          */
217         int (*bo_busy) (drm_intel_bo *bo);
219         /**
220          * Specify the volatility of the buffer.
221          * \param bo Buffer to create a name for
222          * \param madv The purgeable status
223          *
224          * Use I915_MADV_DONTNEED to mark the buffer as purgeable, and it will be
225          * reclaimed under memory pressure. If you subsequently require the buffer,
226          * then you must pass I915_MADV_WILLNEED to mark the buffer as required.
227          *
228          * Returns 1 if the buffer was retained, or 0 if it was discarded whilst
229          * marked as I915_MADV_DONTNEED.
230          */
231         int (*bo_madvise) (drm_intel_bo *bo, int madv);
233         int (*check_aperture_space) (drm_intel_bo ** bo_array, int count);
235         /**
236          * Disable buffer reuse for buffers which will be shared in some way,
237          * as with scanout buffers. When the buffer reference count goes to
238          * zero, it will be freed and not placed in the reuse list.
239          *
240          * \param bo Buffer to disable reuse for
241          */
242         int (*bo_disable_reuse) (drm_intel_bo *bo);
244         /**
245          *
246          * Return the pipe associated with a crtc_id so that vblank
247          * synchronization can use the correct data in the request.
248          * This is only supported for KMS and gem at this point, when
249          * unsupported, this function returns -1 and leaves the decision
250          * of what to do in that case to the caller
251          *
252          * \param bufmgr the associated buffer manager
253          * \param crtc_id the crtc identifier
254          */
255         int (*get_pipe_from_crtc_id) (drm_intel_bufmgr *bufmgr, int crtc_id);
257         /** Returns true if target_bo is in the relocation tree rooted at bo. */
258         int (*bo_references) (drm_intel_bo *bo, drm_intel_bo *target_bo);
260         /**< Enables verbose debugging printouts */
261         int debug;
262 };
264 #define ALIGN(value, alignment) ((value + alignment - 1) & ~(alignment - 1))
265 #define ROUND_UP_TO(x, y)       (((x) + (y) - 1) / (y) * (y))
266 #define ROUND_UP_TO_MB(x)       ROUND_UP_TO((x), 1024*1024)
268 #endif /* INTEL_BUFMGR_PRIV_H */