[3165] | 1 | /** @file
|
---|
| 2 | * VirtualBox Video interface
|
---|
| 3 | */
|
---|
| 4 |
|
---|
| 5 | /*
|
---|
[8155] | 6 | * Copyright (C) 2006 Sun Microsystems, Inc.
|
---|
[3165] | 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
|
---|
[5999] | 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.
|
---|
[8155] | 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.
|
---|
[3165] | 28 | */
|
---|
| 29 |
|
---|
[3632] | 30 | #ifndef ___VBox_VBoxVideo_h
|
---|
| 31 | #define ___VBox_VBoxVideo_h
|
---|
[3165] | 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 | *
|
---|
[4027] | 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 | *
|
---|
[3165] | 50 | * The Virtual Graphics Adapter information in the guest VRAM is stored by the
|
---|
| 51 | * guest video driver using structures prepended by VBOXVIDEOINFOHDR.
|
---|
| 52 | *
|
---|
[4027] | 53 | * When the guest driver writes dword 0 to the VBE_DISPI_INDEX_VBOX_VIDEO
|
---|
[3165] | 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 | *
|
---|
[4027] | 66 | * The guest driver writes dword 0xffffffff to the VBE_DISPI_INDEX_VBOX_VIDEO
|
---|
[3165] | 67 | * to disable the mode.
|
---|
| 68 | *
|
---|
[4027] | 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
|
---|
[3165] | 80 | */
|
---|
| 81 |
|
---|
| 82 | #define VBOX_VIDEO_PRIMARY_SCREEN 0
|
---|
| 83 | #define VBOX_VIDEO_NO_SCREEN ~0
|
---|
| 84 |
|
---|
[4027] | 85 | #define VBOX_VIDEO_MAX_SCREENS 64
|
---|
[3165] | 86 |
|
---|
| 87 | /* The size of the information. */
|
---|
| 88 | #define VBOX_VIDEO_ADAPTER_INFORMATION_SIZE 4096
|
---|
| 89 | #define VBOX_VIDEO_DISPLAY_INFORMATION_SIZE 4096
|
---|
| 90 |
|
---|
| 91 |
|
---|
| 92 | /* The value for port IO to let the adapter to interpret the adapter memory. */
|
---|
| 93 | #define VBOX_VIDEO_DISABLE_ADAPTER_MEMORY 0xFFFFFFFF
|
---|
| 94 |
|
---|
| 95 | /* The value for port IO to let the adapter to interpret the adapter memory. */
|
---|
| 96 | #define VBOX_VIDEO_INTERPRET_ADAPTER_MEMORY 0x00000000
|
---|
| 97 |
|
---|
| 98 | /* The value for port IO to let the adapter to interpret the display memory.
|
---|
| 99 | * The display number is encoded in low 16 bits.
|
---|
| 100 | */
|
---|
| 101 | #define VBOX_VIDEO_INTERPRET_DISPLAY_MEMORY_BASE 0x00010000
|
---|
| 102 |
|
---|
[4027] | 103 |
|
---|
[3165] | 104 | /* The end of the information. */
|
---|
| 105 | #define VBOX_VIDEO_INFO_TYPE_END 0
|
---|
| 106 | /* Instructs the host to fetch the next VBOXVIDEOINFOHDR at the given offset of VRAM. */
|
---|
| 107 | #define VBOX_VIDEO_INFO_TYPE_LINK 1
|
---|
| 108 | /* Information about a display memory position. */
|
---|
| 109 | #define VBOX_VIDEO_INFO_TYPE_DISPLAY 2
|
---|
| 110 | /* Information about a screen. */
|
---|
| 111 | #define VBOX_VIDEO_INFO_TYPE_SCREEN 3
|
---|
| 112 | /* Information about host notifications for the driver. */
|
---|
| 113 | #define VBOX_VIDEO_INFO_TYPE_HOST_EVENTS 4
|
---|
[4027] | 114 | /* Information about non-volatile guest VRAM heap. */
|
---|
| 115 | #define VBOX_VIDEO_INFO_TYPE_NV_HEAP 5
|
---|
[4053] | 116 | /* VBVA enable/disable. */
|
---|
| 117 | #define VBOX_VIDEO_INFO_TYPE_VBVA_STATUS 6
|
---|
| 118 | /* VBVA flush. */
|
---|
| 119 | #define VBOX_VIDEO_INFO_TYPE_VBVA_FLUSH 7
|
---|
| 120 | /* Query configuration value. */
|
---|
| 121 | #define VBOX_VIDEO_INFO_TYPE_QUERY_CONF32 8
|
---|
[3165] | 122 |
|
---|
| 123 |
|
---|
| 124 | #pragma pack(1)
|
---|
| 125 | typedef struct _VBOXVIDEOINFOHDR
|
---|
| 126 | {
|
---|
| 127 | uint8_t u8Type;
|
---|
| 128 | uint8_t u8Reserved;
|
---|
| 129 | uint16_t u16Length;
|
---|
| 130 | } VBOXVIDEOINFOHDR;
|
---|
| 131 |
|
---|
| 132 |
|
---|
| 133 | typedef struct _VBOXVIDEOINFOLINK
|
---|
| 134 | {
|
---|
| 135 | /* Relative offset in VRAM */
|
---|
| 136 | int32_t i32Offset;
|
---|
| 137 | } VBOXVIDEOINFOLINK;
|
---|
| 138 |
|
---|
| 139 |
|
---|
| 140 | /* Resides in adapter info memory. Describes a display VRAM chunk. */
|
---|
| 141 | typedef struct _VBOXVIDEOINFODISPLAY
|
---|
| 142 | {
|
---|
| 143 | /* Index of the framebuffer assigned by guest. */
|
---|
| 144 | uint32_t u32Index;
|
---|
| 145 |
|
---|
| 146 | /* Absolute offset in VRAM of the framebuffer to be displayed on the monitor. */
|
---|
| 147 | uint32_t u32Offset;
|
---|
| 148 |
|
---|
| 149 | /* The size of the memory that can be used for the screen. */
|
---|
| 150 | uint32_t u32FramebufferSize;
|
---|
| 151 |
|
---|
| 152 | /* The size of the memory that is used for the Display information.
|
---|
| 153 | * The information is at u32Offset + u32FramebufferSize
|
---|
| 154 | */
|
---|
| 155 | uint32_t u32InformationSize;
|
---|
| 156 |
|
---|
| 157 | } VBOXVIDEOINFODISPLAY;
|
---|
| 158 |
|
---|
| 159 |
|
---|
| 160 | /* Resides in display info area, describes the current video mode. */
|
---|
| 161 | #define VBOX_VIDEO_INFO_SCREEN_F_NONE 0x00
|
---|
| 162 | #define VBOX_VIDEO_INFO_SCREEN_F_ACTIVE 0x01
|
---|
| 163 |
|
---|
| 164 | typedef struct _VBOXVIDEOINFOSCREEN
|
---|
| 165 | {
|
---|
| 166 | /* Physical X origin relative to the primary screen. */
|
---|
| 167 | int32_t xOrigin;
|
---|
| 168 |
|
---|
| 169 | /* Physical Y origin relative to the primary screen. */
|
---|
| 170 | int32_t yOrigin;
|
---|
| 171 |
|
---|
| 172 | /* The scan line size in bytes. */
|
---|
| 173 | uint32_t u32LineSize;
|
---|
| 174 |
|
---|
| 175 | /* Width of the screen. */
|
---|
| 176 | uint16_t u16Width;
|
---|
| 177 |
|
---|
| 178 | /* Height of the screen. */
|
---|
| 179 | uint16_t u16Height;
|
---|
| 180 |
|
---|
| 181 | /* Color depth. */
|
---|
| 182 | uint8_t bitsPerPixel;
|
---|
| 183 |
|
---|
| 184 | /* VBOX_VIDEO_INFO_SCREEN_F_* */
|
---|
| 185 | uint8_t u8Flags;
|
---|
| 186 | } VBOXVIDEOINFOSCREEN;
|
---|
| 187 |
|
---|
| 188 | /* The guest initializes the structure to 0. The positions of the structure in the
|
---|
| 189 | * display info area must not be changed, host will update the structure. Guest checks
|
---|
| 190 | * the events and modifies the structure as a response to host.
|
---|
| 191 | */
|
---|
| 192 | #define VBOX_VIDEO_INFO_HOST_EVENTS_F_NONE 0x00000000
|
---|
| 193 | #define VBOX_VIDEO_INFO_HOST_EVENTS_F_VRDP_RESET 0x00000080
|
---|
| 194 |
|
---|
| 195 | typedef struct _VBOXVIDEOINFOHOSTEVENTS
|
---|
| 196 | {
|
---|
| 197 | /* Host events. */
|
---|
| 198 | uint32_t fu32Events;
|
---|
| 199 | } VBOXVIDEOINFOHOSTEVENTS;
|
---|
[4027] | 200 |
|
---|
| 201 | /* Resides in adapter info memory. Describes the non-volatile VRAM heap. */
|
---|
| 202 | typedef struct _VBOXVIDEOINFONVHEAP
|
---|
| 203 | {
|
---|
| 204 | /* Absolute offset in VRAM of the start of the heap. */
|
---|
| 205 | uint32_t u32HeapOffset;
|
---|
| 206 |
|
---|
| 207 | /* The size of the heap. */
|
---|
| 208 | uint32_t u32HeapSize;
|
---|
| 209 |
|
---|
| 210 | } VBOXVIDEOINFONVHEAP;
|
---|
[4053] | 211 |
|
---|
| 212 | /* Display information area. */
|
---|
| 213 | typedef struct _VBOXVIDEOINFOVBVASTATUS
|
---|
| 214 | {
|
---|
| 215 | /* Absolute offset in VRAM of the start of the VBVA QUEUE. 0 to disable VBVA. */
|
---|
| 216 | uint32_t u32QueueOffset;
|
---|
| 217 |
|
---|
| 218 | /* The size of the VBVA QUEUE. 0 to disable VBVA. */
|
---|
| 219 | uint32_t u32QueueSize;
|
---|
| 220 |
|
---|
| 221 | } VBOXVIDEOINFOVBVASTATUS;
|
---|
| 222 |
|
---|
| 223 | typedef struct _VBOXVIDEOINFOVBVAFLUSH
|
---|
| 224 | {
|
---|
| 225 | uint32_t u32DataStart;
|
---|
| 226 |
|
---|
| 227 | uint32_t u32DataEnd;
|
---|
| 228 |
|
---|
| 229 | } VBOXVIDEOINFOVBVAFLUSH;
|
---|
| 230 |
|
---|
| 231 | #define VBOX_VIDEO_QCI32_MONITOR_COUNT 0
|
---|
| 232 | #define VBOX_VIDEO_QCI32_OFFSCREEN_HEAP_SIZE 1
|
---|
| 233 |
|
---|
| 234 | typedef struct _VBOXVIDEOINFOQUERYCONF32
|
---|
| 235 | {
|
---|
| 236 | uint32_t u32Index;
|
---|
| 237 |
|
---|
| 238 | uint32_t u32Value;
|
---|
| 239 |
|
---|
| 240 | } VBOXVIDEOINFOQUERYCONF32;
|
---|
[3165] | 241 | #pragma pack()
|
---|
| 242 |
|
---|
[3633] | 243 | #endif
|
---|