VirtualBox

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

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

VBoxVideo.h: added () around constants.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.9 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_HGSMI
255
256/* All structures are without alignment. */
257#pragma pack(1)
258
259typedef struct _VBVABUFFER
260{
261 uint32_t u32HostEvents;
262 uint32_t u32SupportedOrders;
263
264 /* The offset where the data start in the buffer. */
265 uint32_t off32Data;
266 /* The offset where next data must be placed in the buffer. */
267 uint32_t off32Free;
268
269 /* The queue of record descriptions. */
270 VBVARECORD aRecords[VBVA_MAX_RECORDS];
271 uint32_t indexRecordFirst;
272 uint32_t indexRecordFree;
273
274 /* Space to leave free in the buffer when large partial records are transferred. */
275 uint32_t cbPartialWriteThreshold;
276
277 uint32_t cbData;
278 uint8_t au8Data[1]; /* variable size for the rest of the VBVABUFFER area in VRAM. */
279} VBVABUFFER;
280
281
282#define VBVA_QUERY_CONF32 1
283#define VBVA_SET_CONF32 2
284#define VBVA_INFO_VIEW 3
285#define VBVA_INFO_HEAP 4
286#define VBVA_FLUSH 5
287#define VBVA_INFO_SCREEN 6
288#define VBVA_ENABLE 7
289
290/* VBVACONF32::u32Index */
291#define VBOX_VBVA_CONF32_MONITOR_COUNT 0
292#define VBOX_VBVA_CONF32_HOST_HEAP_SIZE 1
293
294typedef struct _VBVACONF32
295{
296 uint32_t u32Index;
297 uint32_t u32Value;
298} VBVACONF32;
299
300typedef struct _VBVAINFOVIEW
301{
302 /* Index of the screen, assigned by the guest. */
303 uint32_t u32ViewIndex;
304
305 /* The screen offset in VRAM, the framebuffer starts here. */
306 uint32_t u32ViewOffset;
307
308 /* The size of the VRAM memory that can be used for the view. */
309 uint32_t u32ViewSize;
310
311 /* The recommended maximum size of the VRAM memory for the screen. */
312 uint32_t u32MaxScreenSize;
313} VBVAINFOVIEW;
314
315typedef struct _VBVAINFOHEAP
316{
317 /* Absolute offset in VRAM of the start of the heap. */
318 uint32_t u32HeapOffset;
319
320 /* The size of the heap. */
321 uint32_t u32HeapSize;
322
323} VBVAINFOHEAP;
324
325typedef struct _VBVAFLUSH
326{
327 uint32_t u32Reserved;
328
329} VBVAFLUSH;
330
331/* VBVAINFOSCREEN::u8Flags */
332#define VBVA_SCREEN_F_NONE 0x0000
333#define VBVA_SCREEN_F_ACTIVE 0x0001
334
335typedef struct _VBVAINFOSCREEN
336{
337 /* Which view contains the screen. */
338 uint32_t u32ViewIndex;
339
340 /* Physical X origin relative to the primary screen. */
341 int32_t i32OriginX;
342
343 /* Physical Y origin relative to the primary screen. */
344 int32_t i32OriginY;
345
346 /* The scan line size in bytes. */
347 uint32_t u32LineSize;
348
349 /* Width of the screen. */
350 uint32_t u32Width;
351
352 /* Height of the screen. */
353 uint32_t u32Height;
354
355 /* Color depth. */
356 uint16_t u16BitsPerPixel;
357
358 /* VBVA_SCREEN_F_* */
359 uint16_t u16Flags;
360} VBVAINFOSCREEN;
361
362
363/* VBVAENABLE::u32Flags */
364#define VBVA_F_NONE 0x00000000
365#define VBVA_F_ENABLE 0x00000001
366#define VBVA_F_DISABLE 0x00000002
367
368typedef struct _VBVAENABLE
369{
370 uint32_t u32Flags;
371 uint32_t u32Offset;
372
373} VBVAENABLE;
374
375#pragma pack()
376
377#endif /* VBOX_WITH_HGSMI */
378
379#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