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 61da177e4SLinus Torvalds * interrupts thus output is done via polling. Also, if irq < 0, then 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 311da177e4SLinus Torvalds #include <asm/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> 361da177e4SLinus Torvalds #include <linux/interrupt.h> 371da177e4SLinus Torvalds #include <linux/errno.h> 381da177e4SLinus Torvalds #include <sound/core.h> 391da177e4SLinus Torvalds #include <sound/mpu401.h> 401da177e4SLinus Torvalds 41c1017a4cSJaroslav Kysela MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>"); 421da177e4SLinus Torvalds MODULE_DESCRIPTION("Routines for control of MPU-401 in UART mode"); 431da177e4SLinus Torvalds MODULE_LICENSE("GPL"); 441da177e4SLinus Torvalds 45e1fad17bSTakashi Iwai static void snd_mpu401_uart_input_read(struct snd_mpu401 * mpu); 46e1fad17bSTakashi Iwai static void snd_mpu401_uart_output_write(struct snd_mpu401 * mpu); 471da177e4SLinus Torvalds 481da177e4SLinus Torvalds /* 491da177e4SLinus Torvalds 501da177e4SLinus Torvalds */ 511da177e4SLinus Torvalds 52b415ed45STakashi Iwai #define snd_mpu401_input_avail(mpu) \ 53b415ed45STakashi Iwai (!(mpu->read(mpu, MPU401C(mpu)) & MPU401_RX_EMPTY)) 54b415ed45STakashi Iwai #define snd_mpu401_output_ready(mpu) \ 55b415ed45STakashi Iwai (!(mpu->read(mpu, MPU401C(mpu)) & MPU401_TX_FULL)) 561da177e4SLinus Torvalds 571da177e4SLinus Torvalds /* Build in lowlevel io */ 582851d963STakashi Iwai static void mpu401_write_port(struct snd_mpu401 *mpu, unsigned char data, 592851d963STakashi Iwai unsigned long addr) 601da177e4SLinus Torvalds { 611da177e4SLinus Torvalds outb(data, addr); 621da177e4SLinus Torvalds } 631da177e4SLinus Torvalds 642851d963STakashi Iwai static unsigned char mpu401_read_port(struct snd_mpu401 *mpu, 652851d963STakashi Iwai unsigned long addr) 661da177e4SLinus Torvalds { 671da177e4SLinus Torvalds return inb(addr); 681da177e4SLinus Torvalds } 691da177e4SLinus Torvalds 702851d963STakashi Iwai static void mpu401_write_mmio(struct snd_mpu401 *mpu, unsigned char data, 712851d963STakashi Iwai unsigned long addr) 721da177e4SLinus Torvalds { 731da177e4SLinus Torvalds writeb(data, (void __iomem *)addr); 741da177e4SLinus Torvalds } 751da177e4SLinus Torvalds 762851d963STakashi Iwai static unsigned char mpu401_read_mmio(struct snd_mpu401 *mpu, 772851d963STakashi Iwai unsigned long addr) 781da177e4SLinus Torvalds { 791da177e4SLinus Torvalds return readb((void __iomem *)addr); 801da177e4SLinus Torvalds } 811da177e4SLinus Torvalds /* */ 821da177e4SLinus Torvalds 83e1fad17bSTakashi Iwai static void snd_mpu401_uart_clear_rx(struct snd_mpu401 *mpu) 841da177e4SLinus Torvalds { 851da177e4SLinus Torvalds int timeout = 100000; 861da177e4SLinus Torvalds for (; timeout > 0 && snd_mpu401_input_avail(mpu); timeout--) 871da177e4SLinus Torvalds mpu->read(mpu, MPU401D(mpu)); 881da177e4SLinus Torvalds #ifdef CONFIG_SND_DEBUG 891da177e4SLinus Torvalds if (timeout <= 0) 902851d963STakashi Iwai snd_printk(KERN_ERR "cmd: clear rx timeout (status = 0x%x)\n", 912851d963STakashi Iwai mpu->read(mpu, MPU401C(mpu))); 921da177e4SLinus Torvalds #endif 931da177e4SLinus Torvalds } 941da177e4SLinus Torvalds 95302e4c2fSTakashi Iwai static void uart_interrupt_tx(struct snd_mpu401 *mpu) 961da177e4SLinus Torvalds { 9760fac85fSClemens Ladisch unsigned long flags; 9860fac85fSClemens Ladisch 991da177e4SLinus Torvalds if (test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode) && 1001da177e4SLinus Torvalds test_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode)) { 10160fac85fSClemens Ladisch spin_lock_irqsave(&mpu->output_lock, flags); 1021da177e4SLinus Torvalds snd_mpu401_uart_output_write(mpu); 10360fac85fSClemens Ladisch spin_unlock_irqrestore(&mpu->output_lock, flags); 1041da177e4SLinus Torvalds } 1051da177e4SLinus Torvalds } 1061da177e4SLinus Torvalds 107302e4c2fSTakashi Iwai static void _snd_mpu401_uart_interrupt(struct snd_mpu401 *mpu) 108302e4c2fSTakashi Iwai { 10960fac85fSClemens Ladisch unsigned long flags; 11060fac85fSClemens Ladisch 111302e4c2fSTakashi Iwai if (mpu->info_flags & MPU401_INFO_INPUT) { 11260fac85fSClemens Ladisch spin_lock_irqsave(&mpu->input_lock, flags); 113302e4c2fSTakashi Iwai if (test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode)) 114302e4c2fSTakashi Iwai snd_mpu401_uart_input_read(mpu); 115302e4c2fSTakashi Iwai else 116302e4c2fSTakashi Iwai snd_mpu401_uart_clear_rx(mpu); 11760fac85fSClemens Ladisch spin_unlock_irqrestore(&mpu->input_lock, flags); 118302e4c2fSTakashi Iwai } 119302e4c2fSTakashi Iwai if (! (mpu->info_flags & MPU401_INFO_TX_IRQ)) 120302e4c2fSTakashi Iwai /* ok. for better Tx performance try do some output 121302e4c2fSTakashi Iwai when input is done */ 122302e4c2fSTakashi Iwai uart_interrupt_tx(mpu); 123302e4c2fSTakashi Iwai } 124302e4c2fSTakashi Iwai 1251da177e4SLinus Torvalds /** 1261da177e4SLinus Torvalds * snd_mpu401_uart_interrupt - generic MPU401-UART interrupt handler 1271da177e4SLinus Torvalds * @irq: the irq number 1281da177e4SLinus Torvalds * @dev_id: mpu401 instance 1291da177e4SLinus Torvalds * 1301da177e4SLinus Torvalds * Processes the interrupt for MPU401-UART i/o. 1311da177e4SLinus Torvalds */ 1327d12e780SDavid Howells irqreturn_t snd_mpu401_uart_interrupt(int irq, void *dev_id) 1331da177e4SLinus Torvalds { 134e1fad17bSTakashi Iwai struct snd_mpu401 *mpu = dev_id; 1351da177e4SLinus Torvalds 1361da177e4SLinus Torvalds if (mpu == NULL) 1371da177e4SLinus Torvalds return IRQ_NONE; 1381da177e4SLinus Torvalds _snd_mpu401_uart_interrupt(mpu); 1391da177e4SLinus Torvalds return IRQ_HANDLED; 1401da177e4SLinus Torvalds } 1411da177e4SLinus Torvalds 1422851d963STakashi Iwai EXPORT_SYMBOL(snd_mpu401_uart_interrupt); 1432851d963STakashi Iwai 144302e4c2fSTakashi Iwai /** 145302e4c2fSTakashi Iwai * snd_mpu401_uart_interrupt_tx - generic MPU401-UART transmit irq handler 146302e4c2fSTakashi Iwai * @irq: the irq number 147302e4c2fSTakashi Iwai * @dev_id: mpu401 instance 148302e4c2fSTakashi Iwai * 149302e4c2fSTakashi Iwai * Processes the interrupt for MPU401-UART output. 150302e4c2fSTakashi Iwai */ 1517d12e780SDavid Howells irqreturn_t snd_mpu401_uart_interrupt_tx(int irq, void *dev_id) 152302e4c2fSTakashi Iwai { 153302e4c2fSTakashi Iwai struct snd_mpu401 *mpu = dev_id; 154302e4c2fSTakashi Iwai 155302e4c2fSTakashi Iwai if (mpu == NULL) 156302e4c2fSTakashi Iwai return IRQ_NONE; 157302e4c2fSTakashi Iwai uart_interrupt_tx(mpu); 158302e4c2fSTakashi Iwai return IRQ_HANDLED; 159302e4c2fSTakashi Iwai } 160302e4c2fSTakashi Iwai 161302e4c2fSTakashi Iwai EXPORT_SYMBOL(snd_mpu401_uart_interrupt_tx); 162302e4c2fSTakashi Iwai 1631da177e4SLinus Torvalds /* 1641da177e4SLinus Torvalds * timer callback 1651da177e4SLinus Torvalds * reprogram the timer and call the interrupt job 1661da177e4SLinus Torvalds */ 1671da177e4SLinus Torvalds static void snd_mpu401_uart_timer(unsigned long data) 1681da177e4SLinus Torvalds { 169e1fad17bSTakashi Iwai struct snd_mpu401 *mpu = (struct snd_mpu401 *)data; 170b32425acSTakashi Iwai unsigned long flags; 1711da177e4SLinus Torvalds 172b32425acSTakashi Iwai spin_lock_irqsave(&mpu->timer_lock, flags); 1731da177e4SLinus Torvalds /*mpu->mode |= MPU401_MODE_TIMER;*/ 1741da177e4SLinus Torvalds mpu->timer.expires = 1 + jiffies; 1751da177e4SLinus Torvalds add_timer(&mpu->timer); 176b32425acSTakashi Iwai spin_unlock_irqrestore(&mpu->timer_lock, flags); 1771da177e4SLinus Torvalds if (mpu->rmidi) 1781da177e4SLinus Torvalds _snd_mpu401_uart_interrupt(mpu); 1791da177e4SLinus Torvalds } 1801da177e4SLinus Torvalds 1811da177e4SLinus Torvalds /* 1821da177e4SLinus Torvalds * initialize the timer callback if not programmed yet 1831da177e4SLinus Torvalds */ 184e1fad17bSTakashi Iwai static void snd_mpu401_uart_add_timer (struct snd_mpu401 *mpu, int input) 1851da177e4SLinus Torvalds { 1861da177e4SLinus Torvalds unsigned long flags; 1871da177e4SLinus Torvalds 1881da177e4SLinus Torvalds spin_lock_irqsave (&mpu->timer_lock, flags); 1891da177e4SLinus Torvalds if (mpu->timer_invoked == 0) { 1901da177e4SLinus Torvalds init_timer(&mpu->timer); 1911da177e4SLinus Torvalds mpu->timer.data = (unsigned long)mpu; 1921da177e4SLinus Torvalds mpu->timer.function = snd_mpu401_uart_timer; 1931da177e4SLinus Torvalds mpu->timer.expires = 1 + jiffies; 1941da177e4SLinus Torvalds add_timer(&mpu->timer); 1951da177e4SLinus Torvalds } 1962851d963STakashi Iwai mpu->timer_invoked |= input ? MPU401_MODE_INPUT_TIMER : 1972851d963STakashi Iwai MPU401_MODE_OUTPUT_TIMER; 1981da177e4SLinus Torvalds spin_unlock_irqrestore (&mpu->timer_lock, flags); 1991da177e4SLinus Torvalds } 2001da177e4SLinus Torvalds 2011da177e4SLinus Torvalds /* 2021da177e4SLinus Torvalds * remove the timer callback if still active 2031da177e4SLinus Torvalds */ 204e1fad17bSTakashi Iwai static void snd_mpu401_uart_remove_timer (struct snd_mpu401 *mpu, int input) 2051da177e4SLinus Torvalds { 2061da177e4SLinus Torvalds unsigned long flags; 2071da177e4SLinus Torvalds 2081da177e4SLinus Torvalds spin_lock_irqsave (&mpu->timer_lock, flags); 2091da177e4SLinus Torvalds if (mpu->timer_invoked) { 2102851d963STakashi Iwai mpu->timer_invoked &= input ? ~MPU401_MODE_INPUT_TIMER : 2112851d963STakashi Iwai ~MPU401_MODE_OUTPUT_TIMER; 2121da177e4SLinus Torvalds if (! mpu->timer_invoked) 2131da177e4SLinus Torvalds del_timer(&mpu->timer); 2141da177e4SLinus Torvalds } 2151da177e4SLinus Torvalds spin_unlock_irqrestore (&mpu->timer_lock, flags); 2161da177e4SLinus Torvalds } 2171da177e4SLinus Torvalds 2181da177e4SLinus Torvalds /* 2192851d963STakashi Iwai * send a UART command 2202851d963STakashi Iwai * return zero if successful, non-zero for some errors 2211da177e4SLinus Torvalds */ 2221da177e4SLinus Torvalds 223962f831fSJon Masters static int snd_mpu401_uart_cmd(struct snd_mpu401 * mpu, unsigned char cmd, 224962f831fSJon Masters int ack) 2251da177e4SLinus Torvalds { 2261da177e4SLinus Torvalds unsigned long flags; 2271da177e4SLinus Torvalds int timeout, ok; 2281da177e4SLinus Torvalds 2291da177e4SLinus Torvalds spin_lock_irqsave(&mpu->input_lock, flags); 2301da177e4SLinus Torvalds if (mpu->hardware != MPU401_HW_TRID4DWAVE) { 2311da177e4SLinus Torvalds mpu->write(mpu, 0x00, MPU401D(mpu)); 2321da177e4SLinus Torvalds /*snd_mpu401_uart_clear_rx(mpu);*/ 2331da177e4SLinus Torvalds } 2341da177e4SLinus Torvalds /* ok. standard MPU-401 initialization */ 2351da177e4SLinus Torvalds if (mpu->hardware != MPU401_HW_SB) { 2362851d963STakashi Iwai for (timeout = 1000; timeout > 0 && 2372851d963STakashi Iwai !snd_mpu401_output_ready(mpu); timeout--) 2381da177e4SLinus Torvalds udelay(10); 2391da177e4SLinus Torvalds #ifdef CONFIG_SND_DEBUG 2401da177e4SLinus Torvalds if (!timeout) 2412851d963STakashi Iwai snd_printk(KERN_ERR "cmd: tx timeout (status = 0x%x)\n", 2422851d963STakashi Iwai mpu->read(mpu, MPU401C(mpu))); 2431da177e4SLinus Torvalds #endif 2441da177e4SLinus Torvalds } 2451da177e4SLinus Torvalds mpu->write(mpu, cmd, MPU401C(mpu)); 2461da177e4SLinus Torvalds if (ack) { 2471da177e4SLinus Torvalds ok = 0; 2481da177e4SLinus Torvalds timeout = 10000; 2491da177e4SLinus Torvalds while (!ok && timeout-- > 0) { 2501da177e4SLinus Torvalds if (snd_mpu401_input_avail(mpu)) { 2511da177e4SLinus Torvalds if (mpu->read(mpu, MPU401D(mpu)) == MPU401_ACK) 2521da177e4SLinus Torvalds ok = 1; 2531da177e4SLinus Torvalds } 2541da177e4SLinus Torvalds } 2551da177e4SLinus Torvalds if (!ok && mpu->read(mpu, MPU401D(mpu)) == MPU401_ACK) 2561da177e4SLinus Torvalds ok = 1; 2572851d963STakashi Iwai } else 2581da177e4SLinus Torvalds ok = 1; 2591da177e4SLinus Torvalds spin_unlock_irqrestore(&mpu->input_lock, flags); 260962f831fSJon Masters if (!ok) { 2612851d963STakashi Iwai snd_printk(KERN_ERR "cmd: 0x%x failed at 0x%lx " 2622851d963STakashi Iwai "(status = 0x%x, data = 0x%x)\n", cmd, mpu->port, 2632851d963STakashi Iwai mpu->read(mpu, MPU401C(mpu)), 2642851d963STakashi Iwai mpu->read(mpu, MPU401D(mpu))); 265962f831fSJon Masters return 1; 266962f831fSJon Masters } 267962f831fSJon Masters return 0; 2681da177e4SLinus Torvalds } 2691da177e4SLinus Torvalds 2708f7ba051STakashi Iwai static int snd_mpu401_do_reset(struct snd_mpu401 *mpu) 2718f7ba051STakashi Iwai { 2728f7ba051STakashi Iwai if (snd_mpu401_uart_cmd(mpu, MPU401_RESET, 1)) 2738f7ba051STakashi Iwai return -EIO; 274c1099fcbSClemens Ladisch if (snd_mpu401_uart_cmd(mpu, MPU401_ENTER_UART, 0)) 2758f7ba051STakashi Iwai return -EIO; 2768f7ba051STakashi Iwai return 0; 2778f7ba051STakashi Iwai } 2788f7ba051STakashi Iwai 2791da177e4SLinus Torvalds /* 2801da177e4SLinus Torvalds * input/output open/close - protected by open_mutex in rawmidi.c 2811da177e4SLinus Torvalds */ 282e1fad17bSTakashi Iwai static int snd_mpu401_uart_input_open(struct snd_rawmidi_substream *substream) 2831da177e4SLinus Torvalds { 284e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 2851da177e4SLinus Torvalds int err; 2861da177e4SLinus Torvalds 2871da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 2881da177e4SLinus Torvalds if (mpu->open_input && (err = mpu->open_input(mpu)) < 0) 2891da177e4SLinus Torvalds return err; 2901da177e4SLinus Torvalds if (! test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode)) { 2918f7ba051STakashi Iwai if (snd_mpu401_do_reset(mpu) < 0) 292962f831fSJon Masters goto error_out; 2931da177e4SLinus Torvalds } 2941da177e4SLinus Torvalds mpu->substream_input = substream; 2951da177e4SLinus Torvalds set_bit(MPU401_MODE_BIT_INPUT, &mpu->mode); 2961da177e4SLinus Torvalds return 0; 297962f831fSJon Masters 298962f831fSJon Masters error_out: 299962f831fSJon Masters if (mpu->open_input && mpu->close_input) 300962f831fSJon Masters mpu->close_input(mpu); 301962f831fSJon Masters return -EIO; 3021da177e4SLinus Torvalds } 3031da177e4SLinus Torvalds 304e1fad17bSTakashi Iwai static int snd_mpu401_uart_output_open(struct snd_rawmidi_substream *substream) 3051da177e4SLinus Torvalds { 306e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 3071da177e4SLinus Torvalds int err; 3081da177e4SLinus Torvalds 3091da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 3101da177e4SLinus Torvalds if (mpu->open_output && (err = mpu->open_output(mpu)) < 0) 3111da177e4SLinus Torvalds return err; 3121da177e4SLinus Torvalds if (! test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode)) { 3138f7ba051STakashi Iwai if (snd_mpu401_do_reset(mpu) < 0) 314962f831fSJon Masters goto error_out; 3151da177e4SLinus Torvalds } 3161da177e4SLinus Torvalds mpu->substream_output = substream; 3171da177e4SLinus Torvalds set_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode); 3181da177e4SLinus Torvalds return 0; 319962f831fSJon Masters 320962f831fSJon Masters error_out: 321962f831fSJon Masters if (mpu->open_output && mpu->close_output) 322962f831fSJon Masters mpu->close_output(mpu); 323962f831fSJon Masters return -EIO; 3241da177e4SLinus Torvalds } 3251da177e4SLinus Torvalds 326e1fad17bSTakashi Iwai static int snd_mpu401_uart_input_close(struct snd_rawmidi_substream *substream) 3271da177e4SLinus Torvalds { 328e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 329962f831fSJon Masters int err = 0; 3301da177e4SLinus Torvalds 3311da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 3321da177e4SLinus Torvalds clear_bit(MPU401_MODE_BIT_INPUT, &mpu->mode); 3331da177e4SLinus Torvalds mpu->substream_input = NULL; 3341da177e4SLinus Torvalds if (! test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode)) 335962f831fSJon Masters err = snd_mpu401_uart_cmd(mpu, MPU401_RESET, 0); 3361da177e4SLinus Torvalds if (mpu->close_input) 3371da177e4SLinus Torvalds mpu->close_input(mpu); 338962f831fSJon Masters if (err) 339962f831fSJon Masters return -EIO; 3401da177e4SLinus Torvalds return 0; 3411da177e4SLinus Torvalds } 3421da177e4SLinus Torvalds 343e1fad17bSTakashi Iwai static int snd_mpu401_uart_output_close(struct snd_rawmidi_substream *substream) 3441da177e4SLinus Torvalds { 345e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 346962f831fSJon Masters int err = 0; 3471da177e4SLinus Torvalds 3481da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 3491da177e4SLinus Torvalds clear_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode); 3501da177e4SLinus Torvalds mpu->substream_output = NULL; 3511da177e4SLinus Torvalds if (! test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode)) 352962f831fSJon Masters err = snd_mpu401_uart_cmd(mpu, MPU401_RESET, 0); 3531da177e4SLinus Torvalds if (mpu->close_output) 3541da177e4SLinus Torvalds mpu->close_output(mpu); 355962f831fSJon Masters if (err) 356962f831fSJon Masters return -EIO; 3571da177e4SLinus Torvalds return 0; 3581da177e4SLinus Torvalds } 3591da177e4SLinus Torvalds 3601da177e4SLinus Torvalds /* 3611da177e4SLinus Torvalds * trigger input callback 3621da177e4SLinus Torvalds */ 3632851d963STakashi Iwai static void 3642851d963STakashi Iwai snd_mpu401_uart_input_trigger(struct snd_rawmidi_substream *substream, int up) 3651da177e4SLinus Torvalds { 3661da177e4SLinus Torvalds unsigned long flags; 367e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 3681da177e4SLinus Torvalds int max = 64; 3691da177e4SLinus Torvalds 3701da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 3711da177e4SLinus Torvalds if (up) { 3722851d963STakashi Iwai if (! test_and_set_bit(MPU401_MODE_BIT_INPUT_TRIGGER, 3732851d963STakashi Iwai &mpu->mode)) { 3741da177e4SLinus Torvalds /* first time - flush FIFO */ 3751da177e4SLinus Torvalds while (max-- > 0) 3761da177e4SLinus Torvalds mpu->read(mpu, MPU401D(mpu)); 3771da177e4SLinus Torvalds if (mpu->irq < 0) 3781da177e4SLinus Torvalds snd_mpu401_uart_add_timer(mpu, 1); 3791da177e4SLinus Torvalds } 3801da177e4SLinus Torvalds 3811da177e4SLinus Torvalds /* read data in advance */ 3821da177e4SLinus Torvalds spin_lock_irqsave(&mpu->input_lock, flags); 3831da177e4SLinus Torvalds snd_mpu401_uart_input_read(mpu); 3841da177e4SLinus Torvalds spin_unlock_irqrestore(&mpu->input_lock, flags); 3851da177e4SLinus Torvalds } else { 3861da177e4SLinus Torvalds if (mpu->irq < 0) 3871da177e4SLinus Torvalds snd_mpu401_uart_remove_timer(mpu, 1); 3881da177e4SLinus Torvalds clear_bit(MPU401_MODE_BIT_INPUT_TRIGGER, &mpu->mode); 3891da177e4SLinus Torvalds } 390962f831fSJon Masters 3911da177e4SLinus Torvalds } 3921da177e4SLinus Torvalds 3931da177e4SLinus Torvalds /* 3941da177e4SLinus Torvalds * transfer input pending data 3951da177e4SLinus Torvalds * call with input_lock spinlock held 3961da177e4SLinus Torvalds */ 397e1fad17bSTakashi Iwai static void snd_mpu401_uart_input_read(struct snd_mpu401 * mpu) 3981da177e4SLinus Torvalds { 3991da177e4SLinus Torvalds int max = 128; 4001da177e4SLinus Torvalds unsigned char byte; 4011da177e4SLinus Torvalds 4021da177e4SLinus Torvalds while (max-- > 0) { 4032851d963STakashi Iwai if (! snd_mpu401_input_avail(mpu)) 4042851d963STakashi Iwai break; /* input not available */ 4051da177e4SLinus Torvalds byte = mpu->read(mpu, MPU401D(mpu)); 4061da177e4SLinus Torvalds if (test_bit(MPU401_MODE_BIT_INPUT_TRIGGER, &mpu->mode)) 4071da177e4SLinus Torvalds snd_rawmidi_receive(mpu->substream_input, &byte, 1); 4081da177e4SLinus Torvalds } 4091da177e4SLinus Torvalds } 4101da177e4SLinus Torvalds 4111da177e4SLinus Torvalds /* 4121da177e4SLinus Torvalds * Tx FIFO sizes: 4131da177e4SLinus Torvalds * CS4237B - 16 bytes 4141da177e4SLinus Torvalds * AudioDrive ES1688 - 12 bytes 4151da177e4SLinus Torvalds * S3 SonicVibes - 8 bytes 4161da177e4SLinus Torvalds * SoundBlaster AWE 64 - 2 bytes (ugly hardware) 4171da177e4SLinus Torvalds */ 4181da177e4SLinus Torvalds 4191da177e4SLinus Torvalds /* 4201da177e4SLinus Torvalds * write output pending bytes 4211da177e4SLinus Torvalds * call with output_lock spinlock held 4221da177e4SLinus Torvalds */ 423e1fad17bSTakashi Iwai static void snd_mpu401_uart_output_write(struct snd_mpu401 * mpu) 4241da177e4SLinus Torvalds { 4251da177e4SLinus Torvalds unsigned char byte; 426ea6b5828SClemens Ladisch int max = 256; 4271da177e4SLinus Torvalds 4281da177e4SLinus Torvalds do { 4292851d963STakashi Iwai if (snd_rawmidi_transmit_peek(mpu->substream_output, 4302851d963STakashi Iwai &byte, 1) == 1) { 431ea6b5828SClemens Ladisch /* 432ea6b5828SClemens Ladisch * Try twice because there is hardware that insists on 433ea6b5828SClemens Ladisch * setting the output busy bit after each write. 434ea6b5828SClemens Ladisch */ 435ea6b5828SClemens Ladisch if (!snd_mpu401_output_ready(mpu) && 436ea6b5828SClemens Ladisch !snd_mpu401_output_ready(mpu)) 4371da177e4SLinus Torvalds break; /* Tx FIFO full - try again later */ 4382851d963STakashi Iwai mpu->write(mpu, byte, MPU401D(mpu)); 4392851d963STakashi Iwai snd_rawmidi_transmit_ack(mpu->substream_output, 1); 4401da177e4SLinus Torvalds } else { 4411da177e4SLinus Torvalds snd_mpu401_uart_remove_timer (mpu, 0); 4421da177e4SLinus Torvalds break; /* no other data - leave the tx loop */ 4431da177e4SLinus Torvalds } 4441da177e4SLinus Torvalds } while (--max > 0); 4451da177e4SLinus Torvalds } 4461da177e4SLinus Torvalds 4471da177e4SLinus Torvalds /* 4481da177e4SLinus Torvalds * output trigger callback 4491da177e4SLinus Torvalds */ 4502851d963STakashi Iwai static void 4512851d963STakashi Iwai snd_mpu401_uart_output_trigger(struct snd_rawmidi_substream *substream, int up) 4521da177e4SLinus Torvalds { 4531da177e4SLinus Torvalds unsigned long flags; 454e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 4551da177e4SLinus Torvalds 4561da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 4571da177e4SLinus Torvalds if (up) { 4581da177e4SLinus Torvalds set_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode); 4591da177e4SLinus Torvalds 4601da177e4SLinus Torvalds /* try to add the timer at each output trigger, 4611da177e4SLinus Torvalds * since the output timer might have been removed in 4621da177e4SLinus Torvalds * snd_mpu401_uart_output_write(). 4631da177e4SLinus Torvalds */ 464302e4c2fSTakashi Iwai if (! (mpu->info_flags & MPU401_INFO_TX_IRQ)) 4651da177e4SLinus Torvalds snd_mpu401_uart_add_timer(mpu, 0); 4661da177e4SLinus Torvalds 4671da177e4SLinus Torvalds /* output pending data */ 4681da177e4SLinus Torvalds spin_lock_irqsave(&mpu->output_lock, flags); 4691da177e4SLinus Torvalds snd_mpu401_uart_output_write(mpu); 4701da177e4SLinus Torvalds spin_unlock_irqrestore(&mpu->output_lock, flags); 4711da177e4SLinus Torvalds } else { 472302e4c2fSTakashi Iwai if (! (mpu->info_flags & MPU401_INFO_TX_IRQ)) 4731da177e4SLinus Torvalds snd_mpu401_uart_remove_timer(mpu, 0); 4741da177e4SLinus Torvalds clear_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode); 4751da177e4SLinus Torvalds } 4761da177e4SLinus Torvalds } 4771da177e4SLinus Torvalds 4781da177e4SLinus Torvalds /* 4791da177e4SLinus Torvalds 4801da177e4SLinus Torvalds */ 4811da177e4SLinus Torvalds 482e1fad17bSTakashi Iwai static struct snd_rawmidi_ops snd_mpu401_uart_output = 4831da177e4SLinus Torvalds { 4841da177e4SLinus Torvalds .open = snd_mpu401_uart_output_open, 4851da177e4SLinus Torvalds .close = snd_mpu401_uart_output_close, 4861da177e4SLinus Torvalds .trigger = snd_mpu401_uart_output_trigger, 4871da177e4SLinus Torvalds }; 4881da177e4SLinus Torvalds 489e1fad17bSTakashi Iwai static struct snd_rawmidi_ops snd_mpu401_uart_input = 4901da177e4SLinus Torvalds { 4911da177e4SLinus Torvalds .open = snd_mpu401_uart_input_open, 4921da177e4SLinus Torvalds .close = snd_mpu401_uart_input_close, 4931da177e4SLinus Torvalds .trigger = snd_mpu401_uart_input_trigger, 4941da177e4SLinus Torvalds }; 4951da177e4SLinus Torvalds 496e1fad17bSTakashi Iwai static void snd_mpu401_uart_free(struct snd_rawmidi *rmidi) 4971da177e4SLinus Torvalds { 498e1fad17bSTakashi Iwai struct snd_mpu401 *mpu = rmidi->private_data; 4991da177e4SLinus Torvalds if (mpu->irq_flags && mpu->irq >= 0) 5001da177e4SLinus Torvalds free_irq(mpu->irq, (void *) mpu); 501b1d5776dSTakashi Iwai release_and_free_resource(mpu->res); 5021da177e4SLinus Torvalds kfree(mpu); 5031da177e4SLinus Torvalds } 5041da177e4SLinus Torvalds 5051da177e4SLinus Torvalds /** 5061da177e4SLinus Torvalds * snd_mpu401_uart_new - create an MPU401-UART instance 5071da177e4SLinus Torvalds * @card: the card instance 5081da177e4SLinus Torvalds * @device: the device index, zero-based 5091da177e4SLinus Torvalds * @hardware: the hardware type, MPU401_HW_XXXX 5101da177e4SLinus Torvalds * @port: the base address of MPU401 port 511302e4c2fSTakashi Iwai * @info_flags: bitflags MPU401_INFO_XXX 5121da177e4SLinus Torvalds * @irq: the irq number, -1 if no interrupt for mpu 5131da177e4SLinus Torvalds * @irq_flags: the irq request flags (SA_XXX), 0 if irq was already reserved. 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 * 5221da177e4SLinus Torvalds * Returns 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, 5281da177e4SLinus Torvalds int irq, int irq_flags, 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); 5461da177e4SLinus Torvalds if (mpu == NULL) { 54773e77ba0STakashi Iwai snd_printk(KERN_ERR "mpu401_uart: cannot allocate\n"); 5481da177e4SLinus Torvalds snd_device_free(card, rmidi); 5491da177e4SLinus Torvalds return -ENOMEM; 5501da177e4SLinus Torvalds } 5511da177e4SLinus Torvalds rmidi->private_data = mpu; 5521da177e4SLinus Torvalds rmidi->private_free = snd_mpu401_uart_free; 5531da177e4SLinus Torvalds spin_lock_init(&mpu->input_lock); 5541da177e4SLinus Torvalds spin_lock_init(&mpu->output_lock); 5551da177e4SLinus Torvalds spin_lock_init(&mpu->timer_lock); 5561da177e4SLinus Torvalds mpu->hardware = hardware; 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"); 5602851d963STakashi Iwai if (mpu->res == NULL) { 5612851d963STakashi Iwai snd_printk(KERN_ERR "mpu401_uart: " 5622851d963STakashi Iwai "unable to grab port 0x%lx size %d\n", 5632851d963STakashi Iwai port, res_size); 5641da177e4SLinus Torvalds snd_device_free(card, rmidi); 5651da177e4SLinus Torvalds return -EBUSY; 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; 5801da177e4SLinus Torvalds if (irq >= 0 && irq_flags) { 5812851d963STakashi Iwai if (request_irq(irq, snd_mpu401_uart_interrupt, irq_flags, 5822851d963STakashi Iwai "MPU401 UART", (void *) mpu)) { 5832851d963STakashi Iwai snd_printk(KERN_ERR "mpu401_uart: " 5842851d963STakashi Iwai "unable to grab IRQ %d\n", irq); 5851da177e4SLinus Torvalds snd_device_free(card, rmidi); 5861da177e4SLinus Torvalds return -EBUSY; 5871da177e4SLinus Torvalds } 5881da177e4SLinus Torvalds } 589302e4c2fSTakashi Iwai mpu->info_flags = info_flags; 5901da177e4SLinus Torvalds mpu->irq = irq; 5911da177e4SLinus Torvalds mpu->irq_flags = irq_flags; 5921da177e4SLinus Torvalds if (card->shortname[0]) 5932851d963STakashi Iwai snprintf(rmidi->name, sizeof(rmidi->name), "%s MIDI", 5942851d963STakashi Iwai card->shortname); 5951da177e4SLinus Torvalds else 5961da177e4SLinus Torvalds sprintf(rmidi->name, "MPU-401 MIDI %d-%d",card->number, device); 597302e4c2fSTakashi Iwai if (out_enable) { 5982851d963STakashi Iwai snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, 5992851d963STakashi Iwai &snd_mpu401_uart_output); 600302e4c2fSTakashi Iwai rmidi->info_flags |= SNDRV_RAWMIDI_INFO_OUTPUT; 601302e4c2fSTakashi Iwai } 602302e4c2fSTakashi Iwai if (in_enable) { 6032851d963STakashi Iwai snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, 6042851d963STakashi Iwai &snd_mpu401_uart_input); 605302e4c2fSTakashi Iwai rmidi->info_flags |= SNDRV_RAWMIDI_INFO_INPUT; 606302e4c2fSTakashi Iwai if (out_enable) 607302e4c2fSTakashi Iwai rmidi->info_flags |= SNDRV_RAWMIDI_INFO_DUPLEX; 608302e4c2fSTakashi Iwai } 6091da177e4SLinus Torvalds mpu->rmidi = rmidi; 6101da177e4SLinus Torvalds if (rrawmidi) 6111da177e4SLinus Torvalds *rrawmidi = rmidi; 6121da177e4SLinus Torvalds return 0; 6131da177e4SLinus Torvalds } 6141da177e4SLinus Torvalds 6151da177e4SLinus Torvalds EXPORT_SYMBOL(snd_mpu401_uart_new); 6161da177e4SLinus Torvalds 6171da177e4SLinus Torvalds /* 6181da177e4SLinus Torvalds * INIT part 6191da177e4SLinus Torvalds */ 6201da177e4SLinus Torvalds 6211da177e4SLinus Torvalds static int __init alsa_mpu401_uart_init(void) 6221da177e4SLinus Torvalds { 6231da177e4SLinus Torvalds return 0; 6241da177e4SLinus Torvalds } 6251da177e4SLinus Torvalds 6261da177e4SLinus Torvalds static void __exit alsa_mpu401_uart_exit(void) 6271da177e4SLinus Torvalds { 6281da177e4SLinus Torvalds } 6291da177e4SLinus Torvalds 6301da177e4SLinus Torvalds module_init(alsa_mpu401_uart_init) 6311da177e4SLinus Torvalds module_exit(alsa_mpu401_uart_exit) 632