1 | /* $Id: HGSMIChSetup.h 98103 2023-01-17 14:15:46Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * VBox Host Guest Shared Memory Interface (HGSMI), Host/Guest shared part.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
---|
8 | *
|
---|
9 | * Permission is hereby granted, free of charge, to any person
|
---|
10 | * obtaining a copy of this software and associated documentation
|
---|
11 | * files (the "Software"), to deal in the Software without
|
---|
12 | * restriction, including without limitation the rights to use,
|
---|
13 | * copy, modify, merge, publish, distribute, sublicense, and/or sell
|
---|
14 | * copies of the Software, and to permit persons to whom the
|
---|
15 | * Software is furnished to do so, subject to the following
|
---|
16 | * conditions:
|
---|
17 | *
|
---|
18 | * The above copyright notice and this permission notice shall be
|
---|
19 | * included in all copies or substantial portions of the Software.
|
---|
20 | *
|
---|
21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
---|
22 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
---|
23 | * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
---|
24 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
---|
25 | * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
---|
26 | * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
---|
27 | * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
---|
28 | * OTHER DEALINGS IN THE SOFTWARE.
|
---|
29 | */
|
---|
30 |
|
---|
31 | #ifndef VBOX_INCLUDED_Graphics_HGSMIChSetup_h
|
---|
32 | #define VBOX_INCLUDED_Graphics_HGSMIChSetup_h
|
---|
33 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
---|
34 | # pragma once
|
---|
35 | #endif
|
---|
36 |
|
---|
37 | #include "HGSMIDefs.h"
|
---|
38 |
|
---|
39 | /* HGSMI setup and configuration channel commands and data structures. */
|
---|
40 | /*
|
---|
41 | * Tell the host the location of hgsmi_host_flags structure, where the host
|
---|
42 | * can write information about pending buffers, etc, and which can be quickly
|
---|
43 | * polled by the guest without a need to port IO.
|
---|
44 | */
|
---|
45 | #define HGSMI_CC_HOST_FLAGS_LOCATION 0
|
---|
46 |
|
---|
47 | typedef struct HGSMIBUFFERLOCATION
|
---|
48 | {
|
---|
49 | HGSMIOFFSET offLocation;
|
---|
50 | HGSMISIZE cbLocation;
|
---|
51 | } HGSMIBUFFERLOCATION;
|
---|
52 | AssertCompileSize(HGSMIBUFFERLOCATION, 8);
|
---|
53 |
|
---|
54 | /* HGSMI setup and configuration data structures. */
|
---|
55 | /* host->guest commands pending, should be accessed under FIFO lock only */
|
---|
56 | #define HGSMIHOSTFLAGS_COMMANDS_PENDING UINT32_C(0x01)
|
---|
57 | /* IRQ is fired, should be accessed under VGAState::lock only */
|
---|
58 | #define HGSMIHOSTFLAGS_IRQ UINT32_C(0x02)
|
---|
59 | #ifdef VBOX_WITH_WDDM
|
---|
60 | /* one or more guest commands is completed, should be accessed under FIFO lock only */
|
---|
61 | # define HGSMIHOSTFLAGS_GCOMMAND_COMPLETED UINT32_C(0x04)
|
---|
62 | #endif
|
---|
63 | /* vsync interrupt flag, should be accessed under VGAState::lock only */
|
---|
64 | #define HGSMIHOSTFLAGS_VSYNC UINT32_C(0x10)
|
---|
65 | /** monitor hotplug flag, should be accessed under VGAState::lock only */
|
---|
66 | #define HGSMIHOSTFLAGS_HOTPLUG UINT32_C(0x20)
|
---|
67 | /**
|
---|
68 | * Cursor capability state change flag, should be accessed under
|
---|
69 | * VGAState::lock only. @see VBVACONF32.
|
---|
70 | */
|
---|
71 | #define HGSMIHOSTFLAGS_CURSOR_CAPABILITIES UINT32_C(0x40)
|
---|
72 |
|
---|
73 | typedef struct HGSMIHOSTFLAGS
|
---|
74 | {
|
---|
75 | /*
|
---|
76 | * Host flags can be accessed and modified in multiple threads
|
---|
77 | * concurrently, e.g. CrOpenGL HGCM and GUI threads when completing
|
---|
78 | * HGSMI 3D and Video Accel respectively, EMT thread when dealing with
|
---|
79 | * HGSMI command processing, etc.
|
---|
80 | * Besides settings/cleaning flags atomically, some flags have their
|
---|
81 | * own special sync restrictions, see comments for flags above.
|
---|
82 | */
|
---|
83 | volatile uint32_t u32HostFlags;
|
---|
84 | uint32_t au32Reserved[3];
|
---|
85 | } HGSMIHOSTFLAGS;
|
---|
86 | AssertCompileSize(HGSMIHOSTFLAGS, 16);
|
---|
87 |
|
---|
88 | #endif /* !VBOX_INCLUDED_Graphics_HGSMIChSetup_h */
|
---|