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