blob: 1bf6f0fc92d1908844d5ef0f39d6534c7c60fde4 [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
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02006 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
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>
Ingo Molnar1a60d4c2006-01-16 16:29:08 +010029#include <linux/mutex.h>
Takashi Iwaib3c705a2011-06-14 14:37:06 +020030#include <linux/workqueue.h>
Takashi Iwaiaee50122015-01-29 17:55:52 +010031#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
33#if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
David Howellsa1ce3922012-10-02 18:01:25 +010034#include <sound/seq_device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#endif
36
37/*
38 * Raw MIDI interface
39 */
40
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Takashi Iwai48c9d412005-11-17 13:56:51 +010048struct snd_rawmidi;
49struct snd_rawmidi_substream;
Clemens Ladischa7b928a2006-05-02 16:22:12 +020050struct snd_seq_port_info;
Clemens Ladisch7584af12009-11-10 10:14:04 +010051struct pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Takashi Iwai48c9d412005-11-17 13:56:51 +010053struct 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};
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Takashi Iwai48c9d412005-11-17 13:56:51 +010060struct snd_rawmidi_global_ops {
61 int (*dev_register) (struct snd_rawmidi * rmidi);
62 int (*dev_unregister) (struct snd_rawmidi * rmidi);
Clemens Ladischa7b928a2006-05-02 16:22:12 +020063 void (*get_port_info)(struct snd_rawmidi *rmidi, int number,
64 struct snd_seq_port_info *info);
Takashi Iwai48c9d412005-11-17 13:56:51 +010065};
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Takashi Iwai48c9d412005-11-17 13:56:51 +010067struct snd_rawmidi_runtime {
Takashi Iwaib3c705a2011-06-14 14:37:06 +020068 struct snd_rawmidi_substream *substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 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;
Daniel Rosenberge57f7812017-10-31 16:55:26 -070081 struct mutex realloc_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 wait_queue_head_t sleep;
83 /* event handler (new bytes, input only) */
Takashi Iwai48c9d412005-11-17 13:56:51 +010084 void (*event)(struct snd_rawmidi_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 /* defers calls to event [input] or ops->trigger [output] */
Takashi Iwaib3c705a2011-06-14 14:37:06 +020086 struct work_struct event_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 /* private data */
88 void *private_data;
Takashi Iwai48c9d412005-11-17 13:56:51 +010089 void (*private_free)(struct snd_rawmidi_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090};
91
Takashi Iwai48c9d412005-11-17 13:56:51 +010092struct snd_rawmidi_substream {
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 struct list_head list; /* list of all substream for given stream */
94 int stream; /* direction */
95 int number; /* substream number */
Takashi Iwai0aa6ce52020-02-14 12:13:16 +010096 bool opened; /* open flag */
97 bool append; /* append flag (merge more streams) */
98 bool active_sensing; /* send active sensing when close */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 int use_count; /* use counter (for output) */
100 size_t bytes;
Takashi Iwai48c9d412005-11-17 13:56:51 +0100101 struct snd_rawmidi *rmidi;
102 struct snd_rawmidi_str *pstr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 char name[32];
Takashi Iwai48c9d412005-11-17 13:56:51 +0100104 struct snd_rawmidi_runtime *runtime;
Clemens Ladisch7584af12009-11-10 10:14:04 +0100105 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 /* hardware layer */
Takashi Iwai48c9d412005-11-17 13:56:51 +0100107 struct snd_rawmidi_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108};
109
Takashi Iwai48c9d412005-11-17 13:56:51 +0100110struct snd_rawmidi_file {
111 struct snd_rawmidi *rmidi;
112 struct snd_rawmidi_substream *input;
113 struct snd_rawmidi_substream *output;
114};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
Takashi Iwai48c9d412005-11-17 13:56:51 +0100116struct snd_rawmidi_str {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 unsigned int substream_count;
118 unsigned int substream_opened;
119 struct list_head substreams;
120};
121
Takashi Iwai48c9d412005-11-17 13:56:51 +0100122struct snd_rawmidi {
123 struct snd_card *card;
Clemens Ladischf87135f2005-11-20 14:06:59 +0100124 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 unsigned int device; /* device number */
126 unsigned int info_flags; /* SNDRV_RAWMIDI_INFO_XXXX */
127 char id[64];
128 char name[80];
129
130#ifdef CONFIG_SND_OSSEMUL
131 int ossreg;
132#endif
133
Julia Lawallefdbe3c2015-11-22 08:55:07 +0100134 const struct snd_rawmidi_global_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
Takashi Iwai48c9d412005-11-17 13:56:51 +0100136 struct snd_rawmidi_str streams[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138 void *private_data;
Takashi Iwai48c9d412005-11-17 13:56:51 +0100139 void (*private_free) (struct snd_rawmidi *rmidi);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100141 struct mutex open_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 wait_queue_head_t open_wait;
143
Takashi Iwaiaee50122015-01-29 17:55:52 +0100144 struct device dev;
145
Takashi Iwai48c9d412005-11-17 13:56:51 +0100146 struct snd_info_entry *proc_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
148#if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
Takashi Iwai48c9d412005-11-17 13:56:51 +0100149 struct snd_seq_device *seq_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150#endif
151};
152
153/* main rawmidi functions */
154
Takashi Iwai48c9d412005-11-17 13:56:51 +0100155int snd_rawmidi_new(struct snd_card *card, char *id, int device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 int output_count, int input_count,
Takashi Iwai48c9d412005-11-17 13:56:51 +0100157 struct snd_rawmidi **rmidi);
158void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream,
159 struct snd_rawmidi_ops *ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
161/* callbacks */
162
Takashi Iwai48c9d412005-11-17 13:56:51 +0100163int snd_rawmidi_receive(struct snd_rawmidi_substream *substream,
164 const unsigned char *buffer, int count);
Takashi Iwai48c9d412005-11-17 13:56:51 +0100165int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream);
166int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
167 unsigned char *buffer, int count);
168int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count);
169int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream,
170 unsigned char *buffer, int count);
Takashi Iwai06ab3002016-01-31 11:57:41 +0100171int __snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
172 unsigned char *buffer, int count);
173int __snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream,
174 int count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
176/* main midi functions */
177
Takashi Iwai48c9d412005-11-17 13:56:51 +0100178int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100179int snd_rawmidi_kernel_open(struct snd_card *card, int device, int subdevice,
180 int mode, struct snd_rawmidi_file *rfile);
Takashi Iwai48c9d412005-11-17 13:56:51 +0100181int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile);
182int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream,
183 struct snd_rawmidi_params *params);
184int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream,
185 struct snd_rawmidi_params *params);
186int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream);
187int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream);
188int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream);
189long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream,
190 unsigned char *buf, long count);
191long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream,
192 const unsigned char *buf, long count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194#endif /* __SOUND_RAWMIDI_H */