rawmidi.h 6.2 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5
#ifndef __SOUND_RAWMIDI_H
#define __SOUND_RAWMIDI_H

/*
 *  Abstract layer for MIDI v1.0 stream
6
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds's avatar
Linus Torvalds committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
 *
 *
 *   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>
29
#include <linux/mutex.h>
30
#include <linux/workqueue.h>
31
#include <linux/device.h>
Linus Torvalds's avatar
Linus Torvalds committed
32 33

#if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
34
#include <sound/seq_device.h>
Linus Torvalds's avatar
Linus Torvalds committed
35 36 37 38 39 40 41 42 43 44 45 46 47
#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)

48 49
struct snd_rawmidi;
struct snd_rawmidi_substream;
50
struct snd_seq_port_info;
51
struct pid;
Linus Torvalds's avatar
Linus Torvalds committed
52

53 54 55 56 57 58
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);
};
Linus Torvalds's avatar
Linus Torvalds committed
59

60 61 62
struct snd_rawmidi_global_ops {
	int (*dev_register) (struct snd_rawmidi * rmidi);
	int (*dev_unregister) (struct snd_rawmidi * rmidi);
63 64
	void (*get_port_info)(struct snd_rawmidi *rmidi, int number,
			      struct snd_seq_port_info *info);
65
};
Linus Torvalds's avatar
Linus Torvalds committed
66

67
struct snd_rawmidi_runtime {
68
	struct snd_rawmidi_substream *substream;
Linus Torvalds's avatar
Linus Torvalds committed
69 70 71 72 73 74 75 76 77 78 79 80 81 82
	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) */
83
	void (*event)(struct snd_rawmidi_substream *substream);
Linus Torvalds's avatar
Linus Torvalds committed
84
	/* defers calls to event [input] or ops->trigger [output] */
85
	struct work_struct event_work;
Linus Torvalds's avatar
Linus Torvalds committed
86 87
	/* private data */
	void *private_data;
88
	void (*private_free)(struct snd_rawmidi_substream *substream);
Linus Torvalds's avatar
Linus Torvalds committed
89 90
};

91
struct snd_rawmidi_substream {
Linus Torvalds's avatar
Linus Torvalds committed
92 93 94 95 96 97 98 99
	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;
100 101
	struct snd_rawmidi *rmidi;
	struct snd_rawmidi_str *pstr;
Linus Torvalds's avatar
Linus Torvalds committed
102
	char name[32];
103
	struct snd_rawmidi_runtime *runtime;
104
	struct pid *pid;
Linus Torvalds's avatar
Linus Torvalds committed
105
	/* hardware layer */
106
	struct snd_rawmidi_ops *ops;
Linus Torvalds's avatar
Linus Torvalds committed
107 108
};

109 110 111 112 113
struct snd_rawmidi_file {
	struct snd_rawmidi *rmidi;
	struct snd_rawmidi_substream *input;
	struct snd_rawmidi_substream *output;
};
Linus Torvalds's avatar
Linus Torvalds committed
114

115
struct snd_rawmidi_str {
Linus Torvalds's avatar
Linus Torvalds committed
116 117 118 119 120
	unsigned int substream_count;
	unsigned int substream_opened;
	struct list_head substreams;
};

121 122
struct snd_rawmidi {
	struct snd_card *card;
123
	struct list_head list;
Linus Torvalds's avatar
Linus Torvalds committed
124 125 126 127 128 129 130 131 132
	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

133
	const struct snd_rawmidi_global_ops *ops;
Linus Torvalds's avatar
Linus Torvalds committed
134

135
	struct snd_rawmidi_str streams[2];
Linus Torvalds's avatar
Linus Torvalds committed
136 137

	void *private_data;
138
	void (*private_free) (struct snd_rawmidi *rmidi);
Linus Torvalds's avatar
Linus Torvalds committed
139

140
	struct mutex open_mutex;
Linus Torvalds's avatar
Linus Torvalds committed
141 142
	wait_queue_head_t open_wait;

143 144
	struct device dev;

145
	struct snd_info_entry *proc_entry;
Linus Torvalds's avatar
Linus Torvalds committed
146 147

#if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
148
	struct snd_seq_device *seq_dev;
Linus Torvalds's avatar
Linus Torvalds committed
149 150 151 152 153
#endif
};

/* main rawmidi functions */

154
int snd_rawmidi_new(struct snd_card *card, char *id, int device,
Linus Torvalds's avatar
Linus Torvalds committed
155
		    int output_count, int input_count,
156 157 158
		    struct snd_rawmidi **rmidi);
void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream,
			 struct snd_rawmidi_ops *ops);
Linus Torvalds's avatar
Linus Torvalds committed
159 160 161

/* callbacks */

162 163 164 165 166 167 168 169
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);
170 171 172 173
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);
Linus Torvalds's avatar
Linus Torvalds committed
174 175 176

/* main midi functions */

177
int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info);
178 179
int snd_rawmidi_kernel_open(struct snd_card *card, int device, int subdevice,
			    int mode, struct snd_rawmidi_file *rfile);
180 181 182 183 184 185 186 187 188 189 190 191
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);
Linus Torvalds's avatar
Linus Torvalds committed
192 193

#endif /* __SOUND_RAWMIDI_H */