[linux.git] / include / sound / rawmidi.h

#ifndef __SOUND_RAWMIDI_H
#define __SOUND_RAWMIDI_H

/*
 *  Abstract layer for MIDI v1.0 stream
 *  Copyright (c) by Jaroslav Kysela <[email protected]>
 *
 *
 *   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 <sound/asound.h>
#include <linux/interrupt.h>
#include <linux/spinlock.h>
#include <linux/wait.h>
#include <linux/mutex.h>
#include <linux/workqueue.h>

#if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
#include <sound/seq_device.h>
#endif

/*
 *  Raw MIDI interface
 */

#define SNDRV_RAWMIDI_DEVICES		8

#define SNDRV_RAWMIDI_LFLG_OUTPUT	(1<<0)
#define SNDRV_RAWMIDI_LFLG_INPUT	(1<<1)
#define SNDRV_RAWMIDI_LFLG_OPEN		(3<<0)
#define SNDRV_RAWMIDI_LFLG_APPEND	(1<<2)

struct snd_rawmidi;
struct snd_rawmidi_substream;
struct snd_seq_port_info;
struct pid;

struct snd_rawmidi_ops {
	int (*open) (struct snd_rawmidi_substream * substream);
	int (*close) (struct snd_rawmidi_substream * substream);
	void (*trigger) (struct snd_rawmidi_substream * substream, int up);
	void (*drain) (struct snd_rawmidi_substream * substream);
};

struct snd_rawmidi_global_ops {
	int (*dev_register) (struct snd_rawmidi * rmidi);
	int (*dev_unregister) (struct snd_rawmidi * rmidi);
	void (*get_port_info)(struct snd_rawmidi *rmidi, int number,
			      struct snd_seq_port_info *info);
};

struct snd_rawmidi_runtime {
	struct snd_rawmidi_substream *substream;
	unsigned int drain: 1,	/* drain stage */
		     oss: 1;	/* OSS compatible mode */
	/* midi stream buffer */
	unsigned char *buffer;	/* buffer for MIDI data */
	size_t buffer_size;	/* size of buffer */
	size_t appl_ptr;	/* application pointer */
	size_t hw_ptr;		/* hardware pointer */
	size_t avail_min;	/* min avail for wakeup */
	size_t avail;		/* max used buffer for wakeup */
	size_t xruns;		/* over/underruns counter */
	/* misc */
	spinlock_t lock;
	wait_queue_head_t sleep;
	/* event handler (new bytes, input only) */
	void (*event)(struct snd_rawmidi_substream *substream);
	/* defers calls to event [input] or ops->trigger [output] */
	struct work_struct event_work;
	/* private data */
	void *private_data;
	void (*private_free)(struct snd_rawmidi_substream *substream);
};

struct snd_rawmidi_substream {
	struct list_head list;		/* list of all substream for given stream */
	int stream;			/* direction */
	int number;			/* substream number */
	unsigned int opened: 1,		/* open flag */
		     append: 1,		/* append flag (merge more streams) */
		     active_sensing: 1; /* send active sensing when close */
	int use_count;			/* use counter (for output) */
	size_t bytes;
	struct snd_rawmidi *rmidi;
	struct snd_rawmidi_str *pstr;
	char name[32];
	struct snd_rawmidi_runtime *runtime;
	struct pid *pid;
	/* hardware layer */
	struct snd_rawmidi_ops *ops;
};

struct snd_rawmidi_file {
	struct snd_rawmidi *rmidi;
	struct snd_rawmidi_substream *input;
	struct snd_rawmidi_substream *output;
};

struct snd_rawmidi_str {
	unsigned int substream_count;
	unsigned int substream_opened;
	struct list_head substreams;
};

struct snd_rawmidi {
	struct snd_card *card;
	struct list_head list;
	unsigned int device;		/* device number */
	unsigned int info_flags;	/* SNDRV_RAWMIDI_INFO_XXXX */
	char id[64];
	char name[80];

#ifdef CONFIG_SND_OSSEMUL
	int ossreg;
#endif

	struct snd_rawmidi_global_ops *ops;

	struct snd_rawmidi_str streams[2];

	void *private_data;
	void (*private_free) (struct snd_rawmidi *rmidi);

	struct mutex open_mutex;
	wait_queue_head_t open_wait;

	struct snd_info_entry *dev;
	struct snd_info_entry *proc_entry;

#if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
	struct snd_seq_device *seq_dev;
#endif
};

/* main rawmidi functions */

int snd_rawmidi_new(struct snd_card *card, char *id, int device,
		    int output_count, int input_count,
		    struct snd_rawmidi **rmidi);
void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream,
			 struct snd_rawmidi_ops *ops);

/* callbacks */

void snd_rawmidi_receive_reset(struct snd_rawmidi_substream *substream);
int snd_rawmidi_receive(struct snd_rawmidi_substream *substream,
			const unsigned char *buffer, int count);
void snd_rawmidi_transmit_reset(struct snd_rawmidi_substream *substream);
int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream);
int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
			      unsigned char *buffer, int count);
int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count);
int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream,
			 unsigned char *buffer, int count);

/* main midi functions */

int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info);
int snd_rawmidi_kernel_open(struct snd_card *card, int device, int subdevice,
			    int mode, struct snd_rawmidi_file *rfile);
int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile);
int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream,
			      struct snd_rawmidi_params *params);
int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream,
			     struct snd_rawmidi_params *params);
int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream);
int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream);
int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream);
long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream,
			     unsigned char *buf, long count);
long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream,
			      const unsigned char *buf, long count);

#endif /* __SOUND_RAWMIDI_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef __SOUND_RAWMIDI_H
	2	#define __SOUND_RAWMIDI_H
	3
	4	/*
	5	* Abstract layer for MIDI v1.0 stream
c1017a4c	6	* Copyright (c) by Jaroslav Kysela <[email protected]>
1da177e4 LT	7	*
	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 <sound/asound.h>
	26	#include <linux/interrupt.h>
	27	#include <linux/spinlock.h>
	28	#include <linux/wait.h>
1a60d4c5	29	#include <linux/mutex.h>
b3c705aa	30	#include <linux/workqueue.h>
1da177e4 LT	31
1da177e4 LT	32	#if defined(CONFIG_SND_SEQUENCER) \|\| defined(CONFIG_SND_SEQUENCER_MODULE)
a1ce3928	33	#include <sound/seq_device.h>
1da177e4 LT	34	#endif
	35
	36	/*
	37	* Raw MIDI interface
	38	*/
	39
1da177e4 LT	40	#define SNDRV_RAWMIDI_DEVICES 8
	41
	42	#define SNDRV_RAWMIDI_LFLG_OUTPUT (1<<0)
	43	#define SNDRV_RAWMIDI_LFLG_INPUT (1<<1)
	44	#define SNDRV_RAWMIDI_LFLG_OPEN (3<<0)
	45	#define SNDRV_RAWMIDI_LFLG_APPEND (1<<2)
1da177e4	46
48c9d417 TI	47	struct snd_rawmidi;
48c9d417 TI	48	struct snd_rawmidi_substream;
a7b928ac	49	struct snd_seq_port_info;
7584af10	50	struct pid;
1da177e4	51
48c9d417 TI	52	struct snd_rawmidi_ops {
	53	int (open) (struct snd_rawmidi_substream substream);
	54	int (close) (struct snd_rawmidi_substream substream);
	55	void (trigger) (struct snd_rawmidi_substream substream, int up);
	56	void (drain) (struct snd_rawmidi_substream substream);
	57	};
1da177e4	58
48c9d417 TI	59	struct snd_rawmidi_global_ops {
	60	int (dev_register) (struct snd_rawmidi rmidi);
	61	int (dev_unregister) (struct snd_rawmidi rmidi);
a7b928ac CL	62	void (get_port_info)(struct snd_rawmidi rmidi, int number,
a7b928ac CL	63	struct snd_seq_port_info *info);
48c9d417	64	};
1da177e4	65
48c9d417	66	struct snd_rawmidi_runtime {
b3c705aa	67	struct snd_rawmidi_substream *substream;
1da177e4 LT	68	unsigned int drain: 1, /* drain stage */
	69	oss: 1; /* OSS compatible mode */
	70	/* midi stream buffer */
	71	unsigned char buffer; / buffer for MIDI data */
	72	size_t buffer_size; /* size of buffer */
	73	size_t appl_ptr; /* application pointer */
	74	size_t hw_ptr; /* hardware pointer */
	75	size_t avail_min; /* min avail for wakeup */
	76	size_t avail; /* max used buffer for wakeup */
	77	size_t xruns; /* over/underruns counter */
	78	/* misc */
	79	spinlock_t lock;
	80	wait_queue_head_t sleep;
	81	/* event handler (new bytes, input only) */
48c9d417	82	void (event)(struct snd_rawmidi_substream substream);
1da177e4	83	/* defers calls to event [input] or ops->trigger [output] */
b3c705aa	84	struct work_struct event_work;
1da177e4 LT	85	/* private data */
1da177e4 LT	86	void *private_data;
48c9d417	87	void (private_free)(struct snd_rawmidi_substream substream);
1da177e4 LT	88	};
1da177e4 LT	89
48c9d417	90	struct snd_rawmidi_substream {
1da177e4 LT	91	struct list_head list; /* list of all substream for given stream */
	92	int stream; /* direction */
	93	int number; /* substream number */
	94	unsigned int opened: 1, /* open flag */
	95	append: 1, /* append flag (merge more streams) */
	96	active_sensing: 1; /* send active sensing when close */
	97	int use_count; /* use counter (for output) */
	98	size_t bytes;
48c9d417 TI	99	struct snd_rawmidi *rmidi;
48c9d417 TI	100	struct snd_rawmidi_str *pstr;
1da177e4	101	char name[32];
48c9d417	102	struct snd_rawmidi_runtime *runtime;
7584af10	103	struct pid *pid;
1da177e4	104	/* hardware layer */
48c9d417	105	struct snd_rawmidi_ops *ops;
1da177e4 LT	106	};
1da177e4 LT	107
48c9d417 TI	108	struct snd_rawmidi_file {
	109	struct snd_rawmidi *rmidi;
	110	struct snd_rawmidi_substream *input;
	111	struct snd_rawmidi_substream *output;
	112	};
1da177e4	113
48c9d417	114	struct snd_rawmidi_str {
1da177e4 LT	115	unsigned int substream_count;
	116	unsigned int substream_opened;
	117	struct list_head substreams;
	118	};
	119
48c9d417 TI	120	struct snd_rawmidi {
48c9d417 TI	121	struct snd_card *card;
f87135f5	122	struct list_head list;
1da177e4 LT	123	unsigned int device; /* device number */
	124	unsigned int info_flags; /* SNDRV_RAWMIDI_INFO_XXXX */
	125	char id[64];
	126	char name[80];
	127
	128	#ifdef CONFIG_SND_OSSEMUL
	129	int ossreg;
	130	#endif
	131
48c9d417	132	struct snd_rawmidi_global_ops *ops;
1da177e4	133
48c9d417	134	struct snd_rawmidi_str streams[2];
1da177e4 LT	135
1da177e4 LT	136	void *private_data;
48c9d417	137	void (private_free) (struct snd_rawmidi rmidi);
1da177e4	138
1a60d4c5	139	struct mutex open_mutex;
1da177e4 LT	140	wait_queue_head_t open_wait;
1da177e4 LT	141
48c9d417 TI	142	struct snd_info_entry *dev;
48c9d417 TI	143	struct snd_info_entry *proc_entry;
1da177e4 LT	144
1da177e4 LT	145	#if defined(CONFIG_SND_SEQUENCER) \|\| defined(CONFIG_SND_SEQUENCER_MODULE)
48c9d417	146	struct snd_seq_device *seq_dev;
1da177e4 LT	147	#endif
	148	};
	149
	150	/* main rawmidi functions */
	151
48c9d417	152	int snd_rawmidi_new(struct snd_card card, char id, int device,
1da177e4	153	int output_count, int input_count,
48c9d417 TI	154	struct snd_rawmidi **rmidi);
	155	void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream,
	156	struct snd_rawmidi_ops *ops);
1da177e4 LT	157
	158	/* callbacks */
	159
48c9d417 TI	160	void snd_rawmidi_receive_reset(struct snd_rawmidi_substream *substream);
	161	int snd_rawmidi_receive(struct snd_rawmidi_substream *substream,
	162	const unsigned char *buffer, int count);
	163	void snd_rawmidi_transmit_reset(struct snd_rawmidi_substream *substream);
	164	int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream);
	165	int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
	166	unsigned char *buffer, int count);
	167	int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count);
	168	int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream,
	169	unsigned char *buffer, int count);
1da177e4 LT	170
	171	/* main midi functions */
	172
48c9d417	173	int snd_rawmidi_info_select(struct snd_card card, struct snd_rawmidi_info info);
f87135f5 CL	174	int snd_rawmidi_kernel_open(struct snd_card *card, int device, int subdevice,
f87135f5 CL	175	int mode, struct snd_rawmidi_file *rfile);
48c9d417 TI	176	int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile);
	177	int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream,
	178	struct snd_rawmidi_params *params);
	179	int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream,
	180	struct snd_rawmidi_params *params);
	181	int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream);
	182	int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream);
	183	int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream);
	184	long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream,
	185	unsigned char *buf, long count);
	186	long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream,
	187	const unsigned char *buf, long count);
1da177e4 LT	188
1da177e4 LT	189	#endif /* __SOUND_RAWMIDI_H */