projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
[ALSA] usb-audio: allow low speed MIDI devices
[linux-block.git] / sound / usb / usbmidi.c
CommitLineData
1da177e4
LT		 1/*
2 * usbmidi.c - ALSA USB MIDI driver
3 *
d05cc104 4 * Copyright (c) 2002-2007 Clemens Ladisch
1da177e4
LT		 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 <sound/driver.h>
39#include <linux/kernel.h>
40#include <linux/types.h>
41#include <linux/bitops.h>
42#include <linux/interrupt.h>
43#include <linux/spinlock.h>
44#include <linux/string.h>
45#include <linux/init.h>
46#include <linux/slab.h>
c8846970 47#include <linux/timer.h>
1da177e4
LT		 48#include <linux/usb.h>
49#include <sound/core.h>
1da177e4 50#include <sound/rawmidi.h>
a7b928ac 51#include <sound/asequencer.h>
1da177e4
LT		 52#include "usbaudio.h"
53
54
55/*
56 * define this to log all USB packets
57 */
58/* #define DUMP_PACKETS */
59
c8846970
CL		 60/*
61 * how long to wait after some USB errors, so that khubd can disconnect() us
62 * without too many spurious errors
63 */
64#define ERROR_DELAY_JIFFIES (HZ / 10)
65
1da177e4
LT		 66
67MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
68MODULE_DESCRIPTION("USB Audio/MIDI helper module");
69MODULE_LICENSE("Dual BSD/GPL");
70
71
72struct usb_ms_header_descriptor {
73 __u8 bLength;
74 __u8 bDescriptorType;
75 __u8 bDescriptorSubtype;
76 __u8 bcdMSC[2];
77 __le16 wTotalLength;
78} __attribute__ ((packed));
79
80struct usb_ms_endpoint_descriptor {
81 __u8 bLength;
82 __u8 bDescriptorType;
83 __u8 bDescriptorSubtype;
84 __u8 bNumEmbMIDIJack;
85 __u8 baAssocJackID[0];
86} __attribute__ ((packed));
87
86e07d34
TI		 88struct snd_usb_midi_in_endpoint;
89struct snd_usb_midi_out_endpoint;
90struct snd_usb_midi_endpoint;
1da177e4
LT		 91
92struct usb_protocol_ops {
86e07d34
TI		 93 void (*input)(struct snd_usb_midi_in_endpoint*, uint8_t*, int);
94 void (*output)(struct snd_usb_midi_out_endpoint*);
1da177e4 95 void (*output_packet)(struct urb*, uint8_t, uint8_t, uint8_t, uint8_t);
86e07d34
TI		 96 void (*init_out_endpoint)(struct snd_usb_midi_out_endpoint*);
97 void (*finish_out_endpoint)(struct snd_usb_midi_out_endpoint*);
1da177e4
LT		 98};
99
100struct snd_usb_midi {
86e07d34 101 struct snd_usb_audio *chip;
1da177e4 102 struct usb_interface *iface;
86e07d34
TI		 103 const struct snd_usb_audio_quirk *quirk;
104 struct snd_rawmidi *rmidi;
1da177e4
LT		 105 struct usb_protocol_ops* usb_protocol_ops;
106 struct list_head list;
c8846970 107 struct timer_list error_timer;
1da177e4
LT		 108
109 struct snd_usb_midi_endpoint {
86e07d34
TI		 110 struct snd_usb_midi_out_endpoint *out;
111 struct snd_usb_midi_in_endpoint *in;
1da177e4
LT		 112 } endpoints[MIDI_MAX_ENDPOINTS];
113 unsigned long input_triggered;
114};
115
116struct snd_usb_midi_out_endpoint {
86e07d34 117 struct snd_usb_midi* umidi;
1da177e4
LT		 118 struct urb* urb;
119 int urb_active;
120 int max_transfer; /* size of urb buffer */
121 struct tasklet_struct tasklet;
122
123 spinlock_t buffer_lock;
124
125 struct usbmidi_out_port {
86e07d34
TI		 126 struct snd_usb_midi_out_endpoint* ep;
127 struct snd_rawmidi_substream *substream;
1da177e4
LT		 128 int active;
129 uint8_t cable; /* cable number << 4 */
130 uint8_t state;
131#define STATE_UNKNOWN 0
132#define STATE_1PARAM 1
133#define STATE_2PARAM_1 2
134#define STATE_2PARAM_2 3
135#define STATE_SYSEX_0 4
136#define STATE_SYSEX_1 5
137#define STATE_SYSEX_2 6
138 uint8_t data[2];
139 } ports[0x10];
140 int current_port;
141};
142
143struct snd_usb_midi_in_endpoint {
86e07d34 144 struct snd_usb_midi* umidi;
1da177e4
LT		 145 struct urb* urb;
146 struct usbmidi_in_port {
86e07d34 147 struct snd_rawmidi_substream *substream;
d05cc104 148 u8 running_status_length;
1da177e4 149 } ports[0x10];
c8846970
CL		 150 u8 seen_f5;
151 u8 error_resubmit;
1da177e4
LT		 152 int current_port;
153};
154
86e07d34 155static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint* ep);
1da177e4
LT		 156
157static const uint8_t snd_usbmidi_cin_length[] = {
158 0, 0, 2, 3, 3, 1, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1
159};
160
161/*
162 * Submits the URB, with error handling.
163 */
55016f10 164static int snd_usbmidi_submit_urb(struct urb* urb, gfp_t flags)
1da177e4
LT		 165{
166 int err = usb_submit_urb(urb, flags);
167 if (err < 0 && err != -ENODEV)
168 snd_printk(KERN_ERR "usb_submit_urb: %d\n", err);
169 return err;
170}
171
172/*
173 * Error handling for URB completion functions.
174 */
175static int snd_usbmidi_urb_error(int status)
176{
c8846970
CL		 177 switch (status) {
178 /* manually unlinked, or device gone */
179 case -ENOENT:
180 case -ECONNRESET:
181 case -ESHUTDOWN:
182 case -ENODEV:
183 return -ENODEV;
184 /* errors that might occur during unplugging */
38e2bfc9
PZ		 185 case -EPROTO:
186 case -ETIME:
187 case -EILSEQ:
c8846970
CL		 188 return -EIO;
189 default:
190 snd_printk(KERN_ERR "urb status %d\n", status);
191 return 0; /* continue */
192 }
1da177e4
LT		 193}
194
195/*
196 * Receives a chunk of MIDI data.
197 */
86e07d34 198static void snd_usbmidi_input_data(struct snd_usb_midi_in_endpoint* ep, int portidx,
1da177e4
LT		 199 uint8_t* data, int length)
200{
86e07d34 201 struct usbmidi_in_port* port = &ep->ports[portidx];
1da177e4
LT		 202
203 if (!port->substream) {
204 snd_printd("unexpected port %d!\n", portidx);
205 return;
206 }
207 if (!test_bit(port->substream->number, &ep->umidi->input_triggered))
208 return;
209 snd_rawmidi_receive(port->substream, data, length);
210}
211
212#ifdef DUMP_PACKETS
213static void dump_urb(const char *type, const u8 *data, int length)
214{
215 snd_printk(KERN_DEBUG "%s packet: [", type);
216 for (; length > 0; ++data, --length)
217 printk(" %02x", *data);
218 printk(" ]\n");
219}
220#else
221#define dump_urb(type, data, length) /* nothing */
222#endif
223
224/*
225 * Processes the data read from the device.
226 */
7d12e780 227static void snd_usbmidi_in_urb_complete(struct urb* urb)
1da177e4 228{
86e07d34 229 struct snd_usb_midi_in_endpoint* ep = urb->context;
1da177e4
LT		 230
231 if (urb->status == 0) {
232 dump_urb("received", urb->transfer_buffer, urb->actual_length);
233 ep->umidi->usb_protocol_ops->input(ep, urb->transfer_buffer,
234 urb->actual_length);
235 } else {
c8846970
CL		 236 int err = snd_usbmidi_urb_error(urb->status);
237 if (err < 0) {
238 if (err != -ENODEV) {
239 ep->error_resubmit = 1;
240 mod_timer(&ep->umidi->error_timer,
241 jiffies + ERROR_DELAY_JIFFIES);
242 }
1da177e4 243 return;
c8846970 244 }
1da177e4
LT		 245 }
246
3cfc1eb1
CL		 247 urb->dev = ep->umidi->chip->dev;
248 snd_usbmidi_submit_urb(urb, GFP_ATOMIC);
1da177e4
LT		 249}
250
7d12e780 251static void snd_usbmidi_out_urb_complete(struct urb* urb)
1da177e4 252{
86e07d34 253 struct snd_usb_midi_out_endpoint* ep = urb->context;
1da177e4
LT		 254
255 spin_lock(&ep->buffer_lock);
256 ep->urb_active = 0;
257 spin_unlock(&ep->buffer_lock);
258 if (urb->status < 0) {
c8846970
CL		 259 int err = snd_usbmidi_urb_error(urb->status);
260 if (err < 0) {
261 if (err != -ENODEV)
262 mod_timer(&ep->umidi->error_timer,
263 jiffies + ERROR_DELAY_JIFFIES);
1da177e4 264 return;
c8846970 265 }
1da177e4
LT		 266 }
267 snd_usbmidi_do_output(ep);
268}
269
270/*
271 * This is called when some data should be transferred to the device
272 * (from one or more substreams).
273 */
86e07d34 274static void snd_usbmidi_do_output(struct snd_usb_midi_out_endpoint* ep)
1da177e4
LT		 275{
276 struct urb* urb = ep->urb;
277 unsigned long flags;
278
279 spin_lock_irqsave(&ep->buffer_lock, flags);
280 if (ep->urb_active || ep->umidi->chip->shutdown) {
281 spin_unlock_irqrestore(&ep->buffer_lock, flags);
282 return;
283 }
284
285 urb->transfer_buffer_length = 0;
286 ep->umidi->usb_protocol_ops->output(ep);
287
288 if (urb->transfer_buffer_length > 0) {
289 dump_urb("sending", urb->transfer_buffer,
290 urb->transfer_buffer_length);
291 urb->dev = ep->umidi->chip->dev;
292 ep->urb_active = snd_usbmidi_submit_urb(urb, GFP_ATOMIC) >= 0;
293 }
294 spin_unlock_irqrestore(&ep->buffer_lock, flags);
295}
296
297static void snd_usbmidi_out_tasklet(unsigned long data)
298{
86e07d34 299 struct snd_usb_midi_out_endpoint* ep = (struct snd_usb_midi_out_endpoint *) data;
1da177e4
LT		 300
301 snd_usbmidi_do_output(ep);
302}
303
c8846970
CL		 304/* called after transfers had been interrupted due to some USB error */
305static void snd_usbmidi_error_timer(unsigned long data)
306{
86e07d34 307 struct snd_usb_midi *umidi = (struct snd_usb_midi *)data;
c8846970
CL		 308 int i;
309
310 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
86e07d34 311 struct snd_usb_midi_in_endpoint *in = umidi->endpoints[i].in;
c8846970
CL		 312 if (in && in->error_resubmit) {
313 in->error_resubmit = 0;
314 in->urb->dev = umidi->chip->dev;
315 snd_usbmidi_submit_urb(in->urb, GFP_ATOMIC);
316 }
317 if (umidi->endpoints[i].out)
318 snd_usbmidi_do_output(umidi->endpoints[i].out);
319 }
320}
321
1da177e4 322/* helper function to send static data that may not DMA-able */
86e07d34 323static int send_bulk_static_data(struct snd_usb_midi_out_endpoint* ep,
1da177e4
LT		 324 const void *data, int len)
325{
326 int err;
52978be6 327 void *buf = kmemdup(data, len, GFP_KERNEL);
1da177e4
LT		 328 if (!buf)
329 return -ENOMEM;
1da177e4
LT		 330 dump_urb("sending", buf, len);
331 err = usb_bulk_msg(ep->umidi->chip->dev, ep->urb->pipe, buf, len,
332 NULL, 250);
333 kfree(buf);
334 return err;
335}
336
337/*
338 * Standard USB MIDI protocol: see the spec.
339 * Midiman protocol: like the standard protocol, but the control byte is the
340 * fourth byte in each packet, and uses length instead of CIN.
341 */
342
86e07d34 343static void snd_usbmidi_standard_input(struct snd_usb_midi_in_endpoint* ep,
1da177e4
LT		 344 uint8_t* buffer, int buffer_length)
345{
346 int i;
347
348 for (i = 0; i + 3 < buffer_length; i += 4)
349 if (buffer[i] != 0) {
350 int cable = buffer[i] >> 4;
351 int length = snd_usbmidi_cin_length[buffer[i] & 0x0f];
352 snd_usbmidi_input_data(ep, cable, &buffer[i + 1], length);
353 }
354}
355
86e07d34 356static void snd_usbmidi_midiman_input(struct snd_usb_midi_in_endpoint* ep,
1da177e4
LT		 357 uint8_t* buffer, int buffer_length)
358{
359 int i;
360
361 for (i = 0; i + 3 < buffer_length; i += 4)
362 if (buffer[i + 3] != 0) {
363 int port = buffer[i + 3] >> 4;
364 int length = buffer[i + 3] & 3;
365 snd_usbmidi_input_data(ep, port, &buffer[i], length);
366 }
367}
368
d05cc104
CL		 369/*
370 * Buggy M-Audio device: running status on input results in a packet that has
371 * the data bytes but not the status byte and that is marked with CIN 4.
372 */
373static void snd_usbmidi_maudio_broken_running_status_input(
374 struct snd_usb_midi_in_endpoint* ep,
375 uint8_t* buffer, int buffer_length)
376{
377 int i;
378
379 for (i = 0; i + 3 < buffer_length; i += 4)
380 if (buffer[i] != 0) {
381 int cable = buffer[i] >> 4;
382 u8 cin = buffer[i] & 0x0f;
383 struct usbmidi_in_port *port = &ep->ports[cable];
384 int length;
385
386 length = snd_usbmidi_cin_length[cin];
387 if (cin == 0xf && buffer[i + 1] >= 0xf8)
388 ; /* realtime msg: no running status change */
389 else if (cin >= 0x8 && cin <= 0xe)
390 /* channel msg */
391 port->running_status_length = length - 1;
392 else if (cin == 0x4 &&
393 port->running_status_length != 0 &&
394 buffer[i + 1] < 0x80)
395 /* CIN 4 that is not a SysEx */
396 length = port->running_status_length;
397 else
398 /*
399 * All other msgs cannot begin running status.
400 * (A channel msg sent as two or three CIN 0xF
401 * packets could in theory, but this device
402 * doesn't use this format.)
403 */
404 port->running_status_length = 0;
405 snd_usbmidi_input_data(ep, cable, &buffer[i + 1], length);
406 }
407}
408
61870aed
CL		 409/*
410 * CME protocol: like the standard protocol, but SysEx commands are sent as a
411 * single USB packet preceded by a 0x0F byte.
412 */
413static void snd_usbmidi_cme_input(struct snd_usb_midi_in_endpoint *ep,
414 uint8_t *buffer, int buffer_length)
415{
416 if (buffer_length < 2 || (buffer[0] & 0x0f) != 0x0f)
417 snd_usbmidi_standard_input(ep, buffer, buffer_length);
418 else
419 snd_usbmidi_input_data(ep, buffer[0] >> 4,
420 &buffer[1], buffer_length - 1);
421}
422
1da177e4
LT		 423/*
424 * Adds one USB MIDI packet to the output buffer.
425 */
426static void snd_usbmidi_output_standard_packet(struct urb* urb, uint8_t p0,
427 uint8_t p1, uint8_t p2, uint8_t p3)
428{
429
430 uint8_t* buf = (uint8_t*)urb->transfer_buffer + urb->transfer_buffer_length;
431 buf[0] = p0;
432 buf[1] = p1;
433 buf[2] = p2;
434 buf[3] = p3;
435 urb->transfer_buffer_length += 4;
436}
437
438/*
439 * Adds one Midiman packet to the output buffer.
440 */
441static void snd_usbmidi_output_midiman_packet(struct urb* urb, uint8_t p0,
442 uint8_t p1, uint8_t p2, uint8_t p3)
443{
444
445 uint8_t* buf = (uint8_t*)urb->transfer_buffer + urb->transfer_buffer_length;
446 buf[0] = p1;
447 buf[1] = p2;
448 buf[2] = p3;
449 buf[3] = (p0 & 0xf0) | snd_usbmidi_cin_length[p0 & 0x0f];
450 urb->transfer_buffer_length += 4;
451}
452
453/*
454 * Converts MIDI commands to USB MIDI packets.
455 */
86e07d34 456static void snd_usbmidi_transmit_byte(struct usbmidi_out_port* port,
1da177e4
LT		 457 uint8_t b, struct urb* urb)
458{
459 uint8_t p0 = port->cable;
460 void (*output_packet)(struct urb*, uint8_t, uint8_t, uint8_t, uint8_t) =
461 port->ep->umidi->usb_protocol_ops->output_packet;
462
463 if (b >= 0xf8) {
464 output_packet(urb, p0 | 0x0f, b, 0, 0);
465 } else if (b >= 0xf0) {
466 switch (b) {
467 case 0xf0:
468 port->data[0] = b;
469 port->state = STATE_SYSEX_1;
470 break;
471 case 0xf1:
472 case 0xf3:
473 port->data[0] = b;
474 port->state = STATE_1PARAM;
475 break;
476 case 0xf2:
477 port->data[0] = b;
478 port->state = STATE_2PARAM_1;
479 break;
480 case 0xf4:
481 case 0xf5:
482 port->state = STATE_UNKNOWN;
483 break;
484 case 0xf6:
485 output_packet(urb, p0 | 0x05, 0xf6, 0, 0);
486 port->state = STATE_UNKNOWN;
487 break;
488 case 0xf7:
489 switch (port->state) {
490 case STATE_SYSEX_0:
491 output_packet(urb, p0 | 0x05, 0xf7, 0, 0);
492 break;
493 case STATE_SYSEX_1:
494 output_packet(urb, p0 | 0x06, port->data[0], 0xf7, 0);
495 break;
496 case STATE_SYSEX_2:
497 output_packet(urb, p0 | 0x07, port->data[0], port->data[1], 0xf7);
498 break;
499 }
500 port->state = STATE_UNKNOWN;
501 break;
502 }
503 } else if (b >= 0x80) {
504 port->data[0] = b;
505 if (b >= 0xc0 && b <= 0xdf)
506 port->state = STATE_1PARAM;
507 else
508 port->state = STATE_2PARAM_1;
509 } else { /* b < 0x80 */
510 switch (port->state) {
511 case STATE_1PARAM:
512 if (port->data[0] < 0xf0) {
513 p0 |= port->data[0] >> 4;
514 } else {
515 p0 |= 0x02;
516 port->state = STATE_UNKNOWN;
517 }
518 output_packet(urb, p0, port->data[0], b, 0);
519 break;
520 case STATE_2PARAM_1:
521 port->data[1] = b;
522 port->state = STATE_2PARAM_2;
523 break;
524 case STATE_2PARAM_2:
525 if (port->data[0] < 0xf0) {
526 p0 |= port->data[0] >> 4;
527 port->state = STATE_2PARAM_1;
528 } else {
529 p0 |= 0x03;
530 port->state = STATE_UNKNOWN;
531 }
532 output_packet(urb, p0, port->data[0], port->data[1], b);
533 break;
534 case STATE_SYSEX_0:
535 port->data[0] = b;
536 port->state = STATE_SYSEX_1;
537 break;
538 case STATE_SYSEX_1:
539 port->data[1] = b;
540 port->state = STATE_SYSEX_2;
541 break;
542 case STATE_SYSEX_2:
543 output_packet(urb, p0 | 0x04, port->data[0], port->data[1], b);
544 port->state = STATE_SYSEX_0;
545 break;
546 }
547 }
548}
549
86e07d34 550static void snd_usbmidi_standard_output(struct snd_usb_midi_out_endpoint* ep)
1da177e4
LT		 551{
552 struct urb* urb = ep->urb;
553 int p;
554
555 /* FIXME: lower-numbered ports can starve higher-numbered ports */
556 for (p = 0; p < 0x10; ++p) {
86e07d34 557 struct usbmidi_out_port* port = &ep->ports[p];
1da177e4
LT		 558 if (!port->active)
559 continue;
560 while (urb->transfer_buffer_length + 3 < ep->max_transfer) {
561 uint8_t b;
562 if (snd_rawmidi_transmit(port->substream, &b, 1) != 1) {
563 port->active = 0;
564 break;
565 }
566 snd_usbmidi_transmit_byte(port, b, urb);
567 }
568 }
569}
570
571static struct usb_protocol_ops snd_usbmidi_standard_ops = {
572 .input = snd_usbmidi_standard_input,
573 .output = snd_usbmidi_standard_output,
574 .output_packet = snd_usbmidi_output_standard_packet,
575};
576
577static struct usb_protocol_ops snd_usbmidi_midiman_ops = {
578 .input = snd_usbmidi_midiman_input,
579 .output = snd_usbmidi_standard_output,
580 .output_packet = snd_usbmidi_output_midiman_packet,
581};
582
d05cc104
CL		 583static struct usb_protocol_ops snd_usbmidi_maudio_broken_running_status_ops = {
584 .input = snd_usbmidi_maudio_broken_running_status_input,
585 .output = snd_usbmidi_standard_output,
586 .output_packet = snd_usbmidi_output_standard_packet,
587};
588
61870aed
CL		 589static struct usb_protocol_ops snd_usbmidi_cme_ops = {
590 .input = snd_usbmidi_cme_input,
591 .output = snd_usbmidi_standard_output,
592 .output_packet = snd_usbmidi_output_standard_packet,
593};
594
1da177e4
LT		 595/*
596 * Novation USB MIDI protocol: number of data bytes is in the first byte
597 * (when receiving) (+1!) or in the second byte (when sending); data begins
598 * at the third byte.
599 */
600
86e07d34 601static void snd_usbmidi_novation_input(struct snd_usb_midi_in_endpoint* ep,
1da177e4
LT		 602 uint8_t* buffer, int buffer_length)
603{
604 if (buffer_length < 2 || !buffer[0] || buffer_length < buffer[0] + 1)
605 return;
606 snd_usbmidi_input_data(ep, 0, &buffer[2], buffer[0] - 1);
607}
608
86e07d34 609static void snd_usbmidi_novation_output(struct snd_usb_midi_out_endpoint* ep)
1da177e4
LT		 610{
611 uint8_t* transfer_buffer;
612 int count;
613
614 if (!ep->ports[0].active)
615 return;
616 transfer_buffer = ep->urb->transfer_buffer;
617 count = snd_rawmidi_transmit(ep->ports[0].substream,
618 &transfer_buffer[2],
619 ep->max_transfer - 2);
620 if (count < 1) {
621 ep->ports[0].active = 0;
622 return;
623 }
624 transfer_buffer[0] = 0;
625 transfer_buffer[1] = count;
626 ep->urb->transfer_buffer_length = 2 + count;
627}
628
629static struct usb_protocol_ops snd_usbmidi_novation_ops = {
630 .input = snd_usbmidi_novation_input,
631 .output = snd_usbmidi_novation_output,
632};
633
634/*
6155aff8 635 * "raw" protocol: used by the MOTU FastLane.
1da177e4
LT		 636 */
637
86e07d34 638static void snd_usbmidi_raw_input(struct snd_usb_midi_in_endpoint* ep,
6155aff8 639 uint8_t* buffer, int buffer_length)
1da177e4
LT		 640{
641 snd_usbmidi_input_data(ep, 0, buffer, buffer_length);
642}
643
86e07d34 644static void snd_usbmidi_raw_output(struct snd_usb_midi_out_endpoint* ep)
1da177e4
LT		 645{
646 int count;
647
648 if (!ep->ports[0].active)
649 return;
650 count = snd_rawmidi_transmit(ep->ports[0].substream,
651 ep->urb->transfer_buffer,
652 ep->max_transfer);
653 if (count < 1) {
654 ep->ports[0].active = 0;
655 return;
656 }
657 ep->urb->transfer_buffer_length = count;
658}
659
6155aff8
CL		 660static struct usb_protocol_ops snd_usbmidi_raw_ops = {
661 .input = snd_usbmidi_raw_input,
662 .output = snd_usbmidi_raw_output,
1da177e4
LT		 663};
664
665/*
666 * Emagic USB MIDI protocol: raw MIDI with "F5 xx" port switching.
667 */
668
86e07d34 669static void snd_usbmidi_emagic_init_out(struct snd_usb_midi_out_endpoint* ep)
1da177e4
LT		 670{
671 static const u8 init_data[] = {
672 /* initialization magic: "get version" */
673 0xf0,
674 0x00, 0x20, 0x31, /* Emagic */
675 0x64, /* Unitor8 */
676 0x0b, /* version number request */
677 0x00, /* command version */
678 0x00, /* EEPROM, box 0 */
679 0xf7
680 };
681 send_bulk_static_data(ep, init_data, sizeof(init_data));
682 /* while we're at it, pour on more magic */
683 send_bulk_static_data(ep, init_data, sizeof(init_data));
684}
685
86e07d34 686static void snd_usbmidi_emagic_finish_out(struct snd_usb_midi_out_endpoint* ep)
1da177e4
LT		 687{
688 static const u8 finish_data[] = {
689 /* switch to patch mode with last preset */
690 0xf0,
691 0x00, 0x20, 0x31, /* Emagic */
692 0x64, /* Unitor8 */
693 0x10, /* patch switch command */
694 0x00, /* command version */
695 0x7f, /* to all boxes */
696 0x40, /* last preset in EEPROM */
697 0xf7
698 };
699 send_bulk_static_data(ep, finish_data, sizeof(finish_data));
700}
701
86e07d34 702static void snd_usbmidi_emagic_input(struct snd_usb_midi_in_endpoint* ep,
1da177e4
LT		 703 uint8_t* buffer, int buffer_length)
704{
c347e9fc
CL		 705 int i;
706
707 /* FF indicates end of valid data */
708 for (i = 0; i < buffer_length; ++i)
709 if (buffer[i] == 0xff) {
710 buffer_length = i;
711 break;
712 }
1da177e4
LT		 713
714 /* handle F5 at end of last buffer */
715 if (ep->seen_f5)
716 goto switch_port;
717
718 while (buffer_length > 0) {
1da177e4
LT		 719 /* determine size of data until next F5 */
720 for (i = 0; i < buffer_length; ++i)
721 if (buffer[i] == 0xf5)
722 break;
723 snd_usbmidi_input_data(ep, ep->current_port, buffer, i);
724 buffer += i;
725 buffer_length -= i;
726
727 if (buffer_length <= 0)
728 break;
729 /* assert(buffer[0] == 0xf5); */
730 ep->seen_f5 = 1;
731 ++buffer;
732 --buffer_length;
733
734 switch_port:
735 if (buffer_length <= 0)
736 break;
737 if (buffer[0] < 0x80) {
738 ep->current_port = (buffer[0] - 1) & 15;
739 ++buffer;
740 --buffer_length;
741 }
742 ep->seen_f5 = 0;
743 }
744}
745
86e07d34 746static void snd_usbmidi_emagic_output(struct snd_usb_midi_out_endpoint* ep)
1da177e4
LT		 747{
748 int port0 = ep->current_port;
749 uint8_t* buf = ep->urb->transfer_buffer;
750 int buf_free = ep->max_transfer;
751 int length, i;
752
753 for (i = 0; i < 0x10; ++i) {
754 /* round-robin, starting at the last current port */
755 int portnum = (port0 + i) & 15;
86e07d34 756 struct usbmidi_out_port* port = &ep->ports[portnum];
1da177e4
LT		 757
758 if (!port->active)
759 continue;
760 if (snd_rawmidi_transmit_peek(port->substream, buf, 1) != 1) {
761 port->active = 0;
762 continue;
763 }
764
765 if (portnum != ep->current_port) {
766 if (buf_free < 2)
767 break;
768 ep->current_port = portnum;
769 buf[0] = 0xf5;
770 buf[1] = (portnum + 1) & 15;
771 buf += 2;
772 buf_free -= 2;
773 }
774
775 if (buf_free < 1)
776 break;
777 length = snd_rawmidi_transmit(port->substream, buf, buf_free);
778 if (length > 0) {
779 buf += length;
780 buf_free -= length;
781 if (buf_free < 1)
782 break;
783 }
784 }
c347e9fc
CL		 785 if (buf_free < ep->max_transfer && buf_free > 0) {
786 *buf = 0xff;
787 --buf_free;
788 }
1da177e4
LT		 789 ep->urb->transfer_buffer_length = ep->max_transfer - buf_free;
790}
791
792static struct usb_protocol_ops snd_usbmidi_emagic_ops = {
793 .input = snd_usbmidi_emagic_input,
794 .output = snd_usbmidi_emagic_output,
795 .init_out_endpoint = snd_usbmidi_emagic_init_out,
796 .finish_out_endpoint = snd_usbmidi_emagic_finish_out,
797};
798
799
86e07d34 800static int snd_usbmidi_output_open(struct snd_rawmidi_substream *substream)
1da177e4 801{
86e07d34
TI		 802 struct snd_usb_midi* umidi = substream->rmidi->private_data;
803 struct usbmidi_out_port* port = NULL;
1da177e4
LT		 804 int i, j;
805
806 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
807 if (umidi->endpoints[i].out)
808 for (j = 0; j < 0x10; ++j)
809 if (umidi->endpoints[i].out->ports[j].substream == substream) {
810 port = &umidi->endpoints[i].out->ports[j];
811 break;
812 }
813 if (!port) {
814 snd_BUG();
815 return -ENXIO;
816 }
817 substream->runtime->private_data = port;
818 port->state = STATE_UNKNOWN;
819 return 0;
820}
821
86e07d34 822static int snd_usbmidi_output_close(struct snd_rawmidi_substream *substream)
1da177e4
LT		 823{
824 return 0;
825}
826
86e07d34 827static void snd_usbmidi_output_trigger(struct snd_rawmidi_substream *substream, int up)
1da177e4 828{
86e07d34 829 struct usbmidi_out_port* port = (struct usbmidi_out_port*)substream->runtime->private_data;
1da177e4
LT		 830
831 port->active = up;
832 if (up) {
833 if (port->ep->umidi->chip->shutdown) {
834 /* gobble up remaining bytes to prevent wait in
835 * snd_rawmidi_drain_output */
836 while (!snd_rawmidi_transmit_empty(substream))
837 snd_rawmidi_transmit_ack(substream, 1);
838 return;
839 }
840 tasklet_hi_schedule(&port->ep->tasklet);
841 }
842}
843
86e07d34 844static int snd_usbmidi_input_open(struct snd_rawmidi_substream *substream)
1da177e4
LT		 845{
846 return 0;
847}
848
86e07d34 849static int snd_usbmidi_input_close(struct snd_rawmidi_substream *substream)
1da177e4
LT		 850{
851 return 0;
852}
853
86e07d34 854static void snd_usbmidi_input_trigger(struct snd_rawmidi_substream *substream, int up)
1da177e4 855{
86e07d34 856 struct snd_usb_midi* umidi = substream->rmidi->private_data;
1da177e4
LT		 857
858 if (up)
859 set_bit(substream->number, &umidi->input_triggered);
860 else
861 clear_bit(substream->number, &umidi->input_triggered);
862}
863
86e07d34 864static struct snd_rawmidi_ops snd_usbmidi_output_ops = {
1da177e4
LT		 865 .open = snd_usbmidi_output_open,
866 .close = snd_usbmidi_output_close,
867 .trigger = snd_usbmidi_output_trigger,
868};
869
86e07d34 870static struct snd_rawmidi_ops snd_usbmidi_input_ops = {
1da177e4
LT		 871 .open = snd_usbmidi_input_open,
872 .close = snd_usbmidi_input_close,
873 .trigger = snd_usbmidi_input_trigger
874};
875
876/*
877 * Frees an input endpoint.
878 * May be called when ep hasn't been initialized completely.
879 */
86e07d34 880static void snd_usbmidi_in_endpoint_delete(struct snd_usb_midi_in_endpoint* ep)
1da177e4
LT		 881{
882 if (ep->urb) {
55851f73
CL		 883 usb_buffer_free(ep->umidi->chip->dev,
884 ep->urb->transfer_buffer_length,
885 ep->urb->transfer_buffer,
886 ep->urb->transfer_dma);
1da177e4
LT		 887 usb_free_urb(ep->urb);
888 }
889 kfree(ep);
890}
891
892/*
893 * Creates an input endpoint.
894 */
86e07d34
TI		 895static int snd_usbmidi_in_endpoint_create(struct snd_usb_midi* umidi,
896 struct snd_usb_midi_endpoint_info* ep_info,
897 struct snd_usb_midi_endpoint* rep)
1da177e4 898{
86e07d34 899 struct snd_usb_midi_in_endpoint* ep;
1da177e4
LT		 900 void* buffer;
901 unsigned int pipe;
902 int length;
903
904 rep->in = NULL;
561b220a 905 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1da177e4
LT		 906 if (!ep)
907 return -ENOMEM;
908 ep->umidi = umidi;
909
910 ep->urb = usb_alloc_urb(0, GFP_KERNEL);
911 if (!ep->urb) {
912 snd_usbmidi_in_endpoint_delete(ep);
913 return -ENOMEM;
914 }
915 if (ep_info->in_interval)
916 pipe = usb_rcvintpipe(umidi->chip->dev, ep_info->in_ep);
917 else
918 pipe = usb_rcvbulkpipe(umidi->chip->dev, ep_info->in_ep);
919 length = usb_maxpacket(umidi->chip->dev, pipe, 0);
55851f73
CL		 920 buffer = usb_buffer_alloc(umidi->chip->dev, length, GFP_KERNEL,
921 &ep->urb->transfer_dma);
1da177e4
LT		 922 if (!buffer) {
923 snd_usbmidi_in_endpoint_delete(ep);
924 return -ENOMEM;
925 }
926 if (ep_info->in_interval)
3527a008
CL		 927 usb_fill_int_urb(ep->urb, umidi->chip->dev, pipe, buffer,
928 length, snd_usbmidi_in_urb_complete, ep,
929 ep_info->in_interval);
1da177e4 930 else
3527a008
CL		 931 usb_fill_bulk_urb(ep->urb, umidi->chip->dev, pipe, buffer,
932 length, snd_usbmidi_in_urb_complete, ep);
55851f73 933 ep->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1da177e4
LT		 934
935 rep->in = ep;
936 return 0;
937}
938
939static unsigned int snd_usbmidi_count_bits(unsigned int x)
940{
62f09c3d 941 unsigned int bits;
1da177e4 942
62f09c3d
CL		 943 for (bits = 0; x; ++bits)
944 x &= x - 1;
1da177e4
LT		 945 return bits;
946}
947
948/*
949 * Frees an output endpoint.
950 * May be called when ep hasn't been initialized completely.
951 */
86e07d34 952static void snd_usbmidi_out_endpoint_delete(struct snd_usb_midi_out_endpoint* ep)
1da177e4 953{
1da177e4 954 if (ep->urb) {
55851f73
CL		 955 usb_buffer_free(ep->umidi->chip->dev, ep->max_transfer,
956 ep->urb->transfer_buffer,
957 ep->urb->transfer_dma);
1da177e4
LT		 958 usb_free_urb(ep->urb);
959 }
960 kfree(ep);
961}
962
963/*
964 * Creates an output endpoint, and initializes output ports.
965 */
86e07d34
TI		 966static int snd_usbmidi_out_endpoint_create(struct snd_usb_midi* umidi,
967 struct snd_usb_midi_endpoint_info* ep_info,
968 struct snd_usb_midi_endpoint* rep)
1da177e4 969{
86e07d34 970 struct snd_usb_midi_out_endpoint* ep;
1da177e4
LT		 971 int i;
972 unsigned int pipe;
973 void* buffer;
974
975 rep->out = NULL;
561b220a 976 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1da177e4
LT		 977 if (!ep)
978 return -ENOMEM;
979 ep->umidi = umidi;
980
981 ep->urb = usb_alloc_urb(0, GFP_KERNEL);
982 if (!ep->urb) {
983 snd_usbmidi_out_endpoint_delete(ep);
984 return -ENOMEM;
985 }
a6a712ae
CL		 986 if (ep_info->out_interval)
987 pipe = usb_sndintpipe(umidi->chip->dev, ep_info->out_ep);
988 else
989 pipe = usb_sndbulkpipe(umidi->chip->dev, ep_info->out_ep);
490cbd92
CL		 990 if (umidi->chip->usb_id == USB_ID(0x0a92, 0x1020)) /* ESI M4U */
991 /* FIXME: we need more URBs to get reasonable bandwidth here: */
992 ep->max_transfer = 4;
993 else
994 ep->max_transfer = usb_maxpacket(umidi->chip->dev, pipe, 1);
55851f73
CL		 995 buffer = usb_buffer_alloc(umidi->chip->dev, ep->max_transfer,
996 GFP_KERNEL, &ep->urb->transfer_dma);
1da177e4
LT		 997 if (!buffer) {
998 snd_usbmidi_out_endpoint_delete(ep);
999 return -ENOMEM;
1000 }
a6a712ae
CL		 1001 if (ep_info->out_interval)
1002 usb_fill_int_urb(ep->urb, umidi->chip->dev, pipe, buffer,
1003 ep->max_transfer, snd_usbmidi_out_urb_complete,
1004 ep, ep_info->out_interval);
1005 else
1006 usb_fill_bulk_urb(ep->urb, umidi->chip->dev,
1007 pipe, buffer, ep->max_transfer,
1008 snd_usbmidi_out_urb_complete, ep);
55851f73 1009 ep->urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1da177e4
LT		 1010
1011 spin_lock_init(&ep->buffer_lock);
1012 tasklet_init(&ep->tasklet, snd_usbmidi_out_tasklet, (unsigned long)ep);
1013
1014 for (i = 0; i < 0x10; ++i)
1015 if (ep_info->out_cables & (1 << i)) {
1016 ep->ports[i].ep = ep;
1017 ep->ports[i].cable = i << 4;
1018 }
1019
1020 if (umidi->usb_protocol_ops->init_out_endpoint)
1021 umidi->usb_protocol_ops->init_out_endpoint(ep);
1022
1023 rep->out = ep;
1024 return 0;
1025}
1026
1027/*
1028 * Frees everything.
1029 */
86e07d34 1030static void snd_usbmidi_free(struct snd_usb_midi* umidi)
1da177e4
LT		 1031{
1032 int i;
1033
1034 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
86e07d34 1035 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
1da177e4
LT		 1036 if (ep->out)
1037 snd_usbmidi_out_endpoint_delete(ep->out);
1038 if (ep->in)
1039 snd_usbmidi_in_endpoint_delete(ep->in);
1040 }
1041 kfree(umidi);
1042}
1043
1044/*
1045 * Unlinks all URBs (must be done before the usb_device is deleted).
1046 */
ee733397 1047void snd_usbmidi_disconnect(struct list_head* p)
1da177e4 1048{
86e07d34 1049 struct snd_usb_midi* umidi;
1da177e4
LT		 1050 int i;
1051
86e07d34 1052 umidi = list_entry(p, struct snd_usb_midi, list);
c8846970 1053 del_timer_sync(&umidi->error_timer);
1da177e4 1054 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
86e07d34 1055 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
c8846970
CL		 1056 if (ep->out)
1057 tasklet_kill(&ep->out->tasklet);
1da177e4
LT		 1058 if (ep->out && ep->out->urb) {
1059 usb_kill_urb(ep->out->urb);
1060 if (umidi->usb_protocol_ops->finish_out_endpoint)
1061 umidi->usb_protocol_ops->finish_out_endpoint(ep->out);
1062 }
f5e135af 1063 if (ep->in)
1da177e4
LT		 1064 usb_kill_urb(ep->in->urb);
1065 }
1066}
1067
86e07d34 1068static void snd_usbmidi_rawmidi_free(struct snd_rawmidi *rmidi)
1da177e4 1069{
86e07d34 1070 struct snd_usb_midi* umidi = rmidi->private_data;
1da177e4
LT		 1071 snd_usbmidi_free(umidi);
1072}
1073
86e07d34 1074static struct snd_rawmidi_substream *snd_usbmidi_find_substream(struct snd_usb_midi* umidi,
1da177e4
LT		 1075 int stream, int number)
1076{
1077 struct list_head* list;
1078
1079 list_for_each(list, &umidi->rmidi->streams[stream].substreams) {
86e07d34 1080 struct snd_rawmidi_substream *substream = list_entry(list, struct snd_rawmidi_substream, list);
1da177e4
LT		 1081 if (substream->number == number)
1082 return substream;
1083 }
1084 return NULL;
1085}
1086
1087/*
1088 * This list specifies names for ports that do not fit into the standard
1089 * "(product) MIDI (n)" schema because they aren't external MIDI ports,
1090 * such as internal control or synthesizer ports.
1091 */
a7b928ac 1092static struct port_info {
27d10f56 1093 u32 id;
a7b928ac
CL		 1094 short int port;
1095 short int voices;
1096 const char *name;
1097 unsigned int seq_flags;
1098} snd_usbmidi_port_info[] = {
1099#define PORT_INFO(vendor, product, num, name_, voices_, flags) \
1100 { .id = USB_ID(vendor, product), \
1101 .port = num, .voices = voices_, \
1102 .name = name_, .seq_flags = flags }
1103#define EXTERNAL_PORT(vendor, product, num, name) \
1104 PORT_INFO(vendor, product, num, name, 0, \
1105 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1106 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1107 SNDRV_SEQ_PORT_TYPE_PORT)
1108#define CONTROL_PORT(vendor, product, num, name) \
1109 PORT_INFO(vendor, product, num, name, 0, \
1110 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1111 SNDRV_SEQ_PORT_TYPE_HARDWARE)
1112#define ROLAND_SYNTH_PORT(vendor, product, num, name, voices) \
1113 PORT_INFO(vendor, product, num, name, voices, \
1114 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1115 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1116 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1117 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1118 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1119 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1120 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1121#define SOUNDCANVAS_PORT(vendor, product, num, name, voices) \
1122 PORT_INFO(vendor, product, num, name, voices, \
1123 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1124 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1125 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1126 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1127 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1128 SNDRV_SEQ_PORT_TYPE_MIDI_MT32 | \
1129 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1130 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1da177e4 1131 /* Roland UA-100 */
a7b928ac 1132 CONTROL_PORT(0x0582, 0x0000, 2, "%s Control"),
1da177e4 1133 /* Roland SC-8850 */
a7b928ac
CL		 1134 SOUNDCANVAS_PORT(0x0582, 0x0003, 0, "%s Part A", 128),
1135 SOUNDCANVAS_PORT(0x0582, 0x0003, 1, "%s Part B", 128),
1136 SOUNDCANVAS_PORT(0x0582, 0x0003, 2, "%s Part C", 128),
1137 SOUNDCANVAS_PORT(0x0582, 0x0003, 3, "%s Part D", 128),
1138 EXTERNAL_PORT(0x0582, 0x0003, 4, "%s MIDI 1"),
1139 EXTERNAL_PORT(0x0582, 0x0003, 5, "%s MIDI 2"),
1da177e4 1140 /* Roland U-8 */
a7b928ac
CL		 1141 EXTERNAL_PORT(0x0582, 0x0004, 0, "%s MIDI"),
1142 CONTROL_PORT(0x0582, 0x0004, 1, "%s Control"),
1da177e4 1143 /* Roland SC-8820 */
a7b928ac
CL		 1144 SOUNDCANVAS_PORT(0x0582, 0x0007, 0, "%s Part A", 64),
1145 SOUNDCANVAS_PORT(0x0582, 0x0007, 1, "%s Part B", 64),
1146 EXTERNAL_PORT(0x0582, 0x0007, 2, "%s MIDI"),
1da177e4 1147 /* Roland SK-500 */
a7b928ac
CL		 1148 SOUNDCANVAS_PORT(0x0582, 0x000b, 0, "%s Part A", 64),
1149 SOUNDCANVAS_PORT(0x0582, 0x000b, 1, "%s Part B", 64),
1150 EXTERNAL_PORT(0x0582, 0x000b, 2, "%s MIDI"),
1da177e4 1151 /* Roland SC-D70 */
a7b928ac
CL		 1152 SOUNDCANVAS_PORT(0x0582, 0x000c, 0, "%s Part A", 64),
1153 SOUNDCANVAS_PORT(0x0582, 0x000c, 1, "%s Part B", 64),
1154 EXTERNAL_PORT(0x0582, 0x000c, 2, "%s MIDI"),
1da177e4 1155 /* Edirol UM-880 */
a7b928ac 1156 CONTROL_PORT(0x0582, 0x0014, 8, "%s Control"),
1da177e4 1157 /* Edirol SD-90 */
a7b928ac
CL		 1158 ROLAND_SYNTH_PORT(0x0582, 0x0016, 0, "%s Part A", 128),
1159 ROLAND_SYNTH_PORT(0x0582, 0x0016, 1, "%s Part B", 128),
1160 EXTERNAL_PORT(0x0582, 0x0016, 2, "%s MIDI 1"),
1161 EXTERNAL_PORT(0x0582, 0x0016, 3, "%s MIDI 2"),
1da177e4 1162 /* Edirol UM-550 */
a7b928ac 1163 CONTROL_PORT(0x0582, 0x0023, 5, "%s Control"),
1da177e4 1164 /* Edirol SD-20 */
a7b928ac
CL		 1165 ROLAND_SYNTH_PORT(0x0582, 0x0027, 0, "%s Part A", 64),
1166 ROLAND_SYNTH_PORT(0x0582, 0x0027, 1, "%s Part B", 64),
1167 EXTERNAL_PORT(0x0582, 0x0027, 2, "%s MIDI"),
1da177e4 1168 /* Edirol SD-80 */
a7b928ac
CL		 1169 ROLAND_SYNTH_PORT(0x0582, 0x0029, 0, "%s Part A", 128),
1170 ROLAND_SYNTH_PORT(0x0582, 0x0029, 1, "%s Part B", 128),
1171 EXTERNAL_PORT(0x0582, 0x0029, 2, "%s MIDI 1"),
1172 EXTERNAL_PORT(0x0582, 0x0029, 3, "%s MIDI 2"),
1da177e4 1173 /* Edirol UA-700 */
a7b928ac
CL		 1174 EXTERNAL_PORT(0x0582, 0x002b, 0, "%s MIDI"),
1175 CONTROL_PORT(0x0582, 0x002b, 1, "%s Control"),
1da177e4 1176 /* Roland VariOS */
a7b928ac
CL		 1177 EXTERNAL_PORT(0x0582, 0x002f, 0, "%s MIDI"),
1178 EXTERNAL_PORT(0x0582, 0x002f, 1, "%s External MIDI"),
1179 EXTERNAL_PORT(0x0582, 0x002f, 2, "%s Sync"),
1da177e4 1180 /* Edirol PCR */
a7b928ac
CL		 1181 EXTERNAL_PORT(0x0582, 0x0033, 0, "%s MIDI"),
1182 EXTERNAL_PORT(0x0582, 0x0033, 1, "%s 1"),
1183 EXTERNAL_PORT(0x0582, 0x0033, 2, "%s 2"),
1da177e4 1184 /* BOSS GS-10 */
a7b928ac
CL		 1185 EXTERNAL_PORT(0x0582, 0x003b, 0, "%s MIDI"),
1186 CONTROL_PORT(0x0582, 0x003b, 1, "%s Control"),
1da177e4 1187 /* Edirol UA-1000 */
a7b928ac
CL		 1188 EXTERNAL_PORT(0x0582, 0x0044, 0, "%s MIDI"),
1189 CONTROL_PORT(0x0582, 0x0044, 1, "%s Control"),
1da177e4 1190 /* Edirol UR-80 */
a7b928ac
CL		 1191 EXTERNAL_PORT(0x0582, 0x0048, 0, "%s MIDI"),
1192 EXTERNAL_PORT(0x0582, 0x0048, 1, "%s 1"),
1193 EXTERNAL_PORT(0x0582, 0x0048, 2, "%s 2"),
1da177e4 1194 /* Edirol PCR-A */
a7b928ac
CL		 1195 EXTERNAL_PORT(0x0582, 0x004d, 0, "%s MIDI"),
1196 EXTERNAL_PORT(0x0582, 0x004d, 1, "%s 1"),
1197 EXTERNAL_PORT(0x0582, 0x004d, 2, "%s 2"),
7c79b768 1198 /* Edirol UM-3EX */
a7b928ac 1199 CONTROL_PORT(0x0582, 0x009a, 3, "%s Control"),
1da177e4 1200 /* M-Audio MidiSport 8x8 */
a7b928ac
CL		 1201 CONTROL_PORT(0x0763, 0x1031, 8, "%s Control"),
1202 CONTROL_PORT(0x0763, 0x1033, 8, "%s Control"),
1da177e4 1203 /* MOTU Fastlane */
a7b928ac
CL		 1204 EXTERNAL_PORT(0x07fd, 0x0001, 0, "%s MIDI A"),
1205 EXTERNAL_PORT(0x07fd, 0x0001, 1, "%s MIDI B"),
1da177e4 1206 /* Emagic Unitor8/AMT8/MT4 */
a7b928ac
CL		 1207 EXTERNAL_PORT(0x086a, 0x0001, 8, "%s Broadcast"),
1208 EXTERNAL_PORT(0x086a, 0x0002, 8, "%s Broadcast"),
1209 EXTERNAL_PORT(0x086a, 0x0003, 4, "%s Broadcast"),
1da177e4
LT		 1210};
1211
a7b928ac
CL		 1212static struct port_info *find_port_info(struct snd_usb_midi* umidi, int number)
1213{
1214 int i;
1215
1216 for (i = 0; i < ARRAY_SIZE(snd_usbmidi_port_info); ++i) {
1217 if (snd_usbmidi_port_info[i].id == umidi->chip->usb_id &&
1218 snd_usbmidi_port_info[i].port == number)
1219 return &snd_usbmidi_port_info[i];
1220 }
1221 return NULL;
1222}
1223
1224static void snd_usbmidi_get_port_info(struct snd_rawmidi *rmidi, int number,
1225 struct snd_seq_port_info *seq_port_info)
1226{
1227 struct snd_usb_midi *umidi = rmidi->private_data;
1228 struct port_info *port_info;
1229
1230 /* TODO: read port flags from descriptors */
1231 port_info = find_port_info(umidi, number);
1232 if (port_info) {
1233 seq_port_info->type = port_info->seq_flags;
1234 seq_port_info->midi_voices = port_info->voices;
1235 }
1236}
1237
86e07d34 1238static void snd_usbmidi_init_substream(struct snd_usb_midi* umidi,
1da177e4 1239 int stream, int number,
86e07d34 1240 struct snd_rawmidi_substream ** rsubstream)
1da177e4 1241{
a7b928ac 1242 struct port_info *port_info;
1da177e4
LT		 1243 const char *name_format;
1244
86e07d34 1245 struct snd_rawmidi_substream *substream = snd_usbmidi_find_substream(umidi, stream, number);
1da177e4
LT		 1246 if (!substream) {
1247 snd_printd(KERN_ERR "substream %d:%d not found\n", stream, number);
1248 return;
1249 }
1250
1251 /* TODO: read port name from jack descriptor */
a7b928ac
CL		 1252 port_info = find_port_info(umidi, number);
1253 name_format = port_info ? port_info->name : "%s MIDI %d";
1da177e4
LT		 1254 snprintf(substream->name, sizeof(substream->name),
1255 name_format, umidi->chip->card->shortname, number + 1);
1256
1257 *rsubstream = substream;
1258}
1259
1260/*
1261 * Creates the endpoints and their ports.
1262 */
86e07d34
TI		 1263static int snd_usbmidi_create_endpoints(struct snd_usb_midi* umidi,
1264 struct snd_usb_midi_endpoint_info* endpoints)
1da177e4
LT		 1265{
1266 int i, j, err;
1267 int out_ports = 0, in_ports = 0;
1268
1269 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1270 if (endpoints[i].out_cables) {
1271 err = snd_usbmidi_out_endpoint_create(umidi, &endpoints[i],
1272 &umidi->endpoints[i]);
1273 if (err < 0)
1274 return err;
1275 }
1276 if (endpoints[i].in_cables) {
1277 err = snd_usbmidi_in_endpoint_create(umidi, &endpoints[i],
1278 &umidi->endpoints[i]);
1279 if (err < 0)
1280 return err;
1281 }
1282
1283 for (j = 0; j < 0x10; ++j) {
1284 if (endpoints[i].out_cables & (1 << j)) {
1285 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_OUTPUT, out_ports,
1286 &umidi->endpoints[i].out->ports[j].substream);
1287 ++out_ports;
1288 }
1289 if (endpoints[i].in_cables & (1 << j)) {
1290 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_INPUT, in_ports,
1291 &umidi->endpoints[i].in->ports[j].substream);
1292 ++in_ports;
1293 }
1294 }
1295 }
1296 snd_printdd(KERN_INFO "created %d output and %d input ports\n",
1297 out_ports, in_ports);
1298 return 0;
1299}
1300
1301/*
1302 * Returns MIDIStreaming device capabilities.
1303 */
86e07d34
TI		 1304static int snd_usbmidi_get_ms_info(struct snd_usb_midi* umidi,
1305 struct snd_usb_midi_endpoint_info* endpoints)
1da177e4
LT		 1306{
1307 struct usb_interface* intf;
1308 struct usb_host_interface *hostif;
1309 struct usb_interface_descriptor* intfd;
1310 struct usb_ms_header_descriptor* ms_header;
1311 struct usb_host_endpoint *hostep;
1312 struct usb_endpoint_descriptor* ep;
1313 struct usb_ms_endpoint_descriptor* ms_ep;
1314 int i, epidx;
1315
1316 intf = umidi->iface;
1317 if (!intf)
1318 return -ENXIO;
1319 hostif = &intf->altsetting[0];
1320 intfd = get_iface_desc(hostif);
1321 ms_header = (struct usb_ms_header_descriptor*)hostif->extra;
1322 if (hostif->extralen >= 7 &&
1323 ms_header->bLength >= 7 &&
1324 ms_header->bDescriptorType == USB_DT_CS_INTERFACE &&
1325 ms_header->bDescriptorSubtype == HEADER)
1326 snd_printdd(KERN_INFO "MIDIStreaming version %02x.%02x\n",
1327 ms_header->bcdMSC[1], ms_header->bcdMSC[0]);
1328 else
1329 snd_printk(KERN_WARNING "MIDIStreaming interface descriptor not found\n");
1330
1331 epidx = 0;
1332 for (i = 0; i < intfd->bNumEndpoints; ++i) {
1333 hostep = &hostif->endpoint[i];
1334 ep = get_ep_desc(hostep);
1335 if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK &&
1336 (ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
1337 continue;
1338 ms_ep = (struct usb_ms_endpoint_descriptor*)hostep->extra;
1339 if (hostep->extralen < 4 ||
1340 ms_ep->bLength < 4 ||
1341 ms_ep->bDescriptorType != USB_DT_CS_ENDPOINT ||
1342 ms_ep->bDescriptorSubtype != MS_GENERAL)
1343 continue;
1344 if ((ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) {
1345 if (endpoints[epidx].out_ep) {
1346 if (++epidx >= MIDI_MAX_ENDPOINTS) {
1347 snd_printk(KERN_WARNING "too many endpoints\n");
1348 break;
1349 }
1350 }
1351 endpoints[epidx].out_ep = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1352 if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)
1353 endpoints[epidx].out_interval = ep->bInterval;
1354 endpoints[epidx].out_cables = (1 << ms_ep->bNumEmbMIDIJack) - 1;
1355 snd_printdd(KERN_INFO "EP %02X: %d jack(s)\n",
1356 ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1357 } else {
1358 if (endpoints[epidx].in_ep) {
1359 if (++epidx >= MIDI_MAX_ENDPOINTS) {
1360 snd_printk(KERN_WARNING "too many endpoints\n");
1361 break;
1362 }
1363 }
1364 endpoints[epidx].in_ep = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1365 if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)
1366 endpoints[epidx].in_interval = ep->bInterval;
1367 endpoints[epidx].in_cables = (1 << ms_ep->bNumEmbMIDIJack) - 1;
1368 snd_printdd(KERN_INFO "EP %02X: %d jack(s)\n",
1369 ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1370 }
1371 }
1372 return 0;
1373}
1374
1375/*
1376 * On Roland devices, use the second alternate setting to be able to use
1377 * the interrupt input endpoint.
1378 */
86e07d34 1379static void snd_usbmidi_switch_roland_altsetting(struct snd_usb_midi* umidi)
1da177e4
LT		 1380{
1381 struct usb_interface* intf;
1382 struct usb_host_interface *hostif;
1383 struct usb_interface_descriptor* intfd;
1384
1385 intf = umidi->iface;
1386 if (!intf || intf->num_altsetting != 2)
1387 return;
1388
1389 hostif = &intf->altsetting[1];
1390 intfd = get_iface_desc(hostif);
1391 if (intfd->bNumEndpoints != 2 ||
1392 (get_endpoint(hostif, 0)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK ||
1393 (get_endpoint(hostif, 1)->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
1394 return;
1395
1396 snd_printdd(KERN_INFO "switching to altsetting %d with int ep\n",
1397 intfd->bAlternateSetting);
1398 usb_set_interface(umidi->chip->dev, intfd->bInterfaceNumber,
1399 intfd->bAlternateSetting);
1400}
1401
1402/*
1403 * Try to find any usable endpoints in the interface.
1404 */
86e07d34
TI		 1405static int snd_usbmidi_detect_endpoints(struct snd_usb_midi* umidi,
1406 struct snd_usb_midi_endpoint_info* endpoint,
1da177e4
LT		 1407 int max_endpoints)
1408{
1409 struct usb_interface* intf;
1410 struct usb_host_interface *hostif;
1411 struct usb_interface_descriptor* intfd;
1412 struct usb_endpoint_descriptor* epd;
1413 int i, out_eps = 0, in_eps = 0;
1414
27d10f56 1415 if (USB_ID_VENDOR(umidi->chip->usb_id) == 0x0582)
1da177e4
LT		 1416 snd_usbmidi_switch_roland_altsetting(umidi);
1417
c1ab5d59
CL		 1418 if (endpoint[0].out_ep || endpoint[0].in_ep)
1419 return 0;
1420
1da177e4
LT		 1421 intf = umidi->iface;
1422 if (!intf || intf->num_altsetting < 1)
1423 return -ENOENT;
1424 hostif = intf->cur_altsetting;
1425 intfd = get_iface_desc(hostif);
1426
1427 for (i = 0; i < intfd->bNumEndpoints; ++i) {
1428 epd = get_endpoint(hostif, i);
1429 if ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK &&
1430 (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT)
1431 continue;
1432 if (out_eps < max_endpoints &&
1433 (epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) {
1434 endpoint[out_eps].out_ep = epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1435 if ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)
1436 endpoint[out_eps].out_interval = epd->bInterval;
1437 ++out_eps;
1438 }
1439 if (in_eps < max_endpoints &&
1440 (epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN) {
1441 endpoint[in_eps].in_ep = epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1442 if ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)
1443 endpoint[in_eps].in_interval = epd->bInterval;
1444 ++in_eps;
1445 }
1446 }
1447 return (out_eps || in_eps) ? 0 : -ENOENT;
1448}
1449
1450/*
1451 * Detects the endpoints for one-port-per-endpoint protocols.
1452 */
86e07d34
TI		 1453static int snd_usbmidi_detect_per_port_endpoints(struct snd_usb_midi* umidi,
1454 struct snd_usb_midi_endpoint_info* endpoints)
1da177e4
LT		 1455{
1456 int err, i;
1457
1458 err = snd_usbmidi_detect_endpoints(umidi, endpoints, MIDI_MAX_ENDPOINTS);
1459 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1460 if (endpoints[i].out_ep)
1461 endpoints[i].out_cables = 0x0001;
1462 if (endpoints[i].in_ep)
1463 endpoints[i].in_cables = 0x0001;
1464 }
1465 return err;
1466}
1467
1468/*
1469 * Detects the endpoints and ports of Yamaha devices.
1470 */
86e07d34
TI		 1471static int snd_usbmidi_detect_yamaha(struct snd_usb_midi* umidi,
1472 struct snd_usb_midi_endpoint_info* endpoint)
1da177e4
LT		 1473{
1474 struct usb_interface* intf;
1475 struct usb_host_interface *hostif;
1476 struct usb_interface_descriptor* intfd;
1477 uint8_t* cs_desc;
1478
1479 intf = umidi->iface;
1480 if (!intf)
1481 return -ENOENT;
1482 hostif = intf->altsetting;
1483 intfd = get_iface_desc(hostif);
1484 if (intfd->bNumEndpoints < 1)
1485 return -ENOENT;
1486
1487 /*
1488 * For each port there is one MIDI_IN/OUT_JACK descriptor, not
1489 * necessarily with any useful contents. So simply count 'em.
1490 */
1491 for (cs_desc = hostif->extra;
1492 cs_desc < hostif->extra + hostif->extralen && cs_desc[0] >= 2;
1493 cs_desc += cs_desc[0]) {
c4a87ef4 1494 if (cs_desc[1] == USB_DT_CS_INTERFACE) {
1da177e4
LT		 1495 if (cs_desc[2] == MIDI_IN_JACK)
1496 endpoint->in_cables = (endpoint->in_cables << 1) | 1;
1497 else if (cs_desc[2] == MIDI_OUT_JACK)
1498 endpoint->out_cables = (endpoint->out_cables << 1) | 1;
1499 }
1500 }
1501 if (!endpoint->in_cables && !endpoint->out_cables)
1502 return -ENOENT;
1503
1504 return snd_usbmidi_detect_endpoints(umidi, endpoint, 1);
1505}
1506
1507/*
1508 * Creates the endpoints and their ports for Midiman devices.
1509 */
86e07d34
TI		 1510static int snd_usbmidi_create_endpoints_midiman(struct snd_usb_midi* umidi,
1511 struct snd_usb_midi_endpoint_info* endpoint)
1da177e4 1512{
86e07d34 1513 struct snd_usb_midi_endpoint_info ep_info;
1da177e4
LT		 1514 struct usb_interface* intf;
1515 struct usb_host_interface *hostif;
1516 struct usb_interface_descriptor* intfd;
1517 struct usb_endpoint_descriptor* epd;
1518 int cable, err;
1519
1520 intf = umidi->iface;
1521 if (!intf)
1522 return -ENOENT;
1523 hostif = intf->altsetting;
1524 intfd = get_iface_desc(hostif);
1525 /*
1526 * The various MidiSport devices have more or less random endpoint
1527 * numbers, so we have to identify the endpoints by their index in
1528 * the descriptor array, like the driver for that other OS does.
1529 *
1530 * There is one interrupt input endpoint for all input ports, one
1531 * bulk output endpoint for even-numbered ports, and one for odd-
1532 * numbered ports. Both bulk output endpoints have corresponding
1533 * input bulk endpoints (at indices 1 and 3) which aren't used.
1534 */
1535 if (intfd->bNumEndpoints < (endpoint->out_cables > 0x0001 ? 5 : 3)) {
1536 snd_printdd(KERN_ERR "not enough endpoints\n");
1537 return -ENOENT;
1538 }
1539
1540 epd = get_endpoint(hostif, 0);
1541 if ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) != USB_DIR_IN ||
1542 (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT) {
1543 snd_printdd(KERN_ERR "endpoint[0] isn't interrupt\n");
1544 return -ENXIO;
1545 }
1546 epd = get_endpoint(hostif, 2);
1547 if ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) != USB_DIR_OUT ||
1548 (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) {
1549 snd_printdd(KERN_ERR "endpoint[2] isn't bulk output\n");
1550 return -ENXIO;
1551 }
1552 if (endpoint->out_cables > 0x0001) {
1553 epd = get_endpoint(hostif, 4);
1554 if ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) != USB_DIR_OUT ||
1555 (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) {
1556 snd_printdd(KERN_ERR "endpoint[4] isn't bulk output\n");
1557 return -ENXIO;
1558 }
1559 }
1560
1561 ep_info.out_ep = get_endpoint(hostif, 2)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1562 ep_info.out_cables = endpoint->out_cables & 0x5555;
1563 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info, &umidi->endpoints[0]);
1564 if (err < 0)
1565 return err;
1566
1567 ep_info.in_ep = get_endpoint(hostif, 0)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1568 ep_info.in_interval = get_endpoint(hostif, 0)->bInterval;
1569 ep_info.in_cables = endpoint->in_cables;
1570 err = snd_usbmidi_in_endpoint_create(umidi, &ep_info, &umidi->endpoints[0]);
1571 if (err < 0)
1572 return err;
1573
1574 if (endpoint->out_cables > 0x0001) {
1575 ep_info.out_ep = get_endpoint(hostif, 4)->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1576 ep_info.out_cables = endpoint->out_cables & 0xaaaa;
1577 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info, &umidi->endpoints[1]);
1578 if (err < 0)
1579 return err;
1580 }
1581
1582 for (cable = 0; cable < 0x10; ++cable) {
1583 if (endpoint->out_cables & (1 << cable))
1584 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_OUTPUT, cable,
1585 &umidi->endpoints[cable & 1].out->ports[cable].substream);
1586 if (endpoint->in_cables & (1 << cable))
1587 snd_usbmidi_init_substream(umidi, SNDRV_RAWMIDI_STREAM_INPUT, cable,
1588 &umidi->endpoints[0].in->ports[cable].substream);
1589 }
1590 return 0;
1591}
1592
a7b928ac
CL		 1593static struct snd_rawmidi_global_ops snd_usbmidi_ops = {
1594 .get_port_info = snd_usbmidi_get_port_info,
1595};
1596
86e07d34 1597static int snd_usbmidi_create_rawmidi(struct snd_usb_midi* umidi,
1da177e4
LT		 1598 int out_ports, int in_ports)
1599{
86e07d34 1600 struct snd_rawmidi *rmidi;
1da177e4
LT		 1601 int err;
1602
1603 err = snd_rawmidi_new(umidi->chip->card, "USB MIDI",
1604 umidi->chip->next_midi_device++,
1605 out_ports, in_ports, &rmidi);
1606 if (err < 0)
1607 return err;
1608 strcpy(rmidi->name, umidi->chip->card->shortname);
1609 rmidi->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT |
1610 SNDRV_RAWMIDI_INFO_INPUT |
1611 SNDRV_RAWMIDI_INFO_DUPLEX;
a7b928ac 1612 rmidi->ops = &snd_usbmidi_ops;
1da177e4
LT		 1613 rmidi->private_data = umidi;
1614 rmidi->private_free = snd_usbmidi_rawmidi_free;
1615 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_usbmidi_output_ops);
1616 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_usbmidi_input_ops);
1617
1618 umidi->rmidi = rmidi;
1619 return 0;
1620}
1621
1622/*
1623 * Temporarily stop input.
1624 */
1625void snd_usbmidi_input_stop(struct list_head* p)
1626{
86e07d34 1627 struct snd_usb_midi* umidi;
1da177e4
LT		 1628 int i;
1629
86e07d34 1630 umidi = list_entry(p, struct snd_usb_midi, list);
1da177e4 1631 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
86e07d34 1632 struct snd_usb_midi_endpoint* ep = &umidi->endpoints[i];
1da177e4
LT		 1633 if (ep->in)
1634 usb_kill_urb(ep->in->urb);
1635 }
1636}
1637
86e07d34 1638static void snd_usbmidi_input_start_ep(struct snd_usb_midi_in_endpoint* ep)
1da177e4
LT		 1639{
1640 if (ep) {
1641 struct urb* urb = ep->urb;
1642 urb->dev = ep->umidi->chip->dev;
1643 snd_usbmidi_submit_urb(urb, GFP_KERNEL);
1644 }
1645}
1646
1647/*
1648 * Resume input after a call to snd_usbmidi_input_stop().
1649 */
1650void snd_usbmidi_input_start(struct list_head* p)
1651{
86e07d34 1652 struct snd_usb_midi* umidi;
1da177e4
LT		 1653 int i;
1654
86e07d34 1655 umidi = list_entry(p, struct snd_usb_midi, list);
1da177e4
LT		 1656 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
1657 snd_usbmidi_input_start_ep(umidi->endpoints[i].in);
1658}
1659
1660/*
1661 * Creates and registers everything needed for a MIDI streaming interface.
1662 */
86e07d34 1663int snd_usb_create_midi_interface(struct snd_usb_audio* chip,
1da177e4 1664 struct usb_interface* iface,
86e07d34 1665 const struct snd_usb_audio_quirk* quirk)
1da177e4 1666{
86e07d34
TI		 1667 struct snd_usb_midi* umidi;
1668 struct snd_usb_midi_endpoint_info endpoints[MIDI_MAX_ENDPOINTS];
1da177e4
LT		 1669 int out_ports, in_ports;
1670 int i, err;
1671
561b220a 1672 umidi = kzalloc(sizeof(*umidi), GFP_KERNEL);
1da177e4
LT		 1673 if (!umidi)
1674 return -ENOMEM;
1675 umidi->chip = chip;
1676 umidi->iface = iface;
1677 umidi->quirk = quirk;
1678 umidi->usb_protocol_ops = &snd_usbmidi_standard_ops;
c8846970
CL		 1679 init_timer(&umidi->error_timer);
1680 umidi->error_timer.function = snd_usbmidi_error_timer;
1681 umidi->error_timer.data = (unsigned long)umidi;
1da177e4
LT		 1682
1683 /* detect the endpoint(s) to use */
1684 memset(endpoints, 0, sizeof(endpoints));
d1bda045
CL		 1685 switch (quirk ? quirk->type : QUIRK_MIDI_STANDARD_INTERFACE) {
1686 case QUIRK_MIDI_STANDARD_INTERFACE:
1da177e4 1687 err = snd_usbmidi_get_ms_info(umidi, endpoints);
d05cc104
CL		 1688 if (chip->usb_id == USB_ID(0x0763, 0x0150)) /* M-Audio Uno */
1689 umidi->usb_protocol_ops =
1690 &snd_usbmidi_maudio_broken_running_status_ops;
d1bda045
CL		 1691 break;
1692 case QUIRK_MIDI_FIXED_ENDPOINT:
1693 memcpy(&endpoints[0], quirk->data,
86e07d34 1694 sizeof(struct snd_usb_midi_endpoint_info));
d1bda045
CL		 1695 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
1696 break;
1697 case QUIRK_MIDI_YAMAHA:
1698 err = snd_usbmidi_detect_yamaha(umidi, &endpoints[0]);
1699 break;
1700 case QUIRK_MIDI_MIDIMAN:
1701 umidi->usb_protocol_ops = &snd_usbmidi_midiman_ops;
1702 memcpy(&endpoints[0], quirk->data,
86e07d34 1703 sizeof(struct snd_usb_midi_endpoint_info));
d1bda045
CL		 1704 err = 0;
1705 break;
1706 case QUIRK_MIDI_NOVATION:
1707 umidi->usb_protocol_ops = &snd_usbmidi_novation_ops;
1708 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
1709 break;
1710 case QUIRK_MIDI_RAW:
1711 umidi->usb_protocol_ops = &snd_usbmidi_raw_ops;
1712 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
1713 break;
1714 case QUIRK_MIDI_EMAGIC:
1715 umidi->usb_protocol_ops = &snd_usbmidi_emagic_ops;
1716 memcpy(&endpoints[0], quirk->data,
86e07d34 1717 sizeof(struct snd_usb_midi_endpoint_info));
d1bda045
CL		 1718 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
1719 break;
cc7a59bd 1720 case QUIRK_MIDI_CME:
61870aed 1721 umidi->usb_protocol_ops = &snd_usbmidi_cme_ops;
d1bda045
CL		 1722 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
1723 break;
1724 default:
1725 snd_printd(KERN_ERR "invalid quirk type %d\n", quirk->type);
1726 err = -ENXIO;
1727 break;
1da177e4
LT		 1728 }
1729 if (err < 0) {
1730 kfree(umidi);
1731 return err;
1732 }
1733
1734 /* create rawmidi device */
1735 out_ports = 0;
1736 in_ports = 0;
1737 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1738 out_ports += snd_usbmidi_count_bits(endpoints[i].out_cables);
1739 in_ports += snd_usbmidi_count_bits(endpoints[i].in_cables);
1740 }
1741 err = snd_usbmidi_create_rawmidi(umidi, out_ports, in_ports);
1742 if (err < 0) {
1743 kfree(umidi);
1744 return err;
1745 }
1746
1747 /* create endpoint/port structures */
1748 if (quirk && quirk->type == QUIRK_MIDI_MIDIMAN)
1749 err = snd_usbmidi_create_endpoints_midiman(umidi, &endpoints[0]);
1750 else
1751 err = snd_usbmidi_create_endpoints(umidi, endpoints);
1752 if (err < 0) {
1753 snd_usbmidi_free(umidi);
1754 return err;
1755 }
1756
1757 list_add(&umidi->list, &umidi->chip->midi_list);
1758
1759 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
1760 snd_usbmidi_input_start_ep(umidi->endpoints[i].in);
1761 return 0;
1762}
1763
1764EXPORT_SYMBOL(snd_usb_create_midi_interface);
1765EXPORT_SYMBOL(snd_usbmidi_input_stop);
1766EXPORT_SYMBOL(snd_usbmidi_input_start);
1767EXPORT_SYMBOL(snd_usbmidi_disconnect);
Linux 6.x block layer and io_uring tree(s)