Loading...
1/*
2 * Information interface for ALSA driver
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/time.h>
24#include <linux/mm.h>
25#include <linux/slab.h>
26#include <linux/string.h>
27#include <linux/module.h>
28#include <sound/core.h>
29#include <sound/minors.h>
30#include <sound/info.h>
31#include <linux/utsname.h>
32#include <linux/proc_fs.h>
33#include <linux/mutex.h>
34#include <stdarg.h>
35
36int snd_info_check_reserved_words(const char *str)
37{
38 static char *reserved[] =
39 {
40 "version",
41 "meminfo",
42 "memdebug",
43 "detect",
44 "devices",
45 "oss",
46 "cards",
47 "timers",
48 "synth",
49 "pcm",
50 "seq",
51 NULL
52 };
53 char **xstr = reserved;
54
55 while (*xstr) {
56 if (!strcmp(*xstr, str))
57 return 0;
58 xstr++;
59 }
60 if (!strncmp(str, "card", 4))
61 return 0;
62 return 1;
63}
64
65static DEFINE_MUTEX(info_mutex);
66
67struct snd_info_private_data {
68 struct snd_info_buffer *rbuffer;
69 struct snd_info_buffer *wbuffer;
70 struct snd_info_entry *entry;
71 void *file_private_data;
72};
73
74static int snd_info_version_init(void);
75static void snd_info_disconnect(struct snd_info_entry *entry);
76
77/*
78
79 */
80
81static struct snd_info_entry *snd_proc_root;
82struct snd_info_entry *snd_seq_root;
83EXPORT_SYMBOL(snd_seq_root);
84
85#ifdef CONFIG_SND_OSSEMUL
86struct snd_info_entry *snd_oss_root;
87#endif
88
89static int alloc_info_private(struct snd_info_entry *entry,
90 struct snd_info_private_data **ret)
91{
92 struct snd_info_private_data *data;
93
94 if (!entry || !entry->p)
95 return -ENODEV;
96 if (!try_module_get(entry->module))
97 return -EFAULT;
98 data = kzalloc(sizeof(*data), GFP_KERNEL);
99 if (!data) {
100 module_put(entry->module);
101 return -ENOMEM;
102 }
103 data->entry = entry;
104 *ret = data;
105 return 0;
106}
107
108static bool valid_pos(loff_t pos, size_t count)
109{
110 if (pos < 0 || (long) pos != pos || (ssize_t) count < 0)
111 return false;
112 if ((unsigned long) pos + (unsigned long) count < (unsigned long) pos)
113 return false;
114 return true;
115}
116
117/*
118 * file ops for binary proc files
119 */
120static loff_t snd_info_entry_llseek(struct file *file, loff_t offset, int orig)
121{
122 struct snd_info_private_data *data;
123 struct snd_info_entry *entry;
124 loff_t ret = -EINVAL, size;
125
126 data = file->private_data;
127 entry = data->entry;
128 mutex_lock(&entry->access);
129 if (entry->c.ops->llseek) {
130 offset = entry->c.ops->llseek(entry,
131 data->file_private_data,
132 file, offset, orig);
133 goto out;
134 }
135
136 size = entry->size;
137 switch (orig) {
138 case SEEK_SET:
139 break;
140 case SEEK_CUR:
141 offset += file->f_pos;
142 break;
143 case SEEK_END:
144 if (!size)
145 goto out;
146 offset += size;
147 break;
148 default:
149 goto out;
150 }
151 if (offset < 0)
152 goto out;
153 if (size && offset > size)
154 offset = size;
155 file->f_pos = offset;
156 ret = offset;
157 out:
158 mutex_unlock(&entry->access);
159 return ret;
160}
161
162static ssize_t snd_info_entry_read(struct file *file, char __user *buffer,
163 size_t count, loff_t * offset)
164{
165 struct snd_info_private_data *data = file->private_data;
166 struct snd_info_entry *entry = data->entry;
167 size_t size;
168 loff_t pos;
169
170 pos = *offset;
171 if (!valid_pos(pos, count))
172 return -EIO;
173 if (pos >= entry->size)
174 return 0;
175 size = entry->size - pos;
176 size = min(count, size);
177 size = entry->c.ops->read(entry, data->file_private_data,
178 file, buffer, size, pos);
179 if ((ssize_t) size > 0)
180 *offset = pos + size;
181 return size;
182}
183
184static ssize_t snd_info_entry_write(struct file *file, const char __user *buffer,
185 size_t count, loff_t * offset)
186{
187 struct snd_info_private_data *data = file->private_data;
188 struct snd_info_entry *entry = data->entry;
189 ssize_t size = 0;
190 loff_t pos;
191
192 pos = *offset;
193 if (!valid_pos(pos, count))
194 return -EIO;
195 if (count > 0) {
196 size_t maxsize = entry->size - pos;
197 count = min(count, maxsize);
198 size = entry->c.ops->write(entry, data->file_private_data,
199 file, buffer, count, pos);
200 }
201 if (size > 0)
202 *offset = pos + size;
203 return size;
204}
205
206static unsigned int snd_info_entry_poll(struct file *file, poll_table *wait)
207{
208 struct snd_info_private_data *data = file->private_data;
209 struct snd_info_entry *entry = data->entry;
210 unsigned int mask = 0;
211
212 if (entry->c.ops->poll)
213 return entry->c.ops->poll(entry,
214 data->file_private_data,
215 file, wait);
216 if (entry->c.ops->read)
217 mask |= POLLIN | POLLRDNORM;
218 if (entry->c.ops->write)
219 mask |= POLLOUT | POLLWRNORM;
220 return mask;
221}
222
223static long snd_info_entry_ioctl(struct file *file, unsigned int cmd,
224 unsigned long arg)
225{
226 struct snd_info_private_data *data = file->private_data;
227 struct snd_info_entry *entry = data->entry;
228
229 if (!entry->c.ops->ioctl)
230 return -ENOTTY;
231 return entry->c.ops->ioctl(entry, data->file_private_data,
232 file, cmd, arg);
233}
234
235static int snd_info_entry_mmap(struct file *file, struct vm_area_struct *vma)
236{
237 struct inode *inode = file_inode(file);
238 struct snd_info_private_data *data;
239 struct snd_info_entry *entry;
240
241 data = file->private_data;
242 if (data == NULL)
243 return 0;
244 entry = data->entry;
245 if (!entry->c.ops->mmap)
246 return -ENXIO;
247 return entry->c.ops->mmap(entry, data->file_private_data,
248 inode, file, vma);
249}
250
251static int snd_info_entry_open(struct inode *inode, struct file *file)
252{
253 struct snd_info_entry *entry = PDE_DATA(inode);
254 struct snd_info_private_data *data;
255 int mode, err;
256
257 mutex_lock(&info_mutex);
258 err = alloc_info_private(entry, &data);
259 if (err < 0)
260 goto unlock;
261
262 mode = file->f_flags & O_ACCMODE;
263 if (((mode == O_RDONLY || mode == O_RDWR) && !entry->c.ops->read) ||
264 ((mode == O_WRONLY || mode == O_RDWR) && !entry->c.ops->write)) {
265 err = -ENODEV;
266 goto error;
267 }
268
269 if (entry->c.ops->open) {
270 err = entry->c.ops->open(entry, mode, &data->file_private_data);
271 if (err < 0)
272 goto error;
273 }
274
275 file->private_data = data;
276 mutex_unlock(&info_mutex);
277 return 0;
278
279 error:
280 kfree(data);
281 module_put(entry->module);
282 unlock:
283 mutex_unlock(&info_mutex);
284 return err;
285}
286
287static int snd_info_entry_release(struct inode *inode, struct file *file)
288{
289 struct snd_info_private_data *data = file->private_data;
290 struct snd_info_entry *entry = data->entry;
291
292 if (entry->c.ops->release)
293 entry->c.ops->release(entry, file->f_flags & O_ACCMODE,
294 data->file_private_data);
295 module_put(entry->module);
296 kfree(data);
297 return 0;
298}
299
300static const struct file_operations snd_info_entry_operations =
301{
302 .owner = THIS_MODULE,
303 .llseek = snd_info_entry_llseek,
304 .read = snd_info_entry_read,
305 .write = snd_info_entry_write,
306 .poll = snd_info_entry_poll,
307 .unlocked_ioctl = snd_info_entry_ioctl,
308 .mmap = snd_info_entry_mmap,
309 .open = snd_info_entry_open,
310 .release = snd_info_entry_release,
311};
312
313/*
314 * file ops for text proc files
315 */
316static ssize_t snd_info_text_entry_write(struct file *file,
317 const char __user *buffer,
318 size_t count, loff_t *offset)
319{
320 struct seq_file *m = file->private_data;
321 struct snd_info_private_data *data = m->private;
322 struct snd_info_entry *entry = data->entry;
323 struct snd_info_buffer *buf;
324 loff_t pos;
325 size_t next;
326 int err = 0;
327
328 if (!entry->c.text.write)
329 return -EIO;
330 pos = *offset;
331 if (!valid_pos(pos, count))
332 return -EIO;
333 next = pos + count;
334 /* don't handle too large text inputs */
335 if (next > 16 * 1024)
336 return -EIO;
337 mutex_lock(&entry->access);
338 buf = data->wbuffer;
339 if (!buf) {
340 data->wbuffer = buf = kzalloc(sizeof(*buf), GFP_KERNEL);
341 if (!buf) {
342 err = -ENOMEM;
343 goto error;
344 }
345 }
346 if (next > buf->len) {
347 char *nbuf = krealloc(buf->buffer, PAGE_ALIGN(next),
348 GFP_KERNEL | __GFP_ZERO);
349 if (!nbuf) {
350 err = -ENOMEM;
351 goto error;
352 }
353 buf->buffer = nbuf;
354 buf->len = PAGE_ALIGN(next);
355 }
356 if (copy_from_user(buf->buffer + pos, buffer, count)) {
357 err = -EFAULT;
358 goto error;
359 }
360 buf->size = next;
361 error:
362 mutex_unlock(&entry->access);
363 if (err < 0)
364 return err;
365 *offset = next;
366 return count;
367}
368
369static int snd_info_seq_show(struct seq_file *seq, void *p)
370{
371 struct snd_info_private_data *data = seq->private;
372 struct snd_info_entry *entry = data->entry;
373
374 if (!entry->c.text.read) {
375 return -EIO;
376 } else {
377 data->rbuffer->buffer = (char *)seq; /* XXX hack! */
378 entry->c.text.read(entry, data->rbuffer);
379 }
380 return 0;
381}
382
383static int snd_info_text_entry_open(struct inode *inode, struct file *file)
384{
385 struct snd_info_entry *entry = PDE_DATA(inode);
386 struct snd_info_private_data *data;
387 int err;
388
389 mutex_lock(&info_mutex);
390 err = alloc_info_private(entry, &data);
391 if (err < 0)
392 goto unlock;
393
394 data->rbuffer = kzalloc(sizeof(*data->rbuffer), GFP_KERNEL);
395 if (!data->rbuffer) {
396 err = -ENOMEM;
397 goto error;
398 }
399 if (entry->size)
400 err = single_open_size(file, snd_info_seq_show, data,
401 entry->size);
402 else
403 err = single_open(file, snd_info_seq_show, data);
404 if (err < 0)
405 goto error;
406 mutex_unlock(&info_mutex);
407 return 0;
408
409 error:
410 kfree(data->rbuffer);
411 kfree(data);
412 module_put(entry->module);
413 unlock:
414 mutex_unlock(&info_mutex);
415 return err;
416}
417
418static int snd_info_text_entry_release(struct inode *inode, struct file *file)
419{
420 struct seq_file *m = file->private_data;
421 struct snd_info_private_data *data = m->private;
422 struct snd_info_entry *entry = data->entry;
423
424 if (data->wbuffer && entry->c.text.write)
425 entry->c.text.write(entry, data->wbuffer);
426
427 single_release(inode, file);
428 kfree(data->rbuffer);
429 if (data->wbuffer) {
430 kfree(data->wbuffer->buffer);
431 kfree(data->wbuffer);
432 }
433
434 module_put(entry->module);
435 kfree(data);
436 return 0;
437}
438
439static const struct file_operations snd_info_text_entry_ops =
440{
441 .owner = THIS_MODULE,
442 .open = snd_info_text_entry_open,
443 .release = snd_info_text_entry_release,
444 .write = snd_info_text_entry_write,
445 .llseek = seq_lseek,
446 .read = seq_read,
447};
448
449static struct snd_info_entry *create_subdir(struct module *mod,
450 const char *name)
451{
452 struct snd_info_entry *entry;
453
454 entry = snd_info_create_module_entry(mod, name, NULL);
455 if (!entry)
456 return NULL;
457 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
458 if (snd_info_register(entry) < 0) {
459 snd_info_free_entry(entry);
460 return NULL;
461 }
462 return entry;
463}
464
465static struct snd_info_entry *
466snd_info_create_entry(const char *name, struct snd_info_entry *parent);
467
468int __init snd_info_init(void)
469{
470 snd_proc_root = snd_info_create_entry("asound", NULL);
471 if (!snd_proc_root)
472 return -ENOMEM;
473 snd_proc_root->mode = S_IFDIR | S_IRUGO | S_IXUGO;
474 snd_proc_root->p = proc_mkdir("asound", NULL);
475 if (!snd_proc_root->p)
476 goto error;
477#ifdef CONFIG_SND_OSSEMUL
478 snd_oss_root = create_subdir(THIS_MODULE, "oss");
479 if (!snd_oss_root)
480 goto error;
481#endif
482#if IS_ENABLED(CONFIG_SND_SEQUENCER)
483 snd_seq_root = create_subdir(THIS_MODULE, "seq");
484 if (!snd_seq_root)
485 goto error;
486#endif
487 if (snd_info_version_init() < 0 ||
488 snd_minor_info_init() < 0 ||
489 snd_minor_info_oss_init() < 0 ||
490 snd_card_info_init() < 0 ||
491 snd_info_minor_register() < 0)
492 goto error;
493 return 0;
494
495 error:
496 snd_info_free_entry(snd_proc_root);
497 return -ENOMEM;
498}
499
500int __exit snd_info_done(void)
501{
502 snd_info_free_entry(snd_proc_root);
503 return 0;
504}
505
506/*
507 * create a card proc file
508 * called from init.c
509 */
510int snd_info_card_create(struct snd_card *card)
511{
512 char str[8];
513 struct snd_info_entry *entry;
514
515 if (snd_BUG_ON(!card))
516 return -ENXIO;
517
518 sprintf(str, "card%i", card->number);
519 entry = create_subdir(card->module, str);
520 if (!entry)
521 return -ENOMEM;
522 card->proc_root = entry;
523 return 0;
524}
525
526/* register all pending info entries */
527static int snd_info_register_recursive(struct snd_info_entry *entry)
528{
529 struct snd_info_entry *p;
530 int err;
531
532 if (!entry->p) {
533 err = snd_info_register(entry);
534 if (err < 0)
535 return err;
536 }
537
538 list_for_each_entry(p, &entry->children, list) {
539 err = snd_info_register_recursive(p);
540 if (err < 0)
541 return err;
542 }
543
544 return 0;
545}
546
547/*
548 * register the card proc file
549 * called from init.c
550 * can be called multiple times for reinitialization
551 */
552int snd_info_card_register(struct snd_card *card)
553{
554 struct proc_dir_entry *p;
555 int err;
556
557 if (snd_BUG_ON(!card))
558 return -ENXIO;
559
560 err = snd_info_register_recursive(card->proc_root);
561 if (err < 0)
562 return err;
563
564 if (!strcmp(card->id, card->proc_root->name))
565 return 0;
566
567 if (card->proc_root_link)
568 return 0;
569 p = proc_symlink(card->id, snd_proc_root->p, card->proc_root->name);
570 if (!p)
571 return -ENOMEM;
572 card->proc_root_link = p;
573 return 0;
574}
575
576/*
577 * called on card->id change
578 */
579void snd_info_card_id_change(struct snd_card *card)
580{
581 mutex_lock(&info_mutex);
582 if (card->proc_root_link) {
583 proc_remove(card->proc_root_link);
584 card->proc_root_link = NULL;
585 }
586 if (strcmp(card->id, card->proc_root->name))
587 card->proc_root_link = proc_symlink(card->id,
588 snd_proc_root->p,
589 card->proc_root->name);
590 mutex_unlock(&info_mutex);
591}
592
593/*
594 * de-register the card proc file
595 * called from init.c
596 */
597void snd_info_card_disconnect(struct snd_card *card)
598{
599 if (!card)
600 return;
601 mutex_lock(&info_mutex);
602 proc_remove(card->proc_root_link);
603 card->proc_root_link = NULL;
604 if (card->proc_root)
605 snd_info_disconnect(card->proc_root);
606 mutex_unlock(&info_mutex);
607}
608
609/*
610 * release the card proc file resources
611 * called from init.c
612 */
613int snd_info_card_free(struct snd_card *card)
614{
615 if (!card)
616 return 0;
617 snd_info_free_entry(card->proc_root);
618 card->proc_root = NULL;
619 return 0;
620}
621
622
623/**
624 * snd_info_get_line - read one line from the procfs buffer
625 * @buffer: the procfs buffer
626 * @line: the buffer to store
627 * @len: the max. buffer size
628 *
629 * Reads one line from the buffer and stores the string.
630 *
631 * Return: Zero if successful, or 1 if error or EOF.
632 */
633int snd_info_get_line(struct snd_info_buffer *buffer, char *line, int len)
634{
635 int c = -1;
636
637 if (snd_BUG_ON(!buffer || !buffer->buffer))
638 return 1;
639 if (len <= 0 || buffer->stop || buffer->error)
640 return 1;
641 while (!buffer->stop) {
642 c = buffer->buffer[buffer->curr++];
643 if (buffer->curr >= buffer->size)
644 buffer->stop = 1;
645 if (c == '\n')
646 break;
647 if (len > 1) {
648 len--;
649 *line++ = c;
650 }
651 }
652 *line = '\0';
653 return 0;
654}
655
656EXPORT_SYMBOL(snd_info_get_line);
657
658/**
659 * snd_info_get_str - parse a string token
660 * @dest: the buffer to store the string token
661 * @src: the original string
662 * @len: the max. length of token - 1
663 *
664 * Parses the original string and copy a token to the given
665 * string buffer.
666 *
667 * Return: The updated pointer of the original string so that
668 * it can be used for the next call.
669 */
670const char *snd_info_get_str(char *dest, const char *src, int len)
671{
672 int c;
673
674 while (*src == ' ' || *src == '\t')
675 src++;
676 if (*src == '"' || *src == '\'') {
677 c = *src++;
678 while (--len > 0 && *src && *src != c) {
679 *dest++ = *src++;
680 }
681 if (*src == c)
682 src++;
683 } else {
684 while (--len > 0 && *src && *src != ' ' && *src != '\t') {
685 *dest++ = *src++;
686 }
687 }
688 *dest = 0;
689 while (*src == ' ' || *src == '\t')
690 src++;
691 return src;
692}
693
694EXPORT_SYMBOL(snd_info_get_str);
695
696/*
697 * snd_info_create_entry - create an info entry
698 * @name: the proc file name
699 * @parent: the parent directory
700 *
701 * Creates an info entry with the given file name and initializes as
702 * the default state.
703 *
704 * Usually called from other functions such as
705 * snd_info_create_card_entry().
706 *
707 * Return: The pointer of the new instance, or %NULL on failure.
708 */
709static struct snd_info_entry *
710snd_info_create_entry(const char *name, struct snd_info_entry *parent)
711{
712 struct snd_info_entry *entry;
713 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
714 if (entry == NULL)
715 return NULL;
716 entry->name = kstrdup(name, GFP_KERNEL);
717 if (entry->name == NULL) {
718 kfree(entry);
719 return NULL;
720 }
721 entry->mode = S_IFREG | S_IRUGO;
722 entry->content = SNDRV_INFO_CONTENT_TEXT;
723 mutex_init(&entry->access);
724 INIT_LIST_HEAD(&entry->children);
725 INIT_LIST_HEAD(&entry->list);
726 entry->parent = parent;
727 if (parent)
728 list_add_tail(&entry->list, &parent->children);
729 return entry;
730}
731
732/**
733 * snd_info_create_module_entry - create an info entry for the given module
734 * @module: the module pointer
735 * @name: the file name
736 * @parent: the parent directory
737 *
738 * Creates a new info entry and assigns it to the given module.
739 *
740 * Return: The pointer of the new instance, or %NULL on failure.
741 */
742struct snd_info_entry *snd_info_create_module_entry(struct module * module,
743 const char *name,
744 struct snd_info_entry *parent)
745{
746 struct snd_info_entry *entry = snd_info_create_entry(name, parent);
747 if (entry)
748 entry->module = module;
749 return entry;
750}
751
752EXPORT_SYMBOL(snd_info_create_module_entry);
753
754/**
755 * snd_info_create_card_entry - create an info entry for the given card
756 * @card: the card instance
757 * @name: the file name
758 * @parent: the parent directory
759 *
760 * Creates a new info entry and assigns it to the given card.
761 *
762 * Return: The pointer of the new instance, or %NULL on failure.
763 */
764struct snd_info_entry *snd_info_create_card_entry(struct snd_card *card,
765 const char *name,
766 struct snd_info_entry * parent)
767{
768 struct snd_info_entry *entry = snd_info_create_entry(name, parent);
769 if (entry) {
770 entry->module = card->module;
771 entry->card = card;
772 }
773 return entry;
774}
775
776EXPORT_SYMBOL(snd_info_create_card_entry);
777
778static void snd_info_disconnect(struct snd_info_entry *entry)
779{
780 struct snd_info_entry *p;
781
782 if (!entry->p)
783 return;
784 list_for_each_entry(p, &entry->children, list)
785 snd_info_disconnect(p);
786 proc_remove(entry->p);
787 entry->p = NULL;
788}
789
790/**
791 * snd_info_free_entry - release the info entry
792 * @entry: the info entry
793 *
794 * Releases the info entry.
795 */
796void snd_info_free_entry(struct snd_info_entry * entry)
797{
798 struct snd_info_entry *p, *n;
799
800 if (!entry)
801 return;
802 if (entry->p) {
803 mutex_lock(&info_mutex);
804 snd_info_disconnect(entry);
805 mutex_unlock(&info_mutex);
806 }
807
808 /* free all children at first */
809 list_for_each_entry_safe(p, n, &entry->children, list)
810 snd_info_free_entry(p);
811
812 list_del(&entry->list);
813 kfree(entry->name);
814 if (entry->private_free)
815 entry->private_free(entry);
816 kfree(entry);
817}
818
819EXPORT_SYMBOL(snd_info_free_entry);
820
821/**
822 * snd_info_register - register the info entry
823 * @entry: the info entry
824 *
825 * Registers the proc info entry.
826 *
827 * Return: Zero if successful, or a negative error code on failure.
828 */
829int snd_info_register(struct snd_info_entry * entry)
830{
831 struct proc_dir_entry *root, *p = NULL;
832
833 if (snd_BUG_ON(!entry))
834 return -ENXIO;
835 root = entry->parent == NULL ? snd_proc_root->p : entry->parent->p;
836 mutex_lock(&info_mutex);
837 if (S_ISDIR(entry->mode)) {
838 p = proc_mkdir_mode(entry->name, entry->mode, root);
839 if (!p) {
840 mutex_unlock(&info_mutex);
841 return -ENOMEM;
842 }
843 } else {
844 const struct file_operations *ops;
845 if (entry->content == SNDRV_INFO_CONTENT_DATA)
846 ops = &snd_info_entry_operations;
847 else
848 ops = &snd_info_text_entry_ops;
849 p = proc_create_data(entry->name, entry->mode, root,
850 ops, entry);
851 if (!p) {
852 mutex_unlock(&info_mutex);
853 return -ENOMEM;
854 }
855 proc_set_size(p, entry->size);
856 }
857 entry->p = p;
858 mutex_unlock(&info_mutex);
859 return 0;
860}
861
862EXPORT_SYMBOL(snd_info_register);
863
864/*
865
866 */
867
868static void snd_info_version_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
869{
870 snd_iprintf(buffer,
871 "Advanced Linux Sound Architecture Driver Version k%s.\n",
872 init_utsname()->release);
873}
874
875static int __init snd_info_version_init(void)
876{
877 struct snd_info_entry *entry;
878
879 entry = snd_info_create_module_entry(THIS_MODULE, "version", NULL);
880 if (entry == NULL)
881 return -ENOMEM;
882 entry->c.text.read = snd_info_version_read;
883 return snd_info_register(entry); /* freed in error path */
884}
1/*
2 * Information interface for ALSA driver
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/time.h>
24#include <linux/mm.h>
25#include <linux/slab.h>
26#include <linux/string.h>
27#include <sound/core.h>
28#include <sound/minors.h>
29#include <sound/info.h>
30#include <sound/version.h>
31#include <linux/proc_fs.h>
32#include <linux/mutex.h>
33#include <stdarg.h>
34
35/*
36 *
37 */
38
39#ifdef CONFIG_PROC_FS
40
41int snd_info_check_reserved_words(const char *str)
42{
43 static char *reserved[] =
44 {
45 "version",
46 "meminfo",
47 "memdebug",
48 "detect",
49 "devices",
50 "oss",
51 "cards",
52 "timers",
53 "synth",
54 "pcm",
55 "seq",
56 NULL
57 };
58 char **xstr = reserved;
59
60 while (*xstr) {
61 if (!strcmp(*xstr, str))
62 return 0;
63 xstr++;
64 }
65 if (!strncmp(str, "card", 4))
66 return 0;
67 return 1;
68}
69
70static DEFINE_MUTEX(info_mutex);
71
72struct snd_info_private_data {
73 struct snd_info_buffer *rbuffer;
74 struct snd_info_buffer *wbuffer;
75 struct snd_info_entry *entry;
76 void *file_private_data;
77};
78
79static int snd_info_version_init(void);
80static int snd_info_version_done(void);
81static void snd_info_disconnect(struct snd_info_entry *entry);
82
83
84/* resize the proc r/w buffer */
85static int resize_info_buffer(struct snd_info_buffer *buffer,
86 unsigned int nsize)
87{
88 char *nbuf;
89
90 nsize = PAGE_ALIGN(nsize);
91 nbuf = krealloc(buffer->buffer, nsize, GFP_KERNEL);
92 if (! nbuf)
93 return -ENOMEM;
94
95 buffer->buffer = nbuf;
96 buffer->len = nsize;
97 return 0;
98}
99
100/**
101 * snd_iprintf - printf on the procfs buffer
102 * @buffer: the procfs buffer
103 * @fmt: the printf format
104 *
105 * Outputs the string on the procfs buffer just like printf().
106 *
107 * Returns the size of output string.
108 */
109int snd_iprintf(struct snd_info_buffer *buffer, const char *fmt, ...)
110{
111 va_list args;
112 int len, res;
113 int err = 0;
114
115 might_sleep();
116 if (buffer->stop || buffer->error)
117 return 0;
118 len = buffer->len - buffer->size;
119 va_start(args, fmt);
120 for (;;) {
121 va_list ap;
122 va_copy(ap, args);
123 res = vsnprintf(buffer->buffer + buffer->curr, len, fmt, ap);
124 va_end(ap);
125 if (res < len)
126 break;
127 err = resize_info_buffer(buffer, buffer->len + PAGE_SIZE);
128 if (err < 0)
129 break;
130 len = buffer->len - buffer->size;
131 }
132 va_end(args);
133
134 if (err < 0)
135 return err;
136 buffer->curr += res;
137 buffer->size += res;
138 return res;
139}
140
141EXPORT_SYMBOL(snd_iprintf);
142
143/*
144
145 */
146
147static struct proc_dir_entry *snd_proc_root;
148struct snd_info_entry *snd_seq_root;
149EXPORT_SYMBOL(snd_seq_root);
150
151#ifdef CONFIG_SND_OSSEMUL
152struct snd_info_entry *snd_oss_root;
153#endif
154
155static void snd_remove_proc_entry(struct proc_dir_entry *parent,
156 struct proc_dir_entry *de)
157{
158 if (de)
159 remove_proc_entry(de->name, parent);
160}
161
162static loff_t snd_info_entry_llseek(struct file *file, loff_t offset, int orig)
163{
164 struct snd_info_private_data *data;
165 struct snd_info_entry *entry;
166 loff_t ret = -EINVAL, size;
167
168 data = file->private_data;
169 entry = data->entry;
170 mutex_lock(&entry->access);
171 if (entry->content == SNDRV_INFO_CONTENT_DATA &&
172 entry->c.ops->llseek) {
173 offset = entry->c.ops->llseek(entry,
174 data->file_private_data,
175 file, offset, orig);
176 goto out;
177 }
178 if (entry->content == SNDRV_INFO_CONTENT_DATA)
179 size = entry->size;
180 else
181 size = 0;
182 switch (orig) {
183 case SEEK_SET:
184 break;
185 case SEEK_CUR:
186 offset += file->f_pos;
187 break;
188 case SEEK_END:
189 if (!size)
190 goto out;
191 offset += size;
192 break;
193 default:
194 goto out;
195 }
196 if (offset < 0)
197 goto out;
198 if (size && offset > size)
199 offset = size;
200 file->f_pos = offset;
201 ret = offset;
202 out:
203 mutex_unlock(&entry->access);
204 return ret;
205}
206
207static ssize_t snd_info_entry_read(struct file *file, char __user *buffer,
208 size_t count, loff_t * offset)
209{
210 struct snd_info_private_data *data;
211 struct snd_info_entry *entry;
212 struct snd_info_buffer *buf;
213 size_t size = 0;
214 loff_t pos;
215
216 data = file->private_data;
217 if (snd_BUG_ON(!data))
218 return -ENXIO;
219 pos = *offset;
220 if (pos < 0 || (long) pos != pos || (ssize_t) count < 0)
221 return -EIO;
222 if ((unsigned long) pos + (unsigned long) count < (unsigned long) pos)
223 return -EIO;
224 entry = data->entry;
225 switch (entry->content) {
226 case SNDRV_INFO_CONTENT_TEXT:
227 buf = data->rbuffer;
228 if (buf == NULL)
229 return -EIO;
230 if (pos >= buf->size)
231 return 0;
232 size = buf->size - pos;
233 size = min(count, size);
234 if (copy_to_user(buffer, buf->buffer + pos, size))
235 return -EFAULT;
236 break;
237 case SNDRV_INFO_CONTENT_DATA:
238 if (pos >= entry->size)
239 return 0;
240 if (entry->c.ops->read) {
241 size = entry->size - pos;
242 size = min(count, size);
243 size = entry->c.ops->read(entry,
244 data->file_private_data,
245 file, buffer, size, pos);
246 }
247 break;
248 }
249 if ((ssize_t) size > 0)
250 *offset = pos + size;
251 return size;
252}
253
254static ssize_t snd_info_entry_write(struct file *file, const char __user *buffer,
255 size_t count, loff_t * offset)
256{
257 struct snd_info_private_data *data;
258 struct snd_info_entry *entry;
259 struct snd_info_buffer *buf;
260 ssize_t size = 0;
261 loff_t pos;
262
263 data = file->private_data;
264 if (snd_BUG_ON(!data))
265 return -ENXIO;
266 entry = data->entry;
267 pos = *offset;
268 if (pos < 0 || (long) pos != pos || (ssize_t) count < 0)
269 return -EIO;
270 if ((unsigned long) pos + (unsigned long) count < (unsigned long) pos)
271 return -EIO;
272 switch (entry->content) {
273 case SNDRV_INFO_CONTENT_TEXT:
274 buf = data->wbuffer;
275 if (buf == NULL)
276 return -EIO;
277 mutex_lock(&entry->access);
278 if (pos + count >= buf->len) {
279 if (resize_info_buffer(buf, pos + count)) {
280 mutex_unlock(&entry->access);
281 return -ENOMEM;
282 }
283 }
284 if (copy_from_user(buf->buffer + pos, buffer, count)) {
285 mutex_unlock(&entry->access);
286 return -EFAULT;
287 }
288 buf->size = pos + count;
289 mutex_unlock(&entry->access);
290 size = count;
291 break;
292 case SNDRV_INFO_CONTENT_DATA:
293 if (entry->c.ops->write && count > 0) {
294 size_t maxsize = entry->size - pos;
295 count = min(count, maxsize);
296 size = entry->c.ops->write(entry,
297 data->file_private_data,
298 file, buffer, count, pos);
299 }
300 break;
301 }
302 if ((ssize_t) size > 0)
303 *offset = pos + size;
304 return size;
305}
306
307static int snd_info_entry_open(struct inode *inode, struct file *file)
308{
309 struct snd_info_entry *entry;
310 struct snd_info_private_data *data;
311 struct snd_info_buffer *buffer;
312 struct proc_dir_entry *p;
313 int mode, err;
314
315 mutex_lock(&info_mutex);
316 p = PDE(inode);
317 entry = p == NULL ? NULL : (struct snd_info_entry *)p->data;
318 if (entry == NULL || ! entry->p) {
319 mutex_unlock(&info_mutex);
320 return -ENODEV;
321 }
322 if (!try_module_get(entry->module)) {
323 err = -EFAULT;
324 goto __error1;
325 }
326 mode = file->f_flags & O_ACCMODE;
327 if (mode == O_RDONLY || mode == O_RDWR) {
328 if ((entry->content == SNDRV_INFO_CONTENT_DATA &&
329 entry->c.ops->read == NULL)) {
330 err = -ENODEV;
331 goto __error;
332 }
333 }
334 if (mode == O_WRONLY || mode == O_RDWR) {
335 if ((entry->content == SNDRV_INFO_CONTENT_DATA &&
336 entry->c.ops->write == NULL)) {
337 err = -ENODEV;
338 goto __error;
339 }
340 }
341 data = kzalloc(sizeof(*data), GFP_KERNEL);
342 if (data == NULL) {
343 err = -ENOMEM;
344 goto __error;
345 }
346 data->entry = entry;
347 switch (entry->content) {
348 case SNDRV_INFO_CONTENT_TEXT:
349 if (mode == O_RDONLY || mode == O_RDWR) {
350 buffer = kzalloc(sizeof(*buffer), GFP_KERNEL);
351 if (buffer == NULL)
352 goto __nomem;
353 data->rbuffer = buffer;
354 buffer->len = PAGE_SIZE;
355 buffer->buffer = kmalloc(buffer->len, GFP_KERNEL);
356 if (buffer->buffer == NULL)
357 goto __nomem;
358 }
359 if (mode == O_WRONLY || mode == O_RDWR) {
360 buffer = kzalloc(sizeof(*buffer), GFP_KERNEL);
361 if (buffer == NULL)
362 goto __nomem;
363 data->wbuffer = buffer;
364 buffer->len = PAGE_SIZE;
365 buffer->buffer = kmalloc(buffer->len, GFP_KERNEL);
366 if (buffer->buffer == NULL)
367 goto __nomem;
368 }
369 break;
370 case SNDRV_INFO_CONTENT_DATA: /* data */
371 if (entry->c.ops->open) {
372 if ((err = entry->c.ops->open(entry, mode,
373 &data->file_private_data)) < 0) {
374 kfree(data);
375 goto __error;
376 }
377 }
378 break;
379 }
380 file->private_data = data;
381 mutex_unlock(&info_mutex);
382 if (entry->content == SNDRV_INFO_CONTENT_TEXT &&
383 (mode == O_RDONLY || mode == O_RDWR)) {
384 if (entry->c.text.read) {
385 mutex_lock(&entry->access);
386 entry->c.text.read(entry, data->rbuffer);
387 mutex_unlock(&entry->access);
388 }
389 }
390 return 0;
391
392 __nomem:
393 if (data->rbuffer) {
394 kfree(data->rbuffer->buffer);
395 kfree(data->rbuffer);
396 }
397 if (data->wbuffer) {
398 kfree(data->wbuffer->buffer);
399 kfree(data->wbuffer);
400 }
401 kfree(data);
402 err = -ENOMEM;
403 __error:
404 module_put(entry->module);
405 __error1:
406 mutex_unlock(&info_mutex);
407 return err;
408}
409
410static int snd_info_entry_release(struct inode *inode, struct file *file)
411{
412 struct snd_info_entry *entry;
413 struct snd_info_private_data *data;
414 int mode;
415
416 mode = file->f_flags & O_ACCMODE;
417 data = file->private_data;
418 entry = data->entry;
419 switch (entry->content) {
420 case SNDRV_INFO_CONTENT_TEXT:
421 if (data->rbuffer) {
422 kfree(data->rbuffer->buffer);
423 kfree(data->rbuffer);
424 }
425 if (data->wbuffer) {
426 if (entry->c.text.write) {
427 entry->c.text.write(entry, data->wbuffer);
428 if (data->wbuffer->error) {
429 snd_printk(KERN_WARNING "data write error to %s (%i)\n",
430 entry->name,
431 data->wbuffer->error);
432 }
433 }
434 kfree(data->wbuffer->buffer);
435 kfree(data->wbuffer);
436 }
437 break;
438 case SNDRV_INFO_CONTENT_DATA:
439 if (entry->c.ops->release)
440 entry->c.ops->release(entry, mode,
441 data->file_private_data);
442 break;
443 }
444 module_put(entry->module);
445 kfree(data);
446 return 0;
447}
448
449static unsigned int snd_info_entry_poll(struct file *file, poll_table * wait)
450{
451 struct snd_info_private_data *data;
452 struct snd_info_entry *entry;
453 unsigned int mask;
454
455 data = file->private_data;
456 if (data == NULL)
457 return 0;
458 entry = data->entry;
459 mask = 0;
460 switch (entry->content) {
461 case SNDRV_INFO_CONTENT_DATA:
462 if (entry->c.ops->poll)
463 return entry->c.ops->poll(entry,
464 data->file_private_data,
465 file, wait);
466 if (entry->c.ops->read)
467 mask |= POLLIN | POLLRDNORM;
468 if (entry->c.ops->write)
469 mask |= POLLOUT | POLLWRNORM;
470 break;
471 }
472 return mask;
473}
474
475static long snd_info_entry_ioctl(struct file *file, unsigned int cmd,
476 unsigned long arg)
477{
478 struct snd_info_private_data *data;
479 struct snd_info_entry *entry;
480
481 data = file->private_data;
482 if (data == NULL)
483 return 0;
484 entry = data->entry;
485 switch (entry->content) {
486 case SNDRV_INFO_CONTENT_DATA:
487 if (entry->c.ops->ioctl)
488 return entry->c.ops->ioctl(entry,
489 data->file_private_data,
490 file, cmd, arg);
491 break;
492 }
493 return -ENOTTY;
494}
495
496static int snd_info_entry_mmap(struct file *file, struct vm_area_struct *vma)
497{
498 struct inode *inode = file->f_path.dentry->d_inode;
499 struct snd_info_private_data *data;
500 struct snd_info_entry *entry;
501
502 data = file->private_data;
503 if (data == NULL)
504 return 0;
505 entry = data->entry;
506 switch (entry->content) {
507 case SNDRV_INFO_CONTENT_DATA:
508 if (entry->c.ops->mmap)
509 return entry->c.ops->mmap(entry,
510 data->file_private_data,
511 inode, file, vma);
512 break;
513 }
514 return -ENXIO;
515}
516
517static const struct file_operations snd_info_entry_operations =
518{
519 .owner = THIS_MODULE,
520 .llseek = snd_info_entry_llseek,
521 .read = snd_info_entry_read,
522 .write = snd_info_entry_write,
523 .poll = snd_info_entry_poll,
524 .unlocked_ioctl = snd_info_entry_ioctl,
525 .mmap = snd_info_entry_mmap,
526 .open = snd_info_entry_open,
527 .release = snd_info_entry_release,
528};
529
530int __init snd_info_init(void)
531{
532 struct proc_dir_entry *p;
533
534 p = proc_mkdir("asound", NULL);
535 if (p == NULL)
536 return -ENOMEM;
537 snd_proc_root = p;
538#ifdef CONFIG_SND_OSSEMUL
539 {
540 struct snd_info_entry *entry;
541 if ((entry = snd_info_create_module_entry(THIS_MODULE, "oss", NULL)) == NULL)
542 return -ENOMEM;
543 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
544 if (snd_info_register(entry) < 0) {
545 snd_info_free_entry(entry);
546 return -ENOMEM;
547 }
548 snd_oss_root = entry;
549 }
550#endif
551#if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
552 {
553 struct snd_info_entry *entry;
554 if ((entry = snd_info_create_module_entry(THIS_MODULE, "seq", NULL)) == NULL)
555 return -ENOMEM;
556 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
557 if (snd_info_register(entry) < 0) {
558 snd_info_free_entry(entry);
559 return -ENOMEM;
560 }
561 snd_seq_root = entry;
562 }
563#endif
564 snd_info_version_init();
565 snd_minor_info_init();
566 snd_minor_info_oss_init();
567 snd_card_info_init();
568 return 0;
569}
570
571int __exit snd_info_done(void)
572{
573 snd_card_info_done();
574 snd_minor_info_oss_done();
575 snd_minor_info_done();
576 snd_info_version_done();
577 if (snd_proc_root) {
578#if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
579 snd_info_free_entry(snd_seq_root);
580#endif
581#ifdef CONFIG_SND_OSSEMUL
582 snd_info_free_entry(snd_oss_root);
583#endif
584 snd_remove_proc_entry(NULL, snd_proc_root);
585 }
586 return 0;
587}
588
589/*
590
591 */
592
593
594/*
595 * create a card proc file
596 * called from init.c
597 */
598int snd_info_card_create(struct snd_card *card)
599{
600 char str[8];
601 struct snd_info_entry *entry;
602
603 if (snd_BUG_ON(!card))
604 return -ENXIO;
605
606 sprintf(str, "card%i", card->number);
607 if ((entry = snd_info_create_module_entry(card->module, str, NULL)) == NULL)
608 return -ENOMEM;
609 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
610 if (snd_info_register(entry) < 0) {
611 snd_info_free_entry(entry);
612 return -ENOMEM;
613 }
614 card->proc_root = entry;
615 return 0;
616}
617
618/*
619 * register the card proc file
620 * called from init.c
621 */
622int snd_info_card_register(struct snd_card *card)
623{
624 struct proc_dir_entry *p;
625
626 if (snd_BUG_ON(!card))
627 return -ENXIO;
628
629 if (!strcmp(card->id, card->proc_root->name))
630 return 0;
631
632 p = proc_symlink(card->id, snd_proc_root, card->proc_root->name);
633 if (p == NULL)
634 return -ENOMEM;
635 card->proc_root_link = p;
636 return 0;
637}
638
639/*
640 * called on card->id change
641 */
642void snd_info_card_id_change(struct snd_card *card)
643{
644 mutex_lock(&info_mutex);
645 if (card->proc_root_link) {
646 snd_remove_proc_entry(snd_proc_root, card->proc_root_link);
647 card->proc_root_link = NULL;
648 }
649 if (strcmp(card->id, card->proc_root->name))
650 card->proc_root_link = proc_symlink(card->id,
651 snd_proc_root,
652 card->proc_root->name);
653 mutex_unlock(&info_mutex);
654}
655
656/*
657 * de-register the card proc file
658 * called from init.c
659 */
660void snd_info_card_disconnect(struct snd_card *card)
661{
662 if (!card)
663 return;
664 mutex_lock(&info_mutex);
665 if (card->proc_root_link) {
666 snd_remove_proc_entry(snd_proc_root, card->proc_root_link);
667 card->proc_root_link = NULL;
668 }
669 if (card->proc_root)
670 snd_info_disconnect(card->proc_root);
671 mutex_unlock(&info_mutex);
672}
673
674/*
675 * release the card proc file resources
676 * called from init.c
677 */
678int snd_info_card_free(struct snd_card *card)
679{
680 if (!card)
681 return 0;
682 snd_info_free_entry(card->proc_root);
683 card->proc_root = NULL;
684 return 0;
685}
686
687
688/**
689 * snd_info_get_line - read one line from the procfs buffer
690 * @buffer: the procfs buffer
691 * @line: the buffer to store
692 * @len: the max. buffer size - 1
693 *
694 * Reads one line from the buffer and stores the string.
695 *
696 * Returns zero if successful, or 1 if error or EOF.
697 */
698int snd_info_get_line(struct snd_info_buffer *buffer, char *line, int len)
699{
700 int c = -1;
701
702 if (len <= 0 || buffer->stop || buffer->error)
703 return 1;
704 while (--len > 0) {
705 c = buffer->buffer[buffer->curr++];
706 if (c == '\n') {
707 if (buffer->curr >= buffer->size)
708 buffer->stop = 1;
709 break;
710 }
711 *line++ = c;
712 if (buffer->curr >= buffer->size) {
713 buffer->stop = 1;
714 break;
715 }
716 }
717 while (c != '\n' && !buffer->stop) {
718 c = buffer->buffer[buffer->curr++];
719 if (buffer->curr >= buffer->size)
720 buffer->stop = 1;
721 }
722 *line = '\0';
723 return 0;
724}
725
726EXPORT_SYMBOL(snd_info_get_line);
727
728/**
729 * snd_info_get_str - parse a string token
730 * @dest: the buffer to store the string token
731 * @src: the original string
732 * @len: the max. length of token - 1
733 *
734 * Parses the original string and copy a token to the given
735 * string buffer.
736 *
737 * Returns the updated pointer of the original string so that
738 * it can be used for the next call.
739 */
740const char *snd_info_get_str(char *dest, const char *src, int len)
741{
742 int c;
743
744 while (*src == ' ' || *src == '\t')
745 src++;
746 if (*src == '"' || *src == '\'') {
747 c = *src++;
748 while (--len > 0 && *src && *src != c) {
749 *dest++ = *src++;
750 }
751 if (*src == c)
752 src++;
753 } else {
754 while (--len > 0 && *src && *src != ' ' && *src != '\t') {
755 *dest++ = *src++;
756 }
757 }
758 *dest = 0;
759 while (*src == ' ' || *src == '\t')
760 src++;
761 return src;
762}
763
764EXPORT_SYMBOL(snd_info_get_str);
765
766/**
767 * snd_info_create_entry - create an info entry
768 * @name: the proc file name
769 *
770 * Creates an info entry with the given file name and initializes as
771 * the default state.
772 *
773 * Usually called from other functions such as
774 * snd_info_create_card_entry().
775 *
776 * Returns the pointer of the new instance, or NULL on failure.
777 */
778static struct snd_info_entry *snd_info_create_entry(const char *name)
779{
780 struct snd_info_entry *entry;
781 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
782 if (entry == NULL)
783 return NULL;
784 entry->name = kstrdup(name, GFP_KERNEL);
785 if (entry->name == NULL) {
786 kfree(entry);
787 return NULL;
788 }
789 entry->mode = S_IFREG | S_IRUGO;
790 entry->content = SNDRV_INFO_CONTENT_TEXT;
791 mutex_init(&entry->access);
792 INIT_LIST_HEAD(&entry->children);
793 INIT_LIST_HEAD(&entry->list);
794 return entry;
795}
796
797/**
798 * snd_info_create_module_entry - create an info entry for the given module
799 * @module: the module pointer
800 * @name: the file name
801 * @parent: the parent directory
802 *
803 * Creates a new info entry and assigns it to the given module.
804 *
805 * Returns the pointer of the new instance, or NULL on failure.
806 */
807struct snd_info_entry *snd_info_create_module_entry(struct module * module,
808 const char *name,
809 struct snd_info_entry *parent)
810{
811 struct snd_info_entry *entry = snd_info_create_entry(name);
812 if (entry) {
813 entry->module = module;
814 entry->parent = parent;
815 }
816 return entry;
817}
818
819EXPORT_SYMBOL(snd_info_create_module_entry);
820
821/**
822 * snd_info_create_card_entry - create an info entry for the given card
823 * @card: the card instance
824 * @name: the file name
825 * @parent: the parent directory
826 *
827 * Creates a new info entry and assigns it to the given card.
828 *
829 * Returns the pointer of the new instance, or NULL on failure.
830 */
831struct snd_info_entry *snd_info_create_card_entry(struct snd_card *card,
832 const char *name,
833 struct snd_info_entry * parent)
834{
835 struct snd_info_entry *entry = snd_info_create_entry(name);
836 if (entry) {
837 entry->module = card->module;
838 entry->card = card;
839 entry->parent = parent;
840 }
841 return entry;
842}
843
844EXPORT_SYMBOL(snd_info_create_card_entry);
845
846static void snd_info_disconnect(struct snd_info_entry *entry)
847{
848 struct list_head *p, *n;
849 struct proc_dir_entry *root;
850
851 list_for_each_safe(p, n, &entry->children) {
852 snd_info_disconnect(list_entry(p, struct snd_info_entry, list));
853 }
854
855 if (! entry->p)
856 return;
857 list_del_init(&entry->list);
858 root = entry->parent == NULL ? snd_proc_root : entry->parent->p;
859 snd_BUG_ON(!root);
860 snd_remove_proc_entry(root, entry->p);
861 entry->p = NULL;
862}
863
864static int snd_info_dev_free_entry(struct snd_device *device)
865{
866 struct snd_info_entry *entry = device->device_data;
867 snd_info_free_entry(entry);
868 return 0;
869}
870
871static int snd_info_dev_register_entry(struct snd_device *device)
872{
873 struct snd_info_entry *entry = device->device_data;
874 return snd_info_register(entry);
875}
876
877/**
878 * snd_card_proc_new - create an info entry for the given card
879 * @card: the card instance
880 * @name: the file name
881 * @entryp: the pointer to store the new info entry
882 *
883 * Creates a new info entry and assigns it to the given card.
884 * Unlike snd_info_create_card_entry(), this function registers the
885 * info entry as an ALSA device component, so that it can be
886 * unregistered/released without explicit call.
887 * Also, you don't have to register this entry via snd_info_register(),
888 * since this will be registered by snd_card_register() automatically.
889 *
890 * The parent is assumed as card->proc_root.
891 *
892 * For releasing this entry, use snd_device_free() instead of
893 * snd_info_free_entry().
894 *
895 * Returns zero if successful, or a negative error code on failure.
896 */
897int snd_card_proc_new(struct snd_card *card, const char *name,
898 struct snd_info_entry **entryp)
899{
900 static struct snd_device_ops ops = {
901 .dev_free = snd_info_dev_free_entry,
902 .dev_register = snd_info_dev_register_entry,
903 /* disconnect is done via snd_info_card_disconnect() */
904 };
905 struct snd_info_entry *entry;
906 int err;
907
908 entry = snd_info_create_card_entry(card, name, card->proc_root);
909 if (! entry)
910 return -ENOMEM;
911 if ((err = snd_device_new(card, SNDRV_DEV_INFO, entry, &ops)) < 0) {
912 snd_info_free_entry(entry);
913 return err;
914 }
915 if (entryp)
916 *entryp = entry;
917 return 0;
918}
919
920EXPORT_SYMBOL(snd_card_proc_new);
921
922/**
923 * snd_info_free_entry - release the info entry
924 * @entry: the info entry
925 *
926 * Releases the info entry. Don't call this after registered.
927 */
928void snd_info_free_entry(struct snd_info_entry * entry)
929{
930 if (entry == NULL)
931 return;
932 if (entry->p) {
933 mutex_lock(&info_mutex);
934 snd_info_disconnect(entry);
935 mutex_unlock(&info_mutex);
936 }
937 kfree(entry->name);
938 if (entry->private_free)
939 entry->private_free(entry);
940 kfree(entry);
941}
942
943EXPORT_SYMBOL(snd_info_free_entry);
944
945/**
946 * snd_info_register - register the info entry
947 * @entry: the info entry
948 *
949 * Registers the proc info entry.
950 *
951 * Returns zero if successful, or a negative error code on failure.
952 */
953int snd_info_register(struct snd_info_entry * entry)
954{
955 struct proc_dir_entry *root, *p = NULL;
956
957 if (snd_BUG_ON(!entry))
958 return -ENXIO;
959 root = entry->parent == NULL ? snd_proc_root : entry->parent->p;
960 mutex_lock(&info_mutex);
961 p = create_proc_entry(entry->name, entry->mode, root);
962 if (!p) {
963 mutex_unlock(&info_mutex);
964 return -ENOMEM;
965 }
966 if (!S_ISDIR(entry->mode))
967 p->proc_fops = &snd_info_entry_operations;
968 p->size = entry->size;
969 p->data = entry;
970 entry->p = p;
971 if (entry->parent)
972 list_add_tail(&entry->list, &entry->parent->children);
973 mutex_unlock(&info_mutex);
974 return 0;
975}
976
977EXPORT_SYMBOL(snd_info_register);
978
979/*
980
981 */
982
983static struct snd_info_entry *snd_info_version_entry;
984
985static void snd_info_version_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
986{
987 snd_iprintf(buffer,
988 "Advanced Linux Sound Architecture Driver Version "
989 CONFIG_SND_VERSION CONFIG_SND_DATE ".\n"
990 );
991}
992
993static int __init snd_info_version_init(void)
994{
995 struct snd_info_entry *entry;
996
997 entry = snd_info_create_module_entry(THIS_MODULE, "version", NULL);
998 if (entry == NULL)
999 return -ENOMEM;
1000 entry->c.text.read = snd_info_version_read;
1001 if (snd_info_register(entry) < 0) {
1002 snd_info_free_entry(entry);
1003 return -ENOMEM;
1004 }
1005 snd_info_version_entry = entry;
1006 return 0;
1007}
1008
1009static int __exit snd_info_version_done(void)
1010{
1011 snd_info_free_entry(snd_info_version_entry);
1012 return 0;
1013}
1014
1015#endif /* CONFIG_PROC_FS */