2 * Copyright (c) by Jaroslav Kysela <perex@suse.cz>
3 * Routines for control of MPU-401 in UART mode
5 * MPU-401 supports UART mode which is not capable generate transmit
6 * interrupts thus output is done via polling. Also, if irq < 0, then
7 * input is done also via polling. Do not expect good performance.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 * Added support for different kind of hardware I/O. Build in choices
26 * are port and mmio. For other kind of I/O, set mpu->read and
27 * mpu->write to your own I/O functions.
31 #include <sound/driver.h>
33 #include <linux/delay.h>
34 #include <linux/init.h>
35 #include <linux/slab.h>
36 #include <linux/ioport.h>
37 #include <linux/interrupt.h>
38 #include <linux/errno.h>
39 #include <sound/core.h>
40 #include <sound/mpu401.h>
42 MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>");
43 MODULE_DESCRIPTION("Routines for control of MPU-401 in UART mode");
44 MODULE_LICENSE("GPL");
46 static void snd_mpu401_uart_input_read(struct snd_mpu401
* mpu
);
47 static void snd_mpu401_uart_output_write(struct snd_mpu401
* mpu
);
53 #define snd_mpu401_input_avail(mpu) (!(mpu->read(mpu, MPU401C(mpu)) & 0x80))
54 #define snd_mpu401_output_ready(mpu) (!(mpu->read(mpu, MPU401C(mpu)) & 0x40))
56 #define MPU401_RESET 0xff
57 #define MPU401_ENTER_UART 0x3f
58 #define MPU401_ACK 0xfe
60 /* Build in lowlevel io */
61 static void mpu401_write_port(struct snd_mpu401
*mpu
, unsigned char data
,
67 static unsigned char mpu401_read_port(struct snd_mpu401
*mpu
,
73 static void mpu401_write_mmio(struct snd_mpu401
*mpu
, unsigned char data
,
76 writeb(data
, (void __iomem
*)addr
);
79 static unsigned char mpu401_read_mmio(struct snd_mpu401
*mpu
,
82 return readb((void __iomem
*)addr
);
86 static void snd_mpu401_uart_clear_rx(struct snd_mpu401
*mpu
)
89 for (; timeout
> 0 && snd_mpu401_input_avail(mpu
); timeout
--)
90 mpu
->read(mpu
, MPU401D(mpu
));
91 #ifdef CONFIG_SND_DEBUG
93 snd_printk(KERN_ERR
"cmd: clear rx timeout (status = 0x%x)\n",
94 mpu
->read(mpu
, MPU401C(mpu
)));
98 static void uart_interrupt_tx(struct snd_mpu401
*mpu
)
100 if (test_bit(MPU401_MODE_BIT_OUTPUT
, &mpu
->mode
) &&
101 test_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER
, &mpu
->mode
)) {
102 spin_lock(&mpu
->output_lock
);
103 snd_mpu401_uart_output_write(mpu
);
104 spin_unlock(&mpu
->output_lock
);
108 static void _snd_mpu401_uart_interrupt(struct snd_mpu401
*mpu
)
110 if (mpu
->info_flags
& MPU401_INFO_INPUT
) {
111 spin_lock(&mpu
->input_lock
);
112 if (test_bit(MPU401_MODE_BIT_INPUT
, &mpu
->mode
))
113 snd_mpu401_uart_input_read(mpu
);
115 snd_mpu401_uart_clear_rx(mpu
);
116 spin_unlock(&mpu
->input_lock
);
118 if (! (mpu
->info_flags
& MPU401_INFO_TX_IRQ
))
119 /* ok. for better Tx performance try do some output
120 when input is done */
121 uart_interrupt_tx(mpu
);
125 * snd_mpu401_uart_interrupt - generic MPU401-UART interrupt handler
126 * @irq: the irq number
127 * @dev_id: mpu401 instance
129 * Processes the interrupt for MPU401-UART i/o.
131 irqreturn_t
snd_mpu401_uart_interrupt(int irq
, void *dev_id
)
133 struct snd_mpu401
*mpu
= dev_id
;
137 _snd_mpu401_uart_interrupt(mpu
);
141 EXPORT_SYMBOL(snd_mpu401_uart_interrupt
);
144 * snd_mpu401_uart_interrupt_tx - generic MPU401-UART transmit irq handler
145 * @irq: the irq number
146 * @dev_id: mpu401 instance
148 * Processes the interrupt for MPU401-UART output.
150 irqreturn_t
snd_mpu401_uart_interrupt_tx(int irq
, void *dev_id
)
152 struct snd_mpu401
*mpu
= dev_id
;
156 uart_interrupt_tx(mpu
);
160 EXPORT_SYMBOL(snd_mpu401_uart_interrupt_tx
);
164 * reprogram the timer and call the interrupt job
166 static void snd_mpu401_uart_timer(unsigned long data
)
168 struct snd_mpu401
*mpu
= (struct snd_mpu401
*)data
;
171 spin_lock_irqsave(&mpu
->timer_lock
, flags
);
172 /*mpu->mode |= MPU401_MODE_TIMER;*/
173 mpu
->timer
.expires
= 1 + jiffies
;
174 add_timer(&mpu
->timer
);
175 spin_unlock_irqrestore(&mpu
->timer_lock
, flags
);
177 _snd_mpu401_uart_interrupt(mpu
);
181 * initialize the timer callback if not programmed yet
183 static void snd_mpu401_uart_add_timer (struct snd_mpu401
*mpu
, int input
)
187 spin_lock_irqsave (&mpu
->timer_lock
, flags
);
188 if (mpu
->timer_invoked
== 0) {
189 init_timer(&mpu
->timer
);
190 mpu
->timer
.data
= (unsigned long)mpu
;
191 mpu
->timer
.function
= snd_mpu401_uart_timer
;
192 mpu
->timer
.expires
= 1 + jiffies
;
193 add_timer(&mpu
->timer
);
195 mpu
->timer_invoked
|= input
? MPU401_MODE_INPUT_TIMER
:
196 MPU401_MODE_OUTPUT_TIMER
;
197 spin_unlock_irqrestore (&mpu
->timer_lock
, flags
);
201 * remove the timer callback if still active
203 static void snd_mpu401_uart_remove_timer (struct snd_mpu401
*mpu
, int input
)
207 spin_lock_irqsave (&mpu
->timer_lock
, flags
);
208 if (mpu
->timer_invoked
) {
209 mpu
->timer_invoked
&= input
? ~MPU401_MODE_INPUT_TIMER
:
210 ~MPU401_MODE_OUTPUT_TIMER
;
211 if (! mpu
->timer_invoked
)
212 del_timer(&mpu
->timer
);
214 spin_unlock_irqrestore (&mpu
->timer_lock
, flags
);
218 * send a UART command
219 * return zero if successful, non-zero for some errors
222 static int snd_mpu401_uart_cmd(struct snd_mpu401
* mpu
, unsigned char cmd
,
228 spin_lock_irqsave(&mpu
->input_lock
, flags
);
229 if (mpu
->hardware
!= MPU401_HW_TRID4DWAVE
) {
230 mpu
->write(mpu
, 0x00, MPU401D(mpu
));
231 /*snd_mpu401_uart_clear_rx(mpu);*/
233 /* ok. standard MPU-401 initialization */
234 if (mpu
->hardware
!= MPU401_HW_SB
) {
235 for (timeout
= 1000; timeout
> 0 &&
236 !snd_mpu401_output_ready(mpu
); timeout
--)
238 #ifdef CONFIG_SND_DEBUG
240 snd_printk(KERN_ERR
"cmd: tx timeout (status = 0x%x)\n",
241 mpu
->read(mpu
, MPU401C(mpu
)));
244 mpu
->write(mpu
, cmd
, MPU401C(mpu
));
248 while (!ok
&& timeout
-- > 0) {
249 if (snd_mpu401_input_avail(mpu
)) {
250 if (mpu
->read(mpu
, MPU401D(mpu
)) == MPU401_ACK
)
254 if (!ok
&& mpu
->read(mpu
, MPU401D(mpu
)) == MPU401_ACK
)
258 spin_unlock_irqrestore(&mpu
->input_lock
, flags
);
260 snd_printk(KERN_ERR
"cmd: 0x%x failed at 0x%lx "
261 "(status = 0x%x, data = 0x%x)\n", cmd
, mpu
->port
,
262 mpu
->read(mpu
, MPU401C(mpu
)),
263 mpu
->read(mpu
, MPU401D(mpu
)));
269 static int snd_mpu401_do_reset(struct snd_mpu401
*mpu
)
271 if (snd_mpu401_uart_cmd(mpu
, MPU401_RESET
, 1))
273 if (!(mpu
->info_flags
& MPU401_INFO_UART_ONLY
) &&
274 snd_mpu401_uart_cmd(mpu
, MPU401_ENTER_UART
, 1))
280 * input/output open/close - protected by open_mutex in rawmidi.c
282 static int snd_mpu401_uart_input_open(struct snd_rawmidi_substream
*substream
)
284 struct snd_mpu401
*mpu
;
287 mpu
= substream
->rmidi
->private_data
;
288 if (mpu
->open_input
&& (err
= mpu
->open_input(mpu
)) < 0)
290 if (! test_bit(MPU401_MODE_BIT_OUTPUT
, &mpu
->mode
)) {
291 if (snd_mpu401_do_reset(mpu
) < 0)
294 mpu
->substream_input
= substream
;
295 set_bit(MPU401_MODE_BIT_INPUT
, &mpu
->mode
);
299 if (mpu
->open_input
&& mpu
->close_input
)
300 mpu
->close_input(mpu
);
304 static int snd_mpu401_uart_output_open(struct snd_rawmidi_substream
*substream
)
306 struct snd_mpu401
*mpu
;
309 mpu
= substream
->rmidi
->private_data
;
310 if (mpu
->open_output
&& (err
= mpu
->open_output(mpu
)) < 0)
312 if (! test_bit(MPU401_MODE_BIT_INPUT
, &mpu
->mode
)) {
313 if (snd_mpu401_do_reset(mpu
) < 0)
316 mpu
->substream_output
= substream
;
317 set_bit(MPU401_MODE_BIT_OUTPUT
, &mpu
->mode
);
321 if (mpu
->open_output
&& mpu
->close_output
)
322 mpu
->close_output(mpu
);
326 static int snd_mpu401_uart_input_close(struct snd_rawmidi_substream
*substream
)
328 struct snd_mpu401
*mpu
;
331 mpu
= substream
->rmidi
->private_data
;
332 clear_bit(MPU401_MODE_BIT_INPUT
, &mpu
->mode
);
333 mpu
->substream_input
= NULL
;
334 if (! test_bit(MPU401_MODE_BIT_OUTPUT
, &mpu
->mode
))
335 err
= snd_mpu401_uart_cmd(mpu
, MPU401_RESET
, 0);
336 if (mpu
->close_input
)
337 mpu
->close_input(mpu
);
343 static int snd_mpu401_uart_output_close(struct snd_rawmidi_substream
*substream
)
345 struct snd_mpu401
*mpu
;
348 mpu
= substream
->rmidi
->private_data
;
349 clear_bit(MPU401_MODE_BIT_OUTPUT
, &mpu
->mode
);
350 mpu
->substream_output
= NULL
;
351 if (! test_bit(MPU401_MODE_BIT_INPUT
, &mpu
->mode
))
352 err
= snd_mpu401_uart_cmd(mpu
, MPU401_RESET
, 0);
353 if (mpu
->close_output
)
354 mpu
->close_output(mpu
);
361 * trigger input callback
364 snd_mpu401_uart_input_trigger(struct snd_rawmidi_substream
*substream
, int up
)
367 struct snd_mpu401
*mpu
;
370 mpu
= substream
->rmidi
->private_data
;
372 if (! test_and_set_bit(MPU401_MODE_BIT_INPUT_TRIGGER
,
374 /* first time - flush FIFO */
376 mpu
->read(mpu
, MPU401D(mpu
));
378 snd_mpu401_uart_add_timer(mpu
, 1);
381 /* read data in advance */
382 spin_lock_irqsave(&mpu
->input_lock
, flags
);
383 snd_mpu401_uart_input_read(mpu
);
384 spin_unlock_irqrestore(&mpu
->input_lock
, flags
);
387 snd_mpu401_uart_remove_timer(mpu
, 1);
388 clear_bit(MPU401_MODE_BIT_INPUT_TRIGGER
, &mpu
->mode
);
394 * transfer input pending data
395 * call with input_lock spinlock held
397 static void snd_mpu401_uart_input_read(struct snd_mpu401
* mpu
)
403 if (! snd_mpu401_input_avail(mpu
))
404 break; /* input not available */
405 byte
= mpu
->read(mpu
, MPU401D(mpu
));
406 if (test_bit(MPU401_MODE_BIT_INPUT_TRIGGER
, &mpu
->mode
))
407 snd_rawmidi_receive(mpu
->substream_input
, &byte
, 1);
414 * AudioDrive ES1688 - 12 bytes
415 * S3 SonicVibes - 8 bytes
416 * SoundBlaster AWE 64 - 2 bytes (ugly hardware)
420 * write output pending bytes
421 * call with output_lock spinlock held
423 static void snd_mpu401_uart_output_write(struct snd_mpu401
* mpu
)
426 int max
= 256, timeout
;
429 if (snd_rawmidi_transmit_peek(mpu
->substream_output
,
431 for (timeout
= 100; timeout
> 0; timeout
--) {
432 if (snd_mpu401_output_ready(mpu
))
436 break; /* Tx FIFO full - try again later */
437 mpu
->write(mpu
, byte
, MPU401D(mpu
));
438 snd_rawmidi_transmit_ack(mpu
->substream_output
, 1);
440 snd_mpu401_uart_remove_timer (mpu
, 0);
441 break; /* no other data - leave the tx loop */
447 * output trigger callback
450 snd_mpu401_uart_output_trigger(struct snd_rawmidi_substream
*substream
, int up
)
453 struct snd_mpu401
*mpu
;
455 mpu
= substream
->rmidi
->private_data
;
457 set_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER
, &mpu
->mode
);
459 /* try to add the timer at each output trigger,
460 * since the output timer might have been removed in
461 * snd_mpu401_uart_output_write().
463 if (! (mpu
->info_flags
& MPU401_INFO_TX_IRQ
))
464 snd_mpu401_uart_add_timer(mpu
, 0);
466 /* output pending data */
467 spin_lock_irqsave(&mpu
->output_lock
, flags
);
468 snd_mpu401_uart_output_write(mpu
);
469 spin_unlock_irqrestore(&mpu
->output_lock
, flags
);
471 if (! (mpu
->info_flags
& MPU401_INFO_TX_IRQ
))
472 snd_mpu401_uart_remove_timer(mpu
, 0);
473 clear_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER
, &mpu
->mode
);
481 static struct snd_rawmidi_ops snd_mpu401_uart_output
=
483 .open
= snd_mpu401_uart_output_open
,
484 .close
= snd_mpu401_uart_output_close
,
485 .trigger
= snd_mpu401_uart_output_trigger
,
488 static struct snd_rawmidi_ops snd_mpu401_uart_input
=
490 .open
= snd_mpu401_uart_input_open
,
491 .close
= snd_mpu401_uart_input_close
,
492 .trigger
= snd_mpu401_uart_input_trigger
,
495 static void snd_mpu401_uart_free(struct snd_rawmidi
*rmidi
)
497 struct snd_mpu401
*mpu
= rmidi
->private_data
;
498 if (mpu
->irq_flags
&& mpu
->irq
>= 0)
499 free_irq(mpu
->irq
, (void *) mpu
);
500 release_and_free_resource(mpu
->res
);
505 * snd_mpu401_uart_new - create an MPU401-UART instance
506 * @card: the card instance
507 * @device: the device index, zero-based
508 * @hardware: the hardware type, MPU401_HW_XXXX
509 * @port: the base address of MPU401 port
510 * @info_flags: bitflags MPU401_INFO_XXX
511 * @irq: the irq number, -1 if no interrupt for mpu
512 * @irq_flags: the irq request flags (SA_XXX), 0 if irq was already reserved.
513 * @rrawmidi: the pointer to store the new rawmidi instance
515 * Creates a new MPU-401 instance.
517 * Note that the rawmidi instance is returned on the rrawmidi argument,
518 * not the mpu401 instance itself. To access to the mpu401 instance,
519 * cast from rawmidi->private_data (with struct snd_mpu401 magic-cast).
521 * Returns zero if successful, or a negative error code.
523 int snd_mpu401_uart_new(struct snd_card
*card
, int device
,
524 unsigned short hardware
,
526 unsigned int info_flags
,
527 int irq
, int irq_flags
,
528 struct snd_rawmidi
** rrawmidi
)
530 struct snd_mpu401
*mpu
;
531 struct snd_rawmidi
*rmidi
;
532 int in_enable
, out_enable
;
537 if (! (info_flags
& (MPU401_INFO_INPUT
| MPU401_INFO_OUTPUT
)))
538 info_flags
|= MPU401_INFO_INPUT
| MPU401_INFO_OUTPUT
;
539 in_enable
= (info_flags
& MPU401_INFO_INPUT
) ? 1 : 0;
540 out_enable
= (info_flags
& MPU401_INFO_OUTPUT
) ? 1 : 0;
541 if ((err
= snd_rawmidi_new(card
, "MPU-401U", device
,
542 out_enable
, in_enable
, &rmidi
)) < 0)
544 mpu
= kzalloc(sizeof(*mpu
), GFP_KERNEL
);
546 snd_printk(KERN_ERR
"mpu401_uart: cannot allocate\n");
547 snd_device_free(card
, rmidi
);
550 rmidi
->private_data
= mpu
;
551 rmidi
->private_free
= snd_mpu401_uart_free
;
552 spin_lock_init(&mpu
->input_lock
);
553 spin_lock_init(&mpu
->output_lock
);
554 spin_lock_init(&mpu
->timer_lock
);
555 mpu
->hardware
= hardware
;
556 if (! (info_flags
& MPU401_INFO_INTEGRATED
)) {
557 int res_size
= hardware
== MPU401_HW_PC98II
? 4 : 2;
558 mpu
->res
= request_region(port
, res_size
, "MPU401 UART");
559 if (mpu
->res
== NULL
) {
560 snd_printk(KERN_ERR
"mpu401_uart: "
561 "unable to grab port 0x%lx size %d\n",
563 snd_device_free(card
, rmidi
);
567 if (info_flags
& MPU401_INFO_MMIO
) {
568 mpu
->write
= mpu401_write_mmio
;
569 mpu
->read
= mpu401_read_mmio
;
571 mpu
->write
= mpu401_write_port
;
572 mpu
->read
= mpu401_read_port
;
575 if (hardware
== MPU401_HW_PC98II
)
576 mpu
->cport
= port
+ 2;
578 mpu
->cport
= port
+ 1;
579 if (irq
>= 0 && irq_flags
) {
580 if (request_irq(irq
, snd_mpu401_uart_interrupt
, irq_flags
,
581 "MPU401 UART", (void *) mpu
)) {
582 snd_printk(KERN_ERR
"mpu401_uart: "
583 "unable to grab IRQ %d\n", irq
);
584 snd_device_free(card
, rmidi
);
588 mpu
->info_flags
= info_flags
;
590 mpu
->irq_flags
= irq_flags
;
591 if (card
->shortname
[0])
592 snprintf(rmidi
->name
, sizeof(rmidi
->name
), "%s MIDI",
595 sprintf(rmidi
->name
, "MPU-401 MIDI %d-%d",card
->number
, device
);
597 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
,
598 &snd_mpu401_uart_output
);
599 rmidi
->info_flags
|= SNDRV_RAWMIDI_INFO_OUTPUT
;
602 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_INPUT
,
603 &snd_mpu401_uart_input
);
604 rmidi
->info_flags
|= SNDRV_RAWMIDI_INFO_INPUT
;
606 rmidi
->info_flags
|= SNDRV_RAWMIDI_INFO_DUPLEX
;
614 EXPORT_SYMBOL(snd_mpu401_uart_new
);
620 static int __init
alsa_mpu401_uart_init(void)
625 static void __exit
alsa_mpu401_uart_exit(void)
629 module_init(alsa_mpu401_uart_init
)
630 module_exit(alsa_mpu401_uart_exit
)