2 * usbmidi.c - ALSA USB MIDI driver
4 * Copyright (c) 2002-2004 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 <sound/driver.h>
39 #include <linux/kernel.h>
40 #include <linux/types.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/usb.h>
47 #include <sound/core.h>
48 #include <sound/minors.h>
49 #include <sound/rawmidi.h>
52 struct usb_ms_header_descriptor {
55 __u8 bDescriptorSubtype;
58 } __attribute__ ((packed));
60 struct usb_ms_endpoint_descriptor {
63 __u8 bDescriptorSubtype;
65 __u8 baAssocJackID[0];
66 } __attribute__ ((packed));
68 typedef struct snd_usb_midi snd_usb_midi_t;
69 typedef struct snd_usb_midi_endpoint snd_usb_midi_endpoint_t;
70 typedef struct snd_usb_midi_out_endpoint snd_usb_midi_out_endpoint_t;
71 typedef struct snd_usb_midi_in_endpoint snd_usb_midi_in_endpoint_t;
72 typedef struct usbmidi_out_port usbmidi_out_port_t;
73 typedef struct usbmidi_in_port usbmidi_in_port_t;
76 snd_usb_audio_t *chip;
77 struct usb_interface *iface;
78 const snd_usb_audio_quirk_t *quirk;
80 struct list_head list;
82 struct snd_usb_midi_endpoint {
83 snd_usb_midi_out_endpoint_t *out;
84 snd_usb_midi_in_endpoint_t *in;
85 } endpoints[MIDI_MAX_ENDPOINTS];
88 struct snd_usb_midi_out_endpoint {
89 snd_usb_midi_t* umidi;
91 int max_transfer; /* size of urb buffer */
92 struct tasklet_struct tasklet;
94 spinlock_t buffer_lock;
96 struct usbmidi_out_port {
97 snd_usb_midi_out_endpoint_t* ep;
98 snd_rawmidi_substream_t* substream;
100 uint8_t cable; /* cable number << 4 */
102 #define STATE_UNKNOWN 0
103 #define STATE_1PARAM 1
104 #define STATE_2PARAM_1 2
105 #define STATE_2PARAM_2 3
106 #define STATE_SYSEX_0 4
107 #define STATE_SYSEX_1 5
108 #define STATE_SYSEX_2 6
113 struct snd_usb_midi_in_endpoint {
114 snd_usb_midi_t* umidi;
116 struct usbmidi_in_port {
117 snd_rawmidi_substream_t* substream;
121 static void snd_usbmidi_do_output(snd_usb_midi_out_endpoint_t* ep);
123 static const uint8_t snd_usbmidi_cin_length[] = {
124 0, 0, 2, 3, 3, 1, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1
128 * Submits the URB, with error handling.
130 static int snd_usbmidi_submit_urb(struct urb* urb, int flags)
132 int err = usb_submit_urb(urb, flags);
133 if (err < 0 && err != -ENODEV)
134 snd_printk(KERN_ERR "usb_submit_urb: %d\n", err);
139 * Error handling for URB completion functions.
141 static int snd_usbmidi_urb_error(int status)
143 if (status == -ENOENT)
144 return status; /* killed */
145 if (status == -EILSEQ ||
146 status == -ECONNRESET ||
147 status == -ETIMEDOUT)
148 return -ENODEV; /* device removed/shutdown */
149 snd_printk(KERN_ERR "urb status %d\n", status);
150 return 0; /* continue */
154 * Receives a USB MIDI packet.
156 static void snd_usbmidi_input_packet(snd_usb_midi_in_endpoint_t* ep,
159 int cable = packet[0] >> 4;
160 usbmidi_in_port_t* port = &ep->ports[cable];
162 if (!port->substream) {
163 snd_printd("unexpected port %d!\n", cable);
166 if (!port->substream->runtime ||
167 !port->substream->runtime->trigger)
169 snd_rawmidi_receive(port->substream, &packet[1],
170 snd_usbmidi_cin_length[packet[0] & 0x0f]);
174 * Processes the data read from the device.
176 static void snd_usbmidi_in_urb_complete(struct urb* urb, struct pt_regs *regs)
178 snd_usb_midi_in_endpoint_t* ep = snd_magic_cast(snd_usb_midi_in_endpoint_t, urb->context, return);
180 if (urb->status == 0) {
181 uint8_t* buffer = (uint8_t*)ep->urb->transfer_buffer;
184 for (i = 0; i + 4 <= urb->actual_length; i += 4)
186 snd_usbmidi_input_packet(ep, &buffer[i]);
188 if (snd_usbmidi_urb_error(urb->status) < 0)
192 if (usb_pipe_needs_resubmit(urb->pipe)) {
193 urb->dev = ep->umidi->chip->dev;
194 snd_usbmidi_submit_urb(urb, GFP_ATOMIC);
199 * Converts the data read from a Midiman device to standard USB MIDI packets.
201 static void snd_usbmidi_in_midiman_complete(struct urb* urb, struct pt_regs *regs)
203 if (urb->status == 0) {
204 uint8_t* buffer = (uint8_t*)urb->transfer_buffer;
207 for (i = 0; i + 4 <= urb->actual_length; i += 4) {
208 if (buffer[i + 3] != 0) {
210 * snd_usbmidi_input_packet() doesn't check the
211 * contents of the message, so we simply use
212 * some random CIN with the desired length.
214 static const uint8_t cin[4] = {
217 uint8_t ctl = buffer[i + 3];
218 buffer[i + 3] = buffer[i + 2];
219 buffer[i + 2] = buffer[i + 1];
220 buffer[i + 1] = buffer[i + 0];
221 buffer[i + 0] = (ctl & 0xf0) | cin[ctl & 3];
227 snd_usbmidi_in_urb_complete(urb, regs);
230 static void snd_usbmidi_out_urb_complete(struct urb* urb, struct pt_regs *regs)
232 snd_usb_midi_out_endpoint_t* ep = snd_magic_cast(snd_usb_midi_out_endpoint_t, urb->context, return);
234 if (urb->status < 0) {
235 if (snd_usbmidi_urb_error(urb->status) < 0)
238 snd_usbmidi_do_output(ep);
242 * Converts standard USB MIDI packets to what Midman devices expect.
244 static void snd_usbmidi_convert_to_midiman(struct urb* urb)
246 uint8_t* buffer = (uint8_t*)urb->transfer_buffer;
249 for (i = 0; i + 4 <= urb->transfer_buffer_length; i += 4) {
250 uint8_t cin = buffer[i];
251 buffer[i + 0] = buffer[i + 1];
252 buffer[i + 1] = buffer[i + 2];
253 buffer[i + 2] = buffer[i + 3];
254 buffer[i + 3] = (cin & 0xf0) | snd_usbmidi_cin_length[cin & 0x0f];
259 * Adds one USB MIDI packet to the output buffer.
261 static inline void output_packet(struct urb* urb,
262 uint8_t p0, uint8_t p1, uint8_t p2, uint8_t p3)
265 uint8_t* buf = (uint8_t*)urb->transfer_buffer + urb->transfer_buffer_length;
270 urb->transfer_buffer_length += 4;
274 * Converts MIDI commands to USB MIDI packets.
276 static void snd_usbmidi_transmit_byte(usbmidi_out_port_t* port,
277 uint8_t b, struct urb* urb)
279 uint8_t p0 = port->cable;
282 output_packet(urb, p0 | 0x0f, b, 0, 0);
283 } else if (b >= 0xf0) {
287 port->state = STATE_SYSEX_1;
292 port->state = STATE_1PARAM;
296 port->state = STATE_2PARAM_1;
300 port->state = STATE_UNKNOWN;
303 output_packet(urb, p0 | 0x05, 0xf6, 0, 0);
304 port->state = STATE_UNKNOWN;
307 switch (port->state) {
309 output_packet(urb, p0 | 0x05, 0xf7, 0, 0);
312 output_packet(urb, p0 | 0x06, port->data[0], 0xf7, 0);
315 output_packet(urb, p0 | 0x07, port->data[0], port->data[1], 0xf7);
318 port->state = STATE_UNKNOWN;
321 } else if (b >= 0x80) {
323 if (b >= 0xc0 && b <= 0xdf)
324 port->state = STATE_1PARAM;
326 port->state = STATE_2PARAM_1;
327 } else { /* b < 0x80 */
328 switch (port->state) {
330 if (port->data[0] < 0xf0) {
331 p0 |= port->data[0] >> 4;
334 port->state = STATE_UNKNOWN;
336 output_packet(urb, p0, port->data[0], b, 0);
340 port->state = STATE_2PARAM_2;
343 if (port->data[0] < 0xf0) {
344 p0 |= port->data[0] >> 4;
345 port->state = STATE_2PARAM_1;
348 port->state = STATE_UNKNOWN;
350 output_packet(urb, p0, port->data[0], port->data[1], b);
354 port->state = STATE_SYSEX_1;
358 port->state = STATE_SYSEX_2;
361 output_packet(urb, p0 | 0x04, port->data[0], port->data[1], b);
362 port->state = STATE_SYSEX_0;
369 * Moves data from one substream buffer to the URB transfer buffer.
371 static void snd_usbmidi_transmit(snd_usb_midi_out_endpoint_t* ep, int port_idx)
373 struct urb* urb = ep->urb;
374 usbmidi_out_port_t* port = &ep->ports[port_idx];
376 while (urb->transfer_buffer_length < ep->max_transfer) {
378 if (snd_rawmidi_transmit_peek(port->substream, &b, 1) != 1) {
382 snd_usbmidi_transmit_byte(port, b, urb);
383 snd_rawmidi_transmit_ack(port->substream, 1);
388 * This is called when some data should be transferred to the device
389 * (from one or more substreams).
391 static void snd_usbmidi_do_output(snd_usb_midi_out_endpoint_t* ep)
394 struct urb* urb = ep->urb;
397 spin_lock_irqsave(&ep->buffer_lock, flags);
398 if (urb->status == -EINPROGRESS || ep->umidi->chip->shutdown) {
399 spin_unlock_irqrestore(&ep->buffer_lock, flags);
403 urb->transfer_buffer_length = 0;
404 for (p= 0; p < 0x10; ++p)
405 if (ep->ports[p].active)
406 snd_usbmidi_transmit(ep, p);
408 if (urb->transfer_buffer_length > 0) {
409 if (ep->umidi->quirk && ep->umidi->quirk->type == QUIRK_MIDI_MIDIMAN)
410 snd_usbmidi_convert_to_midiman(urb);
412 urb->dev = ep->umidi->chip->dev;
413 snd_usbmidi_submit_urb(urb, GFP_ATOMIC);
415 spin_unlock_irqrestore(&ep->buffer_lock, flags);
418 static void snd_usbmidi_out_tasklet(unsigned long data)
420 snd_usb_midi_out_endpoint_t* ep = snd_magic_cast(snd_usb_midi_out_endpoint_t, (void*)data, return);
422 snd_usbmidi_do_output(ep);
425 static int snd_usbmidi_output_open(snd_rawmidi_substream_t* substream)
427 snd_usb_midi_t* umidi = snd_magic_cast(snd_usb_midi_t, substream->rmidi->private_data, return -ENXIO);
428 usbmidi_out_port_t* port = NULL;
431 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
432 if (umidi->endpoints[i].out)
433 for (j = 0; j < 0x10; ++j)
434 if (umidi->endpoints[i].out->ports[j].substream == substream) {
435 port = &umidi->endpoints[i].out->ports[j];
442 substream->runtime->private_data = port;
443 port->state = STATE_UNKNOWN;
447 static int snd_usbmidi_output_close(snd_rawmidi_substream_t* substream)
452 static void snd_usbmidi_output_trigger(snd_rawmidi_substream_t* substream, int up)
454 usbmidi_out_port_t* port = (usbmidi_out_port_t*)substream->runtime->private_data;
458 if (port->ep->umidi->chip->shutdown) {
459 /* gobble up remaining bytes to prevent wait in
460 * snd_rawmidi_drain_output */
461 while (!snd_rawmidi_transmit_empty(substream))
462 snd_rawmidi_transmit_ack(substream, 1);
465 tasklet_hi_schedule(&port->ep->tasklet);
469 static int snd_usbmidi_input_open(snd_rawmidi_substream_t* substream)
474 static int snd_usbmidi_input_close(snd_rawmidi_substream_t* substream)
479 static void snd_usbmidi_input_trigger(snd_rawmidi_substream_t* substream, int up)
483 static snd_rawmidi_ops_t snd_usbmidi_output_ops = {
484 .open = snd_usbmidi_output_open,
485 .close = snd_usbmidi_output_close,
486 .trigger = snd_usbmidi_output_trigger,
489 static snd_rawmidi_ops_t snd_usbmidi_input_ops = {
490 .open = snd_usbmidi_input_open,
491 .close = snd_usbmidi_input_close,
492 .trigger = snd_usbmidi_input_trigger
496 * Frees an input endpoint.
497 * May be called when ep hasn't been initialized completely.
499 static void snd_usbmidi_in_endpoint_delete(snd_usb_midi_in_endpoint_t* ep)
502 if (ep->urb->transfer_buffer)
503 kfree(ep->urb->transfer_buffer);
504 usb_free_urb(ep->urb);
510 * For Roland devices, use the alternate setting which uses interrupt
511 * transfers for input.
513 static struct usb_endpoint_descriptor* snd_usbmidi_get_int_epd(snd_usb_midi_t* umidi)
515 struct usb_interface* intf;
516 struct usb_host_interface *hostif;
517 struct usb_interface_descriptor* intfd;
519 if (umidi->chip->dev->descriptor.idVendor != 0x0582)
522 if (!intf || intf->num_altsetting != 2)
525 hostif = &intf->altsetting[0];
526 intfd = get_iface_desc(hostif);
527 if (intfd->bNumEndpoints != 2 ||
528 (get_endpoint(hostif, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK ||
529 (get_endpoint(hostif, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK)
532 hostif = &intf->altsetting[1];
533 intfd = get_iface_desc(hostif);
534 if (intfd->bNumEndpoints != 2 ||
535 (get_endpoint(hostif, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK ||
536 (get_endpoint(hostif, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
539 snd_printdd(KERN_INFO "switching to altsetting %d with int ep\n",
540 intfd->bAlternateSetting);
541 usb_set_interface(umidi->chip->dev, intfd->bInterfaceNumber,
542 intfd->bAlternateSetting);
543 return get_endpoint(hostif, 1);
546 static struct usb_endpoint_descriptor* snd_usbmidi_get_midiman_int_epd(snd_usb_midi_t* umidi)
548 struct usb_interface* intf = umidi->iface;
549 struct usb_host_interface *hostif;
550 struct usb_interface_descriptor *intfd;
553 hostif = &intf->altsetting[0];
554 intfd = get_iface_desc(hostif);
555 if (intfd->bNumEndpoints < 1)
557 return get_endpoint(hostif, 0);
561 * Creates an input endpoint.
563 static int snd_usbmidi_in_endpoint_create(snd_usb_midi_t* umidi,
564 snd_usb_midi_endpoint_info_t* ep_info,
565 snd_usb_midi_endpoint_t* rep)
567 snd_usb_midi_in_endpoint_t* ep;
568 struct usb_endpoint_descriptor* int_epd;
574 ep = snd_magic_kcalloc(snd_usb_midi_in_endpoint_t, 0, GFP_KERNEL);
579 if (umidi->quirk && umidi->quirk->type == QUIRK_MIDI_MIDIMAN)
580 int_epd = snd_usbmidi_get_midiman_int_epd(umidi);
582 int_epd = snd_usbmidi_get_int_epd(umidi);
584 ep->urb = usb_alloc_urb(0, GFP_KERNEL);
586 snd_usbmidi_in_endpoint_delete(ep);
590 pipe = usb_rcvintpipe(umidi->chip->dev, ep_info->in_ep);
592 pipe = usb_rcvbulkpipe(umidi->chip->dev, ep_info->in_ep);
593 length = usb_maxpacket(umidi->chip->dev, pipe, 0);
594 buffer = kmalloc(length, GFP_KERNEL);
596 snd_usbmidi_in_endpoint_delete(ep);
600 usb_fill_int_urb(ep->urb, umidi->chip->dev, pipe, buffer, length,
601 snd_usb_complete_callback(snd_usbmidi_in_urb_complete),
602 ep, int_epd->bInterval);
604 usb_fill_bulk_urb(ep->urb, umidi->chip->dev, pipe, buffer, length,
605 snd_usb_complete_callback(snd_usbmidi_in_urb_complete),
612 static int snd_usbmidi_count_bits(uint16_t x)
616 for (i = 0; i < 16; ++i)
617 bits += (x & (1 << i)) != 0;
622 * Frees an output endpoint.
623 * May be called when ep hasn't been initialized completely.
625 static void snd_usbmidi_out_endpoint_delete(snd_usb_midi_out_endpoint_t* ep)
627 if (ep->tasklet.func)
628 tasklet_kill(&ep->tasklet);
630 if (ep->urb->transfer_buffer)
631 kfree(ep->urb->transfer_buffer);
632 usb_free_urb(ep->urb);
638 * Creates an output endpoint, and initializes output ports.
640 static int snd_usbmidi_out_endpoint_create(snd_usb_midi_t* umidi,
641 snd_usb_midi_endpoint_info_t* ep_info,
642 snd_usb_midi_endpoint_t* rep)
644 snd_usb_midi_out_endpoint_t* ep;
650 ep = snd_magic_kcalloc(snd_usb_midi_out_endpoint_t, 0, GFP_KERNEL);
655 ep->urb = usb_alloc_urb(0, GFP_KERNEL);
657 snd_usbmidi_out_endpoint_delete(ep);
660 pipe = usb_sndbulkpipe(umidi->chip->dev, ep_info->out_ep);
661 ep->max_transfer = usb_maxpacket(umidi->chip->dev, pipe, 1) & ~3;
662 buffer = kmalloc(ep->max_transfer, GFP_KERNEL);
664 snd_usbmidi_out_endpoint_delete(ep);
667 usb_fill_bulk_urb(ep->urb, umidi->chip->dev, pipe, buffer,
669 snd_usb_complete_callback(snd_usbmidi_out_urb_complete), ep);
671 spin_lock_init(&ep->buffer_lock);
672 tasklet_init(&ep->tasklet, snd_usbmidi_out_tasklet, (unsigned long)ep);
674 for (i = 0; i < 0x10; ++i)
675 if (ep_info->out_cables & (1 << i)) {
676 ep->ports[i].ep = ep;
677 ep->ports[i].cable = i << 4;
687 static void snd_usbmidi_free(snd_usb_midi_t* umidi)
691 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
692 snd_usb_midi_endpoint_t* ep = &umidi->endpoints[i];
694 snd_usbmidi_out_endpoint_delete(ep->out);
696 snd_usbmidi_in_endpoint_delete(ep->in);
698 snd_magic_kfree(umidi);
702 * Unlinks all URBs (must be done before the usb_device is deleted).
704 void snd_usbmidi_disconnect(struct list_head* p, struct usb_driver *driver)
706 snd_usb_midi_t* umidi;
709 umidi = list_entry(p, snd_usb_midi_t, list);
710 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
711 snd_usb_midi_endpoint_t* ep = &umidi->endpoints[i];
712 if (ep->out && ep->out->urb)
713 usb_unlink_urb(ep->out->urb);
714 if (ep->in && ep->in->urb)
715 usb_unlink_urb(ep->in->urb);
719 static void snd_usbmidi_rawmidi_free(snd_rawmidi_t* rmidi)
721 snd_usb_midi_t* umidi = snd_magic_cast(snd_usb_midi_t, rmidi->private_data, return);
722 snd_usbmidi_free(umidi);
725 static snd_rawmidi_substream_t* snd_usbmidi_find_substream(snd_usb_midi_t* umidi,
726 int stream, int number)
728 struct list_head* list;
730 list_for_each(list, &umidi->rmidi->streams[stream].substreams) {
731 snd_rawmidi_substream_t* substream = list_entry(list, snd_rawmidi_substream_t, list);
732 if (substream->number == number)
739 * This list specifies names for ports that do not fit into the standard
740 * "(product) MIDI (n)" schema because they aren't external MIDI ports,
741 * such as internal control or synthesizer ports.
747 const char *name_format;
748 } snd_usbmidi_port_names[] = {
750 {0x0582, 0x0000, 2, "%s Control"},
752 {0x0582, 0x0003, 0, "%s Part A"},
753 {0x0582, 0x0003, 1, "%s Part B"},
754 {0x0582, 0x0003, 2, "%s Part C"},
755 {0x0582, 0x0003, 3, "%s Part D"},
756 {0x0582, 0x0003, 4, "%s MIDI 1"},
757 {0x0582, 0x0003, 5, "%s MIDI 2"},
759 {0x0582, 0x0004, 0, "%s MIDI"},
760 {0x0582, 0x0004, 1, "%s Control"},
762 {0x0582, 0x0007, 0, "%s Part A"},
763 {0x0582, 0x0007, 1, "%s Part B"},
764 {0x0582, 0x0007, 2, "%s MIDI"},
766 {0x0582, 0x000b, 0, "%s Part A"},
767 {0x0582, 0x000b, 1, "%s Part B"},
768 {0x0582, 0x000b, 2, "%s MIDI"},
770 {0x0582, 0x000c, 0, "%s Part A"},
771 {0x0582, 0x000c, 1, "%s Part B"},
772 {0x0582, 0x000c, 2, "%s MIDI"},
774 {0x0582, 0x0014, 8, "%s Control"},
776 {0x0582, 0x0016, 0, "%s Part A"},
777 {0x0582, 0x0016, 1, "%s Part B"},
778 {0x0582, 0x0016, 2, "%s MIDI 1"},
779 {0x0582, 0x0016, 3, "%s MIDI 2"},
781 {0x0582, 0x0023, 5, "%s Control"},
783 {0x0582, 0x0027, 0, "%s Part A"},
784 {0x0582, 0x0027, 1, "%s Part B"},
785 {0x0582, 0x0027, 2, "%s MIDI"},
787 {0x0582, 0x0029, 0, "%s Part A"},
788 {0x0582, 0x0029, 1, "%s Part B"},
789 {0x0582, 0x0029, 2, "%s MIDI 1"},
790 {0x0582, 0x0029, 3, "%s MIDI 2"},
792 {0x0582, 0x002b, 0, "%s MIDI"},
793 {0x0582, 0x002b, 1, "%s Control"},
795 {0x0582, 0x002f, 0, "%s MIDI"},
796 {0x0582, 0x002f, 1, "%s External MIDI"},
797 {0x0582, 0x002f, 2, "%s Sync"},
799 {0x0582, 0x0033, 0, "%s MIDI"},
800 {0x0582, 0x0033, 1, "%s 1"},
801 {0x0582, 0x0033, 2, "%s 2"},
803 {0x0582, 0x003b, 0, "%s MIDI"},
804 {0x0582, 0x003b, 1, "%s Control"},
806 {0x0582, 0x0044, 0, "%s MIDI"},
807 {0x0582, 0x0044, 1, "%s Control"},
809 {0x0582, 0x0048, 0, "%s MIDI"},
810 {0x0582, 0x0048, 1, "%s 1"},
811 {0x0582, 0x0048, 2, "%s 2"},
813 {0x0582, 0x004d, 0, "%s MIDI"},
814 {0x0582, 0x004d, 1, "%s 1"},
815 {0x0582, 0x004d, 2, "%s 2"},
816 /* M-Audio MidiSport 8x8 */
817 {0x0763, 0x1031, 8, "%s Control"},
818 {0x0763, 0x1033, 8, "%s Control"},
821 static void snd_usbmidi_init_substream(snd_usb_midi_t* umidi,
822 int stream, int number,
823 snd_rawmidi_substream_t** rsubstream)
826 __u16 vendor, product;
827 const char *name_format;
829 snd_rawmidi_substream_t* substream = snd_usbmidi_find_substream(umidi, stream, number);
831 snd_printd(KERN_ERR "substream %d:%d not found\n", stream, number);
835 /* TODO: read port name from jack descriptor */
836 name_format = "%s MIDI %d";
837 vendor = umidi->chip->dev->descriptor.idVendor;
838 product = umidi->chip->dev->descriptor.idProduct;
839 for (i = 0; i < ARRAY_SIZE(snd_usbmidi_port_names); ++i) {
840 if (snd_usbmidi_port_names[i].vendor == vendor &&
841 snd_usbmidi_port_names[i].product == product &&
842 snd_usbmidi_port_names[i].port == number) {
843 name_format = snd_usbmidi_port_names[i].name_format;
847 snprintf(substream->name, sizeof(substream->name),
848 name_format, umidi->chip->card->shortname, number + 1);
850 *rsubstream = substream;
854 * Creates the endpoints and their ports.
856 static int snd_usbmidi_create_endpoints(snd_usb_midi_t* umidi,
857 snd_usb_midi_endpoint_info_t* endpoints)
860 int out_ports = 0, in_ports = 0;
862 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
863 if (endpoints[i].out_cables) {
864 err = snd_usbmidi_out_endpoint_create(umidi, &endpoints[i],
865 &umidi->endpoints[i]);
869 if (endpoints[i].in_cables) {
870 err = snd_usbmidi_in_endpoint_create(umidi, &endpoints[i],
871 &umidi->endpoints[i]);
876 for (j = 0; j < 0x10; ++j) {
877 if (endpoints[i].out_cables & (1 << j)) {
878 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_OUTPUT, out_ports,
879 &umidi->endpoints[i].out->ports[j].substream);
882 if (endpoints[i].in_cables & (1 << j)) {
883 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_INPUT, in_ports,
884 &umidi->endpoints[i].in->ports[j].substream);
889 snd_printdd(KERN_INFO "created %d output and %d input ports\n",
890 out_ports, in_ports);
895 * Returns MIDIStreaming device capabilities.
897 static int snd_usbmidi_get_ms_info(snd_usb_midi_t* umidi,
898 snd_usb_midi_endpoint_info_t* endpoints)
900 struct usb_interface* intf;
901 struct usb_host_interface *hostif;
902 struct usb_interface_descriptor* intfd;
903 struct usb_ms_header_descriptor* ms_header;
904 struct usb_host_endpoint *hostep;
905 struct usb_endpoint_descriptor* ep;
906 struct usb_ms_endpoint_descriptor* ms_ep;
912 hostif = &intf->altsetting[0];
913 intfd = get_iface_desc(hostif);
914 ms_header = (struct usb_ms_header_descriptor*)hostif->extra;
915 if (hostif->extralen >= 7 &&
916 ms_header->bLength >= 7 &&
917 ms_header->bDescriptorType == USB_DT_CS_INTERFACE &&
918 ms_header->bDescriptorSubtype == HEADER)
919 snd_printdd(KERN_INFO "MIDIStreaming version %02x.%02x\n",
920 ms_header->bcdMSC[1], ms_header->bcdMSC[0]);
922 snd_printk(KERN_WARNING "MIDIStreaming interface descriptor not found\n");
925 for (i = 0; i < intfd->bNumEndpoints; ++i) {
926 hostep = &hostif->endpoint[i];
927 ep = get_ep_desc(hostep);
928 if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK)
930 ms_ep = (struct usb_ms_endpoint_descriptor*)hostep->extra;
931 if (hostep->extralen < 4 ||
932 ms_ep->bLength < 4 ||
933 ms_ep->bDescriptorType != USB_DT_CS_ENDPOINT ||
934 ms_ep->bDescriptorSubtype != MS_GENERAL)
936 if ((ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) {
937 if (endpoints[epidx].out_ep) {
938 if (++epidx >= MIDI_MAX_ENDPOINTS) {
939 snd_printk(KERN_WARNING "too many endpoints\n");
943 endpoints[epidx].out_ep = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
944 endpoints[epidx].out_cables = (1 << ms_ep->bNumEmbMIDIJack) - 1;
945 snd_printdd(KERN_INFO "EP %02X: %d jack(s)\n",
946 ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
948 if (endpoints[epidx].in_ep) {
949 if (++epidx >= MIDI_MAX_ENDPOINTS) {
950 snd_printk(KERN_WARNING "too many endpoints\n");
954 endpoints[epidx].in_ep = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
955 endpoints[epidx].in_cables = (1 << ms_ep->bNumEmbMIDIJack) - 1;
956 snd_printdd(KERN_INFO "EP %02X: %d jack(s)\n",
957 ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
964 * If the endpoints aren't specified, use the first bulk endpoints in the
965 * first alternate setting of the interface.
967 static int snd_usbmidi_detect_endpoint(snd_usb_midi_t* umidi,
968 snd_usb_midi_endpoint_info_t* endpoint)
970 struct usb_interface* intf;
971 struct usb_host_interface *hostif;
972 struct usb_interface_descriptor* intfd;
973 struct usb_endpoint_descriptor* epd;
977 if (!intf || intf->num_altsetting < 1)
979 hostif = intf->altsetting;
980 intfd = get_iface_desc(hostif);
981 if (intfd->bNumEndpoints < 1)
984 for (i = 0; i < intfd->bNumEndpoints; ++i) {
985 epd = get_endpoint(hostif, i);
986 if ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK)
988 if (!endpoint->out_ep && endpoint->out_cables &&
989 (epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT)
990 endpoint->out_ep = epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
991 if (!endpoint->in_ep && endpoint->in_cables &&
992 (epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN)
993 endpoint->in_ep = epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
999 * Detects the endpoints and ports of Yamaha devices.
1001 static int snd_usbmidi_detect_yamaha(snd_usb_midi_t* umidi,
1002 snd_usb_midi_endpoint_info_t* endpoint)
1004 struct usb_interface* intf;
1005 struct usb_host_interface *hostif;
1006 struct usb_interface_descriptor* intfd;
1009 intf = umidi->iface;
1012 hostif = intf->altsetting;
1013 intfd = get_iface_desc(hostif);
1014 if (intfd->bNumEndpoints < 1)
1018 * For each port there is one MIDI_IN/OUT_JACK descriptor, not
1019 * necessarily with any useful contents. So simply count 'em.
1021 for (cs_desc = hostif->extra;
1022 cs_desc < hostif->extra + hostif->extralen && cs_desc[0] >= 2;
1023 cs_desc += cs_desc[0]) {
1024 if (cs_desc[1] == CS_AUDIO_INTERFACE) {
1025 if (cs_desc[2] == MIDI_IN_JACK)
1026 endpoint->in_cables = (endpoint->in_cables << 1) | 1;
1027 else if (cs_desc[2] == MIDI_OUT_JACK)
1028 endpoint->out_cables = (endpoint->out_cables << 1) | 1;
1031 if (!endpoint->in_cables && !endpoint->out_cables)
1034 return snd_usbmidi_detect_endpoint(umidi, endpoint);
1038 * Creates the endpoints and their ports for Midiman devices.
1040 static int snd_usbmidi_create_endpoints_midiman(snd_usb_midi_t* umidi,
1041 snd_usb_midi_endpoint_info_t* endpoint)
1043 snd_usb_midi_endpoint_info_t ep_info;
1044 struct usb_interface* intf;
1045 struct usb_host_interface *hostif;
1046 struct usb_interface_descriptor* intfd;
1047 struct usb_endpoint_descriptor* epd;
1050 intf = umidi->iface;
1053 hostif = intf->altsetting;
1054 intfd = get_iface_desc(hostif);
1056 * The various MidiSport devices have more or less random endpoint
1057 * numbers, so we have to identify the endpoints by their index in
1058 * the descriptor array, like the driver for that other OS does.
1060 * There is one interrupt input endpoint for all input ports, one
1061 * bulk output endpoint for even-numbered ports, and one for odd-
1062 * numbered ports. Both bulk output endpoints have corresponding
1063 * input bulk endpoints (at indices 1 and 3) which aren't used.
1065 if (intfd->bNumEndpoints < (endpoint->out_cables > 0x0001 ? 5 : 3)) {
1066 snd_printdd(KERN_ERR "not enough endpoints\n");
1070 epd = get_endpoint(hostif, 0);
1071 if ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) != USB_DIR_IN ||
1072 (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT) {
1073 snd_printdd(KERN_ERR "endpoint[0] isn't interrupt\n");
1076 epd = get_endpoint(hostif, 2);
1077 if ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) != USB_DIR_OUT ||
1078 (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) {
1079 snd_printdd(KERN_ERR "endpoint[2] isn't bulk output\n");
1082 if (endpoint->out_cables > 0x0001) {
1083 epd = get_endpoint(hostif, 4);
1084 if ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) != USB_DIR_OUT ||
1085 (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) {
1086 snd_printdd(KERN_ERR "endpoint[4] isn't bulk output\n");
1091 ep_info.out_ep = get_endpoint(hostif, 2)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1092 ep_info.out_cables = endpoint->out_cables & 0x5555;
1093 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info, &umidi->endpoints[0]);
1097 ep_info.in_ep = get_endpoint(hostif, 0)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1098 ep_info.in_cables = endpoint->in_cables;
1099 err = snd_usbmidi_in_endpoint_create(umidi, &ep_info, &umidi->endpoints[0]);
1102 umidi->endpoints[0].in->urb->complete = snd_usb_complete_callback(snd_usbmidi_in_midiman_complete);
1104 if (endpoint->out_cables > 0x0001) {
1105 ep_info.out_ep = get_endpoint(hostif, 4)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1106 ep_info.out_cables = endpoint->out_cables & 0xaaaa;
1107 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info, &umidi->endpoints[1]);
1112 for (cable = 0; cable < 0x10; ++cable) {
1113 if (endpoint->out_cables & (1 << cable))
1114 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_OUTPUT, cable,
1115 &umidi->endpoints[cable & 1].out->ports[cable].substream);
1116 if (endpoint->in_cables & (1 << cable))
1117 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_INPUT, cable,
1118 &umidi->endpoints[0].in->ports[cable].substream);
1123 static int snd_usbmidi_create_rawmidi(snd_usb_midi_t* umidi,
1124 int out_ports, int in_ports)
1126 snd_rawmidi_t* rmidi;
1129 err = snd_rawmidi_new(umidi->chip->card, "USB MIDI",
1130 umidi->chip->next_midi_device++,
1131 out_ports, in_ports, &rmidi);
1134 strcpy(rmidi->name, umidi->chip->card->shortname);
1135 rmidi->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT |
1136 SNDRV_RAWMIDI_INFO_INPUT |
1137 SNDRV_RAWMIDI_INFO_DUPLEX;
1138 rmidi->private_data = umidi;
1139 rmidi->private_free = snd_usbmidi_rawmidi_free;
1140 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_usbmidi_output_ops);
1141 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_usbmidi_input_ops);
1143 umidi->rmidi = rmidi;
1148 * Creates and registers everything needed for a MIDI streaming interface.
1150 int snd_usb_create_midi_interface(snd_usb_audio_t* chip,
1151 struct usb_interface* iface,
1152 const snd_usb_audio_quirk_t* quirk)
1154 snd_usb_midi_t* umidi;
1155 snd_usb_midi_endpoint_info_t endpoints[MIDI_MAX_ENDPOINTS];
1156 int out_ports, in_ports;
1159 umidi = snd_magic_kcalloc(snd_usb_midi_t, 0, GFP_KERNEL);
1163 umidi->iface = iface;
1164 umidi->quirk = quirk;
1166 /* detect the endpoint(s) to use */
1167 memset(endpoints, 0, sizeof(endpoints));
1169 err = snd_usbmidi_get_ms_info(umidi, endpoints);
1171 switch (quirk->type) {
1172 case QUIRK_MIDI_FIXED_ENDPOINT:
1173 memcpy(&endpoints[0], quirk->data,
1174 sizeof(snd_usb_midi_endpoint_info_t));
1175 err = snd_usbmidi_detect_endpoint(umidi, &endpoints[0]);
1177 case QUIRK_MIDI_YAMAHA:
1178 err = snd_usbmidi_detect_yamaha(umidi, &endpoints[0]);
1180 case QUIRK_MIDI_MIDIMAN:
1181 memcpy(&endpoints[0], quirk->data,
1182 sizeof(snd_usb_midi_endpoint_info_t));
1186 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
1192 snd_magic_kfree(umidi);
1196 /* create rawmidi device */
1199 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1200 out_ports += snd_usbmidi_count_bits(endpoints[i].out_cables);
1201 in_ports += snd_usbmidi_count_bits(endpoints[i].in_cables);
1203 err = snd_usbmidi_create_rawmidi(umidi, out_ports, in_ports);
1205 snd_magic_kfree(umidi);
1209 /* create endpoint/port structures */
1210 if (quirk && quirk->type == QUIRK_MIDI_MIDIMAN)
1211 err = snd_usbmidi_create_endpoints_midiman(umidi, &endpoints[0]);
1213 err = snd_usbmidi_create_endpoints(umidi, endpoints);
1215 snd_usbmidi_free(umidi);
1219 list_add(&umidi->list, &umidi->chip->midi_list);
1221 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
1222 if (umidi->endpoints[i].in)
1223 snd_usbmidi_submit_urb(umidi->endpoints[i].in->urb,