[qemu.git] / hw / vga_int.h

/*
 * QEMU internal VGA defines.
 *
 * Copyright (c) 2003-2004 Fabrice Bellard
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#define MSR_COLOR_EMULATION 0x01
#define MSR_PAGE_SELECT     0x20

#define ST01_V_RETRACE      0x08
#define ST01_DISP_ENABLE    0x01

/* bochs VBE support */
#define CONFIG_BOCHS_VBE

#define VBE_DISPI_MAX_XRES              1600
#define VBE_DISPI_MAX_YRES              1200
#define VBE_DISPI_MAX_BPP               32

#define VBE_DISPI_INDEX_ID              0x0
#define VBE_DISPI_INDEX_XRES            0x1
#define VBE_DISPI_INDEX_YRES            0x2
#define VBE_DISPI_INDEX_BPP             0x3
#define VBE_DISPI_INDEX_ENABLE          0x4
#define VBE_DISPI_INDEX_BANK            0x5
#define VBE_DISPI_INDEX_VIRT_WIDTH      0x6
#define VBE_DISPI_INDEX_VIRT_HEIGHT     0x7
#define VBE_DISPI_INDEX_X_OFFSET        0x8
#define VBE_DISPI_INDEX_Y_OFFSET        0x9
#define VBE_DISPI_INDEX_NB              0xa

#define VBE_DISPI_ID0                   0xB0C0
#define VBE_DISPI_ID1                   0xB0C1
#define VBE_DISPI_ID2                   0xB0C2
#define VBE_DISPI_ID3                   0xB0C3
#define VBE_DISPI_ID4                   0xB0C4

#define VBE_DISPI_DISABLED              0x00
#define VBE_DISPI_ENABLED               0x01
#define VBE_DISPI_GETCAPS               0x02
#define VBE_DISPI_8BIT_DAC              0x20
#define VBE_DISPI_LFB_ENABLED           0x40
#define VBE_DISPI_NOCLEARMEM            0x80

#define VBE_DISPI_LFB_PHYSICAL_ADDRESS  0xE0000000

#ifdef CONFIG_BOCHS_VBE

#define VGA_STATE_COMMON_BOCHS_VBE              \
    uint16_t vbe_index;                         \
    uint16_t vbe_regs[VBE_DISPI_INDEX_NB];      \
    uint32_t vbe_start_addr;                    \
    uint32_t vbe_line_offset;                   \
    uint32_t vbe_bank_mask;

#else

#define VGA_STATE_COMMON_BOCHS_VBE

#endif /* !CONFIG_BOCHS_VBE */

#define CH_ATTR_SIZE (160 * 100)
#define VGA_MAX_HEIGHT 2048

struct vga_precise_retrace {
    int64_t ticks_per_char;
    int64_t total_chars;
    int htotal;
    int hstart;
    int hend;
    int vstart;
    int vend;
    int freq;
};

union vga_retrace {
    struct vga_precise_retrace precise;
};

struct VGAState;
typedef uint8_t (* vga_retrace_fn)(struct VGAState *s);
typedef void (* vga_update_retrace_info_fn)(struct VGAState *s);

#define VGA_STATE_COMMON                                                \
    uint8_t *vram_ptr;                                                  \
    ram_addr_t vram_offset;                                             \
    unsigned int vram_size;                                             \
    uint32_t lfb_addr;                                                  \
    uint32_t lfb_end;                                                   \
    uint32_t map_addr;                                                  \
    uint32_t map_end;                                                   \
    uint32_t lfb_vram_mapped; /* whether 0xa0000 is mapped as ram */    \
    unsigned long bios_offset;                                          \
    unsigned int bios_size;                                             \
    int it_shift;                                                       \
    PCIDevice *pci_dev;                                                 \
    uint32_t latch;                                                     \
    uint8_t sr_index;                                                   \
    uint8_t sr[256];                                                    \
    uint8_t gr_index;                                                   \
    uint8_t gr[256];                                                    \
    uint8_t ar_index;                                                   \
    uint8_t ar[21];                                                     \
    int ar_flip_flop;                                                   \
    uint8_t cr_index;                                                   \
    uint8_t cr[256]; /* CRT registers */                                \
    uint8_t msr; /* Misc Output Register */                             \
    uint8_t fcr; /* Feature Control Register */                         \
    uint8_t st00; /* status 0 */                                        \
    uint8_t st01; /* status 1 */                                        \
    uint8_t dac_state;                                                  \
    uint8_t dac_sub_index;                                              \
    uint8_t dac_read_index;                                             \
    uint8_t dac_write_index;                                            \
    uint8_t dac_cache[3]; /* used when writing */                       \
    int dac_8bit;                                                       \
    uint8_t palette[768];                                               \
    int32_t bank_offset;                                                \
    int vga_io_memory;                                             \
    int (*get_bpp)(struct VGAState *s);                                 \
    void (*get_offsets)(struct VGAState *s,                             \
                        uint32_t *pline_offset,                         \
                        uint32_t *pstart_addr,                          \
                        uint32_t *pline_compare);                       \
    void (*get_resolution)(struct VGAState *s,                          \
                        int *pwidth,                                    \
                        int *pheight);                                  \
    VGA_STATE_COMMON_BOCHS_VBE                                          \
    /* display refresh support */                                       \
    DisplayState *ds;                                                   \
    uint32_t font_offsets[2];                                           \
    int graphic_mode;                                                   \
    uint8_t shift_control;                                              \
    uint8_t double_scan;                                                \
    uint32_t line_offset;                                               \
    uint32_t line_compare;                                              \
    uint32_t start_addr;                                                \
    uint32_t plane_updated;                                             \
    uint32_t last_line_offset;                                          \
    uint8_t last_cw, last_ch;                                           \
    uint32_t last_width, last_height; /* in chars or pixels */          \
    uint32_t last_scr_width, last_scr_height; /* in pixels */           \
    uint32_t last_depth; /* in bits */                                  \
    uint8_t cursor_start, cursor_end;                                   \
    uint32_t cursor_offset;                                             \
    unsigned int (*rgb_to_pixel)(unsigned int r,                        \
                                 unsigned int g, unsigned b);           \
    vga_hw_update_ptr update;                                           \
    vga_hw_invalidate_ptr invalidate;                                   \
    vga_hw_screen_dump_ptr screen_dump;                                 \
    vga_hw_text_update_ptr text_update;                                 \
    /* hardware mouse cursor support */                                 \
    uint32_t invalidated_y_table[VGA_MAX_HEIGHT / 32];                  \
    void (*cursor_invalidate)(struct VGAState *s);                      \
    void (*cursor_draw_line)(struct VGAState *s, uint8_t *d, int y);    \
    /* tell for each page if it has been updated since the last time */ \
    uint32_t last_palette[256];                                         \
    uint32_t last_ch_attr[CH_ATTR_SIZE]; /* XXX: make it dynamic */     \
    /* retrace */                                                       \
    vga_retrace_fn retrace;                                             \
    vga_update_retrace_info_fn update_retrace_info;                     \
    union vga_retrace retrace_info;


typedef struct VGAState {
    VGA_STATE_COMMON
} VGAState;

static inline int c6_to_8(int v)
{
    int b;
    v &= 0x3f;
    b = v & 1;
    return (v << 2) | (b << 1) | b;
}

void vga_common_init(VGAState *s, int vga_ram_size);
void vga_init(VGAState *s);
void vga_reset(void *s);

void vga_dirty_log_start(VGAState *s);
void vga_dirty_log_stop(VGAState *s);

uint32_t vga_mem_readb(void *opaque, target_phys_addr_t addr);
void vga_mem_writeb(void *opaque, target_phys_addr_t addr, uint32_t val);
void vga_invalidate_scanlines(VGAState *s, int y1, int y2);
int ppm_save(const char *filename, struct DisplaySurface *ds);

void vga_draw_cursor_line_8(uint8_t *d1, const uint8_t *src1,
                            int poffset, int w,
                            unsigned int color0, unsigned int color1,
                            unsigned int color_xor);
void vga_draw_cursor_line_16(uint8_t *d1, const uint8_t *src1,
                             int poffset, int w,
                             unsigned int color0, unsigned int color1,
                             unsigned int color_xor);
void vga_draw_cursor_line_32(uint8_t *d1, const uint8_t *src1,
                             int poffset, int w,
                             unsigned int color0, unsigned int color1,
                             unsigned int color_xor);

extern const uint8_t sr_mask[8];
extern const uint8_t gr_mask[16];
Commit	Line	Data
798b0c25 FB	1	/*
798b0c25 FB	2	* QEMU internal VGA defines.
5fafdf24	3	*
798b0c25	4	* Copyright (c) 2003-2004 Fabrice Bellard
5fafdf24	5	*
798b0c25 FB	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	#define MSR_COLOR_EMULATION 0x01
	25	#define MSR_PAGE_SELECT 0x20
	26
	27	#define ST01_V_RETRACE 0x08
	28	#define ST01_DISP_ENABLE 0x01
	29
	30	/* bochs VBE support */
	31	#define CONFIG_BOCHS_VBE
	32
8454df8b FB	33	#define VBE_DISPI_MAX_XRES 1600
	34	#define VBE_DISPI_MAX_YRES 1200
	35	#define VBE_DISPI_MAX_BPP 32
798b0c25 FB	36
	37	#define VBE_DISPI_INDEX_ID 0x0
	38	#define VBE_DISPI_INDEX_XRES 0x1
	39	#define VBE_DISPI_INDEX_YRES 0x2
	40	#define VBE_DISPI_INDEX_BPP 0x3
	41	#define VBE_DISPI_INDEX_ENABLE 0x4
	42	#define VBE_DISPI_INDEX_BANK 0x5
	43	#define VBE_DISPI_INDEX_VIRT_WIDTH 0x6
	44	#define VBE_DISPI_INDEX_VIRT_HEIGHT 0x7
	45	#define VBE_DISPI_INDEX_X_OFFSET 0x8
	46	#define VBE_DISPI_INDEX_Y_OFFSET 0x9
	47	#define VBE_DISPI_INDEX_NB 0xa
3b46e624	48
798b0c25 FB	49	#define VBE_DISPI_ID0 0xB0C0
	50	#define VBE_DISPI_ID1 0xB0C1
	51	#define VBE_DISPI_ID2 0xB0C2
37dd208d FB	52	#define VBE_DISPI_ID3 0xB0C3
37dd208d FB	53	#define VBE_DISPI_ID4 0xB0C4
3b46e624	54
798b0c25 FB	55	#define VBE_DISPI_DISABLED 0x00
798b0c25 FB	56	#define VBE_DISPI_ENABLED 0x01
8454df8b FB	57	#define VBE_DISPI_GETCAPS 0x02
8454df8b FB	58	#define VBE_DISPI_8BIT_DAC 0x20
798b0c25 FB	59	#define VBE_DISPI_LFB_ENABLED 0x40
798b0c25 FB	60	#define VBE_DISPI_NOCLEARMEM 0x80
3b46e624	61
798b0c25 FB	62	#define VBE_DISPI_LFB_PHYSICAL_ADDRESS 0xE0000000
798b0c25 FB	63
798b0c25	64	#ifdef CONFIG_BOCHS_VBE
4e3e9d0b FB	65
	66	#define VGA_STATE_COMMON_BOCHS_VBE \
	67	uint16_t vbe_index; \
	68	uint16_t vbe_regs[VBE_DISPI_INDEX_NB]; \
	69	uint32_t vbe_start_addr; \
	70	uint32_t vbe_line_offset; \
798b0c25	71	uint32_t vbe_bank_mask;
4e3e9d0b FB	72
	73	#else
	74
	75	#define VGA_STATE_COMMON_BOCHS_VBE
	76
	77	#endif /* !CONFIG_BOCHS_VBE */
	78
798b0c25	79	#define CH_ATTR_SIZE (160 * 100)
8454df8b	80	#define VGA_MAX_HEIGHT 2048
4e3e9d0b	81
cb5a7aa8	82	struct vga_precise_retrace {
	83	int64_t ticks_per_char;
	84	int64_t total_chars;
	85	int htotal;
	86	int hstart;
	87	int hend;
	88	int vstart;
	89	int vend;
	90	int freq;
	91	};
	92
	93	union vga_retrace {
	94	struct vga_precise_retrace precise;
	95	};
	96
	97	struct VGAState;
	98	typedef uint8_t (* vga_retrace_fn)(struct VGAState *s);
	99	typedef void (* vga_update_retrace_info_fn)(struct VGAState *s);
	100
4e3e9d0b FB	101	#define VGA_STATE_COMMON \
4e3e9d0b FB	102	uint8_t *vram_ptr; \
4efe2755	103	ram_addr_t vram_offset; \
4e3e9d0b	104	unsigned int vram_size; \
2bec46dc AL	105	uint32_t lfb_addr; \
	106	uint32_t lfb_end; \
	107	uint32_t map_addr; \
	108	uint32_t map_end; \
	109	uint32_t lfb_vram_mapped; /* whether 0xa0000 is mapped as ram */ \
d5295253 FB	110	unsigned long bios_offset; \
d5295253 FB	111	unsigned int bios_size; \
2abec30b	112	int it_shift; \
d2269f6f	113	PCIDevice *pci_dev; \
4e3e9d0b FB	114	uint32_t latch; \
	115	uint8_t sr_index; \
	116	uint8_t sr[256]; \
	117	uint8_t gr_index; \
	118	uint8_t gr[256]; \
	119	uint8_t ar_index; \
	120	uint8_t ar[21]; \
	121	int ar_flip_flop; \
	122	uint8_t cr_index; \
	123	uint8_t cr[256]; /* CRT registers */ \
	124	uint8_t msr; /* Misc Output Register */ \
	125	uint8_t fcr; /* Feature Control Register */ \
	126	uint8_t st00; /* status 0 */ \
	127	uint8_t st01; /* status 1 */ \
	128	uint8_t dac_state; \
	129	uint8_t dac_sub_index; \
	130	uint8_t dac_read_index; \
	131	uint8_t dac_write_index; \
	132	uint8_t dac_cache[3]; /* used when writing */ \
37dd208d	133	int dac_8bit; \
4e3e9d0b FB	134	uint8_t palette[768]; \
4e3e9d0b FB	135	int32_t bank_offset; \
b4fbd879	136	int vga_io_memory; \
4e3e9d0b FB	137	int (get_bpp)(struct VGAState s); \
	138	void (get_offsets)(struct VGAState s, \
	139	uint32_t *pline_offset, \
83acc96b FB	140	uint32_t *pstart_addr, \
83acc96b FB	141	uint32_t *pline_compare); \
a130a41e FB	142	void (get_resolution)(struct VGAState s, \
	143	int *pwidth, \
	144	int *pheight); \
4e3e9d0b FB	145	VGA_STATE_COMMON_BOCHS_VBE \
	146	/* display refresh support */ \
	147	DisplayState *ds; \
	148	uint32_t font_offsets[2]; \
	149	int graphic_mode; \
	150	uint8_t shift_control; \
	151	uint8_t double_scan; \
	152	uint32_t line_offset; \
	153	uint32_t line_compare; \
	154	uint32_t start_addr; \
546fa6ab	155	uint32_t plane_updated; \
7d957bd8	156	uint32_t last_line_offset; \
4e3e9d0b FB	157	uint8_t last_cw, last_ch; \
	158	uint32_t last_width, last_height; /* in chars or pixels */ \
	159	uint32_t last_scr_width, last_scr_height; /* in pixels */ \
7d957bd8	160	uint32_t last_depth; /* in bits */ \
4e3e9d0b FB	161	uint8_t cursor_start, cursor_end; \
	162	uint32_t cursor_offset; \
	163	unsigned int (*rgb_to_pixel)(unsigned int r, \
	164	unsigned int g, unsigned b); \
d34cab9f TS	165	vga_hw_update_ptr update; \
	166	vga_hw_invalidate_ptr invalidate; \
	167	vga_hw_screen_dump_ptr screen_dump; \
4d3b6f6e	168	vga_hw_text_update_ptr text_update; \
a8aa669b FB	169	/* hardware mouse cursor support */ \
	170	uint32_t invalidated_y_table[VGA_MAX_HEIGHT / 32]; \
	171	void (cursor_invalidate)(struct VGAState s); \
	172	void (cursor_draw_line)(struct VGAState s, uint8_t *d, int y); \
4e3e9d0b FB	173	/* tell for each page if it has been updated since the last time */ \
4e3e9d0b FB	174	uint32_t last_palette[256]; \
cb5a7aa8	175	uint32_t last_ch_attr[CH_ATTR_SIZE]; /* XXX: make it dynamic */ \
	176	/* retrace */ \
	177	vga_retrace_fn retrace; \
	178	vga_update_retrace_info_fn update_retrace_info; \
	179	union vga_retrace retrace_info;
4e3e9d0b FB	180
	181
	182	typedef struct VGAState {
	183	VGA_STATE_COMMON
798b0c25 FB	184	} VGAState;
798b0c25 FB	185
a8aa669b FB	186	static inline int c6_to_8(int v)
	187	{
	188	int b;
	189	v &= 0x3f;
	190	b = v & 1;
	191	return (v << 2) \| (b << 1) \| b;
	192	}
	193
b584726d	194	void vga_common_init(VGAState *s, int vga_ram_size);
d34cab9f	195	void vga_init(VGAState *s);
4abc796d	196	void vga_reset(void *s);
2bec46dc AL	197
	198	void vga_dirty_log_start(VGAState *s);
	199	void vga_dirty_log_stop(VGAState *s);
	200
798b0c25 FB	201	uint32_t vga_mem_readb(void *opaque, target_phys_addr_t addr);
798b0c25 FB	202	void vga_mem_writeb(void *opaque, target_phys_addr_t addr, uint32_t val);
a8aa669b	203	void vga_invalidate_scanlines(VGAState *s, int y1, int y2);
e07d630a	204	int ppm_save(const char filename, struct DisplaySurface ds);
a8aa669b	205
5fafdf24 TS	206	void vga_draw_cursor_line_8(uint8_t d1, const uint8_t src1,
5fafdf24 TS	207	int poffset, int w,
a8aa669b FB	208	unsigned int color0, unsigned int color1,
a8aa669b FB	209	unsigned int color_xor);
5fafdf24 TS	210	void vga_draw_cursor_line_16(uint8_t d1, const uint8_t src1,
5fafdf24 TS	211	int poffset, int w,
a8aa669b FB	212	unsigned int color0, unsigned int color1,
a8aa669b FB	213	unsigned int color_xor);
5fafdf24 TS	214	void vga_draw_cursor_line_32(uint8_t d1, const uint8_t src1,
5fafdf24 TS	215	int poffset, int w,
a8aa669b FB	216	unsigned int color0, unsigned int color1,
a8aa669b FB	217	unsigned int color_xor);
798b0c25 FB	218
	219	extern const uint8_t sr_mask[8];
	220	extern const uint8_t gr_mask[16];