sound/usb/usbmidi.c

   1 /*
   2  * usbmidi.c - ALSA USB MIDI driver
   3  *
   4  * Copyright (c) 2002-2005 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 <sound/driver.h>
  39 #include <linux/kernel.h>
  40 #include <linux/types.h>
  41 #include <linux/bitops.h>
  42 #include <linux/interrupt.h>
  43 #include <linux/spinlock.h>
  44 #include <linux/string.h>
  45 #include <linux/init.h>
  46 #include <linux/slab.h>
  47 #include <linux/timer.h>
  48 #include <linux/usb.h>
  49 #include <sound/core.h>
  50 #include <sound/rawmidi.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
 108         struct snd_usb_midi_endpoint {
 109                 struct snd_usb_midi_out_endpoint *out;
 110                 struct snd_usb_midi_in_endpoint *in;
 111         } endpoints[MIDI_MAX_ENDPOINTS];
 112         unsigned long input_triggered;
 113 };
 114
 115 struct snd_usb_midi_out_endpoint {
 116         struct snd_usb_midi* umidi;
 117         struct urb* urb;
 118         int urb_active;
 119         int max_transfer;               /* size of urb buffer */
 120         struct tasklet_struct tasklet;
 121
 122         spinlock_t buffer_lock;
 123
 124         struct usbmidi_out_port {
 125                 struct snd_usb_midi_out_endpoint* ep;
 126                 struct snd_rawmidi_substream *substream;
 127                 int active;
 128                 uint8_t cable;          /* cable number << 4 */
 129                 uint8_t state;
 130 #define STATE_UNKNOWN   0
 131 #define STATE_1PARAM    1
 132 #define STATE_2PARAM_1  2
 133 #define STATE_2PARAM_2  3
 134 #define STATE_SYSEX_0   4
 135 #define STATE_SYSEX_1   5
 136 #define STATE_SYSEX_2   6
 137                 uint8_t data[2];
 138         } ports[0x10];
 139         int current_port;
 140 };
 141
 142 struct snd_usb_midi_in_endpoint {
 143         struct snd_usb_midi* umidi;
 144         struct urb* urb;
 145         struct usbmidi_in_port {
 146                 struct snd_rawmidi_substream *substream;
 147         } ports[0x10];
 148         u8 seen_f5;
 149         u8 error_resubmit;
 150         int current_port;
 151 };
 152
 153 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint* ep);
 154
 155 static const uint8_t snd_usbmidi_cin_length[] = {
 156         0, 0, 2, 3, 3, 1, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1
 157 };
 158
 159 /*
 160  * Submits the URB, with error handling.
 161  */
 162 static int snd_usbmidi_submit_urb(struct urb* urb, gfp_t flags)
 163 {
 164         int err = usb_submit_urb(urb, flags);
 165         if (err < 0 && err != -ENODEV)
 166                 snd_printk(KERN_ERR "usb_submit_urb: %d\n", err);
 167         return err;
 168 }
 169
 170 /*
 171  * Error handling for URB completion functions.
 172  */
 173 static int snd_usbmidi_urb_error(int status)
 174 {
 175         switch (status) {
 176         /* manually unlinked, or device gone */
 177         case -ENOENT:
 178         case -ECONNRESET:
 179         case -ESHUTDOWN:
 180         case -ENODEV:
 181                 return -ENODEV;
 182         /* errors that might occur during unplugging */
 183         case -EPROTO:    /* EHCI */
 184         case -ETIMEDOUT: /* OHCI */
 185         case -EILSEQ:    /* UHCI */
 186                 return -EIO;
 187         default:
 188                 snd_printk(KERN_ERR "urb status %d\n", status);
 189                 return 0; /* continue */
 190         }
 191 }
 192
 193 /*
 194  * Receives a chunk of MIDI data.
 195  */
 196 static void snd_usbmidi_input_data(struct snd_usb_midi_in_endpoint* ep, int portidx,
 197                                    uint8_t* data, int length)
 198 {
 199         struct usbmidi_in_port* port = &ep->ports[portidx];
 200
 201         if (!port->substream) {
 202                 snd_printd("unexpected port %d!\n", portidx);
 203                 return;
 204         }
 205         if (!test_bit(port->substream->number, &ep->umidi->input_triggered))
 206                 return;
 207         snd_rawmidi_receive(port->substream, data, length);
 208 }
 209
 210 #ifdef DUMP_PACKETS
 211 static void dump_urb(const char *type, const u8 *data, int length)
 212 {
 213         snd_printk(KERN_DEBUG "%s packet: [", type);
 214         for (; length > 0; ++data, --length)
 215                 printk(" %02x", *data);
 216         printk(" ]\n");
 217 }
 218 #else
 219 #define dump_urb(type, data, length) /* nothing */
 220 #endif
 221
 222 /*
 223  * Processes the data read from the device.
 224  */
 225 static void snd_usbmidi_in_urb_complete(struct urb* urb, struct pt_regs *regs)
 226 {
 227         struct snd_usb_midi_in_endpoint* ep = urb->context;
 228
 229         if (urb->status == 0) {
 230                 dump_urb("received", urb->transfer_buffer, urb->actual_length);
 231                 ep->umidi->usb_protocol_ops->input(ep, urb->transfer_buffer,
 232                                                    urb->actual_length);
 233         } else {
 234                 int err = snd_usbmidi_urb_error(urb->status);
 235                 if (err < 0) {
 236                         if (err != -ENODEV) {
 237                                 ep->error_resubmit = 1;
 238                                 mod_timer(&ep->umidi->error_timer,
 239                                           jiffies + ERROR_DELAY_JIFFIES);
 240                         }
 241                         return;
 242                 }
 243         }
 244
 245         urb->dev = ep->umidi->chip->dev;
 246         snd_usbmidi_submit_urb(urb, GFP_ATOMIC);
 247 }
 248
 249 static void snd_usbmidi_out_urb_complete(struct urb* urb, struct pt_regs *regs)
 250 {
 251         struct snd_usb_midi_out_endpoint* ep = urb->context;
 252
 253         spin_lock(&ep->buffer_lock);
 254         ep->urb_active = 0;
 255         spin_unlock(&ep->buffer_lock);
 256         if (urb->status < 0) {
 257                 int err = snd_usbmidi_urb_error(urb->status);
 258                 if (err < 0) {
 259                         if (err != -ENODEV)
 260                                 mod_timer(&ep->umidi->error_timer,
 261                                           jiffies + ERROR_DELAY_JIFFIES);
 262                         return;
 263                 }
 264         }
 265         snd_usbmidi_do_output(ep);
 266 }
 267
 268 /*
 269  * This is called when some data should be transferred to the device
 270  * (from one or more substreams).
 271  */
 272 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint* ep)
 273 {
 274         struct urb* urb = ep->urb;
 275         unsigned long flags;
 276
 277         spin_lock_irqsave(&ep->buffer_lock, flags);
 278         if (ep->urb_active || ep->umidi->chip->shutdown) {
 279                 spin_unlock_irqrestore(&ep->buffer_lock, flags);
 280                 return;
 281         }
 282
 283         urb->transfer_buffer_length = 0;
 284         ep->umidi->usb_protocol_ops->output(ep);
 285
 286         if (urb->transfer_buffer_length > 0) {
 287                 dump_urb("sending", urb->transfer_buffer,
 288                          urb->transfer_buffer_length);
 289                 urb->dev = ep->umidi->chip->dev;
 290                 ep->urb_active = snd_usbmidi_submit_urb(urb, GFP_ATOMIC) >= 0;
 291         }
 292         spin_unlock_irqrestore(&ep->buffer_lock, flags);
 293 }
 294
 295 static void snd_usbmidi_out_tasklet(unsigned long data)
 296 {
 297         struct snd_usb_midi_out_endpoint* ep = (struct snd_usb_midi_out_endpoint *) data;
 298
 299         snd_usbmidi_do_output(ep);
 300 }
 301
 302 /* called after transfers had been interrupted due to some USB error */
 303 static void snd_usbmidi_error_timer(unsigned long data)
 304 {
 305         struct snd_usb_midi *umidi = (struct snd_usb_midi *)data;
 306         int i;
 307
 308         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
 309                 struct snd_usb_midi_in_endpoint *in = umidi->endpoints[i].in;
 310                 if (in && in->error_resubmit) {
 311                         in->error_resubmit = 0;
 312                         in->urb->dev = umidi->chip->dev;
 313                         snd_usbmidi_submit_urb(in->urb, GFP_ATOMIC);
 314                 }
 315                 if (umidi->endpoints[i].out)
 316                         snd_usbmidi_do_output(umidi->endpoints[i].out);
 317         }
 318 }
 319
 320 /* helper function to send static data that may not DMA-able */
 321 static int send_bulk_static_data(struct snd_usb_midi_out_endpoint* ep,
 322                                  const void *data, int len)
 323 {
 324         int err;
 325         void *buf = kmalloc(len, GFP_KERNEL);
 326         if (!buf)
 327                 return -ENOMEM;
 328         memcpy(buf, data, len);
 329         dump_urb("sending", buf, len);
 330         err = usb_bulk_msg(ep->umidi->chip->dev, ep->urb->pipe, buf, len,
 331                            NULL, 250);
 332         kfree(buf);
 333         return err;
 334 }
 335
 336 /*
 337  * Standard USB MIDI protocol: see the spec.
 338  * Midiman protocol: like the standard protocol, but the control byte is the
 339  * fourth byte in each packet, and uses length instead of CIN.
 340  */
 341
 342 static void snd_usbmidi_standard_input(struct snd_usb_midi_in_endpoint* ep,
 343                                        uint8_t* buffer, int buffer_length)
 344 {
 345         int i;
 346
 347         for (i = 0; i + 3 < buffer_length; i += 4)
 348                 if (buffer[i] != 0) {
 349                         int cable = buffer[i] >> 4;
 350                         int length = snd_usbmidi_cin_length[buffer[i] & 0x0f];
 351                         snd_usbmidi_input_data(ep, cable, &buffer[i + 1], length);
 352                 }
 353 }
 354
 355 static void snd_usbmidi_midiman_input(struct snd_usb_midi_in_endpoint* ep,
 356                                       uint8_t* buffer, int buffer_length)
 357 {
 358         int i;
 359
 360         for (i = 0; i + 3 < buffer_length; i += 4)
 361                 if (buffer[i + 3] != 0) {
 362                         int port = buffer[i + 3] >> 4;
 363                         int length = buffer[i + 3] & 3;
 364                         snd_usbmidi_input_data(ep, port, &buffer[i], length);
 365                 }
 366 }
 367
 368 /*
 369  * Adds one USB MIDI packet to the output buffer.
 370  */
 371 static void snd_usbmidi_output_standard_packet(struct urb* urb, uint8_t p0,
 372                                                uint8_t p1, uint8_t p2, uint8_t p3)
 373 {
 374
 375         uint8_t* buf = (uint8_t*)urb->transfer_buffer + urb->transfer_buffer_length;
 376         buf[0] = p0;
 377         buf[1] = p1;
 378         buf[2] = p2;
 379         buf[3] = p3;
 380         urb->transfer_buffer_length += 4;
 381 }
 382
 383 /*
 384  * Adds one Midiman packet to the output buffer.
 385  */
 386 static void snd_usbmidi_output_midiman_packet(struct urb* urb, uint8_t p0,
 387                                               uint8_t p1, uint8_t p2, uint8_t p3)
 388 {
 389
 390         uint8_t* buf = (uint8_t*)urb->transfer_buffer + urb->transfer_buffer_length;
 391         buf[0] = p1;
 392         buf[1] = p2;
 393         buf[2] = p3;
 394         buf[3] = (p0 & 0xf0) | snd_usbmidi_cin_length[p0 & 0x0f];
 395         urb->transfer_buffer_length += 4;
 396 }
 397
 398 /*
 399  * Converts MIDI commands to USB MIDI packets.
 400  */
 401 static void snd_usbmidi_transmit_byte(struct usbmidi_out_port* port,
 402                                       uint8_t b, struct urb* urb)
 403 {
 404         uint8_t p0 = port->cable;
 405         void (*output_packet)(struct urb*, uint8_t, uint8_t, uint8_t, uint8_t) =
 406                 port->ep->umidi->usb_protocol_ops->output_packet;
 407
 408         if (b >= 0xf8) {
 409                 output_packet(urb, p0 | 0x0f, b, 0, 0);
 410         } else if (b >= 0xf0) {
 411                 switch (b) {
 412                 case 0xf0:
 413                         port->data[0] = b;
 414                         port->state = STATE_SYSEX_1;
 415                         break;
 416                 case 0xf1:
 417                 case 0xf3:
 418                         port->data[0] = b;
 419                         port->state = STATE_1PARAM;
 420                         break;
 421                 case 0xf2:
 422                         port->data[0] = b;
 423                         port->state = STATE_2PARAM_1;
 424                         break;
 425                 case 0xf4:
 426                 case 0xf5:
 427                         port->state = STATE_UNKNOWN;
 428                         break;
 429                 case 0xf6:
 430                         output_packet(urb, p0 | 0x05, 0xf6, 0, 0);
 431                         port->state = STATE_UNKNOWN;
 432                         break;
 433                 case 0xf7:
 434                         switch (port->state) {
 435                         case STATE_SYSEX_0:
 436                                 output_packet(urb, p0 | 0x05, 0xf7, 0, 0);
 437                                 break;
 438                         case STATE_SYSEX_1:
 439                                 output_packet(urb, p0 | 0x06, port->data[0], 0xf7, 0);
 440                                 break;
 441                         case STATE_SYSEX_2:
 442                                 output_packet(urb, p0 | 0x07, port->data[0], port->data[1], 0xf7);
 443                                 break;
 444                         }
 445                         port->state = STATE_UNKNOWN;
 446                         break;
 447                 }
 448         } else if (b >= 0x80) {
 449                 port->data[0] = b;
 450                 if (b >= 0xc0 && b <= 0xdf)
 451                         port->state = STATE_1PARAM;
 452                 else
 453                         port->state = STATE_2PARAM_1;
 454         } else { /* b < 0x80 */
 455                 switch (port->state) {
 456                 case STATE_1PARAM:
 457                         if (port->data[0] < 0xf0) {
 458                                 p0 |= port->data[0] >> 4;
 459                         } else {
 460                                 p0 |= 0x02;
 461                                 port->state = STATE_UNKNOWN;
 462                         }
 463                         output_packet(urb, p0, port->data[0], b, 0);
 464                         break;
 465                 case STATE_2PARAM_1:
 466                         port->data[1] = b;
 467                         port->state = STATE_2PARAM_2;
 468                         break;
 469                 case STATE_2PARAM_2:
 470                         if (port->data[0] < 0xf0) {
 471                                 p0 |= port->data[0] >> 4;
 472                                 port->state = STATE_2PARAM_1;
 473                         } else {
 474                                 p0 |= 0x03;
 475                                 port->state = STATE_UNKNOWN;
 476                         }
 477                         output_packet(urb, p0, port->data[0], port->data[1], b);
 478                         break;
 479                 case STATE_SYSEX_0:
 480                         port->data[0] = b;
 481                         port->state = STATE_SYSEX_1;
 482                         break;
 483                 case STATE_SYSEX_1:
 484                         port->data[1] = b;
 485                         port->state = STATE_SYSEX_2;
 486                         break;
 487                 case STATE_SYSEX_2:
 488                         output_packet(urb, p0 | 0x04, port->data[0], port->data[1], b);
 489                         port->state = STATE_SYSEX_0;
 490                         break;
 491                 }
 492         }
 493 }
 494
 495 static void snd_usbmidi_standard_output(struct snd_usb_midi_out_endpoint* ep)
 496 {
 497         struct urb* urb = ep->urb;
 498         int p;
 499
 500         /* FIXME: lower-numbered ports can starve higher-numbered ports */
 501         for (p = 0; p < 0x10; ++p) {
 502                 struct usbmidi_out_port* port = &ep->ports[p];
 503                 if (!port->active)
 504                         continue;
 505                 while (urb->transfer_buffer_length + 3 < ep->max_transfer) {
 506                         uint8_t b;
 507                         if (snd_rawmidi_transmit(port->substream, &b, 1) != 1) {
 508                                 port->active = 0;
 509                                 break;
 510                         }
 511                         snd_usbmidi_transmit_byte(port, b, urb);
 512                 }
 513         }
 514 }
 515
 516 static struct usb_protocol_ops snd_usbmidi_standard_ops = {
 517         .input = snd_usbmidi_standard_input,
 518         .output = snd_usbmidi_standard_output,
 519         .output_packet = snd_usbmidi_output_standard_packet,
 520 };
 521
 522 static struct usb_protocol_ops snd_usbmidi_midiman_ops = {
 523         .input = snd_usbmidi_midiman_input,
 524         .output = snd_usbmidi_standard_output,
 525         .output_packet = snd_usbmidi_output_midiman_packet,
 526 };
 527
 528 /*
 529  * Novation USB MIDI protocol: number of data bytes is in the first byte
 530  * (when receiving) (+1!) or in the second byte (when sending); data begins
 531  * at the third byte.
 532  */
 533
 534 static void snd_usbmidi_novation_input(struct snd_usb_midi_in_endpoint* ep,
 535                                        uint8_t* buffer, int buffer_length)
 536 {
 537         if (buffer_length < 2 || !buffer[0] || buffer_length < buffer[0] + 1)
 538                 return;
 539         snd_usbmidi_input_data(ep, 0, &buffer[2], buffer[0] - 1);
 540 }
 541
 542 static void snd_usbmidi_novation_output(struct snd_usb_midi_out_endpoint* ep)
 543 {
 544         uint8_t* transfer_buffer;
 545         int count;
 546
 547         if (!ep->ports[0].active)
 548                 return;
 549         transfer_buffer = ep->urb->transfer_buffer;
 550         count = snd_rawmidi_transmit(ep->ports[0].substream,
 551                                      &transfer_buffer[2],
 552                                      ep->max_transfer - 2);
 553         if (count < 1) {
 554                 ep->ports[0].active = 0;
 555                 return;
 556         }
 557         transfer_buffer[0] = 0;
 558         transfer_buffer[1] = count;
 559         ep->urb->transfer_buffer_length = 2 + count;
 560 }
 561
 562 static struct usb_protocol_ops snd_usbmidi_novation_ops = {
 563         .input = snd_usbmidi_novation_input,
 564         .output = snd_usbmidi_novation_output,
 565 };
 566
 567 /*
 568  * "raw" protocol: used by the MOTU FastLane.
 569  */
 570
 571 static void snd_usbmidi_raw_input(struct snd_usb_midi_in_endpoint* ep,
 572                                   uint8_t* buffer, int buffer_length)
 573 {
 574         snd_usbmidi_input_data(ep, 0, buffer, buffer_length);
 575 }
 576
 577 static void snd_usbmidi_raw_output(struct snd_usb_midi_out_endpoint* ep)
 578 {
 579         int count;
 580
 581         if (!ep->ports[0].active)
 582                 return;
 583         count = snd_rawmidi_transmit(ep->ports[0].substream,
 584                                      ep->urb->transfer_buffer,
 585                                      ep->max_transfer);
 586         if (count < 1) {
 587                 ep->ports[0].active = 0;
 588                 return;
 589         }
 590         ep->urb->transfer_buffer_length = count;
 591 }
 592
 593 static struct usb_protocol_ops snd_usbmidi_raw_ops = {
 594         .input = snd_usbmidi_raw_input,
 595         .output = snd_usbmidi_raw_output,
 596 };
 597
 598 /*
 599  * Emagic USB MIDI protocol: raw MIDI with "F5 xx" port switching.
 600  */
 601
 602 static void snd_usbmidi_emagic_init_out(struct snd_usb_midi_out_endpoint* ep)
 603 {
 604         static const u8 init_data[] = {
 605                 /* initialization magic: "get version" */
 606                 0xf0,
 607                 0x00, 0x20, 0x31,       /* Emagic */
 608                 0x64,                   /* Unitor8 */
 609                 0x0b,                   /* version number request */
 610                 0x00,                   /* command version */
 611                 0x00,                   /* EEPROM, box 0 */
 612                 0xf7
 613         };
 614         send_bulk_static_data(ep, init_data, sizeof(init_data));
 615         /* while we're at it, pour on more magic */
 616         send_bulk_static_data(ep, init_data, sizeof(init_data));
 617 }
 618
 619 static void snd_usbmidi_emagic_finish_out(struct snd_usb_midi_out_endpoint* ep)
 620 {
 621         static const u8 finish_data[] = {
 622                 /* switch to patch mode with last preset */
 623                 0xf0,
 624                 0x00, 0x20, 0x31,       /* Emagic */
 625                 0x64,                   /* Unitor8 */
 626                 0x10,                   /* patch switch command */
 627                 0x00,                   /* command version */
 628                 0x7f,                   /* to all boxes */
 629                 0x40,                   /* last preset in EEPROM */
 630                 0xf7
 631         };
 632         send_bulk_static_data(ep, finish_data, sizeof(finish_data));
 633 }
 634
 635 static void snd_usbmidi_emagic_input(struct snd_usb_midi_in_endpoint* ep,
 636                                      uint8_t* buffer, int buffer_length)
 637 {
 638         int i;
 639
 640         /* FF indicates end of valid data */
 641         for (i = 0; i < buffer_length; ++i)
 642                 if (buffer[i] == 0xff) {
 643                         buffer_length = i;
 644                         break;
 645                 }
 646
 647         /* handle F5 at end of last buffer */
 648         if (ep->seen_f5)
 649                 goto switch_port;
 650
 651         while (buffer_length > 0) {
 652                 /* determine size of data until next F5 */
 653                 for (i = 0; i < buffer_length; ++i)
 654                         if (buffer[i] == 0xf5)
 655                                 break;
 656                 snd_usbmidi_input_data(ep, ep->current_port, buffer, i);
 657                 buffer += i;
 658                 buffer_length -= i;
 659
 660                 if (buffer_length <= 0)
 661                         break;
 662                 /* assert(buffer[0] == 0xf5); */
 663                 ep->seen_f5 = 1;
 664                 ++buffer;
 665                 --buffer_length;
 666
 667         switch_port:
 668                 if (buffer_length <= 0)
 669                         break;
 670                 if (buffer[0] < 0x80) {
 671                         ep->current_port = (buffer[0] - 1) & 15;
 672                         ++buffer;
 673                         --buffer_length;
 674                 }
 675                 ep->seen_f5 = 0;
 676         }
 677 }
 678
 679 static void snd_usbmidi_emagic_output(struct snd_usb_midi_out_endpoint* ep)
 680 {
 681         int port0 = ep->current_port;
 682         uint8_t* buf = ep->urb->transfer_buffer;
 683         int buf_free = ep->max_transfer;
 684         int length, i;
 685
 686         for (i = 0; i < 0x10; ++i) {
 687                 /* round-robin, starting at the last current port */
 688                 int portnum = (port0 + i) & 15;
 689                 struct usbmidi_out_port* port = &ep->ports[portnum];
 690
 691                 if (!port->active)
 692                         continue;
 693                 if (snd_rawmidi_transmit_peek(port->substream, buf, 1) != 1) {
 694                         port->active = 0;
 695                         continue;
 696                 }
 697
 698                 if (portnum != ep->current_port) {
 699                         if (buf_free < 2)
 700                                 break;
 701                         ep->current_port = portnum;
 702                         buf[0] = 0xf5;
 703                         buf[1] = (portnum + 1) & 15;
 704                         buf += 2;
 705                         buf_free -= 2;
 706                 }
 707
 708                 if (buf_free < 1)
 709                         break;
 710                 length = snd_rawmidi_transmit(port->substream, buf, buf_free);
 711                 if (length > 0) {
 712                         buf += length;
 713                         buf_free -= length;
 714                         if (buf_free < 1)
 715                                 break;
 716                 }
 717         }
 718         if (buf_free < ep->max_transfer && buf_free > 0) {
 719                 *buf = 0xff;
 720                 --buf_free;
 721         }
 722         ep->urb->transfer_buffer_length = ep->max_transfer - buf_free;
 723 }
 724
 725 static struct usb_protocol_ops snd_usbmidi_emagic_ops = {
 726         .input = snd_usbmidi_emagic_input,
 727         .output = snd_usbmidi_emagic_output,
 728         .init_out_endpoint = snd_usbmidi_emagic_init_out,
 729         .finish_out_endpoint = snd_usbmidi_emagic_finish_out,
 730 };
 731
 732
 733 static int snd_usbmidi_output_open(struct snd_rawmidi_substream *substream)
 734 {
 735         struct snd_usb_midi* umidi = substream->rmidi->private_data;
 736         struct usbmidi_out_port* port = NULL;
 737         int i, j;
 738
 739         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
 740                 if (umidi->endpoints[i].out)
 741                         for (j = 0; j < 0x10; ++j)
 742                                 if (umidi->endpoints[i].out->ports[j].substream == substream) {
 743                                         port = &umidi->endpoints[i].out->ports[j];
 744                                         break;
 745                                 }
 746         if (!port) {
 747                 snd_BUG();
 748                 return -ENXIO;
 749         }
 750         substream->runtime->private_data = port;
 751         port->state = STATE_UNKNOWN;
 752         return 0;
 753 }
 754
 755 static int snd_usbmidi_output_close(struct snd_rawmidi_substream *substream)
 756 {
 757         return 0;
 758 }
 759
 760 static void snd_usbmidi_output_trigger(struct snd_rawmidi_substream *substream, int up)
 761 {
 762         struct usbmidi_out_port* port = (struct usbmidi_out_port*)substream->runtime->private_data;
 763
 764         port->active = up;
 765         if (up) {
 766                 if (port->ep->umidi->chip->shutdown) {
 767                         /* gobble up remaining bytes to prevent wait in
 768                          * snd_rawmidi_drain_output */
 769                         while (!snd_rawmidi_transmit_empty(substream))
 770                                 snd_rawmidi_transmit_ack(substream, 1);
 771                         return;
 772                 }
 773                 tasklet_hi_schedule(&port->ep->tasklet);
 774         }
 775 }
 776
 777 static int snd_usbmidi_input_open(struct snd_rawmidi_substream *substream)
 778 {
 779         return 0;
 780 }
 781
 782 static int snd_usbmidi_input_close(struct snd_rawmidi_substream *substream)
 783 {
 784         return 0;
 785 }
 786
 787 static void snd_usbmidi_input_trigger(struct snd_rawmidi_substream *substream, int up)
 788 {
 789         struct snd_usb_midi* umidi = substream->rmidi->private_data;
 790
 791         if (up)
 792                 set_bit(substream->number, &umidi->input_triggered);
 793         else
 794                 clear_bit(substream->number, &umidi->input_triggered);
 795 }
 796
 797 static struct snd_rawmidi_ops snd_usbmidi_output_ops = {
 798         .open = snd_usbmidi_output_open,
 799         .close = snd_usbmidi_output_close,
 800         .trigger = snd_usbmidi_output_trigger,
 801 };
 802
 803 static struct snd_rawmidi_ops snd_usbmidi_input_ops = {
 804         .open = snd_usbmidi_input_open,
 805         .close = snd_usbmidi_input_close,
 806         .trigger = snd_usbmidi_input_trigger
 807 };
 808
 809 /*
 810  * Frees an input endpoint.
 811  * May be called when ep hasn't been initialized completely.
 812  */
 813 static void snd_usbmidi_in_endpoint_delete(struct snd_usb_midi_in_endpoint* ep)
 814 {
 815         if (ep->urb) {
 816                 usb_buffer_free(ep->umidi->chip->dev,
 817                                 ep->urb->transfer_buffer_length,
 818                                 ep->urb->transfer_buffer,
 819                                 ep->urb->transfer_dma);
 820                 usb_free_urb(ep->urb);
 821         }
 822         kfree(ep);
 823 }
 824
 825 /*
 826  * Creates an input endpoint.
 827  */
 828 static int snd_usbmidi_in_endpoint_create(struct snd_usb_midi* umidi,
 829                                           struct snd_usb_midi_endpoint_info* ep_info,
 830                                           struct snd_usb_midi_endpoint* rep)
 831 {
 832         struct snd_usb_midi_in_endpoint* ep;
 833         void* buffer;
 834         unsigned int pipe;
 835         int length;
 836
 837         rep->in = NULL;
 838         ep = kzalloc(sizeof(*ep), GFP_KERNEL);
 839         if (!ep)
 840                 return -ENOMEM;
 841         ep->umidi = umidi;
 842
 843         ep->urb = usb_alloc_urb(0, GFP_KERNEL);
 844         if (!ep->urb) {
 845                 snd_usbmidi_in_endpoint_delete(ep);
 846                 return -ENOMEM;
 847         }
 848         if (ep_info->in_interval)
 849                 pipe = usb_rcvintpipe(umidi->chip->dev, ep_info->in_ep);
 850         else
 851                 pipe = usb_rcvbulkpipe(umidi->chip->dev, ep_info->in_ep);
 852         length = usb_maxpacket(umidi->chip->dev, pipe, 0);
 853         buffer = usb_buffer_alloc(umidi->chip->dev, length, GFP_KERNEL,
 854                                   &ep->urb->transfer_dma);
 855         if (!buffer) {
 856                 snd_usbmidi_in_endpoint_delete(ep);
 857                 return -ENOMEM;
 858         }
 859         if (ep_info->in_interval)
 860                 usb_fill_int_urb(ep->urb, umidi->chip->dev, pipe, buffer,
 861                                  length, snd_usbmidi_in_urb_complete, ep,
 862                                  ep_info->in_interval);
 863         else
 864                 usb_fill_bulk_urb(ep->urb, umidi->chip->dev, pipe, buffer,
 865                                   length, snd_usbmidi_in_urb_complete, ep);
 866         ep->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
 867
 868         rep->in = ep;
 869         return 0;
 870 }
 871
 872 static unsigned int snd_usbmidi_count_bits(unsigned int x)
 873 {
 874         unsigned int bits = 0;
 875
 876         for (; x; x >>= 1)
 877                 bits += x & 1;
 878         return bits;
 879 }
 880
 881 /*
 882  * Frees an output endpoint.
 883  * May be called when ep hasn't been initialized completely.
 884  */
 885 static void snd_usbmidi_out_endpoint_delete(struct snd_usb_midi_out_endpoint* ep)
 886 {
 887         if (ep->urb) {
 888                 usb_buffer_free(ep->umidi->chip->dev, ep->max_transfer,
 889                                 ep->urb->transfer_buffer,
 890                                 ep->urb->transfer_dma);
 891                 usb_free_urb(ep->urb);
 892         }
 893         kfree(ep);
 894 }
 895
 896 /*
 897  * Creates an output endpoint, and initializes output ports.
 898  */
 899 static int snd_usbmidi_out_endpoint_create(struct snd_usb_midi* umidi,
 900                                            struct snd_usb_midi_endpoint_info* ep_info,
 901                                            struct snd_usb_midi_endpoint* rep)
 902 {
 903         struct snd_usb_midi_out_endpoint* ep;
 904         int i;
 905         unsigned int pipe;
 906         void* buffer;
 907
 908         rep->out = NULL;
 909         ep = kzalloc(sizeof(*ep), GFP_KERNEL);
 910         if (!ep)
 911                 return -ENOMEM;
 912         ep->umidi = umidi;
 913
 914         ep->urb = usb_alloc_urb(0, GFP_KERNEL);
 915         if (!ep->urb) {
 916                 snd_usbmidi_out_endpoint_delete(ep);
 917                 return -ENOMEM;
 918         }
 919         /* we never use interrupt output pipes */
 920         pipe = usb_sndbulkpipe(umidi->chip->dev, ep_info->out_ep);
 921         ep->max_transfer = usb_maxpacket(umidi->chip->dev, pipe, 1);
 922         buffer = usb_buffer_alloc(umidi->chip->dev, ep->max_transfer,
 923                                   GFP_KERNEL, &ep->urb->transfer_dma);
 924         if (!buffer) {
 925                 snd_usbmidi_out_endpoint_delete(ep);
 926                 return -ENOMEM;
 927         }
 928         usb_fill_bulk_urb(ep->urb, umidi->chip->dev, pipe, buffer,
 929                           ep->max_transfer, snd_usbmidi_out_urb_complete, ep);
 930         ep->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
 931
 932         spin_lock_init(&ep->buffer_lock);
 933         tasklet_init(&ep->tasklet, snd_usbmidi_out_tasklet, (unsigned long)ep);
 934
 935         for (i = 0; i < 0x10; ++i)
 936                 if (ep_info->out_cables & (1 << i)) {
 937                         ep->ports[i].ep = ep;
 938                         ep->ports[i].cable = i << 4;
 939                 }
 940
 941         if (umidi->usb_protocol_ops->init_out_endpoint)
 942                 umidi->usb_protocol_ops->init_out_endpoint(ep);
 943
 944         rep->out = ep;
 945         return 0;
 946 }
 947
 948 /*
 949  * Frees everything.
 950  */
 951 static void snd_usbmidi_free(struct snd_usb_midi* umidi)
 952 {
 953         int i;
 954
 955         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
 956                 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
 957                 if (ep->out)
 958                         snd_usbmidi_out_endpoint_delete(ep->out);
 959                 if (ep->in)
 960                         snd_usbmidi_in_endpoint_delete(ep->in);
 961         }
 962         kfree(umidi);
 963 }
 964
 965 /*
 966  * Unlinks all URBs (must be done before the usb_device is deleted).
 967  */
 968 void snd_usbmidi_disconnect(struct list_head* p)
 969 {
 970         struct snd_usb_midi* umidi;
 971         int i;
 972
 973         umidi = list_entry(p, struct snd_usb_midi, list);
 974         del_timer_sync(&umidi->error_timer);
 975         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
 976                 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
 977                 if (ep->out)
 978                         tasklet_kill(&ep->out->tasklet);
 979                 if (ep->out && ep->out->urb) {
 980                         usb_kill_urb(ep->out->urb);
 981                         if (umidi->usb_protocol_ops->finish_out_endpoint)
 982                                 umidi->usb_protocol_ops->finish_out_endpoint(ep->out);
 983                 }
 984                 if (ep->in && ep->in->urb)
 985                         usb_kill_urb(ep->in->urb);
 986         }
 987 }
 988
 989 static void snd_usbmidi_rawmidi_free(struct snd_rawmidi *rmidi)
 990 {
 991         struct snd_usb_midi* umidi = rmidi->private_data;
 992         snd_usbmidi_free(umidi);
 993 }
 994
 995 static struct snd_rawmidi_substream *snd_usbmidi_find_substream(struct snd_usb_midi* umidi,
 996                                                            int stream, int number)
 997 {
 998         struct list_head* list;
 999
1000         list_for_each(list, &umidi->rmidi->streams[stream].substreams) {
1001                 struct snd_rawmidi_substream *substream = list_entry(list, struct snd_rawmidi_substream, list);
1002                 if (substream->number == number)
1003                         return substream;
1004         }
1005         return NULL;
1006 }
1007
1008 /*
1009  * This list specifies names for ports that do not fit into the standard
1010  * "(product) MIDI (n)" schema because they aren't external MIDI ports,
1011  * such as internal control or synthesizer ports.
1012  */
1013 static struct {
1014         u32 id;
1015         int port;
1016         const char *name_format;
1017 } snd_usbmidi_port_names[] = {
1018         /* Roland UA-100 */
1019         { USB_ID(0x0582, 0x0000), 2, "%s Control" },
1020         /* Roland SC-8850 */
1021         { USB_ID(0x0582, 0x0003), 0, "%s Part A" },
1022         { USB_ID(0x0582, 0x0003), 1, "%s Part B" },
1023         { USB_ID(0x0582, 0x0003), 2, "%s Part C" },
1024         { USB_ID(0x0582, 0x0003), 3, "%s Part D" },
1025         { USB_ID(0x0582, 0x0003), 4, "%s MIDI 1" },
1026         { USB_ID(0x0582, 0x0003), 5, "%s MIDI 2" },
1027         /* Roland U-8 */
1028         { USB_ID(0x0582, 0x0004), 0, "%s MIDI" },
1029         { USB_ID(0x0582, 0x0004), 1, "%s Control" },
1030         /* Roland SC-8820 */
1031         { USB_ID(0x0582, 0x0007), 0, "%s Part A" },
1032         { USB_ID(0x0582, 0x0007), 1, "%s Part B" },
1033         { USB_ID(0x0582, 0x0007), 2, "%s MIDI" },
1034         /* Roland SK-500 */
1035         { USB_ID(0x0582, 0x000b), 0, "%s Part A" },
1036         { USB_ID(0x0582, 0x000b), 1, "%s Part B" },
1037         { USB_ID(0x0582, 0x000b), 2, "%s MIDI" },
1038         /* Roland SC-D70 */
1039         { USB_ID(0x0582, 0x000c), 0, "%s Part A" },
1040         { USB_ID(0x0582, 0x000c), 1, "%s Part B" },
1041         { USB_ID(0x0582, 0x000c), 2, "%s MIDI" },
1042         /* Edirol UM-880 */
1043         { USB_ID(0x0582, 0x0014), 8, "%s Control" },
1044         /* Edirol SD-90 */
1045         { USB_ID(0x0582, 0x0016), 0, "%s Part A" },
1046         { USB_ID(0x0582, 0x0016), 1, "%s Part B" },
1047         { USB_ID(0x0582, 0x0016), 2, "%s MIDI 1" },
1048         { USB_ID(0x0582, 0x0016), 3, "%s MIDI 2" },
1049         /* Edirol UM-550 */
1050         { USB_ID(0x0582, 0x0023), 5, "%s Control" },
1051         /* Edirol SD-20 */
1052         { USB_ID(0x0582, 0x0027), 0, "%s Part A" },
1053         { USB_ID(0x0582, 0x0027), 1, "%s Part B" },
1054         { USB_ID(0x0582, 0x0027), 2, "%s MIDI" },
1055         /* Edirol SD-80 */
1056         { USB_ID(0x0582, 0x0029), 0, "%s Part A" },
1057         { USB_ID(0x0582, 0x0029), 1, "%s Part B" },
1058         { USB_ID(0x0582, 0x0029), 2, "%s MIDI 1" },
1059         { USB_ID(0x0582, 0x0029), 3, "%s MIDI 2" },
1060         /* Edirol UA-700 */
1061         { USB_ID(0x0582, 0x002b), 0, "%s MIDI" },
1062         { USB_ID(0x0582, 0x002b), 1, "%s Control" },
1063         /* Roland VariOS */
1064         { USB_ID(0x0582, 0x002f), 0, "%s MIDI" },
1065         { USB_ID(0x0582, 0x002f), 1, "%s External MIDI" },
1066         { USB_ID(0x0582, 0x002f), 2, "%s Sync" },
1067         /* Edirol PCR */
1068         { USB_ID(0x0582, 0x0033), 0, "%s MIDI" },
1069         { USB_ID(0x0582, 0x0033), 1, "%s 1" },
1070         { USB_ID(0x0582, 0x0033), 2, "%s 2" },
1071         /* BOSS GS-10 */
1072         { USB_ID(0x0582, 0x003b), 0, "%s MIDI" },
1073         { USB_ID(0x0582, 0x003b), 1, "%s Control" },
1074         /* Edirol UA-1000 */
1075         { USB_ID(0x0582, 0x0044), 0, "%s MIDI" },
1076         { USB_ID(0x0582, 0x0044), 1, "%s Control" },
1077         /* Edirol UR-80 */
1078         { USB_ID(0x0582, 0x0048), 0, "%s MIDI" },
1079         { USB_ID(0x0582, 0x0048), 1, "%s 1" },
1080         { USB_ID(0x0582, 0x0048), 2, "%s 2" },
1081         /* Edirol PCR-A */
1082         { USB_ID(0x0582, 0x004d), 0, "%s MIDI" },
1083         { USB_ID(0x0582, 0x004d), 1, "%s 1" },
1084         { USB_ID(0x0582, 0x004d), 2, "%s 2" },
1085         /* M-Audio MidiSport 8x8 */
1086         { USB_ID(0x0763, 0x1031), 8, "%s Control" },
1087         { USB_ID(0x0763, 0x1033), 8, "%s Control" },
1088         /* MOTU Fastlane */
1089         { USB_ID(0x07fd, 0x0001), 0, "%s MIDI A" },
1090         { USB_ID(0x07fd, 0x0001), 1, "%s MIDI B" },
1091         /* Emagic Unitor8/AMT8/MT4 */
1092         { USB_ID(0x086a, 0x0001), 8, "%s Broadcast" },
1093         { USB_ID(0x086a, 0x0002), 8, "%s Broadcast" },
1094         { USB_ID(0x086a, 0x0003), 4, "%s Broadcast" },
1095 };
1096
1097 static void snd_usbmidi_init_substream(struct snd_usb_midi* umidi,
1098                                        int stream, int number,
1099                                        struct snd_rawmidi_substream ** rsubstream)
1100 {
1101         int i;
1102         const char *name_format;
1103
1104         struct snd_rawmidi_substream *substream = snd_usbmidi_find_substream(umidi, stream, number);
1105         if (!substream) {
1106                 snd_printd(KERN_ERR "substream %d:%d not found\n", stream, number);
1107                 return;
1108         }
1109
1110         /* TODO: read port name from jack descriptor */
1111         name_format = "%s MIDI %d";
1112         for (i = 0; i < ARRAY_SIZE(snd_usbmidi_port_names); ++i) {
1113                 if (snd_usbmidi_port_names[i].id == umidi->chip->usb_id &&
1114                     snd_usbmidi_port_names[i].port == number) {
1115                         name_format = snd_usbmidi_port_names[i].name_format;
1116                         break;
1117                 }
1118         }
1119         snprintf(substream->name, sizeof(substream->name),
1120                  name_format, umidi->chip->card->shortname, number + 1);
1121
1122         *rsubstream = substream;
1123 }
1124
1125 /*
1126  * Creates the endpoints and their ports.
1127  */
1128 static int snd_usbmidi_create_endpoints(struct snd_usb_midi* umidi,
1129                                         struct snd_usb_midi_endpoint_info* endpoints)
1130 {
1131         int i, j, err;
1132         int out_ports = 0, in_ports = 0;
1133
1134         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1135                 if (endpoints[i].out_cables) {
1136                         err = snd_usbmidi_out_endpoint_create(umidi, &endpoints[i],
1137                                                               &umidi->endpoints[i]);
1138                         if (err < 0)
1139                                 return err;
1140                 }
1141                 if (endpoints[i].in_cables) {
1142                         err = snd_usbmidi_in_endpoint_create(umidi, &endpoints[i],
1143                                                              &umidi->endpoints[i]);
1144                         if (err < 0)
1145                                 return err;
1146                 }
1147
1148                 for (j = 0; j < 0x10; ++j) {
1149                         if (endpoints[i].out_cables & (1 << j)) {
1150                                 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_OUTPUT, out_ports,
1151                                                            &umidi->endpoints[i].out->ports[j].substream);
1152                                 ++out_ports;
1153                         }
1154                         if (endpoints[i].in_cables & (1 << j)) {
1155                                 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_INPUT, in_ports,
1156                                                            &umidi->endpoints[i].in->ports[j].substream);
1157                                 ++in_ports;
1158                         }
1159                 }
1160         }
1161         snd_printdd(KERN_INFO "created %d output and %d input ports\n",
1162                     out_ports, in_ports);
1163         return 0;
1164 }
1165
1166 /*
1167  * Returns MIDIStreaming device capabilities.
1168  */
1169 static int snd_usbmidi_get_ms_info(struct snd_usb_midi* umidi,
1170                                    struct snd_usb_midi_endpoint_info* endpoints)
1171 {
1172         struct usb_interface* intf;
1173         struct usb_host_interface *hostif;
1174         struct usb_interface_descriptor* intfd;
1175         struct usb_ms_header_descriptor* ms_header;
1176         struct usb_host_endpoint *hostep;
1177         struct usb_endpoint_descriptor* ep;
1178         struct usb_ms_endpoint_descriptor* ms_ep;
1179         int i, epidx;
1180
1181         intf = umidi->iface;
1182         if (!intf)
1183                 return -ENXIO;
1184         hostif = &intf->altsetting[0];
1185         intfd = get_iface_desc(hostif);
1186         ms_header = (struct usb_ms_header_descriptor*)hostif->extra;
1187         if (hostif->extralen >= 7 &&
1188             ms_header->bLength >= 7 &&
1189             ms_header->bDescriptorType == USB_DT_CS_INTERFACE &&
1190             ms_header->bDescriptorSubtype == HEADER)
1191                 snd_printdd(KERN_INFO "MIDIStreaming version %02x.%02x\n",
1192                             ms_header->bcdMSC[1], ms_header->bcdMSC[0]);
1193         else
1194                 snd_printk(KERN_WARNING "MIDIStreaming interface descriptor not found\n");
1195
1196         epidx = 0;
1197         for (i = 0; i < intfd->bNumEndpoints; ++i) {
1198                 hostep = &hostif->endpoint[i];
1199                 ep = get_ep_desc(hostep);
1200                 if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK &&
1201                     (ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
1202                         continue;
1203                 ms_ep = (struct usb_ms_endpoint_descriptor*)hostep->extra;
1204                 if (hostep->extralen < 4 ||
1205                     ms_ep->bLength < 4 ||
1206                     ms_ep->bDescriptorType != USB_DT_CS_ENDPOINT ||
1207                     ms_ep->bDescriptorSubtype != MS_GENERAL)
1208                         continue;
1209                 if ((ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) {
1210                         if (endpoints[epidx].out_ep) {
1211                                 if (++epidx >= MIDI_MAX_ENDPOINTS) {
1212                                         snd_printk(KERN_WARNING "too many endpoints\n");
1213                                         break;
1214                                 }
1215                         }
1216                         endpoints[epidx].out_ep = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1217                         if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)
1218                                 endpoints[epidx].out_interval = ep->bInterval;
1219                         endpoints[epidx].out_cables = (1 << ms_ep->bNumEmbMIDIJack) - 1;
1220                         snd_printdd(KERN_INFO "EP %02X: %d jack(s)\n",
1221                                     ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1222                 } else {
1223                         if (endpoints[epidx].in_ep) {
1224                                 if (++epidx >= MIDI_MAX_ENDPOINTS) {
1225                                         snd_printk(KERN_WARNING "too many endpoints\n");
1226                                         break;
1227                                 }
1228                         }
1229                         endpoints[epidx].in_ep = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1230                         if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)
1231                                 endpoints[epidx].in_interval = ep->bInterval;
1232                         endpoints[epidx].in_cables = (1 << ms_ep->bNumEmbMIDIJack) - 1;
1233                         snd_printdd(KERN_INFO "EP %02X: %d jack(s)\n",
1234                                     ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1235                 }
1236         }
1237         return 0;
1238 }
1239
1240 /*
1241  * On Roland devices, use the second alternate setting to be able to use
1242  * the interrupt input endpoint.
1243  */
1244 static void snd_usbmidi_switch_roland_altsetting(struct snd_usb_midi* umidi)
1245 {
1246         struct usb_interface* intf;
1247         struct usb_host_interface *hostif;
1248         struct usb_interface_descriptor* intfd;
1249
1250         intf = umidi->iface;
1251         if (!intf || intf->num_altsetting != 2)
1252                 return;
1253
1254         hostif = &intf->altsetting[1];
1255         intfd = get_iface_desc(hostif);
1256         if (intfd->bNumEndpoints != 2 ||
1257             (get_endpoint(hostif, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK ||
1258             (get_endpoint(hostif, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
1259                 return;
1260
1261         snd_printdd(KERN_INFO "switching to altsetting %d with int ep\n",
1262                     intfd->bAlternateSetting);
1263         usb_set_interface(umidi->chip->dev, intfd->bInterfaceNumber,
1264                           intfd->bAlternateSetting);
1265 }
1266
1267 /*
1268  * Try to find any usable endpoints in the interface.
1269  */
1270 static int snd_usbmidi_detect_endpoints(struct snd_usb_midi* umidi,
1271                                         struct snd_usb_midi_endpoint_info* endpoint,
1272                                         int max_endpoints)
1273 {
1274         struct usb_interface* intf;
1275         struct usb_host_interface *hostif;
1276         struct usb_interface_descriptor* intfd;
1277         struct usb_endpoint_descriptor* epd;
1278         int i, out_eps = 0, in_eps = 0;
1279
1280         if (USB_ID_VENDOR(umidi->chip->usb_id) == 0x0582)
1281                 snd_usbmidi_switch_roland_altsetting(umidi);
1282
1283         if (endpoint[0].out_ep || endpoint[0].in_ep)
1284                 return 0;
1285
1286         intf = umidi->iface;
1287         if (!intf || intf->num_altsetting < 1)
1288                 return -ENOENT;
1289         hostif = intf->cur_altsetting;
1290         intfd = get_iface_desc(hostif);
1291
1292         for (i = 0; i < intfd->bNumEndpoints; ++i) {
1293                 epd = get_endpoint(hostif, i);
1294                 if ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK &&
1295                     (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
1296                         continue;
1297                 if (out_eps < max_endpoints &&
1298                     (epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) {
1299                         endpoint[out_eps].out_ep = epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1300                         if ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)
1301                                 endpoint[out_eps].out_interval = epd->bInterval;
1302                         ++out_eps;
1303                 }
1304                 if (in_eps < max_endpoints &&
1305                     (epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN) {
1306                         endpoint[in_eps].in_ep = epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1307                         if ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)
1308                                 endpoint[in_eps].in_interval = epd->bInterval;
1309                         ++in_eps;
1310                 }
1311         }
1312         return (out_eps || in_eps) ? 0 : -ENOENT;
1313 }
1314
1315 /*
1316  * Detects the endpoints for one-port-per-endpoint protocols.
1317  */
1318 static int snd_usbmidi_detect_per_port_endpoints(struct snd_usb_midi* umidi,
1319                                                  struct snd_usb_midi_endpoint_info* endpoints)
1320 {
1321         int err, i;
1322
1323         err = snd_usbmidi_detect_endpoints(umidi, endpoints, MIDI_MAX_ENDPOINTS);
1324         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1325                 if (endpoints[i].out_ep)
1326                         endpoints[i].out_cables = 0x0001;
1327                 if (endpoints[i].in_ep)
1328                         endpoints[i].in_cables = 0x0001;
1329         }
1330         return err;
1331 }
1332
1333 /*
1334  * Detects the endpoints and ports of Yamaha devices.
1335  */
1336 static int snd_usbmidi_detect_yamaha(struct snd_usb_midi* umidi,
1337                                      struct snd_usb_midi_endpoint_info* endpoint)
1338 {
1339         struct usb_interface* intf;
1340         struct usb_host_interface *hostif;
1341         struct usb_interface_descriptor* intfd;
1342         uint8_t* cs_desc;
1343
1344         intf = umidi->iface;
1345         if (!intf)
1346                 return -ENOENT;
1347         hostif = intf->altsetting;
1348         intfd = get_iface_desc(hostif);
1349         if (intfd->bNumEndpoints < 1)
1350                 return -ENOENT;
1351
1352         /*
1353          * For each port there is one MIDI_IN/OUT_JACK descriptor, not
1354          * necessarily with any useful contents.  So simply count 'em.
1355          */
1356         for (cs_desc = hostif->extra;
1357              cs_desc < hostif->extra + hostif->extralen && cs_desc[0] >= 2;
1358              cs_desc += cs_desc[0]) {
1359                 if (cs_desc[1] == CS_AUDIO_INTERFACE) {
1360                         if (cs_desc[2] == MIDI_IN_JACK)
1361                                 endpoint->in_cables = (endpoint->in_cables << 1) | 1;
1362                         else if (cs_desc[2] == MIDI_OUT_JACK)
1363                                 endpoint->out_cables = (endpoint->out_cables << 1) | 1;
1364                 }
1365         }
1366         if (!endpoint->in_cables && !endpoint->out_cables)
1367                 return -ENOENT;
1368
1369         return snd_usbmidi_detect_endpoints(umidi, endpoint, 1);
1370 }
1371
1372 /*
1373  * Creates the endpoints and their ports for Midiman devices.
1374  */
1375 static int snd_usbmidi_create_endpoints_midiman(struct snd_usb_midi* umidi,
1376                                                 struct snd_usb_midi_endpoint_info* endpoint)
1377 {
1378         struct snd_usb_midi_endpoint_info ep_info;
1379         struct usb_interface* intf;
1380         struct usb_host_interface *hostif;
1381         struct usb_interface_descriptor* intfd;
1382         struct usb_endpoint_descriptor* epd;
1383         int cable, err;
1384
1385         intf = umidi->iface;
1386         if (!intf)
1387                 return -ENOENT;
1388         hostif = intf->altsetting;
1389         intfd = get_iface_desc(hostif);
1390         /*
1391          * The various MidiSport devices have more or less random endpoint
1392          * numbers, so we have to identify the endpoints by their index in
1393          * the descriptor array, like the driver for that other OS does.
1394          *
1395          * There is one interrupt input endpoint for all input ports, one
1396          * bulk output endpoint for even-numbered ports, and one for odd-
1397          * numbered ports.  Both bulk output endpoints have corresponding
1398          * input bulk endpoints (at indices 1 and 3) which aren't used.
1399          */
1400         if (intfd->bNumEndpoints < (endpoint->out_cables > 0x0001 ? 5 : 3)) {
1401                 snd_printdd(KERN_ERR "not enough endpoints\n");
1402                 return -ENOENT;
1403         }
1404
1405         epd = get_endpoint(hostif, 0);
1406         if ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) != USB_DIR_IN ||
1407             (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT) {
1408                 snd_printdd(KERN_ERR "endpoint[0] isn't interrupt\n");
1409                 return -ENXIO;
1410         }
1411         epd = get_endpoint(hostif, 2);
1412         if ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) != USB_DIR_OUT ||
1413             (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) {
1414                 snd_printdd(KERN_ERR "endpoint[2] isn't bulk output\n");
1415                 return -ENXIO;
1416         }
1417         if (endpoint->out_cables > 0x0001) {
1418                 epd = get_endpoint(hostif, 4);
1419                 if ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) != USB_DIR_OUT ||
1420                     (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) {
1421                         snd_printdd(KERN_ERR "endpoint[4] isn't bulk output\n");
1422                         return -ENXIO;
1423                 }
1424         }
1425
1426         ep_info.out_ep = get_endpoint(hostif, 2)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1427         ep_info.out_cables = endpoint->out_cables & 0x5555;
1428         err = snd_usbmidi_out_endpoint_create(umidi, &ep_info, &umidi->endpoints[0]);
1429         if (err < 0)
1430                 return err;
1431
1432         ep_info.in_ep = get_endpoint(hostif, 0)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1433         ep_info.in_interval = get_endpoint(hostif, 0)->bInterval;
1434         ep_info.in_cables = endpoint->in_cables;
1435         err = snd_usbmidi_in_endpoint_create(umidi, &ep_info, &umidi->endpoints[0]);
1436         if (err < 0)
1437                 return err;
1438
1439         if (endpoint->out_cables > 0x0001) {
1440                 ep_info.out_ep = get_endpoint(hostif, 4)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1441                 ep_info.out_cables = endpoint->out_cables & 0xaaaa;
1442                 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info, &umidi->endpoints[1]);
1443                 if (err < 0)
1444                         return err;
1445         }
1446
1447         for (cable = 0; cable < 0x10; ++cable) {
1448                 if (endpoint->out_cables & (1 << cable))
1449                         snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_OUTPUT, cable,
1450                                                    &umidi->endpoints[cable & 1].out->ports[cable].substream);
1451                 if (endpoint->in_cables & (1 << cable))
1452                         snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_INPUT, cable,
1453                                                    &umidi->endpoints[0].in->ports[cable].substream);
1454         }
1455         return 0;
1456 }
1457
1458 static int snd_usbmidi_create_rawmidi(struct snd_usb_midi* umidi,
1459                                       int out_ports, int in_ports)
1460 {
1461         struct snd_rawmidi *rmidi;
1462         int err;
1463
1464         err = snd_rawmidi_new(umidi->chip->card, "USB MIDI",
1465                               umidi->chip->next_midi_device++,
1466                               out_ports, in_ports, &rmidi);
1467         if (err < 0)
1468                 return err;
1469         strcpy(rmidi->name, umidi->chip->card->shortname);
1470         rmidi->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT |
1471                             SNDRV_RAWMIDI_INFO_INPUT |
1472                             SNDRV_RAWMIDI_INFO_DUPLEX;
1473         rmidi->private_data = umidi;
1474         rmidi->private_free = snd_usbmidi_rawmidi_free;
1475         snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_usbmidi_output_ops);
1476         snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_usbmidi_input_ops);
1477
1478         umidi->rmidi = rmidi;
1479         return 0;
1480 }
1481
1482 /*
1483  * Temporarily stop input.
1484  */
1485 void snd_usbmidi_input_stop(struct list_head* p)
1486 {
1487         struct snd_usb_midi* umidi;
1488         int i;
1489
1490         umidi = list_entry(p, struct snd_usb_midi, list);
1491         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1492                 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
1493                 if (ep->in)
1494                         usb_kill_urb(ep->in->urb);
1495         }
1496 }
1497
1498 static void snd_usbmidi_input_start_ep(struct snd_usb_midi_in_endpoint* ep)
1499 {
1500         if (ep) {
1501                 struct urb* urb = ep->urb;
1502                 urb->dev = ep->umidi->chip->dev;
1503                 snd_usbmidi_submit_urb(urb, GFP_KERNEL);
1504         }
1505 }
1506
1507 /*
1508  * Resume input after a call to snd_usbmidi_input_stop().
1509  */
1510 void snd_usbmidi_input_start(struct list_head* p)
1511 {
1512         struct snd_usb_midi* umidi;
1513         int i;
1514
1515         umidi = list_entry(p, struct snd_usb_midi, list);
1516         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
1517                 snd_usbmidi_input_start_ep(umidi->endpoints[i].in);
1518 }
1519
1520 /*
1521  * Creates and registers everything needed for a MIDI streaming interface.
1522  */
1523 int snd_usb_create_midi_interface(struct snd_usb_audio* chip,
1524                                   struct usb_interface* iface,
1525                                   const struct snd_usb_audio_quirk* quirk)
1526 {
1527         struct snd_usb_midi* umidi;
1528         struct snd_usb_midi_endpoint_info endpoints[MIDI_MAX_ENDPOINTS];
1529         int out_ports, in_ports;
1530         int i, err;
1531
1532         umidi = kzalloc(sizeof(*umidi), GFP_KERNEL);
1533         if (!umidi)
1534                 return -ENOMEM;
1535         umidi->chip = chip;
1536         umidi->iface = iface;
1537         umidi->quirk = quirk;
1538         umidi->usb_protocol_ops = &snd_usbmidi_standard_ops;
1539         init_timer(&umidi->error_timer);
1540         umidi->error_timer.function = snd_usbmidi_error_timer;
1541         umidi->error_timer.data = (unsigned long)umidi;
1542
1543         /* detect the endpoint(s) to use */
1544         memset(endpoints, 0, sizeof(endpoints));
1545         switch (quirk ? quirk->type : QUIRK_MIDI_STANDARD_INTERFACE) {
1546         case QUIRK_MIDI_STANDARD_INTERFACE:
1547                 err = snd_usbmidi_get_ms_info(umidi, endpoints);
1548                 break;
1549         case QUIRK_MIDI_FIXED_ENDPOINT:
1550                 memcpy(&endpoints[0], quirk->data,
1551                        sizeof(struct snd_usb_midi_endpoint_info));
1552                 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
1553                 break;
1554         case QUIRK_MIDI_YAMAHA:
1555                 err = snd_usbmidi_detect_yamaha(umidi, &endpoints[0]);
1556                 break;
1557         case QUIRK_MIDI_MIDIMAN:
1558                 umidi->usb_protocol_ops = &snd_usbmidi_midiman_ops;
1559                 memcpy(&endpoints[0], quirk->data,
1560                        sizeof(struct snd_usb_midi_endpoint_info));
1561                 err = 0;
1562                 break;
1563         case QUIRK_MIDI_NOVATION:
1564                 umidi->usb_protocol_ops = &snd_usbmidi_novation_ops;
1565                 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
1566                 break;
1567         case QUIRK_MIDI_RAW:
1568                 umidi->usb_protocol_ops = &snd_usbmidi_raw_ops;
1569                 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
1570                 break;
1571         case QUIRK_MIDI_EMAGIC:
1572                 umidi->usb_protocol_ops = &snd_usbmidi_emagic_ops;
1573                 memcpy(&endpoints[0], quirk->data,
1574                        sizeof(struct snd_usb_midi_endpoint_info));
1575                 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
1576                 break;
1577         case QUIRK_MIDI_MIDITECH:
1578                 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
1579                 break;
1580         default:
1581                 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
1582                 err = -ENXIO;
1583                 break;
1584         }
1585         if (err < 0) {
1586                 kfree(umidi);
1587                 return err;
1588         }
1589
1590         /* create rawmidi device */
1591         out_ports = 0;
1592         in_ports = 0;
1593         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1594                 out_ports += snd_usbmidi_count_bits(endpoints[i].out_cables);
1595                 in_ports += snd_usbmidi_count_bits(endpoints[i].in_cables);
1596         }
1597         err = snd_usbmidi_create_rawmidi(umidi, out_ports, in_ports);
1598         if (err < 0) {
1599                 kfree(umidi);
1600                 return err;
1601         }
1602
1603         /* create endpoint/port structures */
1604         if (quirk && quirk->type == QUIRK_MIDI_MIDIMAN)
1605                 err = snd_usbmidi_create_endpoints_midiman(umidi, &endpoints[0]);
1606         else
1607                 err = snd_usbmidi_create_endpoints(umidi, endpoints);
1608         if (err < 0) {
1609                 snd_usbmidi_free(umidi);
1610                 return err;
1611         }
1612
1613         list_add(&umidi->list, &umidi->chip->midi_list);
1614
1615         for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
1616                 snd_usbmidi_input_start_ep(umidi->endpoints[i].in);
1617         return 0;
1618 }
1619
1620 EXPORT_SYMBOL(snd_usb_create_midi_interface);
1621 EXPORT_SYMBOL(snd_usbmidi_input_stop);
1622 EXPORT_SYMBOL(snd_usbmidi_input_start);
1623 EXPORT_SYMBOL(snd_usbmidi_disconnect);