[people/ms/linux.git] / sound / drivers / opl3 / opl3_seq.c

/*
 *  Copyright (c) by Uros Bizjak <uros@kss-loka.si>
 *
 *  Midi Sequencer interface routines for OPL2/OPL3/OPL4 FM
 *
 *  OPL2/3 FM instrument loader:
 *   alsa-tools/seq/sbiload/
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program 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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */

#include "opl3_voice.h"
#include <linux/init.h>
#include <linux/moduleparam.h>
#include <sound/initval.h>

MODULE_AUTHOR("Uros Bizjak <uros@kss-loka.si>");
MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("ALSA driver for OPL3 FM synth");

int use_internal_drums = 0;
module_param(use_internal_drums, bool, 0444);
MODULE_PARM_DESC(use_internal_drums, "Enable internal OPL2/3 drums.");

int snd_opl3_synth_use_inc(struct snd_opl3 * opl3)
{
	if (!try_module_get(opl3->card->module))
		return -EFAULT;
	return 0;

}

void snd_opl3_synth_use_dec(struct snd_opl3 * opl3)
{
	module_put(opl3->card->module);
}

int snd_opl3_synth_setup(struct snd_opl3 * opl3)
{
	int idx;

	down(&opl3->access_mutex);
	if (opl3->used) {
		up(&opl3->access_mutex);
		return -EBUSY;
	}
	opl3->used++;
	up(&opl3->access_mutex);

	snd_opl3_reset(opl3);

	for (idx = 0; idx < MAX_OPL3_VOICES; idx++) {
		opl3->voices[idx].state = SNDRV_OPL3_ST_OFF;
		opl3->voices[idx].time = 0;
		opl3->voices[idx].keyon_reg = 0x00;
	}
	opl3->use_time = 0;
	opl3->connection_reg = 0x00;
	if (opl3->hardware >= OPL3_HW_OPL3) {
		/* Clear 4-op connections */
		opl3->command(opl3, OPL3_RIGHT | OPL3_REG_CONNECTION_SELECT,
				 opl3->connection_reg);
		opl3->max_voices = MAX_OPL3_VOICES;
	}
	return 0;
}

void snd_opl3_synth_cleanup(struct snd_opl3 * opl3)
{
	unsigned long flags;

	/* Stop system timer */
	spin_lock_irqsave(&opl3->sys_timer_lock, flags);
	if (opl3->sys_timer_status) {
		del_timer(&opl3->tlist);
		opl3->sys_timer_status = 0;
	}
	spin_unlock_irqrestore(&opl3->sys_timer_lock, flags);

	snd_opl3_reset(opl3);
	down(&opl3->access_mutex);
	opl3->used--;
	up(&opl3->access_mutex);
}

static int snd_opl3_synth_use(void *private_data, struct snd_seq_port_subscribe * info)
{
	struct snd_opl3 *opl3 = private_data;
	int err;

	if ((err = snd_opl3_synth_setup(opl3)) < 0)
		return err;

	if (use_internal_drums) {
		/* Percussion mode */
		opl3->voices[6].state = opl3->voices[7].state = 
			opl3->voices[8].state = SNDRV_OPL3_ST_NOT_AVAIL;
		snd_opl3_load_drums(opl3);
		opl3->drum_reg = OPL3_PERCUSSION_ENABLE;
		opl3->command(opl3, OPL3_LEFT | OPL3_REG_PERCUSSION, opl3->drum_reg);
	} else {
		opl3->drum_reg = 0x00;
	}

	if (info->sender.client != SNDRV_SEQ_CLIENT_SYSTEM) {
		if ((err = snd_opl3_synth_use_inc(opl3)) < 0)
			return err;
	}
	opl3->synth_mode = SNDRV_OPL3_MODE_SEQ;
	return 0;
}

static int snd_opl3_synth_unuse(void *private_data, struct snd_seq_port_subscribe * info)
{
	struct snd_opl3 *opl3 = private_data;

	snd_opl3_synth_cleanup(opl3);

	if (info->sender.client != SNDRV_SEQ_CLIENT_SYSTEM)
		snd_opl3_synth_use_dec(opl3);
	return 0;
}

/*
 * MIDI emulation operators
 */
struct snd_midi_op opl3_ops = {
	.note_on =		snd_opl3_note_on,
	.note_off =		snd_opl3_note_off,
	.key_press =		snd_opl3_key_press,
	.note_terminate =	snd_opl3_terminate_note,
	.control =		snd_opl3_control,
	.nrpn =			snd_opl3_nrpn,
	.sysex =		snd_opl3_sysex,
};

static int snd_opl3_synth_event_input(struct snd_seq_event * ev, int direct,
				      void *private_data, int atomic, int hop)
{
	struct snd_opl3 *opl3 = private_data;

	if (ev->type >= SNDRV_SEQ_EVENT_INSTR_BEGIN &&
	    ev->type <= SNDRV_SEQ_EVENT_INSTR_CHANGE) {
		if (direct) {
			snd_seq_instr_event(&opl3->fm_ops, opl3->ilist, ev,
					    opl3->seq_client, atomic, hop);
		}
	} else {
		snd_midi_process_event(&opl3_ops, ev, opl3->chset);
	}
	return 0;
}

/* ------------------------------ */

static void snd_opl3_synth_free_port(void *private_data)
{
	struct snd_opl3 *opl3 = private_data;

	snd_midi_channel_free_set(opl3->chset);
}

static int snd_opl3_synth_create_port(struct snd_opl3 * opl3)
{
	struct snd_seq_port_callback callbacks;
	char name[32];
	int voices, opl_ver;

	voices = (opl3->hardware < OPL3_HW_OPL3) ?
		MAX_OPL2_VOICES : MAX_OPL3_VOICES;
	opl3->chset = snd_midi_channel_alloc_set(16);
	if (opl3->chset == NULL)
		return -ENOMEM;
	opl3->chset->private_data = opl3;

	memset(&callbacks, 0, sizeof(callbacks));
	callbacks.owner = THIS_MODULE;
	callbacks.use = snd_opl3_synth_use;
	callbacks.unuse = snd_opl3_synth_unuse;
	callbacks.event_input = snd_opl3_synth_event_input;
	callbacks.private_free = snd_opl3_synth_free_port;
	callbacks.private_data = opl3;

	opl_ver = (opl3->hardware & OPL3_HW_MASK) >> 8;
	sprintf(name, "OPL%i FM Port", opl_ver);

	opl3->chset->client = opl3->seq_client;
	opl3->chset->port = snd_seq_event_port_attach(opl3->seq_client, &callbacks,
						      SNDRV_SEQ_PORT_CAP_WRITE |
						      SNDRV_SEQ_PORT_CAP_SUBS_WRITE,
						      SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC |
						      SNDRV_SEQ_PORT_TYPE_MIDI_GM |
						      SNDRV_SEQ_PORT_TYPE_SYNTH,
						      16, voices,
						      name);
	if (opl3->chset->port < 0) {
		snd_midi_channel_free_set(opl3->chset);
		return opl3->chset->port;
	}
	return 0;
}

/* ------------------------------ */

static int snd_opl3_seq_new_device(struct snd_seq_device *dev)
{
	struct snd_opl3 *opl3;
	int client;
	struct snd_seq_client_info cinfo;
	int opl_ver;

	opl3 = *(struct snd_opl3 **)SNDRV_SEQ_DEVICE_ARGPTR(dev);
	if (opl3 == NULL)
		return -EINVAL;

	spin_lock_init(&opl3->voice_lock);

	opl3->seq_client = -1;

	/* allocate new client */
	client = opl3->seq_client =
		snd_seq_create_kernel_client(opl3->card, opl3->seq_dev_num);
	if (client < 0)
		return client;

	/* change name of client */
	memset(&cinfo, 0, sizeof(cinfo));
	cinfo.client = client;
	cinfo.type = KERNEL_CLIENT;
	opl_ver = (opl3->hardware & OPL3_HW_MASK) >> 8;
	sprintf(cinfo.name, "OPL%i FM synth", opl_ver);
	snd_seq_kernel_client_ctl(client, SNDRV_SEQ_IOCTL_SET_CLIENT_INFO, &cinfo);

	snd_opl3_synth_create_port(opl3);

	/* initialize instrument list */
	opl3->ilist = snd_seq_instr_list_new();
	if (opl3->ilist == NULL) {
		snd_seq_delete_kernel_client(client);
		opl3->seq_client = -1;
		return -ENOMEM;
	}
	opl3->ilist->flags = SNDRV_SEQ_INSTR_FLG_DIRECT;
	snd_seq_fm_init(&opl3->fm_ops, NULL);

	/* setup system timer */
	init_timer(&opl3->tlist);
	opl3->tlist.function = snd_opl3_timer_func;
	opl3->tlist.data = (unsigned long) opl3;
	spin_lock_init(&opl3->sys_timer_lock);
	opl3->sys_timer_status = 0;

#ifdef CONFIG_SND_SEQUENCER_OSS
	snd_opl3_init_seq_oss(opl3, cinfo.name);
#endif
	return 0;
}

static int snd_opl3_seq_delete_device(struct snd_seq_device *dev)
{
	struct snd_opl3 *opl3;

	opl3 = *(struct snd_opl3 **)SNDRV_SEQ_DEVICE_ARGPTR(dev);
	if (opl3 == NULL)
		return -EINVAL;

#ifdef CONFIG_SND_SEQUENCER_OSS
	snd_opl3_free_seq_oss(opl3);
#endif
	if (opl3->seq_client >= 0) {
		snd_seq_delete_kernel_client(opl3->seq_client);
		opl3->seq_client = -1;
	}
	if (opl3->ilist)
		snd_seq_instr_list_free(&opl3->ilist);
	return 0;
}

static int __init alsa_opl3_seq_init(void)
{
	static struct snd_seq_dev_ops ops =
	{
		snd_opl3_seq_new_device,
		snd_opl3_seq_delete_device
	};

	return snd_seq_device_register_driver(SNDRV_SEQ_DEV_ID_OPL3, &ops,
					      sizeof(struct snd_opl3 *));
}

static void __exit alsa_opl3_seq_exit(void)
{
	snd_seq_device_unregister_driver(SNDRV_SEQ_DEV_ID_OPL3);
}

module_init(alsa_opl3_seq_init)
module_exit(alsa_opl3_seq_exit)
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Copyright (c) by Uros Bizjak <uros@kss-loka.si>
	3	*
	4	* Midi Sequencer interface routines for OPL2/OPL3/OPL4 FM
	5	*
	6	* OPL2/3 FM instrument loader:
	7	* alsa-tools/seq/sbiload/
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	22	*
	23	*/
	24
	25	#include "opl3_voice.h"
	26	#include <linux/init.h>
	27	#include <linux/moduleparam.h>
	28	#include <sound/initval.h>
	29
	30	MODULE_AUTHOR("Uros Bizjak <uros@kss-loka.si>");
	31	MODULE_LICENSE("GPL");
	32	MODULE_DESCRIPTION("ALSA driver for OPL3 FM synth");
	33
	34	int use_internal_drums = 0;
	35	module_param(use_internal_drums, bool, 0444);
	36	MODULE_PARM_DESC(use_internal_drums, "Enable internal OPL2/3 drums.");
	37
5b1646a8	38	int snd_opl3_synth_use_inc(struct snd_opl3 * opl3)
1da177e4 LT	39	{
	40	if (!try_module_get(opl3->card->module))
	41	return -EFAULT;
	42	return 0;
	43
	44	}
	45
5b1646a8	46	void snd_opl3_synth_use_dec(struct snd_opl3 * opl3)
1da177e4 LT	47	{
	48	module_put(opl3->card->module);
	49	}
	50
5b1646a8	51	int snd_opl3_synth_setup(struct snd_opl3 * opl3)
1da177e4 LT	52	{
	53	int idx;
	54
	55	down(&opl3->access_mutex);
	56	if (opl3->used) {
	57	up(&opl3->access_mutex);
	58	return -EBUSY;
	59	}
	60	opl3->used++;
	61	up(&opl3->access_mutex);
	62
	63	snd_opl3_reset(opl3);
	64
	65	for (idx = 0; idx < MAX_OPL3_VOICES; idx++) {
	66	opl3->voices[idx].state = SNDRV_OPL3_ST_OFF;
	67	opl3->voices[idx].time = 0;
	68	opl3->voices[idx].keyon_reg = 0x00;
	69	}
	70	opl3->use_time = 0;
	71	opl3->connection_reg = 0x00;
	72	if (opl3->hardware >= OPL3_HW_OPL3) {
	73	/* Clear 4-op connections */
	74	opl3->command(opl3, OPL3_RIGHT \| OPL3_REG_CONNECTION_SELECT,
	75	opl3->connection_reg);
	76	opl3->max_voices = MAX_OPL3_VOICES;
	77	}
	78	return 0;
	79	}
	80
5b1646a8	81	void snd_opl3_synth_cleanup(struct snd_opl3 * opl3)
1da177e4 LT	82	{
	83	unsigned long flags;
	84
	85	/* Stop system timer */
	86	spin_lock_irqsave(&opl3->sys_timer_lock, flags);
	87	if (opl3->sys_timer_status) {
	88	del_timer(&opl3->tlist);
	89	opl3->sys_timer_status = 0;
	90	}
	91	spin_unlock_irqrestore(&opl3->sys_timer_lock, flags);
	92
	93	snd_opl3_reset(opl3);
	94	down(&opl3->access_mutex);
	95	opl3->used--;
	96	up(&opl3->access_mutex);
	97	}
	98
5b1646a8	99	static int snd_opl3_synth_use(void private_data, struct snd_seq_port_subscribe info)
1da177e4	100	{
5b1646a8	101	struct snd_opl3 *opl3 = private_data;
1da177e4 LT	102	int err;
	103
	104	if ((err = snd_opl3_synth_setup(opl3)) < 0)
	105	return err;
	106
	107	if (use_internal_drums) {
	108	/* Percussion mode */
	109	opl3->voices[6].state = opl3->voices[7].state =
	110	opl3->voices[8].state = SNDRV_OPL3_ST_NOT_AVAIL;
	111	snd_opl3_load_drums(opl3);
	112	opl3->drum_reg = OPL3_PERCUSSION_ENABLE;
	113	opl3->command(opl3, OPL3_LEFT \| OPL3_REG_PERCUSSION, opl3->drum_reg);
	114	} else {
	115	opl3->drum_reg = 0x00;
	116	}
	117
	118	if (info->sender.client != SNDRV_SEQ_CLIENT_SYSTEM) {
	119	if ((err = snd_opl3_synth_use_inc(opl3)) < 0)
	120	return err;
	121	}
	122	opl3->synth_mode = SNDRV_OPL3_MODE_SEQ;
	123	return 0;
	124	}
	125
5b1646a8	126	static int snd_opl3_synth_unuse(void private_data, struct snd_seq_port_subscribe info)
1da177e4	127	{
5b1646a8	128	struct snd_opl3 *opl3 = private_data;
1da177e4 LT	129
	130	snd_opl3_synth_cleanup(opl3);
	131
	132	if (info->sender.client != SNDRV_SEQ_CLIENT_SYSTEM)
	133	snd_opl3_synth_use_dec(opl3);
	134	return 0;
	135	}
	136
	137	/*
	138	* MIDI emulation operators
	139	*/
5b1646a8	140	struct snd_midi_op opl3_ops = {
1da177e4 LT	141	.note_on = snd_opl3_note_on,
	142	.note_off = snd_opl3_note_off,
	143	.key_press = snd_opl3_key_press,
	144	.note_terminate = snd_opl3_terminate_note,
	145	.control = snd_opl3_control,
	146	.nrpn = snd_opl3_nrpn,
	147	.sysex = snd_opl3_sysex,
	148	};
	149
5b1646a8	150	static int snd_opl3_synth_event_input(struct snd_seq_event * ev, int direct,
1da177e4 LT	151	void *private_data, int atomic, int hop)
1da177e4 LT	152	{
5b1646a8	153	struct snd_opl3 *opl3 = private_data;
1da177e4 LT	154
	155	if (ev->type >= SNDRV_SEQ_EVENT_INSTR_BEGIN &&
	156	ev->type <= SNDRV_SEQ_EVENT_INSTR_CHANGE) {
	157	if (direct) {
	158	snd_seq_instr_event(&opl3->fm_ops, opl3->ilist, ev,
	159	opl3->seq_client, atomic, hop);
	160	}
	161	} else {
	162	snd_midi_process_event(&opl3_ops, ev, opl3->chset);
	163	}
	164	return 0;
	165	}
	166
	167	/* ------------------------------ */
	168
	169	static void snd_opl3_synth_free_port(void *private_data)
	170	{
5b1646a8	171	struct snd_opl3 *opl3 = private_data;
1da177e4 LT	172
	173	snd_midi_channel_free_set(opl3->chset);
	174	}
	175
5b1646a8	176	static int snd_opl3_synth_create_port(struct snd_opl3 * opl3)
1da177e4	177	{
5b1646a8	178	struct snd_seq_port_callback callbacks;
1da177e4 LT	179	char name[32];
	180	int voices, opl_ver;
	181
	182	voices = (opl3->hardware < OPL3_HW_OPL3) ?
	183	MAX_OPL2_VOICES : MAX_OPL3_VOICES;
	184	opl3->chset = snd_midi_channel_alloc_set(16);
	185	if (opl3->chset == NULL)
	186	return -ENOMEM;
	187	opl3->chset->private_data = opl3;
	188
	189	memset(&callbacks, 0, sizeof(callbacks));
	190	callbacks.owner = THIS_MODULE;
	191	callbacks.use = snd_opl3_synth_use;
	192	callbacks.unuse = snd_opl3_synth_unuse;
	193	callbacks.event_input = snd_opl3_synth_event_input;
	194	callbacks.private_free = snd_opl3_synth_free_port;
	195	callbacks.private_data = opl3;
	196
	197	opl_ver = (opl3->hardware & OPL3_HW_MASK) >> 8;
	198	sprintf(name, "OPL%i FM Port", opl_ver);
	199
	200	opl3->chset->client = opl3->seq_client;
	201	opl3->chset->port = snd_seq_event_port_attach(opl3->seq_client, &callbacks,
	202	SNDRV_SEQ_PORT_CAP_WRITE \|
	203	SNDRV_SEQ_PORT_CAP_SUBS_WRITE,
	204	SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC \|
	205	SNDRV_SEQ_PORT_TYPE_MIDI_GM \|
	206	SNDRV_SEQ_PORT_TYPE_SYNTH,
	207	16, voices,
	208	name);
	209	if (opl3->chset->port < 0) {
	210	snd_midi_channel_free_set(opl3->chset);
	211	return opl3->chset->port;
	212	}
	213	return 0;
	214	}
	215
	216	/* ------------------------------ */
	217
5b1646a8	218	static int snd_opl3_seq_new_device(struct snd_seq_device *dev)
1da177e4	219	{
5b1646a8	220	struct snd_opl3 *opl3;
1da177e4	221	int client;
5b1646a8	222	struct snd_seq_client_info cinfo;
1da177e4 LT	223	int opl_ver;
1da177e4 LT	224
5b1646a8	225	opl3 = (struct snd_opl3 *)SNDRV_SEQ_DEVICE_ARGPTR(dev);
1da177e4 LT	226	if (opl3 == NULL)
	227	return -EINVAL;
	228
	229	spin_lock_init(&opl3->voice_lock);
	230
	231	opl3->seq_client = -1;
	232
	233	/* allocate new client */
1da177e4	234	client = opl3->seq_client =
83e8ad69	235	snd_seq_create_kernel_client(opl3->card, opl3->seq_dev_num);
1da177e4 LT	236	if (client < 0)
	237	return client;
	238
	239	/* change name of client */
	240	memset(&cinfo, 0, sizeof(cinfo));
	241	cinfo.client = client;
	242	cinfo.type = KERNEL_CLIENT;
	243	opl_ver = (opl3->hardware & OPL3_HW_MASK) >> 8;
	244	sprintf(cinfo.name, "OPL%i FM synth", opl_ver);
	245	snd_seq_kernel_client_ctl(client, SNDRV_SEQ_IOCTL_SET_CLIENT_INFO, &cinfo);
	246
	247	snd_opl3_synth_create_port(opl3);
	248
	249	/* initialize instrument list */
	250	opl3->ilist = snd_seq_instr_list_new();
	251	if (opl3->ilist == NULL) {
	252	snd_seq_delete_kernel_client(client);
	253	opl3->seq_client = -1;
	254	return -ENOMEM;
	255	}
	256	opl3->ilist->flags = SNDRV_SEQ_INSTR_FLG_DIRECT;
	257	snd_seq_fm_init(&opl3->fm_ops, NULL);
	258
	259	/* setup system timer */
	260	init_timer(&opl3->tlist);
	261	opl3->tlist.function = snd_opl3_timer_func;
	262	opl3->tlist.data = (unsigned long) opl3;
	263	spin_lock_init(&opl3->sys_timer_lock);
	264	opl3->sys_timer_status = 0;
	265
	266	#ifdef CONFIG_SND_SEQUENCER_OSS
	267	snd_opl3_init_seq_oss(opl3, cinfo.name);
	268	#endif
	269	return 0;
	270	}
	271
5b1646a8	272	static int snd_opl3_seq_delete_device(struct snd_seq_device *dev)
1da177e4	273	{
5b1646a8	274	struct snd_opl3 *opl3;
1da177e4	275
5b1646a8	276	opl3 = (struct snd_opl3 *)SNDRV_SEQ_DEVICE_ARGPTR(dev);
1da177e4 LT	277	if (opl3 == NULL)
	278	return -EINVAL;
	279
	280	#ifdef CONFIG_SND_SEQUENCER_OSS
	281	snd_opl3_free_seq_oss(opl3);
	282	#endif
	283	if (opl3->seq_client >= 0) {
	284	snd_seq_delete_kernel_client(opl3->seq_client);
	285	opl3->seq_client = -1;
	286	}
	287	if (opl3->ilist)
	288	snd_seq_instr_list_free(&opl3->ilist);
	289	return 0;
	290	}
	291
	292	static int __init alsa_opl3_seq_init(void)
	293	{
5b1646a8	294	static struct snd_seq_dev_ops ops =
1da177e4 LT	295	{
	296	snd_opl3_seq_new_device,
	297	snd_opl3_seq_delete_device
	298	};
	299
	300	return snd_seq_device_register_driver(SNDRV_SEQ_DEV_ID_OPL3, &ops,
5b1646a8	301	sizeof(struct snd_opl3 *));
1da177e4 LT	302	}
	303
	304	static void __exit alsa_opl3_seq_exit(void)
	305	{
	306	snd_seq_device_unregister_driver(SNDRV_SEQ_DEV_ID_OPL3);
	307	}
	308
	309	module_init(alsa_opl3_seq_init)
	310	module_exit(alsa_opl3_seq_exit)