2 * linux/sound/oss/dmasound/dmasound_core.c
5 * OSS/Free compatible Atari TT/Falcon and Amiga DMA sound driver for
7 * Extended to support Power Macintosh for Linux/ppc by Paul Mackerras
9 * (c) 1995 by Michael Schlueter & Michael Marte
11 * Michael Schlueter (michael@duck.syd.de) did the basic structure of the VFS
12 * interface and the u-law to signed byte conversion.
14 * Michael Marte (marte@informatik.uni-muenchen.de) did the sound queue,
15 * /dev/mixer, /dev/sndstat and complemented the VFS interface. He would like
17 * - Michael Schlueter for initial ideas and documentation on the MFP and
18 * the DMA sound hardware.
19 * - Therapy? for their CD 'Troublegum' which really made me rock.
21 * /dev/sndstat is based on code by Hannu Savolainen, the author of the
22 * VoxWare family of drivers.
24 * This file is subject to the terms and conditions of the GNU General Public
25 * License. See the file COPYING in the main directory of this archive
30 * 1995/8/25 First release
32 * 1995/9/02 Roman Hodek:
33 * - Fixed atari_stram_alloc() call, the timer
34 * programming and several race conditions
35 * 1995/9/14 Roman Hodek:
36 * - After some discussion with Michael Schlueter,
37 * revised the interrupt disabling
38 * - Slightly speeded up U8->S8 translation by using
39 * long operations where possible
40 * - Added 4:3 interpolation for /dev/audio
42 * 1995/9/20 Torsten Scherer:
43 * - Fixed a bug in sq_write and changed /dev/audio
44 * converting to play at 12517Hz instead of 6258Hz.
46 * 1995/9/23 Torsten Scherer:
47 * - Changed sq_interrupt() and sq_play() to pre-program
48 * the DMA for another frame while there's still one
49 * running. This allows the IRQ response to be
50 * arbitrarily delayed and playing will still continue.
52 * 1995/10/14 Guenther Kelleter, Torsten Scherer:
53 * - Better support for Falcon audio (the Falcon doesn't
54 * raise an IRQ at the end of a frame, but at the
55 * beginning instead!). uses 'if (codec_dma)' in lots
56 * of places to simply switch between Falcon and TT
59 * 1995/11/06 Torsten Scherer:
60 * - Started introducing a hardware abstraction scheme
61 * (may perhaps also serve for Amigas?)
62 * - Can now play samples at almost all frequencies by
63 * means of a more generalized expand routine
64 * - Takes a good deal of care to cut data only at
66 * - Buffer size is now a kernel runtime option
67 * - Implemented fsync() & several minor improvements
69 * - Useful hints and bug fixes
70 * - Cross-checked it for Falcons
72 * 1996/3/9 Geert Uytterhoeven:
73 * - Support added for Amiga, A-law, 16-bit little
75 * - Unification to drivers/sound/dmasound.c.
77 * 1996/4/6 Martin Mitchell:
78 * - Updated to 1.3 kernel.
80 * 1996/6/13 Topi Kanerva:
81 * - Fixed things that were broken (mainly the amiga
83 * - /dev/sndstat shows now the real hardware frequency
84 * - The lowpass filter is disabled by default now
86 * 1996/9/25 Geert Uytterhoeven:
89 * 1998/6/10 Andreas Schwab:
90 * - Converted to use sound_core
92 * 1999/12/28 Richard Zidlicky:
93 * - Added support for Q40
95 * 2000/2/27 Geert Uytterhoeven:
96 * - Clean up and split the code into 4 parts:
97 * o dmasound_core: machine-independent code
98 * o dmasound_atari: Atari TT and Falcon support
99 * o dmasound_awacs: Apple PowerMac support
100 * o dmasound_paula: Amiga support
102 * 2000/3/25 Geert Uytterhoeven:
103 * - Integration of dmasound_q40
106 * 2001/01/26 [1.0] Iain Sandoe
107 * - make /dev/sndstat show revision & edition info.
108 * - since dmasound.mach.sq_setup() can fail on pmac
109 * its type has been changed to int and the returns
111 * [1.1] - stop missing translations from being called.
112 * 2001/02/08 [1.2] - remove unused translation tables & move machine-
113 * specific tables to low-level.
114 * - return correct info. for SNDCTL_DSP_GETFMTS.
115 * [1.3] - implement SNDCTL_DSP_GETCAPS fully.
116 * [1.4] - make /dev/sndstat text length usage deterministic.
117 * - make /dev/sndstat call to low-level
118 * dmasound.mach.state_info() pass max space to ll driver.
119 * - tidy startup banners and output info.
120 * [1.5] - tidy up a little (removed some unused #defines in
122 * - fix up HAS_RECORD conditionalisation.
123 * - add record code in places it is missing...
124 * - change buf-sizes to bytes to allow < 1kb for pmac
125 * if user param entry is < 256 the value is taken to
126 * be in kb > 256 is taken to be in bytes.
127 * - make default buff/frag params conditional on
128 * machine to allow smaller values for pmac.
129 * - made the ioctls, read & write comply with the OSS
130 * rules on setting params.
131 * - added parsing of _setup() params for record.
132 * 2001/04/04 [1.6] - fix bug where sample rates higher than maximum were
133 * being reported as OK.
134 * - fix open() to return -EBUSY as per OSS doc. when
135 * audio is in use - this is independent of O_NOBLOCK.
136 * - fix bug where SNDCTL_DSP_POST was blocking.
139 /* Record capability notes 30/01/2001:
140 * At present these observations apply only to pmac LL driver (the only one
141 * that can do record, at present). However, if other LL drivers for machines
142 * with record are added they may apply.
144 * The fragment parameters for the record and play channels are separate.
145 * However, if the driver is opened O_RDWR there is no way (in the current OSS
146 * API) to specify their values independently for the record and playback
147 * channels. Since the only common factor between the input & output is the
148 * sample rate (on pmac) it should be possible to open /dev/dspX O_WRONLY and
149 * /dev/dspY O_RDONLY. The input & output channels could then have different
150 * characteristics (other than the first that sets sample rate claiming the
151 * right to set it for ever). As it stands, the format, channels, number of
152 * bits & sample rate are assumed to be common. In the future perhaps these
153 * should be the responsibility of the LL driver - and then if a card really
154 * does not share items between record & playback they can be specified
158 /* Thread-safeness of shared_resources notes: 31/01/2001
159 * If the user opens O_RDWR and then splits record & play between two threads
160 * both of which inherit the fd - and then starts changing things from both
161 * - we will have difficulty telling.
163 * It's bad application coding - but ...
164 * TODO: think about how to sort this out... without bogging everything down in
167 * Similarly, the OSS spec says "all changes to parameters must be between
168 * open() and the first read() or write(). - and a bit later on (by
169 * implication) "between SNDCTL_DSP_RESET and the first read() or write() after
170 * it". If the app is multi-threaded and this rule is broken between threads
171 * we will have trouble spotting it - and the fault will be rather obscure :-(
173 * We will try and put out at least a kmsg if we see it happen... but I think
174 * it will be quite hard to trap it with an -EXXX return... because we can't
175 * see the fault until after the damage is done.
178 #include <linux/module.h>
179 #include <linux/slab.h>
180 #include <linux/sound.h>
181 #include <linux/init.h>
182 #include <linux/soundcard.h>
183 #include <linux/poll.h>
184 #include <linux/smp_lock.h>
186 #include <asm/uaccess.h>
188 #include "dmasound.h"
190 #define DMASOUND_CORE_REVISION 1
191 #define DMASOUND_CORE_EDITION 6
197 int dmasound_catchRadius = 0;
198 module_param(dmasound_catchRadius, int, 0);
200 static unsigned int numWriteBufs = DEFAULT_N_BUFFERS;
201 module_param(numWriteBufs, int, 0);
202 static unsigned int writeBufSize = DEFAULT_BUFF_SIZE ; /* in bytes */
203 module_param(writeBufSize, int, 0);
205 MODULE_LICENSE("GPL");
208 static int sq_unit = -1;
209 static int mixer_unit = -1;
210 static int state_unit = -1;
211 static int irq_installed;
214 /* software implemented recording volume! */
215 uint software_input_volume = SW_INPUT_VOLUME_SCALE * SW_INPUT_VOLUME_DEFAULT;
216 EXPORT_SYMBOL(software_input_volume);
218 /* control over who can modify resources shared between play/record */
219 static mode_t shared_resource_owner;
220 static int shared_resources_initialised;
226 struct sound_settings dmasound = { .lock = SPIN_LOCK_UNLOCKED };
228 static inline void sound_silence(void)
230 dmasound.mach.silence(); /* _MUST_ stop DMA */
233 static inline int sound_set_format(int format)
235 return dmasound.mach.setFormat(format);
239 static int sound_set_speed(int speed)
242 return dmasound.soft.speed;
244 /* trap out-of-range speed settings.
245 at present we allow (arbitrarily) low rates - using soft
246 up-conversion - but we can't allow > max because there is
247 no soft down-conversion.
249 if (dmasound.mach.max_dsp_speed &&
250 (speed > dmasound.mach.max_dsp_speed))
251 speed = dmasound.mach.max_dsp_speed ;
253 dmasound.soft.speed = speed;
255 if (dmasound.minDev == SND_DEV_DSP)
256 dmasound.dsp.speed = dmasound.soft.speed;
258 return dmasound.soft.speed;
261 static int sound_set_stereo(int stereo)
264 return dmasound.soft.stereo;
266 stereo = !!stereo; /* should be 0 or 1 now */
268 dmasound.soft.stereo = stereo;
269 if (dmasound.minDev == SND_DEV_DSP)
270 dmasound.dsp.stereo = stereo;
275 static ssize_t sound_copy_translate(TRANS *trans, const u_char __user *userPtr,
276 size_t userCount, u_char frame[],
277 ssize_t *frameUsed, ssize_t frameLeft)
279 ssize_t (*ct_func)(const u_char __user *, size_t, u_char *, ssize_t *, ssize_t);
281 switch (dmasound.soft.format) {
283 ct_func = trans->ct_ulaw;
286 ct_func = trans->ct_alaw;
289 ct_func = trans->ct_s8;
292 ct_func = trans->ct_u8;
295 ct_func = trans->ct_s16be;
298 ct_func = trans->ct_u16be;
301 ct_func = trans->ct_s16le;
304 ct_func = trans->ct_u16le;
309 /* if the user has requested a non-existent translation don't try
310 to call it but just return 0 bytes moved
313 return ct_func(userPtr, userCount, frame, frameUsed, frameLeft);
318 * /dev/mixer abstraction
326 static int mixer_open(struct inode *inode, struct file *file)
328 if (!try_module_get(dmasound.mach.owner))
334 static int mixer_release(struct inode *inode, struct file *file)
338 module_put(dmasound.mach.owner);
342 static int mixer_ioctl(struct inode *inode, struct file *file, u_int cmd,
345 if (_SIOC_DIR(cmd) & _SIOC_WRITE)
346 mixer.modify_counter++;
349 return IOCTL_OUT(arg, SOUND_VERSION);
350 case SOUND_MIXER_INFO:
353 memset(&info, 0, sizeof(info));
354 strlcpy(info.id, dmasound.mach.name2, sizeof(info.id));
355 strlcpy(info.name, dmasound.mach.name2, sizeof(info.name));
356 info.modify_counter = mixer.modify_counter;
357 if (copy_to_user((void __user *)arg, &info, sizeof(info)))
362 if (dmasound.mach.mixer_ioctl)
363 return dmasound.mach.mixer_ioctl(cmd, arg);
367 static const struct file_operations mixer_fops =
369 .owner = THIS_MODULE,
371 .ioctl = mixer_ioctl,
373 .release = mixer_release,
376 static void mixer_init(void)
381 mixer_unit = register_sound_mixer(&mixer_fops, -1);
388 if (dmasound.mach.mixer_init)
389 dmasound.mach.mixer_init();
394 * Sound queue stuff, the heart of the driver
397 struct sound_queue dmasound_write_sq;
398 static void sq_reset_output(void) ;
400 static int sq_allocate_buffers(struct sound_queue *sq, int num, int size)
408 sq->buffers = kmalloc (num * sizeof(char *), GFP_KERNEL);
411 for (i = 0; i < num; i++) {
412 sq->buffers[i] = dmasound.mach.dma_alloc(size, GFP_KERNEL);
413 if (!sq->buffers[i]) {
415 dmasound.mach.dma_free(sq->buffers[i], size);
424 static void sq_release_buffers(struct sound_queue *sq)
429 for (i = 0; i < sq->numBufs; i++)
430 dmasound.mach.dma_free(sq->buffers[i], sq->bufSize);
437 static int sq_setup(struct sound_queue *sq)
439 int (*setup_func)(void) = NULL;
442 if (sq->locked) { /* are we already set? - and not changeable */
443 #ifdef DEBUG_DMASOUND
444 printk("dmasound_core: tried to sq_setup a locked queue\n") ;
448 sq->locked = 1 ; /* don't think we have a race prob. here _check_ */
450 /* make sure that the parameters are set up
451 This should have been done already...
454 dmasound.mach.init();
456 /* OK. If the user has set fragment parameters explicitly, then we
457 should leave them alone... as long as they are valid.
458 Invalid user fragment params can occur if we allow the whole buffer
459 to be used when the user requests the fragments sizes (with no soft
460 x-lation) and then the user subsequently sets a soft x-lation that
461 requires increased internal buffering.
463 Othwerwise (if the user did not set them) OSS says that we should
464 select frag params on the basis of 0.5 s output & 0.1 s input
465 latency. (TODO. For now we will copy in the defaults.)
468 if (sq->user_frags <= 0) {
469 sq->max_count = sq->numBufs ;
470 sq->max_active = sq->numBufs ;
471 sq->block_size = sq->bufSize;
472 /* set up the user info */
473 sq->user_frags = sq->numBufs ;
474 sq->user_frag_size = sq->bufSize ;
475 sq->user_frag_size *=
476 (dmasound.soft.size * (dmasound.soft.stereo+1) ) ;
477 sq->user_frag_size /=
478 (dmasound.hard.size * (dmasound.hard.stereo+1) ) ;
480 /* work out requested block size */
481 sq->block_size = sq->user_frag_size ;
483 (dmasound.hard.size * (dmasound.hard.stereo+1) ) ;
485 (dmasound.soft.size * (dmasound.soft.stereo+1) ) ;
486 /* the user wants to write frag-size chunks */
487 sq->block_size *= dmasound.hard.speed ;
488 sq->block_size /= dmasound.soft.speed ;
489 /* this only works for size values which are powers of 2 */
491 (dmasound.hard.size * (dmasound.hard.stereo+1))/8 ;
492 sq->block_size += (hard_frame - 1) ;
493 sq->block_size &= ~(hard_frame - 1) ; /* make sure we are aligned */
494 /* let's just check for obvious mistakes */
495 if ( sq->block_size <= 0 || sq->block_size > sq->bufSize) {
496 #ifdef DEBUG_DMASOUND
497 printk("dmasound_core: invalid frag size (user set %d)\n", sq->user_frag_size) ;
499 sq->block_size = sq->bufSize ;
501 if ( sq->user_frags <= sq->numBufs ) {
502 sq->max_count = sq->user_frags ;
503 /* if user has set max_active - then use it */
504 sq->max_active = (sq->max_active <= sq->max_count) ?
505 sq->max_active : sq->max_count ;
507 #ifdef DEBUG_DMASOUND
508 printk("dmasound_core: invalid frag count (user set %d)\n", sq->user_frags) ;
511 sq->max_active = sq->numBufs ;
514 sq->front = sq->count = sq->rear_size = 0;
518 if (sq == &write_sq) {
520 setup_func = dmasound.mach.write_sq_setup;
527 static inline void sq_play(void)
529 dmasound.mach.play();
532 static ssize_t sq_write(struct file *file, const char __user *src, size_t uLeft,
535 ssize_t uWritten = 0;
537 ssize_t uUsed = 0, bUsed, bLeft;
538 unsigned long flags ;
540 /* ++TeSche: Is something like this necessary?
541 * Hey, that's an honest question! Or does any other part of the
542 * filesystem already checks this situation? I really don't know.
547 /* implement any changes we have made to the soft/hard params.
548 this is not satisfactory really, all we have done up to now is to
549 say what we would like - there hasn't been any real checking of capability
552 if (shared_resources_initialised == 0) {
553 dmasound.mach.init() ;
554 shared_resources_initialised = 1 ;
557 /* set up the sq if it is not already done. This may seem a dumb place
558 to do it - but it is what OSS requires. It means that write() can
559 return memory allocation errors. To avoid this possibility use the
560 GETBLKSIZE or GETOSPACE ioctls (after you've fiddled with all the
561 params you want to change) - these ioctls also force the setup.
564 if (write_sq.locked == 0) {
565 if ((uWritten = sq_setup(&write_sq)) < 0) return uWritten ;
569 /* FIXME: I think that this may be the wrong behaviour when we get strapped
570 for time and the cpu is close to being (or actually) behind in sending data.
571 - because we've lost the time that the N samples, already in the buffer,
572 would have given us to get here with the next lot from the user.
574 /* The interrupt doesn't start to play the last, incomplete frame.
575 * Thus we can append to it without disabling the interrupts! (Note
576 * also that write_sq.rear isn't affected by the interrupt.)
579 /* as of 1.6 this behaviour changes if SNDCTL_DSP_POST has been issued:
580 this will mimic the behaviour of syncing and allow the sq_play() to
581 queue a partial fragment. Since sq_play() may/will be called from
582 the IRQ handler - at least on Pmac we have to deal with it.
583 The strategy - possibly not optimum - is to kill _POST status if we
584 get here. This seems, at least, reasonable - in the sense that POST
585 is supposed to indicate that we might not write before the queue
586 is drained - and if we get here in time then it does not apply.
589 spin_lock_irqsave(&dmasound.lock, flags);
590 write_sq.syncing &= ~2 ; /* take out POST status */
591 spin_unlock_irqrestore(&dmasound.lock, flags);
593 if (write_sq.count > 0 &&
594 (bLeft = write_sq.block_size-write_sq.rear_size) > 0) {
595 dest = write_sq.buffers[write_sq.rear];
596 bUsed = write_sq.rear_size;
597 uUsed = sound_copy_translate(dmasound.trans_write, src, uLeft,
598 dest, &bUsed, bLeft);
603 uLeft = (uUsed <= uLeft) ? (uLeft - uUsed) : 0 ; /* paranoia */
604 write_sq.rear_size = bUsed;
608 while (write_sq.count >= write_sq.max_active) {
610 if (write_sq.open_mode & O_NONBLOCK)
611 return uWritten > 0 ? uWritten : -EAGAIN;
612 SLEEP(write_sq.action_queue);
613 if (signal_pending(current))
614 return uWritten > 0 ? uWritten : -EINTR;
617 /* Here, we can avoid disabling the interrupt by first
618 * copying and translating the data, and then updating
619 * the write_sq variables. Until this is done, the interrupt
620 * won't see the new frame and we can work on it
624 dest = write_sq.buffers[(write_sq.rear+1) % write_sq.max_count];
626 bLeft = write_sq.block_size;
627 uUsed = sound_copy_translate(dmasound.trans_write, src, uLeft,
628 dest, &bUsed, bLeft);
633 uLeft = (uUsed <= uLeft) ? (uLeft - uUsed) : 0 ; /* paranoia */
635 write_sq.rear = (write_sq.rear+1) % write_sq.max_count;
636 write_sq.rear_size = bUsed;
639 } /* uUsed may have been 0 */
643 return uUsed < 0? uUsed: uWritten;
646 static unsigned int sq_poll(struct file *file, struct poll_table_struct *wait)
648 unsigned int mask = 0;
651 if (write_sq.locked == 0) {
652 if ((retVal = sq_setup(&write_sq)) < 0)
656 if (file->f_mode & FMODE_WRITE )
657 poll_wait(file, &write_sq.action_queue, wait);
658 if (file->f_mode & FMODE_WRITE)
659 if (write_sq.count < write_sq.max_active || write_sq.block_size - write_sq.rear_size > 0)
660 mask |= POLLOUT | POLLWRNORM;
665 static inline void sq_init_waitqueue(struct sound_queue *sq)
667 init_waitqueue_head(&sq->action_queue);
668 init_waitqueue_head(&sq->open_queue);
669 init_waitqueue_head(&sq->sync_queue);
673 #if 0 /* blocking open() */
674 static inline void sq_wake_up(struct sound_queue *sq, struct file *file,
677 if (file->f_mode & mode) {
678 sq->busy = 0; /* CHECK: IS THIS OK??? */
679 WAKE_UP(sq->open_queue);
684 static int sq_open2(struct sound_queue *sq, struct file *file, mode_t mode,
685 int numbufs, int bufsize)
689 if (file->f_mode & mode) {
691 #if 0 /* blocking open() */
693 if (file->f_flags & O_NONBLOCK)
697 SLEEP(sq->open_queue);
698 if (signal_pending(current))
703 /* OSS manual says we will return EBUSY regardless
709 sq->busy = 1; /* Let's play spot-the-race-condition */
711 /* allocate the default number & size of buffers.
712 (i.e. specified in _setup() or as module params)
713 can't be changed at the moment - but _could_ be perhaps
714 in the setfragments ioctl.
716 if (( rc = sq_allocate_buffers(sq, numbufs, bufsize))) {
717 #if 0 /* blocking open() */
718 sq_wake_up(sq, file, mode);
725 sq->open_mode = file->f_mode;
730 #define write_sq_init_waitqueue() sq_init_waitqueue(&write_sq)
731 #if 0 /* blocking open() */
732 #define write_sq_wake_up(file) sq_wake_up(&write_sq, file, FMODE_WRITE)
734 #define write_sq_release_buffers() sq_release_buffers(&write_sq)
735 #define write_sq_open(file) \
736 sq_open2(&write_sq, file, FMODE_WRITE, numWriteBufs, writeBufSize )
738 static int sq_open(struct inode *inode, struct file *file)
742 if (!try_module_get(dmasound.mach.owner))
745 rc = write_sq_open(file); /* checks the f_mode */
748 if (file->f_mode & FMODE_READ) {
749 /* TODO: if O_RDWR, release any resources grabbed by write part */
750 rc = -ENXIO ; /* I think this is what is required by open(2) */
754 if (dmasound.mach.sq_open)
755 dmasound.mach.sq_open(file->f_mode);
757 /* CHECK whether this is sensible - in the case that dsp0 could be opened
758 O_RDONLY and dsp1 could be opened O_WRONLY
761 dmasound.minDev = iminor(inode) & 0x0f;
763 /* OK. - we should make some attempt at consistency. At least the H'ware
764 options should be set with a valid mode. We will make it that the LL
765 driver must supply defaults for hard & soft params.
768 if (shared_resource_owner == 0) {
769 /* you can make this AFMT_U8/mono/8K if you want to mimic old
770 OSS behaviour - while we still have soft translations ;-) */
771 dmasound.soft = dmasound.mach.default_soft ;
772 dmasound.dsp = dmasound.mach.default_soft ;
773 dmasound.hard = dmasound.mach.default_hard ;
776 #ifndef DMASOUND_STRICT_OSS_COMPLIANCE
777 /* none of the current LL drivers can actually do this "native" at the moment
778 OSS does not really require us to supply /dev/audio if we can't do it.
780 if (dmasound.minDev == SND_DEV_AUDIO) {
781 sound_set_speed(8000);
783 sound_set_format(AFMT_MU_LAW);
789 module_put(dmasound.mach.owner);
793 static void sq_reset_output(void)
795 sound_silence(); /* this _must_ stop DMA, we might be about to lose the buffers */
798 write_sq.rear_size = 0;
799 /* write_sq.front = (write_sq.rear+1) % write_sq.max_count;*/
801 write_sq.rear = -1 ; /* same as for set-up */
803 /* OK - we can unlock the parameters and fragment settings */
804 write_sq.locked = 0 ;
805 write_sq.user_frags = 0 ;
806 write_sq.user_frag_size = 0 ;
809 static void sq_reset(void)
812 /* we could consider resetting the shared_resources_owner here... but I
813 think it is probably still rather non-obvious to application writer
816 /* we release everything else though */
817 shared_resources_initialised = 0 ;
820 static int sq_fsync(struct file *filp, struct dentry *dentry)
825 write_sq.syncing |= 1;
826 sq_play(); /* there may be an incomplete frame waiting */
828 while (write_sq.active) {
829 SLEEP(write_sq.sync_queue);
830 if (signal_pending(current)) {
831 /* While waiting for audio output to drain, an
832 * interrupt occurred. Stop audio output immediately
833 * and clear the queue. */
839 printk(KERN_WARNING "dmasound: Timeout draining output\n");
846 /* flag no sync regardless of whether we had a DSP_POST or not */
847 write_sq.syncing = 0 ;
851 static int sq_release(struct inode *inode, struct file *file)
857 if (file->f_mode & FMODE_WRITE) {
859 rc = sq_fsync(file, file->f_path.dentry);
861 sq_reset_output() ; /* make sure dma is stopped and all is quiet */
862 write_sq_release_buffers();
866 if (file->f_mode & shared_resource_owner) { /* it's us that has them */
867 shared_resource_owner = 0 ;
868 shared_resources_initialised = 0 ;
869 dmasound.hard = dmasound.mach.default_hard ;
872 module_put(dmasound.mach.owner);
874 #if 0 /* blocking open() */
875 /* Wake up a process waiting for the queue being released.
876 * Note: There may be several processes waiting for a call
877 * to open() returning. */
879 /* Iain: hmm I don't understand this next comment ... */
880 /* There is probably a DOS atack here. They change the mode flag. */
881 /* XXX add check here,*/
882 read_sq_wake_up(file); /* checks f_mode */
883 write_sq_wake_up(file); /* checks f_mode */
884 #endif /* blocking open() */
891 /* here we see if we have a right to modify format, channels, size and so on
892 if no-one else has claimed it already then we do...
894 TODO: We might change this to mask O_RDWR such that only one or the other channel
895 is the owner - if we have problems.
898 static int shared_resources_are_mine(mode_t md)
900 if (shared_resource_owner)
901 return (shared_resource_owner & md ) ;
903 shared_resource_owner = md ;
908 /* if either queue is locked we must deny the right to change shared params
911 static int queues_are_quiescent(void)
918 /* check and set a queue's fragments per user's wishes...
919 we will check against the pre-defined literals and the actual sizes.
920 This is a bit fraught - because soft translations can mess with our
921 buffer requirements *after* this call - OSS says "call setfrags first"
924 /* It is possible to replace all the -EINVAL returns with an override that
925 just puts the allowable value in. This may be what many OSS apps require
928 static int set_queue_frags(struct sound_queue *sq, int bufs, int size)
931 #ifdef DEBUG_DMASOUND
932 printk("dmasound_core: tried to set_queue_frags on a locked queue\n") ;
937 if ((size < MIN_FRAG_SIZE) || (size > MAX_FRAG_SIZE))
939 size = (1<<size) ; /* now in bytes */
940 if (size > sq->bufSize)
941 return -EINVAL ; /* this might still not work */
945 if (bufs > sq->numBufs) /* the user is allowed say "don't care" with 0x7fff */
948 /* there is, currently, no way to specify max_active separately
949 from max_count. This could be a LL driver issue - I guess
950 if there is a requirement for these values to be different then
951 we will have to pass that info. up to this level.
954 sq->max_active = bufs ;
955 sq->user_frag_size = size ;
960 static int sq_ioctl(struct inode *inode, struct file *file, u_int cmd,
970 case SNDCTL_DSP_RESET:
974 case SNDCTL_DSP_GETFMTS:
975 fmt = dmasound.mach.hardware_afmts ; /* this is what OSS says.. */
976 return IOCTL_OUT(arg, fmt);
978 case SNDCTL_DSP_GETBLKSIZE:
979 /* this should tell the caller about bytes that the app can
980 read/write - the app doesn't care about our internal buffers.
981 We force sq_setup() here as per OSS 1.1 (which should
982 compute the values necessary).
983 Since there is no mechanism to specify read/write separately, for
984 fds opened O_RDWR, the write_sq values will, arbitrarily, overwrite
988 if (file->f_mode & FMODE_WRITE) {
989 if ( !write_sq.locked )
990 sq_setup(&write_sq) ;
991 size = write_sq.user_frag_size ;
993 return IOCTL_OUT(arg, size);
995 case SNDCTL_DSP_POST:
996 /* all we are going to do is to tell the LL that any
997 partial frags can be queued for output.
998 The LL will have to clear this flag when last output
1001 write_sq.syncing |= 0x2 ;
1004 case SNDCTL_DSP_SYNC:
1005 /* This call, effectively, has the same behaviour as SNDCTL_DSP_RESET
1006 except that it waits for output to finish before resetting
1007 everything - read, however, is killed imediately.
1010 if (file->f_mode & FMODE_WRITE) {
1011 result = sq_fsync(file, file->f_path.dentry);
1014 /* if we are the shared resource owner then release them */
1015 if (file->f_mode & shared_resource_owner)
1016 shared_resources_initialised = 0 ;
1019 case SOUND_PCM_READ_RATE:
1020 return IOCTL_OUT(arg, dmasound.soft.speed);
1021 case SNDCTL_DSP_SPEED:
1022 /* changing this on the fly will have weird effects on the sound.
1023 Where there are rate conversions implemented in soft form - it
1024 will cause the _ctx_xxx() functions to be substituted.
1025 However, there doesn't appear to be any reason to dis-allow it from
1028 if (shared_resources_are_mine(file->f_mode)) {
1029 IOCTL_IN(arg, data);
1030 data = sound_set_speed(data) ;
1031 shared_resources_initialised = 0 ;
1032 return IOCTL_OUT(arg, data);
1036 /* OSS says these next 4 actions are undefined when the device is
1037 busy/active - we will just return -EINVAL.
1038 To be allowed to change one - (a) you have to own the right
1039 (b) the queue(s) must be quiescent
1041 case SNDCTL_DSP_STEREO:
1042 if (shared_resources_are_mine(file->f_mode) &&
1043 queues_are_quiescent()) {
1044 IOCTL_IN(arg, data);
1045 shared_resources_initialised = 0 ;
1046 return IOCTL_OUT(arg, sound_set_stereo(data));
1050 case SOUND_PCM_WRITE_CHANNELS:
1051 if (shared_resources_are_mine(file->f_mode) &&
1052 queues_are_quiescent()) {
1053 IOCTL_IN(arg, data);
1054 /* the user might ask for 20 channels, we will return 1 or 2 */
1055 shared_resources_initialised = 0 ;
1056 return IOCTL_OUT(arg, sound_set_stereo(data-1)+1);
1060 case SNDCTL_DSP_SETFMT:
1061 if (shared_resources_are_mine(file->f_mode) &&
1062 queues_are_quiescent()) {
1064 IOCTL_IN(arg, data);
1065 shared_resources_initialised = 0 ;
1066 format = sound_set_format(data);
1067 result = IOCTL_OUT(arg, format);
1070 if (format != data && data != AFMT_QUERY)
1075 case SNDCTL_DSP_SUBDIVIDE:
1077 case SNDCTL_DSP_SETFRAGMENT:
1078 /* we can do this independently for the two queues - with the
1079 proviso that for fds opened O_RDWR we cannot separate the
1080 actions and both queues will be set per the last call.
1081 NOTE: this does *NOT* actually set the queue up - merely
1082 registers our intentions.
1084 IOCTL_IN(arg, data);
1086 nbufs = (data >> 16) & 0x7fff ; /* 0x7fff is 'use maximum' */
1087 size = data & 0xffff;
1088 if (file->f_mode & FMODE_WRITE) {
1089 result = set_queue_frags(&write_sq, nbufs, size) ;
1093 /* NOTE: this return value is irrelevant - OSS specifically says that
1094 the value is 'random' and that the user _must_ check the actual
1095 frags values using SNDCTL_DSP_GETBLKSIZE or similar */
1096 return IOCTL_OUT(arg, data);
1098 case SNDCTL_DSP_GETOSPACE:
1101 if (file->f_mode & FMODE_WRITE) {
1102 if ( !write_sq.locked )
1103 sq_setup(&write_sq) ;
1104 info.fragments = write_sq.max_active - write_sq.count;
1105 info.fragstotal = write_sq.max_active;
1106 info.fragsize = write_sq.user_frag_size;
1107 info.bytes = info.fragments * info.fragsize;
1108 if (copy_to_user((void __user *)arg, &info, sizeof(info)))
1114 case SNDCTL_DSP_GETCAPS:
1115 val = dmasound.mach.capabilities & 0xffffff00;
1116 return IOCTL_OUT(arg,val);
1119 return mixer_ioctl(inode, file, cmd, arg);
1124 static const struct file_operations sq_fops =
1126 .owner = THIS_MODULE,
1127 .llseek = no_llseek,
1132 .release = sq_release,
1135 static int sq_init(void)
1137 const struct file_operations *fops = &sq_fops;
1142 sq_unit = register_sound_dsp(fops, -1);
1144 printk(KERN_ERR "dmasound_core: couldn't register fops\n") ;
1148 write_sq_init_waitqueue();
1150 /* These parameters will be restored for every clean open()
1151 * in the case of multiple open()s (e.g. dsp0 & dsp1) they
1152 * will be set so long as the shared resources have no owner.
1155 if (shared_resource_owner == 0) {
1156 dmasound.soft = dmasound.mach.default_soft ;
1157 dmasound.hard = dmasound.mach.default_hard ;
1158 dmasound.dsp = dmasound.mach.default_soft ;
1159 shared_resources_initialised = 0 ;
1169 /* we allow more space for record-enabled because there are extra output lines.
1170 the number here must include the amount we are prepared to give to the low-level
1174 #define STAT_BUFF_LEN 768
1176 /* this is how much space we will allow the low-level driver to use
1177 in the stat buffer. Currently, 2 * (80 character line + <NL>).
1178 We do not police this (it is up to the ll driver to be honest).
1181 #define LOW_LEVEL_STAT_ALLOC 162
1185 char buf[STAT_BUFF_LEN]; /* state.buf should not overflow! */
1189 /* publish this function for use by low-level code, if required */
1191 char *get_afmt_string(int afmt)
1201 return "unsigned 8 bit";
1204 return "signed 8 bit";
1207 return "signed 16 bit BE";
1210 return "unsigned 16 bit BE";
1213 return "signed 16 bit LE";
1216 return "unsigned 16 bit LE";
1219 return "format not set" ;
1224 return "ERROR: Unsupported AFMT_XXXX code" ;
1227 static int state_open(struct inode *inode, struct file *file)
1229 char *buffer = state.buf;
1235 if (!try_module_get(dmasound.mach.owner))
1240 len += sprintf(buffer+len, "%sDMA sound driver rev %03d :\n",
1241 dmasound.mach.name, (DMASOUND_CORE_REVISION<<4) +
1242 ((dmasound.mach.version>>8) & 0x0f));
1243 len += sprintf(buffer+len,
1244 "Core driver edition %02d.%02d : %s driver edition %02d.%02d\n",
1245 DMASOUND_CORE_REVISION, DMASOUND_CORE_EDITION, dmasound.mach.name2,
1246 (dmasound.mach.version >> 8), (dmasound.mach.version & 0xff)) ;
1248 /* call the low-level module to fill in any stat info. that it has
1249 if present. Maximum buffer usage is specified.
1252 if (dmasound.mach.state_info)
1253 len += dmasound.mach.state_info(buffer+len,
1254 (size_t) LOW_LEVEL_STAT_ALLOC) ;
1256 /* make usage of the state buffer as deterministic as poss.
1257 exceptional conditions could cause overrun - and this is flagged as
1261 /* formats and settings */
1263 len += sprintf(buffer+len,"\t\t === Formats & settings ===\n") ;
1264 len += sprintf(buffer+len,"Parameter %20s%20s\n","soft","hard") ;
1265 len += sprintf(buffer+len,"Format :%20s%20s\n",
1266 get_afmt_string(dmasound.soft.format),
1267 get_afmt_string(dmasound.hard.format));
1269 len += sprintf(buffer+len,"Samp Rate:%14d s/sec%14d s/sec\n",
1270 dmasound.soft.speed, dmasound.hard.speed);
1272 len += sprintf(buffer+len,"Channels :%20s%20s\n",
1273 dmasound.soft.stereo ? "stereo" : "mono",
1274 dmasound.hard.stereo ? "stereo" : "mono" );
1276 /* sound queue status */
1278 len += sprintf(buffer+len,"\t\t === Sound Queue status ===\n");
1279 len += sprintf(buffer+len,"Allocated:%8s%6s\n","Buffers","Size") ;
1280 len += sprintf(buffer+len,"%9s:%8d%6d\n",
1281 "write", write_sq.numBufs, write_sq.bufSize) ;
1282 len += sprintf(buffer+len,
1283 "Current : MaxFrg FragSiz MaxAct Frnt Rear "
1284 "Cnt RrSize A B S L xruns\n") ;
1285 len += sprintf(buffer+len,"%9s:%7d%8d%7d%5d%5d%4d%7d%2d%2d%2d%2d%7d\n",
1286 "write", write_sq.max_count, write_sq.block_size,
1287 write_sq.max_active, write_sq.front, write_sq.rear,
1288 write_sq.count, write_sq.rear_size, write_sq.active,
1289 write_sq.busy, write_sq.syncing, write_sq.locked, write_sq.xruns) ;
1290 #ifdef DEBUG_DMASOUND
1291 printk("dmasound: stat buffer used %d bytes\n", len) ;
1294 if (len >= STAT_BUFF_LEN)
1295 printk(KERN_ERR "dmasound_core: stat buffer overflowed!\n");
1301 static int state_release(struct inode *inode, struct file *file)
1305 module_put(dmasound.mach.owner);
1310 static ssize_t state_read(struct file *file, char __user *buf, size_t count,
1313 int n = state.len - state.ptr;
1318 if (copy_to_user(buf, &state.buf[state.ptr], n))
1324 static const struct file_operations state_fops = {
1325 .owner = THIS_MODULE,
1326 .llseek = no_llseek,
1329 .release = state_release,
1332 static int state_init(void)
1337 state_unit = register_sound_special(&state_fops, SND_DEV_STATUS);
1348 * This function is called by _one_ chipset-specific driver
1351 int dmasound_init(void)
1359 /* Set up sound queue, /dev/audio and /dev/dsp. */
1361 /* Set default settings. */
1362 if ((res = sq_init()) < 0)
1365 /* Set up /dev/sndstat. */
1366 if ((res = state_init()) < 0)
1369 /* Set up /dev/mixer. */
1372 if (!dmasound.mach.irqinit()) {
1373 printk(KERN_ERR "DMA sound driver: Interrupt initialization failed\n");
1380 printk(KERN_INFO "%s DMA sound driver rev %03d installed\n",
1381 dmasound.mach.name, (DMASOUND_CORE_REVISION<<4) +
1382 ((dmasound.mach.version>>8) & 0x0f));
1384 "Core driver edition %02d.%02d : %s driver edition %02d.%02d\n",
1385 DMASOUND_CORE_REVISION, DMASOUND_CORE_EDITION, dmasound.mach.name2,
1386 (dmasound.mach.version >> 8), (dmasound.mach.version & 0xff)) ;
1387 printk(KERN_INFO "Write will use %4d fragments of %7d bytes as default\n",
1388 numWriteBufs, writeBufSize) ;
1394 void dmasound_deinit(void)
1396 if (irq_installed) {
1398 dmasound.mach.irqcleanup();
1402 write_sq_release_buffers();
1404 if (mixer_unit >= 0)
1405 unregister_sound_mixer(mixer_unit);
1406 if (state_unit >= 0)
1407 unregister_sound_special(state_unit);
1409 unregister_sound_dsp(sq_unit);
1414 static int dmasound_setup(char *str)
1418 str = get_options(str, ARRAY_SIZE(ints), ints);
1420 /* check the bootstrap parameter for "dmasound=" */
1422 /* FIXME: other than in the most naive of cases there is no sense in these
1423 * buffers being other than powers of two. This is not checked yet.
1428 if ((ints[3] < 0) || (ints[3] > MAX_CATCH_RADIUS))
1429 printk("dmasound_setup: invalid catch radius, using default = %d\n", catchRadius);
1431 catchRadius = ints[3];
1434 if (ints[1] < MIN_BUFFERS)
1435 printk("dmasound_setup: invalid number of buffers, using default = %d\n", numWriteBufs);
1437 numWriteBufs = ints[1];
1440 if ((size = ints[2]) < 256) /* check for small buffer specs */
1442 if (size < MIN_BUFSIZE || size > MAX_BUFSIZE)
1443 printk("dmasound_setup: invalid write buffer size, using default = %d\n", writeBufSize);
1445 writeBufSize = size;
1449 printk("dmasound_setup: invalid number of arguments\n");
1455 __setup("dmasound=", dmasound_setup);
1457 #endif /* !MODULE */
1463 #ifdef HAS_8BIT_TABLES
1466 char dmasound_ulaw2dma8[] = {
1467 -126, -122, -118, -114, -110, -106, -102, -98,
1468 -94, -90, -86, -82, -78, -74, -70, -66,
1469 -63, -61, -59, -57, -55, -53, -51, -49,
1470 -47, -45, -43, -41, -39, -37, -35, -33,
1471 -31, -30, -29, -28, -27, -26, -25, -24,
1472 -23, -22, -21, -20, -19, -18, -17, -16,
1473 -16, -15, -15, -14, -14, -13, -13, -12,
1474 -12, -11, -11, -10, -10, -9, -9, -8,
1475 -8, -8, -7, -7, -7, -7, -6, -6,
1476 -6, -6, -5, -5, -5, -5, -4, -4,
1477 -4, -4, -4, -4, -3, -3, -3, -3,
1478 -3, -3, -3, -3, -2, -2, -2, -2,
1479 -2, -2, -2, -2, -2, -2, -2, -2,
1480 -1, -1, -1, -1, -1, -1, -1, -1,
1481 -1, -1, -1, -1, -1, -1, -1, -1,
1482 -1, -1, -1, -1, -1, -1, -1, 0,
1483 125, 121, 117, 113, 109, 105, 101, 97,
1484 93, 89, 85, 81, 77, 73, 69, 65,
1485 62, 60, 58, 56, 54, 52, 50, 48,
1486 46, 44, 42, 40, 38, 36, 34, 32,
1487 30, 29, 28, 27, 26, 25, 24, 23,
1488 22, 21, 20, 19, 18, 17, 16, 15,
1489 15, 14, 14, 13, 13, 12, 12, 11,
1490 11, 10, 10, 9, 9, 8, 8, 7,
1491 7, 7, 6, 6, 6, 6, 5, 5,
1492 5, 5, 4, 4, 4, 4, 3, 3,
1493 3, 3, 3, 3, 2, 2, 2, 2,
1494 2, 2, 2, 2, 1, 1, 1, 1,
1495 1, 1, 1, 1, 1, 1, 1, 1,
1496 0, 0, 0, 0, 0, 0, 0, 0,
1497 0, 0, 0, 0, 0, 0, 0, 0,
1498 0, 0, 0, 0, 0, 0, 0, 0
1503 char dmasound_alaw2dma8[] = {
1504 -22, -21, -24, -23, -18, -17, -20, -19,
1505 -30, -29, -32, -31, -26, -25, -28, -27,
1506 -11, -11, -12, -12, -9, -9, -10, -10,
1507 -15, -15, -16, -16, -13, -13, -14, -14,
1508 -86, -82, -94, -90, -70, -66, -78, -74,
1509 -118, -114, -126, -122, -102, -98, -110, -106,
1510 -43, -41, -47, -45, -35, -33, -39, -37,
1511 -59, -57, -63, -61, -51, -49, -55, -53,
1512 -2, -2, -2, -2, -2, -2, -2, -2,
1513 -2, -2, -2, -2, -2, -2, -2, -2,
1514 -1, -1, -1, -1, -1, -1, -1, -1,
1515 -1, -1, -1, -1, -1, -1, -1, -1,
1516 -6, -6, -6, -6, -5, -5, -5, -5,
1517 -8, -8, -8, -8, -7, -7, -7, -7,
1518 -3, -3, -3, -3, -3, -3, -3, -3,
1519 -4, -4, -4, -4, -4, -4, -4, -4,
1520 21, 20, 23, 22, 17, 16, 19, 18,
1521 29, 28, 31, 30, 25, 24, 27, 26,
1522 10, 10, 11, 11, 8, 8, 9, 9,
1523 14, 14, 15, 15, 12, 12, 13, 13,
1524 86, 82, 94, 90, 70, 66, 78, 74,
1525 118, 114, 126, 122, 102, 98, 110, 106,
1526 43, 41, 47, 45, 35, 33, 39, 37,
1527 59, 57, 63, 61, 51, 49, 55, 53,
1528 1, 1, 1, 1, 1, 1, 1, 1,
1529 1, 1, 1, 1, 1, 1, 1, 1,
1530 0, 0, 0, 0, 0, 0, 0, 0,
1531 0, 0, 0, 0, 0, 0, 0, 0,
1532 5, 5, 5, 5, 4, 4, 4, 4,
1533 7, 7, 7, 7, 6, 6, 6, 6,
1534 2, 2, 2, 2, 2, 2, 2, 2,
1535 3, 3, 3, 3, 3, 3, 3, 3
1537 #endif /* HAS_8BIT_TABLES */
1540 * Visible symbols for modules
1543 EXPORT_SYMBOL(dmasound);
1544 EXPORT_SYMBOL(dmasound_init);
1546 EXPORT_SYMBOL(dmasound_deinit);
1548 EXPORT_SYMBOL(dmasound_write_sq);
1549 EXPORT_SYMBOL(dmasound_catchRadius);
1550 #ifdef HAS_8BIT_TABLES
1551 EXPORT_SYMBOL(dmasound_ulaw2dma8);
1552 EXPORT_SYMBOL(dmasound_alaw2dma8);
1554 EXPORT_SYMBOL(get_afmt_string) ;