blob: 9492a32c10266e94062a705744b06e345a95c855 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __SOUND_RAWMIDI_H
2#define __SOUND_RAWMIDI_H
3
4/*
5 * Abstract layer for MIDI v1.0 stream
6 * Copyright (c) by Jaroslav Kysela <perex@suse.cz>
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>
29#include <asm/semaphore.h>
30
31#if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
32#include "seq_device.h"
33#endif
34
35/*
36 * Raw MIDI interface
37 */
38
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#define SNDRV_RAWMIDI_DEVICES 8
40
41#define SNDRV_RAWMIDI_LFLG_OUTPUT (1<<0)
42#define SNDRV_RAWMIDI_LFLG_INPUT (1<<1)
43#define SNDRV_RAWMIDI_LFLG_OPEN (3<<0)
44#define SNDRV_RAWMIDI_LFLG_APPEND (1<<2)
45#define SNDRV_RAWMIDI_LFLG_NOOPENLOCK (1<<3)
46
Takashi Iwai48c9d412005-11-17 13:56:51 +010047struct snd_rawmidi;
48struct snd_rawmidi_substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Takashi Iwai48c9d412005-11-17 13:56:51 +010050struct snd_rawmidi_ops {
51 int (*open) (struct snd_rawmidi_substream * substream);
52 int (*close) (struct snd_rawmidi_substream * substream);
53 void (*trigger) (struct snd_rawmidi_substream * substream, int up);
54 void (*drain) (struct snd_rawmidi_substream * substream);
55};
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Takashi Iwai48c9d412005-11-17 13:56:51 +010057struct snd_rawmidi_global_ops {
58 int (*dev_register) (struct snd_rawmidi * rmidi);
59 int (*dev_unregister) (struct snd_rawmidi * rmidi);
60};
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Takashi Iwai48c9d412005-11-17 13:56:51 +010062struct snd_rawmidi_runtime {
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 unsigned int drain: 1, /* drain stage */
64 oss: 1; /* OSS compatible mode */
65 /* midi stream buffer */
66 unsigned char *buffer; /* buffer for MIDI data */
67 size_t buffer_size; /* size of buffer */
68 size_t appl_ptr; /* application pointer */
69 size_t hw_ptr; /* hardware pointer */
70 size_t avail_min; /* min avail for wakeup */
71 size_t avail; /* max used buffer for wakeup */
72 size_t xruns; /* over/underruns counter */
73 /* misc */
74 spinlock_t lock;
75 wait_queue_head_t sleep;
76 /* event handler (new bytes, input only) */
Takashi Iwai48c9d412005-11-17 13:56:51 +010077 void (*event)(struct snd_rawmidi_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 /* defers calls to event [input] or ops->trigger [output] */
79 struct tasklet_struct tasklet;
80 /* private data */
81 void *private_data;
Takashi Iwai48c9d412005-11-17 13:56:51 +010082 void (*private_free)(struct snd_rawmidi_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -070083};
84
Takashi Iwai48c9d412005-11-17 13:56:51 +010085struct snd_rawmidi_substream {
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 struct list_head list; /* list of all substream for given stream */
87 int stream; /* direction */
88 int number; /* substream number */
89 unsigned int opened: 1, /* open flag */
90 append: 1, /* append flag (merge more streams) */
91 active_sensing: 1; /* send active sensing when close */
92 int use_count; /* use counter (for output) */
93 size_t bytes;
Takashi Iwai48c9d412005-11-17 13:56:51 +010094 struct snd_rawmidi *rmidi;
95 struct snd_rawmidi_str *pstr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 char name[32];
Takashi Iwai48c9d412005-11-17 13:56:51 +010097 struct snd_rawmidi_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 /* hardware layer */
Takashi Iwai48c9d412005-11-17 13:56:51 +010099 struct snd_rawmidi_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100};
101
Takashi Iwai48c9d412005-11-17 13:56:51 +0100102struct snd_rawmidi_file {
103 struct snd_rawmidi *rmidi;
104 struct snd_rawmidi_substream *input;
105 struct snd_rawmidi_substream *output;
106};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
Takashi Iwai48c9d412005-11-17 13:56:51 +0100108struct snd_rawmidi_str {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 unsigned int substream_count;
110 unsigned int substream_opened;
111 struct list_head substreams;
112};
113
Takashi Iwai48c9d412005-11-17 13:56:51 +0100114struct snd_rawmidi {
115 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
117 unsigned int device; /* device number */
118 unsigned int info_flags; /* SNDRV_RAWMIDI_INFO_XXXX */
119 char id[64];
120 char name[80];
121
122#ifdef CONFIG_SND_OSSEMUL
123 int ossreg;
124#endif
125
Takashi Iwai48c9d412005-11-17 13:56:51 +0100126 struct snd_rawmidi_global_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Takashi Iwai48c9d412005-11-17 13:56:51 +0100128 struct snd_rawmidi_str streams[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
130 void *private_data;
Takashi Iwai48c9d412005-11-17 13:56:51 +0100131 void (*private_free) (struct snd_rawmidi *rmidi);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133 struct semaphore open_mutex;
134 wait_queue_head_t open_wait;
135
Takashi Iwai48c9d412005-11-17 13:56:51 +0100136 struct snd_info_entry *dev;
137 struct snd_info_entry *proc_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139#if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
Takashi Iwai48c9d412005-11-17 13:56:51 +0100140 struct snd_seq_device *seq_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141#endif
142};
143
144/* main rawmidi functions */
145
Takashi Iwai48c9d412005-11-17 13:56:51 +0100146int snd_rawmidi_new(struct snd_card *card, char *id, int device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 int output_count, int input_count,
Takashi Iwai48c9d412005-11-17 13:56:51 +0100148 struct snd_rawmidi **rmidi);
149void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream,
150 struct snd_rawmidi_ops *ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
152/* callbacks */
153
Takashi Iwai48c9d412005-11-17 13:56:51 +0100154void snd_rawmidi_receive_reset(struct snd_rawmidi_substream *substream);
155int snd_rawmidi_receive(struct snd_rawmidi_substream *substream,
156 const unsigned char *buffer, int count);
157void snd_rawmidi_transmit_reset(struct snd_rawmidi_substream *substream);
158int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream);
159int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
160 unsigned char *buffer, int count);
161int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count);
162int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream,
163 unsigned char *buffer, int count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
165/* main midi functions */
166
Takashi Iwai48c9d412005-11-17 13:56:51 +0100167int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info);
168int snd_rawmidi_kernel_open(int cardnum, int device, int subdevice, int mode,
169 struct snd_rawmidi_file *rfile);
170int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile);
171int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream,
172 struct snd_rawmidi_params *params);
173int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream,
174 struct snd_rawmidi_params *params);
175int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream);
176int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream);
177int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream);
178long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream,
179 unsigned char *buf, long count);
180long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream,
181 const unsigned char *buf, long count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183#endif /* __SOUND_RAWMIDI_H */