usb: roles: set switch registered flag early on
authorElson Roy Serrao <quic_eserrao@quicinc.com>
Thu, 6 Feb 2025 19:39:50 +0000 (11:39 -0800)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 14 Feb 2025 08:26:25 +0000 (09:26 +0100)
The role switch registration and set_role() can happen in parallel as they
are invoked independent of each other. There is a possibility that a driver
might spend significant amount of time in usb_role_switch_register() API
due to the presence of time intensive operations like component_add()
which operate under common mutex. This leads to a time window after
allocating the switch and before setting the registered flag where the set
role notifications are dropped. Below timeline summarizes this behavior

Thread1 | Thread2
usb_role_switch_register() |
| |
---> allocate switch |
| |
---> component_add() | usb_role_switch_set_role()
| | |
| | --> Drop role notifications
| |     since sw->registered
| |     flag is not set.
| |
--->Set registered flag.|

To avoid this, set the registered flag early on in the switch register
API.

Fixes: b787a3e78175 ("usb: roles: don't get/set_role() when usb_role_switch is unregistered")
Cc: stable <stable@kernel.org>
Signed-off-by: Elson Roy Serrao <quic_eserrao@quicinc.com>
Reviewed-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>
Link: https://lore.kernel.org/r/20250206193950.22421-1-quic_eserrao@quicinc.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/usb/roles/class.c

index c58a12c147f451ae6d64e9fecb5c0b61d5337722..30482d4cf826786f4281b834a41dfe0821420e51 100644 (file)
@@ -387,8 +387,11 @@ usb_role_switch_register(struct device *parent,
        dev_set_name(&sw->dev, "%s-role-switch",
                     desc->name ? desc->name : dev_name(parent));
 
+       sw->registered = true;
+
        ret = device_register(&sw->dev);
        if (ret) {
+               sw->registered = false;
                put_device(&sw->dev);
                return ERR_PTR(ret);
        }
@@ -399,8 +402,6 @@ usb_role_switch_register(struct device *parent,
                        dev_warn(&sw->dev, "failed to add component\n");
        }
 
-       sw->registered = true;
-
        /* TODO: Symlinks for the host port and the device controller. */
 
        return sw;