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