[qemu.git] / hw / milkymist-vgafb.c


/*
 *  QEMU model of the Milkymist VGA framebuffer.
 *
 *  Copyright (c) 2010-2012 Michael Walle <michael@walle.cc>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
 *
 *
 * Specification available at:
 *   http://www.milkymist.org/socdoc/vgafb.pdf
 */

#include "hw.h"
#include "sysbus.h"
#include "trace.h"
#include "console.h"
#include "framebuffer.h"
#include "pixel_ops.h"
#include "qemu-error.h"

#define BITS 8
#include "milkymist-vgafb_template.h"
#define BITS 15
#include "milkymist-vgafb_template.h"
#define BITS 16
#include "milkymist-vgafb_template.h"
#define BITS 24
#include "milkymist-vgafb_template.h"
#define BITS 32
#include "milkymist-vgafb_template.h"

enum {
    R_CTRL = 0,
    R_HRES,
    R_HSYNC_START,
    R_HSYNC_END,
    R_HSCAN,
    R_VRES,
    R_VSYNC_START,
    R_VSYNC_END,
    R_VSCAN,
    R_BASEADDRESS,
    R_BASEADDRESS_ACT,
    R_BURST_COUNT,
    R_DDC,
    R_SOURCE_CLOCK,
    R_MAX
};

enum {
    CTRL_RESET = (1<<0),
};

struct MilkymistVgafbState {
    SysBusDevice busdev;
    MemoryRegion regs_region;
    DisplayState *ds;

    int invalidate;
    uint32_t fb_offset;
    uint32_t fb_mask;

    uint32_t regs[R_MAX];
};
typedef struct MilkymistVgafbState MilkymistVgafbState;

static int vgafb_enabled(MilkymistVgafbState *s)
{
    return !(s->regs[R_CTRL] & CTRL_RESET);
}

static void vgafb_update_display(void *opaque)
{
    MilkymistVgafbState *s = opaque;
    int first = 0;
    int last = 0;
    drawfn fn;

    if (!vgafb_enabled(s)) {
        return;
    }

    int dest_width = s->regs[R_HRES];

    switch (ds_get_bits_per_pixel(s->ds)) {
    case 0:
        return;
    case 8:
        fn = draw_line_8;
        break;
    case 15:
        fn = draw_line_15;
        dest_width *= 2;
        break;
    case 16:
        fn = draw_line_16;
        dest_width *= 2;
        break;
    case 24:
        fn = draw_line_24;
        dest_width *= 3;
        break;
    case 32:
        fn = draw_line_32;
        dest_width *= 4;
        break;
    default:
        hw_error("milkymist_vgafb: bad color depth\n");
        break;
    }

    framebuffer_update_display(s->ds, sysbus_address_space(&s->busdev),
                               s->regs[R_BASEADDRESS] + s->fb_offset,
                               s->regs[R_HRES],
                               s->regs[R_VRES],
                               s->regs[R_HRES] * 2,
                               dest_width,
                               0,
                               s->invalidate,
                               fn,
                               NULL,
                               &first, &last);

    if (first >= 0) {
        dpy_update(s->ds, 0, first, s->regs[R_HRES], last - first + 1);
    }
    s->invalidate = 0;
}

static void vgafb_invalidate_display(void *opaque)
{
    MilkymistVgafbState *s = opaque;
    s->invalidate = 1;
}

static void vgafb_resize(MilkymistVgafbState *s)
{
    if (!vgafb_enabled(s)) {
        return;
    }

    qemu_console_resize(s->ds, s->regs[R_HRES], s->regs[R_VRES]);
    s->invalidate = 1;
}

static uint64_t vgafb_read(void *opaque, hwaddr addr,
                           unsigned size)
{
    MilkymistVgafbState *s = opaque;
    uint32_t r = 0;

    addr >>= 2;
    switch (addr) {
    case R_CTRL:
    case R_HRES:
    case R_HSYNC_START:
    case R_HSYNC_END:
    case R_HSCAN:
    case R_VRES:
    case R_VSYNC_START:
    case R_VSYNC_END:
    case R_VSCAN:
    case R_BASEADDRESS:
    case R_BURST_COUNT:
    case R_DDC:
    case R_SOURCE_CLOCK:
        r = s->regs[addr];
    break;
    case R_BASEADDRESS_ACT:
        r = s->regs[R_BASEADDRESS];
    break;

    default:
        error_report("milkymist_vgafb: read access to unknown register 0x"
                TARGET_FMT_plx, addr << 2);
        break;
    }

    trace_milkymist_vgafb_memory_read(addr << 2, r);

    return r;
}

static void vgafb_write(void *opaque, hwaddr addr, uint64_t value,
                        unsigned size)
{
    MilkymistVgafbState *s = opaque;

    trace_milkymist_vgafb_memory_write(addr, value);

    addr >>= 2;
    switch (addr) {
    case R_CTRL:
        s->regs[addr] = value;
        vgafb_resize(s);
        break;
    case R_HSYNC_START:
    case R_HSYNC_END:
    case R_HSCAN:
    case R_VSYNC_START:
    case R_VSYNC_END:
    case R_VSCAN:
    case R_BURST_COUNT:
    case R_DDC:
    case R_SOURCE_CLOCK:
        s->regs[addr] = value;
        break;
    case R_BASEADDRESS:
        if (value & 0x1f) {
            error_report("milkymist_vgafb: framebuffer base address have to "
                     "be 32 byte aligned");
            break;
        }
        s->regs[addr] = value & s->fb_mask;
        s->invalidate = 1;
        break;
    case R_HRES:
    case R_VRES:
        s->regs[addr] = value;
        vgafb_resize(s);
        break;
    case R_BASEADDRESS_ACT:
        error_report("milkymist_vgafb: write to read-only register 0x"
                TARGET_FMT_plx, addr << 2);
        break;

    default:
        error_report("milkymist_vgafb: write access to unknown register 0x"
                TARGET_FMT_plx, addr << 2);
        break;
    }
}

static const MemoryRegionOps vgafb_mmio_ops = {
    .read = vgafb_read,
    .write = vgafb_write,
    .valid = {
        .min_access_size = 4,
        .max_access_size = 4,
    },
    .endianness = DEVICE_NATIVE_ENDIAN,
};

static void milkymist_vgafb_reset(DeviceState *d)
{
    MilkymistVgafbState *s = container_of(d, MilkymistVgafbState, busdev.qdev);
    int i;

    for (i = 0; i < R_MAX; i++) {
        s->regs[i] = 0;
    }

    /* defaults */
    s->regs[R_CTRL] = CTRL_RESET;
    s->regs[R_HRES] = 640;
    s->regs[R_VRES] = 480;
    s->regs[R_BASEADDRESS] = 0;
}

static int milkymist_vgafb_init(SysBusDevice *dev)
{
    MilkymistVgafbState *s = FROM_SYSBUS(typeof(*s), dev);

    memory_region_init_io(&s->regs_region, &vgafb_mmio_ops, s,
            "milkymist-vgafb", R_MAX * 4);
    sysbus_init_mmio(dev, &s->regs_region);

    s->ds = graphic_console_init(vgafb_update_display,
                                 vgafb_invalidate_display,
                                 NULL, NULL, s);

    return 0;
}

static int vgafb_post_load(void *opaque, int version_id)
{
    vgafb_invalidate_display(opaque);
    return 0;
}

static const VMStateDescription vmstate_milkymist_vgafb = {
    .name = "milkymist-vgafb",
    .version_id = 1,
    .minimum_version_id = 1,
    .minimum_version_id_old = 1,
    .post_load = vgafb_post_load,
    .fields      = (VMStateField[]) {
        VMSTATE_UINT32_ARRAY(regs, MilkymistVgafbState, R_MAX),
        VMSTATE_END_OF_LIST()
    }
};

static Property milkymist_vgafb_properties[] = {
    DEFINE_PROP_UINT32("fb_offset", MilkymistVgafbState, fb_offset, 0x0),
    DEFINE_PROP_UINT32("fb_mask", MilkymistVgafbState, fb_mask, 0xffffffff),
    DEFINE_PROP_END_OF_LIST(),
};

static void milkymist_vgafb_class_init(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);
    SysBusDeviceClass *k = SYS_BUS_DEVICE_CLASS(klass);

    k->init = milkymist_vgafb_init;
    dc->reset = milkymist_vgafb_reset;
    dc->vmsd = &vmstate_milkymist_vgafb;
    dc->props = milkymist_vgafb_properties;
}

static TypeInfo milkymist_vgafb_info = {
    .name          = "milkymist-vgafb",
    .parent        = TYPE_SYS_BUS_DEVICE,
    .instance_size = sizeof(MilkymistVgafbState),
    .class_init    = milkymist_vgafb_class_init,
};

static void milkymist_vgafb_register_types(void)
{
    type_register_static(&milkymist_vgafb_info);
}

type_init(milkymist_vgafb_register_types)
Commit	Line	Data
d23948b1 MW	1
	2	/*
	3	* QEMU model of the Milkymist VGA framebuffer.
	4	*
a3b6181e	5	* Copyright (c) 2010-2012 Michael Walle <michael@walle.cc>
d23948b1 MW	6	*
	7	* This library is free software; you can redistribute it and/or
	8	* modify it under the terms of the GNU Lesser General Public
	9	* License as published by the Free Software Foundation; either
	10	* version 2 of the License, or (at your option) any later version.
	11	*
	12	* This library is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	* Lesser General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU Lesser General Public
	18	* License along with this library; if not, see <http://www.gnu.org/licenses/>.
	19	*
	20	*
	21	* Specification available at:
	22	* http://www.milkymist.org/socdoc/vgafb.pdf
	23	*/
	24
	25	#include "hw.h"
	26	#include "sysbus.h"
	27	#include "trace.h"
	28	#include "console.h"
	29	#include "framebuffer.h"
	30	#include "pixel_ops.h"
	31	#include "qemu-error.h"
	32
	33	#define BITS 8
	34	#include "milkymist-vgafb_template.h"
	35	#define BITS 15
	36	#include "milkymist-vgafb_template.h"
	37	#define BITS 16
	38	#include "milkymist-vgafb_template.h"
	39	#define BITS 24
	40	#include "milkymist-vgafb_template.h"
	41	#define BITS 32
	42	#include "milkymist-vgafb_template.h"
	43
	44	enum {
	45	R_CTRL = 0,
	46	R_HRES,
	47	R_HSYNC_START,
	48	R_HSYNC_END,
	49	R_HSCAN,
	50	R_VRES,
	51	R_VSYNC_START,
	52	R_VSYNC_END,
	53	R_VSCAN,
	54	R_BASEADDRESS,
	55	R_BASEADDRESS_ACT,
	56	R_BURST_COUNT,
a3b6181e	57	R_DDC,
d23948b1 MW	58	R_SOURCE_CLOCK,
	59	R_MAX
	60	};
	61
	62	enum {
	63	CTRL_RESET = (1<<0),
	64	};
	65
	66	struct MilkymistVgafbState {
	67	SysBusDevice busdev;
883abf8d	68	MemoryRegion regs_region;
d23948b1 MW	69	DisplayState *ds;
	70
	71	int invalidate;
	72	uint32_t fb_offset;
	73	uint32_t fb_mask;
	74
	75	uint32_t regs[R_MAX];
	76	};
	77	typedef struct MilkymistVgafbState MilkymistVgafbState;
	78
	79	static int vgafb_enabled(MilkymistVgafbState *s)
	80	{
	81	return !(s->regs[R_CTRL] & CTRL_RESET);
	82	}
	83
	84	static void vgafb_update_display(void *opaque)
	85	{
	86	MilkymistVgafbState *s = opaque;
	87	int first = 0;
	88	int last = 0;
	89	drawfn fn;
	90
	91	if (!vgafb_enabled(s)) {
	92	return;
	93	}
	94
	95	int dest_width = s->regs[R_HRES];
	96
	97	switch (ds_get_bits_per_pixel(s->ds)) {
	98	case 0:
	99	return;
	100	case 8:
	101	fn = draw_line_8;
	102	break;
	103	case 15:
	104	fn = draw_line_15;
	105	dest_width *= 2;
	106	break;
	107	case 16:
	108	fn = draw_line_16;
	109	dest_width *= 2;
	110	break;
	111	case 24:
	112	fn = draw_line_24;
	113	dest_width *= 3;
	114	break;
	115	case 32:
	116	fn = draw_line_32;
	117	dest_width *= 4;
	118	break;
	119	default:
	120	hw_error("milkymist_vgafb: bad color depth\n");
	121	break;
	122	}
	123
75c9d6c2	124	framebuffer_update_display(s->ds, sysbus_address_space(&s->busdev),
d23948b1 MW	125	s->regs[R_BASEADDRESS] + s->fb_offset,
	126	s->regs[R_HRES],
	127	s->regs[R_VRES],
	128	s->regs[R_HRES] * 2,
	129	dest_width,
	130	0,
	131	s->invalidate,
	132	fn,
	133	NULL,
	134	&first, &last);
	135
	136	if (first >= 0) {
	137	dpy_update(s->ds, 0, first, s->regs[R_HRES], last - first + 1);
	138	}
	139	s->invalidate = 0;
	140	}
	141
	142	static void vgafb_invalidate_display(void *opaque)
	143	{
	144	MilkymistVgafbState *s = opaque;
	145	s->invalidate = 1;
	146	}
	147
	148	static void vgafb_resize(MilkymistVgafbState *s)
	149	{
	150	if (!vgafb_enabled(s)) {
	151	return;
	152	}
	153
	154	qemu_console_resize(s->ds, s->regs[R_HRES], s->regs[R_VRES]);
	155	s->invalidate = 1;
	156	}
	157
a8170e5e	158	static uint64_t vgafb_read(void *opaque, hwaddr addr,
883abf8d	159	unsigned size)
d23948b1 MW	160	{
	161	MilkymistVgafbState *s = opaque;
	162	uint32_t r = 0;
	163
	164	addr >>= 2;
	165	switch (addr) {
	166	case R_CTRL:
	167	case R_HRES:
	168	case R_HSYNC_START:
	169	case R_HSYNC_END:
	170	case R_HSCAN:
	171	case R_VRES:
	172	case R_VSYNC_START:
	173	case R_VSYNC_END:
	174	case R_VSCAN:
	175	case R_BASEADDRESS:
	176	case R_BURST_COUNT:
a3b6181e	177	case R_DDC:
d23948b1 MW	178	case R_SOURCE_CLOCK:
	179	r = s->regs[addr];
	180	break;
	181	case R_BASEADDRESS_ACT:
	182	r = s->regs[R_BASEADDRESS];
	183	break;
	184
	185	default:
	186	error_report("milkymist_vgafb: read access to unknown register 0x"
	187	TARGET_FMT_plx, addr << 2);
	188	break;
	189	}
	190
	191	trace_milkymist_vgafb_memory_read(addr << 2, r);
	192
	193	return r;
	194	}
	195
a8170e5e	196	static void vgafb_write(void *opaque, hwaddr addr, uint64_t value,
883abf8d	197	unsigned size)
d23948b1 MW	198	{
	199	MilkymistVgafbState *s = opaque;
	200
	201	trace_milkymist_vgafb_memory_write(addr, value);
	202
	203	addr >>= 2;
	204	switch (addr) {
	205	case R_CTRL:
c07050dd MW	206	s->regs[addr] = value;
	207	vgafb_resize(s);
	208	break;
d23948b1 MW	209	case R_HSYNC_START:
	210	case R_HSYNC_END:
	211	case R_HSCAN:
	212	case R_VSYNC_START:
	213	case R_VSYNC_END:
	214	case R_VSCAN:
	215	case R_BURST_COUNT:
a3b6181e	216	case R_DDC:
d23948b1 MW	217	case R_SOURCE_CLOCK:
	218	s->regs[addr] = value;
	219	break;
	220	case R_BASEADDRESS:
	221	if (value & 0x1f) {
	222	error_report("milkymist_vgafb: framebuffer base address have to "
	223	"be 32 byte aligned");
	224	break;
	225	}
	226	s->regs[addr] = value & s->fb_mask;
	227	s->invalidate = 1;
	228	break;
	229	case R_HRES:
	230	case R_VRES:
	231	s->regs[addr] = value;
	232	vgafb_resize(s);
	233	break;
	234	case R_BASEADDRESS_ACT:
	235	error_report("milkymist_vgafb: write to read-only register 0x"
	236	TARGET_FMT_plx, addr << 2);
	237	break;
	238
	239	default:
	240	error_report("milkymist_vgafb: write access to unknown register 0x"
	241	TARGET_FMT_plx, addr << 2);
	242	break;
	243	}
	244	}
	245
883abf8d MW	246	static const MemoryRegionOps vgafb_mmio_ops = {
	247	.read = vgafb_read,
	248	.write = vgafb_write,
	249	.valid = {
	250	.min_access_size = 4,
	251	.max_access_size = 4,
	252	},
	253	.endianness = DEVICE_NATIVE_ENDIAN,
d23948b1 MW	254	};
	255
	256	static void milkymist_vgafb_reset(DeviceState *d)
	257	{
	258	MilkymistVgafbState *s = container_of(d, MilkymistVgafbState, busdev.qdev);
	259	int i;
	260
	261	for (i = 0; i < R_MAX; i++) {
	262	s->regs[i] = 0;
	263	}
	264
	265	/* defaults */
	266	s->regs[R_CTRL] = CTRL_RESET;
	267	s->regs[R_HRES] = 640;
	268	s->regs[R_VRES] = 480;
	269	s->regs[R_BASEADDRESS] = 0;
	270	}
	271
	272	static int milkymist_vgafb_init(SysBusDevice *dev)
	273	{
	274	MilkymistVgafbState s = FROM_SYSBUS(typeof(s), dev);
d23948b1	275
883abf8d MW	276	memory_region_init_io(&s->regs_region, &vgafb_mmio_ops, s,
883abf8d MW	277	"milkymist-vgafb", R_MAX * 4);
750ecd44	278	sysbus_init_mmio(dev, &s->regs_region);
d23948b1 MW	279
	280	s->ds = graphic_console_init(vgafb_update_display,
	281	vgafb_invalidate_display,
	282	NULL, NULL, s);
	283
	284	return 0;
	285	}
	286
	287	static int vgafb_post_load(void *opaque, int version_id)
	288	{
	289	vgafb_invalidate_display(opaque);
	290	return 0;
	291	}
	292
	293	static const VMStateDescription vmstate_milkymist_vgafb = {
	294	.name = "milkymist-vgafb",
	295	.version_id = 1,
	296	.minimum_version_id = 1,
	297	.minimum_version_id_old = 1,
	298	.post_load = vgafb_post_load,
	299	.fields = (VMStateField[]) {
	300	VMSTATE_UINT32_ARRAY(regs, MilkymistVgafbState, R_MAX),
	301	VMSTATE_END_OF_LIST()
	302	}
	303	};
	304
999e12bb AL	305	static Property milkymist_vgafb_properties[] = {
	306	DEFINE_PROP_UINT32("fb_offset", MilkymistVgafbState, fb_offset, 0x0),
	307	DEFINE_PROP_UINT32("fb_mask", MilkymistVgafbState, fb_mask, 0xffffffff),
	308	DEFINE_PROP_END_OF_LIST(),
	309	};
	310
	311	static void milkymist_vgafb_class_init(ObjectClass klass, void data)
	312	{
39bffca2	313	DeviceClass *dc = DEVICE_CLASS(klass);
999e12bb AL	314	SysBusDeviceClass *k = SYS_BUS_DEVICE_CLASS(klass);
	315
	316	k->init = milkymist_vgafb_init;
39bffca2 AL	317	dc->reset = milkymist_vgafb_reset;
	318	dc->vmsd = &vmstate_milkymist_vgafb;
	319	dc->props = milkymist_vgafb_properties;
999e12bb AL	320	}
999e12bb AL	321
39bffca2 AL	322	static TypeInfo milkymist_vgafb_info = {
	323	.name = "milkymist-vgafb",
	324	.parent = TYPE_SYS_BUS_DEVICE,
	325	.instance_size = sizeof(MilkymistVgafbState),
	326	.class_init = milkymist_vgafb_class_init,
d23948b1 MW	327	};
d23948b1 MW	328
83f7d43a	329	static void milkymist_vgafb_register_types(void)
d23948b1	330	{
39bffca2	331	type_register_static(&milkymist_vgafb_info);
d23948b1 MW	332	}
d23948b1 MW	333
83f7d43a	334	type_init(milkymist_vgafb_register_types)