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 if (!WARN_ON(!ffs->gadget)) {
351 dev->cdev->next_string_id -= ffs->strings_count;
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;
765 config = kzalloc(sizeof(struct mass_storage_function_config),
770 config->fsg.nluns = 2;
773 for (i = 0; i < config->fsg.nluns; i++) {
774 config->fsg.luns[i].removable = 1;
775 config->fsg.luns[i].nofua = 1;
778 common = fsg_common_init(NULL, cdev, &config->fsg);
779 if (IS_ERR(common)) {
781 return PTR_ERR(common);
784 for (i = 0; i < config->fsg.nluns; i++) {
785 err = sysfs_create_link(&f->dev->kobj,
786 &common->luns[i].dev.kobj,
792 config->common = common;
797 sysfs_remove_link(&f->dev->kobj, name[i-1]);
798 fsg_common_release(&common->ref);
803 static void mass_storage_function_cleanup(struct android_usb_function *f)
809 static int mass_storage_function_bind_config(struct android_usb_function *f,
810 struct usb_configuration *c)
812 struct mass_storage_function_config *config = f->config;
813 return fsg_bind_config(c->cdev, c, config->common);
816 static ssize_t mass_storage_inquiry_show(struct device *dev,
817 struct device_attribute *attr, char *buf)
819 struct android_usb_function *f = dev_get_drvdata(dev);
820 struct mass_storage_function_config *config = f->config;
821 return sprintf(buf, "%s\n", config->common->inquiry_string);
824 static ssize_t mass_storage_inquiry_store(struct device *dev,
825 struct device_attribute *attr, const char *buf, size_t size)
827 struct android_usb_function *f = dev_get_drvdata(dev);
828 struct mass_storage_function_config *config = f->config;
829 if (size >= sizeof(config->common->inquiry_string))
831 if (sscanf(buf, "%s", config->common->inquiry_string) != 1)
836 static DEVICE_ATTR(inquiry_string, S_IRUGO | S_IWUSR,
837 mass_storage_inquiry_show,
838 mass_storage_inquiry_store);
840 static struct device_attribute *mass_storage_function_attributes[] = {
841 &dev_attr_inquiry_string,
845 static struct android_usb_function mass_storage_function = {
846 .name = "mass_storage",
847 .init = mass_storage_function_init,
848 .cleanup = mass_storage_function_cleanup,
849 .bind_config = mass_storage_function_bind_config,
850 .attributes = mass_storage_function_attributes,
854 static int accessory_function_init(struct android_usb_function *f,
855 struct usb_composite_dev *cdev)
860 static void accessory_function_cleanup(struct android_usb_function *f)
865 static int accessory_function_bind_config(struct android_usb_function *f,
866 struct usb_configuration *c)
868 return acc_bind_config(c);
871 static int accessory_function_ctrlrequest(struct android_usb_function *f,
872 struct usb_composite_dev *cdev,
873 const struct usb_ctrlrequest *c)
875 return acc_ctrlrequest(cdev, c);
878 static struct android_usb_function accessory_function = {
880 .init = accessory_function_init,
881 .cleanup = accessory_function_cleanup,
882 .bind_config = accessory_function_bind_config,
883 .ctrlrequest = accessory_function_ctrlrequest,
886 static int audio_source_function_init(struct android_usb_function *f,
887 struct usb_composite_dev *cdev)
889 struct audio_source_config *config;
891 config = kzalloc(sizeof(struct audio_source_config), GFP_KERNEL);
900 static void audio_source_function_cleanup(struct android_usb_function *f)
905 static int audio_source_function_bind_config(struct android_usb_function *f,
906 struct usb_configuration *c)
908 struct audio_source_config *config = f->config;
910 return audio_source_bind_config(c, config);
913 static void audio_source_function_unbind_config(struct android_usb_function *f,
914 struct usb_configuration *c)
916 struct audio_source_config *config = f->config;
922 static ssize_t audio_source_pcm_show(struct device *dev,
923 struct device_attribute *attr, char *buf)
925 struct android_usb_function *f = dev_get_drvdata(dev);
926 struct audio_source_config *config = f->config;
928 /* print PCM card and device numbers */
929 return sprintf(buf, "%d %d\n", config->card, config->device);
932 static DEVICE_ATTR(pcm, S_IRUGO, audio_source_pcm_show, NULL);
934 static struct device_attribute *audio_source_function_attributes[] = {
939 static struct android_usb_function audio_source_function = {
940 .name = "audio_source",
941 .init = audio_source_function_init,
942 .cleanup = audio_source_function_cleanup,
943 .bind_config = audio_source_function_bind_config,
944 .unbind_config = audio_source_function_unbind_config,
945 .attributes = audio_source_function_attributes,
948 static struct android_usb_function *supported_functions[] = {
954 &mass_storage_function,
956 &audio_source_function,
961 static int android_init_functions(struct android_usb_function **functions,
962 struct usb_composite_dev *cdev)
964 struct android_dev *dev = _android_dev;
965 struct android_usb_function *f;
966 struct device_attribute **attrs;
967 struct device_attribute *attr;
971 for (; (f = *functions++); index++) {
972 f->dev_name = kasprintf(GFP_KERNEL, "f_%s", f->name);
973 f->dev = device_create(android_class, dev->dev,
974 MKDEV(0, index), f, f->dev_name);
975 if (IS_ERR(f->dev)) {
976 pr_err("%s: Failed to create dev %s", __func__,
978 err = PTR_ERR(f->dev);
983 err = f->init(f, cdev);
985 pr_err("%s: Failed to init %s", __func__,
991 attrs = f->attributes;
993 while ((attr = *attrs++) && !err)
994 err = device_create_file(f->dev, attr);
997 pr_err("%s: Failed to create function %s attributes",
1005 device_destroy(android_class, f->dev->devt);
1011 static void android_cleanup_functions(struct android_usb_function **functions)
1013 struct android_usb_function *f;
1015 while (*functions) {
1019 device_destroy(android_class, f->dev->devt);
1029 android_bind_enabled_functions(struct android_dev *dev,
1030 struct usb_configuration *c)
1032 struct android_usb_function *f;
1035 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1036 ret = f->bind_config(f, c);
1038 pr_err("%s: %s failed", __func__, f->name);
1046 android_unbind_enabled_functions(struct android_dev *dev,
1047 struct usb_configuration *c)
1049 struct android_usb_function *f;
1051 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1052 if (f->unbind_config)
1053 f->unbind_config(f, c);
1057 static int android_enable_function(struct android_dev *dev, char *name)
1059 struct android_usb_function **functions = dev->functions;
1060 struct android_usb_function *f;
1061 while ((f = *functions++)) {
1062 if (!strcmp(name, f->name)) {
1063 list_add_tail(&f->enabled_list,
1064 &dev->enabled_functions);
1071 /*-------------------------------------------------------------------------*/
1072 /* /sys/class/android_usb/android%d/ interface */
1075 functions_show(struct device *pdev, struct device_attribute *attr, char *buf)
1077 struct android_dev *dev = dev_get_drvdata(pdev);
1078 struct android_usb_function *f;
1081 mutex_lock(&dev->mutex);
1083 list_for_each_entry(f, &dev->enabled_functions, enabled_list)
1084 buff += sprintf(buff, "%s,", f->name);
1086 mutex_unlock(&dev->mutex);
1094 functions_store(struct device *pdev, struct device_attribute *attr,
1095 const char *buff, size_t size)
1097 struct android_dev *dev = dev_get_drvdata(pdev);
1100 char aliases[256], *a;
1103 int ffs_enabled = 0;
1105 mutex_lock(&dev->mutex);
1108 mutex_unlock(&dev->mutex);
1112 INIT_LIST_HEAD(&dev->enabled_functions);
1114 strlcpy(buf, buff, sizeof(buf));
1118 name = strsep(&b, ",");
1123 strlcpy(aliases, dev->ffs_aliases, sizeof(aliases));
1127 char *alias = strsep(&a, ",");
1128 if (alias && !strcmp(name, alias)) {
1137 err = android_enable_function(dev, "ffs");
1139 pr_err("android_usb: Cannot enable ffs (%d)",
1146 err = android_enable_function(dev, name);
1148 pr_err("android_usb: Cannot enable '%s' (%d)",
1152 mutex_unlock(&dev->mutex);
1157 static ssize_t enable_show(struct device *pdev, struct device_attribute *attr,
1160 struct android_dev *dev = dev_get_drvdata(pdev);
1161 return sprintf(buf, "%d\n", dev->enabled);
1164 static ssize_t enable_store(struct device *pdev, struct device_attribute *attr,
1165 const char *buff, size_t size)
1167 struct android_dev *dev = dev_get_drvdata(pdev);
1168 struct usb_composite_dev *cdev = dev->cdev;
1169 struct android_usb_function *f;
1176 mutex_lock(&dev->mutex);
1178 sscanf(buff, "%d", &enabled);
1179 if (enabled && !dev->enabled) {
1181 * Update values in composite driver's copy of
1182 * device descriptor.
1184 cdev->desc.idVendor = device_desc.idVendor;
1185 cdev->desc.idProduct = device_desc.idProduct;
1186 cdev->desc.bcdDevice = device_desc.bcdDevice;
1187 cdev->desc.bDeviceClass = device_desc.bDeviceClass;
1188 cdev->desc.bDeviceSubClass = device_desc.bDeviceSubClass;
1189 cdev->desc.bDeviceProtocol = device_desc.bDeviceProtocol;
1190 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1194 android_enable(dev);
1195 dev->enabled = true;
1196 } else if (!enabled && dev->enabled) {
1197 android_disable(dev);
1198 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1202 dev->enabled = false;
1204 pr_err("android_usb: already %s\n",
1205 dev->enabled ? "enabled" : "disabled");
1208 mutex_unlock(&dev->mutex);
1212 static ssize_t state_show(struct device *pdev, struct device_attribute *attr,
1215 struct android_dev *dev = dev_get_drvdata(pdev);
1216 struct usb_composite_dev *cdev = dev->cdev;
1217 char *state = "DISCONNECTED";
1218 unsigned long flags;
1223 spin_lock_irqsave(&cdev->lock, flags);
1225 state = "CONFIGURED";
1226 else if (dev->connected)
1227 state = "CONNECTED";
1228 spin_unlock_irqrestore(&cdev->lock, flags);
1230 return sprintf(buf, "%s\n", state);
1233 #define DESCRIPTOR_ATTR(field, format_string) \
1235 field ## _show(struct device *dev, struct device_attribute *attr, \
1238 return sprintf(buf, format_string, device_desc.field); \
1241 field ## _store(struct device *dev, struct device_attribute *attr, \
1242 const char *buf, size_t size) \
1245 if (sscanf(buf, format_string, &value) == 1) { \
1246 device_desc.field = value; \
1251 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, field ## _show, field ## _store);
1253 #define DESCRIPTOR_STRING_ATTR(field, buffer) \
1255 field ## _show(struct device *dev, struct device_attribute *attr, \
1258 return sprintf(buf, "%s", buffer); \
1261 field ## _store(struct device *dev, struct device_attribute *attr, \
1262 const char *buf, size_t size) \
1264 if (size >= sizeof(buffer)) \
1266 return strlcpy(buffer, buf, sizeof(buffer)); \
1268 static DEVICE_ATTR(field, S_IRUGO | S_IWUSR, field ## _show, field ## _store);
1271 DESCRIPTOR_ATTR(idVendor, "%04x\n")
1272 DESCRIPTOR_ATTR(idProduct, "%04x\n")
1273 DESCRIPTOR_ATTR(bcdDevice, "%04x\n")
1274 DESCRIPTOR_ATTR(bDeviceClass, "%d\n")
1275 DESCRIPTOR_ATTR(bDeviceSubClass, "%d\n")
1276 DESCRIPTOR_ATTR(bDeviceProtocol, "%d\n")
1277 DESCRIPTOR_STRING_ATTR(iManufacturer, manufacturer_string)
1278 DESCRIPTOR_STRING_ATTR(iProduct, product_string)
1279 DESCRIPTOR_STRING_ATTR(iSerial, serial_string)
1281 static DEVICE_ATTR(functions, S_IRUGO | S_IWUSR, functions_show,
1283 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, enable_show, enable_store);
1284 static DEVICE_ATTR(state, S_IRUGO, state_show, NULL);
1286 static struct device_attribute *android_usb_attributes[] = {
1288 &dev_attr_idProduct,
1289 &dev_attr_bcdDevice,
1290 &dev_attr_bDeviceClass,
1291 &dev_attr_bDeviceSubClass,
1292 &dev_attr_bDeviceProtocol,
1293 &dev_attr_iManufacturer,
1296 &dev_attr_functions,
1302 /*-------------------------------------------------------------------------*/
1303 /* Composite driver */
1305 static int android_bind_config(struct usb_configuration *c)
1307 struct android_dev *dev = _android_dev;
1310 ret = android_bind_enabled_functions(dev, c);
1317 static void android_unbind_config(struct usb_configuration *c)
1319 struct android_dev *dev = _android_dev;
1321 android_unbind_enabled_functions(dev, c);
1324 static int android_bind(struct usb_composite_dev *cdev)
1326 struct android_dev *dev = _android_dev;
1327 struct usb_gadget *gadget = cdev->gadget;
1331 * Start disconnected. Userspace will connect the gadget once
1332 * it is done configuring the functions.
1334 usb_gadget_disconnect(gadget);
1336 ret = android_init_functions(dev->functions, cdev);
1340 /* Allocate string descriptor numbers ... note that string
1341 * contents can be overridden by the composite_dev glue.
1343 id = usb_string_id(cdev);
1346 strings_dev[STRING_MANUFACTURER_IDX].id = id;
1347 device_desc.iManufacturer = id;
1349 id = usb_string_id(cdev);
1352 strings_dev[STRING_PRODUCT_IDX].id = id;
1353 device_desc.iProduct = id;
1355 /* Default strings - should be updated by userspace */
1356 strncpy(manufacturer_string, "Android", sizeof(manufacturer_string)-1);
1357 strncpy(product_string, "Android", sizeof(product_string) - 1);
1358 strncpy(serial_string, "0123456789ABCDEF", sizeof(serial_string) - 1);
1360 id = usb_string_id(cdev);
1363 strings_dev[STRING_SERIAL_IDX].id = id;
1364 device_desc.iSerialNumber = id;
1365 device_desc.bcdDevice = cpu_to_le16(get_default_bcdDevice());
1367 usb_gadget_set_selfpowered(gadget);
1373 static int android_usb_unbind(struct usb_composite_dev *cdev)
1375 struct android_dev *dev = _android_dev;
1377 cancel_work_sync(&dev->work);
1378 android_cleanup_functions(dev->functions);
1382 /* HACK: android needs to override setup for accessory to work */
1383 static int (*composite_setup_func)(struct usb_gadget *gadget, const struct usb_ctrlrequest *c);
1386 android_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *c)
1388 struct android_dev *dev = _android_dev;
1389 struct usb_composite_dev *cdev = get_gadget_data(gadget);
1390 struct usb_request *req = cdev->req;
1391 struct android_usb_function *f;
1392 int value = -EOPNOTSUPP;
1393 unsigned long flags;
1397 gadget->ep0->driver_data = cdev;
1399 list_for_each_entry(f, &dev->enabled_functions, enabled_list) {
1400 if (f->ctrlrequest) {
1401 value = f->ctrlrequest(f, cdev, c);
1407 /* Special case the accessory function.
1408 * It needs to handle control requests before it is enabled.
1411 value = acc_ctrlrequest(cdev, c);
1414 value = composite_setup_func(gadget, c);
1416 spin_lock_irqsave(&cdev->lock, flags);
1417 if (!dev->connected) {
1419 schedule_work(&dev->work);
1420 } else if (c->bRequest == USB_REQ_SET_CONFIGURATION &&
1422 schedule_work(&dev->work);
1424 spin_unlock_irqrestore(&cdev->lock, flags);
1429 static void android_disconnect(struct usb_composite_dev *cdev)
1431 struct android_dev *dev = _android_dev;
1433 /* accessory HID support can be active while the
1434 accessory function is not actually enabled,
1435 so we need to inform it when we are disconnected.
1440 schedule_work(&dev->work);
1443 static struct usb_composite_driver android_usb_driver = {
1444 .name = "android_usb",
1445 .dev = &device_desc,
1446 .strings = dev_strings,
1447 .bind = android_bind,
1448 .unbind = android_usb_unbind,
1449 .disconnect = android_disconnect,
1450 .max_speed = USB_SPEED_HIGH,
1453 static int android_create_device(struct android_dev *dev)
1455 struct device_attribute **attrs = android_usb_attributes;
1456 struct device_attribute *attr;
1459 dev->dev = device_create(android_class, NULL,
1460 MKDEV(0, 0), NULL, "android0");
1461 if (IS_ERR(dev->dev))
1462 return PTR_ERR(dev->dev);
1464 dev_set_drvdata(dev->dev, dev);
1466 while ((attr = *attrs++)) {
1467 err = device_create_file(dev->dev, attr);
1469 device_destroy(android_class, dev->dev->devt);
1477 static int __init init(void)
1479 struct android_dev *dev;
1482 android_class = class_create(THIS_MODULE, "android_usb");
1483 if (IS_ERR(android_class))
1484 return PTR_ERR(android_class);
1486 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1492 dev->disable_depth = 1;
1493 dev->functions = supported_functions;
1494 INIT_LIST_HEAD(&dev->enabled_functions);
1495 INIT_WORK(&dev->work, android_work);
1496 mutex_init(&dev->mutex);
1498 err = android_create_device(dev);
1500 pr_err("%s: failed to create android device %d", __func__, err);
1506 err = usb_composite_probe(&android_usb_driver);
1508 pr_err("%s: failed to probe driver %d", __func__, err);
1512 /* HACK: exchange composite's setup with ours */
1513 composite_setup_func = android_usb_driver.gadget_driver.setup;
1514 android_usb_driver.gadget_driver.setup = android_setup;
1519 device_destroy(android_class, dev->dev->devt);
1523 class_destroy(android_class);
1526 late_initcall(init);
1528 static void __exit cleanup(void)
1530 usb_composite_unregister(&android_usb_driver);
1531 class_destroy(android_class);
1532 kfree(_android_dev);
1533 _android_dev = NULL;
1535 module_exit(cleanup);