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>
6 #include <linux/kstrtox.h>
8 #include <linux/usb/composite.h>
9 #include <linux/usb/gadget_configfs.h>
12 #include "u_os_desc.h"
14 int check_user_usb_string(const char *name,
15 struct usb_gadget_strings *stringtab_dev)
20 ret = kstrtou16(name, 0, &num);
24 if (!usb_validate_langid(num))
27 stringtab_dev->language = num;
31 #define MAX_NAME_LEN 40
32 #define MAX_USB_STRING_LANGS 2
34 static const struct usb_descriptor_header *otg_desc[2];
37 struct config_group group;
38 struct config_group functions_group;
39 struct config_group configs_group;
40 struct config_group strings_group;
41 struct config_group os_desc_group;
44 struct usb_gadget_strings *gstrings[MAX_USB_STRING_LANGS + 1];
45 struct list_head string_list;
46 struct list_head available_func;
48 struct usb_composite_driver composite;
49 struct usb_composite_dev cdev;
52 char qw_sign[OS_STRING_QW_SIGN_LEN];
57 static inline struct gadget_info *to_gadget_info(struct config_item *item)
59 return container_of(to_config_group(item), struct gadget_info, group);
62 struct config_usb_cfg {
63 struct config_group group;
64 struct config_group strings_group;
65 struct list_head string_list;
66 struct usb_configuration c;
67 struct list_head func_list;
68 struct usb_gadget_strings *gstrings[MAX_USB_STRING_LANGS + 1];
71 static inline struct config_usb_cfg *to_config_usb_cfg(struct config_item *item)
73 return container_of(to_config_group(item), struct config_usb_cfg,
77 static inline struct gadget_info *cfg_to_gadget_info(struct config_usb_cfg *cfg)
79 return container_of(cfg->c.cdev, struct gadget_info, cdev);
82 struct gadget_strings {
83 struct usb_gadget_strings stringtab_dev;
84 struct usb_string strings[USB_GADGET_FIRST_AVAIL_IDX];
89 struct config_group group;
90 struct list_head list;
93 struct gadget_config_name {
94 struct usb_gadget_strings stringtab_dev;
95 struct usb_string strings;
98 struct config_group group;
99 struct list_head list;
102 #define USB_MAX_STRING_WITH_NULL_LEN (USB_MAX_STRING_LEN+1)
104 static int usb_string_copy(const char *s, char **s_copy)
108 char *copy = *s_copy;
110 if (ret > USB_MAX_STRING_LEN)
116 str = kmalloc(USB_MAX_STRING_WITH_NULL_LEN, GFP_KERNEL);
121 if (str[ret - 1] == '\n')
127 #define GI_DEVICE_DESC_SIMPLE_R_u8(__name) \
128 static ssize_t gadget_dev_desc_##__name##_show(struct config_item *item, \
131 return sprintf(page, "0x%02x\n", \
132 to_gadget_info(item)->cdev.desc.__name); \
135 #define GI_DEVICE_DESC_SIMPLE_R_u16(__name) \
136 static ssize_t gadget_dev_desc_##__name##_show(struct config_item *item, \
139 return sprintf(page, "0x%04x\n", \
140 le16_to_cpup(&to_gadget_info(item)->cdev.desc.__name)); \
144 #define GI_DEVICE_DESC_SIMPLE_W_u8(_name) \
145 static ssize_t gadget_dev_desc_##_name##_store(struct config_item *item, \
146 const char *page, size_t len) \
150 ret = kstrtou8(page, 0, &val); \
153 to_gadget_info(item)->cdev.desc._name = val; \
157 #define GI_DEVICE_DESC_SIMPLE_W_u16(_name) \
158 static ssize_t gadget_dev_desc_##_name##_store(struct config_item *item, \
159 const char *page, size_t len) \
163 ret = kstrtou16(page, 0, &val); \
166 to_gadget_info(item)->cdev.desc._name = cpu_to_le16p(&val); \
170 #define GI_DEVICE_DESC_SIMPLE_RW(_name, _type) \
171 GI_DEVICE_DESC_SIMPLE_R_##_type(_name) \
172 GI_DEVICE_DESC_SIMPLE_W_##_type(_name)
174 GI_DEVICE_DESC_SIMPLE_R_u16(bcdUSB);
175 GI_DEVICE_DESC_SIMPLE_RW(bDeviceClass, u8);
176 GI_DEVICE_DESC_SIMPLE_RW(bDeviceSubClass, u8);
177 GI_DEVICE_DESC_SIMPLE_RW(bDeviceProtocol, u8);
178 GI_DEVICE_DESC_SIMPLE_RW(bMaxPacketSize0, u8);
179 GI_DEVICE_DESC_SIMPLE_RW(idVendor, u16);
180 GI_DEVICE_DESC_SIMPLE_RW(idProduct, u16);
181 GI_DEVICE_DESC_SIMPLE_R_u16(bcdDevice);
183 static ssize_t is_valid_bcd(u16 bcd_val)
185 if ((bcd_val & 0xf) > 9)
187 if (((bcd_val >> 4) & 0xf) > 9)
189 if (((bcd_val >> 8) & 0xf) > 9)
191 if (((bcd_val >> 12) & 0xf) > 9)
196 static ssize_t gadget_dev_desc_bcdDevice_store(struct config_item *item,
197 const char *page, size_t len)
202 ret = kstrtou16(page, 0, &bcdDevice);
205 ret = is_valid_bcd(bcdDevice);
209 to_gadget_info(item)->cdev.desc.bcdDevice = cpu_to_le16(bcdDevice);
213 static ssize_t gadget_dev_desc_bcdUSB_store(struct config_item *item,
214 const char *page, size_t len)
219 ret = kstrtou16(page, 0, &bcdUSB);
222 ret = is_valid_bcd(bcdUSB);
226 to_gadget_info(item)->cdev.desc.bcdUSB = cpu_to_le16(bcdUSB);
230 static ssize_t gadget_dev_desc_UDC_show(struct config_item *item, char *page)
232 struct gadget_info *gi = to_gadget_info(item);
236 mutex_lock(&gi->lock);
237 udc_name = gi->composite.gadget_driver.udc_name;
238 ret = sprintf(page, "%s\n", udc_name ?: "");
239 mutex_unlock(&gi->lock);
244 static int unregister_gadget(struct gadget_info *gi)
248 if (!gi->composite.gadget_driver.udc_name)
251 ret = usb_gadget_unregister_driver(&gi->composite.gadget_driver);
254 kfree(gi->composite.gadget_driver.udc_name);
255 gi->composite.gadget_driver.udc_name = NULL;
259 static ssize_t gadget_dev_desc_UDC_store(struct config_item *item,
260 const char *page, size_t len)
262 struct gadget_info *gi = to_gadget_info(item);
266 if (strlen(page) < len)
269 name = kstrdup(page, GFP_KERNEL);
272 if (name[len - 1] == '\n')
273 name[len - 1] = '\0';
275 mutex_lock(&gi->lock);
278 ret = unregister_gadget(gi);
283 if (gi->composite.gadget_driver.udc_name) {
287 gi->composite.gadget_driver.udc_name = name;
288 ret = usb_gadget_register_driver(&gi->composite.gadget_driver);
290 gi->composite.gadget_driver.udc_name = NULL;
294 mutex_unlock(&gi->lock);
298 mutex_unlock(&gi->lock);
302 static ssize_t gadget_dev_desc_max_speed_show(struct config_item *item,
305 enum usb_device_speed speed = to_gadget_info(item)->composite.max_speed;
307 return sprintf(page, "%s\n", usb_speed_string(speed));
310 static ssize_t gadget_dev_desc_max_speed_store(struct config_item *item,
311 const char *page, size_t len)
313 struct gadget_info *gi = to_gadget_info(item);
315 mutex_lock(&gi->lock);
317 /* Prevent changing of max_speed after the driver is binded */
318 if (gi->composite.gadget_driver.udc_name)
321 if (strncmp(page, "super-speed-plus", 16) == 0)
322 gi->composite.max_speed = USB_SPEED_SUPER_PLUS;
323 else if (strncmp(page, "super-speed", 11) == 0)
324 gi->composite.max_speed = USB_SPEED_SUPER;
325 else if (strncmp(page, "high-speed", 10) == 0)
326 gi->composite.max_speed = USB_SPEED_HIGH;
327 else if (strncmp(page, "full-speed", 10) == 0)
328 gi->composite.max_speed = USB_SPEED_FULL;
329 else if (strncmp(page, "low-speed", 9) == 0)
330 gi->composite.max_speed = USB_SPEED_LOW;
334 gi->composite.gadget_driver.max_speed = gi->composite.max_speed;
336 mutex_unlock(&gi->lock);
339 mutex_unlock(&gi->lock);
343 CONFIGFS_ATTR(gadget_dev_desc_, bDeviceClass);
344 CONFIGFS_ATTR(gadget_dev_desc_, bDeviceSubClass);
345 CONFIGFS_ATTR(gadget_dev_desc_, bDeviceProtocol);
346 CONFIGFS_ATTR(gadget_dev_desc_, bMaxPacketSize0);
347 CONFIGFS_ATTR(gadget_dev_desc_, idVendor);
348 CONFIGFS_ATTR(gadget_dev_desc_, idProduct);
349 CONFIGFS_ATTR(gadget_dev_desc_, bcdDevice);
350 CONFIGFS_ATTR(gadget_dev_desc_, bcdUSB);
351 CONFIGFS_ATTR(gadget_dev_desc_, UDC);
352 CONFIGFS_ATTR(gadget_dev_desc_, max_speed);
354 static struct configfs_attribute *gadget_root_attrs[] = {
355 &gadget_dev_desc_attr_bDeviceClass,
356 &gadget_dev_desc_attr_bDeviceSubClass,
357 &gadget_dev_desc_attr_bDeviceProtocol,
358 &gadget_dev_desc_attr_bMaxPacketSize0,
359 &gadget_dev_desc_attr_idVendor,
360 &gadget_dev_desc_attr_idProduct,
361 &gadget_dev_desc_attr_bcdDevice,
362 &gadget_dev_desc_attr_bcdUSB,
363 &gadget_dev_desc_attr_UDC,
364 &gadget_dev_desc_attr_max_speed,
368 static inline struct gadget_strings *to_gadget_strings(struct config_item *item)
370 return container_of(to_config_group(item), struct gadget_strings,
374 static inline struct gadget_config_name *to_gadget_config_name(
375 struct config_item *item)
377 return container_of(to_config_group(item), struct gadget_config_name,
381 static inline struct usb_function_instance *to_usb_function_instance(
382 struct config_item *item)
384 return container_of(to_config_group(item),
385 struct usb_function_instance, group);
388 static void gadget_info_attr_release(struct config_item *item)
390 struct gadget_info *gi = to_gadget_info(item);
392 WARN_ON(!list_empty(&gi->cdev.configs));
393 WARN_ON(!list_empty(&gi->string_list));
394 WARN_ON(!list_empty(&gi->available_func));
395 kfree(gi->composite.gadget_driver.function);
399 static struct configfs_item_operations gadget_root_item_ops = {
400 .release = gadget_info_attr_release,
403 static void gadget_config_attr_release(struct config_item *item)
405 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
407 WARN_ON(!list_empty(&cfg->c.functions));
408 list_del(&cfg->c.list);
413 static int config_usb_cfg_link(
414 struct config_item *usb_cfg_ci,
415 struct config_item *usb_func_ci)
417 struct config_usb_cfg *cfg = to_config_usb_cfg(usb_cfg_ci);
418 struct gadget_info *gi = cfg_to_gadget_info(cfg);
420 struct usb_function_instance *fi =
421 to_usb_function_instance(usb_func_ci);
422 struct usb_function_instance *a_fi = NULL, *iter;
423 struct usb_function *f;
426 mutex_lock(&gi->lock);
428 * Make sure this function is from within our _this_ gadget and not
429 * from another gadget or a random directory.
430 * Also a function instance can only be linked once.
432 list_for_each_entry(iter, &gi->available_func, cfs_list) {
443 list_for_each_entry(f, &cfg->func_list, list) {
450 f = usb_get_function(fi);
456 /* stash the function until we bind it to the gadget */
457 list_add_tail(&f->list, &cfg->func_list);
460 mutex_unlock(&gi->lock);
464 static void config_usb_cfg_unlink(
465 struct config_item *usb_cfg_ci,
466 struct config_item *usb_func_ci)
468 struct config_usb_cfg *cfg = to_config_usb_cfg(usb_cfg_ci);
469 struct gadget_info *gi = cfg_to_gadget_info(cfg);
471 struct usb_function_instance *fi =
472 to_usb_function_instance(usb_func_ci);
473 struct usb_function *f;
476 * ideally I would like to forbid to unlink functions while a gadget is
477 * bound to an UDC. Since this isn't possible at the moment, we simply
478 * force an unbind, the function is available here and then we can
479 * remove the function.
481 mutex_lock(&gi->lock);
482 if (gi->composite.gadget_driver.udc_name)
483 unregister_gadget(gi);
484 WARN_ON(gi->composite.gadget_driver.udc_name);
486 list_for_each_entry(f, &cfg->func_list, list) {
490 mutex_unlock(&gi->lock);
494 mutex_unlock(&gi->lock);
495 WARN(1, "Unable to locate function to unbind\n");
498 static struct configfs_item_operations gadget_config_item_ops = {
499 .release = gadget_config_attr_release,
500 .allow_link = config_usb_cfg_link,
501 .drop_link = config_usb_cfg_unlink,
505 static ssize_t gadget_config_desc_MaxPower_show(struct config_item *item,
508 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
510 return sprintf(page, "%u\n", cfg->c.MaxPower);
513 static ssize_t gadget_config_desc_MaxPower_store(struct config_item *item,
514 const char *page, size_t len)
516 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
519 ret = kstrtou16(page, 0, &val);
522 if (DIV_ROUND_UP(val, 8) > 0xff)
524 cfg->c.MaxPower = val;
528 static ssize_t gadget_config_desc_bmAttributes_show(struct config_item *item,
531 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
533 return sprintf(page, "0x%02x\n", cfg->c.bmAttributes);
536 static ssize_t gadget_config_desc_bmAttributes_store(struct config_item *item,
537 const char *page, size_t len)
539 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
542 ret = kstrtou8(page, 0, &val);
545 if (!(val & USB_CONFIG_ATT_ONE))
547 if (val & ~(USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER |
548 USB_CONFIG_ATT_WAKEUP))
550 cfg->c.bmAttributes = val;
554 CONFIGFS_ATTR(gadget_config_desc_, MaxPower);
555 CONFIGFS_ATTR(gadget_config_desc_, bmAttributes);
557 static struct configfs_attribute *gadget_config_attrs[] = {
558 &gadget_config_desc_attr_MaxPower,
559 &gadget_config_desc_attr_bmAttributes,
563 static const struct config_item_type gadget_config_type = {
564 .ct_item_ops = &gadget_config_item_ops,
565 .ct_attrs = gadget_config_attrs,
566 .ct_owner = THIS_MODULE,
569 static const struct config_item_type gadget_root_type = {
570 .ct_item_ops = &gadget_root_item_ops,
571 .ct_attrs = gadget_root_attrs,
572 .ct_owner = THIS_MODULE,
575 static void composite_init_dev(struct usb_composite_dev *cdev)
577 spin_lock_init(&cdev->lock);
578 INIT_LIST_HEAD(&cdev->configs);
579 INIT_LIST_HEAD(&cdev->gstrings);
582 static struct config_group *function_make(
583 struct config_group *group,
586 struct gadget_info *gi;
587 struct usb_function_instance *fi;
588 char buf[MAX_NAME_LEN];
593 ret = snprintf(buf, MAX_NAME_LEN, "%s", name);
594 if (ret >= MAX_NAME_LEN)
595 return ERR_PTR(-ENAMETOOLONG);
598 instance_name = strchr(func_name, '.');
599 if (!instance_name) {
600 pr_err("Unable to locate . in FUNC.INSTANCE\n");
601 return ERR_PTR(-EINVAL);
603 *instance_name = '\0';
606 fi = usb_get_function_instance(func_name);
610 ret = config_item_set_name(&fi->group.cg_item, "%s", name);
612 usb_put_function_instance(fi);
615 if (fi->set_inst_name) {
616 ret = fi->set_inst_name(fi, instance_name);
618 usb_put_function_instance(fi);
623 gi = container_of(group, struct gadget_info, functions_group);
625 mutex_lock(&gi->lock);
626 list_add_tail(&fi->cfs_list, &gi->available_func);
627 mutex_unlock(&gi->lock);
631 static void function_drop(
632 struct config_group *group,
633 struct config_item *item)
635 struct usb_function_instance *fi = to_usb_function_instance(item);
636 struct gadget_info *gi;
638 gi = container_of(group, struct gadget_info, functions_group);
640 mutex_lock(&gi->lock);
641 list_del(&fi->cfs_list);
642 mutex_unlock(&gi->lock);
643 config_item_put(item);
646 static struct configfs_group_operations functions_ops = {
647 .make_group = &function_make,
648 .drop_item = &function_drop,
651 static const struct config_item_type functions_type = {
652 .ct_group_ops = &functions_ops,
653 .ct_owner = THIS_MODULE,
656 GS_STRINGS_RW(gadget_config_name, configuration);
658 static struct configfs_attribute *gadget_config_name_langid_attrs[] = {
659 &gadget_config_name_attr_configuration,
663 static void gadget_config_name_attr_release(struct config_item *item)
665 struct gadget_config_name *cn = to_gadget_config_name(item);
667 kfree(cn->configuration);
673 USB_CONFIG_STRING_RW_OPS(gadget_config_name);
674 USB_CONFIG_STRINGS_LANG(gadget_config_name, config_usb_cfg);
676 static struct config_group *config_desc_make(
677 struct config_group *group,
680 struct gadget_info *gi;
681 struct config_usb_cfg *cfg;
682 char buf[MAX_NAME_LEN];
687 gi = container_of(group, struct gadget_info, configs_group);
688 ret = snprintf(buf, MAX_NAME_LEN, "%s", name);
689 if (ret >= MAX_NAME_LEN)
690 return ERR_PTR(-ENAMETOOLONG);
692 num_str = strchr(buf, '.');
694 pr_err("Unable to locate . in name.bConfigurationValue\n");
695 return ERR_PTR(-EINVAL);
702 return ERR_PTR(-EINVAL);
704 ret = kstrtou8(num_str, 0, &num);
708 cfg = kzalloc(sizeof(*cfg), GFP_KERNEL);
710 return ERR_PTR(-ENOMEM);
711 cfg->c.label = kstrdup(buf, GFP_KERNEL);
716 cfg->c.bConfigurationValue = num;
717 cfg->c.MaxPower = CONFIG_USB_GADGET_VBUS_DRAW;
718 cfg->c.bmAttributes = USB_CONFIG_ATT_ONE;
719 INIT_LIST_HEAD(&cfg->string_list);
720 INIT_LIST_HEAD(&cfg->func_list);
722 config_group_init_type_name(&cfg->group, name,
723 &gadget_config_type);
725 config_group_init_type_name(&cfg->strings_group, "strings",
726 &gadget_config_name_strings_type);
727 configfs_add_default_group(&cfg->strings_group, &cfg->group);
729 ret = usb_add_config_only(&gi->cdev, &cfg->c);
740 static void config_desc_drop(
741 struct config_group *group,
742 struct config_item *item)
744 config_item_put(item);
747 static struct configfs_group_operations config_desc_ops = {
748 .make_group = &config_desc_make,
749 .drop_item = &config_desc_drop,
752 static const struct config_item_type config_desc_type = {
753 .ct_group_ops = &config_desc_ops,
754 .ct_owner = THIS_MODULE,
757 GS_STRINGS_RW(gadget_strings, manufacturer);
758 GS_STRINGS_RW(gadget_strings, product);
759 GS_STRINGS_RW(gadget_strings, serialnumber);
761 static struct configfs_attribute *gadget_strings_langid_attrs[] = {
762 &gadget_strings_attr_manufacturer,
763 &gadget_strings_attr_product,
764 &gadget_strings_attr_serialnumber,
768 static void gadget_strings_attr_release(struct config_item *item)
770 struct gadget_strings *gs = to_gadget_strings(item);
772 kfree(gs->manufacturer);
774 kfree(gs->serialnumber);
780 USB_CONFIG_STRING_RW_OPS(gadget_strings);
781 USB_CONFIG_STRINGS_LANG(gadget_strings, gadget_info);
783 static inline struct gadget_info *os_desc_item_to_gadget_info(
784 struct config_item *item)
786 return container_of(to_config_group(item),
787 struct gadget_info, os_desc_group);
790 static ssize_t os_desc_use_show(struct config_item *item, char *page)
792 return sprintf(page, "%d\n",
793 os_desc_item_to_gadget_info(item)->use_os_desc);
796 static ssize_t os_desc_use_store(struct config_item *item, const char *page,
799 struct gadget_info *gi = os_desc_item_to_gadget_info(item);
803 mutex_lock(&gi->lock);
804 ret = kstrtobool(page, &use);
806 gi->use_os_desc = use;
809 mutex_unlock(&gi->lock);
814 static ssize_t os_desc_b_vendor_code_show(struct config_item *item, char *page)
816 return sprintf(page, "0x%02x\n",
817 os_desc_item_to_gadget_info(item)->b_vendor_code);
820 static ssize_t os_desc_b_vendor_code_store(struct config_item *item,
821 const char *page, size_t len)
823 struct gadget_info *gi = os_desc_item_to_gadget_info(item);
827 mutex_lock(&gi->lock);
828 ret = kstrtou8(page, 0, &b_vendor_code);
830 gi->b_vendor_code = b_vendor_code;
833 mutex_unlock(&gi->lock);
838 static ssize_t os_desc_qw_sign_show(struct config_item *item, char *page)
840 struct gadget_info *gi = os_desc_item_to_gadget_info(item);
843 res = utf16s_to_utf8s((wchar_t *) gi->qw_sign, OS_STRING_QW_SIGN_LEN,
844 UTF16_LITTLE_ENDIAN, page, PAGE_SIZE - 1);
850 static ssize_t os_desc_qw_sign_store(struct config_item *item, const char *page,
853 struct gadget_info *gi = os_desc_item_to_gadget_info(item);
856 l = min((int)len, OS_STRING_QW_SIGN_LEN >> 1);
857 if (page[l - 1] == '\n')
860 mutex_lock(&gi->lock);
861 res = utf8s_to_utf16s(page, l,
862 UTF16_LITTLE_ENDIAN, (wchar_t *) gi->qw_sign,
863 OS_STRING_QW_SIGN_LEN);
866 mutex_unlock(&gi->lock);
871 CONFIGFS_ATTR(os_desc_, use);
872 CONFIGFS_ATTR(os_desc_, b_vendor_code);
873 CONFIGFS_ATTR(os_desc_, qw_sign);
875 static struct configfs_attribute *os_desc_attrs[] = {
877 &os_desc_attr_b_vendor_code,
878 &os_desc_attr_qw_sign,
882 static int os_desc_link(struct config_item *os_desc_ci,
883 struct config_item *usb_cfg_ci)
885 struct gadget_info *gi = os_desc_item_to_gadget_info(os_desc_ci);
886 struct usb_composite_dev *cdev = &gi->cdev;
887 struct config_usb_cfg *c_target = to_config_usb_cfg(usb_cfg_ci);
888 struct usb_configuration *c = NULL, *iter;
891 mutex_lock(&gi->lock);
892 list_for_each_entry(iter, &cdev->configs, list) {
893 if (iter != &c_target->c)
903 if (cdev->os_desc_config) {
908 cdev->os_desc_config = &c_target->c;
912 mutex_unlock(&gi->lock);
916 static void os_desc_unlink(struct config_item *os_desc_ci,
917 struct config_item *usb_cfg_ci)
919 struct gadget_info *gi = os_desc_item_to_gadget_info(os_desc_ci);
920 struct usb_composite_dev *cdev = &gi->cdev;
922 mutex_lock(&gi->lock);
923 if (gi->composite.gadget_driver.udc_name)
924 unregister_gadget(gi);
925 cdev->os_desc_config = NULL;
926 WARN_ON(gi->composite.gadget_driver.udc_name);
927 mutex_unlock(&gi->lock);
930 static struct configfs_item_operations os_desc_ops = {
931 .allow_link = os_desc_link,
932 .drop_link = os_desc_unlink,
935 static struct config_item_type os_desc_type = {
936 .ct_item_ops = &os_desc_ops,
937 .ct_attrs = os_desc_attrs,
938 .ct_owner = THIS_MODULE,
941 static inline struct usb_os_desc_ext_prop
942 *to_usb_os_desc_ext_prop(struct config_item *item)
944 return container_of(item, struct usb_os_desc_ext_prop, item);
947 static ssize_t ext_prop_type_show(struct config_item *item, char *page)
949 return sprintf(page, "%d\n", to_usb_os_desc_ext_prop(item)->type);
952 static ssize_t ext_prop_type_store(struct config_item *item,
953 const char *page, size_t len)
955 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
956 struct usb_os_desc *desc = to_usb_os_desc(ext_prop->item.ci_parent);
960 if (desc->opts_mutex)
961 mutex_lock(desc->opts_mutex);
962 ret = kstrtou8(page, 0, &type);
965 if (type < USB_EXT_PROP_UNICODE || type > USB_EXT_PROP_UNICODE_MULTI) {
970 if ((ext_prop->type == USB_EXT_PROP_BINARY ||
971 ext_prop->type == USB_EXT_PROP_LE32 ||
972 ext_prop->type == USB_EXT_PROP_BE32) &&
973 (type == USB_EXT_PROP_UNICODE ||
974 type == USB_EXT_PROP_UNICODE_ENV ||
975 type == USB_EXT_PROP_UNICODE_LINK))
976 ext_prop->data_len <<= 1;
977 else if ((ext_prop->type == USB_EXT_PROP_UNICODE ||
978 ext_prop->type == USB_EXT_PROP_UNICODE_ENV ||
979 ext_prop->type == USB_EXT_PROP_UNICODE_LINK) &&
980 (type == USB_EXT_PROP_BINARY ||
981 type == USB_EXT_PROP_LE32 ||
982 type == USB_EXT_PROP_BE32))
983 ext_prop->data_len >>= 1;
984 ext_prop->type = type;
988 if (desc->opts_mutex)
989 mutex_unlock(desc->opts_mutex);
993 static ssize_t ext_prop_data_show(struct config_item *item, char *page)
995 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
996 int len = ext_prop->data_len;
998 if (ext_prop->type == USB_EXT_PROP_UNICODE ||
999 ext_prop->type == USB_EXT_PROP_UNICODE_ENV ||
1000 ext_prop->type == USB_EXT_PROP_UNICODE_LINK)
1002 memcpy(page, ext_prop->data, len);
1007 static ssize_t ext_prop_data_store(struct config_item *item,
1008 const char *page, size_t len)
1010 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
1011 struct usb_os_desc *desc = to_usb_os_desc(ext_prop->item.ci_parent);
1013 size_t ret_len = len;
1015 if (page[len - 1] == '\n' || page[len - 1] == '\0')
1017 new_data = kmemdup(page, len, GFP_KERNEL);
1021 if (desc->opts_mutex)
1022 mutex_lock(desc->opts_mutex);
1023 kfree(ext_prop->data);
1024 ext_prop->data = new_data;
1025 desc->ext_prop_len -= ext_prop->data_len;
1026 ext_prop->data_len = len;
1027 desc->ext_prop_len += ext_prop->data_len;
1028 if (ext_prop->type == USB_EXT_PROP_UNICODE ||
1029 ext_prop->type == USB_EXT_PROP_UNICODE_ENV ||
1030 ext_prop->type == USB_EXT_PROP_UNICODE_LINK) {
1031 desc->ext_prop_len -= ext_prop->data_len;
1032 ext_prop->data_len <<= 1;
1033 ext_prop->data_len += 2;
1034 desc->ext_prop_len += ext_prop->data_len;
1036 if (desc->opts_mutex)
1037 mutex_unlock(desc->opts_mutex);
1041 CONFIGFS_ATTR(ext_prop_, type);
1042 CONFIGFS_ATTR(ext_prop_, data);
1044 static struct configfs_attribute *ext_prop_attrs[] = {
1045 &ext_prop_attr_type,
1046 &ext_prop_attr_data,
1050 static void usb_os_desc_ext_prop_release(struct config_item *item)
1052 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
1054 kfree(ext_prop); /* frees a whole chunk */
1057 static struct configfs_item_operations ext_prop_ops = {
1058 .release = usb_os_desc_ext_prop_release,
1061 static struct config_item *ext_prop_make(
1062 struct config_group *group,
1065 struct usb_os_desc_ext_prop *ext_prop;
1066 struct config_item_type *ext_prop_type;
1067 struct usb_os_desc *desc;
1070 vla_group(data_chunk);
1071 vla_item(data_chunk, struct usb_os_desc_ext_prop, ext_prop, 1);
1072 vla_item(data_chunk, struct config_item_type, ext_prop_type, 1);
1074 vlabuf = kzalloc(vla_group_size(data_chunk), GFP_KERNEL);
1076 return ERR_PTR(-ENOMEM);
1078 ext_prop = vla_ptr(vlabuf, data_chunk, ext_prop);
1079 ext_prop_type = vla_ptr(vlabuf, data_chunk, ext_prop_type);
1081 desc = container_of(group, struct usb_os_desc, group);
1082 ext_prop_type->ct_item_ops = &ext_prop_ops;
1083 ext_prop_type->ct_attrs = ext_prop_attrs;
1084 ext_prop_type->ct_owner = desc->owner;
1086 config_item_init_type_name(&ext_prop->item, name, ext_prop_type);
1088 ext_prop->name = kstrdup(name, GFP_KERNEL);
1089 if (!ext_prop->name) {
1091 return ERR_PTR(-ENOMEM);
1093 desc->ext_prop_len += 14;
1094 ext_prop->name_len = 2 * strlen(ext_prop->name) + 2;
1095 if (desc->opts_mutex)
1096 mutex_lock(desc->opts_mutex);
1097 desc->ext_prop_len += ext_prop->name_len;
1098 list_add_tail(&ext_prop->entry, &desc->ext_prop);
1099 ++desc->ext_prop_count;
1100 if (desc->opts_mutex)
1101 mutex_unlock(desc->opts_mutex);
1103 return &ext_prop->item;
1106 static void ext_prop_drop(struct config_group *group, struct config_item *item)
1108 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
1109 struct usb_os_desc *desc = to_usb_os_desc(&group->cg_item);
1111 if (desc->opts_mutex)
1112 mutex_lock(desc->opts_mutex);
1113 list_del(&ext_prop->entry);
1114 --desc->ext_prop_count;
1115 kfree(ext_prop->name);
1116 desc->ext_prop_len -= (ext_prop->name_len + ext_prop->data_len + 14);
1117 if (desc->opts_mutex)
1118 mutex_unlock(desc->opts_mutex);
1119 config_item_put(item);
1122 static struct configfs_group_operations interf_grp_ops = {
1123 .make_item = &ext_prop_make,
1124 .drop_item = &ext_prop_drop,
1127 static ssize_t interf_grp_compatible_id_show(struct config_item *item,
1130 memcpy(page, to_usb_os_desc(item)->ext_compat_id, 8);
1134 static ssize_t interf_grp_compatible_id_store(struct config_item *item,
1135 const char *page, size_t len)
1137 struct usb_os_desc *desc = to_usb_os_desc(item);
1140 l = min_t(int, 8, len);
1141 if (page[l - 1] == '\n')
1143 if (desc->opts_mutex)
1144 mutex_lock(desc->opts_mutex);
1145 memcpy(desc->ext_compat_id, page, l);
1147 if (desc->opts_mutex)
1148 mutex_unlock(desc->opts_mutex);
1153 static ssize_t interf_grp_sub_compatible_id_show(struct config_item *item,
1156 memcpy(page, to_usb_os_desc(item)->ext_compat_id + 8, 8);
1160 static ssize_t interf_grp_sub_compatible_id_store(struct config_item *item,
1161 const char *page, size_t len)
1163 struct usb_os_desc *desc = to_usb_os_desc(item);
1166 l = min_t(int, 8, len);
1167 if (page[l - 1] == '\n')
1169 if (desc->opts_mutex)
1170 mutex_lock(desc->opts_mutex);
1171 memcpy(desc->ext_compat_id + 8, page, l);
1173 if (desc->opts_mutex)
1174 mutex_unlock(desc->opts_mutex);
1179 CONFIGFS_ATTR(interf_grp_, compatible_id);
1180 CONFIGFS_ATTR(interf_grp_, sub_compatible_id);
1182 static struct configfs_attribute *interf_grp_attrs[] = {
1183 &interf_grp_attr_compatible_id,
1184 &interf_grp_attr_sub_compatible_id,
1188 struct config_group *usb_os_desc_prepare_interf_dir(
1189 struct config_group *parent,
1191 struct usb_os_desc **desc,
1193 struct module *owner)
1195 struct config_group *os_desc_group;
1196 struct config_item_type *os_desc_type, *interface_type;
1198 vla_group(data_chunk);
1199 vla_item(data_chunk, struct config_group, os_desc_group, 1);
1200 vla_item(data_chunk, struct config_item_type, os_desc_type, 1);
1201 vla_item(data_chunk, struct config_item_type, interface_type, 1);
1203 char *vlabuf = kzalloc(vla_group_size(data_chunk), GFP_KERNEL);
1205 return ERR_PTR(-ENOMEM);
1207 os_desc_group = vla_ptr(vlabuf, data_chunk, os_desc_group);
1208 os_desc_type = vla_ptr(vlabuf, data_chunk, os_desc_type);
1209 interface_type = vla_ptr(vlabuf, data_chunk, interface_type);
1211 os_desc_type->ct_owner = owner;
1212 config_group_init_type_name(os_desc_group, "os_desc", os_desc_type);
1213 configfs_add_default_group(os_desc_group, parent);
1215 interface_type->ct_group_ops = &interf_grp_ops;
1216 interface_type->ct_attrs = interf_grp_attrs;
1217 interface_type->ct_owner = owner;
1219 while (n_interf--) {
1220 struct usb_os_desc *d;
1224 config_group_init_type_name(&d->group, "", interface_type);
1225 config_item_set_name(&d->group.cg_item, "interface.%s",
1227 configfs_add_default_group(&d->group, os_desc_group);
1230 return os_desc_group;
1232 EXPORT_SYMBOL(usb_os_desc_prepare_interf_dir);
1234 static int configfs_do_nothing(struct usb_composite_dev *cdev)
1240 int composite_dev_prepare(struct usb_composite_driver *composite,
1241 struct usb_composite_dev *dev);
1243 int composite_os_desc_req_prepare(struct usb_composite_dev *cdev,
1244 struct usb_ep *ep0);
1246 static void purge_configs_funcs(struct gadget_info *gi)
1248 struct usb_configuration *c;
1250 list_for_each_entry(c, &gi->cdev.configs, list) {
1251 struct usb_function *f, *tmp;
1252 struct config_usb_cfg *cfg;
1254 cfg = container_of(c, struct config_usb_cfg, c);
1256 list_for_each_entry_safe_reverse(f, tmp, &c->functions, list) {
1258 list_move(&f->list, &cfg->func_list);
1260 dev_dbg(&gi->cdev.gadget->dev,
1261 "unbind function '%s'/%p\n",
1266 c->next_interface_id = 0;
1267 memset(c->interface, 0, sizeof(c->interface));
1268 c->superspeed_plus = 0;
1275 static int configfs_composite_bind(struct usb_gadget *gadget,
1276 struct usb_gadget_driver *gdriver)
1278 struct usb_composite_driver *composite = to_cdriver(gdriver);
1279 struct gadget_info *gi = container_of(composite,
1280 struct gadget_info, composite);
1281 struct usb_composite_dev *cdev = &gi->cdev;
1282 struct usb_configuration *c;
1283 struct usb_string *s;
1287 /* the gi->lock is hold by the caller */
1289 cdev->gadget = gadget;
1290 set_gadget_data(gadget, cdev);
1291 ret = composite_dev_prepare(composite, cdev);
1294 /* and now the gadget bind */
1297 if (list_empty(&gi->cdev.configs)) {
1298 pr_err("Need at least one configuration in %s.\n",
1299 gi->composite.name);
1300 goto err_comp_cleanup;
1304 list_for_each_entry(c, &gi->cdev.configs, list) {
1305 struct config_usb_cfg *cfg;
1307 cfg = container_of(c, struct config_usb_cfg, c);
1308 if (list_empty(&cfg->func_list)) {
1309 pr_err("Config %s/%d of %s needs at least one function.\n",
1310 c->label, c->bConfigurationValue,
1311 gi->composite.name);
1312 goto err_comp_cleanup;
1316 /* init all strings */
1317 if (!list_empty(&gi->string_list)) {
1318 struct gadget_strings *gs;
1321 list_for_each_entry(gs, &gi->string_list, list) {
1323 gi->gstrings[i] = &gs->stringtab_dev;
1324 gs->stringtab_dev.strings = gs->strings;
1325 gs->strings[USB_GADGET_MANUFACTURER_IDX].s =
1327 gs->strings[USB_GADGET_PRODUCT_IDX].s = gs->product;
1328 gs->strings[USB_GADGET_SERIAL_IDX].s = gs->serialnumber;
1331 gi->gstrings[i] = NULL;
1332 s = usb_gstrings_attach(&gi->cdev, gi->gstrings,
1333 USB_GADGET_FIRST_AVAIL_IDX);
1336 goto err_comp_cleanup;
1339 gi->cdev.desc.iManufacturer = s[USB_GADGET_MANUFACTURER_IDX].id;
1340 gi->cdev.desc.iProduct = s[USB_GADGET_PRODUCT_IDX].id;
1341 gi->cdev.desc.iSerialNumber = s[USB_GADGET_SERIAL_IDX].id;
1344 if (gi->use_os_desc) {
1345 cdev->use_os_string = true;
1346 cdev->b_vendor_code = gi->b_vendor_code;
1347 memcpy(cdev->qw_sign, gi->qw_sign, OS_STRING_QW_SIGN_LEN);
1350 if (gadget_is_otg(gadget) && !otg_desc[0]) {
1351 struct usb_descriptor_header *usb_desc;
1353 usb_desc = usb_otg_descriptor_alloc(gadget);
1356 goto err_comp_cleanup;
1358 usb_otg_descriptor_init(gadget, usb_desc);
1359 otg_desc[0] = usb_desc;
1363 /* Go through all configs, attach all functions */
1364 list_for_each_entry(c, &gi->cdev.configs, list) {
1365 struct config_usb_cfg *cfg;
1366 struct usb_function *f;
1367 struct usb_function *tmp;
1368 struct gadget_config_name *cn;
1370 if (gadget_is_otg(gadget))
1371 c->descriptors = otg_desc;
1373 cfg = container_of(c, struct config_usb_cfg, c);
1374 if (!list_empty(&cfg->string_list)) {
1376 list_for_each_entry(cn, &cfg->string_list, list) {
1377 cfg->gstrings[i] = &cn->stringtab_dev;
1378 cn->stringtab_dev.strings = &cn->strings;
1379 cn->strings.s = cn->configuration;
1382 cfg->gstrings[i] = NULL;
1383 s = usb_gstrings_attach(&gi->cdev, cfg->gstrings, 1);
1386 goto err_comp_cleanup;
1388 c->iConfiguration = s[0].id;
1391 list_for_each_entry_safe(f, tmp, &cfg->func_list, list) {
1393 ret = usb_add_function(c, f);
1395 list_add(&f->list, &cfg->func_list);
1396 goto err_purge_funcs;
1399 ret = usb_gadget_check_config(cdev->gadget);
1401 goto err_purge_funcs;
1403 usb_ep_autoconfig_reset(cdev->gadget);
1405 if (cdev->use_os_string) {
1406 ret = composite_os_desc_req_prepare(cdev, gadget->ep0);
1408 goto err_purge_funcs;
1411 usb_ep_autoconfig_reset(cdev->gadget);
1415 purge_configs_funcs(gi);
1417 composite_dev_cleanup(cdev);
1421 static void configfs_composite_unbind(struct usb_gadget *gadget)
1423 struct usb_composite_dev *cdev;
1424 struct gadget_info *gi;
1425 unsigned long flags;
1427 /* the gi->lock is hold by the caller */
1429 cdev = get_gadget_data(gadget);
1430 gi = container_of(cdev, struct gadget_info, cdev);
1431 spin_lock_irqsave(&gi->spinlock, flags);
1433 spin_unlock_irqrestore(&gi->spinlock, flags);
1437 purge_configs_funcs(gi);
1438 composite_dev_cleanup(cdev);
1439 usb_ep_autoconfig_reset(cdev->gadget);
1440 spin_lock_irqsave(&gi->spinlock, flags);
1441 cdev->gadget = NULL;
1442 cdev->deactivations = 0;
1443 gadget->deactivated = false;
1444 set_gadget_data(gadget, NULL);
1445 spin_unlock_irqrestore(&gi->spinlock, flags);
1448 static int configfs_composite_setup(struct usb_gadget *gadget,
1449 const struct usb_ctrlrequest *ctrl)
1451 struct usb_composite_dev *cdev;
1452 struct gadget_info *gi;
1453 unsigned long flags;
1456 cdev = get_gadget_data(gadget);
1460 gi = container_of(cdev, struct gadget_info, cdev);
1461 spin_lock_irqsave(&gi->spinlock, flags);
1462 cdev = get_gadget_data(gadget);
1463 if (!cdev || gi->unbind) {
1464 spin_unlock_irqrestore(&gi->spinlock, flags);
1468 ret = composite_setup(gadget, ctrl);
1469 spin_unlock_irqrestore(&gi->spinlock, flags);
1473 static void configfs_composite_disconnect(struct usb_gadget *gadget)
1475 struct usb_composite_dev *cdev;
1476 struct gadget_info *gi;
1477 unsigned long flags;
1479 cdev = get_gadget_data(gadget);
1483 gi = container_of(cdev, struct gadget_info, cdev);
1484 spin_lock_irqsave(&gi->spinlock, flags);
1485 cdev = get_gadget_data(gadget);
1486 if (!cdev || gi->unbind) {
1487 spin_unlock_irqrestore(&gi->spinlock, flags);
1491 composite_disconnect(gadget);
1492 spin_unlock_irqrestore(&gi->spinlock, flags);
1495 static void configfs_composite_reset(struct usb_gadget *gadget)
1497 struct usb_composite_dev *cdev;
1498 struct gadget_info *gi;
1499 unsigned long flags;
1501 cdev = get_gadget_data(gadget);
1505 gi = container_of(cdev, struct gadget_info, cdev);
1506 spin_lock_irqsave(&gi->spinlock, flags);
1507 cdev = get_gadget_data(gadget);
1508 if (!cdev || gi->unbind) {
1509 spin_unlock_irqrestore(&gi->spinlock, flags);
1513 composite_reset(gadget);
1514 spin_unlock_irqrestore(&gi->spinlock, flags);
1517 static void configfs_composite_suspend(struct usb_gadget *gadget)
1519 struct usb_composite_dev *cdev;
1520 struct gadget_info *gi;
1521 unsigned long flags;
1523 cdev = get_gadget_data(gadget);
1527 gi = container_of(cdev, struct gadget_info, cdev);
1528 spin_lock_irqsave(&gi->spinlock, flags);
1529 cdev = get_gadget_data(gadget);
1530 if (!cdev || gi->unbind) {
1531 spin_unlock_irqrestore(&gi->spinlock, flags);
1535 composite_suspend(gadget);
1536 spin_unlock_irqrestore(&gi->spinlock, flags);
1539 static void configfs_composite_resume(struct usb_gadget *gadget)
1541 struct usb_composite_dev *cdev;
1542 struct gadget_info *gi;
1543 unsigned long flags;
1545 cdev = get_gadget_data(gadget);
1549 gi = container_of(cdev, struct gadget_info, cdev);
1550 spin_lock_irqsave(&gi->spinlock, flags);
1551 cdev = get_gadget_data(gadget);
1552 if (!cdev || gi->unbind) {
1553 spin_unlock_irqrestore(&gi->spinlock, flags);
1557 composite_resume(gadget);
1558 spin_unlock_irqrestore(&gi->spinlock, flags);
1561 static const struct usb_gadget_driver configfs_driver_template = {
1562 .bind = configfs_composite_bind,
1563 .unbind = configfs_composite_unbind,
1565 .setup = configfs_composite_setup,
1566 .reset = configfs_composite_reset,
1567 .disconnect = configfs_composite_disconnect,
1569 .suspend = configfs_composite_suspend,
1570 .resume = configfs_composite_resume,
1572 .max_speed = USB_SPEED_SUPER_PLUS,
1574 .owner = THIS_MODULE,
1575 .name = "configfs-gadget",
1577 .match_existing_only = 1,
1580 static struct config_group *gadgets_make(
1581 struct config_group *group,
1584 struct gadget_info *gi;
1586 gi = kzalloc(sizeof(*gi), GFP_KERNEL);
1588 return ERR_PTR(-ENOMEM);
1590 config_group_init_type_name(&gi->group, name, &gadget_root_type);
1592 config_group_init_type_name(&gi->functions_group, "functions",
1594 configfs_add_default_group(&gi->functions_group, &gi->group);
1596 config_group_init_type_name(&gi->configs_group, "configs",
1598 configfs_add_default_group(&gi->configs_group, &gi->group);
1600 config_group_init_type_name(&gi->strings_group, "strings",
1601 &gadget_strings_strings_type);
1602 configfs_add_default_group(&gi->strings_group, &gi->group);
1604 config_group_init_type_name(&gi->os_desc_group, "os_desc",
1606 configfs_add_default_group(&gi->os_desc_group, &gi->group);
1608 gi->composite.bind = configfs_do_nothing;
1609 gi->composite.unbind = configfs_do_nothing;
1610 gi->composite.suspend = NULL;
1611 gi->composite.resume = NULL;
1612 gi->composite.max_speed = USB_SPEED_SUPER_PLUS;
1614 spin_lock_init(&gi->spinlock);
1615 mutex_init(&gi->lock);
1616 INIT_LIST_HEAD(&gi->string_list);
1617 INIT_LIST_HEAD(&gi->available_func);
1619 composite_init_dev(&gi->cdev);
1620 gi->cdev.desc.bLength = USB_DT_DEVICE_SIZE;
1621 gi->cdev.desc.bDescriptorType = USB_DT_DEVICE;
1622 gi->cdev.desc.bcdDevice = cpu_to_le16(get_default_bcdDevice());
1624 gi->composite.gadget_driver = configfs_driver_template;
1626 gi->composite.gadget_driver.function = kstrdup(name, GFP_KERNEL);
1627 gi->composite.name = gi->composite.gadget_driver.function;
1629 if (!gi->composite.gadget_driver.function)
1635 return ERR_PTR(-ENOMEM);
1638 static void gadgets_drop(struct config_group *group, struct config_item *item)
1640 config_item_put(item);
1643 static struct configfs_group_operations gadgets_ops = {
1644 .make_group = &gadgets_make,
1645 .drop_item = &gadgets_drop,
1648 static const struct config_item_type gadgets_type = {
1649 .ct_group_ops = &gadgets_ops,
1650 .ct_owner = THIS_MODULE,
1653 static struct configfs_subsystem gadget_subsys = {
1656 .ci_namebuf = "usb_gadget",
1657 .ci_type = &gadgets_type,
1660 .su_mutex = __MUTEX_INITIALIZER(gadget_subsys.su_mutex),
1663 void unregister_gadget_item(struct config_item *item)
1665 struct gadget_info *gi = to_gadget_info(item);
1667 mutex_lock(&gi->lock);
1668 unregister_gadget(gi);
1669 mutex_unlock(&gi->lock);
1671 EXPORT_SYMBOL_GPL(unregister_gadget_item);
1673 static int __init gadget_cfs_init(void)
1677 config_group_init(&gadget_subsys.su_group);
1679 ret = configfs_register_subsystem(&gadget_subsys);
1682 module_init(gadget_cfs_init);
1684 static void __exit gadget_cfs_exit(void)
1686 configfs_unregister_subsystem(&gadget_subsys);
1688 module_exit(gadget_cfs_exit);