2 * Information interface for ALSA driver
3 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
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.
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.
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
22 #include <linux/init.h>
23 #include <linux/time.h>
25 #include <linux/slab.h>
26 #include <linux/smp_lock.h>
27 #include <linux/string.h>
28 #include <sound/core.h>
29 #include <sound/minors.h>
30 #include <sound/info.h>
31 #include <sound/version.h>
32 #include <linux/proc_fs.h>
33 #include <linux/mutex.h>
42 int snd_info_check_reserved_words(const char *str)
44 static char *reserved[] =
59 char **xstr = reserved;
62 if (!strcmp(*xstr, str))
66 if (!strncmp(str, "card", 4))
71 static DEFINE_MUTEX(info_mutex);
73 struct 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;
80 static int snd_info_version_init(void);
81 static int snd_info_version_done(void);
82 static void snd_info_disconnect(struct snd_info_entry *entry);
85 /* resize the proc r/w buffer */
86 static int resize_info_buffer(struct snd_info_buffer *buffer,
91 nsize = PAGE_ALIGN(nsize);
92 nbuf = krealloc(buffer->buffer, nsize, GFP_KERNEL);
96 buffer->buffer = nbuf;
102 * snd_iprintf - printf on the procfs buffer
103 * @buffer: the procfs buffer
104 * @fmt: the printf format
106 * Outputs the string on the procfs buffer just like printf().
108 * Returns the size of output string.
110 int snd_iprintf(struct snd_info_buffer *buffer, const char *fmt, ...)
117 if (buffer->stop || buffer->error)
119 len = buffer->len - buffer->size;
124 res = vsnprintf(buffer->buffer + buffer->curr, len, fmt, ap);
128 err = resize_info_buffer(buffer, buffer->len + PAGE_SIZE);
131 len = buffer->len - buffer->size;
142 EXPORT_SYMBOL(snd_iprintf);
148 static struct proc_dir_entry *snd_proc_root;
149 struct snd_info_entry *snd_seq_root;
150 EXPORT_SYMBOL(snd_seq_root);
152 #ifdef CONFIG_SND_OSSEMUL
153 struct snd_info_entry *snd_oss_root;
156 static void snd_remove_proc_entry(struct proc_dir_entry *parent,
157 struct proc_dir_entry *de)
160 remove_proc_entry(de->name, parent);
163 static loff_t snd_info_entry_llseek(struct file *file, loff_t offset, int orig)
165 struct snd_info_private_data *data;
166 struct snd_info_entry *entry;
169 data = file->private_data;
172 switch (entry->content) {
173 case SNDRV_INFO_CONTENT_TEXT:
176 file->f_pos = offset;
180 file->f_pos += offset;
189 case SNDRV_INFO_CONTENT_DATA:
190 if (entry->c.ops->llseek) {
191 ret = entry->c.ops->llseek(entry,
192 data->file_private_data,
204 static ssize_t snd_info_entry_read(struct file *file, char __user *buffer,
205 size_t count, loff_t * offset)
207 struct snd_info_private_data *data;
208 struct snd_info_entry *entry;
209 struct snd_info_buffer *buf;
213 data = file->private_data;
214 if (snd_BUG_ON(!data))
217 if (pos < 0 || (long) pos != pos || (ssize_t) count < 0)
219 if ((unsigned long) pos + (unsigned long) count < (unsigned long) pos)
222 switch (entry->content) {
223 case SNDRV_INFO_CONTENT_TEXT:
227 if (pos >= buf->size)
229 size = buf->size - pos;
230 size = min(count, size);
231 if (copy_to_user(buffer, buf->buffer + pos, size))
234 case SNDRV_INFO_CONTENT_DATA:
235 if (entry->c.ops->read)
236 size = entry->c.ops->read(entry,
237 data->file_private_data,
238 file, buffer, count, pos);
241 if ((ssize_t) size > 0)
242 *offset = pos + size;
246 static ssize_t snd_info_entry_write(struct file *file, const char __user *buffer,
247 size_t count, loff_t * offset)
249 struct snd_info_private_data *data;
250 struct snd_info_entry *entry;
251 struct snd_info_buffer *buf;
255 data = file->private_data;
256 if (snd_BUG_ON(!data))
260 if (pos < 0 || (long) pos != pos || (ssize_t) count < 0)
262 if ((unsigned long) pos + (unsigned long) count < (unsigned long) pos)
264 switch (entry->content) {
265 case SNDRV_INFO_CONTENT_TEXT:
269 mutex_lock(&entry->access);
270 if (pos + count >= buf->len) {
271 if (resize_info_buffer(buf, pos + count)) {
272 mutex_unlock(&entry->access);
276 if (copy_from_user(buf->buffer + pos, buffer, count)) {
277 mutex_unlock(&entry->access);
280 buf->size = pos + count;
281 mutex_unlock(&entry->access);
284 case SNDRV_INFO_CONTENT_DATA:
285 if (entry->c.ops->write)
286 size = entry->c.ops->write(entry,
287 data->file_private_data,
288 file, buffer, count, pos);
291 if ((ssize_t) size > 0)
292 *offset = pos + size;
296 static int snd_info_entry_open(struct inode *inode, struct file *file)
298 struct snd_info_entry *entry;
299 struct snd_info_private_data *data;
300 struct snd_info_buffer *buffer;
301 struct proc_dir_entry *p;
304 mutex_lock(&info_mutex);
306 entry = p == NULL ? NULL : (struct snd_info_entry *)p->data;
307 if (entry == NULL || ! entry->p) {
308 mutex_unlock(&info_mutex);
311 if (!try_module_get(entry->module)) {
315 mode = file->f_flags & O_ACCMODE;
316 if (mode == O_RDONLY || mode == O_RDWR) {
317 if ((entry->content == SNDRV_INFO_CONTENT_DATA &&
318 entry->c.ops->read == NULL)) {
323 if (mode == O_WRONLY || mode == O_RDWR) {
324 if ((entry->content == SNDRV_INFO_CONTENT_DATA &&
325 entry->c.ops->write == NULL)) {
330 data = kzalloc(sizeof(*data), GFP_KERNEL);
336 switch (entry->content) {
337 case SNDRV_INFO_CONTENT_TEXT:
338 if (mode == O_RDONLY || mode == O_RDWR) {
339 buffer = kzalloc(sizeof(*buffer), GFP_KERNEL);
342 data->rbuffer = buffer;
343 buffer->len = PAGE_SIZE;
344 buffer->buffer = kmalloc(buffer->len, GFP_KERNEL);
345 if (buffer->buffer == NULL)
348 if (mode == O_WRONLY || mode == O_RDWR) {
349 buffer = kzalloc(sizeof(*buffer), GFP_KERNEL);
352 data->wbuffer = buffer;
353 buffer->len = PAGE_SIZE;
354 buffer->buffer = kmalloc(buffer->len, GFP_KERNEL);
355 if (buffer->buffer == NULL)
359 case SNDRV_INFO_CONTENT_DATA: /* data */
360 if (entry->c.ops->open) {
361 if ((err = entry->c.ops->open(entry, mode,
362 &data->file_private_data)) < 0) {
369 file->private_data = data;
370 mutex_unlock(&info_mutex);
371 if (entry->content == SNDRV_INFO_CONTENT_TEXT &&
372 (mode == O_RDONLY || mode == O_RDWR)) {
373 if (entry->c.text.read) {
374 mutex_lock(&entry->access);
375 entry->c.text.read(entry, data->rbuffer);
376 mutex_unlock(&entry->access);
383 kfree(data->rbuffer->buffer);
384 kfree(data->rbuffer);
387 kfree(data->wbuffer->buffer);
388 kfree(data->wbuffer);
393 module_put(entry->module);
395 mutex_unlock(&info_mutex);
399 static int snd_info_entry_release(struct inode *inode, struct file *file)
401 struct snd_info_entry *entry;
402 struct snd_info_private_data *data;
405 mode = file->f_flags & O_ACCMODE;
406 data = file->private_data;
408 switch (entry->content) {
409 case SNDRV_INFO_CONTENT_TEXT:
411 kfree(data->rbuffer->buffer);
412 kfree(data->rbuffer);
415 if (entry->c.text.write) {
416 entry->c.text.write(entry, data->wbuffer);
417 if (data->wbuffer->error) {
418 snd_printk(KERN_WARNING "data write error to %s (%i)\n",
420 data->wbuffer->error);
423 kfree(data->wbuffer->buffer);
424 kfree(data->wbuffer);
427 case SNDRV_INFO_CONTENT_DATA:
428 if (entry->c.ops->release)
429 entry->c.ops->release(entry, mode,
430 data->file_private_data);
433 module_put(entry->module);
438 static unsigned int snd_info_entry_poll(struct file *file, poll_table * wait)
440 struct snd_info_private_data *data;
441 struct snd_info_entry *entry;
444 data = file->private_data;
449 switch (entry->content) {
450 case SNDRV_INFO_CONTENT_DATA:
451 if (entry->c.ops->poll)
452 return entry->c.ops->poll(entry,
453 data->file_private_data,
455 if (entry->c.ops->read)
456 mask |= POLLIN | POLLRDNORM;
457 if (entry->c.ops->write)
458 mask |= POLLOUT | POLLWRNORM;
464 static long snd_info_entry_ioctl(struct file *file, unsigned int cmd,
467 struct snd_info_private_data *data;
468 struct snd_info_entry *entry;
470 data = file->private_data;
474 switch (entry->content) {
475 case SNDRV_INFO_CONTENT_DATA:
476 if (entry->c.ops->ioctl)
477 return entry->c.ops->ioctl(entry,
478 data->file_private_data,
485 static int snd_info_entry_mmap(struct file *file, struct vm_area_struct *vma)
487 struct inode *inode = file->f_path.dentry->d_inode;
488 struct snd_info_private_data *data;
489 struct snd_info_entry *entry;
491 data = file->private_data;
495 switch (entry->content) {
496 case SNDRV_INFO_CONTENT_DATA:
497 if (entry->c.ops->mmap)
498 return entry->c.ops->mmap(entry,
499 data->file_private_data,
506 static const struct file_operations snd_info_entry_operations =
508 .owner = THIS_MODULE,
509 .llseek = snd_info_entry_llseek,
510 .read = snd_info_entry_read,
511 .write = snd_info_entry_write,
512 .poll = snd_info_entry_poll,
513 .unlocked_ioctl = snd_info_entry_ioctl,
514 .mmap = snd_info_entry_mmap,
515 .open = snd_info_entry_open,
516 .release = snd_info_entry_release,
519 int __init snd_info_init(void)
521 struct proc_dir_entry *p;
523 p = create_proc_entry("asound", S_IFDIR | S_IRUGO | S_IXUGO, NULL);
527 #ifdef CONFIG_SND_OSSEMUL
529 struct snd_info_entry *entry;
530 if ((entry = snd_info_create_module_entry(THIS_MODULE, "oss", NULL)) == NULL)
532 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
533 if (snd_info_register(entry) < 0) {
534 snd_info_free_entry(entry);
537 snd_oss_root = entry;
540 #if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
542 struct snd_info_entry *entry;
543 if ((entry = snd_info_create_module_entry(THIS_MODULE, "seq", NULL)) == NULL)
545 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
546 if (snd_info_register(entry) < 0) {
547 snd_info_free_entry(entry);
550 snd_seq_root = entry;
553 snd_info_version_init();
554 snd_minor_info_init();
555 snd_minor_info_oss_init();
556 snd_card_info_init();
560 int __exit snd_info_done(void)
562 snd_card_info_done();
563 snd_minor_info_oss_done();
564 snd_minor_info_done();
565 snd_info_version_done();
567 #if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
568 snd_info_free_entry(snd_seq_root);
570 #ifdef CONFIG_SND_OSSEMUL
571 snd_info_free_entry(snd_oss_root);
573 snd_remove_proc_entry(NULL, snd_proc_root);
584 * create a card proc file
587 int snd_info_card_create(struct snd_card *card)
590 struct snd_info_entry *entry;
592 if (snd_BUG_ON(!card))
595 sprintf(str, "card%i", card->number);
596 if ((entry = snd_info_create_module_entry(card->module, str, NULL)) == NULL)
598 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
599 if (snd_info_register(entry) < 0) {
600 snd_info_free_entry(entry);
603 card->proc_root = entry;
608 * register the card proc file
611 int snd_info_card_register(struct snd_card *card)
613 struct proc_dir_entry *p;
615 if (snd_BUG_ON(!card))
618 if (!strcmp(card->id, card->proc_root->name))
621 p = proc_symlink(card->id, snd_proc_root, card->proc_root->name);
624 card->proc_root_link = p;
629 * called on card->id change
631 void snd_info_card_id_change(struct snd_card *card)
633 mutex_lock(&info_mutex);
634 if (card->proc_root_link) {
635 snd_remove_proc_entry(snd_proc_root, card->proc_root_link);
636 card->proc_root_link = NULL;
638 if (strcmp(card->id, card->proc_root->name))
639 card->proc_root_link = proc_symlink(card->id,
641 card->proc_root->name);
642 mutex_unlock(&info_mutex);
646 * de-register the card proc file
649 void snd_info_card_disconnect(struct snd_card *card)
653 mutex_lock(&info_mutex);
654 if (card->proc_root_link) {
655 snd_remove_proc_entry(snd_proc_root, card->proc_root_link);
656 card->proc_root_link = NULL;
659 snd_info_disconnect(card->proc_root);
660 mutex_unlock(&info_mutex);
664 * release the card proc file resources
667 int snd_info_card_free(struct snd_card *card)
671 snd_info_free_entry(card->proc_root);
672 card->proc_root = NULL;
678 * snd_info_get_line - read one line from the procfs buffer
679 * @buffer: the procfs buffer
680 * @line: the buffer to store
681 * @len: the max. buffer size - 1
683 * Reads one line from the buffer and stores the string.
685 * Returns zero if successful, or 1 if error or EOF.
687 int snd_info_get_line(struct snd_info_buffer *buffer, char *line, int len)
691 if (len <= 0 || buffer->stop || buffer->error)
694 c = buffer->buffer[buffer->curr++];
696 if (buffer->curr >= buffer->size)
701 if (buffer->curr >= buffer->size) {
706 while (c != '\n' && !buffer->stop) {
707 c = buffer->buffer[buffer->curr++];
708 if (buffer->curr >= buffer->size)
715 EXPORT_SYMBOL(snd_info_get_line);
718 * snd_info_get_str - parse a string token
719 * @dest: the buffer to store the string token
720 * @src: the original string
721 * @len: the max. length of token - 1
723 * Parses the original string and copy a token to the given
726 * Returns the updated pointer of the original string so that
727 * it can be used for the next call.
729 const char *snd_info_get_str(char *dest, const char *src, int len)
733 while (*src == ' ' || *src == '\t')
735 if (*src == '"' || *src == '\'') {
737 while (--len > 0 && *src && *src != c) {
743 while (--len > 0 && *src && *src != ' ' && *src != '\t') {
748 while (*src == ' ' || *src == '\t')
753 EXPORT_SYMBOL(snd_info_get_str);
756 * snd_info_create_entry - create an info entry
757 * @name: the proc file name
759 * Creates an info entry with the given file name and initializes as
762 * Usually called from other functions such as
763 * snd_info_create_card_entry().
765 * Returns the pointer of the new instance, or NULL on failure.
767 static struct snd_info_entry *snd_info_create_entry(const char *name)
769 struct snd_info_entry *entry;
770 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
773 entry->name = kstrdup(name, GFP_KERNEL);
774 if (entry->name == NULL) {
778 entry->mode = S_IFREG | S_IRUGO;
779 entry->content = SNDRV_INFO_CONTENT_TEXT;
780 mutex_init(&entry->access);
781 INIT_LIST_HEAD(&entry->children);
782 INIT_LIST_HEAD(&entry->list);
787 * snd_info_create_module_entry - create an info entry for the given module
788 * @module: the module pointer
789 * @name: the file name
790 * @parent: the parent directory
792 * Creates a new info entry and assigns it to the given module.
794 * Returns the pointer of the new instance, or NULL on failure.
796 struct snd_info_entry *snd_info_create_module_entry(struct module * module,
798 struct snd_info_entry *parent)
800 struct snd_info_entry *entry = snd_info_create_entry(name);
802 entry->module = module;
803 entry->parent = parent;
808 EXPORT_SYMBOL(snd_info_create_module_entry);
811 * snd_info_create_card_entry - create an info entry for the given card
812 * @card: the card instance
813 * @name: the file name
814 * @parent: the parent directory
816 * Creates a new info entry and assigns it to the given card.
818 * Returns the pointer of the new instance, or NULL on failure.
820 struct snd_info_entry *snd_info_create_card_entry(struct snd_card *card,
822 struct snd_info_entry * parent)
824 struct snd_info_entry *entry = snd_info_create_entry(name);
826 entry->module = card->module;
828 entry->parent = parent;
833 EXPORT_SYMBOL(snd_info_create_card_entry);
835 static void snd_info_disconnect(struct snd_info_entry *entry)
837 struct list_head *p, *n;
838 struct proc_dir_entry *root;
840 list_for_each_safe(p, n, &entry->children) {
841 snd_info_disconnect(list_entry(p, struct snd_info_entry, list));
846 list_del_init(&entry->list);
847 root = entry->parent == NULL ? snd_proc_root : entry->parent->p;
849 snd_remove_proc_entry(root, entry->p);
853 static int snd_info_dev_free_entry(struct snd_device *device)
855 struct snd_info_entry *entry = device->device_data;
856 snd_info_free_entry(entry);
860 static int snd_info_dev_register_entry(struct snd_device *device)
862 struct snd_info_entry *entry = device->device_data;
863 return snd_info_register(entry);
867 * snd_card_proc_new - create an info entry for the given card
868 * @card: the card instance
869 * @name: the file name
870 * @entryp: the pointer to store the new info entry
872 * Creates a new info entry and assigns it to the given card.
873 * Unlike snd_info_create_card_entry(), this function registers the
874 * info entry as an ALSA device component, so that it can be
875 * unregistered/released without explicit call.
876 * Also, you don't have to register this entry via snd_info_register(),
877 * since this will be registered by snd_card_register() automatically.
879 * The parent is assumed as card->proc_root.
881 * For releasing this entry, use snd_device_free() instead of
882 * snd_info_free_entry().
884 * Returns zero if successful, or a negative error code on failure.
886 int snd_card_proc_new(struct snd_card *card, const char *name,
887 struct snd_info_entry **entryp)
889 static struct snd_device_ops ops = {
890 .dev_free = snd_info_dev_free_entry,
891 .dev_register = snd_info_dev_register_entry,
892 /* disconnect is done via snd_info_card_disconnect() */
894 struct snd_info_entry *entry;
897 entry = snd_info_create_card_entry(card, name, card->proc_root);
900 if ((err = snd_device_new(card, SNDRV_DEV_INFO, entry, &ops)) < 0) {
901 snd_info_free_entry(entry);
909 EXPORT_SYMBOL(snd_card_proc_new);
912 * snd_info_free_entry - release the info entry
913 * @entry: the info entry
915 * Releases the info entry. Don't call this after registered.
917 void snd_info_free_entry(struct snd_info_entry * entry)
922 mutex_lock(&info_mutex);
923 snd_info_disconnect(entry);
924 mutex_unlock(&info_mutex);
927 if (entry->private_free)
928 entry->private_free(entry);
932 EXPORT_SYMBOL(snd_info_free_entry);
935 * snd_info_register - register the info entry
936 * @entry: the info entry
938 * Registers the proc info entry.
940 * Returns zero if successful, or a negative error code on failure.
942 int snd_info_register(struct snd_info_entry * entry)
944 struct proc_dir_entry *root, *p = NULL;
946 if (snd_BUG_ON(!entry))
948 root = entry->parent == NULL ? snd_proc_root : entry->parent->p;
949 mutex_lock(&info_mutex);
950 p = create_proc_entry(entry->name, entry->mode, root);
952 mutex_unlock(&info_mutex);
955 if (!S_ISDIR(entry->mode))
956 p->proc_fops = &snd_info_entry_operations;
957 p->size = entry->size;
961 list_add_tail(&entry->list, &entry->parent->children);
962 mutex_unlock(&info_mutex);
966 EXPORT_SYMBOL(snd_info_register);
972 static struct snd_info_entry *snd_info_version_entry;
974 static void snd_info_version_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
977 "Advanced Linux Sound Architecture Driver Version "
978 CONFIG_SND_VERSION CONFIG_SND_DATE ".\n"
982 static int __init snd_info_version_init(void)
984 struct snd_info_entry *entry;
986 entry = snd_info_create_module_entry(THIS_MODULE, "version", NULL);
989 entry->c.text.read = snd_info_version_read;
990 if (snd_info_register(entry) < 0) {
991 snd_info_free_entry(entry);
994 snd_info_version_entry = entry;
998 static int __exit snd_info_version_done(void)
1000 snd_info_free_entry(snd_info_version_entry);
1004 #endif /* CONFIG_PROC_FS */