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 <sound/driver.h>
39 #include <linux/kernel.h>
40 #include <linux/types.h>
41 #include <linux/bitops.h>
42 #include <linux/interrupt.h>
43 #include <linux/spinlock.h>
44 #include <linux/string.h>
45 #include <linux/init.h>
46 #include <linux/slab.h>
47 #include <linux/timer.h>
48 #include <linux/usb.h>
49 #include <sound/core.h>
50 #include <sound/rawmidi.h>
51 #include <sound/asequencer.h>
56 * define this to log all USB packets
58 /* #define DUMP_PACKETS */
61 * how long to wait after some USB errors, so that khubd can disconnect() us
62 * without too many spurious errors
64 #define ERROR_DELAY_JIFFIES (HZ / 10)
67 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
68 MODULE_DESCRIPTION("USB Audio/MIDI helper module");
69 MODULE_LICENSE("Dual BSD/GPL");
72 struct usb_ms_header_descriptor
{
75 __u8 bDescriptorSubtype
;
78 } __attribute__ ((packed
));
80 struct usb_ms_endpoint_descriptor
{
83 __u8 bDescriptorSubtype
;
85 __u8 baAssocJackID
[0];
86 } __attribute__ ((packed
));
88 struct snd_usb_midi_in_endpoint
;
89 struct snd_usb_midi_out_endpoint
;
90 struct snd_usb_midi_endpoint
;
92 struct usb_protocol_ops
{
93 void (*input
)(struct snd_usb_midi_in_endpoint
*, uint8_t*, int);
94 void (*output
)(struct snd_usb_midi_out_endpoint
*);
95 void (*output_packet
)(struct urb
*, uint8_t, uint8_t, uint8_t, uint8_t);
96 void (*init_out_endpoint
)(struct snd_usb_midi_out_endpoint
*);
97 void (*finish_out_endpoint
)(struct snd_usb_midi_out_endpoint
*);
100 struct snd_usb_midi
{
101 struct snd_usb_audio
*chip
;
102 struct usb_interface
*iface
;
103 const struct snd_usb_audio_quirk
*quirk
;
104 struct snd_rawmidi
*rmidi
;
105 struct usb_protocol_ops
* usb_protocol_ops
;
106 struct list_head list
;
107 struct timer_list error_timer
;
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
;
116 struct snd_usb_midi_out_endpoint
{
117 struct snd_usb_midi
* umidi
;
120 int max_transfer
; /* size of urb buffer */
121 struct tasklet_struct tasklet
;
123 spinlock_t buffer_lock
;
125 struct usbmidi_out_port
{
126 struct snd_usb_midi_out_endpoint
* ep
;
127 struct snd_rawmidi_substream
*substream
;
129 uint8_t cable
; /* cable number << 4 */
131 #define STATE_UNKNOWN 0
132 #define STATE_1PARAM 1
133 #define STATE_2PARAM_1 2
134 #define STATE_2PARAM_2 3
135 #define STATE_SYSEX_0 4
136 #define STATE_SYSEX_1 5
137 #define STATE_SYSEX_2 6
143 struct snd_usb_midi_in_endpoint
{
144 struct snd_usb_midi
* umidi
;
146 struct usbmidi_in_port
{
147 struct snd_rawmidi_substream
*substream
;
148 u8 running_status_length
;
155 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint
* ep
);
157 static const uint8_t snd_usbmidi_cin_length
[] = {
158 0, 0, 2, 3, 3, 1, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1
162 * Submits the URB, with error handling.
164 static int snd_usbmidi_submit_urb(struct urb
* urb
, gfp_t flags
)
166 int err
= usb_submit_urb(urb
, flags
);
167 if (err
< 0 && err
!= -ENODEV
)
168 snd_printk(KERN_ERR
"usb_submit_urb: %d\n", err
);
173 * Error handling for URB completion functions.
175 static int snd_usbmidi_urb_error(int status
)
178 /* manually unlinked, or device gone */
184 /* errors that might occur during unplugging */
190 snd_printk(KERN_ERR
"urb status %d\n", status
);
191 return 0; /* continue */
196 * Receives a chunk of MIDI data.
198 static void snd_usbmidi_input_data(struct snd_usb_midi_in_endpoint
* ep
, int portidx
,
199 uint8_t* data
, int length
)
201 struct usbmidi_in_port
* port
= &ep
->ports
[portidx
];
203 if (!port
->substream
) {
204 snd_printd("unexpected port %d!\n", portidx
);
207 if (!test_bit(port
->substream
->number
, &ep
->umidi
->input_triggered
))
209 snd_rawmidi_receive(port
->substream
, data
, length
);
213 static void dump_urb(const char *type
, const u8
*data
, int length
)
215 snd_printk(KERN_DEBUG
"%s packet: [", type
);
216 for (; length
> 0; ++data
, --length
)
217 printk(" %02x", *data
);
221 #define dump_urb(type, data, length) /* nothing */
225 * Processes the data read from the device.
227 static void snd_usbmidi_in_urb_complete(struct urb
* urb
)
229 struct snd_usb_midi_in_endpoint
* ep
= urb
->context
;
231 if (urb
->status
== 0) {
232 dump_urb("received", urb
->transfer_buffer
, urb
->actual_length
);
233 ep
->umidi
->usb_protocol_ops
->input(ep
, urb
->transfer_buffer
,
236 int err
= snd_usbmidi_urb_error(urb
->status
);
238 if (err
!= -ENODEV
) {
239 ep
->error_resubmit
= 1;
240 mod_timer(&ep
->umidi
->error_timer
,
241 jiffies
+ ERROR_DELAY_JIFFIES
);
247 urb
->dev
= ep
->umidi
->chip
->dev
;
248 snd_usbmidi_submit_urb(urb
, GFP_ATOMIC
);
251 static void snd_usbmidi_out_urb_complete(struct urb
* urb
)
253 struct snd_usb_midi_out_endpoint
* ep
= urb
->context
;
255 spin_lock(&ep
->buffer_lock
);
257 spin_unlock(&ep
->buffer_lock
);
258 if (urb
->status
< 0) {
259 int err
= snd_usbmidi_urb_error(urb
->status
);
262 mod_timer(&ep
->umidi
->error_timer
,
263 jiffies
+ ERROR_DELAY_JIFFIES
);
267 snd_usbmidi_do_output(ep
);
271 * This is called when some data should be transferred to the device
272 * (from one or more substreams).
274 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint
* ep
)
276 struct urb
* urb
= ep
->urb
;
279 spin_lock_irqsave(&ep
->buffer_lock
, flags
);
280 if (ep
->urb_active
|| ep
->umidi
->chip
->shutdown
) {
281 spin_unlock_irqrestore(&ep
->buffer_lock
, flags
);
285 urb
->transfer_buffer_length
= 0;
286 ep
->umidi
->usb_protocol_ops
->output(ep
);
288 if (urb
->transfer_buffer_length
> 0) {
289 dump_urb("sending", urb
->transfer_buffer
,
290 urb
->transfer_buffer_length
);
291 urb
->dev
= ep
->umidi
->chip
->dev
;
292 ep
->urb_active
= snd_usbmidi_submit_urb(urb
, GFP_ATOMIC
) >= 0;
294 spin_unlock_irqrestore(&ep
->buffer_lock
, flags
);
297 static void snd_usbmidi_out_tasklet(unsigned long data
)
299 struct snd_usb_midi_out_endpoint
* ep
= (struct snd_usb_midi_out_endpoint
*) data
;
301 snd_usbmidi_do_output(ep
);
304 /* called after transfers had been interrupted due to some USB error */
305 static void snd_usbmidi_error_timer(unsigned long data
)
307 struct snd_usb_midi
*umidi
= (struct snd_usb_midi
*)data
;
310 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
311 struct snd_usb_midi_in_endpoint
*in
= umidi
->endpoints
[i
].in
;
312 if (in
&& in
->error_resubmit
) {
313 in
->error_resubmit
= 0;
314 in
->urb
->dev
= umidi
->chip
->dev
;
315 snd_usbmidi_submit_urb(in
->urb
, GFP_ATOMIC
);
317 if (umidi
->endpoints
[i
].out
)
318 snd_usbmidi_do_output(umidi
->endpoints
[i
].out
);
322 /* helper function to send static data that may not DMA-able */
323 static int send_bulk_static_data(struct snd_usb_midi_out_endpoint
* ep
,
324 const void *data
, int len
)
327 void *buf
= kmemdup(data
, len
, GFP_KERNEL
);
330 dump_urb("sending", buf
, len
);
331 err
= usb_bulk_msg(ep
->umidi
->chip
->dev
, ep
->urb
->pipe
, buf
, len
,
338 * Standard USB MIDI protocol: see the spec.
339 * Midiman protocol: like the standard protocol, but the control byte is the
340 * fourth byte in each packet, and uses length instead of CIN.
343 static void snd_usbmidi_standard_input(struct snd_usb_midi_in_endpoint
* ep
,
344 uint8_t* buffer
, int buffer_length
)
348 for (i
= 0; i
+ 3 < buffer_length
; i
+= 4)
349 if (buffer
[i
] != 0) {
350 int cable
= buffer
[i
] >> 4;
351 int length
= snd_usbmidi_cin_length
[buffer
[i
] & 0x0f];
352 snd_usbmidi_input_data(ep
, cable
, &buffer
[i
+ 1], length
);
356 static void snd_usbmidi_midiman_input(struct snd_usb_midi_in_endpoint
* ep
,
357 uint8_t* buffer
, int buffer_length
)
361 for (i
= 0; i
+ 3 < buffer_length
; i
+= 4)
362 if (buffer
[i
+ 3] != 0) {
363 int port
= buffer
[i
+ 3] >> 4;
364 int length
= buffer
[i
+ 3] & 3;
365 snd_usbmidi_input_data(ep
, port
, &buffer
[i
], length
);
370 * Buggy M-Audio device: running status on input results in a packet that has
371 * the data bytes but not the status byte and that is marked with CIN 4.
373 static void snd_usbmidi_maudio_broken_running_status_input(
374 struct snd_usb_midi_in_endpoint
* ep
,
375 uint8_t* buffer
, int buffer_length
)
379 for (i
= 0; i
+ 3 < buffer_length
; i
+= 4)
380 if (buffer
[i
] != 0) {
381 int cable
= buffer
[i
] >> 4;
382 u8 cin
= buffer
[i
] & 0x0f;
383 struct usbmidi_in_port
*port
= &ep
->ports
[cable
];
386 length
= snd_usbmidi_cin_length
[cin
];
387 if (cin
== 0xf && buffer
[i
+ 1] >= 0xf8)
388 ; /* realtime msg: no running status change */
389 else if (cin
>= 0x8 && cin
<= 0xe)
391 port
->running_status_length
= length
- 1;
392 else if (cin
== 0x4 &&
393 port
->running_status_length
!= 0 &&
394 buffer
[i
+ 1] < 0x80)
395 /* CIN 4 that is not a SysEx */
396 length
= port
->running_status_length
;
399 * All other msgs cannot begin running status.
400 * (A channel msg sent as two or three CIN 0xF
401 * packets could in theory, but this device
402 * doesn't use this format.)
404 port
->running_status_length
= 0;
405 snd_usbmidi_input_data(ep
, cable
, &buffer
[i
+ 1], length
);
410 * CME protocol: like the standard protocol, but SysEx commands are sent as a
411 * single USB packet preceded by a 0x0F byte.
413 static void snd_usbmidi_cme_input(struct snd_usb_midi_in_endpoint
*ep
,
414 uint8_t *buffer
, int buffer_length
)
416 if (buffer_length
< 2 || (buffer
[0] & 0x0f) != 0x0f)
417 snd_usbmidi_standard_input(ep
, buffer
, buffer_length
);
419 snd_usbmidi_input_data(ep
, buffer
[0] >> 4,
420 &buffer
[1], buffer_length
- 1);
424 * Adds one USB MIDI packet to the output buffer.
426 static void snd_usbmidi_output_standard_packet(struct urb
* urb
, uint8_t p0
,
427 uint8_t p1
, uint8_t p2
, uint8_t p3
)
430 uint8_t* buf
= (uint8_t*)urb
->transfer_buffer
+ urb
->transfer_buffer_length
;
435 urb
->transfer_buffer_length
+= 4;
439 * Adds one Midiman packet to the output buffer.
441 static void snd_usbmidi_output_midiman_packet(struct urb
* urb
, uint8_t p0
,
442 uint8_t p1
, uint8_t p2
, uint8_t p3
)
445 uint8_t* buf
= (uint8_t*)urb
->transfer_buffer
+ urb
->transfer_buffer_length
;
449 buf
[3] = (p0
& 0xf0) | snd_usbmidi_cin_length
[p0
& 0x0f];
450 urb
->transfer_buffer_length
+= 4;
454 * Converts MIDI commands to USB MIDI packets.
456 static void snd_usbmidi_transmit_byte(struct usbmidi_out_port
* port
,
457 uint8_t b
, struct urb
* urb
)
459 uint8_t p0
= port
->cable
;
460 void (*output_packet
)(struct urb
*, uint8_t, uint8_t, uint8_t, uint8_t) =
461 port
->ep
->umidi
->usb_protocol_ops
->output_packet
;
464 output_packet(urb
, p0
| 0x0f, b
, 0, 0);
465 } else if (b
>= 0xf0) {
469 port
->state
= STATE_SYSEX_1
;
474 port
->state
= STATE_1PARAM
;
478 port
->state
= STATE_2PARAM_1
;
482 port
->state
= STATE_UNKNOWN
;
485 output_packet(urb
, p0
| 0x05, 0xf6, 0, 0);
486 port
->state
= STATE_UNKNOWN
;
489 switch (port
->state
) {
491 output_packet(urb
, p0
| 0x05, 0xf7, 0, 0);
494 output_packet(urb
, p0
| 0x06, port
->data
[0], 0xf7, 0);
497 output_packet(urb
, p0
| 0x07, port
->data
[0], port
->data
[1], 0xf7);
500 port
->state
= STATE_UNKNOWN
;
503 } else if (b
>= 0x80) {
505 if (b
>= 0xc0 && b
<= 0xdf)
506 port
->state
= STATE_1PARAM
;
508 port
->state
= STATE_2PARAM_1
;
509 } else { /* b < 0x80 */
510 switch (port
->state
) {
512 if (port
->data
[0] < 0xf0) {
513 p0
|= port
->data
[0] >> 4;
516 port
->state
= STATE_UNKNOWN
;
518 output_packet(urb
, p0
, port
->data
[0], b
, 0);
522 port
->state
= STATE_2PARAM_2
;
525 if (port
->data
[0] < 0xf0) {
526 p0
|= port
->data
[0] >> 4;
527 port
->state
= STATE_2PARAM_1
;
530 port
->state
= STATE_UNKNOWN
;
532 output_packet(urb
, p0
, port
->data
[0], port
->data
[1], b
);
536 port
->state
= STATE_SYSEX_1
;
540 port
->state
= STATE_SYSEX_2
;
543 output_packet(urb
, p0
| 0x04, port
->data
[0], port
->data
[1], b
);
544 port
->state
= STATE_SYSEX_0
;
550 static void snd_usbmidi_standard_output(struct snd_usb_midi_out_endpoint
* ep
)
552 struct urb
* urb
= ep
->urb
;
555 /* FIXME: lower-numbered ports can starve higher-numbered ports */
556 for (p
= 0; p
< 0x10; ++p
) {
557 struct usbmidi_out_port
* port
= &ep
->ports
[p
];
560 while (urb
->transfer_buffer_length
+ 3 < ep
->max_transfer
) {
562 if (snd_rawmidi_transmit(port
->substream
, &b
, 1) != 1) {
566 snd_usbmidi_transmit_byte(port
, b
, urb
);
571 static struct usb_protocol_ops snd_usbmidi_standard_ops
= {
572 .input
= snd_usbmidi_standard_input
,
573 .output
= snd_usbmidi_standard_output
,
574 .output_packet
= snd_usbmidi_output_standard_packet
,
577 static struct usb_protocol_ops snd_usbmidi_midiman_ops
= {
578 .input
= snd_usbmidi_midiman_input
,
579 .output
= snd_usbmidi_standard_output
,
580 .output_packet
= snd_usbmidi_output_midiman_packet
,
583 static struct usb_protocol_ops snd_usbmidi_maudio_broken_running_status_ops
= {
584 .input
= snd_usbmidi_maudio_broken_running_status_input
,
585 .output
= snd_usbmidi_standard_output
,
586 .output_packet
= snd_usbmidi_output_standard_packet
,
589 static struct usb_protocol_ops snd_usbmidi_cme_ops
= {
590 .input
= snd_usbmidi_cme_input
,
591 .output
= snd_usbmidi_standard_output
,
592 .output_packet
= snd_usbmidi_output_standard_packet
,
596 * Novation USB MIDI protocol: number of data bytes is in the first byte
597 * (when receiving) (+1!) or in the second byte (when sending); data begins
601 static void snd_usbmidi_novation_input(struct snd_usb_midi_in_endpoint
* ep
,
602 uint8_t* buffer
, int buffer_length
)
604 if (buffer_length
< 2 || !buffer
[0] || buffer_length
< buffer
[0] + 1)
606 snd_usbmidi_input_data(ep
, 0, &buffer
[2], buffer
[0] - 1);
609 static void snd_usbmidi_novation_output(struct snd_usb_midi_out_endpoint
* ep
)
611 uint8_t* transfer_buffer
;
614 if (!ep
->ports
[0].active
)
616 transfer_buffer
= ep
->urb
->transfer_buffer
;
617 count
= snd_rawmidi_transmit(ep
->ports
[0].substream
,
619 ep
->max_transfer
- 2);
621 ep
->ports
[0].active
= 0;
624 transfer_buffer
[0] = 0;
625 transfer_buffer
[1] = count
;
626 ep
->urb
->transfer_buffer_length
= 2 + count
;
629 static struct usb_protocol_ops snd_usbmidi_novation_ops
= {
630 .input
= snd_usbmidi_novation_input
,
631 .output
= snd_usbmidi_novation_output
,
635 * "raw" protocol: used by the MOTU FastLane.
638 static void snd_usbmidi_raw_input(struct snd_usb_midi_in_endpoint
* ep
,
639 uint8_t* buffer
, int buffer_length
)
641 snd_usbmidi_input_data(ep
, 0, buffer
, buffer_length
);
644 static void snd_usbmidi_raw_output(struct snd_usb_midi_out_endpoint
* ep
)
648 if (!ep
->ports
[0].active
)
650 count
= snd_rawmidi_transmit(ep
->ports
[0].substream
,
651 ep
->urb
->transfer_buffer
,
654 ep
->ports
[0].active
= 0;
657 ep
->urb
->transfer_buffer_length
= count
;
660 static struct usb_protocol_ops snd_usbmidi_raw_ops
= {
661 .input
= snd_usbmidi_raw_input
,
662 .output
= snd_usbmidi_raw_output
,
666 * Emagic USB MIDI protocol: raw MIDI with "F5 xx" port switching.
669 static void snd_usbmidi_emagic_init_out(struct snd_usb_midi_out_endpoint
* ep
)
671 static const u8 init_data
[] = {
672 /* initialization magic: "get version" */
674 0x00, 0x20, 0x31, /* Emagic */
676 0x0b, /* version number request */
677 0x00, /* command version */
678 0x00, /* EEPROM, box 0 */
681 send_bulk_static_data(ep
, init_data
, sizeof(init_data
));
682 /* while we're at it, pour on more magic */
683 send_bulk_static_data(ep
, init_data
, sizeof(init_data
));
686 static void snd_usbmidi_emagic_finish_out(struct snd_usb_midi_out_endpoint
* ep
)
688 static const u8 finish_data
[] = {
689 /* switch to patch mode with last preset */
691 0x00, 0x20, 0x31, /* Emagic */
693 0x10, /* patch switch command */
694 0x00, /* command version */
695 0x7f, /* to all boxes */
696 0x40, /* last preset in EEPROM */
699 send_bulk_static_data(ep
, finish_data
, sizeof(finish_data
));
702 static void snd_usbmidi_emagic_input(struct snd_usb_midi_in_endpoint
* ep
,
703 uint8_t* buffer
, int buffer_length
)
707 /* FF indicates end of valid data */
708 for (i
= 0; i
< buffer_length
; ++i
)
709 if (buffer
[i
] == 0xff) {
714 /* handle F5 at end of last buffer */
718 while (buffer_length
> 0) {
719 /* determine size of data until next F5 */
720 for (i
= 0; i
< buffer_length
; ++i
)
721 if (buffer
[i
] == 0xf5)
723 snd_usbmidi_input_data(ep
, ep
->current_port
, buffer
, i
);
727 if (buffer_length
<= 0)
729 /* assert(buffer[0] == 0xf5); */
735 if (buffer_length
<= 0)
737 if (buffer
[0] < 0x80) {
738 ep
->current_port
= (buffer
[0] - 1) & 15;
746 static void snd_usbmidi_emagic_output(struct snd_usb_midi_out_endpoint
* ep
)
748 int port0
= ep
->current_port
;
749 uint8_t* buf
= ep
->urb
->transfer_buffer
;
750 int buf_free
= ep
->max_transfer
;
753 for (i
= 0; i
< 0x10; ++i
) {
754 /* round-robin, starting at the last current port */
755 int portnum
= (port0
+ i
) & 15;
756 struct usbmidi_out_port
* port
= &ep
->ports
[portnum
];
760 if (snd_rawmidi_transmit_peek(port
->substream
, buf
, 1) != 1) {
765 if (portnum
!= ep
->current_port
) {
768 ep
->current_port
= portnum
;
770 buf
[1] = (portnum
+ 1) & 15;
777 length
= snd_rawmidi_transmit(port
->substream
, buf
, buf_free
);
785 if (buf_free
< ep
->max_transfer
&& buf_free
> 0) {
789 ep
->urb
->transfer_buffer_length
= ep
->max_transfer
- buf_free
;
792 static struct usb_protocol_ops snd_usbmidi_emagic_ops
= {
793 .input
= snd_usbmidi_emagic_input
,
794 .output
= snd_usbmidi_emagic_output
,
795 .init_out_endpoint
= snd_usbmidi_emagic_init_out
,
796 .finish_out_endpoint
= snd_usbmidi_emagic_finish_out
,
800 static int snd_usbmidi_output_open(struct snd_rawmidi_substream
*substream
)
802 struct snd_usb_midi
* umidi
= substream
->rmidi
->private_data
;
803 struct usbmidi_out_port
* port
= NULL
;
806 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
)
807 if (umidi
->endpoints
[i
].out
)
808 for (j
= 0; j
< 0x10; ++j
)
809 if (umidi
->endpoints
[i
].out
->ports
[j
].substream
== substream
) {
810 port
= &umidi
->endpoints
[i
].out
->ports
[j
];
817 substream
->runtime
->private_data
= port
;
818 port
->state
= STATE_UNKNOWN
;
822 static int snd_usbmidi_output_close(struct snd_rawmidi_substream
*substream
)
827 static void snd_usbmidi_output_trigger(struct snd_rawmidi_substream
*substream
, int up
)
829 struct usbmidi_out_port
* port
= (struct usbmidi_out_port
*)substream
->runtime
->private_data
;
833 if (port
->ep
->umidi
->chip
->shutdown
) {
834 /* gobble up remaining bytes to prevent wait in
835 * snd_rawmidi_drain_output */
836 while (!snd_rawmidi_transmit_empty(substream
))
837 snd_rawmidi_transmit_ack(substream
, 1);
840 tasklet_hi_schedule(&port
->ep
->tasklet
);
844 static int snd_usbmidi_input_open(struct snd_rawmidi_substream
*substream
)
849 static int snd_usbmidi_input_close(struct snd_rawmidi_substream
*substream
)
854 static void snd_usbmidi_input_trigger(struct snd_rawmidi_substream
*substream
, int up
)
856 struct snd_usb_midi
* umidi
= substream
->rmidi
->private_data
;
859 set_bit(substream
->number
, &umidi
->input_triggered
);
861 clear_bit(substream
->number
, &umidi
->input_triggered
);
864 static struct snd_rawmidi_ops snd_usbmidi_output_ops
= {
865 .open
= snd_usbmidi_output_open
,
866 .close
= snd_usbmidi_output_close
,
867 .trigger
= snd_usbmidi_output_trigger
,
870 static struct snd_rawmidi_ops snd_usbmidi_input_ops
= {
871 .open
= snd_usbmidi_input_open
,
872 .close
= snd_usbmidi_input_close
,
873 .trigger
= snd_usbmidi_input_trigger
877 * Frees an input endpoint.
878 * May be called when ep hasn't been initialized completely.
880 static void snd_usbmidi_in_endpoint_delete(struct snd_usb_midi_in_endpoint
* ep
)
883 usb_buffer_free(ep
->umidi
->chip
->dev
,
884 ep
->urb
->transfer_buffer_length
,
885 ep
->urb
->transfer_buffer
,
886 ep
->urb
->transfer_dma
);
887 usb_free_urb(ep
->urb
);
893 * Creates an input endpoint.
895 static int snd_usbmidi_in_endpoint_create(struct snd_usb_midi
* umidi
,
896 struct snd_usb_midi_endpoint_info
* ep_info
,
897 struct snd_usb_midi_endpoint
* rep
)
899 struct snd_usb_midi_in_endpoint
* ep
;
905 ep
= kzalloc(sizeof(*ep
), GFP_KERNEL
);
910 ep
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
912 snd_usbmidi_in_endpoint_delete(ep
);
915 if (ep_info
->in_interval
)
916 pipe
= usb_rcvintpipe(umidi
->chip
->dev
, ep_info
->in_ep
);
918 pipe
= usb_rcvbulkpipe(umidi
->chip
->dev
, ep_info
->in_ep
);
919 length
= usb_maxpacket(umidi
->chip
->dev
, pipe
, 0);
920 buffer
= usb_buffer_alloc(umidi
->chip
->dev
, length
, GFP_KERNEL
,
921 &ep
->urb
->transfer_dma
);
923 snd_usbmidi_in_endpoint_delete(ep
);
926 if (ep_info
->in_interval
)
927 usb_fill_int_urb(ep
->urb
, umidi
->chip
->dev
, pipe
, buffer
,
928 length
, snd_usbmidi_in_urb_complete
, ep
,
929 ep_info
->in_interval
);
931 usb_fill_bulk_urb(ep
->urb
, umidi
->chip
->dev
, pipe
, buffer
,
932 length
, snd_usbmidi_in_urb_complete
, ep
);
933 ep
->urb
->transfer_flags
= URB_NO_TRANSFER_DMA_MAP
;
939 static unsigned int snd_usbmidi_count_bits(unsigned int x
)
943 for (bits
= 0; x
; ++bits
)
949 * Frees an output endpoint.
950 * May be called when ep hasn't been initialized completely.
952 static void snd_usbmidi_out_endpoint_delete(struct snd_usb_midi_out_endpoint
* ep
)
955 usb_buffer_free(ep
->umidi
->chip
->dev
, ep
->max_transfer
,
956 ep
->urb
->transfer_buffer
,
957 ep
->urb
->transfer_dma
);
958 usb_free_urb(ep
->urb
);
964 * Creates an output endpoint, and initializes output ports.
966 static int snd_usbmidi_out_endpoint_create(struct snd_usb_midi
* umidi
,
967 struct snd_usb_midi_endpoint_info
* ep_info
,
968 struct snd_usb_midi_endpoint
* rep
)
970 struct snd_usb_midi_out_endpoint
* ep
;
976 ep
= kzalloc(sizeof(*ep
), GFP_KERNEL
);
981 ep
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
983 snd_usbmidi_out_endpoint_delete(ep
);
986 /* we never use interrupt output pipes */
987 pipe
= usb_sndbulkpipe(umidi
->chip
->dev
, ep_info
->out_ep
);
988 if (umidi
->chip
->usb_id
== USB_ID(0x0a92, 0x1020)) /* ESI M4U */
989 /* FIXME: we need more URBs to get reasonable bandwidth here: */
990 ep
->max_transfer
= 4;
992 ep
->max_transfer
= usb_maxpacket(umidi
->chip
->dev
, pipe
, 1);
993 buffer
= usb_buffer_alloc(umidi
->chip
->dev
, ep
->max_transfer
,
994 GFP_KERNEL
, &ep
->urb
->transfer_dma
);
996 snd_usbmidi_out_endpoint_delete(ep
);
999 usb_fill_bulk_urb(ep
->urb
, umidi
->chip
->dev
, pipe
, buffer
,
1000 ep
->max_transfer
, snd_usbmidi_out_urb_complete
, ep
);
1001 ep
->urb
->transfer_flags
= URB_NO_TRANSFER_DMA_MAP
;
1003 spin_lock_init(&ep
->buffer_lock
);
1004 tasklet_init(&ep
->tasklet
, snd_usbmidi_out_tasklet
, (unsigned long)ep
);
1006 for (i
= 0; i
< 0x10; ++i
)
1007 if (ep_info
->out_cables
& (1 << i
)) {
1008 ep
->ports
[i
].ep
= ep
;
1009 ep
->ports
[i
].cable
= i
<< 4;
1012 if (umidi
->usb_protocol_ops
->init_out_endpoint
)
1013 umidi
->usb_protocol_ops
->init_out_endpoint(ep
);
1022 static void snd_usbmidi_free(struct snd_usb_midi
* umidi
)
1026 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1027 struct snd_usb_midi_endpoint
* ep
= &umidi
->endpoints
[i
];
1029 snd_usbmidi_out_endpoint_delete(ep
->out
);
1031 snd_usbmidi_in_endpoint_delete(ep
->in
);
1037 * Unlinks all URBs (must be done before the usb_device is deleted).
1039 void snd_usbmidi_disconnect(struct list_head
* p
)
1041 struct snd_usb_midi
* umidi
;
1044 umidi
= list_entry(p
, struct snd_usb_midi
, list
);
1045 del_timer_sync(&umidi
->error_timer
);
1046 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1047 struct snd_usb_midi_endpoint
* ep
= &umidi
->endpoints
[i
];
1049 tasklet_kill(&ep
->out
->tasklet
);
1050 if (ep
->out
&& ep
->out
->urb
) {
1051 usb_kill_urb(ep
->out
->urb
);
1052 if (umidi
->usb_protocol_ops
->finish_out_endpoint
)
1053 umidi
->usb_protocol_ops
->finish_out_endpoint(ep
->out
);
1056 usb_kill_urb(ep
->in
->urb
);
1060 static void snd_usbmidi_rawmidi_free(struct snd_rawmidi
*rmidi
)
1062 struct snd_usb_midi
* umidi
= rmidi
->private_data
;
1063 snd_usbmidi_free(umidi
);
1066 static struct snd_rawmidi_substream
*snd_usbmidi_find_substream(struct snd_usb_midi
* umidi
,
1067 int stream
, int number
)
1069 struct list_head
* list
;
1071 list_for_each(list
, &umidi
->rmidi
->streams
[stream
].substreams
) {
1072 struct snd_rawmidi_substream
*substream
= list_entry(list
, struct snd_rawmidi_substream
, list
);
1073 if (substream
->number
== number
)
1080 * This list specifies names for ports that do not fit into the standard
1081 * "(product) MIDI (n)" schema because they aren't external MIDI ports,
1082 * such as internal control or synthesizer ports.
1084 static struct port_info
{
1089 unsigned int seq_flags
;
1090 } snd_usbmidi_port_info
[] = {
1091 #define PORT_INFO(vendor, product, num, name_, voices_, flags) \
1092 { .id = USB_ID(vendor, product), \
1093 .port = num, .voices = voices_, \
1094 .name = name_, .seq_flags = flags }
1095 #define EXTERNAL_PORT(vendor, product, num, name) \
1096 PORT_INFO(vendor, product, num, name, 0, \
1097 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1098 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1099 SNDRV_SEQ_PORT_TYPE_PORT)
1100 #define CONTROL_PORT(vendor, product, num, name) \
1101 PORT_INFO(vendor, product, num, name, 0, \
1102 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1103 SNDRV_SEQ_PORT_TYPE_HARDWARE)
1104 #define ROLAND_SYNTH_PORT(vendor, product, num, name, voices) \
1105 PORT_INFO(vendor, product, num, name, voices, \
1106 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1107 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1108 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1109 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1110 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1111 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1112 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1113 #define SOUNDCANVAS_PORT(vendor, product, num, name, voices) \
1114 PORT_INFO(vendor, product, num, name, voices, \
1115 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1116 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1117 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1118 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1119 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1120 SNDRV_SEQ_PORT_TYPE_MIDI_MT32 | \
1121 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1122 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1124 CONTROL_PORT(0x0582, 0x0000, 2, "%s Control"),
1125 /* Roland SC-8850 */
1126 SOUNDCANVAS_PORT(0x0582, 0x0003, 0, "%s Part A", 128),
1127 SOUNDCANVAS_PORT(0x0582, 0x0003, 1, "%s Part B", 128),
1128 SOUNDCANVAS_PORT(0x0582, 0x0003, 2, "%s Part C", 128),
1129 SOUNDCANVAS_PORT(0x0582, 0x0003, 3, "%s Part D", 128),
1130 EXTERNAL_PORT(0x0582, 0x0003, 4, "%s MIDI 1"),
1131 EXTERNAL_PORT(0x0582, 0x0003, 5, "%s MIDI 2"),
1133 EXTERNAL_PORT(0x0582, 0x0004, 0, "%s MIDI"),
1134 CONTROL_PORT(0x0582, 0x0004, 1, "%s Control"),
1135 /* Roland SC-8820 */
1136 SOUNDCANVAS_PORT(0x0582, 0x0007, 0, "%s Part A", 64),
1137 SOUNDCANVAS_PORT(0x0582, 0x0007, 1, "%s Part B", 64),
1138 EXTERNAL_PORT(0x0582, 0x0007, 2, "%s MIDI"),
1140 SOUNDCANVAS_PORT(0x0582, 0x000b, 0, "%s Part A", 64),
1141 SOUNDCANVAS_PORT(0x0582, 0x000b, 1, "%s Part B", 64),
1142 EXTERNAL_PORT(0x0582, 0x000b, 2, "%s MIDI"),
1144 SOUNDCANVAS_PORT(0x0582, 0x000c, 0, "%s Part A", 64),
1145 SOUNDCANVAS_PORT(0x0582, 0x000c, 1, "%s Part B", 64),
1146 EXTERNAL_PORT(0x0582, 0x000c, 2, "%s MIDI"),
1148 CONTROL_PORT(0x0582, 0x0014, 8, "%s Control"),
1150 ROLAND_SYNTH_PORT(0x0582, 0x0016, 0, "%s Part A", 128),
1151 ROLAND_SYNTH_PORT(0x0582, 0x0016, 1, "%s Part B", 128),
1152 EXTERNAL_PORT(0x0582, 0x0016, 2, "%s MIDI 1"),
1153 EXTERNAL_PORT(0x0582, 0x0016, 3, "%s MIDI 2"),
1155 CONTROL_PORT(0x0582, 0x0023, 5, "%s Control"),
1157 ROLAND_SYNTH_PORT(0x0582, 0x0027, 0, "%s Part A", 64),
1158 ROLAND_SYNTH_PORT(0x0582, 0x0027, 1, "%s Part B", 64),
1159 EXTERNAL_PORT(0x0582, 0x0027, 2, "%s MIDI"),
1161 ROLAND_SYNTH_PORT(0x0582, 0x0029, 0, "%s Part A", 128),
1162 ROLAND_SYNTH_PORT(0x0582, 0x0029, 1, "%s Part B", 128),
1163 EXTERNAL_PORT(0x0582, 0x0029, 2, "%s MIDI 1"),
1164 EXTERNAL_PORT(0x0582, 0x0029, 3, "%s MIDI 2"),
1166 EXTERNAL_PORT(0x0582, 0x002b, 0, "%s MIDI"),
1167 CONTROL_PORT(0x0582, 0x002b, 1, "%s Control"),
1169 EXTERNAL_PORT(0x0582, 0x002f, 0, "%s MIDI"),
1170 EXTERNAL_PORT(0x0582, 0x002f, 1, "%s External MIDI"),
1171 EXTERNAL_PORT(0x0582, 0x002f, 2, "%s Sync"),
1173 EXTERNAL_PORT(0x0582, 0x0033, 0, "%s MIDI"),
1174 EXTERNAL_PORT(0x0582, 0x0033, 1, "%s 1"),
1175 EXTERNAL_PORT(0x0582, 0x0033, 2, "%s 2"),
1177 EXTERNAL_PORT(0x0582, 0x003b, 0, "%s MIDI"),
1178 CONTROL_PORT(0x0582, 0x003b, 1, "%s Control"),
1179 /* Edirol UA-1000 */
1180 EXTERNAL_PORT(0x0582, 0x0044, 0, "%s MIDI"),
1181 CONTROL_PORT(0x0582, 0x0044, 1, "%s Control"),
1183 EXTERNAL_PORT(0x0582, 0x0048, 0, "%s MIDI"),
1184 EXTERNAL_PORT(0x0582, 0x0048, 1, "%s 1"),
1185 EXTERNAL_PORT(0x0582, 0x0048, 2, "%s 2"),
1187 EXTERNAL_PORT(0x0582, 0x004d, 0, "%s MIDI"),
1188 EXTERNAL_PORT(0x0582, 0x004d, 1, "%s 1"),
1189 EXTERNAL_PORT(0x0582, 0x004d, 2, "%s 2"),
1191 CONTROL_PORT(0x0582, 0x009a, 3, "%s Control"),
1192 /* M-Audio MidiSport 8x8 */
1193 CONTROL_PORT(0x0763, 0x1031, 8, "%s Control"),
1194 CONTROL_PORT(0x0763, 0x1033, 8, "%s Control"),
1196 EXTERNAL_PORT(0x07fd, 0x0001, 0, "%s MIDI A"),
1197 EXTERNAL_PORT(0x07fd, 0x0001, 1, "%s MIDI B"),
1198 /* Emagic Unitor8/AMT8/MT4 */
1199 EXTERNAL_PORT(0x086a, 0x0001, 8, "%s Broadcast"),
1200 EXTERNAL_PORT(0x086a, 0x0002, 8, "%s Broadcast"),
1201 EXTERNAL_PORT(0x086a, 0x0003, 4, "%s Broadcast"),
1204 static struct port_info
*find_port_info(struct snd_usb_midi
* umidi
, int number
)
1208 for (i
= 0; i
< ARRAY_SIZE(snd_usbmidi_port_info
); ++i
) {
1209 if (snd_usbmidi_port_info
[i
].id
== umidi
->chip
->usb_id
&&
1210 snd_usbmidi_port_info
[i
].port
== number
)
1211 return &snd_usbmidi_port_info
[i
];
1216 static void snd_usbmidi_get_port_info(struct snd_rawmidi
*rmidi
, int number
,
1217 struct snd_seq_port_info
*seq_port_info
)
1219 struct snd_usb_midi
*umidi
= rmidi
->private_data
;
1220 struct port_info
*port_info
;
1222 /* TODO: read port flags from descriptors */
1223 port_info
= find_port_info(umidi
, number
);
1225 seq_port_info
->type
= port_info
->seq_flags
;
1226 seq_port_info
->midi_voices
= port_info
->voices
;
1230 static void snd_usbmidi_init_substream(struct snd_usb_midi
* umidi
,
1231 int stream
, int number
,
1232 struct snd_rawmidi_substream
** rsubstream
)
1234 struct port_info
*port_info
;
1235 const char *name_format
;
1237 struct snd_rawmidi_substream
*substream
= snd_usbmidi_find_substream(umidi
, stream
, number
);
1239 snd_printd(KERN_ERR
"substream %d:%d not found\n", stream
, number
);
1243 /* TODO: read port name from jack descriptor */
1244 port_info
= find_port_info(umidi
, number
);
1245 name_format
= port_info
? port_info
->name
: "%s MIDI %d";
1246 snprintf(substream
->name
, sizeof(substream
->name
),
1247 name_format
, umidi
->chip
->card
->shortname
, number
+ 1);
1249 *rsubstream
= substream
;
1253 * Creates the endpoints and their ports.
1255 static int snd_usbmidi_create_endpoints(struct snd_usb_midi
* umidi
,
1256 struct snd_usb_midi_endpoint_info
* endpoints
)
1259 int out_ports
= 0, in_ports
= 0;
1261 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1262 if (endpoints
[i
].out_cables
) {
1263 err
= snd_usbmidi_out_endpoint_create(umidi
, &endpoints
[i
],
1264 &umidi
->endpoints
[i
]);
1268 if (endpoints
[i
].in_cables
) {
1269 err
= snd_usbmidi_in_endpoint_create(umidi
, &endpoints
[i
],
1270 &umidi
->endpoints
[i
]);
1275 for (j
= 0; j
< 0x10; ++j
) {
1276 if (endpoints
[i
].out_cables
& (1 << j
)) {
1277 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, out_ports
,
1278 &umidi
->endpoints
[i
].out
->ports
[j
].substream
);
1281 if (endpoints
[i
].in_cables
& (1 << j
)) {
1282 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_INPUT
, in_ports
,
1283 &umidi
->endpoints
[i
].in
->ports
[j
].substream
);
1288 snd_printdd(KERN_INFO
"created %d output and %d input ports\n",
1289 out_ports
, in_ports
);
1294 * Returns MIDIStreaming device capabilities.
1296 static int snd_usbmidi_get_ms_info(struct snd_usb_midi
* umidi
,
1297 struct snd_usb_midi_endpoint_info
* endpoints
)
1299 struct usb_interface
* intf
;
1300 struct usb_host_interface
*hostif
;
1301 struct usb_interface_descriptor
* intfd
;
1302 struct usb_ms_header_descriptor
* ms_header
;
1303 struct usb_host_endpoint
*hostep
;
1304 struct usb_endpoint_descriptor
* ep
;
1305 struct usb_ms_endpoint_descriptor
* ms_ep
;
1308 intf
= umidi
->iface
;
1311 hostif
= &intf
->altsetting
[0];
1312 intfd
= get_iface_desc(hostif
);
1313 ms_header
= (struct usb_ms_header_descriptor
*)hostif
->extra
;
1314 if (hostif
->extralen
>= 7 &&
1315 ms_header
->bLength
>= 7 &&
1316 ms_header
->bDescriptorType
== USB_DT_CS_INTERFACE
&&
1317 ms_header
->bDescriptorSubtype
== HEADER
)
1318 snd_printdd(KERN_INFO
"MIDIStreaming version %02x.%02x\n",
1319 ms_header
->bcdMSC
[1], ms_header
->bcdMSC
[0]);
1321 snd_printk(KERN_WARNING
"MIDIStreaming interface descriptor not found\n");
1324 for (i
= 0; i
< intfd
->bNumEndpoints
; ++i
) {
1325 hostep
= &hostif
->endpoint
[i
];
1326 ep
= get_ep_desc(hostep
);
1327 if ((ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
&&
1328 (ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_INT
)
1330 ms_ep
= (struct usb_ms_endpoint_descriptor
*)hostep
->extra
;
1331 if (hostep
->extralen
< 4 ||
1332 ms_ep
->bLength
< 4 ||
1333 ms_ep
->bDescriptorType
!= USB_DT_CS_ENDPOINT
||
1334 ms_ep
->bDescriptorSubtype
!= MS_GENERAL
)
1336 if ((ep
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_OUT
) {
1337 if (endpoints
[epidx
].out_ep
) {
1338 if (++epidx
>= MIDI_MAX_ENDPOINTS
) {
1339 snd_printk(KERN_WARNING
"too many endpoints\n");
1343 endpoints
[epidx
].out_ep
= ep
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1344 if ((ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) == USB_ENDPOINT_XFER_INT
)
1345 endpoints
[epidx
].out_interval
= ep
->bInterval
;
1346 endpoints
[epidx
].out_cables
= (1 << ms_ep
->bNumEmbMIDIJack
) - 1;
1347 snd_printdd(KERN_INFO
"EP %02X: %d jack(s)\n",
1348 ep
->bEndpointAddress
, ms_ep
->bNumEmbMIDIJack
);
1350 if (endpoints
[epidx
].in_ep
) {
1351 if (++epidx
>= MIDI_MAX_ENDPOINTS
) {
1352 snd_printk(KERN_WARNING
"too many endpoints\n");
1356 endpoints
[epidx
].in_ep
= ep
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1357 if ((ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) == USB_ENDPOINT_XFER_INT
)
1358 endpoints
[epidx
].in_interval
= ep
->bInterval
;
1359 endpoints
[epidx
].in_cables
= (1 << ms_ep
->bNumEmbMIDIJack
) - 1;
1360 snd_printdd(KERN_INFO
"EP %02X: %d jack(s)\n",
1361 ep
->bEndpointAddress
, ms_ep
->bNumEmbMIDIJack
);
1368 * On Roland devices, use the second alternate setting to be able to use
1369 * the interrupt input endpoint.
1371 static void snd_usbmidi_switch_roland_altsetting(struct snd_usb_midi
* umidi
)
1373 struct usb_interface
* intf
;
1374 struct usb_host_interface
*hostif
;
1375 struct usb_interface_descriptor
* intfd
;
1377 intf
= umidi
->iface
;
1378 if (!intf
|| intf
->num_altsetting
!= 2)
1381 hostif
= &intf
->altsetting
[1];
1382 intfd
= get_iface_desc(hostif
);
1383 if (intfd
->bNumEndpoints
!= 2 ||
1384 (get_endpoint(hostif
, 0)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
||
1385 (get_endpoint(hostif
, 1)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_INT
)
1388 snd_printdd(KERN_INFO
"switching to altsetting %d with int ep\n",
1389 intfd
->bAlternateSetting
);
1390 usb_set_interface(umidi
->chip
->dev
, intfd
->bInterfaceNumber
,
1391 intfd
->bAlternateSetting
);
1395 * Try to find any usable endpoints in the interface.
1397 static int snd_usbmidi_detect_endpoints(struct snd_usb_midi
* umidi
,
1398 struct snd_usb_midi_endpoint_info
* endpoint
,
1401 struct usb_interface
* intf
;
1402 struct usb_host_interface
*hostif
;
1403 struct usb_interface_descriptor
* intfd
;
1404 struct usb_endpoint_descriptor
* epd
;
1405 int i
, out_eps
= 0, in_eps
= 0;
1407 if (USB_ID_VENDOR(umidi
->chip
->usb_id
) == 0x0582)
1408 snd_usbmidi_switch_roland_altsetting(umidi
);
1410 if (endpoint
[0].out_ep
|| endpoint
[0].in_ep
)
1413 intf
= umidi
->iface
;
1414 if (!intf
|| intf
->num_altsetting
< 1)
1416 hostif
= intf
->cur_altsetting
;
1417 intfd
= get_iface_desc(hostif
);
1419 for (i
= 0; i
< intfd
->bNumEndpoints
; ++i
) {
1420 epd
= get_endpoint(hostif
, i
);
1421 if ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
&&
1422 (epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_INT
)
1424 if (out_eps
< max_endpoints
&&
1425 (epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_OUT
) {
1426 endpoint
[out_eps
].out_ep
= epd
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1427 if ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) == USB_ENDPOINT_XFER_INT
)
1428 endpoint
[out_eps
].out_interval
= epd
->bInterval
;
1431 if (in_eps
< max_endpoints
&&
1432 (epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_IN
) {
1433 endpoint
[in_eps
].in_ep
= epd
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1434 if ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) == USB_ENDPOINT_XFER_INT
)
1435 endpoint
[in_eps
].in_interval
= epd
->bInterval
;
1439 return (out_eps
|| in_eps
) ? 0 : -ENOENT
;
1443 * Detects the endpoints for one-port-per-endpoint protocols.
1445 static int snd_usbmidi_detect_per_port_endpoints(struct snd_usb_midi
* umidi
,
1446 struct snd_usb_midi_endpoint_info
* endpoints
)
1450 err
= snd_usbmidi_detect_endpoints(umidi
, endpoints
, MIDI_MAX_ENDPOINTS
);
1451 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1452 if (endpoints
[i
].out_ep
)
1453 endpoints
[i
].out_cables
= 0x0001;
1454 if (endpoints
[i
].in_ep
)
1455 endpoints
[i
].in_cables
= 0x0001;
1461 * Detects the endpoints and ports of Yamaha devices.
1463 static int snd_usbmidi_detect_yamaha(struct snd_usb_midi
* umidi
,
1464 struct snd_usb_midi_endpoint_info
* endpoint
)
1466 struct usb_interface
* intf
;
1467 struct usb_host_interface
*hostif
;
1468 struct usb_interface_descriptor
* intfd
;
1471 intf
= umidi
->iface
;
1474 hostif
= intf
->altsetting
;
1475 intfd
= get_iface_desc(hostif
);
1476 if (intfd
->bNumEndpoints
< 1)
1480 * For each port there is one MIDI_IN/OUT_JACK descriptor, not
1481 * necessarily with any useful contents. So simply count 'em.
1483 for (cs_desc
= hostif
->extra
;
1484 cs_desc
< hostif
->extra
+ hostif
->extralen
&& cs_desc
[0] >= 2;
1485 cs_desc
+= cs_desc
[0]) {
1486 if (cs_desc
[1] == USB_DT_CS_INTERFACE
) {
1487 if (cs_desc
[2] == MIDI_IN_JACK
)
1488 endpoint
->in_cables
= (endpoint
->in_cables
<< 1) | 1;
1489 else if (cs_desc
[2] == MIDI_OUT_JACK
)
1490 endpoint
->out_cables
= (endpoint
->out_cables
<< 1) | 1;
1493 if (!endpoint
->in_cables
&& !endpoint
->out_cables
)
1496 return snd_usbmidi_detect_endpoints(umidi
, endpoint
, 1);
1500 * Creates the endpoints and their ports for Midiman devices.
1502 static int snd_usbmidi_create_endpoints_midiman(struct snd_usb_midi
* umidi
,
1503 struct snd_usb_midi_endpoint_info
* endpoint
)
1505 struct snd_usb_midi_endpoint_info ep_info
;
1506 struct usb_interface
* intf
;
1507 struct usb_host_interface
*hostif
;
1508 struct usb_interface_descriptor
* intfd
;
1509 struct usb_endpoint_descriptor
* epd
;
1512 intf
= umidi
->iface
;
1515 hostif
= intf
->altsetting
;
1516 intfd
= get_iface_desc(hostif
);
1518 * The various MidiSport devices have more or less random endpoint
1519 * numbers, so we have to identify the endpoints by their index in
1520 * the descriptor array, like the driver for that other OS does.
1522 * There is one interrupt input endpoint for all input ports, one
1523 * bulk output endpoint for even-numbered ports, and one for odd-
1524 * numbered ports. Both bulk output endpoints have corresponding
1525 * input bulk endpoints (at indices 1 and 3) which aren't used.
1527 if (intfd
->bNumEndpoints
< (endpoint
->out_cables
> 0x0001 ? 5 : 3)) {
1528 snd_printdd(KERN_ERR
"not enough endpoints\n");
1532 epd
= get_endpoint(hostif
, 0);
1533 if ((epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) != USB_DIR_IN
||
1534 (epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_INT
) {
1535 snd_printdd(KERN_ERR
"endpoint[0] isn't interrupt\n");
1538 epd
= get_endpoint(hostif
, 2);
1539 if ((epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) != USB_DIR_OUT
||
1540 (epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
) {
1541 snd_printdd(KERN_ERR
"endpoint[2] isn't bulk output\n");
1544 if (endpoint
->out_cables
> 0x0001) {
1545 epd
= get_endpoint(hostif
, 4);
1546 if ((epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) != USB_DIR_OUT
||
1547 (epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
) {
1548 snd_printdd(KERN_ERR
"endpoint[4] isn't bulk output\n");
1553 ep_info
.out_ep
= get_endpoint(hostif
, 2)->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1554 ep_info
.out_cables
= endpoint
->out_cables
& 0x5555;
1555 err
= snd_usbmidi_out_endpoint_create(umidi
, &ep_info
, &umidi
->endpoints
[0]);
1559 ep_info
.in_ep
= get_endpoint(hostif
, 0)->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1560 ep_info
.in_interval
= get_endpoint(hostif
, 0)->bInterval
;
1561 ep_info
.in_cables
= endpoint
->in_cables
;
1562 err
= snd_usbmidi_in_endpoint_create(umidi
, &ep_info
, &umidi
->endpoints
[0]);
1566 if (endpoint
->out_cables
> 0x0001) {
1567 ep_info
.out_ep
= get_endpoint(hostif
, 4)->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1568 ep_info
.out_cables
= endpoint
->out_cables
& 0xaaaa;
1569 err
= snd_usbmidi_out_endpoint_create(umidi
, &ep_info
, &umidi
->endpoints
[1]);
1574 for (cable
= 0; cable
< 0x10; ++cable
) {
1575 if (endpoint
->out_cables
& (1 << cable
))
1576 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, cable
,
1577 &umidi
->endpoints
[cable
& 1].out
->ports
[cable
].substream
);
1578 if (endpoint
->in_cables
& (1 << cable
))
1579 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_INPUT
, cable
,
1580 &umidi
->endpoints
[0].in
->ports
[cable
].substream
);
1585 static struct snd_rawmidi_global_ops snd_usbmidi_ops
= {
1586 .get_port_info
= snd_usbmidi_get_port_info
,
1589 static int snd_usbmidi_create_rawmidi(struct snd_usb_midi
* umidi
,
1590 int out_ports
, int in_ports
)
1592 struct snd_rawmidi
*rmidi
;
1595 err
= snd_rawmidi_new(umidi
->chip
->card
, "USB MIDI",
1596 umidi
->chip
->next_midi_device
++,
1597 out_ports
, in_ports
, &rmidi
);
1600 strcpy(rmidi
->name
, umidi
->chip
->card
->shortname
);
1601 rmidi
->info_flags
= SNDRV_RAWMIDI_INFO_OUTPUT
|
1602 SNDRV_RAWMIDI_INFO_INPUT
|
1603 SNDRV_RAWMIDI_INFO_DUPLEX
;
1604 rmidi
->ops
= &snd_usbmidi_ops
;
1605 rmidi
->private_data
= umidi
;
1606 rmidi
->private_free
= snd_usbmidi_rawmidi_free
;
1607 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, &snd_usbmidi_output_ops
);
1608 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_INPUT
, &snd_usbmidi_input_ops
);
1610 umidi
->rmidi
= rmidi
;
1615 * Temporarily stop input.
1617 void snd_usbmidi_input_stop(struct list_head
* p
)
1619 struct snd_usb_midi
* umidi
;
1622 umidi
= list_entry(p
, struct snd_usb_midi
, list
);
1623 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1624 struct snd_usb_midi_endpoint
* ep
= &umidi
->endpoints
[i
];
1626 usb_kill_urb(ep
->in
->urb
);
1630 static void snd_usbmidi_input_start_ep(struct snd_usb_midi_in_endpoint
* ep
)
1633 struct urb
* urb
= ep
->urb
;
1634 urb
->dev
= ep
->umidi
->chip
->dev
;
1635 snd_usbmidi_submit_urb(urb
, GFP_KERNEL
);
1640 * Resume input after a call to snd_usbmidi_input_stop().
1642 void snd_usbmidi_input_start(struct list_head
* p
)
1644 struct snd_usb_midi
* umidi
;
1647 umidi
= list_entry(p
, struct snd_usb_midi
, list
);
1648 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
)
1649 snd_usbmidi_input_start_ep(umidi
->endpoints
[i
].in
);
1653 * Creates and registers everything needed for a MIDI streaming interface.
1655 int snd_usb_create_midi_interface(struct snd_usb_audio
* chip
,
1656 struct usb_interface
* iface
,
1657 const struct snd_usb_audio_quirk
* quirk
)
1659 struct snd_usb_midi
* umidi
;
1660 struct snd_usb_midi_endpoint_info endpoints
[MIDI_MAX_ENDPOINTS
];
1661 int out_ports
, in_ports
;
1664 umidi
= kzalloc(sizeof(*umidi
), GFP_KERNEL
);
1668 umidi
->iface
= iface
;
1669 umidi
->quirk
= quirk
;
1670 umidi
->usb_protocol_ops
= &snd_usbmidi_standard_ops
;
1671 init_timer(&umidi
->error_timer
);
1672 umidi
->error_timer
.function
= snd_usbmidi_error_timer
;
1673 umidi
->error_timer
.data
= (unsigned long)umidi
;
1675 /* detect the endpoint(s) to use */
1676 memset(endpoints
, 0, sizeof(endpoints
));
1677 switch (quirk
? quirk
->type
: QUIRK_MIDI_STANDARD_INTERFACE
) {
1678 case QUIRK_MIDI_STANDARD_INTERFACE
:
1679 err
= snd_usbmidi_get_ms_info(umidi
, endpoints
);
1680 if (chip
->usb_id
== USB_ID(0x0763, 0x0150)) /* M-Audio Uno */
1681 umidi
->usb_protocol_ops
=
1682 &snd_usbmidi_maudio_broken_running_status_ops
;
1684 case QUIRK_MIDI_FIXED_ENDPOINT
:
1685 memcpy(&endpoints
[0], quirk
->data
,
1686 sizeof(struct snd_usb_midi_endpoint_info
));
1687 err
= snd_usbmidi_detect_endpoints(umidi
, &endpoints
[0], 1);
1689 case QUIRK_MIDI_YAMAHA
:
1690 err
= snd_usbmidi_detect_yamaha(umidi
, &endpoints
[0]);
1692 case QUIRK_MIDI_MIDIMAN
:
1693 umidi
->usb_protocol_ops
= &snd_usbmidi_midiman_ops
;
1694 memcpy(&endpoints
[0], quirk
->data
,
1695 sizeof(struct snd_usb_midi_endpoint_info
));
1698 case QUIRK_MIDI_NOVATION
:
1699 umidi
->usb_protocol_ops
= &snd_usbmidi_novation_ops
;
1700 err
= snd_usbmidi_detect_per_port_endpoints(umidi
, endpoints
);
1702 case QUIRK_MIDI_RAW
:
1703 umidi
->usb_protocol_ops
= &snd_usbmidi_raw_ops
;
1704 err
= snd_usbmidi_detect_per_port_endpoints(umidi
, endpoints
);
1706 case QUIRK_MIDI_EMAGIC
:
1707 umidi
->usb_protocol_ops
= &snd_usbmidi_emagic_ops
;
1708 memcpy(&endpoints
[0], quirk
->data
,
1709 sizeof(struct snd_usb_midi_endpoint_info
));
1710 err
= snd_usbmidi_detect_endpoints(umidi
, &endpoints
[0], 1);
1712 case QUIRK_MIDI_CME
:
1713 umidi
->usb_protocol_ops
= &snd_usbmidi_cme_ops
;
1714 err
= snd_usbmidi_detect_per_port_endpoints(umidi
, endpoints
);
1717 snd_printd(KERN_ERR
"invalid quirk type %d\n", quirk
->type
);
1726 /* create rawmidi device */
1729 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1730 out_ports
+= snd_usbmidi_count_bits(endpoints
[i
].out_cables
);
1731 in_ports
+= snd_usbmidi_count_bits(endpoints
[i
].in_cables
);
1733 err
= snd_usbmidi_create_rawmidi(umidi
, out_ports
, in_ports
);
1739 /* create endpoint/port structures */
1740 if (quirk
&& quirk
->type
== QUIRK_MIDI_MIDIMAN
)
1741 err
= snd_usbmidi_create_endpoints_midiman(umidi
, &endpoints
[0]);
1743 err
= snd_usbmidi_create_endpoints(umidi
, endpoints
);
1745 snd_usbmidi_free(umidi
);
1749 list_add(&umidi
->list
, &umidi
->chip
->midi_list
);
1751 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
)
1752 snd_usbmidi_input_start_ep(umidi
->endpoints
[i
].in
);
1756 EXPORT_SYMBOL(snd_usb_create_midi_interface
);
1757 EXPORT_SYMBOL(snd_usbmidi_input_stop
);
1758 EXPORT_SYMBOL(snd_usbmidi_input_start
);
1759 EXPORT_SYMBOL(snd_usbmidi_disconnect
);