[qemu.git] / hw / gus.c

/*
 * QEMU Proxy for Gravis Ultrasound GF1 emulation by Tibor "TS" Schütz
 *
 * Copyright (c) 2002-2005 Vassili Karpov (malc)
 *
 * 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.
 */
#include "hw/hw.h"
#include "hw/audio/audio.h"
#include "audio/audio.h"
#include "hw/isa/isa.h"
#include "hw/gusemu.h"
#include "hw/gustate.h"

#define dolog(...) AUD_log ("audio", __VA_ARGS__)
#ifdef DEBUG
#define ldebug(...) dolog (__VA_ARGS__)
#else
#define ldebug(...)
#endif

#ifdef HOST_WORDS_BIGENDIAN
#define GUS_ENDIANNESS 1
#else
#define GUS_ENDIANNESS 0
#endif

#define IO_READ_PROTO(name) \
    static uint32_t name (void *opaque, uint32_t nport)
#define IO_WRITE_PROTO(name) \
    static void name (void *opaque, uint32_t nport, uint32_t val)

typedef struct GUSState {
    ISADevice dev;
    GUSEmuState emu;
    QEMUSoundCard card;
    uint32_t freq;
    uint32_t port;
    int pos, left, shift, irqs;
    GUSsample *mixbuf;
    uint8_t himem[1024 * 1024 + 32 + 4096];
    int samples;
    SWVoiceOut *voice;
    int64_t last_ticks;
    qemu_irq pic;
} GUSState;

IO_READ_PROTO (gus_readb)
{
    GUSState *s = opaque;

    return gus_read (&s->emu, nport, 1);
}

IO_READ_PROTO (gus_readw)
{
    GUSState *s = opaque;

    return gus_read (&s->emu, nport, 2);
}

IO_WRITE_PROTO (gus_writeb)
{
    GUSState *s = opaque;

    gus_write (&s->emu, nport, 1, val);
}

IO_WRITE_PROTO (gus_writew)
{
    GUSState *s = opaque;

    gus_write (&s->emu, nport, 2, val);
}

static int write_audio (GUSState *s, int samples)
{
    int net = 0;
    int pos = s->pos;

    while (samples) {
        int nbytes, wbytes, wsampl;

        nbytes = samples << s->shift;
        wbytes = AUD_write (
            s->voice,
            s->mixbuf + (pos << (s->shift - 1)),
            nbytes
            );

        if (wbytes) {
            wsampl = wbytes >> s->shift;

            samples -= wsampl;
            pos = (pos + wsampl) % s->samples;

            net += wsampl;
        }
        else {
            break;
        }
    }

    return net;
}

static void GUS_callback (void *opaque, int free)
{
    int samples, to_play, net = 0;
    GUSState *s = opaque;

    samples = free >> s->shift;
    to_play = audio_MIN (samples, s->left);

    while (to_play) {
        int written = write_audio (s, to_play);

        if (!written) {
            goto reset;
        }

        s->left -= written;
        to_play -= written;
        samples -= written;
        net += written;
    }

    samples = audio_MIN (samples, s->samples);
    if (samples) {
        gus_mixvoices (&s->emu, s->freq, samples, s->mixbuf);

        while (samples) {
            int written = write_audio (s, samples);
            if (!written) {
                break;
            }
            samples -= written;
            net += written;
        }
    }
    s->left = samples;

 reset:
    gus_irqgen (&s->emu, muldiv64 (net, 1000000, s->freq));
}

int GUS_irqrequest (GUSEmuState *emu, int hwirq, int n)
{
    GUSState *s = emu->opaque;
    /* qemu_irq_lower (s->pic); */
    qemu_irq_raise (s->pic);
    s->irqs += n;
    ldebug ("irqrequest %d %d %d\n", hwirq, n, s->irqs);
    return n;
}

void GUS_irqclear (GUSEmuState *emu, int hwirq)
{
    GUSState *s = emu->opaque;
    ldebug ("irqclear %d %d\n", hwirq, s->irqs);
    qemu_irq_lower (s->pic);
    s->irqs -= 1;
#ifdef IRQ_STORM
    if (s->irqs > 0) {
        qemu_irq_raise (s->pic[hwirq]);
    }
#endif
}

void GUS_dmarequest (GUSEmuState *der)
{
    /* GUSState *s = (GUSState *) der; */
    ldebug ("dma request %d\n", der->gusdma);
    DMA_hold_DREQ (der->gusdma);
}

static int GUS_read_DMA (void *opaque, int nchan, int dma_pos, int dma_len)
{
    GUSState *s = opaque;
    char tmpbuf[4096];
    int pos = dma_pos, mode, left = dma_len - dma_pos;

    ldebug ("read DMA %#x %d\n", dma_pos, dma_len);
    mode = DMA_get_channel_mode (s->emu.gusdma);
    while (left) {
        int to_copy = audio_MIN ((size_t) left, sizeof (tmpbuf));
        int copied;

        ldebug ("left=%d to_copy=%d pos=%d\n", left, to_copy, pos);
        copied = DMA_read_memory (nchan, tmpbuf, pos, to_copy);
        gus_dma_transferdata (&s->emu, tmpbuf, copied, left == copied);
        left -= copied;
        pos += copied;
    }

    if (0 == ((mode >> 4) & 1)) {
        DMA_release_DREQ (s->emu.gusdma);
    }
    return dma_len;
}

static const VMStateDescription vmstate_gus = {
    .name = "gus",
    .version_id = 2,
    .minimum_version_id = 2,
    .minimum_version_id_old = 2,
    .fields      = (VMStateField []) {
        VMSTATE_INT32 (pos, GUSState),
        VMSTATE_INT32 (left, GUSState),
        VMSTATE_INT32 (shift, GUSState),
        VMSTATE_INT32 (irqs, GUSState),
        VMSTATE_INT32 (samples, GUSState),
        VMSTATE_INT64 (last_ticks, GUSState),
        VMSTATE_BUFFER (himem, GUSState),
        VMSTATE_END_OF_LIST ()
    }
};

static const MemoryRegionPortio gus_portio_list1[] = {
    {0x000,  1, 1, .write = gus_writeb },
    {0x000,  1, 2, .write = gus_writew },
    {0x006, 10, 1, .read = gus_readb, .write = gus_writeb },
    {0x006, 10, 2, .read = gus_readw, .write = gus_writew },
    {0x100,  8, 1, .read = gus_readb, .write = gus_writeb },
    {0x100,  8, 2, .read = gus_readw, .write = gus_writew },
    PORTIO_END_OF_LIST (),
};

static const MemoryRegionPortio gus_portio_list2[] = {
    {0, 1, 1, .read = gus_readb },
    {0, 1, 2, .read = gus_readw },
    PORTIO_END_OF_LIST (),
};

static int gus_initfn (ISADevice *dev)
{
    GUSState *s = DO_UPCAST (GUSState, dev, dev);
    struct audsettings as;

    AUD_register_card ("gus", &s->card);

    as.freq = s->freq;
    as.nchannels = 2;
    as.fmt = AUD_FMT_S16;
    as.endianness = GUS_ENDIANNESS;

    s->voice = AUD_open_out (
        &s->card,
        NULL,
        "gus",
        s,
        GUS_callback,
        &as
        );

    if (!s->voice) {
        AUD_remove_card (&s->card);
        return -1;
    }

    s->shift = 2;
    s->samples = AUD_get_buffer_size_out (s->voice) >> s->shift;
    s->mixbuf = g_malloc0 (s->samples << s->shift);

    isa_register_portio_list (dev, s->port, gus_portio_list1, s, "gus");
    isa_register_portio_list (dev, (s->port + 0x100) & 0xf00,
                              gus_portio_list2, s, "gus");

    DMA_register_channel (s->emu.gusdma, GUS_read_DMA, s);
    s->emu.himemaddr = s->himem;
    s->emu.gusdatapos = s->emu.himemaddr + 1024 * 1024 + 32;
    s->emu.opaque = s;
    isa_init_irq (dev, &s->pic, s->emu.gusirq);

    AUD_set_active_out (s->voice, 1);

    return 0;
}

int GUS_init (ISABus *bus)
{
    isa_create_simple (bus, "gus");
    return 0;
}

static Property gus_properties[] = {
    DEFINE_PROP_UINT32 ("freq",    GUSState, freq,        44100),
    DEFINE_PROP_HEX32  ("iobase",  GUSState, port,        0x240),
    DEFINE_PROP_UINT32 ("irq",     GUSState, emu.gusirq,  7),
    DEFINE_PROP_UINT32 ("dma",     GUSState, emu.gusdma,  3),
    DEFINE_PROP_END_OF_LIST (),
};

static void gus_class_initfn (ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS (klass);
    ISADeviceClass *ic = ISA_DEVICE_CLASS (klass);
    ic->init = gus_initfn;
    dc->desc = "Gravis Ultrasound GF1";
    dc->vmsd = &vmstate_gus;
    dc->props = gus_properties;
}

static const TypeInfo gus_info = {
    .name          = "gus",
    .parent        = TYPE_ISA_DEVICE,
    .instance_size = sizeof (GUSState),
    .class_init    = gus_class_initfn,
};

static void gus_register_types (void)
{
    type_register_static (&gus_info);
}

type_init (gus_register_types)
Commit	Line	Data
423d65f4 AZ	1	/*
	2	* QEMU Proxy for Gravis Ultrasound GF1 emulation by Tibor "TS" Schütz
	3	*
	4	* Copyright (c) 2002-2005 Vassili Karpov (malc)
	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	*/
83c9f4ca	24	#include "hw/hw.h"
0d09e41a	25	#include "hw/audio/audio.h"
423d65f4	26	#include "audio/audio.h"
0d09e41a	27	#include "hw/isa/isa.h"
83c9f4ca PB	28	#include "hw/gusemu.h"
83c9f4ca PB	29	#include "hw/gustate.h"
423d65f4 AZ	30
	31	#define dolog(...) AUD_log ("audio", __VA_ARGS__)
	32	#ifdef DEBUG
	33	#define ldebug(...) dolog (__VA_ARGS__)
	34	#else
	35	#define ldebug(...)
	36	#endif
	37
e2542fe2	38	#ifdef HOST_WORDS_BIGENDIAN
423d65f4 AZ	39	#define GUS_ENDIANNESS 1
	40	#else
	41	#define GUS_ENDIANNESS 0
	42	#endif
	43
	44	#define IO_READ_PROTO(name) \
371bc573	45	static uint32_t name (void *opaque, uint32_t nport)
423d65f4	46	#define IO_WRITE_PROTO(name) \
371bc573	47	static void name (void *opaque, uint32_t nport, uint32_t val)
423d65f4	48
423d65f4	49	typedef struct GUSState {
9df34396	50	ISADevice dev;
423d65f4 AZ	51	GUSEmuState emu;
423d65f4 AZ	52	QEMUSoundCard card;
9df34396 GH	53	uint32_t freq;
9df34396 GH	54	uint32_t port;
423d65f4	55	int pos, left, shift, irqs;
731ba0ce	56	GUSsample *mixbuf;
423d65f4 AZ	57	uint8_t himem[1024 * 1024 + 32 + 4096];
	58	int samples;
	59	SWVoiceOut *voice;
	60	int64_t last_ticks;
9df34396	61	qemu_irq pic;
423d65f4 AZ	62	} GUSState;
	63
	64	IO_READ_PROTO (gus_readb)
	65	{
	66	GUSState *s = opaque;
	67
	68	return gus_read (&s->emu, nport, 1);
	69	}
	70
	71	IO_READ_PROTO (gus_readw)
	72	{
	73	GUSState *s = opaque;
	74
	75	return gus_read (&s->emu, nport, 2);
	76	}
	77
	78	IO_WRITE_PROTO (gus_writeb)
	79	{
	80	GUSState *s = opaque;
	81
	82	gus_write (&s->emu, nport, 1, val);
	83	}
	84
	85	IO_WRITE_PROTO (gus_writew)
	86	{
	87	GUSState *s = opaque;
	88
	89	gus_write (&s->emu, nport, 2, val);
	90	}
	91
	92	static int write_audio (GUSState *s, int samples)
	93	{
	94	int net = 0;
	95	int pos = s->pos;
	96
	97	while (samples) {
	98	int nbytes, wbytes, wsampl;
	99
	100	nbytes = samples << s->shift;
	101	wbytes = AUD_write (
	102	s->voice,
	103	s->mixbuf + (pos << (s->shift - 1)),
	104	nbytes
	105	);
	106
	107	if (wbytes) {
	108	wsampl = wbytes >> s->shift;
	109
	110	samples -= wsampl;
	111	pos = (pos + wsampl) % s->samples;
	112
	113	net += wsampl;
	114	}
	115	else {
	116	break;
	117	}
	118	}
	119
	120	return net;
	121	}
	122
	123	static void GUS_callback (void *opaque, int free)
	124	{
	125	int samples, to_play, net = 0;
126	GUSState *s = opaque;
127
128	samples = free >> s->shift;
129	to_play = audio_MIN (samples, s->left);
130
131	while (to_play) {
132	int written = write_audio (s, to_play);
133
134	if (!written) {
135	goto reset;
136	}
137
138	s->left -= written;
139	to_play -= written;
140	samples -= written;
141	net += written;
142	}
143
144	samples = audio_MIN (samples, s->samples);
145	if (samples) {
146	gus_mixvoices (&s->emu, s->freq, samples, s->mixbuf);
147
148	while (samples) {
149	int written = write_audio (s, samples);
150	if (!written) {
151	break;
152	}
153	samples -= written;
154	net += written;
155	}
156	}
157	s->left = samples;
158
4f4cc0ef	159	reset:
4f4cc0ef	160	gus_irqgen (&s->emu, muldiv64 (net, 1000000, s->freq));
423d65f4 AZ	161	}
	162
	163	int GUS_irqrequest (GUSEmuState *emu, int hwirq, int n)
	164	{
	165	GUSState *s = emu->opaque;
9df34396 GH	166	/* qemu_irq_lower (s->pic); */
9df34396 GH	167	qemu_irq_raise (s->pic);
423d65f4 AZ	168	s->irqs += n;
	169	ldebug ("irqrequest %d %d %d\n", hwirq, n, s->irqs);
	170	return n;
	171	}
	172
	173	void GUS_irqclear (GUSEmuState *emu, int hwirq)
	174	{
	175	GUSState *s = emu->opaque;
	176	ldebug ("irqclear %d %d\n", hwirq, s->irqs);
9df34396	177	qemu_irq_lower (s->pic);
423d65f4 AZ	178	s->irqs -= 1;
	179	#ifdef IRQ_STORM
	180	if (s->irqs > 0) {
	181	qemu_irq_raise (s->pic[hwirq]);
	182	}
	183	#endif
	184	}
	185
	186	void GUS_dmarequest (GUSEmuState *der)
	187	{
	188	/* GUSState s = (GUSState ) der; */
	189	ldebug ("dma request %d\n", der->gusdma);
	190	DMA_hold_DREQ (der->gusdma);
	191	}
	192
371bc573	193	static int GUS_read_DMA (void *opaque, int nchan, int dma_pos, int dma_len)
423d65f4 AZ	194	{
423d65f4 AZ	195	GUSState *s = opaque;
731ba0ce	196	char tmpbuf[4096];
423d65f4 AZ	197	int pos = dma_pos, mode, left = dma_len - dma_pos;
	198
	199	ldebug ("read DMA %#x %d\n", dma_pos, dma_len);
	200	mode = DMA_get_channel_mode (s->emu.gusdma);
	201	while (left) {
	202	int to_copy = audio_MIN ((size_t) left, sizeof (tmpbuf));
	203	int copied;
	204
	205	ldebug ("left=%d to_copy=%d pos=%d\n", left, to_copy, pos);
	206	copied = DMA_read_memory (nchan, tmpbuf, pos, to_copy);
	207	gus_dma_transferdata (&s->emu, tmpbuf, copied, left == copied);
	208	left -= copied;
	209	pos += copied;
	210	}
	211
	212	if (0 == ((mode >> 4) & 1)) {
	213	DMA_release_DREQ (s->emu.gusdma);
	214	}
	215	return dma_len;
	216	}
	217
709ae102 JQ	218	static const VMStateDescription vmstate_gus = {
	219	.name = "gus",
	220	.version_id = 2,
	221	.minimum_version_id = 2,
	222	.minimum_version_id_old = 2,
	223	.fields = (VMStateField []) {
cf4dc461	224	VMSTATE_INT32 (pos, GUSState),
	225	VMSTATE_INT32 (left, GUSState),
	226	VMSTATE_INT32 (shift, GUSState),
	227	VMSTATE_INT32 (irqs, GUSState),
	228	VMSTATE_INT32 (samples, GUSState),
	229	VMSTATE_INT64 (last_ticks, GUSState),
	230	VMSTATE_BUFFER (himem, GUSState),
	231	VMSTATE_END_OF_LIST ()
709ae102 JQ	232	}
709ae102 JQ	233	};
5b5ef0db	234
d7adb96f RH	235	static const MemoryRegionPortio gus_portio_list1[] = {
	236	{0x000, 1, 1, .write = gus_writeb },
	237	{0x000, 1, 2, .write = gus_writew },
	238	{0x006, 10, 1, .read = gus_readb, .write = gus_writeb },
	239	{0x006, 10, 2, .read = gus_readw, .write = gus_writew },
	240	{0x100, 8, 1, .read = gus_readb, .write = gus_writeb },
	241	{0x100, 8, 2, .read = gus_readw, .write = gus_writew },
cf4dc461	242	PORTIO_END_OF_LIST (),
d7adb96f RH	243	};
	244
	245	static const MemoryRegionPortio gus_portio_list2[] = {
	246	{0, 1, 1, .read = gus_readb },
	247	{0, 1, 2, .read = gus_readw },
cf4dc461	248	PORTIO_END_OF_LIST (),
d7adb96f RH	249	};
d7adb96f RH	250
9df34396	251	static int gus_initfn (ISADevice *dev)
423d65f4	252	{
8acbc9b2	253	GUSState *s = DO_UPCAST (GUSState, dev, dev);
1ea879e5	254	struct audsettings as;
423d65f4	255
1a7dafce	256	AUD_register_card ("gus", &s->card);
423d65f4	257
9df34396	258	as.freq = s->freq;
423d65f4 AZ	259	as.nchannels = 2;
	260	as.fmt = AUD_FMT_S16;
	261	as.endianness = GUS_ENDIANNESS;
	262
	263	s->voice = AUD_open_out (
	264	&s->card,
	265	NULL,
	266	"gus",
	267	s,
	268	GUS_callback,
	269	&as
	270	);
	271
	272	if (!s->voice) {
	273	AUD_remove_card (&s->card);
423d65f4 AZ	274	return -1;
	275	}
	276
	277	s->shift = 2;
	278	s->samples = AUD_get_buffer_size_out (s->voice) >> s->shift;
7267c094	279	s->mixbuf = g_malloc0 (s->samples << s->shift);
423d65f4	280
d7adb96f RH	281	isa_register_portio_list (dev, s->port, gus_portio_list1, s, "gus");
	282	isa_register_portio_list (dev, (s->port + 0x100) & 0xf00,
	283	gus_portio_list2, s, "gus");
423d65f4	284
a5e8e46b	285	DMA_register_channel (s->emu.gusdma, GUS_read_DMA, s);
423d65f4 AZ	286	s->emu.himemaddr = s->himem;
	287	s->emu.gusdatapos = s->emu.himemaddr + 1024 * 1024 + 32;
	288	s->emu.opaque = s;
a5e8e46b	289	isa_init_irq (dev, &s->pic, s->emu.gusirq);
423d65f4 AZ	290
423d65f4 AZ	291	AUD_set_active_out (s->voice, 1);
5b5ef0db	292
423d65f4 AZ	293	return 0;
423d65f4 AZ	294	}
9df34396	295
4a0f031d	296	int GUS_init (ISABus *bus)
9df34396	297	{
48a18b3c	298	isa_create_simple (bus, "gus");
9df34396 GH	299	return 0;
	300	}
	301
39bffca2 AL	302	static Property gus_properties[] = {
	303	DEFINE_PROP_UINT32 ("freq", GUSState, freq, 44100),
	304	DEFINE_PROP_HEX32 ("iobase", GUSState, port, 0x240),
	305	DEFINE_PROP_UINT32 ("irq", GUSState, emu.gusirq, 7),
	306	DEFINE_PROP_UINT32 ("dma", GUSState, emu.gusdma, 3),
	307	DEFINE_PROP_END_OF_LIST (),
	308	};
	309
cf4dc461	310	static void gus_class_initfn (ObjectClass klass, void data)
8f04ee08	311	{
cf4dc461	312	DeviceClass *dc = DEVICE_CLASS (klass);
cf4dc461	313	ISADeviceClass *ic = ISA_DEVICE_CLASS (klass);
8f04ee08	314	ic->init = gus_initfn;
39bffca2 AL	315	dc->desc = "Gravis Ultrasound GF1";
	316	dc->vmsd = &vmstate_gus;
	317	dc->props = gus_properties;
8f04ee08 AL	318	}
8f04ee08 AL	319
8c43a6f0	320	static const TypeInfo gus_info = {
39bffca2 AL	321	.name = "gus",
	322	.parent = TYPE_ISA_DEVICE,
	323	.instance_size = sizeof (GUSState),
	324	.class_init = gus_class_initfn,
9df34396 GH	325	};
9df34396 GH	326
83f7d43a	327	static void gus_register_types (void)
9df34396	328	{
cf4dc461	329	type_register_static (&gus_info);
9df34396	330	}
83f7d43a AF	331
83f7d43a AF	332	type_init (gus_register_types)