1 #include <linux/configfs.h>
2 #include <linux/module.h>
3 #include <linux/slab.h>
4 #include <linux/device.h>
6 #include <linux/usb/composite.h>
7 #include <linux/usb/gadget_configfs.h>
10 #include "u_os_desc.h"
12 int check_user_usb_string(const char *name,
13 struct usb_gadget_strings *stringtab_dev)
15 unsigned primary_lang;
20 ret = kstrtou16(name, 0, &num);
24 primary_lang = num & 0x3ff;
27 /* simple sanity check for valid langid */
28 switch (primary_lang) {
37 stringtab_dev->language = num;
41 #define MAX_NAME_LEN 40
42 #define MAX_USB_STRING_LANGS 2
45 struct config_group group;
46 struct config_group functions_group;
47 struct config_group configs_group;
48 struct config_group strings_group;
49 struct config_group os_desc_group;
50 struct config_group *default_groups[5];
53 struct usb_gadget_strings *gstrings[MAX_USB_STRING_LANGS + 1];
54 struct list_head string_list;
55 struct list_head available_func;
59 struct usb_otg_descriptor otg;
61 struct usb_composite_driver composite;
62 struct usb_composite_dev cdev;
65 char qw_sign[OS_STRING_QW_SIGN_LEN];
68 struct config_usb_cfg {
69 struct config_group group;
70 struct config_group strings_group;
71 struct config_group *default_groups[2];
72 struct list_head string_list;
73 struct usb_configuration c;
74 struct list_head func_list;
75 struct usb_gadget_strings *gstrings[MAX_USB_STRING_LANGS + 1];
78 struct gadget_strings {
79 struct usb_gadget_strings stringtab_dev;
80 struct usb_string strings[USB_GADGET_FIRST_AVAIL_IDX];
85 struct config_group group;
86 struct list_head list;
90 struct config_group group;
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 static int usb_string_copy(const char *s, char **s_copy)
106 char *copy = *s_copy;
111 str = kstrdup(s, GFP_KERNEL);
114 if (str[ret - 1] == '\n')
121 CONFIGFS_ATTR_STRUCT(gadget_info);
122 CONFIGFS_ATTR_STRUCT(config_usb_cfg);
124 #define GI_DEVICE_DESC_ITEM_ATTR(name) \
125 static struct gadget_info_attribute gadget_cdev_desc_##name = \
126 __CONFIGFS_ATTR(name, S_IRUGO | S_IWUSR, \
127 gadget_dev_desc_##name##_show, \
128 gadget_dev_desc_##name##_store)
130 #define GI_DEVICE_DESC_SIMPLE_R_u8(__name) \
131 static ssize_t gadget_dev_desc_##__name##_show(struct gadget_info *gi, \
134 return sprintf(page, "0x%02x\n", gi->cdev.desc.__name); \
137 #define GI_DEVICE_DESC_SIMPLE_R_u16(__name) \
138 static ssize_t gadget_dev_desc_##__name##_show(struct gadget_info *gi, \
141 return sprintf(page, "0x%04x\n", le16_to_cpup(&gi->cdev.desc.__name)); \
145 #define GI_DEVICE_DESC_SIMPLE_W_u8(_name) \
146 static ssize_t gadget_dev_desc_##_name##_store(struct gadget_info *gi, \
147 const char *page, size_t len) \
151 ret = kstrtou8(page, 0, &val); \
154 gi->cdev.desc._name = val; \
158 #define GI_DEVICE_DESC_SIMPLE_W_u16(_name) \
159 static ssize_t gadget_dev_desc_##_name##_store(struct gadget_info *gi, \
160 const char *page, size_t len) \
164 ret = kstrtou16(page, 0, &val); \
167 gi->cdev.desc._name = cpu_to_le16p(&val); \
171 #define GI_DEVICE_DESC_SIMPLE_RW(_name, _type) \
172 GI_DEVICE_DESC_SIMPLE_R_##_type(_name) \
173 GI_DEVICE_DESC_SIMPLE_W_##_type(_name)
175 GI_DEVICE_DESC_SIMPLE_R_u16(bcdUSB);
176 GI_DEVICE_DESC_SIMPLE_RW(bDeviceClass, u8);
177 GI_DEVICE_DESC_SIMPLE_RW(bDeviceSubClass, u8);
178 GI_DEVICE_DESC_SIMPLE_RW(bDeviceProtocol, u8);
179 GI_DEVICE_DESC_SIMPLE_RW(bMaxPacketSize0, u8);
180 GI_DEVICE_DESC_SIMPLE_RW(idVendor, u16);
181 GI_DEVICE_DESC_SIMPLE_RW(idProduct, u16);
182 GI_DEVICE_DESC_SIMPLE_R_u16(bcdDevice);
184 static ssize_t is_valid_bcd(u16 bcd_val)
186 if ((bcd_val & 0xf) > 9)
188 if (((bcd_val >> 4) & 0xf) > 9)
190 if (((bcd_val >> 8) & 0xf) > 9)
192 if (((bcd_val >> 12) & 0xf) > 9)
197 static ssize_t gadget_dev_desc_bcdDevice_store(struct gadget_info *gi,
198 const char *page, size_t len)
203 ret = kstrtou16(page, 0, &bcdDevice);
206 ret = is_valid_bcd(bcdDevice);
210 gi->cdev.desc.bcdDevice = cpu_to_le16(bcdDevice);
214 static ssize_t gadget_dev_desc_bcdUSB_store(struct gadget_info *gi,
215 const char *page, size_t len)
220 ret = kstrtou16(page, 0, &bcdUSB);
223 ret = is_valid_bcd(bcdUSB);
227 gi->cdev.desc.bcdUSB = cpu_to_le16(bcdUSB);
231 static ssize_t gadget_dev_desc_UDC_show(struct gadget_info *gi, char *page)
233 return sprintf(page, "%s\n", gi->udc_name ?: "");
236 static int unregister_gadget(struct gadget_info *gi)
243 ret = usb_gadget_unregister_driver(&gi->composite.gadget_driver);
251 static ssize_t gadget_dev_desc_UDC_store(struct gadget_info *gi,
252 const char *page, size_t len)
257 name = kstrdup(page, GFP_KERNEL);
260 if (name[len - 1] == '\n')
261 name[len - 1] = '\0';
263 mutex_lock(&gi->lock);
266 ret = unregister_gadget(gi);
274 ret = udc_attach_driver(name, &gi->composite.gadget_driver);
279 mutex_unlock(&gi->lock);
283 mutex_unlock(&gi->lock);
287 GI_DEVICE_DESC_ITEM_ATTR(bDeviceClass);
288 GI_DEVICE_DESC_ITEM_ATTR(bDeviceSubClass);
289 GI_DEVICE_DESC_ITEM_ATTR(bDeviceProtocol);
290 GI_DEVICE_DESC_ITEM_ATTR(bMaxPacketSize0);
291 GI_DEVICE_DESC_ITEM_ATTR(idVendor);
292 GI_DEVICE_DESC_ITEM_ATTR(idProduct);
293 GI_DEVICE_DESC_ITEM_ATTR(bcdDevice);
294 GI_DEVICE_DESC_ITEM_ATTR(bcdUSB);
295 GI_DEVICE_DESC_ITEM_ATTR(UDC);
297 static struct configfs_attribute *gadget_root_attrs[] = {
298 &gadget_cdev_desc_bDeviceClass.attr,
299 &gadget_cdev_desc_bDeviceSubClass.attr,
300 &gadget_cdev_desc_bDeviceProtocol.attr,
301 &gadget_cdev_desc_bMaxPacketSize0.attr,
302 &gadget_cdev_desc_idVendor.attr,
303 &gadget_cdev_desc_idProduct.attr,
304 &gadget_cdev_desc_bcdDevice.attr,
305 &gadget_cdev_desc_bcdUSB.attr,
306 &gadget_cdev_desc_UDC.attr,
310 static inline struct gadget_info *to_gadget_info(struct config_item *item)
312 return container_of(to_config_group(item), struct gadget_info, group);
315 static inline struct gadget_strings *to_gadget_strings(struct config_item *item)
317 return container_of(to_config_group(item), struct gadget_strings,
321 static inline struct gadget_config_name *to_gadget_config_name(
322 struct config_item *item)
324 return container_of(to_config_group(item), struct gadget_config_name,
328 static inline struct config_usb_cfg *to_config_usb_cfg(struct config_item *item)
330 return container_of(to_config_group(item), struct config_usb_cfg,
334 static inline struct usb_function_instance *to_usb_function_instance(
335 struct config_item *item)
337 return container_of(to_config_group(item),
338 struct usb_function_instance, group);
341 static void gadget_info_attr_release(struct config_item *item)
343 struct gadget_info *gi = to_gadget_info(item);
345 WARN_ON(!list_empty(&gi->cdev.configs));
346 WARN_ON(!list_empty(&gi->string_list));
347 WARN_ON(!list_empty(&gi->available_func));
348 kfree(gi->composite.gadget_driver.function);
352 CONFIGFS_ATTR_OPS(gadget_info);
354 static struct configfs_item_operations gadget_root_item_ops = {
355 .release = gadget_info_attr_release,
356 .show_attribute = gadget_info_attr_show,
357 .store_attribute = gadget_info_attr_store,
360 static void gadget_config_attr_release(struct config_item *item)
362 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
364 WARN_ON(!list_empty(&cfg->c.functions));
365 list_del(&cfg->c.list);
370 static int config_usb_cfg_link(
371 struct config_item *usb_cfg_ci,
372 struct config_item *usb_func_ci)
374 struct config_usb_cfg *cfg = to_config_usb_cfg(usb_cfg_ci);
375 struct usb_composite_dev *cdev = cfg->c.cdev;
376 struct gadget_info *gi = container_of(cdev, struct gadget_info, cdev);
378 struct config_group *group = to_config_group(usb_func_ci);
379 struct usb_function_instance *fi = container_of(group,
380 struct usb_function_instance, group);
381 struct usb_function_instance *a_fi;
382 struct usb_function *f;
385 mutex_lock(&gi->lock);
387 * Make sure this function is from within our _this_ gadget and not
388 * from another gadget or a random directory.
389 * Also a function instance can only be linked once.
391 list_for_each_entry(a_fi, &gi->available_func, cfs_list) {
400 list_for_each_entry(f, &cfg->func_list, list) {
407 f = usb_get_function(fi);
413 /* stash the function until we bind it to the gadget */
414 list_add_tail(&f->list, &cfg->func_list);
417 mutex_unlock(&gi->lock);
421 static int config_usb_cfg_unlink(
422 struct config_item *usb_cfg_ci,
423 struct config_item *usb_func_ci)
425 struct config_usb_cfg *cfg = to_config_usb_cfg(usb_cfg_ci);
426 struct usb_composite_dev *cdev = cfg->c.cdev;
427 struct gadget_info *gi = container_of(cdev, struct gadget_info, cdev);
429 struct config_group *group = to_config_group(usb_func_ci);
430 struct usb_function_instance *fi = container_of(group,
431 struct usb_function_instance, group);
432 struct usb_function *f;
435 * ideally I would like to forbid to unlink functions while a gadget is
436 * bound to an UDC. Since this isn't possible at the moment, we simply
437 * force an unbind, the function is available here and then we can
438 * remove the function.
440 mutex_lock(&gi->lock);
442 unregister_gadget(gi);
443 WARN_ON(gi->udc_name);
445 list_for_each_entry(f, &cfg->func_list, list) {
449 mutex_unlock(&gi->lock);
453 mutex_unlock(&gi->lock);
454 WARN(1, "Unable to locate function to unbind\n");
458 CONFIGFS_ATTR_OPS(config_usb_cfg);
460 static struct configfs_item_operations gadget_config_item_ops = {
461 .release = gadget_config_attr_release,
462 .show_attribute = config_usb_cfg_attr_show,
463 .store_attribute = config_usb_cfg_attr_store,
464 .allow_link = config_usb_cfg_link,
465 .drop_link = config_usb_cfg_unlink,
469 static ssize_t gadget_config_desc_MaxPower_show(struct config_usb_cfg *cfg,
472 return sprintf(page, "%u\n", cfg->c.MaxPower);
475 static ssize_t gadget_config_desc_MaxPower_store(struct config_usb_cfg *cfg,
476 const char *page, size_t len)
480 ret = kstrtou16(page, 0, &val);
483 if (DIV_ROUND_UP(val, 8) > 0xff)
485 cfg->c.MaxPower = val;
489 static ssize_t gadget_config_desc_bmAttributes_show(struct config_usb_cfg *cfg,
492 return sprintf(page, "0x%02x\n", cfg->c.bmAttributes);
495 static ssize_t gadget_config_desc_bmAttributes_store(struct config_usb_cfg *cfg,
496 const char *page, size_t len)
500 ret = kstrtou8(page, 0, &val);
503 if (!(val & USB_CONFIG_ATT_ONE))
505 if (val & ~(USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER |
506 USB_CONFIG_ATT_WAKEUP))
508 cfg->c.bmAttributes = val;
512 #define CFG_CONFIG_DESC_ITEM_ATTR(name) \
513 static struct config_usb_cfg_attribute gadget_usb_cfg_##name = \
514 __CONFIGFS_ATTR(name, S_IRUGO | S_IWUSR, \
515 gadget_config_desc_##name##_show, \
516 gadget_config_desc_##name##_store)
518 CFG_CONFIG_DESC_ITEM_ATTR(MaxPower);
519 CFG_CONFIG_DESC_ITEM_ATTR(bmAttributes);
521 static struct configfs_attribute *gadget_config_attrs[] = {
522 &gadget_usb_cfg_MaxPower.attr,
523 &gadget_usb_cfg_bmAttributes.attr,
527 static struct config_item_type gadget_config_type = {
528 .ct_item_ops = &gadget_config_item_ops,
529 .ct_attrs = gadget_config_attrs,
530 .ct_owner = THIS_MODULE,
533 static struct config_item_type gadget_root_type = {
534 .ct_item_ops = &gadget_root_item_ops,
535 .ct_attrs = gadget_root_attrs,
536 .ct_owner = THIS_MODULE,
539 static void composite_init_dev(struct usb_composite_dev *cdev)
541 spin_lock_init(&cdev->lock);
542 INIT_LIST_HEAD(&cdev->configs);
543 INIT_LIST_HEAD(&cdev->gstrings);
546 static struct config_group *function_make(
547 struct config_group *group,
550 struct gadget_info *gi;
551 struct usb_function_instance *fi;
552 char buf[MAX_NAME_LEN];
557 ret = snprintf(buf, MAX_NAME_LEN, "%s", name);
558 if (ret >= MAX_NAME_LEN)
559 return ERR_PTR(-ENAMETOOLONG);
562 instance_name = strchr(func_name, '.');
563 if (!instance_name) {
564 pr_err("Unable to locate . in FUNC.INSTANCE\n");
565 return ERR_PTR(-EINVAL);
567 *instance_name = '\0';
570 fi = usb_get_function_instance(func_name);
574 ret = config_item_set_name(&fi->group.cg_item, name);
576 usb_put_function_instance(fi);
579 if (fi->set_inst_name) {
580 ret = fi->set_inst_name(fi, instance_name);
582 usb_put_function_instance(fi);
587 gi = container_of(group, struct gadget_info, functions_group);
589 mutex_lock(&gi->lock);
590 list_add_tail(&fi->cfs_list, &gi->available_func);
591 mutex_unlock(&gi->lock);
595 static void function_drop(
596 struct config_group *group,
597 struct config_item *item)
599 struct usb_function_instance *fi = to_usb_function_instance(item);
600 struct gadget_info *gi;
602 gi = container_of(group, struct gadget_info, functions_group);
604 mutex_lock(&gi->lock);
605 list_del(&fi->cfs_list);
606 mutex_unlock(&gi->lock);
607 config_item_put(item);
610 static struct configfs_group_operations functions_ops = {
611 .make_group = &function_make,
612 .drop_item = &function_drop,
615 static struct config_item_type functions_type = {
616 .ct_group_ops = &functions_ops,
617 .ct_owner = THIS_MODULE,
620 CONFIGFS_ATTR_STRUCT(gadget_config_name);
621 GS_STRINGS_RW(gadget_config_name, configuration);
623 static struct configfs_attribute *gadget_config_name_langid_attrs[] = {
624 &gadget_config_name_configuration.attr,
628 static void gadget_config_name_attr_release(struct config_item *item)
630 struct gadget_config_name *cn = to_gadget_config_name(item);
632 kfree(cn->configuration);
638 USB_CONFIG_STRING_RW_OPS(gadget_config_name);
639 USB_CONFIG_STRINGS_LANG(gadget_config_name, config_usb_cfg);
641 static struct config_group *config_desc_make(
642 struct config_group *group,
645 struct gadget_info *gi;
646 struct config_usb_cfg *cfg;
647 char buf[MAX_NAME_LEN];
652 gi = container_of(group, struct gadget_info, configs_group);
653 ret = snprintf(buf, MAX_NAME_LEN, "%s", name);
654 if (ret >= MAX_NAME_LEN)
655 return ERR_PTR(-ENAMETOOLONG);
657 num_str = strchr(buf, '.');
659 pr_err("Unable to locate . in name.bConfigurationValue\n");
660 return ERR_PTR(-EINVAL);
667 return ERR_PTR(-EINVAL);
669 ret = kstrtou8(num_str, 0, &num);
673 cfg = kzalloc(sizeof(*cfg), GFP_KERNEL);
675 return ERR_PTR(-ENOMEM);
676 cfg->c.label = kstrdup(buf, GFP_KERNEL);
681 cfg->c.bConfigurationValue = num;
682 cfg->c.MaxPower = CONFIG_USB_GADGET_VBUS_DRAW;
683 cfg->c.bmAttributes = USB_CONFIG_ATT_ONE;
684 INIT_LIST_HEAD(&cfg->string_list);
685 INIT_LIST_HEAD(&cfg->func_list);
687 cfg->group.default_groups = cfg->default_groups;
688 cfg->default_groups[0] = &cfg->strings_group;
690 config_group_init_type_name(&cfg->group, name,
691 &gadget_config_type);
692 config_group_init_type_name(&cfg->strings_group, "strings",
693 &gadget_config_name_strings_type);
695 ret = usb_add_config_only(&gi->cdev, &cfg->c);
706 static void config_desc_drop(
707 struct config_group *group,
708 struct config_item *item)
710 config_item_put(item);
713 static struct configfs_group_operations config_desc_ops = {
714 .make_group = &config_desc_make,
715 .drop_item = &config_desc_drop,
718 static struct config_item_type config_desc_type = {
719 .ct_group_ops = &config_desc_ops,
720 .ct_owner = THIS_MODULE,
723 CONFIGFS_ATTR_STRUCT(gadget_strings);
724 GS_STRINGS_RW(gadget_strings, manufacturer);
725 GS_STRINGS_RW(gadget_strings, product);
726 GS_STRINGS_RW(gadget_strings, serialnumber);
728 static struct configfs_attribute *gadget_strings_langid_attrs[] = {
729 &gadget_strings_manufacturer.attr,
730 &gadget_strings_product.attr,
731 &gadget_strings_serialnumber.attr,
735 static void gadget_strings_attr_release(struct config_item *item)
737 struct gadget_strings *gs = to_gadget_strings(item);
739 kfree(gs->manufacturer);
741 kfree(gs->serialnumber);
747 USB_CONFIG_STRING_RW_OPS(gadget_strings);
748 USB_CONFIG_STRINGS_LANG(gadget_strings, gadget_info);
750 static inline struct os_desc *to_os_desc(struct config_item *item)
752 return container_of(to_config_group(item), struct os_desc, group);
755 CONFIGFS_ATTR_STRUCT(os_desc);
756 CONFIGFS_ATTR_OPS(os_desc);
758 static ssize_t os_desc_use_show(struct os_desc *os_desc, char *page)
760 struct gadget_info *gi;
762 gi = to_gadget_info(os_desc->group.cg_item.ci_parent);
764 return sprintf(page, "%d", gi->use_os_desc);
767 static ssize_t os_desc_use_store(struct os_desc *os_desc, const char *page,
770 struct gadget_info *gi;
774 gi = to_gadget_info(os_desc->group.cg_item.ci_parent);
776 mutex_lock(&gi->lock);
777 ret = strtobool(page, &use);
779 gi->use_os_desc = use;
782 mutex_unlock(&gi->lock);
787 static struct os_desc_attribute os_desc_use =
788 __CONFIGFS_ATTR(use, S_IRUGO | S_IWUSR,
792 static ssize_t os_desc_b_vendor_code_show(struct os_desc *os_desc, char *page)
794 struct gadget_info *gi;
796 gi = to_gadget_info(os_desc->group.cg_item.ci_parent);
798 return sprintf(page, "%d", gi->b_vendor_code);
801 static ssize_t os_desc_b_vendor_code_store(struct os_desc *os_desc,
802 const char *page, size_t len)
804 struct gadget_info *gi;
808 gi = to_gadget_info(os_desc->group.cg_item.ci_parent);
810 mutex_lock(&gi->lock);
811 ret = kstrtou8(page, 0, &b_vendor_code);
813 gi->b_vendor_code = b_vendor_code;
816 mutex_unlock(&gi->lock);
821 static struct os_desc_attribute os_desc_b_vendor_code =
822 __CONFIGFS_ATTR(b_vendor_code, S_IRUGO | S_IWUSR,
823 os_desc_b_vendor_code_show,
824 os_desc_b_vendor_code_store);
826 static ssize_t os_desc_qw_sign_show(struct os_desc *os_desc, char *page)
828 struct gadget_info *gi;
830 gi = to_gadget_info(os_desc->group.cg_item.ci_parent);
832 memcpy(page, gi->qw_sign, OS_STRING_QW_SIGN_LEN);
834 return OS_STRING_QW_SIGN_LEN;
837 static ssize_t os_desc_qw_sign_store(struct os_desc *os_desc, const char *page,
840 struct gadget_info *gi;
843 gi = to_gadget_info(os_desc->group.cg_item.ci_parent);
844 l = min((int)len, OS_STRING_QW_SIGN_LEN >> 1);
845 if (page[l - 1] == '\n')
848 mutex_lock(&gi->lock);
849 res = utf8s_to_utf16s(page, l,
850 UTF16_LITTLE_ENDIAN, (wchar_t *) gi->qw_sign,
851 OS_STRING_QW_SIGN_LEN);
854 mutex_unlock(&gi->lock);
859 static struct os_desc_attribute os_desc_qw_sign =
860 __CONFIGFS_ATTR(qw_sign, S_IRUGO | S_IWUSR,
861 os_desc_qw_sign_show,
862 os_desc_qw_sign_store);
864 static struct configfs_attribute *os_desc_attrs[] = {
866 &os_desc_b_vendor_code.attr,
867 &os_desc_qw_sign.attr,
871 static void os_desc_attr_release(struct config_item *item)
873 struct os_desc *os_desc = to_os_desc(item);
877 static int os_desc_link(struct config_item *os_desc_ci,
878 struct config_item *usb_cfg_ci)
880 struct gadget_info *gi = container_of(to_config_group(os_desc_ci),
881 struct gadget_info, os_desc_group);
882 struct usb_composite_dev *cdev = &gi->cdev;
883 struct config_usb_cfg *c_target =
884 container_of(to_config_group(usb_cfg_ci),
885 struct config_usb_cfg, group);
886 struct usb_configuration *c;
889 mutex_lock(&gi->lock);
890 list_for_each_entry(c, &cdev->configs, list) {
891 if (c == &c_target->c)
894 if (c != &c_target->c) {
899 if (cdev->os_desc_config) {
904 cdev->os_desc_config = &c_target->c;
908 mutex_unlock(&gi->lock);
912 static int os_desc_unlink(struct config_item *os_desc_ci,
913 struct config_item *usb_cfg_ci)
915 struct gadget_info *gi = container_of(to_config_group(os_desc_ci),
916 struct gadget_info, os_desc_group);
917 struct usb_composite_dev *cdev = &gi->cdev;
919 mutex_lock(&gi->lock);
921 unregister_gadget(gi);
922 cdev->os_desc_config = NULL;
923 WARN_ON(gi->udc_name);
924 mutex_unlock(&gi->lock);
928 static struct configfs_item_operations os_desc_ops = {
929 .release = os_desc_attr_release,
930 .show_attribute = os_desc_attr_show,
931 .store_attribute = os_desc_attr_store,
932 .allow_link = os_desc_link,
933 .drop_link = os_desc_unlink,
936 static struct config_item_type os_desc_type = {
937 .ct_item_ops = &os_desc_ops,
938 .ct_attrs = os_desc_attrs,
939 .ct_owner = THIS_MODULE,
942 CONFIGFS_ATTR_STRUCT(usb_os_desc);
943 CONFIGFS_ATTR_OPS(usb_os_desc);
946 static inline struct usb_os_desc_ext_prop
947 *to_usb_os_desc_ext_prop(struct config_item *item)
949 return container_of(item, struct usb_os_desc_ext_prop, item);
952 CONFIGFS_ATTR_STRUCT(usb_os_desc_ext_prop);
953 CONFIGFS_ATTR_OPS(usb_os_desc_ext_prop);
955 static ssize_t ext_prop_type_show(struct usb_os_desc_ext_prop *ext_prop,
958 return sprintf(page, "%d", ext_prop->type);
961 static ssize_t ext_prop_type_store(struct usb_os_desc_ext_prop *ext_prop,
962 const char *page, size_t len)
964 struct usb_os_desc *desc = to_usb_os_desc(ext_prop->item.ci_parent);
968 if (desc->opts_mutex)
969 mutex_lock(desc->opts_mutex);
970 ret = kstrtou8(page, 0, &type);
973 if (type < USB_EXT_PROP_UNICODE || type > USB_EXT_PROP_UNICODE_MULTI) {
978 if ((ext_prop->type == USB_EXT_PROP_BINARY ||
979 ext_prop->type == USB_EXT_PROP_LE32 ||
980 ext_prop->type == USB_EXT_PROP_BE32) &&
981 (type == USB_EXT_PROP_UNICODE ||
982 type == USB_EXT_PROP_UNICODE_ENV ||
983 type == USB_EXT_PROP_UNICODE_LINK))
984 ext_prop->data_len <<= 1;
985 else if ((ext_prop->type == USB_EXT_PROP_UNICODE ||
986 ext_prop->type == USB_EXT_PROP_UNICODE_ENV ||
987 ext_prop->type == USB_EXT_PROP_UNICODE_LINK) &&
988 (type == USB_EXT_PROP_BINARY ||
989 type == USB_EXT_PROP_LE32 ||
990 type == USB_EXT_PROP_BE32))
991 ext_prop->data_len >>= 1;
992 ext_prop->type = type;
996 if (desc->opts_mutex)
997 mutex_unlock(desc->opts_mutex);
1001 static ssize_t ext_prop_data_show(struct usb_os_desc_ext_prop *ext_prop,
1004 int len = ext_prop->data_len;
1006 if (ext_prop->type == USB_EXT_PROP_UNICODE ||
1007 ext_prop->type == USB_EXT_PROP_UNICODE_ENV ||
1008 ext_prop->type == USB_EXT_PROP_UNICODE_LINK)
1010 memcpy(page, ext_prop->data, len);
1015 static ssize_t ext_prop_data_store(struct usb_os_desc_ext_prop *ext_prop,
1016 const char *page, size_t len)
1018 struct usb_os_desc *desc = to_usb_os_desc(ext_prop->item.ci_parent);
1020 size_t ret_len = len;
1022 if (page[len - 1] == '\n' || page[len - 1] == '\0')
1024 new_data = kzalloc(len, GFP_KERNEL);
1028 memcpy(new_data, page, len);
1030 if (desc->opts_mutex)
1031 mutex_lock(desc->opts_mutex);
1032 kfree(ext_prop->data);
1033 ext_prop->data = new_data;
1034 desc->ext_prop_len -= ext_prop->data_len;
1035 ext_prop->data_len = len;
1036 desc->ext_prop_len += ext_prop->data_len;
1037 if (ext_prop->type == USB_EXT_PROP_UNICODE ||
1038 ext_prop->type == USB_EXT_PROP_UNICODE_ENV ||
1039 ext_prop->type == USB_EXT_PROP_UNICODE_LINK) {
1040 desc->ext_prop_len -= ext_prop->data_len;
1041 ext_prop->data_len <<= 1;
1042 ext_prop->data_len += 2;
1043 desc->ext_prop_len += ext_prop->data_len;
1045 if (desc->opts_mutex)
1046 mutex_unlock(desc->opts_mutex);
1050 static struct usb_os_desc_ext_prop_attribute ext_prop_type =
1051 __CONFIGFS_ATTR(type, S_IRUGO | S_IWUSR,
1052 ext_prop_type_show, ext_prop_type_store);
1054 static struct usb_os_desc_ext_prop_attribute ext_prop_data =
1055 __CONFIGFS_ATTR(data, S_IRUGO | S_IWUSR,
1056 ext_prop_data_show, ext_prop_data_store);
1058 static struct configfs_attribute *ext_prop_attrs[] = {
1059 &ext_prop_type.attr,
1060 &ext_prop_data.attr,
1064 static void usb_os_desc_ext_prop_release(struct config_item *item)
1066 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
1068 kfree(ext_prop); /* frees a whole chunk */
1071 static struct configfs_item_operations ext_prop_ops = {
1072 .release = usb_os_desc_ext_prop_release,
1073 .show_attribute = usb_os_desc_ext_prop_attr_show,
1074 .store_attribute = usb_os_desc_ext_prop_attr_store,
1077 static struct config_item *ext_prop_make(
1078 struct config_group *group,
1081 struct usb_os_desc_ext_prop *ext_prop;
1082 struct config_item_type *ext_prop_type;
1083 struct usb_os_desc *desc;
1086 vla_group(data_chunk);
1087 vla_item(data_chunk, struct usb_os_desc_ext_prop, ext_prop, 1);
1088 vla_item(data_chunk, struct config_item_type, ext_prop_type, 1);
1090 vlabuf = kzalloc(vla_group_size(data_chunk), GFP_KERNEL);
1092 return ERR_PTR(-ENOMEM);
1094 ext_prop = vla_ptr(vlabuf, data_chunk, ext_prop);
1095 ext_prop_type = vla_ptr(vlabuf, data_chunk, ext_prop_type);
1097 desc = container_of(group, struct usb_os_desc, group);
1098 ext_prop_type->ct_item_ops = &ext_prop_ops;
1099 ext_prop_type->ct_attrs = ext_prop_attrs;
1100 ext_prop_type->ct_owner = desc->owner;
1102 config_item_init_type_name(&ext_prop->item, name, ext_prop_type);
1104 ext_prop->name = kstrdup(name, GFP_KERNEL);
1105 if (!ext_prop->name) {
1107 return ERR_PTR(-ENOMEM);
1109 desc->ext_prop_len += 14;
1110 ext_prop->name_len = 2 * strlen(ext_prop->name) + 2;
1111 if (desc->opts_mutex)
1112 mutex_lock(desc->opts_mutex);
1113 desc->ext_prop_len += ext_prop->name_len;
1114 list_add_tail(&ext_prop->entry, &desc->ext_prop);
1115 ++desc->ext_prop_count;
1116 if (desc->opts_mutex)
1117 mutex_unlock(desc->opts_mutex);
1119 return &ext_prop->item;
1122 static void ext_prop_drop(struct config_group *group, struct config_item *item)
1124 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
1125 struct usb_os_desc *desc = to_usb_os_desc(&group->cg_item);
1127 if (desc->opts_mutex)
1128 mutex_lock(desc->opts_mutex);
1129 list_del(&ext_prop->entry);
1130 --desc->ext_prop_count;
1131 kfree(ext_prop->name);
1132 desc->ext_prop_len -= (ext_prop->name_len + ext_prop->data_len + 14);
1133 if (desc->opts_mutex)
1134 mutex_unlock(desc->opts_mutex);
1135 config_item_put(item);
1138 static struct configfs_group_operations interf_grp_ops = {
1139 .make_item = &ext_prop_make,
1140 .drop_item = &ext_prop_drop,
1143 static struct configfs_item_operations interf_item_ops = {
1144 .show_attribute = usb_os_desc_attr_show,
1145 .store_attribute = usb_os_desc_attr_store,
1148 static ssize_t rndis_grp_compatible_id_show(struct usb_os_desc *desc,
1151 memcpy(page, desc->ext_compat_id, 8);
1155 static ssize_t rndis_grp_compatible_id_store(struct usb_os_desc *desc,
1156 const char *page, size_t len)
1160 l = min_t(int, 8, len);
1161 if (page[l - 1] == '\n')
1163 if (desc->opts_mutex)
1164 mutex_lock(desc->opts_mutex);
1165 memcpy(desc->ext_compat_id, page, l);
1166 desc->ext_compat_id[l] = '\0';
1168 if (desc->opts_mutex)
1169 mutex_unlock(desc->opts_mutex);
1174 static struct usb_os_desc_attribute rndis_grp_attr_compatible_id =
1175 __CONFIGFS_ATTR(compatible_id, S_IRUGO | S_IWUSR,
1176 rndis_grp_compatible_id_show,
1177 rndis_grp_compatible_id_store);
1179 static ssize_t rndis_grp_sub_compatible_id_show(struct usb_os_desc *desc,
1182 memcpy(page, desc->ext_compat_id + 8, 8);
1186 static ssize_t rndis_grp_sub_compatible_id_store(struct usb_os_desc *desc,
1187 const char *page, size_t len)
1191 l = min_t(int, 8, len);
1192 if (page[l - 1] == '\n')
1194 if (desc->opts_mutex)
1195 mutex_lock(desc->opts_mutex);
1196 memcpy(desc->ext_compat_id + 8, page, l);
1197 desc->ext_compat_id[l + 8] = '\0';
1199 if (desc->opts_mutex)
1200 mutex_unlock(desc->opts_mutex);
1205 static struct usb_os_desc_attribute rndis_grp_attr_sub_compatible_id =
1206 __CONFIGFS_ATTR(sub_compatible_id, S_IRUGO | S_IWUSR,
1207 rndis_grp_sub_compatible_id_show,
1208 rndis_grp_sub_compatible_id_store);
1210 static struct configfs_attribute *interf_grp_attrs[] = {
1211 &rndis_grp_attr_compatible_id.attr,
1212 &rndis_grp_attr_sub_compatible_id.attr,
1216 int usb_os_desc_prepare_interf_dir(struct config_group *parent,
1218 struct usb_os_desc **desc,
1219 struct module *owner)
1221 struct config_group **f_default_groups, *os_desc_group,
1223 struct config_item_type *os_desc_type, *interface_type;
1225 vla_group(data_chunk);
1226 vla_item(data_chunk, struct config_group *, f_default_groups, 2);
1227 vla_item(data_chunk, struct config_group, os_desc_group, 1);
1228 vla_item(data_chunk, struct config_group *, interface_groups,
1230 vla_item(data_chunk, struct config_item_type, os_desc_type, 1);
1231 vla_item(data_chunk, struct config_item_type, interface_type, 1);
1233 char *vlabuf = kzalloc(vla_group_size(data_chunk), GFP_KERNEL);
1237 f_default_groups = vla_ptr(vlabuf, data_chunk, f_default_groups);
1238 os_desc_group = vla_ptr(vlabuf, data_chunk, os_desc_group);
1239 os_desc_type = vla_ptr(vlabuf, data_chunk, os_desc_type);
1240 interface_groups = vla_ptr(vlabuf, data_chunk, interface_groups);
1241 interface_type = vla_ptr(vlabuf, data_chunk, interface_type);
1243 parent->default_groups = f_default_groups;
1244 os_desc_type->ct_owner = owner;
1245 config_group_init_type_name(os_desc_group, "os_desc", os_desc_type);
1246 f_default_groups[0] = os_desc_group;
1248 os_desc_group->default_groups = interface_groups;
1249 interface_type->ct_item_ops = &interf_item_ops;
1250 interface_type->ct_group_ops = &interf_grp_ops;
1251 interface_type->ct_attrs = interf_grp_attrs;
1252 interface_type->ct_owner = owner;
1254 while (n_interf--) {
1255 struct usb_os_desc *d;
1259 config_group_init_type_name(&d->group, "", interface_type);
1260 config_item_set_name(&d->group.cg_item, "interface.%d",
1262 interface_groups[n_interf] = &d->group;
1267 EXPORT_SYMBOL(usb_os_desc_prepare_interf_dir);
1269 static int configfs_do_nothing(struct usb_composite_dev *cdev)
1275 int composite_dev_prepare(struct usb_composite_driver *composite,
1276 struct usb_composite_dev *dev);
1278 int composite_os_desc_req_prepare(struct usb_composite_dev *cdev,
1279 struct usb_ep *ep0);
1281 static void purge_configs_funcs(struct gadget_info *gi)
1283 struct usb_configuration *c;
1285 list_for_each_entry(c, &gi->cdev.configs, list) {
1286 struct usb_function *f, *tmp;
1287 struct config_usb_cfg *cfg;
1289 cfg = container_of(c, struct config_usb_cfg, c);
1291 list_for_each_entry_safe(f, tmp, &c->functions, list) {
1293 list_move_tail(&f->list, &cfg->func_list);
1295 dev_err(&gi->cdev.gadget->dev, "unbind function"
1296 " '%s'/%p\n", f->name, f);
1300 c->next_interface_id = 0;
1307 static int configfs_composite_bind(struct usb_gadget *gadget,
1308 struct usb_gadget_driver *gdriver)
1310 struct usb_composite_driver *composite = to_cdriver(gdriver);
1311 struct gadget_info *gi = container_of(composite,
1312 struct gadget_info, composite);
1313 struct usb_composite_dev *cdev = &gi->cdev;
1314 struct usb_configuration *c;
1315 struct usb_string *s;
1319 /* the gi->lock is hold by the caller */
1320 cdev->gadget = gadget;
1321 set_gadget_data(gadget, cdev);
1322 ret = composite_dev_prepare(composite, cdev);
1325 /* and now the gadget bind */
1328 if (list_empty(&gi->cdev.configs)) {
1329 pr_err("Need at least one configuration in %s.\n",
1330 gi->composite.name);
1331 goto err_comp_cleanup;
1335 list_for_each_entry(c, &gi->cdev.configs, list) {
1336 struct config_usb_cfg *cfg;
1338 cfg = container_of(c, struct config_usb_cfg, c);
1339 if (list_empty(&cfg->func_list)) {
1340 pr_err("Config %s/%d of %s needs at least one function.\n",
1341 c->label, c->bConfigurationValue,
1342 gi->composite.name);
1343 goto err_comp_cleanup;
1347 /* init all strings */
1348 if (!list_empty(&gi->string_list)) {
1349 struct gadget_strings *gs;
1352 list_for_each_entry(gs, &gi->string_list, list) {
1354 gi->gstrings[i] = &gs->stringtab_dev;
1355 gs->stringtab_dev.strings = gs->strings;
1356 gs->strings[USB_GADGET_MANUFACTURER_IDX].s =
1358 gs->strings[USB_GADGET_PRODUCT_IDX].s = gs->product;
1359 gs->strings[USB_GADGET_SERIAL_IDX].s = gs->serialnumber;
1362 gi->gstrings[i] = NULL;
1363 s = usb_gstrings_attach(&gi->cdev, gi->gstrings,
1364 USB_GADGET_FIRST_AVAIL_IDX);
1367 goto err_comp_cleanup;
1370 gi->cdev.desc.iManufacturer = s[USB_GADGET_MANUFACTURER_IDX].id;
1371 gi->cdev.desc.iProduct = s[USB_GADGET_PRODUCT_IDX].id;
1372 gi->cdev.desc.iSerialNumber = s[USB_GADGET_SERIAL_IDX].id;
1375 if (gi->use_os_desc) {
1376 cdev->use_os_string = true;
1377 cdev->b_vendor_code = gi->b_vendor_code;
1378 memcpy(cdev->qw_sign, gi->qw_sign, OS_STRING_QW_SIGN_LEN);
1381 /* Go through all configs, attach all functions */
1382 list_for_each_entry(c, &gi->cdev.configs, list) {
1383 struct config_usb_cfg *cfg;
1384 struct usb_function *f;
1385 struct usb_function *tmp;
1386 struct gadget_config_name *cn;
1388 cfg = container_of(c, struct config_usb_cfg, c);
1389 if (!list_empty(&cfg->string_list)) {
1391 list_for_each_entry(cn, &cfg->string_list, list) {
1392 cfg->gstrings[i] = &cn->stringtab_dev;
1393 cn->stringtab_dev.strings = &cn->strings;
1394 cn->strings.s = cn->configuration;
1397 cfg->gstrings[i] = NULL;
1398 s = usb_gstrings_attach(&gi->cdev, cfg->gstrings, 1);
1401 goto err_comp_cleanup;
1403 c->iConfiguration = s[0].id;
1406 list_for_each_entry_safe(f, tmp, &cfg->func_list, list) {
1408 ret = usb_add_function(c, f);
1410 list_add(&f->list, &cfg->func_list);
1411 goto err_purge_funcs;
1414 usb_ep_autoconfig_reset(cdev->gadget);
1416 if (cdev->use_os_string) {
1417 ret = composite_os_desc_req_prepare(cdev, gadget->ep0);
1419 goto err_purge_funcs;
1422 usb_ep_autoconfig_reset(cdev->gadget);
1426 purge_configs_funcs(gi);
1428 composite_dev_cleanup(cdev);
1432 static void configfs_composite_unbind(struct usb_gadget *gadget)
1434 struct usb_composite_dev *cdev;
1435 struct gadget_info *gi;
1437 /* the gi->lock is hold by the caller */
1439 cdev = get_gadget_data(gadget);
1440 gi = container_of(cdev, struct gadget_info, cdev);
1442 purge_configs_funcs(gi);
1443 composite_dev_cleanup(cdev);
1444 usb_ep_autoconfig_reset(cdev->gadget);
1445 cdev->gadget = NULL;
1446 set_gadget_data(gadget, NULL);
1449 static const struct usb_gadget_driver configfs_driver_template = {
1450 .bind = configfs_composite_bind,
1451 .unbind = configfs_composite_unbind,
1453 .setup = composite_setup,
1454 .disconnect = composite_disconnect,
1456 .max_speed = USB_SPEED_SUPER,
1458 .owner = THIS_MODULE,
1459 .name = "configfs-gadget",
1463 static struct config_group *gadgets_make(
1464 struct config_group *group,
1467 struct gadget_info *gi;
1469 gi = kzalloc(sizeof(*gi), GFP_KERNEL);
1471 return ERR_PTR(-ENOMEM);
1473 gi->group.default_groups = gi->default_groups;
1474 gi->group.default_groups[0] = &gi->functions_group;
1475 gi->group.default_groups[1] = &gi->configs_group;
1476 gi->group.default_groups[2] = &gi->strings_group;
1477 gi->group.default_groups[3] = &gi->os_desc_group;
1479 config_group_init_type_name(&gi->functions_group, "functions",
1481 config_group_init_type_name(&gi->configs_group, "configs",
1483 config_group_init_type_name(&gi->strings_group, "strings",
1484 &gadget_strings_strings_type);
1485 config_group_init_type_name(&gi->os_desc_group, "os_desc",
1488 gi->composite.bind = configfs_do_nothing;
1489 gi->composite.unbind = configfs_do_nothing;
1490 gi->composite.suspend = NULL;
1491 gi->composite.resume = NULL;
1492 gi->composite.max_speed = USB_SPEED_SUPER;
1494 mutex_init(&gi->lock);
1495 INIT_LIST_HEAD(&gi->string_list);
1496 INIT_LIST_HEAD(&gi->available_func);
1498 composite_init_dev(&gi->cdev);
1499 gi->cdev.desc.bLength = USB_DT_DEVICE_SIZE;
1500 gi->cdev.desc.bDescriptorType = USB_DT_DEVICE;
1501 gi->cdev.desc.bcdDevice = cpu_to_le16(get_default_bcdDevice());
1503 gi->composite.gadget_driver = configfs_driver_template;
1505 gi->composite.gadget_driver.function = kstrdup(name, GFP_KERNEL);
1506 gi->composite.name = gi->composite.gadget_driver.function;
1508 if (!gi->composite.gadget_driver.function)
1511 #ifdef CONFIG_USB_OTG
1512 gi->otg.bLength = sizeof(struct usb_otg_descriptor);
1513 gi->otg.bDescriptorType = USB_DT_OTG;
1514 gi->otg.bmAttributes = USB_OTG_SRP | USB_OTG_HNP;
1517 config_group_init_type_name(&gi->group, name,
1522 return ERR_PTR(-ENOMEM);
1525 static void gadgets_drop(struct config_group *group, struct config_item *item)
1527 config_item_put(item);
1530 static struct configfs_group_operations gadgets_ops = {
1531 .make_group = &gadgets_make,
1532 .drop_item = &gadgets_drop,
1535 static struct config_item_type gadgets_type = {
1536 .ct_group_ops = &gadgets_ops,
1537 .ct_owner = THIS_MODULE,
1540 static struct configfs_subsystem gadget_subsys = {
1543 .ci_namebuf = "usb_gadget",
1544 .ci_type = &gadgets_type,
1547 .su_mutex = __MUTEX_INITIALIZER(gadget_subsys.su_mutex),
1550 void unregister_gadget_item(struct config_item *item)
1552 struct gadget_info *gi = to_gadget_info(item);
1554 unregister_gadget(gi);
1556 EXPORT_SYMBOL_GPL(unregister_gadget_item);
1558 static int __init gadget_cfs_init(void)
1562 config_group_init(&gadget_subsys.su_group);
1564 ret = configfs_register_subsystem(&gadget_subsys);
1567 module_init(gadget_cfs_init);
1569 static void __exit gadget_cfs_exit(void)
1571 configfs_unregister_subsystem(&gadget_subsys);
1573 module_exit(gadget_cfs_exit);