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];
1157 substream->runtime->private_data = port;
1158 port->state = STATE_UNKNOWN;
1159 return substream_open(substream, 0, 1);
1162 static int snd_usbmidi_output_close(struct snd_rawmidi_substream *substream)
1164 return substream_open(substream, 0, 0);
1167 static void snd_usbmidi_output_trigger(struct snd_rawmidi_substream *substream,
1170 struct usbmidi_out_port *port =
1171 (struct usbmidi_out_port *)substream->runtime->private_data;
1175 if (port->ep->umidi->disconnected) {
1176 /* gobble up remaining bytes to prevent wait in
1177 * snd_rawmidi_drain_output */
1178 snd_rawmidi_proceed(substream);
1181 queue_work(system_highpri_wq, &port->ep->work);
1185 static void snd_usbmidi_output_drain(struct snd_rawmidi_substream *substream)
1187 struct usbmidi_out_port *port = substream->runtime->private_data;
1188 struct snd_usb_midi_out_endpoint *ep = port->ep;
1189 unsigned int drain_urbs;
1191 long timeout = msecs_to_jiffies(50);
1193 if (ep->umidi->disconnected)
1196 * The substream buffer is empty, but some data might still be in the
1197 * currently active URBs, so we have to wait for those to complete.
1199 spin_lock_irq(&ep->buffer_lock);
1200 drain_urbs = ep->active_urbs;
1202 ep->drain_urbs |= drain_urbs;
1204 prepare_to_wait(&ep->drain_wait, &wait,
1205 TASK_UNINTERRUPTIBLE);
1206 spin_unlock_irq(&ep->buffer_lock);
1207 timeout = schedule_timeout(timeout);
1208 spin_lock_irq(&ep->buffer_lock);
1209 drain_urbs &= ep->drain_urbs;
1210 } while (drain_urbs && timeout);
1211 finish_wait(&ep->drain_wait, &wait);
1213 spin_unlock_irq(&ep->buffer_lock);
1216 static int snd_usbmidi_input_open(struct snd_rawmidi_substream *substream)
1218 return substream_open(substream, 1, 1);
1221 static int snd_usbmidi_input_close(struct snd_rawmidi_substream *substream)
1223 return substream_open(substream, 1, 0);
1226 static void snd_usbmidi_input_trigger(struct snd_rawmidi_substream *substream,
1229 struct snd_usb_midi *umidi = substream->rmidi->private_data;
1232 set_bit(substream->number, &umidi->input_triggered);
1234 clear_bit(substream->number, &umidi->input_triggered);
1237 static const struct snd_rawmidi_ops snd_usbmidi_output_ops = {
1238 .open = snd_usbmidi_output_open,
1239 .close = snd_usbmidi_output_close,
1240 .trigger = snd_usbmidi_output_trigger,
1241 .drain = snd_usbmidi_output_drain,
1244 static const struct snd_rawmidi_ops snd_usbmidi_input_ops = {
1245 .open = snd_usbmidi_input_open,
1246 .close = snd_usbmidi_input_close,
1247 .trigger = snd_usbmidi_input_trigger
1250 static void free_urb_and_buffer(struct snd_usb_midi *umidi, struct urb *urb,
1251 unsigned int buffer_length)
1253 usb_free_coherent(umidi->dev, buffer_length,
1254 urb->transfer_buffer, urb->transfer_dma);
1259 * Frees an input endpoint.
1260 * May be called when ep hasn't been initialized completely.
1262 static void snd_usbmidi_in_endpoint_delete(struct snd_usb_midi_in_endpoint *ep)
1266 for (i = 0; i < INPUT_URBS; ++i)
1268 free_urb_and_buffer(ep->umidi, ep->urbs[i],
1269 ep->urbs[i]->transfer_buffer_length);
1274 * Creates an input endpoint.
1276 static int snd_usbmidi_in_endpoint_create(struct snd_usb_midi *umidi,
1277 struct snd_usb_midi_endpoint_info *ep_info,
1278 struct snd_usb_midi_endpoint *rep)
1280 struct snd_usb_midi_in_endpoint *ep;
1288 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1293 for (i = 0; i < INPUT_URBS; ++i) {
1294 ep->urbs[i] = usb_alloc_urb(0, GFP_KERNEL);
1300 if (ep_info->in_interval)
1301 pipe = usb_rcvintpipe(umidi->dev, ep_info->in_ep);
1303 pipe = usb_rcvbulkpipe(umidi->dev, ep_info->in_ep);
1304 length = usb_maxpacket(umidi->dev, pipe, 0);
1305 for (i = 0; i < INPUT_URBS; ++i) {
1306 buffer = usb_alloc_coherent(umidi->dev, length, GFP_KERNEL,
1307 &ep->urbs[i]->transfer_dma);
1312 if (ep_info->in_interval)
1313 usb_fill_int_urb(ep->urbs[i], umidi->dev,
1314 pipe, buffer, length,
1315 snd_usbmidi_in_urb_complete,
1316 ep, ep_info->in_interval);
1318 usb_fill_bulk_urb(ep->urbs[i], umidi->dev,
1319 pipe, buffer, length,
1320 snd_usbmidi_in_urb_complete, ep);
1321 ep->urbs[i]->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1322 err = usb_urb_ep_type_check(ep->urbs[i]);
1324 dev_err(&umidi->dev->dev, "invalid MIDI in EP %x\n",
1334 snd_usbmidi_in_endpoint_delete(ep);
1339 * Frees an output endpoint.
1340 * May be called when ep hasn't been initialized completely.
1342 static void snd_usbmidi_out_endpoint_clear(struct snd_usb_midi_out_endpoint *ep)
1346 for (i = 0; i < OUTPUT_URBS; ++i)
1347 if (ep->urbs[i].urb) {
1348 free_urb_and_buffer(ep->umidi, ep->urbs[i].urb,
1350 ep->urbs[i].urb = NULL;
1354 static void snd_usbmidi_out_endpoint_delete(struct snd_usb_midi_out_endpoint *ep)
1356 snd_usbmidi_out_endpoint_clear(ep);
1361 * Creates an output endpoint, and initializes output ports.
1363 static int snd_usbmidi_out_endpoint_create(struct snd_usb_midi *umidi,
1364 struct snd_usb_midi_endpoint_info *ep_info,
1365 struct snd_usb_midi_endpoint *rep)
1367 struct snd_usb_midi_out_endpoint *ep;
1374 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1379 for (i = 0; i < OUTPUT_URBS; ++i) {
1380 ep->urbs[i].urb = usb_alloc_urb(0, GFP_KERNEL);
1381 if (!ep->urbs[i].urb) {
1385 ep->urbs[i].ep = ep;
1387 if (ep_info->out_interval)
1388 pipe = usb_sndintpipe(umidi->dev, ep_info->out_ep);
1390 pipe = usb_sndbulkpipe(umidi->dev, ep_info->out_ep);
1391 switch (umidi->usb_id) {
1393 ep->max_transfer = usb_maxpacket(umidi->dev, pipe, 1);
1396 * Various chips declare a packet size larger than 4 bytes, but
1397 * do not actually work with larger packets:
1399 case USB_ID(0x0a67, 0x5011): /* Medeli DD305 */
1400 case USB_ID(0x0a92, 0x1020): /* ESI M4U */
1401 case USB_ID(0x1430, 0x474b): /* RedOctane GH MIDI INTERFACE */
1402 case USB_ID(0x15ca, 0x0101): /* Textech USB Midi Cable */
1403 case USB_ID(0x15ca, 0x1806): /* Textech USB Midi Cable */
1404 case USB_ID(0x1a86, 0x752d): /* QinHeng CH345 "USB2.0-MIDI" */
1405 case USB_ID(0xfc08, 0x0101): /* Unknown vendor Cable */
1406 ep->max_transfer = 4;
1409 * Some devices only work with 9 bytes packet size:
1411 case USB_ID(0x0644, 0x800e): /* Tascam US-122L */
1412 case USB_ID(0x0644, 0x800f): /* Tascam US-144 */
1413 ep->max_transfer = 9;
1416 for (i = 0; i < OUTPUT_URBS; ++i) {
1417 buffer = usb_alloc_coherent(umidi->dev,
1418 ep->max_transfer, GFP_KERNEL,
1419 &ep->urbs[i].urb->transfer_dma);
1424 if (ep_info->out_interval)
1425 usb_fill_int_urb(ep->urbs[i].urb, umidi->dev,
1426 pipe, buffer, ep->max_transfer,
1427 snd_usbmidi_out_urb_complete,
1428 &ep->urbs[i], ep_info->out_interval);
1430 usb_fill_bulk_urb(ep->urbs[i].urb, umidi->dev,
1431 pipe, buffer, ep->max_transfer,
1432 snd_usbmidi_out_urb_complete,
1434 err = usb_urb_ep_type_check(ep->urbs[i].urb);
1436 dev_err(&umidi->dev->dev, "invalid MIDI out EP %x\n",
1440 ep->urbs[i].urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1443 spin_lock_init(&ep->buffer_lock);
1444 INIT_WORK(&ep->work, snd_usbmidi_out_work);
1445 init_waitqueue_head(&ep->drain_wait);
1447 for (i = 0; i < 0x10; ++i)
1448 if (ep_info->out_cables & (1 << i)) {
1449 ep->ports[i].ep = ep;
1450 ep->ports[i].cable = i << 4;
1453 if (umidi->usb_protocol_ops->init_out_endpoint)
1454 umidi->usb_protocol_ops->init_out_endpoint(ep);
1460 snd_usbmidi_out_endpoint_delete(ep);
1467 static void snd_usbmidi_free(struct snd_usb_midi *umidi)
1471 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1472 struct snd_usb_midi_endpoint *ep = &umidi->endpoints[i];
1474 snd_usbmidi_out_endpoint_delete(ep->out);
1476 snd_usbmidi_in_endpoint_delete(ep->in);
1478 mutex_destroy(&umidi->mutex);
1483 * Unlinks all URBs (must be done before the usb_device is deleted).
1485 void snd_usbmidi_disconnect(struct list_head *p)
1487 struct snd_usb_midi *umidi;
1490 umidi = list_entry(p, struct snd_usb_midi, list);
1492 * an URB's completion handler may start the timer and
1493 * a timer may submit an URB. To reliably break the cycle
1494 * a flag under lock must be used
1496 down_write(&umidi->disc_rwsem);
1497 spin_lock_irq(&umidi->disc_lock);
1498 umidi->disconnected = 1;
1499 spin_unlock_irq(&umidi->disc_lock);
1500 up_write(&umidi->disc_rwsem);
1502 del_timer_sync(&umidi->error_timer);
1504 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1505 struct snd_usb_midi_endpoint *ep = &umidi->endpoints[i];
1507 cancel_work_sync(&ep->out->work);
1509 for (j = 0; j < OUTPUT_URBS; ++j)
1510 usb_kill_urb(ep->out->urbs[j].urb);
1511 if (umidi->usb_protocol_ops->finish_out_endpoint)
1512 umidi->usb_protocol_ops->finish_out_endpoint(ep->out);
1513 ep->out->active_urbs = 0;
1514 if (ep->out->drain_urbs) {
1515 ep->out->drain_urbs = 0;
1516 wake_up(&ep->out->drain_wait);
1520 for (j = 0; j < INPUT_URBS; ++j)
1521 usb_kill_urb(ep->in->urbs[j]);
1522 /* free endpoints here; later call can result in Oops */
1524 snd_usbmidi_out_endpoint_clear(ep->out);
1526 snd_usbmidi_in_endpoint_delete(ep->in);
1531 EXPORT_SYMBOL(snd_usbmidi_disconnect);
1533 static void snd_usbmidi_rawmidi_free(struct snd_rawmidi *rmidi)
1535 struct snd_usb_midi *umidi = rmidi->private_data;
1536 snd_usbmidi_free(umidi);
1539 static struct snd_rawmidi_substream *snd_usbmidi_find_substream(struct snd_usb_midi *umidi,
1543 struct snd_rawmidi_substream *substream;
1545 list_for_each_entry(substream, &umidi->rmidi->streams[stream].substreams,
1547 if (substream->number == number)
1554 * This list specifies names for ports that do not fit into the standard
1555 * "(product) MIDI (n)" schema because they aren't external MIDI ports,
1556 * such as internal control or synthesizer ports.
1558 static struct port_info {
1563 unsigned int seq_flags;
1564 } snd_usbmidi_port_info[] = {
1565 #define PORT_INFO(vendor, product, num, name_, voices_, flags) \
1566 { .id = USB_ID(vendor, product), \
1567 .port = num, .voices = voices_, \
1568 .name = name_, .seq_flags = flags }
1569 #define EXTERNAL_PORT(vendor, product, num, name) \
1570 PORT_INFO(vendor, product, num, name, 0, \
1571 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1572 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1573 SNDRV_SEQ_PORT_TYPE_PORT)
1574 #define CONTROL_PORT(vendor, product, num, name) \
1575 PORT_INFO(vendor, product, num, name, 0, \
1576 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1577 SNDRV_SEQ_PORT_TYPE_HARDWARE)
1578 #define GM_SYNTH_PORT(vendor, product, num, name, voices) \
1579 PORT_INFO(vendor, product, num, name, voices, \
1580 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1581 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1582 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1583 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1584 #define ROLAND_SYNTH_PORT(vendor, product, num, name, voices) \
1585 PORT_INFO(vendor, product, num, name, voices, \
1586 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1587 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1588 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1589 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1590 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1591 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1592 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1593 #define SOUNDCANVAS_PORT(vendor, product, num, name, voices) \
1594 PORT_INFO(vendor, product, num, name, voices, \
1595 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1596 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1597 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1598 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1599 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1600 SNDRV_SEQ_PORT_TYPE_MIDI_MT32 | \
1601 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1602 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1603 /* Yamaha MOTIF XF */
1604 GM_SYNTH_PORT(0x0499, 0x105c, 0, "%s Tone Generator", 128),
1605 CONTROL_PORT(0x0499, 0x105c, 1, "%s Remote Control"),
1606 EXTERNAL_PORT(0x0499, 0x105c, 2, "%s Thru"),
1607 CONTROL_PORT(0x0499, 0x105c, 3, "%s Editor"),
1609 CONTROL_PORT(0x0582, 0x0000, 2, "%s Control"),
1610 /* Roland SC-8850 */
1611 SOUNDCANVAS_PORT(0x0582, 0x0003, 0, "%s Part A", 128),
1612 SOUNDCANVAS_PORT(0x0582, 0x0003, 1, "%s Part B", 128),
1613 SOUNDCANVAS_PORT(0x0582, 0x0003, 2, "%s Part C", 128),
1614 SOUNDCANVAS_PORT(0x0582, 0x0003, 3, "%s Part D", 128),
1615 EXTERNAL_PORT(0x0582, 0x0003, 4, "%s MIDI 1"),
1616 EXTERNAL_PORT(0x0582, 0x0003, 5, "%s MIDI 2"),
1618 EXTERNAL_PORT(0x0582, 0x0004, 0, "%s MIDI"),
1619 CONTROL_PORT(0x0582, 0x0004, 1, "%s Control"),
1620 /* Roland SC-8820 */
1621 SOUNDCANVAS_PORT(0x0582, 0x0007, 0, "%s Part A", 64),
1622 SOUNDCANVAS_PORT(0x0582, 0x0007, 1, "%s Part B", 64),
1623 EXTERNAL_PORT(0x0582, 0x0007, 2, "%s MIDI"),
1625 SOUNDCANVAS_PORT(0x0582, 0x000b, 0, "%s Part A", 64),
1626 SOUNDCANVAS_PORT(0x0582, 0x000b, 1, "%s Part B", 64),
1627 EXTERNAL_PORT(0x0582, 0x000b, 2, "%s MIDI"),
1629 SOUNDCANVAS_PORT(0x0582, 0x000c, 0, "%s Part A", 64),
1630 SOUNDCANVAS_PORT(0x0582, 0x000c, 1, "%s Part B", 64),
1631 EXTERNAL_PORT(0x0582, 0x000c, 2, "%s MIDI"),
1633 CONTROL_PORT(0x0582, 0x0014, 8, "%s Control"),
1635 ROLAND_SYNTH_PORT(0x0582, 0x0016, 0, "%s Part A", 128),
1636 ROLAND_SYNTH_PORT(0x0582, 0x0016, 1, "%s Part B", 128),
1637 EXTERNAL_PORT(0x0582, 0x0016, 2, "%s MIDI 1"),
1638 EXTERNAL_PORT(0x0582, 0x0016, 3, "%s MIDI 2"),
1640 CONTROL_PORT(0x0582, 0x0023, 5, "%s Control"),
1642 ROLAND_SYNTH_PORT(0x0582, 0x0027, 0, "%s Part A", 64),
1643 ROLAND_SYNTH_PORT(0x0582, 0x0027, 1, "%s Part B", 64),
1644 EXTERNAL_PORT(0x0582, 0x0027, 2, "%s MIDI"),
1646 ROLAND_SYNTH_PORT(0x0582, 0x0029, 0, "%s Part A", 128),
1647 ROLAND_SYNTH_PORT(0x0582, 0x0029, 1, "%s Part B", 128),
1648 EXTERNAL_PORT(0x0582, 0x0029, 2, "%s MIDI 1"),
1649 EXTERNAL_PORT(0x0582, 0x0029, 3, "%s MIDI 2"),
1651 EXTERNAL_PORT(0x0582, 0x002b, 0, "%s MIDI"),
1652 CONTROL_PORT(0x0582, 0x002b, 1, "%s Control"),
1654 EXTERNAL_PORT(0x0582, 0x002f, 0, "%s MIDI"),
1655 EXTERNAL_PORT(0x0582, 0x002f, 1, "%s External MIDI"),
1656 EXTERNAL_PORT(0x0582, 0x002f, 2, "%s Sync"),
1658 EXTERNAL_PORT(0x0582, 0x0033, 0, "%s MIDI"),
1659 EXTERNAL_PORT(0x0582, 0x0033, 1, "%s 1"),
1660 EXTERNAL_PORT(0x0582, 0x0033, 2, "%s 2"),
1662 EXTERNAL_PORT(0x0582, 0x003b, 0, "%s MIDI"),
1663 CONTROL_PORT(0x0582, 0x003b, 1, "%s Control"),
1664 /* Edirol UA-1000 */
1665 EXTERNAL_PORT(0x0582, 0x0044, 0, "%s MIDI"),
1666 CONTROL_PORT(0x0582, 0x0044, 1, "%s Control"),
1668 EXTERNAL_PORT(0x0582, 0x0048, 0, "%s MIDI"),
1669 EXTERNAL_PORT(0x0582, 0x0048, 1, "%s 1"),
1670 EXTERNAL_PORT(0x0582, 0x0048, 2, "%s 2"),
1672 EXTERNAL_PORT(0x0582, 0x004d, 0, "%s MIDI"),
1673 EXTERNAL_PORT(0x0582, 0x004d, 1, "%s 1"),
1674 EXTERNAL_PORT(0x0582, 0x004d, 2, "%s 2"),
1676 CONTROL_PORT(0x0582, 0x0089, 0, "%s Control"),
1678 CONTROL_PORT(0x0582, 0x009a, 3, "%s Control"),
1680 CONTROL_PORT(0x0582, 0x00b2, 0, "%s Control"),
1681 EXTERNAL_PORT(0x0582, 0x00b2, 1, "%s MIDI"),
1682 /* Cakewalk Sonar V-Studio 100 */
1683 EXTERNAL_PORT(0x0582, 0x00eb, 0, "%s MIDI"),
1684 CONTROL_PORT(0x0582, 0x00eb, 1, "%s Control"),
1686 CONTROL_PORT(0x0582, 0x0102, 0, "%s Control"),
1687 EXTERNAL_PORT(0x0582, 0x0102, 1, "%s MIDI"),
1689 EXTERNAL_PORT(0x0582, 0x010f, 0, "%s MIDI"),
1690 CONTROL_PORT(0x0582, 0x010f, 1, "%s 1"),
1691 CONTROL_PORT(0x0582, 0x010f, 2, "%s 2"),
1693 ROLAND_SYNTH_PORT(0x0582, 0x0114, 0, "%s Synth", 128),
1694 EXTERNAL_PORT(0x0582, 0x0114, 1, "%s MIDI"),
1695 CONTROL_PORT(0x0582, 0x0114, 2, "%s Control"),
1696 /* Roland OCTA-CAPTURE */
1697 EXTERNAL_PORT(0x0582, 0x0120, 0, "%s MIDI"),
1698 CONTROL_PORT(0x0582, 0x0120, 1, "%s Control"),
1699 EXTERNAL_PORT(0x0582, 0x0121, 0, "%s MIDI"),
1700 CONTROL_PORT(0x0582, 0x0121, 1, "%s Control"),
1702 CONTROL_PORT(0x0582, 0x0145, 0, "%s Control"),
1703 EXTERNAL_PORT(0x0582, 0x0145, 1, "%s MIDI"),
1704 /* Roland A-Series */
1705 CONTROL_PORT(0x0582, 0x0156, 0, "%s Keyboard"),
1706 EXTERNAL_PORT(0x0582, 0x0156, 1, "%s MIDI"),
1707 /* Roland INTEGRA-7 */
1708 ROLAND_SYNTH_PORT(0x0582, 0x015b, 0, "%s Synth", 128),
1709 CONTROL_PORT(0x0582, 0x015b, 1, "%s Control"),
1710 /* M-Audio MidiSport 8x8 */
1711 CONTROL_PORT(0x0763, 0x1031, 8, "%s Control"),
1712 CONTROL_PORT(0x0763, 0x1033, 8, "%s Control"),
1714 EXTERNAL_PORT(0x07fd, 0x0001, 0, "%s MIDI A"),
1715 EXTERNAL_PORT(0x07fd, 0x0001, 1, "%s MIDI B"),
1716 /* Emagic Unitor8/AMT8/MT4 */
1717 EXTERNAL_PORT(0x086a, 0x0001, 8, "%s Broadcast"),
1718 EXTERNAL_PORT(0x086a, 0x0002, 8, "%s Broadcast"),
1719 EXTERNAL_PORT(0x086a, 0x0003, 4, "%s Broadcast"),
1721 CONTROL_PORT(0x09e8, 0x0062, 0, "%s Control"),
1722 PORT_INFO(0x09e8, 0x0062, 1, "%s MIDI", 0,
1723 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC |
1724 SNDRV_SEQ_PORT_TYPE_HARDWARE),
1725 /* Access Music Virus TI */
1726 EXTERNAL_PORT(0x133e, 0x0815, 0, "%s MIDI"),
1727 PORT_INFO(0x133e, 0x0815, 1, "%s Synth", 0,
1728 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC |
1729 SNDRV_SEQ_PORT_TYPE_HARDWARE |
1730 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER),
1733 static struct port_info *find_port_info(struct snd_usb_midi *umidi, int number)
1737 for (i = 0; i < ARRAY_SIZE(snd_usbmidi_port_info); ++i) {
1738 if (snd_usbmidi_port_info[i].id == umidi->usb_id &&
1739 snd_usbmidi_port_info[i].port == number)
1740 return &snd_usbmidi_port_info[i];
1745 static void snd_usbmidi_get_port_info(struct snd_rawmidi *rmidi, int number,
1746 struct snd_seq_port_info *seq_port_info)
1748 struct snd_usb_midi *umidi = rmidi->private_data;
1749 struct port_info *port_info;
1751 /* TODO: read port flags from descriptors */
1752 port_info = find_port_info(umidi, number);
1754 seq_port_info->type = port_info->seq_flags;
1755 seq_port_info->midi_voices = port_info->voices;
1759 static void snd_usbmidi_init_substream(struct snd_usb_midi *umidi,
1760 int stream, int number,
1761 struct snd_rawmidi_substream **rsubstream)
1763 struct port_info *port_info;
1764 const char *name_format;
1766 struct snd_rawmidi_substream *substream =
1767 snd_usbmidi_find_substream(umidi, stream, number);
1769 dev_err(&umidi->dev->dev, "substream %d:%d not found\n", stream,
1774 /* TODO: read port name from jack descriptor */
1775 port_info = find_port_info(umidi, number);
1776 name_format = port_info ? port_info->name : "%s MIDI %d";
1777 snprintf(substream->name, sizeof(substream->name),
1778 name_format, umidi->card->shortname, number + 1);
1780 *rsubstream = substream;
1784 * Creates the endpoints and their ports.
1786 static int snd_usbmidi_create_endpoints(struct snd_usb_midi *umidi,
1787 struct snd_usb_midi_endpoint_info *endpoints)
1790 int out_ports = 0, in_ports = 0;
1792 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1793 if (endpoints[i].out_cables) {
1794 err = snd_usbmidi_out_endpoint_create(umidi,
1796 &umidi->endpoints[i]);
1800 if (endpoints[i].in_cables) {
1801 err = snd_usbmidi_in_endpoint_create(umidi,
1803 &umidi->endpoints[i]);
1808 for (j = 0; j < 0x10; ++j) {
1809 if (endpoints[i].out_cables & (1 << j)) {
1810 snd_usbmidi_init_substream(umidi,
1811 SNDRV_RAWMIDI_STREAM_OUTPUT,
1813 &umidi->endpoints[i].out->ports[j].substream);
1816 if (endpoints[i].in_cables & (1 << j)) {
1817 snd_usbmidi_init_substream(umidi,
1818 SNDRV_RAWMIDI_STREAM_INPUT,
1820 &umidi->endpoints[i].in->ports[j].substream);
1825 dev_dbg(&umidi->dev->dev, "created %d output and %d input ports\n",
1826 out_ports, in_ports);
1830 static struct usb_ms_endpoint_descriptor *find_usb_ms_endpoint_descriptor(
1831 struct usb_host_endpoint *hostep)
1833 unsigned char *extra = hostep->extra;
1834 int extralen = hostep->extralen;
1836 while (extralen > 3) {
1837 struct usb_ms_endpoint_descriptor *ms_ep =
1838 (struct usb_ms_endpoint_descriptor *)extra;
1840 if (ms_ep->bLength > 3 &&
1841 ms_ep->bDescriptorType == USB_DT_CS_ENDPOINT &&
1842 ms_ep->bDescriptorSubtype == UAC_MS_GENERAL)
1846 extralen -= extra[0];
1853 * Returns MIDIStreaming device capabilities.
1855 static int snd_usbmidi_get_ms_info(struct snd_usb_midi *umidi,
1856 struct snd_usb_midi_endpoint_info *endpoints)
1858 struct usb_interface *intf;
1859 struct usb_host_interface *hostif;
1860 struct usb_interface_descriptor *intfd;
1861 struct usb_ms_header_descriptor *ms_header;
1862 struct usb_host_endpoint *hostep;
1863 struct usb_endpoint_descriptor *ep;
1864 struct usb_ms_endpoint_descriptor *ms_ep;
1867 intf = umidi->iface;
1870 hostif = &intf->altsetting[0];
1871 intfd = get_iface_desc(hostif);
1872 ms_header = (struct usb_ms_header_descriptor *)hostif->extra;
1873 if (hostif->extralen >= 7 &&
1874 ms_header->bLength >= 7 &&
1875 ms_header->bDescriptorType == USB_DT_CS_INTERFACE &&
1876 ms_header->bDescriptorSubtype == UAC_HEADER)
1877 dev_dbg(&umidi->dev->dev, "MIDIStreaming version %02x.%02x\n",
1878 ms_header->bcdMSC[1], ms_header->bcdMSC[0]);
1880 dev_warn(&umidi->dev->dev,
1881 "MIDIStreaming interface descriptor not found\n");
1884 for (i = 0; i < intfd->bNumEndpoints; ++i) {
1885 hostep = &hostif->endpoint[i];
1886 ep = get_ep_desc(hostep);
1887 if (!usb_endpoint_xfer_bulk(ep) && !usb_endpoint_xfer_int(ep))
1889 ms_ep = find_usb_ms_endpoint_descriptor(hostep);
1892 if (ms_ep->bNumEmbMIDIJack > 0x10)
1894 if (usb_endpoint_dir_out(ep)) {
1895 if (endpoints[epidx].out_ep) {
1896 if (++epidx >= MIDI_MAX_ENDPOINTS) {
1897 dev_warn(&umidi->dev->dev,
1898 "too many endpoints\n");
1902 endpoints[epidx].out_ep = usb_endpoint_num(ep);
1903 if (usb_endpoint_xfer_int(ep))
1904 endpoints[epidx].out_interval = ep->bInterval;
1905 else if (snd_usb_get_speed(umidi->dev) == USB_SPEED_LOW)
1907 * Low speed bulk transfers don't exist, so
1908 * force interrupt transfers for devices like
1909 * ESI MIDI Mate that try to use them anyway.
1911 endpoints[epidx].out_interval = 1;
1912 endpoints[epidx].out_cables =
1913 (1 << ms_ep->bNumEmbMIDIJack) - 1;
1914 dev_dbg(&umidi->dev->dev, "EP %02X: %d jack(s)\n",
1915 ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1917 if (endpoints[epidx].in_ep) {
1918 if (++epidx >= MIDI_MAX_ENDPOINTS) {
1919 dev_warn(&umidi->dev->dev,
1920 "too many endpoints\n");
1924 endpoints[epidx].in_ep = usb_endpoint_num(ep);
1925 if (usb_endpoint_xfer_int(ep))
1926 endpoints[epidx].in_interval = ep->bInterval;
1927 else if (snd_usb_get_speed(umidi->dev) == USB_SPEED_LOW)
1928 endpoints[epidx].in_interval = 1;
1929 endpoints[epidx].in_cables =
1930 (1 << ms_ep->bNumEmbMIDIJack) - 1;
1931 dev_dbg(&umidi->dev->dev, "EP %02X: %d jack(s)\n",
1932 ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1938 static int roland_load_info(struct snd_kcontrol *kcontrol,
1939 struct snd_ctl_elem_info *info)
1941 static const char *const names[] = { "High Load", "Light Load" };
1943 return snd_ctl_enum_info(info, 1, 2, names);
1946 static int roland_load_get(struct snd_kcontrol *kcontrol,
1947 struct snd_ctl_elem_value *value)
1949 value->value.enumerated.item[0] = kcontrol->private_value;
1953 static int roland_load_put(struct snd_kcontrol *kcontrol,
1954 struct snd_ctl_elem_value *value)
1956 struct snd_usb_midi *umidi = kcontrol->private_data;
1959 if (value->value.enumerated.item[0] > 1)
1961 mutex_lock(&umidi->mutex);
1962 changed = value->value.enumerated.item[0] != kcontrol->private_value;
1964 kcontrol->private_value = value->value.enumerated.item[0];
1965 mutex_unlock(&umidi->mutex);
1969 static const struct snd_kcontrol_new roland_load_ctl = {
1970 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1971 .name = "MIDI Input Mode",
1972 .info = roland_load_info,
1973 .get = roland_load_get,
1974 .put = roland_load_put,
1979 * On Roland devices, use the second alternate setting to be able to use
1980 * the interrupt input endpoint.
1982 static void snd_usbmidi_switch_roland_altsetting(struct snd_usb_midi *umidi)
1984 struct usb_interface *intf;
1985 struct usb_host_interface *hostif;
1986 struct usb_interface_descriptor *intfd;
1988 intf = umidi->iface;
1989 if (!intf || intf->num_altsetting != 2)
1992 hostif = &intf->altsetting[1];
1993 intfd = get_iface_desc(hostif);
1994 /* If either or both of the endpoints support interrupt transfer,
1995 * then use the alternate setting
1997 if (intfd->bNumEndpoints != 2 ||
1998 !((get_endpoint(hostif, 0)->bmAttributes &
1999 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT ||
2000 (get_endpoint(hostif, 1)->bmAttributes &
2001 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT))
2004 dev_dbg(&umidi->dev->dev, "switching to altsetting %d with int ep\n",
2005 intfd->bAlternateSetting);
2006 usb_set_interface(umidi->dev, intfd->bInterfaceNumber,
2007 intfd->bAlternateSetting);
2009 umidi->roland_load_ctl = snd_ctl_new1(&roland_load_ctl, umidi);
2010 if (snd_ctl_add(umidi->card, umidi->roland_load_ctl) < 0)
2011 umidi->roland_load_ctl = NULL;
2015 * Try to find any usable endpoints in the interface.
2017 static int snd_usbmidi_detect_endpoints(struct snd_usb_midi *umidi,
2018 struct snd_usb_midi_endpoint_info *endpoint,
2021 struct usb_interface *intf;
2022 struct usb_host_interface *hostif;
2023 struct usb_interface_descriptor *intfd;
2024 struct usb_endpoint_descriptor *epd;
2025 int i, out_eps = 0, in_eps = 0;
2027 if (USB_ID_VENDOR(umidi->usb_id) == 0x0582)
2028 snd_usbmidi_switch_roland_altsetting(umidi);
2030 if (endpoint[0].out_ep || endpoint[0].in_ep)
2033 intf = umidi->iface;
2034 if (!intf || intf->num_altsetting < 1)
2036 hostif = intf->cur_altsetting;
2037 intfd = get_iface_desc(hostif);
2039 for (i = 0; i < intfd->bNumEndpoints; ++i) {
2040 epd = get_endpoint(hostif, i);
2041 if (!usb_endpoint_xfer_bulk(epd) &&
2042 !usb_endpoint_xfer_int(epd))
2044 if (out_eps < max_endpoints &&
2045 usb_endpoint_dir_out(epd)) {
2046 endpoint[out_eps].out_ep = usb_endpoint_num(epd);
2047 if (usb_endpoint_xfer_int(epd))
2048 endpoint[out_eps].out_interval = epd->bInterval;
2051 if (in_eps < max_endpoints &&
2052 usb_endpoint_dir_in(epd)) {
2053 endpoint[in_eps].in_ep = usb_endpoint_num(epd);
2054 if (usb_endpoint_xfer_int(epd))
2055 endpoint[in_eps].in_interval = epd->bInterval;
2059 return (out_eps || in_eps) ? 0 : -ENOENT;
2063 * Detects the endpoints for one-port-per-endpoint protocols.
2065 static int snd_usbmidi_detect_per_port_endpoints(struct snd_usb_midi *umidi,
2066 struct snd_usb_midi_endpoint_info *endpoints)
2070 err = snd_usbmidi_detect_endpoints(umidi, endpoints, MIDI_MAX_ENDPOINTS);
2071 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
2072 if (endpoints[i].out_ep)
2073 endpoints[i].out_cables = 0x0001;
2074 if (endpoints[i].in_ep)
2075 endpoints[i].in_cables = 0x0001;
2081 * Detects the endpoints and ports of Yamaha devices.
2083 static int snd_usbmidi_detect_yamaha(struct snd_usb_midi *umidi,
2084 struct snd_usb_midi_endpoint_info *endpoint)
2086 struct usb_interface *intf;
2087 struct usb_host_interface *hostif;
2088 struct usb_interface_descriptor *intfd;
2091 intf = umidi->iface;
2094 hostif = intf->altsetting;
2095 intfd = get_iface_desc(hostif);
2096 if (intfd->bNumEndpoints < 1)
2100 * For each port there is one MIDI_IN/OUT_JACK descriptor, not
2101 * necessarily with any useful contents. So simply count 'em.
2103 for (cs_desc = hostif->extra;
2104 cs_desc < hostif->extra + hostif->extralen && cs_desc[0] >= 2;
2105 cs_desc += cs_desc[0]) {
2106 if (cs_desc[1] == USB_DT_CS_INTERFACE) {
2107 if (cs_desc[2] == UAC_MIDI_IN_JACK)
2108 endpoint->in_cables =
2109 (endpoint->in_cables << 1) | 1;
2110 else if (cs_desc[2] == UAC_MIDI_OUT_JACK)
2111 endpoint->out_cables =
2112 (endpoint->out_cables << 1) | 1;
2115 if (!endpoint->in_cables && !endpoint->out_cables)
2118 return snd_usbmidi_detect_endpoints(umidi, endpoint, 1);
2122 * Detects the endpoints and ports of Roland devices.
2124 static int snd_usbmidi_detect_roland(struct snd_usb_midi *umidi,
2125 struct snd_usb_midi_endpoint_info *endpoint)
2127 struct usb_interface *intf;
2128 struct usb_host_interface *hostif;
2131 intf = umidi->iface;
2134 hostif = intf->altsetting;
2136 * Some devices have a descriptor <06 24 F1 02 <inputs> <outputs>>,
2137 * some have standard class descriptors, or both kinds, or neither.
2139 for (cs_desc = hostif->extra;
2140 cs_desc < hostif->extra + hostif->extralen && cs_desc[0] >= 2;
2141 cs_desc += cs_desc[0]) {
2142 if (cs_desc[0] >= 6 &&
2143 cs_desc[1] == USB_DT_CS_INTERFACE &&
2144 cs_desc[2] == 0xf1 &&
2145 cs_desc[3] == 0x02) {
2146 if (cs_desc[4] > 0x10 || cs_desc[5] > 0x10)
2148 endpoint->in_cables = (1 << cs_desc[4]) - 1;
2149 endpoint->out_cables = (1 << cs_desc[5]) - 1;
2150 return snd_usbmidi_detect_endpoints(umidi, endpoint, 1);
2151 } else if (cs_desc[0] >= 7 &&
2152 cs_desc[1] == USB_DT_CS_INTERFACE &&
2153 cs_desc[2] == UAC_HEADER) {
2154 return snd_usbmidi_get_ms_info(umidi, endpoint);
2162 * Creates the endpoints and their ports for Midiman devices.
2164 static int snd_usbmidi_create_endpoints_midiman(struct snd_usb_midi *umidi,
2165 struct snd_usb_midi_endpoint_info *endpoint)
2167 struct snd_usb_midi_endpoint_info ep_info;
2168 struct usb_interface *intf;
2169 struct usb_host_interface *hostif;
2170 struct usb_interface_descriptor *intfd;
2171 struct usb_endpoint_descriptor *epd;
2174 intf = umidi->iface;
2177 hostif = intf->altsetting;
2178 intfd = get_iface_desc(hostif);
2180 * The various MidiSport devices have more or less random endpoint
2181 * numbers, so we have to identify the endpoints by their index in
2182 * the descriptor array, like the driver for that other OS does.
2184 * There is one interrupt input endpoint for all input ports, one
2185 * bulk output endpoint for even-numbered ports, and one for odd-
2186 * numbered ports. Both bulk output endpoints have corresponding
2187 * input bulk endpoints (at indices 1 and 3) which aren't used.
2189 if (intfd->bNumEndpoints < (endpoint->out_cables > 0x0001 ? 5 : 3)) {
2190 dev_dbg(&umidi->dev->dev, "not enough endpoints\n");
2194 epd = get_endpoint(hostif, 0);
2195 if (!usb_endpoint_dir_in(epd) || !usb_endpoint_xfer_int(epd)) {
2196 dev_dbg(&umidi->dev->dev, "endpoint[0] isn't interrupt\n");
2199 epd = get_endpoint(hostif, 2);
2200 if (!usb_endpoint_dir_out(epd) || !usb_endpoint_xfer_bulk(epd)) {
2201 dev_dbg(&umidi->dev->dev, "endpoint[2] isn't bulk output\n");
2204 if (endpoint->out_cables > 0x0001) {
2205 epd = get_endpoint(hostif, 4);
2206 if (!usb_endpoint_dir_out(epd) ||
2207 !usb_endpoint_xfer_bulk(epd)) {
2208 dev_dbg(&umidi->dev->dev,
2209 "endpoint[4] isn't bulk output\n");
2214 ep_info.out_ep = get_endpoint(hostif, 2)->bEndpointAddress &
2215 USB_ENDPOINT_NUMBER_MASK;
2216 ep_info.out_interval = 0;
2217 ep_info.out_cables = endpoint->out_cables & 0x5555;
2218 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info,
2219 &umidi->endpoints[0]);
2223 ep_info.in_ep = get_endpoint(hostif, 0)->bEndpointAddress &
2224 USB_ENDPOINT_NUMBER_MASK;
2225 ep_info.in_interval = get_endpoint(hostif, 0)->bInterval;
2226 ep_info.in_cables = endpoint->in_cables;
2227 err = snd_usbmidi_in_endpoint_create(umidi, &ep_info,
2228 &umidi->endpoints[0]);
2232 if (endpoint->out_cables > 0x0001) {
2233 ep_info.out_ep = get_endpoint(hostif, 4)->bEndpointAddress &
2234 USB_ENDPOINT_NUMBER_MASK;
2235 ep_info.out_cables = endpoint->out_cables & 0xaaaa;
2236 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info,
2237 &umidi->endpoints[1]);
2242 for (cable = 0; cable < 0x10; ++cable) {
2243 if (endpoint->out_cables & (1 << cable))
2244 snd_usbmidi_init_substream(umidi,
2245 SNDRV_RAWMIDI_STREAM_OUTPUT,
2247 &umidi->endpoints[cable & 1].out->ports[cable].substream);
2248 if (endpoint->in_cables & (1 << cable))
2249 snd_usbmidi_init_substream(umidi,
2250 SNDRV_RAWMIDI_STREAM_INPUT,
2252 &umidi->endpoints[0].in->ports[cable].substream);
2257 static const struct snd_rawmidi_global_ops snd_usbmidi_ops = {
2258 .get_port_info = snd_usbmidi_get_port_info,
2261 static int snd_usbmidi_create_rawmidi(struct snd_usb_midi *umidi,
2262 int out_ports, int in_ports)
2264 struct snd_rawmidi *rmidi;
2267 err = snd_rawmidi_new(umidi->card, "USB MIDI",
2268 umidi->next_midi_device++,
2269 out_ports, in_ports, &rmidi);
2272 strcpy(rmidi->name, umidi->card->shortname);
2273 rmidi->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT |
2274 SNDRV_RAWMIDI_INFO_INPUT |
2275 SNDRV_RAWMIDI_INFO_DUPLEX;
2276 rmidi->ops = &snd_usbmidi_ops;
2277 rmidi->private_data = umidi;
2278 rmidi->private_free = snd_usbmidi_rawmidi_free;
2279 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT,
2280 &snd_usbmidi_output_ops);
2281 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT,
2282 &snd_usbmidi_input_ops);
2284 umidi->rmidi = rmidi;
2289 * Temporarily stop input.
2291 void snd_usbmidi_input_stop(struct list_head *p)
2293 struct snd_usb_midi *umidi;
2296 umidi = list_entry(p, struct snd_usb_midi, list);
2297 if (!umidi->input_running)
2299 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
2300 struct snd_usb_midi_endpoint *ep = &umidi->endpoints[i];
2302 for (j = 0; j < INPUT_URBS; ++j)
2303 usb_kill_urb(ep->in->urbs[j]);
2305 umidi->input_running = 0;
2307 EXPORT_SYMBOL(snd_usbmidi_input_stop);
2309 static void snd_usbmidi_input_start_ep(struct snd_usb_midi *umidi,
2310 struct snd_usb_midi_in_endpoint *ep)
2313 unsigned long flags;
2317 for (i = 0; i < INPUT_URBS; ++i) {
2318 struct urb *urb = ep->urbs[i];
2319 spin_lock_irqsave(&umidi->disc_lock, flags);
2320 if (!atomic_read(&urb->use_count)) {
2321 urb->dev = ep->umidi->dev;
2322 snd_usbmidi_submit_urb(urb, GFP_ATOMIC);
2324 spin_unlock_irqrestore(&umidi->disc_lock, flags);
2329 * Resume input after a call to snd_usbmidi_input_stop().
2331 void snd_usbmidi_input_start(struct list_head *p)
2333 struct snd_usb_midi *umidi;
2336 umidi = list_entry(p, struct snd_usb_midi, list);
2337 if (umidi->input_running || !umidi->opened[1])
2339 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
2340 snd_usbmidi_input_start_ep(umidi, umidi->endpoints[i].in);
2341 umidi->input_running = 1;
2343 EXPORT_SYMBOL(snd_usbmidi_input_start);
2346 * Prepare for suspend. Typically called from the USB suspend callback.
2348 void snd_usbmidi_suspend(struct list_head *p)
2350 struct snd_usb_midi *umidi;
2352 umidi = list_entry(p, struct snd_usb_midi, list);
2353 mutex_lock(&umidi->mutex);
2354 snd_usbmidi_input_stop(p);
2355 mutex_unlock(&umidi->mutex);
2357 EXPORT_SYMBOL(snd_usbmidi_suspend);
2360 * Resume. Typically called from the USB resume callback.
2362 void snd_usbmidi_resume(struct list_head *p)
2364 struct snd_usb_midi *umidi;
2366 umidi = list_entry(p, struct snd_usb_midi, list);
2367 mutex_lock(&umidi->mutex);
2368 snd_usbmidi_input_start(p);
2369 mutex_unlock(&umidi->mutex);
2371 EXPORT_SYMBOL(snd_usbmidi_resume);
2374 * Creates and registers everything needed for a MIDI streaming interface.
2376 int __snd_usbmidi_create(struct snd_card *card,
2377 struct usb_interface *iface,
2378 struct list_head *midi_list,
2379 const struct snd_usb_audio_quirk *quirk,
2380 unsigned int usb_id)
2382 struct snd_usb_midi *umidi;
2383 struct snd_usb_midi_endpoint_info endpoints[MIDI_MAX_ENDPOINTS];
2384 int out_ports, in_ports;
2387 umidi = kzalloc(sizeof(*umidi), GFP_KERNEL);
2390 umidi->dev = interface_to_usbdev(iface);
2392 umidi->iface = iface;
2393 umidi->quirk = quirk;
2394 umidi->usb_protocol_ops = &snd_usbmidi_standard_ops;
2395 spin_lock_init(&umidi->disc_lock);
2396 init_rwsem(&umidi->disc_rwsem);
2397 mutex_init(&umidi->mutex);
2399 usb_id = USB_ID(le16_to_cpu(umidi->dev->descriptor.idVendor),
2400 le16_to_cpu(umidi->dev->descriptor.idProduct));
2401 umidi->usb_id = usb_id;
2402 timer_setup(&umidi->error_timer, snd_usbmidi_error_timer, 0);
2404 /* detect the endpoint(s) to use */
2405 memset(endpoints, 0, sizeof(endpoints));
2406 switch (quirk ? quirk->type : QUIRK_MIDI_STANDARD_INTERFACE) {
2407 case QUIRK_MIDI_STANDARD_INTERFACE:
2408 err = snd_usbmidi_get_ms_info(umidi, endpoints);
2409 if (umidi->usb_id == USB_ID(0x0763, 0x0150)) /* M-Audio Uno */
2410 umidi->usb_protocol_ops =
2411 &snd_usbmidi_maudio_broken_running_status_ops;
2413 case QUIRK_MIDI_US122L:
2414 umidi->usb_protocol_ops = &snd_usbmidi_122l_ops;
2416 case QUIRK_MIDI_FIXED_ENDPOINT:
2417 memcpy(&endpoints[0], quirk->data,
2418 sizeof(struct snd_usb_midi_endpoint_info));
2419 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
2421 case QUIRK_MIDI_YAMAHA:
2422 err = snd_usbmidi_detect_yamaha(umidi, &endpoints[0]);
2424 case QUIRK_MIDI_ROLAND:
2425 err = snd_usbmidi_detect_roland(umidi, &endpoints[0]);
2427 case QUIRK_MIDI_MIDIMAN:
2428 umidi->usb_protocol_ops = &snd_usbmidi_midiman_ops;
2429 memcpy(&endpoints[0], quirk->data,
2430 sizeof(struct snd_usb_midi_endpoint_info));
2433 case QUIRK_MIDI_NOVATION:
2434 umidi->usb_protocol_ops = &snd_usbmidi_novation_ops;
2435 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2437 case QUIRK_MIDI_RAW_BYTES:
2438 umidi->usb_protocol_ops = &snd_usbmidi_raw_ops;
2440 * Interface 1 contains isochronous endpoints, but with the same
2441 * numbers as in interface 0. Since it is interface 1 that the
2442 * USB core has most recently seen, these descriptors are now
2443 * associated with the endpoint numbers. This will foul up our
2444 * attempts to submit bulk/interrupt URBs to the endpoints in
2445 * interface 0, so we have to make sure that the USB core looks
2446 * again at interface 0 by calling usb_set_interface() on it.
2448 if (umidi->usb_id == USB_ID(0x07fd, 0x0001)) /* MOTU Fastlane */
2449 usb_set_interface(umidi->dev, 0, 0);
2450 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2452 case QUIRK_MIDI_EMAGIC:
2453 umidi->usb_protocol_ops = &snd_usbmidi_emagic_ops;
2454 memcpy(&endpoints[0], quirk->data,
2455 sizeof(struct snd_usb_midi_endpoint_info));
2456 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
2458 case QUIRK_MIDI_CME:
2459 umidi->usb_protocol_ops = &snd_usbmidi_cme_ops;
2460 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2462 case QUIRK_MIDI_AKAI:
2463 umidi->usb_protocol_ops = &snd_usbmidi_akai_ops;
2464 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2465 /* endpoint 1 is input-only */
2466 endpoints[1].out_cables = 0;
2468 case QUIRK_MIDI_FTDI:
2469 umidi->usb_protocol_ops = &snd_usbmidi_ftdi_ops;
2471 /* set baud rate to 31250 (48 MHz / 16 / 96) */
2472 err = usb_control_msg(umidi->dev, usb_sndctrlpipe(umidi->dev, 0),
2473 3, 0x40, 0x60, 0, NULL, 0, 1000);
2477 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2479 case QUIRK_MIDI_CH345:
2480 umidi->usb_protocol_ops = &snd_usbmidi_ch345_broken_sysex_ops;
2481 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2484 dev_err(&umidi->dev->dev, "invalid quirk type %d\n",
2492 /* create rawmidi device */
2495 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
2496 out_ports += hweight16(endpoints[i].out_cables);
2497 in_ports += hweight16(endpoints[i].in_cables);
2499 err = snd_usbmidi_create_rawmidi(umidi, out_ports, in_ports);
2503 /* create endpoint/port structures */
2504 if (quirk && quirk->type == QUIRK_MIDI_MIDIMAN)
2505 err = snd_usbmidi_create_endpoints_midiman(umidi, &endpoints[0]);
2507 err = snd_usbmidi_create_endpoints(umidi, endpoints);
2511 usb_autopm_get_interface_no_resume(umidi->iface);
2513 list_add_tail(&umidi->list, midi_list);
2521 EXPORT_SYMBOL(__snd_usbmidi_create);