11da177e4SLinus Torvalds /* 2c1017a4cSJaroslav Kysela * Copyright (c) by Jaroslav Kysela <perex@perex.cz> 31da177e4SLinus Torvalds * Routines for control of MPU-401 in UART mode 41da177e4SLinus Torvalds * 51da177e4SLinus Torvalds * MPU-401 supports UART mode which is not capable generate transmit 6dba8b469SClemens Ladisch * interrupts thus output is done via polling. Without interrupt, 71da177e4SLinus Torvalds * input is done also via polling. Do not expect good performance. 81da177e4SLinus Torvalds * 91da177e4SLinus Torvalds * 101da177e4SLinus Torvalds * This program is free software; you can redistribute it and/or modify 111da177e4SLinus Torvalds * it under the terms of the GNU General Public License as published by 121da177e4SLinus Torvalds * the Free Software Foundation; either version 2 of the License, or 131da177e4SLinus Torvalds * (at your option) any later version. 141da177e4SLinus Torvalds * 151da177e4SLinus Torvalds * This program is distributed in the hope that it will be useful, 161da177e4SLinus Torvalds * but WITHOUT ANY WARRANTY; without even the implied warranty of 171da177e4SLinus Torvalds * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 181da177e4SLinus Torvalds * GNU General Public License for more details. 191da177e4SLinus Torvalds * 201da177e4SLinus Torvalds * You should have received a copy of the GNU General Public License 211da177e4SLinus Torvalds * along with this program; if not, write to the Free Software 221da177e4SLinus Torvalds * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 231da177e4SLinus Torvalds * 241da177e4SLinus Torvalds * 13-03-2003: 251da177e4SLinus Torvalds * Added support for different kind of hardware I/O. Build in choices 261da177e4SLinus Torvalds * are port and mmio. For other kind of I/O, set mpu->read and 271da177e4SLinus Torvalds * mpu->write to your own I/O functions. 281da177e4SLinus Torvalds * 291da177e4SLinus Torvalds */ 301da177e4SLinus Torvalds 316cbbfe1cSTakashi Iwai #include <linux/io.h> 321da177e4SLinus Torvalds #include <linux/delay.h> 331da177e4SLinus Torvalds #include <linux/init.h> 341da177e4SLinus Torvalds #include <linux/slab.h> 351da177e4SLinus Torvalds #include <linux/ioport.h> 36da155d5bSPaul Gortmaker #include <linux/module.h> 371da177e4SLinus Torvalds #include <linux/interrupt.h> 381da177e4SLinus Torvalds #include <linux/errno.h> 391da177e4SLinus Torvalds #include <sound/core.h> 401da177e4SLinus Torvalds #include <sound/mpu401.h> 411da177e4SLinus Torvalds 42c1017a4cSJaroslav Kysela MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>"); 431da177e4SLinus Torvalds MODULE_DESCRIPTION("Routines for control of MPU-401 in UART mode"); 441da177e4SLinus Torvalds MODULE_LICENSE("GPL"); 451da177e4SLinus Torvalds 46e1fad17bSTakashi Iwai static void snd_mpu401_uart_input_read(struct snd_mpu401 * mpu); 47e1fad17bSTakashi Iwai static void snd_mpu401_uart_output_write(struct snd_mpu401 * mpu); 481da177e4SLinus Torvalds 491da177e4SLinus Torvalds /* 501da177e4SLinus Torvalds 511da177e4SLinus Torvalds */ 521da177e4SLinus Torvalds 53b415ed45STakashi Iwai #define snd_mpu401_input_avail(mpu) \ 54b415ed45STakashi Iwai (!(mpu->read(mpu, MPU401C(mpu)) & MPU401_RX_EMPTY)) 55b415ed45STakashi Iwai #define snd_mpu401_output_ready(mpu) \ 56b415ed45STakashi Iwai (!(mpu->read(mpu, MPU401C(mpu)) & MPU401_TX_FULL)) 571da177e4SLinus Torvalds 581da177e4SLinus Torvalds /* Build in lowlevel io */ 592851d963STakashi Iwai static void mpu401_write_port(struct snd_mpu401 *mpu, unsigned char data, 602851d963STakashi Iwai unsigned long addr) 611da177e4SLinus Torvalds { 621da177e4SLinus Torvalds outb(data, addr); 631da177e4SLinus Torvalds } 641da177e4SLinus Torvalds 652851d963STakashi Iwai static unsigned char mpu401_read_port(struct snd_mpu401 *mpu, 662851d963STakashi Iwai unsigned long addr) 671da177e4SLinus Torvalds { 681da177e4SLinus Torvalds return inb(addr); 691da177e4SLinus Torvalds } 701da177e4SLinus Torvalds 712851d963STakashi Iwai static void mpu401_write_mmio(struct snd_mpu401 *mpu, unsigned char data, 722851d963STakashi Iwai unsigned long addr) 731da177e4SLinus Torvalds { 741da177e4SLinus Torvalds writeb(data, (void __iomem *)addr); 751da177e4SLinus Torvalds } 761da177e4SLinus Torvalds 772851d963STakashi Iwai static unsigned char mpu401_read_mmio(struct snd_mpu401 *mpu, 782851d963STakashi Iwai unsigned long addr) 791da177e4SLinus Torvalds { 801da177e4SLinus Torvalds return readb((void __iomem *)addr); 811da177e4SLinus Torvalds } 821da177e4SLinus Torvalds /* */ 831da177e4SLinus Torvalds 84e1fad17bSTakashi Iwai static void snd_mpu401_uart_clear_rx(struct snd_mpu401 *mpu) 851da177e4SLinus Torvalds { 861da177e4SLinus Torvalds int timeout = 100000; 871da177e4SLinus Torvalds for (; timeout > 0 && snd_mpu401_input_avail(mpu); timeout--) 881da177e4SLinus Torvalds mpu->read(mpu, MPU401D(mpu)); 891da177e4SLinus Torvalds #ifdef CONFIG_SND_DEBUG 901da177e4SLinus Torvalds if (timeout <= 0) 912851d963STakashi Iwai snd_printk(KERN_ERR "cmd: clear rx timeout (status = 0x%x)\n", 922851d963STakashi Iwai mpu->read(mpu, MPU401C(mpu))); 931da177e4SLinus Torvalds #endif 941da177e4SLinus Torvalds } 951da177e4SLinus Torvalds 96302e4c2fSTakashi Iwai static void uart_interrupt_tx(struct snd_mpu401 *mpu) 971da177e4SLinus Torvalds { 9860fac85fSClemens Ladisch unsigned long flags; 9960fac85fSClemens Ladisch 1001da177e4SLinus Torvalds if (test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode) && 1011da177e4SLinus Torvalds test_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode)) { 10260fac85fSClemens Ladisch spin_lock_irqsave(&mpu->output_lock, flags); 1031da177e4SLinus Torvalds snd_mpu401_uart_output_write(mpu); 10460fac85fSClemens Ladisch spin_unlock_irqrestore(&mpu->output_lock, flags); 1051da177e4SLinus Torvalds } 1061da177e4SLinus Torvalds } 1071da177e4SLinus Torvalds 108302e4c2fSTakashi Iwai static void _snd_mpu401_uart_interrupt(struct snd_mpu401 *mpu) 109302e4c2fSTakashi Iwai { 11060fac85fSClemens Ladisch unsigned long flags; 11160fac85fSClemens Ladisch 112302e4c2fSTakashi Iwai if (mpu->info_flags & MPU401_INFO_INPUT) { 11360fac85fSClemens Ladisch spin_lock_irqsave(&mpu->input_lock, flags); 114302e4c2fSTakashi Iwai if (test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode)) 115302e4c2fSTakashi Iwai snd_mpu401_uart_input_read(mpu); 116302e4c2fSTakashi Iwai else 117302e4c2fSTakashi Iwai snd_mpu401_uart_clear_rx(mpu); 11860fac85fSClemens Ladisch spin_unlock_irqrestore(&mpu->input_lock, flags); 119302e4c2fSTakashi Iwai } 120302e4c2fSTakashi Iwai if (! (mpu->info_flags & MPU401_INFO_TX_IRQ)) 121302e4c2fSTakashi Iwai /* ok. for better Tx performance try do some output 122302e4c2fSTakashi Iwai when input is done */ 123302e4c2fSTakashi Iwai uart_interrupt_tx(mpu); 124302e4c2fSTakashi Iwai } 125302e4c2fSTakashi Iwai 1261da177e4SLinus Torvalds /** 1271da177e4SLinus Torvalds * snd_mpu401_uart_interrupt - generic MPU401-UART interrupt handler 1281da177e4SLinus Torvalds * @irq: the irq number 1291da177e4SLinus Torvalds * @dev_id: mpu401 instance 1301da177e4SLinus Torvalds * 1311da177e4SLinus Torvalds * Processes the interrupt for MPU401-UART i/o. 132eb7c06e8SYacine Belkadi * 133eb7c06e8SYacine Belkadi * Return: %IRQ_HANDLED if the interrupt was handled. %IRQ_NONE otherwise. 1341da177e4SLinus Torvalds */ 1357d12e780SDavid Howells irqreturn_t snd_mpu401_uart_interrupt(int irq, void *dev_id) 1361da177e4SLinus Torvalds { 137e1fad17bSTakashi Iwai struct snd_mpu401 *mpu = dev_id; 1381da177e4SLinus Torvalds 139f1a77dc1SMarkus Elfring if (!mpu) 1401da177e4SLinus Torvalds return IRQ_NONE; 1411da177e4SLinus Torvalds _snd_mpu401_uart_interrupt(mpu); 1421da177e4SLinus Torvalds return IRQ_HANDLED; 1431da177e4SLinus Torvalds } 1441da177e4SLinus Torvalds 1452851d963STakashi Iwai EXPORT_SYMBOL(snd_mpu401_uart_interrupt); 1462851d963STakashi Iwai 147302e4c2fSTakashi Iwai /** 148302e4c2fSTakashi Iwai * snd_mpu401_uart_interrupt_tx - generic MPU401-UART transmit irq handler 149302e4c2fSTakashi Iwai * @irq: the irq number 150302e4c2fSTakashi Iwai * @dev_id: mpu401 instance 151302e4c2fSTakashi Iwai * 152302e4c2fSTakashi Iwai * Processes the interrupt for MPU401-UART output. 153eb7c06e8SYacine Belkadi * 154eb7c06e8SYacine Belkadi * Return: %IRQ_HANDLED if the interrupt was handled. %IRQ_NONE otherwise. 155302e4c2fSTakashi Iwai */ 1567d12e780SDavid Howells irqreturn_t snd_mpu401_uart_interrupt_tx(int irq, void *dev_id) 157302e4c2fSTakashi Iwai { 158302e4c2fSTakashi Iwai struct snd_mpu401 *mpu = dev_id; 159302e4c2fSTakashi Iwai 160f1a77dc1SMarkus Elfring if (!mpu) 161302e4c2fSTakashi Iwai return IRQ_NONE; 162302e4c2fSTakashi Iwai uart_interrupt_tx(mpu); 163302e4c2fSTakashi Iwai return IRQ_HANDLED; 164302e4c2fSTakashi Iwai } 165302e4c2fSTakashi Iwai 166302e4c2fSTakashi Iwai EXPORT_SYMBOL(snd_mpu401_uart_interrupt_tx); 167302e4c2fSTakashi Iwai 1681da177e4SLinus Torvalds /* 1691da177e4SLinus Torvalds * timer callback 1701da177e4SLinus Torvalds * reprogram the timer and call the interrupt job 1711da177e4SLinus Torvalds */ 172bc47ba90SKees Cook static void snd_mpu401_uart_timer(struct timer_list *t) 1731da177e4SLinus Torvalds { 174bc47ba90SKees Cook struct snd_mpu401 *mpu = from_timer(mpu, t, timer); 175b32425acSTakashi Iwai unsigned long flags; 1761da177e4SLinus Torvalds 177b32425acSTakashi Iwai spin_lock_irqsave(&mpu->timer_lock, flags); 1781da177e4SLinus Torvalds /*mpu->mode |= MPU401_MODE_TIMER;*/ 179b093ed23STakashi Iwai mod_timer(&mpu->timer, 1 + jiffies); 180b32425acSTakashi Iwai spin_unlock_irqrestore(&mpu->timer_lock, flags); 1811da177e4SLinus Torvalds if (mpu->rmidi) 1821da177e4SLinus Torvalds _snd_mpu401_uart_interrupt(mpu); 1831da177e4SLinus Torvalds } 1841da177e4SLinus Torvalds 1851da177e4SLinus Torvalds /* 1861da177e4SLinus Torvalds * initialize the timer callback if not programmed yet 1871da177e4SLinus Torvalds */ 188e1fad17bSTakashi Iwai static void snd_mpu401_uart_add_timer (struct snd_mpu401 *mpu, int input) 1891da177e4SLinus Torvalds { 1901da177e4SLinus Torvalds unsigned long flags; 1911da177e4SLinus Torvalds 1921da177e4SLinus Torvalds spin_lock_irqsave (&mpu->timer_lock, flags); 1931da177e4SLinus Torvalds if (mpu->timer_invoked == 0) { 194bc47ba90SKees Cook timer_setup(&mpu->timer, snd_mpu401_uart_timer, 0); 195b093ed23STakashi Iwai mod_timer(&mpu->timer, 1 + jiffies); 1961da177e4SLinus Torvalds } 1972851d963STakashi Iwai mpu->timer_invoked |= input ? MPU401_MODE_INPUT_TIMER : 1982851d963STakashi Iwai MPU401_MODE_OUTPUT_TIMER; 1991da177e4SLinus Torvalds spin_unlock_irqrestore (&mpu->timer_lock, flags); 2001da177e4SLinus Torvalds } 2011da177e4SLinus Torvalds 2021da177e4SLinus Torvalds /* 2031da177e4SLinus Torvalds * remove the timer callback if still active 2041da177e4SLinus Torvalds */ 205e1fad17bSTakashi Iwai static void snd_mpu401_uart_remove_timer (struct snd_mpu401 *mpu, int input) 2061da177e4SLinus Torvalds { 2071da177e4SLinus Torvalds unsigned long flags; 2081da177e4SLinus Torvalds 2091da177e4SLinus Torvalds spin_lock_irqsave (&mpu->timer_lock, flags); 2101da177e4SLinus Torvalds if (mpu->timer_invoked) { 2112851d963STakashi Iwai mpu->timer_invoked &= input ? ~MPU401_MODE_INPUT_TIMER : 2122851d963STakashi Iwai ~MPU401_MODE_OUTPUT_TIMER; 2131da177e4SLinus Torvalds if (! mpu->timer_invoked) 2141da177e4SLinus Torvalds del_timer(&mpu->timer); 2151da177e4SLinus Torvalds } 2161da177e4SLinus Torvalds spin_unlock_irqrestore (&mpu->timer_lock, flags); 2171da177e4SLinus Torvalds } 2181da177e4SLinus Torvalds 2191da177e4SLinus Torvalds /* 2202851d963STakashi Iwai * send a UART command 2212851d963STakashi Iwai * return zero if successful, non-zero for some errors 2221da177e4SLinus Torvalds */ 2231da177e4SLinus Torvalds 224962f831fSJon Masters static int snd_mpu401_uart_cmd(struct snd_mpu401 * mpu, unsigned char cmd, 225962f831fSJon Masters int ack) 2261da177e4SLinus Torvalds { 2271da177e4SLinus Torvalds unsigned long flags; 2281da177e4SLinus Torvalds int timeout, ok; 2291da177e4SLinus Torvalds 2301da177e4SLinus Torvalds spin_lock_irqsave(&mpu->input_lock, flags); 2311da177e4SLinus Torvalds if (mpu->hardware != MPU401_HW_TRID4DWAVE) { 2321da177e4SLinus Torvalds mpu->write(mpu, 0x00, MPU401D(mpu)); 2331da177e4SLinus Torvalds /*snd_mpu401_uart_clear_rx(mpu);*/ 2341da177e4SLinus Torvalds } 2351da177e4SLinus Torvalds /* ok. standard MPU-401 initialization */ 2361da177e4SLinus Torvalds if (mpu->hardware != MPU401_HW_SB) { 2372851d963STakashi Iwai for (timeout = 1000; timeout > 0 && 2382851d963STakashi Iwai !snd_mpu401_output_ready(mpu); timeout--) 2391da177e4SLinus Torvalds udelay(10); 2401da177e4SLinus Torvalds #ifdef CONFIG_SND_DEBUG 2411da177e4SLinus Torvalds if (!timeout) 2422851d963STakashi Iwai snd_printk(KERN_ERR "cmd: tx timeout (status = 0x%x)\n", 2432851d963STakashi Iwai mpu->read(mpu, MPU401C(mpu))); 2441da177e4SLinus Torvalds #endif 2451da177e4SLinus Torvalds } 2461da177e4SLinus Torvalds mpu->write(mpu, cmd, MPU401C(mpu)); 247df7e3fdfSTakashi Iwai if (ack && !(mpu->info_flags & MPU401_INFO_NO_ACK)) { 2481da177e4SLinus Torvalds ok = 0; 2491da177e4SLinus Torvalds timeout = 10000; 2501da177e4SLinus Torvalds while (!ok && timeout-- > 0) { 2511da177e4SLinus Torvalds if (snd_mpu401_input_avail(mpu)) { 2521da177e4SLinus Torvalds if (mpu->read(mpu, MPU401D(mpu)) == MPU401_ACK) 2531da177e4SLinus Torvalds ok = 1; 2541da177e4SLinus Torvalds } 2551da177e4SLinus Torvalds } 2561da177e4SLinus Torvalds if (!ok && mpu->read(mpu, MPU401D(mpu)) == MPU401_ACK) 2571da177e4SLinus Torvalds ok = 1; 2582851d963STakashi Iwai } else 2591da177e4SLinus Torvalds ok = 1; 2601da177e4SLinus Torvalds spin_unlock_irqrestore(&mpu->input_lock, flags); 261962f831fSJon Masters if (!ok) { 2622851d963STakashi Iwai snd_printk(KERN_ERR "cmd: 0x%x failed at 0x%lx " 2632851d963STakashi Iwai "(status = 0x%x, data = 0x%x)\n", cmd, mpu->port, 2642851d963STakashi Iwai mpu->read(mpu, MPU401C(mpu)), 2652851d963STakashi Iwai mpu->read(mpu, MPU401D(mpu))); 266962f831fSJon Masters return 1; 267962f831fSJon Masters } 268962f831fSJon Masters return 0; 2691da177e4SLinus Torvalds } 2701da177e4SLinus Torvalds 2718f7ba051STakashi Iwai static int snd_mpu401_do_reset(struct snd_mpu401 *mpu) 2728f7ba051STakashi Iwai { 2738f7ba051STakashi Iwai if (snd_mpu401_uart_cmd(mpu, MPU401_RESET, 1)) 2748f7ba051STakashi Iwai return -EIO; 275c1099fcbSClemens Ladisch if (snd_mpu401_uart_cmd(mpu, MPU401_ENTER_UART, 0)) 2768f7ba051STakashi Iwai return -EIO; 2778f7ba051STakashi Iwai return 0; 2788f7ba051STakashi Iwai } 2798f7ba051STakashi Iwai 2801da177e4SLinus Torvalds /* 2811da177e4SLinus Torvalds * input/output open/close - protected by open_mutex in rawmidi.c 2821da177e4SLinus Torvalds */ 283e1fad17bSTakashi Iwai static int snd_mpu401_uart_input_open(struct snd_rawmidi_substream *substream) 2841da177e4SLinus Torvalds { 285e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 2861da177e4SLinus Torvalds int err; 2871da177e4SLinus Torvalds 2881da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 2891da177e4SLinus Torvalds if (mpu->open_input && (err = mpu->open_input(mpu)) < 0) 2901da177e4SLinus Torvalds return err; 2911da177e4SLinus Torvalds if (! test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode)) { 2928f7ba051STakashi Iwai if (snd_mpu401_do_reset(mpu) < 0) 293962f831fSJon Masters goto error_out; 2941da177e4SLinus Torvalds } 2951da177e4SLinus Torvalds mpu->substream_input = substream; 2961da177e4SLinus Torvalds set_bit(MPU401_MODE_BIT_INPUT, &mpu->mode); 2971da177e4SLinus Torvalds return 0; 298962f831fSJon Masters 299962f831fSJon Masters error_out: 300962f831fSJon Masters if (mpu->open_input && mpu->close_input) 301962f831fSJon Masters mpu->close_input(mpu); 302962f831fSJon Masters return -EIO; 3031da177e4SLinus Torvalds } 3041da177e4SLinus Torvalds 305e1fad17bSTakashi Iwai static int snd_mpu401_uart_output_open(struct snd_rawmidi_substream *substream) 3061da177e4SLinus Torvalds { 307e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 3081da177e4SLinus Torvalds int err; 3091da177e4SLinus Torvalds 3101da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 3111da177e4SLinus Torvalds if (mpu->open_output && (err = mpu->open_output(mpu)) < 0) 3121da177e4SLinus Torvalds return err; 3131da177e4SLinus Torvalds if (! test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode)) { 3148f7ba051STakashi Iwai if (snd_mpu401_do_reset(mpu) < 0) 315962f831fSJon Masters goto error_out; 3161da177e4SLinus Torvalds } 3171da177e4SLinus Torvalds mpu->substream_output = substream; 3181da177e4SLinus Torvalds set_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode); 3191da177e4SLinus Torvalds return 0; 320962f831fSJon Masters 321962f831fSJon Masters error_out: 322962f831fSJon Masters if (mpu->open_output && mpu->close_output) 323962f831fSJon Masters mpu->close_output(mpu); 324962f831fSJon Masters return -EIO; 3251da177e4SLinus Torvalds } 3261da177e4SLinus Torvalds 327e1fad17bSTakashi Iwai static int snd_mpu401_uart_input_close(struct snd_rawmidi_substream *substream) 3281da177e4SLinus Torvalds { 329e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 330962f831fSJon Masters int err = 0; 3311da177e4SLinus Torvalds 3321da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 3331da177e4SLinus Torvalds clear_bit(MPU401_MODE_BIT_INPUT, &mpu->mode); 3341da177e4SLinus Torvalds mpu->substream_input = NULL; 3351da177e4SLinus Torvalds if (! test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode)) 336962f831fSJon Masters err = snd_mpu401_uart_cmd(mpu, MPU401_RESET, 0); 3371da177e4SLinus Torvalds if (mpu->close_input) 3381da177e4SLinus Torvalds mpu->close_input(mpu); 339962f831fSJon Masters if (err) 340962f831fSJon Masters return -EIO; 3411da177e4SLinus Torvalds return 0; 3421da177e4SLinus Torvalds } 3431da177e4SLinus Torvalds 344e1fad17bSTakashi Iwai static int snd_mpu401_uart_output_close(struct snd_rawmidi_substream *substream) 3451da177e4SLinus Torvalds { 346e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 347962f831fSJon Masters int err = 0; 3481da177e4SLinus Torvalds 3491da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 3501da177e4SLinus Torvalds clear_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode); 3511da177e4SLinus Torvalds mpu->substream_output = NULL; 3521da177e4SLinus Torvalds if (! test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode)) 353962f831fSJon Masters err = snd_mpu401_uart_cmd(mpu, MPU401_RESET, 0); 3541da177e4SLinus Torvalds if (mpu->close_output) 3551da177e4SLinus Torvalds mpu->close_output(mpu); 356962f831fSJon Masters if (err) 357962f831fSJon Masters return -EIO; 3581da177e4SLinus Torvalds return 0; 3591da177e4SLinus Torvalds } 3601da177e4SLinus Torvalds 3611da177e4SLinus Torvalds /* 3621da177e4SLinus Torvalds * trigger input callback 3631da177e4SLinus Torvalds */ 3642851d963STakashi Iwai static void 3652851d963STakashi Iwai snd_mpu401_uart_input_trigger(struct snd_rawmidi_substream *substream, int up) 3661da177e4SLinus Torvalds { 3671da177e4SLinus Torvalds unsigned long flags; 368e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 3691da177e4SLinus Torvalds int max = 64; 3701da177e4SLinus Torvalds 3711da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 3721da177e4SLinus Torvalds if (up) { 3732851d963STakashi Iwai if (! test_and_set_bit(MPU401_MODE_BIT_INPUT_TRIGGER, 3742851d963STakashi Iwai &mpu->mode)) { 3751da177e4SLinus Torvalds /* first time - flush FIFO */ 3761da177e4SLinus Torvalds while (max-- > 0) 3771da177e4SLinus Torvalds mpu->read(mpu, MPU401D(mpu)); 378dba8b469SClemens Ladisch if (mpu->info_flags & MPU401_INFO_USE_TIMER) 3791da177e4SLinus Torvalds snd_mpu401_uart_add_timer(mpu, 1); 3801da177e4SLinus Torvalds } 3811da177e4SLinus Torvalds 3821da177e4SLinus Torvalds /* read data in advance */ 3831da177e4SLinus Torvalds spin_lock_irqsave(&mpu->input_lock, flags); 3841da177e4SLinus Torvalds snd_mpu401_uart_input_read(mpu); 3851da177e4SLinus Torvalds spin_unlock_irqrestore(&mpu->input_lock, flags); 3861da177e4SLinus Torvalds } else { 387dba8b469SClemens Ladisch if (mpu->info_flags & MPU401_INFO_USE_TIMER) 3881da177e4SLinus Torvalds snd_mpu401_uart_remove_timer(mpu, 1); 3891da177e4SLinus Torvalds clear_bit(MPU401_MODE_BIT_INPUT_TRIGGER, &mpu->mode); 3901da177e4SLinus Torvalds } 391962f831fSJon Masters 3921da177e4SLinus Torvalds } 3931da177e4SLinus Torvalds 3941da177e4SLinus Torvalds /* 3951da177e4SLinus Torvalds * transfer input pending data 3961da177e4SLinus Torvalds * call with input_lock spinlock held 3971da177e4SLinus Torvalds */ 398e1fad17bSTakashi Iwai static void snd_mpu401_uart_input_read(struct snd_mpu401 * mpu) 3991da177e4SLinus Torvalds { 4001da177e4SLinus Torvalds int max = 128; 4011da177e4SLinus Torvalds unsigned char byte; 4021da177e4SLinus Torvalds 4031da177e4SLinus Torvalds while (max-- > 0) { 4042851d963STakashi Iwai if (! snd_mpu401_input_avail(mpu)) 4052851d963STakashi Iwai break; /* input not available */ 4061da177e4SLinus Torvalds byte = mpu->read(mpu, MPU401D(mpu)); 4071da177e4SLinus Torvalds if (test_bit(MPU401_MODE_BIT_INPUT_TRIGGER, &mpu->mode)) 4081da177e4SLinus Torvalds snd_rawmidi_receive(mpu->substream_input, &byte, 1); 4091da177e4SLinus Torvalds } 4101da177e4SLinus Torvalds } 4111da177e4SLinus Torvalds 4121da177e4SLinus Torvalds /* 4131da177e4SLinus Torvalds * Tx FIFO sizes: 4141da177e4SLinus Torvalds * CS4237B - 16 bytes 4151da177e4SLinus Torvalds * AudioDrive ES1688 - 12 bytes 4161da177e4SLinus Torvalds * S3 SonicVibes - 8 bytes 4171da177e4SLinus Torvalds * SoundBlaster AWE 64 - 2 bytes (ugly hardware) 4181da177e4SLinus Torvalds */ 4191da177e4SLinus Torvalds 4201da177e4SLinus Torvalds /* 4211da177e4SLinus Torvalds * write output pending bytes 4221da177e4SLinus Torvalds * call with output_lock spinlock held 4231da177e4SLinus Torvalds */ 424e1fad17bSTakashi Iwai static void snd_mpu401_uart_output_write(struct snd_mpu401 * mpu) 4251da177e4SLinus Torvalds { 4261da177e4SLinus Torvalds unsigned char byte; 427ea6b5828SClemens Ladisch int max = 256; 4281da177e4SLinus Torvalds 4291da177e4SLinus Torvalds do { 4302851d963STakashi Iwai if (snd_rawmidi_transmit_peek(mpu->substream_output, 4312851d963STakashi Iwai &byte, 1) == 1) { 432ea6b5828SClemens Ladisch /* 433ea6b5828SClemens Ladisch * Try twice because there is hardware that insists on 434ea6b5828SClemens Ladisch * setting the output busy bit after each write. 435ea6b5828SClemens Ladisch */ 436ea6b5828SClemens Ladisch if (!snd_mpu401_output_ready(mpu) && 437ea6b5828SClemens Ladisch !snd_mpu401_output_ready(mpu)) 4381da177e4SLinus Torvalds break; /* Tx FIFO full - try again later */ 4392851d963STakashi Iwai mpu->write(mpu, byte, MPU401D(mpu)); 4402851d963STakashi Iwai snd_rawmidi_transmit_ack(mpu->substream_output, 1); 4411da177e4SLinus Torvalds } else { 4421da177e4SLinus Torvalds snd_mpu401_uart_remove_timer (mpu, 0); 4431da177e4SLinus Torvalds break; /* no other data - leave the tx loop */ 4441da177e4SLinus Torvalds } 4451da177e4SLinus Torvalds } while (--max > 0); 4461da177e4SLinus Torvalds } 4471da177e4SLinus Torvalds 4481da177e4SLinus Torvalds /* 4491da177e4SLinus Torvalds * output trigger callback 4501da177e4SLinus Torvalds */ 4512851d963STakashi Iwai static void 4522851d963STakashi Iwai snd_mpu401_uart_output_trigger(struct snd_rawmidi_substream *substream, int up) 4531da177e4SLinus Torvalds { 4541da177e4SLinus Torvalds unsigned long flags; 455e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 4561da177e4SLinus Torvalds 4571da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 4581da177e4SLinus Torvalds if (up) { 4591da177e4SLinus Torvalds set_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode); 4601da177e4SLinus Torvalds 4611da177e4SLinus Torvalds /* try to add the timer at each output trigger, 4621da177e4SLinus Torvalds * since the output timer might have been removed in 4631da177e4SLinus Torvalds * snd_mpu401_uart_output_write(). 4641da177e4SLinus Torvalds */ 465302e4c2fSTakashi Iwai if (! (mpu->info_flags & MPU401_INFO_TX_IRQ)) 4661da177e4SLinus Torvalds snd_mpu401_uart_add_timer(mpu, 0); 4671da177e4SLinus Torvalds 4681da177e4SLinus Torvalds /* output pending data */ 4691da177e4SLinus Torvalds spin_lock_irqsave(&mpu->output_lock, flags); 4701da177e4SLinus Torvalds snd_mpu401_uart_output_write(mpu); 4711da177e4SLinus Torvalds spin_unlock_irqrestore(&mpu->output_lock, flags); 4721da177e4SLinus Torvalds } else { 473302e4c2fSTakashi Iwai if (! (mpu->info_flags & MPU401_INFO_TX_IRQ)) 4741da177e4SLinus Torvalds snd_mpu401_uart_remove_timer(mpu, 0); 4751da177e4SLinus Torvalds clear_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode); 4761da177e4SLinus Torvalds } 4771da177e4SLinus Torvalds } 4781da177e4SLinus Torvalds 4791da177e4SLinus Torvalds /* 4801da177e4SLinus Torvalds 4811da177e4SLinus Torvalds */ 4821da177e4SLinus Torvalds 483c36f486dSTakashi Iwai static const struct snd_rawmidi_ops snd_mpu401_uart_output = 4841da177e4SLinus Torvalds { 4851da177e4SLinus Torvalds .open = snd_mpu401_uart_output_open, 4861da177e4SLinus Torvalds .close = snd_mpu401_uart_output_close, 4871da177e4SLinus Torvalds .trigger = snd_mpu401_uart_output_trigger, 4881da177e4SLinus Torvalds }; 4891da177e4SLinus Torvalds 490c36f486dSTakashi Iwai static const struct snd_rawmidi_ops snd_mpu401_uart_input = 4911da177e4SLinus Torvalds { 4921da177e4SLinus Torvalds .open = snd_mpu401_uart_input_open, 4931da177e4SLinus Torvalds .close = snd_mpu401_uart_input_close, 4941da177e4SLinus Torvalds .trigger = snd_mpu401_uart_input_trigger, 4951da177e4SLinus Torvalds }; 4961da177e4SLinus Torvalds 497e1fad17bSTakashi Iwai static void snd_mpu401_uart_free(struct snd_rawmidi *rmidi) 4981da177e4SLinus Torvalds { 499e1fad17bSTakashi Iwai struct snd_mpu401 *mpu = rmidi->private_data; 500dba8b469SClemens Ladisch if (mpu->irq >= 0) 5011da177e4SLinus Torvalds free_irq(mpu->irq, (void *) mpu); 502b1d5776dSTakashi Iwai release_and_free_resource(mpu->res); 5031da177e4SLinus Torvalds kfree(mpu); 5041da177e4SLinus Torvalds } 5051da177e4SLinus Torvalds 5061da177e4SLinus Torvalds /** 5071da177e4SLinus Torvalds * snd_mpu401_uart_new - create an MPU401-UART instance 5081da177e4SLinus Torvalds * @card: the card instance 5091da177e4SLinus Torvalds * @device: the device index, zero-based 5101da177e4SLinus Torvalds * @hardware: the hardware type, MPU401_HW_XXXX 5111da177e4SLinus Torvalds * @port: the base address of MPU401 port 512302e4c2fSTakashi Iwai * @info_flags: bitflags MPU401_INFO_XXX 513dba8b469SClemens Ladisch * @irq: the ISA irq number, -1 if not to be allocated 5141da177e4SLinus Torvalds * @rrawmidi: the pointer to store the new rawmidi instance 5151da177e4SLinus Torvalds * 5161da177e4SLinus Torvalds * Creates a new MPU-401 instance. 5171da177e4SLinus Torvalds * 5181da177e4SLinus Torvalds * Note that the rawmidi instance is returned on the rrawmidi argument, 5191da177e4SLinus Torvalds * not the mpu401 instance itself. To access to the mpu401 instance, 520e1fad17bSTakashi Iwai * cast from rawmidi->private_data (with struct snd_mpu401 magic-cast). 5211da177e4SLinus Torvalds * 522eb7c06e8SYacine Belkadi * Return: Zero if successful, or a negative error code. 5231da177e4SLinus Torvalds */ 524e1fad17bSTakashi Iwai int snd_mpu401_uart_new(struct snd_card *card, int device, 5251da177e4SLinus Torvalds unsigned short hardware, 526302e4c2fSTakashi Iwai unsigned long port, 527302e4c2fSTakashi Iwai unsigned int info_flags, 528dba8b469SClemens Ladisch int irq, 529e1fad17bSTakashi Iwai struct snd_rawmidi ** rrawmidi) 5301da177e4SLinus Torvalds { 531e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 532e1fad17bSTakashi Iwai struct snd_rawmidi *rmidi; 533302e4c2fSTakashi Iwai int in_enable, out_enable; 5341da177e4SLinus Torvalds int err; 5351da177e4SLinus Torvalds 5361da177e4SLinus Torvalds if (rrawmidi) 5371da177e4SLinus Torvalds *rrawmidi = NULL; 538302e4c2fSTakashi Iwai if (! (info_flags & (MPU401_INFO_INPUT | MPU401_INFO_OUTPUT))) 539302e4c2fSTakashi Iwai info_flags |= MPU401_INFO_INPUT | MPU401_INFO_OUTPUT; 540302e4c2fSTakashi Iwai in_enable = (info_flags & MPU401_INFO_INPUT) ? 1 : 0; 541302e4c2fSTakashi Iwai out_enable = (info_flags & MPU401_INFO_OUTPUT) ? 1 : 0; 542302e4c2fSTakashi Iwai if ((err = snd_rawmidi_new(card, "MPU-401U", device, 543302e4c2fSTakashi Iwai out_enable, in_enable, &rmidi)) < 0) 5441da177e4SLinus Torvalds return err; 545561b220aSTakashi Iwai mpu = kzalloc(sizeof(*mpu), GFP_KERNEL); 546f1a77dc1SMarkus Elfring if (!mpu) { 547ec1f43c8SMarkus Elfring err = -ENOMEM; 548ec1f43c8SMarkus Elfring goto free_device; 5491da177e4SLinus Torvalds } 5501da177e4SLinus Torvalds rmidi->private_data = mpu; 5511da177e4SLinus Torvalds rmidi->private_free = snd_mpu401_uart_free; 5521da177e4SLinus Torvalds spin_lock_init(&mpu->input_lock); 5531da177e4SLinus Torvalds spin_lock_init(&mpu->output_lock); 5541da177e4SLinus Torvalds spin_lock_init(&mpu->timer_lock); 5551da177e4SLinus Torvalds mpu->hardware = hardware; 556bc733d49STakashi Iwai mpu->irq = -1; 557302e4c2fSTakashi Iwai if (! (info_flags & MPU401_INFO_INTEGRATED)) { 5581da177e4SLinus Torvalds int res_size = hardware == MPU401_HW_PC98II ? 4 : 2; 5592851d963STakashi Iwai mpu->res = request_region(port, res_size, "MPU401 UART"); 560f1a77dc1SMarkus Elfring if (!mpu->res) { 5612851d963STakashi Iwai snd_printk(KERN_ERR "mpu401_uart: " 5622851d963STakashi Iwai "unable to grab port 0x%lx size %d\n", 5632851d963STakashi Iwai port, res_size); 564ec1f43c8SMarkus Elfring err = -EBUSY; 565ec1f43c8SMarkus Elfring goto free_device; 5661da177e4SLinus Torvalds } 5671da177e4SLinus Torvalds } 568302e4c2fSTakashi Iwai if (info_flags & MPU401_INFO_MMIO) { 5691da177e4SLinus Torvalds mpu->write = mpu401_write_mmio; 5701da177e4SLinus Torvalds mpu->read = mpu401_read_mmio; 571302e4c2fSTakashi Iwai } else { 5721da177e4SLinus Torvalds mpu->write = mpu401_write_port; 5731da177e4SLinus Torvalds mpu->read = mpu401_read_port; 5741da177e4SLinus Torvalds } 5751da177e4SLinus Torvalds mpu->port = port; 5761da177e4SLinus Torvalds if (hardware == MPU401_HW_PC98II) 5771da177e4SLinus Torvalds mpu->cport = port + 2; 5781da177e4SLinus Torvalds else 5791da177e4SLinus Torvalds mpu->cport = port + 1; 580dba8b469SClemens Ladisch if (irq >= 0) { 58188e24c3aSYong Zhang if (request_irq(irq, snd_mpu401_uart_interrupt, 0, 5822851d963STakashi Iwai "MPU401 UART", (void *) mpu)) { 5832851d963STakashi Iwai snd_printk(KERN_ERR "mpu401_uart: " 5842851d963STakashi Iwai "unable to grab IRQ %d\n", irq); 585ec1f43c8SMarkus Elfring err = -EBUSY; 586ec1f43c8SMarkus Elfring goto free_device; 5871da177e4SLinus Torvalds } 5881da177e4SLinus Torvalds } 589dba8b469SClemens Ladisch if (irq < 0 && !(info_flags & MPU401_INFO_IRQ_HOOK)) 590dba8b469SClemens Ladisch info_flags |= MPU401_INFO_USE_TIMER; 591302e4c2fSTakashi Iwai mpu->info_flags = info_flags; 5921da177e4SLinus Torvalds mpu->irq = irq; 5931da177e4SLinus Torvalds if (card->shortname[0]) 5942851d963STakashi Iwai snprintf(rmidi->name, sizeof(rmidi->name), "%s MIDI", 5952851d963STakashi Iwai card->shortname); 5961da177e4SLinus Torvalds else 5971da177e4SLinus Torvalds sprintf(rmidi->name, "MPU-401 MIDI %d-%d",card->number, device); 598302e4c2fSTakashi Iwai if (out_enable) { 5992851d963STakashi Iwai snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, 6002851d963STakashi Iwai &snd_mpu401_uart_output); 601302e4c2fSTakashi Iwai rmidi->info_flags |= SNDRV_RAWMIDI_INFO_OUTPUT; 602302e4c2fSTakashi Iwai } 603302e4c2fSTakashi Iwai if (in_enable) { 6042851d963STakashi Iwai snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, 6052851d963STakashi Iwai &snd_mpu401_uart_input); 606302e4c2fSTakashi Iwai rmidi->info_flags |= SNDRV_RAWMIDI_INFO_INPUT; 607302e4c2fSTakashi Iwai if (out_enable) 608302e4c2fSTakashi Iwai rmidi->info_flags |= SNDRV_RAWMIDI_INFO_DUPLEX; 609302e4c2fSTakashi Iwai } 6101da177e4SLinus Torvalds mpu->rmidi = rmidi; 6111da177e4SLinus Torvalds if (rrawmidi) 6121da177e4SLinus Torvalds *rrawmidi = rmidi; 6131da177e4SLinus Torvalds return 0; 614ec1f43c8SMarkus Elfring free_device: 615ec1f43c8SMarkus Elfring snd_device_free(card, rmidi); 616ec1f43c8SMarkus Elfring return err; 6171da177e4SLinus Torvalds } 6181da177e4SLinus Torvalds 6191da177e4SLinus Torvalds EXPORT_SYMBOL(snd_mpu401_uart_new); 6201da177e4SLinus Torvalds 6211da177e4SLinus Torvalds /* 6221da177e4SLinus Torvalds * INIT part 6231da177e4SLinus Torvalds */ 6241da177e4SLinus Torvalds 6251da177e4SLinus Torvalds static int __init alsa_mpu401_uart_init(void) 6261da177e4SLinus Torvalds { 6271da177e4SLinus Torvalds return 0; 6281da177e4SLinus Torvalds } 6291da177e4SLinus Torvalds 6301da177e4SLinus Torvalds static void __exit alsa_mpu401_uart_exit(void) 6311da177e4SLinus Torvalds { 6321da177e4SLinus Torvalds } 6331da177e4SLinus Torvalds 6341da177e4SLinus Torvalds module_init(alsa_mpu401_uart_init) 6351da177e4SLinus Torvalds module_exit(alsa_mpu401_uart_exit) 636