gmidi.c 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. /*
  2. * gmidi.c -- USB MIDI Gadget Driver
  3. *
  4. * Copyright (C) 2006 Thumtronics Pty Ltd.
  5. * Developed for Thumtronics by Grey Innovation
  6. * Ben Williamson <ben.williamson@greyinnovation.com>
  7. *
  8. * This software is distributed under the terms of the GNU General Public
  9. * License ("GPL") version 2, as published by the Free Software Foundation.
  10. *
  11. * This code is based in part on:
  12. *
  13. * Gadget Zero driver, Copyright (C) 2003-2004 David Brownell.
  14. * USB Audio driver, Copyright (C) 2002 by Takashi Iwai.
  15. * USB MIDI driver, Copyright (C) 2002-2005 Clemens Ladisch.
  16. *
  17. * Refer to the USB Device Class Definition for MIDI Devices:
  18. * http://www.usb.org/developers/devclass_docs/midi10.pdf
  19. */
  20. /* #define VERBOSE_DEBUG */
  21. #include <linux/kernel.h>
  22. #include <linux/slab.h>
  23. #include <linux/module.h>
  24. #include <linux/device.h>
  25. #include <sound/core.h>
  26. #include <sound/initval.h>
  27. #include <sound/rawmidi.h>
  28. #include <linux/usb/ch9.h>
  29. #include <linux/usb/composite.h>
  30. #include <linux/usb/gadget.h>
  31. #include <linux/usb/audio.h>
  32. #include <linux/usb/midi.h>
  33. #include "u_midi.h"
  34. /*-------------------------------------------------------------------------*/
  35. MODULE_AUTHOR("Ben Williamson");
  36. MODULE_LICENSE("GPL v2");
  37. static const char shortname[] = "g_midi";
  38. static const char longname[] = "MIDI Gadget";
  39. USB_GADGET_COMPOSITE_OPTIONS();
  40. static int index = SNDRV_DEFAULT_IDX1;
  41. module_param(index, int, S_IRUGO);
  42. MODULE_PARM_DESC(index, "Index value for the USB MIDI Gadget adapter.");
  43. static char *id = SNDRV_DEFAULT_STR1;
  44. module_param(id, charp, S_IRUGO);
  45. MODULE_PARM_DESC(id, "ID string for the USB MIDI Gadget adapter.");
  46. static unsigned int buflen = 256;
  47. module_param(buflen, uint, S_IRUGO);
  48. MODULE_PARM_DESC(buflen, "MIDI buffer length");
  49. static unsigned int qlen = 32;
  50. module_param(qlen, uint, S_IRUGO);
  51. MODULE_PARM_DESC(qlen, "USB read request queue length");
  52. static unsigned int in_ports = 1;
  53. module_param(in_ports, uint, S_IRUGO);
  54. MODULE_PARM_DESC(in_ports, "Number of MIDI input ports");
  55. static unsigned int out_ports = 1;
  56. module_param(out_ports, uint, S_IRUGO);
  57. MODULE_PARM_DESC(out_ports, "Number of MIDI output ports");
  58. /* Thanks to Grey Innovation for donating this product ID.
  59. *
  60. * DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
  61. * Instead: allocate your own, using normal USB-IF procedures.
  62. */
  63. #define DRIVER_VENDOR_NUM 0x17b3 /* Grey Innovation */
  64. #define DRIVER_PRODUCT_NUM 0x0004 /* Linux-USB "MIDI Gadget" */
  65. /* string IDs are assigned dynamically */
  66. #define STRING_DESCRIPTION_IDX USB_GADGET_FIRST_AVAIL_IDX
  67. static struct usb_device_descriptor device_desc = {
  68. .bLength = USB_DT_DEVICE_SIZE,
  69. .bDescriptorType = USB_DT_DEVICE,
  70. .bcdUSB = cpu_to_le16(0x0200),
  71. .bDeviceClass = USB_CLASS_PER_INTERFACE,
  72. .idVendor = cpu_to_le16(DRIVER_VENDOR_NUM),
  73. .idProduct = cpu_to_le16(DRIVER_PRODUCT_NUM),
  74. /* .iManufacturer = DYNAMIC */
  75. /* .iProduct = DYNAMIC */
  76. .bNumConfigurations = 1,
  77. };
  78. static struct usb_string strings_dev[] = {
  79. [USB_GADGET_MANUFACTURER_IDX].s = "Grey Innovation",
  80. [USB_GADGET_PRODUCT_IDX].s = "MIDI Gadget",
  81. [USB_GADGET_SERIAL_IDX].s = "",
  82. [STRING_DESCRIPTION_IDX].s = "MIDI",
  83. { } /* end of list */
  84. };
  85. static struct usb_gadget_strings stringtab_dev = {
  86. .language = 0x0409, /* en-us */
  87. .strings = strings_dev,
  88. };
  89. static struct usb_gadget_strings *dev_strings[] = {
  90. &stringtab_dev,
  91. NULL,
  92. };
  93. static struct usb_function_instance *fi_midi;
  94. static struct usb_function *f_midi;
  95. static int midi_unbind(struct usb_composite_dev *dev)
  96. {
  97. usb_put_function(f_midi);
  98. usb_put_function_instance(fi_midi);
  99. return 0;
  100. }
  101. static struct usb_configuration midi_config = {
  102. .label = "MIDI Gadget",
  103. .bConfigurationValue = 1,
  104. /* .iConfiguration = DYNAMIC */
  105. .bmAttributes = USB_CONFIG_ATT_ONE,
  106. .MaxPower = CONFIG_USB_GADGET_VBUS_DRAW,
  107. };
  108. static int midi_bind_config(struct usb_configuration *c)
  109. {
  110. int status;
  111. f_midi = usb_get_function(fi_midi);
  112. if (IS_ERR(f_midi))
  113. return PTR_ERR(f_midi);
  114. status = usb_add_function(c, f_midi);
  115. if (status < 0) {
  116. usb_put_function(f_midi);
  117. return status;
  118. }
  119. return 0;
  120. }
  121. static int midi_bind(struct usb_composite_dev *cdev)
  122. {
  123. struct f_midi_opts *midi_opts;
  124. int status;
  125. fi_midi = usb_get_function_instance("midi");
  126. if (IS_ERR(fi_midi))
  127. return PTR_ERR(fi_midi);
  128. midi_opts = container_of(fi_midi, struct f_midi_opts, func_inst);
  129. midi_opts->index = index;
  130. midi_opts->id = id;
  131. midi_opts->in_ports = in_ports;
  132. midi_opts->out_ports = out_ports;
  133. midi_opts->buflen = buflen;
  134. midi_opts->qlen = qlen;
  135. status = usb_string_ids_tab(cdev, strings_dev);
  136. if (status < 0)
  137. goto put;
  138. device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id;
  139. device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
  140. midi_config.iConfiguration = strings_dev[STRING_DESCRIPTION_IDX].id;
  141. status = usb_add_config(cdev, &midi_config, midi_bind_config);
  142. if (status < 0)
  143. goto put;
  144. usb_composite_overwrite_options(cdev, &coverwrite);
  145. pr_info("%s\n", longname);
  146. return 0;
  147. put:
  148. usb_put_function_instance(fi_midi);
  149. return status;
  150. }
  151. static struct usb_composite_driver midi_driver = {
  152. .name = (char *) longname,
  153. .dev = &device_desc,
  154. .strings = dev_strings,
  155. .max_speed = USB_SPEED_HIGH,
  156. .bind = midi_bind,
  157. .unbind = midi_unbind,
  158. };
  159. module_usb_composite_driver(midi_driver);