1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/configfs.h>
3 #include <linux/module.h>
4 #include <linux/slab.h>
5 #include <linux/device.h>
7 #include <linux/usb/composite.h>
8 #include <linux/usb/gadget_configfs.h>
11 #include "u_os_desc.h"
13 int check_user_usb_string(const char *name,
14 struct usb_gadget_strings *stringtab_dev)
19 ret = kstrtou16(name, 0, &num);
23 if (!usb_validate_langid(num))
26 stringtab_dev->language = num;
30 #define MAX_NAME_LEN 40
31 #define MAX_USB_STRING_LANGS 2
33 static const struct usb_descriptor_header *otg_desc[2];
36 struct config_group group;
37 struct config_group functions_group;
38 struct config_group configs_group;
39 struct config_group strings_group;
40 struct config_group os_desc_group;
43 struct usb_gadget_strings *gstrings[MAX_USB_STRING_LANGS + 1];
44 struct list_head string_list;
45 struct list_head available_func;
47 struct usb_composite_driver composite;
48 struct usb_composite_dev cdev;
51 char qw_sign[OS_STRING_QW_SIGN_LEN];
56 static inline struct gadget_info *to_gadget_info(struct config_item *item)
58 return container_of(to_config_group(item), struct gadget_info, group);
61 struct config_usb_cfg {
62 struct config_group group;
63 struct config_group strings_group;
64 struct list_head string_list;
65 struct usb_configuration c;
66 struct list_head func_list;
67 struct usb_gadget_strings *gstrings[MAX_USB_STRING_LANGS + 1];
70 static inline struct config_usb_cfg *to_config_usb_cfg(struct config_item *item)
72 return container_of(to_config_group(item), struct config_usb_cfg,
76 static inline struct gadget_info *cfg_to_gadget_info(struct config_usb_cfg *cfg)
78 return container_of(cfg->c.cdev, struct gadget_info, cdev);
81 struct gadget_strings {
82 struct usb_gadget_strings stringtab_dev;
83 struct usb_string strings[USB_GADGET_FIRST_AVAIL_IDX];
88 struct config_group group;
89 struct list_head list;
92 struct gadget_config_name {
93 struct usb_gadget_strings stringtab_dev;
94 struct usb_string strings;
97 struct config_group group;
98 struct list_head list;
101 #define USB_MAX_STRING_WITH_NULL_LEN (USB_MAX_STRING_LEN+1)
103 static int usb_string_copy(const char *s, char **s_copy)
107 char *copy = *s_copy;
109 if (ret > USB_MAX_STRING_LEN)
115 str = kmalloc(USB_MAX_STRING_WITH_NULL_LEN, GFP_KERNEL);
120 if (str[ret - 1] == '\n')
126 #define GI_DEVICE_DESC_SIMPLE_R_u8(__name) \
127 static ssize_t gadget_dev_desc_##__name##_show(struct config_item *item, \
130 return sprintf(page, "0x%02x\n", \
131 to_gadget_info(item)->cdev.desc.__name); \
134 #define GI_DEVICE_DESC_SIMPLE_R_u16(__name) \
135 static ssize_t gadget_dev_desc_##__name##_show(struct config_item *item, \
138 return sprintf(page, "0x%04x\n", \
139 le16_to_cpup(&to_gadget_info(item)->cdev.desc.__name)); \
143 #define GI_DEVICE_DESC_SIMPLE_W_u8(_name) \
144 static ssize_t gadget_dev_desc_##_name##_store(struct config_item *item, \
145 const char *page, size_t len) \
149 ret = kstrtou8(page, 0, &val); \
152 to_gadget_info(item)->cdev.desc._name = val; \
156 #define GI_DEVICE_DESC_SIMPLE_W_u16(_name) \
157 static ssize_t gadget_dev_desc_##_name##_store(struct config_item *item, \
158 const char *page, size_t len) \
162 ret = kstrtou16(page, 0, &val); \
165 to_gadget_info(item)->cdev.desc._name = cpu_to_le16p(&val); \
169 #define GI_DEVICE_DESC_SIMPLE_RW(_name, _type) \
170 GI_DEVICE_DESC_SIMPLE_R_##_type(_name) \
171 GI_DEVICE_DESC_SIMPLE_W_##_type(_name)
173 GI_DEVICE_DESC_SIMPLE_R_u16(bcdUSB);
174 GI_DEVICE_DESC_SIMPLE_RW(bDeviceClass, u8);
175 GI_DEVICE_DESC_SIMPLE_RW(bDeviceSubClass, u8);
176 GI_DEVICE_DESC_SIMPLE_RW(bDeviceProtocol, u8);
177 GI_DEVICE_DESC_SIMPLE_RW(bMaxPacketSize0, u8);
178 GI_DEVICE_DESC_SIMPLE_RW(idVendor, u16);
179 GI_DEVICE_DESC_SIMPLE_RW(idProduct, u16);
180 GI_DEVICE_DESC_SIMPLE_R_u16(bcdDevice);
182 static ssize_t is_valid_bcd(u16 bcd_val)
184 if ((bcd_val & 0xf) > 9)
186 if (((bcd_val >> 4) & 0xf) > 9)
188 if (((bcd_val >> 8) & 0xf) > 9)
190 if (((bcd_val >> 12) & 0xf) > 9)
195 static ssize_t gadget_dev_desc_bcdDevice_store(struct config_item *item,
196 const char *page, size_t len)
201 ret = kstrtou16(page, 0, &bcdDevice);
204 ret = is_valid_bcd(bcdDevice);
208 to_gadget_info(item)->cdev.desc.bcdDevice = cpu_to_le16(bcdDevice);
212 static ssize_t gadget_dev_desc_bcdUSB_store(struct config_item *item,
213 const char *page, size_t len)
218 ret = kstrtou16(page, 0, &bcdUSB);
221 ret = is_valid_bcd(bcdUSB);
225 to_gadget_info(item)->cdev.desc.bcdUSB = cpu_to_le16(bcdUSB);
229 static ssize_t gadget_dev_desc_UDC_show(struct config_item *item, char *page)
231 struct gadget_info *gi = to_gadget_info(item);
235 mutex_lock(&gi->lock);
236 udc_name = gi->composite.gadget_driver.udc_name;
237 ret = sprintf(page, "%s\n", udc_name ?: "");
238 mutex_unlock(&gi->lock);
243 static int unregister_gadget(struct gadget_info *gi)
247 if (!gi->composite.gadget_driver.udc_name)
250 ret = usb_gadget_unregister_driver(&gi->composite.gadget_driver);
253 kfree(gi->composite.gadget_driver.udc_name);
254 gi->composite.gadget_driver.udc_name = NULL;
258 static ssize_t gadget_dev_desc_UDC_store(struct config_item *item,
259 const char *page, size_t len)
261 struct gadget_info *gi = to_gadget_info(item);
265 if (strlen(page) < len)
268 name = kstrdup(page, GFP_KERNEL);
271 if (name[len - 1] == '\n')
272 name[len - 1] = '\0';
274 mutex_lock(&gi->lock);
277 ret = unregister_gadget(gi);
282 if (gi->composite.gadget_driver.udc_name) {
286 gi->composite.gadget_driver.udc_name = name;
287 ret = usb_gadget_probe_driver(&gi->composite.gadget_driver);
289 gi->composite.gadget_driver.udc_name = NULL;
293 mutex_unlock(&gi->lock);
297 mutex_unlock(&gi->lock);
301 static ssize_t gadget_dev_desc_max_speed_show(struct config_item *item,
304 enum usb_device_speed speed = to_gadget_info(item)->composite.max_speed;
306 return sprintf(page, "%s\n", usb_speed_string(speed));
309 static ssize_t gadget_dev_desc_max_speed_store(struct config_item *item,
310 const char *page, size_t len)
312 struct gadget_info *gi = to_gadget_info(item);
314 mutex_lock(&gi->lock);
316 /* Prevent changing of max_speed after the driver is binded */
317 if (gi->composite.gadget_driver.udc_name)
320 if (strncmp(page, "super-speed-plus", 16) == 0)
321 gi->composite.max_speed = USB_SPEED_SUPER_PLUS;
322 else if (strncmp(page, "super-speed", 11) == 0)
323 gi->composite.max_speed = USB_SPEED_SUPER;
324 else if (strncmp(page, "high-speed", 10) == 0)
325 gi->composite.max_speed = USB_SPEED_HIGH;
326 else if (strncmp(page, "full-speed", 10) == 0)
327 gi->composite.max_speed = USB_SPEED_FULL;
328 else if (strncmp(page, "low-speed", 9) == 0)
329 gi->composite.max_speed = USB_SPEED_LOW;
333 gi->composite.gadget_driver.max_speed = gi->composite.max_speed;
335 mutex_unlock(&gi->lock);
338 mutex_unlock(&gi->lock);
342 CONFIGFS_ATTR(gadget_dev_desc_, bDeviceClass);
343 CONFIGFS_ATTR(gadget_dev_desc_, bDeviceSubClass);
344 CONFIGFS_ATTR(gadget_dev_desc_, bDeviceProtocol);
345 CONFIGFS_ATTR(gadget_dev_desc_, bMaxPacketSize0);
346 CONFIGFS_ATTR(gadget_dev_desc_, idVendor);
347 CONFIGFS_ATTR(gadget_dev_desc_, idProduct);
348 CONFIGFS_ATTR(gadget_dev_desc_, bcdDevice);
349 CONFIGFS_ATTR(gadget_dev_desc_, bcdUSB);
350 CONFIGFS_ATTR(gadget_dev_desc_, UDC);
351 CONFIGFS_ATTR(gadget_dev_desc_, max_speed);
353 static struct configfs_attribute *gadget_root_attrs[] = {
354 &gadget_dev_desc_attr_bDeviceClass,
355 &gadget_dev_desc_attr_bDeviceSubClass,
356 &gadget_dev_desc_attr_bDeviceProtocol,
357 &gadget_dev_desc_attr_bMaxPacketSize0,
358 &gadget_dev_desc_attr_idVendor,
359 &gadget_dev_desc_attr_idProduct,
360 &gadget_dev_desc_attr_bcdDevice,
361 &gadget_dev_desc_attr_bcdUSB,
362 &gadget_dev_desc_attr_UDC,
363 &gadget_dev_desc_attr_max_speed,
367 static inline struct gadget_strings *to_gadget_strings(struct config_item *item)
369 return container_of(to_config_group(item), struct gadget_strings,
373 static inline struct gadget_config_name *to_gadget_config_name(
374 struct config_item *item)
376 return container_of(to_config_group(item), struct gadget_config_name,
380 static inline struct usb_function_instance *to_usb_function_instance(
381 struct config_item *item)
383 return container_of(to_config_group(item),
384 struct usb_function_instance, group);
387 static void gadget_info_attr_release(struct config_item *item)
389 struct gadget_info *gi = to_gadget_info(item);
391 WARN_ON(!list_empty(&gi->cdev.configs));
392 WARN_ON(!list_empty(&gi->string_list));
393 WARN_ON(!list_empty(&gi->available_func));
394 kfree(gi->composite.gadget_driver.function);
398 static struct configfs_item_operations gadget_root_item_ops = {
399 .release = gadget_info_attr_release,
402 static void gadget_config_attr_release(struct config_item *item)
404 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
406 WARN_ON(!list_empty(&cfg->c.functions));
407 list_del(&cfg->c.list);
412 static int config_usb_cfg_link(
413 struct config_item *usb_cfg_ci,
414 struct config_item *usb_func_ci)
416 struct config_usb_cfg *cfg = to_config_usb_cfg(usb_cfg_ci);
417 struct gadget_info *gi = cfg_to_gadget_info(cfg);
419 struct usb_function_instance *fi =
420 to_usb_function_instance(usb_func_ci);
421 struct usb_function_instance *a_fi;
422 struct usb_function *f;
425 mutex_lock(&gi->lock);
427 * Make sure this function is from within our _this_ gadget and not
428 * from another gadget or a random directory.
429 * Also a function instance can only be linked once.
431 list_for_each_entry(a_fi, &gi->available_func, cfs_list) {
440 list_for_each_entry(f, &cfg->func_list, list) {
447 f = usb_get_function(fi);
453 /* stash the function until we bind it to the gadget */
454 list_add_tail(&f->list, &cfg->func_list);
457 mutex_unlock(&gi->lock);
461 static void config_usb_cfg_unlink(
462 struct config_item *usb_cfg_ci,
463 struct config_item *usb_func_ci)
465 struct config_usb_cfg *cfg = to_config_usb_cfg(usb_cfg_ci);
466 struct gadget_info *gi = cfg_to_gadget_info(cfg);
468 struct usb_function_instance *fi =
469 to_usb_function_instance(usb_func_ci);
470 struct usb_function *f;
473 * ideally I would like to forbid to unlink functions while a gadget is
474 * bound to an UDC. Since this isn't possible at the moment, we simply
475 * force an unbind, the function is available here and then we can
476 * remove the function.
478 mutex_lock(&gi->lock);
479 if (gi->composite.gadget_driver.udc_name)
480 unregister_gadget(gi);
481 WARN_ON(gi->composite.gadget_driver.udc_name);
483 list_for_each_entry(f, &cfg->func_list, list) {
487 mutex_unlock(&gi->lock);
491 mutex_unlock(&gi->lock);
492 WARN(1, "Unable to locate function to unbind\n");
495 static struct configfs_item_operations gadget_config_item_ops = {
496 .release = gadget_config_attr_release,
497 .allow_link = config_usb_cfg_link,
498 .drop_link = config_usb_cfg_unlink,
502 static ssize_t gadget_config_desc_MaxPower_show(struct config_item *item,
505 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
507 return sprintf(page, "%u\n", cfg->c.MaxPower);
510 static ssize_t gadget_config_desc_MaxPower_store(struct config_item *item,
511 const char *page, size_t len)
513 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
516 ret = kstrtou16(page, 0, &val);
519 if (DIV_ROUND_UP(val, 8) > 0xff)
521 cfg->c.MaxPower = val;
525 static ssize_t gadget_config_desc_bmAttributes_show(struct config_item *item,
528 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
530 return sprintf(page, "0x%02x\n", cfg->c.bmAttributes);
533 static ssize_t gadget_config_desc_bmAttributes_store(struct config_item *item,
534 const char *page, size_t len)
536 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
539 ret = kstrtou8(page, 0, &val);
542 if (!(val & USB_CONFIG_ATT_ONE))
544 if (val & ~(USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER |
545 USB_CONFIG_ATT_WAKEUP))
547 cfg->c.bmAttributes = val;
551 CONFIGFS_ATTR(gadget_config_desc_, MaxPower);
552 CONFIGFS_ATTR(gadget_config_desc_, bmAttributes);
554 static struct configfs_attribute *gadget_config_attrs[] = {
555 &gadget_config_desc_attr_MaxPower,
556 &gadget_config_desc_attr_bmAttributes,
560 static const struct config_item_type gadget_config_type = {
561 .ct_item_ops = &gadget_config_item_ops,
562 .ct_attrs = gadget_config_attrs,
563 .ct_owner = THIS_MODULE,
566 static const struct config_item_type gadget_root_type = {
567 .ct_item_ops = &gadget_root_item_ops,
568 .ct_attrs = gadget_root_attrs,
569 .ct_owner = THIS_MODULE,
572 static void composite_init_dev(struct usb_composite_dev *cdev)
574 spin_lock_init(&cdev->lock);
575 INIT_LIST_HEAD(&cdev->configs);
576 INIT_LIST_HEAD(&cdev->gstrings);
579 static struct config_group *function_make(
580 struct config_group *group,
583 struct gadget_info *gi;
584 struct usb_function_instance *fi;
585 char buf[MAX_NAME_LEN];
590 ret = snprintf(buf, MAX_NAME_LEN, "%s", name);
591 if (ret >= MAX_NAME_LEN)
592 return ERR_PTR(-ENAMETOOLONG);
595 instance_name = strchr(func_name, '.');
596 if (!instance_name) {
597 pr_err("Unable to locate . in FUNC.INSTANCE\n");
598 return ERR_PTR(-EINVAL);
600 *instance_name = '\0';
603 fi = usb_get_function_instance(func_name);
607 ret = config_item_set_name(&fi->group.cg_item, "%s", name);
609 usb_put_function_instance(fi);
612 if (fi->set_inst_name) {
613 ret = fi->set_inst_name(fi, instance_name);
615 usb_put_function_instance(fi);
620 gi = container_of(group, struct gadget_info, functions_group);
622 mutex_lock(&gi->lock);
623 list_add_tail(&fi->cfs_list, &gi->available_func);
624 mutex_unlock(&gi->lock);
628 static void function_drop(
629 struct config_group *group,
630 struct config_item *item)
632 struct usb_function_instance *fi = to_usb_function_instance(item);
633 struct gadget_info *gi;
635 gi = container_of(group, struct gadget_info, functions_group);
637 mutex_lock(&gi->lock);
638 list_del(&fi->cfs_list);
639 mutex_unlock(&gi->lock);
640 config_item_put(item);
643 static struct configfs_group_operations functions_ops = {
644 .make_group = &function_make,
645 .drop_item = &function_drop,
648 static const struct config_item_type functions_type = {
649 .ct_group_ops = &functions_ops,
650 .ct_owner = THIS_MODULE,
653 GS_STRINGS_RW(gadget_config_name, configuration);
655 static struct configfs_attribute *gadget_config_name_langid_attrs[] = {
656 &gadget_config_name_attr_configuration,
660 static void gadget_config_name_attr_release(struct config_item *item)
662 struct gadget_config_name *cn = to_gadget_config_name(item);
664 kfree(cn->configuration);
670 USB_CONFIG_STRING_RW_OPS(gadget_config_name);
671 USB_CONFIG_STRINGS_LANG(gadget_config_name, config_usb_cfg);
673 static struct config_group *config_desc_make(
674 struct config_group *group,
677 struct gadget_info *gi;
678 struct config_usb_cfg *cfg;
679 char buf[MAX_NAME_LEN];
684 gi = container_of(group, struct gadget_info, configs_group);
685 ret = snprintf(buf, MAX_NAME_LEN, "%s", name);
686 if (ret >= MAX_NAME_LEN)
687 return ERR_PTR(-ENAMETOOLONG);
689 num_str = strchr(buf, '.');
691 pr_err("Unable to locate . in name.bConfigurationValue\n");
692 return ERR_PTR(-EINVAL);
699 return ERR_PTR(-EINVAL);
701 ret = kstrtou8(num_str, 0, &num);
705 cfg = kzalloc(sizeof(*cfg), GFP_KERNEL);
707 return ERR_PTR(-ENOMEM);
708 cfg->c.label = kstrdup(buf, GFP_KERNEL);
713 cfg->c.bConfigurationValue = num;
714 cfg->c.MaxPower = CONFIG_USB_GADGET_VBUS_DRAW;
715 cfg->c.bmAttributes = USB_CONFIG_ATT_ONE;
716 INIT_LIST_HEAD(&cfg->string_list);
717 INIT_LIST_HEAD(&cfg->func_list);
719 config_group_init_type_name(&cfg->group, name,
720 &gadget_config_type);
722 config_group_init_type_name(&cfg->strings_group, "strings",
723 &gadget_config_name_strings_type);
724 configfs_add_default_group(&cfg->strings_group, &cfg->group);
726 ret = usb_add_config_only(&gi->cdev, &cfg->c);
737 static void config_desc_drop(
738 struct config_group *group,
739 struct config_item *item)
741 config_item_put(item);
744 static struct configfs_group_operations config_desc_ops = {
745 .make_group = &config_desc_make,
746 .drop_item = &config_desc_drop,
749 static const struct config_item_type config_desc_type = {
750 .ct_group_ops = &config_desc_ops,
751 .ct_owner = THIS_MODULE,
754 GS_STRINGS_RW(gadget_strings, manufacturer);
755 GS_STRINGS_RW(gadget_strings, product);
756 GS_STRINGS_RW(gadget_strings, serialnumber);
758 static struct configfs_attribute *gadget_strings_langid_attrs[] = {
759 &gadget_strings_attr_manufacturer,
760 &gadget_strings_attr_product,
761 &gadget_strings_attr_serialnumber,
765 static void gadget_strings_attr_release(struct config_item *item)
767 struct gadget_strings *gs = to_gadget_strings(item);
769 kfree(gs->manufacturer);
771 kfree(gs->serialnumber);
777 USB_CONFIG_STRING_RW_OPS(gadget_strings);
778 USB_CONFIG_STRINGS_LANG(gadget_strings, gadget_info);
780 static inline struct gadget_info *os_desc_item_to_gadget_info(
781 struct config_item *item)
783 return container_of(to_config_group(item),
784 struct gadget_info, os_desc_group);
787 static ssize_t os_desc_use_show(struct config_item *item, char *page)
789 return sprintf(page, "%d\n",
790 os_desc_item_to_gadget_info(item)->use_os_desc);
793 static ssize_t os_desc_use_store(struct config_item *item, const char *page,
796 struct gadget_info *gi = os_desc_item_to_gadget_info(item);
800 mutex_lock(&gi->lock);
801 ret = strtobool(page, &use);
803 gi->use_os_desc = use;
806 mutex_unlock(&gi->lock);
811 static ssize_t os_desc_b_vendor_code_show(struct config_item *item, char *page)
813 return sprintf(page, "0x%02x\n",
814 os_desc_item_to_gadget_info(item)->b_vendor_code);
817 static ssize_t os_desc_b_vendor_code_store(struct config_item *item,
818 const char *page, size_t len)
820 struct gadget_info *gi = os_desc_item_to_gadget_info(item);
824 mutex_lock(&gi->lock);
825 ret = kstrtou8(page, 0, &b_vendor_code);
827 gi->b_vendor_code = b_vendor_code;
830 mutex_unlock(&gi->lock);
835 static ssize_t os_desc_qw_sign_show(struct config_item *item, char *page)
837 struct gadget_info *gi = os_desc_item_to_gadget_info(item);
840 res = utf16s_to_utf8s((wchar_t *) gi->qw_sign, OS_STRING_QW_SIGN_LEN,
841 UTF16_LITTLE_ENDIAN, page, PAGE_SIZE - 1);
847 static ssize_t os_desc_qw_sign_store(struct config_item *item, const char *page,
850 struct gadget_info *gi = os_desc_item_to_gadget_info(item);
853 l = min((int)len, OS_STRING_QW_SIGN_LEN >> 1);
854 if (page[l - 1] == '\n')
857 mutex_lock(&gi->lock);
858 res = utf8s_to_utf16s(page, l,
859 UTF16_LITTLE_ENDIAN, (wchar_t *) gi->qw_sign,
860 OS_STRING_QW_SIGN_LEN);
863 mutex_unlock(&gi->lock);
868 CONFIGFS_ATTR(os_desc_, use);
869 CONFIGFS_ATTR(os_desc_, b_vendor_code);
870 CONFIGFS_ATTR(os_desc_, qw_sign);
872 static struct configfs_attribute *os_desc_attrs[] = {
874 &os_desc_attr_b_vendor_code,
875 &os_desc_attr_qw_sign,
879 static int os_desc_link(struct config_item *os_desc_ci,
880 struct config_item *usb_cfg_ci)
882 struct gadget_info *gi = os_desc_item_to_gadget_info(os_desc_ci);
883 struct usb_composite_dev *cdev = &gi->cdev;
884 struct config_usb_cfg *c_target = to_config_usb_cfg(usb_cfg_ci);
885 struct usb_configuration *c;
888 mutex_lock(&gi->lock);
889 list_for_each_entry(c, &cdev->configs, list) {
890 if (c == &c_target->c)
893 if (c != &c_target->c) {
898 if (cdev->os_desc_config) {
903 cdev->os_desc_config = &c_target->c;
907 mutex_unlock(&gi->lock);
911 static void os_desc_unlink(struct config_item *os_desc_ci,
912 struct config_item *usb_cfg_ci)
914 struct gadget_info *gi = os_desc_item_to_gadget_info(os_desc_ci);
915 struct usb_composite_dev *cdev = &gi->cdev;
917 mutex_lock(&gi->lock);
918 if (gi->composite.gadget_driver.udc_name)
919 unregister_gadget(gi);
920 cdev->os_desc_config = NULL;
921 WARN_ON(gi->composite.gadget_driver.udc_name);
922 mutex_unlock(&gi->lock);
925 static struct configfs_item_operations os_desc_ops = {
926 .allow_link = os_desc_link,
927 .drop_link = os_desc_unlink,
930 static struct config_item_type os_desc_type = {
931 .ct_item_ops = &os_desc_ops,
932 .ct_attrs = os_desc_attrs,
933 .ct_owner = THIS_MODULE,
936 static inline struct usb_os_desc_ext_prop
937 *to_usb_os_desc_ext_prop(struct config_item *item)
939 return container_of(item, struct usb_os_desc_ext_prop, item);
942 static ssize_t ext_prop_type_show(struct config_item *item, char *page)
944 return sprintf(page, "%d\n", to_usb_os_desc_ext_prop(item)->type);
947 static ssize_t ext_prop_type_store(struct config_item *item,
948 const char *page, size_t len)
950 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
951 struct usb_os_desc *desc = to_usb_os_desc(ext_prop->item.ci_parent);
955 if (desc->opts_mutex)
956 mutex_lock(desc->opts_mutex);
957 ret = kstrtou8(page, 0, &type);
960 if (type < USB_EXT_PROP_UNICODE || type > USB_EXT_PROP_UNICODE_MULTI) {
965 if ((ext_prop->type == USB_EXT_PROP_BINARY ||
966 ext_prop->type == USB_EXT_PROP_LE32 ||
967 ext_prop->type == USB_EXT_PROP_BE32) &&
968 (type == USB_EXT_PROP_UNICODE ||
969 type == USB_EXT_PROP_UNICODE_ENV ||
970 type == USB_EXT_PROP_UNICODE_LINK))
971 ext_prop->data_len <<= 1;
972 else if ((ext_prop->type == USB_EXT_PROP_UNICODE ||
973 ext_prop->type == USB_EXT_PROP_UNICODE_ENV ||
974 ext_prop->type == USB_EXT_PROP_UNICODE_LINK) &&
975 (type == USB_EXT_PROP_BINARY ||
976 type == USB_EXT_PROP_LE32 ||
977 type == USB_EXT_PROP_BE32))
978 ext_prop->data_len >>= 1;
979 ext_prop->type = type;
983 if (desc->opts_mutex)
984 mutex_unlock(desc->opts_mutex);
988 static ssize_t ext_prop_data_show(struct config_item *item, char *page)
990 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
991 int len = ext_prop->data_len;
993 if (ext_prop->type == USB_EXT_PROP_UNICODE ||
994 ext_prop->type == USB_EXT_PROP_UNICODE_ENV ||
995 ext_prop->type == USB_EXT_PROP_UNICODE_LINK)
997 memcpy(page, ext_prop->data, len);
1002 static ssize_t ext_prop_data_store(struct config_item *item,
1003 const char *page, size_t len)
1005 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
1006 struct usb_os_desc *desc = to_usb_os_desc(ext_prop->item.ci_parent);
1008 size_t ret_len = len;
1010 if (page[len - 1] == '\n' || page[len - 1] == '\0')
1012 new_data = kmemdup(page, len, GFP_KERNEL);
1016 if (desc->opts_mutex)
1017 mutex_lock(desc->opts_mutex);
1018 kfree(ext_prop->data);
1019 ext_prop->data = new_data;
1020 desc->ext_prop_len -= ext_prop->data_len;
1021 ext_prop->data_len = len;
1022 desc->ext_prop_len += ext_prop->data_len;
1023 if (ext_prop->type == USB_EXT_PROP_UNICODE ||
1024 ext_prop->type == USB_EXT_PROP_UNICODE_ENV ||
1025 ext_prop->type == USB_EXT_PROP_UNICODE_LINK) {
1026 desc->ext_prop_len -= ext_prop->data_len;
1027 ext_prop->data_len <<= 1;
1028 ext_prop->data_len += 2;
1029 desc->ext_prop_len += ext_prop->data_len;
1031 if (desc->opts_mutex)
1032 mutex_unlock(desc->opts_mutex);
1036 CONFIGFS_ATTR(ext_prop_, type);
1037 CONFIGFS_ATTR(ext_prop_, data);
1039 static struct configfs_attribute *ext_prop_attrs[] = {
1040 &ext_prop_attr_type,
1041 &ext_prop_attr_data,
1045 static void usb_os_desc_ext_prop_release(struct config_item *item)
1047 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
1049 kfree(ext_prop); /* frees a whole chunk */
1052 static struct configfs_item_operations ext_prop_ops = {
1053 .release = usb_os_desc_ext_prop_release,
1056 static struct config_item *ext_prop_make(
1057 struct config_group *group,
1060 struct usb_os_desc_ext_prop *ext_prop;
1061 struct config_item_type *ext_prop_type;
1062 struct usb_os_desc *desc;
1065 vla_group(data_chunk);
1066 vla_item(data_chunk, struct usb_os_desc_ext_prop, ext_prop, 1);
1067 vla_item(data_chunk, struct config_item_type, ext_prop_type, 1);
1069 vlabuf = kzalloc(vla_group_size(data_chunk), GFP_KERNEL);
1071 return ERR_PTR(-ENOMEM);
1073 ext_prop = vla_ptr(vlabuf, data_chunk, ext_prop);
1074 ext_prop_type = vla_ptr(vlabuf, data_chunk, ext_prop_type);
1076 desc = container_of(group, struct usb_os_desc, group);
1077 ext_prop_type->ct_item_ops = &ext_prop_ops;
1078 ext_prop_type->ct_attrs = ext_prop_attrs;
1079 ext_prop_type->ct_owner = desc->owner;
1081 config_item_init_type_name(&ext_prop->item, name, ext_prop_type);
1083 ext_prop->name = kstrdup(name, GFP_KERNEL);
1084 if (!ext_prop->name) {
1086 return ERR_PTR(-ENOMEM);
1088 desc->ext_prop_len += 14;
1089 ext_prop->name_len = 2 * strlen(ext_prop->name) + 2;
1090 if (desc->opts_mutex)
1091 mutex_lock(desc->opts_mutex);
1092 desc->ext_prop_len += ext_prop->name_len;
1093 list_add_tail(&ext_prop->entry, &desc->ext_prop);
1094 ++desc->ext_prop_count;
1095 if (desc->opts_mutex)
1096 mutex_unlock(desc->opts_mutex);
1098 return &ext_prop->item;
1101 static void ext_prop_drop(struct config_group *group, struct config_item *item)
1103 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
1104 struct usb_os_desc *desc = to_usb_os_desc(&group->cg_item);
1106 if (desc->opts_mutex)
1107 mutex_lock(desc->opts_mutex);
1108 list_del(&ext_prop->entry);
1109 --desc->ext_prop_count;
1110 kfree(ext_prop->name);
1111 desc->ext_prop_len -= (ext_prop->name_len + ext_prop->data_len + 14);
1112 if (desc->opts_mutex)
1113 mutex_unlock(desc->opts_mutex);
1114 config_item_put(item);
1117 static struct configfs_group_operations interf_grp_ops = {
1118 .make_item = &ext_prop_make,
1119 .drop_item = &ext_prop_drop,
1122 static ssize_t interf_grp_compatible_id_show(struct config_item *item,
1125 memcpy(page, to_usb_os_desc(item)->ext_compat_id, 8);
1129 static ssize_t interf_grp_compatible_id_store(struct config_item *item,
1130 const char *page, size_t len)
1132 struct usb_os_desc *desc = to_usb_os_desc(item);
1135 l = min_t(int, 8, len);
1136 if (page[l - 1] == '\n')
1138 if (desc->opts_mutex)
1139 mutex_lock(desc->opts_mutex);
1140 memcpy(desc->ext_compat_id, page, l);
1142 if (desc->opts_mutex)
1143 mutex_unlock(desc->opts_mutex);
1148 static ssize_t interf_grp_sub_compatible_id_show(struct config_item *item,
1151 memcpy(page, to_usb_os_desc(item)->ext_compat_id + 8, 8);
1155 static ssize_t interf_grp_sub_compatible_id_store(struct config_item *item,
1156 const char *page, size_t len)
1158 struct usb_os_desc *desc = to_usb_os_desc(item);
1161 l = min_t(int, 8, len);
1162 if (page[l - 1] == '\n')
1164 if (desc->opts_mutex)
1165 mutex_lock(desc->opts_mutex);
1166 memcpy(desc->ext_compat_id + 8, page, l);
1168 if (desc->opts_mutex)
1169 mutex_unlock(desc->opts_mutex);
1174 CONFIGFS_ATTR(interf_grp_, compatible_id);
1175 CONFIGFS_ATTR(interf_grp_, sub_compatible_id);
1177 static struct configfs_attribute *interf_grp_attrs[] = {
1178 &interf_grp_attr_compatible_id,
1179 &interf_grp_attr_sub_compatible_id,
1183 struct config_group *usb_os_desc_prepare_interf_dir(
1184 struct config_group *parent,
1186 struct usb_os_desc **desc,
1188 struct module *owner)
1190 struct config_group *os_desc_group;
1191 struct config_item_type *os_desc_type, *interface_type;
1193 vla_group(data_chunk);
1194 vla_item(data_chunk, struct config_group, os_desc_group, 1);
1195 vla_item(data_chunk, struct config_item_type, os_desc_type, 1);
1196 vla_item(data_chunk, struct config_item_type, interface_type, 1);
1198 char *vlabuf = kzalloc(vla_group_size(data_chunk), GFP_KERNEL);
1200 return ERR_PTR(-ENOMEM);
1202 os_desc_group = vla_ptr(vlabuf, data_chunk, os_desc_group);
1203 os_desc_type = vla_ptr(vlabuf, data_chunk, os_desc_type);
1204 interface_type = vla_ptr(vlabuf, data_chunk, interface_type);
1206 os_desc_type->ct_owner = owner;
1207 config_group_init_type_name(os_desc_group, "os_desc", os_desc_type);
1208 configfs_add_default_group(os_desc_group, parent);
1210 interface_type->ct_group_ops = &interf_grp_ops;
1211 interface_type->ct_attrs = interf_grp_attrs;
1212 interface_type->ct_owner = owner;
1214 while (n_interf--) {
1215 struct usb_os_desc *d;
1219 config_group_init_type_name(&d->group, "", interface_type);
1220 config_item_set_name(&d->group.cg_item, "interface.%s",
1222 configfs_add_default_group(&d->group, os_desc_group);
1225 return os_desc_group;
1227 EXPORT_SYMBOL(usb_os_desc_prepare_interf_dir);
1229 static int configfs_do_nothing(struct usb_composite_dev *cdev)
1235 int composite_dev_prepare(struct usb_composite_driver *composite,
1236 struct usb_composite_dev *dev);
1238 int composite_os_desc_req_prepare(struct usb_composite_dev *cdev,
1239 struct usb_ep *ep0);
1241 static void purge_configs_funcs(struct gadget_info *gi)
1243 struct usb_configuration *c;
1245 list_for_each_entry(c, &gi->cdev.configs, list) {
1246 struct usb_function *f, *tmp;
1247 struct config_usb_cfg *cfg;
1249 cfg = container_of(c, struct config_usb_cfg, c);
1251 list_for_each_entry_safe_reverse(f, tmp, &c->functions, list) {
1253 list_move(&f->list, &cfg->func_list);
1255 dev_dbg(&gi->cdev.gadget->dev,
1256 "unbind function '%s'/%p\n",
1261 c->next_interface_id = 0;
1262 memset(c->interface, 0, sizeof(c->interface));
1263 c->superspeed_plus = 0;
1270 static int configfs_composite_bind(struct usb_gadget *gadget,
1271 struct usb_gadget_driver *gdriver)
1273 struct usb_composite_driver *composite = to_cdriver(gdriver);
1274 struct gadget_info *gi = container_of(composite,
1275 struct gadget_info, composite);
1276 struct usb_composite_dev *cdev = &gi->cdev;
1277 struct usb_configuration *c;
1278 struct usb_string *s;
1282 /* the gi->lock is hold by the caller */
1284 cdev->gadget = gadget;
1285 set_gadget_data(gadget, cdev);
1286 ret = composite_dev_prepare(composite, cdev);
1289 /* and now the gadget bind */
1292 if (list_empty(&gi->cdev.configs)) {
1293 pr_err("Need at least one configuration in %s.\n",
1294 gi->composite.name);
1295 goto err_comp_cleanup;
1299 list_for_each_entry(c, &gi->cdev.configs, list) {
1300 struct config_usb_cfg *cfg;
1302 cfg = container_of(c, struct config_usb_cfg, c);
1303 if (list_empty(&cfg->func_list)) {
1304 pr_err("Config %s/%d of %s needs at least one function.\n",
1305 c->label, c->bConfigurationValue,
1306 gi->composite.name);
1307 goto err_comp_cleanup;
1311 /* init all strings */
1312 if (!list_empty(&gi->string_list)) {
1313 struct gadget_strings *gs;
1316 list_for_each_entry(gs, &gi->string_list, list) {
1318 gi->gstrings[i] = &gs->stringtab_dev;
1319 gs->stringtab_dev.strings = gs->strings;
1320 gs->strings[USB_GADGET_MANUFACTURER_IDX].s =
1322 gs->strings[USB_GADGET_PRODUCT_IDX].s = gs->product;
1323 gs->strings[USB_GADGET_SERIAL_IDX].s = gs->serialnumber;
1326 gi->gstrings[i] = NULL;
1327 s = usb_gstrings_attach(&gi->cdev, gi->gstrings,
1328 USB_GADGET_FIRST_AVAIL_IDX);
1331 goto err_comp_cleanup;
1334 gi->cdev.desc.iManufacturer = s[USB_GADGET_MANUFACTURER_IDX].id;
1335 gi->cdev.desc.iProduct = s[USB_GADGET_PRODUCT_IDX].id;
1336 gi->cdev.desc.iSerialNumber = s[USB_GADGET_SERIAL_IDX].id;
1339 if (gi->use_os_desc) {
1340 cdev->use_os_string = true;
1341 cdev->b_vendor_code = gi->b_vendor_code;
1342 memcpy(cdev->qw_sign, gi->qw_sign, OS_STRING_QW_SIGN_LEN);
1345 if (gadget_is_otg(gadget) && !otg_desc[0]) {
1346 struct usb_descriptor_header *usb_desc;
1348 usb_desc = usb_otg_descriptor_alloc(gadget);
1351 goto err_comp_cleanup;
1353 usb_otg_descriptor_init(gadget, usb_desc);
1354 otg_desc[0] = usb_desc;
1358 /* Go through all configs, attach all functions */
1359 list_for_each_entry(c, &gi->cdev.configs, list) {
1360 struct config_usb_cfg *cfg;
1361 struct usb_function *f;
1362 struct usb_function *tmp;
1363 struct gadget_config_name *cn;
1365 if (gadget_is_otg(gadget))
1366 c->descriptors = otg_desc;
1368 cfg = container_of(c, struct config_usb_cfg, c);
1369 if (!list_empty(&cfg->string_list)) {
1371 list_for_each_entry(cn, &cfg->string_list, list) {
1372 cfg->gstrings[i] = &cn->stringtab_dev;
1373 cn->stringtab_dev.strings = &cn->strings;
1374 cn->strings.s = cn->configuration;
1377 cfg->gstrings[i] = NULL;
1378 s = usb_gstrings_attach(&gi->cdev, cfg->gstrings, 1);
1381 goto err_comp_cleanup;
1383 c->iConfiguration = s[0].id;
1386 list_for_each_entry_safe(f, tmp, &cfg->func_list, list) {
1388 ret = usb_add_function(c, f);
1390 list_add(&f->list, &cfg->func_list);
1391 goto err_purge_funcs;
1394 ret = usb_gadget_check_config(cdev->gadget);
1396 goto err_purge_funcs;
1398 usb_ep_autoconfig_reset(cdev->gadget);
1400 if (cdev->use_os_string) {
1401 ret = composite_os_desc_req_prepare(cdev, gadget->ep0);
1403 goto err_purge_funcs;
1406 usb_ep_autoconfig_reset(cdev->gadget);
1410 purge_configs_funcs(gi);
1412 composite_dev_cleanup(cdev);
1416 static void configfs_composite_unbind(struct usb_gadget *gadget)
1418 struct usb_composite_dev *cdev;
1419 struct gadget_info *gi;
1420 unsigned long flags;
1422 /* the gi->lock is hold by the caller */
1424 cdev = get_gadget_data(gadget);
1425 gi = container_of(cdev, struct gadget_info, cdev);
1426 spin_lock_irqsave(&gi->spinlock, flags);
1428 spin_unlock_irqrestore(&gi->spinlock, flags);
1432 purge_configs_funcs(gi);
1433 composite_dev_cleanup(cdev);
1434 usb_ep_autoconfig_reset(cdev->gadget);
1435 spin_lock_irqsave(&gi->spinlock, flags);
1436 cdev->gadget = NULL;
1437 set_gadget_data(gadget, NULL);
1438 spin_unlock_irqrestore(&gi->spinlock, flags);
1441 static int configfs_composite_setup(struct usb_gadget *gadget,
1442 const struct usb_ctrlrequest *ctrl)
1444 struct usb_composite_dev *cdev;
1445 struct gadget_info *gi;
1446 unsigned long flags;
1449 cdev = get_gadget_data(gadget);
1453 gi = container_of(cdev, struct gadget_info, cdev);
1454 spin_lock_irqsave(&gi->spinlock, flags);
1455 cdev = get_gadget_data(gadget);
1456 if (!cdev || gi->unbind) {
1457 spin_unlock_irqrestore(&gi->spinlock, flags);
1461 ret = composite_setup(gadget, ctrl);
1462 spin_unlock_irqrestore(&gi->spinlock, flags);
1466 static void configfs_composite_disconnect(struct usb_gadget *gadget)
1468 struct usb_composite_dev *cdev;
1469 struct gadget_info *gi;
1470 unsigned long flags;
1472 cdev = get_gadget_data(gadget);
1476 gi = container_of(cdev, struct gadget_info, cdev);
1477 spin_lock_irqsave(&gi->spinlock, flags);
1478 cdev = get_gadget_data(gadget);
1479 if (!cdev || gi->unbind) {
1480 spin_unlock_irqrestore(&gi->spinlock, flags);
1484 composite_disconnect(gadget);
1485 spin_unlock_irqrestore(&gi->spinlock, flags);
1488 static void configfs_composite_reset(struct usb_gadget *gadget)
1490 struct usb_composite_dev *cdev;
1491 struct gadget_info *gi;
1492 unsigned long flags;
1494 cdev = get_gadget_data(gadget);
1498 gi = container_of(cdev, struct gadget_info, cdev);
1499 spin_lock_irqsave(&gi->spinlock, flags);
1500 cdev = get_gadget_data(gadget);
1501 if (!cdev || gi->unbind) {
1502 spin_unlock_irqrestore(&gi->spinlock, flags);
1506 composite_reset(gadget);
1507 spin_unlock_irqrestore(&gi->spinlock, flags);
1510 static void configfs_composite_suspend(struct usb_gadget *gadget)
1512 struct usb_composite_dev *cdev;
1513 struct gadget_info *gi;
1514 unsigned long flags;
1516 cdev = get_gadget_data(gadget);
1520 gi = container_of(cdev, struct gadget_info, cdev);
1521 spin_lock_irqsave(&gi->spinlock, flags);
1522 cdev = get_gadget_data(gadget);
1523 if (!cdev || gi->unbind) {
1524 spin_unlock_irqrestore(&gi->spinlock, flags);
1528 composite_suspend(gadget);
1529 spin_unlock_irqrestore(&gi->spinlock, flags);
1532 static void configfs_composite_resume(struct usb_gadget *gadget)
1534 struct usb_composite_dev *cdev;
1535 struct gadget_info *gi;
1536 unsigned long flags;
1538 cdev = get_gadget_data(gadget);
1542 gi = container_of(cdev, struct gadget_info, cdev);
1543 spin_lock_irqsave(&gi->spinlock, flags);
1544 cdev = get_gadget_data(gadget);
1545 if (!cdev || gi->unbind) {
1546 spin_unlock_irqrestore(&gi->spinlock, flags);
1550 composite_resume(gadget);
1551 spin_unlock_irqrestore(&gi->spinlock, flags);
1554 static const struct usb_gadget_driver configfs_driver_template = {
1555 .bind = configfs_composite_bind,
1556 .unbind = configfs_composite_unbind,
1558 .setup = configfs_composite_setup,
1559 .reset = configfs_composite_reset,
1560 .disconnect = configfs_composite_disconnect,
1562 .suspend = configfs_composite_suspend,
1563 .resume = configfs_composite_resume,
1565 .max_speed = USB_SPEED_SUPER_PLUS,
1567 .owner = THIS_MODULE,
1568 .name = "configfs-gadget",
1570 .match_existing_only = 1,
1573 static struct config_group *gadgets_make(
1574 struct config_group *group,
1577 struct gadget_info *gi;
1579 gi = kzalloc(sizeof(*gi), GFP_KERNEL);
1581 return ERR_PTR(-ENOMEM);
1583 config_group_init_type_name(&gi->group, name, &gadget_root_type);
1585 config_group_init_type_name(&gi->functions_group, "functions",
1587 configfs_add_default_group(&gi->functions_group, &gi->group);
1589 config_group_init_type_name(&gi->configs_group, "configs",
1591 configfs_add_default_group(&gi->configs_group, &gi->group);
1593 config_group_init_type_name(&gi->strings_group, "strings",
1594 &gadget_strings_strings_type);
1595 configfs_add_default_group(&gi->strings_group, &gi->group);
1597 config_group_init_type_name(&gi->os_desc_group, "os_desc",
1599 configfs_add_default_group(&gi->os_desc_group, &gi->group);
1601 gi->composite.bind = configfs_do_nothing;
1602 gi->composite.unbind = configfs_do_nothing;
1603 gi->composite.suspend = NULL;
1604 gi->composite.resume = NULL;
1605 gi->composite.max_speed = USB_SPEED_SUPER_PLUS;
1607 spin_lock_init(&gi->spinlock);
1608 mutex_init(&gi->lock);
1609 INIT_LIST_HEAD(&gi->string_list);
1610 INIT_LIST_HEAD(&gi->available_func);
1612 composite_init_dev(&gi->cdev);
1613 gi->cdev.desc.bLength = USB_DT_DEVICE_SIZE;
1614 gi->cdev.desc.bDescriptorType = USB_DT_DEVICE;
1615 gi->cdev.desc.bcdDevice = cpu_to_le16(get_default_bcdDevice());
1617 gi->composite.gadget_driver = configfs_driver_template;
1619 gi->composite.gadget_driver.function = kstrdup(name, GFP_KERNEL);
1620 gi->composite.name = gi->composite.gadget_driver.function;
1622 if (!gi->composite.gadget_driver.function)
1628 return ERR_PTR(-ENOMEM);
1631 static void gadgets_drop(struct config_group *group, struct config_item *item)
1633 config_item_put(item);
1636 static struct configfs_group_operations gadgets_ops = {
1637 .make_group = &gadgets_make,
1638 .drop_item = &gadgets_drop,
1641 static const struct config_item_type gadgets_type = {
1642 .ct_group_ops = &gadgets_ops,
1643 .ct_owner = THIS_MODULE,
1646 static struct configfs_subsystem gadget_subsys = {
1649 .ci_namebuf = "usb_gadget",
1650 .ci_type = &gadgets_type,
1653 .su_mutex = __MUTEX_INITIALIZER(gadget_subsys.su_mutex),
1656 void unregister_gadget_item(struct config_item *item)
1658 struct gadget_info *gi = to_gadget_info(item);
1660 mutex_lock(&gi->lock);
1661 unregister_gadget(gi);
1662 mutex_unlock(&gi->lock);
1664 EXPORT_SYMBOL_GPL(unregister_gadget_item);
1666 static int __init gadget_cfs_init(void)
1670 config_group_init(&gadget_subsys.su_group);
1672 ret = configfs_register_subsystem(&gadget_subsys);
1675 module_init(gadget_cfs_init);
1677 static void __exit gadget_cfs_exit(void)
1679 configfs_unregister_subsystem(&gadget_subsys);
1681 module_exit(gadget_cfs_exit);