[ALSA] semaphore -> mutex (core part)
[linux-2.6.git] / sound / core / hwdep.c
1 /*
2  *  Hardware dependent layer
3  *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
4  *
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
22 #include <sound/driver.h>
23 #include <linux/major.h>
24 #include <linux/init.h>
25 #include <linux/smp_lock.h>
26 #include <linux/slab.h>
27 #include <linux/time.h>
28 #include <linux/mutex.h>
29 #include <sound/core.h>
30 #include <sound/control.h>
31 #include <sound/minors.h>
32 #include <sound/hwdep.h>
33 #include <sound/info.h>
34
35 MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>");
36 MODULE_DESCRIPTION("Hardware dependent layer");
37 MODULE_LICENSE("GPL");
38
39 static LIST_HEAD(snd_hwdep_devices);
40 static DEFINE_MUTEX(register_mutex);
41
42 static int snd_hwdep_free(struct snd_hwdep *hwdep);
43 static int snd_hwdep_dev_free(struct snd_device *device);
44 static int snd_hwdep_dev_register(struct snd_device *device);
45 static int snd_hwdep_dev_unregister(struct snd_device *device);
46
47
48 static struct snd_hwdep *snd_hwdep_search(struct snd_card *card, int device)
49 {
50         struct list_head *p;
51         struct snd_hwdep *hwdep;
52
53         list_for_each(p, &snd_hwdep_devices) {
54                 hwdep = list_entry(p, struct snd_hwdep, list);
55                 if (hwdep->card == card && hwdep->device == device)
56                         return hwdep;
57         }
58         return NULL;
59 }
60
61 static loff_t snd_hwdep_llseek(struct file * file, loff_t offset, int orig)
62 {
63         struct snd_hwdep *hw = file->private_data;
64         if (hw->ops.llseek)
65                 return hw->ops.llseek(hw, file, offset, orig);
66         return -ENXIO;
67 }
68
69 static ssize_t snd_hwdep_read(struct file * file, char __user *buf,
70                               size_t count, loff_t *offset)
71 {
72         struct snd_hwdep *hw = file->private_data;
73         if (hw->ops.read)
74                 return hw->ops.read(hw, buf, count, offset);
75         return -ENXIO;  
76 }
77
78 static ssize_t snd_hwdep_write(struct file * file, const char __user *buf,
79                                size_t count, loff_t *offset)
80 {
81         struct snd_hwdep *hw = file->private_data;
82         if (hw->ops.write)
83                 return hw->ops.write(hw, buf, count, offset);
84         return -ENXIO;  
85 }
86
87 static int snd_hwdep_open(struct inode *inode, struct file * file)
88 {
89         int major = imajor(inode);
90         struct snd_hwdep *hw;
91         int err;
92         wait_queue_t wait;
93
94         if (major == snd_major) {
95                 hw = snd_lookup_minor_data(iminor(inode),
96                                            SNDRV_DEVICE_TYPE_HWDEP);
97 #ifdef CONFIG_SND_OSSEMUL
98         } else if (major == SOUND_MAJOR) {
99                 hw = snd_lookup_oss_minor_data(iminor(inode),
100                                                SNDRV_OSS_DEVICE_TYPE_DMFM);
101 #endif
102         } else
103                 return -ENXIO;
104         if (hw == NULL)
105                 return -ENODEV;
106
107         if (!hw->ops.open)
108                 return -ENXIO;
109
110         if (!try_module_get(hw->card->module))
111                 return -EFAULT;
112
113         init_waitqueue_entry(&wait, current);
114         add_wait_queue(&hw->open_wait, &wait);
115         mutex_lock(&hw->open_mutex);
116         while (1) {
117                 if (hw->exclusive && hw->used > 0) {
118                         err = -EBUSY;
119                         break;
120                 }
121                 err = hw->ops.open(hw, file);
122                 if (err >= 0)
123                         break;
124                 if (err == -EAGAIN) {
125                         if (file->f_flags & O_NONBLOCK) {
126                                 err = -EBUSY;
127                                 break;
128                         }
129                 } else
130                         break;
131                 set_current_state(TASK_INTERRUPTIBLE);
132                 mutex_unlock(&hw->open_mutex);
133                 schedule();
134                 mutex_lock(&hw->open_mutex);
135                 if (signal_pending(current)) {
136                         err = -ERESTARTSYS;
137                         break;
138                 }
139         }
140         remove_wait_queue(&hw->open_wait, &wait);
141         if (err >= 0) {
142                 err = snd_card_file_add(hw->card, file);
143                 if (err >= 0) {
144                         file->private_data = hw;
145                         hw->used++;
146                 } else {
147                         if (hw->ops.release)
148                                 hw->ops.release(hw, file);
149                 }
150         }
151         mutex_unlock(&hw->open_mutex);
152         if (err < 0)
153                 module_put(hw->card->module);
154         return err;
155 }
156
157 static int snd_hwdep_release(struct inode *inode, struct file * file)
158 {
159         int err = -ENXIO;
160         struct snd_hwdep *hw = file->private_data;
161         mutex_lock(&hw->open_mutex);
162         if (hw->ops.release) {
163                 err = hw->ops.release(hw, file);
164                 wake_up(&hw->open_wait);
165         }
166         if (hw->used > 0)
167                 hw->used--;
168         snd_card_file_remove(hw->card, file);
169         mutex_unlock(&hw->open_mutex);
170         module_put(hw->card->module);
171         return err;
172 }
173
174 static unsigned int snd_hwdep_poll(struct file * file, poll_table * wait)
175 {
176         struct snd_hwdep *hw = file->private_data;
177         if (hw->ops.poll)
178                 return hw->ops.poll(hw, file, wait);
179         return 0;
180 }
181
182 static int snd_hwdep_info(struct snd_hwdep *hw,
183                           struct snd_hwdep_info __user *_info)
184 {
185         struct snd_hwdep_info info;
186         
187         memset(&info, 0, sizeof(info));
188         info.card = hw->card->number;
189         strlcpy(info.id, hw->id, sizeof(info.id));      
190         strlcpy(info.name, hw->name, sizeof(info.name));
191         info.iface = hw->iface;
192         if (copy_to_user(_info, &info, sizeof(info)))
193                 return -EFAULT;
194         return 0;
195 }
196
197 static int snd_hwdep_dsp_status(struct snd_hwdep *hw,
198                                 struct snd_hwdep_dsp_status __user *_info)
199 {
200         struct snd_hwdep_dsp_status info;
201         int err;
202         
203         if (! hw->ops.dsp_status)
204                 return -ENXIO;
205         memset(&info, 0, sizeof(info));
206         info.dsp_loaded = hw->dsp_loaded;
207         if ((err = hw->ops.dsp_status(hw, &info)) < 0)
208                 return err;
209         if (copy_to_user(_info, &info, sizeof(info)))
210                 return -EFAULT;
211         return 0;
212 }
213
214 static int snd_hwdep_dsp_load(struct snd_hwdep *hw,
215                               struct snd_hwdep_dsp_image __user *_info)
216 {
217         struct snd_hwdep_dsp_image info;
218         int err;
219         
220         if (! hw->ops.dsp_load)
221                 return -ENXIO;
222         memset(&info, 0, sizeof(info));
223         if (copy_from_user(&info, _info, sizeof(info)))
224                 return -EFAULT;
225         /* check whether the dsp was already loaded */
226         if (hw->dsp_loaded & (1 << info.index))
227                 return -EBUSY;
228         if (!access_ok(VERIFY_READ, info.image, info.length))
229                 return -EFAULT;
230         err = hw->ops.dsp_load(hw, &info);
231         if (err < 0)
232                 return err;
233         hw->dsp_loaded |= (1 << info.index);
234         return 0;
235 }
236
237 static long snd_hwdep_ioctl(struct file * file, unsigned int cmd,
238                             unsigned long arg)
239 {
240         struct snd_hwdep *hw = file->private_data;
241         void __user *argp = (void __user *)arg;
242         switch (cmd) {
243         case SNDRV_HWDEP_IOCTL_PVERSION:
244                 return put_user(SNDRV_HWDEP_VERSION, (int __user *)argp);
245         case SNDRV_HWDEP_IOCTL_INFO:
246                 return snd_hwdep_info(hw, argp);
247         case SNDRV_HWDEP_IOCTL_DSP_STATUS:
248                 return snd_hwdep_dsp_status(hw, argp);
249         case SNDRV_HWDEP_IOCTL_DSP_LOAD:
250                 return snd_hwdep_dsp_load(hw, argp);
251         }
252         if (hw->ops.ioctl)
253                 return hw->ops.ioctl(hw, file, cmd, arg);
254         return -ENOTTY;
255 }
256
257 static int snd_hwdep_mmap(struct file * file, struct vm_area_struct * vma)
258 {
259         struct snd_hwdep *hw = file->private_data;
260         if (hw->ops.mmap)
261                 return hw->ops.mmap(hw, file, vma);
262         return -ENXIO;
263 }
264
265 static int snd_hwdep_control_ioctl(struct snd_card *card,
266                                    struct snd_ctl_file * control,
267                                    unsigned int cmd, unsigned long arg)
268 {
269         switch (cmd) {
270         case SNDRV_CTL_IOCTL_HWDEP_NEXT_DEVICE:
271                 {
272                         int device;
273
274                         if (get_user(device, (int __user *)arg))
275                                 return -EFAULT;
276                         mutex_lock(&register_mutex);
277                         device = device < 0 ? 0 : device + 1;
278                         while (device < SNDRV_MINOR_HWDEPS) {
279                                 if (snd_hwdep_search(card, device))
280                                         break;
281                                 device++;
282                         }
283                         if (device >= SNDRV_MINOR_HWDEPS)
284                                 device = -1;
285                         mutex_unlock(&register_mutex);
286                         if (put_user(device, (int __user *)arg))
287                                 return -EFAULT;
288                         return 0;
289                 }
290         case SNDRV_CTL_IOCTL_HWDEP_INFO:
291                 {
292                         struct snd_hwdep_info __user *info = (struct snd_hwdep_info __user *)arg;
293                         int device, err;
294                         struct snd_hwdep *hwdep;
295
296                         if (get_user(device, &info->device))
297                                 return -EFAULT;
298                         mutex_lock(&register_mutex);
299                         hwdep = snd_hwdep_search(card, device);
300                         if (hwdep)
301                                 err = snd_hwdep_info(hwdep, info);
302                         else
303                                 err = -ENXIO;
304                         mutex_unlock(&register_mutex);
305                         return err;
306                 }
307         }
308         return -ENOIOCTLCMD;
309 }
310
311 #ifdef CONFIG_COMPAT
312 #include "hwdep_compat.c"
313 #else
314 #define snd_hwdep_ioctl_compat  NULL
315 #endif
316
317 /*
318
319  */
320
321 static struct file_operations snd_hwdep_f_ops =
322 {
323         .owner =        THIS_MODULE,
324         .llseek =       snd_hwdep_llseek,
325         .read =         snd_hwdep_read,
326         .write =        snd_hwdep_write,
327         .open =         snd_hwdep_open,
328         .release =      snd_hwdep_release,
329         .poll =         snd_hwdep_poll,
330         .unlocked_ioctl =       snd_hwdep_ioctl,
331         .compat_ioctl = snd_hwdep_ioctl_compat,
332         .mmap =         snd_hwdep_mmap,
333 };
334
335 /**
336  * snd_hwdep_new - create a new hwdep instance
337  * @card: the card instance
338  * @id: the id string
339  * @device: the device index (zero-based)
340  * @rhwdep: the pointer to store the new hwdep instance
341  *
342  * Creates a new hwdep instance with the given index on the card.
343  * The callbacks (hwdep->ops) must be set on the returned instance
344  * after this call manually by the caller.
345  *
346  * Returns zero if successful, or a negative error code on failure.
347  */
348 int snd_hwdep_new(struct snd_card *card, char *id, int device,
349                   struct snd_hwdep **rhwdep)
350 {
351         struct snd_hwdep *hwdep;
352         int err;
353         static struct snd_device_ops ops = {
354                 .dev_free = snd_hwdep_dev_free,
355                 .dev_register = snd_hwdep_dev_register,
356                 .dev_unregister = snd_hwdep_dev_unregister
357         };
358
359         snd_assert(rhwdep != NULL, return -EINVAL);
360         *rhwdep = NULL;
361         snd_assert(card != NULL, return -ENXIO);
362         hwdep = kzalloc(sizeof(*hwdep), GFP_KERNEL);
363         if (hwdep == NULL) {
364                 snd_printk(KERN_ERR "hwdep: cannot allocate\n");
365                 return -ENOMEM;
366         }
367         hwdep->card = card;
368         hwdep->device = device;
369         if (id)
370                 strlcpy(hwdep->id, id, sizeof(hwdep->id));
371 #ifdef CONFIG_SND_OSSEMUL
372         hwdep->oss_type = -1;
373 #endif
374         if ((err = snd_device_new(card, SNDRV_DEV_HWDEP, hwdep, &ops)) < 0) {
375                 snd_hwdep_free(hwdep);
376                 return err;
377         }
378         init_waitqueue_head(&hwdep->open_wait);
379         mutex_init(&hwdep->open_mutex);
380         *rhwdep = hwdep;
381         return 0;
382 }
383
384 static int snd_hwdep_free(struct snd_hwdep *hwdep)
385 {
386         snd_assert(hwdep != NULL, return -ENXIO);
387         if (hwdep->private_free)
388                 hwdep->private_free(hwdep);
389         kfree(hwdep);
390         return 0;
391 }
392
393 static int snd_hwdep_dev_free(struct snd_device *device)
394 {
395         struct snd_hwdep *hwdep = device->device_data;
396         return snd_hwdep_free(hwdep);
397 }
398
399 static int snd_hwdep_dev_register(struct snd_device *device)
400 {
401         struct snd_hwdep *hwdep = device->device_data;
402         int err;
403         char name[32];
404
405         mutex_lock(&register_mutex);
406         if (snd_hwdep_search(hwdep->card, hwdep->device)) {
407                 mutex_unlock(&register_mutex);
408                 return -EBUSY;
409         }
410         list_add_tail(&hwdep->list, &snd_hwdep_devices);
411         sprintf(name, "hwC%iD%i", hwdep->card->number, hwdep->device);
412         if ((err = snd_register_device(SNDRV_DEVICE_TYPE_HWDEP,
413                                        hwdep->card, hwdep->device,
414                                        &snd_hwdep_f_ops, hwdep, name)) < 0) {
415                 snd_printk(KERN_ERR "unable to register hardware dependent device %i:%i\n",
416                            hwdep->card->number, hwdep->device);
417                 list_del(&hwdep->list);
418                 mutex_unlock(&register_mutex);
419                 return err;
420         }
421 #ifdef CONFIG_SND_OSSEMUL
422         hwdep->ossreg = 0;
423         if (hwdep->oss_type >= 0) {
424                 if ((hwdep->oss_type == SNDRV_OSS_DEVICE_TYPE_DMFM) && (hwdep->device != 0)) {
425                         snd_printk (KERN_WARNING "only hwdep device 0 can be registered as OSS direct FM device!\n");
426                 } else {
427                         if (snd_register_oss_device(hwdep->oss_type,
428                                                     hwdep->card, hwdep->device,
429                                                     &snd_hwdep_f_ops, hwdep,
430                                                     hwdep->oss_dev) < 0) {
431                                 snd_printk(KERN_ERR "unable to register OSS compatibility device %i:%i\n",
432                                            hwdep->card->number, hwdep->device);
433                         } else
434                                 hwdep->ossreg = 1;
435                 }
436         }
437 #endif
438         mutex_unlock(&register_mutex);
439         return 0;
440 }
441
442 static int snd_hwdep_dev_unregister(struct snd_device *device)
443 {
444         struct snd_hwdep *hwdep = device->device_data;
445
446         snd_assert(hwdep != NULL, return -ENXIO);
447         mutex_lock(&register_mutex);
448         if (snd_hwdep_search(hwdep->card, hwdep->device) != hwdep) {
449                 mutex_unlock(&register_mutex);
450                 return -EINVAL;
451         }
452 #ifdef CONFIG_SND_OSSEMUL
453         if (hwdep->ossreg)
454                 snd_unregister_oss_device(hwdep->oss_type, hwdep->card, hwdep->device);
455 #endif
456         snd_unregister_device(SNDRV_DEVICE_TYPE_HWDEP, hwdep->card, hwdep->device);
457         list_del(&hwdep->list);
458         mutex_unlock(&register_mutex);
459         return snd_hwdep_free(hwdep);
460 }
461
462 #ifdef CONFIG_PROC_FS
463 /*
464  *  Info interface
465  */
466
467 static void snd_hwdep_proc_read(struct snd_info_entry *entry,
468                                 struct snd_info_buffer *buffer)
469 {
470         struct list_head *p;
471         struct snd_hwdep *hwdep;
472
473         mutex_lock(&register_mutex);
474         list_for_each(p, &snd_hwdep_devices) {
475                 hwdep = list_entry(p, struct snd_hwdep, list);
476                 snd_iprintf(buffer, "%02i-%02i: %s\n",
477                             hwdep->card->number, hwdep->device, hwdep->name);
478         }
479         mutex_unlock(&register_mutex);
480 }
481
482 static struct snd_info_entry *snd_hwdep_proc_entry;
483
484 static void __init snd_hwdep_proc_init(void)
485 {
486         struct snd_info_entry *entry;
487
488         if ((entry = snd_info_create_module_entry(THIS_MODULE, "hwdep", NULL)) != NULL) {
489                 entry->c.text.read_size = PAGE_SIZE;
490                 entry->c.text.read = snd_hwdep_proc_read;
491                 if (snd_info_register(entry) < 0) {
492                         snd_info_free_entry(entry);
493                         entry = NULL;
494                 }
495         }
496         snd_hwdep_proc_entry = entry;
497 }
498
499 static void __exit snd_hwdep_proc_done(void)
500 {
501         snd_info_unregister(snd_hwdep_proc_entry);
502 }
503 #else /* !CONFIG_PROC_FS */
504 #define snd_hwdep_proc_init()
505 #define snd_hwdep_proc_done()
506 #endif /* CONFIG_PROC_FS */
507
508
509 /*
510  *  ENTRY functions
511  */
512
513 static int __init alsa_hwdep_init(void)
514 {
515         snd_hwdep_proc_init();
516         snd_ctl_register_ioctl(snd_hwdep_control_ioctl);
517         snd_ctl_register_ioctl_compat(snd_hwdep_control_ioctl);
518         return 0;
519 }
520
521 static void __exit alsa_hwdep_exit(void)
522 {
523         snd_ctl_unregister_ioctl(snd_hwdep_control_ioctl);
524         snd_ctl_unregister_ioctl_compat(snd_hwdep_control_ioctl);
525         snd_hwdep_proc_done();
526 }
527
528 module_init(alsa_hwdep_init)
529 module_exit(alsa_hwdep_exit)
530
531 EXPORT_SYMBOL(snd_hwdep_new);