?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
include: replace linux/module.h with "struct module" wherever possible
[linux-2.6/next.git] / drivers / usb / gadget / gmidi.c
blob305a8a8d3265beec7d17317c2ebdb2775169aa85
1 /*
2 * gmidi.c -- USB MIDI Gadget Driver
3 *
4 * Copyright (C) 2006 Thumtronics Pty Ltd.
5 * Developed for Thumtronics by Grey Innovation
6 * Ben Williamson <ben.williamson@greyinnovation.com>
7 *
8 * This software is distributed under the terms of the GNU General Public
9 * License ("GPL") version 2, as published by the Free Software Foundation.
10 *
11 * This code is based in part on:
12 *
13 * Gadget Zero driver, Copyright (C) 2003-2004 David Brownell.
14 * USB Audio driver, Copyright (C) 2002 by Takashi Iwai.
15 * USB MIDI driver, Copyright (C) 2002-2005 Clemens Ladisch.
16 *
17 * Refer to the USB Device Class Definition for MIDI Devices:
18 * http://www.usb.org/developers/devclass_docs/midi10.pdf
19 */
20
21 /* #define VERBOSE_DEBUG */
22
23 #include <linux/kernel.h>
24 #include <linux/slab.h>
25 #include <linux/utsname.h>
26 #include <linux/module.h>
27 #include <linux/device.h>
28
29 #include <sound/core.h>
30 #include <sound/initval.h>
31 #include <sound/rawmidi.h>
32
33 #include <linux/usb/ch9.h>
34 #include <linux/usb/gadget.h>
35 #include <linux/usb/audio.h>
36 #include <linux/usb/midi.h>
37
38 #include "gadget_chips.h"
39
40
41 /*
42 * Kbuild is not very cooperative with respect to linking separately
43 * compiled library objects into one module. So for now we won't use
44 * separate compilation ... ensuring init/exit sections work to shrink
45 * the runtime footprint, and giving us at least some parts of what
46 * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
47 */
48 #include "usbstring.c"
49 #include "config.c"
50 #include "epautoconf.c"
51
52 /*-------------------------------------------------------------------------*/
53
54
55 MODULE_AUTHOR("Ben Williamson");
56 MODULE_LICENSE("GPL v2");
57
58 #define DRIVER_VERSION "25 Jul 2006"
59
60 static const char shortname[] = "g_midi";
61 static const char longname[] = "MIDI Gadget";
62
63 static int index = SNDRV_DEFAULT_IDX1;
64 static char *id = SNDRV_DEFAULT_STR1;
65
66 module_param(index, int, 0444);
67 MODULE_PARM_DESC(index, "Index value for the USB MIDI Gadget adapter.");
68 module_param(id, charp, 0444);
69 MODULE_PARM_DESC(id, "ID string for the USB MIDI Gadget adapter.");
70
71 /* Some systems will want different product identifiers published in the
72 * device descriptor, either numbers or strings or both. These string
73 * parameters are in UTF-8 (superset of ASCII's 7 bit characters).
74 */
75
76 static ushort idVendor;
77 module_param(idVendor, ushort, S_IRUGO);
78 MODULE_PARM_DESC(idVendor, "USB Vendor ID");
79
80 static ushort idProduct;
81 module_param(idProduct, ushort, S_IRUGO);
82 MODULE_PARM_DESC(idProduct, "USB Product ID");
83
84 static ushort bcdDevice;
85 module_param(bcdDevice, ushort, S_IRUGO);
86 MODULE_PARM_DESC(bcdDevice, "USB Device version (BCD)");
87
88 static char *iManufacturer;
89 module_param(iManufacturer, charp, S_IRUGO);
90 MODULE_PARM_DESC(iManufacturer, "USB Manufacturer string");
91
92 static char *iProduct;
93 module_param(iProduct, charp, S_IRUGO);
94 MODULE_PARM_DESC(iProduct, "USB Product string");
95
96 static char *iSerialNumber;
97 module_param(iSerialNumber, charp, S_IRUGO);
98 MODULE_PARM_DESC(iSerialNumber, "SerialNumber");
99
100 /*
101 * this version autoconfigures as much as possible,
102 * which is reasonable for most "bulk-only" drivers.
103 */
104 static const char *EP_IN_NAME;
105 static const char *EP_OUT_NAME;
106
107
108 /* big enough to hold our biggest descriptor */
109 #define USB_BUFSIZ 256
110
111
112 /* This is a gadget, and the IN/OUT naming is from the host's perspective.
113 USB -> OUT endpoint -> rawmidi
114 USB <- IN endpoint <- rawmidi */
115 struct gmidi_in_port {
116 struct gmidi_device* dev;
117 int active;
118 uint8_t cable; /* cable number << 4 */
119 uint8_t state;
120 #define STATE_UNKNOWN 0
121 #define STATE_1PARAM 1
122 #define STATE_2PARAM_1 2
123 #define STATE_2PARAM_2 3
124 #define STATE_SYSEX_0 4
125 #define STATE_SYSEX_1 5
126 #define STATE_SYSEX_2 6
127 uint8_t data[2];
128 };
129
130 struct gmidi_device {
131 spinlock_t lock;
132 struct usb_gadget *gadget;
133 struct usb_request *req; /* for control responses */
134 u8 config;
135 struct usb_ep *in_ep, *out_ep;
136 struct snd_card *card;
137 struct snd_rawmidi *rmidi;
138 struct snd_rawmidi_substream *in_substream;
139 struct snd_rawmidi_substream *out_substream;
140
141 /* For the moment we only support one port in
142 each direction, but in_port is kept as a
143 separate struct so we can have more later. */
144 struct gmidi_in_port in_port;
145 unsigned long out_triggered;
146 struct tasklet_struct tasklet;
147 };
148
149 static void gmidi_transmit(struct gmidi_device* dev, struct usb_request* req);
150
151
152 #define DBG(d, fmt, args...) \
153 dev_dbg(&(d)->gadget->dev , fmt , ## args)
154 #define VDBG(d, fmt, args...) \
155 dev_vdbg(&(d)->gadget->dev , fmt , ## args)
156 #define ERROR(d, fmt, args...) \
157 dev_err(&(d)->gadget->dev , fmt , ## args)
158 #define INFO(d, fmt, args...) \
159 dev_info(&(d)->gadget->dev , fmt , ## args)
160
161
162 static unsigned buflen = 256;
163 static unsigned qlen = 32;
164
165 module_param(buflen, uint, S_IRUGO);
166 module_param(qlen, uint, S_IRUGO);
167
168
169 /* Thanks to Grey Innovation for donating this product ID.
170 *
171 * DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
172 * Instead: allocate your own, using normal USB-IF procedures.
173 */
174 #define DRIVER_VENDOR_NUM 0x17b3 /* Grey Innovation */
175 #define DRIVER_PRODUCT_NUM 0x0004 /* Linux-USB "MIDI Gadget" */
176
177
178 /*
179 * DESCRIPTORS ... most are static, but strings and (full)
180 * configuration descriptors are built on demand.
181 */
182
183 #define STRING_MANUFACTURER 25
184 #define STRING_PRODUCT 42
185 #define STRING_SERIAL 101
186 #define STRING_MIDI_GADGET 250
187
188 /* We only have the one configuration, it's number 1. */
189 #define GMIDI_CONFIG 1
190
191 /* We have two interfaces- AudioControl and MIDIStreaming */
192 #define GMIDI_AC_INTERFACE 0
193 #define GMIDI_MS_INTERFACE 1
194 #define GMIDI_NUM_INTERFACES 2
195
196 DECLARE_UAC_AC_HEADER_DESCRIPTOR(1);
197 DECLARE_USB_MIDI_OUT_JACK_DESCRIPTOR(1);
198 DECLARE_USB_MS_ENDPOINT_DESCRIPTOR(1);
199
200 /* B.1 Device Descriptor */
201 static struct usb_device_descriptor device_desc = {
202 .bLength = USB_DT_DEVICE_SIZE,
203 .bDescriptorType = USB_DT_DEVICE,
204 .bcdUSB = cpu_to_le16(0x0200),
205 .bDeviceClass = USB_CLASS_PER_INTERFACE,
206 .idVendor = cpu_to_le16(DRIVER_VENDOR_NUM),
207 .idProduct = cpu_to_le16(DRIVER_PRODUCT_NUM),
208 .iManufacturer = STRING_MANUFACTURER,
209 .iProduct = STRING_PRODUCT,
210 .bNumConfigurations = 1,
211 };
212
213 /* B.2 Configuration Descriptor */
214 static struct usb_config_descriptor config_desc = {
215 .bLength = USB_DT_CONFIG_SIZE,
216 .bDescriptorType = USB_DT_CONFIG,
217 /* compute wTotalLength on the fly */
218 .bNumInterfaces = GMIDI_NUM_INTERFACES,
219 .bConfigurationValue = GMIDI_CONFIG,
220 .iConfiguration = STRING_MIDI_GADGET,
221 /*
222 * FIXME: When embedding this driver in a device,
223 * these need to be set to reflect the actual
224 * power properties of the device. Is it selfpowered?
225 */
226 .bmAttributes = USB_CONFIG_ATT_ONE,
227 .bMaxPower = CONFIG_USB_GADGET_VBUS_DRAW / 2,
228 };
229
230 /* B.3.1 Standard AC Interface Descriptor */
231 static const struct usb_interface_descriptor ac_interface_desc = {
232 .bLength = USB_DT_INTERFACE_SIZE,
233 .bDescriptorType = USB_DT_INTERFACE,
234 .bInterfaceNumber = GMIDI_AC_INTERFACE,
235 .bNumEndpoints = 0,
236 .bInterfaceClass = USB_CLASS_AUDIO,
237 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL,
238 .iInterface = STRING_MIDI_GADGET,
239 };
240
241 /* B.3.2 Class-Specific AC Interface Descriptor */
242 static const struct uac1_ac_header_descriptor_1 ac_header_desc = {
243 .bLength = UAC_DT_AC_HEADER_SIZE(1),
244 .bDescriptorType = USB_DT_CS_INTERFACE,
245 .bDescriptorSubtype = USB_MS_HEADER,
246 .bcdADC = cpu_to_le16(0x0100),
247 .wTotalLength = cpu_to_le16(UAC_DT_AC_HEADER_SIZE(1)),
248 .bInCollection = 1,
249 .baInterfaceNr = {
250 [0] = GMIDI_MS_INTERFACE,
251 }
252 };
253
254 /* B.4.1 Standard MS Interface Descriptor */
255 static const struct usb_interface_descriptor ms_interface_desc = {
256 .bLength = USB_DT_INTERFACE_SIZE,
257 .bDescriptorType = USB_DT_INTERFACE,
258 .bInterfaceNumber = GMIDI_MS_INTERFACE,
259 .bNumEndpoints = 2,
260 .bInterfaceClass = USB_CLASS_AUDIO,
261 .bInterfaceSubClass = USB_SUBCLASS_MIDISTREAMING,
262 .iInterface = STRING_MIDI_GADGET,
263 };
264
265 /* B.4.2 Class-Specific MS Interface Descriptor */
266 static const struct usb_ms_header_descriptor ms_header_desc = {
267 .bLength = USB_DT_MS_HEADER_SIZE,
268 .bDescriptorType = USB_DT_CS_INTERFACE,
269 .bDescriptorSubtype = USB_MS_HEADER,
270 .bcdMSC = cpu_to_le16(0x0100),
271 .wTotalLength = cpu_to_le16(USB_DT_MS_HEADER_SIZE
272 + 2*USB_DT_MIDI_IN_SIZE
273 + 2*USB_DT_MIDI_OUT_SIZE(1)),
274 };
275
276 #define JACK_IN_EMB 1
277 #define JACK_IN_EXT 2
278 #define JACK_OUT_EMB 3
279 #define JACK_OUT_EXT 4
280
281 /* B.4.3 MIDI IN Jack Descriptors */
282 static const struct usb_midi_in_jack_descriptor jack_in_emb_desc = {
283 .bLength = USB_DT_MIDI_IN_SIZE,
284 .bDescriptorType = USB_DT_CS_INTERFACE,
285 .bDescriptorSubtype = USB_MS_MIDI_IN_JACK,
286 .bJackType = USB_MS_EMBEDDED,
287 .bJackID = JACK_IN_EMB,
288 };
289
290 static const struct usb_midi_in_jack_descriptor jack_in_ext_desc = {
291 .bLength = USB_DT_MIDI_IN_SIZE,
292 .bDescriptorType = USB_DT_CS_INTERFACE,
293 .bDescriptorSubtype = USB_MS_MIDI_IN_JACK,
294 .bJackType = USB_MS_EXTERNAL,
295 .bJackID = JACK_IN_EXT,
296 };
297
298 /* B.4.4 MIDI OUT Jack Descriptors */
299 static const struct usb_midi_out_jack_descriptor_1 jack_out_emb_desc = {
300 .bLength = USB_DT_MIDI_OUT_SIZE(1),
301 .bDescriptorType = USB_DT_CS_INTERFACE,
302 .bDescriptorSubtype = USB_MS_MIDI_OUT_JACK,
303 .bJackType = USB_MS_EMBEDDED,
304 .bJackID = JACK_OUT_EMB,
305 .bNrInputPins = 1,
306 .pins = {
307 [0] = {
308 .baSourceID = JACK_IN_EXT,
309 .baSourcePin = 1,
310 }
311 }
312 };
313
314 static const struct usb_midi_out_jack_descriptor_1 jack_out_ext_desc = {
315 .bLength = USB_DT_MIDI_OUT_SIZE(1),
316 .bDescriptorType = USB_DT_CS_INTERFACE,
317 .bDescriptorSubtype = USB_MS_MIDI_OUT_JACK,
318 .bJackType = USB_MS_EXTERNAL,
319 .bJackID = JACK_OUT_EXT,
320 .bNrInputPins = 1,
321 .pins = {
322 [0] = {
323 .baSourceID = JACK_IN_EMB,
324 .baSourcePin = 1,
325 }
326 }
327 };
328
329 /* B.5.1 Standard Bulk OUT Endpoint Descriptor */
330 static struct usb_endpoint_descriptor bulk_out_desc = {
331 .bLength = USB_DT_ENDPOINT_AUDIO_SIZE,
332 .bDescriptorType = USB_DT_ENDPOINT,
333 .bEndpointAddress = USB_DIR_OUT,
334 .bmAttributes = USB_ENDPOINT_XFER_BULK,
335 };
336
337 /* B.5.2 Class-specific MS Bulk OUT Endpoint Descriptor */
338 static const struct usb_ms_endpoint_descriptor_1 ms_out_desc = {
339 .bLength = USB_DT_MS_ENDPOINT_SIZE(1),
340 .bDescriptorType = USB_DT_CS_ENDPOINT,
341 .bDescriptorSubtype = USB_MS_GENERAL,
342 .bNumEmbMIDIJack = 1,
343 .baAssocJackID = {
344 [0] = JACK_IN_EMB,
345 }
346 };
347
348 /* B.6.1 Standard Bulk IN Endpoint Descriptor */
349 static struct usb_endpoint_descriptor bulk_in_desc = {
350 .bLength = USB_DT_ENDPOINT_AUDIO_SIZE,
351 .bDescriptorType = USB_DT_ENDPOINT,
352 .bEndpointAddress = USB_DIR_IN,
353 .bmAttributes = USB_ENDPOINT_XFER_BULK,
354 };
355
356 /* B.6.2 Class-specific MS Bulk IN Endpoint Descriptor */
357 static const struct usb_ms_endpoint_descriptor_1 ms_in_desc = {
358 .bLength = USB_DT_MS_ENDPOINT_SIZE(1),
359 .bDescriptorType = USB_DT_CS_ENDPOINT,
360 .bDescriptorSubtype = USB_MS_GENERAL,
361 .bNumEmbMIDIJack = 1,
362 .baAssocJackID = {
363 [0] = JACK_OUT_EMB,
364 }
365 };
366
367 static const struct usb_descriptor_header *gmidi_function [] = {
368 (struct usb_descriptor_header *)&ac_interface_desc,
369 (struct usb_descriptor_header *)&ac_header_desc,
370 (struct usb_descriptor_header *)&ms_interface_desc,
371
372 (struct usb_descriptor_header *)&ms_header_desc,
373 (struct usb_descriptor_header *)&jack_in_emb_desc,
374 (struct usb_descriptor_header *)&jack_in_ext_desc,
375 (struct usb_descriptor_header *)&jack_out_emb_desc,
376 (struct usb_descriptor_header *)&jack_out_ext_desc,
377 /* If you add more jacks, update ms_header_desc.wTotalLength */
378
379 (struct usb_descriptor_header *)&bulk_out_desc,
380 (struct usb_descriptor_header *)&ms_out_desc,
381 (struct usb_descriptor_header *)&bulk_in_desc,
382 (struct usb_descriptor_header *)&ms_in_desc,
383 NULL,
384 };
385
386 static char manufacturer[50];
387 static char product_desc[40] = "MIDI Gadget";
388 static char serial_number[20];
389
390 /* static strings, in UTF-8 */
391 static struct usb_string strings [] = {
392 { STRING_MANUFACTURER, manufacturer, },
393 { STRING_PRODUCT, product_desc, },
394 { STRING_SERIAL, serial_number, },
395 { STRING_MIDI_GADGET, longname, },
396 { } /* end of list */
397 };
398
399 static struct usb_gadget_strings stringtab = {
400 .language = 0x0409, /* en-us */
401 .strings = strings,
402 };
403
404 static int config_buf(struct usb_gadget *gadget,
405 u8 *buf, u8 type, unsigned index)
406 {
407 int len;
408
409 /* only one configuration */
410 if (index != 0) {
411 return -EINVAL;
412 }
413 len = usb_gadget_config_buf(&config_desc,
414 buf, USB_BUFSIZ, gmidi_function);
415 if (len < 0) {
416 return len;
417 }
418 ((struct usb_config_descriptor *)buf)->bDescriptorType = type;
419 return len;
420 }
421
422 static struct usb_request *alloc_ep_req(struct usb_ep *ep, unsigned length)
423 {
424 struct usb_request *req;
425
426 req = usb_ep_alloc_request(ep, GFP_ATOMIC);
427 if (req) {
428 req->length = length;
429 req->buf = kmalloc(length, GFP_ATOMIC);
430 if (!req->buf) {
431 usb_ep_free_request(ep, req);
432 req = NULL;
433 }
434 }
435 return req;
436 }
437
438 static void free_ep_req(struct usb_ep *ep, struct usb_request *req)
439 {
440 kfree(req->buf);
441 usb_ep_free_request(ep, req);
442 }
443
444 static const uint8_t gmidi_cin_length[] = {
445 0, 0, 2, 3, 3, 1, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1
446 };
447
448 /*
449 * Receives a chunk of MIDI data.
450 */
451 static void gmidi_read_data(struct usb_ep *ep, int cable,
452 uint8_t *data, int length)
453 {
454 struct gmidi_device *dev = ep->driver_data;
455 /* cable is ignored, because for now we only have one. */
456
457 if (!dev->out_substream) {
458 /* Nobody is listening - throw it on the floor. */
459 return;
460 }
461 if (!test_bit(dev->out_substream->number, &dev->out_triggered)) {
462 return;
463 }
464 snd_rawmidi_receive(dev->out_substream, data, length);
465 }
466
467 static void gmidi_handle_out_data(struct usb_ep *ep, struct usb_request *req)
468 {
469 unsigned i;
470 u8 *buf = req->buf;
471
472 for (i = 0; i + 3 < req->actual; i += 4) {
473 if (buf[i] != 0) {
474 int cable = buf[i] >> 4;
475 int length = gmidi_cin_length[buf[i] & 0x0f];
476 gmidi_read_data(ep, cable, &buf[i + 1], length);
477 }
478 }
479 }
480
481 static void gmidi_complete(struct usb_ep *ep, struct usb_request *req)
482 {
483 struct gmidi_device *dev = ep->driver_data;
484 int status = req->status;
485
486 switch (status) {
487 case 0: /* normal completion */
488 if (ep == dev->out_ep) {
489 /* we received stuff.
490 req is queued again, below */
491 gmidi_handle_out_data(ep, req);
492 } else if (ep == dev->in_ep) {
493 /* our transmit completed.
494 see if there's more to go.
495 gmidi_transmit eats req, don't queue it again. */
496 gmidi_transmit(dev, req);
497 return;
498 }
499 break;
500
501 /* this endpoint is normally active while we're configured */
502 case -ECONNABORTED: /* hardware forced ep reset */
503 case -ECONNRESET: /* request dequeued */
504 case -ESHUTDOWN: /* disconnect from host */
505 VDBG(dev, "%s gone (%d), %d/%d\n", ep->name, status,
506 req->actual, req->length);
507 if (ep == dev->out_ep) {
508 gmidi_handle_out_data(ep, req);
509 }
510 free_ep_req(ep, req);
511 return;
512
513 case -EOVERFLOW: /* buffer overrun on read means that
514 * we didn't provide a big enough
515 * buffer.
516 */
517 default:
518 DBG(dev, "%s complete --> %d, %d/%d\n", ep->name,
519 status, req->actual, req->length);
520 break;
521 case -EREMOTEIO: /* short read */
522 break;
523 }
524
525 status = usb_ep_queue(ep, req, GFP_ATOMIC);
526 if (status) {
527 ERROR(dev, "kill %s: resubmit %d bytes --> %d\n",
528 ep->name, req->length, status);
529 usb_ep_set_halt(ep);
530 /* FIXME recover later ... somehow */
531 }
532 }
533
534 static int set_gmidi_config(struct gmidi_device *dev, gfp_t gfp_flags)
535 {
536 int err = 0;
537 struct usb_request *req;
538 struct usb_ep *ep;
539 unsigned i;
540
541 dev->in_ep->desc = &bulk_in_desc;
542 err = usb_ep_enable(dev->in_ep);
543 if (err) {
544 ERROR(dev, "can't start %s: %d\n", dev->in_ep->name, err);
545 goto fail;
546 }
547 dev->in_ep->driver_data = dev;
548
549 dev->out_ep->desc = &bulk_out_desc;
550 err = usb_ep_enable(dev->out_ep);
551 if (err) {
552 ERROR(dev, "can't start %s: %d\n", dev->out_ep->name, err);
553 goto fail;
554 }
555 dev->out_ep->driver_data = dev;
556
557 /* allocate a bunch of read buffers and queue them all at once. */
558 ep = dev->out_ep;
559 for (i = 0; i < qlen && err == 0; i++) {
560 req = alloc_ep_req(ep, buflen);
561 if (req) {
562 req->complete = gmidi_complete;
563 err = usb_ep_queue(ep, req, GFP_ATOMIC);
564 if (err) {
565 DBG(dev, "%s queue req: %d\n", ep->name, err);
566 }
567 } else {
568 err = -ENOMEM;
569 }
570 }
571 fail:
572 /* caller is responsible for cleanup on error */
573 return err;
574 }
575
576
577 static void gmidi_reset_config(struct gmidi_device *dev)
578 {
579 if (dev->config == 0) {
580 return;
581 }
582
583 DBG(dev, "reset config\n");
584
585 /* just disable endpoints, forcing completion of pending i/o.
586 * all our completion handlers free their requests in this case.
587 */
588 usb_ep_disable(dev->in_ep);
589 usb_ep_disable(dev->out_ep);
590 dev->config = 0;
591 }
592
593 /* change our operational config. this code must agree with the code
594 * that returns config descriptors, and altsetting code.
595 *
596 * it's also responsible for power management interactions. some
597 * configurations might not work with our current power sources.
598 *
599 * note that some device controller hardware will constrain what this
600 * code can do, perhaps by disallowing more than one configuration or
601 * by limiting configuration choices (like the pxa2xx).
602 */
603 static int
604 gmidi_set_config(struct gmidi_device *dev, unsigned number, gfp_t gfp_flags)
605 {
606 int result = 0;
607 struct usb_gadget *gadget = dev->gadget;
608
609 #if 0
610 /* FIXME */
611 /* Hacking this bit out fixes a bug where on receipt of two
612 USB_REQ_SET_CONFIGURATION messages, we end up with no
613 buffered OUT requests waiting for data. This is clearly
614 hiding a bug elsewhere, because if the config didn't
615 change then we really shouldn't do anything. */
616 /* Having said that, when we do "change" from config 1
617 to config 1, we at least gmidi_reset_config() which
618 clears out any requests on endpoints, so it's not like
619 we leak or anything. */
620 if (number == dev->config) {
621 return 0;
622 }
623 #endif
624
625 gmidi_reset_config(dev);
626
627 switch (number) {
628 case GMIDI_CONFIG:
629 result = set_gmidi_config(dev, gfp_flags);
630 break;
631 default:
632 result = -EINVAL;
633 /* FALL THROUGH */
634 case 0:
635 return result;
636 }
637
638 if (!result && (!dev->in_ep || !dev->out_ep)) {
639 result = -ENODEV;
640 }
641 if (result) {
642 gmidi_reset_config(dev);
643 } else {
644 char *speed;
645
646 switch (gadget->speed) {
647 case USB_SPEED_LOW: speed = "low"; break;
648 case USB_SPEED_FULL: speed = "full"; break;
649 case USB_SPEED_HIGH: speed = "high"; break;
650 default: speed = "?"; break;
651 }
652
653 dev->config = number;
654 INFO(dev, "%s speed\n", speed);
655 }
656 return result;
657 }
658
659
660 static void gmidi_setup_complete(struct usb_ep *ep, struct usb_request *req)
661 {
662 if (req->status || req->actual != req->length) {
663 DBG((struct gmidi_device *) ep->driver_data,
664 "setup complete --> %d, %d/%d\n",
665 req->status, req->actual, req->length);
666 }
667 }
668
669 /*
670 * The setup() callback implements all the ep0 functionality that's
671 * not handled lower down, in hardware or the hardware driver (like
672 * device and endpoint feature flags, and their status). It's all
673 * housekeeping for the gadget function we're implementing. Most of
674 * the work is in config-specific setup.
675 */
676 static int gmidi_setup(struct usb_gadget *gadget,
677 const struct usb_ctrlrequest *ctrl)
678 {
679 struct gmidi_device *dev = get_gadget_data(gadget);
680 struct usb_request *req = dev->req;
681 int value = -EOPNOTSUPP;
682 u16 w_index = le16_to_cpu(ctrl->wIndex);
683 u16 w_value = le16_to_cpu(ctrl->wValue);
684 u16 w_length = le16_to_cpu(ctrl->wLength);
685
686 /* usually this stores reply data in the pre-allocated ep0 buffer,
687 * but config change events will reconfigure hardware.
688 */
689 req->zero = 0;
690 switch (ctrl->bRequest) {
691
692 case USB_REQ_GET_DESCRIPTOR:
693 if (ctrl->bRequestType != USB_DIR_IN) {
694 goto unknown;
695 }
696 switch (w_value >> 8) {
697
698 case USB_DT_DEVICE:
699 device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket;
700 value = min(w_length, (u16) sizeof(device_desc));
701 memcpy(req->buf, &device_desc, value);
702 break;
703 case USB_DT_CONFIG:
704 value = config_buf(gadget, req->buf,
705 w_value >> 8,
706 w_value & 0xff);
707 if (value >= 0) {
708 value = min(w_length, (u16)value);
709 }
710 break;
711
712 case USB_DT_STRING:
713 /* wIndex == language code.
714 * this driver only handles one language, you can
715 * add string tables for other languages, using
716 * any UTF-8 characters
717 */
718 value = usb_gadget_get_string(&stringtab,
719 w_value & 0xff, req->buf);
720 if (value >= 0) {
721 value = min(w_length, (u16)value);
722 }
723 break;
724 }
725 break;
726
727 /* currently two configs, two speeds */
728 case USB_REQ_SET_CONFIGURATION:
729 if (ctrl->bRequestType != 0) {
730 goto unknown;
731 }
732 if (gadget->a_hnp_support) {
733 DBG(dev, "HNP available\n");
734 } else if (gadget->a_alt_hnp_support) {
735 DBG(dev, "HNP needs a different root port\n");
736 } else {
737 VDBG(dev, "HNP inactive\n");
738 }
739 spin_lock(&dev->lock);
740 value = gmidi_set_config(dev, w_value, GFP_ATOMIC);
741 spin_unlock(&dev->lock);
742 break;
743 case USB_REQ_GET_CONFIGURATION:
744 if (ctrl->bRequestType != USB_DIR_IN) {
745 goto unknown;
746 }
747 *(u8 *)req->buf = dev->config;
748 value = min(w_length, (u16)1);
749 break;
750
751 /* until we add altsetting support, or other interfaces,
752 * only 0/0 are possible. pxa2xx only supports 0/0 (poorly)
753 * and already killed pending endpoint I/O.
754 */
755 case USB_REQ_SET_INTERFACE:
756 if (ctrl->bRequestType != USB_RECIP_INTERFACE) {
757 goto unknown;
758 }
759 spin_lock(&dev->lock);
760 if (dev->config && w_index < GMIDI_NUM_INTERFACES
761 && w_value == 0)
762 {
763 u8 config = dev->config;
764
765 /* resets interface configuration, forgets about
766 * previous transaction state (queued bufs, etc)
767 * and re-inits endpoint state (toggle etc)
768 * no response queued, just zero status == success.
769 * if we had more than one interface we couldn't
770 * use this "reset the config" shortcut.
771 */
772 gmidi_reset_config(dev);
773 gmidi_set_config(dev, config, GFP_ATOMIC);
774 value = 0;
775 }
776 spin_unlock(&dev->lock);
777 break;
778 case USB_REQ_GET_INTERFACE:
779 if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE)) {
780 goto unknown;
781 }
782 if (!dev->config) {
783 break;
784 }
785 if (w_index >= GMIDI_NUM_INTERFACES) {
786 value = -EDOM;
787 break;
788 }
789 *(u8 *)req->buf = 0;
790 value = min(w_length, (u16)1);
791 break;
792
793 default:
794 unknown:
795 VDBG(dev, "unknown control req%02x.%02x v%04x i%04x l%d\n",
796 ctrl->bRequestType, ctrl->bRequest,
797 w_value, w_index, w_length);
798 }
799
800 /* respond with data transfer before status phase? */
801 if (value >= 0) {
802 req->length = value;
803 req->zero = value < w_length;
804 value = usb_ep_queue(gadget->ep0, req, GFP_ATOMIC);
805 if (value < 0) {
806 DBG(dev, "ep_queue --> %d\n", value);
807 req->status = 0;
808 gmidi_setup_complete(gadget->ep0, req);
809 }
810 }
811
812 /* device either stalls (value < 0) or reports success */
813 return value;
814 }
815
816 static void gmidi_disconnect(struct usb_gadget *gadget)
817 {
818 struct gmidi_device *dev = get_gadget_data(gadget);
819 unsigned long flags;
820
821 spin_lock_irqsave(&dev->lock, flags);
822 gmidi_reset_config(dev);
823
824 /* a more significant application might have some non-usb
825 * activities to quiesce here, saving resources like power
826 * or pushing the notification up a network stack.
827 */
828 spin_unlock_irqrestore(&dev->lock, flags);
829
830 /* next we may get setup() calls to enumerate new connections;
831 * or an unbind() during shutdown (including removing module).
832 */
833 }
834
835 static void /* __init_or_exit */ gmidi_unbind(struct usb_gadget *gadget)
836 {
837 struct gmidi_device *dev = get_gadget_data(gadget);
838 struct snd_card *card;
839
840 DBG(dev, "unbind\n");
841
842 card = dev->card;
843 dev->card = NULL;
844 if (card) {
845 snd_card_free(card);
846 }
847
848 /* we've already been disconnected ... no i/o is active */
849 if (dev->req) {
850 dev->req->length = USB_BUFSIZ;
851 free_ep_req(gadget->ep0, dev->req);
852 }
853 kfree(dev);
854 set_gadget_data(gadget, NULL);
855 }
856
857 static int gmidi_snd_free(struct snd_device *device)
858 {
859 return 0;
860 }
861
862 static void gmidi_transmit_packet(struct usb_request *req, uint8_t p0,
863 uint8_t p1, uint8_t p2, uint8_t p3)
864 {
865 unsigned length = req->length;
866 u8 *buf = (u8 *)req->buf + length;
867
868 buf[0] = p0;
869 buf[1] = p1;
870 buf[2] = p2;
871 buf[3] = p3;
872 req->length = length + 4;
873 }
874
875 /*
876 * Converts MIDI commands to USB MIDI packets.
877 */
878 static void gmidi_transmit_byte(struct usb_request *req,
879 struct gmidi_in_port *port, uint8_t b)
880 {
881 uint8_t p0 = port->cable;
882
883 if (b >= 0xf8) {
884 gmidi_transmit_packet(req, p0 | 0x0f, b, 0, 0);
885 } else if (b >= 0xf0) {
886 switch (b) {
887 case 0xf0:
888 port->data[0] = b;
889 port->state = STATE_SYSEX_1;
890 break;
891 case 0xf1:
892 case 0xf3:
893 port->data[0] = b;
894 port->state = STATE_1PARAM;
895 break;
896 case 0xf2:
897 port->data[0] = b;
898 port->state = STATE_2PARAM_1;
899 break;
900 case 0xf4:
901 case 0xf5:
902 port->state = STATE_UNKNOWN;
903 break;
904 case 0xf6:
905 gmidi_transmit_packet(req, p0 | 0x05, 0xf6, 0, 0);
906 port->state = STATE_UNKNOWN;
907 break;
908 case 0xf7:
909 switch (port->state) {
910 case STATE_SYSEX_0:
911 gmidi_transmit_packet(req,
912 p0 | 0x05, 0xf7, 0, 0);
913 break;
914 case STATE_SYSEX_1:
915 gmidi_transmit_packet(req,
916 p0 | 0x06, port->data[0], 0xf7, 0);
917 break;
918 case STATE_SYSEX_2:
919 gmidi_transmit_packet(req,
920 p0 | 0x07, port->data[0],
921 port->data[1], 0xf7);
922 break;
923 }
924 port->state = STATE_UNKNOWN;
925 break;
926 }
927 } else if (b >= 0x80) {
928 port->data[0] = b;
929 if (b >= 0xc0 && b <= 0xdf)
930 port->state = STATE_1PARAM;
931 else
932 port->state = STATE_2PARAM_1;
933 } else { /* b < 0x80 */
934 switch (port->state) {
935 case STATE_1PARAM:
936 if (port->data[0] < 0xf0) {
937 p0 |= port->data[0] >> 4;
938 } else {
939 p0 |= 0x02;
940 port->state = STATE_UNKNOWN;
941 }
942 gmidi_transmit_packet(req, p0, port->data[0], b, 0);
943 break;
944 case STATE_2PARAM_1:
945 port->data[1] = b;
946 port->state = STATE_2PARAM_2;
947 break;
948 case STATE_2PARAM_2:
949 if (port->data[0] < 0xf0) {
950 p0 |= port->data[0] >> 4;
951 port->state = STATE_2PARAM_1;
952 } else {
953 p0 |= 0x03;
954 port->state = STATE_UNKNOWN;
955 }
956 gmidi_transmit_packet(req,
957 p0, port->data[0], port->data[1], b);
958 break;
959 case STATE_SYSEX_0:
960 port->data[0] = b;
961 port->state = STATE_SYSEX_1;
962 break;
963 case STATE_SYSEX_1:
964 port->data[1] = b;
965 port->state = STATE_SYSEX_2;
966 break;
967 case STATE_SYSEX_2:
968 gmidi_transmit_packet(req,
969 p0 | 0x04, port->data[0], port->data[1], b);
970 port->state = STATE_SYSEX_0;
971 break;
972 }
973 }
974 }
975
976 static void gmidi_transmit(struct gmidi_device *dev, struct usb_request *req)
977 {
978 struct usb_ep *ep = dev->in_ep;
979 struct gmidi_in_port *port = &dev->in_port;
980
981 if (!ep) {
982 return;
983 }
984 if (!req) {
985 req = alloc_ep_req(ep, buflen);
986 }
987 if (!req) {
988 ERROR(dev, "gmidi_transmit: alloc_ep_request failed\n");
989 return;
990 }
991 req->length = 0;
992 req->complete = gmidi_complete;
993
994 if (port->active) {
995 while (req->length + 3 < buflen) {
996 uint8_t b;
997 if (snd_rawmidi_transmit(dev->in_substream, &b, 1)
998 != 1)
999 {
1000 port->active = 0;
1001 break;
1002 }
1003 gmidi_transmit_byte(req, port, b);
1004 }
1005 }
1006 if (req->length > 0) {
1007 usb_ep_queue(ep, req, GFP_ATOMIC);
1008 } else {
1009 free_ep_req(ep, req);
1010 }
1011 }
1012
1013 static void gmidi_in_tasklet(unsigned long data)
1014 {
1015 struct gmidi_device *dev = (struct gmidi_device *)data;
1016
1017 gmidi_transmit(dev, NULL);
1018 }
1019
1020 static int gmidi_in_open(struct snd_rawmidi_substream *substream)
1021 {
1022 struct gmidi_device *dev = substream->rmidi->private_data;
1023
1024 VDBG(dev, "gmidi_in_open\n");
1025 dev->in_substream = substream;
1026 dev->in_port.state = STATE_UNKNOWN;
1027 return 0;
1028 }
1029
1030 static int gmidi_in_close(struct snd_rawmidi_substream *substream)
1031 {
1032 struct gmidi_device *dev = substream->rmidi->private_data;
1033
1034 VDBG(dev, "gmidi_in_close\n");
1035 return 0;
1036 }
1037
1038 static void gmidi_in_trigger(struct snd_rawmidi_substream *substream, int up)
1039 {
1040 struct gmidi_device *dev = substream->rmidi->private_data;
1041
1042 VDBG(dev, "gmidi_in_trigger %d\n", up);
1043 dev->in_port.active = up;
1044 if (up) {
1045 tasklet_hi_schedule(&dev->tasklet);
1046 }
1047 }
1048
1049 static int gmidi_out_open(struct snd_rawmidi_substream *substream)
1050 {
1051 struct gmidi_device *dev = substream->rmidi->private_data;
1052
1053 VDBG(dev, "gmidi_out_open\n");
1054 dev->out_substream = substream;
1055 return 0;
1056 }
1057
1058 static int gmidi_out_close(struct snd_rawmidi_substream *substream)
1059 {
1060 struct gmidi_device *dev = substream->rmidi->private_data;
1061
1062 VDBG(dev, "gmidi_out_close\n");
1063 return 0;
1064 }
1065
1066 static void gmidi_out_trigger(struct snd_rawmidi_substream *substream, int up)
1067 {
1068 struct gmidi_device *dev = substream->rmidi->private_data;
1069
1070 VDBG(dev, "gmidi_out_trigger %d\n", up);
1071 if (up) {
1072 set_bit(substream->number, &dev->out_triggered);
1073 } else {
1074 clear_bit(substream->number, &dev->out_triggered);
1075 }
1076 }
1077
1078 static struct snd_rawmidi_ops gmidi_in_ops = {
1079 .open = gmidi_in_open,
1080 .close = gmidi_in_close,
1081 .trigger = gmidi_in_trigger,
1082 };
1083
1084 static struct snd_rawmidi_ops gmidi_out_ops = {
1085 .open = gmidi_out_open,
1086 .close = gmidi_out_close,
1087 .trigger = gmidi_out_trigger
1088 };
1089
1090 /* register as a sound "card" */
1091 static int gmidi_register_card(struct gmidi_device *dev)
1092 {
1093 struct snd_card *card;
1094 struct snd_rawmidi *rmidi;
1095 int err;
1096 int out_ports = 1;
1097 int in_ports = 1;
1098 static struct snd_device_ops ops = {
1099 .dev_free = gmidi_snd_free,
1100 };
1101
1102 err = snd_card_create(index, id, THIS_MODULE, 0, &card);
1103 if (err < 0) {
1104 ERROR(dev, "snd_card_create failed\n");
1105 goto fail;
1106 }
1107 dev->card = card;
1108
1109 err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, dev, &ops);
1110 if (err < 0) {
1111 ERROR(dev, "snd_device_new failed: error %d\n", err);
1112 goto fail;
1113 }
1114
1115 strcpy(card->driver, longname);
1116 strcpy(card->longname, longname);
1117 strcpy(card->shortname, shortname);
1118
1119 /* Set up rawmidi */
1120 dev->in_port.dev = dev;
1121 dev->in_port.active = 0;
1122 snd_component_add(card, "MIDI");
1123 err = snd_rawmidi_new(card, "USB MIDI Gadget", 0,
1124 out_ports, in_ports, &rmidi);
1125 if (err < 0) {
1126 ERROR(dev, "snd_rawmidi_new failed: error %d\n", err);
1127 goto fail;
1128 }
1129 dev->rmidi = rmidi;
1130 strcpy(rmidi->name, card->shortname);
1131 rmidi->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT |
1132 SNDRV_RAWMIDI_INFO_INPUT |
1133 SNDRV_RAWMIDI_INFO_DUPLEX;
1134 rmidi->private_data = dev;
1135
1136 /* Yes, rawmidi OUTPUT = USB IN, and rawmidi INPUT = USB OUT.
1137 It's an upside-down world being a gadget. */
1138 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &gmidi_in_ops);
1139 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &gmidi_out_ops);
1140
1141 snd_card_set_dev(card, &dev->gadget->dev);
1142
1143 /* register it - we're ready to go */
1144 err = snd_card_register(card);
1145 if (err < 0) {
1146 ERROR(dev, "snd_card_register failed\n");
1147 goto fail;
1148 }
1149
1150 VDBG(dev, "gmidi_register_card finished ok\n");
1151 return 0;
1152
1153 fail:
1154 if (dev->card) {
1155 snd_card_free(dev->card);
1156 dev->card = NULL;
1157 }
1158 return err;
1159 }
1160
1161 /*
1162 * Creates an output endpoint, and initializes output ports.
1163 */
1164 static int __init gmidi_bind(struct usb_gadget *gadget)
1165 {
1166 struct gmidi_device *dev;
1167 struct usb_ep *in_ep, *out_ep;
1168 int gcnum, err = 0;
1169
1170 /* support optional vendor/distro customization */
1171 if (idVendor) {
1172 if (!idProduct) {
1173 pr_err("idVendor needs idProduct!\n");
1174 return -ENODEV;
1175 }
1176 device_desc.idVendor = cpu_to_le16(idVendor);
1177 device_desc.idProduct = cpu_to_le16(idProduct);
1178 if (bcdDevice) {
1179 device_desc.bcdDevice = cpu_to_le16(bcdDevice);
1180 }
1181 }
1182 if (iManufacturer) {
1183 strlcpy(manufacturer, iManufacturer, sizeof(manufacturer));
1184 } else {
1185 snprintf(manufacturer, sizeof(manufacturer), "%s %s with %s",
1186 init_utsname()->sysname, init_utsname()->release,
1187 gadget->name);
1188 }
1189 if (iProduct) {
1190 strlcpy(product_desc, iProduct, sizeof(product_desc));
1191 }
1192 if (iSerialNumber) {
1193 device_desc.iSerialNumber = STRING_SERIAL,
1194 strlcpy(serial_number, iSerialNumber, sizeof(serial_number));
1195 }
1196
1197 /* Bulk-only drivers like this one SHOULD be able to
1198 * autoconfigure on any sane usb controller driver,
1199 * but there may also be important quirks to address.
1200 */
1201 usb_ep_autoconfig_reset(gadget);
1202 in_ep = usb_ep_autoconfig(gadget, &bulk_in_desc);
1203 if (!in_ep) {
1204 autoconf_fail:
1205 pr_err("%s: can't autoconfigure on %s\n",
1206 shortname, gadget->name);
1207 return -ENODEV;
1208 }
1209 EP_IN_NAME = in_ep->name;
1210 in_ep->driver_data = in_ep; /* claim */
1211
1212 out_ep = usb_ep_autoconfig(gadget, &bulk_out_desc);
1213 if (!out_ep) {
1214 goto autoconf_fail;
1215 }
1216 EP_OUT_NAME = out_ep->name;
1217 out_ep->driver_data = out_ep; /* claim */
1218
1219 gcnum = usb_gadget_controller_number(gadget);
1220 if (gcnum >= 0) {
1221 device_desc.bcdDevice = cpu_to_le16(0x0200 + gcnum);
1222 } else {
1223 /* gmidi is so simple (no altsettings) that
1224 * it SHOULD NOT have problems with bulk-capable hardware.
1225 * so warn about unrecognized controllers, don't panic.
1226 */
1227 pr_warning("%s: controller '%s' not recognized\n",
1228 shortname, gadget->name);
1229 device_desc.bcdDevice = cpu_to_le16(0x9999);
1230 }
1231
1232
1233 /* ok, we made sense of the hardware ... */
1234 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1235 if (!dev) {
1236 return -ENOMEM;
1237 }
1238 spin_lock_init(&dev->lock);
1239 dev->gadget = gadget;
1240 dev->in_ep = in_ep;
1241 dev->out_ep = out_ep;
1242 set_gadget_data(gadget, dev);
1243 tasklet_init(&dev->tasklet, gmidi_in_tasklet, (unsigned long)dev);
1244
1245 /* preallocate control response and buffer */
1246 dev->req = alloc_ep_req(gadget->ep0, USB_BUFSIZ);
1247 if (!dev->req) {
1248 err = -ENOMEM;
1249 goto fail;
1250 }
1251
1252 dev->req->complete = gmidi_setup_complete;
1253
1254 gadget->ep0->driver_data = dev;
1255
1256 INFO(dev, "%s, version: " DRIVER_VERSION "\n", longname);
1257 INFO(dev, "using %s, OUT %s IN %s\n", gadget->name,
1258 EP_OUT_NAME, EP_IN_NAME);
1259
1260 /* register as an ALSA sound card */
1261 err = gmidi_register_card(dev);
1262 if (err < 0) {
1263 goto fail;
1264 }
1265
1266 VDBG(dev, "gmidi_bind finished ok\n");
1267 return 0;
1268
1269 fail:
1270 gmidi_unbind(gadget);
1271 return err;
1272 }
1273
1274
1275 static void gmidi_suspend(struct usb_gadget *gadget)
1276 {
1277 struct gmidi_device *dev = get_gadget_data(gadget);
1278
1279 if (gadget->speed == USB_SPEED_UNKNOWN) {
1280 return;
1281 }
1282
1283 DBG(dev, "suspend\n");
1284 }
1285
1286 static void gmidi_resume(struct usb_gadget *gadget)
1287 {
1288 struct gmidi_device *dev = get_gadget_data(gadget);
1289
1290 DBG(dev, "resume\n");
1291 }
1292
1293
1294 static struct usb_gadget_driver gmidi_driver = {
1295 .speed = USB_SPEED_FULL,
1296 .function = (char *)longname,
1297 .unbind = gmidi_unbind,
1298
1299 .setup = gmidi_setup,
1300 .disconnect = gmidi_disconnect,
1301
1302 .suspend = gmidi_suspend,
1303 .resume = gmidi_resume,
1304
1305 .driver = {
1306 .name = (char *)shortname,
1307 .owner = THIS_MODULE,
1308 },
1309 };
1310
1311 static int __init gmidi_init(void)
1312 {
1313 return usb_gadget_probe_driver(&gmidi_driver, gmidi_bind);
1314 }
1315 module_init(gmidi_init);
1316
1317 static void __exit gmidi_cleanup(void)
1318 {
1319 usb_gadget_unregister_driver(&gmidi_driver);
1320 }
1321 module_exit(gmidi_cleanup);
1322
linux-next