VirtualBox

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

Last change on this file since 50677 was 50677, checked in by vboxsync, 11 years ago

wddm: misc bugfixes
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 55.1 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#define VBVA_CMDVBVA_ENABLE 15 /* enables command ring buffer VBVA */
856#define VBVA_CMDVBVA_SUBMIT 16 /* inform host about VBVA Command submission */
857#define VBVA_CMDVBVA_FLUSH 17 /* inform host about VBVA Command submission */
858#define VBVA_VBVACMD_CTL 18
859
860/* host->guest commands */
861#define VBVAHG_EVENT 1
862#define VBVAHG_DISPLAY_CUSTOM 2
863#ifdef VBOX_WITH_VDMA
864#define VBVAHG_SHGSMI_COMPLETION 3
865#endif
866
867#ifdef VBOX_WITH_VIDEOHWACCEL
868#define VBVAHG_DCUSTOM_VHWA_CMDCOMPLETE 1
869#pragma pack(1)
870typedef struct VBVAHOSTCMDVHWACMDCOMPLETE
871{
872 uint32_t offCmd;
873}VBVAHOSTCMDVHWACMDCOMPLETE;
874#pragma pack()
875#endif /* # ifdef VBOX_WITH_VIDEOHWACCEL */
876
877#pragma pack(1)
878typedef enum
879{
880 VBVAHOSTCMD_OP_EVENT = 1,
881 VBVAHOSTCMD_OP_CUSTOM
882}VBVAHOSTCMD_OP_TYPE;
883
884typedef struct VBVAHOSTCMDEVENT
885{
886 uint64_t pEvent;
887}VBVAHOSTCMDEVENT;
888
889
890typedef struct VBVAHOSTCMD
891{
892 /* destination ID if >=0 specifies display index, otherwize the command is directed to the miniport */
893 int32_t iDstID;
894 int32_t customOpCode;
895 union
896 {
897 struct VBVAHOSTCMD *pNext;
898 uint32_t offNext;
899 uint64_t Data; /* the body is 64-bit aligned */
900 } u;
901 char body[1];
902}VBVAHOSTCMD;
903
904#define VBVAHOSTCMD_SIZE(_size) (sizeof(VBVAHOSTCMD) + (_size))
905#define VBVAHOSTCMD_BODY(_pCmd, _tBody) ((_tBody*)(_pCmd)->body)
906#define VBVAHOSTCMD_HDR(_pBody) ((VBVAHOSTCMD*)(((uint8_t*)_pBody) - RT_OFFSETOF(VBVAHOSTCMD, body)))
907#define VBVAHOSTCMD_HDRSIZE (RT_OFFSETOF(VBVAHOSTCMD, body))
908
909#pragma pack()
910
911/* VBVACONF32::u32Index */
912#define VBOX_VBVA_CONF32_MONITOR_COUNT 0
913#define VBOX_VBVA_CONF32_HOST_HEAP_SIZE 1
914
915typedef struct VBVACONF32
916{
917 uint32_t u32Index;
918 uint32_t u32Value;
919} VBVACONF32;
920
921typedef struct VBVAINFOVIEW
922{
923 /* Index of the screen, assigned by the guest. */
924 uint32_t u32ViewIndex;
925
926 /* The screen offset in VRAM, the framebuffer starts here. */
927 uint32_t u32ViewOffset;
928
929 /* The size of the VRAM memory that can be used for the view. */
930 uint32_t u32ViewSize;
931
932 /* The recommended maximum size of the VRAM memory for the screen. */
933 uint32_t u32MaxScreenSize;
934} VBVAINFOVIEW;
935
936typedef struct VBVAINFOHEAP
937{
938 /* Absolute offset in VRAM of the start of the heap. */
939 uint32_t u32HeapOffset;
940
941 /* The size of the heap. */
942 uint32_t u32HeapSize;
943
944} VBVAINFOHEAP;
945
946typedef struct VBVAFLUSH
947{
948 uint32_t u32Reserved;
949
950} VBVAFLUSH;
951
952typedef struct VBVACMDVBVASUBMIT
953{
954 uint32_t u32Reserved;
955} VBVACMDVBVASUBMIT;
956
957/* flush is requested because due to guest command buffer overflow */
958#define VBVACMDVBVAFLUSH_F_GUEST_BUFFER_OVERFLOW 1
959
960typedef struct VBVACMDVBVAFLUSH
961{
962 uint32_t u32Flags;
963} VBVACMDVBVAFLUSH;
964
965
966/* VBVAINFOSCREEN::u8Flags */
967#define VBVA_SCREEN_F_NONE 0x0000
968#define VBVA_SCREEN_F_ACTIVE 0x0001
969/** The virtual monitor has been disabled by the guest and should be blacked
970 * out by the host and ignored for purposes of pointer position calculation. */
971#define VBVA_SCREEN_F_DISABLED 0x0002
972
973typedef struct VBVAINFOSCREEN
974{
975 /* Which view contains the screen. */
976 uint32_t u32ViewIndex;
977
978 /* Physical X origin relative to the primary screen. */
979 int32_t i32OriginX;
980
981 /* Physical Y origin relative to the primary screen. */
982 int32_t i32OriginY;
983
984 /* Offset of visible framebuffer relative to the framebuffer start. */
985 uint32_t u32StartOffset;
986
987 /* The scan line size in bytes. */
988 uint32_t u32LineSize;
989
990 /* Width of the screen. */
991 uint32_t u32Width;
992
993 /* Height of the screen. */
994 uint32_t u32Height;
995
996 /* Color depth. */
997 uint16_t u16BitsPerPixel;
998
999 /* VBVA_SCREEN_F_* */
1000 uint16_t u16Flags;
1001} VBVAINFOSCREEN;
1002
1003
1004/* VBVAENABLE::u32Flags */
1005#define VBVA_F_NONE 0x00000000
1006#define VBVA_F_ENABLE 0x00000001
1007#define VBVA_F_DISABLE 0x00000002
1008/* extended VBVA to be used with WDDM */
1009#define VBVA_F_EXTENDED 0x00000004
1010/* vbva offset is absolute VRAM offset */
1011#define VBVA_F_ABSOFFSET 0x00000008
1012
1013typedef struct VBVAENABLE
1014{
1015 uint32_t u32Flags;
1016 uint32_t u32Offset;
1017 int32_t i32Result;
1018} VBVAENABLE;
1019
1020typedef struct VBVAENABLE_EX
1021{
1022 VBVAENABLE Base;
1023 uint32_t u32ScreenId;
1024} VBVAENABLE_EX;
1025
1026
1027typedef struct VBVAMOUSEPOINTERSHAPE
1028{
1029 /* The host result. */
1030 int32_t i32Result;
1031
1032 /* VBOX_MOUSE_POINTER_* bit flags. */
1033 uint32_t fu32Flags;
1034
1035 /* X coordinate of the hot spot. */
1036 uint32_t u32HotX;
1037
1038 /* Y coordinate of the hot spot. */
1039 uint32_t u32HotY;
1040
1041 /* Width of the pointer in pixels. */
1042 uint32_t u32Width;
1043
1044 /* Height of the pointer in scanlines. */
1045 uint32_t u32Height;
1046
1047 /* Pointer data.
1048 *
1049 ****
1050 * The data consists of 1 bpp AND mask followed by 32 bpp XOR (color) mask.
1051 *
1052 * For pointers without alpha channel the XOR mask pixels are 32 bit values: (lsb)BGR0(msb).
1053 * For pointers with alpha channel the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
1054 *
1055 * Guest driver must create the AND mask for pointers with alpha channel, so if host does not
1056 * support alpha, the pointer could be displayed as a normal color pointer. The AND mask can
1057 * be constructed from alpha values. For example alpha value >= 0xf0 means bit 0 in the AND mask.
1058 *
1059 * The AND mask is 1 bpp bitmap with byte aligned scanlines. Size of AND mask,
1060 * therefore, is cbAnd = (width + 7) / 8 * height. The padding bits at the
1061 * end of any scanline are undefined.
1062 *
1063 * The XOR mask follows the AND mask on the next 4 bytes aligned offset:
1064 * uint8_t *pXor = pAnd + (cbAnd + 3) & ~3
1065 * Bytes in the gap between the AND and the XOR mask are undefined.
1066 * XOR mask scanlines have no gap between them and size of XOR mask is:
1067 * cXor = width * 4 * height.
1068 ****
1069 *
1070 * Preallocate 4 bytes for accessing actual data as p->au8Data.
1071 */
1072 uint8_t au8Data[4];
1073
1074} VBVAMOUSEPOINTERSHAPE;
1075
1076/* the guest driver can handle asynch guest cmd completion by reading the command offset from io port */
1077#define VBVACAPS_COMPLETEGCMD_BY_IOREAD 0x00000001
1078/* the guest driver can handle video adapter IRQs */
1079#define VBVACAPS_IRQ 0x00000002
1080typedef struct VBVACAPS
1081{
1082 int32_t rc;
1083 uint32_t fCaps;
1084} VBVACAPS;
1085
1086/* makes graphics device generate IRQ on VSYNC */
1087#define VBVASCANLINECFG_ENABLE_VSYNC_IRQ 0x00000001
1088/* guest driver may request the current scanline */
1089#define VBVASCANLINECFG_ENABLE_SCANLINE_INFO 0x00000002
1090/* request the current refresh period, returned in u32RefreshPeriodMs */
1091#define VBVASCANLINECFG_QUERY_REFRESH_PERIOD 0x00000004
1092/* set new refresh period specified in u32RefreshPeriodMs.
1093 * if used with VBVASCANLINECFG_QUERY_REFRESH_PERIOD,
1094 * u32RefreshPeriodMs is set to the previous refresh period on return */
1095#define VBVASCANLINECFG_SET_REFRESH_PERIOD 0x00000008
1096
1097typedef struct VBVASCANLINECFG
1098{
1099 int32_t rc;
1100 uint32_t fFlags;
1101 uint32_t u32RefreshPeriodMs;
1102 uint32_t u32Reserved;
1103} VBVASCANLINECFG;
1104
1105typedef struct VBVASCANLINEINFO
1106{
1107 int32_t rc;
1108 uint32_t u32ScreenId;
1109 uint32_t u32InVBlank;
1110 uint32_t u32ScanLine;
1111} VBVASCANLINEINFO;
1112
1113#pragma pack()
1114
1115typedef uint64_t VBOXVIDEOOFFSET;
1116
1117#define VBOXVIDEOOFFSET_VOID ((VBOXVIDEOOFFSET)~0)
1118
1119#pragma pack(1)
1120
1121/*
1122 * VBOXSHGSMI made on top HGSMI and allows receiving notifications
1123 * about G->H command completion
1124 */
1125/* SHGSMI command header */
1126typedef struct VBOXSHGSMIHEADER
1127{
1128 uint64_t pvNext; /*<- completion processing queue */
1129 uint32_t fFlags; /*<- see VBOXSHGSMI_FLAG_XXX Flags */
1130 uint32_t cRefs; /*<- command referece count */
1131 uint64_t u64Info1; /*<- contents depends on the fFlags value */
1132 uint64_t u64Info2; /*<- contents depends on the fFlags value */
1133} VBOXSHGSMIHEADER, *PVBOXSHGSMIHEADER;
1134
1135typedef enum
1136{
1137 VBOXVDMACMD_TYPE_UNDEFINED = 0,
1138 VBOXVDMACMD_TYPE_DMA_PRESENT_BLT = 1,
1139 VBOXVDMACMD_TYPE_DMA_BPB_TRANSFER,
1140 VBOXVDMACMD_TYPE_DMA_BPB_FILL,
1141 VBOXVDMACMD_TYPE_DMA_PRESENT_SHADOW2PRIMARY,
1142 VBOXVDMACMD_TYPE_DMA_PRESENT_CLRFILL,
1143 VBOXVDMACMD_TYPE_DMA_PRESENT_FLIP,
1144 VBOXVDMACMD_TYPE_DMA_NOP,
1145 VBOXVDMACMD_TYPE_CHROMIUM_CMD, /* chromium cmd */
1146 VBOXVDMACMD_TYPE_DMA_BPB_TRANSFER_VRAMSYS,
1147 VBOXVDMACMD_TYPE_CHILD_STATUS_IRQ /* make the device notify child (monitor) state change IRQ */
1148} VBOXVDMACMD_TYPE;
1149
1150#pragma pack()
1151
1152/* the command processing was asynch, set by the host to indicate asynch command completion
1153 * must not be cleared once set, the command completion is performed by issuing a host->guest completion command
1154 * while keeping this flag unchanged */
1155#define VBOXSHGSMI_FLAG_HG_ASYNCH 0x00010000
1156#if 0
1157/* if set - asynch completion is performed by issuing the event,
1158 * if cleared - asynch completion is performed by calling a callback */
1159#define VBOXSHGSMI_FLAG_GH_ASYNCH_EVENT 0x00000001
1160#endif
1161/* issue interrupt on asynch completion, used for critical G->H commands,
1162 * i.e. for completion of which guest is waiting. */
1163#define VBOXSHGSMI_FLAG_GH_ASYNCH_IRQ 0x00000002
1164/* guest does not do any op on completion of this command,
1165 * the host may copy the command and indicate that it does not need the command anymore
1166 * by not setting VBOXSHGSMI_FLAG_HG_ASYNCH */
1167#define VBOXSHGSMI_FLAG_GH_ASYNCH_NOCOMPLETION 0x00000004
1168/* guest requires the command to be processed asynchronously,
1169 * not setting VBOXSHGSMI_FLAG_HG_ASYNCH by the host in this case is treated as command failure */
1170#define VBOXSHGSMI_FLAG_GH_ASYNCH_FORCE 0x00000008
1171/* force IRQ on cmd completion */
1172#define VBOXSHGSMI_FLAG_GH_ASYNCH_IRQ_FORCE 0x00000010
1173/* an IRQ-level callback is associated with the command */
1174#define VBOXSHGSMI_FLAG_GH_ASYNCH_CALLBACK_IRQ 0x00000020
1175/* guest expects this command to be completed synchronously */
1176#define VBOXSHGSMI_FLAG_GH_SYNCH 0x00000040
1177
1178
1179DECLINLINE(uint8_t *) VBoxSHGSMIBufferData (const VBOXSHGSMIHEADER* pHeader)
1180{
1181 return (uint8_t *)pHeader + sizeof (VBOXSHGSMIHEADER);
1182}
1183
1184#define VBoxSHGSMIBufferHeaderSize() (sizeof (VBOXSHGSMIHEADER))
1185
1186DECLINLINE(PVBOXSHGSMIHEADER) VBoxSHGSMIBufferHeader (const void *pvData)
1187{
1188 return (PVBOXSHGSMIHEADER)((uint8_t *)pvData - sizeof (VBOXSHGSMIHEADER));
1189}
1190
1191#ifdef VBOX_WITH_VDMA
1192# pragma pack(1)
1193
1194/* VDMA - Video DMA */
1195
1196/* VDMA Control API */
1197/* VBOXVDMA_CTL::u32Flags */
1198typedef enum
1199{
1200 VBOXVDMA_CTL_TYPE_NONE = 0,
1201 VBOXVDMA_CTL_TYPE_ENABLE,
1202 VBOXVDMA_CTL_TYPE_DISABLE,
1203 VBOXVDMA_CTL_TYPE_FLUSH,
1204 VBOXVDMA_CTL_TYPE_WATCHDOG
1205} VBOXVDMA_CTL_TYPE;
1206
1207typedef struct VBOXVDMA_CTL
1208{
1209 VBOXVDMA_CTL_TYPE enmCtl;
1210 uint32_t u32Offset;
1211 int32_t i32Result;
1212} VBOXVDMA_CTL, *PVBOXVDMA_CTL;
1213
1214typedef struct VBOXVDMA_RECTL
1215{
1216 int16_t left;
1217 int16_t top;
1218 uint16_t width;
1219 uint16_t height;
1220} VBOXVDMA_RECTL, *PVBOXVDMA_RECTL;
1221
1222typedef enum
1223{
1224 VBOXVDMA_PIXEL_FORMAT_UNKNOWN = 0,
1225 VBOXVDMA_PIXEL_FORMAT_R8G8B8 = 20,
1226 VBOXVDMA_PIXEL_FORMAT_A8R8G8B8 = 21,
1227 VBOXVDMA_PIXEL_FORMAT_X8R8G8B8 = 22,
1228 VBOXVDMA_PIXEL_FORMAT_R5G6B5 = 23,
1229 VBOXVDMA_PIXEL_FORMAT_X1R5G5B5 = 24,
1230 VBOXVDMA_PIXEL_FORMAT_A1R5G5B5 = 25,
1231 VBOXVDMA_PIXEL_FORMAT_A4R4G4B4 = 26,
1232 VBOXVDMA_PIXEL_FORMAT_R3G3B2 = 27,
1233 VBOXVDMA_PIXEL_FORMAT_A8 = 28,
1234 VBOXVDMA_PIXEL_FORMAT_A8R3G3B2 = 29,
1235 VBOXVDMA_PIXEL_FORMAT_X4R4G4B4 = 30,
1236 VBOXVDMA_PIXEL_FORMAT_A2B10G10R10 = 31,
1237 VBOXVDMA_PIXEL_FORMAT_A8B8G8R8 = 32,
1238 VBOXVDMA_PIXEL_FORMAT_X8B8G8R8 = 33,
1239 VBOXVDMA_PIXEL_FORMAT_G16R16 = 34,
1240 VBOXVDMA_PIXEL_FORMAT_A2R10G10B10 = 35,
1241 VBOXVDMA_PIXEL_FORMAT_A16B16G16R16 = 36,
1242 VBOXVDMA_PIXEL_FORMAT_A8P8 = 40,
1243 VBOXVDMA_PIXEL_FORMAT_P8 = 41,
1244 VBOXVDMA_PIXEL_FORMAT_L8 = 50,
1245 VBOXVDMA_PIXEL_FORMAT_A8L8 = 51,
1246 VBOXVDMA_PIXEL_FORMAT_A4L4 = 52,
1247 VBOXVDMA_PIXEL_FORMAT_V8U8 = 60,
1248 VBOXVDMA_PIXEL_FORMAT_L6V5U5 = 61,
1249 VBOXVDMA_PIXEL_FORMAT_X8L8V8U8 = 62,
1250 VBOXVDMA_PIXEL_FORMAT_Q8W8V8U8 = 63,
1251 VBOXVDMA_PIXEL_FORMAT_V16U16 = 64,
1252 VBOXVDMA_PIXEL_FORMAT_W11V11U10 = 65,
1253 VBOXVDMA_PIXEL_FORMAT_A2W10V10U10 = 67
1254} VBOXVDMA_PIXEL_FORMAT;
1255
1256typedef struct VBOXVDMA_SURF_DESC
1257{
1258 uint32_t width;
1259 uint32_t height;
1260 VBOXVDMA_PIXEL_FORMAT format;
1261 uint32_t bpp;
1262 uint32_t pitch;
1263 uint32_t fFlags;
1264} VBOXVDMA_SURF_DESC, *PVBOXVDMA_SURF_DESC;
1265
1266/*typedef uint64_t VBOXVDMAPHADDRESS;*/
1267typedef uint64_t VBOXVDMASURFHANDLE;
1268
1269/* region specified as a rectangle, otherwize it is a size of memory pointed to by phys address */
1270#define VBOXVDMAOPERAND_FLAGS_RECTL 0x1
1271/* Surface handle is valid */
1272#define VBOXVDMAOPERAND_FLAGS_PRIMARY 0x2
1273/* address is offset in VRAM */
1274#define VBOXVDMAOPERAND_FLAGS_VRAMOFFSET 0x4
1275
1276
1277/* VBOXVDMACBUF_DR::phBuf specifies offset in VRAM */
1278#define VBOXVDMACBUF_FLAG_BUF_VRAM_OFFSET 0x00000001
1279/* command buffer follows the VBOXVDMACBUF_DR in VRAM, VBOXVDMACBUF_DR::phBuf is ignored */
1280#define VBOXVDMACBUF_FLAG_BUF_FOLLOWS_DR 0x00000002
1281
1282/*
1283 * We can not submit the DMA command via VRAM since we do not have control over
1284 * DMA command buffer [de]allocation, i.e. we only control the buffer contents.
1285 * In other words the system may call one of our callbacks to fill a command buffer
1286 * with the necessary commands and then discard the buffer w/o any notification.
1287 *
1288 * We have only DMA command buffer physical address at submission time.
1289 *
1290 * so the only way is to */
1291typedef struct VBOXVDMACBUF_DR
1292{
1293 uint16_t fFlags;
1294 uint16_t cbBuf;
1295 /* RT_SUCCESS() - on success
1296 * VERR_INTERRUPTED - on preemption
1297 * VERR_xxx - on error */
1298 int32_t rc;
1299 union
1300 {
1301 uint64_t phBuf;
1302 VBOXVIDEOOFFSET offVramBuf;
1303 } Location;
1304 uint64_t aGuestData[7];
1305} VBOXVDMACBUF_DR, *PVBOXVDMACBUF_DR;
1306
1307#define VBOXVDMACBUF_DR_TAIL(_pCmd, _t) ( (_t*)(((uint8_t*)(_pCmd)) + sizeof (VBOXVDMACBUF_DR)) )
1308#define VBOXVDMACBUF_DR_FROM_TAIL(_pCmd) ( (VBOXVDMACBUF_DR*)(((uint8_t*)(_pCmd)) - sizeof (VBOXVDMACBUF_DR)) )
1309
1310typedef struct VBOXVDMACMD
1311{
1312 VBOXVDMACMD_TYPE enmType;
1313 uint32_t u32CmdSpecific;
1314} VBOXVDMACMD, *PVBOXVDMACMD;
1315
1316#define VBOXVDMACMD_HEADER_SIZE() sizeof (VBOXVDMACMD)
1317#define VBOXVDMACMD_SIZE_FROMBODYSIZE(_s) (VBOXVDMACMD_HEADER_SIZE() + (_s))
1318#define VBOXVDMACMD_SIZE(_t) (VBOXVDMACMD_SIZE_FROMBODYSIZE(sizeof (_t)))
1319#define VBOXVDMACMD_BODY(_pCmd, _t) ( (_t*)(((uint8_t*)(_pCmd)) + VBOXVDMACMD_HEADER_SIZE()) )
1320#define VBOXVDMACMD_BODY_SIZE(_s) ( (_s) - VBOXVDMACMD_HEADER_SIZE() )
1321#define VBOXVDMACMD_FROM_BODY(_pCmd) ( (VBOXVDMACMD*)(((uint8_t*)(_pCmd)) - VBOXVDMACMD_HEADER_SIZE()) )
1322#define VBOXVDMACMD_BODY_FIELD_OFFSET(_ot, _t, _f) ( (_ot)(uintptr_t)( VBOXVDMACMD_BODY(0, uint8_t) + RT_OFFSETOF(_t, _f) ) )
1323
1324typedef struct VBOXVDMACMD_DMA_PRESENT_BLT
1325{
1326 VBOXVIDEOOFFSET offSrc;
1327 VBOXVIDEOOFFSET offDst;
1328 VBOXVDMA_SURF_DESC srcDesc;
1329 VBOXVDMA_SURF_DESC dstDesc;
1330 VBOXVDMA_RECTL srcRectl;
1331 VBOXVDMA_RECTL dstRectl;
1332 uint32_t u32Reserved;
1333 uint32_t cDstSubRects;
1334 VBOXVDMA_RECTL aDstSubRects[1];
1335} VBOXVDMACMD_DMA_PRESENT_BLT, *PVBOXVDMACMD_DMA_PRESENT_BLT;
1336
1337typedef struct VBOXVDMACMD_DMA_PRESENT_SHADOW2PRIMARY
1338{
1339 VBOXVDMA_RECTL Rect;
1340} VBOXVDMACMD_DMA_PRESENT_SHADOW2PRIMARY, *PVBOXVDMACMD_DMA_PRESENT_SHADOW2PRIMARY;
1341
1342
1343#define VBOXVDMACMD_DMA_BPB_TRANSFER_F_SRC_VRAMOFFSET 0x00000001
1344#define VBOXVDMACMD_DMA_BPB_TRANSFER_F_DST_VRAMOFFSET 0x00000002
1345
1346typedef struct VBOXVDMACMD_DMA_BPB_TRANSFER
1347{
1348 uint32_t cbTransferSize;
1349 uint32_t fFlags;
1350 union
1351 {
1352 uint64_t phBuf;
1353 VBOXVIDEOOFFSET offVramBuf;
1354 } Src;
1355 union
1356 {
1357 uint64_t phBuf;
1358 VBOXVIDEOOFFSET offVramBuf;
1359 } Dst;
1360} VBOXVDMACMD_DMA_BPB_TRANSFER, *PVBOXVDMACMD_DMA_BPB_TRANSFER;
1361
1362#define VBOXVDMACMD_SYSMEMEL_F_PAGELIST 0x00000001
1363
1364typedef struct VBOXVDMACMD_SYSMEMEL
1365{
1366 uint32_t cPages;
1367 uint32_t fFlags;
1368 uint64_t phBuf[1];
1369} VBOXVDMACMD_SYSMEMEL, *PVBOXVDMACMD_SYSMEMEL;
1370
1371#define VBOXVDMACMD_SYSMEMEL_NEXT(_pEl) (((_pEl)->fFlags & VBOXVDMACMD_SYSMEMEL_F_PAGELIST) ? \
1372 ((PVBOXVDMACMD_SYSMEMEL)(((uint8_t*)(_pEl))+RT_OFFSETOF(VBOXVDMACMD_SYSMEMEL, phBuf[(_pEl)->cPages]))) \
1373 : \
1374 ((_pEl)+1)
1375
1376#define VBOXVDMACMD_DMA_BPB_TRANSFER_VRAMSYS_SYS2VRAM 0x00000001
1377
1378typedef struct VBOXVDMACMD_DMA_BPB_TRANSFER_VRAMSYS
1379{
1380 uint32_t cTransferPages;
1381 uint32_t fFlags;
1382 VBOXVIDEOOFFSET offVramBuf;
1383 VBOXVDMACMD_SYSMEMEL FirstEl;
1384} VBOXVDMACMD_DMA_BPB_TRANSFER_VRAMSYS, *PVBOXVDMACMD_DMA_BPB_TRANSFER_VRAMSYS;
1385
1386typedef struct VBOXVDMACMD_DMA_BPB_FILL
1387{
1388 VBOXVIDEOOFFSET offSurf;
1389 uint32_t cbFillSize;
1390 uint32_t u32FillPattern;
1391} VBOXVDMACMD_DMA_BPB_FILL, *PVBOXVDMACMD_DMA_BPB_FILL;
1392
1393#define VBOXVDMA_CHILD_STATUS_F_CONNECTED 0x01
1394#define VBOXVDMA_CHILD_STATUS_F_DISCONNECTED 0x02
1395#define VBOXVDMA_CHILD_STATUS_F_ROTATED 0x04
1396
1397typedef struct VBOXVDMA_CHILD_STATUS
1398{
1399 uint32_t iChild;
1400 uint8_t fFlags;
1401 uint8_t u8RotationAngle;
1402 uint16_t u16Reserved;
1403} VBOXVDMA_CHILD_STATUS, *PVBOXVDMA_CHILD_STATUS;
1404
1405/* apply the aInfos are applied to all targets, the iTarget is ignored */
1406#define VBOXVDMACMD_CHILD_STATUS_IRQ_F_APPLY_TO_ALL 0x00000001
1407
1408typedef struct VBOXVDMACMD_CHILD_STATUS_IRQ
1409{
1410 uint32_t cInfos;
1411 uint32_t fFlags;
1412 VBOXVDMA_CHILD_STATUS aInfos[1];
1413} VBOXVDMACMD_CHILD_STATUS_IRQ, *PVBOXVDMACMD_CHILD_STATUS_IRQ;
1414
1415# pragma pack()
1416#endif /* #ifdef VBOX_WITH_VDMA */
1417
1418#ifdef VBOX_WITH_CRHGSMI
1419# pragma pack(1)
1420typedef struct VBOXVDMACMD_CHROMIUM_BUFFER
1421{
1422 VBOXVIDEOOFFSET offBuffer;
1423 uint32_t cbBuffer;
1424 uint32_t u32GuestData;
1425 uint64_t u64GuestData;
1426} VBOXVDMACMD_CHROMIUM_BUFFER, *PVBOXVDMACMD_CHROMIUM_BUFFER;
1427
1428typedef struct VBOXVDMACMD_CHROMIUM_CMD
1429{
1430 uint32_t cBuffers;
1431 uint32_t u32Reserved;
1432 VBOXVDMACMD_CHROMIUM_BUFFER aBuffers[1];
1433} VBOXVDMACMD_CHROMIUM_CMD, *PVBOXVDMACMD_CHROMIUM_CMD;
1434
1435typedef enum
1436{
1437 VBOXVDMACMD_CHROMIUM_CTL_TYPE_UNKNOWN = 0,
1438 VBOXVDMACMD_CHROMIUM_CTL_TYPE_CRHGSMI_SETUP,
1439 VBOXVDMACMD_CHROMIUM_CTL_TYPE_SAVESTATE_BEGIN,
1440 VBOXVDMACMD_CHROMIUM_CTL_TYPE_SAVESTATE_END,
1441 VBOXVDMACMD_CHROMIUM_CTL_TYPE_CRHGSMI_SETUP_MAINCB,
1442 VBOXVDMACMD_CHROMIUM_CTL_TYPE_CRCONNECT,
1443 VBOXVDMACMD_CHROMIUM_CTL_TYPE_SIZEHACK = 0xfffffffe
1444} VBOXVDMACMD_CHROMIUM_CTL_TYPE;
1445
1446typedef struct VBOXVDMACMD_CHROMIUM_CTL
1447{
1448 VBOXVDMACMD_CHROMIUM_CTL_TYPE enmType;
1449 uint32_t cbCmd;
1450} VBOXVDMACMD_CHROMIUM_CTL, *PVBOXVDMACMD_CHROMIUM_CTL;
1451
1452typedef struct VBOXVDMACMD_CHROMIUM_CTL_CRHGSMI_SETUP
1453{
1454 VBOXVDMACMD_CHROMIUM_CTL Hdr;
1455 union
1456 {
1457 void *pvVRamBase;
1458 uint64_t uAlignment;
1459 };
1460 uint64_t cbVRam;
1461 struct VBOXCRCMD_CLTINFO *pCrCmdClientInfo;
1462} VBOXVDMACMD_CHROMIUM_CTL_CRHGSMI_SETUP, *PVBOXVDMACMD_CHROMIUM_CTL_CRHGSMI_SETUP;
1463
1464
1465typedef struct PDMIDISPLAYVBVACALLBACKS *HCRHGSMICMDCOMPLETION;
1466typedef DECLCALLBACK(int) FNCRHGSMICMDCOMPLETION(HCRHGSMICMDCOMPLETION hCompletion, PVBOXVDMACMD_CHROMIUM_CMD pCmd, int rc);
1467typedef FNCRHGSMICMDCOMPLETION *PFNCRHGSMICMDCOMPLETION;
1468
1469typedef DECLCALLBACK(bool) FNCROGLHASDATA();
1470typedef FNCROGLHASDATA *PFNCROGLHASDATA;
1471
1472/* callbacks chrogl gives to main */
1473typedef struct CR_MAIN_INTERFACE
1474{
1475 PFNCROGLHASDATA pfnHasData;
1476} CR_MAIN_INTERFACE;
1477
1478typedef struct VBOXVDMACMD_CHROMIUM_CTL_CRHGSMI_SETUP_MAINCB
1479{
1480 VBOXVDMACMD_CHROMIUM_CTL Hdr;
1481 /*in*/
1482 HCRHGSMICMDCOMPLETION hCompletion;
1483 PFNCRHGSMICMDCOMPLETION pfnCompletion;
1484 /*out*/
1485 CR_MAIN_INTERFACE MainInterface;
1486} VBOXVDMACMD_CHROMIUM_CTL_CRHGSMI_SETUP_MAINCB, *PVBOXVDMACMD_CHROMIUM_CTL_CRHGSMI_SETUP_MAINCB;
1487
1488typedef struct VBOXCRCON_SERVER *HVBOXCRCON_SERVER;
1489typedef struct PDMIDISPLAYVBVACALLBACKS* HVBOXCRCON_CLIENT;
1490
1491typedef struct VBOXCRCON_3DRGN_CLIENT* HVBOXCRCON_3DRGN_CLIENT;
1492typedef struct VBOXCRCON_3DRGN_ASYNCCLIENT* HVBOXCRCON_3DRGN_ASYNCCLIENT;
1493
1494/* server callbacks */
1495/* submit chromium cmd */
1496typedef DECLCALLBACK(int) FNVBOXCRCON_SVR_CRCMD(HVBOXCRCON_SERVER hServer, PVBOXVDMACMD_CHROMIUM_CMD pCmd, uint32_t cbCmd);
1497typedef FNVBOXCRCON_SVR_CRCMD *PFNVBOXCRCON_SVR_CRCMD;
1498
1499/* submit chromium control cmd */
1500typedef DECLCALLBACK(int) FNVBOXCRCON_SVR_CRCTL(HVBOXCRCON_SERVER hServer, PVBOXVDMACMD_CHROMIUM_CTL pCtl, uint32_t cbCmd);
1501typedef FNVBOXCRCON_SVR_CRCTL *PFNVBOXCRCON_SVR_CRCTL;
1502
1503/* request 3D data.
1504 * The protocol is the following:
1505 * 1. if there is no 3D data displayed on screen, returns VINF_EOF immediately w/o calling any PFNVBOXCRCON_3DRGN_XXX callbacks
1506 * 2. otherwise calls PFNVBOXCRCON_3DRGN_ONSUBMIT, submits the "regions get" request to the CrOpenGL server to process it asynchronously and returns VINF_SUCCESS
1507 * 2.a on "regions get" request processing calls PFNVBOXCRCON_3DRGN_BEGIN,
1508 * 2.b then PFNVBOXCRCON_3DRGN_REPORT zero or more times for each 3D region,
1509 * 2.c and then PFNVBOXCRCON_3DRGN_END
1510 * 3. returns VERR_XXX code on failure
1511 * */
1512typedef DECLCALLBACK(int) FNVBOXCRCON_SVR_3DRGN_GET(HVBOXCRCON_SERVER hServer, HVBOXCRCON_3DRGN_CLIENT hRgnClient, uint32_t idScreen);
1513typedef FNVBOXCRCON_SVR_3DRGN_GET *PFNVBOXCRCON_SVR_3DRGN_GET;
1514
1515/* 3D Regions Client callbacks */
1516/* called from the PFNVBOXCRCON_SVR_3DRGN_GET callback in case server has 3D data and is going to process the request asynchronously,
1517 * see comments for PFNVBOXCRCON_SVR_3DRGN_GET above */
1518typedef DECLCALLBACK(int) FNVBOXCRCON_3DRGN_ONSUBMIT(HVBOXCRCON_3DRGN_CLIENT hRgnClient, uint32_t idScreen, HVBOXCRCON_3DRGN_ASYNCCLIENT *phRgnAsyncClient);
1519typedef FNVBOXCRCON_3DRGN_ONSUBMIT *PFNVBOXCRCON_3DRGN_ONSUBMIT;
1520
1521/* called from the "regions get" command processing thread, to indicate that the "regions get" is started.
1522 * see comments for PFNVBOXCRCON_SVR_3DRGN_GET above */
1523typedef DECLCALLBACK(int) FNVBOXCRCON_3DRGN_BEGIN(HVBOXCRCON_3DRGN_ASYNCCLIENT hRgnAsyncClient, uint32_t idScreen);
1524typedef FNVBOXCRCON_3DRGN_BEGIN *PFNVBOXCRCON_3DRGN_BEGIN;
1525
1526/* called from the "regions get" command processing thread, to report a 3D region.
1527 * see comments for PFNVBOXCRCON_SVR_3DRGN_GET above */
1528typedef DECLCALLBACK(int) FNVBOXCRCON_3DRGN_REPORT(HVBOXCRCON_3DRGN_ASYNCCLIENT hRgnAsyncClient, uint32_t idScreen, void *pvData, uint32_t cbStride, const RTRECT *pRect);
1529typedef FNVBOXCRCON_3DRGN_REPORT *PFNVBOXCRCON_3DRGN_REPORT;
1530
1531/* called from the "regions get" command processing thread, to indicate that the "regions get" is completed.
1532 * see comments for PFNVBOXCRCON_SVR_3DRGN_GET above */
1533typedef DECLCALLBACK(int) FNVBOXCRCON_3DRGN_END(HVBOXCRCON_3DRGN_ASYNCCLIENT hRgnAsyncClient, uint32_t idScreen);
1534typedef FNVBOXCRCON_3DRGN_END *PFNVBOXCRCON_3DRGN_END;
1535
1536
1537/* client callbacks */
1538/* complete chromium cmd */
1539typedef DECLCALLBACK(int) FNVBOXCRCON_CLT_CRCTL_COMPLETE(HVBOXCRCON_CLIENT hClient, PVBOXVDMACMD_CHROMIUM_CTL pCtl, int rc);
1540typedef FNVBOXCRCON_CLT_CRCTL_COMPLETE *PFNVBOXCRCON_CLT_CRCTL_COMPLETE;
1541
1542/* complete chromium control cmd */
1543typedef DECLCALLBACK(int) FNVBOXCRCON_CLT_CRCMD_COMPLETE(HVBOXCRCON_CLIENT hClient, PVBOXVDMACMD_CHROMIUM_CMD pCmd, int rc);
1544typedef FNVBOXCRCON_CLT_CRCMD_COMPLETE *PFNVBOXCRCON_CLT_CRCMD_COMPLETE;
1545
1546typedef struct VBOXCRCON_SERVER_CALLBACKS
1547{
1548 HVBOXCRCON_SERVER hServer;
1549 PFNVBOXCRCON_SVR_CRCMD pfnCrCmd;
1550 PFNVBOXCRCON_SVR_CRCTL pfnCrCtl;
1551 PFNVBOXCRCON_SVR_3DRGN_GET pfn3DRgnGet;
1552} VBOXCRCON_SERVER_CALLBACKS, *PVBOXCRCON_SERVER_CALLBACKS;
1553
1554typedef struct VBOXCRCON_CLIENT_CALLBACKS
1555{
1556 HVBOXCRCON_CLIENT hClient;
1557 PFNVBOXCRCON_CLT_CRCMD_COMPLETE pfnCrCmdComplete;
1558 PFNVBOXCRCON_CLT_CRCTL_COMPLETE pfnCrCtlComplete;
1559 PFNVBOXCRCON_3DRGN_ONSUBMIT pfn3DRgnOnSubmit;
1560 PFNVBOXCRCON_3DRGN_BEGIN pfn3DRgnBegin;
1561 PFNVBOXCRCON_3DRGN_REPORT pfn3DRgnReport;
1562 PFNVBOXCRCON_3DRGN_END pfn3DRgnEnd;
1563} VBOXCRCON_CLIENT_CALLBACKS, *PVBOXCRCON_CLIENT_CALLBACKS;
1564
1565/* issued by Main to establish connection between Main and CrOpenGL service */
1566typedef struct VBOXVDMACMD_CHROMIUM_CTL_CRCONNECT
1567{
1568 VBOXVDMACMD_CHROMIUM_CTL Hdr;
1569 /*input (filled by Client) :*/
1570 /*class VMMDev*/void *pVMMDev;
1571 VBOXCRCON_CLIENT_CALLBACKS ClientCallbacks;
1572 /*output (filled by Server) :*/
1573 VBOXCRCON_SERVER_CALLBACKS ServerCallbacks;
1574} VBOXVDMACMD_CHROMIUM_CTL_CRCONNECT, *PVBOXVDMACMD_CHROMIUM_CTL_CRCONNECT;
1575
1576/* ring command buffer dr */
1577#define VBOXCMDVBVA_STATE_SUBMITTED 1
1578#define VBOXCMDVBVA_STATE_CANCELLED 2
1579#define VBOXCMDVBVA_STATE_IN_PROGRESS 3
1580/* the "completed" state is signalled via the ring buffer values */
1581
1582/* CrHgsmi command */
1583#define VBOXCMDVBVA_OPTYPE_CRCMD 1
1584/* blit command that does blitting of allocations identified by VRAM offset or host id
1585 * for VRAM-offset ones the size and format are same as primary */
1586#define VBOXCMDVBVA_OPTYPE_BLT_OFFPRIMSZFMT_OR_ID 2
1587/* flip */
1588#define VBOXCMDVBVA_OPTYPE_FLIP 3
1589/* ColorFill */
1590#define VBOXCMDVBVA_OPTYPE_CLRFILL 4
1591/* allocation paging transfer request */
1592#define VBOXCMDVBVA_OPTYPE_PAGING_TRANSFER 5
1593/* allocation paging fill request */
1594#define VBOXCMDVBVA_OPTYPE_PAGING_FILL 6
1595/* same as VBOXCMDVBVA_OPTYPE_NOP, but contains VBOXCMDVBVA_HDR data */
1596#define VBOXCMDVBVA_OPTYPE_NOPCMD 7
1597
1598/* nop - is a one-bit command. The buffer size to skip is determined by VBVA buffer size */
1599#define VBOXCMDVBVA_OPTYPE_NOP 0x80
1600
1601/* u8Flags flags */
1602/* source allocation is specified with the host id. if not set - source allocation is specified with VRAM offset */
1603#define VBOXCMDVBVA_OPF_ALLOC_SRCID 0x80
1604/* destination allocation is specified with the host id. if not set - destination allocation is specified with VRAM offset */
1605#define VBOXCMDVBVA_OPF_ALLOC_DSTID 0x40
1606
1607/* transfer from RAM to Allocation */
1608#define VBOXCMDVBVA_OPF_PAGING_TRANSFER_IN 0x20
1609
1610/* VBOXCMDVBVA_OPTYPE_BLT_PRIMARY specific flags*/
1611/* if set - src is a primary id */
1612#define VBOXCMDVBVA_OPF_ALLOC_SRCPRIMARY 0x20
1613/* if set - dst is a primary id */
1614#define VBOXCMDVBVA_OPF_ALLOC_DSTPRIMARY 0x10
1615
1616
1617/* trying to make the header as small as possible,
1618 * we'd have pretty few op codes actually, so 8bit is quite enough,
1619 * we will be able to extend it in any way. */
1620typedef struct VBOXCMDVBVA_HDR
1621{
1622 /* one VBOXCMDVBVA_OPTYPE_XXX, except NOP, see comments above */
1623 uint8_t u8OpCode;
1624 /* command-specific
1625 * VBOXCMDVBVA_OPTYPE_CRCMD - must be null
1626 * VBOXCMDVBVA_OPTYPE_BLT_PRIMARY - OR-ed VBOXCMDVBVA_OPF_ALLOC_XXX flags
1627 * VBOXCMDVBVA_OPTYPE_BLT_OFFPRIMSZFMT_OR_ID - OR-ed VBOXCMDVBVA_OPF_ALLOC_XXX flags
1628 * VBOXCMDVBVA_OPTYPE_PAGING_TRANSFER - must be null
1629 * VBOXCMDVBVA_OPTYPE_PAGING_FILL - must be null
1630 * VBOXCMDVBVA_OPTYPE_NOPCMD - must be null
1631 * VBOXCMDVBVA_OPTYPE_NOP - not applicable (as the entire VBOXCMDVBVA_HDR is not valid) */
1632 uint8_t u8Flags;
1633 /* one of VBOXCMDVBVA_STATE_XXX*/
1634 volatile uint8_t u8State;
1635 union
1636 {
1637 /* result, 0 on success, otherwise contains the failure code TBD */
1638 int8_t i8Result;
1639 uint8_t u8PrimaryID;
1640 };
1641 /* DXGK DDI fence ID */
1642 volatile uint32_t u32FenceID;
1643} VBOXCMDVBVA_HDR;
1644
1645typedef uint32_t VBOXCMDVBVAOFFSET;
1646typedef uint64_t VBOXCMDVBVAPHADDR;
1647
1648typedef struct VBOXCMDVBVA_CRCMD_BUFFER
1649{
1650 uint32_t cbBuffer;
1651 VBOXCMDVBVAOFFSET offBuffer;
1652} VBOXCMDVBVA_CRCMD_BUFFER;
1653
1654typedef struct VBOXCMDVBVA_CRCMD_CMD
1655{
1656 uint32_t cBuffers;
1657 VBOXCMDVBVA_CRCMD_BUFFER aBuffers[1];
1658} VBOXCMDVBVA_CRCMD_CMD;
1659
1660typedef struct VBOXCMDVBVA_CRCMD
1661{
1662 VBOXCMDVBVA_HDR Hdr;
1663 VBOXCMDVBVA_CRCMD_CMD Cmd;
1664} VBOXCMDVBVA_CRCMD;
1665
1666typedef struct VBOXCMDVBVA_ALLOCINFO
1667{
1668 union
1669 {
1670 VBOXCMDVBVAOFFSET offVRAM;
1671 uint32_t id;
1672 };
1673} VBOXCMDVBVA_ALLOCINFO;
1674
1675typedef struct VBOXCMDVBVA_RECT
1676{
1677 /** Coordinates of affected rectangle. */
1678 int16_t xLeft;
1679 int16_t yTop;
1680 int16_t xRight;
1681 int16_t yBottom;
1682} VBOXCMDVBVA_RECT;
1683
1684typedef struct VBOXCMDVBVA_POINT
1685{
1686 int16_t x;
1687 int16_t y;
1688} VBOXCMDVBVA_POINT;
1689
1690typedef struct VBOXCMDVBVA_BLT_PRIMARY
1691{
1692 VBOXCMDVBVA_HDR Hdr;
1693 VBOXCMDVBVA_ALLOCINFO alloc;
1694 VBOXCMDVBVA_POINT Pos;
1695 /* the rects count is determined from the command size */
1696 VBOXCMDVBVA_RECT aRects[1];
1697} VBOXCMDVBVA_BLT_PRIMARY;
1698
1699typedef struct VBOXCMDVBVA_BLT_OFFPRIMSZFMT_OR_ID
1700{
1701 VBOXCMDVBVA_HDR Hdr;
1702 VBOXCMDVBVA_ALLOCINFO src;
1703 VBOXCMDVBVA_ALLOCINFO dst;
1704 VBOXCMDVBVA_POINT Pos;
1705 /* the rects count is determined from the command size */
1706 VBOXCMDVBVA_RECT aRects[1];
1707} VBOXCMDVBVA_BLT_OFFPRIMSZFMT_OR_ID;
1708
1709typedef struct VBOXCMDVBVA_FLIP
1710{
1711 VBOXCMDVBVA_HDR Hdr;
1712 VBOXCMDVBVA_ALLOCINFO src;
1713} VBOXCMDVBVA_FLIP;
1714
1715typedef struct VBOXCMDVBVA_CLRFILL
1716{
1717 VBOXCMDVBVA_HDR Hdr;
1718 VBOXCMDVBVA_ALLOCINFO dst;
1719 VBOXCMDVBVA_RECT aRects[1];
1720} VBOXCMDVBVA_CLRFILL;
1721
1722#define VBOXCMDVBVA_SYSMEMEL_CPAGES_MAX 0x1000
1723
1724typedef struct VBOXCMDVBVA_SYSMEMEL
1725{
1726 uint32_t cPagesAfterFirst : 12;
1727 VBOXCMDVBVAPHADDR iPage : 52;
1728} VBOXCMDVBVA_SYSMEMEL;
1729
1730typedef struct VBOXCMDVBVA_PAGING_TRANSFER
1731{
1732 VBOXCMDVBVA_HDR Hdr;
1733 /* for now can only contain offVRAM.
1734 * paging transfer can NOT be initiated for allocations having host 3D object (hostID) associated */
1735 VBOXCMDVBVA_ALLOCINFO Alloc;
1736 uint32_t cSysMem;
1737 VBOXCMDVBVA_SYSMEMEL aSysMem[1];
1738} VBOXCMDVBVA_PAGING_TRANSFER;
1739
1740typedef struct VBOXCMDVBVA_PAGING_FILL
1741{
1742 VBOXCMDVBVA_HDR Hdr;
1743 uint32_t cbFill;
1744 uint32_t Pattern;
1745 /* paging transfer can NOT be initiated for allocations having host 3D object (hostID) associated */
1746 VBOXCMDVBVAOFFSET offVRAM;
1747} VBOXCMDVBVA_PAGING_FILL;
1748
1749# pragma pack()
1750
1751#endif
1752
1753#ifdef VBOXVDMA_WITH_VBVA
1754# pragma pack(1)
1755
1756typedef struct VBOXVDMAVBVACMD
1757{
1758 HGSMIOFFSET offCmd;
1759} VBOXVDMAVBVACMD;
1760
1761#pragma pack()
1762#endif
1763
1764#endif
Note: See TracBrowser for help on using the repository browser.

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