VirtualBox

source: vbox/trunk/src/VBox/Devices/Graphics/DevVGA.h@ 24696

Last change on this file since 24696 was 24495, checked in by vboxsync, 15 years ago

DevVGA: Restore version 1 saved states (very recent regression).

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 22.0 KB
Line 
1/* $Id: DevVGA.h 24495 2009-11-09 12:26:36Z vboxsync $ */
2/** @file
3 * DevVGA - VBox VGA/VESA device, internal header.
4 */
5
6/*
7 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18 * Clara, CA 95054 USA or visit http://www.sun.com if you need
19 * additional information or have any questions.
20 * --------------------------------------------------------------------
21 *
22 * This code is based on:
23 *
24 * QEMU internal VGA defines.
25 *
26 * Copyright (c) 2003-2004 Fabrice Bellard
27 *
28 * Permission is hereby granted, free of charge, to any person obtaining a copy
29 * of this software and associated documentation files (the "Software"), to deal
30 * in the Software without restriction, including without limitation the rights
31 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
32 * copies of the Software, and to permit persons to whom the Software is
33 * furnished to do so, subject to the following conditions:
34 *
35 * The above copyright notice and this permission notice shall be included in
36 * all copies or substantial portions of the Software.
37 *
38 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
39 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
40 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
41 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
42 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
43 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
44 * THE SOFTWARE.
45 */
46
47#ifdef VBOX_WITH_HGSMI
48#include "HGSMI/HGSMIHost.h"
49#endif /* VBOX_WITH_HGSMI */
50
51#define VGA_SAVEDSTATE_VERSION 4
52#define VGA_SAVEDSTATE_VERSION_HGSMI 3
53#define VGA_SAVEDSTATE_VERSION_PRE_HGSMI 2
54#define VGA_SAVEDSTATE_VERSION_ANCIENT 1
55
56#define MSR_COLOR_EMULATION 0x01
57#define MSR_PAGE_SELECT 0x20
58
59#define ST01_V_RETRACE 0x08
60#define ST01_DISP_ENABLE 0x01
61
62/* bochs VBE support */
63#define CONFIG_BOCHS_VBE
64
65#ifdef VBOX
66#define VBE_DISPI_MAX_XRES 16384
67#define VBE_DISPI_MAX_YRES 16384
68#else
69#define VBE_DISPI_MAX_XRES 1600
70#define VBE_DISPI_MAX_YRES 1200
71#endif
72#define VBE_DISPI_MAX_BPP 32
73
74#define VBE_DISPI_INDEX_ID 0x0
75#define VBE_DISPI_INDEX_XRES 0x1
76#define VBE_DISPI_INDEX_YRES 0x2
77#define VBE_DISPI_INDEX_BPP 0x3
78#define VBE_DISPI_INDEX_ENABLE 0x4
79#define VBE_DISPI_INDEX_BANK 0x5
80#define VBE_DISPI_INDEX_VIRT_WIDTH 0x6
81#define VBE_DISPI_INDEX_VIRT_HEIGHT 0x7
82#define VBE_DISPI_INDEX_X_OFFSET 0x8
83#define VBE_DISPI_INDEX_Y_OFFSET 0x9
84#define VBE_DISPI_INDEX_VBOX_VIDEO 0xa
85#define VBE_DISPI_INDEX_NB 0xb
86
87#define VBE_DISPI_ID0 0xB0C0
88#define VBE_DISPI_ID1 0xB0C1
89#define VBE_DISPI_ID2 0xB0C2
90#define VBE_DISPI_ID3 0xB0C3
91#define VBE_DISPI_ID4 0xB0C4
92
93#ifdef VBOX
94/* The VBOX interface id. Indicates support for VBE_DISPI_INDEX_VBOX_VIDEO. */
95#define VBE_DISPI_ID_VBOX_VIDEO 0xBE00
96#ifdef VBOX_WITH_HGSMI
97/* The VBOX interface id. Indicates support for VBVA shared memory interface. */
98#define VBE_DISPI_ID_HGSMI 0xBE01
99#endif /* VBOX_WITH_HGSMI */
100#endif /* VBOX */
101
102#define VBE_DISPI_DISABLED 0x00
103#define VBE_DISPI_ENABLED 0x01
104#define VBE_DISPI_GETCAPS 0x02
105#define VBE_DISPI_8BIT_DAC 0x20
106#define VBE_DISPI_LFB_ENABLED 0x40
107#define VBE_DISPI_NOCLEARMEM 0x80
108
109#define VBE_DISPI_LFB_PHYSICAL_ADDRESS 0xE0000000
110
111#ifdef CONFIG_BOCHS_VBE
112
113#define VGA_STATE_COMMON_BOCHS_VBE \
114 uint16_t vbe_index; \
115 uint16_t vbe_regs[VBE_DISPI_INDEX_NB]; \
116 uint32_t vbe_start_addr; \
117 uint32_t vbe_line_offset; \
118 uint32_t vbe_bank_max;
119
120#else
121
122#define VGA_STATE_COMMON_BOCHS_VBE
123
124#endif /* !CONFIG_BOCHS_VBE */
125
126#define CH_ATTR_SIZE (160 * 100)
127#define VGA_MAX_HEIGHT VBE_DISPI_MAX_YRES
128
129#ifndef VBOX
130#define VGA_STATE_COMMON \
131 uint8_t *vram_ptr; \
132 unsigned long vram_offset; \
133 unsigned int vram_size; \
134 uint32_t latch; \
135 uint8_t sr_index; \
136 uint8_t sr[256]; \
137 uint8_t gr_index; \
138 uint8_t gr[256]; \
139 uint8_t ar_index; \
140 uint8_t ar[21]; \
141 int ar_flip_flop; \
142 uint8_t cr_index; \
143 uint8_t cr[256]; /* CRT registers */ \
144 uint8_t msr; /* Misc Output Register */ \
145 uint8_t fcr; /* Feature Control Register */ \
146 uint8_t st00; /* status 0 */ \
147 uint8_t st01; /* status 1 */ \
148 uint8_t dac_state; \
149 uint8_t dac_sub_index; \
150 uint8_t dac_read_index; \
151 uint8_t dac_write_index; \
152 uint8_t dac_cache[3]; /* used when writing */ \
153 uint8_t palette[768]; \
154 int32_t bank_offset; \
155 int (*get_bpp)(struct VGAState *s); \
156 void (*get_offsets)(struct VGAState *s, \
157 uint32_t *pline_offset, \
158 uint32_t *pstart_addr, \
159 uint32_t *pline_compare); \
160 void (*get_resolution)(struct VGAState *s, \
161 int *pwidth, \
162 int *pheight); \
163 VGA_STATE_COMMON_BOCHS_VBE \
164 /* display refresh support */ \
165 DisplayState *ds; \
166 uint32_t font_offsets[2]; \
167 int graphic_mode; \
168 uint8_t shift_control; \
169 uint8_t double_scan; \
170 uint32_t line_offset; \
171 uint32_t line_compare; \
172 uint32_t start_addr; \
173 uint32_t plane_updated; \
174 uint8_t last_cw, last_ch; \
175 uint32_t last_width, last_height; /* in chars or pixels */ \
176 uint32_t last_scr_width, last_scr_height; /* in pixels */ \
177 uint8_t cursor_start, cursor_end; \
178 uint32_t cursor_offset; \
179 unsigned int (*rgb_to_pixel)(unsigned int r, \
180 unsigned int g, unsigned b); \
181 /* hardware mouse cursor support */ \
182 uint32_t invalidated_y_table[VGA_MAX_HEIGHT / 32]; \
183 void (*cursor_invalidate)(struct VGAState *s); \
184 void (*cursor_draw_line)(struct VGAState *s, uint8_t *d, int y); \
185 /* tell for each page if it has been updated since the last time */ \
186 uint32_t last_palette[256]; \
187 uint32_t last_ch_attr[CH_ATTR_SIZE]; /* XXX: make it dynamic */
188
189#else /* VBOX */
190
191struct VGAState;
192typedef int FNGETBPP(struct VGAState *s);
193typedef void FNGETOFFSETS(struct VGAState *s, uint32_t *pline_offset, uint32_t *pstart_addr, uint32_t *pline_compare);
194typedef void FNGETRESOLUTION(struct VGAState *s, int *pwidth, int *pheight);
195typedef unsigned int FNRGBTOPIXEL(unsigned int r, unsigned int g, unsigned b);
196typedef void FNCURSORINVALIDATE(struct VGAState *s);
197typedef void FNCURSORDRAWLINE(struct VGAState *s, uint8_t *d, int y);
198
199/* bird: vram_offset have been remove, function pointers declared external,
200 some type changes, and some padding have been added. */
201#define VGA_STATE_COMMON \
202 R3PTRTYPE(uint8_t *) vram_ptrR3; \
203 uint32_t vram_size; \
204 uint32_t latch; \
205 uint8_t sr_index; \
206 uint8_t sr[256]; \
207 uint8_t gr_index; \
208 uint8_t gr[256]; \
209 uint8_t ar_index; \
210 uint8_t ar[21]; \
211 int32_t ar_flip_flop; \
212 uint8_t cr_index; \
213 uint8_t cr[256]; /* CRT registers */ \
214 uint8_t msr; /* Misc Output Register */ \
215 uint8_t fcr; /* Feature Control Register */ \
216 uint8_t st00; /* status 0 */ \
217 uint8_t st01; /* status 1 */ \
218 uint8_t dac_state; \
219 uint8_t dac_sub_index; \
220 uint8_t dac_read_index; \
221 uint8_t dac_write_index; \
222 uint8_t dac_cache[3]; /* used when writing */ \
223 uint8_t palette[768]; \
224 int32_t bank_offset; \
225 int32_t padding0; \
226 R3PTRTYPE(FNGETBPP *) get_bpp; \
227 R3PTRTYPE(FNGETOFFSETS *) get_offsets; \
228 R3PTRTYPE(FNGETRESOLUTION *) get_resolution; \
229 VGA_STATE_COMMON_BOCHS_VBE \
230 /* display refresh support */ \
231 uint32_t font_offsets[2]; \
232 int32_t graphic_mode; \
233 uint8_t shift_control; \
234 uint8_t double_scan; \
235 uint8_t padding1[2]; \
236 uint32_t line_offset; \
237 uint32_t line_compare; \
238 uint32_t start_addr; \
239 uint32_t plane_updated; \
240 uint8_t last_cw, last_ch, padding2[2]; \
241 uint32_t last_width, last_height; /* in chars or pixels */ \
242 uint32_t last_scr_width, last_scr_height; /* in pixels */ \
243 uint32_t last_bpp; \
244 uint8_t cursor_start, cursor_end, padding3[2]; \
245 uint32_t cursor_offset; \
246 uint32_t padding4; \
247 R3PTRTYPE(FNRGBTOPIXEL *) rgb_to_pixel; \
248 /* hardware mouse cursor support */ \
249 uint32_t invalidated_y_table[VGA_MAX_HEIGHT / 32]; \
250 R3PTRTYPE(FNCURSORINVALIDATE *) cursor_invalidate; \
251 R3PTRTYPE(FNCURSORDRAWLINE *) cursor_draw_line; \
252 /* tell for each page if it has been updated since the last time */ \
253 uint32_t last_palette[256]; \
254 uint32_t last_ch_attr[CH_ATTR_SIZE]; /* XXX: make it dynamic */
255
256#endif /* VBOX */
257
258typedef struct VGAState {
259 VGA_STATE_COMMON
260#ifdef VBOX
261 /** end-of-common-state-marker */
262 uint32_t u32Marker;
263 /** The physical address the VRAM was assigned. */
264 RTGCPHYS32 GCPhysVRAM;
265 /** The R0 vram pointer... */
266 R0PTRTYPE(uint8_t *) vram_ptrR0;
267 /** Pointer to the GC vram mapping. */
268 RCPTRTYPE(uint8_t *) vram_ptrRC;
269 /** LFB was updated flag. */
270 bool fLFBUpdated;
271 /** Indicates if the GC extensions are enabled or not. */
272 bool fGCEnabled;
273 /** Indicates if the R0 extensions are enabled or not. */
274 bool fR0Enabled;
275 /** Flag indicating that there are dirty bits. This is used to optimize the handler resetting. */
276 bool fHasDirtyBits;
277 /** Flag indicating that the VGA memory in the 0xa0000-0xbffff region has been remapped to allow direct access. */
278 bool fRemappedVGA;
279 /** Whether to render the guest VRAM to the framebuffer memory. False only for some LFB modes. */
280 bool fRenderVRAM;
281 bool Padding1[2];
282
283 uint32_t cMonitors;
284
285#ifdef VBOX_WITH_HGSMI
286 R3PTRTYPE(PHGSMIINSTANCE) pHGSMI;
287#endif /* VBOX_WITH_HGSMI */
288
289 /** Current refresh timer interval. */
290 uint32_t Padding2;
291 uint32_t cMilliesRefreshInterval;
292 /** Refresh timer handle - HC. */
293 PTMTIMERR3 RefreshTimer;
294
295 /** Bitmap tracking dirty pages. */
296 uint32_t au32DirtyBitmap[VGA_VRAM_MAX / PAGE_SIZE / 32];
297 /** Pointer to vgaGCLFBAccessHandler(). */
298 RTRCPTR RCPtrLFBHandler;
299 /** Pointer to the device instance - RC Ptr. */
300 PPDMDEVINSRC pDevInsRC;
301 /** Pointer to the device instance - R3 Ptr. */
302 PPDMDEVINSR3 pDevInsR3;
303 /** Pointer to the device instance - R0 Ptr. */
304 PPDMDEVINSR0 pDevInsR0;
305
306 /** The critical section. */
307 PDMCRITSECT lock;
308
309 /** The display port base interface. */
310 PDMIBASE Base;
311 /** The display port interface. */
312 PDMIDISPLAYPORT Port;
313# if HC_ARCH_BITS == 32
314 uint32_t Padding8;
315# endif
316#if defined(VBOX_WITH_HGSMI) && defined(VBOX_WITH_VIDEOHWACCEL)
317 /** VBVA callbacks interface */
318 PDMDDISPLAYVBVACALLBACKS VBVACallbacks;
319#else
320# if HC_ARCH_BITS == 32
321 uint32_t Padding3;
322# endif
323#endif
324 /** Pointer to base interface of the driver. */
325 R3PTRTYPE(PPDMIBASE) pDrvBase;
326 /** Pointer to display connector interface of the driver. */
327 R3PTRTYPE(PPDMIDISPLAYCONNECTOR) pDrv;
328
329 /** The PCI device. */
330 PCIDEVICE Dev;
331
332 STAMPROFILE StatRZMemoryRead;
333 STAMPROFILE StatR3MemoryRead;
334 STAMPROFILE StatRZMemoryWrite;
335 STAMPROFILE StatR3MemoryWrite;
336 STAMCOUNTER StatMapPage; /**< Counts IOMMMIOMapMMIO2Page calls. */
337
338 /* Keep track of ring 0 latched accesses to the VGA MMIO memory. */
339 uint64_t u64LastLatchedAccess;
340 uint32_t cLatchAccesses;
341 uint16_t uMaskLatchAccess;
342 uint16_t iMask;
343
344#ifdef VBE_BYTEWISE_IO
345 /** VBE read/write data/index flags */
346 uint8_t fReadVBEData;
347 uint8_t fWriteVBEData;
348 uint8_t fReadVBEIndex;
349 uint8_t fWriteVBEIndex;
350 /** VBE write data/index one byte buffer */
351 uint8_t cbWriteVBEData;
352 uint8_t cbWriteVBEIndex;
353# ifdef VBE_NEW_DYN_LIST
354 /** VBE Extra Data write address one byte buffer */
355 uint8_t cbWriteVBEExtraAddress;
356 uint8_t Padding4;
357# else
358 uint8_t Padding4[2];
359# endif
360#endif
361
362#ifdef VBE_NEW_DYN_LIST
363 /** The VBE BIOS extra data. */
364 R3PTRTYPE(uint8_t *) pu8VBEExtraData;
365 /** The size of the VBE BIOS extra data. */
366 uint16_t cbVBEExtraData;
367 /** The VBE BIOS current memory address. */
368 uint16_t u16VBEExtraAddress;
369 uint16_t Padding5[2];
370#endif
371 /** Current logo data offset. */
372 uint32_t offLogoData;
373 /** The size of the BIOS logo data. */
374 uint32_t cbLogo;
375 /** The BIOS logo data. */
376 R3PTRTYPE(uint8_t *) pu8Logo;
377 /** The name of the logo file. */
378 R3PTRTYPE(char *) pszLogoFile;
379 /** Bitmap image data. */
380 R3PTRTYPE(uint8_t *) pu8LogoBitmap;
381 /** Current logo command. */
382 uint16_t LogoCommand;
383 /** Bitmap width. */
384 uint16_t cxLogo;
385 /** Bitmap height. */
386 uint16_t cyLogo;
387 /** Bitmap planes. */
388 uint16_t cLogoPlanes;
389 /** Bitmap depth. */
390 uint16_t cLogoBits;
391 /** Bitmap compression. */
392 uint16_t LogoCompression;
393 /** Bitmap colors used. */
394 uint16_t cLogoUsedColors;
395 /** Palette size. */
396 uint16_t cLogoPalEntries;
397 /** Clear screen flag. */
398 uint8_t fLogoClearScreen;
399 uint8_t Padding6[7];
400 /** Palette data. */
401 uint32_t au32LogoPalette[256];
402#endif /* VBOX */
403#ifdef VBOX_WITH_HGSMI
404 /** Base port in the assigned PCI I/O space. */
405 RTIOPORT IOPortBase;
406 uint8_t Padding7[6];
407#endif /* VBOX_WITH_HGSMI */
408} VGAState;
409#ifdef VBOX
410/** VGA state. */
411typedef VGAState VGASTATE;
412/** Pointer to the VGA state. */
413typedef VGASTATE *PVGASTATE;
414#endif
415
416#ifdef VBE_NEW_DYN_LIST
417/**
418 * VBE Bios Extra Data structure.
419 * @remark duplicated in vbe.h.
420 */
421typedef struct VBEHeader
422{
423 /** Signature (VBEHEADER_MAGIC). */
424 uint16_t u16Signature;
425 /** Data size. */
426 uint16_t cbData;
427} VBEHeader;
428
429/** VBE Extra Data. */
430typedef VBEHeader VBEHEADER;
431/** Pointer to the VBE Extra Data. */
432typedef VBEHEADER *PVBEHEADER;
433
434/** The value of the VBEHEADER::u16Signature field.
435 * @remark duplicated in vbe.h. */
436#define VBEHEADER_MAGIC 0x77CC
437
438/** The extra port which is used to read the mode list.
439 * @remark duplicated in vbe.h. */
440#define VBE_EXTRA_PORT 0x3b6
441
442/** The extra port which is used for debug printf.
443 * @remark duplicated in vbe.h. */
444#define VBE_PRINTF_PORT 0x3b7
445
446#endif /* VBE_NEW_DYN_LIST */
447
448#if !defined(VBOX) || defined(IN_RING3)
449static inline int c6_to_8(int v)
450{
451 int b;
452 v &= 0x3f;
453 b = v & 1;
454 return (v << 2) | (b << 1) | b;
455}
456#endif /* !VBOX || IN_RING3 */
457
458
459#ifdef VBOX_WITH_HGSMI
460int VBVAInit (PVGASTATE pVGAState);
461void VBVADestroy (PVGASTATE pVGAState);
462int VBVAUpdateDisplay (PVGASTATE pVGAState);
463void VBVAReset (PVGASTATE pVGAState);
464void HGSMIReset (PHGSMIINSTANCE pIns);
465
466# ifdef VBOX_WITH_VIDEOHWACCEL
467int vbvaVHWACommandCompleteAsynch(PPDMDDISPLAYVBVACALLBACKS pInterface, PVBOXVHWACMD pCmd);
468int vbvaVHWAConstruct (PVGASTATE pVGAState);
469int vbvaVHWADisable (PVGASTATE pVGAState);
470int vbvaVHWAReset (PVGASTATE pVGAState);
471
472int vboxVBVASaveStatePrep (PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
473# endif
474
475int vboxVBVASaveStateExec (PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
476int vboxVBVALoadStateExec (PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t u32Version);
477int vboxVBVALoadStateDone (PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
478
479#endif /* VBOX_WITH_HGSMI */
480
481#ifndef VBOX
482void vga_common_init(VGAState *s, DisplayState *ds, uint8_t *vga_ram_base,
483 unsigned long vga_ram_offset, int vga_ram_size);
484uint32_t vga_mem_readb(void *opaque, target_phys_addr_t addr);
485void vga_mem_writeb(void *opaque, target_phys_addr_t addr, uint32_t val);
486void vga_invalidate_scanlines(VGAState *s, int y1, int y2);
487
488void vga_draw_cursor_line_8(uint8_t *d1, const uint8_t *src1,
489 int poffset, int w,
490 unsigned int color0, unsigned int color1,
491 unsigned int color_xor);
492void vga_draw_cursor_line_16(uint8_t *d1, const uint8_t *src1,
493 int poffset, int w,
494 unsigned int color0, unsigned int color1,
495 unsigned int color_xor);
496void vga_draw_cursor_line_32(uint8_t *d1, const uint8_t *src1,
497 int poffset, int w,
498 unsigned int color0, unsigned int color1,
499 unsigned int color_xor);
500
501extern const uint8_t sr_mask[8];
502extern const uint8_t gr_mask[16];
503#endif /* !VBOX */
504
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