1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Information interface for ALSA driver
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
7 #include <linux/init.h>
8 #include <linux/time.h>
10 #include <linux/slab.h>
11 #include <linux/string.h>
12 #include <linux/module.h>
13 #include <sound/core.h>
14 #include <sound/minors.h>
15 #include <sound/info.h>
16 #include <linux/utsname.h>
17 #include <linux/proc_fs.h>
18 #include <linux/mutex.h>
20 int snd_info_check_reserved_words(const char *str)
22 static const char * const reserved[] =
37 const char * const *xstr = reserved;
40 if (!strcmp(*xstr, str))
44 if (!strncmp(str, "card", 4))
49 static DEFINE_MUTEX(info_mutex);
51 struct snd_info_private_data {
52 struct snd_info_buffer *rbuffer;
53 struct snd_info_buffer *wbuffer;
54 struct snd_info_entry *entry;
55 void *file_private_data;
58 static int snd_info_version_init(void);
59 static void snd_info_disconnect(struct snd_info_entry *entry);
65 static struct snd_info_entry *snd_proc_root;
66 struct snd_info_entry *snd_seq_root;
67 EXPORT_SYMBOL(snd_seq_root);
69 #ifdef CONFIG_SND_OSSEMUL
70 struct snd_info_entry *snd_oss_root;
73 static int alloc_info_private(struct snd_info_entry *entry,
74 struct snd_info_private_data **ret)
76 struct snd_info_private_data *data;
78 if (!entry || !entry->p)
80 if (!try_module_get(entry->module))
82 data = kzalloc(sizeof(*data), GFP_KERNEL);
84 module_put(entry->module);
92 static bool valid_pos(loff_t pos, size_t count)
94 if (pos < 0 || (long) pos != pos || (ssize_t) count < 0)
96 if ((unsigned long) pos + (unsigned long) count < (unsigned long) pos)
102 * file ops for binary proc files
104 static loff_t snd_info_entry_llseek(struct file *file, loff_t offset, int orig)
106 struct snd_info_private_data *data;
107 struct snd_info_entry *entry;
108 loff_t ret = -EINVAL, size;
110 data = file->private_data;
112 mutex_lock(&entry->access);
113 if (entry->c.ops->llseek) {
114 ret = entry->c.ops->llseek(entry,
115 data->file_private_data,
125 offset += file->f_pos;
137 if (size && offset > size)
139 file->f_pos = offset;
142 mutex_unlock(&entry->access);
146 static ssize_t snd_info_entry_read(struct file *file, char __user *buffer,
147 size_t count, loff_t * offset)
149 struct snd_info_private_data *data = file->private_data;
150 struct snd_info_entry *entry = data->entry;
155 if (!valid_pos(pos, count))
157 if (pos >= entry->size)
159 size = entry->size - pos;
160 size = min(count, size);
161 size = entry->c.ops->read(entry, data->file_private_data,
162 file, buffer, size, pos);
163 if ((ssize_t) size > 0)
164 *offset = pos + size;
168 static ssize_t snd_info_entry_write(struct file *file, const char __user *buffer,
169 size_t count, loff_t * offset)
171 struct snd_info_private_data *data = file->private_data;
172 struct snd_info_entry *entry = data->entry;
177 if (!valid_pos(pos, count))
180 size_t maxsize = entry->size - pos;
181 count = min(count, maxsize);
182 size = entry->c.ops->write(entry, data->file_private_data,
183 file, buffer, count, pos);
186 *offset = pos + size;
190 static __poll_t snd_info_entry_poll(struct file *file, poll_table *wait)
192 struct snd_info_private_data *data = file->private_data;
193 struct snd_info_entry *entry = data->entry;
196 if (entry->c.ops->poll)
197 return entry->c.ops->poll(entry,
198 data->file_private_data,
200 if (entry->c.ops->read)
201 mask |= EPOLLIN | EPOLLRDNORM;
202 if (entry->c.ops->write)
203 mask |= EPOLLOUT | EPOLLWRNORM;
207 static long snd_info_entry_ioctl(struct file *file, unsigned int cmd,
210 struct snd_info_private_data *data = file->private_data;
211 struct snd_info_entry *entry = data->entry;
213 if (!entry->c.ops->ioctl)
215 return entry->c.ops->ioctl(entry, data->file_private_data,
219 static int snd_info_entry_mmap(struct file *file, struct vm_area_struct *vma)
221 struct inode *inode = file_inode(file);
222 struct snd_info_private_data *data;
223 struct snd_info_entry *entry;
225 data = file->private_data;
229 if (!entry->c.ops->mmap)
231 return entry->c.ops->mmap(entry, data->file_private_data,
235 static int snd_info_entry_open(struct inode *inode, struct file *file)
237 struct snd_info_entry *entry = pde_data(inode);
238 struct snd_info_private_data *data;
241 mutex_lock(&info_mutex);
242 err = alloc_info_private(entry, &data);
246 mode = file->f_flags & O_ACCMODE;
247 if (((mode == O_RDONLY || mode == O_RDWR) && !entry->c.ops->read) ||
248 ((mode == O_WRONLY || mode == O_RDWR) && !entry->c.ops->write)) {
253 if (entry->c.ops->open) {
254 err = entry->c.ops->open(entry, mode, &data->file_private_data);
259 file->private_data = data;
260 mutex_unlock(&info_mutex);
265 module_put(entry->module);
267 mutex_unlock(&info_mutex);
271 static int snd_info_entry_release(struct inode *inode, struct file *file)
273 struct snd_info_private_data *data = file->private_data;
274 struct snd_info_entry *entry = data->entry;
276 if (entry->c.ops->release)
277 entry->c.ops->release(entry, file->f_flags & O_ACCMODE,
278 data->file_private_data);
279 module_put(entry->module);
284 static const struct proc_ops snd_info_entry_operations =
286 .proc_lseek = snd_info_entry_llseek,
287 .proc_read = snd_info_entry_read,
288 .proc_write = snd_info_entry_write,
289 .proc_poll = snd_info_entry_poll,
290 .proc_ioctl = snd_info_entry_ioctl,
291 .proc_mmap = snd_info_entry_mmap,
292 .proc_open = snd_info_entry_open,
293 .proc_release = snd_info_entry_release,
297 * file ops for text proc files
299 static ssize_t snd_info_text_entry_write(struct file *file,
300 const char __user *buffer,
301 size_t count, loff_t *offset)
303 struct seq_file *m = file->private_data;
304 struct snd_info_private_data *data = m->private;
305 struct snd_info_entry *entry = data->entry;
306 struct snd_info_buffer *buf;
311 if (!entry->c.text.write)
314 if (!valid_pos(pos, count))
317 /* don't handle too large text inputs */
318 if (next > 16 * 1024)
320 mutex_lock(&entry->access);
323 data->wbuffer = buf = kzalloc(sizeof(*buf), GFP_KERNEL);
329 if (next > buf->len) {
330 char *nbuf = kvzalloc(PAGE_ALIGN(next), GFP_KERNEL);
337 buf->len = PAGE_ALIGN(next);
339 if (copy_from_user(buf->buffer + pos, buffer, count)) {
345 mutex_unlock(&entry->access);
352 static int snd_info_seq_show(struct seq_file *seq, void *p)
354 struct snd_info_private_data *data = seq->private;
355 struct snd_info_entry *entry = data->entry;
357 if (!entry->c.text.read) {
360 data->rbuffer->buffer = (char *)seq; /* XXX hack! */
361 entry->c.text.read(entry, data->rbuffer);
366 static int snd_info_text_entry_open(struct inode *inode, struct file *file)
368 struct snd_info_entry *entry = pde_data(inode);
369 struct snd_info_private_data *data;
372 mutex_lock(&info_mutex);
373 err = alloc_info_private(entry, &data);
377 data->rbuffer = kzalloc(sizeof(*data->rbuffer), GFP_KERNEL);
378 if (!data->rbuffer) {
383 err = single_open_size(file, snd_info_seq_show, data,
386 err = single_open(file, snd_info_seq_show, data);
389 mutex_unlock(&info_mutex);
393 kfree(data->rbuffer);
395 module_put(entry->module);
397 mutex_unlock(&info_mutex);
401 static int snd_info_text_entry_release(struct inode *inode, struct file *file)
403 struct seq_file *m = file->private_data;
404 struct snd_info_private_data *data = m->private;
405 struct snd_info_entry *entry = data->entry;
407 if (data->wbuffer && entry->c.text.write)
408 entry->c.text.write(entry, data->wbuffer);
410 single_release(inode, file);
411 kfree(data->rbuffer);
413 kvfree(data->wbuffer->buffer);
414 kfree(data->wbuffer);
417 module_put(entry->module);
422 static const struct proc_ops snd_info_text_entry_ops =
424 .proc_open = snd_info_text_entry_open,
425 .proc_release = snd_info_text_entry_release,
426 .proc_write = snd_info_text_entry_write,
427 .proc_lseek = seq_lseek,
428 .proc_read = seq_read,
431 static struct snd_info_entry *create_subdir(struct module *mod,
434 struct snd_info_entry *entry;
436 entry = snd_info_create_module_entry(mod, name, NULL);
439 entry->mode = S_IFDIR | 0555;
440 if (snd_info_register(entry) < 0) {
441 snd_info_free_entry(entry);
447 static struct snd_info_entry *
448 snd_info_create_entry(const char *name, struct snd_info_entry *parent,
449 struct module *module);
451 int __init snd_info_init(void)
453 snd_proc_root = snd_info_create_entry("asound", NULL, THIS_MODULE);
456 snd_proc_root->mode = S_IFDIR | 0555;
457 snd_proc_root->p = proc_mkdir("asound", NULL);
458 if (!snd_proc_root->p)
460 #ifdef CONFIG_SND_OSSEMUL
461 snd_oss_root = create_subdir(THIS_MODULE, "oss");
465 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
466 snd_seq_root = create_subdir(THIS_MODULE, "seq");
470 if (snd_info_version_init() < 0 ||
471 snd_minor_info_init() < 0 ||
472 snd_minor_info_oss_init() < 0 ||
473 snd_card_info_init() < 0 ||
474 snd_info_minor_register() < 0)
479 snd_info_free_entry(snd_proc_root);
483 int __exit snd_info_done(void)
485 snd_info_free_entry(snd_proc_root);
489 static void snd_card_id_read(struct snd_info_entry *entry,
490 struct snd_info_buffer *buffer)
492 struct snd_card *card = entry->private_data;
494 snd_iprintf(buffer, "%s\n", card->id);
498 * create a card proc file
501 int snd_info_card_create(struct snd_card *card)
504 struct snd_info_entry *entry;
506 if (snd_BUG_ON(!card))
509 sprintf(str, "card%i", card->number);
510 entry = create_subdir(card->module, str);
513 card->proc_root = entry;
515 return snd_card_ro_proc_new(card, "id", card, snd_card_id_read);
519 * register the card proc file
521 * can be called multiple times for reinitialization
523 int snd_info_card_register(struct snd_card *card)
525 struct proc_dir_entry *p;
528 if (snd_BUG_ON(!card))
531 err = snd_info_register(card->proc_root);
535 if (!strcmp(card->id, card->proc_root->name))
538 if (card->proc_root_link)
540 p = proc_symlink(card->id, snd_proc_root->p, card->proc_root->name);
543 card->proc_root_link = p;
548 * called on card->id change
550 void snd_info_card_id_change(struct snd_card *card)
552 mutex_lock(&info_mutex);
553 if (card->proc_root_link) {
554 proc_remove(card->proc_root_link);
555 card->proc_root_link = NULL;
557 if (strcmp(card->id, card->proc_root->name))
558 card->proc_root_link = proc_symlink(card->id,
560 card->proc_root->name);
561 mutex_unlock(&info_mutex);
565 * de-register the card proc file
568 void snd_info_card_disconnect(struct snd_card *card)
572 mutex_lock(&info_mutex);
573 proc_remove(card->proc_root_link);
574 card->proc_root_link = NULL;
576 snd_info_disconnect(card->proc_root);
577 mutex_unlock(&info_mutex);
581 * release the card proc file resources
584 int snd_info_card_free(struct snd_card *card)
588 snd_info_free_entry(card->proc_root);
589 card->proc_root = NULL;
595 * snd_info_get_line - read one line from the procfs buffer
596 * @buffer: the procfs buffer
597 * @line: the buffer to store
598 * @len: the max. buffer size
600 * Reads one line from the buffer and stores the string.
602 * Return: Zero if successful, or 1 if error or EOF.
604 int snd_info_get_line(struct snd_info_buffer *buffer, char *line, int len)
608 if (snd_BUG_ON(!buffer))
612 if (len <= 0 || buffer->stop || buffer->error)
614 while (!buffer->stop) {
615 c = buffer->buffer[buffer->curr++];
616 if (buffer->curr >= buffer->size)
628 EXPORT_SYMBOL(snd_info_get_line);
631 * snd_info_get_str - parse a string token
632 * @dest: the buffer to store the string token
633 * @src: the original string
634 * @len: the max. length of token - 1
636 * Parses the original string and copy a token to the given
639 * Return: The updated pointer of the original string so that
640 * it can be used for the next call.
642 const char *snd_info_get_str(char *dest, const char *src, int len)
646 while (*src == ' ' || *src == '\t')
648 if (*src == '"' || *src == '\'') {
650 while (--len > 0 && *src && *src != c) {
656 while (--len > 0 && *src && *src != ' ' && *src != '\t') {
661 while (*src == ' ' || *src == '\t')
665 EXPORT_SYMBOL(snd_info_get_str);
668 * snd_info_create_entry - create an info entry
669 * @name: the proc file name
670 * @parent: the parent directory
672 * Creates an info entry with the given file name and initializes as
675 * Usually called from other functions such as
676 * snd_info_create_card_entry().
678 * Return: The pointer of the new instance, or %NULL on failure.
680 static struct snd_info_entry *
681 snd_info_create_entry(const char *name, struct snd_info_entry *parent,
682 struct module *module)
684 struct snd_info_entry *entry;
685 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
688 entry->name = kstrdup(name, GFP_KERNEL);
689 if (entry->name == NULL) {
693 entry->mode = S_IFREG | 0444;
694 entry->content = SNDRV_INFO_CONTENT_TEXT;
695 mutex_init(&entry->access);
696 INIT_LIST_HEAD(&entry->children);
697 INIT_LIST_HEAD(&entry->list);
698 entry->parent = parent;
699 entry->module = module;
701 mutex_lock(&parent->access);
702 list_add_tail(&entry->list, &parent->children);
703 mutex_unlock(&parent->access);
709 * snd_info_create_module_entry - create an info entry for the given module
710 * @module: the module pointer
711 * @name: the file name
712 * @parent: the parent directory
714 * Creates a new info entry and assigns it to the given module.
716 * Return: The pointer of the new instance, or %NULL on failure.
718 struct snd_info_entry *snd_info_create_module_entry(struct module * module,
720 struct snd_info_entry *parent)
723 parent = snd_proc_root;
724 return snd_info_create_entry(name, parent, module);
726 EXPORT_SYMBOL(snd_info_create_module_entry);
729 * snd_info_create_card_entry - create an info entry for the given card
730 * @card: the card instance
731 * @name: the file name
732 * @parent: the parent directory
734 * Creates a new info entry and assigns it to the given card.
736 * Return: The pointer of the new instance, or %NULL on failure.
738 struct snd_info_entry *snd_info_create_card_entry(struct snd_card *card,
740 struct snd_info_entry * parent)
743 parent = card->proc_root;
744 return snd_info_create_entry(name, parent, card->module);
746 EXPORT_SYMBOL(snd_info_create_card_entry);
748 static void snd_info_disconnect(struct snd_info_entry *entry)
750 struct snd_info_entry *p;
754 list_for_each_entry(p, &entry->children, list)
755 snd_info_disconnect(p);
756 proc_remove(entry->p);
761 * snd_info_free_entry - release the info entry
762 * @entry: the info entry
764 * Releases the info entry.
766 void snd_info_free_entry(struct snd_info_entry * entry)
768 struct snd_info_entry *p, *n;
773 mutex_lock(&info_mutex);
774 snd_info_disconnect(entry);
775 mutex_unlock(&info_mutex);
778 /* free all children at first */
779 list_for_each_entry_safe(p, n, &entry->children, list)
780 snd_info_free_entry(p);
784 mutex_lock(&p->access);
785 list_del(&entry->list);
786 mutex_unlock(&p->access);
789 if (entry->private_free)
790 entry->private_free(entry);
793 EXPORT_SYMBOL(snd_info_free_entry);
795 static int __snd_info_register(struct snd_info_entry *entry)
797 struct proc_dir_entry *root, *p = NULL;
799 if (snd_BUG_ON(!entry))
801 root = entry->parent == NULL ? snd_proc_root->p : entry->parent->p;
802 mutex_lock(&info_mutex);
803 if (entry->p || !root)
805 if (S_ISDIR(entry->mode)) {
806 p = proc_mkdir_mode(entry->name, entry->mode, root);
808 mutex_unlock(&info_mutex);
812 const struct proc_ops *ops;
813 if (entry->content == SNDRV_INFO_CONTENT_DATA)
814 ops = &snd_info_entry_operations;
816 ops = &snd_info_text_entry_ops;
817 p = proc_create_data(entry->name, entry->mode, root,
820 mutex_unlock(&info_mutex);
823 proc_set_size(p, entry->size);
827 mutex_unlock(&info_mutex);
832 * snd_info_register - register the info entry
833 * @entry: the info entry
835 * Registers the proc info entry.
836 * The all children entries are registered recursively.
838 * Return: Zero if successful, or a negative error code on failure.
840 int snd_info_register(struct snd_info_entry *entry)
842 struct snd_info_entry *p;
846 err = __snd_info_register(entry);
851 list_for_each_entry(p, &entry->children, list) {
852 err = snd_info_register(p);
859 EXPORT_SYMBOL(snd_info_register);
862 * snd_card_rw_proc_new - Create a read/write text proc file entry for the card
863 * @card: the card instance
864 * @name: the file name
865 * @private_data: the arbitrary private data
866 * @read: the read callback
867 * @write: the write callback, NULL for read-only
869 * This proc file entry will be registered via snd_card_register() call, and
870 * it will be removed automatically at the card removal, too.
872 * Return: zero if successful, or a negative error code
874 int snd_card_rw_proc_new(struct snd_card *card, const char *name,
876 void (*read)(struct snd_info_entry *,
877 struct snd_info_buffer *),
878 void (*write)(struct snd_info_entry *entry,
879 struct snd_info_buffer *buffer))
881 struct snd_info_entry *entry;
883 entry = snd_info_create_card_entry(card, name, card->proc_root);
886 snd_info_set_text_ops(entry, private_data, read);
889 entry->c.text.write = write;
893 EXPORT_SYMBOL_GPL(snd_card_rw_proc_new);
899 static void snd_info_version_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
902 "Advanced Linux Sound Architecture Driver Version k%s.\n",
903 init_utsname()->release);
906 static int __init snd_info_version_init(void)
908 struct snd_info_entry *entry;
910 entry = snd_info_create_module_entry(THIS_MODULE, "version", NULL);
913 entry->c.text.read = snd_info_version_read;
914 return snd_info_register(entry); /* freed in error path */