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 0x2207
52 #define PRODUCT_ID 0x2910
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;
98 struct work_struct work;
99 char ffs_aliases[256];
102 static struct class *android_class;
103 static struct android_dev *_android_dev;
104 static int android_bind_config(struct usb_configuration *c);
105 static void android_unbind_config(struct usb_configuration *c);
107 /* string IDs are assigned dynamically */
108 #define STRING_MANUFACTURER_IDX 0
109 #define STRING_PRODUCT_IDX 1
110 #define STRING_SERIAL_IDX 2
112 static char manufacturer_string[256];
113 static char product_string[256];
114 static char serial_string[256];
117 static struct usb_string strings_dev[] = {
118 [STRING_MANUFACTURER_IDX].s = manufacturer_string,
119 [STRING_PRODUCT_IDX].s = product_string,
120 [STRING_SERIAL_IDX].s = serial_string,
121 { } /* end of list */
124 static struct usb_gadget_strings stringtab_dev = {
125 .language = 0x0409, /* en-us */
126 .strings = strings_dev,
129 static struct usb_gadget_strings *dev_strings[] = {
134 static struct usb_device_descriptor device_desc = {
135 .bLength = sizeof(device_desc),
136 .bDescriptorType = USB_DT_DEVICE,
137 .bcdUSB = __constant_cpu_to_le16(0x0200),
138 .bDeviceClass = USB_CLASS_PER_INTERFACE,
139 .idVendor = __constant_cpu_to_le16(VENDOR_ID),
140 .idProduct = __constant_cpu_to_le16(PRODUCT_ID),
141 .bcdDevice = __constant_cpu_to_le16(0xffff),
142 .bNumConfigurations = 1,
145 static struct usb_configuration android_config_driver = {
147 .unbind = android_unbind_config,
148 .bConfigurationValue = 1,
149 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
150 .MaxPower = 500, /* 500ma */
153 static void android_work(struct work_struct *data)
155 struct android_dev *dev = container_of(data, struct android_dev, work);
156 struct usb_composite_dev *cdev = dev->cdev;
157 char *disconnected[2] = { "USB_STATE=DISCONNECTED", NULL };
158 char *connected[2] = { "USB_STATE=CONNECTED", NULL };
159 char *configured[2] = { "USB_STATE=CONFIGURED", NULL };
160 char **uevent_envp = NULL;
163 spin_lock_irqsave(&cdev->lock, flags);
165 uevent_envp = configured;
166 else if (dev->connected != dev->sw_connected)
167 uevent_envp = dev->connected ? connected : disconnected;
168 dev->sw_connected = dev->connected;
169 spin_unlock_irqrestore(&cdev->lock, flags);
172 kobject_uevent_env(&dev->dev->kobj, KOBJ_CHANGE, uevent_envp);
173 pr_info("%s: sent uevent %s\n", __func__, uevent_envp[0]);
175 pr_info("%s: did not send uevent (%d %d %p)\n", __func__,
176 dev->connected, dev->sw_connected, cdev->config);
180 static void android_enable(struct android_dev *dev)
182 struct usb_composite_dev *cdev = dev->cdev;
184 if (WARN_ON(!dev->disable_depth))
187 if (--dev->disable_depth == 0) {
188 usb_add_config(cdev, &android_config_driver,
189 android_bind_config);
190 usb_gadget_connect(cdev->gadget);
194 static void android_disable(struct android_dev *dev)
196 struct usb_composite_dev *cdev = dev->cdev;
198 if (dev->disable_depth++ == 0) {
199 usb_gadget_disconnect(cdev->gadget);
200 /* Cancel pending control requests */
201 usb_ep_dequeue(cdev->gadget->ep0, cdev->req);
202 usb_remove_config(cdev, &android_config_driver);
206 /*-------------------------------------------------------------------------*/
207 /* Supported functions initialization */
209 struct functionfs_config {
212 struct ffs_data *data;
215 static int ffs_function_init(struct android_usb_function *f,
216 struct usb_composite_dev *cdev)
218 f->config = kzalloc(sizeof(struct functionfs_config), GFP_KERNEL);
222 return functionfs_init();
225 static void ffs_function_cleanup(struct android_usb_function *f)
227 functionfs_cleanup();
231 static void ffs_function_enable(struct android_usb_function *f)
233 struct android_dev *dev = _android_dev;
234 struct functionfs_config *config = f->config;
236 config->enabled = true;
238 /* Disable the gadget until the function is ready */
240 android_disable(dev);
243 static void ffs_function_disable(struct android_usb_function *f)
245 struct android_dev *dev = _android_dev;
246 struct functionfs_config *config = f->config;
248 config->enabled = false;
250 /* Balance the disable that was called in closed_callback */
255 static int ffs_function_bind_config(struct android_usb_function *f,
256 struct usb_configuration *c)
258 struct functionfs_config *config = f->config;
259 return functionfs_bind_config(c->cdev, c, config->data);
263 ffs_aliases_show(struct device *pdev, struct device_attribute *attr, char *buf)
265 struct android_dev *dev = _android_dev;
268 mutex_lock(&dev->mutex);
269 ret = sprintf(buf, "%s\n", dev->ffs_aliases);
270 mutex_unlock(&dev->mutex);
276 ffs_aliases_store(struct device *pdev, struct device_attribute *attr,
277 const char *buf, size_t size)
279 struct android_dev *dev = _android_dev;
282 mutex_lock(&dev->mutex);
285 mutex_unlock(&dev->mutex);
289 strlcpy(buff, buf, sizeof(buff));
290 strlcpy(dev->ffs_aliases, strim(buff), sizeof(dev->ffs_aliases));
292 mutex_unlock(&dev->mutex);
297 static DEVICE_ATTR(aliases, S_IRUGO | S_IWUSR, ffs_aliases_show,
299 static struct device_attribute *ffs_function_attributes[] = {
304 static struct android_usb_function ffs_function = {
306 .init = ffs_function_init,
307 .enable = ffs_function_enable,
308 .disable = ffs_function_disable,
309 .cleanup = ffs_function_cleanup,
310 .bind_config = ffs_function_bind_config,
311 .attributes = ffs_function_attributes,
314 static int functionfs_ready_callback(struct ffs_data *ffs)
316 struct android_dev *dev = _android_dev;
317 struct functionfs_config *config = ffs_function.config;
320 mutex_lock(&dev->mutex);
322 ret = functionfs_bind(ffs, dev->cdev);
327 config->opened = true;
333 mutex_unlock(&dev->mutex);
337 static void functionfs_closed_callback(struct ffs_data *ffs)
339 struct android_dev *dev = _android_dev;
340 struct functionfs_config *config = ffs_function.config;
342 mutex_lock(&dev->mutex);
345 android_disable(dev);
347 config->opened = false;
350 functionfs_unbind(ffs);
352 mutex_unlock(&dev->mutex);
355 static void *functionfs_acquire_dev_callback(const char *dev_name)
360 static void functionfs_release_dev_callback(struct ffs_data *ffs_data)
364 #define MAX_ACM_INSTANCES 4
365 struct acm_function_config {
368 struct usb_function *f_acm[MAX_ACM_INSTANCES];
369 struct usb_function_instance *f_acm_inst[MAX_ACM_INSTANCES];
373 acm_function_init(struct android_usb_function *f,
374 struct usb_composite_dev *cdev)
378 struct acm_function_config *config;
380 config = kzalloc(sizeof(struct acm_function_config), GFP_KERNEL);
385 for (i = 0; i < MAX_ACM_INSTANCES; i++) {
386 config->f_acm_inst[i] = usb_get_function_instance("acm");
387 if (IS_ERR(config->f_acm_inst[i])) {
388 ret = PTR_ERR(config->f_acm_inst[i]);
389 goto err_usb_get_function_instance;
391 config->f_acm[i] = usb_get_function(config->f_acm_inst[i]);
392 if (IS_ERR(config->f_acm[i])) {
393 ret = PTR_ERR(config->f_acm[i]);
394 goto err_usb_get_function;
398 err_usb_get_function_instance:
400 usb_put_function(config->f_acm[i]);
401 err_usb_get_function:
402 usb_put_function_instance(config->f_acm_inst[i]);
407 static void acm_function_cleanup(struct android_usb_function *f)
410 struct acm_function_config *config = f->config;
412 for (i = 0; i < MAX_ACM_INSTANCES; i++) {
413 usb_put_function(config->f_acm[i]);
414 usb_put_function_instance(config->f_acm_inst[i]);
421 acm_function_bind_config(struct android_usb_function *f,
422 struct usb_configuration *c)
426 struct acm_function_config *config = f->config;
428 config->instances_on = config->instances;
429 for (i = 0; i < config->instances_on; i++) {
430 ret = usb_add_function(c, config->f_acm[i]);
432 pr_err("Could not bind acm%u config\n", i);
433 goto err_usb_add_function;
439 err_usb_add_function:
441 usb_remove_function(c, config->f_acm[i]);
445 static void acm_function_unbind_config(struct android_usb_function *f,
446 struct usb_configuration *c)
449 struct acm_function_config *config = f->config;
451 for (i = 0; i < config->instances_on; i++)
452 usb_remove_function(c, config->f_acm[i]);
455 static ssize_t acm_instances_show(struct device *dev,
456 struct device_attribute *attr, char *buf)
458 struct android_usb_function *f = dev_get_drvdata(dev);
459 struct acm_function_config *config = f->config;
460 return sprintf(buf, "%d\n", config->instances);
463 static ssize_t acm_instances_store(struct device *dev,
464 struct device_attribute *attr, const char *buf, size_t size)
466 struct android_usb_function *f = dev_get_drvdata(dev);
467 struct acm_function_config *config = f->config;
470 sscanf(buf, "%d", &value);
471 if (value > MAX_ACM_INSTANCES)
472 value = MAX_ACM_INSTANCES;
473 config->instances = value;
477 static DEVICE_ATTR(instances, S_IRUGO | S_IWUSR, acm_instances_show,
478 acm_instances_store);
479 static struct device_attribute *acm_function_attributes[] = {
484 static struct android_usb_function acm_function = {
486 .init = acm_function_init,
487 .cleanup = acm_function_cleanup,
488 .bind_config = acm_function_bind_config,
489 .unbind_config = acm_function_unbind_config,
490 .attributes = acm_function_attributes,
495 mtp_function_init(struct android_usb_function *f,
496 struct usb_composite_dev *cdev)
501 static void mtp_function_cleanup(struct android_usb_function *f)
507 mtp_function_bind_config(struct android_usb_function *f,
508 struct usb_configuration *c)
510 return mtp_bind_config(c, false);
514 ptp_function_init(struct android_usb_function *f,
515 struct usb_composite_dev *cdev)
517 /* nothing to do - initialization is handled by mtp_function_init */
521 static void ptp_function_cleanup(struct android_usb_function *f)
523 /* nothing to do - cleanup is handled by mtp_function_cleanup */
527 ptp_function_bind_config(struct android_usb_function *f,
528 struct usb_configuration *c)
530 return mtp_bind_config(c, true);
533 static int mtp_function_ctrlrequest(struct android_usb_function *f,
534 struct usb_composite_dev *cdev,
535 const struct usb_ctrlrequest *c)
537 return mtp_ctrlrequest(cdev, c);
540 static struct android_usb_function mtp_function = {
542 .init = mtp_function_init,
543 .cleanup = mtp_function_cleanup,
544 .bind_config = mtp_function_bind_config,
545 .ctrlrequest = mtp_function_ctrlrequest,
548 /* PTP function is same as MTP with slightly different interface descriptor */
549 static struct android_usb_function ptp_function = {
551 .init = ptp_function_init,
552 .cleanup = ptp_function_cleanup,
553 .bind_config = ptp_function_bind_config,
557 struct rndis_function_config {
558 u8 ethaddr[ETH_ALEN];
560 char manufacturer[256];
561 /* "Wireless" RNDIS; auto-detected by Windows */
567 rndis_function_init(struct android_usb_function *f,
568 struct usb_composite_dev *cdev)
570 f->config = kzalloc(sizeof(struct rndis_function_config), GFP_KERNEL);
576 static void rndis_function_cleanup(struct android_usb_function *f)
583 rndis_function_bind_config(struct android_usb_function *f,
584 struct usb_configuration *c)
588 struct rndis_function_config *rndis = f->config;
591 pr_err("%s: rndis_pdata\n", __func__);
595 pr_info("%s MAC: %02X:%02X:%02X:%02X:%02X:%02X\n", __func__,
596 rndis->ethaddr[0], rndis->ethaddr[1], rndis->ethaddr[2],
597 rndis->ethaddr[3], rndis->ethaddr[4], rndis->ethaddr[5]);
599 dev = gether_setup_name(c->cdev->gadget, rndis->ethaddr, "rndis");
602 pr_err("%s: gether_setup failed\n", __func__);
608 /* "Wireless" RNDIS; auto-detected by Windows */
609 rndis_iad_descriptor.bFunctionClass =
610 USB_CLASS_WIRELESS_CONTROLLER;
611 rndis_iad_descriptor.bFunctionSubClass = 0x01;
612 rndis_iad_descriptor.bFunctionProtocol = 0x03;
613 rndis_control_intf.bInterfaceClass =
614 USB_CLASS_WIRELESS_CONTROLLER;
615 rndis_control_intf.bInterfaceSubClass = 0x01;
616 rndis_control_intf.bInterfaceProtocol = 0x03;
619 return rndis_bind_config_vendor(c, rndis->ethaddr, rndis->vendorID,
620 rndis->manufacturer, rndis->dev);
623 static void rndis_function_unbind_config(struct android_usb_function *f,
624 struct usb_configuration *c)
626 struct rndis_function_config *rndis = f->config;
627 gether_cleanup(rndis->dev);
630 static ssize_t rndis_manufacturer_show(struct device *dev,
631 struct device_attribute *attr, char *buf)
633 struct android_usb_function *f = dev_get_drvdata(dev);
634 struct rndis_function_config *config = f->config;
635 return sprintf(buf, "%s\n", config->manufacturer);
638 static ssize_t rndis_manufacturer_store(struct device *dev,
639 struct device_attribute *attr, const char *buf, size_t size)
641 struct android_usb_function *f = dev_get_drvdata(dev);
642 struct rndis_function_config *config = f->config;
644 if (size >= sizeof(config->manufacturer))
646 if (sscanf(buf, "%s", config->manufacturer) == 1)
651 static DEVICE_ATTR(manufacturer, S_IRUGO | S_IWUSR, rndis_manufacturer_show,
652 rndis_manufacturer_store);
654 static ssize_t rndis_wceis_show(struct device *dev,
655 struct device_attribute *attr, char *buf)
657 struct android_usb_function *f = dev_get_drvdata(dev);
658 struct rndis_function_config *config = f->config;
659 return sprintf(buf, "%d\n", config->wceis);
662 static ssize_t rndis_wceis_store(struct device *dev,
663 struct device_attribute *attr, const char *buf, size_t size)
665 struct android_usb_function *f = dev_get_drvdata(dev);
666 struct rndis_function_config *config = f->config;
669 if (sscanf(buf, "%d", &value) == 1) {
670 config->wceis = value;
676 static DEVICE_ATTR(wceis, S_IRUGO | S_IWUSR, rndis_wceis_show,
679 static ssize_t rndis_ethaddr_show(struct device *dev,
680 struct device_attribute *attr, char *buf)
682 struct android_usb_function *f = dev_get_drvdata(dev);
683 struct rndis_function_config *rndis = f->config;
684 return sprintf(buf, "%02x:%02x:%02x:%02x:%02x:%02x\n",
685 rndis->ethaddr[0], rndis->ethaddr[1], rndis->ethaddr[2],
686 rndis->ethaddr[3], rndis->ethaddr[4], rndis->ethaddr[5]);
689 static ssize_t rndis_ethaddr_store(struct device *dev,
690 struct device_attribute *attr, const char *buf, size_t size)
692 struct android_usb_function *f = dev_get_drvdata(dev);
693 struct rndis_function_config *rndis = f->config;
695 if (sscanf(buf, "%02x:%02x:%02x:%02x:%02x:%02x\n",
696 (int *)&rndis->ethaddr[0], (int *)&rndis->ethaddr[1],
697 (int *)&rndis->ethaddr[2], (int *)&rndis->ethaddr[3],
698 (int *)&rndis->ethaddr[4], (int *)&rndis->ethaddr[5]) == 6)
703 static DEVICE_ATTR(ethaddr, S_IRUGO | S_IWUSR, rndis_ethaddr_show,
704 rndis_ethaddr_store);
706 static ssize_t rndis_vendorID_show(struct device *dev,
707 struct device_attribute *attr, char *buf)
709 struct android_usb_function *f = dev_get_drvdata(dev);
710 struct rndis_function_config *config = f->config;
711 return sprintf(buf, "%04x\n", config->vendorID);
714 static ssize_t rndis_vendorID_store(struct device *dev,
715 struct device_attribute *attr, const char *buf, size_t size)
717 struct android_usb_function *f = dev_get_drvdata(dev);
718 struct rndis_function_config *config = f->config;
721 if (sscanf(buf, "%04x", &value) == 1) {
722 config->vendorID = value;
728 static DEVICE_ATTR(vendorID, S_IRUGO | S_IWUSR, rndis_vendorID_show,
729 rndis_vendorID_store);
731 static struct device_attribute *rndis_function_attributes[] = {
732 &dev_attr_manufacturer,
739 static struct android_usb_function rndis_function = {
741 .init = rndis_function_init,
742 .cleanup = rndis_function_cleanup,
743 .bind_config = rndis_function_bind_config,
744 .unbind_config = rndis_function_unbind_config,
745 .attributes = rndis_function_attributes,
749 struct mass_storage_function_config {
750 struct fsg_config fsg;
751 struct fsg_common *common;
754 static int mass_storage_function_init(struct android_usb_function *f,
755 struct usb_composite_dev *cdev)
757 struct mass_storage_function_config *config;
758 struct fsg_common *common;
761 config = kzalloc(sizeof(struct mass_storage_function_config),
766 config->fsg.nluns = 2;
767 config->fsg.luns[0].removable = 1;
768 config->fsg.luns[1].removable = 1;
770 common = fsg_common_init(NULL, cdev, &config->fsg);
771 if (IS_ERR(common)) {
773 return PTR_ERR(common);
776 err = sysfs_create_link(&f->dev->kobj,
777 &common->luns[0].dev.kobj,
779 err = sysfs_create_link(&f->dev->kobj,
780 &common->luns[1].dev.kobj,
787 config->common = common;
792 static void mass_storage_function_cleanup(struct android_usb_function *f)
798 static int mass_storage_function_bind_config(struct android_usb_function *f,
799 struct usb_configuration *c)
801 struct mass_storage_function_config *config = f->config;
802 return fsg_bind_config(c->cdev, c, config->common);
805 static ssize_t mass_storage_inquiry_show(struct device *dev,
806 struct device_attribute *attr, char *buf)
808 struct android_usb_function *f = dev_get_drvdata(dev);
809 struct mass_storage_function_config *config = f->config;
810 return sprintf(buf, "%s\n", config->common->inquiry_string);
813 static ssize_t mass_storage_inquiry_store(struct device *dev,
814 struct device_attribute *attr, const char *buf, size_t size)
816 struct android_usb_function *f = dev_get_drvdata(dev);
817 struct mass_storage_function_config *config = f->config;
818 if (size >= sizeof(config->common->inquiry_string))
820 if (sscanf(buf, "%s", config->common->inquiry_string) != 1)
825 static DEVICE_ATTR(inquiry_string, S_IRUGO | S_IWUSR,
826 mass_storage_inquiry_show,
827 mass_storage_inquiry_store);
829 static struct device_attribute *mass_storage_function_attributes[] = {
830 &dev_attr_inquiry_string,
834 static struct android_usb_function mass_storage_function = {
835 .name = "mass_storage",
836 .init = mass_storage_function_init,
837 .cleanup = mass_storage_function_cleanup,
838 .bind_config = mass_storage_function_bind_config,
839 .attributes = mass_storage_function_attributes,
843 static int accessory_function_init(struct android_usb_function *f,
844 struct usb_composite_dev *cdev)
849 static void accessory_function_cleanup(struct android_usb_function *f)
854 static int accessory_function_bind_config(struct android_usb_function *f,
855 struct usb_configuration *c)
857 return acc_bind_config(c);
860 static int accessory_function_ctrlrequest(struct android_usb_function *f,
861 struct usb_composite_dev *cdev,
862 const struct usb_ctrlrequest *c)
864 return acc_ctrlrequest(cdev, c);
867 static struct android_usb_function accessory_function = {
869 .init = accessory_function_init,
870 .cleanup = accessory_function_cleanup,
871 .bind_config = accessory_function_bind_config,
872 .ctrlrequest = accessory_function_ctrlrequest,
875 static int audio_source_function_init(struct android_usb_function *f,
876 struct usb_composite_dev *cdev)
878 struct audio_source_config *config;
880 config = kzalloc(sizeof(struct audio_source_config), GFP_KERNEL);
889 static void audio_source_function_cleanup(struct android_usb_function *f)
894 static int audio_source_function_bind_config(struct android_usb_function *f,
895 struct usb_configuration *c)
897 struct audio_source_config *config = f->config;
899 return audio_source_bind_config(c, config);
902 static void audio_source_function_unbind_config(struct android_usb_function *f,
903 struct usb_configuration *c)
905 struct audio_source_config *config = f->config;
911 static ssize_t audio_source_pcm_show(struct device *dev,
912 struct device_attribute *attr, char *buf)
914 struct android_usb_function *f = dev_get_drvdata(dev);
915 struct audio_source_config *config = f->config;
917 /* print PCM card and device numbers */
918 return sprintf(buf, "%d %d\n", config->card, config->device);
921 static DEVICE_ATTR(pcm, S_IRUGO, audio_source_pcm_show, NULL);
923 static struct device_attribute *audio_source_function_attributes[] = {
928 static struct android_usb_function audio_source_function = {
929 .name = "audio_source",
930 .init = audio_source_function_init,
931 .cleanup = audio_source_function_cleanup,
932 .bind_config = audio_source_function_bind_config,
933 .unbind_config = audio_source_function_unbind_config,
934 .attributes = audio_source_function_attributes,
937 static struct android_usb_function *supported_functions[] = {
943 &mass_storage_function,
945 &audio_source_function,
950 static int android_init_functions(struct android_usb_function **functions,
951 struct usb_composite_dev *cdev)
953 struct android_dev *dev = _android_dev;
954 struct android_usb_function *f;
955 struct device_attribute **attrs;
956 struct device_attribute *attr;
960 for (; (f = *functions++); index++) {
961 f->dev_name = kasprintf(GFP_KERNEL, "f_%s", f->name);
962 f->dev = device_create(android_class, dev->dev,
963 MKDEV(0, index), f, f->dev_name);
964 if (IS_ERR(f->dev)) {
965 pr_err("%s: Failed to create dev %s", __func__,
967 err = PTR_ERR(f->dev);
972 err = f->init(f, cdev);
974 pr_err("%s: Failed to init %s", __func__,
980 attrs = f->attributes;
982 while ((attr = *attrs++) && !err)
983 err = device_create_file(f->dev, attr);
986 pr_err("%s: Failed to create function %s attributes",
994 device_destroy(android_class, f->dev->devt);
1000 static void android_cleanup_functions(struct android_usb_function **functions)
1002 struct android_usb_function *f;
1004 while (*functions) {
1008 device_destroy(android_class, f->dev->devt);
1018 android_bind_enabled_functions(struct android_dev *dev,
1019 struct usb_configuration *c)
1021 struct android_usb_function *f;
1024 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1025 ret = f->bind_config(f, c);
1027 pr_err("%s: %s failed", __func__, f->name);
1035 android_unbind_enabled_functions(struct android_dev *dev,
1036 struct usb_configuration *c)
1038 struct android_usb_function *f;
1040 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1041 if (f->unbind_config)
1042 f->unbind_config(f, c);
1046 static int android_enable_function(struct android_dev *dev, char *name)
1048 struct android_usb_function **functions = dev->functions;
1049 struct android_usb_function *f;
1050 while ((f = *functions++)) {
1051 if (!strcmp(name, f->name)) {
1052 list_add_tail(&f->enabled_list,
1053 &dev->enabled_functions);
1060 /*-------------------------------------------------------------------------*/
1061 /* /sys/class/android_usb/android%d/ interface */
1064 functions_show(struct device *pdev, struct device_attribute *attr, char *buf)
1066 struct android_dev *dev = dev_get_drvdata(pdev);
1067 struct android_usb_function *f;
1070 mutex_lock(&dev->mutex);
1072 list_for_each_entry(f, &dev->enabled_functions, enabled_list)
1073 buff += sprintf(buff, "%s,", f->name);
1075 mutex_unlock(&dev->mutex);
1083 functions_store(struct device *pdev, struct device_attribute *attr,
1084 const char *buff, size_t size)
1086 struct android_dev *dev = dev_get_drvdata(pdev);
1089 char aliases[256], *a;
1092 int ffs_enabled = 0;
1094 mutex_lock(&dev->mutex);
1097 mutex_unlock(&dev->mutex);
1101 INIT_LIST_HEAD(&dev->enabled_functions);
1103 strlcpy(buf, buff, sizeof(buf));
1107 name = strsep(&b, ",");
1112 strlcpy(aliases, dev->ffs_aliases, sizeof(aliases));
1116 char *alias = strsep(&a, ",");
1117 if (alias && !strcmp(name, alias)) {
1126 err = android_enable_function(dev, "ffs");
1128 pr_err("android_usb: Cannot enable ffs (%d)",
1135 err = android_enable_function(dev, name);
1137 pr_err("android_usb: Cannot enable '%s' (%d)",
1141 mutex_unlock(&dev->mutex);
1146 static ssize_t enable_show(struct device *pdev, struct device_attribute *attr,
1149 struct android_dev *dev = dev_get_drvdata(pdev);
1150 return sprintf(buf, "%d\n", dev->enabled);
1153 static ssize_t enable_store(struct device *pdev, struct device_attribute *attr,
1154 const char *buff, size_t size)
1156 struct android_dev *dev = dev_get_drvdata(pdev);
1157 struct usb_composite_dev *cdev = dev->cdev;
1158 struct android_usb_function *f;
1165 mutex_lock(&dev->mutex);
1167 sscanf(buff, "%d", &enabled);
1168 if (enabled && !dev->enabled) {
1170 * Update values in composite driver's copy of
1171 * device descriptor.
1173 cdev->desc.idVendor = device_desc.idVendor;
1174 cdev->desc.idProduct = device_desc.idProduct;
1175 cdev->desc.bcdDevice = device_desc.bcdDevice;
1176 cdev->desc.bDeviceClass = device_desc.bDeviceClass;
1177 cdev->desc.bDeviceSubClass = device_desc.bDeviceSubClass;
1178 cdev->desc.bDeviceProtocol = device_desc.bDeviceProtocol;
1179 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1183 android_enable(dev);
1184 dev->enabled = true;
1185 } else if (!enabled && dev->enabled) {
1186 android_disable(dev);
1187 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1191 dev->enabled = false;
1193 pr_err("android_usb: already %s\n",
1194 dev->enabled ? "enabled" : "disabled");
1197 mutex_unlock(&dev->mutex);
1201 static ssize_t state_show(struct device *pdev, struct device_attribute *attr,
1204 struct android_dev *dev = dev_get_drvdata(pdev);
1205 struct usb_composite_dev *cdev = dev->cdev;
1206 char *state = "DISCONNECTED";
1207 unsigned long flags;
1212 spin_lock_irqsave(&cdev->lock, flags);
1214 state = "CONFIGURED";
1215 else if (dev->connected)
1216 state = "CONNECTED";
1217 spin_unlock_irqrestore(&cdev->lock, flags);
1219 return sprintf(buf, "%s\n", state);
1222 #define DESCRIPTOR_ATTR(field, format_string) \
1224 field ## _show(struct device *dev, struct device_attribute *attr, \
1227 return sprintf(buf, format_string, device_desc.field); \
1230 field ## _store(struct device *dev, struct device_attribute *attr, \
1231 const char *buf, size_t size) \
1234 if (sscanf(buf, format_string, &value) == 1) { \
1235 device_desc.field = value; \
1240 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, field ## _show, field ## _store);
1242 #define DESCRIPTOR_STRING_ATTR(field, buffer) \
1244 field ## _show(struct device *dev, struct device_attribute *attr, \
1247 return sprintf(buf, "%s", buffer); \
1250 field ## _store(struct device *dev, struct device_attribute *attr, \
1251 const char *buf, size_t size) \
1253 if (size >= sizeof(buffer)) \
1255 return strlcpy(buffer, buf, sizeof(buffer)); \
1257 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, field ## _show, field ## _store);
1260 DESCRIPTOR_ATTR(idVendor, "%04x\n")
1261 DESCRIPTOR_ATTR(idProduct, "%04x\n")
1262 DESCRIPTOR_ATTR(bcdDevice, "%04x\n")
1263 DESCRIPTOR_ATTR(bDeviceClass, "%d\n")
1264 DESCRIPTOR_ATTR(bDeviceSubClass, "%d\n")
1265 DESCRIPTOR_ATTR(bDeviceProtocol, "%d\n")
1266 DESCRIPTOR_STRING_ATTR(iManufacturer, manufacturer_string)
1267 DESCRIPTOR_STRING_ATTR(iProduct, product_string)
1268 DESCRIPTOR_STRING_ATTR(iSerial, serial_string)
1270 static DEVICE_ATTR(functions, S_IRUGO | S_IWUSR, functions_show,
1272 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, enable_show, enable_store);
1273 static DEVICE_ATTR(state, S_IRUGO, state_show, NULL);
1275 static struct device_attribute *android_usb_attributes[] = {
1277 &dev_attr_idProduct,
1278 &dev_attr_bcdDevice,
1279 &dev_attr_bDeviceClass,
1280 &dev_attr_bDeviceSubClass,
1281 &dev_attr_bDeviceProtocol,
1282 &dev_attr_iManufacturer,
1285 &dev_attr_functions,
1291 /*-------------------------------------------------------------------------*/
1292 /* Composite driver */
1294 static int android_bind_config(struct usb_configuration *c)
1296 struct android_dev *dev = _android_dev;
1299 ret = android_bind_enabled_functions(dev, c);
1306 static void android_unbind_config(struct usb_configuration *c)
1308 struct android_dev *dev = _android_dev;
1310 android_unbind_enabled_functions(dev, c);
1313 static int android_bind(struct usb_composite_dev *cdev)
1315 struct android_dev *dev = _android_dev;
1316 struct usb_gadget *gadget = cdev->gadget;
1320 * Start disconnected. Userspace will connect the gadget once
1321 * it is done configuring the functions.
1323 usb_gadget_disconnect(gadget);
1325 ret = android_init_functions(dev->functions, cdev);
1329 /* Allocate string descriptor numbers ... note that string
1330 * contents can be overridden by the composite_dev glue.
1332 id = usb_string_id(cdev);
1335 strings_dev[STRING_MANUFACTURER_IDX].id = id;
1336 device_desc.iManufacturer = id;
1338 id = usb_string_id(cdev);
1341 strings_dev[STRING_PRODUCT_IDX].id = id;
1342 device_desc.iProduct = id;
1344 /* Default strings - should be updated by userspace */
1345 strncpy(manufacturer_string, "Android", sizeof(manufacturer_string)-1);
1346 strncpy(product_string, "Android", sizeof(product_string) - 1);
1347 strncpy(serial_string, "0123456789ABCDEF", sizeof(serial_string) - 1);
1349 id = usb_string_id(cdev);
1352 strings_dev[STRING_SERIAL_IDX].id = id;
1353 device_desc.iSerialNumber = id;
1354 device_desc.bcdDevice = cpu_to_le16(get_default_bcdDevice());
1356 usb_gadget_set_selfpowered(gadget);
1362 static int android_usb_unbind(struct usb_composite_dev *cdev)
1364 struct android_dev *dev = _android_dev;
1366 cancel_work_sync(&dev->work);
1367 android_cleanup_functions(dev->functions);
1371 /* HACK: android needs to override setup for accessory to work */
1372 static int (*composite_setup_func)(struct usb_gadget *gadget, const struct usb_ctrlrequest *c);
1375 android_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *c)
1377 struct android_dev *dev = _android_dev;
1378 struct usb_composite_dev *cdev = get_gadget_data(gadget);
1379 struct usb_request *req = cdev->req;
1380 struct android_usb_function *f;
1381 int value = -EOPNOTSUPP;
1382 unsigned long flags;
1386 gadget->ep0->driver_data = cdev;
1388 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1389 if (f->ctrlrequest) {
1390 value = f->ctrlrequest(f, cdev, c);
1396 /* Special case the accessory function.
1397 * It needs to handle control requests before it is enabled.
1400 value = acc_ctrlrequest(cdev, c);
1403 value = composite_setup_func(gadget, c);
1405 spin_lock_irqsave(&cdev->lock, flags);
1406 if (!dev->connected) {
1408 schedule_work(&dev->work);
1409 } else if (c->bRequest == USB_REQ_SET_CONFIGURATION &&
1411 schedule_work(&dev->work);
1413 spin_unlock_irqrestore(&cdev->lock, flags);
1418 static void android_disconnect(struct usb_composite_dev *cdev)
1420 struct android_dev *dev = _android_dev;
1422 /* accessory HID support can be active while the
1423 accessory function is not actually enabled,
1424 so we need to inform it when we are disconnected.
1429 schedule_work(&dev->work);
1432 static struct usb_composite_driver android_usb_driver = {
1433 .name = "android_usb",
1434 .dev = &device_desc,
1435 .strings = dev_strings,
1436 .bind = android_bind,
1437 .unbind = android_usb_unbind,
1438 .disconnect = android_disconnect,
1439 .max_speed = USB_SPEED_HIGH,
1442 static int android_create_device(struct android_dev *dev)
1444 struct device_attribute **attrs = android_usb_attributes;
1445 struct device_attribute *attr;
1448 dev->dev = device_create(android_class, NULL,
1449 MKDEV(0, 0), NULL, "android0");
1450 if (IS_ERR(dev->dev))
1451 return PTR_ERR(dev->dev);
1453 dev_set_drvdata(dev->dev, dev);
1455 while ((attr = *attrs++)) {
1456 err = device_create_file(dev->dev, attr);
1458 device_destroy(android_class, dev->dev->devt);
1466 static int __init init(void)
1468 struct android_dev *dev;
1471 android_class = class_create(THIS_MODULE, "android_usb");
1472 if (IS_ERR(android_class))
1473 return PTR_ERR(android_class);
1475 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1481 dev->disable_depth = 1;
1482 dev->functions = supported_functions;
1483 INIT_LIST_HEAD(&dev->enabled_functions);
1484 INIT_WORK(&dev->work, android_work);
1485 mutex_init(&dev->mutex);
1487 err = android_create_device(dev);
1489 pr_err("%s: failed to create android device %d", __func__, err);
1495 err = usb_composite_probe(&android_usb_driver);
1497 pr_err("%s: failed to probe driver %d", __func__, err);
1501 /* HACK: exchange composite's setup with ours */
1502 composite_setup_func = android_usb_driver.gadget_driver.setup;
1503 android_usb_driver.gadget_driver.setup = android_setup;
1508 device_destroy(android_class, dev->dev->devt);
1512 class_destroy(android_class);
1515 late_initcall(init);
1517 static void __exit cleanup(void)
1519 usb_composite_unregister(&android_usb_driver);
1520 class_destroy(android_class);
1521 kfree(_android_dev);
1522 _android_dev = NULL;
1524 module_exit(cleanup);