intel_bufmgr.h revision 13d1d17d 
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 <stdint.h>
38
39typedef struct _drm_intel_bufmgr drm_intel_bufmgr;
40typedef struct _drm_intel_bo drm_intel_bo;
41
42struct _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;
50
51	/**
52	 * Alignment requirement for object
53	 *
54	 * Used for GTT mapping & pinning the object.
55	 */
56	unsigned long align;
57
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;
64
65	/**
66	 * Virtual address for accessing the buffer data.  Only valid while
67	 * mapped.
68	 */
69	void *virtual;
70
71	/** Buffer manager context associated with this buffer object */
72	drm_intel_bufmgr *bufmgr;
73
74	/**
75	 * MM-specific handle for accessing object
76	 */
77	int handle;
78};
79
80#define BO_ALLOC_FOR_RENDER (1<<0)
81
82drm_intel_bo *drm_intel_bo_alloc(drm_intel_bufmgr *bufmgr, const char *name,
83				 unsigned long size, unsigned int alignment);
84drm_intel_bo *drm_intel_bo_alloc_for_render(drm_intel_bufmgr *bufmgr,
85					    const char *name,
86					    unsigned long size,
87					    unsigned int alignment);
88drm_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);
94void drm_intel_bo_reference(drm_intel_bo *bo);
95void drm_intel_bo_unreference(drm_intel_bo *bo);
96int drm_intel_bo_map(drm_intel_bo *bo, int write_enable);
97int drm_intel_bo_unmap(drm_intel_bo *bo);
98
99int drm_intel_bo_subdata(drm_intel_bo *bo, unsigned long offset,
100			 unsigned long size, const void *data);
101int drm_intel_bo_get_subdata(drm_intel_bo *bo, unsigned long offset,
102			     unsigned long size, void *data);
103void drm_intel_bo_wait_rendering(drm_intel_bo *bo);
104
105void drm_intel_bufmgr_set_debug(drm_intel_bufmgr *bufmgr, int enable_debug);
106void drm_intel_bufmgr_destroy(drm_intel_bufmgr *bufmgr);
107int drm_intel_bo_exec(drm_intel_bo *bo, int used,
108		      drm_clip_rect_t * cliprects, int num_cliprects, int DR4);
109int drm_intel_bo_mrb_exec(drm_intel_bo *bo, int used,
110			drm_clip_rect_t *cliprects, int num_cliprects, int DR4,
111			int ring_flag);
112int drm_intel_bufmgr_check_aperture_space(drm_intel_bo ** bo_array, int count);
113
114int drm_intel_bo_emit_reloc(drm_intel_bo *bo, uint32_t offset,
115			    drm_intel_bo *target_bo, uint32_t target_offset,
116			    uint32_t read_domains, uint32_t write_domain);
117int drm_intel_bo_emit_reloc_fence(drm_intel_bo *bo, uint32_t offset,
118				  drm_intel_bo *target_bo,
119				  uint32_t target_offset,
120				  uint32_t read_domains, uint32_t write_domain);
121int drm_intel_bo_pin(drm_intel_bo *bo, uint32_t alignment);
122int drm_intel_bo_unpin(drm_intel_bo *bo);
123int drm_intel_bo_set_tiling(drm_intel_bo *bo, uint32_t * tiling_mode,
124			    uint32_t stride);
125int drm_intel_bo_get_tiling(drm_intel_bo *bo, uint32_t * tiling_mode,
126			    uint32_t * swizzle_mode);
127int drm_intel_bo_flink(drm_intel_bo *bo, uint32_t * name);
128int drm_intel_bo_busy(drm_intel_bo *bo);
129int drm_intel_bo_madvise(drm_intel_bo *bo, int madv);
130
131int drm_intel_bo_disable_reuse(drm_intel_bo *bo);
132int drm_intel_bo_is_reusable(drm_intel_bo *bo);
133int drm_intel_bo_references(drm_intel_bo *bo, drm_intel_bo *target_bo);
134
135/* drm_intel_bufmgr_gem.c */
136drm_intel_bufmgr *drm_intel_bufmgr_gem_init(int fd, int batch_size);
137drm_intel_bo *drm_intel_bo_gem_create_from_name(drm_intel_bufmgr *bufmgr,
138						const char *name,
139						unsigned int handle);
140void drm_intel_bufmgr_gem_enable_reuse(drm_intel_bufmgr *bufmgr);
141void drm_intel_bufmgr_gem_enable_fenced_relocs(drm_intel_bufmgr *bufmgr);
142int drm_intel_gem_bo_map_gtt(drm_intel_bo *bo);
143int drm_intel_gem_bo_unmap_gtt(drm_intel_bo *bo);
144void drm_intel_gem_bo_start_gtt_access(drm_intel_bo *bo, int write_enable);
145
146int drm_intel_get_pipe_from_crtc_id(drm_intel_bufmgr *bufmgr, int crtc_id);
147
148/* drm_intel_bufmgr_fake.c */
149drm_intel_bufmgr *drm_intel_bufmgr_fake_init(int fd,
150					     unsigned long low_offset,
151					     void *low_virtual,
152					     unsigned long size,
153					     volatile unsigned int
154					     *last_dispatch);
155void drm_intel_bufmgr_fake_set_last_dispatch(drm_intel_bufmgr *bufmgr,
156					     volatile unsigned int
157					     *last_dispatch);
158void drm_intel_bufmgr_fake_set_exec_callback(drm_intel_bufmgr *bufmgr,
159					     int (*exec) (drm_intel_bo *bo,
160							  unsigned int used,
161							  void *priv),
162					     void *priv);
163void drm_intel_bufmgr_fake_set_fence_callback(drm_intel_bufmgr *bufmgr,
164					      unsigned int (*emit) (void *priv),
165					      void (*wait) (unsigned int fence,
166							    void *priv),
167					      void *priv);
168drm_intel_bo *drm_intel_bo_fake_alloc_static(drm_intel_bufmgr *bufmgr,
169					     const char *name,
170					     unsigned long offset,
171					     unsigned long size, void *virtual);
172void drm_intel_bo_fake_disable_backing_store(drm_intel_bo *bo,
173					     void (*invalidate_cb) (drm_intel_bo
174								    * bo,
175								    void *ptr),
176					     void *ptr);
177
178void drm_intel_bufmgr_fake_contended_lock_take(drm_intel_bufmgr *bufmgr);
179void drm_intel_bufmgr_fake_evict_all(drm_intel_bufmgr *bufmgr);
180
181/** @{ Compatibility defines to keep old code building despite the symbol rename
182 * from dri_* to drm_intel_*
183 */
184#define dri_bo drm_intel_bo
185#define dri_bufmgr drm_intel_bufmgr
186#define dri_bo_alloc drm_intel_bo_alloc
187#define dri_bo_reference drm_intel_bo_reference
188#define dri_bo_unreference drm_intel_bo_unreference
189#define dri_bo_map drm_intel_bo_map
190#define dri_bo_unmap drm_intel_bo_unmap
191#define dri_bo_subdata drm_intel_bo_subdata
192#define dri_bo_get_subdata drm_intel_bo_get_subdata
193#define dri_bo_wait_rendering drm_intel_bo_wait_rendering
194#define dri_bufmgr_set_debug drm_intel_bufmgr_set_debug
195#define dri_bufmgr_destroy drm_intel_bufmgr_destroy
196#define dri_bo_exec drm_intel_bo_exec
197#define dri_bufmgr_check_aperture_space drm_intel_bufmgr_check_aperture_space
198#define dri_bo_emit_reloc(reloc_bo, read, write, target_offset,		\
199			  reloc_offset, target_bo)			\
200	drm_intel_bo_emit_reloc(reloc_bo, reloc_offset,			\
201				target_bo, target_offset,		\
202				read, write);
203#define dri_bo_pin drm_intel_bo_pin
204#define dri_bo_unpin drm_intel_bo_unpin
205#define dri_bo_get_tiling drm_intel_bo_get_tiling
206#define dri_bo_set_tiling(bo, mode) drm_intel_bo_set_tiling(bo, mode, 0)
207#define dri_bo_flink drm_intel_bo_flink
208#define intel_bufmgr_gem_init drm_intel_bufmgr_gem_init
209#define intel_bo_gem_create_from_name drm_intel_bo_gem_create_from_name
210#define intel_bufmgr_gem_enable_reuse drm_intel_bufmgr_gem_enable_reuse
211#define intel_bufmgr_fake_init drm_intel_bufmgr_fake_init
212#define intel_bufmgr_fake_set_last_dispatch drm_intel_bufmgr_fake_set_last_dispatch
213#define intel_bufmgr_fake_set_exec_callback drm_intel_bufmgr_fake_set_exec_callback
214#define intel_bufmgr_fake_set_fence_callback drm_intel_bufmgr_fake_set_fence_callback
215#define intel_bo_fake_alloc_static drm_intel_bo_fake_alloc_static
216#define intel_bo_fake_disable_backing_store drm_intel_bo_fake_disable_backing_store
217#define intel_bufmgr_fake_contended_lock_take drm_intel_bufmgr_fake_contended_lock_take
218#define intel_bufmgr_fake_evict_all drm_intel_bufmgr_fake_evict_all
219
220/** @{ */
221
222#endif /* INTEL_BUFMGR_H */
223