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>
21 int snd_info_check_reserved_words(const char *str)
23 static char *reserved[] =
38 char **xstr = reserved;
41 if (!strcmp(*xstr, str))
45 if (!strncmp(str, "card", 4))
50 static DEFINE_MUTEX(info_mutex);
52 struct snd_info_private_data {
53 struct snd_info_buffer *rbuffer;
54 struct snd_info_buffer *wbuffer;
55 struct snd_info_entry *entry;
56 void *file_private_data;
59 static int snd_info_version_init(void);
60 static void snd_info_disconnect(struct snd_info_entry *entry);
66 static struct snd_info_entry *snd_proc_root;
67 struct snd_info_entry *snd_seq_root;
68 EXPORT_SYMBOL(snd_seq_root);
70 #ifdef CONFIG_SND_OSSEMUL
71 struct snd_info_entry *snd_oss_root;
74 static int alloc_info_private(struct snd_info_entry *entry,
75 struct snd_info_private_data **ret)
77 struct snd_info_private_data *data;
79 if (!entry || !entry->p)
81 if (!try_module_get(entry->module))
83 data = kzalloc(sizeof(*data), GFP_KERNEL);
85 module_put(entry->module);
93 static bool valid_pos(loff_t pos, size_t count)
95 if (pos < 0 || (long) pos != pos || (ssize_t) count < 0)
97 if ((unsigned long) pos + (unsigned long) count < (unsigned long) pos)
103 * file ops for binary proc files
105 static loff_t snd_info_entry_llseek(struct file *file, loff_t offset, int orig)
107 struct snd_info_private_data *data;
108 struct snd_info_entry *entry;
109 loff_t ret = -EINVAL, size;
111 data = file->private_data;
113 mutex_lock(&entry->access);
114 if (entry->c.ops->llseek) {
115 offset = entry->c.ops->llseek(entry,
116 data->file_private_data,
126 offset += file->f_pos;
138 if (size && offset > size)
140 file->f_pos = offset;
143 mutex_unlock(&entry->access);
147 static ssize_t snd_info_entry_read(struct file *file, char __user *buffer,
148 size_t count, loff_t * offset)
150 struct snd_info_private_data *data = file->private_data;
151 struct snd_info_entry *entry = data->entry;
156 if (!valid_pos(pos, count))
158 if (pos >= entry->size)
160 size = entry->size - pos;
161 size = min(count, size);
162 size = entry->c.ops->read(entry, data->file_private_data,
163 file, buffer, size, pos);
164 if ((ssize_t) size > 0)
165 *offset = pos + size;
169 static ssize_t snd_info_entry_write(struct file *file, const char __user *buffer,
170 size_t count, loff_t * offset)
172 struct snd_info_private_data *data = file->private_data;
173 struct snd_info_entry *entry = data->entry;
178 if (!valid_pos(pos, count))
181 size_t maxsize = entry->size - pos;
182 count = min(count, maxsize);
183 size = entry->c.ops->write(entry, data->file_private_data,
184 file, buffer, count, pos);
187 *offset = pos + size;
191 static __poll_t snd_info_entry_poll(struct file *file, poll_table *wait)
193 struct snd_info_private_data *data = file->private_data;
194 struct snd_info_entry *entry = data->entry;
197 if (entry->c.ops->poll)
198 return entry->c.ops->poll(entry,
199 data->file_private_data,
201 if (entry->c.ops->read)
202 mask |= EPOLLIN | EPOLLRDNORM;
203 if (entry->c.ops->write)
204 mask |= EPOLLOUT | EPOLLWRNORM;
208 static long snd_info_entry_ioctl(struct file *file, unsigned int cmd,
211 struct snd_info_private_data *data = file->private_data;
212 struct snd_info_entry *entry = data->entry;
214 if (!entry->c.ops->ioctl)
216 return entry->c.ops->ioctl(entry, data->file_private_data,
220 static int snd_info_entry_mmap(struct file *file, struct vm_area_struct *vma)
222 struct inode *inode = file_inode(file);
223 struct snd_info_private_data *data;
224 struct snd_info_entry *entry;
226 data = file->private_data;
230 if (!entry->c.ops->mmap)
232 return entry->c.ops->mmap(entry, data->file_private_data,
236 static int snd_info_entry_open(struct inode *inode, struct file *file)
238 struct snd_info_entry *entry = PDE_DATA(inode);
239 struct snd_info_private_data *data;
242 mutex_lock(&info_mutex);
243 err = alloc_info_private(entry, &data);
247 mode = file->f_flags & O_ACCMODE;
248 if (((mode == O_RDONLY || mode == O_RDWR) && !entry->c.ops->read) ||
249 ((mode == O_WRONLY || mode == O_RDWR) && !entry->c.ops->write)) {
254 if (entry->c.ops->open) {
255 err = entry->c.ops->open(entry, mode, &data->file_private_data);
260 file->private_data = data;
261 mutex_unlock(&info_mutex);
266 module_put(entry->module);
268 mutex_unlock(&info_mutex);
272 static int snd_info_entry_release(struct inode *inode, struct file *file)
274 struct snd_info_private_data *data = file->private_data;
275 struct snd_info_entry *entry = data->entry;
277 if (entry->c.ops->release)
278 entry->c.ops->release(entry, file->f_flags & O_ACCMODE,
279 data->file_private_data);
280 module_put(entry->module);
285 static const struct file_operations snd_info_entry_operations =
287 .owner = THIS_MODULE,
288 .llseek = snd_info_entry_llseek,
289 .read = snd_info_entry_read,
290 .write = snd_info_entry_write,
291 .poll = snd_info_entry_poll,
292 .unlocked_ioctl = snd_info_entry_ioctl,
293 .mmap = snd_info_entry_mmap,
294 .open = snd_info_entry_open,
295 .release = snd_info_entry_release,
299 * file ops for text proc files
301 static ssize_t snd_info_text_entry_write(struct file *file,
302 const char __user *buffer,
303 size_t count, loff_t *offset)
305 struct seq_file *m = file->private_data;
306 struct snd_info_private_data *data = m->private;
307 struct snd_info_entry *entry = data->entry;
308 struct snd_info_buffer *buf;
313 if (!entry->c.text.write)
316 if (!valid_pos(pos, count))
319 /* don't handle too large text inputs */
320 if (next > 16 * 1024)
322 mutex_lock(&entry->access);
325 data->wbuffer = buf = kzalloc(sizeof(*buf), GFP_KERNEL);
331 if (next > buf->len) {
332 char *nbuf = kvzalloc(PAGE_ALIGN(next), GFP_KERNEL);
339 buf->len = PAGE_ALIGN(next);
341 if (copy_from_user(buf->buffer + pos, buffer, count)) {
347 mutex_unlock(&entry->access);
354 static int snd_info_seq_show(struct seq_file *seq, void *p)
356 struct snd_info_private_data *data = seq->private;
357 struct snd_info_entry *entry = data->entry;
359 if (!entry->c.text.read) {
362 data->rbuffer->buffer = (char *)seq; /* XXX hack! */
363 entry->c.text.read(entry, data->rbuffer);
368 static int snd_info_text_entry_open(struct inode *inode, struct file *file)
370 struct snd_info_entry *entry = PDE_DATA(inode);
371 struct snd_info_private_data *data;
374 mutex_lock(&info_mutex);
375 err = alloc_info_private(entry, &data);
379 data->rbuffer = kzalloc(sizeof(*data->rbuffer), GFP_KERNEL);
380 if (!data->rbuffer) {
385 err = single_open_size(file, snd_info_seq_show, data,
388 err = single_open(file, snd_info_seq_show, data);
391 mutex_unlock(&info_mutex);
395 kfree(data->rbuffer);
397 module_put(entry->module);
399 mutex_unlock(&info_mutex);
403 static int snd_info_text_entry_release(struct inode *inode, struct file *file)
405 struct seq_file *m = file->private_data;
406 struct snd_info_private_data *data = m->private;
407 struct snd_info_entry *entry = data->entry;
409 if (data->wbuffer && entry->c.text.write)
410 entry->c.text.write(entry, data->wbuffer);
412 single_release(inode, file);
413 kfree(data->rbuffer);
415 kvfree(data->wbuffer->buffer);
416 kfree(data->wbuffer);
419 module_put(entry->module);
424 static const struct file_operations snd_info_text_entry_ops =
426 .owner = THIS_MODULE,
427 .open = snd_info_text_entry_open,
428 .release = snd_info_text_entry_release,
429 .write = snd_info_text_entry_write,
434 static struct snd_info_entry *create_subdir(struct module *mod,
437 struct snd_info_entry *entry;
439 entry = snd_info_create_module_entry(mod, name, NULL);
442 entry->mode = S_IFDIR | 0555;
443 if (snd_info_register(entry) < 0) {
444 snd_info_free_entry(entry);
450 static struct snd_info_entry *
451 snd_info_create_entry(const char *name, struct snd_info_entry *parent,
452 struct module *module);
454 int __init snd_info_init(void)
456 snd_proc_root = snd_info_create_entry("asound", NULL, THIS_MODULE);
459 snd_proc_root->mode = S_IFDIR | 0555;
460 snd_proc_root->p = proc_mkdir("asound", NULL);
461 if (!snd_proc_root->p)
463 #ifdef CONFIG_SND_OSSEMUL
464 snd_oss_root = create_subdir(THIS_MODULE, "oss");
468 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
469 snd_seq_root = create_subdir(THIS_MODULE, "seq");
473 if (snd_info_version_init() < 0 ||
474 snd_minor_info_init() < 0 ||
475 snd_minor_info_oss_init() < 0 ||
476 snd_card_info_init() < 0 ||
477 snd_info_minor_register() < 0)
482 snd_info_free_entry(snd_proc_root);
486 int __exit snd_info_done(void)
488 snd_info_free_entry(snd_proc_root);
492 static void snd_card_id_read(struct snd_info_entry *entry,
493 struct snd_info_buffer *buffer)
495 struct snd_card *card = entry->private_data;
497 snd_iprintf(buffer, "%s\n", card->id);
501 * create a card proc file
504 int snd_info_card_create(struct snd_card *card)
507 struct snd_info_entry *entry;
509 if (snd_BUG_ON(!card))
512 sprintf(str, "card%i", card->number);
513 entry = create_subdir(card->module, str);
516 card->proc_root = entry;
518 return snd_card_ro_proc_new(card, "id", card, snd_card_id_read);
522 * register the card proc file
524 * can be called multiple times for reinitialization
526 int snd_info_card_register(struct snd_card *card)
528 struct proc_dir_entry *p;
531 if (snd_BUG_ON(!card))
534 err = snd_info_register(card->proc_root);
538 if (!strcmp(card->id, card->proc_root->name))
541 if (card->proc_root_link)
543 p = proc_symlink(card->id, snd_proc_root->p, card->proc_root->name);
546 card->proc_root_link = p;
551 * called on card->id change
553 void snd_info_card_id_change(struct snd_card *card)
555 mutex_lock(&info_mutex);
556 if (card->proc_root_link) {
557 proc_remove(card->proc_root_link);
558 card->proc_root_link = NULL;
560 if (strcmp(card->id, card->proc_root->name))
561 card->proc_root_link = proc_symlink(card->id,
563 card->proc_root->name);
564 mutex_unlock(&info_mutex);
568 * de-register the card proc file
571 void snd_info_card_disconnect(struct snd_card *card)
575 mutex_lock(&info_mutex);
576 proc_remove(card->proc_root_link);
577 card->proc_root_link = NULL;
579 snd_info_disconnect(card->proc_root);
580 mutex_unlock(&info_mutex);
584 * release the card proc file resources
587 int snd_info_card_free(struct snd_card *card)
591 snd_info_free_entry(card->proc_root);
592 card->proc_root = NULL;
598 * snd_info_get_line - read one line from the procfs buffer
599 * @buffer: the procfs buffer
600 * @line: the buffer to store
601 * @len: the max. buffer size
603 * Reads one line from the buffer and stores the string.
605 * Return: Zero if successful, or 1 if error or EOF.
607 int snd_info_get_line(struct snd_info_buffer *buffer, char *line, int len)
611 if (snd_BUG_ON(!buffer || !buffer->buffer))
613 if (len <= 0 || buffer->stop || buffer->error)
615 while (!buffer->stop) {
616 c = buffer->buffer[buffer->curr++];
617 if (buffer->curr >= buffer->size)
629 EXPORT_SYMBOL(snd_info_get_line);
632 * snd_info_get_str - parse a string token
633 * @dest: the buffer to store the string token
634 * @src: the original string
635 * @len: the max. length of token - 1
637 * Parses the original string and copy a token to the given
640 * Return: The updated pointer of the original string so that
641 * it can be used for the next call.
643 const char *snd_info_get_str(char *dest, const char *src, int len)
647 while (*src == ' ' || *src == '\t')
649 if (*src == '"' || *src == '\'') {
651 while (--len > 0 && *src && *src != c) {
657 while (--len > 0 && *src && *src != ' ' && *src != '\t') {
662 while (*src == ' ' || *src == '\t')
666 EXPORT_SYMBOL(snd_info_get_str);
669 * snd_info_create_entry - create an info entry
670 * @name: the proc file name
671 * @parent: the parent directory
673 * Creates an info entry with the given file name and initializes as
676 * Usually called from other functions such as
677 * snd_info_create_card_entry().
679 * Return: The pointer of the new instance, or %NULL on failure.
681 static struct snd_info_entry *
682 snd_info_create_entry(const char *name, struct snd_info_entry *parent,
683 struct module *module)
685 struct snd_info_entry *entry;
686 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
689 entry->name = kstrdup(name, GFP_KERNEL);
690 if (entry->name == NULL) {
694 entry->mode = S_IFREG | 0444;
695 entry->content = SNDRV_INFO_CONTENT_TEXT;
696 mutex_init(&entry->access);
697 INIT_LIST_HEAD(&entry->children);
698 INIT_LIST_HEAD(&entry->list);
699 entry->parent = parent;
700 entry->module = module;
702 mutex_lock(&parent->access);
703 list_add_tail(&entry->list, &parent->children);
704 mutex_unlock(&parent->access);
710 * snd_info_create_module_entry - create an info entry for the given module
711 * @module: the module pointer
712 * @name: the file name
713 * @parent: the parent directory
715 * Creates a new info entry and assigns it to the given module.
717 * Return: The pointer of the new instance, or %NULL on failure.
719 struct snd_info_entry *snd_info_create_module_entry(struct module * module,
721 struct snd_info_entry *parent)
724 parent = snd_proc_root;
725 return snd_info_create_entry(name, parent, module);
727 EXPORT_SYMBOL(snd_info_create_module_entry);
730 * snd_info_create_card_entry - create an info entry for the given card
731 * @card: the card instance
732 * @name: the file name
733 * @parent: the parent directory
735 * Creates a new info entry and assigns it to the given card.
737 * Return: The pointer of the new instance, or %NULL on failure.
739 struct snd_info_entry *snd_info_create_card_entry(struct snd_card *card,
741 struct snd_info_entry * parent)
744 parent = card->proc_root;
745 return snd_info_create_entry(name, parent, card->module);
747 EXPORT_SYMBOL(snd_info_create_card_entry);
749 static void snd_info_disconnect(struct snd_info_entry *entry)
751 struct snd_info_entry *p;
755 list_for_each_entry(p, &entry->children, list)
756 snd_info_disconnect(p);
757 proc_remove(entry->p);
762 * snd_info_free_entry - release the info entry
763 * @entry: the info entry
765 * Releases the info entry.
767 void snd_info_free_entry(struct snd_info_entry * entry)
769 struct snd_info_entry *p, *n;
774 mutex_lock(&info_mutex);
775 snd_info_disconnect(entry);
776 mutex_unlock(&info_mutex);
779 /* free all children at first */
780 list_for_each_entry_safe(p, n, &entry->children, list)
781 snd_info_free_entry(p);
785 mutex_lock(&p->access);
786 list_del(&entry->list);
787 mutex_unlock(&p->access);
790 if (entry->private_free)
791 entry->private_free(entry);
794 EXPORT_SYMBOL(snd_info_free_entry);
796 static int __snd_info_register(struct snd_info_entry *entry)
798 struct proc_dir_entry *root, *p = NULL;
800 if (snd_BUG_ON(!entry))
802 root = entry->parent == NULL ? snd_proc_root->p : entry->parent->p;
803 mutex_lock(&info_mutex);
804 if (entry->p || !root)
806 if (S_ISDIR(entry->mode)) {
807 p = proc_mkdir_mode(entry->name, entry->mode, root);
809 mutex_unlock(&info_mutex);
813 const struct file_operations *ops;
814 if (entry->content == SNDRV_INFO_CONTENT_DATA)
815 ops = &snd_info_entry_operations;
817 ops = &snd_info_text_entry_ops;
818 p = proc_create_data(entry->name, entry->mode, root,
821 mutex_unlock(&info_mutex);
824 proc_set_size(p, entry->size);
828 mutex_unlock(&info_mutex);
833 * snd_info_register - register the info entry
834 * @entry: the info entry
836 * Registers the proc info entry.
837 * The all children entries are registered recursively.
839 * Return: Zero if successful, or a negative error code on failure.
841 int snd_info_register(struct snd_info_entry *entry)
843 struct snd_info_entry *p;
847 err = __snd_info_register(entry);
852 list_for_each_entry(p, &entry->children, list) {
853 err = snd_info_register(p);
860 EXPORT_SYMBOL(snd_info_register);
863 * snd_card_rw_proc_new - Create a read/write text proc file entry for the card
864 * @card: the card instance
865 * @name: the file name
866 * @private_data: the arbitrary private data
867 * @read: the read callback
868 * @write: the write callback, NULL for read-only
870 * This proc file entry will be registered via snd_card_register() call, and
871 * it will be removed automatically at the card removal, too.
873 int snd_card_rw_proc_new(struct snd_card *card, const char *name,
875 void (*read)(struct snd_info_entry *,
876 struct snd_info_buffer *),
877 void (*write)(struct snd_info_entry *entry,
878 struct snd_info_buffer *buffer))
880 struct snd_info_entry *entry;
882 entry = snd_info_create_card_entry(card, name, card->proc_root);
885 snd_info_set_text_ops(entry, private_data, read);
888 entry->c.text.write = write;
892 EXPORT_SYMBOL_GPL(snd_card_rw_proc_new);
898 static void snd_info_version_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
901 "Advanced Linux Sound Architecture Driver Version k%s.\n",
902 init_utsname()->release);
905 static int __init snd_info_version_init(void)
907 struct snd_info_entry *entry;
909 entry = snd_info_create_module_entry(THIS_MODULE, "version", NULL);
912 entry->c.text.read = snd_info_version_read;
913 return snd_info_register(entry); /* freed in error path */