Skip to contentSkip to conversation

USB: gadget: Add ID numbers to configfs-gadget driver names

PATCH Superseded Chanh Nguyen 4 participants 4 messages Dec 21, 2022 – Dec 30, 2022 USB

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 USB: gadget: Add ID numbers to configfs-gadget driver names

It is unable to use configfs to attach more than one gadget. When attaching the second gadget, it always fails and the kernel message prints out:

Error: Driver 'configfs-gadget' is already registered, aborting... UDC core: g1: driver registration failed: -16

This commit fixes the problem by a ".N" suffix added to each configfs_gadget's driver name (where N is a unique ID number), thus making the names distinct.

Fixes fc274c1e9973 ("USB: gadget: Add a new bus for gadgets")

---
Changes in v2:
- Replace scnprintf() by kasprintf() to simplify the code [CJ]
- Move the clean up code from gadgets_drop() to
gadget_info_attr_release() [Frank Li]
- Correct the resource free up in gadges_make() [Alan Stern]
- Remove the unnecessary variable in gadgets_make() [Chanh]
- Fixes minor grammar issue in commit message [Chanh]

---
 drivers/usb/gadget/configfs.c | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)
drivers/usb/gadget/configfs.c +24 -1
index 96121d1c8df4..7faf68bfa716 100644
@@ -3,6 +3,7 @@
 #include <linux/module.h>
 #include <linux/slab.h>
 #include <linux/device.h>
+#include <linux/idr.h>
 #include <linux/kstrtox.h>
 #include <linux/nls.h>
 #include <linux/usb/composite.h>
@@ -11,6 +12,8 @@
 #include "u_f.h"
 #include "u_os_desc.h"
 
+static DEFINE_IDA(driver_id_numbers);
+
 int check_user_usb_string(const char *name,
 		struct usb_gadget_strings *stringtab_dev)
 {
@@ -52,6 +55,9 @@ struct gadget_info {
 	char qw_sign[OS_STRING_QW_SIGN_LEN];
 	spinlock_t spinlock;
 	bool unbind;
+
+	/* Make driver names unique */
+	int driver_id_number;
 };
 
 static inline struct gadget_info *to_gadget_info(struct config_item *item)
@@ -393,6 +399,8 @@ static void gadget_info_attr_release(struct config_item *item)
 	WARN_ON(!list_empty(&gi->string_list));
 	WARN_ON(!list_empty(&gi->available_func));
 	kfree(gi->composite.gadget_driver.function);
+	kfree(gi->composite.gadget_driver.driver.name);
+	ida_free(&driver_id_numbers, gi->driver_id_number);
 	kfree(gi);
 }
 
@@ -1623,13 +1631,28 @@ static struct config_group *gadgets_make(
 
 	gi->composite.gadget_driver = configfs_driver_template;
 
+	gi->driver_id_number = ida_alloc(&driver_id_numbers, GFP_KERNEL);
+	if (gi->driver_id_number < 0)
+		goto err;
+
+	gi->composite.gadget_driver.driver.name = kasprintf(GFP_KERNEL,
+							    "configfs-gadget.%d",
+							    gi->driver_id_number);
+	if (!gi->composite.gadget_driver.driver.name)
+		goto out_free_driver_id_number;
+
 	gi->composite.gadget_driver.function = kstrdup(name, GFP_KERNEL);
 	gi->composite.name = gi->composite.gadget_driver.function;
 
 	if (!gi->composite.gadget_driver.function)
-		goto err;
+		goto out_free_driver_name;
 
 	return &gi->group;
+
+out_free_driver_name:
+	kfree(gi->composite.gadget_driver.driver.name);
+out_free_driver_id_number:
+	ida_free(&driver_id_numbers, gi->driver_id_number);
 err:
 	kfree(gi);
 	return ERR_PTR(-ENOMEM);
Signature · 1 line
2.17.1
#1 lore raw

Hi,

W dniu 21.12.2022 o 10:13, Chanh Nguyen pisze:

Quoted 7 lines

It is unable to use configfs to attach more than one gadget. When attaching the second gadget, it always fails and the kernel message prints out:

Error: Driver 'configfs-gadget' is already registered, aborting... UDC core: g1: driver registration failed: -16

I assume you are interested in a scenario where there is more than one UDC available which means you can have more than one active gadget?

Quoted 60 lines

This commit fixes the problem by a ".N" suffix added to each configfs_gadget's driver name (where N is a unique ID number), thus making the names distinct.

Fixes fc274c1e9973 ("USB: gadget: Add a new bus for gadgets")

---
Changes in v2:
- Replace scnprintf() by kasprintf() to simplify the code [CJ]
- Move the clean up code from gadgets_drop() to
gadget_info_attr_release() [Frank Li]
- Correct the resource free up in gadges_make() [Alan Stern]
- Remove the unnecessary variable in gadgets_make() [Chanh]
- Fixes minor grammar issue in commit message [Chanh]

---
  drivers/usb/gadget/configfs.c | 25 ++++++++++++++++++++++++-
  1 file changed, 24 insertions(+), 1 deletion(-)
drivers/usb/gadget/configfs.c +8 -0
index 96121d1c8df4..7faf68bfa716 100644
@@ -3,6 +3,7 @@
  #include <linux/module.h>
  #include <linux/slab.h>
  #include <linux/device.h>
+#include <linux/idr.h>
  #include <linux/kstrtox.h>
  #include <linux/nls.h>
  #include <linux/usb/composite.h>
@@ -11,6 +12,8 @@
  #include "u_f.h"
  #include "u_os_desc.h"
 
+static DEFINE_IDA(driver_id_numbers);
+
  int check_user_usb_string(const char *name,
  		struct usb_gadget_strings *stringtab_dev)
  {
@@ -52,6 +55,9 @@ struct gadget_info {
  	char qw_sign[OS_STRING_QW_SIGN_LEN];
  	spinlock_t spinlock;
  	bool unbind;
+
+	/* Make driver names unique */
+	int driver_id_number;
  };
 
  static inline struct gadget_info *to_gadget_info(struct config_item *item)
@@ -393,6 +399,8 @@ static void gadget_info_attr_release(struct config_item *item)
  	WARN_ON(!list_empty(&gi->string_list));
  	WARN_ON(!list_empty(&gi->available_func));
  	kfree(gi->composite.gadget_driver.function);
+	kfree(gi->composite.gadget_driver.driver.name);
+	ida_free(&driver_id_numbers, gi->driver_id_number);
  	kfree(gi);
  }
 

drivers/usb/gadget/configfs.c static struct config_group *gadgets_make( · line 1640

Quoted 10 lines
drivers/usb/gadget/configfs.c +7 -0
@@ -1623,13 +1631,28 @@ static struct config_group *gadgets_make(
 
  	gi->composite.gadget_driver = configfs_driver_template;
 
+	gi->driver_id_number = ida_alloc(&driver_id_numbers, GFP_KERNEL);
+	if (gi->driver_id_number < 0)
+		goto err;
+
+	gi->composite.gadget_driver.driver.name = kasprintf(GFP_KERNEL,
+							    "configfs-gadget.%d",
+							    gi->driver_id_number);

I'm wondering if it maybe makes more sense to use the gadget name as a suffix instead?

	gi->composite.gadget_driver.driver.name =
		kasprintf(GFP_KERNEL, "configfs-gadget.%s" name);

So that when you

mkdir g1

you will ultimately see /sys/bus/gadget/drivers/configfs-gadget.g1

instead of /sys/bus/gadget/drivers/configfs-gadget.0

Gadget names are guaranteed to be unique because they are created as sibling subdirectories in configfs. Your patch would then be greatly simplified (no need for ida).

Regards,

Andrzej

Quoted 19 lines
drivers/usb/gadget/configfs.c +9 -1
+	if (!gi->composite.gadget_driver.driver.name)
+		goto out_free_driver_id_number;
+
  	gi->composite.gadget_driver.function = kstrdup(name, GFP_KERNEL);
  	gi->composite.name = gi->composite.gadget_driver.function;
 
  	if (!gi->composite.gadget_driver.function)
-		goto err;
+		goto out_free_driver_name;
 
  	return &gi->group;
+
+out_free_driver_name:
+	kfree(gi->composite.gadget_driver.driver.name);
+out_free_driver_id_number:
+	ida_free(&driver_id_numbers, gi->driver_id_number);
  err:
  	kfree(gi);
  	return ERR_PTR(-ENOMEM);
#2 lore raw
Quoted 12 lines

I'm wondering if it maybe makes more sense to use the gadget name as a suffix
instead?

        gi->composite.gadget_driver.driver.name =
                kasprintf(GFP_KERNEL, "configfs-gadget.%s" name);

So that when you

mkdir g1

Quoted 7 lines

you will ultimately see /sys/bus/gadget/drivers/configfs-gadget.g1

instead of /sys/bus/gadget/drivers/configfs-gadget.0

Gadget names are guaranteed to be unique because they are created as sibling subdirectories in configfs. Your patch would then be greatly simplified (no need for ida).

I vote this ways.

Best regards
Frank Li

Quoted 5 lines

Regards,

Andrzej

#3 lore raw
In reply to Andrzej Pietrasiewicz
Quoted 7 lines · Andrzej Pietrasiewicz

Hi,

W dniu 21.12.2022 o 10:13, Chanh Nguyen pisze:

Quoted 4 lines

It is unable to use configfs to attach more than one gadget. When attaching the second gadget, it always fails and the kernel message prints out:

Quoted 7 lines
Quoted 3 lines

Error: Driver 'configfs-gadget' is already registered, aborting... UDC core: g1: driver registration failed: -16

I assume you are interested in a scenario where there is more than one UDC available which means you can have more than one active gadget?

Yes, I'd like to have more active gadgets. For example, mass_storage and ecm usb, ...

Quoted 81 lines
Quoted 58 lines

This commit fixes the problem by a ".N" suffix added to each configfs_gadget's driver name (where N is a unique ID number), thus making the names distinct.

Fixes fc274c1e9973 ("USB: gadget: Add a new bus for gadgets")

---
Changes in v2:
   - Replace scnprintf() by kasprintf() to simplify the code [CJ]
   - Move the clean up code from gadgets_drop() to gadget_info_attr_release()                        [Frank Li]
   - Correct the resource free up in gadges_make()   [Alan Stern]
   - Remove the unnecessary variable in gadgets_make()    [Chanh]
   - Fixes minor grammar issue in commit message          [Chanh]
---
  drivers/usb/gadget/configfs.c | 25 ++++++++++++++++++++++++-

  1 file changed, 24 insertions(+), 1 deletion(-)
drivers/usb/gadget/configfs.c +8 -0
index 96121d1c8df4..7faf68bfa716 100644
@@ -3,6 +3,7 @@
   #include <linux/module.h>
   #include <linux/slab.h>
   #include <linux/device.h>
+#include <linux/idr.h>
   #include <linux/kstrtox.h>
   #include <linux/nls.h>
   #include <linux/usb/composite.h>
@@ -11,6 +12,8 @@
   #include "u_f.h"
   #include "u_os_desc.h"
+static DEFINE_IDA(driver_id_numbers);
+
   int check_user_usb_string(const char *name,
           struct usb_gadget_strings *stringtab_dev)
   {
@@ -52,6 +55,9 @@ struct gadget_info {
       char qw_sign[OS_STRING_QW_SIGN_LEN];
       spinlock_t spinlock;
       bool unbind;
+
+    /* Make driver names unique */
+    int driver_id_number;
   };
   static inline struct gadget_info *to_gadget_info(struct config_item *item)
@@ -393,6 +399,8 @@ static void gadget_info_attr_release(struct 
 config_item *item)
       WARN_ON(!list_empty(&gi->string_list));
       WARN_ON(!list_empty(&gi->available_func));
       kfree(gi->composite.gadget_driver.function);
+    kfree(gi->composite.gadget_driver.driver.name);
+    ida_free(&driver_id_numbers, gi->driver_id_number);
       kfree(gi);
   }

drivers/usb/gadget/configfs.c static struct config_group *gadgets_make( · line 1638

Quoted 8 lines
drivers/usb/gadget/configfs.c +7 -0
@@ -1623,13 +1631,28 @@ static struct config_group *gadgets_make(
       gi->composite.gadget_driver = configfs_driver_template;
+    gi->driver_id_number = ida_alloc(&driver_id_numbers, GFP_KERNEL);
+    if (gi->driver_id_number < 0)
+        goto err;
+
+    gi->composite.gadget_driver.driver.name = kasprintf(GFP_KERNEL,
+                                "configfs-gadget.%d",
+                                gi->driver_id_number);

I'm wondering if it maybe makes more sense to use the gadget name as a suffix instead?

    gi->composite.gadget_driver.driver.name = kasprintf(GFP_KERNEL, "configfs-gadget.%s" name);

So that when you

mkdir g1

you will ultimately see /sys/bus/gadget/drivers/configfs-gadget.g1

instead of /sys/bus/gadget/drivers/configfs-gadget.0

Quoted 8 lines

Gadget names are guaranteed to be unique because they are created as sibling subdirectories in configfs. Your patch would then be greatly simplified (no need for ida).

Regards,

Andrzej

Thanks, Andrzej! I'll update that in patch v3

Quoted 18 lines
Quoted 17 lines
drivers/usb/gadget/configfs.c +9 -1
+    if (!gi->composite.gadget_driver.driver.name)
+        goto out_free_driver_id_number;
+
       gi->composite.gadget_driver.function = kstrdup(name, GFP_KERNEL);
       gi->composite.name = gi->composite.gadget_driver.function;
       if (!gi->composite.gadget_driver.function)
-        goto err;
+        goto out_free_driver_name;
       return &gi->group;
+
+out_free_driver_name:
+    kfree(gi->composite.gadget_driver.driver.name);
+out_free_driver_id_number:
+    ida_free(&driver_id_numbers, gi->driver_id_number);

  err:
      kfree(gi);
      return ERR_PTR(-ENOMEM);