xref: /openbmc/qemu/hw/display/vga_int.h (revision da4b2481)
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 #ifndef HW_VGA_INT_H
26 #define HW_VGA_INT_H
27 
28 #include "ui/console.h"
29 #include "exec/ioport.h"
30 #include "exec/memory.h"
31 
32 #include "hw/display/bochs-vbe.h"
33 #include "hw/acpi/acpi_aml_interface.h"
34 
35 #define ST01_V_RETRACE      0x08
36 #define ST01_DISP_ENABLE    0x01
37 
38 #define CH_ATTR_SIZE (160 * 100)
39 #define VGA_MAX_HEIGHT 2048
40 
41 struct vga_precise_retrace {
42     int64_t ticks_per_char;
43     int64_t total_chars;
44     int htotal;
45     int hstart;
46     int hend;
47     int vstart;
48     int vend;
49     int freq;
50 };
51 
52 union vga_retrace {
53     struct vga_precise_retrace precise;
54 };
55 
56 struct VGACommonState;
57 typedef uint8_t (* vga_retrace_fn)(struct VGACommonState *s);
58 typedef void (* vga_update_retrace_info_fn)(struct VGACommonState *s);
59 
60 typedef struct VGADisplayParams {
61     uint32_t line_offset;
62     uint32_t start_addr;
63     uint32_t line_compare;
64     uint8_t  hpel;
65     bool     hpel_split;
66 } VGADisplayParams;
67 
68 typedef struct VGACommonState {
69     MemoryRegion *legacy_address_space;
70     uint8_t *vram_ptr;
71     MemoryRegion vram;
72     uint32_t vram_size;
73     uint32_t vram_size_mb; /* property */
74     uint32_t vbe_size;
75     uint32_t vbe_size_mask;
76     uint32_t latch;
77     bool has_chain4_alias;
78     MemoryRegion chain4_alias;
79     uint8_t sr_index;
80     uint8_t sr[256];
81     uint8_t sr_vbe[256];
82     uint8_t gr_index;
83     uint8_t gr[256];
84     uint8_t ar_index;
85     uint8_t ar[21];
86     int ar_flip_flop;
87     uint8_t cr_index;
88     uint8_t cr[256]; /* CRT registers */
89     uint8_t msr; /* Misc Output Register */
90     uint8_t fcr; /* Feature Control Register */
91     uint8_t st00; /* status 0 */
92     uint8_t st01; /* status 1 */
93     uint8_t dac_state;
94     uint8_t dac_sub_index;
95     uint8_t dac_read_index;
96     uint8_t dac_write_index;
97     uint8_t dac_cache[3]; /* used when writing */
98     int dac_8bit;
99     uint8_t palette[768];
100     int32_t bank_offset;
101     int (*get_bpp)(struct VGACommonState *s);
102     void (*get_params)(struct VGACommonState *s, VGADisplayParams *params);
103     void (*get_resolution)(struct VGACommonState *s,
104                         int *pwidth,
105                         int *pheight);
106     PortioList vga_port_list;
107     PortioList vbe_port_list;
108     /* bochs vbe state */
109     uint16_t vbe_index;
110     uint16_t vbe_regs[VBE_DISPI_INDEX_NB];
111     uint32_t vbe_start_addr;
112     uint32_t vbe_line_offset;
113     uint32_t vbe_bank_mask;
114     /* display refresh support */
115     QemuConsole *con;
116     uint32_t font_offsets[2];
117     uint8_t *panning_buf;
118     int graphic_mode;
119     uint8_t shift_control;
120     uint8_t double_scan;
121     VGADisplayParams params;
122     uint32_t plane_updated;
123     uint32_t last_line_offset;
124     uint8_t last_cw, last_ch;
125     uint32_t last_width, last_height; /* in chars or pixels */
126     uint32_t last_scr_width, last_scr_height; /* in pixels */
127     uint32_t last_depth; /* in bits */
128     bool last_byteswap;
129     bool force_shadow;
130     uint8_t cursor_start, cursor_end;
131     bool cursor_visible_phase;
132     int64_t cursor_blink_time;
133     uint32_t cursor_offset;
134     const GraphicHwOps *hw_ops;
135     bool full_update_text;
136     bool full_update_gfx;
137     bool big_endian_fb;
138     bool default_endian_fb;
139     bool global_vmstate;
140     /* hardware mouse cursor support */
141     uint32_t invalidated_y_table[VGA_MAX_HEIGHT / 32];
142     uint32_t hw_cursor_x;
143     uint32_t hw_cursor_y;
144     void (*cursor_invalidate)(struct VGACommonState *s);
145     void (*cursor_draw_line)(struct VGACommonState *s, uint8_t *d, int y);
146     /* tell for each page if it has been updated since the last time */
147     uint32_t last_palette[256];
148     uint32_t last_ch_attr[CH_ATTR_SIZE]; /* XXX: make it dynamic */
149     /* retrace */
150     vga_retrace_fn retrace;
151     vga_update_retrace_info_fn update_retrace_info;
152     union vga_retrace retrace_info;
153     uint8_t is_vbe_vmstate;
154 } VGACommonState;
155 
c6_to_8(int v)156 static inline int c6_to_8(int v)
157 {
158     int b;
159     v &= 0x3f;
160     b = v & 1;
161     return (v << 2) | (b << 1) | b;
162 }
163 
164 bool vga_common_init(VGACommonState *s, Object *obj, Error **errp);
165 void vga_init(VGACommonState *s, Object *obj, MemoryRegion *address_space,
166               MemoryRegion *address_space_io, bool init_vga_ports);
167 MemoryRegion *vga_init_io(VGACommonState *s, Object *obj,
168                           const MemoryRegionPortio **vga_ports,
169                           const MemoryRegionPortio **vbe_ports);
170 void vga_common_reset(VGACommonState *s);
171 
172 void vga_dirty_log_start(VGACommonState *s);
173 void vga_dirty_log_stop(VGACommonState *s);
174 
175 extern const VMStateDescription vmstate_vga_common;
176 uint32_t vga_ioport_read(void *opaque, uint32_t addr);
177 void vga_ioport_write(void *opaque, uint32_t addr, uint32_t val);
178 uint32_t vga_mem_readb(VGACommonState *s, hwaddr addr);
179 void vga_mem_writeb(VGACommonState *s, hwaddr addr, uint32_t val);
180 void vga_invalidate_scanlines(VGACommonState *s, int y1, int y2);
181 
182 int vga_ioport_invalid(VGACommonState *s, uint32_t addr);
183 
184 uint32_t vbe_ioport_read_data(void *opaque, uint32_t addr);
185 void vbe_ioport_write_index(void *opaque, uint32_t addr, uint32_t val);
186 void vbe_ioport_write_data(void *opaque, uint32_t addr, uint32_t val);
187 
188 extern const uint8_t sr_mask[8];
189 extern const uint8_t gr_mask[16];
190 
191 #define VGABIOS_FILENAME "vgabios.bin"
192 #define VGABIOS_CIRRUS_FILENAME "vgabios-cirrus.bin"
193 
194 extern const MemoryRegionOps vga_mem_ops;
195 
196 /* vga-pci.c */
197 void pci_std_vga_mmio_region_init(VGACommonState *s,
198                                   Object *owner,
199                                   MemoryRegion *parent,
200                                   MemoryRegion *subs,
201                                   bool qext, bool edid);
202 
203 void build_vga_aml(AcpiDevAmlIf *adev, Aml *scope);
204 #endif
205