11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * Copyright (c) by Jaroslav Kysela <perex@suse.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 <sound/driver.h> 321da177e4SLinus Torvalds #include <asm/io.h> 331da177e4SLinus Torvalds #include <linux/delay.h> 341da177e4SLinus Torvalds #include <linux/init.h> 351da177e4SLinus Torvalds #include <linux/slab.h> 361da177e4SLinus Torvalds #include <linux/ioport.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 421da177e4SLinus Torvalds MODULE_AUTHOR("Jaroslav Kysela <perex@suse.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 531da177e4SLinus Torvalds #define snd_mpu401_input_avail(mpu) (!(mpu->read(mpu, MPU401C(mpu)) & 0x80)) 541da177e4SLinus Torvalds #define snd_mpu401_output_ready(mpu) (!(mpu->read(mpu, MPU401C(mpu)) & 0x40)) 551da177e4SLinus Torvalds 561da177e4SLinus Torvalds #define MPU401_RESET 0xff 571da177e4SLinus Torvalds #define MPU401_ENTER_UART 0x3f 581da177e4SLinus Torvalds #define MPU401_ACK 0xfe 591da177e4SLinus Torvalds 601da177e4SLinus Torvalds /* Build in lowlevel io */ 612851d963STakashi Iwai static void mpu401_write_port(struct snd_mpu401 *mpu, unsigned char data, 622851d963STakashi Iwai unsigned long addr) 631da177e4SLinus Torvalds { 641da177e4SLinus Torvalds outb(data, addr); 651da177e4SLinus Torvalds } 661da177e4SLinus Torvalds 672851d963STakashi Iwai static unsigned char mpu401_read_port(struct snd_mpu401 *mpu, 682851d963STakashi Iwai unsigned long addr) 691da177e4SLinus Torvalds { 701da177e4SLinus Torvalds return inb(addr); 711da177e4SLinus Torvalds } 721da177e4SLinus Torvalds 732851d963STakashi Iwai static void mpu401_write_mmio(struct snd_mpu401 *mpu, unsigned char data, 742851d963STakashi Iwai unsigned long addr) 751da177e4SLinus Torvalds { 761da177e4SLinus Torvalds writeb(data, (void __iomem *)addr); 771da177e4SLinus Torvalds } 781da177e4SLinus Torvalds 792851d963STakashi Iwai static unsigned char mpu401_read_mmio(struct snd_mpu401 *mpu, 802851d963STakashi Iwai unsigned long addr) 811da177e4SLinus Torvalds { 821da177e4SLinus Torvalds return readb((void __iomem *)addr); 831da177e4SLinus Torvalds } 841da177e4SLinus Torvalds /* */ 851da177e4SLinus Torvalds 86e1fad17bSTakashi Iwai static void snd_mpu401_uart_clear_rx(struct snd_mpu401 *mpu) 871da177e4SLinus Torvalds { 881da177e4SLinus Torvalds int timeout = 100000; 891da177e4SLinus Torvalds for (; timeout > 0 && snd_mpu401_input_avail(mpu); timeout--) 901da177e4SLinus Torvalds mpu->read(mpu, MPU401D(mpu)); 911da177e4SLinus Torvalds #ifdef CONFIG_SND_DEBUG 921da177e4SLinus Torvalds if (timeout <= 0) 932851d963STakashi Iwai snd_printk(KERN_ERR "cmd: clear rx timeout (status = 0x%x)\n", 942851d963STakashi Iwai mpu->read(mpu, MPU401C(mpu))); 951da177e4SLinus Torvalds #endif 961da177e4SLinus Torvalds } 971da177e4SLinus Torvalds 98302e4c2fSTakashi Iwai static void uart_interrupt_tx(struct snd_mpu401 *mpu) 991da177e4SLinus Torvalds { 1001da177e4SLinus Torvalds if (test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode) && 1011da177e4SLinus Torvalds test_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode)) { 1021da177e4SLinus Torvalds spin_lock(&mpu->output_lock); 1031da177e4SLinus Torvalds snd_mpu401_uart_output_write(mpu); 1041da177e4SLinus Torvalds spin_unlock(&mpu->output_lock); 1051da177e4SLinus Torvalds } 1061da177e4SLinus Torvalds } 1071da177e4SLinus Torvalds 108302e4c2fSTakashi Iwai static void _snd_mpu401_uart_interrupt(struct snd_mpu401 *mpu) 109302e4c2fSTakashi Iwai { 110302e4c2fSTakashi Iwai if (mpu->info_flags & MPU401_INFO_INPUT) { 111302e4c2fSTakashi Iwai spin_lock(&mpu->input_lock); 112302e4c2fSTakashi Iwai if (test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode)) 113302e4c2fSTakashi Iwai snd_mpu401_uart_input_read(mpu); 114302e4c2fSTakashi Iwai else 115302e4c2fSTakashi Iwai snd_mpu401_uart_clear_rx(mpu); 116302e4c2fSTakashi Iwai spin_unlock(&mpu->input_lock); 117302e4c2fSTakashi Iwai } 118302e4c2fSTakashi Iwai if (! (mpu->info_flags & MPU401_INFO_TX_IRQ)) 119302e4c2fSTakashi Iwai /* ok. for better Tx performance try do some output 120302e4c2fSTakashi Iwai when input is done */ 121302e4c2fSTakashi Iwai uart_interrupt_tx(mpu); 122302e4c2fSTakashi Iwai } 123302e4c2fSTakashi Iwai 1241da177e4SLinus Torvalds /** 1251da177e4SLinus Torvalds * snd_mpu401_uart_interrupt - generic MPU401-UART interrupt handler 1261da177e4SLinus Torvalds * @irq: the irq number 1271da177e4SLinus Torvalds * @dev_id: mpu401 instance 1281da177e4SLinus Torvalds * 1291da177e4SLinus Torvalds * Processes the interrupt for MPU401-UART i/o. 1301da177e4SLinus Torvalds */ 1317d12e780SDavid Howells irqreturn_t snd_mpu401_uart_interrupt(int irq, void *dev_id) 1321da177e4SLinus Torvalds { 133e1fad17bSTakashi Iwai struct snd_mpu401 *mpu = dev_id; 1341da177e4SLinus Torvalds 1351da177e4SLinus Torvalds if (mpu == NULL) 1361da177e4SLinus Torvalds return IRQ_NONE; 1371da177e4SLinus Torvalds _snd_mpu401_uart_interrupt(mpu); 1381da177e4SLinus Torvalds return IRQ_HANDLED; 1391da177e4SLinus Torvalds } 1401da177e4SLinus Torvalds 1412851d963STakashi Iwai EXPORT_SYMBOL(snd_mpu401_uart_interrupt); 1422851d963STakashi Iwai 143302e4c2fSTakashi Iwai /** 144302e4c2fSTakashi Iwai * snd_mpu401_uart_interrupt_tx - generic MPU401-UART transmit irq handler 145302e4c2fSTakashi Iwai * @irq: the irq number 146302e4c2fSTakashi Iwai * @dev_id: mpu401 instance 147302e4c2fSTakashi Iwai * 148302e4c2fSTakashi Iwai * Processes the interrupt for MPU401-UART output. 149302e4c2fSTakashi Iwai */ 1507d12e780SDavid Howells irqreturn_t snd_mpu401_uart_interrupt_tx(int irq, void *dev_id) 151302e4c2fSTakashi Iwai { 152302e4c2fSTakashi Iwai struct snd_mpu401 *mpu = dev_id; 153302e4c2fSTakashi Iwai 154302e4c2fSTakashi Iwai if (mpu == NULL) 155302e4c2fSTakashi Iwai return IRQ_NONE; 156302e4c2fSTakashi Iwai uart_interrupt_tx(mpu); 157302e4c2fSTakashi Iwai return IRQ_HANDLED; 158302e4c2fSTakashi Iwai } 159302e4c2fSTakashi Iwai 160302e4c2fSTakashi Iwai EXPORT_SYMBOL(snd_mpu401_uart_interrupt_tx); 161302e4c2fSTakashi Iwai 1621da177e4SLinus Torvalds /* 1631da177e4SLinus Torvalds * timer callback 1641da177e4SLinus Torvalds * reprogram the timer and call the interrupt job 1651da177e4SLinus Torvalds */ 1661da177e4SLinus Torvalds static void snd_mpu401_uart_timer(unsigned long data) 1671da177e4SLinus Torvalds { 168e1fad17bSTakashi Iwai struct snd_mpu401 *mpu = (struct snd_mpu401 *)data; 169b32425acSTakashi Iwai unsigned long flags; 1701da177e4SLinus Torvalds 171b32425acSTakashi Iwai spin_lock_irqsave(&mpu->timer_lock, flags); 1721da177e4SLinus Torvalds /*mpu->mode |= MPU401_MODE_TIMER;*/ 1731da177e4SLinus Torvalds mpu->timer.expires = 1 + jiffies; 1741da177e4SLinus Torvalds add_timer(&mpu->timer); 175b32425acSTakashi Iwai spin_unlock_irqrestore(&mpu->timer_lock, flags); 1761da177e4SLinus Torvalds if (mpu->rmidi) 1771da177e4SLinus Torvalds _snd_mpu401_uart_interrupt(mpu); 1781da177e4SLinus Torvalds } 1791da177e4SLinus Torvalds 1801da177e4SLinus Torvalds /* 1811da177e4SLinus Torvalds * initialize the timer callback if not programmed yet 1821da177e4SLinus Torvalds */ 183e1fad17bSTakashi Iwai static void snd_mpu401_uart_add_timer (struct snd_mpu401 *mpu, int input) 1841da177e4SLinus Torvalds { 1851da177e4SLinus Torvalds unsigned long flags; 1861da177e4SLinus Torvalds 1871da177e4SLinus Torvalds spin_lock_irqsave (&mpu->timer_lock, flags); 1881da177e4SLinus Torvalds if (mpu->timer_invoked == 0) { 1891da177e4SLinus Torvalds init_timer(&mpu->timer); 1901da177e4SLinus Torvalds mpu->timer.data = (unsigned long)mpu; 1911da177e4SLinus Torvalds mpu->timer.function = snd_mpu401_uart_timer; 1921da177e4SLinus Torvalds mpu->timer.expires = 1 + jiffies; 1931da177e4SLinus Torvalds add_timer(&mpu->timer); 1941da177e4SLinus Torvalds } 1952851d963STakashi Iwai mpu->timer_invoked |= input ? MPU401_MODE_INPUT_TIMER : 1962851d963STakashi Iwai MPU401_MODE_OUTPUT_TIMER; 1971da177e4SLinus Torvalds spin_unlock_irqrestore (&mpu->timer_lock, flags); 1981da177e4SLinus Torvalds } 1991da177e4SLinus Torvalds 2001da177e4SLinus Torvalds /* 2011da177e4SLinus Torvalds * remove the timer callback if still active 2021da177e4SLinus Torvalds */ 203e1fad17bSTakashi Iwai static void snd_mpu401_uart_remove_timer (struct snd_mpu401 *mpu, int input) 2041da177e4SLinus Torvalds { 2051da177e4SLinus Torvalds unsigned long flags; 2061da177e4SLinus Torvalds 2071da177e4SLinus Torvalds spin_lock_irqsave (&mpu->timer_lock, flags); 2081da177e4SLinus Torvalds if (mpu->timer_invoked) { 2092851d963STakashi Iwai mpu->timer_invoked &= input ? ~MPU401_MODE_INPUT_TIMER : 2102851d963STakashi Iwai ~MPU401_MODE_OUTPUT_TIMER; 2111da177e4SLinus Torvalds if (! mpu->timer_invoked) 2121da177e4SLinus Torvalds del_timer(&mpu->timer); 2131da177e4SLinus Torvalds } 2141da177e4SLinus Torvalds spin_unlock_irqrestore (&mpu->timer_lock, flags); 2151da177e4SLinus Torvalds } 2161da177e4SLinus Torvalds 2171da177e4SLinus Torvalds /* 2182851d963STakashi Iwai * send a UART command 2192851d963STakashi Iwai * return zero if successful, non-zero for some errors 2201da177e4SLinus Torvalds */ 2211da177e4SLinus Torvalds 222962f831fSJon Masters static int snd_mpu401_uart_cmd(struct snd_mpu401 * mpu, unsigned char cmd, 223962f831fSJon Masters int ack) 2241da177e4SLinus Torvalds { 2251da177e4SLinus Torvalds unsigned long flags; 2261da177e4SLinus Torvalds int timeout, ok; 2271da177e4SLinus Torvalds 2281da177e4SLinus Torvalds spin_lock_irqsave(&mpu->input_lock, flags); 2291da177e4SLinus Torvalds if (mpu->hardware != MPU401_HW_TRID4DWAVE) { 2301da177e4SLinus Torvalds mpu->write(mpu, 0x00, MPU401D(mpu)); 2311da177e4SLinus Torvalds /*snd_mpu401_uart_clear_rx(mpu);*/ 2321da177e4SLinus Torvalds } 2331da177e4SLinus Torvalds /* ok. standard MPU-401 initialization */ 2341da177e4SLinus Torvalds if (mpu->hardware != MPU401_HW_SB) { 2352851d963STakashi Iwai for (timeout = 1000; timeout > 0 && 2362851d963STakashi Iwai !snd_mpu401_output_ready(mpu); timeout--) 2371da177e4SLinus Torvalds udelay(10); 2381da177e4SLinus Torvalds #ifdef CONFIG_SND_DEBUG 2391da177e4SLinus Torvalds if (!timeout) 2402851d963STakashi Iwai snd_printk(KERN_ERR "cmd: tx timeout (status = 0x%x)\n", 2412851d963STakashi Iwai mpu->read(mpu, MPU401C(mpu))); 2421da177e4SLinus Torvalds #endif 2431da177e4SLinus Torvalds } 2441da177e4SLinus Torvalds mpu->write(mpu, cmd, MPU401C(mpu)); 2451da177e4SLinus Torvalds if (ack) { 2461da177e4SLinus Torvalds ok = 0; 2471da177e4SLinus Torvalds timeout = 10000; 2481da177e4SLinus Torvalds while (!ok && timeout-- > 0) { 2491da177e4SLinus Torvalds if (snd_mpu401_input_avail(mpu)) { 2501da177e4SLinus Torvalds if (mpu->read(mpu, MPU401D(mpu)) == MPU401_ACK) 2511da177e4SLinus Torvalds ok = 1; 2521da177e4SLinus Torvalds } 2531da177e4SLinus Torvalds } 2541da177e4SLinus Torvalds if (!ok && mpu->read(mpu, MPU401D(mpu)) == MPU401_ACK) 2551da177e4SLinus Torvalds ok = 1; 2562851d963STakashi Iwai } else 2571da177e4SLinus Torvalds ok = 1; 2581da177e4SLinus Torvalds spin_unlock_irqrestore(&mpu->input_lock, flags); 259962f831fSJon Masters if (!ok) { 2602851d963STakashi Iwai snd_printk(KERN_ERR "cmd: 0x%x failed at 0x%lx " 2612851d963STakashi Iwai "(status = 0x%x, data = 0x%x)\n", cmd, mpu->port, 2622851d963STakashi Iwai mpu->read(mpu, MPU401C(mpu)), 2632851d963STakashi Iwai mpu->read(mpu, MPU401D(mpu))); 264962f831fSJon Masters return 1; 265962f831fSJon Masters } 266962f831fSJon Masters return 0; 2671da177e4SLinus Torvalds } 2681da177e4SLinus Torvalds 2698f7ba051STakashi Iwai static int snd_mpu401_do_reset(struct snd_mpu401 *mpu) 2708f7ba051STakashi Iwai { 2718f7ba051STakashi Iwai if (snd_mpu401_uart_cmd(mpu, MPU401_RESET, 1)) 2728f7ba051STakashi Iwai return -EIO; 273c1099fcbSClemens Ladisch if (snd_mpu401_uart_cmd(mpu, MPU401_ENTER_UART, 0)) 2748f7ba051STakashi Iwai return -EIO; 2758f7ba051STakashi Iwai return 0; 2768f7ba051STakashi Iwai } 2778f7ba051STakashi Iwai 2781da177e4SLinus Torvalds /* 2791da177e4SLinus Torvalds * input/output open/close - protected by open_mutex in rawmidi.c 2801da177e4SLinus Torvalds */ 281e1fad17bSTakashi Iwai static int snd_mpu401_uart_input_open(struct snd_rawmidi_substream *substream) 2821da177e4SLinus Torvalds { 283e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 2841da177e4SLinus Torvalds int err; 2851da177e4SLinus Torvalds 2861da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 2871da177e4SLinus Torvalds if (mpu->open_input && (err = mpu->open_input(mpu)) < 0) 2881da177e4SLinus Torvalds return err; 2891da177e4SLinus Torvalds if (! test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode)) { 2908f7ba051STakashi Iwai if (snd_mpu401_do_reset(mpu) < 0) 291962f831fSJon Masters goto error_out; 2921da177e4SLinus Torvalds } 2931da177e4SLinus Torvalds mpu->substream_input = substream; 2941da177e4SLinus Torvalds set_bit(MPU401_MODE_BIT_INPUT, &mpu->mode); 2951da177e4SLinus Torvalds return 0; 296962f831fSJon Masters 297962f831fSJon Masters error_out: 298962f831fSJon Masters if (mpu->open_input && mpu->close_input) 299962f831fSJon Masters mpu->close_input(mpu); 300962f831fSJon Masters return -EIO; 3011da177e4SLinus Torvalds } 3021da177e4SLinus Torvalds 303e1fad17bSTakashi Iwai static int snd_mpu401_uart_output_open(struct snd_rawmidi_substream *substream) 3041da177e4SLinus Torvalds { 305e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 3061da177e4SLinus Torvalds int err; 3071da177e4SLinus Torvalds 3081da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 3091da177e4SLinus Torvalds if (mpu->open_output && (err = mpu->open_output(mpu)) < 0) 3101da177e4SLinus Torvalds return err; 3111da177e4SLinus Torvalds if (! test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode)) { 3128f7ba051STakashi Iwai if (snd_mpu401_do_reset(mpu) < 0) 313962f831fSJon Masters goto error_out; 3141da177e4SLinus Torvalds } 3151da177e4SLinus Torvalds mpu->substream_output = substream; 3161da177e4SLinus Torvalds set_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode); 3171da177e4SLinus Torvalds return 0; 318962f831fSJon Masters 319962f831fSJon Masters error_out: 320962f831fSJon Masters if (mpu->open_output && mpu->close_output) 321962f831fSJon Masters mpu->close_output(mpu); 322962f831fSJon Masters return -EIO; 3231da177e4SLinus Torvalds } 3241da177e4SLinus Torvalds 325e1fad17bSTakashi Iwai static int snd_mpu401_uart_input_close(struct snd_rawmidi_substream *substream) 3261da177e4SLinus Torvalds { 327e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 328962f831fSJon Masters int err = 0; 3291da177e4SLinus Torvalds 3301da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 3311da177e4SLinus Torvalds clear_bit(MPU401_MODE_BIT_INPUT, &mpu->mode); 3321da177e4SLinus Torvalds mpu->substream_input = NULL; 3331da177e4SLinus Torvalds if (! test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode)) 334962f831fSJon Masters err = snd_mpu401_uart_cmd(mpu, MPU401_RESET, 0); 3351da177e4SLinus Torvalds if (mpu->close_input) 3361da177e4SLinus Torvalds mpu->close_input(mpu); 337962f831fSJon Masters if (err) 338962f831fSJon Masters return -EIO; 3391da177e4SLinus Torvalds return 0; 3401da177e4SLinus Torvalds } 3411da177e4SLinus Torvalds 342e1fad17bSTakashi Iwai static int snd_mpu401_uart_output_close(struct snd_rawmidi_substream *substream) 3431da177e4SLinus Torvalds { 344e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 345962f831fSJon Masters int err = 0; 3461da177e4SLinus Torvalds 3471da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 3481da177e4SLinus Torvalds clear_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode); 3491da177e4SLinus Torvalds mpu->substream_output = NULL; 3501da177e4SLinus Torvalds if (! test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode)) 351962f831fSJon Masters err = snd_mpu401_uart_cmd(mpu, MPU401_RESET, 0); 3521da177e4SLinus Torvalds if (mpu->close_output) 3531da177e4SLinus Torvalds mpu->close_output(mpu); 354962f831fSJon Masters if (err) 355962f831fSJon Masters return -EIO; 3561da177e4SLinus Torvalds return 0; 3571da177e4SLinus Torvalds } 3581da177e4SLinus Torvalds 3591da177e4SLinus Torvalds /* 3601da177e4SLinus Torvalds * trigger input callback 3611da177e4SLinus Torvalds */ 3622851d963STakashi Iwai static void 3632851d963STakashi Iwai snd_mpu401_uart_input_trigger(struct snd_rawmidi_substream *substream, int up) 3641da177e4SLinus Torvalds { 3651da177e4SLinus Torvalds unsigned long flags; 366e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 3671da177e4SLinus Torvalds int max = 64; 3681da177e4SLinus Torvalds 3691da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 3701da177e4SLinus Torvalds if (up) { 3712851d963STakashi Iwai if (! test_and_set_bit(MPU401_MODE_BIT_INPUT_TRIGGER, 3722851d963STakashi Iwai &mpu->mode)) { 3731da177e4SLinus Torvalds /* first time - flush FIFO */ 3741da177e4SLinus Torvalds while (max-- > 0) 3751da177e4SLinus Torvalds mpu->read(mpu, MPU401D(mpu)); 3761da177e4SLinus Torvalds if (mpu->irq < 0) 3771da177e4SLinus Torvalds snd_mpu401_uart_add_timer(mpu, 1); 3781da177e4SLinus Torvalds } 3791da177e4SLinus Torvalds 3801da177e4SLinus Torvalds /* read data in advance */ 3811da177e4SLinus Torvalds spin_lock_irqsave(&mpu->input_lock, flags); 3821da177e4SLinus Torvalds snd_mpu401_uart_input_read(mpu); 3831da177e4SLinus Torvalds spin_unlock_irqrestore(&mpu->input_lock, flags); 3841da177e4SLinus Torvalds } else { 3851da177e4SLinus Torvalds if (mpu->irq < 0) 3861da177e4SLinus Torvalds snd_mpu401_uart_remove_timer(mpu, 1); 3871da177e4SLinus Torvalds clear_bit(MPU401_MODE_BIT_INPUT_TRIGGER, &mpu->mode); 3881da177e4SLinus Torvalds } 389962f831fSJon Masters 3901da177e4SLinus Torvalds } 3911da177e4SLinus Torvalds 3921da177e4SLinus Torvalds /* 3931da177e4SLinus Torvalds * transfer input pending data 3941da177e4SLinus Torvalds * call with input_lock spinlock held 3951da177e4SLinus Torvalds */ 396e1fad17bSTakashi Iwai static void snd_mpu401_uart_input_read(struct snd_mpu401 * mpu) 3971da177e4SLinus Torvalds { 3981da177e4SLinus Torvalds int max = 128; 3991da177e4SLinus Torvalds unsigned char byte; 4001da177e4SLinus Torvalds 4011da177e4SLinus Torvalds while (max-- > 0) { 4022851d963STakashi Iwai if (! snd_mpu401_input_avail(mpu)) 4032851d963STakashi Iwai break; /* input not available */ 4041da177e4SLinus Torvalds byte = mpu->read(mpu, MPU401D(mpu)); 4051da177e4SLinus Torvalds if (test_bit(MPU401_MODE_BIT_INPUT_TRIGGER, &mpu->mode)) 4061da177e4SLinus Torvalds snd_rawmidi_receive(mpu->substream_input, &byte, 1); 4071da177e4SLinus Torvalds } 4081da177e4SLinus Torvalds } 4091da177e4SLinus Torvalds 4101da177e4SLinus Torvalds /* 4111da177e4SLinus Torvalds * Tx FIFO sizes: 4121da177e4SLinus Torvalds * CS4237B - 16 bytes 4131da177e4SLinus Torvalds * AudioDrive ES1688 - 12 bytes 4141da177e4SLinus Torvalds * S3 SonicVibes - 8 bytes 4151da177e4SLinus Torvalds * SoundBlaster AWE 64 - 2 bytes (ugly hardware) 4161da177e4SLinus Torvalds */ 4171da177e4SLinus Torvalds 4181da177e4SLinus Torvalds /* 4191da177e4SLinus Torvalds * write output pending bytes 4201da177e4SLinus Torvalds * call with output_lock spinlock held 4211da177e4SLinus Torvalds */ 422e1fad17bSTakashi Iwai static void snd_mpu401_uart_output_write(struct snd_mpu401 * mpu) 4231da177e4SLinus Torvalds { 4241da177e4SLinus Torvalds unsigned char byte; 4251da177e4SLinus Torvalds int max = 256, timeout; 4261da177e4SLinus Torvalds 4271da177e4SLinus Torvalds do { 4282851d963STakashi Iwai if (snd_rawmidi_transmit_peek(mpu->substream_output, 4292851d963STakashi Iwai &byte, 1) == 1) { 4301da177e4SLinus Torvalds for (timeout = 100; timeout > 0; timeout--) { 4312851d963STakashi Iwai if (snd_mpu401_output_ready(mpu)) 4321da177e4SLinus Torvalds break; 4331da177e4SLinus Torvalds } 4341da177e4SLinus Torvalds if (timeout == 0) 4351da177e4SLinus Torvalds break; /* Tx FIFO full - try again later */ 4362851d963STakashi Iwai mpu->write(mpu, byte, MPU401D(mpu)); 4372851d963STakashi Iwai snd_rawmidi_transmit_ack(mpu->substream_output, 1); 4381da177e4SLinus Torvalds } else { 4391da177e4SLinus Torvalds snd_mpu401_uart_remove_timer (mpu, 0); 4401da177e4SLinus Torvalds break; /* no other data - leave the tx loop */ 4411da177e4SLinus Torvalds } 4421da177e4SLinus Torvalds } while (--max > 0); 4431da177e4SLinus Torvalds } 4441da177e4SLinus Torvalds 4451da177e4SLinus Torvalds /* 4461da177e4SLinus Torvalds * output trigger callback 4471da177e4SLinus Torvalds */ 4482851d963STakashi Iwai static void 4492851d963STakashi Iwai snd_mpu401_uart_output_trigger(struct snd_rawmidi_substream *substream, int up) 4501da177e4SLinus Torvalds { 4511da177e4SLinus Torvalds unsigned long flags; 452e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 4531da177e4SLinus Torvalds 4541da177e4SLinus Torvalds mpu = substream->rmidi->private_data; 4551da177e4SLinus Torvalds if (up) { 4561da177e4SLinus Torvalds set_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode); 4571da177e4SLinus Torvalds 4581da177e4SLinus Torvalds /* try to add the timer at each output trigger, 4591da177e4SLinus Torvalds * since the output timer might have been removed in 4601da177e4SLinus Torvalds * snd_mpu401_uart_output_write(). 4611da177e4SLinus Torvalds */ 462302e4c2fSTakashi Iwai if (! (mpu->info_flags & MPU401_INFO_TX_IRQ)) 4631da177e4SLinus Torvalds snd_mpu401_uart_add_timer(mpu, 0); 4641da177e4SLinus Torvalds 4651da177e4SLinus Torvalds /* output pending data */ 4661da177e4SLinus Torvalds spin_lock_irqsave(&mpu->output_lock, flags); 4671da177e4SLinus Torvalds snd_mpu401_uart_output_write(mpu); 4681da177e4SLinus Torvalds spin_unlock_irqrestore(&mpu->output_lock, flags); 4691da177e4SLinus Torvalds } else { 470302e4c2fSTakashi Iwai if (! (mpu->info_flags & MPU401_INFO_TX_IRQ)) 4711da177e4SLinus Torvalds snd_mpu401_uart_remove_timer(mpu, 0); 4721da177e4SLinus Torvalds clear_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode); 4731da177e4SLinus Torvalds } 4741da177e4SLinus Torvalds } 4751da177e4SLinus Torvalds 4761da177e4SLinus Torvalds /* 4771da177e4SLinus Torvalds 4781da177e4SLinus Torvalds */ 4791da177e4SLinus Torvalds 480e1fad17bSTakashi Iwai static struct snd_rawmidi_ops snd_mpu401_uart_output = 4811da177e4SLinus Torvalds { 4821da177e4SLinus Torvalds .open = snd_mpu401_uart_output_open, 4831da177e4SLinus Torvalds .close = snd_mpu401_uart_output_close, 4841da177e4SLinus Torvalds .trigger = snd_mpu401_uart_output_trigger, 4851da177e4SLinus Torvalds }; 4861da177e4SLinus Torvalds 487e1fad17bSTakashi Iwai static struct snd_rawmidi_ops snd_mpu401_uart_input = 4881da177e4SLinus Torvalds { 4891da177e4SLinus Torvalds .open = snd_mpu401_uart_input_open, 4901da177e4SLinus Torvalds .close = snd_mpu401_uart_input_close, 4911da177e4SLinus Torvalds .trigger = snd_mpu401_uart_input_trigger, 4921da177e4SLinus Torvalds }; 4931da177e4SLinus Torvalds 494e1fad17bSTakashi Iwai static void snd_mpu401_uart_free(struct snd_rawmidi *rmidi) 4951da177e4SLinus Torvalds { 496e1fad17bSTakashi Iwai struct snd_mpu401 *mpu = rmidi->private_data; 4971da177e4SLinus Torvalds if (mpu->irq_flags && mpu->irq >= 0) 4981da177e4SLinus Torvalds free_irq(mpu->irq, (void *) mpu); 499b1d5776dSTakashi Iwai release_and_free_resource(mpu->res); 5001da177e4SLinus Torvalds kfree(mpu); 5011da177e4SLinus Torvalds } 5021da177e4SLinus Torvalds 5031da177e4SLinus Torvalds /** 5041da177e4SLinus Torvalds * snd_mpu401_uart_new - create an MPU401-UART instance 5051da177e4SLinus Torvalds * @card: the card instance 5061da177e4SLinus Torvalds * @device: the device index, zero-based 5071da177e4SLinus Torvalds * @hardware: the hardware type, MPU401_HW_XXXX 5081da177e4SLinus Torvalds * @port: the base address of MPU401 port 509302e4c2fSTakashi Iwai * @info_flags: bitflags MPU401_INFO_XXX 5101da177e4SLinus Torvalds * @irq: the irq number, -1 if no interrupt for mpu 5111da177e4SLinus Torvalds * @irq_flags: the irq request flags (SA_XXX), 0 if irq was already reserved. 5121da177e4SLinus Torvalds * @rrawmidi: the pointer to store the new rawmidi instance 5131da177e4SLinus Torvalds * 5141da177e4SLinus Torvalds * Creates a new MPU-401 instance. 5151da177e4SLinus Torvalds * 5161da177e4SLinus Torvalds * Note that the rawmidi instance is returned on the rrawmidi argument, 5171da177e4SLinus Torvalds * not the mpu401 instance itself. To access to the mpu401 instance, 518e1fad17bSTakashi Iwai * cast from rawmidi->private_data (with struct snd_mpu401 magic-cast). 5191da177e4SLinus Torvalds * 5201da177e4SLinus Torvalds * Returns zero if successful, or a negative error code. 5211da177e4SLinus Torvalds */ 522e1fad17bSTakashi Iwai int snd_mpu401_uart_new(struct snd_card *card, int device, 5231da177e4SLinus Torvalds unsigned short hardware, 524302e4c2fSTakashi Iwai unsigned long port, 525302e4c2fSTakashi Iwai unsigned int info_flags, 5261da177e4SLinus Torvalds int irq, int irq_flags, 527e1fad17bSTakashi Iwai struct snd_rawmidi ** rrawmidi) 5281da177e4SLinus Torvalds { 529e1fad17bSTakashi Iwai struct snd_mpu401 *mpu; 530e1fad17bSTakashi Iwai struct snd_rawmidi *rmidi; 531302e4c2fSTakashi Iwai int in_enable, out_enable; 5321da177e4SLinus Torvalds int err; 5331da177e4SLinus Torvalds 5341da177e4SLinus Torvalds if (rrawmidi) 5351da177e4SLinus Torvalds *rrawmidi = NULL; 536302e4c2fSTakashi Iwai if (! (info_flags & (MPU401_INFO_INPUT | MPU401_INFO_OUTPUT))) 537302e4c2fSTakashi Iwai info_flags |= MPU401_INFO_INPUT | MPU401_INFO_OUTPUT; 538302e4c2fSTakashi Iwai in_enable = (info_flags & MPU401_INFO_INPUT) ? 1 : 0; 539302e4c2fSTakashi Iwai out_enable = (info_flags & MPU401_INFO_OUTPUT) ? 1 : 0; 540302e4c2fSTakashi Iwai if ((err = snd_rawmidi_new(card, "MPU-401U", device, 541302e4c2fSTakashi Iwai out_enable, in_enable, &rmidi)) < 0) 5421da177e4SLinus Torvalds return err; 543561b220aSTakashi Iwai mpu = kzalloc(sizeof(*mpu), GFP_KERNEL); 5441da177e4SLinus Torvalds if (mpu == NULL) { 54573e77ba0STakashi Iwai snd_printk(KERN_ERR "mpu401_uart: cannot allocate\n"); 5461da177e4SLinus Torvalds snd_device_free(card, rmidi); 5471da177e4SLinus Torvalds return -ENOMEM; 5481da177e4SLinus Torvalds } 5491da177e4SLinus Torvalds rmidi->private_data = mpu; 5501da177e4SLinus Torvalds rmidi->private_free = snd_mpu401_uart_free; 5511da177e4SLinus Torvalds spin_lock_init(&mpu->input_lock); 5521da177e4SLinus Torvalds spin_lock_init(&mpu->output_lock); 5531da177e4SLinus Torvalds spin_lock_init(&mpu->timer_lock); 5541da177e4SLinus Torvalds mpu->hardware = hardware; 555302e4c2fSTakashi Iwai if (! (info_flags & MPU401_INFO_INTEGRATED)) { 5561da177e4SLinus Torvalds int res_size = hardware == MPU401_HW_PC98II ? 4 : 2; 5572851d963STakashi Iwai mpu->res = request_region(port, res_size, "MPU401 UART"); 5582851d963STakashi Iwai if (mpu->res == NULL) { 5592851d963STakashi Iwai snd_printk(KERN_ERR "mpu401_uart: " 5602851d963STakashi Iwai "unable to grab port 0x%lx size %d\n", 5612851d963STakashi Iwai port, res_size); 5621da177e4SLinus Torvalds snd_device_free(card, rmidi); 5631da177e4SLinus Torvalds return -EBUSY; 5641da177e4SLinus Torvalds } 5651da177e4SLinus Torvalds } 566302e4c2fSTakashi Iwai if (info_flags & MPU401_INFO_MMIO) { 5671da177e4SLinus Torvalds mpu->write = mpu401_write_mmio; 5681da177e4SLinus Torvalds mpu->read = mpu401_read_mmio; 569302e4c2fSTakashi Iwai } else { 5701da177e4SLinus Torvalds mpu->write = mpu401_write_port; 5711da177e4SLinus Torvalds mpu->read = mpu401_read_port; 5721da177e4SLinus Torvalds } 5731da177e4SLinus Torvalds mpu->port = port; 5741da177e4SLinus Torvalds if (hardware == MPU401_HW_PC98II) 5751da177e4SLinus Torvalds mpu->cport = port + 2; 5761da177e4SLinus Torvalds else 5771da177e4SLinus Torvalds mpu->cport = port + 1; 5781da177e4SLinus Torvalds if (irq >= 0 && irq_flags) { 5792851d963STakashi Iwai if (request_irq(irq, snd_mpu401_uart_interrupt, irq_flags, 5802851d963STakashi Iwai "MPU401 UART", (void *) mpu)) { 5812851d963STakashi Iwai snd_printk(KERN_ERR "mpu401_uart: " 5822851d963STakashi Iwai "unable to grab IRQ %d\n", irq); 5831da177e4SLinus Torvalds snd_device_free(card, rmidi); 5841da177e4SLinus Torvalds return -EBUSY; 5851da177e4SLinus Torvalds } 5861da177e4SLinus Torvalds } 587302e4c2fSTakashi Iwai mpu->info_flags = info_flags; 5881da177e4SLinus Torvalds mpu->irq = irq; 5891da177e4SLinus Torvalds mpu->irq_flags = irq_flags; 5901da177e4SLinus Torvalds if (card->shortname[0]) 5912851d963STakashi Iwai snprintf(rmidi->name, sizeof(rmidi->name), "%s MIDI", 5922851d963STakashi Iwai card->shortname); 5931da177e4SLinus Torvalds else 5941da177e4SLinus Torvalds sprintf(rmidi->name, "MPU-401 MIDI %d-%d",card->number, device); 595302e4c2fSTakashi Iwai if (out_enable) { 5962851d963STakashi Iwai snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, 5972851d963STakashi Iwai &snd_mpu401_uart_output); 598302e4c2fSTakashi Iwai rmidi->info_flags |= SNDRV_RAWMIDI_INFO_OUTPUT; 599302e4c2fSTakashi Iwai } 600302e4c2fSTakashi Iwai if (in_enable) { 6012851d963STakashi Iwai snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, 6022851d963STakashi Iwai &snd_mpu401_uart_input); 603302e4c2fSTakashi Iwai rmidi->info_flags |= SNDRV_RAWMIDI_INFO_INPUT; 604302e4c2fSTakashi Iwai if (out_enable) 605302e4c2fSTakashi Iwai rmidi->info_flags |= SNDRV_RAWMIDI_INFO_DUPLEX; 606302e4c2fSTakashi Iwai } 6071da177e4SLinus Torvalds mpu->rmidi = rmidi; 6081da177e4SLinus Torvalds if (rrawmidi) 6091da177e4SLinus Torvalds *rrawmidi = rmidi; 6101da177e4SLinus Torvalds return 0; 6111da177e4SLinus Torvalds } 6121da177e4SLinus Torvalds 6131da177e4SLinus Torvalds EXPORT_SYMBOL(snd_mpu401_uart_new); 6141da177e4SLinus Torvalds 6151da177e4SLinus Torvalds /* 6161da177e4SLinus Torvalds * INIT part 6171da177e4SLinus Torvalds */ 6181da177e4SLinus Torvalds 6191da177e4SLinus Torvalds static int __init alsa_mpu401_uart_init(void) 6201da177e4SLinus Torvalds { 6211da177e4SLinus Torvalds return 0; 6221da177e4SLinus Torvalds } 6231da177e4SLinus Torvalds 6241da177e4SLinus Torvalds static void __exit alsa_mpu401_uart_exit(void) 6251da177e4SLinus Torvalds { 6261da177e4SLinus Torvalds } 6271da177e4SLinus Torvalds 6281da177e4SLinus Torvalds module_init(alsa_mpu401_uart_init) 6291da177e4SLinus Torvalds module_exit(alsa_mpu401_uart_exit) 630