9865002861cb389675b42778f4b4223ab58d8978
[sdk/emulator/qemu.git] / hw / vga_int.h
1 /*
2  * QEMU internal VGA defines.
3  *
4  * Copyright (c) 2003-2004 Fabrice Bellard
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24
25 #include <hw/hw.h>
26 #include "memory.h"
27
28 #define ST01_V_RETRACE      0x08
29 #define ST01_DISP_ENABLE    0x01
30
31 /* bochs VBE support */
32 #define CONFIG_BOCHS_VBE
33
34 #if CONFIG_MARU
35 #define VBE_DISPI_MAX_XRES              2600
36 #define VBE_DISPI_MAX_YRES              2600
37 #else
38 #define VBE_DISPI_MAX_XRES              1600
39 #define VBE_DISPI_MAX_YRES              1200
40 #endif
41 #define VBE_DISPI_MAX_BPP               32
42
43 #define VBE_DISPI_INDEX_ID              0x0
44 #define VBE_DISPI_INDEX_XRES            0x1
45 #define VBE_DISPI_INDEX_YRES            0x2
46 #define VBE_DISPI_INDEX_BPP             0x3
47 #define VBE_DISPI_INDEX_ENABLE          0x4
48 #define VBE_DISPI_INDEX_BANK            0x5
49 #define VBE_DISPI_INDEX_VIRT_WIDTH      0x6
50 #define VBE_DISPI_INDEX_VIRT_HEIGHT     0x7
51 #define VBE_DISPI_INDEX_X_OFFSET        0x8
52 #define VBE_DISPI_INDEX_Y_OFFSET        0x9
53 #define VBE_DISPI_INDEX_NB              0xa /* size of vbe_regs[] */
54 #define VBE_DISPI_INDEX_VIDEO_MEMORY_64K 0xa /* read-only, not in vbe_regs */
55
56 #define VBE_DISPI_ID0                   0xB0C0
57 #define VBE_DISPI_ID1                   0xB0C1
58 #define VBE_DISPI_ID2                   0xB0C2
59 #define VBE_DISPI_ID3                   0xB0C3
60 #define VBE_DISPI_ID4                   0xB0C4
61 #define VBE_DISPI_ID5                   0xB0C5
62
63 #define VBE_DISPI_DISABLED              0x00
64 #define VBE_DISPI_ENABLED               0x01
65 #define VBE_DISPI_GETCAPS               0x02
66 #define VBE_DISPI_8BIT_DAC              0x20
67 #define VBE_DISPI_LFB_ENABLED           0x40
68 #define VBE_DISPI_NOCLEARMEM            0x80
69
70 #define VBE_DISPI_LFB_PHYSICAL_ADDRESS  0xE0000000
71
72 #ifdef CONFIG_BOCHS_VBE
73
74 #define VGA_STATE_COMMON_BOCHS_VBE              \
75     uint16_t vbe_index;                         \
76     uint16_t vbe_regs[VBE_DISPI_INDEX_NB];      \
77     uint32_t vbe_start_addr;                    \
78     uint32_t vbe_line_offset;                   \
79     uint32_t vbe_bank_mask;                     \
80     int vbe_mapped;
81 #else
82
83 #define VGA_STATE_COMMON_BOCHS_VBE
84
85 #endif /* !CONFIG_BOCHS_VBE */
86
87 #define CH_ATTR_SIZE (160 * 100)
88 #define VGA_MAX_HEIGHT 2048
89
90 struct vga_precise_retrace {
91     int64_t ticks_per_char;
92     int64_t total_chars;
93     int htotal;
94     int hstart;
95     int hend;
96     int vstart;
97     int vend;
98     int freq;
99 };
100
101 union vga_retrace {
102     struct vga_precise_retrace precise;
103 };
104
105 struct VGACommonState;
106 typedef uint8_t (* vga_retrace_fn)(struct VGACommonState *s);
107 typedef void (* vga_update_retrace_info_fn)(struct VGACommonState *s);
108
109 typedef struct VGACommonState {
110     MemoryRegion *legacy_address_space;
111     uint8_t *vram_ptr;
112     MemoryRegion vram;
113     MemoryRegion vram_vbe;
114     uint32_t vram_size;
115     uint32_t vram_size_mb; /* property */
116     uint32_t latch;
117     MemoryRegion *chain4_alias;
118     uint8_t sr_index;
119     uint8_t sr[256];
120     uint8_t gr_index;
121     uint8_t gr[256];
122     uint8_t ar_index;
123     uint8_t ar[21];
124     int ar_flip_flop;
125     uint8_t cr_index;
126     uint8_t cr[256]; /* CRT registers */
127     uint8_t msr; /* Misc Output Register */
128     uint8_t fcr; /* Feature Control Register */
129     uint8_t st00; /* status 0 */
130     uint8_t st01; /* status 1 */
131     uint8_t dac_state;
132     uint8_t dac_sub_index;
133     uint8_t dac_read_index;
134     uint8_t dac_write_index;
135     uint8_t dac_cache[3]; /* used when writing */
136     int dac_8bit;
137     uint8_t palette[768];
138     int32_t bank_offset;
139     int (*get_bpp)(struct VGACommonState *s);
140     void (*get_offsets)(struct VGACommonState *s,
141                         uint32_t *pline_offset,
142                         uint32_t *pstart_addr,
143                         uint32_t *pline_compare);
144     void (*get_resolution)(struct VGACommonState *s,
145                         int *pwidth,
146                         int *pheight);
147     VGA_STATE_COMMON_BOCHS_VBE
148     /* display refresh support */
149     DisplayState *ds;
150     uint32_t font_offsets[2];
151     int graphic_mode;
152     uint8_t shift_control;
153     uint8_t double_scan;
154     uint32_t line_offset;
155     uint32_t line_compare;
156     uint32_t start_addr;
157     uint32_t plane_updated;
158     uint32_t last_line_offset;
159     uint8_t last_cw, last_ch;
160     uint32_t last_width, last_height; /* in chars or pixels */
161     uint32_t last_scr_width, last_scr_height; /* in pixels */
162     uint32_t last_depth; /* in bits */
163     uint8_t cursor_start, cursor_end;
164     bool cursor_visible_phase;
165     int64_t cursor_blink_time;
166     uint32_t cursor_offset;
167     unsigned int (*rgb_to_pixel)(unsigned int r,
168                                  unsigned int g, unsigned b);
169     vga_hw_update_ptr update;
170     vga_hw_invalidate_ptr invalidate;
171     vga_hw_screen_dump_ptr screen_dump;
172     vga_hw_text_update_ptr text_update;
173     /* hardware mouse cursor support */
174     uint32_t invalidated_y_table[VGA_MAX_HEIGHT / 32];
175     void (*cursor_invalidate)(struct VGACommonState *s);
176     void (*cursor_draw_line)(struct VGACommonState *s, uint8_t *d, int y);
177     /* tell for each page if it has been updated since the last time */
178     uint32_t last_palette[256];
179     uint32_t last_ch_attr[CH_ATTR_SIZE]; /* XXX: make it dynamic */
180     /* retrace */
181     vga_retrace_fn retrace;
182     vga_update_retrace_info_fn update_retrace_info;
183     union vga_retrace retrace_info;
184     uint8_t is_vbe_vmstate;
185 } VGACommonState;
186
187 static inline int c6_to_8(int v)
188 {
189     int b;
190     v &= 0x3f;
191     b = v & 1;
192     return (v << 2) | (b << 1) | b;
193 }
194
195 void vga_common_init(VGACommonState *s);
196 void vga_init(VGACommonState *s, MemoryRegion *address_space,
197               MemoryRegion *address_space_io, bool init_vga_ports);
198 MemoryRegion *vga_init_io(VGACommonState *s,
199                           const MemoryRegionPortio **vga_ports,
200                           const MemoryRegionPortio **vbe_ports);
201 void vga_common_reset(VGACommonState *s);
202
203 void vga_dirty_log_start(VGACommonState *s);
204 void vga_dirty_log_stop(VGACommonState *s);
205
206 extern const VMStateDescription vmstate_vga_common;
207 uint32_t vga_ioport_read(void *opaque, uint32_t addr);
208 void vga_ioport_write(void *opaque, uint32_t addr, uint32_t val);
209 uint32_t vga_mem_readb(VGACommonState *s, target_phys_addr_t addr);
210 void vga_mem_writeb(VGACommonState *s, target_phys_addr_t addr, uint32_t val);
211 void vga_invalidate_scanlines(VGACommonState *s, int y1, int y2);
212 int ppm_save(const char *filename, struct DisplaySurface *ds);
213
214 int vga_ioport_invalid(VGACommonState *s, uint32_t addr);
215 void vga_init_vbe(VGACommonState *s, MemoryRegion *address_space);
216
217 extern const uint8_t sr_mask[8];
218 extern const uint8_t gr_mask[16];
219
220 #define VGABIOS_FILENAME "vgabios.bin"
221 #define VGABIOS_CIRRUS_FILENAME "vgabios-cirrus.bin"
222
223 extern const MemoryRegionOps vga_mem_ops;