sound/drivers/mpu401/mpu401_uart.c

   1 /*
   2  *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
   3  *  Routines for control of MPU-401 in UART mode
   4  *
   5  *  MPU-401 supports UART mode which is not capable generate transmit
   6  *  interrupts thus output is done via polling. Also, if irq < 0, then
   7  *  input is done also via polling. Do not expect good performance.
   8  *
   9  *
  10  *   This program is free software; you can redistribute it and/or modify
  11  *   it under the terms of the GNU General Public License as published by
  12  *   the Free Software Foundation; either version 2 of the License, or
  13  *   (at your option) any later version.
  14  *
  15  *   This program is distributed in the hope that it will be useful,
  16  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *   GNU General Public License for more details.
  19  *
  20  *   You should have received a copy of the GNU General Public License
  21  *   along with this program; if not, write to the Free Software
  22  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  23  *
  24  *   13-03-2003:
  25  *      Added support for different kind of hardware I/O. Build in choices
  26  *      are port and mmio. For other kind of I/O, set mpu->read and
  27  *      mpu->write to your own I/O functions.
  28  *
  29  */
  30
  31 #include <sound/driver.h>
  32 #include <asm/io.h>
  33 #include <linux/delay.h>
  34 #include <linux/init.h>
  35 #include <linux/slab.h>
  36 #include <linux/ioport.h>
  37 #include <linux/interrupt.h>
  38 #include <linux/errno.h>
  39 #include <sound/core.h>
  40 #include <sound/mpu401.h>
  41
  42 MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>");
  43 MODULE_DESCRIPTION("Routines for control of MPU-401 in UART mode");
  44 MODULE_LICENSE("GPL");
  45
  46 static void snd_mpu401_uart_input_read(mpu401_t * mpu);
  47 static void snd_mpu401_uart_output_write(mpu401_t * mpu);
  48
  49 /*
  50
  51  */
  52
  53 #define snd_mpu401_input_avail(mpu)     (!(mpu->read(mpu, MPU401C(mpu)) & 0x80))
  54 #define snd_mpu401_output_ready(mpu)    (!(mpu->read(mpu, MPU401C(mpu)) & 0x40))
  55
  56 #define MPU401_RESET            0xff
  57 #define MPU401_ENTER_UART       0x3f
  58 #define MPU401_ACK              0xfe
  59
  60 /* Build in lowlevel io */
  61 static void mpu401_write_port(mpu401_t *mpu, unsigned char data, unsigned long addr)
  62 {
  63         outb(data, addr);
  64 }
  65
  66 static unsigned char mpu401_read_port(mpu401_t *mpu, unsigned long addr)
  67 {
  68         return inb(addr);
  69 }
  70
  71 static void mpu401_write_mmio(mpu401_t *mpu, unsigned char data, unsigned long addr)
  72 {
  73         writeb(data, (unsigned long*)addr);
  74 }
  75
  76 static unsigned char mpu401_read_mmio(mpu401_t *mpu, unsigned long addr)
  77 {
  78         return readb((unsigned long*)addr);
  79 }
  80 /*  */
  81
  82 static void snd_mpu401_uart_clear_rx(mpu401_t *mpu)
  83 {
  84         int timeout = 100000;
  85         for (; timeout > 0 && snd_mpu401_input_avail(mpu); timeout--)
  86                 mpu->read(mpu, MPU401D(mpu));
  87 #ifdef CONFIG_SND_DEBUG
  88         if (timeout <= 0)
  89                 snd_printk("cmd: clear rx timeout (status = 0x%x)\n", mpu->read(mpu, MPU401C(mpu)));
  90 #endif
  91 }
  92
  93 static void _snd_mpu401_uart_interrupt(mpu401_t *mpu)
  94 {
  95         spin_lock(&mpu->input_lock);
  96         if (test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode)) {
  97                 atomic_dec(&mpu->rx_loop);
  98                 snd_mpu401_uart_input_read(mpu);
  99                 atomic_inc(&mpu->rx_loop);
 100         } else {
 101                 snd_mpu401_uart_clear_rx(mpu);
 102         }
 103         spin_unlock(&mpu->input_lock);
 104         /* ok. for better Tx performance try do some output when input is done */
 105         if (test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode) &&
 106             test_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode)) {
 107                 if (spin_trylock(&mpu->output_lock)) {
 108                         atomic_dec(&mpu->tx_loop);
 109                         snd_mpu401_uart_output_write(mpu);
 110                         atomic_inc(&mpu->tx_loop);
 111                         spin_unlock(&mpu->output_lock);
 112                 }
 113         }
 114 }
 115
 116 /**
 117  * snd_mpu401_uart_interrupt - generic MPU401-UART interrupt handler
 118  * @irq: the irq number
 119  * @dev_id: mpu401 instance
 120  * @regs: the reigster
 121  *
 122  * Processes the interrupt for MPU401-UART i/o.
 123  */
 124 irqreturn_t snd_mpu401_uart_interrupt(int irq, void *dev_id, struct pt_regs *regs)
 125 {
 126         mpu401_t *mpu = snd_magic_cast(mpu401_t, dev_id, return IRQ_NONE);
 127
 128         if (mpu == NULL)
 129                 return IRQ_NONE;
 130         _snd_mpu401_uart_interrupt(mpu);
 131         return IRQ_HANDLED;
 132 }
 133
 134 /*
 135  * timer callback
 136  * reprogram the timer and call the interrupt job
 137  */
 138 static void snd_mpu401_uart_timer(unsigned long data)
 139 {
 140         mpu401_t *mpu = snd_magic_cast(mpu401_t, (void *)data, return);
 141
 142         spin_lock(&mpu->timer_lock);
 143         /*mpu->mode |= MPU401_MODE_TIMER;*/
 144         mpu->timer.expires = 1 + jiffies;
 145         add_timer(&mpu->timer);
 146         spin_unlock(&mpu->timer_lock);
 147         if (mpu->rmidi)
 148                 _snd_mpu401_uart_interrupt(mpu);
 149 }
 150
 151 /*
 152  * initialize the timer callback if not programmed yet
 153  */
 154 static void snd_mpu401_uart_add_timer (mpu401_t *mpu, int input)
 155 {
 156         unsigned long flags;
 157
 158         spin_lock_irqsave (&mpu->timer_lock, flags);
 159         if (mpu->timer_invoked == 0) {
 160                 init_timer(&mpu->timer);
 161                 mpu->timer.data = (unsigned long)mpu;
 162                 mpu->timer.function = snd_mpu401_uart_timer;
 163                 mpu->timer.expires = 1 + jiffies;
 164                 add_timer(&mpu->timer);
 165         }
 166         mpu->timer_invoked |= input ? MPU401_MODE_INPUT_TIMER : MPU401_MODE_OUTPUT_TIMER;
 167         spin_unlock_irqrestore (&mpu->timer_lock, flags);
 168 }
 169
 170 /*
 171  * remove the timer callback if still active
 172  */
 173 static void snd_mpu401_uart_remove_timer (mpu401_t *mpu, int input)
 174 {
 175         unsigned long flags;
 176
 177         spin_lock_irqsave (&mpu->timer_lock, flags);
 178         if (mpu->timer_invoked) {
 179                 mpu->timer_invoked &= input ? ~MPU401_MODE_INPUT_TIMER : ~MPU401_MODE_OUTPUT_TIMER;
 180                 if (! mpu->timer_invoked)
 181                         del_timer(&mpu->timer);
 182         }
 183         spin_unlock_irqrestore (&mpu->timer_lock, flags);
 184 }
 185
 186 /*
 187
 188  */
 189
 190 static void snd_mpu401_uart_cmd(mpu401_t * mpu, unsigned char cmd, int ack)
 191 {
 192         unsigned long flags;
 193         int timeout, ok;
 194
 195         spin_lock_irqsave(&mpu->input_lock, flags);
 196         if (mpu->hardware != MPU401_HW_TRID4DWAVE) {
 197                 mpu->write(mpu, 0x00, MPU401D(mpu));
 198                 /*snd_mpu401_uart_clear_rx(mpu);*/
 199         }
 200         /* ok. standard MPU-401 initialization */
 201         if (mpu->hardware != MPU401_HW_SB) {
 202                 for (timeout = 1000; timeout > 0 && !snd_mpu401_output_ready(mpu); timeout--)
 203                         udelay(10);
 204 #ifdef CONFIG_SND_DEBUG
 205                 if (!timeout)
 206                         snd_printk("cmd: tx timeout (status = 0x%x)\n", mpu->read(mpu, MPU401C(mpu)));
 207 #endif
 208         }
 209         mpu->write(mpu, cmd, MPU401C(mpu));
 210         if (ack) {
 211                 ok = 0;
 212                 timeout = 10000;
 213                 while (!ok && timeout-- > 0) {
 214                         if (snd_mpu401_input_avail(mpu)) {
 215                                 if (mpu->read(mpu, MPU401D(mpu)) == MPU401_ACK)
 216                                         ok = 1;
 217                         }
 218                 }
 219                 if (!ok && mpu->read(mpu, MPU401D(mpu)) == MPU401_ACK)
 220                         ok = 1;
 221         } else {
 222                 ok = 1;
 223         }
 224         spin_unlock_irqrestore(&mpu->input_lock, flags);
 225         if (! ok)
 226                 snd_printk("cmd: 0x%x failed at 0x%lx (status = 0x%x, data = 0x%x)\n", cmd, mpu->port, mpu->read(mpu, MPU401C(mpu)), mpu->read(mpu, MPU401D(mpu)));
 227         // snd_printk("cmd: 0x%x at 0x%lx (status = 0x%x, data = 0x%x)\n", cmd, mpu->port, mpu->read(mpu, MPU401C(mpu)), mpu->read(mpu, MPU401D(mpu)));
 228 }
 229
 230 /*
 231  * input/output open/close - protected by open_mutex in rawmidi.c
 232  */
 233 static int snd_mpu401_uart_input_open(snd_rawmidi_substream_t * substream)
 234 {
 235         mpu401_t *mpu;
 236         int err;
 237
 238         mpu = snd_magic_cast(mpu401_t, substream->rmidi->private_data, return -ENXIO);
 239         if (mpu->open_input && (err = mpu->open_input(mpu)) < 0)
 240                 return err;
 241         if (! test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode)) {
 242                 snd_mpu401_uart_cmd(mpu, MPU401_RESET, 1);
 243                 snd_mpu401_uart_cmd(mpu, MPU401_ENTER_UART, 1);
 244         }
 245         mpu->substream_input = substream;
 246         atomic_set(&mpu->rx_loop, 1);
 247         set_bit(MPU401_MODE_BIT_INPUT, &mpu->mode);
 248         return 0;
 249 }
 250
 251 static int snd_mpu401_uart_output_open(snd_rawmidi_substream_t * substream)
 252 {
 253         mpu401_t *mpu;
 254         int err;
 255
 256         mpu = snd_magic_cast(mpu401_t, substream->rmidi->private_data, return -ENXIO);
 257         if (mpu->open_output && (err = mpu->open_output(mpu)) < 0)
 258                 return err;
 259         if (! test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode)) {
 260                 snd_mpu401_uart_cmd(mpu, MPU401_RESET, 1);
 261                 snd_mpu401_uart_cmd(mpu, MPU401_ENTER_UART, 1);
 262         }
 263         mpu->substream_output = substream;
 264         atomic_set(&mpu->tx_loop, 1);
 265         set_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode);
 266         return 0;
 267 }
 268
 269 static int snd_mpu401_uart_input_close(snd_rawmidi_substream_t * substream)
 270 {
 271         mpu401_t *mpu;
 272
 273         mpu = snd_magic_cast(mpu401_t, substream->rmidi->private_data, return -ENXIO);
 274         clear_bit(MPU401_MODE_BIT_INPUT, &mpu->mode);
 275         mpu->substream_input = NULL;
 276         if (! test_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode))
 277                 snd_mpu401_uart_cmd(mpu, MPU401_RESET, 0);
 278         if (mpu->close_input)
 279                 mpu->close_input(mpu);
 280         return 0;
 281 }
 282
 283 static int snd_mpu401_uart_output_close(snd_rawmidi_substream_t * substream)
 284 {
 285         mpu401_t *mpu;
 286
 287         mpu = snd_magic_cast(mpu401_t, substream->rmidi->private_data, return -ENXIO);
 288         clear_bit(MPU401_MODE_BIT_OUTPUT, &mpu->mode);
 289         mpu->substream_output = NULL;
 290         if (! test_bit(MPU401_MODE_BIT_INPUT, &mpu->mode))
 291                 snd_mpu401_uart_cmd(mpu, MPU401_RESET, 0);
 292         if (mpu->close_output)
 293                 mpu->close_output(mpu);
 294         return 0;
 295 }
 296
 297 /*
 298  * trigger input callback
 299  */
 300 static void snd_mpu401_uart_input_trigger(snd_rawmidi_substream_t * substream, int up)
 301 {
 302         unsigned long flags;
 303         mpu401_t *mpu;
 304         int max = 64;
 305
 306         mpu = snd_magic_cast(mpu401_t, substream->rmidi->private_data, return);
 307         if (up) {
 308                 if (! test_and_set_bit(MPU401_MODE_BIT_INPUT_TRIGGER, &mpu->mode)) {
 309                         /* first time - flush FIFO */
 310                         while (max-- > 0)
 311                                 mpu->read(mpu, MPU401D(mpu));
 312                         if (mpu->irq < 0)
 313                                 snd_mpu401_uart_add_timer(mpu, 1);
 314                 }
 315
 316                 /* read data in advance */
 317                 /* prevent double enter via rawmidi->event callback */
 318                 if (atomic_dec_and_test(&mpu->rx_loop)) {
 319                         local_irq_save(flags);
 320                         if (spin_trylock(&mpu->input_lock)) {
 321                                 snd_mpu401_uart_input_read(mpu);
 322                                 spin_unlock(&mpu->input_lock);
 323                         }
 324                         local_irq_restore(flags);
 325                 }
 326                 atomic_inc(&mpu->rx_loop);
 327         } else {
 328                 if (mpu->irq < 0)
 329                         snd_mpu401_uart_remove_timer(mpu, 1);
 330                 clear_bit(MPU401_MODE_BIT_INPUT_TRIGGER, &mpu->mode);
 331         }
 332 }
 333
 334 /*
 335  * transfer input pending data
 336  * call with input_lock spinlock held
 337  */
 338 static void snd_mpu401_uart_input_read(mpu401_t * mpu)
 339 {
 340         int max = 128;
 341         unsigned char byte;
 342
 343         while (max-- > 0) {
 344                 if (snd_mpu401_input_avail(mpu)) {
 345                         byte = mpu->read(mpu, MPU401D(mpu));
 346                         if (test_bit(MPU401_MODE_BIT_INPUT_TRIGGER, &mpu->mode))
 347                                 snd_rawmidi_receive(mpu->substream_input, &byte, 1);
 348                 } else {
 349                         break; /* input not available */
 350                 }
 351         }
 352 }
 353
 354 /*
 355  *  Tx FIFO sizes:
 356  *    CS4237B                   - 16 bytes
 357  *    AudioDrive ES1688         - 12 bytes
 358  *    S3 SonicVibes             -  8 bytes
 359  *    SoundBlaster AWE 64       -  2 bytes (ugly hardware)
 360  */
 361
 362 /*
 363  * write output pending bytes
 364  * call with output_lock spinlock held
 365  */
 366 static void snd_mpu401_uart_output_write(mpu401_t * mpu)
 367 {
 368         unsigned char byte;
 369         int max = 256, timeout;
 370
 371         do {
 372                 if (snd_rawmidi_transmit_peek(mpu->substream_output, &byte, 1) == 1) {
 373                         for (timeout = 100; timeout > 0; timeout--) {
 374                                 if (snd_mpu401_output_ready(mpu)) {
 375                                         mpu->write(mpu, byte, MPU401D(mpu));
 376                                         snd_rawmidi_transmit_ack(mpu->substream_output, 1);
 377                                         break;
 378                                 }
 379                         }
 380                         if (timeout == 0)
 381                                 break;  /* Tx FIFO full - try again later */
 382                 } else {
 383                         snd_mpu401_uart_remove_timer (mpu, 0);
 384                         break;  /* no other data - leave the tx loop */
 385                 }
 386         } while (--max > 0);
 387 }
 388
 389 /*
 390  * output trigger callback
 391  */
 392 static void snd_mpu401_uart_output_trigger(snd_rawmidi_substream_t * substream, int up)
 393 {
 394         unsigned long flags;
 395         mpu401_t *mpu;
 396
 397         mpu = snd_magic_cast(mpu401_t, substream->rmidi->private_data, return);
 398         if (up) {
 399                 set_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode);
 400
 401                 /* try to add the timer at each output trigger,
 402                  * since the output timer might have been removed in
 403                  * snd_mpu401_uart_output_write().
 404                  */
 405                 snd_mpu401_uart_add_timer(mpu, 0);
 406
 407                 /* output pending data */
 408                 /* prevent double enter via rawmidi->event callback */
 409                 if (atomic_dec_and_test(&mpu->tx_loop)) {
 410                         local_irq_save(flags);
 411                         if (spin_trylock(&mpu->output_lock)) {
 412                                 snd_mpu401_uart_output_write(mpu);
 413                                 spin_unlock(&mpu->output_lock);
 414                         }
 415                         local_irq_restore(flags);
 416                 }
 417                 atomic_inc(&mpu->tx_loop);
 418         } else {
 419                 snd_mpu401_uart_remove_timer(mpu, 0);
 420                 clear_bit(MPU401_MODE_BIT_OUTPUT_TRIGGER, &mpu->mode);
 421         }
 422 }
 423
 424 /*
 425
 426  */
 427
 428 static snd_rawmidi_ops_t snd_mpu401_uart_output =
 429 {
 430         .open =         snd_mpu401_uart_output_open,
 431         .close =        snd_mpu401_uart_output_close,
 432         .trigger =      snd_mpu401_uart_output_trigger,
 433 };
 434
 435 static snd_rawmidi_ops_t snd_mpu401_uart_input =
 436 {
 437         .open =         snd_mpu401_uart_input_open,
 438         .close =        snd_mpu401_uart_input_close,
 439         .trigger =      snd_mpu401_uart_input_trigger,
 440 };
 441
 442 static void snd_mpu401_uart_free(snd_rawmidi_t *rmidi)
 443 {
 444         mpu401_t *mpu = snd_magic_cast(mpu401_t, rmidi->private_data, return);
 445         if (mpu->irq_flags && mpu->irq >= 0)
 446                 free_irq(mpu->irq, (void *) mpu);
 447         if (mpu->res) {
 448                 release_resource(mpu->res);
 449                 kfree_nocheck(mpu->res);
 450         }
 451         snd_magic_kfree(mpu);
 452 }
 453
 454 /**
 455  * snd_mpu401_uart_new - create an MPU401-UART instance
 456  * @card: the card instance
 457  * @device: the device index, zero-based
 458  * @hardware: the hardware type, MPU401_HW_XXXX
 459  * @port: the base address of MPU401 port
 460  * @integrated: non-zero if the port was already reserved by the chip
 461  * @irq: the irq number, -1 if no interrupt for mpu
 462  * @irq_flags: the irq request flags (SA_XXX), 0 if irq was already reserved.
 463  * @rrawmidi: the pointer to store the new rawmidi instance
 464  *
 465  * Creates a new MPU-401 instance.
 466  *
 467  * Note that the rawmidi instance is returned on the rrawmidi argument,
 468  * not the mpu401 instance itself.  To access to the mpu401 instance,
 469  * cast from rawmidi->private_data (with mpu401_t magic-cast).
 470  *
 471  * Returns zero if successful, or a negative error code.
 472  */
 473 int snd_mpu401_uart_new(snd_card_t * card, int device,
 474                         unsigned short hardware,
 475                         unsigned long port, int integrated,
 476                         int irq, int irq_flags,
 477                         snd_rawmidi_t ** rrawmidi)
 478 {
 479         mpu401_t *mpu;
 480         snd_rawmidi_t *rmidi;
 481         int err;
 482
 483         if (rrawmidi)
 484                 *rrawmidi = NULL;
 485         if ((err = snd_rawmidi_new(card, "MPU-401U", device, 1, 1, &rmidi)) < 0)
 486                 return err;
 487         mpu = snd_magic_kcalloc(mpu401_t, 0, GFP_KERNEL);
 488         if (mpu == NULL) {
 489                 snd_device_free(card, rmidi);
 490                 return -ENOMEM;
 491         }
 492         rmidi->private_data = mpu;
 493         rmidi->private_free = snd_mpu401_uart_free;
 494         spin_lock_init(&mpu->input_lock);
 495         spin_lock_init(&mpu->output_lock);
 496         spin_lock_init(&mpu->timer_lock);
 497         mpu->hardware = hardware;
 498         if (!integrated) {
 499                 int res_size = hardware == MPU401_HW_PC98II ? 4 : 2;
 500                 if ((mpu->res = request_region(port, res_size, "MPU401 UART")) == NULL) {
 501                         snd_printk(KERN_ERR "mpu401_uart: unable to grab port 0x%lx size %d\n", port, res_size);
 502                         snd_device_free(card, rmidi);
 503                         return -EBUSY;
 504                 }
 505         }
 506         switch (hardware) {
 507         case MPU401_HW_AUREAL:
 508                 mpu->write = mpu401_write_mmio;
 509                 mpu->read = mpu401_read_mmio;
 510                 break;
 511         default:
 512                 mpu->write = mpu401_write_port;
 513                 mpu->read = mpu401_read_port;
 514                 break;
 515         }
 516         mpu->port = port;
 517         if (hardware == MPU401_HW_PC98II)
 518                 mpu->cport = port + 2;
 519         else
 520                 mpu->cport = port + 1;
 521         if (irq >= 0 && irq_flags) {
 522                 if (request_irq(irq, snd_mpu401_uart_interrupt, irq_flags, "MPU401 UART", (void *) mpu)) {
 523                         snd_printk(KERN_ERR "mpu401_uart: unable to grab IRQ %d\n", irq);
 524                         snd_device_free(card, rmidi);
 525                         return -EBUSY;
 526                 }
 527         }
 528         mpu->irq = irq;
 529         mpu->irq_flags = irq_flags;
 530         if (card->shortname[0])
 531                 snprintf(rmidi->name, sizeof(rmidi->name), "%s MIDI", card->shortname);
 532         else
 533                 sprintf(rmidi->name, "MPU-401 MIDI %d-%d", card->number, device);
 534         snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_mpu401_uart_output);
 535         snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_mpu401_uart_input);
 536         rmidi->info_flags |= SNDRV_RAWMIDI_INFO_OUTPUT |
 537                              SNDRV_RAWMIDI_INFO_INPUT |
 538                              SNDRV_RAWMIDI_INFO_DUPLEX;
 539         mpu->rmidi = rmidi;
 540         if (rrawmidi)
 541                 *rrawmidi = rmidi;
 542         return 0;
 543 }
 544
 545 EXPORT_SYMBOL(snd_mpu401_uart_interrupt);
 546 EXPORT_SYMBOL(snd_mpu401_uart_new);
 547
 548 /*
 549  *  INIT part
 550  */
 551
 552 static int __init alsa_mpu401_uart_init(void)
 553 {
 554         return 0;
 555 }
 556
 557 static void __exit alsa_mpu401_uart_exit(void)
 558 {
 559 }
 560
 561 module_init(alsa_mpu401_uart_init)
 562 module_exit(alsa_mpu401_uart_exit)