VBoxVideo.h@ 21490

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

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

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

Download in other formats: