pcm.c revision e88e8ae639a4908b903d9406c54e99a729b01a28
1/*
2 *  Digital Audio (PCM) abstract layer
3 *  Copyright (c) by Jaroslav Kysela <perex@suse.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 <sound/driver.h>
23#include <linux/init.h>
24#include <linux/slab.h>
25#include <linux/time.h>
26#include <linux/mutex.h>
27#include <sound/core.h>
28#include <sound/minors.h>
29#include <sound/pcm.h>
30#include <sound/control.h>
31#include <sound/info.h>
32
33MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>, Abramo Bagnara <abramo@alsa-project.org>");
34MODULE_DESCRIPTION("Midlevel PCM code for ALSA.");
35MODULE_LICENSE("GPL");
36
37static LIST_HEAD(snd_pcm_devices);
38static LIST_HEAD(snd_pcm_notify_list);
39static DEFINE_MUTEX(register_mutex);
40
41static int snd_pcm_free(struct snd_pcm *pcm);
42static int snd_pcm_dev_free(struct snd_device *device);
43static int snd_pcm_dev_register(struct snd_device *device);
44static int snd_pcm_dev_disconnect(struct snd_device *device);
45static int snd_pcm_dev_unregister(struct snd_device *device);
46
47static struct snd_pcm *snd_pcm_search(struct snd_card *card, int device)
48{
49	struct list_head *p;
50	struct snd_pcm *pcm;
51
52	list_for_each(p, &snd_pcm_devices) {
53		pcm = list_entry(p, struct snd_pcm, list);
54		if (pcm->card == card && pcm->device == device)
55			return pcm;
56	}
57	return NULL;
58}
59
60static int snd_pcm_control_ioctl(struct snd_card *card,
61				 struct snd_ctl_file *control,
62				 unsigned int cmd, unsigned long arg)
63{
64	switch (cmd) {
65	case SNDRV_CTL_IOCTL_PCM_NEXT_DEVICE:
66		{
67			int device;
68
69			if (get_user(device, (int __user *)arg))
70				return -EFAULT;
71			mutex_lock(&register_mutex);
72			device = device < 0 ? 0 : device + 1;
73			while (device < SNDRV_PCM_DEVICES) {
74				if (snd_pcm_search(card, device))
75					break;
76				device++;
77			}
78			if (device == SNDRV_PCM_DEVICES)
79				device = -1;
80			mutex_unlock(&register_mutex);
81			if (put_user(device, (int __user *)arg))
82				return -EFAULT;
83			return 0;
84		}
85	case SNDRV_CTL_IOCTL_PCM_INFO:
86		{
87			struct snd_pcm_info __user *info;
88			unsigned int device, subdevice;
89			int stream;
90			struct snd_pcm *pcm;
91			struct snd_pcm_str *pstr;
92			struct snd_pcm_substream *substream;
93			int err;
94
95			info = (struct snd_pcm_info __user *)arg;
96			if (get_user(device, &info->device))
97				return -EFAULT;
98			if (get_user(stream, &info->stream))
99				return -EFAULT;
100			if (stream < 0 || stream > 1)
101				return -EINVAL;
102			if (get_user(subdevice, &info->subdevice))
103				return -EFAULT;
104			mutex_lock(&register_mutex);
105			pcm = snd_pcm_search(card, device);
106			if (pcm == NULL) {
107				err = -ENXIO;
108				goto _error;
109			}
110			pstr = &pcm->streams[stream];
111			if (pstr->substream_count == 0) {
112				err = -ENOENT;
113				goto _error;
114			}
115			if (subdevice >= pstr->substream_count) {
116				err = -ENXIO;
117				goto _error;
118			}
119			for (substream = pstr->substream; substream;
120			     substream = substream->next)
121				if (substream->number == (int)subdevice)
122					break;
123			if (substream == NULL) {
124				err = -ENXIO;
125				goto _error;
126			}
127			err = snd_pcm_info_user(substream, info);
128		_error:
129			mutex_unlock(&register_mutex);
130			return err;
131		}
132	case SNDRV_CTL_IOCTL_PCM_PREFER_SUBDEVICE:
133		{
134			int val;
135
136			if (get_user(val, (int __user *)arg))
137				return -EFAULT;
138			control->prefer_pcm_subdevice = val;
139			return 0;
140		}
141	}
142	return -ENOIOCTLCMD;
143}
144
145#ifdef CONFIG_SND_VERBOSE_PROCFS
146
147#define STATE(v) [SNDRV_PCM_STATE_##v] = #v
148#define STREAM(v) [SNDRV_PCM_STREAM_##v] = #v
149#define READY(v) [SNDRV_PCM_READY_##v] = #v
150#define XRUN(v) [SNDRV_PCM_XRUN_##v] = #v
151#define SILENCE(v) [SNDRV_PCM_SILENCE_##v] = #v
152#define TSTAMP(v) [SNDRV_PCM_TSTAMP_##v] = #v
153#define ACCESS(v) [SNDRV_PCM_ACCESS_##v] = #v
154#define START(v) [SNDRV_PCM_START_##v] = #v
155#define FORMAT(v) [SNDRV_PCM_FORMAT_##v] = #v
156#define SUBFORMAT(v) [SNDRV_PCM_SUBFORMAT_##v] = #v
157
158static char *snd_pcm_format_names[] = {
159	FORMAT(S8),
160	FORMAT(U8),
161	FORMAT(S16_LE),
162	FORMAT(S16_BE),
163	FORMAT(U16_LE),
164	FORMAT(U16_BE),
165	FORMAT(S24_LE),
166	FORMAT(S24_BE),
167	FORMAT(U24_LE),
168	FORMAT(U24_BE),
169	FORMAT(S32_LE),
170	FORMAT(S32_BE),
171	FORMAT(U32_LE),
172	FORMAT(U32_BE),
173	FORMAT(FLOAT_LE),
174	FORMAT(FLOAT_BE),
175	FORMAT(FLOAT64_LE),
176	FORMAT(FLOAT64_BE),
177	FORMAT(IEC958_SUBFRAME_LE),
178	FORMAT(IEC958_SUBFRAME_BE),
179	FORMAT(MU_LAW),
180	FORMAT(A_LAW),
181	FORMAT(IMA_ADPCM),
182	FORMAT(MPEG),
183	FORMAT(GSM),
184	FORMAT(SPECIAL),
185	FORMAT(S24_3LE),
186	FORMAT(S24_3BE),
187	FORMAT(U24_3LE),
188	FORMAT(U24_3BE),
189	FORMAT(S20_3LE),
190	FORMAT(S20_3BE),
191	FORMAT(U20_3LE),
192	FORMAT(U20_3BE),
193	FORMAT(S18_3LE),
194	FORMAT(S18_3BE),
195	FORMAT(U18_3LE),
196	FORMAT(U18_3BE),
197};
198
199static const char *snd_pcm_format_name(snd_pcm_format_t format)
200{
201	return snd_pcm_format_names[format];
202}
203
204static char *snd_pcm_stream_names[] = {
205	STREAM(PLAYBACK),
206	STREAM(CAPTURE),
207};
208
209static char *snd_pcm_state_names[] = {
210	STATE(OPEN),
211	STATE(SETUP),
212	STATE(PREPARED),
213	STATE(RUNNING),
214	STATE(XRUN),
215	STATE(DRAINING),
216	STATE(PAUSED),
217	STATE(SUSPENDED),
218};
219
220static char *snd_pcm_access_names[] = {
221	ACCESS(MMAP_INTERLEAVED),
222	ACCESS(MMAP_NONINTERLEAVED),
223	ACCESS(MMAP_COMPLEX),
224	ACCESS(RW_INTERLEAVED),
225	ACCESS(RW_NONINTERLEAVED),
226};
227
228static char *snd_pcm_subformat_names[] = {
229	SUBFORMAT(STD),
230};
231
232static char *snd_pcm_tstamp_mode_names[] = {
233	TSTAMP(NONE),
234	TSTAMP(MMAP),
235};
236
237static const char *snd_pcm_stream_name(int stream)
238{
239	snd_assert(stream <= SNDRV_PCM_STREAM_LAST, return NULL);
240	return snd_pcm_stream_names[stream];
241}
242
243static const char *snd_pcm_access_name(snd_pcm_access_t access)
244{
245	return snd_pcm_access_names[access];
246}
247
248static const char *snd_pcm_subformat_name(snd_pcm_subformat_t subformat)
249{
250	return snd_pcm_subformat_names[subformat];
251}
252
253static const char *snd_pcm_tstamp_mode_name(int mode)
254{
255	snd_assert(mode <= SNDRV_PCM_TSTAMP_LAST, return NULL);
256	return snd_pcm_tstamp_mode_names[mode];
257}
258
259static const char *snd_pcm_state_name(snd_pcm_state_t state)
260{
261	return snd_pcm_state_names[state];
262}
263
264#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
265#include <linux/soundcard.h>
266
267static const char *snd_pcm_oss_format_name(int format)
268{
269	switch (format) {
270	case AFMT_MU_LAW:
271		return "MU_LAW";
272	case AFMT_A_LAW:
273		return "A_LAW";
274	case AFMT_IMA_ADPCM:
275		return "IMA_ADPCM";
276	case AFMT_U8:
277		return "U8";
278	case AFMT_S16_LE:
279		return "S16_LE";
280	case AFMT_S16_BE:
281		return "S16_BE";
282	case AFMT_S8:
283		return "S8";
284	case AFMT_U16_LE:
285		return "U16_LE";
286	case AFMT_U16_BE:
287		return "U16_BE";
288	case AFMT_MPEG:
289		return "MPEG";
290	default:
291		return "unknown";
292	}
293}
294#endif
295
296static void snd_pcm_proc_info_read(struct snd_pcm_substream *substream,
297				   struct snd_info_buffer *buffer)
298{
299	struct snd_pcm_info *info;
300	int err;
301
302	if (! substream)
303		return;
304
305	info = kmalloc(sizeof(*info), GFP_KERNEL);
306	if (! info) {
307		printk(KERN_DEBUG "snd_pcm_proc_info_read: cannot malloc\n");
308		return;
309	}
310
311	err = snd_pcm_info(substream, info);
312	if (err < 0) {
313		snd_iprintf(buffer, "error %d\n", err);
314		kfree(info);
315		return;
316	}
317	snd_iprintf(buffer, "card: %d\n", info->card);
318	snd_iprintf(buffer, "device: %d\n", info->device);
319	snd_iprintf(buffer, "subdevice: %d\n", info->subdevice);
320	snd_iprintf(buffer, "stream: %s\n", snd_pcm_stream_name(info->stream));
321	snd_iprintf(buffer, "id: %s\n", info->id);
322	snd_iprintf(buffer, "name: %s\n", info->name);
323	snd_iprintf(buffer, "subname: %s\n", info->subname);
324	snd_iprintf(buffer, "class: %d\n", info->dev_class);
325	snd_iprintf(buffer, "subclass: %d\n", info->dev_subclass);
326	snd_iprintf(buffer, "subdevices_count: %d\n", info->subdevices_count);
327	snd_iprintf(buffer, "subdevices_avail: %d\n", info->subdevices_avail);
328	kfree(info);
329}
330
331static void snd_pcm_stream_proc_info_read(struct snd_info_entry *entry,
332					  struct snd_info_buffer *buffer)
333{
334	snd_pcm_proc_info_read(((struct snd_pcm_str *)entry->private_data)->substream,
335			       buffer);
336}
337
338static void snd_pcm_substream_proc_info_read(struct snd_info_entry *entry,
339					     struct snd_info_buffer *buffer)
340{
341	snd_pcm_proc_info_read((struct snd_pcm_substream *)entry->private_data,
342			       buffer);
343}
344
345static void snd_pcm_substream_proc_hw_params_read(struct snd_info_entry *entry,
346						  struct snd_info_buffer *buffer)
347{
348	struct snd_pcm_substream *substream = entry->private_data;
349	struct snd_pcm_runtime *runtime = substream->runtime;
350	if (!runtime) {
351		snd_iprintf(buffer, "closed\n");
352		return;
353	}
354	snd_pcm_stream_lock_irq(substream);
355	if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
356		snd_iprintf(buffer, "no setup\n");
357		snd_pcm_stream_unlock_irq(substream);
358		return;
359	}
360	snd_iprintf(buffer, "access: %s\n", snd_pcm_access_name(runtime->access));
361	snd_iprintf(buffer, "format: %s\n", snd_pcm_format_name(runtime->format));
362	snd_iprintf(buffer, "subformat: %s\n", snd_pcm_subformat_name(runtime->subformat));
363	snd_iprintf(buffer, "channels: %u\n", runtime->channels);
364	snd_iprintf(buffer, "rate: %u (%u/%u)\n", runtime->rate, runtime->rate_num, runtime->rate_den);
365	snd_iprintf(buffer, "period_size: %lu\n", runtime->period_size);
366	snd_iprintf(buffer, "buffer_size: %lu\n", runtime->buffer_size);
367	snd_iprintf(buffer, "tick_time: %u\n", runtime->tick_time);
368#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
369	if (substream->oss.oss) {
370		snd_iprintf(buffer, "OSS format: %s\n", snd_pcm_oss_format_name(runtime->oss.format));
371		snd_iprintf(buffer, "OSS channels: %u\n", runtime->oss.channels);
372		snd_iprintf(buffer, "OSS rate: %u\n", runtime->oss.rate);
373		snd_iprintf(buffer, "OSS period bytes: %lu\n", (unsigned long)runtime->oss.period_bytes);
374		snd_iprintf(buffer, "OSS periods: %u\n", runtime->oss.periods);
375		snd_iprintf(buffer, "OSS period frames: %lu\n", (unsigned long)runtime->oss.period_frames);
376	}
377#endif
378	snd_pcm_stream_unlock_irq(substream);
379}
380
381static void snd_pcm_substream_proc_sw_params_read(struct snd_info_entry *entry,
382						  struct snd_info_buffer *buffer)
383{
384	struct snd_pcm_substream *substream = entry->private_data;
385	struct snd_pcm_runtime *runtime = substream->runtime;
386	if (!runtime) {
387		snd_iprintf(buffer, "closed\n");
388		return;
389	}
390	snd_pcm_stream_lock_irq(substream);
391	if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
392		snd_iprintf(buffer, "no setup\n");
393		snd_pcm_stream_unlock_irq(substream);
394		return;
395	}
396	snd_iprintf(buffer, "tstamp_mode: %s\n", snd_pcm_tstamp_mode_name(runtime->tstamp_mode));
397	snd_iprintf(buffer, "period_step: %u\n", runtime->period_step);
398	snd_iprintf(buffer, "sleep_min: %u\n", runtime->sleep_min);
399	snd_iprintf(buffer, "avail_min: %lu\n", runtime->control->avail_min);
400	snd_iprintf(buffer, "xfer_align: %lu\n", runtime->xfer_align);
401	snd_iprintf(buffer, "start_threshold: %lu\n", runtime->start_threshold);
402	snd_iprintf(buffer, "stop_threshold: %lu\n", runtime->stop_threshold);
403	snd_iprintf(buffer, "silence_threshold: %lu\n", runtime->silence_threshold);
404	snd_iprintf(buffer, "silence_size: %lu\n", runtime->silence_size);
405	snd_iprintf(buffer, "boundary: %lu\n", runtime->boundary);
406	snd_pcm_stream_unlock_irq(substream);
407}
408
409static void snd_pcm_substream_proc_status_read(struct snd_info_entry *entry,
410					       struct snd_info_buffer *buffer)
411{
412	struct snd_pcm_substream *substream = entry->private_data;
413	struct snd_pcm_runtime *runtime = substream->runtime;
414	struct snd_pcm_status status;
415	int err;
416	if (!runtime) {
417		snd_iprintf(buffer, "closed\n");
418		return;
419	}
420	memset(&status, 0, sizeof(status));
421	err = snd_pcm_status(substream, &status);
422	if (err < 0) {
423		snd_iprintf(buffer, "error %d\n", err);
424		return;
425	}
426	snd_iprintf(buffer, "state: %s\n", snd_pcm_state_name(status.state));
427	snd_iprintf(buffer, "trigger_time: %ld.%09ld\n",
428		status.trigger_tstamp.tv_sec, status.trigger_tstamp.tv_nsec);
429	snd_iprintf(buffer, "tstamp      : %ld.%09ld\n",
430		status.tstamp.tv_sec, status.tstamp.tv_nsec);
431	snd_iprintf(buffer, "delay       : %ld\n", status.delay);
432	snd_iprintf(buffer, "avail       : %ld\n", status.avail);
433	snd_iprintf(buffer, "avail_max   : %ld\n", status.avail_max);
434	snd_iprintf(buffer, "-----\n");
435	snd_iprintf(buffer, "hw_ptr      : %ld\n", runtime->status->hw_ptr);
436	snd_iprintf(buffer, "appl_ptr    : %ld\n", runtime->control->appl_ptr);
437}
438
439#ifdef CONFIG_SND_PCM_XRUN_DEBUG
440static void snd_pcm_xrun_debug_read(struct snd_info_entry *entry,
441				    struct snd_info_buffer *buffer)
442{
443	struct snd_pcm_str *pstr = entry->private_data;
444	snd_iprintf(buffer, "%d\n", pstr->xrun_debug);
445}
446
447static void snd_pcm_xrun_debug_write(struct snd_info_entry *entry,
448				     struct snd_info_buffer *buffer)
449{
450	struct snd_pcm_str *pstr = entry->private_data;
451	char line[64];
452	if (!snd_info_get_line(buffer, line, sizeof(line)))
453		pstr->xrun_debug = simple_strtoul(line, NULL, 10);
454}
455#endif
456
457static int snd_pcm_stream_proc_init(struct snd_pcm_str *pstr)
458{
459	struct snd_pcm *pcm = pstr->pcm;
460	struct snd_info_entry *entry;
461	char name[16];
462
463	sprintf(name, "pcm%i%c", pcm->device,
464		pstr->stream == SNDRV_PCM_STREAM_PLAYBACK ? 'p' : 'c');
465	if ((entry = snd_info_create_card_entry(pcm->card, name, pcm->card->proc_root)) == NULL)
466		return -ENOMEM;
467	entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
468	if (snd_info_register(entry) < 0) {
469		snd_info_free_entry(entry);
470		return -ENOMEM;
471	}
472	pstr->proc_root = entry;
473
474	if ((entry = snd_info_create_card_entry(pcm->card, "info", pstr->proc_root)) != NULL) {
475		snd_info_set_text_ops(entry, pstr, 256, snd_pcm_stream_proc_info_read);
476		if (snd_info_register(entry) < 0) {
477			snd_info_free_entry(entry);
478			entry = NULL;
479		}
480	}
481	pstr->proc_info_entry = entry;
482
483#ifdef CONFIG_SND_PCM_XRUN_DEBUG
484	if ((entry = snd_info_create_card_entry(pcm->card, "xrun_debug",
485						pstr->proc_root)) != NULL) {
486		entry->c.text.read_size = 64;
487		entry->c.text.read = snd_pcm_xrun_debug_read;
488		entry->c.text.write_size = 64;
489		entry->c.text.write = snd_pcm_xrun_debug_write;
490		entry->mode |= S_IWUSR;
491		entry->private_data = pstr;
492		if (snd_info_register(entry) < 0) {
493			snd_info_free_entry(entry);
494			entry = NULL;
495		}
496	}
497	pstr->proc_xrun_debug_entry = entry;
498#endif
499	return 0;
500}
501
502static int snd_pcm_stream_proc_done(struct snd_pcm_str *pstr)
503{
504#ifdef CONFIG_SND_PCM_XRUN_DEBUG
505	if (pstr->proc_xrun_debug_entry) {
506		snd_info_unregister(pstr->proc_xrun_debug_entry);
507		pstr->proc_xrun_debug_entry = NULL;
508	}
509#endif
510	if (pstr->proc_info_entry) {
511		snd_info_unregister(pstr->proc_info_entry);
512		pstr->proc_info_entry = NULL;
513	}
514	if (pstr->proc_root) {
515		snd_info_unregister(pstr->proc_root);
516		pstr->proc_root = NULL;
517	}
518	return 0;
519}
520
521static int snd_pcm_substream_proc_init(struct snd_pcm_substream *substream)
522{
523	struct snd_info_entry *entry;
524	struct snd_card *card;
525	char name[16];
526
527	card = substream->pcm->card;
528
529	sprintf(name, "sub%i", substream->number);
530	if ((entry = snd_info_create_card_entry(card, name, substream->pstr->proc_root)) == NULL)
531		return -ENOMEM;
532	entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
533	if (snd_info_register(entry) < 0) {
534		snd_info_free_entry(entry);
535		return -ENOMEM;
536	}
537	substream->proc_root = entry;
538
539	if ((entry = snd_info_create_card_entry(card, "info", substream->proc_root)) != NULL) {
540		snd_info_set_text_ops(entry, substream, 256, snd_pcm_substream_proc_info_read);
541		if (snd_info_register(entry) < 0) {
542			snd_info_free_entry(entry);
543			entry = NULL;
544		}
545	}
546	substream->proc_info_entry = entry;
547
548	if ((entry = snd_info_create_card_entry(card, "hw_params", substream->proc_root)) != NULL) {
549		snd_info_set_text_ops(entry, substream, 256, snd_pcm_substream_proc_hw_params_read);
550		if (snd_info_register(entry) < 0) {
551			snd_info_free_entry(entry);
552			entry = NULL;
553		}
554	}
555	substream->proc_hw_params_entry = entry;
556
557	if ((entry = snd_info_create_card_entry(card, "sw_params", substream->proc_root)) != NULL) {
558		snd_info_set_text_ops(entry, substream, 256, snd_pcm_substream_proc_sw_params_read);
559		if (snd_info_register(entry) < 0) {
560			snd_info_free_entry(entry);
561			entry = NULL;
562		}
563	}
564	substream->proc_sw_params_entry = entry;
565
566	if ((entry = snd_info_create_card_entry(card, "status", substream->proc_root)) != NULL) {
567		snd_info_set_text_ops(entry, substream, 256, snd_pcm_substream_proc_status_read);
568		if (snd_info_register(entry) < 0) {
569			snd_info_free_entry(entry);
570			entry = NULL;
571		}
572	}
573	substream->proc_status_entry = entry;
574
575	return 0;
576}
577
578static int snd_pcm_substream_proc_done(struct snd_pcm_substream *substream)
579{
580	if (substream->proc_info_entry) {
581		snd_info_unregister(substream->proc_info_entry);
582		substream->proc_info_entry = NULL;
583	}
584	if (substream->proc_hw_params_entry) {
585		snd_info_unregister(substream->proc_hw_params_entry);
586		substream->proc_hw_params_entry = NULL;
587	}
588	if (substream->proc_sw_params_entry) {
589		snd_info_unregister(substream->proc_sw_params_entry);
590		substream->proc_sw_params_entry = NULL;
591	}
592	if (substream->proc_status_entry) {
593		snd_info_unregister(substream->proc_status_entry);
594		substream->proc_status_entry = NULL;
595	}
596	if (substream->proc_root) {
597		snd_info_unregister(substream->proc_root);
598		substream->proc_root = NULL;
599	}
600	return 0;
601}
602#else /* !CONFIG_SND_VERBOSE_PROCFS */
603static inline int snd_pcm_stream_proc_init(struct snd_pcm_str *pstr) { return 0; }
604static inline int snd_pcm_stream_proc_done(struct snd_pcm_str *pstr) { return 0; }
605static inline int snd_pcm_substream_proc_init(struct snd_pcm_substream *substream) { return 0; }
606static inline int snd_pcm_substream_proc_done(struct snd_pcm_substream *substream) { return 0; }
607#endif /* CONFIG_SND_VERBOSE_PROCFS */
608
609/**
610 * snd_pcm_new_stream - create a new PCM stream
611 * @pcm: the pcm instance
612 * @stream: the stream direction, SNDRV_PCM_STREAM_XXX
613 * @substream_count: the number of substreams
614 *
615 * Creates a new stream for the pcm.
616 * The corresponding stream on the pcm must have been empty before
617 * calling this, i.e. zero must be given to the argument of
618 * snd_pcm_new().
619 *
620 * Returns zero if successful, or a negative error code on failure.
621 */
622int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count)
623{
624	int idx, err;
625	struct snd_pcm_str *pstr = &pcm->streams[stream];
626	struct snd_pcm_substream *substream, *prev;
627
628#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
629	mutex_init(&pstr->oss.setup_mutex);
630#endif
631	pstr->stream = stream;
632	pstr->pcm = pcm;
633	pstr->substream_count = substream_count;
634	if (substream_count > 0) {
635		err = snd_pcm_stream_proc_init(pstr);
636		if (err < 0) {
637			snd_printk(KERN_ERR "Error in snd_pcm_stream_proc_init\n");
638			return err;
639		}
640	}
641	prev = NULL;
642	for (idx = 0, prev = NULL; idx < substream_count; idx++) {
643		substream = kzalloc(sizeof(*substream), GFP_KERNEL);
644		if (substream == NULL) {
645			snd_printk(KERN_ERR "Cannot allocate PCM substream\n");
646			return -ENOMEM;
647		}
648		substream->pcm = pcm;
649		substream->pstr = pstr;
650		substream->number = idx;
651		substream->stream = stream;
652		sprintf(substream->name, "subdevice #%i", idx);
653		substream->buffer_bytes_max = UINT_MAX;
654		if (prev == NULL)
655			pstr->substream = substream;
656		else
657			prev->next = substream;
658		err = snd_pcm_substream_proc_init(substream);
659		if (err < 0) {
660			snd_printk(KERN_ERR "Error in snd_pcm_stream_proc_init\n");
661			kfree(substream);
662			return err;
663		}
664		substream->group = &substream->self_group;
665		spin_lock_init(&substream->self_group.lock);
666		INIT_LIST_HEAD(&substream->self_group.substreams);
667		list_add_tail(&substream->link_list, &substream->self_group.substreams);
668		spin_lock_init(&substream->timer_lock);
669		prev = substream;
670	}
671	return 0;
672}
673
674EXPORT_SYMBOL(snd_pcm_new_stream);
675
676/**
677 * snd_pcm_new - create a new PCM instance
678 * @card: the card instance
679 * @id: the id string
680 * @device: the device index (zero based)
681 * @playback_count: the number of substreams for playback
682 * @capture_count: the number of substreams for capture
683 * @rpcm: the pointer to store the new pcm instance
684 *
685 * Creates a new PCM instance.
686 *
687 * The pcm operators have to be set afterwards to the new instance
688 * via snd_pcm_set_ops().
689 *
690 * Returns zero if successful, or a negative error code on failure.
691 */
692int snd_pcm_new(struct snd_card *card, char *id, int device,
693		int playback_count, int capture_count,
694	        struct snd_pcm ** rpcm)
695{
696	struct snd_pcm *pcm;
697	int err;
698	static struct snd_device_ops ops = {
699		.dev_free = snd_pcm_dev_free,
700		.dev_register =	snd_pcm_dev_register,
701		.dev_disconnect = snd_pcm_dev_disconnect,
702		.dev_unregister = snd_pcm_dev_unregister
703	};
704
705	snd_assert(rpcm != NULL, return -EINVAL);
706	*rpcm = NULL;
707	snd_assert(card != NULL, return -ENXIO);
708	pcm = kzalloc(sizeof(*pcm), GFP_KERNEL);
709	if (pcm == NULL) {
710		snd_printk(KERN_ERR "Cannot allocate PCM\n");
711		return -ENOMEM;
712	}
713	pcm->card = card;
714	pcm->device = device;
715	if (id)
716		strlcpy(pcm->id, id, sizeof(pcm->id));
717	if ((err = snd_pcm_new_stream(pcm, SNDRV_PCM_STREAM_PLAYBACK, playback_count)) < 0) {
718		snd_pcm_free(pcm);
719		return err;
720	}
721	if ((err = snd_pcm_new_stream(pcm, SNDRV_PCM_STREAM_CAPTURE, capture_count)) < 0) {
722		snd_pcm_free(pcm);
723		return err;
724	}
725	mutex_init(&pcm->open_mutex);
726	init_waitqueue_head(&pcm->open_wait);
727	if ((err = snd_device_new(card, SNDRV_DEV_PCM, pcm, &ops)) < 0) {
728		snd_pcm_free(pcm);
729		return err;
730	}
731	*rpcm = pcm;
732	return 0;
733}
734
735EXPORT_SYMBOL(snd_pcm_new);
736
737static void snd_pcm_free_stream(struct snd_pcm_str * pstr)
738{
739	struct snd_pcm_substream *substream, *substream_next;
740#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
741	struct snd_pcm_oss_setup *setup, *setupn;
742#endif
743	substream = pstr->substream;
744	while (substream) {
745		substream_next = substream->next;
746		snd_pcm_substream_proc_done(substream);
747		kfree(substream);
748		substream = substream_next;
749	}
750	snd_pcm_stream_proc_done(pstr);
751#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
752	for (setup = pstr->oss.setup_list; setup; setup = setupn) {
753		setupn = setup->next;
754		kfree(setup->task_name);
755		kfree(setup);
756	}
757#endif
758}
759
760static int snd_pcm_free(struct snd_pcm *pcm)
761{
762	snd_assert(pcm != NULL, return -ENXIO);
763	if (pcm->private_free)
764		pcm->private_free(pcm);
765	snd_pcm_lib_preallocate_free_for_all(pcm);
766	snd_pcm_free_stream(&pcm->streams[SNDRV_PCM_STREAM_PLAYBACK]);
767	snd_pcm_free_stream(&pcm->streams[SNDRV_PCM_STREAM_CAPTURE]);
768	kfree(pcm);
769	return 0;
770}
771
772static int snd_pcm_dev_free(struct snd_device *device)
773{
774	struct snd_pcm *pcm = device->device_data;
775	return snd_pcm_free(pcm);
776}
777
778static void snd_pcm_tick_timer_func(unsigned long data)
779{
780	struct snd_pcm_substream *substream = (struct snd_pcm_substream *) data;
781	snd_pcm_tick_elapsed(substream);
782}
783
784int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream,
785			     struct file *file,
786			     struct snd_pcm_substream **rsubstream)
787{
788	struct snd_pcm_str * pstr;
789	struct snd_pcm_substream *substream;
790	struct snd_pcm_runtime *runtime;
791	struct snd_ctl_file *kctl;
792	struct snd_card *card;
793	struct list_head *list;
794	int prefer_subdevice = -1;
795	size_t size;
796
797	snd_assert(rsubstream != NULL, return -EINVAL);
798	*rsubstream = NULL;
799	snd_assert(pcm != NULL, return -ENXIO);
800	pstr = &pcm->streams[stream];
801	if (pstr->substream == NULL || pstr->substream_count == 0)
802		return -ENODEV;
803
804	card = pcm->card;
805	down_read(&card->controls_rwsem);
806	list_for_each(list, &card->ctl_files) {
807		kctl = snd_ctl_file(list);
808		if (kctl->pid == current->pid) {
809			prefer_subdevice = kctl->prefer_pcm_subdevice;
810			break;
811		}
812	}
813	up_read(&card->controls_rwsem);
814
815	switch (stream) {
816	case SNDRV_PCM_STREAM_PLAYBACK:
817		if (pcm->info_flags & SNDRV_PCM_INFO_HALF_DUPLEX) {
818			for (substream = pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream; substream; substream = substream->next) {
819				if (SUBSTREAM_BUSY(substream))
820					return -EAGAIN;
821			}
822		}
823		break;
824	case SNDRV_PCM_STREAM_CAPTURE:
825		if (pcm->info_flags & SNDRV_PCM_INFO_HALF_DUPLEX) {
826			for (substream = pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream; substream; substream = substream->next) {
827				if (SUBSTREAM_BUSY(substream))
828					return -EAGAIN;
829			}
830		}
831		break;
832	default:
833		return -EINVAL;
834	}
835
836	if (prefer_subdevice >= 0) {
837		for (substream = pstr->substream; substream; substream = substream->next)
838			if (!SUBSTREAM_BUSY(substream) && substream->number == prefer_subdevice)
839				goto __ok;
840	}
841	for (substream = pstr->substream; substream; substream = substream->next)
842		if (!SUBSTREAM_BUSY(substream))
843			break;
844      __ok:
845	if (substream == NULL)
846		return -EAGAIN;
847
848	runtime = kzalloc(sizeof(*runtime), GFP_KERNEL);
849	if (runtime == NULL)
850		return -ENOMEM;
851
852	size = PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status));
853	runtime->status = snd_malloc_pages(size, GFP_KERNEL);
854	if (runtime->status == NULL) {
855		kfree(runtime);
856		return -ENOMEM;
857	}
858	memset((void*)runtime->status, 0, size);
859
860	size = PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control));
861	runtime->control = snd_malloc_pages(size, GFP_KERNEL);
862	if (runtime->control == NULL) {
863		snd_free_pages((void*)runtime->status,
864			       PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)));
865		kfree(runtime);
866		return -ENOMEM;
867	}
868	memset((void*)runtime->control, 0, size);
869
870	init_waitqueue_head(&runtime->sleep);
871	atomic_set(&runtime->mmap_count, 0);
872	init_timer(&runtime->tick_timer);
873	runtime->tick_timer.function = snd_pcm_tick_timer_func;
874	runtime->tick_timer.data = (unsigned long) substream;
875
876	runtime->status->state = SNDRV_PCM_STATE_OPEN;
877
878	substream->runtime = runtime;
879	substream->private_data = pcm->private_data;
880	substream->ffile = file;
881	pstr->substream_opened++;
882	*rsubstream = substream;
883	return 0;
884}
885
886void snd_pcm_detach_substream(struct snd_pcm_substream *substream)
887{
888	struct snd_pcm_runtime *runtime;
889	substream->file = NULL;
890	runtime = substream->runtime;
891	snd_assert(runtime != NULL, return);
892	if (runtime->private_free != NULL)
893		runtime->private_free(runtime);
894	snd_free_pages((void*)runtime->status,
895		       PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)));
896	snd_free_pages((void*)runtime->control,
897		       PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)));
898	kfree(runtime->hw_constraints.rules);
899	kfree(runtime);
900	substream->runtime = NULL;
901	substream->pstr->substream_opened--;
902}
903
904static int snd_pcm_dev_register(struct snd_device *device)
905{
906	int cidx, err;
907	struct snd_pcm_substream *substream;
908	struct list_head *list;
909	char str[16];
910	struct snd_pcm *pcm = device->device_data;
911
912	snd_assert(pcm != NULL && device != NULL, return -ENXIO);
913	mutex_lock(&register_mutex);
914	if (snd_pcm_search(pcm->card, pcm->device)) {
915		mutex_unlock(&register_mutex);
916		return -EBUSY;
917	}
918	list_add_tail(&pcm->list, &snd_pcm_devices);
919	for (cidx = 0; cidx < 2; cidx++) {
920		int devtype = -1;
921		if (pcm->streams[cidx].substream == NULL)
922			continue;
923		switch (cidx) {
924		case SNDRV_PCM_STREAM_PLAYBACK:
925			sprintf(str, "pcmC%iD%ip", pcm->card->number, pcm->device);
926			devtype = SNDRV_DEVICE_TYPE_PCM_PLAYBACK;
927			break;
928		case SNDRV_PCM_STREAM_CAPTURE:
929			sprintf(str, "pcmC%iD%ic", pcm->card->number, pcm->device);
930			devtype = SNDRV_DEVICE_TYPE_PCM_CAPTURE;
931			break;
932		}
933		if ((err = snd_register_device(devtype, pcm->card,
934					       pcm->device,
935					       &snd_pcm_f_ops[cidx],
936					       pcm, str)) < 0)
937		{
938			list_del(&pcm->list);
939			mutex_unlock(&register_mutex);
940			return err;
941		}
942		for (substream = pcm->streams[cidx].substream; substream; substream = substream->next)
943			snd_pcm_timer_init(substream);
944	}
945	list_for_each(list, &snd_pcm_notify_list) {
946		struct snd_pcm_notify *notify;
947		notify = list_entry(list, struct snd_pcm_notify, list);
948		notify->n_register(pcm);
949	}
950	mutex_unlock(&register_mutex);
951	return 0;
952}
953
954static int snd_pcm_dev_disconnect(struct snd_device *device)
955{
956	struct snd_pcm *pcm = device->device_data;
957	struct list_head *list;
958	struct snd_pcm_substream *substream;
959	int cidx;
960
961	mutex_lock(&register_mutex);
962	list_del_init(&pcm->list);
963	for (cidx = 0; cidx < 2; cidx++)
964		for (substream = pcm->streams[cidx].substream; substream; substream = substream->next)
965			if (substream->runtime)
966				substream->runtime->status->state = SNDRV_PCM_STATE_DISCONNECTED;
967	list_for_each(list, &snd_pcm_notify_list) {
968		struct snd_pcm_notify *notify;
969		notify = list_entry(list, struct snd_pcm_notify, list);
970		notify->n_disconnect(pcm);
971	}
972	mutex_unlock(&register_mutex);
973	return 0;
974}
975
976static int snd_pcm_dev_unregister(struct snd_device *device)
977{
978	int cidx, devtype;
979	struct snd_pcm_substream *substream;
980	struct list_head *list;
981	struct snd_pcm *pcm = device->device_data;
982
983	snd_assert(pcm != NULL, return -ENXIO);
984	mutex_lock(&register_mutex);
985	list_del(&pcm->list);
986	for (cidx = 0; cidx < 2; cidx++) {
987		devtype = -1;
988		switch (cidx) {
989		case SNDRV_PCM_STREAM_PLAYBACK:
990			devtype = SNDRV_DEVICE_TYPE_PCM_PLAYBACK;
991			break;
992		case SNDRV_PCM_STREAM_CAPTURE:
993			devtype = SNDRV_DEVICE_TYPE_PCM_CAPTURE;
994			break;
995		}
996		snd_unregister_device(devtype, pcm->card, pcm->device);
997		for (substream = pcm->streams[cidx].substream; substream; substream = substream->next)
998			snd_pcm_timer_done(substream);
999	}
1000	list_for_each(list, &snd_pcm_notify_list) {
1001		struct snd_pcm_notify *notify;
1002		notify = list_entry(list, struct snd_pcm_notify, list);
1003		notify->n_unregister(pcm);
1004	}
1005	mutex_unlock(&register_mutex);
1006	return snd_pcm_free(pcm);
1007}
1008
1009int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree)
1010{
1011	struct list_head *p;
1012
1013	snd_assert(notify != NULL && notify->n_register != NULL && notify->n_unregister != NULL, return -EINVAL);
1014	mutex_lock(&register_mutex);
1015	if (nfree) {
1016		list_del(&notify->list);
1017		list_for_each(p, &snd_pcm_devices)
1018			notify->n_unregister(list_entry(p,
1019							struct snd_pcm, list));
1020	} else {
1021		list_add_tail(&notify->list, &snd_pcm_notify_list);
1022		list_for_each(p, &snd_pcm_devices)
1023			notify->n_register(list_entry(p, struct snd_pcm, list));
1024	}
1025	mutex_unlock(&register_mutex);
1026	return 0;
1027}
1028
1029EXPORT_SYMBOL(snd_pcm_notify);
1030
1031#ifdef CONFIG_PROC_FS
1032/*
1033 *  Info interface
1034 */
1035
1036static void snd_pcm_proc_read(struct snd_info_entry *entry,
1037			      struct snd_info_buffer *buffer)
1038{
1039	struct list_head *p;
1040	struct snd_pcm *pcm;
1041
1042	mutex_lock(&register_mutex);
1043	list_for_each(p, &snd_pcm_devices) {
1044		pcm = list_entry(p, struct snd_pcm, list);
1045		snd_iprintf(buffer, "%02i-%02i: %s : %s",
1046			    pcm->card->number, pcm->device, pcm->id, pcm->name);
1047		if (pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream)
1048			snd_iprintf(buffer, " : playback %i",
1049				    pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream_count);
1050		if (pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream)
1051			snd_iprintf(buffer, " : capture %i",
1052				    pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream_count);
1053		snd_iprintf(buffer, "\n");
1054	}
1055	mutex_unlock(&register_mutex);
1056}
1057
1058static struct snd_info_entry *snd_pcm_proc_entry = NULL;
1059
1060static void snd_pcm_proc_init(void)
1061{
1062	struct snd_info_entry *entry;
1063
1064	if ((entry = snd_info_create_module_entry(THIS_MODULE, "pcm", NULL)) != NULL) {
1065		snd_info_set_text_ops(entry, NULL, SNDRV_CARDS * SNDRV_PCM_DEVICES * 128,
1066				      snd_pcm_proc_read);
1067		if (snd_info_register(entry) < 0) {
1068			snd_info_free_entry(entry);
1069			entry = NULL;
1070		}
1071	}
1072	snd_pcm_proc_entry = entry;
1073}
1074
1075static void snd_pcm_proc_done(void)
1076{
1077	if (snd_pcm_proc_entry)
1078		snd_info_unregister(snd_pcm_proc_entry);
1079}
1080
1081#else /* !CONFIG_PROC_FS */
1082#define snd_pcm_proc_init()
1083#define snd_pcm_proc_done()
1084#endif /* CONFIG_PROC_FS */
1085
1086
1087/*
1088 *  ENTRY functions
1089 */
1090
1091static int __init alsa_pcm_init(void)
1092{
1093	snd_ctl_register_ioctl(snd_pcm_control_ioctl);
1094	snd_ctl_register_ioctl_compat(snd_pcm_control_ioctl);
1095	snd_pcm_proc_init();
1096	return 0;
1097}
1098
1099static void __exit alsa_pcm_exit(void)
1100{
1101	snd_ctl_unregister_ioctl(snd_pcm_control_ioctl);
1102	snd_ctl_unregister_ioctl_compat(snd_pcm_control_ioctl);
1103	snd_pcm_proc_done();
1104}
1105
1106module_init(alsa_pcm_init)
1107module_exit(alsa_pcm_exit)
1108