2 * usbmidi.c - ALSA USB MIDI driver
4 * Copyright (c) 2002-2009 Clemens Ladisch
7 * Based on the OSS usb-midi driver by NAGANO Daisuke,
8 * NetBSD's umidi driver by Takuya SHIOZAKI,
9 * the "USB Device Class Definition for MIDI Devices" by Roland
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. The name of the author may not be used to endorse or promote products
18 * derived from this software without specific prior written permission.
20 * Alternatively, this software may be distributed and/or modified under the
21 * terms of the GNU General Public License as published by the Free Software
22 * Foundation; either version 2 of the License, or (at your option) any later
25 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
29 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 #include <linux/kernel.h>
39 #include <linux/types.h>
40 #include <linux/bitops.h>
41 #include <linux/interrupt.h>
42 #include <linux/spinlock.h>
43 #include <linux/string.h>
44 #include <linux/init.h>
45 #include <linux/slab.h>
46 #include <linux/timer.h>
47 #include <linux/usb.h>
48 #include <linux/wait.h>
49 #include <linux/usb/audio.h>
51 #include <sound/core.h>
52 #include <sound/control.h>
53 #include <sound/rawmidi.h>
54 #include <sound/asequencer.h>
61 * define this to log all USB packets
63 /* #define DUMP_PACKETS */
66 * how long to wait after some USB errors, so that khubd can disconnect() us
67 * without too many spurious errors
69 #define ERROR_DELAY_JIFFIES (HZ / 10)
75 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
76 MODULE_DESCRIPTION("USB Audio/MIDI helper module");
77 MODULE_LICENSE("Dual BSD/GPL");
80 struct usb_ms_header_descriptor
{
83 __u8 bDescriptorSubtype
;
86 } __attribute__ ((packed
));
88 struct usb_ms_endpoint_descriptor
{
91 __u8 bDescriptorSubtype
;
93 __u8 baAssocJackID
[0];
94 } __attribute__ ((packed
));
96 struct snd_usb_midi_in_endpoint
;
97 struct snd_usb_midi_out_endpoint
;
98 struct snd_usb_midi_endpoint
;
100 struct usb_protocol_ops
{
101 void (*input
)(struct snd_usb_midi_in_endpoint
*, uint8_t*, int);
102 void (*output
)(struct snd_usb_midi_out_endpoint
*ep
, struct urb
*urb
);
103 void (*output_packet
)(struct urb
*, uint8_t, uint8_t, uint8_t, uint8_t);
104 void (*init_out_endpoint
)(struct snd_usb_midi_out_endpoint
*);
105 void (*finish_out_endpoint
)(struct snd_usb_midi_out_endpoint
*);
108 struct snd_usb_midi
{
109 struct usb_device
*dev
;
110 struct snd_card
*card
;
111 struct usb_interface
*iface
;
112 const struct snd_usb_audio_quirk
*quirk
;
113 struct snd_rawmidi
*rmidi
;
114 struct usb_protocol_ops
* usb_protocol_ops
;
115 struct list_head list
;
116 struct timer_list error_timer
;
117 spinlock_t disc_lock
;
120 int next_midi_device
;
122 struct snd_usb_midi_endpoint
{
123 struct snd_usb_midi_out_endpoint
*out
;
124 struct snd_usb_midi_in_endpoint
*in
;
125 } endpoints
[MIDI_MAX_ENDPOINTS
];
126 unsigned long input_triggered
;
128 unsigned char disconnected
;
130 struct snd_kcontrol
*roland_load_ctl
;
133 struct snd_usb_midi_out_endpoint
{
134 struct snd_usb_midi
* umidi
;
135 struct out_urb_context
{
137 struct snd_usb_midi_out_endpoint
*ep
;
139 unsigned int active_urbs
;
140 unsigned int drain_urbs
;
141 int max_transfer
; /* size of urb buffer */
142 struct tasklet_struct tasklet
;
143 unsigned int next_urb
;
144 spinlock_t buffer_lock
;
146 struct usbmidi_out_port
{
147 struct snd_usb_midi_out_endpoint
* ep
;
148 struct snd_rawmidi_substream
*substream
;
150 uint8_t cable
; /* cable number << 4 */
152 #define STATE_UNKNOWN 0
153 #define STATE_1PARAM 1
154 #define STATE_2PARAM_1 2
155 #define STATE_2PARAM_2 3
156 #define STATE_SYSEX_0 4
157 #define STATE_SYSEX_1 5
158 #define STATE_SYSEX_2 6
163 wait_queue_head_t drain_wait
;
166 struct snd_usb_midi_in_endpoint
{
167 struct snd_usb_midi
* umidi
;
168 struct urb
* urbs
[INPUT_URBS
];
169 struct usbmidi_in_port
{
170 struct snd_rawmidi_substream
*substream
;
171 u8 running_status_length
;
178 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint
* ep
);
180 static const uint8_t snd_usbmidi_cin_length
[] = {
181 0, 0, 2, 3, 3, 1, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1
185 * Submits the URB, with error handling.
187 static int snd_usbmidi_submit_urb(struct urb
* urb
, gfp_t flags
)
189 int err
= usb_submit_urb(urb
, flags
);
190 if (err
< 0 && err
!= -ENODEV
)
191 snd_printk(KERN_ERR
"usb_submit_urb: %d\n", err
);
196 * Error handling for URB completion functions.
198 static int snd_usbmidi_urb_error(int status
)
201 /* manually unlinked, or device gone */
207 /* errors that might occur during unplugging */
213 snd_printk(KERN_ERR
"urb status %d\n", status
);
214 return 0; /* continue */
219 * Receives a chunk of MIDI data.
221 static void snd_usbmidi_input_data(struct snd_usb_midi_in_endpoint
* ep
, int portidx
,
222 uint8_t* data
, int length
)
224 struct usbmidi_in_port
* port
= &ep
->ports
[portidx
];
226 if (!port
->substream
) {
227 snd_printd("unexpected port %d!\n", portidx
);
230 if (!test_bit(port
->substream
->number
, &ep
->umidi
->input_triggered
))
232 snd_rawmidi_receive(port
->substream
, data
, length
);
236 static void dump_urb(const char *type
, const u8
*data
, int length
)
238 snd_printk(KERN_DEBUG
"%s packet: [", type
);
239 for (; length
> 0; ++data
, --length
)
240 printk(" %02x", *data
);
244 #define dump_urb(type, data, length) /* nothing */
248 * Processes the data read from the device.
250 static void snd_usbmidi_in_urb_complete(struct urb
* urb
)
252 struct snd_usb_midi_in_endpoint
* ep
= urb
->context
;
254 if (urb
->status
== 0) {
255 dump_urb("received", urb
->transfer_buffer
, urb
->actual_length
);
256 ep
->umidi
->usb_protocol_ops
->input(ep
, urb
->transfer_buffer
,
259 int err
= snd_usbmidi_urb_error(urb
->status
);
261 if (err
!= -ENODEV
) {
262 ep
->error_resubmit
= 1;
263 mod_timer(&ep
->umidi
->error_timer
,
264 jiffies
+ ERROR_DELAY_JIFFIES
);
270 urb
->dev
= ep
->umidi
->dev
;
271 snd_usbmidi_submit_urb(urb
, GFP_ATOMIC
);
274 static void snd_usbmidi_out_urb_complete(struct urb
* urb
)
276 struct out_urb_context
*context
= urb
->context
;
277 struct snd_usb_midi_out_endpoint
* ep
= context
->ep
;
278 unsigned int urb_index
;
280 spin_lock(&ep
->buffer_lock
);
281 urb_index
= context
- ep
->urbs
;
282 ep
->active_urbs
&= ~(1 << urb_index
);
283 if (unlikely(ep
->drain_urbs
)) {
284 ep
->drain_urbs
&= ~(1 << urb_index
);
285 wake_up(&ep
->drain_wait
);
287 spin_unlock(&ep
->buffer_lock
);
288 if (urb
->status
< 0) {
289 int err
= snd_usbmidi_urb_error(urb
->status
);
292 mod_timer(&ep
->umidi
->error_timer
,
293 jiffies
+ ERROR_DELAY_JIFFIES
);
297 snd_usbmidi_do_output(ep
);
301 * This is called when some data should be transferred to the device
302 * (from one or more substreams).
304 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint
* ep
)
306 unsigned int urb_index
;
310 spin_lock_irqsave(&ep
->buffer_lock
, flags
);
311 if (ep
->umidi
->disconnected
) {
312 spin_unlock_irqrestore(&ep
->buffer_lock
, flags
);
316 urb_index
= ep
->next_urb
;
318 if (!(ep
->active_urbs
& (1 << urb_index
))) {
319 urb
= ep
->urbs
[urb_index
].urb
;
320 urb
->transfer_buffer_length
= 0;
321 ep
->umidi
->usb_protocol_ops
->output(ep
, urb
);
322 if (urb
->transfer_buffer_length
== 0)
325 dump_urb("sending", urb
->transfer_buffer
,
326 urb
->transfer_buffer_length
);
327 urb
->dev
= ep
->umidi
->dev
;
328 if (snd_usbmidi_submit_urb(urb
, GFP_ATOMIC
) < 0)
330 ep
->active_urbs
|= 1 << urb_index
;
332 if (++urb_index
>= OUTPUT_URBS
)
334 if (urb_index
== ep
->next_urb
)
337 ep
->next_urb
= urb_index
;
338 spin_unlock_irqrestore(&ep
->buffer_lock
, flags
);
341 static void snd_usbmidi_out_tasklet(unsigned long data
)
343 struct snd_usb_midi_out_endpoint
* ep
= (struct snd_usb_midi_out_endpoint
*) data
;
345 snd_usbmidi_do_output(ep
);
348 /* called after transfers had been interrupted due to some USB error */
349 static void snd_usbmidi_error_timer(unsigned long data
)
351 struct snd_usb_midi
*umidi
= (struct snd_usb_midi
*)data
;
354 spin_lock(&umidi
->disc_lock
);
355 if (umidi
->disconnected
) {
356 spin_unlock(&umidi
->disc_lock
);
359 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
360 struct snd_usb_midi_in_endpoint
*in
= umidi
->endpoints
[i
].in
;
361 if (in
&& in
->error_resubmit
) {
362 in
->error_resubmit
= 0;
363 for (j
= 0; j
< INPUT_URBS
; ++j
) {
364 in
->urbs
[j
]->dev
= umidi
->dev
;
365 snd_usbmidi_submit_urb(in
->urbs
[j
], GFP_ATOMIC
);
368 if (umidi
->endpoints
[i
].out
)
369 snd_usbmidi_do_output(umidi
->endpoints
[i
].out
);
371 spin_unlock(&umidi
->disc_lock
);
374 /* helper function to send static data that may not DMA-able */
375 static int send_bulk_static_data(struct snd_usb_midi_out_endpoint
* ep
,
376 const void *data
, int len
)
379 void *buf
= kmemdup(data
, len
, GFP_KERNEL
);
382 dump_urb("sending", buf
, len
);
384 err
= usb_bulk_msg(ep
->umidi
->dev
, ep
->urbs
[0].urb
->pipe
,
385 buf
, len
, NULL
, 250);
391 * Standard USB MIDI protocol: see the spec.
392 * Midiman protocol: like the standard protocol, but the control byte is the
393 * fourth byte in each packet, and uses length instead of CIN.
396 static void snd_usbmidi_standard_input(struct snd_usb_midi_in_endpoint
* ep
,
397 uint8_t* buffer
, int buffer_length
)
401 for (i
= 0; i
+ 3 < buffer_length
; i
+= 4)
402 if (buffer
[i
] != 0) {
403 int cable
= buffer
[i
] >> 4;
404 int length
= snd_usbmidi_cin_length
[buffer
[i
] & 0x0f];
405 snd_usbmidi_input_data(ep
, cable
, &buffer
[i
+ 1], length
);
409 static void snd_usbmidi_midiman_input(struct snd_usb_midi_in_endpoint
* ep
,
410 uint8_t* buffer
, int buffer_length
)
414 for (i
= 0; i
+ 3 < buffer_length
; i
+= 4)
415 if (buffer
[i
+ 3] != 0) {
416 int port
= buffer
[i
+ 3] >> 4;
417 int length
= buffer
[i
+ 3] & 3;
418 snd_usbmidi_input_data(ep
, port
, &buffer
[i
], length
);
423 * Buggy M-Audio device: running status on input results in a packet that has
424 * the data bytes but not the status byte and that is marked with CIN 4.
426 static void snd_usbmidi_maudio_broken_running_status_input(
427 struct snd_usb_midi_in_endpoint
* ep
,
428 uint8_t* buffer
, int buffer_length
)
432 for (i
= 0; i
+ 3 < buffer_length
; i
+= 4)
433 if (buffer
[i
] != 0) {
434 int cable
= buffer
[i
] >> 4;
435 u8 cin
= buffer
[i
] & 0x0f;
436 struct usbmidi_in_port
*port
= &ep
->ports
[cable
];
439 length
= snd_usbmidi_cin_length
[cin
];
440 if (cin
== 0xf && buffer
[i
+ 1] >= 0xf8)
441 ; /* realtime msg: no running status change */
442 else if (cin
>= 0x8 && cin
<= 0xe)
444 port
->running_status_length
= length
- 1;
445 else if (cin
== 0x4 &&
446 port
->running_status_length
!= 0 &&
447 buffer
[i
+ 1] < 0x80)
448 /* CIN 4 that is not a SysEx */
449 length
= port
->running_status_length
;
452 * All other msgs cannot begin running status.
453 * (A channel msg sent as two or three CIN 0xF
454 * packets could in theory, but this device
455 * doesn't use this format.)
457 port
->running_status_length
= 0;
458 snd_usbmidi_input_data(ep
, cable
, &buffer
[i
+ 1], length
);
463 * CME protocol: like the standard protocol, but SysEx commands are sent as a
464 * single USB packet preceded by a 0x0F byte.
466 static void snd_usbmidi_cme_input(struct snd_usb_midi_in_endpoint
*ep
,
467 uint8_t *buffer
, int buffer_length
)
469 if (buffer_length
< 2 || (buffer
[0] & 0x0f) != 0x0f)
470 snd_usbmidi_standard_input(ep
, buffer
, buffer_length
);
472 snd_usbmidi_input_data(ep
, buffer
[0] >> 4,
473 &buffer
[1], buffer_length
- 1);
477 * Adds one USB MIDI packet to the output buffer.
479 static void snd_usbmidi_output_standard_packet(struct urb
* urb
, uint8_t p0
,
480 uint8_t p1
, uint8_t p2
, uint8_t p3
)
483 uint8_t* buf
= (uint8_t*)urb
->transfer_buffer
+ urb
->transfer_buffer_length
;
488 urb
->transfer_buffer_length
+= 4;
492 * Adds one Midiman packet to the output buffer.
494 static void snd_usbmidi_output_midiman_packet(struct urb
* urb
, uint8_t p0
,
495 uint8_t p1
, uint8_t p2
, uint8_t p3
)
498 uint8_t* buf
= (uint8_t*)urb
->transfer_buffer
+ urb
->transfer_buffer_length
;
502 buf
[3] = (p0
& 0xf0) | snd_usbmidi_cin_length
[p0
& 0x0f];
503 urb
->transfer_buffer_length
+= 4;
507 * Converts MIDI commands to USB MIDI packets.
509 static void snd_usbmidi_transmit_byte(struct usbmidi_out_port
* port
,
510 uint8_t b
, struct urb
* urb
)
512 uint8_t p0
= port
->cable
;
513 void (*output_packet
)(struct urb
*, uint8_t, uint8_t, uint8_t, uint8_t) =
514 port
->ep
->umidi
->usb_protocol_ops
->output_packet
;
517 output_packet(urb
, p0
| 0x0f, b
, 0, 0);
518 } else if (b
>= 0xf0) {
522 port
->state
= STATE_SYSEX_1
;
527 port
->state
= STATE_1PARAM
;
531 port
->state
= STATE_2PARAM_1
;
535 port
->state
= STATE_UNKNOWN
;
538 output_packet(urb
, p0
| 0x05, 0xf6, 0, 0);
539 port
->state
= STATE_UNKNOWN
;
542 switch (port
->state
) {
544 output_packet(urb
, p0
| 0x05, 0xf7, 0, 0);
547 output_packet(urb
, p0
| 0x06, port
->data
[0], 0xf7, 0);
550 output_packet(urb
, p0
| 0x07, port
->data
[0], port
->data
[1], 0xf7);
553 port
->state
= STATE_UNKNOWN
;
556 } else if (b
>= 0x80) {
558 if (b
>= 0xc0 && b
<= 0xdf)
559 port
->state
= STATE_1PARAM
;
561 port
->state
= STATE_2PARAM_1
;
562 } else { /* b < 0x80 */
563 switch (port
->state
) {
565 if (port
->data
[0] < 0xf0) {
566 p0
|= port
->data
[0] >> 4;
569 port
->state
= STATE_UNKNOWN
;
571 output_packet(urb
, p0
, port
->data
[0], b
, 0);
575 port
->state
= STATE_2PARAM_2
;
578 if (port
->data
[0] < 0xf0) {
579 p0
|= port
->data
[0] >> 4;
580 port
->state
= STATE_2PARAM_1
;
583 port
->state
= STATE_UNKNOWN
;
585 output_packet(urb
, p0
, port
->data
[0], port
->data
[1], b
);
589 port
->state
= STATE_SYSEX_1
;
593 port
->state
= STATE_SYSEX_2
;
596 output_packet(urb
, p0
| 0x04, port
->data
[0], port
->data
[1], b
);
597 port
->state
= STATE_SYSEX_0
;
603 static void snd_usbmidi_standard_output(struct snd_usb_midi_out_endpoint
* ep
,
608 /* FIXME: lower-numbered ports can starve higher-numbered ports */
609 for (p
= 0; p
< 0x10; ++p
) {
610 struct usbmidi_out_port
* port
= &ep
->ports
[p
];
613 while (urb
->transfer_buffer_length
+ 3 < ep
->max_transfer
) {
615 if (snd_rawmidi_transmit(port
->substream
, &b
, 1) != 1) {
619 snd_usbmidi_transmit_byte(port
, b
, urb
);
624 static struct usb_protocol_ops snd_usbmidi_standard_ops
= {
625 .input
= snd_usbmidi_standard_input
,
626 .output
= snd_usbmidi_standard_output
,
627 .output_packet
= snd_usbmidi_output_standard_packet
,
630 static struct usb_protocol_ops snd_usbmidi_midiman_ops
= {
631 .input
= snd_usbmidi_midiman_input
,
632 .output
= snd_usbmidi_standard_output
,
633 .output_packet
= snd_usbmidi_output_midiman_packet
,
636 static struct usb_protocol_ops snd_usbmidi_maudio_broken_running_status_ops
= {
637 .input
= snd_usbmidi_maudio_broken_running_status_input
,
638 .output
= snd_usbmidi_standard_output
,
639 .output_packet
= snd_usbmidi_output_standard_packet
,
642 static struct usb_protocol_ops snd_usbmidi_cme_ops
= {
643 .input
= snd_usbmidi_cme_input
,
644 .output
= snd_usbmidi_standard_output
,
645 .output_packet
= snd_usbmidi_output_standard_packet
,
649 * AKAI MPD16 protocol:
651 * For control port (endpoint 1):
652 * ==============================
653 * One or more chunks consisting of first byte of (0x10 | msg_len) and then a
654 * SysEx message (msg_len=9 bytes long).
656 * For data port (endpoint 2):
657 * ===========================
658 * One or more chunks consisting of first byte of (0x20 | msg_len) and then a
659 * MIDI message (msg_len bytes long)
661 * Messages sent: Active Sense, Note On, Poly Pressure, Control Change.
663 static void snd_usbmidi_akai_input(struct snd_usb_midi_in_endpoint
*ep
,
664 uint8_t *buffer
, int buffer_length
)
666 unsigned int pos
= 0;
667 unsigned int len
= (unsigned int)buffer_length
;
669 unsigned int port
= (buffer
[pos
] >> 4) - 1;
670 unsigned int msg_len
= buffer
[pos
] & 0x0f;
672 if (pos
+ msg_len
<= len
&& port
< 2)
673 snd_usbmidi_input_data(ep
, 0, &buffer
[pos
], msg_len
);
678 #define MAX_AKAI_SYSEX_LEN 9
680 static void snd_usbmidi_akai_output(struct snd_usb_midi_out_endpoint
*ep
,
684 int pos
, end
, count
, buf_end
;
685 uint8_t tmp
[MAX_AKAI_SYSEX_LEN
];
686 struct snd_rawmidi_substream
*substream
= ep
->ports
[0].substream
;
688 if (!ep
->ports
[0].active
)
691 msg
= urb
->transfer_buffer
+ urb
->transfer_buffer_length
;
692 buf_end
= ep
->max_transfer
- MAX_AKAI_SYSEX_LEN
- 1;
694 /* only try adding more data when there's space for at least 1 SysEx */
695 while (urb
->transfer_buffer_length
< buf_end
) {
696 count
= snd_rawmidi_transmit_peek(substream
,
697 tmp
, MAX_AKAI_SYSEX_LEN
);
699 ep
->ports
[0].active
= 0;
702 /* try to skip non-SysEx data */
703 for (pos
= 0; pos
< count
&& tmp
[pos
] != 0xF0; pos
++)
707 snd_rawmidi_transmit_ack(substream
, pos
);
711 /* look for the start or end marker */
712 for (end
= 1; end
< count
&& tmp
[end
] < 0xF0; end
++)
715 /* next SysEx started before the end of current one */
716 if (end
< count
&& tmp
[end
] == 0xF0) {
717 /* it's incomplete - drop it */
718 snd_rawmidi_transmit_ack(substream
, end
);
722 if (end
< count
&& tmp
[end
] == 0xF7) {
723 /* queue it, ack it, and get the next one */
725 msg
[0] = 0x10 | count
;
726 memcpy(&msg
[1], tmp
, count
);
727 snd_rawmidi_transmit_ack(substream
, count
);
728 urb
->transfer_buffer_length
+= count
+ 1;
732 /* less than 9 bytes and no end byte - wait for more */
733 if (count
< MAX_AKAI_SYSEX_LEN
) {
734 ep
->ports
[0].active
= 0;
737 /* 9 bytes and no end marker in sight - malformed, skip it */
738 snd_rawmidi_transmit_ack(substream
, count
);
742 static struct usb_protocol_ops snd_usbmidi_akai_ops
= {
743 .input
= snd_usbmidi_akai_input
,
744 .output
= snd_usbmidi_akai_output
,
748 * Novation USB MIDI protocol: number of data bytes is in the first byte
749 * (when receiving) (+1!) or in the second byte (when sending); data begins
753 static void snd_usbmidi_novation_input(struct snd_usb_midi_in_endpoint
* ep
,
754 uint8_t* buffer
, int buffer_length
)
756 if (buffer_length
< 2 || !buffer
[0] || buffer_length
< buffer
[0] + 1)
758 snd_usbmidi_input_data(ep
, 0, &buffer
[2], buffer
[0] - 1);
761 static void snd_usbmidi_novation_output(struct snd_usb_midi_out_endpoint
* ep
,
764 uint8_t* transfer_buffer
;
767 if (!ep
->ports
[0].active
)
769 transfer_buffer
= urb
->transfer_buffer
;
770 count
= snd_rawmidi_transmit(ep
->ports
[0].substream
,
772 ep
->max_transfer
- 2);
774 ep
->ports
[0].active
= 0;
777 transfer_buffer
[0] = 0;
778 transfer_buffer
[1] = count
;
779 urb
->transfer_buffer_length
= 2 + count
;
782 static struct usb_protocol_ops snd_usbmidi_novation_ops
= {
783 .input
= snd_usbmidi_novation_input
,
784 .output
= snd_usbmidi_novation_output
,
788 * "raw" protocol: just move raw MIDI bytes from/to the endpoint
791 static void snd_usbmidi_raw_input(struct snd_usb_midi_in_endpoint
* ep
,
792 uint8_t* buffer
, int buffer_length
)
794 snd_usbmidi_input_data(ep
, 0, buffer
, buffer_length
);
797 static void snd_usbmidi_raw_output(struct snd_usb_midi_out_endpoint
* ep
,
802 if (!ep
->ports
[0].active
)
804 count
= snd_rawmidi_transmit(ep
->ports
[0].substream
,
805 urb
->transfer_buffer
,
808 ep
->ports
[0].active
= 0;
811 urb
->transfer_buffer_length
= count
;
814 static struct usb_protocol_ops snd_usbmidi_raw_ops
= {
815 .input
= snd_usbmidi_raw_input
,
816 .output
= snd_usbmidi_raw_output
,
820 * FTDI protocol: raw MIDI bytes, but input packets have two modem status bytes.
823 static void snd_usbmidi_ftdi_input(struct snd_usb_midi_in_endpoint
* ep
,
824 uint8_t* buffer
, int buffer_length
)
826 if (buffer_length
> 2)
827 snd_usbmidi_input_data(ep
, 0, buffer
+ 2, buffer_length
- 2);
830 static struct usb_protocol_ops snd_usbmidi_ftdi_ops
= {
831 .input
= snd_usbmidi_ftdi_input
,
832 .output
= snd_usbmidi_raw_output
,
835 static void snd_usbmidi_us122l_input(struct snd_usb_midi_in_endpoint
*ep
,
836 uint8_t *buffer
, int buffer_length
)
838 if (buffer_length
!= 9)
841 while (buffer_length
&& buffer
[buffer_length
- 1] == 0xFD)
844 snd_usbmidi_input_data(ep
, 0, buffer
, buffer_length
);
847 static void snd_usbmidi_us122l_output(struct snd_usb_midi_out_endpoint
*ep
,
852 if (!ep
->ports
[0].active
)
854 switch (snd_usb_get_speed(ep
->umidi
->dev
)) {
856 case USB_SPEED_SUPER
:
862 count
= snd_rawmidi_transmit(ep
->ports
[0].substream
,
863 urb
->transfer_buffer
,
866 ep
->ports
[0].active
= 0;
870 memset(urb
->transfer_buffer
+ count
, 0xFD, ep
->max_transfer
- count
);
871 urb
->transfer_buffer_length
= ep
->max_transfer
;
874 static struct usb_protocol_ops snd_usbmidi_122l_ops
= {
875 .input
= snd_usbmidi_us122l_input
,
876 .output
= snd_usbmidi_us122l_output
,
880 * Emagic USB MIDI protocol: raw MIDI with "F5 xx" port switching.
883 static void snd_usbmidi_emagic_init_out(struct snd_usb_midi_out_endpoint
* ep
)
885 static const u8 init_data
[] = {
886 /* initialization magic: "get version" */
888 0x00, 0x20, 0x31, /* Emagic */
890 0x0b, /* version number request */
891 0x00, /* command version */
892 0x00, /* EEPROM, box 0 */
895 send_bulk_static_data(ep
, init_data
, sizeof(init_data
));
896 /* while we're at it, pour on more magic */
897 send_bulk_static_data(ep
, init_data
, sizeof(init_data
));
900 static void snd_usbmidi_emagic_finish_out(struct snd_usb_midi_out_endpoint
* ep
)
902 static const u8 finish_data
[] = {
903 /* switch to patch mode with last preset */
905 0x00, 0x20, 0x31, /* Emagic */
907 0x10, /* patch switch command */
908 0x00, /* command version */
909 0x7f, /* to all boxes */
910 0x40, /* last preset in EEPROM */
913 send_bulk_static_data(ep
, finish_data
, sizeof(finish_data
));
916 static void snd_usbmidi_emagic_input(struct snd_usb_midi_in_endpoint
* ep
,
917 uint8_t* buffer
, int buffer_length
)
921 /* FF indicates end of valid data */
922 for (i
= 0; i
< buffer_length
; ++i
)
923 if (buffer
[i
] == 0xff) {
928 /* handle F5 at end of last buffer */
932 while (buffer_length
> 0) {
933 /* determine size of data until next F5 */
934 for (i
= 0; i
< buffer_length
; ++i
)
935 if (buffer
[i
] == 0xf5)
937 snd_usbmidi_input_data(ep
, ep
->current_port
, buffer
, i
);
941 if (buffer_length
<= 0)
943 /* assert(buffer[0] == 0xf5); */
949 if (buffer_length
<= 0)
951 if (buffer
[0] < 0x80) {
952 ep
->current_port
= (buffer
[0] - 1) & 15;
960 static void snd_usbmidi_emagic_output(struct snd_usb_midi_out_endpoint
* ep
,
963 int port0
= ep
->current_port
;
964 uint8_t* buf
= urb
->transfer_buffer
;
965 int buf_free
= ep
->max_transfer
;
968 for (i
= 0; i
< 0x10; ++i
) {
969 /* round-robin, starting at the last current port */
970 int portnum
= (port0
+ i
) & 15;
971 struct usbmidi_out_port
* port
= &ep
->ports
[portnum
];
975 if (snd_rawmidi_transmit_peek(port
->substream
, buf
, 1) != 1) {
980 if (portnum
!= ep
->current_port
) {
983 ep
->current_port
= portnum
;
985 buf
[1] = (portnum
+ 1) & 15;
992 length
= snd_rawmidi_transmit(port
->substream
, buf
, buf_free
);
1000 if (buf_free
< ep
->max_transfer
&& buf_free
> 0) {
1004 urb
->transfer_buffer_length
= ep
->max_transfer
- buf_free
;
1007 static struct usb_protocol_ops snd_usbmidi_emagic_ops
= {
1008 .input
= snd_usbmidi_emagic_input
,
1009 .output
= snd_usbmidi_emagic_output
,
1010 .init_out_endpoint
= snd_usbmidi_emagic_init_out
,
1011 .finish_out_endpoint
= snd_usbmidi_emagic_finish_out
,
1015 static void update_roland_altsetting(struct snd_usb_midi
* umidi
)
1017 struct usb_interface
*intf
;
1018 struct usb_host_interface
*hostif
;
1019 struct usb_interface_descriptor
*intfd
;
1022 intf
= umidi
->iface
;
1023 is_light_load
= intf
->cur_altsetting
!= intf
->altsetting
;
1024 if (umidi
->roland_load_ctl
->private_value
== is_light_load
)
1026 hostif
= &intf
->altsetting
[umidi
->roland_load_ctl
->private_value
];
1027 intfd
= get_iface_desc(hostif
);
1028 snd_usbmidi_input_stop(&umidi
->list
);
1029 usb_set_interface(umidi
->dev
, intfd
->bInterfaceNumber
,
1030 intfd
->bAlternateSetting
);
1031 snd_usbmidi_input_start(&umidi
->list
);
1034 static void substream_open(struct snd_rawmidi_substream
*substream
, int open
)
1036 struct snd_usb_midi
* umidi
= substream
->rmidi
->private_data
;
1037 struct snd_kcontrol
*ctl
;
1039 mutex_lock(&umidi
->mutex
);
1041 if (umidi
->opened
++ == 0 && umidi
->roland_load_ctl
) {
1042 ctl
= umidi
->roland_load_ctl
;
1043 ctl
->vd
[0].access
|= SNDRV_CTL_ELEM_ACCESS_INACTIVE
;
1044 snd_ctl_notify(umidi
->card
,
1045 SNDRV_CTL_EVENT_MASK_INFO
, &ctl
->id
);
1046 update_roland_altsetting(umidi
);
1049 if (--umidi
->opened
== 0 && umidi
->roland_load_ctl
) {
1050 ctl
= umidi
->roland_load_ctl
;
1051 ctl
->vd
[0].access
&= ~SNDRV_CTL_ELEM_ACCESS_INACTIVE
;
1052 snd_ctl_notify(umidi
->card
,
1053 SNDRV_CTL_EVENT_MASK_INFO
, &ctl
->id
);
1056 mutex_unlock(&umidi
->mutex
);
1059 static int snd_usbmidi_output_open(struct snd_rawmidi_substream
*substream
)
1061 struct snd_usb_midi
* umidi
= substream
->rmidi
->private_data
;
1062 struct usbmidi_out_port
* port
= NULL
;
1066 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
)
1067 if (umidi
->endpoints
[i
].out
)
1068 for (j
= 0; j
< 0x10; ++j
)
1069 if (umidi
->endpoints
[i
].out
->ports
[j
].substream
== substream
) {
1070 port
= &umidi
->endpoints
[i
].out
->ports
[j
];
1077 err
= usb_autopm_get_interface(umidi
->iface
);
1080 substream
->runtime
->private_data
= port
;
1081 port
->state
= STATE_UNKNOWN
;
1082 substream_open(substream
, 1);
1086 static int snd_usbmidi_output_close(struct snd_rawmidi_substream
*substream
)
1088 struct snd_usb_midi
* umidi
= substream
->rmidi
->private_data
;
1090 substream_open(substream
, 0);
1091 usb_autopm_put_interface(umidi
->iface
);
1095 static void snd_usbmidi_output_trigger(struct snd_rawmidi_substream
*substream
, int up
)
1097 struct usbmidi_out_port
* port
= (struct usbmidi_out_port
*)substream
->runtime
->private_data
;
1101 if (port
->ep
->umidi
->disconnected
) {
1102 /* gobble up remaining bytes to prevent wait in
1103 * snd_rawmidi_drain_output */
1104 while (!snd_rawmidi_transmit_empty(substream
))
1105 snd_rawmidi_transmit_ack(substream
, 1);
1108 tasklet_schedule(&port
->ep
->tasklet
);
1112 static void snd_usbmidi_output_drain(struct snd_rawmidi_substream
*substream
)
1114 struct usbmidi_out_port
* port
= substream
->runtime
->private_data
;
1115 struct snd_usb_midi_out_endpoint
*ep
= port
->ep
;
1116 unsigned int drain_urbs
;
1118 long timeout
= msecs_to_jiffies(50);
1120 if (ep
->umidi
->disconnected
)
1123 * The substream buffer is empty, but some data might still be in the
1124 * currently active URBs, so we have to wait for those to complete.
1126 spin_lock_irq(&ep
->buffer_lock
);
1127 drain_urbs
= ep
->active_urbs
;
1129 ep
->drain_urbs
|= drain_urbs
;
1131 prepare_to_wait(&ep
->drain_wait
, &wait
,
1132 TASK_UNINTERRUPTIBLE
);
1133 spin_unlock_irq(&ep
->buffer_lock
);
1134 timeout
= schedule_timeout(timeout
);
1135 spin_lock_irq(&ep
->buffer_lock
);
1136 drain_urbs
&= ep
->drain_urbs
;
1137 } while (drain_urbs
&& timeout
);
1138 finish_wait(&ep
->drain_wait
, &wait
);
1140 spin_unlock_irq(&ep
->buffer_lock
);
1143 static int snd_usbmidi_input_open(struct snd_rawmidi_substream
*substream
)
1145 substream_open(substream
, 1);
1149 static int snd_usbmidi_input_close(struct snd_rawmidi_substream
*substream
)
1151 substream_open(substream
, 0);
1155 static void snd_usbmidi_input_trigger(struct snd_rawmidi_substream
*substream
, int up
)
1157 struct snd_usb_midi
* umidi
= substream
->rmidi
->private_data
;
1160 set_bit(substream
->number
, &umidi
->input_triggered
);
1162 clear_bit(substream
->number
, &umidi
->input_triggered
);
1165 static struct snd_rawmidi_ops snd_usbmidi_output_ops
= {
1166 .open
= snd_usbmidi_output_open
,
1167 .close
= snd_usbmidi_output_close
,
1168 .trigger
= snd_usbmidi_output_trigger
,
1169 .drain
= snd_usbmidi_output_drain
,
1172 static struct snd_rawmidi_ops snd_usbmidi_input_ops
= {
1173 .open
= snd_usbmidi_input_open
,
1174 .close
= snd_usbmidi_input_close
,
1175 .trigger
= snd_usbmidi_input_trigger
1178 static void free_urb_and_buffer(struct snd_usb_midi
*umidi
, struct urb
*urb
,
1179 unsigned int buffer_length
)
1181 usb_free_coherent(umidi
->dev
, buffer_length
,
1182 urb
->transfer_buffer
, urb
->transfer_dma
);
1187 * Frees an input endpoint.
1188 * May be called when ep hasn't been initialized completely.
1190 static void snd_usbmidi_in_endpoint_delete(struct snd_usb_midi_in_endpoint
* ep
)
1194 for (i
= 0; i
< INPUT_URBS
; ++i
)
1196 free_urb_and_buffer(ep
->umidi
, ep
->urbs
[i
],
1197 ep
->urbs
[i
]->transfer_buffer_length
);
1202 * Creates an input endpoint.
1204 static int snd_usbmidi_in_endpoint_create(struct snd_usb_midi
* umidi
,
1205 struct snd_usb_midi_endpoint_info
* ep_info
,
1206 struct snd_usb_midi_endpoint
* rep
)
1208 struct snd_usb_midi_in_endpoint
* ep
;
1215 ep
= kzalloc(sizeof(*ep
), GFP_KERNEL
);
1220 for (i
= 0; i
< INPUT_URBS
; ++i
) {
1221 ep
->urbs
[i
] = usb_alloc_urb(0, GFP_KERNEL
);
1223 snd_usbmidi_in_endpoint_delete(ep
);
1227 if (ep_info
->in_interval
)
1228 pipe
= usb_rcvintpipe(umidi
->dev
, ep_info
->in_ep
);
1230 pipe
= usb_rcvbulkpipe(umidi
->dev
, ep_info
->in_ep
);
1231 length
= usb_maxpacket(umidi
->dev
, pipe
, 0);
1232 for (i
= 0; i
< INPUT_URBS
; ++i
) {
1233 buffer
= usb_alloc_coherent(umidi
->dev
, length
, GFP_KERNEL
,
1234 &ep
->urbs
[i
]->transfer_dma
);
1236 snd_usbmidi_in_endpoint_delete(ep
);
1239 if (ep_info
->in_interval
)
1240 usb_fill_int_urb(ep
->urbs
[i
], umidi
->dev
,
1241 pipe
, buffer
, length
,
1242 snd_usbmidi_in_urb_complete
,
1243 ep
, ep_info
->in_interval
);
1245 usb_fill_bulk_urb(ep
->urbs
[i
], umidi
->dev
,
1246 pipe
, buffer
, length
,
1247 snd_usbmidi_in_urb_complete
, ep
);
1248 ep
->urbs
[i
]->transfer_flags
= URB_NO_TRANSFER_DMA_MAP
;
1256 * Frees an output endpoint.
1257 * May be called when ep hasn't been initialized completely.
1259 static void snd_usbmidi_out_endpoint_clear(struct snd_usb_midi_out_endpoint
*ep
)
1263 for (i
= 0; i
< OUTPUT_URBS
; ++i
)
1264 if (ep
->urbs
[i
].urb
) {
1265 free_urb_and_buffer(ep
->umidi
, ep
->urbs
[i
].urb
,
1267 ep
->urbs
[i
].urb
= NULL
;
1271 static void snd_usbmidi_out_endpoint_delete(struct snd_usb_midi_out_endpoint
*ep
)
1273 snd_usbmidi_out_endpoint_clear(ep
);
1278 * Creates an output endpoint, and initializes output ports.
1280 static int snd_usbmidi_out_endpoint_create(struct snd_usb_midi
* umidi
,
1281 struct snd_usb_midi_endpoint_info
* ep_info
,
1282 struct snd_usb_midi_endpoint
* rep
)
1284 struct snd_usb_midi_out_endpoint
* ep
;
1290 ep
= kzalloc(sizeof(*ep
), GFP_KERNEL
);
1295 for (i
= 0; i
< OUTPUT_URBS
; ++i
) {
1296 ep
->urbs
[i
].urb
= usb_alloc_urb(0, GFP_KERNEL
);
1297 if (!ep
->urbs
[i
].urb
) {
1298 snd_usbmidi_out_endpoint_delete(ep
);
1301 ep
->urbs
[i
].ep
= ep
;
1303 if (ep_info
->out_interval
)
1304 pipe
= usb_sndintpipe(umidi
->dev
, ep_info
->out_ep
);
1306 pipe
= usb_sndbulkpipe(umidi
->dev
, ep_info
->out_ep
);
1307 switch (umidi
->usb_id
) {
1309 ep
->max_transfer
= usb_maxpacket(umidi
->dev
, pipe
, 1);
1312 * Various chips declare a packet size larger than 4 bytes, but
1313 * do not actually work with larger packets:
1315 case USB_ID(0x0a92, 0x1020): /* ESI M4U */
1316 case USB_ID(0x1430, 0x474b): /* RedOctane GH MIDI INTERFACE */
1317 case USB_ID(0x15ca, 0x0101): /* Textech USB Midi Cable */
1318 case USB_ID(0x15ca, 0x1806): /* Textech USB Midi Cable */
1319 case USB_ID(0x1a86, 0x752d): /* QinHeng CH345 "USB2.0-MIDI" */
1320 case USB_ID(0xfc08, 0x0101): /* Unknown vendor Cable */
1321 ep
->max_transfer
= 4;
1324 * Some devices only work with 9 bytes packet size:
1326 case USB_ID(0x0644, 0x800E): /* Tascam US-122L */
1327 case USB_ID(0x0644, 0x800F): /* Tascam US-144 */
1328 ep
->max_transfer
= 9;
1331 for (i
= 0; i
< OUTPUT_URBS
; ++i
) {
1332 buffer
= usb_alloc_coherent(umidi
->dev
,
1333 ep
->max_transfer
, GFP_KERNEL
,
1334 &ep
->urbs
[i
].urb
->transfer_dma
);
1336 snd_usbmidi_out_endpoint_delete(ep
);
1339 if (ep_info
->out_interval
)
1340 usb_fill_int_urb(ep
->urbs
[i
].urb
, umidi
->dev
,
1341 pipe
, buffer
, ep
->max_transfer
,
1342 snd_usbmidi_out_urb_complete
,
1343 &ep
->urbs
[i
], ep_info
->out_interval
);
1345 usb_fill_bulk_urb(ep
->urbs
[i
].urb
, umidi
->dev
,
1346 pipe
, buffer
, ep
->max_transfer
,
1347 snd_usbmidi_out_urb_complete
,
1349 ep
->urbs
[i
].urb
->transfer_flags
= URB_NO_TRANSFER_DMA_MAP
;
1352 spin_lock_init(&ep
->buffer_lock
);
1353 tasklet_init(&ep
->tasklet
, snd_usbmidi_out_tasklet
, (unsigned long)ep
);
1354 init_waitqueue_head(&ep
->drain_wait
);
1356 for (i
= 0; i
< 0x10; ++i
)
1357 if (ep_info
->out_cables
& (1 << i
)) {
1358 ep
->ports
[i
].ep
= ep
;
1359 ep
->ports
[i
].cable
= i
<< 4;
1362 if (umidi
->usb_protocol_ops
->init_out_endpoint
)
1363 umidi
->usb_protocol_ops
->init_out_endpoint(ep
);
1372 static void snd_usbmidi_free(struct snd_usb_midi
* umidi
)
1376 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1377 struct snd_usb_midi_endpoint
* ep
= &umidi
->endpoints
[i
];
1379 snd_usbmidi_out_endpoint_delete(ep
->out
);
1381 snd_usbmidi_in_endpoint_delete(ep
->in
);
1383 mutex_destroy(&umidi
->mutex
);
1388 * Unlinks all URBs (must be done before the usb_device is deleted).
1390 void snd_usbmidi_disconnect(struct list_head
* p
)
1392 struct snd_usb_midi
* umidi
;
1395 umidi
= list_entry(p
, struct snd_usb_midi
, list
);
1397 * an URB's completion handler may start the timer and
1398 * a timer may submit an URB. To reliably break the cycle
1399 * a flag under lock must be used
1401 spin_lock_irq(&umidi
->disc_lock
);
1402 umidi
->disconnected
= 1;
1403 spin_unlock_irq(&umidi
->disc_lock
);
1404 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1405 struct snd_usb_midi_endpoint
* ep
= &umidi
->endpoints
[i
];
1407 tasklet_kill(&ep
->out
->tasklet
);
1409 for (j
= 0; j
< OUTPUT_URBS
; ++j
)
1410 usb_kill_urb(ep
->out
->urbs
[j
].urb
);
1411 if (umidi
->usb_protocol_ops
->finish_out_endpoint
)
1412 umidi
->usb_protocol_ops
->finish_out_endpoint(ep
->out
);
1413 ep
->out
->active_urbs
= 0;
1414 if (ep
->out
->drain_urbs
) {
1415 ep
->out
->drain_urbs
= 0;
1416 wake_up(&ep
->out
->drain_wait
);
1420 for (j
= 0; j
< INPUT_URBS
; ++j
)
1421 usb_kill_urb(ep
->in
->urbs
[j
]);
1422 /* free endpoints here; later call can result in Oops */
1424 snd_usbmidi_out_endpoint_clear(ep
->out
);
1426 snd_usbmidi_in_endpoint_delete(ep
->in
);
1430 del_timer_sync(&umidi
->error_timer
);
1433 static void snd_usbmidi_rawmidi_free(struct snd_rawmidi
*rmidi
)
1435 struct snd_usb_midi
* umidi
= rmidi
->private_data
;
1436 snd_usbmidi_free(umidi
);
1439 static struct snd_rawmidi_substream
*snd_usbmidi_find_substream(struct snd_usb_midi
* umidi
,
1440 int stream
, int number
)
1442 struct list_head
* list
;
1444 list_for_each(list
, &umidi
->rmidi
->streams
[stream
].substreams
) {
1445 struct snd_rawmidi_substream
*substream
= list_entry(list
, struct snd_rawmidi_substream
, list
);
1446 if (substream
->number
== number
)
1453 * This list specifies names for ports that do not fit into the standard
1454 * "(product) MIDI (n)" schema because they aren't external MIDI ports,
1455 * such as internal control or synthesizer ports.
1457 static struct port_info
{
1462 unsigned int seq_flags
;
1463 } snd_usbmidi_port_info
[] = {
1464 #define PORT_INFO(vendor, product, num, name_, voices_, flags) \
1465 { .id = USB_ID(vendor, product), \
1466 .port = num, .voices = voices_, \
1467 .name = name_, .seq_flags = flags }
1468 #define EXTERNAL_PORT(vendor, product, num, name) \
1469 PORT_INFO(vendor, product, num, name, 0, \
1470 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1471 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1472 SNDRV_SEQ_PORT_TYPE_PORT)
1473 #define CONTROL_PORT(vendor, product, num, name) \
1474 PORT_INFO(vendor, product, num, name, 0, \
1475 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1476 SNDRV_SEQ_PORT_TYPE_HARDWARE)
1477 #define ROLAND_SYNTH_PORT(vendor, product, num, name, voices) \
1478 PORT_INFO(vendor, product, num, name, voices, \
1479 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1480 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1481 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1482 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1483 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1484 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1485 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1486 #define SOUNDCANVAS_PORT(vendor, product, num, name, voices) \
1487 PORT_INFO(vendor, product, num, name, voices, \
1488 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1489 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1490 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1491 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1492 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1493 SNDRV_SEQ_PORT_TYPE_MIDI_MT32 | \
1494 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1495 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1497 CONTROL_PORT(0x0582, 0x0000, 2, "%s Control"),
1498 /* Roland SC-8850 */
1499 SOUNDCANVAS_PORT(0x0582, 0x0003, 0, "%s Part A", 128),
1500 SOUNDCANVAS_PORT(0x0582, 0x0003, 1, "%s Part B", 128),
1501 SOUNDCANVAS_PORT(0x0582, 0x0003, 2, "%s Part C", 128),
1502 SOUNDCANVAS_PORT(0x0582, 0x0003, 3, "%s Part D", 128),
1503 EXTERNAL_PORT(0x0582, 0x0003, 4, "%s MIDI 1"),
1504 EXTERNAL_PORT(0x0582, 0x0003, 5, "%s MIDI 2"),
1506 EXTERNAL_PORT(0x0582, 0x0004, 0, "%s MIDI"),
1507 CONTROL_PORT(0x0582, 0x0004, 1, "%s Control"),
1508 /* Roland SC-8820 */
1509 SOUNDCANVAS_PORT(0x0582, 0x0007, 0, "%s Part A", 64),
1510 SOUNDCANVAS_PORT(0x0582, 0x0007, 1, "%s Part B", 64),
1511 EXTERNAL_PORT(0x0582, 0x0007, 2, "%s MIDI"),
1513 SOUNDCANVAS_PORT(0x0582, 0x000b, 0, "%s Part A", 64),
1514 SOUNDCANVAS_PORT(0x0582, 0x000b, 1, "%s Part B", 64),
1515 EXTERNAL_PORT(0x0582, 0x000b, 2, "%s MIDI"),
1517 SOUNDCANVAS_PORT(0x0582, 0x000c, 0, "%s Part A", 64),
1518 SOUNDCANVAS_PORT(0x0582, 0x000c, 1, "%s Part B", 64),
1519 EXTERNAL_PORT(0x0582, 0x000c, 2, "%s MIDI"),
1521 CONTROL_PORT(0x0582, 0x0014, 8, "%s Control"),
1523 ROLAND_SYNTH_PORT(0x0582, 0x0016, 0, "%s Part A", 128),
1524 ROLAND_SYNTH_PORT(0x0582, 0x0016, 1, "%s Part B", 128),
1525 EXTERNAL_PORT(0x0582, 0x0016, 2, "%s MIDI 1"),
1526 EXTERNAL_PORT(0x0582, 0x0016, 3, "%s MIDI 2"),
1528 CONTROL_PORT(0x0582, 0x0023, 5, "%s Control"),
1530 ROLAND_SYNTH_PORT(0x0582, 0x0027, 0, "%s Part A", 64),
1531 ROLAND_SYNTH_PORT(0x0582, 0x0027, 1, "%s Part B", 64),
1532 EXTERNAL_PORT(0x0582, 0x0027, 2, "%s MIDI"),
1534 ROLAND_SYNTH_PORT(0x0582, 0x0029, 0, "%s Part A", 128),
1535 ROLAND_SYNTH_PORT(0x0582, 0x0029, 1, "%s Part B", 128),
1536 EXTERNAL_PORT(0x0582, 0x0029, 2, "%s MIDI 1"),
1537 EXTERNAL_PORT(0x0582, 0x0029, 3, "%s MIDI 2"),
1539 EXTERNAL_PORT(0x0582, 0x002b, 0, "%s MIDI"),
1540 CONTROL_PORT(0x0582, 0x002b, 1, "%s Control"),
1542 EXTERNAL_PORT(0x0582, 0x002f, 0, "%s MIDI"),
1543 EXTERNAL_PORT(0x0582, 0x002f, 1, "%s External MIDI"),
1544 EXTERNAL_PORT(0x0582, 0x002f, 2, "%s Sync"),
1546 EXTERNAL_PORT(0x0582, 0x0033, 0, "%s MIDI"),
1547 EXTERNAL_PORT(0x0582, 0x0033, 1, "%s 1"),
1548 EXTERNAL_PORT(0x0582, 0x0033, 2, "%s 2"),
1550 EXTERNAL_PORT(0x0582, 0x003b, 0, "%s MIDI"),
1551 CONTROL_PORT(0x0582, 0x003b, 1, "%s Control"),
1552 /* Edirol UA-1000 */
1553 EXTERNAL_PORT(0x0582, 0x0044, 0, "%s MIDI"),
1554 CONTROL_PORT(0x0582, 0x0044, 1, "%s Control"),
1556 EXTERNAL_PORT(0x0582, 0x0048, 0, "%s MIDI"),
1557 EXTERNAL_PORT(0x0582, 0x0048, 1, "%s 1"),
1558 EXTERNAL_PORT(0x0582, 0x0048, 2, "%s 2"),
1560 EXTERNAL_PORT(0x0582, 0x004d, 0, "%s MIDI"),
1561 EXTERNAL_PORT(0x0582, 0x004d, 1, "%s 1"),
1562 EXTERNAL_PORT(0x0582, 0x004d, 2, "%s 2"),
1564 CONTROL_PORT(0x0582, 0x009a, 3, "%s Control"),
1565 /* M-Audio MidiSport 8x8 */
1566 CONTROL_PORT(0x0763, 0x1031, 8, "%s Control"),
1567 CONTROL_PORT(0x0763, 0x1033, 8, "%s Control"),
1569 EXTERNAL_PORT(0x07fd, 0x0001, 0, "%s MIDI A"),
1570 EXTERNAL_PORT(0x07fd, 0x0001, 1, "%s MIDI B"),
1571 /* Emagic Unitor8/AMT8/MT4 */
1572 EXTERNAL_PORT(0x086a, 0x0001, 8, "%s Broadcast"),
1573 EXTERNAL_PORT(0x086a, 0x0002, 8, "%s Broadcast"),
1574 EXTERNAL_PORT(0x086a, 0x0003, 4, "%s Broadcast"),
1576 CONTROL_PORT(0x09e8, 0x0062, 0, "%s Control"),
1577 PORT_INFO(0x09e8, 0x0062, 1, "%s MIDI", 0,
1578 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC
|
1579 SNDRV_SEQ_PORT_TYPE_HARDWARE
),
1580 /* Access Music Virus TI */
1581 EXTERNAL_PORT(0x133e, 0x0815, 0, "%s MIDI"),
1582 PORT_INFO(0x133e, 0x0815, 1, "%s Synth", 0,
1583 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC
|
1584 SNDRV_SEQ_PORT_TYPE_HARDWARE
|
1585 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER
),
1588 static struct port_info
*find_port_info(struct snd_usb_midi
* umidi
, int number
)
1592 for (i
= 0; i
< ARRAY_SIZE(snd_usbmidi_port_info
); ++i
) {
1593 if (snd_usbmidi_port_info
[i
].id
== umidi
->usb_id
&&
1594 snd_usbmidi_port_info
[i
].port
== number
)
1595 return &snd_usbmidi_port_info
[i
];
1600 static void snd_usbmidi_get_port_info(struct snd_rawmidi
*rmidi
, int number
,
1601 struct snd_seq_port_info
*seq_port_info
)
1603 struct snd_usb_midi
*umidi
= rmidi
->private_data
;
1604 struct port_info
*port_info
;
1606 /* TODO: read port flags from descriptors */
1607 port_info
= find_port_info(umidi
, number
);
1609 seq_port_info
->type
= port_info
->seq_flags
;
1610 seq_port_info
->midi_voices
= port_info
->voices
;
1614 static void snd_usbmidi_init_substream(struct snd_usb_midi
* umidi
,
1615 int stream
, int number
,
1616 struct snd_rawmidi_substream
** rsubstream
)
1618 struct port_info
*port_info
;
1619 const char *name_format
;
1621 struct snd_rawmidi_substream
*substream
= snd_usbmidi_find_substream(umidi
, stream
, number
);
1623 snd_printd(KERN_ERR
"substream %d:%d not found\n", stream
, number
);
1627 /* TODO: read port name from jack descriptor */
1628 port_info
= find_port_info(umidi
, number
);
1629 name_format
= port_info
? port_info
->name
: "%s MIDI %d";
1630 snprintf(substream
->name
, sizeof(substream
->name
),
1631 name_format
, umidi
->card
->shortname
, number
+ 1);
1633 *rsubstream
= substream
;
1637 * Creates the endpoints and their ports.
1639 static int snd_usbmidi_create_endpoints(struct snd_usb_midi
* umidi
,
1640 struct snd_usb_midi_endpoint_info
* endpoints
)
1643 int out_ports
= 0, in_ports
= 0;
1645 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1646 if (endpoints
[i
].out_cables
) {
1647 err
= snd_usbmidi_out_endpoint_create(umidi
, &endpoints
[i
],
1648 &umidi
->endpoints
[i
]);
1652 if (endpoints
[i
].in_cables
) {
1653 err
= snd_usbmidi_in_endpoint_create(umidi
, &endpoints
[i
],
1654 &umidi
->endpoints
[i
]);
1659 for (j
= 0; j
< 0x10; ++j
) {
1660 if (endpoints
[i
].out_cables
& (1 << j
)) {
1661 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, out_ports
,
1662 &umidi
->endpoints
[i
].out
->ports
[j
].substream
);
1665 if (endpoints
[i
].in_cables
& (1 << j
)) {
1666 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_INPUT
, in_ports
,
1667 &umidi
->endpoints
[i
].in
->ports
[j
].substream
);
1672 snd_printdd(KERN_INFO
"created %d output and %d input ports\n",
1673 out_ports
, in_ports
);
1678 * Returns MIDIStreaming device capabilities.
1680 static int snd_usbmidi_get_ms_info(struct snd_usb_midi
* umidi
,
1681 struct snd_usb_midi_endpoint_info
* endpoints
)
1683 struct usb_interface
* intf
;
1684 struct usb_host_interface
*hostif
;
1685 struct usb_interface_descriptor
* intfd
;
1686 struct usb_ms_header_descriptor
* ms_header
;
1687 struct usb_host_endpoint
*hostep
;
1688 struct usb_endpoint_descriptor
* ep
;
1689 struct usb_ms_endpoint_descriptor
* ms_ep
;
1692 intf
= umidi
->iface
;
1695 hostif
= &intf
->altsetting
[0];
1696 intfd
= get_iface_desc(hostif
);
1697 ms_header
= (struct usb_ms_header_descriptor
*)hostif
->extra
;
1698 if (hostif
->extralen
>= 7 &&
1699 ms_header
->bLength
>= 7 &&
1700 ms_header
->bDescriptorType
== USB_DT_CS_INTERFACE
&&
1701 ms_header
->bDescriptorSubtype
== UAC_HEADER
)
1702 snd_printdd(KERN_INFO
"MIDIStreaming version %02x.%02x\n",
1703 ms_header
->bcdMSC
[1], ms_header
->bcdMSC
[0]);
1705 snd_printk(KERN_WARNING
"MIDIStreaming interface descriptor not found\n");
1708 for (i
= 0; i
< intfd
->bNumEndpoints
; ++i
) {
1709 hostep
= &hostif
->endpoint
[i
];
1710 ep
= get_ep_desc(hostep
);
1711 if (!usb_endpoint_xfer_bulk(ep
) && !usb_endpoint_xfer_int(ep
))
1713 ms_ep
= (struct usb_ms_endpoint_descriptor
*)hostep
->extra
;
1714 if (hostep
->extralen
< 4 ||
1715 ms_ep
->bLength
< 4 ||
1716 ms_ep
->bDescriptorType
!= USB_DT_CS_ENDPOINT
||
1717 ms_ep
->bDescriptorSubtype
!= UAC_MS_GENERAL
)
1719 if (usb_endpoint_dir_out(ep
)) {
1720 if (endpoints
[epidx
].out_ep
) {
1721 if (++epidx
>= MIDI_MAX_ENDPOINTS
) {
1722 snd_printk(KERN_WARNING
"too many endpoints\n");
1726 endpoints
[epidx
].out_ep
= usb_endpoint_num(ep
);
1727 if (usb_endpoint_xfer_int(ep
))
1728 endpoints
[epidx
].out_interval
= ep
->bInterval
;
1729 else if (snd_usb_get_speed(umidi
->dev
) == USB_SPEED_LOW
)
1731 * Low speed bulk transfers don't exist, so
1732 * force interrupt transfers for devices like
1733 * ESI MIDI Mate that try to use them anyway.
1735 endpoints
[epidx
].out_interval
= 1;
1736 endpoints
[epidx
].out_cables
= (1 << ms_ep
->bNumEmbMIDIJack
) - 1;
1737 snd_printdd(KERN_INFO
"EP %02X: %d jack(s)\n",
1738 ep
->bEndpointAddress
, ms_ep
->bNumEmbMIDIJack
);
1740 if (endpoints
[epidx
].in_ep
) {
1741 if (++epidx
>= MIDI_MAX_ENDPOINTS
) {
1742 snd_printk(KERN_WARNING
"too many endpoints\n");
1746 endpoints
[epidx
].in_ep
= usb_endpoint_num(ep
);
1747 if (usb_endpoint_xfer_int(ep
))
1748 endpoints
[epidx
].in_interval
= ep
->bInterval
;
1749 else if (snd_usb_get_speed(umidi
->dev
) == USB_SPEED_LOW
)
1750 endpoints
[epidx
].in_interval
= 1;
1751 endpoints
[epidx
].in_cables
= (1 << ms_ep
->bNumEmbMIDIJack
) - 1;
1752 snd_printdd(KERN_INFO
"EP %02X: %d jack(s)\n",
1753 ep
->bEndpointAddress
, ms_ep
->bNumEmbMIDIJack
);
1759 static int roland_load_info(struct snd_kcontrol
*kcontrol
,
1760 struct snd_ctl_elem_info
*info
)
1762 static const char *const names
[] = { "High Load", "Light Load" };
1764 return snd_ctl_enum_info(info
, 1, 2, names
);
1767 static int roland_load_get(struct snd_kcontrol
*kcontrol
,
1768 struct snd_ctl_elem_value
*value
)
1770 value
->value
.enumerated
.item
[0] = kcontrol
->private_value
;
1774 static int roland_load_put(struct snd_kcontrol
*kcontrol
,
1775 struct snd_ctl_elem_value
*value
)
1777 struct snd_usb_midi
* umidi
= kcontrol
->private_data
;
1780 if (value
->value
.enumerated
.item
[0] > 1)
1782 mutex_lock(&umidi
->mutex
);
1783 changed
= value
->value
.enumerated
.item
[0] != kcontrol
->private_value
;
1785 kcontrol
->private_value
= value
->value
.enumerated
.item
[0];
1786 mutex_unlock(&umidi
->mutex
);
1790 static struct snd_kcontrol_new roland_load_ctl
= {
1791 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
1792 .name
= "MIDI Input Mode",
1793 .info
= roland_load_info
,
1794 .get
= roland_load_get
,
1795 .put
= roland_load_put
,
1800 * On Roland devices, use the second alternate setting to be able to use
1801 * the interrupt input endpoint.
1803 static void snd_usbmidi_switch_roland_altsetting(struct snd_usb_midi
* umidi
)
1805 struct usb_interface
* intf
;
1806 struct usb_host_interface
*hostif
;
1807 struct usb_interface_descriptor
* intfd
;
1809 intf
= umidi
->iface
;
1810 if (!intf
|| intf
->num_altsetting
!= 2)
1813 hostif
= &intf
->altsetting
[1];
1814 intfd
= get_iface_desc(hostif
);
1815 if (intfd
->bNumEndpoints
!= 2 ||
1816 (get_endpoint(hostif
, 0)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_BULK
||
1817 (get_endpoint(hostif
, 1)->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
) != USB_ENDPOINT_XFER_INT
)
1820 snd_printdd(KERN_INFO
"switching to altsetting %d with int ep\n",
1821 intfd
->bAlternateSetting
);
1822 usb_set_interface(umidi
->dev
, intfd
->bInterfaceNumber
,
1823 intfd
->bAlternateSetting
);
1825 umidi
->roland_load_ctl
= snd_ctl_new1(&roland_load_ctl
, umidi
);
1826 if (snd_ctl_add(umidi
->card
, umidi
->roland_load_ctl
) < 0)
1827 umidi
->roland_load_ctl
= NULL
;
1831 * Try to find any usable endpoints in the interface.
1833 static int snd_usbmidi_detect_endpoints(struct snd_usb_midi
* umidi
,
1834 struct snd_usb_midi_endpoint_info
* endpoint
,
1837 struct usb_interface
* intf
;
1838 struct usb_host_interface
*hostif
;
1839 struct usb_interface_descriptor
* intfd
;
1840 struct usb_endpoint_descriptor
* epd
;
1841 int i
, out_eps
= 0, in_eps
= 0;
1843 if (USB_ID_VENDOR(umidi
->usb_id
) == 0x0582)
1844 snd_usbmidi_switch_roland_altsetting(umidi
);
1846 if (endpoint
[0].out_ep
|| endpoint
[0].in_ep
)
1849 intf
= umidi
->iface
;
1850 if (!intf
|| intf
->num_altsetting
< 1)
1852 hostif
= intf
->cur_altsetting
;
1853 intfd
= get_iface_desc(hostif
);
1855 for (i
= 0; i
< intfd
->bNumEndpoints
; ++i
) {
1856 epd
= get_endpoint(hostif
, i
);
1857 if (!usb_endpoint_xfer_bulk(epd
) &&
1858 !usb_endpoint_xfer_int(epd
))
1860 if (out_eps
< max_endpoints
&&
1861 usb_endpoint_dir_out(epd
)) {
1862 endpoint
[out_eps
].out_ep
= usb_endpoint_num(epd
);
1863 if (usb_endpoint_xfer_int(epd
))
1864 endpoint
[out_eps
].out_interval
= epd
->bInterval
;
1867 if (in_eps
< max_endpoints
&&
1868 usb_endpoint_dir_in(epd
)) {
1869 endpoint
[in_eps
].in_ep
= usb_endpoint_num(epd
);
1870 if (usb_endpoint_xfer_int(epd
))
1871 endpoint
[in_eps
].in_interval
= epd
->bInterval
;
1875 return (out_eps
|| in_eps
) ? 0 : -ENOENT
;
1879 * Detects the endpoints for one-port-per-endpoint protocols.
1881 static int snd_usbmidi_detect_per_port_endpoints(struct snd_usb_midi
* umidi
,
1882 struct snd_usb_midi_endpoint_info
* endpoints
)
1886 err
= snd_usbmidi_detect_endpoints(umidi
, endpoints
, MIDI_MAX_ENDPOINTS
);
1887 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
1888 if (endpoints
[i
].out_ep
)
1889 endpoints
[i
].out_cables
= 0x0001;
1890 if (endpoints
[i
].in_ep
)
1891 endpoints
[i
].in_cables
= 0x0001;
1897 * Detects the endpoints and ports of Yamaha devices.
1899 static int snd_usbmidi_detect_yamaha(struct snd_usb_midi
* umidi
,
1900 struct snd_usb_midi_endpoint_info
* endpoint
)
1902 struct usb_interface
* intf
;
1903 struct usb_host_interface
*hostif
;
1904 struct usb_interface_descriptor
* intfd
;
1907 intf
= umidi
->iface
;
1910 hostif
= intf
->altsetting
;
1911 intfd
= get_iface_desc(hostif
);
1912 if (intfd
->bNumEndpoints
< 1)
1916 * For each port there is one MIDI_IN/OUT_JACK descriptor, not
1917 * necessarily with any useful contents. So simply count 'em.
1919 for (cs_desc
= hostif
->extra
;
1920 cs_desc
< hostif
->extra
+ hostif
->extralen
&& cs_desc
[0] >= 2;
1921 cs_desc
+= cs_desc
[0]) {
1922 if (cs_desc
[1] == USB_DT_CS_INTERFACE
) {
1923 if (cs_desc
[2] == UAC_MIDI_IN_JACK
)
1924 endpoint
->in_cables
= (endpoint
->in_cables
<< 1) | 1;
1925 else if (cs_desc
[2] == UAC_MIDI_OUT_JACK
)
1926 endpoint
->out_cables
= (endpoint
->out_cables
<< 1) | 1;
1929 if (!endpoint
->in_cables
&& !endpoint
->out_cables
)
1932 return snd_usbmidi_detect_endpoints(umidi
, endpoint
, 1);
1936 * Creates the endpoints and their ports for Midiman devices.
1938 static int snd_usbmidi_create_endpoints_midiman(struct snd_usb_midi
* umidi
,
1939 struct snd_usb_midi_endpoint_info
* endpoint
)
1941 struct snd_usb_midi_endpoint_info ep_info
;
1942 struct usb_interface
* intf
;
1943 struct usb_host_interface
*hostif
;
1944 struct usb_interface_descriptor
* intfd
;
1945 struct usb_endpoint_descriptor
* epd
;
1948 intf
= umidi
->iface
;
1951 hostif
= intf
->altsetting
;
1952 intfd
= get_iface_desc(hostif
);
1954 * The various MidiSport devices have more or less random endpoint
1955 * numbers, so we have to identify the endpoints by their index in
1956 * the descriptor array, like the driver for that other OS does.
1958 * There is one interrupt input endpoint for all input ports, one
1959 * bulk output endpoint for even-numbered ports, and one for odd-
1960 * numbered ports. Both bulk output endpoints have corresponding
1961 * input bulk endpoints (at indices 1 and 3) which aren't used.
1963 if (intfd
->bNumEndpoints
< (endpoint
->out_cables
> 0x0001 ? 5 : 3)) {
1964 snd_printdd(KERN_ERR
"not enough endpoints\n");
1968 epd
= get_endpoint(hostif
, 0);
1969 if (!usb_endpoint_dir_in(epd
) || !usb_endpoint_xfer_int(epd
)) {
1970 snd_printdd(KERN_ERR
"endpoint[0] isn't interrupt\n");
1973 epd
= get_endpoint(hostif
, 2);
1974 if (!usb_endpoint_dir_out(epd
) || !usb_endpoint_xfer_bulk(epd
)) {
1975 snd_printdd(KERN_ERR
"endpoint[2] isn't bulk output\n");
1978 if (endpoint
->out_cables
> 0x0001) {
1979 epd
= get_endpoint(hostif
, 4);
1980 if (!usb_endpoint_dir_out(epd
) ||
1981 !usb_endpoint_xfer_bulk(epd
)) {
1982 snd_printdd(KERN_ERR
"endpoint[4] isn't bulk output\n");
1987 ep_info
.out_ep
= get_endpoint(hostif
, 2)->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1988 ep_info
.out_interval
= 0;
1989 ep_info
.out_cables
= endpoint
->out_cables
& 0x5555;
1990 err
= snd_usbmidi_out_endpoint_create(umidi
, &ep_info
, &umidi
->endpoints
[0]);
1994 ep_info
.in_ep
= get_endpoint(hostif
, 0)->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
1995 ep_info
.in_interval
= get_endpoint(hostif
, 0)->bInterval
;
1996 ep_info
.in_cables
= endpoint
->in_cables
;
1997 err
= snd_usbmidi_in_endpoint_create(umidi
, &ep_info
, &umidi
->endpoints
[0]);
2001 if (endpoint
->out_cables
> 0x0001) {
2002 ep_info
.out_ep
= get_endpoint(hostif
, 4)->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
;
2003 ep_info
.out_cables
= endpoint
->out_cables
& 0xaaaa;
2004 err
= snd_usbmidi_out_endpoint_create(umidi
, &ep_info
, &umidi
->endpoints
[1]);
2009 for (cable
= 0; cable
< 0x10; ++cable
) {
2010 if (endpoint
->out_cables
& (1 << cable
))
2011 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, cable
,
2012 &umidi
->endpoints
[cable
& 1].out
->ports
[cable
].substream
);
2013 if (endpoint
->in_cables
& (1 << cable
))
2014 snd_usbmidi_init_substream(umidi
, SNDRV_RAWMIDI_STREAM_INPUT
, cable
,
2015 &umidi
->endpoints
[0].in
->ports
[cable
].substream
);
2020 static struct snd_rawmidi_global_ops snd_usbmidi_ops
= {
2021 .get_port_info
= snd_usbmidi_get_port_info
,
2024 static int snd_usbmidi_create_rawmidi(struct snd_usb_midi
* umidi
,
2025 int out_ports
, int in_ports
)
2027 struct snd_rawmidi
*rmidi
;
2030 err
= snd_rawmidi_new(umidi
->card
, "USB MIDI",
2031 umidi
->next_midi_device
++,
2032 out_ports
, in_ports
, &rmidi
);
2035 strcpy(rmidi
->name
, umidi
->card
->shortname
);
2036 rmidi
->info_flags
= SNDRV_RAWMIDI_INFO_OUTPUT
|
2037 SNDRV_RAWMIDI_INFO_INPUT
|
2038 SNDRV_RAWMIDI_INFO_DUPLEX
;
2039 rmidi
->ops
= &snd_usbmidi_ops
;
2040 rmidi
->private_data
= umidi
;
2041 rmidi
->private_free
= snd_usbmidi_rawmidi_free
;
2042 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, &snd_usbmidi_output_ops
);
2043 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_INPUT
, &snd_usbmidi_input_ops
);
2045 umidi
->rmidi
= rmidi
;
2050 * Temporarily stop input.
2052 void snd_usbmidi_input_stop(struct list_head
* p
)
2054 struct snd_usb_midi
* umidi
;
2057 umidi
= list_entry(p
, struct snd_usb_midi
, list
);
2058 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
2059 struct snd_usb_midi_endpoint
* ep
= &umidi
->endpoints
[i
];
2061 for (j
= 0; j
< INPUT_URBS
; ++j
)
2062 usb_kill_urb(ep
->in
->urbs
[j
]);
2066 static void snd_usbmidi_input_start_ep(struct snd_usb_midi_in_endpoint
* ep
)
2072 for (i
= 0; i
< INPUT_URBS
; ++i
) {
2073 struct urb
* urb
= ep
->urbs
[i
];
2074 urb
->dev
= ep
->umidi
->dev
;
2075 snd_usbmidi_submit_urb(urb
, GFP_KERNEL
);
2080 * Resume input after a call to snd_usbmidi_input_stop().
2082 void snd_usbmidi_input_start(struct list_head
* p
)
2084 struct snd_usb_midi
* umidi
;
2087 umidi
= list_entry(p
, struct snd_usb_midi
, list
);
2088 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
)
2089 snd_usbmidi_input_start_ep(umidi
->endpoints
[i
].in
);
2093 * Creates and registers everything needed for a MIDI streaming interface.
2095 int snd_usbmidi_create(struct snd_card
*card
,
2096 struct usb_interface
* iface
,
2097 struct list_head
*midi_list
,
2098 const struct snd_usb_audio_quirk
* quirk
)
2100 struct snd_usb_midi
* umidi
;
2101 struct snd_usb_midi_endpoint_info endpoints
[MIDI_MAX_ENDPOINTS
];
2102 int out_ports
, in_ports
;
2105 umidi
= kzalloc(sizeof(*umidi
), GFP_KERNEL
);
2108 umidi
->dev
= interface_to_usbdev(iface
);
2110 umidi
->iface
= iface
;
2111 umidi
->quirk
= quirk
;
2112 umidi
->usb_protocol_ops
= &snd_usbmidi_standard_ops
;
2113 init_timer(&umidi
->error_timer
);
2114 spin_lock_init(&umidi
->disc_lock
);
2115 mutex_init(&umidi
->mutex
);
2116 umidi
->usb_id
= USB_ID(le16_to_cpu(umidi
->dev
->descriptor
.idVendor
),
2117 le16_to_cpu(umidi
->dev
->descriptor
.idProduct
));
2118 umidi
->error_timer
.function
= snd_usbmidi_error_timer
;
2119 umidi
->error_timer
.data
= (unsigned long)umidi
;
2121 /* detect the endpoint(s) to use */
2122 memset(endpoints
, 0, sizeof(endpoints
));
2123 switch (quirk
? quirk
->type
: QUIRK_MIDI_STANDARD_INTERFACE
) {
2124 case QUIRK_MIDI_STANDARD_INTERFACE
:
2125 err
= snd_usbmidi_get_ms_info(umidi
, endpoints
);
2126 if (umidi
->usb_id
== USB_ID(0x0763, 0x0150)) /* M-Audio Uno */
2127 umidi
->usb_protocol_ops
=
2128 &snd_usbmidi_maudio_broken_running_status_ops
;
2130 case QUIRK_MIDI_US122L
:
2131 umidi
->usb_protocol_ops
= &snd_usbmidi_122l_ops
;
2133 case QUIRK_MIDI_FIXED_ENDPOINT
:
2134 memcpy(&endpoints
[0], quirk
->data
,
2135 sizeof(struct snd_usb_midi_endpoint_info
));
2136 err
= snd_usbmidi_detect_endpoints(umidi
, &endpoints
[0], 1);
2138 case QUIRK_MIDI_YAMAHA
:
2139 err
= snd_usbmidi_detect_yamaha(umidi
, &endpoints
[0]);
2141 case QUIRK_MIDI_MIDIMAN
:
2142 umidi
->usb_protocol_ops
= &snd_usbmidi_midiman_ops
;
2143 memcpy(&endpoints
[0], quirk
->data
,
2144 sizeof(struct snd_usb_midi_endpoint_info
));
2147 case QUIRK_MIDI_NOVATION
:
2148 umidi
->usb_protocol_ops
= &snd_usbmidi_novation_ops
;
2149 err
= snd_usbmidi_detect_per_port_endpoints(umidi
, endpoints
);
2151 case QUIRK_MIDI_RAW_BYTES
:
2152 umidi
->usb_protocol_ops
= &snd_usbmidi_raw_ops
;
2154 * Interface 1 contains isochronous endpoints, but with the same
2155 * numbers as in interface 0. Since it is interface 1 that the
2156 * USB core has most recently seen, these descriptors are now
2157 * associated with the endpoint numbers. This will foul up our
2158 * attempts to submit bulk/interrupt URBs to the endpoints in
2159 * interface 0, so we have to make sure that the USB core looks
2160 * again at interface 0 by calling usb_set_interface() on it.
2162 if (umidi
->usb_id
== USB_ID(0x07fd, 0x0001)) /* MOTU Fastlane */
2163 usb_set_interface(umidi
->dev
, 0, 0);
2164 err
= snd_usbmidi_detect_per_port_endpoints(umidi
, endpoints
);
2166 case QUIRK_MIDI_EMAGIC
:
2167 umidi
->usb_protocol_ops
= &snd_usbmidi_emagic_ops
;
2168 memcpy(&endpoints
[0], quirk
->data
,
2169 sizeof(struct snd_usb_midi_endpoint_info
));
2170 err
= snd_usbmidi_detect_endpoints(umidi
, &endpoints
[0], 1);
2172 case QUIRK_MIDI_CME
:
2173 umidi
->usb_protocol_ops
= &snd_usbmidi_cme_ops
;
2174 err
= snd_usbmidi_detect_per_port_endpoints(umidi
, endpoints
);
2176 case QUIRK_MIDI_AKAI
:
2177 umidi
->usb_protocol_ops
= &snd_usbmidi_akai_ops
;
2178 err
= snd_usbmidi_detect_per_port_endpoints(umidi
, endpoints
);
2179 /* endpoint 1 is input-only */
2180 endpoints
[1].out_cables
= 0;
2182 case QUIRK_MIDI_FTDI
:
2183 umidi
->usb_protocol_ops
= &snd_usbmidi_ftdi_ops
;
2185 /* set baud rate to 31250 (48 MHz / 16 / 96) */
2186 err
= usb_control_msg(umidi
->dev
, usb_sndctrlpipe(umidi
->dev
, 0),
2187 3, 0x40, 0x60, 0, NULL
, 0, 1000);
2191 err
= snd_usbmidi_detect_per_port_endpoints(umidi
, endpoints
);
2194 snd_printd(KERN_ERR
"invalid quirk type %d\n", quirk
->type
);
2203 /* create rawmidi device */
2206 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
) {
2207 out_ports
+= hweight16(endpoints
[i
].out_cables
);
2208 in_ports
+= hweight16(endpoints
[i
].in_cables
);
2210 err
= snd_usbmidi_create_rawmidi(umidi
, out_ports
, in_ports
);
2216 /* create endpoint/port structures */
2217 if (quirk
&& quirk
->type
== QUIRK_MIDI_MIDIMAN
)
2218 err
= snd_usbmidi_create_endpoints_midiman(umidi
, &endpoints
[0]);
2220 err
= snd_usbmidi_create_endpoints(umidi
, endpoints
);
2222 snd_usbmidi_free(umidi
);
2226 list_add_tail(&umidi
->list
, midi_list
);
2228 for (i
= 0; i
< MIDI_MAX_ENDPOINTS
; ++i
)
2229 snd_usbmidi_input_start_ep(umidi
->endpoints
[i
].in
);
2233 EXPORT_SYMBOL(snd_usbmidi_create
);
2234 EXPORT_SYMBOL(snd_usbmidi_input_stop
);
2235 EXPORT_SYMBOL(snd_usbmidi_input_start
);
2236 EXPORT_SYMBOL(snd_usbmidi_disconnect
);