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;
93 struct config_group group;
96 struct gadget_config_name {
97 struct usb_gadget_strings stringtab_dev;
98 struct usb_string strings;
101 struct config_group group;
102 struct list_head list;
105 #define USB_MAX_STRING_WITH_NULL_LEN (USB_MAX_STRING_LEN+1)
107 static int usb_string_copy(const char *s, char **s_copy)
111 char *copy = *s_copy;
113 if (ret > USB_MAX_STRING_LEN)
119 str = kmalloc(USB_MAX_STRING_WITH_NULL_LEN, GFP_KERNEL);
124 if (str[ret - 1] == '\n')
130 #define GI_DEVICE_DESC_SIMPLE_R_u8(__name) \
131 static ssize_t gadget_dev_desc_##__name##_show(struct config_item *item, \
134 return sprintf(page, "0x%02x\n", \
135 to_gadget_info(item)->cdev.desc.__name); \
138 #define GI_DEVICE_DESC_SIMPLE_R_u16(__name) \
139 static ssize_t gadget_dev_desc_##__name##_show(struct config_item *item, \
142 return sprintf(page, "0x%04x\n", \
143 le16_to_cpup(&to_gadget_info(item)->cdev.desc.__name)); \
147 #define GI_DEVICE_DESC_SIMPLE_W_u8(_name) \
148 static ssize_t gadget_dev_desc_##_name##_store(struct config_item *item, \
149 const char *page, size_t len) \
153 ret = kstrtou8(page, 0, &val); \
156 to_gadget_info(item)->cdev.desc._name = val; \
160 #define GI_DEVICE_DESC_SIMPLE_W_u16(_name) \
161 static ssize_t gadget_dev_desc_##_name##_store(struct config_item *item, \
162 const char *page, size_t len) \
166 ret = kstrtou16(page, 0, &val); \
169 to_gadget_info(item)->cdev.desc._name = cpu_to_le16p(&val); \
173 #define GI_DEVICE_DESC_SIMPLE_RW(_name, _type) \
174 GI_DEVICE_DESC_SIMPLE_R_##_type(_name) \
175 GI_DEVICE_DESC_SIMPLE_W_##_type(_name)
177 GI_DEVICE_DESC_SIMPLE_R_u16(bcdUSB);
178 GI_DEVICE_DESC_SIMPLE_RW(bDeviceClass, u8);
179 GI_DEVICE_DESC_SIMPLE_RW(bDeviceSubClass, u8);
180 GI_DEVICE_DESC_SIMPLE_RW(bDeviceProtocol, u8);
181 GI_DEVICE_DESC_SIMPLE_RW(bMaxPacketSize0, u8);
182 GI_DEVICE_DESC_SIMPLE_RW(idVendor, u16);
183 GI_DEVICE_DESC_SIMPLE_RW(idProduct, u16);
184 GI_DEVICE_DESC_SIMPLE_R_u16(bcdDevice);
186 static ssize_t is_valid_bcd(u16 bcd_val)
188 if ((bcd_val & 0xf) > 9)
190 if (((bcd_val >> 4) & 0xf) > 9)
192 if (((bcd_val >> 8) & 0xf) > 9)
194 if (((bcd_val >> 12) & 0xf) > 9)
199 static ssize_t gadget_dev_desc_bcdDevice_store(struct config_item *item,
200 const char *page, size_t len)
205 ret = kstrtou16(page, 0, &bcdDevice);
208 ret = is_valid_bcd(bcdDevice);
212 to_gadget_info(item)->cdev.desc.bcdDevice = cpu_to_le16(bcdDevice);
216 static ssize_t gadget_dev_desc_bcdUSB_store(struct config_item *item,
217 const char *page, size_t len)
222 ret = kstrtou16(page, 0, &bcdUSB);
225 ret = is_valid_bcd(bcdUSB);
229 to_gadget_info(item)->cdev.desc.bcdUSB = cpu_to_le16(bcdUSB);
233 static ssize_t gadget_dev_desc_UDC_show(struct config_item *item, char *page)
235 struct gadget_info *gi = to_gadget_info(item);
239 mutex_lock(&gi->lock);
240 udc_name = gi->composite.gadget_driver.udc_name;
241 ret = sprintf(page, "%s\n", udc_name ?: "");
242 mutex_unlock(&gi->lock);
247 static int unregister_gadget(struct gadget_info *gi)
251 if (!gi->composite.gadget_driver.udc_name)
254 ret = usb_gadget_unregister_driver(&gi->composite.gadget_driver);
257 kfree(gi->composite.gadget_driver.udc_name);
258 gi->composite.gadget_driver.udc_name = NULL;
262 static ssize_t gadget_dev_desc_UDC_store(struct config_item *item,
263 const char *page, size_t len)
265 struct gadget_info *gi = to_gadget_info(item);
269 if (strlen(page) < len)
272 name = kstrdup(page, GFP_KERNEL);
275 if (name[len - 1] == '\n')
276 name[len - 1] = '\0';
278 mutex_lock(&gi->lock);
281 ret = unregister_gadget(gi);
286 if (gi->composite.gadget_driver.udc_name) {
290 gi->composite.gadget_driver.udc_name = name;
291 ret = usb_gadget_probe_driver(&gi->composite.gadget_driver);
293 gi->composite.gadget_driver.udc_name = NULL;
297 mutex_unlock(&gi->lock);
301 mutex_unlock(&gi->lock);
305 static ssize_t gadget_dev_desc_max_speed_show(struct config_item *item,
308 enum usb_device_speed speed = to_gadget_info(item)->composite.max_speed;
310 return sprintf(page, "%s\n", usb_speed_string(speed));
313 static ssize_t gadget_dev_desc_max_speed_store(struct config_item *item,
314 const char *page, size_t len)
316 struct gadget_info *gi = to_gadget_info(item);
318 mutex_lock(&gi->lock);
320 /* Prevent changing of max_speed after the driver is binded */
321 if (gi->composite.gadget_driver.udc_name)
324 if (strncmp(page, "super-speed-plus", 16) == 0)
325 gi->composite.max_speed = USB_SPEED_SUPER_PLUS;
326 else if (strncmp(page, "super-speed", 11) == 0)
327 gi->composite.max_speed = USB_SPEED_SUPER;
328 else if (strncmp(page, "high-speed", 10) == 0)
329 gi->composite.max_speed = USB_SPEED_HIGH;
330 else if (strncmp(page, "full-speed", 10) == 0)
331 gi->composite.max_speed = USB_SPEED_FULL;
332 else if (strncmp(page, "low-speed", 9) == 0)
333 gi->composite.max_speed = USB_SPEED_LOW;
337 gi->composite.gadget_driver.max_speed = gi->composite.max_speed;
339 mutex_unlock(&gi->lock);
342 mutex_unlock(&gi->lock);
346 CONFIGFS_ATTR(gadget_dev_desc_, bDeviceClass);
347 CONFIGFS_ATTR(gadget_dev_desc_, bDeviceSubClass);
348 CONFIGFS_ATTR(gadget_dev_desc_, bDeviceProtocol);
349 CONFIGFS_ATTR(gadget_dev_desc_, bMaxPacketSize0);
350 CONFIGFS_ATTR(gadget_dev_desc_, idVendor);
351 CONFIGFS_ATTR(gadget_dev_desc_, idProduct);
352 CONFIGFS_ATTR(gadget_dev_desc_, bcdDevice);
353 CONFIGFS_ATTR(gadget_dev_desc_, bcdUSB);
354 CONFIGFS_ATTR(gadget_dev_desc_, UDC);
355 CONFIGFS_ATTR(gadget_dev_desc_, max_speed);
357 static struct configfs_attribute *gadget_root_attrs[] = {
358 &gadget_dev_desc_attr_bDeviceClass,
359 &gadget_dev_desc_attr_bDeviceSubClass,
360 &gadget_dev_desc_attr_bDeviceProtocol,
361 &gadget_dev_desc_attr_bMaxPacketSize0,
362 &gadget_dev_desc_attr_idVendor,
363 &gadget_dev_desc_attr_idProduct,
364 &gadget_dev_desc_attr_bcdDevice,
365 &gadget_dev_desc_attr_bcdUSB,
366 &gadget_dev_desc_attr_UDC,
367 &gadget_dev_desc_attr_max_speed,
371 static inline struct gadget_strings *to_gadget_strings(struct config_item *item)
373 return container_of(to_config_group(item), struct gadget_strings,
377 static inline struct gadget_config_name *to_gadget_config_name(
378 struct config_item *item)
380 return container_of(to_config_group(item), struct gadget_config_name,
384 static inline struct usb_function_instance *to_usb_function_instance(
385 struct config_item *item)
387 return container_of(to_config_group(item),
388 struct usb_function_instance, group);
391 static void gadget_info_attr_release(struct config_item *item)
393 struct gadget_info *gi = to_gadget_info(item);
395 WARN_ON(!list_empty(&gi->cdev.configs));
396 WARN_ON(!list_empty(&gi->string_list));
397 WARN_ON(!list_empty(&gi->available_func));
398 kfree(gi->composite.gadget_driver.function);
402 static struct configfs_item_operations gadget_root_item_ops = {
403 .release = gadget_info_attr_release,
406 static void gadget_config_attr_release(struct config_item *item)
408 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
410 WARN_ON(!list_empty(&cfg->c.functions));
411 list_del(&cfg->c.list);
416 static int config_usb_cfg_link(
417 struct config_item *usb_cfg_ci,
418 struct config_item *usb_func_ci)
420 struct config_usb_cfg *cfg = to_config_usb_cfg(usb_cfg_ci);
421 struct gadget_info *gi = cfg_to_gadget_info(cfg);
423 struct config_group *group = to_config_group(usb_func_ci);
424 struct usb_function_instance *fi = container_of(group,
425 struct usb_function_instance, group);
426 struct usb_function_instance *a_fi;
427 struct usb_function *f;
430 mutex_lock(&gi->lock);
432 * Make sure this function is from within our _this_ gadget and not
433 * from another gadget or a random directory.
434 * Also a function instance can only be linked once.
436 list_for_each_entry(a_fi, &gi->available_func, cfs_list) {
445 list_for_each_entry(f, &cfg->func_list, list) {
452 f = usb_get_function(fi);
458 /* stash the function until we bind it to the gadget */
459 list_add_tail(&f->list, &cfg->func_list);
462 mutex_unlock(&gi->lock);
466 static void config_usb_cfg_unlink(
467 struct config_item *usb_cfg_ci,
468 struct config_item *usb_func_ci)
470 struct config_usb_cfg *cfg = to_config_usb_cfg(usb_cfg_ci);
471 struct gadget_info *gi = cfg_to_gadget_info(cfg);
473 struct config_group *group = to_config_group(usb_func_ci);
474 struct usb_function_instance *fi = container_of(group,
475 struct usb_function_instance, group);
476 struct usb_function *f;
479 * ideally I would like to forbid to unlink functions while a gadget is
480 * bound to an UDC. Since this isn't possible at the moment, we simply
481 * force an unbind, the function is available here and then we can
482 * remove the function.
484 mutex_lock(&gi->lock);
485 if (gi->composite.gadget_driver.udc_name)
486 unregister_gadget(gi);
487 WARN_ON(gi->composite.gadget_driver.udc_name);
489 list_for_each_entry(f, &cfg->func_list, list) {
493 mutex_unlock(&gi->lock);
497 mutex_unlock(&gi->lock);
498 WARN(1, "Unable to locate function to unbind\n");
501 static struct configfs_item_operations gadget_config_item_ops = {
502 .release = gadget_config_attr_release,
503 .allow_link = config_usb_cfg_link,
504 .drop_link = config_usb_cfg_unlink,
508 static ssize_t gadget_config_desc_MaxPower_show(struct config_item *item,
511 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
513 return sprintf(page, "%u\n", cfg->c.MaxPower);
516 static ssize_t gadget_config_desc_MaxPower_store(struct config_item *item,
517 const char *page, size_t len)
519 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
522 ret = kstrtou16(page, 0, &val);
525 if (DIV_ROUND_UP(val, 8) > 0xff)
527 cfg->c.MaxPower = val;
531 static ssize_t gadget_config_desc_bmAttributes_show(struct config_item *item,
534 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
536 return sprintf(page, "0x%02x\n", cfg->c.bmAttributes);
539 static ssize_t gadget_config_desc_bmAttributes_store(struct config_item *item,
540 const char *page, size_t len)
542 struct config_usb_cfg *cfg = to_config_usb_cfg(item);
545 ret = kstrtou8(page, 0, &val);
548 if (!(val & USB_CONFIG_ATT_ONE))
550 if (val & ~(USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER |
551 USB_CONFIG_ATT_WAKEUP))
553 cfg->c.bmAttributes = val;
557 CONFIGFS_ATTR(gadget_config_desc_, MaxPower);
558 CONFIGFS_ATTR(gadget_config_desc_, bmAttributes);
560 static struct configfs_attribute *gadget_config_attrs[] = {
561 &gadget_config_desc_attr_MaxPower,
562 &gadget_config_desc_attr_bmAttributes,
566 static const struct config_item_type gadget_config_type = {
567 .ct_item_ops = &gadget_config_item_ops,
568 .ct_attrs = gadget_config_attrs,
569 .ct_owner = THIS_MODULE,
572 static const struct config_item_type gadget_root_type = {
573 .ct_item_ops = &gadget_root_item_ops,
574 .ct_attrs = gadget_root_attrs,
575 .ct_owner = THIS_MODULE,
578 static void composite_init_dev(struct usb_composite_dev *cdev)
580 spin_lock_init(&cdev->lock);
581 INIT_LIST_HEAD(&cdev->configs);
582 INIT_LIST_HEAD(&cdev->gstrings);
585 static struct config_group *function_make(
586 struct config_group *group,
589 struct gadget_info *gi;
590 struct usb_function_instance *fi;
591 char buf[MAX_NAME_LEN];
596 ret = snprintf(buf, MAX_NAME_LEN, "%s", name);
597 if (ret >= MAX_NAME_LEN)
598 return ERR_PTR(-ENAMETOOLONG);
601 instance_name = strchr(func_name, '.');
602 if (!instance_name) {
603 pr_err("Unable to locate . in FUNC.INSTANCE\n");
604 return ERR_PTR(-EINVAL);
606 *instance_name = '\0';
609 fi = usb_get_function_instance(func_name);
613 ret = config_item_set_name(&fi->group.cg_item, "%s", name);
615 usb_put_function_instance(fi);
618 if (fi->set_inst_name) {
619 ret = fi->set_inst_name(fi, instance_name);
621 usb_put_function_instance(fi);
626 gi = container_of(group, struct gadget_info, functions_group);
628 mutex_lock(&gi->lock);
629 list_add_tail(&fi->cfs_list, &gi->available_func);
630 mutex_unlock(&gi->lock);
634 static void function_drop(
635 struct config_group *group,
636 struct config_item *item)
638 struct usb_function_instance *fi = to_usb_function_instance(item);
639 struct gadget_info *gi;
641 gi = container_of(group, struct gadget_info, functions_group);
643 mutex_lock(&gi->lock);
644 list_del(&fi->cfs_list);
645 mutex_unlock(&gi->lock);
646 config_item_put(item);
649 static struct configfs_group_operations functions_ops = {
650 .make_group = &function_make,
651 .drop_item = &function_drop,
654 static const struct config_item_type functions_type = {
655 .ct_group_ops = &functions_ops,
656 .ct_owner = THIS_MODULE,
659 GS_STRINGS_RW(gadget_config_name, configuration);
661 static struct configfs_attribute *gadget_config_name_langid_attrs[] = {
662 &gadget_config_name_attr_configuration,
666 static void gadget_config_name_attr_release(struct config_item *item)
668 struct gadget_config_name *cn = to_gadget_config_name(item);
670 kfree(cn->configuration);
676 USB_CONFIG_STRING_RW_OPS(gadget_config_name);
677 USB_CONFIG_STRINGS_LANG(gadget_config_name, config_usb_cfg);
679 static struct config_group *config_desc_make(
680 struct config_group *group,
683 struct gadget_info *gi;
684 struct config_usb_cfg *cfg;
685 char buf[MAX_NAME_LEN];
690 gi = container_of(group, struct gadget_info, configs_group);
691 ret = snprintf(buf, MAX_NAME_LEN, "%s", name);
692 if (ret >= MAX_NAME_LEN)
693 return ERR_PTR(-ENAMETOOLONG);
695 num_str = strchr(buf, '.');
697 pr_err("Unable to locate . in name.bConfigurationValue\n");
698 return ERR_PTR(-EINVAL);
705 return ERR_PTR(-EINVAL);
707 ret = kstrtou8(num_str, 0, &num);
711 cfg = kzalloc(sizeof(*cfg), GFP_KERNEL);
713 return ERR_PTR(-ENOMEM);
714 cfg->c.label = kstrdup(buf, GFP_KERNEL);
719 cfg->c.bConfigurationValue = num;
720 cfg->c.MaxPower = CONFIG_USB_GADGET_VBUS_DRAW;
721 cfg->c.bmAttributes = USB_CONFIG_ATT_ONE;
722 INIT_LIST_HEAD(&cfg->string_list);
723 INIT_LIST_HEAD(&cfg->func_list);
725 config_group_init_type_name(&cfg->group, name,
726 &gadget_config_type);
728 config_group_init_type_name(&cfg->strings_group, "strings",
729 &gadget_config_name_strings_type);
730 configfs_add_default_group(&cfg->strings_group, &cfg->group);
732 ret = usb_add_config_only(&gi->cdev, &cfg->c);
743 static void config_desc_drop(
744 struct config_group *group,
745 struct config_item *item)
747 config_item_put(item);
750 static struct configfs_group_operations config_desc_ops = {
751 .make_group = &config_desc_make,
752 .drop_item = &config_desc_drop,
755 static const struct config_item_type config_desc_type = {
756 .ct_group_ops = &config_desc_ops,
757 .ct_owner = THIS_MODULE,
760 GS_STRINGS_RW(gadget_strings, manufacturer);
761 GS_STRINGS_RW(gadget_strings, product);
762 GS_STRINGS_RW(gadget_strings, serialnumber);
764 static struct configfs_attribute *gadget_strings_langid_attrs[] = {
765 &gadget_strings_attr_manufacturer,
766 &gadget_strings_attr_product,
767 &gadget_strings_attr_serialnumber,
771 static void gadget_strings_attr_release(struct config_item *item)
773 struct gadget_strings *gs = to_gadget_strings(item);
775 kfree(gs->manufacturer);
777 kfree(gs->serialnumber);
783 USB_CONFIG_STRING_RW_OPS(gadget_strings);
784 USB_CONFIG_STRINGS_LANG(gadget_strings, gadget_info);
786 static inline struct os_desc *to_os_desc(struct config_item *item)
788 return container_of(to_config_group(item), struct os_desc, group);
791 static inline struct gadget_info *os_desc_item_to_gadget_info(
792 struct config_item *item)
794 return to_gadget_info(to_os_desc(item)->group.cg_item.ci_parent);
797 static ssize_t os_desc_use_show(struct config_item *item, char *page)
799 return sprintf(page, "%d\n",
800 os_desc_item_to_gadget_info(item)->use_os_desc);
803 static ssize_t os_desc_use_store(struct config_item *item, const char *page,
806 struct gadget_info *gi = os_desc_item_to_gadget_info(item);
810 mutex_lock(&gi->lock);
811 ret = strtobool(page, &use);
813 gi->use_os_desc = use;
816 mutex_unlock(&gi->lock);
821 static ssize_t os_desc_b_vendor_code_show(struct config_item *item, char *page)
823 return sprintf(page, "0x%02x\n",
824 os_desc_item_to_gadget_info(item)->b_vendor_code);
827 static ssize_t os_desc_b_vendor_code_store(struct config_item *item,
828 const char *page, size_t len)
830 struct gadget_info *gi = os_desc_item_to_gadget_info(item);
834 mutex_lock(&gi->lock);
835 ret = kstrtou8(page, 0, &b_vendor_code);
837 gi->b_vendor_code = b_vendor_code;
840 mutex_unlock(&gi->lock);
845 static ssize_t os_desc_qw_sign_show(struct config_item *item, char *page)
847 struct gadget_info *gi = os_desc_item_to_gadget_info(item);
850 res = utf16s_to_utf8s((wchar_t *) gi->qw_sign, OS_STRING_QW_SIGN_LEN,
851 UTF16_LITTLE_ENDIAN, page, PAGE_SIZE - 1);
857 static ssize_t os_desc_qw_sign_store(struct config_item *item, const char *page,
860 struct gadget_info *gi = os_desc_item_to_gadget_info(item);
863 l = min((int)len, OS_STRING_QW_SIGN_LEN >> 1);
864 if (page[l - 1] == '\n')
867 mutex_lock(&gi->lock);
868 res = utf8s_to_utf16s(page, l,
869 UTF16_LITTLE_ENDIAN, (wchar_t *) gi->qw_sign,
870 OS_STRING_QW_SIGN_LEN);
873 mutex_unlock(&gi->lock);
878 CONFIGFS_ATTR(os_desc_, use);
879 CONFIGFS_ATTR(os_desc_, b_vendor_code);
880 CONFIGFS_ATTR(os_desc_, qw_sign);
882 static struct configfs_attribute *os_desc_attrs[] = {
884 &os_desc_attr_b_vendor_code,
885 &os_desc_attr_qw_sign,
889 static void os_desc_attr_release(struct config_item *item)
891 struct os_desc *os_desc = to_os_desc(item);
895 static int os_desc_link(struct config_item *os_desc_ci,
896 struct config_item *usb_cfg_ci)
898 struct gadget_info *gi = container_of(to_config_group(os_desc_ci),
899 struct gadget_info, os_desc_group);
900 struct usb_composite_dev *cdev = &gi->cdev;
901 struct config_usb_cfg *c_target =
902 container_of(to_config_group(usb_cfg_ci),
903 struct config_usb_cfg, group);
904 struct usb_configuration *c;
907 mutex_lock(&gi->lock);
908 list_for_each_entry(c, &cdev->configs, list) {
909 if (c == &c_target->c)
912 if (c != &c_target->c) {
917 if (cdev->os_desc_config) {
922 cdev->os_desc_config = &c_target->c;
926 mutex_unlock(&gi->lock);
930 static void os_desc_unlink(struct config_item *os_desc_ci,
931 struct config_item *usb_cfg_ci)
933 struct gadget_info *gi = container_of(to_config_group(os_desc_ci),
934 struct gadget_info, os_desc_group);
935 struct usb_composite_dev *cdev = &gi->cdev;
937 mutex_lock(&gi->lock);
938 if (gi->composite.gadget_driver.udc_name)
939 unregister_gadget(gi);
940 cdev->os_desc_config = NULL;
941 WARN_ON(gi->composite.gadget_driver.udc_name);
942 mutex_unlock(&gi->lock);
945 static struct configfs_item_operations os_desc_ops = {
946 .release = os_desc_attr_release,
947 .allow_link = os_desc_link,
948 .drop_link = os_desc_unlink,
951 static struct config_item_type os_desc_type = {
952 .ct_item_ops = &os_desc_ops,
953 .ct_attrs = os_desc_attrs,
954 .ct_owner = THIS_MODULE,
957 static inline struct usb_os_desc_ext_prop
958 *to_usb_os_desc_ext_prop(struct config_item *item)
960 return container_of(item, struct usb_os_desc_ext_prop, item);
963 static ssize_t ext_prop_type_show(struct config_item *item, char *page)
965 return sprintf(page, "%d\n", to_usb_os_desc_ext_prop(item)->type);
968 static ssize_t ext_prop_type_store(struct config_item *item,
969 const char *page, size_t len)
971 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
972 struct usb_os_desc *desc = to_usb_os_desc(ext_prop->item.ci_parent);
976 if (desc->opts_mutex)
977 mutex_lock(desc->opts_mutex);
978 ret = kstrtou8(page, 0, &type);
981 if (type < USB_EXT_PROP_UNICODE || type > USB_EXT_PROP_UNICODE_MULTI) {
986 if ((ext_prop->type == USB_EXT_PROP_BINARY ||
987 ext_prop->type == USB_EXT_PROP_LE32 ||
988 ext_prop->type == USB_EXT_PROP_BE32) &&
989 (type == USB_EXT_PROP_UNICODE ||
990 type == USB_EXT_PROP_UNICODE_ENV ||
991 type == USB_EXT_PROP_UNICODE_LINK))
992 ext_prop->data_len <<= 1;
993 else 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) &&
996 (type == USB_EXT_PROP_BINARY ||
997 type == USB_EXT_PROP_LE32 ||
998 type == USB_EXT_PROP_BE32))
999 ext_prop->data_len >>= 1;
1000 ext_prop->type = type;
1004 if (desc->opts_mutex)
1005 mutex_unlock(desc->opts_mutex);
1009 static ssize_t ext_prop_data_show(struct config_item *item, char *page)
1011 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
1012 int len = ext_prop->data_len;
1014 if (ext_prop->type == USB_EXT_PROP_UNICODE ||
1015 ext_prop->type == USB_EXT_PROP_UNICODE_ENV ||
1016 ext_prop->type == USB_EXT_PROP_UNICODE_LINK)
1018 memcpy(page, ext_prop->data, len);
1023 static ssize_t ext_prop_data_store(struct config_item *item,
1024 const char *page, size_t len)
1026 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
1027 struct usb_os_desc *desc = to_usb_os_desc(ext_prop->item.ci_parent);
1029 size_t ret_len = len;
1031 if (page[len - 1] == '\n' || page[len - 1] == '\0')
1033 new_data = kmemdup(page, len, GFP_KERNEL);
1037 if (desc->opts_mutex)
1038 mutex_lock(desc->opts_mutex);
1039 kfree(ext_prop->data);
1040 ext_prop->data = new_data;
1041 desc->ext_prop_len -= ext_prop->data_len;
1042 ext_prop->data_len = len;
1043 desc->ext_prop_len += ext_prop->data_len;
1044 if (ext_prop->type == USB_EXT_PROP_UNICODE ||
1045 ext_prop->type == USB_EXT_PROP_UNICODE_ENV ||
1046 ext_prop->type == USB_EXT_PROP_UNICODE_LINK) {
1047 desc->ext_prop_len -= ext_prop->data_len;
1048 ext_prop->data_len <<= 1;
1049 ext_prop->data_len += 2;
1050 desc->ext_prop_len += ext_prop->data_len;
1052 if (desc->opts_mutex)
1053 mutex_unlock(desc->opts_mutex);
1057 CONFIGFS_ATTR(ext_prop_, type);
1058 CONFIGFS_ATTR(ext_prop_, data);
1060 static struct configfs_attribute *ext_prop_attrs[] = {
1061 &ext_prop_attr_type,
1062 &ext_prop_attr_data,
1066 static void usb_os_desc_ext_prop_release(struct config_item *item)
1068 struct usb_os_desc_ext_prop *ext_prop = to_usb_os_desc_ext_prop(item);
1070 kfree(ext_prop); /* frees a whole chunk */
1073 static struct configfs_item_operations ext_prop_ops = {
1074 .release = usb_os_desc_ext_prop_release,
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 ssize_t interf_grp_compatible_id_show(struct config_item *item,
1146 memcpy(page, to_usb_os_desc(item)->ext_compat_id, 8);
1150 static ssize_t interf_grp_compatible_id_store(struct config_item *item,
1151 const char *page, size_t len)
1153 struct usb_os_desc *desc = to_usb_os_desc(item);
1156 l = min_t(int, 8, len);
1157 if (page[l - 1] == '\n')
1159 if (desc->opts_mutex)
1160 mutex_lock(desc->opts_mutex);
1161 memcpy(desc->ext_compat_id, page, l);
1163 if (desc->opts_mutex)
1164 mutex_unlock(desc->opts_mutex);
1169 static ssize_t interf_grp_sub_compatible_id_show(struct config_item *item,
1172 memcpy(page, to_usb_os_desc(item)->ext_compat_id + 8, 8);
1176 static ssize_t interf_grp_sub_compatible_id_store(struct config_item *item,
1177 const char *page, size_t len)
1179 struct usb_os_desc *desc = to_usb_os_desc(item);
1182 l = min_t(int, 8, len);
1183 if (page[l - 1] == '\n')
1185 if (desc->opts_mutex)
1186 mutex_lock(desc->opts_mutex);
1187 memcpy(desc->ext_compat_id + 8, page, l);
1189 if (desc->opts_mutex)
1190 mutex_unlock(desc->opts_mutex);
1195 CONFIGFS_ATTR(interf_grp_, compatible_id);
1196 CONFIGFS_ATTR(interf_grp_, sub_compatible_id);
1198 static struct configfs_attribute *interf_grp_attrs[] = {
1199 &interf_grp_attr_compatible_id,
1200 &interf_grp_attr_sub_compatible_id,
1204 struct config_group *usb_os_desc_prepare_interf_dir(
1205 struct config_group *parent,
1207 struct usb_os_desc **desc,
1209 struct module *owner)
1211 struct config_group *os_desc_group;
1212 struct config_item_type *os_desc_type, *interface_type;
1214 vla_group(data_chunk);
1215 vla_item(data_chunk, struct config_group, os_desc_group, 1);
1216 vla_item(data_chunk, struct config_item_type, os_desc_type, 1);
1217 vla_item(data_chunk, struct config_item_type, interface_type, 1);
1219 char *vlabuf = kzalloc(vla_group_size(data_chunk), GFP_KERNEL);
1221 return ERR_PTR(-ENOMEM);
1223 os_desc_group = vla_ptr(vlabuf, data_chunk, os_desc_group);
1224 os_desc_type = vla_ptr(vlabuf, data_chunk, os_desc_type);
1225 interface_type = vla_ptr(vlabuf, data_chunk, interface_type);
1227 os_desc_type->ct_owner = owner;
1228 config_group_init_type_name(os_desc_group, "os_desc", os_desc_type);
1229 configfs_add_default_group(os_desc_group, parent);
1231 interface_type->ct_group_ops = &interf_grp_ops;
1232 interface_type->ct_attrs = interf_grp_attrs;
1233 interface_type->ct_owner = owner;
1235 while (n_interf--) {
1236 struct usb_os_desc *d;
1240 config_group_init_type_name(&d->group, "", interface_type);
1241 config_item_set_name(&d->group.cg_item, "interface.%s",
1243 configfs_add_default_group(&d->group, os_desc_group);
1246 return os_desc_group;
1248 EXPORT_SYMBOL(usb_os_desc_prepare_interf_dir);
1250 static int configfs_do_nothing(struct usb_composite_dev *cdev)
1256 int composite_dev_prepare(struct usb_composite_driver *composite,
1257 struct usb_composite_dev *dev);
1259 int composite_os_desc_req_prepare(struct usb_composite_dev *cdev,
1260 struct usb_ep *ep0);
1262 static void purge_configs_funcs(struct gadget_info *gi)
1264 struct usb_configuration *c;
1266 list_for_each_entry(c, &gi->cdev.configs, list) {
1267 struct usb_function *f, *tmp;
1268 struct config_usb_cfg *cfg;
1270 cfg = container_of(c, struct config_usb_cfg, c);
1272 list_for_each_entry_safe_reverse(f, tmp, &c->functions, list) {
1274 list_move(&f->list, &cfg->func_list);
1276 dev_dbg(&gi->cdev.gadget->dev,
1277 "unbind function '%s'/%p\n",
1282 c->next_interface_id = 0;
1283 memset(c->interface, 0, sizeof(c->interface));
1284 c->superspeed_plus = 0;
1291 static int configfs_composite_bind(struct usb_gadget *gadget,
1292 struct usb_gadget_driver *gdriver)
1294 struct usb_composite_driver *composite = to_cdriver(gdriver);
1295 struct gadget_info *gi = container_of(composite,
1296 struct gadget_info, composite);
1297 struct usb_composite_dev *cdev = &gi->cdev;
1298 struct usb_configuration *c;
1299 struct usb_string *s;
1303 /* the gi->lock is hold by the caller */
1305 cdev->gadget = gadget;
1306 set_gadget_data(gadget, cdev);
1307 ret = composite_dev_prepare(composite, cdev);
1310 /* and now the gadget bind */
1313 if (list_empty(&gi->cdev.configs)) {
1314 pr_err("Need at least one configuration in %s.\n",
1315 gi->composite.name);
1316 goto err_comp_cleanup;
1320 list_for_each_entry(c, &gi->cdev.configs, list) {
1321 struct config_usb_cfg *cfg;
1323 cfg = container_of(c, struct config_usb_cfg, c);
1324 if (list_empty(&cfg->func_list)) {
1325 pr_err("Config %s/%d of %s needs at least one function.\n",
1326 c->label, c->bConfigurationValue,
1327 gi->composite.name);
1328 goto err_comp_cleanup;
1332 /* init all strings */
1333 if (!list_empty(&gi->string_list)) {
1334 struct gadget_strings *gs;
1337 list_for_each_entry(gs, &gi->string_list, list) {
1339 gi->gstrings[i] = &gs->stringtab_dev;
1340 gs->stringtab_dev.strings = gs->strings;
1341 gs->strings[USB_GADGET_MANUFACTURER_IDX].s =
1343 gs->strings[USB_GADGET_PRODUCT_IDX].s = gs->product;
1344 gs->strings[USB_GADGET_SERIAL_IDX].s = gs->serialnumber;
1347 gi->gstrings[i] = NULL;
1348 s = usb_gstrings_attach(&gi->cdev, gi->gstrings,
1349 USB_GADGET_FIRST_AVAIL_IDX);
1352 goto err_comp_cleanup;
1355 gi->cdev.desc.iManufacturer = s[USB_GADGET_MANUFACTURER_IDX].id;
1356 gi->cdev.desc.iProduct = s[USB_GADGET_PRODUCT_IDX].id;
1357 gi->cdev.desc.iSerialNumber = s[USB_GADGET_SERIAL_IDX].id;
1360 if (gi->use_os_desc) {
1361 cdev->use_os_string = true;
1362 cdev->b_vendor_code = gi->b_vendor_code;
1363 memcpy(cdev->qw_sign, gi->qw_sign, OS_STRING_QW_SIGN_LEN);
1366 if (gadget_is_otg(gadget) && !otg_desc[0]) {
1367 struct usb_descriptor_header *usb_desc;
1369 usb_desc = usb_otg_descriptor_alloc(gadget);
1372 goto err_comp_cleanup;
1374 usb_otg_descriptor_init(gadget, usb_desc);
1375 otg_desc[0] = usb_desc;
1379 /* Go through all configs, attach all functions */
1380 list_for_each_entry(c, &gi->cdev.configs, list) {
1381 struct config_usb_cfg *cfg;
1382 struct usb_function *f;
1383 struct usb_function *tmp;
1384 struct gadget_config_name *cn;
1386 if (gadget_is_otg(gadget))
1387 c->descriptors = otg_desc;
1389 cfg = container_of(c, struct config_usb_cfg, c);
1390 if (!list_empty(&cfg->string_list)) {
1392 list_for_each_entry(cn, &cfg->string_list, list) {
1393 cfg->gstrings[i] = &cn->stringtab_dev;
1394 cn->stringtab_dev.strings = &cn->strings;
1395 cn->strings.s = cn->configuration;
1398 cfg->gstrings[i] = NULL;
1399 s = usb_gstrings_attach(&gi->cdev, cfg->gstrings, 1);
1402 goto err_comp_cleanup;
1404 c->iConfiguration = s[0].id;
1407 list_for_each_entry_safe(f, tmp, &cfg->func_list, list) {
1409 ret = usb_add_function(c, f);
1411 list_add(&f->list, &cfg->func_list);
1412 goto err_purge_funcs;
1415 ret = usb_gadget_check_config(cdev->gadget);
1417 goto err_purge_funcs;
1419 usb_ep_autoconfig_reset(cdev->gadget);
1421 if (cdev->use_os_string) {
1422 ret = composite_os_desc_req_prepare(cdev, gadget->ep0);
1424 goto err_purge_funcs;
1427 usb_ep_autoconfig_reset(cdev->gadget);
1431 purge_configs_funcs(gi);
1433 composite_dev_cleanup(cdev);
1437 static void configfs_composite_unbind(struct usb_gadget *gadget)
1439 struct usb_composite_dev *cdev;
1440 struct gadget_info *gi;
1441 unsigned long flags;
1443 /* the gi->lock is hold by the caller */
1445 cdev = get_gadget_data(gadget);
1446 gi = container_of(cdev, struct gadget_info, cdev);
1447 spin_lock_irqsave(&gi->spinlock, flags);
1449 spin_unlock_irqrestore(&gi->spinlock, flags);
1453 purge_configs_funcs(gi);
1454 composite_dev_cleanup(cdev);
1455 usb_ep_autoconfig_reset(cdev->gadget);
1456 spin_lock_irqsave(&gi->spinlock, flags);
1457 cdev->gadget = NULL;
1458 set_gadget_data(gadget, NULL);
1459 spin_unlock_irqrestore(&gi->spinlock, flags);
1462 static int configfs_composite_setup(struct usb_gadget *gadget,
1463 const struct usb_ctrlrequest *ctrl)
1465 struct usb_composite_dev *cdev;
1466 struct gadget_info *gi;
1467 unsigned long flags;
1470 cdev = get_gadget_data(gadget);
1474 gi = container_of(cdev, struct gadget_info, cdev);
1475 spin_lock_irqsave(&gi->spinlock, flags);
1476 cdev = get_gadget_data(gadget);
1477 if (!cdev || gi->unbind) {
1478 spin_unlock_irqrestore(&gi->spinlock, flags);
1482 ret = composite_setup(gadget, ctrl);
1483 spin_unlock_irqrestore(&gi->spinlock, flags);
1487 static void configfs_composite_disconnect(struct usb_gadget *gadget)
1489 struct usb_composite_dev *cdev;
1490 struct gadget_info *gi;
1491 unsigned long flags;
1493 cdev = get_gadget_data(gadget);
1497 gi = container_of(cdev, struct gadget_info, cdev);
1498 spin_lock_irqsave(&gi->spinlock, flags);
1499 cdev = get_gadget_data(gadget);
1500 if (!cdev || gi->unbind) {
1501 spin_unlock_irqrestore(&gi->spinlock, flags);
1505 composite_disconnect(gadget);
1506 spin_unlock_irqrestore(&gi->spinlock, flags);
1509 static void configfs_composite_reset(struct usb_gadget *gadget)
1511 struct usb_composite_dev *cdev;
1512 struct gadget_info *gi;
1513 unsigned long flags;
1515 cdev = get_gadget_data(gadget);
1519 gi = container_of(cdev, struct gadget_info, cdev);
1520 spin_lock_irqsave(&gi->spinlock, flags);
1521 cdev = get_gadget_data(gadget);
1522 if (!cdev || gi->unbind) {
1523 spin_unlock_irqrestore(&gi->spinlock, flags);
1527 composite_reset(gadget);
1528 spin_unlock_irqrestore(&gi->spinlock, flags);
1531 static void configfs_composite_suspend(struct usb_gadget *gadget)
1533 struct usb_composite_dev *cdev;
1534 struct gadget_info *gi;
1535 unsigned long flags;
1537 cdev = get_gadget_data(gadget);
1541 gi = container_of(cdev, struct gadget_info, cdev);
1542 spin_lock_irqsave(&gi->spinlock, flags);
1543 cdev = get_gadget_data(gadget);
1544 if (!cdev || gi->unbind) {
1545 spin_unlock_irqrestore(&gi->spinlock, flags);
1549 composite_suspend(gadget);
1550 spin_unlock_irqrestore(&gi->spinlock, flags);
1553 static void configfs_composite_resume(struct usb_gadget *gadget)
1555 struct usb_composite_dev *cdev;
1556 struct gadget_info *gi;
1557 unsigned long flags;
1559 cdev = get_gadget_data(gadget);
1563 gi = container_of(cdev, struct gadget_info, cdev);
1564 spin_lock_irqsave(&gi->spinlock, flags);
1565 cdev = get_gadget_data(gadget);
1566 if (!cdev || gi->unbind) {
1567 spin_unlock_irqrestore(&gi->spinlock, flags);
1571 composite_resume(gadget);
1572 spin_unlock_irqrestore(&gi->spinlock, flags);
1575 static const struct usb_gadget_driver configfs_driver_template = {
1576 .bind = configfs_composite_bind,
1577 .unbind = configfs_composite_unbind,
1579 .setup = configfs_composite_setup,
1580 .reset = configfs_composite_reset,
1581 .disconnect = configfs_composite_disconnect,
1583 .suspend = configfs_composite_suspend,
1584 .resume = configfs_composite_resume,
1586 .max_speed = USB_SPEED_SUPER_PLUS,
1588 .owner = THIS_MODULE,
1589 .name = "configfs-gadget",
1591 .match_existing_only = 1,
1594 static struct config_group *gadgets_make(
1595 struct config_group *group,
1598 struct gadget_info *gi;
1600 gi = kzalloc(sizeof(*gi), GFP_KERNEL);
1602 return ERR_PTR(-ENOMEM);
1604 config_group_init_type_name(&gi->group, name, &gadget_root_type);
1606 config_group_init_type_name(&gi->functions_group, "functions",
1608 configfs_add_default_group(&gi->functions_group, &gi->group);
1610 config_group_init_type_name(&gi->configs_group, "configs",
1612 configfs_add_default_group(&gi->configs_group, &gi->group);
1614 config_group_init_type_name(&gi->strings_group, "strings",
1615 &gadget_strings_strings_type);
1616 configfs_add_default_group(&gi->strings_group, &gi->group);
1618 config_group_init_type_name(&gi->os_desc_group, "os_desc",
1620 configfs_add_default_group(&gi->os_desc_group, &gi->group);
1622 gi->composite.bind = configfs_do_nothing;
1623 gi->composite.unbind = configfs_do_nothing;
1624 gi->composite.suspend = NULL;
1625 gi->composite.resume = NULL;
1626 gi->composite.max_speed = USB_SPEED_SUPER_PLUS;
1628 spin_lock_init(&gi->spinlock);
1629 mutex_init(&gi->lock);
1630 INIT_LIST_HEAD(&gi->string_list);
1631 INIT_LIST_HEAD(&gi->available_func);
1633 composite_init_dev(&gi->cdev);
1634 gi->cdev.desc.bLength = USB_DT_DEVICE_SIZE;
1635 gi->cdev.desc.bDescriptorType = USB_DT_DEVICE;
1636 gi->cdev.desc.bcdDevice = cpu_to_le16(get_default_bcdDevice());
1638 gi->composite.gadget_driver = configfs_driver_template;
1640 gi->composite.gadget_driver.function = kstrdup(name, GFP_KERNEL);
1641 gi->composite.name = gi->composite.gadget_driver.function;
1643 if (!gi->composite.gadget_driver.function)
1649 return ERR_PTR(-ENOMEM);
1652 static void gadgets_drop(struct config_group *group, struct config_item *item)
1654 config_item_put(item);
1657 static struct configfs_group_operations gadgets_ops = {
1658 .make_group = &gadgets_make,
1659 .drop_item = &gadgets_drop,
1662 static const struct config_item_type gadgets_type = {
1663 .ct_group_ops = &gadgets_ops,
1664 .ct_owner = THIS_MODULE,
1667 static struct configfs_subsystem gadget_subsys = {
1670 .ci_namebuf = "usb_gadget",
1671 .ci_type = &gadgets_type,
1674 .su_mutex = __MUTEX_INITIALIZER(gadget_subsys.su_mutex),
1677 void unregister_gadget_item(struct config_item *item)
1679 struct gadget_info *gi = to_gadget_info(item);
1681 mutex_lock(&gi->lock);
1682 unregister_gadget(gi);
1683 mutex_unlock(&gi->lock);
1685 EXPORT_SYMBOL_GPL(unregister_gadget_item);
1687 static int __init gadget_cfs_init(void)
1691 config_group_init(&gadget_subsys.su_group);
1693 ret = configfs_register_subsystem(&gadget_subsys);
1696 module_init(gadget_cfs_init);
1698 static void __exit gadget_cfs_exit(void)
1700 configfs_unregister_subsystem(&gadget_subsys);
1702 module_exit(gadget_cfs_exit);