2 * usbmidi.c - ALSA USB MIDI driver
4 * Copyright (c) 2002-2005 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/minors.h>
51 #include <sound/rawmidi.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 typedef struct snd_usb_midi snd_usb_midi_t
;
89 typedef struct snd_usb_midi_endpoint snd_usb_midi_endpoint_t
;
90 typedef struct snd_usb_midi_out_endpoint snd_usb_midi_out_endpoint_t
;
91 typedef struct snd_usb_midi_in_endpoint snd_usb_midi_in_endpoint_t
;
92 typedef struct usbmidi_out_port usbmidi_out_port_t
;
93 typedef struct usbmidi_in_port usbmidi_in_port_t
;
95 struct usb_protocol_ops
{
96 void (*input
)(snd_usb_midi_in_endpoint_t
*, uint8_t*, int);
97 void (*output
)(snd_usb_midi_out_endpoint_t
*);
98 void (*output_packet
)(struct urb
*, uint8_t, uint8_t, uint8_t, uint8_t);
99 void (*init_out_endpoint
)(snd_usb_midi_out_endpoint_t
*);
100 void (*finish_out_endpoint
)(snd_usb_midi_out_endpoint_t
*);
103 struct snd_usb_midi
{
104 snd_usb_audio_t
*chip
;
105 struct usb_interface
*iface
;
106 const snd_usb_audio_quirk_t
*quirk
;
107 snd_rawmidi_t
* rmidi
;
108 struct usb_protocol_ops
* usb_protocol_ops
;
109 struct list_head list
;
110 struct timer_list error_timer
;
112 struct snd_usb_midi_endpoint
{
113 snd_usb_midi_out_endpoint_t
*out
;
114 snd_usb_midi_in_endpoint_t
*in
;
115 } endpoints
[MIDI_MAX_ENDPOINTS
];
116 unsigned long input_triggered
;
119 struct snd_usb_midi_out_endpoint
{
120 snd_usb_midi_t
* umidi
;
123 int max_transfer
; /* size of urb buffer */
124 struct tasklet_struct tasklet
;
126 spinlock_t buffer_lock
;
128 struct usbmidi_out_port
{
129 snd_usb_midi_out_endpoint_t
* ep
;
130 snd_rawmidi_substream_t
* substream
;
132 uint8_t cable
; /* cable number << 4 */
134 #define STATE_UNKNOWN 0
135 #define STATE_1PARAM 1
136 #define STATE_2PARAM_1 2
137 #define STATE_2PARAM_2 3
138 #define STATE_SYSEX_0 4
139 #define STATE_SYSEX_1 5
140 #define STATE_SYSEX_2 6
146 struct snd_usb_midi_in_endpoint
{
147 snd_usb_midi_t
* umidi
;
149 struct usbmidi_in_port
{
150 snd_rawmidi_substream_t
* substream
;
157 static void snd_usbmidi_do_output(snd_usb_midi_out_endpoint_t
* ep
);
159 static const uint8_t snd_usbmidi_cin_length
[] = {
160 0, 0, 2, 3, 3, 1, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1
164 * Submits the URB, with error handling.
166 static int snd_usbmidi_submit_urb(struct urb
* urb
, gfp_t flags
)
168 int err
= usb_submit_urb(urb
, flags
);
169 if (err
< 0 && err
!= -ENODEV
)
170 snd_printk(KERN_ERR
"usb_submit_urb: %d\n", err
);
175 * Error handling for URB completion functions.
177 static int snd_usbmidi_urb_error(int status
)
180 /* manually unlinked, or device gone */
186 /* errors that might occur during unplugging */
187 case -EPROTO
: /* EHCI */
188 case -ETIMEDOUT
: /* OHCI */
189 case -EILSEQ
: /* UHCI */
192 snd_printk(KERN_ERR
"urb status %d\n", status
);
193 return 0; /* continue */
198 * Receives a chunk of MIDI data.
200 static void snd_usbmidi_input_data(snd_usb_midi_in_endpoint_t
* ep
, int portidx
,
201 uint8_t* data
, int length
)
203 usbmidi_in_port_t
* port
= &ep
->ports
[portidx
];
205 if (!port
->substream
) {
206 snd_printd("unexpected port %d!\n", portidx
);
209 if (!test_bit(port
->substream
->number
, &ep
->umidi
->input_triggered
))
211 snd_rawmidi_receive(port
->substream
, data
, length
);
215 static void dump_urb(const char *type
, const u8
*data
, int length
)
217 snd_printk(KERN_DEBUG
"%s packet: [", type
);
218 for (; length
> 0; ++data
, --length
)
219 printk(" %02x", *data
);
223 #define dump_urb(type, data, length) /* nothing */
227 * Processes the data read from the device.
229 static void snd_usbmidi_in_urb_complete(struct urb
* urb
, struct pt_regs
*regs
)
231 snd_usb_midi_in_endpoint_t
* ep
= urb
->context
;
233 if (urb
->status
== 0) {
234 dump_urb("received", urb
->transfer_buffer
, urb
->actual_length
);
235 ep
->umidi
->usb_protocol_ops
->input(ep
, urb
->transfer_buffer
,
238 int err
= snd_usbmidi_urb_error(urb
->status
);
240 if (err
!= -ENODEV
) {
241 ep
->error_resubmit
= 1;
242 mod_timer(&ep
->umidi
->error_timer
,
243 jiffies
+ ERROR_DELAY_JIFFIES
);
249 if (usb_pipe_needs_resubmit(urb
->pipe
)) {
250 urb
->dev
= ep
->umidi
->chip
->dev
;
251 snd_usbmidi_submit_urb(urb
, GFP_ATOMIC
);
255 static void snd_usbmidi_out_urb_complete(struct urb
* urb
, struct pt_regs
*regs
)
257 snd_usb_midi_out_endpoint_t
* ep
= urb
->context
;
259 spin_lock(&ep
->buffer_lock
);
261 spin_unlock(&ep
->buffer_lock
);
262 if (urb
->status
< 0) {
263 int err
= snd_usbmidi_urb_error(urb
->status
);
266 mod_timer(&ep
->umidi
->error_timer
,
267 jiffies
+ ERROR_DELAY_JIFFIES
);
271 snd_usbmidi_do_output(ep
);
275 * This is called when some data should be transferred to the device
276 * (from one or more substreams).
278 static void snd_usbmidi_do_output(snd_usb_midi_out_endpoint_t
* ep
)
280 struct urb
* urb
= ep
->urb
;
283 spin_lock_irqsave(&ep
->buffer_lock
, flags
);
284 if (ep
->urb_active
|| ep
->umidi
->chip
->shutdown
) {
285 spin_unlock_irqrestore(&ep
->buffer_lock
, flags
);
289 urb
->transfer_buffer_length
= 0;
290 ep
->umidi
->usb_protocol_ops
->output(ep
);
292 if (urb
->transfer_buffer_length
> 0) {
293 dump_urb("sending", urb
->transfer_buffer
,
294 urb
->transfer_buffer_length
);
295 urb
->dev
= ep
->umidi
->chip
->dev
;
296 ep
->urb_active
= snd_usbmidi_submit_urb(urb
, GFP_ATOMIC
) >= 0;
298 spin_unlock_irqrestore(&ep
->buffer_lock
, flags
);
301 static void snd_usbmidi_out_tasklet(unsigned long data
)
303 snd_usb_midi_out_endpoint_t
* ep
= (snd_usb_midi_out_endpoint_t
*) data
;
305 snd_usbmidi_do_output(ep
);
308 /* called after transfers had been interrupted due to some USB error */
309 static void snd_usbmidi_error_timer(unsigned long data
)
311 snd_usb_midi_t
*umidi
= (snd_usb_midi_t
*)data
;
314 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
315 snd_usb_midi_in_endpoint_t
*in
= umidi
->endpoints
[i
].in
;
316 if (in
&& in
->error_resubmit
) {
317 in
->error_resubmit
= 0;
318 in
->urb
->dev
= umidi
->chip
->dev
;
319 snd_usbmidi_submit_urb(in
->urb
, GFP_ATOMIC
);
321 if (umidi
->endpoints
[i
].out
)
322 snd_usbmidi_do_output(umidi
->endpoints
[i
].out
);
326 /* helper function to send static data that may not DMA-able */
327 static int send_bulk_static_data(snd_usb_midi_out_endpoint_t
* ep
,
328 const void *data
, int len
)
331 void *buf
= kmalloc(len
, GFP_KERNEL
);
334 memcpy(buf
, data
, len
);
335 dump_urb("sending", buf
, len
);
336 err
= usb_bulk_msg(ep
->umidi
->chip
->dev
, ep
->urb
->pipe
, buf
, len
,
343 * Standard USB MIDI protocol: see the spec.
344 * Midiman protocol: like the standard protocol, but the control byte is the
345 * fourth byte in each packet, and uses length instead of CIN.
348 static void snd_usbmidi_standard_input(snd_usb_midi_in_endpoint_t
* ep
,
349 uint8_t* buffer
, int buffer_length
)
353 for (i
= 0; i
+ 3 < buffer_length
; i
+= 4)
354 if (buffer
[i
] != 0) {
355 int cable
= buffer
[i
] >> 4;
356 int length
= snd_usbmidi_cin_length
[buffer
[i
] & 0x0f];
357 snd_usbmidi_input_data(ep
, cable
, &buffer
[i
+ 1], length
);
361 static void snd_usbmidi_midiman_input(snd_usb_midi_in_endpoint_t
* ep
,
362 uint8_t* buffer
, int buffer_length
)
366 for (i
= 0; i
+ 3 < buffer_length
; i
+= 4)
367 if (buffer
[i
+ 3] != 0) {
368 int port
= buffer
[i
+ 3] >> 4;
369 int length
= buffer
[i
+ 3] & 3;
370 snd_usbmidi_input_data(ep
, port
, &buffer
[i
], length
);
375 * Adds one USB MIDI packet to the output buffer.
377 static void snd_usbmidi_output_standard_packet(struct urb
* urb
, uint8_t p0
,
378 uint8_t p1
, uint8_t p2
, uint8_t p3
)
381 uint8_t* buf
= (uint8_t*)urb
->transfer_buffer
+ urb
->transfer_buffer_length
;
386 urb
->transfer_buffer_length
+= 4;
390 * Adds one Midiman packet to the output buffer.
392 static void snd_usbmidi_output_midiman_packet(struct urb
* urb
, uint8_t p0
,
393 uint8_t p1
, uint8_t p2
, uint8_t p3
)
396 uint8_t* buf
= (uint8_t*)urb
->transfer_buffer
+ urb
->transfer_buffer_length
;
400 buf
[3] = (p0
& 0xf0) | snd_usbmidi_cin_length
[p0
& 0x0f];
401 urb
->transfer_buffer_length
+= 4;
405 * Converts MIDI commands to USB MIDI packets.
407 static void snd_usbmidi_transmit_byte(usbmidi_out_port_t
* port
,
408 uint8_t b
, struct urb
* urb
)
410 uint8_t p0
= port
->cable
;
411 void (*output_packet
)(struct urb
*, uint8_t, uint8_t, uint8_t, uint8_t) =
412 port
->ep
->umidi
->usb_protocol_ops
->output_packet
;
415 output_packet(urb
, p0
| 0x0f, b
, 0, 0);
416 } else if (b
>= 0xf0) {
420 port
->state
= STATE_SYSEX_1
;
425 port
->state
= STATE_1PARAM
;
429 port
->state
= STATE_2PARAM_1
;
433 port
->state
= STATE_UNKNOWN
;
436 output_packet(urb
, p0
| 0x05, 0xf6, 0, 0);
437 port
->state
= STATE_UNKNOWN
;
440 switch (port
->state
) {
442 output_packet(urb
, p0
| 0x05, 0xf7, 0, 0);
445 output_packet(urb
, p0
| 0x06, port
->data
[0], 0xf7, 0);
448 output_packet(urb
, p0
| 0x07, port
->data
[0], port
->data
[1], 0xf7);
451 port
->state
= STATE_UNKNOWN
;
454 } else if (b
>= 0x80) {
456 if (b
>= 0xc0 && b
<= 0xdf)
457 port
->state
= STATE_1PARAM
;
459 port
->state
= STATE_2PARAM_1
;
460 } else { /* b < 0x80 */
461 switch (port
->state
) {
463 if (port
->data
[0] < 0xf0) {
464 p0
|= port
->data
[0] >> 4;
467 port
->state
= STATE_UNKNOWN
;
469 output_packet(urb
, p0
, port
->data
[0], b
, 0);
473 port
->state
= STATE_2PARAM_2
;
476 if (port
->data
[0] < 0xf0) {
477 p0
|= port
->data
[0] >> 4;
478 port
->state
= STATE_2PARAM_1
;
481 port
->state
= STATE_UNKNOWN
;
483 output_packet(urb
, p0
, port
->data
[0], port
->data
[1], b
);
487 port
->state
= STATE_SYSEX_1
;
491 port
->state
= STATE_SYSEX_2
;
494 output_packet(urb
, p0
| 0x04, port
->data
[0], port
->data
[1], b
);
495 port
->state
= STATE_SYSEX_0
;
501 static void snd_usbmidi_standard_output(snd_usb_midi_out_endpoint_t
* ep
)
503 struct urb
* urb
= ep
->urb
;
506 /* FIXME: lower-numbered ports can starve higher-numbered ports */
507 for (p
= 0; p
< 0x10; ++p
) {
508 usbmidi_out_port_t
* port
= &ep
->ports
[p
];
511 while (urb
->transfer_buffer_length
+ 3 < ep
->max_transfer
) {
513 if (snd_rawmidi_transmit(port
->substream
, &b
, 1) != 1) {
517 snd_usbmidi_transmit_byte(port
, b
, urb
);
522 static struct usb_protocol_ops snd_usbmidi_standard_ops
= {
523 .input
= snd_usbmidi_standard_input
,
524 .output
= snd_usbmidi_standard_output
,
525 .output_packet
= snd_usbmidi_output_standard_packet
,
528 static struct usb_protocol_ops snd_usbmidi_midiman_ops
= {
529 .input
= snd_usbmidi_midiman_input
,
530 .output
= snd_usbmidi_standard_output
,
531 .output_packet
= snd_usbmidi_output_midiman_packet
,
535 * Novation USB MIDI protocol: number of data bytes is in the first byte
536 * (when receiving) (+1!) or in the second byte (when sending); data begins
540 static void snd_usbmidi_novation_input(snd_usb_midi_in_endpoint_t
* ep
,
541 uint8_t* buffer
, int buffer_length
)
543 if (buffer_length
< 2 || !buffer
[0] || buffer_length
< buffer
[0] + 1)
545 snd_usbmidi_input_data(ep
, 0, &buffer
[2], buffer
[0] - 1);
548 static void snd_usbmidi_novation_output(snd_usb_midi_out_endpoint_t
* ep
)
550 uint8_t* transfer_buffer
;
553 if (!ep
->ports
[0].active
)
555 transfer_buffer
= ep
->urb
->transfer_buffer
;
556 count
= snd_rawmidi_transmit(ep
->ports
[0].substream
,
558 ep
->max_transfer
- 2);
560 ep
->ports
[0].active
= 0;
563 transfer_buffer
[0] = 0;
564 transfer_buffer
[1] = count
;
565 ep
->urb
->transfer_buffer_length
= 2 + count
;
568 static struct usb_protocol_ops snd_usbmidi_novation_ops
= {
569 .input
= snd_usbmidi_novation_input
,
570 .output
= snd_usbmidi_novation_output
,
574 * "raw" protocol: used by the MOTU FastLane.
577 static void snd_usbmidi_raw_input(snd_usb_midi_in_endpoint_t
* ep
,
578 uint8_t* buffer
, int buffer_length
)
580 snd_usbmidi_input_data(ep
, 0, buffer
, buffer_length
);
583 static void snd_usbmidi_raw_output(snd_usb_midi_out_endpoint_t
* ep
)
587 if (!ep
->ports
[0].active
)
589 count
= snd_rawmidi_transmit(ep
->ports
[0].substream
,
590 ep
->urb
->transfer_buffer
,
593 ep
->ports
[0].active
= 0;
596 ep
->urb
->transfer_buffer_length
= count
;
599 static struct usb_protocol_ops snd_usbmidi_raw_ops
= {
600 .input
= snd_usbmidi_raw_input
,
601 .output
= snd_usbmidi_raw_output
,
605 * Emagic USB MIDI protocol: raw MIDI with "F5 xx" port switching.
608 static void snd_usbmidi_emagic_init_out(snd_usb_midi_out_endpoint_t
* ep
)
610 static const u8 init_data
[] = {
611 /* initialization magic: "get version" */
613 0x00, 0x20, 0x31, /* Emagic */
615 0x0b, /* version number request */
616 0x00, /* command version */
617 0x00, /* EEPROM, box 0 */
620 send_bulk_static_data(ep
, init_data
, sizeof(init_data
));
621 /* while we're at it, pour on more magic */
622 send_bulk_static_data(ep
, init_data
, sizeof(init_data
));
625 static void snd_usbmidi_emagic_finish_out(snd_usb_midi_out_endpoint_t
* ep
)
627 static const u8 finish_data
[] = {
628 /* switch to patch mode with last preset */
630 0x00, 0x20, 0x31, /* Emagic */
632 0x10, /* patch switch command */
633 0x00, /* command version */
634 0x7f, /* to all boxes */
635 0x40, /* last preset in EEPROM */
638 send_bulk_static_data(ep
, finish_data
, sizeof(finish_data
));
641 static void snd_usbmidi_emagic_input(snd_usb_midi_in_endpoint_t
* ep
,
642 uint8_t* buffer
, int buffer_length
)
646 /* FF indicates end of valid data */
647 for (i
= 0; i
< buffer_length
; ++i
)
648 if (buffer
[i
] == 0xff) {
653 /* handle F5 at end of last buffer */
657 while (buffer_length
> 0) {
658 /* determine size of data until next F5 */
659 for (i
= 0; i
< buffer_length
; ++i
)
660 if (buffer
[i
] == 0xf5)
662 snd_usbmidi_input_data(ep
, ep
->current_port
, buffer
, i
);
666 if (buffer_length
<= 0)
668 /* assert(buffer[0] == 0xf5); */
674 if (buffer_length
<= 0)
676 if (buffer
[0] < 0x80) {
677 ep
->current_port
= (buffer
[0] - 1) & 15;
685 static void snd_usbmidi_emagic_output(snd_usb_midi_out_endpoint_t
* ep
)
687 int port0
= ep
->current_port
;
688 uint8_t* buf
= ep
->urb
->transfer_buffer
;
689 int buf_free
= ep
->max_transfer
;
692 for (i
= 0; i
< 0x10; ++i
) {
693 /* round-robin, starting at the last current port */
694 int portnum
= (port0
+ i
) & 15;
695 usbmidi_out_port_t
* port
= &ep
->ports
[portnum
];
699 if (snd_rawmidi_transmit_peek(port
->substream
, buf
, 1) != 1) {
704 if (portnum
!= ep
->current_port
) {
707 ep
->current_port
= portnum
;
709 buf
[1] = (portnum
+ 1) & 15;
716 length
= snd_rawmidi_transmit(port
->substream
, buf
, buf_free
);
724 if (buf_free
< ep
->max_transfer
&& buf_free
> 0) {
728 ep
->urb
->transfer_buffer_length
= ep
->max_transfer
- buf_free
;
731 static struct usb_protocol_ops snd_usbmidi_emagic_ops
= {
732 .input
= snd_usbmidi_emagic_input
,
733 .output
= snd_usbmidi_emagic_output
,
734 .init_out_endpoint
= snd_usbmidi_emagic_init_out
,
735 .finish_out_endpoint
= snd_usbmidi_emagic_finish_out
,
739 static int snd_usbmidi_output_open(snd_rawmidi_substream_t
* substream
)
741 snd_usb_midi_t
* umidi
= substream
->rmidi
->private_data
;
742 usbmidi_out_port_t
* port
= NULL
;
745 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
)
746 if (umidi
->endpoints
[i
].out
)
747 for (j
= 0; j
< 0x10; ++j
)
748 if (umidi
->endpoints
[i
].out
->ports
[j
].substream
== substream
) {
749 port
= &umidi
->endpoints
[i
].out
->ports
[j
];
756 substream
->runtime
->private_data
= port
;
757 port
->state
= STATE_UNKNOWN
;
761 static int snd_usbmidi_output_close(snd_rawmidi_substream_t
* substream
)
766 static void snd_usbmidi_output_trigger(snd_rawmidi_substream_t
* substream
, int up
)
768 usbmidi_out_port_t
* port
= (usbmidi_out_port_t
*)substream
->runtime
->private_data
;
772 if (port
->ep
->umidi
->chip
->shutdown
) {
773 /* gobble up remaining bytes to prevent wait in
774 * snd_rawmidi_drain_output */
775 while (!snd_rawmidi_transmit_empty(substream
))
776 snd_rawmidi_transmit_ack(substream
, 1);
779 tasklet_hi_schedule(&port
->ep
->tasklet
);
783 static int snd_usbmidi_input_open(snd_rawmidi_substream_t
* substream
)
788 static int snd_usbmidi_input_close(snd_rawmidi_substream_t
* substream
)
793 static void snd_usbmidi_input_trigger(snd_rawmidi_substream_t
* substream
, int up
)
795 snd_usb_midi_t
* umidi
= substream
->rmidi
->private_data
;
798 set_bit(substream
->number
, &umidi
->input_triggered
);
800 clear_bit(substream
->number
, &umidi
->input_triggered
);
803 static snd_rawmidi_ops_t snd_usbmidi_output_ops
= {
804 .open
= snd_usbmidi_output_open
,
805 .close
= snd_usbmidi_output_close
,
806 .trigger
= snd_usbmidi_output_trigger
,
809 static snd_rawmidi_ops_t snd_usbmidi_input_ops
= {
810 .open
= snd_usbmidi_input_open
,
811 .close
= snd_usbmidi_input_close
,
812 .trigger
= snd_usbmidi_input_trigger
816 * Frees an input endpoint.
817 * May be called when ep hasn't been initialized completely.
819 static void snd_usbmidi_in_endpoint_delete(snd_usb_midi_in_endpoint_t
* ep
)
822 usb_buffer_free(ep
->umidi
->chip
->dev
,
823 ep
->urb
->transfer_buffer_length
,
824 ep
->urb
->transfer_buffer
,
825 ep
->urb
->transfer_dma
);
826 usb_free_urb(ep
->urb
);
832 * Creates an input endpoint.
834 static int snd_usbmidi_in_endpoint_create(snd_usb_midi_t
* umidi
,
835 snd_usb_midi_endpoint_info_t
* ep_info
,
836 snd_usb_midi_endpoint_t
* rep
)
838 snd_usb_midi_in_endpoint_t
* ep
;
844 ep
= kzalloc(sizeof(*ep
), GFP_KERNEL
);
849 ep
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
851 snd_usbmidi_in_endpoint_delete(ep
);
854 if (ep_info
->in_interval
)
855 pipe
= usb_rcvintpipe(umidi
->chip
->dev
, ep_info
->in_ep
);
857 pipe
= usb_rcvbulkpipe(umidi
->chip
->dev
, ep_info
->in_ep
);
858 length
= usb_maxpacket(umidi
->chip
->dev
, pipe
, 0);
859 buffer
= usb_buffer_alloc(umidi
->chip
->dev
, length
, GFP_KERNEL
,
860 &ep
->urb
->transfer_dma
);
862 snd_usbmidi_in_endpoint_delete(ep
);
865 if (ep_info
->in_interval
)
866 usb_fill_int_urb(ep
->urb
, umidi
->chip
->dev
, pipe
, buffer
, length
,
867 snd_usb_complete_callback(snd_usbmidi_in_urb_complete
),
868 ep
, ep_info
->in_interval
);
870 usb_fill_bulk_urb(ep
->urb
, umidi
->chip
->dev
, pipe
, buffer
, length
,
871 snd_usb_complete_callback(snd_usbmidi_in_urb_complete
),
873 ep
->urb
->transfer_flags
= URB_NO_TRANSFER_DMA_MAP
;
879 static unsigned int snd_usbmidi_count_bits(unsigned int x
)
881 unsigned int bits
= 0;
889 * Frees an output endpoint.
890 * May be called when ep hasn't been initialized completely.
892 static void snd_usbmidi_out_endpoint_delete(snd_usb_midi_out_endpoint_t
* ep
)
895 usb_buffer_free(ep
->umidi
->chip
->dev
, ep
->max_transfer
,
896 ep
->urb
->transfer_buffer
,
897 ep
->urb
->transfer_dma
);
898 usb_free_urb(ep
->urb
);
904 * Creates an output endpoint, and initializes output ports.
906 static int snd_usbmidi_out_endpoint_create(snd_usb_midi_t
* umidi
,
907 snd_usb_midi_endpoint_info_t
* ep_info
,
908 snd_usb_midi_endpoint_t
* rep
)
910 snd_usb_midi_out_endpoint_t
* ep
;
916 ep
= kzalloc(sizeof(*ep
), GFP_KERNEL
);
921 ep
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
923 snd_usbmidi_out_endpoint_delete(ep
);
926 /* we never use interrupt output pipes */
927 pipe
= usb_sndbulkpipe(umidi
->chip
->dev
, ep_info
->out_ep
);
928 ep
->max_transfer
= usb_maxpacket(umidi
->chip
->dev
, pipe
, 1);
929 buffer
= usb_buffer_alloc(umidi
->chip
->dev
, ep
->max_transfer
,
930 GFP_KERNEL
, &ep
->urb
->transfer_dma
);
932 snd_usbmidi_out_endpoint_delete(ep
);
935 usb_fill_bulk_urb(ep
->urb
, umidi
->chip
->dev
, pipe
, buffer
,
937 snd_usb_complete_callback(snd_usbmidi_out_urb_complete
), ep
);
938 ep
->urb
->transfer_flags
= URB_NO_TRANSFER_DMA_MAP
;
940 spin_lock_init(&ep
->buffer_lock
);
941 tasklet_init(&ep
->tasklet
, snd_usbmidi_out_tasklet
, (unsigned long)ep
);
943 for (i
= 0; i
< 0x10; ++i
)
944 if (ep_info
->out_cables
& (1 << i
)) {
945 ep
->ports
[i
].ep
= ep
;
946 ep
->ports
[i
].cable
= i
<< 4;
949 if (umidi
->usb_protocol_ops
->init_out_endpoint
)
950 umidi
->usb_protocol_ops
->init_out_endpoint(ep
);
959 static void snd_usbmidi_free(snd_usb_midi_t
* umidi
)
963 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
964 snd_usb_midi_endpoint_t
* ep
= &umidi
->endpoints
[i
];
966 snd_usbmidi_out_endpoint_delete(ep
->out
);
968 snd_usbmidi_in_endpoint_delete(ep
->in
);
974 * Unlinks all URBs (must be done before the usb_device is deleted).
976 void snd_usbmidi_disconnect(struct list_head
* p
)
978 snd_usb_midi_t
* umidi
;
981 umidi
= list_entry(p
, snd_usb_midi_t
, list
);
982 del_timer_sync(&umidi
->error_timer
);
983 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
984 snd_usb_midi_endpoint_t
* ep
= &umidi
->endpoints
[i
];
986 tasklet_kill(&ep
->out
->tasklet
);
987 if (ep
->out
&& ep
->out
->urb
) {
988 usb_kill_urb(ep
->out
->urb
);
989 if (umidi
->usb_protocol_ops
->finish_out_endpoint
)
990 umidi
->usb_protocol_ops
->finish_out_endpoint(ep
->out
);
992 if (ep
->in
&& ep
->in
->urb
)
993 usb_kill_urb(ep
->in
->urb
);
997 static void snd_usbmidi_rawmidi_free(snd_rawmidi_t
* rmidi
)
999 snd_usb_midi_t
* umidi
= rmidi
->private_data
;
1000 snd_usbmidi_free(umidi
);
1003 static snd_rawmidi_substream_t
* snd_usbmidi_find_substream(snd_usb_midi_t
* umidi
,
1004 int stream
, int number
)
1006 struct list_head
* list
;
1008 list_for_each(list
, &umidi
->rmidi
->streams
[stream
].substreams
) {
1009 snd_rawmidi_substream_t
* substream
= list_entry(list
, snd_rawmidi_substream_t
, list
);
1010 if (substream
->number
== number
)
1017 * This list specifies names for ports that do not fit into the standard
1018 * "(product) MIDI (n)" schema because they aren't external MIDI ports,
1019 * such as internal control or synthesizer ports.
1024 const char *name_format
;
1025 } snd_usbmidi_port_names
[] = {
1027 { USB_ID(0x0582, 0x0000), 2, "%s Control" },
1028 /* Roland SC-8850 */
1029 { USB_ID(0x0582, 0x0003), 0, "%s Part A" },
1030 { USB_ID(0x0582, 0x0003), 1, "%s Part B" },
1031 { USB_ID(0x0582, 0x0003), 2, "%s Part C" },
1032 { USB_ID(0x0582, 0x0003), 3, "%s Part D" },
1033 { USB_ID(0x0582, 0x0003), 4, "%s MIDI 1" },
1034 { USB_ID(0x0582, 0x0003), 5, "%s MIDI 2" },
1036 { USB_ID(0x0582, 0x0004), 0, "%s MIDI" },
1037 { USB_ID(0x0582, 0x0004), 1, "%s Control" },
1038 /* Roland SC-8820 */
1039 { USB_ID(0x0582, 0x0007), 0, "%s Part A" },
1040 { USB_ID(0x0582, 0x0007), 1, "%s Part B" },
1041 { USB_ID(0x0582, 0x0007), 2, "%s MIDI" },
1043 { USB_ID(0x0582, 0x000b), 0, "%s Part A" },
1044 { USB_ID(0x0582, 0x000b), 1, "%s Part B" },
1045 { USB_ID(0x0582, 0x000b), 2, "%s MIDI" },
1047 { USB_ID(0x0582, 0x000c), 0, "%s Part A" },
1048 { USB_ID(0x0582, 0x000c), 1, "%s Part B" },
1049 { USB_ID(0x0582, 0x000c), 2, "%s MIDI" },
1051 { USB_ID(0x0582, 0x0014), 8, "%s Control" },
1053 { USB_ID(0x0582, 0x0016), 0, "%s Part A" },
1054 { USB_ID(0x0582, 0x0016), 1, "%s Part B" },
1055 { USB_ID(0x0582, 0x0016), 2, "%s MIDI 1" },
1056 { USB_ID(0x0582, 0x0016), 3, "%s MIDI 2" },
1058 { USB_ID(0x0582, 0x0023), 5, "%s Control" },
1060 { USB_ID(0x0582, 0x0027), 0, "%s Part A" },
1061 { USB_ID(0x0582, 0x0027), 1, "%s Part B" },
1062 { USB_ID(0x0582, 0x0027), 2, "%s MIDI" },
1064 { USB_ID(0x0582, 0x0029), 0, "%s Part A" },
1065 { USB_ID(0x0582, 0x0029), 1, "%s Part B" },
1066 { USB_ID(0x0582, 0x0029), 2, "%s MIDI 1" },
1067 { USB_ID(0x0582, 0x0029), 3, "%s MIDI 2" },
1069 { USB_ID(0x0582, 0x002b), 0, "%s MIDI" },
1070 { USB_ID(0x0582, 0x002b), 1, "%s Control" },
1072 { USB_ID(0x0582, 0x002f), 0, "%s MIDI" },
1073 { USB_ID(0x0582, 0x002f), 1, "%s External MIDI" },
1074 { USB_ID(0x0582, 0x002f), 2, "%s Sync" },
1076 { USB_ID(0x0582, 0x0033), 0, "%s MIDI" },
1077 { USB_ID(0x0582, 0x0033), 1, "%s 1" },
1078 { USB_ID(0x0582, 0x0033), 2, "%s 2" },
1080 { USB_ID(0x0582, 0x003b), 0, "%s MIDI" },
1081 { USB_ID(0x0582, 0x003b), 1, "%s Control" },
1082 /* Edirol UA-1000 */
1083 { USB_ID(0x0582, 0x0044), 0, "%s MIDI" },
1084 { USB_ID(0x0582, 0x0044), 1, "%s Control" },
1086 { USB_ID(0x0582, 0x0048), 0, "%s MIDI" },
1087 { USB_ID(0x0582, 0x0048), 1, "%s 1" },
1088 { USB_ID(0x0582, 0x0048), 2, "%s 2" },
1090 { USB_ID(0x0582, 0x004d), 0, "%s MIDI" },
1091 { USB_ID(0x0582, 0x004d), 1, "%s 1" },
1092 { USB_ID(0x0582, 0x004d), 2, "%s 2" },
1093 /* M-Audio MidiSport 8x8 */
1094 { USB_ID(0x0763, 0x1031), 8, "%s Control" },
1095 { USB_ID(0x0763, 0x1033), 8, "%s Control" },
1097 { USB_ID(0x07fd, 0x0001), 0, "%s MIDI A" },
1098 { USB_ID(0x07fd, 0x0001), 1, "%s MIDI B" },
1099 /* Emagic Unitor8/AMT8/MT4 */
1100 { USB_ID(0x086a, 0x0001), 8, "%s Broadcast" },
1101 { USB_ID(0x086a, 0x0002), 8, "%s Broadcast" },
1102 { USB_ID(0x086a, 0x0003), 4, "%s Broadcast" },
1105 static void snd_usbmidi_init_substream(snd_usb_midi_t
* umidi
,
1106 int stream
, int number
,
1107 snd_rawmidi_substream_t
** rsubstream
)
1110 const char *name_format
;
1112 snd_rawmidi_substream_t
* substream
= snd_usbmidi_find_substream(umidi
, stream
, number
);
1114 snd_printd(KERN_ERR
"substream %d:%d not found\n", stream
, number
);
1118 /* TODO: read port name from jack descriptor */
1119 name_format
= "%s MIDI %d";
1120 for (i
= 0; i
< ARRAY_SIZE(snd_usbmidi_port_names
); ++i
) {
1121 if (snd_usbmidi_port_names
[i
].id
== umidi
->chip
->usb_id
&&
1122 snd_usbmidi_port_names
[i
].port
== number
) {
1123 name_format
= snd_usbmidi_port_names
[i
].name_format
;
1127 snprintf(substream
->name
, sizeof(substream
->name
),
1128 name_format
, umidi
->chip
->card
->shortname
, number
+ 1);
1130 *rsubstream
= substream
;
1134 * Creates the endpoints and their ports.
1136 static int snd_usbmidi_create_endpoints(snd_usb_midi_t
* umidi
,
1137 snd_usb_midi_endpoint_info_t
* endpoints
)
1140 int out_ports
= 0, in_ports
= 0;
1142 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1143 if (endpoints
[i
].out_cables
) {
1144 err
= snd_usbmidi_out_endpoint_create(umidi
, &endpoints
[i
],
1145 &umidi
->endpoints
[i
]);
1149 if (endpoints
[i
].in_cables
) {
1150 err
= snd_usbmidi_in_endpoint_create(umidi
, &endpoints
[i
],
1151 &umidi
->endpoints
[i
]);
1156 for (j
= 0; j
< 0x10; ++j
) {
1157 if (endpoints
[i
].out_cables
& (1 << j
)) {
1158 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, out_ports
,
1159 &umidi
->endpoints
[i
].out
->ports
[j
].substream
);
1162 if (endpoints
[i
].in_cables
& (1 << j
)) {
1163 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_INPUT
, in_ports
,
1164 &umidi
->endpoints
[i
].in
->ports
[j
].substream
);
1169 snd_printdd(KERN_INFO
"created %d output and %d input ports\n",
1170 out_ports
, in_ports
);
1175 * Returns MIDIStreaming device capabilities.
1177 static int snd_usbmidi_get_ms_info(snd_usb_midi_t
* umidi
,
1178 snd_usb_midi_endpoint_info_t
* endpoints
)
1180 struct usb_interface
* intf
;
1181 struct usb_host_interface
*hostif
;
1182 struct usb_interface_descriptor
* intfd
;
1183 struct usb_ms_header_descriptor
* ms_header
;
1184 struct usb_host_endpoint
*hostep
;
1185 struct usb_endpoint_descriptor
* ep
;
1186 struct usb_ms_endpoint_descriptor
* ms_ep
;
1189 intf
= umidi
->iface
;
1192 hostif
= &intf
->altsetting
[0];
1193 intfd
= get_iface_desc(hostif
);
1194 ms_header
= (struct usb_ms_header_descriptor
*)hostif
->extra
;
1195 if (hostif
->extralen
>= 7 &&
1196 ms_header
->bLength
>= 7 &&
1197 ms_header
->bDescriptorType
== USB_DT_CS_INTERFACE
&&
1198 ms_header
->bDescriptorSubtype
== HEADER
)
1199 snd_printdd(KERN_INFO
"MIDIStreaming version %02x.%02x\n",
1200 ms_header
->bcdMSC
[1], ms_header
->bcdMSC
[0]);
1202 snd_printk(KERN_WARNING
"MIDIStreaming interface descriptor not found\n");
1205 for (i
= 0; i
< intfd
->bNumEndpoints
; ++i
) {
1206 hostep
= &hostif
->endpoint
[i
];
1207 ep
= get_ep_desc(hostep
);
1208 if ((ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
&&
1209 (ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_INT
)
1211 ms_ep
= (struct usb_ms_endpoint_descriptor
*)hostep
->extra
;
1212 if (hostep
->extralen
< 4 ||
1213 ms_ep
->bLength
< 4 ||
1214 ms_ep
->bDescriptorType
!= USB_DT_CS_ENDPOINT
||
1215 ms_ep
->bDescriptorSubtype
!= MS_GENERAL
)
1217 if ((ep
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_OUT
) {
1218 if (endpoints
[epidx
].out_ep
) {
1219 if (++epidx
>= MIDI_MAX_ENDPOINTS
) {
1220 snd_printk(KERN_WARNING
"too many endpoints\n");
1224 endpoints
[epidx
].out_ep
= ep
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1225 if ((ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) == USB_ENDPOINT_XFER_INT
)
1226 endpoints
[epidx
].out_interval
= ep
->bInterval
;
1227 endpoints
[epidx
].out_cables
= (1 << ms_ep
->bNumEmbMIDIJack
) - 1;
1228 snd_printdd(KERN_INFO
"EP %02X: %d jack(s)\n",
1229 ep
->bEndpointAddress
, ms_ep
->bNumEmbMIDIJack
);
1231 if (endpoints
[epidx
].in_ep
) {
1232 if (++epidx
>= MIDI_MAX_ENDPOINTS
) {
1233 snd_printk(KERN_WARNING
"too many endpoints\n");
1237 endpoints
[epidx
].in_ep
= ep
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1238 if ((ep
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) == USB_ENDPOINT_XFER_INT
)
1239 endpoints
[epidx
].in_interval
= ep
->bInterval
;
1240 endpoints
[epidx
].in_cables
= (1 << ms_ep
->bNumEmbMIDIJack
) - 1;
1241 snd_printdd(KERN_INFO
"EP %02X: %d jack(s)\n",
1242 ep
->bEndpointAddress
, ms_ep
->bNumEmbMIDIJack
);
1249 * On Roland devices, use the second alternate setting to be able to use
1250 * the interrupt input endpoint.
1252 static void snd_usbmidi_switch_roland_altsetting(snd_usb_midi_t
* umidi
)
1254 struct usb_interface
* intf
;
1255 struct usb_host_interface
*hostif
;
1256 struct usb_interface_descriptor
* intfd
;
1258 intf
= umidi
->iface
;
1259 if (!intf
|| intf
->num_altsetting
!= 2)
1262 hostif
= &intf
->altsetting
[1];
1263 intfd
= get_iface_desc(hostif
);
1264 if (intfd
->bNumEndpoints
!= 2 ||
1265 (get_endpoint(hostif
, 0)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
||
1266 (get_endpoint(hostif
, 1)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_INT
)
1269 snd_printdd(KERN_INFO
"switching to altsetting %d with int ep\n",
1270 intfd
->bAlternateSetting
);
1271 usb_set_interface(umidi
->chip
->dev
, intfd
->bInterfaceNumber
,
1272 intfd
->bAlternateSetting
);
1276 * Try to find any usable endpoints in the interface.
1278 static int snd_usbmidi_detect_endpoints(snd_usb_midi_t
* umidi
,
1279 snd_usb_midi_endpoint_info_t
* endpoint
,
1282 struct usb_interface
* intf
;
1283 struct usb_host_interface
*hostif
;
1284 struct usb_interface_descriptor
* intfd
;
1285 struct usb_endpoint_descriptor
* epd
;
1286 int i
, out_eps
= 0, in_eps
= 0;
1288 if (USB_ID_VENDOR(umidi
->chip
->usb_id
) == 0x0582)
1289 snd_usbmidi_switch_roland_altsetting(umidi
);
1291 if (endpoint
[0].out_ep
|| endpoint
[0].in_ep
)
1294 intf
= umidi
->iface
;
1295 if (!intf
|| intf
->num_altsetting
< 1)
1297 hostif
= intf
->cur_altsetting
;
1298 intfd
= get_iface_desc(hostif
);
1300 for (i
= 0; i
< intfd
->bNumEndpoints
; ++i
) {
1301 epd
= get_endpoint(hostif
, i
);
1302 if ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
&&
1303 (epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_INT
)
1305 if (out_eps
< max_endpoints
&&
1306 (epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_OUT
) {
1307 endpoint
[out_eps
].out_ep
= epd
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1308 if ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) == USB_ENDPOINT_XFER_INT
)
1309 endpoint
[out_eps
].out_interval
= epd
->bInterval
;
1312 if (in_eps
< max_endpoints
&&
1313 (epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_IN
) {
1314 endpoint
[in_eps
].in_ep
= epd
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1315 if ((epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) == USB_ENDPOINT_XFER_INT
)
1316 endpoint
[in_eps
].in_interval
= epd
->bInterval
;
1320 return (out_eps
|| in_eps
) ? 0 : -ENOENT
;
1324 * Detects the endpoints for one-port-per-endpoint protocols.
1326 static int snd_usbmidi_detect_per_port_endpoints(snd_usb_midi_t
* umidi
,
1327 snd_usb_midi_endpoint_info_t
* endpoints
)
1331 err
= snd_usbmidi_detect_endpoints(umidi
, endpoints
, MIDI_MAX_ENDPOINTS
);
1332 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1333 if (endpoints
[i
].out_ep
)
1334 endpoints
[i
].out_cables
= 0x0001;
1335 if (endpoints
[i
].in_ep
)
1336 endpoints
[i
].in_cables
= 0x0001;
1342 * Detects the endpoints and ports of Yamaha devices.
1344 static int snd_usbmidi_detect_yamaha(snd_usb_midi_t
* umidi
,
1345 snd_usb_midi_endpoint_info_t
* endpoint
)
1347 struct usb_interface
* intf
;
1348 struct usb_host_interface
*hostif
;
1349 struct usb_interface_descriptor
* intfd
;
1352 intf
= umidi
->iface
;
1355 hostif
= intf
->altsetting
;
1356 intfd
= get_iface_desc(hostif
);
1357 if (intfd
->bNumEndpoints
< 1)
1361 * For each port there is one MIDI_IN/OUT_JACK descriptor, not
1362 * necessarily with any useful contents. So simply count 'em.
1364 for (cs_desc
= hostif
->extra
;
1365 cs_desc
< hostif
->extra
+ hostif
->extralen
&& cs_desc
[0] >= 2;
1366 cs_desc
+= cs_desc
[0]) {
1367 if (cs_desc
[1] == CS_AUDIO_INTERFACE
) {
1368 if (cs_desc
[2] == MIDI_IN_JACK
)
1369 endpoint
->in_cables
= (endpoint
->in_cables
<< 1) | 1;
1370 else if (cs_desc
[2] == MIDI_OUT_JACK
)
1371 endpoint
->out_cables
= (endpoint
->out_cables
<< 1) | 1;
1374 if (!endpoint
->in_cables
&& !endpoint
->out_cables
)
1377 return snd_usbmidi_detect_endpoints(umidi
, endpoint
, 1);
1381 * Creates the endpoints and their ports for Midiman devices.
1383 static int snd_usbmidi_create_endpoints_midiman(snd_usb_midi_t
* umidi
,
1384 snd_usb_midi_endpoint_info_t
* endpoint
)
1386 snd_usb_midi_endpoint_info_t ep_info
;
1387 struct usb_interface
* intf
;
1388 struct usb_host_interface
*hostif
;
1389 struct usb_interface_descriptor
* intfd
;
1390 struct usb_endpoint_descriptor
* epd
;
1393 intf
= umidi
->iface
;
1396 hostif
= intf
->altsetting
;
1397 intfd
= get_iface_desc(hostif
);
1399 * The various MidiSport devices have more or less random endpoint
1400 * numbers, so we have to identify the endpoints by their index in
1401 * the descriptor array, like the driver for that other OS does.
1403 * There is one interrupt input endpoint for all input ports, one
1404 * bulk output endpoint for even-numbered ports, and one for odd-
1405 * numbered ports. Both bulk output endpoints have corresponding
1406 * input bulk endpoints (at indices 1 and 3) which aren't used.
1408 if (intfd
->bNumEndpoints
< (endpoint
->out_cables
> 0x0001 ? 5 : 3)) {
1409 snd_printdd(KERN_ERR
"not enough endpoints\n");
1413 epd
= get_endpoint(hostif
, 0);
1414 if ((epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) != USB_DIR_IN
||
1415 (epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_INT
) {
1416 snd_printdd(KERN_ERR
"endpoint[0] isn't interrupt\n");
1419 epd
= get_endpoint(hostif
, 2);
1420 if ((epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) != USB_DIR_OUT
||
1421 (epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
) {
1422 snd_printdd(KERN_ERR
"endpoint[2] isn't bulk output\n");
1425 if (endpoint
->out_cables
> 0x0001) {
1426 epd
= get_endpoint(hostif
, 4);
1427 if ((epd
->bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) != USB_DIR_OUT
||
1428 (epd
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
) {
1429 snd_printdd(KERN_ERR
"endpoint[4] isn't bulk output\n");
1434 ep_info
.out_ep
= get_endpoint(hostif
, 2)->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1435 ep_info
.out_cables
= endpoint
->out_cables
& 0x5555;
1436 err
= snd_usbmidi_out_endpoint_create(umidi
, &ep_info
, &umidi
->endpoints
[0]);
1440 ep_info
.in_ep
= get_endpoint(hostif
, 0)->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1441 ep_info
.in_interval
= get_endpoint(hostif
, 0)->bInterval
;
1442 ep_info
.in_cables
= endpoint
->in_cables
;
1443 err
= snd_usbmidi_in_endpoint_create(umidi
, &ep_info
, &umidi
->endpoints
[0]);
1447 if (endpoint
->out_cables
> 0x0001) {
1448 ep_info
.out_ep
= get_endpoint(hostif
, 4)->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1449 ep_info
.out_cables
= endpoint
->out_cables
& 0xaaaa;
1450 err
= snd_usbmidi_out_endpoint_create(umidi
, &ep_info
, &umidi
->endpoints
[1]);
1455 for (cable
= 0; cable
< 0x10; ++cable
) {
1456 if (endpoint
->out_cables
& (1 << cable
))
1457 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, cable
,
1458 &umidi
->endpoints
[cable
& 1].out
->ports
[cable
].substream
);
1459 if (endpoint
->in_cables
& (1 << cable
))
1460 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_INPUT
, cable
,
1461 &umidi
->endpoints
[0].in
->ports
[cable
].substream
);
1466 static int snd_usbmidi_create_rawmidi(snd_usb_midi_t
* umidi
,
1467 int out_ports
, int in_ports
)
1469 snd_rawmidi_t
* rmidi
;
1472 err
= snd_rawmidi_new(umidi
->chip
->card
, "USB MIDI",
1473 umidi
->chip
->next_midi_device
++,
1474 out_ports
, in_ports
, &rmidi
);
1477 strcpy(rmidi
->name
, umidi
->chip
->card
->shortname
);
1478 rmidi
->info_flags
= SNDRV_RAWMIDI_INFO_OUTPUT
|
1479 SNDRV_RAWMIDI_INFO_INPUT
|
1480 SNDRV_RAWMIDI_INFO_DUPLEX
;
1481 rmidi
->private_data
= umidi
;
1482 rmidi
->private_free
= snd_usbmidi_rawmidi_free
;
1483 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, &snd_usbmidi_output_ops
);
1484 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_INPUT
, &snd_usbmidi_input_ops
);
1486 umidi
->rmidi
= rmidi
;
1491 * Temporarily stop input.
1493 void snd_usbmidi_input_stop(struct list_head
* p
)
1495 snd_usb_midi_t
* umidi
;
1498 umidi
= list_entry(p
, snd_usb_midi_t
, list
);
1499 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1500 snd_usb_midi_endpoint_t
* ep
= &umidi
->endpoints
[i
];
1502 usb_kill_urb(ep
->in
->urb
);
1506 static void snd_usbmidi_input_start_ep(snd_usb_midi_in_endpoint_t
* ep
)
1509 struct urb
* urb
= ep
->urb
;
1510 urb
->dev
= ep
->umidi
->chip
->dev
;
1511 snd_usbmidi_submit_urb(urb
, GFP_KERNEL
);
1516 * Resume input after a call to snd_usbmidi_input_stop().
1518 void snd_usbmidi_input_start(struct list_head
* p
)
1520 snd_usb_midi_t
* umidi
;
1523 umidi
= list_entry(p
, snd_usb_midi_t
, list
);
1524 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
)
1525 snd_usbmidi_input_start_ep(umidi
->endpoints
[i
].in
);
1529 * Creates and registers everything needed for a MIDI streaming interface.
1531 int snd_usb_create_midi_interface(snd_usb_audio_t
* chip
,
1532 struct usb_interface
* iface
,
1533 const snd_usb_audio_quirk_t
* quirk
)
1535 snd_usb_midi_t
* umidi
;
1536 snd_usb_midi_endpoint_info_t endpoints
[MIDI_MAX_ENDPOINTS
];
1537 int out_ports
, in_ports
;
1540 umidi
= kzalloc(sizeof(*umidi
), GFP_KERNEL
);
1544 umidi
->iface
= iface
;
1545 umidi
->quirk
= quirk
;
1546 umidi
->usb_protocol_ops
= &snd_usbmidi_standard_ops
;
1547 init_timer(&umidi
->error_timer
);
1548 umidi
->error_timer
.function
= snd_usbmidi_error_timer
;
1549 umidi
->error_timer
.data
= (unsigned long)umidi
;
1551 /* detect the endpoint(s) to use */
1552 memset(endpoints
, 0, sizeof(endpoints
));
1553 switch (quirk
? quirk
->type
: QUIRK_MIDI_STANDARD_INTERFACE
) {
1554 case QUIRK_MIDI_STANDARD_INTERFACE
:
1555 err
= snd_usbmidi_get_ms_info(umidi
, endpoints
);
1557 case QUIRK_MIDI_FIXED_ENDPOINT
:
1558 memcpy(&endpoints
[0], quirk
->data
,
1559 sizeof(snd_usb_midi_endpoint_info_t
));
1560 err
= snd_usbmidi_detect_endpoints(umidi
, &endpoints
[0], 1);
1562 case QUIRK_MIDI_YAMAHA
:
1563 err
= snd_usbmidi_detect_yamaha(umidi
, &endpoints
[0]);
1565 case QUIRK_MIDI_MIDIMAN
:
1566 umidi
->usb_protocol_ops
= &snd_usbmidi_midiman_ops
;
1567 memcpy(&endpoints
[0], quirk
->data
,
1568 sizeof(snd_usb_midi_endpoint_info_t
));
1571 case QUIRK_MIDI_NOVATION
:
1572 umidi
->usb_protocol_ops
= &snd_usbmidi_novation_ops
;
1573 err
= snd_usbmidi_detect_per_port_endpoints(umidi
, endpoints
);
1575 case QUIRK_MIDI_RAW
:
1576 umidi
->usb_protocol_ops
= &snd_usbmidi_raw_ops
;
1577 err
= snd_usbmidi_detect_per_port_endpoints(umidi
, endpoints
);
1579 case QUIRK_MIDI_EMAGIC
:
1580 umidi
->usb_protocol_ops
= &snd_usbmidi_emagic_ops
;
1581 memcpy(&endpoints
[0], quirk
->data
,
1582 sizeof(snd_usb_midi_endpoint_info_t
));
1583 err
= snd_usbmidi_detect_endpoints(umidi
, &endpoints
[0], 1);
1585 case QUIRK_MIDI_MIDITECH
:
1586 err
= snd_usbmidi_detect_per_port_endpoints(umidi
, endpoints
);
1589 snd_printd(KERN_ERR
"invalid quirk type %d\n", quirk
->type
);
1598 /* create rawmidi device */
1601 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1602 out_ports
+= snd_usbmidi_count_bits(endpoints
[i
].out_cables
);
1603 in_ports
+= snd_usbmidi_count_bits(endpoints
[i
].in_cables
);
1605 err
= snd_usbmidi_create_rawmidi(umidi
, out_ports
, in_ports
);
1611 /* create endpoint/port structures */
1612 if (quirk
&& quirk
->type
== QUIRK_MIDI_MIDIMAN
)
1613 err
= snd_usbmidi_create_endpoints_midiman(umidi
, &endpoints
[0]);
1615 err
= snd_usbmidi_create_endpoints(umidi
, endpoints
);
1617 snd_usbmidi_free(umidi
);
1621 list_add(&umidi
->list
, &umidi
->chip
->midi_list
);
1623 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
)
1624 snd_usbmidi_input_start_ep(umidi
->endpoints
[i
].in
);
1628 EXPORT_SYMBOL(snd_usb_create_midi_interface
);
1629 EXPORT_SYMBOL(snd_usbmidi_input_stop
);
1630 EXPORT_SYMBOL(snd_usbmidi_input_start
);
1631 EXPORT_SYMBOL(snd_usbmidi_disconnect
);