xref: /qemu/hw/audio/gus.c (revision abff1abf) 
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  */
24 
25 #include "qemu/osdep.h"
26 #include "qapi/error.h"
27 #include "qemu/module.h"
28 #include "hw/audio/soundhw.h"
29 #include "audio/audio.h"
30 #include "hw/irq.h"
31 #include "hw/isa/isa.h"
32 #include "hw/qdev-properties.h"
33 #include "migration/vmstate.h"
34 #include "gusemu.h"
35 #include "gustate.h"
36 
37 #define dolog(...) AUD_log ("audio", __VA_ARGS__)
38 #ifdef DEBUG
39 #define ldebug(...) dolog (__VA_ARGS__)
40 #else
41 #define ldebug(...)
42 #endif
43 
44 #define TYPE_GUS "gus"
45 #define GUS(obj) OBJECT_CHECK (GUSState, (obj), TYPE_GUS)
46 
47 typedef struct GUSState {
48     ISADevice dev;
49     GUSEmuState emu;
50     QEMUSoundCard card;
51     uint32_t freq;
52     uint32_t port;
53     int pos, left, shift, irqs;
54     int16_t *mixbuf;
55     uint8_t himem[1024 * 1024 + 32 + 4096];
56     int samples;
57     SWVoiceOut *voice;
58     int64_t last_ticks;
59     qemu_irq pic;
60     IsaDma *isa_dma;
61     PortioList portio_list1;
62     PortioList portio_list2;
63 } GUSState;
64 
65 static uint32_t gus_readb(void *opaque, uint32_t nport)
66 {
67     GUSState *s = opaque;
68 
69     return gus_read (&s->emu, nport, 1);
70 }
71 
72 static void gus_writeb(void *opaque, uint32_t nport, uint32_t val)
73 {
74     GUSState *s = opaque;
75 
76     gus_write (&s->emu, nport, 1, val);
77 }
78 
79 static int write_audio (GUSState *s, int samples)
80 {
81     int net = 0;
82     int pos = s->pos;
83 
84     while (samples) {
85         int nbytes, wbytes, wsampl;
86 
87         nbytes = samples << s->shift;
88         wbytes = AUD_write (
89             s->voice,
90             s->mixbuf + (pos << (s->shift - 1)),
91             nbytes
92             );
93 
94         if (wbytes) {
95             wsampl = wbytes >> s->shift;
96 
97             samples -= wsampl;
98             pos = (pos + wsampl) % s->samples;
99 
100             net += wsampl;
101         }
102         else {
103             break;
104         }
105     }
106 
107     return net;
108 }
109 
110 static void GUS_callback (void *opaque, int free)
111 {
112     int samples, to_play, net = 0;
113     GUSState *s = opaque;
114 
115     samples = free >> s->shift;
116     to_play = MIN (samples, s->left);
117 
118     while (to_play) {
119         int written = write_audio (s, to_play);
120 
121         if (!written) {
122             goto reset;
123         }
124 
125         s->left -= written;
126         to_play -= written;
127         samples -= written;
128         net += written;
129     }
130 
131     samples = MIN (samples, s->samples);
132     if (samples) {
133         gus_mixvoices (&s->emu, s->freq, samples, s->mixbuf);
134 
135         while (samples) {
136             int written = write_audio (s, samples);
137             if (!written) {
138                 break;
139             }
140             samples -= written;
141             net += written;
142         }
143     }
144     s->left = samples;
145 
146  reset:
147     gus_irqgen (&s->emu, (uint64_t)net * 1000000 / s->freq);
148 }
149 
150 int GUS_irqrequest (GUSEmuState *emu, int hwirq, int n)
151 {
152     GUSState *s = emu->opaque;
153     /* qemu_irq_lower (s->pic); */
154     qemu_irq_raise (s->pic);
155     s->irqs += n;
156     ldebug ("irqrequest %d %d %d\n", hwirq, n, s->irqs);
157     return n;
158 }
159 
160 void GUS_irqclear (GUSEmuState *emu, int hwirq)
161 {
162     GUSState *s = emu->opaque;
163     ldebug ("irqclear %d %d\n", hwirq, s->irqs);
164     qemu_irq_lower (s->pic);
165     s->irqs -= 1;
166 #ifdef IRQ_STORM
167     if (s->irqs > 0) {
168         qemu_irq_raise (s->pic[hwirq]);
169     }
170 #endif
171 }
172 
173 void GUS_dmarequest (GUSEmuState *emu)
174 {
175     GUSState *s = emu->opaque;
176     IsaDmaClass *k = ISADMA_GET_CLASS(s->isa_dma);
177     ldebug ("dma request %d\n", der->gusdma);
178     k->hold_DREQ(s->isa_dma, s->emu.gusdma);
179 }
180 
181 static int GUS_read_DMA (void *opaque, int nchan, int dma_pos, int dma_len)
182 {
183     GUSState *s = opaque;
184     IsaDmaClass *k = ISADMA_GET_CLASS(s->isa_dma);
185     char tmpbuf[4096];
186     int pos = dma_pos, mode, left = dma_len - dma_pos;
187 
188     ldebug ("read DMA %#x %d\n", dma_pos, dma_len);
189     mode = k->has_autoinitialization(s->isa_dma, s->emu.gusdma);
190     while (left) {
191         int to_copy = MIN ((size_t) left, sizeof (tmpbuf));
192         int copied;
193 
194         ldebug ("left=%d to_copy=%d pos=%d\n", left, to_copy, pos);
195         copied = k->read_memory(s->isa_dma, nchan, tmpbuf, pos, to_copy);
196         gus_dma_transferdata (&s->emu, tmpbuf, copied, left == copied);
197         left -= copied;
198         pos += copied;
199     }
200 
201     if (((mode >> 4) & 1) == 0) {
202         k->release_DREQ(s->isa_dma, s->emu.gusdma);
203     }
204     return dma_len;
205 }
206 
207 static const VMStateDescription vmstate_gus = {
208     .name = "gus",
209     .version_id = 2,
210     .minimum_version_id = 2,
211     .fields = (VMStateField[]) {
212         VMSTATE_INT32 (pos, GUSState),
213         VMSTATE_INT32 (left, GUSState),
214         VMSTATE_INT32 (shift, GUSState),
215         VMSTATE_INT32 (irqs, GUSState),
216         VMSTATE_INT32 (samples, GUSState),
217         VMSTATE_INT64 (last_ticks, GUSState),
218         VMSTATE_BUFFER (himem, GUSState),
219         VMSTATE_END_OF_LIST ()
220     }
221 };
222 
223 static const MemoryRegionPortio gus_portio_list1[] = {
224     {0x000,  1, 1, .write = gus_writeb },
225     {0x006, 10, 1, .read = gus_readb, .write = gus_writeb },
226     {0x100,  8, 1, .read = gus_readb, .write = gus_writeb },
227     PORTIO_END_OF_LIST (),
228 };
229 
230 static const MemoryRegionPortio gus_portio_list2[] = {
231     {0, 2, 1, .read = gus_readb },
232     PORTIO_END_OF_LIST (),
233 };
234 
235 static void gus_realizefn (DeviceState *dev, Error **errp)
236 {
237     ISADevice *d = ISA_DEVICE(dev);
238     GUSState *s = GUS (dev);
239     IsaDmaClass *k;
240     struct audsettings as;
241 
242     s->isa_dma = isa_get_dma(isa_bus_from_device(d), s->emu.gusdma);
243     if (!s->isa_dma) {
244         error_setg(errp, "ISA controller does not support DMA");
245         return;
246     }
247 
248     AUD_register_card ("gus", &s->card);
249 
250     as.freq = s->freq;
251     as.nchannels = 2;
252     as.fmt = AUDIO_FORMAT_S16;
253     as.endianness = AUDIO_HOST_ENDIANNESS;
254 
255     s->voice = AUD_open_out (
256         &s->card,
257         NULL,
258         "gus",
259         s,
260         GUS_callback,
261         &as
262         );
263 
264     if (!s->voice) {
265         AUD_remove_card (&s->card);
266         error_setg(errp, "No voice");
267         return;
268     }
269 
270     s->shift = 2;
271     s->samples = AUD_get_buffer_size_out (s->voice) >> s->shift;
272     s->mixbuf = g_malloc0 (s->samples << s->shift);
273 
274     isa_register_portio_list(d, &s->portio_list1, s->port,
275                              gus_portio_list1, s, "gus");
276     isa_register_portio_list(d, &s->portio_list2, (s->port + 0x100) & 0xf00,
277                              gus_portio_list2, s, "gus");
278 
279     k = ISADMA_GET_CLASS(s->isa_dma);
280     k->register_channel(s->isa_dma, s->emu.gusdma, GUS_read_DMA, s);
281     s->emu.himemaddr = s->himem;
282     s->emu.gusdatapos = s->emu.himemaddr + 1024 * 1024 + 32;
283     s->emu.opaque = s;
284     isa_init_irq (d, &s->pic, s->emu.gusirq);
285 
286     AUD_set_active_out (s->voice, 1);
287 }
288 
289 static Property gus_properties[] = {
290     DEFINE_AUDIO_PROPERTIES(GUSState, card),
291     DEFINE_PROP_UINT32 ("freq",    GUSState, freq,        44100),
292     DEFINE_PROP_UINT32 ("iobase",  GUSState, port,        0x240),
293     DEFINE_PROP_UINT32 ("irq",     GUSState, emu.gusirq,  7),
294     DEFINE_PROP_UINT32 ("dma",     GUSState, emu.gusdma,  3),
295     DEFINE_PROP_END_OF_LIST (),
296 };
297 
298 static void gus_class_initfn (ObjectClass *klass, void *data)
299 {
300     DeviceClass *dc = DEVICE_CLASS (klass);
301 
302     dc->realize = gus_realizefn;
303     set_bit(DEVICE_CATEGORY_SOUND, dc->categories);
304     dc->desc = "Gravis Ultrasound GF1";
305     dc->vmsd = &vmstate_gus;
306     device_class_set_props(dc, gus_properties);
307 }
308 
309 static const TypeInfo gus_info = {
310     .name          = TYPE_GUS,
311     .parent        = TYPE_ISA_DEVICE,
312     .instance_size = sizeof (GUSState),
313     .class_init    = gus_class_initfn,
314 };
315 
316 static void gus_register_types (void)
317 {
318     type_register_static (&gus_info);
319     deprecated_register_soundhw("gus", "Gravis Ultrasound GF1", 1, TYPE_GUS);
320 }
321 
322 type_init (gus_register_types)
323