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