VBoxVideo.h@ 23002

Last change on this file since 23002 was 22920, checked in by vboxsync, 15 years ago
Video hw accel: fallback for PBO allocation failure
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 28.1 KB

Line
1	/** @file
2	* VirtualBox Video interface.
3	*/
4
5	/*
6	* Copyright (C) 2006 Sun Microsystems, Inc.
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*
25	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26	* Clara, CA 95054 USA or visit http://www.sun.com if you need
27	* additional information or have any questions.
28	*/
29
30	#ifndef ___VBox_VBoxVideo_h
31	#define ___VBox_VBoxVideo_h
32
33	#include <iprt/cdefs.h>
34	#include <iprt/types.h>
35
36	#ifdef VBOX_WITH_HGSMI
37	#include <VBox/VMMDev.h>
38	#endif /* VBOX_WITH_HGSMI */
39
40	/*
41	* The last 4096 bytes of the guest VRAM contains the generic info for all
42	* DualView chunks: sizes and offsets of chunks. This is filled by miniport.
43	*
44	* Last 4096 bytes of each chunk contain chunk specific data: framebuffer info,
45	* etc. This is used exclusively by the corresponding instance of a display driver.
46	*
47	* The VRAM layout:
48	* Last 4096 bytes - Adapter information area.
49	* 4096 bytes aligned miniport heap (value specified in the config rouded up).
50	* Slack - what left after dividing the VRAM.
51	* 4096 bytes aligned framebuffers:
52	* last 4096 bytes of each framebuffer is the display information area.
53	*
54	* The Virtual Graphics Adapter information in the guest VRAM is stored by the
55	* guest video driver using structures prepended by VBOXVIDEOINFOHDR.
56	*
57	* When the guest driver writes dword 0 to the VBE_DISPI_INDEX_VBOX_VIDEO
58	* the host starts to process the info. The first element at the start of
59	* the 4096 bytes region should be normally be a LINK that points to
60	* actual information chain. That way the guest driver can have some
61	* fixed layout of the information memory block and just rewrite
62	* the link to point to relevant memory chain.
63	*
64	* The processing stops at the END element.
65	*
66	* The host can access the memory only when the port IO is processed.
67	* All data that will be needed later must be copied from these 4096 bytes.
68	* But other VRAM can be used by host until the mode is disabled.
69	*
70	* The guest driver writes dword 0xffffffff to the VBE_DISPI_INDEX_VBOX_VIDEO
71	* to disable the mode.
72	*
73	* VBE_DISPI_INDEX_VBOX_VIDEO is used to read the configuration information
74	* from the host and issue commands to the host.
75	*
76	* The guest writes the VBE_DISPI_INDEX_VBOX_VIDEO index register, the the
77	* following operations with the VBE data register can be performed:
78	*
79	* Operation Result
80	* write 16 bit value NOP
81	* read 16 bit value count of monitors
82	* write 32 bit value sets the vbox command value and the command processed by the host
83	* read 32 bit value result of the last vbox command is returned
84	*/
85
86	#define VBOX_VIDEO_PRIMARY_SCREEN 0
87	#define VBOX_VIDEO_NO_SCREEN ~0
88
89	#define VBOX_VIDEO_MAX_SCREENS 64
90
91	/* The size of the information. */
92	#ifndef VBOX_WITH_HGSMI
93	#define VBOX_VIDEO_ADAPTER_INFORMATION_SIZE 4096
94	#define VBOX_VIDEO_DISPLAY_INFORMATION_SIZE 4096
95	#else
96	/*
97	* The minimum HGSMI heap size is PAGE_SIZE (4096 bytes) and is a restriction of the
98	* runtime heapsimple API. Use minimum 2 pages here, because the info area also may
99	* contain other data (for example HGSMIHOSTFLAGS structure).
100	*/
101	#define VBVA_ADAPTER_INFORMATION_SIZE (8*_1K)
102	#define VBVA_DISPLAY_INFORMATION_SIZE (8*_1K)
103	#define VBVA_MIN_BUFFER_SIZE (64*_1K)
104	#endif /* VBOX_WITH_HGSMI */
105
106
107	/* The value for port IO to let the adapter to interpret the adapter memory. */
108	#define VBOX_VIDEO_DISABLE_ADAPTER_MEMORY 0xFFFFFFFF
109
110	/* The value for port IO to let the adapter to interpret the adapter memory. */
111	#define VBOX_VIDEO_INTERPRET_ADAPTER_MEMORY 0x00000000
112
113	/* The value for port IO to let the adapter to interpret the display memory.
114	* The display number is encoded in low 16 bits.
115	*/
116	#define VBOX_VIDEO_INTERPRET_DISPLAY_MEMORY_BASE 0x00010000
117
118
119	/* The end of the information. */
120	#define VBOX_VIDEO_INFO_TYPE_END 0
121	/* Instructs the host to fetch the next VBOXVIDEOINFOHDR at the given offset of VRAM. */
122	#define VBOX_VIDEO_INFO_TYPE_LINK 1
123	/* Information about a display memory position. */
124	#define VBOX_VIDEO_INFO_TYPE_DISPLAY 2
125	/* Information about a screen. */
126	#define VBOX_VIDEO_INFO_TYPE_SCREEN 3
127	/* Information about host notifications for the driver. */
128	#define VBOX_VIDEO_INFO_TYPE_HOST_EVENTS 4
129	/* Information about non-volatile guest VRAM heap. */
130	#define VBOX_VIDEO_INFO_TYPE_NV_HEAP 5
131	/* VBVA enable/disable. */
132	#define VBOX_VIDEO_INFO_TYPE_VBVA_STATUS 6
133	/* VBVA flush. */
134	#define VBOX_VIDEO_INFO_TYPE_VBVA_FLUSH 7
135	/* Query configuration value. */
136	#define VBOX_VIDEO_INFO_TYPE_QUERY_CONF32 8
137
138
139	#pragma pack(1)
140	typedef struct _VBOXVIDEOINFOHDR
141	{
142	uint8_t u8Type;
143	uint8_t u8Reserved;
144	uint16_t u16Length;
145	} VBOXVIDEOINFOHDR;
146
147
148	typedef struct _VBOXVIDEOINFOLINK
149	{
150	/* Relative offset in VRAM */
151	int32_t i32Offset;
152	} VBOXVIDEOINFOLINK;
153
154
155	/* Resides in adapter info memory. Describes a display VRAM chunk. */
156	typedef struct _VBOXVIDEOINFODISPLAY
157	{
158	/* Index of the framebuffer assigned by guest. */
159	uint32_t u32Index;
160
161	/* Absolute offset in VRAM of the framebuffer to be displayed on the monitor. */
162	uint32_t u32Offset;
163
164	/* The size of the memory that can be used for the screen. */
165	uint32_t u32FramebufferSize;
166
167	/* The size of the memory that is used for the Display information.
168	* The information is at u32Offset + u32FramebufferSize
169	*/
170	uint32_t u32InformationSize;
171
172	} VBOXVIDEOINFODISPLAY;
173
174
175	/* Resides in display info area, describes the current video mode. */
176	#define VBOX_VIDEO_INFO_SCREEN_F_NONE 0x00
177	#define VBOX_VIDEO_INFO_SCREEN_F_ACTIVE 0x01
178
179	typedef struct _VBOXVIDEOINFOSCREEN
180	{
181	/* Physical X origin relative to the primary screen. */
182	int32_t xOrigin;
183
184	/* Physical Y origin relative to the primary screen. */
185	int32_t yOrigin;
186
187	/* The scan line size in bytes. */
188	uint32_t u32LineSize;
189
190	/* Width of the screen. */
191	uint16_t u16Width;
192
193	/* Height of the screen. */
194	uint16_t u16Height;
195
196	/* Color depth. */
197	uint8_t bitsPerPixel;
198
199	/* VBOX_VIDEO_INFO_SCREEN_F_* */
200	uint8_t u8Flags;
201	} VBOXVIDEOINFOSCREEN;
202
203	/* The guest initializes the structure to 0. The positions of the structure in the
204	* display info area must not be changed, host will update the structure. Guest checks
205	* the events and modifies the structure as a response to host.
206	*/
207	#define VBOX_VIDEO_INFO_HOST_EVENTS_F_NONE 0x00000000
208	#define VBOX_VIDEO_INFO_HOST_EVENTS_F_VRDP_RESET 0x00000080
209
210	typedef struct _VBOXVIDEOINFOHOSTEVENTS
211	{
212	/* Host events. */
213	uint32_t fu32Events;
214	} VBOXVIDEOINFOHOSTEVENTS;
215
216	/* Resides in adapter info memory. Describes the non-volatile VRAM heap. */
217	typedef struct _VBOXVIDEOINFONVHEAP
218	{
219	/* Absolute offset in VRAM of the start of the heap. */
220	uint32_t u32HeapOffset;
221
222	/* The size of the heap. */
223	uint32_t u32HeapSize;
224
225	} VBOXVIDEOINFONVHEAP;
226
227	/* Display information area. */
228	typedef struct _VBOXVIDEOINFOVBVASTATUS
229	{
230	/* Absolute offset in VRAM of the start of the VBVA QUEUE. 0 to disable VBVA. */
231	uint32_t u32QueueOffset;
232
233	/* The size of the VBVA QUEUE. 0 to disable VBVA. */
234	uint32_t u32QueueSize;
235
236	} VBOXVIDEOINFOVBVASTATUS;
237
238	typedef struct _VBOXVIDEOINFOVBVAFLUSH
239	{
240	uint32_t u32DataStart;
241
242	uint32_t u32DataEnd;
243
244	} VBOXVIDEOINFOVBVAFLUSH;
245
246	#define VBOX_VIDEO_QCI32_MONITOR_COUNT 0
247	#define VBOX_VIDEO_QCI32_OFFSCREEN_HEAP_SIZE 1
248
249	typedef struct _VBOXVIDEOINFOQUERYCONF32
250	{
251	uint32_t u32Index;
252
253	uint32_t u32Value;
254
255	} VBOXVIDEOINFOQUERYCONF32;
256	#pragma pack()
257
258	# ifdef VBOX_WITH_VIDEOHWACCEL
259	#pragma pack(1)
260
261	#define VBOXVHWA_VERSION_MAJ 0
262	#define VBOXVHWA_VERSION_MIN 0
263	#define VBOXVHWA_VERSION_BLD 3
264	#define VBOXVHWA_VERSION_RSV 0
265
266	typedef enum
267	{
268	VBOXVHWACMD_TYPE_SURF_CANCREATE = 1,
269	VBOXVHWACMD_TYPE_SURF_CREATE,
270	VBOXVHWACMD_TYPE_SURF_DESTROY,
271	VBOXVHWACMD_TYPE_SURF_LOCK,
272	VBOXVHWACMD_TYPE_SURF_UNLOCK,
273	VBOXVHWACMD_TYPE_SURF_BLT,
274	VBOXVHWACMD_TYPE_SURF_FLIP,
275	VBOXVHWACMD_TYPE_SURF_OVERLAY_UPDATE,
276	VBOXVHWACMD_TYPE_SURF_OVERLAY_SETPOSITION,
277	VBOXVHWACMD_TYPE_SURF_COLORKEY_SET,
278	VBOXVHWACMD_TYPE_QUERY_INFO1,
279	VBOXVHWACMD_TYPE_QUERY_INFO2,
280	VBOXVHWACMD_TYPE_ENABLE,
281	VBOXVHWACMD_TYPE_DISABLE,
282	VBOXVHWACMD_TYPE_HH_CONSTRUCT
283	} VBOXVHWACMD_TYPE;
284
285	/* the command processing was asynch, set by the host to indicate asynch command completion
286	* must not be cleared once set, the command completion is performed by issuing a host->guest completion command
287	* while keeping this flag unchanged */
288	#define VBOXVHWACMD_FLAG_HG_ASYNCH 0x00010000
289	/* asynch completion is performed by issuing the event */
290	#define VBOXVHWACMD_FLAG_GH_ASYNCH_EVENT 0x00000001
291	/* issue interrupt on asynch completion */
292	#define VBOXVHWACMD_FLAG_GH_ASYNCH_IRQ 0x00000002
293	/* guest does not do any op on completion of this command, the host may copy the command and indicate that it does not need the command anymore
294	* by setting the VBOXVHWACMD_FLAG_HG_ASYNCH_RETURNED flag */
295	#define VBOXVHWACMD_FLAG_GH_ASYNCH_NOCOMPLETION 0x00000004
296	/* the host has copied the VBOXVHWACMD_FLAG_GH_ASYNCH_NOCOMPLETION command and returned it to the guest */
297	#define VBOXVHWACMD_FLAG_HG_ASYNCH_RETURNED 0x00020000
298	/* this is the host->host cmd, i.e. a configuration command posted by the host to the framebuffer */
299	#define VBOXVHWACMD_FLAG_HH_CMD 0x10000000
300
301	typedef struct _VBOXVHWACMD
302	{
303	VBOXVHWACMD_TYPE enmCmd; /* command type */
304	volatile int32_t rc; /* command result */
305	int32_t iDisplay; /* display index */
306	volatile int32_t Flags; /* ored VBOXVHWACMD_FLAG_xxx values */
307	uint64_t GuestVBVAReserved1; /* field internally used by the guest VBVA cmd handling, must NOT be modified by clients */
308	uint64_t GuestVBVAReserved2; /* field internally used by the guest VBVA cmd handling, must NOT be modified by clients */
309	volatile uint32_t cRefs;
310	int32_t Reserved;
311	union
312	{
313	struct _VBOXVHWACMD *pNext;
314	uint32_t offNext;
315	uint64_t Data; /* the body is 64-bit aligned */
316	} u;
317	char body[1];
318	} VBOXVHWACMD;
319
320	#define VBOXVHWACMD_HEADSIZE() (RT_OFFSETOF(VBOXVHWACMD, body))
321	#define VBOXVHWACMD_SIZE(_tCmd) (VBOXVHWACMD_HEADSIZE() + sizeof(_tCmd))
322	typedef unsigned int VBOXVHWACMD_LENGTH;
323	typedef uint64_t VBOXVHWA_SURFHANDLE;
324	#define VBOXVHWA_SURFHANDLE_INVALID 0
325	#define VBOXVHWACMD_BODY(_p, _t) ((_t*)(_p)->body)
326	#define VBOXVHWACMD_HEAD(_pb) ((VBOXVHWACMD)((uint8_t )(_pb) - RT_OFFSETOF(VBOXVHWACMD, body)))
327
328	typedef struct _VBOXVHWA_RECTL
329	{
330	int32_t left;
331	int32_t top;
332	int32_t right;
333	int32_t bottom;
334	} VBOXVHWA_RECTL;
335
336	typedef struct _VBOXVHWA_COLORKEY
337	{
338	uint32_t low;
339	uint32_t high;
340	} VBOXVHWA_COLORKEY;
341
342	typedef struct _VBOXVHWA_PIXELFORMAT
343	{
344	uint32_t flags;
345	uint32_t fourCC;
346	union
347	{
348	uint32_t rgbBitCount;
349	uint32_t yuvBitCount;
350	} c;
351
352	union
353	{
354	uint32_t rgbRBitMask;
355	uint32_t yuvYBitMask;
356	} m1;
357
358	union
359	{
360	uint32_t rgbGBitMask;
361	uint32_t yuvUBitMask;
362	} m2;
363
364	union
365	{
366	uint32_t rgbBBitMask;
367	uint32_t yuvVBitMask;
368	} m3;
369
370	union
371	{
372	uint32_t rgbABitMask;
373	} m4;
374	} VBOXVHWA_PIXELFORMAT;
375
376	typedef struct _VBOXVHWA_SURFACEDESC
377	{
378	uint32_t flags;
379	uint32_t height;
380	uint32_t width;
381	uint32_t pitch;
382	uint32_t sizeX;
383	uint32_t sizeY;
384	uint32_t cBackBuffers;
385	uint32_t Reserved;
386	VBOXVHWA_COLORKEY DstOverlayCK;
387	VBOXVHWA_COLORKEY DstBltCK;
388	VBOXVHWA_COLORKEY SrcOverlayCK;
389	VBOXVHWA_COLORKEY SrcBltCK;
390	VBOXVHWA_PIXELFORMAT PixelFormat;
391	uint32_t surfCaps;
392	uint32_t Reserved2;
393	VBOXVHWA_SURFHANDLE hSurf;
394	uint64_t offSurface;
395	} VBOXVHWA_SURFACEDESC;
396
397	typedef struct _VBOXVHWA_BLTFX
398	{
399	uint32_t flags;
400	uint32_t rop;
401	uint32_t rotationOp;
402	uint32_t rotation;
403	uint32_t fillColor;
404	uint32_t Reserved;
405	VBOXVHWA_COLORKEY DstCK;
406	VBOXVHWA_COLORKEY SrcCK;
407	} VBOXVHWA_BLTFX;
408
409	typedef struct _VBOXVHWA_OVERLAYFX
410	{
411	uint32_t flags;
412	uint32_t Reserved1;
413	uint32_t fxFlags;
414	uint32_t Reserved2;
415	VBOXVHWA_COLORKEY DstCK;
416	VBOXVHWA_COLORKEY SrcCK;
417	} VBOXVHWA_OVERLAYFX;
418
419	#define VBOXVHWA_CAPS_BLT 0x00000001
420	#define VBOXVHWA_CAPS_BLTCOLORFILL 0x00000002
421	#define VBOXVHWA_CAPS_BLTFOURCC 0x00000004
422	#define VBOXVHWA_CAPS_BLTSTRETCH 0x00000008
423	#define VBOXVHWA_CAPS_BLTQUEUE 0x00000010
424
425	#define VBOXVHWA_CAPS_OVERLAY 0x00000100
426	#define VBOXVHWA_CAPS_OVERLAYFOURCC 0x00000200
427	#define VBOXVHWA_CAPS_OVERLAYSTRETCH 0x00000400
428	#define VBOXVHWA_CAPS_OVERLAYCANTCLIP 0x00000800
429
430	#define VBOXVHWA_CAPS_COLORKEY 0x00010000
431	#define VBOXVHWA_CAPS_COLORKEYHWASSIST 0x00020000
432
433
434	#define VBOXVHWA_SCAPS_FLIP 0x00000001
435	#define VBOXVHWA_SCAPS_PRIMARYSURFACE 0x00000002
436	#define VBOXVHWA_SCAPS_OFFSCREENPLAIN 0x00000004
437	#define VBOXVHWA_SCAPS_OVERLAY 0x00000008
438	#define VBOXVHWA_SCAPS_VISIBLE 0x00000010
439	#define VBOXVHWA_SCAPS_VIDEOMEMORY 0x00000020
440	#define VBOXVHWA_SCAPS_LOCALVIDMEM 0x00000040
441	#define VBOXVHWA_SCAPS_COMPLEX 0x00000080
442
443
444	#define VBOXVHWA_PF_RGB 0x00000001
445	#define VBOXVHWA_PF_RGBTOYUV 0x00000002
446	#define VBOXVHWA_PF_YUV 0x00000008
447	#define VBOXVHWA_PF_FOURCC 0x00000010
448
449	#define VBOXVHWA_LOCK_DISCARDCONTENTS 0x00000001
450
451	#define VBOXVHWA_CFG_ENABLED 0x00000001
452
453	#define VBOXVHWA_SD_BACKBUFFERCOUNT 0x00000001
454	#define VBOXVHWA_SD_CAPS 0x00000002
455	#define VBOXVHWA_SD_CKDESTBLT 0x00000004
456	#define VBOXVHWA_SD_CKDESTOVERLAY 0x00000008
457	#define VBOXVHWA_SD_CKSRCBLT 0x00000010
458	#define VBOXVHWA_SD_CKSRCOVERLAY 0x00000020
459	#define VBOXVHWA_SD_HEIGHT 0x00000040
460	#define VBOXVHWA_SD_PITCH 0x00000080
461	#define VBOXVHWA_SD_PIXELFORMAT 0x00000100
462	//#define VBOXVHWA_SD_REFRESHRATE 0x00000200
463	#define VBOXVHWA_SD_WIDTH 0x00000400
464
465	#define VBOXVHWA_CKEYCAPS_DESTBLT 0x00000001
466	#define VBOXVHWA_CKEYCAPS_DESTBLTCLRSPACE 0x00000002
467	#define VBOXVHWA_CKEYCAPS_DESTBLTCLRSPACEYUV 0x00000004
468	#define VBOXVHWA_CKEYCAPS_DESTBLTYUV 0x00000008
469	#define VBOXVHWA_CKEYCAPS_DESTOVERLAY 0x00000010
470	#define VBOXVHWA_CKEYCAPS_DESTOVERLAYCLRSPACE 0x00000020
471	#define VBOXVHWA_CKEYCAPS_DESTOVERLAYCLRSPACEYUV 0x00000040
472	#define VBOXVHWA_CKEYCAPS_DESTOVERLAYONEACTIVE 0x00000080
473	#define VBOXVHWA_CKEYCAPS_DESTOVERLAYYUV 0x00000100
474	#define VBOXVHWA_CKEYCAPS_NOCOSTOVERLAY 0x00000200
475	#define VBOXVHWA_CKEYCAPS_SRCBLT 0x00000400
476	#define VBOXVHWA_CKEYCAPS_SRCBLTCLRSPACE 0x00000800
477	#define VBOXVHWA_CKEYCAPS_SRCBLTCLRSPACEYUV 0x00001000
478	#define VBOXVHWA_CKEYCAPS_SRCBLTYUV 0x00002000
479	#define VBOXVHWA_CKEYCAPS_SRCOVERLAY 0x00004000
480	#define VBOXVHWA_CKEYCAPS_SRCOVERLAYCLRSPACE 0x00008000
481	#define VBOXVHWA_CKEYCAPS_SRCOVERLAYCLRSPACEYUV 0x00010000
482	#define VBOXVHWA_CKEYCAPS_SRCOVERLAYONEACTIVE 0x00020000
483	#define VBOXVHWA_CKEYCAPS_SRCOVERLAYYUV 0x00040000
484
485
486	#define VBOXVHWA_BLT_COLORFILL 0x00000400
487	#define VBOXVHWA_BLT_DDFX 0x00000800
488	#define VBOXVHWA_BLT_EXTENDED_FLAGS 0x40000000
489	#define VBOXVHWA_BLT_EXTENDED_LINEAR_CONTENT 0x00000004
490	#define VBOXVHWA_BLT_EXTENDED_PRESENTATION_STRETCHFACTOR 0x00000010
491	#define VBOXVHWA_BLT_KEYDESTOVERRIDE 0x00004000
492	#define VBOXVHWA_BLT_KEYSRCOVERRIDE 0x00010000
493	#define VBOXVHWA_BLT_LAST_PRESENTATION 0x20000000
494	#define VBOXVHWA_BLT_PRESENTATION 0x10000000
495	#define VBOXVHWA_BLT_ROP 0x00020000
496
497
498	#define VBOXVHWA_OVER_DDFX 0x00080000
499	#define VBOXVHWA_OVER_HIDE 0x00000200
500	#define VBOXVHWA_OVER_KEYDEST 0x00000400
501	#define VBOXVHWA_OVER_KEYDESTOVERRIDE 0x00000800
502	#define VBOXVHWA_OVER_KEYSRC 0x00001000
503	#define VBOXVHWA_OVER_KEYSRCOVERRIDE 0x00002000
504	#define VBOXVHWA_OVER_SHOW 0x00004000
505
506	#define VBOXVHWA_CKEY_COLORSPACE 0x00000001
507	#define VBOXVHWA_CKEY_DESTBLT 0x00000002
508	#define VBOXVHWA_CKEY_DESTOVERLAY 0x00000004
509	#define VBOXVHWA_CKEY_SRCBLT 0x00000008
510	#define VBOXVHWA_CKEY_SRCOVERLAY 0x00000010
511
512	#define VBOXVHWA_BLT_ARITHSTRETCHY 0x00000001
513	#define VBOXVHWA_BLT_MIRRORLEFTRIGHT 0x00000002
514	#define VBOXVHWA_BLT_MIRRORUPDOWN 0x00000004
515
516	#define VBOXVHWA_OVERFX_ARITHSTRETCHY 0x00000001
517	#define VBOXVHWA_OVERFX_MIRRORLEFTRIGHT 0x00000002
518	#define VBOXVHWA_OVERFX_MIRRORUPDOWN 0x00000004
519
520	#define VBOXVHWA_CAPS2_CANRENDERWINDOWED 0x00080000
521	#define VBOXVHWA_CAPS2_WIDESURFACES 0x00001000
522	#define VBOXVHWA_CAPS2_COPYFOURCC 0x00008000
523	//#define VBOXVHWA_CAPS2_FLIPINTERVAL 0x00200000
524	//#define VBOXVHWA_CAPS2_FLIPNOVSYNC 0x00400000
525
526
527	#define VBOXVHWA_OFFSET64_VOID (UINT64_MAX)
528
529	typedef struct _VBOXVHWA_VERSION
530	{
531	uint32_t maj;
532	uint32_t min;
533	uint32_t bld;
534	uint32_t reserved;
535	} VBOXVHWA_VERSION;
536
537	typedef struct _VBOXVHWACMD_QUERYINFO1
538	{
539	union
540	{
541	struct
542	{
543	VBOXVHWA_VERSION guestVersion;
544	} in;
545
546	struct
547	{
548	uint32_t cfgFlags;
549	uint32_t caps;
550
551	uint32_t caps2;
552	uint32_t colorKeyCaps;
553
554	uint32_t stretchCaps;
555	uint32_t surfaceCaps;
556
557	uint32_t numOverlays;
558	uint32_t curOverlays;
559
560	uint32_t numFourCC;
561	uint32_t reserved;
562	} out;
563	} u;
564	} VBOXVHWACMD_QUERYINFO1;
565
566	typedef struct _VBOXVHWACMD_QUERYINFO2
567	{
568	uint32_t numFourCC;
569	uint32_t FourCC[1];
570	} VBOXVHWACMD_QUERYINFO2;
571
572	#define VBOXVHWAINFO2_SIZE(_cFourCC) RT_OFFSETOF(VBOXVHWACMD_QUERYINFO2, FourCC[_cFourCC])
573
574	typedef struct _VBOXVHWACMD_SURF_CANCREATE
575	{
576	VBOXVHWA_SURFACEDESC SurfInfo;
577	union
578	{
579	struct
580	{
581	uint32_t bIsDifferentPixelFormat;
582	uint32_t Reserved;
583	} in;
584
585	struct
586	{
587	int32_t ErrInfo;
588	} out;
589	} u;
590	} VBOXVHWACMD_SURF_CANCREATE;
591
592	typedef struct _VBOXVHWACMD_SURF_CREATE
593	{
594	VBOXVHWA_SURFACEDESC SurfInfo;
595	} VBOXVHWACMD_SURF_CREATE;
596
597	typedef struct _VBOXVHWACMD_SURF_DESTROY
598	{
599	union
600	{
601	struct
602	{
603	VBOXVHWA_SURFHANDLE hSurf;
604	} in;
605	} u;
606	} VBOXVHWACMD_SURF_DESTROY;
607
608	typedef struct _VBOXVHWACMD_SURF_LOCK
609	{
610	union
611	{
612	struct
613	{
614	VBOXVHWA_SURFHANDLE hSurf;
615	uint64_t offSurface;
616	uint32_t flags;
617	uint32_t rectValid;
618	VBOXVHWA_RECTL rect;
619	} in;
620	} u;
621	} VBOXVHWACMD_SURF_LOCK;
622
623	typedef struct _VBOXVHWACMD_SURF_UNLOCK
624	{
625	union
626	{
627	struct
628	{
629	VBOXVHWA_SURFHANDLE hSurf;
630	uint32_t xUpdatedMemValid;
631	uint32_t reserved;
632	VBOXVHWA_RECTL xUpdatedMemRect;
633	} in;
634	} u;
635	} VBOXVHWACMD_SURF_UNLOCK;
636
637	typedef struct _VBOXVHWACMD_SURF_BLT
638	{
639	uint64_t DstGuestSurfInfo;
640	uint64_t SrcGuestSurfInfo;
641	union
642	{
643	struct
644	{
645	VBOXVHWA_SURFHANDLE hDstSurf;
646	uint64_t offDstSurface;
647	VBOXVHWA_RECTL dstRect;
648	VBOXVHWA_SURFHANDLE hSrcSurf;
649	uint64_t offSrcSurface;
650	VBOXVHWA_RECTL srcRect;
651	uint32_t flags;
652	uint32_t xUpdatedSrcMemValid;
653	VBOXVHWA_BLTFX desc;
654	VBOXVHWA_RECTL xUpdatedSrcMemRect;
655	} in;
656	} u;
657	} VBOXVHWACMD_SURF_BLT;
658
659	typedef struct _VBOXVHWACMD_SURF_FLIP
660	{
661	uint64_t TargGuestSurfInfo;
662	uint64_t CurrGuestSurfInfo;
663	union
664	{
665	struct
666	{
667	VBOXVHWA_SURFHANDLE hTargSurf;
668	uint64_t offTargSurface;
669	VBOXVHWA_SURFHANDLE hCurrSurf;
670	uint64_t offCurrSurface;
671	uint32_t flags;
672	uint32_t xUpdatedTargMemValid;
673	VBOXVHWA_RECTL xUpdatedTargMemRect;
674	} in;
675	} u;
676	} VBOXVHWACMD_SURF_FLIP;
677
678	typedef struct _VBOXVHWACMD_SURF_COLORKEY_SET
679	{
680	union
681	{
682	struct
683	{
684	VBOXVHWA_SURFHANDLE hSurf;
685	uint64_t offSurface;
686	VBOXVHWA_COLORKEY CKey;
687	uint32_t flags;
688	uint32_t reserved;
689	} in;
690	} u;
691	} VBOXVHWACMD_SURF_COLORKEY_SET;
692
693	typedef struct _VBOXVHWACMD_SURF_OVERLAY_UPDATE
694	{
695	union
696	{
697	struct
698	{
699	VBOXVHWA_SURFHANDLE hDstSurf;
700	uint64_t offDstSurface;
701	VBOXVHWA_RECTL dstRect;
702	VBOXVHWA_SURFHANDLE hSrcSurf;
703	uint64_t offSrcSurface;
704	VBOXVHWA_RECTL srcRect;
705	uint32_t flags;
706	uint32_t xUpdatedSrcMemValid;
707	VBOXVHWA_OVERLAYFX desc;
708	VBOXVHWA_RECTL xUpdatedSrcMemRect;
709	} in;
710	} u;
711	}VBOXVHWACMD_SURF_OVERLAY_UPDATE;
712
713	typedef struct _VBOXVHWACMD_SURF_OVERLAY_SETPOSITION
714	{
715	union
716	{
717	struct
718	{
719	VBOXVHWA_SURFHANDLE hDstSurf;
720	uint64_t offDstSurface;
721	VBOXVHWA_SURFHANDLE hSrcSurf;
722	uint64_t offSrcSurface;
723	uint32_t xPos;
724	uint32_t yPos;
725	uint32_t flags;
726	uint32_t reserved;
727	} in;
728	} u;
729	} VBOXVHWACMD_SURF_OVERLAY_SETPOSITION;
730
731	typedef struct _VBOXVHWACMD_HH_CONSTRUCT
732	{
733	void * pVM;
734	} VBOXVHWACMD_HH_CONSTRUCT;
735
736	#pragma pack()
737	# endif /* #ifdef VBOX_WITH_VIDEOHWACCEL */
738
739	#ifdef VBOX_WITH_HGSMI
740
741	/* All structures are without alignment. */
742	#pragma pack(1)
743
744	typedef struct _VBVABUFFER
745	{
746	uint32_t u32HostEvents;
747	uint32_t u32SupportedOrders;
748
749	/* The offset where the data start in the buffer. */
750	uint32_t off32Data;
751	/* The offset where next data must be placed in the buffer. */
752	uint32_t off32Free;
753
754	/* The queue of record descriptions. */
755	VBVARECORD aRecords[VBVA_MAX_RECORDS];
756	uint32_t indexRecordFirst;
757	uint32_t indexRecordFree;
758
759	/* Space to leave free in the buffer when large partial records are transferred. */
760	uint32_t cbPartialWriteThreshold;
761
762	uint32_t cbData;
763	uint8_t au8Data[1]; /* variable size for the rest of the VBVABUFFER area in VRAM. */
764	} VBVABUFFER;
765
766	/* guest->host commands */
767	#define VBVA_QUERY_CONF32 1
768	#define VBVA_SET_CONF32 2
769	#define VBVA_INFO_VIEW 3
770	#define VBVA_INFO_HEAP 4
771	#define VBVA_FLUSH 5
772	#define VBVA_INFO_SCREEN 6
773	#define VBVA_ENABLE 7
774	#define VBVA_MOUSE_POINTER_SHAPE 8
775	#ifdef VBOX_WITH_VIDEOHWACCEL
776	# define VBVA_VHWA_CMD 9
777	#endif /* # ifdef VBOX_WITH_VIDEOHWACCEL */
778
779	/* host->guest commands */
780	# define VBVAHG_EVENT 1
781	# define VBVAHG_DISPLAY_CUSTOM 2
782
783	# ifdef VBOX_WITH_VIDEOHWACCEL
784	#define VBVAHG_DCUSTOM_VHWA_CMDCOMPLETE 1
785	#pragma pack(1)
786	typedef struct _VBVAHOSTCMDVHWACMDCOMPLETE
787	{
788	uint32_t offCmd;
789	}VBVAHOSTCMDVHWACMDCOMPLETE;
790	#pragma pack()
791	# endif /* # ifdef VBOX_WITH_VIDEOHWACCEL */
792
793	#pragma pack(1)
794	typedef enum
795	{
796	VBVAHOSTCMD_OP_EVENT = 1,
797	VBVAHOSTCMD_OP_CUSTOM
798	}VBVAHOSTCMD_OP_TYPE;
799
800	typedef struct _VBVAHOSTCMDEVENT
801	{
802	uint64_t pEvent;
803	}VBVAHOSTCMDEVENT;
804
805
806	typedef struct _VBVAHOSTCMD
807	{
808	/* destination ID if >=0 specifies display index, otherwize the command is directed to the miniport */
809	int32_t iDstID;
810	int32_t customOpCode;
811	union
812	{
813	struct _VBVAHOSTCMD *pNext;
814	uint32_t offNext;
815	uint64_t Data; /* the body is 64-bit aligned */
816	} u;
817	char body[1];
818	}VBVAHOSTCMD;
819
820	#define VBVAHOSTCMD_SIZE(_size) (sizeof(VBVAHOSTCMD) + (_size))
821	#define VBVAHOSTCMD_BODY(_pCmd, _tBody) ((_tBody*)(_pCmd)->body)
822	#define VBVAHOSTCMD_HDR(_pBody) ((VBVAHOSTCMD)(((uint8_t)_pBody) - RT_OFFSETOF(VBVAHOSTCMD, body)))
823	#define VBVAHOSTCMD_HDRSIZE (RT_OFFSETOF(VBVAHOSTCMD, body))
824
825	#pragma pack()
826
827	/* VBVACONF32::u32Index */
828	#define VBOX_VBVA_CONF32_MONITOR_COUNT 0
829	#define VBOX_VBVA_CONF32_HOST_HEAP_SIZE 1
830
831	typedef struct _VBVACONF32
832	{
833	uint32_t u32Index;
834	uint32_t u32Value;
835	} VBVACONF32;
836
837	typedef struct VBVAINFOVIEW
838	{
839	/* Index of the screen, assigned by the guest. */
840	uint32_t u32ViewIndex;
841
842	/* The screen offset in VRAM, the framebuffer starts here. */
843	uint32_t u32ViewOffset;
844
845	/* The size of the VRAM memory that can be used for the view. */
846	uint32_t u32ViewSize;
847
848	/* The recommended maximum size of the VRAM memory for the screen. */
849	uint32_t u32MaxScreenSize;
850	} VBVAINFOVIEW;
851
852	typedef struct _VBVAINFOHEAP
853	{
854	/* Absolute offset in VRAM of the start of the heap. */
855	uint32_t u32HeapOffset;
856
857	/* The size of the heap. */
858	uint32_t u32HeapSize;
859
860	} VBVAINFOHEAP;
861
862	typedef struct _VBVAFLUSH
863	{
864	uint32_t u32Reserved;
865
866	} VBVAFLUSH;
867
868	/* VBVAINFOSCREEN::u8Flags */
869	#define VBVA_SCREEN_F_NONE 0x0000
870	#define VBVA_SCREEN_F_ACTIVE 0x0001
871
872	typedef struct VBVAINFOSCREEN
873	{
874	/* Which view contains the screen. */
875	uint32_t u32ViewIndex;
876
877	/* Physical X origin relative to the primary screen. */
878	int32_t i32OriginX;
879
880	/* Physical Y origin relative to the primary screen. */
881	int32_t i32OriginY;
882
883	/* Offset of visible framebuffer relative to the framebuffer start. */
884	uint32_t u32StartOffset;
885
886	/* The scan line size in bytes. */
887	uint32_t u32LineSize;
888
889	/* Width of the screen. */
890	uint32_t u32Width;
891
892	/* Height of the screen. */
893	uint32_t u32Height;
894
895	/* Color depth. */
896	uint16_t u16BitsPerPixel;
897
898	/* VBVA_SCREEN_F_* */
899	uint16_t u16Flags;
900	} VBVAINFOSCREEN;
901
902
903	/* VBVAENABLE::u32Flags */
904	#define VBVA_F_NONE 0x00000000
905	#define VBVA_F_ENABLE 0x00000001
906	#define VBVA_F_DISABLE 0x00000002
907
908	typedef struct _VBVAENABLE
909	{
910	uint32_t u32Flags;
911	uint32_t u32Offset;
912	int32_t i32Result;
913
914	} VBVAENABLE;
915
916	typedef struct _VBVAMOUSEPOINTERSHAPE
917	{
918	/* The host result. */
919	int32_t i32Result;
920
921	/* VBOX_MOUSE_POINTER_* bit flags. */
922	uint32_t fu32Flags;
923
924	/* X coordinate of the hot spot. */
925	uint32_t u32HotX;
926
927	/* Y coordinate of the hot spot. */
928	uint32_t u32HotY;
929
930	/* Width of the pointer in pixels. */
931	uint32_t u32Width;
932
933	/* Height of the pointer in scanlines. */
934	uint32_t u32Height;
935
936	/* Pointer data.
937	*
938	****
939	* The data consists of 1 bpp AND mask followed by 32 bpp XOR (color) mask.
940	*
941	* For pointers without alpha channel the XOR mask pixels are 32 bit values: (lsb)BGR0(msb).
942	* For pointers with alpha channel the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
943	*
944	* Guest driver must create the AND mask for pointers with alpha channel, so if host does not
945	* support alpha, the pointer could be displayed as a normal color pointer. The AND mask can
946	* be constructed from alpha values. For example alpha value >= 0xf0 means bit 0 in the AND mask.
947	*
948	* The AND mask is 1 bpp bitmap with byte aligned scanlines. Size of AND mask,
949	* therefore, is cbAnd = (width + 7) / 8 * height. The padding bits at the
950	* end of any scanline are undefined.
951	*
952	* The XOR mask follows the AND mask on the next 4 bytes aligned offset:
953	* uint8_t *pXor = pAnd + (cbAnd + 3) & ~3
954	* Bytes in the gap between the AND and the XOR mask are undefined.
955	* XOR mask scanlines have no gap between them and size of XOR mask is:
956	* cXor = width * 4 * height.
957	****
958	*
959	* Preallocate 4 bytes for accessing actual data as p->au8Data.
960	*/
961	uint8_t au8Data[4];
962
963	} VBVAMOUSEPOINTERSHAPE;
964
965	#pragma pack()
966
967	#endif /* VBOX_WITH_HGSMI */
968
969	#endif

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/VBox/VBoxVideo.h@ 23002

Download in other formats: