2 * usbmidi.c - ALSA USB MIDI driver
4 * Copyright (c) 2002-2007 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 <sound/core.h>
49 #include <sound/rawmidi.h>
50 #include <sound/asequencer.h>
55 * define this to log all USB packets
57 /* #define DUMP_PACKETS */
60 * how long to wait after some USB errors, so that khubd can disconnect() us
61 * without too many spurious errors
63 #define ERROR_DELAY_JIFFIES (HZ / 10)
66 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
67 MODULE_DESCRIPTION("USB Audio/MIDI helper module");
68 MODULE_LICENSE("Dual BSD/GPL");
71 struct usb_ms_header_descriptor
{
74 __u8 bDescriptorSubtype
;
77 } __attribute__ ((packed
));
79 struct usb_ms_endpoint_descriptor
{
82 __u8 bDescriptorSubtype
;
84 __u8 baAssocJackID
[0];
85 } __attribute__ ((packed
));
87 struct snd_usb_midi_in_endpoint
;
88 struct snd_usb_midi_out_endpoint
;
89 struct snd_usb_midi_endpoint
;
91 struct usb_protocol_ops
{
92 void (*input
)(struct snd_usb_midi_in_endpoint
*, uint8_t*, int);
93 void (*output
)(struct snd_usb_midi_out_endpoint
*);
94 void (*output_packet
)(struct urb
*, uint8_t, uint8_t, uint8_t, uint8_t);
95 void (*init_out_endpoint
)(struct snd_usb_midi_out_endpoint
*);
96 void (*finish_out_endpoint
)(struct snd_usb_midi_out_endpoint
*);
100 struct snd_usb_audio
*chip
;
101 struct usb_interface
*iface
;
102 const struct snd_usb_audio_quirk
*quirk
;
103 struct snd_rawmidi
*rmidi
;
104 struct usb_protocol_ops
* usb_protocol_ops
;
105 struct list_head list
;
106 struct timer_list error_timer
;
107 spinlock_t disc_lock
;
109 struct snd_usb_midi_endpoint
{
110 struct snd_usb_midi_out_endpoint
*out
;
111 struct snd_usb_midi_in_endpoint
*in
;
112 } endpoints
[MIDI_MAX_ENDPOINTS
];
113 unsigned long input_triggered
;
114 unsigned char disconnected
;
117 struct snd_usb_midi_out_endpoint
{
118 struct snd_usb_midi
* umidi
;
121 int max_transfer
; /* size of urb buffer */
122 struct tasklet_struct tasklet
;
124 spinlock_t buffer_lock
;
126 struct usbmidi_out_port
{
127 struct snd_usb_midi_out_endpoint
* ep
;
128 struct snd_rawmidi_substream
*substream
;
130 uint8_t cable
; /* cable number << 4 */
132 #define STATE_UNKNOWN 0
133 #define STATE_1PARAM 1
134 #define STATE_2PARAM_1 2
135 #define STATE_2PARAM_2 3
136 #define STATE_SYSEX_0 4
137 #define STATE_SYSEX_1 5
138 #define STATE_SYSEX_2 6
144 struct snd_usb_midi_in_endpoint
{
145 struct snd_usb_midi
* umidi
;
147 struct usbmidi_in_port
{
148 struct snd_rawmidi_substream
*substream
;
149 u8 running_status_length
;
156 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint
* ep
);
158 static const uint8_t snd_usbmidi_cin_length
[] = {
159 0, 0, 2, 3, 3, 1, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1
163 * Submits the URB, with error handling.
165 static int snd_usbmidi_submit_urb(struct urb
* urb
, gfp_t flags
)
167 int err
= usb_submit_urb(urb
, flags
);
168 if (err
< 0 && err
!= -ENODEV
)
169 snd_printk(KERN_ERR
"usb_submit_urb: %d\n", err
);
174 * Error handling for URB completion functions.
176 static int snd_usbmidi_urb_error(int status
)
179 /* manually unlinked, or device gone */
185 /* errors that might occur during unplugging */
191 snd_printk(KERN_ERR
"urb status %d\n", status
);
192 return 0; /* continue */
197 * Receives a chunk of MIDI data.
199 static void snd_usbmidi_input_data(struct snd_usb_midi_in_endpoint
* ep
, int portidx
,
200 uint8_t* data
, int length
)
202 struct usbmidi_in_port
* port
= &ep
->ports
[portidx
];
204 if (!port
->substream
) {
205 snd_printd("unexpected port %d!\n", portidx
);
208 if (!test_bit(port
->substream
->number
, &ep
->umidi
->input_triggered
))
210 snd_rawmidi_receive(port
->substream
, data
, length
);
214 static void dump_urb(const char *type
, const u8
*data
, int length
)
216 snd_printk(KERN_DEBUG
"%s packet: [", type
);
217 for (; length
> 0; ++data
, --length
)
218 printk(" %02x", *data
);
222 #define dump_urb(type, data, length) /* nothing */
226 * Processes the data read from the device.
228 static void snd_usbmidi_in_urb_complete(struct urb
* urb
)
230 struct snd_usb_midi_in_endpoint
* ep
= urb
->context
;
232 if (urb
->status
== 0) {
233 dump_urb("received", urb
->transfer_buffer
, urb
->actual_length
);
234 ep
->umidi
->usb_protocol_ops
->input(ep
, urb
->transfer_buffer
,
237 int err
= snd_usbmidi_urb_error(urb
->status
);
239 if (err
!= -ENODEV
) {
240 ep
->error_resubmit
= 1;
241 mod_timer(&ep
->umidi
->error_timer
,
242 jiffies
+ ERROR_DELAY_JIFFIES
);
248 urb
->dev
= ep
->umidi
->chip
->dev
;
249 snd_usbmidi_submit_urb(urb
, GFP_ATOMIC
);
252 static void snd_usbmidi_out_urb_complete(struct urb
* urb
)
254 struct snd_usb_midi_out_endpoint
* ep
= urb
->context
;
256 spin_lock(&ep
->buffer_lock
);
258 spin_unlock(&ep
->buffer_lock
);
259 if (urb
->status
< 0) {
260 int err
= snd_usbmidi_urb_error(urb
->status
);
263 mod_timer(&ep
->umidi
->error_timer
,
264 jiffies
+ ERROR_DELAY_JIFFIES
);
268 snd_usbmidi_do_output(ep
);
272 * This is called when some data should be transferred to the device
273 * (from one or more substreams).
275 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint
* ep
)
277 struct urb
* urb
= ep
->urb
;
280 spin_lock_irqsave(&ep
->buffer_lock
, flags
);
281 if (ep
->urb_active
|| ep
->umidi
->chip
->shutdown
) {
282 spin_unlock_irqrestore(&ep
->buffer_lock
, flags
);
286 urb
->transfer_buffer_length
= 0;
287 ep
->umidi
->usb_protocol_ops
->output(ep
);
289 if (urb
->transfer_buffer_length
> 0) {
290 dump_urb("sending", urb
->transfer_buffer
,
291 urb
->transfer_buffer_length
);
292 urb
->dev
= ep
->umidi
->chip
->dev
;
293 ep
->urb_active
= snd_usbmidi_submit_urb(urb
, GFP_ATOMIC
) >= 0;
295 spin_unlock_irqrestore(&ep
->buffer_lock
, flags
);
298 static void snd_usbmidi_out_tasklet(unsigned long data
)
300 struct snd_usb_midi_out_endpoint
* ep
= (struct snd_usb_midi_out_endpoint
*) data
;
302 snd_usbmidi_do_output(ep
);
305 /* called after transfers had been interrupted due to some USB error */
306 static void snd_usbmidi_error_timer(unsigned long data
)
308 struct snd_usb_midi
*umidi
= (struct snd_usb_midi
*)data
;
311 spin_lock(&umidi
->disc_lock
);
312 if (umidi
->disconnected
) {
313 spin_unlock(&umidi
->disc_lock
);
316 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
317 struct snd_usb_midi_in_endpoint
*in
= umidi
->endpoints
[i
].in
;
318 if (in
&& in
->error_resubmit
) {
319 in
->error_resubmit
= 0;
320 in
->urb
->dev
= umidi
->chip
->dev
;
321 snd_usbmidi_submit_urb(in
->urb
, GFP_ATOMIC
);
323 if (umidi
->endpoints
[i
].out
)
324 snd_usbmidi_do_output(umidi
->endpoints
[i
].out
);
326 spin_unlock(&umidi
->disc_lock
);
329 /* helper function to send static data that may not DMA-able */
330 static int send_bulk_static_data(struct snd_usb_midi_out_endpoint
* ep
,
331 const void *data
, int len
)
334 void *buf
= kmemdup(data
, len
, GFP_KERNEL
);
337 dump_urb("sending", buf
, len
);
338 err
= usb_bulk_msg(ep
->umidi
->chip
->dev
, ep
->urb
->pipe
, buf
, len
,
345 * Standard USB MIDI protocol: see the spec.
346 * Midiman protocol: like the standard protocol, but the control byte is the
347 * fourth byte in each packet, and uses length instead of CIN.
350 static void snd_usbmidi_standard_input(struct snd_usb_midi_in_endpoint
* ep
,
351 uint8_t* buffer
, int buffer_length
)
355 for (i
= 0; i
+ 3 < buffer_length
; i
+= 4)
356 if (buffer
[i
] != 0) {
357 int cable
= buffer
[i
] >> 4;
358 int length
= snd_usbmidi_cin_length
[buffer
[i
] & 0x0f];
359 snd_usbmidi_input_data(ep
, cable
, &buffer
[i
+ 1], length
);
363 static void snd_usbmidi_midiman_input(struct snd_usb_midi_in_endpoint
* ep
,
364 uint8_t* buffer
, int buffer_length
)
368 for (i
= 0; i
+ 3 < buffer_length
; i
+= 4)
369 if (buffer
[i
+ 3] != 0) {
370 int port
= buffer
[i
+ 3] >> 4;
371 int length
= buffer
[i
+ 3] & 3;
372 snd_usbmidi_input_data(ep
, port
, &buffer
[i
], length
);
377 * Buggy M-Audio device: running status on input results in a packet that has
378 * the data bytes but not the status byte and that is marked with CIN 4.
380 static void snd_usbmidi_maudio_broken_running_status_input(
381 struct snd_usb_midi_in_endpoint
* ep
,
382 uint8_t* buffer
, int buffer_length
)
386 for (i
= 0; i
+ 3 < buffer_length
; i
+= 4)
387 if (buffer
[i
] != 0) {
388 int cable
= buffer
[i
] >> 4;
389 u8 cin
= buffer
[i
] & 0x0f;
390 struct usbmidi_in_port
*port
= &ep
->ports
[cable
];
393 length
= snd_usbmidi_cin_length
[cin
];
394 if (cin
== 0xf && buffer
[i
+ 1] >= 0xf8)
395 ; /* realtime msg: no running status change */
396 else if (cin
>= 0x8 && cin
<= 0xe)
398 port
->running_status_length
= length
- 1;
399 else if (cin
== 0x4 &&
400 port
->running_status_length
!= 0 &&
401 buffer
[i
+ 1] < 0x80)
402 /* CIN 4 that is not a SysEx */
403 length
= port
->running_status_length
;
406 * All other msgs cannot begin running status.
407 * (A channel msg sent as two or three CIN 0xF
408 * packets could in theory, but this device
409 * doesn't use this format.)
411 port
->running_status_length
= 0;
412 snd_usbmidi_input_data(ep
, cable
, &buffer
[i
+ 1], length
);
417 * CME protocol: like the standard protocol, but SysEx commands are sent as a
418 * single USB packet preceded by a 0x0F byte.
420 static void snd_usbmidi_cme_input(struct snd_usb_midi_in_endpoint
*ep
,
421 uint8_t *buffer
, int buffer_length
)
423 if (buffer_length
< 2 || (buffer
[0] & 0x0f) != 0x0f)
424 snd_usbmidi_standard_input(ep
, buffer
, buffer_length
);
426 snd_usbmidi_input_data(ep
, buffer
[0] >> 4,
427 &buffer
[1], buffer_length
- 1);
431 * Adds one USB MIDI packet to the output buffer.
433 static void snd_usbmidi_output_standard_packet(struct urb
* urb
, uint8_t p0
,
434 uint8_t p1
, uint8_t p2
, uint8_t p3
)
437 uint8_t* buf
= (uint8_t*)urb
->transfer_buffer
+ urb
->transfer_buffer_length
;
442 urb
->transfer_buffer_length
+= 4;
446 * Adds one Midiman packet to the output buffer.
448 static void snd_usbmidi_output_midiman_packet(struct urb
* urb
, uint8_t p0
,
449 uint8_t p1
, uint8_t p2
, uint8_t p3
)
452 uint8_t* buf
= (uint8_t*)urb
->transfer_buffer
+ urb
->transfer_buffer_length
;
456 buf
[3] = (p0
& 0xf0) | snd_usbmidi_cin_length
[p0
& 0x0f];
457 urb
->transfer_buffer_length
+= 4;
461 * Converts MIDI commands to USB MIDI packets.
463 static void snd_usbmidi_transmit_byte(struct usbmidi_out_port
* port
,
464 uint8_t b
, struct urb
* urb
)
466 uint8_t p0
= port
->cable
;
467 void (*output_packet
)(struct urb
*, uint8_t, uint8_t, uint8_t, uint8_t) =
468 port
->ep
->umidi
->usb_protocol_ops
->output_packet
;
471 output_packet(urb
, p0
| 0x0f, b
, 0, 0);
472 } else if (b
>= 0xf0) {
476 port
->state
= STATE_SYSEX_1
;
481 port
->state
= STATE_1PARAM
;
485 port
->state
= STATE_2PARAM_1
;
489 port
->state
= STATE_UNKNOWN
;
492 output_packet(urb
, p0
| 0x05, 0xf6, 0, 0);
493 port
->state
= STATE_UNKNOWN
;
496 switch (port
->state
) {
498 output_packet(urb
, p0
| 0x05, 0xf7, 0, 0);
501 output_packet(urb
, p0
| 0x06, port
->data
[0], 0xf7, 0);
504 output_packet(urb
, p0
| 0x07, port
->data
[0], port
->data
[1], 0xf7);
507 port
->state
= STATE_UNKNOWN
;
510 } else if (b
>= 0x80) {
512 if (b
>= 0xc0 && b
<= 0xdf)
513 port
->state
= STATE_1PARAM
;
515 port
->state
= STATE_2PARAM_1
;
516 } else { /* b < 0x80 */
517 switch (port
->state
) {
519 if (port
->data
[0] < 0xf0) {
520 p0
|= port
->data
[0] >> 4;
523 port
->state
= STATE_UNKNOWN
;
525 output_packet(urb
, p0
, port
->data
[0], b
, 0);
529 port
->state
= STATE_2PARAM_2
;
532 if (port
->data
[0] < 0xf0) {
533 p0
|= port
->data
[0] >> 4;
534 port
->state
= STATE_2PARAM_1
;
537 port
->state
= STATE_UNKNOWN
;
539 output_packet(urb
, p0
, port
->data
[0], port
->data
[1], b
);
543 port
->state
= STATE_SYSEX_1
;
547 port
->state
= STATE_SYSEX_2
;
550 output_packet(urb
, p0
| 0x04, port
->data
[0], port
->data
[1], b
);
551 port
->state
= STATE_SYSEX_0
;
557 static void snd_usbmidi_standard_output(struct snd_usb_midi_out_endpoint
* ep
)
559 struct urb
* urb
= ep
->urb
;
562 /* FIXME: lower-numbered ports can starve higher-numbered ports */
563 for (p
= 0; p
< 0x10; ++p
) {
564 struct usbmidi_out_port
* port
= &ep
->ports
[p
];
567 while (urb
->transfer_buffer_length
+ 3 < ep
->max_transfer
) {
569 if (snd_rawmidi_transmit(port
->substream
, &b
, 1) != 1) {
573 snd_usbmidi_transmit_byte(port
, b
, urb
);
578 static struct usb_protocol_ops snd_usbmidi_standard_ops
= {
579 .input
= snd_usbmidi_standard_input
,
580 .output
= snd_usbmidi_standard_output
,
581 .output_packet
= snd_usbmidi_output_standard_packet
,
584 static struct usb_protocol_ops snd_usbmidi_midiman_ops
= {
585 .input
= snd_usbmidi_midiman_input
,
586 .output
= snd_usbmidi_standard_output
,
587 .output_packet
= snd_usbmidi_output_midiman_packet
,
590 static struct usb_protocol_ops snd_usbmidi_maudio_broken_running_status_ops
= {
591 .input
= snd_usbmidi_maudio_broken_running_status_input
,
592 .output
= snd_usbmidi_standard_output
,
593 .output_packet
= snd_usbmidi_output_standard_packet
,
596 static struct usb_protocol_ops snd_usbmidi_cme_ops
= {
597 .input
= snd_usbmidi_cme_input
,
598 .output
= snd_usbmidi_standard_output
,
599 .output_packet
= snd_usbmidi_output_standard_packet
,
603 * Novation USB MIDI protocol: number of data bytes is in the first byte
604 * (when receiving) (+1!) or in the second byte (when sending); data begins
608 static void snd_usbmidi_novation_input(struct snd_usb_midi_in_endpoint
* ep
,
609 uint8_t* buffer
, int buffer_length
)
611 if (buffer_length
< 2 || !buffer
[0] || buffer_length
< buffer
[0] + 1)
613 snd_usbmidi_input_data(ep
, 0, &buffer
[2], buffer
[0] - 1);
616 static void snd_usbmidi_novation_output(struct snd_usb_midi_out_endpoint
* ep
)
618 uint8_t* transfer_buffer
;
621 if (!ep
->ports
[0].active
)
623 transfer_buffer
= ep
->urb
->transfer_buffer
;
624 count
= snd_rawmidi_transmit(ep
->ports
[0].substream
,
626 ep
->max_transfer
- 2);
628 ep
->ports
[0].active
= 0;
631 transfer_buffer
[0] = 0;
632 transfer_buffer
[1] = count
;
633 ep
->urb
->transfer_buffer_length
= 2 + count
;
636 static struct usb_protocol_ops snd_usbmidi_novation_ops
= {
637 .input
= snd_usbmidi_novation_input
,
638 .output
= snd_usbmidi_novation_output
,
642 * "raw" protocol: used by the MOTU FastLane.
645 static void snd_usbmidi_raw_input(struct snd_usb_midi_in_endpoint
* ep
,
646 uint8_t* buffer
, int buffer_length
)
648 snd_usbmidi_input_data(ep
, 0, buffer
, buffer_length
);
651 static void snd_usbmidi_raw_output(struct snd_usb_midi_out_endpoint
* ep
)
655 if (!ep
->ports
[0].active
)
657 count
= snd_rawmidi_transmit(ep
->ports
[0].substream
,
658 ep
->urb
->transfer_buffer
,
661 ep
->ports
[0].active
= 0;
664 ep
->urb
->transfer_buffer_length
= count
;
667 static struct usb_protocol_ops snd_usbmidi_raw_ops
= {
668 .input
= snd_usbmidi_raw_input
,
669 .output
= snd_usbmidi_raw_output
,
672 static void snd_usbmidi_us122l_input(struct snd_usb_midi_in_endpoint
*ep
,
673 uint8_t *buffer
, int buffer_length
)
675 if (buffer_length
!= 9)
678 while (buffer_length
&& buffer
[buffer_length
- 1] == 0xFD)
681 snd_usbmidi_input_data(ep
, 0, buffer
, buffer_length
);
684 static void snd_usbmidi_us122l_output(struct snd_usb_midi_out_endpoint
*ep
)
688 if (!ep
->ports
[0].active
)
690 count
= ep
->urb
->dev
->speed
== USB_SPEED_HIGH
? 1 : 2;
691 count
= snd_rawmidi_transmit(ep
->ports
[0].substream
,
692 ep
->urb
->transfer_buffer
,
695 ep
->ports
[0].active
= 0;
699 memset(ep
->urb
->transfer_buffer
+ count
, 0xFD, 9 - count
);
700 ep
->urb
->transfer_buffer_length
= count
;
703 static struct usb_protocol_ops snd_usbmidi_122l_ops
= {
704 .input
= snd_usbmidi_us122l_input
,
705 .output
= snd_usbmidi_us122l_output
,
709 * Emagic USB MIDI protocol: raw MIDI with "F5 xx" port switching.
712 static void snd_usbmidi_emagic_init_out(struct snd_usb_midi_out_endpoint
* ep
)
714 static const u8 init_data
[] = {
715 /* initialization magic: "get version" */
717 0x00, 0x20, 0x31, /* Emagic */
719 0x0b, /* version number request */
720 0x00, /* command version */
721 0x00, /* EEPROM, box 0 */
724 send_bulk_static_data(ep
, init_data
, sizeof(init_data
));
725 /* while we're at it, pour on more magic */
726 send_bulk_static_data(ep
, init_data
, sizeof(init_data
));
729 static void snd_usbmidi_emagic_finish_out(struct snd_usb_midi_out_endpoint
* ep
)
731 static const u8 finish_data
[] = {
732 /* switch to patch mode with last preset */
734 0x00, 0x20, 0x31, /* Emagic */
736 0x10, /* patch switch command */
737 0x00, /* command version */
738 0x7f, /* to all boxes */
739 0x40, /* last preset in EEPROM */
742 send_bulk_static_data(ep
, finish_data
, sizeof(finish_data
));
745 static void snd_usbmidi_emagic_input(struct snd_usb_midi_in_endpoint
* ep
,
746 uint8_t* buffer
, int buffer_length
)
750 /* FF indicates end of valid data */
751 for (i
= 0; i
< buffer_length
; ++i
)
752 if (buffer
[i
] == 0xff) {
757 /* handle F5 at end of last buffer */
761 while (buffer_length
> 0) {
762 /* determine size of data until next F5 */
763 for (i
= 0; i
< buffer_length
; ++i
)
764 if (buffer
[i
] == 0xf5)
766 snd_usbmidi_input_data(ep
, ep
->current_port
, buffer
, i
);
770 if (buffer_length
<= 0)
772 /* assert(buffer[0] == 0xf5); */
778 if (buffer_length
<= 0)
780 if (buffer
[0] < 0x80) {
781 ep
->current_port
= (buffer
[0] - 1) & 15;
789 static void snd_usbmidi_emagic_output(struct snd_usb_midi_out_endpoint
* ep
)
791 int port0
= ep
->current_port
;
792 uint8_t* buf
= ep
->urb
->transfer_buffer
;
793 int buf_free
= ep
->max_transfer
;
796 for (i
= 0; i
< 0x10; ++i
) {
797 /* round-robin, starting at the last current port */
798 int portnum
= (port0
+ i
) & 15;
799 struct usbmidi_out_port
* port
= &ep
->ports
[portnum
];
803 if (snd_rawmidi_transmit_peek(port
->substream
, buf
, 1) != 1) {
808 if (portnum
!= ep
->current_port
) {
811 ep
->current_port
= portnum
;
813 buf
[1] = (portnum
+ 1) & 15;
820 length
= snd_rawmidi_transmit(port
->substream
, buf
, buf_free
);
828 if (buf_free
< ep
->max_transfer
&& buf_free
> 0) {
832 ep
->urb
->transfer_buffer_length
= ep
->max_transfer
- buf_free
;
835 static struct usb_protocol_ops snd_usbmidi_emagic_ops
= {
836 .input
= snd_usbmidi_emagic_input
,
837 .output
= snd_usbmidi_emagic_output
,
838 .init_out_endpoint
= snd_usbmidi_emagic_init_out
,
839 .finish_out_endpoint
= snd_usbmidi_emagic_finish_out
,
843 static int snd_usbmidi_output_open(struct snd_rawmidi_substream
*substream
)
845 struct snd_usb_midi
* umidi
= substream
->rmidi
->private_data
;
846 struct usbmidi_out_port
* port
= NULL
;
849 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
)
850 if (umidi
->endpoints
[i
].out
)
851 for (j
= 0; j
< 0x10; ++j
)
852 if (umidi
->endpoints
[i
].out
->ports
[j
].substream
== substream
) {
853 port
= &umidi
->endpoints
[i
].out
->ports
[j
];
860 substream
->runtime
->private_data
= port
;
861 port
->state
= STATE_UNKNOWN
;
865 static int snd_usbmidi_output_close(struct snd_rawmidi_substream
*substream
)
870 static void snd_usbmidi_output_trigger(struct snd_rawmidi_substream
*substream
, int up
)
872 struct usbmidi_out_port
* port
= (struct usbmidi_out_port
*)substream
->runtime
->private_data
;
876 if (port
->ep
->umidi
->chip
->shutdown
) {
877 /* gobble up remaining bytes to prevent wait in
878 * snd_rawmidi_drain_output */
879 while (!snd_rawmidi_transmit_empty(substream
))
880 snd_rawmidi_transmit_ack(substream
, 1);
883 tasklet_hi_schedule(&port
->ep
->tasklet
);
887 static int snd_usbmidi_input_open(struct snd_rawmidi_substream
*substream
)
892 static int snd_usbmidi_input_close(struct snd_rawmidi_substream
*substream
)
897 static void snd_usbmidi_input_trigger(struct snd_rawmidi_substream
*substream
, int up
)
899 struct snd_usb_midi
* umidi
= substream
->rmidi
->private_data
;
902 set_bit(substream
->number
, &umidi
->input_triggered
);
904 clear_bit(substream
->number
, &umidi
->input_triggered
);
907 static struct snd_rawmidi_ops snd_usbmidi_output_ops
= {
908 .open
= snd_usbmidi_output_open
,
909 .close
= snd_usbmidi_output_close
,
910 .trigger
= snd_usbmidi_output_trigger
,
913 static struct snd_rawmidi_ops snd_usbmidi_input_ops
= {
914 .open
= snd_usbmidi_input_open
,
915 .close
= snd_usbmidi_input_close
,
916 .trigger
= snd_usbmidi_input_trigger
920 * Frees an input endpoint.
921 * May be called when ep hasn't been initialized completely.
923 static void snd_usbmidi_in_endpoint_delete(struct snd_usb_midi_in_endpoint
* ep
)
926 usb_buffer_free(ep
->umidi
->chip
->dev
,
927 ep
->urb
->transfer_buffer_length
,
928 ep
->urb
->transfer_buffer
,
929 ep
->urb
->transfer_dma
);
930 usb_free_urb(ep
->urb
);
936 * Creates an input endpoint.
938 static int snd_usbmidi_in_endpoint_create(struct snd_usb_midi
* umidi
,
939 struct snd_usb_midi_endpoint_info
* ep_info
,
940 struct snd_usb_midi_endpoint
* rep
)
942 struct snd_usb_midi_in_endpoint
* ep
;
948 ep
= kzalloc(sizeof(*ep
), GFP_KERNEL
);
953 ep
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
955 snd_usbmidi_in_endpoint_delete(ep
);
958 if (ep_info
->in_interval
)
959 pipe
= usb_rcvintpipe(umidi
->chip
->dev
, ep_info
->in_ep
);
961 pipe
= usb_rcvbulkpipe(umidi
->chip
->dev
, ep_info
->in_ep
);
962 length
= usb_maxpacket(umidi
->chip
->dev
, pipe
, 0);
963 buffer
= usb_buffer_alloc(umidi
->chip
->dev
, length
, GFP_KERNEL
,
964 &ep
->urb
->transfer_dma
);
966 snd_usbmidi_in_endpoint_delete(ep
);
969 if (ep_info
->in_interval
)
970 usb_fill_int_urb(ep
->urb
, umidi
->chip
->dev
, pipe
, buffer
,
971 length
, snd_usbmidi_in_urb_complete
, ep
,
972 ep_info
->in_interval
);
974 usb_fill_bulk_urb(ep
->urb
, umidi
->chip
->dev
, pipe
, buffer
,
975 length
, snd_usbmidi_in_urb_complete
, ep
);
976 ep
->urb
->transfer_flags
= URB_NO_TRANSFER_DMA_MAP
;
982 static unsigned int snd_usbmidi_count_bits(unsigned int x
)
986 for (bits
= 0; x
; ++bits
)
992 * Frees an output endpoint.
993 * May be called when ep hasn't been initialized completely.
995 static void snd_usbmidi_out_endpoint_delete(struct snd_usb_midi_out_endpoint
* ep
)
998 usb_buffer_free(ep
->umidi
->chip
->dev
, ep
->max_transfer
,
999 ep
->urb
->transfer_buffer
,
1000 ep
->urb
->transfer_dma
);
1001 usb_free_urb(ep
->urb
);
1007 * Creates an output endpoint, and initializes output ports.
1009 static int snd_usbmidi_out_endpoint_create(struct snd_usb_midi
* umidi
,
1010 struct snd_usb_midi_endpoint_info
* ep_info
,
1011 struct snd_usb_midi_endpoint
* rep
)
1013 struct snd_usb_midi_out_endpoint
* ep
;
1019 ep
= kzalloc(sizeof(*ep
), GFP_KERNEL
);
1024 ep
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1026 snd_usbmidi_out_endpoint_delete(ep
);
1029 if (ep_info
->out_interval
)
1030 pipe
= usb_sndintpipe(umidi
->chip
->dev
, ep_info
->out_ep
);
1032 pipe
= usb_sndbulkpipe(umidi
->chip
->dev
, ep_info
->out_ep
);
1033 if (umidi
->chip
->usb_id
== USB_ID(0x0a92, 0x1020)) /* ESI M4U */
1034 /* FIXME: we need more URBs to get reasonable bandwidth here: */
1035 ep
->max_transfer
= 4;
1037 ep
->max_transfer
= usb_maxpacket(umidi
->chip
->dev
, pipe
, 1);
1038 buffer
= usb_buffer_alloc(umidi
->chip
->dev
, ep
->max_transfer
,
1039 GFP_KERNEL
, &ep
->urb
->transfer_dma
);
1041 snd_usbmidi_out_endpoint_delete(ep
);
1044 if (ep_info
->out_interval
)
1045 usb_fill_int_urb(ep
->urb
, umidi
->chip
->dev
, pipe
, buffer
,
1046 ep
->max_transfer
, snd_usbmidi_out_urb_complete
,
1047 ep
, ep_info
->out_interval
);
1049 usb_fill_bulk_urb(ep
->urb
, umidi
->chip
->dev
,
1050 pipe
, buffer
, ep
->max_transfer
,
1051 snd_usbmidi_out_urb_complete
, ep
);
1052 ep
->urb
->transfer_flags
= URB_NO_TRANSFER_DMA_MAP
;
1054 spin_lock_init(&ep
->buffer_lock
);
1055 tasklet_init(&ep
->tasklet
, snd_usbmidi_out_tasklet
, (unsigned long)ep
);
1057 for (i
= 0; i
< 0x10; ++i
)
1058 if (ep_info
->out_cables
& (1 << i
)) {
1059 ep
->ports
[i
].ep
= ep
;
1060 ep
->ports
[i
].cable
= i
<< 4;
1063 if (umidi
->usb_protocol_ops
->init_out_endpoint
)
1064 umidi
->usb_protocol_ops
->init_out_endpoint(ep
);
1073 static void snd_usbmidi_free(struct snd_usb_midi
* umidi
)
1077 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1078 struct snd_usb_midi_endpoint
* ep
= &umidi
->endpoints
[i
];
1080 snd_usbmidi_out_endpoint_delete(ep
->out
);
1082 snd_usbmidi_in_endpoint_delete(ep
->in
);
1088 * Unlinks all URBs (must be done before the usb_device is deleted).
1090 void snd_usbmidi_disconnect(struct list_head
* p
)
1092 struct snd_usb_midi
* umidi
;
1095 umidi
= list_entry(p
, struct snd_usb_midi
, list
);
1097 * an URB's completion handler may start the timer and
1098 * a timer may submit an URB. To reliably break the cycle
1099 * a flag under lock must be used
1101 spin_lock_irq(&umidi
->disc_lock
);
1102 umidi
->disconnected
= 1;
1103 spin_unlock_irq(&umidi
->disc_lock
);
1104 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1105 struct snd_usb_midi_endpoint
* ep
= &umidi
->endpoints
[i
];
1107 tasklet_kill(&ep
->out
->tasklet
);
1108 if (ep
->out
&& ep
->out
->urb
) {
1109 usb_kill_urb(ep
->out
->urb
);
1110 if (umidi
->usb_protocol_ops
->finish_out_endpoint
)
1111 umidi
->usb_protocol_ops
->finish_out_endpoint(ep
->out
);
1114 usb_kill_urb(ep
->in
->urb
);
1116 del_timer_sync(&umidi
->error_timer
);
1119 static void snd_usbmidi_rawmidi_free(struct snd_rawmidi
*rmidi
)
1121 struct snd_usb_midi
* umidi
= rmidi
->private_data
;
1122 snd_usbmidi_free(umidi
);
1125 static struct snd_rawmidi_substream
*snd_usbmidi_find_substream(struct snd_usb_midi
* umidi
,
1126 int stream
, int number
)
1128 struct list_head
* list
;
1130 list_for_each(list
, &umidi
->rmidi
->streams
[stream
].substreams
) {
1131 struct snd_rawmidi_substream
*substream
= list_entry(list
, struct snd_rawmidi_substream
, list
);
1132 if (substream
->number
== number
)
1139 * This list specifies names for ports that do not fit into the standard
1140 * "(product) MIDI (n)" schema because they aren't external MIDI ports,
1141 * such as internal control or synthesizer ports.
1143 static struct port_info
{
1148 unsigned int seq_flags
;
1149 } snd_usbmidi_port_info
[] = {
1150 #define PORT_INFO(vendor, product, num, name_, voices_, flags) \
1151 { .id = USB_ID(vendor, product), \
1152 .port = num, .voices = voices_, \
1153 .name = name_, .seq_flags = flags }
1154 #define EXTERNAL_PORT(vendor, product, num, name) \
1155 PORT_INFO(vendor, product, num, name, 0, \
1156 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1157 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1158 SNDRV_SEQ_PORT_TYPE_PORT)
1159 #define CONTROL_PORT(vendor, product, num, name) \
1160 PORT_INFO(vendor, product, num, name, 0, \
1161 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1162 SNDRV_SEQ_PORT_TYPE_HARDWARE)
1163 #define ROLAND_SYNTH_PORT(vendor, product, num, name, voices) \
1164 PORT_INFO(vendor, product, num, name, voices, \
1165 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1166 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1167 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1168 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1169 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1170 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1171 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1172 #define SOUNDCANVAS_PORT(vendor, product, num, name, voices) \
1173 PORT_INFO(vendor, product, num, name, voices, \
1174 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1175 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1176 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1177 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1178 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1179 SNDRV_SEQ_PORT_TYPE_MIDI_MT32 | \
1180 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1181 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1183 CONTROL_PORT(0x0582, 0x0000, 2, "%s Control"),
1184 /* Roland SC-8850 */
1185 SOUNDCANVAS_PORT(0x0582, 0x0003, 0, "%s Part A", 128),
1186 SOUNDCANVAS_PORT(0x0582, 0x0003, 1, "%s Part B", 128),
1187 SOUNDCANVAS_PORT(0x0582, 0x0003, 2, "%s Part C", 128),
1188 SOUNDCANVAS_PORT(0x0582, 0x0003, 3, "%s Part D", 128),
1189 EXTERNAL_PORT(0x0582, 0x0003, 4, "%s MIDI 1"),
1190 EXTERNAL_PORT(0x0582, 0x0003, 5, "%s MIDI 2"),
1192 EXTERNAL_PORT(0x0582, 0x0004, 0, "%s MIDI"),
1193 CONTROL_PORT(0x0582, 0x0004, 1, "%s Control"),
1194 /* Roland SC-8820 */
1195 SOUNDCANVAS_PORT(0x0582, 0x0007, 0, "%s Part A", 64),
1196 SOUNDCANVAS_PORT(0x0582, 0x0007, 1, "%s Part B", 64),
1197 EXTERNAL_PORT(0x0582, 0x0007, 2, "%s MIDI"),
1199 SOUNDCANVAS_PORT(0x0582, 0x000b, 0, "%s Part A", 64),
1200 SOUNDCANVAS_PORT(0x0582, 0x000b, 1, "%s Part B", 64),
1201 EXTERNAL_PORT(0x0582, 0x000b, 2, "%s MIDI"),
1203 SOUNDCANVAS_PORT(0x0582, 0x000c, 0, "%s Part A", 64),
1204 SOUNDCANVAS_PORT(0x0582, 0x000c, 1, "%s Part B", 64),
1205 EXTERNAL_PORT(0x0582, 0x000c, 2, "%s MIDI"),
1207 CONTROL_PORT(0x0582, 0x0014, 8, "%s Control"),
1209 ROLAND_SYNTH_PORT(0x0582, 0x0016, 0, "%s Part A", 128),
1210 ROLAND_SYNTH_PORT(0x0582, 0x0016, 1, "%s Part B", 128),
1211 EXTERNAL_PORT(0x0582, 0x0016, 2, "%s MIDI 1"),
1212 EXTERNAL_PORT(0x0582, 0x0016, 3, "%s MIDI 2"),
1214 CONTROL_PORT(0x0582, 0x0023, 5, "%s Control"),
1216 ROLAND_SYNTH_PORT(0x0582, 0x0027, 0, "%s Part A", 64),
1217 ROLAND_SYNTH_PORT(0x0582, 0x0027, 1, "%s Part B", 64),
1218 EXTERNAL_PORT(0x0582, 0x0027, 2, "%s MIDI"),
1220 ROLAND_SYNTH_PORT(0x0582, 0x0029, 0, "%s Part A", 128),
1221 ROLAND_SYNTH_PORT(0x0582, 0x0029, 1, "%s Part B", 128),
1222 EXTERNAL_PORT(0x0582, 0x0029, 2, "%s MIDI 1"),
1223 EXTERNAL_PORT(0x0582, 0x0029, 3, "%s MIDI 2"),
1225 EXTERNAL_PORT(0x0582, 0x002b, 0, "%s MIDI"),
1226 CONTROL_PORT(0x0582, 0x002b, 1, "%s Control"),
1228 EXTERNAL_PORT(0x0582, 0x002f, 0, "%s MIDI"),
1229 EXTERNAL_PORT(0x0582, 0x002f, 1, "%s External MIDI"),
1230 EXTERNAL_PORT(0x0582, 0x002f, 2, "%s Sync"),
1232 EXTERNAL_PORT(0x0582, 0x0033, 0, "%s MIDI"),
1233 EXTERNAL_PORT(0x0582, 0x0033, 1, "%s 1"),
1234 EXTERNAL_PORT(0x0582, 0x0033, 2, "%s 2"),
1236 EXTERNAL_PORT(0x0582, 0x003b, 0, "%s MIDI"),
1237 CONTROL_PORT(0x0582, 0x003b, 1, "%s Control"),
1238 /* Edirol UA-1000 */
1239 EXTERNAL_PORT(0x0582, 0x0044, 0, "%s MIDI"),
1240 CONTROL_PORT(0x0582, 0x0044, 1, "%s Control"),
1242 EXTERNAL_PORT(0x0582, 0x0048, 0, "%s MIDI"),
1243 EXTERNAL_PORT(0x0582, 0x0048, 1, "%s 1"),
1244 EXTERNAL_PORT(0x0582, 0x0048, 2, "%s 2"),
1246 EXTERNAL_PORT(0x0582, 0x004d, 0, "%s MIDI"),
1247 EXTERNAL_PORT(0x0582, 0x004d, 1, "%s 1"),
1248 EXTERNAL_PORT(0x0582, 0x004d, 2, "%s 2"),
1250 CONTROL_PORT(0x0582, 0x009a, 3, "%s Control"),
1251 /* M-Audio MidiSport 8x8 */
1252 CONTROL_PORT(0x0763, 0x1031, 8, "%s Control"),
1253 CONTROL_PORT(0x0763, 0x1033, 8, "%s Control"),
1255 EXTERNAL_PORT(0x07fd, 0x0001, 0, "%s MIDI A"),
1256 EXTERNAL_PORT(0x07fd, 0x0001, 1, "%s MIDI B"),
1257 /* Emagic Unitor8/AMT8/MT4 */
1258 EXTERNAL_PORT(0x086a, 0x0001, 8, "%s Broadcast"),
1259 EXTERNAL_PORT(0x086a, 0x0002, 8, "%s Broadcast"),
1260 EXTERNAL_PORT(0x086a, 0x0003, 4, "%s Broadcast"),
1263 static struct port_info
*find_port_info(struct snd_usb_midi
* umidi
, int number
)
1267 for (i
= 0; i
< ARRAY_SIZE(snd_usbmidi_port_info
); ++i
) {
1268 if (snd_usbmidi_port_info
[i
].id
== umidi
->chip
->usb_id
&&
1269 snd_usbmidi_port_info
[i
].port
== number
)
1270 return &snd_usbmidi_port_info
[i
];
1275 static void snd_usbmidi_get_port_info(struct snd_rawmidi
*rmidi
, int number
,
1276 struct snd_seq_port_info
*seq_port_info
)
1278 struct snd_usb_midi
*umidi
= rmidi
->private_data
;
1279 struct port_info
*port_info
;
1281 /* TODO: read port flags from descriptors */
1282 port_info
= find_port_info(umidi
, number
);
1284 seq_port_info
->type
= port_info
->seq_flags
;
1285 seq_port_info
->midi_voices
= port_info
->voices
;
1289 static void snd_usbmidi_init_substream(struct snd_usb_midi
* umidi
,
1290 int stream
, int number
,
1291 struct snd_rawmidi_substream
** rsubstream
)
1293 struct port_info
*port_info
;
1294 const char *name_format
;
1296 struct snd_rawmidi_substream
*substream
= snd_usbmidi_find_substream(umidi
, stream
, number
);
1298 snd_printd(KERN_ERR
"substream %d:%d not found\n", stream
, number
);
1302 /* TODO: read port name from jack descriptor */
1303 port_info
= find_port_info(umidi
, number
);
1304 name_format
= port_info
? port_info
->name
: "%s MIDI %d";
1305 snprintf(substream
->name
, sizeof(substream
->name
),
1306 name_format
, umidi
->chip
->card
->shortname
, number
+ 1);
1308 *rsubstream
= substream
;
1312 * Creates the endpoints and their ports.
1314 static int snd_usbmidi_create_endpoints(struct snd_usb_midi
* umidi
,
1315 struct snd_usb_midi_endpoint_info
* endpoints
)
1318 int out_ports
= 0, in_ports
= 0;
1320 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1321 if (endpoints
[i
].out_cables
) {
1322 err
= snd_usbmidi_out_endpoint_create(umidi
, &endpoints
[i
],
1323 &umidi
->endpoints
[i
]);
1327 if (endpoints
[i
].in_cables
) {
1328 err
= snd_usbmidi_in_endpoint_create(umidi
, &endpoints
[i
],
1329 &umidi
->endpoints
[i
]);
1334 for (j
= 0; j
< 0x10; ++j
) {
1335 if (endpoints
[i
].out_cables
& (1 << j
)) {
1336 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, out_ports
,
1337 &umidi
->endpoints
[i
].out
->ports
[j
].substream
);
1340 if (endpoints
[i
].in_cables
& (1 << j
)) {
1341 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_INPUT
, in_ports
,
1342 &umidi
->endpoints
[i
].in
->ports
[j
].substream
);
1347 snd_printdd(KERN_INFO
"created %d output and %d input ports\n",
1348 out_ports
, in_ports
);
1353 * Returns MIDIStreaming device capabilities.
1355 static int snd_usbmidi_get_ms_info(struct snd_usb_midi
* umidi
,
1356 struct snd_usb_midi_endpoint_info
* endpoints
)
1358 struct usb_interface
* intf
;
1359 struct usb_host_interface
*hostif
;
1360 struct usb_interface_descriptor
* intfd
;
1361 struct usb_ms_header_descriptor
* ms_header
;
1362 struct usb_host_endpoint
*hostep
;
1363 struct usb_endpoint_descriptor
* ep
;
1364 struct usb_ms_endpoint_descriptor
* ms_ep
;
1367 intf
= umidi
->iface
;
1370 hostif
= &intf
->altsetting
[0];
1371 intfd
= get_iface_desc(hostif
);
1372 ms_header
= (struct usb_ms_header_descriptor
*)hostif
->extra
;
1373 if (hostif
->extralen
>= 7 &&
1374 ms_header
->bLength
>= 7 &&
1375 ms_header
->bDescriptorType
== USB_DT_CS_INTERFACE
&&
1376 ms_header
->bDescriptorSubtype
== HEADER
)
1377 snd_printdd(KERN_INFO
"MIDIStreaming version %02x.%02x\n",
1378 ms_header
->bcdMSC
[1], ms_header
->bcdMSC
[0]);
1380 snd_printk(KERN_WARNING
"MIDIStreaming interface descriptor not found\n");
1383 for (i
= 0; i
< intfd
->bNumEndpoints
; ++i
) {
1384 hostep
= &hostif
->endpoint
[i
];
1385 ep
= get_ep_desc(hostep
);
1386 if ((ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
&&
1387 (ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_INT
)
1389 ms_ep
= (struct usb_ms_endpoint_descriptor
*)hostep
->extra
;
1390 if (hostep
->extralen
< 4 ||
1391 ms_ep
->bLength
< 4 ||
1392 ms_ep
->bDescriptorType
!= USB_DT_CS_ENDPOINT
||
1393 ms_ep
->bDescriptorSubtype
!= MS_GENERAL
)
1395 if ((ep
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_OUT
) {
1396 if (endpoints
[epidx
].out_ep
) {
1397 if (++epidx
>= MIDI_MAX_ENDPOINTS
) {
1398 snd_printk(KERN_WARNING
"too many endpoints\n");
1402 endpoints
[epidx
].out_ep
= ep
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1403 if ((ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) == USB_ENDPOINT_XFER_INT
)
1404 endpoints
[epidx
].out_interval
= ep
->bInterval
;
1405 else if (snd_usb_get_speed(umidi
->chip
->dev
) == USB_SPEED_LOW
)
1407 * Low speed bulk transfers don't exist, so
1408 * force interrupt transfers for devices like
1409 * ESI MIDI Mate that try to use them anyway.
1411 endpoints
[epidx
].out_interval
= 1;
1412 endpoints
[epidx
].out_cables
= (1 << ms_ep
->bNumEmbMIDIJack
) - 1;
1413 snd_printdd(KERN_INFO
"EP %02X: %d jack(s)\n",
1414 ep
->bEndpointAddress
, ms_ep
->bNumEmbMIDIJack
);
1416 if (endpoints
[epidx
].in_ep
) {
1417 if (++epidx
>= MIDI_MAX_ENDPOINTS
) {
1418 snd_printk(KERN_WARNING
"too many endpoints\n");
1422 endpoints
[epidx
].in_ep
= ep
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1423 if ((ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) == USB_ENDPOINT_XFER_INT
)
1424 endpoints
[epidx
].in_interval
= ep
->bInterval
;
1425 else if (snd_usb_get_speed(umidi
->chip
->dev
) == USB_SPEED_LOW
)
1426 endpoints
[epidx
].in_interval
= 1;
1427 endpoints
[epidx
].in_cables
= (1 << ms_ep
->bNumEmbMIDIJack
) - 1;
1428 snd_printdd(KERN_INFO
"EP %02X: %d jack(s)\n",
1429 ep
->bEndpointAddress
, ms_ep
->bNumEmbMIDIJack
);
1436 * On Roland devices, use the second alternate setting to be able to use
1437 * the interrupt input endpoint.
1439 static void snd_usbmidi_switch_roland_altsetting(struct snd_usb_midi
* umidi
)
1441 struct usb_interface
* intf
;
1442 struct usb_host_interface
*hostif
;
1443 struct usb_interface_descriptor
* intfd
;
1445 intf
= umidi
->iface
;
1446 if (!intf
|| intf
->num_altsetting
!= 2)
1449 hostif
= &intf
->altsetting
[1];
1450 intfd
= get_iface_desc(hostif
);
1451 if (intfd
->bNumEndpoints
!= 2 ||
1452 (get_endpoint(hostif
, 0)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
||
1453 (get_endpoint(hostif
, 1)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_INT
)
1456 snd_printdd(KERN_INFO
"switching to altsetting %d with int ep\n",
1457 intfd
->bAlternateSetting
);
1458 usb_set_interface(umidi
->chip
->dev
, intfd
->bInterfaceNumber
,
1459 intfd
->bAlternateSetting
);
1463 * Try to find any usable endpoints in the interface.
1465 static int snd_usbmidi_detect_endpoints(struct snd_usb_midi
* umidi
,
1466 struct snd_usb_midi_endpoint_info
* endpoint
,
1469 struct usb_interface
* intf
;
1470 struct usb_host_interface
*hostif
;
1471 struct usb_interface_descriptor
* intfd
;
1472 struct usb_endpoint_descriptor
* epd
;
1473 int i
, out_eps
= 0, in_eps
= 0;
1475 if (USB_ID_VENDOR(umidi
->chip
->usb_id
) == 0x0582)
1476 snd_usbmidi_switch_roland_altsetting(umidi
);
1478 if (endpoint
[0].out_ep
|| endpoint
[0].in_ep
)
1481 intf
= umidi
->iface
;
1482 if (!intf
|| intf
->num_altsetting
< 1)
1484 hostif
= intf
->cur_altsetting
;
1485 intfd
= get_iface_desc(hostif
);
1487 for (i
= 0; i
< intfd
->bNumEndpoints
; ++i
) {
1488 epd
= get_endpoint(hostif
, i
);
1489 if ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
&&
1490 (epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_INT
)
1492 if (out_eps
< max_endpoints
&&
1493 (epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_OUT
) {
1494 endpoint
[out_eps
].out_ep
= epd
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1495 if ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) == USB_ENDPOINT_XFER_INT
)
1496 endpoint
[out_eps
].out_interval
= epd
->bInterval
;
1499 if (in_eps
< max_endpoints
&&
1500 (epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_IN
) {
1501 endpoint
[in_eps
].in_ep
= epd
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1502 if ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) == USB_ENDPOINT_XFER_INT
)
1503 endpoint
[in_eps
].in_interval
= epd
->bInterval
;
1507 return (out_eps
|| in_eps
) ? 0 : -ENOENT
;
1511 * Detects the endpoints for one-port-per-endpoint protocols.
1513 static int snd_usbmidi_detect_per_port_endpoints(struct snd_usb_midi
* umidi
,
1514 struct snd_usb_midi_endpoint_info
* endpoints
)
1518 err
= snd_usbmidi_detect_endpoints(umidi
, endpoints
, MIDI_MAX_ENDPOINTS
);
1519 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1520 if (endpoints
[i
].out_ep
)
1521 endpoints
[i
].out_cables
= 0x0001;
1522 if (endpoints
[i
].in_ep
)
1523 endpoints
[i
].in_cables
= 0x0001;
1529 * Detects the endpoints and ports of Yamaha devices.
1531 static int snd_usbmidi_detect_yamaha(struct snd_usb_midi
* umidi
,
1532 struct snd_usb_midi_endpoint_info
* endpoint
)
1534 struct usb_interface
* intf
;
1535 struct usb_host_interface
*hostif
;
1536 struct usb_interface_descriptor
* intfd
;
1539 intf
= umidi
->iface
;
1542 hostif
= intf
->altsetting
;
1543 intfd
= get_iface_desc(hostif
);
1544 if (intfd
->bNumEndpoints
< 1)
1548 * For each port there is one MIDI_IN/OUT_JACK descriptor, not
1549 * necessarily with any useful contents. So simply count 'em.
1551 for (cs_desc
= hostif
->extra
;
1552 cs_desc
< hostif
->extra
+ hostif
->extralen
&& cs_desc
[0] >= 2;
1553 cs_desc
+= cs_desc
[0]) {
1554 if (cs_desc
[1] == USB_DT_CS_INTERFACE
) {
1555 if (cs_desc
[2] == MIDI_IN_JACK
)
1556 endpoint
->in_cables
= (endpoint
->in_cables
<< 1) | 1;
1557 else if (cs_desc
[2] == MIDI_OUT_JACK
)
1558 endpoint
->out_cables
= (endpoint
->out_cables
<< 1) | 1;
1561 if (!endpoint
->in_cables
&& !endpoint
->out_cables
)
1564 return snd_usbmidi_detect_endpoints(umidi
, endpoint
, 1);
1568 * Creates the endpoints and their ports for Midiman devices.
1570 static int snd_usbmidi_create_endpoints_midiman(struct snd_usb_midi
* umidi
,
1571 struct snd_usb_midi_endpoint_info
* endpoint
)
1573 struct snd_usb_midi_endpoint_info ep_info
;
1574 struct usb_interface
* intf
;
1575 struct usb_host_interface
*hostif
;
1576 struct usb_interface_descriptor
* intfd
;
1577 struct usb_endpoint_descriptor
* epd
;
1580 intf
= umidi
->iface
;
1583 hostif
= intf
->altsetting
;
1584 intfd
= get_iface_desc(hostif
);
1586 * The various MidiSport devices have more or less random endpoint
1587 * numbers, so we have to identify the endpoints by their index in
1588 * the descriptor array, like the driver for that other OS does.
1590 * There is one interrupt input endpoint for all input ports, one
1591 * bulk output endpoint for even-numbered ports, and one for odd-
1592 * numbered ports. Both bulk output endpoints have corresponding
1593 * input bulk endpoints (at indices 1 and 3) which aren't used.
1595 if (intfd
->bNumEndpoints
< (endpoint
->out_cables
> 0x0001 ? 5 : 3)) {
1596 snd_printdd(KERN_ERR
"not enough endpoints\n");
1600 epd
= get_endpoint(hostif
, 0);
1601 if ((epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) != USB_DIR_IN
||
1602 (epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_INT
) {
1603 snd_printdd(KERN_ERR
"endpoint[0] isn't interrupt\n");
1606 epd
= get_endpoint(hostif
, 2);
1607 if ((epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) != USB_DIR_OUT
||
1608 (epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
) {
1609 snd_printdd(KERN_ERR
"endpoint[2] isn't bulk output\n");
1612 if (endpoint
->out_cables
> 0x0001) {
1613 epd
= get_endpoint(hostif
, 4);
1614 if ((epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) != USB_DIR_OUT
||
1615 (epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
) {
1616 snd_printdd(KERN_ERR
"endpoint[4] isn't bulk output\n");
1621 ep_info
.out_ep
= get_endpoint(hostif
, 2)->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1622 ep_info
.out_cables
= endpoint
->out_cables
& 0x5555;
1623 err
= snd_usbmidi_out_endpoint_create(umidi
, &ep_info
, &umidi
->endpoints
[0]);
1627 ep_info
.in_ep
= get_endpoint(hostif
, 0)->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1628 ep_info
.in_interval
= get_endpoint(hostif
, 0)->bInterval
;
1629 ep_info
.in_cables
= endpoint
->in_cables
;
1630 err
= snd_usbmidi_in_endpoint_create(umidi
, &ep_info
, &umidi
->endpoints
[0]);
1634 if (endpoint
->out_cables
> 0x0001) {
1635 ep_info
.out_ep
= get_endpoint(hostif
, 4)->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1636 ep_info
.out_cables
= endpoint
->out_cables
& 0xaaaa;
1637 err
= snd_usbmidi_out_endpoint_create(umidi
, &ep_info
, &umidi
->endpoints
[1]);
1642 for (cable
= 0; cable
< 0x10; ++cable
) {
1643 if (endpoint
->out_cables
& (1 << cable
))
1644 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, cable
,
1645 &umidi
->endpoints
[cable
& 1].out
->ports
[cable
].substream
);
1646 if (endpoint
->in_cables
& (1 << cable
))
1647 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_INPUT
, cable
,
1648 &umidi
->endpoints
[0].in
->ports
[cable
].substream
);
1653 static struct snd_rawmidi_global_ops snd_usbmidi_ops
= {
1654 .get_port_info
= snd_usbmidi_get_port_info
,
1657 static int snd_usbmidi_create_rawmidi(struct snd_usb_midi
* umidi
,
1658 int out_ports
, int in_ports
)
1660 struct snd_rawmidi
*rmidi
;
1663 err
= snd_rawmidi_new(umidi
->chip
->card
, "USB MIDI",
1664 umidi
->chip
->next_midi_device
++,
1665 out_ports
, in_ports
, &rmidi
);
1668 strcpy(rmidi
->name
, umidi
->chip
->card
->shortname
);
1669 rmidi
->info_flags
= SNDRV_RAWMIDI_INFO_OUTPUT
|
1670 SNDRV_RAWMIDI_INFO_INPUT
|
1671 SNDRV_RAWMIDI_INFO_DUPLEX
;
1672 rmidi
->ops
= &snd_usbmidi_ops
;
1673 rmidi
->private_data
= umidi
;
1674 rmidi
->private_free
= snd_usbmidi_rawmidi_free
;
1675 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, &snd_usbmidi_output_ops
);
1676 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_INPUT
, &snd_usbmidi_input_ops
);
1678 umidi
->rmidi
= rmidi
;
1683 * Temporarily stop input.
1685 void snd_usbmidi_input_stop(struct list_head
* p
)
1687 struct snd_usb_midi
* umidi
;
1690 umidi
= list_entry(p
, struct snd_usb_midi
, list
);
1691 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1692 struct snd_usb_midi_endpoint
* ep
= &umidi
->endpoints
[i
];
1694 usb_kill_urb(ep
->in
->urb
);
1698 static void snd_usbmidi_input_start_ep(struct snd_usb_midi_in_endpoint
* ep
)
1701 struct urb
* urb
= ep
->urb
;
1702 urb
->dev
= ep
->umidi
->chip
->dev
;
1703 snd_usbmidi_submit_urb(urb
, GFP_KERNEL
);
1708 * Resume input after a call to snd_usbmidi_input_stop().
1710 void snd_usbmidi_input_start(struct list_head
* p
)
1712 struct snd_usb_midi
* umidi
;
1715 umidi
= list_entry(p
, struct snd_usb_midi
, list
);
1716 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
)
1717 snd_usbmidi_input_start_ep(umidi
->endpoints
[i
].in
);
1721 * Creates and registers everything needed for a MIDI streaming interface.
1723 int snd_usb_create_midi_interface(struct snd_usb_audio
* chip
,
1724 struct usb_interface
* iface
,
1725 const struct snd_usb_audio_quirk
* quirk
)
1727 struct snd_usb_midi
* umidi
;
1728 struct snd_usb_midi_endpoint_info endpoints
[MIDI_MAX_ENDPOINTS
];
1729 int out_ports
, in_ports
;
1732 umidi
= kzalloc(sizeof(*umidi
), GFP_KERNEL
);
1736 umidi
->iface
= iface
;
1737 umidi
->quirk
= quirk
;
1738 umidi
->usb_protocol_ops
= &snd_usbmidi_standard_ops
;
1739 init_timer(&umidi
->error_timer
);
1740 spin_lock_init(&umidi
->disc_lock
);
1741 umidi
->error_timer
.function
= snd_usbmidi_error_timer
;
1742 umidi
->error_timer
.data
= (unsigned long)umidi
;
1744 /* detect the endpoint(s) to use */
1745 memset(endpoints
, 0, sizeof(endpoints
));
1746 switch (quirk
? quirk
->type
: QUIRK_MIDI_STANDARD_INTERFACE
) {
1747 case QUIRK_MIDI_STANDARD_INTERFACE
:
1748 err
= snd_usbmidi_get_ms_info(umidi
, endpoints
);
1749 if (chip
->usb_id
== USB_ID(0x0763, 0x0150)) /* M-Audio Uno */
1750 umidi
->usb_protocol_ops
=
1751 &snd_usbmidi_maudio_broken_running_status_ops
;
1753 case QUIRK_MIDI_US122L
:
1754 umidi
->usb_protocol_ops
= &snd_usbmidi_122l_ops
;
1756 case QUIRK_MIDI_FIXED_ENDPOINT
:
1757 memcpy(&endpoints
[0], quirk
->data
,
1758 sizeof(struct snd_usb_midi_endpoint_info
));
1759 err
= snd_usbmidi_detect_endpoints(umidi
, &endpoints
[0], 1);
1761 case QUIRK_MIDI_YAMAHA
:
1762 err
= snd_usbmidi_detect_yamaha(umidi
, &endpoints
[0]);
1764 case QUIRK_MIDI_MIDIMAN
:
1765 umidi
->usb_protocol_ops
= &snd_usbmidi_midiman_ops
;
1766 memcpy(&endpoints
[0], quirk
->data
,
1767 sizeof(struct snd_usb_midi_endpoint_info
));
1770 case QUIRK_MIDI_NOVATION
:
1771 umidi
->usb_protocol_ops
= &snd_usbmidi_novation_ops
;
1772 err
= snd_usbmidi_detect_per_port_endpoints(umidi
, endpoints
);
1774 case QUIRK_MIDI_RAW
:
1775 umidi
->usb_protocol_ops
= &snd_usbmidi_raw_ops
;
1776 err
= snd_usbmidi_detect_per_port_endpoints(umidi
, endpoints
);
1778 case QUIRK_MIDI_EMAGIC
:
1779 umidi
->usb_protocol_ops
= &snd_usbmidi_emagic_ops
;
1780 memcpy(&endpoints
[0], quirk
->data
,
1781 sizeof(struct snd_usb_midi_endpoint_info
));
1782 err
= snd_usbmidi_detect_endpoints(umidi
, &endpoints
[0], 1);
1784 case QUIRK_MIDI_CME
:
1785 umidi
->usb_protocol_ops
= &snd_usbmidi_cme_ops
;
1786 err
= snd_usbmidi_detect_per_port_endpoints(umidi
, endpoints
);
1789 snd_printd(KERN_ERR
"invalid quirk type %d\n", quirk
->type
);
1798 /* create rawmidi device */
1801 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1802 out_ports
+= snd_usbmidi_count_bits(endpoints
[i
].out_cables
);
1803 in_ports
+= snd_usbmidi_count_bits(endpoints
[i
].in_cables
);
1805 err
= snd_usbmidi_create_rawmidi(umidi
, out_ports
, in_ports
);
1811 /* create endpoint/port structures */
1812 if (quirk
&& quirk
->type
== QUIRK_MIDI_MIDIMAN
)
1813 err
= snd_usbmidi_create_endpoints_midiman(umidi
, &endpoints
[0]);
1815 err
= snd_usbmidi_create_endpoints(umidi
, endpoints
);
1817 snd_usbmidi_free(umidi
);
1821 list_add(&umidi
->list
, &umidi
->chip
->midi_list
);
1823 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
)
1824 snd_usbmidi_input_start_ep(umidi
->endpoints
[i
].in
);
1828 EXPORT_SYMBOL(snd_usb_create_midi_interface
);
1829 EXPORT_SYMBOL(snd_usbmidi_input_stop
);
1830 EXPORT_SYMBOL(snd_usbmidi_input_start
);
1831 EXPORT_SYMBOL(snd_usbmidi_disconnect
);