sound/usb/midi.c

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