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>
26 #include <linux/kfifo.h>
27 #include <linux/spinlock.h>
29 #include <sound/core.h>
30 #include <sound/initval.h>
31 #include <sound/rawmidi.h>
33 #include <linux/usb/ch9.h>
34 #include <linux/usb/gadget.h>
35 #include <linux/usb/audio.h>
36 #include <linux/usb/midi.h>
41 MODULE_AUTHOR("Ben Williamson");
42 MODULE_LICENSE("GPL v2");
44 static const char f_midi_shortname[] = "f_midi";
45 static const char f_midi_longname[] = "MIDI Gadget";
48 * We can only handle 16 cables on one single endpoint, as cable numbers are
49 * stored in 4-bit fields. And as the interface currently only holds one
50 * single endpoint, this is the maximum number of ports we can allow.
54 /* MIDI message states */
56 STATE_INITIAL = 0, /* pseudo state */
64 STATE_FINISHED, /* pseudo state */
68 * This is a gadget, and the IN/OUT naming is from the host's perspective.
69 * USB -> OUT endpoint -> rawmidi
70 * USB <- IN endpoint <- rawmidi
72 struct gmidi_in_port {
73 struct snd_rawmidi_substream *substream;
81 struct usb_function func;
82 struct usb_gadget *gadget;
83 struct usb_ep *in_ep, *out_ep;
84 struct snd_card *card;
85 struct snd_rawmidi *rmidi;
88 struct snd_rawmidi_substream *out_substream[MAX_PORTS];
90 unsigned long out_triggered;
91 struct tasklet_struct tasklet;
92 unsigned int in_ports;
93 unsigned int out_ports;
96 unsigned int buflen, qlen;
97 /* This fifo is used as a buffer ring for pre-allocated IN usb_requests */
98 DECLARE_KFIFO_PTR(in_req_fifo, struct usb_request *);
99 spinlock_t transmit_lock;
100 unsigned int in_last_port;
102 struct gmidi_in_port in_ports_array[/* in_ports */];
105 static inline struct f_midi *func_to_midi(struct usb_function *f)
107 return container_of(f, struct f_midi, func);
110 static void f_midi_transmit(struct f_midi *midi);
112 DECLARE_UAC_AC_HEADER_DESCRIPTOR(1);
113 DECLARE_USB_MIDI_OUT_JACK_DESCRIPTOR(1);
114 DECLARE_USB_MS_ENDPOINT_DESCRIPTOR(16);
116 /* B.3.1 Standard AC Interface Descriptor */
117 static struct usb_interface_descriptor ac_interface_desc = {
118 .bLength = USB_DT_INTERFACE_SIZE,
119 .bDescriptorType = USB_DT_INTERFACE,
120 /* .bInterfaceNumber = DYNAMIC */
121 /* .bNumEndpoints = DYNAMIC */
122 .bInterfaceClass = USB_CLASS_AUDIO,
123 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL,
124 /* .iInterface = DYNAMIC */
127 /* B.3.2 Class-Specific AC Interface Descriptor */
128 static struct uac1_ac_header_descriptor_1 ac_header_desc = {
129 .bLength = UAC_DT_AC_HEADER_SIZE(1),
130 .bDescriptorType = USB_DT_CS_INTERFACE,
131 .bDescriptorSubtype = USB_MS_HEADER,
132 .bcdADC = cpu_to_le16(0x0100),
133 .wTotalLength = cpu_to_le16(UAC_DT_AC_HEADER_SIZE(1)),
135 /* .baInterfaceNr = DYNAMIC */
138 /* B.4.1 Standard MS Interface Descriptor */
139 static struct usb_interface_descriptor ms_interface_desc = {
140 .bLength = USB_DT_INTERFACE_SIZE,
141 .bDescriptorType = USB_DT_INTERFACE,
142 /* .bInterfaceNumber = DYNAMIC */
144 .bInterfaceClass = USB_CLASS_AUDIO,
145 .bInterfaceSubClass = USB_SUBCLASS_MIDISTREAMING,
146 /* .iInterface = DYNAMIC */
149 /* B.4.2 Class-Specific MS Interface Descriptor */
150 static struct usb_ms_header_descriptor ms_header_desc = {
151 .bLength = USB_DT_MS_HEADER_SIZE,
152 .bDescriptorType = USB_DT_CS_INTERFACE,
153 .bDescriptorSubtype = USB_MS_HEADER,
154 .bcdMSC = cpu_to_le16(0x0100),
155 /* .wTotalLength = DYNAMIC */
158 /* B.5.1 Standard Bulk OUT Endpoint Descriptor */
159 static struct usb_endpoint_descriptor bulk_out_desc = {
160 .bLength = USB_DT_ENDPOINT_AUDIO_SIZE,
161 .bDescriptorType = USB_DT_ENDPOINT,
162 .bEndpointAddress = USB_DIR_OUT,
163 .bmAttributes = USB_ENDPOINT_XFER_BULK,
166 /* B.5.2 Class-specific MS Bulk OUT Endpoint Descriptor */
167 static struct usb_ms_endpoint_descriptor_16 ms_out_desc = {
168 /* .bLength = DYNAMIC */
169 .bDescriptorType = USB_DT_CS_ENDPOINT,
170 .bDescriptorSubtype = USB_MS_GENERAL,
171 /* .bNumEmbMIDIJack = DYNAMIC */
172 /* .baAssocJackID = DYNAMIC */
175 /* B.6.1 Standard Bulk IN Endpoint Descriptor */
176 static struct usb_endpoint_descriptor bulk_in_desc = {
177 .bLength = USB_DT_ENDPOINT_AUDIO_SIZE,
178 .bDescriptorType = USB_DT_ENDPOINT,
179 .bEndpointAddress = USB_DIR_IN,
180 .bmAttributes = USB_ENDPOINT_XFER_BULK,
183 /* B.6.2 Class-specific MS Bulk IN Endpoint Descriptor */
184 static struct usb_ms_endpoint_descriptor_16 ms_in_desc = {
185 /* .bLength = DYNAMIC */
186 .bDescriptorType = USB_DT_CS_ENDPOINT,
187 .bDescriptorSubtype = USB_MS_GENERAL,
188 /* .bNumEmbMIDIJack = DYNAMIC */
189 /* .baAssocJackID = DYNAMIC */
192 /* string IDs are assigned dynamically */
194 #define STRING_FUNC_IDX 0
196 static struct usb_string midi_string_defs[] = {
197 [STRING_FUNC_IDX].s = "MIDI function",
198 { } /* end of list */
201 static struct usb_gadget_strings midi_stringtab = {
202 .language = 0x0409, /* en-us */
203 .strings = midi_string_defs,
206 static struct usb_gadget_strings *midi_strings[] = {
211 static inline struct usb_request *midi_alloc_ep_req(struct usb_ep *ep,
214 return alloc_ep_req(ep, length, length);
217 static const uint8_t f_midi_cin_length[] = {
218 0, 0, 2, 3, 3, 1, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1
222 * Receives a chunk of MIDI data.
224 static void f_midi_read_data(struct usb_ep *ep, int cable,
225 uint8_t *data, int length)
227 struct f_midi *midi = ep->driver_data;
228 struct snd_rawmidi_substream *substream = midi->out_substream[cable];
231 /* Nobody is listening - throw it on the floor. */
234 if (!test_bit(cable, &midi->out_triggered))
237 snd_rawmidi_receive(substream, data, length);
240 static void f_midi_handle_out_data(struct usb_ep *ep, struct usb_request *req)
245 for (i = 0; i + 3 < req->actual; i += 4)
247 int cable = buf[i] >> 4;
248 int length = f_midi_cin_length[buf[i] & 0x0f];
249 f_midi_read_data(ep, cable, &buf[i + 1], length);
254 f_midi_complete(struct usb_ep *ep, struct usb_request *req)
256 struct f_midi *midi = ep->driver_data;
257 struct usb_composite_dev *cdev = midi->func.config->cdev;
258 int status = req->status;
261 case 0: /* normal completion */
262 if (ep == midi->out_ep) {
263 /* We received stuff. req is queued again, below */
264 f_midi_handle_out_data(ep, req);
265 } else if (ep == midi->in_ep) {
266 /* Our transmit completed. See if there's more to go.
267 * f_midi_transmit eats req, don't queue it again. */
269 f_midi_transmit(midi);
274 /* this endpoint is normally active while we're configured */
275 case -ECONNABORTED: /* hardware forced ep reset */
276 case -ECONNRESET: /* request dequeued */
277 case -ESHUTDOWN: /* disconnect from host */
278 VDBG(cdev, "%s gone (%d), %d/%d\n", ep->name, status,
279 req->actual, req->length);
280 if (ep == midi->out_ep) {
281 f_midi_handle_out_data(ep, req);
282 /* We don't need to free IN requests because it's handled
283 * by the midi->in_req_fifo. */
284 free_ep_req(ep, req);
288 case -EOVERFLOW: /* buffer overrun on read means that
289 * we didn't provide a big enough buffer.
292 DBG(cdev, "%s complete --> %d, %d/%d\n", ep->name,
293 status, req->actual, req->length);
295 case -EREMOTEIO: /* short read */
299 status = usb_ep_queue(ep, req, GFP_ATOMIC);
301 ERROR(cdev, "kill %s: resubmit %d bytes --> %d\n",
302 ep->name, req->length, status);
304 /* FIXME recover later ... somehow */
308 static int f_midi_start_ep(struct f_midi *midi,
309 struct usb_function *f,
313 struct usb_composite_dev *cdev = f->config->cdev;
317 err = config_ep_by_speed(midi->gadget, f, ep);
319 ERROR(cdev, "can't configure %s: %d\n", ep->name, err);
323 err = usb_ep_enable(ep);
325 ERROR(cdev, "can't start %s: %d\n", ep->name, err);
329 ep->driver_data = midi;
334 static int f_midi_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
336 struct f_midi *midi = func_to_midi(f);
340 /* we only set alt for MIDIStreaming interface */
341 if (intf != midi->ms_id)
344 err = f_midi_start_ep(midi, f, midi->in_ep);
348 err = f_midi_start_ep(midi, f, midi->out_ep);
352 /* pre-allocate write usb requests to use on f_midi_transmit. */
353 while (kfifo_avail(&midi->in_req_fifo)) {
354 struct usb_request *req =
355 midi_alloc_ep_req(midi->in_ep, midi->buflen);
361 req->complete = f_midi_complete;
363 kfifo_put(&midi->in_req_fifo, req);
366 /* allocate a bunch of read buffers and queue them all at once. */
367 for (i = 0; i < midi->qlen && err == 0; i++) {
368 struct usb_request *req =
369 midi_alloc_ep_req(midi->out_ep, midi->buflen);
374 req->complete = f_midi_complete;
375 err = usb_ep_queue(midi->out_ep, req, GFP_ATOMIC);
377 ERROR(midi, "%s: couldn't enqueue request: %d\n",
378 midi->out_ep->name, err);
379 free_ep_req(midi->out_ep, req);
387 static void f_midi_disable(struct usb_function *f)
389 struct f_midi *midi = func_to_midi(f);
390 struct usb_composite_dev *cdev = f->config->cdev;
391 struct usb_request *req = NULL;
393 DBG(cdev, "disable\n");
396 * just disable endpoints, forcing completion of pending i/o.
397 * all our completion handlers free their requests in this case.
399 usb_ep_disable(midi->in_ep);
400 usb_ep_disable(midi->out_ep);
402 /* release IN requests */
403 while (kfifo_get(&midi->in_req_fifo, &req))
404 free_ep_req(midi->in_ep, req);
407 static int f_midi_snd_free(struct snd_device *device)
413 * Converts MIDI commands to USB MIDI packets.
415 static void f_midi_transmit_byte(struct usb_request *req,
416 struct gmidi_in_port *port, uint8_t b)
418 uint8_t p[4] = { port->cable << 4, 0, 0, 0 };
419 uint8_t next_state = STATE_INITIAL;
423 /* System Real-Time Messages */
426 next_state = port->state;
427 port->state = STATE_REAL_TIME;
432 switch (port->state) {
436 next_state = STATE_FINISHED;
440 p[1] = port->data[0];
442 next_state = STATE_FINISHED;
446 p[1] = port->data[0];
447 p[2] = port->data[1];
449 next_state = STATE_FINISHED;
453 next_state = port->state;
454 port->state = STATE_INITIAL;
459 /* System Common Messages */
460 port->data[0] = port->data[1] = 0;
461 port->state = STATE_INITIAL;
466 next_state = STATE_SYSEX_1;
471 next_state = STATE_1PARAM;
475 next_state = STATE_2PARAM_1;
479 next_state = STATE_INITIAL;
484 next_state = STATE_FINISHED;
491 * Channel Voice Messages, Channel Mode Messages
492 * and Control Change Messages.
496 port->state = STATE_INITIAL;
497 if (b >= 0xc0 && b <= 0xdf)
498 next_state = STATE_1PARAM;
500 next_state = STATE_2PARAM_1;
504 /* Message parameters */
505 switch (port->state) {
507 if (port->data[0] < 0xf0)
508 p[0] |= port->data[0] >> 4;
512 p[1] = port->data[0];
514 /* This is to allow Running State Messages */
515 next_state = STATE_1PARAM;
519 next_state = STATE_2PARAM_2;
522 if (port->data[0] < 0xf0)
523 p[0] |= port->data[0] >> 4;
527 p[1] = port->data[0];
528 p[2] = port->data[1];
530 /* This is to allow Running State Messages */
531 next_state = STATE_2PARAM_1;
535 next_state = STATE_SYSEX_1;
539 next_state = STATE_SYSEX_2;
543 p[1] = port->data[0];
544 p[2] = port->data[1];
546 next_state = STATE_SYSEX_0;
552 /* States where we have to write into the USB request */
553 if (next_state == STATE_FINISHED ||
554 port->state == STATE_SYSEX_2 ||
555 port->state == STATE_1PARAM ||
556 port->state == STATE_2PARAM_2 ||
557 port->state == STATE_REAL_TIME) {
559 unsigned int length = req->length;
560 u8 *buf = (u8 *)req->buf + length;
562 memcpy(buf, p, sizeof(p));
563 req->length = length + sizeof(p);
565 if (next_state == STATE_FINISHED) {
566 next_state = STATE_INITIAL;
567 port->data[0] = port->data[1] = 0;
571 port->state = next_state;
574 static void f_midi_drop_out_substreams(struct f_midi *midi)
578 for (i = 0; i < midi->in_ports; i++) {
579 struct gmidi_in_port *port = midi->in_ports_array + i;
580 struct snd_rawmidi_substream *substream = port->substream;
581 if (port->active && substream)
582 snd_rawmidi_drop_output(substream);
586 static int f_midi_do_transmit(struct f_midi *midi, struct usb_ep *ep)
588 struct usb_request *req = NULL;
594 * We peek the request in order to reuse it if it fails to enqueue on
597 len = kfifo_peek(&midi->in_req_fifo, &req);
599 ERROR(midi, "%s: Couldn't get usb request\n", __func__);
604 * If buffer overrun, then we ignore this transmission.
605 * IMPORTANT: This will cause the user-space rawmidi device to block
606 * until a) usb requests have been completed or b) snd_rawmidi_write()
612 for (i = midi->in_last_port; i < midi->in_ports; ++i) {
613 struct gmidi_in_port *port = midi->in_ports_array + i;
614 struct snd_rawmidi_substream *substream = port->substream;
616 if (!port->active || !substream)
619 while (req->length + 3 < midi->buflen) {
622 if (snd_rawmidi_transmit(substream, &b, 1) != 1) {
626 f_midi_transmit_byte(req, port, b);
629 active = !!port->active;
633 midi->in_last_port = active ? i : 0;
635 if (req->length <= 0)
638 err = usb_ep_queue(ep, req, GFP_ATOMIC);
640 ERROR(midi, "%s failed to queue req: %d\n",
641 midi->in_ep->name, err);
642 req->length = 0; /* Re-use request next time. */
644 /* Upon success, put request at the back of the queue. */
645 kfifo_skip(&midi->in_req_fifo);
646 kfifo_put(&midi->in_req_fifo, req);
653 static void f_midi_transmit(struct f_midi *midi)
655 struct usb_ep *ep = midi->in_ep;
659 /* We only care about USB requests if IN endpoint is enabled */
660 if (!ep || !ep->enabled)
663 spin_lock_irqsave(&midi->transmit_lock, flags);
666 ret = f_midi_do_transmit(midi, ep);
668 spin_unlock_irqrestore(&midi->transmit_lock, flags);
673 spin_unlock_irqrestore(&midi->transmit_lock, flags);
678 f_midi_drop_out_substreams(midi);
681 static void f_midi_in_tasklet(unsigned long data)
683 struct f_midi *midi = (struct f_midi *) data;
684 f_midi_transmit(midi);
687 static int f_midi_in_open(struct snd_rawmidi_substream *substream)
689 struct f_midi *midi = substream->rmidi->private_data;
690 struct gmidi_in_port *port;
692 if (substream->number >= midi->in_ports)
695 VDBG(midi, "%s()\n", __func__);
696 port = midi->in_ports_array + substream->number;
697 port->substream = substream;
698 port->state = STATE_INITIAL;
702 static int f_midi_in_close(struct snd_rawmidi_substream *substream)
704 struct f_midi *midi = substream->rmidi->private_data;
706 VDBG(midi, "%s()\n", __func__);
710 static void f_midi_in_trigger(struct snd_rawmidi_substream *substream, int up)
712 struct f_midi *midi = substream->rmidi->private_data;
714 if (substream->number >= midi->in_ports)
717 VDBG(midi, "%s() %d\n", __func__, up);
718 midi->in_ports_array[substream->number].active = up;
720 tasklet_hi_schedule(&midi->tasklet);
723 static int f_midi_out_open(struct snd_rawmidi_substream *substream)
725 struct f_midi *midi = substream->rmidi->private_data;
727 if (substream->number >= MAX_PORTS)
730 VDBG(midi, "%s()\n", __func__);
731 midi->out_substream[substream->number] = substream;
735 static int f_midi_out_close(struct snd_rawmidi_substream *substream)
737 struct f_midi *midi = substream->rmidi->private_data;
739 VDBG(midi, "%s()\n", __func__);
743 static void f_midi_out_trigger(struct snd_rawmidi_substream *substream, int up)
745 struct f_midi *midi = substream->rmidi->private_data;
747 VDBG(midi, "%s()\n", __func__);
750 set_bit(substream->number, &midi->out_triggered);
752 clear_bit(substream->number, &midi->out_triggered);
755 static struct snd_rawmidi_ops gmidi_in_ops = {
756 .open = f_midi_in_open,
757 .close = f_midi_in_close,
758 .trigger = f_midi_in_trigger,
761 static struct snd_rawmidi_ops gmidi_out_ops = {
762 .open = f_midi_out_open,
763 .close = f_midi_out_close,
764 .trigger = f_midi_out_trigger
767 static inline void f_midi_unregister_card(struct f_midi *midi)
770 snd_card_free(midi->card);
775 /* register as a sound "card" */
776 static int f_midi_register_card(struct f_midi *midi)
778 struct snd_card *card;
779 struct snd_rawmidi *rmidi;
781 static struct snd_device_ops ops = {
782 .dev_free = f_midi_snd_free,
785 err = snd_card_new(&midi->gadget->dev, midi->index, midi->id,
786 THIS_MODULE, 0, &card);
788 ERROR(midi, "snd_card_new() failed\n");
793 err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, midi, &ops);
795 ERROR(midi, "snd_device_new() failed: error %d\n", err);
799 strcpy(card->driver, f_midi_longname);
800 strcpy(card->longname, f_midi_longname);
801 strcpy(card->shortname, f_midi_shortname);
804 snd_component_add(card, "MIDI");
805 err = snd_rawmidi_new(card, card->longname, 0,
806 midi->out_ports, midi->in_ports, &rmidi);
808 ERROR(midi, "snd_rawmidi_new() failed: error %d\n", err);
812 midi->in_last_port = 0;
813 strcpy(rmidi->name, card->shortname);
814 rmidi->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT |
815 SNDRV_RAWMIDI_INFO_INPUT |
816 SNDRV_RAWMIDI_INFO_DUPLEX;
817 rmidi->private_data = midi;
820 * Yes, rawmidi OUTPUT = USB IN, and rawmidi INPUT = USB OUT.
821 * It's an upside-down world being a gadget.
823 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &gmidi_in_ops);
824 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &gmidi_out_ops);
826 /* register it - we're ready to go */
827 err = snd_card_register(card);
829 ERROR(midi, "snd_card_register() failed\n");
833 VDBG(midi, "%s() finished ok\n", __func__);
837 f_midi_unregister_card(midi);
841 /* MIDI function driver setup/binding */
843 static int f_midi_bind(struct usb_configuration *c, struct usb_function *f)
845 struct usb_descriptor_header **midi_function;
846 struct usb_midi_in_jack_descriptor jack_in_ext_desc[MAX_PORTS];
847 struct usb_midi_in_jack_descriptor jack_in_emb_desc[MAX_PORTS];
848 struct usb_midi_out_jack_descriptor_1 jack_out_ext_desc[MAX_PORTS];
849 struct usb_midi_out_jack_descriptor_1 jack_out_emb_desc[MAX_PORTS];
850 struct usb_composite_dev *cdev = c->cdev;
851 struct f_midi *midi = func_to_midi(f);
852 struct usb_string *us;
853 int status, n, jack = 1, i = 0;
855 midi->gadget = cdev->gadget;
856 tasklet_init(&midi->tasklet, f_midi_in_tasklet, (unsigned long) midi);
857 status = f_midi_register_card(midi);
861 /* maybe allocate device-global string ID */
862 us = usb_gstrings_attach(c->cdev, midi_strings,
863 ARRAY_SIZE(midi_string_defs));
865 status = PTR_ERR(us);
868 ac_interface_desc.iInterface = us[STRING_FUNC_IDX].id;
870 /* We have two interfaces, AudioControl and MIDIStreaming */
871 status = usb_interface_id(c, f);
874 ac_interface_desc.bInterfaceNumber = status;
876 status = usb_interface_id(c, f);
879 ms_interface_desc.bInterfaceNumber = status;
880 ac_header_desc.baInterfaceNr[0] = status;
881 midi->ms_id = status;
885 /* allocate instance-specific endpoints */
886 midi->in_ep = usb_ep_autoconfig(cdev->gadget, &bulk_in_desc);
890 midi->out_ep = usb_ep_autoconfig(cdev->gadget, &bulk_out_desc);
894 /* allocate temporary function list */
895 midi_function = kcalloc((MAX_PORTS * 4) + 9, sizeof(*midi_function),
897 if (!midi_function) {
903 * construct the function's descriptor set. As the number of
904 * input and output MIDI ports is configurable, we have to do
908 /* add the headers - these are always the same */
909 midi_function[i++] = (struct usb_descriptor_header *) &ac_interface_desc;
910 midi_function[i++] = (struct usb_descriptor_header *) &ac_header_desc;
911 midi_function[i++] = (struct usb_descriptor_header *) &ms_interface_desc;
913 /* calculate the header's wTotalLength */
914 n = USB_DT_MS_HEADER_SIZE
915 + (midi->in_ports + midi->out_ports) *
916 (USB_DT_MIDI_IN_SIZE + USB_DT_MIDI_OUT_SIZE(1));
917 ms_header_desc.wTotalLength = cpu_to_le16(n);
919 midi_function[i++] = (struct usb_descriptor_header *) &ms_header_desc;
921 /* configure the external IN jacks, each linked to an embedded OUT jack */
922 for (n = 0; n < midi->in_ports; n++) {
923 struct usb_midi_in_jack_descriptor *in_ext = &jack_in_ext_desc[n];
924 struct usb_midi_out_jack_descriptor_1 *out_emb = &jack_out_emb_desc[n];
926 in_ext->bLength = USB_DT_MIDI_IN_SIZE;
927 in_ext->bDescriptorType = USB_DT_CS_INTERFACE;
928 in_ext->bDescriptorSubtype = USB_MS_MIDI_IN_JACK;
929 in_ext->bJackType = USB_MS_EXTERNAL;
930 in_ext->bJackID = jack++;
932 midi_function[i++] = (struct usb_descriptor_header *) in_ext;
934 out_emb->bLength = USB_DT_MIDI_OUT_SIZE(1);
935 out_emb->bDescriptorType = USB_DT_CS_INTERFACE;
936 out_emb->bDescriptorSubtype = USB_MS_MIDI_OUT_JACK;
937 out_emb->bJackType = USB_MS_EMBEDDED;
938 out_emb->bJackID = jack++;
939 out_emb->bNrInputPins = 1;
940 out_emb->pins[0].baSourcePin = 1;
941 out_emb->pins[0].baSourceID = in_ext->bJackID;
943 midi_function[i++] = (struct usb_descriptor_header *) out_emb;
945 /* link it to the endpoint */
946 ms_in_desc.baAssocJackID[n] = out_emb->bJackID;
949 /* configure the external OUT jacks, each linked to an embedded IN jack */
950 for (n = 0; n < midi->out_ports; n++) {
951 struct usb_midi_in_jack_descriptor *in_emb = &jack_in_emb_desc[n];
952 struct usb_midi_out_jack_descriptor_1 *out_ext = &jack_out_ext_desc[n];
954 in_emb->bLength = USB_DT_MIDI_IN_SIZE;
955 in_emb->bDescriptorType = USB_DT_CS_INTERFACE;
956 in_emb->bDescriptorSubtype = USB_MS_MIDI_IN_JACK;
957 in_emb->bJackType = USB_MS_EMBEDDED;
958 in_emb->bJackID = jack++;
960 midi_function[i++] = (struct usb_descriptor_header *) in_emb;
962 out_ext->bLength = USB_DT_MIDI_OUT_SIZE(1);
963 out_ext->bDescriptorType = USB_DT_CS_INTERFACE;
964 out_ext->bDescriptorSubtype = USB_MS_MIDI_OUT_JACK;
965 out_ext->bJackType = USB_MS_EXTERNAL;
966 out_ext->bJackID = jack++;
967 out_ext->bNrInputPins = 1;
969 out_ext->pins[0].baSourceID = in_emb->bJackID;
970 out_ext->pins[0].baSourcePin = 1;
971 midi_function[i++] = (struct usb_descriptor_header *) out_ext;
973 /* link it to the endpoint */
974 ms_out_desc.baAssocJackID[n] = in_emb->bJackID;
977 /* configure the endpoint descriptors ... */
978 ms_out_desc.bLength = USB_DT_MS_ENDPOINT_SIZE(midi->in_ports);
979 ms_out_desc.bNumEmbMIDIJack = midi->in_ports;
981 ms_in_desc.bLength = USB_DT_MS_ENDPOINT_SIZE(midi->out_ports);
982 ms_in_desc.bNumEmbMIDIJack = midi->out_ports;
984 /* ... and add them to the list */
985 midi_function[i++] = (struct usb_descriptor_header *) &bulk_out_desc;
986 midi_function[i++] = (struct usb_descriptor_header *) &ms_out_desc;
987 midi_function[i++] = (struct usb_descriptor_header *) &bulk_in_desc;
988 midi_function[i++] = (struct usb_descriptor_header *) &ms_in_desc;
989 midi_function[i++] = NULL;
992 * support all relevant hardware speeds... we expect that when
993 * hardware is dual speed, all bulk-capable endpoints work at
996 /* copy descriptors, and track endpoint copies */
997 f->fs_descriptors = usb_copy_descriptors(midi_function);
998 if (!f->fs_descriptors)
1001 if (gadget_is_dualspeed(c->cdev->gadget)) {
1002 bulk_in_desc.wMaxPacketSize = cpu_to_le16(512);
1003 bulk_out_desc.wMaxPacketSize = cpu_to_le16(512);
1004 f->hs_descriptors = usb_copy_descriptors(midi_function);
1005 if (!f->hs_descriptors)
1009 kfree(midi_function);
1014 kfree(midi_function);
1015 usb_free_descriptors(f->hs_descriptors);
1017 f_midi_unregister_card(midi);
1019 ERROR(cdev, "%s: can't bind, err %d\n", f->name, status);
1024 static inline struct f_midi_opts *to_f_midi_opts(struct config_item *item)
1026 return container_of(to_config_group(item), struct f_midi_opts,
1030 static void midi_attr_release(struct config_item *item)
1032 struct f_midi_opts *opts = to_f_midi_opts(item);
1034 usb_put_function_instance(&opts->func_inst);
1037 static struct configfs_item_operations midi_item_ops = {
1038 .release = midi_attr_release,
1041 #define F_MIDI_OPT(name, test_limit, limit) \
1042 static ssize_t f_midi_opts_##name##_show(struct config_item *item, char *page) \
1044 struct f_midi_opts *opts = to_f_midi_opts(item); \
1047 mutex_lock(&opts->lock); \
1048 result = sprintf(page, "%d\n", opts->name); \
1049 mutex_unlock(&opts->lock); \
1054 static ssize_t f_midi_opts_##name##_store(struct config_item *item, \
1055 const char *page, size_t len) \
1057 struct f_midi_opts *opts = to_f_midi_opts(item); \
1061 mutex_lock(&opts->lock); \
1062 if (opts->refcnt) { \
1067 ret = kstrtou32(page, 0, &num); \
1071 if (test_limit && num > limit) { \
1079 mutex_unlock(&opts->lock); \
1083 CONFIGFS_ATTR(f_midi_opts_, name);
1085 F_MIDI_OPT(index, true, SNDRV_CARDS);
1086 F_MIDI_OPT(buflen, false, 0);
1087 F_MIDI_OPT(qlen, false, 0);
1088 F_MIDI_OPT(in_ports, true, MAX_PORTS);
1089 F_MIDI_OPT(out_ports, true, MAX_PORTS);
1091 static ssize_t f_midi_opts_id_show(struct config_item *item, char *page)
1093 struct f_midi_opts *opts = to_f_midi_opts(item);
1096 mutex_lock(&opts->lock);
1098 result = strlcpy(page, opts->id, PAGE_SIZE);
1104 mutex_unlock(&opts->lock);
1109 static ssize_t f_midi_opts_id_store(struct config_item *item,
1110 const char *page, size_t len)
1112 struct f_midi_opts *opts = to_f_midi_opts(item);
1116 mutex_lock(&opts->lock);
1122 c = kstrndup(page, len, GFP_KERNEL);
1127 if (opts->id_allocated)
1130 opts->id_allocated = true;
1133 mutex_unlock(&opts->lock);
1137 CONFIGFS_ATTR(f_midi_opts_, id);
1139 static struct configfs_attribute *midi_attrs[] = {
1140 &f_midi_opts_attr_index,
1141 &f_midi_opts_attr_buflen,
1142 &f_midi_opts_attr_qlen,
1143 &f_midi_opts_attr_in_ports,
1144 &f_midi_opts_attr_out_ports,
1145 &f_midi_opts_attr_id,
1149 static struct config_item_type midi_func_type = {
1150 .ct_item_ops = &midi_item_ops,
1151 .ct_attrs = midi_attrs,
1152 .ct_owner = THIS_MODULE,
1155 static void f_midi_free_inst(struct usb_function_instance *f)
1157 struct f_midi_opts *opts;
1159 opts = container_of(f, struct f_midi_opts, func_inst);
1161 if (opts->id_allocated)
1167 static struct usb_function_instance *f_midi_alloc_inst(void)
1169 struct f_midi_opts *opts;
1171 opts = kzalloc(sizeof(*opts), GFP_KERNEL);
1173 return ERR_PTR(-ENOMEM);
1175 mutex_init(&opts->lock);
1176 opts->func_inst.free_func_inst = f_midi_free_inst;
1177 opts->index = SNDRV_DEFAULT_IDX1;
1178 opts->id = SNDRV_DEFAULT_STR1;
1182 opts->out_ports = 1;
1184 config_group_init_type_name(&opts->func_inst.group, "",
1187 return &opts->func_inst;
1190 static void f_midi_free(struct usb_function *f)
1192 struct f_midi *midi;
1193 struct f_midi_opts *opts;
1195 midi = func_to_midi(f);
1196 opts = container_of(f->fi, struct f_midi_opts, func_inst);
1198 mutex_lock(&opts->lock);
1199 kfifo_free(&midi->in_req_fifo);
1202 mutex_unlock(&opts->lock);
1205 static void f_midi_unbind(struct usb_configuration *c, struct usb_function *f)
1207 struct usb_composite_dev *cdev = f->config->cdev;
1208 struct f_midi *midi = func_to_midi(f);
1209 struct snd_card *card;
1211 DBG(cdev, "unbind\n");
1213 /* just to be sure */
1219 snd_card_free(card);
1221 usb_free_all_descriptors(f);
1224 static struct usb_function *f_midi_alloc(struct usb_function_instance *fi)
1226 struct f_midi *midi = NULL;
1227 struct f_midi_opts *opts;
1230 opts = container_of(fi, struct f_midi_opts, func_inst);
1232 mutex_lock(&opts->lock);
1234 if (opts->in_ports > MAX_PORTS || opts->out_ports > MAX_PORTS) {
1239 /* allocate and initialize one new instance */
1241 sizeof(*midi) + opts->in_ports * sizeof(*midi->in_ports_array),
1248 for (i = 0; i < opts->in_ports; i++)
1249 midi->in_ports_array[i].cable = i;
1251 /* set up ALSA midi devices */
1252 midi->id = kstrdup(opts->id, GFP_KERNEL);
1253 if (opts->id && !midi->id) {
1257 midi->in_ports = opts->in_ports;
1258 midi->out_ports = opts->out_ports;
1259 midi->index = opts->index;
1260 midi->buflen = opts->buflen;
1261 midi->qlen = opts->qlen;
1262 midi->in_last_port = 0;
1264 status = kfifo_alloc(&midi->in_req_fifo, midi->qlen, GFP_KERNEL);
1268 spin_lock_init(&midi->transmit_lock);
1271 mutex_unlock(&opts->lock);
1273 midi->func.name = "gmidi function";
1274 midi->func.bind = f_midi_bind;
1275 midi->func.unbind = f_midi_unbind;
1276 midi->func.set_alt = f_midi_set_alt;
1277 midi->func.disable = f_midi_disable;
1278 midi->func.free_func = f_midi_free;
1283 mutex_unlock(&opts->lock);
1285 return ERR_PTR(status);
1288 DECLARE_USB_FUNCTION_INIT(midi, f_midi_alloc_inst, f_midi_alloc);