2 * Copyright (c) by Jaroslav Kysela <perex@perex.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.
32 #include <linux/delay.h>
33 #include <linux/init.h>
34 #include <linux/slab.h>
35 #include <linux/ioport.h>
36 #include <linux/interrupt.h>
37 #include <linux/errno.h>
38 #include <sound/core.h>
39 #include <sound/mpu401.h>
41 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
42 MODULE_DESCRIPTION("Routines for control of MPU-401 in UART mode");
43 MODULE_LICENSE("GPL");
45 static void snd_mpu401_uart_input_read(struct snd_mpu401
* mpu
);
46 static void snd_mpu401_uart_output_write(struct snd_mpu401
* mpu
);
52 #define snd_mpu401_input_avail(mpu) \
53 (!(mpu->read(mpu, MPU401C(mpu)) & MPU401_RX_EMPTY))
54 #define snd_mpu401_output_ready(mpu) \
55 (!(mpu->read(mpu, MPU401C(mpu)) & MPU401_TX_FULL))
57 /* Build in lowlevel io */
58 static void mpu401_write_port(struct snd_mpu401
*mpu
, unsigned char data
,
64 static unsigned char mpu401_read_port(struct snd_mpu401
*mpu
,
70 static void mpu401_write_mmio(struct snd_mpu401
*mpu
, unsigned char data
,
73 writeb(data
, (void __iomem
*)addr
);
76 static unsigned char mpu401_read_mmio(struct snd_mpu401
*mpu
,
79 return readb((void __iomem
*)addr
);
83 static void snd_mpu401_uart_clear_rx(struct snd_mpu401
*mpu
)
86 for (; timeout
> 0 && snd_mpu401_input_avail(mpu
); timeout
--)
87 mpu
->read(mpu
, MPU401D(mpu
));
88 #ifdef CONFIG_SND_DEBUG
90 snd_printk(KERN_ERR
"cmd: clear rx timeout (status = 0x%x)\n",
91 mpu
->read(mpu
, MPU401C(mpu
)));
95 static void uart_interrupt_tx(struct snd_mpu401
*mpu
)
99 if (test_bit(MPU401_MODE_BIT_OUTPUT
, &mpu
->mode
) &&
100 test_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER
, &mpu
->mode
)) {
101 spin_lock_irqsave(&mpu
->output_lock
, flags
);
102 snd_mpu401_uart_output_write(mpu
);
103 spin_unlock_irqrestore(&mpu
->output_lock
, flags
);
107 static void _snd_mpu401_uart_interrupt(struct snd_mpu401
*mpu
)
111 if (mpu
->info_flags
& MPU401_INFO_INPUT
) {
112 spin_lock_irqsave(&mpu
->input_lock
, flags
);
113 if (test_bit(MPU401_MODE_BIT_INPUT
, &mpu
->mode
))
114 snd_mpu401_uart_input_read(mpu
);
116 snd_mpu401_uart_clear_rx(mpu
);
117 spin_unlock_irqrestore(&mpu
->input_lock
, flags
);
119 if (! (mpu
->info_flags
& MPU401_INFO_TX_IRQ
))
120 /* ok. for better Tx performance try do some output
121 when input is done */
122 uart_interrupt_tx(mpu
);
126 * snd_mpu401_uart_interrupt - generic MPU401-UART interrupt handler
127 * @irq: the irq number
128 * @dev_id: mpu401 instance
130 * Processes the interrupt for MPU401-UART i/o.
132 irqreturn_t
snd_mpu401_uart_interrupt(int irq
, void *dev_id
)
134 struct snd_mpu401
*mpu
= dev_id
;
138 _snd_mpu401_uart_interrupt(mpu
);
142 EXPORT_SYMBOL(snd_mpu401_uart_interrupt
);
145 * snd_mpu401_uart_interrupt_tx - generic MPU401-UART transmit irq handler
146 * @irq: the irq number
147 * @dev_id: mpu401 instance
149 * Processes the interrupt for MPU401-UART output.
151 irqreturn_t
snd_mpu401_uart_interrupt_tx(int irq
, void *dev_id
)
153 struct snd_mpu401
*mpu
= dev_id
;
157 uart_interrupt_tx(mpu
);
161 EXPORT_SYMBOL(snd_mpu401_uart_interrupt_tx
);
165 * reprogram the timer and call the interrupt job
167 static void snd_mpu401_uart_timer(unsigned long data
)
169 struct snd_mpu401
*mpu
= (struct snd_mpu401
*)data
;
172 spin_lock_irqsave(&mpu
->timer_lock
, flags
);
173 /*mpu->mode |= MPU401_MODE_TIMER;*/
174 mpu
->timer
.expires
= 1 + jiffies
;
175 add_timer(&mpu
->timer
);
176 spin_unlock_irqrestore(&mpu
->timer_lock
, flags
);
178 _snd_mpu401_uart_interrupt(mpu
);
182 * initialize the timer callback if not programmed yet
184 static void snd_mpu401_uart_add_timer (struct snd_mpu401
*mpu
, int input
)
188 spin_lock_irqsave (&mpu
->timer_lock
, flags
);
189 if (mpu
->timer_invoked
== 0) {
190 init_timer(&mpu
->timer
);
191 mpu
->timer
.data
= (unsigned long)mpu
;
192 mpu
->timer
.function
= snd_mpu401_uart_timer
;
193 mpu
->timer
.expires
= 1 + jiffies
;
194 add_timer(&mpu
->timer
);
196 mpu
->timer_invoked
|= input
? MPU401_MODE_INPUT_TIMER
:
197 MPU401_MODE_OUTPUT_TIMER
;
198 spin_unlock_irqrestore (&mpu
->timer_lock
, flags
);
202 * remove the timer callback if still active
204 static void snd_mpu401_uart_remove_timer (struct snd_mpu401
*mpu
, int input
)
208 spin_lock_irqsave (&mpu
->timer_lock
, flags
);
209 if (mpu
->timer_invoked
) {
210 mpu
->timer_invoked
&= input
? ~MPU401_MODE_INPUT_TIMER
:
211 ~MPU401_MODE_OUTPUT_TIMER
;
212 if (! mpu
->timer_invoked
)
213 del_timer(&mpu
->timer
);
215 spin_unlock_irqrestore (&mpu
->timer_lock
, flags
);
219 * send a UART command
220 * return zero if successful, non-zero for some errors
223 static int snd_mpu401_uart_cmd(struct snd_mpu401
* mpu
, unsigned char cmd
,
229 spin_lock_irqsave(&mpu
->input_lock
, flags
);
230 if (mpu
->hardware
!= MPU401_HW_TRID4DWAVE
) {
231 mpu
->write(mpu
, 0x00, MPU401D(mpu
));
232 /*snd_mpu401_uart_clear_rx(mpu);*/
234 /* ok. standard MPU-401 initialization */
235 if (mpu
->hardware
!= MPU401_HW_SB
) {
236 for (timeout
= 1000; timeout
> 0 &&
237 !snd_mpu401_output_ready(mpu
); timeout
--)
239 #ifdef CONFIG_SND_DEBUG
241 snd_printk(KERN_ERR
"cmd: tx timeout (status = 0x%x)\n",
242 mpu
->read(mpu
, MPU401C(mpu
)));
245 mpu
->write(mpu
, cmd
, MPU401C(mpu
));
246 if (ack
&& !(mpu
->info_flags
& MPU401_INFO_NO_ACK
)) {
249 while (!ok
&& timeout
-- > 0) {
250 if (snd_mpu401_input_avail(mpu
)) {
251 if (mpu
->read(mpu
, MPU401D(mpu
)) == MPU401_ACK
)
255 if (!ok
&& mpu
->read(mpu
, MPU401D(mpu
)) == MPU401_ACK
)
259 spin_unlock_irqrestore(&mpu
->input_lock
, flags
);
261 snd_printk(KERN_ERR
"cmd: 0x%x failed at 0x%lx "
262 "(status = 0x%x, data = 0x%x)\n", cmd
, mpu
->port
,
263 mpu
->read(mpu
, MPU401C(mpu
)),
264 mpu
->read(mpu
, MPU401D(mpu
)));
270 static int snd_mpu401_do_reset(struct snd_mpu401
*mpu
)
272 if (snd_mpu401_uart_cmd(mpu
, MPU401_RESET
, 1))
274 if (snd_mpu401_uart_cmd(mpu
, MPU401_ENTER_UART
, 0))
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
)
429 if (snd_rawmidi_transmit_peek(mpu
->substream_output
,
432 * Try twice because there is hardware that insists on
433 * setting the output busy bit after each write.
435 if (!snd_mpu401_output_ready(mpu
) &&
436 !snd_mpu401_output_ready(mpu
))
437 break; /* Tx FIFO full - try again later */
438 mpu
->write(mpu
, byte
, MPU401D(mpu
));
439 snd_rawmidi_transmit_ack(mpu
->substream_output
, 1);
441 snd_mpu401_uart_remove_timer (mpu
, 0);
442 break; /* no other data - leave the tx loop */
448 * output trigger callback
451 snd_mpu401_uart_output_trigger(struct snd_rawmidi_substream
*substream
, int up
)
454 struct snd_mpu401
*mpu
;
456 mpu
= substream
->rmidi
->private_data
;
458 set_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER
, &mpu
->mode
);
460 /* try to add the timer at each output trigger,
461 * since the output timer might have been removed in
462 * snd_mpu401_uart_output_write().
464 if (! (mpu
->info_flags
& MPU401_INFO_TX_IRQ
))
465 snd_mpu401_uart_add_timer(mpu
, 0);
467 /* output pending data */
468 spin_lock_irqsave(&mpu
->output_lock
, flags
);
469 snd_mpu401_uart_output_write(mpu
);
470 spin_unlock_irqrestore(&mpu
->output_lock
, flags
);
472 if (! (mpu
->info_flags
& MPU401_INFO_TX_IRQ
))
473 snd_mpu401_uart_remove_timer(mpu
, 0);
474 clear_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER
, &mpu
->mode
);
482 static struct snd_rawmidi_ops snd_mpu401_uart_output
=
484 .open
= snd_mpu401_uart_output_open
,
485 .close
= snd_mpu401_uart_output_close
,
486 .trigger
= snd_mpu401_uart_output_trigger
,
489 static struct snd_rawmidi_ops snd_mpu401_uart_input
=
491 .open
= snd_mpu401_uart_input_open
,
492 .close
= snd_mpu401_uart_input_close
,
493 .trigger
= snd_mpu401_uart_input_trigger
,
496 static void snd_mpu401_uart_free(struct snd_rawmidi
*rmidi
)
498 struct snd_mpu401
*mpu
= rmidi
->private_data
;
499 if (mpu
->irq_flags
&& mpu
->irq
>= 0)
500 free_irq(mpu
->irq
, (void *) mpu
);
501 release_and_free_resource(mpu
->res
);
506 * snd_mpu401_uart_new - create an MPU401-UART instance
507 * @card: the card instance
508 * @device: the device index, zero-based
509 * @hardware: the hardware type, MPU401_HW_XXXX
510 * @port: the base address of MPU401 port
511 * @info_flags: bitflags MPU401_INFO_XXX
512 * @irq: the irq number, -1 if no interrupt for mpu
513 * @irq_flags: the irq request flags (SA_XXX), 0 if irq was already reserved.
514 * @rrawmidi: the pointer to store the new rawmidi instance
516 * Creates a new MPU-401 instance.
518 * Note that the rawmidi instance is returned on the rrawmidi argument,
519 * not the mpu401 instance itself. To access to the mpu401 instance,
520 * cast from rawmidi->private_data (with struct snd_mpu401 magic-cast).
522 * Returns zero if successful, or a negative error code.
524 int snd_mpu401_uart_new(struct snd_card
*card
, int device
,
525 unsigned short hardware
,
527 unsigned int info_flags
,
528 int irq
, int irq_flags
,
529 struct snd_rawmidi
** rrawmidi
)
531 struct snd_mpu401
*mpu
;
532 struct snd_rawmidi
*rmidi
;
533 int in_enable
, out_enable
;
538 if (! (info_flags
& (MPU401_INFO_INPUT
| MPU401_INFO_OUTPUT
)))
539 info_flags
|= MPU401_INFO_INPUT
| MPU401_INFO_OUTPUT
;
540 in_enable
= (info_flags
& MPU401_INFO_INPUT
) ? 1 : 0;
541 out_enable
= (info_flags
& MPU401_INFO_OUTPUT
) ? 1 : 0;
542 if ((err
= snd_rawmidi_new(card
, "MPU-401U", device
,
543 out_enable
, in_enable
, &rmidi
)) < 0)
545 mpu
= kzalloc(sizeof(*mpu
), GFP_KERNEL
);
547 snd_printk(KERN_ERR
"mpu401_uart: cannot allocate\n");
548 snd_device_free(card
, rmidi
);
551 rmidi
->private_data
= mpu
;
552 rmidi
->private_free
= snd_mpu401_uart_free
;
553 spin_lock_init(&mpu
->input_lock
);
554 spin_lock_init(&mpu
->output_lock
);
555 spin_lock_init(&mpu
->timer_lock
);
556 mpu
->hardware
= hardware
;
557 if (! (info_flags
& MPU401_INFO_INTEGRATED
)) {
558 int res_size
= hardware
== MPU401_HW_PC98II
? 4 : 2;
559 mpu
->res
= request_region(port
, res_size
, "MPU401 UART");
560 if (mpu
->res
== NULL
) {
561 snd_printk(KERN_ERR
"mpu401_uart: "
562 "unable to grab port 0x%lx size %d\n",
564 snd_device_free(card
, rmidi
);
568 if (info_flags
& MPU401_INFO_MMIO
) {
569 mpu
->write
= mpu401_write_mmio
;
570 mpu
->read
= mpu401_read_mmio
;
572 mpu
->write
= mpu401_write_port
;
573 mpu
->read
= mpu401_read_port
;
576 if (hardware
== MPU401_HW_PC98II
)
577 mpu
->cport
= port
+ 2;
579 mpu
->cport
= port
+ 1;
580 if (irq
>= 0 && irq_flags
) {
581 if (request_irq(irq
, snd_mpu401_uart_interrupt
, irq_flags
,
582 "MPU401 UART", (void *) mpu
)) {
583 snd_printk(KERN_ERR
"mpu401_uart: "
584 "unable to grab IRQ %d\n", irq
);
585 snd_device_free(card
, rmidi
);
589 mpu
->info_flags
= info_flags
;
591 mpu
->irq_flags
= irq_flags
;
592 if (card
->shortname
[0])
593 snprintf(rmidi
->name
, sizeof(rmidi
->name
), "%s MIDI",
596 sprintf(rmidi
->name
, "MPU-401 MIDI %d-%d",card
->number
, device
);
598 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
,
599 &snd_mpu401_uart_output
);
600 rmidi
->info_flags
|= SNDRV_RAWMIDI_INFO_OUTPUT
;
603 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_INPUT
,
604 &snd_mpu401_uart_input
);
605 rmidi
->info_flags
|= SNDRV_RAWMIDI_INFO_INPUT
;
607 rmidi
->info_flags
|= SNDRV_RAWMIDI_INFO_DUPLEX
;
615 EXPORT_SYMBOL(snd_mpu401_uart_new
);
621 static int __init
alsa_mpu401_uart_init(void)
626 static void __exit
alsa_mpu401_uart_exit(void)
630 module_init(alsa_mpu401_uart_init
)
631 module_exit(alsa_mpu401_uart_exit
)