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