Loading...
1/*
2 * Digital Audio (PCM) abstract layer
3 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
4 *
5 *
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.
10 *
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.
15 *
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
19 *
20 */
21
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>
33
34MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>, Abramo Bagnara <abramo@alsa-project.org>");
35MODULE_DESCRIPTION("Midlevel PCM code for ALSA.");
36MODULE_LICENSE("GPL");
37
38static LIST_HEAD(snd_pcm_devices);
39static LIST_HEAD(snd_pcm_notify_list);
40static DEFINE_MUTEX(register_mutex);
41
42static int snd_pcm_free(struct snd_pcm *pcm);
43static int snd_pcm_dev_free(struct snd_device *device);
44static int snd_pcm_dev_register(struct snd_device *device);
45static int snd_pcm_dev_disconnect(struct snd_device *device);
46
47static struct snd_pcm *snd_pcm_get(struct snd_card *card, int device)
48{
49 struct snd_pcm *pcm;
50
51 list_for_each_entry(pcm, &snd_pcm_devices, list) {
52 if (pcm->card == card && pcm->device == device)
53 return pcm;
54 }
55 return NULL;
56}
57
58static int snd_pcm_next(struct snd_card *card, int device)
59{
60 struct snd_pcm *pcm;
61
62 list_for_each_entry(pcm, &snd_pcm_devices, list) {
63 if (pcm->card == card && pcm->device > device)
64 return pcm->device;
65 else if (pcm->card->number > card->number)
66 return -1;
67 }
68 return -1;
69}
70
71static int snd_pcm_add(struct snd_pcm *newpcm)
72{
73 struct snd_pcm *pcm;
74
75 if (newpcm->internal)
76 return 0;
77
78 list_for_each_entry(pcm, &snd_pcm_devices, list) {
79 if (pcm->card == newpcm->card && pcm->device == newpcm->device)
80 return -EBUSY;
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);
85 return 0;
86 }
87 }
88 list_add_tail(&newpcm->list, &snd_pcm_devices);
89 return 0;
90}
91
92static int snd_pcm_control_ioctl(struct snd_card *card,
93 struct snd_ctl_file *control,
94 unsigned int cmd, unsigned long arg)
95{
96 switch (cmd) {
97 case SNDRV_CTL_IOCTL_PCM_NEXT_DEVICE:
98 {
99 int device;
100
101 if (get_user(device, (int __user *)arg))
102 return -EFAULT;
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))
107 return -EFAULT;
108 return 0;
109 }
110 case SNDRV_CTL_IOCTL_PCM_INFO:
111 {
112 struct snd_pcm_info __user *info;
113 unsigned int device, subdevice;
114 int stream;
115 struct snd_pcm *pcm;
116 struct snd_pcm_str *pstr;
117 struct snd_pcm_substream *substream;
118 int err;
119
120 info = (struct snd_pcm_info __user *)arg;
121 if (get_user(device, &info->device))
122 return -EFAULT;
123 if (get_user(stream, &info->stream))
124 return -EFAULT;
125 if (stream < 0 || stream > 1)
126 return -EINVAL;
127 if (get_user(subdevice, &info->subdevice))
128 return -EFAULT;
129 mutex_lock(®ister_mutex);
130 pcm = snd_pcm_get(card, device);
131 if (pcm == NULL) {
132 err = -ENXIO;
133 goto _error;
134 }
135 pstr = &pcm->streams[stream];
136 if (pstr->substream_count == 0) {
137 err = -ENOENT;
138 goto _error;
139 }
140 if (subdevice >= pstr->substream_count) {
141 err = -ENXIO;
142 goto _error;
143 }
144 for (substream = pstr->substream; substream;
145 substream = substream->next)
146 if (substream->number == (int)subdevice)
147 break;
148 if (substream == NULL) {
149 err = -ENXIO;
150 goto _error;
151 }
152 err = snd_pcm_info_user(substream, info);
153 _error:
154 mutex_unlock(®ister_mutex);
155 return err;
156 }
157 case SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE:
158 {
159 int val;
160
161 if (get_user(val, (int __user *)arg))
162 return -EFAULT;
163 control->preferred_subdevice[SND_CTL_SUBDEV_PCM] = val;
164 return 0;
165 }
166 }
167 return -ENOIOCTLCMD;
168}
169
170#define FORMAT(v) [SNDRV_PCM_FORMAT_##v] = #v
171
172static char *snd_pcm_format_names[] = {
173 FORMAT(S8),
174 FORMAT(U8),
175 FORMAT(S16_LE),
176 FORMAT(S16_BE),
177 FORMAT(U16_LE),
178 FORMAT(U16_BE),
179 FORMAT(S24_LE),
180 FORMAT(S24_BE),
181 FORMAT(U24_LE),
182 FORMAT(U24_BE),
183 FORMAT(S32_LE),
184 FORMAT(S32_BE),
185 FORMAT(U32_LE),
186 FORMAT(U32_BE),
187 FORMAT(FLOAT_LE),
188 FORMAT(FLOAT_BE),
189 FORMAT(FLOAT64_LE),
190 FORMAT(FLOAT64_BE),
191 FORMAT(IEC958_SUBFRAME_LE),
192 FORMAT(IEC958_SUBFRAME_BE),
193 FORMAT(MU_LAW),
194 FORMAT(A_LAW),
195 FORMAT(IMA_ADPCM),
196 FORMAT(MPEG),
197 FORMAT(GSM),
198 FORMAT(SPECIAL),
199 FORMAT(S24_3LE),
200 FORMAT(S24_3BE),
201 FORMAT(U24_3LE),
202 FORMAT(U24_3BE),
203 FORMAT(S20_3LE),
204 FORMAT(S20_3BE),
205 FORMAT(U20_3LE),
206 FORMAT(U20_3BE),
207 FORMAT(S18_3LE),
208 FORMAT(S18_3BE),
209 FORMAT(U18_3LE),
210 FORMAT(U18_3BE),
211 FORMAT(G723_24),
212 FORMAT(G723_24_1B),
213 FORMAT(G723_40),
214 FORMAT(G723_40_1B),
215 FORMAT(DSD_U8),
216 FORMAT(DSD_U16_LE),
217 FORMAT(DSD_U32_LE),
218 FORMAT(DSD_U16_BE),
219 FORMAT(DSD_U32_BE),
220};
221
222/**
223 * snd_pcm_format_name - Return a name string for the given PCM format
224 * @format: PCM format
225 */
226const char *snd_pcm_format_name(snd_pcm_format_t format)
227{
228 if ((__force unsigned int)format >= ARRAY_SIZE(snd_pcm_format_names))
229 return "Unknown";
230 return snd_pcm_format_names[(__force unsigned int)format];
231}
232EXPORT_SYMBOL_GPL(snd_pcm_format_name);
233
234#ifdef CONFIG_SND_VERBOSE_PROCFS
235
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
245
246static char *snd_pcm_stream_names[] = {
247 STREAM(PLAYBACK),
248 STREAM(CAPTURE),
249};
250
251static char *snd_pcm_state_names[] = {
252 STATE(OPEN),
253 STATE(SETUP),
254 STATE(PREPARED),
255 STATE(RUNNING),
256 STATE(XRUN),
257 STATE(DRAINING),
258 STATE(PAUSED),
259 STATE(SUSPENDED),
260};
261
262static 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),
268};
269
270static char *snd_pcm_subformat_names[] = {
271 SUBFORMAT(STD),
272};
273
274static char *snd_pcm_tstamp_mode_names[] = {
275 TSTAMP(NONE),
276 TSTAMP(ENABLE),
277};
278
279static const char *snd_pcm_stream_name(int stream)
280{
281 return snd_pcm_stream_names[stream];
282}
283
284static const char *snd_pcm_access_name(snd_pcm_access_t access)
285{
286 return snd_pcm_access_names[(__force int)access];
287}
288
289static const char *snd_pcm_subformat_name(snd_pcm_subformat_t subformat)
290{
291 return snd_pcm_subformat_names[(__force int)subformat];
292}
293
294static const char *snd_pcm_tstamp_mode_name(int mode)
295{
296 return snd_pcm_tstamp_mode_names[mode];
297}
298
299static const char *snd_pcm_state_name(snd_pcm_state_t state)
300{
301 return snd_pcm_state_names[(__force int)state];
302}
303
304#if IS_ENABLED(CONFIG_SND_PCM_OSS)
305#include <linux/soundcard.h>
306
307static const char *snd_pcm_oss_format_name(int format)
308{
309 switch (format) {
310 case AFMT_MU_LAW:
311 return "MU_LAW";
312 case AFMT_A_LAW:
313 return "A_LAW";
314 case AFMT_IMA_ADPCM:
315 return "IMA_ADPCM";
316 case AFMT_U8:
317 return "U8";
318 case AFMT_S16_LE:
319 return "S16_LE";
320 case AFMT_S16_BE:
321 return "S16_BE";
322 case AFMT_S8:
323 return "S8";
324 case AFMT_U16_LE:
325 return "U16_LE";
326 case AFMT_U16_BE:
327 return "U16_BE";
328 case AFMT_MPEG:
329 return "MPEG";
330 default:
331 return "unknown";
332 }
333}
334#endif
335
336static void snd_pcm_proc_info_read(struct snd_pcm_substream *substream,
337 struct snd_info_buffer *buffer)
338{
339 struct snd_pcm_info *info;
340 int err;
341
342 if (! substream)
343 return;
344
345 info = kmalloc(sizeof(*info), GFP_KERNEL);
346 if (!info)
347 return;
348
349 err = snd_pcm_info(substream, info);
350 if (err < 0) {
351 snd_iprintf(buffer, "error %d\n", err);
352 kfree(info);
353 return;
354 }
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);
366 kfree(info);
367}
368
369static void snd_pcm_stream_proc_info_read(struct snd_info_entry *entry,
370 struct snd_info_buffer *buffer)
371{
372 snd_pcm_proc_info_read(((struct snd_pcm_str *)entry->private_data)->substream,
373 buffer);
374}
375
376static void snd_pcm_substream_proc_info_read(struct snd_info_entry *entry,
377 struct snd_info_buffer *buffer)
378{
379 snd_pcm_proc_info_read(entry->private_data, buffer);
380}
381
382static void snd_pcm_substream_proc_hw_params_read(struct snd_info_entry *entry,
383 struct snd_info_buffer *buffer)
384{
385 struct snd_pcm_substream *substream = entry->private_data;
386 struct snd_pcm_runtime *runtime;
387
388 mutex_lock(&substream->pcm->open_mutex);
389 runtime = substream->runtime;
390 if (!runtime) {
391 snd_iprintf(buffer, "closed\n");
392 goto unlock;
393 }
394 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
395 snd_iprintf(buffer, "no setup\n");
396 goto unlock;
397 }
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);
413 }
414#endif
415 unlock:
416 mutex_unlock(&substream->pcm->open_mutex);
417}
418
419static void snd_pcm_substream_proc_sw_params_read(struct snd_info_entry *entry,
420 struct snd_info_buffer *buffer)
421{
422 struct snd_pcm_substream *substream = entry->private_data;
423 struct snd_pcm_runtime *runtime;
424
425 mutex_lock(&substream->pcm->open_mutex);
426 runtime = substream->runtime;
427 if (!runtime) {
428 snd_iprintf(buffer, "closed\n");
429 goto unlock;
430 }
431 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
432 snd_iprintf(buffer, "no setup\n");
433 goto unlock;
434 }
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);
443 unlock:
444 mutex_unlock(&substream->pcm->open_mutex);
445}
446
447static void snd_pcm_substream_proc_status_read(struct snd_info_entry *entry,
448 struct snd_info_buffer *buffer)
449{
450 struct snd_pcm_substream *substream = entry->private_data;
451 struct snd_pcm_runtime *runtime;
452 struct snd_pcm_status status;
453 int err;
454
455 mutex_lock(&substream->pcm->open_mutex);
456 runtime = substream->runtime;
457 if (!runtime) {
458 snd_iprintf(buffer, "closed\n");
459 goto unlock;
460 }
461 memset(&status, 0, sizeof(status));
462 err = snd_pcm_status(substream, &status);
463 if (err < 0) {
464 snd_iprintf(buffer, "error %d\n", err);
465 goto unlock;
466 }
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);
479 unlock:
480 mutex_unlock(&substream->pcm->open_mutex);
481}
482
483#ifdef CONFIG_SND_PCM_XRUN_DEBUG
484static void snd_pcm_xrun_injection_write(struct snd_info_entry *entry,
485 struct snd_info_buffer *buffer)
486{
487 struct snd_pcm_substream *substream = entry->private_data;
488 struct snd_pcm_runtime *runtime;
489
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);
495}
496
497static void snd_pcm_xrun_debug_read(struct snd_info_entry *entry,
498 struct snd_info_buffer *buffer)
499{
500 struct snd_pcm_str *pstr = entry->private_data;
501 snd_iprintf(buffer, "%d\n", pstr->xrun_debug);
502}
503
504static void snd_pcm_xrun_debug_write(struct snd_info_entry *entry,
505 struct snd_info_buffer *buffer)
506{
507 struct snd_pcm_str *pstr = entry->private_data;
508 char line[64];
509 if (!snd_info_get_line(buffer, line, sizeof(line)))
510 pstr->xrun_debug = simple_strtoul(line, NULL, 10);
511}
512#endif
513
514static int snd_pcm_stream_proc_init(struct snd_pcm_str *pstr)
515{
516 struct snd_pcm *pcm = pstr->pcm;
517 struct snd_info_entry *entry;
518 char name[16];
519
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)
523 return -ENOMEM;
524 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
525 if (snd_info_register(entry) < 0) {
526 snd_info_free_entry(entry);
527 return -ENOMEM;
528 }
529 pstr->proc_root = entry;
530
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);
535 entry = NULL;
536 }
537 }
538 pstr->proc_info_entry = entry;
539
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);
549 entry = NULL;
550 }
551 }
552 pstr->proc_xrun_debug_entry = entry;
553#endif
554 return 0;
555}
556
557static int snd_pcm_stream_proc_done(struct snd_pcm_str *pstr)
558{
559#ifdef CONFIG_SND_PCM_XRUN_DEBUG
560 snd_info_free_entry(pstr->proc_xrun_debug_entry);
561 pstr->proc_xrun_debug_entry = NULL;
562#endif
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;
567 return 0;
568}
569
570static int snd_pcm_substream_proc_init(struct snd_pcm_substream *substream)
571{
572 struct snd_info_entry *entry;
573 struct snd_card *card;
574 char name[16];
575
576 card = substream->pcm->card;
577
578 sprintf(name, "sub%i", substream->number);
579 if ((entry = snd_info_create_card_entry(card, name, substream->pstr->proc_root)) == NULL)
580 return -ENOMEM;
581 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
582 if (snd_info_register(entry) < 0) {
583 snd_info_free_entry(entry);
584 return -ENOMEM;
585 }
586 substream->proc_root = entry;
587
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);
593 entry = NULL;
594 }
595 }
596 substream->proc_info_entry = entry;
597
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);
603 entry = NULL;
604 }
605 }
606 substream->proc_hw_params_entry = entry;
607
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);
613 entry = NULL;
614 }
615 }
616 substream->proc_sw_params_entry = entry;
617
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);
623 entry = NULL;
624 }
625 }
626 substream->proc_status_entry = entry;
627
628#ifdef CONFIG_SND_PCM_XRUN_DEBUG
629 entry = snd_info_create_card_entry(card, "xrun_injection",
630 substream->proc_root);
631 if (entry) {
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);
638 entry = NULL;
639 }
640 }
641 substream->proc_xrun_injection_entry = entry;
642#endif /* CONFIG_SND_PCM_XRUN_DEBUG */
643
644 return 0;
645}
646
647static int snd_pcm_substream_proc_done(struct snd_pcm_substream *substream)
648{
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;
660#endif
661 snd_info_free_entry(substream->proc_root);
662 substream->proc_root = NULL;
663 return 0;
664}
665#else /* !CONFIG_SND_VERBOSE_PROCFS */
666static inline int snd_pcm_stream_proc_init(struct snd_pcm_str *pstr) { return 0; }
667static inline int snd_pcm_stream_proc_done(struct snd_pcm_str *pstr) { return 0; }
668static inline int snd_pcm_substream_proc_init(struct snd_pcm_substream *substream) { return 0; }
669static inline int snd_pcm_substream_proc_done(struct snd_pcm_substream *substream) { return 0; }
670#endif /* CONFIG_SND_VERBOSE_PROCFS */
671
672static const struct attribute_group *pcm_dev_attr_groups[];
673
674/**
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
679 *
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
683 * snd_pcm_new().
684 *
685 * Return: Zero if successful, or a negative error code on failure.
686 */
687int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count)
688{
689 int idx, err;
690 struct snd_pcm_str *pstr = &pcm->streams[stream];
691 struct snd_pcm_substream *substream, *prev;
692
693#if IS_ENABLED(CONFIG_SND_PCM_OSS)
694 mutex_init(&pstr->oss.setup_mutex);
695#endif
696 pstr->stream = stream;
697 pstr->pcm = pcm;
698 pstr->substream_count = substream_count;
699 if (!substream_count)
700 return 0;
701
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');
706
707 if (!pcm->internal) {
708 err = snd_pcm_stream_proc_init(pstr);
709 if (err < 0) {
710 pcm_err(pcm, "Error in snd_pcm_stream_proc_init\n");
711 return err;
712 }
713 }
714 prev = NULL;
715 for (idx = 0, prev = NULL; idx < substream_count; idx++) {
716 substream = kzalloc(sizeof(*substream), GFP_KERNEL);
717 if (!substream)
718 return -ENOMEM;
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;
725 if (prev == NULL)
726 pstr->substream = substream;
727 else
728 prev->next = substream;
729
730 if (!pcm->internal) {
731 err = snd_pcm_substream_proc_init(substream);
732 if (err < 0) {
733 pcm_err(pcm,
734 "Error in snd_pcm_stream_proc_init\n");
735 if (prev == NULL)
736 pstr->substream = NULL;
737 else
738 prev->next = NULL;
739 kfree(substream);
740 return err;
741 }
742 }
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);
749 prev = substream;
750 }
751 return 0;
752}
753EXPORT_SYMBOL(snd_pcm_new_stream);
754
755static 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)
758{
759 struct snd_pcm *pcm;
760 int err;
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,
765 };
766
767 if (snd_BUG_ON(!card))
768 return -ENXIO;
769 if (rpcm)
770 *rpcm = NULL;
771 pcm = kzalloc(sizeof(*pcm), GFP_KERNEL);
772 if (!pcm)
773 return -ENOMEM;
774 pcm->card = card;
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);
780 if (id)
781 strlcpy(pcm->id, id, sizeof(pcm->id));
782 if ((err = snd_pcm_new_stream(pcm, SNDRV_PCM_STREAM_PLAYBACK, playback_count)) < 0) {
783 snd_pcm_free(pcm);
784 return err;
785 }
786 if ((err = snd_pcm_new_stream(pcm, SNDRV_PCM_STREAM_CAPTURE, capture_count)) < 0) {
787 snd_pcm_free(pcm);
788 return err;
789 }
790 if ((err = snd_device_new(card, SNDRV_DEV_PCM, pcm, &ops)) < 0) {
791 snd_pcm_free(pcm);
792 return err;
793 }
794 if (rpcm)
795 *rpcm = pcm;
796 return 0;
797}
798
799/**
800 * snd_pcm_new - create a new PCM instance
801 * @card: the card instance
802 * @id: the id string
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
807 *
808 * Creates a new PCM instance.
809 *
810 * The pcm operators have to be set afterwards to the new instance
811 * via snd_pcm_set_ops().
812 *
813 * Return: Zero if successful, or a negative error code on failure.
814 */
815int snd_pcm_new(struct snd_card *card, const char *id, int device,
816 int playback_count, int capture_count, struct snd_pcm **rpcm)
817{
818 return _snd_pcm_new(card, id, device, playback_count, capture_count,
819 false, rpcm);
820}
821EXPORT_SYMBOL(snd_pcm_new);
822
823/**
824 * snd_pcm_new_internal - create a new internal PCM instance
825 * @card: the card instance
826 * @id: the id string
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
831 *
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.
837 *
838 * The pcm operators have to be set afterwards to the new instance
839 * via snd_pcm_set_ops().
840 *
841 * Return: Zero if successful, or a negative error code on failure.
842 */
843int 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)
846{
847 return _snd_pcm_new(card, id, device, playback_count, capture_count,
848 true, rpcm);
849}
850EXPORT_SYMBOL(snd_pcm_new_internal);
851
852static void snd_pcm_free_stream(struct snd_pcm_str * pstr)
853{
854 struct snd_pcm_substream *substream, *substream_next;
855#if IS_ENABLED(CONFIG_SND_PCM_OSS)
856 struct snd_pcm_oss_setup *setup, *setupn;
857#endif
858 substream = pstr->substream;
859 while (substream) {
860 substream_next = substream->next;
861 snd_pcm_timer_done(substream);
862 snd_pcm_substream_proc_done(substream);
863 kfree(substream);
864 substream = substream_next;
865 }
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);
871 kfree(setup);
872 }
873#endif
874 if (pstr->substream_count)
875 put_device(&pstr->dev);
876}
877
878static int snd_pcm_free(struct snd_pcm *pcm)
879{
880 struct snd_pcm_notify *notify;
881
882 if (!pcm)
883 return 0;
884 if (!pcm->internal) {
885 list_for_each_entry(notify, &snd_pcm_notify_list, list)
886 notify->n_unregister(pcm);
887 }
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]);
893 kfree(pcm);
894 return 0;
895}
896
897static int snd_pcm_dev_free(struct snd_device *device)
898{
899 struct snd_pcm *pcm = device->device_data;
900 return snd_pcm_free(pcm);
901}
902
903int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream,
904 struct file *file,
905 struct snd_pcm_substream **rsubstream)
906{
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;
912 size_t size;
913
914 if (snd_BUG_ON(!pcm || !rsubstream))
915 return -ENXIO;
916 if (snd_BUG_ON(stream != SNDRV_PCM_STREAM_PLAYBACK &&
917 stream != SNDRV_PCM_STREAM_CAPTURE))
918 return -EINVAL;
919 *rsubstream = NULL;
920 pstr = &pcm->streams[stream];
921 if (pstr->substream == NULL || pstr->substream_count == 0)
922 return -ENODEV;
923
924 card = pcm->card;
925 prefer_subdevice = snd_ctl_get_preferred_subdevice(card, SND_CTL_SUBDEV_PCM);
926
927 if (pcm->info_flags & SNDRV_PCM_INFO_HALF_DUPLEX) {
928 int opposite = !stream;
929
930 for (substream = pcm->streams[opposite].substream; substream;
931 substream = substream->next) {
932 if (SUBSTREAM_BUSY(substream))
933 return -EAGAIN;
934 }
935 }
936
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;
942 } else {
943 for (substream = pstr->substream; substream;
944 substream = substream->next)
945 if (substream->number == prefer_subdevice)
946 break;
947 }
948 if (! substream)
949 return -ENODEV;
950 if (! SUBSTREAM_BUSY(substream))
951 return -EBADFD;
952 substream->ref_count++;
953 *rsubstream = substream;
954 return 0;
955 }
956
957 for (substream = pstr->substream; substream; substream = substream->next) {
958 if (!SUBSTREAM_BUSY(substream) &&
959 (prefer_subdevice == -1 ||
960 substream->number == prefer_subdevice))
961 break;
962 }
963 if (substream == NULL)
964 return -EAGAIN;
965
966 runtime = kzalloc(sizeof(*runtime), GFP_KERNEL);
967 if (runtime == NULL)
968 return -ENOMEM;
969
970 size = PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status));
971 runtime->status = snd_malloc_pages(size, GFP_KERNEL);
972 if (runtime->status == NULL) {
973 kfree(runtime);
974 return -ENOMEM;
975 }
976 memset((void*)runtime->status, 0, size);
977
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)));
983 kfree(runtime);
984 return -ENOMEM;
985 }
986 memset((void*)runtime->control, 0, size);
987
988 init_waitqueue_head(&runtime->sleep);
989 init_waitqueue_head(&runtime->tsleep);
990
991 runtime->status->state = SNDRV_PCM_STATE_OPEN;
992
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;
1000 return 0;
1001}
1002
1003void snd_pcm_detach_substream(struct snd_pcm_substream *substream)
1004{
1005 struct snd_pcm_runtime *runtime;
1006
1007 if (PCM_RUNTIME_CHECK(substream))
1008 return;
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);
1017 kfree(runtime);
1018 substream->runtime = NULL;
1019 put_pid(substream->pid);
1020 substream->pid = NULL;
1021 substream->pstr->substream_opened--;
1022}
1023
1024static ssize_t show_pcm_class(struct device *dev,
1025 struct device_attribute *attr, char *buf)
1026{
1027 struct snd_pcm_str *pstr = container_of(dev, struct snd_pcm_str, dev);
1028 struct snd_pcm *pcm = pstr->pcm;
1029 const char *str;
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",
1035 };
1036
1037 if (pcm->dev_class > SNDRV_PCM_CLASS_LAST)
1038 str = "none";
1039 else
1040 str = strs[pcm->dev_class];
1041 return snprintf(buf, PAGE_SIZE, "%s\n", str);
1042}
1043
1044static DEVICE_ATTR(pcm_class, S_IRUGO, show_pcm_class, NULL);
1045static struct attribute *pcm_dev_attrs[] = {
1046 &dev_attr_pcm_class.attr,
1047 NULL
1048};
1049
1050static struct attribute_group pcm_dev_attr_group = {
1051 .attrs = pcm_dev_attrs,
1052};
1053
1054static const struct attribute_group *pcm_dev_attr_groups[] = {
1055 &pcm_dev_attr_group,
1056 NULL
1057};
1058
1059static int snd_pcm_dev_register(struct snd_device *device)
1060{
1061 int cidx, err;
1062 struct snd_pcm_substream *substream;
1063 struct snd_pcm_notify *notify;
1064 struct snd_pcm *pcm;
1065
1066 if (snd_BUG_ON(!device || !device->device_data))
1067 return -ENXIO;
1068 pcm = device->device_data;
1069 if (pcm->internal)
1070 return 0;
1071
1072 mutex_lock(®ister_mutex);
1073 err = snd_pcm_add(pcm);
1074 if (err)
1075 goto unlock;
1076 for (cidx = 0; cidx < 2; cidx++) {
1077 int devtype = -1;
1078 if (pcm->streams[cidx].substream == NULL)
1079 continue;
1080 switch (cidx) {
1081 case SNDRV_PCM_STREAM_PLAYBACK:
1082 devtype = SNDRV_DEVICE_TYPE_PCM_PLAYBACK;
1083 break;
1084 case SNDRV_PCM_STREAM_CAPTURE:
1085 devtype = SNDRV_DEVICE_TYPE_PCM_CAPTURE;
1086 break;
1087 }
1088 /* register pcm */
1089 err = snd_register_device(devtype, pcm->card, pcm->device,
1090 &snd_pcm_f_ops[cidx], pcm,
1091 &pcm->streams[cidx].dev);
1092 if (err < 0) {
1093 list_del_init(&pcm->list);
1094 goto unlock;
1095 }
1096
1097 for (substream = pcm->streams[cidx].substream; substream; substream = substream->next)
1098 snd_pcm_timer_init(substream);
1099 }
1100
1101 list_for_each_entry(notify, &snd_pcm_notify_list, list)
1102 notify->n_register(pcm);
1103
1104 unlock:
1105 mutex_unlock(®ister_mutex);
1106 return err;
1107}
1108
1109static int snd_pcm_dev_disconnect(struct snd_device *device)
1110{
1111 struct snd_pcm *pcm = device->device_data;
1112 struct snd_pcm_notify *notify;
1113 struct snd_pcm_substream *substream;
1114 int cidx;
1115
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);
1127 }
1128 snd_pcm_stream_unlock_irq(substream);
1129 }
1130 }
1131 if (!pcm->internal) {
1132 list_for_each_entry(notify, &snd_pcm_notify_list, list)
1133 notify->n_disconnect(pcm);
1134 }
1135 for (cidx = 0; cidx < 2; cidx++) {
1136 if (!pcm->internal)
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;
1141 }
1142 }
1143 mutex_unlock(&pcm->open_mutex);
1144 mutex_unlock(®ister_mutex);
1145 return 0;
1146}
1147
1148/**
1149 * snd_pcm_notify - Add/remove the notify list
1150 * @notify: PCM notify list
1151 * @nfree: 0 = register, 1 = unregister
1152 *
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.
1156 */
1157int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree)
1158{
1159 struct snd_pcm *pcm;
1160
1161 if (snd_BUG_ON(!notify ||
1162 !notify->n_register ||
1163 !notify->n_unregister ||
1164 !notify->n_disconnect))
1165 return -EINVAL;
1166 mutex_lock(®ister_mutex);
1167 if (nfree) {
1168 list_del(¬ify->list);
1169 list_for_each_entry(pcm, &snd_pcm_devices, list)
1170 notify->n_unregister(pcm);
1171 } else {
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);
1175 }
1176 mutex_unlock(®ister_mutex);
1177 return 0;
1178}
1179EXPORT_SYMBOL(snd_pcm_notify);
1180
1181#ifdef CONFIG_SND_PROC_FS
1182/*
1183 * Info interface
1184 */
1185
1186static void snd_pcm_proc_read(struct snd_info_entry *entry,
1187 struct snd_info_buffer *buffer)
1188{
1189 struct snd_pcm *pcm;
1190
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");
1202 }
1203 mutex_unlock(®ister_mutex);
1204}
1205
1206static struct snd_info_entry *snd_pcm_proc_entry;
1207
1208static void snd_pcm_proc_init(void)
1209{
1210 struct snd_info_entry *entry;
1211
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);
1216 entry = NULL;
1217 }
1218 }
1219 snd_pcm_proc_entry = entry;
1220}
1221
1222static void snd_pcm_proc_done(void)
1223{
1224 snd_info_free_entry(snd_pcm_proc_entry);
1225}
1226
1227#else /* !CONFIG_SND_PROC_FS */
1228#define snd_pcm_proc_init()
1229#define snd_pcm_proc_done()
1230#endif /* CONFIG_SND_PROC_FS */
1231
1232
1233/*
1234 * ENTRY functions
1235 */
1236
1237static int __init alsa_pcm_init(void)
1238{
1239 snd_ctl_register_ioctl(snd_pcm_control_ioctl);
1240 snd_ctl_register_ioctl_compat(snd_pcm_control_ioctl);
1241 snd_pcm_proc_init();
1242 return 0;
1243}
1244
1245static void __exit alsa_pcm_exit(void)
1246{
1247 snd_ctl_unregister_ioctl(snd_pcm_control_ioctl);
1248 snd_ctl_unregister_ioctl_compat(snd_pcm_control_ioctl);
1249 snd_pcm_proc_done();
1250}
1251
1252module_init(alsa_pcm_init)
1253module_exit(alsa_pcm_exit)
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Digital Audio (PCM) abstract layer
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
5 */
6
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>
20
21#include "pcm_local.h"
22
23MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>, Abramo Bagnara <abramo@alsa-project.org>");
24MODULE_DESCRIPTION("Midlevel PCM code for ALSA.");
25MODULE_LICENSE("GPL");
26
27static LIST_HEAD(snd_pcm_devices);
28static DEFINE_MUTEX(register_mutex);
29#if IS_ENABLED(CONFIG_SND_PCM_OSS)
30static LIST_HEAD(snd_pcm_notify_list);
31#endif
32
33static int snd_pcm_free(struct snd_pcm *pcm);
34static int snd_pcm_dev_free(struct snd_device *device);
35static int snd_pcm_dev_register(struct snd_device *device);
36static int snd_pcm_dev_disconnect(struct snd_device *device);
37
38static struct snd_pcm *snd_pcm_get(struct snd_card *card, int device)
39{
40 struct snd_pcm *pcm;
41
42 list_for_each_entry(pcm, &snd_pcm_devices, list) {
43 if (pcm->card == card && pcm->device == device)
44 return pcm;
45 }
46 return NULL;
47}
48
49static int snd_pcm_next(struct snd_card *card, int device)
50{
51 struct snd_pcm *pcm;
52
53 list_for_each_entry(pcm, &snd_pcm_devices, list) {
54 if (pcm->card == card && pcm->device > device)
55 return pcm->device;
56 else if (pcm->card->number > card->number)
57 return -1;
58 }
59 return -1;
60}
61
62static int snd_pcm_add(struct snd_pcm *newpcm)
63{
64 struct snd_pcm *pcm;
65
66 if (newpcm->internal)
67 return 0;
68
69 list_for_each_entry(pcm, &snd_pcm_devices, list) {
70 if (pcm->card == newpcm->card && pcm->device == newpcm->device)
71 return -EBUSY;
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);
76 return 0;
77 }
78 }
79 list_add_tail(&newpcm->list, &snd_pcm_devices);
80 return 0;
81}
82
83static int snd_pcm_control_ioctl(struct snd_card *card,
84 struct snd_ctl_file *control,
85 unsigned int cmd, unsigned long arg)
86{
87 switch (cmd) {
88 case SNDRV_CTL_IOCTL_PCM_NEXT_DEVICE:
89 {
90 int device;
91
92 if (get_user(device, (int __user *)arg))
93 return -EFAULT;
94 scoped_guard(mutex, ®ister_mutex)
95 device = snd_pcm_next(card, device);
96 if (put_user(device, (int __user *)arg))
97 return -EFAULT;
98 return 0;
99 }
100 case SNDRV_CTL_IOCTL_PCM_INFO:
101 {
102 struct snd_pcm_info __user *info;
103 unsigned int device, subdevice;
104 int stream;
105 struct snd_pcm *pcm;
106 struct snd_pcm_str *pstr;
107 struct snd_pcm_substream *substream;
108
109 info = (struct snd_pcm_info __user *)arg;
110 if (get_user(device, &info->device))
111 return -EFAULT;
112 if (get_user(stream, &info->stream))
113 return -EFAULT;
114 if (stream < 0 || stream > 1)
115 return -EINVAL;
116 stream = array_index_nospec(stream, 2);
117 if (get_user(subdevice, &info->subdevice))
118 return -EFAULT;
119 guard(mutex)(®ister_mutex);
120 pcm = snd_pcm_get(card, device);
121 if (pcm == NULL)
122 return -ENXIO;
123 pstr = &pcm->streams[stream];
124 if (pstr->substream_count == 0)
125 return -ENOENT;
126 if (subdevice >= pstr->substream_count)
127 return -ENXIO;
128 for (substream = pstr->substream; substream;
129 substream = substream->next)
130 if (substream->number == (int)subdevice)
131 break;
132 if (substream == NULL)
133 return -ENXIO;
134 guard(mutex)(&pcm->open_mutex);
135 return snd_pcm_info_user(substream, info);
136 }
137 case SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE:
138 {
139 int val;
140
141 if (get_user(val, (int __user *)arg))
142 return -EFAULT;
143 control->preferred_subdevice[SND_CTL_SUBDEV_PCM] = val;
144 return 0;
145 }
146 }
147 return -ENOIOCTLCMD;
148}
149
150#define FORMAT(v) [SNDRV_PCM_FORMAT_##v] = #v
151
152static const char * const snd_pcm_format_names[] = {
153 FORMAT(S8),
154 FORMAT(U8),
155 FORMAT(S16_LE),
156 FORMAT(S16_BE),
157 FORMAT(U16_LE),
158 FORMAT(U16_BE),
159 FORMAT(S24_LE),
160 FORMAT(S24_BE),
161 FORMAT(U24_LE),
162 FORMAT(U24_BE),
163 FORMAT(S32_LE),
164 FORMAT(S32_BE),
165 FORMAT(U32_LE),
166 FORMAT(U32_BE),
167 FORMAT(FLOAT_LE),
168 FORMAT(FLOAT_BE),
169 FORMAT(FLOAT64_LE),
170 FORMAT(FLOAT64_BE),
171 FORMAT(IEC958_SUBFRAME_LE),
172 FORMAT(IEC958_SUBFRAME_BE),
173 FORMAT(MU_LAW),
174 FORMAT(A_LAW),
175 FORMAT(IMA_ADPCM),
176 FORMAT(MPEG),
177 FORMAT(GSM),
178 FORMAT(SPECIAL),
179 FORMAT(S24_3LE),
180 FORMAT(S24_3BE),
181 FORMAT(U24_3LE),
182 FORMAT(U24_3BE),
183 FORMAT(S20_3LE),
184 FORMAT(S20_3BE),
185 FORMAT(U20_3LE),
186 FORMAT(U20_3BE),
187 FORMAT(S18_3LE),
188 FORMAT(S18_3BE),
189 FORMAT(U18_3LE),
190 FORMAT(U18_3BE),
191 FORMAT(G723_24),
192 FORMAT(G723_24_1B),
193 FORMAT(G723_40),
194 FORMAT(G723_40_1B),
195 FORMAT(DSD_U8),
196 FORMAT(DSD_U16_LE),
197 FORMAT(DSD_U32_LE),
198 FORMAT(DSD_U16_BE),
199 FORMAT(DSD_U32_BE),
200 FORMAT(S20_LE),
201 FORMAT(S20_BE),
202 FORMAT(U20_LE),
203 FORMAT(U20_BE),
204};
205
206/**
207 * snd_pcm_format_name - Return a name string for the given PCM format
208 * @format: PCM format
209 *
210 * Return: the format name string
211 */
212const char *snd_pcm_format_name(snd_pcm_format_t format)
213{
214 unsigned int format_num = (__force unsigned int)format;
215
216 if (format_num >= ARRAY_SIZE(snd_pcm_format_names) || !snd_pcm_format_names[format_num])
217 return "Unknown";
218 return snd_pcm_format_names[format_num];
219}
220EXPORT_SYMBOL_GPL(snd_pcm_format_name);
221
222#ifdef CONFIG_SND_VERBOSE_PROCFS
223
224#define STATE(v) [SNDRV_PCM_STATE_##v] = #v
225#define STREAM(v) [SNDRV_PCM_STREAM_##v] = #v
226#define READY(v) [SNDRV_PCM_READY_##v] = #v
227#define XRUN(v) [SNDRV_PCM_XRUN_##v] = #v
228#define SILENCE(v) [SNDRV_PCM_SILENCE_##v] = #v
229#define TSTAMP(v) [SNDRV_PCM_TSTAMP_##v] = #v
230#define ACCESS(v) [SNDRV_PCM_ACCESS_##v] = #v
231#define START(v) [SNDRV_PCM_START_##v] = #v
232#define SUBFORMAT(v) [SNDRV_PCM_SUBFORMAT_##v] = #v
233
234static const char * const snd_pcm_stream_names[] = {
235 STREAM(PLAYBACK),
236 STREAM(CAPTURE),
237};
238
239static const char * const snd_pcm_state_names[] = {
240 STATE(OPEN),
241 STATE(SETUP),
242 STATE(PREPARED),
243 STATE(RUNNING),
244 STATE(XRUN),
245 STATE(DRAINING),
246 STATE(PAUSED),
247 STATE(SUSPENDED),
248 STATE(DISCONNECTED),
249};
250
251static const char * const snd_pcm_access_names[] = {
252 ACCESS(MMAP_INTERLEAVED),
253 ACCESS(MMAP_NONINTERLEAVED),
254 ACCESS(MMAP_COMPLEX),
255 ACCESS(RW_INTERLEAVED),
256 ACCESS(RW_NONINTERLEAVED),
257};
258
259static const char * const snd_pcm_subformat_names[] = {
260 SUBFORMAT(STD),
261 SUBFORMAT(MSBITS_MAX),
262 SUBFORMAT(MSBITS_20),
263 SUBFORMAT(MSBITS_24),
264};
265
266static const char * const snd_pcm_tstamp_mode_names[] = {
267 TSTAMP(NONE),
268 TSTAMP(ENABLE),
269};
270
271static const char *snd_pcm_stream_name(int stream)
272{
273 return snd_pcm_stream_names[stream];
274}
275
276static const char *snd_pcm_access_name(snd_pcm_access_t access)
277{
278 return snd_pcm_access_names[(__force int)access];
279}
280
281static const char *snd_pcm_subformat_name(snd_pcm_subformat_t subformat)
282{
283 return snd_pcm_subformat_names[(__force int)subformat];
284}
285
286static const char *snd_pcm_tstamp_mode_name(int mode)
287{
288 return snd_pcm_tstamp_mode_names[mode];
289}
290
291static const char *snd_pcm_state_name(snd_pcm_state_t state)
292{
293 return snd_pcm_state_names[(__force int)state];
294}
295
296#if IS_ENABLED(CONFIG_SND_PCM_OSS)
297#include <linux/soundcard.h>
298
299static const char *snd_pcm_oss_format_name(int format)
300{
301 switch (format) {
302 case AFMT_MU_LAW:
303 return "MU_LAW";
304 case AFMT_A_LAW:
305 return "A_LAW";
306 case AFMT_IMA_ADPCM:
307 return "IMA_ADPCM";
308 case AFMT_U8:
309 return "U8";
310 case AFMT_S16_LE:
311 return "S16_LE";
312 case AFMT_S16_BE:
313 return "S16_BE";
314 case AFMT_S8:
315 return "S8";
316 case AFMT_U16_LE:
317 return "U16_LE";
318 case AFMT_U16_BE:
319 return "U16_BE";
320 case AFMT_MPEG:
321 return "MPEG";
322 default:
323 return "unknown";
324 }
325}
326#endif
327
328static void snd_pcm_proc_info_read(struct snd_pcm_substream *substream,
329 struct snd_info_buffer *buffer)
330{
331 struct snd_pcm_info *info __free(kfree) = NULL;
332 int err;
333
334 if (! substream)
335 return;
336
337 info = kmalloc(sizeof(*info), GFP_KERNEL);
338 if (!info)
339 return;
340
341 err = snd_pcm_info(substream, info);
342 if (err < 0) {
343 snd_iprintf(buffer, "error %d\n", err);
344 return;
345 }
346 snd_iprintf(buffer, "card: %d\n", info->card);
347 snd_iprintf(buffer, "device: %d\n", info->device);
348 snd_iprintf(buffer, "subdevice: %d\n", info->subdevice);
349 snd_iprintf(buffer, "stream: %s\n", snd_pcm_stream_name(info->stream));
350 snd_iprintf(buffer, "id: %s\n", info->id);
351 snd_iprintf(buffer, "name: %s\n", info->name);
352 snd_iprintf(buffer, "subname: %s\n", info->subname);
353 snd_iprintf(buffer, "class: %d\n", info->dev_class);
354 snd_iprintf(buffer, "subclass: %d\n", info->dev_subclass);
355 snd_iprintf(buffer, "subdevices_count: %d\n", info->subdevices_count);
356 snd_iprintf(buffer, "subdevices_avail: %d\n", info->subdevices_avail);
357}
358
359static void snd_pcm_stream_proc_info_read(struct snd_info_entry *entry,
360 struct snd_info_buffer *buffer)
361{
362 snd_pcm_proc_info_read(((struct snd_pcm_str *)entry->private_data)->substream,
363 buffer);
364}
365
366static void snd_pcm_substream_proc_info_read(struct snd_info_entry *entry,
367 struct snd_info_buffer *buffer)
368{
369 snd_pcm_proc_info_read(entry->private_data, buffer);
370}
371
372static void snd_pcm_substream_proc_hw_params_read(struct snd_info_entry *entry,
373 struct snd_info_buffer *buffer)
374{
375 struct snd_pcm_substream *substream = entry->private_data;
376 struct snd_pcm_runtime *runtime;
377
378 guard(mutex)(&substream->pcm->open_mutex);
379 runtime = substream->runtime;
380 if (!runtime) {
381 snd_iprintf(buffer, "closed\n");
382 return;
383 }
384 if (runtime->state == SNDRV_PCM_STATE_OPEN) {
385 snd_iprintf(buffer, "no setup\n");
386 return;
387 }
388 snd_iprintf(buffer, "access: %s\n", snd_pcm_access_name(runtime->access));
389 snd_iprintf(buffer, "format: %s\n", snd_pcm_format_name(runtime->format));
390 snd_iprintf(buffer, "subformat: %s\n", snd_pcm_subformat_name(runtime->subformat));
391 snd_iprintf(buffer, "channels: %u\n", runtime->channels);
392 snd_iprintf(buffer, "rate: %u (%u/%u)\n", runtime->rate, runtime->rate_num, runtime->rate_den);
393 snd_iprintf(buffer, "period_size: %lu\n", runtime->period_size);
394 snd_iprintf(buffer, "buffer_size: %lu\n", runtime->buffer_size);
395#if IS_ENABLED(CONFIG_SND_PCM_OSS)
396 if (substream->oss.oss) {
397 snd_iprintf(buffer, "OSS format: %s\n", snd_pcm_oss_format_name(runtime->oss.format));
398 snd_iprintf(buffer, "OSS channels: %u\n", runtime->oss.channels);
399 snd_iprintf(buffer, "OSS rate: %u\n", runtime->oss.rate);
400 snd_iprintf(buffer, "OSS period bytes: %lu\n", (unsigned long)runtime->oss.period_bytes);
401 snd_iprintf(buffer, "OSS periods: %u\n", runtime->oss.periods);
402 snd_iprintf(buffer, "OSS period frames: %lu\n", (unsigned long)runtime->oss.period_frames);
403 }
404#endif
405}
406
407static void snd_pcm_substream_proc_sw_params_read(struct snd_info_entry *entry,
408 struct snd_info_buffer *buffer)
409{
410 struct snd_pcm_substream *substream = entry->private_data;
411 struct snd_pcm_runtime *runtime;
412
413 guard(mutex)(&substream->pcm->open_mutex);
414 runtime = substream->runtime;
415 if (!runtime) {
416 snd_iprintf(buffer, "closed\n");
417 return;
418 }
419 if (runtime->state == SNDRV_PCM_STATE_OPEN) {
420 snd_iprintf(buffer, "no setup\n");
421 return;
422 }
423 snd_iprintf(buffer, "tstamp_mode: %s\n", snd_pcm_tstamp_mode_name(runtime->tstamp_mode));
424 snd_iprintf(buffer, "period_step: %u\n", runtime->period_step);
425 snd_iprintf(buffer, "avail_min: %lu\n", runtime->control->avail_min);
426 snd_iprintf(buffer, "start_threshold: %lu\n", runtime->start_threshold);
427 snd_iprintf(buffer, "stop_threshold: %lu\n", runtime->stop_threshold);
428 snd_iprintf(buffer, "silence_threshold: %lu\n", runtime->silence_threshold);
429 snd_iprintf(buffer, "silence_size: %lu\n", runtime->silence_size);
430 snd_iprintf(buffer, "boundary: %lu\n", runtime->boundary);
431}
432
433static void snd_pcm_substream_proc_status_read(struct snd_info_entry *entry,
434 struct snd_info_buffer *buffer)
435{
436 struct snd_pcm_substream *substream = entry->private_data;
437 struct snd_pcm_runtime *runtime;
438 struct snd_pcm_status64 status;
439 int err;
440
441 guard(mutex)(&substream->pcm->open_mutex);
442 runtime = substream->runtime;
443 if (!runtime) {
444 snd_iprintf(buffer, "closed\n");
445 return;
446 }
447 memset(&status, 0, sizeof(status));
448 err = snd_pcm_status64(substream, &status);
449 if (err < 0) {
450 snd_iprintf(buffer, "error %d\n", err);
451 return;
452 }
453 snd_iprintf(buffer, "state: %s\n", snd_pcm_state_name(status.state));
454 snd_iprintf(buffer, "owner_pid : %d\n", pid_vnr(substream->pid));
455 snd_iprintf(buffer, "trigger_time: %lld.%09lld\n",
456 status.trigger_tstamp_sec, status.trigger_tstamp_nsec);
457 snd_iprintf(buffer, "tstamp : %lld.%09lld\n",
458 status.tstamp_sec, status.tstamp_nsec);
459 snd_iprintf(buffer, "delay : %ld\n", status.delay);
460 snd_iprintf(buffer, "avail : %ld\n", status.avail);
461 snd_iprintf(buffer, "avail_max : %ld\n", status.avail_max);
462 snd_iprintf(buffer, "-----\n");
463 snd_iprintf(buffer, "hw_ptr : %ld\n", runtime->status->hw_ptr);
464 snd_iprintf(buffer, "appl_ptr : %ld\n", runtime->control->appl_ptr);
465#ifdef CONFIG_SND_PCM_XRUN_DEBUG
466 snd_iprintf(buffer, "xrun_counter: %d\n", substream->xrun_counter);
467#endif
468}
469
470#ifdef CONFIG_SND_PCM_XRUN_DEBUG
471static void snd_pcm_xrun_injection_write(struct snd_info_entry *entry,
472 struct snd_info_buffer *buffer)
473{
474 struct snd_pcm_substream *substream = entry->private_data;
475
476 snd_pcm_stop_xrun(substream);
477}
478
479static void snd_pcm_xrun_debug_read(struct snd_info_entry *entry,
480 struct snd_info_buffer *buffer)
481{
482 struct snd_pcm_str *pstr = entry->private_data;
483 snd_iprintf(buffer, "%d\n", pstr->xrun_debug);
484}
485
486static void snd_pcm_xrun_debug_write(struct snd_info_entry *entry,
487 struct snd_info_buffer *buffer)
488{
489 struct snd_pcm_str *pstr = entry->private_data;
490 char line[64];
491 if (!snd_info_get_line(buffer, line, sizeof(line)))
492 pstr->xrun_debug = simple_strtoul(line, NULL, 10);
493}
494#endif
495
496static int snd_pcm_stream_proc_init(struct snd_pcm_str *pstr)
497{
498 struct snd_pcm *pcm = pstr->pcm;
499 struct snd_info_entry *entry;
500 char name[16];
501
502 sprintf(name, "pcm%i%c", pcm->device,
503 pstr->stream == SNDRV_PCM_STREAM_PLAYBACK ? 'p' : 'c');
504 entry = snd_info_create_card_entry(pcm->card, name,
505 pcm->card->proc_root);
506 if (!entry)
507 return -ENOMEM;
508 entry->mode = S_IFDIR | 0555;
509 pstr->proc_root = entry;
510 entry = snd_info_create_card_entry(pcm->card, "info", pstr->proc_root);
511 if (entry)
512 snd_info_set_text_ops(entry, pstr, snd_pcm_stream_proc_info_read);
513#ifdef CONFIG_SND_PCM_XRUN_DEBUG
514 entry = snd_info_create_card_entry(pcm->card, "xrun_debug",
515 pstr->proc_root);
516 if (entry) {
517 snd_info_set_text_ops(entry, pstr, snd_pcm_xrun_debug_read);
518 entry->c.text.write = snd_pcm_xrun_debug_write;
519 entry->mode |= 0200;
520 }
521#endif
522 return 0;
523}
524
525static int snd_pcm_stream_proc_done(struct snd_pcm_str *pstr)
526{
527 snd_info_free_entry(pstr->proc_root);
528 pstr->proc_root = NULL;
529 return 0;
530}
531
532static struct snd_info_entry *
533create_substream_info_entry(struct snd_pcm_substream *substream,
534 const char *name,
535 void (*read)(struct snd_info_entry *,
536 struct snd_info_buffer *))
537{
538 struct snd_info_entry *entry;
539
540 entry = snd_info_create_card_entry(substream->pcm->card, name,
541 substream->proc_root);
542 if (entry)
543 snd_info_set_text_ops(entry, substream, read);
544 return entry;
545}
546
547static int snd_pcm_substream_proc_init(struct snd_pcm_substream *substream)
548{
549 struct snd_info_entry *entry;
550 struct snd_card *card;
551 char name[16];
552
553 card = substream->pcm->card;
554
555 sprintf(name, "sub%i", substream->number);
556 entry = snd_info_create_card_entry(card, name,
557 substream->pstr->proc_root);
558 if (!entry)
559 return -ENOMEM;
560 entry->mode = S_IFDIR | 0555;
561 substream->proc_root = entry;
562
563 create_substream_info_entry(substream, "info",
564 snd_pcm_substream_proc_info_read);
565 create_substream_info_entry(substream, "hw_params",
566 snd_pcm_substream_proc_hw_params_read);
567 create_substream_info_entry(substream, "sw_params",
568 snd_pcm_substream_proc_sw_params_read);
569 create_substream_info_entry(substream, "status",
570 snd_pcm_substream_proc_status_read);
571
572#ifdef CONFIG_SND_PCM_XRUN_DEBUG
573 entry = create_substream_info_entry(substream, "xrun_injection", NULL);
574 if (entry) {
575 entry->c.text.write = snd_pcm_xrun_injection_write;
576 entry->mode = S_IFREG | 0200;
577 }
578#endif /* CONFIG_SND_PCM_XRUN_DEBUG */
579
580 return 0;
581}
582
583#else /* !CONFIG_SND_VERBOSE_PROCFS */
584static inline int snd_pcm_stream_proc_init(struct snd_pcm_str *pstr) { return 0; }
585static inline int snd_pcm_stream_proc_done(struct snd_pcm_str *pstr) { return 0; }
586static inline int snd_pcm_substream_proc_init(struct snd_pcm_substream *substream) { return 0; }
587#endif /* CONFIG_SND_VERBOSE_PROCFS */
588
589static const struct attribute_group *pcm_dev_attr_groups[];
590
591/*
592 * PM callbacks: we need to deal only with suspend here, as the resume is
593 * triggered either from user-space or the driver's resume callback
594 */
595#ifdef CONFIG_PM_SLEEP
596static int do_pcm_suspend(struct device *dev)
597{
598 struct snd_pcm_str *pstr = dev_get_drvdata(dev);
599
600 if (!pstr->pcm->no_device_suspend)
601 snd_pcm_suspend_all(pstr->pcm);
602 return 0;
603}
604#endif
605
606static const struct dev_pm_ops pcm_dev_pm_ops = {
607 SET_SYSTEM_SLEEP_PM_OPS(do_pcm_suspend, NULL)
608};
609
610/* device type for PCM -- basically only for passing PM callbacks */
611static const struct device_type pcm_dev_type = {
612 .name = "pcm",
613 .pm = &pcm_dev_pm_ops,
614};
615
616/**
617 * snd_pcm_new_stream - create a new PCM stream
618 * @pcm: the pcm instance
619 * @stream: the stream direction, SNDRV_PCM_STREAM_XXX
620 * @substream_count: the number of substreams
621 *
622 * Creates a new stream for the pcm.
623 * The corresponding stream on the pcm must have been empty before
624 * calling this, i.e. zero must be given to the argument of
625 * snd_pcm_new().
626 *
627 * Return: Zero if successful, or a negative error code on failure.
628 */
629int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count)
630{
631 int idx, err;
632 struct snd_pcm_str *pstr = &pcm->streams[stream];
633 struct snd_pcm_substream *substream, *prev;
634
635#if IS_ENABLED(CONFIG_SND_PCM_OSS)
636 mutex_init(&pstr->oss.setup_mutex);
637#endif
638 pstr->stream = stream;
639 pstr->pcm = pcm;
640 pstr->substream_count = substream_count;
641 if (!substream_count)
642 return 0;
643
644 err = snd_device_alloc(&pstr->dev, pcm->card);
645 if (err < 0)
646 return err;
647 dev_set_name(pstr->dev, "pcmC%iD%i%c", pcm->card->number, pcm->device,
648 stream == SNDRV_PCM_STREAM_PLAYBACK ? 'p' : 'c');
649 pstr->dev->groups = pcm_dev_attr_groups;
650 pstr->dev->type = &pcm_dev_type;
651 dev_set_drvdata(pstr->dev, pstr);
652
653 if (!pcm->internal) {
654 err = snd_pcm_stream_proc_init(pstr);
655 if (err < 0) {
656 pcm_err(pcm, "Error in snd_pcm_stream_proc_init\n");
657 return err;
658 }
659 }
660 prev = NULL;
661 for (idx = 0, prev = NULL; idx < substream_count; idx++) {
662 substream = kzalloc(sizeof(*substream), GFP_KERNEL);
663 if (!substream)
664 return -ENOMEM;
665 substream->pcm = pcm;
666 substream->pstr = pstr;
667 substream->number = idx;
668 substream->stream = stream;
669 sprintf(substream->name, "subdevice #%i", idx);
670 substream->buffer_bytes_max = UINT_MAX;
671 if (prev == NULL)
672 pstr->substream = substream;
673 else
674 prev->next = substream;
675
676 if (!pcm->internal) {
677 err = snd_pcm_substream_proc_init(substream);
678 if (err < 0) {
679 pcm_err(pcm,
680 "Error in snd_pcm_stream_proc_init\n");
681 if (prev == NULL)
682 pstr->substream = NULL;
683 else
684 prev->next = NULL;
685 kfree(substream);
686 return err;
687 }
688 }
689 substream->group = &substream->self_group;
690 snd_pcm_group_init(&substream->self_group);
691 list_add_tail(&substream->link_list, &substream->self_group.substreams);
692 atomic_set(&substream->mmap_count, 0);
693 prev = substream;
694 }
695 return 0;
696}
697EXPORT_SYMBOL(snd_pcm_new_stream);
698
699static int _snd_pcm_new(struct snd_card *card, const char *id, int device,
700 int playback_count, int capture_count, bool internal,
701 struct snd_pcm **rpcm)
702{
703 struct snd_pcm *pcm;
704 int err;
705 static const struct snd_device_ops ops = {
706 .dev_free = snd_pcm_dev_free,
707 .dev_register = snd_pcm_dev_register,
708 .dev_disconnect = snd_pcm_dev_disconnect,
709 };
710 static const struct snd_device_ops internal_ops = {
711 .dev_free = snd_pcm_dev_free,
712 };
713
714 if (snd_BUG_ON(!card))
715 return -ENXIO;
716 if (rpcm)
717 *rpcm = NULL;
718 pcm = kzalloc(sizeof(*pcm), GFP_KERNEL);
719 if (!pcm)
720 return -ENOMEM;
721 pcm->card = card;
722 pcm->device = device;
723 pcm->internal = internal;
724 mutex_init(&pcm->open_mutex);
725 init_waitqueue_head(&pcm->open_wait);
726 INIT_LIST_HEAD(&pcm->list);
727 if (id)
728 strscpy(pcm->id, id, sizeof(pcm->id));
729
730 err = snd_pcm_new_stream(pcm, SNDRV_PCM_STREAM_PLAYBACK,
731 playback_count);
732 if (err < 0)
733 goto free_pcm;
734
735 err = snd_pcm_new_stream(pcm, SNDRV_PCM_STREAM_CAPTURE, capture_count);
736 if (err < 0)
737 goto free_pcm;
738
739 err = snd_device_new(card, SNDRV_DEV_PCM, pcm,
740 internal ? &internal_ops : &ops);
741 if (err < 0)
742 goto free_pcm;
743
744 if (rpcm)
745 *rpcm = pcm;
746 return 0;
747
748free_pcm:
749 snd_pcm_free(pcm);
750 return err;
751}
752
753/**
754 * snd_pcm_new - create a new PCM instance
755 * @card: the card instance
756 * @id: the id string
757 * @device: the device index (zero based)
758 * @playback_count: the number of substreams for playback
759 * @capture_count: the number of substreams for capture
760 * @rpcm: the pointer to store the new pcm instance
761 *
762 * Creates a new PCM instance.
763 *
764 * The pcm operators have to be set afterwards to the new instance
765 * via snd_pcm_set_ops().
766 *
767 * Return: Zero if successful, or a negative error code on failure.
768 */
769int snd_pcm_new(struct snd_card *card, const char *id, int device,
770 int playback_count, int capture_count, struct snd_pcm **rpcm)
771{
772 return _snd_pcm_new(card, id, device, playback_count, capture_count,
773 false, rpcm);
774}
775EXPORT_SYMBOL(snd_pcm_new);
776
777/**
778 * snd_pcm_new_internal - create a new internal PCM instance
779 * @card: the card instance
780 * @id: the id string
781 * @device: the device index (zero based - shared with normal PCMs)
782 * @playback_count: the number of substreams for playback
783 * @capture_count: the number of substreams for capture
784 * @rpcm: the pointer to store the new pcm instance
785 *
786 * Creates a new internal PCM instance with no userspace device or procfs
787 * entries. This is used by ASoC Back End PCMs in order to create a PCM that
788 * will only be used internally by kernel drivers. i.e. it cannot be opened
789 * by userspace. It provides existing ASoC components drivers with a substream
790 * and access to any private data.
791 *
792 * The pcm operators have to be set afterwards to the new instance
793 * via snd_pcm_set_ops().
794 *
795 * Return: Zero if successful, or a negative error code on failure.
796 */
797int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
798 int playback_count, int capture_count,
799 struct snd_pcm **rpcm)
800{
801 return _snd_pcm_new(card, id, device, playback_count, capture_count,
802 true, rpcm);
803}
804EXPORT_SYMBOL(snd_pcm_new_internal);
805
806static void free_chmap(struct snd_pcm_str *pstr)
807{
808 if (pstr->chmap_kctl) {
809 struct snd_card *card = pstr->pcm->card;
810
811 snd_ctl_remove(card, pstr->chmap_kctl);
812 pstr->chmap_kctl = NULL;
813 }
814}
815
816static void snd_pcm_free_stream(struct snd_pcm_str * pstr)
817{
818 struct snd_pcm_substream *substream, *substream_next;
819#if IS_ENABLED(CONFIG_SND_PCM_OSS)
820 struct snd_pcm_oss_setup *setup, *setupn;
821#endif
822
823 /* free all proc files under the stream */
824 snd_pcm_stream_proc_done(pstr);
825
826 substream = pstr->substream;
827 while (substream) {
828 substream_next = substream->next;
829 snd_pcm_timer_done(substream);
830 kfree(substream);
831 substream = substream_next;
832 }
833#if IS_ENABLED(CONFIG_SND_PCM_OSS)
834 for (setup = pstr->oss.setup_list; setup; setup = setupn) {
835 setupn = setup->next;
836 kfree(setup->task_name);
837 kfree(setup);
838 }
839#endif
840 free_chmap(pstr);
841 if (pstr->substream_count)
842 put_device(pstr->dev);
843}
844
845#if IS_ENABLED(CONFIG_SND_PCM_OSS)
846#define pcm_call_notify(pcm, call) \
847 do { \
848 struct snd_pcm_notify *_notify; \
849 list_for_each_entry(_notify, &snd_pcm_notify_list, list) \
850 _notify->call(pcm); \
851 } while (0)
852#else
853#define pcm_call_notify(pcm, call) do {} while (0)
854#endif
855
856static int snd_pcm_free(struct snd_pcm *pcm)
857{
858 if (!pcm)
859 return 0;
860 if (!pcm->internal)
861 pcm_call_notify(pcm, n_unregister);
862 if (pcm->private_free)
863 pcm->private_free(pcm);
864 snd_pcm_lib_preallocate_free_for_all(pcm);
865 snd_pcm_free_stream(&pcm->streams[SNDRV_PCM_STREAM_PLAYBACK]);
866 snd_pcm_free_stream(&pcm->streams[SNDRV_PCM_STREAM_CAPTURE]);
867 kfree(pcm);
868 return 0;
869}
870
871static int snd_pcm_dev_free(struct snd_device *device)
872{
873 struct snd_pcm *pcm = device->device_data;
874 return snd_pcm_free(pcm);
875}
876
877int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream,
878 struct file *file,
879 struct snd_pcm_substream **rsubstream)
880{
881 struct snd_pcm_str * pstr;
882 struct snd_pcm_substream *substream;
883 struct snd_pcm_runtime *runtime;
884 struct snd_card *card;
885 int prefer_subdevice;
886 size_t size;
887
888 if (snd_BUG_ON(!pcm || !rsubstream))
889 return -ENXIO;
890 if (snd_BUG_ON(stream != SNDRV_PCM_STREAM_PLAYBACK &&
891 stream != SNDRV_PCM_STREAM_CAPTURE))
892 return -EINVAL;
893 *rsubstream = NULL;
894 pstr = &pcm->streams[stream];
895 if (pstr->substream == NULL || pstr->substream_count == 0)
896 return -ENODEV;
897
898 card = pcm->card;
899 prefer_subdevice = snd_ctl_get_preferred_subdevice(card, SND_CTL_SUBDEV_PCM);
900
901 if (pcm->info_flags & SNDRV_PCM_INFO_HALF_DUPLEX) {
902 int opposite = !stream;
903
904 for (substream = pcm->streams[opposite].substream; substream;
905 substream = substream->next) {
906 if (SUBSTREAM_BUSY(substream))
907 return -EAGAIN;
908 }
909 }
910
911 if (file->f_flags & O_APPEND) {
912 if (prefer_subdevice < 0) {
913 if (pstr->substream_count > 1)
914 return -EINVAL; /* must be unique */
915 substream = pstr->substream;
916 } else {
917 for (substream = pstr->substream; substream;
918 substream = substream->next)
919 if (substream->number == prefer_subdevice)
920 break;
921 }
922 if (! substream)
923 return -ENODEV;
924 if (! SUBSTREAM_BUSY(substream))
925 return -EBADFD;
926 substream->ref_count++;
927 *rsubstream = substream;
928 return 0;
929 }
930
931 for (substream = pstr->substream; substream; substream = substream->next) {
932 if (!SUBSTREAM_BUSY(substream) &&
933 (prefer_subdevice == -1 ||
934 substream->number == prefer_subdevice))
935 break;
936 }
937 if (substream == NULL)
938 return -EAGAIN;
939
940 runtime = kzalloc(sizeof(*runtime), GFP_KERNEL);
941 if (runtime == NULL)
942 return -ENOMEM;
943
944 size = PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status));
945 runtime->status = alloc_pages_exact(size, GFP_KERNEL);
946 if (runtime->status == NULL) {
947 kfree(runtime);
948 return -ENOMEM;
949 }
950 memset(runtime->status, 0, size);
951
952 size = PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control));
953 runtime->control = alloc_pages_exact(size, GFP_KERNEL);
954 if (runtime->control == NULL) {
955 free_pages_exact(runtime->status,
956 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)));
957 kfree(runtime);
958 return -ENOMEM;
959 }
960 memset(runtime->control, 0, size);
961
962 init_waitqueue_head(&runtime->sleep);
963 init_waitqueue_head(&runtime->tsleep);
964
965 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_OPEN);
966 mutex_init(&runtime->buffer_mutex);
967 atomic_set(&runtime->buffer_accessing, 0);
968
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;
976#ifdef CONFIG_SND_PCM_XRUN_DEBUG
977 substream->xrun_counter = 0;
978#endif /* CONFIG_SND_PCM_XRUN_DEBUG */
979 return 0;
980}
981
982void snd_pcm_detach_substream(struct snd_pcm_substream *substream)
983{
984 struct snd_pcm_runtime *runtime;
985
986 if (PCM_RUNTIME_CHECK(substream))
987 return;
988 runtime = substream->runtime;
989 if (runtime->private_free != NULL)
990 runtime->private_free(runtime);
991 free_pages_exact(runtime->status,
992 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)));
993 free_pages_exact(runtime->control,
994 PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)));
995 kfree(runtime->hw_constraints.rules);
996 /* Avoid concurrent access to runtime via PCM timer interface */
997 if (substream->timer) {
998 scoped_guard(spinlock_irq, &substream->timer->lock)
999 substream->runtime = NULL;
1000 } else {
1001 substream->runtime = NULL;
1002 }
1003 mutex_destroy(&runtime->buffer_mutex);
1004 snd_fasync_free(runtime->fasync);
1005 kfree(runtime);
1006 put_pid(substream->pid);
1007 substream->pid = NULL;
1008 substream->pstr->substream_opened--;
1009}
1010
1011static ssize_t pcm_class_show(struct device *dev,
1012 struct device_attribute *attr, char *buf)
1013{
1014 struct snd_pcm_str *pstr = dev_get_drvdata(dev);
1015 struct snd_pcm *pcm = pstr->pcm;
1016 const char *str;
1017 static const char *strs[SNDRV_PCM_CLASS_LAST + 1] = {
1018 [SNDRV_PCM_CLASS_GENERIC] = "generic",
1019 [SNDRV_PCM_CLASS_MULTI] = "multi",
1020 [SNDRV_PCM_CLASS_MODEM] = "modem",
1021 [SNDRV_PCM_CLASS_DIGITIZER] = "digitizer",
1022 };
1023
1024 if (pcm->dev_class > SNDRV_PCM_CLASS_LAST)
1025 str = "none";
1026 else
1027 str = strs[pcm->dev_class];
1028 return sysfs_emit(buf, "%s\n", str);
1029}
1030
1031static DEVICE_ATTR_RO(pcm_class);
1032static struct attribute *pcm_dev_attrs[] = {
1033 &dev_attr_pcm_class.attr,
1034 NULL
1035};
1036
1037static const struct attribute_group pcm_dev_attr_group = {
1038 .attrs = pcm_dev_attrs,
1039};
1040
1041static const struct attribute_group *pcm_dev_attr_groups[] = {
1042 &pcm_dev_attr_group,
1043 NULL
1044};
1045
1046static int snd_pcm_dev_register(struct snd_device *device)
1047{
1048 int cidx, err;
1049 struct snd_pcm_substream *substream;
1050 struct snd_pcm *pcm;
1051
1052 if (snd_BUG_ON(!device || !device->device_data))
1053 return -ENXIO;
1054 pcm = device->device_data;
1055
1056 guard(mutex)(®ister_mutex);
1057 err = snd_pcm_add(pcm);
1058 if (err)
1059 return err;
1060 for (cidx = 0; cidx < 2; cidx++) {
1061 int devtype = -1;
1062 if (pcm->streams[cidx].substream == NULL)
1063 continue;
1064 switch (cidx) {
1065 case SNDRV_PCM_STREAM_PLAYBACK:
1066 devtype = SNDRV_DEVICE_TYPE_PCM_PLAYBACK;
1067 break;
1068 case SNDRV_PCM_STREAM_CAPTURE:
1069 devtype = SNDRV_DEVICE_TYPE_PCM_CAPTURE;
1070 break;
1071 }
1072 /* register pcm */
1073 err = snd_register_device(devtype, pcm->card, pcm->device,
1074 &snd_pcm_f_ops[cidx], pcm,
1075 pcm->streams[cidx].dev);
1076 if (err < 0) {
1077 list_del_init(&pcm->list);
1078 return err;
1079 }
1080
1081 for (substream = pcm->streams[cidx].substream; substream; substream = substream->next)
1082 snd_pcm_timer_init(substream);
1083 }
1084
1085 pcm_call_notify(pcm, n_register);
1086 return err;
1087}
1088
1089static int snd_pcm_dev_disconnect(struct snd_device *device)
1090{
1091 struct snd_pcm *pcm = device->device_data;
1092 struct snd_pcm_substream *substream;
1093 int cidx;
1094
1095 guard(mutex)(®ister_mutex);
1096 guard(mutex)(&pcm->open_mutex);
1097 wake_up(&pcm->open_wait);
1098 list_del_init(&pcm->list);
1099
1100 for_each_pcm_substream(pcm, cidx, substream) {
1101 snd_pcm_stream_lock_irq(substream);
1102 if (substream->runtime) {
1103 if (snd_pcm_running(substream))
1104 snd_pcm_stop(substream, SNDRV_PCM_STATE_DISCONNECTED);
1105 /* to be sure, set the state unconditionally */
1106 __snd_pcm_set_state(substream->runtime,
1107 SNDRV_PCM_STATE_DISCONNECTED);
1108 wake_up(&substream->runtime->sleep);
1109 wake_up(&substream->runtime->tsleep);
1110 }
1111 snd_pcm_stream_unlock_irq(substream);
1112 }
1113
1114 for_each_pcm_substream(pcm, cidx, substream)
1115 snd_pcm_sync_stop(substream, false);
1116
1117 pcm_call_notify(pcm, n_disconnect);
1118 for (cidx = 0; cidx < 2; cidx++) {
1119 if (pcm->streams[cidx].dev)
1120 snd_unregister_device(pcm->streams[cidx].dev);
1121 free_chmap(&pcm->streams[cidx]);
1122 }
1123 return 0;
1124}
1125
1126#if IS_ENABLED(CONFIG_SND_PCM_OSS)
1127/**
1128 * snd_pcm_notify - Add/remove the notify list
1129 * @notify: PCM notify list
1130 * @nfree: 0 = register, 1 = unregister
1131 *
1132 * This adds the given notifier to the global list so that the callback is
1133 * called for each registered PCM devices. This exists only for PCM OSS
1134 * emulation, so far.
1135 *
1136 * Return: zero if successful, or a negative error code
1137 */
1138int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree)
1139{
1140 struct snd_pcm *pcm;
1141
1142 if (snd_BUG_ON(!notify ||
1143 !notify->n_register ||
1144 !notify->n_unregister ||
1145 !notify->n_disconnect))
1146 return -EINVAL;
1147 guard(mutex)(®ister_mutex);
1148 if (nfree) {
1149 list_del(¬ify->list);
1150 list_for_each_entry(pcm, &snd_pcm_devices, list)
1151 notify->n_unregister(pcm);
1152 } else {
1153 list_add_tail(¬ify->list, &snd_pcm_notify_list);
1154 list_for_each_entry(pcm, &snd_pcm_devices, list)
1155 notify->n_register(pcm);
1156 }
1157 return 0;
1158}
1159EXPORT_SYMBOL(snd_pcm_notify);
1160#endif /* CONFIG_SND_PCM_OSS */
1161
1162#ifdef CONFIG_SND_PROC_FS
1163/*
1164 * Info interface
1165 */
1166
1167static void snd_pcm_proc_read(struct snd_info_entry *entry,
1168 struct snd_info_buffer *buffer)
1169{
1170 struct snd_pcm *pcm;
1171
1172 guard(mutex)(®ister_mutex);
1173 list_for_each_entry(pcm, &snd_pcm_devices, list) {
1174 snd_iprintf(buffer, "%02i-%02i: %s : %s",
1175 pcm->card->number, pcm->device, pcm->id, pcm->name);
1176 if (pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream)
1177 snd_iprintf(buffer, " : playback %i",
1178 pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream_count);
1179 if (pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream)
1180 snd_iprintf(buffer, " : capture %i",
1181 pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream_count);
1182 snd_iprintf(buffer, "\n");
1183 }
1184}
1185
1186static struct snd_info_entry *snd_pcm_proc_entry;
1187
1188static void snd_pcm_proc_init(void)
1189{
1190 struct snd_info_entry *entry;
1191
1192 entry = snd_info_create_module_entry(THIS_MODULE, "pcm", NULL);
1193 if (entry) {
1194 snd_info_set_text_ops(entry, NULL, snd_pcm_proc_read);
1195 if (snd_info_register(entry) < 0) {
1196 snd_info_free_entry(entry);
1197 entry = NULL;
1198 }
1199 }
1200 snd_pcm_proc_entry = entry;
1201}
1202
1203static void snd_pcm_proc_done(void)
1204{
1205 snd_info_free_entry(snd_pcm_proc_entry);
1206}
1207
1208#else /* !CONFIG_SND_PROC_FS */
1209#define snd_pcm_proc_init()
1210#define snd_pcm_proc_done()
1211#endif /* CONFIG_SND_PROC_FS */
1212
1213
1214/*
1215 * ENTRY functions
1216 */
1217
1218static int __init alsa_pcm_init(void)
1219{
1220 snd_ctl_register_ioctl(snd_pcm_control_ioctl);
1221 snd_ctl_register_ioctl_compat(snd_pcm_control_ioctl);
1222 snd_pcm_proc_init();
1223 return 0;
1224}
1225
1226static void __exit alsa_pcm_exit(void)
1227{
1228 snd_ctl_unregister_ioctl(snd_pcm_control_ioctl);
1229 snd_ctl_unregister_ioctl_compat(snd_pcm_control_ioctl);
1230 snd_pcm_proc_done();
1231}
1232
1233module_init(alsa_pcm_init)
1234module_exit(alsa_pcm_exit)