[mirror_ubuntu-jammy-kernel.git] / sound / drivers / opl3 / opl3_lib.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>,
 *                   Hannu Savolainen 1993-1996,
 *                   Rob Hooft
 *                   
 *  Routines for control of AdLib FM cards (OPL2/OPL3/OPL4 chips)
 *
 *  Most if code is ported from OSS/Lite.
 */

#include <sound/opl3.h>
#include <linux/io.h>
#include <linux/delay.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/ioport.h>
#include <sound/minors.h>
#include "opl3_voice.h"

MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>, Hannu Savolainen 1993-1996, Rob Hooft");
MODULE_DESCRIPTION("Routines for control of AdLib FM cards (OPL2/OPL3/OPL4 chips)");
MODULE_LICENSE("GPL");

static void snd_opl2_command(struct snd_opl3 * opl3, unsigned short cmd, unsigned char val)
{
	unsigned long flags;
	unsigned long port;

	/*
	 * The original 2-OP synth requires a quite long delay
	 * after writing to a register.
	 */

	port = (cmd & OPL3_RIGHT) ? opl3->r_port : opl3->l_port;

	spin_lock_irqsave(&opl3->reg_lock, flags);

	outb((unsigned char) cmd, port);
	udelay(10);

	outb((unsigned char) val, port + 1);
	udelay(30);

	spin_unlock_irqrestore(&opl3->reg_lock, flags);
}

static void snd_opl3_command(struct snd_opl3 * opl3, unsigned short cmd, unsigned char val)
{
	unsigned long flags;
	unsigned long port;

	/*
	 * The OPL-3 survives with just two INBs
	 * after writing to a register.
	 */

	port = (cmd & OPL3_RIGHT) ? opl3->r_port : opl3->l_port;

	spin_lock_irqsave(&opl3->reg_lock, flags);

	outb((unsigned char) cmd, port);
	inb(opl3->l_port);
	inb(opl3->l_port);

	outb((unsigned char) val, port + 1);
	inb(opl3->l_port);
	inb(opl3->l_port);

	spin_unlock_irqrestore(&opl3->reg_lock, flags);
}

static int snd_opl3_detect(struct snd_opl3 * opl3)
{
	/*
	 * This function returns 1 if the FM chip is present at the given I/O port
	 * The detection algorithm plays with the timer built in the FM chip and
	 * looks for a change in the status register.
	 *
	 * Note! The timers of the FM chip are not connected to AdLib (and compatible)
	 * boards.
	 *
	 * Note2! The chip is initialized if detected.
	 */

	unsigned char stat1, stat2, signature;

	/* Reset timers 1 and 2 */
	opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, OPL3_TIMER1_MASK | OPL3_TIMER2_MASK);
	/* Reset the IRQ of the FM chip */
	opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, OPL3_IRQ_RESET);
	signature = stat1 = inb(opl3->l_port);	/* Status register */
	if ((stat1 & 0xe0) != 0x00) {	/* Should be 0x00 */
		snd_printd("OPL3: stat1 = 0x%x\n", stat1);
		return -ENODEV;
	}
	/* Set timer1 to 0xff */
	opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER1, 0xff);
	/* Unmask and start timer 1 */
	opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, OPL3_TIMER2_MASK | OPL3_TIMER1_START);
	/* Now we have to delay at least 80us */
	udelay(200);
	/* Read status after timers have expired */
	stat2 = inb(opl3->l_port);
	/* Stop the timers */
	opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, OPL3_TIMER1_MASK | OPL3_TIMER2_MASK);
	/* Reset the IRQ of the FM chip */
	opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, OPL3_IRQ_RESET);
	if ((stat2 & 0xe0) != 0xc0) {	/* There is no YM3812 */
		snd_printd("OPL3: stat2 = 0x%x\n", stat2);
		return -ENODEV;
	}

	/* If the toplevel code knows exactly the type of chip, don't try
	   to detect it. */
	if (opl3->hardware != OPL3_HW_AUTO)
		return 0;

	/* There is a FM chip on this address. Detect the type (OPL2 to OPL4) */
	if (signature == 0x06) {	/* OPL2 */
		opl3->hardware = OPL3_HW_OPL2;
	} else {
		/*
		 * If we had an OPL4 chip, opl3->hardware would have been set
		 * by the OPL4 driver; so we can assume OPL3 here.
		 */
		if (snd_BUG_ON(!opl3->r_port))
			return -ENODEV;
		opl3->hardware = OPL3_HW_OPL3;
	}
	return 0;
}

/*
 *  AdLib timers
 */

/*
 *  Timer 1 - 80us
 */

static int snd_opl3_timer1_start(struct snd_timer * timer)
{
	unsigned long flags;
	unsigned char tmp;
	unsigned int ticks;
	struct snd_opl3 *opl3;

	opl3 = snd_timer_chip(timer);
	spin_lock_irqsave(&opl3->timer_lock, flags);
	ticks = timer->sticks;
	tmp = (opl3->timer_enable | OPL3_TIMER1_START) & ~OPL3_TIMER1_MASK;
	opl3->timer_enable = tmp;
	opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER1, 256 - ticks);	/* timer 1 count */
	opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, tmp);	/* enable timer 1 IRQ */
	spin_unlock_irqrestore(&opl3->timer_lock, flags);
	return 0;
}

static int snd_opl3_timer1_stop(struct snd_timer * timer)
{
	unsigned long flags;
	unsigned char tmp;
	struct snd_opl3 *opl3;

	opl3 = snd_timer_chip(timer);
	spin_lock_irqsave(&opl3->timer_lock, flags);
	tmp = (opl3->timer_enable | OPL3_TIMER1_MASK) & ~OPL3_TIMER1_START;
	opl3->timer_enable = tmp;
	opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, tmp);	/* disable timer #1 */
	spin_unlock_irqrestore(&opl3->timer_lock, flags);
	return 0;
}

/*
 *  Timer 2 - 320us
 */

static int snd_opl3_timer2_start(struct snd_timer * timer)
{
	unsigned long flags;
	unsigned char tmp;
	unsigned int ticks;
	struct snd_opl3 *opl3;

	opl3 = snd_timer_chip(timer);
	spin_lock_irqsave(&opl3->timer_lock, flags);
	ticks = timer->sticks;
	tmp = (opl3->timer_enable | OPL3_TIMER2_START) & ~OPL3_TIMER2_MASK;
	opl3->timer_enable = tmp;
	opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER2, 256 - ticks);	/* timer 1 count */
	opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, tmp);	/* enable timer 1 IRQ */
	spin_unlock_irqrestore(&opl3->timer_lock, flags);
	return 0;
}

static int snd_opl3_timer2_stop(struct snd_timer * timer)
{
	unsigned long flags;
	unsigned char tmp;
	struct snd_opl3 *opl3;

	opl3 = snd_timer_chip(timer);
	spin_lock_irqsave(&opl3->timer_lock, flags);
	tmp = (opl3->timer_enable | OPL3_TIMER2_MASK) & ~OPL3_TIMER2_START;
	opl3->timer_enable = tmp;
	opl3->command(opl3, OPL3_LEFT | OPL3_REG_TIMER_CONTROL, tmp);	/* disable timer #1 */
	spin_unlock_irqrestore(&opl3->timer_lock, flags);
	return 0;
}

/*

 */

static struct snd_timer_hardware snd_opl3_timer1 =
{
	.flags =	SNDRV_TIMER_HW_STOP,
	.resolution =	80000,
	.ticks =	256,
	.start =	snd_opl3_timer1_start,
	.stop =		snd_opl3_timer1_stop,
};

static struct snd_timer_hardware snd_opl3_timer2 =
{
	.flags =	SNDRV_TIMER_HW_STOP,
	.resolution =	320000,
	.ticks =	256,
	.start =	snd_opl3_timer2_start,
	.stop =		snd_opl3_timer2_stop,
};

static int snd_opl3_timer1_init(struct snd_opl3 * opl3, int timer_no)
{
	struct snd_timer *timer = NULL;
	struct snd_timer_id tid;
	int err;

	tid.dev_class = SNDRV_TIMER_CLASS_CARD;
	tid.dev_sclass = SNDRV_TIMER_SCLASS_NONE;
	tid.card = opl3->card->number;
	tid.device = timer_no;
	tid.subdevice = 0;
	if ((err = snd_timer_new(opl3->card, "AdLib timer #1", &tid, &timer)) >= 0) {
		strcpy(timer->name, "AdLib timer #1");
		timer->private_data = opl3;
		timer->hw = snd_opl3_timer1;
	}
	opl3->timer1 = timer;
	return err;
}

static int snd_opl3_timer2_init(struct snd_opl3 * opl3, int timer_no)
{
	struct snd_timer *timer = NULL;
	struct snd_timer_id tid;
	int err;

	tid.dev_class = SNDRV_TIMER_CLASS_CARD;
	tid.dev_sclass = SNDRV_TIMER_SCLASS_NONE;
	tid.card = opl3->card->number;
	tid.device = timer_no;
	tid.subdevice = 0;
	if ((err = snd_timer_new(opl3->card, "AdLib timer #2", &tid, &timer)) >= 0) {
		strcpy(timer->name, "AdLib timer #2");
		timer->private_data = opl3;
		timer->hw = snd_opl3_timer2;
	}
	opl3->timer2 = timer;
	return err;
}

/*

 */

void snd_opl3_interrupt(struct snd_hwdep * hw)
{
	unsigned char status;
	struct snd_opl3 *opl3;
	struct snd_timer *timer;

	if (hw == NULL)
		return;

	opl3 = hw->private_data;
	status = inb(opl3->l_port);
#if 0
	snd_printk(KERN_DEBUG "AdLib IRQ status = 0x%x\n", status);
#endif
	if (!(status & 0x80))
		return;

	if (status & 0x40) {
		timer = opl3->timer1;
		snd_timer_interrupt(timer, timer->sticks);
	}
	if (status & 0x20) {
		timer = opl3->timer2;
		snd_timer_interrupt(timer, timer->sticks);
	}
}

EXPORT_SYMBOL(snd_opl3_interrupt);

/*

 */

static int snd_opl3_free(struct snd_opl3 *opl3)
{
	if (snd_BUG_ON(!opl3))
		return -ENXIO;
	if (opl3->private_free)
		opl3->private_free(opl3);
	snd_opl3_clear_patches(opl3);
	release_and_free_resource(opl3->res_l_port);
	release_and_free_resource(opl3->res_r_port);
	kfree(opl3);
	return 0;
}

static int snd_opl3_dev_free(struct snd_device *device)
{
	struct snd_opl3 *opl3 = device->device_data;
	return snd_opl3_free(opl3);
}

int snd_opl3_new(struct snd_card *card,
		 unsigned short hardware,
		 struct snd_opl3 **ropl3)
{
	static struct snd_device_ops ops = {
		.dev_free = snd_opl3_dev_free,
	};
	struct snd_opl3 *opl3;
	int err;

	*ropl3 = NULL;
	opl3 = kzalloc(sizeof(*opl3), GFP_KERNEL);
	if (!opl3)
		return -ENOMEM;

	opl3->card = card;
	opl3->hardware = hardware;
	spin_lock_init(&opl3->reg_lock);
	spin_lock_init(&opl3->timer_lock);

	if ((err = snd_device_new(card, SNDRV_DEV_CODEC, opl3, &ops)) < 0) {
		snd_opl3_free(opl3);
		return err;
	}

	*ropl3 = opl3;
	return 0;
}

EXPORT_SYMBOL(snd_opl3_new);

int snd_opl3_init(struct snd_opl3 *opl3)
{
	if (! opl3->command) {
		printk(KERN_ERR "snd_opl3_init: command not defined!\n");
		return -EINVAL;
	}

	opl3->command(opl3, OPL3_LEFT | OPL3_REG_TEST, OPL3_ENABLE_WAVE_SELECT);
	/* Melodic mode */
	opl3->command(opl3, OPL3_LEFT | OPL3_REG_PERCUSSION, 0x00);

	switch (opl3->hardware & OPL3_HW_MASK) {
	case OPL3_HW_OPL2:
		opl3->max_voices = MAX_OPL2_VOICES;
		break;
	case OPL3_HW_OPL3:
	case OPL3_HW_OPL4:
		opl3->max_voices = MAX_OPL3_VOICES;
		/* Enter OPL3 mode */
		opl3->command(opl3, OPL3_RIGHT | OPL3_REG_MODE, OPL3_OPL3_ENABLE);
	}
	return 0;
}

EXPORT_SYMBOL(snd_opl3_init);

int snd_opl3_create(struct snd_card *card,
		    unsigned long l_port,
		    unsigned long r_port,
		    unsigned short hardware,
		    int integrated,
		    struct snd_opl3 ** ropl3)
{
	struct snd_opl3 *opl3;
	int err;

	*ropl3 = NULL;
	if ((err = snd_opl3_new(card, hardware, &opl3)) < 0)
		return err;
	if (! integrated) {
		if ((opl3->res_l_port = request_region(l_port, 2, "OPL2/3 (left)")) == NULL) {
			snd_printk(KERN_ERR "opl3: can't grab left port 0x%lx\n", l_port);
			snd_device_free(card, opl3);
			return -EBUSY;
		}
		if (r_port != 0 &&
		    (opl3->res_r_port = request_region(r_port, 2, "OPL2/3 (right)")) == NULL) {
			snd_printk(KERN_ERR "opl3: can't grab right port 0x%lx\n", r_port);
			snd_device_free(card, opl3);
			return -EBUSY;
		}
	}
	opl3->l_port = l_port;
	opl3->r_port = r_port;

	switch (opl3->hardware) {
	/* some hardware doesn't support timers */
	case OPL3_HW_OPL3_SV:
	case OPL3_HW_OPL3_CS:
	case OPL3_HW_OPL3_FM801:
		opl3->command = &snd_opl3_command;
		break;
	default:
		opl3->command = &snd_opl2_command;
		if ((err = snd_opl3_detect(opl3)) < 0) {
			snd_printd("OPL2/3 chip not detected at 0x%lx/0x%lx\n",
				   opl3->l_port, opl3->r_port);
			snd_device_free(card, opl3);
			return err;
		}
		/* detect routine returns correct hardware type */
		switch (opl3->hardware & OPL3_HW_MASK) {
		case OPL3_HW_OPL3:
		case OPL3_HW_OPL4:
			opl3->command = &snd_opl3_command;
		}
	}

	snd_opl3_init(opl3);

	*ropl3 = opl3;
	return 0;
}

EXPORT_SYMBOL(snd_opl3_create);

int snd_opl3_timer_new(struct snd_opl3 * opl3, int timer1_dev, int timer2_dev)
{
	int err;

	if (timer1_dev >= 0)
		if ((err = snd_opl3_timer1_init(opl3, timer1_dev)) < 0)
			return err;
	if (timer2_dev >= 0) {
		if ((err = snd_opl3_timer2_init(opl3, timer2_dev)) < 0) {
			snd_device_free(opl3->card, opl3->timer1);
			opl3->timer1 = NULL;
			return err;
		}
	}
	return 0;
}

EXPORT_SYMBOL(snd_opl3_timer_new);

int snd_opl3_hwdep_new(struct snd_opl3 * opl3,
		       int device, int seq_device,
		       struct snd_hwdep ** rhwdep)
{
	struct snd_hwdep *hw;
	struct snd_card *card = opl3->card;
	int err;

	if (rhwdep)
		*rhwdep = NULL;

	/* create hardware dependent device (direct FM) */

	if ((err = snd_hwdep_new(card, "OPL2/OPL3", device, &hw)) < 0) {
		snd_device_free(card, opl3);
		return err;
	}
	hw->private_data = opl3;
	hw->exclusive = 1;
#ifdef CONFIG_SND_OSSEMUL
	if (device == 0)
		hw->oss_type = SNDRV_OSS_DEVICE_TYPE_DMFM;
#endif
	strcpy(hw->name, hw->id);
	switch (opl3->hardware & OPL3_HW_MASK) {
	case OPL3_HW_OPL2:
		strcpy(hw->name, "OPL2 FM");
		hw->iface = SNDRV_HWDEP_IFACE_OPL2;
		break;
	case OPL3_HW_OPL3:
		strcpy(hw->name, "OPL3 FM");
		hw->iface = SNDRV_HWDEP_IFACE_OPL3;
		break;
	case OPL3_HW_OPL4:
		strcpy(hw->name, "OPL4 FM");
		hw->iface = SNDRV_HWDEP_IFACE_OPL4;
		break;
	}

	/* operators - only ioctl */
	hw->ops.open = snd_opl3_open;
	hw->ops.ioctl = snd_opl3_ioctl;
	hw->ops.write = snd_opl3_write;
	hw->ops.release = snd_opl3_release;

	opl3->hwdep = hw;
	opl3->seq_dev_num = seq_device;
#if IS_ENABLED(CONFIG_SND_SEQUENCER)
	if (snd_seq_device_new(card, seq_device, SNDRV_SEQ_DEV_ID_OPL3,
			       sizeof(struct snd_opl3 *), &opl3->seq_dev) >= 0) {
		strcpy(opl3->seq_dev->name, hw->name);
		*(struct snd_opl3 **)SNDRV_SEQ_DEVICE_ARGPTR(opl3->seq_dev) = opl3;
	}
#endif
	if (rhwdep)
		*rhwdep = hw;
	return 0;
}

EXPORT_SYMBOL(snd_opl3_hwdep_new);
Commit	Line	Data
1a59d1b8	1	// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4	2	/*
c1017a4c	3	* Copyright (c) by Jaroslav Kysela <perex@perex.cz>,
1da177e4 LT	4	* Hannu Savolainen 1993-1996,
	5	* Rob Hooft
	6	*
	7	* Routines for control of AdLib FM cards (OPL2/OPL3/OPL4 chips)
	8	*
	9	* Most if code is ported from OSS/Lite.
1da177e4 LT	10	*/
	11
	12	#include <sound/opl3.h>
6cbbfe1c	13	#include <linux/io.h>
1da177e4	14	#include <linux/delay.h>
da155d5b	15	#include <linux/module.h>
1da177e4 LT	16	#include <linux/init.h>
	17	#include <linux/slab.h>
	18	#include <linux/ioport.h>
	19	#include <sound/minors.h>
7e9c20f4	20	#include "opl3_voice.h"
1da177e4	21
c1017a4c	22	MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>, Hannu Savolainen 1993-1996, Rob Hooft");
1da177e4 LT	23	MODULE_DESCRIPTION("Routines for control of AdLib FM cards (OPL2/OPL3/OPL4 chips)");
	24	MODULE_LICENSE("GPL");
	25
5b1646a8	26	static void snd_opl2_command(struct snd_opl3 * opl3, unsigned short cmd, unsigned char val)
1da177e4 LT	27	{
	28	unsigned long flags;
	29	unsigned long port;
	30
	31	/*
	32	* The original 2-OP synth requires a quite long delay
	33	* after writing to a register.
	34	*/
	35
	36	port = (cmd & OPL3_RIGHT) ? opl3->r_port : opl3->l_port;
	37
	38	spin_lock_irqsave(&opl3->reg_lock, flags);
	39
	40	outb((unsigned char) cmd, port);
	41	udelay(10);
	42
	43	outb((unsigned char) val, port + 1);
	44	udelay(30);
	45
	46	spin_unlock_irqrestore(&opl3->reg_lock, flags);
	47	}
	48
5b1646a8	49	static void snd_opl3_command(struct snd_opl3 * opl3, unsigned short cmd, unsigned char val)
1da177e4 LT	50	{
	51	unsigned long flags;
	52	unsigned long port;
	53
	54	/*
	55	* The OPL-3 survives with just two INBs
	56	* after writing to a register.
	57	*/
	58
	59	port = (cmd & OPL3_RIGHT) ? opl3->r_port : opl3->l_port;
	60
	61	spin_lock_irqsave(&opl3->reg_lock, flags);
	62
	63	outb((unsigned char) cmd, port);
	64	inb(opl3->l_port);
	65	inb(opl3->l_port);
	66
	67	outb((unsigned char) val, port + 1);
	68	inb(opl3->l_port);
	69	inb(opl3->l_port);
	70
	71	spin_unlock_irqrestore(&opl3->reg_lock, flags);
	72	}
	73
5b1646a8	74	static int snd_opl3_detect(struct snd_opl3 * opl3)
1da177e4 LT	75	{
	76	/*
	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.
	80	*
	81	* Note! The timers of the FM chip are not connected to AdLib (and compatible)
	82	* boards.
	83	*
	84	* Note2! The chip is initialized if detected.
	85	*/
	86
	87	unsigned char stat1, stat2, signature;
	88
	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);
	96	return -ENODEV;
	97	}
	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 */
	103	udelay(200);
	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);
	112	return -ENODEV;
	113	}
	114
	115	/* If the toplevel code knows exactly the type of chip, don't try
	116	to detect it. */
	117	if (opl3->hardware != OPL3_HW_AUTO)
	118	return 0;
	119
	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;
	123	} else {
	124	/*
	125	* If we had an OPL4 chip, opl3->hardware would have been set
	126	* by the OPL4 driver; so we can assume OPL3 here.
	127	*/
5e246b85 TI	128	if (snd_BUG_ON(!opl3->r_port))
5e246b85 TI	129	return -ENODEV;
1da177e4 LT	130	opl3->hardware = OPL3_HW_OPL3;
	131	}
	132	return 0;
	133	}
	134
	135	/*
	136	* AdLib timers
	137	*/
	138
	139	/*
	140	* Timer 1 - 80us
	141	*/
	142
5b1646a8	143	static int snd_opl3_timer1_start(struct snd_timer * timer)
1da177e4 LT	144	{
	145	unsigned long flags;
	146	unsigned char tmp;
	147	unsigned int ticks;
5b1646a8	148	struct snd_opl3 *opl3;
1da177e4 LT	149
	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);
	158	return 0;
	159	}
	160
5b1646a8	161	static int snd_opl3_timer1_stop(struct snd_timer * timer)
1da177e4 LT	162	{
	163	unsigned long flags;
	164	unsigned char tmp;
5b1646a8	165	struct snd_opl3 *opl3;
1da177e4 LT	166
	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);
	173	return 0;
	174	}
	175
	176	/*
	177	* Timer 2 - 320us
	178	*/
	179
5b1646a8	180	static int snd_opl3_timer2_start(struct snd_timer * timer)
1da177e4 LT	181	{
	182	unsigned long flags;
	183	unsigned char tmp;
	184	unsigned int ticks;
5b1646a8	185	struct snd_opl3 *opl3;
1da177e4 LT	186
	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);
	195	return 0;
	196	}
	197
5b1646a8	198	static int snd_opl3_timer2_stop(struct snd_timer * timer)
1da177e4 LT	199	{
	200	unsigned long flags;
	201	unsigned char tmp;
5b1646a8	202	struct snd_opl3 *opl3;
1da177e4 LT	203
	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);
	210	return 0;
	211	}
	212
	213	/*
	214
	215	*/
	216
5b1646a8	217	static struct snd_timer_hardware snd_opl3_timer1 =
1da177e4 LT	218	{
	219	.flags = SNDRV_TIMER_HW_STOP,
	220	.resolution = 80000,
	221	.ticks = 256,
	222	.start = snd_opl3_timer1_start,
	223	.stop = snd_opl3_timer1_stop,
	224	};
	225
5b1646a8	226	static struct snd_timer_hardware snd_opl3_timer2 =
1da177e4 LT	227	{
	228	.flags = SNDRV_TIMER_HW_STOP,
	229	.resolution = 320000,
	230	.ticks = 256,
	231	.start = snd_opl3_timer2_start,
	232	.stop = snd_opl3_timer2_stop,
	233	};
	234
5b1646a8	235	static int snd_opl3_timer1_init(struct snd_opl3 * opl3, int timer_no)
1da177e4	236	{
5b1646a8 TI	237	struct snd_timer *timer = NULL;
5b1646a8 TI	238	struct snd_timer_id tid;
1da177e4 LT	239	int err;
	240
	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;
	245	tid.subdevice = 0;
	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;
	250	}
	251	opl3->timer1 = timer;
	252	return err;
	253	}
	254
5b1646a8	255	static int snd_opl3_timer2_init(struct snd_opl3 * opl3, int timer_no)
1da177e4	256	{
5b1646a8 TI	257	struct snd_timer *timer = NULL;
5b1646a8 TI	258	struct snd_timer_id tid;
1da177e4 LT	259	int err;
	260
	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;
	265	tid.subdevice = 0;
	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;
	270	}
	271	opl3->timer2 = timer;
	272	return err;
	273	}
	274
	275	/*
	276
	277	*/
	278
5b1646a8	279	void snd_opl3_interrupt(struct snd_hwdep * hw)
1da177e4 LT	280	{
1da177e4 LT	281	unsigned char status;
5b1646a8 TI	282	struct snd_opl3 *opl3;
5b1646a8 TI	283	struct snd_timer *timer;
1da177e4 LT	284
	285	if (hw == NULL)
	286	return;
	287
	288	opl3 = hw->private_data;
	289	status = inb(opl3->l_port);
	290	#if 0
45203832	291	snd_printk(KERN_DEBUG "AdLib IRQ status = 0x%x\n", status);
1da177e4 LT	292	#endif
	293	if (!(status & 0x80))
	294	return;
	295
	296	if (status & 0x40) {
	297	timer = opl3->timer1;
	298	snd_timer_interrupt(timer, timer->sticks);
	299	}
	300	if (status & 0x20) {
	301	timer = opl3->timer2;
	302	snd_timer_interrupt(timer, timer->sticks);
	303	}
	304	}
	305
ac19e19b TI	306	EXPORT_SYMBOL(snd_opl3_interrupt);
ac19e19b TI	307
1da177e4 LT	308	/*
	309
	310	*/
	311
5b1646a8	312	static int snd_opl3_free(struct snd_opl3 *opl3)
1da177e4	313	{
5e246b85 TI	314	if (snd_BUG_ON(!opl3))
5e246b85 TI	315	return -ENXIO;
1da177e4 LT	316	if (opl3->private_free)
1da177e4 LT	317	opl3->private_free(opl3);
224a0332	318	snd_opl3_clear_patches(opl3);
b1d5776d TI	319	release_and_free_resource(opl3->res_l_port);
b1d5776d TI	320	release_and_free_resource(opl3->res_r_port);
1da177e4 LT	321	kfree(opl3);
	322	return 0;
	323	}
	324
5b1646a8	325	static int snd_opl3_dev_free(struct snd_device *device)
1da177e4	326	{
5b1646a8	327	struct snd_opl3 *opl3 = device->device_data;
1da177e4 LT	328	return snd_opl3_free(opl3);
	329	}
	330
5b1646a8	331	int snd_opl3_new(struct snd_card *card,
1da177e4	332	unsigned short hardware,
5b1646a8	333	struct snd_opl3 **ropl3)
1da177e4	334	{
5b1646a8	335	static struct snd_device_ops ops = {
1da177e4 LT	336	.dev_free = snd_opl3_dev_free,
1da177e4 LT	337	};
5b1646a8	338	struct snd_opl3 *opl3;
1da177e4 LT	339	int err;
	340
	341	*ropl3 = NULL;
561b220a	342	opl3 = kzalloc(sizeof(*opl3), GFP_KERNEL);
2b223a91	343	if (!opl3)
1da177e4 LT	344	return -ENOMEM;
	345
	346	opl3->card = card;
	347	opl3->hardware = hardware;
	348	spin_lock_init(&opl3->reg_lock);
	349	spin_lock_init(&opl3->timer_lock);
1da177e4 LT	350
	351	if ((err = snd_device_new(card, SNDRV_DEV_CODEC, opl3, &ops)) < 0) {
	352	snd_opl3_free(opl3);
	353	return err;
	354	}
	355
	356	*ropl3 = opl3;
	357	return 0;
	358	}
	359
ac19e19b TI	360	EXPORT_SYMBOL(snd_opl3_new);
ac19e19b TI	361
5b1646a8	362	int snd_opl3_init(struct snd_opl3 *opl3)
1da177e4 LT	363	{
	364	if (! opl3->command) {
	365	printk(KERN_ERR "snd_opl3_init: command not defined!\n");
	366	return -EINVAL;
	367	}
	368
	369	opl3->command(opl3, OPL3_LEFT \| OPL3_REG_TEST, OPL3_ENABLE_WAVE_SELECT);
	370	/* Melodic mode */
	371	opl3->command(opl3, OPL3_LEFT \| OPL3_REG_PERCUSSION, 0x00);
	372
	373	switch (opl3->hardware & OPL3_HW_MASK) {
	374	case OPL3_HW_OPL2:
	375	opl3->max_voices = MAX_OPL2_VOICES;
	376	break;
	377	case OPL3_HW_OPL3:
	378	case OPL3_HW_OPL4:
	379	opl3->max_voices = MAX_OPL3_VOICES;
	380	/* Enter OPL3 mode */
	381	opl3->command(opl3, OPL3_RIGHT \| OPL3_REG_MODE, OPL3_OPL3_ENABLE);
	382	}
	383	return 0;
	384	}
	385
ac19e19b TI	386	EXPORT_SYMBOL(snd_opl3_init);
ac19e19b TI	387
5b1646a8	388	int snd_opl3_create(struct snd_card *card,
1da177e4 LT	389	unsigned long l_port,
	390	unsigned long r_port,
	391	unsigned short hardware,
	392	int integrated,
5b1646a8	393	struct snd_opl3 ** ropl3)
1da177e4	394	{
5b1646a8	395	struct snd_opl3 *opl3;
1da177e4 LT	396	int err;
	397
	398	*ropl3 = NULL;
	399	if ((err = snd_opl3_new(card, hardware, &opl3)) < 0)
	400	return err;
	401	if (! integrated) {
	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);
676338a1	404	snd_device_free(card, opl3);
1da177e4 LT	405	return -EBUSY;
	406	}
	407	if (r_port != 0 &&
	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);
676338a1	410	snd_device_free(card, opl3);
1da177e4 LT	411	return -EBUSY;
	412	}
	413	}
	414	opl3->l_port = l_port;
	415	opl3->r_port = r_port;
	416
	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;
	423	break;
	424	default:
	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);
676338a1	429	snd_device_free(card, opl3);
1da177e4 LT	430	return err;
	431	}
	432	/* detect routine returns correct hardware type */
	433	switch (opl3->hardware & OPL3_HW_MASK) {
	434	case OPL3_HW_OPL3:
	435	case OPL3_HW_OPL4:
	436	opl3->command = &snd_opl3_command;
	437	}
	438	}
	439
	440	snd_opl3_init(opl3);
	441
	442	*ropl3 = opl3;
	443	return 0;
	444	}
	445
ac19e19b TI	446	EXPORT_SYMBOL(snd_opl3_create);
ac19e19b TI	447
5b1646a8	448	int snd_opl3_timer_new(struct snd_opl3 * opl3, int timer1_dev, int timer2_dev)
1da177e4 LT	449	{
	450	int err;
	451
	452	if (timer1_dev >= 0)
	453	if ((err = snd_opl3_timer1_init(opl3, timer1_dev)) < 0)
	454	return err;
	455	if (timer2_dev >= 0) {
	456	if ((err = snd_opl3_timer2_init(opl3, timer2_dev)) < 0) {
	457	snd_device_free(opl3->card, opl3->timer1);
	458	opl3->timer1 = NULL;
	459	return err;
	460	}
	461	}
	462	return 0;
	463	}
	464
ac19e19b TI	465	EXPORT_SYMBOL(snd_opl3_timer_new);
ac19e19b TI	466
5b1646a8	467	int snd_opl3_hwdep_new(struct snd_opl3 * opl3,
1da177e4	468	int device, int seq_device,
5b1646a8	469	struct snd_hwdep ** rhwdep)
1da177e4	470	{
5b1646a8 TI	471	struct snd_hwdep *hw;
5b1646a8 TI	472	struct snd_card *card = opl3->card;
1da177e4 LT	473	int err;
	474
	475	if (rhwdep)
	476	*rhwdep = NULL;
	477
	478	/* create hardware dependent device (direct FM) */
	479
	480	if ((err = snd_hwdep_new(card, "OPL2/OPL3", device, &hw)) < 0) {
	481	snd_device_free(card, opl3);
	482	return err;
	483	}
	484	hw->private_data = opl3;
05c1afe7	485	hw->exclusive = 1;
1da177e4	486	#ifdef CONFIG_SND_OSSEMUL
80d7d771	487	if (device == 0)
1da177e4	488	hw->oss_type = SNDRV_OSS_DEVICE_TYPE_DMFM;
1da177e4 LT	489	#endif
	490	strcpy(hw->name, hw->id);
	491	switch (opl3->hardware & OPL3_HW_MASK) {
	492	case OPL3_HW_OPL2:
	493	strcpy(hw->name, "OPL2 FM");
	494	hw->iface = SNDRV_HWDEP_IFACE_OPL2;
	495	break;
	496	case OPL3_HW_OPL3:
	497	strcpy(hw->name, "OPL3 FM");
	498	hw->iface = SNDRV_HWDEP_IFACE_OPL3;
	499	break;
	500	case OPL3_HW_OPL4:
	501	strcpy(hw->name, "OPL4 FM");
	502	hw->iface = SNDRV_HWDEP_IFACE_OPL4;
	503	break;
	504	}
	505
	506	/* operators - only ioctl */
	507	hw->ops.open = snd_opl3_open;
	508	hw->ops.ioctl = snd_opl3_ioctl;
224a0332	509	hw->ops.write = snd_opl3_write;
1da177e4 LT	510	hw->ops.release = snd_opl3_release;
1da177e4 LT	511
04576525	512	opl3->hwdep = hw;
1da177e4	513	opl3->seq_dev_num = seq_device;
111b0cdb	514	#if IS_ENABLED(CONFIG_SND_SEQUENCER)
1da177e4	515	if (snd_seq_device_new(card, seq_device, SNDRV_SEQ_DEV_ID_OPL3,
5b1646a8	516	sizeof(struct snd_opl3 *), &opl3->seq_dev) >= 0) {
1da177e4	517	strcpy(opl3->seq_dev->name, hw->name);
5b1646a8	518	(struct snd_opl3 *)SNDRV_SEQ_DEVICE_ARGPTR(opl3->seq_dev) = opl3;
1da177e4 LT	519	}
	520	#endif
	521	if (rhwdep)
	522	*rhwdep = hw;
	523	return 0;
	524	}
	525
1da177e4	526	EXPORT_SYMBOL(snd_opl3_hwdep_new);