2 * Initialization routines
3 * Copyright (c) by Jaroslav Kysela <perex@suse.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 <sound/driver.h>
23 #include <linux/init.h>
24 #include <linux/sched.h>
25 #include <linux/file.h>
26 #include <linux/slab.h>
27 #include <linux/time.h>
28 #include <linux/ctype.h>
29 #include <linux/pci.h>
32 #include <sound/core.h>
33 #include <sound/control.h>
34 #include <sound/info.h>
36 struct snd_shutdown_f_ops
{
37 struct file_operations f_ops
;
38 struct snd_shutdown_f_ops
*next
;
41 unsigned int snd_cards_lock
= 0; /* locked for registering/using */
42 struct snd_card
*snd_cards
[SNDRV_CARDS
] = {[0 ... (SNDRV_CARDS
-1)] = NULL
};
43 DEFINE_RWLOCK(snd_card_rwlock
);
45 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
46 int (*snd_mixer_oss_notify_callback
)(struct snd_card
*card
, int free_flag
);
50 static void snd_card_id_read(struct snd_info_entry
*entry
,
51 struct snd_info_buffer
*buffer
)
53 snd_iprintf(buffer
, "%s\n", entry
->card
->id
);
56 static inline int init_info_for_card(struct snd_card
*card
)
59 struct snd_info_entry
*entry
;
61 if ((err
= snd_info_card_register(card
)) < 0) {
62 snd_printd("unable to create card info\n");
65 if ((entry
= snd_info_create_card_entry(card
, "id", card
->proc_root
)) == NULL
) {
66 snd_printd("unable to create card entry\n");
69 entry
->c
.text
.read_size
= PAGE_SIZE
;
70 entry
->c
.text
.read
= snd_card_id_read
;
71 if (snd_info_register(entry
) < 0) {
72 snd_info_free_entry(entry
);
75 card
->proc_id
= entry
;
78 #else /* !CONFIG_PROC_FS */
79 #define init_info_for_card(card)
82 static void snd_card_free_thread(void * __card
);
85 * snd_card_new - create and initialize a soundcard structure
86 * @idx: card index (address) [0 ... (SNDRV_CARDS-1)]
87 * @xid: card identification (ASCII string)
88 * @module: top level module for locking
89 * @extra_size: allocate this extra size after the main soundcard structure
91 * Creates and initializes a soundcard structure.
93 * Returns kmallocated snd_card structure. Creates the ALSA control interface
94 * (which is blocked until snd_card_register function is called).
96 struct snd_card
*snd_card_new(int idx
, const char *xid
,
97 struct module
*module
, int extra_size
)
99 struct snd_card
*card
;
104 card
= kzalloc(sizeof(*card
) + extra_size
, GFP_KERNEL
);
108 if (!snd_info_check_reserved_words(xid
))
110 strlcpy(card
->id
, xid
, sizeof(card
->id
));
113 write_lock(&snd_card_rwlock
);
116 for (idx2
= 0; idx2
< SNDRV_CARDS
; idx2
++)
117 if (~snd_cards_lock
& idx
& 1<<idx2
) {
119 if (idx
>= snd_ecards_limit
)
120 snd_ecards_limit
= idx
+ 1;
123 } else if (idx
< snd_ecards_limit
) {
124 if (snd_cards_lock
& (1 << idx
))
125 err
= -ENODEV
; /* invalid */
126 } else if (idx
< SNDRV_CARDS
)
127 snd_ecards_limit
= idx
+ 1; /* increase the limit */
130 if (idx
< 0 || err
< 0) {
131 write_unlock(&snd_card_rwlock
);
132 snd_printk(KERN_ERR
"cannot find the slot for index %d (range 0-%i)\n", idx
, snd_ecards_limit
- 1);
135 snd_cards_lock
|= 1 << idx
; /* lock it */
136 write_unlock(&snd_card_rwlock
);
138 card
->module
= module
;
139 INIT_LIST_HEAD(&card
->devices
);
140 init_rwsem(&card
->controls_rwsem
);
141 rwlock_init(&card
->ctl_files_rwlock
);
142 INIT_LIST_HEAD(&card
->controls
);
143 INIT_LIST_HEAD(&card
->ctl_files
);
144 spin_lock_init(&card
->files_lock
);
145 init_waitqueue_head(&card
->shutdown_sleep
);
146 INIT_WORK(&card
->free_workq
, snd_card_free_thread
, card
);
148 mutex_init(&card
->power_lock
);
149 init_waitqueue_head(&card
->power_sleep
);
151 /* the control interface cannot be accessed from the user space until */
152 /* snd_cards_bitmask and snd_cards are set with snd_card_register */
153 if ((err
= snd_ctl_create(card
)) < 0) {
154 snd_printd("unable to register control minors\n");
157 if ((err
= snd_info_card_create(card
)) < 0) {
158 snd_printd("unable to create card info\n");
162 card
->private_data
= (char *)card
+ sizeof(struct snd_card
);
166 snd_device_free_all(card
, SNDRV_DEV_CMD_PRE
);
172 static loff_t
snd_disconnect_llseek(struct file
*file
, loff_t offset
, int orig
)
177 static ssize_t
snd_disconnect_read(struct file
*file
, char __user
*buf
,
178 size_t count
, loff_t
*offset
)
183 static ssize_t
snd_disconnect_write(struct file
*file
, const char __user
*buf
,
184 size_t count
, loff_t
*offset
)
189 static unsigned int snd_disconnect_poll(struct file
* file
, poll_table
* wait
)
191 return POLLERR
| POLLNVAL
;
194 static long snd_disconnect_ioctl(struct file
*file
,
195 unsigned int cmd
, unsigned long arg
)
200 static int snd_disconnect_mmap(struct file
*file
, struct vm_area_struct
*vma
)
205 static int snd_disconnect_fasync(int fd
, struct file
*file
, int on
)
211 * snd_card_disconnect - disconnect all APIs from the file-operations (user space)
212 * @card: soundcard structure
214 * Disconnects all APIs from the file-operations (user space).
216 * Returns zero, otherwise a negative error code.
218 * Note: The current implementation replaces all active file->f_op with special
219 * dummy file operations (they do nothing except release).
221 int snd_card_disconnect(struct snd_card
*card
)
223 struct snd_monitor_file
*mfile
;
225 struct snd_shutdown_f_ops
*s_f_ops
;
226 struct file_operations
*f_ops
;
227 const struct file_operations
*old_f_ops
;
230 spin_lock(&card
->files_lock
);
231 if (card
->shutdown
) {
232 spin_unlock(&card
->files_lock
);
236 spin_unlock(&card
->files_lock
);
238 /* phase 1: disable fops (user space) operations for ALSA API */
239 write_lock(&snd_card_rwlock
);
240 snd_cards
[card
->number
] = NULL
;
241 write_unlock(&snd_card_rwlock
);
243 /* phase 2: replace file->f_op with special dummy operations */
245 spin_lock(&card
->files_lock
);
250 /* it's critical part, use endless loop */
251 /* we have no room to fail */
252 s_f_ops
= kmalloc(sizeof(struct snd_shutdown_f_ops
), GFP_ATOMIC
);
254 panic("Atomic allocation failed for snd_shutdown_f_ops!");
256 f_ops
= &s_f_ops
->f_ops
;
258 memset(f_ops
, 0, sizeof(*f_ops
));
259 f_ops
->owner
= file
->f_op
->owner
;
260 f_ops
->release
= file
->f_op
->release
;
261 f_ops
->llseek
= snd_disconnect_llseek
;
262 f_ops
->read
= snd_disconnect_read
;
263 f_ops
->write
= snd_disconnect_write
;
264 f_ops
->poll
= snd_disconnect_poll
;
265 f_ops
->unlocked_ioctl
= snd_disconnect_ioctl
;
267 f_ops
->compat_ioctl
= snd_disconnect_ioctl
;
269 f_ops
->mmap
= snd_disconnect_mmap
;
270 f_ops
->fasync
= snd_disconnect_fasync
;
272 s_f_ops
->next
= card
->s_f_ops
;
273 card
->s_f_ops
= s_f_ops
;
275 f_ops
= fops_get(f_ops
);
277 old_f_ops
= file
->f_op
;
278 file
->f_op
= f_ops
; /* must be atomic */
283 spin_unlock(&card
->files_lock
);
285 /* phase 3: notify all connected devices about disconnection */
286 /* at this point, they cannot respond to any calls except release() */
288 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
289 if (snd_mixer_oss_notify_callback
)
290 snd_mixer_oss_notify_callback(card
, SND_MIXER_OSS_NOTIFY_DISCONNECT
);
293 /* notify all devices that we are disconnected */
294 err
= snd_device_disconnect_all(card
);
296 snd_printk(KERN_ERR
"not all devices for card %i can be disconnected\n", card
->number
);
302 * snd_card_free - frees given soundcard structure
303 * @card: soundcard structure
305 * This function releases the soundcard structure and the all assigned
306 * devices automatically. That is, you don't have to release the devices
309 * Returns zero. Frees all associated devices and frees the control
310 * interface associated to given soundcard.
312 int snd_card_free(struct snd_card
*card
)
314 struct snd_shutdown_f_ops
*s_f_ops
;
318 write_lock(&snd_card_rwlock
);
319 snd_cards
[card
->number
] = NULL
;
320 write_unlock(&snd_card_rwlock
);
323 wake_up(&card
->power_sleep
);
325 /* wait, until all devices are ready for the free operation */
326 wait_event(card
->shutdown_sleep
, card
->files
== NULL
);
328 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
329 if (snd_mixer_oss_notify_callback
)
330 snd_mixer_oss_notify_callback(card
, SND_MIXER_OSS_NOTIFY_FREE
);
332 if (snd_device_free_all(card
, SNDRV_DEV_CMD_PRE
) < 0) {
333 snd_printk(KERN_ERR
"unable to free all devices (pre)\n");
334 /* Fatal, but this situation should never occur */
336 if (snd_device_free_all(card
, SNDRV_DEV_CMD_NORMAL
) < 0) {
337 snd_printk(KERN_ERR
"unable to free all devices (normal)\n");
338 /* Fatal, but this situation should never occur */
340 if (snd_device_free_all(card
, SNDRV_DEV_CMD_POST
) < 0) {
341 snd_printk(KERN_ERR
"unable to free all devices (post)\n");
342 /* Fatal, but this situation should never occur */
344 if (card
->private_free
)
345 card
->private_free(card
);
346 snd_info_unregister(card
->proc_id
);
347 if (snd_info_card_free(card
) < 0) {
348 snd_printk(KERN_WARNING
"unable to free card info\n");
349 /* Not fatal error */
351 while (card
->s_f_ops
) {
352 s_f_ops
= card
->s_f_ops
;
353 card
->s_f_ops
= s_f_ops
->next
;
356 write_lock(&snd_card_rwlock
);
357 snd_cards_lock
&= ~(1 << card
->number
);
358 write_unlock(&snd_card_rwlock
);
363 static void snd_card_free_thread(void * __card
)
365 struct snd_card
*card
= __card
;
366 struct module
* module
= card
->module
;
368 if (!try_module_get(module
)) {
369 snd_printk(KERN_ERR
"unable to lock toplevel module for card %i in free thread\n", card
->number
);
379 * snd_card_free_in_thread - call snd_card_free() in thread
380 * @card: soundcard structure
382 * This function schedules the call of snd_card_free() function in a
383 * work queue. When all devices are released (non-busy), the work
384 * is woken up and calls snd_card_free().
386 * When a card can be disconnected at any time by hotplug service,
387 * this function should be used in disconnect (or detach) callback
388 * instead of calling snd_card_free() directly.
390 * Returns - zero otherwise a negative error code if the start of thread failed.
392 int snd_card_free_in_thread(struct snd_card
*card
)
394 if (card
->files
== NULL
) {
399 if (schedule_work(&card
->free_workq
))
402 snd_printk(KERN_ERR
"schedule_work() failed in snd_card_free_in_thread for card %i\n", card
->number
);
403 /* try to free the structure immediately */
408 static void choose_default_id(struct snd_card
*card
)
410 int i
, len
, idx_flag
= 0, loops
= SNDRV_CARDS
;
413 id
= spos
= card
->shortname
;
414 while (*id
!= '\0') {
420 while (*spos
!= '\0' && !isalnum(*spos
))
423 *id
++ = isalpha(card
->shortname
[0]) ? card
->shortname
[0] : 'D';
424 while (*spos
!= '\0' && (size_t)(id
- card
->id
) < sizeof(card
->id
) - 1) {
434 strcpy(id
, "default");
438 snd_printk(KERN_ERR
"unable to choose default card id (%s)\n", id
);
439 strcpy(card
->id
, card
->proc_root
->name
);
442 if (!snd_info_check_reserved_words(id
))
444 for (i
= 0; i
< snd_ecards_limit
; i
++) {
445 if (snd_cards
[i
] && !strcmp(snd_cards
[i
]->id
, id
))
453 if (id
[len
-1] != '9')
457 } else if ((size_t)len
<= sizeof(card
->id
) - 3) {
462 if ((size_t)len
<= sizeof(card
->id
) - 2)
473 * snd_card_register - register the soundcard
474 * @card: soundcard structure
476 * This function registers all the devices assigned to the soundcard.
477 * Until calling this, the ALSA control interface is blocked from the
478 * external accesses. Thus, you should call this function at the end
479 * of the initialization of the card.
481 * Returns zero otherwise a negative error code if the registrain failed.
483 int snd_card_register(struct snd_card
*card
)
487 snd_assert(card
!= NULL
, return -EINVAL
);
488 if ((err
= snd_device_register_all(card
)) < 0)
490 write_lock(&snd_card_rwlock
);
491 if (snd_cards
[card
->number
]) {
492 /* already registered */
493 write_unlock(&snd_card_rwlock
);
496 if (card
->id
[0] == '\0')
497 choose_default_id(card
);
498 snd_cards
[card
->number
] = card
;
499 write_unlock(&snd_card_rwlock
);
500 init_info_for_card(card
);
501 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
502 if (snd_mixer_oss_notify_callback
)
503 snd_mixer_oss_notify_callback(card
, SND_MIXER_OSS_NOTIFY_REGISTER
);
508 #ifdef CONFIG_PROC_FS
509 static struct snd_info_entry
*snd_card_info_entry
= NULL
;
511 static void snd_card_info_read(struct snd_info_entry
*entry
,
512 struct snd_info_buffer
*buffer
)
515 struct snd_card
*card
;
517 for (idx
= count
= 0; idx
< SNDRV_CARDS
; idx
++) {
518 read_lock(&snd_card_rwlock
);
519 if ((card
= snd_cards
[idx
]) != NULL
) {
521 snd_iprintf(buffer
, "%2i [%-15s]: %s - %s\n",
526 snd_iprintf(buffer
, " %s\n",
529 read_unlock(&snd_card_rwlock
);
532 snd_iprintf(buffer
, "--- no soundcards ---\n");
535 #ifdef CONFIG_SND_OSSEMUL
537 void snd_card_info_read_oss(struct snd_info_buffer
*buffer
)
540 struct snd_card
*card
;
542 for (idx
= count
= 0; idx
< SNDRV_CARDS
; idx
++) {
543 read_lock(&snd_card_rwlock
);
544 if ((card
= snd_cards
[idx
]) != NULL
) {
546 snd_iprintf(buffer
, "%s\n", card
->longname
);
548 read_unlock(&snd_card_rwlock
);
551 snd_iprintf(buffer
, "--- no soundcards ---\n");
558 static struct snd_info_entry
*snd_card_module_info_entry
;
559 static void snd_card_module_info_read(struct snd_info_entry
*entry
,
560 struct snd_info_buffer
*buffer
)
563 struct snd_card
*card
;
565 for (idx
= 0; idx
< SNDRV_CARDS
; idx
++) {
566 read_lock(&snd_card_rwlock
);
567 if ((card
= snd_cards
[idx
]) != NULL
)
568 snd_iprintf(buffer
, "%2i %s\n",
569 idx
, card
->module
->name
);
570 read_unlock(&snd_card_rwlock
);
575 int __init
snd_card_info_init(void)
577 struct snd_info_entry
*entry
;
579 entry
= snd_info_create_module_entry(THIS_MODULE
, "cards", NULL
);
582 entry
->c
.text
.read_size
= PAGE_SIZE
;
583 entry
->c
.text
.read
= snd_card_info_read
;
584 if (snd_info_register(entry
) < 0) {
585 snd_info_free_entry(entry
);
588 snd_card_info_entry
= entry
;
591 entry
= snd_info_create_module_entry(THIS_MODULE
, "modules", NULL
);
593 entry
->c
.text
.read_size
= PAGE_SIZE
;
594 entry
->c
.text
.read
= snd_card_module_info_read
;
595 if (snd_info_register(entry
) < 0)
596 snd_info_free_entry(entry
);
598 snd_card_module_info_entry
= entry
;
605 int __exit
snd_card_info_done(void)
607 snd_info_unregister(snd_card_info_entry
);
609 snd_info_unregister(snd_card_module_info_entry
);
614 #endif /* CONFIG_PROC_FS */
617 * snd_component_add - add a component string
618 * @card: soundcard structure
619 * @component: the component id string
621 * This function adds the component id string to the supported list.
622 * The component can be referred from the alsa-lib.
624 * Returns zero otherwise a negative error code.
627 int snd_component_add(struct snd_card
*card
, const char *component
)
630 int len
= strlen(component
);
632 ptr
= strstr(card
->components
, component
);
634 if (ptr
[len
] == '\0' || ptr
[len
] == ' ') /* already there */
637 if (strlen(card
->components
) + 1 + len
+ 1 > sizeof(card
->components
)) {
641 if (card
->components
[0] != '\0')
642 strcat(card
->components
, " ");
643 strcat(card
->components
, component
);
648 * snd_card_file_add - add the file to the file list of the card
649 * @card: soundcard structure
650 * @file: file pointer
652 * This function adds the file to the file linked-list of the card.
653 * This linked-list is used to keep tracking the connection state,
654 * and to avoid the release of busy resources by hotplug.
656 * Returns zero or a negative error code.
658 int snd_card_file_add(struct snd_card
*card
, struct file
*file
)
660 struct snd_monitor_file
*mfile
;
662 mfile
= kmalloc(sizeof(*mfile
), GFP_KERNEL
);
667 spin_lock(&card
->files_lock
);
668 if (card
->shutdown
) {
669 spin_unlock(&card
->files_lock
);
673 mfile
->next
= card
->files
;
675 spin_unlock(&card
->files_lock
);
680 * snd_card_file_remove - remove the file from the file list
681 * @card: soundcard structure
682 * @file: file pointer
684 * This function removes the file formerly added to the card via
685 * snd_card_file_add() function.
686 * If all files are removed and the release of the card is
687 * scheduled, it will wake up the the thread to call snd_card_free()
688 * (see snd_card_free_in_thread() function).
690 * Returns zero or a negative error code.
692 int snd_card_file_remove(struct snd_card
*card
, struct file
*file
)
694 struct snd_monitor_file
*mfile
, *pfile
= NULL
;
696 spin_lock(&card
->files_lock
);
699 if (mfile
->file
== file
) {
701 pfile
->next
= mfile
->next
;
703 card
->files
= mfile
->next
;
709 spin_unlock(&card
->files_lock
);
710 if (card
->files
== NULL
)
711 wake_up(&card
->shutdown_sleep
);
713 snd_printk(KERN_ERR
"ALSA card file remove problem (%p)\n", file
);
722 * snd_power_wait - wait until the power-state is changed.
723 * @card: soundcard structure
724 * @power_state: expected power state
726 * Waits until the power-state is changed.
728 * Note: the power lock must be active before call.
730 int snd_power_wait(struct snd_card
*card
, unsigned int power_state
)
736 if (snd_power_get_state(card
) == power_state
)
738 init_waitqueue_entry(&wait
, current
);
739 add_wait_queue(&card
->power_sleep
, &wait
);
741 if (card
->shutdown
) {
745 if (snd_power_get_state(card
) == power_state
)
747 set_current_state(TASK_UNINTERRUPTIBLE
);
748 snd_power_unlock(card
);
749 schedule_timeout(30 * HZ
);
750 snd_power_lock(card
);
752 remove_wait_queue(&card
->power_sleep
, &wait
);
756 #endif /* CONFIG_PM */