1 /**********************************************************
2 * Copyright 2008-2009 VMware, Inc. All rights reserved.
4 * Permission is hereby granted, free of charge, to any person
5 * obtaining a copy of this software and associated documentation
6 * files (the "Software"), to deal in the Software without
7 * restriction, including without limitation the rights to use, copy,
8 * modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be
13 * included in all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
19 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
20 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 **********************************************************/
28 * VMware SVGA specific winsys interface.
30 * @author Jose Fonseca <jfonseca@vmware.com>
32 * Documentation taken from the VMware SVGA DDK.
35 #ifndef SVGA_WINSYS_H_
36 #define SVGA_WINSYS_H_
39 #include "svga_types.h"
41 #include "svga3d_reg.h"
43 #include "pipe/p_compiler.h"
44 #include "pipe/p_defines.h"
47 struct svga_winsys_screen
;
48 struct svga_winsys_buffer
;
51 struct pipe_fence_handle
;
57 #define SVGA_BUFFER_USAGE_PINNED (1 << 0)
58 #define SVGA_BUFFER_USAGE_WRAPPED (1 << 1)
61 #define SVGA_RELOC_WRITE 0x1
62 #define SVGA_RELOC_READ 0x2
64 #define SVGA_FENCE_FLAG_EXEC (1 << 0)
65 #define SVGA_FENCE_FLAG_QUERY (1 << 1)
67 /** Opaque surface handle */
68 struct svga_winsys_surface
;
72 * SVGA per-context winsys interface.
74 struct svga_winsys_context
77 (*destroy
)(struct svga_winsys_context
*swc
);
80 (*reserve
)(struct svga_winsys_context
*swc
,
81 uint32_t nr_bytes
, uint32_t nr_relocs
);
84 * Emit a relocation for a host surface.
86 * @param flags bitmask of SVGA_RELOC_* flags
88 * NOTE: Order of this call does matter. It should be the same order
89 * as relocations appear in the command buffer.
92 (*surface_relocation
)(struct svga_winsys_context
*swc
,
94 struct svga_winsys_surface
*surface
,
98 * Emit a relocation for a guest memory region.
100 * @param flags bitmask of SVGA_RELOC_* flags
102 * NOTE: Order of this call does matter. It should be the same order
103 * as relocations appear in the command buffer.
106 (*region_relocation
)(struct svga_winsys_context
*swc
,
107 struct SVGAGuestPtr
*ptr
,
108 struct svga_winsys_buffer
*buffer
,
113 (*commit
)(struct svga_winsys_context
*swc
);
116 (*flush
)(struct svga_winsys_context
*swc
,
117 struct pipe_fence_handle
**pfence
);
120 * Context ID used to fill in the commands
122 * Context IDs are arbitrary small non-negative integers,
123 * global to the entire SVGA device.
130 * SVGA per-screen winsys interface.
132 struct svga_winsys_screen
135 (*destroy
)(struct svga_winsys_screen
*sws
);
137 SVGA3dHardwareVersion
138 (*get_hw_version
)(struct svga_winsys_screen
*sws
);
141 (*get_cap
)(struct svga_winsys_screen
*sws
,
142 SVGA3dDevCapIndex index
,
143 SVGA3dDevCapResult
*result
);
146 * Create a new context.
148 * Context objects encapsulate all render state, and shader
149 * objects are per-context.
151 * Surfaces are not per-context. The same surface can be shared
152 * between multiple contexts, and surface operations can occur
155 struct svga_winsys_context
*
156 (*context_create
)(struct svga_winsys_screen
*sws
);
160 * This creates a "surface" object in the SVGA3D device,
161 * and returns the surface ID (sid). Surfaces are generic
162 * containers for host VRAM objects like textures, vertex
163 * buffers, and depth/stencil buffers.
165 * Surfaces are hierarchial:
167 * - Surface may have multiple faces (for cube maps)
169 * - Each face has a list of mipmap levels
171 * - Each mipmap image may have multiple volume
172 * slices, if the image is three dimensional.
174 * - Each slice is a 2D array of 'blocks'
176 * - Each block may be one or more pixels.
177 * (Usually 1, more for DXT or YUV formats.)
179 * Surfaces are generic host VRAM objects. The SVGA3D device
180 * may optimize surfaces according to the format they were
181 * created with, but this format does not limit the ways in
182 * which the surface may be used. For example, a depth surface
183 * can be used as a texture, or a floating point image may
184 * be used as a vertex buffer. Some surface usages may be
185 * lower performance, due to software emulation, but any
186 * usage should work with any surface.
188 struct svga_winsys_surface
*
189 (*surface_create
)(struct svga_winsys_screen
*sws
,
190 SVGA3dSurfaceFlags flags
,
191 SVGA3dSurfaceFormat format
,
194 uint32 numMipLevels
);
197 * Creates a surface from a winsys handle.
198 * Used to implement pipe_screen::resource_from_handle.
200 struct svga_winsys_surface
*
201 (*surface_from_handle
)(struct svga_winsys_screen
*sws
,
202 struct winsys_handle
*whandle
,
203 SVGA3dSurfaceFormat
*format
);
206 * Get a winsys_handle from a surface.
207 * Used to implement pipe_screen::resource_get_handle.
210 (*surface_get_handle
)(struct svga_winsys_screen
*sws
,
211 struct svga_winsys_surface
*surface
,
213 struct winsys_handle
*whandle
);
216 * Whether this surface is sitting in a validate list
219 (*surface_is_flushed
)(struct svga_winsys_screen
*sws
,
220 struct svga_winsys_surface
*surface
);
223 * Reference a SVGA3D surface object. This allows sharing of a
224 * surface between different objects.
227 (*surface_reference
)(struct svga_winsys_screen
*sws
,
228 struct svga_winsys_surface
**pdst
,
229 struct svga_winsys_surface
*src
);
232 * Buffer management. Buffer attributes are mostly fixed over its lifetime.
234 * @param usage bitmask of SVGA_BUFFER_USAGE_* flags.
236 * alignment indicates the client's alignment requirements, eg for
239 struct svga_winsys_buffer
*
240 (*buffer_create
)( struct svga_winsys_screen
*sws
,
246 * Map the entire data store of a buffer object into the client's address.
247 * usage is a bitmask of PIPE_TRANSFER_*
250 (*buffer_map
)( struct svga_winsys_screen
*sws
,
251 struct svga_winsys_buffer
*buf
,
255 (*buffer_unmap
)( struct svga_winsys_screen
*sws
,
256 struct svga_winsys_buffer
*buf
);
259 (*buffer_destroy
)( struct svga_winsys_screen
*sws
,
260 struct svga_winsys_buffer
*buf
);
264 * Reference a fence object.
267 (*fence_reference
)( struct svga_winsys_screen
*sws
,
268 struct pipe_fence_handle
**pdst
,
269 struct pipe_fence_handle
*src
);
272 * Checks whether the fence has been signalled.
273 * \param flags driver-specific meaning
274 * \return zero on success.
276 int (*fence_signalled
)( struct svga_winsys_screen
*sws
,
277 struct pipe_fence_handle
*fence
,
281 * Wait for the fence to finish.
282 * \param flags driver-specific meaning
283 * \return zero on success.
285 int (*fence_finish
)( struct svga_winsys_screen
*sws
,
286 struct pipe_fence_handle
*fence
,
292 struct svga_winsys_screen
*
293 svga_winsys_screen(struct pipe_screen
*screen
);
295 struct svga_winsys_context
*
296 svga_winsys_context(struct pipe_context
*context
);
298 struct pipe_resource
*
299 svga_screen_buffer_wrap_surface(struct pipe_screen
*screen
,
300 enum SVGA3dSurfaceFormat format
,
301 struct svga_winsys_surface
*srf
);
303 struct svga_winsys_surface
*
304 svga_screen_buffer_get_winsys_surface(struct pipe_resource
*buffer
);
306 #endif /* SVGA_WINSYS_H_ */