1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * Abstract layer for MIDI v1.0 stream
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
5 */
6
7 #include <sound/core.h>
8 #include <linux/major.h>
9 #include <linux/init.h>
10 #include <linux/sched/signal.h>
11 #include <linux/slab.h>
12 #include <linux/time.h>
13 #include <linux/wait.h>
14 #include <linux/mutex.h>
15 #include <linux/module.h>
16 #include <linux/delay.h>
17 #include <linux/mm.h>
18 #include <linux/nospec.h>
19 #include <sound/rawmidi.h>
20 #include <sound/info.h>
21 #include <sound/control.h>
22 #include <sound/minors.h>
23 #include <sound/initval.h>
24 #include <sound/ump.h>
25
26 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
27 MODULE_DESCRIPTION("Midlevel RawMidi code for ALSA.");
28 MODULE_LICENSE("GPL");
29
30 #ifdef CONFIG_SND_OSSEMUL
31 static int midi_map[SNDRV_CARDS];
32 static int amidi_map[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS-1)] = 1};
33 module_param_array(midi_map, int, NULL, 0444);
34 MODULE_PARM_DESC(midi_map, "Raw MIDI device number assigned to 1st OSS device.");
35 module_param_array(amidi_map, int, NULL, 0444);
36 MODULE_PARM_DESC(amidi_map, "Raw MIDI device number assigned to 2nd OSS device.");
37 #endif /* CONFIG_SND_OSSEMUL */
38
39 static int snd_rawmidi_dev_free(struct snd_device *device);
40 static int snd_rawmidi_dev_register(struct snd_device *device);
41 static int snd_rawmidi_dev_disconnect(struct snd_device *device);
42
43 static LIST_HEAD(snd_rawmidi_devices);
44 static DEFINE_MUTEX(register_mutex);
45
46 #define rmidi_err(rmidi, fmt, args...) \
47 dev_err((rmidi)->dev, fmt, ##args)
48 #define rmidi_warn(rmidi, fmt, args...) \
49 dev_warn((rmidi)->dev, fmt, ##args)
50 #define rmidi_dbg(rmidi, fmt, args...) \
51 dev_dbg((rmidi)->dev, fmt, ##args)
52
53 struct snd_rawmidi_status32 {
54 s32 stream;
55 s32 tstamp_sec; /* Timestamp */
56 s32 tstamp_nsec;
57 u32 avail; /* available bytes */
58 u32 xruns; /* count of overruns since last status (in bytes) */
59 unsigned char reserved[16]; /* reserved for future use */
60 };
61
62 #define SNDRV_RAWMIDI_IOCTL_STATUS32 _IOWR('W', 0x20, struct snd_rawmidi_status32)
63
64 struct snd_rawmidi_status64 {
65 int stream;
66 u8 rsvd[4]; /* alignment */
67 s64 tstamp_sec; /* Timestamp */
68 s64 tstamp_nsec;
69 size_t avail; /* available bytes */
70 size_t xruns; /* count of overruns since last status (in bytes) */
71 unsigned char reserved[16]; /* reserved for future use */
72 };
73
74 #define SNDRV_RAWMIDI_IOCTL_STATUS64 _IOWR('W', 0x20, struct snd_rawmidi_status64)
75
76 #define rawmidi_is_ump(rmidi) \
77 (IS_ENABLED(CONFIG_SND_UMP) && ((rmidi)->info_flags & SNDRV_RAWMIDI_INFO_UMP))
78
snd_rawmidi_search(struct snd_card * card,int device)79 static struct snd_rawmidi *snd_rawmidi_search(struct snd_card *card, int device)
80 {
81 struct snd_rawmidi *rawmidi;
82
83 list_for_each_entry(rawmidi, &snd_rawmidi_devices, list)
84 if (rawmidi->card == card && rawmidi->device == device)
85 return rawmidi;
86 return NULL;
87 }
88
snd_rawmidi_file_flags(struct file * file)89 static inline unsigned short snd_rawmidi_file_flags(struct file *file)
90 {
91 switch (file->f_mode & (FMODE_READ | FMODE_WRITE)) {
92 case FMODE_WRITE:
93 return SNDRV_RAWMIDI_LFLG_OUTPUT;
94 case FMODE_READ:
95 return SNDRV_RAWMIDI_LFLG_INPUT;
96 default:
97 return SNDRV_RAWMIDI_LFLG_OPEN;
98 }
99 }
100
__snd_rawmidi_ready(struct snd_rawmidi_runtime * runtime)101 static inline bool __snd_rawmidi_ready(struct snd_rawmidi_runtime *runtime)
102 {
103 return runtime->avail >= runtime->avail_min;
104 }
105
snd_rawmidi_ready(struct snd_rawmidi_substream * substream)106 static bool snd_rawmidi_ready(struct snd_rawmidi_substream *substream)
107 {
108 guard(spinlock_irqsave)(&substream->lock);
109 return __snd_rawmidi_ready(substream->runtime);
110 }
111
snd_rawmidi_ready_append(struct snd_rawmidi_substream * substream,size_t count)112 static inline int snd_rawmidi_ready_append(struct snd_rawmidi_substream *substream,
113 size_t count)
114 {
115 struct snd_rawmidi_runtime *runtime = substream->runtime;
116
117 return runtime->avail >= runtime->avail_min &&
118 (!substream->append || runtime->avail >= count);
119 }
120
snd_rawmidi_input_event_work(struct work_struct * work)121 static void snd_rawmidi_input_event_work(struct work_struct *work)
122 {
123 struct snd_rawmidi_runtime *runtime =
124 container_of(work, struct snd_rawmidi_runtime, event_work);
125
126 if (runtime->event)
127 runtime->event(runtime->substream);
128 }
129
130 /* buffer refcount management: call with substream->lock held */
snd_rawmidi_buffer_ref(struct snd_rawmidi_runtime * runtime)131 static inline void snd_rawmidi_buffer_ref(struct snd_rawmidi_runtime *runtime)
132 {
133 runtime->buffer_ref++;
134 }
135
snd_rawmidi_buffer_unref(struct snd_rawmidi_runtime * runtime)136 static inline void snd_rawmidi_buffer_unref(struct snd_rawmidi_runtime *runtime)
137 {
138 runtime->buffer_ref--;
139 }
140
snd_rawmidi_buffer_ref_sync(struct snd_rawmidi_substream * substream)141 static void snd_rawmidi_buffer_ref_sync(struct snd_rawmidi_substream *substream)
142 {
143 int loop = HZ;
144
145 spin_lock_irq(&substream->lock);
146 while (substream->runtime->buffer_ref) {
147 spin_unlock_irq(&substream->lock);
148 if (!--loop) {
149 rmidi_err(substream->rmidi, "Buffer ref sync timeout\n");
150 return;
151 }
152 schedule_timeout_uninterruptible(1);
153 spin_lock_irq(&substream->lock);
154 }
155 spin_unlock_irq(&substream->lock);
156 }
157
snd_rawmidi_runtime_create(struct snd_rawmidi_substream * substream)158 static int snd_rawmidi_runtime_create(struct snd_rawmidi_substream *substream)
159 {
160 struct snd_rawmidi_runtime *runtime;
161
162 runtime = kzalloc(sizeof(*runtime), GFP_KERNEL);
163 if (!runtime)
164 return -ENOMEM;
165 runtime->substream = substream;
166 init_waitqueue_head(&runtime->sleep);
167 INIT_WORK(&runtime->event_work, snd_rawmidi_input_event_work);
168 runtime->event = NULL;
169 runtime->buffer_size = PAGE_SIZE;
170 runtime->avail_min = 1;
171 if (substream->stream == SNDRV_RAWMIDI_STREAM_INPUT)
172 runtime->avail = 0;
173 else
174 runtime->avail = runtime->buffer_size;
175 runtime->buffer = kvzalloc(runtime->buffer_size, GFP_KERNEL);
176 if (!runtime->buffer) {
177 kfree(runtime);
178 return -ENOMEM;
179 }
180 runtime->appl_ptr = runtime->hw_ptr = 0;
181 substream->runtime = runtime;
182 if (rawmidi_is_ump(substream->rmidi))
183 runtime->align = 3;
184 return 0;
185 }
186
187 /* get the current alignment (either 0 or 3) */
get_align(struct snd_rawmidi_runtime * runtime)188 static inline int get_align(struct snd_rawmidi_runtime *runtime)
189 {
190 if (IS_ENABLED(CONFIG_SND_UMP))
191 return runtime->align;
192 else
193 return 0;
194 }
195
196 /* get the trimmed size with the current alignment */
197 #define get_aligned_size(runtime, size) ((size) & ~get_align(runtime))
198
snd_rawmidi_runtime_free(struct snd_rawmidi_substream * substream)199 static int snd_rawmidi_runtime_free(struct snd_rawmidi_substream *substream)
200 {
201 struct snd_rawmidi_runtime *runtime = substream->runtime;
202
203 kvfree(runtime->buffer);
204 kfree(runtime);
205 substream->runtime = NULL;
206 return 0;
207 }
208
snd_rawmidi_output_trigger(struct snd_rawmidi_substream * substream,int up)209 static inline void snd_rawmidi_output_trigger(struct snd_rawmidi_substream *substream, int up)
210 {
211 if (!substream->opened)
212 return;
213 substream->ops->trigger(substream, up);
214 }
215
snd_rawmidi_input_trigger(struct snd_rawmidi_substream * substream,int up)216 static void snd_rawmidi_input_trigger(struct snd_rawmidi_substream *substream, int up)
217 {
218 if (!substream->opened)
219 return;
220 substream->ops->trigger(substream, up);
221 if (!up)
222 cancel_work_sync(&substream->runtime->event_work);
223 }
224
__reset_runtime_ptrs(struct snd_rawmidi_runtime * runtime,bool is_input)225 static void __reset_runtime_ptrs(struct snd_rawmidi_runtime *runtime,
226 bool is_input)
227 {
228 runtime->drain = 0;
229 runtime->appl_ptr = runtime->hw_ptr = 0;
230 runtime->avail = is_input ? 0 : runtime->buffer_size;
231 }
232
reset_runtime_ptrs(struct snd_rawmidi_substream * substream,bool is_input)233 static void reset_runtime_ptrs(struct snd_rawmidi_substream *substream,
234 bool is_input)
235 {
236 guard(spinlock_irqsave)(&substream->lock);
237 if (substream->opened && substream->runtime)
238 __reset_runtime_ptrs(substream->runtime, is_input);
239 }
240
snd_rawmidi_drop_output(struct snd_rawmidi_substream * substream)241 int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream)
242 {
243 snd_rawmidi_output_trigger(substream, 0);
244 reset_runtime_ptrs(substream, false);
245 return 0;
246 }
247 EXPORT_SYMBOL(snd_rawmidi_drop_output);
248
snd_rawmidi_drain_output(struct snd_rawmidi_substream * substream)249 int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream)
250 {
251 int err = 0;
252 long timeout;
253 struct snd_rawmidi_runtime *runtime;
254
255 scoped_guard(spinlock_irq, &substream->lock) {
256 runtime = substream->runtime;
257 if (!substream->opened || !runtime || !runtime->buffer)
258 return -EINVAL;
259 snd_rawmidi_buffer_ref(runtime);
260 runtime->drain = 1;
261 }
262
263 timeout = wait_event_interruptible_timeout(runtime->sleep,
264 (runtime->avail >= runtime->buffer_size),
265 10*HZ);
266
267 scoped_guard(spinlock_irq, &substream->lock) {
268 if (signal_pending(current))
269 err = -ERESTARTSYS;
270 if (runtime->avail < runtime->buffer_size && !timeout) {
271 rmidi_warn(substream->rmidi,
272 "rawmidi drain error (avail = %li, buffer_size = %li)\n",
273 (long)runtime->avail, (long)runtime->buffer_size);
274 err = -EIO;
275 }
276 runtime->drain = 0;
277 }
278
279 if (err != -ERESTARTSYS) {
280 /* we need wait a while to make sure that Tx FIFOs are empty */
281 if (substream->ops->drain)
282 substream->ops->drain(substream);
283 else
284 msleep(50);
285 snd_rawmidi_drop_output(substream);
286 }
287
288 scoped_guard(spinlock_irq, &substream->lock)
289 snd_rawmidi_buffer_unref(runtime);
290
291 return err;
292 }
293 EXPORT_SYMBOL(snd_rawmidi_drain_output);
294
snd_rawmidi_drain_input(struct snd_rawmidi_substream * substream)295 int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream)
296 {
297 snd_rawmidi_input_trigger(substream, 0);
298 reset_runtime_ptrs(substream, true);
299 return 0;
300 }
301 EXPORT_SYMBOL(snd_rawmidi_drain_input);
302
303 /* look for an available substream for the given stream direction;
304 * if a specific subdevice is given, try to assign it
305 */
assign_substream(struct snd_rawmidi * rmidi,int subdevice,int stream,int mode,struct snd_rawmidi_substream ** sub_ret)306 static int assign_substream(struct snd_rawmidi *rmidi, int subdevice,
307 int stream, int mode,
308 struct snd_rawmidi_substream **sub_ret)
309 {
310 struct snd_rawmidi_substream *substream;
311 struct snd_rawmidi_str *s = &rmidi->streams[stream];
312 static const unsigned int info_flags[2] = {
313 [SNDRV_RAWMIDI_STREAM_OUTPUT] = SNDRV_RAWMIDI_INFO_OUTPUT,
314 [SNDRV_RAWMIDI_STREAM_INPUT] = SNDRV_RAWMIDI_INFO_INPUT,
315 };
316
317 if (!(rmidi->info_flags & info_flags[stream]))
318 return -ENXIO;
319 if (subdevice >= 0 && subdevice >= s->substream_count)
320 return -ENODEV;
321
322 list_for_each_entry(substream, &s->substreams, list) {
323 if (substream->opened) {
324 if (stream == SNDRV_RAWMIDI_STREAM_INPUT ||
325 !(mode & SNDRV_RAWMIDI_LFLG_APPEND) ||
326 !substream->append)
327 continue;
328 }
329 if (subdevice < 0 || subdevice == substream->number) {
330 *sub_ret = substream;
331 return 0;
332 }
333 }
334 return -EAGAIN;
335 }
336
337 /* open and do ref-counting for the given substream */
open_substream(struct snd_rawmidi * rmidi,struct snd_rawmidi_substream * substream,int mode)338 static int open_substream(struct snd_rawmidi *rmidi,
339 struct snd_rawmidi_substream *substream,
340 int mode)
341 {
342 int err;
343
344 if (substream->use_count == 0) {
345 err = snd_rawmidi_runtime_create(substream);
346 if (err < 0)
347 return err;
348 err = substream->ops->open(substream);
349 if (err < 0) {
350 snd_rawmidi_runtime_free(substream);
351 return err;
352 }
353 guard(spinlock_irq)(&substream->lock);
354 substream->opened = 1;
355 substream->active_sensing = 0;
356 if (mode & SNDRV_RAWMIDI_LFLG_APPEND)
357 substream->append = 1;
358 substream->pid = get_pid(task_pid(current));
359 rmidi->streams[substream->stream].substream_opened++;
360 }
361 substream->use_count++;
362 return 0;
363 }
364
365 static void close_substream(struct snd_rawmidi *rmidi,
366 struct snd_rawmidi_substream *substream,
367 int cleanup);
368
rawmidi_open_priv(struct snd_rawmidi * rmidi,int subdevice,int mode,struct snd_rawmidi_file * rfile)369 static int rawmidi_open_priv(struct snd_rawmidi *rmidi, int subdevice, int mode,
370 struct snd_rawmidi_file *rfile)
371 {
372 struct snd_rawmidi_substream *sinput = NULL, *soutput = NULL;
373 int err;
374
375 rfile->input = rfile->output = NULL;
376 if (mode & SNDRV_RAWMIDI_LFLG_INPUT) {
377 err = assign_substream(rmidi, subdevice,
378 SNDRV_RAWMIDI_STREAM_INPUT,
379 mode, &sinput);
380 if (err < 0)
381 return err;
382 }
383 if (mode & SNDRV_RAWMIDI_LFLG_OUTPUT) {
384 err = assign_substream(rmidi, subdevice,
385 SNDRV_RAWMIDI_STREAM_OUTPUT,
386 mode, &soutput);
387 if (err < 0)
388 return err;
389 }
390
391 if (sinput) {
392 err = open_substream(rmidi, sinput, mode);
393 if (err < 0)
394 return err;
395 }
396 if (soutput) {
397 err = open_substream(rmidi, soutput, mode);
398 if (err < 0) {
399 if (sinput)
400 close_substream(rmidi, sinput, 0);
401 return err;
402 }
403 }
404
405 rfile->rmidi = rmidi;
406 rfile->input = sinput;
407 rfile->output = soutput;
408 return 0;
409 }
410
411 /* called from sound/core/seq/seq_midi.c */
snd_rawmidi_kernel_open(struct snd_rawmidi * rmidi,int subdevice,int mode,struct snd_rawmidi_file * rfile)412 int snd_rawmidi_kernel_open(struct snd_rawmidi *rmidi, int subdevice,
413 int mode, struct snd_rawmidi_file *rfile)
414 {
415 int err;
416
417 if (snd_BUG_ON(!rfile))
418 return -EINVAL;
419 if (!try_module_get(rmidi->card->module))
420 return -ENXIO;
421
422 guard(mutex)(&rmidi->open_mutex);
423 err = rawmidi_open_priv(rmidi, subdevice, mode, rfile);
424 if (err < 0)
425 module_put(rmidi->card->module);
426 return err;
427 }
428 EXPORT_SYMBOL(snd_rawmidi_kernel_open);
429
snd_rawmidi_open(struct inode * inode,struct file * file)430 static int snd_rawmidi_open(struct inode *inode, struct file *file)
431 {
432 int maj = imajor(inode);
433 struct snd_card *card;
434 int subdevice;
435 unsigned short fflags;
436 int err;
437 struct snd_rawmidi *rmidi;
438 struct snd_rawmidi_file *rawmidi_file = NULL;
439 wait_queue_entry_t wait;
440
441 if ((file->f_flags & O_APPEND) && !(file->f_flags & O_NONBLOCK))
442 return -EINVAL; /* invalid combination */
443
444 err = stream_open(inode, file);
445 if (err < 0)
446 return err;
447
448 if (maj == snd_major) {
449 rmidi = snd_lookup_minor_data(iminor(inode),
450 SNDRV_DEVICE_TYPE_RAWMIDI);
451 #ifdef CONFIG_SND_OSSEMUL
452 } else if (maj == SOUND_MAJOR) {
453 rmidi = snd_lookup_oss_minor_data(iminor(inode),
454 SNDRV_OSS_DEVICE_TYPE_MIDI);
455 #endif
456 } else
457 return -ENXIO;
458
459 if (rmidi == NULL)
460 return -ENODEV;
461
462 if (!try_module_get(rmidi->card->module)) {
463 snd_card_unref(rmidi->card);
464 return -ENXIO;
465 }
466
467 mutex_lock(&rmidi->open_mutex);
468 card = rmidi->card;
469 err = snd_card_file_add(card, file);
470 if (err < 0)
471 goto __error_card;
472 fflags = snd_rawmidi_file_flags(file);
473 if ((file->f_flags & O_APPEND) || maj == SOUND_MAJOR) /* OSS emul? */
474 fflags |= SNDRV_RAWMIDI_LFLG_APPEND;
475 rawmidi_file = kmalloc(sizeof(*rawmidi_file), GFP_KERNEL);
476 if (rawmidi_file == NULL) {
477 err = -ENOMEM;
478 goto __error;
479 }
480 rawmidi_file->user_pversion = 0;
481 init_waitqueue_entry(&wait, current);
482 add_wait_queue(&rmidi->open_wait, &wait);
483 while (1) {
484 subdevice = snd_ctl_get_preferred_subdevice(card, SND_CTL_SUBDEV_RAWMIDI);
485 err = rawmidi_open_priv(rmidi, subdevice, fflags, rawmidi_file);
486 if (err >= 0)
487 break;
488 if (err == -EAGAIN) {
489 if (file->f_flags & O_NONBLOCK) {
490 err = -EBUSY;
491 break;
492 }
493 } else
494 break;
495 set_current_state(TASK_INTERRUPTIBLE);
496 mutex_unlock(&rmidi->open_mutex);
497 schedule();
498 mutex_lock(&rmidi->open_mutex);
499 if (rmidi->card->shutdown) {
500 err = -ENODEV;
501 break;
502 }
503 if (signal_pending(current)) {
504 err = -ERESTARTSYS;
505 break;
506 }
507 }
508 remove_wait_queue(&rmidi->open_wait, &wait);
509 if (err < 0) {
510 kfree(rawmidi_file);
511 goto __error;
512 }
513 #ifdef CONFIG_SND_OSSEMUL
514 if (rawmidi_file->input && rawmidi_file->input->runtime)
515 rawmidi_file->input->runtime->oss = (maj == SOUND_MAJOR);
516 if (rawmidi_file->output && rawmidi_file->output->runtime)
517 rawmidi_file->output->runtime->oss = (maj == SOUND_MAJOR);
518 #endif
519 file->private_data = rawmidi_file;
520 mutex_unlock(&rmidi->open_mutex);
521 snd_card_unref(rmidi->card);
522 return 0;
523
524 __error:
525 snd_card_file_remove(card, file);
526 __error_card:
527 mutex_unlock(&rmidi->open_mutex);
528 module_put(rmidi->card->module);
529 snd_card_unref(rmidi->card);
530 return err;
531 }
532
close_substream(struct snd_rawmidi * rmidi,struct snd_rawmidi_substream * substream,int cleanup)533 static void close_substream(struct snd_rawmidi *rmidi,
534 struct snd_rawmidi_substream *substream,
535 int cleanup)
536 {
537 if (--substream->use_count)
538 return;
539
540 if (cleanup) {
541 if (substream->stream == SNDRV_RAWMIDI_STREAM_INPUT)
542 snd_rawmidi_input_trigger(substream, 0);
543 else {
544 if (substream->active_sensing) {
545 unsigned char buf = 0xfe;
546 /* sending single active sensing message
547 * to shut the device up
548 */
549 snd_rawmidi_kernel_write(substream, &buf, 1);
550 }
551 if (snd_rawmidi_drain_output(substream) == -ERESTARTSYS)
552 snd_rawmidi_output_trigger(substream, 0);
553 }
554 snd_rawmidi_buffer_ref_sync(substream);
555 }
556 scoped_guard(spinlock_irq, &substream->lock) {
557 substream->opened = 0;
558 substream->append = 0;
559 }
560 substream->ops->close(substream);
561 if (substream->runtime->private_free)
562 substream->runtime->private_free(substream);
563 snd_rawmidi_runtime_free(substream);
564 put_pid(substream->pid);
565 substream->pid = NULL;
566 rmidi->streams[substream->stream].substream_opened--;
567 }
568
rawmidi_release_priv(struct snd_rawmidi_file * rfile)569 static void rawmidi_release_priv(struct snd_rawmidi_file *rfile)
570 {
571 struct snd_rawmidi *rmidi;
572
573 rmidi = rfile->rmidi;
574 guard(mutex)(&rmidi->open_mutex);
575 if (rfile->input) {
576 close_substream(rmidi, rfile->input, 1);
577 rfile->input = NULL;
578 }
579 if (rfile->output) {
580 close_substream(rmidi, rfile->output, 1);
581 rfile->output = NULL;
582 }
583 rfile->rmidi = NULL;
584 wake_up(&rmidi->open_wait);
585 }
586
587 /* called from sound/core/seq/seq_midi.c */
snd_rawmidi_kernel_release(struct snd_rawmidi_file * rfile)588 int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile)
589 {
590 struct snd_rawmidi *rmidi;
591
592 if (snd_BUG_ON(!rfile))
593 return -ENXIO;
594
595 rmidi = rfile->rmidi;
596 rawmidi_release_priv(rfile);
597 module_put(rmidi->card->module);
598 return 0;
599 }
600 EXPORT_SYMBOL(snd_rawmidi_kernel_release);
601
snd_rawmidi_release(struct inode * inode,struct file * file)602 static int snd_rawmidi_release(struct inode *inode, struct file *file)
603 {
604 struct snd_rawmidi_file *rfile;
605 struct snd_rawmidi *rmidi;
606 struct module *module;
607
608 rfile = file->private_data;
609 rmidi = rfile->rmidi;
610 rawmidi_release_priv(rfile);
611 kfree(rfile);
612 module = rmidi->card->module;
613 snd_card_file_remove(rmidi->card, file);
614 module_put(module);
615 return 0;
616 }
617
snd_rawmidi_info(struct snd_rawmidi_substream * substream,struct snd_rawmidi_info * info)618 static int snd_rawmidi_info(struct snd_rawmidi_substream *substream,
619 struct snd_rawmidi_info *info)
620 {
621 struct snd_rawmidi *rmidi;
622
623 if (substream == NULL)
624 return -ENODEV;
625 rmidi = substream->rmidi;
626 memset(info, 0, sizeof(*info));
627 info->card = rmidi->card->number;
628 info->device = rmidi->device;
629 info->subdevice = substream->number;
630 info->stream = substream->stream;
631 info->flags = rmidi->info_flags;
632 strcpy(info->id, rmidi->id);
633 strcpy(info->name, rmidi->name);
634 strcpy(info->subname, substream->name);
635 info->subdevices_count = substream->pstr->substream_count;
636 info->subdevices_avail = (substream->pstr->substream_count -
637 substream->pstr->substream_opened);
638 return 0;
639 }
640
snd_rawmidi_info_user(struct snd_rawmidi_substream * substream,struct snd_rawmidi_info __user * _info)641 static int snd_rawmidi_info_user(struct snd_rawmidi_substream *substream,
642 struct snd_rawmidi_info __user *_info)
643 {
644 struct snd_rawmidi_info info;
645 int err;
646
647 err = snd_rawmidi_info(substream, &info);
648 if (err < 0)
649 return err;
650 if (copy_to_user(_info, &info, sizeof(struct snd_rawmidi_info)))
651 return -EFAULT;
652 return 0;
653 }
654
__snd_rawmidi_info_select(struct snd_card * card,struct snd_rawmidi_info * info)655 static int __snd_rawmidi_info_select(struct snd_card *card,
656 struct snd_rawmidi_info *info)
657 {
658 struct snd_rawmidi *rmidi;
659 struct snd_rawmidi_str *pstr;
660 struct snd_rawmidi_substream *substream;
661
662 rmidi = snd_rawmidi_search(card, info->device);
663 if (!rmidi)
664 return -ENXIO;
665 if (info->stream < 0 || info->stream > 1)
666 return -EINVAL;
667 info->stream = array_index_nospec(info->stream, 2);
668 pstr = &rmidi->streams[info->stream];
669 if (pstr->substream_count == 0)
670 return -ENOENT;
671 if (info->subdevice >= pstr->substream_count)
672 return -ENXIO;
673 list_for_each_entry(substream, &pstr->substreams, list) {
674 if ((unsigned int)substream->number == info->subdevice)
675 return snd_rawmidi_info(substream, info);
676 }
677 return -ENXIO;
678 }
679
snd_rawmidi_info_select(struct snd_card * card,struct snd_rawmidi_info * info)680 int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info)
681 {
682 guard(mutex)(®ister_mutex);
683 return __snd_rawmidi_info_select(card, info);
684 }
685 EXPORT_SYMBOL(snd_rawmidi_info_select);
686
snd_rawmidi_info_select_user(struct snd_card * card,struct snd_rawmidi_info __user * _info)687 static int snd_rawmidi_info_select_user(struct snd_card *card,
688 struct snd_rawmidi_info __user *_info)
689 {
690 int err;
691 struct snd_rawmidi_info info;
692
693 if (get_user(info.device, &_info->device))
694 return -EFAULT;
695 if (get_user(info.stream, &_info->stream))
696 return -EFAULT;
697 if (get_user(info.subdevice, &_info->subdevice))
698 return -EFAULT;
699 err = snd_rawmidi_info_select(card, &info);
700 if (err < 0)
701 return err;
702 if (copy_to_user(_info, &info, sizeof(struct snd_rawmidi_info)))
703 return -EFAULT;
704 return 0;
705 }
706
resize_runtime_buffer(struct snd_rawmidi_substream * substream,struct snd_rawmidi_params * params,bool is_input)707 static int resize_runtime_buffer(struct snd_rawmidi_substream *substream,
708 struct snd_rawmidi_params *params,
709 bool is_input)
710 {
711 struct snd_rawmidi_runtime *runtime = substream->runtime;
712 char *newbuf, *oldbuf;
713 unsigned int framing = params->mode & SNDRV_RAWMIDI_MODE_FRAMING_MASK;
714
715 if (params->buffer_size < 32 || params->buffer_size > 1024L * 1024L)
716 return -EINVAL;
717 if (framing == SNDRV_RAWMIDI_MODE_FRAMING_TSTAMP && (params->buffer_size & 0x1f) != 0)
718 return -EINVAL;
719 if (params->avail_min < 1 || params->avail_min > params->buffer_size)
720 return -EINVAL;
721 if (params->buffer_size & get_align(runtime))
722 return -EINVAL;
723 if (params->buffer_size != runtime->buffer_size) {
724 newbuf = kvzalloc(params->buffer_size, GFP_KERNEL);
725 if (!newbuf)
726 return -ENOMEM;
727 spin_lock_irq(&substream->lock);
728 if (runtime->buffer_ref) {
729 spin_unlock_irq(&substream->lock);
730 kvfree(newbuf);
731 return -EBUSY;
732 }
733 oldbuf = runtime->buffer;
734 runtime->buffer = newbuf;
735 runtime->buffer_size = params->buffer_size;
736 __reset_runtime_ptrs(runtime, is_input);
737 spin_unlock_irq(&substream->lock);
738 kvfree(oldbuf);
739 }
740 runtime->avail_min = params->avail_min;
741 return 0;
742 }
743
snd_rawmidi_output_params(struct snd_rawmidi_substream * substream,struct snd_rawmidi_params * params)744 int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream,
745 struct snd_rawmidi_params *params)
746 {
747 int err;
748
749 snd_rawmidi_drain_output(substream);
750 guard(mutex)(&substream->rmidi->open_mutex);
751 if (substream->append && substream->use_count > 1)
752 return -EBUSY;
753 err = resize_runtime_buffer(substream, params, false);
754 if (!err)
755 substream->active_sensing = !params->no_active_sensing;
756 return err;
757 }
758 EXPORT_SYMBOL(snd_rawmidi_output_params);
759
snd_rawmidi_input_params(struct snd_rawmidi_substream * substream,struct snd_rawmidi_params * params)760 int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream,
761 struct snd_rawmidi_params *params)
762 {
763 unsigned int framing = params->mode & SNDRV_RAWMIDI_MODE_FRAMING_MASK;
764 unsigned int clock_type = params->mode & SNDRV_RAWMIDI_MODE_CLOCK_MASK;
765 int err;
766
767 snd_rawmidi_drain_input(substream);
768 guard(mutex)(&substream->rmidi->open_mutex);
769 if (framing == SNDRV_RAWMIDI_MODE_FRAMING_NONE && clock_type != SNDRV_RAWMIDI_MODE_CLOCK_NONE)
770 err = -EINVAL;
771 else if (clock_type > SNDRV_RAWMIDI_MODE_CLOCK_MONOTONIC_RAW)
772 err = -EINVAL;
773 else if (framing > SNDRV_RAWMIDI_MODE_FRAMING_TSTAMP)
774 err = -EINVAL;
775 else
776 err = resize_runtime_buffer(substream, params, true);
777
778 if (!err) {
779 substream->framing = framing;
780 substream->clock_type = clock_type;
781 }
782 return 0;
783 }
784 EXPORT_SYMBOL(snd_rawmidi_input_params);
785
snd_rawmidi_output_status(struct snd_rawmidi_substream * substream,struct snd_rawmidi_status64 * status)786 static int snd_rawmidi_output_status(struct snd_rawmidi_substream *substream,
787 struct snd_rawmidi_status64 *status)
788 {
789 struct snd_rawmidi_runtime *runtime = substream->runtime;
790
791 memset(status, 0, sizeof(*status));
792 status->stream = SNDRV_RAWMIDI_STREAM_OUTPUT;
793 guard(spinlock_irq)(&substream->lock);
794 status->avail = runtime->avail;
795 return 0;
796 }
797
snd_rawmidi_input_status(struct snd_rawmidi_substream * substream,struct snd_rawmidi_status64 * status)798 static int snd_rawmidi_input_status(struct snd_rawmidi_substream *substream,
799 struct snd_rawmidi_status64 *status)
800 {
801 struct snd_rawmidi_runtime *runtime = substream->runtime;
802
803 memset(status, 0, sizeof(*status));
804 status->stream = SNDRV_RAWMIDI_STREAM_INPUT;
805 guard(spinlock_irq)(&substream->lock);
806 status->avail = runtime->avail;
807 status->xruns = runtime->xruns;
808 runtime->xruns = 0;
809 return 0;
810 }
811
snd_rawmidi_ioctl_status32(struct snd_rawmidi_file * rfile,struct snd_rawmidi_status32 __user * argp)812 static int snd_rawmidi_ioctl_status32(struct snd_rawmidi_file *rfile,
813 struct snd_rawmidi_status32 __user *argp)
814 {
815 int err = 0;
816 struct snd_rawmidi_status32 __user *status = argp;
817 struct snd_rawmidi_status32 status32;
818 struct snd_rawmidi_status64 status64;
819
820 if (copy_from_user(&status32, argp,
821 sizeof(struct snd_rawmidi_status32)))
822 return -EFAULT;
823
824 switch (status32.stream) {
825 case SNDRV_RAWMIDI_STREAM_OUTPUT:
826 if (rfile->output == NULL)
827 return -EINVAL;
828 err = snd_rawmidi_output_status(rfile->output, &status64);
829 break;
830 case SNDRV_RAWMIDI_STREAM_INPUT:
831 if (rfile->input == NULL)
832 return -EINVAL;
833 err = snd_rawmidi_input_status(rfile->input, &status64);
834 break;
835 default:
836 return -EINVAL;
837 }
838 if (err < 0)
839 return err;
840
841 status32 = (struct snd_rawmidi_status32) {
842 .stream = status64.stream,
843 .tstamp_sec = status64.tstamp_sec,
844 .tstamp_nsec = status64.tstamp_nsec,
845 .avail = status64.avail,
846 .xruns = status64.xruns,
847 };
848
849 if (copy_to_user(status, &status32, sizeof(*status)))
850 return -EFAULT;
851
852 return 0;
853 }
854
snd_rawmidi_ioctl_status64(struct snd_rawmidi_file * rfile,struct snd_rawmidi_status64 __user * argp)855 static int snd_rawmidi_ioctl_status64(struct snd_rawmidi_file *rfile,
856 struct snd_rawmidi_status64 __user *argp)
857 {
858 int err = 0;
859 struct snd_rawmidi_status64 status;
860
861 if (copy_from_user(&status, argp, sizeof(struct snd_rawmidi_status64)))
862 return -EFAULT;
863
864 switch (status.stream) {
865 case SNDRV_RAWMIDI_STREAM_OUTPUT:
866 if (rfile->output == NULL)
867 return -EINVAL;
868 err = snd_rawmidi_output_status(rfile->output, &status);
869 break;
870 case SNDRV_RAWMIDI_STREAM_INPUT:
871 if (rfile->input == NULL)
872 return -EINVAL;
873 err = snd_rawmidi_input_status(rfile->input, &status);
874 break;
875 default:
876 return -EINVAL;
877 }
878 if (err < 0)
879 return err;
880 if (copy_to_user(argp, &status,
881 sizeof(struct snd_rawmidi_status64)))
882 return -EFAULT;
883 return 0;
884 }
885
snd_rawmidi_ioctl(struct file * file,unsigned int cmd,unsigned long arg)886 static long snd_rawmidi_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
887 {
888 struct snd_rawmidi_file *rfile;
889 struct snd_rawmidi *rmidi;
890 void __user *argp = (void __user *)arg;
891
892 rfile = file->private_data;
893 if (((cmd >> 8) & 0xff) != 'W')
894 return -ENOTTY;
895 switch (cmd) {
896 case SNDRV_RAWMIDI_IOCTL_PVERSION:
897 return put_user(SNDRV_RAWMIDI_VERSION, (int __user *)argp) ? -EFAULT : 0;
898 case SNDRV_RAWMIDI_IOCTL_INFO:
899 {
900 int stream;
901 struct snd_rawmidi_info __user *info = argp;
902
903 if (get_user(stream, &info->stream))
904 return -EFAULT;
905 switch (stream) {
906 case SNDRV_RAWMIDI_STREAM_INPUT:
907 return snd_rawmidi_info_user(rfile->input, info);
908 case SNDRV_RAWMIDI_STREAM_OUTPUT:
909 return snd_rawmidi_info_user(rfile->output, info);
910 default:
911 return -EINVAL;
912 }
913 }
914 case SNDRV_RAWMIDI_IOCTL_USER_PVERSION:
915 if (get_user(rfile->user_pversion, (unsigned int __user *)arg))
916 return -EFAULT;
917 return 0;
918
919 case SNDRV_RAWMIDI_IOCTL_PARAMS:
920 {
921 struct snd_rawmidi_params params;
922
923 if (copy_from_user(¶ms, argp, sizeof(struct snd_rawmidi_params)))
924 return -EFAULT;
925 if (rfile->user_pversion < SNDRV_PROTOCOL_VERSION(2, 0, 2)) {
926 params.mode = 0;
927 memset(params.reserved, 0, sizeof(params.reserved));
928 }
929 switch (params.stream) {
930 case SNDRV_RAWMIDI_STREAM_OUTPUT:
931 if (rfile->output == NULL)
932 return -EINVAL;
933 return snd_rawmidi_output_params(rfile->output, ¶ms);
934 case SNDRV_RAWMIDI_STREAM_INPUT:
935 if (rfile->input == NULL)
936 return -EINVAL;
937 return snd_rawmidi_input_params(rfile->input, ¶ms);
938 default:
939 return -EINVAL;
940 }
941 }
942 case SNDRV_RAWMIDI_IOCTL_STATUS32:
943 return snd_rawmidi_ioctl_status32(rfile, argp);
944 case SNDRV_RAWMIDI_IOCTL_STATUS64:
945 return snd_rawmidi_ioctl_status64(rfile, argp);
946 case SNDRV_RAWMIDI_IOCTL_DROP:
947 {
948 int val;
949
950 if (get_user(val, (int __user *) argp))
951 return -EFAULT;
952 switch (val) {
953 case SNDRV_RAWMIDI_STREAM_OUTPUT:
954 if (rfile->output == NULL)
955 return -EINVAL;
956 return snd_rawmidi_drop_output(rfile->output);
957 default:
958 return -EINVAL;
959 }
960 }
961 case SNDRV_RAWMIDI_IOCTL_DRAIN:
962 {
963 int val;
964
965 if (get_user(val, (int __user *) argp))
966 return -EFAULT;
967 switch (val) {
968 case SNDRV_RAWMIDI_STREAM_OUTPUT:
969 if (rfile->output == NULL)
970 return -EINVAL;
971 return snd_rawmidi_drain_output(rfile->output);
972 case SNDRV_RAWMIDI_STREAM_INPUT:
973 if (rfile->input == NULL)
974 return -EINVAL;
975 return snd_rawmidi_drain_input(rfile->input);
976 default:
977 return -EINVAL;
978 }
979 }
980 default:
981 rmidi = rfile->rmidi;
982 if (rmidi->ops && rmidi->ops->ioctl)
983 return rmidi->ops->ioctl(rmidi, cmd, argp);
984 rmidi_dbg(rmidi, "rawmidi: unknown command = 0x%x\n", cmd);
985 }
986 return -ENOTTY;
987 }
988
989 /* ioctl to find the next device; either legacy or UMP depending on @find_ump */
snd_rawmidi_next_device(struct snd_card * card,int __user * argp,bool find_ump)990 static int snd_rawmidi_next_device(struct snd_card *card, int __user *argp,
991 bool find_ump)
992
993 {
994 struct snd_rawmidi *rmidi;
995 int device;
996 bool is_ump;
997
998 if (get_user(device, argp))
999 return -EFAULT;
1000 if (device >= SNDRV_RAWMIDI_DEVICES) /* next device is -1 */
1001 device = SNDRV_RAWMIDI_DEVICES - 1;
1002 scoped_guard(mutex, ®ister_mutex) {
1003 device = device < 0 ? 0 : device + 1;
1004 for (; device < SNDRV_RAWMIDI_DEVICES; device++) {
1005 rmidi = snd_rawmidi_search(card, device);
1006 if (!rmidi)
1007 continue;
1008 is_ump = rawmidi_is_ump(rmidi);
1009 if (find_ump == is_ump)
1010 break;
1011 }
1012 if (device == SNDRV_RAWMIDI_DEVICES)
1013 device = -1;
1014 }
1015 if (put_user(device, argp))
1016 return -EFAULT;
1017 return 0;
1018 }
1019
1020 #if IS_ENABLED(CONFIG_SND_UMP)
1021 /* inquiry of UMP endpoint and block info via control API */
snd_rawmidi_call_ump_ioctl(struct snd_card * card,int cmd,void __user * argp)1022 static int snd_rawmidi_call_ump_ioctl(struct snd_card *card, int cmd,
1023 void __user *argp)
1024 {
1025 struct snd_ump_endpoint_info __user *info = argp;
1026 struct snd_rawmidi *rmidi;
1027 int device;
1028
1029 if (get_user(device, &info->device))
1030 return -EFAULT;
1031 guard(mutex)(®ister_mutex);
1032 rmidi = snd_rawmidi_search(card, device);
1033 if (rmidi && rmidi->ops && rmidi->ops->ioctl)
1034 return rmidi->ops->ioctl(rmidi, cmd, argp);
1035 else
1036 return -ENXIO;
1037 }
1038 #endif
1039
snd_rawmidi_control_ioctl(struct snd_card * card,struct snd_ctl_file * control,unsigned int cmd,unsigned long arg)1040 static int snd_rawmidi_control_ioctl(struct snd_card *card,
1041 struct snd_ctl_file *control,
1042 unsigned int cmd,
1043 unsigned long arg)
1044 {
1045 void __user *argp = (void __user *)arg;
1046
1047 switch (cmd) {
1048 case SNDRV_CTL_IOCTL_RAWMIDI_NEXT_DEVICE:
1049 return snd_rawmidi_next_device(card, argp, false);
1050 #if IS_ENABLED(CONFIG_SND_UMP)
1051 case SNDRV_CTL_IOCTL_UMP_NEXT_DEVICE:
1052 return snd_rawmidi_next_device(card, argp, true);
1053 case SNDRV_CTL_IOCTL_UMP_ENDPOINT_INFO:
1054 return snd_rawmidi_call_ump_ioctl(card, SNDRV_UMP_IOCTL_ENDPOINT_INFO, argp);
1055 case SNDRV_CTL_IOCTL_UMP_BLOCK_INFO:
1056 return snd_rawmidi_call_ump_ioctl(card, SNDRV_UMP_IOCTL_BLOCK_INFO, argp);
1057 #endif
1058 case SNDRV_CTL_IOCTL_RAWMIDI_PREFER_SUBDEVICE:
1059 {
1060 int val;
1061
1062 if (get_user(val, (int __user *)argp))
1063 return -EFAULT;
1064 control->preferred_subdevice[SND_CTL_SUBDEV_RAWMIDI] = val;
1065 return 0;
1066 }
1067 case SNDRV_CTL_IOCTL_RAWMIDI_INFO:
1068 return snd_rawmidi_info_select_user(card, argp);
1069 }
1070 return -ENOIOCTLCMD;
1071 }
1072
receive_with_tstamp_framing(struct snd_rawmidi_substream * substream,const unsigned char * buffer,int src_count,const struct timespec64 * tstamp)1073 static int receive_with_tstamp_framing(struct snd_rawmidi_substream *substream,
1074 const unsigned char *buffer, int src_count, const struct timespec64 *tstamp)
1075 {
1076 struct snd_rawmidi_runtime *runtime = substream->runtime;
1077 struct snd_rawmidi_framing_tstamp *dest_ptr;
1078 struct snd_rawmidi_framing_tstamp frame = { .tv_sec = tstamp->tv_sec, .tv_nsec = tstamp->tv_nsec };
1079 int orig_count = src_count;
1080 int frame_size = sizeof(struct snd_rawmidi_framing_tstamp);
1081 int align = get_align(runtime);
1082
1083 BUILD_BUG_ON(frame_size != 0x20);
1084 if (snd_BUG_ON((runtime->hw_ptr & 0x1f) != 0))
1085 return -EINVAL;
1086
1087 while (src_count > align) {
1088 if ((int)(runtime->buffer_size - runtime->avail) < frame_size) {
1089 runtime->xruns += src_count;
1090 break;
1091 }
1092 if (src_count >= SNDRV_RAWMIDI_FRAMING_DATA_LENGTH)
1093 frame.length = SNDRV_RAWMIDI_FRAMING_DATA_LENGTH;
1094 else {
1095 frame.length = get_aligned_size(runtime, src_count);
1096 if (!frame.length)
1097 break;
1098 memset(frame.data, 0, SNDRV_RAWMIDI_FRAMING_DATA_LENGTH);
1099 }
1100 memcpy(frame.data, buffer, frame.length);
1101 buffer += frame.length;
1102 src_count -= frame.length;
1103 dest_ptr = (struct snd_rawmidi_framing_tstamp *) (runtime->buffer + runtime->hw_ptr);
1104 *dest_ptr = frame;
1105 runtime->avail += frame_size;
1106 runtime->hw_ptr += frame_size;
1107 runtime->hw_ptr %= runtime->buffer_size;
1108 }
1109 return orig_count - src_count;
1110 }
1111
get_framing_tstamp(struct snd_rawmidi_substream * substream)1112 static struct timespec64 get_framing_tstamp(struct snd_rawmidi_substream *substream)
1113 {
1114 struct timespec64 ts64 = {0, 0};
1115
1116 switch (substream->clock_type) {
1117 case SNDRV_RAWMIDI_MODE_CLOCK_MONOTONIC_RAW:
1118 ktime_get_raw_ts64(&ts64);
1119 break;
1120 case SNDRV_RAWMIDI_MODE_CLOCK_MONOTONIC:
1121 ktime_get_ts64(&ts64);
1122 break;
1123 case SNDRV_RAWMIDI_MODE_CLOCK_REALTIME:
1124 ktime_get_real_ts64(&ts64);
1125 break;
1126 }
1127 return ts64;
1128 }
1129
1130 /**
1131 * snd_rawmidi_receive - receive the input data from the device
1132 * @substream: the rawmidi substream
1133 * @buffer: the buffer pointer
1134 * @count: the data size to read
1135 *
1136 * Reads the data from the internal buffer.
1137 *
1138 * Return: The size of read data, or a negative error code on failure.
1139 */
snd_rawmidi_receive(struct snd_rawmidi_substream * substream,const unsigned char * buffer,int count)1140 int snd_rawmidi_receive(struct snd_rawmidi_substream *substream,
1141 const unsigned char *buffer, int count)
1142 {
1143 struct timespec64 ts64 = get_framing_tstamp(substream);
1144 int result = 0, count1;
1145 struct snd_rawmidi_runtime *runtime;
1146
1147 guard(spinlock_irqsave)(&substream->lock);
1148 if (!substream->opened)
1149 return -EBADFD;
1150 runtime = substream->runtime;
1151 if (!runtime || !runtime->buffer) {
1152 rmidi_dbg(substream->rmidi,
1153 "snd_rawmidi_receive: input is not active!!!\n");
1154 return -EINVAL;
1155 }
1156
1157 count = get_aligned_size(runtime, count);
1158 if (!count)
1159 return result;
1160
1161 if (substream->framing == SNDRV_RAWMIDI_MODE_FRAMING_TSTAMP) {
1162 result = receive_with_tstamp_framing(substream, buffer, count, &ts64);
1163 } else if (count == 1) { /* special case, faster code */
1164 substream->bytes++;
1165 if (runtime->avail < runtime->buffer_size) {
1166 runtime->buffer[runtime->hw_ptr++] = buffer[0];
1167 runtime->hw_ptr %= runtime->buffer_size;
1168 runtime->avail++;
1169 result++;
1170 } else {
1171 runtime->xruns++;
1172 }
1173 } else {
1174 substream->bytes += count;
1175 count1 = runtime->buffer_size - runtime->hw_ptr;
1176 if (count1 > count)
1177 count1 = count;
1178 if (count1 > (int)(runtime->buffer_size - runtime->avail))
1179 count1 = runtime->buffer_size - runtime->avail;
1180 count1 = get_aligned_size(runtime, count1);
1181 if (!count1)
1182 return result;
1183 memcpy(runtime->buffer + runtime->hw_ptr, buffer, count1);
1184 runtime->hw_ptr += count1;
1185 runtime->hw_ptr %= runtime->buffer_size;
1186 runtime->avail += count1;
1187 count -= count1;
1188 result += count1;
1189 if (count > 0) {
1190 buffer += count1;
1191 count1 = count;
1192 if (count1 > (int)(runtime->buffer_size - runtime->avail)) {
1193 count1 = runtime->buffer_size - runtime->avail;
1194 runtime->xruns += count - count1;
1195 }
1196 if (count1 > 0) {
1197 memcpy(runtime->buffer, buffer, count1);
1198 runtime->hw_ptr = count1;
1199 runtime->avail += count1;
1200 result += count1;
1201 }
1202 }
1203 }
1204 if (result > 0) {
1205 if (runtime->event)
1206 schedule_work(&runtime->event_work);
1207 else if (__snd_rawmidi_ready(runtime))
1208 wake_up(&runtime->sleep);
1209 }
1210 return result;
1211 }
1212 EXPORT_SYMBOL(snd_rawmidi_receive);
1213
snd_rawmidi_kernel_read1(struct snd_rawmidi_substream * substream,unsigned char __user * userbuf,unsigned char * kernelbuf,long count)1214 static long snd_rawmidi_kernel_read1(struct snd_rawmidi_substream *substream,
1215 unsigned char __user *userbuf,
1216 unsigned char *kernelbuf, long count)
1217 {
1218 unsigned long flags;
1219 long result = 0, count1;
1220 struct snd_rawmidi_runtime *runtime = substream->runtime;
1221 unsigned long appl_ptr;
1222 int err = 0;
1223
1224 spin_lock_irqsave(&substream->lock, flags);
1225 snd_rawmidi_buffer_ref(runtime);
1226 while (count > 0 && runtime->avail) {
1227 count1 = runtime->buffer_size - runtime->appl_ptr;
1228 if (count1 > count)
1229 count1 = count;
1230 if (count1 > (int)runtime->avail)
1231 count1 = runtime->avail;
1232
1233 /* update runtime->appl_ptr before unlocking for userbuf */
1234 appl_ptr = runtime->appl_ptr;
1235 runtime->appl_ptr += count1;
1236 runtime->appl_ptr %= runtime->buffer_size;
1237 runtime->avail -= count1;
1238
1239 if (kernelbuf)
1240 memcpy(kernelbuf + result, runtime->buffer + appl_ptr, count1);
1241 if (userbuf) {
1242 spin_unlock_irqrestore(&substream->lock, flags);
1243 if (copy_to_user(userbuf + result,
1244 runtime->buffer + appl_ptr, count1))
1245 err = -EFAULT;
1246 spin_lock_irqsave(&substream->lock, flags);
1247 if (err)
1248 goto out;
1249 }
1250 result += count1;
1251 count -= count1;
1252 }
1253 out:
1254 snd_rawmidi_buffer_unref(runtime);
1255 spin_unlock_irqrestore(&substream->lock, flags);
1256 return result > 0 ? result : err;
1257 }
1258
snd_rawmidi_kernel_read(struct snd_rawmidi_substream * substream,unsigned char * buf,long count)1259 long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream,
1260 unsigned char *buf, long count)
1261 {
1262 snd_rawmidi_input_trigger(substream, 1);
1263 return snd_rawmidi_kernel_read1(substream, NULL/*userbuf*/, buf, count);
1264 }
1265 EXPORT_SYMBOL(snd_rawmidi_kernel_read);
1266
snd_rawmidi_read(struct file * file,char __user * buf,size_t count,loff_t * offset)1267 static ssize_t snd_rawmidi_read(struct file *file, char __user *buf, size_t count,
1268 loff_t *offset)
1269 {
1270 long result;
1271 int count1;
1272 struct snd_rawmidi_file *rfile;
1273 struct snd_rawmidi_substream *substream;
1274 struct snd_rawmidi_runtime *runtime;
1275
1276 rfile = file->private_data;
1277 substream = rfile->input;
1278 if (substream == NULL)
1279 return -EIO;
1280 runtime = substream->runtime;
1281 snd_rawmidi_input_trigger(substream, 1);
1282 result = 0;
1283 while (count > 0) {
1284 spin_lock_irq(&substream->lock);
1285 while (!__snd_rawmidi_ready(runtime)) {
1286 wait_queue_entry_t wait;
1287
1288 if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
1289 spin_unlock_irq(&substream->lock);
1290 return result > 0 ? result : -EAGAIN;
1291 }
1292 init_waitqueue_entry(&wait, current);
1293 add_wait_queue(&runtime->sleep, &wait);
1294 set_current_state(TASK_INTERRUPTIBLE);
1295 spin_unlock_irq(&substream->lock);
1296 schedule();
1297 remove_wait_queue(&runtime->sleep, &wait);
1298 if (rfile->rmidi->card->shutdown)
1299 return -ENODEV;
1300 if (signal_pending(current))
1301 return result > 0 ? result : -ERESTARTSYS;
1302 spin_lock_irq(&substream->lock);
1303 if (!runtime->avail) {
1304 spin_unlock_irq(&substream->lock);
1305 return result > 0 ? result : -EIO;
1306 }
1307 }
1308 spin_unlock_irq(&substream->lock);
1309 count1 = snd_rawmidi_kernel_read1(substream,
1310 (unsigned char __user *)buf,
1311 NULL/*kernelbuf*/,
1312 count);
1313 if (count1 < 0)
1314 return result > 0 ? result : count1;
1315 result += count1;
1316 buf += count1;
1317 count -= count1;
1318 }
1319 return result;
1320 }
1321
1322 /**
1323 * snd_rawmidi_transmit_empty - check whether the output buffer is empty
1324 * @substream: the rawmidi substream
1325 *
1326 * Return: 1 if the internal output buffer is empty, 0 if not.
1327 */
snd_rawmidi_transmit_empty(struct snd_rawmidi_substream * substream)1328 int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream)
1329 {
1330 struct snd_rawmidi_runtime *runtime;
1331
1332 guard(spinlock_irqsave)(&substream->lock);
1333 runtime = substream->runtime;
1334 if (!substream->opened || !runtime || !runtime->buffer) {
1335 rmidi_dbg(substream->rmidi,
1336 "snd_rawmidi_transmit_empty: output is not active!!!\n");
1337 return 1;
1338 }
1339 return (runtime->avail >= runtime->buffer_size);
1340 }
1341 EXPORT_SYMBOL(snd_rawmidi_transmit_empty);
1342
1343 /*
1344 * __snd_rawmidi_transmit_peek - copy data from the internal buffer
1345 * @substream: the rawmidi substream
1346 * @buffer: the buffer pointer
1347 * @count: data size to transfer
1348 *
1349 * This is a variant of snd_rawmidi_transmit_peek() without spinlock.
1350 */
__snd_rawmidi_transmit_peek(struct snd_rawmidi_substream * substream,unsigned char * buffer,int count)1351 static int __snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
1352 unsigned char *buffer, int count)
1353 {
1354 int result, count1;
1355 struct snd_rawmidi_runtime *runtime = substream->runtime;
1356
1357 if (runtime->buffer == NULL) {
1358 rmidi_dbg(substream->rmidi,
1359 "snd_rawmidi_transmit_peek: output is not active!!!\n");
1360 return -EINVAL;
1361 }
1362 result = 0;
1363 if (runtime->avail >= runtime->buffer_size) {
1364 /* warning: lowlevel layer MUST trigger down the hardware */
1365 goto __skip;
1366 }
1367 if (count == 1) { /* special case, faster code */
1368 *buffer = runtime->buffer[runtime->hw_ptr];
1369 result++;
1370 } else {
1371 count1 = runtime->buffer_size - runtime->hw_ptr;
1372 if (count1 > count)
1373 count1 = count;
1374 if (count1 > (int)(runtime->buffer_size - runtime->avail))
1375 count1 = runtime->buffer_size - runtime->avail;
1376 count1 = get_aligned_size(runtime, count1);
1377 if (!count1)
1378 goto __skip;
1379 memcpy(buffer, runtime->buffer + runtime->hw_ptr, count1);
1380 count -= count1;
1381 result += count1;
1382 if (count > 0) {
1383 if (count > (int)(runtime->buffer_size - runtime->avail - count1))
1384 count = runtime->buffer_size - runtime->avail - count1;
1385 count = get_aligned_size(runtime, count);
1386 if (!count)
1387 goto __skip;
1388 memcpy(buffer + count1, runtime->buffer, count);
1389 result += count;
1390 }
1391 }
1392 __skip:
1393 return result;
1394 }
1395
1396 /**
1397 * snd_rawmidi_transmit_peek - copy data from the internal buffer
1398 * @substream: the rawmidi substream
1399 * @buffer: the buffer pointer
1400 * @count: data size to transfer
1401 *
1402 * Copies data from the internal output buffer to the given buffer.
1403 *
1404 * Call this in the interrupt handler when the midi output is ready,
1405 * and call snd_rawmidi_transmit_ack() after the transmission is
1406 * finished.
1407 *
1408 * Return: The size of copied data, or a negative error code on failure.
1409 */
snd_rawmidi_transmit_peek(struct snd_rawmidi_substream * substream,unsigned char * buffer,int count)1410 int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
1411 unsigned char *buffer, int count)
1412 {
1413 guard(spinlock_irqsave)(&substream->lock);
1414 if (!substream->opened || !substream->runtime)
1415 return -EBADFD;
1416 return __snd_rawmidi_transmit_peek(substream, buffer, count);
1417 }
1418 EXPORT_SYMBOL(snd_rawmidi_transmit_peek);
1419
1420 /*
1421 * __snd_rawmidi_transmit_ack - acknowledge the transmission
1422 * @substream: the rawmidi substream
1423 * @count: the transferred count
1424 *
1425 * This is a variant of __snd_rawmidi_transmit_ack() without spinlock.
1426 */
__snd_rawmidi_transmit_ack(struct snd_rawmidi_substream * substream,int count)1427 static int __snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream,
1428 int count)
1429 {
1430 struct snd_rawmidi_runtime *runtime = substream->runtime;
1431
1432 if (runtime->buffer == NULL) {
1433 rmidi_dbg(substream->rmidi,
1434 "snd_rawmidi_transmit_ack: output is not active!!!\n");
1435 return -EINVAL;
1436 }
1437 snd_BUG_ON(runtime->avail + count > runtime->buffer_size);
1438 count = get_aligned_size(runtime, count);
1439 runtime->hw_ptr += count;
1440 runtime->hw_ptr %= runtime->buffer_size;
1441 runtime->avail += count;
1442 substream->bytes += count;
1443 if (count > 0) {
1444 if (runtime->drain || __snd_rawmidi_ready(runtime))
1445 wake_up(&runtime->sleep);
1446 }
1447 return count;
1448 }
1449
1450 /**
1451 * snd_rawmidi_transmit_ack - acknowledge the transmission
1452 * @substream: the rawmidi substream
1453 * @count: the transferred count
1454 *
1455 * Advances the hardware pointer for the internal output buffer with
1456 * the given size and updates the condition.
1457 * Call after the transmission is finished.
1458 *
1459 * Return: The advanced size if successful, or a negative error code on failure.
1460 */
snd_rawmidi_transmit_ack(struct snd_rawmidi_substream * substream,int count)1461 int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count)
1462 {
1463 guard(spinlock_irqsave)(&substream->lock);
1464 if (!substream->opened || !substream->runtime)
1465 return -EBADFD;
1466 return __snd_rawmidi_transmit_ack(substream, count);
1467 }
1468 EXPORT_SYMBOL(snd_rawmidi_transmit_ack);
1469
1470 /**
1471 * snd_rawmidi_transmit - copy from the buffer to the device
1472 * @substream: the rawmidi substream
1473 * @buffer: the buffer pointer
1474 * @count: the data size to transfer
1475 *
1476 * Copies data from the buffer to the device and advances the pointer.
1477 *
1478 * Return: The copied size if successful, or a negative error code on failure.
1479 */
snd_rawmidi_transmit(struct snd_rawmidi_substream * substream,unsigned char * buffer,int count)1480 int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream,
1481 unsigned char *buffer, int count)
1482 {
1483 guard(spinlock_irqsave)(&substream->lock);
1484 if (!substream->opened)
1485 return -EBADFD;
1486 count = __snd_rawmidi_transmit_peek(substream, buffer, count);
1487 if (count <= 0)
1488 return count;
1489 return __snd_rawmidi_transmit_ack(substream, count);
1490 }
1491 EXPORT_SYMBOL(snd_rawmidi_transmit);
1492
1493 /**
1494 * snd_rawmidi_proceed - Discard the all pending bytes and proceed
1495 * @substream: rawmidi substream
1496 *
1497 * Return: the number of discarded bytes
1498 */
snd_rawmidi_proceed(struct snd_rawmidi_substream * substream)1499 int snd_rawmidi_proceed(struct snd_rawmidi_substream *substream)
1500 {
1501 struct snd_rawmidi_runtime *runtime;
1502 int count = 0;
1503
1504 guard(spinlock_irqsave)(&substream->lock);
1505 runtime = substream->runtime;
1506 if (substream->opened && runtime &&
1507 runtime->avail < runtime->buffer_size) {
1508 count = runtime->buffer_size - runtime->avail;
1509 __snd_rawmidi_transmit_ack(substream, count);
1510 }
1511 return count;
1512 }
1513 EXPORT_SYMBOL(snd_rawmidi_proceed);
1514
snd_rawmidi_kernel_write1(struct snd_rawmidi_substream * substream,const unsigned char __user * userbuf,const unsigned char * kernelbuf,long count)1515 static long snd_rawmidi_kernel_write1(struct snd_rawmidi_substream *substream,
1516 const unsigned char __user *userbuf,
1517 const unsigned char *kernelbuf,
1518 long count)
1519 {
1520 unsigned long flags;
1521 long count1, result;
1522 struct snd_rawmidi_runtime *runtime = substream->runtime;
1523 unsigned long appl_ptr;
1524
1525 if (!kernelbuf && !userbuf)
1526 return -EINVAL;
1527 if (snd_BUG_ON(!runtime->buffer))
1528 return -EINVAL;
1529
1530 result = 0;
1531 spin_lock_irqsave(&substream->lock, flags);
1532 if (substream->append) {
1533 if ((long)runtime->avail < count) {
1534 spin_unlock_irqrestore(&substream->lock, flags);
1535 return -EAGAIN;
1536 }
1537 }
1538 snd_rawmidi_buffer_ref(runtime);
1539 while (count > 0 && runtime->avail > 0) {
1540 count1 = runtime->buffer_size - runtime->appl_ptr;
1541 if (count1 > count)
1542 count1 = count;
1543 if (count1 > (long)runtime->avail)
1544 count1 = runtime->avail;
1545
1546 /* update runtime->appl_ptr before unlocking for userbuf */
1547 appl_ptr = runtime->appl_ptr;
1548 runtime->appl_ptr += count1;
1549 runtime->appl_ptr %= runtime->buffer_size;
1550 runtime->avail -= count1;
1551
1552 if (kernelbuf)
1553 memcpy(runtime->buffer + appl_ptr,
1554 kernelbuf + result, count1);
1555 else if (userbuf) {
1556 spin_unlock_irqrestore(&substream->lock, flags);
1557 if (copy_from_user(runtime->buffer + appl_ptr,
1558 userbuf + result, count1)) {
1559 spin_lock_irqsave(&substream->lock, flags);
1560 result = result > 0 ? result : -EFAULT;
1561 goto __end;
1562 }
1563 spin_lock_irqsave(&substream->lock, flags);
1564 }
1565 result += count1;
1566 count -= count1;
1567 }
1568 __end:
1569 count1 = runtime->avail < runtime->buffer_size;
1570 snd_rawmidi_buffer_unref(runtime);
1571 spin_unlock_irqrestore(&substream->lock, flags);
1572 if (count1)
1573 snd_rawmidi_output_trigger(substream, 1);
1574 return result;
1575 }
1576
snd_rawmidi_kernel_write(struct snd_rawmidi_substream * substream,const unsigned char * buf,long count)1577 long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream,
1578 const unsigned char *buf, long count)
1579 {
1580 return snd_rawmidi_kernel_write1(substream, NULL, buf, count);
1581 }
1582 EXPORT_SYMBOL(snd_rawmidi_kernel_write);
1583
snd_rawmidi_write(struct file * file,const char __user * buf,size_t count,loff_t * offset)1584 static ssize_t snd_rawmidi_write(struct file *file, const char __user *buf,
1585 size_t count, loff_t *offset)
1586 {
1587 long result, timeout;
1588 int count1;
1589 struct snd_rawmidi_file *rfile;
1590 struct snd_rawmidi_runtime *runtime;
1591 struct snd_rawmidi_substream *substream;
1592
1593 rfile = file->private_data;
1594 substream = rfile->output;
1595 runtime = substream->runtime;
1596 /* we cannot put an atomic message to our buffer */
1597 if (substream->append && count > runtime->buffer_size)
1598 return -EIO;
1599 result = 0;
1600 while (count > 0) {
1601 spin_lock_irq(&substream->lock);
1602 while (!snd_rawmidi_ready_append(substream, count)) {
1603 wait_queue_entry_t wait;
1604
1605 if (file->f_flags & O_NONBLOCK) {
1606 spin_unlock_irq(&substream->lock);
1607 return result > 0 ? result : -EAGAIN;
1608 }
1609 init_waitqueue_entry(&wait, current);
1610 add_wait_queue(&runtime->sleep, &wait);
1611 set_current_state(TASK_INTERRUPTIBLE);
1612 spin_unlock_irq(&substream->lock);
1613 timeout = schedule_timeout(30 * HZ);
1614 remove_wait_queue(&runtime->sleep, &wait);
1615 if (rfile->rmidi->card->shutdown)
1616 return -ENODEV;
1617 if (signal_pending(current))
1618 return result > 0 ? result : -ERESTARTSYS;
1619 spin_lock_irq(&substream->lock);
1620 if (!runtime->avail && !timeout) {
1621 spin_unlock_irq(&substream->lock);
1622 return result > 0 ? result : -EIO;
1623 }
1624 }
1625 spin_unlock_irq(&substream->lock);
1626 count1 = snd_rawmidi_kernel_write1(substream, buf, NULL, count);
1627 if (count1 < 0)
1628 return result > 0 ? result : count1;
1629 result += count1;
1630 buf += count1;
1631 if ((size_t)count1 < count && (file->f_flags & O_NONBLOCK))
1632 break;
1633 count -= count1;
1634 }
1635 if (file->f_flags & O_DSYNC) {
1636 spin_lock_irq(&substream->lock);
1637 while (runtime->avail != runtime->buffer_size) {
1638 wait_queue_entry_t wait;
1639 unsigned int last_avail = runtime->avail;
1640
1641 init_waitqueue_entry(&wait, current);
1642 add_wait_queue(&runtime->sleep, &wait);
1643 set_current_state(TASK_INTERRUPTIBLE);
1644 spin_unlock_irq(&substream->lock);
1645 timeout = schedule_timeout(30 * HZ);
1646 remove_wait_queue(&runtime->sleep, &wait);
1647 if (signal_pending(current))
1648 return result > 0 ? result : -ERESTARTSYS;
1649 if (runtime->avail == last_avail && !timeout)
1650 return result > 0 ? result : -EIO;
1651 spin_lock_irq(&substream->lock);
1652 }
1653 spin_unlock_irq(&substream->lock);
1654 }
1655 return result;
1656 }
1657
snd_rawmidi_poll(struct file * file,poll_table * wait)1658 static __poll_t snd_rawmidi_poll(struct file *file, poll_table *wait)
1659 {
1660 struct snd_rawmidi_file *rfile;
1661 struct snd_rawmidi_runtime *runtime;
1662 __poll_t mask;
1663
1664 rfile = file->private_data;
1665 if (rfile->input != NULL) {
1666 runtime = rfile->input->runtime;
1667 snd_rawmidi_input_trigger(rfile->input, 1);
1668 poll_wait(file, &runtime->sleep, wait);
1669 }
1670 if (rfile->output != NULL) {
1671 runtime = rfile->output->runtime;
1672 poll_wait(file, &runtime->sleep, wait);
1673 }
1674 mask = 0;
1675 if (rfile->input != NULL) {
1676 if (snd_rawmidi_ready(rfile->input))
1677 mask |= EPOLLIN | EPOLLRDNORM;
1678 }
1679 if (rfile->output != NULL) {
1680 if (snd_rawmidi_ready(rfile->output))
1681 mask |= EPOLLOUT | EPOLLWRNORM;
1682 }
1683 return mask;
1684 }
1685
1686 /*
1687 */
1688 #ifdef CONFIG_COMPAT
1689 #include "rawmidi_compat.c"
1690 #else
1691 #define snd_rawmidi_ioctl_compat NULL
1692 #endif
1693
1694 /*
1695 */
1696
snd_rawmidi_proc_info_read(struct snd_info_entry * entry,struct snd_info_buffer * buffer)1697 static void snd_rawmidi_proc_info_read(struct snd_info_entry *entry,
1698 struct snd_info_buffer *buffer)
1699 {
1700 struct snd_rawmidi *rmidi;
1701 struct snd_rawmidi_substream *substream;
1702 struct snd_rawmidi_runtime *runtime;
1703 unsigned long buffer_size, avail, xruns;
1704 unsigned int clock_type;
1705 static const char *clock_names[4] = { "none", "realtime", "monotonic", "monotonic raw" };
1706
1707 rmidi = entry->private_data;
1708 snd_iprintf(buffer, "%s\n\n", rmidi->name);
1709 if (IS_ENABLED(CONFIG_SND_UMP))
1710 snd_iprintf(buffer, "Type: %s\n",
1711 rawmidi_is_ump(rmidi) ? "UMP" : "Legacy");
1712 if (rmidi->ops && rmidi->ops->proc_read)
1713 rmidi->ops->proc_read(entry, buffer);
1714 guard(mutex)(&rmidi->open_mutex);
1715 if (rmidi->info_flags & SNDRV_RAWMIDI_INFO_OUTPUT) {
1716 list_for_each_entry(substream,
1717 &rmidi->streams[SNDRV_RAWMIDI_STREAM_OUTPUT].substreams,
1718 list) {
1719 snd_iprintf(buffer,
1720 "Output %d\n"
1721 " Tx bytes : %lu\n",
1722 substream->number,
1723 (unsigned long) substream->bytes);
1724 if (substream->opened) {
1725 snd_iprintf(buffer,
1726 " Owner PID : %d\n",
1727 pid_vnr(substream->pid));
1728 runtime = substream->runtime;
1729 scoped_guard(spinlock_irq, &substream->lock) {
1730 buffer_size = runtime->buffer_size;
1731 avail = runtime->avail;
1732 }
1733 snd_iprintf(buffer,
1734 " Mode : %s\n"
1735 " Buffer size : %lu\n"
1736 " Avail : %lu\n",
1737 runtime->oss ? "OSS compatible" : "native",
1738 buffer_size, avail);
1739 }
1740 }
1741 }
1742 if (rmidi->info_flags & SNDRV_RAWMIDI_INFO_INPUT) {
1743 list_for_each_entry(substream,
1744 &rmidi->streams[SNDRV_RAWMIDI_STREAM_INPUT].substreams,
1745 list) {
1746 snd_iprintf(buffer,
1747 "Input %d\n"
1748 " Rx bytes : %lu\n",
1749 substream->number,
1750 (unsigned long) substream->bytes);
1751 if (substream->opened) {
1752 snd_iprintf(buffer,
1753 " Owner PID : %d\n",
1754 pid_vnr(substream->pid));
1755 runtime = substream->runtime;
1756 scoped_guard(spinlock_irq, &substream->lock) {
1757 buffer_size = runtime->buffer_size;
1758 avail = runtime->avail;
1759 xruns = runtime->xruns;
1760 }
1761 snd_iprintf(buffer,
1762 " Buffer size : %lu\n"
1763 " Avail : %lu\n"
1764 " Overruns : %lu\n",
1765 buffer_size, avail, xruns);
1766 if (substream->framing == SNDRV_RAWMIDI_MODE_FRAMING_TSTAMP) {
1767 clock_type = substream->clock_type >> SNDRV_RAWMIDI_MODE_CLOCK_SHIFT;
1768 if (!snd_BUG_ON(clock_type >= ARRAY_SIZE(clock_names)))
1769 snd_iprintf(buffer,
1770 " Framing : tstamp\n"
1771 " Clock type : %s\n",
1772 clock_names[clock_type]);
1773 }
1774 }
1775 }
1776 }
1777 }
1778
1779 /*
1780 * Register functions
1781 */
1782
1783 static const struct file_operations snd_rawmidi_f_ops = {
1784 .owner = THIS_MODULE,
1785 .read = snd_rawmidi_read,
1786 .write = snd_rawmidi_write,
1787 .open = snd_rawmidi_open,
1788 .release = snd_rawmidi_release,
1789 .poll = snd_rawmidi_poll,
1790 .unlocked_ioctl = snd_rawmidi_ioctl,
1791 .compat_ioctl = snd_rawmidi_ioctl_compat,
1792 };
1793
snd_rawmidi_alloc_substreams(struct snd_rawmidi * rmidi,struct snd_rawmidi_str * stream,int direction,int count)1794 static int snd_rawmidi_alloc_substreams(struct snd_rawmidi *rmidi,
1795 struct snd_rawmidi_str *stream,
1796 int direction,
1797 int count)
1798 {
1799 struct snd_rawmidi_substream *substream;
1800 int idx;
1801
1802 for (idx = 0; idx < count; idx++) {
1803 substream = kzalloc(sizeof(*substream), GFP_KERNEL);
1804 if (!substream)
1805 return -ENOMEM;
1806 substream->stream = direction;
1807 substream->number = idx;
1808 substream->rmidi = rmidi;
1809 substream->pstr = stream;
1810 spin_lock_init(&substream->lock);
1811 list_add_tail(&substream->list, &stream->substreams);
1812 stream->substream_count++;
1813 }
1814 return 0;
1815 }
1816
1817 /* used for both rawmidi and ump */
snd_rawmidi_init(struct snd_rawmidi * rmidi,struct snd_card * card,char * id,int device,int output_count,int input_count,unsigned int info_flags)1818 int snd_rawmidi_init(struct snd_rawmidi *rmidi,
1819 struct snd_card *card, char *id, int device,
1820 int output_count, int input_count,
1821 unsigned int info_flags)
1822 {
1823 int err;
1824 static const struct snd_device_ops ops = {
1825 .dev_free = snd_rawmidi_dev_free,
1826 .dev_register = snd_rawmidi_dev_register,
1827 .dev_disconnect = snd_rawmidi_dev_disconnect,
1828 };
1829
1830 rmidi->card = card;
1831 rmidi->device = device;
1832 mutex_init(&rmidi->open_mutex);
1833 init_waitqueue_head(&rmidi->open_wait);
1834 INIT_LIST_HEAD(&rmidi->streams[SNDRV_RAWMIDI_STREAM_INPUT].substreams);
1835 INIT_LIST_HEAD(&rmidi->streams[SNDRV_RAWMIDI_STREAM_OUTPUT].substreams);
1836 rmidi->info_flags = info_flags;
1837
1838 if (id != NULL)
1839 strscpy(rmidi->id, id, sizeof(rmidi->id));
1840
1841 err = snd_device_alloc(&rmidi->dev, card);
1842 if (err < 0)
1843 return err;
1844 if (rawmidi_is_ump(rmidi))
1845 dev_set_name(rmidi->dev, "umpC%iD%i", card->number, device);
1846 else
1847 dev_set_name(rmidi->dev, "midiC%iD%i", card->number, device);
1848
1849 err = snd_rawmidi_alloc_substreams(rmidi,
1850 &rmidi->streams[SNDRV_RAWMIDI_STREAM_INPUT],
1851 SNDRV_RAWMIDI_STREAM_INPUT,
1852 input_count);
1853 if (err < 0)
1854 return err;
1855 err = snd_rawmidi_alloc_substreams(rmidi,
1856 &rmidi->streams[SNDRV_RAWMIDI_STREAM_OUTPUT],
1857 SNDRV_RAWMIDI_STREAM_OUTPUT,
1858 output_count);
1859 if (err < 0)
1860 return err;
1861 err = snd_device_new(card, SNDRV_DEV_RAWMIDI, rmidi, &ops);
1862 if (err < 0)
1863 return err;
1864 return 0;
1865 }
1866 EXPORT_SYMBOL_GPL(snd_rawmidi_init);
1867
1868 /**
1869 * snd_rawmidi_new - create a rawmidi instance
1870 * @card: the card instance
1871 * @id: the id string
1872 * @device: the device index
1873 * @output_count: the number of output streams
1874 * @input_count: the number of input streams
1875 * @rrawmidi: the pointer to store the new rawmidi instance
1876 *
1877 * Creates a new rawmidi instance.
1878 * Use snd_rawmidi_set_ops() to set the operators to the new instance.
1879 *
1880 * Return: Zero if successful, or a negative error code on failure.
1881 */
snd_rawmidi_new(struct snd_card * card,char * id,int device,int output_count,int input_count,struct snd_rawmidi ** rrawmidi)1882 int snd_rawmidi_new(struct snd_card *card, char *id, int device,
1883 int output_count, int input_count,
1884 struct snd_rawmidi **rrawmidi)
1885 {
1886 struct snd_rawmidi *rmidi;
1887 int err;
1888
1889 if (rrawmidi)
1890 *rrawmidi = NULL;
1891 rmidi = kzalloc(sizeof(*rmidi), GFP_KERNEL);
1892 if (!rmidi)
1893 return -ENOMEM;
1894 err = snd_rawmidi_init(rmidi, card, id, device,
1895 output_count, input_count, 0);
1896 if (err < 0) {
1897 snd_rawmidi_free(rmidi);
1898 return err;
1899 }
1900 if (rrawmidi)
1901 *rrawmidi = rmidi;
1902 return 0;
1903 }
1904 EXPORT_SYMBOL(snd_rawmidi_new);
1905
snd_rawmidi_free_substreams(struct snd_rawmidi_str * stream)1906 static void snd_rawmidi_free_substreams(struct snd_rawmidi_str *stream)
1907 {
1908 struct snd_rawmidi_substream *substream;
1909
1910 while (!list_empty(&stream->substreams)) {
1911 substream = list_entry(stream->substreams.next, struct snd_rawmidi_substream, list);
1912 list_del(&substream->list);
1913 kfree(substream);
1914 }
1915 }
1916
1917 /* called from ump.c, too */
snd_rawmidi_free(struct snd_rawmidi * rmidi)1918 int snd_rawmidi_free(struct snd_rawmidi *rmidi)
1919 {
1920 if (!rmidi)
1921 return 0;
1922
1923 snd_info_free_entry(rmidi->proc_entry);
1924 rmidi->proc_entry = NULL;
1925 if (rmidi->ops && rmidi->ops->dev_unregister)
1926 rmidi->ops->dev_unregister(rmidi);
1927
1928 snd_rawmidi_free_substreams(&rmidi->streams[SNDRV_RAWMIDI_STREAM_INPUT]);
1929 snd_rawmidi_free_substreams(&rmidi->streams[SNDRV_RAWMIDI_STREAM_OUTPUT]);
1930 if (rmidi->private_free)
1931 rmidi->private_free(rmidi);
1932 put_device(rmidi->dev);
1933 kfree(rmidi);
1934 return 0;
1935 }
1936 EXPORT_SYMBOL_GPL(snd_rawmidi_free);
1937
snd_rawmidi_dev_free(struct snd_device * device)1938 static int snd_rawmidi_dev_free(struct snd_device *device)
1939 {
1940 struct snd_rawmidi *rmidi = device->device_data;
1941
1942 return snd_rawmidi_free(rmidi);
1943 }
1944
1945 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
snd_rawmidi_dev_seq_free(struct snd_seq_device * device)1946 static void snd_rawmidi_dev_seq_free(struct snd_seq_device *device)
1947 {
1948 struct snd_rawmidi *rmidi = device->private_data;
1949
1950 rmidi->seq_dev = NULL;
1951 }
1952 #endif
1953
snd_rawmidi_dev_register(struct snd_device * device)1954 static int snd_rawmidi_dev_register(struct snd_device *device)
1955 {
1956 int err;
1957 struct snd_info_entry *entry;
1958 char name[16];
1959 struct snd_rawmidi *rmidi = device->device_data;
1960
1961 if (rmidi->device >= SNDRV_RAWMIDI_DEVICES)
1962 return -ENOMEM;
1963 err = 0;
1964 scoped_guard(mutex, ®ister_mutex) {
1965 if (snd_rawmidi_search(rmidi->card, rmidi->device))
1966 err = -EBUSY;
1967 else
1968 list_add_tail(&rmidi->list, &snd_rawmidi_devices);
1969 }
1970 if (err < 0)
1971 return err;
1972
1973 err = snd_register_device(SNDRV_DEVICE_TYPE_RAWMIDI,
1974 rmidi->card, rmidi->device,
1975 &snd_rawmidi_f_ops, rmidi, rmidi->dev);
1976 if (err < 0) {
1977 rmidi_err(rmidi, "unable to register\n");
1978 goto error;
1979 }
1980 if (rmidi->ops && rmidi->ops->dev_register) {
1981 err = rmidi->ops->dev_register(rmidi);
1982 if (err < 0)
1983 goto error_unregister;
1984 }
1985 #ifdef CONFIG_SND_OSSEMUL
1986 rmidi->ossreg = 0;
1987 if (!rawmidi_is_ump(rmidi) &&
1988 (int)rmidi->device == midi_map[rmidi->card->number]) {
1989 if (snd_register_oss_device(SNDRV_OSS_DEVICE_TYPE_MIDI,
1990 rmidi->card, 0, &snd_rawmidi_f_ops,
1991 rmidi) < 0) {
1992 rmidi_err(rmidi,
1993 "unable to register OSS rawmidi device %i:%i\n",
1994 rmidi->card->number, 0);
1995 } else {
1996 rmidi->ossreg++;
1997 #ifdef SNDRV_OSS_INFO_DEV_MIDI
1998 snd_oss_info_register(SNDRV_OSS_INFO_DEV_MIDI, rmidi->card->number, rmidi->name);
1999 #endif
2000 }
2001 }
2002 if (!rawmidi_is_ump(rmidi) &&
2003 (int)rmidi->device == amidi_map[rmidi->card->number]) {
2004 if (snd_register_oss_device(SNDRV_OSS_DEVICE_TYPE_MIDI,
2005 rmidi->card, 1, &snd_rawmidi_f_ops,
2006 rmidi) < 0) {
2007 rmidi_err(rmidi,
2008 "unable to register OSS rawmidi device %i:%i\n",
2009 rmidi->card->number, 1);
2010 } else {
2011 rmidi->ossreg++;
2012 }
2013 }
2014 #endif /* CONFIG_SND_OSSEMUL */
2015 sprintf(name, "midi%d", rmidi->device);
2016 entry = snd_info_create_card_entry(rmidi->card, name, rmidi->card->proc_root);
2017 if (entry) {
2018 entry->private_data = rmidi;
2019 entry->c.text.read = snd_rawmidi_proc_info_read;
2020 if (snd_info_register(entry) < 0) {
2021 snd_info_free_entry(entry);
2022 entry = NULL;
2023 }
2024 }
2025 rmidi->proc_entry = entry;
2026 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
2027 /* no own registration mechanism? */
2028 if (!rmidi->ops || !rmidi->ops->dev_register) {
2029 if (snd_seq_device_new(rmidi->card, rmidi->device, SNDRV_SEQ_DEV_ID_MIDISYNTH, 0, &rmidi->seq_dev) >= 0) {
2030 rmidi->seq_dev->private_data = rmidi;
2031 rmidi->seq_dev->private_free = snd_rawmidi_dev_seq_free;
2032 sprintf(rmidi->seq_dev->name, "MIDI %d-%d", rmidi->card->number, rmidi->device);
2033 snd_device_register(rmidi->card, rmidi->seq_dev);
2034 }
2035 }
2036 #endif
2037 return 0;
2038
2039 error_unregister:
2040 snd_unregister_device(rmidi->dev);
2041 error:
2042 scoped_guard(mutex, ®ister_mutex)
2043 list_del(&rmidi->list);
2044 return err;
2045 }
2046
snd_rawmidi_dev_disconnect(struct snd_device * device)2047 static int snd_rawmidi_dev_disconnect(struct snd_device *device)
2048 {
2049 struct snd_rawmidi *rmidi = device->device_data;
2050 int dir;
2051
2052 guard(mutex)(®ister_mutex);
2053 guard(mutex)(&rmidi->open_mutex);
2054 wake_up(&rmidi->open_wait);
2055 list_del_init(&rmidi->list);
2056 for (dir = 0; dir < 2; dir++) {
2057 struct snd_rawmidi_substream *s;
2058
2059 list_for_each_entry(s, &rmidi->streams[dir].substreams, list) {
2060 if (s->runtime)
2061 wake_up(&s->runtime->sleep);
2062 }
2063 }
2064
2065 #ifdef CONFIG_SND_OSSEMUL
2066 if (rmidi->ossreg) {
2067 if ((int)rmidi->device == midi_map[rmidi->card->number]) {
2068 snd_unregister_oss_device(SNDRV_OSS_DEVICE_TYPE_MIDI, rmidi->card, 0);
2069 #ifdef SNDRV_OSS_INFO_DEV_MIDI
2070 snd_oss_info_unregister(SNDRV_OSS_INFO_DEV_MIDI, rmidi->card->number);
2071 #endif
2072 }
2073 if ((int)rmidi->device == amidi_map[rmidi->card->number])
2074 snd_unregister_oss_device(SNDRV_OSS_DEVICE_TYPE_MIDI, rmidi->card, 1);
2075 rmidi->ossreg = 0;
2076 }
2077 #endif /* CONFIG_SND_OSSEMUL */
2078 snd_unregister_device(rmidi->dev);
2079 return 0;
2080 }
2081
2082 /**
2083 * snd_rawmidi_set_ops - set the rawmidi operators
2084 * @rmidi: the rawmidi instance
2085 * @stream: the stream direction, SNDRV_RAWMIDI_STREAM_XXX
2086 * @ops: the operator table
2087 *
2088 * Sets the rawmidi operators for the given stream direction.
2089 */
snd_rawmidi_set_ops(struct snd_rawmidi * rmidi,int stream,const struct snd_rawmidi_ops * ops)2090 void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream,
2091 const struct snd_rawmidi_ops *ops)
2092 {
2093 struct snd_rawmidi_substream *substream;
2094
2095 list_for_each_entry(substream, &rmidi->streams[stream].substreams, list)
2096 substream->ops = ops;
2097 }
2098 EXPORT_SYMBOL(snd_rawmidi_set_ops);
2099
2100 /*
2101 * ENTRY functions
2102 */
2103
alsa_rawmidi_init(void)2104 static int __init alsa_rawmidi_init(void)
2105 {
2106
2107 snd_ctl_register_ioctl(snd_rawmidi_control_ioctl);
2108 snd_ctl_register_ioctl_compat(snd_rawmidi_control_ioctl);
2109 #ifdef CONFIG_SND_OSSEMUL
2110 { int i;
2111 /* check device map table */
2112 for (i = 0; i < SNDRV_CARDS; i++) {
2113 if (midi_map[i] < 0 || midi_map[i] >= SNDRV_RAWMIDI_DEVICES) {
2114 pr_err("ALSA: rawmidi: invalid midi_map[%d] = %d\n",
2115 i, midi_map[i]);
2116 midi_map[i] = 0;
2117 }
2118 if (amidi_map[i] < 0 || amidi_map[i] >= SNDRV_RAWMIDI_DEVICES) {
2119 pr_err("ALSA: rawmidi: invalid amidi_map[%d] = %d\n",
2120 i, amidi_map[i]);
2121 amidi_map[i] = 1;
2122 }
2123 }
2124 }
2125 #endif /* CONFIG_SND_OSSEMUL */
2126 return 0;
2127 }
2128
alsa_rawmidi_exit(void)2129 static void __exit alsa_rawmidi_exit(void)
2130 {
2131 snd_ctl_unregister_ioctl(snd_rawmidi_control_ioctl);
2132 snd_ctl_unregister_ioctl_compat(snd_rawmidi_control_ioctl);
2133 }
2134
2135 module_init(alsa_rawmidi_init)
2136 module_exit(alsa_rawmidi_exit)
2137