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