llseek: automatically add .llseek fop
[linux-2.6.git] / sound / sound_core.c
1 /*
2  *      Sound core.  This file is composed of two parts.  sound_class
3  *      which is common to both OSS and ALSA and OSS sound core which
4  *      is used OSS or emulation of it.
5  */
6
7 /*
8  * First, the common part.
9  */
10 #include <linux/module.h>
11 #include <linux/device.h>
12 #include <linux/err.h>
13 #include <linux/kdev_t.h>
14 #include <linux/major.h>
15 #include <sound/core.h>
16
17 #ifdef CONFIG_SOUND_OSS_CORE
18 static int __init init_oss_soundcore(void);
19 static void cleanup_oss_soundcore(void);
20 #else
21 static inline int init_oss_soundcore(void)      { return 0; }
22 static inline void cleanup_oss_soundcore(void)  { }
23 #endif
24
25 struct class *sound_class;
26 EXPORT_SYMBOL(sound_class);
27
28 MODULE_DESCRIPTION("Core sound module");
29 MODULE_AUTHOR("Alan Cox");
30 MODULE_LICENSE("GPL");
31
32 static char *sound_devnode(struct device *dev, mode_t *mode)
33 {
34         if (MAJOR(dev->devt) == SOUND_MAJOR)
35                 return NULL;
36         return kasprintf(GFP_KERNEL, "snd/%s", dev_name(dev));
37 }
38
39 static int __init init_soundcore(void)
40 {
41         int rc;
42
43         rc = init_oss_soundcore();
44         if (rc)
45                 return rc;
46
47         sound_class = class_create(THIS_MODULE, "sound");
48         if (IS_ERR(sound_class)) {
49                 cleanup_oss_soundcore();
50                 return PTR_ERR(sound_class);
51         }
52
53         sound_class->devnode = sound_devnode;
54
55         return 0;
56 }
57
58 static void __exit cleanup_soundcore(void)
59 {
60         cleanup_oss_soundcore();
61         class_destroy(sound_class);
62 }
63
64 subsys_initcall(init_soundcore);
65 module_exit(cleanup_soundcore);
66
67
68 #ifdef CONFIG_SOUND_OSS_CORE
69 /*
70  *      OSS sound core handling. Breaks out sound functions to submodules
71  *      
72  *      Author:         Alan Cox <alan@lxorguk.ukuu.org.uk>
73  *
74  *      Fixes:
75  *
76  *
77  *      This program is free software; you can redistribute it and/or
78  *      modify it under the terms of the GNU General Public License
79  *      as published by the Free Software Foundation; either version
80  *      2 of the License, or (at your option) any later version.
81  *
82  *                         --------------------
83  * 
84  *      Top level handler for the sound subsystem. Various devices can
85  *      plug into this. The fact they don't all go via OSS doesn't mean 
86  *      they don't have to implement the OSS API. There is a lot of logic
87  *      to keeping much of the OSS weight out of the code in a compatibility
88  *      module, but it's up to the driver to rember to load it...
89  *
90  *      The code provides a set of functions for registration of devices
91  *      by type. This is done rather than providing a single call so that
92  *      we can hide any future changes in the internals (eg when we go to
93  *      32bit dev_t) from the modules and their interface.
94  *
95  *      Secondly we need to allocate the dsp, dsp16 and audio devices as
96  *      one. Thus we misuse the chains a bit to simplify this.
97  *
98  *      Thirdly to make it more fun and for 2.3.x and above we do all
99  *      of this using fine grained locking.
100  *
101  *      FIXME: we have to resolve modules and fine grained load/unload
102  *      locking at some point in 2.3.x.
103  */
104
105 #include <linux/init.h>
106 #include <linux/slab.h>
107 #include <linux/smp_lock.h>
108 #include <linux/types.h>
109 #include <linux/kernel.h>
110 #include <linux/sound.h>
111 #include <linux/kmod.h>
112
113 #define SOUND_STEP 16
114
115 struct sound_unit
116 {
117         int unit_minor;
118         const struct file_operations *unit_fops;
119         struct sound_unit *next;
120         char name[32];
121 };
122
123 #ifdef CONFIG_SOUND_MSNDCLAS
124 extern int msnd_classic_init(void);
125 #endif
126 #ifdef CONFIG_SOUND_MSNDPIN
127 extern int msnd_pinnacle_init(void);
128 #endif
129
130 /*
131  * By default, OSS sound_core claims full legacy minor range (0-255)
132  * of SOUND_MAJOR to trap open attempts to any sound minor and
133  * requests modules using custom sound-slot/service-* module aliases.
134  * The only benefit of doing this is allowing use of custom module
135  * aliases instead of the standard char-major-* ones.  This behavior
136  * prevents alternative OSS implementation and is scheduled to be
137  * removed.
138  *
139  * CONFIG_SOUND_OSS_CORE_PRECLAIM and soundcore.preclaim_oss kernel
140  * parameter are added to allow distros and developers to try and
141  * switch to alternative implementations without needing to rebuild
142  * the kernel in the meantime.  If preclaim_oss is non-zero, the
143  * kernel will behave the same as before.  All SOUND_MAJOR minors are
144  * preclaimed and the custom module aliases along with standard chrdev
145  * ones are emitted if a missing device is opened.  If preclaim_oss is
146  * zero, sound_core only grabs what's actually in use and for missing
147  * devices only the standard chrdev aliases are requested.
148  *
149  * All these clutters are scheduled to be removed along with
150  * sound-slot/service-* module aliases.  Please take a look at
151  * feature-removal-schedule.txt for details.
152  */
153 #ifdef CONFIG_SOUND_OSS_CORE_PRECLAIM
154 static int preclaim_oss = 1;
155 #else
156 static int preclaim_oss = 0;
157 #endif
158
159 module_param(preclaim_oss, int, 0444);
160
161 static int soundcore_open(struct inode *, struct file *);
162
163 static const struct file_operations soundcore_fops =
164 {
165         /* We must have an owner or the module locking fails */
166         .owner  = THIS_MODULE,
167         .open   = soundcore_open,
168         .llseek = noop_llseek,
169 };
170
171 /*
172  *      Low level list operator. Scan the ordered list, find a hole and
173  *      join into it. Called with the lock asserted
174  */
175
176 static int __sound_insert_unit(struct sound_unit * s, struct sound_unit **list, const struct file_operations *fops, int index, int low, int top)
177 {
178         int n=low;
179
180         if (index < 0) {        /* first free */
181
182                 while (*list && (*list)->unit_minor<n)
183                         list=&((*list)->next);
184
185                 while(n<top)
186                 {
187                         /* Found a hole ? */
188                         if(*list==NULL || (*list)->unit_minor>n)
189                                 break;
190                         list=&((*list)->next);
191                         n+=SOUND_STEP;
192                 }
193
194                 if(n>=top)
195                         return -ENOENT;
196         } else {
197                 n = low+(index*16);
198                 while (*list) {
199                         if ((*list)->unit_minor==n)
200                                 return -EBUSY;
201                         if ((*list)->unit_minor>n)
202                                 break;
203                         list=&((*list)->next);
204                 }
205         }       
206                 
207         /*
208          *      Fill it in
209          */
210          
211         s->unit_minor=n;
212         s->unit_fops=fops;
213         
214         /*
215          *      Link it
216          */
217          
218         s->next=*list;
219         *list=s;
220         
221         
222         return n;
223 }
224
225 /*
226  *      Remove a node from the chain. Called with the lock asserted
227  */
228  
229 static struct sound_unit *__sound_remove_unit(struct sound_unit **list, int unit)
230 {
231         while(*list)
232         {
233                 struct sound_unit *p=*list;
234                 if(p->unit_minor==unit)
235                 {
236                         *list=p->next;
237                         return p;
238                 }
239                 list=&(p->next);
240         }
241         printk(KERN_ERR "Sound device %d went missing!\n", unit);
242         return NULL;
243 }
244
245 /*
246  *      This lock guards the sound loader list.
247  */
248
249 static DEFINE_SPINLOCK(sound_loader_lock);
250
251 /*
252  *      Allocate the controlling structure and add it to the sound driver
253  *      list. Acquires locks as needed
254  */
255
256 static int sound_insert_unit(struct sound_unit **list, const struct file_operations *fops, int index, int low, int top, const char *name, umode_t mode, struct device *dev)
257 {
258         struct sound_unit *s = kmalloc(sizeof(*s), GFP_KERNEL);
259         int r;
260
261         if (!s)
262                 return -ENOMEM;
263
264         spin_lock(&sound_loader_lock);
265 retry:
266         r = __sound_insert_unit(s, list, fops, index, low, top);
267         spin_unlock(&sound_loader_lock);
268         
269         if (r < 0)
270                 goto fail;
271         else if (r < SOUND_STEP)
272                 sprintf(s->name, "sound/%s", name);
273         else
274                 sprintf(s->name, "sound/%s%d", name, r / SOUND_STEP);
275
276         if (!preclaim_oss) {
277                 /*
278                  * Something else might have grabbed the minor.  If
279                  * first free slot is requested, rescan with @low set
280                  * to the next unit; otherwise, -EBUSY.
281                  */
282                 r = __register_chrdev(SOUND_MAJOR, s->unit_minor, 1, s->name,
283                                       &soundcore_fops);
284                 if (r < 0) {
285                         spin_lock(&sound_loader_lock);
286                         __sound_remove_unit(list, s->unit_minor);
287                         if (index < 0) {
288                                 low = s->unit_minor + SOUND_STEP;
289                                 goto retry;
290                         }
291                         spin_unlock(&sound_loader_lock);
292                         return -EBUSY;
293                 }
294         }
295
296         device_create(sound_class, dev, MKDEV(SOUND_MAJOR, s->unit_minor),
297                       NULL, s->name+6);
298         return s->unit_minor;
299
300 fail:
301         kfree(s);
302         return r;
303 }
304
305 /*
306  *      Remove a unit. Acquires locks as needed. The drivers MUST have
307  *      completed the removal before their file operations become
308  *      invalid.
309  */
310         
311 static void sound_remove_unit(struct sound_unit **list, int unit)
312 {
313         struct sound_unit *p;
314
315         spin_lock(&sound_loader_lock);
316         p = __sound_remove_unit(list, unit);
317         spin_unlock(&sound_loader_lock);
318         if (p) {
319                 if (!preclaim_oss)
320                         __unregister_chrdev(SOUND_MAJOR, p->unit_minor, 1,
321                                             p->name);
322                 device_destroy(sound_class, MKDEV(SOUND_MAJOR, p->unit_minor));
323                 kfree(p);
324         }
325 }
326
327 /*
328  *      Allocations
329  *
330  *      0       *16             Mixers
331  *      1       *8              Sequencers
332  *      2       *16             Midi
333  *      3       *16             DSP
334  *      4       *16             SunDSP
335  *      5       *16             DSP16
336  *      6       --              sndstat (obsolete)
337  *      7       *16             unused
338  *      8       --              alternate sequencer (see above)
339  *      9       *16             raw synthesizer access
340  *      10      *16             unused
341  *      11      *16             unused
342  *      12      *16             unused
343  *      13      *16             unused
344  *      14      *16             unused
345  *      15      *16             unused
346  */
347
348 static struct sound_unit *chains[SOUND_STEP];
349
350 /**
351  *      register_sound_special_device - register a special sound node
352  *      @fops: File operations for the driver
353  *      @unit: Unit number to allocate
354  *      @dev: device pointer
355  *
356  *      Allocate a special sound device by minor number from the sound
357  *      subsystem. The allocated number is returned on success. On failure
358  *      a negative error code is returned.
359  */
360  
361 int register_sound_special_device(const struct file_operations *fops, int unit,
362                                   struct device *dev)
363 {
364         const int chain = unit % SOUND_STEP;
365         int max_unit = 128 + chain;
366         const char *name;
367         char _name[16];
368
369         switch (chain) {
370             case 0:
371                 name = "mixer";
372                 break;
373             case 1:
374                 name = "sequencer";
375                 if (unit >= SOUND_STEP)
376                         goto __unknown;
377                 max_unit = unit + 1;
378                 break;
379             case 2:
380                 name = "midi";
381                 break;
382             case 3:
383                 name = "dsp";
384                 break;
385             case 4:
386                 name = "audio";
387                 break;
388             case 8:
389                 name = "sequencer2";
390                 if (unit >= SOUND_STEP)
391                         goto __unknown;
392                 max_unit = unit + 1;
393                 break;
394             case 9:
395                 name = "dmmidi";
396                 break;
397             case 10:
398                 name = "dmfm";
399                 break;
400             case 12:
401                 name = "adsp";
402                 break;
403             case 13:
404                 name = "amidi";
405                 break;
406             case 14:
407                 name = "admmidi";
408                 break;
409             default:
410                 {
411                     __unknown:
412                         sprintf(_name, "unknown%d", chain);
413                         if (unit >= SOUND_STEP)
414                                 strcat(_name, "-");
415                         name = _name;
416                 }
417                 break;
418         }
419         return sound_insert_unit(&chains[chain], fops, -1, unit, max_unit,
420                                  name, S_IRUSR | S_IWUSR, dev);
421 }
422  
423 EXPORT_SYMBOL(register_sound_special_device);
424
425 int register_sound_special(const struct file_operations *fops, int unit)
426 {
427         return register_sound_special_device(fops, unit, NULL);
428 }
429
430 EXPORT_SYMBOL(register_sound_special);
431
432 /**
433  *      register_sound_mixer - register a mixer device
434  *      @fops: File operations for the driver
435  *      @dev: Unit number to allocate
436  *
437  *      Allocate a mixer device. Unit is the number of the mixer requested.
438  *      Pass -1 to request the next free mixer unit. On success the allocated
439  *      number is returned, on failure a negative error code is returned.
440  */
441
442 int register_sound_mixer(const struct file_operations *fops, int dev)
443 {
444         return sound_insert_unit(&chains[0], fops, dev, 0, 128,
445                                  "mixer", S_IRUSR | S_IWUSR, NULL);
446 }
447
448 EXPORT_SYMBOL(register_sound_mixer);
449
450 /**
451  *      register_sound_midi - register a midi device
452  *      @fops: File operations for the driver
453  *      @dev: Unit number to allocate
454  *
455  *      Allocate a midi device. Unit is the number of the midi device requested.
456  *      Pass -1 to request the next free midi unit. On success the allocated
457  *      number is returned, on failure a negative error code is returned.
458  */
459
460 int register_sound_midi(const struct file_operations *fops, int dev)
461 {
462         return sound_insert_unit(&chains[2], fops, dev, 2, 130,
463                                  "midi", S_IRUSR | S_IWUSR, NULL);
464 }
465
466 EXPORT_SYMBOL(register_sound_midi);
467
468 /*
469  *      DSP's are registered as a triple. Register only one and cheat
470  *      in open - see below.
471  */
472  
473 /**
474  *      register_sound_dsp - register a DSP device
475  *      @fops: File operations for the driver
476  *      @dev: Unit number to allocate
477  *
478  *      Allocate a DSP device. Unit is the number of the DSP requested.
479  *      Pass -1 to request the next free DSP unit. On success the allocated
480  *      number is returned, on failure a negative error code is returned.
481  *
482  *      This function allocates both the audio and dsp device entries together
483  *      and will always allocate them as a matching pair - eg dsp3/audio3
484  */
485
486 int register_sound_dsp(const struct file_operations *fops, int dev)
487 {
488         return sound_insert_unit(&chains[3], fops, dev, 3, 131,
489                                  "dsp", S_IWUSR | S_IRUSR, NULL);
490 }
491
492 EXPORT_SYMBOL(register_sound_dsp);
493
494 /**
495  *      unregister_sound_special - unregister a special sound device
496  *      @unit: unit number to allocate
497  *
498  *      Release a sound device that was allocated with
499  *      register_sound_special(). The unit passed is the return value from
500  *      the register function.
501  */
502
503
504 void unregister_sound_special(int unit)
505 {
506         sound_remove_unit(&chains[unit % SOUND_STEP], unit);
507 }
508  
509 EXPORT_SYMBOL(unregister_sound_special);
510
511 /**
512  *      unregister_sound_mixer - unregister a mixer
513  *      @unit: unit number to allocate
514  *
515  *      Release a sound device that was allocated with register_sound_mixer().
516  *      The unit passed is the return value from the register function.
517  */
518
519 void unregister_sound_mixer(int unit)
520 {
521         sound_remove_unit(&chains[0], unit);
522 }
523
524 EXPORT_SYMBOL(unregister_sound_mixer);
525
526 /**
527  *      unregister_sound_midi - unregister a midi device
528  *      @unit: unit number to allocate
529  *
530  *      Release a sound device that was allocated with register_sound_midi().
531  *      The unit passed is the return value from the register function.
532  */
533
534 void unregister_sound_midi(int unit)
535 {
536         sound_remove_unit(&chains[2], unit);
537 }
538
539 EXPORT_SYMBOL(unregister_sound_midi);
540
541 /**
542  *      unregister_sound_dsp - unregister a DSP device
543  *      @unit: unit number to allocate
544  *
545  *      Release a sound device that was allocated with register_sound_dsp().
546  *      The unit passed is the return value from the register function.
547  *
548  *      Both of the allocated units are released together automatically.
549  */
550
551 void unregister_sound_dsp(int unit)
552 {
553         sound_remove_unit(&chains[3], unit);
554 }
555
556
557 EXPORT_SYMBOL(unregister_sound_dsp);
558
559 static struct sound_unit *__look_for_unit(int chain, int unit)
560 {
561         struct sound_unit *s;
562         
563         s=chains[chain];
564         while(s && s->unit_minor <= unit)
565         {
566                 if(s->unit_minor==unit)
567                         return s;
568                 s=s->next;
569         }
570         return NULL;
571 }
572
573 static int soundcore_open(struct inode *inode, struct file *file)
574 {
575         int chain;
576         int unit = iminor(inode);
577         struct sound_unit *s;
578         const struct file_operations *new_fops = NULL;
579
580         chain=unit&0x0F;
581         if(chain==4 || chain==5)        /* dsp/audio/dsp16 */
582         {
583                 unit&=0xF0;
584                 unit|=3;
585                 chain=3;
586         }
587         
588         spin_lock(&sound_loader_lock);
589         s = __look_for_unit(chain, unit);
590         if (s)
591                 new_fops = fops_get(s->unit_fops);
592         if (preclaim_oss && !new_fops) {
593                 spin_unlock(&sound_loader_lock);
594
595                 /*
596                  *  Please, don't change this order or code.
597                  *  For ALSA slot means soundcard and OSS emulation code
598                  *  comes as add-on modules which aren't depend on
599                  *  ALSA toplevel modules for soundcards, thus we need
600                  *  load them at first.   [Jaroslav Kysela <perex@jcu.cz>]
601                  */
602                 request_module("sound-slot-%i", unit>>4);
603                 request_module("sound-service-%i-%i", unit>>4, chain);
604
605                 /*
606                  * sound-slot/service-* module aliases are scheduled
607                  * for removal in favor of the standard char-major-*
608                  * module aliases.  For the time being, generate both
609                  * the legacy and standard module aliases to ease
610                  * transition.
611                  */
612                 if (request_module("char-major-%d-%d", SOUND_MAJOR, unit) > 0)
613                         request_module("char-major-%d", SOUND_MAJOR);
614
615                 spin_lock(&sound_loader_lock);
616                 s = __look_for_unit(chain, unit);
617                 if (s)
618                         new_fops = fops_get(s->unit_fops);
619         }
620         if (new_fops) {
621                 /*
622                  * We rely upon the fact that we can't be unloaded while the
623                  * subdriver is there, so if ->open() is successful we can
624                  * safely drop the reference counter and if it is not we can
625                  * revert to old ->f_op. Ugly, indeed, but that's the cost of
626                  * switching ->f_op in the first place.
627                  */
628                 int err = 0;
629                 const struct file_operations *old_fops = file->f_op;
630                 file->f_op = new_fops;
631                 spin_unlock(&sound_loader_lock);
632
633                 if (file->f_op->open)
634                         err = file->f_op->open(inode,file);
635
636                 if (err) {
637                         fops_put(file->f_op);
638                         file->f_op = fops_get(old_fops);
639                 }
640
641                 fops_put(old_fops);
642                 return err;
643         }
644         spin_unlock(&sound_loader_lock);
645         return -ENODEV;
646 }
647
648 MODULE_ALIAS_CHARDEV_MAJOR(SOUND_MAJOR);
649
650 static void cleanup_oss_soundcore(void)
651 {
652         /* We have nothing to really do here - we know the lists must be
653            empty */
654         unregister_chrdev(SOUND_MAJOR, "sound");
655 }
656
657 static int __init init_oss_soundcore(void)
658 {
659         if (preclaim_oss &&
660             register_chrdev(SOUND_MAJOR, "sound", &soundcore_fops) == -1) {
661                 printk(KERN_ERR "soundcore: sound device already in use.\n");
662                 return -EBUSY;
663         }
664
665         return 0;
666 }
667
668 #endif /* CONFIG_SOUND_OSS_CORE */