sound/usb/usbmidi.c

   1 /*
   2  * usbmidi.c - ALSA USB MIDI driver
   3  *
   4  * Copyright (c) 2002-2007 Clemens Ladisch
   5  * All rights reserved.
   6  *
   7  * Based on the OSS usb-midi driver by NAGANO Daisuke,
   8  *          NetBSD's umidi driver by Takuya SHIOZAKI,
   9  *          the "USB Device Class Definition for MIDI Devices" by Roland
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. The name of the author may not be used to endorse or promote products
  18  *    derived from this software without specific prior written permission.
  19  *
  20  * Alternatively, this software may be distributed and/or modified under the
  21  * terms of the GNU General Public License as published by the Free Software
  22  * Foundation; either version 2 of the License, or (at your option) any later
  23  * version.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  29  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35  * SUCH DAMAGE.
  36  */
  37
  38 #include <linux/kernel.h>
  39 #include <linux/types.h>
  40 #include <linux/bitops.h>
  41 #include <linux/interrupt.h>
  42 #include <linux/spinlock.h>
  43 #include <linux/string.h>
  44 #include <linux/init.h>
  45 #include <linux/slab.h>
  46 #include <linux/timer.h>
  47 #include <linux/usb.h>
  48 #include <sound/core.h>
  49 #include <sound/rawmidi.h>
  50 #include <sound/asequencer.h>
  51 #include "usbaudio.h"
  52
  53
  54 /*
  55  * define this to log all USB packets
  56  */
  57 /* #define DUMP_PACKETS */
  58
  59 /*
  60  * how long to wait after some USB errors, so that khubd can disconnect() us
  61  * without too many spurious errors
  62  */
  63 #define ERROR_DELAY_JIFFIES (HZ / 10)
  64
  65
  66 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
  67 MODULE_DESCRIPTION("USB Audio/MIDI helper module");
  68 MODULE_LICENSE("Dual BSD/GPL");
  69
  70
  71 struct usb_ms_header_descriptor {
  72         __u8  bLength;
  73         __u8  bDescriptorType;
  74         __u8  bDescriptorSubtype;
  75         __u8  bcdMSC[2];
  76         __le16 wTotalLength;
  77 } __attribute__ ((packed));
  78
  79 struct usb_ms_endpoint_descriptor {
  80         __u8  bLength;
  81         __u8  bDescriptorType;
  82         __u8  bDescriptorSubtype;
  83         __u8  bNumEmbMIDIJack;
  84         __u8  baAssocJackID[0];
  85 } __attribute__ ((packed));
  86
  87 struct snd_usb_midi_in_endpoint;
  88 struct snd_usb_midi_out_endpoint;
  89 struct snd_usb_midi_endpoint;
  90
  91 struct usb_protocol_ops {
  92         void (*input)(struct snd_usb_midi_in_endpoint*, uint8_t*, int);
  93         void (*output)(struct snd_usb_midi_out_endpoint*);
  94         void (*output_packet)(struct urb*, uint8_t, uint8_t, uint8_t, uint8_t);
  95         void (*init_out_endpoint)(struct snd_usb_midi_out_endpoint*);
  96         void (*finish_out_endpoint)(struct snd_usb_midi_out_endpoint*);
  97 };
  98
  99 struct snd_usb_midi {
 100         struct snd_usb_audio *chip;
 101         struct usb_interface *iface;
 102         const struct snd_usb_audio_quirk *quirk;
 103         struct snd_rawmidi *rmidi;
 104         struct usb_protocol_ops* usb_protocol_ops;
 105         struct list_head list;
 106         struct timer_list error_timer;
 107         spinlock_t disc_lock;
 108
 109         struct snd_usb_midi_endpoint {
 110                 struct snd_usb_midi_out_endpoint *out;
 111                 struct snd_usb_midi_in_endpoint *in;
 112         } endpoints[MIDI_MAX_ENDPOINTS];
 113         unsigned long input_triggered;
 114         unsigned char disconnected;
 115 };
 116
 117 struct snd_usb_midi_out_endpoint {
 118         struct snd_usb_midi* umidi;
 119         struct urb* urb;
 120         int urb_active;
 121         int max_transfer;               /* size of urb buffer */
 122         struct tasklet_struct tasklet;
 123
 124         spinlock_t buffer_lock;
 125
 126         struct usbmidi_out_port {
 127                 struct snd_usb_midi_out_endpoint* ep;
 128                 struct snd_rawmidi_substream *substream;
 129                 int active;
 130                 uint8_t cable;          /* cable number << 4 */
 131                 uint8_t state;
 132 #define STATE_UNKNOWN   0
 133 #define STATE_1PARAM    1
 134 #define STATE_2PARAM_1  2
 135 #define STATE_2PARAM_2  3
 136 #define STATE_SYSEX_0   4
 137 #define STATE_SYSEX_1   5
 138 #define STATE_SYSEX_2   6
 139                 uint8_t data[2];
 140         } ports[0x10];
 141         int current_port;
 142 };
 143
 144 struct snd_usb_midi_in_endpoint {
 145         struct snd_usb_midi* umidi;
 146         struct urb* urb;
 147         struct usbmidi_in_port {
 148                 struct snd_rawmidi_substream *substream;
 149                 u8 running_status_length;
 150         } ports[0x10];
 151         u8 seen_f5;
 152         u8 error_resubmit;
 153         int current_port;
 154 };
 155
 156 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint* ep);
 157
 158 static const uint8_t snd_usbmidi_cin_length[] = {
 159         0, 0, 2, 3, 3, 1, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1
 160 };
 161
 162 /*
 163  * Submits the URB, with error handling.
 164  */
 165 static int snd_usbmidi_submit_urb(struct urb* urb, gfp_t flags)
 166 {
 167         int err = usb_submit_urb(urb, flags);
 168         if (err < 0 && err != -ENODEV)
 169                 snd_printk(KERN_ERR "usb_submit_urb: %d\n", err);
 170         return err;
 171 }
 172
 173 /*
 174  * Error handling for URB completion functions.
 175  */
 176 static int snd_usbmidi_urb_error(int status)
 177 {
 178         switch (status) {
 179         /* manually unlinked, or device gone */
 180         case -ENOENT:
 181         case -ECONNRESET:
 182         case -ESHUTDOWN:
 183         case -ENODEV:
 184                 return -ENODEV;
 185         /* errors that might occur during unplugging */
 186         case -EPROTO:
 187         case -ETIME:
 188         case -EILSEQ:
 189                 return -EIO;
 190         default:
 191                 snd_printk(KERN_ERR "urb status %d\n", status);
 192                 return 0; /* continue */
 193         }
 194 }
 195
 196 /*
 197  * Receives a chunk of MIDI data.
 198  */
 199 static void snd_usbmidi_input_data(struct snd_usb_midi_in_endpoint* ep, int portidx,
 200                                    uint8_t* data, int length)
 201 {
 202         struct usbmidi_in_port* port = &ep->ports[portidx];
 203
 204         if (!port->substream) {
 205                 snd_printd("unexpected port %d!\n", portidx);
 206                 return;
 207         }
 208         if (!test_bit(port->substream->number, &ep->umidi->input_triggered))
 209                 return;
 210         snd_rawmidi_receive(port->substream, data, length);
 211 }
 212
 213 #ifdef DUMP_PACKETS
 214 static void dump_urb(const char *type, const u8 *data, int length)
 215 {
 216         snd_printk(KERN_DEBUG "%s packet: [", type);
 217         for (; length > 0; ++data, --length)
 218                 printk(" %02x", *data);
 219         printk(" ]\n");
 220 }
 221 #else
 222 #define dump_urb(type, data, length) /* nothing */
 223 #endif
 224
 225 /*
 226  * Processes the data read from the device.
 227  */
 228 static void snd_usbmidi_in_urb_complete(struct urb* urb)
 229 {
 230         struct snd_usb_midi_in_endpoint* ep = urb->context;
 231
 232         if (urb->status == 0) {
 233                 dump_urb("received", urb->transfer_buffer, urb->actual_length);
 234                 ep->umidi->usb_protocol_ops->input(ep, urb->transfer_buffer,
 235                                                    urb->actual_length);
 236         } else {
 237                 int err = snd_usbmidi_urb_error(urb->status);
 238                 if (err < 0) {
 239                         if (err != -ENODEV) {
 240                                 ep->error_resubmit = 1;
 241                                 mod_timer(&ep->umidi->error_timer,
 242                                           jiffies + ERROR_DELAY_JIFFIES);
 243                         }
 244                         return;
 245                 }
 246         }
 247
 248         urb->dev = ep->umidi->chip->dev;
 249         snd_usbmidi_submit_urb(urb, GFP_ATOMIC);
 250 }
 251
 252 static void snd_usbmidi_out_urb_complete(struct urb* urb)
 253 {
 254         struct snd_usb_midi_out_endpoint* ep = urb->context;
 255
 256         spin_lock(&ep->buffer_lock);
 257         ep->urb_active = 0;
 258         spin_unlock(&ep->buffer_lock);
 259         if (urb->status < 0) {
 260                 int err = snd_usbmidi_urb_error(urb->status);
 261                 if (err < 0) {
 262                         if (err != -ENODEV)
 263                                 mod_timer(&ep->umidi->error_timer,
 264                                           jiffies + ERROR_DELAY_JIFFIES);
 265                         return;
 266                 }
 267         }
 268         snd_usbmidi_do_output(ep);
 269 }
 270
 271 /*
 272  * This is called when some data should be transferred to the device
 273  * (from one or more substreams).
 274  */
 275 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint* ep)
 276 {
 277         struct urb* urb = ep->urb;
 278         unsigned long flags;
 279
 280         spin_lock_irqsave(&ep->buffer_lock, flags);
 281         if (ep->urb_active || ep->umidi->chip->shutdown) {
 282                 spin_unlock_irqrestore(&ep->buffer_lock, flags);
 283                 return;
 284         }
 285
 286         urb->transfer_buffer_length = 0;
 287         ep->umidi->usb_protocol_ops->output(ep);
 288
 289         if (urb->transfer_buffer_length > 0) {
 290                 dump_urb("sending", urb->transfer_buffer,
 291                          urb->transfer_buffer_length);
 292                 urb->dev = ep->umidi->chip->dev;
 293                 ep->urb_active = snd_usbmidi_submit_urb(urb, GFP_ATOMIC) >= 0;
 294         }
 295         spin_unlock_irqrestore(&ep->buffer_lock, flags);
 296 }
 297
 298 static void snd_usbmidi_out_tasklet(unsigned long data)
 299 {
 300         struct snd_usb_midi_out_endpoint* ep = (struct snd_usb_midi_out_endpoint *) data;
 301
 302         snd_usbmidi_do_output(ep);
 303 }
 304
 305 /* called after transfers had been interrupted due to some USB error */
 306 static void snd_usbmidi_error_timer(unsigned long data)
 307 {
 308         struct snd_usb_midi *umidi = (struct snd_usb_midi *)data;
 309         int i;
 310
 311         spin_lock(&umidi->disc_lock);
 312         if (umidi->disconnected) {
 313                 spin_unlock(&umidi->disc_lock);
 314                 return;
 315         }
 316         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
 317                 struct snd_usb_midi_in_endpoint *in = umidi->endpoints[i].in;
 318                 if (in && in->error_resubmit) {
 319                         in->error_resubmit = 0;
 320                         in->urb->dev = umidi->chip->dev;
 321                         snd_usbmidi_submit_urb(in->urb, GFP_ATOMIC);
 322                 }
 323                 if (umidi->endpoints[i].out)
 324                         snd_usbmidi_do_output(umidi->endpoints[i].out);
 325         }
 326         spin_unlock(&umidi->disc_lock);
 327 }
 328
 329 /* helper function to send static data that may not DMA-able */
 330 static int send_bulk_static_data(struct snd_usb_midi_out_endpoint* ep,
 331                                  const void *data, int len)
 332 {
 333         int err;
 334         void *buf = kmemdup(data, len, GFP_KERNEL);
 335         if (!buf)
 336                 return -ENOMEM;
 337         dump_urb("sending", buf, len);
 338         err = usb_bulk_msg(ep->umidi->chip->dev, ep->urb->pipe, buf, len,
 339                            NULL, 250);
 340         kfree(buf);
 341         return err;
 342 }
 343
 344 /*
 345  * Standard USB MIDI protocol: see the spec.
 346  * Midiman protocol: like the standard protocol, but the control byte is the
 347  * fourth byte in each packet, and uses length instead of CIN.
 348  */
 349
 350 static void snd_usbmidi_standard_input(struct snd_usb_midi_in_endpoint* ep,
 351                                        uint8_t* buffer, int buffer_length)
 352 {
 353         int i;
 354
 355         for (i = 0; i + 3 < buffer_length; i += 4)
 356                 if (buffer[i] != 0) {
 357                         int cable = buffer[i] >> 4;
 358                         int length = snd_usbmidi_cin_length[buffer[i] & 0x0f];
 359                         snd_usbmidi_input_data(ep, cable, &buffer[i + 1], length);
 360                 }
 361 }
 362
 363 static void snd_usbmidi_midiman_input(struct snd_usb_midi_in_endpoint* ep,
 364                                       uint8_t* buffer, int buffer_length)
 365 {
 366         int i;
 367
 368         for (i = 0; i + 3 < buffer_length; i += 4)
 369                 if (buffer[i + 3] != 0) {
 370                         int port = buffer[i + 3] >> 4;
 371                         int length = buffer[i + 3] & 3;
 372                         snd_usbmidi_input_data(ep, port, &buffer[i], length);
 373                 }
 374 }
 375
 376 /*
 377  * Buggy M-Audio device: running status on input results in a packet that has
 378  * the data bytes but not the status byte and that is marked with CIN 4.
 379  */
 380 static void snd_usbmidi_maudio_broken_running_status_input(
 381                                         struct snd_usb_midi_in_endpoint* ep,
 382                                         uint8_t* buffer, int buffer_length)
 383 {
 384         int i;
 385
 386         for (i = 0; i + 3 < buffer_length; i += 4)
 387                 if (buffer[i] != 0) {
 388                         int cable = buffer[i] >> 4;
 389                         u8 cin = buffer[i] & 0x0f;
 390                         struct usbmidi_in_port *port = &ep->ports[cable];
 391                         int length;
 392
 393                         length = snd_usbmidi_cin_length[cin];
 394                         if (cin == 0xf && buffer[i + 1] >= 0xf8)
 395                                 ; /* realtime msg: no running status change */
 396                         else if (cin >= 0x8 && cin <= 0xe)
 397                                 /* channel msg */
 398                                 port->running_status_length = length - 1;
 399                         else if (cin == 0x4 &&
 400                                  port->running_status_length != 0 &&
 401                                  buffer[i + 1] < 0x80)
 402                                 /* CIN 4 that is not a SysEx */
 403                                 length = port->running_status_length;
 404                         else
 405                                 /*
 406                                  * All other msgs cannot begin running status.
 407                                  * (A channel msg sent as two or three CIN 0xF
 408                                  * packets could in theory, but this device
 409                                  * doesn't use this format.)
 410                                  */
 411                                 port->running_status_length = 0;
 412                         snd_usbmidi_input_data(ep, cable, &buffer[i + 1], length);
 413                 }
 414 }
 415
 416 /*
 417  * CME protocol: like the standard protocol, but SysEx commands are sent as a
 418  * single USB packet preceded by a 0x0F byte.
 419  */
 420 static void snd_usbmidi_cme_input(struct snd_usb_midi_in_endpoint *ep,
 421                                   uint8_t *buffer, int buffer_length)
 422 {
 423         if (buffer_length < 2 || (buffer[0] & 0x0f) != 0x0f)
 424                 snd_usbmidi_standard_input(ep, buffer, buffer_length);
 425         else
 426                 snd_usbmidi_input_data(ep, buffer[0] >> 4,
 427                                        &buffer[1], buffer_length - 1);
 428 }
 429
 430 /*
 431  * Adds one USB MIDI packet to the output buffer.
 432  */
 433 static void snd_usbmidi_output_standard_packet(struct urb* urb, uint8_t p0,
 434                                                uint8_t p1, uint8_t p2, uint8_t p3)
 435 {
 436
 437         uint8_t* buf = (uint8_t*)urb->transfer_buffer + urb->transfer_buffer_length;
 438         buf[0] = p0;
 439         buf[1] = p1;
 440         buf[2] = p2;
 441         buf[3] = p3;
 442         urb->transfer_buffer_length += 4;
 443 }
 444
 445 /*
 446  * Adds one Midiman packet to the output buffer.
 447  */
 448 static void snd_usbmidi_output_midiman_packet(struct urb* urb, uint8_t p0,
 449                                               uint8_t p1, uint8_t p2, uint8_t p3)
 450 {
 451
 452         uint8_t* buf = (uint8_t*)urb->transfer_buffer + urb->transfer_buffer_length;
 453         buf[0] = p1;
 454         buf[1] = p2;
 455         buf[2] = p3;
 456         buf[3] = (p0 & 0xf0) | snd_usbmidi_cin_length[p0 & 0x0f];
 457         urb->transfer_buffer_length += 4;
 458 }
 459
 460 /*
 461  * Converts MIDI commands to USB MIDI packets.
 462  */
 463 static void snd_usbmidi_transmit_byte(struct usbmidi_out_port* port,
 464                                       uint8_t b, struct urb* urb)
 465 {
 466         uint8_t p0 = port->cable;
 467         void (*output_packet)(struct urb*, uint8_t, uint8_t, uint8_t, uint8_t) =
 468                 port->ep->umidi->usb_protocol_ops->output_packet;
 469
 470         if (b >= 0xf8) {
 471                 output_packet(urb, p0 | 0x0f, b, 0, 0);
 472         } else if (b >= 0xf0) {
 473                 switch (b) {
 474                 case 0xf0:
 475                         port->data[0] = b;
 476                         port->state = STATE_SYSEX_1;
 477                         break;
 478                 case 0xf1:
 479                 case 0xf3:
 480                         port->data[0] = b;
 481                         port->state = STATE_1PARAM;
 482                         break;
 483                 case 0xf2:
 484                         port->data[0] = b;
 485                         port->state = STATE_2PARAM_1;
 486                         break;
 487                 case 0xf4:
 488                 case 0xf5:
 489                         port->state = STATE_UNKNOWN;
 490                         break;
 491                 case 0xf6:
 492                         output_packet(urb, p0 | 0x05, 0xf6, 0, 0);
 493                         port->state = STATE_UNKNOWN;
 494                         break;
 495                 case 0xf7:
 496                         switch (port->state) {
 497                         case STATE_SYSEX_0:
 498                                 output_packet(urb, p0 | 0x05, 0xf7, 0, 0);
 499                                 break;
 500                         case STATE_SYSEX_1:
 501                                 output_packet(urb, p0 | 0x06, port->data[0], 0xf7, 0);
 502                                 break;
 503                         case STATE_SYSEX_2:
 504                                 output_packet(urb, p0 | 0x07, port->data[0], port->data[1], 0xf7);
 505                                 break;
 506                         }
 507                         port->state = STATE_UNKNOWN;
 508                         break;
 509                 }
 510         } else if (b >= 0x80) {
 511                 port->data[0] = b;
 512                 if (b >= 0xc0 && b <= 0xdf)
 513                         port->state = STATE_1PARAM;
 514                 else
 515                         port->state = STATE_2PARAM_1;
 516         } else { /* b < 0x80 */
 517                 switch (port->state) {
 518                 case STATE_1PARAM:
 519                         if (port->data[0] < 0xf0) {
 520                                 p0 |= port->data[0] >> 4;
 521                         } else {
 522                                 p0 |= 0x02;
 523                                 port->state = STATE_UNKNOWN;
 524                         }
 525                         output_packet(urb, p0, port->data[0], b, 0);
 526                         break;
 527                 case STATE_2PARAM_1:
 528                         port->data[1] = b;
 529                         port->state = STATE_2PARAM_2;
 530                         break;
 531                 case STATE_2PARAM_2:
 532                         if (port->data[0] < 0xf0) {
 533                                 p0 |= port->data[0] >> 4;
 534                                 port->state = STATE_2PARAM_1;
 535                         } else {
 536                                 p0 |= 0x03;
 537                                 port->state = STATE_UNKNOWN;
 538                         }
 539                         output_packet(urb, p0, port->data[0], port->data[1], b);
 540                         break;
 541                 case STATE_SYSEX_0:
 542                         port->data[0] = b;
 543                         port->state = STATE_SYSEX_1;
 544                         break;
 545                 case STATE_SYSEX_1:
 546                         port->data[1] = b;
 547                         port->state = STATE_SYSEX_2;
 548                         break;
 549                 case STATE_SYSEX_2:
 550                         output_packet(urb, p0 | 0x04, port->data[0], port->data[1], b);
 551                         port->state = STATE_SYSEX_0;
 552                         break;
 553                 }
 554         }
 555 }
 556
 557 static void snd_usbmidi_standard_output(struct snd_usb_midi_out_endpoint* ep)
 558 {
 559         struct urb* urb = ep->urb;
 560         int p;
 561
 562         /* FIXME: lower-numbered ports can starve higher-numbered ports */
 563         for (p = 0; p < 0x10; ++p) {
 564                 struct usbmidi_out_port* port = &ep->ports[p];
 565                 if (!port->active)
 566                         continue;
 567                 while (urb->transfer_buffer_length + 3 < ep->max_transfer) {
 568                         uint8_t b;
 569                         if (snd_rawmidi_transmit(port->substream, &b, 1) != 1) {
 570                                 port->active = 0;
 571                                 break;
 572                         }
 573                         snd_usbmidi_transmit_byte(port, b, urb);
 574                 }
 575         }
 576 }
 577
 578 static struct usb_protocol_ops snd_usbmidi_standard_ops = {
 579         .input = snd_usbmidi_standard_input,
 580         .output = snd_usbmidi_standard_output,
 581         .output_packet = snd_usbmidi_output_standard_packet,
 582 };
 583
 584 static struct usb_protocol_ops snd_usbmidi_midiman_ops = {
 585         .input = snd_usbmidi_midiman_input,
 586         .output = snd_usbmidi_standard_output,
 587         .output_packet = snd_usbmidi_output_midiman_packet,
 588 };
 589
 590 static struct usb_protocol_ops snd_usbmidi_maudio_broken_running_status_ops = {
 591         .input = snd_usbmidi_maudio_broken_running_status_input,
 592         .output = snd_usbmidi_standard_output,
 593         .output_packet = snd_usbmidi_output_standard_packet,
 594 };
 595
 596 static struct usb_protocol_ops snd_usbmidi_cme_ops = {
 597         .input = snd_usbmidi_cme_input,
 598         .output = snd_usbmidi_standard_output,
 599         .output_packet = snd_usbmidi_output_standard_packet,
 600 };
 601
 602 /*
 603  * Novation USB MIDI protocol: number of data bytes is in the first byte
 604  * (when receiving) (+1!) or in the second byte (when sending); data begins
 605  * at the third byte.
 606  */
 607
 608 static void snd_usbmidi_novation_input(struct snd_usb_midi_in_endpoint* ep,
 609                                        uint8_t* buffer, int buffer_length)
 610 {
 611         if (buffer_length < 2 || !buffer[0] || buffer_length < buffer[0] + 1)
 612                 return;
 613         snd_usbmidi_input_data(ep, 0, &buffer[2], buffer[0] - 1);
 614 }
 615
 616 static void snd_usbmidi_novation_output(struct snd_usb_midi_out_endpoint* ep)
 617 {
 618         uint8_t* transfer_buffer;
 619         int count;
 620
 621         if (!ep->ports[0].active)
 622                 return;
 623         transfer_buffer = ep->urb->transfer_buffer;
 624         count = snd_rawmidi_transmit(ep->ports[0].substream,
 625                                      &transfer_buffer[2],
 626                                      ep->max_transfer - 2);
 627         if (count < 1) {
 628                 ep->ports[0].active = 0;
 629                 return;
 630         }
 631         transfer_buffer[0] = 0;
 632         transfer_buffer[1] = count;
 633         ep->urb->transfer_buffer_length = 2 + count;
 634 }
 635
 636 static struct usb_protocol_ops snd_usbmidi_novation_ops = {
 637         .input = snd_usbmidi_novation_input,
 638         .output = snd_usbmidi_novation_output,
 639 };
 640
 641 /*
 642  * "raw" protocol: used by the MOTU FastLane.
 643  */
 644
 645 static void snd_usbmidi_raw_input(struct snd_usb_midi_in_endpoint* ep,
 646                                   uint8_t* buffer, int buffer_length)
 647 {
 648         snd_usbmidi_input_data(ep, 0, buffer, buffer_length);
 649 }
 650
 651 static void snd_usbmidi_raw_output(struct snd_usb_midi_out_endpoint* ep)
 652 {
 653         int count;
 654
 655         if (!ep->ports[0].active)
 656                 return;
 657         count = snd_rawmidi_transmit(ep->ports[0].substream,
 658                                      ep->urb->transfer_buffer,
 659                                      ep->max_transfer);
 660         if (count < 1) {
 661                 ep->ports[0].active = 0;
 662                 return;
 663         }
 664         ep->urb->transfer_buffer_length = count;
 665 }
 666
 667 static struct usb_protocol_ops snd_usbmidi_raw_ops = {
 668         .input = snd_usbmidi_raw_input,
 669         .output = snd_usbmidi_raw_output,
 670 };
 671
 672 static void snd_usbmidi_us122l_input(struct snd_usb_midi_in_endpoint *ep,
 673                                      uint8_t *buffer, int buffer_length)
 674 {
 675         if (buffer_length != 9)
 676                 return;
 677         buffer_length = 8;
 678         while (buffer_length && buffer[buffer_length - 1] == 0xFD)
 679                 buffer_length--;
 680         if (buffer_length)
 681                 snd_usbmidi_input_data(ep, 0, buffer, buffer_length);
 682 }
 683
 684 static void snd_usbmidi_us122l_output(struct snd_usb_midi_out_endpoint *ep)
 685 {
 686         int count;
 687
 688         if (!ep->ports[0].active)
 689                 return;
 690         count = ep->urb->dev->speed == USB_SPEED_HIGH ? 1 : 2;
 691         count = snd_rawmidi_transmit(ep->ports[0].substream,
 692                                      ep->urb->transfer_buffer,
 693                                      count);
 694         if (count < 1) {
 695                 ep->ports[0].active = 0;
 696                 return;
 697         }
 698
 699         memset(ep->urb->transfer_buffer + count, 0xFD, 9 - count);
 700         ep->urb->transfer_buffer_length = count;
 701 }
 702
 703 static struct usb_protocol_ops snd_usbmidi_122l_ops = {
 704         .input = snd_usbmidi_us122l_input,
 705         .output = snd_usbmidi_us122l_output,
 706 };
 707
 708 /*
 709  * Emagic USB MIDI protocol: raw MIDI with "F5 xx" port switching.
 710  */
 711
 712 static void snd_usbmidi_emagic_init_out(struct snd_usb_midi_out_endpoint* ep)
 713 {
 714         static const u8 init_data[] = {
 715                 /* initialization magic: "get version" */
 716                 0xf0,
 717                 0x00, 0x20, 0x31,       /* Emagic */
 718                 0x64,                   /* Unitor8 */
 719                 0x0b,                   /* version number request */
 720                 0x00,                   /* command version */
 721                 0x00,                   /* EEPROM, box 0 */
 722                 0xf7
 723         };
 724         send_bulk_static_data(ep, init_data, sizeof(init_data));
 725         /* while we're at it, pour on more magic */
 726         send_bulk_static_data(ep, init_data, sizeof(init_data));
 727 }
 728
 729 static void snd_usbmidi_emagic_finish_out(struct snd_usb_midi_out_endpoint* ep)
 730 {
 731         static const u8 finish_data[] = {
 732                 /* switch to patch mode with last preset */
 733                 0xf0,
 734                 0x00, 0x20, 0x31,       /* Emagic */
 735                 0x64,                   /* Unitor8 */
 736                 0x10,                   /* patch switch command */
 737                 0x00,                   /* command version */
 738                 0x7f,                   /* to all boxes */
 739                 0x40,                   /* last preset in EEPROM */
 740                 0xf7
 741         };
 742         send_bulk_static_data(ep, finish_data, sizeof(finish_data));
 743 }
 744
 745 static void snd_usbmidi_emagic_input(struct snd_usb_midi_in_endpoint* ep,
 746                                      uint8_t* buffer, int buffer_length)
 747 {
 748         int i;
 749
 750         /* FF indicates end of valid data */
 751         for (i = 0; i < buffer_length; ++i)
 752                 if (buffer[i] == 0xff) {
 753                         buffer_length = i;
 754                         break;
 755                 }
 756
 757         /* handle F5 at end of last buffer */
 758         if (ep->seen_f5)
 759                 goto switch_port;
 760
 761         while (buffer_length > 0) {
 762                 /* determine size of data until next F5 */
 763                 for (i = 0; i < buffer_length; ++i)
 764                         if (buffer[i] == 0xf5)
 765                                 break;
 766                 snd_usbmidi_input_data(ep, ep->current_port, buffer, i);
 767                 buffer += i;
 768                 buffer_length -= i;
 769
 770                 if (buffer_length <= 0)
 771                         break;
 772                 /* assert(buffer[0] == 0xf5); */
 773                 ep->seen_f5 = 1;
 774                 ++buffer;
 775                 --buffer_length;
 776
 777         switch_port:
 778                 if (buffer_length <= 0)
 779                         break;
 780                 if (buffer[0] < 0x80) {
 781                         ep->current_port = (buffer[0] - 1) & 15;
 782                         ++buffer;
 783                         --buffer_length;
 784                 }
 785                 ep->seen_f5 = 0;
 786         }
 787 }
 788
 789 static void snd_usbmidi_emagic_output(struct snd_usb_midi_out_endpoint* ep)
 790 {
 791         int port0 = ep->current_port;
 792         uint8_t* buf = ep->urb->transfer_buffer;
 793         int buf_free = ep->max_transfer;
 794         int length, i;
 795
 796         for (i = 0; i < 0x10; ++i) {
 797                 /* round-robin, starting at the last current port */
 798                 int portnum = (port0 + i) & 15;
 799                 struct usbmidi_out_port* port = &ep->ports[portnum];
 800
 801                 if (!port->active)
 802                         continue;
 803                 if (snd_rawmidi_transmit_peek(port->substream, buf, 1) != 1) {
 804                         port->active = 0;
 805                         continue;
 806                 }
 807
 808                 if (portnum != ep->current_port) {
 809                         if (buf_free < 2)
 810                                 break;
 811                         ep->current_port = portnum;
 812                         buf[0] = 0xf5;
 813                         buf[1] = (portnum + 1) & 15;
 814                         buf += 2;
 815                         buf_free -= 2;
 816                 }
 817
 818                 if (buf_free < 1)
 819                         break;
 820                 length = snd_rawmidi_transmit(port->substream, buf, buf_free);
 821                 if (length > 0) {
 822                         buf += length;
 823                         buf_free -= length;
 824                         if (buf_free < 1)
 825                                 break;
 826                 }
 827         }
 828         if (buf_free < ep->max_transfer && buf_free > 0) {
 829                 *buf = 0xff;
 830                 --buf_free;
 831         }
 832         ep->urb->transfer_buffer_length = ep->max_transfer - buf_free;
 833 }
 834
 835 static struct usb_protocol_ops snd_usbmidi_emagic_ops = {
 836         .input = snd_usbmidi_emagic_input,
 837         .output = snd_usbmidi_emagic_output,
 838         .init_out_endpoint = snd_usbmidi_emagic_init_out,
 839         .finish_out_endpoint = snd_usbmidi_emagic_finish_out,
 840 };
 841
 842
 843 static int snd_usbmidi_output_open(struct snd_rawmidi_substream *substream)
 844 {
 845         struct snd_usb_midi* umidi = substream->rmidi->private_data;
 846         struct usbmidi_out_port* port = NULL;
 847         int i, j;
 848
 849         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
 850                 if (umidi->endpoints[i].out)
 851                         for (j = 0; j < 0x10; ++j)
 852                                 if (umidi->endpoints[i].out->ports[j].substream == substream) {
 853                                         port = &umidi->endpoints[i].out->ports[j];
 854                                         break;
 855                                 }
 856         if (!port) {
 857                 snd_BUG();
 858                 return -ENXIO;
 859         }
 860         substream->runtime->private_data = port;
 861         port->state = STATE_UNKNOWN;
 862         return 0;
 863 }
 864
 865 static int snd_usbmidi_output_close(struct snd_rawmidi_substream *substream)
 866 {
 867         return 0;
 868 }
 869
 870 static void snd_usbmidi_output_trigger(struct snd_rawmidi_substream *substream, int up)
 871 {
 872         struct usbmidi_out_port* port = (struct usbmidi_out_port*)substream->runtime->private_data;
 873
 874         port->active = up;
 875         if (up) {
 876                 if (port->ep->umidi->chip->shutdown) {
 877                         /* gobble up remaining bytes to prevent wait in
 878                          * snd_rawmidi_drain_output */
 879                         while (!snd_rawmidi_transmit_empty(substream))
 880                                 snd_rawmidi_transmit_ack(substream, 1);
 881                         return;
 882                 }
 883                 tasklet_hi_schedule(&port->ep->tasklet);
 884         }
 885 }
 886
 887 static int snd_usbmidi_input_open(struct snd_rawmidi_substream *substream)
 888 {
 889         return 0;
 890 }
 891
 892 static int snd_usbmidi_input_close(struct snd_rawmidi_substream *substream)
 893 {
 894         return 0;
 895 }
 896
 897 static void snd_usbmidi_input_trigger(struct snd_rawmidi_substream *substream, int up)
 898 {
 899         struct snd_usb_midi* umidi = substream->rmidi->private_data;
 900
 901         if (up)
 902                 set_bit(substream->number, &umidi->input_triggered);
 903         else
 904                 clear_bit(substream->number, &umidi->input_triggered);
 905 }
 906
 907 static struct snd_rawmidi_ops snd_usbmidi_output_ops = {
 908         .open = snd_usbmidi_output_open,
 909         .close = snd_usbmidi_output_close,
 910         .trigger = snd_usbmidi_output_trigger,
 911 };
 912
 913 static struct snd_rawmidi_ops snd_usbmidi_input_ops = {
 914         .open = snd_usbmidi_input_open,
 915         .close = snd_usbmidi_input_close,
 916         .trigger = snd_usbmidi_input_trigger
 917 };
 918
 919 /*
 920  * Frees an input endpoint.
 921  * May be called when ep hasn't been initialized completely.
 922  */
 923 static void snd_usbmidi_in_endpoint_delete(struct snd_usb_midi_in_endpoint* ep)
 924 {
 925         if (ep->urb) {
 926                 usb_buffer_free(ep->umidi->chip->dev,
 927                                 ep->urb->transfer_buffer_length,
 928                                 ep->urb->transfer_buffer,
 929                                 ep->urb->transfer_dma);
 930                 usb_free_urb(ep->urb);
 931         }
 932         kfree(ep);
 933 }
 934
 935 /*
 936  * Creates an input endpoint.
 937  */
 938 static int snd_usbmidi_in_endpoint_create(struct snd_usb_midi* umidi,
 939                                           struct snd_usb_midi_endpoint_info* ep_info,
 940                                           struct snd_usb_midi_endpoint* rep)
 941 {
 942         struct snd_usb_midi_in_endpoint* ep;
 943         void* buffer;
 944         unsigned int pipe;
 945         int length;
 946
 947         rep->in = NULL;
 948         ep = kzalloc(sizeof(*ep), GFP_KERNEL);
 949         if (!ep)
 950                 return -ENOMEM;
 951         ep->umidi = umidi;
 952
 953         ep->urb = usb_alloc_urb(0, GFP_KERNEL);
 954         if (!ep->urb) {
 955                 snd_usbmidi_in_endpoint_delete(ep);
 956                 return -ENOMEM;
 957         }
 958         if (ep_info->in_interval)
 959                 pipe = usb_rcvintpipe(umidi->chip->dev, ep_info->in_ep);
 960         else
 961                 pipe = usb_rcvbulkpipe(umidi->chip->dev, ep_info->in_ep);
 962         length = usb_maxpacket(umidi->chip->dev, pipe, 0);
 963         buffer = usb_buffer_alloc(umidi->chip->dev, length, GFP_KERNEL,
 964                                   &ep->urb->transfer_dma);
 965         if (!buffer) {
 966                 snd_usbmidi_in_endpoint_delete(ep);
 967                 return -ENOMEM;
 968         }
 969         if (ep_info->in_interval)
 970                 usb_fill_int_urb(ep->urb, umidi->chip->dev, pipe, buffer,
 971                                  length, snd_usbmidi_in_urb_complete, ep,
 972                                  ep_info->in_interval);
 973         else
 974                 usb_fill_bulk_urb(ep->urb, umidi->chip->dev, pipe, buffer,
 975                                   length, snd_usbmidi_in_urb_complete, ep);
 976         ep->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
 977
 978         rep->in = ep;
 979         return 0;
 980 }
 981
 982 static unsigned int snd_usbmidi_count_bits(unsigned int x)
 983 {
 984         unsigned int bits;
 985
 986         for (bits = 0; x; ++bits)
 987                 x &= x - 1;
 988         return bits;
 989 }
 990
 991 /*
 992  * Frees an output endpoint.
 993  * May be called when ep hasn't been initialized completely.
 994  */
 995 static void snd_usbmidi_out_endpoint_delete(struct snd_usb_midi_out_endpoint* ep)
 996 {
 997         if (ep->urb) {
 998                 usb_buffer_free(ep->umidi->chip->dev, ep->max_transfer,
 999                                 ep->urb->transfer_buffer,
1000                                 ep->urb->transfer_dma);
1001                 usb_free_urb(ep->urb);
1002         }
1003         kfree(ep);
1004 }
1005
1006 /*
1007  * Creates an output endpoint, and initializes output ports.
1008  */
1009 static int snd_usbmidi_out_endpoint_create(struct snd_usb_midi* umidi,
1010                                            struct snd_usb_midi_endpoint_info* ep_info,
1011                                            struct snd_usb_midi_endpoint* rep)
1012 {
1013         struct snd_usb_midi_out_endpoint* ep;
1014         int i;
1015         unsigned int pipe;
1016         void* buffer;
1017
1018         rep->out = NULL;
1019         ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1020         if (!ep)
1021                 return -ENOMEM;
1022         ep->umidi = umidi;
1023
1024         ep->urb = usb_alloc_urb(0, GFP_KERNEL);
1025         if (!ep->urb) {
1026                 snd_usbmidi_out_endpoint_delete(ep);
1027                 return -ENOMEM;
1028         }
1029         if (ep_info->out_interval)
1030                 pipe = usb_sndintpipe(umidi->chip->dev, ep_info->out_ep);
1031         else
1032                 pipe = usb_sndbulkpipe(umidi->chip->dev, ep_info->out_ep);
1033         if (umidi->chip->usb_id == USB_ID(0x0a92, 0x1020)) /* ESI M4U */
1034                 /* FIXME: we need more URBs to get reasonable bandwidth here: */
1035                 ep->max_transfer = 4;
1036         else
1037                 ep->max_transfer = usb_maxpacket(umidi->chip->dev, pipe, 1);
1038         buffer = usb_buffer_alloc(umidi->chip->dev, ep->max_transfer,
1039                                   GFP_KERNEL, &ep->urb->transfer_dma);
1040         if (!buffer) {
1041                 snd_usbmidi_out_endpoint_delete(ep);
1042                 return -ENOMEM;
1043         }
1044         if (ep_info->out_interval)
1045                 usb_fill_int_urb(ep->urb, umidi->chip->dev, pipe, buffer,
1046                                  ep->max_transfer, snd_usbmidi_out_urb_complete,
1047                                  ep, ep_info->out_interval);
1048         else
1049                 usb_fill_bulk_urb(ep->urb, umidi->chip->dev,
1050                                   pipe, buffer, ep->max_transfer,
1051                                   snd_usbmidi_out_urb_complete, ep);
1052         ep->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1053
1054         spin_lock_init(&ep->buffer_lock);
1055         tasklet_init(&ep->tasklet, snd_usbmidi_out_tasklet, (unsigned long)ep);
1056
1057         for (i = 0; i < 0x10; ++i)
1058                 if (ep_info->out_cables & (1 << i)) {
1059                         ep->ports[i].ep = ep;
1060                         ep->ports[i].cable = i << 4;
1061                 }
1062
1063         if (umidi->usb_protocol_ops->init_out_endpoint)
1064                 umidi->usb_protocol_ops->init_out_endpoint(ep);
1065
1066         rep->out = ep;
1067         return 0;
1068 }
1069
1070 /*
1071  * Frees everything.
1072  */
1073 static void snd_usbmidi_free(struct snd_usb_midi* umidi)
1074 {
1075         int i;
1076
1077         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1078                 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
1079                 if (ep->out)
1080                         snd_usbmidi_out_endpoint_delete(ep->out);
1081                 if (ep->in)
1082                         snd_usbmidi_in_endpoint_delete(ep->in);
1083         }
1084         kfree(umidi);
1085 }
1086
1087 /*
1088  * Unlinks all URBs (must be done before the usb_device is deleted).
1089  */
1090 void snd_usbmidi_disconnect(struct list_head* p)
1091 {
1092         struct snd_usb_midi* umidi;
1093         int i;
1094
1095         umidi = list_entry(p, struct snd_usb_midi, list);
1096         /*
1097          * an URB's completion handler may start the timer and
1098          * a timer may submit an URB. To reliably break the cycle
1099          * a flag under lock must be used
1100          */
1101         spin_lock_irq(&umidi->disc_lock);
1102         umidi->disconnected = 1;
1103         spin_unlock_irq(&umidi->disc_lock);
1104         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1105                 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
1106                 if (ep->out)
1107                         tasklet_kill(&ep->out->tasklet);
1108                 if (ep->out && ep->out->urb) {
1109                         usb_kill_urb(ep->out->urb);
1110                         if (umidi->usb_protocol_ops->finish_out_endpoint)
1111                                 umidi->usb_protocol_ops->finish_out_endpoint(ep->out);
1112                 }
1113                 if (ep->in)
1114                         usb_kill_urb(ep->in->urb);
1115         }
1116         del_timer_sync(&umidi->error_timer);
1117 }
1118
1119 static void snd_usbmidi_rawmidi_free(struct snd_rawmidi *rmidi)
1120 {
1121         struct snd_usb_midi* umidi = rmidi->private_data;
1122         snd_usbmidi_free(umidi);
1123 }
1124
1125 static struct snd_rawmidi_substream *snd_usbmidi_find_substream(struct snd_usb_midi* umidi,
1126                                                            int stream, int number)
1127 {
1128         struct list_head* list;
1129
1130         list_for_each(list, &umidi->rmidi->streams[stream].substreams) {
1131                 struct snd_rawmidi_substream *substream = list_entry(list, struct snd_rawmidi_substream, list);
1132                 if (substream->number == number)
1133                         return substream;
1134         }
1135         return NULL;
1136 }
1137
1138 /*
1139  * This list specifies names for ports that do not fit into the standard
1140  * "(product) MIDI (n)" schema because they aren't external MIDI ports,
1141  * such as internal control or synthesizer ports.
1142  */
1143 static struct port_info {
1144         u32 id;
1145         short int port;
1146         short int voices;
1147         const char *name;
1148         unsigned int seq_flags;
1149 } snd_usbmidi_port_info[] = {
1150 #define PORT_INFO(vendor, product, num, name_, voices_, flags) \
1151         { .id = USB_ID(vendor, product), \
1152           .port = num, .voices = voices_, \
1153           .name = name_, .seq_flags = flags }
1154 #define EXTERNAL_PORT(vendor, product, num, name) \
1155         PORT_INFO(vendor, product, num, name, 0, \
1156                   SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1157                   SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1158                   SNDRV_SEQ_PORT_TYPE_PORT)
1159 #define CONTROL_PORT(vendor, product, num, name) \
1160         PORT_INFO(vendor, product, num, name, 0, \
1161                   SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1162                   SNDRV_SEQ_PORT_TYPE_HARDWARE)
1163 #define ROLAND_SYNTH_PORT(vendor, product, num, name, voices) \
1164         PORT_INFO(vendor, product, num, name, voices, \
1165                   SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1166                   SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1167                   SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1168                   SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1169                   SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1170                   SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1171                   SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1172 #define SOUNDCANVAS_PORT(vendor, product, num, name, voices) \
1173         PORT_INFO(vendor, product, num, name, voices, \
1174                   SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1175                   SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1176                   SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1177                   SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1178                   SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1179                   SNDRV_SEQ_PORT_TYPE_MIDI_MT32 | \
1180                   SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1181                   SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1182         /* Roland UA-100 */
1183         CONTROL_PORT(0x0582, 0x0000, 2, "%s Control"),
1184         /* Roland SC-8850 */
1185         SOUNDCANVAS_PORT(0x0582, 0x0003, 0, "%s Part A", 128),
1186         SOUNDCANVAS_PORT(0x0582, 0x0003, 1, "%s Part B", 128),
1187         SOUNDCANVAS_PORT(0x0582, 0x0003, 2, "%s Part C", 128),
1188         SOUNDCANVAS_PORT(0x0582, 0x0003, 3, "%s Part D", 128),
1189         EXTERNAL_PORT(0x0582, 0x0003, 4, "%s MIDI 1"),
1190         EXTERNAL_PORT(0x0582, 0x0003, 5, "%s MIDI 2"),
1191         /* Roland U-8 */
1192         EXTERNAL_PORT(0x0582, 0x0004, 0, "%s MIDI"),
1193         CONTROL_PORT(0x0582, 0x0004, 1, "%s Control"),
1194         /* Roland SC-8820 */
1195         SOUNDCANVAS_PORT(0x0582, 0x0007, 0, "%s Part A", 64),
1196         SOUNDCANVAS_PORT(0x0582, 0x0007, 1, "%s Part B", 64),
1197         EXTERNAL_PORT(0x0582, 0x0007, 2, "%s MIDI"),
1198         /* Roland SK-500 */
1199         SOUNDCANVAS_PORT(0x0582, 0x000b, 0, "%s Part A", 64),
1200         SOUNDCANVAS_PORT(0x0582, 0x000b, 1, "%s Part B", 64),
1201         EXTERNAL_PORT(0x0582, 0x000b, 2, "%s MIDI"),
1202         /* Roland SC-D70 */
1203         SOUNDCANVAS_PORT(0x0582, 0x000c, 0, "%s Part A", 64),
1204         SOUNDCANVAS_PORT(0x0582, 0x000c, 1, "%s Part B", 64),
1205         EXTERNAL_PORT(0x0582, 0x000c, 2, "%s MIDI"),
1206         /* Edirol UM-880 */
1207         CONTROL_PORT(0x0582, 0x0014, 8, "%s Control"),
1208         /* Edirol SD-90 */
1209         ROLAND_SYNTH_PORT(0x0582, 0x0016, 0, "%s Part A", 128),
1210         ROLAND_SYNTH_PORT(0x0582, 0x0016, 1, "%s Part B", 128),
1211         EXTERNAL_PORT(0x0582, 0x0016, 2, "%s MIDI 1"),
1212         EXTERNAL_PORT(0x0582, 0x0016, 3, "%s MIDI 2"),
1213         /* Edirol UM-550 */
1214         CONTROL_PORT(0x0582, 0x0023, 5, "%s Control"),
1215         /* Edirol SD-20 */
1216         ROLAND_SYNTH_PORT(0x0582, 0x0027, 0, "%s Part A", 64),
1217         ROLAND_SYNTH_PORT(0x0582, 0x0027, 1, "%s Part B", 64),
1218         EXTERNAL_PORT(0x0582, 0x0027, 2, "%s MIDI"),
1219         /* Edirol SD-80 */
1220         ROLAND_SYNTH_PORT(0x0582, 0x0029, 0, "%s Part A", 128),
1221         ROLAND_SYNTH_PORT(0x0582, 0x0029, 1, "%s Part B", 128),
1222         EXTERNAL_PORT(0x0582, 0x0029, 2, "%s MIDI 1"),
1223         EXTERNAL_PORT(0x0582, 0x0029, 3, "%s MIDI 2"),
1224         /* Edirol UA-700 */
1225         EXTERNAL_PORT(0x0582, 0x002b, 0, "%s MIDI"),
1226         CONTROL_PORT(0x0582, 0x002b, 1, "%s Control"),
1227         /* Roland VariOS */
1228         EXTERNAL_PORT(0x0582, 0x002f, 0, "%s MIDI"),
1229         EXTERNAL_PORT(0x0582, 0x002f, 1, "%s External MIDI"),
1230         EXTERNAL_PORT(0x0582, 0x002f, 2, "%s Sync"),
1231         /* Edirol PCR */
1232         EXTERNAL_PORT(0x0582, 0x0033, 0, "%s MIDI"),
1233         EXTERNAL_PORT(0x0582, 0x0033, 1, "%s 1"),
1234         EXTERNAL_PORT(0x0582, 0x0033, 2, "%s 2"),
1235         /* BOSS GS-10 */
1236         EXTERNAL_PORT(0x0582, 0x003b, 0, "%s MIDI"),
1237         CONTROL_PORT(0x0582, 0x003b, 1, "%s Control"),
1238         /* Edirol UA-1000 */
1239         EXTERNAL_PORT(0x0582, 0x0044, 0, "%s MIDI"),
1240         CONTROL_PORT(0x0582, 0x0044, 1, "%s Control"),
1241         /* Edirol UR-80 */
1242         EXTERNAL_PORT(0x0582, 0x0048, 0, "%s MIDI"),
1243         EXTERNAL_PORT(0x0582, 0x0048, 1, "%s 1"),
1244         EXTERNAL_PORT(0x0582, 0x0048, 2, "%s 2"),
1245         /* Edirol PCR-A */
1246         EXTERNAL_PORT(0x0582, 0x004d, 0, "%s MIDI"),
1247         EXTERNAL_PORT(0x0582, 0x004d, 1, "%s 1"),
1248         EXTERNAL_PORT(0x0582, 0x004d, 2, "%s 2"),
1249         /* Edirol UM-3EX */
1250         CONTROL_PORT(0x0582, 0x009a, 3, "%s Control"),
1251         /* M-Audio MidiSport 8x8 */
1252         CONTROL_PORT(0x0763, 0x1031, 8, "%s Control"),
1253         CONTROL_PORT(0x0763, 0x1033, 8, "%s Control"),
1254         /* MOTU Fastlane */
1255         EXTERNAL_PORT(0x07fd, 0x0001, 0, "%s MIDI A"),
1256         EXTERNAL_PORT(0x07fd, 0x0001, 1, "%s MIDI B"),
1257         /* Emagic Unitor8/AMT8/MT4 */
1258         EXTERNAL_PORT(0x086a, 0x0001, 8, "%s Broadcast"),
1259         EXTERNAL_PORT(0x086a, 0x0002, 8, "%s Broadcast"),
1260         EXTERNAL_PORT(0x086a, 0x0003, 4, "%s Broadcast"),
1261 };
1262
1263 static struct port_info *find_port_info(struct snd_usb_midi* umidi, int number)
1264 {
1265         int i;
1266
1267         for (i = 0; i < ARRAY_SIZE(snd_usbmidi_port_info); ++i) {
1268                 if (snd_usbmidi_port_info[i].id == umidi->chip->usb_id &&
1269                     snd_usbmidi_port_info[i].port == number)
1270                         return &snd_usbmidi_port_info[i];
1271         }
1272         return NULL;
1273 }
1274
1275 static void snd_usbmidi_get_port_info(struct snd_rawmidi *rmidi, int number,
1276                                       struct snd_seq_port_info *seq_port_info)
1277 {
1278         struct snd_usb_midi *umidi = rmidi->private_data;
1279         struct port_info *port_info;
1280
1281         /* TODO: read port flags from descriptors */
1282         port_info = find_port_info(umidi, number);
1283         if (port_info) {
1284                 seq_port_info->type = port_info->seq_flags;
1285                 seq_port_info->midi_voices = port_info->voices;
1286         }
1287 }
1288
1289 static void snd_usbmidi_init_substream(struct snd_usb_midi* umidi,
1290                                        int stream, int number,
1291                                        struct snd_rawmidi_substream ** rsubstream)
1292 {
1293         struct port_info *port_info;
1294         const char *name_format;
1295
1296         struct snd_rawmidi_substream *substream = snd_usbmidi_find_substream(umidi, stream, number);
1297         if (!substream) {
1298                 snd_printd(KERN_ERR "substream %d:%d not found\n", stream, number);
1299                 return;
1300         }
1301
1302         /* TODO: read port name from jack descriptor */
1303         port_info = find_port_info(umidi, number);
1304         name_format = port_info ? port_info->name : "%s MIDI %d";
1305         snprintf(substream->name, sizeof(substream->name),
1306                  name_format, umidi->chip->card->shortname, number + 1);
1307
1308         *rsubstream = substream;
1309 }
1310
1311 /*
1312  * Creates the endpoints and their ports.
1313  */
1314 static int snd_usbmidi_create_endpoints(struct snd_usb_midi* umidi,
1315                                         struct snd_usb_midi_endpoint_info* endpoints)
1316 {
1317         int i, j, err;
1318         int out_ports = 0, in_ports = 0;
1319
1320         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1321                 if (endpoints[i].out_cables) {
1322                         err = snd_usbmidi_out_endpoint_create(umidi, &endpoints[i],
1323                                                               &umidi->endpoints[i]);
1324                         if (err < 0)
1325                                 return err;
1326                 }
1327                 if (endpoints[i].in_cables) {
1328                         err = snd_usbmidi_in_endpoint_create(umidi, &endpoints[i],
1329                                                              &umidi->endpoints[i]);
1330                         if (err < 0)
1331                                 return err;
1332                 }
1333
1334                 for (j = 0; j < 0x10; ++j) {
1335                         if (endpoints[i].out_cables & (1 << j)) {
1336                                 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_OUTPUT, out_ports,
1337                                                            &umidi->endpoints[i].out->ports[j].substream);
1338                                 ++out_ports;
1339                         }
1340                         if (endpoints[i].in_cables & (1 << j)) {
1341                                 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_INPUT, in_ports,
1342                                                            &umidi->endpoints[i].in->ports[j].substream);
1343                                 ++in_ports;
1344                         }
1345                 }
1346         }
1347         snd_printdd(KERN_INFO "created %d output and %d input ports\n",
1348                     out_ports, in_ports);
1349         return 0;
1350 }
1351
1352 /*
1353  * Returns MIDIStreaming device capabilities.
1354  */
1355 static int snd_usbmidi_get_ms_info(struct snd_usb_midi* umidi,
1356                                    struct snd_usb_midi_endpoint_info* endpoints)
1357 {
1358         struct usb_interface* intf;
1359         struct usb_host_interface *hostif;
1360         struct usb_interface_descriptor* intfd;
1361         struct usb_ms_header_descriptor* ms_header;
1362         struct usb_host_endpoint *hostep;
1363         struct usb_endpoint_descriptor* ep;
1364         struct usb_ms_endpoint_descriptor* ms_ep;
1365         int i, epidx;
1366
1367         intf = umidi->iface;
1368         if (!intf)
1369                 return -ENXIO;
1370         hostif = &intf->altsetting[0];
1371         intfd = get_iface_desc(hostif);
1372         ms_header = (struct usb_ms_header_descriptor*)hostif->extra;
1373         if (hostif->extralen >= 7 &&
1374             ms_header->bLength >= 7 &&
1375             ms_header->bDescriptorType == USB_DT_CS_INTERFACE &&
1376             ms_header->bDescriptorSubtype == HEADER)
1377                 snd_printdd(KERN_INFO "MIDIStreaming version %02x.%02x\n",
1378                             ms_header->bcdMSC[1], ms_header->bcdMSC[0]);
1379         else
1380                 snd_printk(KERN_WARNING "MIDIStreaming interface descriptor not found\n");
1381
1382         epidx = 0;
1383         for (i = 0; i < intfd->bNumEndpoints; ++i) {
1384                 hostep = &hostif->endpoint[i];
1385                 ep = get_ep_desc(hostep);
1386                 if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK &&
1387                     (ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
1388                         continue;
1389                 ms_ep = (struct usb_ms_endpoint_descriptor*)hostep->extra;
1390                 if (hostep->extralen < 4 ||
1391                     ms_ep->bLength < 4 ||
1392                     ms_ep->bDescriptorType != USB_DT_CS_ENDPOINT ||
1393                     ms_ep->bDescriptorSubtype != MS_GENERAL)
1394                         continue;
1395                 if ((ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) {
1396                         if (endpoints[epidx].out_ep) {
1397                                 if (++epidx >= MIDI_MAX_ENDPOINTS) {
1398                                         snd_printk(KERN_WARNING "too many endpoints\n");
1399                                         break;
1400                                 }
1401                         }
1402                         endpoints[epidx].out_ep = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1403                         if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)
1404                                 endpoints[epidx].out_interval = ep->bInterval;
1405                         else if (snd_usb_get_speed(umidi->chip->dev) == USB_SPEED_LOW)
1406                                 /*
1407                                  * Low speed bulk transfers don't exist, so
1408                                  * force interrupt transfers for devices like
1409                                  * ESI MIDI Mate that try to use them anyway.
1410                                  */
1411                                 endpoints[epidx].out_interval = 1;
1412                         endpoints[epidx].out_cables = (1 << ms_ep->bNumEmbMIDIJack) - 1;
1413                         snd_printdd(KERN_INFO "EP %02X: %d jack(s)\n",
1414                                     ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1415                 } else {
1416                         if (endpoints[epidx].in_ep) {
1417                                 if (++epidx >= MIDI_MAX_ENDPOINTS) {
1418                                         snd_printk(KERN_WARNING "too many endpoints\n");
1419                                         break;
1420                                 }
1421                         }
1422                         endpoints[epidx].in_ep = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1423                         if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)
1424                                 endpoints[epidx].in_interval = ep->bInterval;
1425                         else if (snd_usb_get_speed(umidi->chip->dev) == USB_SPEED_LOW)
1426                                 endpoints[epidx].in_interval = 1;
1427                         endpoints[epidx].in_cables = (1 << ms_ep->bNumEmbMIDIJack) - 1;
1428                         snd_printdd(KERN_INFO "EP %02X: %d jack(s)\n",
1429                                     ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1430                 }
1431         }
1432         return 0;
1433 }
1434
1435 /*
1436  * On Roland devices, use the second alternate setting to be able to use
1437  * the interrupt input endpoint.
1438  */
1439 static void snd_usbmidi_switch_roland_altsetting(struct snd_usb_midi* umidi)
1440 {
1441         struct usb_interface* intf;
1442         struct usb_host_interface *hostif;
1443         struct usb_interface_descriptor* intfd;
1444
1445         intf = umidi->iface;
1446         if (!intf || intf->num_altsetting != 2)
1447                 return;
1448
1449         hostif = &intf->altsetting[1];
1450         intfd = get_iface_desc(hostif);
1451         if (intfd->bNumEndpoints != 2 ||
1452             (get_endpoint(hostif, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK ||
1453             (get_endpoint(hostif, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
1454                 return;
1455
1456         snd_printdd(KERN_INFO "switching to altsetting %d with int ep\n",
1457                     intfd->bAlternateSetting);
1458         usb_set_interface(umidi->chip->dev, intfd->bInterfaceNumber,
1459                           intfd->bAlternateSetting);
1460 }
1461
1462 /*
1463  * Try to find any usable endpoints in the interface.
1464  */
1465 static int snd_usbmidi_detect_endpoints(struct snd_usb_midi* umidi,
1466                                         struct snd_usb_midi_endpoint_info* endpoint,
1467                                         int max_endpoints)
1468 {
1469         struct usb_interface* intf;
1470         struct usb_host_interface *hostif;
1471         struct usb_interface_descriptor* intfd;
1472         struct usb_endpoint_descriptor* epd;
1473         int i, out_eps = 0, in_eps = 0;
1474
1475         if (USB_ID_VENDOR(umidi->chip->usb_id) == 0x0582)
1476                 snd_usbmidi_switch_roland_altsetting(umidi);
1477
1478         if (endpoint[0].out_ep || endpoint[0].in_ep)
1479                 return 0;
1480
1481         intf = umidi->iface;
1482         if (!intf || intf->num_altsetting < 1)
1483                 return -ENOENT;
1484         hostif = intf->cur_altsetting;
1485         intfd = get_iface_desc(hostif);
1486
1487         for (i = 0; i < intfd->bNumEndpoints; ++i) {
1488                 epd = get_endpoint(hostif, i);
1489                 if ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK &&
1490                     (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
1491                         continue;
1492                 if (out_eps < max_endpoints &&
1493                     (epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) {
1494                         endpoint[out_eps].out_ep = epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1495                         if ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)
1496                                 endpoint[out_eps].out_interval = epd->bInterval;
1497                         ++out_eps;
1498                 }
1499                 if (in_eps < max_endpoints &&
1500                     (epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN) {
1501                         endpoint[in_eps].in_ep = epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1502                         if ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)
1503                                 endpoint[in_eps].in_interval = epd->bInterval;
1504                         ++in_eps;
1505                 }
1506         }
1507         return (out_eps || in_eps) ? 0 : -ENOENT;
1508 }
1509
1510 /*
1511  * Detects the endpoints for one-port-per-endpoint protocols.
1512  */
1513 static int snd_usbmidi_detect_per_port_endpoints(struct snd_usb_midi* umidi,
1514                                                  struct snd_usb_midi_endpoint_info* endpoints)
1515 {
1516         int err, i;
1517
1518         err = snd_usbmidi_detect_endpoints(umidi, endpoints, MIDI_MAX_ENDPOINTS);
1519         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1520                 if (endpoints[i].out_ep)
1521                         endpoints[i].out_cables = 0x0001;
1522                 if (endpoints[i].in_ep)
1523                         endpoints[i].in_cables = 0x0001;
1524         }
1525         return err;
1526 }
1527
1528 /*
1529  * Detects the endpoints and ports of Yamaha devices.
1530  */
1531 static int snd_usbmidi_detect_yamaha(struct snd_usb_midi* umidi,
1532                                      struct snd_usb_midi_endpoint_info* endpoint)
1533 {
1534         struct usb_interface* intf;
1535         struct usb_host_interface *hostif;
1536         struct usb_interface_descriptor* intfd;
1537         uint8_t* cs_desc;
1538
1539         intf = umidi->iface;
1540         if (!intf)
1541                 return -ENOENT;
1542         hostif = intf->altsetting;
1543         intfd = get_iface_desc(hostif);
1544         if (intfd->bNumEndpoints < 1)
1545                 return -ENOENT;
1546
1547         /*
1548          * For each port there is one MIDI_IN/OUT_JACK descriptor, not
1549          * necessarily with any useful contents.  So simply count 'em.
1550          */
1551         for (cs_desc = hostif->extra;
1552              cs_desc < hostif->extra + hostif->extralen && cs_desc[0] >= 2;
1553              cs_desc += cs_desc[0]) {
1554                 if (cs_desc[1] == USB_DT_CS_INTERFACE) {
1555                         if (cs_desc[2] == MIDI_IN_JACK)
1556                                 endpoint->in_cables = (endpoint->in_cables << 1) | 1;
1557                         else if (cs_desc[2] == MIDI_OUT_JACK)
1558                                 endpoint->out_cables = (endpoint->out_cables << 1) | 1;
1559                 }
1560         }
1561         if (!endpoint->in_cables && !endpoint->out_cables)
1562                 return -ENOENT;
1563
1564         return snd_usbmidi_detect_endpoints(umidi, endpoint, 1);
1565 }
1566
1567 /*
1568  * Creates the endpoints and their ports for Midiman devices.
1569  */
1570 static int snd_usbmidi_create_endpoints_midiman(struct snd_usb_midi* umidi,
1571                                                 struct snd_usb_midi_endpoint_info* endpoint)
1572 {
1573         struct snd_usb_midi_endpoint_info ep_info;
1574         struct usb_interface* intf;
1575         struct usb_host_interface *hostif;
1576         struct usb_interface_descriptor* intfd;
1577         struct usb_endpoint_descriptor* epd;
1578         int cable, err;
1579
1580         intf = umidi->iface;
1581         if (!intf)
1582                 return -ENOENT;
1583         hostif = intf->altsetting;
1584         intfd = get_iface_desc(hostif);
1585         /*
1586          * The various MidiSport devices have more or less random endpoint
1587          * numbers, so we have to identify the endpoints by their index in
1588          * the descriptor array, like the driver for that other OS does.
1589          *
1590          * There is one interrupt input endpoint for all input ports, one
1591          * bulk output endpoint for even-numbered ports, and one for odd-
1592          * numbered ports.  Both bulk output endpoints have corresponding
1593          * input bulk endpoints (at indices 1 and 3) which aren't used.
1594          */
1595         if (intfd->bNumEndpoints < (endpoint->out_cables > 0x0001 ? 5 : 3)) {
1596                 snd_printdd(KERN_ERR "not enough endpoints\n");
1597                 return -ENOENT;
1598         }
1599
1600         epd = get_endpoint(hostif, 0);
1601         if ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) != USB_DIR_IN ||
1602             (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT) {
1603                 snd_printdd(KERN_ERR "endpoint[0] isn't interrupt\n");
1604                 return -ENXIO;
1605         }
1606         epd = get_endpoint(hostif, 2);
1607         if ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) != USB_DIR_OUT ||
1608             (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) {
1609                 snd_printdd(KERN_ERR "endpoint[2] isn't bulk output\n");
1610                 return -ENXIO;
1611         }
1612         if (endpoint->out_cables > 0x0001) {
1613                 epd = get_endpoint(hostif, 4);
1614                 if ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) != USB_DIR_OUT ||
1615                     (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) {
1616                         snd_printdd(KERN_ERR "endpoint[4] isn't bulk output\n");
1617                         return -ENXIO;
1618                 }
1619         }
1620
1621         ep_info.out_ep = get_endpoint(hostif, 2)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1622         ep_info.out_cables = endpoint->out_cables & 0x5555;
1623         err = snd_usbmidi_out_endpoint_create(umidi, &ep_info, &umidi->endpoints[0]);
1624         if (err < 0)
1625                 return err;
1626
1627         ep_info.in_ep = get_endpoint(hostif, 0)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1628         ep_info.in_interval = get_endpoint(hostif, 0)->bInterval;
1629         ep_info.in_cables = endpoint->in_cables;
1630         err = snd_usbmidi_in_endpoint_create(umidi, &ep_info, &umidi->endpoints[0]);
1631         if (err < 0)
1632                 return err;
1633
1634         if (endpoint->out_cables > 0x0001) {
1635                 ep_info.out_ep = get_endpoint(hostif, 4)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1636                 ep_info.out_cables = endpoint->out_cables & 0xaaaa;
1637                 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info, &umidi->endpoints[1]);
1638                 if (err < 0)
1639                         return err;
1640         }
1641
1642         for (cable = 0; cable < 0x10; ++cable) {
1643                 if (endpoint->out_cables & (1 << cable))
1644                         snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_OUTPUT, cable,
1645                                                    &umidi->endpoints[cable & 1].out->ports[cable].substream);
1646                 if (endpoint->in_cables & (1 << cable))
1647                         snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_INPUT, cable,
1648                                                    &umidi->endpoints[0].in->ports[cable].substream);
1649         }
1650         return 0;
1651 }
1652
1653 static struct snd_rawmidi_global_ops snd_usbmidi_ops = {
1654         .get_port_info = snd_usbmidi_get_port_info,
1655 };
1656
1657 static int snd_usbmidi_create_rawmidi(struct snd_usb_midi* umidi,
1658                                       int out_ports, int in_ports)
1659 {
1660         struct snd_rawmidi *rmidi;
1661         int err;
1662
1663         err = snd_rawmidi_new(umidi->chip->card, "USB MIDI",
1664                               umidi->chip->next_midi_device++,
1665                               out_ports, in_ports, &rmidi);
1666         if (err < 0)
1667                 return err;
1668         strcpy(rmidi->name, umidi->chip->card->shortname);
1669         rmidi->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT |
1670                             SNDRV_RAWMIDI_INFO_INPUT |
1671                             SNDRV_RAWMIDI_INFO_DUPLEX;
1672         rmidi->ops = &snd_usbmidi_ops;
1673         rmidi->private_data = umidi;
1674         rmidi->private_free = snd_usbmidi_rawmidi_free;
1675         snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_usbmidi_output_ops);
1676         snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_usbmidi_input_ops);
1677
1678         umidi->rmidi = rmidi;
1679         return 0;
1680 }
1681
1682 /*
1683  * Temporarily stop input.
1684  */
1685 void snd_usbmidi_input_stop(struct list_head* p)
1686 {
1687         struct snd_usb_midi* umidi;
1688         int i;
1689
1690         umidi = list_entry(p, struct snd_usb_midi, list);
1691         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1692                 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
1693                 if (ep->in)
1694                         usb_kill_urb(ep->in->urb);
1695         }
1696 }
1697
1698 static void snd_usbmidi_input_start_ep(struct snd_usb_midi_in_endpoint* ep)
1699 {
1700         if (ep) {
1701                 struct urb* urb = ep->urb;
1702                 urb->dev = ep->umidi->chip->dev;
1703                 snd_usbmidi_submit_urb(urb, GFP_KERNEL);
1704         }
1705 }
1706
1707 /*
1708  * Resume input after a call to snd_usbmidi_input_stop().
1709  */
1710 void snd_usbmidi_input_start(struct list_head* p)
1711 {
1712         struct snd_usb_midi* umidi;
1713         int i;
1714
1715         umidi = list_entry(p, struct snd_usb_midi, list);
1716         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
1717                 snd_usbmidi_input_start_ep(umidi->endpoints[i].in);
1718 }
1719
1720 /*
1721  * Creates and registers everything needed for a MIDI streaming interface.
1722  */
1723 int snd_usb_create_midi_interface(struct snd_usb_audio* chip,
1724                                   struct usb_interface* iface,
1725                                   const struct snd_usb_audio_quirk* quirk)
1726 {
1727         struct snd_usb_midi* umidi;
1728         struct snd_usb_midi_endpoint_info endpoints[MIDI_MAX_ENDPOINTS];
1729         int out_ports, in_ports;
1730         int i, err;
1731
1732         umidi = kzalloc(sizeof(*umidi), GFP_KERNEL);
1733         if (!umidi)
1734                 return -ENOMEM;
1735         umidi->chip = chip;
1736         umidi->iface = iface;
1737         umidi->quirk = quirk;
1738         umidi->usb_protocol_ops = &snd_usbmidi_standard_ops;
1739         init_timer(&umidi->error_timer);
1740         spin_lock_init(&umidi->disc_lock);
1741         umidi->error_timer.function = snd_usbmidi_error_timer;
1742         umidi->error_timer.data = (unsigned long)umidi;
1743
1744         /* detect the endpoint(s) to use */
1745         memset(endpoints, 0, sizeof(endpoints));
1746         switch (quirk ? quirk->type : QUIRK_MIDI_STANDARD_INTERFACE) {
1747         case QUIRK_MIDI_STANDARD_INTERFACE:
1748                 err = snd_usbmidi_get_ms_info(umidi, endpoints);
1749                 if (chip->usb_id == USB_ID(0x0763, 0x0150)) /* M-Audio Uno */
1750                         umidi->usb_protocol_ops =
1751                                 &snd_usbmidi_maudio_broken_running_status_ops;
1752                 break;
1753         case QUIRK_MIDI_US122L:
1754                 umidi->usb_protocol_ops = &snd_usbmidi_122l_ops;
1755                 /* fall through */
1756         case QUIRK_MIDI_FIXED_ENDPOINT:
1757                 memcpy(&endpoints[0], quirk->data,
1758                        sizeof(struct snd_usb_midi_endpoint_info));
1759                 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
1760                 break;
1761         case QUIRK_MIDI_YAMAHA:
1762                 err = snd_usbmidi_detect_yamaha(umidi, &endpoints[0]);
1763                 break;
1764         case QUIRK_MIDI_MIDIMAN:
1765                 umidi->usb_protocol_ops = &snd_usbmidi_midiman_ops;
1766                 memcpy(&endpoints[0], quirk->data,
1767                        sizeof(struct snd_usb_midi_endpoint_info));
1768                 err = 0;
1769                 break;
1770         case QUIRK_MIDI_NOVATION:
1771                 umidi->usb_protocol_ops = &snd_usbmidi_novation_ops;
1772                 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
1773                 break;
1774         case QUIRK_MIDI_RAW:
1775                 umidi->usb_protocol_ops = &snd_usbmidi_raw_ops;
1776                 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
1777                 break;
1778         case QUIRK_MIDI_EMAGIC:
1779                 umidi->usb_protocol_ops = &snd_usbmidi_emagic_ops;
1780                 memcpy(&endpoints[0], quirk->data,
1781                        sizeof(struct snd_usb_midi_endpoint_info));
1782                 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
1783                 break;
1784         case QUIRK_MIDI_CME:
1785                 umidi->usb_protocol_ops = &snd_usbmidi_cme_ops;
1786                 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
1787                 break;
1788         default:
1789                 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
1790                 err = -ENXIO;
1791                 break;
1792         }
1793         if (err < 0) {
1794                 kfree(umidi);
1795                 return err;
1796         }
1797
1798         /* create rawmidi device */
1799         out_ports = 0;
1800         in_ports = 0;
1801         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1802                 out_ports += snd_usbmidi_count_bits(endpoints[i].out_cables);
1803                 in_ports += snd_usbmidi_count_bits(endpoints[i].in_cables);
1804         }
1805         err = snd_usbmidi_create_rawmidi(umidi, out_ports, in_ports);
1806         if (err < 0) {
1807                 kfree(umidi);
1808                 return err;
1809         }
1810
1811         /* create endpoint/port structures */
1812         if (quirk && quirk->type == QUIRK_MIDI_MIDIMAN)
1813                 err = snd_usbmidi_create_endpoints_midiman(umidi, &endpoints[0]);
1814         else
1815                 err = snd_usbmidi_create_endpoints(umidi, endpoints);
1816         if (err < 0) {
1817                 snd_usbmidi_free(umidi);
1818                 return err;
1819         }
1820
1821         list_add(&umidi->list, &umidi->chip->midi_list);
1822
1823         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
1824                 snd_usbmidi_input_start_ep(umidi->endpoints[i].in);
1825         return 0;
1826 }
1827
1828 EXPORT_SYMBOL(snd_usb_create_midi_interface);
1829 EXPORT_SYMBOL(snd_usbmidi_input_stop);
1830 EXPORT_SYMBOL(snd_usbmidi_input_start);
1831 EXPORT_SYMBOL(snd_usbmidi_disconnect);