2 * mass_storage.c -- Mass Storage USB Gadget
4 * Copyright (C) 2003-2008 Alan Stern
5 * Copyright (C) 2009 Samsung Electronics
6 * Author: Michal Nazarewicz <m.nazarewicz@samsung.com>
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.
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.
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
26 * The Mass Storage Gadget acts as a USB Mass Storage device,
27 * appearing to the host as a disk drive or as a CD-ROM drive. In
28 * addition to providing an example of a genuinely useful gadget
29 * driver for a USB device, it also illustrates a technique of
30 * double-buffering for increased throughput. Last but not least, it
31 * gives an easy way to probe the behavior of the Mass Storage drivers
34 * Since this file serves only administrative purposes and all the
35 * business logic is implemented in f_mass_storage.* file. Read
36 * comments in this file for more detailed description.
40 #include <linux/kernel.h>
41 #include <linux/utsname.h>
42 #include <linux/usb/ch9.h>
45 /*-------------------------------------------------------------------------*/
47 #define DRIVER_DESC "Mass Storage Gadget"
48 #define DRIVER_VERSION "2009/09/11"
50 /*-------------------------------------------------------------------------*/
53 * kbuild is not very cooperative with respect to linking separately
54 * compiled library objects into one module. So for now we won't use
55 * separate compilation ... ensuring init/exit sections work to shrink
56 * the runtime footprint, and giving us at least some parts of what
57 * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
60 #include "composite.c"
61 #include "usbstring.c"
63 #include "epautoconf.c"
64 #include "f_mass_storage.c"
66 /*-------------------------------------------------------------------------*/
68 static struct usb_device_descriptor msg_device_desc = {
69 .bLength = sizeof msg_device_desc,
70 .bDescriptorType = USB_DT_DEVICE,
72 .bcdUSB = cpu_to_le16(0x0200),
73 .bDeviceClass = USB_CLASS_PER_INTERFACE,
75 /* Vendor and product id can be overridden by module parameters. */
76 .idVendor = cpu_to_le16(FSG_VENDOR_ID),
77 .idProduct = cpu_to_le16(FSG_PRODUCT_ID),
78 /* .bcdDevice = f(hardware) */
79 /* .iManufacturer = DYNAMIC */
80 /* .iProduct = DYNAMIC */
81 /* NO SERIAL NUMBER */
82 .bNumConfigurations = 1,
85 static struct usb_otg_descriptor otg_descriptor = {
86 .bLength = sizeof otg_descriptor,
87 .bDescriptorType = USB_DT_OTG,
89 /* REVISIT SRP-only hardware is possible, although
90 * it would not be called "OTG" ...
92 .bmAttributes = USB_OTG_SRP | USB_OTG_HNP,
95 static const struct usb_descriptor_header *otg_desc[] = {
96 (struct usb_descriptor_header *) &otg_descriptor,
101 /* string IDs are assigned dynamically */
103 #define STRING_MANUFACTURER_IDX 0
104 #define STRING_PRODUCT_IDX 1
105 #define STRING_CONFIGURATION_IDX 2
107 static char manufacturer[50];
109 static struct usb_string strings_dev[] = {
110 [STRING_MANUFACTURER_IDX].s = manufacturer,
111 [STRING_PRODUCT_IDX].s = DRIVER_DESC,
112 [STRING_CONFIGURATION_IDX].s = "Self Powered",
113 { } /* end of list */
116 static struct usb_gadget_strings stringtab_dev = {
117 .language = 0x0409, /* en-us */
118 .strings = strings_dev,
121 static struct usb_gadget_strings *dev_strings[] = {
128 /****************************** Configurations ******************************/
130 static struct fsg_module_parameters mod_data = {
133 FSG_MODULE_PARAMETERS(/* no prefix */, mod_data);
135 static unsigned long msg_registered = 0;
136 static void msg_cleanup(void);
138 static int msg_thread_exits(struct fsg_common *common)
144 static int __ref msg_do_config(struct usb_configuration *c)
146 static const struct fsg_operations ops = {
147 .thread_exits = msg_thread_exits,
149 static struct fsg_common common;
151 struct fsg_common *retp;
152 struct fsg_config config;
155 if (gadget_is_otg(c->cdev->gadget)) {
156 c->descriptors = otg_desc;
157 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
160 fsg_config_from_params(&config, &mod_data);
163 retp = fsg_common_init(&common, c->cdev, &config);
165 return PTR_ERR(retp);
167 ret = fsg_bind_config(c->cdev, c, &common);
168 fsg_common_put(&common);
172 static struct usb_configuration msg_config_driver = {
173 .label = "Linux File-Backed Storage",
174 .bind = msg_do_config,
175 .bConfigurationValue = 1,
176 /* .iConfiguration = DYNAMIC */
177 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
182 /****************************** Gadget Bind ******************************/
185 static int __ref msg_bind(struct usb_composite_dev *cdev)
187 struct usb_gadget *gadget = cdev->gadget;
190 /* Allocate string descriptor numbers ... note that string
191 * contents can be overridden by the composite_dev glue.
194 /* device descriptor strings: manufacturer, product */
195 snprintf(manufacturer, sizeof manufacturer, "%s %s with %s",
196 init_utsname()->sysname, init_utsname()->release,
198 status = usb_string_id(cdev);
201 strings_dev[STRING_MANUFACTURER_IDX].id = status;
202 msg_device_desc.iManufacturer = status;
204 status = usb_string_id(cdev);
207 strings_dev[STRING_PRODUCT_IDX].id = status;
208 msg_device_desc.iProduct = status;
210 status = usb_string_id(cdev);
213 strings_dev[STRING_CONFIGURATION_IDX].id = status;
214 msg_config_driver.iConfiguration = status;
216 /* register our second configuration */
217 status = usb_add_config(cdev, &msg_config_driver);
221 dev_info(&gadget->dev, DRIVER_DESC ", version: " DRIVER_VERSION "\n");
222 set_bit(0, &msg_registered);
227 /****************************** Some noise ******************************/
230 static struct usb_composite_driver msg_driver = {
231 .name = "g_mass_storage",
232 .dev = &msg_device_desc,
233 .strings = dev_strings,
237 MODULE_DESCRIPTION(DRIVER_DESC);
238 MODULE_AUTHOR("Michal Nazarewicz");
239 MODULE_LICENSE("GPL");
241 static int __init msg_init(void)
243 return usb_composite_register(&msg_driver);
245 module_init(msg_init);
247 static void msg_cleanup(void)
249 if (test_and_clear_bit(0, &msg_registered))
250 usb_composite_unregister(&msg_driver);
252 module_exit(msg_cleanup);