Commit | Line | Data |
---|---|---|
d23b0f08 | 1 | /* |
d26a6aa0 | 2 | * mass_storage.c -- Mass Storage USB Gadget |
d23b0f08 MN |
3 | * |
4 | * Copyright (C) 2003-2008 Alan Stern | |
d23b0f08 | 5 | * Copyright (C) 2009 Samsung Electronics |
54b8360f | 6 | * Author: Michal Nazarewicz <mina86@mina86.com> |
d26a6aa0 | 7 | * All rights reserved. |
d23b0f08 MN |
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. | |
d23b0f08 MN |
13 | */ |
14 | ||
15 | ||
16 | /* | |
17 | * The Mass Storage Gadget acts as a USB Mass Storage device, | |
18 | * appearing to the host as a disk drive or as a CD-ROM drive. In | |
19 | * addition to providing an example of a genuinely useful gadget | |
20 | * driver for a USB device, it also illustrates a technique of | |
21 | * double-buffering for increased throughput. Last but not least, it | |
22 | * gives an easy way to probe the behavior of the Mass Storage drivers | |
23 | * in a USB host. | |
24 | * | |
25 | * Since this file serves only administrative purposes and all the | |
26 | * business logic is implemented in f_mass_storage.* file. Read | |
27 | * comments in this file for more detailed description. | |
28 | */ | |
29 | ||
30 | ||
31 | #include <linux/kernel.h> | |
32 | #include <linux/utsname.h> | |
33 | #include <linux/usb/ch9.h> | |
34 | ||
35 | ||
36 | /*-------------------------------------------------------------------------*/ | |
37 | ||
38 | #define DRIVER_DESC "Mass Storage Gadget" | |
d26a6aa0 | 39 | #define DRIVER_VERSION "2009/09/11" |
d23b0f08 MN |
40 | |
41 | /*-------------------------------------------------------------------------*/ | |
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 | ||
51 | #include "composite.c" | |
52 | #include "usbstring.c" | |
53 | #include "config.c" | |
54 | #include "epautoconf.c" | |
55 | #include "f_mass_storage.c" | |
56 | ||
57 | /*-------------------------------------------------------------------------*/ | |
58 | ||
59 | static struct usb_device_descriptor msg_device_desc = { | |
60 | .bLength = sizeof msg_device_desc, | |
61 | .bDescriptorType = USB_DT_DEVICE, | |
62 | ||
63 | .bcdUSB = cpu_to_le16(0x0200), | |
64 | .bDeviceClass = USB_CLASS_PER_INTERFACE, | |
65 | ||
66 | /* Vendor and product id can be overridden by module parameters. */ | |
67 | .idVendor = cpu_to_le16(FSG_VENDOR_ID), | |
68 | .idProduct = cpu_to_le16(FSG_PRODUCT_ID), | |
d23b0f08 MN |
69 | .bNumConfigurations = 1, |
70 | }; | |
71 | ||
72 | static struct usb_otg_descriptor otg_descriptor = { | |
73 | .bLength = sizeof otg_descriptor, | |
74 | .bDescriptorType = USB_DT_OTG, | |
75 | ||
7c2b61d0 MN |
76 | /* |
77 | * REVISIT SRP-only hardware is possible, although | |
d23b0f08 MN |
78 | * it would not be called "OTG" ... |
79 | */ | |
80 | .bmAttributes = USB_OTG_SRP | USB_OTG_HNP, | |
81 | }; | |
82 | ||
83 | static const struct usb_descriptor_header *otg_desc[] = { | |
84 | (struct usb_descriptor_header *) &otg_descriptor, | |
85 | NULL, | |
86 | }; | |
87 | ||
88 | ||
d23b0f08 MN |
89 | /****************************** Configurations ******************************/ |
90 | ||
481e4929 MN |
91 | static struct fsg_module_parameters mod_data = { |
92 | .stall = 1 | |
93 | }; | |
94 | FSG_MODULE_PARAMETERS(/* no prefix */, mod_data); | |
95 | ||
b73af61e | 96 | static unsigned long msg_registered; |
c85efcb9 MN |
97 | static void msg_cleanup(void); |
98 | ||
7f1ee826 MN |
99 | static int msg_thread_exits(struct fsg_common *common) |
100 | { | |
101 | msg_cleanup(); | |
102 | return 0; | |
103 | } | |
104 | ||
e12995ec | 105 | static int __init msg_do_config(struct usb_configuration *c) |
d23b0f08 | 106 | { |
8876f5e7 MN |
107 | static const struct fsg_operations ops = { |
108 | .thread_exits = msg_thread_exits, | |
109 | }; | |
26eca10e MN |
110 | static struct fsg_common common; |
111 | ||
112 | struct fsg_common *retp; | |
c85efcb9 | 113 | struct fsg_config config; |
d23b0f08 MN |
114 | int ret; |
115 | ||
116 | if (gadget_is_otg(c->cdev->gadget)) { | |
117 | c->descriptors = otg_desc; | |
118 | c->bmAttributes |= USB_CONFIG_ATT_WAKEUP; | |
119 | } | |
120 | ||
c85efcb9 | 121 | fsg_config_from_params(&config, &mod_data); |
8876f5e7 | 122 | config.ops = &ops; |
d23b0f08 | 123 | |
26eca10e MN |
124 | retp = fsg_common_init(&common, c->cdev, &config); |
125 | if (IS_ERR(retp)) | |
126 | return PTR_ERR(retp); | |
127 | ||
1dc90985 | 128 | ret = fsg_bind_config(c->cdev, c, &common); |
26eca10e | 129 | fsg_common_put(&common); |
d23b0f08 MN |
130 | return ret; |
131 | } | |
132 | ||
133 | static struct usb_configuration msg_config_driver = { | |
134 | .label = "Linux File-Backed Storage", | |
d23b0f08 | 135 | .bConfigurationValue = 1, |
d23b0f08 MN |
136 | .bmAttributes = USB_CONFIG_ATT_SELFPOWER, |
137 | }; | |
138 | ||
139 | ||
d23b0f08 MN |
140 | /****************************** Gadget Bind ******************************/ |
141 | ||
e12995ec | 142 | static int __init msg_bind(struct usb_composite_dev *cdev) |
d23b0f08 | 143 | { |
d23b0f08 MN |
144 | int status; |
145 | ||
c9bfff9c | 146 | status = usb_add_config(cdev, &msg_config_driver, msg_do_config); |
d23b0f08 MN |
147 | if (status < 0) |
148 | return status; | |
149 | ||
7c2b61d0 MN |
150 | dev_info(&cdev->gadget->dev, |
151 | DRIVER_DESC ", version: " DRIVER_VERSION "\n"); | |
c85efcb9 | 152 | set_bit(0, &msg_registered); |
d23b0f08 MN |
153 | return 0; |
154 | } | |
155 | ||
156 | ||
157 | /****************************** Some noise ******************************/ | |
158 | ||
d23b0f08 MN |
159 | static struct usb_composite_driver msg_driver = { |
160 | .name = "g_mass_storage", | |
161 | .dev = &msg_device_desc, | |
7c2b61d0 | 162 | .iProduct = DRIVER_DESC, |
4bb99b7c | 163 | .max_speed = USB_SPEED_SUPER, |
7c2b61d0 | 164 | .needs_serial = 1, |
d23b0f08 MN |
165 | }; |
166 | ||
167 | MODULE_DESCRIPTION(DRIVER_DESC); | |
168 | MODULE_AUTHOR("Michal Nazarewicz"); | |
169 | MODULE_LICENSE("GPL"); | |
170 | ||
171 | static int __init msg_init(void) | |
172 | { | |
07a18bd7 | 173 | return usb_composite_probe(&msg_driver, msg_bind); |
d23b0f08 MN |
174 | } |
175 | module_init(msg_init); | |
176 | ||
c85efcb9 | 177 | static void msg_cleanup(void) |
d23b0f08 | 178 | { |
c85efcb9 MN |
179 | if (test_and_clear_bit(0, &msg_registered)) |
180 | usb_composite_unregister(&msg_driver); | |
d23b0f08 MN |
181 | } |
182 | module_exit(msg_cleanup); |