DevVGA.h@ 27491

Last change on this file since 27491 was 27339, checked in by vboxsync, 15 years ago
wddm: basics for DMA commands support in graphics device impl
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 22.7 KB

Line
1	/* $Id: DevVGA.h 27339 2010-03-12 17:44:11Z 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	#ifdef VBOX
47	/** The default amount of VRAM. */
48	# define VGA_VRAM_DEFAULT (_4M)
49	/** The maximum amount of VRAM. */
50	# define VGA_VRAM_MAX (128 * _1M)
51	/** The minimum amount of VRAM. */
52	# define VGA_VRAM_MIN (_1M)
53	#endif
54
55	#ifdef VBOX_WITH_HGSMI
56	# include "HGSMI/HGSMIHost.h"
57	#endif /* VBOX_WITH_HGSMI */
58	#include "DevVGASavedState.h"
59
60	#define MSR_COLOR_EMULATION 0x01
61	#define MSR_PAGE_SELECT 0x20
62
63	#define ST01_V_RETRACE 0x08
64	#define ST01_DISP_ENABLE 0x01
65
66	/* bochs VBE support */
67	#define CONFIG_BOCHS_VBE
68
69	#ifdef VBOX
70	#define VBE_DISPI_MAX_XRES 16384
71	#define VBE_DISPI_MAX_YRES 16384
72	#else
73	#define VBE_DISPI_MAX_XRES 1600
74	#define VBE_DISPI_MAX_YRES 1200
75	#endif
76	#define VBE_DISPI_MAX_BPP 32
77
78	#define VBE_DISPI_INDEX_ID 0x0
79	#define VBE_DISPI_INDEX_XRES 0x1
80	#define VBE_DISPI_INDEX_YRES 0x2
81	#define VBE_DISPI_INDEX_BPP 0x3
82	#define VBE_DISPI_INDEX_ENABLE 0x4
83	#define VBE_DISPI_INDEX_BANK 0x5
84	#define VBE_DISPI_INDEX_VIRT_WIDTH 0x6
85	#define VBE_DISPI_INDEX_VIRT_HEIGHT 0x7
86	#define VBE_DISPI_INDEX_X_OFFSET 0x8
87	#define VBE_DISPI_INDEX_Y_OFFSET 0x9
88	#define VBE_DISPI_INDEX_VBOX_VIDEO 0xa
89	#define VBE_DISPI_INDEX_NB 0xb
90
91	#define VBE_DISPI_ID0 0xB0C0
92	#define VBE_DISPI_ID1 0xB0C1
93	#define VBE_DISPI_ID2 0xB0C2
94	#define VBE_DISPI_ID3 0xB0C3
95	#define VBE_DISPI_ID4 0xB0C4
96
97	#ifdef VBOX
98	/* The VBOX interface id. Indicates support for VBE_DISPI_INDEX_VBOX_VIDEO. */
99	#define VBE_DISPI_ID_VBOX_VIDEO 0xBE00
100	#ifdef VBOX_WITH_HGSMI
101	/* The VBOX interface id. Indicates support for VBVA shared memory interface. */
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	#ifdef VBOXVDMA
263	typedef struct VBOXVDMAHOST *PVBOXVDMAHOST;
264	#endif
265
266	typedef struct VGAState {
267	VGA_STATE_COMMON
268	#ifdef VBOX
269	/** end-of-common-state-marker */
270	uint32_t u32Marker;
271	/** The physical address the VRAM was assigned. */
272	RTGCPHYS32 GCPhysVRAM;
273	/** The R0 vram pointer... */
274	R0PTRTYPE(uint8_t *) vram_ptrR0;
275	/** Pointer to the GC vram mapping. */
276	RCPTRTYPE(uint8_t *) vram_ptrRC;
277	/** LFB was updated flag. */
278	bool fLFBUpdated;
279	/** Indicates if the GC extensions are enabled or not. */
280	bool fGCEnabled;
281	/** Indicates if the R0 extensions are enabled or not. */
282	bool fR0Enabled;
283	/** Flag indicating that there are dirty bits. This is used to optimize the handler resetting. */
284	bool fHasDirtyBits;
285	/** Flag indicating that the VGA memory in the 0xa0000-0xbffff region has been remapped to allow direct access. */
286	bool fRemappedVGA;
287	/** Whether to render the guest VRAM to the framebuffer memory. False only for some LFB modes. */
288	bool fRenderVRAM;
289	bool Padding1[2];
290
291	uint32_t cMonitors;
292
293	#ifdef VBOX_WITH_HGSMI
294	R3PTRTYPE(PHGSMIINSTANCE) pHGSMI;
295	#endif /* VBOX_WITH_HGSMI */
296	#ifdef VBOXVDMA
297	R3PTRTYPE(PVBOXVDMAHOST) pVdma;
298	#endif
299
300	/** Current refresh timer interval. */
301	uint32_t Padding2;
302	uint32_t cMilliesRefreshInterval;
303	/** Refresh timer handle - HC. */
304	PTMTIMERR3 RefreshTimer;
305
306	/** Bitmap tracking dirty pages. */
307	uint32_t au32DirtyBitmap[VGA_VRAM_MAX / PAGE_SIZE / 32];
308	/** Pointer to vgaGCLFBAccessHandler(). */
309	RTRCPTR RCPtrLFBHandler;
310	/** Pointer to the device instance - RC Ptr. */
311	PPDMDEVINSRC pDevInsRC;
312	/** Pointer to the device instance - R3 Ptr. */
313	PPDMDEVINSR3 pDevInsR3;
314	/** Pointer to the device instance - R0 Ptr. */
315	PPDMDEVINSR0 pDevInsR0;
316
317	/** The critical section. */
318	PDMCRITSECT lock;
319
320	/** LUN\#0: The display port base interface. */
321	PDMIBASE IBase;
322	/** LUN\#0: The display port interface. */
323	PDMIDISPLAYPORT IPort;
324	# if HC_ARCH_BITS == 32
325	uint32_t Padding8;
326	# endif
327	#if defined(VBOX_WITH_HGSMI) && defined(VBOX_WITH_VIDEOHWACCEL)
328	/** LUN\#0: VBVA callbacks interface */
329	PDMIDISPLAYVBVACALLBACKS IVBVACallbacks;
330	#else
331	# if HC_ARCH_BITS == 32
332	uint32_t Padding3;
333	# endif
334	#endif
335	/** Pointer to base interface of the driver. */
336	R3PTRTYPE(PPDMIBASE) pDrvBase;
337	/** Pointer to display connector interface of the driver. */
338	R3PTRTYPE(PPDMIDISPLAYCONNECTOR) pDrv;
339
340	/** The PCI device. */
341	PCIDEVICE Dev;
342
343	STAMPROFILE StatRZMemoryRead;
344	STAMPROFILE StatR3MemoryRead;
345	STAMPROFILE StatRZMemoryWrite;
346	STAMPROFILE StatR3MemoryWrite;
347	STAMCOUNTER StatMapPage; /*< Counts IOMMMIOMapMMIO2Page calls. /
348
349	/* Keep track of ring 0 latched accesses to the VGA MMIO memory. */
350	uint64_t u64LastLatchedAccess;
351	uint32_t cLatchAccesses;
352	uint16_t uMaskLatchAccess;
353	uint16_t iMask;
354
355	#ifdef VBE_BYTEWISE_IO
356	/** VBE read/write data/index flags */
357	uint8_t fReadVBEData;
358	uint8_t fWriteVBEData;
359	uint8_t fReadVBEIndex;
360	uint8_t fWriteVBEIndex;
361	/** VBE write data/index one byte buffer */
362	uint8_t cbWriteVBEData;
363	uint8_t cbWriteVBEIndex;
364	# ifdef VBE_NEW_DYN_LIST
365	/** VBE Extra Data write address one byte buffer */
366	uint8_t cbWriteVBEExtraAddress;
367	uint8_t Padding4;
368	# else
369	uint8_t Padding4[2];
370	# endif
371	#endif
372
373	#ifdef VBE_NEW_DYN_LIST
374	/** The VBE BIOS extra data. */
375	R3PTRTYPE(uint8_t *) pu8VBEExtraData;
376	/** The size of the VBE BIOS extra data. */
377	uint16_t cbVBEExtraData;
378	/** The VBE BIOS current memory address. */
379	uint16_t u16VBEExtraAddress;
380	uint16_t Padding5[2];
381	#endif
382	/** Current logo data offset. */
383	uint32_t offLogoData;
384	/** The size of the BIOS logo data. */
385	uint32_t cbLogo;
386	/** The BIOS logo data. */
387	R3PTRTYPE(uint8_t *) pu8Logo;
388	/** The name of the logo file. */
389	R3PTRTYPE(char *) pszLogoFile;
390	/** Bitmap image data. */
391	R3PTRTYPE(uint8_t *) pu8LogoBitmap;
392	/** Current logo command. */
393	uint16_t LogoCommand;
394	/** Bitmap width. */
395	uint16_t cxLogo;
396	/** Bitmap height. */
397	uint16_t cyLogo;
398	/** Bitmap planes. */
399	uint16_t cLogoPlanes;
400	/** Bitmap depth. */
401	uint16_t cLogoBits;
402	/** Bitmap compression. */
403	uint16_t LogoCompression;
404	/** Bitmap colors used. */
405	uint16_t cLogoUsedColors;
406	/** Palette size. */
407	uint16_t cLogoPalEntries;
408	/** Clear screen flag. */
409	uint8_t fLogoClearScreen;
410	uint8_t Padding6[7];
411	/** Palette data. */
412	uint32_t au32LogoPalette[256];
413	#endif /* VBOX */
414	#ifdef VBOX_WITH_HGSMI
415	/** Base port in the assigned PCI I/O space. */
416	RTIOPORT IOPortBase;
417	uint8_t Padding7[6];
418	#endif /* VBOX_WITH_HGSMI */
419	} VGAState;
420	#ifdef VBOX
421	/** VGA state. */
422	typedef VGAState VGASTATE;
423	/** Pointer to the VGA state. */
424	typedef VGASTATE *PVGASTATE;
425	#endif
426
427	#ifdef VBE_NEW_DYN_LIST
428	/**
429	* VBE Bios Extra Data structure.
430	* @remark duplicated in vbe.h.
431	*/
432	typedef struct VBEHeader
433	{
434	/** Signature (VBEHEADER_MAGIC). */
435	uint16_t u16Signature;
436	/** Data size. */
437	uint16_t cbData;
438	} VBEHeader;
439
440	/** VBE Extra Data. */
441	typedef VBEHeader VBEHEADER;
442	/** Pointer to the VBE Extra Data. */
443	typedef VBEHEADER *PVBEHEADER;
444
445	/** The value of the VBEHEADER::u16Signature field.
446	* @remark duplicated in vbe.h. */
447	#define VBEHEADER_MAGIC 0x77CC
448
449	/** The extra port which is used to read the mode list.
450	* @remark duplicated in vbe.h. */
451	#define VBE_EXTRA_PORT 0x3b6
452
453	/** The extra port which is used for debug printf.
454	* @remark duplicated in vbe.h. */
455	#define VBE_PRINTF_PORT 0x3b7
456
457	#endif /* VBE_NEW_DYN_LIST */
458
459	#if !defined(VBOX) \|\| defined(IN_RING3)
460	static inline int c6_to_8(int v)
461	{
462	int b;
463	v &= 0x3f;
464	b = v & 1;
465	return (v << 2) \| (b << 1) \| b;
466	}
467	#endif /* !VBOX \|\| IN_RING3 */
468
469
470	#ifdef VBOX_WITH_HGSMI
471	int VBVAInit (PVGASTATE pVGAState);
472	void VBVADestroy (PVGASTATE pVGAState);
473	int VBVAUpdateDisplay (PVGASTATE pVGAState);
474	void VBVAReset (PVGASTATE pVGAState);
475	/* @return host-guest flags that were set on reset
476	* this allows the caller to make further cleaning when needed,
477	* e.g. reset the IRQ */
478	uint32_t HGSMIReset (PHGSMIINSTANCE pIns);
479
480	# ifdef VBOX_WITH_VIDEOHWACCEL
481	int vbvaVHWACommandCompleteAsynch(PPDMIDISPLAYVBVACALLBACKS pInterface, PVBOXVHWACMD pCmd);
482	int vbvaVHWAConstruct (PVGASTATE pVGAState);
483	int vbvaVHWADisable (PVGASTATE pVGAState);
484	int vbvaVHWAReset (PVGASTATE pVGAState);
485
486	int vboxVBVASaveStatePrep (PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
487	# endif
488
489	int vboxVBVASaveStateExec (PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
490	int vboxVBVALoadStateExec (PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t u32Version);
491	int vboxVBVALoadStateDone (PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
492
493	# ifdef VBOXVDMA
494	typedef struct VBOXVDMAHOST *PVBOXVDMAHOST;
495	int vboxVDMAConstruct(PVGASTATE pVGAState, struct VBOXVDMAHOST **ppVdma, uint32_t cPipeElements);
496	int vboxVDMADestruct(PVBOXVDMAHOST pVdma);
497	void vboxVDMAControl(PVBOXVDMAHOST pVdma, PVBOXVDMA_CTL pCmd);
498	void vboxVDMACommand(PVBOXVDMAHOST pVdma, PVBOXVDMACBUF_DR pCmd);
499	# endif /* VBOXVDMA */
500
501	#endif /* VBOX_WITH_HGSMI */
502
503	#ifndef VBOX
504	void vga_common_init(VGAState s, DisplayState ds, uint8_t *vga_ram_base,
505	unsigned long vga_ram_offset, int vga_ram_size);
506	uint32_t vga_mem_readb(void *opaque, target_phys_addr_t addr);
507	void vga_mem_writeb(void *opaque, target_phys_addr_t addr, uint32_t val);
508	void vga_invalidate_scanlines(VGAState *s, int y1, int y2);
509
510	void vga_draw_cursor_line_8(uint8_t d1, const uint8_t src1,
511	int poffset, int w,
512	unsigned int color0, unsigned int color1,
513	unsigned int color_xor);
514	void vga_draw_cursor_line_16(uint8_t d1, const uint8_t src1,
515	int poffset, int w,
516	unsigned int color0, unsigned int color1,
517	unsigned int color_xor);
518	void vga_draw_cursor_line_32(uint8_t d1, const uint8_t src1,
519	int poffset, int w,
520	unsigned int color0, unsigned int color1,
521	unsigned int color_xor);
522
523	extern const uint8_t sr_mask[8];
524	extern const uint8_t gr_mask[16];
525	#endif /* !VBOX */
526

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

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

Download in other formats: