projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
blk-mq: really fix plug list flushing for nomerge queues
[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:
89e448b3 914 case USB_SPEED_SUPER_PLUS:
4f4e8f69
PZ		 915 count = 1;
916 break;
917 default:
918 count = 2;
919 }
030a07e4 920 count = snd_rawmidi_transmit(ep->ports[0].substream,
ed4affa5 921 urb->transfer_buffer,
030a07e4
KW		 922 count);
923 if (count < 1) {
924 ep->ports[0].active = 0;
925 return;
926 }
927
921eebdc
KW		 928 memset(urb->transfer_buffer + count, 0xFD, ep->max_transfer - count);
929 urb->transfer_buffer_length = ep->max_transfer;
030a07e4
KW		 930}
931
17074c1a 932static const struct usb_protocol_ops snd_usbmidi_122l_ops = {
030a07e4
KW		 933 .input = snd_usbmidi_us122l_input,
934 .output = snd_usbmidi_us122l_output,
935};
936
1da177e4
LT		 937/*
938 * Emagic USB MIDI protocol: raw MIDI with "F5 xx" port switching.
939 */
940
a509574e 941static void snd_usbmidi_emagic_init_out(struct snd_usb_midi_out_endpoint *ep)
1da177e4
LT		 942{
943 static const u8 init_data[] = {
944 /* initialization magic: "get version" */
945 0xf0,
946 0x00, 0x20, 0x31, /* Emagic */
947 0x64, /* Unitor8 */
948 0x0b, /* version number request */
949 0x00, /* command version */
950 0x00, /* EEPROM, box 0 */
951 0xf7
952 };
953 send_bulk_static_data(ep, init_data, sizeof(init_data));
954 /* while we're at it, pour on more magic */
955 send_bulk_static_data(ep, init_data, sizeof(init_data));
956}
957
a509574e 958static void snd_usbmidi_emagic_finish_out(struct snd_usb_midi_out_endpoint *ep)
1da177e4
LT		 959{
960 static const u8 finish_data[] = {
961 /* switch to patch mode with last preset */
962 0xf0,
963 0x00, 0x20, 0x31, /* Emagic */
964 0x64, /* Unitor8 */
965 0x10, /* patch switch command */
966 0x00, /* command version */
967 0x7f, /* to all boxes */
968 0x40, /* last preset in EEPROM */
969 0xf7
970 };
971 send_bulk_static_data(ep, finish_data, sizeof(finish_data));
972}
973
a509574e
AG		 974static void snd_usbmidi_emagic_input(struct snd_usb_midi_in_endpoint *ep,
975 uint8_t *buffer, int buffer_length)
1da177e4 976{
c347e9fc
CL		 977 int i;
978
979 /* FF indicates end of valid data */
980 for (i = 0; i < buffer_length; ++i)
981 if (buffer[i] == 0xff) {
982 buffer_length = i;
983 break;
984 }
1da177e4
LT		 985
986 /* handle F5 at end of last buffer */
987 if (ep->seen_f5)
988 goto switch_port;
989
990 while (buffer_length > 0) {
1da177e4
LT		 991 /* determine size of data until next F5 */
992 for (i = 0; i < buffer_length; ++i)
993 if (buffer[i] == 0xf5)
994 break;
995 snd_usbmidi_input_data(ep, ep->current_port, buffer, i);
996 buffer += i;
997 buffer_length -= i;
998
999 if (buffer_length <= 0)
1000 break;
1001 /* assert(buffer[0] == 0xf5); */
1002 ep->seen_f5 = 1;
1003 ++buffer;
1004 --buffer_length;
1005
1006 switch_port:
1007 if (buffer_length <= 0)
1008 break;
1009 if (buffer[0] < 0x80) {
1010 ep->current_port = (buffer[0] - 1) & 15;
1011 ++buffer;
1012 --buffer_length;
1013 }
1014 ep->seen_f5 = 0;
1015 }
1016}
1017
a509574e 1018static void snd_usbmidi_emagic_output(struct snd_usb_midi_out_endpoint *ep,
ed4affa5 1019 struct urb *urb)
1da177e4
LT		 1020{
1021 int port0 = ep->current_port;
a509574e 1022 uint8_t *buf = urb->transfer_buffer;
1da177e4
LT		 1023 int buf_free = ep->max_transfer;
1024 int length, i;
1025
1026 for (i = 0; i < 0x10; ++i) {
1027 /* round-robin, starting at the last current port */
1028 int portnum = (port0 + i) & 15;
a509574e 1029 struct usbmidi_out_port *port = &ep->ports[portnum];
1da177e4
LT		 1030
1031 if (!port->active)
1032 continue;
1033 if (snd_rawmidi_transmit_peek(port->substream, buf, 1) != 1) {
1034 port->active = 0;
1035 continue;
1036 }
1037
1038 if (portnum != ep->current_port) {
1039 if (buf_free < 2)
1040 break;
1041 ep->current_port = portnum;
1042 buf[0] = 0xf5;
1043 buf[1] = (portnum + 1) & 15;
1044 buf += 2;
1045 buf_free -= 2;
1046 }
1047
1048 if (buf_free < 1)
1049 break;
1050 length = snd_rawmidi_transmit(port->substream, buf, buf_free);
1051 if (length > 0) {
1052 buf += length;
1053 buf_free -= length;
1054 if (buf_free < 1)
1055 break;
1056 }
1057 }
c347e9fc
CL		 1058 if (buf_free < ep->max_transfer && buf_free > 0) {
1059 *buf = 0xff;
1060 --buf_free;
1061 }
ed4affa5 1062 urb->transfer_buffer_length = ep->max_transfer - buf_free;
1da177e4
LT		 1063}
1064
17074c1a 1065static const struct usb_protocol_ops snd_usbmidi_emagic_ops = {
1da177e4
LT		 1066 .input = snd_usbmidi_emagic_input,
1067 .output = snd_usbmidi_emagic_output,
1068 .init_out_endpoint = snd_usbmidi_emagic_init_out,
1069 .finish_out_endpoint = snd_usbmidi_emagic_finish_out,
1070};
1071
1072
a509574e 1073static void update_roland_altsetting(struct snd_usb_midi *umidi)
96f61d9a
CL		 1074{
1075 struct usb_interface *intf;
1076 struct usb_host_interface *hostif;
1077 struct usb_interface_descriptor *intfd;
1078 int is_light_load;
1079
1080 intf = umidi->iface;
1081 is_light_load = intf->cur_altsetting != intf->altsetting;
1082 if (umidi->roland_load_ctl->private_value == is_light_load)
1083 return;
1084 hostif = &intf->altsetting[umidi->roland_load_ctl->private_value];
1085 intfd = get_iface_desc(hostif);
1086 snd_usbmidi_input_stop(&umidi->list);
d82af9f9 1087 usb_set_interface(umidi->dev, intfd->bInterfaceNumber,
96f61d9a
CL		 1088 intfd->bAlternateSetting);
1089 snd_usbmidi_input_start(&umidi->list);
1090}
1091
f5f16541
TI		 1092static int substream_open(struct snd_rawmidi_substream *substream, int dir,
1093 int open)
96f61d9a 1094{
a509574e 1095 struct snd_usb_midi *umidi = substream->rmidi->private_data;
96f61d9a
CL		 1096 struct snd_kcontrol *ctl;
1097
59866da9
TI		 1098 down_read(&umidi->disc_rwsem);
1099 if (umidi->disconnected) {
1100 up_read(&umidi->disc_rwsem);
f5f16541 1101 return open ? -ENODEV : 0;
59866da9
TI		 1102 }
1103
96f61d9a
CL		 1104 mutex_lock(&umidi->mutex);
1105 if (open) {
f5f16541 1106 if (!umidi->opened[0] && !umidi->opened[1]) {
f5f16541
TI		 1107 if (umidi->roland_load_ctl) {
1108 ctl = umidi->roland_load_ctl;
a509574e
AG		 1109 ctl->vd[0].access |=
1110 SNDRV_CTL_ELEM_ACCESS_INACTIVE;
f5f16541 1111 snd_ctl_notify(umidi->card,
96f61d9a 1112 SNDRV_CTL_EVENT_MASK_INFO, &ctl->id);
f5f16541
TI		 1113 update_roland_altsetting(umidi);
1114 }
96f61d9a 1115 }
f5f16541
TI		 1116 umidi->opened[dir]++;
1117 if (umidi->opened[1])
1118 snd_usbmidi_input_start(&umidi->list);
96f61d9a 1119 } else {
f5f16541
TI		 1120 umidi->opened[dir]--;
1121 if (!umidi->opened[1])
1122 snd_usbmidi_input_stop(&umidi->list);
1123 if (!umidi->opened[0] && !umidi->opened[1]) {
1124 if (umidi->roland_load_ctl) {
1125 ctl = umidi->roland_load_ctl;
a509574e
AG		 1126 ctl->vd[0].access &=
1127 ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
f5f16541 1128 snd_ctl_notify(umidi->card,
96f61d9a 1129 SNDRV_CTL_EVENT_MASK_INFO, &ctl->id);
f5f16541 1130 }
96f61d9a
CL		 1131 }
1132 }
1133 mutex_unlock(&umidi->mutex);
59866da9 1134 up_read(&umidi->disc_rwsem);
f5f16541 1135 return 0;
96f61d9a
CL		 1136}
1137
86e07d34 1138static int snd_usbmidi_output_open(struct snd_rawmidi_substream *substream)
1da177e4 1139{
a509574e
AG		 1140 struct snd_usb_midi *umidi = substream->rmidi->private_data;
1141 struct usbmidi_out_port *port = NULL;
1da177e4
LT		 1142 int i, j;
1143
1144 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
1145 if (umidi->endpoints[i].out)
1146 for (j = 0; j < 0x10; ++j)
1147 if (umidi->endpoints[i].out->ports[j].substream == substream) {
1148 port = &umidi->endpoints[i].out->ports[j];
1149 break;
1150 }
1151 if (!port) {
1152 snd_BUG();
1153 return -ENXIO;
1154 }
59866da9 1155
1da177e4
LT		 1156 substream->runtime->private_data = port;
1157 port->state = STATE_UNKNOWN;
f5f16541 1158 return substream_open(substream, 0, 1);
1da177e4
LT		 1159}
1160
86e07d34 1161static int snd_usbmidi_output_close(struct snd_rawmidi_substream *substream)
1da177e4 1162{
f5f16541 1163 return substream_open(substream, 0, 0);
1da177e4
LT		 1164}
1165
a509574e
AG		 1166static void snd_usbmidi_output_trigger(struct snd_rawmidi_substream *substream,
1167 int up)
1da177e4 1168{
a509574e
AG		 1169 struct usbmidi_out_port *port =
1170 (struct usbmidi_out_port *)substream->runtime->private_data;
1da177e4
LT		 1171
1172 port->active = up;
1173 if (up) {
d82af9f9 1174 if (port->ep->umidi->disconnected) {
1da177e4
LT		 1175 /* gobble up remaining bytes to prevent wait in
1176 * snd_rawmidi_drain_output */
1177 while (!snd_rawmidi_transmit_empty(substream))
1178 snd_rawmidi_transmit_ack(substream, 1);
1179 return;
1180 }
1f04128a 1181 tasklet_schedule(&port->ep->tasklet);
1da177e4
LT		 1182 }
1183}
1184
a65dd997
CL		 1185static void snd_usbmidi_output_drain(struct snd_rawmidi_substream *substream)
1186{
a509574e 1187 struct usbmidi_out_port *port = substream->runtime->private_data;
a65dd997
CL		 1188 struct snd_usb_midi_out_endpoint *ep = port->ep;
1189 unsigned int drain_urbs;
1190 DEFINE_WAIT(wait);
1191 long timeout = msecs_to_jiffies(50);
1192
29aac005
TI		 1193 if (ep->umidi->disconnected)
1194 return;
a65dd997
CL		 1195 /*
1196 * The substream buffer is empty, but some data might still be in the
1197 * currently active URBs, so we have to wait for those to complete.
1198 */
1199 spin_lock_irq(&ep->buffer_lock);
1200 drain_urbs = ep->active_urbs;
1201 if (drain_urbs) {
1202 ep->drain_urbs |= drain_urbs;
1203 do {
1204 prepare_to_wait(&ep->drain_wait, &wait,
1205 TASK_UNINTERRUPTIBLE);
1206 spin_unlock_irq(&ep->buffer_lock);
1207 timeout = schedule_timeout(timeout);
1208 spin_lock_irq(&ep->buffer_lock);
1209 drain_urbs &= ep->drain_urbs;
1210 } while (drain_urbs && timeout);
1211 finish_wait(&ep->drain_wait, &wait);
1212 }
1213 spin_unlock_irq(&ep->buffer_lock);
1214}
1215
86e07d34 1216static int snd_usbmidi_input_open(struct snd_rawmidi_substream *substream)
1da177e4 1217{
f5f16541 1218 return substream_open(substream, 1, 1);
1da177e4
LT		 1219}
1220
86e07d34 1221static int snd_usbmidi_input_close(struct snd_rawmidi_substream *substream)
1da177e4 1222{
f5f16541 1223 return substream_open(substream, 1, 0);
1da177e4
LT		 1224}
1225
a509574e
AG		 1226static void snd_usbmidi_input_trigger(struct snd_rawmidi_substream *substream,
1227 int up)
1da177e4 1228{
a509574e 1229 struct snd_usb_midi *umidi = substream->rmidi->private_data;
1da177e4
LT		 1230
1231 if (up)
1232 set_bit(substream->number, &umidi->input_triggered);
1233 else
1234 clear_bit(substream->number, &umidi->input_triggered);
1235}
1236
86e07d34 1237static struct snd_rawmidi_ops snd_usbmidi_output_ops = {
1da177e4
LT		 1238 .open = snd_usbmidi_output_open,
1239 .close = snd_usbmidi_output_close,
1240 .trigger = snd_usbmidi_output_trigger,
a65dd997 1241 .drain = snd_usbmidi_output_drain,
1da177e4
LT		 1242};
1243
86e07d34 1244static struct snd_rawmidi_ops snd_usbmidi_input_ops = {
1da177e4
LT		 1245 .open = snd_usbmidi_input_open,
1246 .close = snd_usbmidi_input_close,
1247 .trigger = snd_usbmidi_input_trigger
1248};
1249
ed4affa5
CL		 1250static void free_urb_and_buffer(struct snd_usb_midi *umidi, struct urb *urb,
1251 unsigned int buffer_length)
1252{
997ea58e
DM		 1253 usb_free_coherent(umidi->dev, buffer_length,
1254 urb->transfer_buffer, urb->transfer_dma);
ed4affa5
CL		 1255 usb_free_urb(urb);
1256}
1257
1da177e4
LT		 1258/*
1259 * Frees an input endpoint.
1260 * May be called when ep hasn't been initialized completely.
1261 */
a509574e 1262static void snd_usbmidi_in_endpoint_delete(struct snd_usb_midi_in_endpoint *ep)
1da177e4 1263{
4773d1fb
CL		 1264 unsigned int i;
1265
ed4affa5
CL		 1266 for (i = 0; i < INPUT_URBS; ++i)
1267 if (ep->urbs[i])
1268 free_urb_and_buffer(ep->umidi, ep->urbs[i],
1269 ep->urbs[i]->transfer_buffer_length);
1da177e4
LT		 1270 kfree(ep);
1271}
1272
1273/*
1274 * Creates an input endpoint.
1275 */
a509574e
AG		 1276static int snd_usbmidi_in_endpoint_create(struct snd_usb_midi *umidi,
1277 struct snd_usb_midi_endpoint_info *ep_info,
1278 struct snd_usb_midi_endpoint *rep)
1da177e4 1279{
a509574e
AG		 1280 struct snd_usb_midi_in_endpoint *ep;
1281 void *buffer;
1da177e4
LT		 1282 unsigned int pipe;
1283 int length;
4773d1fb 1284 unsigned int i;
1da177e4
LT		 1285
1286 rep->in = NULL;
561b220a 1287 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1da177e4
LT		 1288 if (!ep)
1289 return -ENOMEM;
1290 ep->umidi = umidi;
1291
4773d1fb
CL		 1292 for (i = 0; i < INPUT_URBS; ++i) {
1293 ep->urbs[i] = usb_alloc_urb(0, GFP_KERNEL);
1294 if (!ep->urbs[i]) {
1295 snd_usbmidi_in_endpoint_delete(ep);
1296 return -ENOMEM;
1297 }
1da177e4
LT		 1298 }
1299 if (ep_info->in_interval)
d82af9f9 1300 pipe = usb_rcvintpipe(umidi->dev, ep_info->in_ep);
1da177e4 1301 else
d82af9f9
CL		 1302 pipe = usb_rcvbulkpipe(umidi->dev, ep_info->in_ep);
1303 length = usb_maxpacket(umidi->dev, pipe, 0);
4773d1fb 1304 for (i = 0; i < INPUT_URBS; ++i) {
997ea58e
DM		 1305 buffer = usb_alloc_coherent(umidi->dev, length, GFP_KERNEL,
1306 &ep->urbs[i]->transfer_dma);
4773d1fb
CL		 1307 if (!buffer) {
1308 snd_usbmidi_in_endpoint_delete(ep);
1309 return -ENOMEM;
1310 }
1311 if (ep_info->in_interval)
d82af9f9 1312 usb_fill_int_urb(ep->urbs[i], umidi->dev,
4773d1fb
CL		 1313 pipe, buffer, length,
1314 snd_usbmidi_in_urb_complete,
1315 ep, ep_info->in_interval);
1316 else
d82af9f9 1317 usb_fill_bulk_urb(ep->urbs[i], umidi->dev,
4773d1fb
CL		 1318 pipe, buffer, length,
1319 snd_usbmidi_in_urb_complete, ep);
1320 ep->urbs[i]->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1da177e4 1321 }
1da177e4
LT		 1322
1323 rep->in = ep;
1324 return 0;
1325}
1326
1da177e4
LT		 1327/*
1328 * Frees an output endpoint.
1329 * May be called when ep hasn't been initialized completely.
1330 */
29aac005 1331static void snd_usbmidi_out_endpoint_clear(struct snd_usb_midi_out_endpoint *ep)
1da177e4 1332{
ed4affa5
CL		 1333 unsigned int i;
1334
1335 for (i = 0; i < OUTPUT_URBS; ++i)
29aac005 1336 if (ep->urbs[i].urb) {
ed4affa5
CL		 1337 free_urb_and_buffer(ep->umidi, ep->urbs[i].urb,
1338 ep->max_transfer);
29aac005
TI		 1339 ep->urbs[i].urb = NULL;
1340 }
1341}
1342
1343static void snd_usbmidi_out_endpoint_delete(struct snd_usb_midi_out_endpoint *ep)
1344{
1345 snd_usbmidi_out_endpoint_clear(ep);
1da177e4
LT		 1346 kfree(ep);
1347}
1348
1349/*
1350 * Creates an output endpoint, and initializes output ports.
1351 */
a509574e
AG		 1352static int snd_usbmidi_out_endpoint_create(struct snd_usb_midi *umidi,
1353 struct snd_usb_midi_endpoint_info *ep_info,
1354 struct snd_usb_midi_endpoint *rep)
1da177e4 1355{
a509574e 1356 struct snd_usb_midi_out_endpoint *ep;
ed4affa5 1357 unsigned int i;
1da177e4 1358 unsigned int pipe;
a509574e 1359 void *buffer;
1da177e4
LT		 1360
1361 rep->out = NULL;
561b220a 1362 ep = kzalloc(sizeof(*ep), GFP_KERNEL);
1da177e4
LT		 1363 if (!ep)
1364 return -ENOMEM;
1365 ep->umidi = umidi;
1366
ed4affa5
CL		 1367 for (i = 0; i < OUTPUT_URBS; ++i) {
1368 ep->urbs[i].urb = usb_alloc_urb(0, GFP_KERNEL);
1369 if (!ep->urbs[i].urb) {
1370 snd_usbmidi_out_endpoint_delete(ep);
1371 return -ENOMEM;
1372 }
1373 ep->urbs[i].ep = ep;
1da177e4 1374 }
a6a712ae 1375 if (ep_info->out_interval)
d82af9f9 1376 pipe = usb_sndintpipe(umidi->dev, ep_info->out_ep);
a6a712ae 1377 else
d82af9f9 1378 pipe = usb_sndbulkpipe(umidi->dev, ep_info->out_ep);
f167e1d0
CL		 1379 switch (umidi->usb_id) {
1380 default:
d82af9f9 1381 ep->max_transfer = usb_maxpacket(umidi->dev, pipe, 1);
f167e1d0
CL		 1382 break;
1383 /*
1384 * Various chips declare a packet size larger than 4 bytes, but
1385 * do not actually work with larger packets:
1386 */
98d362be 1387 case USB_ID(0x0a67, 0x5011): /* Medeli DD305 */
f167e1d0
CL		 1388 case USB_ID(0x0a92, 0x1020): /* ESI M4U */
1389 case USB_ID(0x1430, 0x474b): /* RedOctane GH MIDI INTERFACE */
1390 case USB_ID(0x15ca, 0x0101): /* Textech USB Midi Cable */
1391 case USB_ID(0x15ca, 0x1806): /* Textech USB Midi Cable */
1392 case USB_ID(0x1a86, 0x752d): /* QinHeng CH345 "USB2.0-MIDI" */
49c039f0 1393 case USB_ID(0xfc08, 0x0101): /* Unknown vendor Cable */
f167e1d0
CL		 1394 ep->max_transfer = 4;
1395 break;
921eebdc
KW		 1396 /*
1397 * Some devices only work with 9 bytes packet size:
1398 */
1399 case USB_ID(0x0644, 0x800E): /* Tascam US-122L */
1400 case USB_ID(0x0644, 0x800F): /* Tascam US-144 */
1401 ep->max_transfer = 9;
1402 break;
f167e1d0 1403 }
ed4affa5 1404 for (i = 0; i < OUTPUT_URBS; ++i) {
997ea58e
DM		 1405 buffer = usb_alloc_coherent(umidi->dev,
1406 ep->max_transfer, GFP_KERNEL,
1407 &ep->urbs[i].urb->transfer_dma);
ed4affa5
CL		 1408 if (!buffer) {
1409 snd_usbmidi_out_endpoint_delete(ep);
1410 return -ENOMEM;
1411 }
1412 if (ep_info->out_interval)
d82af9f9 1413 usb_fill_int_urb(ep->urbs[i].urb, umidi->dev,
ed4affa5
CL		 1414 pipe, buffer, ep->max_transfer,
1415 snd_usbmidi_out_urb_complete,
1416 &ep->urbs[i], ep_info->out_interval);
1417 else
d82af9f9 1418 usb_fill_bulk_urb(ep->urbs[i].urb, umidi->dev,
ed4affa5
CL		 1419 pipe, buffer, ep->max_transfer,
1420 snd_usbmidi_out_urb_complete,
1421 &ep->urbs[i]);
1422 ep->urbs[i].urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1da177e4 1423 }
1da177e4
LT		 1424
1425 spin_lock_init(&ep->buffer_lock);
1426 tasklet_init(&ep->tasklet, snd_usbmidi_out_tasklet, (unsigned long)ep);
a65dd997 1427 init_waitqueue_head(&ep->drain_wait);
1da177e4
LT		 1428
1429 for (i = 0; i < 0x10; ++i)
1430 if (ep_info->out_cables & (1 << i)) {
1431 ep->ports[i].ep = ep;
1432 ep->ports[i].cable = i << 4;
1433 }
1434
1435 if (umidi->usb_protocol_ops->init_out_endpoint)
1436 umidi->usb_protocol_ops->init_out_endpoint(ep);
1437
1438 rep->out = ep;
1439 return 0;
1440}
1441
1442/*
1443 * Frees everything.
1444 */
a509574e 1445static void snd_usbmidi_free(struct snd_usb_midi *umidi)
1da177e4
LT		 1446{
1447 int i;
1448
1449 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
a509574e 1450 struct snd_usb_midi_endpoint *ep = &umidi->endpoints[i];
1da177e4
LT		 1451 if (ep->out)
1452 snd_usbmidi_out_endpoint_delete(ep->out);
1453 if (ep->in)
1454 snd_usbmidi_in_endpoint_delete(ep->in);
1455 }
96f61d9a 1456 mutex_destroy(&umidi->mutex);
1da177e4
LT		 1457 kfree(umidi);
1458}
1459
1460/*
1461 * Unlinks all URBs (must be done before the usb_device is deleted).
1462 */
a509574e 1463void snd_usbmidi_disconnect(struct list_head *p)
1da177e4 1464{
a509574e 1465 struct snd_usb_midi *umidi;
4773d1fb 1466 unsigned int i, j;
1da177e4 1467
86e07d34 1468 umidi = list_entry(p, struct snd_usb_midi, list);
c0792e00
TI		 1469 /*
1470 * an URB's completion handler may start the timer and
1471 * a timer may submit an URB. To reliably break the cycle
1472 * a flag under lock must be used
1473 */
59866da9 1474 down_write(&umidi->disc_rwsem);
c0792e00
TI		 1475 spin_lock_irq(&umidi->disc_lock);
1476 umidi->disconnected = 1;
1477 spin_unlock_irq(&umidi->disc_lock);
59866da9
TI		 1478 up_write(&umidi->disc_rwsem);
1479
1da177e4 1480 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
a509574e 1481 struct snd_usb_midi_endpoint *ep = &umidi->endpoints[i];
c8846970
CL		 1482 if (ep->out)
1483 tasklet_kill(&ep->out->tasklet);
ed4affa5
CL		 1484 if (ep->out) {
1485 for (j = 0; j < OUTPUT_URBS; ++j)
1486 usb_kill_urb(ep->out->urbs[j].urb);
1da177e4
LT		 1487 if (umidi->usb_protocol_ops->finish_out_endpoint)
1488 umidi->usb_protocol_ops->finish_out_endpoint(ep->out);
29aac005
TI		 1489 ep->out->active_urbs = 0;
1490 if (ep->out->drain_urbs) {
1491 ep->out->drain_urbs = 0;
1492 wake_up(&ep->out->drain_wait);
1493 }
1da177e4 1494 }
f5e135af 1495 if (ep->in)
4773d1fb
CL		 1496 for (j = 0; j < INPUT_URBS; ++j)
1497 usb_kill_urb(ep->in->urbs[j]);
7a17daae 1498 /* free endpoints here; later call can result in Oops */
29aac005
TI		 1499 if (ep->out)
1500 snd_usbmidi_out_endpoint_clear(ep->out);
7a17daae
TI		 1501 if (ep->in) {
1502 snd_usbmidi_in_endpoint_delete(ep->in);
1503 ep->in = NULL;
1504 }
1da177e4 1505 }
c0792e00 1506 del_timer_sync(&umidi->error_timer);
1da177e4 1507}
ed136aca 1508EXPORT_SYMBOL(snd_usbmidi_disconnect);
1da177e4 1509
86e07d34 1510static void snd_usbmidi_rawmidi_free(struct snd_rawmidi *rmidi)
1da177e4 1511{
a509574e 1512 struct snd_usb_midi *umidi = rmidi->private_data;
1da177e4
LT		 1513 snd_usbmidi_free(umidi);
1514}
1515
a509574e
AG		 1516static struct snd_rawmidi_substream *snd_usbmidi_find_substream(struct snd_usb_midi *umidi,
1517 int stream,
1518 int number)
1da177e4 1519{
88766f04 1520 struct snd_rawmidi_substream *substream;
1da177e4 1521
a509574e
AG		 1522 list_for_each_entry(substream, &umidi->rmidi->streams[stream].substreams,
1523 list) {
1da177e4
LT		 1524 if (substream->number == number)
1525 return substream;
1526 }
1527 return NULL;
1528}
1529
1530/*
1531 * This list specifies names for ports that do not fit into the standard
1532 * "(product) MIDI (n)" schema because they aren't external MIDI ports,
1533 * such as internal control or synthesizer ports.
1534 */
a7b928ac 1535static struct port_info {
27d10f56 1536 u32 id;
a7b928ac
CL		 1537 short int port;
1538 short int voices;
1539 const char *name;
1540 unsigned int seq_flags;
1541} snd_usbmidi_port_info[] = {
1542#define PORT_INFO(vendor, product, num, name_, voices_, flags) \
1543 { .id = USB_ID(vendor, product), \
1544 .port = num, .voices = voices_, \
1545 .name = name_, .seq_flags = flags }
1546#define EXTERNAL_PORT(vendor, product, num, name) \
1547 PORT_INFO(vendor, product, num, name, 0, \
1548 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1549 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1550 SNDRV_SEQ_PORT_TYPE_PORT)
1551#define CONTROL_PORT(vendor, product, num, name) \
1552 PORT_INFO(vendor, product, num, name, 0, \
1553 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1554 SNDRV_SEQ_PORT_TYPE_HARDWARE)
49f4b4d1
CL		 1555#define GM_SYNTH_PORT(vendor, product, num, name, voices) \
1556 PORT_INFO(vendor, product, num, name, voices, \
1557 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1558 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1559 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1560 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
a7b928ac
CL		 1561#define ROLAND_SYNTH_PORT(vendor, product, num, name, voices) \
1562 PORT_INFO(vendor, product, num, name, voices, \
1563 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1564 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1565 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1566 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1567 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1568 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1569 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
1570#define SOUNDCANVAS_PORT(vendor, product, num, name, voices) \
1571 PORT_INFO(vendor, product, num, name, voices, \
1572 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC | \
1573 SNDRV_SEQ_PORT_TYPE_MIDI_GM | \
1574 SNDRV_SEQ_PORT_TYPE_MIDI_GM2 | \
1575 SNDRV_SEQ_PORT_TYPE_MIDI_GS | \
1576 SNDRV_SEQ_PORT_TYPE_MIDI_XG | \
1577 SNDRV_SEQ_PORT_TYPE_MIDI_MT32 | \
1578 SNDRV_SEQ_PORT_TYPE_HARDWARE | \
1579 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER)
49f4b4d1
CL		 1580 /* Yamaha MOTIF XF */
1581 GM_SYNTH_PORT(0x0499, 0x105c, 0, "%s Tone Generator", 128),
1582 CONTROL_PORT(0x0499, 0x105c, 1, "%s Remote Control"),
1583 EXTERNAL_PORT(0x0499, 0x105c, 2, "%s Thru"),
1584 CONTROL_PORT(0x0499, 0x105c, 3, "%s Editor"),
1da177e4 1585 /* Roland UA-100 */
a7b928ac 1586 CONTROL_PORT(0x0582, 0x0000, 2, "%s Control"),
1da177e4 1587 /* Roland SC-8850 */
a7b928ac
CL		 1588 SOUNDCANVAS_PORT(0x0582, 0x0003, 0, "%s Part A", 128),
1589 SOUNDCANVAS_PORT(0x0582, 0x0003, 1, "%s Part B", 128),
1590 SOUNDCANVAS_PORT(0x0582, 0x0003, 2, "%s Part C", 128),
1591 SOUNDCANVAS_PORT(0x0582, 0x0003, 3, "%s Part D", 128),
1592 EXTERNAL_PORT(0x0582, 0x0003, 4, "%s MIDI 1"),
1593 EXTERNAL_PORT(0x0582, 0x0003, 5, "%s MIDI 2"),
1da177e4 1594 /* Roland U-8 */
a7b928ac
CL		 1595 EXTERNAL_PORT(0x0582, 0x0004, 0, "%s MIDI"),
1596 CONTROL_PORT(0x0582, 0x0004, 1, "%s Control"),
1da177e4 1597 /* Roland SC-8820 */
a7b928ac
CL		 1598 SOUNDCANVAS_PORT(0x0582, 0x0007, 0, "%s Part A", 64),
1599 SOUNDCANVAS_PORT(0x0582, 0x0007, 1, "%s Part B", 64),
1600 EXTERNAL_PORT(0x0582, 0x0007, 2, "%s MIDI"),
1da177e4 1601 /* Roland SK-500 */
a7b928ac
CL		 1602 SOUNDCANVAS_PORT(0x0582, 0x000b, 0, "%s Part A", 64),
1603 SOUNDCANVAS_PORT(0x0582, 0x000b, 1, "%s Part B", 64),
1604 EXTERNAL_PORT(0x0582, 0x000b, 2, "%s MIDI"),
1da177e4 1605 /* Roland SC-D70 */
a7b928ac
CL		 1606 SOUNDCANVAS_PORT(0x0582, 0x000c, 0, "%s Part A", 64),
1607 SOUNDCANVAS_PORT(0x0582, 0x000c, 1, "%s Part B", 64),
1608 EXTERNAL_PORT(0x0582, 0x000c, 2, "%s MIDI"),
1da177e4 1609 /* Edirol UM-880 */
a7b928ac 1610 CONTROL_PORT(0x0582, 0x0014, 8, "%s Control"),
1da177e4 1611 /* Edirol SD-90 */
a7b928ac
CL		 1612 ROLAND_SYNTH_PORT(0x0582, 0x0016, 0, "%s Part A", 128),
1613 ROLAND_SYNTH_PORT(0x0582, 0x0016, 1, "%s Part B", 128),
1614 EXTERNAL_PORT(0x0582, 0x0016, 2, "%s MIDI 1"),
1615 EXTERNAL_PORT(0x0582, 0x0016, 3, "%s MIDI 2"),
1da177e4 1616 /* Edirol UM-550 */
a7b928ac 1617 CONTROL_PORT(0x0582, 0x0023, 5, "%s Control"),
1da177e4 1618 /* Edirol SD-20 */
a7b928ac
CL		 1619 ROLAND_SYNTH_PORT(0x0582, 0x0027, 0, "%s Part A", 64),
1620 ROLAND_SYNTH_PORT(0x0582, 0x0027, 1, "%s Part B", 64),
1621 EXTERNAL_PORT(0x0582, 0x0027, 2, "%s MIDI"),
1da177e4 1622 /* Edirol SD-80 */
a7b928ac
CL		 1623 ROLAND_SYNTH_PORT(0x0582, 0x0029, 0, "%s Part A", 128),
1624 ROLAND_SYNTH_PORT(0x0582, 0x0029, 1, "%s Part B", 128),
1625 EXTERNAL_PORT(0x0582, 0x0029, 2, "%s MIDI 1"),
1626 EXTERNAL_PORT(0x0582, 0x0029, 3, "%s MIDI 2"),
1da177e4 1627 /* Edirol UA-700 */
a7b928ac
CL		 1628 EXTERNAL_PORT(0x0582, 0x002b, 0, "%s MIDI"),
1629 CONTROL_PORT(0x0582, 0x002b, 1, "%s Control"),
1da177e4 1630 /* Roland VariOS */
a7b928ac
CL		 1631 EXTERNAL_PORT(0x0582, 0x002f, 0, "%s MIDI"),
1632 EXTERNAL_PORT(0x0582, 0x002f, 1, "%s External MIDI"),
1633 EXTERNAL_PORT(0x0582, 0x002f, 2, "%s Sync"),
1da177e4 1634 /* Edirol PCR */
a7b928ac
CL		 1635 EXTERNAL_PORT(0x0582, 0x0033, 0, "%s MIDI"),
1636 EXTERNAL_PORT(0x0582, 0x0033, 1, "%s 1"),
1637 EXTERNAL_PORT(0x0582, 0x0033, 2, "%s 2"),
1da177e4 1638 /* BOSS GS-10 */
a7b928ac
CL		 1639 EXTERNAL_PORT(0x0582, 0x003b, 0, "%s MIDI"),
1640 CONTROL_PORT(0x0582, 0x003b, 1, "%s Control"),
1da177e4 1641 /* Edirol UA-1000 */
a7b928ac
CL		 1642 EXTERNAL_PORT(0x0582, 0x0044, 0, "%s MIDI"),
1643 CONTROL_PORT(0x0582, 0x0044, 1, "%s Control"),
1da177e4 1644 /* Edirol UR-80 */
a7b928ac
CL		 1645 EXTERNAL_PORT(0x0582, 0x0048, 0, "%s MIDI"),
1646 EXTERNAL_PORT(0x0582, 0x0048, 1, "%s 1"),
1647 EXTERNAL_PORT(0x0582, 0x0048, 2, "%s 2"),
1da177e4 1648 /* Edirol PCR-A */
a7b928ac
CL		 1649 EXTERNAL_PORT(0x0582, 0x004d, 0, "%s MIDI"),
1650 EXTERNAL_PORT(0x0582, 0x004d, 1, "%s 1"),
1651 EXTERNAL_PORT(0x0582, 0x004d, 2, "%s 2"),
a968782e
CL		 1652 /* BOSS GT-PRO */
1653 CONTROL_PORT(0x0582, 0x0089, 0, "%s Control"),
7c79b768 1654 /* Edirol UM-3EX */
a7b928ac 1655 CONTROL_PORT(0x0582, 0x009a, 3, "%s Control"),
a968782e
CL		 1656 /* Roland VG-99 */
1657 CONTROL_PORT(0x0582, 0x00b2, 0, "%s Control"),
1658 EXTERNAL_PORT(0x0582, 0x00b2, 1, "%s MIDI"),
1659 /* Cakewalk Sonar V-Studio 100 */
1660 EXTERNAL_PORT(0x0582, 0x00eb, 0, "%s MIDI"),
1661 CONTROL_PORT(0x0582, 0x00eb, 1, "%s Control"),
1662 /* Roland VB-99 */
1663 CONTROL_PORT(0x0582, 0x0102, 0, "%s Control"),
1664 EXTERNAL_PORT(0x0582, 0x0102, 1, "%s MIDI"),
1665 /* Roland A-PRO */
1666 EXTERNAL_PORT(0x0582, 0x010f, 0, "%s MIDI"),
1667 CONTROL_PORT(0x0582, 0x010f, 1, "%s 1"),
1668 CONTROL_PORT(0x0582, 0x010f, 2, "%s 2"),
1669 /* Roland SD-50 */
1670 ROLAND_SYNTH_PORT(0x0582, 0x0114, 0, "%s Synth", 128),
1671 EXTERNAL_PORT(0x0582, 0x0114, 1, "%s MIDI"),
1672 CONTROL_PORT(0x0582, 0x0114, 2, "%s Control"),
1673 /* Roland OCTA-CAPTURE */
1674 EXTERNAL_PORT(0x0582, 0x0120, 0, "%s MIDI"),
1675 CONTROL_PORT(0x0582, 0x0120, 1, "%s Control"),
1676 EXTERNAL_PORT(0x0582, 0x0121, 0, "%s MIDI"),
1677 CONTROL_PORT(0x0582, 0x0121, 1, "%s Control"),
1678 /* Roland SPD-SX */
1679 CONTROL_PORT(0x0582, 0x0145, 0, "%s Control"),
1680 EXTERNAL_PORT(0x0582, 0x0145, 1, "%s MIDI"),
1681 /* Roland A-Series */
1682 CONTROL_PORT(0x0582, 0x0156, 0, "%s Keyboard"),
1683 EXTERNAL_PORT(0x0582, 0x0156, 1, "%s MIDI"),
1684 /* Roland INTEGRA-7 */
1685 ROLAND_SYNTH_PORT(0x0582, 0x015b, 0, "%s Synth", 128),
1686 CONTROL_PORT(0x0582, 0x015b, 1, "%s Control"),
1da177e4 1687 /* M-Audio MidiSport 8x8 */
a7b928ac
CL		 1688 CONTROL_PORT(0x0763, 0x1031, 8, "%s Control"),
1689 CONTROL_PORT(0x0763, 0x1033, 8, "%s Control"),
1da177e4 1690 /* MOTU Fastlane */
a7b928ac
CL		 1691 EXTERNAL_PORT(0x07fd, 0x0001, 0, "%s MIDI A"),
1692 EXTERNAL_PORT(0x07fd, 0x0001, 1, "%s MIDI B"),
1da177e4 1693 /* Emagic Unitor8/AMT8/MT4 */
a7b928ac
CL		 1694 EXTERNAL_PORT(0x086a, 0x0001, 8, "%s Broadcast"),
1695 EXTERNAL_PORT(0x086a, 0x0002, 8, "%s Broadcast"),
1696 EXTERNAL_PORT(0x086a, 0x0003, 4, "%s Broadcast"),
4434ade8
KF		 1697 /* Akai MPD16 */
1698 CONTROL_PORT(0x09e8, 0x0062, 0, "%s Control"),
1699 PORT_INFO(0x09e8, 0x0062, 1, "%s MIDI", 0,
1700 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC |
1701 SNDRV_SEQ_PORT_TYPE_HARDWARE),
d39e82db
SA		 1702 /* Access Music Virus TI */
1703 EXTERNAL_PORT(0x133e, 0x0815, 0, "%s MIDI"),
1704 PORT_INFO(0x133e, 0x0815, 1, "%s Synth", 0,
1705 SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC |
1706 SNDRV_SEQ_PORT_TYPE_HARDWARE |
1707 SNDRV_SEQ_PORT_TYPE_SYNTHESIZER),
1da177e4
LT		 1708};
1709
a509574e 1710static struct port_info *find_port_info(struct snd_usb_midi *umidi, int number)
a7b928ac
CL		 1711{
1712 int i;
1713
1714 for (i = 0; i < ARRAY_SIZE(snd_usbmidi_port_info); ++i) {
d82af9f9 1715 if (snd_usbmidi_port_info[i].id == umidi->usb_id &&
a7b928ac
CL		 1716 snd_usbmidi_port_info[i].port == number)
1717 return &snd_usbmidi_port_info[i];
1718 }
1719 return NULL;
1720}
1721
1722static void snd_usbmidi_get_port_info(struct snd_rawmidi *rmidi, int number,
1723 struct snd_seq_port_info *seq_port_info)
1724{
1725 struct snd_usb_midi *umidi = rmidi->private_data;
1726 struct port_info *port_info;
1727
1728 /* TODO: read port flags from descriptors */
1729 port_info = find_port_info(umidi, number);
1730 if (port_info) {
1731 seq_port_info->type = port_info->seq_flags;
1732 seq_port_info->midi_voices = port_info->voices;
1733 }
1734}
1735
a509574e 1736static void snd_usbmidi_init_substream(struct snd_usb_midi *umidi,
1da177e4 1737 int stream, int number,
a509574e 1738 struct snd_rawmidi_substream **rsubstream)
1da177e4 1739{
a7b928ac 1740 struct port_info *port_info;
1da177e4
LT		 1741 const char *name_format;
1742
a509574e
AG		 1743 struct snd_rawmidi_substream *substream =
1744 snd_usbmidi_find_substream(umidi, stream, number);
1da177e4 1745 if (!substream) {
a509574e
AG		 1746 dev_err(&umidi->dev->dev, "substream %d:%d not found\n", stream,
1747 number);
1da177e4
LT		 1748 return;
1749 }
1750
1751 /* TODO: read port name from jack descriptor */
a7b928ac
CL		 1752 port_info = find_port_info(umidi, number);
1753 name_format = port_info ? port_info->name : "%s MIDI %d";
1da177e4 1754 snprintf(substream->name, sizeof(substream->name),
d82af9f9 1755 name_format, umidi->card->shortname, number + 1);
1da177e4
LT		 1756
1757 *rsubstream = substream;
1758}
1759
1760/*
1761 * Creates the endpoints and their ports.
1762 */
a509574e
AG		 1763static int snd_usbmidi_create_endpoints(struct snd_usb_midi *umidi,
1764 struct snd_usb_midi_endpoint_info *endpoints)
1da177e4
LT		 1765{
1766 int i, j, err;
1767 int out_ports = 0, in_ports = 0;
1768
1769 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
1770 if (endpoints[i].out_cables) {
a509574e
AG		 1771 err = snd_usbmidi_out_endpoint_create(umidi,
1772 &endpoints[i],
1da177e4
LT		 1773 &umidi->endpoints[i]);
1774 if (err < 0)
1775 return err;
1776 }
1777 if (endpoints[i].in_cables) {
a509574e
AG		 1778 err = snd_usbmidi_in_endpoint_create(umidi,
1779 &endpoints[i],
1da177e4
LT		 1780 &umidi->endpoints[i]);
1781 if (err < 0)
1782 return err;
1783 }
1784
1785 for (j = 0; j < 0x10; ++j) {
1786 if (endpoints[i].out_cables & (1 << j)) {
a509574e
AG		 1787 snd_usbmidi_init_substream(umidi,
1788 SNDRV_RAWMIDI_STREAM_OUTPUT,
1789 out_ports,
1da177e4
LT		 1790 &umidi->endpoints[i].out->ports[j].substream);
1791 ++out_ports;
1792 }
1793 if (endpoints[i].in_cables & (1 << j)) {
a509574e
AG		 1794 snd_usbmidi_init_substream(umidi,
1795 SNDRV_RAWMIDI_STREAM_INPUT,
1796 in_ports,
1da177e4
LT		 1797 &umidi->endpoints[i].in->ports[j].substream);
1798 ++in_ports;
1799 }
1800 }
1801 }
0ba41d91 1802 dev_dbg(&umidi->dev->dev, "created %d output and %d input ports\n",
1da177e4
LT		 1803 out_ports, in_ports);
1804 return 0;
1805}
1806
1807/*
1808 * Returns MIDIStreaming device capabilities.
1809 */
a509574e
AG		 1810static int snd_usbmidi_get_ms_info(struct snd_usb_midi *umidi,
1811 struct snd_usb_midi_endpoint_info *endpoints)
1da177e4 1812{
a509574e 1813 struct usb_interface *intf;
1da177e4 1814 struct usb_host_interface *hostif;
a509574e
AG		 1815 struct usb_interface_descriptor *intfd;
1816 struct usb_ms_header_descriptor *ms_header;
1da177e4 1817 struct usb_host_endpoint *hostep;
a509574e
AG		 1818 struct usb_endpoint_descriptor *ep;
1819 struct usb_ms_endpoint_descriptor *ms_ep;
1da177e4
LT		 1820 int i, epidx;
1821
1822 intf = umidi->iface;
1823 if (!intf)
1824 return -ENXIO;
1825 hostif = &intf->altsetting[0];
1826 intfd = get_iface_desc(hostif);
a509574e 1827 ms_header = (struct usb_ms_header_descriptor *)hostif->extra;
1da177e4
LT		 1828 if (hostif->extralen >= 7 &&
1829 ms_header->bLength >= 7 &&
1830 ms_header->bDescriptorType == USB_DT_CS_INTERFACE &&
de48c7bc 1831 ms_header->bDescriptorSubtype == UAC_HEADER)
0ba41d91 1832 dev_dbg(&umidi->dev->dev, "MIDIStreaming version %02x.%02x\n",
1da177e4
LT		 1833 ms_header->bcdMSC[1], ms_header->bcdMSC[0]);
1834 else
0ba41d91
TI		 1835 dev_warn(&umidi->dev->dev,
1836 "MIDIStreaming interface descriptor not found\n");
1da177e4
LT		 1837
1838 epidx = 0;
1839 for (i = 0; i < intfd->bNumEndpoints; ++i) {
1840 hostep = &hostif->endpoint[i];
1841 ep = get_ep_desc(hostep);
913ae5a2 1842 if (!usb_endpoint_xfer_bulk(ep) && !usb_endpoint_xfer_int(ep))
1da177e4 1843 continue;
a509574e 1844 ms_ep = (struct usb_ms_endpoint_descriptor *)hostep->extra;
1da177e4
LT		 1845 if (hostep->extralen < 4 ||
1846 ms_ep->bLength < 4 ||
1847 ms_ep->bDescriptorType != USB_DT_CS_ENDPOINT ||
de48c7bc 1848 ms_ep->bDescriptorSubtype != UAC_MS_GENERAL)
1da177e4 1849 continue;
42a6e66f 1850 if (usb_endpoint_dir_out(ep)) {
1da177e4
LT		 1851 if (endpoints[epidx].out_ep) {
1852 if (++epidx >= MIDI_MAX_ENDPOINTS) {
0ba41d91
TI		 1853 dev_warn(&umidi->dev->dev,
1854 "too many endpoints\n");
1da177e4
LT		 1855 break;
1856 }
1857 }
42a6e66f
JL		 1858 endpoints[epidx].out_ep = usb_endpoint_num(ep);
1859 if (usb_endpoint_xfer_int(ep))
1da177e4 1860 endpoints[epidx].out_interval = ep->bInterval;
d82af9f9 1861 else if (snd_usb_get_speed(umidi->dev) == USB_SPEED_LOW)
56162aab
CL		 1862 /*
1863 * Low speed bulk transfers don't exist, so
1864 * force interrupt transfers for devices like
1865 * ESI MIDI Mate that try to use them anyway.
1866 */
1867 endpoints[epidx].out_interval = 1;
a509574e
AG		 1868 endpoints[epidx].out_cables =
1869 (1 << ms_ep->bNumEmbMIDIJack) - 1;
0ba41d91 1870 dev_dbg(&umidi->dev->dev, "EP %02X: %d jack(s)\n",
a509574e 1871 ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1da177e4
LT		 1872 } else {
1873 if (endpoints[epidx].in_ep) {
1874 if (++epidx >= MIDI_MAX_ENDPOINTS) {
0ba41d91
TI		 1875 dev_warn(&umidi->dev->dev,
1876 "too many endpoints\n");
1da177e4
LT		 1877 break;
1878 }
1879 }
42a6e66f
JL		 1880 endpoints[epidx].in_ep = usb_endpoint_num(ep);
1881 if (usb_endpoint_xfer_int(ep))
1da177e4 1882 endpoints[epidx].in_interval = ep->bInterval;
d82af9f9 1883 else if (snd_usb_get_speed(umidi->dev) == USB_SPEED_LOW)
56162aab 1884 endpoints[epidx].in_interval = 1;
a509574e
AG		 1885 endpoints[epidx].in_cables =
1886 (1 << ms_ep->bNumEmbMIDIJack) - 1;
0ba41d91 1887 dev_dbg(&umidi->dev->dev, "EP %02X: %d jack(s)\n",
a509574e 1888 ep->bEndpointAddress, ms_ep->bNumEmbMIDIJack);
1da177e4
LT		 1889 }
1890 }
1891 return 0;
1892}
1893
96f61d9a
CL		 1894static int roland_load_info(struct snd_kcontrol *kcontrol,
1895 struct snd_ctl_elem_info *info)
1896{
1897 static const char *const names[] = { "High Load", "Light Load" };
1898
2a1803a7 1899 return snd_ctl_enum_info(info, 1, 2, names);
96f61d9a
CL		 1900}
1901
1902static int roland_load_get(struct snd_kcontrol *kcontrol,
1903 struct snd_ctl_elem_value *value)
1904{
1905 value->value.enumerated.item[0] = kcontrol->private_value;
1906 return 0;
1907}
1908
1909static int roland_load_put(struct snd_kcontrol *kcontrol,
1910 struct snd_ctl_elem_value *value)
1911{
a509574e 1912 struct snd_usb_midi *umidi = kcontrol->private_data;
96f61d9a
CL		 1913 int changed;
1914
1915 if (value->value.enumerated.item[0] > 1)
1916 return -EINVAL;
1917 mutex_lock(&umidi->mutex);
1918 changed = value->value.enumerated.item[0] != kcontrol->private_value;
1919 if (changed)
1920 kcontrol->private_value = value->value.enumerated.item[0];
1921 mutex_unlock(&umidi->mutex);
1922 return changed;
1923}
1924
1925static struct snd_kcontrol_new roland_load_ctl = {
1926 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1927 .name = "MIDI Input Mode",
1928 .info = roland_load_info,
1929 .get = roland_load_get,
1930 .put = roland_load_put,
1931 .private_value = 1,
1932};
1933
1da177e4
LT		 1934/*
1935 * On Roland devices, use the second alternate setting to be able to use
1936 * the interrupt input endpoint.
1937 */
a509574e 1938static void snd_usbmidi_switch_roland_altsetting(struct snd_usb_midi *umidi)
1da177e4 1939{
a509574e 1940 struct usb_interface *intf;
1da177e4 1941 struct usb_host_interface *hostif;
a509574e 1942 struct usb_interface_descriptor *intfd;
1da177e4
LT		 1943
1944 intf = umidi->iface;
1945 if (!intf || intf->num_altsetting != 2)
1946 return;
1947
1948 hostif = &intf->altsetting[1];
1949 intfd = get_iface_desc(hostif);
ac774236
KM		 1950 /* If either or both of the endpoints support interrupt transfer,
1951 * then use the alternate setting
1952 */
1da177e4 1953 if (intfd->bNumEndpoints != 2 ||
ac774236
KM		 1954 !((get_endpoint(hostif, 0)->bmAttributes &
1955 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT ||
1956 (get_endpoint(hostif, 1)->bmAttributes &
1957 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT))
1da177e4
LT		 1958 return;
1959
0ba41d91 1960 dev_dbg(&umidi->dev->dev, "switching to altsetting %d with int ep\n",
1da177e4 1961 intfd->bAlternateSetting);
d82af9f9 1962 usb_set_interface(umidi->dev, intfd->bInterfaceNumber,
1da177e4 1963 intfd->bAlternateSetting);
96f61d9a
CL		 1964
1965 umidi->roland_load_ctl = snd_ctl_new1(&roland_load_ctl, umidi);
d82af9f9 1966 if (snd_ctl_add(umidi->card, umidi->roland_load_ctl) < 0)
96f61d9a 1967 umidi->roland_load_ctl = NULL;
1da177e4
LT		 1968}
1969
1970/*
1971 * Try to find any usable endpoints in the interface.
1972 */
a509574e
AG		 1973static int snd_usbmidi_detect_endpoints(struct snd_usb_midi *umidi,
1974 struct snd_usb_midi_endpoint_info *endpoint,
1da177e4
LT		 1975 int max_endpoints)
1976{
a509574e 1977 struct usb_interface *intf;
1da177e4 1978 struct usb_host_interface *hostif;
a509574e
AG		 1979 struct usb_interface_descriptor *intfd;
1980 struct usb_endpoint_descriptor *epd;
1da177e4
LT		 1981 int i, out_eps = 0, in_eps = 0;
1982
d82af9f9 1983 if (USB_ID_VENDOR(umidi->usb_id) == 0x0582)
1da177e4
LT		 1984 snd_usbmidi_switch_roland_altsetting(umidi);
1985
c1ab5d59 1986 if (endpoint[0].out_ep || endpoint[0].in_ep)
21af7d8c 1987 return 0;
c1ab5d59 1988
1da177e4
LT		 1989 intf = umidi->iface;
1990 if (!intf || intf->num_altsetting < 1)
1991 return -ENOENT;
1992 hostif = intf->cur_altsetting;
1993 intfd = get_iface_desc(hostif);
1994
1995 for (i = 0; i < intfd->bNumEndpoints; ++i) {
1996 epd = get_endpoint(hostif, i);
913ae5a2
JL		 1997 if (!usb_endpoint_xfer_bulk(epd) &&
1998 !usb_endpoint_xfer_int(epd))
1da177e4
LT		 1999 continue;
2000 if (out_eps < max_endpoints &&
42a6e66f
JL		 2001 usb_endpoint_dir_out(epd)) {
2002 endpoint[out_eps].out_ep = usb_endpoint_num(epd);
2003 if (usb_endpoint_xfer_int(epd))
1da177e4
LT		 2004 endpoint[out_eps].out_interval = epd->bInterval;
2005 ++out_eps;
2006 }
2007 if (in_eps < max_endpoints &&
42a6e66f
JL		 2008 usb_endpoint_dir_in(epd)) {
2009 endpoint[in_eps].in_ep = usb_endpoint_num(epd);
2010 if (usb_endpoint_xfer_int(epd))
1da177e4
LT		 2011 endpoint[in_eps].in_interval = epd->bInterval;
2012 ++in_eps;
2013 }
2014 }
2015 return (out_eps || in_eps) ? 0 : -ENOENT;
2016}
2017
2018/*
2019 * Detects the endpoints for one-port-per-endpoint protocols.
2020 */
a509574e
AG		 2021static int snd_usbmidi_detect_per_port_endpoints(struct snd_usb_midi *umidi,
2022 struct snd_usb_midi_endpoint_info *endpoints)
1da177e4
LT		 2023{
2024 int err, i;
21af7d8c 2025
1da177e4
LT		 2026 err = snd_usbmidi_detect_endpoints(umidi, endpoints, MIDI_MAX_ENDPOINTS);
2027 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
2028 if (endpoints[i].out_ep)
2029 endpoints[i].out_cables = 0x0001;
2030 if (endpoints[i].in_ep)
2031 endpoints[i].in_cables = 0x0001;
2032 }
2033 return err;
2034}
2035
2036/*
2037 * Detects the endpoints and ports of Yamaha devices.
2038 */
a509574e
AG		 2039static int snd_usbmidi_detect_yamaha(struct snd_usb_midi *umidi,
2040 struct snd_usb_midi_endpoint_info *endpoint)
1da177e4 2041{
a509574e 2042 struct usb_interface *intf;
1da177e4 2043 struct usb_host_interface *hostif;
a509574e
AG		 2044 struct usb_interface_descriptor *intfd;
2045 uint8_t *cs_desc;
1da177e4
LT		 2046
2047 intf = umidi->iface;
2048 if (!intf)
2049 return -ENOENT;
2050 hostif = intf->altsetting;
2051 intfd = get_iface_desc(hostif);
2052 if (intfd->bNumEndpoints < 1)
2053 return -ENOENT;
2054
2055 /*
2056 * For each port there is one MIDI_IN/OUT_JACK descriptor, not
2057 * necessarily with any useful contents. So simply count 'em.
2058 */
2059 for (cs_desc = hostif->extra;
2060 cs_desc < hostif->extra + hostif->extralen && cs_desc[0] >= 2;
2061 cs_desc += cs_desc[0]) {
c4a87ef4 2062 if (cs_desc[1] == USB_DT_CS_INTERFACE) {
de48c7bc 2063 if (cs_desc[2] == UAC_MIDI_IN_JACK)
a509574e
AG		 2064 endpoint->in_cables =
2065 (endpoint->in_cables << 1) | 1;
de48c7bc 2066 else if (cs_desc[2] == UAC_MIDI_OUT_JACK)
a509574e
AG		 2067 endpoint->out_cables =
2068 (endpoint->out_cables << 1) | 1;
1da177e4
LT		 2069 }
2070 }
2071 if (!endpoint->in_cables && !endpoint->out_cables)
2072 return -ENOENT;
2073
2074 return snd_usbmidi_detect_endpoints(umidi, endpoint, 1);
2075}
2076
aafe77cc
CL		 2077/*
2078 * Detects the endpoints and ports of Roland devices.
2079 */
a509574e
AG		 2080static int snd_usbmidi_detect_roland(struct snd_usb_midi *umidi,
2081 struct snd_usb_midi_endpoint_info *endpoint)
aafe77cc 2082{
a509574e 2083 struct usb_interface *intf;
aafe77cc 2084 struct usb_host_interface *hostif;
a509574e 2085 u8 *cs_desc;
aafe77cc
CL		 2086
2087 intf = umidi->iface;
2088 if (!intf)
2089 return -ENOENT;
2090 hostif = intf->altsetting;
2091 /*
2092 * Some devices have a descriptor <06 24 F1 02 <inputs> <outputs>>,
2093 * some have standard class descriptors, or both kinds, or neither.
2094 */
2095 for (cs_desc = hostif->extra;
2096 cs_desc < hostif->extra + hostif->extralen && cs_desc[0] >= 2;
2097 cs_desc += cs_desc[0]) {
2098 if (cs_desc[0] >= 6 &&
2099 cs_desc[1] == USB_DT_CS_INTERFACE &&
2100 cs_desc[2] == 0xf1 &&
2101 cs_desc[3] == 0x02) {
2102 endpoint->in_cables = (1 << cs_desc[4]) - 1;
2103 endpoint->out_cables = (1 << cs_desc[5]) - 1;
2104 return snd_usbmidi_detect_endpoints(umidi, endpoint, 1);
2105 } else if (cs_desc[0] >= 7 &&
2106 cs_desc[1] == USB_DT_CS_INTERFACE &&
2107 cs_desc[2] == UAC_HEADER) {
2108 return snd_usbmidi_get_ms_info(umidi, endpoint);
2109 }
2110 }
2111
2112 return -ENODEV;
2113}
2114
1da177e4
LT		 2115/*
2116 * Creates the endpoints and their ports for Midiman devices.
2117 */
a509574e
AG		 2118static int snd_usbmidi_create_endpoints_midiman(struct snd_usb_midi *umidi,
2119 struct snd_usb_midi_endpoint_info *endpoint)
1da177e4 2120{
86e07d34 2121 struct snd_usb_midi_endpoint_info ep_info;
a509574e 2122 struct usb_interface *intf;
1da177e4 2123 struct usb_host_interface *hostif;
a509574e
AG		 2124 struct usb_interface_descriptor *intfd;
2125 struct usb_endpoint_descriptor *epd;
1da177e4
LT		 2126 int cable, err;
2127
2128 intf = umidi->iface;
2129 if (!intf)
2130 return -ENOENT;
2131 hostif = intf->altsetting;
2132 intfd = get_iface_desc(hostif);
2133 /*
2134 * The various MidiSport devices have more or less random endpoint
2135 * numbers, so we have to identify the endpoints by their index in
2136 * the descriptor array, like the driver for that other OS does.
2137 *
2138 * There is one interrupt input endpoint for all input ports, one
2139 * bulk output endpoint for even-numbered ports, and one for odd-
2140 * numbered ports. Both bulk output endpoints have corresponding
2141 * input bulk endpoints (at indices 1 and 3) which aren't used.
2142 */
2143 if (intfd->bNumEndpoints < (endpoint->out_cables > 0x0001 ? 5 : 3)) {
0ba41d91 2144 dev_dbg(&umidi->dev->dev, "not enough endpoints\n");
1da177e4
LT		 2145 return -ENOENT;
2146 }
2147
2148 epd = get_endpoint(hostif, 0);
913ae5a2 2149 if (!usb_endpoint_dir_in(epd) || !usb_endpoint_xfer_int(epd)) {
0ba41d91 2150 dev_dbg(&umidi->dev->dev, "endpoint[0] isn't interrupt\n");
1da177e4
LT		 2151 return -ENXIO;
2152 }
2153 epd = get_endpoint(hostif, 2);
913ae5a2 2154 if (!usb_endpoint_dir_out(epd) || !usb_endpoint_xfer_bulk(epd)) {
0ba41d91 2155 dev_dbg(&umidi->dev->dev, "endpoint[2] isn't bulk output\n");
1da177e4
LT		 2156 return -ENXIO;
2157 }
2158 if (endpoint->out_cables > 0x0001) {
2159 epd = get_endpoint(hostif, 4);
913ae5a2
JL		 2160 if (!usb_endpoint_dir_out(epd) ||
2161 !usb_endpoint_xfer_bulk(epd)) {
a509574e
AG		 2162 dev_dbg(&umidi->dev->dev,
2163 "endpoint[4] isn't bulk output\n");
1da177e4
LT		 2164 return -ENXIO;
2165 }
2166 }
2167
a509574e
AG		 2168 ep_info.out_ep = get_endpoint(hostif, 2)->bEndpointAddress &
2169 USB_ENDPOINT_NUMBER_MASK;
e156ac4c 2170 ep_info.out_interval = 0;
1da177e4 2171 ep_info.out_cables = endpoint->out_cables & 0x5555;
a509574e
AG		 2172 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info,
2173 &umidi->endpoints[0]);
1da177e4
LT		 2174 if (err < 0)
2175 return err;
2176
a509574e
AG		 2177 ep_info.in_ep = get_endpoint(hostif, 0)->bEndpointAddress &
2178 USB_ENDPOINT_NUMBER_MASK;
1da177e4
LT		 2179 ep_info.in_interval = get_endpoint(hostif, 0)->bInterval;
2180 ep_info.in_cables = endpoint->in_cables;
a509574e
AG		 2181 err = snd_usbmidi_in_endpoint_create(umidi, &ep_info,
2182 &umidi->endpoints[0]);
1da177e4
LT		 2183 if (err < 0)
2184 return err;
2185
2186 if (endpoint->out_cables > 0x0001) {
a509574e
AG		 2187 ep_info.out_ep = get_endpoint(hostif, 4)->bEndpointAddress &
2188 USB_ENDPOINT_NUMBER_MASK;
1da177e4 2189 ep_info.out_cables = endpoint->out_cables & 0xaaaa;
a509574e
AG		 2190 err = snd_usbmidi_out_endpoint_create(umidi, &ep_info,
2191 &umidi->endpoints[1]);
1da177e4
LT		 2192 if (err < 0)
2193 return err;
2194 }
2195
2196 for (cable = 0; cable < 0x10; ++cable) {
2197 if (endpoint->out_cables & (1 << cable))
a509574e
AG		 2198 snd_usbmidi_init_substream(umidi,
2199 SNDRV_RAWMIDI_STREAM_OUTPUT,
2200 cable,
1da177e4
LT		 2201 &umidi->endpoints[cable & 1].out->ports[cable].substream);
2202 if (endpoint->in_cables & (1 << cable))
a509574e
AG		 2203 snd_usbmidi_init_substream(umidi,
2204 SNDRV_RAWMIDI_STREAM_INPUT,
2205 cable,
1da177e4
LT		 2206 &umidi->endpoints[0].in->ports[cable].substream);
2207 }
2208 return 0;
2209}
2210
efdbe3c3 2211static const struct snd_rawmidi_global_ops snd_usbmidi_ops = {
a7b928ac
CL		 2212 .get_port_info = snd_usbmidi_get_port_info,
2213};
2214
a509574e 2215static int snd_usbmidi_create_rawmidi(struct snd_usb_midi *umidi,
1da177e4
LT		 2216 int out_ports, int in_ports)
2217{
86e07d34 2218 struct snd_rawmidi *rmidi;
1da177e4
LT		 2219 int err;
2220
d82af9f9
CL		 2221 err = snd_rawmidi_new(umidi->card, "USB MIDI",
2222 umidi->next_midi_device++,
1da177e4
LT		 2223 out_ports, in_ports, &rmidi);
2224 if (err < 0)
2225 return err;
d82af9f9 2226 strcpy(rmidi->name, umidi->card->shortname);
1da177e4
LT		 2227 rmidi->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT |
2228 SNDRV_RAWMIDI_INFO_INPUT |
2229 SNDRV_RAWMIDI_INFO_DUPLEX;
a7b928ac 2230 rmidi->ops = &snd_usbmidi_ops;
1da177e4
LT		 2231 rmidi->private_data = umidi;
2232 rmidi->private_free = snd_usbmidi_rawmidi_free;
a509574e
AG		 2233 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT,
2234 &snd_usbmidi_output_ops);
2235 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT,
2236 &snd_usbmidi_input_ops);
1da177e4
LT		 2237
2238 umidi->rmidi = rmidi;
2239 return 0;
2240}
2241
2242/*
2243 * Temporarily stop input.
2244 */
a509574e 2245void snd_usbmidi_input_stop(struct list_head *p)
1da177e4 2246{
a509574e 2247 struct snd_usb_midi *umidi;
4773d1fb 2248 unsigned int i, j;
1da177e4 2249
86e07d34 2250 umidi = list_entry(p, struct snd_usb_midi, list);
f5f16541
TI		 2251 if (!umidi->input_running)
2252 return;
1da177e4 2253 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
a509574e 2254 struct snd_usb_midi_endpoint *ep = &umidi->endpoints[i];
1da177e4 2255 if (ep->in)
4773d1fb
CL		 2256 for (j = 0; j < INPUT_URBS; ++j)
2257 usb_kill_urb(ep->in->urbs[j]);
1da177e4 2258 }
f5f16541 2259 umidi->input_running = 0;
1da177e4 2260}
ed136aca 2261EXPORT_SYMBOL(snd_usbmidi_input_stop);
1da177e4 2262
a509574e 2263static void snd_usbmidi_input_start_ep(struct snd_usb_midi_in_endpoint *ep)
1da177e4 2264{
4773d1fb
CL		 2265 unsigned int i;
2266
2267 if (!ep)
2268 return;
2269 for (i = 0; i < INPUT_URBS; ++i) {
a509574e 2270 struct urb *urb = ep->urbs[i];
d82af9f9 2271 urb->dev = ep->umidi->dev;
1da177e4
LT		 2272 snd_usbmidi_submit_urb(urb, GFP_KERNEL);
2273 }
2274}
2275
2276/*
2277 * Resume input after a call to snd_usbmidi_input_stop().
2278 */
a509574e 2279void snd_usbmidi_input_start(struct list_head *p)
1da177e4 2280{
a509574e 2281 struct snd_usb_midi *umidi;
1da177e4
LT		 2282 int i;
2283
86e07d34 2284 umidi = list_entry(p, struct snd_usb_midi, list);
f5f16541
TI		 2285 if (umidi->input_running || !umidi->opened[1])
2286 return;
1da177e4
LT		 2287 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i)
2288 snd_usbmidi_input_start_ep(umidi->endpoints[i].in);
f5f16541 2289 umidi->input_running = 1;
1da177e4 2290}
ed136aca 2291EXPORT_SYMBOL(snd_usbmidi_input_start);
1da177e4 2292
f7881e5e
AG		 2293/*
2294 * Prepare for suspend. Typically called from the USB suspend callback.
2295 */
2296void snd_usbmidi_suspend(struct list_head *p)
2297{
2298 struct snd_usb_midi *umidi;
2299
2300 umidi = list_entry(p, struct snd_usb_midi, list);
2301 mutex_lock(&umidi->mutex);
2302 snd_usbmidi_input_stop(p);
2303 mutex_unlock(&umidi->mutex);
2304}
2305EXPORT_SYMBOL(snd_usbmidi_suspend);
2306
2307/*
2308 * Resume. Typically called from the USB resume callback.
2309 */
2310void snd_usbmidi_resume(struct list_head *p)
2311{
2312 struct snd_usb_midi *umidi;
2313
2314 umidi = list_entry(p, struct snd_usb_midi, list);
2315 mutex_lock(&umidi->mutex);
2316 snd_usbmidi_input_start(p);
2317 mutex_unlock(&umidi->mutex);
2318}
2319EXPORT_SYMBOL(snd_usbmidi_resume);
2320
1da177e4
LT		 2321/*
2322 * Creates and registers everything needed for a MIDI streaming interface.
2323 */
79289e24
TI		 2324int __snd_usbmidi_create(struct snd_card *card,
2325 struct usb_interface *iface,
2326 struct list_head *midi_list,
2327 const struct snd_usb_audio_quirk *quirk,
2328 unsigned int usb_id)
1da177e4 2329{
a509574e 2330 struct snd_usb_midi *umidi;
86e07d34 2331 struct snd_usb_midi_endpoint_info endpoints[MIDI_MAX_ENDPOINTS];
1da177e4
LT		 2332 int out_ports, in_ports;
2333 int i, err;
2334
561b220a 2335 umidi = kzalloc(sizeof(*umidi), GFP_KERNEL);
1da177e4
LT		 2336 if (!umidi)
2337 return -ENOMEM;
d82af9f9
CL		 2338 umidi->dev = interface_to_usbdev(iface);
2339 umidi->card = card;
1da177e4
LT		 2340 umidi->iface = iface;
2341 umidi->quirk = quirk;
2342 umidi->usb_protocol_ops = &snd_usbmidi_standard_ops;
c0792e00 2343 spin_lock_init(&umidi->disc_lock);
59866da9 2344 init_rwsem(&umidi->disc_rwsem);
96f61d9a 2345 mutex_init(&umidi->mutex);
79289e24
TI		 2346 if (!usb_id)
2347 usb_id = USB_ID(le16_to_cpu(umidi->dev->descriptor.idVendor),
d82af9f9 2348 le16_to_cpu(umidi->dev->descriptor.idProduct));
79289e24 2349 umidi->usb_id = usb_id;
28e237a9
TI		 2350 setup_timer(&umidi->error_timer, snd_usbmidi_error_timer,
2351 (unsigned long)umidi);
1da177e4
LT		 2352
2353 /* detect the endpoint(s) to use */
2354 memset(endpoints, 0, sizeof(endpoints));
d1bda045
CL		 2355 switch (quirk ? quirk->type : QUIRK_MIDI_STANDARD_INTERFACE) {
2356 case QUIRK_MIDI_STANDARD_INTERFACE:
1da177e4 2357 err = snd_usbmidi_get_ms_info(umidi, endpoints);
d82af9f9 2358 if (umidi->usb_id == USB_ID(0x0763, 0x0150)) /* M-Audio Uno */
d05cc104
CL		 2359 umidi->usb_protocol_ops =
2360 &snd_usbmidi_maudio_broken_running_status_ops;
d1bda045 2361 break;
030a07e4
KW		 2362 case QUIRK_MIDI_US122L:
2363 umidi->usb_protocol_ops = &snd_usbmidi_122l_ops;
2364 /* fall through */
d1bda045
CL		 2365 case QUIRK_MIDI_FIXED_ENDPOINT:
2366 memcpy(&endpoints[0], quirk->data,
86e07d34 2367 sizeof(struct snd_usb_midi_endpoint_info));
d1bda045
CL		 2368 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
2369 break;
2370 case QUIRK_MIDI_YAMAHA:
2371 err = snd_usbmidi_detect_yamaha(umidi, &endpoints[0]);
2372 break;
aafe77cc
CL		 2373 case QUIRK_MIDI_ROLAND:
2374 err = snd_usbmidi_detect_roland(umidi, &endpoints[0]);
2375 break;
d1bda045
CL		 2376 case QUIRK_MIDI_MIDIMAN:
2377 umidi->usb_protocol_ops = &snd_usbmidi_midiman_ops;
2378 memcpy(&endpoints[0], quirk->data,
86e07d34 2379 sizeof(struct snd_usb_midi_endpoint_info));
d1bda045
CL		 2380 err = 0;
2381 break;
2382 case QUIRK_MIDI_NOVATION:
2383 umidi->usb_protocol_ops = &snd_usbmidi_novation_ops;
2384 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2385 break;
c7f57216 2386 case QUIRK_MIDI_RAW_BYTES:
d1bda045 2387 umidi->usb_protocol_ops = &snd_usbmidi_raw_ops;
55de5ef9
CL		 2388 /*
2389 * Interface 1 contains isochronous endpoints, but with the same
2390 * numbers as in interface 0. Since it is interface 1 that the
2391 * USB core has most recently seen, these descriptors are now
2392 * associated with the endpoint numbers. This will foul up our
2393 * attempts to submit bulk/interrupt URBs to the endpoints in
2394 * interface 0, so we have to make sure that the USB core looks
2395 * again at interface 0 by calling usb_set_interface() on it.
2396 */
c7f57216
CL		 2397 if (umidi->usb_id == USB_ID(0x07fd, 0x0001)) /* MOTU Fastlane */
2398 usb_set_interface(umidi->dev, 0, 0);
d1bda045
CL		 2399 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2400 break;
2401 case QUIRK_MIDI_EMAGIC:
2402 umidi->usb_protocol_ops = &snd_usbmidi_emagic_ops;
2403 memcpy(&endpoints[0], quirk->data,
86e07d34 2404 sizeof(struct snd_usb_midi_endpoint_info));
d1bda045
CL		 2405 err = snd_usbmidi_detect_endpoints(umidi, &endpoints[0], 1);
2406 break;
cc7a59bd 2407 case QUIRK_MIDI_CME:
61870aed 2408 umidi->usb_protocol_ops = &snd_usbmidi_cme_ops;
d1bda045
CL		 2409 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2410 break;
4434ade8
KF		 2411 case QUIRK_MIDI_AKAI:
2412 umidi->usb_protocol_ops = &snd_usbmidi_akai_ops;
2413 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2414 /* endpoint 1 is input-only */
2415 endpoints[1].out_cables = 0;
2416 break;
1ef0e0a0
KA		 2417 case QUIRK_MIDI_FTDI:
2418 umidi->usb_protocol_ops = &snd_usbmidi_ftdi_ops;
2419
2420 /* set baud rate to 31250 (48 MHz / 16 / 96) */
2421 err = usb_control_msg(umidi->dev, usb_sndctrlpipe(umidi->dev, 0),
2422 3, 0x40, 0x60, 0, NULL, 0, 1000);
2423 if (err < 0)
2424 break;
2425
1ca8b201
CL		 2426 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2427 break;
2428 case QUIRK_MIDI_CH345:
a91e627e 2429 umidi->usb_protocol_ops = &snd_usbmidi_ch345_broken_sysex_ops;
1ef0e0a0
KA		 2430 err = snd_usbmidi_detect_per_port_endpoints(umidi, endpoints);
2431 break;
d1bda045 2432 default:
a509574e
AG		 2433 dev_err(&umidi->dev->dev, "invalid quirk type %d\n",
2434 quirk->type);
d1bda045
CL		 2435 err = -ENXIO;
2436 break;
1da177e4
LT		 2437 }
2438 if (err < 0) {
2439 kfree(umidi);
2440 return err;
2441 }
2442
2443 /* create rawmidi device */
2444 out_ports = 0;
2445 in_ports = 0;
2446 for (i = 0; i < MIDI_MAX_ENDPOINTS; ++i) {
fbc54391
AM		 2447 out_ports += hweight16(endpoints[i].out_cables);
2448 in_ports += hweight16(endpoints[i].in_cables);
1da177e4
LT		 2449 }
2450 err = snd_usbmidi_create_rawmidi(umidi, out_ports, in_ports);
2451 if (err < 0) {
2452 kfree(umidi);
2453 return err;
2454 }
2455
2456 /* create endpoint/port structures */
2457 if (quirk && quirk->type == QUIRK_MIDI_MIDIMAN)
2458 err = snd_usbmidi_create_endpoints_midiman(umidi, &endpoints[0]);
2459 else
2460 err = snd_usbmidi_create_endpoints(umidi, endpoints);
2461 if (err < 0) {
1da177e4
LT		 2462 return err;
2463 }
2464
cbc200bc
CL		 2465 usb_autopm_get_interface_no_resume(umidi->iface);
2466
d82af9f9 2467 list_add_tail(&umidi->list, midi_list);
1da177e4
LT		 2468 return 0;
2469}
79289e24 2470EXPORT_SYMBOL(__snd_usbmidi_create);
Linux 6.x block layer and io_uring tree(s)