1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>,
4 * Hannu Savolainen 1993-1996,
7 * Routines for control of AdLib FM cards (OPL2/OPL3/OPL4 chips)
9 * Most if code is ported from OSS/Lite.
12 #include <sound/opl3.h>
14 #include <linux/delay.h>
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/slab.h>
18 #include <linux/ioport.h>
19 #include <sound/minors.h>
20 #include "opl3_voice.h"
22 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>, Hannu Savolainen 1993-1996, Rob Hooft");
23 MODULE_DESCRIPTION("Routines for control of AdLib FM cards (OPL2/OPL3/OPL4 chips)");
24 MODULE_LICENSE("GPL");
26 static void snd_opl2_command(struct snd_opl3 * opl3, unsigned short cmd, unsigned char val)
32 * The original 2-OP synth requires a quite long delay
33 * after writing to a register.
36 port = (cmd & OPL3_RIGHT) ? opl3->r_port : opl3->l_port;
38 spin_lock_irqsave(&opl3->reg_lock, flags);
40 outb((unsigned char) cmd, port);
43 outb((unsigned char) val, port + 1);
46 spin_unlock_irqrestore(&opl3->reg_lock, flags);
49 static void snd_opl3_command(struct snd_opl3 * opl3, unsigned short cmd, unsigned char val)
55 * The OPL-3 survives with just two INBs
56 * after writing to a register.
59 port = (cmd & OPL3_RIGHT) ? opl3->r_port : opl3->l_port;
61 spin_lock_irqsave(&opl3->reg_lock, flags);
63 outb((unsigned char) cmd, port);
67 outb((unsigned char) val, port + 1);
71 spin_unlock_irqrestore(&opl3->reg_lock, flags);
74 static int snd_opl3_detect(struct snd_opl3 * opl3)
77 * This function returns 1 if the FM chip is present at the given I/O port
78 * The detection algorithm plays with the timer built in the FM chip and
79 * looks for a change in the status register.
81 * Note! The timers of the FM chip are not connected to AdLib (and compatible)
84 * Note2! The chip is initialized if detected.
87 unsigned char stat1, stat2, signature;
89 /* Reset timers 1 and 2 */
90 opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, OPL3_TIMER1_MASK | OPL3_TIMER2_MASK);
91 /* Reset the IRQ of the FM chip */
92 opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, OPL3_IRQ_RESET);
93 signature = stat1 = inb(opl3->l_port); /* Status register */
94 if ((stat1 & 0xe0) != 0x00) { /* Should be 0x00 */
95 snd_printd("OPL3: stat1 = 0x%x\n", stat1);
98 /* Set timer1 to 0xff */
99 opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER1, 0xff);
100 /* Unmask and start timer 1 */
101 opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, OPL3_TIMER2_MASK | OPL3_TIMER1_START);
102 /* Now we have to delay at least 80us */
104 /* Read status after timers have expired */
105 stat2 = inb(opl3->l_port);
106 /* Stop the timers */
107 opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, OPL3_TIMER1_MASK | OPL3_TIMER2_MASK);
108 /* Reset the IRQ of the FM chip */
109 opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, OPL3_IRQ_RESET);
110 if ((stat2 & 0xe0) != 0xc0) { /* There is no YM3812 */
111 snd_printd("OPL3: stat2 = 0x%x\n", stat2);
115 /* If the toplevel code knows exactly the type of chip, don't try
117 if (opl3->hardware != OPL3_HW_AUTO)
120 /* There is a FM chip on this address. Detect the type (OPL2 to OPL4) */
121 if (signature == 0x06) { /* OPL2 */
122 opl3->hardware = OPL3_HW_OPL2;
125 * If we had an OPL4 chip, opl3->hardware would have been set
126 * by the OPL4 driver; so we can assume OPL3 here.
128 if (snd_BUG_ON(!opl3->r_port))
130 opl3->hardware = OPL3_HW_OPL3;
143 static int snd_opl3_timer1_start(struct snd_timer * timer)
148 struct snd_opl3 *opl3;
150 opl3 = snd_timer_chip(timer);
151 spin_lock_irqsave(&opl3->timer_lock, flags);
152 ticks = timer->sticks;
153 tmp = (opl3->timer_enable | OPL3_TIMER1_START) & ~OPL3_TIMER1_MASK;
154 opl3->timer_enable = tmp;
155 opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER1, 256 - ticks); /* timer 1 count */
156 opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, tmp); /* enable timer 1 IRQ */
157 spin_unlock_irqrestore(&opl3->timer_lock, flags);
161 static int snd_opl3_timer1_stop(struct snd_timer * timer)
165 struct snd_opl3 *opl3;
167 opl3 = snd_timer_chip(timer);
168 spin_lock_irqsave(&opl3->timer_lock, flags);
169 tmp = (opl3->timer_enable | OPL3_TIMER1_MASK) & ~OPL3_TIMER1_START;
170 opl3->timer_enable = tmp;
171 opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, tmp); /* disable timer #1 */
172 spin_unlock_irqrestore(&opl3->timer_lock, flags);
180 static int snd_opl3_timer2_start(struct snd_timer * timer)
185 struct snd_opl3 *opl3;
187 opl3 = snd_timer_chip(timer);
188 spin_lock_irqsave(&opl3->timer_lock, flags);
189 ticks = timer->sticks;
190 tmp = (opl3->timer_enable | OPL3_TIMER2_START) & ~OPL3_TIMER2_MASK;
191 opl3->timer_enable = tmp;
192 opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER2, 256 - ticks); /* timer 1 count */
193 opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, tmp); /* enable timer 1 IRQ */
194 spin_unlock_irqrestore(&opl3->timer_lock, flags);
198 static int snd_opl3_timer2_stop(struct snd_timer * timer)
202 struct snd_opl3 *opl3;
204 opl3 = snd_timer_chip(timer);
205 spin_lock_irqsave(&opl3->timer_lock, flags);
206 tmp = (opl3->timer_enable | OPL3_TIMER2_MASK) & ~OPL3_TIMER2_START;
207 opl3->timer_enable = tmp;
208 opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, tmp); /* disable timer #1 */
209 spin_unlock_irqrestore(&opl3->timer_lock, flags);
217 static const struct snd_timer_hardware snd_opl3_timer1 =
219 .flags = SNDRV_TIMER_HW_STOP,
222 .start = snd_opl3_timer1_start,
223 .stop = snd_opl3_timer1_stop,
226 static const struct snd_timer_hardware snd_opl3_timer2 =
228 .flags = SNDRV_TIMER_HW_STOP,
229 .resolution = 320000,
231 .start = snd_opl3_timer2_start,
232 .stop = snd_opl3_timer2_stop,
235 static int snd_opl3_timer1_init(struct snd_opl3 * opl3, int timer_no)
237 struct snd_timer *timer = NULL;
238 struct snd_timer_id tid;
241 tid.dev_class = SNDRV_TIMER_CLASS_CARD;
242 tid.dev_sclass = SNDRV_TIMER_SCLASS_NONE;
243 tid.card = opl3->card->number;
244 tid.device = timer_no;
246 if ((err = snd_timer_new(opl3->card, "AdLib timer #1", &tid, &timer)) >= 0) {
247 strcpy(timer->name, "AdLib timer #1");
248 timer->private_data = opl3;
249 timer->hw = snd_opl3_timer1;
251 opl3->timer1 = timer;
255 static int snd_opl3_timer2_init(struct snd_opl3 * opl3, int timer_no)
257 struct snd_timer *timer = NULL;
258 struct snd_timer_id tid;
261 tid.dev_class = SNDRV_TIMER_CLASS_CARD;
262 tid.dev_sclass = SNDRV_TIMER_SCLASS_NONE;
263 tid.card = opl3->card->number;
264 tid.device = timer_no;
266 if ((err = snd_timer_new(opl3->card, "AdLib timer #2", &tid, &timer)) >= 0) {
267 strcpy(timer->name, "AdLib timer #2");
268 timer->private_data = opl3;
269 timer->hw = snd_opl3_timer2;
271 opl3->timer2 = timer;
279 void snd_opl3_interrupt(struct snd_hwdep * hw)
281 unsigned char status;
282 struct snd_opl3 *opl3;
283 struct snd_timer *timer;
288 opl3 = hw->private_data;
289 status = inb(opl3->l_port);
291 snd_printk(KERN_DEBUG "AdLib IRQ status = 0x%x\n", status);
293 if (!(status & 0x80))
297 timer = opl3->timer1;
298 snd_timer_interrupt(timer, timer->sticks);
301 timer = opl3->timer2;
302 snd_timer_interrupt(timer, timer->sticks);
306 EXPORT_SYMBOL(snd_opl3_interrupt);
312 static int snd_opl3_free(struct snd_opl3 *opl3)
314 if (snd_BUG_ON(!opl3))
316 if (opl3->private_free)
317 opl3->private_free(opl3);
318 snd_opl3_clear_patches(opl3);
319 release_and_free_resource(opl3->res_l_port);
320 release_and_free_resource(opl3->res_r_port);
325 static int snd_opl3_dev_free(struct snd_device *device)
327 struct snd_opl3 *opl3 = device->device_data;
328 return snd_opl3_free(opl3);
331 int snd_opl3_new(struct snd_card *card,
332 unsigned short hardware,
333 struct snd_opl3 **ropl3)
335 static const struct snd_device_ops ops = {
336 .dev_free = snd_opl3_dev_free,
338 struct snd_opl3 *opl3;
342 opl3 = kzalloc(sizeof(*opl3), GFP_KERNEL);
347 opl3->hardware = hardware;
348 spin_lock_init(&opl3->reg_lock);
349 spin_lock_init(&opl3->timer_lock);
351 if ((err = snd_device_new(card, SNDRV_DEV_CODEC, opl3, &ops)) < 0) {
360 EXPORT_SYMBOL(snd_opl3_new);
362 int snd_opl3_init(struct snd_opl3 *opl3)
364 if (! opl3->command) {
365 printk(KERN_ERR "snd_opl3_init: command not defined!\n");
369 opl3->command(opl3, OPL3_LEFT | OPL3_REG_TEST, OPL3_ENABLE_WAVE_SELECT);
371 opl3->command(opl3, OPL3_LEFT | OPL3_REG_PERCUSSION, 0x00);
373 switch (opl3->hardware & OPL3_HW_MASK) {
375 opl3->max_voices = MAX_OPL2_VOICES;
379 opl3->max_voices = MAX_OPL3_VOICES;
380 /* Enter OPL3 mode */
381 opl3->command(opl3, OPL3_RIGHT | OPL3_REG_MODE, OPL3_OPL3_ENABLE);
386 EXPORT_SYMBOL(snd_opl3_init);
388 int snd_opl3_create(struct snd_card *card,
389 unsigned long l_port,
390 unsigned long r_port,
391 unsigned short hardware,
393 struct snd_opl3 ** ropl3)
395 struct snd_opl3 *opl3;
399 if ((err = snd_opl3_new(card, hardware, &opl3)) < 0)
402 if ((opl3->res_l_port = request_region(l_port, 2, "OPL2/3 (left)")) == NULL) {
403 snd_printk(KERN_ERR "opl3: can't grab left port 0x%lx\n", l_port);
404 snd_device_free(card, opl3);
408 (opl3->res_r_port = request_region(r_port, 2, "OPL2/3 (right)")) == NULL) {
409 snd_printk(KERN_ERR "opl3: can't grab right port 0x%lx\n", r_port);
410 snd_device_free(card, opl3);
414 opl3->l_port = l_port;
415 opl3->r_port = r_port;
417 switch (opl3->hardware) {
418 /* some hardware doesn't support timers */
419 case OPL3_HW_OPL3_SV:
420 case OPL3_HW_OPL3_CS:
421 case OPL3_HW_OPL3_FM801:
422 opl3->command = &snd_opl3_command;
425 opl3->command = &snd_opl2_command;
426 if ((err = snd_opl3_detect(opl3)) < 0) {
427 snd_printd("OPL2/3 chip not detected at 0x%lx/0x%lx\n",
428 opl3->l_port, opl3->r_port);
429 snd_device_free(card, opl3);
432 /* detect routine returns correct hardware type */
433 switch (opl3->hardware & OPL3_HW_MASK) {
436 opl3->command = &snd_opl3_command;
446 EXPORT_SYMBOL(snd_opl3_create);
448 int snd_opl3_timer_new(struct snd_opl3 * opl3, int timer1_dev, int timer2_dev)
453 if ((err = snd_opl3_timer1_init(opl3, timer1_dev)) < 0)
455 if (timer2_dev >= 0) {
456 if ((err = snd_opl3_timer2_init(opl3, timer2_dev)) < 0) {
457 snd_device_free(opl3->card, opl3->timer1);
465 EXPORT_SYMBOL(snd_opl3_timer_new);
467 int snd_opl3_hwdep_new(struct snd_opl3 * opl3,
468 int device, int seq_device,
469 struct snd_hwdep ** rhwdep)
471 struct snd_hwdep *hw;
472 struct snd_card *card = opl3->card;
478 /* create hardware dependent device (direct FM) */
480 if ((err = snd_hwdep_new(card, "OPL2/OPL3", device, &hw)) < 0) {
481 snd_device_free(card, opl3);
484 hw->private_data = opl3;
486 #ifdef CONFIG_SND_OSSEMUL
488 hw->oss_type = SNDRV_OSS_DEVICE_TYPE_DMFM;
490 strcpy(hw->name, hw->id);
491 switch (opl3->hardware & OPL3_HW_MASK) {
493 strcpy(hw->name, "OPL2 FM");
494 hw->iface = SNDRV_HWDEP_IFACE_OPL2;
497 strcpy(hw->name, "OPL3 FM");
498 hw->iface = SNDRV_HWDEP_IFACE_OPL3;
501 strcpy(hw->name, "OPL4 FM");
502 hw->iface = SNDRV_HWDEP_IFACE_OPL4;
506 /* operators - only ioctl */
507 hw->ops.open = snd_opl3_open;
508 hw->ops.ioctl = snd_opl3_ioctl;
509 hw->ops.write = snd_opl3_write;
510 hw->ops.release = snd_opl3_release;
513 opl3->seq_dev_num = seq_device;
514 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
515 if (snd_seq_device_new(card, seq_device, SNDRV_SEQ_DEV_ID_OPL3,
516 sizeof(struct snd_opl3 *), &opl3->seq_dev) >= 0) {
517 strcpy(opl3->seq_dev->name, hw->name);
518 *(struct snd_opl3 **)SNDRV_SEQ_DEVICE_ARGPTR(opl3->seq_dev) = opl3;
526 EXPORT_SYMBOL(snd_opl3_hwdep_new);