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>
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
| __GFP_ZERO
);
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 * Return: The size of output string, or a negative error code.
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 loff_t
snd_info_entry_llseek(struct file
*file
, loff_t offset
, int orig
)
158 struct snd_info_private_data
*data
;
159 struct snd_info_entry
*entry
;
160 loff_t ret
= -EINVAL
, size
;
162 data
= file
->private_data
;
164 mutex_lock(&entry
->access
);
165 if (entry
->content
== SNDRV_INFO_CONTENT_DATA
&&
166 entry
->c
.ops
->llseek
) {
167 offset
= entry
->c
.ops
->llseek(entry
,
168 data
->file_private_data
,
172 if (entry
->content
== SNDRV_INFO_CONTENT_DATA
)
180 offset
+= file
->f_pos
;
192 if (size
&& offset
> size
)
194 file
->f_pos
= offset
;
197 mutex_unlock(&entry
->access
);
201 static ssize_t
snd_info_entry_read(struct file
*file
, char __user
*buffer
,
202 size_t count
, loff_t
* offset
)
204 struct snd_info_private_data
*data
;
205 struct snd_info_entry
*entry
;
206 struct snd_info_buffer
*buf
;
210 data
= file
->private_data
;
211 if (snd_BUG_ON(!data
))
214 if (pos
< 0 || (long) pos
!= pos
|| (ssize_t
) count
< 0)
216 if ((unsigned long) pos
+ (unsigned long) count
< (unsigned long) pos
)
219 switch (entry
->content
) {
220 case SNDRV_INFO_CONTENT_TEXT
:
224 if (pos
>= buf
->size
)
226 size
= buf
->size
- pos
;
227 size
= min(count
, size
);
228 if (copy_to_user(buffer
, buf
->buffer
+ pos
, size
))
231 case SNDRV_INFO_CONTENT_DATA
:
232 if (pos
>= entry
->size
)
234 if (entry
->c
.ops
->read
) {
235 size
= entry
->size
- pos
;
236 size
= min(count
, size
);
237 size
= entry
->c
.ops
->read(entry
,
238 data
->file_private_data
,
239 file
, buffer
, size
, pos
);
243 if ((ssize_t
) size
> 0)
244 *offset
= pos
+ size
;
248 static ssize_t
snd_info_entry_write(struct file
*file
, const char __user
*buffer
,
249 size_t count
, loff_t
* offset
)
251 struct snd_info_private_data
*data
;
252 struct snd_info_entry
*entry
;
253 struct snd_info_buffer
*buf
;
257 data
= file
->private_data
;
258 if (snd_BUG_ON(!data
))
262 if (pos
< 0 || (long) pos
!= pos
|| (ssize_t
) count
< 0)
264 if ((unsigned long) pos
+ (unsigned long) count
< (unsigned long) pos
)
266 switch (entry
->content
) {
267 case SNDRV_INFO_CONTENT_TEXT
:
271 mutex_lock(&entry
->access
);
272 if (pos
+ count
>= buf
->len
) {
273 if (resize_info_buffer(buf
, pos
+ count
)) {
274 mutex_unlock(&entry
->access
);
278 if (copy_from_user(buf
->buffer
+ pos
, buffer
, count
)) {
279 mutex_unlock(&entry
->access
);
282 buf
->size
= pos
+ count
;
283 mutex_unlock(&entry
->access
);
286 case SNDRV_INFO_CONTENT_DATA
:
287 if (entry
->c
.ops
->write
&& count
> 0) {
288 size_t maxsize
= entry
->size
- pos
;
289 count
= min(count
, maxsize
);
290 size
= entry
->c
.ops
->write(entry
,
291 data
->file_private_data
,
292 file
, buffer
, count
, pos
);
296 if ((ssize_t
) size
> 0)
297 *offset
= pos
+ size
;
301 static int snd_info_entry_open(struct inode
*inode
, struct file
*file
)
303 struct snd_info_entry
*entry
;
304 struct snd_info_private_data
*data
;
305 struct snd_info_buffer
*buffer
;
308 mutex_lock(&info_mutex
);
309 entry
= PDE_DATA(inode
);
310 if (entry
== NULL
|| ! entry
->p
) {
311 mutex_unlock(&info_mutex
);
314 if (!try_module_get(entry
->module
)) {
318 mode
= file
->f_flags
& O_ACCMODE
;
319 if (mode
== O_RDONLY
|| mode
== O_RDWR
) {
320 if ((entry
->content
== SNDRV_INFO_CONTENT_DATA
&&
321 entry
->c
.ops
->read
== NULL
)) {
326 if (mode
== O_WRONLY
|| mode
== O_RDWR
) {
327 if ((entry
->content
== SNDRV_INFO_CONTENT_DATA
&&
328 entry
->c
.ops
->write
== NULL
)) {
333 data
= kzalloc(sizeof(*data
), GFP_KERNEL
);
339 switch (entry
->content
) {
340 case SNDRV_INFO_CONTENT_TEXT
:
341 if (mode
== O_RDONLY
|| mode
== O_RDWR
) {
342 buffer
= kzalloc(sizeof(*buffer
), GFP_KERNEL
);
345 data
->rbuffer
= buffer
;
346 buffer
->len
= PAGE_SIZE
;
347 buffer
->buffer
= kzalloc(buffer
->len
, GFP_KERNEL
);
348 if (buffer
->buffer
== NULL
)
351 if (mode
== O_WRONLY
|| mode
== O_RDWR
) {
352 buffer
= kzalloc(sizeof(*buffer
), GFP_KERNEL
);
355 data
->wbuffer
= buffer
;
356 buffer
->len
= PAGE_SIZE
;
357 buffer
->buffer
= kmalloc(buffer
->len
, GFP_KERNEL
);
358 if (buffer
->buffer
== NULL
)
362 case SNDRV_INFO_CONTENT_DATA
: /* data */
363 if (entry
->c
.ops
->open
) {
364 if ((err
= entry
->c
.ops
->open(entry
, mode
,
365 &data
->file_private_data
)) < 0) {
372 file
->private_data
= data
;
373 mutex_unlock(&info_mutex
);
374 if (entry
->content
== SNDRV_INFO_CONTENT_TEXT
&&
375 (mode
== O_RDONLY
|| mode
== O_RDWR
)) {
376 if (entry
->c
.text
.read
) {
377 mutex_lock(&entry
->access
);
378 entry
->c
.text
.read(entry
, data
->rbuffer
);
379 mutex_unlock(&entry
->access
);
386 kfree(data
->rbuffer
->buffer
);
387 kfree(data
->rbuffer
);
390 kfree(data
->wbuffer
->buffer
);
391 kfree(data
->wbuffer
);
396 module_put(entry
->module
);
398 mutex_unlock(&info_mutex
);
402 static int snd_info_entry_release(struct inode
*inode
, struct file
*file
)
404 struct snd_info_entry
*entry
;
405 struct snd_info_private_data
*data
;
408 mode
= file
->f_flags
& O_ACCMODE
;
409 data
= file
->private_data
;
411 switch (entry
->content
) {
412 case SNDRV_INFO_CONTENT_TEXT
:
414 kfree(data
->rbuffer
->buffer
);
415 kfree(data
->rbuffer
);
418 if (entry
->c
.text
.write
) {
419 entry
->c
.text
.write(entry
, data
->wbuffer
);
420 if (data
->wbuffer
->error
) {
422 dev_warn(entry
->card
->dev
, "info: data write error to %s (%i)\n",
424 data
->wbuffer
->error
);
426 pr_warn("ALSA: info: data write error to %s (%i)\n",
428 data
->wbuffer
->error
);
431 kfree(data
->wbuffer
->buffer
);
432 kfree(data
->wbuffer
);
435 case SNDRV_INFO_CONTENT_DATA
:
436 if (entry
->c
.ops
->release
)
437 entry
->c
.ops
->release(entry
, mode
,
438 data
->file_private_data
);
441 module_put(entry
->module
);
446 static unsigned int snd_info_entry_poll(struct file
*file
, poll_table
* wait
)
448 struct snd_info_private_data
*data
;
449 struct snd_info_entry
*entry
;
452 data
= file
->private_data
;
457 switch (entry
->content
) {
458 case SNDRV_INFO_CONTENT_DATA
:
459 if (entry
->c
.ops
->poll
)
460 return entry
->c
.ops
->poll(entry
,
461 data
->file_private_data
,
463 if (entry
->c
.ops
->read
)
464 mask
|= POLLIN
| POLLRDNORM
;
465 if (entry
->c
.ops
->write
)
466 mask
|= POLLOUT
| POLLWRNORM
;
472 static long snd_info_entry_ioctl(struct file
*file
, unsigned int cmd
,
475 struct snd_info_private_data
*data
;
476 struct snd_info_entry
*entry
;
478 data
= file
->private_data
;
482 switch (entry
->content
) {
483 case SNDRV_INFO_CONTENT_DATA
:
484 if (entry
->c
.ops
->ioctl
)
485 return entry
->c
.ops
->ioctl(entry
,
486 data
->file_private_data
,
493 static int snd_info_entry_mmap(struct file
*file
, struct vm_area_struct
*vma
)
495 struct inode
*inode
= file_inode(file
);
496 struct snd_info_private_data
*data
;
497 struct snd_info_entry
*entry
;
499 data
= file
->private_data
;
503 switch (entry
->content
) {
504 case SNDRV_INFO_CONTENT_DATA
:
505 if (entry
->c
.ops
->mmap
)
506 return entry
->c
.ops
->mmap(entry
,
507 data
->file_private_data
,
514 static const struct file_operations snd_info_entry_operations
=
516 .owner
= THIS_MODULE
,
517 .llseek
= snd_info_entry_llseek
,
518 .read
= snd_info_entry_read
,
519 .write
= snd_info_entry_write
,
520 .poll
= snd_info_entry_poll
,
521 .unlocked_ioctl
= snd_info_entry_ioctl
,
522 .mmap
= snd_info_entry_mmap
,
523 .open
= snd_info_entry_open
,
524 .release
= snd_info_entry_release
,
527 int __init
snd_info_init(void)
529 struct proc_dir_entry
*p
;
531 p
= proc_mkdir("asound", NULL
);
535 #ifdef CONFIG_SND_OSSEMUL
537 struct snd_info_entry
*entry
;
538 if ((entry
= snd_info_create_module_entry(THIS_MODULE
, "oss", NULL
)) == NULL
)
540 entry
->mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
;
541 if (snd_info_register(entry
) < 0) {
542 snd_info_free_entry(entry
);
545 snd_oss_root
= entry
;
548 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
550 struct snd_info_entry
*entry
;
551 if ((entry
= snd_info_create_module_entry(THIS_MODULE
, "seq", 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_seq_root
= entry
;
561 snd_info_version_init();
562 snd_minor_info_init();
563 snd_minor_info_oss_init();
564 snd_card_info_init();
568 int __exit
snd_info_done(void)
570 snd_card_info_done();
571 snd_minor_info_oss_done();
572 snd_minor_info_done();
573 snd_info_version_done();
575 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
576 snd_info_free_entry(snd_seq_root
);
578 #ifdef CONFIG_SND_OSSEMUL
579 snd_info_free_entry(snd_oss_root
);
581 proc_remove(snd_proc_root
);
592 * create a card proc file
595 int snd_info_card_create(struct snd_card
*card
)
598 struct snd_info_entry
*entry
;
600 if (snd_BUG_ON(!card
))
603 sprintf(str
, "card%i", card
->number
);
604 if ((entry
= snd_info_create_module_entry(card
->module
, str
, NULL
)) == NULL
)
606 entry
->mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
;
607 if (snd_info_register(entry
) < 0) {
608 snd_info_free_entry(entry
);
611 card
->proc_root
= entry
;
616 * register the card proc file
619 int snd_info_card_register(struct snd_card
*card
)
621 struct proc_dir_entry
*p
;
623 if (snd_BUG_ON(!card
))
626 if (!strcmp(card
->id
, card
->proc_root
->name
))
629 p
= proc_symlink(card
->id
, snd_proc_root
, card
->proc_root
->name
);
632 card
->proc_root_link
= p
;
637 * called on card->id change
639 void snd_info_card_id_change(struct snd_card
*card
)
641 mutex_lock(&info_mutex
);
642 if (card
->proc_root_link
) {
643 proc_remove(card
->proc_root_link
);
644 card
->proc_root_link
= NULL
;
646 if (strcmp(card
->id
, card
->proc_root
->name
))
647 card
->proc_root_link
= proc_symlink(card
->id
,
649 card
->proc_root
->name
);
650 mutex_unlock(&info_mutex
);
654 * de-register the card proc file
657 void snd_info_card_disconnect(struct snd_card
*card
)
661 mutex_lock(&info_mutex
);
662 proc_remove(card
->proc_root_link
);
663 card
->proc_root_link
= NULL
;
665 snd_info_disconnect(card
->proc_root
);
666 mutex_unlock(&info_mutex
);
670 * release the card proc file resources
673 int snd_info_card_free(struct snd_card
*card
)
677 snd_info_free_entry(card
->proc_root
);
678 card
->proc_root
= NULL
;
684 * snd_info_get_line - read one line from the procfs buffer
685 * @buffer: the procfs buffer
686 * @line: the buffer to store
687 * @len: the max. buffer size
689 * Reads one line from the buffer and stores the string.
691 * Return: Zero if successful, or 1 if error or EOF.
693 int snd_info_get_line(struct snd_info_buffer
*buffer
, char *line
, int len
)
697 if (snd_BUG_ON(!buffer
|| !buffer
->buffer
))
699 if (len
<= 0 || buffer
->stop
|| buffer
->error
)
701 while (!buffer
->stop
) {
702 c
= buffer
->buffer
[buffer
->curr
++];
703 if (buffer
->curr
>= buffer
->size
)
716 EXPORT_SYMBOL(snd_info_get_line
);
719 * snd_info_get_str - parse a string token
720 * @dest: the buffer to store the string token
721 * @src: the original string
722 * @len: the max. length of token - 1
724 * Parses the original string and copy a token to the given
727 * Return: The updated pointer of the original string so that
728 * it can be used for the next call.
730 const char *snd_info_get_str(char *dest
, const char *src
, int len
)
734 while (*src
== ' ' || *src
== '\t')
736 if (*src
== '"' || *src
== '\'') {
738 while (--len
> 0 && *src
&& *src
!= c
) {
744 while (--len
> 0 && *src
&& *src
!= ' ' && *src
!= '\t') {
749 while (*src
== ' ' || *src
== '\t')
754 EXPORT_SYMBOL(snd_info_get_str
);
757 * snd_info_create_entry - create an info entry
758 * @name: the proc file name
760 * Creates an info entry with the given file name and initializes as
763 * Usually called from other functions such as
764 * snd_info_create_card_entry().
766 * Return: The pointer of the new instance, or %NULL on failure.
768 static struct snd_info_entry
*snd_info_create_entry(const char *name
)
770 struct snd_info_entry
*entry
;
771 entry
= kzalloc(sizeof(*entry
), GFP_KERNEL
);
774 entry
->name
= kstrdup(name
, GFP_KERNEL
);
775 if (entry
->name
== NULL
) {
779 entry
->mode
= S_IFREG
| S_IRUGO
;
780 entry
->content
= SNDRV_INFO_CONTENT_TEXT
;
781 mutex_init(&entry
->access
);
782 INIT_LIST_HEAD(&entry
->children
);
783 INIT_LIST_HEAD(&entry
->list
);
788 * snd_info_create_module_entry - create an info entry for the given module
789 * @module: the module pointer
790 * @name: the file name
791 * @parent: the parent directory
793 * Creates a new info entry and assigns it to the given module.
795 * Return: The pointer of the new instance, or %NULL on failure.
797 struct snd_info_entry
*snd_info_create_module_entry(struct module
* module
,
799 struct snd_info_entry
*parent
)
801 struct snd_info_entry
*entry
= snd_info_create_entry(name
);
803 entry
->module
= module
;
804 entry
->parent
= parent
;
809 EXPORT_SYMBOL(snd_info_create_module_entry
);
812 * snd_info_create_card_entry - create an info entry for the given card
813 * @card: the card instance
814 * @name: the file name
815 * @parent: the parent directory
817 * Creates a new info entry and assigns it to the given card.
819 * Return: The pointer of the new instance, or %NULL on failure.
821 struct snd_info_entry
*snd_info_create_card_entry(struct snd_card
*card
,
823 struct snd_info_entry
* parent
)
825 struct snd_info_entry
*entry
= snd_info_create_entry(name
);
827 entry
->module
= card
->module
;
829 entry
->parent
= parent
;
834 EXPORT_SYMBOL(snd_info_create_card_entry
);
836 static void snd_info_disconnect(struct snd_info_entry
*entry
)
838 struct list_head
*p
, *n
;
839 struct proc_dir_entry
*root
;
841 list_for_each_safe(p
, n
, &entry
->children
) {
842 snd_info_disconnect(list_entry(p
, struct snd_info_entry
, list
));
847 list_del_init(&entry
->list
);
848 root
= entry
->parent
== NULL
? snd_proc_root
: entry
->parent
->p
;
850 proc_remove(entry
->p
);
854 static int snd_info_dev_free_entry(struct snd_device
*device
)
856 struct snd_info_entry
*entry
= device
->device_data
;
857 snd_info_free_entry(entry
);
861 static int snd_info_dev_register_entry(struct snd_device
*device
)
863 struct snd_info_entry
*entry
= device
->device_data
;
864 return snd_info_register(entry
);
868 * snd_card_proc_new - create an info entry for the given card
869 * @card: the card instance
870 * @name: the file name
871 * @entryp: the pointer to store the new info entry
873 * Creates a new info entry and assigns it to the given card.
874 * Unlike snd_info_create_card_entry(), this function registers the
875 * info entry as an ALSA device component, so that it can be
876 * unregistered/released without explicit call.
877 * Also, you don't have to register this entry via snd_info_register(),
878 * since this will be registered by snd_card_register() automatically.
880 * The parent is assumed as card->proc_root.
882 * For releasing this entry, use snd_device_free() instead of
883 * snd_info_free_entry().
885 * Return: Zero if successful, or a negative error code on failure.
887 int snd_card_proc_new(struct snd_card
*card
, const char *name
,
888 struct snd_info_entry
**entryp
)
890 static struct snd_device_ops ops
= {
891 .dev_free
= snd_info_dev_free_entry
,
892 .dev_register
= snd_info_dev_register_entry
,
893 /* disconnect is done via snd_info_card_disconnect() */
895 struct snd_info_entry
*entry
;
898 entry
= snd_info_create_card_entry(card
, name
, card
->proc_root
);
901 if ((err
= snd_device_new(card
, SNDRV_DEV_INFO
, entry
, &ops
)) < 0) {
902 snd_info_free_entry(entry
);
910 EXPORT_SYMBOL(snd_card_proc_new
);
913 * snd_info_free_entry - release the info entry
914 * @entry: the info entry
916 * Releases the info entry. Don't call this after registered.
918 void snd_info_free_entry(struct snd_info_entry
* entry
)
923 mutex_lock(&info_mutex
);
924 snd_info_disconnect(entry
);
925 mutex_unlock(&info_mutex
);
928 if (entry
->private_free
)
929 entry
->private_free(entry
);
933 EXPORT_SYMBOL(snd_info_free_entry
);
936 * snd_info_register - register the info entry
937 * @entry: the info entry
939 * Registers the proc info entry.
941 * Return: Zero if successful, or a negative error code on failure.
943 int snd_info_register(struct snd_info_entry
* entry
)
945 struct proc_dir_entry
*root
, *p
= NULL
;
947 if (snd_BUG_ON(!entry
))
949 root
= entry
->parent
== NULL
? snd_proc_root
: entry
->parent
->p
;
950 mutex_lock(&info_mutex
);
951 if (S_ISDIR(entry
->mode
)) {
952 p
= proc_mkdir_mode(entry
->name
, entry
->mode
, root
);
954 mutex_unlock(&info_mutex
);
958 p
= proc_create_data(entry
->name
, entry
->mode
, root
,
959 &snd_info_entry_operations
, entry
);
961 mutex_unlock(&info_mutex
);
964 proc_set_size(p
, entry
->size
);
968 list_add_tail(&entry
->list
, &entry
->parent
->children
);
969 mutex_unlock(&info_mutex
);
973 EXPORT_SYMBOL(snd_info_register
);
979 static struct snd_info_entry
*snd_info_version_entry
;
981 static void snd_info_version_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
984 "Advanced Linux Sound Architecture Driver Version k%s.\n",
985 init_utsname()->release
);
988 static int __init
snd_info_version_init(void)
990 struct snd_info_entry
*entry
;
992 entry
= snd_info_create_module_entry(THIS_MODULE
, "version", NULL
);
995 entry
->c
.text
.read
= snd_info_version_read
;
996 if (snd_info_register(entry
) < 0) {
997 snd_info_free_entry(entry
);
1000 snd_info_version_entry
= entry
;
1004 static int __exit
snd_info_version_done(void)
1006 snd_info_free_entry(snd_info_version_entry
);
1010 #endif /* CONFIG_PROC_FS */