[mirror_ubuntu-bionic-kernel.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 <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
 *
 */

#include <sound/asound.h>
#include <linux/interrupt.h>
#include <linux/spinlock.h>
#include <linux/wait.h>
#include <linux/mutex.h>
#include <linux/workqueue.h>
#include <linux/device.h>

#if IS_ENABLED(CONFIG_SND_SEQUENCER)
#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 */
	const 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

	const 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 device dev;

	struct snd_info_entry *proc_entry;

#if IS_ENABLED(CONFIG_SND_SEQUENCER)
	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,
			 const struct snd_rawmidi_ops *ops);

/* callbacks */

int snd_rawmidi_receive(struct snd_rawmidi_substream *substream,
			const unsigned char *buffer, int count);
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);
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);

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