2 * Digital Audio (PCM) abstract layer
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>
35 MODULE_DESCRIPTION("Midlevel PCM code for ALSA.");
36 MODULE_LICENSE("GPL");
38 static LIST_HEAD(snd_pcm_devices);
39 static LIST_HEAD(snd_pcm_notify_list);
40 static DEFINE_MUTEX(register_mutex);
42 static int snd_pcm_free(struct snd_pcm *pcm);
43 static int snd_pcm_dev_free(struct snd_device *device);
44 static int snd_pcm_dev_register(struct snd_device *device);
45 static int snd_pcm_dev_disconnect(struct snd_device *device);
47 static struct snd_pcm *snd_pcm_get(struct snd_card *card, int device)
51 list_for_each_entry(pcm, &snd_pcm_devices, list) {
52 if (pcm->card == card && pcm->device == device)
58 static int snd_pcm_next(struct snd_card *card, int device)
62 list_for_each_entry(pcm, &snd_pcm_devices, list) {
63 if (pcm->card == card && pcm->device > device)
65 else if (pcm->card->number > card->number)
71 static int snd_pcm_add(struct snd_pcm *newpcm)
78 list_for_each_entry(pcm, &snd_pcm_devices, list) {
79 if (pcm->card == newpcm->card && pcm->device == newpcm->device)
81 if (pcm->card->number > newpcm->card->number ||
82 (pcm->card == newpcm->card &&
83 pcm->device > newpcm->device)) {
84 list_add(&newpcm->list, pcm->list.prev);
88 list_add_tail(&newpcm->list, &snd_pcm_devices);
92 static int snd_pcm_control_ioctl(struct snd_card *card,
93 struct snd_ctl_file *control,
94 unsigned int cmd, unsigned long arg)
97 case SNDRV_CTL_IOCTL_PCM_NEXT_DEVICE:
101 if (get_user(device, (int __user *)arg))
103 mutex_lock(®ister_mutex);
104 device = snd_pcm_next(card, device);
105 mutex_unlock(®ister_mutex);
106 if (put_user(device, (int __user *)arg))
110 case SNDRV_CTL_IOCTL_PCM_INFO:
112 struct snd_pcm_info __user *info;
113 unsigned int device, subdevice;
116 struct snd_pcm_str *pstr;
117 struct snd_pcm_substream *substream;
120 info = (struct snd_pcm_info __user *)arg;
121 if (get_user(device, &info->device))
123 if (get_user(stream, &info->stream))
125 if (stream < 0 || stream > 1)
127 if (get_user(subdevice, &info->subdevice))
129 mutex_lock(®ister_mutex);
130 pcm = snd_pcm_get(card, device);
135 pstr = &pcm->streams[stream];
136 if (pstr->substream_count == 0) {
140 if (subdevice >= pstr->substream_count) {
144 for (substream = pstr->substream; substream;
145 substream = substream->next)
146 if (substream->number == (int)subdevice)
148 if (substream == NULL) {
152 err = snd_pcm_info_user(substream, info);
154 mutex_unlock(®ister_mutex);
157 case SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE:
161 if (get_user(val, (int __user *)arg))
163 control->preferred_subdevice[SND_CTL_SUBDEV_PCM] = val;
170 #define FORMAT(v) [SNDRV_PCM_FORMAT_##v] = #v
172 static char *snd_pcm_format_names[] = {
191 FORMAT(IEC958_SUBFRAME_LE),
192 FORMAT(IEC958_SUBFRAME_BE),
223 * snd_pcm_format_name - Return a name string for the given PCM format
224 * @format: PCM format
226 const char *snd_pcm_format_name(snd_pcm_format_t format)
228 if ((__force unsigned int)format >= ARRAY_SIZE(snd_pcm_format_names))
230 return snd_pcm_format_names[(__force unsigned int)format];
232 EXPORT_SYMBOL_GPL(snd_pcm_format_name);
234 #ifdef CONFIG_SND_VERBOSE_PROCFS
236 #define STATE(v) [SNDRV_PCM_STATE_##v] = #v
237 #define STREAM(v) [SNDRV_PCM_STREAM_##v] = #v
238 #define READY(v) [SNDRV_PCM_READY_##v] = #v
239 #define XRUN(v) [SNDRV_PCM_XRUN_##v] = #v
240 #define SILENCE(v) [SNDRV_PCM_SILENCE_##v] = #v
241 #define TSTAMP(v) [SNDRV_PCM_TSTAMP_##v] = #v
242 #define ACCESS(v) [SNDRV_PCM_ACCESS_##v] = #v
243 #define START(v) [SNDRV_PCM_START_##v] = #v
244 #define SUBFORMAT(v) [SNDRV_PCM_SUBFORMAT_##v] = #v
246 static char *snd_pcm_stream_names[] = {
251 static char *snd_pcm_state_names[] = {
262 static char *snd_pcm_access_names[] = {
263 ACCESS(MMAP_INTERLEAVED),
264 ACCESS(MMAP_NONINTERLEAVED),
265 ACCESS(MMAP_COMPLEX),
266 ACCESS(RW_INTERLEAVED),
267 ACCESS(RW_NONINTERLEAVED),
270 static char *snd_pcm_subformat_names[] = {
274 static char *snd_pcm_tstamp_mode_names[] = {
279 static const char *snd_pcm_stream_name(int stream)
281 return snd_pcm_stream_names[stream];
284 static const char *snd_pcm_access_name(snd_pcm_access_t access)
286 return snd_pcm_access_names[(__force int)access];
289 static const char *snd_pcm_subformat_name(snd_pcm_subformat_t subformat)
291 return snd_pcm_subformat_names[(__force int)subformat];
294 static const char *snd_pcm_tstamp_mode_name(int mode)
296 return snd_pcm_tstamp_mode_names[mode];
299 static const char *snd_pcm_state_name(snd_pcm_state_t state)
301 return snd_pcm_state_names[(__force int)state];
304 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
305 #include <linux/soundcard.h>
307 static const char *snd_pcm_oss_format_name(int format)
336 static void snd_pcm_proc_info_read(struct snd_pcm_substream *substream,
337 struct snd_info_buffer *buffer)
339 struct snd_pcm_info *info;
345 info = kmalloc(sizeof(*info), GFP_KERNEL);
349 err = snd_pcm_info(substream, info);
351 snd_iprintf(buffer, "error %d\n", err);
355 snd_iprintf(buffer, "card: %d\n", info->card);
356 snd_iprintf(buffer, "device: %d\n", info->device);
357 snd_iprintf(buffer, "subdevice: %d\n", info->subdevice);
358 snd_iprintf(buffer, "stream: %s\n", snd_pcm_stream_name(info->stream));
359 snd_iprintf(buffer, "id: %s\n", info->id);
360 snd_iprintf(buffer, "name: %s\n", info->name);
361 snd_iprintf(buffer, "subname: %s\n", info->subname);
362 snd_iprintf(buffer, "class: %d\n", info->dev_class);
363 snd_iprintf(buffer, "subclass: %d\n", info->dev_subclass);
364 snd_iprintf(buffer, "subdevices_count: %d\n", info->subdevices_count);
365 snd_iprintf(buffer, "subdevices_avail: %d\n", info->subdevices_avail);
369 static void snd_pcm_stream_proc_info_read(struct snd_info_entry *entry,
370 struct snd_info_buffer *buffer)
372 snd_pcm_proc_info_read(((struct snd_pcm_str *)entry->private_data)->substream,
376 static void snd_pcm_substream_proc_info_read(struct snd_info_entry *entry,
377 struct snd_info_buffer *buffer)
379 snd_pcm_proc_info_read(entry->private_data, buffer);
382 static void snd_pcm_substream_proc_hw_params_read(struct snd_info_entry *entry,
383 struct snd_info_buffer *buffer)
385 struct snd_pcm_substream *substream = entry->private_data;
386 struct snd_pcm_runtime *runtime;
388 mutex_lock(&substream->pcm->open_mutex);
389 runtime = substream->runtime;
391 snd_iprintf(buffer, "closed\n");
394 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
395 snd_iprintf(buffer, "no setup\n");
398 snd_iprintf(buffer, "access: %s\n", snd_pcm_access_name(runtime->access));
399 snd_iprintf(buffer, "format: %s\n", snd_pcm_format_name(runtime->format));
400 snd_iprintf(buffer, "subformat: %s\n", snd_pcm_subformat_name(runtime->subformat));
401 snd_iprintf(buffer, "channels: %u\n", runtime->channels);
402 snd_iprintf(buffer, "rate: %u (%u/%u)\n", runtime->rate, runtime->rate_num, runtime->rate_den);
403 snd_iprintf(buffer, "period_size: %lu\n", runtime->period_size);
404 snd_iprintf(buffer, "buffer_size: %lu\n", runtime->buffer_size);
405 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
406 if (substream->oss.oss) {
407 snd_iprintf(buffer, "OSS format: %s\n", snd_pcm_oss_format_name(runtime->oss.format));
408 snd_iprintf(buffer, "OSS channels: %u\n", runtime->oss.channels);
409 snd_iprintf(buffer, "OSS rate: %u\n", runtime->oss.rate);
410 snd_iprintf(buffer, "OSS period bytes: %lu\n", (unsigned long)runtime->oss.period_bytes);
411 snd_iprintf(buffer, "OSS periods: %u\n", runtime->oss.periods);
412 snd_iprintf(buffer, "OSS period frames: %lu\n", (unsigned long)runtime->oss.period_frames);
416 mutex_unlock(&substream->pcm->open_mutex);
419 static void snd_pcm_substream_proc_sw_params_read(struct snd_info_entry *entry,
420 struct snd_info_buffer *buffer)
422 struct snd_pcm_substream *substream = entry->private_data;
423 struct snd_pcm_runtime *runtime;
425 mutex_lock(&substream->pcm->open_mutex);
426 runtime = substream->runtime;
428 snd_iprintf(buffer, "closed\n");
431 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
432 snd_iprintf(buffer, "no setup\n");
435 snd_iprintf(buffer, "tstamp_mode: %s\n", snd_pcm_tstamp_mode_name(runtime->tstamp_mode));
436 snd_iprintf(buffer, "period_step: %u\n", runtime->period_step);
437 snd_iprintf(buffer, "avail_min: %lu\n", runtime->control->avail_min);
438 snd_iprintf(buffer, "start_threshold: %lu\n", runtime->start_threshold);
439 snd_iprintf(buffer, "stop_threshold: %lu\n", runtime->stop_threshold);
440 snd_iprintf(buffer, "silence_threshold: %lu\n", runtime->silence_threshold);
441 snd_iprintf(buffer, "silence_size: %lu\n", runtime->silence_size);
442 snd_iprintf(buffer, "boundary: %lu\n", runtime->boundary);
444 mutex_unlock(&substream->pcm->open_mutex);
447 static void snd_pcm_substream_proc_status_read(struct snd_info_entry *entry,
448 struct snd_info_buffer *buffer)
450 struct snd_pcm_substream *substream = entry->private_data;
451 struct snd_pcm_runtime *runtime;
452 struct snd_pcm_status status;
455 mutex_lock(&substream->pcm->open_mutex);
456 runtime = substream->runtime;
458 snd_iprintf(buffer, "closed\n");
461 memset(&status, 0, sizeof(status));
462 err = snd_pcm_status(substream, &status);
464 snd_iprintf(buffer, "error %d\n", err);
467 snd_iprintf(buffer, "state: %s\n", snd_pcm_state_name(status.state));
468 snd_iprintf(buffer, "owner_pid : %d\n", pid_vnr(substream->pid));
469 snd_iprintf(buffer, "trigger_time: %ld.%09ld\n",
470 status.trigger_tstamp.tv_sec, status.trigger_tstamp.tv_nsec);
471 snd_iprintf(buffer, "tstamp : %ld.%09ld\n",
472 status.tstamp.tv_sec, status.tstamp.tv_nsec);
473 snd_iprintf(buffer, "delay : %ld\n", status.delay);
474 snd_iprintf(buffer, "avail : %ld\n", status.avail);
475 snd_iprintf(buffer, "avail_max : %ld\n", status.avail_max);
476 snd_iprintf(buffer, "-----\n");
477 snd_iprintf(buffer, "hw_ptr : %ld\n", runtime->status->hw_ptr);
478 snd_iprintf(buffer, "appl_ptr : %ld\n", runtime->control->appl_ptr);
480 mutex_unlock(&substream->pcm->open_mutex);
483 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
484 static void snd_pcm_xrun_injection_write(struct snd_info_entry *entry,
485 struct snd_info_buffer *buffer)
487 struct snd_pcm_substream *substream = entry->private_data;
488 struct snd_pcm_runtime *runtime;
490 snd_pcm_stream_lock_irq(substream);
491 runtime = substream->runtime;
492 if (runtime && runtime->status->state == SNDRV_PCM_STATE_RUNNING)
493 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
494 snd_pcm_stream_unlock_irq(substream);
497 static void snd_pcm_xrun_debug_read(struct snd_info_entry *entry,
498 struct snd_info_buffer *buffer)
500 struct snd_pcm_str *pstr = entry->private_data;
501 snd_iprintf(buffer, "%d\n", pstr->xrun_debug);
504 static void snd_pcm_xrun_debug_write(struct snd_info_entry *entry,
505 struct snd_info_buffer *buffer)
507 struct snd_pcm_str *pstr = entry->private_data;
509 if (!snd_info_get_line(buffer, line, sizeof(line)))
510 pstr->xrun_debug = simple_strtoul(line, NULL, 10);
514 static int snd_pcm_stream_proc_init(struct snd_pcm_str *pstr)
516 struct snd_pcm *pcm = pstr->pcm;
517 struct snd_info_entry *entry;
520 sprintf(name, "pcm%i%c", pcm->device,
521 pstr->stream == SNDRV_PCM_STREAM_PLAYBACK ? 'p' : 'c');
522 if ((entry = snd_info_create_card_entry(pcm->card, name, pcm->card->proc_root)) == NULL)
524 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
525 if (snd_info_register(entry) < 0) {
526 snd_info_free_entry(entry);
529 pstr->proc_root = entry;
531 if ((entry = snd_info_create_card_entry(pcm->card, "info", pstr->proc_root)) != NULL) {
532 snd_info_set_text_ops(entry, pstr, snd_pcm_stream_proc_info_read);
533 if (snd_info_register(entry) < 0) {
534 snd_info_free_entry(entry);
538 pstr->proc_info_entry = entry;
540 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
541 if ((entry = snd_info_create_card_entry(pcm->card, "xrun_debug",
542 pstr->proc_root)) != NULL) {
543 entry->c.text.read = snd_pcm_xrun_debug_read;
544 entry->c.text.write = snd_pcm_xrun_debug_write;
545 entry->mode |= S_IWUSR;
546 entry->private_data = pstr;
547 if (snd_info_register(entry) < 0) {
548 snd_info_free_entry(entry);
552 pstr->proc_xrun_debug_entry = entry;
557 static int snd_pcm_stream_proc_done(struct snd_pcm_str *pstr)
559 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
560 snd_info_free_entry(pstr->proc_xrun_debug_entry);
561 pstr->proc_xrun_debug_entry = NULL;
563 snd_info_free_entry(pstr->proc_info_entry);
564 pstr->proc_info_entry = NULL;
565 snd_info_free_entry(pstr->proc_root);
566 pstr->proc_root = NULL;
570 static int snd_pcm_substream_proc_init(struct snd_pcm_substream *substream)
572 struct snd_info_entry *entry;
573 struct snd_card *card;
576 card = substream->pcm->card;
578 sprintf(name, "sub%i", substream->number);
579 if ((entry = snd_info_create_card_entry(card, name, substream->pstr->proc_root)) == NULL)
581 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
582 if (snd_info_register(entry) < 0) {
583 snd_info_free_entry(entry);
586 substream->proc_root = entry;
588 if ((entry = snd_info_create_card_entry(card, "info", substream->proc_root)) != NULL) {
589 snd_info_set_text_ops(entry, substream,
590 snd_pcm_substream_proc_info_read);
591 if (snd_info_register(entry) < 0) {
592 snd_info_free_entry(entry);
596 substream->proc_info_entry = entry;
598 if ((entry = snd_info_create_card_entry(card, "hw_params", substream->proc_root)) != NULL) {
599 snd_info_set_text_ops(entry, substream,
600 snd_pcm_substream_proc_hw_params_read);
601 if (snd_info_register(entry) < 0) {
602 snd_info_free_entry(entry);
606 substream->proc_hw_params_entry = entry;
608 if ((entry = snd_info_create_card_entry(card, "sw_params", substream->proc_root)) != NULL) {
609 snd_info_set_text_ops(entry, substream,
610 snd_pcm_substream_proc_sw_params_read);
611 if (snd_info_register(entry) < 0) {
612 snd_info_free_entry(entry);
616 substream->proc_sw_params_entry = entry;
618 if ((entry = snd_info_create_card_entry(card, "status", substream->proc_root)) != NULL) {
619 snd_info_set_text_ops(entry, substream,
620 snd_pcm_substream_proc_status_read);
621 if (snd_info_register(entry) < 0) {
622 snd_info_free_entry(entry);
626 substream->proc_status_entry = entry;
628 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
629 entry = snd_info_create_card_entry(card, "xrun_injection",
630 substream->proc_root);
632 entry->private_data = substream;
633 entry->c.text.read = NULL;
634 entry->c.text.write = snd_pcm_xrun_injection_write;
635 entry->mode = S_IFREG | S_IWUSR;
636 if (snd_info_register(entry) < 0) {
637 snd_info_free_entry(entry);
641 substream->proc_xrun_injection_entry = entry;
642 #endif /* CONFIG_SND_PCM_XRUN_DEBUG */
647 static int snd_pcm_substream_proc_done(struct snd_pcm_substream *substream)
649 snd_info_free_entry(substream->proc_info_entry);
650 substream->proc_info_entry = NULL;
651 snd_info_free_entry(substream->proc_hw_params_entry);
652 substream->proc_hw_params_entry = NULL;
653 snd_info_free_entry(substream->proc_sw_params_entry);
654 substream->proc_sw_params_entry = NULL;
655 snd_info_free_entry(substream->proc_status_entry);
656 substream->proc_status_entry = NULL;
657 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
658 snd_info_free_entry(substream->proc_xrun_injection_entry);
659 substream->proc_xrun_injection_entry = NULL;
661 snd_info_free_entry(substream->proc_root);
662 substream->proc_root = NULL;
665 #else /* !CONFIG_SND_VERBOSE_PROCFS */
666 static inline int snd_pcm_stream_proc_init(struct snd_pcm_str *pstr) { return 0; }
667 static inline int snd_pcm_stream_proc_done(struct snd_pcm_str *pstr) { return 0; }
668 static inline int snd_pcm_substream_proc_init(struct snd_pcm_substream *substream) { return 0; }
669 static inline int snd_pcm_substream_proc_done(struct snd_pcm_substream *substream) { return 0; }
670 #endif /* CONFIG_SND_VERBOSE_PROCFS */
672 static const struct attribute_group *pcm_dev_attr_groups[];
675 * snd_pcm_new_stream - create a new PCM stream
676 * @pcm: the pcm instance
677 * @stream: the stream direction, SNDRV_PCM_STREAM_XXX
678 * @substream_count: the number of substreams
680 * Creates a new stream for the pcm.
681 * The corresponding stream on the pcm must have been empty before
682 * calling this, i.e. zero must be given to the argument of
685 * Return: Zero if successful, or a negative error code on failure.
687 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count)
690 struct snd_pcm_str *pstr = &pcm->streams[stream];
691 struct snd_pcm_substream *substream, *prev;
693 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
694 mutex_init(&pstr->oss.setup_mutex);
696 pstr->stream = stream;
698 pstr->substream_count = substream_count;
699 if (!substream_count)
702 snd_device_initialize(&pstr->dev, pcm->card);
703 pstr->dev.groups = pcm_dev_attr_groups;
704 dev_set_name(&pstr->dev, "pcmC%iD%i%c", pcm->card->number, pcm->device,
705 stream == SNDRV_PCM_STREAM_PLAYBACK ? 'p' : 'c');
707 if (!pcm->internal) {
708 err = snd_pcm_stream_proc_init(pstr);
710 pcm_err(pcm, "Error in snd_pcm_stream_proc_init\n");
715 for (idx = 0, prev = NULL; idx < substream_count; idx++) {
716 substream = kzalloc(sizeof(*substream), GFP_KERNEL);
719 substream->pcm = pcm;
720 substream->pstr = pstr;
721 substream->number = idx;
722 substream->stream = stream;
723 sprintf(substream->name, "subdevice #%i", idx);
724 substream->buffer_bytes_max = UINT_MAX;
726 pstr->substream = substream;
728 prev->next = substream;
730 if (!pcm->internal) {
731 err = snd_pcm_substream_proc_init(substream);
734 "Error in snd_pcm_stream_proc_init\n");
736 pstr->substream = NULL;
743 substream->group = &substream->self_group;
744 spin_lock_init(&substream->self_group.lock);
745 mutex_init(&substream->self_group.mutex);
746 INIT_LIST_HEAD(&substream->self_group.substreams);
747 list_add_tail(&substream->link_list, &substream->self_group.substreams);
748 atomic_set(&substream->mmap_count, 0);
753 EXPORT_SYMBOL(snd_pcm_new_stream);
755 static int _snd_pcm_new(struct snd_card *card, const char *id, int device,
756 int playback_count, int capture_count, bool internal,
757 struct snd_pcm **rpcm)
761 static struct snd_device_ops ops = {
762 .dev_free = snd_pcm_dev_free,
763 .dev_register = snd_pcm_dev_register,
764 .dev_disconnect = snd_pcm_dev_disconnect,
767 if (snd_BUG_ON(!card))
771 pcm = kzalloc(sizeof(*pcm), GFP_KERNEL);
775 pcm->device = device;
776 pcm->internal = internal;
777 mutex_init(&pcm->open_mutex);
778 init_waitqueue_head(&pcm->open_wait);
779 INIT_LIST_HEAD(&pcm->list);
781 strlcpy(pcm->id, id, sizeof(pcm->id));
782 if ((err = snd_pcm_new_stream(pcm, SNDRV_PCM_STREAM_PLAYBACK, playback_count)) < 0) {
786 if ((err = snd_pcm_new_stream(pcm, SNDRV_PCM_STREAM_CAPTURE, capture_count)) < 0) {
790 if ((err = snd_device_new(card, SNDRV_DEV_PCM, pcm, &ops)) < 0) {
800 * snd_pcm_new - create a new PCM instance
801 * @card: the card instance
803 * @device: the device index (zero based)
804 * @playback_count: the number of substreams for playback
805 * @capture_count: the number of substreams for capture
806 * @rpcm: the pointer to store the new pcm instance
808 * Creates a new PCM instance.
810 * The pcm operators have to be set afterwards to the new instance
811 * via snd_pcm_set_ops().
813 * Return: Zero if successful, or a negative error code on failure.
815 int snd_pcm_new(struct snd_card *card, const char *id, int device,
816 int playback_count, int capture_count, struct snd_pcm **rpcm)
818 return _snd_pcm_new(card, id, device, playback_count, capture_count,
821 EXPORT_SYMBOL(snd_pcm_new);
824 * snd_pcm_new_internal - create a new internal PCM instance
825 * @card: the card instance
827 * @device: the device index (zero based - shared with normal PCMs)
828 * @playback_count: the number of substreams for playback
829 * @capture_count: the number of substreams for capture
830 * @rpcm: the pointer to store the new pcm instance
832 * Creates a new internal PCM instance with no userspace device or procfs
833 * entries. This is used by ASoC Back End PCMs in order to create a PCM that
834 * will only be used internally by kernel drivers. i.e. it cannot be opened
835 * by userspace. It provides existing ASoC components drivers with a substream
836 * and access to any private data.
838 * The pcm operators have to be set afterwards to the new instance
839 * via snd_pcm_set_ops().
841 * Return: Zero if successful, or a negative error code on failure.
843 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
844 int playback_count, int capture_count,
845 struct snd_pcm **rpcm)
847 return _snd_pcm_new(card, id, device, playback_count, capture_count,
850 EXPORT_SYMBOL(snd_pcm_new_internal);
852 static void snd_pcm_free_stream(struct snd_pcm_str * pstr)
854 struct snd_pcm_substream *substream, *substream_next;
855 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
856 struct snd_pcm_oss_setup *setup, *setupn;
858 substream = pstr->substream;
860 substream_next = substream->next;
861 snd_pcm_timer_done(substream);
862 snd_pcm_substream_proc_done(substream);
864 substream = substream_next;
866 snd_pcm_stream_proc_done(pstr);
867 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
868 for (setup = pstr->oss.setup_list; setup; setup = setupn) {
869 setupn = setup->next;
870 kfree(setup->task_name);
874 if (pstr->substream_count)
875 put_device(&pstr->dev);
878 static int snd_pcm_free(struct snd_pcm *pcm)
880 struct snd_pcm_notify *notify;
884 if (!pcm->internal) {
885 list_for_each_entry(notify, &snd_pcm_notify_list, list)
886 notify->n_unregister(pcm);
888 if (pcm->private_free)
889 pcm->private_free(pcm);
890 snd_pcm_lib_preallocate_free_for_all(pcm);
891 snd_pcm_free_stream(&pcm->streams[SNDRV_PCM_STREAM_PLAYBACK]);
892 snd_pcm_free_stream(&pcm->streams[SNDRV_PCM_STREAM_CAPTURE]);
897 static int snd_pcm_dev_free(struct snd_device *device)
899 struct snd_pcm *pcm = device->device_data;
900 return snd_pcm_free(pcm);
903 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream,
905 struct snd_pcm_substream **rsubstream)
907 struct snd_pcm_str * pstr;
908 struct snd_pcm_substream *substream;
909 struct snd_pcm_runtime *runtime;
910 struct snd_card *card;
911 int prefer_subdevice;
914 if (snd_BUG_ON(!pcm || !rsubstream))
916 if (snd_BUG_ON(stream != SNDRV_PCM_STREAM_PLAYBACK &&
917 stream != SNDRV_PCM_STREAM_CAPTURE))
920 pstr = &pcm->streams[stream];
921 if (pstr->substream == NULL || pstr->substream_count == 0)
925 prefer_subdevice = snd_ctl_get_preferred_subdevice(card, SND_CTL_SUBDEV_PCM);
927 if (pcm->info_flags & SNDRV_PCM_INFO_HALF_DUPLEX) {
928 int opposite = !stream;
930 for (substream = pcm->streams[opposite].substream; substream;
931 substream = substream->next) {
932 if (SUBSTREAM_BUSY(substream))
937 if (file->f_flags & O_APPEND) {
938 if (prefer_subdevice < 0) {
939 if (pstr->substream_count > 1)
940 return -EINVAL; /* must be unique */
941 substream = pstr->substream;
943 for (substream = pstr->substream; substream;
944 substream = substream->next)
945 if (substream->number == prefer_subdevice)
950 if (! SUBSTREAM_BUSY(substream))
952 substream->ref_count++;
953 *rsubstream = substream;
957 for (substream = pstr->substream; substream; substream = substream->next) {
958 if (!SUBSTREAM_BUSY(substream) &&
959 (prefer_subdevice == -1 ||
960 substream->number == prefer_subdevice))
963 if (substream == NULL)
966 runtime = kzalloc(sizeof(*runtime), GFP_KERNEL);
970 size = PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status));
971 runtime->status = snd_malloc_pages(size, GFP_KERNEL);
972 if (runtime->status == NULL) {
976 memset((void*)runtime->status, 0, size);
978 size = PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control));
979 runtime->control = snd_malloc_pages(size, GFP_KERNEL);
980 if (runtime->control == NULL) {
981 snd_free_pages((void*)runtime->status,
982 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)));
986 memset((void*)runtime->control, 0, size);
988 init_waitqueue_head(&runtime->sleep);
989 init_waitqueue_head(&runtime->tsleep);
991 runtime->status->state = SNDRV_PCM_STATE_OPEN;
993 substream->runtime = runtime;
994 substream->private_data = pcm->private_data;
995 substream->ref_count = 1;
996 substream->f_flags = file->f_flags;
997 substream->pid = get_pid(task_pid(current));
998 pstr->substream_opened++;
999 *rsubstream = substream;
1003 void snd_pcm_detach_substream(struct snd_pcm_substream *substream)
1005 struct snd_pcm_runtime *runtime;
1007 if (PCM_RUNTIME_CHECK(substream))
1009 runtime = substream->runtime;
1010 if (runtime->private_free != NULL)
1011 runtime->private_free(runtime);
1012 snd_free_pages((void*)runtime->status,
1013 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)));
1014 snd_free_pages((void*)runtime->control,
1015 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)));
1016 kfree(runtime->hw_constraints.rules);
1018 substream->runtime = NULL;
1019 put_pid(substream->pid);
1020 substream->pid = NULL;
1021 substream->pstr->substream_opened--;
1024 static ssize_t show_pcm_class(struct device *dev,
1025 struct device_attribute *attr, char *buf)
1027 struct snd_pcm_str *pstr = container_of(dev, struct snd_pcm_str, dev);
1028 struct snd_pcm *pcm = pstr->pcm;
1030 static const char *strs[SNDRV_PCM_CLASS_LAST + 1] = {
1031 [SNDRV_PCM_CLASS_GENERIC] = "generic",
1032 [SNDRV_PCM_CLASS_MULTI] = "multi",
1033 [SNDRV_PCM_CLASS_MODEM] = "modem",
1034 [SNDRV_PCM_CLASS_DIGITIZER] = "digitizer",
1037 if (pcm->dev_class > SNDRV_PCM_CLASS_LAST)
1040 str = strs[pcm->dev_class];
1041 return snprintf(buf, PAGE_SIZE, "%s\n", str);
1044 static DEVICE_ATTR(pcm_class, S_IRUGO, show_pcm_class, NULL);
1045 static struct attribute *pcm_dev_attrs[] = {
1046 &dev_attr_pcm_class.attr,
1050 static struct attribute_group pcm_dev_attr_group = {
1051 .attrs = pcm_dev_attrs,
1054 static const struct attribute_group *pcm_dev_attr_groups[] = {
1055 &pcm_dev_attr_group,
1059 static int snd_pcm_dev_register(struct snd_device *device)
1062 struct snd_pcm_substream *substream;
1063 struct snd_pcm_notify *notify;
1064 struct snd_pcm *pcm;
1066 if (snd_BUG_ON(!device || !device->device_data))
1068 pcm = device->device_data;
1072 mutex_lock(®ister_mutex);
1073 err = snd_pcm_add(pcm);
1076 for (cidx = 0; cidx < 2; cidx++) {
1078 if (pcm->streams[cidx].substream == NULL)
1081 case SNDRV_PCM_STREAM_PLAYBACK:
1082 devtype = SNDRV_DEVICE_TYPE_PCM_PLAYBACK;
1084 case SNDRV_PCM_STREAM_CAPTURE:
1085 devtype = SNDRV_DEVICE_TYPE_PCM_CAPTURE;
1089 err = snd_register_device(devtype, pcm->card, pcm->device,
1090 &snd_pcm_f_ops[cidx], pcm,
1091 &pcm->streams[cidx].dev);
1093 list_del_init(&pcm->list);
1097 for (substream = pcm->streams[cidx].substream; substream; substream = substream->next)
1098 snd_pcm_timer_init(substream);
1101 list_for_each_entry(notify, &snd_pcm_notify_list, list)
1102 notify->n_register(pcm);
1105 mutex_unlock(®ister_mutex);
1109 static int snd_pcm_dev_disconnect(struct snd_device *device)
1111 struct snd_pcm *pcm = device->device_data;
1112 struct snd_pcm_notify *notify;
1113 struct snd_pcm_substream *substream;
1116 mutex_lock(®ister_mutex);
1117 mutex_lock(&pcm->open_mutex);
1118 wake_up(&pcm->open_wait);
1119 list_del_init(&pcm->list);
1120 for (cidx = 0; cidx < 2; cidx++) {
1121 for (substream = pcm->streams[cidx].substream; substream; substream = substream->next) {
1122 snd_pcm_stream_lock_irq(substream);
1123 if (substream->runtime) {
1124 substream->runtime->status->state = SNDRV_PCM_STATE_DISCONNECTED;
1125 wake_up(&substream->runtime->sleep);
1126 wake_up(&substream->runtime->tsleep);
1128 snd_pcm_stream_unlock_irq(substream);
1131 if (!pcm->internal) {
1132 list_for_each_entry(notify, &snd_pcm_notify_list, list)
1133 notify->n_disconnect(pcm);
1135 for (cidx = 0; cidx < 2; cidx++) {
1137 snd_unregister_device(&pcm->streams[cidx].dev);
1138 if (pcm->streams[cidx].chmap_kctl) {
1139 snd_ctl_remove(pcm->card, pcm->streams[cidx].chmap_kctl);
1140 pcm->streams[cidx].chmap_kctl = NULL;
1143 mutex_unlock(&pcm->open_mutex);
1144 mutex_unlock(®ister_mutex);
1149 * snd_pcm_notify - Add/remove the notify list
1150 * @notify: PCM notify list
1151 * @nfree: 0 = register, 1 = unregister
1153 * This adds the given notifier to the global list so that the callback is
1154 * called for each registered PCM devices. This exists only for PCM OSS
1155 * emulation, so far.
1157 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree)
1159 struct snd_pcm *pcm;
1161 if (snd_BUG_ON(!notify ||
1162 !notify->n_register ||
1163 !notify->n_unregister ||
1164 !notify->n_disconnect))
1166 mutex_lock(®ister_mutex);
1168 list_del(¬ify->list);
1169 list_for_each_entry(pcm, &snd_pcm_devices, list)
1170 notify->n_unregister(pcm);
1172 list_add_tail(¬ify->list, &snd_pcm_notify_list);
1173 list_for_each_entry(pcm, &snd_pcm_devices, list)
1174 notify->n_register(pcm);
1176 mutex_unlock(®ister_mutex);
1179 EXPORT_SYMBOL(snd_pcm_notify);
1181 #ifdef CONFIG_SND_PROC_FS
1186 static void snd_pcm_proc_read(struct snd_info_entry *entry,
1187 struct snd_info_buffer *buffer)
1189 struct snd_pcm *pcm;
1191 mutex_lock(®ister_mutex);
1192 list_for_each_entry(pcm, &snd_pcm_devices, list) {
1193 snd_iprintf(buffer, "%02i-%02i: %s : %s",
1194 pcm->card->number, pcm->device, pcm->id, pcm->name);
1195 if (pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream)
1196 snd_iprintf(buffer, " : playback %i",
1197 pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream_count);
1198 if (pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream)
1199 snd_iprintf(buffer, " : capture %i",
1200 pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream_count);
1201 snd_iprintf(buffer, "\n");
1203 mutex_unlock(®ister_mutex);
1206 static struct snd_info_entry *snd_pcm_proc_entry;
1208 static void snd_pcm_proc_init(void)
1210 struct snd_info_entry *entry;
1212 if ((entry = snd_info_create_module_entry(THIS_MODULE, "pcm", NULL)) != NULL) {
1213 snd_info_set_text_ops(entry, NULL, snd_pcm_proc_read);
1214 if (snd_info_register(entry) < 0) {
1215 snd_info_free_entry(entry);
1219 snd_pcm_proc_entry = entry;
1222 static void snd_pcm_proc_done(void)
1224 snd_info_free_entry(snd_pcm_proc_entry);
1227 #else /* !CONFIG_SND_PROC_FS */
1228 #define snd_pcm_proc_init()
1229 #define snd_pcm_proc_done()
1230 #endif /* CONFIG_SND_PROC_FS */
1237 static int __init alsa_pcm_init(void)
1239 snd_ctl_register_ioctl(snd_pcm_control_ioctl);
1240 snd_ctl_register_ioctl_compat(snd_pcm_control_ioctl);
1241 snd_pcm_proc_init();
1245 static void __exit alsa_pcm_exit(void)
1247 snd_ctl_unregister_ioctl(snd_pcm_control_ioctl);
1248 snd_ctl_unregister_ioctl_compat(snd_pcm_control_ioctl);
1249 snd_pcm_proc_done();
1252 module_init(alsa_pcm_init)
1253 module_exit(alsa_pcm_exit)