1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Digital Audio (PCM) abstract layer
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
7 #include <linux/init.h>
8 #include <linux/slab.h>
9 #include <linux/module.h>
10 #include <linux/time.h>
11 #include <linux/mutex.h>
12 #include <linux/device.h>
13 #include <linux/nospec.h>
14 #include <sound/core.h>
15 #include <sound/minors.h>
16 #include <sound/pcm.h>
17 #include <sound/timer.h>
18 #include <sound/control.h>
19 #include <sound/info.h>
21 #include "pcm_local.h"
23 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>, Abramo Bagnara <abramo@alsa-project.org>");
24 MODULE_DESCRIPTION("Midlevel PCM code for ALSA.");
25 MODULE_LICENSE("GPL");
27 static LIST_HEAD(snd_pcm_devices);
28 static DEFINE_MUTEX(register_mutex);
29 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
30 static LIST_HEAD(snd_pcm_notify_list);
33 static int snd_pcm_free(struct snd_pcm *pcm);
34 static int snd_pcm_dev_free(struct snd_device *device);
35 static int snd_pcm_dev_register(struct snd_device *device);
36 static int snd_pcm_dev_disconnect(struct snd_device *device);
38 static struct snd_pcm *snd_pcm_get(struct snd_card *card, int device)
42 list_for_each_entry(pcm, &snd_pcm_devices, list) {
43 if (pcm->card == card && pcm->device == device)
49 static int snd_pcm_next(struct snd_card *card, int device)
53 list_for_each_entry(pcm, &snd_pcm_devices, list) {
54 if (pcm->card == card && pcm->device > device)
56 else if (pcm->card->number > card->number)
62 static int snd_pcm_add(struct snd_pcm *newpcm)
69 list_for_each_entry(pcm, &snd_pcm_devices, list) {
70 if (pcm->card == newpcm->card && pcm->device == newpcm->device)
72 if (pcm->card->number > newpcm->card->number ||
73 (pcm->card == newpcm->card &&
74 pcm->device > newpcm->device)) {
75 list_add(&newpcm->list, pcm->list.prev);
79 list_add_tail(&newpcm->list, &snd_pcm_devices);
83 static int snd_pcm_control_ioctl(struct snd_card *card,
84 struct snd_ctl_file *control,
85 unsigned int cmd, unsigned long arg)
88 case SNDRV_CTL_IOCTL_PCM_NEXT_DEVICE:
92 if (get_user(device, (int __user *)arg))
94 mutex_lock(®ister_mutex);
95 device = snd_pcm_next(card, device);
96 mutex_unlock(®ister_mutex);
97 if (put_user(device, (int __user *)arg))
101 case SNDRV_CTL_IOCTL_PCM_INFO:
103 struct snd_pcm_info __user *info;
104 unsigned int device, subdevice;
107 struct snd_pcm_str *pstr;
108 struct snd_pcm_substream *substream;
111 info = (struct snd_pcm_info __user *)arg;
112 if (get_user(device, &info->device))
114 if (get_user(stream, &info->stream))
116 if (stream < 0 || stream > 1)
118 stream = array_index_nospec(stream, 2);
119 if (get_user(subdevice, &info->subdevice))
121 mutex_lock(®ister_mutex);
122 pcm = snd_pcm_get(card, device);
127 pstr = &pcm->streams[stream];
128 if (pstr->substream_count == 0) {
132 if (subdevice >= pstr->substream_count) {
136 for (substream = pstr->substream; substream;
137 substream = substream->next)
138 if (substream->number == (int)subdevice)
140 if (substream == NULL) {
144 mutex_lock(&pcm->open_mutex);
145 err = snd_pcm_info_user(substream, info);
146 mutex_unlock(&pcm->open_mutex);
148 mutex_unlock(®ister_mutex);
151 case SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE:
155 if (get_user(val, (int __user *)arg))
157 control->preferred_subdevice[SND_CTL_SUBDEV_PCM] = val;
164 #define FORMAT(v) [SNDRV_PCM_FORMAT_##v] = #v
166 static const char * const snd_pcm_format_names[] = {
185 FORMAT(IEC958_SUBFRAME_LE),
186 FORMAT(IEC958_SUBFRAME_BE),
217 * snd_pcm_format_name - Return a name string for the given PCM format
218 * @format: PCM format
220 * Return: the format name string
222 const char *snd_pcm_format_name(snd_pcm_format_t format)
224 if ((__force unsigned int)format >= ARRAY_SIZE(snd_pcm_format_names))
226 return snd_pcm_format_names[(__force unsigned int)format];
228 EXPORT_SYMBOL_GPL(snd_pcm_format_name);
230 #ifdef CONFIG_SND_VERBOSE_PROCFS
232 #define STATE(v) [SNDRV_PCM_STATE_##v] = #v
233 #define STREAM(v) [SNDRV_PCM_STREAM_##v] = #v
234 #define READY(v) [SNDRV_PCM_READY_##v] = #v
235 #define XRUN(v) [SNDRV_PCM_XRUN_##v] = #v
236 #define SILENCE(v) [SNDRV_PCM_SILENCE_##v] = #v
237 #define TSTAMP(v) [SNDRV_PCM_TSTAMP_##v] = #v
238 #define ACCESS(v) [SNDRV_PCM_ACCESS_##v] = #v
239 #define START(v) [SNDRV_PCM_START_##v] = #v
240 #define SUBFORMAT(v) [SNDRV_PCM_SUBFORMAT_##v] = #v
242 static const char * const snd_pcm_stream_names[] = {
247 static const char * const snd_pcm_state_names[] = {
258 static const char * const snd_pcm_access_names[] = {
259 ACCESS(MMAP_INTERLEAVED),
260 ACCESS(MMAP_NONINTERLEAVED),
261 ACCESS(MMAP_COMPLEX),
262 ACCESS(RW_INTERLEAVED),
263 ACCESS(RW_NONINTERLEAVED),
266 static const char * const snd_pcm_subformat_names[] = {
270 static const char * const snd_pcm_tstamp_mode_names[] = {
275 static const char *snd_pcm_stream_name(int stream)
277 return snd_pcm_stream_names[stream];
280 static const char *snd_pcm_access_name(snd_pcm_access_t access)
282 return snd_pcm_access_names[(__force int)access];
285 static const char *snd_pcm_subformat_name(snd_pcm_subformat_t subformat)
287 return snd_pcm_subformat_names[(__force int)subformat];
290 static const char *snd_pcm_tstamp_mode_name(int mode)
292 return snd_pcm_tstamp_mode_names[mode];
295 static const char *snd_pcm_state_name(snd_pcm_state_t state)
297 return snd_pcm_state_names[(__force int)state];
300 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
301 #include <linux/soundcard.h>
303 static const char *snd_pcm_oss_format_name(int format)
332 static void snd_pcm_proc_info_read(struct snd_pcm_substream *substream,
333 struct snd_info_buffer *buffer)
335 struct snd_pcm_info *info;
341 info = kmalloc(sizeof(*info), GFP_KERNEL);
345 err = snd_pcm_info(substream, info);
347 snd_iprintf(buffer, "error %d\n", err);
351 snd_iprintf(buffer, "card: %d\n", info->card);
352 snd_iprintf(buffer, "device: %d\n", info->device);
353 snd_iprintf(buffer, "subdevice: %d\n", info->subdevice);
354 snd_iprintf(buffer, "stream: %s\n", snd_pcm_stream_name(info->stream));
355 snd_iprintf(buffer, "id: %s\n", info->id);
356 snd_iprintf(buffer, "name: %s\n", info->name);
357 snd_iprintf(buffer, "subname: %s\n", info->subname);
358 snd_iprintf(buffer, "class: %d\n", info->dev_class);
359 snd_iprintf(buffer, "subclass: %d\n", info->dev_subclass);
360 snd_iprintf(buffer, "subdevices_count: %d\n", info->subdevices_count);
361 snd_iprintf(buffer, "subdevices_avail: %d\n", info->subdevices_avail);
365 static void snd_pcm_stream_proc_info_read(struct snd_info_entry *entry,
366 struct snd_info_buffer *buffer)
368 snd_pcm_proc_info_read(((struct snd_pcm_str *)entry->private_data)->substream,
372 static void snd_pcm_substream_proc_info_read(struct snd_info_entry *entry,
373 struct snd_info_buffer *buffer)
375 snd_pcm_proc_info_read(entry->private_data, buffer);
378 static void snd_pcm_substream_proc_hw_params_read(struct snd_info_entry *entry,
379 struct snd_info_buffer *buffer)
381 struct snd_pcm_substream *substream = entry->private_data;
382 struct snd_pcm_runtime *runtime;
384 mutex_lock(&substream->pcm->open_mutex);
385 runtime = substream->runtime;
387 snd_iprintf(buffer, "closed\n");
390 if (runtime->state == SNDRV_PCM_STATE_OPEN) {
391 snd_iprintf(buffer, "no setup\n");
394 snd_iprintf(buffer, "access: %s\n", snd_pcm_access_name(runtime->access));
395 snd_iprintf(buffer, "format: %s\n", snd_pcm_format_name(runtime->format));
396 snd_iprintf(buffer, "subformat: %s\n", snd_pcm_subformat_name(runtime->subformat));
397 snd_iprintf(buffer, "channels: %u\n", runtime->channels);
398 snd_iprintf(buffer, "rate: %u (%u/%u)\n", runtime->rate, runtime->rate_num, runtime->rate_den);
399 snd_iprintf(buffer, "period_size: %lu\n", runtime->period_size);
400 snd_iprintf(buffer, "buffer_size: %lu\n", runtime->buffer_size);
401 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
402 if (substream->oss.oss) {
403 snd_iprintf(buffer, "OSS format: %s\n", snd_pcm_oss_format_name(runtime->oss.format));
404 snd_iprintf(buffer, "OSS channels: %u\n", runtime->oss.channels);
405 snd_iprintf(buffer, "OSS rate: %u\n", runtime->oss.rate);
406 snd_iprintf(buffer, "OSS period bytes: %lu\n", (unsigned long)runtime->oss.period_bytes);
407 snd_iprintf(buffer, "OSS periods: %u\n", runtime->oss.periods);
408 snd_iprintf(buffer, "OSS period frames: %lu\n", (unsigned long)runtime->oss.period_frames);
412 mutex_unlock(&substream->pcm->open_mutex);
415 static void snd_pcm_substream_proc_sw_params_read(struct snd_info_entry *entry,
416 struct snd_info_buffer *buffer)
418 struct snd_pcm_substream *substream = entry->private_data;
419 struct snd_pcm_runtime *runtime;
421 mutex_lock(&substream->pcm->open_mutex);
422 runtime = substream->runtime;
424 snd_iprintf(buffer, "closed\n");
427 if (runtime->state == SNDRV_PCM_STATE_OPEN) {
428 snd_iprintf(buffer, "no setup\n");
431 snd_iprintf(buffer, "tstamp_mode: %s\n", snd_pcm_tstamp_mode_name(runtime->tstamp_mode));
432 snd_iprintf(buffer, "period_step: %u\n", runtime->period_step);
433 snd_iprintf(buffer, "avail_min: %lu\n", runtime->control->avail_min);
434 snd_iprintf(buffer, "start_threshold: %lu\n", runtime->start_threshold);
435 snd_iprintf(buffer, "stop_threshold: %lu\n", runtime->stop_threshold);
436 snd_iprintf(buffer, "silence_threshold: %lu\n", runtime->silence_threshold);
437 snd_iprintf(buffer, "silence_size: %lu\n", runtime->silence_size);
438 snd_iprintf(buffer, "boundary: %lu\n", runtime->boundary);
440 mutex_unlock(&substream->pcm->open_mutex);
443 static void snd_pcm_substream_proc_status_read(struct snd_info_entry *entry,
444 struct snd_info_buffer *buffer)
446 struct snd_pcm_substream *substream = entry->private_data;
447 struct snd_pcm_runtime *runtime;
448 struct snd_pcm_status64 status;
451 mutex_lock(&substream->pcm->open_mutex);
452 runtime = substream->runtime;
454 snd_iprintf(buffer, "closed\n");
457 memset(&status, 0, sizeof(status));
458 err = snd_pcm_status64(substream, &status);
460 snd_iprintf(buffer, "error %d\n", err);
463 snd_iprintf(buffer, "state: %s\n", snd_pcm_state_name(status.state));
464 snd_iprintf(buffer, "owner_pid : %d\n", pid_vnr(substream->pid));
465 snd_iprintf(buffer, "trigger_time: %lld.%09lld\n",
466 status.trigger_tstamp_sec, status.trigger_tstamp_nsec);
467 snd_iprintf(buffer, "tstamp : %lld.%09lld\n",
468 status.tstamp_sec, status.tstamp_nsec);
469 snd_iprintf(buffer, "delay : %ld\n", status.delay);
470 snd_iprintf(buffer, "avail : %ld\n", status.avail);
471 snd_iprintf(buffer, "avail_max : %ld\n", status.avail_max);
472 snd_iprintf(buffer, "-----\n");
473 snd_iprintf(buffer, "hw_ptr : %ld\n", runtime->status->hw_ptr);
474 snd_iprintf(buffer, "appl_ptr : %ld\n", runtime->control->appl_ptr);
476 mutex_unlock(&substream->pcm->open_mutex);
479 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
480 static void snd_pcm_xrun_injection_write(struct snd_info_entry *entry,
481 struct snd_info_buffer *buffer)
483 struct snd_pcm_substream *substream = entry->private_data;
485 snd_pcm_stop_xrun(substream);
488 static void snd_pcm_xrun_debug_read(struct snd_info_entry *entry,
489 struct snd_info_buffer *buffer)
491 struct snd_pcm_str *pstr = entry->private_data;
492 snd_iprintf(buffer, "%d\n", pstr->xrun_debug);
495 static void snd_pcm_xrun_debug_write(struct snd_info_entry *entry,
496 struct snd_info_buffer *buffer)
498 struct snd_pcm_str *pstr = entry->private_data;
500 if (!snd_info_get_line(buffer, line, sizeof(line)))
501 pstr->xrun_debug = simple_strtoul(line, NULL, 10);
505 static int snd_pcm_stream_proc_init(struct snd_pcm_str *pstr)
507 struct snd_pcm *pcm = pstr->pcm;
508 struct snd_info_entry *entry;
511 sprintf(name, "pcm%i%c", pcm->device,
512 pstr->stream == SNDRV_PCM_STREAM_PLAYBACK ? 'p' : 'c');
513 entry = snd_info_create_card_entry(pcm->card, name,
514 pcm->card->proc_root);
517 entry->mode = S_IFDIR | 0555;
518 pstr->proc_root = entry;
519 entry = snd_info_create_card_entry(pcm->card, "info", pstr->proc_root);
521 snd_info_set_text_ops(entry, pstr, snd_pcm_stream_proc_info_read);
522 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
523 entry = snd_info_create_card_entry(pcm->card, "xrun_debug",
526 snd_info_set_text_ops(entry, pstr, snd_pcm_xrun_debug_read);
527 entry->c.text.write = snd_pcm_xrun_debug_write;
534 static int snd_pcm_stream_proc_done(struct snd_pcm_str *pstr)
536 snd_info_free_entry(pstr->proc_root);
537 pstr->proc_root = NULL;
541 static struct snd_info_entry *
542 create_substream_info_entry(struct snd_pcm_substream *substream,
544 void (*read)(struct snd_info_entry *,
545 struct snd_info_buffer *))
547 struct snd_info_entry *entry;
549 entry = snd_info_create_card_entry(substream->pcm->card, name,
550 substream->proc_root);
552 snd_info_set_text_ops(entry, substream, read);
556 static int snd_pcm_substream_proc_init(struct snd_pcm_substream *substream)
558 struct snd_info_entry *entry;
559 struct snd_card *card;
562 card = substream->pcm->card;
564 sprintf(name, "sub%i", substream->number);
565 entry = snd_info_create_card_entry(card, name,
566 substream->pstr->proc_root);
569 entry->mode = S_IFDIR | 0555;
570 substream->proc_root = entry;
572 create_substream_info_entry(substream, "info",
573 snd_pcm_substream_proc_info_read);
574 create_substream_info_entry(substream, "hw_params",
575 snd_pcm_substream_proc_hw_params_read);
576 create_substream_info_entry(substream, "sw_params",
577 snd_pcm_substream_proc_sw_params_read);
578 create_substream_info_entry(substream, "status",
579 snd_pcm_substream_proc_status_read);
581 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
582 entry = create_substream_info_entry(substream, "xrun_injection", NULL);
584 entry->c.text.write = snd_pcm_xrun_injection_write;
585 entry->mode = S_IFREG | 0200;
587 #endif /* CONFIG_SND_PCM_XRUN_DEBUG */
592 #else /* !CONFIG_SND_VERBOSE_PROCFS */
593 static inline int snd_pcm_stream_proc_init(struct snd_pcm_str *pstr) { return 0; }
594 static inline int snd_pcm_stream_proc_done(struct snd_pcm_str *pstr) { return 0; }
595 static inline int snd_pcm_substream_proc_init(struct snd_pcm_substream *substream) { return 0; }
596 #endif /* CONFIG_SND_VERBOSE_PROCFS */
598 static const struct attribute_group *pcm_dev_attr_groups[];
601 * PM callbacks: we need to deal only with suspend here, as the resume is
602 * triggered either from user-space or the driver's resume callback
604 #ifdef CONFIG_PM_SLEEP
605 static int do_pcm_suspend(struct device *dev)
607 struct snd_pcm_str *pstr = dev_get_drvdata(dev);
609 if (!pstr->pcm->no_device_suspend)
610 snd_pcm_suspend_all(pstr->pcm);
615 static const struct dev_pm_ops pcm_dev_pm_ops = {
616 SET_SYSTEM_SLEEP_PM_OPS(do_pcm_suspend, NULL)
619 /* device type for PCM -- basically only for passing PM callbacks */
620 static const struct device_type pcm_dev_type = {
622 .pm = &pcm_dev_pm_ops,
626 * snd_pcm_new_stream - create a new PCM stream
627 * @pcm: the pcm instance
628 * @stream: the stream direction, SNDRV_PCM_STREAM_XXX
629 * @substream_count: the number of substreams
631 * Creates a new stream for the pcm.
632 * The corresponding stream on the pcm must have been empty before
633 * calling this, i.e. zero must be given to the argument of
636 * Return: Zero if successful, or a negative error code on failure.
638 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count)
641 struct snd_pcm_str *pstr = &pcm->streams[stream];
642 struct snd_pcm_substream *substream, *prev;
644 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
645 mutex_init(&pstr->oss.setup_mutex);
647 pstr->stream = stream;
649 pstr->substream_count = substream_count;
650 if (!substream_count)
653 err = snd_device_alloc(&pstr->dev, pcm->card);
656 dev_set_name(pstr->dev, "pcmC%iD%i%c", pcm->card->number, pcm->device,
657 stream == SNDRV_PCM_STREAM_PLAYBACK ? 'p' : 'c');
658 pstr->dev->groups = pcm_dev_attr_groups;
659 pstr->dev->type = &pcm_dev_type;
660 dev_set_drvdata(pstr->dev, pstr);
662 if (!pcm->internal) {
663 err = snd_pcm_stream_proc_init(pstr);
665 pcm_err(pcm, "Error in snd_pcm_stream_proc_init\n");
670 for (idx = 0, prev = NULL; idx < substream_count; idx++) {
671 substream = kzalloc(sizeof(*substream), GFP_KERNEL);
674 substream->pcm = pcm;
675 substream->pstr = pstr;
676 substream->number = idx;
677 substream->stream = stream;
678 sprintf(substream->name, "subdevice #%i", idx);
679 substream->buffer_bytes_max = UINT_MAX;
681 pstr->substream = substream;
683 prev->next = substream;
685 if (!pcm->internal) {
686 err = snd_pcm_substream_proc_init(substream);
689 "Error in snd_pcm_stream_proc_init\n");
691 pstr->substream = NULL;
698 substream->group = &substream->self_group;
699 snd_pcm_group_init(&substream->self_group);
700 list_add_tail(&substream->link_list, &substream->self_group.substreams);
701 atomic_set(&substream->mmap_count, 0);
706 EXPORT_SYMBOL(snd_pcm_new_stream);
708 static int _snd_pcm_new(struct snd_card *card, const char *id, int device,
709 int playback_count, int capture_count, bool internal,
710 struct snd_pcm **rpcm)
714 static const struct snd_device_ops ops = {
715 .dev_free = snd_pcm_dev_free,
716 .dev_register = snd_pcm_dev_register,
717 .dev_disconnect = snd_pcm_dev_disconnect,
719 static const struct snd_device_ops internal_ops = {
720 .dev_free = snd_pcm_dev_free,
723 if (snd_BUG_ON(!card))
727 pcm = kzalloc(sizeof(*pcm), GFP_KERNEL);
731 pcm->device = device;
732 pcm->internal = internal;
733 mutex_init(&pcm->open_mutex);
734 init_waitqueue_head(&pcm->open_wait);
735 INIT_LIST_HEAD(&pcm->list);
737 strscpy(pcm->id, id, sizeof(pcm->id));
739 err = snd_pcm_new_stream(pcm, SNDRV_PCM_STREAM_PLAYBACK,
744 err = snd_pcm_new_stream(pcm, SNDRV_PCM_STREAM_CAPTURE, capture_count);
748 err = snd_device_new(card, SNDRV_DEV_PCM, pcm,
749 internal ? &internal_ops : &ops);
763 * snd_pcm_new - create a new PCM instance
764 * @card: the card instance
766 * @device: the device index (zero based)
767 * @playback_count: the number of substreams for playback
768 * @capture_count: the number of substreams for capture
769 * @rpcm: the pointer to store the new pcm instance
771 * Creates a new PCM instance.
773 * The pcm operators have to be set afterwards to the new instance
774 * via snd_pcm_set_ops().
776 * Return: Zero if successful, or a negative error code on failure.
778 int snd_pcm_new(struct snd_card *card, const char *id, int device,
779 int playback_count, int capture_count, struct snd_pcm **rpcm)
781 return _snd_pcm_new(card, id, device, playback_count, capture_count,
784 EXPORT_SYMBOL(snd_pcm_new);
787 * snd_pcm_new_internal - create a new internal PCM instance
788 * @card: the card instance
790 * @device: the device index (zero based - shared with normal PCMs)
791 * @playback_count: the number of substreams for playback
792 * @capture_count: the number of substreams for capture
793 * @rpcm: the pointer to store the new pcm instance
795 * Creates a new internal PCM instance with no userspace device or procfs
796 * entries. This is used by ASoC Back End PCMs in order to create a PCM that
797 * will only be used internally by kernel drivers. i.e. it cannot be opened
798 * by userspace. It provides existing ASoC components drivers with a substream
799 * and access to any private data.
801 * The pcm operators have to be set afterwards to the new instance
802 * via snd_pcm_set_ops().
804 * Return: Zero if successful, or a negative error code on failure.
806 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
807 int playback_count, int capture_count,
808 struct snd_pcm **rpcm)
810 return _snd_pcm_new(card, id, device, playback_count, capture_count,
813 EXPORT_SYMBOL(snd_pcm_new_internal);
815 static void free_chmap(struct snd_pcm_str *pstr)
817 if (pstr->chmap_kctl) {
818 struct snd_card *card = pstr->pcm->card;
820 snd_ctl_remove(card, pstr->chmap_kctl);
821 pstr->chmap_kctl = NULL;
825 static void snd_pcm_free_stream(struct snd_pcm_str * pstr)
827 struct snd_pcm_substream *substream, *substream_next;
828 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
829 struct snd_pcm_oss_setup *setup, *setupn;
832 /* free all proc files under the stream */
833 snd_pcm_stream_proc_done(pstr);
835 substream = pstr->substream;
837 substream_next = substream->next;
838 snd_pcm_timer_done(substream);
840 substream = substream_next;
842 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
843 for (setup = pstr->oss.setup_list; setup; setup = setupn) {
844 setupn = setup->next;
845 kfree(setup->task_name);
850 if (pstr->substream_count)
851 put_device(pstr->dev);
854 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
855 #define pcm_call_notify(pcm, call) \
857 struct snd_pcm_notify *_notify; \
858 list_for_each_entry(_notify, &snd_pcm_notify_list, list) \
859 _notify->call(pcm); \
862 #define pcm_call_notify(pcm, call) do {} while (0)
865 static int snd_pcm_free(struct snd_pcm *pcm)
870 pcm_call_notify(pcm, n_unregister);
871 if (pcm->private_free)
872 pcm->private_free(pcm);
873 snd_pcm_lib_preallocate_free_for_all(pcm);
874 snd_pcm_free_stream(&pcm->streams[SNDRV_PCM_STREAM_PLAYBACK]);
875 snd_pcm_free_stream(&pcm->streams[SNDRV_PCM_STREAM_CAPTURE]);
880 static int snd_pcm_dev_free(struct snd_device *device)
882 struct snd_pcm *pcm = device->device_data;
883 return snd_pcm_free(pcm);
886 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream,
888 struct snd_pcm_substream **rsubstream)
890 struct snd_pcm_str * pstr;
891 struct snd_pcm_substream *substream;
892 struct snd_pcm_runtime *runtime;
893 struct snd_card *card;
894 int prefer_subdevice;
897 if (snd_BUG_ON(!pcm || !rsubstream))
899 if (snd_BUG_ON(stream != SNDRV_PCM_STREAM_PLAYBACK &&
900 stream != SNDRV_PCM_STREAM_CAPTURE))
903 pstr = &pcm->streams[stream];
904 if (pstr->substream == NULL || pstr->substream_count == 0)
908 prefer_subdevice = snd_ctl_get_preferred_subdevice(card, SND_CTL_SUBDEV_PCM);
910 if (pcm->info_flags & SNDRV_PCM_INFO_HALF_DUPLEX) {
911 int opposite = !stream;
913 for (substream = pcm->streams[opposite].substream; substream;
914 substream = substream->next) {
915 if (SUBSTREAM_BUSY(substream))
920 if (file->f_flags & O_APPEND) {
921 if (prefer_subdevice < 0) {
922 if (pstr->substream_count > 1)
923 return -EINVAL; /* must be unique */
924 substream = pstr->substream;
926 for (substream = pstr->substream; substream;
927 substream = substream->next)
928 if (substream->number == prefer_subdevice)
933 if (! SUBSTREAM_BUSY(substream))
935 substream->ref_count++;
936 *rsubstream = substream;
940 for (substream = pstr->substream; substream; substream = substream->next) {
941 if (!SUBSTREAM_BUSY(substream) &&
942 (prefer_subdevice == -1 ||
943 substream->number == prefer_subdevice))
946 if (substream == NULL)
949 runtime = kzalloc(sizeof(*runtime), GFP_KERNEL);
953 size = PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status));
954 runtime->status = alloc_pages_exact(size, GFP_KERNEL);
955 if (runtime->status == NULL) {
959 memset(runtime->status, 0, size);
961 size = PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control));
962 runtime->control = alloc_pages_exact(size, GFP_KERNEL);
963 if (runtime->control == NULL) {
964 free_pages_exact(runtime->status,
965 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)));
969 memset(runtime->control, 0, size);
971 init_waitqueue_head(&runtime->sleep);
972 init_waitqueue_head(&runtime->tsleep);
974 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_OPEN);
975 mutex_init(&runtime->buffer_mutex);
976 atomic_set(&runtime->buffer_accessing, 0);
978 substream->runtime = runtime;
979 substream->private_data = pcm->private_data;
980 substream->ref_count = 1;
981 substream->f_flags = file->f_flags;
982 substream->pid = get_pid(task_pid(current));
983 pstr->substream_opened++;
984 *rsubstream = substream;
988 void snd_pcm_detach_substream(struct snd_pcm_substream *substream)
990 struct snd_pcm_runtime *runtime;
992 if (PCM_RUNTIME_CHECK(substream))
994 runtime = substream->runtime;
995 if (runtime->private_free != NULL)
996 runtime->private_free(runtime);
997 free_pages_exact(runtime->status,
998 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)));
999 free_pages_exact(runtime->control,
1000 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)));
1001 kfree(runtime->hw_constraints.rules);
1002 /* Avoid concurrent access to runtime via PCM timer interface */
1003 if (substream->timer) {
1004 spin_lock_irq(&substream->timer->lock);
1005 substream->runtime = NULL;
1006 spin_unlock_irq(&substream->timer->lock);
1008 substream->runtime = NULL;
1010 mutex_destroy(&runtime->buffer_mutex);
1011 snd_fasync_free(runtime->fasync);
1013 put_pid(substream->pid);
1014 substream->pid = NULL;
1015 substream->pstr->substream_opened--;
1018 static ssize_t pcm_class_show(struct device *dev,
1019 struct device_attribute *attr, char *buf)
1021 struct snd_pcm_str *pstr = dev_get_drvdata(dev);
1022 struct snd_pcm *pcm = pstr->pcm;
1024 static const char *strs[SNDRV_PCM_CLASS_LAST + 1] = {
1025 [SNDRV_PCM_CLASS_GENERIC] = "generic",
1026 [SNDRV_PCM_CLASS_MULTI] = "multi",
1027 [SNDRV_PCM_CLASS_MODEM] = "modem",
1028 [SNDRV_PCM_CLASS_DIGITIZER] = "digitizer",
1031 if (pcm->dev_class > SNDRV_PCM_CLASS_LAST)
1034 str = strs[pcm->dev_class];
1035 return sysfs_emit(buf, "%s\n", str);
1038 static DEVICE_ATTR_RO(pcm_class);
1039 static struct attribute *pcm_dev_attrs[] = {
1040 &dev_attr_pcm_class.attr,
1044 static const struct attribute_group pcm_dev_attr_group = {
1045 .attrs = pcm_dev_attrs,
1048 static const struct attribute_group *pcm_dev_attr_groups[] = {
1049 &pcm_dev_attr_group,
1053 static int snd_pcm_dev_register(struct snd_device *device)
1056 struct snd_pcm_substream *substream;
1057 struct snd_pcm *pcm;
1059 if (snd_BUG_ON(!device || !device->device_data))
1061 pcm = device->device_data;
1063 mutex_lock(®ister_mutex);
1064 err = snd_pcm_add(pcm);
1067 for (cidx = 0; cidx < 2; cidx++) {
1069 if (pcm->streams[cidx].substream == NULL)
1072 case SNDRV_PCM_STREAM_PLAYBACK:
1073 devtype = SNDRV_DEVICE_TYPE_PCM_PLAYBACK;
1075 case SNDRV_PCM_STREAM_CAPTURE:
1076 devtype = SNDRV_DEVICE_TYPE_PCM_CAPTURE;
1080 err = snd_register_device(devtype, pcm->card, pcm->device,
1081 &snd_pcm_f_ops[cidx], pcm,
1082 pcm->streams[cidx].dev);
1084 list_del_init(&pcm->list);
1088 for (substream = pcm->streams[cidx].substream; substream; substream = substream->next)
1089 snd_pcm_timer_init(substream);
1092 pcm_call_notify(pcm, n_register);
1095 mutex_unlock(®ister_mutex);
1099 static int snd_pcm_dev_disconnect(struct snd_device *device)
1101 struct snd_pcm *pcm = device->device_data;
1102 struct snd_pcm_substream *substream;
1105 mutex_lock(®ister_mutex);
1106 mutex_lock(&pcm->open_mutex);
1107 wake_up(&pcm->open_wait);
1108 list_del_init(&pcm->list);
1110 for_each_pcm_substream(pcm, cidx, substream) {
1111 snd_pcm_stream_lock_irq(substream);
1112 if (substream->runtime) {
1113 if (snd_pcm_running(substream))
1114 snd_pcm_stop(substream, SNDRV_PCM_STATE_DISCONNECTED);
1115 /* to be sure, set the state unconditionally */
1116 __snd_pcm_set_state(substream->runtime,
1117 SNDRV_PCM_STATE_DISCONNECTED);
1118 wake_up(&substream->runtime->sleep);
1119 wake_up(&substream->runtime->tsleep);
1121 snd_pcm_stream_unlock_irq(substream);
1124 for_each_pcm_substream(pcm, cidx, substream)
1125 snd_pcm_sync_stop(substream, false);
1127 pcm_call_notify(pcm, n_disconnect);
1128 for (cidx = 0; cidx < 2; cidx++) {
1129 if (pcm->streams[cidx].dev)
1130 snd_unregister_device(pcm->streams[cidx].dev);
1131 free_chmap(&pcm->streams[cidx]);
1133 mutex_unlock(&pcm->open_mutex);
1134 mutex_unlock(®ister_mutex);
1138 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
1140 * snd_pcm_notify - Add/remove the notify list
1141 * @notify: PCM notify list
1142 * @nfree: 0 = register, 1 = unregister
1144 * This adds the given notifier to the global list so that the callback is
1145 * called for each registered PCM devices. This exists only for PCM OSS
1146 * emulation, so far.
1148 * Return: zero if successful, or a negative error code
1150 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree)
1152 struct snd_pcm *pcm;
1154 if (snd_BUG_ON(!notify ||
1155 !notify->n_register ||
1156 !notify->n_unregister ||
1157 !notify->n_disconnect))
1159 mutex_lock(®ister_mutex);
1161 list_del(¬ify->list);
1162 list_for_each_entry(pcm, &snd_pcm_devices, list)
1163 notify->n_unregister(pcm);
1165 list_add_tail(¬ify->list, &snd_pcm_notify_list);
1166 list_for_each_entry(pcm, &snd_pcm_devices, list)
1167 notify->n_register(pcm);
1169 mutex_unlock(®ister_mutex);
1172 EXPORT_SYMBOL(snd_pcm_notify);
1173 #endif /* CONFIG_SND_PCM_OSS */
1175 #ifdef CONFIG_SND_PROC_FS
1180 static void snd_pcm_proc_read(struct snd_info_entry *entry,
1181 struct snd_info_buffer *buffer)
1183 struct snd_pcm *pcm;
1185 mutex_lock(®ister_mutex);
1186 list_for_each_entry(pcm, &snd_pcm_devices, list) {
1187 snd_iprintf(buffer, "%02i-%02i: %s : %s",
1188 pcm->card->number, pcm->device, pcm->id, pcm->name);
1189 if (pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream)
1190 snd_iprintf(buffer, " : playback %i",
1191 pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream_count);
1192 if (pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream)
1193 snd_iprintf(buffer, " : capture %i",
1194 pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream_count);
1195 snd_iprintf(buffer, "\n");
1197 mutex_unlock(®ister_mutex);
1200 static struct snd_info_entry *snd_pcm_proc_entry;
1202 static void snd_pcm_proc_init(void)
1204 struct snd_info_entry *entry;
1206 entry = snd_info_create_module_entry(THIS_MODULE, "pcm", NULL);
1208 snd_info_set_text_ops(entry, NULL, snd_pcm_proc_read);
1209 if (snd_info_register(entry) < 0) {
1210 snd_info_free_entry(entry);
1214 snd_pcm_proc_entry = entry;
1217 static void snd_pcm_proc_done(void)
1219 snd_info_free_entry(snd_pcm_proc_entry);
1222 #else /* !CONFIG_SND_PROC_FS */
1223 #define snd_pcm_proc_init()
1224 #define snd_pcm_proc_done()
1225 #endif /* CONFIG_SND_PROC_FS */
1232 static int __init alsa_pcm_init(void)
1234 snd_ctl_register_ioctl(snd_pcm_control_ioctl);
1235 snd_ctl_register_ioctl_compat(snd_pcm_control_ioctl);
1236 snd_pcm_proc_init();
1240 static void __exit alsa_pcm_exit(void)
1242 snd_ctl_unregister_ioctl(snd_pcm_control_ioctl);
1243 snd_ctl_unregister_ioctl_compat(snd_pcm_control_ioctl);
1244 snd_pcm_proc_done();
1247 module_init(alsa_pcm_init)
1248 module_exit(alsa_pcm_exit)