intel: Add an interface for setting the output file for decode.
[gstreamer-omap: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  */
27
28 /**
29  * @file intel_bufmgr.h
30  *
31  * Public definitions of Intel-specific bufmgr functions.
32  */
33
34 #ifndef INTEL_BUFMGR_H
35 #define INTEL_BUFMGR_H
36
37 #include <stdio.h>
38 #include <stdint.h>
39
40 struct drm_clip_rect;
41
42 typedef struct _drm_intel_bufmgr drm_intel_bufmgr;
43 typedef struct _drm_intel_bo drm_intel_bo;
44
45 struct _drm_intel_bo {
46         /**
47          * Size in bytes of the buffer object.
48          *
49          * The size may be larger than the size originally requested for the
50          * allocation, such as being aligned to page size.
51          */
52         unsigned long size;
53
54         /**
55          * Alignment requirement for object
56          *
57          * Used for GTT mapping & pinning the object.
58          */
59         unsigned long align;
60
61         /**
62          * Last seen card virtual address (offset from the beginning of the
63          * aperture) for the object.  This should be used to fill relocation
64          * entries when calling drm_intel_bo_emit_reloc()
65          */
66         unsigned long offset;
67
68         /**
69          * Virtual address for accessing the buffer data.  Only valid while
70          * mapped.
71          */
72 #ifdef __cplusplus
73         void *virt;
74 #else
75         void *virtual;
76 #endif
77
78         /** Buffer manager context associated with this buffer object */
79         drm_intel_bufmgr *bufmgr;
80
81         /**
82          * MM-specific handle for accessing object
83          */
84         int handle;
85 };
86
87 #define BO_ALLOC_FOR_RENDER (1<<0)
88
89 drm_intel_bo *drm_intel_bo_alloc(drm_intel_bufmgr *bufmgr, const char *name,
90                                  unsigned long size, unsigned int alignment);
91 drm_intel_bo *drm_intel_bo_alloc_for_render(drm_intel_bufmgr *bufmgr,
92                                             const char *name,
93                                             unsigned long size,
94                                             unsigned int alignment);
95 drm_intel_bo *drm_intel_bo_alloc_tiled(drm_intel_bufmgr *bufmgr,
96                                        const char *name,
97                                        int x, int y, int cpp,
98                                        uint32_t *tiling_mode,
99                                        unsigned long *pitch,
100                                        unsigned long flags);
101 void drm_intel_bo_reference(drm_intel_bo *bo);
102 void drm_intel_bo_unreference(drm_intel_bo *bo);
103 int drm_intel_bo_map(drm_intel_bo *bo, int write_enable);
104 int drm_intel_bo_unmap(drm_intel_bo *bo);
105
106 int drm_intel_bo_subdata(drm_intel_bo *bo, unsigned long offset,
107                          unsigned long size, const void *data);
108 int drm_intel_bo_get_subdata(drm_intel_bo *bo, unsigned long offset,
109                              unsigned long size, void *data);
110 void drm_intel_bo_wait_rendering(drm_intel_bo *bo);
111
112 void drm_intel_bufmgr_set_debug(drm_intel_bufmgr *bufmgr, int enable_debug);
113 void drm_intel_bufmgr_destroy(drm_intel_bufmgr *bufmgr);
114 int drm_intel_bo_exec(drm_intel_bo *bo, int used,
115                       struct drm_clip_rect *cliprects, int num_cliprects, int DR4);
116 int drm_intel_bo_mrb_exec(drm_intel_bo *bo, int used,
117                         struct drm_clip_rect *cliprects, int num_cliprects, int DR4,
118                         unsigned int flags);
119 int drm_intel_bufmgr_check_aperture_space(drm_intel_bo ** bo_array, int count);
120
121 int drm_intel_bo_emit_reloc(drm_intel_bo *bo, uint32_t offset,
122                             drm_intel_bo *target_bo, uint32_t target_offset,
123                             uint32_t read_domains, uint32_t write_domain);
124 int drm_intel_bo_emit_reloc_fence(drm_intel_bo *bo, uint32_t offset,
125                                   drm_intel_bo *target_bo,
126                                   uint32_t target_offset,
127                                   uint32_t read_domains, uint32_t write_domain);
128 int drm_intel_bo_pin(drm_intel_bo *bo, uint32_t alignment);
129 int drm_intel_bo_unpin(drm_intel_bo *bo);
130 int drm_intel_bo_set_tiling(drm_intel_bo *bo, uint32_t * tiling_mode,
131                             uint32_t stride);
132 int drm_intel_bo_get_tiling(drm_intel_bo *bo, uint32_t * tiling_mode,
133                             uint32_t * swizzle_mode);
134 int drm_intel_bo_flink(drm_intel_bo *bo, uint32_t * name);
135 int drm_intel_bo_busy(drm_intel_bo *bo);
136 int drm_intel_bo_madvise(drm_intel_bo *bo, int madv);
137
138 int drm_intel_bo_disable_reuse(drm_intel_bo *bo);
139 int drm_intel_bo_is_reusable(drm_intel_bo *bo);
140 int drm_intel_bo_references(drm_intel_bo *bo, drm_intel_bo *target_bo);
141
142 /* drm_intel_bufmgr_gem.c */
143 drm_intel_bufmgr *drm_intel_bufmgr_gem_init(int fd, int batch_size);
144 drm_intel_bo *drm_intel_bo_gem_create_from_name(drm_intel_bufmgr *bufmgr,
145                                                 const char *name,
146                                                 unsigned int handle);
147 void drm_intel_bufmgr_gem_enable_reuse(drm_intel_bufmgr *bufmgr);
148 void drm_intel_bufmgr_gem_enable_fenced_relocs(drm_intel_bufmgr *bufmgr);
149 void drm_intel_bufmgr_gem_set_vma_cache_size(drm_intel_bufmgr *bufmgr,
150                                              int limit);
151 int drm_intel_gem_bo_map_gtt(drm_intel_bo *bo);
152 int drm_intel_gem_bo_unmap_gtt(drm_intel_bo *bo);
153 int drm_intel_gem_bo_get_reloc_count(drm_intel_bo *bo);
154 void drm_intel_gem_bo_clear_relocs(drm_intel_bo *bo, int start);
155 void drm_intel_gem_bo_start_gtt_access(drm_intel_bo *bo, int write_enable);
156
157 int drm_intel_get_pipe_from_crtc_id(drm_intel_bufmgr *bufmgr, int crtc_id);
158
159 int drm_intel_get_aperture_sizes(int fd, size_t *mappable, size_t *total);
160
161 /* drm_intel_bufmgr_fake.c */
162 drm_intel_bufmgr *drm_intel_bufmgr_fake_init(int fd,
163                                              unsigned long low_offset,
164                                              void *low_virtual,
165                                              unsigned long size,
166                                              volatile unsigned int
167                                              *last_dispatch);
168 void drm_intel_bufmgr_fake_set_last_dispatch(drm_intel_bufmgr *bufmgr,
169                                              volatile unsigned int
170                                              *last_dispatch);
171 void drm_intel_bufmgr_fake_set_exec_callback(drm_intel_bufmgr *bufmgr,
172                                              int (*exec) (drm_intel_bo *bo,
173                                                           unsigned int used,
174                                                           void *priv),
175                                              void *priv);
176 void drm_intel_bufmgr_fake_set_fence_callback(drm_intel_bufmgr *bufmgr,
177                                               unsigned int (*emit) (void *priv),
178                                               void (*wait) (unsigned int fence,
179                                                             void *priv),
180                                               void *priv);
181 drm_intel_bo *drm_intel_bo_fake_alloc_static(drm_intel_bufmgr *bufmgr,
182                                              const char *name,
183                                              unsigned long offset,
184                                              unsigned long size, void *virt);
185 void drm_intel_bo_fake_disable_backing_store(drm_intel_bo *bo,
186                                              void (*invalidate_cb) (drm_intel_bo
187                                                                     * bo,
188                                                                     void *ptr),
189                                              void *ptr);
190
191 void drm_intel_bufmgr_fake_contended_lock_take(drm_intel_bufmgr *bufmgr);
192 void drm_intel_bufmgr_fake_evict_all(drm_intel_bufmgr *bufmgr);
193
194 struct drm_intel_decode *drm_intel_decode_context_alloc(uint32_t devid);
195 void drm_intel_decode_context_free(struct drm_intel_decode *ctx);
196 void drm_intel_decode_set_batch_pointer(struct drm_intel_decode *ctx,
197                                         void *data, uint32_t hw_offset,
198                                         int count);
199 void drm_intel_decode_set_dump_past_end(struct drm_intel_decode *ctx,
200                                         int dump_past_end);
201 void drm_intel_decode_set_head_tail(struct drm_intel_decode *ctx,
202                                     uint32_t head, uint32_t tail);
203 void drm_intel_decode_set_output_file(struct drm_intel_decode *ctx, FILE *out);
204 void drm_intel_decode(struct drm_intel_decode *ctx);
205
206
207 /** @{ Compatibility defines to keep old code building despite the symbol rename
208  * from dri_* to drm_intel_*
209  */
210 #define dri_bo drm_intel_bo
211 #define dri_bufmgr drm_intel_bufmgr
212 #define dri_bo_alloc drm_intel_bo_alloc
213 #define dri_bo_reference drm_intel_bo_reference
214 #define dri_bo_unreference drm_intel_bo_unreference
215 #define dri_bo_map drm_intel_bo_map
216 #define dri_bo_unmap drm_intel_bo_unmap
217 #define dri_bo_subdata drm_intel_bo_subdata
218 #define dri_bo_get_subdata drm_intel_bo_get_subdata
219 #define dri_bo_wait_rendering drm_intel_bo_wait_rendering
220 #define dri_bufmgr_set_debug drm_intel_bufmgr_set_debug
221 #define dri_bufmgr_destroy drm_intel_bufmgr_destroy
222 #define dri_bo_exec drm_intel_bo_exec
223 #define dri_bufmgr_check_aperture_space drm_intel_bufmgr_check_aperture_space
224 #define dri_bo_emit_reloc(reloc_bo, read, write, target_offset,         \
225                           reloc_offset, target_bo)                      \
226         drm_intel_bo_emit_reloc(reloc_bo, reloc_offset,                 \
227                                 target_bo, target_offset,               \
228                                 read, write);
229 #define dri_bo_pin drm_intel_bo_pin
230 #define dri_bo_unpin drm_intel_bo_unpin
231 #define dri_bo_get_tiling drm_intel_bo_get_tiling
232 #define dri_bo_set_tiling(bo, mode) drm_intel_bo_set_tiling(bo, mode, 0)
233 #define dri_bo_flink drm_intel_bo_flink
234 #define intel_bufmgr_gem_init drm_intel_bufmgr_gem_init
235 #define intel_bo_gem_create_from_name drm_intel_bo_gem_create_from_name
236 #define intel_bufmgr_gem_enable_reuse drm_intel_bufmgr_gem_enable_reuse
237 #define intel_bufmgr_fake_init drm_intel_bufmgr_fake_init
238 #define intel_bufmgr_fake_set_last_dispatch drm_intel_bufmgr_fake_set_last_dispatch
239 #define intel_bufmgr_fake_set_exec_callback drm_intel_bufmgr_fake_set_exec_callback
240 #define intel_bufmgr_fake_set_fence_callback drm_intel_bufmgr_fake_set_fence_callback
241 #define intel_bo_fake_alloc_static drm_intel_bo_fake_alloc_static
242 #define intel_bo_fake_disable_backing_store drm_intel_bo_fake_disable_backing_store
243 #define intel_bufmgr_fake_contended_lock_take drm_intel_bufmgr_fake_contended_lock_take
244 #define intel_bufmgr_fake_evict_all drm_intel_bufmgr_fake_evict_all
245
246 /** @{ */
247
248 #endif /* INTEL_BUFMGR_H */