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 hub_wq 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;
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 const 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 work_struct work;
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;
183 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint *ep);
185 static const uint8_t snd_usbmidi_cin_length[] = {
186 0, 0, 2, 3, 3, 1, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1
190 * Submits the URB, with error handling.
192 static int snd_usbmidi_submit_urb(struct urb *urb, gfp_t flags)
194 int err = usb_submit_urb(urb, flags);
195 if (err < 0 && err != -ENODEV)
196 dev_err(&urb->dev->dev, "usb_submit_urb: %d\n", err);
201 * Error handling for URB completion functions.
203 static int snd_usbmidi_urb_error(const struct urb *urb)
205 switch (urb->status) {
206 /* manually unlinked, or device gone */
212 /* errors that might occur during unplugging */
218 dev_err(&urb->dev->dev, "urb status %d\n", urb->status);
219 return 0; /* continue */
224 * Receives a chunk of MIDI data.
226 static void snd_usbmidi_input_data(struct snd_usb_midi_in_endpoint *ep,
227 int portidx, uint8_t *data, int length)
229 struct usbmidi_in_port *port = &ep->ports[portidx];
231 if (!port->substream) {
232 dev_dbg(&ep->umidi->dev->dev, "unexpected port %d!\n", portidx);
235 if (!test_bit(port->substream->number, &ep->umidi->input_triggered))
237 snd_rawmidi_receive(port->substream, data, length);
241 static void dump_urb(const char *type, const u8 *data, int length)
243 snd_printk(KERN_DEBUG "%s packet: [", type);
244 for (; length > 0; ++data, --length)
245 printk(KERN_CONT " %02x", *data);
246 printk(KERN_CONT " ]\n");
249 #define dump_urb(type, data, length) /* nothing */
253 * Processes the data read from the device.
255 static void snd_usbmidi_in_urb_complete(struct urb *urb)
257 struct snd_usb_midi_in_endpoint *ep = urb->context;
259 if (urb->status == 0) {
260 dump_urb("received", urb->transfer_buffer, urb->actual_length);
261 ep->umidi->usb_protocol_ops->input(ep, urb->transfer_buffer,
264 int err = snd_usbmidi_urb_error(urb);
266 if (err != -ENODEV) {
267 ep->error_resubmit = 1;
268 mod_timer(&ep->umidi->error_timer,
269 jiffies + ERROR_DELAY_JIFFIES);
275 urb->dev = ep->umidi->dev;
276 snd_usbmidi_submit_urb(urb, GFP_ATOMIC);
279 static void snd_usbmidi_out_urb_complete(struct urb *urb)
281 struct out_urb_context *context = urb->context;
282 struct snd_usb_midi_out_endpoint *ep = context->ep;
283 unsigned int urb_index;
286 spin_lock_irqsave(&ep->buffer_lock, flags);
287 urb_index = context - ep->urbs;
288 ep->active_urbs &= ~(1 << urb_index);
289 if (unlikely(ep->drain_urbs)) {
290 ep->drain_urbs &= ~(1 << urb_index);
291 wake_up(&ep->drain_wait);
293 spin_unlock_irqrestore(&ep->buffer_lock, flags);
294 if (urb->status < 0) {
295 int err = snd_usbmidi_urb_error(urb);
298 mod_timer(&ep->umidi->error_timer,
299 jiffies + ERROR_DELAY_JIFFIES);
303 snd_usbmidi_do_output(ep);
307 * This is called when some data should be transferred to the device
308 * (from one or more substreams).
310 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint *ep)
312 unsigned int urb_index;
316 spin_lock_irqsave(&ep->buffer_lock, flags);
317 if (ep->umidi->disconnected) {
318 spin_unlock_irqrestore(&ep->buffer_lock, flags);
322 urb_index = ep->next_urb;
324 if (!(ep->active_urbs & (1 << urb_index))) {
325 urb = ep->urbs[urb_index].urb;
326 urb->transfer_buffer_length = 0;
327 ep->umidi->usb_protocol_ops->output(ep, urb);
328 if (urb->transfer_buffer_length == 0)
331 dump_urb("sending", urb->transfer_buffer,
332 urb->transfer_buffer_length);
333 urb->dev = ep->umidi->dev;
334 if (snd_usbmidi_submit_urb(urb, GFP_ATOMIC) < 0)
336 ep->active_urbs |= 1 << urb_index;
338 if (++urb_index >= OUTPUT_URBS)
340 if (urb_index == ep->next_urb)
343 ep->next_urb = urb_index;
344 spin_unlock_irqrestore(&ep->buffer_lock, flags);
347 static void snd_usbmidi_out_work(struct work_struct *work)
349 struct snd_usb_midi_out_endpoint *ep =
350 container_of(work, struct snd_usb_midi_out_endpoint, work);
352 snd_usbmidi_do_output(ep);
355 /* called after transfers had been interrupted due to some USB error */
356 static void snd_usbmidi_error_timer(struct timer_list *t)
358 struct snd_usb_midi *umidi = from_timer(umidi, t, error_timer);
361 spin_lock(&umidi->disc_lock);
362 if (umidi->disconnected) {
363 spin_unlock(&umidi->disc_lock);
366 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
367 struct snd_usb_midi_in_endpoint *in = umidi->endpoints[i].in;
368 if (in && in->error_resubmit) {
369 in->error_resubmit = 0;
370 for (j = 0; j < INPUT_URBS; ++j) {
371 if (atomic_read(&in->urbs[j]->use_count))
373 in->urbs[j]->dev = umidi->dev;
374 snd_usbmidi_submit_urb(in->urbs[j], GFP_ATOMIC);
377 if (umidi->endpoints[i].out)
378 snd_usbmidi_do_output(umidi->endpoints[i].out);
380 spin_unlock(&umidi->disc_lock);
383 /* helper function to send static data that may not DMA-able */
384 static int send_bulk_static_data(struct snd_usb_midi_out_endpoint *ep,
385 const void *data, int len)
388 void *buf = kmemdup(data, len, GFP_KERNEL);
391 dump_urb("sending", buf, len);
393 err = usb_bulk_msg(ep->umidi->dev, ep->urbs[0].urb->pipe,
394 buf, len, NULL, 250);
400 * Standard USB MIDI protocol: see the spec.
401 * Midiman protocol: like the standard protocol, but the control byte is the
402 * fourth byte in each packet, and uses length instead of CIN.
405 static void snd_usbmidi_standard_input(struct snd_usb_midi_in_endpoint *ep,
406 uint8_t *buffer, int buffer_length)
410 for (i = 0; i + 3 < buffer_length; i += 4)
411 if (buffer[i] != 0) {
412 int cable = buffer[i] >> 4;
413 int length = snd_usbmidi_cin_length[buffer[i] & 0x0f];
414 snd_usbmidi_input_data(ep, cable, &buffer[i + 1],
419 static void snd_usbmidi_midiman_input(struct snd_usb_midi_in_endpoint *ep,
420 uint8_t *buffer, int buffer_length)
424 for (i = 0; i + 3 < buffer_length; i += 4)
425 if (buffer[i + 3] != 0) {
426 int port = buffer[i + 3] >> 4;
427 int length = buffer[i + 3] & 3;
428 snd_usbmidi_input_data(ep, port, &buffer[i], length);
433 * Buggy M-Audio device: running status on input results in a packet that has
434 * the data bytes but not the status byte and that is marked with CIN 4.
436 static void snd_usbmidi_maudio_broken_running_status_input(
437 struct snd_usb_midi_in_endpoint *ep,
438 uint8_t *buffer, int buffer_length)
442 for (i = 0; i + 3 < buffer_length; i += 4)
443 if (buffer[i] != 0) {
444 int cable = buffer[i] >> 4;
445 u8 cin = buffer[i] & 0x0f;
446 struct usbmidi_in_port *port = &ep->ports[cable];
449 length = snd_usbmidi_cin_length[cin];
450 if (cin == 0xf && buffer[i + 1] >= 0xf8)
451 ; /* realtime msg: no running status change */
452 else if (cin >= 0x8 && cin <= 0xe)
454 port->running_status_length = length - 1;
455 else if (cin == 0x4 &&
456 port->running_status_length != 0 &&
457 buffer[i + 1] < 0x80)
458 /* CIN 4 that is not a SysEx */
459 length = port->running_status_length;
462 * All other msgs cannot begin running status.
463 * (A channel msg sent as two or three CIN 0xF
464 * packets could in theory, but this device
465 * doesn't use this format.)
467 port->running_status_length = 0;
468 snd_usbmidi_input_data(ep, cable, &buffer[i + 1],
474 * QinHeng CH345 is buggy: every second packet inside a SysEx has not CIN 4
475 * but the previously seen CIN, but still with three data bytes.
477 static void ch345_broken_sysex_input(struct snd_usb_midi_in_endpoint *ep,
478 uint8_t *buffer, int buffer_length)
480 unsigned int i, cin, length;
482 for (i = 0; i + 3 < buffer_length; i += 4) {
483 if (buffer[i] == 0 && i > 0)
485 cin = buffer[i] & 0x0f;
487 cin == ep->last_cin &&
488 (buffer[i + 1 + (cin == 0x6)] & 0x80) == 0)
491 if (buffer[i + 1] == 0x90) {
493 * Either a corrupted running status or a real note-on
494 * message; impossible to detect reliably.
498 length = snd_usbmidi_cin_length[cin];
499 snd_usbmidi_input_data(ep, 0, &buffer[i + 1], length);
500 ep->in_sysex = cin == 0x4;
507 * CME protocol: like the standard protocol, but SysEx commands are sent as a
508 * single USB packet preceded by a 0x0F byte.
510 static void snd_usbmidi_cme_input(struct snd_usb_midi_in_endpoint *ep,
511 uint8_t *buffer, int buffer_length)
513 if (buffer_length < 2 || (buffer[0] & 0x0f) != 0x0f)
514 snd_usbmidi_standard_input(ep, buffer, buffer_length);
516 snd_usbmidi_input_data(ep, buffer[0] >> 4,
517 &buffer[1], buffer_length - 1);
521 * Adds one USB MIDI packet to the output buffer.
523 static void snd_usbmidi_output_standard_packet(struct urb *urb, uint8_t p0,
524 uint8_t p1, uint8_t p2,
529 (uint8_t *)urb->transfer_buffer + urb->transfer_buffer_length;
534 urb->transfer_buffer_length += 4;
538 * Adds one Midiman packet to the output buffer.
540 static void snd_usbmidi_output_midiman_packet(struct urb *urb, uint8_t p0,
541 uint8_t p1, uint8_t p2,
546 (uint8_t *)urb->transfer_buffer + urb->transfer_buffer_length;
550 buf[3] = (p0 & 0xf0) | snd_usbmidi_cin_length[p0 & 0x0f];
551 urb->transfer_buffer_length += 4;
555 * Converts MIDI commands to USB MIDI packets.
557 static void snd_usbmidi_transmit_byte(struct usbmidi_out_port *port,
558 uint8_t b, struct urb *urb)
560 uint8_t p0 = port->cable;
561 void (*output_packet)(struct urb*, uint8_t, uint8_t, uint8_t, uint8_t) =
562 port->ep->umidi->usb_protocol_ops->output_packet;
565 output_packet(urb, p0 | 0x0f, b, 0, 0);
566 } else if (b >= 0xf0) {
570 port->state = STATE_SYSEX_1;
575 port->state = STATE_1PARAM;
579 port->state = STATE_2PARAM_1;
583 port->state = STATE_UNKNOWN;
586 output_packet(urb, p0 | 0x05, 0xf6, 0, 0);
587 port->state = STATE_UNKNOWN;
590 switch (port->state) {
592 output_packet(urb, p0 | 0x05, 0xf7, 0, 0);
595 output_packet(urb, p0 | 0x06, port->data[0],
599 output_packet(urb, p0 | 0x07, port->data[0],
600 port->data[1], 0xf7);
603 port->state = STATE_UNKNOWN;
606 } else if (b >= 0x80) {
608 if (b >= 0xc0 && b <= 0xdf)
609 port->state = STATE_1PARAM;
611 port->state = STATE_2PARAM_1;
612 } else { /* b < 0x80 */
613 switch (port->state) {
615 if (port->data[0] < 0xf0) {
616 p0 |= port->data[0] >> 4;
619 port->state = STATE_UNKNOWN;
621 output_packet(urb, p0, port->data[0], b, 0);
625 port->state = STATE_2PARAM_2;
628 if (port->data[0] < 0xf0) {
629 p0 |= port->data[0] >> 4;
630 port->state = STATE_2PARAM_1;
633 port->state = STATE_UNKNOWN;
635 output_packet(urb, p0, port->data[0], port->data[1], b);
639 port->state = STATE_SYSEX_1;
643 port->state = STATE_SYSEX_2;
646 output_packet(urb, p0 | 0x04, port->data[0],
648 port->state = STATE_SYSEX_0;
654 static void snd_usbmidi_standard_output(struct snd_usb_midi_out_endpoint *ep,
659 /* FIXME: lower-numbered ports can starve higher-numbered ports */
660 for (p = 0; p < 0x10; ++p) {
661 struct usbmidi_out_port *port = &ep->ports[p];
664 while (urb->transfer_buffer_length + 3 < ep->max_transfer) {
666 if (snd_rawmidi_transmit(port->substream, &b, 1) != 1) {
670 snd_usbmidi_transmit_byte(port, b, urb);
675 static const struct usb_protocol_ops snd_usbmidi_standard_ops = {
676 .input = snd_usbmidi_standard_input,
677 .output = snd_usbmidi_standard_output,
678 .output_packet = snd_usbmidi_output_standard_packet,
681 static const struct usb_protocol_ops snd_usbmidi_midiman_ops = {
682 .input = snd_usbmidi_midiman_input,
683 .output = snd_usbmidi_standard_output,
684 .output_packet = snd_usbmidi_output_midiman_packet,
688 struct usb_protocol_ops snd_usbmidi_maudio_broken_running_status_ops = {
689 .input = snd_usbmidi_maudio_broken_running_status_input,
690 .output = snd_usbmidi_standard_output,
691 .output_packet = snd_usbmidi_output_standard_packet,
694 static const struct usb_protocol_ops snd_usbmidi_cme_ops = {
695 .input = snd_usbmidi_cme_input,
696 .output = snd_usbmidi_standard_output,
697 .output_packet = snd_usbmidi_output_standard_packet,
700 static const struct usb_protocol_ops snd_usbmidi_ch345_broken_sysex_ops = {
701 .input = ch345_broken_sysex_input,
702 .output = snd_usbmidi_standard_output,
703 .output_packet = snd_usbmidi_output_standard_packet,
707 * AKAI MPD16 protocol:
709 * For control port (endpoint 1):
710 * ==============================
711 * One or more chunks consisting of first byte of (0x10 | msg_len) and then a
712 * SysEx message (msg_len=9 bytes long).
714 * For data port (endpoint 2):
715 * ===========================
716 * One or more chunks consisting of first byte of (0x20 | msg_len) and then a
717 * MIDI message (msg_len bytes long)
719 * Messages sent: Active Sense, Note On, Poly Pressure, Control Change.
721 static void snd_usbmidi_akai_input(struct snd_usb_midi_in_endpoint *ep,
722 uint8_t *buffer, int buffer_length)
724 unsigned int pos = 0;
725 unsigned int len = (unsigned int)buffer_length;
727 unsigned int port = (buffer[pos] >> 4) - 1;
728 unsigned int msg_len = buffer[pos] & 0x0f;
730 if (pos + msg_len <= len && port < 2)
731 snd_usbmidi_input_data(ep, 0, &buffer[pos], msg_len);
736 #define MAX_AKAI_SYSEX_LEN 9
738 static void snd_usbmidi_akai_output(struct snd_usb_midi_out_endpoint *ep,
742 int pos, end, count, buf_end;
743 uint8_t tmp[MAX_AKAI_SYSEX_LEN];
744 struct snd_rawmidi_substream *substream = ep->ports[0].substream;
746 if (!ep->ports[0].active)
749 msg = urb->transfer_buffer + urb->transfer_buffer_length;
750 buf_end = ep->max_transfer - MAX_AKAI_SYSEX_LEN - 1;
752 /* only try adding more data when there's space for at least 1 SysEx */
753 while (urb->transfer_buffer_length < buf_end) {
754 count = snd_rawmidi_transmit_peek(substream,
755 tmp, MAX_AKAI_SYSEX_LEN);
757 ep->ports[0].active = 0;
760 /* try to skip non-SysEx data */
761 for (pos = 0; pos < count && tmp[pos] != 0xF0; pos++)
765 snd_rawmidi_transmit_ack(substream, pos);
769 /* look for the start or end marker */
770 for (end = 1; end < count && tmp[end] < 0xF0; end++)
773 /* next SysEx started before the end of current one */
774 if (end < count && tmp[end] == 0xF0) {
775 /* it's incomplete - drop it */
776 snd_rawmidi_transmit_ack(substream, end);
780 if (end < count && tmp[end] == 0xF7) {
781 /* queue it, ack it, and get the next one */
783 msg[0] = 0x10 | count;
784 memcpy(&msg[1], tmp, count);
785 snd_rawmidi_transmit_ack(substream, count);
786 urb->transfer_buffer_length += count + 1;
790 /* less than 9 bytes and no end byte - wait for more */
791 if (count < MAX_AKAI_SYSEX_LEN) {
792 ep->ports[0].active = 0;
795 /* 9 bytes and no end marker in sight - malformed, skip it */
796 snd_rawmidi_transmit_ack(substream, count);
800 static const struct usb_protocol_ops snd_usbmidi_akai_ops = {
801 .input = snd_usbmidi_akai_input,
802 .output = snd_usbmidi_akai_output,
806 * Novation USB MIDI protocol: number of data bytes is in the first byte
807 * (when receiving) (+1!) or in the second byte (when sending); data begins
811 static void snd_usbmidi_novation_input(struct snd_usb_midi_in_endpoint *ep,
812 uint8_t *buffer, int buffer_length)
814 if (buffer_length < 2 || !buffer[0] || buffer_length < buffer[0] + 1)
816 snd_usbmidi_input_data(ep, 0, &buffer[2], buffer[0] - 1);
819 static void snd_usbmidi_novation_output(struct snd_usb_midi_out_endpoint *ep,
822 uint8_t *transfer_buffer;
825 if (!ep->ports[0].active)
827 transfer_buffer = urb->transfer_buffer;
828 count = snd_rawmidi_transmit(ep->ports[0].substream,
830 ep->max_transfer - 2);
832 ep->ports[0].active = 0;
835 transfer_buffer[0] = 0;
836 transfer_buffer[1] = count;
837 urb->transfer_buffer_length = 2 + count;
840 static const struct usb_protocol_ops snd_usbmidi_novation_ops = {
841 .input = snd_usbmidi_novation_input,
842 .output = snd_usbmidi_novation_output,
846 * "raw" protocol: just move raw MIDI bytes from/to the endpoint
849 static void snd_usbmidi_raw_input(struct snd_usb_midi_in_endpoint *ep,
850 uint8_t *buffer, int buffer_length)
852 snd_usbmidi_input_data(ep, 0, buffer, buffer_length);
855 static void snd_usbmidi_raw_output(struct snd_usb_midi_out_endpoint *ep,
860 if (!ep->ports[0].active)
862 count = snd_rawmidi_transmit(ep->ports[0].substream,
863 urb->transfer_buffer,
866 ep->ports[0].active = 0;
869 urb->transfer_buffer_length = count;
872 static const struct usb_protocol_ops snd_usbmidi_raw_ops = {
873 .input = snd_usbmidi_raw_input,
874 .output = snd_usbmidi_raw_output,
878 * FTDI protocol: raw MIDI bytes, but input packets have two modem status bytes.
881 static void snd_usbmidi_ftdi_input(struct snd_usb_midi_in_endpoint *ep,
882 uint8_t *buffer, int buffer_length)
884 if (buffer_length > 2)
885 snd_usbmidi_input_data(ep, 0, buffer + 2, buffer_length - 2);
888 static const struct usb_protocol_ops snd_usbmidi_ftdi_ops = {
889 .input = snd_usbmidi_ftdi_input,
890 .output = snd_usbmidi_raw_output,
893 static void snd_usbmidi_us122l_input(struct snd_usb_midi_in_endpoint *ep,
894 uint8_t *buffer, int buffer_length)
896 if (buffer_length != 9)
899 while (buffer_length && buffer[buffer_length - 1] == 0xFD)
902 snd_usbmidi_input_data(ep, 0, buffer, buffer_length);
905 static void snd_usbmidi_us122l_output(struct snd_usb_midi_out_endpoint *ep,
910 if (!ep->ports[0].active)
912 switch (snd_usb_get_speed(ep->umidi->dev)) {
914 case USB_SPEED_SUPER:
915 case USB_SPEED_SUPER_PLUS:
921 count = snd_rawmidi_transmit(ep->ports[0].substream,
922 urb->transfer_buffer,
925 ep->ports[0].active = 0;
929 memset(urb->transfer_buffer + count, 0xFD, ep->max_transfer - count);
930 urb->transfer_buffer_length = ep->max_transfer;
933 static const struct usb_protocol_ops snd_usbmidi_122l_ops = {
934 .input = snd_usbmidi_us122l_input,
935 .output = snd_usbmidi_us122l_output,
939 * Emagic USB MIDI protocol: raw MIDI with "F5 xx" port switching.
942 static void snd_usbmidi_emagic_init_out(struct snd_usb_midi_out_endpoint *ep)
944 static const u8 init_data[] = {
945 /* initialization magic: "get version" */
947 0x00, 0x20, 0x31, /* Emagic */
949 0x0b, /* version number request */
950 0x00, /* command version */
951 0x00, /* EEPROM, box 0 */
954 send_bulk_static_data(ep, init_data, sizeof(init_data));
955 /* while we're at it, pour on more magic */
956 send_bulk_static_data(ep, init_data, sizeof(init_data));
959 static void snd_usbmidi_emagic_finish_out(struct snd_usb_midi_out_endpoint *ep)
961 static const u8 finish_data[] = {
962 /* switch to patch mode with last preset */
964 0x00, 0x20, 0x31, /* Emagic */
966 0x10, /* patch switch command */
967 0x00, /* command version */
968 0x7f, /* to all boxes */
969 0x40, /* last preset in EEPROM */
972 send_bulk_static_data(ep, finish_data, sizeof(finish_data));
975 static void snd_usbmidi_emagic_input(struct snd_usb_midi_in_endpoint *ep,
976 uint8_t *buffer, int buffer_length)
980 /* FF indicates end of valid data */
981 for (i = 0; i < buffer_length; ++i)
982 if (buffer[i] == 0xff) {
987 /* handle F5 at end of last buffer */
991 while (buffer_length > 0) {
992 /* determine size of data until next F5 */
993 for (i = 0; i < buffer_length; ++i)
994 if (buffer[i] == 0xf5)
996 snd_usbmidi_input_data(ep, ep->current_port, buffer, i);
1000 if (buffer_length <= 0)
1002 /* assert(buffer[0] == 0xf5); */
1008 if (buffer_length <= 0)
1010 if (buffer[0] < 0x80) {
1011 ep->current_port = (buffer[0] - 1) & 15;
1019 static void snd_usbmidi_emagic_output(struct snd_usb_midi_out_endpoint *ep,
1022 int port0 = ep->current_port;
1023 uint8_t *buf = urb->transfer_buffer;
1024 int buf_free = ep->max_transfer;
1027 for (i = 0; i < 0x10; ++i) {
1028 /* round-robin, starting at the last current port */
1029 int portnum = (port0 + i) & 15;
1030 struct usbmidi_out_port *port = &ep->ports[portnum];
1034 if (snd_rawmidi_transmit_peek(port->substream, buf, 1) != 1) {
1039 if (portnum != ep->current_port) {
1042 ep->current_port = portnum;
1044 buf[1] = (portnum + 1) & 15;
1051 length = snd_rawmidi_transmit(port->substream, buf, buf_free);
1059 if (buf_free < ep->max_transfer && buf_free > 0) {
1063 urb->transfer_buffer_length = ep->max_transfer - buf_free;
1066 static const struct usb_protocol_ops snd_usbmidi_emagic_ops = {
1067 .input = snd_usbmidi_emagic_input,
1068 .output = snd_usbmidi_emagic_output,
1069 .init_out_endpoint = snd_usbmidi_emagic_init_out,
1070 .finish_out_endpoint = snd_usbmidi_emagic_finish_out,
1074 static void update_roland_altsetting(struct snd_usb_midi *umidi)
1076 struct usb_interface *intf;
1077 struct usb_host_interface *hostif;
1078 struct usb_interface_descriptor *intfd;
1081 intf = umidi->iface;
1082 is_light_load = intf->cur_altsetting != intf->altsetting;
1083 if (umidi->roland_load_ctl->private_value == is_light_load)
1085 hostif = &intf->altsetting[umidi->roland_load_ctl->private_value];
1086 intfd = get_iface_desc(hostif);
1087 snd_usbmidi_input_stop(&umidi->list);
1088 usb_set_interface(umidi->dev, intfd->bInterfaceNumber,
1089 intfd->bAlternateSetting);
1090 snd_usbmidi_input_start(&umidi->list);
1093 static int substream_open(struct snd_rawmidi_substream *substream, int dir,
1096 struct snd_usb_midi *umidi = substream->rmidi->private_data;
1097 struct snd_kcontrol *ctl;
1099 down_read(&umidi->disc_rwsem);
1100 if (umidi->disconnected) {
1101 up_read(&umidi->disc_rwsem);
1102 return open ? -ENODEV : 0;
1105 mutex_lock(&umidi->mutex);
1107 if (!umidi->opened[0] && !umidi->opened[1]) {
1108 if (umidi->roland_load_ctl) {
1109 ctl = umidi->roland_load_ctl;
1110 ctl->vd[0].access |=
1111 SNDRV_CTL_ELEM_ACCESS_INACTIVE;
1112 snd_ctl_notify(umidi->card,
1113 SNDRV_CTL_EVENT_MASK_INFO, &ctl->id);
1114 update_roland_altsetting(umidi);
1117 umidi->opened[dir]++;
1118 if (umidi->opened[1])
1119 snd_usbmidi_input_start(&umidi->list);
1121 umidi->opened[dir]--;
1122 if (!umidi->opened[1])
1123 snd_usbmidi_input_stop(&umidi->list);
1124 if (!umidi->opened[0] && !umidi->opened[1]) {
1125 if (umidi->roland_load_ctl) {
1126 ctl = umidi->roland_load_ctl;
1127 ctl->vd[0].access &=
1128 ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
1129 snd_ctl_notify(umidi->card,
1130 SNDRV_CTL_EVENT_MASK_INFO, &ctl->id);
1134 mutex_unlock(&umidi->mutex);
1135 up_read(&umidi->disc_rwsem);
1139 static int snd_usbmidi_output_open(struct snd_rawmidi_substream *substream)
1141 struct snd_usb_midi *umidi = substream->rmidi->private_data;
1142 struct usbmidi_out_port *port = NULL;
1145 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
1146 if (umidi->endpoints[i].out)
1147 for (j = 0; j < 0x10; ++j)
1148 if (umidi->endpoints[i].out->ports[j].substream == substream) {
1149 port = &umidi->endpoints[i].out->ports[j];
1155 substream->runtime->private_data = port;
1156 port->state = STATE_UNKNOWN;
1157 return substream_open(substream, 0, 1);
1160 static int snd_usbmidi_output_close(struct snd_rawmidi_substream *substream)
1162 struct usbmidi_out_port *port = substream->runtime->private_data;
1164 cancel_work_sync(&port->ep->work);
1165 return substream_open(substream, 0, 0);
1168 static void snd_usbmidi_output_trigger(struct snd_rawmidi_substream *substream,
1171 struct usbmidi_out_port *port =
1172 (struct usbmidi_out_port *)substream->runtime->private_data;
1176 if (port->ep->umidi->disconnected) {
1177 /* gobble up remaining bytes to prevent wait in
1178 * snd_rawmidi_drain_output */
1179 snd_rawmidi_proceed(substream);
1182 queue_work(system_highpri_wq, &port->ep->work);
1186 static void snd_usbmidi_output_drain(struct snd_rawmidi_substream *substream)
1188 struct usbmidi_out_port *port = substream->runtime->private_data;
1189 struct snd_usb_midi_out_endpoint *ep = port->ep;
1190 unsigned int drain_urbs;
1192 long timeout = msecs_to_jiffies(50);
1194 if (ep->umidi->disconnected)
1197 * The substream buffer is empty, but some data might still be in the
1198 * currently active URBs, so we have to wait for those to complete.
1200 spin_lock_irq(&ep->buffer_lock);
1201 drain_urbs = ep->active_urbs;
1203 ep->drain_urbs |= drain_urbs;
1205 prepare_to_wait(&ep->drain_wait, &wait,
1206 TASK_UNINTERRUPTIBLE);
1207 spin_unlock_irq(&ep->buffer_lock);
1208 timeout = schedule_timeout(timeout);
1209 spin_lock_irq(&ep->buffer_lock);
1210 drain_urbs &= ep->drain_urbs;
1211 } while (drain_urbs && timeout);
1212 finish_wait(&ep->drain_wait, &wait);
1215 spin_unlock_irq(&ep->buffer_lock);
1218 static int snd_usbmidi_input_open(struct snd_rawmidi_substream *substream)
1220 return substream_open(substream, 1, 1);
1223 static int snd_usbmidi_input_close(struct snd_rawmidi_substream *substream)
1225 return substream_open(substream, 1, 0);
1228 static void snd_usbmidi_input_trigger(struct snd_rawmidi_substream *substream,
1231 struct snd_usb_midi *umidi = substream->rmidi->private_data;
1234 set_bit(substream->number, &umidi->input_triggered);
1236 clear_bit(substream->number, &umidi->input_triggered);
1239 static const struct snd_rawmidi_ops snd_usbmidi_output_ops = {
1240 .open = snd_usbmidi_output_open,
1241 .close = snd_usbmidi_output_close,
1242 .trigger = snd_usbmidi_output_trigger,
1243 .drain = snd_usbmidi_output_drain,
1246 static const struct snd_rawmidi_ops snd_usbmidi_input_ops = {
1247 .open = snd_usbmidi_input_open,
1248 .close = snd_usbmidi_input_close,
1249 .trigger = snd_usbmidi_input_trigger
1252 static void free_urb_and_buffer(struct snd_usb_midi *umidi, struct urb *urb,
1253 unsigned int buffer_length)
1255 usb_free_coherent(umidi->dev, buffer_length,
1256 urb->transfer_buffer, urb->transfer_dma);
1261 * Frees an input endpoint.
1262 * May be called when ep hasn't been initialized completely.
1264 static void snd_usbmidi_in_endpoint_delete(struct snd_usb_midi_in_endpoint *ep)
1268 for (i = 0; i < INPUT_URBS; ++i)
1270 free_urb_and_buffer(ep->umidi, ep->urbs[i],
1271 ep->urbs[i]->transfer_buffer_length);
1276 * Creates an input endpoint.
1278 static int snd_usbmidi_in_endpoint_create(struct snd_usb_midi *umidi,
1279 struct snd_usb_midi_endpoint_info *ep_info,
1280 struct snd_usb_midi_endpoint *rep)
1282 struct snd_usb_midi_in_endpoint *ep;
1290 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1295 for (i = 0; i < INPUT_URBS; ++i) {
1296 ep->urbs[i] = usb_alloc_urb(0, GFP_KERNEL);
1302 if (ep_info->in_interval)
1303 pipe = usb_rcvintpipe(umidi->dev, ep_info->in_ep);
1305 pipe = usb_rcvbulkpipe(umidi->dev, ep_info->in_ep);
1306 length = usb_maxpacket(umidi->dev, pipe, 0);
1307 for (i = 0; i < INPUT_URBS; ++i) {
1308 buffer = usb_alloc_coherent(umidi->dev, length, GFP_KERNEL,
1309 &ep->urbs[i]->transfer_dma);
1314 if (ep_info->in_interval)
1315 usb_fill_int_urb(ep->urbs[i], umidi->dev,
1316 pipe, buffer, length,
1317 snd_usbmidi_in_urb_complete,
1318 ep, ep_info->in_interval);
1320 usb_fill_bulk_urb(ep->urbs[i], umidi->dev,
1321 pipe, buffer, length,
1322 snd_usbmidi_in_urb_complete, ep);
1323 ep->urbs[i]->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1324 err = usb_urb_ep_type_check(ep->urbs[i]);
1326 dev_err(&umidi->dev->dev, "invalid MIDI in EP %x\n",
1336 snd_usbmidi_in_endpoint_delete(ep);
1341 * Frees an output endpoint.
1342 * May be called when ep hasn't been initialized completely.
1344 static void snd_usbmidi_out_endpoint_clear(struct snd_usb_midi_out_endpoint *ep)
1348 for (i = 0; i < OUTPUT_URBS; ++i)
1349 if (ep->urbs[i].urb) {
1350 free_urb_and_buffer(ep->umidi, ep->urbs[i].urb,
1352 ep->urbs[i].urb = NULL;
1356 static void snd_usbmidi_out_endpoint_delete(struct snd_usb_midi_out_endpoint *ep)
1358 snd_usbmidi_out_endpoint_clear(ep);
1363 * Creates an output endpoint, and initializes output ports.
1365 static int snd_usbmidi_out_endpoint_create(struct snd_usb_midi *umidi,
1366 struct snd_usb_midi_endpoint_info *ep_info,
1367 struct snd_usb_midi_endpoint *rep)
1369 struct snd_usb_midi_out_endpoint *ep;
1376 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1381 for (i = 0; i < OUTPUT_URBS; ++i) {
1382 ep->urbs[i].urb = usb_alloc_urb(0, GFP_KERNEL);
1383 if (!ep->urbs[i].urb) {
1387 ep->urbs[i].ep = ep;
1389 if (ep_info->out_interval)
1390 pipe = usb_sndintpipe(umidi->dev, ep_info->out_ep);
1392 pipe = usb_sndbulkpipe(umidi->dev, ep_info->out_ep);
1393 switch (umidi->usb_id) {
1395 ep->max_transfer = usb_maxpacket(umidi->dev, pipe, 1);
1398 * Various chips declare a packet size larger than 4 bytes, but
1399 * do not actually work with larger packets:
1401 case USB_ID(0x0a67, 0x5011): /* Medeli DD305 */
1402 case USB_ID(0x0a92, 0x1020): /* ESI M4U */
1403 case USB_ID(0x1430, 0x474b): /* RedOctane GH MIDI INTERFACE */
1404 case USB_ID(0x15ca, 0x0101): /* Textech USB Midi Cable */
1405 case USB_ID(0x15ca, 0x1806): /* Textech USB Midi Cable */
1406 case USB_ID(0x1a86, 0x752d): /* QinHeng CH345 "USB2.0-MIDI" */
1407 case USB_ID(0xfc08, 0x0101): /* Unknown vendor Cable */
1408 ep->max_transfer = 4;
1411 * Some devices only work with 9 bytes packet size:
1413 case USB_ID(0x0644, 0x800e): /* Tascam US-122L */
1414 case USB_ID(0x0644, 0x800f): /* Tascam US-144 */
1415 ep->max_transfer = 9;
1418 for (i = 0; i < OUTPUT_URBS; ++i) {
1419 buffer = usb_alloc_coherent(umidi->dev,
1420 ep->max_transfer, GFP_KERNEL,
1421 &ep->urbs[i].urb->transfer_dma);
1426 if (ep_info->out_interval)
1427 usb_fill_int_urb(ep->urbs[i].urb, umidi->dev,
1428 pipe, buffer, ep->max_transfer,
1429 snd_usbmidi_out_urb_complete,
1430 &ep->urbs[i], ep_info->out_interval);
1432 usb_fill_bulk_urb(ep->urbs[i].urb, umidi->dev,
1433 pipe, buffer, ep->max_transfer,
1434 snd_usbmidi_out_urb_complete,
1436 err = usb_urb_ep_type_check(ep->urbs[i].urb);
1438 dev_err(&umidi->dev->dev, "invalid MIDI out EP %x\n",
1442 ep->urbs[i].urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1445 spin_lock_init(&ep->buffer_lock);
1446 INIT_WORK(&ep->work, snd_usbmidi_out_work);
1447 init_waitqueue_head(&ep->drain_wait);
1449 for (i = 0; i < 0x10; ++i)
1450 if (ep_info->out_cables & (1 << i)) {
1451 ep->ports[i].ep = ep;
1452 ep->ports[i].cable = i << 4;
1455 if (umidi->usb_protocol_ops->init_out_endpoint)
1456 umidi->usb_protocol_ops->init_out_endpoint(ep);
1462 snd_usbmidi_out_endpoint_delete(ep);
1469 static void snd_usbmidi_free(struct snd_usb_midi *umidi)
1473 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1474 struct snd_usb_midi_endpoint *ep = &umidi->endpoints[i];
1476 snd_usbmidi_out_endpoint_delete(ep->out);
1478 snd_usbmidi_in_endpoint_delete(ep->in);
1480 mutex_destroy(&umidi->mutex);
1485 * Unlinks all URBs (must be done before the usb_device is deleted).
1487 void snd_usbmidi_disconnect(struct list_head *p)
1489 struct snd_usb_midi *umidi;
1492 umidi = list_entry(p, struct snd_usb_midi, list);
1494 * an URB's completion handler may start the timer and
1495 * a timer may submit an URB. To reliably break the cycle
1496 * a flag under lock must be used
1498 down_write(&umidi->disc_rwsem);
1499 spin_lock_irq(&umidi->disc_lock);
1500 umidi->disconnected = 1;
1501 spin_unlock_irq(&umidi->disc_lock);
1502 up_write(&umidi->disc_rwsem);
1504 del_timer_sync(&umidi->error_timer);
1506 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1507 struct snd_usb_midi_endpoint *ep = &umidi->endpoints[i];
1509 cancel_work_sync(&ep->out->work);
1511 for (j = 0; j < OUTPUT_URBS; ++j)
1512 usb_kill_urb(ep->out->urbs[j].urb);
1513 if (umidi->usb_protocol_ops->finish_out_endpoint)
1514 umidi->usb_protocol_ops->finish_out_endpoint(ep->out);
1515 ep->out->active_urbs = 0;
1516 if (ep->out->drain_urbs) {
1517 ep->out->drain_urbs = 0;
1518 wake_up(&ep->out->drain_wait);
1522 for (j = 0; j < INPUT_URBS; ++j)
1523 usb_kill_urb(ep->in->urbs[j]);
1524 /* free endpoints here; later call can result in Oops */
1526 snd_usbmidi_out_endpoint_clear(ep->out);
1528 snd_usbmidi_in_endpoint_delete(ep->in);
1533 EXPORT_SYMBOL(snd_usbmidi_disconnect);
1535 static void snd_usbmidi_rawmidi_free(struct snd_rawmidi *rmidi)
1537 struct snd_usb_midi *umidi = rmidi->private_data;
1538 snd_usbmidi_free(umidi);
1541 static struct snd_rawmidi_substream *snd_usbmidi_find_substream(struct snd_usb_midi *umidi,
1545 struct snd_rawmidi_substream *substream;
1547 list_for_each_entry(substream, &umidi->rmidi->streams[stream].substreams,
1549 if (substream->number == number)
1556 * This list specifies names for ports that do not fit into the standard
1557 * "(product) MIDI (n)" schema because they aren't external MIDI ports,
1558 * such as internal control or synthesizer ports.
1560 static struct port_info {
1565 unsigned int seq_flags;
1566 } snd_usbmidi_port_info[] = {
1567 #define PORT_INFO(vendor, product, num, name_, voices_, flags) \
1568 { .id = USB_ID(vendor, product), \
1569 .port = num, .voices = voices_, \
1570 .name = name_, .seq_flags = flags }
1571 #define EXTERNAL_PORT(vendor, product, num, name) \
1572 PORT_INFO(vendor, product, num, name, 0, \
1573 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1574 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1575 SNDRV_SEQ_PORT_TYPE_PORT)
1576 #define CONTROL_PORT(vendor, product, num, name) \
1577 PORT_INFO(vendor, product, num, name, 0, \
1578 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1579 SNDRV_SEQ_PORT_TYPE_HARDWARE)
1580 #define GM_SYNTH_PORT(vendor, product, num, name, voices) \
1581 PORT_INFO(vendor, product, num, name, voices, \
1582 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1583 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1584 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1585 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1586 #define ROLAND_SYNTH_PORT(vendor, product, num, name, voices) \
1587 PORT_INFO(vendor, product, num, name, voices, \
1588 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1589 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1590 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1591 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1592 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1593 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1594 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1595 #define SOUNDCANVAS_PORT(vendor, product, num, name, voices) \
1596 PORT_INFO(vendor, product, num, name, voices, \
1597 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1598 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1599 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1600 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1601 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1602 SNDRV_SEQ_PORT_TYPE_MIDI_MT32 | \
1603 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1604 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1605 /* Yamaha MOTIF XF */
1606 GM_SYNTH_PORT(0x0499, 0x105c, 0, "%s Tone Generator", 128),
1607 CONTROL_PORT(0x0499, 0x105c, 1, "%s Remote Control"),
1608 EXTERNAL_PORT(0x0499, 0x105c, 2, "%s Thru"),
1609 CONTROL_PORT(0x0499, 0x105c, 3, "%s Editor"),
1611 CONTROL_PORT(0x0582, 0x0000, 2, "%s Control"),
1612 /* Roland SC-8850 */
1613 SOUNDCANVAS_PORT(0x0582, 0x0003, 0, "%s Part A", 128),
1614 SOUNDCANVAS_PORT(0x0582, 0x0003, 1, "%s Part B", 128),
1615 SOUNDCANVAS_PORT(0x0582, 0x0003, 2, "%s Part C", 128),
1616 SOUNDCANVAS_PORT(0x0582, 0x0003, 3, "%s Part D", 128),
1617 EXTERNAL_PORT(0x0582, 0x0003, 4, "%s MIDI 1"),
1618 EXTERNAL_PORT(0x0582, 0x0003, 5, "%s MIDI 2"),
1620 EXTERNAL_PORT(0x0582, 0x0004, 0, "%s MIDI"),
1621 CONTROL_PORT(0x0582, 0x0004, 1, "%s Control"),
1622 /* Roland SC-8820 */
1623 SOUNDCANVAS_PORT(0x0582, 0x0007, 0, "%s Part A", 64),
1624 SOUNDCANVAS_PORT(0x0582, 0x0007, 1, "%s Part B", 64),
1625 EXTERNAL_PORT(0x0582, 0x0007, 2, "%s MIDI"),
1627 SOUNDCANVAS_PORT(0x0582, 0x000b, 0, "%s Part A", 64),
1628 SOUNDCANVAS_PORT(0x0582, 0x000b, 1, "%s Part B", 64),
1629 EXTERNAL_PORT(0x0582, 0x000b, 2, "%s MIDI"),
1631 SOUNDCANVAS_PORT(0x0582, 0x000c, 0, "%s Part A", 64),
1632 SOUNDCANVAS_PORT(0x0582, 0x000c, 1, "%s Part B", 64),
1633 EXTERNAL_PORT(0x0582, 0x000c, 2, "%s MIDI"),
1635 CONTROL_PORT(0x0582, 0x0014, 8, "%s Control"),
1637 ROLAND_SYNTH_PORT(0x0582, 0x0016, 0, "%s Part A", 128),
1638 ROLAND_SYNTH_PORT(0x0582, 0x0016, 1, "%s Part B", 128),
1639 EXTERNAL_PORT(0x0582, 0x0016, 2, "%s MIDI 1"),
1640 EXTERNAL_PORT(0x0582, 0x0016, 3, "%s MIDI 2"),
1642 CONTROL_PORT(0x0582, 0x0023, 5, "%s Control"),
1644 ROLAND_SYNTH_PORT(0x0582, 0x0027, 0, "%s Part A", 64),
1645 ROLAND_SYNTH_PORT(0x0582, 0x0027, 1, "%s Part B", 64),
1646 EXTERNAL_PORT(0x0582, 0x0027, 2, "%s MIDI"),
1648 ROLAND_SYNTH_PORT(0x0582, 0x0029, 0, "%s Part A", 128),
1649 ROLAND_SYNTH_PORT(0x0582, 0x0029, 1, "%s Part B", 128),
1650 EXTERNAL_PORT(0x0582, 0x0029, 2, "%s MIDI 1"),
1651 EXTERNAL_PORT(0x0582, 0x0029, 3, "%s MIDI 2"),
1653 EXTERNAL_PORT(0x0582, 0x002b, 0, "%s MIDI"),
1654 CONTROL_PORT(0x0582, 0x002b, 1, "%s Control"),
1656 EXTERNAL_PORT(0x0582, 0x002f, 0, "%s MIDI"),
1657 EXTERNAL_PORT(0x0582, 0x002f, 1, "%s External MIDI"),
1658 EXTERNAL_PORT(0x0582, 0x002f, 2, "%s Sync"),
1660 EXTERNAL_PORT(0x0582, 0x0033, 0, "%s MIDI"),
1661 EXTERNAL_PORT(0x0582, 0x0033, 1, "%s 1"),
1662 EXTERNAL_PORT(0x0582, 0x0033, 2, "%s 2"),
1664 EXTERNAL_PORT(0x0582, 0x003b, 0, "%s MIDI"),
1665 CONTROL_PORT(0x0582, 0x003b, 1, "%s Control"),
1666 /* Edirol UA-1000 */
1667 EXTERNAL_PORT(0x0582, 0x0044, 0, "%s MIDI"),
1668 CONTROL_PORT(0x0582, 0x0044, 1, "%s Control"),
1670 EXTERNAL_PORT(0x0582, 0x0048, 0, "%s MIDI"),
1671 EXTERNAL_PORT(0x0582, 0x0048, 1, "%s 1"),
1672 EXTERNAL_PORT(0x0582, 0x0048, 2, "%s 2"),
1674 EXTERNAL_PORT(0x0582, 0x004d, 0, "%s MIDI"),
1675 EXTERNAL_PORT(0x0582, 0x004d, 1, "%s 1"),
1676 EXTERNAL_PORT(0x0582, 0x004d, 2, "%s 2"),
1678 CONTROL_PORT(0x0582, 0x0089, 0, "%s Control"),
1680 CONTROL_PORT(0x0582, 0x009a, 3, "%s Control"),
1682 CONTROL_PORT(0x0582, 0x00b2, 0, "%s Control"),
1683 EXTERNAL_PORT(0x0582, 0x00b2, 1, "%s MIDI"),
1684 /* Cakewalk Sonar V-Studio 100 */
1685 EXTERNAL_PORT(0x0582, 0x00eb, 0, "%s MIDI"),
1686 CONTROL_PORT(0x0582, 0x00eb, 1, "%s Control"),
1688 CONTROL_PORT(0x0582, 0x0102, 0, "%s Control"),
1689 EXTERNAL_PORT(0x0582, 0x0102, 1, "%s MIDI"),
1691 EXTERNAL_PORT(0x0582, 0x010f, 0, "%s MIDI"),
1692 CONTROL_PORT(0x0582, 0x010f, 1, "%s 1"),
1693 CONTROL_PORT(0x0582, 0x010f, 2, "%s 2"),
1695 ROLAND_SYNTH_PORT(0x0582, 0x0114, 0, "%s Synth", 128),
1696 EXTERNAL_PORT(0x0582, 0x0114, 1, "%s MIDI"),
1697 CONTROL_PORT(0x0582, 0x0114, 2, "%s Control"),
1698 /* Roland OCTA-CAPTURE */
1699 EXTERNAL_PORT(0x0582, 0x0120, 0, "%s MIDI"),
1700 CONTROL_PORT(0x0582, 0x0120, 1, "%s Control"),
1701 EXTERNAL_PORT(0x0582, 0x0121, 0, "%s MIDI"),
1702 CONTROL_PORT(0x0582, 0x0121, 1, "%s Control"),
1704 CONTROL_PORT(0x0582, 0x0145, 0, "%s Control"),
1705 EXTERNAL_PORT(0x0582, 0x0145, 1, "%s MIDI"),
1706 /* Roland A-Series */
1707 CONTROL_PORT(0x0582, 0x0156, 0, "%s Keyboard"),
1708 EXTERNAL_PORT(0x0582, 0x0156, 1, "%s MIDI"),
1709 /* Roland INTEGRA-7 */
1710 ROLAND_SYNTH_PORT(0x0582, 0x015b, 0, "%s Synth", 128),
1711 CONTROL_PORT(0x0582, 0x015b, 1, "%s Control"),
1712 /* M-Audio MidiSport 8x8 */
1713 CONTROL_PORT(0x0763, 0x1031, 8, "%s Control"),
1714 CONTROL_PORT(0x0763, 0x1033, 8, "%s Control"),
1716 EXTERNAL_PORT(0x07fd, 0x0001, 0, "%s MIDI A"),
1717 EXTERNAL_PORT(0x07fd, 0x0001, 1, "%s MIDI B"),
1718 /* Emagic Unitor8/AMT8/MT4 */
1719 EXTERNAL_PORT(0x086a, 0x0001, 8, "%s Broadcast"),
1720 EXTERNAL_PORT(0x086a, 0x0002, 8, "%s Broadcast"),
1721 EXTERNAL_PORT(0x086a, 0x0003, 4, "%s Broadcast"),
1723 CONTROL_PORT(0x09e8, 0x0062, 0, "%s Control"),
1724 PORT_INFO(0x09e8, 0x0062, 1, "%s MIDI", 0,
1725 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC |
1726 SNDRV_SEQ_PORT_TYPE_HARDWARE),
1727 /* Access Music Virus TI */
1728 EXTERNAL_PORT(0x133e, 0x0815, 0, "%s MIDI"),
1729 PORT_INFO(0x133e, 0x0815, 1, "%s Synth", 0,
1730 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC |
1731 SNDRV_SEQ_PORT_TYPE_HARDWARE |
1732 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER),
1735 static struct port_info *find_port_info(struct snd_usb_midi *umidi, int number)
1739 for (i = 0; i < ARRAY_SIZE(snd_usbmidi_port_info); ++i) {
1740 if (snd_usbmidi_port_info[i].id == umidi->usb_id &&
1741 snd_usbmidi_port_info[i].port == number)
1742 return &snd_usbmidi_port_info[i];
1747 static void snd_usbmidi_get_port_info(struct snd_rawmidi *rmidi, int number,
1748 struct snd_seq_port_info *seq_port_info)
1750 struct snd_usb_midi *umidi = rmidi->private_data;
1751 struct port_info *port_info;
1753 /* TODO: read port flags from descriptors */
1754 port_info = find_port_info(umidi, number);
1756 seq_port_info->type = port_info->seq_flags;
1757 seq_port_info->midi_voices = port_info->voices;
1761 static void snd_usbmidi_init_substream(struct snd_usb_midi *umidi,
1762 int stream, int number,
1763 struct snd_rawmidi_substream **rsubstream)
1765 struct port_info *port_info;
1766 const char *name_format;
1768 struct snd_rawmidi_substream *substream =
1769 snd_usbmidi_find_substream(umidi, stream, number);
1771 dev_err(&umidi->dev->dev, "substream %d:%d not found\n", stream,
1776 /* TODO: read port name from jack descriptor */
1777 port_info = find_port_info(umidi, number);
1778 name_format = port_info ? port_info->name : "%s MIDI %d";
1779 snprintf(substream->name, sizeof(substream->name),
1780 name_format, umidi->card->shortname, number + 1);
1782 *rsubstream = substream;
1786 * Creates the endpoints and their ports.
1788 static int snd_usbmidi_create_endpoints(struct snd_usb_midi *umidi,
1789 struct snd_usb_midi_endpoint_info *endpoints)
1792 int out_ports = 0, in_ports = 0;
1794 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1795 if (endpoints[i].out_cables) {
1796 err = snd_usbmidi_out_endpoint_create(umidi,
1798 &umidi->endpoints[i]);
1802 if (endpoints[i].in_cables) {
1803 err = snd_usbmidi_in_endpoint_create(umidi,
1805 &umidi->endpoints[i]);
1810 for (j = 0; j < 0x10; ++j) {
1811 if (endpoints[i].out_cables & (1 << j)) {
1812 snd_usbmidi_init_substream(umidi,
1813 SNDRV_RAWMIDI_STREAM_OUTPUT,
1815 &umidi->endpoints[i].out->ports[j].substream);
1818 if (endpoints[i].in_cables & (1 << j)) {
1819 snd_usbmidi_init_substream(umidi,
1820 SNDRV_RAWMIDI_STREAM_INPUT,
1822 &umidi->endpoints[i].in->ports[j].substream);
1827 dev_dbg(&umidi->dev->dev, "created %d output and %d input ports\n",
1828 out_ports, in_ports);
1832 static struct usb_ms_endpoint_descriptor *find_usb_ms_endpoint_descriptor(
1833 struct usb_host_endpoint *hostep)
1835 unsigned char *extra = hostep->extra;
1836 int extralen = hostep->extralen;
1838 while (extralen > 3) {
1839 struct usb_ms_endpoint_descriptor *ms_ep =
1840 (struct usb_ms_endpoint_descriptor *)extra;
1842 if (ms_ep->bLength > 3 &&
1843 ms_ep->bDescriptorType == USB_DT_CS_ENDPOINT &&
1844 ms_ep->bDescriptorSubtype == UAC_MS_GENERAL)
1848 extralen -= extra[0];
1855 * Returns MIDIStreaming device capabilities.
1857 static int snd_usbmidi_get_ms_info(struct snd_usb_midi *umidi,
1858 struct snd_usb_midi_endpoint_info *endpoints)
1860 struct usb_interface *intf;
1861 struct usb_host_interface *hostif;
1862 struct usb_interface_descriptor *intfd;
1863 struct usb_ms_header_descriptor *ms_header;
1864 struct usb_host_endpoint *hostep;
1865 struct usb_endpoint_descriptor *ep;
1866 struct usb_ms_endpoint_descriptor *ms_ep;
1869 intf = umidi->iface;
1872 hostif = &intf->altsetting[0];
1873 intfd = get_iface_desc(hostif);
1874 ms_header = (struct usb_ms_header_descriptor *)hostif->extra;
1875 if (hostif->extralen >= 7 &&
1876 ms_header->bLength >= 7 &&
1877 ms_header->bDescriptorType == USB_DT_CS_INTERFACE &&
1878 ms_header->bDescriptorSubtype == UAC_HEADER)
1879 dev_dbg(&umidi->dev->dev, "MIDIStreaming version %02x.%02x\n",
1880 ms_header->bcdMSC[1], ms_header->bcdMSC[0]);
1882 dev_warn(&umidi->dev->dev,
1883 "MIDIStreaming interface descriptor not found\n");
1886 for (i = 0; i < intfd->bNumEndpoints; ++i) {
1887 hostep = &hostif->endpoint[i];
1888 ep = get_ep_desc(hostep);
1889 if (!usb_endpoint_xfer_bulk(ep) && !usb_endpoint_xfer_int(ep))
1891 ms_ep = find_usb_ms_endpoint_descriptor(hostep);
1894 if (ms_ep->bLength <= sizeof(*ms_ep))
1896 if (ms_ep->bNumEmbMIDIJack > 0x10)
1898 if (ms_ep->bLength < sizeof(*ms_ep) + ms_ep->bNumEmbMIDIJack)
1900 if (usb_endpoint_dir_out(ep)) {
1901 if (endpoints[epidx].out_ep) {
1902 if (++epidx >= MIDI_MAX_ENDPOINTS) {
1903 dev_warn(&umidi->dev->dev,
1904 "too many endpoints\n");
1908 endpoints[epidx].out_ep = usb_endpoint_num(ep);
1909 if (usb_endpoint_xfer_int(ep))
1910 endpoints[epidx].out_interval = ep->bInterval;
1911 else if (snd_usb_get_speed(umidi->dev) == USB_SPEED_LOW)
1913 * Low speed bulk transfers don't exist, so
1914 * force interrupt transfers for devices like
1915 * ESI MIDI Mate that try to use them anyway.
1917 endpoints[epidx].out_interval = 1;
1918 endpoints[epidx].out_cables =
1919 (1 << ms_ep->bNumEmbMIDIJack) - 1;
1920 dev_dbg(&umidi->dev->dev, "EP %02X: %d jack(s)\n",
1921 ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1923 if (endpoints[epidx].in_ep) {
1924 if (++epidx >= MIDI_MAX_ENDPOINTS) {
1925 dev_warn(&umidi->dev->dev,
1926 "too many endpoints\n");
1930 endpoints[epidx].in_ep = usb_endpoint_num(ep);
1931 if (usb_endpoint_xfer_int(ep))
1932 endpoints[epidx].in_interval = ep->bInterval;
1933 else if (snd_usb_get_speed(umidi->dev) == USB_SPEED_LOW)
1934 endpoints[epidx].in_interval = 1;
1935 endpoints[epidx].in_cables =
1936 (1 << ms_ep->bNumEmbMIDIJack) - 1;
1937 dev_dbg(&umidi->dev->dev, "EP %02X: %d jack(s)\n",
1938 ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1944 static int roland_load_info(struct snd_kcontrol *kcontrol,
1945 struct snd_ctl_elem_info *info)
1947 static const char *const names[] = { "High Load", "Light Load" };
1949 return snd_ctl_enum_info(info, 1, 2, names);
1952 static int roland_load_get(struct snd_kcontrol *kcontrol,
1953 struct snd_ctl_elem_value *value)
1955 value->value.enumerated.item[0] = kcontrol->private_value;
1959 static int roland_load_put(struct snd_kcontrol *kcontrol,
1960 struct snd_ctl_elem_value *value)
1962 struct snd_usb_midi *umidi = kcontrol->private_data;
1965 if (value->value.enumerated.item[0] > 1)
1967 mutex_lock(&umidi->mutex);
1968 changed = value->value.enumerated.item[0] != kcontrol->private_value;
1970 kcontrol->private_value = value->value.enumerated.item[0];
1971 mutex_unlock(&umidi->mutex);
1975 static const struct snd_kcontrol_new roland_load_ctl = {
1976 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1977 .name = "MIDI Input Mode",
1978 .info = roland_load_info,
1979 .get = roland_load_get,
1980 .put = roland_load_put,
1985 * On Roland devices, use the second alternate setting to be able to use
1986 * the interrupt input endpoint.
1988 static void snd_usbmidi_switch_roland_altsetting(struct snd_usb_midi *umidi)
1990 struct usb_interface *intf;
1991 struct usb_host_interface *hostif;
1992 struct usb_interface_descriptor *intfd;
1994 intf = umidi->iface;
1995 if (!intf || intf->num_altsetting != 2)
1998 hostif = &intf->altsetting[1];
1999 intfd = get_iface_desc(hostif);
2000 /* If either or both of the endpoints support interrupt transfer,
2001 * then use the alternate setting
2003 if (intfd->bNumEndpoints != 2 ||
2004 !((get_endpoint(hostif, 0)->bmAttributes &
2005 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT ||
2006 (get_endpoint(hostif, 1)->bmAttributes &
2007 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT))
2010 dev_dbg(&umidi->dev->dev, "switching to altsetting %d with int ep\n",
2011 intfd->bAlternateSetting);
2012 usb_set_interface(umidi->dev, intfd->bInterfaceNumber,
2013 intfd->bAlternateSetting);
2015 umidi->roland_load_ctl = snd_ctl_new1(&roland_load_ctl, umidi);
2016 if (snd_ctl_add(umidi->card, umidi->roland_load_ctl) < 0)
2017 umidi->roland_load_ctl = NULL;
2021 * Try to find any usable endpoints in the interface.
2023 static int snd_usbmidi_detect_endpoints(struct snd_usb_midi *umidi,
2024 struct snd_usb_midi_endpoint_info *endpoint,
2027 struct usb_interface *intf;
2028 struct usb_host_interface *hostif;
2029 struct usb_interface_descriptor *intfd;
2030 struct usb_endpoint_descriptor *epd;
2031 int i, out_eps = 0, in_eps = 0;
2033 if (USB_ID_VENDOR(umidi->usb_id) == 0x0582)
2034 snd_usbmidi_switch_roland_altsetting(umidi);
2036 if (endpoint[0].out_ep || endpoint[0].in_ep)
2039 intf = umidi->iface;
2040 if (!intf || intf->num_altsetting < 1)
2042 hostif = intf->cur_altsetting;
2043 intfd = get_iface_desc(hostif);
2045 for (i = 0; i < intfd->bNumEndpoints; ++i) {
2046 epd = get_endpoint(hostif, i);
2047 if (!usb_endpoint_xfer_bulk(epd) &&
2048 !usb_endpoint_xfer_int(epd))
2050 if (out_eps < max_endpoints &&
2051 usb_endpoint_dir_out(epd)) {
2052 endpoint[out_eps].out_ep = usb_endpoint_num(epd);
2053 if (usb_endpoint_xfer_int(epd))
2054 endpoint[out_eps].out_interval = epd->bInterval;
2057 if (in_eps < max_endpoints &&
2058 usb_endpoint_dir_in(epd)) {
2059 endpoint[in_eps].in_ep = usb_endpoint_num(epd);
2060 if (usb_endpoint_xfer_int(epd))
2061 endpoint[in_eps].in_interval = epd->bInterval;
2065 return (out_eps || in_eps) ? 0 : -ENOENT;
2069 * Detects the endpoints for one-port-per-endpoint protocols.
2071 static int snd_usbmidi_detect_per_port_endpoints(struct snd_usb_midi *umidi,
2072 struct snd_usb_midi_endpoint_info *endpoints)
2076 err = snd_usbmidi_detect_endpoints(umidi, endpoints, MIDI_MAX_ENDPOINTS);
2077 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
2078 if (endpoints[i].out_ep)
2079 endpoints[i].out_cables = 0x0001;
2080 if (endpoints[i].in_ep)
2081 endpoints[i].in_cables = 0x0001;
2087 * Detects the endpoints and ports of Yamaha devices.
2089 static int snd_usbmidi_detect_yamaha(struct snd_usb_midi *umidi,
2090 struct snd_usb_midi_endpoint_info *endpoint)
2092 struct usb_interface *intf;
2093 struct usb_host_interface *hostif;
2094 struct usb_interface_descriptor *intfd;
2097 intf = umidi->iface;
2100 hostif = intf->altsetting;
2101 intfd = get_iface_desc(hostif);
2102 if (intfd->bNumEndpoints < 1)
2106 * For each port there is one MIDI_IN/OUT_JACK descriptor, not
2107 * necessarily with any useful contents. So simply count 'em.
2109 for (cs_desc = hostif->extra;
2110 cs_desc < hostif->extra + hostif->extralen && cs_desc[0] >= 2;
2111 cs_desc += cs_desc[0]) {
2112 if (cs_desc[1] == USB_DT_CS_INTERFACE) {
2113 if (cs_desc[2] == UAC_MIDI_IN_JACK)
2114 endpoint->in_cables =
2115 (endpoint->in_cables << 1) | 1;
2116 else if (cs_desc[2] == UAC_MIDI_OUT_JACK)
2117 endpoint->out_cables =
2118 (endpoint->out_cables << 1) | 1;
2121 if (!endpoint->in_cables && !endpoint->out_cables)
2124 return snd_usbmidi_detect_endpoints(umidi, endpoint, 1);
2128 * Detects the endpoints and ports of Roland devices.
2130 static int snd_usbmidi_detect_roland(struct snd_usb_midi *umidi,
2131 struct snd_usb_midi_endpoint_info *endpoint)
2133 struct usb_interface *intf;
2134 struct usb_host_interface *hostif;
2137 intf = umidi->iface;
2140 hostif = intf->altsetting;
2142 * Some devices have a descriptor <06 24 F1 02 <inputs> <outputs>>,
2143 * some have standard class descriptors, or both kinds, or neither.
2145 for (cs_desc = hostif->extra;
2146 cs_desc < hostif->extra + hostif->extralen && cs_desc[0] >= 2;
2147 cs_desc += cs_desc[0]) {
2148 if (cs_desc[0] >= 6 &&
2149 cs_desc[1] == USB_DT_CS_INTERFACE &&
2150 cs_desc[2] == 0xf1 &&
2151 cs_desc[3] == 0x02) {
2152 if (cs_desc[4] > 0x10 || cs_desc[5] > 0x10)
2154 endpoint->in_cables = (1 << cs_desc[4]) - 1;
2155 endpoint->out_cables = (1 << cs_desc[5]) - 1;
2156 return snd_usbmidi_detect_endpoints(umidi, endpoint, 1);
2157 } else if (cs_desc[0] >= 7 &&
2158 cs_desc[1] == USB_DT_CS_INTERFACE &&
2159 cs_desc[2] == UAC_HEADER) {
2160 return snd_usbmidi_get_ms_info(umidi, endpoint);
2168 * Creates the endpoints and their ports for Midiman devices.
2170 static int snd_usbmidi_create_endpoints_midiman(struct snd_usb_midi *umidi,
2171 struct snd_usb_midi_endpoint_info *endpoint)
2173 struct snd_usb_midi_endpoint_info ep_info;
2174 struct usb_interface *intf;
2175 struct usb_host_interface *hostif;
2176 struct usb_interface_descriptor *intfd;
2177 struct usb_endpoint_descriptor *epd;
2180 intf = umidi->iface;
2183 hostif = intf->altsetting;
2184 intfd = get_iface_desc(hostif);
2186 * The various MidiSport devices have more or less random endpoint
2187 * numbers, so we have to identify the endpoints by their index in
2188 * the descriptor array, like the driver for that other OS does.
2190 * There is one interrupt input endpoint for all input ports, one
2191 * bulk output endpoint for even-numbered ports, and one for odd-
2192 * numbered ports. Both bulk output endpoints have corresponding
2193 * input bulk endpoints (at indices 1 and 3) which aren't used.
2195 if (intfd->bNumEndpoints < (endpoint->out_cables > 0x0001 ? 5 : 3)) {
2196 dev_dbg(&umidi->dev->dev, "not enough endpoints\n");
2200 epd = get_endpoint(hostif, 0);
2201 if (!usb_endpoint_dir_in(epd) || !usb_endpoint_xfer_int(epd)) {
2202 dev_dbg(&umidi->dev->dev, "endpoint[0] isn't interrupt\n");
2205 epd = get_endpoint(hostif, 2);
2206 if (!usb_endpoint_dir_out(epd) || !usb_endpoint_xfer_bulk(epd)) {
2207 dev_dbg(&umidi->dev->dev, "endpoint[2] isn't bulk output\n");
2210 if (endpoint->out_cables > 0x0001) {
2211 epd = get_endpoint(hostif, 4);
2212 if (!usb_endpoint_dir_out(epd) ||
2213 !usb_endpoint_xfer_bulk(epd)) {
2214 dev_dbg(&umidi->dev->dev,
2215 "endpoint[4] isn't bulk output\n");
2220 ep_info.out_ep = get_endpoint(hostif, 2)->bEndpointAddress &
2221 USB_ENDPOINT_NUMBER_MASK;
2222 ep_info.out_interval = 0;
2223 ep_info.out_cables = endpoint->out_cables & 0x5555;
2224 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info,
2225 &umidi->endpoints[0]);
2229 ep_info.in_ep = get_endpoint(hostif, 0)->bEndpointAddress &
2230 USB_ENDPOINT_NUMBER_MASK;
2231 ep_info.in_interval = get_endpoint(hostif, 0)->bInterval;
2232 ep_info.in_cables = endpoint->in_cables;
2233 err = snd_usbmidi_in_endpoint_create(umidi, &ep_info,
2234 &umidi->endpoints[0]);
2238 if (endpoint->out_cables > 0x0001) {
2239 ep_info.out_ep = get_endpoint(hostif, 4)->bEndpointAddress &
2240 USB_ENDPOINT_NUMBER_MASK;
2241 ep_info.out_cables = endpoint->out_cables & 0xaaaa;
2242 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info,
2243 &umidi->endpoints[1]);
2248 for (cable = 0; cable < 0x10; ++cable) {
2249 if (endpoint->out_cables & (1 << cable))
2250 snd_usbmidi_init_substream(umidi,
2251 SNDRV_RAWMIDI_STREAM_OUTPUT,
2253 &umidi->endpoints[cable & 1].out->ports[cable].substream);
2254 if (endpoint->in_cables & (1 << cable))
2255 snd_usbmidi_init_substream(umidi,
2256 SNDRV_RAWMIDI_STREAM_INPUT,
2258 &umidi->endpoints[0].in->ports[cable].substream);
2263 static const struct snd_rawmidi_global_ops snd_usbmidi_ops = {
2264 .get_port_info = snd_usbmidi_get_port_info,
2267 static int snd_usbmidi_create_rawmidi(struct snd_usb_midi *umidi,
2268 int out_ports, int in_ports)
2270 struct snd_rawmidi *rmidi;
2273 err = snd_rawmidi_new(umidi->card, "USB MIDI",
2274 umidi->next_midi_device++,
2275 out_ports, in_ports, &rmidi);
2278 strcpy(rmidi->name, umidi->card->shortname);
2279 rmidi->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT |
2280 SNDRV_RAWMIDI_INFO_INPUT |
2281 SNDRV_RAWMIDI_INFO_DUPLEX;
2282 rmidi->ops = &snd_usbmidi_ops;
2283 rmidi->private_data = umidi;
2284 rmidi->private_free = snd_usbmidi_rawmidi_free;
2285 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT,
2286 &snd_usbmidi_output_ops);
2287 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT,
2288 &snd_usbmidi_input_ops);
2290 umidi->rmidi = rmidi;
2295 * Temporarily stop input.
2297 void snd_usbmidi_input_stop(struct list_head *p)
2299 struct snd_usb_midi *umidi;
2302 umidi = list_entry(p, struct snd_usb_midi, list);
2303 if (!umidi->input_running)
2305 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
2306 struct snd_usb_midi_endpoint *ep = &umidi->endpoints[i];
2308 for (j = 0; j < INPUT_URBS; ++j)
2309 usb_kill_urb(ep->in->urbs[j]);
2311 umidi->input_running = 0;
2313 EXPORT_SYMBOL(snd_usbmidi_input_stop);
2315 static void snd_usbmidi_input_start_ep(struct snd_usb_midi *umidi,
2316 struct snd_usb_midi_in_endpoint *ep)
2319 unsigned long flags;
2323 for (i = 0; i < INPUT_URBS; ++i) {
2324 struct urb *urb = ep->urbs[i];
2325 spin_lock_irqsave(&umidi->disc_lock, flags);
2326 if (!atomic_read(&urb->use_count)) {
2327 urb->dev = ep->umidi->dev;
2328 snd_usbmidi_submit_urb(urb, GFP_ATOMIC);
2330 spin_unlock_irqrestore(&umidi->disc_lock, flags);
2335 * Resume input after a call to snd_usbmidi_input_stop().
2337 void snd_usbmidi_input_start(struct list_head *p)
2339 struct snd_usb_midi *umidi;
2342 umidi = list_entry(p, struct snd_usb_midi, list);
2343 if (umidi->input_running || !umidi->opened[1])
2345 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
2346 snd_usbmidi_input_start_ep(umidi, umidi->endpoints[i].in);
2347 umidi->input_running = 1;
2349 EXPORT_SYMBOL(snd_usbmidi_input_start);
2352 * Prepare for suspend. Typically called from the USB suspend callback.
2354 void snd_usbmidi_suspend(struct list_head *p)
2356 struct snd_usb_midi *umidi;
2358 umidi = list_entry(p, struct snd_usb_midi, list);
2359 mutex_lock(&umidi->mutex);
2360 snd_usbmidi_input_stop(p);
2361 mutex_unlock(&umidi->mutex);
2363 EXPORT_SYMBOL(snd_usbmidi_suspend);
2366 * Resume. Typically called from the USB resume callback.
2368 void snd_usbmidi_resume(struct list_head *p)
2370 struct snd_usb_midi *umidi;
2372 umidi = list_entry(p, struct snd_usb_midi, list);
2373 mutex_lock(&umidi->mutex);
2374 snd_usbmidi_input_start(p);
2375 mutex_unlock(&umidi->mutex);
2377 EXPORT_SYMBOL(snd_usbmidi_resume);
2380 * Creates and registers everything needed for a MIDI streaming interface.
2382 int __snd_usbmidi_create(struct snd_card *card,
2383 struct usb_interface *iface,
2384 struct list_head *midi_list,
2385 const struct snd_usb_audio_quirk *quirk,
2386 unsigned int usb_id)
2388 struct snd_usb_midi *umidi;
2389 struct snd_usb_midi_endpoint_info endpoints[MIDI_MAX_ENDPOINTS];
2390 int out_ports, in_ports;
2393 umidi = kzalloc(sizeof(*umidi), GFP_KERNEL);
2396 umidi->dev = interface_to_usbdev(iface);
2398 umidi->iface = iface;
2399 umidi->quirk = quirk;
2400 umidi->usb_protocol_ops = &snd_usbmidi_standard_ops;
2401 spin_lock_init(&umidi->disc_lock);
2402 init_rwsem(&umidi->disc_rwsem);
2403 mutex_init(&umidi->mutex);
2405 usb_id = USB_ID(le16_to_cpu(umidi->dev->descriptor.idVendor),
2406 le16_to_cpu(umidi->dev->descriptor.idProduct));
2407 umidi->usb_id = usb_id;
2408 timer_setup(&umidi->error_timer, snd_usbmidi_error_timer, 0);
2410 /* detect the endpoint(s) to use */
2411 memset(endpoints, 0, sizeof(endpoints));
2412 switch (quirk ? quirk->type : QUIRK_MIDI_STANDARD_INTERFACE) {
2413 case QUIRK_MIDI_STANDARD_INTERFACE:
2414 err = snd_usbmidi_get_ms_info(umidi, endpoints);
2415 if (umidi->usb_id == USB_ID(0x0763, 0x0150)) /* M-Audio Uno */
2416 umidi->usb_protocol_ops =
2417 &snd_usbmidi_maudio_broken_running_status_ops;
2419 case QUIRK_MIDI_US122L:
2420 umidi->usb_protocol_ops = &snd_usbmidi_122l_ops;
2422 case QUIRK_MIDI_FIXED_ENDPOINT:
2423 memcpy(&endpoints[0], quirk->data,
2424 sizeof(struct snd_usb_midi_endpoint_info));
2425 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
2427 case QUIRK_MIDI_YAMAHA:
2428 err = snd_usbmidi_detect_yamaha(umidi, &endpoints[0]);
2430 case QUIRK_MIDI_ROLAND:
2431 err = snd_usbmidi_detect_roland(umidi, &endpoints[0]);
2433 case QUIRK_MIDI_MIDIMAN:
2434 umidi->usb_protocol_ops = &snd_usbmidi_midiman_ops;
2435 memcpy(&endpoints[0], quirk->data,
2436 sizeof(struct snd_usb_midi_endpoint_info));
2439 case QUIRK_MIDI_NOVATION:
2440 umidi->usb_protocol_ops = &snd_usbmidi_novation_ops;
2441 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2443 case QUIRK_MIDI_RAW_BYTES:
2444 umidi->usb_protocol_ops = &snd_usbmidi_raw_ops;
2446 * Interface 1 contains isochronous endpoints, but with the same
2447 * numbers as in interface 0. Since it is interface 1 that the
2448 * USB core has most recently seen, these descriptors are now
2449 * associated with the endpoint numbers. This will foul up our
2450 * attempts to submit bulk/interrupt URBs to the endpoints in
2451 * interface 0, so we have to make sure that the USB core looks
2452 * again at interface 0 by calling usb_set_interface() on it.
2454 if (umidi->usb_id == USB_ID(0x07fd, 0x0001)) /* MOTU Fastlane */
2455 usb_set_interface(umidi->dev, 0, 0);
2456 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2458 case QUIRK_MIDI_EMAGIC:
2459 umidi->usb_protocol_ops = &snd_usbmidi_emagic_ops;
2460 memcpy(&endpoints[0], quirk->data,
2461 sizeof(struct snd_usb_midi_endpoint_info));
2462 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
2464 case QUIRK_MIDI_CME:
2465 umidi->usb_protocol_ops = &snd_usbmidi_cme_ops;
2466 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2468 case QUIRK_MIDI_AKAI:
2469 umidi->usb_protocol_ops = &snd_usbmidi_akai_ops;
2470 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2471 /* endpoint 1 is input-only */
2472 endpoints[1].out_cables = 0;
2474 case QUIRK_MIDI_FTDI:
2475 umidi->usb_protocol_ops = &snd_usbmidi_ftdi_ops;
2477 /* set baud rate to 31250 (48 MHz / 16 / 96) */
2478 err = usb_control_msg(umidi->dev, usb_sndctrlpipe(umidi->dev, 0),
2479 3, 0x40, 0x60, 0, NULL, 0, 1000);
2483 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2485 case QUIRK_MIDI_CH345:
2486 umidi->usb_protocol_ops = &snd_usbmidi_ch345_broken_sysex_ops;
2487 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2490 dev_err(&umidi->dev->dev, "invalid quirk type %d\n",
2498 /* create rawmidi device */
2501 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
2502 out_ports += hweight16(endpoints[i].out_cables);
2503 in_ports += hweight16(endpoints[i].in_cables);
2505 err = snd_usbmidi_create_rawmidi(umidi, out_ports, in_ports);
2509 /* create endpoint/port structures */
2510 if (quirk && quirk->type == QUIRK_MIDI_MIDIMAN)
2511 err = snd_usbmidi_create_endpoints_midiman(umidi, &endpoints[0]);
2513 err = snd_usbmidi_create_endpoints(umidi, endpoints);
2517 usb_autopm_get_interface_no_resume(umidi->iface);
2519 list_add_tail(&umidi->list, midi_list);
2527 EXPORT_SYMBOL(__snd_usbmidi_create);