2 * Information interface for ALSA driver
3 * Copyright (c) by Jaroslav Kysela <perex@suse.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 <sound/driver.h>
23 #include <linux/init.h>
24 #include <linux/time.h>
25 #include <linux/smp_lock.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>
41 int snd_info_check_reserved_words(const char *str)
43 static char *reserved[] =
58 char **xstr = reserved;
61 if (!strcmp(*xstr, str))
65 if (!strncmp(str, "card", 4))
70 static DEFINE_MUTEX(info_mutex);
72 struct 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;
79 static int snd_info_version_init(void);
80 static int snd_info_version_done(void);
83 /* resize the proc r/w buffer */
84 static int resize_info_buffer(struct snd_info_buffer *buffer,
89 nsize = PAGE_ALIGN(nsize);
90 nbuf = kmalloc(nsize, GFP_KERNEL);
94 memcpy(nbuf, buffer->buffer, buffer->len);
95 kfree(buffer->buffer);
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, char *fmt,...)
117 if (buffer->stop || buffer->error)
119 len = buffer->len - buffer->size;
122 res = vsnprintf(buffer->buffer + buffer->curr, len, fmt, args);
125 err = resize_info_buffer(buffer, buffer->len + PAGE_SIZE);
128 len = buffer->len - buffer->size;
139 EXPORT_SYMBOL(snd_iprintf);
145 static struct proc_dir_entry *snd_proc_root;
146 struct snd_info_entry *snd_seq_root;
147 EXPORT_SYMBOL(snd_seq_root);
149 #ifdef CONFIG_SND_OSSEMUL
150 struct snd_info_entry *snd_oss_root;
153 static inline void snd_info_entry_prepare(struct proc_dir_entry *de)
155 de->owner = THIS_MODULE;
158 static void snd_remove_proc_entry(struct proc_dir_entry *parent,
159 struct proc_dir_entry *de)
162 remove_proc_entry(de->name, parent);
165 static loff_t snd_info_entry_llseek(struct file *file, loff_t offset, int orig)
167 struct snd_info_private_data *data;
168 struct snd_info_entry *entry;
171 data = file->private_data;
174 switch (entry->content) {
175 case SNDRV_INFO_CONTENT_TEXT:
177 case 0: /* SEEK_SET */
178 file->f_pos = offset;
181 case 1: /* SEEK_CUR */
182 file->f_pos += offset;
185 case 2: /* SEEK_END */
191 case SNDRV_INFO_CONTENT_DATA:
192 if (entry->c.ops->llseek) {
193 ret = entry->c.ops->llseek(entry,
194 data->file_private_data,
206 static ssize_t snd_info_entry_read(struct file *file, char __user *buffer,
207 size_t count, loff_t * offset)
209 struct snd_info_private_data *data;
210 struct snd_info_entry *entry;
211 struct snd_info_buffer *buf;
215 data = file->private_data;
216 snd_assert(data != NULL, return -ENXIO);
218 if (pos < 0 || (long) pos != pos || (ssize_t) count < 0)
220 if ((unsigned long) pos + (unsigned long) count < (unsigned long) pos)
223 switch (entry->content) {
224 case SNDRV_INFO_CONTENT_TEXT:
228 if (pos >= buf->size)
230 size = buf->size - pos;
231 size = min(count, size);
232 if (copy_to_user(buffer, buf->buffer + pos, size))
235 case SNDRV_INFO_CONTENT_DATA:
236 if (entry->c.ops->read)
237 size = entry->c.ops->read(entry,
238 data->file_private_data,
239 file, buffer, count, pos);
242 if ((ssize_t) size > 0)
243 *offset = pos + size;
247 static ssize_t snd_info_entry_write(struct file *file, const char __user *buffer,
248 size_t count, loff_t * offset)
250 struct snd_info_private_data *data;
251 struct snd_info_entry *entry;
252 struct snd_info_buffer *buf;
256 data = file->private_data;
257 snd_assert(data != NULL, return -ENXIO);
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->disconnected) {
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_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 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,
520 * snd_create_proc_entry - create a procfs entry
521 * @name: the name of the proc file
522 * @mode: the file permission bits, S_Ixxx
523 * @parent: the parent proc-directory entry
525 * Creates a new proc file entry with the given name and permission
526 * on the given directory.
528 * Returns the pointer of new instance or NULL on failure.
530 static struct proc_dir_entry *snd_create_proc_entry(const char *name, mode_t mode,
531 struct proc_dir_entry *parent)
533 struct proc_dir_entry *p;
534 p = create_proc_entry(name, mode, parent);
536 snd_info_entry_prepare(p);
540 int __init snd_info_init(void)
542 struct proc_dir_entry *p;
544 p = snd_create_proc_entry("asound", S_IFDIR | S_IRUGO | S_IXUGO, &proc_root);
548 #ifdef CONFIG_SND_OSSEMUL
550 struct snd_info_entry *entry;
551 if ((entry = snd_info_create_module_entry(THIS_MODULE, "oss", NULL)) == NULL)
553 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
554 if (snd_info_register(entry) < 0) {
555 snd_info_free_entry(entry);
558 snd_oss_root = entry;
561 #if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
563 struct snd_info_entry *entry;
564 if ((entry = snd_info_create_module_entry(THIS_MODULE, "seq", NULL)) == NULL)
566 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
567 if (snd_info_register(entry) < 0) {
568 snd_info_free_entry(entry);
571 snd_seq_root = entry;
574 snd_info_version_init();
575 snd_minor_info_init();
576 snd_minor_info_oss_init();
577 snd_card_info_init();
581 int __exit snd_info_done(void)
583 snd_card_info_done();
584 snd_minor_info_oss_done();
585 snd_minor_info_done();
586 snd_info_version_done();
588 #if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
589 snd_info_unregister(snd_seq_root);
591 #ifdef CONFIG_SND_OSSEMUL
592 snd_info_unregister(snd_oss_root);
594 snd_remove_proc_entry(&proc_root, snd_proc_root);
605 * create a card proc file
608 int snd_info_card_create(struct snd_card *card)
611 struct snd_info_entry *entry;
613 snd_assert(card != NULL, return -ENXIO);
615 sprintf(str, "card%i", card->number);
616 if ((entry = snd_info_create_module_entry(card->module, str, NULL)) == NULL)
618 entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
619 if (snd_info_register(entry) < 0) {
620 snd_info_free_entry(entry);
623 card->proc_root = entry;
628 * register the card proc file
631 int snd_info_card_register(struct snd_card *card)
633 struct proc_dir_entry *p;
635 snd_assert(card != NULL, return -ENXIO);
637 if (!strcmp(card->id, card->proc_root->name))
640 p = proc_symlink(card->id, snd_proc_root, card->proc_root->name);
643 card->proc_root_link = p;
648 * de-register the card proc file
651 int snd_info_card_free(struct snd_card *card)
653 snd_assert(card != NULL, return -ENXIO);
654 if (card->proc_root_link) {
655 snd_remove_proc_entry(snd_proc_root, card->proc_root_link);
656 card->proc_root_link = NULL;
658 if (card->proc_root) {
659 snd_info_unregister(card->proc_root);
660 card->proc_root = NULL;
667 * snd_info_get_line - read one line from the procfs buffer
668 * @buffer: the procfs buffer
669 * @line: the buffer to store
670 * @len: the max. buffer size - 1
672 * Reads one line from the buffer and stores the string.
674 * Returns zero if successful, or 1 if error or EOF.
676 int snd_info_get_line(struct snd_info_buffer *buffer, char *line, int len)
680 if (len <= 0 || buffer->stop || buffer->error)
683 c = buffer->buffer[buffer->curr++];
685 if (buffer->curr >= buffer->size)
690 if (buffer->curr >= buffer->size) {
695 while (c != '\n' && !buffer->stop) {
696 c = buffer->buffer[buffer->curr++];
697 if (buffer->curr >= buffer->size)
704 EXPORT_SYMBOL(snd_info_get_line);
707 * snd_info_get_str - parse a string token
708 * @dest: the buffer to store the string token
709 * @src: the original string
710 * @len: the max. length of token - 1
712 * Parses the original string and copy a token to the given
715 * Returns the updated pointer of the original string so that
716 * it can be used for the next call.
718 char *snd_info_get_str(char *dest, char *src, int len)
722 while (*src == ' ' || *src == '\t')
724 if (*src == '"' || *src == '\'') {
726 while (--len > 0 && *src && *src != c) {
732 while (--len > 0 && *src && *src != ' ' && *src != '\t') {
737 while (*src == ' ' || *src == '\t')
742 EXPORT_SYMBOL(snd_info_get_str);
745 * snd_info_create_entry - create an info entry
746 * @name: the proc file name
748 * Creates an info entry with the given file name and initializes as
751 * Usually called from other functions such as
752 * snd_info_create_card_entry().
754 * Returns the pointer of the new instance, or NULL on failure.
756 static struct snd_info_entry *snd_info_create_entry(const char *name)
758 struct snd_info_entry *entry;
759 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
762 entry->name = kstrdup(name, GFP_KERNEL);
763 if (entry->name == NULL) {
767 entry->mode = S_IFREG | S_IRUGO;
768 entry->content = SNDRV_INFO_CONTENT_TEXT;
769 mutex_init(&entry->access);
774 * snd_info_create_module_entry - create an info entry for the given module
775 * @module: the module pointer
776 * @name: the file name
777 * @parent: the parent directory
779 * Creates a new info entry and assigns it to the given module.
781 * Returns the pointer of the new instance, or NULL on failure.
783 struct snd_info_entry *snd_info_create_module_entry(struct module * module,
785 struct snd_info_entry *parent)
787 struct snd_info_entry *entry = snd_info_create_entry(name);
789 entry->module = module;
790 entry->parent = parent;
795 EXPORT_SYMBOL(snd_info_create_module_entry);
798 * snd_info_create_card_entry - create an info entry for the given card
799 * @card: the card instance
800 * @name: the file name
801 * @parent: the parent directory
803 * Creates a new info entry and assigns it to the given card.
805 * Returns the pointer of the new instance, or NULL on failure.
807 struct snd_info_entry *snd_info_create_card_entry(struct snd_card *card,
809 struct snd_info_entry * parent)
811 struct snd_info_entry *entry = snd_info_create_entry(name);
813 entry->module = card->module;
815 entry->parent = parent;
820 EXPORT_SYMBOL(snd_info_create_card_entry);
822 static int snd_info_dev_free_entry(struct snd_device *device)
824 struct snd_info_entry *entry = device->device_data;
825 snd_info_free_entry(entry);
829 static int snd_info_dev_register_entry(struct snd_device *device)
831 struct snd_info_entry *entry = device->device_data;
832 return snd_info_register(entry);
835 static int snd_info_dev_disconnect_entry(struct snd_device *device)
837 struct snd_info_entry *entry = device->device_data;
838 entry->disconnected = 1;
842 static int snd_info_dev_unregister_entry(struct snd_device *device)
844 struct snd_info_entry *entry = device->device_data;
845 return snd_info_unregister(entry);
849 * snd_card_proc_new - create an info entry for the given card
850 * @card: the card instance
851 * @name: the file name
852 * @entryp: the pointer to store the new info entry
854 * Creates a new info entry and assigns it to the given card.
855 * Unlike snd_info_create_card_entry(), this function registers the
856 * info entry as an ALSA device component, so that it can be
857 * unregistered/released without explicit call.
858 * Also, you don't have to register this entry via snd_info_register(),
859 * since this will be registered by snd_card_register() automatically.
861 * The parent is assumed as card->proc_root.
863 * For releasing this entry, use snd_device_free() instead of
864 * snd_info_free_entry().
866 * Returns zero if successful, or a negative error code on failure.
868 int snd_card_proc_new(struct snd_card *card, const char *name,
869 struct snd_info_entry **entryp)
871 static struct snd_device_ops ops = {
872 .dev_free = snd_info_dev_free_entry,
873 .dev_register = snd_info_dev_register_entry,
874 .dev_disconnect = snd_info_dev_disconnect_entry,
875 .dev_unregister = snd_info_dev_unregister_entry
877 struct snd_info_entry *entry;
880 entry = snd_info_create_card_entry(card, name, card->proc_root);
883 if ((err = snd_device_new(card, SNDRV_DEV_INFO, entry, &ops)) < 0) {
884 snd_info_free_entry(entry);
892 EXPORT_SYMBOL(snd_card_proc_new);
895 * snd_info_free_entry - release the info entry
896 * @entry: the info entry
898 * Releases the info entry. Don't call this after registered.
900 void snd_info_free_entry(struct snd_info_entry * entry)
905 if (entry->private_free)
906 entry->private_free(entry);
910 EXPORT_SYMBOL(snd_info_free_entry);
913 * snd_info_register - register the info entry
914 * @entry: the info entry
916 * Registers the proc info entry.
918 * Returns zero if successful, or a negative error code on failure.
920 int snd_info_register(struct snd_info_entry * entry)
922 struct proc_dir_entry *root, *p = NULL;
924 snd_assert(entry != NULL, return -ENXIO);
925 root = entry->parent == NULL ? snd_proc_root : entry->parent->p;
926 mutex_lock(&info_mutex);
927 p = snd_create_proc_entry(entry->name, entry->mode, root);
929 mutex_unlock(&info_mutex);
932 p->owner = entry->module;
933 if (!S_ISDIR(entry->mode))
934 p->proc_fops = &snd_info_entry_operations;
935 p->size = entry->size;
938 mutex_unlock(&info_mutex);
942 EXPORT_SYMBOL(snd_info_register);
945 * snd_info_unregister - de-register the info entry
946 * @entry: the info entry
948 * De-registers the info entry and releases the instance.
950 * Returns zero if successful, or a negative error code on failure.
952 int snd_info_unregister(struct snd_info_entry * entry)
954 struct proc_dir_entry *root;
958 snd_assert(entry->p != NULL, return -ENXIO);
959 root = entry->parent == NULL ? snd_proc_root : entry->parent->p;
960 snd_assert(root, return -ENXIO);
961 mutex_lock(&info_mutex);
962 snd_remove_proc_entry(root, entry->p);
963 mutex_unlock(&info_mutex);
964 snd_info_free_entry(entry);
968 EXPORT_SYMBOL(snd_info_unregister);
974 static struct snd_info_entry *snd_info_version_entry;
976 static void snd_info_version_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
979 "Advanced Linux Sound Architecture Driver Version "
980 CONFIG_SND_VERSION CONFIG_SND_DATE ".\n"
984 static int __init snd_info_version_init(void)
986 struct snd_info_entry *entry;
988 entry = snd_info_create_module_entry(THIS_MODULE, "version", NULL);
991 entry->c.text.read = snd_info_version_read;
992 if (snd_info_register(entry) < 0) {
993 snd_info_free_entry(entry);
996 snd_info_version_entry = entry;
1000 static int __exit snd_info_version_done(void)
1002 if (snd_info_version_entry)
1003 snd_info_unregister(snd_info_version_entry);
1007 #endif /* CONFIG_PROC_FS */