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 **********************************************************/
29 * Command construction utility for the SVGA3D protocol used by
30 * the VMware SVGA device, based on the svgautil library.
33 #include "svga_winsys.h"
34 #include "svga_resource_buffer.h"
35 #include "svga_resource_texture.h"
36 #include "svga_surface.h"
40 *----------------------------------------------------------------------
42 * surface_to_surfaceid --
44 * Utility function for surface ids.
45 * Can handle null surface. Does a surface_reallocation so you need
46 * to have allocated the fifo space before converting.
49 * param flags mask of SVGA_RELOC_READ / _WRITE
55 * One surface relocation is performed for texture handle.
57 *----------------------------------------------------------------------
61 surface_to_surfaceid(struct svga_winsys_context
*swc
, // IN
62 struct pipe_surface
*surface
, // IN
63 SVGA3dSurfaceImageId
*id
, // OUT
67 struct svga_surface
*s
= svga_surface(surface
);
68 swc
->surface_relocation(swc
, &id
->sid
, NULL
, s
->handle
, flags
);
69 id
->face
= s
->real_layer
; /* faces have the same order */
70 id
->mipmap
= s
->real_level
;
73 swc
->surface_relocation(swc
, &id
->sid
, NULL
, NULL
, flags
);
81 *----------------------------------------------------------------------
83 * SVGA3D_FIFOReserve --
85 * Reserve space for an SVGA3D FIFO command.
87 * The 2D SVGA commands have been around for a while, so they
88 * have a rather asymmetric structure. The SVGA3D protocol is
89 * more uniform: each command begins with a header containing the
90 * command number and the full size.
92 * This is a convenience wrapper around SVGA_FIFOReserve. We
93 * reserve space for the whole command, and write the header.
95 * This function must be paired with SVGA_FIFOCommitAll().
98 * Returns a pointer to the space reserved for command-specific
99 * data. It must be 'cmdSize' bytes long.
102 * Begins a FIFO reservation.
104 *----------------------------------------------------------------------
108 SVGA3D_FIFOReserve(struct svga_winsys_context
*swc
,
110 uint32 cmdSize
, // IN
111 uint32 nr_relocs
) // IN
113 SVGA3dCmdHeader
*header
;
115 header
= swc
->reserve(swc
, sizeof *header
+ cmdSize
, nr_relocs
);
120 header
->size
= cmdSize
;
127 SVGA_FIFOCommitAll(struct svga_winsys_context
*swc
)
134 *----------------------------------------------------------------------
136 * SVGA3D_DefineContext --
138 * Create a new context, to be referred to with the provided ID.
140 * Context objects encapsulate all render state, and shader
141 * objects are per-context.
143 * Surfaces are not per-context. The same surface can be shared
144 * between multiple contexts, and surface operations can occur
147 * If the provided context ID already existed, it is redefined.
149 * Context IDs are arbitrary small non-negative integers,
150 * global to the entire SVGA device.
158 *----------------------------------------------------------------------
162 SVGA3D_DefineContext(struct svga_winsys_context
*swc
) // IN
164 SVGA3dCmdDefineContext
*cmd
;
166 cmd
= SVGA3D_FIFOReserve(swc
,
167 SVGA_3D_CMD_CONTEXT_DEFINE
, sizeof *cmd
, 0);
169 return PIPE_ERROR_OUT_OF_MEMORY
;
180 *----------------------------------------------------------------------
182 * SVGA3D_DestroyContext --
184 * Delete a context created with SVGA3D_DefineContext.
192 *----------------------------------------------------------------------
196 SVGA3D_DestroyContext(struct svga_winsys_context
*swc
) // IN
198 SVGA3dCmdDestroyContext
*cmd
;
200 cmd
= SVGA3D_FIFOReserve(swc
,
201 SVGA_3D_CMD_CONTEXT_DESTROY
, sizeof *cmd
, 0);
203 return PIPE_ERROR_OUT_OF_MEMORY
;
214 *----------------------------------------------------------------------
216 * SVGA3D_BeginDefineSurface --
218 * Begin a SURFACE_DEFINE command. This reserves space for it in
219 * the FIFO, and returns pointers to the command's faces and
222 * This function must be paired with SVGA_FIFOCommitAll().
223 * The faces and mipSizes arrays are initialized to zero.
225 * This creates a "surface" object in the SVGA3D device,
226 * with the provided surface ID (sid). Surfaces are generic
227 * containers for host VRAM objects like textures, vertex
228 * buffers, and depth/stencil buffers.
230 * Surfaces are hierarchical:
232 * - Surface may have multiple faces (for cube maps)
234 * - Each face has a list of mipmap levels
236 * - Each mipmap image may have multiple volume
237 * slices, if the image is three dimensional.
239 * - Each slice is a 2D array of 'blocks'
241 * - Each block may be one or more pixels.
242 * (Usually 1, more for DXT or YUV formats.)
244 * Surfaces are generic host VRAM objects. The SVGA3D device
245 * may optimize surfaces according to the format they were
246 * created with, but this format does not limit the ways in
247 * which the surface may be used. For example, a depth surface
248 * can be used as a texture, or a floating point image may
249 * be used as a vertex buffer. Some surface usages may be
250 * lower performance, due to software emulation, but any
251 * usage should work with any surface.
253 * If 'sid' is already defined, the old surface is deleted
254 * and this new surface replaces it.
256 * Surface IDs are arbitrary small non-negative integers,
257 * global to the entire SVGA device.
260 * Returns pointers to arrays allocated in the FIFO for 'faces'
264 * Begins a FIFO reservation.
266 *----------------------------------------------------------------------
270 SVGA3D_BeginDefineSurface(struct svga_winsys_context
*swc
,
271 struct svga_winsys_surface
*sid
, // IN
272 SVGA3dSurfaceFlags flags
, // IN
273 SVGA3dSurfaceFormat format
, // IN
274 SVGA3dSurfaceFace
**faces
, // OUT
275 SVGA3dSize
**mipSizes
, // OUT
276 uint32 numMipSizes
) // IN
278 SVGA3dCmdDefineSurface
*cmd
;
280 cmd
= SVGA3D_FIFOReserve(swc
,
281 SVGA_3D_CMD_SURFACE_DEFINE
, sizeof *cmd
+
282 sizeof **mipSizes
* numMipSizes
, 1);
284 return PIPE_ERROR_OUT_OF_MEMORY
;
286 swc
->surface_relocation(swc
, &cmd
->sid
, NULL
, sid
,
287 SVGA_RELOC_WRITE
| SVGA_RELOC_INTERNAL
);
288 cmd
->surfaceFlags
= flags
;
289 cmd
->format
= format
;
291 *faces
= &cmd
->face
[0];
292 *mipSizes
= (SVGA3dSize
*) &cmd
[1];
294 memset(*faces
, 0, sizeof **faces
* SVGA3D_MAX_SURFACE_FACES
);
295 memset(*mipSizes
, 0, sizeof **mipSizes
* numMipSizes
);
302 *----------------------------------------------------------------------
304 * SVGA3D_DefineSurface2D --
306 * This is a simplified version of SVGA3D_BeginDefineSurface(),
307 * which does not support cube maps, mipmaps, or volume textures.
315 *----------------------------------------------------------------------
319 SVGA3D_DefineSurface2D(struct svga_winsys_context
*swc
, // IN
320 struct svga_winsys_surface
*sid
, // IN
323 SVGA3dSurfaceFormat format
) // IN
325 SVGA3dSize
*mipSizes
;
326 SVGA3dSurfaceFace
*faces
;
329 ret
= SVGA3D_BeginDefineSurface(swc
,
330 sid
, 0, format
, &faces
, &mipSizes
, 1);
334 faces
[0].numMipLevels
= 1;
336 mipSizes
[0].width
= width
;
337 mipSizes
[0].height
= height
;
338 mipSizes
[0].depth
= 1;
347 *----------------------------------------------------------------------
349 * SVGA3D_DestroySurface --
351 * Release the host VRAM encapsulated by a particular surface ID.
359 *----------------------------------------------------------------------
363 SVGA3D_DestroySurface(struct svga_winsys_context
*swc
,
364 struct svga_winsys_surface
*sid
) // IN
366 SVGA3dCmdDestroySurface
*cmd
;
368 cmd
= SVGA3D_FIFOReserve(swc
,
369 SVGA_3D_CMD_SURFACE_DESTROY
, sizeof *cmd
, 1);
371 return PIPE_ERROR_OUT_OF_MEMORY
;
373 swc
->surface_relocation(swc
, &cmd
->sid
, NULL
, sid
,
374 SVGA_RELOC_WRITE
| SVGA_RELOC_INTERNAL
);
382 *----------------------------------------------------------------------
384 * SVGA3D_SurfaceDMA--
386 * Emit a SURFACE_DMA command.
388 * When the SVGA3D device asynchronously processes this FIFO
389 * command, a DMA operation is performed between host VRAM and
390 * a generic SVGAGuestPtr. The guest pointer may refer to guest
391 * VRAM (provided by the SVGA PCI device) or to guest system
392 * memory that has been set up as a Guest Memory Region (GMR)
393 * by the SVGA device.
395 * The guest's DMA buffer must remain valid (not freed, paged out,
396 * or overwritten) until the host has finished processing this
397 * command. The guest can determine that the host has finished
398 * by using the SVGA device's FIFO Fence mechanism.
400 * The guest's image buffer can be an arbitrary size and shape.
401 * Guest image data is interpreted according to the SVGA3D surface
402 * format specified when the surface was defined.
404 * The caller may optionally define the guest image's pitch.
405 * guestImage->pitch can either be zero (assume image is tightly
406 * packed) or it must be the number of bytes between vertically
407 * adjacent image blocks.
409 * The provided copybox list specifies which regions of the source
410 * image are to be copied, and where they appear on the destination.
412 * NOTE: srcx/srcy are always on the guest image and x/y are
413 * always on the host image, regardless of the actual transfer
416 * For efficiency, the SVGA3D device is free to copy more data
417 * than specified. For example, it may round copy boxes outwards
418 * such that they lie on particular alignment boundaries.
420 *----------------------------------------------------------------------
424 SVGA3D_SurfaceDMA(struct svga_winsys_context
*swc
,
425 struct svga_transfer
*st
, // IN
426 SVGA3dTransferType transfer
, // IN
427 const SVGA3dCopyBox
*boxes
, // IN
428 uint32 numBoxes
, // IN
429 SVGA3dSurfaceDMAFlags flags
) // IN
431 struct svga_texture
*texture
= svga_texture(st
->base
.resource
);
432 SVGA3dCmdSurfaceDMA
*cmd
;
433 SVGA3dCmdSurfaceDMASuffix
*pSuffix
;
434 uint32 boxesSize
= sizeof *boxes
* numBoxes
;
435 unsigned region_flags
;
436 unsigned surface_flags
;
438 if (transfer
== SVGA3D_WRITE_HOST_VRAM
) {
439 region_flags
= SVGA_RELOC_READ
;
440 surface_flags
= SVGA_RELOC_WRITE
;
442 else if (transfer
== SVGA3D_READ_HOST_VRAM
) {
443 region_flags
= SVGA_RELOC_WRITE
;
444 surface_flags
= SVGA_RELOC_READ
;
448 return PIPE_ERROR_BAD_INPUT
;
451 cmd
= SVGA3D_FIFOReserve(swc
,
452 SVGA_3D_CMD_SURFACE_DMA
,
453 sizeof *cmd
+ boxesSize
+ sizeof *pSuffix
,
456 return PIPE_ERROR_OUT_OF_MEMORY
;
458 swc
->region_relocation(swc
, &cmd
->guest
.ptr
, st
->hwbuf
, 0, region_flags
);
459 cmd
->guest
.pitch
= st
->base
.stride
;
461 swc
->surface_relocation(swc
, &cmd
->host
.sid
, NULL
,
462 texture
->handle
, surface_flags
);
463 cmd
->host
.face
= st
->slice
; /* PIPE_TEX_FACE_* and SVGA3D_CUBEFACE_* match */
464 cmd
->host
.mipmap
= st
->base
.level
;
466 cmd
->transfer
= transfer
;
468 memcpy(&cmd
[1], boxes
, boxesSize
);
470 pSuffix
= (SVGA3dCmdSurfaceDMASuffix
*)((uint8_t*)cmd
+ sizeof *cmd
+ boxesSize
);
471 pSuffix
->suffixSize
= sizeof *pSuffix
;
472 pSuffix
->maximumOffset
= st
->hw_nblocksy
*st
->base
.stride
;
473 pSuffix
->flags
= flags
;
482 SVGA3D_BufferDMA(struct svga_winsys_context
*swc
,
483 struct svga_winsys_buffer
*guest
,
484 struct svga_winsys_surface
*host
,
485 SVGA3dTransferType transfer
, // IN
487 uint32 guest_offset
, // IN
488 uint32 host_offset
, // IN
489 SVGA3dSurfaceDMAFlags flags
) // IN
491 SVGA3dCmdSurfaceDMA
*cmd
;
493 SVGA3dCmdSurfaceDMASuffix
*pSuffix
;
494 unsigned region_flags
;
495 unsigned surface_flags
;
497 assert(!swc
->have_gb_objects
);
499 if (transfer
== SVGA3D_WRITE_HOST_VRAM
) {
500 region_flags
= SVGA_RELOC_READ
;
501 surface_flags
= SVGA_RELOC_WRITE
;
503 else if (transfer
== SVGA3D_READ_HOST_VRAM
) {
504 region_flags
= SVGA_RELOC_WRITE
;
505 surface_flags
= SVGA_RELOC_READ
;
509 return PIPE_ERROR_BAD_INPUT
;
512 cmd
= SVGA3D_FIFOReserve(swc
,
513 SVGA_3D_CMD_SURFACE_DMA
,
514 sizeof *cmd
+ sizeof *box
+ sizeof *pSuffix
,
517 return PIPE_ERROR_OUT_OF_MEMORY
;
519 swc
->region_relocation(swc
, &cmd
->guest
.ptr
, guest
, 0, region_flags
);
520 cmd
->guest
.pitch
= 0;
522 swc
->surface_relocation(swc
, &cmd
->host
.sid
,
523 NULL
, host
, surface_flags
);
525 cmd
->host
.mipmap
= 0;
527 cmd
->transfer
= transfer
;
529 box
= (SVGA3dCopyBox
*)&cmd
[1];
530 box
->x
= host_offset
;
536 box
->srcx
= guest_offset
;
540 pSuffix
= (SVGA3dCmdSurfaceDMASuffix
*)((uint8_t*)cmd
+ sizeof *cmd
+ sizeof *box
);
541 pSuffix
->suffixSize
= sizeof *pSuffix
;
542 pSuffix
->maximumOffset
= guest_offset
+ size
;
543 pSuffix
->flags
= flags
;
552 *----------------------------------------------------------------------
554 * SVGA3D_SetRenderTarget --
556 * Bind a surface object to a particular render target attachment
557 * point on the current context. Render target attachment points
558 * exist for color buffers, a depth buffer, and a stencil buffer.
560 * The SVGA3D device is quite lenient about the types of surfaces
561 * that may be used as render targets. The color buffers must
562 * all be the same size, but the depth and stencil buffers do not
563 * have to be the same size as the color buffer. All attachments
566 * Some combinations of render target formats may require software
567 * emulation, depending on the capabilities of the host graphics
568 * API and graphics hardware.
576 *----------------------------------------------------------------------
580 SVGA3D_SetRenderTarget(struct svga_winsys_context
*swc
,
581 SVGA3dRenderTargetType type
, // IN
582 struct pipe_surface
*surface
) // IN
584 SVGA3dCmdSetRenderTarget
*cmd
;
586 cmd
= SVGA3D_FIFOReserve(swc
,
587 SVGA_3D_CMD_SETRENDERTARGET
, sizeof *cmd
, 1);
589 return PIPE_ERROR_OUT_OF_MEMORY
;
593 surface_to_surfaceid(swc
, surface
, &cmd
->target
, SVGA_RELOC_WRITE
);
601 *----------------------------------------------------------------------
603 * SVGA3D_DefineShader --
605 * Upload the bytecode for a new shader. The bytecode is "SVGA3D
606 * format", which is theoretically a binary-compatible superset
607 * of Microsoft's DirectX shader bytecode. In practice, the
608 * SVGA3D bytecode doesn't yet have any extensions to DirectX's
611 * The SVGA3D device supports shader models 1.1 through 2.0.
613 * The caller chooses a shader ID (small positive integer) by
614 * which this shader will be identified in future commands. This
615 * ID is in a namespace which is per-context and per-shader-type.
617 * 'bytecodeLen' is specified in bytes. It must be a multiple of 4.
625 *----------------------------------------------------------------------
629 SVGA3D_DefineShader(struct svga_winsys_context
*swc
,
631 SVGA3dShaderType type
, // IN
632 const uint32
*bytecode
, // IN
633 uint32 bytecodeLen
) // IN
635 SVGA3dCmdDefineShader
*cmd
;
637 assert(bytecodeLen
% 4 == 0);
639 cmd
= SVGA3D_FIFOReserve(swc
,
640 SVGA_3D_CMD_SHADER_DEFINE
, sizeof *cmd
+ bytecodeLen
,
643 return PIPE_ERROR_OUT_OF_MEMORY
;
648 memcpy(&cmd
[1], bytecode
, bytecodeLen
);
656 *----------------------------------------------------------------------
658 * SVGA3D_DestroyShader --
660 * Delete a shader that was created by SVGA3D_DefineShader. If
661 * the shader was the current vertex or pixel shader for its
662 * context, rendering results are undefined until a new shader is
671 *----------------------------------------------------------------------
675 SVGA3D_DestroyShader(struct svga_winsys_context
*swc
,
677 SVGA3dShaderType type
) // IN
679 SVGA3dCmdDestroyShader
*cmd
;
681 cmd
= SVGA3D_FIFOReserve(swc
,
682 SVGA_3D_CMD_SHADER_DESTROY
, sizeof *cmd
,
685 return PIPE_ERROR_OUT_OF_MEMORY
;
697 *----------------------------------------------------------------------
699 * SVGA3D_SetShaderConst --
701 * Set the value of a shader constant.
703 * Shader constants are analogous to uniform variables in GLSL,
704 * except that they belong to the render context rather than to
705 * an individual shader.
707 * Constants may have one of three types: A 4-vector of floats,
708 * a 4-vector of integers, or a single boolean flag.
716 *----------------------------------------------------------------------
720 SVGA3D_SetShaderConst(struct svga_winsys_context
*swc
,
722 SVGA3dShaderType type
, // IN
723 SVGA3dShaderConstType ctype
, // IN
724 const void *value
) // IN
726 SVGA3dCmdSetShaderConst
*cmd
;
728 cmd
= SVGA3D_FIFOReserve(swc
,
729 SVGA_3D_CMD_SET_SHADER_CONST
, sizeof *cmd
,
732 return PIPE_ERROR_OUT_OF_MEMORY
;
741 case SVGA3D_CONST_TYPE_FLOAT
:
742 case SVGA3D_CONST_TYPE_INT
:
743 memcpy(&cmd
->values
, value
, sizeof cmd
->values
);
746 case SVGA3D_CONST_TYPE_BOOL
:
747 memset(&cmd
->values
, 0, sizeof cmd
->values
);
748 cmd
->values
[0] = *(uint32
*)value
;
763 *----------------------------------------------------------------------
765 * SVGA3D_SetShaderConsts --
767 * Set the value of successive shader constants.
769 * Shader constants are analogous to uniform variables in GLSL,
770 * except that they belong to the render context rather than to
771 * an individual shader.
773 * Constants may have one of three types: A 4-vector of floats,
774 * a 4-vector of integers, or a single boolean flag.
782 *----------------------------------------------------------------------
786 SVGA3D_SetShaderConsts(struct svga_winsys_context
*swc
,
788 uint32 numRegs
, // IN
789 SVGA3dShaderType type
, // IN
790 SVGA3dShaderConstType ctype
, // IN
791 const void *values
) // IN
793 SVGA3dCmdSetShaderConst
*cmd
;
795 cmd
= SVGA3D_FIFOReserve(swc
,
796 SVGA_3D_CMD_SET_SHADER_CONST
,
797 sizeof *cmd
+ (numRegs
- 1) * sizeof cmd
->values
,
800 return PIPE_ERROR_OUT_OF_MEMORY
;
807 memcpy(&cmd
->values
, values
, numRegs
* sizeof cmd
->values
);
819 *----------------------------------------------------------------------
821 * SVGA3D_SetShader --
823 * Switch active shaders. This binds a new vertex or pixel shader
824 * to the specified context.
826 * A shader ID of SVGA3D_INVALID_ID unbinds any shader, switching
827 * back to the fixed function vertex or pixel pipeline.
835 *----------------------------------------------------------------------
839 SVGA3D_SetShader(struct svga_winsys_context
*swc
,
840 SVGA3dShaderType type
, // IN
843 SVGA3dCmdSetShader
*cmd
;
845 assert(type
== SVGA3D_SHADERTYPE_VS
|| type
== SVGA3D_SHADERTYPE_PS
);
847 cmd
= SVGA3D_FIFOReserve(swc
,
848 SVGA_3D_CMD_SET_SHADER
, sizeof *cmd
,
851 return PIPE_ERROR_OUT_OF_MEMORY
;
863 *----------------------------------------------------------------------
865 * SVGA3D_BeginClear --
867 * Begin a CLEAR command. This reserves space for it in the FIFO,
868 * and returns a pointer to the command's rectangle array. This
869 * function must be paired with SVGA_FIFOCommitAll().
871 * Clear is a rendering operation which fills a list of
872 * rectangles with constant values on all render target types
873 * indicated by 'flags'.
875 * Clear is not affected by clipping, depth test, or other
876 * render state which affects the fragment pipeline.
882 * May write to attached render target surfaces.
884 *----------------------------------------------------------------------
888 SVGA3D_BeginClear(struct svga_winsys_context
*swc
,
889 SVGA3dClearFlag flags
, // IN
892 uint32 stencil
, // IN
893 SVGA3dRect
**rects
, // OUT
894 uint32 numRects
) // IN
898 cmd
= SVGA3D_FIFOReserve(swc
,
900 sizeof *cmd
+ sizeof **rects
* numRects
,
903 return PIPE_ERROR_OUT_OF_MEMORY
;
906 cmd
->clearFlag
= flags
;
909 cmd
->stencil
= stencil
;
910 *rects
= (SVGA3dRect
*) &cmd
[1];
917 *----------------------------------------------------------------------
919 * SVGA3D_ClearRect --
921 * This is a simplified version of SVGA3D_BeginClear().
929 *----------------------------------------------------------------------
933 SVGA3D_ClearRect(struct svga_winsys_context
*swc
,
934 SVGA3dClearFlag flags
, // IN
937 uint32 stencil
, // IN
946 ret
= SVGA3D_BeginClear(swc
, flags
, color
, depth
, stencil
, &rect
, 1);
948 return PIPE_ERROR_OUT_OF_MEMORY
;
950 memset(rect
, 0, sizeof *rect
);
962 *----------------------------------------------------------------------
964 * SVGA3D_BeginDrawPrimitives --
966 * Begin a DRAW_PRIMITIVES command. This reserves space for it in
967 * the FIFO, and returns a pointer to the command's arrays.
968 * This function must be paired with SVGA_FIFOCommitAll().
970 * Drawing commands consist of two variable-length arrays:
971 * SVGA3dVertexDecl elements declare a set of vertex buffers to
972 * use while rendering, and SVGA3dPrimitiveRange elements specify
973 * groups of primitives each with an optional index buffer.
975 * The decls and ranges arrays are initialized to zero.
981 * May write to attached render target surfaces.
983 *----------------------------------------------------------------------
987 SVGA3D_BeginDrawPrimitives(struct svga_winsys_context
*swc
,
988 SVGA3dVertexDecl
**decls
, // OUT
989 uint32 numVertexDecls
, // IN
990 SVGA3dPrimitiveRange
**ranges
, // OUT
991 uint32 numRanges
) // IN
993 SVGA3dCmdDrawPrimitives
*cmd
;
994 SVGA3dVertexDecl
*declArray
;
995 SVGA3dPrimitiveRange
*rangeArray
;
996 uint32 declSize
= sizeof **decls
* numVertexDecls
;
997 uint32 rangeSize
= sizeof **ranges
* numRanges
;
999 cmd
= SVGA3D_FIFOReserve(swc
,
1000 SVGA_3D_CMD_DRAW_PRIMITIVES
,
1001 sizeof *cmd
+ declSize
+ rangeSize
,
1002 numVertexDecls
+ numRanges
);
1004 return PIPE_ERROR_OUT_OF_MEMORY
;
1006 cmd
->cid
= swc
->cid
;
1007 cmd
->numVertexDecls
= numVertexDecls
;
1008 cmd
->numRanges
= numRanges
;
1010 declArray
= (SVGA3dVertexDecl
*) &cmd
[1];
1011 rangeArray
= (SVGA3dPrimitiveRange
*) &declArray
[numVertexDecls
];
1013 memset(declArray
, 0, declSize
);
1014 memset(rangeArray
, 0, rangeSize
);
1017 *ranges
= rangeArray
;
1024 *----------------------------------------------------------------------
1026 * SVGA3D_BeginSurfaceCopy --
1028 * Begin a SURFACE_COPY command. This reserves space for it in
1029 * the FIFO, and returns a pointer to the command's arrays. This
1030 * function must be paired with SVGA_FIFOCommitAll().
1032 * The box array is initialized with zeroes.
1038 * Asynchronously copies a list of boxes from surface to surface.
1040 *----------------------------------------------------------------------
1044 SVGA3D_BeginSurfaceCopy(struct svga_winsys_context
*swc
,
1045 struct pipe_surface
*src
, // IN
1046 struct pipe_surface
*dest
, // IN
1047 SVGA3dCopyBox
**boxes
, // OUT
1048 uint32 numBoxes
) // IN
1050 SVGA3dCmdSurfaceCopy
*cmd
;
1051 uint32 boxesSize
= sizeof **boxes
* numBoxes
;
1053 cmd
= SVGA3D_FIFOReserve(swc
,
1054 SVGA_3D_CMD_SURFACE_COPY
, sizeof *cmd
+ boxesSize
,
1057 return PIPE_ERROR_OUT_OF_MEMORY
;
1059 surface_to_surfaceid(swc
, src
, &cmd
->src
, SVGA_RELOC_READ
);
1060 surface_to_surfaceid(swc
, dest
, &cmd
->dest
, SVGA_RELOC_WRITE
);
1061 *boxes
= (SVGA3dCopyBox
*) &cmd
[1];
1063 memset(*boxes
, 0, boxesSize
);
1070 *----------------------------------------------------------------------
1072 * SVGA3D_SurfaceStretchBlt --
1074 * Issue a SURFACE_STRETCHBLT command: an asynchronous
1075 * surface-to-surface blit, with scaling.
1081 * Asynchronously copies one box from surface to surface.
1083 *----------------------------------------------------------------------
1087 SVGA3D_SurfaceStretchBlt(struct svga_winsys_context
*swc
,
1088 struct pipe_surface
*src
, // IN
1089 struct pipe_surface
*dest
, // IN
1090 SVGA3dBox
*boxSrc
, // IN
1091 SVGA3dBox
*boxDest
, // IN
1092 SVGA3dStretchBltMode mode
) // IN
1094 SVGA3dCmdSurfaceStretchBlt
*cmd
;
1096 cmd
= SVGA3D_FIFOReserve(swc
,
1097 SVGA_3D_CMD_SURFACE_STRETCHBLT
, sizeof *cmd
,
1100 return PIPE_ERROR_OUT_OF_MEMORY
;
1102 surface_to_surfaceid(swc
, src
, &cmd
->src
, SVGA_RELOC_READ
);
1103 surface_to_surfaceid(swc
, dest
, &cmd
->dest
, SVGA_RELOC_WRITE
);
1104 cmd
->boxSrc
= *boxSrc
;
1105 cmd
->boxDest
= *boxDest
;
1114 *----------------------------------------------------------------------
1116 * SVGA3D_SetViewport --
1118 * Set the current context's viewport rectangle. The viewport
1119 * is clipped to the dimensions of the current render target,
1120 * then all rendering is clipped to the viewport.
1128 *----------------------------------------------------------------------
1132 SVGA3D_SetViewport(struct svga_winsys_context
*swc
,
1133 SVGA3dRect
*rect
) // IN
1135 SVGA3dCmdSetViewport
*cmd
;
1137 cmd
= SVGA3D_FIFOReserve(swc
,
1138 SVGA_3D_CMD_SETVIEWPORT
, sizeof *cmd
,
1141 return PIPE_ERROR_OUT_OF_MEMORY
;
1143 cmd
->cid
= swc
->cid
;
1154 *----------------------------------------------------------------------
1156 * SVGA3D_SetScissorRect --
1158 * Set the current context's scissor rectangle. If scissoring
1159 * is enabled then all rendering is clipped to the scissor bounds.
1167 *----------------------------------------------------------------------
1171 SVGA3D_SetScissorRect(struct svga_winsys_context
*swc
,
1172 SVGA3dRect
*rect
) // IN
1174 SVGA3dCmdSetScissorRect
*cmd
;
1176 cmd
= SVGA3D_FIFOReserve(swc
,
1177 SVGA_3D_CMD_SETSCISSORRECT
, sizeof *cmd
,
1180 return PIPE_ERROR_OUT_OF_MEMORY
;
1182 cmd
->cid
= swc
->cid
;
1190 *----------------------------------------------------------------------
1192 * SVGA3D_SetClipPlane --
1194 * Set one of the current context's clip planes. If the clip
1195 * plane is enabled then all 3d rendering is clipped against
1204 *----------------------------------------------------------------------
1208 SVGA3D_SetClipPlane(struct svga_winsys_context
*swc
,
1209 uint32 index
, const float *plane
)
1211 SVGA3dCmdSetClipPlane
*cmd
;
1213 cmd
= SVGA3D_FIFOReserve(swc
,
1214 SVGA_3D_CMD_SETCLIPPLANE
, sizeof *cmd
,
1217 return PIPE_ERROR_OUT_OF_MEMORY
;
1219 cmd
->cid
= swc
->cid
;
1221 cmd
->plane
[0] = plane
[0];
1222 cmd
->plane
[1] = plane
[1];
1223 cmd
->plane
[2] = plane
[2];
1224 cmd
->plane
[3] = plane
[3];
1231 *----------------------------------------------------------------------
1233 * SVGA3D_SetZRange --
1235 * Set the range of the depth buffer to use. 'min' and 'max'
1236 * are values between 0.0 and 1.0.
1244 *----------------------------------------------------------------------
1248 SVGA3D_SetZRange(struct svga_winsys_context
*swc
,
1252 SVGA3dCmdSetZRange
*cmd
;
1254 cmd
= SVGA3D_FIFOReserve(swc
,
1255 SVGA_3D_CMD_SETZRANGE
, sizeof *cmd
,
1258 return PIPE_ERROR_OUT_OF_MEMORY
;
1260 cmd
->cid
= swc
->cid
;
1261 cmd
->zRange
.min
= zMin
;
1262 cmd
->zRange
.max
= zMax
;
1270 *----------------------------------------------------------------------
1272 * SVGA3D_BeginSetTextureState --
1274 * Begin a SETTEXTURESTATE command. This reserves space for it in
1275 * the FIFO, and returns a pointer to the command's texture state
1276 * array. This function must be paired with SVGA_FIFOCommitAll().
1278 * This command sets rendering state which is per-texture-unit.
1280 * XXX: Individual texture states need documentation. However,
1281 * they are very similar to the texture states defined by
1282 * Direct3D. The D3D documentation is a good starting point
1283 * for understanding SVGA3D texture states.
1291 *----------------------------------------------------------------------
1295 SVGA3D_BeginSetTextureState(struct svga_winsys_context
*swc
,
1296 SVGA3dTextureState
**states
, // OUT
1297 uint32 numStates
) // IN
1299 SVGA3dCmdSetTextureState
*cmd
;
1301 cmd
= SVGA3D_FIFOReserve(swc
,
1302 SVGA_3D_CMD_SETTEXTURESTATE
,
1303 sizeof *cmd
+ sizeof **states
* numStates
,
1306 return PIPE_ERROR_OUT_OF_MEMORY
;
1308 cmd
->cid
= swc
->cid
;
1309 *states
= (SVGA3dTextureState
*) &cmd
[1];
1316 *----------------------------------------------------------------------
1318 * SVGA3D_BeginSetRenderState --
1320 * Begin a SETRENDERSTATE command. This reserves space for it in
1321 * the FIFO, and returns a pointer to the command's texture state
1322 * array. This function must be paired with SVGA_FIFOCommitAll().
1324 * This command sets rendering state which is global to the context.
1326 * XXX: Individual render states need documentation. However,
1327 * they are very similar to the render states defined by
1328 * Direct3D. The D3D documentation is a good starting point
1329 * for understanding SVGA3D render states.
1337 *----------------------------------------------------------------------
1341 SVGA3D_BeginSetRenderState(struct svga_winsys_context
*swc
,
1342 SVGA3dRenderState
**states
, // OUT
1343 uint32 numStates
) // IN
1345 SVGA3dCmdSetRenderState
*cmd
;
1347 cmd
= SVGA3D_FIFOReserve(swc
,
1348 SVGA_3D_CMD_SETRENDERSTATE
,
1349 sizeof *cmd
+ sizeof **states
* numStates
,
1352 return PIPE_ERROR_OUT_OF_MEMORY
;
1354 cmd
->cid
= swc
->cid
;
1355 *states
= (SVGA3dRenderState
*) &cmd
[1];
1362 *----------------------------------------------------------------------
1364 * SVGA3D_BeginGBQuery--
1366 * GB resource version of SVGA3D_BeginQuery.
1372 * Commits space in the FIFO memory.
1374 *----------------------------------------------------------------------
1377 static enum pipe_error
1378 SVGA3D_BeginGBQuery(struct svga_winsys_context
*swc
,
1379 SVGA3dQueryType type
) // IN
1381 SVGA3dCmdBeginGBQuery
*cmd
;
1383 cmd
= SVGA3D_FIFOReserve(swc
,
1384 SVGA_3D_CMD_BEGIN_GB_QUERY
,
1388 return PIPE_ERROR_OUT_OF_MEMORY
;
1390 cmd
->cid
= swc
->cid
;
1400 *----------------------------------------------------------------------
1402 * SVGA3D_BeginQuery--
1404 * Issues a SVGA_3D_CMD_BEGIN_QUERY command.
1410 * Commits space in the FIFO memory.
1412 *----------------------------------------------------------------------
1416 SVGA3D_BeginQuery(struct svga_winsys_context
*swc
,
1417 SVGA3dQueryType type
) // IN
1419 SVGA3dCmdBeginQuery
*cmd
;
1421 if (swc
->have_gb_objects
)
1422 return SVGA3D_BeginGBQuery(swc
, type
);
1424 cmd
= SVGA3D_FIFOReserve(swc
,
1425 SVGA_3D_CMD_BEGIN_QUERY
,
1429 return PIPE_ERROR_OUT_OF_MEMORY
;
1431 cmd
->cid
= swc
->cid
;
1441 *----------------------------------------------------------------------
1443 * SVGA3D_EndGBQuery--
1445 * GB resource version of SVGA3D_EndQuery.
1451 * Commits space in the FIFO memory.
1453 *----------------------------------------------------------------------
1456 static enum pipe_error
1457 SVGA3D_EndGBQuery(struct svga_winsys_context
*swc
,
1458 SVGA3dQueryType type
, // IN
1459 struct svga_winsys_buffer
*buffer
) // IN/OUT
1461 SVGA3dCmdEndGBQuery
*cmd
;
1463 cmd
= SVGA3D_FIFOReserve(swc
,
1464 SVGA_3D_CMD_END_GB_QUERY
,
1468 return PIPE_ERROR_OUT_OF_MEMORY
;
1470 cmd
->cid
= swc
->cid
;
1473 swc
->mob_relocation(swc
, &cmd
->mobid
, &cmd
->offset
, buffer
,
1474 0, SVGA_RELOC_READ
| SVGA_RELOC_WRITE
);
1483 *----------------------------------------------------------------------
1487 * Issues a SVGA_3D_CMD_END_QUERY command.
1493 * Commits space in the FIFO memory.
1495 *----------------------------------------------------------------------
1499 SVGA3D_EndQuery(struct svga_winsys_context
*swc
,
1500 SVGA3dQueryType type
, // IN
1501 struct svga_winsys_buffer
*buffer
) // IN/OUT
1503 SVGA3dCmdEndQuery
*cmd
;
1505 if (swc
->have_gb_objects
)
1506 return SVGA3D_EndGBQuery(swc
, type
, buffer
);
1508 cmd
= SVGA3D_FIFOReserve(swc
,
1509 SVGA_3D_CMD_END_QUERY
,
1513 return PIPE_ERROR_OUT_OF_MEMORY
;
1515 cmd
->cid
= swc
->cid
;
1518 swc
->region_relocation(swc
, &cmd
->guestResult
, buffer
, 0,
1519 SVGA_RELOC_READ
| SVGA_RELOC_WRITE
);
1528 *----------------------------------------------------------------------
1530 * SVGA3D_WaitForGBQuery--
1532 * GB resource version of SVGA3D_WaitForQuery.
1538 * Commits space in the FIFO memory.
1540 *----------------------------------------------------------------------
1543 static enum pipe_error
1544 SVGA3D_WaitForGBQuery(struct svga_winsys_context
*swc
,
1545 SVGA3dQueryType type
, // IN
1546 struct svga_winsys_buffer
*buffer
) // IN/OUT
1548 SVGA3dCmdWaitForGBQuery
*cmd
;
1550 cmd
= SVGA3D_FIFOReserve(swc
,
1551 SVGA_3D_CMD_WAIT_FOR_GB_QUERY
,
1555 return PIPE_ERROR_OUT_OF_MEMORY
;
1557 cmd
->cid
= swc
->cid
;
1560 swc
->mob_relocation(swc
, &cmd
->mobid
, &cmd
->offset
, buffer
,
1561 0, SVGA_RELOC_READ
| SVGA_RELOC_WRITE
);
1570 *----------------------------------------------------------------------
1572 * SVGA3D_WaitForQuery--
1574 * Issues a SVGA_3D_CMD_WAIT_FOR_QUERY command. This reserves space
1575 * for it in the FIFO. This doesn't actually wait for the query to
1576 * finish but instead tells the host to start a wait at the driver
1577 * level. The caller can wait on the status variable in the
1578 * guestPtr memory or send an insert fence instruction after this
1579 * command and wait on the fence.
1585 * Commits space in the FIFO memory.
1587 *----------------------------------------------------------------------
1591 SVGA3D_WaitForQuery(struct svga_winsys_context
*swc
,
1592 SVGA3dQueryType type
, // IN
1593 struct svga_winsys_buffer
*buffer
) // IN/OUT
1595 SVGA3dCmdWaitForQuery
*cmd
;
1597 if (swc
->have_gb_objects
)
1598 return SVGA3D_WaitForGBQuery(swc
, type
, buffer
);
1600 cmd
= SVGA3D_FIFOReserve(swc
,
1601 SVGA_3D_CMD_WAIT_FOR_QUERY
,
1605 return PIPE_ERROR_OUT_OF_MEMORY
;
1607 cmd
->cid
= swc
->cid
;
1610 swc
->region_relocation(swc
, &cmd
->guestResult
, buffer
, 0,
1611 SVGA_RELOC_READ
| SVGA_RELOC_WRITE
);
1620 SVGA3D_BindGBShader(struct svga_winsys_context
*swc
,
1621 struct svga_winsys_gb_shader
*gbshader
)
1623 SVGA3dCmdBindGBShader
*cmd
=
1624 SVGA3D_FIFOReserve(swc
,
1625 SVGA_3D_CMD_BIND_GB_SHADER
,
1627 2); /* two relocations */
1630 return PIPE_ERROR_OUT_OF_MEMORY
;
1632 swc
->shader_relocation(swc
, &cmd
->shid
, &cmd
->mobid
,
1633 &cmd
->offsetInBytes
, gbshader
, 0);
1642 SVGA3D_SetGBShader(struct svga_winsys_context
*swc
,
1643 SVGA3dShaderType type
, // IN
1644 struct svga_winsys_gb_shader
*gbshader
)
1646 SVGA3dCmdSetShader
*cmd
;
1648 assert(type
== SVGA3D_SHADERTYPE_VS
|| type
== SVGA3D_SHADERTYPE_PS
);
1650 cmd
= SVGA3D_FIFOReserve(swc
,
1651 SVGA_3D_CMD_SET_SHADER
,
1653 2); /* two relocations */
1655 return PIPE_ERROR_OUT_OF_MEMORY
;
1657 cmd
->cid
= swc
->cid
;
1660 swc
->shader_relocation(swc
, &cmd
->shid
, NULL
, NULL
, gbshader
, 0);
1662 cmd
->shid
= SVGA_ID_INVALID
;
1670 * \param flags mask of SVGA_RELOC_READ / _WRITE
1673 SVGA3D_BindGBSurface(struct svga_winsys_context
*swc
,
1674 struct svga_winsys_surface
*surface
)
1676 SVGA3dCmdBindGBSurface
*cmd
=
1677 SVGA3D_FIFOReserve(swc
,
1678 SVGA_3D_CMD_BIND_GB_SURFACE
,
1680 2); /* two relocations */
1683 return PIPE_ERROR_OUT_OF_MEMORY
;
1685 swc
->surface_relocation(swc
, &cmd
->sid
, &cmd
->mobid
, surface
,
1686 SVGA_RELOC_READ
| SVGA_RELOC_INTERNAL
);
1695 * Update an image in a guest-backed surface.
1696 * (Inform the device that the guest-contents have been updated.)
1699 SVGA3D_UpdateGBImage(struct svga_winsys_context
*swc
,
1700 struct svga_winsys_surface
*surface
,
1701 const SVGA3dBox
*box
,
1702 unsigned face
, unsigned mipLevel
)
1705 SVGA3dCmdUpdateGBImage
*cmd
=
1706 SVGA3D_FIFOReserve(swc
,
1707 SVGA_3D_CMD_UPDATE_GB_IMAGE
,
1709 1); /* one relocation */
1712 return PIPE_ERROR_OUT_OF_MEMORY
;
1714 swc
->surface_relocation(swc
, &cmd
->image
.sid
, NULL
, surface
,
1715 SVGA_RELOC_WRITE
| SVGA_RELOC_INTERNAL
);
1716 cmd
->image
.face
= face
;
1717 cmd
->image
.mipmap
= mipLevel
;
1727 * Update an entire guest-backed surface.
1728 * (Inform the device that the guest-contents have been updated.)
1731 SVGA3D_UpdateGBSurface(struct svga_winsys_context
*swc
,
1732 struct svga_winsys_surface
*surface
)
1734 SVGA3dCmdUpdateGBSurface
*cmd
=
1735 SVGA3D_FIFOReserve(swc
,
1736 SVGA_3D_CMD_UPDATE_GB_SURFACE
,
1738 1); /* one relocation */
1741 return PIPE_ERROR_OUT_OF_MEMORY
;
1743 swc
->surface_relocation(swc
, &cmd
->sid
, NULL
, surface
,
1744 SVGA_RELOC_WRITE
| SVGA_RELOC_INTERNAL
);
1753 * Readback an image in a guest-backed surface.
1754 * (Request the device to flush the dirty contents into the guest.)
1757 SVGA3D_ReadbackGBImage(struct svga_winsys_context
*swc
,
1758 struct svga_winsys_surface
*surface
,
1759 unsigned face
, unsigned mipLevel
)
1761 SVGA3dCmdReadbackGBImage
*cmd
=
1762 SVGA3D_FIFOReserve(swc
,
1763 SVGA_3D_CMD_READBACK_GB_IMAGE
,
1765 1); /* one relocation */
1768 return PIPE_ERROR_OUT_OF_MEMORY
;
1770 swc
->surface_relocation(swc
, &cmd
->image
.sid
, NULL
, surface
,
1771 SVGA_RELOC_READ
| SVGA_RELOC_INTERNAL
);
1772 cmd
->image
.face
= face
;
1773 cmd
->image
.mipmap
= mipLevel
;
1782 * Readback an entire guest-backed surface.
1783 * (Request the device to flush the dirty contents into the guest.)
1786 SVGA3D_ReadbackGBSurface(struct svga_winsys_context
*swc
,
1787 struct svga_winsys_surface
*surface
)
1789 SVGA3dCmdReadbackGBSurface
*cmd
=
1790 SVGA3D_FIFOReserve(swc
,
1791 SVGA_3D_CMD_READBACK_GB_SURFACE
,
1793 1); /* one relocation */
1796 return PIPE_ERROR_OUT_OF_MEMORY
;
1798 swc
->surface_relocation(swc
, &cmd
->sid
, NULL
, surface
,
1799 SVGA_RELOC_READ
| SVGA_RELOC_INTERNAL
);
1808 SVGA3D_ReadbackGBImagePartial(struct svga_winsys_context
*swc
,
1809 struct svga_winsys_surface
*surface
,
1810 unsigned face
, unsigned mipLevel
,
1811 const SVGA3dBox
*box
,
1814 SVGA3dCmdReadbackGBImagePartial
*cmd
=
1815 SVGA3D_FIFOReserve(swc
,
1816 SVGA_3D_CMD_READBACK_GB_IMAGE_PARTIAL
,
1818 1); /* one relocation */
1820 return PIPE_ERROR_OUT_OF_MEMORY
;
1822 swc
->surface_relocation(swc
, &cmd
->image
.sid
, NULL
, surface
,
1823 SVGA_RELOC_READ
| SVGA_RELOC_INTERNAL
);
1824 cmd
->image
.face
= face
;
1825 cmd
->image
.mipmap
= mipLevel
;
1827 cmd
->invertBox
= invertBox
;
1836 SVGA3D_InvalidateGBImagePartial(struct svga_winsys_context
*swc
,
1837 struct svga_winsys_surface
*surface
,
1838 unsigned face
, unsigned mipLevel
,
1839 const SVGA3dBox
*box
,
1842 SVGA3dCmdInvalidateGBImagePartial
*cmd
=
1843 SVGA3D_FIFOReserve(swc
,
1844 SVGA_3D_CMD_INVALIDATE_GB_IMAGE_PARTIAL
,
1846 1); /* one relocation */
1848 return PIPE_ERROR_OUT_OF_MEMORY
;
1850 swc
->surface_relocation(swc
, &cmd
->image
.sid
, NULL
, surface
,
1851 SVGA_RELOC_READ
| SVGA_RELOC_INTERNAL
);
1852 cmd
->image
.face
= face
;
1853 cmd
->image
.mipmap
= mipLevel
;
1855 cmd
->invertBox
= invertBox
;
1864 SVGA3D_SetGBShaderConstsInline(struct svga_winsys_context
*swc
,
1867 SVGA3dShaderType shaderType
,
1868 SVGA3dShaderConstType constType
,
1871 SVGA3dCmdSetGBShaderConstInline
*cmd
;
1873 assert(numRegs
> 0);
1875 cmd
= SVGA3D_FIFOReserve(swc
,
1876 SVGA_3D_CMD_SET_GB_SHADERCONSTS_INLINE
,
1877 sizeof *cmd
+ numRegs
* sizeof(float[4]),
1878 0); /* no relocations */
1880 return PIPE_ERROR_OUT_OF_MEMORY
;
1882 cmd
->cid
= swc
->cid
;
1883 cmd
->regStart
= regStart
;
1884 cmd
->shaderType
= shaderType
;
1885 cmd
->constType
= constType
;
1887 memcpy(&cmd
[1], values
, numRegs
* sizeof(float[4]));