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