1 #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@perex.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 <linux/mutex.h>
30 #include <linux/workqueue.h>
31 #include <linux/device.h>
32 
33 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
34 #include <sound/seq_device.h>
35 #endif
36 
37 /*
38  *  Raw MIDI interface
39  */
40 
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)
47 
48 struct snd_rawmidi;
49 struct snd_rawmidi_substream;
50 struct snd_seq_port_info;
51 struct pid;
52 
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 };
59 
60 struct snd_rawmidi_global_ops {
61 	int (*dev_register) (struct snd_rawmidi * rmidi);
62 	int (*dev_unregister) (struct snd_rawmidi * rmidi);
63 	void (*get_port_info)(struct snd_rawmidi *rmidi, int number,
64 			      struct snd_seq_port_info *info);
65 };
66 
67 struct snd_rawmidi_runtime {
68 	struct snd_rawmidi_substream *substream;
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 	int buffer_ref;		/* buffer reference count */
80 	/* misc */
81 	spinlock_t lock;
82 	wait_queue_head_t sleep;
83 	/* event handler (new bytes, input only) */
84 	void (*event)(struct snd_rawmidi_substream *substream);
85 	/* defers calls to event [input] or ops->trigger [output] */
86 	struct work_struct event_work;
87 	/* private data */
88 	void *private_data;
89 	void (*private_free)(struct snd_rawmidi_substream *substream);
90 };
91 
92 struct snd_rawmidi_substream {
93 	struct list_head list;		/* list of all substream for given stream */
94 	int stream;			/* direction */
95 	int number;			/* substream number */
96 	bool opened;			/* open flag */
97 	bool append;			/* append flag (merge more streams) */
98 	bool active_sensing;		/* send active sensing when close */
99 	int use_count;			/* use counter (for output) */
100 	size_t bytes;
101 	struct snd_rawmidi *rmidi;
102 	struct snd_rawmidi_str *pstr;
103 	char name[32];
104 	struct snd_rawmidi_runtime *runtime;
105 	struct pid *pid;
106 	/* hardware layer */
107 	const struct snd_rawmidi_ops *ops;
108 };
109 
110 struct snd_rawmidi_file {
111 	struct snd_rawmidi *rmidi;
112 	struct snd_rawmidi_substream *input;
113 	struct snd_rawmidi_substream *output;
114 };
115 
116 struct snd_rawmidi_str {
117 	unsigned int substream_count;
118 	unsigned int substream_opened;
119 	struct list_head substreams;
120 };
121 
122 struct snd_rawmidi {
123 	struct snd_card *card;
124 	struct list_head list;
125 	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 
134 	const struct snd_rawmidi_global_ops *ops;
135 
136 	struct snd_rawmidi_str streams[2];
137 
138 	void *private_data;
139 	void (*private_free) (struct snd_rawmidi *rmidi);
140 
141 	struct mutex open_mutex;
142 	wait_queue_head_t open_wait;
143 
144 	struct device dev;
145 
146 	struct snd_info_entry *proc_entry;
147 
148 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
149 	struct snd_seq_device *seq_dev;
150 #endif
151 };
152 
153 /* main rawmidi functions */
154 
155 int snd_rawmidi_new(struct snd_card *card, char *id, int device,
156 		    int output_count, int input_count,
157 		    struct snd_rawmidi **rmidi);
158 void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream,
159 			 const struct snd_rawmidi_ops *ops);
160 
161 /* callbacks */
162 
163 int snd_rawmidi_receive(struct snd_rawmidi_substream *substream,
164 			const unsigned char *buffer, int count);
165 int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream);
166 int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
167 			      unsigned char *buffer, int count);
168 int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count);
169 int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream,
170 			 unsigned char *buffer, int count);
171 int __snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
172 			      unsigned char *buffer, int count);
173 int __snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream,
174 			       int count);
175 
176 /* main midi functions */
177 
178 int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info);
179 int snd_rawmidi_kernel_open(struct snd_card *card, int device, int subdevice,
180 			    int mode, struct snd_rawmidi_file *rfile);
181 int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile);
182 int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream,
183 			      struct snd_rawmidi_params *params);
184 int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream,
185 			     struct snd_rawmidi_params *params);
186 int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream);
187 int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream);
188 int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream);
189 long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream,
190 			     unsigned char *buf, long count);
191 long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream,
192 			      const unsigned char *buf, long count);
193 
194 #endif /* __SOUND_RAWMIDI_H */
195