2 * Initialization routines
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/sched.h>
24 #include <linux/file.h>
25 #include <linux/slab.h>
26 #include <linux/time.h>
27 #include <linux/ctype.h>
30 #include <sound/core.h>
31 #include <sound/control.h>
32 #include <sound/info.h>
34 static DEFINE_SPINLOCK(shutdown_lock
);
35 static LIST_HEAD(shutdown_files
);
37 static const struct file_operations snd_shutdown_f_ops
;
39 static unsigned int snd_cards_lock
; /* locked for registering/using */
40 struct snd_card
*snd_cards
[SNDRV_CARDS
];
41 EXPORT_SYMBOL(snd_cards
);
43 static DEFINE_MUTEX(snd_card_mutex
);
45 static char *slots
[SNDRV_CARDS
];
46 module_param_array(slots
, charp
, NULL
, 0444);
47 MODULE_PARM_DESC(slots
, "Module names assigned to the slots.");
49 /* return non-zero if the given index is reserved for the given
50 * module via slots option
52 static int module_slot_match(struct module
*module
, int idx
)
58 if (!module
|| !module
->name
|| !slots
[idx
])
64 match
= 0; /* negative match */
67 /* compare module name strings
68 * hyphens are handled as equivalent with underscore
86 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
87 int (*snd_mixer_oss_notify_callback
)(struct snd_card
*card
, int free_flag
);
88 EXPORT_SYMBOL(snd_mixer_oss_notify_callback
);
92 static void snd_card_id_read(struct snd_info_entry
*entry
,
93 struct snd_info_buffer
*buffer
)
95 snd_iprintf(buffer
, "%s\n", entry
->card
->id
);
98 static inline int init_info_for_card(struct snd_card
*card
)
101 struct snd_info_entry
*entry
;
103 if ((err
= snd_info_card_register(card
)) < 0) {
104 snd_printd("unable to create card info\n");
107 if ((entry
= snd_info_create_card_entry(card
, "id", card
->proc_root
)) == NULL
) {
108 snd_printd("unable to create card entry\n");
111 entry
->c
.text
.read
= snd_card_id_read
;
112 if (snd_info_register(entry
) < 0) {
113 snd_info_free_entry(entry
);
116 card
->proc_id
= entry
;
119 #else /* !CONFIG_PROC_FS */
120 #define init_info_for_card(card)
124 * snd_card_new - create and initialize a soundcard structure
125 * @idx: card index (address) [0 ... (SNDRV_CARDS-1)]
126 * @xid: card identification (ASCII string)
127 * @module: top level module for locking
128 * @extra_size: allocate this extra size after the main soundcard structure
130 * Creates and initializes a soundcard structure.
132 * Returns kmallocated snd_card structure. Creates the ALSA control interface
133 * (which is blocked until snd_card_register function is called).
135 struct snd_card
*snd_card_new(int idx
, const char *xid
,
136 struct module
*module
, int extra_size
)
138 struct snd_card
*card
;
143 card
= kzalloc(sizeof(*card
) + extra_size
, GFP_KERNEL
);
147 if (!snd_info_check_reserved_words(xid
))
149 strlcpy(card
->id
, xid
, sizeof(card
->id
));
152 mutex_lock(&snd_card_mutex
);
154 for (idx2
= 0; idx2
< SNDRV_CARDS
; idx2
++)
155 /* idx == -1 == 0xffff means: take any free slot */
156 if (~snd_cards_lock
& idx
& 1<<idx2
) {
157 if (module_slot_match(module
, idx2
)) {
164 for (idx2
= 0; idx2
< SNDRV_CARDS
; idx2
++)
165 /* idx == -1 == 0xffff means: take any free slot */
166 if (~snd_cards_lock
& idx
& 1<<idx2
) {
167 if (!slots
[idx2
] || !*slots
[idx2
]) {
175 else if (idx
< snd_ecards_limit
) {
176 if (snd_cards_lock
& (1 << idx
))
177 err
= -EBUSY
; /* invalid */
178 } else if (idx
>= SNDRV_CARDS
)
181 mutex_unlock(&snd_card_mutex
);
182 snd_printk(KERN_ERR
"cannot find the slot for index %d (range 0-%i), error: %d\n",
183 idx
, snd_ecards_limit
- 1, err
);
186 snd_cards_lock
|= 1 << idx
; /* lock it */
187 if (idx
>= snd_ecards_limit
)
188 snd_ecards_limit
= idx
+ 1; /* increase the limit */
189 mutex_unlock(&snd_card_mutex
);
191 card
->module
= module
;
192 INIT_LIST_HEAD(&card
->devices
);
193 init_rwsem(&card
->controls_rwsem
);
194 rwlock_init(&card
->ctl_files_rwlock
);
195 INIT_LIST_HEAD(&card
->controls
);
196 INIT_LIST_HEAD(&card
->ctl_files
);
197 spin_lock_init(&card
->files_lock
);
198 init_waitqueue_head(&card
->shutdown_sleep
);
200 mutex_init(&card
->power_lock
);
201 init_waitqueue_head(&card
->power_sleep
);
203 /* the control interface cannot be accessed from the user space until */
204 /* snd_cards_bitmask and snd_cards are set with snd_card_register */
205 if ((err
= snd_ctl_create(card
)) < 0) {
206 snd_printd("unable to register control minors\n");
209 if ((err
= snd_info_card_create(card
)) < 0) {
210 snd_printd("unable to create card info\n");
214 card
->private_data
= (char *)card
+ sizeof(struct snd_card
);
218 snd_device_free_all(card
, SNDRV_DEV_CMD_PRE
);
224 EXPORT_SYMBOL(snd_card_new
);
226 /* return non-zero if a card is already locked */
227 int snd_card_locked(int card
)
231 mutex_lock(&snd_card_mutex
);
232 locked
= snd_cards_lock
& (1 << card
);
233 mutex_unlock(&snd_card_mutex
);
237 static loff_t
snd_disconnect_llseek(struct file
*file
, loff_t offset
, int orig
)
242 static ssize_t
snd_disconnect_read(struct file
*file
, char __user
*buf
,
243 size_t count
, loff_t
*offset
)
248 static ssize_t
snd_disconnect_write(struct file
*file
, const char __user
*buf
,
249 size_t count
, loff_t
*offset
)
254 static int snd_disconnect_release(struct inode
*inode
, struct file
*file
)
256 struct snd_monitor_file
*df
= NULL
, *_df
;
258 spin_lock(&shutdown_lock
);
259 list_for_each_entry(_df
, &shutdown_files
, shutdown_list
) {
260 if (_df
->file
== file
) {
265 spin_unlock(&shutdown_lock
);
268 return df
->disconnected_f_op
->release(inode
, file
);
270 panic("%s(%p, %p) failed!", __func__
, inode
, file
);
273 static unsigned int snd_disconnect_poll(struct file
* file
, poll_table
* wait
)
275 return POLLERR
| POLLNVAL
;
278 static long snd_disconnect_ioctl(struct file
*file
,
279 unsigned int cmd
, unsigned long arg
)
284 static int snd_disconnect_mmap(struct file
*file
, struct vm_area_struct
*vma
)
289 static int snd_disconnect_fasync(int fd
, struct file
*file
, int on
)
294 static const struct file_operations snd_shutdown_f_ops
=
296 .owner
= THIS_MODULE
,
297 .llseek
= snd_disconnect_llseek
,
298 .read
= snd_disconnect_read
,
299 .write
= snd_disconnect_write
,
300 .release
= snd_disconnect_release
,
301 .poll
= snd_disconnect_poll
,
302 .unlocked_ioctl
= snd_disconnect_ioctl
,
304 .compat_ioctl
= snd_disconnect_ioctl
,
306 .mmap
= snd_disconnect_mmap
,
307 .fasync
= snd_disconnect_fasync
311 * snd_card_disconnect - disconnect all APIs from the file-operations (user space)
312 * @card: soundcard structure
314 * Disconnects all APIs from the file-operations (user space).
316 * Returns zero, otherwise a negative error code.
318 * Note: The current implementation replaces all active file->f_op with special
319 * dummy file operations (they do nothing except release).
321 int snd_card_disconnect(struct snd_card
*card
)
323 struct snd_monitor_file
*mfile
;
330 spin_lock(&card
->files_lock
);
331 if (card
->shutdown
) {
332 spin_unlock(&card
->files_lock
);
336 spin_unlock(&card
->files_lock
);
338 /* phase 1: disable fops (user space) operations for ALSA API */
339 mutex_lock(&snd_card_mutex
);
340 snd_cards
[card
->number
] = NULL
;
341 snd_cards_lock
&= ~(1 << card
->number
);
342 mutex_unlock(&snd_card_mutex
);
344 /* phase 2: replace file->f_op with special dummy operations */
346 spin_lock(&card
->files_lock
);
351 /* it's critical part, use endless loop */
352 /* we have no room to fail */
353 mfile
->disconnected_f_op
= mfile
->file
->f_op
;
355 spin_lock(&shutdown_lock
);
356 list_add(&mfile
->shutdown_list
, &shutdown_files
);
357 spin_unlock(&shutdown_lock
);
359 mfile
->file
->f_op
= &snd_shutdown_f_ops
;
360 fops_get(mfile
->file
->f_op
);
364 spin_unlock(&card
->files_lock
);
366 /* phase 3: notify all connected devices about disconnection */
367 /* at this point, they cannot respond to any calls except release() */
369 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
370 if (snd_mixer_oss_notify_callback
)
371 snd_mixer_oss_notify_callback(card
, SND_MIXER_OSS_NOTIFY_DISCONNECT
);
374 /* notify all devices that we are disconnected */
375 err
= snd_device_disconnect_all(card
);
377 snd_printk(KERN_ERR
"not all devices for card %i can be disconnected\n", card
->number
);
379 snd_info_card_disconnect(card
);
380 #ifndef CONFIG_SYSFS_DEPRECATED
381 if (card
->card_dev
) {
382 device_unregister(card
->card_dev
);
383 card
->card_dev
= NULL
;
387 wake_up(&card
->power_sleep
);
392 EXPORT_SYMBOL(snd_card_disconnect
);
395 * snd_card_free - frees given soundcard structure
396 * @card: soundcard structure
398 * This function releases the soundcard structure and the all assigned
399 * devices automatically. That is, you don't have to release the devices
402 * Returns zero. Frees all associated devices and frees the control
403 * interface associated to given soundcard.
405 static int snd_card_do_free(struct snd_card
*card
)
407 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
408 if (snd_mixer_oss_notify_callback
)
409 snd_mixer_oss_notify_callback(card
, SND_MIXER_OSS_NOTIFY_FREE
);
411 if (snd_device_free_all(card
, SNDRV_DEV_CMD_PRE
) < 0) {
412 snd_printk(KERN_ERR
"unable to free all devices (pre)\n");
413 /* Fatal, but this situation should never occur */
415 if (snd_device_free_all(card
, SNDRV_DEV_CMD_NORMAL
) < 0) {
416 snd_printk(KERN_ERR
"unable to free all devices (normal)\n");
417 /* Fatal, but this situation should never occur */
419 if (snd_device_free_all(card
, SNDRV_DEV_CMD_POST
) < 0) {
420 snd_printk(KERN_ERR
"unable to free all devices (post)\n");
421 /* Fatal, but this situation should never occur */
423 if (card
->private_free
)
424 card
->private_free(card
);
425 snd_info_free_entry(card
->proc_id
);
426 if (snd_info_card_free(card
) < 0) {
427 snd_printk(KERN_WARNING
"unable to free card info\n");
428 /* Not fatal error */
434 int snd_card_free_when_closed(struct snd_card
*card
)
437 int ret
= snd_card_disconnect(card
);
441 spin_lock(&card
->files_lock
);
442 if (card
->files
== NULL
)
445 card
->free_on_last_close
= 1;
446 spin_unlock(&card
->files_lock
);
449 snd_card_do_free(card
);
453 EXPORT_SYMBOL(snd_card_free_when_closed
);
455 int snd_card_free(struct snd_card
*card
)
457 int ret
= snd_card_disconnect(card
);
461 /* wait, until all devices are ready for the free operation */
462 wait_event(card
->shutdown_sleep
, card
->files
== NULL
);
463 snd_card_do_free(card
);
467 EXPORT_SYMBOL(snd_card_free
);
469 static void choose_default_id(struct snd_card
*card
)
471 int i
, len
, idx_flag
= 0, loops
= SNDRV_CARDS
;
474 id
= spos
= card
->shortname
;
475 while (*id
!= '\0') {
481 while (*spos
!= '\0' && !isalnum(*spos
))
484 *id
++ = isalpha(card
->shortname
[0]) ? card
->shortname
[0] : 'D';
485 while (*spos
!= '\0' && (size_t)(id
- card
->id
) < sizeof(card
->id
) - 1) {
495 strcpy(id
, "default");
499 snd_printk(KERN_ERR
"unable to choose default card id (%s)\n", id
);
500 strcpy(card
->id
, card
->proc_root
->name
);
503 if (!snd_info_check_reserved_words(id
))
505 for (i
= 0; i
< snd_ecards_limit
; i
++) {
506 if (snd_cards
[i
] && !strcmp(snd_cards
[i
]->id
, id
))
514 if (id
[len
-1] != '9')
518 } else if ((size_t)len
<= sizeof(card
->id
) - 3) {
523 if ((size_t)len
<= sizeof(card
->id
) - 2)
534 * snd_card_register - register the soundcard
535 * @card: soundcard structure
537 * This function registers all the devices assigned to the soundcard.
538 * Until calling this, the ALSA control interface is blocked from the
539 * external accesses. Thus, you should call this function at the end
540 * of the initialization of the card.
542 * Returns zero otherwise a negative error code if the registrain failed.
544 int snd_card_register(struct snd_card
*card
)
548 snd_assert(card
!= NULL
, return -EINVAL
);
549 #ifndef CONFIG_SYSFS_DEPRECATED
550 if (!card
->card_dev
) {
551 card
->card_dev
= device_create_drvdata(sound_class
, card
->dev
,
553 "card%i", card
->number
);
554 if (IS_ERR(card
->card_dev
))
555 card
->card_dev
= NULL
;
558 if ((err
= snd_device_register_all(card
)) < 0)
560 mutex_lock(&snd_card_mutex
);
561 if (snd_cards
[card
->number
]) {
562 /* already registered */
563 mutex_unlock(&snd_card_mutex
);
566 if (card
->id
[0] == '\0')
567 choose_default_id(card
);
568 snd_cards
[card
->number
] = card
;
569 mutex_unlock(&snd_card_mutex
);
570 init_info_for_card(card
);
571 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
572 if (snd_mixer_oss_notify_callback
)
573 snd_mixer_oss_notify_callback(card
, SND_MIXER_OSS_NOTIFY_REGISTER
);
578 EXPORT_SYMBOL(snd_card_register
);
580 #ifdef CONFIG_PROC_FS
581 static struct snd_info_entry
*snd_card_info_entry
;
583 static void snd_card_info_read(struct snd_info_entry
*entry
,
584 struct snd_info_buffer
*buffer
)
587 struct snd_card
*card
;
589 for (idx
= count
= 0; idx
< SNDRV_CARDS
; idx
++) {
590 mutex_lock(&snd_card_mutex
);
591 if ((card
= snd_cards
[idx
]) != NULL
) {
593 snd_iprintf(buffer
, "%2i [%-15s]: %s - %s\n",
598 snd_iprintf(buffer
, " %s\n",
601 mutex_unlock(&snd_card_mutex
);
604 snd_iprintf(buffer
, "--- no soundcards ---\n");
607 #ifdef CONFIG_SND_OSSEMUL
609 void snd_card_info_read_oss(struct snd_info_buffer
*buffer
)
612 struct snd_card
*card
;
614 for (idx
= count
= 0; idx
< SNDRV_CARDS
; idx
++) {
615 mutex_lock(&snd_card_mutex
);
616 if ((card
= snd_cards
[idx
]) != NULL
) {
618 snd_iprintf(buffer
, "%s\n", card
->longname
);
620 mutex_unlock(&snd_card_mutex
);
623 snd_iprintf(buffer
, "--- no soundcards ---\n");
630 static struct snd_info_entry
*snd_card_module_info_entry
;
631 static void snd_card_module_info_read(struct snd_info_entry
*entry
,
632 struct snd_info_buffer
*buffer
)
635 struct snd_card
*card
;
637 for (idx
= 0; idx
< SNDRV_CARDS
; idx
++) {
638 mutex_lock(&snd_card_mutex
);
639 if ((card
= snd_cards
[idx
]) != NULL
)
640 snd_iprintf(buffer
, "%2i %s\n",
641 idx
, card
->module
->name
);
642 mutex_unlock(&snd_card_mutex
);
647 int __init
snd_card_info_init(void)
649 struct snd_info_entry
*entry
;
651 entry
= snd_info_create_module_entry(THIS_MODULE
, "cards", NULL
);
654 entry
->c
.text
.read
= snd_card_info_read
;
655 if (snd_info_register(entry
) < 0) {
656 snd_info_free_entry(entry
);
659 snd_card_info_entry
= entry
;
662 entry
= snd_info_create_module_entry(THIS_MODULE
, "modules", NULL
);
664 entry
->c
.text
.read
= snd_card_module_info_read
;
665 if (snd_info_register(entry
) < 0)
666 snd_info_free_entry(entry
);
668 snd_card_module_info_entry
= entry
;
675 int __exit
snd_card_info_done(void)
677 snd_info_free_entry(snd_card_info_entry
);
679 snd_info_free_entry(snd_card_module_info_entry
);
684 #endif /* CONFIG_PROC_FS */
687 * snd_component_add - add a component string
688 * @card: soundcard structure
689 * @component: the component id string
691 * This function adds the component id string to the supported list.
692 * The component can be referred from the alsa-lib.
694 * Returns zero otherwise a negative error code.
697 int snd_component_add(struct snd_card
*card
, const char *component
)
700 int len
= strlen(component
);
702 ptr
= strstr(card
->components
, component
);
704 if (ptr
[len
] == '\0' || ptr
[len
] == ' ') /* already there */
707 if (strlen(card
->components
) + 1 + len
+ 1 > sizeof(card
->components
)) {
711 if (card
->components
[0] != '\0')
712 strcat(card
->components
, " ");
713 strcat(card
->components
, component
);
717 EXPORT_SYMBOL(snd_component_add
);
720 * snd_card_file_add - add the file to the file list of the card
721 * @card: soundcard structure
722 * @file: file pointer
724 * This function adds the file to the file linked-list of the card.
725 * This linked-list is used to keep tracking the connection state,
726 * and to avoid the release of busy resources by hotplug.
728 * Returns zero or a negative error code.
730 int snd_card_file_add(struct snd_card
*card
, struct file
*file
)
732 struct snd_monitor_file
*mfile
;
734 mfile
= kmalloc(sizeof(*mfile
), GFP_KERNEL
);
738 mfile
->disconnected_f_op
= NULL
;
740 spin_lock(&card
->files_lock
);
741 if (card
->shutdown
) {
742 spin_unlock(&card
->files_lock
);
746 mfile
->next
= card
->files
;
748 spin_unlock(&card
->files_lock
);
752 EXPORT_SYMBOL(snd_card_file_add
);
755 * snd_card_file_remove - remove the file from the file list
756 * @card: soundcard structure
757 * @file: file pointer
759 * This function removes the file formerly added to the card via
760 * snd_card_file_add() function.
761 * If all files are removed and snd_card_free_when_closed() was
762 * called beforehand, it processes the pending release of
765 * Returns zero or a negative error code.
767 int snd_card_file_remove(struct snd_card
*card
, struct file
*file
)
769 struct snd_monitor_file
*mfile
, *pfile
= NULL
;
772 spin_lock(&card
->files_lock
);
775 if (mfile
->file
== file
) {
777 pfile
->next
= mfile
->next
;
779 card
->files
= mfile
->next
;
785 if (mfile
&& mfile
->disconnected_f_op
) {
786 fops_put(mfile
->disconnected_f_op
);
787 spin_lock(&shutdown_lock
);
788 list_del(&mfile
->shutdown_list
);
789 spin_unlock(&shutdown_lock
);
791 if (card
->files
== NULL
)
793 spin_unlock(&card
->files_lock
);
795 wake_up(&card
->shutdown_sleep
);
796 if (card
->free_on_last_close
)
797 snd_card_do_free(card
);
800 snd_printk(KERN_ERR
"ALSA card file remove problem (%p)\n", file
);
807 EXPORT_SYMBOL(snd_card_file_remove
);
811 * snd_power_wait - wait until the power-state is changed.
812 * @card: soundcard structure
813 * @power_state: expected power state
815 * Waits until the power-state is changed.
817 * Note: the power lock must be active before call.
819 int snd_power_wait(struct snd_card
*card
, unsigned int power_state
)
825 if (snd_power_get_state(card
) == power_state
)
827 init_waitqueue_entry(&wait
, current
);
828 add_wait_queue(&card
->power_sleep
, &wait
);
830 if (card
->shutdown
) {
834 if (snd_power_get_state(card
) == power_state
)
836 set_current_state(TASK_UNINTERRUPTIBLE
);
837 snd_power_unlock(card
);
838 schedule_timeout(30 * HZ
);
839 snd_power_lock(card
);
841 remove_wait_queue(&card
->power_sleep
, &wait
);
845 EXPORT_SYMBOL(snd_power_wait
);
846 #endif /* CONFIG_PM */