1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Digital Audio (PCM) abstract layer
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
7 #include <linux/init.h>
8 #include <linux/slab.h>
9 #include <linux/module.h>
10 #include <linux/time.h>
11 #include <linux/mutex.h>
12 #include <linux/device.h>
13 #include <linux/nospec.h>
14 #include <sound/core.h>
15 #include <sound/minors.h>
16 #include <sound/pcm.h>
17 #include <sound/timer.h>
18 #include <sound/control.h>
19 #include <sound/info.h>
21 #include "pcm_local.h"
23 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>, Abramo Bagnara <abramo@alsa-project.org>");
24 MODULE_DESCRIPTION("Midlevel PCM code for ALSA.");
25 MODULE_LICENSE("GPL");
27 static LIST_HEAD(snd_pcm_devices
);
28 static DEFINE_MUTEX(register_mutex
);
29 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
30 static LIST_HEAD(snd_pcm_notify_list
);
33 static int snd_pcm_free(struct snd_pcm
*pcm
);
34 static int snd_pcm_dev_free(struct snd_device
*device
);
35 static int snd_pcm_dev_register(struct snd_device
*device
);
36 static int snd_pcm_dev_disconnect(struct snd_device
*device
);
38 static struct snd_pcm
*snd_pcm_get(struct snd_card
*card
, int device
)
42 list_for_each_entry(pcm
, &snd_pcm_devices
, list
) {
43 if (pcm
->card
== card
&& pcm
->device
== device
)
49 static int snd_pcm_next(struct snd_card
*card
, int device
)
53 list_for_each_entry(pcm
, &snd_pcm_devices
, list
) {
54 if (pcm
->card
== card
&& pcm
->device
> device
)
56 else if (pcm
->card
->number
> card
->number
)
62 static int snd_pcm_add(struct snd_pcm
*newpcm
)
69 list_for_each_entry(pcm
, &snd_pcm_devices
, list
) {
70 if (pcm
->card
== newpcm
->card
&& pcm
->device
== newpcm
->device
)
72 if (pcm
->card
->number
> newpcm
->card
->number
||
73 (pcm
->card
== newpcm
->card
&&
74 pcm
->device
> newpcm
->device
)) {
75 list_add(&newpcm
->list
, pcm
->list
.prev
);
79 list_add_tail(&newpcm
->list
, &snd_pcm_devices
);
83 static int snd_pcm_control_ioctl(struct snd_card
*card
,
84 struct snd_ctl_file
*control
,
85 unsigned int cmd
, unsigned long arg
)
88 case SNDRV_CTL_IOCTL_PCM_NEXT_DEVICE
:
92 if (get_user(device
, (int __user
*)arg
))
94 mutex_lock(®ister_mutex
);
95 device
= snd_pcm_next(card
, device
);
96 mutex_unlock(®ister_mutex
);
97 if (put_user(device
, (int __user
*)arg
))
101 case SNDRV_CTL_IOCTL_PCM_INFO
:
103 struct snd_pcm_info __user
*info
;
104 unsigned int device
, subdevice
;
107 struct snd_pcm_str
*pstr
;
108 struct snd_pcm_substream
*substream
;
111 info
= (struct snd_pcm_info __user
*)arg
;
112 if (get_user(device
, &info
->device
))
114 if (get_user(stream
, &info
->stream
))
116 if (stream
< 0 || stream
> 1)
118 stream
= array_index_nospec(stream
, 2);
119 if (get_user(subdevice
, &info
->subdevice
))
121 mutex_lock(®ister_mutex
);
122 pcm
= snd_pcm_get(card
, device
);
127 pstr
= &pcm
->streams
[stream
];
128 if (pstr
->substream_count
== 0) {
132 if (subdevice
>= pstr
->substream_count
) {
136 for (substream
= pstr
->substream
; substream
;
137 substream
= substream
->next
)
138 if (substream
->number
== (int)subdevice
)
140 if (substream
== NULL
) {
144 mutex_lock(&pcm
->open_mutex
);
145 err
= snd_pcm_info_user(substream
, info
);
146 mutex_unlock(&pcm
->open_mutex
);
148 mutex_unlock(®ister_mutex
);
151 case SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE
:
155 if (get_user(val
, (int __user
*)arg
))
157 control
->preferred_subdevice
[SND_CTL_SUBDEV_PCM
] = val
;
164 #define FORMAT(v) [SNDRV_PCM_FORMAT_##v] = #v
166 static const char * const snd_pcm_format_names
[] = {
185 FORMAT(IEC958_SUBFRAME_LE
),
186 FORMAT(IEC958_SUBFRAME_BE
),
217 * snd_pcm_format_name - Return a name string for the given PCM format
218 * @format: PCM format
220 const char *snd_pcm_format_name(snd_pcm_format_t format
)
222 if ((__force
unsigned int)format
>= ARRAY_SIZE(snd_pcm_format_names
))
224 return snd_pcm_format_names
[(__force
unsigned int)format
];
226 EXPORT_SYMBOL_GPL(snd_pcm_format_name
);
228 #ifdef CONFIG_SND_VERBOSE_PROCFS
230 #define STATE(v) [SNDRV_PCM_STATE_##v] = #v
231 #define STREAM(v) [SNDRV_PCM_STREAM_##v] = #v
232 #define READY(v) [SNDRV_PCM_READY_##v] = #v
233 #define XRUN(v) [SNDRV_PCM_XRUN_##v] = #v
234 #define SILENCE(v) [SNDRV_PCM_SILENCE_##v] = #v
235 #define TSTAMP(v) [SNDRV_PCM_TSTAMP_##v] = #v
236 #define ACCESS(v) [SNDRV_PCM_ACCESS_##v] = #v
237 #define START(v) [SNDRV_PCM_START_##v] = #v
238 #define SUBFORMAT(v) [SNDRV_PCM_SUBFORMAT_##v] = #v
240 static const char * const snd_pcm_stream_names
[] = {
245 static const char * const snd_pcm_state_names
[] = {
256 static const char * const snd_pcm_access_names
[] = {
257 ACCESS(MMAP_INTERLEAVED
),
258 ACCESS(MMAP_NONINTERLEAVED
),
259 ACCESS(MMAP_COMPLEX
),
260 ACCESS(RW_INTERLEAVED
),
261 ACCESS(RW_NONINTERLEAVED
),
264 static const char * const snd_pcm_subformat_names
[] = {
268 static const char * const snd_pcm_tstamp_mode_names
[] = {
273 static const char *snd_pcm_stream_name(int stream
)
275 return snd_pcm_stream_names
[stream
];
278 static const char *snd_pcm_access_name(snd_pcm_access_t access
)
280 return snd_pcm_access_names
[(__force
int)access
];
283 static const char *snd_pcm_subformat_name(snd_pcm_subformat_t subformat
)
285 return snd_pcm_subformat_names
[(__force
int)subformat
];
288 static const char *snd_pcm_tstamp_mode_name(int mode
)
290 return snd_pcm_tstamp_mode_names
[mode
];
293 static const char *snd_pcm_state_name(snd_pcm_state_t state
)
295 return snd_pcm_state_names
[(__force
int)state
];
298 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
299 #include <linux/soundcard.h>
301 static const char *snd_pcm_oss_format_name(int format
)
330 static void snd_pcm_proc_info_read(struct snd_pcm_substream
*substream
,
331 struct snd_info_buffer
*buffer
)
333 struct snd_pcm_info
*info
;
339 info
= kmalloc(sizeof(*info
), GFP_KERNEL
);
343 err
= snd_pcm_info(substream
, info
);
345 snd_iprintf(buffer
, "error %d\n", err
);
349 snd_iprintf(buffer
, "card: %d\n", info
->card
);
350 snd_iprintf(buffer
, "device: %d\n", info
->device
);
351 snd_iprintf(buffer
, "subdevice: %d\n", info
->subdevice
);
352 snd_iprintf(buffer
, "stream: %s\n", snd_pcm_stream_name(info
->stream
));
353 snd_iprintf(buffer
, "id: %s\n", info
->id
);
354 snd_iprintf(buffer
, "name: %s\n", info
->name
);
355 snd_iprintf(buffer
, "subname: %s\n", info
->subname
);
356 snd_iprintf(buffer
, "class: %d\n", info
->dev_class
);
357 snd_iprintf(buffer
, "subclass: %d\n", info
->dev_subclass
);
358 snd_iprintf(buffer
, "subdevices_count: %d\n", info
->subdevices_count
);
359 snd_iprintf(buffer
, "subdevices_avail: %d\n", info
->subdevices_avail
);
363 static void snd_pcm_stream_proc_info_read(struct snd_info_entry
*entry
,
364 struct snd_info_buffer
*buffer
)
366 snd_pcm_proc_info_read(((struct snd_pcm_str
*)entry
->private_data
)->substream
,
370 static void snd_pcm_substream_proc_info_read(struct snd_info_entry
*entry
,
371 struct snd_info_buffer
*buffer
)
373 snd_pcm_proc_info_read(entry
->private_data
, buffer
);
376 static void snd_pcm_substream_proc_hw_params_read(struct snd_info_entry
*entry
,
377 struct snd_info_buffer
*buffer
)
379 struct snd_pcm_substream
*substream
= entry
->private_data
;
380 struct snd_pcm_runtime
*runtime
;
382 mutex_lock(&substream
->pcm
->open_mutex
);
383 runtime
= substream
->runtime
;
385 snd_iprintf(buffer
, "closed\n");
388 if (runtime
->status
->state
== SNDRV_PCM_STATE_OPEN
) {
389 snd_iprintf(buffer
, "no setup\n");
392 snd_iprintf(buffer
, "access: %s\n", snd_pcm_access_name(runtime
->access
));
393 snd_iprintf(buffer
, "format: %s\n", snd_pcm_format_name(runtime
->format
));
394 snd_iprintf(buffer
, "subformat: %s\n", snd_pcm_subformat_name(runtime
->subformat
));
395 snd_iprintf(buffer
, "channels: %u\n", runtime
->channels
);
396 snd_iprintf(buffer
, "rate: %u (%u/%u)\n", runtime
->rate
, runtime
->rate_num
, runtime
->rate_den
);
397 snd_iprintf(buffer
, "period_size: %lu\n", runtime
->period_size
);
398 snd_iprintf(buffer
, "buffer_size: %lu\n", runtime
->buffer_size
);
399 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
400 if (substream
->oss
.oss
) {
401 snd_iprintf(buffer
, "OSS format: %s\n", snd_pcm_oss_format_name(runtime
->oss
.format
));
402 snd_iprintf(buffer
, "OSS channels: %u\n", runtime
->oss
.channels
);
403 snd_iprintf(buffer
, "OSS rate: %u\n", runtime
->oss
.rate
);
404 snd_iprintf(buffer
, "OSS period bytes: %lu\n", (unsigned long)runtime
->oss
.period_bytes
);
405 snd_iprintf(buffer
, "OSS periods: %u\n", runtime
->oss
.periods
);
406 snd_iprintf(buffer
, "OSS period frames: %lu\n", (unsigned long)runtime
->oss
.period_frames
);
410 mutex_unlock(&substream
->pcm
->open_mutex
);
413 static void snd_pcm_substream_proc_sw_params_read(struct snd_info_entry
*entry
,
414 struct snd_info_buffer
*buffer
)
416 struct snd_pcm_substream
*substream
= entry
->private_data
;
417 struct snd_pcm_runtime
*runtime
;
419 mutex_lock(&substream
->pcm
->open_mutex
);
420 runtime
= substream
->runtime
;
422 snd_iprintf(buffer
, "closed\n");
425 if (runtime
->status
->state
== SNDRV_PCM_STATE_OPEN
) {
426 snd_iprintf(buffer
, "no setup\n");
429 snd_iprintf(buffer
, "tstamp_mode: %s\n", snd_pcm_tstamp_mode_name(runtime
->tstamp_mode
));
430 snd_iprintf(buffer
, "period_step: %u\n", runtime
->period_step
);
431 snd_iprintf(buffer
, "avail_min: %lu\n", runtime
->control
->avail_min
);
432 snd_iprintf(buffer
, "start_threshold: %lu\n", runtime
->start_threshold
);
433 snd_iprintf(buffer
, "stop_threshold: %lu\n", runtime
->stop_threshold
);
434 snd_iprintf(buffer
, "silence_threshold: %lu\n", runtime
->silence_threshold
);
435 snd_iprintf(buffer
, "silence_size: %lu\n", runtime
->silence_size
);
436 snd_iprintf(buffer
, "boundary: %lu\n", runtime
->boundary
);
438 mutex_unlock(&substream
->pcm
->open_mutex
);
441 static void snd_pcm_substream_proc_status_read(struct snd_info_entry
*entry
,
442 struct snd_info_buffer
*buffer
)
444 struct snd_pcm_substream
*substream
= entry
->private_data
;
445 struct snd_pcm_runtime
*runtime
;
446 struct snd_pcm_status64 status
;
449 mutex_lock(&substream
->pcm
->open_mutex
);
450 runtime
= substream
->runtime
;
452 snd_iprintf(buffer
, "closed\n");
455 memset(&status
, 0, sizeof(status
));
456 err
= snd_pcm_status64(substream
, &status
);
458 snd_iprintf(buffer
, "error %d\n", err
);
461 snd_iprintf(buffer
, "state: %s\n", snd_pcm_state_name(status
.state
));
462 snd_iprintf(buffer
, "owner_pid : %d\n", pid_vnr(substream
->pid
));
463 snd_iprintf(buffer
, "trigger_time: %lld.%09lld\n",
464 status
.trigger_tstamp_sec
, status
.trigger_tstamp_nsec
);
465 snd_iprintf(buffer
, "tstamp : %lld.%09lld\n",
466 status
.tstamp_sec
, status
.tstamp_nsec
);
467 snd_iprintf(buffer
, "delay : %ld\n", status
.delay
);
468 snd_iprintf(buffer
, "avail : %ld\n", status
.avail
);
469 snd_iprintf(buffer
, "avail_max : %ld\n", status
.avail_max
);
470 snd_iprintf(buffer
, "-----\n");
471 snd_iprintf(buffer
, "hw_ptr : %ld\n", runtime
->status
->hw_ptr
);
472 snd_iprintf(buffer
, "appl_ptr : %ld\n", runtime
->control
->appl_ptr
);
474 mutex_unlock(&substream
->pcm
->open_mutex
);
477 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
478 static void snd_pcm_xrun_injection_write(struct snd_info_entry
*entry
,
479 struct snd_info_buffer
*buffer
)
481 struct snd_pcm_substream
*substream
= entry
->private_data
;
483 snd_pcm_stop_xrun(substream
);
486 static void snd_pcm_xrun_debug_read(struct snd_info_entry
*entry
,
487 struct snd_info_buffer
*buffer
)
489 struct snd_pcm_str
*pstr
= entry
->private_data
;
490 snd_iprintf(buffer
, "%d\n", pstr
->xrun_debug
);
493 static void snd_pcm_xrun_debug_write(struct snd_info_entry
*entry
,
494 struct snd_info_buffer
*buffer
)
496 struct snd_pcm_str
*pstr
= entry
->private_data
;
498 if (!snd_info_get_line(buffer
, line
, sizeof(line
)))
499 pstr
->xrun_debug
= simple_strtoul(line
, NULL
, 10);
503 static int snd_pcm_stream_proc_init(struct snd_pcm_str
*pstr
)
505 struct snd_pcm
*pcm
= pstr
->pcm
;
506 struct snd_info_entry
*entry
;
509 sprintf(name
, "pcm%i%c", pcm
->device
,
510 pstr
->stream
== SNDRV_PCM_STREAM_PLAYBACK
? 'p' : 'c');
511 entry
= snd_info_create_card_entry(pcm
->card
, name
,
512 pcm
->card
->proc_root
);
515 entry
->mode
= S_IFDIR
| 0555;
516 pstr
->proc_root
= entry
;
517 entry
= snd_info_create_card_entry(pcm
->card
, "info", pstr
->proc_root
);
519 snd_info_set_text_ops(entry
, pstr
, snd_pcm_stream_proc_info_read
);
520 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
521 entry
= snd_info_create_card_entry(pcm
->card
, "xrun_debug",
524 snd_info_set_text_ops(entry
, pstr
, snd_pcm_xrun_debug_read
);
525 entry
->c
.text
.write
= snd_pcm_xrun_debug_write
;
532 static int snd_pcm_stream_proc_done(struct snd_pcm_str
*pstr
)
534 snd_info_free_entry(pstr
->proc_root
);
535 pstr
->proc_root
= NULL
;
539 static struct snd_info_entry
*
540 create_substream_info_entry(struct snd_pcm_substream
*substream
,
542 void (*read
)(struct snd_info_entry
*,
543 struct snd_info_buffer
*))
545 struct snd_info_entry
*entry
;
547 entry
= snd_info_create_card_entry(substream
->pcm
->card
, name
,
548 substream
->proc_root
);
550 snd_info_set_text_ops(entry
, substream
, read
);
554 static int snd_pcm_substream_proc_init(struct snd_pcm_substream
*substream
)
556 struct snd_info_entry
*entry
;
557 struct snd_card
*card
;
560 card
= substream
->pcm
->card
;
562 sprintf(name
, "sub%i", substream
->number
);
563 entry
= snd_info_create_card_entry(card
, name
,
564 substream
->pstr
->proc_root
);
567 entry
->mode
= S_IFDIR
| 0555;
568 substream
->proc_root
= entry
;
570 create_substream_info_entry(substream
, "info",
571 snd_pcm_substream_proc_info_read
);
572 create_substream_info_entry(substream
, "hw_params",
573 snd_pcm_substream_proc_hw_params_read
);
574 create_substream_info_entry(substream
, "sw_params",
575 snd_pcm_substream_proc_sw_params_read
);
576 create_substream_info_entry(substream
, "status",
577 snd_pcm_substream_proc_status_read
);
579 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
580 entry
= create_substream_info_entry(substream
, "xrun_injection", NULL
);
582 entry
->c
.text
.write
= snd_pcm_xrun_injection_write
;
583 entry
->mode
= S_IFREG
| 0200;
585 #endif /* CONFIG_SND_PCM_XRUN_DEBUG */
590 #else /* !CONFIG_SND_VERBOSE_PROCFS */
591 static inline int snd_pcm_stream_proc_init(struct snd_pcm_str
*pstr
) { return 0; }
592 static inline int snd_pcm_stream_proc_done(struct snd_pcm_str
*pstr
) { return 0; }
593 static inline int snd_pcm_substream_proc_init(struct snd_pcm_substream
*substream
) { return 0; }
594 #endif /* CONFIG_SND_VERBOSE_PROCFS */
596 static const struct attribute_group
*pcm_dev_attr_groups
[];
599 * PM callbacks: we need to deal only with suspend here, as the resume is
600 * triggered either from user-space or the driver's resume callback
602 #ifdef CONFIG_PM_SLEEP
603 static int do_pcm_suspend(struct device
*dev
)
605 struct snd_pcm_str
*pstr
= container_of(dev
, struct snd_pcm_str
, dev
);
607 if (!pstr
->pcm
->no_device_suspend
)
608 snd_pcm_suspend_all(pstr
->pcm
);
613 static const struct dev_pm_ops pcm_dev_pm_ops
= {
614 SET_SYSTEM_SLEEP_PM_OPS(do_pcm_suspend
, NULL
)
617 /* device type for PCM -- basically only for passing PM callbacks */
618 static const struct device_type pcm_dev_type
= {
620 .pm
= &pcm_dev_pm_ops
,
624 * snd_pcm_new_stream - create a new PCM stream
625 * @pcm: the pcm instance
626 * @stream: the stream direction, SNDRV_PCM_STREAM_XXX
627 * @substream_count: the number of substreams
629 * Creates a new stream for the pcm.
630 * The corresponding stream on the pcm must have been empty before
631 * calling this, i.e. zero must be given to the argument of
634 * Return: Zero if successful, or a negative error code on failure.
636 int snd_pcm_new_stream(struct snd_pcm
*pcm
, int stream
, int substream_count
)
639 struct snd_pcm_str
*pstr
= &pcm
->streams
[stream
];
640 struct snd_pcm_substream
*substream
, *prev
;
642 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
643 mutex_init(&pstr
->oss
.setup_mutex
);
645 pstr
->stream
= stream
;
647 pstr
->substream_count
= substream_count
;
648 if (!substream_count
)
651 snd_device_initialize(&pstr
->dev
, pcm
->card
);
652 pstr
->dev
.groups
= pcm_dev_attr_groups
;
653 pstr
->dev
.type
= &pcm_dev_type
;
654 dev_set_name(&pstr
->dev
, "pcmC%iD%i%c", pcm
->card
->number
, pcm
->device
,
655 stream
== SNDRV_PCM_STREAM_PLAYBACK
? 'p' : 'c');
657 if (!pcm
->internal
) {
658 err
= snd_pcm_stream_proc_init(pstr
);
660 pcm_err(pcm
, "Error in snd_pcm_stream_proc_init\n");
665 for (idx
= 0, prev
= NULL
; idx
< substream_count
; idx
++) {
666 substream
= kzalloc(sizeof(*substream
), GFP_KERNEL
);
669 substream
->pcm
= pcm
;
670 substream
->pstr
= pstr
;
671 substream
->number
= idx
;
672 substream
->stream
= stream
;
673 sprintf(substream
->name
, "subdevice #%i", idx
);
674 substream
->buffer_bytes_max
= UINT_MAX
;
676 pstr
->substream
= substream
;
678 prev
->next
= substream
;
680 if (!pcm
->internal
) {
681 err
= snd_pcm_substream_proc_init(substream
);
684 "Error in snd_pcm_stream_proc_init\n");
686 pstr
->substream
= NULL
;
693 substream
->group
= &substream
->self_group
;
694 snd_pcm_group_init(&substream
->self_group
);
695 list_add_tail(&substream
->link_list
, &substream
->self_group
.substreams
);
696 atomic_set(&substream
->mmap_count
, 0);
701 EXPORT_SYMBOL(snd_pcm_new_stream
);
703 static int _snd_pcm_new(struct snd_card
*card
, const char *id
, int device
,
704 int playback_count
, int capture_count
, bool internal
,
705 struct snd_pcm
**rpcm
)
709 static const struct snd_device_ops ops
= {
710 .dev_free
= snd_pcm_dev_free
,
711 .dev_register
= snd_pcm_dev_register
,
712 .dev_disconnect
= snd_pcm_dev_disconnect
,
714 static const struct snd_device_ops internal_ops
= {
715 .dev_free
= snd_pcm_dev_free
,
718 if (snd_BUG_ON(!card
))
722 pcm
= kzalloc(sizeof(*pcm
), GFP_KERNEL
);
726 pcm
->device
= device
;
727 pcm
->internal
= internal
;
728 mutex_init(&pcm
->open_mutex
);
729 init_waitqueue_head(&pcm
->open_wait
);
730 INIT_LIST_HEAD(&pcm
->list
);
732 strlcpy(pcm
->id
, id
, sizeof(pcm
->id
));
734 err
= snd_pcm_new_stream(pcm
, SNDRV_PCM_STREAM_PLAYBACK
,
739 err
= snd_pcm_new_stream(pcm
, SNDRV_PCM_STREAM_CAPTURE
, capture_count
);
743 err
= snd_device_new(card
, SNDRV_DEV_PCM
, pcm
,
744 internal
? &internal_ops
: &ops
);
758 * snd_pcm_new - create a new PCM instance
759 * @card: the card instance
761 * @device: the device index (zero based)
762 * @playback_count: the number of substreams for playback
763 * @capture_count: the number of substreams for capture
764 * @rpcm: the pointer to store the new pcm instance
766 * Creates a new PCM instance.
768 * The pcm operators have to be set afterwards to the new instance
769 * via snd_pcm_set_ops().
771 * Return: Zero if successful, or a negative error code on failure.
773 int snd_pcm_new(struct snd_card
*card
, const char *id
, int device
,
774 int playback_count
, int capture_count
, struct snd_pcm
**rpcm
)
776 return _snd_pcm_new(card
, id
, device
, playback_count
, capture_count
,
779 EXPORT_SYMBOL(snd_pcm_new
);
782 * snd_pcm_new_internal - create a new internal PCM instance
783 * @card: the card instance
785 * @device: the device index (zero based - shared with normal PCMs)
786 * @playback_count: the number of substreams for playback
787 * @capture_count: the number of substreams for capture
788 * @rpcm: the pointer to store the new pcm instance
790 * Creates a new internal PCM instance with no userspace device or procfs
791 * entries. This is used by ASoC Back End PCMs in order to create a PCM that
792 * will only be used internally by kernel drivers. i.e. it cannot be opened
793 * by userspace. It provides existing ASoC components drivers with a substream
794 * and access to any private data.
796 * The pcm operators have to be set afterwards to the new instance
797 * via snd_pcm_set_ops().
799 * Return: Zero if successful, or a negative error code on failure.
801 int snd_pcm_new_internal(struct snd_card
*card
, const char *id
, int device
,
802 int playback_count
, int capture_count
,
803 struct snd_pcm
**rpcm
)
805 return _snd_pcm_new(card
, id
, device
, playback_count
, capture_count
,
808 EXPORT_SYMBOL(snd_pcm_new_internal
);
810 static void free_chmap(struct snd_pcm_str
*pstr
)
812 if (pstr
->chmap_kctl
) {
813 snd_ctl_remove(pstr
->pcm
->card
, pstr
->chmap_kctl
);
814 pstr
->chmap_kctl
= NULL
;
818 static void snd_pcm_free_stream(struct snd_pcm_str
* pstr
)
820 struct snd_pcm_substream
*substream
, *substream_next
;
821 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
822 struct snd_pcm_oss_setup
*setup
, *setupn
;
825 /* free all proc files under the stream */
826 snd_pcm_stream_proc_done(pstr
);
828 substream
= pstr
->substream
;
830 substream_next
= substream
->next
;
831 snd_pcm_timer_done(substream
);
833 substream
= substream_next
;
835 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
836 for (setup
= pstr
->oss
.setup_list
; setup
; setup
= setupn
) {
837 setupn
= setup
->next
;
838 kfree(setup
->task_name
);
843 if (pstr
->substream_count
)
844 put_device(&pstr
->dev
);
847 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
848 #define pcm_call_notify(pcm, call) \
850 struct snd_pcm_notify *_notify; \
851 list_for_each_entry(_notify, &snd_pcm_notify_list, list) \
852 _notify->call(pcm); \
855 #define pcm_call_notify(pcm, call) do {} while (0)
858 static int snd_pcm_free(struct snd_pcm
*pcm
)
863 pcm_call_notify(pcm
, n_unregister
);
864 if (pcm
->private_free
)
865 pcm
->private_free(pcm
);
866 snd_pcm_lib_preallocate_free_for_all(pcm
);
867 snd_pcm_free_stream(&pcm
->streams
[SNDRV_PCM_STREAM_PLAYBACK
]);
868 snd_pcm_free_stream(&pcm
->streams
[SNDRV_PCM_STREAM_CAPTURE
]);
873 static int snd_pcm_dev_free(struct snd_device
*device
)
875 struct snd_pcm
*pcm
= device
->device_data
;
876 return snd_pcm_free(pcm
);
879 int snd_pcm_attach_substream(struct snd_pcm
*pcm
, int stream
,
881 struct snd_pcm_substream
**rsubstream
)
883 struct snd_pcm_str
* pstr
;
884 struct snd_pcm_substream
*substream
;
885 struct snd_pcm_runtime
*runtime
;
886 struct snd_card
*card
;
887 int prefer_subdevice
;
890 if (snd_BUG_ON(!pcm
|| !rsubstream
))
892 if (snd_BUG_ON(stream
!= SNDRV_PCM_STREAM_PLAYBACK
&&
893 stream
!= SNDRV_PCM_STREAM_CAPTURE
))
896 pstr
= &pcm
->streams
[stream
];
897 if (pstr
->substream
== NULL
|| pstr
->substream_count
== 0)
901 prefer_subdevice
= snd_ctl_get_preferred_subdevice(card
, SND_CTL_SUBDEV_PCM
);
903 if (pcm
->info_flags
& SNDRV_PCM_INFO_HALF_DUPLEX
) {
904 int opposite
= !stream
;
906 for (substream
= pcm
->streams
[opposite
].substream
; substream
;
907 substream
= substream
->next
) {
908 if (SUBSTREAM_BUSY(substream
))
913 if (file
->f_flags
& O_APPEND
) {
914 if (prefer_subdevice
< 0) {
915 if (pstr
->substream_count
> 1)
916 return -EINVAL
; /* must be unique */
917 substream
= pstr
->substream
;
919 for (substream
= pstr
->substream
; substream
;
920 substream
= substream
->next
)
921 if (substream
->number
== prefer_subdevice
)
926 if (! SUBSTREAM_BUSY(substream
))
928 substream
->ref_count
++;
929 *rsubstream
= substream
;
933 for (substream
= pstr
->substream
; substream
; substream
= substream
->next
) {
934 if (!SUBSTREAM_BUSY(substream
) &&
935 (prefer_subdevice
== -1 ||
936 substream
->number
== prefer_subdevice
))
939 if (substream
== NULL
)
942 runtime
= kzalloc(sizeof(*runtime
), GFP_KERNEL
);
946 size
= PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status
));
947 runtime
->status
= alloc_pages_exact(size
, GFP_KERNEL
);
948 if (runtime
->status
== NULL
) {
952 memset(runtime
->status
, 0, size
);
954 size
= PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control
));
955 runtime
->control
= alloc_pages_exact(size
, GFP_KERNEL
);
956 if (runtime
->control
== NULL
) {
957 free_pages_exact(runtime
->status
,
958 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status
)));
962 memset(runtime
->control
, 0, size
);
964 init_waitqueue_head(&runtime
->sleep
);
965 init_waitqueue_head(&runtime
->tsleep
);
967 runtime
->status
->state
= SNDRV_PCM_STATE_OPEN
;
969 substream
->runtime
= runtime
;
970 substream
->private_data
= pcm
->private_data
;
971 substream
->ref_count
= 1;
972 substream
->f_flags
= file
->f_flags
;
973 substream
->pid
= get_pid(task_pid(current
));
974 pstr
->substream_opened
++;
975 *rsubstream
= substream
;
979 void snd_pcm_detach_substream(struct snd_pcm_substream
*substream
)
981 struct snd_pcm_runtime
*runtime
;
983 if (PCM_RUNTIME_CHECK(substream
))
985 runtime
= substream
->runtime
;
986 if (runtime
->private_free
!= NULL
)
987 runtime
->private_free(runtime
);
988 free_pages_exact(runtime
->status
,
989 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status
)));
990 free_pages_exact(runtime
->control
,
991 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control
)));
992 kfree(runtime
->hw_constraints
.rules
);
993 /* Avoid concurrent access to runtime via PCM timer interface */
994 if (substream
->timer
)
995 spin_lock_irq(&substream
->timer
->lock
);
996 substream
->runtime
= NULL
;
997 if (substream
->timer
)
998 spin_unlock_irq(&substream
->timer
->lock
);
1000 put_pid(substream
->pid
);
1001 substream
->pid
= NULL
;
1002 substream
->pstr
->substream_opened
--;
1005 static ssize_t
show_pcm_class(struct device
*dev
,
1006 struct device_attribute
*attr
, char *buf
)
1008 struct snd_pcm_str
*pstr
= container_of(dev
, struct snd_pcm_str
, 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 sprintf(buf
, "%s\n", str
);
1025 static DEVICE_ATTR(pcm_class
, 0444, show_pcm_class
, NULL
);
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 mutex_lock(®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
);
1082 mutex_unlock(®ister_mutex
);
1086 static int snd_pcm_dev_disconnect(struct snd_device
*device
)
1088 struct snd_pcm
*pcm
= device
->device_data
;
1089 struct snd_pcm_substream
*substream
;
1092 mutex_lock(®ister_mutex
);
1093 mutex_lock(&pcm
->open_mutex
);
1094 wake_up(&pcm
->open_wait
);
1095 list_del_init(&pcm
->list
);
1096 for (cidx
= 0; cidx
< 2; cidx
++) {
1097 for (substream
= pcm
->streams
[cidx
].substream
; substream
; substream
= substream
->next
) {
1098 snd_pcm_stream_lock_irq(substream
);
1099 if (substream
->runtime
) {
1100 if (snd_pcm_running(substream
))
1101 snd_pcm_stop(substream
,
1102 SNDRV_PCM_STATE_DISCONNECTED
);
1103 /* to be sure, set the state unconditionally */
1104 substream
->runtime
->status
->state
= SNDRV_PCM_STATE_DISCONNECTED
;
1105 wake_up(&substream
->runtime
->sleep
);
1106 wake_up(&substream
->runtime
->tsleep
);
1108 snd_pcm_stream_unlock_irq(substream
);
1112 pcm_call_notify(pcm
, n_disconnect
);
1113 for (cidx
= 0; cidx
< 2; cidx
++) {
1114 snd_unregister_device(&pcm
->streams
[cidx
].dev
);
1115 free_chmap(&pcm
->streams
[cidx
]);
1117 mutex_unlock(&pcm
->open_mutex
);
1118 mutex_unlock(®ister_mutex
);
1122 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
1124 * snd_pcm_notify - Add/remove the notify list
1125 * @notify: PCM notify list
1126 * @nfree: 0 = register, 1 = unregister
1128 * This adds the given notifier to the global list so that the callback is
1129 * called for each registered PCM devices. This exists only for PCM OSS
1130 * emulation, so far.
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 mutex_lock(®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
);
1151 mutex_unlock(®ister_mutex
);
1154 EXPORT_SYMBOL(snd_pcm_notify
);
1155 #endif /* CONFIG_SND_PCM_OSS */
1157 #ifdef CONFIG_SND_PROC_FS
1162 static void snd_pcm_proc_read(struct snd_info_entry
*entry
,
1163 struct snd_info_buffer
*buffer
)
1165 struct snd_pcm
*pcm
;
1167 mutex_lock(®ister_mutex
);
1168 list_for_each_entry(pcm
, &snd_pcm_devices
, list
) {
1169 snd_iprintf(buffer
, "%02i-%02i: %s : %s",
1170 pcm
->card
->number
, pcm
->device
, pcm
->id
, pcm
->name
);
1171 if (pcm
->streams
[SNDRV_PCM_STREAM_PLAYBACK
].substream
)
1172 snd_iprintf(buffer
, " : playback %i",
1173 pcm
->streams
[SNDRV_PCM_STREAM_PLAYBACK
].substream_count
);
1174 if (pcm
->streams
[SNDRV_PCM_STREAM_CAPTURE
].substream
)
1175 snd_iprintf(buffer
, " : capture %i",
1176 pcm
->streams
[SNDRV_PCM_STREAM_CAPTURE
].substream_count
);
1177 snd_iprintf(buffer
, "\n");
1179 mutex_unlock(®ister_mutex
);
1182 static struct snd_info_entry
*snd_pcm_proc_entry
;
1184 static void snd_pcm_proc_init(void)
1186 struct snd_info_entry
*entry
;
1188 entry
= snd_info_create_module_entry(THIS_MODULE
, "pcm", NULL
);
1190 snd_info_set_text_ops(entry
, NULL
, snd_pcm_proc_read
);
1191 if (snd_info_register(entry
) < 0) {
1192 snd_info_free_entry(entry
);
1196 snd_pcm_proc_entry
= entry
;
1199 static void snd_pcm_proc_done(void)
1201 snd_info_free_entry(snd_pcm_proc_entry
);
1204 #else /* !CONFIG_SND_PROC_FS */
1205 #define snd_pcm_proc_init()
1206 #define snd_pcm_proc_done()
1207 #endif /* CONFIG_SND_PROC_FS */
1214 static int __init
alsa_pcm_init(void)
1216 snd_ctl_register_ioctl(snd_pcm_control_ioctl
);
1217 snd_ctl_register_ioctl_compat(snd_pcm_control_ioctl
);
1218 snd_pcm_proc_init();
1222 static void __exit
alsa_pcm_exit(void)
1224 snd_ctl_unregister_ioctl(snd_pcm_control_ioctl
);
1225 snd_ctl_unregister_ioctl_compat(snd_pcm_control_ioctl
);
1226 snd_pcm_proc_done();
1229 module_init(alsa_pcm_init
)
1230 module_exit(alsa_pcm_exit
)