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/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);
81 static void snd_info_disconnect(struct snd_info_entry
*entry
);
84 /* resize the proc r/w buffer */
85 static int resize_info_buffer(struct snd_info_buffer
*buffer
,
90 nsize
= PAGE_ALIGN(nsize
);
91 nbuf
= kmalloc(nsize
, GFP_KERNEL
);
95 memcpy(nbuf
, buffer
->buffer
, buffer
->len
);
96 kfree(buffer
->buffer
);
97 buffer
->buffer
= nbuf
;
103 * snd_iprintf - printf on the procfs buffer
104 * @buffer: the procfs buffer
105 * @fmt: the printf format
107 * Outputs the string on the procfs buffer just like printf().
109 * Returns the size of output string.
111 int snd_iprintf(struct snd_info_buffer
*buffer
, char *fmt
,...)
118 if (buffer
->stop
|| buffer
->error
)
120 len
= buffer
->len
- buffer
->size
;
125 res
= vsnprintf(buffer
->buffer
+ buffer
->curr
, len
, fmt
, ap
);
129 err
= resize_info_buffer(buffer
, buffer
->len
+ PAGE_SIZE
);
132 len
= buffer
->len
- buffer
->size
;
143 EXPORT_SYMBOL(snd_iprintf
);
149 static struct proc_dir_entry
*snd_proc_root
;
150 struct snd_info_entry
*snd_seq_root
;
151 EXPORT_SYMBOL(snd_seq_root
);
153 #ifdef CONFIG_SND_OSSEMUL
154 struct snd_info_entry
*snd_oss_root
;
157 static void snd_remove_proc_entry(struct proc_dir_entry
*parent
,
158 struct proc_dir_entry
*de
)
161 remove_proc_entry(de
->name
, parent
);
164 static loff_t
snd_info_entry_llseek(struct file
*file
, loff_t offset
, int orig
)
166 struct snd_info_private_data
*data
;
167 struct snd_info_entry
*entry
;
170 data
= file
->private_data
;
173 switch (entry
->content
) {
174 case SNDRV_INFO_CONTENT_TEXT
:
177 file
->f_pos
= offset
;
181 file
->f_pos
+= offset
;
190 case SNDRV_INFO_CONTENT_DATA
:
191 if (entry
->c
.ops
->llseek
) {
192 ret
= entry
->c
.ops
->llseek(entry
,
193 data
->file_private_data
,
205 static ssize_t
snd_info_entry_read(struct file
*file
, char __user
*buffer
,
206 size_t count
, loff_t
* offset
)
208 struct snd_info_private_data
*data
;
209 struct snd_info_entry
*entry
;
210 struct snd_info_buffer
*buf
;
214 data
= file
->private_data
;
215 if (snd_BUG_ON(!data
))
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 if (snd_BUG_ON(!data
))
261 if (pos
< 0 || (long) pos
!= pos
|| (ssize_t
) count
< 0)
263 if ((unsigned long) pos
+ (unsigned long) count
< (unsigned long) pos
)
265 switch (entry
->content
) {
266 case SNDRV_INFO_CONTENT_TEXT
:
270 mutex_lock(&entry
->access
);
271 if (pos
+ count
>= buf
->len
) {
272 if (resize_info_buffer(buf
, pos
+ count
)) {
273 mutex_unlock(&entry
->access
);
277 if (copy_from_user(buf
->buffer
+ pos
, buffer
, count
)) {
278 mutex_unlock(&entry
->access
);
281 buf
->size
= pos
+ count
;
282 mutex_unlock(&entry
->access
);
285 case SNDRV_INFO_CONTENT_DATA
:
286 if (entry
->c
.ops
->write
)
287 size
= entry
->c
.ops
->write(entry
,
288 data
->file_private_data
,
289 file
, buffer
, count
, pos
);
292 if ((ssize_t
) size
> 0)
293 *offset
= pos
+ size
;
297 static int snd_info_entry_open(struct inode
*inode
, struct file
*file
)
299 struct snd_info_entry
*entry
;
300 struct snd_info_private_data
*data
;
301 struct snd_info_buffer
*buffer
;
302 struct proc_dir_entry
*p
;
305 mutex_lock(&info_mutex
);
307 entry
= p
== NULL
? NULL
: (struct snd_info_entry
*)p
->data
;
308 if (entry
== NULL
|| ! entry
->p
) {
309 mutex_unlock(&info_mutex
);
312 if (!try_module_get(entry
->module
)) {
316 mode
= file
->f_flags
& O_ACCMODE
;
317 if (mode
== O_RDONLY
|| mode
== O_RDWR
) {
318 if ((entry
->content
== SNDRV_INFO_CONTENT_DATA
&&
319 entry
->c
.ops
->read
== NULL
)) {
324 if (mode
== O_WRONLY
|| mode
== O_RDWR
) {
325 if ((entry
->content
== SNDRV_INFO_CONTENT_DATA
&&
326 entry
->c
.ops
->write
== NULL
)) {
331 data
= kzalloc(sizeof(*data
), GFP_KERNEL
);
337 switch (entry
->content
) {
338 case SNDRV_INFO_CONTENT_TEXT
:
339 if (mode
== O_RDONLY
|| mode
== O_RDWR
) {
340 buffer
= kzalloc(sizeof(*buffer
), GFP_KERNEL
);
343 data
->rbuffer
= buffer
;
344 buffer
->len
= PAGE_SIZE
;
345 buffer
->buffer
= kmalloc(buffer
->len
, GFP_KERNEL
);
346 if (buffer
->buffer
== NULL
)
349 if (mode
== O_WRONLY
|| mode
== O_RDWR
) {
350 buffer
= kzalloc(sizeof(*buffer
), GFP_KERNEL
);
353 data
->wbuffer
= buffer
;
354 buffer
->len
= PAGE_SIZE
;
355 buffer
->buffer
= kmalloc(buffer
->len
, GFP_KERNEL
);
356 if (buffer
->buffer
== NULL
)
360 case SNDRV_INFO_CONTENT_DATA
: /* data */
361 if (entry
->c
.ops
->open
) {
362 if ((err
= entry
->c
.ops
->open(entry
, mode
,
363 &data
->file_private_data
)) < 0) {
370 file
->private_data
= data
;
371 mutex_unlock(&info_mutex
);
372 if (entry
->content
== SNDRV_INFO_CONTENT_TEXT
&&
373 (mode
== O_RDONLY
|| mode
== O_RDWR
)) {
374 if (entry
->c
.text
.read
) {
375 mutex_lock(&entry
->access
);
376 entry
->c
.text
.read(entry
, data
->rbuffer
);
377 mutex_unlock(&entry
->access
);
384 kfree(data
->rbuffer
->buffer
);
385 kfree(data
->rbuffer
);
388 kfree(data
->wbuffer
->buffer
);
389 kfree(data
->wbuffer
);
394 module_put(entry
->module
);
396 mutex_unlock(&info_mutex
);
400 static int snd_info_entry_release(struct inode
*inode
, struct file
*file
)
402 struct snd_info_entry
*entry
;
403 struct snd_info_private_data
*data
;
406 mode
= file
->f_flags
& O_ACCMODE
;
407 data
= file
->private_data
;
409 switch (entry
->content
) {
410 case SNDRV_INFO_CONTENT_TEXT
:
412 kfree(data
->rbuffer
->buffer
);
413 kfree(data
->rbuffer
);
416 if (entry
->c
.text
.write
) {
417 entry
->c
.text
.write(entry
, data
->wbuffer
);
418 if (data
->wbuffer
->error
) {
419 snd_printk(KERN_WARNING
"data write error to %s (%i)\n",
421 data
->wbuffer
->error
);
424 kfree(data
->wbuffer
->buffer
);
425 kfree(data
->wbuffer
);
428 case SNDRV_INFO_CONTENT_DATA
:
429 if (entry
->c
.ops
->release
)
430 entry
->c
.ops
->release(entry
, mode
,
431 data
->file_private_data
);
434 module_put(entry
->module
);
439 static unsigned int snd_info_entry_poll(struct file
*file
, poll_table
* wait
)
441 struct snd_info_private_data
*data
;
442 struct snd_info_entry
*entry
;
445 data
= file
->private_data
;
450 switch (entry
->content
) {
451 case SNDRV_INFO_CONTENT_DATA
:
452 if (entry
->c
.ops
->poll
)
453 return entry
->c
.ops
->poll(entry
,
454 data
->file_private_data
,
456 if (entry
->c
.ops
->read
)
457 mask
|= POLLIN
| POLLRDNORM
;
458 if (entry
->c
.ops
->write
)
459 mask
|= POLLOUT
| POLLWRNORM
;
465 static long snd_info_entry_ioctl(struct file
*file
, unsigned int cmd
,
468 struct snd_info_private_data
*data
;
469 struct snd_info_entry
*entry
;
471 data
= file
->private_data
;
475 switch (entry
->content
) {
476 case SNDRV_INFO_CONTENT_DATA
:
477 if (entry
->c
.ops
->ioctl
)
478 return entry
->c
.ops
->ioctl(entry
,
479 data
->file_private_data
,
486 static int snd_info_entry_mmap(struct file
*file
, struct vm_area_struct
*vma
)
488 struct inode
*inode
= file
->f_path
.dentry
->d_inode
;
489 struct snd_info_private_data
*data
;
490 struct snd_info_entry
*entry
;
492 data
= file
->private_data
;
496 switch (entry
->content
) {
497 case SNDRV_INFO_CONTENT_DATA
:
498 if (entry
->c
.ops
->mmap
)
499 return entry
->c
.ops
->mmap(entry
,
500 data
->file_private_data
,
507 static const struct file_operations snd_info_entry_operations
=
509 .owner
= THIS_MODULE
,
510 .llseek
= snd_info_entry_llseek
,
511 .read
= snd_info_entry_read
,
512 .write
= snd_info_entry_write
,
513 .poll
= snd_info_entry_poll
,
514 .unlocked_ioctl
= snd_info_entry_ioctl
,
515 .mmap
= snd_info_entry_mmap
,
516 .open
= snd_info_entry_open
,
517 .release
= snd_info_entry_release
,
520 int __init
snd_info_init(void)
522 struct proc_dir_entry
*p
;
524 p
= create_proc_entry("asound", S_IFDIR
| S_IRUGO
| S_IXUGO
, NULL
);
528 #ifdef CONFIG_SND_OSSEMUL
530 struct snd_info_entry
*entry
;
531 if ((entry
= snd_info_create_module_entry(THIS_MODULE
, "oss", NULL
)) == NULL
)
533 entry
->mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
;
534 if (snd_info_register(entry
) < 0) {
535 snd_info_free_entry(entry
);
538 snd_oss_root
= entry
;
541 #if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
543 struct snd_info_entry
*entry
;
544 if ((entry
= snd_info_create_module_entry(THIS_MODULE
, "seq", NULL
)) == NULL
)
546 entry
->mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
;
547 if (snd_info_register(entry
) < 0) {
548 snd_info_free_entry(entry
);
551 snd_seq_root
= entry
;
554 snd_info_version_init();
555 snd_minor_info_init();
556 snd_minor_info_oss_init();
557 snd_card_info_init();
561 int __exit
snd_info_done(void)
563 snd_card_info_done();
564 snd_minor_info_oss_done();
565 snd_minor_info_done();
566 snd_info_version_done();
568 #if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
569 snd_info_free_entry(snd_seq_root
);
571 #ifdef CONFIG_SND_OSSEMUL
572 snd_info_free_entry(snd_oss_root
);
574 snd_remove_proc_entry(NULL
, snd_proc_root
);
585 * create a card proc file
588 int snd_info_card_create(struct snd_card
*card
)
591 struct snd_info_entry
*entry
;
593 if (snd_BUG_ON(!card
))
596 sprintf(str
, "card%i", card
->number
);
597 if ((entry
= snd_info_create_module_entry(card
->module
, str
, NULL
)) == NULL
)
599 entry
->mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
;
600 if (snd_info_register(entry
) < 0) {
601 snd_info_free_entry(entry
);
604 card
->proc_root
= entry
;
609 * register the card proc file
612 int snd_info_card_register(struct snd_card
*card
)
614 struct proc_dir_entry
*p
;
616 if (snd_BUG_ON(!card
))
619 if (!strcmp(card
->id
, card
->proc_root
->name
))
622 p
= proc_symlink(card
->id
, snd_proc_root
, card
->proc_root
->name
);
625 card
->proc_root_link
= p
;
630 * called on card->id change
632 void snd_info_card_id_change(struct snd_card
*card
)
634 mutex_lock(&info_mutex
);
635 if (card
->proc_root_link
) {
636 snd_remove_proc_entry(snd_proc_root
, card
->proc_root_link
);
637 card
->proc_root_link
= NULL
;
639 if (strcmp(card
->id
, card
->proc_root
->name
))
640 card
->proc_root_link
= proc_symlink(card
->id
,
642 card
->proc_root
->name
);
643 mutex_unlock(&info_mutex
);
647 * de-register the card proc file
650 void snd_info_card_disconnect(struct snd_card
*card
)
654 mutex_lock(&info_mutex
);
655 if (card
->proc_root_link
) {
656 snd_remove_proc_entry(snd_proc_root
, card
->proc_root_link
);
657 card
->proc_root_link
= NULL
;
660 snd_info_disconnect(card
->proc_root
);
661 mutex_unlock(&info_mutex
);
665 * release the card proc file resources
668 int snd_info_card_free(struct snd_card
*card
)
672 snd_info_free_entry(card
->proc_root
);
673 card
->proc_root
= NULL
;
679 * snd_info_get_line - read one line from the procfs buffer
680 * @buffer: the procfs buffer
681 * @line: the buffer to store
682 * @len: the max. buffer size - 1
684 * Reads one line from the buffer and stores the string.
686 * Returns zero if successful, or 1 if error or EOF.
688 int snd_info_get_line(struct snd_info_buffer
*buffer
, char *line
, int len
)
692 if (len
<= 0 || buffer
->stop
|| buffer
->error
)
695 c
= buffer
->buffer
[buffer
->curr
++];
697 if (buffer
->curr
>= buffer
->size
)
702 if (buffer
->curr
>= buffer
->size
) {
707 while (c
!= '\n' && !buffer
->stop
) {
708 c
= buffer
->buffer
[buffer
->curr
++];
709 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 * Returns the updated pointer of the original string so that
728 * it can be used for the next call.
730 char *snd_info_get_str(char *dest
, 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 * Returns 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 * Returns 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 * Returns 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 snd_remove_proc_entry(root
, 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 * Returns 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 * Returns 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 p
= create_proc_entry(entry
->name
, entry
->mode
, root
);
953 mutex_unlock(&info_mutex
);
956 if (!S_ISDIR(entry
->mode
))
957 p
->proc_fops
= &snd_info_entry_operations
;
958 p
->size
= entry
->size
;
962 list_add_tail(&entry
->list
, &entry
->parent
->children
);
963 mutex_unlock(&info_mutex
);
967 EXPORT_SYMBOL(snd_info_register
);
973 static struct snd_info_entry
*snd_info_version_entry
;
975 static void snd_info_version_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
978 "Advanced Linux Sound Architecture Driver Version "
979 CONFIG_SND_VERSION CONFIG_SND_DATE
".\n"
983 static int __init
snd_info_version_init(void)
985 struct snd_info_entry
*entry
;
987 entry
= snd_info_create_module_entry(THIS_MODULE
, "version", NULL
);
990 entry
->c
.text
.read
= snd_info_version_read
;
991 if (snd_info_register(entry
) < 0) {
992 snd_info_free_entry(entry
);
995 snd_info_version_entry
= entry
;
999 static int __exit
snd_info_version_done(void)
1001 snd_info_free_entry(snd_info_version_entry
);
1005 #endif /* CONFIG_PROC_FS */