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