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