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/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>
36 int snd_info_check_reserved_words(const char *str
)
38 static char *reserved
[] =
53 char **xstr
= reserved
;
56 if (!strcmp(*xstr
, str
))
60 if (!strncmp(str
, "card", 4))
65 static DEFINE_MUTEX(info_mutex
);
67 struct 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
;
74 static int snd_info_version_init(void);
75 static void snd_info_disconnect(struct snd_info_entry
*entry
);
81 static struct snd_info_entry
*snd_proc_root
;
82 struct snd_info_entry
*snd_seq_root
;
83 EXPORT_SYMBOL(snd_seq_root
);
85 #ifdef CONFIG_SND_OSSEMUL
86 struct snd_info_entry
*snd_oss_root
;
89 static int alloc_info_private(struct snd_info_entry
*entry
,
90 struct snd_info_private_data
**ret
)
92 struct snd_info_private_data
*data
;
94 if (!entry
|| !entry
->p
)
96 if (!try_module_get(entry
->module
))
98 data
= kzalloc(sizeof(*data
), GFP_KERNEL
);
100 module_put(entry
->module
);
108 static bool valid_pos(loff_t pos
, size_t count
)
110 if (pos
< 0 || (long) pos
!= pos
|| (ssize_t
) count
< 0)
112 if ((unsigned long) pos
+ (unsigned long) count
< (unsigned long) pos
)
118 * file ops for binary proc files
120 static loff_t
snd_info_entry_llseek(struct file
*file
, loff_t offset
, int orig
)
122 struct snd_info_private_data
*data
;
123 struct snd_info_entry
*entry
;
124 loff_t ret
= -EINVAL
, size
;
126 data
= file
->private_data
;
128 mutex_lock(&entry
->access
);
129 if (entry
->c
.ops
->llseek
) {
130 offset
= entry
->c
.ops
->llseek(entry
,
131 data
->file_private_data
,
141 offset
+= file
->f_pos
;
153 if (size
&& offset
> size
)
155 file
->f_pos
= offset
;
158 mutex_unlock(&entry
->access
);
162 static ssize_t
snd_info_entry_read(struct file
*file
, char __user
*buffer
,
163 size_t count
, loff_t
* offset
)
165 struct snd_info_private_data
*data
= file
->private_data
;
166 struct snd_info_entry
*entry
= data
->entry
;
171 if (!valid_pos(pos
, count
))
173 if (pos
>= entry
->size
)
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
;
184 static ssize_t
snd_info_entry_write(struct file
*file
, const char __user
*buffer
,
185 size_t count
, loff_t
* offset
)
187 struct snd_info_private_data
*data
= file
->private_data
;
188 struct snd_info_entry
*entry
= data
->entry
;
193 if (!valid_pos(pos
, count
))
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
);
202 *offset
= pos
+ size
;
206 static unsigned int snd_info_entry_poll(struct file
*file
, poll_table
*wait
)
208 struct snd_info_private_data
*data
= file
->private_data
;
209 struct snd_info_entry
*entry
= data
->entry
;
210 unsigned int mask
= 0;
212 if (entry
->c
.ops
->poll
)
213 return entry
->c
.ops
->poll(entry
,
214 data
->file_private_data
,
216 if (entry
->c
.ops
->read
)
217 mask
|= POLLIN
| POLLRDNORM
;
218 if (entry
->c
.ops
->write
)
219 mask
|= POLLOUT
| POLLWRNORM
;
223 static long snd_info_entry_ioctl(struct file
*file
, unsigned int cmd
,
226 struct snd_info_private_data
*data
= file
->private_data
;
227 struct snd_info_entry
*entry
= data
->entry
;
229 if (!entry
->c
.ops
->ioctl
)
231 return entry
->c
.ops
->ioctl(entry
, data
->file_private_data
,
235 static int snd_info_entry_mmap(struct file
*file
, struct vm_area_struct
*vma
)
237 struct inode
*inode
= file_inode(file
);
238 struct snd_info_private_data
*data
;
239 struct snd_info_entry
*entry
;
241 data
= file
->private_data
;
245 if (!entry
->c
.ops
->mmap
)
247 return entry
->c
.ops
->mmap(entry
, data
->file_private_data
,
251 static int snd_info_entry_open(struct inode
*inode
, struct file
*file
)
253 struct snd_info_entry
*entry
= PDE_DATA(inode
);
254 struct snd_info_private_data
*data
;
257 mutex_lock(&info_mutex
);
258 err
= alloc_info_private(entry
, &data
);
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
)) {
269 if (entry
->c
.ops
->open
) {
270 err
= entry
->c
.ops
->open(entry
, mode
, &data
->file_private_data
);
275 file
->private_data
= data
;
276 mutex_unlock(&info_mutex
);
281 module_put(entry
->module
);
283 mutex_unlock(&info_mutex
);
287 static int snd_info_entry_release(struct inode
*inode
, struct file
*file
)
289 struct snd_info_private_data
*data
= file
->private_data
;
290 struct snd_info_entry
*entry
= data
->entry
;
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
);
300 static const struct file_operations snd_info_entry_operations
=
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
,
314 * file ops for text proc files
316 static ssize_t
snd_info_text_entry_write(struct file
*file
,
317 const char __user
*buffer
,
318 size_t count
, loff_t
*offset
)
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
;
328 if (!entry
->c
.text
.write
)
331 if (!valid_pos(pos
, count
))
334 /* don't handle too large text inputs */
335 if (next
> 16 * 1024)
337 mutex_lock(&entry
->access
);
340 data
->wbuffer
= buf
= kzalloc(sizeof(*buf
), GFP_KERNEL
);
346 if (next
> buf
->len
) {
347 char *nbuf
= kvzalloc(PAGE_ALIGN(next
), GFP_KERNEL
);
354 buf
->len
= PAGE_ALIGN(next
);
356 if (copy_from_user(buf
->buffer
+ pos
, buffer
, count
)) {
362 mutex_unlock(&entry
->access
);
369 static int snd_info_seq_show(struct seq_file
*seq
, void *p
)
371 struct snd_info_private_data
*data
= seq
->private;
372 struct snd_info_entry
*entry
= data
->entry
;
374 if (!entry
->c
.text
.read
) {
377 data
->rbuffer
->buffer
= (char *)seq
; /* XXX hack! */
378 entry
->c
.text
.read(entry
, data
->rbuffer
);
383 static int snd_info_text_entry_open(struct inode
*inode
, struct file
*file
)
385 struct snd_info_entry
*entry
= PDE_DATA(inode
);
386 struct snd_info_private_data
*data
;
389 mutex_lock(&info_mutex
);
390 err
= alloc_info_private(entry
, &data
);
394 data
->rbuffer
= kzalloc(sizeof(*data
->rbuffer
), GFP_KERNEL
);
395 if (!data
->rbuffer
) {
400 err
= single_open_size(file
, snd_info_seq_show
, data
,
403 err
= single_open(file
, snd_info_seq_show
, data
);
406 mutex_unlock(&info_mutex
);
410 kfree(data
->rbuffer
);
412 module_put(entry
->module
);
414 mutex_unlock(&info_mutex
);
418 static int snd_info_text_entry_release(struct inode
*inode
, struct file
*file
)
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
;
424 if (data
->wbuffer
&& entry
->c
.text
.write
)
425 entry
->c
.text
.write(entry
, data
->wbuffer
);
427 single_release(inode
, file
);
428 kfree(data
->rbuffer
);
430 kvfree(data
->wbuffer
->buffer
);
431 kfree(data
->wbuffer
);
434 module_put(entry
->module
);
439 static const struct file_operations snd_info_text_entry_ops
=
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
,
449 static struct snd_info_entry
*create_subdir(struct module
*mod
,
452 struct snd_info_entry
*entry
;
454 entry
= snd_info_create_module_entry(mod
, name
, NULL
);
457 entry
->mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
;
458 if (snd_info_register(entry
) < 0) {
459 snd_info_free_entry(entry
);
465 static struct snd_info_entry
*
466 snd_info_create_entry(const char *name
, struct snd_info_entry
*parent
);
468 int __init
snd_info_init(void)
470 snd_proc_root
= snd_info_create_entry("asound", NULL
);
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
)
477 #ifdef CONFIG_SND_OSSEMUL
478 snd_oss_root
= create_subdir(THIS_MODULE
, "oss");
482 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
483 snd_seq_root
= create_subdir(THIS_MODULE
, "seq");
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)
496 snd_info_free_entry(snd_proc_root
);
500 int __exit
snd_info_done(void)
502 snd_info_free_entry(snd_proc_root
);
507 * create a card proc file
510 int snd_info_card_create(struct snd_card
*card
)
513 struct snd_info_entry
*entry
;
515 if (snd_BUG_ON(!card
))
518 sprintf(str
, "card%i", card
->number
);
519 entry
= create_subdir(card
->module
, str
);
522 card
->proc_root
= entry
;
526 /* register all pending info entries */
527 static int snd_info_register_recursive(struct snd_info_entry
*entry
)
529 struct snd_info_entry
*p
;
533 err
= snd_info_register(entry
);
538 list_for_each_entry(p
, &entry
->children
, list
) {
539 err
= snd_info_register_recursive(p
);
548 * register the card proc file
550 * can be called multiple times for reinitialization
552 int snd_info_card_register(struct snd_card
*card
)
554 struct proc_dir_entry
*p
;
557 if (snd_BUG_ON(!card
))
560 err
= snd_info_register_recursive(card
->proc_root
);
564 if (!strcmp(card
->id
, card
->proc_root
->name
))
567 if (card
->proc_root_link
)
569 p
= proc_symlink(card
->id
, snd_proc_root
->p
, card
->proc_root
->name
);
572 card
->proc_root_link
= p
;
577 * called on card->id change
579 void snd_info_card_id_change(struct snd_card
*card
)
581 mutex_lock(&info_mutex
);
582 if (card
->proc_root_link
) {
583 proc_remove(card
->proc_root_link
);
584 card
->proc_root_link
= NULL
;
586 if (strcmp(card
->id
, card
->proc_root
->name
))
587 card
->proc_root_link
= proc_symlink(card
->id
,
589 card
->proc_root
->name
);
590 mutex_unlock(&info_mutex
);
594 * de-register the card proc file
597 void snd_info_card_disconnect(struct snd_card
*card
)
601 mutex_lock(&info_mutex
);
602 proc_remove(card
->proc_root_link
);
603 card
->proc_root_link
= NULL
;
605 snd_info_disconnect(card
->proc_root
);
606 mutex_unlock(&info_mutex
);
610 * release the card proc file resources
613 int snd_info_card_free(struct snd_card
*card
)
617 snd_info_free_entry(card
->proc_root
);
618 card
->proc_root
= NULL
;
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
629 * Reads one line from the buffer and stores the string.
631 * Return: Zero if successful, or 1 if error or EOF.
633 int snd_info_get_line(struct snd_info_buffer
*buffer
, char *line
, int len
)
637 if (snd_BUG_ON(!buffer
|| !buffer
->buffer
))
639 if (len
<= 0 || buffer
->stop
|| buffer
->error
)
641 while (!buffer
->stop
) {
642 c
= buffer
->buffer
[buffer
->curr
++];
643 if (buffer
->curr
>= buffer
->size
)
655 EXPORT_SYMBOL(snd_info_get_line
);
658 * snd_info_get_str - parse a string token
659 * @dest: the buffer to store the string token
660 * @src: the original string
661 * @len: the max. length of token - 1
663 * Parses the original string and copy a token to the given
666 * Return: The updated pointer of the original string so that
667 * it can be used for the next call.
669 const char *snd_info_get_str(char *dest
, const char *src
, int len
)
673 while (*src
== ' ' || *src
== '\t')
675 if (*src
== '"' || *src
== '\'') {
677 while (--len
> 0 && *src
&& *src
!= c
) {
683 while (--len
> 0 && *src
&& *src
!= ' ' && *src
!= '\t') {
688 while (*src
== ' ' || *src
== '\t')
692 EXPORT_SYMBOL(snd_info_get_str
);
695 * snd_info_create_entry - create an info entry
696 * @name: the proc file name
697 * @parent: the parent directory
699 * Creates an info entry with the given file name and initializes as
702 * Usually called from other functions such as
703 * snd_info_create_card_entry().
705 * Return: The pointer of the new instance, or %NULL on failure.
707 static struct snd_info_entry
*
708 snd_info_create_entry(const char *name
, struct snd_info_entry
*parent
)
710 struct snd_info_entry
*entry
;
711 entry
= kzalloc(sizeof(*entry
), GFP_KERNEL
);
714 entry
->name
= kstrdup(name
, GFP_KERNEL
);
715 if (entry
->name
== NULL
) {
719 entry
->mode
= S_IFREG
| S_IRUGO
;
720 entry
->content
= SNDRV_INFO_CONTENT_TEXT
;
721 mutex_init(&entry
->access
);
722 INIT_LIST_HEAD(&entry
->children
);
723 INIT_LIST_HEAD(&entry
->list
);
724 entry
->parent
= parent
;
726 list_add_tail(&entry
->list
, &parent
->children
);
731 * snd_info_create_module_entry - create an info entry for the given module
732 * @module: the module pointer
733 * @name: the file name
734 * @parent: the parent directory
736 * Creates a new info entry and assigns it to the given module.
738 * Return: The pointer of the new instance, or %NULL on failure.
740 struct snd_info_entry
*snd_info_create_module_entry(struct module
* module
,
742 struct snd_info_entry
*parent
)
744 struct snd_info_entry
*entry
= snd_info_create_entry(name
, parent
);
746 entry
->module
= module
;
749 EXPORT_SYMBOL(snd_info_create_module_entry
);
752 * snd_info_create_card_entry - create an info entry for the given card
753 * @card: the card instance
754 * @name: the file name
755 * @parent: the parent directory
757 * Creates a new info entry and assigns it to the given card.
759 * Return: The pointer of the new instance, or %NULL on failure.
761 struct snd_info_entry
*snd_info_create_card_entry(struct snd_card
*card
,
763 struct snd_info_entry
* parent
)
765 struct snd_info_entry
*entry
= snd_info_create_entry(name
, parent
);
767 entry
->module
= card
->module
;
772 EXPORT_SYMBOL(snd_info_create_card_entry
);
774 static void snd_info_disconnect(struct snd_info_entry
*entry
)
776 struct snd_info_entry
*p
;
780 list_for_each_entry(p
, &entry
->children
, list
)
781 snd_info_disconnect(p
);
782 proc_remove(entry
->p
);
787 * snd_info_free_entry - release the info entry
788 * @entry: the info entry
790 * Releases the info entry.
792 void snd_info_free_entry(struct snd_info_entry
* entry
)
794 struct snd_info_entry
*p
, *n
;
799 mutex_lock(&info_mutex
);
800 snd_info_disconnect(entry
);
801 mutex_unlock(&info_mutex
);
804 /* free all children at first */
805 list_for_each_entry_safe(p
, n
, &entry
->children
, list
)
806 snd_info_free_entry(p
);
808 list_del(&entry
->list
);
810 if (entry
->private_free
)
811 entry
->private_free(entry
);
814 EXPORT_SYMBOL(snd_info_free_entry
);
817 * snd_info_register - register the info entry
818 * @entry: the info entry
820 * Registers the proc info entry.
822 * Return: Zero if successful, or a negative error code on failure.
824 int snd_info_register(struct snd_info_entry
* entry
)
826 struct proc_dir_entry
*root
, *p
= NULL
;
828 if (snd_BUG_ON(!entry
))
830 root
= entry
->parent
== NULL
? snd_proc_root
->p
: entry
->parent
->p
;
831 mutex_lock(&info_mutex
);
832 if (S_ISDIR(entry
->mode
)) {
833 p
= proc_mkdir_mode(entry
->name
, entry
->mode
, root
);
835 mutex_unlock(&info_mutex
);
839 const struct file_operations
*ops
;
840 if (entry
->content
== SNDRV_INFO_CONTENT_DATA
)
841 ops
= &snd_info_entry_operations
;
843 ops
= &snd_info_text_entry_ops
;
844 p
= proc_create_data(entry
->name
, entry
->mode
, root
,
847 mutex_unlock(&info_mutex
);
850 proc_set_size(p
, entry
->size
);
853 mutex_unlock(&info_mutex
);
856 EXPORT_SYMBOL(snd_info_register
);
862 static void snd_info_version_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
865 "Advanced Linux Sound Architecture Driver Version k%s.\n",
866 init_utsname()->release
);
869 static int __init
snd_info_version_init(void)
871 struct snd_info_entry
*entry
;
873 entry
= snd_info_create_module_entry(THIS_MODULE
, "version", NULL
);
876 entry
->c
.text
.read
= snd_info_version_read
;
877 return snd_info_register(entry
); /* freed in error path */