2 * Gadget Driver for Android
4 * Copyright (C) 2008 Google, Inc.
5 * Author: Mike Lockwood <lockwood@android.com>
6 * Benoit Goby <benoit@android.com>
8 * This software is licensed under the terms of the GNU General Public
9 * License version 2, as published by the Free Software Foundation, and
10 * may be copied, distributed, and modified under those terms.
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.
19 #include <linux/init.h>
20 #include <linux/module.h>
22 #include <linux/delay.h>
23 #include <linux/kernel.h>
24 #include <linux/utsname.h>
25 #include <linux/platform_device.h>
27 #include <linux/usb/ch9.h>
28 #include <linux/usb/composite.h>
29 #include <linux/usb/gadget.h>
31 #include "gadget_chips.h"
34 #include "f_audio_source.c"
35 #include "f_mass_storage.c"
37 #include "f_accessory.c"
38 #define USB_ETH_RNDIS y
43 MODULE_AUTHOR("Mike Lockwood");
44 MODULE_DESCRIPTION("Android Composite USB Driver");
45 MODULE_LICENSE("GPL");
46 MODULE_VERSION("1.0");
48 static const char longname[] = "Gadget Android";
50 /* Default vendor and product IDs, overridden by userspace */
51 #define VENDOR_ID 0x18D1
52 #define PRODUCT_ID 0x0001
54 struct android_usb_function {
60 struct device_attribute **attributes;
62 /* for android_dev.enabled_functions */
63 struct list_head enabled_list;
65 /* Optional: initialization during gadget bind */
66 int (*init)(struct android_usb_function *, struct usb_composite_dev *);
67 /* Optional: cleanup during gadget unbind */
68 void (*cleanup)(struct android_usb_function *);
69 /* Optional: called when the function is added the list of
70 * enabled functions */
71 void (*enable)(struct android_usb_function *);
72 /* Optional: called when it is removed */
73 void (*disable)(struct android_usb_function *);
75 int (*bind_config)(struct android_usb_function *,
76 struct usb_configuration *);
78 /* Optional: called when the configuration is removed */
79 void (*unbind_config)(struct android_usb_function *,
80 struct usb_configuration *);
81 /* Optional: handle ctrl requests before the device is configured */
82 int (*ctrlrequest)(struct android_usb_function *,
83 struct usb_composite_dev *,
84 const struct usb_ctrlrequest *);
88 struct android_usb_function **functions;
89 struct list_head enabled_functions;
90 struct usb_composite_dev *cdev;
93 void (*setup_complete)(struct usb_ep *ep,
94 struct usb_request *req);
101 struct work_struct work;
102 char ffs_aliases[256];
105 static struct class *android_class;
106 static struct android_dev *_android_dev;
107 static int android_bind_config(struct usb_configuration *c);
108 static void android_unbind_config(struct usb_configuration *c);
110 /* string IDs are assigned dynamically */
111 #define STRING_MANUFACTURER_IDX 0
112 #define STRING_PRODUCT_IDX 1
113 #define STRING_SERIAL_IDX 2
115 static char manufacturer_string[256];
116 static char product_string[256];
117 static char serial_string[256];
120 static struct usb_string strings_dev[] = {
121 [STRING_MANUFACTURER_IDX].s = manufacturer_string,
122 [STRING_PRODUCT_IDX].s = product_string,
123 [STRING_SERIAL_IDX].s = serial_string,
124 { } /* end of list */
127 static struct usb_gadget_strings stringtab_dev = {
128 .language = 0x0409, /* en-us */
129 .strings = strings_dev,
132 static struct usb_gadget_strings *dev_strings[] = {
137 static struct usb_device_descriptor device_desc = {
138 .bLength = sizeof(device_desc),
139 .bDescriptorType = USB_DT_DEVICE,
140 .bcdUSB = __constant_cpu_to_le16(0x0200),
141 .bDeviceClass = USB_CLASS_PER_INTERFACE,
142 .idVendor = __constant_cpu_to_le16(VENDOR_ID),
143 .idProduct = __constant_cpu_to_le16(PRODUCT_ID),
144 .bcdDevice = __constant_cpu_to_le16(0xffff),
145 .bNumConfigurations = 1,
148 static struct usb_configuration android_config_driver = {
150 .unbind = android_unbind_config,
151 .bConfigurationValue = 1,
152 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
153 .MaxPower = 500, /* 500ma */
156 static void android_work(struct work_struct *data)
158 struct android_dev *dev = container_of(data, struct android_dev, work);
159 struct usb_composite_dev *cdev = dev->cdev;
160 char *disconnected[2] = { "USB_STATE=DISCONNECTED", NULL };
161 char *connected[2] = { "USB_STATE=CONNECTED", NULL };
162 char *configured[2] = { "USB_STATE=CONFIGURED", NULL };
163 char **uevent_envp = NULL;
166 spin_lock_irqsave(&cdev->lock, flags);
168 uevent_envp = configured;
169 else if (dev->connected != dev->sw_connected)
170 uevent_envp = dev->connected ? connected : disconnected;
171 dev->sw_connected = dev->connected;
172 spin_unlock_irqrestore(&cdev->lock, flags);
175 kobject_uevent_env(&dev->dev->kobj, KOBJ_CHANGE, uevent_envp);
176 pr_info("%s: sent uevent %s\n", __func__, uevent_envp[0]);
178 pr_info("%s: did not send uevent (%d %d %p)\n", __func__,
179 dev->connected, dev->sw_connected, cdev->config);
183 static void android_enable(struct android_dev *dev)
185 struct usb_composite_dev *cdev = dev->cdev;
187 if (WARN_ON(!dev->disable_depth))
190 if (--dev->disable_depth == 0) {
191 usb_add_config(cdev, &android_config_driver,
192 android_bind_config);
193 usb_gadget_connect(cdev->gadget);
197 static void android_disable(struct android_dev *dev)
199 struct usb_composite_dev *cdev = dev->cdev;
201 if (dev->disable_depth++ == 0) {
202 usb_gadget_disconnect(cdev->gadget);
203 /* Cancel pending control requests */
204 usb_ep_dequeue(cdev->gadget->ep0, cdev->req);
205 usb_remove_config(cdev, &android_config_driver);
209 /*-------------------------------------------------------------------------*/
210 /* Supported functions initialization */
212 struct functionfs_config {
215 struct ffs_data *data;
218 static int ffs_function_init(struct android_usb_function *f,
219 struct usb_composite_dev *cdev)
221 f->config = kzalloc(sizeof(struct functionfs_config), GFP_KERNEL);
225 return functionfs_init();
228 static void ffs_function_cleanup(struct android_usb_function *f)
230 functionfs_cleanup();
234 static void ffs_function_enable(struct android_usb_function *f)
236 struct android_dev *dev = _android_dev;
237 struct functionfs_config *config = f->config;
239 config->enabled = true;
241 /* Disable the gadget until the function is ready */
243 android_disable(dev);
246 static void ffs_function_disable(struct android_usb_function *f)
248 struct android_dev *dev = _android_dev;
249 struct functionfs_config *config = f->config;
251 config->enabled = false;
253 /* Balance the disable that was called in closed_callback */
258 static int ffs_function_bind_config(struct android_usb_function *f,
259 struct usb_configuration *c)
261 struct functionfs_config *config = f->config;
262 return functionfs_bind_config(c->cdev, c, config->data);
266 ffs_aliases_show(struct device *pdev, struct device_attribute *attr, char *buf)
268 struct android_dev *dev = _android_dev;
271 mutex_lock(&dev->mutex);
272 ret = sprintf(buf, "%s\n", dev->ffs_aliases);
273 mutex_unlock(&dev->mutex);
279 ffs_aliases_store(struct device *pdev, struct device_attribute *attr,
280 const char *buf, size_t size)
282 struct android_dev *dev = _android_dev;
285 mutex_lock(&dev->mutex);
288 mutex_unlock(&dev->mutex);
292 strlcpy(buff, buf, sizeof(buff));
293 strlcpy(dev->ffs_aliases, strim(buff), sizeof(dev->ffs_aliases));
295 mutex_unlock(&dev->mutex);
300 static DEVICE_ATTR(aliases, S_IRUGO | S_IWUSR, ffs_aliases_show,
302 static struct device_attribute *ffs_function_attributes[] = {
307 static struct android_usb_function ffs_function = {
309 .init = ffs_function_init,
310 .enable = ffs_function_enable,
311 .disable = ffs_function_disable,
312 .cleanup = ffs_function_cleanup,
313 .bind_config = ffs_function_bind_config,
314 .attributes = ffs_function_attributes,
317 static int functionfs_ready_callback(struct ffs_data *ffs)
319 struct android_dev *dev = _android_dev;
320 struct functionfs_config *config = ffs_function.config;
323 mutex_lock(&dev->mutex);
325 ret = functionfs_bind(ffs, dev->cdev);
330 config->opened = true;
336 mutex_unlock(&dev->mutex);
340 static void functionfs_closed_callback(struct ffs_data *ffs)
342 struct android_dev *dev = _android_dev;
343 struct functionfs_config *config = ffs_function.config;
345 mutex_lock(&dev->mutex);
348 android_disable(dev);
350 config->opened = false;
353 functionfs_unbind(ffs);
355 mutex_unlock(&dev->mutex);
358 static void *functionfs_acquire_dev_callback(const char *dev_name)
363 static void functionfs_release_dev_callback(struct ffs_data *ffs_data)
367 #define MAX_ACM_INSTANCES 4
368 struct acm_function_config {
371 struct usb_function *f_acm[MAX_ACM_INSTANCES];
372 struct usb_function_instance *f_acm_inst[MAX_ACM_INSTANCES];
376 acm_function_init(struct android_usb_function *f,
377 struct usb_composite_dev *cdev)
381 struct acm_function_config *config;
383 config = kzalloc(sizeof(struct acm_function_config), GFP_KERNEL);
388 for (i = 0; i < MAX_ACM_INSTANCES; i++) {
389 config->f_acm_inst[i] = usb_get_function_instance("acm");
390 if (IS_ERR(config->f_acm_inst[i])) {
391 ret = PTR_ERR(config->f_acm_inst[i]);
392 goto err_usb_get_function_instance;
394 config->f_acm[i] = usb_get_function(config->f_acm_inst[i]);
395 if (IS_ERR(config->f_acm[i])) {
396 ret = PTR_ERR(config->f_acm[i]);
397 goto err_usb_get_function;
401 err_usb_get_function_instance:
403 usb_put_function(config->f_acm[i]);
404 err_usb_get_function:
405 usb_put_function_instance(config->f_acm_inst[i]);
410 static void acm_function_cleanup(struct android_usb_function *f)
413 struct acm_function_config *config = f->config;
415 for (i = 0; i < MAX_ACM_INSTANCES; i++) {
416 usb_put_function(config->f_acm[i]);
417 usb_put_function_instance(config->f_acm_inst[i]);
424 acm_function_bind_config(struct android_usb_function *f,
425 struct usb_configuration *c)
429 struct acm_function_config *config = f->config;
431 config->instances_on = config->instances;
432 for (i = 0; i < config->instances_on; i++) {
433 ret = usb_add_function(c, config->f_acm[i]);
435 pr_err("Could not bind acm%u config\n", i);
436 goto err_usb_add_function;
442 err_usb_add_function:
444 usb_remove_function(c, config->f_acm[i]);
448 static void acm_function_unbind_config(struct android_usb_function *f,
449 struct usb_configuration *c)
452 struct acm_function_config *config = f->config;
454 for (i = 0; i < config->instances_on; i++)
455 usb_remove_function(c, config->f_acm[i]);
458 static ssize_t acm_instances_show(struct device *dev,
459 struct device_attribute *attr, char *buf)
461 struct android_usb_function *f = dev_get_drvdata(dev);
462 struct acm_function_config *config = f->config;
463 return sprintf(buf, "%d\n", config->instances);
466 static ssize_t acm_instances_store(struct device *dev,
467 struct device_attribute *attr, const char *buf, size_t size)
469 struct android_usb_function *f = dev_get_drvdata(dev);
470 struct acm_function_config *config = f->config;
473 sscanf(buf, "%d", &value);
474 if (value > MAX_ACM_INSTANCES)
475 value = MAX_ACM_INSTANCES;
476 config->instances = value;
480 static DEVICE_ATTR(instances, S_IRUGO | S_IWUSR, acm_instances_show,
481 acm_instances_store);
482 static struct device_attribute *acm_function_attributes[] = {
487 static struct android_usb_function acm_function = {
489 .init = acm_function_init,
490 .cleanup = acm_function_cleanup,
491 .bind_config = acm_function_bind_config,
492 .unbind_config = acm_function_unbind_config,
493 .attributes = acm_function_attributes,
498 mtp_function_init(struct android_usb_function *f,
499 struct usb_composite_dev *cdev)
504 static void mtp_function_cleanup(struct android_usb_function *f)
510 mtp_function_bind_config(struct android_usb_function *f,
511 struct usb_configuration *c)
513 return mtp_bind_config(c, false);
517 ptp_function_init(struct android_usb_function *f,
518 struct usb_composite_dev *cdev)
520 /* nothing to do - initialization is handled by mtp_function_init */
524 static void ptp_function_cleanup(struct android_usb_function *f)
526 /* nothing to do - cleanup is handled by mtp_function_cleanup */
530 ptp_function_bind_config(struct android_usb_function *f,
531 struct usb_configuration *c)
533 return mtp_bind_config(c, true);
536 static int mtp_function_ctrlrequest(struct android_usb_function *f,
537 struct usb_composite_dev *cdev,
538 const struct usb_ctrlrequest *c)
540 return mtp_ctrlrequest(cdev, c);
543 static struct android_usb_function mtp_function = {
545 .init = mtp_function_init,
546 .cleanup = mtp_function_cleanup,
547 .bind_config = mtp_function_bind_config,
548 .ctrlrequest = mtp_function_ctrlrequest,
551 /* PTP function is same as MTP with slightly different interface descriptor */
552 static struct android_usb_function ptp_function = {
554 .init = ptp_function_init,
555 .cleanup = ptp_function_cleanup,
556 .bind_config = ptp_function_bind_config,
560 struct rndis_function_config {
561 u8 ethaddr[ETH_ALEN];
563 char manufacturer[256];
564 /* "Wireless" RNDIS; auto-detected by Windows */
570 rndis_function_init(struct android_usb_function *f,
571 struct usb_composite_dev *cdev)
573 f->config = kzalloc(sizeof(struct rndis_function_config), GFP_KERNEL);
579 static void rndis_function_cleanup(struct android_usb_function *f)
586 rndis_function_bind_config(struct android_usb_function *f,
587 struct usb_configuration *c)
591 struct rndis_function_config *rndis = f->config;
594 pr_err("%s: rndis_pdata\n", __func__);
598 pr_info("%s MAC: %02X:%02X:%02X:%02X:%02X:%02X\n", __func__,
599 rndis->ethaddr[0], rndis->ethaddr[1], rndis->ethaddr[2],
600 rndis->ethaddr[3], rndis->ethaddr[4], rndis->ethaddr[5]);
602 dev = gether_setup_name(c->cdev->gadget, rndis->ethaddr, "rndis");
605 pr_err("%s: gether_setup failed\n", __func__);
611 /* "Wireless" RNDIS; auto-detected by Windows */
612 rndis_iad_descriptor.bFunctionClass =
613 USB_CLASS_WIRELESS_CONTROLLER;
614 rndis_iad_descriptor.bFunctionSubClass = 0x01;
615 rndis_iad_descriptor.bFunctionProtocol = 0x03;
616 rndis_control_intf.bInterfaceClass =
617 USB_CLASS_WIRELESS_CONTROLLER;
618 rndis_control_intf.bInterfaceSubClass = 0x01;
619 rndis_control_intf.bInterfaceProtocol = 0x03;
622 return rndis_bind_config_vendor(c, rndis->ethaddr, rndis->vendorID,
623 rndis->manufacturer, rndis->dev);
626 static void rndis_function_unbind_config(struct android_usb_function *f,
627 struct usb_configuration *c)
629 struct rndis_function_config *rndis = f->config;
630 gether_cleanup(rndis->dev);
633 static ssize_t rndis_manufacturer_show(struct device *dev,
634 struct device_attribute *attr, char *buf)
636 struct android_usb_function *f = dev_get_drvdata(dev);
637 struct rndis_function_config *config = f->config;
638 return sprintf(buf, "%s\n", config->manufacturer);
641 static ssize_t rndis_manufacturer_store(struct device *dev,
642 struct device_attribute *attr, const char *buf, size_t size)
644 struct android_usb_function *f = dev_get_drvdata(dev);
645 struct rndis_function_config *config = f->config;
647 if (size >= sizeof(config->manufacturer))
649 if (sscanf(buf, "%s", config->manufacturer) == 1)
654 static DEVICE_ATTR(manufacturer, S_IRUGO | S_IWUSR, rndis_manufacturer_show,
655 rndis_manufacturer_store);
657 static ssize_t rndis_wceis_show(struct device *dev,
658 struct device_attribute *attr, char *buf)
660 struct android_usb_function *f = dev_get_drvdata(dev);
661 struct rndis_function_config *config = f->config;
662 return sprintf(buf, "%d\n", config->wceis);
665 static ssize_t rndis_wceis_store(struct device *dev,
666 struct device_attribute *attr, const char *buf, size_t size)
668 struct android_usb_function *f = dev_get_drvdata(dev);
669 struct rndis_function_config *config = f->config;
672 if (sscanf(buf, "%d", &value) == 1) {
673 config->wceis = value;
679 static DEVICE_ATTR(wceis, S_IRUGO | S_IWUSR, rndis_wceis_show,
682 static ssize_t rndis_ethaddr_show(struct device *dev,
683 struct device_attribute *attr, char *buf)
685 struct android_usb_function *f = dev_get_drvdata(dev);
686 struct rndis_function_config *rndis = f->config;
687 return sprintf(buf, "%02x:%02x:%02x:%02x:%02x:%02x\n",
688 rndis->ethaddr[0], rndis->ethaddr[1], rndis->ethaddr[2],
689 rndis->ethaddr[3], rndis->ethaddr[4], rndis->ethaddr[5]);
692 static ssize_t rndis_ethaddr_store(struct device *dev,
693 struct device_attribute *attr, const char *buf, size_t size)
695 struct android_usb_function *f = dev_get_drvdata(dev);
696 struct rndis_function_config *rndis = f->config;
698 if (sscanf(buf, "%02x:%02x:%02x:%02x:%02x:%02x\n",
699 (int *)&rndis->ethaddr[0], (int *)&rndis->ethaddr[1],
700 (int *)&rndis->ethaddr[2], (int *)&rndis->ethaddr[3],
701 (int *)&rndis->ethaddr[4], (int *)&rndis->ethaddr[5]) == 6)
706 static DEVICE_ATTR(ethaddr, S_IRUGO | S_IWUSR, rndis_ethaddr_show,
707 rndis_ethaddr_store);
709 static ssize_t rndis_vendorID_show(struct device *dev,
710 struct device_attribute *attr, char *buf)
712 struct android_usb_function *f = dev_get_drvdata(dev);
713 struct rndis_function_config *config = f->config;
714 return sprintf(buf, "%04x\n", config->vendorID);
717 static ssize_t rndis_vendorID_store(struct device *dev,
718 struct device_attribute *attr, const char *buf, size_t size)
720 struct android_usb_function *f = dev_get_drvdata(dev);
721 struct rndis_function_config *config = f->config;
724 if (sscanf(buf, "%04x", &value) == 1) {
725 config->vendorID = value;
731 static DEVICE_ATTR(vendorID, S_IRUGO | S_IWUSR, rndis_vendorID_show,
732 rndis_vendorID_store);
734 static struct device_attribute *rndis_function_attributes[] = {
735 &dev_attr_manufacturer,
742 static struct android_usb_function rndis_function = {
744 .init = rndis_function_init,
745 .cleanup = rndis_function_cleanup,
746 .bind_config = rndis_function_bind_config,
747 .unbind_config = rndis_function_unbind_config,
748 .attributes = rndis_function_attributes,
752 struct mass_storage_function_config {
753 struct fsg_config fsg;
754 struct fsg_common *common;
757 static int mass_storage_function_init(struct android_usb_function *f,
758 struct usb_composite_dev *cdev)
760 struct mass_storage_function_config *config;
761 struct fsg_common *common;
764 config = kzalloc(sizeof(struct mass_storage_function_config),
769 config->fsg.nluns = 1;
770 config->fsg.luns[0].removable = 1;
772 common = fsg_common_init(NULL, cdev, &config->fsg);
773 if (IS_ERR(common)) {
775 return PTR_ERR(common);
778 err = sysfs_create_link(&f->dev->kobj,
779 &common->luns[0].dev.kobj,
786 config->common = common;
791 static void mass_storage_function_cleanup(struct android_usb_function *f)
797 static int mass_storage_function_bind_config(struct android_usb_function *f,
798 struct usb_configuration *c)
800 struct mass_storage_function_config *config = f->config;
801 return fsg_bind_config(c->cdev, c, config->common);
804 static ssize_t mass_storage_inquiry_show(struct device *dev,
805 struct device_attribute *attr, char *buf)
807 struct android_usb_function *f = dev_get_drvdata(dev);
808 struct mass_storage_function_config *config = f->config;
809 return sprintf(buf, "%s\n", config->common->inquiry_string);
812 static ssize_t mass_storage_inquiry_store(struct device *dev,
813 struct device_attribute *attr, const char *buf, size_t size)
815 struct android_usb_function *f = dev_get_drvdata(dev);
816 struct mass_storage_function_config *config = f->config;
817 if (size >= sizeof(config->common->inquiry_string))
819 if (sscanf(buf, "%s", config->common->inquiry_string) != 1)
824 static DEVICE_ATTR(inquiry_string, S_IRUGO | S_IWUSR,
825 mass_storage_inquiry_show,
826 mass_storage_inquiry_store);
828 static struct device_attribute *mass_storage_function_attributes[] = {
829 &dev_attr_inquiry_string,
833 static struct android_usb_function mass_storage_function = {
834 .name = "mass_storage",
835 .init = mass_storage_function_init,
836 .cleanup = mass_storage_function_cleanup,
837 .bind_config = mass_storage_function_bind_config,
838 .attributes = mass_storage_function_attributes,
842 static int accessory_function_init(struct android_usb_function *f,
843 struct usb_composite_dev *cdev)
848 static void accessory_function_cleanup(struct android_usb_function *f)
853 static int accessory_function_bind_config(struct android_usb_function *f,
854 struct usb_configuration *c)
856 return acc_bind_config(c);
859 static int accessory_function_ctrlrequest(struct android_usb_function *f,
860 struct usb_composite_dev *cdev,
861 const struct usb_ctrlrequest *c)
863 return acc_ctrlrequest(cdev, c);
866 static struct android_usb_function accessory_function = {
868 .init = accessory_function_init,
869 .cleanup = accessory_function_cleanup,
870 .bind_config = accessory_function_bind_config,
871 .ctrlrequest = accessory_function_ctrlrequest,
874 static int audio_source_function_init(struct android_usb_function *f,
875 struct usb_composite_dev *cdev)
877 struct audio_source_config *config;
879 config = kzalloc(sizeof(struct audio_source_config), GFP_KERNEL);
888 static void audio_source_function_cleanup(struct android_usb_function *f)
893 static int audio_source_function_bind_config(struct android_usb_function *f,
894 struct usb_configuration *c)
896 struct audio_source_config *config = f->config;
898 return audio_source_bind_config(c, config);
901 static void audio_source_function_unbind_config(struct android_usb_function *f,
902 struct usb_configuration *c)
904 struct audio_source_config *config = f->config;
910 static ssize_t audio_source_pcm_show(struct device *dev,
911 struct device_attribute *attr, char *buf)
913 struct android_usb_function *f = dev_get_drvdata(dev);
914 struct audio_source_config *config = f->config;
916 /* print PCM card and device numbers */
917 return sprintf(buf, "%d %d\n", config->card, config->device);
920 static DEVICE_ATTR(pcm, S_IRUGO, audio_source_pcm_show, NULL);
922 static struct device_attribute *audio_source_function_attributes[] = {
927 static struct android_usb_function audio_source_function = {
928 .name = "audio_source",
929 .init = audio_source_function_init,
930 .cleanup = audio_source_function_cleanup,
931 .bind_config = audio_source_function_bind_config,
932 .unbind_config = audio_source_function_unbind_config,
933 .attributes = audio_source_function_attributes,
936 static struct android_usb_function *supported_functions[] = {
942 &mass_storage_function,
944 &audio_source_function,
949 static int android_init_functions(struct android_usb_function **functions,
950 struct usb_composite_dev *cdev)
952 struct android_dev *dev = _android_dev;
953 struct android_usb_function *f;
954 struct device_attribute **attrs;
955 struct device_attribute *attr;
959 for (; (f = *functions++); index++) {
960 f->dev_name = kasprintf(GFP_KERNEL, "f_%s", f->name);
961 f->dev = device_create(android_class, dev->dev,
962 MKDEV(0, index), f, f->dev_name);
963 if (IS_ERR(f->dev)) {
964 pr_err("%s: Failed to create dev %s", __func__,
966 err = PTR_ERR(f->dev);
971 err = f->init(f, cdev);
973 pr_err("%s: Failed to init %s", __func__,
979 attrs = f->attributes;
981 while ((attr = *attrs++) && !err)
982 err = device_create_file(f->dev, attr);
985 pr_err("%s: Failed to create function %s attributes",
993 device_destroy(android_class, f->dev->devt);
999 static void android_cleanup_functions(struct android_usb_function **functions)
1001 struct android_usb_function *f;
1003 while (*functions) {
1007 device_destroy(android_class, f->dev->devt);
1017 android_bind_enabled_functions(struct android_dev *dev,
1018 struct usb_configuration *c)
1020 struct android_usb_function *f;
1023 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1024 ret = f->bind_config(f, c);
1026 pr_err("%s: %s failed", __func__, f->name);
1034 android_unbind_enabled_functions(struct android_dev *dev,
1035 struct usb_configuration *c)
1037 struct android_usb_function *f;
1039 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1040 if (f->unbind_config)
1041 f->unbind_config(f, c);
1045 static int android_enable_function(struct android_dev *dev, char *name)
1047 struct android_usb_function **functions = dev->functions;
1048 struct android_usb_function *f;
1049 while ((f = *functions++)) {
1050 if (!strcmp(name, f->name)) {
1051 list_add_tail(&f->enabled_list,
1052 &dev->enabled_functions);
1059 /*-------------------------------------------------------------------------*/
1060 /* /sys/class/android_usb/android%d/ interface */
1063 functions_show(struct device *pdev, struct device_attribute *attr, char *buf)
1065 struct android_dev *dev = dev_get_drvdata(pdev);
1066 struct android_usb_function *f;
1069 mutex_lock(&dev->mutex);
1071 list_for_each_entry(f, &dev->enabled_functions, enabled_list)
1072 buff += sprintf(buff, "%s,", f->name);
1074 mutex_unlock(&dev->mutex);
1082 functions_store(struct device *pdev, struct device_attribute *attr,
1083 const char *buff, size_t size)
1085 struct android_dev *dev = dev_get_drvdata(pdev);
1088 char aliases[256], *a;
1091 int ffs_enabled = 0;
1093 mutex_lock(&dev->mutex);
1096 mutex_unlock(&dev->mutex);
1100 INIT_LIST_HEAD(&dev->enabled_functions);
1102 strlcpy(buf, buff, sizeof(buf));
1106 name = strsep(&b, ",");
1111 strlcpy(aliases, dev->ffs_aliases, sizeof(aliases));
1115 char *alias = strsep(&a, ",");
1116 if (alias && !strcmp(name, alias)) {
1125 err = android_enable_function(dev, "ffs");
1127 pr_err("android_usb: Cannot enable ffs (%d)",
1134 err = android_enable_function(dev, name);
1136 pr_err("android_usb: Cannot enable '%s' (%d)",
1140 mutex_unlock(&dev->mutex);
1145 static ssize_t enable_show(struct device *pdev, struct device_attribute *attr,
1148 struct android_dev *dev = dev_get_drvdata(pdev);
1149 return sprintf(buf, "%d\n", dev->enabled);
1152 static ssize_t enable_store(struct device *pdev, struct device_attribute *attr,
1153 const char *buff, size_t size)
1155 struct android_dev *dev = dev_get_drvdata(pdev);
1156 struct usb_composite_dev *cdev = dev->cdev;
1157 struct android_usb_function *f;
1164 mutex_lock(&dev->mutex);
1166 sscanf(buff, "%d", &enabled);
1167 if (enabled && !dev->enabled) {
1169 * Update values in composite driver's copy of
1170 * device descriptor.
1172 cdev->desc.idVendor = device_desc.idVendor;
1173 cdev->desc.idProduct = device_desc.idProduct;
1174 cdev->desc.bcdDevice = device_desc.bcdDevice;
1175 cdev->desc.bDeviceClass = device_desc.bDeviceClass;
1176 cdev->desc.bDeviceSubClass = device_desc.bDeviceSubClass;
1177 cdev->desc.bDeviceProtocol = device_desc.bDeviceProtocol;
1178 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1182 android_enable(dev);
1183 dev->enabled = true;
1184 } else if (!enabled && dev->enabled) {
1185 android_disable(dev);
1186 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1190 dev->enabled = false;
1192 pr_err("android_usb: already %s\n",
1193 dev->enabled ? "enabled" : "disabled");
1196 mutex_unlock(&dev->mutex);
1200 static ssize_t state_show(struct device *pdev, struct device_attribute *attr,
1203 struct android_dev *dev = dev_get_drvdata(pdev);
1204 struct usb_composite_dev *cdev = dev->cdev;
1205 char *state = "DISCONNECTED";
1206 unsigned long flags;
1211 spin_lock_irqsave(&cdev->lock, flags);
1213 state = "CONFIGURED";
1214 else if (dev->connected)
1215 state = "CONNECTED";
1216 spin_unlock_irqrestore(&cdev->lock, flags);
1218 return sprintf(buf, "%s\n", state);
1221 #define DESCRIPTOR_ATTR(field, format_string) \
1223 field ## _show(struct device *dev, struct device_attribute *attr, \
1226 return sprintf(buf, format_string, device_desc.field); \
1229 field ## _store(struct device *dev, struct device_attribute *attr, \
1230 const char *buf, size_t size) \
1233 if (sscanf(buf, format_string, &value) == 1) { \
1234 device_desc.field = value; \
1239 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, field ## _show, field ## _store);
1241 #define DESCRIPTOR_STRING_ATTR(field, buffer) \
1243 field ## _show(struct device *dev, struct device_attribute *attr, \
1246 return sprintf(buf, "%s", buffer); \
1249 field ## _store(struct device *dev, struct device_attribute *attr, \
1250 const char *buf, size_t size) \
1252 if (size >= sizeof(buffer)) \
1254 return strlcpy(buffer, buf, sizeof(buffer)); \
1256 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, field ## _show, field ## _store);
1259 DESCRIPTOR_ATTR(idVendor, "%04x\n")
1260 DESCRIPTOR_ATTR(idProduct, "%04x\n")
1261 DESCRIPTOR_ATTR(bcdDevice, "%04x\n")
1262 DESCRIPTOR_ATTR(bDeviceClass, "%d\n")
1263 DESCRIPTOR_ATTR(bDeviceSubClass, "%d\n")
1264 DESCRIPTOR_ATTR(bDeviceProtocol, "%d\n")
1265 DESCRIPTOR_STRING_ATTR(iManufacturer, manufacturer_string)
1266 DESCRIPTOR_STRING_ATTR(iProduct, product_string)
1267 DESCRIPTOR_STRING_ATTR(iSerial, serial_string)
1269 static DEVICE_ATTR(functions, S_IRUGO | S_IWUSR, functions_show,
1271 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, enable_show, enable_store);
1272 static DEVICE_ATTR(state, S_IRUGO, state_show, NULL);
1274 static struct device_attribute *android_usb_attributes[] = {
1276 &dev_attr_idProduct,
1277 &dev_attr_bcdDevice,
1278 &dev_attr_bDeviceClass,
1279 &dev_attr_bDeviceSubClass,
1280 &dev_attr_bDeviceProtocol,
1281 &dev_attr_iManufacturer,
1284 &dev_attr_functions,
1290 /*-------------------------------------------------------------------------*/
1291 /* Composite driver */
1293 static int android_bind_config(struct usb_configuration *c)
1295 struct android_dev *dev = _android_dev;
1298 ret = android_bind_enabled_functions(dev, c);
1305 static void android_unbind_config(struct usb_configuration *c)
1307 struct android_dev *dev = _android_dev;
1309 android_unbind_enabled_functions(dev, c);
1312 static int android_bind(struct usb_composite_dev *cdev)
1314 struct android_dev *dev = _android_dev;
1315 struct usb_gadget *gadget = cdev->gadget;
1318 /* Save the default handler */
1319 dev->setup_complete = cdev->req->complete;
1322 * Start disconnected. Userspace will connect the gadget once
1323 * it is done configuring the functions.
1325 usb_gadget_disconnect(gadget);
1327 ret = android_init_functions(dev->functions, cdev);
1331 /* Allocate string descriptor numbers ... note that string
1332 * contents can be overridden by the composite_dev glue.
1334 id = usb_string_id(cdev);
1337 strings_dev[STRING_MANUFACTURER_IDX].id = id;
1338 device_desc.iManufacturer = id;
1340 id = usb_string_id(cdev);
1343 strings_dev[STRING_PRODUCT_IDX].id = id;
1344 device_desc.iProduct = id;
1346 /* Default strings - should be updated by userspace */
1347 strncpy(manufacturer_string, "Android", sizeof(manufacturer_string)-1);
1348 strncpy(product_string, "Android", sizeof(product_string) - 1);
1349 strncpy(serial_string, "0123456789ABCDEF", sizeof(serial_string) - 1);
1351 id = usb_string_id(cdev);
1354 strings_dev[STRING_SERIAL_IDX].id = id;
1355 device_desc.iSerialNumber = id;
1357 usb_gadget_set_selfpowered(gadget);
1363 static int android_usb_unbind(struct usb_composite_dev *cdev)
1365 struct android_dev *dev = _android_dev;
1367 cancel_work_sync(&dev->work);
1368 android_cleanup_functions(dev->functions);
1372 /* HACK: android needs to override setup for accessory to work */
1373 static int (*composite_setup_func)(struct usb_gadget *gadget, const struct usb_ctrlrequest *c);
1376 android_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *c)
1378 struct android_dev *dev = _android_dev;
1379 struct usb_composite_dev *cdev = get_gadget_data(gadget);
1380 struct usb_request *req = cdev->req;
1381 struct android_usb_function *f;
1382 int value = -EOPNOTSUPP;
1383 unsigned long flags;
1387 req->complete = dev->setup_complete;
1388 gadget->ep0->driver_data = cdev;
1390 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1391 if (f->ctrlrequest) {
1392 value = f->ctrlrequest(f, cdev, c);
1398 /* Special case the accessory function.
1399 * It needs to handle control requests before it is enabled.
1402 value = acc_ctrlrequest(cdev, c);
1405 value = composite_setup_func(gadget, c);
1407 spin_lock_irqsave(&cdev->lock, flags);
1408 if (!dev->connected) {
1410 schedule_work(&dev->work);
1411 } else if (c->bRequest == USB_REQ_SET_CONFIGURATION &&
1413 schedule_work(&dev->work);
1415 spin_unlock_irqrestore(&cdev->lock, flags);
1420 static void android_disconnect(struct usb_composite_dev *cdev)
1422 struct android_dev *dev = _android_dev;
1424 /* accessory HID support can be active while the
1425 accessory function is not actually enabled,
1426 so we need to inform it when we are disconnected.
1431 schedule_work(&dev->work);
1434 static struct usb_composite_driver android_usb_driver = {
1435 .name = "android_usb",
1436 .dev = &device_desc,
1437 .strings = dev_strings,
1438 .bind = android_bind,
1439 .unbind = android_usb_unbind,
1440 .disconnect = android_disconnect,
1441 .max_speed = USB_SPEED_HIGH,
1444 static int android_create_device(struct android_dev *dev)
1446 struct device_attribute **attrs = android_usb_attributes;
1447 struct device_attribute *attr;
1450 dev->dev = device_create(android_class, NULL,
1451 MKDEV(0, 0), NULL, "android0");
1452 if (IS_ERR(dev->dev))
1453 return PTR_ERR(dev->dev);
1455 dev_set_drvdata(dev->dev, dev);
1457 while ((attr = *attrs++)) {
1458 err = device_create_file(dev->dev, attr);
1460 device_destroy(android_class, dev->dev->devt);
1468 static int __init init(void)
1470 struct android_dev *dev;
1473 android_class = class_create(THIS_MODULE, "android_usb");
1474 if (IS_ERR(android_class))
1475 return PTR_ERR(android_class);
1477 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1483 dev->disable_depth = 1;
1484 dev->functions = supported_functions;
1485 INIT_LIST_HEAD(&dev->enabled_functions);
1486 INIT_WORK(&dev->work, android_work);
1487 mutex_init(&dev->mutex);
1489 err = android_create_device(dev);
1491 pr_err("%s: failed to create android device %d", __func__, err);
1497 err = usb_composite_probe(&android_usb_driver);
1499 pr_err("%s: failed to probe driver %d", __func__, err);
1503 /* HACK: exchange composite's setup with ours */
1504 composite_setup_func = android_usb_driver.gadget_driver.setup;
1505 android_usb_driver.gadget_driver.setup = android_setup;
1510 device_destroy(android_class, dev->dev->devt);
1514 class_destroy(android_class);
1517 late_initcall(init);
1519 static void __exit cleanup(void)
1521 usb_composite_unregister(&android_usb_driver);
1522 class_destroy(android_class);
1523 kfree(_android_dev);
1524 _android_dev = NULL;
1526 module_exit(cleanup);