2 * f_midi.c -- USB MIDI class function driver
4 * Copyright (C) 2006 Thumtronics Pty Ltd.
5 * Developed for Thumtronics by Grey Innovation
6 * Ben Williamson <ben.williamson@greyinnovation.com>
8 * Rewritten for the composite framework
9 * Copyright (C) 2011 Daniel Mack <zonque@gmail.com>
11 * Based on drivers/usb/gadget/f_audio.c,
12 * Copyright (C) 2008 Bryan Wu <cooloney@kernel.org>
13 * Copyright (C) 2008 Analog Devices, Inc
15 * and drivers/usb/gadget/midi.c,
16 * Copyright (C) 2006 Thumtronics Pty Ltd.
17 * Ben Williamson <ben.williamson@greyinnovation.com>
19 * Licensed under the GPL-2 or later.
22 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/slab.h>
25 #include <linux/device.h>
27 #include <sound/core.h>
28 #include <sound/initval.h>
29 #include <sound/rawmidi.h>
31 #include <linux/usb/ch9.h>
32 #include <linux/usb/gadget.h>
33 #include <linux/usb/audio.h>
34 #include <linux/usb/midi.h>
39 MODULE_AUTHOR("Ben Williamson");
40 MODULE_LICENSE("GPL v2");
42 static const char f_midi_shortname[] = "f_midi";
43 static const char f_midi_longname[] = "MIDI Gadget";
46 * We can only handle 16 cables on one single endpoint, as cable numbers are
47 * stored in 4-bit fields. And as the interface currently only holds one
48 * single endpoint, this is the maximum number of ports we can allow.
53 * This is a gadget, and the IN/OUT naming is from the host's perspective.
54 * USB -> OUT endpoint -> rawmidi
55 * USB <- IN endpoint <- rawmidi
57 struct gmidi_in_port {
62 #define STATE_UNKNOWN 0
63 #define STATE_1PARAM 1
64 #define STATE_2PARAM_1 2
65 #define STATE_2PARAM_2 3
66 #define STATE_SYSEX_0 4
67 #define STATE_SYSEX_1 5
68 #define STATE_SYSEX_2 6
73 struct usb_function func;
74 struct usb_gadget *gadget;
75 struct usb_ep *in_ep, *out_ep;
76 struct snd_card *card;
77 struct snd_rawmidi *rmidi;
79 struct snd_rawmidi_substream *in_substream[MAX_PORTS];
80 struct snd_rawmidi_substream *out_substream[MAX_PORTS];
81 struct gmidi_in_port *in_port[MAX_PORTS];
83 unsigned long out_triggered;
84 struct tasklet_struct tasklet;
85 unsigned int in_ports;
86 unsigned int out_ports;
89 unsigned int buflen, qlen;
92 static inline struct f_midi *func_to_midi(struct usb_function *f)
94 return container_of(f, struct f_midi, func);
97 static void f_midi_transmit(struct f_midi *midi, struct usb_request *req);
99 DECLARE_UAC_AC_HEADER_DESCRIPTOR(1);
100 DECLARE_USB_MIDI_OUT_JACK_DESCRIPTOR(1);
101 DECLARE_USB_MS_ENDPOINT_DESCRIPTOR(16);
103 /* B.3.1 Standard AC Interface Descriptor */
104 static struct usb_interface_descriptor ac_interface_desc = {
105 .bLength = USB_DT_INTERFACE_SIZE,
106 .bDescriptorType = USB_DT_INTERFACE,
107 /* .bInterfaceNumber = DYNAMIC */
108 /* .bNumEndpoints = DYNAMIC */
109 .bInterfaceClass = USB_CLASS_AUDIO,
110 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL,
111 /* .iInterface = DYNAMIC */
114 /* B.3.2 Class-Specific AC Interface Descriptor */
115 static struct uac1_ac_header_descriptor_1 ac_header_desc = {
116 .bLength = UAC_DT_AC_HEADER_SIZE(1),
117 .bDescriptorType = USB_DT_CS_INTERFACE,
118 .bDescriptorSubtype = USB_MS_HEADER,
119 .bcdADC = cpu_to_le16(0x0100),
120 .wTotalLength = cpu_to_le16(UAC_DT_AC_HEADER_SIZE(1)),
122 /* .baInterfaceNr = DYNAMIC */
125 /* B.4.1 Standard MS Interface Descriptor */
126 static struct usb_interface_descriptor ms_interface_desc = {
127 .bLength = USB_DT_INTERFACE_SIZE,
128 .bDescriptorType = USB_DT_INTERFACE,
129 /* .bInterfaceNumber = DYNAMIC */
131 .bInterfaceClass = USB_CLASS_AUDIO,
132 .bInterfaceSubClass = USB_SUBCLASS_MIDISTREAMING,
133 /* .iInterface = DYNAMIC */
136 /* B.4.2 Class-Specific MS Interface Descriptor */
137 static struct usb_ms_header_descriptor ms_header_desc = {
138 .bLength = USB_DT_MS_HEADER_SIZE,
139 .bDescriptorType = USB_DT_CS_INTERFACE,
140 .bDescriptorSubtype = USB_MS_HEADER,
141 .bcdMSC = cpu_to_le16(0x0100),
142 /* .wTotalLength = DYNAMIC */
145 /* B.5.1 Standard Bulk OUT Endpoint Descriptor */
146 static struct usb_endpoint_descriptor bulk_out_desc = {
147 .bLength = USB_DT_ENDPOINT_AUDIO_SIZE,
148 .bDescriptorType = USB_DT_ENDPOINT,
149 .bEndpointAddress = USB_DIR_OUT,
150 .bmAttributes = USB_ENDPOINT_XFER_BULK,
153 /* B.5.2 Class-specific MS Bulk OUT Endpoint Descriptor */
154 static struct usb_ms_endpoint_descriptor_16 ms_out_desc = {
155 /* .bLength = DYNAMIC */
156 .bDescriptorType = USB_DT_CS_ENDPOINT,
157 .bDescriptorSubtype = USB_MS_GENERAL,
158 /* .bNumEmbMIDIJack = DYNAMIC */
159 /* .baAssocJackID = DYNAMIC */
162 /* B.6.1 Standard Bulk IN Endpoint Descriptor */
163 static struct usb_endpoint_descriptor bulk_in_desc = {
164 .bLength = USB_DT_ENDPOINT_AUDIO_SIZE,
165 .bDescriptorType = USB_DT_ENDPOINT,
166 .bEndpointAddress = USB_DIR_IN,
167 .bmAttributes = USB_ENDPOINT_XFER_BULK,
170 /* B.6.2 Class-specific MS Bulk IN Endpoint Descriptor */
171 static struct usb_ms_endpoint_descriptor_16 ms_in_desc = {
172 /* .bLength = DYNAMIC */
173 .bDescriptorType = USB_DT_CS_ENDPOINT,
174 .bDescriptorSubtype = USB_MS_GENERAL,
175 /* .bNumEmbMIDIJack = DYNAMIC */
176 /* .baAssocJackID = DYNAMIC */
179 /* string IDs are assigned dynamically */
181 #define STRING_FUNC_IDX 0
183 static struct usb_string midi_string_defs[] = {
184 [STRING_FUNC_IDX].s = "MIDI function",
185 { } /* end of list */
188 static struct usb_gadget_strings midi_stringtab = {
189 .language = 0x0409, /* en-us */
190 .strings = midi_string_defs,
193 static struct usb_gadget_strings *midi_strings[] = {
198 static inline struct usb_request *midi_alloc_ep_req(struct usb_ep *ep,
201 return alloc_ep_req(ep, length, length);
204 static const uint8_t f_midi_cin_length[] = {
205 0, 0, 2, 3, 3, 1, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1
209 * Receives a chunk of MIDI data.
211 static void f_midi_read_data(struct usb_ep *ep, int cable,
212 uint8_t *data, int length)
214 struct f_midi *midi = ep->driver_data;
215 struct snd_rawmidi_substream *substream = midi->out_substream[cable];
218 /* Nobody is listening - throw it on the floor. */
221 if (!test_bit(cable, &midi->out_triggered))
224 snd_rawmidi_receive(substream, data, length);
227 static void f_midi_handle_out_data(struct usb_ep *ep, struct usb_request *req)
232 for (i = 0; i + 3 < req->actual; i += 4)
234 int cable = buf[i] >> 4;
235 int length = f_midi_cin_length[buf[i] & 0x0f];
236 f_midi_read_data(ep, cable, &buf[i + 1], length);
241 f_midi_complete(struct usb_ep *ep, struct usb_request *req)
243 struct f_midi *midi = ep->driver_data;
244 struct usb_composite_dev *cdev = midi->func.config->cdev;
245 int status = req->status;
248 case 0: /* normal completion */
249 if (ep == midi->out_ep) {
250 /* We received stuff. req is queued again, below */
251 f_midi_handle_out_data(ep, req);
252 } else if (ep == midi->in_ep) {
253 /* Our transmit completed. See if there's more to go.
254 * f_midi_transmit eats req, don't queue it again. */
255 f_midi_transmit(midi, req);
260 /* this endpoint is normally active while we're configured */
261 case -ECONNABORTED: /* hardware forced ep reset */
262 case -ECONNRESET: /* request dequeued */
263 case -ESHUTDOWN: /* disconnect from host */
264 VDBG(cdev, "%s gone (%d), %d/%d\n", ep->name, status,
265 req->actual, req->length);
266 if (ep == midi->out_ep)
267 f_midi_handle_out_data(ep, req);
269 free_ep_req(ep, req);
272 case -EOVERFLOW: /* buffer overrun on read means that
273 * we didn't provide a big enough buffer.
276 DBG(cdev, "%s complete --> %d, %d/%d\n", ep->name,
277 status, req->actual, req->length);
279 case -EREMOTEIO: /* short read */
283 status = usb_ep_queue(ep, req, GFP_ATOMIC);
285 ERROR(cdev, "kill %s: resubmit %d bytes --> %d\n",
286 ep->name, req->length, status);
288 /* FIXME recover later ... somehow */
292 static int f_midi_start_ep(struct f_midi *midi,
293 struct usb_function *f,
297 struct usb_composite_dev *cdev = f->config->cdev;
301 err = config_ep_by_speed(midi->gadget, f, ep);
303 ERROR(cdev, "can't configure %s: %d\n", ep->name, err);
307 err = usb_ep_enable(ep);
309 ERROR(cdev, "can't start %s: %d\n", ep->name, err);
313 ep->driver_data = midi;
318 static int f_midi_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
320 struct f_midi *midi = func_to_midi(f);
321 struct usb_composite_dev *cdev = f->config->cdev;
325 /* For Control Device interface we do nothing */
329 err = f_midi_start_ep(midi, f, midi->in_ep);
333 err = f_midi_start_ep(midi, f, midi->out_ep);
337 usb_ep_disable(midi->out_ep);
339 err = config_ep_by_speed(midi->gadget, f, midi->out_ep);
341 ERROR(cdev, "can't configure %s: %d\n",
342 midi->out_ep->name, err);
346 err = usb_ep_enable(midi->out_ep);
348 ERROR(cdev, "can't start %s: %d\n",
349 midi->out_ep->name, err);
353 midi->out_ep->driver_data = midi;
355 /* allocate a bunch of read buffers and queue them all at once. */
356 for (i = 0; i < midi->qlen && err == 0; i++) {
357 struct usb_request *req =
358 midi_alloc_ep_req(midi->out_ep,
359 max_t(unsigned, midi->buflen,
360 bulk_out_desc.wMaxPacketSize));
364 req->complete = f_midi_complete;
365 err = usb_ep_queue(midi->out_ep, req, GFP_ATOMIC);
367 ERROR(midi, "%s: couldn't enqueue request: %d\n",
368 midi->out_ep->name, err);
369 if (req->buf != NULL)
370 free_ep_req(midi->out_ep, req);
378 static void f_midi_disable(struct usb_function *f)
380 struct f_midi *midi = func_to_midi(f);
381 struct usb_composite_dev *cdev = f->config->cdev;
383 DBG(cdev, "disable\n");
386 * just disable endpoints, forcing completion of pending i/o.
387 * all our completion handlers free their requests in this case.
389 usb_ep_disable(midi->in_ep);
390 usb_ep_disable(midi->out_ep);
393 static int f_midi_snd_free(struct snd_device *device)
398 static void f_midi_transmit_packet(struct usb_request *req, uint8_t p0,
399 uint8_t p1, uint8_t p2, uint8_t p3)
401 unsigned length = req->length;
402 u8 *buf = (u8 *)req->buf + length;
408 req->length = length + 4;
412 * Converts MIDI commands to USB MIDI packets.
414 static void f_midi_transmit_byte(struct usb_request *req,
415 struct gmidi_in_port *port, uint8_t b)
417 uint8_t p0 = port->cable << 4;
420 f_midi_transmit_packet(req, p0 | 0x0f, b, 0, 0);
421 } else if (b >= 0xf0) {
425 port->state = STATE_SYSEX_1;
430 port->state = STATE_1PARAM;
434 port->state = STATE_2PARAM_1;
438 port->state = STATE_UNKNOWN;
441 f_midi_transmit_packet(req, p0 | 0x05, 0xf6, 0, 0);
442 port->state = STATE_UNKNOWN;
445 switch (port->state) {
447 f_midi_transmit_packet(req,
448 p0 | 0x05, 0xf7, 0, 0);
451 f_midi_transmit_packet(req,
452 p0 | 0x06, port->data[0], 0xf7, 0);
455 f_midi_transmit_packet(req,
456 p0 | 0x07, port->data[0],
457 port->data[1], 0xf7);
460 port->state = STATE_UNKNOWN;
463 } else if (b >= 0x80) {
465 if (b >= 0xc0 && b <= 0xdf)
466 port->state = STATE_1PARAM;
468 port->state = STATE_2PARAM_1;
469 } else { /* b < 0x80 */
470 switch (port->state) {
472 if (port->data[0] < 0xf0) {
473 p0 |= port->data[0] >> 4;
476 port->state = STATE_UNKNOWN;
478 f_midi_transmit_packet(req, p0, port->data[0], b, 0);
482 port->state = STATE_2PARAM_2;
485 if (port->data[0] < 0xf0) {
486 p0 |= port->data[0] >> 4;
487 port->state = STATE_2PARAM_1;
490 port->state = STATE_UNKNOWN;
492 f_midi_transmit_packet(req,
493 p0, port->data[0], port->data[1], b);
497 port->state = STATE_SYSEX_1;
501 port->state = STATE_SYSEX_2;
504 f_midi_transmit_packet(req,
505 p0 | 0x04, port->data[0], port->data[1], b);
506 port->state = STATE_SYSEX_0;
512 static void f_midi_transmit(struct f_midi *midi, struct usb_request *req)
514 struct usb_ep *ep = midi->in_ep;
521 req = midi_alloc_ep_req(ep, midi->buflen);
524 ERROR(midi, "%s: alloc_ep_request failed\n", __func__);
528 req->complete = f_midi_complete;
530 for (i = 0; i < MAX_PORTS; i++) {
531 struct gmidi_in_port *port = midi->in_port[i];
532 struct snd_rawmidi_substream *substream = midi->in_substream[i];
534 if (!port || !port->active || !substream)
537 while (req->length + 3 < midi->buflen) {
539 if (snd_rawmidi_transmit(substream, &b, 1) != 1) {
543 f_midi_transmit_byte(req, port, b);
547 if (req->length > 0 && ep->enabled) {
550 err = usb_ep_queue(ep, req, GFP_ATOMIC);
552 ERROR(midi, "%s queue req: %d\n",
553 midi->in_ep->name, err);
555 free_ep_req(ep, req);
559 static void f_midi_in_tasklet(unsigned long data)
561 struct f_midi *midi = (struct f_midi *) data;
562 f_midi_transmit(midi, NULL);
565 static int f_midi_in_open(struct snd_rawmidi_substream *substream)
567 struct f_midi *midi = substream->rmidi->private_data;
569 if (!midi->in_port[substream->number])
572 VDBG(midi, "%s()\n", __func__);
573 midi->in_substream[substream->number] = substream;
574 midi->in_port[substream->number]->state = STATE_UNKNOWN;
578 static int f_midi_in_close(struct snd_rawmidi_substream *substream)
580 struct f_midi *midi = substream->rmidi->private_data;
582 VDBG(midi, "%s()\n", __func__);
586 static void f_midi_in_trigger(struct snd_rawmidi_substream *substream, int up)
588 struct f_midi *midi = substream->rmidi->private_data;
590 if (!midi->in_port[substream->number])
593 VDBG(midi, "%s() %d\n", __func__, up);
594 midi->in_port[substream->number]->active = up;
596 tasklet_hi_schedule(&midi->tasklet);
599 static int f_midi_out_open(struct snd_rawmidi_substream *substream)
601 struct f_midi *midi = substream->rmidi->private_data;
603 if (substream->number >= MAX_PORTS)
606 VDBG(midi, "%s()\n", __func__);
607 midi->out_substream[substream->number] = substream;
611 static int f_midi_out_close(struct snd_rawmidi_substream *substream)
613 struct f_midi *midi = substream->rmidi->private_data;
615 VDBG(midi, "%s()\n", __func__);
619 static void f_midi_out_trigger(struct snd_rawmidi_substream *substream, int up)
621 struct f_midi *midi = substream->rmidi->private_data;
623 VDBG(midi, "%s()\n", __func__);
626 set_bit(substream->number, &midi->out_triggered);
628 clear_bit(substream->number, &midi->out_triggered);
631 static struct snd_rawmidi_ops gmidi_in_ops = {
632 .open = f_midi_in_open,
633 .close = f_midi_in_close,
634 .trigger = f_midi_in_trigger,
637 static struct snd_rawmidi_ops gmidi_out_ops = {
638 .open = f_midi_out_open,
639 .close = f_midi_out_close,
640 .trigger = f_midi_out_trigger
643 static inline void f_midi_unregister_card(struct f_midi *midi)
646 snd_card_free(midi->card);
651 /* register as a sound "card" */
652 static int f_midi_register_card(struct f_midi *midi)
654 struct snd_card *card;
655 struct snd_rawmidi *rmidi;
657 static struct snd_device_ops ops = {
658 .dev_free = f_midi_snd_free,
661 err = snd_card_new(&midi->gadget->dev, midi->index, midi->id,
662 THIS_MODULE, 0, &card);
664 ERROR(midi, "snd_card_new() failed\n");
669 err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, midi, &ops);
671 ERROR(midi, "snd_device_new() failed: error %d\n", err);
675 strcpy(card->driver, f_midi_longname);
676 strcpy(card->longname, f_midi_longname);
677 strcpy(card->shortname, f_midi_shortname);
680 snd_component_add(card, "MIDI");
681 err = snd_rawmidi_new(card, card->longname, 0,
682 midi->out_ports, midi->in_ports, &rmidi);
684 ERROR(midi, "snd_rawmidi_new() failed: error %d\n", err);
688 strcpy(rmidi->name, card->shortname);
689 rmidi->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT |
690 SNDRV_RAWMIDI_INFO_INPUT |
691 SNDRV_RAWMIDI_INFO_DUPLEX;
692 rmidi->private_data = midi;
695 * Yes, rawmidi OUTPUT = USB IN, and rawmidi INPUT = USB OUT.
696 * It's an upside-down world being a gadget.
698 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &gmidi_in_ops);
699 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &gmidi_out_ops);
701 /* register it - we're ready to go */
702 err = snd_card_register(card);
704 ERROR(midi, "snd_card_register() failed\n");
708 VDBG(midi, "%s() finished ok\n", __func__);
712 f_midi_unregister_card(midi);
716 /* MIDI function driver setup/binding */
718 static int f_midi_bind(struct usb_configuration *c, struct usb_function *f)
720 struct usb_descriptor_header **midi_function;
721 struct usb_midi_in_jack_descriptor jack_in_ext_desc[MAX_PORTS];
722 struct usb_midi_in_jack_descriptor jack_in_emb_desc[MAX_PORTS];
723 struct usb_midi_out_jack_descriptor_1 jack_out_ext_desc[MAX_PORTS];
724 struct usb_midi_out_jack_descriptor_1 jack_out_emb_desc[MAX_PORTS];
725 struct usb_composite_dev *cdev = c->cdev;
726 struct f_midi *midi = func_to_midi(f);
727 struct usb_string *us;
728 int status, n, jack = 1, i = 0;
730 midi->gadget = cdev->gadget;
731 tasklet_init(&midi->tasklet, f_midi_in_tasklet, (unsigned long) midi);
732 status = f_midi_register_card(midi);
736 /* maybe allocate device-global string ID */
737 us = usb_gstrings_attach(c->cdev, midi_strings,
738 ARRAY_SIZE(midi_string_defs));
740 status = PTR_ERR(us);
743 ac_interface_desc.iInterface = us[STRING_FUNC_IDX].id;
745 /* We have two interfaces, AudioControl and MIDIStreaming */
746 status = usb_interface_id(c, f);
749 ac_interface_desc.bInterfaceNumber = status;
751 status = usb_interface_id(c, f);
754 ms_interface_desc.bInterfaceNumber = status;
755 ac_header_desc.baInterfaceNr[0] = status;
759 /* allocate instance-specific endpoints */
760 midi->in_ep = usb_ep_autoconfig(cdev->gadget, &bulk_in_desc);
764 midi->out_ep = usb_ep_autoconfig(cdev->gadget, &bulk_out_desc);
768 /* allocate temporary function list */
769 midi_function = kcalloc((MAX_PORTS * 4) + 9, sizeof(*midi_function),
771 if (!midi_function) {
777 * construct the function's descriptor set. As the number of
778 * input and output MIDI ports is configurable, we have to do
782 /* add the headers - these are always the same */
783 midi_function[i++] = (struct usb_descriptor_header *) &ac_interface_desc;
784 midi_function[i++] = (struct usb_descriptor_header *) &ac_header_desc;
785 midi_function[i++] = (struct usb_descriptor_header *) &ms_interface_desc;
787 /* calculate the header's wTotalLength */
788 n = USB_DT_MS_HEADER_SIZE
789 + (midi->in_ports + midi->out_ports) *
790 (USB_DT_MIDI_IN_SIZE + USB_DT_MIDI_OUT_SIZE(1));
791 ms_header_desc.wTotalLength = cpu_to_le16(n);
793 midi_function[i++] = (struct usb_descriptor_header *) &ms_header_desc;
795 /* configure the external IN jacks, each linked to an embedded OUT jack */
796 for (n = 0; n < midi->in_ports; n++) {
797 struct usb_midi_in_jack_descriptor *in_ext = &jack_in_ext_desc[n];
798 struct usb_midi_out_jack_descriptor_1 *out_emb = &jack_out_emb_desc[n];
800 in_ext->bLength = USB_DT_MIDI_IN_SIZE;
801 in_ext->bDescriptorType = USB_DT_CS_INTERFACE;
802 in_ext->bDescriptorSubtype = USB_MS_MIDI_IN_JACK;
803 in_ext->bJackType = USB_MS_EXTERNAL;
804 in_ext->bJackID = jack++;
806 midi_function[i++] = (struct usb_descriptor_header *) in_ext;
808 out_emb->bLength = USB_DT_MIDI_OUT_SIZE(1);
809 out_emb->bDescriptorType = USB_DT_CS_INTERFACE;
810 out_emb->bDescriptorSubtype = USB_MS_MIDI_OUT_JACK;
811 out_emb->bJackType = USB_MS_EMBEDDED;
812 out_emb->bJackID = jack++;
813 out_emb->bNrInputPins = 1;
814 out_emb->pins[0].baSourcePin = 1;
815 out_emb->pins[0].baSourceID = in_ext->bJackID;
817 midi_function[i++] = (struct usb_descriptor_header *) out_emb;
819 /* link it to the endpoint */
820 ms_in_desc.baAssocJackID[n] = out_emb->bJackID;
823 /* configure the external OUT jacks, each linked to an embedded IN jack */
824 for (n = 0; n < midi->out_ports; n++) {
825 struct usb_midi_in_jack_descriptor *in_emb = &jack_in_emb_desc[n];
826 struct usb_midi_out_jack_descriptor_1 *out_ext = &jack_out_ext_desc[n];
828 in_emb->bLength = USB_DT_MIDI_IN_SIZE;
829 in_emb->bDescriptorType = USB_DT_CS_INTERFACE;
830 in_emb->bDescriptorSubtype = USB_MS_MIDI_IN_JACK;
831 in_emb->bJackType = USB_MS_EMBEDDED;
832 in_emb->bJackID = jack++;
834 midi_function[i++] = (struct usb_descriptor_header *) in_emb;
836 out_ext->bLength = USB_DT_MIDI_OUT_SIZE(1);
837 out_ext->bDescriptorType = USB_DT_CS_INTERFACE;
838 out_ext->bDescriptorSubtype = USB_MS_MIDI_OUT_JACK;
839 out_ext->bJackType = USB_MS_EXTERNAL;
840 out_ext->bJackID = jack++;
841 out_ext->bNrInputPins = 1;
843 out_ext->pins[0].baSourceID = in_emb->bJackID;
844 out_ext->pins[0].baSourcePin = 1;
845 midi_function[i++] = (struct usb_descriptor_header *) out_ext;
847 /* link it to the endpoint */
848 ms_out_desc.baAssocJackID[n] = in_emb->bJackID;
851 /* configure the endpoint descriptors ... */
852 ms_out_desc.bLength = USB_DT_MS_ENDPOINT_SIZE(midi->in_ports);
853 ms_out_desc.bNumEmbMIDIJack = midi->in_ports;
855 ms_in_desc.bLength = USB_DT_MS_ENDPOINT_SIZE(midi->out_ports);
856 ms_in_desc.bNumEmbMIDIJack = midi->out_ports;
858 /* ... and add them to the list */
859 midi_function[i++] = (struct usb_descriptor_header *) &bulk_out_desc;
860 midi_function[i++] = (struct usb_descriptor_header *) &ms_out_desc;
861 midi_function[i++] = (struct usb_descriptor_header *) &bulk_in_desc;
862 midi_function[i++] = (struct usb_descriptor_header *) &ms_in_desc;
863 midi_function[i++] = NULL;
866 * support all relevant hardware speeds... we expect that when
867 * hardware is dual speed, all bulk-capable endpoints work at
870 /* copy descriptors, and track endpoint copies */
871 f->fs_descriptors = usb_copy_descriptors(midi_function);
872 if (!f->fs_descriptors)
875 if (gadget_is_dualspeed(c->cdev->gadget)) {
876 bulk_in_desc.wMaxPacketSize = cpu_to_le16(512);
877 bulk_out_desc.wMaxPacketSize = cpu_to_le16(512);
878 f->hs_descriptors = usb_copy_descriptors(midi_function);
879 if (!f->hs_descriptors)
883 kfree(midi_function);
888 kfree(midi_function);
889 usb_free_descriptors(f->hs_descriptors);
891 f_midi_unregister_card(midi);
893 ERROR(cdev, "%s: can't bind, err %d\n", f->name, status);
898 static inline struct f_midi_opts *to_f_midi_opts(struct config_item *item)
900 return container_of(to_config_group(item), struct f_midi_opts,
904 static void midi_attr_release(struct config_item *item)
906 struct f_midi_opts *opts = to_f_midi_opts(item);
908 usb_put_function_instance(&opts->func_inst);
911 static struct configfs_item_operations midi_item_ops = {
912 .release = midi_attr_release,
915 #define F_MIDI_OPT(name, test_limit, limit) \
916 static ssize_t f_midi_opts_##name##_show(struct config_item *item, char *page) \
918 struct f_midi_opts *opts = to_f_midi_opts(item); \
921 mutex_lock(&opts->lock); \
922 result = sprintf(page, "%d\n", opts->name); \
923 mutex_unlock(&opts->lock); \
928 static ssize_t f_midi_opts_##name##_store(struct config_item *item, \
929 const char *page, size_t len) \
931 struct f_midi_opts *opts = to_f_midi_opts(item); \
935 mutex_lock(&opts->lock); \
936 if (opts->refcnt) { \
941 ret = kstrtou32(page, 0, &num); \
945 if (test_limit && num > limit) { \
953 mutex_unlock(&opts->lock); \
957 CONFIGFS_ATTR(f_midi_opts_, name);
959 F_MIDI_OPT(index, true, SNDRV_CARDS);
960 F_MIDI_OPT(buflen, false, 0);
961 F_MIDI_OPT(qlen, false, 0);
962 F_MIDI_OPT(in_ports, true, MAX_PORTS);
963 F_MIDI_OPT(out_ports, true, MAX_PORTS);
965 static ssize_t f_midi_opts_id_show(struct config_item *item, char *page)
967 struct f_midi_opts *opts = to_f_midi_opts(item);
970 mutex_lock(&opts->lock);
972 result = strlcpy(page, opts->id, PAGE_SIZE);
978 mutex_unlock(&opts->lock);
983 static ssize_t f_midi_opts_id_store(struct config_item *item,
984 const char *page, size_t len)
986 struct f_midi_opts *opts = to_f_midi_opts(item);
990 mutex_lock(&opts->lock);
996 c = kstrndup(page, len, GFP_KERNEL);
1001 if (opts->id_allocated)
1004 opts->id_allocated = true;
1007 mutex_unlock(&opts->lock);
1011 CONFIGFS_ATTR(f_midi_opts_, id);
1013 static struct configfs_attribute *midi_attrs[] = {
1014 &f_midi_opts_attr_index,
1015 &f_midi_opts_attr_buflen,
1016 &f_midi_opts_attr_qlen,
1017 &f_midi_opts_attr_in_ports,
1018 &f_midi_opts_attr_out_ports,
1019 &f_midi_opts_attr_id,
1023 static struct config_item_type midi_func_type = {
1024 .ct_item_ops = &midi_item_ops,
1025 .ct_attrs = midi_attrs,
1026 .ct_owner = THIS_MODULE,
1029 static void f_midi_free_inst(struct usb_function_instance *f)
1031 struct f_midi_opts *opts;
1033 opts = container_of(f, struct f_midi_opts, func_inst);
1035 if (opts->id_allocated)
1041 static struct usb_function_instance *f_midi_alloc_inst(void)
1043 struct f_midi_opts *opts;
1045 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
1047 return ERR_PTR(-ENOMEM);
1049 mutex_init(&opts->lock);
1050 opts->func_inst.free_func_inst = f_midi_free_inst;
1051 opts->index = SNDRV_DEFAULT_IDX1;
1052 opts->id = SNDRV_DEFAULT_STR1;
1056 opts->out_ports = 1;
1058 config_group_init_type_name(&opts->func_inst.group, "",
1061 return &opts->func_inst;
1064 static void f_midi_free(struct usb_function *f)
1066 struct f_midi *midi;
1067 struct f_midi_opts *opts;
1070 midi = func_to_midi(f);
1071 opts = container_of(f->fi, struct f_midi_opts, func_inst);
1073 mutex_lock(&opts->lock);
1074 for (i = opts->in_ports - 1; i >= 0; --i)
1075 kfree(midi->in_port[i]);
1078 mutex_unlock(&opts->lock);
1081 static void f_midi_unbind(struct usb_configuration *c, struct usb_function *f)
1083 struct usb_composite_dev *cdev = f->config->cdev;
1084 struct f_midi *midi = func_to_midi(f);
1085 struct snd_card *card;
1087 DBG(cdev, "unbind\n");
1089 /* just to be sure */
1095 snd_card_free(card);
1097 usb_free_all_descriptors(f);
1100 static struct usb_function *f_midi_alloc(struct usb_function_instance *fi)
1102 struct f_midi *midi;
1103 struct f_midi_opts *opts;
1106 opts = container_of(fi, struct f_midi_opts, func_inst);
1108 mutex_lock(&opts->lock);
1110 if (opts->in_ports > MAX_PORTS || opts->out_ports > MAX_PORTS) {
1111 mutex_unlock(&opts->lock);
1112 return ERR_PTR(-EINVAL);
1115 /* allocate and initialize one new instance */
1116 midi = kzalloc(sizeof(*midi), GFP_KERNEL);
1118 mutex_unlock(&opts->lock);
1119 return ERR_PTR(-ENOMEM);
1122 for (i = 0; i < opts->in_ports; i++) {
1123 struct gmidi_in_port *port = kzalloc(sizeof(*port), GFP_KERNEL);
1127 mutex_unlock(&opts->lock);
1134 midi->in_port[i] = port;
1137 /* set up ALSA midi devices */
1138 midi->id = kstrdup(opts->id, GFP_KERNEL);
1139 if (opts->id && !midi->id) {
1141 mutex_unlock(&opts->lock);
1144 midi->in_ports = opts->in_ports;
1145 midi->out_ports = opts->out_ports;
1146 midi->index = opts->index;
1147 midi->buflen = opts->buflen;
1148 midi->qlen = opts->qlen;
1150 mutex_unlock(&opts->lock);
1152 midi->func.name = "gmidi function";
1153 midi->func.bind = f_midi_bind;
1154 midi->func.unbind = f_midi_unbind;
1155 midi->func.set_alt = f_midi_set_alt;
1156 midi->func.disable = f_midi_disable;
1157 midi->func.free_func = f_midi_free;
1162 for (--i; i >= 0; i--)
1163 kfree(midi->in_port[i]);
1165 return ERR_PTR(status);
1168 DECLARE_USB_FUNCTION_INIT(midi, f_midi_alloc_inst, f_midi_alloc);