Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Chanh Nguyen <chanh@os.amperecomputing.com>
To:     OpenBMC Maillist <openbmc@lists.ozlabs.org>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Christophe JAILLET <christophe.jaillet@wanadoo.fr>,
        Dan Vacura <w36195@motorola.com>,
        Jakob Koschel <jakobkoschel@gmail.com>,
        Alan Stern <stern@rowland.harvard.edu>,
        Vijayavardhan Vennapusa <vvreddy@codeaurora.org>,
        linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org,
        Open Source Submission <patches@amperecomputing.com>
Cc:     Chanh Nguyen <chanh@os.amperecomputing.com>
Subject: [PATCH] USB: gadget: Add ID numbers to configfs-gadget driver names
Date:   Tue, 13 Dec 2022 11:12:03 +0700
Message-Id: <20221213041203.21080-1-chanh@os.amperecomputing.com>
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?W/FF8f6D4pGY52HDNypd/vOUiWZYLntdPgegK78wQKtqw/fwfQtkMl+LkiIa?=
 =?us-ascii?Q?5f0lrULY2DVH/O2jYrVJxS/tQe6H7NRV4HuKR5P6QvUEaVqsPCKlNE0Yj3KV?=
 =?us-ascii?Q?soVAmboI9/X7Sk1jjCZgl8z+39gNl9nO5JoaOkEoRRHpG0Rt1wUw/rgNQK/g?=
 =?us-ascii?Q?ALfWlEOq1wzyuhxK/byvJLu/iOHl2Ym1VH3ZDtgXoNWxl4PMUda/JSZVBbOB?=
 =?us-ascii?Q?ZLKm9Pa5ZZBsSELYaFgM7NviGw4wt9MJFb94xAZ3LFRDxM1i+6J3vkphMGuF?=
 =?us-ascii?Q?UB8Ibnmssx06rRj7eO8pl2KdpcV/3VpdxYgFmoyNjFCyF9MHSzREzOadl3qx?=
 =?us-ascii?Q?EANPodLxctE84W27A4WvrX+VYKslBvL8lwGbtLRNg3/03Jv5KKbTiP9k4HjQ?=
 =?us-ascii?Q?scUqZuPgfDrxaY/wuek6N2XMW/1HbfAnMLLfoyX0FKLJP/Ch7YYABXo7Czmp?=
 =?us-ascii?Q?NFwO0LnwL8eQ9mAcWCrh4v1QXYK7rGp2e01Rud28yHzKyhVdnXaP7XTYCpOz?=
 =?us-ascii?Q?yocZrWiSxCHavSwJGNN/Hvus2dCgYNRFD78xMwkuhS1ACjNUgTcjTfWOauNr?=
 =?us-ascii?Q?I2SV7ZHC9rNpMFqqG3JOU5u/yD/mg/9QblWgCX1qczuJh4Hjeu/XcFaPcRma?=
 =?us-ascii?Q?b4AmeriqlvoGBbKEr15tHSmASQ3DWCv3fz5KAuQvC2agzIp1OFhldOXY1qIS?=
 =?us-ascii?Q?nUwuYJFxyc9yrVvWGqkAr3wX3athuTFoynGpxHL3bRbB1vKJQbffTuK5UJgQ?=
 =?us-ascii?Q?12WHNVNgviNE/wFYDQRd0MZt7y/XQ314MirnRjFv9eY/ykF2em5duky4BAEh?=
 =?us-ascii?Q?MaDKTCx0FT2XAC/2V+IVYnhqw7mZ56aujC/ahjpeRj6lrSAXXTgcfH+1LbKL?=
 =?us-ascii?Q?4cf86TkNfjNwRIAWggQtDJViSFR4zcoVhS3HJdoAGm+UBBV1QoZUFjjPHHK8?=
 =?us-ascii?Q?bTFjRr4ZgwZdweQh5uVT0zaxQ0Ql6OBxvtuL8pE4lyHWEaBD21Q+t+bVEevR?=
 =?us-ascii?Q?fHC8fCf4upTX9IucmaWK3woEFBDkBQBMfePWVkvSZo+8Sds+FgmjdKlrD9of?=
 =?us-ascii?Q?HLwm6CS4HJbLHaM0KLMWcrNghNUcvUxV6j3gypF59aZc67RjVCOT9d4RLUhc?=
 =?us-ascii?Q?eQXDgWESu/+gyKgSMHUatKULn05lzvZNryjGh1UXB5MBzqtZEcXc+A5ZJWBE?=
 =?us-ascii?Q?YGLMg+JEdPBF1/chOmamWTQrggQjuaT3UkEsokTdsVdm7g9fSiVW2n8k6x6F?=
 =?us-ascii?Q?5YuzEtkk042AIb/f0da3IKNPtdiNbxZnIW94UeDUZqR+ZVNxaJrHVc+sUJCd?=
 =?us-ascii?Q?TlKApKzrGWulHAEUGloiCvhwu89Ki2VVfLKyDuxMBBXNaLh33NbQPfPmkHDt?=
 =?us-ascii?Q?cbVnSf6kJ+mSCSlH8g695F4Jfcd9AvCe3tAUWVkyqwLbAn2Umf5YryRJSXGz?=
 =?us-ascii?Q?MIeC0syE4Ptcykt/BgRt/c09i+3YVmiUL9LEaiGkMd/IHS392BpKQvCTVO8F?=
 =?us-ascii?Q?RsuqqXygExrDTCLo6SEnRoTXAS5TxcpwkG5Qs5QajEMCnjmJEsACXejrmtix?=
 =?us-ascii?Q?mnRbvNUhr3BO95J8EfXCZkIvNV1RatmWmBm2QIrCab4VWEHVgD2wRlHLomIe?=
 =?us-ascii?Q?6NzxT10Bo5sK9SgSAVwjCQc=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 81ce94ac-c437-49b5-7d3f-08dadcc0767a
X-MS-Exchange-CrossTenant-AuthSource: SN6PR01MB4973.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Dec 2022 04:14:00.8416
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3bc2b170-fd94-476d-b0ce-4229bdc904a7
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: JxHz3cw9ypJfP4847d388+9vx3m+ZOih4RCq6XPG9d+iUCzcdTdvqN9JmiWrieqNFBOJu8gf+vXlEkXgxuy29lNMJQDn/X2gD9YddL7ufsj8MmhGD4OHIiVReAUA1Z5I
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR01MB2314
X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,
        SPF_HELO_PASS,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

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")
Signed-off-by: Chanh Nguyen <chanh@os.amperecomputing.com>
---
 drivers/usb/gadget/configfs.c | 42 +++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/drivers/usb/gadget/configfs.c b/drivers/usb/gadget/configfs.c
index 96121d1c8df4..d8c5156ad777 100644
--- a/drivers/usb/gadget/configfs.c
+++ b/drivers/usb/gadget/configfs.c
@@ -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,16 @@
 #include "u_f.h"
 #include "u_os_desc.h"
 
+static DEFINE_IDA(driver_id_numbers);
+
+/*
+ * Driver name has the form of "configfs-gadget.%d", where %d
+ * is id allocated by ida_alloc(). The max value returns by
+ * ida_alloc() is INT_MAX, in 64-bit system, it is about nine
+ * quintillion: 19 digits in decimal. Set the max length to 35.
+ */
+#define DRIVER_NAME_LENGTH_MAX 35
+
 int check_user_usb_string(const char *name,
 		struct usb_gadget_strings *stringtab_dev)
 {
@@ -52,6 +63,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)
@@ -1582,6 +1596,8 @@ static struct config_group *gadgets_make(
 		const char *name)
 {
 	struct gadget_info *gi;
+	char *driver_name;
+	int ret;
 
 	gi = kzalloc(sizeof(*gi), GFP_KERNEL);
 	if (!gi)
@@ -1623,6 +1639,21 @@ static struct config_group *gadgets_make(
 
 	gi->composite.gadget_driver = configfs_driver_template;
 
+	ret = ida_alloc(&driver_id_numbers, GFP_KERNEL);
+	if (ret < 0)
+		goto err;
+	gi->driver_id_number = ret;
+
+	driver_name = kmalloc(DRIVER_NAME_LENGTH_MAX, GFP_KERNEL);
+	if (!driver_name)
+		goto out_free_driver_id_number;
+
+	ret = scnprintf(driver_name, DRIVER_NAME_LENGTH_MAX,
+			"configfs-gadget.%d", gi->driver_id_number);
+	if (ret < 0)
+		goto out_free_driver_name;
+
+	gi->composite.gadget_driver.driver.name = driver_name;
 	gi->composite.gadget_driver.function = kstrdup(name, GFP_KERNEL);
 	gi->composite.name = gi->composite.gadget_driver.function;
 
@@ -1630,6 +1661,11 @@ static struct config_group *gadgets_make(
 		goto err;
 
 	return &gi->group;
+
+out_free_driver_name:
+	kfree(driver_name);
+out_free_driver_id_number:
+	ida_free(&driver_id_numbers, gi->driver_id_number);
 err:
 	kfree(gi);
 	return ERR_PTR(-ENOMEM);
@@ -1637,6 +1673,12 @@ static struct config_group *gadgets_make(
 
 static void gadgets_drop(struct config_group *group, struct config_item *item)
 {
+	struct gadget_info *gi = to_gadget_info(item);
+
+	mutex_lock(&gi->lock);
+	kfree(gi->composite.gadget_driver.driver.name);
+	ida_free(&driver_id_numbers, gi->driver_id_number);
+	mutex_unlock(&gi->lock);
 	config_item_put(item);
 }
 
-- 
2.17.1