VirtualBox

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

Last change on this file since 47680 was 44529, checked in by vboxsync, 12 years ago

header (C) fixes
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 44.3 KB
Line 
1/** @file
2 * VirtualBox Video interface.
3 */
4
5/*
6 * Copyright (C) 2006-2012 Oracle Corporation
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
26#ifndef ___VBox_VBoxVideo_h
27#define ___VBox_VBoxVideo_h
28
29#include <VBox/VMMDev.h>
30#include <VBox/Hardware/VBoxVideoVBE.h>
31
32#include <iprt/cdefs.h>
33#include <iprt/types.h>
34
35/*
36 * The last 4096 bytes of the guest VRAM contains the generic info for all
37 * DualView chunks: sizes and offsets of chunks. This is filled by miniport.
38 *
39 * Last 4096 bytes of each chunk contain chunk specific data: framebuffer info,
40 * etc. This is used exclusively by the corresponding instance of a display driver.
41 *
42 * The VRAM layout:
43 * Last 4096 bytes - Adapter information area.
44 * 4096 bytes aligned miniport heap (value specified in the config rouded up).
45 * Slack - what left after dividing the VRAM.
46 * 4096 bytes aligned framebuffers:
47 * last 4096 bytes of each framebuffer is the display information area.
48 *
49 * The Virtual Graphics Adapter information in the guest VRAM is stored by the
50 * guest video driver using structures prepended by VBOXVIDEOINFOHDR.
51 *
52 * When the guest driver writes dword 0 to the VBE_DISPI_INDEX_VBOX_VIDEO
53 * the host starts to process the info. The first element at the start of
54 * the 4096 bytes region should be normally be a LINK that points to
55 * actual information chain. That way the guest driver can have some
56 * fixed layout of the information memory block and just rewrite
57 * the link to point to relevant memory chain.
58 *
59 * The processing stops at the END element.
60 *
61 * The host can access the memory only when the port IO is processed.
62 * All data that will be needed later must be copied from these 4096 bytes.
63 * But other VRAM can be used by host until the mode is disabled.
64 *
65 * The guest driver writes dword 0xffffffff to the VBE_DISPI_INDEX_VBOX_VIDEO
66 * to disable the mode.
67 *
68 * VBE_DISPI_INDEX_VBOX_VIDEO is used to read the configuration information
69 * from the host and issue commands to the host.
70 *
71 * The guest writes the VBE_DISPI_INDEX_VBOX_VIDEO index register, the the
72 * following operations with the VBE data register can be performed:
73 *
74 * Operation Result
75 * write 16 bit value NOP
76 * read 16 bit value count of monitors
77 * write 32 bit value sets the vbox command value and the command processed by the host
78 * read 32 bit value result of the last vbox command is returned
79 */
80
81#define VBOX_VIDEO_PRIMARY_SCREEN 0
82#define VBOX_VIDEO_NO_SCREEN ~0
83
84/* The size of the information. */
85/*
86 * The minimum HGSMI heap size is PAGE_SIZE (4096 bytes) and is a restriction of the
87 * runtime heapsimple API. Use minimum 2 pages here, because the info area also may
88 * contain other data (for example HGSMIHOSTFLAGS structure).
89 */
90#ifndef VBOX_XPDM_MINIPORT
91# define VBVA_ADAPTER_INFORMATION_SIZE (64*_1K)
92#else
93#define VBVA_ADAPTER_INFORMATION_SIZE (16*_1K)
94#define VBVA_DISPLAY_INFORMATION_SIZE (64*_1K)
95#endif
96#define VBVA_MIN_BUFFER_SIZE (64*_1K)
97
98
99/* The value for port IO to let the adapter to interpret the adapter memory. */
100#define VBOX_VIDEO_DISABLE_ADAPTER_MEMORY 0xFFFFFFFF
101
102/* The value for port IO to let the adapter to interpret the adapter memory. */
103#define VBOX_VIDEO_INTERPRET_ADAPTER_MEMORY 0x00000000
104
105/* The value for port IO to let the adapter to interpret the display memory.
106 * The display number is encoded in low 16 bits.
107 */
108#define VBOX_VIDEO_INTERPRET_DISPLAY_MEMORY_BASE 0x00010000
109
110
111/* The end of the information. */
112#define VBOX_VIDEO_INFO_TYPE_END 0
113/* Instructs the host to fetch the next VBOXVIDEOINFOHDR at the given offset of VRAM. */
114#define VBOX_VIDEO_INFO_TYPE_LINK 1
115/* Information about a display memory position. */
116#define VBOX_VIDEO_INFO_TYPE_DISPLAY 2
117/* Information about a screen. */
118#define VBOX_VIDEO_INFO_TYPE_SCREEN 3
119/* Information about host notifications for the driver. */
120#define VBOX_VIDEO_INFO_TYPE_HOST_EVENTS 4
121/* Information about non-volatile guest VRAM heap. */
122#define VBOX_VIDEO_INFO_TYPE_NV_HEAP 5
123/* VBVA enable/disable. */
124#define VBOX_VIDEO_INFO_TYPE_VBVA_STATUS 6
125/* VBVA flush. */
126#define VBOX_VIDEO_INFO_TYPE_VBVA_FLUSH 7
127/* Query configuration value. */
128#define VBOX_VIDEO_INFO_TYPE_QUERY_CONF32 8
129
130
131#pragma pack(1)
132typedef struct VBOXVIDEOINFOHDR
133{
134 uint8_t u8Type;
135 uint8_t u8Reserved;
136 uint16_t u16Length;
137} VBOXVIDEOINFOHDR;
138
139
140typedef struct VBOXVIDEOINFOLINK
141{
142 /* Relative offset in VRAM */
143 int32_t i32Offset;
144} VBOXVIDEOINFOLINK;
145
146
147/* Resides in adapter info memory. Describes a display VRAM chunk. */
148typedef struct VBOXVIDEOINFODISPLAY
149{
150 /* Index of the framebuffer assigned by guest. */
151 uint32_t u32Index;
152
153 /* Absolute offset in VRAM of the framebuffer to be displayed on the monitor. */
154 uint32_t u32Offset;
155
156 /* The size of the memory that can be used for the screen. */
157 uint32_t u32FramebufferSize;
158
159 /* The size of the memory that is used for the Display information.
160 * The information is at u32Offset + u32FramebufferSize
161 */
162 uint32_t u32InformationSize;
163
164} VBOXVIDEOINFODISPLAY;
165
166
167/* Resides in display info area, describes the current video mode. */
168#define VBOX_VIDEO_INFO_SCREEN_F_NONE 0x00
169#define VBOX_VIDEO_INFO_SCREEN_F_ACTIVE 0x01
170
171typedef struct VBOXVIDEOINFOSCREEN
172{
173 /* Physical X origin relative to the primary screen. */
174 int32_t xOrigin;
175
176 /* Physical Y origin relative to the primary screen. */
177 int32_t yOrigin;
178
179 /* The scan line size in bytes. */
180 uint32_t u32LineSize;
181
182 /* Width of the screen. */
183 uint16_t u16Width;
184
185 /* Height of the screen. */
186 uint16_t u16Height;
187
188 /* Color depth. */
189 uint8_t bitsPerPixel;
190
191 /* VBOX_VIDEO_INFO_SCREEN_F_* */
192 uint8_t u8Flags;
193} VBOXVIDEOINFOSCREEN;
194
195/* The guest initializes the structure to 0. The positions of the structure in the
196 * display info area must not be changed, host will update the structure. Guest checks
197 * the events and modifies the structure as a response to host.
198 */
199#define VBOX_VIDEO_INFO_HOST_EVENTS_F_NONE 0x00000000
200#define VBOX_VIDEO_INFO_HOST_EVENTS_F_VRDP_RESET 0x00000080
201
202typedef struct VBOXVIDEOINFOHOSTEVENTS
203{
204 /* Host events. */
205 uint32_t fu32Events;
206} VBOXVIDEOINFOHOSTEVENTS;
207
208/* Resides in adapter info memory. Describes the non-volatile VRAM heap. */
209typedef struct VBOXVIDEOINFONVHEAP
210{
211 /* Absolute offset in VRAM of the start of the heap. */
212 uint32_t u32HeapOffset;
213
214 /* The size of the heap. */
215 uint32_t u32HeapSize;
216
217} VBOXVIDEOINFONVHEAP;
218
219/* Display information area. */
220typedef struct VBOXVIDEOINFOVBVASTATUS
221{
222 /* Absolute offset in VRAM of the start of the VBVA QUEUE. 0 to disable VBVA. */
223 uint32_t u32QueueOffset;
224
225 /* The size of the VBVA QUEUE. 0 to disable VBVA. */
226 uint32_t u32QueueSize;
227
228} VBOXVIDEOINFOVBVASTATUS;
229
230typedef struct VBOXVIDEOINFOVBVAFLUSH
231{
232 uint32_t u32DataStart;
233
234 uint32_t u32DataEnd;
235
236} VBOXVIDEOINFOVBVAFLUSH;
237
238#define VBOX_VIDEO_QCI32_MONITOR_COUNT 0
239#define VBOX_VIDEO_QCI32_OFFSCREEN_HEAP_SIZE 1
240
241typedef struct VBOXVIDEOINFOQUERYCONF32
242{
243 uint32_t u32Index;
244
245 uint32_t u32Value;
246
247} VBOXVIDEOINFOQUERYCONF32;
248#pragma pack()
249
250#ifdef VBOX_WITH_VIDEOHWACCEL
251#pragma pack(1)
252
253#define VBOXVHWA_VERSION_MAJ 0
254#define VBOXVHWA_VERSION_MIN 0
255#define VBOXVHWA_VERSION_BLD 6
256#define VBOXVHWA_VERSION_RSV 0
257
258typedef enum
259{
260 VBOXVHWACMD_TYPE_SURF_CANCREATE = 1,
261 VBOXVHWACMD_TYPE_SURF_CREATE,
262 VBOXVHWACMD_TYPE_SURF_DESTROY,
263 VBOXVHWACMD_TYPE_SURF_LOCK,
264 VBOXVHWACMD_TYPE_SURF_UNLOCK,
265 VBOXVHWACMD_TYPE_SURF_BLT,
266 VBOXVHWACMD_TYPE_SURF_FLIP,
267 VBOXVHWACMD_TYPE_SURF_OVERLAY_UPDATE,
268 VBOXVHWACMD_TYPE_SURF_OVERLAY_SETPOSITION,
269 VBOXVHWACMD_TYPE_SURF_COLORKEY_SET,
270 VBOXVHWACMD_TYPE_QUERY_INFO1,
271 VBOXVHWACMD_TYPE_QUERY_INFO2,
272 VBOXVHWACMD_TYPE_ENABLE,
273 VBOXVHWACMD_TYPE_DISABLE,
274 VBOXVHWACMD_TYPE_HH_CONSTRUCT,
275 VBOXVHWACMD_TYPE_HH_RESET
276#ifdef VBOX_WITH_WDDM
277 , VBOXVHWACMD_TYPE_SURF_GETINFO
278 , VBOXVHWACMD_TYPE_SURF_COLORFILL
279#endif
280 , VBOXVHWACMD_TYPE_HH_DISABLE
281 , VBOXVHWACMD_TYPE_HH_ENABLE
282 , VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEBEGIN
283 , VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEEND
284 , VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEPERFORM
285 , VBOXVHWACMD_TYPE_HH_SAVESTATE_LOADPERFORM
286} VBOXVHWACMD_TYPE;
287
288/* the command processing was asynch, set by the host to indicate asynch command completion
289 * must not be cleared once set, the command completion is performed by issuing a host->guest completion command
290 * while keeping this flag unchanged */
291#define VBOXVHWACMD_FLAG_HG_ASYNCH 0x00010000
292/* asynch completion is performed by issuing the event */
293#define VBOXVHWACMD_FLAG_GH_ASYNCH_EVENT 0x00000001
294/* issue interrupt on asynch completion */
295#define VBOXVHWACMD_FLAG_GH_ASYNCH_IRQ 0x00000002
296/* 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
297 * by setting the VBOXVHWACMD_FLAG_HG_ASYNCH_RETURNED flag */
298#define VBOXVHWACMD_FLAG_GH_ASYNCH_NOCOMPLETION 0x00000004
299/* the host has copied the VBOXVHWACMD_FLAG_GH_ASYNCH_NOCOMPLETION command and returned it to the guest */
300#define VBOXVHWACMD_FLAG_HG_ASYNCH_RETURNED 0x00020000
301/* this is the host->host cmd, i.e. a configuration command posted by the host to the framebuffer */
302#define VBOXVHWACMD_FLAG_HH_CMD 0x10000000
303
304typedef struct VBOXVHWACMD
305{
306 VBOXVHWACMD_TYPE enmCmd; /* command type */
307 volatile int32_t rc; /* command result */
308 int32_t iDisplay; /* display index */
309 volatile int32_t Flags; /* ored VBOXVHWACMD_FLAG_xxx values */
310 uint64_t GuestVBVAReserved1; /* field internally used by the guest VBVA cmd handling, must NOT be modified by clients */
311 uint64_t GuestVBVAReserved2; /* field internally used by the guest VBVA cmd handling, must NOT be modified by clients */
312 volatile uint32_t cRefs;
313 int32_t Reserved;
314 union
315 {
316 struct VBOXVHWACMD *pNext;
317 uint32_t offNext;
318 uint64_t Data; /* the body is 64-bit aligned */
319 } u;
320 char body[1];
321} VBOXVHWACMD;
322
323#define VBOXVHWACMD_HEADSIZE() (RT_OFFSETOF(VBOXVHWACMD, body))
324#define VBOXVHWACMD_SIZE_FROMBODYSIZE(_s) (VBOXVHWACMD_HEADSIZE() + (_s))
325#define VBOXVHWACMD_SIZE(_tCmd) (VBOXVHWACMD_SIZE_FROMBODYSIZE(sizeof(_tCmd)))
326typedef unsigned int VBOXVHWACMD_LENGTH;
327typedef uint64_t VBOXVHWA_SURFHANDLE;
328#define VBOXVHWA_SURFHANDLE_INVALID 0ULL
329#define VBOXVHWACMD_BODY(_p, _t) ((_t*)(_p)->body)
330#define VBOXVHWACMD_HEAD(_pb) ((VBOXVHWACMD*)((uint8_t *)(_pb) - RT_OFFSETOF(VBOXVHWACMD, body)))
331
332typedef struct VBOXVHWA_RECTL
333{
334 int32_t left;
335 int32_t top;
336 int32_t right;
337 int32_t bottom;
338} VBOXVHWA_RECTL;
339
340typedef struct VBOXVHWA_COLORKEY
341{
342 uint32_t low;
343 uint32_t high;
344} VBOXVHWA_COLORKEY;
345
346typedef struct VBOXVHWA_PIXELFORMAT
347{
348 uint32_t flags;
349 uint32_t fourCC;
350 union
351 {
352 uint32_t rgbBitCount;
353 uint32_t yuvBitCount;
354 } c;
355
356 union
357 {
358 uint32_t rgbRBitMask;
359 uint32_t yuvYBitMask;
360 } m1;
361
362 union
363 {
364 uint32_t rgbGBitMask;
365 uint32_t yuvUBitMask;
366 } m2;
367
368 union
369 {
370 uint32_t rgbBBitMask;
371 uint32_t yuvVBitMask;
372 } m3;
373
374 union
375 {
376 uint32_t rgbABitMask;
377 } m4;
378
379 uint32_t Reserved;
380} VBOXVHWA_PIXELFORMAT;
381
382typedef struct VBOXVHWA_SURFACEDESC
383{
384 uint32_t flags;
385 uint32_t height;
386 uint32_t width;
387 uint32_t pitch;
388 uint32_t sizeX;
389 uint32_t sizeY;
390 uint32_t cBackBuffers;
391 uint32_t Reserved;
392 VBOXVHWA_COLORKEY DstOverlayCK;
393 VBOXVHWA_COLORKEY DstBltCK;
394 VBOXVHWA_COLORKEY SrcOverlayCK;
395 VBOXVHWA_COLORKEY SrcBltCK;
396 VBOXVHWA_PIXELFORMAT PixelFormat;
397 uint32_t surfCaps;
398 uint32_t Reserved2;
399 VBOXVHWA_SURFHANDLE hSurf;
400 uint64_t offSurface;
401} VBOXVHWA_SURFACEDESC;
402
403typedef struct VBOXVHWA_BLTFX
404{
405 uint32_t flags;
406 uint32_t rop;
407 uint32_t rotationOp;
408 uint32_t rotation;
409 uint32_t fillColor;
410 uint32_t Reserved;
411 VBOXVHWA_COLORKEY DstCK;
412 VBOXVHWA_COLORKEY SrcCK;
413} VBOXVHWA_BLTFX;
414
415typedef struct VBOXVHWA_OVERLAYFX
416{
417 uint32_t flags;
418 uint32_t Reserved1;
419 uint32_t fxFlags;
420 uint32_t Reserved2;
421 VBOXVHWA_COLORKEY DstCK;
422 VBOXVHWA_COLORKEY SrcCK;
423} VBOXVHWA_OVERLAYFX;
424
425#define VBOXVHWA_CAPS_BLT 0x00000040
426#define VBOXVHWA_CAPS_BLTCOLORFILL 0x04000000
427#define VBOXVHWA_CAPS_BLTFOURCC 0x00000100
428#define VBOXVHWA_CAPS_BLTSTRETCH 0x00000200
429#define VBOXVHWA_CAPS_BLTQUEUE 0x00000080
430
431#define VBOXVHWA_CAPS_OVERLAY 0x00000800
432#define VBOXVHWA_CAPS_OVERLAYFOURCC 0x00002000
433#define VBOXVHWA_CAPS_OVERLAYSTRETCH 0x00004000
434#define VBOXVHWA_CAPS_OVERLAYCANTCLIP 0x00001000
435
436#define VBOXVHWA_CAPS_COLORKEY 0x00400000
437#define VBOXVHWA_CAPS_COLORKEYHWASSIST 0x01000000
438
439#define VBOXVHWA_SCAPS_BACKBUFFER 0x00000004
440#define VBOXVHWA_SCAPS_COMPLEX 0x00000008
441#define VBOXVHWA_SCAPS_FLIP 0x00000010
442#define VBOXVHWA_SCAPS_FRONTBUFFER 0x00000020
443#define VBOXVHWA_SCAPS_OFFSCREENPLAIN 0x00000040
444#define VBOXVHWA_SCAPS_OVERLAY 0x00000080
445#define VBOXVHWA_SCAPS_PRIMARYSURFACE 0x00000200
446#define VBOXVHWA_SCAPS_SYSTEMMEMORY 0x00000800
447#define VBOXVHWA_SCAPS_VIDEOMEMORY 0x00004000
448#define VBOXVHWA_SCAPS_VISIBLE 0x00008000
449#define VBOXVHWA_SCAPS_LOCALVIDMEM 0x10000000
450
451#define VBOXVHWA_PF_PALETTEINDEXED8 0x00000020
452#define VBOXVHWA_PF_RGB 0x00000040
453#define VBOXVHWA_PF_RGBTOYUV 0x00000100
454#define VBOXVHWA_PF_YUV 0x00000200
455#define VBOXVHWA_PF_FOURCC 0x00000004
456
457#define VBOXVHWA_LOCK_DISCARDCONTENTS 0x00002000
458
459#define VBOXVHWA_CFG_ENABLED 0x00000001
460
461#define VBOXVHWA_SD_BACKBUFFERCOUNT 0x00000020
462#define VBOXVHWA_SD_CAPS 0x00000001
463#define VBOXVHWA_SD_CKDESTBLT 0x00004000
464#define VBOXVHWA_SD_CKDESTOVERLAY 0x00002000
465#define VBOXVHWA_SD_CKSRCBLT 0x00010000
466#define VBOXVHWA_SD_CKSRCOVERLAY 0x00008000
467#define VBOXVHWA_SD_HEIGHT 0x00000002
468#define VBOXVHWA_SD_PITCH 0x00000008
469#define VBOXVHWA_SD_PIXELFORMAT 0x00001000
470/*#define VBOXVHWA_SD_REFRESHRATE 0x00040000*/
471#define VBOXVHWA_SD_WIDTH 0x00000004
472
473#define VBOXVHWA_CKEYCAPS_DESTBLT 0x00000001
474#define VBOXVHWA_CKEYCAPS_DESTBLTCLRSPACE 0x00000002
475#define VBOXVHWA_CKEYCAPS_DESTBLTCLRSPACEYUV 0x00000004
476#define VBOXVHWA_CKEYCAPS_DESTBLTYUV 0x00000008
477#define VBOXVHWA_CKEYCAPS_DESTOVERLAY 0x00000010
478#define VBOXVHWA_CKEYCAPS_DESTOVERLAYCLRSPACE 0x00000020
479#define VBOXVHWA_CKEYCAPS_DESTOVERLAYCLRSPACEYUV 0x00000040
480#define VBOXVHWA_CKEYCAPS_DESTOVERLAYONEACTIVE 0x00000080
481#define VBOXVHWA_CKEYCAPS_DESTOVERLAYYUV 0x00000100
482#define VBOXVHWA_CKEYCAPS_SRCBLT 0x00000200
483#define VBOXVHWA_CKEYCAPS_SRCBLTCLRSPACE 0x00000400
484#define VBOXVHWA_CKEYCAPS_SRCBLTCLRSPACEYUV 0x00000800
485#define VBOXVHWA_CKEYCAPS_SRCBLTYUV 0x00001000
486#define VBOXVHWA_CKEYCAPS_SRCOVERLAY 0x00002000
487#define VBOXVHWA_CKEYCAPS_SRCOVERLAYCLRSPACE 0x00004000
488#define VBOXVHWA_CKEYCAPS_SRCOVERLAYCLRSPACEYUV 0x00008000
489#define VBOXVHWA_CKEYCAPS_SRCOVERLAYONEACTIVE 0x00010000
490#define VBOXVHWA_CKEYCAPS_SRCOVERLAYYUV 0x00020000
491#define VBOXVHWA_CKEYCAPS_NOCOSTOVERLAY 0x00040000
492
493#define VBOXVHWA_BLT_COLORFILL 0x00000400
494#define VBOXVHWA_BLT_DDFX 0x00000800
495#define VBOXVHWA_BLT_EXTENDED_FLAGS 0x40000000
496#define VBOXVHWA_BLT_EXTENDED_LINEAR_CONTENT 0x00000004
497#define VBOXVHWA_BLT_EXTENDED_PRESENTATION_STRETCHFACTOR 0x00000010
498#define VBOXVHWA_BLT_KEYDESTOVERRIDE 0x00004000
499#define VBOXVHWA_BLT_KEYSRCOVERRIDE 0x00010000
500#define VBOXVHWA_BLT_LAST_PRESENTATION 0x20000000
501#define VBOXVHWA_BLT_PRESENTATION 0x10000000
502#define VBOXVHWA_BLT_ROP 0x00020000
503
504
505#define VBOXVHWA_OVER_DDFX 0x00080000
506#define VBOXVHWA_OVER_HIDE 0x00000200
507#define VBOXVHWA_OVER_KEYDEST 0x00000400
508#define VBOXVHWA_OVER_KEYDESTOVERRIDE 0x00000800
509#define VBOXVHWA_OVER_KEYSRC 0x00001000
510#define VBOXVHWA_OVER_KEYSRCOVERRIDE 0x00002000
511#define VBOXVHWA_OVER_SHOW 0x00004000
512
513#define VBOXVHWA_CKEY_COLORSPACE 0x00000001
514#define VBOXVHWA_CKEY_DESTBLT 0x00000002
515#define VBOXVHWA_CKEY_DESTOVERLAY 0x00000004
516#define VBOXVHWA_CKEY_SRCBLT 0x00000008
517#define VBOXVHWA_CKEY_SRCOVERLAY 0x00000010
518
519#define VBOXVHWA_BLT_ARITHSTRETCHY 0x00000001
520#define VBOXVHWA_BLT_MIRRORLEFTRIGHT 0x00000002
521#define VBOXVHWA_BLT_MIRRORUPDOWN 0x00000004
522
523#define VBOXVHWA_OVERFX_ARITHSTRETCHY 0x00000001
524#define VBOXVHWA_OVERFX_MIRRORLEFTRIGHT 0x00000002
525#define VBOXVHWA_OVERFX_MIRRORUPDOWN 0x00000004
526
527#define VBOXVHWA_CAPS2_CANRENDERWINDOWED 0x00080000
528#define VBOXVHWA_CAPS2_WIDESURFACES 0x00001000
529#define VBOXVHWA_CAPS2_COPYFOURCC 0x00008000
530/*#define VBOXVHWA_CAPS2_FLIPINTERVAL 0x00200000*/
531/*#define VBOXVHWA_CAPS2_FLIPNOVSYNC 0x00400000*/
532
533
534#define VBOXVHWA_OFFSET64_VOID (UINT64_MAX)
535
536typedef struct VBOXVHWA_VERSION
537{
538 uint32_t maj;
539 uint32_t min;
540 uint32_t bld;
541 uint32_t reserved;
542} VBOXVHWA_VERSION;
543
544#define VBOXVHWA_VERSION_INIT(_pv) do { \
545 (_pv)->maj = VBOXVHWA_VERSION_MAJ; \
546 (_pv)->min = VBOXVHWA_VERSION_MIN; \
547 (_pv)->bld = VBOXVHWA_VERSION_BLD; \
548 (_pv)->reserved = VBOXVHWA_VERSION_RSV; \
549 } while(0)
550
551typedef struct VBOXVHWACMD_QUERYINFO1
552{
553 union
554 {
555 struct
556 {
557 VBOXVHWA_VERSION guestVersion;
558 } in;
559
560 struct
561 {
562 uint32_t cfgFlags;
563 uint32_t caps;
564
565 uint32_t caps2;
566 uint32_t colorKeyCaps;
567
568 uint32_t stretchCaps;
569 uint32_t surfaceCaps;
570
571 uint32_t numOverlays;
572 uint32_t curOverlays;
573
574 uint32_t numFourCC;
575 uint32_t reserved;
576 } out;
577 } u;
578} VBOXVHWACMD_QUERYINFO1;
579
580typedef struct VBOXVHWACMD_QUERYINFO2
581{
582 uint32_t numFourCC;
583 uint32_t FourCC[1];
584} VBOXVHWACMD_QUERYINFO2;
585
586#define VBOXVHWAINFO2_SIZE(_cFourCC) RT_OFFSETOF(VBOXVHWACMD_QUERYINFO2, FourCC[_cFourCC])
587
588typedef struct VBOXVHWACMD_SURF_CANCREATE
589{
590 VBOXVHWA_SURFACEDESC SurfInfo;
591 union
592 {
593 struct
594 {
595 uint32_t bIsDifferentPixelFormat;
596 uint32_t Reserved;
597 } in;
598
599 struct
600 {
601 int32_t ErrInfo;
602 } out;
603 } u;
604} VBOXVHWACMD_SURF_CANCREATE;
605
606typedef struct VBOXVHWACMD_SURF_CREATE
607{
608 VBOXVHWA_SURFACEDESC SurfInfo;
609} VBOXVHWACMD_SURF_CREATE;
610
611#ifdef VBOX_WITH_WDDM
612typedef struct VBOXVHWACMD_SURF_GETINFO
613{
614 VBOXVHWA_SURFACEDESC SurfInfo;
615} VBOXVHWACMD_SURF_GETINFO;
616#endif
617
618typedef struct VBOXVHWACMD_SURF_DESTROY
619{
620 union
621 {
622 struct
623 {
624 VBOXVHWA_SURFHANDLE hSurf;
625 } in;
626 } u;
627} VBOXVHWACMD_SURF_DESTROY;
628
629typedef struct VBOXVHWACMD_SURF_LOCK
630{
631 union
632 {
633 struct
634 {
635 VBOXVHWA_SURFHANDLE hSurf;
636 uint64_t offSurface;
637 uint32_t flags;
638 uint32_t rectValid;
639 VBOXVHWA_RECTL rect;
640 } in;
641 } u;
642} VBOXVHWACMD_SURF_LOCK;
643
644typedef struct VBOXVHWACMD_SURF_UNLOCK
645{
646 union
647 {
648 struct
649 {
650 VBOXVHWA_SURFHANDLE hSurf;
651 uint32_t xUpdatedMemValid;
652 uint32_t reserved;
653 VBOXVHWA_RECTL xUpdatedMemRect;
654 } in;
655 } u;
656} VBOXVHWACMD_SURF_UNLOCK;
657
658typedef struct VBOXVHWACMD_SURF_BLT
659{
660 uint64_t DstGuestSurfInfo;
661 uint64_t SrcGuestSurfInfo;
662 union
663 {
664 struct
665 {
666 VBOXVHWA_SURFHANDLE hDstSurf;
667 uint64_t offDstSurface;
668 VBOXVHWA_RECTL dstRect;
669 VBOXVHWA_SURFHANDLE hSrcSurf;
670 uint64_t offSrcSurface;
671 VBOXVHWA_RECTL srcRect;
672 uint32_t flags;
673 uint32_t xUpdatedSrcMemValid;
674 VBOXVHWA_BLTFX desc;
675 VBOXVHWA_RECTL xUpdatedSrcMemRect;
676 } in;
677 } u;
678} VBOXVHWACMD_SURF_BLT;
679
680#ifdef VBOX_WITH_WDDM
681typedef struct VBOXVHWACMD_SURF_COLORFILL
682{
683 union
684 {
685 struct
686 {
687 VBOXVHWA_SURFHANDLE hSurf;
688 uint64_t offSurface;
689 uint32_t u32Reserved;
690 uint32_t cRects;
691 VBOXVHWA_RECTL aRects[1];
692 } in;
693 } u;
694} VBOXVHWACMD_SURF_COLORFILL;
695#endif
696
697typedef struct VBOXVHWACMD_SURF_FLIP
698{
699 uint64_t TargGuestSurfInfo;
700 uint64_t CurrGuestSurfInfo;
701 union
702 {
703 struct
704 {
705 VBOXVHWA_SURFHANDLE hTargSurf;
706 uint64_t offTargSurface;
707 VBOXVHWA_SURFHANDLE hCurrSurf;
708 uint64_t offCurrSurface;
709 uint32_t flags;
710 uint32_t xUpdatedTargMemValid;
711 VBOXVHWA_RECTL xUpdatedTargMemRect;
712 } in;
713 } u;
714} VBOXVHWACMD_SURF_FLIP;
715
716typedef struct VBOXVHWACMD_SURF_COLORKEY_SET
717{
718 union
719 {
720 struct
721 {
722 VBOXVHWA_SURFHANDLE hSurf;
723 uint64_t offSurface;
724 VBOXVHWA_COLORKEY CKey;
725 uint32_t flags;
726 uint32_t reserved;
727 } in;
728 } u;
729} VBOXVHWACMD_SURF_COLORKEY_SET;
730
731#define VBOXVHWACMD_SURF_OVERLAY_UPDATE_F_SRCMEMRECT 0x00000001
732#define VBOXVHWACMD_SURF_OVERLAY_UPDATE_F_DSTMEMRECT 0x00000002
733
734typedef struct VBOXVHWACMD_SURF_OVERLAY_UPDATE
735{
736 union
737 {
738 struct
739 {
740 VBOXVHWA_SURFHANDLE hDstSurf;
741 uint64_t offDstSurface;
742 VBOXVHWA_RECTL dstRect;
743 VBOXVHWA_SURFHANDLE hSrcSurf;
744 uint64_t offSrcSurface;
745 VBOXVHWA_RECTL srcRect;
746 uint32_t flags;
747 uint32_t xFlags;
748 VBOXVHWA_OVERLAYFX desc;
749 VBOXVHWA_RECTL xUpdatedSrcMemRect;
750 VBOXVHWA_RECTL xUpdatedDstMemRect;
751 } in;
752 } u;
753}VBOXVHWACMD_SURF_OVERLAY_UPDATE;
754
755typedef struct VBOXVHWACMD_SURF_OVERLAY_SETPOSITION
756{
757 union
758 {
759 struct
760 {
761 VBOXVHWA_SURFHANDLE hDstSurf;
762 uint64_t offDstSurface;
763 VBOXVHWA_SURFHANDLE hSrcSurf;
764 uint64_t offSrcSurface;
765 uint32_t xPos;
766 uint32_t yPos;
767 uint32_t flags;
768 uint32_t reserved;
769 } in;
770 } u;
771} VBOXVHWACMD_SURF_OVERLAY_SETPOSITION;
772
773typedef struct VBOXVHWACMD_HH_CONSTRUCT
774{
775 void *pVM;
776 /* VRAM info for the backend to be able to properly translate VRAM offsets */
777 void *pvVRAM;
778 uint32_t cbVRAM;
779} VBOXVHWACMD_HH_CONSTRUCT;
780
781typedef struct VBOXVHWACMD_HH_SAVESTATE_SAVEPERFORM
782{
783 struct SSMHANDLE * pSSM;
784} VBOXVHWACMD_HH_SAVESTATE_SAVEPERFORM;
785
786typedef struct VBOXVHWACMD_HH_SAVESTATE_LOADPERFORM
787{
788 struct SSMHANDLE * pSSM;
789} VBOXVHWACMD_HH_SAVESTATE_LOADPERFORM;
790
791typedef DECLCALLBACK(void) FNVBOXVHWA_HH_CALLBACK(void*);
792typedef FNVBOXVHWA_HH_CALLBACK *PFNVBOXVHWA_HH_CALLBACK;
793
794#define VBOXVHWA_HH_CALLBACK_SET(_pCmd, _pfn, _parg) \
795 do { \
796 (_pCmd)->GuestVBVAReserved1 = (uint64_t)(uintptr_t)(_pfn); \
797 (_pCmd)->GuestVBVAReserved2 = (uint64_t)(uintptr_t)(_parg); \
798 }while(0)
799
800#define VBOXVHWA_HH_CALLBACK_GET(_pCmd) ((PFNVBOXVHWA_HH_CALLBACK)(_pCmd)->GuestVBVAReserved1)
801#define VBOXVHWA_HH_CALLBACK_GET_ARG(_pCmd) ((void*)(_pCmd)->GuestVBVAReserved2)
802
803#pragma pack()
804#endif /* #ifdef VBOX_WITH_VIDEOHWACCEL */
805
806/* All structures are without alignment. */
807#pragma pack(1)
808
809typedef struct VBVAHOSTFLAGS
810{
811 uint32_t u32HostEvents;
812 uint32_t u32SupportedOrders;
813} VBVAHOSTFLAGS;
814
815typedef struct VBVABUFFER
816{
817 VBVAHOSTFLAGS hostFlags;
818
819 /* The offset where the data start in the buffer. */
820 uint32_t off32Data;
821 /* The offset where next data must be placed in the buffer. */
822 uint32_t off32Free;
823
824 /* The queue of record descriptions. */
825 VBVARECORD aRecords[VBVA_MAX_RECORDS];
826 uint32_t indexRecordFirst;
827 uint32_t indexRecordFree;
828
829 /* Space to leave free in the buffer when large partial records are transferred. */
830 uint32_t cbPartialWriteThreshold;
831
832 uint32_t cbData;
833 uint8_t au8Data[1]; /* variable size for the rest of the VBVABUFFER area in VRAM. */
834} VBVABUFFER;
835
836/* guest->host commands */
837#define VBVA_QUERY_CONF32 1
838#define VBVA_SET_CONF32 2
839#define VBVA_INFO_VIEW 3
840#define VBVA_INFO_HEAP 4
841#define VBVA_FLUSH 5
842#define VBVA_INFO_SCREEN 6
843#define VBVA_ENABLE 7
844#define VBVA_MOUSE_POINTER_SHAPE 8
845#ifdef VBOX_WITH_VIDEOHWACCEL
846# define VBVA_VHWA_CMD 9
847#endif /* # ifdef VBOX_WITH_VIDEOHWACCEL */
848#ifdef VBOX_WITH_VDMA
849# define VBVA_VDMA_CTL 10 /* setup G<->H DMA channel info */
850# define VBVA_VDMA_CMD 11 /* G->H DMA command */
851#endif
852#define VBVA_INFO_CAPS 12 /* informs host about HGSMI caps. see VBVACAPS below */
853#define VBVA_SCANLINE_CFG 13 /* configures scanline, see VBVASCANLINECFG below */
854#define VBVA_SCANLINE_INFO 14 /* requests scanline info, see VBVASCANLINEINFO below */
855
856/* host->guest commands */
857#define VBVAHG_EVENT 1
858#define VBVAHG_DISPLAY_CUSTOM 2
859#ifdef VBOX_WITH_VDMA
860#define VBVAHG_SHGSMI_COMPLETION 3
861#endif
862
863#ifdef VBOX_WITH_VIDEOHWACCEL
864#define VBVAHG_DCUSTOM_VHWA_CMDCOMPLETE 1
865#pragma pack(1)
866typedef struct VBVAHOSTCMDVHWACMDCOMPLETE
867{
868 uint32_t offCmd;
869}VBVAHOSTCMDVHWACMDCOMPLETE;
870#pragma pack()
871#endif /* # ifdef VBOX_WITH_VIDEOHWACCEL */
872
873#pragma pack(1)
874typedef enum
875{
876 VBVAHOSTCMD_OP_EVENT = 1,
877 VBVAHOSTCMD_OP_CUSTOM
878}VBVAHOSTCMD_OP_TYPE;
879
880typedef struct VBVAHOSTCMDEVENT
881{
882 uint64_t pEvent;
883}VBVAHOSTCMDEVENT;
884
885
886typedef struct VBVAHOSTCMD
887{
888 /* destination ID if >=0 specifies display index, otherwize the command is directed to the miniport */
889 int32_t iDstID;
890 int32_t customOpCode;
891 union
892 {
893 struct VBVAHOSTCMD *pNext;
894 uint32_t offNext;
895 uint64_t Data; /* the body is 64-bit aligned */
896 } u;
897 char body[1];
898}VBVAHOSTCMD;
899
900#define VBVAHOSTCMD_SIZE(_size) (sizeof(VBVAHOSTCMD) + (_size))
901#define VBVAHOSTCMD_BODY(_pCmd, _tBody) ((_tBody*)(_pCmd)->body)
902#define VBVAHOSTCMD_HDR(_pBody) ((VBVAHOSTCMD*)(((uint8_t*)_pBody) - RT_OFFSETOF(VBVAHOSTCMD, body)))
903#define VBVAHOSTCMD_HDRSIZE (RT_OFFSETOF(VBVAHOSTCMD, body))
904
905#pragma pack()
906
907/* VBVACONF32::u32Index */
908#define VBOX_VBVA_CONF32_MONITOR_COUNT 0
909#define VBOX_VBVA_CONF32_HOST_HEAP_SIZE 1
910
911typedef struct VBVACONF32
912{
913 uint32_t u32Index;
914 uint32_t u32Value;
915} VBVACONF32;
916
917typedef struct VBVAINFOVIEW
918{
919 /* Index of the screen, assigned by the guest. */
920 uint32_t u32ViewIndex;
921
922 /* The screen offset in VRAM, the framebuffer starts here. */
923 uint32_t u32ViewOffset;
924
925 /* The size of the VRAM memory that can be used for the view. */
926 uint32_t u32ViewSize;
927
928 /* The recommended maximum size of the VRAM memory for the screen. */
929 uint32_t u32MaxScreenSize;
930} VBVAINFOVIEW;
931
932typedef struct VBVAINFOHEAP
933{
934 /* Absolute offset in VRAM of the start of the heap. */
935 uint32_t u32HeapOffset;
936
937 /* The size of the heap. */
938 uint32_t u32HeapSize;
939
940} VBVAINFOHEAP;
941
942typedef struct VBVAFLUSH
943{
944 uint32_t u32Reserved;
945
946} VBVAFLUSH;
947
948/* VBVAINFOSCREEN::u8Flags */
949#define VBVA_SCREEN_F_NONE 0x0000
950#define VBVA_SCREEN_F_ACTIVE 0x0001
951/** The virtual monitor has been disabled by the guest and should be blacked
952 * out by the host and ignored for purposes of pointer position calculation. */
953#define VBVA_SCREEN_F_DISABLED 0x0002
954
955typedef struct VBVAINFOSCREEN
956{
957 /* Which view contains the screen. */
958 uint32_t u32ViewIndex;
959
960 /* Physical X origin relative to the primary screen. */
961 int32_t i32OriginX;
962
963 /* Physical Y origin relative to the primary screen. */
964 int32_t i32OriginY;
965
966 /* Offset of visible framebuffer relative to the framebuffer start. */
967 uint32_t u32StartOffset;
968
969 /* The scan line size in bytes. */
970 uint32_t u32LineSize;
971
972 /* Width of the screen. */
973 uint32_t u32Width;
974
975 /* Height of the screen. */
976 uint32_t u32Height;
977
978 /* Color depth. */
979 uint16_t u16BitsPerPixel;
980
981 /* VBVA_SCREEN_F_* */
982 uint16_t u16Flags;
983} VBVAINFOSCREEN;
984
985
986/* VBVAENABLE::u32Flags */
987#define VBVA_F_NONE 0x00000000
988#define VBVA_F_ENABLE 0x00000001
989#define VBVA_F_DISABLE 0x00000002
990/* extended VBVA to be used with WDDM */
991#define VBVA_F_EXTENDED 0x00000004
992/* vbva offset is absolute VRAM offset */
993#define VBVA_F_ABSOFFSET 0x00000008
994
995typedef struct VBVAENABLE
996{
997 uint32_t u32Flags;
998 uint32_t u32Offset;
999 int32_t i32Result;
1000} VBVAENABLE;
1001
1002typedef struct VBVAENABLE_EX
1003{
1004 VBVAENABLE Base;
1005 uint32_t u32ScreenId;
1006} VBVAENABLE_EX;
1007
1008
1009typedef struct VBVAMOUSEPOINTERSHAPE
1010{
1011 /* The host result. */
1012 int32_t i32Result;
1013
1014 /* VBOX_MOUSE_POINTER_* bit flags. */
1015 uint32_t fu32Flags;
1016
1017 /* X coordinate of the hot spot. */
1018 uint32_t u32HotX;
1019
1020 /* Y coordinate of the hot spot. */
1021 uint32_t u32HotY;
1022
1023 /* Width of the pointer in pixels. */
1024 uint32_t u32Width;
1025
1026 /* Height of the pointer in scanlines. */
1027 uint32_t u32Height;
1028
1029 /* Pointer data.
1030 *
1031 ****
1032 * The data consists of 1 bpp AND mask followed by 32 bpp XOR (color) mask.
1033 *
1034 * For pointers without alpha channel the XOR mask pixels are 32 bit values: (lsb)BGR0(msb).
1035 * For pointers with alpha channel the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
1036 *
1037 * Guest driver must create the AND mask for pointers with alpha channel, so if host does not
1038 * support alpha, the pointer could be displayed as a normal color pointer. The AND mask can
1039 * be constructed from alpha values. For example alpha value >= 0xf0 means bit 0 in the AND mask.
1040 *
1041 * The AND mask is 1 bpp bitmap with byte aligned scanlines. Size of AND mask,
1042 * therefore, is cbAnd = (width + 7) / 8 * height. The padding bits at the
1043 * end of any scanline are undefined.
1044 *
1045 * The XOR mask follows the AND mask on the next 4 bytes aligned offset:
1046 * uint8_t *pXor = pAnd + (cbAnd + 3) & ~3
1047 * Bytes in the gap between the AND and the XOR mask are undefined.
1048 * XOR mask scanlines have no gap between them and size of XOR mask is:
1049 * cXor = width * 4 * height.
1050 ****
1051 *
1052 * Preallocate 4 bytes for accessing actual data as p->au8Data.
1053 */
1054 uint8_t au8Data[4];
1055
1056} VBVAMOUSEPOINTERSHAPE;
1057
1058/* the guest driver can handle asynch guest cmd completion by reading the command offset from io port */
1059#define VBVACAPS_COMPLETEGCMD_BY_IOREAD 0x00000001
1060/* the guest driver can handle video adapter IRQs */
1061#define VBVACAPS_IRQ 0x00000002
1062typedef struct VBVACAPS
1063{
1064 int32_t rc;
1065 uint32_t fCaps;
1066} VBVACAPS;
1067
1068/* makes graphics device generate IRQ on VSYNC */
1069#define VBVASCANLINECFG_ENABLE_VSYNC_IRQ 0x00000001
1070/* guest driver may request the current scanline */
1071#define VBVASCANLINECFG_ENABLE_SCANLINE_INFO 0x00000002
1072/* request the current refresh period, returned in u32RefreshPeriodMs */
1073#define VBVASCANLINECFG_QUERY_REFRESH_PERIOD 0x00000004
1074/* set new refresh period specified in u32RefreshPeriodMs.
1075 * if used with VBVASCANLINECFG_QUERY_REFRESH_PERIOD,
1076 * u32RefreshPeriodMs is set to the previous refresh period on return */
1077#define VBVASCANLINECFG_SET_REFRESH_PERIOD 0x00000008
1078
1079typedef struct VBVASCANLINECFG
1080{
1081 int32_t rc;
1082 uint32_t fFlags;
1083 uint32_t u32RefreshPeriodMs;
1084 uint32_t u32Reserved;
1085} VBVASCANLINECFG;
1086
1087typedef struct VBVASCANLINEINFO
1088{
1089 int32_t rc;
1090 uint32_t u32ScreenId;
1091 uint32_t u32InVBlank;
1092 uint32_t u32ScanLine;
1093} VBVASCANLINEINFO;
1094
1095#pragma pack()
1096
1097typedef uint64_t VBOXVIDEOOFFSET;
1098
1099#define VBOXVIDEOOFFSET_VOID ((VBOXVIDEOOFFSET)~0)
1100
1101#pragma pack(1)
1102
1103/*
1104 * VBOXSHGSMI made on top HGSMI and allows receiving notifications
1105 * about G->H command completion
1106 */
1107/* SHGSMI command header */
1108typedef struct VBOXSHGSMIHEADER
1109{
1110 uint64_t pvNext; /*<- completion processing queue */
1111 uint32_t fFlags; /*<- see VBOXSHGSMI_FLAG_XXX Flags */
1112 uint32_t cRefs; /*<- command referece count */
1113 uint64_t u64Info1; /*<- contents depends on the fFlags value */
1114 uint64_t u64Info2; /*<- contents depends on the fFlags value */
1115} VBOXSHGSMIHEADER, *PVBOXSHGSMIHEADER;
1116
1117typedef enum
1118{
1119 VBOXVDMACMD_TYPE_UNDEFINED = 0,
1120 VBOXVDMACMD_TYPE_DMA_PRESENT_BLT = 1,
1121 VBOXVDMACMD_TYPE_DMA_BPB_TRANSFER,
1122 VBOXVDMACMD_TYPE_DMA_BPB_FILL,
1123 VBOXVDMACMD_TYPE_DMA_PRESENT_SHADOW2PRIMARY,
1124 VBOXVDMACMD_TYPE_DMA_PRESENT_CLRFILL,
1125 VBOXVDMACMD_TYPE_DMA_PRESENT_FLIP,
1126 VBOXVDMACMD_TYPE_DMA_NOP,
1127 VBOXVDMACMD_TYPE_CHROMIUM_CMD, /* chromium cmd */
1128 VBOXVDMACMD_TYPE_DMA_BPB_TRANSFER_VRAMSYS,
1129 VBOXVDMACMD_TYPE_CHILD_STATUS_IRQ /* make the device notify child (monitor) state change IRQ */
1130} VBOXVDMACMD_TYPE;
1131
1132#pragma pack()
1133
1134/* the command processing was asynch, set by the host to indicate asynch command completion
1135 * must not be cleared once set, the command completion is performed by issuing a host->guest completion command
1136 * while keeping this flag unchanged */
1137#define VBOXSHGSMI_FLAG_HG_ASYNCH 0x00010000
1138#if 0
1139/* if set - asynch completion is performed by issuing the event,
1140 * if cleared - asynch completion is performed by calling a callback */
1141#define VBOXSHGSMI_FLAG_GH_ASYNCH_EVENT 0x00000001
1142#endif
1143/* issue interrupt on asynch completion, used for critical G->H commands,
1144 * i.e. for completion of which guest is waiting. */
1145#define VBOXSHGSMI_FLAG_GH_ASYNCH_IRQ 0x00000002
1146/* guest does not do any op on completion of this command,
1147 * the host may copy the command and indicate that it does not need the command anymore
1148 * by not setting VBOXSHGSMI_FLAG_HG_ASYNCH */
1149#define VBOXSHGSMI_FLAG_GH_ASYNCH_NOCOMPLETION 0x00000004
1150/* guest requires the command to be processed asynchronously,
1151 * not setting VBOXSHGSMI_FLAG_HG_ASYNCH by the host in this case is treated as command failure */
1152#define VBOXSHGSMI_FLAG_GH_ASYNCH_FORCE 0x00000008
1153/* force IRQ on cmd completion */
1154#define VBOXSHGSMI_FLAG_GH_ASYNCH_IRQ_FORCE 0x00000010
1155/* an IRQ-level callback is associated with the command */
1156#define VBOXSHGSMI_FLAG_GH_ASYNCH_CALLBACK_IRQ 0x00000020
1157/* guest expects this command to be completed synchronously */
1158#define VBOXSHGSMI_FLAG_GH_SYNCH 0x00000040
1159
1160
1161DECLINLINE(uint8_t *) VBoxSHGSMIBufferData (const VBOXSHGSMIHEADER* pHeader)
1162{
1163 return (uint8_t *)pHeader + sizeof (VBOXSHGSMIHEADER);
1164}
1165
1166#define VBoxSHGSMIBufferHeaderSize() (sizeof (VBOXSHGSMIHEADER))
1167
1168DECLINLINE(PVBOXSHGSMIHEADER) VBoxSHGSMIBufferHeader (const void *pvData)
1169{
1170 return (PVBOXSHGSMIHEADER)((uint8_t *)pvData - sizeof (VBOXSHGSMIHEADER));
1171}
1172
1173#ifdef VBOX_WITH_VDMA
1174# pragma pack(1)
1175
1176/* VDMA - Video DMA */
1177
1178/* VDMA Control API */
1179/* VBOXVDMA_CTL::u32Flags */
1180typedef enum
1181{
1182 VBOXVDMA_CTL_TYPE_NONE = 0,
1183 VBOXVDMA_CTL_TYPE_ENABLE,
1184 VBOXVDMA_CTL_TYPE_DISABLE,
1185 VBOXVDMA_CTL_TYPE_FLUSH,
1186 VBOXVDMA_CTL_TYPE_WATCHDOG
1187} VBOXVDMA_CTL_TYPE;
1188
1189typedef struct VBOXVDMA_CTL
1190{
1191 VBOXVDMA_CTL_TYPE enmCtl;
1192 uint32_t u32Offset;
1193 int32_t i32Result;
1194} VBOXVDMA_CTL, *PVBOXVDMA_CTL;
1195
1196typedef struct VBOXVDMA_RECTL
1197{
1198 int16_t left;
1199 int16_t top;
1200 uint16_t width;
1201 uint16_t height;
1202} VBOXVDMA_RECTL, *PVBOXVDMA_RECTL;
1203
1204typedef enum
1205{
1206 VBOXVDMA_PIXEL_FORMAT_UNKNOWN = 0,
1207 VBOXVDMA_PIXEL_FORMAT_R8G8B8 = 20,
1208 VBOXVDMA_PIXEL_FORMAT_A8R8G8B8 = 21,
1209 VBOXVDMA_PIXEL_FORMAT_X8R8G8B8 = 22,
1210 VBOXVDMA_PIXEL_FORMAT_R5G6B5 = 23,
1211 VBOXVDMA_PIXEL_FORMAT_X1R5G5B5 = 24,
1212 VBOXVDMA_PIXEL_FORMAT_A1R5G5B5 = 25,
1213 VBOXVDMA_PIXEL_FORMAT_A4R4G4B4 = 26,
1214 VBOXVDMA_PIXEL_FORMAT_R3G3B2 = 27,
1215 VBOXVDMA_PIXEL_FORMAT_A8 = 28,
1216 VBOXVDMA_PIXEL_FORMAT_A8R3G3B2 = 29,
1217 VBOXVDMA_PIXEL_FORMAT_X4R4G4B4 = 30,
1218 VBOXVDMA_PIXEL_FORMAT_A2B10G10R10 = 31,
1219 VBOXVDMA_PIXEL_FORMAT_A8B8G8R8 = 32,
1220 VBOXVDMA_PIXEL_FORMAT_X8B8G8R8 = 33,
1221 VBOXVDMA_PIXEL_FORMAT_G16R16 = 34,
1222 VBOXVDMA_PIXEL_FORMAT_A2R10G10B10 = 35,
1223 VBOXVDMA_PIXEL_FORMAT_A16B16G16R16 = 36,
1224 VBOXVDMA_PIXEL_FORMAT_A8P8 = 40,
1225 VBOXVDMA_PIXEL_FORMAT_P8 = 41,
1226 VBOXVDMA_PIXEL_FORMAT_L8 = 50,
1227 VBOXVDMA_PIXEL_FORMAT_A8L8 = 51,
1228 VBOXVDMA_PIXEL_FORMAT_A4L4 = 52,
1229 VBOXVDMA_PIXEL_FORMAT_V8U8 = 60,
1230 VBOXVDMA_PIXEL_FORMAT_L6V5U5 = 61,
1231 VBOXVDMA_PIXEL_FORMAT_X8L8V8U8 = 62,
1232 VBOXVDMA_PIXEL_FORMAT_Q8W8V8U8 = 63,
1233 VBOXVDMA_PIXEL_FORMAT_V16U16 = 64,
1234 VBOXVDMA_PIXEL_FORMAT_W11V11U10 = 65,
1235 VBOXVDMA_PIXEL_FORMAT_A2W10V10U10 = 67
1236} VBOXVDMA_PIXEL_FORMAT;
1237
1238typedef struct VBOXVDMA_SURF_DESC
1239{
1240 uint32_t width;
1241 uint32_t height;
1242 VBOXVDMA_PIXEL_FORMAT format;
1243 uint32_t bpp;
1244 uint32_t pitch;
1245 uint32_t fFlags;
1246} VBOXVDMA_SURF_DESC, *PVBOXVDMA_SURF_DESC;
1247
1248/*typedef uint64_t VBOXVDMAPHADDRESS;*/
1249typedef uint64_t VBOXVDMASURFHANDLE;
1250
1251/* region specified as a rectangle, otherwize it is a size of memory pointed to by phys address */
1252#define VBOXVDMAOPERAND_FLAGS_RECTL 0x1
1253/* Surface handle is valid */
1254#define VBOXVDMAOPERAND_FLAGS_PRIMARY 0x2
1255/* address is offset in VRAM */
1256#define VBOXVDMAOPERAND_FLAGS_VRAMOFFSET 0x4
1257
1258
1259/* VBOXVDMACBUF_DR::phBuf specifies offset in VRAM */
1260#define VBOXVDMACBUF_FLAG_BUF_VRAM_OFFSET 0x00000001
1261/* command buffer follows the VBOXVDMACBUF_DR in VRAM, VBOXVDMACBUF_DR::phBuf is ignored */
1262#define VBOXVDMACBUF_FLAG_BUF_FOLLOWS_DR 0x00000002
1263
1264/*
1265 * We can not submit the DMA command via VRAM since we do not have control over
1266 * DMA command buffer [de]allocation, i.e. we only control the buffer contents.
1267 * In other words the system may call one of our callbacks to fill a command buffer
1268 * with the necessary commands and then discard the buffer w/o any notification.
1269 *
1270 * We have only DMA command buffer physical address at submission time.
1271 *
1272 * so the only way is to */
1273typedef struct VBOXVDMACBUF_DR
1274{
1275 uint16_t fFlags;
1276 uint16_t cbBuf;
1277 /* RT_SUCCESS() - on success
1278 * VERR_INTERRUPTED - on preemption
1279 * VERR_xxx - on error */
1280 int32_t rc;
1281 union
1282 {
1283 uint64_t phBuf;
1284 VBOXVIDEOOFFSET offVramBuf;
1285 } Location;
1286 uint64_t aGuestData[7];
1287} VBOXVDMACBUF_DR, *PVBOXVDMACBUF_DR;
1288
1289#define VBOXVDMACBUF_DR_TAIL(_pCmd, _t) ( (_t*)(((uint8_t*)(_pCmd)) + sizeof (VBOXVDMACBUF_DR)) )
1290#define VBOXVDMACBUF_DR_FROM_TAIL(_pCmd) ( (VBOXVDMACBUF_DR*)(((uint8_t*)(_pCmd)) - sizeof (VBOXVDMACBUF_DR)) )
1291
1292typedef struct VBOXVDMACMD
1293{
1294 VBOXVDMACMD_TYPE enmType;
1295 uint32_t u32CmdSpecific;
1296} VBOXVDMACMD, *PVBOXVDMACMD;
1297
1298#define VBOXVDMACMD_HEADER_SIZE() sizeof (VBOXVDMACMD)
1299#define VBOXVDMACMD_SIZE_FROMBODYSIZE(_s) (VBOXVDMACMD_HEADER_SIZE() + (_s))
1300#define VBOXVDMACMD_SIZE(_t) (VBOXVDMACMD_SIZE_FROMBODYSIZE(sizeof (_t)))
1301#define VBOXVDMACMD_BODY(_pCmd, _t) ( (_t*)(((uint8_t*)(_pCmd)) + VBOXVDMACMD_HEADER_SIZE()) )
1302#define VBOXVDMACMD_BODY_SIZE(_s) ( (_s) - VBOXVDMACMD_HEADER_SIZE() )
1303#define VBOXVDMACMD_FROM_BODY(_pCmd) ( (VBOXVDMACMD*)(((uint8_t*)(_pCmd)) - VBOXVDMACMD_HEADER_SIZE()) )
1304#define VBOXVDMACMD_BODY_FIELD_OFFSET(_ot, _t, _f) ( (_ot)(uintptr_t)( VBOXVDMACMD_BODY(0, uint8_t) + RT_OFFSETOF(_t, _f) ) )
1305
1306typedef struct VBOXVDMACMD_DMA_PRESENT_BLT
1307{
1308 VBOXVIDEOOFFSET offSrc;
1309 VBOXVIDEOOFFSET offDst;
1310 VBOXVDMA_SURF_DESC srcDesc;
1311 VBOXVDMA_SURF_DESC dstDesc;
1312 VBOXVDMA_RECTL srcRectl;
1313 VBOXVDMA_RECTL dstRectl;
1314 uint32_t u32Reserved;
1315 uint32_t cDstSubRects;
1316 VBOXVDMA_RECTL aDstSubRects[1];
1317} VBOXVDMACMD_DMA_PRESENT_BLT, *PVBOXVDMACMD_DMA_PRESENT_BLT;
1318
1319typedef struct VBOXVDMACMD_DMA_PRESENT_SHADOW2PRIMARY
1320{
1321 VBOXVDMA_RECTL Rect;
1322} VBOXVDMACMD_DMA_PRESENT_SHADOW2PRIMARY, *PVBOXVDMACMD_DMA_PRESENT_SHADOW2PRIMARY;
1323
1324
1325#define VBOXVDMACMD_DMA_BPB_TRANSFER_F_SRC_VRAMOFFSET 0x00000001
1326#define VBOXVDMACMD_DMA_BPB_TRANSFER_F_DST_VRAMOFFSET 0x00000002
1327
1328typedef struct VBOXVDMACMD_DMA_BPB_TRANSFER
1329{
1330 uint32_t cbTransferSize;
1331 uint32_t fFlags;
1332 union
1333 {
1334 uint64_t phBuf;
1335 VBOXVIDEOOFFSET offVramBuf;
1336 } Src;
1337 union
1338 {
1339 uint64_t phBuf;
1340 VBOXVIDEOOFFSET offVramBuf;
1341 } Dst;
1342} VBOXVDMACMD_DMA_BPB_TRANSFER, *PVBOXVDMACMD_DMA_BPB_TRANSFER;
1343
1344#define VBOXVDMACMD_SYSMEMEL_F_PAGELIST 0x00000001
1345
1346typedef struct VBOXVDMACMD_SYSMEMEL
1347{
1348 uint32_t cPages;
1349 uint32_t fFlags;
1350 uint64_t phBuf[1];
1351} VBOXVDMACMD_SYSMEMEL, *PVBOXVDMACMD_SYSMEMEL;
1352
1353#define VBOXVDMACMD_SYSMEMEL_NEXT(_pEl) (((_pEl)->fFlags & VBOXVDMACMD_SYSMEMEL_F_PAGELIST) ? \
1354 ((PVBOXVDMACMD_SYSMEMEL)(((uint8_t*)(_pEl))+RT_OFFSETOF(VBOXVDMACMD_SYSMEMEL, phBuf[(_pEl)->cPages]))) \
1355 : \
1356 ((_pEl)+1)
1357
1358#define VBOXVDMACMD_DMA_BPB_TRANSFER_VRAMSYS_SYS2VRAM 0x00000001
1359
1360typedef struct VBOXVDMACMD_DMA_BPB_TRANSFER_VRAMSYS
1361{
1362 uint32_t cTransferPages;
1363 uint32_t fFlags;
1364 VBOXVIDEOOFFSET offVramBuf;
1365 VBOXVDMACMD_SYSMEMEL FirstEl;
1366} VBOXVDMACMD_DMA_BPB_TRANSFER_VRAMSYS, *PVBOXVDMACMD_DMA_BPB_TRANSFER_VRAMSYS;
1367
1368typedef struct VBOXVDMACMD_DMA_BPB_FILL
1369{
1370 VBOXVIDEOOFFSET offSurf;
1371 uint32_t cbFillSize;
1372 uint32_t u32FillPattern;
1373} VBOXVDMACMD_DMA_BPB_FILL, *PVBOXVDMACMD_DMA_BPB_FILL;
1374
1375#define VBOXVDMA_CHILD_STATUS_F_CONNECTED 0x01
1376#define VBOXVDMA_CHILD_STATUS_F_DISCONNECTED 0x02
1377#define VBOXVDMA_CHILD_STATUS_F_ROTATED 0x04
1378
1379typedef struct VBOXVDMA_CHILD_STATUS
1380{
1381 uint32_t iChild;
1382 uint8_t fFlags;
1383 uint8_t u8RotationAngle;
1384 uint16_t u16Reserved;
1385} VBOXVDMA_CHILD_STATUS, *PVBOXVDMA_CHILD_STATUS;
1386
1387/* apply the aInfos are applied to all targets, the iTarget is ignored */
1388#define VBOXVDMACMD_CHILD_STATUS_IRQ_F_APPLY_TO_ALL 0x00000001
1389
1390typedef struct VBOXVDMACMD_CHILD_STATUS_IRQ
1391{
1392 uint32_t cInfos;
1393 uint32_t fFlags;
1394 VBOXVDMA_CHILD_STATUS aInfos[1];
1395} VBOXVDMACMD_CHILD_STATUS_IRQ, *PVBOXVDMACMD_CHILD_STATUS_IRQ;
1396
1397# pragma pack()
1398#endif /* #ifdef VBOX_WITH_VDMA */
1399
1400#ifdef VBOX_WITH_CRHGSMI
1401# pragma pack(1)
1402typedef struct VBOXVDMACMD_CHROMIUM_BUFFER
1403{
1404 VBOXVIDEOOFFSET offBuffer;
1405 uint32_t cbBuffer;
1406 uint32_t u32GuestData;
1407 uint64_t u64GuestData;
1408} VBOXVDMACMD_CHROMIUM_BUFFER, *PVBOXVDMACMD_CHROMIUM_BUFFER;
1409
1410typedef struct VBOXVDMACMD_CHROMIUM_CMD
1411{
1412 uint32_t cBuffers;
1413 uint32_t u32Reserved;
1414 VBOXVDMACMD_CHROMIUM_BUFFER aBuffers[1];
1415} VBOXVDMACMD_CHROMIUM_CMD, *PVBOXVDMACMD_CHROMIUM_CMD;
1416
1417typedef enum
1418{
1419 VBOXVDMACMD_CHROMIUM_CTL_TYPE_UNKNOWN = 0,
1420 VBOXVDMACMD_CHROMIUM_CTL_TYPE_CRHGSMI_SETUP,
1421 VBOXVDMACMD_CHROMIUM_CTL_TYPE_SAVESTATE_BEGIN,
1422 VBOXVDMACMD_CHROMIUM_CTL_TYPE_SAVESTATE_END,
1423 VBOXVDMACMD_CHROMIUM_CTL_TYPE_CRHGSMI_SETUP_COMPLETION,
1424 VBOXVDMACMD_CHROMIUM_CTL_TYPE_SIZEHACK = 0xfffffffe
1425} VBOXVDMACMD_CHROMIUM_CTL_TYPE;
1426
1427typedef struct VBOXVDMACMD_CHROMIUM_CTL
1428{
1429 VBOXVDMACMD_CHROMIUM_CTL_TYPE enmType;
1430 uint32_t cbCmd;
1431} VBOXVDMACMD_CHROMIUM_CTL, *PVBOXVDMACMD_CHROMIUM_CTL;
1432
1433typedef struct VBOXVDMACMD_CHROMIUM_CTL_CRHGSMI_SETUP
1434{
1435 VBOXVDMACMD_CHROMIUM_CTL Hdr;
1436 union
1437 {
1438 void *pvVRamBase;
1439 uint64_t uAlignment;
1440 };
1441 uint64_t cbVRam;
1442} VBOXVDMACMD_CHROMIUM_CTL_CRHGSMI_SETUP, *PVBOXVDMACMD_CHROMIUM_CTL_CRHGSMI_SETUP;
1443
1444typedef struct PDMIDISPLAYVBVACALLBACKS *HCRHGSMICMDCOMPLETION;
1445typedef DECLCALLBACK(int) FNCRHGSMICMDCOMPLETION(HCRHGSMICMDCOMPLETION hCompletion, PVBOXVDMACMD_CHROMIUM_CMD pCmd, int rc);
1446typedef FNCRHGSMICMDCOMPLETION *PFNCRHGSMICMDCOMPLETION;
1447
1448typedef struct VBOXVDMACMD_CHROMIUM_CTL_CRHGSMI_SETUP_COMPLETION
1449{
1450 VBOXVDMACMD_CHROMIUM_CTL Hdr;
1451 HCRHGSMICMDCOMPLETION hCompletion;
1452 PFNCRHGSMICMDCOMPLETION pfnCompletion;
1453} VBOXVDMACMD_CHROMIUM_CTL_CRHGSMI_SETUP_COMPLETION, *PVBOXVDMACMD_CHROMIUM_CTL_CRHGSMI_SETUP_COMPLETION;
1454# pragma pack()
1455#endif
1456
1457#ifdef VBOXVDMA_WITH_VBVA
1458# pragma pack(1)
1459
1460typedef struct VBOXVDMAVBVACMD
1461{
1462 HGSMIOFFSET offCmd;
1463} VBOXVDMAVBVACMD;
1464
1465#pragma pack()
1466#endif
1467
1468#endif
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette