blob: 5c254d498ae094d452bb0c85a143f468eaedde0a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Initialization routines
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02003 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 *
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.
10 *
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.
15 *
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
19 *
20 */
21
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/pm.h>
Russell Kingd052d1b2005-10-29 19:07:23 +010029
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <sound/core.h>
31#include <sound/control.h>
32#include <sound/info.h>
33
Karsten Wiesea9edfc62006-10-06 16:08:27 +020034static DEFINE_SPINLOCK(shutdown_lock);
35static LIST_HEAD(shutdown_files);
36
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -080037static const struct file_operations snd_shutdown_f_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Takashi Iwai6581f4e2006-05-17 17:14:51 +020039static unsigned int snd_cards_lock; /* locked for registering/using */
40struct snd_card *snd_cards[SNDRV_CARDS];
Takashi Iwaic0d3fb32006-04-28 15:13:39 +020041EXPORT_SYMBOL(snd_cards);
42
Takashi Iwai746df942006-05-15 19:49:05 +020043static DEFINE_MUTEX(snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Takashi Iwai304cd072007-10-26 15:10:15 +020045static char *slots[SNDRV_CARDS];
46module_param_array(slots, charp, NULL, 0444);
47MODULE_PARM_DESC(slots, "Module names assigned to the slots.");
48
Takashi Iwaia93bbaa2008-05-27 17:59:24 +020049/* return non-zero if the given index is reserved for the given
Takashi Iwai304cd072007-10-26 15:10:15 +020050 * module via slots option
51 */
Takashi Iwaia93bbaa2008-05-27 17:59:24 +020052static int module_slot_match(struct module *module, int idx)
Takashi Iwai304cd072007-10-26 15:10:15 +020053{
Takashi Iwaia93bbaa2008-05-27 17:59:24 +020054 int match = 1;
Takashi Iwai304cd072007-10-26 15:10:15 +020055#ifdef MODULE
Takashi Iwaia93bbaa2008-05-27 17:59:24 +020056 const char *s1, *s2;
57
Takashi Iwai304cd072007-10-26 15:10:15 +020058 if (!module || !module->name || !slots[idx])
59 return 0;
Takashi Iwaia93bbaa2008-05-27 17:59:24 +020060
61 s1 = module->name;
62 s2 = slots[idx];
63 if (*s2 == '!') {
64 match = 0; /* negative match */
65 s2++;
66 }
Takashi Iwai304cd072007-10-26 15:10:15 +020067 /* compare module name strings
68 * hyphens are handled as equivalent with underscore
69 */
70 for (;;) {
71 char c1 = *s1++;
72 char c2 = *s2++;
73 if (c1 == '-')
74 c1 = '_';
75 if (c2 == '-')
76 c2 = '_';
77 if (c1 != c2)
Takashi Iwaia93bbaa2008-05-27 17:59:24 +020078 return !match;
Takashi Iwai304cd072007-10-26 15:10:15 +020079 if (!c1)
80 break;
81 }
Takashi Iwaia93bbaa2008-05-27 17:59:24 +020082#endif /* MODULE */
83 return match;
Takashi Iwai304cd072007-10-26 15:10:15 +020084}
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
Takashi Iwai512bbd62005-11-17 13:51:18 +010087int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int free_flag);
Takashi Iwaic0d3fb32006-04-28 15:13:39 +020088EXPORT_SYMBOL(snd_mixer_oss_notify_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089#endif
90
Takashi Iwaie28563c2005-12-01 10:42:42 +010091#ifdef CONFIG_PROC_FS
Takashi Iwai512bbd62005-11-17 13:51:18 +010092static void snd_card_id_read(struct snd_info_entry *entry,
93 struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -070094{
95 snd_iprintf(buffer, "%s\n", entry->card->id);
96}
97
Takashi Iwaie28563c2005-12-01 10:42:42 +010098static inline int init_info_for_card(struct snd_card *card)
99{
100 int err;
101 struct snd_info_entry *entry;
102
103 if ((err = snd_info_card_register(card)) < 0) {
104 snd_printd("unable to create card info\n");
105 return err;
106 }
107 if ((entry = snd_info_create_card_entry(card, "id", card->proc_root)) == NULL) {
108 snd_printd("unable to create card entry\n");
109 return err;
110 }
Takashi Iwaie28563c2005-12-01 10:42:42 +0100111 entry->c.text.read = snd_card_id_read;
112 if (snd_info_register(entry) < 0) {
113 snd_info_free_entry(entry);
114 entry = NULL;
115 }
116 card->proc_id = entry;
117 return 0;
118}
119#else /* !CONFIG_PROC_FS */
120#define init_info_for_card(card)
121#endif
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123/**
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
129 *
130 * Creates and initializes a soundcard structure.
131 *
Takashi Iwai512bbd62005-11-17 13:51:18 +0100132 * Returns kmallocated snd_card structure. Creates the ALSA control interface
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 * (which is blocked until snd_card_register function is called).
134 */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100135struct snd_card *snd_card_new(int idx, const char *xid,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 struct module *module, int extra_size)
137{
Takashi Iwai512bbd62005-11-17 13:51:18 +0100138 struct snd_card *card;
Takashi Iwaia93bbaa2008-05-27 17:59:24 +0200139 int err, idx2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
141 if (extra_size < 0)
142 extra_size = 0;
Takashi Iwaica2c0962005-09-09 14:20:23 +0200143 card = kzalloc(sizeof(*card) + extra_size, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 if (card == NULL)
145 return NULL;
146 if (xid) {
147 if (!snd_info_check_reserved_words(xid))
148 goto __error;
149 strlcpy(card->id, xid, sizeof(card->id));
150 }
151 err = 0;
Takashi Iwai746df942006-05-15 19:49:05 +0200152 mutex_lock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 if (idx < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 for (idx2 = 0; idx2 < SNDRV_CARDS; idx2++)
Oliver Neukum5c33dd72007-01-16 17:49:21 +0100155 /* idx == -1 == 0xffff means: take any free slot */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 if (~snd_cards_lock & idx & 1<<idx2) {
Takashi Iwaia93bbaa2008-05-27 17:59:24 +0200157 if (module_slot_match(module, idx2)) {
158 idx = idx2;
159 break;
160 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 }
Oliver Neukum5c33dd72007-01-16 17:49:21 +0100162 }
Takashi Iwaia93bbaa2008-05-27 17:59:24 +0200163 if (idx < 0) {
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]) {
168 idx = idx2;
169 break;
170 }
171 }
172 }
173 if (idx < 0)
174 err = -ENODEV;
175 else if (idx < snd_ecards_limit) {
176 if (snd_cards_lock & (1 << idx))
177 err = -EBUSY; /* invalid */
178 } else if (idx >= SNDRV_CARDS)
179 err = -ENODEV;
180 if (err < 0) {
Takashi Iwai746df942006-05-15 19:49:05 +0200181 mutex_unlock(&snd_card_mutex);
Oliver Neukum5c33dd72007-01-16 17:49:21 +0100182 snd_printk(KERN_ERR "cannot find the slot for index %d (range 0-%i), error: %d\n",
183 idx, snd_ecards_limit - 1, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 goto __error;
185 }
186 snd_cards_lock |= 1 << idx; /* lock it */
Takashi Iwaia93bbaa2008-05-27 17:59:24 +0200187 if (idx >= snd_ecards_limit)
188 snd_ecards_limit = idx + 1; /* increase the limit */
Takashi Iwai746df942006-05-15 19:49:05 +0200189 mutex_unlock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 card->number = idx;
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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199#ifdef CONFIG_PM
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100200 mutex_init(&card->power_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 init_waitqueue_head(&card->power_sleep);
202#endif
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");
207 goto __error;
208 }
209 if ((err = snd_info_card_create(card)) < 0) {
210 snd_printd("unable to create card info\n");
211 goto __error_ctl;
212 }
213 if (extra_size > 0)
Takashi Iwai512bbd62005-11-17 13:51:18 +0100214 card->private_data = (char *)card + sizeof(struct snd_card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 return card;
216
217 __error_ctl:
218 snd_device_free_all(card, SNDRV_DEV_CMD_PRE);
219 __error:
220 kfree(card);
221 return NULL;
222}
223
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200224EXPORT_SYMBOL(snd_card_new);
225
Takashi Iwai746df942006-05-15 19:49:05 +0200226/* return non-zero if a card is already locked */
227int snd_card_locked(int card)
228{
229 int locked;
230
231 mutex_lock(&snd_card_mutex);
232 locked = snd_cards_lock & (1 << card);
233 mutex_unlock(&snd_card_mutex);
234 return locked;
235}
236
Clemens Ladischb3b0abe2006-03-03 14:08:43 +0100237static loff_t snd_disconnect_llseek(struct file *file, loff_t offset, int orig)
238{
239 return -ENODEV;
240}
241
242static ssize_t snd_disconnect_read(struct file *file, char __user *buf,
243 size_t count, loff_t *offset)
244{
245 return -ENODEV;
246}
247
248static ssize_t snd_disconnect_write(struct file *file, const char __user *buf,
249 size_t count, loff_t *offset)
250{
251 return -ENODEV;
252}
253
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200254static int snd_disconnect_release(struct inode *inode, struct file *file)
255{
256 struct snd_monitor_file *df = NULL, *_df;
257
258 spin_lock(&shutdown_lock);
259 list_for_each_entry(_df, &shutdown_files, shutdown_list) {
260 if (_df->file == file) {
261 df = _df;
262 break;
263 }
264 }
265 spin_unlock(&shutdown_lock);
266
267 if (likely(df))
268 return df->disconnected_f_op->release(inode, file);
269
Harvey Harrison9bf8e7d2008-03-03 15:32:18 -0800270 panic("%s(%p, %p) failed!", __func__, inode, file);
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200271}
272
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273static unsigned int snd_disconnect_poll(struct file * file, poll_table * wait)
274{
275 return POLLERR | POLLNVAL;
276}
277
Clemens Ladischb3b0abe2006-03-03 14:08:43 +0100278static long snd_disconnect_ioctl(struct file *file,
279 unsigned int cmd, unsigned long arg)
280{
281 return -ENODEV;
282}
283
284static int snd_disconnect_mmap(struct file *file, struct vm_area_struct *vma)
285{
286 return -ENODEV;
287}
288
289static int snd_disconnect_fasync(int fd, struct file *file, int on)
290{
291 return -ENODEV;
292}
293
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -0800294static const struct file_operations snd_shutdown_f_ops =
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200295{
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,
303#ifdef CONFIG_COMPAT
304 .compat_ioctl = snd_disconnect_ioctl,
305#endif
306 .mmap = snd_disconnect_mmap,
307 .fasync = snd_disconnect_fasync
308};
309
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310/**
311 * snd_card_disconnect - disconnect all APIs from the file-operations (user space)
312 * @card: soundcard structure
313 *
314 * Disconnects all APIs from the file-operations (user space).
315 *
316 * Returns zero, otherwise a negative error code.
317 *
318 * Note: The current implementation replaces all active file->f_op with special
319 * dummy file operations (they do nothing except release).
320 */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100321int snd_card_disconnect(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322{
323 struct snd_monitor_file *mfile;
324 struct file *file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 int err;
326
Takashi Iwaif18638d2008-04-17 12:52:02 +0200327 if (!card)
328 return -EINVAL;
329
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 spin_lock(&card->files_lock);
331 if (card->shutdown) {
332 spin_unlock(&card->files_lock);
333 return 0;
334 }
335 card->shutdown = 1;
336 spin_unlock(&card->files_lock);
337
338 /* phase 1: disable fops (user space) operations for ALSA API */
Takashi Iwai746df942006-05-15 19:49:05 +0200339 mutex_lock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 snd_cards[card->number] = NULL;
Takashi Iwaif18638d2008-04-17 12:52:02 +0200341 snd_cards_lock &= ~(1 << card->number);
Takashi Iwai746df942006-05-15 19:49:05 +0200342 mutex_unlock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
344 /* phase 2: replace file->f_op with special dummy operations */
345
346 spin_lock(&card->files_lock);
347 mfile = card->files;
348 while (mfile) {
349 file = mfile->file;
350
351 /* it's critical part, use endless loop */
352 /* we have no room to fail */
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200353 mfile->disconnected_f_op = mfile->file->f_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200355 spin_lock(&shutdown_lock);
356 list_add(&mfile->shutdown_list, &shutdown_files);
357 spin_unlock(&shutdown_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200359 mfile->file->f_op = &snd_shutdown_f_ops;
Miguel Botonbc9abce2008-01-13 12:03:53 +0100360 fops_get(mfile->file->f_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
362 mfile = mfile->next;
363 }
364 spin_unlock(&card->files_lock);
365
366 /* phase 3: notify all connected devices about disconnection */
367 /* at this point, they cannot respond to any calls except release() */
368
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);
372#endif
373
374 /* notify all devices that we are disconnected */
375 err = snd_device_disconnect_all(card);
376 if (err < 0)
377 snd_printk(KERN_ERR "not all devices for card %i can be disconnected\n", card->number);
378
Takashi Iwai746d4a02006-06-23 14:37:59 +0200379 snd_info_card_disconnect(card);
Takashi Iwai73d38b12008-04-17 12:50:47 +0200380#ifndef CONFIG_SYSFS_DEPRECATED
381 if (card->card_dev) {
382 device_unregister(card->card_dev);
383 card->card_dev = NULL;
384 }
385#endif
Takashi Iwaif18638d2008-04-17 12:52:02 +0200386#ifdef CONFIG_PM
387 wake_up(&card->power_sleep);
388#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 return 0;
390}
391
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200392EXPORT_SYMBOL(snd_card_disconnect);
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394/**
395 * snd_card_free - frees given soundcard structure
396 * @card: soundcard structure
397 *
398 * This function releases the soundcard structure and the all assigned
399 * devices automatically. That is, you don't have to release the devices
400 * by yourself.
401 *
402 * Returns zero. Frees all associated devices and frees the control
403 * interface associated to given soundcard.
404 */
Takashi Iwaic4614822006-06-23 14:38:23 +0200405static int snd_card_do_free(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407#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);
410#endif
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 */
414 }
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 */
418 }
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 */
422 }
423 if (card->private_free)
424 card->private_free(card);
Takashi Iwai746d4a02006-06-23 14:37:59 +0200425 snd_info_free_entry(card->proc_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 if (snd_info_card_free(card) < 0) {
427 snd_printk(KERN_WARNING "unable to free card info\n");
428 /* Not fatal error */
429 }
Takashi Iwaic4614822006-06-23 14:38:23 +0200430 kfree(card);
431 return 0;
432}
433
Takashi Iwaic4614822006-06-23 14:38:23 +0200434int snd_card_free_when_closed(struct snd_card *card)
435{
436 int free_now = 0;
Takashi Iwaif18638d2008-04-17 12:52:02 +0200437 int ret = snd_card_disconnect(card);
Takashi Iwaic4614822006-06-23 14:38:23 +0200438 if (ret)
439 return ret;
440
441 spin_lock(&card->files_lock);
442 if (card->files == NULL)
443 free_now = 1;
444 else
445 card->free_on_last_close = 1;
446 spin_unlock(&card->files_lock);
447
448 if (free_now)
449 snd_card_do_free(card);
450 return 0;
451}
452
453EXPORT_SYMBOL(snd_card_free_when_closed);
454
455int snd_card_free(struct snd_card *card)
456{
Takashi Iwaif18638d2008-04-17 12:52:02 +0200457 int ret = snd_card_disconnect(card);
Takashi Iwaic4614822006-06-23 14:38:23 +0200458 if (ret)
459 return ret;
460
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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 return 0;
465}
466
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200467EXPORT_SYMBOL(snd_card_free);
468
Takashi Iwai512bbd62005-11-17 13:51:18 +0100469static void choose_default_id(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470{
Clemens Ladischd0015442005-11-20 14:09:05 +0100471 int i, len, idx_flag = 0, loops = SNDRV_CARDS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 char *id, *spos;
473
474 id = spos = card->shortname;
475 while (*id != '\0') {
476 if (*id == ' ')
477 spos = id + 1;
478 id++;
479 }
480 id = card->id;
481 while (*spos != '\0' && !isalnum(*spos))
482 spos++;
483 if (isdigit(*spos))
484 *id++ = isalpha(card->shortname[0]) ? card->shortname[0] : 'D';
485 while (*spos != '\0' && (size_t)(id - card->id) < sizeof(card->id) - 1) {
486 if (isalnum(*spos))
487 *id++ = *spos;
488 spos++;
489 }
490 *id = '\0';
491
492 id = card->id;
493
494 if (*id == '\0')
495 strcpy(id, "default");
496
497 while (1) {
498 if (loops-- == 0) {
499 snd_printk(KERN_ERR "unable to choose default card id (%s)\n", id);
500 strcpy(card->id, card->proc_root->name);
501 return;
502 }
503 if (!snd_info_check_reserved_words(id))
504 goto __change;
505 for (i = 0; i < snd_ecards_limit; i++) {
506 if (snd_cards[i] && !strcmp(snd_cards[i]->id, id))
507 goto __change;
508 }
509 break;
510
511 __change:
512 len = strlen(id);
Clemens Ladischd0015442005-11-20 14:09:05 +0100513 if (idx_flag) {
514 if (id[len-1] != '9')
515 id[len-1]++;
516 else
517 id[len-1] = 'A';
518 } else if ((size_t)len <= sizeof(card->id) - 3) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 strcat(id, "_1");
520 idx_flag++;
521 } else {
522 spos = id + len - 2;
523 if ((size_t)len <= sizeof(card->id) - 2)
524 spos++;
525 *spos++ = '_';
526 *spos++ = '1';
527 *spos++ = '\0';
528 idx_flag++;
529 }
530 }
531}
532
533/**
534 * snd_card_register - register the soundcard
535 * @card: soundcard structure
536 *
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.
541 *
542 * Returns zero otherwise a negative error code if the registrain failed.
543 */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100544int snd_card_register(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545{
546 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
Takashi Iwai7c22f1a2005-10-10 11:46:31 +0200548 snd_assert(card != NULL, return -EINVAL);
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100549#ifndef CONFIG_SYSFS_DEPRECATED
550 if (!card->card_dev) {
551 card->card_dev = device_create(sound_class, card->dev, 0,
552 "card%i", card->number);
553 if (IS_ERR(card->card_dev))
554 card->card_dev = NULL;
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700555 }
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100556#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 if ((err = snd_device_register_all(card)) < 0)
558 return err;
Takashi Iwai746df942006-05-15 19:49:05 +0200559 mutex_lock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 if (snd_cards[card->number]) {
561 /* already registered */
Takashi Iwai746df942006-05-15 19:49:05 +0200562 mutex_unlock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 return 0;
564 }
565 if (card->id[0] == '\0')
566 choose_default_id(card);
567 snd_cards[card->number] = card;
Takashi Iwai746df942006-05-15 19:49:05 +0200568 mutex_unlock(&snd_card_mutex);
Takashi Iwaie28563c2005-12-01 10:42:42 +0100569 init_info_for_card(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
571 if (snd_mixer_oss_notify_callback)
572 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_REGISTER);
573#endif
574 return 0;
575}
576
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200577EXPORT_SYMBOL(snd_card_register);
578
Takashi Iwaie28563c2005-12-01 10:42:42 +0100579#ifdef CONFIG_PROC_FS
Takashi Iwai6581f4e2006-05-17 17:14:51 +0200580static struct snd_info_entry *snd_card_info_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581
Takashi Iwaia381a7a2005-11-17 15:55:49 +0100582static void snd_card_info_read(struct snd_info_entry *entry,
583 struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584{
585 int idx, count;
Takashi Iwai512bbd62005-11-17 13:51:18 +0100586 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
588 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
Takashi Iwai746df942006-05-15 19:49:05 +0200589 mutex_lock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 if ((card = snd_cards[idx]) != NULL) {
591 count++;
Clemens Ladischd0015442005-11-20 14:09:05 +0100592 snd_iprintf(buffer, "%2i [%-15s]: %s - %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 idx,
594 card->id,
595 card->driver,
596 card->shortname);
Clemens Ladischd0015442005-11-20 14:09:05 +0100597 snd_iprintf(buffer, " %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 card->longname);
599 }
Takashi Iwai746df942006-05-15 19:49:05 +0200600 mutex_unlock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 }
602 if (!count)
603 snd_iprintf(buffer, "--- no soundcards ---\n");
604}
605
Takashi Iwaie28563c2005-12-01 10:42:42 +0100606#ifdef CONFIG_SND_OSSEMUL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Takashi Iwai512bbd62005-11-17 13:51:18 +0100608void snd_card_info_read_oss(struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609{
610 int idx, count;
Takashi Iwai512bbd62005-11-17 13:51:18 +0100611 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
613 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
Takashi Iwai746df942006-05-15 19:49:05 +0200614 mutex_lock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 if ((card = snd_cards[idx]) != NULL) {
616 count++;
617 snd_iprintf(buffer, "%s\n", card->longname);
618 }
Takashi Iwai746df942006-05-15 19:49:05 +0200619 mutex_unlock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 }
621 if (!count) {
622 snd_iprintf(buffer, "--- no soundcards ---\n");
623 }
624}
625
626#endif
627
628#ifdef MODULE
Takashi Iwai512bbd62005-11-17 13:51:18 +0100629static struct snd_info_entry *snd_card_module_info_entry;
630static void snd_card_module_info_read(struct snd_info_entry *entry,
631 struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632{
633 int idx;
Takashi Iwai512bbd62005-11-17 13:51:18 +0100634 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
636 for (idx = 0; idx < SNDRV_CARDS; idx++) {
Takashi Iwai746df942006-05-15 19:49:05 +0200637 mutex_lock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 if ((card = snd_cards[idx]) != NULL)
Clemens Ladischd0015442005-11-20 14:09:05 +0100639 snd_iprintf(buffer, "%2i %s\n",
640 idx, card->module->name);
Takashi Iwai746df942006-05-15 19:49:05 +0200641 mutex_unlock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 }
643}
644#endif
645
646int __init snd_card_info_init(void)
647{
Takashi Iwai512bbd62005-11-17 13:51:18 +0100648 struct snd_info_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649
650 entry = snd_info_create_module_entry(THIS_MODULE, "cards", NULL);
Takashi Iwai7c22f1a2005-10-10 11:46:31 +0200651 if (! entry)
652 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 entry->c.text.read = snd_card_info_read;
654 if (snd_info_register(entry) < 0) {
655 snd_info_free_entry(entry);
656 return -ENOMEM;
657 }
658 snd_card_info_entry = entry;
659
660#ifdef MODULE
661 entry = snd_info_create_module_entry(THIS_MODULE, "modules", NULL);
662 if (entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 entry->c.text.read = snd_card_module_info_read;
664 if (snd_info_register(entry) < 0)
665 snd_info_free_entry(entry);
666 else
667 snd_card_module_info_entry = entry;
668 }
669#endif
670
671 return 0;
672}
673
674int __exit snd_card_info_done(void)
675{
Takashi Iwai746d4a02006-06-23 14:37:59 +0200676 snd_info_free_entry(snd_card_info_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677#ifdef MODULE
Takashi Iwai746d4a02006-06-23 14:37:59 +0200678 snd_info_free_entry(snd_card_module_info_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679#endif
680 return 0;
681}
682
Takashi Iwaie28563c2005-12-01 10:42:42 +0100683#endif /* CONFIG_PROC_FS */
684
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685/**
686 * snd_component_add - add a component string
687 * @card: soundcard structure
688 * @component: the component id string
689 *
690 * This function adds the component id string to the supported list.
691 * The component can be referred from the alsa-lib.
692 *
693 * Returns zero otherwise a negative error code.
694 */
695
Takashi Iwai512bbd62005-11-17 13:51:18 +0100696int snd_component_add(struct snd_card *card, const char *component)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697{
698 char *ptr;
699 int len = strlen(component);
700
701 ptr = strstr(card->components, component);
702 if (ptr != NULL) {
703 if (ptr[len] == '\0' || ptr[len] == ' ') /* already there */
704 return 1;
705 }
706 if (strlen(card->components) + 1 + len + 1 > sizeof(card->components)) {
707 snd_BUG();
708 return -ENOMEM;
709 }
710 if (card->components[0] != '\0')
711 strcat(card->components, " ");
712 strcat(card->components, component);
713 return 0;
714}
715
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200716EXPORT_SYMBOL(snd_component_add);
717
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718/**
719 * snd_card_file_add - add the file to the file list of the card
720 * @card: soundcard structure
721 * @file: file pointer
722 *
723 * This function adds the file to the file linked-list of the card.
724 * This linked-list is used to keep tracking the connection state,
725 * and to avoid the release of busy resources by hotplug.
726 *
727 * Returns zero or a negative error code.
728 */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100729int snd_card_file_add(struct snd_card *card, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730{
731 struct snd_monitor_file *mfile;
732
733 mfile = kmalloc(sizeof(*mfile), GFP_KERNEL);
734 if (mfile == NULL)
735 return -ENOMEM;
736 mfile->file = file;
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200737 mfile->disconnected_f_op = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 mfile->next = NULL;
739 spin_lock(&card->files_lock);
740 if (card->shutdown) {
741 spin_unlock(&card->files_lock);
742 kfree(mfile);
743 return -ENODEV;
744 }
745 mfile->next = card->files;
746 card->files = mfile;
747 spin_unlock(&card->files_lock);
748 return 0;
749}
750
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200751EXPORT_SYMBOL(snd_card_file_add);
752
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753/**
754 * snd_card_file_remove - remove the file from the file list
755 * @card: soundcard structure
756 * @file: file pointer
757 *
758 * This function removes the file formerly added to the card via
759 * snd_card_file_add() function.
Takashi Iwai2b29b132006-06-23 14:38:26 +0200760 * If all files are removed and snd_card_free_when_closed() was
761 * called beforehand, it processes the pending release of
762 * resources.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 *
764 * Returns zero or a negative error code.
765 */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100766int snd_card_file_remove(struct snd_card *card, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767{
768 struct snd_monitor_file *mfile, *pfile = NULL;
Takashi Iwaic4614822006-06-23 14:38:23 +0200769 int last_close = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770
771 spin_lock(&card->files_lock);
772 mfile = card->files;
773 while (mfile) {
774 if (mfile->file == file) {
775 if (pfile)
776 pfile->next = mfile->next;
777 else
778 card->files = mfile->next;
779 break;
780 }
781 pfile = mfile;
782 mfile = mfile->next;
783 }
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200784 if (mfile && mfile->disconnected_f_op) {
785 fops_put(mfile->disconnected_f_op);
786 spin_lock(&shutdown_lock);
787 list_del(&mfile->shutdown_list);
788 spin_unlock(&shutdown_lock);
789 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 if (card->files == NULL)
Takashi Iwaic4614822006-06-23 14:38:23 +0200791 last_close = 1;
792 spin_unlock(&card->files_lock);
793 if (last_close) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 wake_up(&card->shutdown_sleep);
Takashi Iwaic4614822006-06-23 14:38:23 +0200795 if (card->free_on_last_close)
796 snd_card_do_free(card);
797 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 if (!mfile) {
799 snd_printk(KERN_ERR "ALSA card file remove problem (%p)\n", file);
800 return -ENOENT;
801 }
802 kfree(mfile);
803 return 0;
804}
805
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200806EXPORT_SYMBOL(snd_card_file_remove);
807
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808#ifdef CONFIG_PM
809/**
810 * snd_power_wait - wait until the power-state is changed.
811 * @card: soundcard structure
812 * @power_state: expected power state
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 *
814 * Waits until the power-state is changed.
815 *
816 * Note: the power lock must be active before call.
817 */
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200818int snd_power_wait(struct snd_card *card, unsigned int power_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819{
820 wait_queue_t wait;
821 int result = 0;
822
823 /* fastpath */
824 if (snd_power_get_state(card) == power_state)
825 return 0;
826 init_waitqueue_entry(&wait, current);
827 add_wait_queue(&card->power_sleep, &wait);
828 while (1) {
829 if (card->shutdown) {
830 result = -ENODEV;
831 break;
832 }
833 if (snd_power_get_state(card) == power_state)
834 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 set_current_state(TASK_UNINTERRUPTIBLE);
836 snd_power_unlock(card);
837 schedule_timeout(30 * HZ);
838 snd_power_lock(card);
839 }
840 remove_wait_queue(&card->power_sleep, &wait);
841 return result;
842}
843
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200844EXPORT_SYMBOL(snd_power_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845#endif /* CONFIG_PM */