DevVGA.h@ 20524

Last change on this file since 20524 was 20444, checked in by vboxsync, 16 years ago
Protect VGA accesses with a critical section.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 21.3 KB

Line
1	/* $Id: DevVGA.h 20444 2009-06-09 15:16:41Z 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 MSR_COLOR_EMULATION 0x01
52	#define MSR_PAGE_SELECT 0x20
53
54	#define ST01_V_RETRACE 0x08
55	#define ST01_DISP_ENABLE 0x01
56
57	/* bochs VBE support */
58	#define CONFIG_BOCHS_VBE
59
60	#ifdef VBOX
61	#define VBE_DISPI_MAX_XRES 16384
62	#define VBE_DISPI_MAX_YRES 16384
63	#else
64	#define VBE_DISPI_MAX_XRES 1600
65	#define VBE_DISPI_MAX_YRES 1200
66	#endif
67	#define VBE_DISPI_MAX_BPP 32
68
69	#define VBE_DISPI_INDEX_ID 0x0
70	#define VBE_DISPI_INDEX_XRES 0x1
71	#define VBE_DISPI_INDEX_YRES 0x2
72	#define VBE_DISPI_INDEX_BPP 0x3
73	#define VBE_DISPI_INDEX_ENABLE 0x4
74	#define VBE_DISPI_INDEX_BANK 0x5
75	#define VBE_DISPI_INDEX_VIRT_WIDTH 0x6
76	#define VBE_DISPI_INDEX_VIRT_HEIGHT 0x7
77	#define VBE_DISPI_INDEX_X_OFFSET 0x8
78	#define VBE_DISPI_INDEX_Y_OFFSET 0x9
79	#define VBE_DISPI_INDEX_VBOX_VIDEO 0xa
80	#ifdef VBOX_WITH_HGSMI
81	/* @todo this will break saved state and is inefficient. use 2 PCI io ports. */
82	#define VBE_DISPI_INDEX_VBVA_HOST 0xb
83	#define VBE_DISPI_INDEX_VBVA_GUEST 0xc
84	#define VBE_DISPI_INDEX_NB 0xd
85	#else
86	#define VBE_DISPI_INDEX_NB 0xb
87	#endif /* !VBOX_WITH_HGSMI */
88
89	#define VBE_DISPI_ID0 0xB0C0
90	#define VBE_DISPI_ID1 0xB0C1
91	#define VBE_DISPI_ID2 0xB0C2
92	#define VBE_DISPI_ID3 0xB0C3
93	#define VBE_DISPI_ID4 0xB0C4
94
95	#ifdef VBOX
96	/* The VBOX interface id. Indicates support for VBE_DISPI_INDEX_VBOX_VIDEO. */
97	#define VBE_DISPI_ID_VBOX_VIDEO 0xBE00
98	#ifdef VBOX_WITH_HGSMI
99	/* The VBOX interface id. Indicates support for VBVA shared memory interface,
100	* VBE_DISPI_INDEX_VBVA_GUEST_CMD and VBE_DISPI_INDEX_VBVA_HOST_CMD VBE indexes.
101	*/
102	#define VBE_DISPI_ID_HGSMI 0xBE01
103	#endif /* VBOX_WITH_HGSMI */
104	#endif /* VBOX */
105
106	#define VBE_DISPI_DISABLED 0x00
107	#define VBE_DISPI_ENABLED 0x01
108	#define VBE_DISPI_GETCAPS 0x02
109	#define VBE_DISPI_8BIT_DAC 0x20
110	#define VBE_DISPI_LFB_ENABLED 0x40
111	#define VBE_DISPI_NOCLEARMEM 0x80
112
113	#define VBE_DISPI_LFB_PHYSICAL_ADDRESS 0xE0000000
114
115	#ifdef CONFIG_BOCHS_VBE
116
117	#define VGA_STATE_COMMON_BOCHS_VBE \
118	uint16_t vbe_index; \
119	uint16_t vbe_regs[VBE_DISPI_INDEX_NB]; \
120	uint32_t vbe_start_addr; \
121	uint32_t vbe_line_offset; \
122	uint32_t vbe_bank_max;
123
124	#else
125
126	#define VGA_STATE_COMMON_BOCHS_VBE
127
128	#endif /* !CONFIG_BOCHS_VBE */
129
130	#define CH_ATTR_SIZE (160 * 100)
131	#define VGA_MAX_HEIGHT VBE_DISPI_MAX_YRES
132
133	#ifndef VBOX
134	#define VGA_STATE_COMMON \
135	uint8_t *vram_ptr; \
136	unsigned long vram_offset; \
137	unsigned int vram_size; \
138	uint32_t latch; \
139	uint8_t sr_index; \
140	uint8_t sr[256]; \
141	uint8_t gr_index; \
142	uint8_t gr[256]; \
143	uint8_t ar_index; \
144	uint8_t ar[21]; \
145	int ar_flip_flop; \
146	uint8_t cr_index; \
147	uint8_t cr[256]; /* CRT registers */ \
148	uint8_t msr; /* Misc Output Register */ \
149	uint8_t fcr; /* Feature Control Register */ \
150	uint8_t st00; /* status 0 */ \
151	uint8_t st01; /* status 1 */ \
152	uint8_t dac_state; \
153	uint8_t dac_sub_index; \
154	uint8_t dac_read_index; \
155	uint8_t dac_write_index; \
156	uint8_t dac_cache[3]; /* used when writing */ \
157	uint8_t palette[768]; \
158	int32_t bank_offset; \
159	int (get_bpp)(struct VGAState s); \
160	void (get_offsets)(struct VGAState s, \
161	uint32_t *pline_offset, \
162	uint32_t *pstart_addr, \
163	uint32_t *pline_compare); \
164	void (get_resolution)(struct VGAState s, \
165	int *pwidth, \
166	int *pheight); \
167	VGA_STATE_COMMON_BOCHS_VBE \
168	/* display refresh support */ \
169	DisplayState *ds; \
170	uint32_t font_offsets[2]; \
171	int graphic_mode; \
172	uint8_t shift_control; \
173	uint8_t double_scan; \
174	uint32_t line_offset; \
175	uint32_t line_compare; \
176	uint32_t start_addr; \
177	uint32_t plane_updated; \
178	uint8_t last_cw, last_ch; \
179	uint32_t last_width, last_height; /* in chars or pixels */ \
180	uint32_t last_scr_width, last_scr_height; /* in pixels */ \
181	uint8_t cursor_start, cursor_end; \
182	uint32_t cursor_offset; \
183	unsigned int (*rgb_to_pixel)(unsigned int r, \
184	unsigned int g, unsigned b); \
185	/* hardware mouse cursor support */ \
186	uint32_t invalidated_y_table[VGA_MAX_HEIGHT / 32]; \
187	void (cursor_invalidate)(struct VGAState s); \
188	void (cursor_draw_line)(struct VGAState s, uint8_t *d, int y); \
189	/* tell for each page if it has been updated since the last time */ \
190	uint32_t last_palette[256]; \
191	uint32_t last_ch_attr[CH_ATTR_SIZE]; /* XXX: make it dynamic */
192
193	#else /* VBOX */
194
195	struct VGAState;
196	typedef int FNGETBPP(struct VGAState *s);
197	typedef void FNGETOFFSETS(struct VGAState s, uint32_t pline_offset, uint32_t pstart_addr, uint32_t pline_compare);
198	typedef void FNGETRESOLUTION(struct VGAState s, int pwidth, int *pheight);
199	typedef unsigned int FNRGBTOPIXEL(unsigned int r, unsigned int g, unsigned b);
200	typedef void FNCURSORINVALIDATE(struct VGAState *s);
201	typedef void FNCURSORDRAWLINE(struct VGAState s, uint8_t d, int y);
202
203	/* bird: vram_offset have been remove, function pointers declared external,
204	some type changes, and some padding have been added. */
205	#define VGA_STATE_COMMON \
206	R3PTRTYPE(uint8_t *) vram_ptrR3; \
207	uint32_t vram_size; \
208	uint32_t latch; \
209	uint8_t sr_index; \
210	uint8_t sr[256]; \
211	uint8_t gr_index; \
212	uint8_t gr[256]; \
213	uint8_t ar_index; \
214	uint8_t ar[21]; \
215	int32_t ar_flip_flop; \
216	uint8_t cr_index; \
217	uint8_t cr[256]; /* CRT registers */ \
218	uint8_t msr; /* Misc Output Register */ \
219	uint8_t fcr; /* Feature Control Register */ \
220	uint8_t st00; /* status 0 */ \
221	uint8_t st01; /* status 1 */ \
222	uint8_t dac_state; \
223	uint8_t dac_sub_index; \
224	uint8_t dac_read_index; \
225	uint8_t dac_write_index; \
226	uint8_t dac_cache[3]; /* used when writing */ \
227	uint8_t palette[768]; \
228	int32_t bank_offset; \
229	int32_t padding0; \
230	R3PTRTYPE(FNGETBPP *) get_bpp; \
231	R3PTRTYPE(FNGETOFFSETS *) get_offsets; \
232	R3PTRTYPE(FNGETRESOLUTION *) get_resolution; \
233	VGA_STATE_COMMON_BOCHS_VBE \
234	/* display refresh support */ \
235	uint32_t font_offsets[2]; \
236	int32_t graphic_mode; \
237	uint8_t shift_control; \
238	uint8_t double_scan; \
239	uint8_t padding1[2]; \
240	uint32_t line_offset; \
241	uint32_t line_compare; \
242	uint32_t start_addr; \
243	uint32_t plane_updated; \
244	uint8_t last_cw, last_ch, padding2[2]; \
245	uint32_t last_width, last_height; /* in chars or pixels */ \
246	uint32_t last_scr_width, last_scr_height; /* in pixels */ \
247	uint32_t last_bpp; \
248	uint8_t cursor_start, cursor_end, padding3[2]; \
249	uint32_t cursor_offset; \
250	uint32_t padding4; \
251	R3PTRTYPE(FNRGBTOPIXEL *) rgb_to_pixel; \
252	/* hardware mouse cursor support */ \
253	uint32_t invalidated_y_table[VGA_MAX_HEIGHT / 32]; \
254	R3PTRTYPE(FNCURSORINVALIDATE *) cursor_invalidate; \
255	R3PTRTYPE(FNCURSORDRAWLINE *) cursor_draw_line; \
256	/* tell for each page if it has been updated since the last time */ \
257	uint32_t last_palette[256]; \
258	uint32_t last_ch_attr[CH_ATTR_SIZE]; /* XXX: make it dynamic */
259
260	#endif /* VBOX */
261
262	typedef struct VGAState {
263	VGA_STATE_COMMON
264	#ifdef VBOX
265	/** end-of-common-state-marker */
266	uint32_t u32Marker;
267	/** The physical address the VRAM was assigned. */
268	RTGCPHYS32 GCPhysVRAM;
269	/** The R0 vram pointer... */
270	R0PTRTYPE(uint8_t *) vram_ptrR0;
271	/** Pointer to the GC vram mapping. */
272	RCPTRTYPE(uint8_t *) vram_ptrRC;
273	/** LFB was updated flag. */
274	bool fLFBUpdated;
275	/** Indicates if the GC extensions are enabled or not. */
276	bool fGCEnabled;
277	/** Indicates if the R0 extensions are enabled or not. */
278	bool fR0Enabled;
279	/** Flag indicating that there are dirty bits. This is used to optimize the handler resetting. */
280	bool fHasDirtyBits;
281	/** Flag indicating that the VGA memory in the 0xa0000-0xbffff region has been remapped to allow direct access. */
282	bool fRemappedVGA;
283	/** Whether to render the guest VRAM to the framebuffer memory. False only for some LFB modes. */
284	bool fRenderVRAM;
285	bool padding9[2];
286
287	#ifdef VBOX_WITH_HGSMI
288	R3PTRTYPE(PHGSMIINSTANCE) pHGSMI;
289	#endif /* VBOX_WITH_HGSMI */
290
291	/** Current refresh timer interval. */
292	uint32_t cMilliesRefreshInterval;
293	/** Refresh timer handle - HC. */
294	PTMTIMERR3 RefreshTimer;
295
296	/** Bitmap tracking dirty pages. */
297	uint32_t au32DirtyBitmap[VGA_VRAM_MAX / PAGE_SIZE / 32];
298	/** Pointer to vgaGCLFBAccessHandler(). */
299	RTRCPTR RCPtrLFBHandler;
300	/** Pointer to the device instance - RC Ptr. */
301	PPDMDEVINSRC pDevInsRC;
302	/** Pointer to the device instance - R3 Ptr. */
303	PPDMDEVINSR3 pDevInsR3;
304	/** Pointer to the device instance - R0 Ptr. */
305	PPDMDEVINSR0 pDevInsR0;
306
307	/** The critical section. */
308	PDMCRITSECT lock;
309
310	/** The display port base interface. */
311	PDMIBASE Base;
312	/** The display port interface. */
313	PDMIDISPLAYPORT Port;
314	#if defined(VBOX_WITH_HGSMI) && defined(VBOX_WITH_VIDEOHWACCEL)
315	/** VBVA callbacks interface */
316	PDMDDISPLAYVBVACALLBACKS VBVACallbacks;
317	#endif
318	/** Pointer to base interface of the driver. */
319	R3PTRTYPE(PPDMIBASE) pDrvBase;
320	/** Pointer to display connector interface of the driver. */
321	R3PTRTYPE(PPDMIDISPLAYCONNECTOR) pDrv;
322
323	/** The PCI device. */
324	PCIDEVICE Dev;
325
326	STAMPROFILE StatRZMemoryRead;
327	STAMPROFILE StatR3MemoryRead;
328	STAMPROFILE StatRZMemoryWrite;
329	STAMPROFILE StatR3MemoryWrite;
330	STAMCOUNTER StatMapPage; /*< Counts IOMMMIOMapMMIO2Page calls. /
331
332	/* Keep track of ring 0 latched accesses to the VGA MMIO memory. */
333	uint64_t u64LastLatchedAccess;
334	uint32_t cLatchAccesses;
335	uint16_t uMaskLatchAccess;
336	uint16_t iMask;
337
338	#ifdef VBE_BYTEWISE_IO
339	/** VBE read/write data/index flags */
340	uint8_t fReadVBEData;
341	uint8_t fWriteVBEData;
342	uint8_t fReadVBEIndex;
343	uint8_t fWriteVBEIndex;
344	/** VBE write data/index one byte buffer */
345	uint8_t cbWriteVBEData;
346	uint8_t cbWriteVBEIndex;
347	# ifdef VBE_NEW_DYN_LIST
348	/** VBE Extra Data write address one byte buffer */
349	uint8_t cbWriteVBEExtraAddress;
350	uint8_t Padding6; /*< Alignment padding. /
351	# else
352	uint8_t Padding6[2]; /*< Alignment padding. /
353	# endif
354	#endif
355
356	#ifdef VBE_NEW_DYN_LIST
357	/** The VBE BIOS extra data. */
358	R3PTRTYPE(uint8_t *) pu8VBEExtraData;
359	/** The size of the VBE BIOS extra data. */
360	uint16_t cbVBEExtraData;
361	/** The VBE BIOS current memory address. */
362	uint16_t u16VBEExtraAddress;
363	uint16_t Padding7[2]; /*< Alignment padding. /
364	#endif
365	/** Current logo data offset. */
366	uint32_t offLogoData;
367	/** The size of the BIOS logo data. */
368	uint32_t cbLogo;
369	/** The BIOS logo data. */
370	R3PTRTYPE(uint8_t *) pu8Logo;
371	/** The name of the logo file. */
372	R3PTRTYPE(char *) pszLogoFile;
373	/** Bitmap image data. */
374	R3PTRTYPE(uint8_t *) pu8LogoBitmap;
375	/** Current logo command. */
376	uint16_t LogoCommand;
377	/** Bitmap width. */
378	uint16_t cxLogo;
379	/** Bitmap height. */
380	uint16_t cyLogo;
381	/** Bitmap planes. */
382	uint16_t cLogoPlanes;
383	/** Bitmap depth. */
384	uint16_t cLogoBits;
385	/** Bitmap compression. */
386	uint16_t LogoCompression;
387	/** Bitmap colors used. */
388	uint16_t cLogoUsedColors;
389	/** Palette size. */
390	uint16_t cLogoPalEntries;
391	/** Clear screen flag. */
392	uint8_t fLogoClearScreen;
393	uint8_t Padding8[7]; /*< Alignment padding. /
394	/** Palette data. */
395	uint32_t au32LogoPalette[256];
396	#endif /* VBOX */
397	} VGAState;
398	#ifdef VBOX
399	/** VGA state. */
400	typedef VGAState VGASTATE;
401	/** Pointer to the VGA state. */
402	typedef VGASTATE *PVGASTATE;
403	#endif
404
405	#ifdef VBE_NEW_DYN_LIST
406	/**
407	* VBE Bios Extra Data structure.
408	* @remark duplicated in vbe.h.
409	*/
410	typedef struct VBEHeader
411	{
412	/** Signature (VBEHEADER_MAGIC). */
413	uint16_t u16Signature;
414	/** Data size. */
415	uint16_t cbData;
416	} VBEHeader;
417
418	/** VBE Extra Data. */
419	typedef VBEHeader VBEHEADER;
420	/** Pointer to the VBE Extra Data. */
421	typedef VBEHEADER *PVBEHEADER;
422
423	/** The value of the VBEHEADER::u16Signature field.
424	* @remark duplicated in vbe.h. */
425	#define VBEHEADER_MAGIC 0x77CC
426
427	/** The extra port which is used to read the mode list.
428	* @remark duplicated in vbe.h. */
429	#define VBE_EXTRA_PORT 0x3b6
430
431	/** The extra port which is used for debug printf.
432	* @remark duplicated in vbe.h. */
433	#define VBE_PRINTF_PORT 0x3b7
434
435	#endif /* VBE_NEW_DYN_LIST */
436
437	#if !defined(VBOX) \|\| defined(IN_RING3)
438	static inline int c6_to_8(int v)
439	{
440	int b;
441	v &= 0x3f;
442	b = v & 1;
443	return (v << 2) \| (b << 1) \| b;
444	}
445	#endif /* !VBOX \|\| IN_RING3 */
446
447
448	#ifdef VBOX_WITH_HGSMI
449	int VBVAInit (PVGASTATE pVGAState);
450	void VBVADestroy (PVGASTATE pVGAState);
451	int VBVAUpdateDisplay (PVGASTATE pVGAState);
452
453	# ifdef VBOX_WITH_VIDEOHWACCEL
454	int vbvaVHWACommandCompleteAsynch(PPDMDDISPLAYVBVACALLBACKS pInterface, PVBOXVHWACMD pCmd);
455	# endif
456	#endif /* VBOX_WITH_HGSMI */
457
458	#ifndef VBOX
459	void vga_common_init(VGAState s, DisplayState ds, uint8_t *vga_ram_base,
460	unsigned long vga_ram_offset, int vga_ram_size);
461	uint32_t vga_mem_readb(void *opaque, target_phys_addr_t addr);
462	void vga_mem_writeb(void *opaque, target_phys_addr_t addr, uint32_t val);
463	void vga_invalidate_scanlines(VGAState *s, int y1, int y2);
464
465	void vga_draw_cursor_line_8(uint8_t d1, const uint8_t src1,
466	int poffset, int w,
467	unsigned int color0, unsigned int color1,
468	unsigned int color_xor);
469	void vga_draw_cursor_line_16(uint8_t d1, const uint8_t src1,
470	int poffset, int w,
471	unsigned int color0, unsigned int color1,
472	unsigned int color_xor);
473	void vga_draw_cursor_line_32(uint8_t d1, const uint8_t src1,
474	int poffset, int w,
475	unsigned int color0, unsigned int color1,
476	unsigned int color_xor);
477
478	extern const uint8_t sr_mask[8];
479	extern const uint8_t gr_mask[16];
480	#endif /* !VBOX */
481

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: