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
;
256 unsigned long realloc_size
;
258 data
= file
->private_data
;
259 if (snd_BUG_ON(!data
))
263 if (pos
< 0 || (long) pos
!= pos
|| (ssize_t
) count
< 0)
265 realloc_size
= (unsigned long) pos
+ (unsigned long) count
;
266 if (realloc_size
< (unsigned long) pos
|| realloc_size
> UINT_MAX
)
268 switch (entry
->content
) {
269 case SNDRV_INFO_CONTENT_TEXT
:
273 mutex_lock(&entry
->access
);
274 if (pos
+ count
>= buf
->len
) {
275 if (resize_info_buffer(buf
, pos
+ count
)) {
276 mutex_unlock(&entry
->access
);
280 if (copy_from_user(buf
->buffer
+ pos
, buffer
, count
)) {
281 mutex_unlock(&entry
->access
);
284 buf
->size
= pos
+ count
;
285 mutex_unlock(&entry
->access
);
288 case SNDRV_INFO_CONTENT_DATA
:
289 if (entry
->c
.ops
->write
&& count
> 0) {
290 size_t maxsize
= entry
->size
- pos
;
291 count
= min(count
, maxsize
);
292 size
= entry
->c
.ops
->write(entry
,
293 data
->file_private_data
,
294 file
, buffer
, count
, pos
);
298 if ((ssize_t
) size
> 0)
299 *offset
= pos
+ size
;
303 static int snd_info_entry_open(struct inode
*inode
, struct file
*file
)
305 struct snd_info_entry
*entry
;
306 struct snd_info_private_data
*data
;
307 struct snd_info_buffer
*buffer
;
310 mutex_lock(&info_mutex
);
311 entry
= PDE_DATA(inode
);
312 if (entry
== NULL
|| ! entry
->p
) {
313 mutex_unlock(&info_mutex
);
316 if (!try_module_get(entry
->module
)) {
320 mode
= file
->f_flags
& O_ACCMODE
;
321 if (mode
== O_RDONLY
|| mode
== O_RDWR
) {
322 if ((entry
->content
== SNDRV_INFO_CONTENT_DATA
&&
323 entry
->c
.ops
->read
== NULL
)) {
328 if (mode
== O_WRONLY
|| mode
== O_RDWR
) {
329 if ((entry
->content
== SNDRV_INFO_CONTENT_DATA
&&
330 entry
->c
.ops
->write
== NULL
)) {
335 data
= kzalloc(sizeof(*data
), GFP_KERNEL
);
341 switch (entry
->content
) {
342 case SNDRV_INFO_CONTENT_TEXT
:
343 if (mode
== O_RDONLY
|| mode
== O_RDWR
) {
344 buffer
= kzalloc(sizeof(*buffer
), GFP_KERNEL
);
347 data
->rbuffer
= buffer
;
348 buffer
->len
= PAGE_SIZE
;
349 buffer
->buffer
= kzalloc(buffer
->len
, GFP_KERNEL
);
350 if (buffer
->buffer
== NULL
)
353 if (mode
== O_WRONLY
|| mode
== O_RDWR
) {
354 buffer
= kzalloc(sizeof(*buffer
), GFP_KERNEL
);
357 data
->wbuffer
= buffer
;
358 buffer
->len
= PAGE_SIZE
;
359 buffer
->buffer
= kmalloc(buffer
->len
, GFP_KERNEL
);
360 if (buffer
->buffer
== NULL
)
364 case SNDRV_INFO_CONTENT_DATA
: /* data */
365 if (entry
->c
.ops
->open
) {
366 if ((err
= entry
->c
.ops
->open(entry
, mode
,
367 &data
->file_private_data
)) < 0) {
374 file
->private_data
= data
;
375 mutex_unlock(&info_mutex
);
376 if (entry
->content
== SNDRV_INFO_CONTENT_TEXT
&&
377 (mode
== O_RDONLY
|| mode
== O_RDWR
)) {
378 if (entry
->c
.text
.read
) {
379 mutex_lock(&entry
->access
);
380 entry
->c
.text
.read(entry
, data
->rbuffer
);
381 mutex_unlock(&entry
->access
);
388 kfree(data
->rbuffer
->buffer
);
389 kfree(data
->rbuffer
);
392 kfree(data
->wbuffer
->buffer
);
393 kfree(data
->wbuffer
);
398 module_put(entry
->module
);
400 mutex_unlock(&info_mutex
);
404 static int snd_info_entry_release(struct inode
*inode
, struct file
*file
)
406 struct snd_info_entry
*entry
;
407 struct snd_info_private_data
*data
;
410 mode
= file
->f_flags
& O_ACCMODE
;
411 data
= file
->private_data
;
413 switch (entry
->content
) {
414 case SNDRV_INFO_CONTENT_TEXT
:
416 kfree(data
->rbuffer
->buffer
);
417 kfree(data
->rbuffer
);
420 if (entry
->c
.text
.write
) {
421 entry
->c
.text
.write(entry
, data
->wbuffer
);
422 if (data
->wbuffer
->error
) {
423 snd_printk(KERN_WARNING
"data write error to %s (%i)\n",
425 data
->wbuffer
->error
);
428 kfree(data
->wbuffer
->buffer
);
429 kfree(data
->wbuffer
);
432 case SNDRV_INFO_CONTENT_DATA
:
433 if (entry
->c
.ops
->release
)
434 entry
->c
.ops
->release(entry
, mode
,
435 data
->file_private_data
);
438 module_put(entry
->module
);
443 static unsigned int snd_info_entry_poll(struct file
*file
, poll_table
* wait
)
445 struct snd_info_private_data
*data
;
446 struct snd_info_entry
*entry
;
449 data
= file
->private_data
;
454 switch (entry
->content
) {
455 case SNDRV_INFO_CONTENT_DATA
:
456 if (entry
->c
.ops
->poll
)
457 return entry
->c
.ops
->poll(entry
,
458 data
->file_private_data
,
460 if (entry
->c
.ops
->read
)
461 mask
|= POLLIN
| POLLRDNORM
;
462 if (entry
->c
.ops
->write
)
463 mask
|= POLLOUT
| POLLWRNORM
;
469 static long snd_info_entry_ioctl(struct file
*file
, unsigned int cmd
,
472 struct snd_info_private_data
*data
;
473 struct snd_info_entry
*entry
;
475 data
= file
->private_data
;
479 switch (entry
->content
) {
480 case SNDRV_INFO_CONTENT_DATA
:
481 if (entry
->c
.ops
->ioctl
)
482 return entry
->c
.ops
->ioctl(entry
,
483 data
->file_private_data
,
490 static int snd_info_entry_mmap(struct file
*file
, struct vm_area_struct
*vma
)
492 struct inode
*inode
= file_inode(file
);
493 struct snd_info_private_data
*data
;
494 struct snd_info_entry
*entry
;
496 data
= file
->private_data
;
500 switch (entry
->content
) {
501 case SNDRV_INFO_CONTENT_DATA
:
502 if (entry
->c
.ops
->mmap
)
503 return entry
->c
.ops
->mmap(entry
,
504 data
->file_private_data
,
511 static const struct file_operations snd_info_entry_operations
=
513 .owner
= THIS_MODULE
,
514 .llseek
= snd_info_entry_llseek
,
515 .read
= snd_info_entry_read
,
516 .write
= snd_info_entry_write
,
517 .poll
= snd_info_entry_poll
,
518 .unlocked_ioctl
= snd_info_entry_ioctl
,
519 .mmap
= snd_info_entry_mmap
,
520 .open
= snd_info_entry_open
,
521 .release
= snd_info_entry_release
,
524 int __init
snd_info_init(void)
526 struct proc_dir_entry
*p
;
528 p
= proc_mkdir("asound", NULL
);
532 #ifdef CONFIG_SND_OSSEMUL
534 struct snd_info_entry
*entry
;
535 if ((entry
= snd_info_create_module_entry(THIS_MODULE
, "oss", NULL
)) == NULL
)
537 entry
->mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
;
538 if (snd_info_register(entry
) < 0) {
539 snd_info_free_entry(entry
);
542 snd_oss_root
= entry
;
545 #if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
547 struct snd_info_entry
*entry
;
548 if ((entry
= snd_info_create_module_entry(THIS_MODULE
, "seq", NULL
)) == NULL
)
550 entry
->mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
;
551 if (snd_info_register(entry
) < 0) {
552 snd_info_free_entry(entry
);
555 snd_seq_root
= entry
;
558 snd_info_version_init();
559 snd_minor_info_init();
560 snd_minor_info_oss_init();
561 snd_card_info_init();
565 int __exit
snd_info_done(void)
567 snd_card_info_done();
568 snd_minor_info_oss_done();
569 snd_minor_info_done();
570 snd_info_version_done();
572 #if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
573 snd_info_free_entry(snd_seq_root
);
575 #ifdef CONFIG_SND_OSSEMUL
576 snd_info_free_entry(snd_oss_root
);
578 proc_remove(snd_proc_root
);
589 * create a card proc file
592 int snd_info_card_create(struct snd_card
*card
)
595 struct snd_info_entry
*entry
;
597 if (snd_BUG_ON(!card
))
600 sprintf(str
, "card%i", card
->number
);
601 if ((entry
= snd_info_create_module_entry(card
->module
, str
, NULL
)) == NULL
)
603 entry
->mode
= S_IFDIR
| S_IRUGO
| S_IXUGO
;
604 if (snd_info_register(entry
) < 0) {
605 snd_info_free_entry(entry
);
608 card
->proc_root
= entry
;
613 * register the card proc file
616 int snd_info_card_register(struct snd_card
*card
)
618 struct proc_dir_entry
*p
;
620 if (snd_BUG_ON(!card
))
623 if (!strcmp(card
->id
, card
->proc_root
->name
))
626 p
= proc_symlink(card
->id
, snd_proc_root
, card
->proc_root
->name
);
629 card
->proc_root_link
= p
;
634 * called on card->id change
636 void snd_info_card_id_change(struct snd_card
*card
)
638 mutex_lock(&info_mutex
);
639 if (card
->proc_root_link
) {
640 proc_remove(card
->proc_root_link
);
641 card
->proc_root_link
= NULL
;
643 if (strcmp(card
->id
, card
->proc_root
->name
))
644 card
->proc_root_link
= proc_symlink(card
->id
,
646 card
->proc_root
->name
);
647 mutex_unlock(&info_mutex
);
651 * de-register the card proc file
654 void snd_info_card_disconnect(struct snd_card
*card
)
658 mutex_lock(&info_mutex
);
659 proc_remove(card
->proc_root_link
);
660 card
->proc_root_link
= NULL
;
662 snd_info_disconnect(card
->proc_root
);
663 mutex_unlock(&info_mutex
);
667 * release the card proc file resources
670 int snd_info_card_free(struct snd_card
*card
)
674 snd_info_free_entry(card
->proc_root
);
675 card
->proc_root
= NULL
;
681 * snd_info_get_line - read one line from the procfs buffer
682 * @buffer: the procfs buffer
683 * @line: the buffer to store
684 * @len: the max. buffer size
686 * Reads one line from the buffer and stores the string.
688 * Return: Zero if successful, or 1 if error or EOF.
690 int snd_info_get_line(struct snd_info_buffer
*buffer
, char *line
, int len
)
694 if (snd_BUG_ON(!buffer
|| !buffer
->buffer
))
696 if (len
<= 0 || buffer
->stop
|| buffer
->error
)
698 while (!buffer
->stop
) {
699 c
= buffer
->buffer
[buffer
->curr
++];
700 if (buffer
->curr
>= buffer
->size
)
713 EXPORT_SYMBOL(snd_info_get_line
);
716 * snd_info_get_str - parse a string token
717 * @dest: the buffer to store the string token
718 * @src: the original string
719 * @len: the max. length of token - 1
721 * Parses the original string and copy a token to the given
724 * Return: The updated pointer of the original string so that
725 * it can be used for the next call.
727 const char *snd_info_get_str(char *dest
, const char *src
, int len
)
731 while (*src
== ' ' || *src
== '\t')
733 if (*src
== '"' || *src
== '\'') {
735 while (--len
> 0 && *src
&& *src
!= c
) {
741 while (--len
> 0 && *src
&& *src
!= ' ' && *src
!= '\t') {
746 while (*src
== ' ' || *src
== '\t')
751 EXPORT_SYMBOL(snd_info_get_str
);
754 * snd_info_create_entry - create an info entry
755 * @name: the proc file name
757 * Creates an info entry with the given file name and initializes as
760 * Usually called from other functions such as
761 * snd_info_create_card_entry().
763 * Return: The pointer of the new instance, or %NULL on failure.
765 static struct snd_info_entry
*snd_info_create_entry(const char *name
)
767 struct snd_info_entry
*entry
;
768 entry
= kzalloc(sizeof(*entry
), GFP_KERNEL
);
771 entry
->name
= kstrdup(name
, GFP_KERNEL
);
772 if (entry
->name
== NULL
) {
776 entry
->mode
= S_IFREG
| S_IRUGO
;
777 entry
->content
= SNDRV_INFO_CONTENT_TEXT
;
778 mutex_init(&entry
->access
);
779 INIT_LIST_HEAD(&entry
->children
);
780 INIT_LIST_HEAD(&entry
->list
);
785 * snd_info_create_module_entry - create an info entry for the given module
786 * @module: the module pointer
787 * @name: the file name
788 * @parent: the parent directory
790 * Creates a new info entry and assigns it to the given module.
792 * Return: The pointer of the new instance, or %NULL on failure.
794 struct snd_info_entry
*snd_info_create_module_entry(struct module
* module
,
796 struct snd_info_entry
*parent
)
798 struct snd_info_entry
*entry
= snd_info_create_entry(name
);
800 entry
->module
= module
;
801 entry
->parent
= parent
;
806 EXPORT_SYMBOL(snd_info_create_module_entry
);
809 * snd_info_create_card_entry - create an info entry for the given card
810 * @card: the card instance
811 * @name: the file name
812 * @parent: the parent directory
814 * Creates a new info entry and assigns it to the given card.
816 * Return: The pointer of the new instance, or %NULL on failure.
818 struct snd_info_entry
*snd_info_create_card_entry(struct snd_card
*card
,
820 struct snd_info_entry
* parent
)
822 struct snd_info_entry
*entry
= snd_info_create_entry(name
);
824 entry
->module
= card
->module
;
826 entry
->parent
= parent
;
831 EXPORT_SYMBOL(snd_info_create_card_entry
);
833 static void snd_info_disconnect(struct snd_info_entry
*entry
)
835 struct list_head
*p
, *n
;
836 struct proc_dir_entry
*root
;
838 list_for_each_safe(p
, n
, &entry
->children
) {
839 snd_info_disconnect(list_entry(p
, struct snd_info_entry
, list
));
844 list_del_init(&entry
->list
);
845 root
= entry
->parent
== NULL
? snd_proc_root
: entry
->parent
->p
;
847 proc_remove(entry
->p
);
851 static int snd_info_dev_free_entry(struct snd_device
*device
)
853 struct snd_info_entry
*entry
= device
->device_data
;
854 snd_info_free_entry(entry
);
858 static int snd_info_dev_register_entry(struct snd_device
*device
)
860 struct snd_info_entry
*entry
= device
->device_data
;
861 return snd_info_register(entry
);
865 * snd_card_proc_new - create an info entry for the given card
866 * @card: the card instance
867 * @name: the file name
868 * @entryp: the pointer to store the new info entry
870 * Creates a new info entry and assigns it to the given card.
871 * Unlike snd_info_create_card_entry(), this function registers the
872 * info entry as an ALSA device component, so that it can be
873 * unregistered/released without explicit call.
874 * Also, you don't have to register this entry via snd_info_register(),
875 * since this will be registered by snd_card_register() automatically.
877 * The parent is assumed as card->proc_root.
879 * For releasing this entry, use snd_device_free() instead of
880 * snd_info_free_entry().
882 * Return: Zero if successful, or a negative error code on failure.
884 int snd_card_proc_new(struct snd_card
*card
, const char *name
,
885 struct snd_info_entry
**entryp
)
887 static struct snd_device_ops ops
= {
888 .dev_free
= snd_info_dev_free_entry
,
889 .dev_register
= snd_info_dev_register_entry
,
890 /* disconnect is done via snd_info_card_disconnect() */
892 struct snd_info_entry
*entry
;
895 entry
= snd_info_create_card_entry(card
, name
, card
->proc_root
);
898 if ((err
= snd_device_new(card
, SNDRV_DEV_INFO
, entry
, &ops
)) < 0) {
899 snd_info_free_entry(entry
);
907 EXPORT_SYMBOL(snd_card_proc_new
);
910 * snd_info_free_entry - release the info entry
911 * @entry: the info entry
913 * Releases the info entry. Don't call this after registered.
915 void snd_info_free_entry(struct snd_info_entry
* entry
)
920 mutex_lock(&info_mutex
);
921 snd_info_disconnect(entry
);
922 mutex_unlock(&info_mutex
);
925 if (entry
->private_free
)
926 entry
->private_free(entry
);
930 EXPORT_SYMBOL(snd_info_free_entry
);
933 * snd_info_register - register the info entry
934 * @entry: the info entry
936 * Registers the proc info entry.
938 * Return: Zero if successful, or a negative error code on failure.
940 int snd_info_register(struct snd_info_entry
* entry
)
942 struct proc_dir_entry
*root
, *p
= NULL
;
944 if (snd_BUG_ON(!entry
))
946 root
= entry
->parent
== NULL
? snd_proc_root
: entry
->parent
->p
;
947 mutex_lock(&info_mutex
);
948 if (S_ISDIR(entry
->mode
)) {
949 p
= proc_mkdir_mode(entry
->name
, entry
->mode
, root
);
951 mutex_unlock(&info_mutex
);
955 p
= proc_create_data(entry
->name
, entry
->mode
, root
,
956 &snd_info_entry_operations
, entry
);
958 mutex_unlock(&info_mutex
);
961 proc_set_size(p
, entry
->size
);
965 list_add_tail(&entry
->list
, &entry
->parent
->children
);
966 mutex_unlock(&info_mutex
);
970 EXPORT_SYMBOL(snd_info_register
);
976 static struct snd_info_entry
*snd_info_version_entry
;
978 static void snd_info_version_read(struct snd_info_entry
*entry
, struct snd_info_buffer
*buffer
)
981 "Advanced Linux Sound Architecture Driver Version k%s.\n",
982 init_utsname()->release
);
985 static int __init
snd_info_version_init(void)
987 struct snd_info_entry
*entry
;
989 entry
= snd_info_create_module_entry(THIS_MODULE
, "version", NULL
);
992 entry
->c
.text
.read
= snd_info_version_read
;
993 if (snd_info_register(entry
) < 0) {
994 snd_info_free_entry(entry
);
997 snd_info_version_entry
= entry
;
1001 static int __exit
snd_info_version_done(void)
1003 snd_info_free_entry(snd_info_version_entry
);
1007 #endif /* CONFIG_PROC_FS */