[mirror_ubuntu-artful-kernel.git] / sound / core / seq / seq_virmidi.c

/*
 *  Virtual Raw MIDI client on Sequencer
 *
 *  Copyright (c) 2000 by Takashi Iwai <tiwai@suse.de>,
 *                        Jaroslav Kysela <perex@perex.cz>
 *
 *   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
 *
 */

/*
 * Virtual Raw MIDI client
 *
 * The virtual rawmidi client is a sequencer client which associate
 * a rawmidi device file.  The created rawmidi device file can be
 * accessed as a normal raw midi, but its MIDI source and destination
 * are arbitrary.  For example, a user-client software synth connected
 * to this port can be used as a normal midi device as well.
 *
 * The virtual rawmidi device accepts also multiple opens.  Each file
 * has its own input buffer, so that no conflict would occur.  The drain
 * of input/output buffer acts only to the local buffer.
 *
 */

#include <linux/init.h>
#include <linux/wait.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <sound/core.h>
#include <sound/rawmidi.h>
#include <sound/info.h>
#include <sound/control.h>
#include <sound/minors.h>
#include <sound/seq_kernel.h>
#include <sound/seq_midi_event.h>
#include <sound/seq_virmidi.h>

MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
MODULE_DESCRIPTION("Virtual Raw MIDI client on Sequencer");
MODULE_LICENSE("GPL");

/*
 * initialize an event record
 */
static void snd_virmidi_init_event(struct snd_virmidi *vmidi,
				   struct snd_seq_event *ev)
{
	memset(ev, 0, sizeof(*ev));
	ev->source.port = vmidi->port;
	switch (vmidi->seq_mode) {
	case SNDRV_VIRMIDI_SEQ_DISPATCH:
		ev->dest.client = SNDRV_SEQ_ADDRESS_SUBSCRIBERS;
		break;
	case SNDRV_VIRMIDI_SEQ_ATTACH:
		/* FIXME: source and destination are same - not good.. */
		ev->dest.client = vmidi->client;
		ev->dest.port = vmidi->port;
		break;
	}
	ev->type = SNDRV_SEQ_EVENT_NONE;
}

/*
 * decode input event and put to read buffer of each opened file
 */
static int snd_virmidi_dev_receive_event(struct snd_virmidi_dev *rdev,
					 struct snd_seq_event *ev)
{
	struct snd_virmidi *vmidi;
	unsigned char msg[4];
	int len;

	read_lock(&rdev->filelist_lock);
	list_for_each_entry(vmidi, &rdev->filelist, list) {
		if (!vmidi->trigger)
			continue;
		if (ev->type == SNDRV_SEQ_EVENT_SYSEX) {
			if ((ev->flags & SNDRV_SEQ_EVENT_LENGTH_MASK) != SNDRV_SEQ_EVENT_LENGTH_VARIABLE)
				continue;
			snd_seq_dump_var_event(ev, (snd_seq_dump_func_t)snd_rawmidi_receive, vmidi->substream);
		} else {
			len = snd_midi_event_decode(vmidi->parser, msg, sizeof(msg), ev);
			if (len > 0)
				snd_rawmidi_receive(vmidi->substream, msg, len);
		}
	}
	read_unlock(&rdev->filelist_lock);

	return 0;
}

/*
 * receive an event from the remote virmidi port
 *
 * for rawmidi inputs, you can call this function from the event
 * handler of a remote port which is attached to the virmidi via
 * SNDRV_VIRMIDI_SEQ_ATTACH.
 */
#if 0
int snd_virmidi_receive(struct snd_rawmidi *rmidi, struct snd_seq_event *ev)
{
	struct snd_virmidi_dev *rdev;

	rdev = rmidi->private_data;
	return snd_virmidi_dev_receive_event(rdev, ev);
}
#endif  /*  0  */

/*
 * event handler of virmidi port
 */
static int snd_virmidi_event_input(struct snd_seq_event *ev, int direct,
				   void *private_data, int atomic, int hop)
{
	struct snd_virmidi_dev *rdev;

	rdev = private_data;
	if (!(rdev->flags & SNDRV_VIRMIDI_USE))
		return 0; /* ignored */
	return snd_virmidi_dev_receive_event(rdev, ev);
}

/*
 * trigger rawmidi stream for input
 */
static void snd_virmidi_input_trigger(struct snd_rawmidi_substream *substream, int up)
{
	struct snd_virmidi *vmidi = substream->runtime->private_data;

	if (up) {
		vmidi->trigger = 1;
	} else {
		vmidi->trigger = 0;
	}
}

/*
 * trigger rawmidi stream for output
 */
static void snd_virmidi_output_trigger(struct snd_rawmidi_substream *substream, int up)
{
	struct snd_virmidi *vmidi = substream->runtime->private_data;
	int count, res;
	unsigned char buf[32], *pbuf;

	if (up) {
		vmidi->trigger = 1;
		if (vmidi->seq_mode == SNDRV_VIRMIDI_SEQ_DISPATCH &&
		    !(vmidi->rdev->flags & SNDRV_VIRMIDI_SUBSCRIBE)) {
			snd_rawmidi_transmit_ack(substream, substream->runtime->buffer_size - substream->runtime->avail);
			return;		/* ignored */
		}
		if (vmidi->event.type != SNDRV_SEQ_EVENT_NONE) {
			if (snd_seq_kernel_client_dispatch(vmidi->client, &vmidi->event, in_atomic(), 0) < 0)
				return;
			vmidi->event.type = SNDRV_SEQ_EVENT_NONE;
		}
		while (1) {
			count = snd_rawmidi_transmit_peek(substream, buf, sizeof(buf));
			if (count <= 0)
				break;
			pbuf = buf;
			while (count > 0) {
				res = snd_midi_event_encode(vmidi->parser, pbuf, count, &vmidi->event);
				if (res < 0) {
					snd_midi_event_reset_encode(vmidi->parser);
					continue;
				}
				snd_rawmidi_transmit_ack(substream, res);
				pbuf += res;
				count -= res;
				if (vmidi->event.type != SNDRV_SEQ_EVENT_NONE) {
					if (snd_seq_kernel_client_dispatch(vmidi->client, &vmidi->event, in_atomic(), 0) < 0)
						return;
					vmidi->event.type = SNDRV_SEQ_EVENT_NONE;
				}
			}
		}
	} else {
		vmidi->trigger = 0;
	}
}

/*
 * open rawmidi handle for input
 */
static int snd_virmidi_input_open(struct snd_rawmidi_substream *substream)
{
	struct snd_virmidi_dev *rdev = substream->rmidi->private_data;
	struct snd_rawmidi_runtime *runtime = substream->runtime;
	struct snd_virmidi *vmidi;
	unsigned long flags;

	vmidi = kzalloc(sizeof(*vmidi), GFP_KERNEL);
	if (vmidi == NULL)
		return -ENOMEM;
	vmidi->substream = substream;
	if (snd_midi_event_new(0, &vmidi->parser) < 0) {
		kfree(vmidi);
		return -ENOMEM;
	}
	vmidi->seq_mode = rdev->seq_mode;
	vmidi->client = rdev->client;
	vmidi->port = rdev->port;	
	runtime->private_data = vmidi;
	write_lock_irqsave(&rdev->filelist_lock, flags);
	list_add_tail(&vmidi->list, &rdev->filelist);
	write_unlock_irqrestore(&rdev->filelist_lock, flags);
	vmidi->rdev = rdev;
	return 0;
}

/*
 * open rawmidi handle for output
 */
static int snd_virmidi_output_open(struct snd_rawmidi_substream *substream)
{
	struct snd_virmidi_dev *rdev = substream->rmidi->private_data;
	struct snd_rawmidi_runtime *runtime = substream->runtime;
	struct snd_virmidi *vmidi;

	vmidi = kzalloc(sizeof(*vmidi), GFP_KERNEL);
	if (vmidi == NULL)
		return -ENOMEM;
	vmidi->substream = substream;
	if (snd_midi_event_new(MAX_MIDI_EVENT_BUF, &vmidi->parser) < 0) {
		kfree(vmidi);
		return -ENOMEM;
	}
	vmidi->seq_mode = rdev->seq_mode;
	vmidi->client = rdev->client;
	vmidi->port = rdev->port;
	snd_virmidi_init_event(vmidi, &vmidi->event);
	vmidi->rdev = rdev;
	runtime->private_data = vmidi;
	return 0;
}

/*
 * close rawmidi handle for input
 */
static int snd_virmidi_input_close(struct snd_rawmidi_substream *substream)
{
	struct snd_virmidi_dev *rdev = substream->rmidi->private_data;
	struct snd_virmidi *vmidi = substream->runtime->private_data;

	write_lock_irq(&rdev->filelist_lock);
	list_del(&vmidi->list);
	write_unlock_irq(&rdev->filelist_lock);
	snd_midi_event_free(vmidi->parser);
	substream->runtime->private_data = NULL;
	kfree(vmidi);
	return 0;
}

/*
 * close rawmidi handle for output
 */
static int snd_virmidi_output_close(struct snd_rawmidi_substream *substream)
{
	struct snd_virmidi *vmidi = substream->runtime->private_data;
	snd_midi_event_free(vmidi->parser);
	substream->runtime->private_data = NULL;
	kfree(vmidi);
	return 0;
}

/*
 * subscribe callback - allow output to rawmidi device
 */
static int snd_virmidi_subscribe(void *private_data,
				 struct snd_seq_port_subscribe *info)
{
	struct snd_virmidi_dev *rdev;

	rdev = private_data;
	if (!try_module_get(rdev->card->module))
		return -EFAULT;
	rdev->flags |= SNDRV_VIRMIDI_SUBSCRIBE;
	return 0;
}

/*
 * unsubscribe callback - disallow output to rawmidi device
 */
static int snd_virmidi_unsubscribe(void *private_data,
				   struct snd_seq_port_subscribe *info)
{
	struct snd_virmidi_dev *rdev;

	rdev = private_data;
	rdev->flags &= ~SNDRV_VIRMIDI_SUBSCRIBE;
	module_put(rdev->card->module);
	return 0;
}


/*
 * use callback - allow input to rawmidi device
 */
static int snd_virmidi_use(void *private_data,
			   struct snd_seq_port_subscribe *info)
{
	struct snd_virmidi_dev *rdev;

	rdev = private_data;
	if (!try_module_get(rdev->card->module))
		return -EFAULT;
	rdev->flags |= SNDRV_VIRMIDI_USE;
	return 0;
}

/*
 * unuse callback - disallow input to rawmidi device
 */
static int snd_virmidi_unuse(void *private_data,
			     struct snd_seq_port_subscribe *info)
{
	struct snd_virmidi_dev *rdev;

	rdev = private_data;
	rdev->flags &= ~SNDRV_VIRMIDI_USE;
	module_put(rdev->card->module);
	return 0;
}


/*
 *  Register functions
 */

static struct snd_rawmidi_ops snd_virmidi_input_ops = {
	.open = snd_virmidi_input_open,
	.close = snd_virmidi_input_close,
	.trigger = snd_virmidi_input_trigger,
};

static struct snd_rawmidi_ops snd_virmidi_output_ops = {
	.open = snd_virmidi_output_open,
	.close = snd_virmidi_output_close,
	.trigger = snd_virmidi_output_trigger,
};

/*
 * create a sequencer client and a port
 */
static int snd_virmidi_dev_attach_seq(struct snd_virmidi_dev *rdev)
{
	int client;
	struct snd_seq_port_callback pcallbacks;
	struct snd_seq_port_info *pinfo;
	int err;

	if (rdev->client >= 0)
		return 0;

	pinfo = kzalloc(sizeof(*pinfo), GFP_KERNEL);
	if (!pinfo) {
		err = -ENOMEM;
		goto __error;
	}

	client = snd_seq_create_kernel_client(rdev->card, rdev->device,
					      "%s %d-%d", rdev->rmidi->name,
					      rdev->card->number,
					      rdev->device);
	if (client < 0) {
		err = client;
		goto __error;
	}
	rdev->client = client;

	/* create a port */
	pinfo->addr.client = client;
	sprintf(pinfo->name, "VirMIDI %d-%d", rdev->card->number, rdev->device);
	/* set all capabilities */
	pinfo->capability |= SNDRV_SEQ_PORT_CAP_WRITE | SNDRV_SEQ_PORT_CAP_SYNC_WRITE | SNDRV_SEQ_PORT_CAP_SUBS_WRITE;
	pinfo->capability |= SNDRV_SEQ_PORT_CAP_READ | SNDRV_SEQ_PORT_CAP_SYNC_READ | SNDRV_SEQ_PORT_CAP_SUBS_READ;
	pinfo->capability |= SNDRV_SEQ_PORT_CAP_DUPLEX;
	pinfo->type = SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC
		| SNDRV_SEQ_PORT_TYPE_SOFTWARE
		| SNDRV_SEQ_PORT_TYPE_PORT;
	pinfo->midi_channels = 16;
	memset(&pcallbacks, 0, sizeof(pcallbacks));
	pcallbacks.owner = THIS_MODULE;
	pcallbacks.private_data = rdev;
	pcallbacks.subscribe = snd_virmidi_subscribe;
	pcallbacks.unsubscribe = snd_virmidi_unsubscribe;
	pcallbacks.use = snd_virmidi_use;
	pcallbacks.unuse = snd_virmidi_unuse;
	pcallbacks.event_input = snd_virmidi_event_input;
	pinfo->kernel = &pcallbacks;
	err = snd_seq_kernel_client_ctl(client, SNDRV_SEQ_IOCTL_CREATE_PORT, pinfo);
	if (err < 0) {
		snd_seq_delete_kernel_client(client);
		rdev->client = -1;
		goto __error;
	}

	rdev->port = pinfo->addr.port;
	err = 0; /* success */

 __error:
	kfree(pinfo);
	return err;
}


/*
 * release the sequencer client
 */
static void snd_virmidi_dev_detach_seq(struct snd_virmidi_dev *rdev)
{
	if (rdev->client >= 0) {
		snd_seq_delete_kernel_client(rdev->client);
		rdev->client = -1;
	}
}

/*
 * register the device
 */
static int snd_virmidi_dev_register(struct snd_rawmidi *rmidi)
{
	struct snd_virmidi_dev *rdev = rmidi->private_data;
	int err;

	switch (rdev->seq_mode) {
	case SNDRV_VIRMIDI_SEQ_DISPATCH:
		err = snd_virmidi_dev_attach_seq(rdev);
		if (err < 0)
			return err;
		break;
	case SNDRV_VIRMIDI_SEQ_ATTACH:
		if (rdev->client == 0)
			return -EINVAL;
		/* should check presence of port more strictly.. */
		break;
	default:
		pr_err("ALSA: seq_virmidi: seq_mode is not set: %d\n", rdev->seq_mode);
		return -EINVAL;
	}
	return 0;
}


/*
 * unregister the device
 */
static int snd_virmidi_dev_unregister(struct snd_rawmidi *rmidi)
{
	struct snd_virmidi_dev *rdev = rmidi->private_data;

	if (rdev->seq_mode == SNDRV_VIRMIDI_SEQ_DISPATCH)
		snd_virmidi_dev_detach_seq(rdev);
	return 0;
}

/*
 *
 */
static const struct snd_rawmidi_global_ops snd_virmidi_global_ops = {
	.dev_register = snd_virmidi_dev_register,
	.dev_unregister = snd_virmidi_dev_unregister,
};

/*
 * free device
 */
static void snd_virmidi_free(struct snd_rawmidi *rmidi)
{
	struct snd_virmidi_dev *rdev = rmidi->private_data;
	kfree(rdev);
}

/*
 * create a new device
 *
 */
/* exported */
int snd_virmidi_new(struct snd_card *card, int device, struct snd_rawmidi **rrmidi)
{
	struct snd_rawmidi *rmidi;
	struct snd_virmidi_dev *rdev;
	int err;
	
	*rrmidi = NULL;
	if ((err = snd_rawmidi_new(card, "VirMidi", device,
				   16,	/* may be configurable */
				   16,	/* may be configurable */
				   &rmidi)) < 0)
		return err;
	strcpy(rmidi->name, rmidi->id);
	rdev = kzalloc(sizeof(*rdev), GFP_KERNEL);
	if (rdev == NULL) {
		snd_device_free(card, rmidi);
		return -ENOMEM;
	}
	rdev->card = card;
	rdev->rmidi = rmidi;
	rdev->device = device;
	rdev->client = -1;
	rwlock_init(&rdev->filelist_lock);
	INIT_LIST_HEAD(&rdev->filelist);
	rdev->seq_mode = SNDRV_VIRMIDI_SEQ_DISPATCH;
	rmidi->private_data = rdev;
	rmidi->private_free = snd_virmidi_free;
	rmidi->ops = &snd_virmidi_global_ops;
	snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_virmidi_input_ops);
	snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_virmidi_output_ops);
	rmidi->info_flags = SNDRV_RAWMIDI_INFO_INPUT |
			    SNDRV_RAWMIDI_INFO_OUTPUT |
			    SNDRV_RAWMIDI_INFO_DUPLEX;
	*rrmidi = rmidi;
	return 0;
}

/*
 *  ENTRY functions
 */

static int __init alsa_virmidi_init(void)
{
	return 0;
}

static void __exit alsa_virmidi_exit(void)
{
}

module_init(alsa_virmidi_init)
module_exit(alsa_virmidi_exit)

EXPORT_SYMBOL(snd_virmidi_new);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Virtual Raw MIDI client on Sequencer
	3	*
	4	* Copyright (c) 2000 by Takashi Iwai <tiwai@suse.de>,
	5	* Jaroslav Kysela <perex@perex.cz>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	20	*
	21	*/
	22
	23	/*
	24	* Virtual Raw MIDI client
	25	*
	26	* The virtual rawmidi client is a sequencer client which associate
	27	* a rawmidi device file. The created rawmidi device file can be
	28	* accessed as a normal raw midi, but its MIDI source and destination
	29	* are arbitrary. For example, a user-client software synth connected
	30	* to this port can be used as a normal midi device as well.
	31	*
	32	* The virtual rawmidi device accepts also multiple opens. Each file
	33	* has its own input buffer, so that no conflict would occur. The drain
	34	* of input/output buffer acts only to the local buffer.
	35	*
	36	*/
	37
1da177e4 LT	38	#include <linux/init.h>
1da177e4 LT	39	#include <linux/wait.h>
da155d5b	40	#include <linux/module.h>
1da177e4 LT	41	#include <linux/slab.h>
	42	#include <sound/core.h>
	43	#include <sound/rawmidi.h>
	44	#include <sound/info.h>
	45	#include <sound/control.h>
	46	#include <sound/minors.h>
	47	#include <sound/seq_kernel.h>
	48	#include <sound/seq_midi_event.h>
	49	#include <sound/seq_virmidi.h>
	50
	51	MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");
	52	MODULE_DESCRIPTION("Virtual Raw MIDI client on Sequencer");
	53	MODULE_LICENSE("GPL");
	54
	55	/*
	56	* initialize an event record
	57	*/
c7e0b5bf TI	58	static void snd_virmidi_init_event(struct snd_virmidi *vmidi,
c7e0b5bf TI	59	struct snd_seq_event *ev)
1da177e4 LT	60	{
	61	memset(ev, 0, sizeof(*ev));
	62	ev->source.port = vmidi->port;
	63	switch (vmidi->seq_mode) {
	64	case SNDRV_VIRMIDI_SEQ_DISPATCH:
	65	ev->dest.client = SNDRV_SEQ_ADDRESS_SUBSCRIBERS;
	66	break;
	67	case SNDRV_VIRMIDI_SEQ_ATTACH:
	68	/* FIXME: source and destination are same - not good.. */
	69	ev->dest.client = vmidi->client;
	70	ev->dest.port = vmidi->port;
	71	break;
	72	}
	73	ev->type = SNDRV_SEQ_EVENT_NONE;
	74	}
	75
	76	/*
	77	* decode input event and put to read buffer of each opened file
	78	*/
c7e0b5bf TI	79	static int snd_virmidi_dev_receive_event(struct snd_virmidi_dev *rdev,
c7e0b5bf TI	80	struct snd_seq_event *ev)
1da177e4	81	{
c7e0b5bf	82	struct snd_virmidi *vmidi;
1da177e4 LT	83	unsigned char msg[4];
	84	int len;
	85
	86	read_lock(&rdev->filelist_lock);
9244b2c3	87	list_for_each_entry(vmidi, &rdev->filelist, list) {
1da177e4 LT	88	if (!vmidi->trigger)
	89	continue;
	90	if (ev->type == SNDRV_SEQ_EVENT_SYSEX) {
	91	if ((ev->flags & SNDRV_SEQ_EVENT_LENGTH_MASK) != SNDRV_SEQ_EVENT_LENGTH_VARIABLE)
	92	continue;
	93	snd_seq_dump_var_event(ev, (snd_seq_dump_func_t)snd_rawmidi_receive, vmidi->substream);
	94	} else {
	95	len = snd_midi_event_decode(vmidi->parser, msg, sizeof(msg), ev);
	96	if (len > 0)
	97	snd_rawmidi_receive(vmidi->substream, msg, len);
	98	}
	99	}
	100	read_unlock(&rdev->filelist_lock);
	101
	102	return 0;
	103	}
	104
	105	/*
	106	* receive an event from the remote virmidi port
	107	*
	108	* for rawmidi inputs, you can call this function from the event
	109	* handler of a remote port which is attached to the virmidi via
	110	* SNDRV_VIRMIDI_SEQ_ATTACH.
	111	*/
123992f7	112	#if 0
c7e0b5bf	113	int snd_virmidi_receive(struct snd_rawmidi rmidi, struct snd_seq_event ev)
1da177e4	114	{
c7e0b5bf	115	struct snd_virmidi_dev *rdev;
1da177e4 LT	116
	117	rdev = rmidi->private_data;
	118	return snd_virmidi_dev_receive_event(rdev, ev);
	119	}
123992f7	120	#endif /* 0 */
1da177e4 LT	121
	122	/*
	123	* event handler of virmidi port
	124	*/
c7e0b5bf	125	static int snd_virmidi_event_input(struct snd_seq_event *ev, int direct,
1da177e4 LT	126	void *private_data, int atomic, int hop)
1da177e4 LT	127	{
c7e0b5bf	128	struct snd_virmidi_dev *rdev;
1da177e4 LT	129
	130	rdev = private_data;
	131	if (!(rdev->flags & SNDRV_VIRMIDI_USE))
	132	return 0; /* ignored */
	133	return snd_virmidi_dev_receive_event(rdev, ev);
	134	}
	135
	136	/*
	137	* trigger rawmidi stream for input
	138	*/
c7e0b5bf	139	static void snd_virmidi_input_trigger(struct snd_rawmidi_substream *substream, int up)
1da177e4	140	{
c7e0b5bf	141	struct snd_virmidi *vmidi = substream->runtime->private_data;
1da177e4 LT	142
	143	if (up) {
	144	vmidi->trigger = 1;
	145	} else {
	146	vmidi->trigger = 0;
	147	}
	148	}
	149
	150	/*
	151	* trigger rawmidi stream for output
	152	*/
c7e0b5bf	153	static void snd_virmidi_output_trigger(struct snd_rawmidi_substream *substream, int up)
1da177e4	154	{
c7e0b5bf	155	struct snd_virmidi *vmidi = substream->runtime->private_data;
1da177e4 LT	156	int count, res;
	157	unsigned char buf[32], *pbuf;
	158
	159	if (up) {
	160	vmidi->trigger = 1;
	161	if (vmidi->seq_mode == SNDRV_VIRMIDI_SEQ_DISPATCH &&
	162	!(vmidi->rdev->flags & SNDRV_VIRMIDI_SUBSCRIBE)) {
	163	snd_rawmidi_transmit_ack(substream, substream->runtime->buffer_size - substream->runtime->avail);
	164	return; /* ignored */
	165	}
	166	if (vmidi->event.type != SNDRV_SEQ_EVENT_NONE) {
62c5549e	167	if (snd_seq_kernel_client_dispatch(vmidi->client, &vmidi->event, in_atomic(), 0) < 0)
1da177e4 LT	168	return;
	169	vmidi->event.type = SNDRV_SEQ_EVENT_NONE;
	170	}
	171	while (1) {
	172	count = snd_rawmidi_transmit_peek(substream, buf, sizeof(buf));
	173	if (count <= 0)
	174	break;
	175	pbuf = buf;
	176	while (count > 0) {
	177	res = snd_midi_event_encode(vmidi->parser, pbuf, count, &vmidi->event);
	178	if (res < 0) {
	179	snd_midi_event_reset_encode(vmidi->parser);
	180	continue;
	181	}
	182	snd_rawmidi_transmit_ack(substream, res);
	183	pbuf += res;
	184	count -= res;
	185	if (vmidi->event.type != SNDRV_SEQ_EVENT_NONE) {
62c5549e	186	if (snd_seq_kernel_client_dispatch(vmidi->client, &vmidi->event, in_atomic(), 0) < 0)
1da177e4 LT	187	return;
	188	vmidi->event.type = SNDRV_SEQ_EVENT_NONE;
	189	}
	190	}
	191	}
	192	} else {
	193	vmidi->trigger = 0;
	194	}
	195	}
	196
	197	/*
	198	* open rawmidi handle for input
	199	*/
c7e0b5bf	200	static int snd_virmidi_input_open(struct snd_rawmidi_substream *substream)
1da177e4	201	{
c7e0b5bf TI	202	struct snd_virmidi_dev *rdev = substream->rmidi->private_data;
	203	struct snd_rawmidi_runtime *runtime = substream->runtime;
	204	struct snd_virmidi *vmidi;
1da177e4 LT	205	unsigned long flags;
1da177e4 LT	206
ecca82b4	207	vmidi = kzalloc(sizeof(*vmidi), GFP_KERNEL);
1da177e4 LT	208	if (vmidi == NULL)
	209	return -ENOMEM;
	210	vmidi->substream = substream;
	211	if (snd_midi_event_new(0, &vmidi->parser) < 0) {
	212	kfree(vmidi);
	213	return -ENOMEM;
	214	}
	215	vmidi->seq_mode = rdev->seq_mode;
	216	vmidi->client = rdev->client;
	217	vmidi->port = rdev->port;
	218	runtime->private_data = vmidi;
	219	write_lock_irqsave(&rdev->filelist_lock, flags);
	220	list_add_tail(&vmidi->list, &rdev->filelist);
	221	write_unlock_irqrestore(&rdev->filelist_lock, flags);
	222	vmidi->rdev = rdev;
	223	return 0;
	224	}
	225
	226	/*
	227	* open rawmidi handle for output
	228	*/
c7e0b5bf	229	static int snd_virmidi_output_open(struct snd_rawmidi_substream *substream)
1da177e4	230	{
c7e0b5bf TI	231	struct snd_virmidi_dev *rdev = substream->rmidi->private_data;
	232	struct snd_rawmidi_runtime *runtime = substream->runtime;
	233	struct snd_virmidi *vmidi;
1da177e4	234
ecca82b4	235	vmidi = kzalloc(sizeof(*vmidi), GFP_KERNEL);
1da177e4 LT	236	if (vmidi == NULL)
	237	return -ENOMEM;
	238	vmidi->substream = substream;
	239	if (snd_midi_event_new(MAX_MIDI_EVENT_BUF, &vmidi->parser) < 0) {
	240	kfree(vmidi);
	241	return -ENOMEM;
	242	}
	243	vmidi->seq_mode = rdev->seq_mode;
	244	vmidi->client = rdev->client;
	245	vmidi->port = rdev->port;
	246	snd_virmidi_init_event(vmidi, &vmidi->event);
	247	vmidi->rdev = rdev;
	248	runtime->private_data = vmidi;
	249	return 0;
	250	}
	251
	252	/*
	253	* close rawmidi handle for input
	254	*/
c7e0b5bf	255	static int snd_virmidi_input_close(struct snd_rawmidi_substream *substream)
1da177e4	256	{
2d1b5c08	257	struct snd_virmidi_dev *rdev = substream->rmidi->private_data;
c7e0b5bf	258	struct snd_virmidi *vmidi = substream->runtime->private_data;
2d1b5c08 TI	259
2d1b5c08 TI	260	write_lock_irq(&rdev->filelist_lock);
1da177e4	261	list_del(&vmidi->list);
2d1b5c08 TI	262	write_unlock_irq(&rdev->filelist_lock);
2d1b5c08 TI	263	snd_midi_event_free(vmidi->parser);
1da177e4 LT	264	substream->runtime->private_data = NULL;
	265	kfree(vmidi);
	266	return 0;
	267	}
	268
	269	/*
	270	* close rawmidi handle for output
	271	*/
c7e0b5bf	272	static int snd_virmidi_output_close(struct snd_rawmidi_substream *substream)
1da177e4	273	{
c7e0b5bf	274	struct snd_virmidi *vmidi = substream->runtime->private_data;
1da177e4 LT	275	snd_midi_event_free(vmidi->parser);
	276	substream->runtime->private_data = NULL;
	277	kfree(vmidi);
	278	return 0;
	279	}
	280
	281	/*
	282	* subscribe callback - allow output to rawmidi device
	283	*/
c7e0b5bf TI	284	static int snd_virmidi_subscribe(void *private_data,
c7e0b5bf TI	285	struct snd_seq_port_subscribe *info)
1da177e4	286	{
c7e0b5bf	287	struct snd_virmidi_dev *rdev;
1da177e4 LT	288
	289	rdev = private_data;
	290	if (!try_module_get(rdev->card->module))
	291	return -EFAULT;
	292	rdev->flags \|= SNDRV_VIRMIDI_SUBSCRIBE;
	293	return 0;
	294	}
	295
	296	/*
	297	* unsubscribe callback - disallow output to rawmidi device
	298	*/
c7e0b5bf TI	299	static int snd_virmidi_unsubscribe(void *private_data,
c7e0b5bf TI	300	struct snd_seq_port_subscribe *info)
1da177e4	301	{
c7e0b5bf	302	struct snd_virmidi_dev *rdev;
1da177e4 LT	303
	304	rdev = private_data;
	305	rdev->flags &= ~SNDRV_VIRMIDI_SUBSCRIBE;
	306	module_put(rdev->card->module);
	307	return 0;
	308	}
	309
	310
	311	/*
	312	* use callback - allow input to rawmidi device
	313	*/
c7e0b5bf TI	314	static int snd_virmidi_use(void *private_data,
c7e0b5bf TI	315	struct snd_seq_port_subscribe *info)
1da177e4	316	{
c7e0b5bf	317	struct snd_virmidi_dev *rdev;
1da177e4 LT	318
	319	rdev = private_data;
	320	if (!try_module_get(rdev->card->module))
	321	return -EFAULT;
	322	rdev->flags \|= SNDRV_VIRMIDI_USE;
	323	return 0;
	324	}
	325
	326	/*
	327	* unuse callback - disallow input to rawmidi device
	328	*/
c7e0b5bf TI	329	static int snd_virmidi_unuse(void *private_data,
c7e0b5bf TI	330	struct snd_seq_port_subscribe *info)
1da177e4	331	{
c7e0b5bf	332	struct snd_virmidi_dev *rdev;
1da177e4 LT	333
	334	rdev = private_data;
	335	rdev->flags &= ~SNDRV_VIRMIDI_USE;
	336	module_put(rdev->card->module);
	337	return 0;
	338	}
	339
	340
	341	/*
	342	* Register functions
	343	*/
	344
c7e0b5bf	345	static struct snd_rawmidi_ops snd_virmidi_input_ops = {
1da177e4 LT	346	.open = snd_virmidi_input_open,
	347	.close = snd_virmidi_input_close,
	348	.trigger = snd_virmidi_input_trigger,
	349	};
	350
c7e0b5bf	351	static struct snd_rawmidi_ops snd_virmidi_output_ops = {
1da177e4 LT	352	.open = snd_virmidi_output_open,
	353	.close = snd_virmidi_output_close,
	354	.trigger = snd_virmidi_output_trigger,
	355	};
	356
	357	/*
	358	* create a sequencer client and a port
	359	*/
c7e0b5bf	360	static int snd_virmidi_dev_attach_seq(struct snd_virmidi_dev *rdev)
1da177e4 LT	361	{
1da177e4 LT	362	int client;
c7e0b5bf	363	struct snd_seq_port_callback pcallbacks;
c7e0b5bf	364	struct snd_seq_port_info *pinfo;
1da177e4 LT	365	int err;
	366
	367	if (rdev->client >= 0)
	368	return 0;
	369
dd00cc48	370	pinfo = kzalloc(sizeof(*pinfo), GFP_KERNEL);
7b6d9245	371	if (!pinfo) {
1da177e4 LT	372	err = -ENOMEM;
	373	goto __error;
	374	}
	375
7b6d9245 CL	376	client = snd_seq_create_kernel_client(rdev->card, rdev->device,
	377	"%s %d-%d", rdev->rmidi->name,
	378	rdev->card->number,
	379	rdev->device);
1da177e4 LT	380	if (client < 0) {
	381	err = client;
	382	goto __error;
	383	}
	384	rdev->client = client;
	385
1da177e4	386	/* create a port */
1da177e4 LT	387	pinfo->addr.client = client;
	388	sprintf(pinfo->name, "VirMIDI %d-%d", rdev->card->number, rdev->device);
	389	/* set all capabilities */
	390	pinfo->capability \|= SNDRV_SEQ_PORT_CAP_WRITE \| SNDRV_SEQ_PORT_CAP_SYNC_WRITE \| SNDRV_SEQ_PORT_CAP_SUBS_WRITE;
	391	pinfo->capability \|= SNDRV_SEQ_PORT_CAP_READ \| SNDRV_SEQ_PORT_CAP_SYNC_READ \| SNDRV_SEQ_PORT_CAP_SUBS_READ;
	392	pinfo->capability \|= SNDRV_SEQ_PORT_CAP_DUPLEX;
450047a7 CL	393	pinfo->type = SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC
	394	\| SNDRV_SEQ_PORT_TYPE_SOFTWARE
	395	\| SNDRV_SEQ_PORT_TYPE_PORT;
1da177e4 LT	396	pinfo->midi_channels = 16;
	397	memset(&pcallbacks, 0, sizeof(pcallbacks));
	398	pcallbacks.owner = THIS_MODULE;
	399	pcallbacks.private_data = rdev;
	400	pcallbacks.subscribe = snd_virmidi_subscribe;
	401	pcallbacks.unsubscribe = snd_virmidi_unsubscribe;
	402	pcallbacks.use = snd_virmidi_use;
	403	pcallbacks.unuse = snd_virmidi_unuse;
	404	pcallbacks.event_input = snd_virmidi_event_input;
	405	pinfo->kernel = &pcallbacks;
0aa0d387	406	err = snd_seq_kernel_client_ctl(client, SNDRV_SEQ_IOCTL_CREATE_PORT, pinfo);
1da177e4 LT	407	if (err < 0) {
	408	snd_seq_delete_kernel_client(client);
	409	rdev->client = -1;
	410	goto __error;
	411	}
	412
	413	rdev->port = pinfo->addr.port;
	414	err = 0; /* success */
	415
	416	__error:
1da177e4 LT	417	kfree(pinfo);
	418	return err;
	419	}
	420
	421
	422	/*
	423	* release the sequencer client
	424	*/
c7e0b5bf	425	static void snd_virmidi_dev_detach_seq(struct snd_virmidi_dev *rdev)
1da177e4 LT	426	{
	427	if (rdev->client >= 0) {
	428	snd_seq_delete_kernel_client(rdev->client);
	429	rdev->client = -1;
	430	}
	431	}
	432
	433	/*
	434	* register the device
	435	*/
c7e0b5bf	436	static int snd_virmidi_dev_register(struct snd_rawmidi *rmidi)
1da177e4	437	{
c7e0b5bf	438	struct snd_virmidi_dev *rdev = rmidi->private_data;
1da177e4 LT	439	int err;
	440
	441	switch (rdev->seq_mode) {
	442	case SNDRV_VIRMIDI_SEQ_DISPATCH:
	443	err = snd_virmidi_dev_attach_seq(rdev);
	444	if (err < 0)
	445	return err;
	446	break;
	447	case SNDRV_VIRMIDI_SEQ_ATTACH:
	448	if (rdev->client == 0)
	449	return -EINVAL;
	450	/* should check presence of port more strictly.. */
	451	break;
	452	default:
04cc79a0	453	pr_err("ALSA: seq_virmidi: seq_mode is not set: %d\n", rdev->seq_mode);
1da177e4 LT	454	return -EINVAL;
	455	}
	456	return 0;
	457	}
	458
	459
	460	/*
	461	* unregister the device
	462	*/
c7e0b5bf	463	static int snd_virmidi_dev_unregister(struct snd_rawmidi *rmidi)
1da177e4	464	{
c7e0b5bf	465	struct snd_virmidi_dev *rdev = rmidi->private_data;
1da177e4 LT	466
	467	if (rdev->seq_mode == SNDRV_VIRMIDI_SEQ_DISPATCH)
	468	snd_virmidi_dev_detach_seq(rdev);
	469	return 0;
	470	}
	471
	472	/*
	473	*
	474	*/
efdbe3c3	475	static const struct snd_rawmidi_global_ops snd_virmidi_global_ops = {
1da177e4 LT	476	.dev_register = snd_virmidi_dev_register,
	477	.dev_unregister = snd_virmidi_dev_unregister,
	478	};
	479
	480	/*
	481	* free device
	482	*/
c7e0b5bf	483	static void snd_virmidi_free(struct snd_rawmidi *rmidi)
1da177e4	484	{
c7e0b5bf	485	struct snd_virmidi_dev *rdev = rmidi->private_data;
1da177e4 LT	486	kfree(rdev);
	487	}
	488
	489	/*
	490	* create a new device
	491	*
	492	*/
	493	/* exported */
c7e0b5bf	494	int snd_virmidi_new(struct snd_card card, int device, struct snd_rawmidi *rrmidi)
1da177e4	495	{
c7e0b5bf TI	496	struct snd_rawmidi *rmidi;
c7e0b5bf TI	497	struct snd_virmidi_dev *rdev;
1da177e4 LT	498	int err;
	499
	500	*rrmidi = NULL;
	501	if ((err = snd_rawmidi_new(card, "VirMidi", device,
	502	16, /* may be configurable */
	503	16, /* may be configurable */
	504	&rmidi)) < 0)
	505	return err;
	506	strcpy(rmidi->name, rmidi->id);
ecca82b4	507	rdev = kzalloc(sizeof(*rdev), GFP_KERNEL);
1da177e4 LT	508	if (rdev == NULL) {
	509	snd_device_free(card, rmidi);
	510	return -ENOMEM;
	511	}
	512	rdev->card = card;
	513	rdev->rmidi = rmidi;
	514	rdev->device = device;
	515	rdev->client = -1;
	516	rwlock_init(&rdev->filelist_lock);
	517	INIT_LIST_HEAD(&rdev->filelist);
	518	rdev->seq_mode = SNDRV_VIRMIDI_SEQ_DISPATCH;
	519	rmidi->private_data = rdev;
	520	rmidi->private_free = snd_virmidi_free;
	521	rmidi->ops = &snd_virmidi_global_ops;
	522	snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_virmidi_input_ops);
	523	snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_virmidi_output_ops);
	524	rmidi->info_flags = SNDRV_RAWMIDI_INFO_INPUT \|
	525	SNDRV_RAWMIDI_INFO_OUTPUT \|
	526	SNDRV_RAWMIDI_INFO_DUPLEX;
	527	*rrmidi = rmidi;
	528	return 0;
	529	}
	530
	531	/*
	532	* ENTRY functions
	533	*/
	534
	535	static int __init alsa_virmidi_init(void)
	536	{
	537	return 0;
	538	}
	539
	540	static void __exit alsa_virmidi_exit(void)
	541	{
	542	}
	543
	544	module_init(alsa_virmidi_init)
	545	module_exit(alsa_virmidi_exit)
	546
	547	EXPORT_SYMBOL(snd_virmidi_new);