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