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(mpu401_t * mpu);
47 static void snd_mpu401_uart_output_write(mpu401_t * 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(mpu401_t *mpu, unsigned char data, unsigned long addr)
66 static unsigned char mpu401_read_port(mpu401_t *mpu, unsigned long addr)
71 static void mpu401_write_mmio(mpu401_t *mpu, unsigned char data, unsigned long addr)
73 writeb(data, (unsigned long*)addr);
76 static unsigned char mpu401_read_mmio(mpu401_t *mpu, unsigned long addr)
78 return readb((unsigned long*)addr);
82 static void snd_mpu401_uart_clear_rx(mpu401_t *mpu)
85 for (; timeout > 0 && snd_mpu401_input_avail(mpu); timeout--)
86 mpu->read(mpu, MPU401D(mpu));
87 #ifdef CONFIG_SND_DEBUG
89 snd_printk("cmd: clear rx timeout (status = 0x%x)\n", mpu->read(mpu, MPU401C(mpu)));
93 static void _snd_mpu401_uart_interrupt(mpu401_t *mpu)
95 spin_lock(&mpu->input_lock);
96 if (test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode)) {
97 atomic_dec(&mpu->rx_loop);
98 snd_mpu401_uart_input_read(mpu);
99 atomic_inc(&mpu->rx_loop);
101 snd_mpu401_uart_clear_rx(mpu);
103 spin_unlock(&mpu->input_lock);
104 /* ok. for better Tx performance try do some output when input is done */
105 if (test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode) &&
106 test_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode)) {
107 if (spin_trylock(&mpu->output_lock)) {
108 atomic_dec(&mpu->tx_loop);
109 snd_mpu401_uart_output_write(mpu);
110 atomic_inc(&mpu->tx_loop);
111 spin_unlock(&mpu->output_lock);
117 * snd_mpu401_uart_interrupt - generic MPU401-UART interrupt handler
118 * @irq: the irq number
119 * @dev_id: mpu401 instance
120 * @regs: the reigster
122 * Processes the interrupt for MPU401-UART i/o.
124 irqreturn_t snd_mpu401_uart_interrupt(int irq, void *dev_id, struct pt_regs *regs)
126 mpu401_t *mpu = dev_id;
130 _snd_mpu401_uart_interrupt(mpu);
136 * reprogram the timer and call the interrupt job
138 static void snd_mpu401_uart_timer(unsigned long data)
140 mpu401_t *mpu = (mpu401_t *)data;
142 spin_lock(&mpu->timer_lock);
143 /*mpu->mode |= MPU401_MODE_TIMER;*/
144 mpu->timer.expires = 1 + jiffies;
145 add_timer(&mpu->timer);
146 spin_unlock(&mpu->timer_lock);
148 _snd_mpu401_uart_interrupt(mpu);
152 * initialize the timer callback if not programmed yet
154 static void snd_mpu401_uart_add_timer (mpu401_t *mpu, int input)
158 spin_lock_irqsave (&mpu->timer_lock, flags);
159 if (mpu->timer_invoked == 0) {
160 init_timer(&mpu->timer);
161 mpu->timer.data = (unsigned long)mpu;
162 mpu->timer.function = snd_mpu401_uart_timer;
163 mpu->timer.expires = 1 + jiffies;
164 add_timer(&mpu->timer);
166 mpu->timer_invoked |= input ? MPU401_MODE_INPUT_TIMER : MPU401_MODE_OUTPUT_TIMER;
167 spin_unlock_irqrestore (&mpu->timer_lock, flags);
171 * remove the timer callback if still active
173 static void snd_mpu401_uart_remove_timer (mpu401_t *mpu, int input)
177 spin_lock_irqsave (&mpu->timer_lock, flags);
178 if (mpu->timer_invoked) {
179 mpu->timer_invoked &= input ? ~MPU401_MODE_INPUT_TIMER : ~MPU401_MODE_OUTPUT_TIMER;
180 if (! mpu->timer_invoked)
181 del_timer(&mpu->timer);
183 spin_unlock_irqrestore (&mpu->timer_lock, flags);
190 static void snd_mpu401_uart_cmd(mpu401_t * mpu, unsigned char cmd, int ack)
195 spin_lock_irqsave(&mpu->input_lock, flags);
196 if (mpu->hardware != MPU401_HW_TRID4DWAVE) {
197 mpu->write(mpu, 0x00, MPU401D(mpu));
198 /*snd_mpu401_uart_clear_rx(mpu);*/
200 /* ok. standard MPU-401 initialization */
201 if (mpu->hardware != MPU401_HW_SB) {
202 for (timeout = 1000; timeout > 0 && !snd_mpu401_output_ready(mpu); timeout--)
204 #ifdef CONFIG_SND_DEBUG
206 snd_printk("cmd: tx timeout (status = 0x%x)\n", mpu->read(mpu, MPU401C(mpu)));
209 mpu->write(mpu, cmd, MPU401C(mpu));
213 while (!ok && timeout-- > 0) {
214 if (snd_mpu401_input_avail(mpu)) {
215 if (mpu->read(mpu, MPU401D(mpu)) == MPU401_ACK)
219 if (!ok && mpu->read(mpu, MPU401D(mpu)) == MPU401_ACK)
224 spin_unlock_irqrestore(&mpu->input_lock, flags);
226 snd_printk("cmd: 0x%x failed at 0x%lx (status = 0x%x, data = 0x%x)\n", cmd, mpu->port, mpu->read(mpu, MPU401C(mpu)), mpu->read(mpu, MPU401D(mpu)));
227 // snd_printk("cmd: 0x%x at 0x%lx (status = 0x%x, data = 0x%x)\n", cmd, mpu->port, mpu->read(mpu, MPU401C(mpu)), mpu->read(mpu, MPU401D(mpu)));
231 * input/output open/close - protected by open_mutex in rawmidi.c
233 static int snd_mpu401_uart_input_open(snd_rawmidi_substream_t * substream)
238 mpu = substream->rmidi->private_data;
239 if (mpu->open_input && (err = mpu->open_input(mpu)) < 0)
241 if (! test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode)) {
242 snd_mpu401_uart_cmd(mpu, MPU401_RESET, 1);
243 snd_mpu401_uart_cmd(mpu, MPU401_ENTER_UART, 1);
245 mpu->substream_input = substream;
246 atomic_set(&mpu->rx_loop, 1);
247 set_bit(MPU401_MODE_BIT_INPUT, &mpu->mode);
251 static int snd_mpu401_uart_output_open(snd_rawmidi_substream_t * substream)
256 mpu = substream->rmidi->private_data;
257 if (mpu->open_output && (err = mpu->open_output(mpu)) < 0)
259 if (! test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode)) {
260 snd_mpu401_uart_cmd(mpu, MPU401_RESET, 1);
261 snd_mpu401_uart_cmd(mpu, MPU401_ENTER_UART, 1);
263 mpu->substream_output = substream;
264 atomic_set(&mpu->tx_loop, 1);
265 set_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode);
269 static int snd_mpu401_uart_input_close(snd_rawmidi_substream_t * substream)
273 mpu = substream->rmidi->private_data;
274 clear_bit(MPU401_MODE_BIT_INPUT, &mpu->mode);
275 mpu->substream_input = NULL;
276 if (! test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode))
277 snd_mpu401_uart_cmd(mpu, MPU401_RESET, 0);
278 if (mpu->close_input)
279 mpu->close_input(mpu);
283 static int snd_mpu401_uart_output_close(snd_rawmidi_substream_t * substream)
287 mpu = substream->rmidi->private_data;
288 clear_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode);
289 mpu->substream_output = NULL;
290 if (! test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode))
291 snd_mpu401_uart_cmd(mpu, MPU401_RESET, 0);
292 if (mpu->close_output)
293 mpu->close_output(mpu);
298 * trigger input callback
300 static void snd_mpu401_uart_input_trigger(snd_rawmidi_substream_t * substream, int up)
306 mpu = substream->rmidi->private_data;
308 if (! test_and_set_bit(MPU401_MODE_BIT_INPUT_TRIGGER, &mpu->mode)) {
309 /* first time - flush FIFO */
311 mpu->read(mpu, MPU401D(mpu));
313 snd_mpu401_uart_add_timer(mpu, 1);
316 /* read data in advance */
317 /* prevent double enter via rawmidi->event callback */
318 if (atomic_dec_and_test(&mpu->rx_loop)) {
319 local_irq_save(flags);
320 if (spin_trylock(&mpu->input_lock)) {
321 snd_mpu401_uart_input_read(mpu);
322 spin_unlock(&mpu->input_lock);
324 local_irq_restore(flags);
326 atomic_inc(&mpu->rx_loop);
329 snd_mpu401_uart_remove_timer(mpu, 1);
330 clear_bit(MPU401_MODE_BIT_INPUT_TRIGGER, &mpu->mode);
335 * transfer input pending data
336 * call with input_lock spinlock held
338 static void snd_mpu401_uart_input_read(mpu401_t * mpu)
344 if (snd_mpu401_input_avail(mpu)) {
345 byte = mpu->read(mpu, MPU401D(mpu));
346 if (test_bit(MPU401_MODE_BIT_INPUT_TRIGGER, &mpu->mode))
347 snd_rawmidi_receive(mpu->substream_input, &byte, 1);
349 break; /* input not available */
357 * AudioDrive ES1688 - 12 bytes
358 * S3 SonicVibes - 8 bytes
359 * SoundBlaster AWE 64 - 2 bytes (ugly hardware)
363 * write output pending bytes
364 * call with output_lock spinlock held
366 static void snd_mpu401_uart_output_write(mpu401_t * mpu)
369 int max = 256, timeout;
372 if (snd_rawmidi_transmit_peek(mpu->substream_output, &byte, 1) == 1) {
373 for (timeout = 100; timeout > 0; timeout--) {
374 if (snd_mpu401_output_ready(mpu)) {
375 mpu->write(mpu, byte, MPU401D(mpu));
376 snd_rawmidi_transmit_ack(mpu->substream_output, 1);
381 break; /* Tx FIFO full - try again later */
383 snd_mpu401_uart_remove_timer (mpu, 0);
384 break; /* no other data - leave the tx loop */
390 * output trigger callback
392 static void snd_mpu401_uart_output_trigger(snd_rawmidi_substream_t * substream, int up)
397 mpu = substream->rmidi->private_data;
399 set_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode);
401 /* try to add the timer at each output trigger,
402 * since the output timer might have been removed in
403 * snd_mpu401_uart_output_write().
405 snd_mpu401_uart_add_timer(mpu, 0);
407 /* output pending data */
408 /* prevent double enter via rawmidi->event callback */
409 if (atomic_dec_and_test(&mpu->tx_loop)) {
410 local_irq_save(flags);
411 if (spin_trylock(&mpu->output_lock)) {
412 snd_mpu401_uart_output_write(mpu);
413 spin_unlock(&mpu->output_lock);
415 local_irq_restore(flags);
417 atomic_inc(&mpu->tx_loop);
419 snd_mpu401_uart_remove_timer(mpu, 0);
420 clear_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode);
428 static snd_rawmidi_ops_t snd_mpu401_uart_output =
430 .open = snd_mpu401_uart_output_open,
431 .close = snd_mpu401_uart_output_close,
432 .trigger = snd_mpu401_uart_output_trigger,
435 static snd_rawmidi_ops_t snd_mpu401_uart_input =
437 .open = snd_mpu401_uart_input_open,
438 .close = snd_mpu401_uart_input_close,
439 .trigger = snd_mpu401_uart_input_trigger,
442 static void snd_mpu401_uart_free(snd_rawmidi_t *rmidi)
444 mpu401_t *mpu = rmidi->private_data;
445 if (mpu->irq_flags && mpu->irq >= 0)
446 free_irq(mpu->irq, (void *) mpu);
448 release_resource(mpu->res);
449 kfree_nocheck(mpu->res);
455 * snd_mpu401_uart_new - create an MPU401-UART instance
456 * @card: the card instance
457 * @device: the device index, zero-based
458 * @hardware: the hardware type, MPU401_HW_XXXX
459 * @port: the base address of MPU401 port
460 * @integrated: non-zero if the port was already reserved by the chip
461 * @irq: the irq number, -1 if no interrupt for mpu
462 * @irq_flags: the irq request flags (SA_XXX), 0 if irq was already reserved.
463 * @rrawmidi: the pointer to store the new rawmidi instance
465 * Creates a new MPU-401 instance.
467 * Note that the rawmidi instance is returned on the rrawmidi argument,
468 * not the mpu401 instance itself. To access to the mpu401 instance,
469 * cast from rawmidi->private_data (with mpu401_t magic-cast).
471 * Returns zero if successful, or a negative error code.
473 int snd_mpu401_uart_new(snd_card_t * card, int device,
474 unsigned short hardware,
475 unsigned long port, int integrated,
476 int irq, int irq_flags,
477 snd_rawmidi_t ** rrawmidi)
480 snd_rawmidi_t *rmidi;
485 if ((err = snd_rawmidi_new(card, "MPU-401U", device, 1, 1, &rmidi)) < 0)
487 mpu = kcalloc(1, sizeof(*mpu), GFP_KERNEL);
489 snd_device_free(card, rmidi);
492 rmidi->private_data = mpu;
493 rmidi->private_free = snd_mpu401_uart_free;
494 spin_lock_init(&mpu->input_lock);
495 spin_lock_init(&mpu->output_lock);
496 spin_lock_init(&mpu->timer_lock);
497 mpu->hardware = hardware;
499 int res_size = hardware == MPU401_HW_PC98II ? 4 : 2;
500 if ((mpu->res = request_region(port, res_size, "MPU401 UART")) == NULL) {
501 snd_printk(KERN_ERR "mpu401_uart: unable to grab port 0x%lx size %d\n", port, res_size);
502 snd_device_free(card, rmidi);
507 case MPU401_HW_AUREAL:
508 mpu->write = mpu401_write_mmio;
509 mpu->read = mpu401_read_mmio;
512 mpu->write = mpu401_write_port;
513 mpu->read = mpu401_read_port;
517 if (hardware == MPU401_HW_PC98II)
518 mpu->cport = port + 2;
520 mpu->cport = port + 1;
521 if (irq >= 0 && irq_flags) {
522 if (request_irq(irq, snd_mpu401_uart_interrupt, irq_flags, "MPU401 UART", (void *) mpu)) {
523 snd_printk(KERN_ERR "mpu401_uart: unable to grab IRQ %d\n", irq);
524 snd_device_free(card, rmidi);
529 mpu->irq_flags = irq_flags;
530 if (card->shortname[0])
531 snprintf(rmidi->name, sizeof(rmidi->name), "%s MIDI", card->shortname);
533 sprintf(rmidi->name, "MPU-401 MIDI %d-%d", card->number, device);
534 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_mpu401_uart_output);
535 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_mpu401_uart_input);
536 rmidi->info_flags |= SNDRV_RAWMIDI_INFO_OUTPUT |
537 SNDRV_RAWMIDI_INFO_INPUT |
538 SNDRV_RAWMIDI_INFO_DUPLEX;
545 EXPORT_SYMBOL(snd_mpu401_uart_interrupt);
546 EXPORT_SYMBOL(snd_mpu401_uart_new);
552 static int __init alsa_mpu401_uart_init(void)
557 static void __exit alsa_mpu401_uart_exit(void)
561 module_init(alsa_mpu401_uart_init)
562 module_exit(alsa_mpu401_uart_exit)