1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Digital Audio (PCM) abstract layer
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"
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 scoped_guard(mutex, ®ister_mutex)
95 device = snd_pcm_next(card, device);
96 if (put_user(device, (int __user *)arg))
100 case SNDRV_CTL_IOCTL_PCM_INFO:
102 struct snd_pcm_info __user *info;
103 unsigned int device, subdevice;
106 struct snd_pcm_str *pstr;
107 struct snd_pcm_substream *substream;
109 info = (struct snd_pcm_info __user *)arg;
110 if (get_user(device, &info->device))
112 if (get_user(stream, &info->stream))
114 if (stream < 0 || stream > 1)
116 stream = array_index_nospec(stream, 2);
117 if (get_user(subdevice, &info->subdevice))
119 guard(mutex)(®ister_mutex);
120 pcm = snd_pcm_get(card, device);
123 pstr = &pcm->streams[stream];
124 if (pstr->substream_count == 0)
126 if (subdevice >= pstr->substream_count)
128 for (substream = pstr->substream; substream;
129 substream = substream->next)
130 if (substream->number == (int)subdevice)
132 if (substream == NULL)
134 guard(mutex)(&pcm->open_mutex);
135 return snd_pcm_info_user(substream, info);
137 case SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE:
141 if (get_user(val, (int __user *)arg))
143 control->preferred_subdevice[SND_CTL_SUBDEV_PCM] = val;
150 #define FORMAT(v) [SNDRV_PCM_FORMAT_##v] = #v
152 static const char * const snd_pcm_format_names[] = {
171 FORMAT(IEC958_SUBFRAME_LE),
172 FORMAT(IEC958_SUBFRAME_BE),
207 * snd_pcm_format_name - Return a name string for the given PCM format
208 * @format: PCM format
210 * Return: the format name string
212 const char *snd_pcm_format_name(snd_pcm_format_t format)
214 unsigned int format_num = (__force unsigned int)format;
216 if (format_num >= ARRAY_SIZE(snd_pcm_format_names) || !snd_pcm_format_names[format_num])
218 return snd_pcm_format_names[format_num];
220 EXPORT_SYMBOL_GPL(snd_pcm_format_name);
222 #ifdef CONFIG_SND_VERBOSE_PROCFS
224 #define STATE(v) [SNDRV_PCM_STATE_##v] = #v
225 #define STREAM(v) [SNDRV_PCM_STREAM_##v] = #v
226 #define READY(v) [SNDRV_PCM_READY_##v] = #v
227 #define XRUN(v) [SNDRV_PCM_XRUN_##v] = #v
228 #define SILENCE(v) [SNDRV_PCM_SILENCE_##v] = #v
229 #define TSTAMP(v) [SNDRV_PCM_TSTAMP_##v] = #v
230 #define ACCESS(v) [SNDRV_PCM_ACCESS_##v] = #v
231 #define START(v) [SNDRV_PCM_START_##v] = #v
232 #define SUBFORMAT(v) [SNDRV_PCM_SUBFORMAT_##v] = #v
234 static const char * const snd_pcm_stream_names[] = {
239 static const char * const snd_pcm_state_names[] = {
251 static const char * const snd_pcm_access_names[] = {
252 ACCESS(MMAP_INTERLEAVED),
253 ACCESS(MMAP_NONINTERLEAVED),
254 ACCESS(MMAP_COMPLEX),
255 ACCESS(RW_INTERLEAVED),
256 ACCESS(RW_NONINTERLEAVED),
259 static const char * const snd_pcm_subformat_names[] = {
261 SUBFORMAT(MSBITS_MAX),
262 SUBFORMAT(MSBITS_20),
263 SUBFORMAT(MSBITS_24),
266 static const char * const snd_pcm_tstamp_mode_names[] = {
271 static const char *snd_pcm_stream_name(int stream)
273 return snd_pcm_stream_names[stream];
276 static const char *snd_pcm_access_name(snd_pcm_access_t access)
278 return snd_pcm_access_names[(__force int)access];
281 static const char *snd_pcm_subformat_name(snd_pcm_subformat_t subformat)
283 return snd_pcm_subformat_names[(__force int)subformat];
286 static const char *snd_pcm_tstamp_mode_name(int mode)
288 return snd_pcm_tstamp_mode_names[mode];
291 static const char *snd_pcm_state_name(snd_pcm_state_t state)
293 return snd_pcm_state_names[(__force int)state];
296 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
297 #include <linux/soundcard.h>
299 static const char *snd_pcm_oss_format_name(int format)
328 static void snd_pcm_proc_info_read(struct snd_pcm_substream *substream,
329 struct snd_info_buffer *buffer)
331 struct snd_pcm_info *info __free(kfree) = NULL;
337 info = kmalloc(sizeof(*info), GFP_KERNEL);
341 err = snd_pcm_info(substream, info);
343 snd_iprintf(buffer, "error %d\n", err);
346 snd_iprintf(buffer, "card: %d\n", info->card);
347 snd_iprintf(buffer, "device: %d\n", info->device);
348 snd_iprintf(buffer, "subdevice: %d\n", info->subdevice);
349 snd_iprintf(buffer, "stream: %s\n", snd_pcm_stream_name(info->stream));
350 snd_iprintf(buffer, "id: %s\n", info->id);
351 snd_iprintf(buffer, "name: %s\n", info->name);
352 snd_iprintf(buffer, "subname: %s\n", info->subname);
353 snd_iprintf(buffer, "class: %d\n", info->dev_class);
354 snd_iprintf(buffer, "subclass: %d\n", info->dev_subclass);
355 snd_iprintf(buffer, "subdevices_count: %d\n", info->subdevices_count);
356 snd_iprintf(buffer, "subdevices_avail: %d\n", info->subdevices_avail);
359 static void snd_pcm_stream_proc_info_read(struct snd_info_entry *entry,
360 struct snd_info_buffer *buffer)
362 snd_pcm_proc_info_read(((struct snd_pcm_str *)entry->private_data)->substream,
366 static void snd_pcm_substream_proc_info_read(struct snd_info_entry *entry,
367 struct snd_info_buffer *buffer)
369 snd_pcm_proc_info_read(entry->private_data, buffer);
372 static void snd_pcm_substream_proc_hw_params_read(struct snd_info_entry *entry,
373 struct snd_info_buffer *buffer)
375 struct snd_pcm_substream *substream = entry->private_data;
376 struct snd_pcm_runtime *runtime;
378 guard(mutex)(&substream->pcm->open_mutex);
379 runtime = substream->runtime;
381 snd_iprintf(buffer, "closed\n");
384 if (runtime->state == SNDRV_PCM_STATE_OPEN) {
385 snd_iprintf(buffer, "no setup\n");
388 snd_iprintf(buffer, "access: %s\n", snd_pcm_access_name(runtime->access));
389 snd_iprintf(buffer, "format: %s\n", snd_pcm_format_name(runtime->format));
390 snd_iprintf(buffer, "subformat: %s\n", snd_pcm_subformat_name(runtime->subformat));
391 snd_iprintf(buffer, "channels: %u\n", runtime->channels);
392 snd_iprintf(buffer, "rate: %u (%u/%u)\n", runtime->rate, runtime->rate_num, runtime->rate_den);
393 snd_iprintf(buffer, "period_size: %lu\n", runtime->period_size);
394 snd_iprintf(buffer, "buffer_size: %lu\n", runtime->buffer_size);
395 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
396 if (substream->oss.oss) {
397 snd_iprintf(buffer, "OSS format: %s\n", snd_pcm_oss_format_name(runtime->oss.format));
398 snd_iprintf(buffer, "OSS channels: %u\n", runtime->oss.channels);
399 snd_iprintf(buffer, "OSS rate: %u\n", runtime->oss.rate);
400 snd_iprintf(buffer, "OSS period bytes: %lu\n", (unsigned long)runtime->oss.period_bytes);
401 snd_iprintf(buffer, "OSS periods: %u\n", runtime->oss.periods);
402 snd_iprintf(buffer, "OSS period frames: %lu\n", (unsigned long)runtime->oss.period_frames);
407 static void snd_pcm_substream_proc_sw_params_read(struct snd_info_entry *entry,
408 struct snd_info_buffer *buffer)
410 struct snd_pcm_substream *substream = entry->private_data;
411 struct snd_pcm_runtime *runtime;
413 guard(mutex)(&substream->pcm->open_mutex);
414 runtime = substream->runtime;
416 snd_iprintf(buffer, "closed\n");
419 if (runtime->state == SNDRV_PCM_STATE_OPEN) {
420 snd_iprintf(buffer, "no setup\n");
423 snd_iprintf(buffer, "tstamp_mode: %s\n", snd_pcm_tstamp_mode_name(runtime->tstamp_mode));
424 snd_iprintf(buffer, "period_step: %u\n", runtime->period_step);
425 snd_iprintf(buffer, "avail_min: %lu\n", runtime->control->avail_min);
426 snd_iprintf(buffer, "start_threshold: %lu\n", runtime->start_threshold);
427 snd_iprintf(buffer, "stop_threshold: %lu\n", runtime->stop_threshold);
428 snd_iprintf(buffer, "silence_threshold: %lu\n", runtime->silence_threshold);
429 snd_iprintf(buffer, "silence_size: %lu\n", runtime->silence_size);
430 snd_iprintf(buffer, "boundary: %lu\n", runtime->boundary);
433 static void snd_pcm_substream_proc_status_read(struct snd_info_entry *entry,
434 struct snd_info_buffer *buffer)
436 struct snd_pcm_substream *substream = entry->private_data;
437 struct snd_pcm_runtime *runtime;
438 struct snd_pcm_status64 status;
441 guard(mutex)(&substream->pcm->open_mutex);
442 runtime = substream->runtime;
444 snd_iprintf(buffer, "closed\n");
447 memset(&status, 0, sizeof(status));
448 err = snd_pcm_status64(substream, &status);
450 snd_iprintf(buffer, "error %d\n", err);
453 snd_iprintf(buffer, "state: %s\n", snd_pcm_state_name(status.state));
454 snd_iprintf(buffer, "owner_pid : %d\n", pid_vnr(substream->pid));
455 snd_iprintf(buffer, "trigger_time: %lld.%09lld\n",
456 status.trigger_tstamp_sec, status.trigger_tstamp_nsec);
457 snd_iprintf(buffer, "tstamp : %lld.%09lld\n",
458 status.tstamp_sec, status.tstamp_nsec);
459 snd_iprintf(buffer, "delay : %ld\n", status.delay);
460 snd_iprintf(buffer, "avail : %ld\n", status.avail);
461 snd_iprintf(buffer, "avail_max : %ld\n", status.avail_max);
462 snd_iprintf(buffer, "-----\n");
463 snd_iprintf(buffer, "hw_ptr : %ld\n", runtime->status->hw_ptr);
464 snd_iprintf(buffer, "appl_ptr : %ld\n", runtime->control->appl_ptr);
467 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
468 static void snd_pcm_xrun_injection_write(struct snd_info_entry *entry,
469 struct snd_info_buffer *buffer)
471 struct snd_pcm_substream *substream = entry->private_data;
473 snd_pcm_stop_xrun(substream);
476 static void snd_pcm_xrun_debug_read(struct snd_info_entry *entry,
477 struct snd_info_buffer *buffer)
479 struct snd_pcm_str *pstr = entry->private_data;
480 snd_iprintf(buffer, "%d\n", pstr->xrun_debug);
483 static void snd_pcm_xrun_debug_write(struct snd_info_entry *entry,
484 struct snd_info_buffer *buffer)
486 struct snd_pcm_str *pstr = entry->private_data;
488 if (!snd_info_get_line(buffer, line, sizeof(line)))
489 pstr->xrun_debug = simple_strtoul(line, NULL, 10);
493 static int snd_pcm_stream_proc_init(struct snd_pcm_str *pstr)
495 struct snd_pcm *pcm = pstr->pcm;
496 struct snd_info_entry *entry;
499 sprintf(name, "pcm%i%c", pcm->device,
500 pstr->stream == SNDRV_PCM_STREAM_PLAYBACK ? 'p' : 'c');
501 entry = snd_info_create_card_entry(pcm->card, name,
502 pcm->card->proc_root);
505 entry->mode = S_IFDIR | 0555;
506 pstr->proc_root = entry;
507 entry = snd_info_create_card_entry(pcm->card, "info", pstr->proc_root);
509 snd_info_set_text_ops(entry, pstr, snd_pcm_stream_proc_info_read);
510 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
511 entry = snd_info_create_card_entry(pcm->card, "xrun_debug",
514 snd_info_set_text_ops(entry, pstr, snd_pcm_xrun_debug_read);
515 entry->c.text.write = snd_pcm_xrun_debug_write;
522 static int snd_pcm_stream_proc_done(struct snd_pcm_str *pstr)
524 snd_info_free_entry(pstr->proc_root);
525 pstr->proc_root = NULL;
529 static struct snd_info_entry *
530 create_substream_info_entry(struct snd_pcm_substream *substream,
532 void (*read)(struct snd_info_entry *,
533 struct snd_info_buffer *))
535 struct snd_info_entry *entry;
537 entry = snd_info_create_card_entry(substream->pcm->card, name,
538 substream->proc_root);
540 snd_info_set_text_ops(entry, substream, read);
544 static int snd_pcm_substream_proc_init(struct snd_pcm_substream *substream)
546 struct snd_info_entry *entry;
547 struct snd_card *card;
550 card = substream->pcm->card;
552 sprintf(name, "sub%i", substream->number);
553 entry = snd_info_create_card_entry(card, name,
554 substream->pstr->proc_root);
557 entry->mode = S_IFDIR | 0555;
558 substream->proc_root = entry;
560 create_substream_info_entry(substream, "info",
561 snd_pcm_substream_proc_info_read);
562 create_substream_info_entry(substream, "hw_params",
563 snd_pcm_substream_proc_hw_params_read);
564 create_substream_info_entry(substream, "sw_params",
565 snd_pcm_substream_proc_sw_params_read);
566 create_substream_info_entry(substream, "status",
567 snd_pcm_substream_proc_status_read);
569 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
570 entry = create_substream_info_entry(substream, "xrun_injection", NULL);
572 entry->c.text.write = snd_pcm_xrun_injection_write;
573 entry->mode = S_IFREG | 0200;
575 #endif /* CONFIG_SND_PCM_XRUN_DEBUG */
580 #else /* !CONFIG_SND_VERBOSE_PROCFS */
581 static inline int snd_pcm_stream_proc_init(struct snd_pcm_str *pstr) { return 0; }
582 static inline int snd_pcm_stream_proc_done(struct snd_pcm_str *pstr) { return 0; }
583 static inline int snd_pcm_substream_proc_init(struct snd_pcm_substream *substream) { return 0; }
584 #endif /* CONFIG_SND_VERBOSE_PROCFS */
586 static const struct attribute_group *pcm_dev_attr_groups[];
589 * PM callbacks: we need to deal only with suspend here, as the resume is
590 * triggered either from user-space or the driver's resume callback
592 #ifdef CONFIG_PM_SLEEP
593 static int do_pcm_suspend(struct device *dev)
595 struct snd_pcm_str *pstr = dev_get_drvdata(dev);
597 if (!pstr->pcm->no_device_suspend)
598 snd_pcm_suspend_all(pstr->pcm);
603 static const struct dev_pm_ops pcm_dev_pm_ops = {
604 SET_SYSTEM_SLEEP_PM_OPS(do_pcm_suspend, NULL)
607 /* device type for PCM -- basically only for passing PM callbacks */
608 static const struct device_type pcm_dev_type = {
610 .pm = &pcm_dev_pm_ops,
614 * snd_pcm_new_stream - create a new PCM stream
615 * @pcm: the pcm instance
616 * @stream: the stream direction, SNDRV_PCM_STREAM_XXX
617 * @substream_count: the number of substreams
619 * Creates a new stream for the pcm.
620 * The corresponding stream on the pcm must have been empty before
621 * calling this, i.e. zero must be given to the argument of
624 * Return: Zero if successful, or a negative error code on failure.
626 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count)
629 struct snd_pcm_str *pstr = &pcm->streams[stream];
630 struct snd_pcm_substream *substream, *prev;
632 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
633 mutex_init(&pstr->oss.setup_mutex);
635 pstr->stream = stream;
637 pstr->substream_count = substream_count;
638 if (!substream_count)
641 err = snd_device_alloc(&pstr->dev, pcm->card);
644 dev_set_name(pstr->dev, "pcmC%iD%i%c", pcm->card->number, pcm->device,
645 stream == SNDRV_PCM_STREAM_PLAYBACK ? 'p' : 'c');
646 pstr->dev->groups = pcm_dev_attr_groups;
647 pstr->dev->type = &pcm_dev_type;
648 dev_set_drvdata(pstr->dev, pstr);
650 if (!pcm->internal) {
651 err = snd_pcm_stream_proc_init(pstr);
653 pcm_err(pcm, "Error in snd_pcm_stream_proc_init\n");
658 for (idx = 0, prev = NULL; idx < substream_count; idx++) {
659 substream = kzalloc(sizeof(*substream), GFP_KERNEL);
662 substream->pcm = pcm;
663 substream->pstr = pstr;
664 substream->number = idx;
665 substream->stream = stream;
666 sprintf(substream->name, "subdevice #%i", idx);
667 substream->buffer_bytes_max = UINT_MAX;
669 pstr->substream = substream;
671 prev->next = substream;
673 if (!pcm->internal) {
674 err = snd_pcm_substream_proc_init(substream);
677 "Error in snd_pcm_stream_proc_init\n");
679 pstr->substream = NULL;
686 substream->group = &substream->self_group;
687 snd_pcm_group_init(&substream->self_group);
688 list_add_tail(&substream->link_list, &substream->self_group.substreams);
689 atomic_set(&substream->mmap_count, 0);
694 EXPORT_SYMBOL(snd_pcm_new_stream);
696 static int _snd_pcm_new(struct snd_card *card, const char *id, int device,
697 int playback_count, int capture_count, bool internal,
698 struct snd_pcm **rpcm)
702 static const struct snd_device_ops ops = {
703 .dev_free = snd_pcm_dev_free,
704 .dev_register = snd_pcm_dev_register,
705 .dev_disconnect = snd_pcm_dev_disconnect,
707 static const struct snd_device_ops internal_ops = {
708 .dev_free = snd_pcm_dev_free,
711 if (snd_BUG_ON(!card))
715 pcm = kzalloc(sizeof(*pcm), GFP_KERNEL);
719 pcm->device = device;
720 pcm->internal = internal;
721 mutex_init(&pcm->open_mutex);
722 init_waitqueue_head(&pcm->open_wait);
723 INIT_LIST_HEAD(&pcm->list);
725 strscpy(pcm->id, id, sizeof(pcm->id));
727 err = snd_pcm_new_stream(pcm, SNDRV_PCM_STREAM_PLAYBACK,
732 err = snd_pcm_new_stream(pcm, SNDRV_PCM_STREAM_CAPTURE, capture_count);
736 err = snd_device_new(card, SNDRV_DEV_PCM, pcm,
737 internal ? &internal_ops : &ops);
751 * snd_pcm_new - create a new PCM instance
752 * @card: the card instance
754 * @device: the device index (zero based)
755 * @playback_count: the number of substreams for playback
756 * @capture_count: the number of substreams for capture
757 * @rpcm: the pointer to store the new pcm instance
759 * Creates a new PCM instance.
761 * The pcm operators have to be set afterwards to the new instance
762 * via snd_pcm_set_ops().
764 * Return: Zero if successful, or a negative error code on failure.
766 int snd_pcm_new(struct snd_card *card, const char *id, int device,
767 int playback_count, int capture_count, struct snd_pcm **rpcm)
769 return _snd_pcm_new(card, id, device, playback_count, capture_count,
772 EXPORT_SYMBOL(snd_pcm_new);
775 * snd_pcm_new_internal - create a new internal PCM instance
776 * @card: the card instance
778 * @device: the device index (zero based - shared with normal PCMs)
779 * @playback_count: the number of substreams for playback
780 * @capture_count: the number of substreams for capture
781 * @rpcm: the pointer to store the new pcm instance
783 * Creates a new internal PCM instance with no userspace device or procfs
784 * entries. This is used by ASoC Back End PCMs in order to create a PCM that
785 * will only be used internally by kernel drivers. i.e. it cannot be opened
786 * by userspace. It provides existing ASoC components drivers with a substream
787 * and access to any private data.
789 * The pcm operators have to be set afterwards to the new instance
790 * via snd_pcm_set_ops().
792 * Return: Zero if successful, or a negative error code on failure.
794 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
795 int playback_count, int capture_count,
796 struct snd_pcm **rpcm)
798 return _snd_pcm_new(card, id, device, playback_count, capture_count,
801 EXPORT_SYMBOL(snd_pcm_new_internal);
803 static void free_chmap(struct snd_pcm_str *pstr)
805 if (pstr->chmap_kctl) {
806 struct snd_card *card = pstr->pcm->card;
808 snd_ctl_remove(card, pstr->chmap_kctl);
809 pstr->chmap_kctl = NULL;
813 static void snd_pcm_free_stream(struct snd_pcm_str * pstr)
815 struct snd_pcm_substream *substream, *substream_next;
816 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
817 struct snd_pcm_oss_setup *setup, *setupn;
820 /* free all proc files under the stream */
821 snd_pcm_stream_proc_done(pstr);
823 substream = pstr->substream;
825 substream_next = substream->next;
826 snd_pcm_timer_done(substream);
828 substream = substream_next;
830 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
831 for (setup = pstr->oss.setup_list; setup; setup = setupn) {
832 setupn = setup->next;
833 kfree(setup->task_name);
838 if (pstr->substream_count)
839 put_device(pstr->dev);
842 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
843 #define pcm_call_notify(pcm, call) \
845 struct snd_pcm_notify *_notify; \
846 list_for_each_entry(_notify, &snd_pcm_notify_list, list) \
847 _notify->call(pcm); \
850 #define pcm_call_notify(pcm, call) do {} while (0)
853 static int snd_pcm_free(struct snd_pcm *pcm)
858 pcm_call_notify(pcm, n_unregister);
859 if (pcm->private_free)
860 pcm->private_free(pcm);
861 snd_pcm_lib_preallocate_free_for_all(pcm);
862 snd_pcm_free_stream(&pcm->streams[SNDRV_PCM_STREAM_PLAYBACK]);
863 snd_pcm_free_stream(&pcm->streams[SNDRV_PCM_STREAM_CAPTURE]);
868 static int snd_pcm_dev_free(struct snd_device *device)
870 struct snd_pcm *pcm = device->device_data;
871 return snd_pcm_free(pcm);
874 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream,
876 struct snd_pcm_substream **rsubstream)
878 struct snd_pcm_str * pstr;
879 struct snd_pcm_substream *substream;
880 struct snd_pcm_runtime *runtime;
881 struct snd_card *card;
882 int prefer_subdevice;
885 if (snd_BUG_ON(!pcm || !rsubstream))
887 if (snd_BUG_ON(stream != SNDRV_PCM_STREAM_PLAYBACK &&
888 stream != SNDRV_PCM_STREAM_CAPTURE))
891 pstr = &pcm->streams[stream];
892 if (pstr->substream == NULL || pstr->substream_count == 0)
896 prefer_subdevice = snd_ctl_get_preferred_subdevice(card, SND_CTL_SUBDEV_PCM);
898 if (pcm->info_flags & SNDRV_PCM_INFO_HALF_DUPLEX) {
899 int opposite = !stream;
901 for (substream = pcm->streams[opposite].substream; substream;
902 substream = substream->next) {
903 if (SUBSTREAM_BUSY(substream))
908 if (file->f_flags & O_APPEND) {
909 if (prefer_subdevice < 0) {
910 if (pstr->substream_count > 1)
911 return -EINVAL; /* must be unique */
912 substream = pstr->substream;
914 for (substream = pstr->substream; substream;
915 substream = substream->next)
916 if (substream->number == prefer_subdevice)
921 if (! SUBSTREAM_BUSY(substream))
923 substream->ref_count++;
924 *rsubstream = substream;
928 for (substream = pstr->substream; substream; substream = substream->next) {
929 if (!SUBSTREAM_BUSY(substream) &&
930 (prefer_subdevice == -1 ||
931 substream->number == prefer_subdevice))
934 if (substream == NULL)
937 runtime = kzalloc(sizeof(*runtime), GFP_KERNEL);
941 size = PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status));
942 runtime->status = alloc_pages_exact(size, GFP_KERNEL);
943 if (runtime->status == NULL) {
947 memset(runtime->status, 0, size);
949 size = PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control));
950 runtime->control = alloc_pages_exact(size, GFP_KERNEL);
951 if (runtime->control == NULL) {
952 free_pages_exact(runtime->status,
953 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)));
957 memset(runtime->control, 0, size);
959 init_waitqueue_head(&runtime->sleep);
960 init_waitqueue_head(&runtime->tsleep);
962 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_OPEN);
963 mutex_init(&runtime->buffer_mutex);
964 atomic_set(&runtime->buffer_accessing, 0);
966 substream->runtime = runtime;
967 substream->private_data = pcm->private_data;
968 substream->ref_count = 1;
969 substream->f_flags = file->f_flags;
970 substream->pid = get_pid(task_pid(current));
971 pstr->substream_opened++;
972 *rsubstream = substream;
976 void snd_pcm_detach_substream(struct snd_pcm_substream *substream)
978 struct snd_pcm_runtime *runtime;
980 if (PCM_RUNTIME_CHECK(substream))
982 runtime = substream->runtime;
983 if (runtime->private_free != NULL)
984 runtime->private_free(runtime);
985 free_pages_exact(runtime->status,
986 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)));
987 free_pages_exact(runtime->control,
988 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)));
989 kfree(runtime->hw_constraints.rules);
990 /* Avoid concurrent access to runtime via PCM timer interface */
991 if (substream->timer) {
992 scoped_guard(spinlock_irq, &substream->timer->lock)
993 substream->runtime = NULL;
995 substream->runtime = NULL;
997 mutex_destroy(&runtime->buffer_mutex);
998 snd_fasync_free(runtime->fasync);
1000 put_pid(substream->pid);
1001 substream->pid = NULL;
1002 substream->pstr->substream_opened--;
1005 static ssize_t pcm_class_show(struct device *dev,
1006 struct device_attribute *attr, char *buf)
1008 struct snd_pcm_str *pstr = dev_get_drvdata(dev);
1009 struct snd_pcm *pcm = pstr->pcm;
1011 static const char *strs[SNDRV_PCM_CLASS_LAST + 1] = {
1012 [SNDRV_PCM_CLASS_GENERIC] = "generic",
1013 [SNDRV_PCM_CLASS_MULTI] = "multi",
1014 [SNDRV_PCM_CLASS_MODEM] = "modem",
1015 [SNDRV_PCM_CLASS_DIGITIZER] = "digitizer",
1018 if (pcm->dev_class > SNDRV_PCM_CLASS_LAST)
1021 str = strs[pcm->dev_class];
1022 return sysfs_emit(buf, "%s\n", str);
1025 static DEVICE_ATTR_RO(pcm_class);
1026 static struct attribute *pcm_dev_attrs[] = {
1027 &dev_attr_pcm_class.attr,
1031 static const struct attribute_group pcm_dev_attr_group = {
1032 .attrs = pcm_dev_attrs,
1035 static const struct attribute_group *pcm_dev_attr_groups[] = {
1036 &pcm_dev_attr_group,
1040 static int snd_pcm_dev_register(struct snd_device *device)
1043 struct snd_pcm_substream *substream;
1044 struct snd_pcm *pcm;
1046 if (snd_BUG_ON(!device || !device->device_data))
1048 pcm = device->device_data;
1050 guard(mutex)(®ister_mutex);
1051 err = snd_pcm_add(pcm);
1054 for (cidx = 0; cidx < 2; cidx++) {
1056 if (pcm->streams[cidx].substream == NULL)
1059 case SNDRV_PCM_STREAM_PLAYBACK:
1060 devtype = SNDRV_DEVICE_TYPE_PCM_PLAYBACK;
1062 case SNDRV_PCM_STREAM_CAPTURE:
1063 devtype = SNDRV_DEVICE_TYPE_PCM_CAPTURE;
1067 err = snd_register_device(devtype, pcm->card, pcm->device,
1068 &snd_pcm_f_ops[cidx], pcm,
1069 pcm->streams[cidx].dev);
1071 list_del_init(&pcm->list);
1075 for (substream = pcm->streams[cidx].substream; substream; substream = substream->next)
1076 snd_pcm_timer_init(substream);
1079 pcm_call_notify(pcm, n_register);
1083 static int snd_pcm_dev_disconnect(struct snd_device *device)
1085 struct snd_pcm *pcm = device->device_data;
1086 struct snd_pcm_substream *substream;
1089 guard(mutex)(®ister_mutex);
1090 guard(mutex)(&pcm->open_mutex);
1091 wake_up(&pcm->open_wait);
1092 list_del_init(&pcm->list);
1094 for_each_pcm_substream(pcm, cidx, substream) {
1095 snd_pcm_stream_lock_irq(substream);
1096 if (substream->runtime) {
1097 if (snd_pcm_running(substream))
1098 snd_pcm_stop(substream, SNDRV_PCM_STATE_DISCONNECTED);
1099 /* to be sure, set the state unconditionally */
1100 __snd_pcm_set_state(substream->runtime,
1101 SNDRV_PCM_STATE_DISCONNECTED);
1102 wake_up(&substream->runtime->sleep);
1103 wake_up(&substream->runtime->tsleep);
1105 snd_pcm_stream_unlock_irq(substream);
1108 for_each_pcm_substream(pcm, cidx, substream)
1109 snd_pcm_sync_stop(substream, false);
1111 pcm_call_notify(pcm, n_disconnect);
1112 for (cidx = 0; cidx < 2; cidx++) {
1113 if (pcm->streams[cidx].dev)
1114 snd_unregister_device(pcm->streams[cidx].dev);
1115 free_chmap(&pcm->streams[cidx]);
1120 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
1122 * snd_pcm_notify - Add/remove the notify list
1123 * @notify: PCM notify list
1124 * @nfree: 0 = register, 1 = unregister
1126 * This adds the given notifier to the global list so that the callback is
1127 * called for each registered PCM devices. This exists only for PCM OSS
1128 * emulation, so far.
1130 * Return: zero if successful, or a negative error code
1132 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree)
1134 struct snd_pcm *pcm;
1136 if (snd_BUG_ON(!notify ||
1137 !notify->n_register ||
1138 !notify->n_unregister ||
1139 !notify->n_disconnect))
1141 guard(mutex)(®ister_mutex);
1143 list_del(¬ify->list);
1144 list_for_each_entry(pcm, &snd_pcm_devices, list)
1145 notify->n_unregister(pcm);
1147 list_add_tail(¬ify->list, &snd_pcm_notify_list);
1148 list_for_each_entry(pcm, &snd_pcm_devices, list)
1149 notify->n_register(pcm);
1153 EXPORT_SYMBOL(snd_pcm_notify);
1154 #endif /* CONFIG_SND_PCM_OSS */
1156 #ifdef CONFIG_SND_PROC_FS
1161 static void snd_pcm_proc_read(struct snd_info_entry *entry,
1162 struct snd_info_buffer *buffer)
1164 struct snd_pcm *pcm;
1166 guard(mutex)(®ister_mutex);
1167 list_for_each_entry(pcm, &snd_pcm_devices, list) {
1168 snd_iprintf(buffer, "%02i-%02i: %s : %s",
1169 pcm->card->number, pcm->device, pcm->id, pcm->name);
1170 if (pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream)
1171 snd_iprintf(buffer, " : playback %i",
1172 pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream_count);
1173 if (pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream)
1174 snd_iprintf(buffer, " : capture %i",
1175 pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream_count);
1176 snd_iprintf(buffer, "\n");
1180 static struct snd_info_entry *snd_pcm_proc_entry;
1182 static void snd_pcm_proc_init(void)
1184 struct snd_info_entry *entry;
1186 entry = snd_info_create_module_entry(THIS_MODULE, "pcm", NULL);
1188 snd_info_set_text_ops(entry, NULL, snd_pcm_proc_read);
1189 if (snd_info_register(entry) < 0) {
1190 snd_info_free_entry(entry);
1194 snd_pcm_proc_entry = entry;
1197 static void snd_pcm_proc_done(void)
1199 snd_info_free_entry(snd_pcm_proc_entry);
1202 #else /* !CONFIG_SND_PROC_FS */
1203 #define snd_pcm_proc_init()
1204 #define snd_pcm_proc_done()
1205 #endif /* CONFIG_SND_PROC_FS */
1212 static int __init alsa_pcm_init(void)
1214 snd_ctl_register_ioctl(snd_pcm_control_ioctl);
1215 snd_ctl_register_ioctl_compat(snd_pcm_control_ioctl);
1216 snd_pcm_proc_init();
1220 static void __exit alsa_pcm_exit(void)
1222 snd_ctl_unregister_ioctl(snd_pcm_control_ioctl);
1223 snd_ctl_unregister_ioctl_compat(snd_pcm_control_ioctl);
1224 snd_pcm_proc_done();
1227 module_init(alsa_pcm_init)
1228 module_exit(alsa_pcm_exit)