intel_bufmgr.h revision e6188e58
1/*
2 * Copyright © 2008-2012 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#include <stdio.h>
40
41struct drm_clip_rect;
42
43typedef struct _drm_intel_bufmgr drm_intel_bufmgr;
44typedef struct _drm_intel_context drm_intel_context;
45typedef struct _drm_intel_bo drm_intel_bo;
46
47struct _drm_intel_bo {
48	/**
49	 * Size in bytes of the buffer object.
50	 *
51	 * The size may be larger than the size originally requested for the
52	 * allocation, such as being aligned to page size.
53	 */
54	unsigned long size;
55
56	/**
57	 * Alignment requirement for object
58	 *
59	 * Used for GTT mapping & pinning the object.
60	 */
61	unsigned long align;
62
63	/**
64	 * Deprecated field containing (possibly the low 32-bits of) the last
65	 * seen virtual card address.  Use offset64 instead.
66	 */
67	unsigned long offset;
68
69	/**
70	 * Virtual address for accessing the buffer data.  Only valid while
71	 * mapped.
72	 */
73#ifdef __cplusplus
74	void *virt;
75#else
76	void *virtual;
77#endif
78
79	/** Buffer manager context associated with this buffer object */
80	drm_intel_bufmgr *bufmgr;
81
82	/**
83	 * MM-specific handle for accessing object
84	 */
85	int handle;
86
87	/**
88	 * Last seen card virtual address (offset from the beginning of the
89	 * aperture) for the object.  This should be used to fill relocation
90	 * entries when calling drm_intel_bo_emit_reloc()
91	 */
92	uint64_t offset64;
93};
94
95enum aub_dump_bmp_format {
96	AUB_DUMP_BMP_FORMAT_8BIT = 1,
97	AUB_DUMP_BMP_FORMAT_ARGB_4444 = 4,
98	AUB_DUMP_BMP_FORMAT_ARGB_0888 = 6,
99	AUB_DUMP_BMP_FORMAT_ARGB_8888 = 7,
100};
101
102typedef struct _drm_intel_aub_annotation {
103	uint32_t type;
104	uint32_t subtype;
105	uint32_t ending_offset;
106} drm_intel_aub_annotation;
107
108#define BO_ALLOC_FOR_RENDER (1<<0)
109
110drm_intel_bo *drm_intel_bo_alloc(drm_intel_bufmgr *bufmgr, const char *name,
111				 unsigned long size, unsigned int alignment);
112drm_intel_bo *drm_intel_bo_alloc_for_render(drm_intel_bufmgr *bufmgr,
113					    const char *name,
114					    unsigned long size,
115					    unsigned int alignment);
116drm_intel_bo *drm_intel_bo_alloc_userptr(drm_intel_bufmgr *bufmgr,
117					const char *name,
118					void *addr, uint32_t tiling_mode,
119					uint32_t stride, unsigned long size,
120					unsigned long flags);
121drm_intel_bo *drm_intel_bo_alloc_tiled(drm_intel_bufmgr *bufmgr,
122				       const char *name,
123				       int x, int y, int cpp,
124				       uint32_t *tiling_mode,
125				       unsigned long *pitch,
126				       unsigned long flags);
127void drm_intel_bo_reference(drm_intel_bo *bo);
128void drm_intel_bo_unreference(drm_intel_bo *bo);
129int drm_intel_bo_map(drm_intel_bo *bo, int write_enable);
130int drm_intel_bo_unmap(drm_intel_bo *bo);
131
132int drm_intel_bo_subdata(drm_intel_bo *bo, unsigned long offset,
133			 unsigned long size, const void *data);
134int drm_intel_bo_get_subdata(drm_intel_bo *bo, unsigned long offset,
135			     unsigned long size, void *data);
136void drm_intel_bo_wait_rendering(drm_intel_bo *bo);
137
138void drm_intel_bufmgr_set_debug(drm_intel_bufmgr *bufmgr, int enable_debug);
139void drm_intel_bufmgr_destroy(drm_intel_bufmgr *bufmgr);
140int drm_intel_bo_exec(drm_intel_bo *bo, int used,
141		      struct drm_clip_rect *cliprects, int num_cliprects, int DR4);
142int drm_intel_bo_mrb_exec(drm_intel_bo *bo, int used,
143			struct drm_clip_rect *cliprects, int num_cliprects, int DR4,
144			unsigned int flags);
145int drm_intel_bufmgr_check_aperture_space(drm_intel_bo ** bo_array, int count);
146
147int drm_intel_bo_emit_reloc(drm_intel_bo *bo, uint32_t offset,
148			    drm_intel_bo *target_bo, uint32_t target_offset,
149			    uint32_t read_domains, uint32_t write_domain);
150int drm_intel_bo_emit_reloc_fence(drm_intel_bo *bo, uint32_t offset,
151				  drm_intel_bo *target_bo,
152				  uint32_t target_offset,
153				  uint32_t read_domains, uint32_t write_domain);
154int drm_intel_bo_pin(drm_intel_bo *bo, uint32_t alignment);
155int drm_intel_bo_unpin(drm_intel_bo *bo);
156int drm_intel_bo_set_tiling(drm_intel_bo *bo, uint32_t * tiling_mode,
157			    uint32_t stride);
158int drm_intel_bo_get_tiling(drm_intel_bo *bo, uint32_t * tiling_mode,
159			    uint32_t * swizzle_mode);
160int drm_intel_bo_flink(drm_intel_bo *bo, uint32_t * name);
161int drm_intel_bo_busy(drm_intel_bo *bo);
162int drm_intel_bo_madvise(drm_intel_bo *bo, int madv);
163
164int drm_intel_bo_disable_reuse(drm_intel_bo *bo);
165int drm_intel_bo_is_reusable(drm_intel_bo *bo);
166int drm_intel_bo_references(drm_intel_bo *bo, drm_intel_bo *target_bo);
167
168/* drm_intel_bufmgr_gem.c */
169drm_intel_bufmgr *drm_intel_bufmgr_gem_init(int fd, int batch_size);
170drm_intel_bo *drm_intel_bo_gem_create_from_name(drm_intel_bufmgr *bufmgr,
171						const char *name,
172						unsigned int handle);
173void drm_intel_bufmgr_gem_enable_reuse(drm_intel_bufmgr *bufmgr);
174void drm_intel_bufmgr_gem_enable_fenced_relocs(drm_intel_bufmgr *bufmgr);
175void drm_intel_bufmgr_gem_set_vma_cache_size(drm_intel_bufmgr *bufmgr,
176					     int limit);
177int drm_intel_gem_bo_map_unsynchronized(drm_intel_bo *bo);
178int drm_intel_gem_bo_map_gtt(drm_intel_bo *bo);
179int drm_intel_gem_bo_unmap_gtt(drm_intel_bo *bo);
180
181int drm_intel_gem_bo_get_reloc_count(drm_intel_bo *bo);
182void drm_intel_gem_bo_clear_relocs(drm_intel_bo *bo, int start);
183void drm_intel_gem_bo_start_gtt_access(drm_intel_bo *bo, int write_enable);
184
185void
186drm_intel_bufmgr_gem_set_aub_filename(drm_intel_bufmgr *bufmgr,
187				      const char *filename);
188void drm_intel_bufmgr_gem_set_aub_dump(drm_intel_bufmgr *bufmgr, int enable);
189void drm_intel_gem_bo_aub_dump_bmp(drm_intel_bo *bo,
190				   int x1, int y1, int width, int height,
191				   enum aub_dump_bmp_format format,
192				   int pitch, int offset);
193void
194drm_intel_bufmgr_gem_set_aub_annotations(drm_intel_bo *bo,
195					 drm_intel_aub_annotation *annotations,
196					 unsigned count);
197
198int drm_intel_get_pipe_from_crtc_id(drm_intel_bufmgr *bufmgr, int crtc_id);
199
200int drm_intel_get_aperture_sizes(int fd, size_t *mappable, size_t *total);
201int drm_intel_bufmgr_gem_get_devid(drm_intel_bufmgr *bufmgr);
202int drm_intel_gem_bo_wait(drm_intel_bo *bo, int64_t timeout_ns);
203
204drm_intel_context *drm_intel_gem_context_create(drm_intel_bufmgr *bufmgr);
205void drm_intel_gem_context_destroy(drm_intel_context *ctx);
206int drm_intel_gem_bo_context_exec(drm_intel_bo *bo, drm_intel_context *ctx,
207				  int used, unsigned int flags);
208
209int drm_intel_bo_gem_export_to_prime(drm_intel_bo *bo, int *prime_fd);
210drm_intel_bo *drm_intel_bo_gem_create_from_prime(drm_intel_bufmgr *bufmgr,
211						int prime_fd, int size);
212
213/* drm_intel_bufmgr_fake.c */
214drm_intel_bufmgr *drm_intel_bufmgr_fake_init(int fd,
215					     unsigned long low_offset,
216					     void *low_virtual,
217					     unsigned long size,
218					     volatile unsigned int
219					     *last_dispatch);
220void drm_intel_bufmgr_fake_set_last_dispatch(drm_intel_bufmgr *bufmgr,
221					     volatile unsigned int
222					     *last_dispatch);
223void drm_intel_bufmgr_fake_set_exec_callback(drm_intel_bufmgr *bufmgr,
224					     int (*exec) (drm_intel_bo *bo,
225							  unsigned int used,
226							  void *priv),
227					     void *priv);
228void drm_intel_bufmgr_fake_set_fence_callback(drm_intel_bufmgr *bufmgr,
229					      unsigned int (*emit) (void *priv),
230					      void (*wait) (unsigned int fence,
231							    void *priv),
232					      void *priv);
233drm_intel_bo *drm_intel_bo_fake_alloc_static(drm_intel_bufmgr *bufmgr,
234					     const char *name,
235					     unsigned long offset,
236					     unsigned long size, void *virt);
237void drm_intel_bo_fake_disable_backing_store(drm_intel_bo *bo,
238					     void (*invalidate_cb) (drm_intel_bo
239								    * bo,
240								    void *ptr),
241					     void *ptr);
242
243void drm_intel_bufmgr_fake_contended_lock_take(drm_intel_bufmgr *bufmgr);
244void drm_intel_bufmgr_fake_evict_all(drm_intel_bufmgr *bufmgr);
245
246struct drm_intel_decode *drm_intel_decode_context_alloc(uint32_t devid);
247void drm_intel_decode_context_free(struct drm_intel_decode *ctx);
248void drm_intel_decode_set_batch_pointer(struct drm_intel_decode *ctx,
249					void *data, uint32_t hw_offset,
250					int count);
251void drm_intel_decode_set_dump_past_end(struct drm_intel_decode *ctx,
252					int dump_past_end);
253void drm_intel_decode_set_head_tail(struct drm_intel_decode *ctx,
254				    uint32_t head, uint32_t tail);
255void drm_intel_decode_set_output_file(struct drm_intel_decode *ctx, FILE *out);
256void drm_intel_decode(struct drm_intel_decode *ctx);
257
258int drm_intel_reg_read(drm_intel_bufmgr *bufmgr,
259		       uint32_t offset,
260		       uint64_t *result);
261
262int drm_intel_get_reset_stats(drm_intel_context *ctx,
263			      uint32_t *reset_count,
264			      uint32_t *active,
265			      uint32_t *pending);
266
267int drm_intel_get_subslice_total(int fd, unsigned int *subslice_total);
268int drm_intel_get_eu_total(int fd, unsigned int *eu_total);
269
270/** @{ Compatibility defines to keep old code building despite the symbol rename
271 * from dri_* to drm_intel_*
272 */
273#define dri_bo drm_intel_bo
274#define dri_bufmgr drm_intel_bufmgr
275#define dri_bo_alloc drm_intel_bo_alloc
276#define dri_bo_reference drm_intel_bo_reference
277#define dri_bo_unreference drm_intel_bo_unreference
278#define dri_bo_map drm_intel_bo_map
279#define dri_bo_unmap drm_intel_bo_unmap
280#define dri_bo_subdata drm_intel_bo_subdata
281#define dri_bo_get_subdata drm_intel_bo_get_subdata
282#define dri_bo_wait_rendering drm_intel_bo_wait_rendering
283#define dri_bufmgr_set_debug drm_intel_bufmgr_set_debug
284#define dri_bufmgr_destroy drm_intel_bufmgr_destroy
285#define dri_bo_exec drm_intel_bo_exec
286#define dri_bufmgr_check_aperture_space drm_intel_bufmgr_check_aperture_space
287#define dri_bo_emit_reloc(reloc_bo, read, write, target_offset,		\
288			  reloc_offset, target_bo)			\
289	drm_intel_bo_emit_reloc(reloc_bo, reloc_offset,			\
290				target_bo, target_offset,		\
291				read, write);
292#define dri_bo_pin drm_intel_bo_pin
293#define dri_bo_unpin drm_intel_bo_unpin
294#define dri_bo_get_tiling drm_intel_bo_get_tiling
295#define dri_bo_set_tiling(bo, mode) drm_intel_bo_set_tiling(bo, mode, 0)
296#define dri_bo_flink drm_intel_bo_flink
297#define intel_bufmgr_gem_init drm_intel_bufmgr_gem_init
298#define intel_bo_gem_create_from_name drm_intel_bo_gem_create_from_name
299#define intel_bufmgr_gem_enable_reuse drm_intel_bufmgr_gem_enable_reuse
300#define intel_bufmgr_fake_init drm_intel_bufmgr_fake_init
301#define intel_bufmgr_fake_set_last_dispatch drm_intel_bufmgr_fake_set_last_dispatch
302#define intel_bufmgr_fake_set_exec_callback drm_intel_bufmgr_fake_set_exec_callback
303#define intel_bufmgr_fake_set_fence_callback drm_intel_bufmgr_fake_set_fence_callback
304#define intel_bo_fake_alloc_static drm_intel_bo_fake_alloc_static
305#define intel_bo_fake_disable_backing_store drm_intel_bo_fake_disable_backing_store
306#define intel_bufmgr_fake_contended_lock_take drm_intel_bufmgr_fake_contended_lock_take
307#define intel_bufmgr_fake_evict_all drm_intel_bufmgr_fake_evict_all
308
309/** @{ */
310
311#endif /* INTEL_BUFMGR_H */
312