1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Abstract layer for MIDI v1.0 stream
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
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>
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>
25 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
26 MODULE_DESCRIPTION("Midlevel RawMidi code for ALSA.");
27 MODULE_LICENSE("GPL");
29 #ifdef CONFIG_SND_OSSEMUL
30 static int midi_map[SNDRV_CARDS];
31 static int amidi_map[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS-1)] = 1};
32 module_param_array(midi_map, int, NULL, 0444);
33 MODULE_PARM_DESC(midi_map, "Raw MIDI device number assigned to 1st OSS device.");
34 module_param_array(amidi_map, int, NULL, 0444);
35 MODULE_PARM_DESC(amidi_map, "Raw MIDI device number assigned to 2nd OSS device.");
36 #endif /* CONFIG_SND_OSSEMUL */
38 static int snd_rawmidi_free(struct snd_rawmidi *rmidi);
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);
43 static LIST_HEAD(snd_rawmidi_devices);
44 static DEFINE_MUTEX(register_mutex);
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)
53 struct snd_rawmidi_status32 {
55 s32 tstamp_sec; /* Timestamp */
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 */
62 #define SNDRV_RAWMIDI_IOCTL_STATUS32 _IOWR('W', 0x20, struct snd_rawmidi_status32)
64 struct snd_rawmidi_status64 {
66 u8 rsvd[4]; /* alignment */
67 s64 tstamp_sec; /* Timestamp */
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 */
74 #define SNDRV_RAWMIDI_IOCTL_STATUS64 _IOWR('W', 0x20, struct snd_rawmidi_status64)
76 static struct snd_rawmidi *snd_rawmidi_search(struct snd_card *card, int device)
78 struct snd_rawmidi *rawmidi;
80 list_for_each_entry(rawmidi, &snd_rawmidi_devices, list)
81 if (rawmidi->card == card && rawmidi->device == device)
86 static inline unsigned short snd_rawmidi_file_flags(struct file *file)
88 switch (file->f_mode & (FMODE_READ | FMODE_WRITE)) {
90 return SNDRV_RAWMIDI_LFLG_OUTPUT;
92 return SNDRV_RAWMIDI_LFLG_INPUT;
94 return SNDRV_RAWMIDI_LFLG_OPEN;
98 static inline bool __snd_rawmidi_ready(struct snd_rawmidi_runtime *runtime)
100 return runtime->avail >= runtime->avail_min;
103 static bool snd_rawmidi_ready(struct snd_rawmidi_substream *substream)
108 spin_lock_irqsave(&substream->lock, flags);
109 ready = __snd_rawmidi_ready(substream->runtime);
110 spin_unlock_irqrestore(&substream->lock, flags);
114 static inline int snd_rawmidi_ready_append(struct snd_rawmidi_substream *substream,
117 struct snd_rawmidi_runtime *runtime = substream->runtime;
119 return runtime->avail >= runtime->avail_min &&
120 (!substream->append || runtime->avail >= count);
123 static void snd_rawmidi_input_event_work(struct work_struct *work)
125 struct snd_rawmidi_runtime *runtime =
126 container_of(work, struct snd_rawmidi_runtime, event_work);
129 runtime->event(runtime->substream);
132 /* buffer refcount management: call with substream->lock held */
133 static inline void snd_rawmidi_buffer_ref(struct snd_rawmidi_runtime *runtime)
135 runtime->buffer_ref++;
138 static inline void snd_rawmidi_buffer_unref(struct snd_rawmidi_runtime *runtime)
140 runtime->buffer_ref--;
143 static void snd_rawmidi_buffer_ref_sync(struct snd_rawmidi_substream *substream)
147 spin_lock_irq(&substream->lock);
148 while (substream->runtime->buffer_ref) {
149 spin_unlock_irq(&substream->lock);
151 rmidi_err(substream->rmidi, "Buffer ref sync timeout\n");
154 schedule_timeout_uninterruptible(1);
155 spin_lock_irq(&substream->lock);
157 spin_unlock_irq(&substream->lock);
160 static int snd_rawmidi_runtime_create(struct snd_rawmidi_substream *substream)
162 struct snd_rawmidi_runtime *runtime;
164 runtime = kzalloc(sizeof(*runtime), GFP_KERNEL);
167 runtime->substream = substream;
168 init_waitqueue_head(&runtime->sleep);
169 INIT_WORK(&runtime->event_work, snd_rawmidi_input_event_work);
170 runtime->event = NULL;
171 runtime->buffer_size = PAGE_SIZE;
172 runtime->avail_min = 1;
173 if (substream->stream == SNDRV_RAWMIDI_STREAM_INPUT)
176 runtime->avail = runtime->buffer_size;
177 runtime->buffer = kvzalloc(runtime->buffer_size, GFP_KERNEL);
178 if (!runtime->buffer) {
182 runtime->appl_ptr = runtime->hw_ptr = 0;
183 substream->runtime = runtime;
187 static int snd_rawmidi_runtime_free(struct snd_rawmidi_substream *substream)
189 struct snd_rawmidi_runtime *runtime = substream->runtime;
191 kvfree(runtime->buffer);
193 substream->runtime = NULL;
197 static inline void snd_rawmidi_output_trigger(struct snd_rawmidi_substream *substream, int up)
199 if (!substream->opened)
201 substream->ops->trigger(substream, up);
204 static void snd_rawmidi_input_trigger(struct snd_rawmidi_substream *substream, int up)
206 if (!substream->opened)
208 substream->ops->trigger(substream, up);
210 cancel_work_sync(&substream->runtime->event_work);
213 static void __reset_runtime_ptrs(struct snd_rawmidi_runtime *runtime,
217 runtime->appl_ptr = runtime->hw_ptr = 0;
218 runtime->avail = is_input ? 0 : runtime->buffer_size;
221 static void reset_runtime_ptrs(struct snd_rawmidi_substream *substream,
226 spin_lock_irqsave(&substream->lock, flags);
227 if (substream->opened && substream->runtime)
228 __reset_runtime_ptrs(substream->runtime, is_input);
229 spin_unlock_irqrestore(&substream->lock, flags);
232 int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream)
234 snd_rawmidi_output_trigger(substream, 0);
235 reset_runtime_ptrs(substream, false);
238 EXPORT_SYMBOL(snd_rawmidi_drop_output);
240 int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream)
244 struct snd_rawmidi_runtime *runtime;
246 spin_lock_irq(&substream->lock);
247 runtime = substream->runtime;
248 if (!substream->opened || !runtime || !runtime->buffer) {
251 snd_rawmidi_buffer_ref(runtime);
254 spin_unlock_irq(&substream->lock);
258 timeout = wait_event_interruptible_timeout(runtime->sleep,
259 (runtime->avail >= runtime->buffer_size),
262 spin_lock_irq(&substream->lock);
263 if (signal_pending(current))
265 if (runtime->avail < runtime->buffer_size && !timeout) {
266 rmidi_warn(substream->rmidi,
267 "rawmidi drain error (avail = %li, buffer_size = %li)\n",
268 (long)runtime->avail, (long)runtime->buffer_size);
272 spin_unlock_irq(&substream->lock);
274 if (err != -ERESTARTSYS) {
275 /* we need wait a while to make sure that Tx FIFOs are empty */
276 if (substream->ops->drain)
277 substream->ops->drain(substream);
280 snd_rawmidi_drop_output(substream);
283 spin_lock_irq(&substream->lock);
284 snd_rawmidi_buffer_unref(runtime);
285 spin_unlock_irq(&substream->lock);
289 EXPORT_SYMBOL(snd_rawmidi_drain_output);
291 int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream)
293 snd_rawmidi_input_trigger(substream, 0);
294 reset_runtime_ptrs(substream, true);
297 EXPORT_SYMBOL(snd_rawmidi_drain_input);
299 /* look for an available substream for the given stream direction;
300 * if a specific subdevice is given, try to assign it
302 static int assign_substream(struct snd_rawmidi *rmidi, int subdevice,
303 int stream, int mode,
304 struct snd_rawmidi_substream **sub_ret)
306 struct snd_rawmidi_substream *substream;
307 struct snd_rawmidi_str *s = &rmidi->streams[stream];
308 static const unsigned int info_flags[2] = {
309 [SNDRV_RAWMIDI_STREAM_OUTPUT] = SNDRV_RAWMIDI_INFO_OUTPUT,
310 [SNDRV_RAWMIDI_STREAM_INPUT] = SNDRV_RAWMIDI_INFO_INPUT,
313 if (!(rmidi->info_flags & info_flags[stream]))
315 if (subdevice >= 0 && subdevice >= s->substream_count)
318 list_for_each_entry(substream, &s->substreams, list) {
319 if (substream->opened) {
320 if (stream == SNDRV_RAWMIDI_STREAM_INPUT ||
321 !(mode & SNDRV_RAWMIDI_LFLG_APPEND) ||
325 if (subdevice < 0 || subdevice == substream->number) {
326 *sub_ret = substream;
333 /* open and do ref-counting for the given substream */
334 static int open_substream(struct snd_rawmidi *rmidi,
335 struct snd_rawmidi_substream *substream,
340 if (substream->use_count == 0) {
341 err = snd_rawmidi_runtime_create(substream);
344 err = substream->ops->open(substream);
346 snd_rawmidi_runtime_free(substream);
349 spin_lock_irq(&substream->lock);
350 substream->opened = 1;
351 substream->active_sensing = 0;
352 if (mode & SNDRV_RAWMIDI_LFLG_APPEND)
353 substream->append = 1;
354 substream->pid = get_pid(task_pid(current));
355 rmidi->streams[substream->stream].substream_opened++;
356 spin_unlock_irq(&substream->lock);
358 substream->use_count++;
362 static void close_substream(struct snd_rawmidi *rmidi,
363 struct snd_rawmidi_substream *substream,
366 static int rawmidi_open_priv(struct snd_rawmidi *rmidi, int subdevice, int mode,
367 struct snd_rawmidi_file *rfile)
369 struct snd_rawmidi_substream *sinput = NULL, *soutput = NULL;
372 rfile->input = rfile->output = NULL;
373 if (mode & SNDRV_RAWMIDI_LFLG_INPUT) {
374 err = assign_substream(rmidi, subdevice,
375 SNDRV_RAWMIDI_STREAM_INPUT,
380 if (mode & SNDRV_RAWMIDI_LFLG_OUTPUT) {
381 err = assign_substream(rmidi, subdevice,
382 SNDRV_RAWMIDI_STREAM_OUTPUT,
389 err = open_substream(rmidi, sinput, mode);
394 err = open_substream(rmidi, soutput, mode);
397 close_substream(rmidi, sinput, 0);
402 rfile->rmidi = rmidi;
403 rfile->input = sinput;
404 rfile->output = soutput;
408 /* called from sound/core/seq/seq_midi.c */
409 int snd_rawmidi_kernel_open(struct snd_card *card, int device, int subdevice,
410 int mode, struct snd_rawmidi_file *rfile)
412 struct snd_rawmidi *rmidi;
415 if (snd_BUG_ON(!rfile))
418 mutex_lock(®ister_mutex);
419 rmidi = snd_rawmidi_search(card, device);
422 else if (!try_module_get(rmidi->card->module))
424 mutex_unlock(®ister_mutex);
428 mutex_lock(&rmidi->open_mutex);
429 err = rawmidi_open_priv(rmidi, subdevice, mode, rfile);
430 mutex_unlock(&rmidi->open_mutex);
432 module_put(rmidi->card->module);
435 EXPORT_SYMBOL(snd_rawmidi_kernel_open);
437 static int snd_rawmidi_open(struct inode *inode, struct file *file)
439 int maj = imajor(inode);
440 struct snd_card *card;
442 unsigned short fflags;
444 struct snd_rawmidi *rmidi;
445 struct snd_rawmidi_file *rawmidi_file = NULL;
446 wait_queue_entry_t wait;
448 if ((file->f_flags & O_APPEND) && !(file->f_flags & O_NONBLOCK))
449 return -EINVAL; /* invalid combination */
451 err = stream_open(inode, file);
455 if (maj == snd_major) {
456 rmidi = snd_lookup_minor_data(iminor(inode),
457 SNDRV_DEVICE_TYPE_RAWMIDI);
458 #ifdef CONFIG_SND_OSSEMUL
459 } else if (maj == SOUND_MAJOR) {
460 rmidi = snd_lookup_oss_minor_data(iminor(inode),
461 SNDRV_OSS_DEVICE_TYPE_MIDI);
469 if (!try_module_get(rmidi->card->module)) {
470 snd_card_unref(rmidi->card);
474 mutex_lock(&rmidi->open_mutex);
476 err = snd_card_file_add(card, file);
479 fflags = snd_rawmidi_file_flags(file);
480 if ((file->f_flags & O_APPEND) || maj == SOUND_MAJOR) /* OSS emul? */
481 fflags |= SNDRV_RAWMIDI_LFLG_APPEND;
482 rawmidi_file = kmalloc(sizeof(*rawmidi_file), GFP_KERNEL);
483 if (rawmidi_file == NULL) {
487 rawmidi_file->user_pversion = 0;
488 init_waitqueue_entry(&wait, current);
489 add_wait_queue(&rmidi->open_wait, &wait);
491 subdevice = snd_ctl_get_preferred_subdevice(card, SND_CTL_SUBDEV_RAWMIDI);
492 err = rawmidi_open_priv(rmidi, subdevice, fflags, rawmidi_file);
495 if (err == -EAGAIN) {
496 if (file->f_flags & O_NONBLOCK) {
502 set_current_state(TASK_INTERRUPTIBLE);
503 mutex_unlock(&rmidi->open_mutex);
505 mutex_lock(&rmidi->open_mutex);
506 if (rmidi->card->shutdown) {
510 if (signal_pending(current)) {
515 remove_wait_queue(&rmidi->open_wait, &wait);
520 #ifdef CONFIG_SND_OSSEMUL
521 if (rawmidi_file->input && rawmidi_file->input->runtime)
522 rawmidi_file->input->runtime->oss = (maj == SOUND_MAJOR);
523 if (rawmidi_file->output && rawmidi_file->output->runtime)
524 rawmidi_file->output->runtime->oss = (maj == SOUND_MAJOR);
526 file->private_data = rawmidi_file;
527 mutex_unlock(&rmidi->open_mutex);
528 snd_card_unref(rmidi->card);
532 snd_card_file_remove(card, file);
534 mutex_unlock(&rmidi->open_mutex);
535 module_put(rmidi->card->module);
536 snd_card_unref(rmidi->card);
540 static void close_substream(struct snd_rawmidi *rmidi,
541 struct snd_rawmidi_substream *substream,
544 if (--substream->use_count)
548 if (substream->stream == SNDRV_RAWMIDI_STREAM_INPUT)
549 snd_rawmidi_input_trigger(substream, 0);
551 if (substream->active_sensing) {
552 unsigned char buf = 0xfe;
553 /* sending single active sensing message
554 * to shut the device up
556 snd_rawmidi_kernel_write(substream, &buf, 1);
558 if (snd_rawmidi_drain_output(substream) == -ERESTARTSYS)
559 snd_rawmidi_output_trigger(substream, 0);
561 snd_rawmidi_buffer_ref_sync(substream);
563 spin_lock_irq(&substream->lock);
564 substream->opened = 0;
565 substream->append = 0;
566 spin_unlock_irq(&substream->lock);
567 substream->ops->close(substream);
568 if (substream->runtime->private_free)
569 substream->runtime->private_free(substream);
570 snd_rawmidi_runtime_free(substream);
571 put_pid(substream->pid);
572 substream->pid = NULL;
573 rmidi->streams[substream->stream].substream_opened--;
576 static void rawmidi_release_priv(struct snd_rawmidi_file *rfile)
578 struct snd_rawmidi *rmidi;
580 rmidi = rfile->rmidi;
581 mutex_lock(&rmidi->open_mutex);
583 close_substream(rmidi, rfile->input, 1);
587 close_substream(rmidi, rfile->output, 1);
588 rfile->output = NULL;
591 mutex_unlock(&rmidi->open_mutex);
592 wake_up(&rmidi->open_wait);
595 /* called from sound/core/seq/seq_midi.c */
596 int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile)
598 struct snd_rawmidi *rmidi;
600 if (snd_BUG_ON(!rfile))
603 rmidi = rfile->rmidi;
604 rawmidi_release_priv(rfile);
605 module_put(rmidi->card->module);
608 EXPORT_SYMBOL(snd_rawmidi_kernel_release);
610 static int snd_rawmidi_release(struct inode *inode, struct file *file)
612 struct snd_rawmidi_file *rfile;
613 struct snd_rawmidi *rmidi;
614 struct module *module;
616 rfile = file->private_data;
617 rmidi = rfile->rmidi;
618 rawmidi_release_priv(rfile);
620 module = rmidi->card->module;
621 snd_card_file_remove(rmidi->card, file);
626 static int snd_rawmidi_info(struct snd_rawmidi_substream *substream,
627 struct snd_rawmidi_info *info)
629 struct snd_rawmidi *rmidi;
631 if (substream == NULL)
633 rmidi = substream->rmidi;
634 memset(info, 0, sizeof(*info));
635 info->card = rmidi->card->number;
636 info->device = rmidi->device;
637 info->subdevice = substream->number;
638 info->stream = substream->stream;
639 info->flags = rmidi->info_flags;
640 strcpy(info->id, rmidi->id);
641 strcpy(info->name, rmidi->name);
642 strcpy(info->subname, substream->name);
643 info->subdevices_count = substream->pstr->substream_count;
644 info->subdevices_avail = (substream->pstr->substream_count -
645 substream->pstr->substream_opened);
649 static int snd_rawmidi_info_user(struct snd_rawmidi_substream *substream,
650 struct snd_rawmidi_info __user *_info)
652 struct snd_rawmidi_info info;
655 err = snd_rawmidi_info(substream, &info);
658 if (copy_to_user(_info, &info, sizeof(struct snd_rawmidi_info)))
663 static int __snd_rawmidi_info_select(struct snd_card *card,
664 struct snd_rawmidi_info *info)
666 struct snd_rawmidi *rmidi;
667 struct snd_rawmidi_str *pstr;
668 struct snd_rawmidi_substream *substream;
670 rmidi = snd_rawmidi_search(card, info->device);
673 if (info->stream < 0 || info->stream > 1)
675 info->stream = array_index_nospec(info->stream, 2);
676 pstr = &rmidi->streams[info->stream];
677 if (pstr->substream_count == 0)
679 if (info->subdevice >= pstr->substream_count)
681 list_for_each_entry(substream, &pstr->substreams, list) {
682 if ((unsigned int)substream->number == info->subdevice)
683 return snd_rawmidi_info(substream, info);
688 int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info)
692 mutex_lock(®ister_mutex);
693 ret = __snd_rawmidi_info_select(card, info);
694 mutex_unlock(®ister_mutex);
697 EXPORT_SYMBOL(snd_rawmidi_info_select);
699 static int snd_rawmidi_info_select_user(struct snd_card *card,
700 struct snd_rawmidi_info __user *_info)
703 struct snd_rawmidi_info info;
705 if (get_user(info.device, &_info->device))
707 if (get_user(info.stream, &_info->stream))
709 if (get_user(info.subdevice, &_info->subdevice))
711 err = snd_rawmidi_info_select(card, &info);
714 if (copy_to_user(_info, &info, sizeof(struct snd_rawmidi_info)))
719 static int resize_runtime_buffer(struct snd_rawmidi_substream *substream,
720 struct snd_rawmidi_params *params,
723 struct snd_rawmidi_runtime *runtime = substream->runtime;
724 char *newbuf, *oldbuf;
725 unsigned int framing = params->mode & SNDRV_RAWMIDI_MODE_FRAMING_MASK;
727 if (params->buffer_size < 32 || params->buffer_size > 1024L * 1024L)
729 if (framing == SNDRV_RAWMIDI_MODE_FRAMING_TSTAMP && (params->buffer_size & 0x1f) != 0)
731 if (params->avail_min < 1 || params->avail_min > params->buffer_size)
733 if (params->buffer_size != runtime->buffer_size) {
734 newbuf = kvzalloc(params->buffer_size, GFP_KERNEL);
737 spin_lock_irq(&substream->lock);
738 if (runtime->buffer_ref) {
739 spin_unlock_irq(&substream->lock);
743 oldbuf = runtime->buffer;
744 runtime->buffer = newbuf;
745 runtime->buffer_size = params->buffer_size;
746 __reset_runtime_ptrs(runtime, is_input);
747 spin_unlock_irq(&substream->lock);
750 runtime->avail_min = params->avail_min;
754 int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream,
755 struct snd_rawmidi_params *params)
759 snd_rawmidi_drain_output(substream);
760 mutex_lock(&substream->rmidi->open_mutex);
761 if (substream->append && substream->use_count > 1)
764 err = resize_runtime_buffer(substream, params, false);
767 substream->active_sensing = !params->no_active_sensing;
768 mutex_unlock(&substream->rmidi->open_mutex);
771 EXPORT_SYMBOL(snd_rawmidi_output_params);
773 int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream,
774 struct snd_rawmidi_params *params)
776 unsigned int framing = params->mode & SNDRV_RAWMIDI_MODE_FRAMING_MASK;
777 unsigned int clock_type = params->mode & SNDRV_RAWMIDI_MODE_CLOCK_MASK;
780 snd_rawmidi_drain_input(substream);
781 mutex_lock(&substream->rmidi->open_mutex);
782 if (framing == SNDRV_RAWMIDI_MODE_FRAMING_NONE && clock_type != SNDRV_RAWMIDI_MODE_CLOCK_NONE)
784 else if (clock_type > SNDRV_RAWMIDI_MODE_CLOCK_MONOTONIC_RAW)
786 else if (framing > SNDRV_RAWMIDI_MODE_FRAMING_TSTAMP)
789 err = resize_runtime_buffer(substream, params, true);
792 substream->framing = framing;
793 substream->clock_type = clock_type;
795 mutex_unlock(&substream->rmidi->open_mutex);
798 EXPORT_SYMBOL(snd_rawmidi_input_params);
800 static int snd_rawmidi_output_status(struct snd_rawmidi_substream *substream,
801 struct snd_rawmidi_status64 *status)
803 struct snd_rawmidi_runtime *runtime = substream->runtime;
805 memset(status, 0, sizeof(*status));
806 status->stream = SNDRV_RAWMIDI_STREAM_OUTPUT;
807 spin_lock_irq(&substream->lock);
808 status->avail = runtime->avail;
809 spin_unlock_irq(&substream->lock);
813 static int snd_rawmidi_input_status(struct snd_rawmidi_substream *substream,
814 struct snd_rawmidi_status64 *status)
816 struct snd_rawmidi_runtime *runtime = substream->runtime;
818 memset(status, 0, sizeof(*status));
819 status->stream = SNDRV_RAWMIDI_STREAM_INPUT;
820 spin_lock_irq(&substream->lock);
821 status->avail = runtime->avail;
822 status->xruns = runtime->xruns;
824 spin_unlock_irq(&substream->lock);
828 static int snd_rawmidi_ioctl_status32(struct snd_rawmidi_file *rfile,
829 struct snd_rawmidi_status32 __user *argp)
832 struct snd_rawmidi_status32 __user *status = argp;
833 struct snd_rawmidi_status32 status32;
834 struct snd_rawmidi_status64 status64;
836 if (copy_from_user(&status32, argp,
837 sizeof(struct snd_rawmidi_status32)))
840 switch (status32.stream) {
841 case SNDRV_RAWMIDI_STREAM_OUTPUT:
842 if (rfile->output == NULL)
844 err = snd_rawmidi_output_status(rfile->output, &status64);
846 case SNDRV_RAWMIDI_STREAM_INPUT:
847 if (rfile->input == NULL)
849 err = snd_rawmidi_input_status(rfile->input, &status64);
857 status32 = (struct snd_rawmidi_status32) {
858 .stream = status64.stream,
859 .tstamp_sec = status64.tstamp_sec,
860 .tstamp_nsec = status64.tstamp_nsec,
861 .avail = status64.avail,
862 .xruns = status64.xruns,
865 if (copy_to_user(status, &status32, sizeof(*status)))
871 static int snd_rawmidi_ioctl_status64(struct snd_rawmidi_file *rfile,
872 struct snd_rawmidi_status64 __user *argp)
875 struct snd_rawmidi_status64 status;
877 if (copy_from_user(&status, argp, sizeof(struct snd_rawmidi_status64)))
880 switch (status.stream) {
881 case SNDRV_RAWMIDI_STREAM_OUTPUT:
882 if (rfile->output == NULL)
884 err = snd_rawmidi_output_status(rfile->output, &status);
886 case SNDRV_RAWMIDI_STREAM_INPUT:
887 if (rfile->input == NULL)
889 err = snd_rawmidi_input_status(rfile->input, &status);
896 if (copy_to_user(argp, &status,
897 sizeof(struct snd_rawmidi_status64)))
902 static long snd_rawmidi_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
904 struct snd_rawmidi_file *rfile;
905 void __user *argp = (void __user *)arg;
907 rfile = file->private_data;
908 if (((cmd >> 8) & 0xff) != 'W')
911 case SNDRV_RAWMIDI_IOCTL_PVERSION:
912 return put_user(SNDRV_RAWMIDI_VERSION, (int __user *)argp) ? -EFAULT : 0;
913 case SNDRV_RAWMIDI_IOCTL_INFO:
916 struct snd_rawmidi_info __user *info = argp;
918 if (get_user(stream, &info->stream))
921 case SNDRV_RAWMIDI_STREAM_INPUT:
922 return snd_rawmidi_info_user(rfile->input, info);
923 case SNDRV_RAWMIDI_STREAM_OUTPUT:
924 return snd_rawmidi_info_user(rfile->output, info);
929 case SNDRV_RAWMIDI_IOCTL_USER_PVERSION:
930 if (get_user(rfile->user_pversion, (unsigned int __user *)arg))
934 case SNDRV_RAWMIDI_IOCTL_PARAMS:
936 struct snd_rawmidi_params params;
938 if (copy_from_user(¶ms, argp, sizeof(struct snd_rawmidi_params)))
940 if (rfile->user_pversion < SNDRV_PROTOCOL_VERSION(2, 0, 2)) {
942 memset(params.reserved, 0, sizeof(params.reserved));
944 switch (params.stream) {
945 case SNDRV_RAWMIDI_STREAM_OUTPUT:
946 if (rfile->output == NULL)
948 return snd_rawmidi_output_params(rfile->output, ¶ms);
949 case SNDRV_RAWMIDI_STREAM_INPUT:
950 if (rfile->input == NULL)
952 return snd_rawmidi_input_params(rfile->input, ¶ms);
957 case SNDRV_RAWMIDI_IOCTL_STATUS32:
958 return snd_rawmidi_ioctl_status32(rfile, argp);
959 case SNDRV_RAWMIDI_IOCTL_STATUS64:
960 return snd_rawmidi_ioctl_status64(rfile, argp);
961 case SNDRV_RAWMIDI_IOCTL_DROP:
965 if (get_user(val, (int __user *) argp))
968 case SNDRV_RAWMIDI_STREAM_OUTPUT:
969 if (rfile->output == NULL)
971 return snd_rawmidi_drop_output(rfile->output);
976 case SNDRV_RAWMIDI_IOCTL_DRAIN:
980 if (get_user(val, (int __user *) argp))
983 case SNDRV_RAWMIDI_STREAM_OUTPUT:
984 if (rfile->output == NULL)
986 return snd_rawmidi_drain_output(rfile->output);
987 case SNDRV_RAWMIDI_STREAM_INPUT:
988 if (rfile->input == NULL)
990 return snd_rawmidi_drain_input(rfile->input);
996 rmidi_dbg(rfile->rmidi,
997 "rawmidi: unknown command = 0x%x\n", cmd);
1002 static int snd_rawmidi_control_ioctl(struct snd_card *card,
1003 struct snd_ctl_file *control,
1007 void __user *argp = (void __user *)arg;
1010 case SNDRV_CTL_IOCTL_RAWMIDI_NEXT_DEVICE:
1014 if (get_user(device, (int __user *)argp))
1016 if (device >= SNDRV_RAWMIDI_DEVICES) /* next device is -1 */
1017 device = SNDRV_RAWMIDI_DEVICES - 1;
1018 mutex_lock(®ister_mutex);
1019 device = device < 0 ? 0 : device + 1;
1020 while (device < SNDRV_RAWMIDI_DEVICES) {
1021 if (snd_rawmidi_search(card, device))
1025 if (device == SNDRV_RAWMIDI_DEVICES)
1027 mutex_unlock(®ister_mutex);
1028 if (put_user(device, (int __user *)argp))
1032 case SNDRV_CTL_IOCTL_RAWMIDI_PREFER_SUBDEVICE:
1036 if (get_user(val, (int __user *)argp))
1038 control->preferred_subdevice[SND_CTL_SUBDEV_RAWMIDI] = val;
1041 case SNDRV_CTL_IOCTL_RAWMIDI_INFO:
1042 return snd_rawmidi_info_select_user(card, argp);
1044 return -ENOIOCTLCMD;
1047 static int receive_with_tstamp_framing(struct snd_rawmidi_substream *substream,
1048 const unsigned char *buffer, int src_count, const struct timespec64 *tstamp)
1050 struct snd_rawmidi_runtime *runtime = substream->runtime;
1051 struct snd_rawmidi_framing_tstamp *dest_ptr;
1052 struct snd_rawmidi_framing_tstamp frame = { .tv_sec = tstamp->tv_sec, .tv_nsec = tstamp->tv_nsec };
1053 int dest_frames = 0;
1054 int orig_count = src_count;
1055 int frame_size = sizeof(struct snd_rawmidi_framing_tstamp);
1057 BUILD_BUG_ON(frame_size != 0x20);
1058 if (snd_BUG_ON((runtime->hw_ptr & 0x1f) != 0))
1061 while (src_count > 0) {
1062 if ((int)(runtime->buffer_size - runtime->avail) < frame_size) {
1063 runtime->xruns += src_count;
1066 if (src_count >= SNDRV_RAWMIDI_FRAMING_DATA_LENGTH)
1067 frame.length = SNDRV_RAWMIDI_FRAMING_DATA_LENGTH;
1069 frame.length = src_count;
1070 memset(frame.data, 0, SNDRV_RAWMIDI_FRAMING_DATA_LENGTH);
1072 memcpy(frame.data, buffer, frame.length);
1073 buffer += frame.length;
1074 src_count -= frame.length;
1075 dest_ptr = (struct snd_rawmidi_framing_tstamp *) (runtime->buffer + runtime->hw_ptr);
1077 runtime->avail += frame_size;
1078 runtime->hw_ptr += frame_size;
1079 runtime->hw_ptr %= runtime->buffer_size;
1082 return orig_count - src_count;
1085 static struct timespec64 get_framing_tstamp(struct snd_rawmidi_substream *substream)
1087 struct timespec64 ts64 = {0, 0};
1089 switch (substream->clock_type) {
1090 case SNDRV_RAWMIDI_MODE_CLOCK_MONOTONIC_RAW:
1091 ktime_get_raw_ts64(&ts64);
1093 case SNDRV_RAWMIDI_MODE_CLOCK_MONOTONIC:
1094 ktime_get_ts64(&ts64);
1096 case SNDRV_RAWMIDI_MODE_CLOCK_REALTIME:
1097 ktime_get_real_ts64(&ts64);
1104 * snd_rawmidi_receive - receive the input data from the device
1105 * @substream: the rawmidi substream
1106 * @buffer: the buffer pointer
1107 * @count: the data size to read
1109 * Reads the data from the internal buffer.
1111 * Return: The size of read data, or a negative error code on failure.
1113 int snd_rawmidi_receive(struct snd_rawmidi_substream *substream,
1114 const unsigned char *buffer, int count)
1116 unsigned long flags;
1117 struct timespec64 ts64 = get_framing_tstamp(substream);
1118 int result = 0, count1;
1119 struct snd_rawmidi_runtime *runtime;
1121 spin_lock_irqsave(&substream->lock, flags);
1122 if (!substream->opened) {
1126 runtime = substream->runtime;
1127 if (!runtime || !runtime->buffer) {
1128 rmidi_dbg(substream->rmidi,
1129 "snd_rawmidi_receive: input is not active!!!\n");
1134 if (substream->framing == SNDRV_RAWMIDI_MODE_FRAMING_TSTAMP) {
1135 result = receive_with_tstamp_framing(substream, buffer, count, &ts64);
1136 } else if (count == 1) { /* special case, faster code */
1138 if (runtime->avail < runtime->buffer_size) {
1139 runtime->buffer[runtime->hw_ptr++] = buffer[0];
1140 runtime->hw_ptr %= runtime->buffer_size;
1147 substream->bytes += count;
1148 count1 = runtime->buffer_size - runtime->hw_ptr;
1151 if (count1 > (int)(runtime->buffer_size - runtime->avail))
1152 count1 = runtime->buffer_size - runtime->avail;
1153 memcpy(runtime->buffer + runtime->hw_ptr, buffer, count1);
1154 runtime->hw_ptr += count1;
1155 runtime->hw_ptr %= runtime->buffer_size;
1156 runtime->avail += count1;
1162 if (count1 > (int)(runtime->buffer_size - runtime->avail)) {
1163 count1 = runtime->buffer_size - runtime->avail;
1164 runtime->xruns += count - count1;
1167 memcpy(runtime->buffer, buffer, count1);
1168 runtime->hw_ptr = count1;
1169 runtime->avail += count1;
1176 schedule_work(&runtime->event_work);
1177 else if (__snd_rawmidi_ready(runtime))
1178 wake_up(&runtime->sleep);
1181 spin_unlock_irqrestore(&substream->lock, flags);
1184 EXPORT_SYMBOL(snd_rawmidi_receive);
1186 static long snd_rawmidi_kernel_read1(struct snd_rawmidi_substream *substream,
1187 unsigned char __user *userbuf,
1188 unsigned char *kernelbuf, long count)
1190 unsigned long flags;
1191 long result = 0, count1;
1192 struct snd_rawmidi_runtime *runtime = substream->runtime;
1193 unsigned long appl_ptr;
1196 spin_lock_irqsave(&substream->lock, flags);
1197 snd_rawmidi_buffer_ref(runtime);
1198 while (count > 0 && runtime->avail) {
1199 count1 = runtime->buffer_size - runtime->appl_ptr;
1202 if (count1 > (int)runtime->avail)
1203 count1 = runtime->avail;
1205 /* update runtime->appl_ptr before unlocking for userbuf */
1206 appl_ptr = runtime->appl_ptr;
1207 runtime->appl_ptr += count1;
1208 runtime->appl_ptr %= runtime->buffer_size;
1209 runtime->avail -= count1;
1212 memcpy(kernelbuf + result, runtime->buffer + appl_ptr, count1);
1214 spin_unlock_irqrestore(&substream->lock, flags);
1215 if (copy_to_user(userbuf + result,
1216 runtime->buffer + appl_ptr, count1))
1218 spin_lock_irqsave(&substream->lock, flags);
1226 snd_rawmidi_buffer_unref(runtime);
1227 spin_unlock_irqrestore(&substream->lock, flags);
1228 return result > 0 ? result : err;
1231 long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream,
1232 unsigned char *buf, long count)
1234 snd_rawmidi_input_trigger(substream, 1);
1235 return snd_rawmidi_kernel_read1(substream, NULL/*userbuf*/, buf, count);
1237 EXPORT_SYMBOL(snd_rawmidi_kernel_read);
1239 static ssize_t snd_rawmidi_read(struct file *file, char __user *buf, size_t count,
1244 struct snd_rawmidi_file *rfile;
1245 struct snd_rawmidi_substream *substream;
1246 struct snd_rawmidi_runtime *runtime;
1248 rfile = file->private_data;
1249 substream = rfile->input;
1250 if (substream == NULL)
1252 runtime = substream->runtime;
1253 snd_rawmidi_input_trigger(substream, 1);
1256 spin_lock_irq(&substream->lock);
1257 while (!__snd_rawmidi_ready(runtime)) {
1258 wait_queue_entry_t wait;
1260 if ((file->f_flags & O_NONBLOCK) != 0 || result > 0) {
1261 spin_unlock_irq(&substream->lock);
1262 return result > 0 ? result : -EAGAIN;
1264 init_waitqueue_entry(&wait, current);
1265 add_wait_queue(&runtime->sleep, &wait);
1266 set_current_state(TASK_INTERRUPTIBLE);
1267 spin_unlock_irq(&substream->lock);
1269 remove_wait_queue(&runtime->sleep, &wait);
1270 if (rfile->rmidi->card->shutdown)
1272 if (signal_pending(current))
1273 return result > 0 ? result : -ERESTARTSYS;
1274 spin_lock_irq(&substream->lock);
1275 if (!runtime->avail) {
1276 spin_unlock_irq(&substream->lock);
1277 return result > 0 ? result : -EIO;
1280 spin_unlock_irq(&substream->lock);
1281 count1 = snd_rawmidi_kernel_read1(substream,
1282 (unsigned char __user *)buf,
1286 return result > 0 ? result : count1;
1295 * snd_rawmidi_transmit_empty - check whether the output buffer is empty
1296 * @substream: the rawmidi substream
1298 * Return: 1 if the internal output buffer is empty, 0 if not.
1300 int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream)
1302 struct snd_rawmidi_runtime *runtime;
1304 unsigned long flags;
1306 spin_lock_irqsave(&substream->lock, flags);
1307 runtime = substream->runtime;
1308 if (!substream->opened || !runtime || !runtime->buffer) {
1309 rmidi_dbg(substream->rmidi,
1310 "snd_rawmidi_transmit_empty: output is not active!!!\n");
1313 result = runtime->avail >= runtime->buffer_size;
1315 spin_unlock_irqrestore(&substream->lock, flags);
1318 EXPORT_SYMBOL(snd_rawmidi_transmit_empty);
1321 * __snd_rawmidi_transmit_peek - copy data from the internal buffer
1322 * @substream: the rawmidi substream
1323 * @buffer: the buffer pointer
1324 * @count: data size to transfer
1326 * This is a variant of snd_rawmidi_transmit_peek() without spinlock.
1328 static int __snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
1329 unsigned char *buffer, int count)
1332 struct snd_rawmidi_runtime *runtime = substream->runtime;
1334 if (runtime->buffer == NULL) {
1335 rmidi_dbg(substream->rmidi,
1336 "snd_rawmidi_transmit_peek: output is not active!!!\n");
1340 if (runtime->avail >= runtime->buffer_size) {
1341 /* warning: lowlevel layer MUST trigger down the hardware */
1344 if (count == 1) { /* special case, faster code */
1345 *buffer = runtime->buffer[runtime->hw_ptr];
1348 count1 = runtime->buffer_size - runtime->hw_ptr;
1351 if (count1 > (int)(runtime->buffer_size - runtime->avail))
1352 count1 = runtime->buffer_size - runtime->avail;
1353 memcpy(buffer, runtime->buffer + runtime->hw_ptr, count1);
1357 if (count > (int)(runtime->buffer_size - runtime->avail - count1))
1358 count = runtime->buffer_size - runtime->avail - count1;
1359 memcpy(buffer + count1, runtime->buffer, count);
1368 * snd_rawmidi_transmit_peek - copy data from the internal buffer
1369 * @substream: the rawmidi substream
1370 * @buffer: the buffer pointer
1371 * @count: data size to transfer
1373 * Copies data from the internal output buffer to the given buffer.
1375 * Call this in the interrupt handler when the midi output is ready,
1376 * and call snd_rawmidi_transmit_ack() after the transmission is
1379 * Return: The size of copied data, or a negative error code on failure.
1381 int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
1382 unsigned char *buffer, int count)
1385 unsigned long flags;
1387 spin_lock_irqsave(&substream->lock, flags);
1388 if (!substream->opened || !substream->runtime)
1391 result = __snd_rawmidi_transmit_peek(substream, buffer, count);
1392 spin_unlock_irqrestore(&substream->lock, flags);
1395 EXPORT_SYMBOL(snd_rawmidi_transmit_peek);
1398 * __snd_rawmidi_transmit_ack - acknowledge the transmission
1399 * @substream: the rawmidi substream
1400 * @count: the transferred count
1402 * This is a variant of __snd_rawmidi_transmit_ack() without spinlock.
1404 static int __snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream,
1407 struct snd_rawmidi_runtime *runtime = substream->runtime;
1409 if (runtime->buffer == NULL) {
1410 rmidi_dbg(substream->rmidi,
1411 "snd_rawmidi_transmit_ack: output is not active!!!\n");
1414 snd_BUG_ON(runtime->avail + count > runtime->buffer_size);
1415 runtime->hw_ptr += count;
1416 runtime->hw_ptr %= runtime->buffer_size;
1417 runtime->avail += count;
1418 substream->bytes += count;
1420 if (runtime->drain || __snd_rawmidi_ready(runtime))
1421 wake_up(&runtime->sleep);
1427 * snd_rawmidi_transmit_ack - acknowledge the transmission
1428 * @substream: the rawmidi substream
1429 * @count: the transferred count
1431 * Advances the hardware pointer for the internal output buffer with
1432 * the given size and updates the condition.
1433 * Call after the transmission is finished.
1435 * Return: The advanced size if successful, or a negative error code on failure.
1437 int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count)
1440 unsigned long flags;
1442 spin_lock_irqsave(&substream->lock, flags);
1443 if (!substream->opened || !substream->runtime)
1446 result = __snd_rawmidi_transmit_ack(substream, count);
1447 spin_unlock_irqrestore(&substream->lock, flags);
1450 EXPORT_SYMBOL(snd_rawmidi_transmit_ack);
1453 * snd_rawmidi_transmit - copy from the buffer to the device
1454 * @substream: the rawmidi substream
1455 * @buffer: the buffer pointer
1456 * @count: the data size to transfer
1458 * Copies data from the buffer to the device and advances the pointer.
1460 * Return: The copied size if successful, or a negative error code on failure.
1462 int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream,
1463 unsigned char *buffer, int count)
1466 unsigned long flags;
1468 spin_lock_irqsave(&substream->lock, flags);
1469 if (!substream->opened)
1472 count = __snd_rawmidi_transmit_peek(substream, buffer, count);
1476 result = __snd_rawmidi_transmit_ack(substream, count);
1478 spin_unlock_irqrestore(&substream->lock, flags);
1481 EXPORT_SYMBOL(snd_rawmidi_transmit);
1484 * snd_rawmidi_proceed - Discard the all pending bytes and proceed
1485 * @substream: rawmidi substream
1487 * Return: the number of discarded bytes
1489 int snd_rawmidi_proceed(struct snd_rawmidi_substream *substream)
1491 struct snd_rawmidi_runtime *runtime;
1492 unsigned long flags;
1495 spin_lock_irqsave(&substream->lock, flags);
1496 runtime = substream->runtime;
1497 if (substream->opened && runtime &&
1498 runtime->avail < runtime->buffer_size) {
1499 count = runtime->buffer_size - runtime->avail;
1500 __snd_rawmidi_transmit_ack(substream, count);
1502 spin_unlock_irqrestore(&substream->lock, flags);
1505 EXPORT_SYMBOL(snd_rawmidi_proceed);
1507 static long snd_rawmidi_kernel_write1(struct snd_rawmidi_substream *substream,
1508 const unsigned char __user *userbuf,
1509 const unsigned char *kernelbuf,
1512 unsigned long flags;
1513 long count1, result;
1514 struct snd_rawmidi_runtime *runtime = substream->runtime;
1515 unsigned long appl_ptr;
1517 if (!kernelbuf && !userbuf)
1519 if (snd_BUG_ON(!runtime->buffer))
1523 spin_lock_irqsave(&substream->lock, flags);
1524 if (substream->append) {
1525 if ((long)runtime->avail < count) {
1526 spin_unlock_irqrestore(&substream->lock, flags);
1530 snd_rawmidi_buffer_ref(runtime);
1531 while (count > 0 && runtime->avail > 0) {
1532 count1 = runtime->buffer_size - runtime->appl_ptr;
1535 if (count1 > (long)runtime->avail)
1536 count1 = runtime->avail;
1538 /* update runtime->appl_ptr before unlocking for userbuf */
1539 appl_ptr = runtime->appl_ptr;
1540 runtime->appl_ptr += count1;
1541 runtime->appl_ptr %= runtime->buffer_size;
1542 runtime->avail -= count1;
1545 memcpy(runtime->buffer + appl_ptr,
1546 kernelbuf + result, count1);
1548 spin_unlock_irqrestore(&substream->lock, flags);
1549 if (copy_from_user(runtime->buffer + appl_ptr,
1550 userbuf + result, count1)) {
1551 spin_lock_irqsave(&substream->lock, flags);
1552 result = result > 0 ? result : -EFAULT;
1555 spin_lock_irqsave(&substream->lock, flags);
1561 count1 = runtime->avail < runtime->buffer_size;
1562 snd_rawmidi_buffer_unref(runtime);
1563 spin_unlock_irqrestore(&substream->lock, flags);
1565 snd_rawmidi_output_trigger(substream, 1);
1569 long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream,
1570 const unsigned char *buf, long count)
1572 return snd_rawmidi_kernel_write1(substream, NULL, buf, count);
1574 EXPORT_SYMBOL(snd_rawmidi_kernel_write);
1576 static ssize_t snd_rawmidi_write(struct file *file, const char __user *buf,
1577 size_t count, loff_t *offset)
1579 long result, timeout;
1581 struct snd_rawmidi_file *rfile;
1582 struct snd_rawmidi_runtime *runtime;
1583 struct snd_rawmidi_substream *substream;
1585 rfile = file->private_data;
1586 substream = rfile->output;
1587 runtime = substream->runtime;
1588 /* we cannot put an atomic message to our buffer */
1589 if (substream->append && count > runtime->buffer_size)
1593 spin_lock_irq(&substream->lock);
1594 while (!snd_rawmidi_ready_append(substream, count)) {
1595 wait_queue_entry_t wait;
1597 if (file->f_flags & O_NONBLOCK) {
1598 spin_unlock_irq(&substream->lock);
1599 return result > 0 ? result : -EAGAIN;
1601 init_waitqueue_entry(&wait, current);
1602 add_wait_queue(&runtime->sleep, &wait);
1603 set_current_state(TASK_INTERRUPTIBLE);
1604 spin_unlock_irq(&substream->lock);
1605 timeout = schedule_timeout(30 * HZ);
1606 remove_wait_queue(&runtime->sleep, &wait);
1607 if (rfile->rmidi->card->shutdown)
1609 if (signal_pending(current))
1610 return result > 0 ? result : -ERESTARTSYS;
1611 spin_lock_irq(&substream->lock);
1612 if (!runtime->avail && !timeout) {
1613 spin_unlock_irq(&substream->lock);
1614 return result > 0 ? result : -EIO;
1617 spin_unlock_irq(&substream->lock);
1618 count1 = snd_rawmidi_kernel_write1(substream, buf, NULL, count);
1620 return result > 0 ? result : count1;
1623 if ((size_t)count1 < count && (file->f_flags & O_NONBLOCK))
1627 if (file->f_flags & O_DSYNC) {
1628 spin_lock_irq(&substream->lock);
1629 while (runtime->avail != runtime->buffer_size) {
1630 wait_queue_entry_t wait;
1631 unsigned int last_avail = runtime->avail;
1633 init_waitqueue_entry(&wait, current);
1634 add_wait_queue(&runtime->sleep, &wait);
1635 set_current_state(TASK_INTERRUPTIBLE);
1636 spin_unlock_irq(&substream->lock);
1637 timeout = schedule_timeout(30 * HZ);
1638 remove_wait_queue(&runtime->sleep, &wait);
1639 if (signal_pending(current))
1640 return result > 0 ? result : -ERESTARTSYS;
1641 if (runtime->avail == last_avail && !timeout)
1642 return result > 0 ? result : -EIO;
1643 spin_lock_irq(&substream->lock);
1645 spin_unlock_irq(&substream->lock);
1650 static __poll_t snd_rawmidi_poll(struct file *file, poll_table *wait)
1652 struct snd_rawmidi_file *rfile;
1653 struct snd_rawmidi_runtime *runtime;
1656 rfile = file->private_data;
1657 if (rfile->input != NULL) {
1658 runtime = rfile->input->runtime;
1659 snd_rawmidi_input_trigger(rfile->input, 1);
1660 poll_wait(file, &runtime->sleep, wait);
1662 if (rfile->output != NULL) {
1663 runtime = rfile->output->runtime;
1664 poll_wait(file, &runtime->sleep, wait);
1667 if (rfile->input != NULL) {
1668 if (snd_rawmidi_ready(rfile->input))
1669 mask |= EPOLLIN | EPOLLRDNORM;
1671 if (rfile->output != NULL) {
1672 if (snd_rawmidi_ready(rfile->output))
1673 mask |= EPOLLOUT | EPOLLWRNORM;
1680 #ifdef CONFIG_COMPAT
1681 #include "rawmidi_compat.c"
1683 #define snd_rawmidi_ioctl_compat NULL
1689 static void snd_rawmidi_proc_info_read(struct snd_info_entry *entry,
1690 struct snd_info_buffer *buffer)
1692 struct snd_rawmidi *rmidi;
1693 struct snd_rawmidi_substream *substream;
1694 struct snd_rawmidi_runtime *runtime;
1695 unsigned long buffer_size, avail, xruns;
1696 unsigned int clock_type;
1697 static const char *clock_names[4] = { "none", "realtime", "monotonic", "monotonic raw" };
1699 rmidi = entry->private_data;
1700 snd_iprintf(buffer, "%s\n\n", rmidi->name);
1701 mutex_lock(&rmidi->open_mutex);
1702 if (rmidi->info_flags & SNDRV_RAWMIDI_INFO_OUTPUT) {
1703 list_for_each_entry(substream,
1704 &rmidi->streams[SNDRV_RAWMIDI_STREAM_OUTPUT].substreams,
1708 " Tx bytes : %lu\n",
1710 (unsigned long) substream->bytes);
1711 if (substream->opened) {
1713 " Owner PID : %d\n",
1714 pid_vnr(substream->pid));
1715 runtime = substream->runtime;
1716 spin_lock_irq(&substream->lock);
1717 buffer_size = runtime->buffer_size;
1718 avail = runtime->avail;
1719 spin_unlock_irq(&substream->lock);
1722 " Buffer size : %lu\n"
1724 runtime->oss ? "OSS compatible" : "native",
1725 buffer_size, avail);
1729 if (rmidi->info_flags & SNDRV_RAWMIDI_INFO_INPUT) {
1730 list_for_each_entry(substream,
1731 &rmidi->streams[SNDRV_RAWMIDI_STREAM_INPUT].substreams,
1735 " Rx bytes : %lu\n",
1737 (unsigned long) substream->bytes);
1738 if (substream->opened) {
1740 " Owner PID : %d\n",
1741 pid_vnr(substream->pid));
1742 runtime = substream->runtime;
1743 spin_lock_irq(&substream->lock);
1744 buffer_size = runtime->buffer_size;
1745 avail = runtime->avail;
1746 xruns = runtime->xruns;
1747 spin_unlock_irq(&substream->lock);
1749 " Buffer size : %lu\n"
1751 " Overruns : %lu\n",
1752 buffer_size, avail, xruns);
1753 if (substream->framing == SNDRV_RAWMIDI_MODE_FRAMING_TSTAMP) {
1754 clock_type = substream->clock_type >> SNDRV_RAWMIDI_MODE_CLOCK_SHIFT;
1755 if (!snd_BUG_ON(clock_type >= ARRAY_SIZE(clock_names)))
1757 " Framing : tstamp\n"
1758 " Clock type : %s\n",
1759 clock_names[clock_type]);
1764 mutex_unlock(&rmidi->open_mutex);
1768 * Register functions
1771 static const struct file_operations snd_rawmidi_f_ops = {
1772 .owner = THIS_MODULE,
1773 .read = snd_rawmidi_read,
1774 .write = snd_rawmidi_write,
1775 .open = snd_rawmidi_open,
1776 .release = snd_rawmidi_release,
1777 .llseek = no_llseek,
1778 .poll = snd_rawmidi_poll,
1779 .unlocked_ioctl = snd_rawmidi_ioctl,
1780 .compat_ioctl = snd_rawmidi_ioctl_compat,
1783 static int snd_rawmidi_alloc_substreams(struct snd_rawmidi *rmidi,
1784 struct snd_rawmidi_str *stream,
1788 struct snd_rawmidi_substream *substream;
1791 for (idx = 0; idx < count; idx++) {
1792 substream = kzalloc(sizeof(*substream), GFP_KERNEL);
1795 substream->stream = direction;
1796 substream->number = idx;
1797 substream->rmidi = rmidi;
1798 substream->pstr = stream;
1799 spin_lock_init(&substream->lock);
1800 list_add_tail(&substream->list, &stream->substreams);
1801 stream->substream_count++;
1806 static void release_rawmidi_device(struct device *dev)
1808 kfree(container_of(dev, struct snd_rawmidi, dev));
1812 * snd_rawmidi_new - create a rawmidi instance
1813 * @card: the card instance
1814 * @id: the id string
1815 * @device: the device index
1816 * @output_count: the number of output streams
1817 * @input_count: the number of input streams
1818 * @rrawmidi: the pointer to store the new rawmidi instance
1820 * Creates a new rawmidi instance.
1821 * Use snd_rawmidi_set_ops() to set the operators to the new instance.
1823 * Return: Zero if successful, or a negative error code on failure.
1825 int snd_rawmidi_new(struct snd_card *card, char *id, int device,
1826 int output_count, int input_count,
1827 struct snd_rawmidi **rrawmidi)
1829 struct snd_rawmidi *rmidi;
1831 static const struct snd_device_ops ops = {
1832 .dev_free = snd_rawmidi_dev_free,
1833 .dev_register = snd_rawmidi_dev_register,
1834 .dev_disconnect = snd_rawmidi_dev_disconnect,
1837 if (snd_BUG_ON(!card))
1841 rmidi = kzalloc(sizeof(*rmidi), GFP_KERNEL);
1845 rmidi->device = device;
1846 mutex_init(&rmidi->open_mutex);
1847 init_waitqueue_head(&rmidi->open_wait);
1848 INIT_LIST_HEAD(&rmidi->streams[SNDRV_RAWMIDI_STREAM_INPUT].substreams);
1849 INIT_LIST_HEAD(&rmidi->streams[SNDRV_RAWMIDI_STREAM_OUTPUT].substreams);
1852 strscpy(rmidi->id, id, sizeof(rmidi->id));
1854 snd_device_initialize(&rmidi->dev, card);
1855 rmidi->dev.release = release_rawmidi_device;
1856 dev_set_name(&rmidi->dev, "midiC%iD%i", card->number, device);
1858 err = snd_rawmidi_alloc_substreams(rmidi,
1859 &rmidi->streams[SNDRV_RAWMIDI_STREAM_INPUT],
1860 SNDRV_RAWMIDI_STREAM_INPUT,
1864 err = snd_rawmidi_alloc_substreams(rmidi,
1865 &rmidi->streams[SNDRV_RAWMIDI_STREAM_OUTPUT],
1866 SNDRV_RAWMIDI_STREAM_OUTPUT,
1870 err = snd_device_new(card, SNDRV_DEV_RAWMIDI, rmidi, &ops);
1879 snd_rawmidi_free(rmidi);
1882 EXPORT_SYMBOL(snd_rawmidi_new);
1884 static void snd_rawmidi_free_substreams(struct snd_rawmidi_str *stream)
1886 struct snd_rawmidi_substream *substream;
1888 while (!list_empty(&stream->substreams)) {
1889 substream = list_entry(stream->substreams.next, struct snd_rawmidi_substream, list);
1890 list_del(&substream->list);
1895 static int snd_rawmidi_free(struct snd_rawmidi *rmidi)
1900 snd_info_free_entry(rmidi->proc_entry);
1901 rmidi->proc_entry = NULL;
1902 if (rmidi->ops && rmidi->ops->dev_unregister)
1903 rmidi->ops->dev_unregister(rmidi);
1905 snd_rawmidi_free_substreams(&rmidi->streams[SNDRV_RAWMIDI_STREAM_INPUT]);
1906 snd_rawmidi_free_substreams(&rmidi->streams[SNDRV_RAWMIDI_STREAM_OUTPUT]);
1907 if (rmidi->private_free)
1908 rmidi->private_free(rmidi);
1909 put_device(&rmidi->dev);
1913 static int snd_rawmidi_dev_free(struct snd_device *device)
1915 struct snd_rawmidi *rmidi = device->device_data;
1917 return snd_rawmidi_free(rmidi);
1920 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
1921 static void snd_rawmidi_dev_seq_free(struct snd_seq_device *device)
1923 struct snd_rawmidi *rmidi = device->private_data;
1925 rmidi->seq_dev = NULL;
1929 static int snd_rawmidi_dev_register(struct snd_device *device)
1932 struct snd_info_entry *entry;
1934 struct snd_rawmidi *rmidi = device->device_data;
1936 if (rmidi->device >= SNDRV_RAWMIDI_DEVICES)
1939 mutex_lock(®ister_mutex);
1940 if (snd_rawmidi_search(rmidi->card, rmidi->device))
1943 list_add_tail(&rmidi->list, &snd_rawmidi_devices);
1944 mutex_unlock(®ister_mutex);
1948 err = snd_register_device(SNDRV_DEVICE_TYPE_RAWMIDI,
1949 rmidi->card, rmidi->device,
1950 &snd_rawmidi_f_ops, rmidi, &rmidi->dev);
1952 rmidi_err(rmidi, "unable to register\n");
1955 if (rmidi->ops && rmidi->ops->dev_register) {
1956 err = rmidi->ops->dev_register(rmidi);
1958 goto error_unregister;
1960 #ifdef CONFIG_SND_OSSEMUL
1962 if ((int)rmidi->device == midi_map[rmidi->card->number]) {
1963 if (snd_register_oss_device(SNDRV_OSS_DEVICE_TYPE_MIDI,
1964 rmidi->card, 0, &snd_rawmidi_f_ops,
1967 "unable to register OSS rawmidi device %i:%i\n",
1968 rmidi->card->number, 0);
1971 #ifdef SNDRV_OSS_INFO_DEV_MIDI
1972 snd_oss_info_register(SNDRV_OSS_INFO_DEV_MIDI, rmidi->card->number, rmidi->name);
1976 if ((int)rmidi->device == amidi_map[rmidi->card->number]) {
1977 if (snd_register_oss_device(SNDRV_OSS_DEVICE_TYPE_MIDI,
1978 rmidi->card, 1, &snd_rawmidi_f_ops,
1981 "unable to register OSS rawmidi device %i:%i\n",
1982 rmidi->card->number, 1);
1987 #endif /* CONFIG_SND_OSSEMUL */
1988 sprintf(name, "midi%d", rmidi->device);
1989 entry = snd_info_create_card_entry(rmidi->card, name, rmidi->card->proc_root);
1991 entry->private_data = rmidi;
1992 entry->c.text.read = snd_rawmidi_proc_info_read;
1993 if (snd_info_register(entry) < 0) {
1994 snd_info_free_entry(entry);
1998 rmidi->proc_entry = entry;
1999 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
2000 if (!rmidi->ops || !rmidi->ops->dev_register) { /* own registration mechanism */
2001 if (snd_seq_device_new(rmidi->card, rmidi->device, SNDRV_SEQ_DEV_ID_MIDISYNTH, 0, &rmidi->seq_dev) >= 0) {
2002 rmidi->seq_dev->private_data = rmidi;
2003 rmidi->seq_dev->private_free = snd_rawmidi_dev_seq_free;
2004 sprintf(rmidi->seq_dev->name, "MIDI %d-%d", rmidi->card->number, rmidi->device);
2005 snd_device_register(rmidi->card, rmidi->seq_dev);
2012 snd_unregister_device(&rmidi->dev);
2014 mutex_lock(®ister_mutex);
2015 list_del(&rmidi->list);
2016 mutex_unlock(®ister_mutex);
2020 static int snd_rawmidi_dev_disconnect(struct snd_device *device)
2022 struct snd_rawmidi *rmidi = device->device_data;
2025 mutex_lock(®ister_mutex);
2026 mutex_lock(&rmidi->open_mutex);
2027 wake_up(&rmidi->open_wait);
2028 list_del_init(&rmidi->list);
2029 for (dir = 0; dir < 2; dir++) {
2030 struct snd_rawmidi_substream *s;
2032 list_for_each_entry(s, &rmidi->streams[dir].substreams, list) {
2034 wake_up(&s->runtime->sleep);
2038 #ifdef CONFIG_SND_OSSEMUL
2039 if (rmidi->ossreg) {
2040 if ((int)rmidi->device == midi_map[rmidi->card->number]) {
2041 snd_unregister_oss_device(SNDRV_OSS_DEVICE_TYPE_MIDI, rmidi->card, 0);
2042 #ifdef SNDRV_OSS_INFO_DEV_MIDI
2043 snd_oss_info_unregister(SNDRV_OSS_INFO_DEV_MIDI, rmidi->card->number);
2046 if ((int)rmidi->device == amidi_map[rmidi->card->number])
2047 snd_unregister_oss_device(SNDRV_OSS_DEVICE_TYPE_MIDI, rmidi->card, 1);
2050 #endif /* CONFIG_SND_OSSEMUL */
2051 snd_unregister_device(&rmidi->dev);
2052 mutex_unlock(&rmidi->open_mutex);
2053 mutex_unlock(®ister_mutex);
2058 * snd_rawmidi_set_ops - set the rawmidi operators
2059 * @rmidi: the rawmidi instance
2060 * @stream: the stream direction, SNDRV_RAWMIDI_STREAM_XXX
2061 * @ops: the operator table
2063 * Sets the rawmidi operators for the given stream direction.
2065 void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream,
2066 const struct snd_rawmidi_ops *ops)
2068 struct snd_rawmidi_substream *substream;
2070 list_for_each_entry(substream, &rmidi->streams[stream].substreams, list)
2071 substream->ops = ops;
2073 EXPORT_SYMBOL(snd_rawmidi_set_ops);
2079 static int __init alsa_rawmidi_init(void)
2082 snd_ctl_register_ioctl(snd_rawmidi_control_ioctl);
2083 snd_ctl_register_ioctl_compat(snd_rawmidi_control_ioctl);
2084 #ifdef CONFIG_SND_OSSEMUL
2086 /* check device map table */
2087 for (i = 0; i < SNDRV_CARDS; i++) {
2088 if (midi_map[i] < 0 || midi_map[i] >= SNDRV_RAWMIDI_DEVICES) {
2089 pr_err("ALSA: rawmidi: invalid midi_map[%d] = %d\n",
2093 if (amidi_map[i] < 0 || amidi_map[i] >= SNDRV_RAWMIDI_DEVICES) {
2094 pr_err("ALSA: rawmidi: invalid amidi_map[%d] = %d\n",
2100 #endif /* CONFIG_SND_OSSEMUL */
2104 static void __exit alsa_rawmidi_exit(void)
2106 snd_ctl_unregister_ioctl(snd_rawmidi_control_ioctl);
2107 snd_ctl_unregister_ioctl_compat(snd_rawmidi_control_ioctl);
2110 module_init(alsa_rawmidi_init)
2111 module_exit(alsa_rawmidi_exit)