3801ff31a7f26448323ce070ee9bc40515f2444d
[glsdk/libdrm.git] / intel / intel_bufmgr.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.h
30  *
31  * Public definitions of Intel-specific bufmgr functions.
32  */
34 #ifndef INTEL_BUFMGR_H
35 #define INTEL_BUFMGR_H
37 #include <stdint.h>
39 typedef struct _drm_intel_bufmgr drm_intel_bufmgr;
40 typedef struct _drm_intel_bo drm_intel_bo;
42 struct _drm_intel_bo {
43         /**
44          * Size in bytes of the buffer object.
45          *
46          * The size may be larger than the size originally requested for the
47          * allocation, such as being aligned to page size.
48          */
49         unsigned long size;
51         /**
52          * Alignment requirement for object
53          *
54          * Used for GTT mapping & pinning the object.
55          */
56         unsigned long align;
58         /**
59          * Last seen card virtual address (offset from the beginning of the
60          * aperture) for the object.  This should be used to fill relocation
61          * entries when calling drm_intel_bo_emit_reloc()
62          */
63         unsigned long offset;
65         /**
66          * Virtual address for accessing the buffer data.  Only valid while
67          * mapped.
68          */
69         void *virtual;
71         /** Buffer manager context associated with this buffer object */
72         drm_intel_bufmgr *bufmgr;
74         /**
75          * MM-specific handle for accessing object
76          */
77         int handle;
78 };
80 #define BO_ALLOC_FOR_RENDER (1<<0)
82 drm_intel_bo *drm_intel_bo_alloc(drm_intel_bufmgr *bufmgr, const char *name,
83                                  unsigned long size, unsigned int alignment);
84 drm_intel_bo *drm_intel_bo_alloc_for_render(drm_intel_bufmgr *bufmgr,
85                                             const char *name,
86                                             unsigned long size,
87                                             unsigned int alignment);
88 drm_intel_bo *drm_intel_bo_alloc_tiled(drm_intel_bufmgr *bufmgr,
89                                        const char *name,
90                                        int x, int y, int cpp,
91                                        uint32_t *tiling_mode,
92                                        unsigned long *pitch,
93                                        unsigned long flags);
94 void drm_intel_bo_reference(drm_intel_bo *bo);
95 void drm_intel_bo_unreference(drm_intel_bo *bo);
96 int drm_intel_bo_map(drm_intel_bo *bo, int write_enable);
97 int drm_intel_bo_unmap(drm_intel_bo *bo);
99 int drm_intel_bo_subdata(drm_intel_bo *bo, unsigned long offset,
100                          unsigned long size, const void *data);
101 int drm_intel_bo_get_subdata(drm_intel_bo *bo, unsigned long offset,
102                              unsigned long size, void *data);
103 void drm_intel_bo_wait_rendering(drm_intel_bo *bo);
105 void drm_intel_bufmgr_set_debug(drm_intel_bufmgr *bufmgr, int enable_debug);
106 void drm_intel_bufmgr_destroy(drm_intel_bufmgr *bufmgr);
107 int drm_intel_bo_exec(drm_intel_bo *bo, int used,
108                       drm_clip_rect_t * cliprects, int num_cliprects, int DR4);
109 int drm_intel_bufmgr_check_aperture_space(drm_intel_bo ** bo_array, int count);
111 int drm_intel_bo_emit_reloc(drm_intel_bo *bo, uint32_t offset,
112                             drm_intel_bo *target_bo, uint32_t target_offset,
113                             uint32_t read_domains, uint32_t write_domain);
114 int drm_intel_bo_pin(drm_intel_bo *bo, uint32_t alignment);
115 int drm_intel_bo_unpin(drm_intel_bo *bo);
116 int drm_intel_bo_set_tiling(drm_intel_bo *bo, uint32_t * tiling_mode,
117                             uint32_t stride);
118 int drm_intel_bo_get_tiling(drm_intel_bo *bo, uint32_t * tiling_mode,
119                             uint32_t * swizzle_mode);
120 int drm_intel_bo_flink(drm_intel_bo *bo, uint32_t * name);
121 int drm_intel_bo_busy(drm_intel_bo *bo);
123 int drm_intel_bo_disable_reuse(drm_intel_bo *bo);
124 int drm_intel_bo_references(drm_intel_bo *bo, drm_intel_bo *target_bo);
126 /* drm_intel_bufmgr_gem.c */
127 drm_intel_bufmgr *drm_intel_bufmgr_gem_init(int fd, int batch_size);
128 drm_intel_bo *drm_intel_bo_gem_create_from_name(drm_intel_bufmgr *bufmgr,
129                                                 const char *name,
130                                                 unsigned int handle);
131 void drm_intel_bufmgr_gem_enable_reuse(drm_intel_bufmgr *bufmgr);
132 int drm_intel_gem_bo_map_gtt(drm_intel_bo *bo);
133 int drm_intel_gem_bo_unmap_gtt(drm_intel_bo *bo);
134 void drm_intel_gem_bo_start_gtt_access(drm_intel_bo *bo, int write_enable);
136 int drm_intel_get_pipe_from_crtc_id(drm_intel_bufmgr *bufmgr, int crtc_id);
138 /* drm_intel_bufmgr_fake.c */
139 drm_intel_bufmgr *drm_intel_bufmgr_fake_init(int fd,
140                                              unsigned long low_offset,
141                                              void *low_virtual,
142                                              unsigned long size,
143                                              volatile unsigned int
144                                              *last_dispatch);
145 void drm_intel_bufmgr_fake_set_last_dispatch(drm_intel_bufmgr *bufmgr,
146                                              volatile unsigned int
147                                              *last_dispatch);
148 void drm_intel_bufmgr_fake_set_exec_callback(drm_intel_bufmgr *bufmgr,
149                                              int (*exec) (drm_intel_bo *bo,
150                                                           unsigned int used,
151                                                           void *priv),
152                                              void *priv);
153 void drm_intel_bufmgr_fake_set_fence_callback(drm_intel_bufmgr *bufmgr,
154                                               unsigned int (*emit) (void *priv),
155                                               void (*wait) (unsigned int fence,
156                                                             void *priv),
157                                               void *priv);
158 drm_intel_bo *drm_intel_bo_fake_alloc_static(drm_intel_bufmgr *bufmgr,
159                                              const char *name,
160                                              unsigned long offset,
161                                              unsigned long size, void *virtual);
162 void drm_intel_bo_fake_disable_backing_store(drm_intel_bo *bo,
163                                              void (*invalidate_cb) (drm_intel_bo
164                                                                     * bo,
165                                                                     void *ptr),
166                                              void *ptr);
168 void drm_intel_bufmgr_fake_contended_lock_take(drm_intel_bufmgr *bufmgr);
169 void drm_intel_bufmgr_fake_evict_all(drm_intel_bufmgr *bufmgr);
171 /** @{ Compatibility defines to keep old code building despite the symbol rename
172  * from dri_* to drm_intel_*
173  */
174 #define dri_bo drm_intel_bo
175 #define dri_bufmgr drm_intel_bufmgr
176 #define dri_bo_alloc drm_intel_bo_alloc
177 #define dri_bo_reference drm_intel_bo_reference
178 #define dri_bo_unreference drm_intel_bo_unreference
179 #define dri_bo_map drm_intel_bo_map
180 #define dri_bo_unmap drm_intel_bo_unmap
181 #define dri_bo_subdata drm_intel_bo_subdata
182 #define dri_bo_get_subdata drm_intel_bo_get_subdata
183 #define dri_bo_wait_rendering drm_intel_bo_wait_rendering
184 #define dri_bufmgr_set_debug drm_intel_bufmgr_set_debug
185 #define dri_bufmgr_destroy drm_intel_bufmgr_destroy
186 #define dri_bo_exec drm_intel_bo_exec
187 #define dri_bufmgr_check_aperture_space drm_intel_bufmgr_check_aperture_space
188 #define dri_bo_emit_reloc(reloc_bo, read, write, target_offset,         \
189                           reloc_offset, target_bo)                      \
190         drm_intel_bo_emit_reloc(reloc_bo, reloc_offset,                 \
191                                 target_bo, target_offset,               \
192                                 read, write);
193 #define dri_bo_pin drm_intel_bo_pin
194 #define dri_bo_unpin drm_intel_bo_unpin
195 #define dri_bo_get_tiling drm_intel_bo_get_tiling
196 #define dri_bo_set_tiling(bo, mode) drm_intel_bo_set_tiling(bo, mode, 0)
197 #define dri_bo_flink drm_intel_bo_flink
198 #define intel_bufmgr_gem_init drm_intel_bufmgr_gem_init
199 #define intel_bo_gem_create_from_name drm_intel_bo_gem_create_from_name
200 #define intel_bufmgr_gem_enable_reuse drm_intel_bufmgr_gem_enable_reuse
201 #define intel_bufmgr_fake_init drm_intel_bufmgr_fake_init
202 #define intel_bufmgr_fake_set_last_dispatch drm_intel_bufmgr_fake_set_last_dispatch
203 #define intel_bufmgr_fake_set_exec_callback drm_intel_bufmgr_fake_set_exec_callback
204 #define intel_bufmgr_fake_set_fence_callback drm_intel_bufmgr_fake_set_fence_callback
205 #define intel_bo_fake_alloc_static drm_intel_bo_fake_alloc_static
206 #define intel_bo_fake_disable_backing_store drm_intel_bo_fake_disable_backing_store
207 #define intel_bufmgr_fake_contended_lock_take drm_intel_bufmgr_fake_contended_lock_take
208 #define intel_bufmgr_fake_evict_all drm_intel_bufmgr_fake_evict_all
210 /** @{ */
212 #endif /* INTEL_BUFMGR_H */