?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
include: convert various register fcns to macros to avoid include chaining
[linux-2.6/next.git] / sound / usb / midi.c
blob7c89a3b5c3da6053f29cac270e0b57787a0dccf5
1 /*
2 * usbmidi.c - ALSA USB MIDI driver
3 *
4 * Copyright (c) 2002-2009 Clemens Ladisch
5 * All rights reserved.
6 *
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
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
19 *
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
23 * version.
24 *
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
35 * SUCH DAMAGE.
36 */
37
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>
50 #include <linux/module.h>
51
52 #include <sound/core.h>
53 #include <sound/control.h>
54 #include <sound/rawmidi.h>
55 #include <sound/asequencer.h>
56 #include "usbaudio.h"
57 #include "midi.h"
58 #include "power.h"
59 #include "helper.h"
60
61 /*
62 * define this to log all USB packets
63 */
64 /* #define DUMP_PACKETS */
65
66 /*
67 * how long to wait after some USB errors, so that khubd can disconnect() us
68 * without too many spurious errors
69 */
70 #define ERROR_DELAY_JIFFIES (HZ / 10)
71
72 #define OUTPUT_URBS 7
73 #define INPUT_URBS 7
74
75
76 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
77 MODULE_DESCRIPTION("USB Audio/MIDI helper module");
78 MODULE_LICENSE("Dual BSD/GPL");
79
80
81 struct usb_ms_header_descriptor {
82 __u8 bLength;
83 __u8 bDescriptorType;
84 __u8 bDescriptorSubtype;
85 __u8 bcdMSC[2];
86 __le16 wTotalLength;
87 } __attribute__ ((packed));
88
89 struct usb_ms_endpoint_descriptor {
90 __u8 bLength;
91 __u8 bDescriptorType;
92 __u8 bDescriptorSubtype;
93 __u8 bNumEmbMIDIJack;
94 __u8 baAssocJackID[0];
95 } __attribute__ ((packed));
96
97 struct snd_usb_midi_in_endpoint;
98 struct snd_usb_midi_out_endpoint;
99 struct snd_usb_midi_endpoint;
100
101 struct usb_protocol_ops {
102 void (*input)(struct snd_usb_midi_in_endpoint*, uint8_t*, int);
103 void (*output)(struct snd_usb_midi_out_endpoint *ep, struct urb *urb);
104 void (*output_packet)(struct urb*, uint8_t, uint8_t, uint8_t, uint8_t);
105 void (*init_out_endpoint)(struct snd_usb_midi_out_endpoint*);
106 void (*finish_out_endpoint)(struct snd_usb_midi_out_endpoint*);
107 };
108
109 struct snd_usb_midi {
110 struct usb_device *dev;
111 struct snd_card *card;
112 struct usb_interface *iface;
113 const struct snd_usb_audio_quirk *quirk;
114 struct snd_rawmidi *rmidi;
115 struct usb_protocol_ops* usb_protocol_ops;
116 struct list_head list;
117 struct timer_list error_timer;
118 spinlock_t disc_lock;
119 struct mutex mutex;
120 u32 usb_id;
121 int next_midi_device;
122
123 struct snd_usb_midi_endpoint {
124 struct snd_usb_midi_out_endpoint *out;
125 struct snd_usb_midi_in_endpoint *in;
126 } endpoints[MIDI_MAX_ENDPOINTS];
127 unsigned long input_triggered;
128 unsigned int opened;
129 unsigned char disconnected;
130
131 struct snd_kcontrol *roland_load_ctl;
132 };
133
134 struct snd_usb_midi_out_endpoint {
135 struct snd_usb_midi* umidi;
136 struct out_urb_context {
137 struct urb *urb;
138 struct snd_usb_midi_out_endpoint *ep;
139 } urbs[OUTPUT_URBS];
140 unsigned int active_urbs;
141 unsigned int drain_urbs;
142 int max_transfer; /* size of urb buffer */
143 struct tasklet_struct tasklet;
144 unsigned int next_urb;
145 spinlock_t buffer_lock;
146
147 struct usbmidi_out_port {
148 struct snd_usb_midi_out_endpoint* ep;
149 struct snd_rawmidi_substream *substream;
150 int active;
151 uint8_t cable; /* cable number << 4 */
152 uint8_t state;
153 #define STATE_UNKNOWN 0
154 #define STATE_1PARAM 1
155 #define STATE_2PARAM_1 2
156 #define STATE_2PARAM_2 3
157 #define STATE_SYSEX_0 4
158 #define STATE_SYSEX_1 5
159 #define STATE_SYSEX_2 6
160 uint8_t data[2];
161 } ports[0x10];
162 int current_port;
163
164 wait_queue_head_t drain_wait;
165 };
166
167 struct snd_usb_midi_in_endpoint {
168 struct snd_usb_midi* umidi;
169 struct urb* urbs[INPUT_URBS];
170 struct usbmidi_in_port {
171 struct snd_rawmidi_substream *substream;
172 u8 running_status_length;
173 } ports[0x10];
174 u8 seen_f5;
175 u8 error_resubmit;
176 int current_port;
177 };
178
179 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint* ep);
180
181 static const uint8_t snd_usbmidi_cin_length[] = {
182 0, 0, 2, 3, 3, 1, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1
183 };
184
185 /*
186 * Submits the URB, with error handling.
187 */
188 static int snd_usbmidi_submit_urb(struct urb* urb, gfp_t flags)
189 {
190 int err = usb_submit_urb(urb, flags);
191 if (err < 0 && err != -ENODEV)
192 snd_printk(KERN_ERR "usb_submit_urb: %d\n", err);
193 return err;
194 }
195
196 /*
197 * Error handling for URB completion functions.
198 */
199 static int snd_usbmidi_urb_error(int status)
200 {
201 switch (status) {
202 /* manually unlinked, or device gone */
203 case -ENOENT:
204 case -ECONNRESET:
205 case -ESHUTDOWN:
206 case -ENODEV:
207 return -ENODEV;
208 /* errors that might occur during unplugging */
209 case -EPROTO:
210 case -ETIME:
211 case -EILSEQ:
212 return -EIO;
213 default:
214 snd_printk(KERN_ERR "urb status %d\n", status);
215 return 0; /* continue */
216 }
217 }
218
219 /*
220 * Receives a chunk of MIDI data.
221 */
222 static void snd_usbmidi_input_data(struct snd_usb_midi_in_endpoint* ep, int portidx,
223 uint8_t* data, int length)
224 {
225 struct usbmidi_in_port* port = &ep->ports[portidx];
226
227 if (!port->substream) {
228 snd_printd("unexpected port %d!\n", portidx);
229 return;
230 }
231 if (!test_bit(port->substream->number, &ep->umidi->input_triggered))
232 return;
233 snd_rawmidi_receive(port->substream, data, length);
234 }
235
236 #ifdef DUMP_PACKETS
237 static void dump_urb(const char *type, const u8 *data, int length)
238 {
239 snd_printk(KERN_DEBUG "%s packet: [", type);
240 for (; length > 0; ++data, --length)
241 printk(" %02x", *data);
242 printk(" ]\n");
243 }
244 #else
245 #define dump_urb(type, data, length) /* nothing */
246 #endif
247
248 /*
249 * Processes the data read from the device.
250 */
251 static void snd_usbmidi_in_urb_complete(struct urb* urb)
252 {
253 struct snd_usb_midi_in_endpoint* ep = urb->context;
254
255 if (urb->status == 0) {
256 dump_urb("received", urb->transfer_buffer, urb->actual_length);
257 ep->umidi->usb_protocol_ops->input(ep, urb->transfer_buffer,
258 urb->actual_length);
259 } else {
260 int err = snd_usbmidi_urb_error(urb->status);
261 if (err < 0) {
262 if (err != -ENODEV) {
263 ep->error_resubmit = 1;
264 mod_timer(&ep->umidi->error_timer,
265 jiffies + ERROR_DELAY_JIFFIES);
266 }
267 return;
268 }
269 }
270
271 urb->dev = ep->umidi->dev;
272 snd_usbmidi_submit_urb(urb, GFP_ATOMIC);
273 }
274
275 static void snd_usbmidi_out_urb_complete(struct urb* urb)
276 {
277 struct out_urb_context *context = urb->context;
278 struct snd_usb_midi_out_endpoint* ep = context->ep;
279 unsigned int urb_index;
280
281 spin_lock(&ep->buffer_lock);
282 urb_index = context - ep->urbs;
283 ep->active_urbs &= ~(1 << urb_index);
284 if (unlikely(ep->drain_urbs)) {
285 ep->drain_urbs &= ~(1 << urb_index);
286 wake_up(&ep->drain_wait);
287 }
288 spin_unlock(&ep->buffer_lock);
289 if (urb->status < 0) {
290 int err = snd_usbmidi_urb_error(urb->status);
291 if (err < 0) {
292 if (err != -ENODEV)
293 mod_timer(&ep->umidi->error_timer,
294 jiffies + ERROR_DELAY_JIFFIES);
295 return;
296 }
297 }
298 snd_usbmidi_do_output(ep);
299 }
300
301 /*
302 * This is called when some data should be transferred to the device
303 * (from one or more substreams).
304 */
305 static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint* ep)
306 {
307 unsigned int urb_index;
308 struct urb* urb;
309 unsigned long flags;
310
311 spin_lock_irqsave(&ep->buffer_lock, flags);
312 if (ep->umidi->disconnected) {
313 spin_unlock_irqrestore(&ep->buffer_lock, flags);
314 return;
315 }
316
317 urb_index = ep->next_urb;
318 for (;;) {
319 if (!(ep->active_urbs & (1 << urb_index))) {
320 urb = ep->urbs[urb_index].urb;
321 urb->transfer_buffer_length = 0;
322 ep->umidi->usb_protocol_ops->output(ep, urb);
323 if (urb->transfer_buffer_length == 0)
324 break;
325
326 dump_urb("sending", urb->transfer_buffer,
327 urb->transfer_buffer_length);
328 urb->dev = ep->umidi->dev;
329 if (snd_usbmidi_submit_urb(urb, GFP_ATOMIC) < 0)
330 break;
331 ep->active_urbs |= 1 << urb_index;
332 }
333 if (++urb_index >= OUTPUT_URBS)
334 urb_index = 0;
335 if (urb_index == ep->next_urb)
336 break;
337 }
338 ep->next_urb = urb_index;
339 spin_unlock_irqrestore(&ep->buffer_lock, flags);
340 }
341
342 static void snd_usbmidi_out_tasklet(unsigned long data)
343 {
344 struct snd_usb_midi_out_endpoint* ep = (struct snd_usb_midi_out_endpoint *) data;
345
346 snd_usbmidi_do_output(ep);
347 }
348
349 /* called after transfers had been interrupted due to some USB error */
350 static void snd_usbmidi_error_timer(unsigned long data)
351 {
352 struct snd_usb_midi *umidi = (struct snd_usb_midi *)data;
353 unsigned int i, j;
354
355 spin_lock(&umidi->disc_lock);
356 if (umidi->disconnected) {
357 spin_unlock(&umidi->disc_lock);
358 return;
359 }
360 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
361 struct snd_usb_midi_in_endpoint *in = umidi->endpoints[i].in;
362 if (in && in->error_resubmit) {
363 in->error_resubmit = 0;
364 for (j = 0; j < INPUT_URBS; ++j) {
365 in->urbs[j]->dev = umidi->dev;
366 snd_usbmidi_submit_urb(in->urbs[j], GFP_ATOMIC);
367 }
368 }
369 if (umidi->endpoints[i].out)
370 snd_usbmidi_do_output(umidi->endpoints[i].out);
371 }
372 spin_unlock(&umidi->disc_lock);
373 }
374
375 /* helper function to send static data that may not DMA-able */
376 static int send_bulk_static_data(struct snd_usb_midi_out_endpoint* ep,
377 const void *data, int len)
378 {
379 int err = 0;
380 void *buf = kmemdup(data, len, GFP_KERNEL);
381 if (!buf)
382 return -ENOMEM;
383 dump_urb("sending", buf, len);
384 if (ep->urbs[0].urb)
385 err = usb_bulk_msg(ep->umidi->dev, ep->urbs[0].urb->pipe,
386 buf, len, NULL, 250);
387 kfree(buf);
388 return err;
389 }
390
391 /*
392 * Standard USB MIDI protocol: see the spec.
393 * Midiman protocol: like the standard protocol, but the control byte is the
394 * fourth byte in each packet, and uses length instead of CIN.
395 */
396
397 static void snd_usbmidi_standard_input(struct snd_usb_midi_in_endpoint* ep,
398 uint8_t* buffer, int buffer_length)
399 {
400 int i;
401
402 for (i = 0; i + 3 < buffer_length; i += 4)
403 if (buffer[i] != 0) {
404 int cable = buffer[i] >> 4;
405 int length = snd_usbmidi_cin_length[buffer[i] & 0x0f];
406 snd_usbmidi_input_data(ep, cable, &buffer[i + 1], length);
407 }
408 }
409
410 static void snd_usbmidi_midiman_input(struct snd_usb_midi_in_endpoint* ep,
411 uint8_t* buffer, int buffer_length)
412 {
413 int i;
414
415 for (i = 0; i + 3 < buffer_length; i += 4)
416 if (buffer[i + 3] != 0) {
417 int port = buffer[i + 3] >> 4;
418 int length = buffer[i + 3] & 3;
419 snd_usbmidi_input_data(ep, port, &buffer[i], length);
420 }
421 }
422
423 /*
424 * Buggy M-Audio device: running status on input results in a packet that has
425 * the data bytes but not the status byte and that is marked with CIN 4.
426 */
427 static void snd_usbmidi_maudio_broken_running_status_input(
428 struct snd_usb_midi_in_endpoint* ep,
429 uint8_t* buffer, int buffer_length)
430 {
431 int i;
432
433 for (i = 0; i + 3 < buffer_length; i += 4)
434 if (buffer[i] != 0) {
435 int cable = buffer[i] >> 4;
436 u8 cin = buffer[i] & 0x0f;
437 struct usbmidi_in_port *port = &ep->ports[cable];
438 int length;
439
440 length = snd_usbmidi_cin_length[cin];
441 if (cin == 0xf && buffer[i + 1] >= 0xf8)
442 ; /* realtime msg: no running status change */
443 else if (cin >= 0x8 && cin <= 0xe)
444 /* channel msg */
445 port->running_status_length = length - 1;
446 else if (cin == 0x4 &&
447 port->running_status_length != 0 &&
448 buffer[i + 1] < 0x80)
449 /* CIN 4 that is not a SysEx */
450 length = port->running_status_length;
451 else
452 /*
453 * All other msgs cannot begin running status.
454 * (A channel msg sent as two or three CIN 0xF
455 * packets could in theory, but this device
456 * doesn't use this format.)
457 */
458 port->running_status_length = 0;
459 snd_usbmidi_input_data(ep, cable, &buffer[i + 1], length);
460 }
461 }
462
463 /*
464 * CME protocol: like the standard protocol, but SysEx commands are sent as a
465 * single USB packet preceded by a 0x0F byte.
466 */
467 static void snd_usbmidi_cme_input(struct snd_usb_midi_in_endpoint *ep,
468 uint8_t *buffer, int buffer_length)
469 {
470 if (buffer_length < 2 || (buffer[0] & 0x0f) != 0x0f)
471 snd_usbmidi_standard_input(ep, buffer, buffer_length);
472 else
473 snd_usbmidi_input_data(ep, buffer[0] >> 4,
474 &buffer[1], buffer_length - 1);
475 }
476
477 /*
478 * Adds one USB MIDI packet to the output buffer.
479 */
480 static void snd_usbmidi_output_standard_packet(struct urb* urb, uint8_t p0,
481 uint8_t p1, uint8_t p2, uint8_t p3)
482 {
483
484 uint8_t* buf = (uint8_t*)urb->transfer_buffer + urb->transfer_buffer_length;
485 buf[0] = p0;
486 buf[1] = p1;
487 buf[2] = p2;
488 buf[3] = p3;
489 urb->transfer_buffer_length += 4;
490 }
491
492 /*
493 * Adds one Midiman packet to the output buffer.
494 */
495 static void snd_usbmidi_output_midiman_packet(struct urb* urb, uint8_t p0,
496 uint8_t p1, uint8_t p2, uint8_t p3)
497 {
498
499 uint8_t* buf = (uint8_t*)urb->transfer_buffer + urb->transfer_buffer_length;
500 buf[0] = p1;
501 buf[1] = p2;
502 buf[2] = p3;
503 buf[3] = (p0 & 0xf0) | snd_usbmidi_cin_length[p0 & 0x0f];
504 urb->transfer_buffer_length += 4;
505 }
506
507 /*
508 * Converts MIDI commands to USB MIDI packets.
509 */
510 static void snd_usbmidi_transmit_byte(struct usbmidi_out_port* port,
511 uint8_t b, struct urb* urb)
512 {
513 uint8_t p0 = port->cable;
514 void (*output_packet)(struct urb*, uint8_t, uint8_t, uint8_t, uint8_t) =
515 port->ep->umidi->usb_protocol_ops->output_packet;
516
517 if (b >= 0xf8) {
518 output_packet(urb, p0 | 0x0f, b, 0, 0);
519 } else if (b >= 0xf0) {
520 switch (b) {
521 case 0xf0:
522 port->data[0] = b;
523 port->state = STATE_SYSEX_1;
524 break;
525 case 0xf1:
526 case 0xf3:
527 port->data[0] = b;
528 port->state = STATE_1PARAM;
529 break;
530 case 0xf2:
531 port->data[0] = b;
532 port->state = STATE_2PARAM_1;
533 break;
534 case 0xf4:
535 case 0xf5:
536 port->state = STATE_UNKNOWN;
537 break;
538 case 0xf6:
539 output_packet(urb, p0 | 0x05, 0xf6, 0, 0);
540 port->state = STATE_UNKNOWN;
541 break;
542 case 0xf7:
543 switch (port->state) {
544 case STATE_SYSEX_0:
545 output_packet(urb, p0 | 0x05, 0xf7, 0, 0);
546 break;
547 case STATE_SYSEX_1:
548 output_packet(urb, p0 | 0x06, port->data[0], 0xf7, 0);
549 break;
550 case STATE_SYSEX_2:
551 output_packet(urb, p0 | 0x07, port->data[0], port->data[1], 0xf7);
552 break;
553 }
554 port->state = STATE_UNKNOWN;
555 break;
556 }
557 } else if (b >= 0x80) {
558 port->data[0] = b;
559 if (b >= 0xc0 && b <= 0xdf)
560 port->state = STATE_1PARAM;
561 else
562 port->state = STATE_2PARAM_1;
563 } else { /* b < 0x80 */
564 switch (port->state) {
565 case STATE_1PARAM:
566 if (port->data[0] < 0xf0) {
567 p0 |= port->data[0] >> 4;
568 } else {
569 p0 |= 0x02;
570 port->state = STATE_UNKNOWN;
571 }
572 output_packet(urb, p0, port->data[0], b, 0);
573 break;
574 case STATE_2PARAM_1:
575 port->data[1] = b;
576 port->state = STATE_2PARAM_2;
577 break;
578 case STATE_2PARAM_2:
579 if (port->data[0] < 0xf0) {
580 p0 |= port->data[0] >> 4;
581 port->state = STATE_2PARAM_1;
582 } else {
583 p0 |= 0x03;
584 port->state = STATE_UNKNOWN;
585 }
586 output_packet(urb, p0, port->data[0], port->data[1], b);
587 break;
588 case STATE_SYSEX_0:
589 port->data[0] = b;
590 port->state = STATE_SYSEX_1;
591 break;
592 case STATE_SYSEX_1:
593 port->data[1] = b;
594 port->state = STATE_SYSEX_2;
595 break;
596 case STATE_SYSEX_2:
597 output_packet(urb, p0 | 0x04, port->data[0], port->data[1], b);
598 port->state = STATE_SYSEX_0;
599 break;
600 }
601 }
602 }
603
604 static void snd_usbmidi_standard_output(struct snd_usb_midi_out_endpoint* ep,
605 struct urb *urb)
606 {
607 int p;
608
609 /* FIXME: lower-numbered ports can starve higher-numbered ports */
610 for (p = 0; p < 0x10; ++p) {
611 struct usbmidi_out_port* port = &ep->ports[p];
612 if (!port->active)
613 continue;
614 while (urb->transfer_buffer_length + 3 < ep->max_transfer) {
615 uint8_t b;
616 if (snd_rawmidi_transmit(port->substream, &b, 1) != 1) {
617 port->active = 0;
618 break;
619 }
620 snd_usbmidi_transmit_byte(port, b, urb);
621 }
622 }
623 }
624
625 static struct usb_protocol_ops snd_usbmidi_standard_ops = {
626 .input = snd_usbmidi_standard_input,
627 .output = snd_usbmidi_standard_output,
628 .output_packet = snd_usbmidi_output_standard_packet,
629 };
630
631 static struct usb_protocol_ops snd_usbmidi_midiman_ops = {
632 .input = snd_usbmidi_midiman_input,
633 .output = snd_usbmidi_standard_output,
634 .output_packet = snd_usbmidi_output_midiman_packet,
635 };
636
637 static struct usb_protocol_ops snd_usbmidi_maudio_broken_running_status_ops = {
638 .input = snd_usbmidi_maudio_broken_running_status_input,
639 .output = snd_usbmidi_standard_output,
640 .output_packet = snd_usbmidi_output_standard_packet,
641 };
642
643 static struct usb_protocol_ops snd_usbmidi_cme_ops = {
644 .input = snd_usbmidi_cme_input,
645 .output = snd_usbmidi_standard_output,
646 .output_packet = snd_usbmidi_output_standard_packet,
647 };
648
649 /*
650 * AKAI MPD16 protocol:
651 *
652 * For control port (endpoint 1):
653 * ==============================
654 * One or more chunks consisting of first byte of (0x10 | msg_len) and then a
655 * SysEx message (msg_len=9 bytes long).
656 *
657 * For data port (endpoint 2):
658 * ===========================
659 * One or more chunks consisting of first byte of (0x20 | msg_len) and then a
660 * MIDI message (msg_len bytes long)
661 *
662 * Messages sent: Active Sense, Note On, Poly Pressure, Control Change.
663 */
664 static void snd_usbmidi_akai_input(struct snd_usb_midi_in_endpoint *ep,
665 uint8_t *buffer, int buffer_length)
666 {
667 unsigned int pos = 0;
668 unsigned int len = (unsigned int)buffer_length;
669 while (pos < len) {
670 unsigned int port = (buffer[pos] >> 4) - 1;
671 unsigned int msg_len = buffer[pos] & 0x0f;
672 pos++;
673 if (pos + msg_len <= len && port < 2)
674 snd_usbmidi_input_data(ep, 0, &buffer[pos], msg_len);
675 pos += msg_len;
676 }
677 }
678
679 #define MAX_AKAI_SYSEX_LEN 9
680
681 static void snd_usbmidi_akai_output(struct snd_usb_midi_out_endpoint *ep,
682 struct urb *urb)
683 {
684 uint8_t *msg;
685 int pos, end, count, buf_end;
686 uint8_t tmp[MAX_AKAI_SYSEX_LEN];
687 struct snd_rawmidi_substream *substream = ep->ports[0].substream;
688
689 if (!ep->ports[0].active)
690 return;
691
692 msg = urb->transfer_buffer + urb->transfer_buffer_length;
693 buf_end = ep->max_transfer - MAX_AKAI_SYSEX_LEN - 1;
694
695 /* only try adding more data when there's space for at least 1 SysEx */
696 while (urb->transfer_buffer_length < buf_end) {
697 count = snd_rawmidi_transmit_peek(substream,
698 tmp, MAX_AKAI_SYSEX_LEN);
699 if (!count) {
700 ep->ports[0].active = 0;
701 return;
702 }
703 /* try to skip non-SysEx data */
704 for (pos = 0; pos < count && tmp[pos] != 0xF0; pos++)
705 ;
706
707 if (pos > 0) {
708 snd_rawmidi_transmit_ack(substream, pos);
709 continue;
710 }
711
712 /* look for the start or end marker */
713 for (end = 1; end < count && tmp[end] < 0xF0; end++)
714 ;
715
716 /* next SysEx started before the end of current one */
717 if (end < count && tmp[end] == 0xF0) {
718 /* it's incomplete - drop it */
719 snd_rawmidi_transmit_ack(substream, end);
720 continue;
721 }
722 /* SysEx complete */
723 if (end < count && tmp[end] == 0xF7) {
724 /* queue it, ack it, and get the next one */
725 count = end + 1;
726 msg[0] = 0x10 | count;
727 memcpy(&msg[1], tmp, count);
728 snd_rawmidi_transmit_ack(substream, count);
729 urb->transfer_buffer_length += count + 1;
730 msg += count + 1;
731 continue;
732 }
733 /* less than 9 bytes and no end byte - wait for more */
734 if (count < MAX_AKAI_SYSEX_LEN) {
735 ep->ports[0].active = 0;
736 return;
737 }
738 /* 9 bytes and no end marker in sight - malformed, skip it */
739 snd_rawmidi_transmit_ack(substream, count);
740 }
741 }
742
743 static struct usb_protocol_ops snd_usbmidi_akai_ops = {
744 .input = snd_usbmidi_akai_input,
745 .output = snd_usbmidi_akai_output,
746 };
747
748 /*
749 * Novation USB MIDI protocol: number of data bytes is in the first byte
750 * (when receiving) (+1!) or in the second byte (when sending); data begins
751 * at the third byte.
752 */
753
754 static void snd_usbmidi_novation_input(struct snd_usb_midi_in_endpoint* ep,
755 uint8_t* buffer, int buffer_length)
756 {
757 if (buffer_length < 2 || !buffer[0] || buffer_length < buffer[0] + 1)
758 return;
759 snd_usbmidi_input_data(ep, 0, &buffer[2], buffer[0] - 1);
760 }
761
762 static void snd_usbmidi_novation_output(struct snd_usb_midi_out_endpoint* ep,
763 struct urb *urb)
764 {
765 uint8_t* transfer_buffer;
766 int count;
767
768 if (!ep->ports[0].active)
769 return;
770 transfer_buffer = urb->transfer_buffer;
771 count = snd_rawmidi_transmit(ep->ports[0].substream,
772 &transfer_buffer[2],
773 ep->max_transfer - 2);
774 if (count < 1) {
775 ep->ports[0].active = 0;
776 return;
777 }
778 transfer_buffer[0] = 0;
779 transfer_buffer[1] = count;
780 urb->transfer_buffer_length = 2 + count;
781 }
782
783 static struct usb_protocol_ops snd_usbmidi_novation_ops = {
784 .input = snd_usbmidi_novation_input,
785 .output = snd_usbmidi_novation_output,
786 };
787
788 /*
789 * "raw" protocol: just move raw MIDI bytes from/to the endpoint
790 */
791
792 static void snd_usbmidi_raw_input(struct snd_usb_midi_in_endpoint* ep,
793 uint8_t* buffer, int buffer_length)
794 {
795 snd_usbmidi_input_data(ep, 0, buffer, buffer_length);
796 }
797
798 static void snd_usbmidi_raw_output(struct snd_usb_midi_out_endpoint* ep,
799 struct urb *urb)
800 {
801 int count;
802
803 if (!ep->ports[0].active)
804 return;
805 count = snd_rawmidi_transmit(ep->ports[0].substream,
806 urb->transfer_buffer,
807 ep->max_transfer);
808 if (count < 1) {
809 ep->ports[0].active = 0;
810 return;
811 }
812 urb->transfer_buffer_length = count;
813 }
814
815 static struct usb_protocol_ops snd_usbmidi_raw_ops = {
816 .input = snd_usbmidi_raw_input,
817 .output = snd_usbmidi_raw_output,
818 };
819
820 static void snd_usbmidi_us122l_input(struct snd_usb_midi_in_endpoint *ep,
821 uint8_t *buffer, int buffer_length)
822 {
823 if (buffer_length != 9)
824 return;
825 buffer_length = 8;
826 while (buffer_length && buffer[buffer_length - 1] == 0xFD)
827 buffer_length--;
828 if (buffer_length)
829 snd_usbmidi_input_data(ep, 0, buffer, buffer_length);
830 }
831
832 static void snd_usbmidi_us122l_output(struct snd_usb_midi_out_endpoint *ep,
833 struct urb *urb)
834 {
835 int count;
836
837 if (!ep->ports[0].active)
838 return;
839 switch (snd_usb_get_speed(ep->umidi->dev)) {
840 case USB_SPEED_HIGH:
841 case USB_SPEED_SUPER:
842 count = 1;
843 break;
844 default:
845 count = 2;
846 }
847 count = snd_rawmidi_transmit(ep->ports[0].substream,
848 urb->transfer_buffer,
849 count);
850 if (count < 1) {
851 ep->ports[0].active = 0;
852 return;
853 }
854
855 memset(urb->transfer_buffer + count, 0xFD, ep->max_transfer - count);
856 urb->transfer_buffer_length = ep->max_transfer;
857 }
858
859 static struct usb_protocol_ops snd_usbmidi_122l_ops = {
860 .input = snd_usbmidi_us122l_input,
861 .output = snd_usbmidi_us122l_output,
862 };
863
864 /*
865 * Emagic USB MIDI protocol: raw MIDI with "F5 xx" port switching.
866 */
867
868 static void snd_usbmidi_emagic_init_out(struct snd_usb_midi_out_endpoint* ep)
869 {
870 static const u8 init_data[] = {
871 /* initialization magic: "get version" */
872 0xf0,
873 0x00, 0x20, 0x31, /* Emagic */
874 0x64, /* Unitor8 */
875 0x0b, /* version number request */
876 0x00, /* command version */
877 0x00, /* EEPROM, box 0 */
878 0xf7
879 };
880 send_bulk_static_data(ep, init_data, sizeof(init_data));
881 /* while we're at it, pour on more magic */
882 send_bulk_static_data(ep, init_data, sizeof(init_data));
883 }
884
885 static void snd_usbmidi_emagic_finish_out(struct snd_usb_midi_out_endpoint* ep)
886 {
887 static const u8 finish_data[] = {
888 /* switch to patch mode with last preset */
889 0xf0,
890 0x00, 0x20, 0x31, /* Emagic */
891 0x64, /* Unitor8 */
892 0x10, /* patch switch command */
893 0x00, /* command version */
894 0x7f, /* to all boxes */
895 0x40, /* last preset in EEPROM */
896 0xf7
897 };
898 send_bulk_static_data(ep, finish_data, sizeof(finish_data));
899 }
900
901 static void snd_usbmidi_emagic_input(struct snd_usb_midi_in_endpoint* ep,
902 uint8_t* buffer, int buffer_length)
903 {
904 int i;
905
906 /* FF indicates end of valid data */
907 for (i = 0; i < buffer_length; ++i)
908 if (buffer[i] == 0xff) {
909 buffer_length = i;
910 break;
911 }
912
913 /* handle F5 at end of last buffer */
914 if (ep->seen_f5)
915 goto switch_port;
916
917 while (buffer_length > 0) {
918 /* determine size of data until next F5 */
919 for (i = 0; i < buffer_length; ++i)
920 if (buffer[i] == 0xf5)
921 break;
922 snd_usbmidi_input_data(ep, ep->current_port, buffer, i);
923 buffer += i;
924 buffer_length -= i;
925
926 if (buffer_length <= 0)
927 break;
928 /* assert(buffer[0] == 0xf5); */
929 ep->seen_f5 = 1;
930 ++buffer;
931 --buffer_length;
932
933 switch_port:
934 if (buffer_length <= 0)
935 break;
936 if (buffer[0] < 0x80) {
937 ep->current_port = (buffer[0] - 1) & 15;
938 ++buffer;
939 --buffer_length;
940 }
941 ep->seen_f5 = 0;
942 }
943 }
944
945 static void snd_usbmidi_emagic_output(struct snd_usb_midi_out_endpoint* ep,
946 struct urb *urb)
947 {
948 int port0 = ep->current_port;
949 uint8_t* buf = urb->transfer_buffer;
950 int buf_free = ep->max_transfer;
951 int length, i;
952
953 for (i = 0; i < 0x10; ++i) {
954 /* round-robin, starting at the last current port */
955 int portnum = (port0 + i) & 15;
956 struct usbmidi_out_port* port = &ep->ports[portnum];
957
958 if (!port->active)
959 continue;
960 if (snd_rawmidi_transmit_peek(port->substream, buf, 1) != 1) {
961 port->active = 0;
962 continue;
963 }
964
965 if (portnum != ep->current_port) {
966 if (buf_free < 2)
967 break;
968 ep->current_port = portnum;
969 buf[0] = 0xf5;
970 buf[1] = (portnum + 1) & 15;
971 buf += 2;
972 buf_free -= 2;
973 }
974
975 if (buf_free < 1)
976 break;
977 length = snd_rawmidi_transmit(port->substream, buf, buf_free);
978 if (length > 0) {
979 buf += length;
980 buf_free -= length;
981 if (buf_free < 1)
982 break;
983 }
984 }
985 if (buf_free < ep->max_transfer && buf_free > 0) {
986 *buf = 0xff;
987 --buf_free;
988 }
989 urb->transfer_buffer_length = ep->max_transfer - buf_free;
990 }
991
992 static struct usb_protocol_ops snd_usbmidi_emagic_ops = {
993 .input = snd_usbmidi_emagic_input,
994 .output = snd_usbmidi_emagic_output,
995 .init_out_endpoint = snd_usbmidi_emagic_init_out,
996 .finish_out_endpoint = snd_usbmidi_emagic_finish_out,
997 };
998
999
1000 static void update_roland_altsetting(struct snd_usb_midi* umidi)
1001 {
1002 struct usb_interface *intf;
1003 struct usb_host_interface *hostif;
1004 struct usb_interface_descriptor *intfd;
1005 int is_light_load;
1006
1007 intf = umidi->iface;
1008 is_light_load = intf->cur_altsetting != intf->altsetting;
1009 if (umidi->roland_load_ctl->private_value == is_light_load)
1010 return;
1011 hostif = &intf->altsetting[umidi->roland_load_ctl->private_value];
1012 intfd = get_iface_desc(hostif);
1013 snd_usbmidi_input_stop(&umidi->list);
1014 usb_set_interface(umidi->dev, intfd->bInterfaceNumber,
1015 intfd->bAlternateSetting);
1016 snd_usbmidi_input_start(&umidi->list);
1017 }
1018
1019 static void substream_open(struct snd_rawmidi_substream *substream, int open)
1020 {
1021 struct snd_usb_midi* umidi = substream->rmidi->private_data;
1022 struct snd_kcontrol *ctl;
1023
1024 mutex_lock(&umidi->mutex);
1025 if (open) {
1026 if (umidi->opened++ == 0 && umidi->roland_load_ctl) {
1027 ctl = umidi->roland_load_ctl;
1028 ctl->vd[0].access |= SNDRV_CTL_ELEM_ACCESS_INACTIVE;
1029 snd_ctl_notify(umidi->card,
1030 SNDRV_CTL_EVENT_MASK_INFO, &ctl->id);
1031 update_roland_altsetting(umidi);
1032 }
1033 } else {
1034 if (--umidi->opened == 0 && umidi->roland_load_ctl) {
1035 ctl = umidi->roland_load_ctl;
1036 ctl->vd[0].access &= ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
1037 snd_ctl_notify(umidi->card,
1038 SNDRV_CTL_EVENT_MASK_INFO, &ctl->id);
1039 }
1040 }
1041 mutex_unlock(&umidi->mutex);
1042 }
1043
1044 static int snd_usbmidi_output_open(struct snd_rawmidi_substream *substream)
1045 {
1046 struct snd_usb_midi* umidi = substream->rmidi->private_data;
1047 struct usbmidi_out_port* port = NULL;
1048 int i, j;
1049 int err;
1050
1051 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
1052 if (umidi->endpoints[i].out)
1053 for (j = 0; j < 0x10; ++j)
1054 if (umidi->endpoints[i].out->ports[j].substream == substream) {
1055 port = &umidi->endpoints[i].out->ports[j];
1056 break;
1057 }
1058 if (!port) {
1059 snd_BUG();
1060 return -ENXIO;
1061 }
1062 err = usb_autopm_get_interface(umidi->iface);
1063 if (err < 0)
1064 return -EIO;
1065 substream->runtime->private_data = port;
1066 port->state = STATE_UNKNOWN;
1067 substream_open(substream, 1);
1068 return 0;
1069 }
1070
1071 static int snd_usbmidi_output_close(struct snd_rawmidi_substream *substream)
1072 {
1073 struct snd_usb_midi* umidi = substream->rmidi->private_data;
1074
1075 substream_open(substream, 0);
1076 usb_autopm_put_interface(umidi->iface);
1077 return 0;
1078 }
1079
1080 static void snd_usbmidi_output_trigger(struct snd_rawmidi_substream *substream, int up)
1081 {
1082 struct usbmidi_out_port* port = (struct usbmidi_out_port*)substream->runtime->private_data;
1083
1084 port->active = up;
1085 if (up) {
1086 if (port->ep->umidi->disconnected) {
1087 /* gobble up remaining bytes to prevent wait in
1088 * snd_rawmidi_drain_output */
1089 while (!snd_rawmidi_transmit_empty(substream))
1090 snd_rawmidi_transmit_ack(substream, 1);
1091 return;
1092 }
1093 tasklet_schedule(&port->ep->tasklet);
1094 }
1095 }
1096
1097 static void snd_usbmidi_output_drain(struct snd_rawmidi_substream *substream)
1098 {
1099 struct usbmidi_out_port* port = substream->runtime->private_data;
1100 struct snd_usb_midi_out_endpoint *ep = port->ep;
1101 unsigned int drain_urbs;
1102 DEFINE_WAIT(wait);
1103 long timeout = msecs_to_jiffies(50);
1104
1105 if (ep->umidi->disconnected)
1106 return;
1107 /*
1108 * The substream buffer is empty, but some data might still be in the
1109 * currently active URBs, so we have to wait for those to complete.
1110 */
1111 spin_lock_irq(&ep->buffer_lock);
1112 drain_urbs = ep->active_urbs;
1113 if (drain_urbs) {
1114 ep->drain_urbs |= drain_urbs;
1115 do {
1116 prepare_to_wait(&ep->drain_wait, &wait,
1117 TASK_UNINTERRUPTIBLE);
1118 spin_unlock_irq(&ep->buffer_lock);
1119 timeout = schedule_timeout(timeout);
1120 spin_lock_irq(&ep->buffer_lock);
1121 drain_urbs &= ep->drain_urbs;
1122 } while (drain_urbs && timeout);
1123 finish_wait(&ep->drain_wait, &wait);
1124 }
1125 spin_unlock_irq(&ep->buffer_lock);
1126 }
1127
1128 static int snd_usbmidi_input_open(struct snd_rawmidi_substream *substream)
1129 {
1130 substream_open(substream, 1);
1131 return 0;
1132 }
1133
1134 static int snd_usbmidi_input_close(struct snd_rawmidi_substream *substream)
1135 {
1136 substream_open(substream, 0);
1137 return 0;
1138 }
1139
1140 static void snd_usbmidi_input_trigger(struct snd_rawmidi_substream *substream, int up)
1141 {
1142 struct snd_usb_midi* umidi = substream->rmidi->private_data;
1143
1144 if (up)
1145 set_bit(substream->number, &umidi->input_triggered);
1146 else
1147 clear_bit(substream->number, &umidi->input_triggered);
1148 }
1149
1150 static struct snd_rawmidi_ops snd_usbmidi_output_ops = {
1151 .open = snd_usbmidi_output_open,
1152 .close = snd_usbmidi_output_close,
1153 .trigger = snd_usbmidi_output_trigger,
1154 .drain = snd_usbmidi_output_drain,
1155 };
1156
1157 static struct snd_rawmidi_ops snd_usbmidi_input_ops = {
1158 .open = snd_usbmidi_input_open,
1159 .close = snd_usbmidi_input_close,
1160 .trigger = snd_usbmidi_input_trigger
1161 };
1162
1163 static void free_urb_and_buffer(struct snd_usb_midi *umidi, struct urb *urb,
1164 unsigned int buffer_length)
1165 {
1166 usb_free_coherent(umidi->dev, buffer_length,
1167 urb->transfer_buffer, urb->transfer_dma);
1168 usb_free_urb(urb);
1169 }
1170
1171 /*
1172 * Frees an input endpoint.
1173 * May be called when ep hasn't been initialized completely.
1174 */
1175 static void snd_usbmidi_in_endpoint_delete(struct snd_usb_midi_in_endpoint* ep)
1176 {
1177 unsigned int i;
1178
1179 for (i = 0; i < INPUT_URBS; ++i)
1180 if (ep->urbs[i])
1181 free_urb_and_buffer(ep->umidi, ep->urbs[i],
1182 ep->urbs[i]->transfer_buffer_length);
1183 kfree(ep);
1184 }
1185
1186 /*
1187 * Creates an input endpoint.
1188 */
1189 static int snd_usbmidi_in_endpoint_create(struct snd_usb_midi* umidi,
1190 struct snd_usb_midi_endpoint_info* ep_info,
1191 struct snd_usb_midi_endpoint* rep)
1192 {
1193 struct snd_usb_midi_in_endpoint* ep;
1194 void* buffer;
1195 unsigned int pipe;
1196 int length;
1197 unsigned int i;
1198
1199 rep->in = NULL;
1200 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1201 if (!ep)
1202 return -ENOMEM;
1203 ep->umidi = umidi;
1204
1205 for (i = 0; i < INPUT_URBS; ++i) {
1206 ep->urbs[i] = usb_alloc_urb(0, GFP_KERNEL);
1207 if (!ep->urbs[i]) {
1208 snd_usbmidi_in_endpoint_delete(ep);
1209 return -ENOMEM;
1210 }
1211 }
1212 if (ep_info->in_interval)
1213 pipe = usb_rcvintpipe(umidi->dev, ep_info->in_ep);
1214 else
1215 pipe = usb_rcvbulkpipe(umidi->dev, ep_info->in_ep);
1216 length = usb_maxpacket(umidi->dev, pipe, 0);
1217 for (i = 0; i < INPUT_URBS; ++i) {
1218 buffer = usb_alloc_coherent(umidi->dev, length, GFP_KERNEL,
1219 &ep->urbs[i]->transfer_dma);
1220 if (!buffer) {
1221 snd_usbmidi_in_endpoint_delete(ep);
1222 return -ENOMEM;
1223 }
1224 if (ep_info->in_interval)
1225 usb_fill_int_urb(ep->urbs[i], umidi->dev,
1226 pipe, buffer, length,
1227 snd_usbmidi_in_urb_complete,
1228 ep, ep_info->in_interval);
1229 else
1230 usb_fill_bulk_urb(ep->urbs[i], umidi->dev,
1231 pipe, buffer, length,
1232 snd_usbmidi_in_urb_complete, ep);
1233 ep->urbs[i]->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1234 }
1235
1236 rep->in = ep;
1237 return 0;
1238 }
1239
1240 /*
1241 * Frees an output endpoint.
1242 * May be called when ep hasn't been initialized completely.
1243 */
1244 static void snd_usbmidi_out_endpoint_clear(struct snd_usb_midi_out_endpoint *ep)
1245 {
1246 unsigned int i;
1247
1248 for (i = 0; i < OUTPUT_URBS; ++i)
1249 if (ep->urbs[i].urb) {
1250 free_urb_and_buffer(ep->umidi, ep->urbs[i].urb,
1251 ep->max_transfer);
1252 ep->urbs[i].urb = NULL;
1253 }
1254 }
1255
1256 static void snd_usbmidi_out_endpoint_delete(struct snd_usb_midi_out_endpoint *ep)
1257 {
1258 snd_usbmidi_out_endpoint_clear(ep);
1259 kfree(ep);
1260 }
1261
1262 /*
1263 * Creates an output endpoint, and initializes output ports.
1264 */
1265 static int snd_usbmidi_out_endpoint_create(struct snd_usb_midi* umidi,
1266 struct snd_usb_midi_endpoint_info* ep_info,
1267 struct snd_usb_midi_endpoint* rep)
1268 {
1269 struct snd_usb_midi_out_endpoint* ep;
1270 unsigned int i;
1271 unsigned int pipe;
1272 void* buffer;
1273
1274 rep->out = NULL;
1275 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1276 if (!ep)
1277 return -ENOMEM;
1278 ep->umidi = umidi;
1279
1280 for (i = 0; i < OUTPUT_URBS; ++i) {
1281 ep->urbs[i].urb = usb_alloc_urb(0, GFP_KERNEL);
1282 if (!ep->urbs[i].urb) {
1283 snd_usbmidi_out_endpoint_delete(ep);
1284 return -ENOMEM;
1285 }
1286 ep->urbs[i].ep = ep;
1287 }
1288 if (ep_info->out_interval)
1289 pipe = usb_sndintpipe(umidi->dev, ep_info->out_ep);
1290 else
1291 pipe = usb_sndbulkpipe(umidi->dev, ep_info->out_ep);
1292 switch (umidi->usb_id) {
1293 default:
1294 ep->max_transfer = usb_maxpacket(umidi->dev, pipe, 1);
1295 break;
1296 /*
1297 * Various chips declare a packet size larger than 4 bytes, but
1298 * do not actually work with larger packets:
1299 */
1300 case USB_ID(0x0a92, 0x1020): /* ESI M4U */
1301 case USB_ID(0x1430, 0x474b): /* RedOctane GH MIDI INTERFACE */
1302 case USB_ID(0x15ca, 0x0101): /* Textech USB Midi Cable */
1303 case USB_ID(0x15ca, 0x1806): /* Textech USB Midi Cable */
1304 case USB_ID(0x1a86, 0x752d): /* QinHeng CH345 "USB2.0-MIDI" */
1305 case USB_ID(0xfc08, 0x0101): /* Unknown vendor Cable */
1306 ep->max_transfer = 4;
1307 break;
1308 /*
1309 * Some devices only work with 9 bytes packet size:
1310 */
1311 case USB_ID(0x0644, 0x800E): /* Tascam US-122L */
1312 case USB_ID(0x0644, 0x800F): /* Tascam US-144 */
1313 ep->max_transfer = 9;
1314 break;
1315 }
1316 for (i = 0; i < OUTPUT_URBS; ++i) {
1317 buffer = usb_alloc_coherent(umidi->dev,
1318 ep->max_transfer, GFP_KERNEL,
1319 &ep->urbs[i].urb->transfer_dma);
1320 if (!buffer) {
1321 snd_usbmidi_out_endpoint_delete(ep);
1322 return -ENOMEM;
1323 }
1324 if (ep_info->out_interval)
1325 usb_fill_int_urb(ep->urbs[i].urb, umidi->dev,
1326 pipe, buffer, ep->max_transfer,
1327 snd_usbmidi_out_urb_complete,
1328 &ep->urbs[i], ep_info->out_interval);
1329 else
1330 usb_fill_bulk_urb(ep->urbs[i].urb, umidi->dev,
1331 pipe, buffer, ep->max_transfer,
1332 snd_usbmidi_out_urb_complete,
1333 &ep->urbs[i]);
1334 ep->urbs[i].urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1335 }
1336
1337 spin_lock_init(&ep->buffer_lock);
1338 tasklet_init(&ep->tasklet, snd_usbmidi_out_tasklet, (unsigned long)ep);
1339 init_waitqueue_head(&ep->drain_wait);
1340
1341 for (i = 0; i < 0x10; ++i)
1342 if (ep_info->out_cables & (1 << i)) {
1343 ep->ports[i].ep = ep;
1344 ep->ports[i].cable = i << 4;
1345 }
1346
1347 if (umidi->usb_protocol_ops->init_out_endpoint)
1348 umidi->usb_protocol_ops->init_out_endpoint(ep);
1349
1350 rep->out = ep;
1351 return 0;
1352 }
1353
1354 /*
1355 * Frees everything.
1356 */
1357 static void snd_usbmidi_free(struct snd_usb_midi* umidi)
1358 {
1359 int i;
1360
1361 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1362 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
1363 if (ep->out)
1364 snd_usbmidi_out_endpoint_delete(ep->out);
1365 if (ep->in)
1366 snd_usbmidi_in_endpoint_delete(ep->in);
1367 }
1368 mutex_destroy(&umidi->mutex);
1369 kfree(umidi);
1370 }
1371
1372 /*
1373 * Unlinks all URBs (must be done before the usb_device is deleted).
1374 */
1375 void snd_usbmidi_disconnect(struct list_head* p)
1376 {
1377 struct snd_usb_midi* umidi;
1378 unsigned int i, j;
1379
1380 umidi = list_entry(p, struct snd_usb_midi, list);
1381 /*
1382 * an URB's completion handler may start the timer and
1383 * a timer may submit an URB. To reliably break the cycle
1384 * a flag under lock must be used
1385 */
1386 spin_lock_irq(&umidi->disc_lock);
1387 umidi->disconnected = 1;
1388 spin_unlock_irq(&umidi->disc_lock);
1389 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1390 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
1391 if (ep->out)
1392 tasklet_kill(&ep->out->tasklet);
1393 if (ep->out) {
1394 for (j = 0; j < OUTPUT_URBS; ++j)
1395 usb_kill_urb(ep->out->urbs[j].urb);
1396 if (umidi->usb_protocol_ops->finish_out_endpoint)
1397 umidi->usb_protocol_ops->finish_out_endpoint(ep->out);
1398 ep->out->active_urbs = 0;
1399 if (ep->out->drain_urbs) {
1400 ep->out->drain_urbs = 0;
1401 wake_up(&ep->out->drain_wait);
1402 }
1403 }
1404 if (ep->in)
1405 for (j = 0; j < INPUT_URBS; ++j)
1406 usb_kill_urb(ep->in->urbs[j]);
1407 /* free endpoints here; later call can result in Oops */
1408 if (ep->out)
1409 snd_usbmidi_out_endpoint_clear(ep->out);
1410 if (ep->in) {
1411 snd_usbmidi_in_endpoint_delete(ep->in);
1412 ep->in = NULL;
1413 }
1414 }
1415 del_timer_sync(&umidi->error_timer);
1416 }
1417
1418 static void snd_usbmidi_rawmidi_free(struct snd_rawmidi *rmidi)
1419 {
1420 struct snd_usb_midi* umidi = rmidi->private_data;
1421 snd_usbmidi_free(umidi);
1422 }
1423
1424 static struct snd_rawmidi_substream *snd_usbmidi_find_substream(struct snd_usb_midi* umidi,
1425 int stream, int number)
1426 {
1427 struct list_head* list;
1428
1429 list_for_each(list, &umidi->rmidi->streams[stream].substreams) {
1430 struct snd_rawmidi_substream *substream = list_entry(list, struct snd_rawmidi_substream, list);
1431 if (substream->number == number)
1432 return substream;
1433 }
1434 return NULL;
1435 }
1436
1437 /*
1438 * This list specifies names for ports that do not fit into the standard
1439 * "(product) MIDI (n)" schema because they aren't external MIDI ports,
1440 * such as internal control or synthesizer ports.
1441 */
1442 static struct port_info {
1443 u32 id;
1444 short int port;
1445 short int voices;
1446 const char *name;
1447 unsigned int seq_flags;
1448 } snd_usbmidi_port_info[] = {
1449 #define PORT_INFO(vendor, product, num, name_, voices_, flags) \
1450 { .id = USB_ID(vendor, product), \
1451 .port = num, .voices = voices_, \
1452 .name = name_, .seq_flags = flags }
1453 #define EXTERNAL_PORT(vendor, product, num, name) \
1454 PORT_INFO(vendor, product, num, name, 0, \
1455 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1456 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1457 SNDRV_SEQ_PORT_TYPE_PORT)
1458 #define CONTROL_PORT(vendor, product, num, name) \
1459 PORT_INFO(vendor, product, num, name, 0, \
1460 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1461 SNDRV_SEQ_PORT_TYPE_HARDWARE)
1462 #define ROLAND_SYNTH_PORT(vendor, product, num, name, voices) \
1463 PORT_INFO(vendor, product, num, name, voices, \
1464 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1465 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1466 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1467 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1468 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1469 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1470 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1471 #define SOUNDCANVAS_PORT(vendor, product, num, name, voices) \
1472 PORT_INFO(vendor, product, num, name, voices, \
1473 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1474 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1475 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1476 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1477 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1478 SNDRV_SEQ_PORT_TYPE_MIDI_MT32 | \
1479 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1480 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1481 /* Roland UA-100 */
1482 CONTROL_PORT(0x0582, 0x0000, 2, "%s Control"),
1483 /* Roland SC-8850 */
1484 SOUNDCANVAS_PORT(0x0582, 0x0003, 0, "%s Part A", 128),
1485 SOUNDCANVAS_PORT(0x0582, 0x0003, 1, "%s Part B", 128),
1486 SOUNDCANVAS_PORT(0x0582, 0x0003, 2, "%s Part C", 128),
1487 SOUNDCANVAS_PORT(0x0582, 0x0003, 3, "%s Part D", 128),
1488 EXTERNAL_PORT(0x0582, 0x0003, 4, "%s MIDI 1"),
1489 EXTERNAL_PORT(0x0582, 0x0003, 5, "%s MIDI 2"),
1490 /* Roland U-8 */
1491 EXTERNAL_PORT(0x0582, 0x0004, 0, "%s MIDI"),
1492 CONTROL_PORT(0x0582, 0x0004, 1, "%s Control"),
1493 /* Roland SC-8820 */
1494 SOUNDCANVAS_PORT(0x0582, 0x0007, 0, "%s Part A", 64),
1495 SOUNDCANVAS_PORT(0x0582, 0x0007, 1, "%s Part B", 64),
1496 EXTERNAL_PORT(0x0582, 0x0007, 2, "%s MIDI"),
1497 /* Roland SK-500 */
1498 SOUNDCANVAS_PORT(0x0582, 0x000b, 0, "%s Part A", 64),
1499 SOUNDCANVAS_PORT(0x0582, 0x000b, 1, "%s Part B", 64),
1500 EXTERNAL_PORT(0x0582, 0x000b, 2, "%s MIDI"),
1501 /* Roland SC-D70 */
1502 SOUNDCANVAS_PORT(0x0582, 0x000c, 0, "%s Part A", 64),
1503 SOUNDCANVAS_PORT(0x0582, 0x000c, 1, "%s Part B", 64),
1504 EXTERNAL_PORT(0x0582, 0x000c, 2, "%s MIDI"),
1505 /* Edirol UM-880 */
1506 CONTROL_PORT(0x0582, 0x0014, 8, "%s Control"),
1507 /* Edirol SD-90 */
1508 ROLAND_SYNTH_PORT(0x0582, 0x0016, 0, "%s Part A", 128),
1509 ROLAND_SYNTH_PORT(0x0582, 0x0016, 1, "%s Part B", 128),
1510 EXTERNAL_PORT(0x0582, 0x0016, 2, "%s MIDI 1"),
1511 EXTERNAL_PORT(0x0582, 0x0016, 3, "%s MIDI 2"),
1512 /* Edirol UM-550 */
1513 CONTROL_PORT(0x0582, 0x0023, 5, "%s Control"),
1514 /* Edirol SD-20 */
1515 ROLAND_SYNTH_PORT(0x0582, 0x0027, 0, "%s Part A", 64),
1516 ROLAND_SYNTH_PORT(0x0582, 0x0027, 1, "%s Part B", 64),
1517 EXTERNAL_PORT(0x0582, 0x0027, 2, "%s MIDI"),
1518 /* Edirol SD-80 */
1519 ROLAND_SYNTH_PORT(0x0582, 0x0029, 0, "%s Part A", 128),
1520 ROLAND_SYNTH_PORT(0x0582, 0x0029, 1, "%s Part B", 128),
1521 EXTERNAL_PORT(0x0582, 0x0029, 2, "%s MIDI 1"),
1522 EXTERNAL_PORT(0x0582, 0x0029, 3, "%s MIDI 2"),
1523 /* Edirol UA-700 */
1524 EXTERNAL_PORT(0x0582, 0x002b, 0, "%s MIDI"),
1525 CONTROL_PORT(0x0582, 0x002b, 1, "%s Control"),
1526 /* Roland VariOS */
1527 EXTERNAL_PORT(0x0582, 0x002f, 0, "%s MIDI"),
1528 EXTERNAL_PORT(0x0582, 0x002f, 1, "%s External MIDI"),
1529 EXTERNAL_PORT(0x0582, 0x002f, 2, "%s Sync"),
1530 /* Edirol PCR */
1531 EXTERNAL_PORT(0x0582, 0x0033, 0, "%s MIDI"),
1532 EXTERNAL_PORT(0x0582, 0x0033, 1, "%s 1"),
1533 EXTERNAL_PORT(0x0582, 0x0033, 2, "%s 2"),
1534 /* BOSS GS-10 */
1535 EXTERNAL_PORT(0x0582, 0x003b, 0, "%s MIDI"),
1536 CONTROL_PORT(0x0582, 0x003b, 1, "%s Control"),
1537 /* Edirol UA-1000 */
1538 EXTERNAL_PORT(0x0582, 0x0044, 0, "%s MIDI"),
1539 CONTROL_PORT(0x0582, 0x0044, 1, "%s Control"),
1540 /* Edirol UR-80 */
1541 EXTERNAL_PORT(0x0582, 0x0048, 0, "%s MIDI"),
1542 EXTERNAL_PORT(0x0582, 0x0048, 1, "%s 1"),
1543 EXTERNAL_PORT(0x0582, 0x0048, 2, "%s 2"),
1544 /* Edirol PCR-A */
1545 EXTERNAL_PORT(0x0582, 0x004d, 0, "%s MIDI"),
1546 EXTERNAL_PORT(0x0582, 0x004d, 1, "%s 1"),
1547 EXTERNAL_PORT(0x0582, 0x004d, 2, "%s 2"),
1548 /* Edirol UM-3EX */
1549 CONTROL_PORT(0x0582, 0x009a, 3, "%s Control"),
1550 /* M-Audio MidiSport 8x8 */
1551 CONTROL_PORT(0x0763, 0x1031, 8, "%s Control"),
1552 CONTROL_PORT(0x0763, 0x1033, 8, "%s Control"),
1553 /* MOTU Fastlane */
1554 EXTERNAL_PORT(0x07fd, 0x0001, 0, "%s MIDI A"),
1555 EXTERNAL_PORT(0x07fd, 0x0001, 1, "%s MIDI B"),
1556 /* Emagic Unitor8/AMT8/MT4 */
1557 EXTERNAL_PORT(0x086a, 0x0001, 8, "%s Broadcast"),
1558 EXTERNAL_PORT(0x086a, 0x0002, 8, "%s Broadcast"),
1559 EXTERNAL_PORT(0x086a, 0x0003, 4, "%s Broadcast"),
1560 /* Akai MPD16 */
1561 CONTROL_PORT(0x09e8, 0x0062, 0, "%s Control"),
1562 PORT_INFO(0x09e8, 0x0062, 1, "%s MIDI", 0,
1563 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC |
1564 SNDRV_SEQ_PORT_TYPE_HARDWARE),
1565 /* Access Music Virus TI */
1566 EXTERNAL_PORT(0x133e, 0x0815, 0, "%s MIDI"),
1567 PORT_INFO(0x133e, 0x0815, 1, "%s Synth", 0,
1568 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC |
1569 SNDRV_SEQ_PORT_TYPE_HARDWARE |
1570 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER),
1571 };
1572
1573 static struct port_info *find_port_info(struct snd_usb_midi* umidi, int number)
1574 {
1575 int i;
1576
1577 for (i = 0; i < ARRAY_SIZE(snd_usbmidi_port_info); ++i) {
1578 if (snd_usbmidi_port_info[i].id == umidi->usb_id &&
1579 snd_usbmidi_port_info[i].port == number)
1580 return &snd_usbmidi_port_info[i];
1581 }
1582 return NULL;
1583 }
1584
1585 static void snd_usbmidi_get_port_info(struct snd_rawmidi *rmidi, int number,
1586 struct snd_seq_port_info *seq_port_info)
1587 {
1588 struct snd_usb_midi *umidi = rmidi->private_data;
1589 struct port_info *port_info;
1590
1591 /* TODO: read port flags from descriptors */
1592 port_info = find_port_info(umidi, number);
1593 if (port_info) {
1594 seq_port_info->type = port_info->seq_flags;
1595 seq_port_info->midi_voices = port_info->voices;
1596 }
1597 }
1598
1599 static void snd_usbmidi_init_substream(struct snd_usb_midi* umidi,
1600 int stream, int number,
1601 struct snd_rawmidi_substream ** rsubstream)
1602 {
1603 struct port_info *port_info;
1604 const char *name_format;
1605
1606 struct snd_rawmidi_substream *substream = snd_usbmidi_find_substream(umidi, stream, number);
1607 if (!substream) {
1608 snd_printd(KERN_ERR "substream %d:%d not found\n", stream, number);
1609 return;
1610 }
1611
1612 /* TODO: read port name from jack descriptor */
1613 port_info = find_port_info(umidi, number);
1614 name_format = port_info ? port_info->name : "%s MIDI %d";
1615 snprintf(substream->name, sizeof(substream->name),
1616 name_format, umidi->card->shortname, number + 1);
1617
1618 *rsubstream = substream;
1619 }
1620
1621 /*
1622 * Creates the endpoints and their ports.
1623 */
1624 static int snd_usbmidi_create_endpoints(struct snd_usb_midi* umidi,
1625 struct snd_usb_midi_endpoint_info* endpoints)
1626 {
1627 int i, j, err;
1628 int out_ports = 0, in_ports = 0;
1629
1630 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1631 if (endpoints[i].out_cables) {
1632 err = snd_usbmidi_out_endpoint_create(umidi, &endpoints[i],
1633 &umidi->endpoints[i]);
1634 if (err < 0)
1635 return err;
1636 }
1637 if (endpoints[i].in_cables) {
1638 err = snd_usbmidi_in_endpoint_create(umidi, &endpoints[i],
1639 &umidi->endpoints[i]);
1640 if (err < 0)
1641 return err;
1642 }
1643
1644 for (j = 0; j < 0x10; ++j) {
1645 if (endpoints[i].out_cables & (1 << j)) {
1646 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_OUTPUT, out_ports,
1647 &umidi->endpoints[i].out->ports[j].substream);
1648 ++out_ports;
1649 }
1650 if (endpoints[i].in_cables & (1 << j)) {
1651 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_INPUT, in_ports,
1652 &umidi->endpoints[i].in->ports[j].substream);
1653 ++in_ports;
1654 }
1655 }
1656 }
1657 snd_printdd(KERN_INFO "created %d output and %d input ports\n",
1658 out_ports, in_ports);
1659 return 0;
1660 }
1661
1662 /*
1663 * Returns MIDIStreaming device capabilities.
1664 */
1665 static int snd_usbmidi_get_ms_info(struct snd_usb_midi* umidi,
1666 struct snd_usb_midi_endpoint_info* endpoints)
1667 {
1668 struct usb_interface* intf;
1669 struct usb_host_interface *hostif;
1670 struct usb_interface_descriptor* intfd;
1671 struct usb_ms_header_descriptor* ms_header;
1672 struct usb_host_endpoint *hostep;
1673 struct usb_endpoint_descriptor* ep;
1674 struct usb_ms_endpoint_descriptor* ms_ep;
1675 int i, epidx;
1676
1677 intf = umidi->iface;
1678 if (!intf)
1679 return -ENXIO;
1680 hostif = &intf->altsetting[0];
1681 intfd = get_iface_desc(hostif);
1682 ms_header = (struct usb_ms_header_descriptor*)hostif->extra;
1683 if (hostif->extralen >= 7 &&
1684 ms_header->bLength >= 7 &&
1685 ms_header->bDescriptorType == USB_DT_CS_INTERFACE &&
1686 ms_header->bDescriptorSubtype == UAC_HEADER)
1687 snd_printdd(KERN_INFO "MIDIStreaming version %02x.%02x\n",
1688 ms_header->bcdMSC[1], ms_header->bcdMSC[0]);
1689 else
1690 snd_printk(KERN_WARNING "MIDIStreaming interface descriptor not found\n");
1691
1692 epidx = 0;
1693 for (i = 0; i < intfd->bNumEndpoints; ++i) {
1694 hostep = &hostif->endpoint[i];
1695 ep = get_ep_desc(hostep);
1696 if (!usb_endpoint_xfer_bulk(ep) && !usb_endpoint_xfer_int(ep))
1697 continue;
1698 ms_ep = (struct usb_ms_endpoint_descriptor*)hostep->extra;
1699 if (hostep->extralen < 4 ||
1700 ms_ep->bLength < 4 ||
1701 ms_ep->bDescriptorType != USB_DT_CS_ENDPOINT ||
1702 ms_ep->bDescriptorSubtype != UAC_MS_GENERAL)
1703 continue;
1704 if (usb_endpoint_dir_out(ep)) {
1705 if (endpoints[epidx].out_ep) {
1706 if (++epidx >= MIDI_MAX_ENDPOINTS) {
1707 snd_printk(KERN_WARNING "too many endpoints\n");
1708 break;
1709 }
1710 }
1711 endpoints[epidx].out_ep = usb_endpoint_num(ep);
1712 if (usb_endpoint_xfer_int(ep))
1713 endpoints[epidx].out_interval = ep->bInterval;
1714 else if (snd_usb_get_speed(umidi->dev) == USB_SPEED_LOW)
1715 /*
1716 * Low speed bulk transfers don't exist, so
1717 * force interrupt transfers for devices like
1718 * ESI MIDI Mate that try to use them anyway.
1719 */
1720 endpoints[epidx].out_interval = 1;
1721 endpoints[epidx].out_cables = (1 << ms_ep->bNumEmbMIDIJack) - 1;
1722 snd_printdd(KERN_INFO "EP %02X: %d jack(s)\n",
1723 ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1724 } else {
1725 if (endpoints[epidx].in_ep) {
1726 if (++epidx >= MIDI_MAX_ENDPOINTS) {
1727 snd_printk(KERN_WARNING "too many endpoints\n");
1728 break;
1729 }
1730 }
1731 endpoints[epidx].in_ep = usb_endpoint_num(ep);
1732 if (usb_endpoint_xfer_int(ep))
1733 endpoints[epidx].in_interval = ep->bInterval;
1734 else if (snd_usb_get_speed(umidi->dev) == USB_SPEED_LOW)
1735 endpoints[epidx].in_interval = 1;
1736 endpoints[epidx].in_cables = (1 << ms_ep->bNumEmbMIDIJack) - 1;
1737 snd_printdd(KERN_INFO "EP %02X: %d jack(s)\n",
1738 ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1739 }
1740 }
1741 return 0;
1742 }
1743
1744 static int roland_load_info(struct snd_kcontrol *kcontrol,
1745 struct snd_ctl_elem_info *info)
1746 {
1747 static const char *const names[] = { "High Load", "Light Load" };
1748
1749 return snd_ctl_enum_info(info, 1, 2, names);
1750 }
1751
1752 static int roland_load_get(struct snd_kcontrol *kcontrol,
1753 struct snd_ctl_elem_value *value)
1754 {
1755 value->value.enumerated.item[0] = kcontrol->private_value;
1756 return 0;
1757 }
1758
1759 static int roland_load_put(struct snd_kcontrol *kcontrol,
1760 struct snd_ctl_elem_value *value)
1761 {
1762 struct snd_usb_midi* umidi = kcontrol->private_data;
1763 int changed;
1764
1765 if (value->value.enumerated.item[0] > 1)
1766 return -EINVAL;
1767 mutex_lock(&umidi->mutex);
1768 changed = value->value.enumerated.item[0] != kcontrol->private_value;
1769 if (changed)
1770 kcontrol->private_value = value->value.enumerated.item[0];
1771 mutex_unlock(&umidi->mutex);
1772 return changed;
1773 }
1774
1775 static struct snd_kcontrol_new roland_load_ctl = {
1776 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1777 .name = "MIDI Input Mode",
1778 .info = roland_load_info,
1779 .get = roland_load_get,
1780 .put = roland_load_put,
1781 .private_value = 1,
1782 };
1783
1784 /*
1785 * On Roland devices, use the second alternate setting to be able to use
1786 * the interrupt input endpoint.
1787 */
1788 static void snd_usbmidi_switch_roland_altsetting(struct snd_usb_midi* umidi)
1789 {
1790 struct usb_interface* intf;
1791 struct usb_host_interface *hostif;
1792 struct usb_interface_descriptor* intfd;
1793
1794 intf = umidi->iface;
1795 if (!intf || intf->num_altsetting != 2)
1796 return;
1797
1798 hostif = &intf->altsetting[1];
1799 intfd = get_iface_desc(hostif);
1800 if (intfd->bNumEndpoints != 2 ||
1801 (get_endpoint(hostif, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK ||
1802 (get_endpoint(hostif, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
1803 return;
1804
1805 snd_printdd(KERN_INFO "switching to altsetting %d with int ep\n",
1806 intfd->bAlternateSetting);
1807 usb_set_interface(umidi->dev, intfd->bInterfaceNumber,
1808 intfd->bAlternateSetting);
1809
1810 umidi->roland_load_ctl = snd_ctl_new1(&roland_load_ctl, umidi);
1811 if (snd_ctl_add(umidi->card, umidi->roland_load_ctl) < 0)
1812 umidi->roland_load_ctl = NULL;
1813 }
1814
1815 /*
1816 * Try to find any usable endpoints in the interface.
1817 */
1818 static int snd_usbmidi_detect_endpoints(struct snd_usb_midi* umidi,
1819 struct snd_usb_midi_endpoint_info* endpoint,
1820 int max_endpoints)
1821 {
1822 struct usb_interface* intf;
1823 struct usb_host_interface *hostif;
1824 struct usb_interface_descriptor* intfd;
1825 struct usb_endpoint_descriptor* epd;
1826 int i, out_eps = 0, in_eps = 0;
1827
1828 if (USB_ID_VENDOR(umidi->usb_id) == 0x0582)
1829 snd_usbmidi_switch_roland_altsetting(umidi);
1830
1831 if (endpoint[0].out_ep || endpoint[0].in_ep)
1832 return 0;
1833
1834 intf = umidi->iface;
1835 if (!intf || intf->num_altsetting < 1)
1836 return -ENOENT;
1837 hostif = intf->cur_altsetting;
1838 intfd = get_iface_desc(hostif);
1839
1840 for (i = 0; i < intfd->bNumEndpoints; ++i) {
1841 epd = get_endpoint(hostif, i);
1842 if (!usb_endpoint_xfer_bulk(epd) &&
1843 !usb_endpoint_xfer_int(epd))
1844 continue;
1845 if (out_eps < max_endpoints &&
1846 usb_endpoint_dir_out(epd)) {
1847 endpoint[out_eps].out_ep = usb_endpoint_num(epd);
1848 if (usb_endpoint_xfer_int(epd))
1849 endpoint[out_eps].out_interval = epd->bInterval;
1850 ++out_eps;
1851 }
1852 if (in_eps < max_endpoints &&
1853 usb_endpoint_dir_in(epd)) {
1854 endpoint[in_eps].in_ep = usb_endpoint_num(epd);
1855 if (usb_endpoint_xfer_int(epd))
1856 endpoint[in_eps].in_interval = epd->bInterval;
1857 ++in_eps;
1858 }
1859 }
1860 return (out_eps || in_eps) ? 0 : -ENOENT;
1861 }
1862
1863 /*
1864 * Detects the endpoints for one-port-per-endpoint protocols.
1865 */
1866 static int snd_usbmidi_detect_per_port_endpoints(struct snd_usb_midi* umidi,
1867 struct snd_usb_midi_endpoint_info* endpoints)
1868 {
1869 int err, i;
1870
1871 err = snd_usbmidi_detect_endpoints(umidi, endpoints, MIDI_MAX_ENDPOINTS);
1872 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1873 if (endpoints[i].out_ep)
1874 endpoints[i].out_cables = 0x0001;
1875 if (endpoints[i].in_ep)
1876 endpoints[i].in_cables = 0x0001;
1877 }
1878 return err;
1879 }
1880
1881 /*
1882 * Detects the endpoints and ports of Yamaha devices.
1883 */
1884 static int snd_usbmidi_detect_yamaha(struct snd_usb_midi* umidi,
1885 struct snd_usb_midi_endpoint_info* endpoint)
1886 {
1887 struct usb_interface* intf;
1888 struct usb_host_interface *hostif;
1889 struct usb_interface_descriptor* intfd;
1890 uint8_t* cs_desc;
1891
1892 intf = umidi->iface;
1893 if (!intf)
1894 return -ENOENT;
1895 hostif = intf->altsetting;
1896 intfd = get_iface_desc(hostif);
1897 if (intfd->bNumEndpoints < 1)
1898 return -ENOENT;
1899
1900 /*
1901 * For each port there is one MIDI_IN/OUT_JACK descriptor, not
1902 * necessarily with any useful contents. So simply count 'em.
1903 */
1904 for (cs_desc = hostif->extra;
1905 cs_desc < hostif->extra + hostif->extralen && cs_desc[0] >= 2;
1906 cs_desc += cs_desc[0]) {
1907 if (cs_desc[1] == USB_DT_CS_INTERFACE) {
1908 if (cs_desc[2] == UAC_MIDI_IN_JACK)
1909 endpoint->in_cables = (endpoint->in_cables << 1) | 1;
1910 else if (cs_desc[2] == UAC_MIDI_OUT_JACK)
1911 endpoint->out_cables = (endpoint->out_cables << 1) | 1;
1912 }
1913 }
1914 if (!endpoint->in_cables && !endpoint->out_cables)
1915 return -ENOENT;
1916
1917 return snd_usbmidi_detect_endpoints(umidi, endpoint, 1);
1918 }
1919
1920 /*
1921 * Creates the endpoints and their ports for Midiman devices.
1922 */
1923 static int snd_usbmidi_create_endpoints_midiman(struct snd_usb_midi* umidi,
1924 struct snd_usb_midi_endpoint_info* endpoint)
1925 {
1926 struct snd_usb_midi_endpoint_info ep_info;
1927 struct usb_interface* intf;
1928 struct usb_host_interface *hostif;
1929 struct usb_interface_descriptor* intfd;
1930 struct usb_endpoint_descriptor* epd;
1931 int cable, err;
1932
1933 intf = umidi->iface;
1934 if (!intf)
1935 return -ENOENT;
1936 hostif = intf->altsetting;
1937 intfd = get_iface_desc(hostif);
1938 /*
1939 * The various MidiSport devices have more or less random endpoint
1940 * numbers, so we have to identify the endpoints by their index in
1941 * the descriptor array, like the driver for that other OS does.
1942 *
1943 * There is one interrupt input endpoint for all input ports, one
1944 * bulk output endpoint for even-numbered ports, and one for odd-
1945 * numbered ports. Both bulk output endpoints have corresponding
1946 * input bulk endpoints (at indices 1 and 3) which aren't used.
1947 */
1948 if (intfd->bNumEndpoints < (endpoint->out_cables > 0x0001 ? 5 : 3)) {
1949 snd_printdd(KERN_ERR "not enough endpoints\n");
1950 return -ENOENT;
1951 }
1952
1953 epd = get_endpoint(hostif, 0);
1954 if (!usb_endpoint_dir_in(epd) || !usb_endpoint_xfer_int(epd)) {
1955 snd_printdd(KERN_ERR "endpoint[0] isn't interrupt\n");
1956 return -ENXIO;
1957 }
1958 epd = get_endpoint(hostif, 2);
1959 if (!usb_endpoint_dir_out(epd) || !usb_endpoint_xfer_bulk(epd)) {
1960 snd_printdd(KERN_ERR "endpoint[2] isn't bulk output\n");
1961 return -ENXIO;
1962 }
1963 if (endpoint->out_cables > 0x0001) {
1964 epd = get_endpoint(hostif, 4);
1965 if (!usb_endpoint_dir_out(epd) ||
1966 !usb_endpoint_xfer_bulk(epd)) {
1967 snd_printdd(KERN_ERR "endpoint[4] isn't bulk output\n");
1968 return -ENXIO;
1969 }
1970 }
1971
1972 ep_info.out_ep = get_endpoint(hostif, 2)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1973 ep_info.out_interval = 0;
1974 ep_info.out_cables = endpoint->out_cables & 0x5555;
1975 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info, &umidi->endpoints[0]);
1976 if (err < 0)
1977 return err;
1978
1979 ep_info.in_ep = get_endpoint(hostif, 0)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1980 ep_info.in_interval = get_endpoint(hostif, 0)->bInterval;
1981 ep_info.in_cables = endpoint->in_cables;
1982 err = snd_usbmidi_in_endpoint_create(umidi, &ep_info, &umidi->endpoints[0]);
1983 if (err < 0)
1984 return err;
1985
1986 if (endpoint->out_cables > 0x0001) {
1987 ep_info.out_ep = get_endpoint(hostif, 4)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1988 ep_info.out_cables = endpoint->out_cables & 0xaaaa;
1989 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info, &umidi->endpoints[1]);
1990 if (err < 0)
1991 return err;
1992 }
1993
1994 for (cable = 0; cable < 0x10; ++cable) {
1995 if (endpoint->out_cables & (1 << cable))
1996 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_OUTPUT, cable,
1997 &umidi->endpoints[cable & 1].out->ports[cable].substream);
1998 if (endpoint->in_cables & (1 << cable))
1999 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_INPUT, cable,
2000 &umidi->endpoints[0].in->ports[cable].substream);
2001 }
2002 return 0;
2003 }
2004
2005 static struct snd_rawmidi_global_ops snd_usbmidi_ops = {
2006 .get_port_info = snd_usbmidi_get_port_info,
2007 };
2008
2009 static int snd_usbmidi_create_rawmidi(struct snd_usb_midi* umidi,
2010 int out_ports, int in_ports)
2011 {
2012 struct snd_rawmidi *rmidi;
2013 int err;
2014
2015 err = snd_rawmidi_new(umidi->card, "USB MIDI",
2016 umidi->next_midi_device++,
2017 out_ports, in_ports, &rmidi);
2018 if (err < 0)
2019 return err;
2020 strcpy(rmidi->name, umidi->card->shortname);
2021 rmidi->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT |
2022 SNDRV_RAWMIDI_INFO_INPUT |
2023 SNDRV_RAWMIDI_INFO_DUPLEX;
2024 rmidi->ops = &snd_usbmidi_ops;
2025 rmidi->private_data = umidi;
2026 rmidi->private_free = snd_usbmidi_rawmidi_free;
2027 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_usbmidi_output_ops);
2028 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_usbmidi_input_ops);
2029
2030 umidi->rmidi = rmidi;
2031 return 0;
2032 }
2033
2034 /*
2035 * Temporarily stop input.
2036 */
2037 void snd_usbmidi_input_stop(struct list_head* p)
2038 {
2039 struct snd_usb_midi* umidi;
2040 unsigned int i, j;
2041
2042 umidi = list_entry(p, struct snd_usb_midi, list);
2043 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
2044 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
2045 if (ep->in)
2046 for (j = 0; j < INPUT_URBS; ++j)
2047 usb_kill_urb(ep->in->urbs[j]);
2048 }
2049 }
2050
2051 static void snd_usbmidi_input_start_ep(struct snd_usb_midi_in_endpoint* ep)
2052 {
2053 unsigned int i;
2054
2055 if (!ep)
2056 return;
2057 for (i = 0; i < INPUT_URBS; ++i) {
2058 struct urb* urb = ep->urbs[i];
2059 urb->dev = ep->umidi->dev;
2060 snd_usbmidi_submit_urb(urb, GFP_KERNEL);
2061 }
2062 }
2063
2064 /*
2065 * Resume input after a call to snd_usbmidi_input_stop().
2066 */
2067 void snd_usbmidi_input_start(struct list_head* p)
2068 {
2069 struct snd_usb_midi* umidi;
2070 int i;
2071
2072 umidi = list_entry(p, struct snd_usb_midi, list);
2073 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
2074 snd_usbmidi_input_start_ep(umidi->endpoints[i].in);
2075 }
2076
2077 /*
2078 * Creates and registers everything needed for a MIDI streaming interface.
2079 */
2080 int snd_usbmidi_create(struct snd_card *card,
2081 struct usb_interface* iface,
2082 struct list_head *midi_list,
2083 const struct snd_usb_audio_quirk* quirk)
2084 {
2085 struct snd_usb_midi* umidi;
2086 struct snd_usb_midi_endpoint_info endpoints[MIDI_MAX_ENDPOINTS];
2087 int out_ports, in_ports;
2088 int i, err;
2089
2090 umidi = kzalloc(sizeof(*umidi), GFP_KERNEL);
2091 if (!umidi)
2092 return -ENOMEM;
2093 umidi->dev = interface_to_usbdev(iface);
2094 umidi->card = card;
2095 umidi->iface = iface;
2096 umidi->quirk = quirk;
2097 umidi->usb_protocol_ops = &snd_usbmidi_standard_ops;
2098 init_timer(&umidi->error_timer);
2099 spin_lock_init(&umidi->disc_lock);
2100 mutex_init(&umidi->mutex);
2101 umidi->usb_id = USB_ID(le16_to_cpu(umidi->dev->descriptor.idVendor),
2102 le16_to_cpu(umidi->dev->descriptor.idProduct));
2103 umidi->error_timer.function = snd_usbmidi_error_timer;
2104 umidi->error_timer.data = (unsigned long)umidi;
2105
2106 /* detect the endpoint(s) to use */
2107 memset(endpoints, 0, sizeof(endpoints));
2108 switch (quirk ? quirk->type : QUIRK_MIDI_STANDARD_INTERFACE) {
2109 case QUIRK_MIDI_STANDARD_INTERFACE:
2110 err = snd_usbmidi_get_ms_info(umidi, endpoints);
2111 if (umidi->usb_id == USB_ID(0x0763, 0x0150)) /* M-Audio Uno */
2112 umidi->usb_protocol_ops =
2113 &snd_usbmidi_maudio_broken_running_status_ops;
2114 break;
2115 case QUIRK_MIDI_US122L:
2116 umidi->usb_protocol_ops = &snd_usbmidi_122l_ops;
2117 /* fall through */
2118 case QUIRK_MIDI_FIXED_ENDPOINT:
2119 memcpy(&endpoints[0], quirk->data,
2120 sizeof(struct snd_usb_midi_endpoint_info));
2121 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
2122 break;
2123 case QUIRK_MIDI_YAMAHA:
2124 err = snd_usbmidi_detect_yamaha(umidi, &endpoints[0]);
2125 break;
2126 case QUIRK_MIDI_MIDIMAN:
2127 umidi->usb_protocol_ops = &snd_usbmidi_midiman_ops;
2128 memcpy(&endpoints[0], quirk->data,
2129 sizeof(struct snd_usb_midi_endpoint_info));
2130 err = 0;
2131 break;
2132 case QUIRK_MIDI_NOVATION:
2133 umidi->usb_protocol_ops = &snd_usbmidi_novation_ops;
2134 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2135 break;
2136 case QUIRK_MIDI_RAW_BYTES:
2137 umidi->usb_protocol_ops = &snd_usbmidi_raw_ops;
2138 /*
2139 * Interface 1 contains isochronous endpoints, but with the same
2140 * numbers as in interface 0. Since it is interface 1 that the
2141 * USB core has most recently seen, these descriptors are now
2142 * associated with the endpoint numbers. This will foul up our
2143 * attempts to submit bulk/interrupt URBs to the endpoints in
2144 * interface 0, so we have to make sure that the USB core looks
2145 * again at interface 0 by calling usb_set_interface() on it.
2146 */
2147 if (umidi->usb_id == USB_ID(0x07fd, 0x0001)) /* MOTU Fastlane */
2148 usb_set_interface(umidi->dev, 0, 0);
2149 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2150 break;
2151 case QUIRK_MIDI_EMAGIC:
2152 umidi->usb_protocol_ops = &snd_usbmidi_emagic_ops;
2153 memcpy(&endpoints[0], quirk->data,
2154 sizeof(struct snd_usb_midi_endpoint_info));
2155 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
2156 break;
2157 case QUIRK_MIDI_CME:
2158 umidi->usb_protocol_ops = &snd_usbmidi_cme_ops;
2159 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2160 break;
2161 case QUIRK_MIDI_AKAI:
2162 umidi->usb_protocol_ops = &snd_usbmidi_akai_ops;
2163 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2164 /* endpoint 1 is input-only */
2165 endpoints[1].out_cables = 0;
2166 break;
2167 default:
2168 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
2169 err = -ENXIO;
2170 break;
2171 }
2172 if (err < 0) {
2173 kfree(umidi);
2174 return err;
2175 }
2176
2177 /* create rawmidi device */
2178 out_ports = 0;
2179 in_ports = 0;
2180 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
2181 out_ports += hweight16(endpoints[i].out_cables);
2182 in_ports += hweight16(endpoints[i].in_cables);
2183 }
2184 err = snd_usbmidi_create_rawmidi(umidi, out_ports, in_ports);
2185 if (err < 0) {
2186 kfree(umidi);
2187 return err;
2188 }
2189
2190 /* create endpoint/port structures */
2191 if (quirk && quirk->type == QUIRK_MIDI_MIDIMAN)
2192 err = snd_usbmidi_create_endpoints_midiman(umidi, &endpoints[0]);
2193 else
2194 err = snd_usbmidi_create_endpoints(umidi, endpoints);
2195 if (err < 0) {
2196 snd_usbmidi_free(umidi);
2197 return err;
2198 }
2199
2200 list_add_tail(&umidi->list, midi_list);
2201
2202 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
2203 snd_usbmidi_input_start_ep(umidi->endpoints[i].in);
2204 return 0;
2205 }
2206
2207 EXPORT_SYMBOL(snd_usbmidi_create);
2208 EXPORT_SYMBOL(snd_usbmidi_input_stop);
2209 EXPORT_SYMBOL(snd_usbmidi_input_start);
2210 EXPORT_SYMBOL(snd_usbmidi_disconnect);
linux-next