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 EXPORT_SYMBOL(snd_cards);
45 DEFINE_RWLOCK(snd_card_rwlock);
47 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
48 int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int free_flag);
49 EXPORT_SYMBOL(snd_mixer_oss_notify_callback);
53 static void snd_card_id_read(struct snd_info_entry *entry,
54 struct snd_info_buffer *buffer)
56 snd_iprintf(buffer, "%s\n", entry->card->id);
59 static inline int init_info_for_card(struct snd_card *card)
62 struct snd_info_entry *entry;
64 if ((err = snd_info_card_register(card)) < 0) {
65 snd_printd("unable to create card info\n");
68 if ((entry = snd_info_create_card_entry(card, "id", card->proc_root)) == NULL) {
69 snd_printd("unable to create card entry\n");
72 entry->c.text.read = snd_card_id_read;
73 if (snd_info_register(entry) < 0) {
74 snd_info_free_entry(entry);
77 card->proc_id = entry;
80 #else /* !CONFIG_PROC_FS */
81 #define init_info_for_card(card)
84 static void snd_card_free_thread(void * __card);
87 * snd_card_new - create and initialize a soundcard structure
88 * @idx: card index (address) [0 ... (SNDRV_CARDS-1)]
89 * @xid: card identification (ASCII string)
90 * @module: top level module for locking
91 * @extra_size: allocate this extra size after the main soundcard structure
93 * Creates and initializes a soundcard structure.
95 * Returns kmallocated snd_card structure. Creates the ALSA control interface
96 * (which is blocked until snd_card_register function is called).
98 struct snd_card *snd_card_new(int idx, const char *xid,
99 struct module *module, int extra_size)
101 struct snd_card *card;
106 card = kzalloc(sizeof(*card) + extra_size, GFP_KERNEL);
110 if (!snd_info_check_reserved_words(xid))
112 strlcpy(card->id, xid, sizeof(card->id));
115 write_lock(&snd_card_rwlock);
118 for (idx2 = 0; idx2 < SNDRV_CARDS; idx2++)
119 if (~snd_cards_lock & idx & 1<<idx2) {
121 if (idx >= snd_ecards_limit)
122 snd_ecards_limit = idx + 1;
125 } else if (idx < snd_ecards_limit) {
126 if (snd_cards_lock & (1 << idx))
127 err = -ENODEV; /* invalid */
128 } else if (idx < SNDRV_CARDS)
129 snd_ecards_limit = idx + 1; /* increase the limit */
132 if (idx < 0 || err < 0) {
133 write_unlock(&snd_card_rwlock);
134 snd_printk(KERN_ERR "cannot find the slot for index %d (range 0-%i)\n", idx, snd_ecards_limit - 1);
137 snd_cards_lock |= 1 << idx; /* lock it */
138 write_unlock(&snd_card_rwlock);
140 card->module = module;
141 INIT_LIST_HEAD(&card->devices);
142 init_rwsem(&card->controls_rwsem);
143 rwlock_init(&card->ctl_files_rwlock);
144 INIT_LIST_HEAD(&card->controls);
145 INIT_LIST_HEAD(&card->ctl_files);
146 spin_lock_init(&card->files_lock);
147 init_waitqueue_head(&card->shutdown_sleep);
148 INIT_WORK(&card->free_workq, snd_card_free_thread, card);
150 mutex_init(&card->power_lock);
151 init_waitqueue_head(&card->power_sleep);
153 /* the control interface cannot be accessed from the user space until */
154 /* snd_cards_bitmask and snd_cards are set with snd_card_register */
155 if ((err = snd_ctl_create(card)) < 0) {
156 snd_printd("unable to register control minors\n");
159 if ((err = snd_info_card_create(card)) < 0) {
160 snd_printd("unable to create card info\n");
164 card->private_data = (char *)card + sizeof(struct snd_card);
168 snd_device_free_all(card, SNDRV_DEV_CMD_PRE);
174 EXPORT_SYMBOL(snd_card_new);
176 static loff_t snd_disconnect_llseek(struct file *file, loff_t offset, int orig)
181 static ssize_t snd_disconnect_read(struct file *file, char __user *buf,
182 size_t count, loff_t *offset)
187 static ssize_t snd_disconnect_write(struct file *file, const char __user *buf,
188 size_t count, loff_t *offset)
193 static unsigned int snd_disconnect_poll(struct file * file, poll_table * wait)
195 return POLLERR | POLLNVAL;
198 static long snd_disconnect_ioctl(struct file *file,
199 unsigned int cmd, unsigned long arg)
204 static int snd_disconnect_mmap(struct file *file, struct vm_area_struct *vma)
209 static int snd_disconnect_fasync(int fd, struct file *file, int on)
215 * snd_card_disconnect - disconnect all APIs from the file-operations (user space)
216 * @card: soundcard structure
218 * Disconnects all APIs from the file-operations (user space).
220 * Returns zero, otherwise a negative error code.
222 * Note: The current implementation replaces all active file->f_op with special
223 * dummy file operations (they do nothing except release).
225 int snd_card_disconnect(struct snd_card *card)
227 struct snd_monitor_file *mfile;
229 struct snd_shutdown_f_ops *s_f_ops;
230 struct file_operations *f_ops;
231 const struct file_operations *old_f_ops;
234 spin_lock(&card->files_lock);
235 if (card->shutdown) {
236 spin_unlock(&card->files_lock);
240 spin_unlock(&card->files_lock);
242 /* phase 1: disable fops (user space) operations for ALSA API */
243 write_lock(&snd_card_rwlock);
244 snd_cards[card->number] = NULL;
245 write_unlock(&snd_card_rwlock);
247 /* phase 2: replace file->f_op with special dummy operations */
249 spin_lock(&card->files_lock);
254 /* it's critical part, use endless loop */
255 /* we have no room to fail */
256 s_f_ops = kmalloc(sizeof(struct snd_shutdown_f_ops), GFP_ATOMIC);
258 panic("Atomic allocation failed for snd_shutdown_f_ops!");
260 f_ops = &s_f_ops->f_ops;
262 memset(f_ops, 0, sizeof(*f_ops));
263 f_ops->owner = file->f_op->owner;
264 f_ops->release = file->f_op->release;
265 f_ops->llseek = snd_disconnect_llseek;
266 f_ops->read = snd_disconnect_read;
267 f_ops->write = snd_disconnect_write;
268 f_ops->poll = snd_disconnect_poll;
269 f_ops->unlocked_ioctl = snd_disconnect_ioctl;
271 f_ops->compat_ioctl = snd_disconnect_ioctl;
273 f_ops->mmap = snd_disconnect_mmap;
274 f_ops->fasync = snd_disconnect_fasync;
276 s_f_ops->next = card->s_f_ops;
277 card->s_f_ops = s_f_ops;
279 f_ops = fops_get(f_ops);
281 old_f_ops = file->f_op;
282 file->f_op = f_ops; /* must be atomic */
287 spin_unlock(&card->files_lock);
289 /* phase 3: notify all connected devices about disconnection */
290 /* at this point, they cannot respond to any calls except release() */
292 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
293 if (snd_mixer_oss_notify_callback)
294 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_DISCONNECT);
297 /* notify all devices that we are disconnected */
298 err = snd_device_disconnect_all(card);
300 snd_printk(KERN_ERR "not all devices for card %i can be disconnected\n", card->number);
305 EXPORT_SYMBOL(snd_card_disconnect);
308 * snd_card_free - frees given soundcard structure
309 * @card: soundcard structure
311 * This function releases the soundcard structure and the all assigned
312 * devices automatically. That is, you don't have to release the devices
315 * Returns zero. Frees all associated devices and frees the control
316 * interface associated to given soundcard.
318 int snd_card_free(struct snd_card *card)
320 struct snd_shutdown_f_ops *s_f_ops;
324 write_lock(&snd_card_rwlock);
325 snd_cards[card->number] = NULL;
326 write_unlock(&snd_card_rwlock);
329 wake_up(&card->power_sleep);
331 /* wait, until all devices are ready for the free operation */
332 wait_event(card->shutdown_sleep, card->files == NULL);
334 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
335 if (snd_mixer_oss_notify_callback)
336 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_FREE);
338 if (snd_device_free_all(card, SNDRV_DEV_CMD_PRE) < 0) {
339 snd_printk(KERN_ERR "unable to free all devices (pre)\n");
340 /* Fatal, but this situation should never occur */
342 if (snd_device_free_all(card, SNDRV_DEV_CMD_NORMAL) < 0) {
343 snd_printk(KERN_ERR "unable to free all devices (normal)\n");
344 /* Fatal, but this situation should never occur */
346 if (snd_device_free_all(card, SNDRV_DEV_CMD_POST) < 0) {
347 snd_printk(KERN_ERR "unable to free all devices (post)\n");
348 /* Fatal, but this situation should never occur */
350 if (card->private_free)
351 card->private_free(card);
352 snd_info_unregister(card->proc_id);
353 if (snd_info_card_free(card) < 0) {
354 snd_printk(KERN_WARNING "unable to free card info\n");
355 /* Not fatal error */
357 while (card->s_f_ops) {
358 s_f_ops = card->s_f_ops;
359 card->s_f_ops = s_f_ops->next;
362 write_lock(&snd_card_rwlock);
363 snd_cards_lock &= ~(1 << card->number);
364 write_unlock(&snd_card_rwlock);
369 EXPORT_SYMBOL(snd_card_free);
371 static void snd_card_free_thread(void * __card)
373 struct snd_card *card = __card;
374 struct module * module = card->module;
376 if (!try_module_get(module)) {
377 snd_printk(KERN_ERR "unable to lock toplevel module for card %i in free thread\n", card->number);
387 * snd_card_free_in_thread - call snd_card_free() in thread
388 * @card: soundcard structure
390 * This function schedules the call of snd_card_free() function in a
391 * work queue. When all devices are released (non-busy), the work
392 * is woken up and calls snd_card_free().
394 * When a card can be disconnected at any time by hotplug service,
395 * this function should be used in disconnect (or detach) callback
396 * instead of calling snd_card_free() directly.
398 * Returns - zero otherwise a negative error code if the start of thread failed.
400 int snd_card_free_in_thread(struct snd_card *card)
402 if (card->files == NULL) {
407 if (schedule_work(&card->free_workq))
410 snd_printk(KERN_ERR "schedule_work() failed in snd_card_free_in_thread for card %i\n", card->number);
411 /* try to free the structure immediately */
416 EXPORT_SYMBOL(snd_card_free_in_thread);
418 static void choose_default_id(struct snd_card *card)
420 int i, len, idx_flag = 0, loops = SNDRV_CARDS;
423 id = spos = card->shortname;
424 while (*id != '\0') {
430 while (*spos != '\0' && !isalnum(*spos))
433 *id++ = isalpha(card->shortname[0]) ? card->shortname[0] : 'D';
434 while (*spos != '\0' && (size_t)(id - card->id) < sizeof(card->id) - 1) {
444 strcpy(id, "default");
448 snd_printk(KERN_ERR "unable to choose default card id (%s)\n", id);
449 strcpy(card->id, card->proc_root->name);
452 if (!snd_info_check_reserved_words(id))
454 for (i = 0; i < snd_ecards_limit; i++) {
455 if (snd_cards[i] && !strcmp(snd_cards[i]->id, id))
463 if (id[len-1] != '9')
467 } else if ((size_t)len <= sizeof(card->id) - 3) {
472 if ((size_t)len <= sizeof(card->id) - 2)
483 * snd_card_register - register the soundcard
484 * @card: soundcard structure
486 * This function registers all the devices assigned to the soundcard.
487 * Until calling this, the ALSA control interface is blocked from the
488 * external accesses. Thus, you should call this function at the end
489 * of the initialization of the card.
491 * Returns zero otherwise a negative error code if the registrain failed.
493 int snd_card_register(struct snd_card *card)
497 snd_assert(card != NULL, return -EINVAL);
498 if ((err = snd_device_register_all(card)) < 0)
500 write_lock(&snd_card_rwlock);
501 if (snd_cards[card->number]) {
502 /* already registered */
503 write_unlock(&snd_card_rwlock);
506 if (card->id[0] == '\0')
507 choose_default_id(card);
508 snd_cards[card->number] = card;
509 write_unlock(&snd_card_rwlock);
510 init_info_for_card(card);
511 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
512 if (snd_mixer_oss_notify_callback)
513 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_REGISTER);
518 EXPORT_SYMBOL(snd_card_register);
520 #ifdef CONFIG_PROC_FS
521 static struct snd_info_entry *snd_card_info_entry = NULL;
523 static void snd_card_info_read(struct snd_info_entry *entry,
524 struct snd_info_buffer *buffer)
527 struct snd_card *card;
529 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
530 read_lock(&snd_card_rwlock);
531 if ((card = snd_cards[idx]) != NULL) {
533 snd_iprintf(buffer, "%2i [%-15s]: %s - %s\n",
538 snd_iprintf(buffer, " %s\n",
541 read_unlock(&snd_card_rwlock);
544 snd_iprintf(buffer, "--- no soundcards ---\n");
547 #ifdef CONFIG_SND_OSSEMUL
549 void snd_card_info_read_oss(struct snd_info_buffer *buffer)
552 struct snd_card *card;
554 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
555 read_lock(&snd_card_rwlock);
556 if ((card = snd_cards[idx]) != NULL) {
558 snd_iprintf(buffer, "%s\n", card->longname);
560 read_unlock(&snd_card_rwlock);
563 snd_iprintf(buffer, "--- no soundcards ---\n");
570 static struct snd_info_entry *snd_card_module_info_entry;
571 static void snd_card_module_info_read(struct snd_info_entry *entry,
572 struct snd_info_buffer *buffer)
575 struct snd_card *card;
577 for (idx = 0; idx < SNDRV_CARDS; idx++) {
578 read_lock(&snd_card_rwlock);
579 if ((card = snd_cards[idx]) != NULL)
580 snd_iprintf(buffer, "%2i %s\n",
581 idx, card->module->name);
582 read_unlock(&snd_card_rwlock);
587 int __init snd_card_info_init(void)
589 struct snd_info_entry *entry;
591 entry = snd_info_create_module_entry(THIS_MODULE, "cards", NULL);
594 entry->c.text.read = snd_card_info_read;
595 if (snd_info_register(entry) < 0) {
596 snd_info_free_entry(entry);
599 snd_card_info_entry = entry;
602 entry = snd_info_create_module_entry(THIS_MODULE, "modules", NULL);
604 entry->c.text.read = snd_card_module_info_read;
605 if (snd_info_register(entry) < 0)
606 snd_info_free_entry(entry);
608 snd_card_module_info_entry = entry;
615 int __exit snd_card_info_done(void)
617 snd_info_unregister(snd_card_info_entry);
619 snd_info_unregister(snd_card_module_info_entry);
624 #endif /* CONFIG_PROC_FS */
627 * snd_component_add - add a component string
628 * @card: soundcard structure
629 * @component: the component id string
631 * This function adds the component id string to the supported list.
632 * The component can be referred from the alsa-lib.
634 * Returns zero otherwise a negative error code.
637 int snd_component_add(struct snd_card *card, const char *component)
640 int len = strlen(component);
642 ptr = strstr(card->components, component);
644 if (ptr[len] == '\0' || ptr[len] == ' ') /* already there */
647 if (strlen(card->components) + 1 + len + 1 > sizeof(card->components)) {
651 if (card->components[0] != '\0')
652 strcat(card->components, " ");
653 strcat(card->components, component);
657 EXPORT_SYMBOL(snd_component_add);
660 * snd_card_file_add - add the file to the file list of the card
661 * @card: soundcard structure
662 * @file: file pointer
664 * This function adds the file to the file linked-list of the card.
665 * This linked-list is used to keep tracking the connection state,
666 * and to avoid the release of busy resources by hotplug.
668 * Returns zero or a negative error code.
670 int snd_card_file_add(struct snd_card *card, struct file *file)
672 struct snd_monitor_file *mfile;
674 mfile = kmalloc(sizeof(*mfile), GFP_KERNEL);
679 spin_lock(&card->files_lock);
680 if (card->shutdown) {
681 spin_unlock(&card->files_lock);
685 mfile->next = card->files;
687 spin_unlock(&card->files_lock);
691 EXPORT_SYMBOL(snd_card_file_add);
694 * snd_card_file_remove - remove the file from the file list
695 * @card: soundcard structure
696 * @file: file pointer
698 * This function removes the file formerly added to the card via
699 * snd_card_file_add() function.
700 * If all files are removed and the release of the card is
701 * scheduled, it will wake up the the thread to call snd_card_free()
702 * (see snd_card_free_in_thread() function).
704 * Returns zero or a negative error code.
706 int snd_card_file_remove(struct snd_card *card, struct file *file)
708 struct snd_monitor_file *mfile, *pfile = NULL;
710 spin_lock(&card->files_lock);
713 if (mfile->file == file) {
715 pfile->next = mfile->next;
717 card->files = mfile->next;
723 spin_unlock(&card->files_lock);
724 if (card->files == NULL)
725 wake_up(&card->shutdown_sleep);
727 snd_printk(KERN_ERR "ALSA card file remove problem (%p)\n", file);
734 EXPORT_SYMBOL(snd_card_file_remove);
738 * snd_power_wait - wait until the power-state is changed.
739 * @card: soundcard structure
740 * @power_state: expected power state
742 * Waits until the power-state is changed.
744 * Note: the power lock must be active before call.
746 int snd_power_wait(struct snd_card *card, unsigned int power_state)
752 if (snd_power_get_state(card) == power_state)
754 init_waitqueue_entry(&wait, current);
755 add_wait_queue(&card->power_sleep, &wait);
757 if (card->shutdown) {
761 if (snd_power_get_state(card) == power_state)
763 set_current_state(TASK_UNINTERRUPTIBLE);
764 snd_power_unlock(card);
765 schedule_timeout(30 * HZ);
766 snd_power_lock(card);
768 remove_wait_queue(&card->power_sleep, &wait);
772 EXPORT_SYMBOL(snd_power_wait);
773 #endif /* CONFIG_PM */