2 * Digital Audio (PCM) abstract layer
3 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <linux/init.h>
23 #include <linux/slab.h>
24 #include <linux/module.h>
25 #include <linux/time.h>
26 #include <linux/mutex.h>
27 #include <linux/device.h>
28 #include <sound/core.h>
29 #include <sound/minors.h>
30 #include <sound/pcm.h>
31 #include <sound/control.h>
32 #include <sound/info.h>
34 #include "pcm_local.h"
36 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>, Abramo Bagnara <abramo@alsa-project.org>");
37 MODULE_DESCRIPTION("Midlevel PCM code for ALSA.");
38 MODULE_LICENSE("GPL");
40 static LIST_HEAD(snd_pcm_devices);
41 static DEFINE_MUTEX(register_mutex);
42 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
43 static LIST_HEAD(snd_pcm_notify_list);
46 static int snd_pcm_free(struct snd_pcm *pcm);
47 static int snd_pcm_dev_free(struct snd_device *device);
48 static int snd_pcm_dev_register(struct snd_device *device);
49 static int snd_pcm_dev_disconnect(struct snd_device *device);
51 static struct snd_pcm *snd_pcm_get(struct snd_card *card, int device)
55 list_for_each_entry(pcm, &snd_pcm_devices, list) {
56 if (pcm->card == card && pcm->device == device)
62 static int snd_pcm_next(struct snd_card *card, int device)
66 list_for_each_entry(pcm, &snd_pcm_devices, list) {
67 if (pcm->card == card && pcm->device > device)
69 else if (pcm->card->number > card->number)
75 static int snd_pcm_add(struct snd_pcm *newpcm)
82 list_for_each_entry(pcm, &snd_pcm_devices, list) {
83 if (pcm->card == newpcm->card && pcm->device == newpcm->device)
85 if (pcm->card->number > newpcm->card->number ||
86 (pcm->card == newpcm->card &&
87 pcm->device > newpcm->device)) {
88 list_add(&newpcm->list, pcm->list.prev);
92 list_add_tail(&newpcm->list, &snd_pcm_devices);
96 static int snd_pcm_control_ioctl(struct snd_card *card,
97 struct snd_ctl_file *control,
98 unsigned int cmd, unsigned long arg)
101 case SNDRV_CTL_IOCTL_PCM_NEXT_DEVICE:
105 if (get_user(device, (int __user *)arg))
107 mutex_lock(®ister_mutex);
108 device = snd_pcm_next(card, device);
109 mutex_unlock(®ister_mutex);
110 if (put_user(device, (int __user *)arg))
114 case SNDRV_CTL_IOCTL_PCM_INFO:
116 struct snd_pcm_info __user *info;
117 unsigned int device, subdevice;
120 struct snd_pcm_str *pstr;
121 struct snd_pcm_substream *substream;
124 info = (struct snd_pcm_info __user *)arg;
125 if (get_user(device, &info->device))
127 if (get_user(stream, &info->stream))
129 if (stream < 0 || stream > 1)
131 if (get_user(subdevice, &info->subdevice))
133 mutex_lock(®ister_mutex);
134 pcm = snd_pcm_get(card, device);
139 pstr = &pcm->streams[stream];
140 if (pstr->substream_count == 0) {
144 if (subdevice >= pstr->substream_count) {
148 for (substream = pstr->substream; substream;
149 substream = substream->next)
150 if (substream->number == (int)subdevice)
152 if (substream == NULL) {
156 err = snd_pcm_info_user(substream, info);
158 mutex_unlock(®ister_mutex);
161 case SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE:
165 if (get_user(val, (int __user *)arg))
167 control->preferred_subdevice[SND_CTL_SUBDEV_PCM] = val;
174 #define FORMAT(v) [SNDRV_PCM_FORMAT_##v] = #v
176 static char *snd_pcm_format_names[] = {
195 FORMAT(IEC958_SUBFRAME_LE),
196 FORMAT(IEC958_SUBFRAME_BE),
227 * snd_pcm_format_name - Return a name string for the given PCM format
228 * @format: PCM format
230 const char *snd_pcm_format_name(snd_pcm_format_t format)
232 if ((__force unsigned int)format >= ARRAY_SIZE(snd_pcm_format_names))
234 return snd_pcm_format_names[(__force unsigned int)format];
236 EXPORT_SYMBOL_GPL(snd_pcm_format_name);
238 #ifdef CONFIG_SND_VERBOSE_PROCFS
240 #define STATE(v) [SNDRV_PCM_STATE_##v] = #v
241 #define STREAM(v) [SNDRV_PCM_STREAM_##v] = #v
242 #define READY(v) [SNDRV_PCM_READY_##v] = #v
243 #define XRUN(v) [SNDRV_PCM_XRUN_##v] = #v
244 #define SILENCE(v) [SNDRV_PCM_SILENCE_##v] = #v
245 #define TSTAMP(v) [SNDRV_PCM_TSTAMP_##v] = #v
246 #define ACCESS(v) [SNDRV_PCM_ACCESS_##v] = #v
247 #define START(v) [SNDRV_PCM_START_##v] = #v
248 #define SUBFORMAT(v) [SNDRV_PCM_SUBFORMAT_##v] = #v
250 static char *snd_pcm_stream_names[] = {
255 static char *snd_pcm_state_names[] = {
266 static char *snd_pcm_access_names[] = {
267 ACCESS(MMAP_INTERLEAVED),
268 ACCESS(MMAP_NONINTERLEAVED),
269 ACCESS(MMAP_COMPLEX),
270 ACCESS(RW_INTERLEAVED),
271 ACCESS(RW_NONINTERLEAVED),
274 static char *snd_pcm_subformat_names[] = {
278 static char *snd_pcm_tstamp_mode_names[] = {
283 static const char *snd_pcm_stream_name(int stream)
285 return snd_pcm_stream_names[stream];
288 static const char *snd_pcm_access_name(snd_pcm_access_t access)
290 return snd_pcm_access_names[(__force int)access];
293 static const char *snd_pcm_subformat_name(snd_pcm_subformat_t subformat)
295 return snd_pcm_subformat_names[(__force int)subformat];
298 static const char *snd_pcm_tstamp_mode_name(int mode)
300 return snd_pcm_tstamp_mode_names[mode];
303 static const char *snd_pcm_state_name(snd_pcm_state_t state)
305 return snd_pcm_state_names[(__force int)state];
308 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
309 #include <linux/soundcard.h>
311 static const char *snd_pcm_oss_format_name(int format)
340 static void snd_pcm_proc_info_read(struct snd_pcm_substream *substream,
341 struct snd_info_buffer *buffer)
343 struct snd_pcm_info *info;
349 info = kmalloc(sizeof(*info), GFP_KERNEL);
353 err = snd_pcm_info(substream, info);
355 snd_iprintf(buffer, "error %d\n", err);
359 snd_iprintf(buffer, "card: %d\n", info->card);
360 snd_iprintf(buffer, "device: %d\n", info->device);
361 snd_iprintf(buffer, "subdevice: %d\n", info->subdevice);
362 snd_iprintf(buffer, "stream: %s\n", snd_pcm_stream_name(info->stream));
363 snd_iprintf(buffer, "id: %s\n", info->id);
364 snd_iprintf(buffer, "name: %s\n", info->name);
365 snd_iprintf(buffer, "subname: %s\n", info->subname);
366 snd_iprintf(buffer, "class: %d\n", info->dev_class);
367 snd_iprintf(buffer, "subclass: %d\n", info->dev_subclass);
368 snd_iprintf(buffer, "subdevices_count: %d\n", info->subdevices_count);
369 snd_iprintf(buffer, "subdevices_avail: %d\n", info->subdevices_avail);
373 static void snd_pcm_stream_proc_info_read(struct snd_info_entry *entry,
374 struct snd_info_buffer *buffer)
376 snd_pcm_proc_info_read(((struct snd_pcm_str *)entry->private_data)->substream,
380 static void snd_pcm_substream_proc_info_read(struct snd_info_entry *entry,
381 struct snd_info_buffer *buffer)
383 snd_pcm_proc_info_read(entry->private_data, buffer);
386 static void snd_pcm_substream_proc_hw_params_read(struct snd_info_entry *entry,
387 struct snd_info_buffer *buffer)
389 struct snd_pcm_substream *substream = entry->private_data;
390 struct snd_pcm_runtime *runtime;
392 mutex_lock(&substream->pcm->open_mutex);
393 runtime = substream->runtime;
395 snd_iprintf(buffer, "closed\n");
398 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
399 snd_iprintf(buffer, "no setup\n");
402 snd_iprintf(buffer, "access: %s\n", snd_pcm_access_name(runtime->access));
403 snd_iprintf(buffer, "format: %s\n", snd_pcm_format_name(runtime->format));
404 snd_iprintf(buffer, "subformat: %s\n", snd_pcm_subformat_name(runtime->subformat));
405 snd_iprintf(buffer, "channels: %u\n", runtime->channels);
406 snd_iprintf(buffer, "rate: %u (%u/%u)\n", runtime->rate, runtime->rate_num, runtime->rate_den);
407 snd_iprintf(buffer, "period_size: %lu\n", runtime->period_size);
408 snd_iprintf(buffer, "buffer_size: %lu\n", runtime->buffer_size);
409 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
410 if (substream->oss.oss) {
411 snd_iprintf(buffer, "OSS format: %s\n", snd_pcm_oss_format_name(runtime->oss.format));
412 snd_iprintf(buffer, "OSS channels: %u\n", runtime->oss.channels);
413 snd_iprintf(buffer, "OSS rate: %u\n", runtime->oss.rate);
414 snd_iprintf(buffer, "OSS period bytes: %lu\n", (unsigned long)runtime->oss.period_bytes);
415 snd_iprintf(buffer, "OSS periods: %u\n", runtime->oss.periods);
416 snd_iprintf(buffer, "OSS period frames: %lu\n", (unsigned long)runtime->oss.period_frames);
420 mutex_unlock(&substream->pcm->open_mutex);
423 static void snd_pcm_substream_proc_sw_params_read(struct snd_info_entry *entry,
424 struct snd_info_buffer *buffer)
426 struct snd_pcm_substream *substream = entry->private_data;
427 struct snd_pcm_runtime *runtime;
429 mutex_lock(&substream->pcm->open_mutex);
430 runtime = substream->runtime;
432 snd_iprintf(buffer, "closed\n");
435 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
436 snd_iprintf(buffer, "no setup\n");
439 snd_iprintf(buffer, "tstamp_mode: %s\n", snd_pcm_tstamp_mode_name(runtime->tstamp_mode));
440 snd_iprintf(buffer, "period_step: %u\n", runtime->period_step);
441 snd_iprintf(buffer, "avail_min: %lu\n", runtime->control->avail_min);
442 snd_iprintf(buffer, "start_threshold: %lu\n", runtime->start_threshold);
443 snd_iprintf(buffer, "stop_threshold: %lu\n", runtime->stop_threshold);
444 snd_iprintf(buffer, "silence_threshold: %lu\n", runtime->silence_threshold);
445 snd_iprintf(buffer, "silence_size: %lu\n", runtime->silence_size);
446 snd_iprintf(buffer, "boundary: %lu\n", runtime->boundary);
448 mutex_unlock(&substream->pcm->open_mutex);
451 static void snd_pcm_substream_proc_status_read(struct snd_info_entry *entry,
452 struct snd_info_buffer *buffer)
454 struct snd_pcm_substream *substream = entry->private_data;
455 struct snd_pcm_runtime *runtime;
456 struct snd_pcm_status status;
459 mutex_lock(&substream->pcm->open_mutex);
460 runtime = substream->runtime;
462 snd_iprintf(buffer, "closed\n");
465 memset(&status, 0, sizeof(status));
466 err = snd_pcm_status(substream, &status);
468 snd_iprintf(buffer, "error %d\n", err);
471 snd_iprintf(buffer, "state: %s\n", snd_pcm_state_name(status.state));
472 snd_iprintf(buffer, "owner_pid : %d\n", pid_vnr(substream->pid));
473 snd_iprintf(buffer, "trigger_time: %ld.%09ld\n",
474 status.trigger_tstamp.tv_sec, status.trigger_tstamp.tv_nsec);
475 snd_iprintf(buffer, "tstamp : %ld.%09ld\n",
476 status.tstamp.tv_sec, status.tstamp.tv_nsec);
477 snd_iprintf(buffer, "delay : %ld\n", status.delay);
478 snd_iprintf(buffer, "avail : %ld\n", status.avail);
479 snd_iprintf(buffer, "avail_max : %ld\n", status.avail_max);
480 snd_iprintf(buffer, "-----\n");
481 snd_iprintf(buffer, "hw_ptr : %ld\n", runtime->status->hw_ptr);
482 snd_iprintf(buffer, "appl_ptr : %ld\n", runtime->control->appl_ptr);
484 mutex_unlock(&substream->pcm->open_mutex);
487 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
488 static void snd_pcm_xrun_injection_write(struct snd_info_entry *entry,
489 struct snd_info_buffer *buffer)
491 struct snd_pcm_substream *substream = entry->private_data;
492 struct snd_pcm_runtime *runtime;
494 snd_pcm_stream_lock_irq(substream);
495 runtime = substream->runtime;
496 if (runtime && runtime->status->state == SNDRV_PCM_STATE_RUNNING)
497 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
498 snd_pcm_stream_unlock_irq(substream);
501 static void snd_pcm_xrun_debug_read(struct snd_info_entry *entry,
502 struct snd_info_buffer *buffer)
504 struct snd_pcm_str *pstr = entry->private_data;
505 snd_iprintf(buffer, "%d\n", pstr->xrun_debug);
508 static void snd_pcm_xrun_debug_write(struct snd_info_entry *entry,
509 struct snd_info_buffer *buffer)
511 struct snd_pcm_str *pstr = entry->private_data;
513 if (!snd_info_get_line(buffer, line, sizeof(line)))
514 pstr->xrun_debug = simple_strtoul(line, NULL, 10);
518 static int snd_pcm_stream_proc_init(struct snd_pcm_str *pstr)
520 struct snd_pcm *pcm = pstr->pcm;
521 struct snd_info_entry *entry;
524 sprintf(name, "pcm%i%c", pcm->device,
525 pstr->stream == SNDRV_PCM_STREAM_PLAYBACK ? 'p' : 'c');
526 if ((entry = snd_info_create_card_entry(pcm->card, name, pcm->card->proc_root)) == NULL)
528 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
529 if (snd_info_register(entry) < 0) {
530 snd_info_free_entry(entry);
533 pstr->proc_root = entry;
535 if ((entry = snd_info_create_card_entry(pcm->card, "info", pstr->proc_root)) != NULL) {
536 snd_info_set_text_ops(entry, pstr, snd_pcm_stream_proc_info_read);
537 if (snd_info_register(entry) < 0) {
538 snd_info_free_entry(entry);
542 pstr->proc_info_entry = entry;
544 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
545 if ((entry = snd_info_create_card_entry(pcm->card, "xrun_debug",
546 pstr->proc_root)) != NULL) {
547 entry->c.text.read = snd_pcm_xrun_debug_read;
548 entry->c.text.write = snd_pcm_xrun_debug_write;
549 entry->mode |= S_IWUSR;
550 entry->private_data = pstr;
551 if (snd_info_register(entry) < 0) {
552 snd_info_free_entry(entry);
556 pstr->proc_xrun_debug_entry = entry;
561 static int snd_pcm_stream_proc_done(struct snd_pcm_str *pstr)
563 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
564 snd_info_free_entry(pstr->proc_xrun_debug_entry);
565 pstr->proc_xrun_debug_entry = NULL;
567 snd_info_free_entry(pstr->proc_info_entry);
568 pstr->proc_info_entry = NULL;
569 snd_info_free_entry(pstr->proc_root);
570 pstr->proc_root = NULL;
574 static int snd_pcm_substream_proc_init(struct snd_pcm_substream *substream)
576 struct snd_info_entry *entry;
577 struct snd_card *card;
580 card = substream->pcm->card;
582 sprintf(name, "sub%i", substream->number);
583 if ((entry = snd_info_create_card_entry(card, name, substream->pstr->proc_root)) == NULL)
585 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
586 if (snd_info_register(entry) < 0) {
587 snd_info_free_entry(entry);
590 substream->proc_root = entry;
592 if ((entry = snd_info_create_card_entry(card, "info", substream->proc_root)) != NULL) {
593 snd_info_set_text_ops(entry, substream,
594 snd_pcm_substream_proc_info_read);
595 if (snd_info_register(entry) < 0) {
596 snd_info_free_entry(entry);
600 substream->proc_info_entry = entry;
602 if ((entry = snd_info_create_card_entry(card, "hw_params", substream->proc_root)) != NULL) {
603 snd_info_set_text_ops(entry, substream,
604 snd_pcm_substream_proc_hw_params_read);
605 if (snd_info_register(entry) < 0) {
606 snd_info_free_entry(entry);
610 substream->proc_hw_params_entry = entry;
612 if ((entry = snd_info_create_card_entry(card, "sw_params", substream->proc_root)) != NULL) {
613 snd_info_set_text_ops(entry, substream,
614 snd_pcm_substream_proc_sw_params_read);
615 if (snd_info_register(entry) < 0) {
616 snd_info_free_entry(entry);
620 substream->proc_sw_params_entry = entry;
622 if ((entry = snd_info_create_card_entry(card, "status", substream->proc_root)) != NULL) {
623 snd_info_set_text_ops(entry, substream,
624 snd_pcm_substream_proc_status_read);
625 if (snd_info_register(entry) < 0) {
626 snd_info_free_entry(entry);
630 substream->proc_status_entry = entry;
632 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
633 entry = snd_info_create_card_entry(card, "xrun_injection",
634 substream->proc_root);
636 entry->private_data = substream;
637 entry->c.text.read = NULL;
638 entry->c.text.write = snd_pcm_xrun_injection_write;
639 entry->mode = S_IFREG | S_IWUSR;
640 if (snd_info_register(entry) < 0) {
641 snd_info_free_entry(entry);
645 substream->proc_xrun_injection_entry = entry;
646 #endif /* CONFIG_SND_PCM_XRUN_DEBUG */
651 static int snd_pcm_substream_proc_done(struct snd_pcm_substream *substream)
653 snd_info_free_entry(substream->proc_info_entry);
654 substream->proc_info_entry = NULL;
655 snd_info_free_entry(substream->proc_hw_params_entry);
656 substream->proc_hw_params_entry = NULL;
657 snd_info_free_entry(substream->proc_sw_params_entry);
658 substream->proc_sw_params_entry = NULL;
659 snd_info_free_entry(substream->proc_status_entry);
660 substream->proc_status_entry = NULL;
661 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
662 snd_info_free_entry(substream->proc_xrun_injection_entry);
663 substream->proc_xrun_injection_entry = NULL;
665 snd_info_free_entry(substream->proc_root);
666 substream->proc_root = NULL;
669 #else /* !CONFIG_SND_VERBOSE_PROCFS */
670 static inline int snd_pcm_stream_proc_init(struct snd_pcm_str *pstr) { return 0; }
671 static inline int snd_pcm_stream_proc_done(struct snd_pcm_str *pstr) { return 0; }
672 static inline int snd_pcm_substream_proc_init(struct snd_pcm_substream *substream) { return 0; }
673 static inline int snd_pcm_substream_proc_done(struct snd_pcm_substream *substream) { return 0; }
674 #endif /* CONFIG_SND_VERBOSE_PROCFS */
676 static const struct attribute_group *pcm_dev_attr_groups[];
679 * snd_pcm_new_stream - create a new PCM stream
680 * @pcm: the pcm instance
681 * @stream: the stream direction, SNDRV_PCM_STREAM_XXX
682 * @substream_count: the number of substreams
684 * Creates a new stream for the pcm.
685 * The corresponding stream on the pcm must have been empty before
686 * calling this, i.e. zero must be given to the argument of
689 * Return: Zero if successful, or a negative error code on failure.
691 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count)
694 struct snd_pcm_str *pstr = &pcm->streams[stream];
695 struct snd_pcm_substream *substream, *prev;
697 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
698 mutex_init(&pstr->oss.setup_mutex);
700 pstr->stream = stream;
702 pstr->substream_count = substream_count;
703 if (!substream_count)
706 snd_device_initialize(&pstr->dev, pcm->card);
707 pstr->dev.groups = pcm_dev_attr_groups;
708 dev_set_name(&pstr->dev, "pcmC%iD%i%c", pcm->card->number, pcm->device,
709 stream == SNDRV_PCM_STREAM_PLAYBACK ? 'p' : 'c');
711 if (!pcm->internal) {
712 err = snd_pcm_stream_proc_init(pstr);
714 pcm_err(pcm, "Error in snd_pcm_stream_proc_init\n");
719 for (idx = 0, prev = NULL; idx < substream_count; idx++) {
720 substream = kzalloc(sizeof(*substream), GFP_KERNEL);
723 substream->pcm = pcm;
724 substream->pstr = pstr;
725 substream->number = idx;
726 substream->stream = stream;
727 sprintf(substream->name, "subdevice #%i", idx);
728 substream->buffer_bytes_max = UINT_MAX;
730 pstr->substream = substream;
732 prev->next = substream;
734 if (!pcm->internal) {
735 err = snd_pcm_substream_proc_init(substream);
738 "Error in snd_pcm_stream_proc_init\n");
740 pstr->substream = NULL;
747 substream->group = &substream->self_group;
748 spin_lock_init(&substream->self_group.lock);
749 mutex_init(&substream->self_group.mutex);
750 INIT_LIST_HEAD(&substream->self_group.substreams);
751 list_add_tail(&substream->link_list, &substream->self_group.substreams);
752 atomic_set(&substream->mmap_count, 0);
757 EXPORT_SYMBOL(snd_pcm_new_stream);
759 static int _snd_pcm_new(struct snd_card *card, const char *id, int device,
760 int playback_count, int capture_count, bool internal,
761 struct snd_pcm **rpcm)
765 static struct snd_device_ops ops = {
766 .dev_free = snd_pcm_dev_free,
767 .dev_register = snd_pcm_dev_register,
768 .dev_disconnect = snd_pcm_dev_disconnect,
771 if (snd_BUG_ON(!card))
775 pcm = kzalloc(sizeof(*pcm), GFP_KERNEL);
779 pcm->device = device;
780 pcm->internal = internal;
781 mutex_init(&pcm->open_mutex);
782 init_waitqueue_head(&pcm->open_wait);
783 INIT_LIST_HEAD(&pcm->list);
785 strlcpy(pcm->id, id, sizeof(pcm->id));
786 if ((err = snd_pcm_new_stream(pcm, SNDRV_PCM_STREAM_PLAYBACK, playback_count)) < 0) {
790 if ((err = snd_pcm_new_stream(pcm, SNDRV_PCM_STREAM_CAPTURE, capture_count)) < 0) {
794 if ((err = snd_device_new(card, SNDRV_DEV_PCM, pcm, &ops)) < 0) {
804 * snd_pcm_new - create a new PCM instance
805 * @card: the card instance
807 * @device: the device index (zero based)
808 * @playback_count: the number of substreams for playback
809 * @capture_count: the number of substreams for capture
810 * @rpcm: the pointer to store the new pcm instance
812 * Creates a new PCM instance.
814 * The pcm operators have to be set afterwards to the new instance
815 * via snd_pcm_set_ops().
817 * Return: Zero if successful, or a negative error code on failure.
819 int snd_pcm_new(struct snd_card *card, const char *id, int device,
820 int playback_count, int capture_count, struct snd_pcm **rpcm)
822 return _snd_pcm_new(card, id, device, playback_count, capture_count,
825 EXPORT_SYMBOL(snd_pcm_new);
828 * snd_pcm_new_internal - create a new internal PCM instance
829 * @card: the card instance
831 * @device: the device index (zero based - shared with normal PCMs)
832 * @playback_count: the number of substreams for playback
833 * @capture_count: the number of substreams for capture
834 * @rpcm: the pointer to store the new pcm instance
836 * Creates a new internal PCM instance with no userspace device or procfs
837 * entries. This is used by ASoC Back End PCMs in order to create a PCM that
838 * will only be used internally by kernel drivers. i.e. it cannot be opened
839 * by userspace. It provides existing ASoC components drivers with a substream
840 * and access to any private data.
842 * The pcm operators have to be set afterwards to the new instance
843 * via snd_pcm_set_ops().
845 * Return: Zero if successful, or a negative error code on failure.
847 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
848 int playback_count, int capture_count,
849 struct snd_pcm **rpcm)
851 return _snd_pcm_new(card, id, device, playback_count, capture_count,
854 EXPORT_SYMBOL(snd_pcm_new_internal);
856 static void free_chmap(struct snd_pcm_str *pstr)
858 if (pstr->chmap_kctl) {
859 snd_ctl_remove(pstr->pcm->card, pstr->chmap_kctl);
860 pstr->chmap_kctl = NULL;
864 static void snd_pcm_free_stream(struct snd_pcm_str * pstr)
866 struct snd_pcm_substream *substream, *substream_next;
867 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
868 struct snd_pcm_oss_setup *setup, *setupn;
870 substream = pstr->substream;
872 substream_next = substream->next;
873 snd_pcm_timer_done(substream);
874 snd_pcm_substream_proc_done(substream);
876 substream = substream_next;
878 snd_pcm_stream_proc_done(pstr);
879 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
880 for (setup = pstr->oss.setup_list; setup; setup = setupn) {
881 setupn = setup->next;
882 kfree(setup->task_name);
887 if (pstr->substream_count)
888 put_device(&pstr->dev);
891 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
892 #define pcm_call_notify(pcm, call) \
894 struct snd_pcm_notify *_notify; \
895 list_for_each_entry(_notify, &snd_pcm_notify_list, list) \
896 _notify->call(pcm); \
899 #define pcm_call_notify(pcm, call) do {} while (0)
902 static int snd_pcm_free(struct snd_pcm *pcm)
907 pcm_call_notify(pcm, n_unregister);
908 if (pcm->private_free)
909 pcm->private_free(pcm);
910 snd_pcm_lib_preallocate_free_for_all(pcm);
911 snd_pcm_free_stream(&pcm->streams[SNDRV_PCM_STREAM_PLAYBACK]);
912 snd_pcm_free_stream(&pcm->streams[SNDRV_PCM_STREAM_CAPTURE]);
917 static int snd_pcm_dev_free(struct snd_device *device)
919 struct snd_pcm *pcm = device->device_data;
920 return snd_pcm_free(pcm);
923 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream,
925 struct snd_pcm_substream **rsubstream)
927 struct snd_pcm_str * pstr;
928 struct snd_pcm_substream *substream;
929 struct snd_pcm_runtime *runtime;
930 struct snd_card *card;
931 int prefer_subdevice;
934 if (snd_BUG_ON(!pcm || !rsubstream))
936 if (snd_BUG_ON(stream != SNDRV_PCM_STREAM_PLAYBACK &&
937 stream != SNDRV_PCM_STREAM_CAPTURE))
940 pstr = &pcm->streams[stream];
941 if (pstr->substream == NULL || pstr->substream_count == 0)
945 prefer_subdevice = snd_ctl_get_preferred_subdevice(card, SND_CTL_SUBDEV_PCM);
947 if (pcm->info_flags & SNDRV_PCM_INFO_HALF_DUPLEX) {
948 int opposite = !stream;
950 for (substream = pcm->streams[opposite].substream; substream;
951 substream = substream->next) {
952 if (SUBSTREAM_BUSY(substream))
957 if (file->f_flags & O_APPEND) {
958 if (prefer_subdevice < 0) {
959 if (pstr->substream_count > 1)
960 return -EINVAL; /* must be unique */
961 substream = pstr->substream;
963 for (substream = pstr->substream; substream;
964 substream = substream->next)
965 if (substream->number == prefer_subdevice)
970 if (! SUBSTREAM_BUSY(substream))
972 substream->ref_count++;
973 *rsubstream = substream;
977 for (substream = pstr->substream; substream; substream = substream->next) {
978 if (!SUBSTREAM_BUSY(substream) &&
979 (prefer_subdevice == -1 ||
980 substream->number == prefer_subdevice))
983 if (substream == NULL)
986 runtime = kzalloc(sizeof(*runtime), GFP_KERNEL);
990 size = PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status));
991 runtime->status = snd_malloc_pages(size, GFP_KERNEL);
992 if (runtime->status == NULL) {
996 memset((void*)runtime->status, 0, size);
998 size = PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control));
999 runtime->control = snd_malloc_pages(size, GFP_KERNEL);
1000 if (runtime->control == NULL) {
1001 snd_free_pages((void*)runtime->status,
1002 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)));
1006 memset((void*)runtime->control, 0, size);
1008 init_waitqueue_head(&runtime->sleep);
1009 init_waitqueue_head(&runtime->tsleep);
1011 runtime->status->state = SNDRV_PCM_STATE_OPEN;
1013 substream->runtime = runtime;
1014 substream->private_data = pcm->private_data;
1015 substream->ref_count = 1;
1016 substream->f_flags = file->f_flags;
1017 substream->pid = get_pid(task_pid(current));
1018 pstr->substream_opened++;
1019 *rsubstream = substream;
1023 void snd_pcm_detach_substream(struct snd_pcm_substream *substream)
1025 struct snd_pcm_runtime *runtime;
1027 if (PCM_RUNTIME_CHECK(substream))
1029 runtime = substream->runtime;
1030 if (runtime->private_free != NULL)
1031 runtime->private_free(runtime);
1032 snd_free_pages((void*)runtime->status,
1033 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)));
1034 snd_free_pages((void*)runtime->control,
1035 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)));
1036 kfree(runtime->hw_constraints.rules);
1038 substream->runtime = NULL;
1039 put_pid(substream->pid);
1040 substream->pid = NULL;
1041 substream->pstr->substream_opened--;
1044 static ssize_t show_pcm_class(struct device *dev,
1045 struct device_attribute *attr, char *buf)
1047 struct snd_pcm_str *pstr = container_of(dev, struct snd_pcm_str, dev);
1048 struct snd_pcm *pcm = pstr->pcm;
1050 static const char *strs[SNDRV_PCM_CLASS_LAST + 1] = {
1051 [SNDRV_PCM_CLASS_GENERIC] = "generic",
1052 [SNDRV_PCM_CLASS_MULTI] = "multi",
1053 [SNDRV_PCM_CLASS_MODEM] = "modem",
1054 [SNDRV_PCM_CLASS_DIGITIZER] = "digitizer",
1057 if (pcm->dev_class > SNDRV_PCM_CLASS_LAST)
1060 str = strs[pcm->dev_class];
1061 return snprintf(buf, PAGE_SIZE, "%s\n", str);
1064 static DEVICE_ATTR(pcm_class, S_IRUGO, show_pcm_class, NULL);
1065 static struct attribute *pcm_dev_attrs[] = {
1066 &dev_attr_pcm_class.attr,
1070 static const struct attribute_group pcm_dev_attr_group = {
1071 .attrs = pcm_dev_attrs,
1074 static const struct attribute_group *pcm_dev_attr_groups[] = {
1075 &pcm_dev_attr_group,
1079 static int snd_pcm_dev_register(struct snd_device *device)
1082 struct snd_pcm_substream *substream;
1083 struct snd_pcm *pcm;
1085 if (snd_BUG_ON(!device || !device->device_data))
1087 pcm = device->device_data;
1091 mutex_lock(®ister_mutex);
1092 err = snd_pcm_add(pcm);
1095 for (cidx = 0; cidx < 2; cidx++) {
1097 if (pcm->streams[cidx].substream == NULL)
1100 case SNDRV_PCM_STREAM_PLAYBACK:
1101 devtype = SNDRV_DEVICE_TYPE_PCM_PLAYBACK;
1103 case SNDRV_PCM_STREAM_CAPTURE:
1104 devtype = SNDRV_DEVICE_TYPE_PCM_CAPTURE;
1108 err = snd_register_device(devtype, pcm->card, pcm->device,
1109 &snd_pcm_f_ops[cidx], pcm,
1110 &pcm->streams[cidx].dev);
1112 list_del_init(&pcm->list);
1116 for (substream = pcm->streams[cidx].substream; substream; substream = substream->next)
1117 snd_pcm_timer_init(substream);
1120 pcm_call_notify(pcm, n_register);
1123 mutex_unlock(®ister_mutex);
1127 static int snd_pcm_dev_disconnect(struct snd_device *device)
1129 struct snd_pcm *pcm = device->device_data;
1130 struct snd_pcm_substream *substream;
1133 mutex_lock(®ister_mutex);
1134 mutex_lock(&pcm->open_mutex);
1135 wake_up(&pcm->open_wait);
1136 list_del_init(&pcm->list);
1137 for (cidx = 0; cidx < 2; cidx++) {
1138 for (substream = pcm->streams[cidx].substream; substream; substream = substream->next) {
1139 snd_pcm_stream_lock_irq(substream);
1140 if (substream->runtime) {
1141 substream->runtime->status->state = SNDRV_PCM_STATE_DISCONNECTED;
1142 wake_up(&substream->runtime->sleep);
1143 wake_up(&substream->runtime->tsleep);
1145 snd_pcm_stream_unlock_irq(substream);
1148 if (!pcm->internal) {
1149 pcm_call_notify(pcm, n_disconnect);
1151 for (cidx = 0; cidx < 2; cidx++) {
1153 snd_unregister_device(&pcm->streams[cidx].dev);
1154 free_chmap(&pcm->streams[cidx]);
1156 mutex_unlock(&pcm->open_mutex);
1157 mutex_unlock(®ister_mutex);
1161 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
1163 * snd_pcm_notify - Add/remove the notify list
1164 * @notify: PCM notify list
1165 * @nfree: 0 = register, 1 = unregister
1167 * This adds the given notifier to the global list so that the callback is
1168 * called for each registered PCM devices. This exists only for PCM OSS
1169 * emulation, so far.
1171 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree)
1173 struct snd_pcm *pcm;
1175 if (snd_BUG_ON(!notify ||
1176 !notify->n_register ||
1177 !notify->n_unregister ||
1178 !notify->n_disconnect))
1180 mutex_lock(®ister_mutex);
1182 list_del(¬ify->list);
1183 list_for_each_entry(pcm, &snd_pcm_devices, list)
1184 notify->n_unregister(pcm);
1186 list_add_tail(¬ify->list, &snd_pcm_notify_list);
1187 list_for_each_entry(pcm, &snd_pcm_devices, list)
1188 notify->n_register(pcm);
1190 mutex_unlock(®ister_mutex);
1193 EXPORT_SYMBOL(snd_pcm_notify);
1194 #endif /* CONFIG_SND_PCM_OSS */
1196 #ifdef CONFIG_SND_PROC_FS
1201 static void snd_pcm_proc_read(struct snd_info_entry *entry,
1202 struct snd_info_buffer *buffer)
1204 struct snd_pcm *pcm;
1206 mutex_lock(®ister_mutex);
1207 list_for_each_entry(pcm, &snd_pcm_devices, list) {
1208 snd_iprintf(buffer, "%02i-%02i: %s : %s",
1209 pcm->card->number, pcm->device, pcm->id, pcm->name);
1210 if (pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream)
1211 snd_iprintf(buffer, " : playback %i",
1212 pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream_count);
1213 if (pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream)
1214 snd_iprintf(buffer, " : capture %i",
1215 pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream_count);
1216 snd_iprintf(buffer, "\n");
1218 mutex_unlock(®ister_mutex);
1221 static struct snd_info_entry *snd_pcm_proc_entry;
1223 static void snd_pcm_proc_init(void)
1225 struct snd_info_entry *entry;
1227 if ((entry = snd_info_create_module_entry(THIS_MODULE, "pcm", NULL)) != NULL) {
1228 snd_info_set_text_ops(entry, NULL, snd_pcm_proc_read);
1229 if (snd_info_register(entry) < 0) {
1230 snd_info_free_entry(entry);
1234 snd_pcm_proc_entry = entry;
1237 static void snd_pcm_proc_done(void)
1239 snd_info_free_entry(snd_pcm_proc_entry);
1242 #else /* !CONFIG_SND_PROC_FS */
1243 #define snd_pcm_proc_init()
1244 #define snd_pcm_proc_done()
1245 #endif /* CONFIG_SND_PROC_FS */
1252 static int __init alsa_pcm_init(void)
1254 snd_ctl_register_ioctl(snd_pcm_control_ioctl);
1255 snd_ctl_register_ioctl_compat(snd_pcm_control_ioctl);
1256 snd_pcm_proc_init();
1260 static void __exit alsa_pcm_exit(void)
1262 snd_ctl_unregister_ioctl(snd_pcm_control_ioctl);
1263 snd_ctl_unregister_ioctl_compat(snd_pcm_control_ioctl);
1264 snd_pcm_proc_done();
1267 module_init(alsa_pcm_init)
1268 module_exit(alsa_pcm_exit)