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