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