2 * g_ffs.c -- user mode file system API for USB composite function controllers
4 * Copyright (C) 2010 Samsung Electronics
5 * Author: Michal Nazarewicz <m.nazarewicz@samsung.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <linux/module.h>
23 #include <linux/utsname.h>
26 * kbuild is not very cooperative with respect to linking separately
27 * compiled library objects into one module. So for now we won't use
28 * separate compilation ... ensuring init/exit sections work to shrink
29 * the runtime footprint, and giving us at least some parts of what
30 * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
33 #include "composite.c"
34 #include "usbstring.c"
36 #include "epautoconf.c"
38 #if defined CONFIG_USB_FUNCTIONFS_ETH || defined CONFIG_USB_FUNCTIONFS_RNDIS
39 # if defined USB_ETH_RNDIS
42 # ifdef CONFIG_USB_FUNCTIONFS_RNDIS
43 # define USB_ETH_RNDIS y
47 # include "f_subset.c"
54 static u8 gfs_hostaddr[ETH_ALEN];
55 # ifdef CONFIG_USB_FUNCTIONFS_ETH
56 static int eth_bind_config(struct usb_configuration *c, u8 ethaddr[ETH_ALEN]);
59 # define gether_cleanup() do { } while (0)
60 # define gether_setup(gadget, hostaddr) ((int)0)
61 # define gfs_hostaddr NULL
66 #define DRIVER_NAME "g_ffs"
67 #define DRIVER_DESC "USB Function Filesystem"
68 #define DRIVER_VERSION "24 Aug 2004"
70 MODULE_DESCRIPTION(DRIVER_DESC);
71 MODULE_AUTHOR("Michal Nazarewicz");
72 MODULE_LICENSE("GPL");
74 #define GFS_VENDOR_ID 0x1d6b /* Linux Foundation */
75 #define GFS_PRODUCT_ID 0x0105 /* FunctionFS Gadget */
77 static struct usb_device_descriptor gfs_dev_desc = {
78 .bLength = sizeof gfs_dev_desc,
79 .bDescriptorType = USB_DT_DEVICE,
81 .bcdUSB = cpu_to_le16(0x0200),
82 .bDeviceClass = USB_CLASS_PER_INTERFACE,
84 .idVendor = cpu_to_le16(GFS_VENDOR_ID),
85 .idProduct = cpu_to_le16(GFS_PRODUCT_ID),
88 module_param_named(bDeviceClass, gfs_dev_desc.bDeviceClass, byte, 0644);
89 MODULE_PARM_DESC(bDeviceClass, "USB Device class");
90 module_param_named(bDeviceSubClass, gfs_dev_desc.bDeviceSubClass, byte, 0644);
91 MODULE_PARM_DESC(bDeviceSubClass, "USB Device subclass");
92 module_param_named(bDeviceProtocol, gfs_dev_desc.bDeviceProtocol, byte, 0644);
93 MODULE_PARM_DESC(bDeviceProtocol, "USB Device protocol");
95 static const struct usb_descriptor_header *gfs_otg_desc[] = {
96 (const struct usb_descriptor_header *)
97 &(const struct usb_otg_descriptor) {
98 .bLength = sizeof(struct usb_otg_descriptor),
99 .bDescriptorType = USB_DT_OTG,
102 * REVISIT SRP-only hardware is possible, although
103 * it would not be called "OTG" ...
105 .bmAttributes = USB_OTG_SRP | USB_OTG_HNP,
111 /* String IDs are assigned dynamically */
112 static struct usb_string gfs_strings[] = {
113 #ifdef CONFIG_USB_FUNCTIONFS_RNDIS
114 { .s = "FunctionFS + RNDIS" },
116 #ifdef CONFIG_USB_FUNCTIONFS_ETH
117 { .s = "FunctionFS + ECM" },
119 #ifdef CONFIG_USB_FUNCTIONFS_GENERIC
120 { .s = "FunctionFS" },
122 { } /* end of list */
125 static struct usb_gadget_strings *gfs_dev_strings[] = {
126 &(struct usb_gadget_strings) {
127 .language = 0x0409, /* en-us */
128 .strings = gfs_strings,
133 struct gfs_configuration {
134 struct usb_configuration c;
135 int (*eth)(struct usb_configuration *c, u8 *ethaddr);
136 } gfs_configurations[] = {
137 #ifdef CONFIG_USB_FUNCTIONFS_RNDIS
139 .eth = rndis_bind_config,
143 #ifdef CONFIG_USB_FUNCTIONFS_ETH
145 .eth = eth_bind_config,
149 #ifdef CONFIG_USB_FUNCTIONFS_GENERIC
155 static int gfs_bind(struct usb_composite_dev *cdev);
156 static int gfs_unbind(struct usb_composite_dev *cdev);
157 static int gfs_do_config(struct usb_configuration *c);
159 static struct usb_composite_driver gfs_driver = {
161 .dev = &gfs_dev_desc,
162 .strings = gfs_dev_strings,
163 .unbind = gfs_unbind,
164 .iProduct = DRIVER_DESC,
167 static struct ffs_data *gfs_ffs_data;
168 static unsigned long gfs_registered;
170 static int gfs_init(void)
174 return functionfs_init();
176 module_init(gfs_init);
178 static void gfs_exit(void)
182 if (test_and_clear_bit(0, &gfs_registered))
183 usb_composite_unregister(&gfs_driver);
185 functionfs_cleanup();
187 module_exit(gfs_exit);
189 static int functionfs_ready_callback(struct ffs_data *ffs)
195 if (WARN_ON(test_and_set_bit(0, &gfs_registered)))
199 ret = usb_composite_probe(&gfs_driver, gfs_bind);
200 if (unlikely(ret < 0))
201 clear_bit(0, &gfs_registered);
205 static void functionfs_closed_callback(struct ffs_data *ffs)
209 if (test_and_clear_bit(0, &gfs_registered))
210 usb_composite_unregister(&gfs_driver);
213 static int functionfs_check_dev_callback(const char *dev_name)
218 static int gfs_bind(struct usb_composite_dev *cdev)
224 if (WARN_ON(!gfs_ffs_data))
227 ret = gether_setup(cdev->gadget, gfs_hostaddr);
228 if (unlikely(ret < 0))
231 ret = usb_string_ids_tab(cdev, gfs_strings);
232 if (unlikely(ret < 0))
235 ret = functionfs_bind(gfs_ffs_data, cdev);
236 if (unlikely(ret < 0))
239 for (i = 0; i < ARRAY_SIZE(gfs_configurations); ++i) {
240 struct gfs_configuration *c = gfs_configurations + i;
242 c->c.label = gfs_strings[i].s;
243 c->c.iConfiguration = gfs_strings[i].id;
244 c->c.bConfigurationValue = 1 + i;
245 c->c.bmAttributes = USB_CONFIG_ATT_SELFPOWER;
247 ret = usb_add_config(cdev, &c->c, gfs_do_config);
248 if (unlikely(ret < 0))
255 functionfs_unbind(gfs_ffs_data);
263 static int gfs_unbind(struct usb_composite_dev *cdev)
268 * We may have been called in an error recovery from
269 * composite_bind() after gfs_unbind() failure so we need to
270 * check if gfs_ffs_data is not NULL since gfs_bind() handles
271 * all error recovery itself. I'd rather we werent called
272 * from composite on orror recovery, but what you're gonna
277 functionfs_unbind(gfs_ffs_data);
284 static int gfs_do_config(struct usb_configuration *c)
286 struct gfs_configuration *gc =
287 container_of(c, struct gfs_configuration, c);
290 if (WARN_ON(!gfs_ffs_data))
293 if (gadget_is_otg(c->cdev->gadget)) {
294 c->descriptors = gfs_otg_desc;
295 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
299 ret = gc->eth(c, gfs_hostaddr);
300 if (unlikely(ret < 0))
304 ret = functionfs_bind_config(c->cdev, c, gfs_ffs_data);
305 if (unlikely(ret < 0))
309 * After previous do_configs there may be some invalid
310 * pointers in c->interface array. This happens every time
311 * a user space function with fewer interfaces than a user
312 * space function that was run before the new one is run. The
313 * compasit's set_config() assumes that if there is no more
314 * then MAX_CONFIG_INTERFACES interfaces in a configuration
315 * then there is a NULL pointer after the last interface in
316 * c->interface array. We need to make sure this is true.
318 if (c->next_interface_id < ARRAY_SIZE(c->interface))
319 c->interface[c->next_interface_id] = NULL;
324 #ifdef CONFIG_USB_FUNCTIONFS_ETH
326 static int eth_bind_config(struct usb_configuration *c, u8 ethaddr[ETH_ALEN])
328 return can_support_ecm(c->cdev->gadget)
329 ? ecm_bind_config(c, ethaddr)
330 : geth_bind_config(c, ethaddr);