drivers/usb/gadget/function/f_midi.c

   1 /*
   2  * f_midi.c -- USB MIDI class function 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  * Rewritten for the composite framework
   9  *   Copyright (C) 2011 Daniel Mack <zonque@gmail.com>
  10  *
  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
  14  *
  15  * and drivers/usb/gadget/midi.c,
  16  *   Copyright (C) 2006 Thumtronics Pty Ltd.
  17  *   Ben Williamson <ben.williamson@greyinnovation.com>
  18  *
  19  * Licensed under the GPL-2 or later.
  20  */
  21
  22 #include <linux/kernel.h>
  23 #include <linux/module.h>
  24 #include <linux/slab.h>
  25 #include <linux/device.h>
  26
  27 #include <sound/core.h>
  28 #include <sound/initval.h>
  29 #include <sound/rawmidi.h>
  30
  31 #include <linux/usb/ch9.h>
  32 #include <linux/usb/gadget.h>
  33 #include <linux/usb/audio.h>
  34 #include <linux/usb/midi.h>
  35
  36 #include "u_f.h"
  37 #include "u_midi.h"
  38
  39 MODULE_AUTHOR("Ben Williamson");
  40 MODULE_LICENSE("GPL v2");
  41
  42 static const char f_midi_shortname[] = "f_midi";
  43 static const char f_midi_longname[] = "MIDI Gadget";
  44
  45 /*
  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.
  49  */
  50 #define MAX_PORTS 16
  51
  52 /*
  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
  56  */
  57 struct gmidi_in_port {
  58         struct f_midi *midi;
  59         int active;
  60         uint8_t cable;
  61         uint8_t state;
  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
  69         uint8_t data[2];
  70 };
  71
  72 struct f_midi {
  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;
  78
  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];
  82
  83         unsigned long           out_triggered;
  84         struct tasklet_struct   tasklet;
  85         unsigned int in_ports;
  86         unsigned int out_ports;
  87         int index;
  88         char *id;
  89         unsigned int buflen, qlen;
  90 };
  91
  92 static inline struct f_midi *func_to_midi(struct usb_function *f)
  93 {
  94         return container_of(f, struct f_midi, func);
  95 }
  96
  97 static void f_midi_transmit(struct f_midi *midi, struct usb_request *req);
  98
  99 DECLARE_UAC_AC_HEADER_DESCRIPTOR(1);
 100 DECLARE_USB_MIDI_OUT_JACK_DESCRIPTOR(1);
 101 DECLARE_USB_MS_ENDPOINT_DESCRIPTOR(16);
 102
 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 */
 112 };
 113
 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)),
 121         .bInCollection =        1,
 122         /* .baInterfaceNr =     DYNAMIC */
 123 };
 124
 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 */
 130         .bNumEndpoints =        2,
 131         .bInterfaceClass =      USB_CLASS_AUDIO,
 132         .bInterfaceSubClass =   USB_SUBCLASS_MIDISTREAMING,
 133         /* .iInterface =        DYNAMIC */
 134 };
 135
 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 */
 143 };
 144
 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,
 151 };
 152
 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 */
 160 };
 161
 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,
 168 };
 169
 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 */
 177 };
 178
 179 /* string IDs are assigned dynamically */
 180
 181 #define STRING_FUNC_IDX                 0
 182
 183 static struct usb_string midi_string_defs[] = {
 184         [STRING_FUNC_IDX].s = "MIDI function",
 185         {  } /* end of list */
 186 };
 187
 188 static struct usb_gadget_strings midi_stringtab = {
 189         .language       = 0x0409,       /* en-us */
 190         .strings        = midi_string_defs,
 191 };
 192
 193 static struct usb_gadget_strings *midi_strings[] = {
 194         &midi_stringtab,
 195         NULL,
 196 };
 197
 198 static inline struct usb_request *midi_alloc_ep_req(struct usb_ep *ep,
 199                                                     unsigned length)
 200 {
 201         return alloc_ep_req(ep, length, length);
 202 }
 203
 204 static void free_ep_req(struct usb_ep *ep, struct usb_request *req)
 205 {
 206         kfree(req->buf);
 207         usb_ep_free_request(ep, req);
 208 }
 209
 210 static const uint8_t f_midi_cin_length[] = {
 211         0, 0, 2, 3, 3, 1, 2, 3, 3, 3, 3, 3, 2, 2, 3, 1
 212 };
 213
 214 /*
 215  * Receives a chunk of MIDI data.
 216  */
 217 static void f_midi_read_data(struct usb_ep *ep, int cable,
 218                              uint8_t *data, int length)
 219 {
 220         struct f_midi *midi = ep->driver_data;
 221         struct snd_rawmidi_substream *substream = midi->out_substream[cable];
 222
 223         if (!substream)
 224                 /* Nobody is listening - throw it on the floor. */
 225                 return;
 226
 227         if (!test_bit(cable, &midi->out_triggered))
 228                 return;
 229
 230         snd_rawmidi_receive(substream, data, length);
 231 }
 232
 233 static void f_midi_handle_out_data(struct usb_ep *ep, struct usb_request *req)
 234 {
 235         unsigned int i;
 236         u8 *buf = req->buf;
 237
 238         for (i = 0; i + 3 < req->actual; i += 4)
 239                 if (buf[i] != 0) {
 240                         int cable = buf[i] >> 4;
 241                         int length = f_midi_cin_length[buf[i] & 0x0f];
 242                         f_midi_read_data(ep, cable, &buf[i + 1], length);
 243                 }
 244 }
 245
 246 static void
 247 f_midi_complete(struct usb_ep *ep, struct usb_request *req)
 248 {
 249         struct f_midi *midi = ep->driver_data;
 250         struct usb_composite_dev *cdev = midi->func.config->cdev;
 251         int status = req->status;
 252
 253         switch (status) {
 254         case 0:                  /* normal completion */
 255                 if (ep == midi->out_ep) {
 256                         /* We received stuff. req is queued again, below */
 257                         f_midi_handle_out_data(ep, req);
 258                 } else if (ep == midi->in_ep) {
 259                         /* Our transmit completed. See if there's more to go.
 260                          * f_midi_transmit eats req, don't queue it again. */
 261                         f_midi_transmit(midi, req);
 262                         return;
 263                 }
 264                 break;
 265
 266         /* this endpoint is normally active while we're configured */
 267         case -ECONNABORTED:     /* hardware forced ep reset */
 268         case -ECONNRESET:       /* request dequeued */
 269         case -ESHUTDOWN:        /* disconnect from host */
 270                 VDBG(cdev, "%s gone (%d), %d/%d\n", ep->name, status,
 271                                 req->actual, req->length);
 272                 if (ep == midi->out_ep)
 273                         f_midi_handle_out_data(ep, req);
 274
 275                 free_ep_req(ep, req);
 276                 return;
 277
 278         case -EOVERFLOW:        /* buffer overrun on read means that
 279                                  * we didn't provide a big enough buffer.
 280                                  */
 281         default:
 282                 DBG(cdev, "%s complete --> %d, %d/%d\n", ep->name,
 283                                 status, req->actual, req->length);
 284                 break;
 285         case -EREMOTEIO:        /* short read */
 286                 break;
 287         }
 288
 289         status = usb_ep_queue(ep, req, GFP_ATOMIC);
 290         if (status) {
 291                 ERROR(cdev, "kill %s:  resubmit %d bytes --> %d\n",
 292                                 ep->name, req->length, status);
 293                 usb_ep_set_halt(ep);
 294                 /* FIXME recover later ... somehow */
 295         }
 296 }
 297
 298 static int f_midi_start_ep(struct f_midi *midi,
 299                            struct usb_function *f,
 300                            struct usb_ep *ep)
 301 {
 302         int err;
 303         struct usb_composite_dev *cdev = f->config->cdev;
 304
 305         if (ep->driver_data)
 306                 usb_ep_disable(ep);
 307
 308         err = config_ep_by_speed(midi->gadget, f, ep);
 309         if (err) {
 310                 ERROR(cdev, "can't configure %s: %d\n", ep->name, err);
 311                 return err;
 312         }
 313
 314         err = usb_ep_enable(ep);
 315         if (err) {
 316                 ERROR(cdev, "can't start %s: %d\n", ep->name, err);
 317                 return err;
 318         }
 319
 320         ep->driver_data = midi;
 321
 322         return 0;
 323 }
 324
 325 static int f_midi_set_alt(struct usb_function *f, unsigned intf, unsigned alt)
 326 {
 327         struct f_midi *midi = func_to_midi(f);
 328         struct usb_composite_dev *cdev = f->config->cdev;
 329         unsigned i;
 330         int err;
 331
 332         /* For Control Device interface we do nothing */
 333         if (intf == 0)
 334                 return 0;
 335
 336         err = f_midi_start_ep(midi, f, midi->in_ep);
 337         if (err)
 338                 return err;
 339
 340         err = f_midi_start_ep(midi, f, midi->out_ep);
 341         if (err)
 342                 return err;
 343
 344         if (midi->out_ep->driver_data)
 345                 usb_ep_disable(midi->out_ep);
 346
 347         err = config_ep_by_speed(midi->gadget, f, midi->out_ep);
 348         if (err) {
 349                 ERROR(cdev, "can't configure %s: %d\n",
 350                       midi->out_ep->name, err);
 351                 return err;
 352         }
 353
 354         err = usb_ep_enable(midi->out_ep);
 355         if (err) {
 356                 ERROR(cdev, "can't start %s: %d\n",
 357                       midi->out_ep->name, err);
 358                 return err;
 359         }
 360
 361         midi->out_ep->driver_data = midi;
 362
 363         /* allocate a bunch of read buffers and queue them all at once. */
 364         for (i = 0; i < midi->qlen && err == 0; i++) {
 365                 struct usb_request *req =
 366                         midi_alloc_ep_req(midi->out_ep, midi->buflen);
 367                 if (req == NULL)
 368                         return -ENOMEM;
 369
 370                 req->complete = f_midi_complete;
 371                 err = usb_ep_queue(midi->out_ep, req, GFP_ATOMIC);
 372                 if (err) {
 373                         ERROR(midi, "%s queue req: %d\n",
 374                                     midi->out_ep->name, err);
 375                 }
 376         }
 377
 378         return 0;
 379 }
 380
 381 static void f_midi_disable(struct usb_function *f)
 382 {
 383         struct f_midi *midi = func_to_midi(f);
 384         struct usb_composite_dev *cdev = f->config->cdev;
 385
 386         DBG(cdev, "disable\n");
 387
 388         /*
 389          * just disable endpoints, forcing completion of pending i/o.
 390          * all our completion handlers free their requests in this case.
 391          */
 392         usb_ep_disable(midi->in_ep);
 393         usb_ep_disable(midi->out_ep);
 394 }
 395
 396 static int f_midi_snd_free(struct snd_device *device)
 397 {
 398         return 0;
 399 }
 400
 401 static void f_midi_transmit_packet(struct usb_request *req, uint8_t p0,
 402                                         uint8_t p1, uint8_t p2, uint8_t p3)
 403 {
 404         unsigned length = req->length;
 405         u8 *buf = (u8 *)req->buf + length;
 406
 407         buf[0] = p0;
 408         buf[1] = p1;
 409         buf[2] = p2;
 410         buf[3] = p3;
 411         req->length = length + 4;
 412 }
 413
 414 /*
 415  * Converts MIDI commands to USB MIDI packets.
 416  */
 417 static void f_midi_transmit_byte(struct usb_request *req,
 418                                  struct gmidi_in_port *port, uint8_t b)
 419 {
 420         uint8_t p0 = port->cable << 4;
 421
 422         if (b >= 0xf8) {
 423                 f_midi_transmit_packet(req, p0 | 0x0f, b, 0, 0);
 424         } else if (b >= 0xf0) {
 425                 switch (b) {
 426                 case 0xf0:
 427                         port->data[0] = b;
 428                         port->state = STATE_SYSEX_1;
 429                         break;
 430                 case 0xf1:
 431                 case 0xf3:
 432                         port->data[0] = b;
 433                         port->state = STATE_1PARAM;
 434                         break;
 435                 case 0xf2:
 436                         port->data[0] = b;
 437                         port->state = STATE_2PARAM_1;
 438                         break;
 439                 case 0xf4:
 440                 case 0xf5:
 441                         port->state = STATE_UNKNOWN;
 442                         break;
 443                 case 0xf6:
 444                         f_midi_transmit_packet(req, p0 | 0x05, 0xf6, 0, 0);
 445                         port->state = STATE_UNKNOWN;
 446                         break;
 447                 case 0xf7:
 448                         switch (port->state) {
 449                         case STATE_SYSEX_0:
 450                                 f_midi_transmit_packet(req,
 451                                         p0 | 0x05, 0xf7, 0, 0);
 452                                 break;
 453                         case STATE_SYSEX_1:
 454                                 f_midi_transmit_packet(req,
 455                                         p0 | 0x06, port->data[0], 0xf7, 0);
 456                                 break;
 457                         case STATE_SYSEX_2:
 458                                 f_midi_transmit_packet(req,
 459                                         p0 | 0x07, port->data[0],
 460                                         port->data[1], 0xf7);
 461                                 break;
 462                         }
 463                         port->state = STATE_UNKNOWN;
 464                         break;
 465                 }
 466         } else if (b >= 0x80) {
 467                 port->data[0] = b;
 468                 if (b >= 0xc0 && b <= 0xdf)
 469                         port->state = STATE_1PARAM;
 470                 else
 471                         port->state = STATE_2PARAM_1;
 472         } else { /* b < 0x80 */
 473                 switch (port->state) {
 474                 case STATE_1PARAM:
 475                         if (port->data[0] < 0xf0) {
 476                                 p0 |= port->data[0] >> 4;
 477                         } else {
 478                                 p0 |= 0x02;
 479                                 port->state = STATE_UNKNOWN;
 480                         }
 481                         f_midi_transmit_packet(req, p0, port->data[0], b, 0);
 482                         break;
 483                 case STATE_2PARAM_1:
 484                         port->data[1] = b;
 485                         port->state = STATE_2PARAM_2;
 486                         break;
 487                 case STATE_2PARAM_2:
 488                         if (port->data[0] < 0xf0) {
 489                                 p0 |= port->data[0] >> 4;
 490                                 port->state = STATE_2PARAM_1;
 491                         } else {
 492                                 p0 |= 0x03;
 493                                 port->state = STATE_UNKNOWN;
 494                         }
 495                         f_midi_transmit_packet(req,
 496                                 p0, port->data[0], port->data[1], b);
 497                         break;
 498                 case STATE_SYSEX_0:
 499                         port->data[0] = b;
 500                         port->state = STATE_SYSEX_1;
 501                         break;
 502                 case STATE_SYSEX_1:
 503                         port->data[1] = b;
 504                         port->state = STATE_SYSEX_2;
 505                         break;
 506                 case STATE_SYSEX_2:
 507                         f_midi_transmit_packet(req,
 508                                 p0 | 0x04, port->data[0], port->data[1], b);
 509                         port->state = STATE_SYSEX_0;
 510                         break;
 511                 }
 512         }
 513 }
 514
 515 static void f_midi_transmit(struct f_midi *midi, struct usb_request *req)
 516 {
 517         struct usb_ep *ep = midi->in_ep;
 518         int i;
 519
 520         if (!ep)
 521                 return;
 522
 523         if (!req)
 524                 req = midi_alloc_ep_req(ep, midi->buflen);
 525
 526         if (!req) {
 527                 ERROR(midi, "%s: alloc_ep_request failed\n", __func__);
 528                 return;
 529         }
 530         req->length = 0;
 531         req->complete = f_midi_complete;
 532
 533         for (i = 0; i < MAX_PORTS; i++) {
 534                 struct gmidi_in_port *port = midi->in_port[i];
 535                 struct snd_rawmidi_substream *substream = midi->in_substream[i];
 536
 537                 if (!port || !port->active || !substream)
 538                         continue;
 539
 540                 while (req->length + 3 < midi->buflen) {
 541                         uint8_t b;
 542                         if (snd_rawmidi_transmit(substream, &b, 1) != 1) {
 543                                 port->active = 0;
 544                                 break;
 545                         }
 546                         f_midi_transmit_byte(req, port, b);
 547                 }
 548         }
 549
 550         if (req->length > 0) {
 551                 int err;
 552
 553                 err = usb_ep_queue(ep, req, GFP_ATOMIC);
 554                 if (err < 0)
 555                         ERROR(midi, "%s queue req: %d\n",
 556                               midi->in_ep->name, err);
 557         } else {
 558                 free_ep_req(ep, req);
 559         }
 560 }
 561
 562 static void f_midi_in_tasklet(unsigned long data)
 563 {
 564         struct f_midi *midi = (struct f_midi *) data;
 565         f_midi_transmit(midi, NULL);
 566 }
 567
 568 static int f_midi_in_open(struct snd_rawmidi_substream *substream)
 569 {
 570         struct f_midi *midi = substream->rmidi->private_data;
 571
 572         if (!midi->in_port[substream->number])
 573                 return -EINVAL;
 574
 575         VDBG(midi, "%s()\n", __func__);
 576         midi->in_substream[substream->number] = substream;
 577         midi->in_port[substream->number]->state = STATE_UNKNOWN;
 578         return 0;
 579 }
 580
 581 static int f_midi_in_close(struct snd_rawmidi_substream *substream)
 582 {
 583         struct f_midi *midi = substream->rmidi->private_data;
 584
 585         VDBG(midi, "%s()\n", __func__);
 586         return 0;
 587 }
 588
 589 static void f_midi_in_trigger(struct snd_rawmidi_substream *substream, int up)
 590 {
 591         struct f_midi *midi = substream->rmidi->private_data;
 592
 593         if (!midi->in_port[substream->number])
 594                 return;
 595
 596         VDBG(midi, "%s() %d\n", __func__, up);
 597         midi->in_port[substream->number]->active = up;
 598         if (up)
 599                 tasklet_hi_schedule(&midi->tasklet);
 600 }
 601
 602 static int f_midi_out_open(struct snd_rawmidi_substream *substream)
 603 {
 604         struct f_midi *midi = substream->rmidi->private_data;
 605
 606         if (substream->number >= MAX_PORTS)
 607                 return -EINVAL;
 608
 609         VDBG(midi, "%s()\n", __func__);
 610         midi->out_substream[substream->number] = substream;
 611         return 0;
 612 }
 613
 614 static int f_midi_out_close(struct snd_rawmidi_substream *substream)
 615 {
 616         struct f_midi *midi = substream->rmidi->private_data;
 617
 618         VDBG(midi, "%s()\n", __func__);
 619         return 0;
 620 }
 621
 622 static void f_midi_out_trigger(struct snd_rawmidi_substream *substream, int up)
 623 {
 624         struct f_midi *midi = substream->rmidi->private_data;
 625
 626         VDBG(midi, "%s()\n", __func__);
 627
 628         if (up)
 629                 set_bit(substream->number, &midi->out_triggered);
 630         else
 631                 clear_bit(substream->number, &midi->out_triggered);
 632 }
 633
 634 static struct snd_rawmidi_ops gmidi_in_ops = {
 635         .open = f_midi_in_open,
 636         .close = f_midi_in_close,
 637         .trigger = f_midi_in_trigger,
 638 };
 639
 640 static struct snd_rawmidi_ops gmidi_out_ops = {
 641         .open = f_midi_out_open,
 642         .close = f_midi_out_close,
 643         .trigger = f_midi_out_trigger
 644 };
 645
 646 static inline void f_midi_unregister_card(struct f_midi *midi)
 647 {
 648         if (midi->card) {
 649                 snd_card_free(midi->card);
 650                 midi->card = NULL;
 651         }
 652 }
 653
 654 /* register as a sound "card" */
 655 static int f_midi_register_card(struct f_midi *midi)
 656 {
 657         struct snd_card *card;
 658         struct snd_rawmidi *rmidi;
 659         int err;
 660         static struct snd_device_ops ops = {
 661                 .dev_free = f_midi_snd_free,
 662         };
 663
 664         err = snd_card_new(&midi->gadget->dev, midi->index, midi->id,
 665                            THIS_MODULE, 0, &card);
 666         if (err < 0) {
 667                 ERROR(midi, "snd_card_new() failed\n");
 668                 goto fail;
 669         }
 670         midi->card = card;
 671
 672         err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, midi, &ops);
 673         if (err < 0) {
 674                 ERROR(midi, "snd_device_new() failed: error %d\n", err);
 675                 goto fail;
 676         }
 677
 678         strcpy(card->driver, f_midi_longname);
 679         strcpy(card->longname, f_midi_longname);
 680         strcpy(card->shortname, f_midi_shortname);
 681
 682         /* Set up rawmidi */
 683         snd_component_add(card, "MIDI");
 684         err = snd_rawmidi_new(card, card->longname, 0,
 685                               midi->out_ports, midi->in_ports, &rmidi);
 686         if (err < 0) {
 687                 ERROR(midi, "snd_rawmidi_new() failed: error %d\n", err);
 688                 goto fail;
 689         }
 690         midi->rmidi = rmidi;
 691         strcpy(rmidi->name, card->shortname);
 692         rmidi->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT |
 693                             SNDRV_RAWMIDI_INFO_INPUT |
 694                             SNDRV_RAWMIDI_INFO_DUPLEX;
 695         rmidi->private_data = midi;
 696
 697         /*
 698          * Yes, rawmidi OUTPUT = USB IN, and rawmidi INPUT = USB OUT.
 699          * It's an upside-down world being a gadget.
 700          */
 701         snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &gmidi_in_ops);
 702         snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &gmidi_out_ops);
 703
 704         /* register it - we're ready to go */
 705         err = snd_card_register(card);
 706         if (err < 0) {
 707                 ERROR(midi, "snd_card_register() failed\n");
 708                 goto fail;
 709         }
 710
 711         VDBG(midi, "%s() finished ok\n", __func__);
 712         return 0;
 713
 714 fail:
 715         f_midi_unregister_card(midi);
 716         return err;
 717 }
 718
 719 /* MIDI function driver setup/binding */
 720
 721 static int f_midi_bind(struct usb_configuration *c, struct usb_function *f)
 722 {
 723         struct usb_descriptor_header **midi_function;
 724         struct usb_midi_in_jack_descriptor jack_in_ext_desc[MAX_PORTS];
 725         struct usb_midi_in_jack_descriptor jack_in_emb_desc[MAX_PORTS];
 726         struct usb_midi_out_jack_descriptor_1 jack_out_ext_desc[MAX_PORTS];
 727         struct usb_midi_out_jack_descriptor_1 jack_out_emb_desc[MAX_PORTS];
 728         struct usb_composite_dev *cdev = c->cdev;
 729         struct f_midi *midi = func_to_midi(f);
 730         struct usb_string *us;
 731         int status, n, jack = 1, i = 0;
 732
 733         midi->gadget = cdev->gadget;
 734         tasklet_init(&midi->tasklet, f_midi_in_tasklet, (unsigned long) midi);
 735         status = f_midi_register_card(midi);
 736         if (status < 0)
 737                 goto fail_register;
 738
 739         /* maybe allocate device-global string ID */
 740         us = usb_gstrings_attach(c->cdev, midi_strings,
 741                                  ARRAY_SIZE(midi_string_defs));
 742         if (IS_ERR(us)) {
 743                 status = PTR_ERR(us);
 744                 goto fail;
 745         }
 746         ac_interface_desc.iInterface = us[STRING_FUNC_IDX].id;
 747
 748         /* We have two interfaces, AudioControl and MIDIStreaming */
 749         status = usb_interface_id(c, f);
 750         if (status < 0)
 751                 goto fail;
 752         ac_interface_desc.bInterfaceNumber = status;
 753
 754         status = usb_interface_id(c, f);
 755         if (status < 0)
 756                 goto fail;
 757         ms_interface_desc.bInterfaceNumber = status;
 758         ac_header_desc.baInterfaceNr[0] = status;
 759
 760         status = -ENODEV;
 761
 762         /* allocate instance-specific endpoints */
 763         midi->in_ep = usb_ep_autoconfig(cdev->gadget, &bulk_in_desc);
 764         if (!midi->in_ep)
 765                 goto fail;
 766         midi->in_ep->driver_data = cdev;        /* claim */
 767
 768         midi->out_ep = usb_ep_autoconfig(cdev->gadget, &bulk_out_desc);
 769         if (!midi->out_ep)
 770                 goto fail;
 771         midi->out_ep->driver_data = cdev;       /* claim */
 772
 773         /* allocate temporary function list */
 774         midi_function = kcalloc((MAX_PORTS * 4) + 9, sizeof(*midi_function),
 775                                 GFP_KERNEL);
 776         if (!midi_function) {
 777                 status = -ENOMEM;
 778                 goto fail;
 779         }
 780
 781         /*
 782          * construct the function's descriptor set. As the number of
 783          * input and output MIDI ports is configurable, we have to do
 784          * it that way.
 785          */
 786
 787         /* add the headers - these are always the same */
 788         midi_function[i++] = (struct usb_descriptor_header *) &ac_interface_desc;
 789         midi_function[i++] = (struct usb_descriptor_header *) &ac_header_desc;
 790         midi_function[i++] = (struct usb_descriptor_header *) &ms_interface_desc;
 791
 792         /* calculate the header's wTotalLength */
 793         n = USB_DT_MS_HEADER_SIZE
 794                 + (midi->in_ports + midi->out_ports) *
 795                         (USB_DT_MIDI_IN_SIZE + USB_DT_MIDI_OUT_SIZE(1));
 796         ms_header_desc.wTotalLength = cpu_to_le16(n);
 797
 798         midi_function[i++] = (struct usb_descriptor_header *) &ms_header_desc;
 799
 800         /* configure the external IN jacks, each linked to an embedded OUT jack */
 801         for (n = 0; n < midi->in_ports; n++) {
 802                 struct usb_midi_in_jack_descriptor *in_ext = &jack_in_ext_desc[n];
 803                 struct usb_midi_out_jack_descriptor_1 *out_emb = &jack_out_emb_desc[n];
 804
 805                 in_ext->bLength                 = USB_DT_MIDI_IN_SIZE;
 806                 in_ext->bDescriptorType         = USB_DT_CS_INTERFACE;
 807                 in_ext->bDescriptorSubtype      = USB_MS_MIDI_IN_JACK;
 808                 in_ext->bJackType               = USB_MS_EXTERNAL;
 809                 in_ext->bJackID                 = jack++;
 810                 in_ext->iJack                   = 0;
 811                 midi_function[i++] = (struct usb_descriptor_header *) in_ext;
 812
 813                 out_emb->bLength                = USB_DT_MIDI_OUT_SIZE(1);
 814                 out_emb->bDescriptorType        = USB_DT_CS_INTERFACE;
 815                 out_emb->bDescriptorSubtype     = USB_MS_MIDI_OUT_JACK;
 816                 out_emb->bJackType              = USB_MS_EMBEDDED;
 817                 out_emb->bJackID                = jack++;
 818                 out_emb->bNrInputPins           = 1;
 819                 out_emb->pins[0].baSourcePin    = 1;
 820                 out_emb->pins[0].baSourceID     = in_ext->bJackID;
 821                 out_emb->iJack                  = 0;
 822                 midi_function[i++] = (struct usb_descriptor_header *) out_emb;
 823
 824                 /* link it to the endpoint */
 825                 ms_in_desc.baAssocJackID[n] = out_emb->bJackID;
 826         }
 827
 828         /* configure the external OUT jacks, each linked to an embedded IN jack */
 829         for (n = 0; n < midi->out_ports; n++) {
 830                 struct usb_midi_in_jack_descriptor *in_emb = &jack_in_emb_desc[n];
 831                 struct usb_midi_out_jack_descriptor_1 *out_ext = &jack_out_ext_desc[n];
 832
 833                 in_emb->bLength                 = USB_DT_MIDI_IN_SIZE;
 834                 in_emb->bDescriptorType         = USB_DT_CS_INTERFACE;
 835                 in_emb->bDescriptorSubtype      = USB_MS_MIDI_IN_JACK;
 836                 in_emb->bJackType               = USB_MS_EMBEDDED;
 837                 in_emb->bJackID                 = jack++;
 838                 in_emb->iJack                   = 0;
 839                 midi_function[i++] = (struct usb_descriptor_header *) in_emb;
 840
 841                 out_ext->bLength =              USB_DT_MIDI_OUT_SIZE(1);
 842                 out_ext->bDescriptorType =      USB_DT_CS_INTERFACE;
 843                 out_ext->bDescriptorSubtype =   USB_MS_MIDI_OUT_JACK;
 844                 out_ext->bJackType =            USB_MS_EXTERNAL;
 845                 out_ext->bJackID =              jack++;
 846                 out_ext->bNrInputPins =         1;
 847                 out_ext->iJack =                0;
 848                 out_ext->pins[0].baSourceID =   in_emb->bJackID;
 849                 out_ext->pins[0].baSourcePin =  1;
 850                 midi_function[i++] = (struct usb_descriptor_header *) out_ext;
 851
 852                 /* link it to the endpoint */
 853                 ms_out_desc.baAssocJackID[n] = in_emb->bJackID;
 854         }
 855
 856         /* configure the endpoint descriptors ... */
 857         ms_out_desc.bLength = USB_DT_MS_ENDPOINT_SIZE(midi->in_ports);
 858         ms_out_desc.bNumEmbMIDIJack = midi->in_ports;
 859
 860         ms_in_desc.bLength = USB_DT_MS_ENDPOINT_SIZE(midi->out_ports);
 861         ms_in_desc.bNumEmbMIDIJack = midi->out_ports;
 862
 863         /* ... and add them to the list */
 864         midi_function[i++] = (struct usb_descriptor_header *) &bulk_out_desc;
 865         midi_function[i++] = (struct usb_descriptor_header *) &ms_out_desc;
 866         midi_function[i++] = (struct usb_descriptor_header *) &bulk_in_desc;
 867         midi_function[i++] = (struct usb_descriptor_header *) &ms_in_desc;
 868         midi_function[i++] = NULL;
 869
 870         /*
 871          * support all relevant hardware speeds... we expect that when
 872          * hardware is dual speed, all bulk-capable endpoints work at
 873          * both speeds
 874          */
 875         /* copy descriptors, and track endpoint copies */
 876         f->fs_descriptors = usb_copy_descriptors(midi_function);
 877         if (!f->fs_descriptors)
 878                 goto fail_f_midi;
 879
 880         if (gadget_is_dualspeed(c->cdev->gadget)) {
 881                 bulk_in_desc.wMaxPacketSize = cpu_to_le16(512);
 882                 bulk_out_desc.wMaxPacketSize = cpu_to_le16(512);
 883                 f->hs_descriptors = usb_copy_descriptors(midi_function);
 884                 if (!f->hs_descriptors)
 885                         goto fail_f_midi;
 886         }
 887
 888         kfree(midi_function);
 889
 890         return 0;
 891
 892 fail_f_midi:
 893         kfree(midi_function);
 894         usb_free_descriptors(f->hs_descriptors);
 895 fail:
 896         f_midi_unregister_card(midi);
 897 fail_register:
 898         /* we might as well release our claims on endpoints */
 899         if (midi->out_ep)
 900                 midi->out_ep->driver_data = NULL;
 901         if (midi->in_ep)
 902                 midi->in_ep->driver_data = NULL;
 903
 904         ERROR(cdev, "%s: can't bind, err %d\n", f->name, status);
 905
 906         return status;
 907 }
 908
 909 static inline struct f_midi_opts *to_f_midi_opts(struct config_item *item)
 910 {
 911         return container_of(to_config_group(item), struct f_midi_opts,
 912                             func_inst.group);
 913 }
 914
 915 CONFIGFS_ATTR_STRUCT(f_midi_opts);
 916 CONFIGFS_ATTR_OPS(f_midi_opts);
 917
 918 static void midi_attr_release(struct config_item *item)
 919 {
 920         struct f_midi_opts *opts = to_f_midi_opts(item);
 921
 922         usb_put_function_instance(&opts->func_inst);
 923 }
 924
 925 static struct configfs_item_operations midi_item_ops = {
 926         .release        = midi_attr_release,
 927         .show_attribute = f_midi_opts_attr_show,
 928         .store_attribute = f_midi_opts_attr_store,
 929 };
 930
 931 #define F_MIDI_OPT(name, test_limit, limit)                             \
 932 static ssize_t f_midi_opts_##name##_show(struct f_midi_opts *opts, char *page) \
 933 {                                                                       \
 934         int result;                                                     \
 935                                                                         \
 936         mutex_lock(&opts->lock);                                        \
 937         result = sprintf(page, "%d\n", opts->name);                     \
 938         mutex_unlock(&opts->lock);                                      \
 939                                                                         \
 940         return result;                                                  \
 941 }                                                                       \
 942                                                                         \
 943 static ssize_t f_midi_opts_##name##_store(struct f_midi_opts *opts,     \
 944                                          const char *page, size_t len)  \
 945 {                                                                       \
 946         int ret;                                                        \
 947         u32 num;                                                        \
 948                                                                         \
 949         mutex_lock(&opts->lock);                                        \
 950         if (opts->refcnt) {                                             \
 951                 ret = -EBUSY;                                           \
 952                 goto end;                                               \
 953         }                                                               \
 954                                                                         \
 955         ret = kstrtou32(page, 0, &num);                                 \
 956         if (ret)                                                        \
 957                 goto end;                                               \
 958                                                                         \
 959         if (test_limit && num > limit) {                                \
 960                 ret = -EINVAL;                                          \
 961                 goto end;                                               \
 962         }                                                               \
 963         opts->name = num;                                               \
 964         ret = len;                                                      \
 965                                                                         \
 966 end:                                                                    \
 967         mutex_unlock(&opts->lock);                                      \
 968         return ret;                                                     \
 969 }                                                                       \
 970                                                                         \
 971 static struct f_midi_opts_attribute f_midi_opts_##name =                \
 972         __CONFIGFS_ATTR(name, S_IRUGO | S_IWUSR, f_midi_opts_##name##_show, \
 973                         f_midi_opts_##name##_store)
 974
 975 F_MIDI_OPT(index, true, SNDRV_CARDS);
 976 F_MIDI_OPT(buflen, false, 0);
 977 F_MIDI_OPT(qlen, false, 0);
 978 F_MIDI_OPT(in_ports, true, MAX_PORTS);
 979 F_MIDI_OPT(out_ports, true, MAX_PORTS);
 980
 981 static ssize_t f_midi_opts_id_show(struct f_midi_opts *opts, char *page)
 982 {
 983         int result;
 984
 985         mutex_lock(&opts->lock);
 986         if (opts->id) {
 987                 result = strlcpy(page, opts->id, PAGE_SIZE);
 988         } else {
 989                 page[0] = 0;
 990                 result = 0;
 991         }
 992
 993         mutex_unlock(&opts->lock);
 994
 995         return result;
 996 }
 997
 998 static ssize_t f_midi_opts_id_store(struct f_midi_opts *opts,
 999                                     const char *page, size_t len)
1000 {
1001         int ret;
1002         char *c;
1003
1004         mutex_lock(&opts->lock);
1005         if (opts->refcnt) {
1006                 ret = -EBUSY;
1007                 goto end;
1008         }
1009
1010         c = kstrndup(page, len, GFP_KERNEL);
1011         if (!c) {
1012                 ret = -ENOMEM;
1013                 goto end;
1014         }
1015         if (opts->id_allocated)
1016                 kfree(opts->id);
1017         opts->id = c;
1018         opts->id_allocated = true;
1019         ret = len;
1020 end:
1021         mutex_unlock(&opts->lock);
1022         return ret;
1023 }
1024
1025 static struct f_midi_opts_attribute f_midi_opts_id =
1026         __CONFIGFS_ATTR(id, S_IRUGO | S_IWUSR, f_midi_opts_id_show,
1027                         f_midi_opts_id_store);
1028
1029 static struct configfs_attribute *midi_attrs[] = {
1030         &f_midi_opts_index.attr,
1031         &f_midi_opts_buflen.attr,
1032         &f_midi_opts_qlen.attr,
1033         &f_midi_opts_in_ports.attr,
1034         &f_midi_opts_out_ports.attr,
1035         &f_midi_opts_id.attr,
1036         NULL,
1037 };
1038
1039 static struct config_item_type midi_func_type = {
1040         .ct_item_ops    = &midi_item_ops,
1041         .ct_attrs       = midi_attrs,
1042         .ct_owner       = THIS_MODULE,
1043 };
1044
1045 static void f_midi_free_inst(struct usb_function_instance *f)
1046 {
1047         struct f_midi_opts *opts;
1048
1049         opts = container_of(f, struct f_midi_opts, func_inst);
1050
1051         if (opts->id_allocated)
1052                 kfree(opts->id);
1053
1054         kfree(opts);
1055 }
1056
1057 static struct usb_function_instance *f_midi_alloc_inst(void)
1058 {
1059         struct f_midi_opts *opts;
1060
1061         opts = kzalloc(sizeof(*opts), GFP_KERNEL);
1062         if (!opts)
1063                 return ERR_PTR(-ENOMEM);
1064
1065         mutex_init(&opts->lock);
1066         opts->func_inst.free_func_inst = f_midi_free_inst;
1067         opts->index = SNDRV_DEFAULT_IDX1;
1068         opts->id = SNDRV_DEFAULT_STR1;
1069         opts->buflen = 256;
1070         opts->qlen = 32;
1071         opts->in_ports = 1;
1072         opts->out_ports = 1;
1073
1074         config_group_init_type_name(&opts->func_inst.group, "",
1075                                     &midi_func_type);
1076
1077         return &opts->func_inst;
1078 }
1079
1080 static void f_midi_free(struct usb_function *f)
1081 {
1082         struct f_midi *midi;
1083         struct f_midi_opts *opts;
1084         int i;
1085
1086         midi = func_to_midi(f);
1087         opts = container_of(f->fi, struct f_midi_opts, func_inst);
1088         kfree(midi->id);
1089         mutex_lock(&opts->lock);
1090         for (i = opts->in_ports - 1; i >= 0; --i)
1091                 kfree(midi->in_port[i]);
1092         kfree(midi);
1093         --opts->refcnt;
1094         mutex_unlock(&opts->lock);
1095 }
1096
1097 static void f_midi_unbind(struct usb_configuration *c, struct usb_function *f)
1098 {
1099         struct usb_composite_dev *cdev = f->config->cdev;
1100         struct f_midi *midi = func_to_midi(f);
1101         struct snd_card *card;
1102
1103         DBG(cdev, "unbind\n");
1104
1105         /* just to be sure */
1106         f_midi_disable(f);
1107
1108         card = midi->card;
1109         midi->card = NULL;
1110         if (card)
1111                 snd_card_free(card);
1112
1113         usb_free_all_descriptors(f);
1114 }
1115
1116 static struct usb_function *f_midi_alloc(struct usb_function_instance *fi)
1117 {
1118         struct f_midi *midi;
1119         struct f_midi_opts *opts;
1120         int status, i;
1121
1122         opts = container_of(fi, struct f_midi_opts, func_inst);
1123
1124         mutex_lock(&opts->lock);
1125         /* sanity check */
1126         if (opts->in_ports > MAX_PORTS || opts->out_ports > MAX_PORTS) {
1127                 mutex_unlock(&opts->lock);
1128                 return ERR_PTR(-EINVAL);
1129         }
1130
1131         /* allocate and initialize one new instance */
1132         midi = kzalloc(sizeof(*midi), GFP_KERNEL);
1133         if (!midi) {
1134                 mutex_unlock(&opts->lock);
1135                 return ERR_PTR(-ENOMEM);
1136         }
1137
1138         for (i = 0; i < opts->in_ports; i++) {
1139                 struct gmidi_in_port *port = kzalloc(sizeof(*port), GFP_KERNEL);
1140
1141                 if (!port) {
1142                         status = -ENOMEM;
1143                         mutex_unlock(&opts->lock);
1144                         goto setup_fail;
1145                 }
1146
1147                 port->midi = midi;
1148                 port->active = 0;
1149                 port->cable = i;
1150                 midi->in_port[i] = port;
1151         }
1152
1153         /* set up ALSA midi devices */
1154         midi->id = kstrdup(opts->id, GFP_KERNEL);
1155         if (opts->id && !midi->id) {
1156                 status = -ENOMEM;
1157                 mutex_unlock(&opts->lock);
1158                 goto setup_fail;
1159         }
1160         midi->in_ports = opts->in_ports;
1161         midi->out_ports = opts->out_ports;
1162         midi->index = opts->index;
1163         midi->buflen = opts->buflen;
1164         midi->qlen = opts->qlen;
1165         ++opts->refcnt;
1166         mutex_unlock(&opts->lock);
1167
1168         midi->func.name         = "gmidi function";
1169         midi->func.bind         = f_midi_bind;
1170         midi->func.unbind       = f_midi_unbind;
1171         midi->func.set_alt      = f_midi_set_alt;
1172         midi->func.disable      = f_midi_disable;
1173         midi->func.free_func    = f_midi_free;
1174
1175         return &midi->func;
1176
1177 setup_fail:
1178         for (--i; i >= 0; i--)
1179                 kfree(midi->in_port[i]);
1180         kfree(midi);
1181         return ERR_PTR(status);
1182 }
1183
1184 DECLARE_USB_FUNCTION_INIT(midi, f_midi_alloc_inst, f_midi_alloc);