mass_storage.c 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191
  1. /*
  2. * mass_storage.c -- Mass Storage USB Gadget
  3. *
  4. * Copyright (C) 2003-2008 Alan Stern
  5. * Copyright (C) 2009 Samsung Electronics
  6. * Author: Michal Nazarewicz <m.nazarewicz@samsung.com>
  7. * All rights reserved.
  8. *
  9. * This program is free software; you can redistribute it and/or modify
  10. * it under the terms of the GNU General Public License as published by
  11. * the Free Software Foundation; either version 2 of the License, or
  12. * (at your option) any later version.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU General Public License
  20. * along with this program; if not, write to the Free Software
  21. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  22. */
  23. /*
  24. * The Mass Storage Gadget acts as a USB Mass Storage device,
  25. * appearing to the host as a disk drive or as a CD-ROM drive. In
  26. * addition to providing an example of a genuinely useful gadget
  27. * driver for a USB device, it also illustrates a technique of
  28. * double-buffering for increased throughput. Last but not least, it
  29. * gives an easy way to probe the behavior of the Mass Storage drivers
  30. * in a USB host.
  31. *
  32. * Since this file serves only administrative purposes and all the
  33. * business logic is implemented in f_mass_storage.* file. Read
  34. * comments in this file for more detailed description.
  35. */
  36. #include <linux/kernel.h>
  37. #include <linux/utsname.h>
  38. #include <linux/usb/ch9.h>
  39. /*-------------------------------------------------------------------------*/
  40. #define DRIVER_DESC "Mass Storage Gadget"
  41. #define DRIVER_VERSION "2009/09/11"
  42. /*-------------------------------------------------------------------------*/
  43. /*
  44. * kbuild is not very cooperative with respect to linking separately
  45. * compiled library objects into one module. So for now we won't use
  46. * separate compilation ... ensuring init/exit sections work to shrink
  47. * the runtime footprint, and giving us at least some parts of what
  48. * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
  49. */
  50. #include "composite.c"
  51. #include "usbstring.c"
  52. #include "config.c"
  53. #include "epautoconf.c"
  54. #include "f_mass_storage.c"
  55. /*-------------------------------------------------------------------------*/
  56. static struct usb_device_descriptor msg_device_desc = {
  57. .bLength = sizeof msg_device_desc,
  58. .bDescriptorType = USB_DT_DEVICE,
  59. .bcdUSB = cpu_to_le16(0x0200),
  60. .bDeviceClass = USB_CLASS_PER_INTERFACE,
  61. /* Vendor and product id can be overridden by module parameters. */
  62. .idVendor = cpu_to_le16(FSG_VENDOR_ID),
  63. .idProduct = cpu_to_le16(FSG_PRODUCT_ID),
  64. .bNumConfigurations = 1,
  65. };
  66. static struct usb_otg_descriptor otg_descriptor = {
  67. .bLength = sizeof otg_descriptor,
  68. .bDescriptorType = USB_DT_OTG,
  69. /*
  70. * REVISIT SRP-only hardware is possible, although
  71. * it would not be called "OTG" ...
  72. */
  73. .bmAttributes = USB_OTG_SRP | USB_OTG_HNP,
  74. };
  75. static const struct usb_descriptor_header *otg_desc[] = {
  76. (struct usb_descriptor_header *) &otg_descriptor,
  77. NULL,
  78. };
  79. /****************************** Configurations ******************************/
  80. static struct fsg_module_parameters mod_data = {
  81. .stall = 1
  82. };
  83. FSG_MODULE_PARAMETERS(/* no prefix */, mod_data);
  84. static unsigned long msg_registered;
  85. static void msg_cleanup(void);
  86. static int msg_thread_exits(struct fsg_common *common)
  87. {
  88. msg_cleanup();
  89. return 0;
  90. }
  91. static int __init msg_do_config(struct usb_configuration *c)
  92. {
  93. static const struct fsg_operations ops = {
  94. .thread_exits = msg_thread_exits,
  95. };
  96. static struct fsg_common common;
  97. struct fsg_common *retp;
  98. struct fsg_config config;
  99. int ret;
  100. if (gadget_is_otg(c->cdev->gadget)) {
  101. c->descriptors = otg_desc;
  102. c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
  103. }
  104. fsg_config_from_params(&config, &mod_data);
  105. config.ops = &ops;
  106. retp = fsg_common_init(&common, c->cdev, &config);
  107. if (IS_ERR(retp))
  108. return PTR_ERR(retp);
  109. ret = fsg_bind_config(c->cdev, c, &common);
  110. fsg_common_put(&common);
  111. return ret;
  112. }
  113. static struct usb_configuration msg_config_driver = {
  114. .label = "Linux File-Backed Storage",
  115. .bConfigurationValue = 1,
  116. .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
  117. };
  118. /****************************** Gadget Bind ******************************/
  119. static int __init msg_bind(struct usb_composite_dev *cdev)
  120. {
  121. int status;
  122. status = usb_add_config(cdev, &msg_config_driver, msg_do_config);
  123. if (status < 0)
  124. return status;
  125. dev_info(&cdev->gadget->dev,
  126. DRIVER_DESC ", version: " DRIVER_VERSION "\n");
  127. set_bit(0, &msg_registered);
  128. return 0;
  129. }
  130. /****************************** Some noise ******************************/
  131. static struct usb_composite_driver msg_driver = {
  132. .name = "g_mass_storage",
  133. .dev = &msg_device_desc,
  134. .iProduct = DRIVER_DESC,
  135. .needs_serial = 1,
  136. };
  137. MODULE_DESCRIPTION(DRIVER_DESC);
  138. MODULE_AUTHOR("Michal Nazarewicz");
  139. MODULE_LICENSE("GPL");
  140. static int __init msg_init(void)
  141. {
  142. return usb_composite_probe(&msg_driver, msg_bind);
  143. }
  144. module_init(msg_init);
  145. static void msg_cleanup(void)
  146. {
  147. if (test_and_clear_bit(0, &msg_registered))
  148. usb_composite_unregister(&msg_driver);
  149. }
  150. module_exit(msg_cleanup);