2 * usbmidi.c - ALSA USB MIDI driver
4 * Copyright (c) 2002-2009 Clemens Ladisch
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
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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
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
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>
52 #include <sound/core.h>
53 #include <sound/control.h>
54 #include <sound/rawmidi.h>
55 #include <sound/asequencer.h>
62 * define this to log all USB packets
64 /* #define DUMP_PACKETS */
67 * how long to wait after some USB errors, so that khubd can disconnect() us
68 * without too many spurious errors
70 #define ERROR_DELAY_JIFFIES (HZ / 10)
76 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
77 MODULE_DESCRIPTION("USB Audio/MIDI helper module");
78 MODULE_LICENSE("Dual BSD/GPL");
81 struct usb_ms_header_descriptor {
84 __u8 bDescriptorSubtype;
87 } __attribute__ ((packed));
89 struct usb_ms_endpoint_descriptor {
92 __u8 bDescriptorSubtype;
94 __u8 baAssocJackID[0];
95 } __attribute__ ((packed));
97 struct snd_usb_midi_in_endpoint;
98 struct snd_usb_midi_out_endpoint;
99 struct snd_usb_midi_endpoint;
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*);
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;
122 int next_midi_device;
124 struct snd_usb_midi_endpoint {
125 struct snd_usb_midi_out_endpoint *out;
126 struct snd_usb_midi_in_endpoint *in;
127 } endpoints[MIDI_MAX_ENDPOINTS];
128 unsigned long input_triggered;
129 unsigned int opened[2];
130 unsigned char disconnected;
131 unsigned char input_running;
133 struct snd_kcontrol *roland_load_ctl;
136 struct snd_usb_midi_out_endpoint {
137 struct snd_usb_midi* umidi;
138 struct out_urb_context {
140 struct snd_usb_midi_out_endpoint *ep;
142 unsigned int active_urbs;
143 unsigned int drain_urbs;
144 int max_transfer; /* size of urb buffer */
145 struct tasklet_struct tasklet;
146 unsigned int next_urb;
147 spinlock_t buffer_lock;
149 struct usbmidi_out_port {
150 struct snd_usb_midi_out_endpoint* ep;
151 struct snd_rawmidi_substream *substream;
153 uint8_t cable; /* cable number << 4 */
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
166 wait_queue_head_t drain_wait;
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;
181 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint* ep);
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
188 * Submits the URB, with error handling.
190 static int snd_usbmidi_submit_urb(struct urb* urb, gfp_t flags)
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);
199 * Error handling for URB completion functions.
201 static int snd_usbmidi_urb_error(int status)
204 /* manually unlinked, or device gone */
210 /* errors that might occur during unplugging */
216 snd_printk(KERN_ERR "urb status %d\n", status);
217 return 0; /* continue */
222 * Receives a chunk of MIDI data.
224 static void snd_usbmidi_input_data(struct snd_usb_midi_in_endpoint* ep, int portidx,
225 uint8_t* data, int length)
227 struct usbmidi_in_port* port = &ep->ports[portidx];
229 if (!port->substream) {
230 snd_printd("unexpected port %d!\n", portidx);
233 if (!test_bit(port->substream->number, &ep->umidi->input_triggered))
235 snd_rawmidi_receive(port->substream, data, length);
239 static void dump_urb(const char *type, const u8 *data, int length)
241 snd_printk(KERN_DEBUG "%s packet: [", type);
242 for (; length > 0; ++data, --length)
243 printk(" %02x", *data);
247 #define dump_urb(type, data, length) /* nothing */
251 * Processes the data read from the device.
253 static void snd_usbmidi_in_urb_complete(struct urb* urb)
255 struct snd_usb_midi_in_endpoint* ep = urb->context;
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,
262 int err = snd_usbmidi_urb_error(urb->status);
264 if (err != -ENODEV) {
265 ep->error_resubmit = 1;
266 mod_timer(&ep->umidi->error_timer,
267 jiffies + ERROR_DELAY_JIFFIES);
273 urb->dev = ep->umidi->dev;
274 snd_usbmidi_submit_urb(urb, GFP_ATOMIC);
277 static void snd_usbmidi_out_urb_complete(struct urb* urb)
279 struct out_urb_context *context = urb->context;
280 struct snd_usb_midi_out_endpoint* ep = context->ep;
281 unsigned int urb_index;
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);
290 spin_unlock(&ep->buffer_lock);
291 if (urb->status < 0) {
292 int err = snd_usbmidi_urb_error(urb->status);
295 mod_timer(&ep->umidi->error_timer,
296 jiffies + ERROR_DELAY_JIFFIES);
300 snd_usbmidi_do_output(ep);
304 * This is called when some data should be transferred to the device
305 * (from one or more substreams).
307 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint* ep)
309 unsigned int urb_index;
313 spin_lock_irqsave(&ep->buffer_lock, flags);
314 if (ep->umidi->disconnected) {
315 spin_unlock_irqrestore(&ep->buffer_lock, flags);
319 urb_index = ep->next_urb;
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)
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)
333 ep->active_urbs |= 1 << urb_index;
335 if (++urb_index >= OUTPUT_URBS)
337 if (urb_index == ep->next_urb)
340 ep->next_urb = urb_index;
341 spin_unlock_irqrestore(&ep->buffer_lock, flags);
344 static void snd_usbmidi_out_tasklet(unsigned long data)
346 struct snd_usb_midi_out_endpoint* ep = (struct snd_usb_midi_out_endpoint *) data;
348 snd_usbmidi_do_output(ep);
351 /* called after transfers had been interrupted due to some USB error */
352 static void snd_usbmidi_error_timer(unsigned long data)
354 struct snd_usb_midi *umidi = (struct snd_usb_midi *)data;
357 spin_lock(&umidi->disc_lock);
358 if (umidi->disconnected) {
359 spin_unlock(&umidi->disc_lock);
362 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
363 struct snd_usb_midi_in_endpoint *in = umidi->endpoints[i].in;
364 if (in && in->error_resubmit) {
365 in->error_resubmit = 0;
366 for (j = 0; j < INPUT_URBS; ++j) {
367 if (atomic_read(&in->urbs[j]->use_count))
369 in->urbs[j]->dev = umidi->dev;
370 snd_usbmidi_submit_urb(in->urbs[j], GFP_ATOMIC);
373 if (umidi->endpoints[i].out)
374 snd_usbmidi_do_output(umidi->endpoints[i].out);
376 spin_unlock(&umidi->disc_lock);
379 /* helper function to send static data that may not DMA-able */
380 static int send_bulk_static_data(struct snd_usb_midi_out_endpoint* ep,
381 const void *data, int len)
384 void *buf = kmemdup(data, len, GFP_KERNEL);
387 dump_urb("sending", buf, len);
389 err = usb_bulk_msg(ep->umidi->dev, ep->urbs[0].urb->pipe,
390 buf, len, NULL, 250);
396 * Standard USB MIDI protocol: see the spec.
397 * Midiman protocol: like the standard protocol, but the control byte is the
398 * fourth byte in each packet, and uses length instead of CIN.
401 static void snd_usbmidi_standard_input(struct snd_usb_midi_in_endpoint* ep,
402 uint8_t* buffer, int buffer_length)
406 for (i = 0; i + 3 < buffer_length; i += 4)
407 if (buffer[i] != 0) {
408 int cable = buffer[i] >> 4;
409 int length = snd_usbmidi_cin_length[buffer[i] & 0x0f];
410 snd_usbmidi_input_data(ep, cable, &buffer[i + 1], length);
414 static void snd_usbmidi_midiman_input(struct snd_usb_midi_in_endpoint* ep,
415 uint8_t* buffer, int buffer_length)
419 for (i = 0; i + 3 < buffer_length; i += 4)
420 if (buffer[i + 3] != 0) {
421 int port = buffer[i + 3] >> 4;
422 int length = buffer[i + 3] & 3;
423 snd_usbmidi_input_data(ep, port, &buffer[i], length);
428 * Buggy M-Audio device: running status on input results in a packet that has
429 * the data bytes but not the status byte and that is marked with CIN 4.
431 static void snd_usbmidi_maudio_broken_running_status_input(
432 struct snd_usb_midi_in_endpoint* ep,
433 uint8_t* buffer, int buffer_length)
437 for (i = 0; i + 3 < buffer_length; i += 4)
438 if (buffer[i] != 0) {
439 int cable = buffer[i] >> 4;
440 u8 cin = buffer[i] & 0x0f;
441 struct usbmidi_in_port *port = &ep->ports[cable];
444 length = snd_usbmidi_cin_length[cin];
445 if (cin == 0xf && buffer[i + 1] >= 0xf8)
446 ; /* realtime msg: no running status change */
447 else if (cin >= 0x8 && cin <= 0xe)
449 port->running_status_length = length - 1;
450 else if (cin == 0x4 &&
451 port->running_status_length != 0 &&
452 buffer[i + 1] < 0x80)
453 /* CIN 4 that is not a SysEx */
454 length = port->running_status_length;
457 * All other msgs cannot begin running status.
458 * (A channel msg sent as two or three CIN 0xF
459 * packets could in theory, but this device
460 * doesn't use this format.)
462 port->running_status_length = 0;
463 snd_usbmidi_input_data(ep, cable, &buffer[i + 1], length);
468 * CME protocol: like the standard protocol, but SysEx commands are sent as a
469 * single USB packet preceded by a 0x0F byte.
471 static void snd_usbmidi_cme_input(struct snd_usb_midi_in_endpoint *ep,
472 uint8_t *buffer, int buffer_length)
474 if (buffer_length < 2 || (buffer[0] & 0x0f) != 0x0f)
475 snd_usbmidi_standard_input(ep, buffer, buffer_length);
477 snd_usbmidi_input_data(ep, buffer[0] >> 4,
478 &buffer[1], buffer_length - 1);
482 * Adds one USB MIDI packet to the output buffer.
484 static void snd_usbmidi_output_standard_packet(struct urb* urb, uint8_t p0,
485 uint8_t p1, uint8_t p2, uint8_t p3)
488 uint8_t* buf = (uint8_t*)urb->transfer_buffer + urb->transfer_buffer_length;
493 urb->transfer_buffer_length += 4;
497 * Adds one Midiman packet to the output buffer.
499 static void snd_usbmidi_output_midiman_packet(struct urb* urb, uint8_t p0,
500 uint8_t p1, uint8_t p2, uint8_t p3)
503 uint8_t* buf = (uint8_t*)urb->transfer_buffer + urb->transfer_buffer_length;
507 buf[3] = (p0 & 0xf0) | snd_usbmidi_cin_length[p0 & 0x0f];
508 urb->transfer_buffer_length += 4;
512 * Converts MIDI commands to USB MIDI packets.
514 static void snd_usbmidi_transmit_byte(struct usbmidi_out_port* port,
515 uint8_t b, struct urb* urb)
517 uint8_t p0 = port->cable;
518 void (*output_packet)(struct urb*, uint8_t, uint8_t, uint8_t, uint8_t) =
519 port->ep->umidi->usb_protocol_ops->output_packet;
522 output_packet(urb, p0 | 0x0f, b, 0, 0);
523 } else if (b >= 0xf0) {
527 port->state = STATE_SYSEX_1;
532 port->state = STATE_1PARAM;
536 port->state = STATE_2PARAM_1;
540 port->state = STATE_UNKNOWN;
543 output_packet(urb, p0 | 0x05, 0xf6, 0, 0);
544 port->state = STATE_UNKNOWN;
547 switch (port->state) {
549 output_packet(urb, p0 | 0x05, 0xf7, 0, 0);
552 output_packet(urb, p0 | 0x06, port->data[0], 0xf7, 0);
555 output_packet(urb, p0 | 0x07, port->data[0], port->data[1], 0xf7);
558 port->state = STATE_UNKNOWN;
561 } else if (b >= 0x80) {
563 if (b >= 0xc0 && b <= 0xdf)
564 port->state = STATE_1PARAM;
566 port->state = STATE_2PARAM_1;
567 } else { /* b < 0x80 */
568 switch (port->state) {
570 if (port->data[0] < 0xf0) {
571 p0 |= port->data[0] >> 4;
574 port->state = STATE_UNKNOWN;
576 output_packet(urb, p0, port->data[0], b, 0);
580 port->state = STATE_2PARAM_2;
583 if (port->data[0] < 0xf0) {
584 p0 |= port->data[0] >> 4;
585 port->state = STATE_2PARAM_1;
588 port->state = STATE_UNKNOWN;
590 output_packet(urb, p0, port->data[0], port->data[1], b);
594 port->state = STATE_SYSEX_1;
598 port->state = STATE_SYSEX_2;
601 output_packet(urb, p0 | 0x04, port->data[0], port->data[1], b);
602 port->state = STATE_SYSEX_0;
608 static void snd_usbmidi_standard_output(struct snd_usb_midi_out_endpoint* ep,
613 /* FIXME: lower-numbered ports can starve higher-numbered ports */
614 for (p = 0; p < 0x10; ++p) {
615 struct usbmidi_out_port* port = &ep->ports[p];
618 while (urb->transfer_buffer_length + 3 < ep->max_transfer) {
620 if (snd_rawmidi_transmit(port->substream, &b, 1) != 1) {
624 snd_usbmidi_transmit_byte(port, b, urb);
629 static struct usb_protocol_ops snd_usbmidi_standard_ops = {
630 .input = snd_usbmidi_standard_input,
631 .output = snd_usbmidi_standard_output,
632 .output_packet = snd_usbmidi_output_standard_packet,
635 static struct usb_protocol_ops snd_usbmidi_midiman_ops = {
636 .input = snd_usbmidi_midiman_input,
637 .output = snd_usbmidi_standard_output,
638 .output_packet = snd_usbmidi_output_midiman_packet,
641 static struct usb_protocol_ops snd_usbmidi_maudio_broken_running_status_ops = {
642 .input = snd_usbmidi_maudio_broken_running_status_input,
643 .output = snd_usbmidi_standard_output,
644 .output_packet = snd_usbmidi_output_standard_packet,
647 static struct usb_protocol_ops snd_usbmidi_cme_ops = {
648 .input = snd_usbmidi_cme_input,
649 .output = snd_usbmidi_standard_output,
650 .output_packet = snd_usbmidi_output_standard_packet,
654 * AKAI MPD16 protocol:
656 * For control port (endpoint 1):
657 * ==============================
658 * One or more chunks consisting of first byte of (0x10 | msg_len) and then a
659 * SysEx message (msg_len=9 bytes long).
661 * For data port (endpoint 2):
662 * ===========================
663 * One or more chunks consisting of first byte of (0x20 | msg_len) and then a
664 * MIDI message (msg_len bytes long)
666 * Messages sent: Active Sense, Note On, Poly Pressure, Control Change.
668 static void snd_usbmidi_akai_input(struct snd_usb_midi_in_endpoint *ep,
669 uint8_t *buffer, int buffer_length)
671 unsigned int pos = 0;
672 unsigned int len = (unsigned int)buffer_length;
674 unsigned int port = (buffer[pos] >> 4) - 1;
675 unsigned int msg_len = buffer[pos] & 0x0f;
677 if (pos + msg_len <= len && port < 2)
678 snd_usbmidi_input_data(ep, 0, &buffer[pos], msg_len);
683 #define MAX_AKAI_SYSEX_LEN 9
685 static void snd_usbmidi_akai_output(struct snd_usb_midi_out_endpoint *ep,
689 int pos, end, count, buf_end;
690 uint8_t tmp[MAX_AKAI_SYSEX_LEN];
691 struct snd_rawmidi_substream *substream = ep->ports[0].substream;
693 if (!ep->ports[0].active)
696 msg = urb->transfer_buffer + urb->transfer_buffer_length;
697 buf_end = ep->max_transfer - MAX_AKAI_SYSEX_LEN - 1;
699 /* only try adding more data when there's space for at least 1 SysEx */
700 while (urb->transfer_buffer_length < buf_end) {
701 count = snd_rawmidi_transmit_peek(substream,
702 tmp, MAX_AKAI_SYSEX_LEN);
704 ep->ports[0].active = 0;
707 /* try to skip non-SysEx data */
708 for (pos = 0; pos < count && tmp[pos] != 0xF0; pos++)
712 snd_rawmidi_transmit_ack(substream, pos);
716 /* look for the start or end marker */
717 for (end = 1; end < count && tmp[end] < 0xF0; end++)
720 /* next SysEx started before the end of current one */
721 if (end < count && tmp[end] == 0xF0) {
722 /* it's incomplete - drop it */
723 snd_rawmidi_transmit_ack(substream, end);
727 if (end < count && tmp[end] == 0xF7) {
728 /* queue it, ack it, and get the next one */
730 msg[0] = 0x10 | count;
731 memcpy(&msg[1], tmp, count);
732 snd_rawmidi_transmit_ack(substream, count);
733 urb->transfer_buffer_length += count + 1;
737 /* less than 9 bytes and no end byte - wait for more */
738 if (count < MAX_AKAI_SYSEX_LEN) {
739 ep->ports[0].active = 0;
742 /* 9 bytes and no end marker in sight - malformed, skip it */
743 snd_rawmidi_transmit_ack(substream, count);
747 static struct usb_protocol_ops snd_usbmidi_akai_ops = {
748 .input = snd_usbmidi_akai_input,
749 .output = snd_usbmidi_akai_output,
753 * Novation USB MIDI protocol: number of data bytes is in the first byte
754 * (when receiving) (+1!) or in the second byte (when sending); data begins
758 static void snd_usbmidi_novation_input(struct snd_usb_midi_in_endpoint* ep,
759 uint8_t* buffer, int buffer_length)
761 if (buffer_length < 2 || !buffer[0] || buffer_length < buffer[0] + 1)
763 snd_usbmidi_input_data(ep, 0, &buffer[2], buffer[0] - 1);
766 static void snd_usbmidi_novation_output(struct snd_usb_midi_out_endpoint* ep,
769 uint8_t* transfer_buffer;
772 if (!ep->ports[0].active)
774 transfer_buffer = urb->transfer_buffer;
775 count = snd_rawmidi_transmit(ep->ports[0].substream,
777 ep->max_transfer - 2);
779 ep->ports[0].active = 0;
782 transfer_buffer[0] = 0;
783 transfer_buffer[1] = count;
784 urb->transfer_buffer_length = 2 + count;
787 static struct usb_protocol_ops snd_usbmidi_novation_ops = {
788 .input = snd_usbmidi_novation_input,
789 .output = snd_usbmidi_novation_output,
793 * "raw" protocol: just move raw MIDI bytes from/to the endpoint
796 static void snd_usbmidi_raw_input(struct snd_usb_midi_in_endpoint* ep,
797 uint8_t* buffer, int buffer_length)
799 snd_usbmidi_input_data(ep, 0, buffer, buffer_length);
802 static void snd_usbmidi_raw_output(struct snd_usb_midi_out_endpoint* ep,
807 if (!ep->ports[0].active)
809 count = snd_rawmidi_transmit(ep->ports[0].substream,
810 urb->transfer_buffer,
813 ep->ports[0].active = 0;
816 urb->transfer_buffer_length = count;
819 static struct usb_protocol_ops snd_usbmidi_raw_ops = {
820 .input = snd_usbmidi_raw_input,
821 .output = snd_usbmidi_raw_output,
825 * FTDI protocol: raw MIDI bytes, but input packets have two modem status bytes.
828 static void snd_usbmidi_ftdi_input(struct snd_usb_midi_in_endpoint* ep,
829 uint8_t* buffer, int buffer_length)
831 if (buffer_length > 2)
832 snd_usbmidi_input_data(ep, 0, buffer + 2, buffer_length - 2);
835 static struct usb_protocol_ops snd_usbmidi_ftdi_ops = {
836 .input = snd_usbmidi_ftdi_input,
837 .output = snd_usbmidi_raw_output,
840 static void snd_usbmidi_us122l_input(struct snd_usb_midi_in_endpoint *ep,
841 uint8_t *buffer, int buffer_length)
843 if (buffer_length != 9)
846 while (buffer_length && buffer[buffer_length - 1] == 0xFD)
849 snd_usbmidi_input_data(ep, 0, buffer, buffer_length);
852 static void snd_usbmidi_us122l_output(struct snd_usb_midi_out_endpoint *ep,
857 if (!ep->ports[0].active)
859 switch (snd_usb_get_speed(ep->umidi->dev)) {
861 case USB_SPEED_SUPER:
867 count = snd_rawmidi_transmit(ep->ports[0].substream,
868 urb->transfer_buffer,
871 ep->ports[0].active = 0;
875 memset(urb->transfer_buffer + count, 0xFD, ep->max_transfer - count);
876 urb->transfer_buffer_length = ep->max_transfer;
879 static struct usb_protocol_ops snd_usbmidi_122l_ops = {
880 .input = snd_usbmidi_us122l_input,
881 .output = snd_usbmidi_us122l_output,
885 * Emagic USB MIDI protocol: raw MIDI with "F5 xx" port switching.
888 static void snd_usbmidi_emagic_init_out(struct snd_usb_midi_out_endpoint* ep)
890 static const u8 init_data[] = {
891 /* initialization magic: "get version" */
893 0x00, 0x20, 0x31, /* Emagic */
895 0x0b, /* version number request */
896 0x00, /* command version */
897 0x00, /* EEPROM, box 0 */
900 send_bulk_static_data(ep, init_data, sizeof(init_data));
901 /* while we're at it, pour on more magic */
902 send_bulk_static_data(ep, init_data, sizeof(init_data));
905 static void snd_usbmidi_emagic_finish_out(struct snd_usb_midi_out_endpoint* ep)
907 static const u8 finish_data[] = {
908 /* switch to patch mode with last preset */
910 0x00, 0x20, 0x31, /* Emagic */
912 0x10, /* patch switch command */
913 0x00, /* command version */
914 0x7f, /* to all boxes */
915 0x40, /* last preset in EEPROM */
918 send_bulk_static_data(ep, finish_data, sizeof(finish_data));
921 static void snd_usbmidi_emagic_input(struct snd_usb_midi_in_endpoint* ep,
922 uint8_t* buffer, int buffer_length)
926 /* FF indicates end of valid data */
927 for (i = 0; i < buffer_length; ++i)
928 if (buffer[i] == 0xff) {
933 /* handle F5 at end of last buffer */
937 while (buffer_length > 0) {
938 /* determine size of data until next F5 */
939 for (i = 0; i < buffer_length; ++i)
940 if (buffer[i] == 0xf5)
942 snd_usbmidi_input_data(ep, ep->current_port, buffer, i);
946 if (buffer_length <= 0)
948 /* assert(buffer[0] == 0xf5); */
954 if (buffer_length <= 0)
956 if (buffer[0] < 0x80) {
957 ep->current_port = (buffer[0] - 1) & 15;
965 static void snd_usbmidi_emagic_output(struct snd_usb_midi_out_endpoint* ep,
968 int port0 = ep->current_port;
969 uint8_t* buf = urb->transfer_buffer;
970 int buf_free = ep->max_transfer;
973 for (i = 0; i < 0x10; ++i) {
974 /* round-robin, starting at the last current port */
975 int portnum = (port0 + i) & 15;
976 struct usbmidi_out_port* port = &ep->ports[portnum];
980 if (snd_rawmidi_transmit_peek(port->substream, buf, 1) != 1) {
985 if (portnum != ep->current_port) {
988 ep->current_port = portnum;
990 buf[1] = (portnum + 1) & 15;
997 length = snd_rawmidi_transmit(port->substream, buf, buf_free);
1005 if (buf_free < ep->max_transfer && buf_free > 0) {
1009 urb->transfer_buffer_length = ep->max_transfer - buf_free;
1012 static struct usb_protocol_ops snd_usbmidi_emagic_ops = {
1013 .input = snd_usbmidi_emagic_input,
1014 .output = snd_usbmidi_emagic_output,
1015 .init_out_endpoint = snd_usbmidi_emagic_init_out,
1016 .finish_out_endpoint = snd_usbmidi_emagic_finish_out,
1020 static void update_roland_altsetting(struct snd_usb_midi* umidi)
1022 struct usb_interface *intf;
1023 struct usb_host_interface *hostif;
1024 struct usb_interface_descriptor *intfd;
1027 intf = umidi->iface;
1028 is_light_load = intf->cur_altsetting != intf->altsetting;
1029 if (umidi->roland_load_ctl->private_value == is_light_load)
1031 hostif = &intf->altsetting[umidi->roland_load_ctl->private_value];
1032 intfd = get_iface_desc(hostif);
1033 snd_usbmidi_input_stop(&umidi->list);
1034 usb_set_interface(umidi->dev, intfd->bInterfaceNumber,
1035 intfd->bAlternateSetting);
1036 snd_usbmidi_input_start(&umidi->list);
1039 static int substream_open(struct snd_rawmidi_substream *substream, int dir,
1042 struct snd_usb_midi* umidi = substream->rmidi->private_data;
1043 struct snd_kcontrol *ctl;
1045 down_read(&umidi->disc_rwsem);
1046 if (umidi->disconnected) {
1047 up_read(&umidi->disc_rwsem);
1048 return open ? -ENODEV : 0;
1051 mutex_lock(&umidi->mutex);
1053 if (!umidi->opened[0] && !umidi->opened[1]) {
1054 if (umidi->roland_load_ctl) {
1055 ctl = umidi->roland_load_ctl;
1056 ctl->vd[0].access |= SNDRV_CTL_ELEM_ACCESS_INACTIVE;
1057 snd_ctl_notify(umidi->card,
1058 SNDRV_CTL_EVENT_MASK_INFO, &ctl->id);
1059 update_roland_altsetting(umidi);
1062 umidi->opened[dir]++;
1063 if (umidi->opened[1])
1064 snd_usbmidi_input_start(&umidi->list);
1066 umidi->opened[dir]--;
1067 if (!umidi->opened[1])
1068 snd_usbmidi_input_stop(&umidi->list);
1069 if (!umidi->opened[0] && !umidi->opened[1]) {
1070 if (umidi->roland_load_ctl) {
1071 ctl = umidi->roland_load_ctl;
1072 ctl->vd[0].access &= ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
1073 snd_ctl_notify(umidi->card,
1074 SNDRV_CTL_EVENT_MASK_INFO, &ctl->id);
1078 mutex_unlock(&umidi->mutex);
1079 up_read(&umidi->disc_rwsem);
1083 static int snd_usbmidi_output_open(struct snd_rawmidi_substream *substream)
1085 struct snd_usb_midi* umidi = substream->rmidi->private_data;
1086 struct usbmidi_out_port* port = NULL;
1089 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
1090 if (umidi->endpoints[i].out)
1091 for (j = 0; j < 0x10; ++j)
1092 if (umidi->endpoints[i].out->ports[j].substream == substream) {
1093 port = &umidi->endpoints[i].out->ports[j];
1101 substream->runtime->private_data = port;
1102 port->state = STATE_UNKNOWN;
1103 return substream_open(substream, 0, 1);
1106 static int snd_usbmidi_output_close(struct snd_rawmidi_substream *substream)
1108 return substream_open(substream, 0, 0);
1111 static void snd_usbmidi_output_trigger(struct snd_rawmidi_substream *substream, int up)
1113 struct usbmidi_out_port* port = (struct usbmidi_out_port*)substream->runtime->private_data;
1117 if (port->ep->umidi->disconnected) {
1118 /* gobble up remaining bytes to prevent wait in
1119 * snd_rawmidi_drain_output */
1120 while (!snd_rawmidi_transmit_empty(substream))
1121 snd_rawmidi_transmit_ack(substream, 1);
1124 tasklet_schedule(&port->ep->tasklet);
1128 static void snd_usbmidi_output_drain(struct snd_rawmidi_substream *substream)
1130 struct usbmidi_out_port* port = substream->runtime->private_data;
1131 struct snd_usb_midi_out_endpoint *ep = port->ep;
1132 unsigned int drain_urbs;
1134 long timeout = msecs_to_jiffies(50);
1136 if (ep->umidi->disconnected)
1139 * The substream buffer is empty, but some data might still be in the
1140 * currently active URBs, so we have to wait for those to complete.
1142 spin_lock_irq(&ep->buffer_lock);
1143 drain_urbs = ep->active_urbs;
1145 ep->drain_urbs |= drain_urbs;
1147 prepare_to_wait(&ep->drain_wait, &wait,
1148 TASK_UNINTERRUPTIBLE);
1149 spin_unlock_irq(&ep->buffer_lock);
1150 timeout = schedule_timeout(timeout);
1151 spin_lock_irq(&ep->buffer_lock);
1152 drain_urbs &= ep->drain_urbs;
1153 } while (drain_urbs && timeout);
1154 finish_wait(&ep->drain_wait, &wait);
1156 spin_unlock_irq(&ep->buffer_lock);
1159 static int snd_usbmidi_input_open(struct snd_rawmidi_substream *substream)
1161 return substream_open(substream, 1, 1);
1164 static int snd_usbmidi_input_close(struct snd_rawmidi_substream *substream)
1166 return substream_open(substream, 1, 0);
1169 static void snd_usbmidi_input_trigger(struct snd_rawmidi_substream *substream, int up)
1171 struct snd_usb_midi* umidi = substream->rmidi->private_data;
1174 set_bit(substream->number, &umidi->input_triggered);
1176 clear_bit(substream->number, &umidi->input_triggered);
1179 static struct snd_rawmidi_ops snd_usbmidi_output_ops = {
1180 .open = snd_usbmidi_output_open,
1181 .close = snd_usbmidi_output_close,
1182 .trigger = snd_usbmidi_output_trigger,
1183 .drain = snd_usbmidi_output_drain,
1186 static struct snd_rawmidi_ops snd_usbmidi_input_ops = {
1187 .open = snd_usbmidi_input_open,
1188 .close = snd_usbmidi_input_close,
1189 .trigger = snd_usbmidi_input_trigger
1192 static void free_urb_and_buffer(struct snd_usb_midi *umidi, struct urb *urb,
1193 unsigned int buffer_length)
1195 usb_free_coherent(umidi->dev, buffer_length,
1196 urb->transfer_buffer, urb->transfer_dma);
1201 * Frees an input endpoint.
1202 * May be called when ep hasn't been initialized completely.
1204 static void snd_usbmidi_in_endpoint_delete(struct snd_usb_midi_in_endpoint* ep)
1208 for (i = 0; i < INPUT_URBS; ++i)
1210 free_urb_and_buffer(ep->umidi, ep->urbs[i],
1211 ep->urbs[i]->transfer_buffer_length);
1216 * Creates an input endpoint.
1218 static int snd_usbmidi_in_endpoint_create(struct snd_usb_midi* umidi,
1219 struct snd_usb_midi_endpoint_info* ep_info,
1220 struct snd_usb_midi_endpoint* rep)
1222 struct snd_usb_midi_in_endpoint* ep;
1229 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1234 for (i = 0; i < INPUT_URBS; ++i) {
1235 ep->urbs[i] = usb_alloc_urb(0, GFP_KERNEL);
1237 snd_usbmidi_in_endpoint_delete(ep);
1241 if (ep_info->in_interval)
1242 pipe = usb_rcvintpipe(umidi->dev, ep_info->in_ep);
1244 pipe = usb_rcvbulkpipe(umidi->dev, ep_info->in_ep);
1245 length = usb_maxpacket(umidi->dev, pipe, 0);
1246 for (i = 0; i < INPUT_URBS; ++i) {
1247 buffer = usb_alloc_coherent(umidi->dev, length, GFP_KERNEL,
1248 &ep->urbs[i]->transfer_dma);
1250 snd_usbmidi_in_endpoint_delete(ep);
1253 if (ep_info->in_interval)
1254 usb_fill_int_urb(ep->urbs[i], umidi->dev,
1255 pipe, buffer, length,
1256 snd_usbmidi_in_urb_complete,
1257 ep, ep_info->in_interval);
1259 usb_fill_bulk_urb(ep->urbs[i], umidi->dev,
1260 pipe, buffer, length,
1261 snd_usbmidi_in_urb_complete, ep);
1262 ep->urbs[i]->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1270 * Frees an output endpoint.
1271 * May be called when ep hasn't been initialized completely.
1273 static void snd_usbmidi_out_endpoint_clear(struct snd_usb_midi_out_endpoint *ep)
1277 for (i = 0; i < OUTPUT_URBS; ++i)
1278 if (ep->urbs[i].urb) {
1279 free_urb_and_buffer(ep->umidi, ep->urbs[i].urb,
1281 ep->urbs[i].urb = NULL;
1285 static void snd_usbmidi_out_endpoint_delete(struct snd_usb_midi_out_endpoint *ep)
1287 snd_usbmidi_out_endpoint_clear(ep);
1292 * Creates an output endpoint, and initializes output ports.
1294 static int snd_usbmidi_out_endpoint_create(struct snd_usb_midi* umidi,
1295 struct snd_usb_midi_endpoint_info* ep_info,
1296 struct snd_usb_midi_endpoint* rep)
1298 struct snd_usb_midi_out_endpoint* ep;
1304 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1309 for (i = 0; i < OUTPUT_URBS; ++i) {
1310 ep->urbs[i].urb = usb_alloc_urb(0, GFP_KERNEL);
1311 if (!ep->urbs[i].urb) {
1312 snd_usbmidi_out_endpoint_delete(ep);
1315 ep->urbs[i].ep = ep;
1317 if (ep_info->out_interval)
1318 pipe = usb_sndintpipe(umidi->dev, ep_info->out_ep);
1320 pipe = usb_sndbulkpipe(umidi->dev, ep_info->out_ep);
1321 switch (umidi->usb_id) {
1323 ep->max_transfer = usb_maxpacket(umidi->dev, pipe, 1);
1326 * Various chips declare a packet size larger than 4 bytes, but
1327 * do not actually work with larger packets:
1329 case USB_ID(0x0a67, 0x5011): /* Medeli DD305 */
1330 case USB_ID(0x0a92, 0x1020): /* ESI M4U */
1331 case USB_ID(0x1430, 0x474b): /* RedOctane GH MIDI INTERFACE */
1332 case USB_ID(0x15ca, 0x0101): /* Textech USB Midi Cable */
1333 case USB_ID(0x15ca, 0x1806): /* Textech USB Midi Cable */
1334 case USB_ID(0x1a86, 0x752d): /* QinHeng CH345 "USB2.0-MIDI" */
1335 case USB_ID(0xfc08, 0x0101): /* Unknown vendor Cable */
1336 ep->max_transfer = 4;
1339 * Some devices only work with 9 bytes packet size:
1341 case USB_ID(0x0644, 0x800E): /* Tascam US-122L */
1342 case USB_ID(0x0644, 0x800F): /* Tascam US-144 */
1343 ep->max_transfer = 9;
1346 for (i = 0; i < OUTPUT_URBS; ++i) {
1347 buffer = usb_alloc_coherent(umidi->dev,
1348 ep->max_transfer, GFP_KERNEL,
1349 &ep->urbs[i].urb->transfer_dma);
1351 snd_usbmidi_out_endpoint_delete(ep);
1354 if (ep_info->out_interval)
1355 usb_fill_int_urb(ep->urbs[i].urb, umidi->dev,
1356 pipe, buffer, ep->max_transfer,
1357 snd_usbmidi_out_urb_complete,
1358 &ep->urbs[i], ep_info->out_interval);
1360 usb_fill_bulk_urb(ep->urbs[i].urb, umidi->dev,
1361 pipe, buffer, ep->max_transfer,
1362 snd_usbmidi_out_urb_complete,
1364 ep->urbs[i].urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1367 spin_lock_init(&ep->buffer_lock);
1368 tasklet_init(&ep->tasklet, snd_usbmidi_out_tasklet, (unsigned long)ep);
1369 init_waitqueue_head(&ep->drain_wait);
1371 for (i = 0; i < 0x10; ++i)
1372 if (ep_info->out_cables & (1 << i)) {
1373 ep->ports[i].ep = ep;
1374 ep->ports[i].cable = i << 4;
1377 if (umidi->usb_protocol_ops->init_out_endpoint)
1378 umidi->usb_protocol_ops->init_out_endpoint(ep);
1387 static void snd_usbmidi_free(struct snd_usb_midi* umidi)
1391 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1392 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
1394 snd_usbmidi_out_endpoint_delete(ep->out);
1396 snd_usbmidi_in_endpoint_delete(ep->in);
1398 mutex_destroy(&umidi->mutex);
1403 * Unlinks all URBs (must be done before the usb_device is deleted).
1405 void snd_usbmidi_disconnect(struct list_head* p)
1407 struct snd_usb_midi* umidi;
1410 umidi = list_entry(p, struct snd_usb_midi, list);
1412 * an URB's completion handler may start the timer and
1413 * a timer may submit an URB. To reliably break the cycle
1414 * a flag under lock must be used
1416 down_write(&umidi->disc_rwsem);
1417 spin_lock_irq(&umidi->disc_lock);
1418 umidi->disconnected = 1;
1419 spin_unlock_irq(&umidi->disc_lock);
1420 up_write(&umidi->disc_rwsem);
1422 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1423 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
1425 tasklet_kill(&ep->out->tasklet);
1427 for (j = 0; j < OUTPUT_URBS; ++j)
1428 usb_kill_urb(ep->out->urbs[j].urb);
1429 if (umidi->usb_protocol_ops->finish_out_endpoint)
1430 umidi->usb_protocol_ops->finish_out_endpoint(ep->out);
1431 ep->out->active_urbs = 0;
1432 if (ep->out->drain_urbs) {
1433 ep->out->drain_urbs = 0;
1434 wake_up(&ep->out->drain_wait);
1438 for (j = 0; j < INPUT_URBS; ++j)
1439 usb_kill_urb(ep->in->urbs[j]);
1440 /* free endpoints here; later call can result in Oops */
1442 snd_usbmidi_out_endpoint_clear(ep->out);
1444 snd_usbmidi_in_endpoint_delete(ep->in);
1448 del_timer_sync(&umidi->error_timer);
1451 static void snd_usbmidi_rawmidi_free(struct snd_rawmidi *rmidi)
1453 struct snd_usb_midi* umidi = rmidi->private_data;
1454 snd_usbmidi_free(umidi);
1457 static struct snd_rawmidi_substream *snd_usbmidi_find_substream(struct snd_usb_midi* umidi,
1458 int stream, int number)
1460 struct list_head* list;
1462 list_for_each(list, &umidi->rmidi->streams[stream].substreams) {
1463 struct snd_rawmidi_substream *substream = list_entry(list, struct snd_rawmidi_substream, list);
1464 if (substream->number == number)
1471 * This list specifies names for ports that do not fit into the standard
1472 * "(product) MIDI (n)" schema because they aren't external MIDI ports,
1473 * such as internal control or synthesizer ports.
1475 static struct port_info {
1480 unsigned int seq_flags;
1481 } snd_usbmidi_port_info[] = {
1482 #define PORT_INFO(vendor, product, num, name_, voices_, flags) \
1483 { .id = USB_ID(vendor, product), \
1484 .port = num, .voices = voices_, \
1485 .name = name_, .seq_flags = flags }
1486 #define EXTERNAL_PORT(vendor, product, num, name) \
1487 PORT_INFO(vendor, product, num, name, 0, \
1488 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1489 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1490 SNDRV_SEQ_PORT_TYPE_PORT)
1491 #define CONTROL_PORT(vendor, product, num, name) \
1492 PORT_INFO(vendor, product, num, name, 0, \
1493 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1494 SNDRV_SEQ_PORT_TYPE_HARDWARE)
1495 #define ROLAND_SYNTH_PORT(vendor, product, num, name, voices) \
1496 PORT_INFO(vendor, product, num, name, voices, \
1497 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1498 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1499 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1500 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1501 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1502 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1503 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1504 #define SOUNDCANVAS_PORT(vendor, product, num, name, voices) \
1505 PORT_INFO(vendor, product, num, name, voices, \
1506 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1507 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1508 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1509 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1510 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1511 SNDRV_SEQ_PORT_TYPE_MIDI_MT32 | \
1512 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1513 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1515 CONTROL_PORT(0x0582, 0x0000, 2, "%s Control"),
1516 /* Roland SC-8850 */
1517 SOUNDCANVAS_PORT(0x0582, 0x0003, 0, "%s Part A", 128),
1518 SOUNDCANVAS_PORT(0x0582, 0x0003, 1, "%s Part B", 128),
1519 SOUNDCANVAS_PORT(0x0582, 0x0003, 2, "%s Part C", 128),
1520 SOUNDCANVAS_PORT(0x0582, 0x0003, 3, "%s Part D", 128),
1521 EXTERNAL_PORT(0x0582, 0x0003, 4, "%s MIDI 1"),
1522 EXTERNAL_PORT(0x0582, 0x0003, 5, "%s MIDI 2"),
1524 EXTERNAL_PORT(0x0582, 0x0004, 0, "%s MIDI"),
1525 CONTROL_PORT(0x0582, 0x0004, 1, "%s Control"),
1526 /* Roland SC-8820 */
1527 SOUNDCANVAS_PORT(0x0582, 0x0007, 0, "%s Part A", 64),
1528 SOUNDCANVAS_PORT(0x0582, 0x0007, 1, "%s Part B", 64),
1529 EXTERNAL_PORT(0x0582, 0x0007, 2, "%s MIDI"),
1531 SOUNDCANVAS_PORT(0x0582, 0x000b, 0, "%s Part A", 64),
1532 SOUNDCANVAS_PORT(0x0582, 0x000b, 1, "%s Part B", 64),
1533 EXTERNAL_PORT(0x0582, 0x000b, 2, "%s MIDI"),
1535 SOUNDCANVAS_PORT(0x0582, 0x000c, 0, "%s Part A", 64),
1536 SOUNDCANVAS_PORT(0x0582, 0x000c, 1, "%s Part B", 64),
1537 EXTERNAL_PORT(0x0582, 0x000c, 2, "%s MIDI"),
1539 CONTROL_PORT(0x0582, 0x0014, 8, "%s Control"),
1541 ROLAND_SYNTH_PORT(0x0582, 0x0016, 0, "%s Part A", 128),
1542 ROLAND_SYNTH_PORT(0x0582, 0x0016, 1, "%s Part B", 128),
1543 EXTERNAL_PORT(0x0582, 0x0016, 2, "%s MIDI 1"),
1544 EXTERNAL_PORT(0x0582, 0x0016, 3, "%s MIDI 2"),
1546 CONTROL_PORT(0x0582, 0x0023, 5, "%s Control"),
1548 ROLAND_SYNTH_PORT(0x0582, 0x0027, 0, "%s Part A", 64),
1549 ROLAND_SYNTH_PORT(0x0582, 0x0027, 1, "%s Part B", 64),
1550 EXTERNAL_PORT(0x0582, 0x0027, 2, "%s MIDI"),
1552 ROLAND_SYNTH_PORT(0x0582, 0x0029, 0, "%s Part A", 128),
1553 ROLAND_SYNTH_PORT(0x0582, 0x0029, 1, "%s Part B", 128),
1554 EXTERNAL_PORT(0x0582, 0x0029, 2, "%s MIDI 1"),
1555 EXTERNAL_PORT(0x0582, 0x0029, 3, "%s MIDI 2"),
1557 EXTERNAL_PORT(0x0582, 0x002b, 0, "%s MIDI"),
1558 CONTROL_PORT(0x0582, 0x002b, 1, "%s Control"),
1560 EXTERNAL_PORT(0x0582, 0x002f, 0, "%s MIDI"),
1561 EXTERNAL_PORT(0x0582, 0x002f, 1, "%s External MIDI"),
1562 EXTERNAL_PORT(0x0582, 0x002f, 2, "%s Sync"),
1564 EXTERNAL_PORT(0x0582, 0x0033, 0, "%s MIDI"),
1565 EXTERNAL_PORT(0x0582, 0x0033, 1, "%s 1"),
1566 EXTERNAL_PORT(0x0582, 0x0033, 2, "%s 2"),
1568 EXTERNAL_PORT(0x0582, 0x003b, 0, "%s MIDI"),
1569 CONTROL_PORT(0x0582, 0x003b, 1, "%s Control"),
1570 /* Edirol UA-1000 */
1571 EXTERNAL_PORT(0x0582, 0x0044, 0, "%s MIDI"),
1572 CONTROL_PORT(0x0582, 0x0044, 1, "%s Control"),
1574 EXTERNAL_PORT(0x0582, 0x0048, 0, "%s MIDI"),
1575 EXTERNAL_PORT(0x0582, 0x0048, 1, "%s 1"),
1576 EXTERNAL_PORT(0x0582, 0x0048, 2, "%s 2"),
1578 EXTERNAL_PORT(0x0582, 0x004d, 0, "%s MIDI"),
1579 EXTERNAL_PORT(0x0582, 0x004d, 1, "%s 1"),
1580 EXTERNAL_PORT(0x0582, 0x004d, 2, "%s 2"),
1582 CONTROL_PORT(0x0582, 0x009a, 3, "%s Control"),
1583 /* M-Audio MidiSport 8x8 */
1584 CONTROL_PORT(0x0763, 0x1031, 8, "%s Control"),
1585 CONTROL_PORT(0x0763, 0x1033, 8, "%s Control"),
1587 EXTERNAL_PORT(0x07fd, 0x0001, 0, "%s MIDI A"),
1588 EXTERNAL_PORT(0x07fd, 0x0001, 1, "%s MIDI B"),
1589 /* Emagic Unitor8/AMT8/MT4 */
1590 EXTERNAL_PORT(0x086a, 0x0001, 8, "%s Broadcast"),
1591 EXTERNAL_PORT(0x086a, 0x0002, 8, "%s Broadcast"),
1592 EXTERNAL_PORT(0x086a, 0x0003, 4, "%s Broadcast"),
1594 CONTROL_PORT(0x09e8, 0x0062, 0, "%s Control"),
1595 PORT_INFO(0x09e8, 0x0062, 1, "%s MIDI", 0,
1596 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC |
1597 SNDRV_SEQ_PORT_TYPE_HARDWARE),
1598 /* Access Music Virus TI */
1599 EXTERNAL_PORT(0x133e, 0x0815, 0, "%s MIDI"),
1600 PORT_INFO(0x133e, 0x0815, 1, "%s Synth", 0,
1601 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC |
1602 SNDRV_SEQ_PORT_TYPE_HARDWARE |
1603 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER),
1606 static struct port_info *find_port_info(struct snd_usb_midi* umidi, int number)
1610 for (i = 0; i < ARRAY_SIZE(snd_usbmidi_port_info); ++i) {
1611 if (snd_usbmidi_port_info[i].id == umidi->usb_id &&
1612 snd_usbmidi_port_info[i].port == number)
1613 return &snd_usbmidi_port_info[i];
1618 static void snd_usbmidi_get_port_info(struct snd_rawmidi *rmidi, int number,
1619 struct snd_seq_port_info *seq_port_info)
1621 struct snd_usb_midi *umidi = rmidi->private_data;
1622 struct port_info *port_info;
1624 /* TODO: read port flags from descriptors */
1625 port_info = find_port_info(umidi, number);
1627 seq_port_info->type = port_info->seq_flags;
1628 seq_port_info->midi_voices = port_info->voices;
1632 static void snd_usbmidi_init_substream(struct snd_usb_midi* umidi,
1633 int stream, int number,
1634 struct snd_rawmidi_substream ** rsubstream)
1636 struct port_info *port_info;
1637 const char *name_format;
1639 struct snd_rawmidi_substream *substream = snd_usbmidi_find_substream(umidi, stream, number);
1641 snd_printd(KERN_ERR "substream %d:%d not found\n", stream, number);
1645 /* TODO: read port name from jack descriptor */
1646 port_info = find_port_info(umidi, number);
1647 name_format = port_info ? port_info->name : "%s MIDI %d";
1648 snprintf(substream->name, sizeof(substream->name),
1649 name_format, umidi->card->shortname, number + 1);
1651 *rsubstream = substream;
1655 * Creates the endpoints and their ports.
1657 static int snd_usbmidi_create_endpoints(struct snd_usb_midi* umidi,
1658 struct snd_usb_midi_endpoint_info* endpoints)
1661 int out_ports = 0, in_ports = 0;
1663 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1664 if (endpoints[i].out_cables) {
1665 err = snd_usbmidi_out_endpoint_create(umidi, &endpoints[i],
1666 &umidi->endpoints[i]);
1670 if (endpoints[i].in_cables) {
1671 err = snd_usbmidi_in_endpoint_create(umidi, &endpoints[i],
1672 &umidi->endpoints[i]);
1677 for (j = 0; j < 0x10; ++j) {
1678 if (endpoints[i].out_cables & (1 << j)) {
1679 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_OUTPUT, out_ports,
1680 &umidi->endpoints[i].out->ports[j].substream);
1683 if (endpoints[i].in_cables & (1 << j)) {
1684 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_INPUT, in_ports,
1685 &umidi->endpoints[i].in->ports[j].substream);
1690 snd_printdd(KERN_INFO "created %d output and %d input ports\n",
1691 out_ports, in_ports);
1696 * Returns MIDIStreaming device capabilities.
1698 static int snd_usbmidi_get_ms_info(struct snd_usb_midi* umidi,
1699 struct snd_usb_midi_endpoint_info* endpoints)
1701 struct usb_interface* intf;
1702 struct usb_host_interface *hostif;
1703 struct usb_interface_descriptor* intfd;
1704 struct usb_ms_header_descriptor* ms_header;
1705 struct usb_host_endpoint *hostep;
1706 struct usb_endpoint_descriptor* ep;
1707 struct usb_ms_endpoint_descriptor* ms_ep;
1710 intf = umidi->iface;
1713 hostif = &intf->altsetting[0];
1714 intfd = get_iface_desc(hostif);
1715 ms_header = (struct usb_ms_header_descriptor*)hostif->extra;
1716 if (hostif->extralen >= 7 &&
1717 ms_header->bLength >= 7 &&
1718 ms_header->bDescriptorType == USB_DT_CS_INTERFACE &&
1719 ms_header->bDescriptorSubtype == UAC_HEADER)
1720 snd_printdd(KERN_INFO "MIDIStreaming version %02x.%02x\n",
1721 ms_header->bcdMSC[1], ms_header->bcdMSC[0]);
1723 snd_printk(KERN_WARNING "MIDIStreaming interface descriptor not found\n");
1726 for (i = 0; i < intfd->bNumEndpoints; ++i) {
1727 hostep = &hostif->endpoint[i];
1728 ep = get_ep_desc(hostep);
1729 if (!usb_endpoint_xfer_bulk(ep) && !usb_endpoint_xfer_int(ep))
1731 ms_ep = (struct usb_ms_endpoint_descriptor*)hostep->extra;
1732 if (hostep->extralen < 4 ||
1733 ms_ep->bLength < 4 ||
1734 ms_ep->bDescriptorType != USB_DT_CS_ENDPOINT ||
1735 ms_ep->bDescriptorSubtype != UAC_MS_GENERAL)
1737 if (usb_endpoint_dir_out(ep)) {
1738 if (endpoints[epidx].out_ep) {
1739 if (++epidx >= MIDI_MAX_ENDPOINTS) {
1740 snd_printk(KERN_WARNING "too many endpoints\n");
1744 endpoints[epidx].out_ep = usb_endpoint_num(ep);
1745 if (usb_endpoint_xfer_int(ep))
1746 endpoints[epidx].out_interval = ep->bInterval;
1747 else if (snd_usb_get_speed(umidi->dev) == USB_SPEED_LOW)
1749 * Low speed bulk transfers don't exist, so
1750 * force interrupt transfers for devices like
1751 * ESI MIDI Mate that try to use them anyway.
1753 endpoints[epidx].out_interval = 1;
1754 endpoints[epidx].out_cables = (1 << ms_ep->bNumEmbMIDIJack) - 1;
1755 snd_printdd(KERN_INFO "EP %02X: %d jack(s)\n",
1756 ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1758 if (endpoints[epidx].in_ep) {
1759 if (++epidx >= MIDI_MAX_ENDPOINTS) {
1760 snd_printk(KERN_WARNING "too many endpoints\n");
1764 endpoints[epidx].in_ep = usb_endpoint_num(ep);
1765 if (usb_endpoint_xfer_int(ep))
1766 endpoints[epidx].in_interval = ep->bInterval;
1767 else if (snd_usb_get_speed(umidi->dev) == USB_SPEED_LOW)
1768 endpoints[epidx].in_interval = 1;
1769 endpoints[epidx].in_cables = (1 << ms_ep->bNumEmbMIDIJack) - 1;
1770 snd_printdd(KERN_INFO "EP %02X: %d jack(s)\n",
1771 ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1777 static int roland_load_info(struct snd_kcontrol *kcontrol,
1778 struct snd_ctl_elem_info *info)
1780 static const char *const names[] = { "High Load", "Light Load" };
1782 return snd_ctl_enum_info(info, 1, 2, names);
1785 static int roland_load_get(struct snd_kcontrol *kcontrol,
1786 struct snd_ctl_elem_value *value)
1788 value->value.enumerated.item[0] = kcontrol->private_value;
1792 static int roland_load_put(struct snd_kcontrol *kcontrol,
1793 struct snd_ctl_elem_value *value)
1795 struct snd_usb_midi* umidi = kcontrol->private_data;
1798 if (value->value.enumerated.item[0] > 1)
1800 mutex_lock(&umidi->mutex);
1801 changed = value->value.enumerated.item[0] != kcontrol->private_value;
1803 kcontrol->private_value = value->value.enumerated.item[0];
1804 mutex_unlock(&umidi->mutex);
1808 static struct snd_kcontrol_new roland_load_ctl = {
1809 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1810 .name = "MIDI Input Mode",
1811 .info = roland_load_info,
1812 .get = roland_load_get,
1813 .put = roland_load_put,
1818 * On Roland devices, use the second alternate setting to be able to use
1819 * the interrupt input endpoint.
1821 static void snd_usbmidi_switch_roland_altsetting(struct snd_usb_midi* umidi)
1823 struct usb_interface* intf;
1824 struct usb_host_interface *hostif;
1825 struct usb_interface_descriptor* intfd;
1827 intf = umidi->iface;
1828 if (!intf || intf->num_altsetting != 2)
1831 hostif = &intf->altsetting[1];
1832 intfd = get_iface_desc(hostif);
1833 if (intfd->bNumEndpoints != 2 ||
1834 (get_endpoint(hostif, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK ||
1835 (get_endpoint(hostif, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
1838 snd_printdd(KERN_INFO "switching to altsetting %d with int ep\n",
1839 intfd->bAlternateSetting);
1840 usb_set_interface(umidi->dev, intfd->bInterfaceNumber,
1841 intfd->bAlternateSetting);
1843 umidi->roland_load_ctl = snd_ctl_new1(&roland_load_ctl, umidi);
1844 if (snd_ctl_add(umidi->card, umidi->roland_load_ctl) < 0)
1845 umidi->roland_load_ctl = NULL;
1849 * Try to find any usable endpoints in the interface.
1851 static int snd_usbmidi_detect_endpoints(struct snd_usb_midi* umidi,
1852 struct snd_usb_midi_endpoint_info* endpoint,
1855 struct usb_interface* intf;
1856 struct usb_host_interface *hostif;
1857 struct usb_interface_descriptor* intfd;
1858 struct usb_endpoint_descriptor* epd;
1859 int i, out_eps = 0, in_eps = 0;
1861 if (USB_ID_VENDOR(umidi->usb_id) == 0x0582)
1862 snd_usbmidi_switch_roland_altsetting(umidi);
1864 if (endpoint[0].out_ep || endpoint[0].in_ep)
1867 intf = umidi->iface;
1868 if (!intf || intf->num_altsetting < 1)
1870 hostif = intf->cur_altsetting;
1871 intfd = get_iface_desc(hostif);
1873 for (i = 0; i < intfd->bNumEndpoints; ++i) {
1874 epd = get_endpoint(hostif, i);
1875 if (!usb_endpoint_xfer_bulk(epd) &&
1876 !usb_endpoint_xfer_int(epd))
1878 if (out_eps < max_endpoints &&
1879 usb_endpoint_dir_out(epd)) {
1880 endpoint[out_eps].out_ep = usb_endpoint_num(epd);
1881 if (usb_endpoint_xfer_int(epd))
1882 endpoint[out_eps].out_interval = epd->bInterval;
1885 if (in_eps < max_endpoints &&
1886 usb_endpoint_dir_in(epd)) {
1887 endpoint[in_eps].in_ep = usb_endpoint_num(epd);
1888 if (usb_endpoint_xfer_int(epd))
1889 endpoint[in_eps].in_interval = epd->bInterval;
1893 return (out_eps || in_eps) ? 0 : -ENOENT;
1897 * Detects the endpoints for one-port-per-endpoint protocols.
1899 static int snd_usbmidi_detect_per_port_endpoints(struct snd_usb_midi* umidi,
1900 struct snd_usb_midi_endpoint_info* endpoints)
1904 err = snd_usbmidi_detect_endpoints(umidi, endpoints, MIDI_MAX_ENDPOINTS);
1905 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1906 if (endpoints[i].out_ep)
1907 endpoints[i].out_cables = 0x0001;
1908 if (endpoints[i].in_ep)
1909 endpoints[i].in_cables = 0x0001;
1915 * Detects the endpoints and ports of Yamaha devices.
1917 static int snd_usbmidi_detect_yamaha(struct snd_usb_midi* umidi,
1918 struct snd_usb_midi_endpoint_info* endpoint)
1920 struct usb_interface* intf;
1921 struct usb_host_interface *hostif;
1922 struct usb_interface_descriptor* intfd;
1925 intf = umidi->iface;
1928 hostif = intf->altsetting;
1929 intfd = get_iface_desc(hostif);
1930 if (intfd->bNumEndpoints < 1)
1934 * For each port there is one MIDI_IN/OUT_JACK descriptor, not
1935 * necessarily with any useful contents. So simply count 'em.
1937 for (cs_desc = hostif->extra;
1938 cs_desc < hostif->extra + hostif->extralen && cs_desc[0] >= 2;
1939 cs_desc += cs_desc[0]) {
1940 if (cs_desc[1] == USB_DT_CS_INTERFACE) {
1941 if (cs_desc[2] == UAC_MIDI_IN_JACK)
1942 endpoint->in_cables = (endpoint->in_cables << 1) | 1;
1943 else if (cs_desc[2] == UAC_MIDI_OUT_JACK)
1944 endpoint->out_cables = (endpoint->out_cables << 1) | 1;
1947 if (!endpoint->in_cables && !endpoint->out_cables)
1950 return snd_usbmidi_detect_endpoints(umidi, endpoint, 1);
1954 * Creates the endpoints and their ports for Midiman devices.
1956 static int snd_usbmidi_create_endpoints_midiman(struct snd_usb_midi* umidi,
1957 struct snd_usb_midi_endpoint_info* endpoint)
1959 struct snd_usb_midi_endpoint_info ep_info;
1960 struct usb_interface* intf;
1961 struct usb_host_interface *hostif;
1962 struct usb_interface_descriptor* intfd;
1963 struct usb_endpoint_descriptor* epd;
1966 intf = umidi->iface;
1969 hostif = intf->altsetting;
1970 intfd = get_iface_desc(hostif);
1972 * The various MidiSport devices have more or less random endpoint
1973 * numbers, so we have to identify the endpoints by their index in
1974 * the descriptor array, like the driver for that other OS does.
1976 * There is one interrupt input endpoint for all input ports, one
1977 * bulk output endpoint for even-numbered ports, and one for odd-
1978 * numbered ports. Both bulk output endpoints have corresponding
1979 * input bulk endpoints (at indices 1 and 3) which aren't used.
1981 if (intfd->bNumEndpoints < (endpoint->out_cables > 0x0001 ? 5 : 3)) {
1982 snd_printdd(KERN_ERR "not enough endpoints\n");
1986 epd = get_endpoint(hostif, 0);
1987 if (!usb_endpoint_dir_in(epd) || !usb_endpoint_xfer_int(epd)) {
1988 snd_printdd(KERN_ERR "endpoint[0] isn't interrupt\n");
1991 epd = get_endpoint(hostif, 2);
1992 if (!usb_endpoint_dir_out(epd) || !usb_endpoint_xfer_bulk(epd)) {
1993 snd_printdd(KERN_ERR "endpoint[2] isn't bulk output\n");
1996 if (endpoint->out_cables > 0x0001) {
1997 epd = get_endpoint(hostif, 4);
1998 if (!usb_endpoint_dir_out(epd) ||
1999 !usb_endpoint_xfer_bulk(epd)) {
2000 snd_printdd(KERN_ERR "endpoint[4] isn't bulk output\n");
2005 ep_info.out_ep = get_endpoint(hostif, 2)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
2006 ep_info.out_interval = 0;
2007 ep_info.out_cables = endpoint->out_cables & 0x5555;
2008 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info, &umidi->endpoints[0]);
2012 ep_info.in_ep = get_endpoint(hostif, 0)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
2013 ep_info.in_interval = get_endpoint(hostif, 0)->bInterval;
2014 ep_info.in_cables = endpoint->in_cables;
2015 err = snd_usbmidi_in_endpoint_create(umidi, &ep_info, &umidi->endpoints[0]);
2019 if (endpoint->out_cables > 0x0001) {
2020 ep_info.out_ep = get_endpoint(hostif, 4)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
2021 ep_info.out_cables = endpoint->out_cables & 0xaaaa;
2022 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info, &umidi->endpoints[1]);
2027 for (cable = 0; cable < 0x10; ++cable) {
2028 if (endpoint->out_cables & (1 << cable))
2029 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_OUTPUT, cable,
2030 &umidi->endpoints[cable & 1].out->ports[cable].substream);
2031 if (endpoint->in_cables & (1 << cable))
2032 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_INPUT, cable,
2033 &umidi->endpoints[0].in->ports[cable].substream);
2038 static struct snd_rawmidi_global_ops snd_usbmidi_ops = {
2039 .get_port_info = snd_usbmidi_get_port_info,
2042 static int snd_usbmidi_create_rawmidi(struct snd_usb_midi* umidi,
2043 int out_ports, int in_ports)
2045 struct snd_rawmidi *rmidi;
2048 err = snd_rawmidi_new(umidi->card, "USB MIDI",
2049 umidi->next_midi_device++,
2050 out_ports, in_ports, &rmidi);
2053 strcpy(rmidi->name, umidi->card->shortname);
2054 rmidi->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT |
2055 SNDRV_RAWMIDI_INFO_INPUT |
2056 SNDRV_RAWMIDI_INFO_DUPLEX;
2057 rmidi->ops = &snd_usbmidi_ops;
2058 rmidi->private_data = umidi;
2059 rmidi->private_free = snd_usbmidi_rawmidi_free;
2060 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_usbmidi_output_ops);
2061 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_usbmidi_input_ops);
2063 umidi->rmidi = rmidi;
2068 * Temporarily stop input.
2070 void snd_usbmidi_input_stop(struct list_head* p)
2072 struct snd_usb_midi* umidi;
2075 umidi = list_entry(p, struct snd_usb_midi, list);
2076 if (!umidi->input_running)
2078 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
2079 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
2081 for (j = 0; j < INPUT_URBS; ++j)
2082 usb_kill_urb(ep->in->urbs[j]);
2084 umidi->input_running = 0;
2087 static void snd_usbmidi_input_start_ep(struct snd_usb_midi_in_endpoint* ep)
2093 for (i = 0; i < INPUT_URBS; ++i) {
2094 struct urb* urb = ep->urbs[i];
2095 urb->dev = ep->umidi->dev;
2096 snd_usbmidi_submit_urb(urb, GFP_KERNEL);
2101 * Resume input after a call to snd_usbmidi_input_stop().
2103 void snd_usbmidi_input_start(struct list_head* p)
2105 struct snd_usb_midi* umidi;
2108 umidi = list_entry(p, struct snd_usb_midi, list);
2109 if (umidi->input_running || !umidi->opened[1])
2111 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
2112 snd_usbmidi_input_start_ep(umidi->endpoints[i].in);
2113 umidi->input_running = 1;
2117 * Creates and registers everything needed for a MIDI streaming interface.
2119 int snd_usbmidi_create(struct snd_card *card,
2120 struct usb_interface* iface,
2121 struct list_head *midi_list,
2122 const struct snd_usb_audio_quirk* quirk)
2124 struct snd_usb_midi* umidi;
2125 struct snd_usb_midi_endpoint_info endpoints[MIDI_MAX_ENDPOINTS];
2126 int out_ports, in_ports;
2129 umidi = kzalloc(sizeof(*umidi), GFP_KERNEL);
2132 umidi->dev = interface_to_usbdev(iface);
2134 umidi->iface = iface;
2135 umidi->quirk = quirk;
2136 umidi->usb_protocol_ops = &snd_usbmidi_standard_ops;
2137 init_timer(&umidi->error_timer);
2138 spin_lock_init(&umidi->disc_lock);
2139 init_rwsem(&umidi->disc_rwsem);
2140 mutex_init(&umidi->mutex);
2141 umidi->usb_id = USB_ID(le16_to_cpu(umidi->dev->descriptor.idVendor),
2142 le16_to_cpu(umidi->dev->descriptor.idProduct));
2143 umidi->error_timer.function = snd_usbmidi_error_timer;
2144 umidi->error_timer.data = (unsigned long)umidi;
2146 /* detect the endpoint(s) to use */
2147 memset(endpoints, 0, sizeof(endpoints));
2148 switch (quirk ? quirk->type : QUIRK_MIDI_STANDARD_INTERFACE) {
2149 case QUIRK_MIDI_STANDARD_INTERFACE:
2150 err = snd_usbmidi_get_ms_info(umidi, endpoints);
2151 if (umidi->usb_id == USB_ID(0x0763, 0x0150)) /* M-Audio Uno */
2152 umidi->usb_protocol_ops =
2153 &snd_usbmidi_maudio_broken_running_status_ops;
2155 case QUIRK_MIDI_US122L:
2156 umidi->usb_protocol_ops = &snd_usbmidi_122l_ops;
2158 case QUIRK_MIDI_FIXED_ENDPOINT:
2159 memcpy(&endpoints[0], quirk->data,
2160 sizeof(struct snd_usb_midi_endpoint_info));
2161 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
2163 case QUIRK_MIDI_YAMAHA:
2164 err = snd_usbmidi_detect_yamaha(umidi, &endpoints[0]);
2166 case QUIRK_MIDI_MIDIMAN:
2167 umidi->usb_protocol_ops = &snd_usbmidi_midiman_ops;
2168 memcpy(&endpoints[0], quirk->data,
2169 sizeof(struct snd_usb_midi_endpoint_info));
2172 case QUIRK_MIDI_NOVATION:
2173 umidi->usb_protocol_ops = &snd_usbmidi_novation_ops;
2174 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2176 case QUIRK_MIDI_RAW_BYTES:
2177 umidi->usb_protocol_ops = &snd_usbmidi_raw_ops;
2179 * Interface 1 contains isochronous endpoints, but with the same
2180 * numbers as in interface 0. Since it is interface 1 that the
2181 * USB core has most recently seen, these descriptors are now
2182 * associated with the endpoint numbers. This will foul up our
2183 * attempts to submit bulk/interrupt URBs to the endpoints in
2184 * interface 0, so we have to make sure that the USB core looks
2185 * again at interface 0 by calling usb_set_interface() on it.
2187 if (umidi->usb_id == USB_ID(0x07fd, 0x0001)) /* MOTU Fastlane */
2188 usb_set_interface(umidi->dev, 0, 0);
2189 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2191 case QUIRK_MIDI_EMAGIC:
2192 umidi->usb_protocol_ops = &snd_usbmidi_emagic_ops;
2193 memcpy(&endpoints[0], quirk->data,
2194 sizeof(struct snd_usb_midi_endpoint_info));
2195 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
2197 case QUIRK_MIDI_CME:
2198 umidi->usb_protocol_ops = &snd_usbmidi_cme_ops;
2199 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2201 case QUIRK_MIDI_AKAI:
2202 umidi->usb_protocol_ops = &snd_usbmidi_akai_ops;
2203 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2204 /* endpoint 1 is input-only */
2205 endpoints[1].out_cables = 0;
2207 case QUIRK_MIDI_FTDI:
2208 umidi->usb_protocol_ops = &snd_usbmidi_ftdi_ops;
2210 /* set baud rate to 31250 (48 MHz / 16 / 96) */
2211 err = usb_control_msg(umidi->dev, usb_sndctrlpipe(umidi->dev, 0),
2212 3, 0x40, 0x60, 0, NULL, 0, 1000);
2216 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2218 case QUIRK_MIDI_CH345:
2219 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2222 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
2231 /* create rawmidi device */
2234 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
2235 out_ports += hweight16(endpoints[i].out_cables);
2236 in_ports += hweight16(endpoints[i].in_cables);
2238 err = snd_usbmidi_create_rawmidi(umidi, out_ports, in_ports);
2244 /* create endpoint/port structures */
2245 if (quirk && quirk->type == QUIRK_MIDI_MIDIMAN)
2246 err = snd_usbmidi_create_endpoints_midiman(umidi, &endpoints[0]);
2248 err = snd_usbmidi_create_endpoints(umidi, endpoints);
2250 snd_usbmidi_free(umidi);
2254 usb_autopm_get_interface_no_resume(umidi->iface);
2256 list_add_tail(&umidi->list, midi_list);
2260 EXPORT_SYMBOL(snd_usbmidi_create);
2261 EXPORT_SYMBOL(snd_usbmidi_input_stop);
2262 EXPORT_SYMBOL(snd_usbmidi_input_start);
2263 EXPORT_SYMBOL(snd_usbmidi_disconnect);