VirtualBox

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

Last change on this file since 20478 was 20478, checked in by vboxsync, 16 years ago

video hw accel: guest driver -> host framebuffer commands processing impl

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 19.3 KB
Line 
1/** @file
2 * VirtualBox Video interface
3 */
4
5/*
6 * Copyright (C) 2006 Sun Microsystems, Inc.
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 *
25 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26 * Clara, CA 95054 USA or visit http://www.sun.com if you need
27 * additional information or have any questions.
28 */
29
30#ifndef ___VBox_VBoxVideo_h
31#define ___VBox_VBoxVideo_h
32
33#include <iprt/cdefs.h>
34#include <iprt/types.h>
35
36/*
37 * The last 4096 bytes of the guest VRAM contains the generic info for all
38 * DualView chunks: sizes and offsets of chunks. This is filled by miniport.
39 *
40 * Last 4096 bytes of each chunk contain chunk specific data: framebuffer info,
41 * etc. This is used exclusively by the corresponding instance of a display driver.
42 *
43 * The VRAM layout:
44 * Last 4096 bytes - Adapter information area.
45 * 4096 bytes aligned miniport heap (value specified in the config rouded up).
46 * Slack - what left after dividing the VRAM.
47 * 4096 bytes aligned framebuffers:
48 * last 4096 bytes of each framebuffer is the display information area.
49 *
50 * The Virtual Graphics Adapter information in the guest VRAM is stored by the
51 * guest video driver using structures prepended by VBOXVIDEOINFOHDR.
52 *
53 * When the guest driver writes dword 0 to the VBE_DISPI_INDEX_VBOX_VIDEO
54 * the host starts to process the info. The first element at the start of
55 * the 4096 bytes region should be normally be a LINK that points to
56 * actual information chain. That way the guest driver can have some
57 * fixed layout of the information memory block and just rewrite
58 * the link to point to relevant memory chain.
59 *
60 * The processing stops at the END element.
61 *
62 * The host can access the memory only when the port IO is processed.
63 * All data that will be needed later must be copied from these 4096 bytes.
64 * But other VRAM can be used by host until the mode is disabled.
65 *
66 * The guest driver writes dword 0xffffffff to the VBE_DISPI_INDEX_VBOX_VIDEO
67 * to disable the mode.
68 *
69 * VBE_DISPI_INDEX_VBOX_VIDEO is used to read the configuration information
70 * from the host and issue commands to the host.
71 *
72 * The guest writes the VBE_DISPI_INDEX_VBOX_VIDEO index register, the the
73 * following operations with the VBE data register can be performed:
74 *
75 * Operation Result
76 * write 16 bit value NOP
77 * read 16 bit value count of monitors
78 * write 32 bit value sets the vbox command value and the command processed by the host
79 * read 32 bit value result of the last vbox command is returned
80 */
81
82#define VBOX_VIDEO_PRIMARY_SCREEN 0
83#define VBOX_VIDEO_NO_SCREEN ~0
84
85#define VBOX_VIDEO_MAX_SCREENS 64
86
87/* The size of the information. */
88#ifndef VBOX_WITH_HGSMI
89#define VBOX_VIDEO_ADAPTER_INFORMATION_SIZE 4096
90#define VBOX_VIDEO_DISPLAY_INFORMATION_SIZE 4096
91#else
92/*
93 * The minimum HGSMI heap size is PAGE_SIZE (4096 bytes) and is a restriction of the
94 * runtime heapsimple API. Use minimum 2 pages here, because the info area also may
95 * contain other data (for example HGSMIHOSTFLAGS structure).
96 */
97#define VBVA_ADAPTER_INFORMATION_SIZE (8*_1K)
98#define VBVA_DISPLAY_INFORMATION_SIZE (8*_1K)
99#define VBVA_MIN_BUFFER_SIZE (64*_1K)
100#endif /* VBOX_WITH_HGSMI */
101
102
103/* The value for port IO to let the adapter to interpret the adapter memory. */
104#define VBOX_VIDEO_DISABLE_ADAPTER_MEMORY 0xFFFFFFFF
105
106/* The value for port IO to let the adapter to interpret the adapter memory. */
107#define VBOX_VIDEO_INTERPRET_ADAPTER_MEMORY 0x00000000
108
109/* The value for port IO to let the adapter to interpret the display memory.
110 * The display number is encoded in low 16 bits.
111 */
112#define VBOX_VIDEO_INTERPRET_DISPLAY_MEMORY_BASE 0x00010000
113
114
115/* The end of the information. */
116#define VBOX_VIDEO_INFO_TYPE_END 0
117/* Instructs the host to fetch the next VBOXVIDEOINFOHDR at the given offset of VRAM. */
118#define VBOX_VIDEO_INFO_TYPE_LINK 1
119/* Information about a display memory position. */
120#define VBOX_VIDEO_INFO_TYPE_DISPLAY 2
121/* Information about a screen. */
122#define VBOX_VIDEO_INFO_TYPE_SCREEN 3
123/* Information about host notifications for the driver. */
124#define VBOX_VIDEO_INFO_TYPE_HOST_EVENTS 4
125/* Information about non-volatile guest VRAM heap. */
126#define VBOX_VIDEO_INFO_TYPE_NV_HEAP 5
127/* VBVA enable/disable. */
128#define VBOX_VIDEO_INFO_TYPE_VBVA_STATUS 6
129/* VBVA flush. */
130#define VBOX_VIDEO_INFO_TYPE_VBVA_FLUSH 7
131/* Query configuration value. */
132#define VBOX_VIDEO_INFO_TYPE_QUERY_CONF32 8
133
134
135#pragma pack(1)
136typedef struct _VBOXVIDEOINFOHDR
137{
138 uint8_t u8Type;
139 uint8_t u8Reserved;
140 uint16_t u16Length;
141} VBOXVIDEOINFOHDR;
142
143
144typedef struct _VBOXVIDEOINFOLINK
145{
146 /* Relative offset in VRAM */
147 int32_t i32Offset;
148} VBOXVIDEOINFOLINK;
149
150
151/* Resides in adapter info memory. Describes a display VRAM chunk. */
152typedef struct _VBOXVIDEOINFODISPLAY
153{
154 /* Index of the framebuffer assigned by guest. */
155 uint32_t u32Index;
156
157 /* Absolute offset in VRAM of the framebuffer to be displayed on the monitor. */
158 uint32_t u32Offset;
159
160 /* The size of the memory that can be used for the screen. */
161 uint32_t u32FramebufferSize;
162
163 /* The size of the memory that is used for the Display information.
164 * The information is at u32Offset + u32FramebufferSize
165 */
166 uint32_t u32InformationSize;
167
168} VBOXVIDEOINFODISPLAY;
169
170
171/* Resides in display info area, describes the current video mode. */
172#define VBOX_VIDEO_INFO_SCREEN_F_NONE 0x00
173#define VBOX_VIDEO_INFO_SCREEN_F_ACTIVE 0x01
174
175typedef struct _VBOXVIDEOINFOSCREEN
176{
177 /* Physical X origin relative to the primary screen. */
178 int32_t xOrigin;
179
180 /* Physical Y origin relative to the primary screen. */
181 int32_t yOrigin;
182
183 /* The scan line size in bytes. */
184 uint32_t u32LineSize;
185
186 /* Width of the screen. */
187 uint16_t u16Width;
188
189 /* Height of the screen. */
190 uint16_t u16Height;
191
192 /* Color depth. */
193 uint8_t bitsPerPixel;
194
195 /* VBOX_VIDEO_INFO_SCREEN_F_* */
196 uint8_t u8Flags;
197} VBOXVIDEOINFOSCREEN;
198
199/* The guest initializes the structure to 0. The positions of the structure in the
200 * display info area must not be changed, host will update the structure. Guest checks
201 * the events and modifies the structure as a response to host.
202 */
203#define VBOX_VIDEO_INFO_HOST_EVENTS_F_NONE 0x00000000
204#define VBOX_VIDEO_INFO_HOST_EVENTS_F_VRDP_RESET 0x00000080
205
206typedef struct _VBOXVIDEOINFOHOSTEVENTS
207{
208 /* Host events. */
209 uint32_t fu32Events;
210} VBOXVIDEOINFOHOSTEVENTS;
211
212/* Resides in adapter info memory. Describes the non-volatile VRAM heap. */
213typedef struct _VBOXVIDEOINFONVHEAP
214{
215 /* Absolute offset in VRAM of the start of the heap. */
216 uint32_t u32HeapOffset;
217
218 /* The size of the heap. */
219 uint32_t u32HeapSize;
220
221} VBOXVIDEOINFONVHEAP;
222
223/* Display information area. */
224typedef struct _VBOXVIDEOINFOVBVASTATUS
225{
226 /* Absolute offset in VRAM of the start of the VBVA QUEUE. 0 to disable VBVA. */
227 uint32_t u32QueueOffset;
228
229 /* The size of the VBVA QUEUE. 0 to disable VBVA. */
230 uint32_t u32QueueSize;
231
232} VBOXVIDEOINFOVBVASTATUS;
233
234typedef struct _VBOXVIDEOINFOVBVAFLUSH
235{
236 uint32_t u32DataStart;
237
238 uint32_t u32DataEnd;
239
240} VBOXVIDEOINFOVBVAFLUSH;
241
242#define VBOX_VIDEO_QCI32_MONITOR_COUNT 0
243#define VBOX_VIDEO_QCI32_OFFSCREEN_HEAP_SIZE 1
244
245typedef struct _VBOXVIDEOINFOQUERYCONF32
246{
247 uint32_t u32Index;
248
249 uint32_t u32Value;
250
251} VBOXVIDEOINFOQUERYCONF32;
252#pragma pack()
253
254# ifdef VBOX_WITH_VIDEOHWACCEL
255#pragma pack(1)
256
257typedef enum
258{
259 VBOXVHWACMD_TYPE_SURF_CANCREATE = 1,
260 VBOXVHWACMD_TYPE_SURF_CREATE,
261 VBOXVHWACMD_TYPE_SURF_DESTROY,
262 VBOXVHWACMD_TYPE_SURF_LOCK,
263 VBOXVHWACMD_TYPE_SURF_UNLOCK,
264 VBOXVHWACMD_TYPE_SURF_BLT,
265 VBOXVHWACMD_TYPE_QUERY_INFO1,
266 VBOXVHWACMD_TYPE_QUERY_INFO2
267} VBOXVHWACMD_TYPE;
268
269/* the command processing was asynch, set by the host to indicate asynch command completion
270 * must not be cleared once set, the command completion is performed by issuing a host->guest completion command
271 * while keeping this flag unchanged */
272#define VBOXVHWACMD_FLAG_ASYNCH 0x00000001
273/* asynch completion is performed by issuing the event */
274#define VBOXVHWACMD_FLAG_ASYNCH_EVENT 0x00000002
275
276typedef struct _VBOXVHWACMD
277{
278 VBOXVHWACMD_TYPE enmCmd; /* command type */
279 volatile int32_t rc; /* command result */
280 int32_t iDisplay; /* display index */
281 volatile int32_t Flags; /* ored VBOXVHWACMD_FLAG_xxx values */
282 uint64_t GuestVBVAReserved1; /* field internally used by the guest VBVA cmd handling, must NOT be modified by clients */
283 uint64_t GuestVBVAReserved2; /* field internally used by the guest VBVA cmd handling, must NOT be modified by clients */
284 char body[1];
285} VBOXVHWACMD;
286
287#define VBOXVHWACMD_HEADSIZE() (RT_OFFSETOF(VBOXVHWACMD, body))
288#define VBOXVHWACMD_SIZE(_tCmd) (VBOXVHWACMD_HEADSIZE() + sizeof(_tCmd))
289typedef unsigned int VBOXVHWACMD_LENGTH;
290typedef uint64_t VBOXVHWA_SURFHANDLE;
291#define VBOXVHWACMD_SURFHANDLE_INVALID 0
292#define VBOXVHWACMD_BODY(_p, _t) ((_t*)(_p)->body)
293#define VBOXVHWACMD_HEAD(_pb) ((VBOXVHWACMD*)((uint8_t *)(_pb) - RT_OFFSETOF(VBOXVHWACMD, body)))
294
295typedef struct _VBOXVHWA_RECTL
296{
297 int16_t x;
298 int16_t y;
299 uint16_t w;
300 uint16_t h;
301} VBOXVHWA_RECTL;
302
303typedef struct _VBOXVHWA_COLORKEY
304{
305 uint32_t low;
306 uint32_t high;
307} VBOXVHWA_COLORKEY;
308
309typedef struct _VBOXVHWA_PIXELFORMAT
310{
311 uint32_t flags;
312 uint32_t fourCC;
313 union
314 {
315 uint32_t rgbBitCount;
316 uint32_t yuvBitCount;
317 } c;
318
319 union
320 {
321 uint32_t rgbRBitMask;
322 uint32_t yuvYBitMask;
323 } m1;
324
325 union
326 {
327 uint32_t rgbGBitMask;
328 uint32_t yuvUBitMask;
329 } m2;
330
331 union
332 {
333 uint32_t rgbBBitMask;
334 uint32_t yuvVBitMask;
335 } m3;
336} VBOXVHWA_PIXELFORMAT;
337
338typedef struct _VBOXVHWA_SURFINFO
339{
340 uint32_t height;
341 uint32_t width;
342 VBOXVHWA_COLORKEY DstOverlayCK;
343 VBOXVHWA_COLORKEY DstBltCK;
344 VBOXVHWA_COLORKEY SrcOverlayCK;
345 VBOXVHWA_COLORKEY SrcBltCK;
346 VBOXVHWA_PIXELFORMAT PixelFormat;
347 uint32_t surfCaps;
348 uint32_t Reserved;
349} VBOXVHWA_SURFINFO;
350
351#define VBOXVHWA_CAPS_BLT 0x00000001
352#define VBOXVHWA_CAPS_BLTCOLORFILL 0x00000002
353#define VBOXVHWA_CAPS_BLTFOURCC 0x00000004
354#define VBOXVHWA_CAPS_BLTSTRETCH 0x00000008
355
356#define VBOXVHWA_CAPS_OVERLAY 0x00000100
357#define VBOXVHWA_CAPS_OVERLAYFOURCC 0x00000200
358#define VBOXVHWA_CAPS_OVERLAYSTRETCH 0x00000400
359
360#define VBOXVHWA_CAPS_COLORKEY 0x00001000
361//#define VBOXVHWA_CAPS_COLORKEYHWASSIST 0x00002000 /* always set COLORKEYHWASSIST in case host reports colorkey support */
362
363#define VBOXVHWA_CAPS2_COPYFOURCC 0x00000001
364
365#define VBOXVHWA_SCAPS_FLIP 0x00000001
366#define VBOXVHWA_SCAPS_PRIMARYSURFACE 0x00000002
367#define VBOXVHWA_SCAPS_OVERLAY 0x00000008
368
369#define VBOXVHWA_PF_RGB 0x00000001
370#define VBOXVHWA_PF_RGBTOYUV 0x00000002
371#define VBOXVHWA_PF_YUV 0x00000008
372#define VBOXVHWA_PF_FOURCC 0x00000010
373
374#define VBOXVHWA_CFG_ENABLED 0x00000001
375
376typedef struct _VBOXVHWACMD_QUERYINFO1
377{
378 uint32_t cfgFlags;
379 uint32_t caps;
380 uint32_t colorKeyCaps;
381 uint32_t stretchCaps;
382 uint32_t surfaceCaps;
383 uint32_t numOverlays;
384 uint32_t numFourCC;
385
386} VBOXVHWACMD_QUERYINFO1;
387
388typedef struct _VBOXVHWACMD_QUERYINFO2
389{
390 uint32_t numFourCC;
391 uint32_t FourCC[1];
392} VBOXVHWACMD_QUERYINFO2;
393
394#define VBOXVHWAINFO2_SIZE(_cFourCC) RT_OFFSETOF(VBOXVHWAINFO2, FourCC[_cFourCC])
395
396typedef struct _VBOXVHWACMD_SURF_CANCREATE
397{
398 union
399 {
400 struct
401 {
402 VBOXVHWA_SURFINFO SurfInfo;
403 } in;
404
405 struct
406 {
407 uint32_t ErrInfo;
408 } out;
409 } u;
410} VBOXVHWACMD_SURF_CANCREATE;
411
412typedef struct _VBOXVHWACMD_SURF_CREATE
413{
414 union
415 {
416 struct
417 {
418 VBOXVHWA_SURFINFO SurfInfo;
419 } in;
420
421 struct
422 {
423 VBOXVHWA_SURFHANDLE hSurf;
424 } out;
425 } u;
426} VBOXVHWACMD_SURF_CREATE;
427
428typedef struct _VBOXVHWACMD_SURF_DESTROY
429{
430 union
431 {
432 struct
433 {
434 VBOXVHWA_SURFHANDLE hSurf;
435 } in;
436 } u;
437} VBOXVHWACMD_SURF_DESTROY;
438
439typedef struct _VBOXVHWACMD_SURF_LOCK
440{
441 union
442 {
443 struct
444 {
445 VBOXVHWA_SURFHANDLE hSurf;
446 uint32_t flags;
447 uint32_t Reserved;
448 VBOXVHWA_RECTL rect;
449 } in;
450 } u;
451} VBOXVHWACMD_SURF_LOCK;
452
453typedef struct _VBOXVHWACMD_SURF_UNLOCK
454{
455 union
456 {
457 struct
458 {
459 VBOXVHWA_SURFHANDLE hSurf;
460 } in;
461 } u;
462} VBOXVHWACMD_SURF_UNLOCK;
463
464typedef struct _VBOXVHWACMD_SURF_BLT
465{
466 union
467 {
468 struct
469 {
470 VBOXVHWA_SURFHANDLE hDstSurf;
471 VBOXVHWA_RECTL dstRect;
472 VBOXVHWA_SURFHANDLE hSrcSurf;
473 VBOXVHWA_RECTL srcRect;
474 uint32_t flags;
475 uint32_t reserved;
476 } in;
477 } u;
478} VBOXVHWACMD_SURF_BLT;
479
480#pragma pack()
481# endif /* #ifdef VBOX_WITH_VIDEOHWACCEL */
482
483#ifdef VBOX_WITH_HGSMI
484
485/* All structures are without alignment. */
486#pragma pack(1)
487
488typedef struct _VBVABUFFER
489{
490 uint32_t u32HostEvents;
491 uint32_t u32SupportedOrders;
492
493 /* The offset where the data start in the buffer. */
494 uint32_t off32Data;
495 /* The offset where next data must be placed in the buffer. */
496 uint32_t off32Free;
497
498 /* The queue of record descriptions. */
499 VBVARECORD aRecords[VBVA_MAX_RECORDS];
500 uint32_t indexRecordFirst;
501 uint32_t indexRecordFree;
502
503 /* Space to leave free in the buffer when large partial records are transferred. */
504 uint32_t cbPartialWriteThreshold;
505
506 uint32_t cbData;
507 uint8_t au8Data[1]; /* variable size for the rest of the VBVABUFFER area in VRAM. */
508} VBVABUFFER;
509
510/* guest->host commands */
511#define VBVA_QUERY_CONF32 1
512#define VBVA_SET_CONF32 2
513#define VBVA_INFO_VIEW 3
514#define VBVA_INFO_HEAP 4
515#define VBVA_FLUSH 5
516#define VBVA_INFO_SCREEN 6
517#define VBVA_ENABLE 7
518#define VBVA_MOUSE_POINTER_SHAPE 8
519#ifdef VBOX_WITH_VIDEOHWACCEL
520# define VBVA_VHWA_CMD 9
521#endif /* # ifdef VBOX_WITH_VIDEOHWACCEL */
522
523/* host->guest commands */
524# define VBVAHG_EVENT 1
525# define VBVAHG_DISPLAY_CUSTOM 2
526
527# ifdef VBOX_WITH_VIDEOHWACCEL
528#define VBVAHG_DCUSTOM_VHWA_CMDCOMPLETE 1
529#pragma pack(1)
530typedef struct _VBVAHOSTCMDVHWACMDCOMPLETE
531{
532 uint32_t offCmd;
533}VBVAHOSTCMDVHWACMDCOMPLETE;
534#pragma pack()
535# endif /* # ifdef VBOX_WITH_VIDEOHWACCEL */
536
537#pragma pack(1)
538typedef enum
539{
540 VBVAHOSTCMD_OP_EVENT = 1,
541 VBVAHOSTCMD_OP_CUSTOM
542}VBVAHOSTCMD_OP_TYPE;
543
544typedef struct _VBVAHOSTCMDEVENT
545{
546 uint64_t pEvent;
547}VBVAHOSTCMDEVENT;
548
549
550typedef struct _VBVAHOSTCMD
551{
552 /* destination ID if >=0 specifies display index, otherwize the command is directed to the miniport */
553 int32_t iDstID;
554 int32_t customOpCode;
555 union
556 {
557 struct _VBVAHOSTCMD *pNext;
558 uint64_t Data; /* the body is 64-bit alligned */
559 } u;
560 char body[1];
561}VBVAHOSTCMD;
562
563#define VBVAHOSTCMD_SIZE(_size) (sizeof(VBVAHOSTCMD) + (_size))
564#define VBVAHOSTCMD_BODY(_pCmd, _tBody) ((_tBody*)(_pCmd)->body)
565#define VBVAHOSTCMD_HDR(_pBody) ((VBVAHOSTCMD*)(((uint8_t*)_pBody) - RT_OFFSETOF(VBVAHOSTCMD, body)))
566#define VBVAHOSTCMD_HDRSIZE (RT_OFFSETOF(VBVAHOSTCMD, body))
567
568#pragma pack()
569
570/* VBVACONF32::u32Index */
571#define VBOX_VBVA_CONF32_MONITOR_COUNT 0
572#define VBOX_VBVA_CONF32_HOST_HEAP_SIZE 1
573
574typedef struct _VBVACONF32
575{
576 uint32_t u32Index;
577 uint32_t u32Value;
578} VBVACONF32;
579
580typedef struct _VBVAINFOVIEW
581{
582 /* Index of the screen, assigned by the guest. */
583 uint32_t u32ViewIndex;
584
585 /* The screen offset in VRAM, the framebuffer starts here. */
586 uint32_t u32ViewOffset;
587
588 /* The size of the VRAM memory that can be used for the view. */
589 uint32_t u32ViewSize;
590
591 /* The recommended maximum size of the VRAM memory for the screen. */
592 uint32_t u32MaxScreenSize;
593} VBVAINFOVIEW;
594
595typedef struct _VBVAINFOHEAP
596{
597 /* Absolute offset in VRAM of the start of the heap. */
598 uint32_t u32HeapOffset;
599
600 /* The size of the heap. */
601 uint32_t u32HeapSize;
602
603} VBVAINFOHEAP;
604
605typedef struct _VBVAFLUSH
606{
607 uint32_t u32Reserved;
608
609} VBVAFLUSH;
610
611/* VBVAINFOSCREEN::u8Flags */
612#define VBVA_SCREEN_F_NONE 0x0000
613#define VBVA_SCREEN_F_ACTIVE 0x0001
614
615typedef struct _VBVAINFOSCREEN
616{
617 /* Which view contains the screen. */
618 uint32_t u32ViewIndex;
619
620 /* Physical X origin relative to the primary screen. */
621 int32_t i32OriginX;
622
623 /* Physical Y origin relative to the primary screen. */
624 int32_t i32OriginY;
625
626 /* The scan line size in bytes. */
627 uint32_t u32LineSize;
628
629 /* Width of the screen. */
630 uint32_t u32Width;
631
632 /* Height of the screen. */
633 uint32_t u32Height;
634
635 /* Color depth. */
636 uint16_t u16BitsPerPixel;
637
638 /* VBVA_SCREEN_F_* */
639 uint16_t u16Flags;
640} VBVAINFOSCREEN;
641
642
643/* VBVAENABLE::u32Flags */
644#define VBVA_F_NONE 0x00000000
645#define VBVA_F_ENABLE 0x00000001
646#define VBVA_F_DISABLE 0x00000002
647
648typedef struct _VBVAENABLE
649{
650 uint32_t u32Flags;
651 uint32_t u32Offset;
652
653} VBVAENABLE;
654
655typedef struct _VBVAMOUSEPOINTERSHAPE
656{
657 /* The host result. */
658 uint32_t u32Result;
659
660 /* VBOX_MOUSE_POINTER_* bit flags. */
661 uint32_t fu32Flags;
662
663 /* X coordinate of the hot spot. */
664 uint32_t u32HotX;
665
666 /* Y coordinate of the hot spot. */
667 uint32_t u32HotY;
668
669 /* Width of the pointer in pixels. */
670 uint32_t u32Width;
671
672 /* Height of the pointer in scanlines. */
673 uint32_t u32Height;
674
675 /* Pointer data.
676 *
677 ****
678 * The data consists of 1 bpp AND mask followed by 32 bpp XOR (color) mask.
679 *
680 * For pointers without alpha channel the XOR mask pixels are 32 bit values: (lsb)BGR0(msb).
681 * For pointers with alpha channel the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
682 *
683 * Guest driver must create the AND mask for pointers with alpha channel, so if host does not
684 * support alpha, the pointer could be displayed as a normal color pointer. The AND mask can
685 * be constructed from alpha values. For example alpha value >= 0xf0 means bit 0 in the AND mask.
686 *
687 * The AND mask is 1 bpp bitmap with byte aligned scanlines. Size of AND mask,
688 * therefore, is cbAnd = (width + 7) / 8 * height. The padding bits at the
689 * end of any scanline are undefined.
690 *
691 * The XOR mask follows the AND mask on the next 4 bytes aligned offset:
692 * uint8_t *pXor = pAnd + (cbAnd + 3) & ~3
693 * Bytes in the gap between the AND and the XOR mask are undefined.
694 * XOR mask scanlines have no gap between them and size of XOR mask is:
695 * cXor = width * 4 * height.
696 ****
697 *
698 * Preallocate 4 bytes for accessing actual data as p->au8Data.
699 */
700 uint8_t au8Data[4];
701
702} VBVAMOUSEPOINTERSHAPE;
703
704#pragma pack()
705
706#endif /* VBOX_WITH_HGSMI */
707
708#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